BitmovinApiSdk\Models\CustomTag
Synopsis
class CustomTag
extends BitmovinResource
{
- // members
- public PositionMode $positionMode;
- public string $keyframeId;
- public float $time;
- public int $segment;
- public string $data;
- // 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 positionMode()
- public $this keyframeId()
- public $this time()
- public $this segment()
- public $this data()
- // 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
- $data — string
- $description — string
- $id — string
- $keyframeId — string
- $modifiedAt — Carbon\Carbon
- $name — string
- $positionMode — BitmovinApiSdk\Models\PositionMode
- $segment — int
- $time — float
Methods
public
- __construct()
- data() — The data to be contained in the custom tag. (required)
- keyframeId() — Id of keyframe where the custom tag should be inserted. Required, when KEYFRAME is selected as position mode.
- positionMode() — The positioning mode that should be used when inserting the placement opportunity (required)
- segment() — The custom tag will be inserted before the specified segment. Required, when SEGMENT is selected as position mode.
- time() — Time in seconds where the custom tag should be inserted. Required, when TIME is selected as position mode.
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.