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