Class BroadcastClient

Namespace

Vonage.Video.Broadcast

Assembly

Vonage.dll

Represents a client exposing live broadcast features.

public class BroadcastClient

Inheritance

object

BroadcastClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

AddStreamToBroadcastAsync(Result<AddStreamToBroadcastRequest>)

Adds a stream to a live streaming broadcast.

public Task<Result<Unit>> AddStreamToBroadcastAsync(Result<AddStreamToBroadcastRequest> request)

Parameters

request Result<AddStreamToBroadcastRequest>

The request.

Returns

Task<Result<Unit>>

A success state if the operation succeeded. A failure state with the error message if it failed.

Examples

var request = AddStreamToBroadcastRequest.Build()
    .WithApplicationId(applicationId)
    .WithBroadcastId(broadcastId)
    .WithStreamId(streamId)
    .Create();
var result = await client.VideoClient.BroadcastClient.AddStreamToBroadcastAsync(request);

ChangeBroadcastLayoutAsync(Result<ChangeBroadcastLayoutRequest>)

Dynamically changes the layout type of a live streaming broadcast.

public Task<Result<Unit>> ChangeBroadcastLayoutAsync(Result<ChangeBroadcastLayoutRequest> request)

Parameters

request Result<ChangeBroadcastLayoutRequest>

The request.

Returns

Task<Result<Unit>>

A success state if the operation succeeded. A failure state with the error message if it failed.

Examples

var request = ChangeBroadcastLayoutRequest.Build()
    .WithApplicationId(applicationId)
    .WithBroadcastId(broadcastId)
    .WithLayout(new Layout(null, null, LayoutType.BestFit))
    .Create();
var result = await client.VideoClient.BroadcastClient.ChangeBroadcastLayoutAsync(request);

GetBroadcastAsync(Result<GetBroadcastRequest>)

Retrieves a live streaming broadcast.

public Task<Result<Broadcast>> GetBroadcastAsync(Result<GetBroadcastRequest> request)

Parameters

request Result<GetBroadcastRequest>

The request.

Returns

Task<Result<Broadcast>>

A success state with the broadcast if the operation succeeded. A failure state with the error message if it failed.

Examples

var request = GetBroadcastRequest.Build()
    .WithApplicationId(applicationId)
    .WithBroadcastId(broadcastId)
    .Create();
var result = await client.VideoClient.BroadcastClient.GetBroadcastAsync(request);

GetBroadcastsAsync(Result<GetBroadcastsRequest>)

Retrieves all live streaming broadcasts.

public Task<Result<GetBroadcastsResponse>> GetBroadcastsAsync(Result<GetBroadcastsRequest> request)

Parameters

request Result<GetBroadcastsRequest>

The request.

Returns

Task<Result<GetBroadcastsResponse>>

A success state with broadcasts if the operation succeeded. A failure state with the error message if it failed.

Examples

var request = GetBroadcastsRequest.Build()
    .WithApplicationId(applicationId)
    .Create();
var result = await client.VideoClient.BroadcastClient.GetBroadcastsAsync(request);

RemoveStreamFromBroadcastAsync(Result<RemoveStreamFromBroadcastRequest>)

Removes a stream from a live streaming broadcast.

public Task<Result<Unit>> RemoveStreamFromBroadcastAsync(Result<RemoveStreamFromBroadcastRequest> request)

Parameters

request Result<RemoveStreamFromBroadcastRequest>

The request.

Returns

Task<Result<Unit>>

A success state if the operation succeeded. A failure state with the error message if it failed.

Examples

var request = RemoveStreamFromBroadcastRequest.Build()
    .WithApplicationId(applicationId)
    .WithBroadcastId(broadcastId)
    .WithStreamId(streamId)
    .Create();
var result = await client.VideoClient.BroadcastClient.RemoveStreamFromBroadcastAsync(request);

StartBroadcastsAsync(Result<StartBroadcastRequest>)

Starts a live stream broadcast for a Vonage Video session.

public Task<Result<Broadcast>> StartBroadcastsAsync(Result<StartBroadcastRequest> request)

Parameters

request Result<StartBroadcastRequest>

The request.

Returns

Task<Result<Broadcast>>

A success state with the broadcast if the operation succeeded. A failure state with the error message if it failed.

Examples

var request = StartBroadcastRequest.Build()
    .WithApplicationId(applicationId)
    .WithSessionId(sessionId)
    .WithLayout(new Layout(null, null, LayoutType.BestFit))
    .WithOutputs(outputs)
    .Create();
var result = await client.VideoClient.BroadcastClient.StartBroadcastsAsync(request);

StopBroadcastAsync(Result<StopBroadcastRequest>)

Stops a live stream broadcast.

public Task<Result<Broadcast>> StopBroadcastAsync(Result<StopBroadcastRequest> request)

Parameters

request Result<StopBroadcastRequest>

The request.

Returns

Task<Result<Broadcast>>

A success state with the broadcast if the operation succeeded. A failure state with the error message if it failed.

Examples

var request = StopBroadcastRequest.Build()
    .WithApplicationId(applicationId)
    .WithBroadcastId(broadcastId)
    .Create();
var result = await client.VideoClient.BroadcastClient.StopBroadcastAsync(request);