actions/videoEdit/TrimAction.ts

import {Action} from "../../internal/Action.js";
import {Qualifier} from "../../internal/qualifier/Qualifier.js";
import {ITrimActionModel} from "../../internal/models/ITrimActionModel.js";
import {IActionModel} from "../../internal/models/IActionModel.js";

/**
 * @description Class for shortening a video to the specified range.
 * @extends SDK.Action
 * @memberOf Actions.VideoEdit
 * @see Visit {@link Actions.VideoEdit|VideoEdit} for an example
 */
class TrimAction extends Action {
  protected _actionModel: ITrimActionModel;

  constructor() {
    super();
    this._actionModel = {
      actionType: 'trimVideo'
    };
  }

  /**
   *
   * @description Support Percentages in values (30% -> 30p)
   * @param {string|number} val
   * @private
   * @return {string}
   */
  private parseVal(val: string|number): string | number {
    return typeof val === 'number' ? val : val.replace('%', 'p');
  }

  /**
   * @description Sets the starting position of the part of the video to keep when trimming videos.
   *
   * @param {string|number} offset The starting position of the part of the video to keep. This can be specified as a
   *                           float representing the time in seconds or a string representing the percentage of the
   *                           video length (for example, "30%" or "30p").
   * @return {this}
   */
  startOffset(offset: string|number): this {
    this._actionModel.startOffset = getAuto(offset) || +offset;
    return this.addQualifier(new Qualifier('so', this.parseVal(offset)));
  }

  /**
   * @description Sets the end position of the part of the video to keep when trimming videos.
   *
   * @param {string|number} offset The end position of the part of the video to keep. This can be specified as a
   *                         float representing the time in seconds or a string representing the percentage of the
   *                         video length (for example, "30%" or "30p").
   * @return {this}
   */
  endOffset(offset: string|number): this {
    this._actionModel.endOffset = getAuto(offset) || +offset;
    return this.addQualifier(new Qualifier('eo', this.parseVal(offset)));
  }

  /**
   * @description Sets the duration of the video to keep.
   *
   * @param {string|number} duration The length of the part of the video to keep. This can be specified as a float
   *                        representing the time in seconds or a string representing the percentage of the
   *                        video length (for example, "30%" or "30p").
   * @return {this}
   */
  duration(duration: string|number): this {
    this._actionModel.duration = duration;
    return this.addQualifier(new Qualifier('du', this.parseVal(duration)));
  }

  static fromJson(actionModel: IActionModel): TrimAction {
    const {duration, startOffset, endOffset} = (actionModel as ITrimActionModel);
    // 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();
    if (duration != null){
      result.duration(duration);
    }

    if (startOffset != null){
      result.startOffset(startOffset);
    }

    if (endOffset != null){
      result.endOffset(endOffset);
    }

    return result;
  }
}


/**
 * Helper function that either gets 'auto' or return null
 */
const getAuto = (value: unknown): 'auto' | null => value === 'auto' ? value : null;

export default TrimAction;