@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
63 lines (62 loc) • 2.49 kB
TypeScript
import { BaseAPI } from '../../../common/BaseAPI';
import Configuration from '../../../common/Configuration';
import EsamApi from './esam/EsamApi';
import ResetLiveManifestTimeshiftApi from './resetLiveManifestTimeshift/ResetLiveManifestTimeshiftApi';
import HeartbeatApi from './heartbeat/HeartbeatApi';
import HdApi from './hd/HdApi';
import InsertableContentApi from './insertableContent/InsertableContentApi';
import Scte35CueApi from './scte35Cue/Scte35CueApi';
import BitmovinResponse from '../../../models/BitmovinResponse';
import LiveEncoding from '../../../models/LiveEncoding';
import StartLiveEncodingRequest from '../../../models/StartLiveEncodingRequest';
/**
* LiveApi - object-oriented interface
* @export
* @class LiveApi
* @extends {BaseAPI}
*/
export default class LiveApi extends BaseAPI {
esam: EsamApi;
resetLiveManifestTimeshift: ResetLiveManifestTimeshiftApi;
heartbeat: HeartbeatApi;
hd: HdApi;
insertableContent: InsertableContentApi;
scte35Cue: Scte35CueApi;
constructor(configuration: Configuration);
/**
* @summary Live Encoding Details
* @param {string} encodingId Id of the encoding.
* @throws {BitmovinError}
* @memberof LiveApi
*/
get(encodingId: string): Promise<LiveEncoding>;
/**
* @summary Live Encoding Start Details
* @param {string} encodingId Id of the encoding
* @throws {BitmovinError}
* @memberof LiveApi
*/
getStartRequest(encodingId: string): Promise<StartLiveEncodingRequest>;
/**
* @summary Re-Start Live Encoding
* @param {string} encodingId Id of the encoding. **Important:** Only live encodings with the status `RUNNING`, `FINISHED`, `CANCELED` or `ERROR` can be restarted.
* @throws {BitmovinError}
* @memberof LiveApi
*/
restart(encodingId: string): Promise<BitmovinResponse>;
/**
* @summary Start Live Encoding
* @param {string} encodingId Id of the encoding
* @param {StartLiveEncodingRequest} startLiveEncodingRequest Live Encoding startup options
* @throws {BitmovinError}
* @memberof LiveApi
*/
start(encodingId: string, startLiveEncodingRequest?: StartLiveEncodingRequest): Promise<BitmovinResponse>;
/**
* @summary Stop Live Encoding
* @param {string} encodingId Id of the encoding
* @throws {BitmovinError}
* @memberof LiveApi
*/
stop(encodingId: string): Promise<BitmovinResponse>;
}