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

POSThttps://api.sariska.io/api/v1/misc/generate-token

Body

application/json

Generate JWT Token to use with sariska services

apiKeystring

please pass apiKey with tied with your sariska account

Example: "iufwenufewifweifiuTbddhbdjhjfbjfjwfjwfj"

userobject

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: ""

Response

200401

A successfully generated response for jwt token

Body

application/json

tokenstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.sariska.io/api/v1/misc/generate-token', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200401

{
  "token": "text"
}

1. Start Live Streaming

Starts new live streaming

POSThttps://api.sariska.io/terraform/v1/hooks/srs/startRecording

Authorization

Bearer

Body

application/json

Starts new live streaming

stream_keysarray of StreamKeyModel (object)

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

stream_urlsarray of string

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

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"

Response

200400401422502504

A generated response after live streaming started successfully

Body

application/json

startedboolean

true if live streaming started successfully

stream_namestring

stream name of live streaming

pod_namestring

pod name

hls_urlstring

HLS player URL, is passed when is_low_latency flag is not passed

low_latency_hls_urlstring

Low latency HLS player URL, is passed only if is_low_latency is marked true

vod_urlstring

Video on demain URL, is passed only if is_vod is marked true

rtmp_urlstring

RTMP player URL

flv_urlstring

FLV player URL

Request

JavaScriptCurlPython

const response = await fetch('https://api.sariska.io/terraform/v1/hooks/srs/startRecording', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401422502504

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

1. Stop Live Streaming

Stops already started live streaming

POSThttps://api.sariska.io/terraform/v1/hooks/srs/stopRecording

Authorization

Bearer

Body

application/json

Stops already started live streaming

room_namestring

stops streaming of given room name

Example: "room1234"

Response

200400401422502504

A generated response for successfully stopped streaming

Body

application/json

startedstring

Example: false

Request

JavaScriptCurlPython

const response = await fetch('https://api.sariska.io/terraform/v1/hooks/srs/stopRecording', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401422502504

{
  "started": false
}

1. Get Live Viewers Count

Get all live viewers count

GEThttps://api.sariska.io/terraform/v1/hooks/srs/live/viewers/count/{stream_name}

Path parameters

stream_name*string

Response

200

A generated response for fetching live hls users count

Body

application/json

{stream_name}object

Request

JavaScriptCurlPython

const response = await fetch('https://api.sariska.io/terraform/v1/hooks/srs/live/viewers/count/{stream_name}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

1. Get Live Viewers Count for Low Latency HLS

Get all live viewers count with low latency HLS URL

GEThttps://api.sariska.io/llhls/v1/hooks/srs/live/viewers/count/{stream_name}

Path parameters

stream_name*string

Response

200

A generated response for fetching live hls users count

Body

application/json

{stream_name}object

Request

JavaScriptCurlPython

const response = await fetch('https://api.sariska.io/llhls/v1/hooks/srs/live/viewers/count/{stream_name}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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