BitmovinApiSdk\Models\VideoConfiguration
Synopsis
class VideoConfiguration
extends CodecConfiguration
{
- // members
- public int $width;
- public int $height;
- public int $bitrate;
- public float $rate;
- public PixelFormat $pixelFormat;
- public ColorConfig $colorConfig;
- public int $sampleAspectRatioNumerator;
- public int $sampleAspectRatioDenominator;
- public DisplayAspectRatio $displayAspectRatio;
- public EncodingMode $encodingMode;
- // Inherited members from CodecConfiguration
- 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 width()
- public $this height()
- public $this bitrate()
- public $this rate()
- public $this pixelFormat()
- public $this colorConfig()
- public $this sampleAspectRatioNumerator()
- public $this sampleAspectRatioDenominator()
- public $this displayAspectRatio()
- public $this encodingMode()
- // Inherited methods from CodecConfiguration
- 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
Members
public
- $bitrate — int
- $colorConfig — BitmovinApiSdk\Models\ColorConfig
- $createdAt — Carbon\Carbon
- $customData — mixed
- $description — string
- $discriminatorMapping
- $discriminatorName
- $displayAspectRatio — BitmovinApiSdk\Models\DisplayAspectRatio
- $encodingMode — BitmovinApiSdk\Models\EncodingMode
- $height — int
- $id — string
- $modifiedAt — Carbon\Carbon
- $name — string
- $pixelFormat — BitmovinApiSdk\Models\PixelFormat
- $rate — float
- $sampleAspectRatioDenominator — int
- $sampleAspectRatioNumerator — int
- $width — int
Methods
public
- __construct()
- bitrate() — Target bitrate for the encoded video in bps. Either bitrate or crf is required.
- colorConfig() — colorConfig
- displayAspectRatio() — Specifies a display aspect ratio (DAR) to be enforced. The sample aspect ratio (SAR) will be adjusted accordingly. If set then sampleAspectRatioNumerator and sampleAspectRatioDenominator are not allowed.
- encodingMode() — The mode of the encoding. When this is set, `encodingMode` (`liveEncodingMode`) must not be set in the (live) encoding start request.
- height() — Height of the encoded video in pixels
- pixelFormat() — Describes the color encoding, bit depth, and chroma subsampling of each pixel in the output image.
- rate() — Target frame rate of the encoded video. Must be set for live encodings
- sampleAspectRatioDenominator() — The denominator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioNumerator is set. If set then displayAspectRatio is not allowed.
- sampleAspectRatioNumerator() — The numerator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioDenominator is set. If set then displayAspectRatio is not allowed.
- width() — Width of the encoded video in pixels
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.