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