@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
52 lines (51 loc) • 2.42 kB
TypeScript
import { BaseAPI } from '../../../../../common/BaseAPI';
import Configuration from '../../../../../common/Configuration';
import BitmovinResponse from '../../../../../models/BitmovinResponse';
import IFramePlaylist from '../../../../../models/IFramePlaylist';
import PaginationResponse from '../../../../../models/PaginationResponse';
import { IFramePlaylistListQueryParams, IFramePlaylistListQueryParamsBuilder } from './IFramePlaylistListQueryParams';
/**
* IframeApi - object-oriented interface
* @export
* @class IframeApi
* @extends {BaseAPI}
*/
export default class IframeApi extends BaseAPI {
constructor(configuration: Configuration);
/**
* @summary Add I-frame playlist to variant stream
* @param {string} manifestId Id of the hls manifest.
* @param {string} streamId Id of the variant stream.
* @param {IFramePlaylist} iFramePlaylist The I-frame playlist to be added
* @throws {BitmovinError}
* @memberof IframeApi
*/
create(manifestId: string, streamId: string, iFramePlaylist?: IFramePlaylist): Promise<IFramePlaylist>;
/**
* @summary Delete I-frame playlist
* @param {string} manifestId Id of the hls manifest.
* @param {string} streamId Id of the variant stream.
* @param {string} iframeId Id of the Iframe-Playlist.
* @throws {BitmovinError}
* @memberof IframeApi
*/
delete(manifestId: string, streamId: string, iframeId: string): Promise<BitmovinResponse>;
/**
* @summary I-frame playlist Details
* @param {string} manifestId Id of the hls manifest.
* @param {string} streamId Id of the variant stream.
* @param {string} iframeId Id of the Iframe-Playlist.
* @throws {BitmovinError}
* @memberof IframeApi
*/
get(manifestId: string, streamId: string, iframeId: string): Promise<IFramePlaylist>;
/**
* @summary List all I-frame playlists of a variant stream
* @param {string} manifestId Id of the hls manifest.
* @param {string} streamId Id of the variant stream.
* @param {*} [queryParameters] query parameters for filtering, sorting and pagination
* @throws {BitmovinError}
* @memberof IframeApi
*/
list(manifestId: string, streamId: string, queryParameters?: IFramePlaylistListQueryParams | ((q: IFramePlaylistListQueryParamsBuilder) => IFramePlaylistListQueryParamsBuilder)): Promise<PaginationResponse<IFramePlaylist>>;
}