Class Sprite

Sprite

Inheritance

System.Object

BitmovinResponse

BitmovinResource

Sprite

Inherited Members

BitmovinResource.Name

BitmovinResource.Description

BitmovinResource.CreatedAt

BitmovinResource.ModifiedAt

BitmovinResource.CustomData

BitmovinResponse.Id

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 Sprite : 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>

CreationMode

The creation mode for the thumbnails in the Sprite. Two possible creation modes exist: generate thumbnails starting with the beginning of the video or after the first configured period. When using distance=10 and unit=SECONDS and INTERVAL_END, the first image of the sprite is from the second 10 of the video. When using distance=10 and unit=SECONDS and INTERVAL_START, the first image of the sprite is from the very start of the video, while the second image is from second 10 of the video. It is recommended to use 'INTERVAL_START' when using the sprites for trick play so that there is an additional thumbnail from the beginning of the video. Only supported starting with encoder version 2.76.0.

Declaration

public SpriteCreationMode? CreationMode { get; set; }

Property Value

Type	Description
System.Nullable<SpriteCreationMode>

Distance

Distance in the given unit between a screenshot

Declaration

public double? Distance { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>

Filename

Filename of the sprite image. If not set, spriteName will be used, but without an extension.

Declaration

public string Filename { get; set; }

Property Value

Type	Description
System.String

Height

Height of one 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 both are required

Declaration

public int? Height { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

HTiles

Number of rows of images per file. Has to be set together with vTiles. If this property and vTiles are set, the imagesPerFile property must not be set. It is recommended to use the placeholder '%number%' in the spriteName to allow the generation of multiple sprites. Only supported starting with encoder version 2.76.0.

Declaration

public int? HTiles { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

ImagesPerFile

Number of images per file. If more images are generated than specified in this value, multiple sprites will be created. You can use the placeholder '%number%' in the spriteName to specify the naming policy. Either this property must be set or hTiles and vTiles.

Declaration

public int? ImagesPerFile { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

JpegConfig

Additional configuration for JPEG sprite generation. If this property is set the extension of the file must be '.jpg.' or '.jpeg' Only supported starting with encoder version 2.76.0

Declaration

public SpriteJpegConfig JpegConfig { get; set; }

Property Value

Type	Description
SpriteJpegConfig

Outputs

Outputs

Declaration

public List<EncodingOutput> Outputs { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<EncodingOutput>

SpriteName

Name of the sprite image. File extension ".jpg"/".jpeg" or ".png" is required. (required)

Declaration

public string SpriteName { get; set; }

Property Value

Type	Description
System.String

Unit

Unit

Declaration

public SpriteUnit? Unit { get; set; }

Property Value

Type	Description
System.Nullable<SpriteUnit>

VTiles

Number of columns of images per file. Has to be set together with hTiles. If this property and hTiles are set, the imagesPerFile property must not be set. It is recommended to use the placeholder '%number%' in the spriteName to allow the generation of multiple sprites. Only supported starting with encoder version 2.76.0.

Declaration

public int? VTiles { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

VttName

Filename of the vtt-file. The file-extension ".vtt" is required.

Declaration

public string VttName { get; set; }

Property Value

Type	Description
System.String

Width

Width of one 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 both are required

Declaration

public int? Width { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>