Code Snippet I'd like to share « cocos2d for iPhone

cocos2d for iPhone » Programming » CocosDenshion (sound engine)

Code Snippet I'd like to share

(11 posts) (4 voices)

Started 1 year ago by CraigVella
Latest reply from iJanification

Tags:

Sometime in games if your just using the SimpleAudioEngine it would be nice to just mute SFX or BGM and not everything, And When you mute the BGM, it would be nice to use the End users iPod music. If you want this to be the case and you are using SimpleAudioEngine then this might really help you out ;)

//
//  SimpleAudioEngineExt.h
//  Detonation
//
//  Created by Craig Vella on 6/17/10.
//  Copyright 2010 craigvella. All rights reserved.
//
// Adds Muted Support for SFX & BGMusic w/Ability to play iPod Music when Muted

#import <Foundation/Foundation.h>
#import "SimpleAudioEngine.h"

@interface SimpleAudioEngineExt : SimpleAudioEngine {
	BOOL    muteSFX_;
	BOOL    muteBGMusic_;
}

+ (SimpleAudioEngineExt*) sharedEngine;

@property (readwrite) BOOL muteSFX;
@property (readwrite) BOOL muteBGMusic;

@end

//
//  SimpleAudioEngineExt.m
//  Detonation
//
//  Created by Craig Vella on 6/17/10.
//  Copyright 2010 craigvella. All rights reserved.
//

#import "SimpleAudioEngineExt.h"

@implementation SimpleAudioEngineExt

static SimpleAudioEngineExt *sharedEngine = nil;

+ (SimpleAudioEngineExt *) sharedEngine
{
	@synchronized(self)     {
		if (!sharedEngine)
			sharedEngine = [[SimpleAudioEngineExt alloc] init];
	}
	return sharedEngine;
}

-(id) init {
	if ((self = [super init])) {
		muteSFX_ = NO;
		muteBGMusic_ = NO;
	}
	return self;
}

-(void) playBackgroundMusic:(NSString*) filePath loop:(BOOL) loop
{
	if (!muteBGMusic_)
		[super playBackgroundMusic:filePath loop:loop];
	else
		return;
}

-(ALuint) playEffect:(NSString*) filePath
{
	if (muteSFX_) return 0;
	return [super playEffect:filePath];
}

-(BOOL) muteSFX
{
	return muteSFX_;
}

-(void) setMuteSFX:(BOOL)muteSFX
{
	muteSFX_ = muteSFX;
}

-(BOOL) muteBGMusic
{
	return muteBGMusic_;
}

-(void) setMuteBGMusic:(BOOL)muteBGMusic
{
	muteBGMusic_ = muteBGMusic;
	if (muteBGMusic) {
		if ([self isBackgroundMusicPlaying])
			[self stopBackgroundMusic];
		[[CDAudioManager sharedManager] setMode:kAMM_FxOnly]; // Allow playing of iPod Music
	} else {
		[[CDAudioManager sharedManager] setMode:kAMM_FxPlusMusicIfNoOtherAudio];
	}
}

@end

Posted 1 year ago #

CraigVella
Member

You can just use it like your reg SimpleAudioManager...

Example

[SimpleAudioManagerExt sharedManager].muteSFX = YES; // Mutes Sound Effects
[SimpleAudioManagerExt sharedManager].muteBGMusic = YES; // Mutes Background Music and Allows iPod Player to be used.

Posted 1 year ago #

Steve Oldmeadow
Administrator

Thanks for the code Craig. I don't know if you are using the new version of CocosDenshion but now there is a distinction between muting and enabling audio sources. Mute now means that the audio will continue but it is silenced - like how the ringer switch on the iPhone or the mute switch on a television works. Setting enabled to false causes all current audio to be stopped and prevents any further audio from playing.

If you are wanting to play music using the iPod then it sounds like disabling background music is probably what you want to do.

Posted 1 year ago #
CraigVella
Member

With muteBGMusic, I guess the name of it may be misleading, Basically it stops the backgroundMusic audio from playing and changes the CDAudioManager mode to a mode that allows iPod Music to be played while in Game, just stopping the Background music wont allow (from my experience at least) you to play iPod Music. With this if you enable muteBGMusic -> (in iOS 4) go to your iPod Control, turn some music on, come back in to your game, your music will still be playing. With SimpleAudioManager (the original) if you stopBackgroundMusic -> go to your iPod Control -> come back into game, the music will not be played. Plus the mute that is currently in SimpleAudioManager is a global mute for both your SFX and Music, this will allow a distinction between the two instead of putting it in your game logic.

Posted 1 year ago #
Steve Oldmeadow
Administrator

That is fine, this kind of usage is exactly why I modified CDAudioManager to allow the mode to be changed.

Posted 1 year ago #
CraigVella
Member

Good modification imo :) Should add direct utilization of it in SimpleAudioManager in future release.

Posted 1 year ago #
Steve Oldmeadow
Administrator

A while back I made it safe to access the CDAudioManager shared instance when using SimpleAudioEngine. There is a lot of new functionality where the intention is that the developer will utilise CDAudioManager rather than exposing it at the SimpleAudioEngine level. I'm referring to this as a hybrid approach. I'll be writing some articles about this sort of stuff in the near future.

We get some very inexperienced developers trying to use cocos2d so my intention is to keep SimpleAudioEngine as minimal as possible whilst being useful so we can direct the noobs to it. More advanced developers can dip down into CDAudioManager or roll their own custom audio interfaces as you have done. I'm more than happy for people to share their custom interfaces, I might start a sub directory in CocosDenshion if we get any more. SimpleAudioEngine itself started as a custom interface that Joao Caxaria built on top of my CDSoundEngine before CDAudioManager even existed.

Posted 1 year ago #
camsauce
Member

Thanks for the code Craig! Just the thing I was looking for.

Posted 1 year ago #
camsauce
Member

Just getting around to implementing this in my project. Can you elaborate on how you defined the SimpleAudioManagerExt in the class/implementation? I'm getting errors that muteSFX and muteBGMusic aren't members.

Posted 1 year ago #
Steve Oldmeadow
Administrator
If you want to control enabling/disabling effects and background music separately you can use code like below. Things like stopping the background music and not playing sound when disabled are already handled by CocosDenshion there is no need to code it yourself as in the example above.
```
[[CDAudioManager sharedManager].soundEngine setEnabled:NO];
[[CDAudioManager sharedManager].backgroundMusic setEnabled:NO];
```
You can also leave the mode as kAMM_FxPlusMusicIfNoOtherAudio, Craig wrote this code before I did all the work to support fast task switching to the iPod app in iOS 4.0.
Posted 1 year ago #
iJanification
Member

Hi all,

I was reading your comments and now I'm a bit confused. I use the latest version of cocos2d and cocosdension. I would like to use SimpleAudioPlayer for playing FX sounds and MPMusicPlayerController for playing iPod Background Music.. What is the best approach for getting this?

Thanks in advance..

Jan

Posted 8 months ago #

RSS feed for this topic

Reply

You must log in to post.