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 string $infrastructureId;
- public InfrastructureSettings $infrastructure;
- public string $selectedEncoderVersion;
- public EncodingMode $selectedEncodingMode;
- public CloudRegion $selectedCloudRegion;
- public Status $status;
- public array $labels;
- // 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 errorAt()
- public $this cloudRegion()
- public $this fallbackCloudRegions()
- public $this encoderVersion()
- public $this infrastructureId()
- public $this infrastructure()
- 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
- $infrastructureId — string
- $labels — BitmovinApiSdk\Models\string[]
- $modifiedAt — Carbon\Carbon
- $name — string
- $progress — int
- $queuedAt — Carbon\Carbon
- $runningAt — Carbon\Carbon
- $selectedCloudRegion — BitmovinApiSdk\Models\CloudRegion
- $selectedEncoderVersion — string
- $selectedEncodingMode — BitmovinApiSdk\Models\EncodingMode
- $startedAt — Carbon\Carbon
- $status — BitmovinApiSdk\Models\Status
- $type — BitmovinApiSdk\Models\EncodingType
Methods
public
- __construct()
- cloudRegion() — cloudRegion
- encoderVersion() — Version of the encoder
- errorAt() — Timestamp when the encoding status changed to 'ERROR', returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ Note that this timestamp is deprecated and is equivalent to finishedAt in case of an 'ERROR'.
- 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
- infrastructureId() — Define an external infrastructure to run the encoding on. Note If you set this value, the `cloudRegion` must be 'EXTERNAL'.
- labels() — You may pass a list of groups associated with this encoding. This will enable you to group results in the statistics resource
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.