VideoConfiguration.ts

import {map, mapArray} from '../common/Mapper';
import CodecConfiguration from './CodecConfiguration';
import ColorConfig from './ColorConfig';
import DisplayAspectRatio from './DisplayAspectRatio';
import EncodingMode from './EncodingMode';
import PixelFormat from './PixelFormat';

/**
 * @export
 * @class VideoConfiguration
 */
export class VideoConfiguration extends CodecConfiguration {
  /**
   * Width of the encoded video in pixels
   * @type {number}
   * @memberof VideoConfiguration
   */
  public width?: number;

  /**
   * Height of the encoded video in pixels
   * @type {number}
   * @memberof VideoConfiguration
   */
  public height?: number;

  /**
   * Target bitrate for the encoded video in bps. Either bitrate or crf is required.
   * @type {number}
   * @memberof VideoConfiguration
   */
  public bitrate?: number;

  /**
   * Target frame rate of the encoded video. Must be set for live encodings
   * @type {number}
   * @memberof VideoConfiguration
   */
  public rate?: number;

  /**
   * Describes the color encoding, bit depth, and chroma subsampling of each pixel in the output image.
   * @type {PixelFormat}
   * @memberof VideoConfiguration
   */
  public pixelFormat?: PixelFormat;

  /**
   * @type {ColorConfig}
   * @memberof VideoConfiguration
   */
  public 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
   */
  public 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
   */
  public 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
   */
  public 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
   */
  public encodingMode?: EncodingMode;

  constructor(obj?: Partial<VideoConfiguration>) {
    super(obj);
    if(!obj) {
      return;
    }
    this.width = map(obj.width);
    this.height = map(obj.height);
    this.bitrate = map(obj.bitrate);
    this.rate = map(obj.rate);
    this.pixelFormat = map(obj.pixelFormat);
    this.colorConfig = map(obj.colorConfig, ColorConfig);
    this.sampleAspectRatioNumerator = map(obj.sampleAspectRatioNumerator);
    this.sampleAspectRatioDenominator = map(obj.sampleAspectRatioDenominator);
    this.displayAspectRatio = map(obj.displayAspectRatio, DisplayAspectRatio);
    this.encodingMode = map(obj.encodingMode);
  }
}

export default VideoConfiguration;