Class CommonImageFormat


  • public final class CommonImageFormat
    extends Object
    Enumeration for common types of image formats. Certain task types such as speech synthesis produce image files. Some prompt services allow the user to select the format of that image file. Implementations are encouraged to use these constants to increase interoperability between different prompt service implementations, but are not required to do so.
    Since:
    8.5.0
    See Also:
    IPromptQueryConfig_ImageFormat
    • Field Detail

      • BITMAP_IMAGE_FILE

        public static final String BITMAP_IMAGE_FILE
        The Bitmap Image File format, commonly known as "bmp".
        See Also:
        Constant Field Values
      • GRAPHICS_INTERCHANGE_FORMAT

        public static final String GRAPHICS_INTERCHANGE_FORMAT
        The Graphics Interchange Format, commonly known as "gif".
        See Also:
        Constant Field Values
      • HIGH_EFFICIENCY_IMAGE_FILE

        public static final String HIGH_EFFICIENCY_IMAGE_FILE
        The High Efficiency Image File Format, commonly known as "heif".
        See Also:
        Constant Field Values
      • JOINT_PHOTOGRAPHIC_EXPERTS_GROUP

        public static final String JOINT_PHOTOGRAPHIC_EXPERTS_GROUP
        The Joint Photographic Experts Group format, commonly known as "jpeg".
        See Also:
        Constant Field Values
      • JOINT_PHOTOGRAPHIC_EXPERTS_GROUP_2000

        public static final String JOINT_PHOTOGRAPHIC_EXPERTS_GROUP_2000
        The Joint Photographic Experts Group 2000 format, commonly known as "jpeg2000".
        See Also:
        Constant Field Values
      • PORTABLE_NETWORK_GRAPHICS

        public static final String PORTABLE_NETWORK_GRAPHICS
        The Portable Network Graphics format, commonly known as "png".
        See Also:
        Constant Field Values
      • TAGGED_IMAGE_FILE_FORMAT

        public static final String TAGGED_IMAGE_FILE_FORMAT
        The Tagged Image File Format, commonly known as "tiff".
        See Also:
        Constant Field Values
      • WEB_PICTURE

        public static final String WEB_PICTURE
        The Web Picture image format, commonly known as "webp".
        See Also:
        Constant Field Values
    • Method Detail

      • localizedDescription

        public static String localizedDescription​(Locale locale,
                                                  String commonImageFormat)
        Gets the localized description for the given common image format. The value should be one of the constants defined in this class. When an unknown value is given, returns an implementation-defined default description.
        Parameters:
        locale - The locale for which to localize the description.
        commonImageFormat - The common image format constant, must be one of the constants defined in this class.
        Returns:
        The localized description for the given common image format.
      • localizedLabel

        public static String localizedLabel​(Locale locale,
                                            String commonImageFormat)
        Gets the localized label for the given common image format. The value should be one of the constants defined in this class. If any other value is given, returns an implementation-defined default label.
        Parameters:
        locale - The locale for which to localize the label.
        commonImageFormat - The common image format constant, must be one of the constants defined in this class.
        Returns:
        The localized label for the given common image format.
      • mimeType

        public static String mimeType​(String imageFormat)
        Gets the mime type for the given common image format. The value should be one of the constants defined in this class. If any other value is given, returns "application/octet-stream".
        Parameters:
        imageFormat - The common image format constant, must be one of the constants defined in this class.
        Returns:
        The mime type for the given common image format.