com.bitmovin.api.sdk.encoding.encodings.inputStreams.dolbyAtmos

Class DolbyAtmosApi

java.lang.Object

com.bitmovin.api.sdk.encoding.encodings.inputStreams.dolbyAtmos.DolbyAtmosApi

public class DolbyAtmosApi
extends Object

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
DolbyAtmosIngestInputStream	create(String encodingId, DolbyAtmosIngestInputStream dolbyAtmosIngestInputStream) Add Dolby Atmos input stream
BitmovinResponse	delete(String encodingId, String inputStreamId) Delete Dolby Atmos input stream
DolbyAtmosIngestInputStream	get(String encodingId, String inputStreamId) Dolby Atmos input stream details
PaginationResponse<DolbyAtmosIngestInputStream>	list(String encodingId) List Dolby Atmos input streams
PaginationResponse<DolbyAtmosIngestInputStream>	list(String encodingId, DolbyAtmosIngestInputStreamListQueryParams queryParams) List Dolby Atmos input streams

Methods inherited from class java.lang.Object

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

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 DolbyAtmosIngestInputStream create(String encodingId,
                                          DolbyAtmosIngestInputStream dolbyAtmosIngestInputStream)
                                   throws BitmovinException

Add Dolby Atmos input stream

Parameters:

encodingId - Id of the encoding (required)

dolbyAtmosIngestInputStream - The Dolby Atmos input stream to be created (required)

Returns:

DolbyAtmosIngestInputStream

Throws:

BitmovinException - if fails to make API call

delete

public BitmovinResponse delete(String encodingId,
                               String inputStreamId)
                        throws BitmovinException

Delete Dolby Atmos input stream

Parameters:

encodingId - Id of the encoding (required)

inputStreamId - Id of the Dolby Atmos input stream (required)

Returns:

BitmovinResponse

Throws:

BitmovinException - if fails to make API call

get

public DolbyAtmosIngestInputStream get(String encodingId,
                                       String inputStreamId)
                                throws BitmovinException

Dolby Atmos input stream details

Parameters:

encodingId - Id of the encoding (required)

inputStreamId - Id of the Dolby Atmos input stream (required)

Returns:

DolbyAtmosIngestInputStream

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<DolbyAtmosIngestInputStream> list(String encodingId)
                                                     throws BitmovinException

List Dolby Atmos input streams

Parameters:

encodingId - Id of the encoding (required)

Returns:

List<DolbyAtmosIngestInputStream>

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<DolbyAtmosIngestInputStream> list(String encodingId,
                                                            DolbyAtmosIngestInputStreamListQueryParams queryParams)
                                                     throws BitmovinException

List Dolby Atmos input streams

Parameters:

encodingId - Id of the encoding (required)

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

Returns:

List<DolbyAtmosIngestInputStream>

Throws:

BitmovinException - if fails to make API call