@bitmovin/api-sdk/dist/models/StartEncodingRequest.d.ts

Bitmovin JS/TS API SDK

import AiSceneAnalysis from './AiSceneAnalysis';
import EncodingMode from './EncodingMode';
import ManifestGenerator from './ManifestGenerator';
import ManifestResource from './ManifestResource';
import PerTitle from './PerTitle';
import Scheduling from './Scheduling';
import Trimming from './Trimming';
import Tweaks from './Tweaks';
/**
 * @export
 * @class StartEncodingRequest
 */
export declare class StartEncodingRequest {
    /**
     * Allows to encode only part of the input. Defines start (offset) and duration of the desired section. This is not allowed when the Encoding uses any kind of Input Stream resource.
     * @type {Trimming}
     * @memberof StartEncodingRequest
     */
    trimming?: Trimming;
    /**
     * Scheduling parameters of the encoding.
     * @type {Scheduling}
     * @memberof StartEncodingRequest
     */
    scheduling?: Scheduling;
    /**
     * Special tweaks for your encoding job.
     * @type {Tweaks}
     * @memberof StartEncodingRequest
     */
    tweaks?: Tweaks;
    /**
     * Enable frame dropping/duplication to handle variable frames per seconds of video input streams
     * @type {boolean}
     * @memberof StartEncodingRequest
     */
    handleVariableInputFps?: boolean;
    /**
     * The pass mode of the encoding. Must only be set when `encodingMode` is not set on any codec configuration used by this encoding.
     * @type {EncodingMode}
     * @memberof StartEncodingRequest
     */
    encodingMode?: EncodingMode;
    /**
     * DASH manifests to be generated for previewing while the encoding is still running. See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)
     * @type {ManifestResource[]}
     * @memberof StartEncodingRequest
     */
    previewDashManifests?: ManifestResource[];
    /**
     * HLS manifests to be generated for previewing while the encoding is still running. See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)
     * @type {ManifestResource[]}
     * @memberof StartEncodingRequest
     */
    previewHlsManifests?: ManifestResource[];
    /**
     * DASH manifests to be generated right after encoding (just-in-time). See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)
     * @type {ManifestResource[]}
     * @memberof StartEncodingRequest
     */
    vodDashManifests?: ManifestResource[];
    /**
     * HLS manifests to be generated right after encoding (just-in-time). See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)
     * @type {ManifestResource[]}
     * @memberof StartEncodingRequest
     */
    vodHlsManifests?: ManifestResource[];
    /**
     * Smooth Streaming manifests to be generated right after encoding (just-in-time). See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)
     * @type {ManifestResource[]}
     * @memberof StartEncodingRequest
     */
    vodSmoothManifests?: ManifestResource[];
    /**
     * Major version of the manifest generator to be used for manifests referenced in this request (by properties vodDashManifests, vodHlsManifests, vodSmoothManifests, previewDashManifests, previewHlsManifests). `V2` is available for encoder versions 2.70.0 and above and is the recommended option. The default value depends on the sign-up date of your organization. See [documentation](https://developer.bitmovin.com/encoding/docs/manifest-generator-v2) page for a detailed explanation.
     * @type {ManifestGenerator}
     * @memberof StartEncodingRequest
     */
    manifestGenerator?: ManifestGenerator;
    /**
     * Per-Title settings
     * @type {PerTitle}
     * @memberof StartEncodingRequest
     */
    perTitle?: PerTitle;
    /**
     * AI scene analysis settings
     * @type {AiSceneAnalysis}
     * @memberof StartEncodingRequest
     */
    aiSceneAnalysis?: AiSceneAnalysis;
    constructor(obj?: Partial<StartEncodingRequest>);
}
export default StartEncodingRequest;