Interface IPromptQueryConfig_TranscriptionFormat

public interface IPromptQueryConfig_TranscriptionFormat
Mixin for a prompt query configuration model that allows the user to define the format when transcribing speech to text, such as e.g. plain text or subtitles. It is up to implementations to define which transcription formats are supported, and what their identifiers are. But see CommonTranscriptionFormat for standard names of common transcription formats. We encourage implementations to use these common names to increase interoperability between different prompt service implementations.

Use of this mixin is optional, but ensures a consistent name for the property. When different prompt service handlers use the same property name, switching between different prompt service handlers preserves the configured data.

See also the <xp:transcriptionFormat/> Faces component from the http://www.xima.de/taglib/xfc/prompt namespace, which provides a user interface for editing the data defined by this mixin.

Since:
8.5.0
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ATTR_TRANSCRIPTION_FORMAT
    The name of the transcription format attribute.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getTranscriptionFormat()
    Gets the format to use for generated transcription files, such as e.g. plain text or subtitles.
    void
    setTranscriptionFormat(String transcriptionFormat)
    Sets the format to use for generated transcription, such as e.g. plain text or subtitles.

  • Field Details

    • ATTR_TRANSCRIPTION_FORMAT

      static final String ATTR_TRANSCRIPTION_FORMAT
      The name of the transcription format attribute. If you implement a custom serialization / deserialization, use this name for the attribute to increase compatibility with other prompt service handlers.
      See Also:

  • Method Details

    • getTranscriptionFormat

      String getTranscriptionFormat()
      Gets the format to use for generated transcription files, such as e.g. plain text or subtitles.
      Returns:
      The transcription format.

    • setTranscriptionFormat

      void setTranscriptionFormat(String transcriptionFormat)
      Sets the format to use for generated transcription, such as e.g. plain text or subtitles.
      Parameters:
      transcriptionFormat - The transcription format.