• Overview
• Features
• Usage
• Documentation
• Download
• Contact

• Home
• >Documentation
• >Classes
• >Sound

Classes

Sound

Games don't necessarily always need audio; there are many types of simple board and card games, for example, which have no audio at all. On mobile devices it's actually preferable to keep audio to a minimum in order to reduce load times, not to mention the fact that audio support still isn't exactly standardized on all devices. Further still, many users prefer to mute game audio in favor of the their own.

That said, JackyJS leverages the HowlerJS library to bring you cross platform support for your most basic audio needs. You can play multiple sound effects, loop background music, increase/decrease volume, mute/unmute, and save user settings to localStorage. Just remember to keep it simple. ;-)

JackyJS audio needs to be preloaded and assets initialized prior to use. The following example shows you how:

	GAME.initPreload(function(){
		GAME.Preloader.sounds.push('jackyjs/assets/sounds/gling.wav');
		GAME.Preloader.sounds.push('jackyjs/assets/sounds/notify.wav');
		GAME.Preloader.sounds.push('jackyjs/assets/sounds/music.mp3');
	});

	GAME.initAssets(function(){
		GAME.Sound.asset(['gling.wav'], {name:'gling'});
		GAME.Sound.asset(['notify.wav'], {name:'notify'});
		GAME.Sound.asset(['music.mp3','music.ogg'], {
			name: 'music',
			type: 'music',
			loop: true
		});
	});
	
	GAME.initRooms(function(){
		var Level1 = GAME.Room.create({name:'Level1});
		
		Level1.onCreate(function(obj){
			...
		});
		
		Level1.onStart(function(obj){
			GAME.Sound.play('music');
		});
	});

Properties (static)

Methods (static)

• Overview
• Features
• Usage
• Documentation
• Download
• Contact

• Updates
• |
• Terms of Service
• Privacy Policy