If you find some bugs or missing functional in plugins, use Issues page on GitHub
Today websites are full of events (new mail, new chat-message, content update etc.). Often it is not enough to indicate this events only visually to get user attention. You need sounds! This library, made for playing small sounds, will help you with this task.
Also, new version of Ion.Sound is capable to handle browser games audio. It has full control of loading, playing and removing audio files. And audio-sprites support of course.
Try it:
Can i use Web Audio API and HTML5 Audio?
It is not enough to have only MP3-file, you should make OGG and AAC-file too, because not all browsers support MP3.
You can easily convert you MP3-s to OGG-s and AAC-s at Media.io or at CloudConvert.org.
AAC support was added to improve cross browser support of iOS 8.x devices (iPhone, iPad)
To initialise plugin call this method:
ion.sound({ sounds: [ { name: "my_cool_sound" }, { name: "notify_sound", volume: 0.2 }, { name: "alert_sound", volume: 0.3, preload: false } ], volume: 0.5, path: "sounds/", preload: true });
And play sound!
// Simple ion.sound.play("my_cool_sound");
If your are new person in web development
and you are not sure how to correctly install the plugin to your web-page, please download
this demo example
Option | Defaults | Type | Description |
---|---|---|---|
sounds | - | array | Collection of sound objects. Each object contains information about sound file and (optional) individual settings |
path | - | string | Path to file |
preload | false | boolean | Preloading sounds |
multiplay | false | boolean | Sound multi play. If set, will allow to play multiple instances of one sound at once |
loop | false | boolean/number | If set to true will enable infinite loop. Or paste a number to set loop limit |
volume | 1.0 | number | Playback volume from 0 to 1 |
scope | null | object | Callbacks will be called in that object's scope |
ready_callback | null | function | Called after sound file is fully uploaded (or ready to play for HTML5 audio) |
ended_callback | null | function | Called each time then sound file will reach it's end |
Option | Defaults | Type | Description |
---|---|---|---|
name | - | string | File name. Plugin will choose file extension automatically (.mp3, .ogg, .aac, .mp4 and etc.) |
alias | - | string | Alias for sound call, optional. Normally is used to shorten ion.sound calls |
sprite | - | object |
Mark that sound is audio-sprite.
This is an object. Example: {"part_name_1": [0, 2], "part_name_2": [2, 2]} Part_name is a name of sprite piece (it is used instead of name to play a sound). And array with time marks: [start, duration] in seconds. |
And also individual: path, preload, multiplay, loop, volume, scope and callbacks |