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