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