@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
52 lines (51 loc) • 2.15 kB
TypeScript
import { BaseAPI } from '../../../../common/BaseAPI';
import Configuration from '../../../../common/Configuration';
import CustomTagsApi from './customTags/CustomTagsApi';
import IframeApi from './iframe/IframeApi';
import BitmovinResponse from '../../../../models/BitmovinResponse';
import StreamInfo from '../../../../models/StreamInfo';
import PaginationResponse from '../../../../models/PaginationResponse';
import { StreamInfoListQueryParams, StreamInfoListQueryParamsBuilder } from './StreamInfoListQueryParams';
/**
* StreamsApi - object-oriented interface
* @export
* @class StreamsApi
* @extends {BaseAPI}
*/
export default class StreamsApi extends BaseAPI {
customTags: CustomTagsApi;
iframe: IframeApi;
constructor(configuration: Configuration);
/**
* @summary Add Variant Stream
* @param {string} manifestId Id of the hls manifest.
* @param {StreamInfo} streamInfo The Variant Stream to be added
* @throws {BitmovinError}
* @memberof StreamsApi
*/
create(manifestId: string, streamInfo?: StreamInfo): Promise<StreamInfo>;
/**
* @summary Delete Variant Stream
* @param {string} manifestId Id of the hls manifest.
* @param {string} streamId Id of the variant stream.
* @throws {BitmovinError}
* @memberof StreamsApi
*/
delete(manifestId: string, streamId: string): Promise<BitmovinResponse>;
/**
* @summary Variant Stream Details
* @param {string} manifestId Id of the hls manifest.
* @param {string} streamId Id of the variant stream.
* @throws {BitmovinError}
* @memberof StreamsApi
*/
get(manifestId: string, streamId: string): Promise<StreamInfo>;
/**
* @summary List all Variant Streams
* @param {string} manifestId Id of the hls manifest.
* @param {*} [queryParameters] query parameters for filtering, sorting and pagination
* @throws {BitmovinError}
* @memberof StreamsApi
*/
list(manifestId: string, queryParameters?: StreamInfoListQueryParams | ((q: StreamInfoListQueryParamsBuilder) => StreamInfoListQueryParamsBuilder)): Promise<PaginationResponse<StreamInfo>>;
}