Skip to content

CreateLiveStream.md

Latest commit

 

History

History
48 lines (37 loc) · 3.47 KB

CreateLiveStream.md

File metadata and controls

48 lines (37 loc) · 3.47 KB

Method: initiateLiveStream()

The initiateLiveStream method allows you to start a live stream with specific configurations. You can define settings for playback, input media, and metadata. This method returns the details of the initiated stream, including the unique streamId and streamKey that you can use for managing further live stream operations.

Parameter Details:

Parameter Description Type Accepted Values
playbackSettings Defines settings related to playback, such as access policy. Object See details below
inputMediaSettings Defines settings related to the media being streamed, such as resolution. Object See details below

playbackSettings

Parameter Description Type Accepted Values
accessPolicy Determines if access to the streamed content is kept private or available to all. String "public", "private"

inputMediaSettings

Parameter Description Type Accepted Values
maxResolution Sets the maximum resolution for the live stream. String "1080p", "720p", "480p"
reconnectWindow The time in seconds to wait before reconnecting the stream if it's interrupted. Integer 60 to 1800 seconds
mediaPolicy Determines whether the recorded stream is private or public when converted to VOD. String "public", "private"
metadata Optional metadata for tagging the live stream. Up to 10 key-value pairs. Object Any valid key-value pair (max 255 characters per key and value)
enableDvrMode Enables or disables DVR mode for the live stream. When enabled, viewers can rewind the stream. Boolean true, false

Example Request:

// Define the live stream request with custom configurations
const liveStreamRequest = {
  playbackSettings: {
    accessPolicy: "public", // Defines the access level of the live stream (public or private)
  },
  inputMediaSettings: {
    maxResolution: "1080p", // Set the maximum resolution of the live stream
    reconnectWindow: 60, // Set the duration for reconnecting the stream in seconds
    mediaPolicy: "public", // Define media policy (public or private)
    enableDvrMode: true, // Enable DVR mode to allow viewers to rewind the live stream
  },
};

// Initiating the live stream
const generateLiveStream = await fastpix.initiateLiveStream(liveStreamRequest);
console.log("Live Stream initiated successfully:", generateLiveStream);