Table of Contents

Interface IBuilderForOptional

Namespace
Vonage.Video.LiveCaptions.Start
Assembly
Vonage.dll
public interface IBuilderForOptional : IVonageRequestBuilder<StartRequest>
Inherited Members

Methods

DisablePartialCaptions()

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

IBuilderForOptional DisablePartialCaptions()

Returns

IBuilderForOptional

Examples

.DisablePartialCaptions()

WithLanguage(string)

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

IBuilderForOptional WithLanguage(string value)

Parameters

value string

Returns

IBuilderForOptional

Examples

.WithLanguage("es-ES")

WithMaxDuration(int)

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).

IBuilderForOptional WithMaxDuration(int value)

Parameters

value int

Returns

IBuilderForOptional

Examples

.WithMaxDuration(3600)

WithStatusCallbackUrl(Uri)

Sets the callback URL for captioning status events.

IBuilderForOptional WithStatusCallbackUrl(Uri value)

Parameters

value Uri

Returns

IBuilderForOptional

Examples

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