Table of Contents

Struct StartRequest

Namespace
Vonage.Video.LiveCaptions.Start
Assembly
Vonage.dll
[Builder(new string[] { })]
public readonly struct StartRequest : IVonageRequest
Implements
Inherited Members

Properties

ApplicationId

Sets the Vonage Application UUID.

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

Property Value

Guid

Examples

.WithApplicationId(applicationId)

Language

Sets the BCP-47 code for a spoken language used on this call. The default value is "en-US".

[JsonPropertyOrder(2)]
[JsonPropertyName("languageCode")]
[OptionalWithDefault("string", "en-US")]
public string Language { get; }

Property Value

string

Examples

.WithLanguage("es-ES")

MaxDuration

Sets the maximum duration for the audio captioning, in seconds. The default value is 14,400 seconds (4 hours), the maximum duration allowed. The minimum value is 300 (5 minutes).

[JsonPropertyOrder(3)]
[OptionalWithDefault("int", "14400")]
public int MaxDuration { get; }

Property Value

int

Examples

.WithMaxDuration(3600)

PartialCaptions

Disables partial captions. Partial captions are enabled by default for faster captioning at the cost of some degree of inaccuracies.

[JsonPropertyOrder(4)]
[OptionalBoolean(true, "DisablePartialCaptions")]
public bool PartialCaptions { get; }

Property Value

bool

Examples

.DisablePartialCaptions()

SessionId

Sets the Vonage Video session ID. The audio from Publishers publishing into this session will be used to generate the captions.

[JsonPropertyOrder(0)]
[Mandatory(1)]
public string SessionId { get; }

Property Value

string

Examples

.WithSessionId("flR1ZSBPY3QgMjkgMTI6MTM6MjMgUERUIDIwMTN")

StatusCallbackUrl

Sets the callback URL for captioning status events.

[JsonPropertyOrder(5)]
[JsonConverter(typeof(MaybeJsonConverter<Uri>))]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public Maybe<Uri> StatusCallbackUrl { get; }

Property Value

Maybe<Uri>

Examples

.WithStatusCallbackUrl(new Uri("https://example.com/captions/status"))

Token

Sets the Vonage Video token with role set to Moderator.

[JsonPropertyOrder(1)]
[Mandatory(2)]
public string Token { get; }

Property Value

string

Examples

.WithToken("eyJ0eXAiOiJKV1Q...")

Methods

Build() 

public static IBuilderForApplicationId Build()

Returns

IBuilderForApplicationId

BuildRequestMessage()

Converts the request to a HttpRequest.

public HttpRequestMessage BuildRequestMessage()

Returns

HttpRequestMessage

The Http request.