java.lang.Object
com.azure.resourcemanager.mediaservices.models.Format
com.azure.resourcemanager.mediaservices.models.ImageFormat
Direct Known Subclasses:
JpgFormat, PngFormat

public class ImageFormat extends Format
Describes the properties for an output image file.
  • Constructor Details

    • ImageFormat

      public ImageFormat()
      Creates an instance of ImageFormat class.
  • Method Details

    • withFilenamePattern

      public ImageFormat withFilenamePattern(String filenamePattern)
      Set the filenamePattern property: The file naming pattern used for the creation of output files. The following macros are supported in the file name: {Basename} - An expansion macro that will use the name of the input video file. If the base name(the file suffix is not included) of the input video file is less than 32 characters long, the base name of input video files will be used. If the length of base name of the input video file exceeds 32 characters, the base name is truncated to the first 32 characters in total length. {Extension} - The appropriate extension for this format. {Label} - The label assigned to the codec/layer. {Index} - A unique index for thumbnails. Only applicable to thumbnails. {AudioStream} - string "Audio" plus audio stream number(start from 1). {Bitrate} - The audio/video bitrate in kbps. Not applicable to thumbnails. {Codec} - The type of the audio/video codec. {Resolution} - The video resolution. Any unsubstituted macros will be collapsed and removed from the filename.
      Overrides:
      withFilenamePattern in class Format
      Parameters:
      filenamePattern - the filenamePattern value to set.
      Returns:
      the Format object itself.
    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class Format
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.