@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
52 lines (51 loc) • 2.48 kB
TypeScript
import { BaseAPI } from '../../../../../../common/BaseAPI';
import Configuration from '../../../../../../common/Configuration';
import AudioAdaptationSet from '../../../../../../models/AudioAdaptationSet';
import BitmovinResponse from '../../../../../../models/BitmovinResponse';
import PaginationResponse from '../../../../../../models/PaginationResponse';
import { AudioAdaptationSetListQueryParams, AudioAdaptationSetListQueryParamsBuilder } from './AudioAdaptationSetListQueryParams';
/**
* AudioApi - object-oriented interface
* @export
* @class AudioApi
* @extends {BaseAPI}
*/
export default class AudioApi extends BaseAPI {
constructor(configuration: Configuration);
/**
* @summary Add Audio AdaptationSet
* @param {string} manifestId Id of the manifest
* @param {string} periodId Id of the period
* @param {AudioAdaptationSet} audioAdaptationSet The audio adaptation set to be added to the period
* @throws {BitmovinError}
* @memberof AudioApi
*/
create(manifestId: string, periodId: string, audioAdaptationSet?: AudioAdaptationSet): Promise<AudioAdaptationSet>;
/**
* @summary Delete Audio AdaptationSet
* @param {string} manifestId Id of the manifest
* @param {string} periodId Id of the period
* @param {string} adaptationsetId Id of the audio adaptation set to be deleted
* @throws {BitmovinError}
* @memberof AudioApi
*/
delete(manifestId: string, periodId: string, adaptationsetId: string): Promise<BitmovinResponse>;
/**
* @summary Audio AdaptationSet Details
* @param {string} manifestId Id of the manifest
* @param {string} periodId Id of the period
* @param {string} adaptationsetId Id of the audio adaptation set
* @throws {BitmovinError}
* @memberof AudioApi
*/
get(manifestId: string, periodId: string, adaptationsetId: string): Promise<AudioAdaptationSet>;
/**
* @summary List all Audio AdaptationSets
* @param {string} manifestId Id of the manifest
* @param {string} periodId Id of the period
* @param {*} [queryParameters] query parameters for filtering, sorting and pagination
* @throws {BitmovinError}
* @memberof AudioApi
*/
list(manifestId: string, periodId: string, queryParameters?: AudioAdaptationSetListQueryParams | ((q: AudioAdaptationSetListQueryParamsBuilder) => AudioAdaptationSetListQueryParamsBuilder)): Promise<PaginationResponse<AudioAdaptationSet>>;
}