Class CommonTranscriptionFormat

java.lang.Object
de.xima.fc.prompt.service.support.CommonTranscriptionFormat
public final class CommonTranscriptionFormat extends Object
Enumeration for common types of transcription formats, when transcribing speech to text. Some prompt services allow the user to select the format for the transcription. Implementations are encouraged to use these constants to increase interoperability between different prompt service implementations, but are not required to do so.
Since:
8.5.0
See Also:

  • Field Details

    • ADVANCED_SUB_STATION_ALPHA

      public static final String ADVANCED_SUB_STATION_ALPHA
      The Advanced SubStation Alpha subtitle format, commonly known as "ass".
      See Also:

    • PLAIN_TEXT

      public static final String PLAIN_TEXT
      A plain string with the entire transcribed text, without any additional metadata.
      See Also:

    • SEGMENTED_TEXT

      public static final String SEGMENTED_TEXT
      Produce a list of segments, with additional metadata for each segment, such as the name of the speaker or the start and end time of the segment.
      See Also:

    • SUB_RIP_TEXT

      public static final String SUB_RIP_TEXT
      The SubRip text subtitle format, commonly known as "srt".
      See Also:

    • SUB_STATION_ALPHA

      public static final String SUB_STATION_ALPHA
      The SubStation Alpha subtitle format, commonly known as "ssa".
      See Also:

    • VIDEO_TEXT_TRACKS

      public static final String VIDEO_TEXT_TRACKS
      The Video Text Tracks subtitle format, commonly known as "vtt".
      See Also:

  • Method Details

    • icon

      public static IGuiIcon icon(String commonTranscriptionFormat)
      Gets the icon for the given common transcription format. The value should be one of the constants defined in this class. If any other value is given, returns an implementation-defined default icon.
      Parameters:
      commonTranscriptionFormat - The common transcription format constant, should be one of the constants defined in this class.
      Returns:
      The icon for the given common transcription format.

    • localizedDescription

      public static String localizedDescription(Locale locale, String commonTranscriptionFormat)
      Gets the localized description for the given common transcription format. The value should be one of the constants defined in this class. When an unknown value is given, returns an implementation-defined default description.
      Parameters:
      locale - The locale for which to localize the description.
      commonTranscriptionFormat - The common transcription format constant, must be one of the constants defined in this class.
      Returns:
      The localized description for the given common transcription format.

    • localizedLabel

      public static String localizedLabel(Locale locale, String commonTranscriptionFormat)
      Gets the localized label for the given common transcription format. The value should be one of the constants defined in this class. If any other value is given, returns an implementation-defined default label.
      Parameters:
      locale - The locale for which to localize the label.
      commonTranscriptionFormat - The common transcription format constant, must be one of the constants defined in this class.
      Returns:
      The localized label for the given common transcription format.