Interface IPromptQueryConfig_VideoFormat

public interface IPromptQueryConfig_VideoFormat
Mixin for a prompt query configuration model that allows the user to define the format of generated video files, such as e.g. HEVC or Theora. It is up to implementations to define which video formats are supported, and what their identifiers are. But see CommonVideoFormat for standard names of common video 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:videoFormat/> 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_VIDEO_FORMAT
    The name of the video format attribute.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getVideoFormat()
    Gets the format to use for generated video files, such as e.g.
    void
    setVideoFormat(String videoFormat)
    Sets the format to use for generated video files, such as e.g.

  • Field Details

    • ATTR_VIDEO_FORMAT

      static final String ATTR_VIDEO_FORMAT
      The name of the video 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

    • getVideoFormat

      String getVideoFormat()
      Gets the format to use for generated video files, such as e.g. HEVC or Theora.
      Returns:
      The video format.

    • setVideoFormat

      void setVideoFormat(String videoFormat)
      Sets the format to use for generated video files, such as e.g. HEVC or Theora.
      Parameters:
      videoFormat - The video format.