Suggestions

close search

Add Messaging, Voice, and Authentication to your apps with Vonage Communications APIs

Visit the Vonage API Developer Portal

OpenTokSDK.Broadcast

Represents a broadcast of an Vonage Video API session. More...

Classes

class  BroadcastHlsSettings
 Provides details on an HLS stream. More...
class  BroadcastSettings
 Provides details on an HLS broadcast stream. This object includes an hls property that specifies whether DVR functionality and low-latency mode are enabled for the HLS stream. More...

Public Types

enum  BroadcastStatus { BroadcastStatus.STOPPED, BroadcastStatus.STARTED }
 Defines values returned by the Status property of a Broadcast object. More...

Public Member Functions

void Stop ()
 Stops the live broadcasting if it is started. More...

Protected Member Functions

 Broadcast ()
 Initializes a new instance of the Broadcast class. More...

Properties

string Id [get, set]
 The broadcast ID. More...
string SessionId [get, set]
 The session ID of the Vonage Video API session associated with this broadcast. More...
int ProjectId [get, set]
 The Vonage Video API key associated with the broadcast. More...
long CreatedAt [get, set]
 The time the broadcast started, expressed in milliseconds since the Unix epoch (January 1, 1970, 00:00:00 UTC). More...
long UpdatedAt [get, set]
 The time the broadcast was updated, in milliseconds since the Unix epoch (January 1, 1970, 00:00:00 UTC). More...
string Resolution [get, set]
 The resolution of the broadcast: either "640x480" (SD landscape, the default), "1280x720" (HD landscape), "1920x1080" (FHD landscape), "480x640" (SD portrait), "720x1280" (HD portrait), or "1080x1920" (FHD portrait). More...
BroadcastStatus Status [get, set]
 The status of the broadcast: either "started" or "stopped". More...
int MaxDuration [get, set]
 The maximun duration of the broadcast. More...
List< RtmpRtmpList [get, set]
 The RTMP List. More...
string Hls [get, set]
 HLS Url. More...
StreamMode StreamMode [get, set]
 Whether streams included in the broadcast are selected automatically ("auto", the default) or manually More...
BroadcastSettings Settings [get, set]
 Provides details on an HLS broadcast stream. This includes information on whether the stream supports DVR functionality and low-latency mode. More...
string MultiBroadcastTag [get, set]
 The unique tag for simultaneous broadcasts (if one was set). More...

Detailed Description

Represents a broadcast of an Vonage Video API session.

Member Enumeration Documentation

◆ BroadcastStatus

Defines values returned by the Status property of a Broadcast object.

Enumerator
STOPPED 

The broadcast is stopped.

STARTED 

The broadcast is started.

Constructor & Destructor Documentation

◆ Broadcast()

OpenTokSDK.Broadcast.Broadcast ( )

Initializes a new instance of the Broadcast class.

Member Function Documentation

◆ Stop()

void OpenTokSDK.Broadcast.Stop ( )

Stops the live broadcasting if it is started.

Property Documentation

◆ CreatedAt

long OpenTokSDK.Broadcast.CreatedAt

The time the broadcast started, expressed in milliseconds since the Unix epoch (January 1, 1970, 00:00:00 UTC).

◆ Hls

string OpenTokSDK.Broadcast.Hls

HLS Url.

◆ Id

string OpenTokSDK.Broadcast.Id

The broadcast ID.

◆ MaxDuration

int OpenTokSDK.Broadcast.MaxDuration

The maximun duration of the broadcast.

◆ MultiBroadcastTag

string OpenTokSDK.Broadcast.MultiBroadcastTag

The unique tag for simultaneous broadcasts (if one was set).

◆ ProjectId

int OpenTokSDK.Broadcast.ProjectId

The Vonage Video API key associated with the broadcast.

◆ Resolution

string OpenTokSDK.Broadcast.Resolution

The resolution of the broadcast: either "640x480" (SD landscape, the default), "1280x720" (HD landscape), "1920x1080" (FHD landscape), "480x640" (SD portrait), "720x1280" (HD portrait), or "1080x1920" (FHD portrait).

◆ RtmpList

List<Rtmp> OpenTokSDK.Broadcast.RtmpList

The RTMP List.

◆ SessionId

string OpenTokSDK.Broadcast.SessionId

The session ID of the Vonage Video API session associated with this broadcast.

◆ Settings

BroadcastSettings OpenTokSDK.Broadcast.Settings

Provides details on an HLS broadcast stream. This includes information on whether the stream supports DVR functionality and low-latency mode.

◆ Status

BroadcastStatus OpenTokSDK.Broadcast.Status

The status of the broadcast: either "started" or "stopped".

◆ StreamMode

StreamMode OpenTokSDK.Broadcast.StreamMode

Whether streams included in the broadcast are selected automatically ("auto", the default) or manually

◆ UpdatedAt

long OpenTokSDK.Broadcast.UpdatedAt

The time the broadcast was updated, in milliseconds since the Unix epoch (January 1, 1970, 00:00:00 UTC).