com.bitmovin.api.sdk.encoding.encodings.streams.hdr.dolbyVision

Class DolbyVisionApi

java.lang.Object

com.bitmovin.api.sdk.encoding.encodings.streams.hdr.dolbyVision.DolbyVisionApi

public class DolbyVisionApi
extends Object

Constructor Summary

Constructors

Constructor and Description
DolbyVisionApi(BitmovinApiClientFactory clientFactory)

Method Summary

Modifier and Type	Method and Description
static BitmovinApiBuilder<DolbyVisionApi>	builder() Fluent builder for creating an instance of DolbyVisionApi
DolbyVisionMetadata	create(String encodingId, String streamId, DolbyVisionMetadata dolbyVisionMetadata) Add Dolby Vision Metadata
BitmovinResponse	delete(String encodingId, String streamId, String hdrId) Delete Dolby Vision Metadata
DolbyVisionMetadata	get(String encodingId, String streamId, String hdrId) Dolby Vision Metadata Details
PaginationResponse<DolbyVisionMetadata>	list(String encodingId, String streamId) List Dolby Vision Metadata
PaginationResponse<DolbyVisionMetadata>	list(String encodingId, String streamId, DolbyVisionMetadataListQueryParams queryParams) List Dolby Vision Metadata

Methods inherited from class java.lang.Object

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

Constructor Detail

DolbyVisionApi

public DolbyVisionApi(BitmovinApiClientFactory clientFactory)

Method Detail

builder

public static BitmovinApiBuilder<DolbyVisionApi> builder()

Fluent builder for creating an instance of DolbyVisionApi

create

public DolbyVisionMetadata create(String encodingId,
                                  String streamId,
                                  DolbyVisionMetadata dolbyVisionMetadata)
                           throws BitmovinException

Add Dolby Vision Metadata

Parameters:

encodingId - Id of the encoding. (required)

streamId - Id of the stream. (required)

dolbyVisionMetadata - The Dolby Vision Metadata to be added (required)

Returns:

DolbyVisionMetadata

Throws:

BitmovinException - if fails to make API call

delete

public BitmovinResponse delete(String encodingId,
                               String streamId,
                               String hdrId)
                        throws BitmovinException

Delete Dolby Vision Metadata

Parameters:

encodingId - Id of the encoding. (required)

streamId - Id of the stream. (required)

hdrId - Id of the Dolby Vision Metadata. (required)

Returns:

BitmovinResponse

Throws:

BitmovinException - if fails to make API call

get

public DolbyVisionMetadata get(String encodingId,
                               String streamId,
                               String hdrId)
                        throws BitmovinException

Dolby Vision Metadata Details

Parameters:

encodingId - Id of the encoding. (required)

streamId - Id of the stream. (required)

hdrId - Id of the Dolby Vision Metadata. (required)

Returns:

DolbyVisionMetadata

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<DolbyVisionMetadata> list(String encodingId,
                                                    String streamId)
                                             throws BitmovinException

List Dolby Vision Metadata

Parameters:

encodingId - Id of the encoding. (required)

streamId - Id of the stream. (required)

Returns:

List<DolbyVisionMetadata>

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<DolbyVisionMetadata> list(String encodingId,
                                                    String streamId,
                                                    DolbyVisionMetadataListQueryParams queryParams)
                                             throws BitmovinException

List Dolby Vision Metadata

Parameters:

encodingId - Id of the encoding. (required)

streamId - Id of the stream. (required)

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

Returns:

List<DolbyVisionMetadata>

Throws:

BitmovinException - if fails to make API call