BitmovinApiSdk\Models\Sprite

Synopsis

class Sprite extends BitmovinResource {

// members
public int $height;
public int $width;
public SpriteUnit $unit;
public float $distance;
public string $spriteName;
public string $filename;
public string $vttName;
public array $outputs;
public int $imagesPerFile;
public int $hTiles;
public int $vTiles;
public SpriteJpegConfig $jpegConfig;
public SpriteCreationMode $creationMode;
public ThumbnailAspectMode $aspectMode;

// Inherited members from BitmovinResource
public string $name;
public string $description;
public Carbon $createdAt;
public Carbon $modifiedAt;
public mixed $customData;

// Inherited members from BitmovinResponse
public string $id;

// methods
public void __construct()
public $this height()
public $this width()
public $this unit()
public $this distance()
public $this spriteName()
public $this filename()
public $this vttName()
public $this outputs()
public $this imagesPerFile()
public $this hTiles()
public $this vTiles()
public $this jpegConfig()
public $this creationMode()
public $this aspectMode()

// Inherited methods from BitmovinResource
public void __construct()
public $this name()
public $this description()
public $this customData()

// Inherited methods from BitmovinResponse
public void __construct()

// Inherited methods from ApiResource
public void __construct()
public static $this create()
public void toArray()

}

Hierarchy

Extends

BitmovinApiSdk\Models\BitmovinResource

Members

public

$aspectMode — BitmovinApiSdk\Models\ThumbnailAspectMode
$createdAt — Carbon\Carbon
$creationMode — BitmovinApiSdk\Models\SpriteCreationMode
$customData — mixed
$description — string
$distance — float
$filename — string
$hTiles — int
$height — int
$id — string
$imagesPerFile — int
$jpegConfig — BitmovinApiSdk\Models\SpriteJpegConfig
$modifiedAt — Carbon\Carbon
$name — string
$outputs — \BitmovinApiSdk\Models\EncodingOutput[]
$spriteName — string
$unit — BitmovinApiSdk\Models\SpriteUnit
$vTiles — int
$vttName — string
$width — int

Methods

public

__construct()
aspectMode() — Specifies the aspect mode that is used when both height and width are specified Only supported starting with encoder version `2.85.0`.
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`.
distance() — Distance in the given unit between a screenshot
filename() — Filename of the sprite image. If not set, spriteName will be used, but without an extension.
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`.
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
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.
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`
outputs() — outputs
spriteName() — Name of the sprite image. File extension \".jpg\"/\".jpeg\" or \".png\" is required. (required)
unit() — unit
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`.
vttName() — Filename of the vtt-file. The file-extension \".vtt\" is required.
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

Inherited from BitmovinApiSdk\Models\BitmovinResource

public

customData() — User-specific meta data. This can hold anything.
description() — Description of the resource. Can be freely chosen by the user.
name() — Name of the resource. Can be freely chosen by the user.

Inherited from BitmovinApiSdk\Common\ApiResource

public

create()
toArray() — Create array with values, skip null and empty arrays