@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
48 lines (47 loc) • 2.26 kB
TypeScript
import { BaseAPI } from '../../../../../common/BaseAPI';
import Configuration from '../../../../../common/Configuration';
import BitmovinResponse from '../../../../../models/BitmovinResponse';
import Cea708CaptionInputStream from '../../../../../models/Cea708CaptionInputStream';
import PaginationResponse from '../../../../../models/PaginationResponse';
import { Cea708CaptionInputStreamListQueryParams, Cea708CaptionInputStreamListQueryParamsBuilder } from './Cea708CaptionInputStreamListQueryParams';
/**
* Cea708Api - object-oriented interface
* @export
* @class Cea708Api
* @extends {BaseAPI}
*/
export default class Cea708Api extends BaseAPI {
constructor(configuration: Configuration);
/**
* @summary Add CEA 708 Input Stream
* @param {string} encodingId Id of the encoding.
* @param {Cea708CaptionInputStream} cea708CaptionInputStream The CEA 708 Input Stream to be created
* @throws {BitmovinError}
* @memberof Cea708Api
*/
create(encodingId: string, cea708CaptionInputStream?: Cea708CaptionInputStream): Promise<Cea708CaptionInputStream>;
/**
* @summary Delete CEA 708 Input Stream
* @param {string} encodingId Id of the Encoding
* @param {string} inputStreamId Id of the CEA 708 input stream.
* @throws {BitmovinError}
* @memberof Cea708Api
*/
delete(encodingId: string, inputStreamId: string): Promise<BitmovinResponse>;
/**
* @summary CEA 708 Input Stream Details
* @param {string} encodingId Id of the encoding.
* @param {string} inputStreamId Id of the CEA 708 input stream.
* @throws {BitmovinError}
* @memberof Cea708Api
*/
get(encodingId: string, inputStreamId: string): Promise<Cea708CaptionInputStream>;
/**
* @summary List CEA 708 Input Streams
* @param {string} encodingId Id of the encoding.
* @param {*} [queryParameters] query parameters for filtering, sorting and pagination
* @throws {BitmovinError}
* @memberof Cea708Api
*/
list(encodingId: string, queryParameters?: Cea708CaptionInputStreamListQueryParams | ((q: Cea708CaptionInputStreamListQueryParamsBuilder) => Cea708CaptionInputStreamListQueryParamsBuilder)): Promise<PaginationResponse<Cea708CaptionInputStream>>;
}