Package com.opentok

Class CaptionProperties

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  CaptionProperties.Builder
      Used to create a CaptionProperties object.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static CaptionProperties.Builder Builder()
      Entry point for constructing an instance of this class.
      java.lang.String getLanguageCode()
      The BCP-47 code for a spoken language used on this call.
      int getMaxDuration()
      The maximum duration for the audio captioning, in seconds.
      java.lang.String getStatusCallbackUrl()
      A publicly reachable URL controlled by the customer and capable of generating the content to be rendered without user intervention.
      boolean partialCaptions()
      Whether faster captioning is enabled at the cost of some degree of inaccuracies.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • getStatusCallbackUrl

        public java.lang.String getStatusCallbackUrl()
        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. For more information, see Live Caption status updates.
        Returns:
        The status callback URL as a string, or null if not set.

      • getLanguageCode

        public java.lang.String getLanguageCode()
        The BCP-47 code for a spoken language used on this call.
        Returns:
        The language code as a string.

      • getMaxDuration

        public int 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 CaptionProperties.Builder Builder()
        Entry point for constructing an instance of this class.
        Returns:
        A new Builder.