com.bitmovin.api.sdk.encoding.manifests.hls.media.audio

Class AudioApi

java.lang.Object

com.bitmovin.api.sdk.encoding.manifests.hls.media.audio.AudioApi

public class AudioApi
extends Object

Constructor Summary

Constructors

Constructor and Description
AudioApi(BitmovinApiClientFactory clientFactory)

Method Summary

Modifier and Type	Method and Description
static BitmovinApiBuilder<AudioApi>	builder() Fluent builder for creating an instance of AudioApi
AudioMediaInfo	create(String manifestId, AudioMediaInfo audioMediaInfo) Add Audio Media
BitmovinResponse	delete(String manifestId, String mediaId) Delete Audio Media
AudioMediaInfo	get(String manifestId, String mediaId) Audio Media Details
PaginationResponse<AudioMediaInfo>	list(String manifestId) List all Audio Media
PaginationResponse<AudioMediaInfo>	list(String manifestId, AudioMediaInfoListQueryParams queryParams) List all Audio Media

Methods inherited from class java.lang.Object

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

Constructor Detail

AudioApi

public AudioApi(BitmovinApiClientFactory clientFactory)

Method Detail

builder

public static BitmovinApiBuilder<AudioApi> builder()

Fluent builder for creating an instance of AudioApi

create

public AudioMediaInfo create(String manifestId,
                             AudioMediaInfo audioMediaInfo)
                      throws BitmovinException

Add Audio Media

Parameters:

manifestId - Id of the hls manifest. (required)

audioMediaInfo - The Audio Media to be added (required)

Returns:

AudioMediaInfo

Throws:

BitmovinException - if fails to make API call

delete

public BitmovinResponse delete(String manifestId,
                               String mediaId)
                        throws BitmovinException

Delete Audio Media

Parameters:

manifestId - Id of the hls manifest. (required)

mediaId - Id of the audio media. (required)

Returns:

BitmovinResponse

Throws:

BitmovinException - if fails to make API call

get

public AudioMediaInfo get(String manifestId,
                          String mediaId)
                   throws BitmovinException

Audio Media Details

Parameters:

manifestId - Id of the hls manifest. (required)

mediaId - Id of the audio media. (required)

Returns:

AudioMediaInfo

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<AudioMediaInfo> list(String manifestId)
                                        throws BitmovinException

List all Audio Media

Parameters:

manifestId - Id of the hls manifest. (required)

Returns:

List<AudioMediaInfo>

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<AudioMediaInfo> list(String manifestId,
                                               AudioMediaInfoListQueryParams queryParams)
                                        throws BitmovinException

List all Audio Media

Parameters:

manifestId - Id of the hls manifest. (required)

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

Returns:

List<AudioMediaInfo>

Throws:

BitmovinException - if fails to make API call