Show / Hide Table of Contents

Class AudioApi

Inheritance
System.Object
AudioApi
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.Manifests.Dash.Periods.Adaptationsets.Audio
Assembly: Bitmovin.Api.Sdk.dll
Syntax
public class AudioApi

Constructors

AudioApi(IBitmovinApiClientFactory)

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

Properties

Builder

Fluent builder for creating an instance of AudioApi

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

Methods

CreateAsync(String, String, AudioAdaptationSet)

Add Audio AdaptationSet

Declaration
public Task<AudioAdaptationSet> CreateAsync(string manifestId, string periodId, AudioAdaptationSet audioAdaptationSet)
Parameters
Type Name Description
System.String manifestId

Id of the manifest (required)

System.String periodId

Id of the period (required)

AudioAdaptationSet audioAdaptationSet

The audio adaptation set to be added to the period

Returns
Type Description
System.Threading.Tasks.Task<AudioAdaptationSet>

DeleteAsync(String, String, String)

Delete Audio AdaptationSet

Declaration
public Task<BitmovinResponse> DeleteAsync(string manifestId, string periodId, string adaptationsetId)
Parameters
Type Name Description
System.String manifestId

Id of the manifest (required)

System.String periodId

Id of the period (required)

System.String adaptationsetId

Id of the audio adaptation set to be deleted (required)

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

GetAsync(String, String, String)

Audio AdaptationSet Details

Declaration
public Task<AudioAdaptationSet> GetAsync(string manifestId, string periodId, string adaptationsetId)
Parameters
Type Name Description
System.String manifestId

Id of the manifest (required)

System.String periodId

Id of the period (required)

System.String adaptationsetId

Id of the audio adaptation set (required)

Returns
Type Description
System.Threading.Tasks.Task<AudioAdaptationSet>

ListAsync(String, String, Func<AudioApi.ListQueryParams, AudioApi.ListQueryParams>[])

List all Audio AdaptationSets

Declaration
public Task<PaginationResponse<AudioAdaptationSet>> ListAsync(string manifestId, string periodId, params Func<AudioApi.ListQueryParams, AudioApi.ListQueryParams>[] queryParams)
Parameters
Type Name Description
System.String manifestId

Id of the manifest (required)

System.String periodId

Id of the period (required)

System.Func<AudioApi.ListQueryParams, AudioApi.ListQueryParams>[] queryParams

The query parameters for sorting, filtering and paging options (optional)

Returns
Type Description
System.Threading.Tasks.Task<PaginationResponse<AudioAdaptationSet>>
Back to top Generated by DocFX