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;
- // 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()
- // 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
Members
public
- $createdAt — Carbon\Carbon
- $customData — mixed
- $description — string
- $distance — float
- $filename — string
- $height — int
- $id — string
- $imagesPerFile — int
- $modifiedAt — Carbon\Carbon
- $name — string
- $outputs — \BitmovinApiSdk\Models\EncodingOutput[]
- $spriteName — string
- $unit — BitmovinApiSdk\Models\SpriteUnit
- $vttName — string
- $width — int
Methods
public
- __construct()
- 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.
- height() — Height of one thumbnail (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.
- outputs() — outputs
- spriteName() — Name of the sprite image. File extension \".jpg\" or \".png\" is required. (required)
- unit() — unit
- vttName() — Filename of the vtt-file. The file-extension \".vtt\" is required. (required)
- width() — Width of one thumbnail (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.