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