Struct Broadcast

Namespace

Vonage.Video.Broadcast

Assembly

Vonage.dll

Represents a broadcast.

public struct Broadcast

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Properties

ApplicationId

The Vonage Application UUID.

public Guid ApplicationId { readonly get; set; }

Property Value

Guid

BroadcastUrls

An object containing details about the HLS and RTMP broadcasts.

public Broadcast.BroadcastUrl BroadcastUrls { readonly get; set; }

Property Value

Broadcast.BroadcastUrl

CreatedAt

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

public long CreatedAt { readonly get; set; }

Property Value

long

HasAudio

Whether the broadcast has audio.

public bool HasAudio { readonly get; set; }

Property Value

bool

HasVideo

Whether the broadcast has video.

public bool HasVideo { readonly get; set; }

Property Value

bool

Id

The unique ID for the broadcast.

public Guid Id { readonly get; set; }

Property Value

Guid

MaxBitrate

The maximum bitrate for the broadcast stream, in bits per second.

public int MaxBitrate { readonly get; set; }

Property Value

int

MaxDuration

The maximum duration for the broadcast (if one was set), in seconds.

public int MaxDuration { readonly get; set; }

Property Value

int

MultiBroadcastTag

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

public string MultiBroadcastTag { readonly get; set; }

Property Value

string

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). You may want to use a portrait aspect ratio for broadcasts that include video streams from mobile devices (which often use the portrait aspect ratio).

public string Resolution { readonly get; set; }

Property Value

string

SessionId

The Vonage Video session ID.

public string SessionId { readonly get; set; }

Property Value

string

Settings

The settings for the broadcast, including HLS configuration.

public Broadcast.BroadcastSettings Settings { readonly get; set; }

Property Value

Broadcast.BroadcastSettings

Status

Current status of the broadcast.

public Broadcast.BroadcastStatus Status { readonly get; set; }

Property Value

Broadcast.BroadcastStatus

StreamMode

Whether streams included in the broadcast are selected automatically ("auto", the default) or manually ("manual"). When streams are selected automatically ("auto"), all streams in the session can be included in the broadcast. When streams are selected manually ("manual"), you specify streams to be included based on calls to this REST method. You can specify whether a stream's audio, video, or both are included in the broadcast.

public string StreamMode { readonly get; set; }

Property Value

string

Streams

An array of objects corresponding to streams currently being broadcast. This is only set for a broadcast with the status set to "started" and the streamMode set to "manual"

public Broadcast.LiveStream[] Streams { readonly get; set; }

Property Value

LiveStream[]

UpdatedAt

For this start method, this timestamp matches the createdAt timestamp.

public long UpdatedAt { readonly get; set; }

Property Value

long