@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 CmafMuxing from '../../../../models/CmafMuxing';
import PaginationResponse from '../../../../models/PaginationResponse';
import { CmafMuxingListQueryParams, CmafMuxingListQueryParamsBuilder } from './CmafMuxingListQueryParams';
/**
* CmafApi - object-oriented interface
* @export
* @class CmafApi
* @extends {BaseAPI}
*/
export default class CmafApi extends BaseAPI {
customdata: CustomdataApi;
constructor(configuration: Configuration);
/**
* @summary Add CMAF muxing
* @param {string} encodingId Id of the encoding.
* @param {CmafMuxing} cmafMuxing The CMAF muxing to be created
* @throws {BitmovinError}
* @memberof CmafApi
*/
create(encodingId: string, cmafMuxing?: CmafMuxing): Promise<CmafMuxing>;
/**
* @summary Delete CMAF muxing
* @param {string} encodingId Id of the encoding.
* @param {string} muxingId Id of the CMAF muxing
* @throws {BitmovinError}
* @memberof CmafApi
*/
delete(encodingId: string, muxingId: string): Promise<BitmovinResponse>;
/**
* @summary CMAF muxing details
* @param {string} encodingId Id of the encoding.
* @param {string} muxingId Id of the CMAF muxing
* @throws {BitmovinError}
* @memberof CmafApi
*/
get(encodingId: string, muxingId: string): Promise<CmafMuxing>;
/**
* @summary List CMAF muxings
* @param {string} encodingId Id of the encoding.
* @param {*} [queryParameters] query parameters for filtering, sorting and pagination
* @throws {BitmovinError}
* @memberof CmafApi
*/
list(encodingId: string, queryParameters?: CmafMuxingListQueryParams | ((q: CmafMuxingListQueryParamsBuilder) => CmafMuxingListQueryParamsBuilder)): Promise<PaginationResponse<CmafMuxing>>;
}