@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
46 lines (45 loc) • 2.13 kB
TypeScript
import { BaseAPI } from '../../../../common/BaseAPI';
import Configuration from '../../../../common/Configuration';
import CustomdataApi from './customdata/CustomdataApi';
import BitmovinResponse from '../../../../models/BitmovinResponse';
import DvbSubtitleConfiguration from '../../../../models/DvbSubtitleConfiguration';
import PaginationResponse from '../../../../models/PaginationResponse';
import { DvbSubtitleConfigurationListQueryParams, DvbSubtitleConfigurationListQueryParamsBuilder } from './DvbSubtitleConfigurationListQueryParams';
/**
* DvbSubtitleApi - object-oriented interface
* @export
* @class DvbSubtitleApi
* @extends {BaseAPI}
*/
export default class DvbSubtitleApi extends BaseAPI {
customdata: CustomdataApi;
constructor(configuration: Configuration);
/**
* @summary Create DVB-SUB subtitle configuration
* @param {DvbSubtitleConfiguration} dvbSubtitleConfiguration The DVB-SUB subtitle configuration to be created
* @throws {BitmovinError}
* @memberof DvbSubtitleApi
*/
create(dvbSubtitleConfiguration?: DvbSubtitleConfiguration): Promise<DvbSubtitleConfiguration>;
/**
* @summary Delete DVB-SUB subtitle configuration
* @param {string} configurationId Id of the subtitle configuration
* @throws {BitmovinError}
* @memberof DvbSubtitleApi
*/
delete(configurationId: string): Promise<BitmovinResponse>;
/**
* @summary DVB-SUB subtitle configuration details
* @param {string} configurationId Id of the codec configuration
* @throws {BitmovinError}
* @memberof DvbSubtitleApi
*/
get(configurationId: string): Promise<DvbSubtitleConfiguration>;
/**
* @summary List DVB-SUB subtitle configurations
* @param {*} [queryParameters] query parameters for filtering, sorting and pagination
* @throws {BitmovinError}
* @memberof DvbSubtitleApi
*/
list(queryParameters?: DvbSubtitleConfigurationListQueryParams | ((q: DvbSubtitleConfigurationListQueryParamsBuilder) => DvbSubtitleConfigurationListQueryParamsBuilder)): Promise<PaginationResponse<DvbSubtitleConfiguration>>;
}