API Reference - Non-Interactive Live Streaming

This page describes the API references for Non-Inteactive (Direct Ingestion) Live Streaming

---

Table of Contents

1. Generate JWT Token

2. Start Live Streaming

3. Get Live Viewers Count

4. 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 (Direct Ingestion)

Starts new live streaming

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

Authorization

Bearer

Body

application/json

Starts new live streaming

is_low_latencyboolean

Whether the live streaming needs to be in low latency

Example: true

is_direct_ingestionboolean

Instead of a room, we use direct ingestion to start a live stream, for e.g. from obs

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

Response

200400401422502504

A generated response after live streaming started successfully

Body

application/json

startedboolean

true if live streaming started successfully

stream_pathstring

stream name of live streaming

srt_ingest_urlstring

SRT Ingest URL, for ingestion through the SRT protocol

flv_ingest_urlstring

FLV Ingest URL, for ingestion through the FLV protocol

rtmp_ingest_urlstring

RTMP Ingest URL, for ingestion through the RTMP protocol

flv_play_urlstring

FLV Play URL

Example: "http://streaming-edge-nlb-tcp-bbc5ae3a0d2cb7a3.elb.ap-south-1.amazonaws.com:8080/4zrurnrwrvxxj8xf/wsb3vhnlxcrtdluw.flv?domain=ll_latency_h264"

rtmp_play_urlstring

RTMP Play URL

Example: "rtmp://streaming-edge-nlb-tcp-bbc5ae3a0d2cb7a3.elb.ap-south-1.amazonaws.com:1935/4zrurnrwrvxxj8xf/wsb3vhnlxcrtdluw?domain=ll_latency_h264"

low_latency_hls_urlstring

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

Example: "https://low-latency-edge.sariska.io/original/4zrurnrwrvxxj8xf/wsb3vhnlxcrtdluw/playlist.m3u8"

hls_urlstring

HLS player URL, is passed only if is_low_latency flag is not passed

Example: "https://edge.sariska.io/play/hls/2imjtqyu4udy4ol8/82e28qet2noruyzb.m3u8"

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_path": "text",
  "srt_ingest_url": "text",
  "flv_ingest_url": "text",
  "rtmp_ingest_url": "text",
  "flv_play_url": "http://streaming-edge-nlb-tcp-bbc5ae3a0d2cb7a3.elb.ap-south-1.amazonaws.com:8080/4zrurnrwrvxxj8xf/wsb3vhnlxcrtdluw.flv?domain=ll_latency_h264",
  "rtmp_play_url": "rtmp://streaming-edge-nlb-tcp-bbc5ae3a0d2cb7a3.elb.ap-south-1.amazonaws.com:1935/4zrurnrwrvxxj8xf/wsb3vhnlxcrtdluw?domain=ll_latency_h264",
  "low_latency_hls_url": "https://low-latency-edge.sariska.io/original/4zrurnrwrvxxj8xf/wsb3vhnlxcrtdluw/playlist.m3u8",
  "hls_url": "https://edge.sariska.io/play/hls/2imjtqyu4udy4ol8/82e28qet2noruyzb.m3u8"
}

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
  }
}