@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
48 lines (47 loc) • 2.04 kB
TypeScript
import { BaseAPI } from '../../../../../common/BaseAPI';
import Configuration from '../../../../../common/Configuration';
import AudioMediaInfo from '../../../../../models/AudioMediaInfo';
import BitmovinResponse from '../../../../../models/BitmovinResponse';
import PaginationResponse from '../../../../../models/PaginationResponse';
import { AudioMediaInfoListQueryParams, AudioMediaInfoListQueryParamsBuilder } from './AudioMediaInfoListQueryParams';
/**
* AudioApi - object-oriented interface
* @export
* @class AudioApi
* @extends {BaseAPI}
*/
export default class AudioApi extends BaseAPI {
constructor(configuration: Configuration);
/**
* @summary Add Audio Media
* @param {string} manifestId Id of the hls manifest.
* @param {AudioMediaInfo} audioMediaInfo The Audio Media to be added
* @throws {BitmovinError}
* @memberof AudioApi
*/
create(manifestId: string, audioMediaInfo?: AudioMediaInfo): Promise<AudioMediaInfo>;
/**
* @summary Delete Audio Media
* @param {string} manifestId Id of the hls manifest.
* @param {string} mediaId Id of the audio media.
* @throws {BitmovinError}
* @memberof AudioApi
*/
delete(manifestId: string, mediaId: string): Promise<BitmovinResponse>;
/**
* @summary Audio Media Details
* @param {string} manifestId Id of the hls manifest.
* @param {string} mediaId Id of the audio media.
* @throws {BitmovinError}
* @memberof AudioApi
*/
get(manifestId: string, mediaId: string): Promise<AudioMediaInfo>;
/**
* @summary List all Audio Media
* @param {string} manifestId Id of the hls manifest.
* @param {*} [queryParameters] query parameters for filtering, sorting and pagination
* @throws {BitmovinError}
* @memberof AudioApi
*/
list(manifestId: string, queryParameters?: AudioMediaInfoListQueryParams | ((q: AudioMediaInfoListQueryParamsBuilder) => AudioMediaInfoListQueryParamsBuilder)): Promise<PaginationResponse<AudioMediaInfo>>;
}