cw-trainer

CWPlayer

Demonstrations and samples here

Usage

import morseplayer.js (in head or body)

<script src="morseplayer.js"></script>

Instantiate the player :

var player = new CWPlayer({wpm:25});
// can't call play() for the first time directly from onload or arbitrary code : this must be done on a user gesture (https://developer.chrome.com/blog/autoplay/#web_audio)
//player.play('Hello world !');

⚠ : as stated above, the first call to a playing method (such as play or setting AutoPlay attribute to true) must be initiated from a user gesture on the page (explanation). Subsequent calls can be done without condition

Then try it :

<a href="#" onclick="player.play('Hello world !')">click me!</a>

CWPlayer instance’s properties

• Playing : the player is currently playing
• Paused : the player is currently paused
• WPM : get or set the WPM
• EffWPM : get or set the Effective WPM (see Learning Methods and Farnsworth speed)
• EWS : get or set Extra Word Space
• Tone : get or set tone’s frequency
• Volume : get or set volume
• KeyingQuality : get or set the keying quality (between 50% : bad and 100% : perfect)
• PreDelay : get or set the delay before playing firs symbol
• Text : get or set the text to play. Text is “cleaned” :

  player.Text = "StrÀngé ïnpùt tèxt";
  console.log(player.Text);
  // 'STRANGE INPUT TEXT'
  

  Prosigns can be entered between { and } and will be played as prosigns :

  player.Text = "VE3YYY de F8XXX {AS}";
  

• TextArray : get an array of the current text, including prosigns. Each element is either a letter/number/punctuation or a prosign.
• Index : get or set the playing’s index (in the TextArray property !)
• AutoPlay : set to true automatically starts playing when Text changes
• HPFix : set it to true if you experience truncation of symbols while using USB/Bluetooth headphones on Android devices

Methods

constructor(options)

The CWPlayer constructor accepts options as an Object in which keys can be :

• wpm (default to 20 wpm) : the speed in words per minute
• effwpm (default to 20 wpm) : the effective speed in words per minute (see Learning Methods and Farnsworth speed)

  Note: When WPM is lower than Effective WPM, the latest value is used for both

• ews (default to 0 s) : Extra Word Space, a space in seconds added to the normal space between words
• tone (default to 800Hz) : the tonality
• volume (default to 1) : the volume (from 0 to 1)
• keyingquality : get or set the keying quality (between 50% : bad and 100% : perfect)
• predelay (default to 0 s) : a time in seconds before playing the first symbol
• autoplay (default to false) : if set to “true”, a change in the text automatically starts playing
• hpfix (default to false) : set it to true if you experience truncation of symbols while using USB/Bluetooth headphones on Android devices

async play(text)

play method start the morse playing of the text. The text can be passed as parameter otherwise Text property will be used. Text is cleaned. The method returns a promise wich is fulfilled at the first pause or at the end of the playing.

await player.play('test');
await player.play('this text is read after the first has finished');

async renderToFile(text)

renderToFile method render the morse representation of the text and save it to a .wav file. The text can be passed as parameter otherwise Text property will be used. Text is cleaned. The method returns a promise wich is fulfilled at the end of the conversion to .wav file.

await player.renderToFile();

pause()

stops the playing

stop()

stops the playing and reset the current playing time

playBoop()

play a ‘boop’ sound (used for wrong entry in simple mode)

addEventListener(event_name, func)

Register an event listener

player.addEventListener('play', () => {
    console.log('CW Time !');
});
player.addEventListener('parameterchanged', (param) => {
    console.log(`"${param}" changed to ${player[param]}`);
});

Supported events

• parameterchanged : one of the properties of the player has changed. The parameter’s name is passed as argument with the event.
• indexchanged : the current index in the input text changed. Warning the index reference the Text property, which is cleaned (and thus can be different from original provided text)
• play : playing has started or been resumed from pause
• pause : playing has been temporarily stopped
• stop : playing has been definitely stopped
• recording : recording to wave has started. stop is triggered once finished

on(event_name, func)

Register an event listener, triggered only once

player.on('play', () => {
    // this message will appear only once even if play is called multiple times
    console.log('CW Time !');
});

removeEventListener(event_name, func?) / removeEventListener(func)

Remove the event listener. If no func is provided, remove all the listeners. If only func is provided, remove this listener from all events.

static translate(text)

Translate to Morse the specified text :

let translated = CWPlayer.translate("Bonjour");
console.log(translated);
// '-... --- -. .--- --- ..- .-.'

// Prosigns
translated = CWPlayer.translate('{AS}');
console.log(translated);
// '.-...'

static cleanText(text)

Used to clean the provided text.

let cleaned = CWPlayer.cleanText("StrÀngé ïnpùt tèxt");
console.log(cleaned);
// 'STRANGE INPUT TEXT'

This site is open source. Improve this page.