@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
54 lines (53 loc) • 2.6 kB
TypeScript
import { BaseAPI } from '../../../../../../common/BaseAPI';
import Configuration from '../../../../../../common/Configuration';
import CustomdataApi from './customdata/CustomdataApi';
import BitmovinResponse from '../../../../../../models/BitmovinResponse';
import SrtToCea608708Caption from '../../../../../../models/SrtToCea608708Caption';
import PaginationResponse from '../../../../../../models/PaginationResponse';
import { SrtToCea608708CaptionListQueryParams, SrtToCea608708CaptionListQueryParamsBuilder } from './SrtToCea608708CaptionListQueryParams';
/**
* SrtApi - object-oriented interface
* @export
* @class SrtApi
* @extends {BaseAPI}
*/
export default class SrtApi extends BaseAPI {
customdata: CustomdataApi;
constructor(configuration: Configuration);
/**
* @summary Embed SRT captions as 608/708 into Stream
* @param {string} encodingId Id of the encoding.
* @param {string} streamId Id of the stream.
* @param {SrtToCea608708Caption} srtToCea608708Caption The SRT captions to be embedded as 607/708 into Stream
* @throws {BitmovinError}
* @memberof SrtApi
*/
create(encodingId: string, streamId: string, srtToCea608708Caption?: SrtToCea608708Caption): Promise<SrtToCea608708Caption>;
/**
* @summary Delete SRT captions as 608/708 from Stream
* @param {string} encodingId Id of the encoding.
* @param {string} streamId Id of the stream.
* @param {string} captionsId Id of the caption.
* @throws {BitmovinError}
* @memberof SrtApi
*/
delete(encodingId: string, streamId: string, captionsId: string): Promise<BitmovinResponse>;
/**
* @summary Embed SRT captions as 608/708 Details
* @param {string} encodingId Id of the encoding.
* @param {string} streamId Id of the stream.
* @param {string} captionsId Id of the caption.
* @throws {BitmovinError}
* @memberof SrtApi
*/
get(encodingId: string, streamId: string, captionsId: string): Promise<SrtToCea608708Caption>;
/**
* @summary List SRT captions as 608/708 from 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?: SrtToCea608708CaptionListQueryParams | ((q: SrtToCea608708CaptionListQueryParamsBuilder) => SrtToCea608708CaptionListQueryParamsBuilder)): Promise<PaginationResponse<SrtToCea608708Caption>>;
}