@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
52 lines (51 loc) • 2.43 kB
TypeScript
import { BaseAPI } from '../../../../../common/BaseAPI';
import Configuration from '../../../../../common/Configuration';
import BitmovinResponse from '../../../../../models/BitmovinResponse';
import BurnInSubtitleSrt from '../../../../../models/BurnInSubtitleSrt';
import PaginationResponse from '../../../../../models/PaginationResponse';
import { BurnInSubtitleSrtListQueryParams, BurnInSubtitleSrtListQueryParamsBuilder } from './BurnInSubtitleSrtListQueryParams';
/**
* SrtApi - object-oriented interface
* @export
* @class SrtApi
* @extends {BaseAPI}
*/
export default class SrtApi extends BaseAPI {
constructor(configuration: Configuration);
/**
* @summary Burn-In SRT Subtitle into Stream
* @param {string} encodingId Id of the encoding.
* @param {string} streamId Id of the stream.
* @param {BurnInSubtitleSrt} burnInSubtitleSrt The Burn-In SRT Subtitle to be added
* @throws {BitmovinError}
* @memberof SrtApi
*/
create(encodingId: string, streamId: string, burnInSubtitleSrt?: BurnInSubtitleSrt): Promise<BurnInSubtitleSrt>;
/**
* @summary Delete Burn-In SRT Subtitle from Stream
* @param {string} encodingId Id of the encoding.
* @param {string} streamId Id of the stream.
* @param {string} subtitleId Id of the burn-in subtitle.
* @throws {BitmovinError}
* @memberof SrtApi
*/
delete(encodingId: string, streamId: string, subtitleId: string): Promise<BitmovinResponse>;
/**
* @summary Get Burn-In SRT Subtitle Details
* @param {string} encodingId Id of the encoding.
* @param {string} streamId Id of the stream.
* @param {string} subtitleId Id of the burn-in subtitle.
* @throws {BitmovinError}
* @memberof SrtApi
*/
get(encodingId: string, streamId: string, subtitleId: string): Promise<BurnInSubtitleSrt>;
/**
* @summary List the Burn-In SRT 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 SrtApi
*/
list(encodingId: string, streamId: string, queryParameters?: BurnInSubtitleSrtListQueryParams | ((q: BurnInSubtitleSrtListQueryParamsBuilder) => BurnInSubtitleSrtListQueryParamsBuilder)): Promise<PaginationResponse<BurnInSubtitleSrt>>;
}