Package de.xima.fc.prompt.service.support

Interface IPromptQueryConfig_Voice

  • public interface IPromptQueryConfig_Voice
    Mixin for a prompt query configuration model that allows the user to define the name or ID of a voice to use when synthesizing speech.

    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:voice/> 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

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String ATTR_VOICE
      The name of the voice attribute.

    • Field Detail

      • ATTR_VOICE

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

    • Method Detail

      • getVoice

        String getVoice()
        Gets the name or ID of the voice to use for speech synthesis.
        Returns:
        The voice name or ID.

      • setVoice

        void setVoice​(String voice)
        Sets the name or ID of the voice to use for speech synthesis.
        Parameters:
        voice - The voice name or ID.