Interface IPromptQueryConfig_AudioFormat

public interface IPromptQueryConfig_AudioFormat
Mixin for a prompt query configuration model that allows the user to define the format of generated audio files, such as e.g. mp3 or wav. It is up to implementations to define which audio formats are supported, and what their identifiers are. But see CommonAudioFormat for standard names of common audio 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 text parameters 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:audioFormat/> 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_AUDIO_FORMAT
    The name of the audio format attribute.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAudioFormat()
    Gets the format to use for generated audio files, such as e.g. mp3 or wav.
    void
    setAudioFormat(String audioFormat)
    Sets the format to use for generated audio files, such as e.g. mp3 or wav.

  • Field Details

    • ATTR_AUDIO_FORMAT

      static final String ATTR_AUDIO_FORMAT
      The name of the audio 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

    • getAudioFormat

      String getAudioFormat()
      Gets the format to use for generated audio files, such as e.g. mp3 or wav.
      Returns:
      The audio format.

    • setAudioFormat

      void setAudioFormat(String audioFormat)
      Sets the format to use for generated audio files, such as e.g. mp3 or wav.
      Parameters:
      audioFormat - The audio format.