@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
48 lines (47 loc) • 2.2 kB
TypeScript
import { BaseAPI } from '../../../../common/BaseAPI';
import Configuration from '../../../../common/Configuration';
import AudioMixInputStream from '../../../../models/AudioMixInputStream';
import BitmovinResponse from '../../../../models/BitmovinResponse';
import PaginationResponse from '../../../../models/PaginationResponse';
import { AudioMixInputStreamListQueryParams, AudioMixInputStreamListQueryParamsBuilder } from './AudioMixInputStreamListQueryParams';
/**
* AudioMixApi - object-oriented interface
* @export
* @class AudioMixApi
* @extends {BaseAPI}
*/
export default class AudioMixApi extends BaseAPI {
constructor(configuration: Configuration);
/**
* @summary Add audio mix input stream
* @param {string} encodingId Id of the encoding.
* @param {AudioMixInputStream} audioMixInputStream The audio mix input stream to be created
* @throws {BitmovinError}
* @memberof AudioMixApi
*/
create(encodingId: string, audioMixInputStream?: AudioMixInputStream): Promise<AudioMixInputStream>;
/**
* @summary Delete audio mix input stream
* @param {string} encodingId Id of the encoding.
* @param {string} inputStreamId Id of the audio mix input stream.
* @throws {BitmovinError}
* @memberof AudioMixApi
*/
delete(encodingId: string, inputStreamId: string): Promise<BitmovinResponse>;
/**
* @summary Audio mix input stream details
* @param {string} encodingId Id of the encoding.
* @param {string} inputStreamId Id of the audio mix input stream.
* @throws {BitmovinError}
* @memberof AudioMixApi
*/
get(encodingId: string, inputStreamId: string): Promise<AudioMixInputStream>;
/**
* @summary List audio mix input stream
* @param {string} encodingId Id of the encoding.
* @param {*} [queryParameters] query parameters for filtering, sorting and pagination
* @throws {BitmovinError}
* @memberof AudioMixApi
*/
list(encodingId: string, queryParameters?: AudioMixInputStreamListQueryParams | ((q: AudioMixInputStreamListQueryParamsBuilder) => AudioMixInputStreamListQueryParamsBuilder)): Promise<PaginationResponse<AudioMixInputStream>>;
}