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