@bitmovin/api-sdk/dist/encoding/encodings/live/hd/HdApi.d.ts

Bitmovin JS/TS API SDK

import { BaseAPI } from '../../../../common/BaseAPI';
import Configuration from '../../../../common/Configuration';
import BitmovinResponse from '../../../../models/BitmovinResponse';
import StartLiveChannelEncodingRequest from '../../../../models/StartLiveChannelEncodingRequest';
/**
 * HdApi - object-oriented interface
 * @export
 * @class HdApi
 * @extends {BaseAPI}
 */
export default class HdApi extends BaseAPI {
    constructor(configuration: Configuration);
    /**
     * @summary Live Encoding Start Details
     * @param {string} encodingId Id of the encoding
     * @throws {BitmovinError}
     * @memberof HdApi
     */
    getStartRequest(encodingId: string): Promise<StartLiveChannelEncodingRequest>;
    /**
     * @summary Start HD Options Live Encoding
     * @param {string} encodingId Id of the encoding
     * @param {StartLiveChannelEncodingRequest} startLiveChannelEncodingRequest Live Encoding startup options
     * @throws {BitmovinError}
     * @memberof HdApi
     */
    start(encodingId: string, startLiveChannelEncodingRequest?: StartLiveChannelEncodingRequest): Promise<BitmovinResponse>;
}