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.Hls.Media.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, AudioMediaInfo)

Add Audio Media

Declaration
public Task<AudioMediaInfo> CreateAsync(string manifestId, AudioMediaInfo audioMediaInfo)
Parameters
Type Name Description
System.String manifestId

Id of the hls manifest. (required)

AudioMediaInfo audioMediaInfo

The Audio Media to be added

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

DeleteAsync(String, String)

Delete Audio Media

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

Id of the hls manifest. (required)

System.String mediaId

Id of the audio media. (required)

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

GetAsync(String, String)

Audio Media Details

Declaration
public Task<AudioMediaInfo> GetAsync(string manifestId, string mediaId)
Parameters
Type Name Description
System.String manifestId

Id of the hls manifest. (required)

System.String mediaId

Id of the audio media. (required)

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

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

List all Audio Media

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

Id of the hls manifest. (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<AudioMediaInfo>>
Back to top Generated by DocFX