Class EncodingsApi

Inheritance
System.Object
EncodingsApi
Inherited Members
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.Encoding.Encodings
Assembly: Bitmovin.Api.Sdk.dll
Syntax
public class EncodingsApi

Constructors

EncodingsApi(IBitmovinApiClientFactory)

Declaration
public EncodingsApi(IBitmovinApiClientFactory apiClientFactory)
Parameters
Type Name Description
IBitmovinApiClientFactory apiClientFactory

Properties

Builder

Fluent builder for creating an instance of EncodingsApi

Declaration
public static BitmovinApiBuilder<EncodingsApi> Builder { get; }
Property Value
Type Description
BitmovinApiBuilder<EncodingsApi>

Captions

Declaration
public CaptionsApi Captions { get; }
Property Value
Type Description
CaptionsApi

Customdata

Declaration
public CustomdataApi Customdata { get; }
Property Value
Type Description
CustomdataApi

InputStreams

Declaration
public InputStreamsApi InputStreams { get; }
Property Value
Type Description
InputStreamsApi

Keyframes

Declaration
public KeyframesApi Keyframes { get; }
Property Value
Type Description
KeyframesApi

Live

Declaration
public LiveApi Live { get; }
Property Value
Type Description
LiveApi

MachineLearning

Declaration
public MachineLearningApi MachineLearning { get; }
Property Value
Type Description
MachineLearningApi

Muxings

Declaration
public MuxingsApi Muxings { get; }
Property Value
Type Description
MuxingsApi

Sidecars

Declaration
public SidecarsApi Sidecars { get; }
Property Value
Type Description
SidecarsApi

Streams

Declaration
public StreamsApi Streams { get; }
Property Value
Type Description
StreamsApi

TransferRetries

Declaration
public TransferRetriesApi TransferRetries { get; }
Property Value
Type Description
TransferRetriesApi

Methods

CreateAsync(Encoding)

Create Encoding

Declaration
public Task<Encoding> CreateAsync(Encoding encoding)
Parameters
Type Name Description
Encoding encoding

The Encoding to be created
Returns
Type Description
System.Threading.Tasks.Task<Encoding>

DeleteAsync(String)

Delete Encoding

Declaration
public Task<BitmovinResponse> DeleteAsync(string encodingId)
Parameters
Type Name Description
System.String encodingId

Id of the encoding. (required)
Returns
Type Description
System.Threading.Tasks.Task<BitmovinResponse>

GetAsync(String)

Encoding Details

Declaration
public Task<Encoding> GetAsync(string encodingId)
Parameters
Type Name Description
System.String encodingId

Id of the encoding. (required)
Returns
Type Description
System.Threading.Tasks.Task<Encoding>

GetStartRequestAsync(String)

Encoding Start Details

Declaration
public Task<StartEncodingRequest> GetStartRequestAsync(string encodingId)
Parameters
Type Name Description
System.String encodingId

Id of the encoding (required)
Returns
Type Description
System.Threading.Tasks.Task<StartEncodingRequest>

ListAsync(Func<EncodingsApi.ListQueryParams, EncodingsApi.ListQueryParams>[])

List all Encodings

Declaration
public Task<PaginationResponse<Encoding>> ListAsync(params Func<EncodingsApi.ListQueryParams, EncodingsApi.ListQueryParams>[] queryParams)
Parameters
Type Name Description
System.Func<EncodingsApi.ListQueryParams, EncodingsApi.ListQueryParams>[] queryParams

The query parameters for sorting, filtering and paging options (optional)
Returns
Type Description
System.Threading.Tasks.Task<PaginationResponse<Encoding>>

ReprioritizeAsync(String, ReprioritizeEncodingRequest)

Reprioritize Encoding

Declaration
public Task<BitmovinResponse> ReprioritizeAsync(string encodingId, ReprioritizeEncodingRequest reprioritizeEncodingRequest)
Parameters
Type Name Description
System.String encodingId

Id of the encoding. (required)
ReprioritizeEncodingRequest reprioritizeEncodingRequest

Reprioritization options
Returns
Type Description
System.Threading.Tasks.Task<BitmovinResponse>

RescheduleAsync(String, RescheduleEncodingRequest)

Reschedule Encoding

Declaration
public Task<BitmovinResponse> RescheduleAsync(string encodingId, RescheduleEncodingRequest rescheduleEncodingRequest)
Parameters
Type Name Description
System.String encodingId

Id of the encoding. (required)
RescheduleEncodingRequest rescheduleEncodingRequest

Rescheduling options
Returns
Type Description
System.Threading.Tasks.Task<BitmovinResponse>

StartAsync(String, StartEncodingRequest)

Start Encoding

Declaration
public Task<BitmovinResponse> StartAsync(string encodingId, StartEncodingRequest startEncodingRequest = null)
Parameters
Type Name Description
System.String encodingId

Id of the encoding (required)
StartEncodingRequest startEncodingRequest

Encoding Startup Options
Returns
Type Description
System.Threading.Tasks.Task<BitmovinResponse>

StatusAsync(String)

Encoding Status

Declaration
public Task<ServiceTaskStatus> StatusAsync(string encodingId)
Parameters
Type Name Description
System.String encodingId

Id of the encoding (required)
Returns
Type Description
System.Threading.Tasks.Task<ServiceTaskStatus>

StopAsync(String)

Stop Encoding

Declaration
public Task<BitmovinResponse> StopAsync(string encodingId)
Parameters
Type Name Description
System.String encodingId

Id of the encoding (required)
Returns
Type Description
System.Threading.Tasks.Task<BitmovinResponse>