BitmovinApiSdk\Models\WatermarkFilter
Synopsis
class WatermarkFilter
extends Filter
{
- // members
- public string $image;
- public int $left;
- public int $right;
- public int $top;
- public int $bottom;
- public PositionUnit $unit;
- // Inherited members from Filter
- public static string $discriminatorName;
- public static array $discriminatorMapping;
- // 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 image()
- public $this left()
- public $this right()
- public $this top()
- public $this bottom()
- public $this unit()
- // Inherited methods from Filter
- public void __construct()
- // 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
Members
public
- $bottom — int
- $createdAt — Carbon\Carbon
- $customData — mixed
- $description — string
- $discriminatorMapping
- $discriminatorName
- $id — string
- $image — string
- $left — int
- $modifiedAt — Carbon\Carbon
- $name — string
- $right — int
- $top — int
- $unit — BitmovinApiSdk\Models\PositionUnit
Methods
public
- __construct()
- bottom() — Distance from the bottom edge of the input video to the bottom edge of the watermark image. May not be set if 'top' is set.
- image() — URL of the file to be used as watermark image. Supported image formats: PNG, JPEG, BMP, GIF (required)
- left() — Distance from the left edge of the input video to the left edge of the watermark image. May not be set if 'right' is set.
- right() — Distance from the right edge of the input video to the right edge of the watermark image . May not be set if 'left' is set.
- top() — Distance from the top edge of the input video to the top edge of the watermark image. May not be set if 'bottom' is set.
- unit() — Specifies if the values of 'left', 'right', 'top' and 'bottom' are interpreted as pixels or as a percentage of the input video's dimensions.
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.