BitmovinApiSdk\Models\Thumbnail

Synopsis

class Thumbnail extends BitmovinResource {
  • // Inherited members from BitmovinResponse
  • public string $id;
  • // Inherited methods from BitmovinResponse
  • public void __construct()
  • // Inherited methods from ApiResource
  • public void __construct()
  • public static $this create()
  • public void toArray()
}

Hierarchy

Members

public

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`.
  • height() — Height of the 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 only height is supported and mandatory.
  • interval() — The interval in which to create thumbnails. In seconds (E.g. a value of 4 means create a thumbnail every 4 seconds). Mutually exclusive with positions/unit. Has to be equal to or greater than 1.
  • outputs() — outputs
  • pattern() — Pattern which describes the thumbnail filenames. For example with thumbnail-%number%.png as pattern and 3 positions: thumbnail-3_0.png, thumbnail-5_0.png and thumbnail-25_5.png. (The number represents the position in the source video in seconds, in the previous example the first filename represents the thumbnail at 3s, the second one at 5s and the third one at 25.5s). (required)
  • positions() — Position in the unit where the thumbnail should be created from. Mutually exclusive with interval.
  • unit() — Unit of the values in the positions array.
  • width() — Width of the 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 only height is supported

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