actions/effect/leveled/FadeOut.ts

import {LeveledEffectAction} from "../EffectActions/LeveledEffectAction.js";
import {Action} from "../../../internal/Action.js";
import {Qualifier} from "../../../internal/qualifier/Qualifier.js";
import {QualifierValue} from "../../../internal/qualifier/QualifierValue.js";
import {IFadeOutEffectActionModel} from "../../../internal/models/IEffectActionModel.js";
import {IActionModel} from "../../../internal/models/IActionModel.js";


/**
 * @description Fade out at the end of the video, use the length() method to set the time in ms for the fade to occur. (Server default: 2000)
 * @extends LeveledEffectAction
 * @memberOf Actions.Effect
 * @see Visit {@link Actions.Effect|Effect} for an example
 */
class FadeOutEffectAction extends Action {
  protected _actionModel : IFadeOutEffectActionModel = {actionType: 'fadeOut'};
  constructor(duration: number) {
    super();
    this.addQualifier(new Qualifier('e', new QualifierValue(['fade', `-${duration}`]).setDelimiter(':')));
    duration && (this._actionModel.length = duration);
  }
  /**
   *
   * @description Sets the duration level for the action
   * @param {string | number} duration - The duration of the effect
   */
  duration(duration: number | string): this {
    this._actionModel.length = duration as number;
    return this.addQualifier(new Qualifier('e', new QualifierValue(['fade', `-${duration}`]).setDelimiter(':')));
  }

  static fromJson(actionModel: IActionModel): FadeOutEffectAction {
    const {length} = (actionModel as IFadeOutEffectActionModel);

    if (length === undefined) {
      return new this(1000);
    }

    // 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(length);

    return result;
  }
}


export {FadeOutEffectAction};