OOMusic Class Reference

#include <OOALMusic.h>

Inheritance diagram for OOMusic:

Collaboration diagram for OOMusic:

Instance Methods
(void)	- playLooped:
(void)	- stop
(BOOL)	- isPlaying
(void)	- setMusicGain:
(float)	- musicGain
(OOSoundSource *)	- musicSoundSource
(void)	- dealloc [implementation]
(id)	- initWithContentsOfFile: [implementation]
(NSString *)	- name [implementation]
Instance Methods inherited from OOSound
(ALuint)	- soundBuffer
(BOOL)	- soundIncomplete
(void)	- rewind
(id)	- init [implementation]
(id)	- initWithDecoder: [implementation]
(id)	- initWithCustomSoundKey:
(jsval)	- oo_jsValueInContext: [implementation]
(NSString *)	- oo_jsDescription [implementation]
(NSString *)	- oo_jsClassName [implementation]

Class Methods
(id)	+ allocWithZone: [implementation]
Class Methods inherited from OOSound
(BOOL)	+ setUp
(void)	+ update
(void)	+ setMasterVolume:
(float)	+ masterVolume
(BOOL)	+ isSoundOK
(id)	+ soundWithCustomSoundKey:

Private Attributes
OOSound *	sound

Detailed Description

Definition at line 37 of file OOALMusic.h.

Method Documentation

allocWithZone:

+ (id) allocWithZone: (NSZone *) inZone

implementation

Definition at line 32 of file OOALMusic.m.

                   :(NSZone *)inZone
{
    return NSAllocateObject([OOMusic class], 0, inZone);
}

dealloc

- (void) dealloc

implementation

Definition at line 32 of file OOALMusic.m.

{
    if (sPlayingMusic == self) [self stop];
    [sound release];
    
    [super dealloc];
}

initWithContentsOfFile:

- (id) initWithContentsOfFile: (NSString *) inPath

implementation

Reimplemented from OOSound.

Definition at line 32 of file OOALMusic.m.

                            :(NSString *)inPath
{
    self = [super init];
    if (nil != self)
    {
        sound = [[OOSound alloc] initWithContentsOfFile:inPath];
        if (nil == sound)
        {
            [self release];
            self = nil;
        }
    }
    
    return self;
}

isPlaying

- (BOOL) isPlaying

Definition at line 32 of file OOALMusic.m.

{
    return sPlayingMusic == self && [sMusicSource isPlaying];
}

musicGain

- (float) musicGain

Definition at line 32 of file OOALMusic.m.

{
    if (nil == sMusicSource)  return 0.0f;
    return [sMusicSource gain];
}

musicSoundSource

- (OOSoundSource *) musicSoundSource

Definition at line 32 of file OOALMusic.m.

{
    return sMusicSource;
}

name

- (NSString *) name

implementation

Reimplemented from OOSound.

Definition at line 32 of file OOALMusic.m.

{
    return [sound name];
}

playLooped:

- (void) playLooped:

(BOOL)

looped

Definition at line 32 of file OOALMusic.m.

                  :(BOOL)inLoop
{
    if (sPlayingMusic != self)
    {
        if (nil == sMusicSource)
        {
            sMusicSource = [[OOSoundSource alloc] init];
        }
        [sMusicSource stop];
        [sMusicSource setLoop:inLoop];
        [sMusicSource setSound:sound];
        [sMusicSource play];
        
        sPlayingMusic = self;
    }
}

setMusicGain:

- (void) setMusicGain:

(float)

newValue

Definition at line 32 of file OOALMusic.m.

                    :(float)newValue
{
    if (nil != sMusicSource)
    {
        [sMusicSource setGain:newValue];
    }
}

stop

- (void) stop

Definition at line 32 of file OOALMusic.m.

{
    if (sPlayingMusic == self)
    {
        sPlayingMusic = nil;
        [sMusicSource stop];
        [sMusicSource setSound:nil];
    }
}

Member Data Documentation

sound

- (OOSound*) sound

private

Definition at line 40 of file OOALMusic.h.

---

The documentation for this class was generated from the following files:

• src/Core/OOALMusic.h
• src/Core/OOALMusic.m