@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
50 lines (49 loc) • 2 kB
TypeScript
import { BaseAPI } from '../../../../common/BaseAPI';
import Configuration from '../../../../common/Configuration';
import CustomdataApi from './customdata/CustomdataApi';
import BitmovinResponse from '../../../../models/BitmovinResponse';
import MxfMuxing from '../../../../models/MxfMuxing';
import PaginationResponse from '../../../../models/PaginationResponse';
import { MxfMuxingListQueryParams, MxfMuxingListQueryParamsBuilder } from './MxfMuxingListQueryParams';
/**
* MxfApi - object-oriented interface
* @export
* @class MxfApi
* @extends {BaseAPI}
*/
export default class MxfApi extends BaseAPI {
customdata: CustomdataApi;
constructor(configuration: Configuration);
/**
* @summary Add MXF muxing
* @param {string} encodingId Id of the encoding.
* @param {MxfMuxing} mxfMuxing The MXF muxing to be created
* @throws {BitmovinError}
* @memberof MxfApi
*/
create(encodingId: string, mxfMuxing?: MxfMuxing): Promise<MxfMuxing>;
/**
* @summary Delete MXF muxing
* @param {string} encodingId Id of the encoding.
* @param {string} muxingId Id of the MXF muxing
* @throws {BitmovinError}
* @memberof MxfApi
*/
delete(encodingId: string, muxingId: string): Promise<BitmovinResponse>;
/**
* @summary MXF muxing details
* @param {string} encodingId Id of the encoding.
* @param {string} muxingId Id of the MXF muxing
* @throws {BitmovinError}
* @memberof MxfApi
*/
get(encodingId: string, muxingId: string): Promise<MxfMuxing>;
/**
* @summary List MXF muxings
* @param {string} encodingId Id of the encoding.
* @param {*} [queryParameters] query parameters for filtering, sorting and pagination
* @throws {BitmovinError}
* @memberof MxfApi
*/
list(encodingId: string, queryParameters?: MxfMuxingListQueryParams | ((q: MxfMuxingListQueryParamsBuilder) => MxfMuxingListQueryParamsBuilder)): Promise<PaginationResponse<MxfMuxing>>;
}