@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
44 lines (43 loc) • 2.13 kB
TypeScript
import { BaseAPI } from '../../../../common/BaseAPI';
import Configuration from '../../../../common/Configuration';
import BitmovinResponse from '../../../../models/BitmovinResponse';
import PassthroughAudioConfiguration from '../../../../models/PassthroughAudioConfiguration';
import PaginationResponse from '../../../../models/PaginationResponse';
import { PassthroughAudioConfigurationListQueryParams, PassthroughAudioConfigurationListQueryParamsBuilder } from './PassthroughAudioConfigurationListQueryParams';
/**
* PassthroughApi - object-oriented interface
* @export
* @class PassthroughApi
* @extends {BaseAPI}
*/
export default class PassthroughApi extends BaseAPI {
constructor(configuration: Configuration);
/**
* @summary Create Audio Passthrough Configuration
* @param {PassthroughAudioConfiguration} passthroughAudioConfiguration The Audio Passthrough Configuration to be created
* @throws {BitmovinError}
* @memberof PassthroughApi
*/
create(passthroughAudioConfiguration?: PassthroughAudioConfiguration): Promise<PassthroughAudioConfiguration>;
/**
* @summary Delete Audio Passthrough Codec Configuration
* @param {string} configurationId Id of the audio configuration
* @throws {BitmovinError}
* @memberof PassthroughApi
*/
delete(configurationId: string): Promise<BitmovinResponse>;
/**
* @summary Audio Passthrough Configuration Details
* @param {string} configurationId Id of the audio configuration
* @throws {BitmovinError}
* @memberof PassthroughApi
*/
get(configurationId: string): Promise<PassthroughAudioConfiguration>;
/**
* @summary List Audio Passthrough Configurations
* @param {*} [queryParameters] query parameters for filtering, sorting and pagination
* @throws {BitmovinError}
* @memberof PassthroughApi
*/
list(queryParameters?: PassthroughAudioConfigurationListQueryParams | ((q: PassthroughAudioConfigurationListQueryParamsBuilder) => PassthroughAudioConfigurationListQueryParamsBuilder)): Promise<PaginationResponse<PassthroughAudioConfiguration>>;
}