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