BitmovinApiSdk\Models\Av1VideoConfiguration

Synopsis

class Av1VideoConfiguration extends VideoConfiguration {

// members
public Av1PresetConfiguration $presetConfiguration;
public AutoLevelSetup $autoLevelSetup;

// Inherited members from VideoConfiguration
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 presetConfiguration()
public $this autoLevelSetup()

// Inherited methods from VideoConfiguration
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

Extends

BitmovinApiSdk\Models\VideoConfiguration

Members

public

$autoLevelSetup — BitmovinApiSdk\Models\AutoLevelSetup
$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
$presetConfiguration — BitmovinApiSdk\Models\Av1PresetConfiguration
$rate — float
$sampleAspectRatioDenominator — int
$sampleAspectRatioNumerator — int
$width — int

Methods

public

__construct()
autoLevelSetup() — Enable/disable automatic calculation of level, maxBitrate, and bufsize based on the least level that satisfies maximum property values for picture resolution, frame rate, and bit rate. In the case the target level is set explicitly, the maximum bitrate and buffer size are calculated based on the defined level. Explicitly setting maxBitrate, or bufsize properties will disable the automatic calculation.
presetConfiguration() — Use a set of well defined configurations preset to support certain use cases. Can be overwritten with more specific values.

Inherited from BitmovinApiSdk\Models\VideoConfiguration

public

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.

Inherited from BitmovinApiSdk\Common\ApiResource

public

create()
toArray() — Create array with values, skip null and empty arrays