Class LiveCaptionsClient

Namespace

Vonage.Video.LiveCaptions

Assembly

Vonage.dll

Represents a client exposing Live Captions features.

public class LiveCaptionsClient

Inheritance

object

LiveCaptionsClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

StartAsync(Result<StartRequest>)

Starts real-time Live Captions for a Vonage Video Session.

public Task<Result<StartResponse>> StartAsync(Result<StartRequest> request)

Parameters

request Result<StartRequest>

The request.

Returns

Task<Result<StartResponse>>

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

Examples

var request = StartRequest.Build()
    .WithApplicationId(applicationId)
    .WithSessionId(sessionId)
    .WithToken(token)
    .Create();
var result = await client.VideoClient.LiveCaptionsClient.StartAsync(request);

StopAsync(Result<StopRequest>)

Stops live captions for a session

public Task<Result<Unit>> StopAsync(Result<StopRequest> request)

Parameters

request Result<StopRequest>

The request.

Returns

Task<Result<Unit>>

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

Examples

var request = StopRequest.Parse(applicationId, captionsId);
var result = await client.VideoClient.LiveCaptionsClient.StopAsync(request);