Interface IPromptQueryConfig_MediaSpeed


  • public interface IPromptQueryConfig_MediaSpeed
    Mixin for a prompt query configuration model that allows the user to define the speed at which a media (e.g. speech or music) file should be generated. 1.0 is normal speed, values less than 1.0 are slower, values greater than 1.0 are faster.

    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:mediaSpeed/> 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 Detail

      • ATTR_MEDIA_SPEED

        static final String ATTR_MEDIA_SPEED
        The name of the media speed 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

      • getMediaSpeed

        Double getMediaSpeed()
        Gets the speed at which a media (e.g. speech or music) file should be generated. 1.0 is normal speed, values less than 1.0 are slower, values greater than 1.0 are faster.
        Returns:
        The media speed.
      • setMediaSpeed

        void setMediaSpeed​(Double mediaSpeed)
        Sets the speed at which a media (e.g. speech or music) file should be generated. 1.0 is normal speed, values less than 1.0 are slower, values greater than 1.0 are faster.
        Parameters:
        mediaSpeed - The media speed.