Sounds are defined in config/sounds.js file.
Example of a sound definition:
bcsound = new Object(); bcsound.id = 1; bcsound.name = "Smile"; bcsound.alt1 = ":-)"; bcsound.alt2 = ":)"; bcsound.alt3 = "";
bcsound.iconClass = "bcSoundMessage";
bcsound.ogg = "";
bcsound.mp3 = "/components/com_blastchatconfig/config/sounds/msg.mp3";
bcsound.wav = "/components/com_blastchatconfig/config/sounds/msg.wav";
bcDataConfig.sounds.sounds.push(bcsound);
You should copy this code for each sound you would like to create. There are 3 alternatives "ogg", "mp3" and "wav" for the file type because different browsers support different sound file types. You can read more about it at HTML5 Audio.
Parameter name
|
Default value
|
Type
|
bcsound.id (mandatory) | Number | |
Identification number of the sound (must be unique value in your system) |
||
bcsound.name | "" | String |
Sound name (presented as a tooltip) |
||
bcsound.alt1 | "" | String |
First string alternative to look for in the message, that should be mapped to this sound |
||
bcsound.alt2 | "" | Boolean |
Second string alternative to look for in the message, that should be mapped to this sound |
||
bcsound.alt3 | "" | String |
Third string alternative to look for in the message, that should be mapped to this sound |
||
bcsound.iconClass | "" | String |
icon class |
||
bcsound.ogg | "" | String |
File location of the "ogg" file type alternative for this sound definition |
||
bcsound.mp3 | "" | String |
File location of the "mp3" file type alternative for this sound definition |
||
bcsound.wav | "" | String |
File location of the "wav" file type alternative for this sound definition |
Sound groups are defined in config/emoticons.js file.
Example of a sound group definition:
bcsoundgroup = new Object(); bcsoundgroup.id = 1; bcsoundgroup.sounds = [1,2]; bcDataConfig.sounds.groups.push(bcsoundgroup);
You should copy this code for each emoticon group you would like to create.
Parameter name
|
Default value
|
Type
|
bcsoundgroup.id (mandatory) | Number | |
Identification number of the sound group (must be unique value in your system) |
||
bcsoundgroup.sounds | "" | Array |
Array of comma separated sound identification numbers that belong to this sound group |