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