Class VorbisApi

Inheritance

System.Object

VorbisApi

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

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class VorbisApi

Constructors

VorbisApi(IBitmovinApiClientFactory)

Declaration

public VorbisApi(IBitmovinApiClientFactory apiClientFactory)

Parameters

Type	Name	Description
IBitmovinApiClientFactory	apiClientFactory

Properties

Builder

Fluent builder for creating an instance of VorbisApi

Declaration

public static BitmovinApiBuilder<VorbisApi> Builder { get; }

Property Value

Type	Description
BitmovinApiBuilder<VorbisApi>

Customdata

Declaration

public CustomdataApi Customdata { get; }

Property Value

Type	Description
CustomdataApi

Methods

CreateAsync(VorbisAudioConfiguration)

Create Vorbis Codec Configuration

Declaration

public Task<VorbisAudioConfiguration> CreateAsync(VorbisAudioConfiguration vorbisAudioConfiguration)

Parameters

Type	Name	Description
VorbisAudioConfiguration	vorbisAudioConfiguration	The Vorbis Codec Configuration to be created

Returns

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

DeleteAsync(String)

Delete Vorbis 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)

Vorbis Codec Configuration Details

Declaration

public Task<VorbisAudioConfiguration> GetAsync(string configurationId)

Parameters

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

Returns

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

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

List Vorbis Configurations

Declaration

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

Parameters

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

Returns

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