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