Package com.azure.resourcemanager.mediaservices.models

Class JpgImage

java.lang.Object
com.azure.resourcemanager.mediaservices.models.Codec
com.azure.resourcemanager.mediaservices.models.Video
com.azure.resourcemanager.mediaservices.models.Image
com.azure.resourcemanager.mediaservices.models.JpgImage
public final class JpgImage extends Image
Describes the properties for producing a series of JPEG images from the input video.

  • Constructor Details

    • JpgImage

      public JpgImage()
      Creates an instance of JpgImage class.

  • Method Details

    • layers

      public List<JpgLayer> layers()
      Get the layers property: A collection of output JPEG image layers to be produced by the encoder.
      Returns:
      the layers value.

    • withLayers

      public JpgImage withLayers(List<JpgLayer> layers)
      Set the layers property: A collection of output JPEG image layers to be produced by the encoder.
      Parameters:
      layers - the layers value to set.
      Returns:
      the JpgImage object itself.

    • spriteColumn

      public Integer spriteColumn()
      Get the spriteColumn property: Sets the number of columns used in thumbnail sprite image. The number of rows are automatically calculated and a VTT file is generated with the coordinate mappings for each thumbnail in the sprite. Note: this value should be a positive integer and a proper value is recommended so that the output image resolution will not go beyond JPEG maximum pixel resolution limit 65535x65535.
      Returns:
      the spriteColumn value.

    • withSpriteColumn

      public JpgImage withSpriteColumn(Integer spriteColumn)
      Set the spriteColumn property: Sets the number of columns used in thumbnail sprite image. The number of rows are automatically calculated and a VTT file is generated with the coordinate mappings for each thumbnail in the sprite. Note: this value should be a positive integer and a proper value is recommended so that the output image resolution will not go beyond JPEG maximum pixel resolution limit 65535x65535.
      Parameters:
      spriteColumn - the spriteColumn value to set.
      Returns:
      the JpgImage object itself.

    • withStart

      public JpgImage withStart(String start)
      Set the start property: The position in the input video from where to start generating thumbnails. The value can be in ISO 8601 format (For example, PT05S to start at 5 seconds), or a frame count (For example, 10 to start at the 10th frame), or a relative value to stream duration (For example, 10% to start at 10% of stream duration). Also supports a macro {Best}, which tells the encoder to select the best thumbnail from the first few seconds of the video and will only produce one thumbnail, no matter what other settings are for Step and Range. The default value is macro {Best}.
      Overrides:
      withStart in class Image
      Parameters:
      start - the start value to set.
      Returns:
      the Image object itself.

    • withStep

      public JpgImage withStep(String step)
      Set the step property: The intervals at which thumbnails are generated. The value can be in ISO 8601 format (For example, PT05S for one image every 5 seconds), or a frame count (For example, 30 for one image every 30 frames), or a relative value to stream duration (For example, 10% for one image every 10% of stream duration). Note: Step value will affect the first generated thumbnail, which may not be exactly the one specified at transform preset start time. This is due to the encoder, which tries to select the best thumbnail between start time and Step position from start time as the first output. As the default value is 10%, it means if stream has long duration, the first generated thumbnail might be far away from the one specified at start time. Try to select reasonable value for Step if the first thumbnail is expected close to start time, or set Range value at 1 if only one thumbnail is needed at start time.
      Overrides:
      withStep in class Image
      Parameters:
      step - the step value to set.
      Returns:
      the Image object itself.

    • withRange

      public JpgImage withRange(String range)
      Set the range property: The position relative to transform preset start time in the input video at which to stop generating thumbnails. The value can be in ISO 8601 format (For example, PT5M30S to stop at 5 minutes and 30 seconds from start time), or a frame count (For example, 300 to stop at the 300th frame from the frame at start time. If this value is 1, it means only producing one thumbnail at start time), or a relative value to the stream duration (For example, 50% to stop at half of stream duration from start time). The default value is 100%, which means to stop at the end of the stream.
      Overrides:
      withRange in class Image
      Parameters:
      range - the range value to set.
      Returns:
      the Image object itself.

    • withKeyFrameInterval

      public JpgImage withKeyFrameInterval(Duration keyFrameInterval)
      Set the keyFrameInterval property: The distance between two key frames. The value should be non-zero in the range [0.5, 20] seconds, specified in ISO 8601 format. The default is 2 seconds(PT2S). Note that this setting is ignored if VideoSyncMode.Passthrough is set, where the KeyFrameInterval value will follow the input source setting.
      Overrides:
      withKeyFrameInterval in class Image
      Parameters:
      keyFrameInterval - the keyFrameInterval value to set.
      Returns:
      the Video object itself.

    • withStretchMode

      public JpgImage withStretchMode(StretchMode stretchMode)
      Set the stretchMode property: The resizing mode - how the input video will be resized to fit the desired output resolution(s). Default is AutoSize.
      Overrides:
      withStretchMode in class Image
      Parameters:
      stretchMode - the stretchMode value to set.
      Returns:
      the Video object itself.

    • withSyncMode

      public JpgImage withSyncMode(VideoSyncMode syncMode)
      Set the syncMode property: The Video Sync Mode.
      Overrides:
      withSyncMode in class Image
      Parameters:
      syncMode - the syncMode value to set.
      Returns:
      the Video object itself.

    • withLabel

      public JpgImage withLabel(String label)
      Set the label property: An optional label for the codec. The label can be used to control muxing behavior.
      Overrides:
      withLabel in class Image
      Parameters:
      label - the label value to set.
      Returns:
      the Codec object itself.

    • validate

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