@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
52 lines (51 loc) • 2.47 kB
TypeScript
import { BaseAPI } from '../../../../../common/BaseAPI';
import Configuration from '../../../../../common/Configuration';
import BitmovinResponse from '../../../../../models/BitmovinResponse';
import DolbyVisionMetadata from '../../../../../models/DolbyVisionMetadata';
import PaginationResponse from '../../../../../models/PaginationResponse';
import { DolbyVisionMetadataListQueryParams, DolbyVisionMetadataListQueryParamsBuilder } from './DolbyVisionMetadataListQueryParams';
/**
* DolbyVisionApi - object-oriented interface
* @export
* @class DolbyVisionApi
* @extends {BaseAPI}
*/
export default class DolbyVisionApi extends BaseAPI {
constructor(configuration: Configuration);
/**
* @summary Add Dolby Vision Metadata
* @param {string} encodingId Id of the encoding.
* @param {string} streamId Id of the stream.
* @param {DolbyVisionMetadata} dolbyVisionMetadata The Dolby Vision Metadata to be added
* @throws {BitmovinError}
* @memberof DolbyVisionApi
*/
create(encodingId: string, streamId: string, dolbyVisionMetadata?: DolbyVisionMetadata): Promise<DolbyVisionMetadata>;
/**
* @summary Delete Dolby Vision Metadata
* @param {string} encodingId Id of the encoding.
* @param {string} streamId Id of the stream.
* @param {string} hdrId Id of the Dolby Vision Metadata.
* @throws {BitmovinError}
* @memberof DolbyVisionApi
*/
delete(encodingId: string, streamId: string, hdrId: string): Promise<BitmovinResponse>;
/**
* @summary Dolby Vision Metadata Details
* @param {string} encodingId Id of the encoding.
* @param {string} streamId Id of the stream.
* @param {string} hdrId Id of the Dolby Vision Metadata.
* @throws {BitmovinError}
* @memberof DolbyVisionApi
*/
get(encodingId: string, streamId: string, hdrId: string): Promise<DolbyVisionMetadata>;
/**
* @summary List Dolby Vision Metadata
* @param {string} encodingId Id of the encoding.
* @param {string} streamId Id of the stream.
* @param {*} [queryParameters] query parameters for filtering, sorting and pagination
* @throws {BitmovinError}
* @memberof DolbyVisionApi
*/
list(encodingId: string, streamId: string, queryParameters?: DolbyVisionMetadataListQueryParams | ((q: DolbyVisionMetadataListQueryParamsBuilder) => DolbyVisionMetadataListQueryParamsBuilder)): Promise<PaginationResponse<DolbyVisionMetadata>>;
}