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

Bitmovin JS/TS API SDK

import BitmovinResource from './BitmovinResource';
import CloudRegion from './CloudRegion';
import PrewarmedEncoderDiskSize from './PrewarmedEncoderDiskSize';
import PrewarmedEncoderPoolStatus from './PrewarmedEncoderPoolStatus';
/**
 * @export
 * @class PrewarmedEncoderPool
 */
export declare class PrewarmedEncoderPool extends BitmovinResource {
    /**
     * The encoder version which the pool's instances will be running (required)
     * @type {string}
     * @memberof PrewarmedEncoderPool
     */
    encoderVersion?: string;
    /**
     * The cloud region in which the pool's instances will be running. Must be a specific region (e.g. not 'AUTO', 'GOOGLE' or 'EUROPE') (required)
     * @type {CloudRegion}
     * @memberof PrewarmedEncoderPool
     */
    cloudRegion?: CloudRegion;
    /**
     * Define an external infrastructure to run the pool on.
     * @type {string}
     * @memberof PrewarmedEncoderPool
     */
    infrastructureId?: string;
    /**
     * Disk size of the prewarmed instances in GB. Needs to be chosen depending on input file sizes and encoding features used. (required)
     * @type {PrewarmedEncoderDiskSize}
     * @memberof PrewarmedEncoderPool
     */
    diskSize?: PrewarmedEncoderDiskSize;
    /**
     * Number of instances to keep prewarmed while the pool is running (required)
     * @type {number}
     * @memberof PrewarmedEncoderPool
     */
    targetPoolSize?: number;
    /**
     * Activate dynamic pool behaviour. Pool will increase/decrease based on usage up until a size of 10 instances. Minimum pool size is set by targetPoolSize
     * @type {boolean}
     * @memberof PrewarmedEncoderPool
     */
    dynamicPool?: boolean;
    /**
     * Create pool with GPU instances for hardware encoding presets (e.g., VOD_HARDWARE_SHORTFORM).
     * @type {boolean}
     * @memberof PrewarmedEncoderPool
     */
    gpuEnabled?: boolean;
    /**
     * Current status of the pool.
     * @type {PrewarmedEncoderPoolStatus}
     * @memberof PrewarmedEncoderPool
     */
    status?: PrewarmedEncoderPoolStatus;
    constructor(obj?: Partial<PrewarmedEncoderPool>);
}
export default PrewarmedEncoderPool;