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