Show / Hide Table of Contents

Class Mp3Api

Inheritance
System.Object
Mp3Api
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.Mp3
Assembly: Bitmovin.Api.Sdk.dll
Syntax
public class Mp3Api

Constructors

Mp3Api(IBitmovinApiClientFactory)

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

Properties

Builder

Fluent builder for creating an instance of Mp3Api

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

Customdata

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

Methods

CreateAsync(Mp3AudioConfiguration)

Create MP3 Codec Configuration

Declaration
public Task<Mp3AudioConfiguration> CreateAsync(Mp3AudioConfiguration mp3AudioConfiguration)
Parameters
Type Name Description
Mp3AudioConfiguration mp3AudioConfiguration

The MP3 Codec Configuration to be created

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

DeleteAsync(String)

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

MP3 Codec Configuration Details

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

Id of the codec configuration (required)

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

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

List MP3 Configurations

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

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

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