JpgImage Class

Definition

Namespace:

Microsoft.Azure.Management.Media.Models

Assembly:

Microsoft.Azure.Management.Media.dll

Package:

Microsoft.Azure.Management.Media v6.0.0

Describes the properties for producing a series of JPEG images from the input video.

[Newtonsoft.Json.JsonObject("#Microsoft.Media.JpgImage")]
public class JpgImage : Microsoft.Azure.Management.Media.Models.Image

[<Newtonsoft.Json.JsonObject("#Microsoft.Media.JpgImage")>]
type JpgImage = class
    inherit Image

Public Class JpgImage
Inherits Image

Inheritance

Object

Codec

Video

Image

JpgImage

Attributes

Newtonsoft.Json.JsonObjectAttribute

Constructors

JpgImage()	Initializes a new instance of the JpgImage class.
JpgImage(String, String, Nullable<TimeSpan>, Nullable<StretchMode>, Nullable<VideoSyncMode>, String, String, IList<JpgLayer>, Nullable<Int32>)	Initializes a new instance of the JpgImage class.

Properties

KeyFrameInterval	Gets or sets 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. (Inherited from Video)
Label	Gets or sets an optional label for the codec. The label can be used to control muxing behavior. (Inherited from Codec)
Layers	Gets or sets a collection of output JPEG image layers to be produced by the encoder.
Range	Gets or sets 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. (Inherited from Image)
SpriteColumn	Gets or sets 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.
Start	Gets or sets 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}. (Inherited from Image)
Step	Gets or sets 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. (Inherited from Image)
StretchMode	Gets or sets the resizing mode - how the input video will be resized to fit the desired output resolution(s). Default is AutoSize. Possible values include: 'None', 'AutoSize', 'AutoFit' (Inherited from Video)
SyncMode	Gets or sets the Video Sync Mode. Possible values include: 'Auto', 'Passthrough', 'Cfr', 'Vfr' (Inherited from Video)

Methods

Validate()

Validate the object.