A Blockly audio player field.
Audio player capabilities right from the Google Blockly Field.
- Interactive audio visualization using Web Audio and Canvas based on wavesurfer.js
- Public API:
load()
,unload()
,play()
,pause()
,stop()
- Player state change events
- Audio source cache
- Audio source autoload
- XHR fetch with credentials
- Color scheme configuration
npm install --save blockly-field-player
yarn add blockly-field-player
npm run build
or
yarn build
import * as Blockly from 'blockly'
import {FieldPlayer} from 'blockly-field-player'
Blockly.Blocks['test_field'] = {
init: function () {
this.appendDummyInput()
.appendField(new FieldPlayer('http://localhost/test.mp3'), 'FIELDNAME')
}
};
import * as Blockly from 'blockly'
import 'blockly-field-text-box'
Blockly.defineBlocksWithJsonArray([
{
"type": "test_field",
"message0": "%1",
"args0": [
{
"type": "field_player",
"name": "FIELDNAME",
"src": "http://localhost/test.mp3"
}
]
}])
<script src="./dist/index.js"></script>
note: you need to build the package first.
You can provide options object:
Blockly.defineBlocksWithJsonArray([
{
"type": "test_field",
"message0": "%1",
"args0": [
{
"type": "field_player",
"name": "FIELDNAME",
"src": "http://localhost/test.mp3",
"options": {
primaryColor: '#DEA922',
secondaryColor: '#E2D0A7',
backgroundColor: '#FCF3D8'
}
}
]
}])
- primaryColor
- secondaryColor
- backgroundColor
- autoLoad (see notes about Autoload option)
You can listen for various of player state events, such as:
notloaded
readytoload
unloaded
loading
loaded
playing
paused
error
Just subscribe to state events from the player instance:
Blockly.Blocks['test_field'] = {
init: function () {
const player = new FieldPlayer('http://localhost/test.mp3')
player.on('state', state => console.debug(state))
this.appendDummyInput().appendField(player, 'FIELDNAME')
}
};
By default, even if media source is provided, player will not load it automatically. If you want to change this behaviour and load media to cache during field render, set autoLoad option to true.
const player = new FieldPlayer('http://localhost/test.mp3', { autoLoad: true })
Apache 2.0