Class IframeApi

Hierarchy

BaseAPI
- IframeApi

Index

Constructors

constructor

Properties

restClient

Methods

Constructors

constructor

new IframeApi(configuration: Configuration): IframeApi

Overrides BaseAPI.constructor
- Defined in encoding/manifests/hls/streams/iframe/IframeApi.ts:15
Parameters
- configuration: Configuration
Returns IframeApi

Properties

Protected restClient

restClient: RestClient

Methods

create

create(manifestId: string, streamId: string, iFramePlaylist: IFramePlaylist): Promise<IFramePlaylist>

- Defined in encoding/manifests/hls/streams/iframe/IframeApi.ts:29
Parameters
- manifestId: string
- streamId: string
- Optional iFramePlaylist: IFramePlaylist
Returns Promise<IFramePlaylist>

delete

delete(manifestId: string, streamId: string, iframeId: string): Promise<BitmovinResponse>

- Defined in encoding/manifests/hls/streams/iframe/IframeApi.ts:47
Parameters
- manifestId: string
- streamId: string
- iframeId: string
Returns Promise<BitmovinResponse>

get

get(manifestId: string, streamId: string, iframeId: string): Promise<IFramePlaylist>

- Defined in encoding/manifests/hls/streams/iframe/IframeApi.ts:66
Parameters
- manifestId: string
- streamId: string
- iframeId: string
Returns Promise<IFramePlaylist>

list

list(manifestId: string, streamId: string, queryParameters: IFramePlaylistListQueryParams | function): Promise<PaginationResponse<IFramePlaylist>>

- Defined in encoding/manifests/hls/streams/iframe/IframeApi.ts:85
Parameters
- manifestId: string
- streamId: string
- Optional queryParameters: IFramePlaylistListQueryParams | function
Returns Promise<PaginationResponse<IFramePlaylist>>

Generated using TypeDoc