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