Class Encoding

Encoding

Inheritance

System.Object

BitmovinResponse

BitmovinResource

Encoding

Inherited Members

BitmovinResource.Name

BitmovinResource.Description

BitmovinResource.CreatedAt

BitmovinResource.ModifiedAt

BitmovinResource.CustomData

BitmovinResponse.Id

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Bitmovin.Api.Sdk.Models

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class Encoding : BitmovinResource

Properties

CloudRegion

CloudRegion

Declaration

public CloudRegion? CloudRegion { get; set; }

Property Value

Type	Description
System.Nullable<CloudRegion>

EncoderVersion

Version of the encoder

Declaration

public string EncoderVersion { get; set; }

Property Value

Type	Description
System.String

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'.

Declaration

public DateTime? ErrorAt { get; }

Property Value

Type	Description
System.Nullable<System.DateTime>

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

Declaration

public List<CloudRegion> FallbackCloudRegions { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<CloudRegion>

FinishedAt

Timestamp when the encoding status changed to 'FINISHED', 'ERROR', 'CANCELED', or 'TRANSFER_ERROR', returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ Note that this timestamp might be inaccurate for encodings which ran prior to the 1.50.0 REST API release.

Declaration

public DateTime? FinishedAt { get; }

Property Value

Type	Description
System.Nullable<System.DateTime>

Infrastructure

Infrastructure

Declaration

public InfrastructureSettings Infrastructure { get; set; }

Property Value

Type	Description
InfrastructureSettings

Labels

You may pass a list of groups associated with this encoding. This will enable you to group results in the statistics resource

Declaration

public List<string> Labels { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.String>

Progress

Progress of the encoding in percent

Declaration

public int? Progress { get; }

Property Value

Type	Description
System.Nullable<System.Int32>

QueuedAt

Timestamp when the encoding status changed to "QUEUED", returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Declaration

public DateTime? QueuedAt { get; }

Property Value

Type	Description
System.Nullable<System.DateTime>

RunningAt

Timestamp when the encoding status changed to "RUNNING", returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Declaration

public DateTime? RunningAt { get; }

Property Value

Type	Description
System.Nullable<System.DateTime>

SelectedCloudRegion

After the encoding has been started, this will contain the cloud region that was actually used. This will differ from cloudRegion if cloudRegion was set to an unspecific region (e.g. 'AUTO')

Declaration

public CloudRegion? SelectedCloudRegion { get; }

Property Value

Type	Description
System.Nullable<CloudRegion>

SelectedEncoderVersion

After the encoding has been started, this will contain the encoder version that was actually used. Especially useful when starting an encoding with a version tag like STABLE or BETA.

Declaration

public string SelectedEncoderVersion { get; }

Property Value

Type	Description
System.String

SelectedEncodingMode

After the encoding has been started, this will contain the encoding mode that was actually used. Especially useful when starting an encoding with encoding mode STANDARD.

Declaration

public EncodingMode? SelectedEncodingMode { get; }

Property Value

Type	Description
System.Nullable<EncodingMode>

StartedAt

Timestamp when the encoding was started, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Declaration

public DateTime? StartedAt { get; }

Property Value

Type	Description
System.Nullable<System.DateTime>

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.

Declaration

public string StaticIpId { get; set; }

Property Value

Type	Description
System.String

Status

The current status of the encoding.

Declaration

public Status? Status { get; }

Property Value

Type	Description
System.Nullable<Status>

Type

Type of the encoding

Declaration

public EncodingType? Type { get; }

Property Value

Type	Description
System.Nullable<EncodingType>