Skip to main content
Version: 0.2.1

HLS

Creates HLS playlist that is ready to be broadcasted via CDN. Read more about HLS here.

Compatibility​

Requirements​

  • The Room in which the HLS component is created must have the video codec set to H264. See API for more information.
  • Max 1 HLS component allowed per room.

Configuration options​

Optional

  • lowLatency (boolean, default: false) - whether the component should use LL-HLS

Env variables​

Currently, there are no environment variables related to this component.

Output​

After adding a WebRTC peer (and at least one track) or an RTSP component, the HLS stream will be available under http://<jellyfish-address>/hls/<room_id>/index.m3u8 (or https://, if using TLS).

Example Docker commands​

The HLS playlist will be created inside the Docker container. To access it from the host, you need to create a volume, e.g. by adding the option -v $(pwd)/jellyfish_output:/app/jellyfish_output to your Docker command.

Other than that, your Docker commands shouldn't be affected by adding this component.

docker run -p 8080:8080/tcp \
           -e JF_SERVER_API_TOKEN=token \
           -e JF_HOST=localhost:8080 \
           -v $(pwd)/jellyfish_output:/app/jellyfish_output \
           ghcr.io/jellyfish-dev/jellyfish:0.2.1