actions/transcode/KeyframeIntervalsAction.ts

import {Action} from "../../internal/Action.js";
import {Qualifier} from "../../internal/qualifier/Qualifier.js";
import {toFloatAsString} from "../../internal/utils/toFloatAsString.js";
import {IKeyframeIntervalsActionModel} from "../../internal/models/ITranscodeActionModel.js";
import {IActionModel} from "../../internal/models/IActionModel.js";

/**
 * @extends SDK.Action
 * @memberOf Actions.Transcode
 * @description Controls the keyframe interval of the delivered video.
 * @see Visit {@link Actions.Transcode|Transcode} for an example
 */
class KeyframeIntervalsAction extends Action {
  protected _actionModel : IKeyframeIntervalsActionModel = { actionType: 'keyframeInterval' };
  constructor(interval: number | string) {
    super();
    this._actionModel.interval = interval;
    this.addQualifier(new Qualifier('ki', toFloatAsString(interval)));
  }

  static fromJson(actionModel: IActionModel): KeyframeIntervalsAction {
    const {interval} = (actionModel as IKeyframeIntervalsActionModel);

    // We are using this() to allow inheriting classes to use super.fromJson.apply(this, [actionModel])
    // This allows the inheriting classes to determine the class to be created
    const result = new this(interval);

    return result;
  }
}

export default KeyframeIntervalsAction;