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