Class OpusApi

Inheritance

System.Object

OpusApi

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.Configurations.Audio.Opus

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class OpusApi

Constructors

OpusApi(IBitmovinApiClientFactory)

Declaration

public OpusApi(IBitmovinApiClientFactory apiClientFactory)

Parameters

Type	Name	Description
IBitmovinApiClientFactory	apiClientFactory

Properties

Builder

Fluent builder for creating an instance of OpusApi

Declaration

public static BitmovinApiBuilder<OpusApi> Builder { get; }

Property Value

Type	Description
BitmovinApiBuilder<OpusApi>

Customdata

Declaration

public CustomdataApi Customdata { get; }

Property Value

Type	Description
CustomdataApi

Methods

CreateAsync(OpusAudioConfiguration)

Create Opus Codec Configuration

Declaration

public Task<OpusAudioConfiguration> CreateAsync(OpusAudioConfiguration opusAudioConfiguration)

Parameters

Type	Name	Description
OpusAudioConfiguration	opusAudioConfiguration	The Opus Codec Configuration to be created

Returns

Type	Description
System.Threading.Tasks.Task<OpusAudioConfiguration>

DeleteAsync(String)

Delete Opus Codec Configuration

Declaration

public Task<BitmovinResponse> DeleteAsync(string configurationId)

Parameters

Type	Name	Description
System.String	configurationId	Id of the codec configuration (required)

Returns

Type	Description
System.Threading.Tasks.Task<BitmovinResponse>

GetAsync(String)

Opus Codec Configuration Details

Declaration

public Task<OpusAudioConfiguration> GetAsync(string configurationId)

Parameters

Type	Name	Description
System.String	configurationId	Id of the codec configuration (required)

Returns

Type	Description
System.Threading.Tasks.Task<OpusAudioConfiguration>

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

List Opus Configurations

Declaration

public Task<PaginationResponse<OpusAudioConfiguration>> ListAsync(params Func<OpusApi.ListQueryParams, OpusApi.ListQueryParams>[] queryParams)

Parameters

Type	Name	Description
System.Func<OpusApi.ListQueryParams, OpusApi.ListQueryParams>[]	queryParams	The query parameters for sorting, filtering and paging options (optional)

Returns

Type	Description
System.Threading.Tasks.Task<PaginationResponse<OpusAudioConfiguration>>