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