Package com.vonage.client.video

Class CaptionsRequest.Builder

java.lang.Object
com.vonage.client.video.CaptionsRequest.Builder
Enclosing class:
CaptionsRequest
public static final class CaptionsRequest.Builder extends Object
Builder for defining the fields in a StartCaptionsRequest object.

  • Method Details

    • languageCode

      public CaptionsRequest.Builder languageCode(Language languageCode)
      BCP-47 code for a spoken language used on this call. The default value is Language.EN_US.
      Parameters:
      languageCode - The BCP-47 language code as an enum.
      Returns:
      This Builder with the languageCode property setting.

    • statusCallbackUrl

      public CaptionsRequest.Builder statusCallbackUrl(String statusCallbackUrl)
      A publicly reachable URL controlled by the customer and capable of generating the content to be rendered without user intervention. The minimum length of the URL is 15 characters and the maximum length is 2048 characters.
      Parameters:
      statusCallbackUrl - The status callback URL as a string.
      Returns:
      This Builder with the statusCallbackUrl property setting.

    • maxDuration

      public CaptionsRequest.Builder maxDuration(int maxDuration)
      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 seconds.
      Parameters:
      maxDuration - The maximum captions duration in seconds.
      Returns:
      This Builder with the maxDuration property setting.

    • partialCaptions

      public CaptionsRequest.Builder partialCaptions(boolean partialCaptions)
      Whether to enable this to faster captioning at the cost of some degree of inaccuracies. The default value is true.
      Parameters:
      partialCaptions - Whether to enable faster captions.
      Returns:
      This Builder with the partialCaptions property setting.

    • build

      public CaptionsRequest build()
      Builds the StartCaptionsRequest object.
      Returns:
      The StartCaptionsRequest object with this builder's settings.