Package com.vonage.client.video

Class CaptionsRequest

java.lang.Object

com.vonage.client.JsonableBaseObject

com.vonage.client.video.CaptionsRequest

All Implemented Interfaces:

Jsonable

public final class CaptionsRequest
extends JsonableBaseObject

Defines the captioning properties used in VideoClient.startCaptions(CaptionsRequest).

Since:

8.5.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CaptionsRequest.Builder	Builder for defining the fields in a StartCaptionsRequest object.

Method Summary

Modifier and Type	Method	Description
static CaptionsRequest.Builder	builder()	Entry point for constructing an instance of this class.
Language	getLanguageCode()	Spoken language used on this call in BCP-47 format.
Integer	getMaxDuration()	The maximum duration for the audio captioning, in seconds.
String	getSessionId()	Unique identifier of the Vonage Video session.
URI	getStatusCallbackUrl()	A publicly reachable URL controlled by the customer and capable of generating the content to be rendered without user intervention.
String	getToken()	JSON Web Token with the appropriate roles for this request.
Boolean	partialCaptions()	Whether faster captioning is enabled at the cost of some degree of inaccuracies.

Methods inherited from class com.vonage.client.JsonableBaseObject

createJsonObjectMapper, equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.vonage.client.Jsonable

toJson, updateFromJson

Method Details

getStatusCallbackUrl

public URI getStatusCallbackUrl()

A publicly reachable URL controlled by the customer and capable of generating the content to be rendered without user intervention.

Returns:

The status callback URL, or null if not set.

getLanguageCode

public Language getLanguageCode()

Spoken language used on this call in BCP-47 format.

Returns:

The language code as an enum.

getMaxDuration

public Integer getMaxDuration()

The maximum duration for the audio captioning, in seconds.

Returns:

The maximum captioning duration as an integer.

partialCaptions

public Boolean partialCaptions()

Whether faster captioning is enabled at the cost of some degree of inaccuracies.

Returns:

true if the partial captions setting is enabled.

builder

public static CaptionsRequest.Builder builder()

Entry point for constructing an instance of this class.

Returns:

A new Builder.

getSessionId

public String getSessionId()

Unique identifier of the Vonage Video session.

Returns:

The session ID as a string.

getToken

public String getToken()

JSON Web Token with the appropriate roles for this request.

Returns:

The Base64-encoded JWT as a string.