Class Thumbnail

Thumbnail

Inheritance
System.Object
BitmovinResponse
BitmovinResource
Thumbnail
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Bitmovin.Api.Sdk.Models
Assembly: Bitmovin.Api.Sdk.dll
Syntax
public class Thumbnail : BitmovinResource

Properties

AspectMode

Specifies the aspect mode that is used when both height and width are specified Only supported starting with encoder version 2.85.0.

Declaration
public ThumbnailAspectMode? AspectMode { get; set; }
Property Value
Type Description
System.Nullable<ThumbnailAspectMode>

Height

Height of the thumbnail, either height or width are required fields. If only one is given the encoder will calculate the other way value based on the aspect ratio of the video file. If the encoder version is below 2.83.0 only height is supported and mandatory.

Declaration
public int? Height { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

Interval

The interval in which to create thumbnails. In seconds (E.g. a value of 4 means create a thumbnail every 4 seconds). Mutually exclusive with positions/unit. Has to be equal to or greater than 1.

Declaration
public double? Interval { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

Outputs

Outputs

Declaration
public List<EncodingOutput> Outputs { get; set; }
Property Value
Type Description
System.Collections.Generic.List<EncodingOutput>

Pattern

Pattern which describes the thumbnail filenames. For example with thumbnail-%number%.png as pattern and 3 positions: thumbnail-3_0.png, thumbnail-5_0.png and thumbnail-25_5.png. (The number represents the position in the source video in seconds, in the previous example the first filename represents the thumbnail at 3s, the second one at 5s and the third one at 25.5s). (required)

Declaration
public string Pattern { get; set; }
Property Value
Type Description
System.String

Positions

Position in the unit where the thumbnail should be created from. Mutually exclusive with interval.

Declaration
public List<double?> Positions { get; set; }
Property Value
Type Description
System.Collections.Generic.List<System.Nullable<System.Double>>

Unit

Unit of the values in the positions array.

Declaration
public ThumbnailUnit? Unit { get; set; }
Property Value
Type Description
System.Nullable<ThumbnailUnit>

Width

Width of the thumbnail, either height or width are required fields. If only one is given the encoder will calculate the other way value based on the aspect ratio of the video file. If the encoder version is below 2.83.0 only height is supported

Declaration
public int? Width { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>