@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
52 lines (51 loc) • 2.5 kB
TypeScript
import { BaseAPI } from '../../../../../common/BaseAPI';
import Configuration from '../../../../../common/Configuration';
import BitmovinResponse from '../../../../../models/BitmovinResponse';
import BurnInSubtitleDvbSub from '../../../../../models/BurnInSubtitleDvbSub';
import PaginationResponse from '../../../../../models/PaginationResponse';
import { BurnInSubtitleDvbSubListQueryParams, BurnInSubtitleDvbSubListQueryParamsBuilder } from './BurnInSubtitleDvbSubListQueryParams';
/**
* DvbsubApi - object-oriented interface
* @export
* @class DvbsubApi
* @extends {BaseAPI}
*/
export default class DvbsubApi extends BaseAPI {
constructor(configuration: Configuration);
/**
* @summary Burn-In DVB-SUB Subtitle into Stream
* @param {string} encodingId Id of the encoding.
* @param {string} streamId Id of the stream.
* @param {BurnInSubtitleDvbSub} burnInSubtitleDvbSub The Burn-In DVB-SUB Subtitle to be added
* @throws {BitmovinError}
* @memberof DvbsubApi
*/
create(encodingId: string, streamId: string, burnInSubtitleDvbSub?: BurnInSubtitleDvbSub): Promise<BurnInSubtitleDvbSub>;
/**
* @summary Delete Burn-In DVB-SUB Subtitle from Stream
* @param {string} encodingId Id of the encoding.
* @param {string} streamId Id of the stream.
* @param {string} subtitleId Id of the subtitle.
* @throws {BitmovinError}
* @memberof DvbsubApi
*/
delete(encodingId: string, streamId: string, subtitleId: string): Promise<BitmovinResponse>;
/**
* @summary Get Burn-In DVB-SUB Subtitle Details
* @param {string} encodingId Id of the encoding.
* @param {string} streamId Id of the stream.
* @param {string} subtitleId Id of the subtitle.
* @throws {BitmovinError}
* @memberof DvbsubApi
*/
get(encodingId: string, streamId: string, subtitleId: string): Promise<BurnInSubtitleDvbSub>;
/**
* @summary List the Burn-In DVB-SUB subtitles of a stream
* @param {string} encodingId Id of the encoding.
* @param {string} streamId Id of the stream.
* @param {*} [queryParameters] query parameters for filtering, sorting and pagination
* @throws {BitmovinError}
* @memberof DvbsubApi
*/
list(encodingId: string, streamId: string, queryParameters?: BurnInSubtitleDvbSubListQueryParams | ((q: BurnInSubtitleDvbSubListQueryParamsBuilder) => BurnInSubtitleDvbSubListQueryParamsBuilder)): Promise<PaginationResponse<BurnInSubtitleDvbSub>>;
}