Skip to main content
Version: /v2

Start HLS Stream

This API lets you start an HLS stream by passing roomId and config object as body parameters.
Body Parameters
REQUIRED
The ID of the Room.
OPTIONAL
  • orientation - hls stream orientation will be set to "landscape" by default, if you pass portrait orientation then it will stream hls in portrait mode.
  • config:
    • layout:
      • type: "GRID" | "SPOTLIGHT" | "SIDEBAR"
      • priority: "SPEAKER" | "PIN"
      • gridSize: Number max 25
    • orientation: "landscape" | "portrait"
    • theme: "DARK" | "LIGHT" | "DEFAULT"
    • mode: "video-and-audio" | "audio"
    • quality: "low" | "med" | "high"
Response Parameters
Live HLS with playback support
Live HLS without playback sipport
@deprecated
Live HLS with playback support
POST
|
https://api.videosdk.live/v2/hls/start
NodeJS
import fetch from 'node-fetch';
const options = {
	method: "POST",
	headers: {
		"Authorization": "$YOUR_TOKEN",
		"Content-Type": "application/json",
	},
	body: JSON.stringify({"roomId" : "xyz","templateUrl" : "https://www.example.com/?token=tooken&meetingId=74v5-v21l-n1ey&participantId=RECORDER_ID","config" : "configObj"}),
};
const url= `https://api.videosdk.live/v2/hls/start`;
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
RESPONSE
{
  "sessionId": "abcde94c96e17e03fb0abcde4",
  "start": "2022-04-19T09:18:13.432Z",
  "roomId": "abcd-efgh-ijkl",
  "links": {
    "get_room": "https://api.videosdk.live/v2/rooms/abcd-efgh-ijkl",
    "get_session": "https://api.videosdk.live/v2/sessions/abcde94c96e17e03fb0abcde4"
  },
  "downstreamUrl": "https://cdn.videosdk.live/meetings-hls/abcdefgh-ijkl-mnop/index.m3u8",
  "playbackHlsUrl": "https://cdn.videosdk.live/meetings-hls/abcdefgh-ijkl-mnop/index.m3u8",
  "livestreamUrl": "https://cdn.videosdk.live/meetings-hls/abcdefgh-ijkl-mnop/live.m3u8",
  "id": "abcdef9879288c1f48339f64"
}