m8-js/lib/types/internal/MIDICC.js

Library for loading and interacting with Dirtywave M8 instrument/song files.

/* Copyright 2023 Jeremy Whitlock
 *
 * Licensed under the Apache License, Version 2.0 (the 'License');
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an 'AS IS' BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

const Serializable = require('./Serializable')

/**
 * Represents a MIDI CC.
 *
 * @class
 *
 * @augments module:m8-js/lib/types/internal.Serializable
 * @memberof module:m8-js/lib/types/internal
 */
class MIDICC extends Serializable {
  /** @member {Number} */
  number
  /** @member {Number} */
  defaultValue

  /**
   * Creates an MIDI CC.
   *
   * @param {Number} [defaultValue=0xFF]
   * @param {Number} [number=0xFF]
   */
  constructor (defaultValue = 0xFF, number = 0xFF) {
    super()

    this.defaultValue = defaultValue
    this.number = number
  }

  /**
   * @inheritdoc
   */
  asObject () {
    return {
      defaultValue: this.defaultValue,
      number: this.number
    }
  }

  /**
   * @inheritdoc
   */
  static fromObject (object) {
    return new MIDICC(object?.defaultValue, object?.number)
  }

  /**
   * @inheritdoc
   */
  static getObjectProperties () {
    return ['defaultValue', 'number']
  }
}

module.exports = MIDICC