com.bitmovin.api.sdk.encoding.manifests.hls.streams.iframe

Class IframeApi

java.lang.Object

com.bitmovin.api.sdk.encoding.manifests.hls.streams.iframe.IframeApi

public class IframeApi
extends Object

Constructor Summary

Constructors

Constructor and Description
IframeApi(BitmovinApiClientFactory clientFactory)

Method Summary

Modifier and Type	Method and Description
static BitmovinApiBuilder<IframeApi>	builder() Fluent builder for creating an instance of IframeApi
IFramePlaylist	create(String manifestId, String streamId, IFramePlaylist iframePlaylist) Add I-frame playlist to variant stream
BitmovinResponse	delete(String manifestId, String streamId, String iframeId) Delete I-frame playlist
IFramePlaylist	get(String manifestId, String streamId, String iframeId) I-frame playlist Details
PaginationResponse<IFramePlaylist>	list(String manifestId, String streamId) List all I-frame playlists of a variant stream
PaginationResponse<IFramePlaylist>	list(String manifestId, String streamId, IFramePlaylistListQueryParams queryParams) List all I-frame playlists of a variant stream

Methods inherited from class java.lang.Object

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

Constructor Detail

IframeApi

public IframeApi(BitmovinApiClientFactory clientFactory)

Method Detail

builder

public static BitmovinApiBuilder<IframeApi> builder()

Fluent builder for creating an instance of IframeApi

create

public IFramePlaylist create(String manifestId,
                             String streamId,
                             IFramePlaylist iframePlaylist)
                      throws BitmovinException

Add I-frame playlist to variant stream

Parameters:

manifestId - Id of the hls manifest. (required)

streamId - Id of the variant stream. (required)

iframePlaylist - The I-frame playlist to be added (required)

Returns:

IFramePlaylist

Throws:

BitmovinException - if fails to make API call

delete

public BitmovinResponse delete(String manifestId,
                               String streamId,
                               String iframeId)
                        throws BitmovinException

Delete I-frame playlist

Parameters:

manifestId - Id of the hls manifest. (required)

streamId - Id of the variant stream. (required)

iframeId - Id of the Iframe-Playlist. (required)

Returns:

BitmovinResponse

Throws:

BitmovinException - if fails to make API call

get

public IFramePlaylist get(String manifestId,
                          String streamId,
                          String iframeId)
                   throws BitmovinException

I-frame playlist Details

Parameters:

manifestId - Id of the hls manifest. (required)

streamId - Id of the variant stream. (required)

iframeId - Id of the Iframe-Playlist. (required)

Returns:

IFramePlaylist

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<IFramePlaylist> list(String manifestId,
                                               String streamId)
                                        throws BitmovinException

List all I-frame playlists of a variant stream

Parameters:

manifestId - Id of the hls manifest. (required)

streamId - Id of the variant stream. (required)

Returns:

List<IFramePlaylist>

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<IFramePlaylist> list(String manifestId,
                                               String streamId,
                                               IFramePlaylistListQueryParams queryParams)
                                        throws BitmovinException

List all I-frame playlists of a variant stream

Parameters:

manifestId - Id of the hls manifest. (required)

streamId - Id of the variant stream. (required)

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

Returns:

List<IFramePlaylist>

Throws:

BitmovinException - if fails to make API call