@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
46 lines (45 loc) • 2.01 kB
TypeScript
import { BaseAPI } from '../../../common/BaseAPI';
import Configuration from '../../../common/Configuration';
import CustomdataApi from './customdata/CustomdataApi';
import BitmovinResponse from '../../../models/BitmovinResponse';
import LiveMediaIngestOutput from '../../../models/LiveMediaIngestOutput';
import PaginationResponse from '../../../models/PaginationResponse';
import { LiveMediaIngestOutputListQueryParams, LiveMediaIngestOutputListQueryParamsBuilder } from './LiveMediaIngestOutputListQueryParams';
/**
* LiveMediaIngestApi - object-oriented interface
* @export
* @class LiveMediaIngestApi
* @extends {BaseAPI}
*/
export default class LiveMediaIngestApi extends BaseAPI {
customdata: CustomdataApi;
constructor(configuration: Configuration);
/**
* @summary Create Live Media Ingest Output
* @param {LiveMediaIngestOutput} liveMediaIngestOutput The Live Media Ingest output to be created
* @throws {BitmovinError}
* @memberof LiveMediaIngestApi
*/
create(liveMediaIngestOutput?: LiveMediaIngestOutput): Promise<LiveMediaIngestOutput>;
/**
* @summary Delete Live Media Ingest Output
* @param {string} outputId Id of the output
* @throws {BitmovinError}
* @memberof LiveMediaIngestApi
*/
delete(outputId: string): Promise<BitmovinResponse>;
/**
* @summary Live Media Ingest Output Details
* @param {string} outputId Id of the output
* @throws {BitmovinError}
* @memberof LiveMediaIngestApi
*/
get(outputId: string): Promise<LiveMediaIngestOutput>;
/**
* @summary List Live Media Ingest Outputs
* @param {*} [queryParameters] query parameters for filtering, sorting and pagination
* @throws {BitmovinError}
* @memberof LiveMediaIngestApi
*/
list(queryParameters?: LiveMediaIngestOutputListQueryParams | ((q: LiveMediaIngestOutputListQueryParamsBuilder) => LiveMediaIngestOutputListQueryParamsBuilder)): Promise<PaginationResponse<LiveMediaIngestOutput>>;
}