@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
50 lines (49 loc) • 2.02 kB
TypeScript
import { BaseAPI } from '../../../../common/BaseAPI';
import Configuration from '../../../../common/Configuration';
import CustomdataApi from './customdata/CustomdataApi';
import BitmovinResponse from '../../../../models/BitmovinResponse';
import TextMuxing from '../../../../models/TextMuxing';
import PaginationResponse from '../../../../models/PaginationResponse';
import { TextMuxingListQueryParams, TextMuxingListQueryParamsBuilder } from './TextMuxingListQueryParams';
/**
* TextApi - object-oriented interface
* @export
* @class TextApi
* @extends {BaseAPI}
*/
export default class TextApi extends BaseAPI {
customdata: CustomdataApi;
constructor(configuration: Configuration);
/**
* @summary Add Text muxing
* @param {string} encodingId Id of the encoding.
* @param {TextMuxing} textMuxing The Text muxing to be created
* @throws {BitmovinError}
* @memberof TextApi
*/
create(encodingId: string, textMuxing?: TextMuxing): Promise<TextMuxing>;
/**
* @summary Delete Text muxing
* @param {string} encodingId Id of the encoding.
* @param {string} muxingId Id of the Text muxing
* @throws {BitmovinError}
* @memberof TextApi
*/
delete(encodingId: string, muxingId: string): Promise<BitmovinResponse>;
/**
* @summary Text muxing details
* @param {string} encodingId Id of the encoding.
* @param {string} muxingId Id of the Text muxing
* @throws {BitmovinError}
* @memberof TextApi
*/
get(encodingId: string, muxingId: string): Promise<TextMuxing>;
/**
* @summary List Text muxings
* @param {string} encodingId Id of the encoding.
* @param {*} [queryParameters] query parameters for filtering, sorting and pagination
* @throws {BitmovinError}
* @memberof TextApi
*/
list(encodingId: string, queryParameters?: TextMuxingListQueryParams | ((q: TextMuxingListQueryParamsBuilder) => TextMuxingListQueryParamsBuilder)): Promise<PaginationResponse<TextMuxing>>;
}