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