BitmovinApiSdk\Models\Encoding
Synopsis
class Encoding
extends BitmovinResource
{
- // members
- public EncodingType $type;
- public Carbon $startedAt;
- public Carbon $queuedAt;
- public Carbon $runningAt;
- public Carbon $finishedAt;
- public Carbon $errorAt;
- public int $progress;
- public CloudRegion $cloudRegion;
- public array $fallbackCloudRegions;
- public string $encoderVersion;
- public InfrastructureSettings $infrastructure;
- public string $staticIpId;
- public string $selectedEncoderVersion;
- public EncodingMode $selectedEncodingMode;
- public CloudRegion $selectedCloudRegion;
- public array $selectedFallbackCloudRegions;
- public Status $status;
- public array $labels;
- public LiveOptionsType $liveOptionsType;
- // 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 cloudRegion()
- public $this fallbackCloudRegions()
- public $this encoderVersion()
- public $this infrastructure()
- public $this staticIpId()
- public $this labels()
- // 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
- $cloudRegion — BitmovinApiSdk\Models\CloudRegion
- $createdAt — Carbon\Carbon
- $customData — mixed
- $description — string
- $encoderVersion — string
- $errorAt — Carbon\Carbon
- $fallbackCloudRegions — \BitmovinApiSdk\Models\CloudRegion[]
- $finishedAt — Carbon\Carbon
- $id — string
- $infrastructure — BitmovinApiSdk\Models\InfrastructureSettings
- $labels — BitmovinApiSdk\Models\string[]
- $liveOptionsType — BitmovinApiSdk\Models\LiveOptionsType
- $modifiedAt — Carbon\Carbon
- $name — string
- $progress — int
- $queuedAt — Carbon\Carbon
- $runningAt — Carbon\Carbon
- $selectedCloudRegion — BitmovinApiSdk\Models\CloudRegion
- $selectedEncoderVersion — string
- $selectedEncodingMode — BitmovinApiSdk\Models\EncodingMode
- $selectedFallbackCloudRegions — \BitmovinApiSdk\Models\CloudRegion[]
- $startedAt — Carbon\Carbon
- $staticIpId — string
- $status — BitmovinApiSdk\Models\Status
- $type — BitmovinApiSdk\Models\EncodingType
Methods
public
- __construct()
- cloudRegion() — cloudRegion
- encoderVersion() — Version of the encoder
- fallbackCloudRegions() — Specify a list of regions which are used in case the preferred region is down. Currently there are several restrictions. - The region has to be specific or AUTO - The region has to be for the same cloud provider as the default one - You can only configure at most 3 fallback regions
- infrastructure() — infrastructure
- labels() — You may pass a list of groups associated with this encoding. This will enable you to group results in the statistics resource
- staticIpId() — Specify an ID of a Static IP infrastructure resource this encoding should use. A Static IP cannot be used by multiple encodings at once. The encoding will go to an error state if the Static IP is already in use. This is currently only supported for live encodings.
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.