close search

Add Messaging, Voice, and Authentication to your apps with Nexmo APIs

Visit Nexmo


Public Types

enum  BroadcastStatus { BroadcastStatus.STOPPED, BroadcastStatus.STARTED }

Public Member Functions

void Stop ()


string Id [get, set]
String SessionId [get, set]
int ProjectId [get, set]
long CreatedAt [get, set]
long UpdatedAt [get, set]
string Resolution [get, set]
BroadcastStatus Status [get, set]
int MaxDuration [get, set]
List< RtmpRtmpList [get, set]
String Hls [get, set]

Detailed Description

Represents a broadcast of an OpenTok session.

Member Enumeration Documentation

◆ BroadcastStatus

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


The broadcast is stopped


The broadcast is started

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


◆ Id

string OpenTokSDK.Broadcast.Id

The broadcast ID.

◆ MaxDuration

int OpenTokSDK.Broadcast.MaxDuration

The maximun duration of the broadcast

◆ ProjectId

int OpenTokSDK.Broadcast.ProjectId

The OpenTok API key associated with the broadcast.

◆ Resolution

string OpenTokSDK.Broadcast.Resolution

The resolution of the broadcast: either "640x480" (SD, the default) or "1280x720" (HD).

◆ RtmpList

List<Rtmp> OpenTokSDK.Broadcast.RtmpList

The RTMP List

◆ SessionId

String OpenTokSDK.Broadcast.SessionId

The session ID of the OpenTok session associated with this broadcast.

◆ Status

BroadcastStatus OpenTokSDK.Broadcast.Status

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

◆ UpdatedAt

long OpenTokSDK.Broadcast.UpdatedAt

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