API Reference - Interactive Live Streaming
This page describes the API references for interactive live streaming.
Table of Contents
Last updated
This page describes the API references for interactive live streaming.
Last updated
A generated response for fetching live hls users count
A generated response for fetching live hls users count
Generate JWT Token to use with sariska services
please pass apiKey with tied with your sariska account
pass exp claim of jwt token
pass nbf claim of jwt token
pass scope of token it can be messaging or media or sariska or leave it blank
A successfully generated response for jwt token
Stops already started live streaming
stops streaming of given room name
A generated response for successfully stopped streaming
Starts new live streaming
List of RTMP server keys for simulcast live streaming to all platforms, including Instagram, YouTube, Twitch, Vimeo, Periscope, Facebook, DLive, Mixcloud, and Restream.
This is a list of additional RTMP URLs for platforms not included in the above-listed platforms or host URL is dynamic
The room name recorder needs to join.
Whether the live streaming needs to be in low latency
The player side codec default is H264
Please set this flag to true if you want MP4 recordings of the live stream.
If true
is passed, the stream will be transcoded into 5 different variants: 720p (HD), 480p (HD_MID), 360p (MID), 240p (MID_LOW), and 240p (LOW) with bitrates of 2628kbps, 1128kbps, 878kbps, 528kbps, and 264kbps, respectively. This will ensure the best possible viewing experience, regardless of the user's network or device.
Please set this flag to true if you want to access the Video on Demand (VOD) URL. The VOD will be available after the live streaming has finished.
Please set this flag to true if you want the participant name to appear in the video tiles.
Please set this flag to true if you want the streaming to be audio-only.
By default, the live streaming layout is optimized for desktop
. If you want it to be optimized for mobile, you can pass the flag mobile
By default, adaptive
bitrate streaming is enabled between the videobridge and recorder for each participant's stream. However, if you want to record and stream each participant's original quality, you can pass the flag as HD
The default time interval for the recorder is 1 minute. If a different time interval is set, the recorder will remain active for that duration, and if all participants leave before the interval ends, a new streaming API call must be made to restart the recording.
A generated response after live streaming started successfully
true if live streaming started successfully
stream name of live streaming
pod name
HLS player URL, is passed when is_low_latency flag is not passed
Low latency HLS player URL, is passed only if is_low_latency is marked true
Video on demain URL, is passed only if is_vod is marked true
RTMP player URL
FLV player URL