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

Bitmovin JS/TS API SDK

import CodecConfiguration from './CodecConfiguration';
import ColorConfig from './ColorConfig';
import DisplayAspectRatio from './DisplayAspectRatio';
import EncodingMode from './EncodingMode';
import PixelFormat from './PixelFormat';
/**
 * @export
 * @class VideoConfiguration
 */
export declare class VideoConfiguration extends CodecConfiguration {
    /**
     * Width of the encoded video in pixels
     * @type {number}
     * @memberof VideoConfiguration
     */
    width?: number;
    /**
     * Height of the encoded video in pixels
     * @type {number}
     * @memberof VideoConfiguration
     */
    height?: number;
    /**
     * Target bitrate for the encoded video in bps. Either bitrate or crf is required.
     * @type {number}
     * @memberof VideoConfiguration
     */
    bitrate?: number;
    /**
     * Target frame rate of the encoded video. Must be set for live encodings
     * @type {number}
     * @memberof VideoConfiguration
     */
    rate?: number;
    /**
     * Describes the color encoding, bit depth, and chroma subsampling of each pixel in the output image.
     * @type {PixelFormat}
     * @memberof VideoConfiguration
     */
    pixelFormat?: PixelFormat;
    /**
     * @type {ColorConfig}
     * @memberof VideoConfiguration
     */
    colorConfig?: ColorConfig;
    /**
     * The numerator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioDenominator is set. If set then displayAspectRatio is not allowed.
     * @type {number}
     * @memberof VideoConfiguration
     */
    sampleAspectRatioNumerator?: number;
    /**
     * The denominator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioNumerator is set. If set then displayAspectRatio is not allowed.
     * @type {number}
     * @memberof VideoConfiguration
     */
    sampleAspectRatioDenominator?: number;
    /**
     * Specifies a display aspect ratio (DAR) to be enforced. The sample aspect ratio (SAR) will be adjusted accordingly. If set then sampleAspectRatioNumerator and sampleAspectRatioDenominator are not allowed.
     * @type {DisplayAspectRatio}
     * @memberof VideoConfiguration
     */
    displayAspectRatio?: DisplayAspectRatio;
    /**
     * The mode of the encoding. When this is set, `encodingMode` (`liveEncodingMode`) must not be set in the (live) encoding start request.
     * @type {EncodingMode}
     * @memberof VideoConfiguration
     */
    encodingMode?: EncodingMode;
    constructor(obj?: Partial<VideoConfiguration>);
}
export default VideoConfiguration;