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

Class DolbyAtmosApi

java.lang.Object

com.bitmovin.api.sdk.encoding.configurations.audio.dolbyAtmos.DolbyAtmosApi

public class DolbyAtmosApi
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
CustomdataApi	customdata

Constructor Summary

Constructors

Constructor and Description
DolbyAtmosApi(BitmovinApiClientFactory clientFactory)

Method Summary

Modifier and Type	Method and Description
static BitmovinApiBuilder<DolbyAtmosApi>	builder() Fluent builder for creating an instance of DolbyAtmosApi
DolbyAtmosAudioConfiguration	create(DolbyAtmosAudioConfiguration dolbyAtmosAudioConfiguration) Create Dolby Atmos Configuration
BitmovinResponse	delete(String configurationId) Delete Dolby Atmos Codec Configuration
DolbyAtmosAudioConfiguration	get(String configurationId) Dolby Atmos Codec Configuration Details
PaginationResponse<DolbyAtmosAudioConfiguration>	list() List Dolby Atmos Configurations
PaginationResponse<DolbyAtmosAudioConfiguration>	list(DolbyAtmosAudioConfigurationListQueryParams queryParams) List Dolby Atmos 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

DolbyAtmosApi

public DolbyAtmosApi(BitmovinApiClientFactory clientFactory)

Method Detail

builder

public static BitmovinApiBuilder<DolbyAtmosApi> builder()

Fluent builder for creating an instance of DolbyAtmosApi

create

public DolbyAtmosAudioConfiguration create(DolbyAtmosAudioConfiguration dolbyAtmosAudioConfiguration)
                                    throws BitmovinException

Create Dolby Atmos Configuration

Parameters:

dolbyAtmosAudioConfiguration - The Dolby Atmos Codec Configuration to be created (required)

Returns:

DolbyAtmosAudioConfiguration

Throws:

BitmovinException - if fails to make API call

delete

public BitmovinResponse delete(String configurationId)
                        throws BitmovinException

Delete Dolby Atmos Codec Configuration

Parameters:

configurationId - Id of the codec configuration (required)

Returns:

BitmovinResponse

Throws:

BitmovinException - if fails to make API call

get

public DolbyAtmosAudioConfiguration get(String configurationId)
                                 throws BitmovinException

Dolby Atmos Codec Configuration Details

Parameters:

configurationId - Id of the codec configuration (required)

Returns:

DolbyAtmosAudioConfiguration

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<DolbyAtmosAudioConfiguration> list()
                                                      throws BitmovinException

List Dolby Atmos Configurations

Returns:

List<DolbyAtmosAudioConfiguration>

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<DolbyAtmosAudioConfiguration> list(DolbyAtmosAudioConfigurationListQueryParams queryParams)
                                                      throws BitmovinException

List Dolby Atmos Configurations

Parameters:

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

Returns:

List<DolbyAtmosAudioConfiguration>

Throws:

BitmovinException - if fails to make API call