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