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