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

Class VorbisApi

java.lang.Object

com.bitmovin.api.sdk.encoding.configurations.audio.vorbis.VorbisApi

public class VorbisApi
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
CustomdataApi	customdata

Constructor Summary

Constructors

Constructor and Description
VorbisApi(BitmovinApiClientFactory clientFactory)

Method Summary

Modifier and Type	Method and Description
static BitmovinApiBuilder<VorbisApi>	builder() Fluent builder for creating an instance of VorbisApi
VorbisAudioConfiguration	create(VorbisAudioConfiguration vorbisAudioConfiguration) Create Vorbis Codec Configuration
BitmovinResponse	delete(String configurationId) Delete Vorbis Codec Configuration
VorbisAudioConfiguration	get(String configurationId) Vorbis Codec Configuration Details
PaginationResponse<VorbisAudioConfiguration>	list() List Vorbis Configurations
PaginationResponse<VorbisAudioConfiguration>	list(VorbisAudioConfigurationListQueryParams queryParams) List Vorbis 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

VorbisApi

public VorbisApi(BitmovinApiClientFactory clientFactory)

Method Detail

builder

public static BitmovinApiBuilder<VorbisApi> builder()

Fluent builder for creating an instance of VorbisApi

create

public VorbisAudioConfiguration create(VorbisAudioConfiguration vorbisAudioConfiguration)
                                throws BitmovinException

Create Vorbis Codec Configuration

Parameters:

vorbisAudioConfiguration - The Vorbis Codec Configuration to be created (required)

Returns:

VorbisAudioConfiguration

Throws:

BitmovinException - if fails to make API call

delete

public BitmovinResponse delete(String configurationId)
                        throws BitmovinException

Delete Vorbis Codec Configuration

Parameters:

configurationId - Id of the codec configuration (required)

Returns:

BitmovinResponse

Throws:

BitmovinException - if fails to make API call

get

public VorbisAudioConfiguration get(String configurationId)
                             throws BitmovinException

Vorbis Codec Configuration Details

Parameters:

configurationId - Id of the codec configuration (required)

Returns:

VorbisAudioConfiguration

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<VorbisAudioConfiguration> list()
                                                  throws BitmovinException

List Vorbis Configurations

Returns:

List<VorbisAudioConfiguration>

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<VorbisAudioConfiguration> list(VorbisAudioConfigurationListQueryParams queryParams)
                                                  throws BitmovinException

List Vorbis Configurations

Parameters:

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

Returns:

List<VorbisAudioConfiguration>

Throws:

BitmovinException - if fails to make API call