API Reference - Interactive Live Streaming

This page describes the API references for interactive live streaming.

---

Table of Contents

1. Generate JWT Token

2. Start Live Streaming

3. Stop Live Streaming

4. Get Live Viewers Count

5. Get Live Viewers Count for Low Latency Live Streaming

---

1. Generate JWT Token

Generate JWT Token to use with sariska services

post

/api/v1/misc/generate-token

Body

apiKeystring

please pass apiKey with tied with your sariska account

Example: iufwenufewifweifiuTbddhbdjhjfbjfjwfjwfj

expstring

pass exp claim of jwt token

Example: 24 hours

nbfstring

pass nbf claim of jwt token

Example:

scopestring

pass scope of token it can be messaging or media or sariska or leave it blank

Example:

userobject

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.sariska.io/api/v1/misc/generate-token' \
  --header 'Content-Type: application/json'

200

401

200

{
  "token": "text"
}

A successfully generated response for jwt token

1. Start Live Streaming

Starts new live streaming

post

/terraform/v1/hooks/srs/startRecording

Authorizations

Body

room_namestring

The room name recorder needs to join.

Example: room1234

is_low_latencyboolean

Whether the live streaming needs to be in low latency

Example: true

codecstring

The player side codec default is H264

Example: H265

is_recordingboolean

Please set this flag to true if you want MP4 recordings of the live stream.

Example: true

multi_bitrateboolean

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.

Example: true

is_vodboolean

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.

Example: true

usernameboolean

Please set this flag to true if you want the participant name to appear in the video tiles.

Example: true

audio_onlyboolean

Please set this flag to true if you want the streaming to be audio-only.

Example: true

layoutstring

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

Example: mobile

profilestring

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

Example: HD

reconnect_windownumber

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.

Example: 6000 equivalent to 1 min

stream_urlsstring[]

This is a list of additional RTMP URLs for platforms not included in the above-listed platforms or host URL is dynamic

stream_keysobject[]

List of RTMP server keys for simulcast live streaming to all platforms, including Instagram, YouTube, Twitch, Vimeo, Periscope, Facebook, DLive, Mixcloud, and Restream.

Example: [{"key":"youtube","value":"youtube_stream_key"},{"key":"facebook","value":"facebook_stream_key"},{"key":"twitch","value":"twitch_stream_key"},{"key":"vimeo","value":"vimeo_stream_key"},{"key":"instagram","value":"instagram_stream_key"}]

Responses

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.sariska.io/terraform/v1/hooks/srs/startRecording' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"room_name":"room1234","is_low_latency":true,"codec":"H265","is_recording":true,"multi_bitrate":true,"is_vod":true,"username":true,"audio_only":true,"layout":"mobile","profile":"HD","reconnect_window":"6000 equivalent to 1 min","stream_urls":["rtmp://linkedin.{dynamic-secret}.rtmp.url, rtmp://microsoft.{dynamic-secret}.rtmp.url"],"stream_keys":[{"key":"youtube","value":"youtube_stream_key"},{"key":"facebook","value":"facebook_stream_key"},{"key":"twitch","value":"twitch_stream_key"},{"key":"vimeo","value":"vimeo_stream_key"},{"key":"instagram","value":"instagram_stream_key"}]}'

200

400

401

422

502

504

200

{
  "started": true,
  "stream_name": "text",
  "pod_name": "text",
  "hls_url": "text",
  "low_latency_hls_url": "text",
  "vod_url": "text",
  "rtmp_url": "text",
  "flv_url": "text"
}

A generated response after live streaming started successfully

1. Stop Live Streaming

Stops already started live streaming

post

/terraform/v1/hooks/srs/stopRecording

Authorizations

Body

room_namestring

stops streaming of given room name

Example: room1234

Responses

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.sariska.io/terraform/v1/hooks/srs/stopRecording' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json'

200

400

401

422

502

504

200

{
  "started": false
}

A generated response for successfully stopped streaming

1. Get Live Viewers Count

Get all live viewers count

get

/terraform/v1/hooks/srs/live/viewers/count/{stream_name}

Path parameters

stream_namestringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.sariska.io/terraform/v1/hooks/srs/live/viewers/count/{stream_name}'

200

200

{
  "{stream_name}": {
    "current_viewers": 1,
    "uptime": 1
  }
}

A generated response for fetching live hls users count

1. Get Live Viewers Count for Low Latency HLS

Get all live viewers count with low latency HLS URL

get

/llhls/v1/hooks/srs/live/viewers/count/{stream_name}

Path parameters

stream_namestringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.sariska.io/llhls/v1/hooks/srs/live/viewers/count/{stream_name}'

200

200

{
  "{stream_name}": {
    "current_viewers": 1,
    "uptime": 1
  }
}

A generated response for fetching live hls users count