bitmovin_api_sdk.encoding.manifests.hls.streams.iframe package

Submodules

bitmovin_api_sdk.encoding.manifests.hls.streams.iframe.i_frame_playlist_list_query_params module

class bitmovin_api_sdk.encoding.manifests.hls.streams.iframe.i_frame_playlist_list_query_params.IFramePlaylistListQueryParams(offset: Optional[int] = None, limit: Optional[int] = None)[source]

Bases: object

property attribute_map
property openapi_types

bitmovin_api_sdk.encoding.manifests.hls.streams.iframe.iframe_api module

class bitmovin_api_sdk.encoding.manifests.hls.streams.iframe.iframe_api.IframeApi(**kwargs)[source]

Bases: BaseApi

create(manifest_id: string_types, stream_id: string_types, i_frame_playlist: IFramePlaylist, **kwargs: dict) → IFramePlaylist[source]

Add I-frame playlist to variant stream

Parameters

  • manifest_id (string_types, required) – Id of the hls manifest.

  • stream_id (string_types, required) – Id of the variant stream.

  • i_frame_playlist (IFramePlaylist, required) – The I-frame playlist to be added

Returns

Iframe-Playlist details

Return type

IFramePlaylist

delete(manifest_id: string_types, stream_id: string_types, iframe_id: string_types, **kwargs: dict) → BitmovinResponse[source]

Delete I-frame playlist

Parameters

  • manifest_id (string_types, required) – Id of the hls manifest.

  • stream_id (string_types, required) – Id of the variant stream.

  • iframe_id (string_types, required) – Id of the Iframe-Playlist.

Returns

Id of the custom tag

Return type

BitmovinResponse

get(manifest_id: string_types, stream_id: string_types, iframe_id: string_types, **kwargs: dict) → IFramePlaylist[source]

I-frame playlist Details

Parameters

  • manifest_id (string_types, required) – Id of the hls manifest.

  • stream_id (string_types, required) – Id of the variant stream.

  • iframe_id (string_types, required) – Id of the Iframe-Playlist.

Returns

Custom tag details

Return type

IFramePlaylist

list(manifest_id: string_types, stream_id: string_types, query_params: IFramePlaylistListQueryParams = None, **kwargs: dict) → IFramePlaylist[source]

List all I-frame playlists of a variant stream

Parameters

  • manifest_id (string_types, required) – Id of the hls manifest.

  • stream_id (string_types, required) – Id of the variant stream.

  • query_params (IFramePlaylistListQueryParams) – Query parameters

Returns

Video media

Return type

IFramePlaylist

Module contents