com.bitmovin.api.sdk.encoding.configurations.audio.mp3

Class Mp3Api

java.lang.Object

com.bitmovin.api.sdk.encoding.configurations.audio.mp3.Mp3Api

public class Mp3Api
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
CustomdataApi	customdata

Constructor Summary

Constructors

Constructor and Description
Mp3Api(BitmovinApiClientFactory clientFactory)

Method Summary

Modifier and Type	Method and Description
static BitmovinApiBuilder<Mp3Api>	builder() Fluent builder for creating an instance of Mp3Api
Mp3AudioConfiguration	create(Mp3AudioConfiguration mp3AudioConfiguration) Create MP3 Codec Configuration
BitmovinResponse	delete(String configurationId) Delete MP3 Codec Configuration
Mp3AudioConfiguration	get(String configurationId) MP3 Codec Configuration Details
PaginationResponse<Mp3AudioConfiguration>	list() List MP3 Configurations
PaginationResponse<Mp3AudioConfiguration>	list(Mp3AudioConfigurationListQueryParams queryParams) List MP3 Configurations

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

customdata

public final CustomdataApi customdata

Constructor Detail

Mp3Api

public Mp3Api(BitmovinApiClientFactory clientFactory)

Method Detail

builder

public static BitmovinApiBuilder<Mp3Api> builder()

Fluent builder for creating an instance of Mp3Api

create

public Mp3AudioConfiguration create(Mp3AudioConfiguration mp3AudioConfiguration)
                             throws BitmovinException

Create MP3 Codec Configuration

Parameters:

mp3AudioConfiguration - The MP3 Codec Configuration to be created (required)

Returns:

Mp3AudioConfiguration

Throws:

BitmovinException - if fails to make API call

delete

public BitmovinResponse delete(String configurationId)
                        throws BitmovinException

Delete MP3 Codec Configuration

Parameters:

configurationId - Id of the codec configuration (required)

Returns:

BitmovinResponse

Throws:

BitmovinException - if fails to make API call

get

public Mp3AudioConfiguration get(String configurationId)
                          throws BitmovinException

MP3 Codec Configuration Details

Parameters:

configurationId - Id of the codec configuration (required)

Returns:

Mp3AudioConfiguration

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<Mp3AudioConfiguration> list()
                                               throws BitmovinException

List MP3 Configurations

Returns:

List<Mp3AudioConfiguration>

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<Mp3AudioConfiguration> list(Mp3AudioConfigurationListQueryParams queryParams)
                                               throws BitmovinException

List MP3 Configurations

Parameters:

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

Returns:

List<Mp3AudioConfiguration>

Throws:

BitmovinException - if fails to make API call