Class BasePlayer

Abstract base class for a NoteSequence player based on Tone.js.

Hierarchy

BasePlayer
- Player
- SoundFontPlayer

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BasePlayer(playClick?: boolean, callbackObject?: BasePlayerCallback): BasePlayer

- Defined in core/player.ts:68
BasePlayer constructor.

@param playClick A boolean, determines whether the click will be played. @param callbackObject An optional BasePlayerCallback, specifies an object that contains run() and stop() methods to invode during playback.

Parameters
- Default value playClick: boolean = false
- Optional callbackObject: BasePlayerCallback
Returns BasePlayer

Properties

Protected callbackObject

callbackObject: BasePlayerCallback

Protected currentPart

currentPart: any

Protected playClick

playClick: boolean

Protected scheduledStop

scheduledStop: number

Methods

isPlaying

isPlaying(): boolean

- Defined in core/player.ts:166
Returns boolean

Protected Abstract playNote

playNote(time: number, note: INote): void

- Defined in core/player.ts:68
Parameters
- time: number
- note: INote
Returns void

start

start(seq: INoteSequence, qpm?: number): Promise<void>

- Defined in core/player.ts:117
Starts playing a NoteSequence (either quantized or unquantized), and returns a Promise that resolves when it is done playing.

Parameters
- seq: INoteSequence
  
  The NoteSequence to play.
- Optional qpm: number
  
  (Optional) If specified, will play back at this qpm. If not specified, will use either the qpm specified in the sequence or the default of 120. Only valid for quantized sequences.
Returns Promise<void>

a Promise that resolves when playback is complete.

stop

stop(): void

- Defined in core/player.ts:157
Stop playing the currently playing sequence right away.

Returns void

Generated using TypeDoc