Struct AddStreamToBroadcastRequest

Namespace

Vonage.Video.Broadcast.AddStreamToBroadcast

Assembly

Vonage.dll

Represents a request to add a stream to a broadcast.

[Builder(new string[] { })]
public readonly struct AddStreamToBroadcastRequest : IVonageRequest, IHasApplicationId, IHasStreamId, IHasBroadcastId

Implements

IVonageRequest

IHasApplicationId

IHasStreamId

IHasBroadcastId

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.

[JsonIgnore]
[Mandatory(0)]
public Guid ApplicationId { get; }

Property Value

Guid

BroadcastId

The broadcast Id.

[JsonIgnore]
[Mandatory(1)]
public Guid BroadcastId { get; }

Property Value

Guid

HasAudio

Disables audio for the stream in the broadcast. Audio is included by default.

[JsonPropertyOrder(1)]
[OptionalBoolean(true, "WithDisabledAudio")]
public bool HasAudio { get; }

Property Value

bool

Examples

.WithDisabledAudio()

HasVideo

Disables video for the stream in the broadcast. Video is included by default.

[JsonPropertyOrder(2)]
[OptionalBoolean(true, "WithDisabledVideo")]
public bool HasVideo { get; }

Property Value

bool

Examples

.WithDisabledVideo()

StreamId

The stream Id.

[JsonPropertyName("addStream")]
[JsonPropertyOrder(0)]
[Mandatory(2)]
public Guid StreamId { get; }

Property Value

Guid

Methods

Build()

public static IBuilderForApplicationId Build()

Returns

IBuilderForApplicationId

BuildRequestMessage()

Converts the request to a HttpRequest.

public HttpRequestMessage BuildRequestMessage()

Returns

HttpRequestMessage

The Http request.