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