OOSound Class Reference

#include <OOALSound.h>

Inheritance diagram for OOSound:

Collaboration diagram for OOSound:

Instance Methods
(id)	- initWithContentsOfFile:
(NSString *)	- name
(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
(BOOL)	+ setUp
(void)	+ update
(void)	+ setMasterVolume:
(float)	+ masterVolume
(BOOL)	+ isSoundOK
(id)	+ soundWithCustomSoundKey:

Detailed Description

Definition at line 30 of file OOALSound.h.

Method Documentation

init

- (id) init

implementation

Definition at line 42 of file OOALSound.m.

{
    if (!sIsSetUp)  [OOSound setUp];
    return [super init];
}

References nil, setMasterVolume:, OOOpenALController::sharedController, sIsSetUp, and sIsSoundOK.

Here is the call graph for this function:

initWithContentsOfFile:

- (id) initWithContentsOfFile:

(NSString *)

path

Reimplemented in OOMusic.

Definition at line 42 of file OOALSound.m.

                             :(NSString *)path
{
    if (!sIsSoundOK)  return nil;
    
    [self release];
    if (!sIsSetUp && ![OOSound setUp])  return nil;
 
    OOALSoundDecoder        *decoder;
 
    decoder = [[OOALSoundDecoder alloc] initWithPath:path];
    if (nil == decoder) return nil;
    
    if ([decoder sizeAsBuffer] <= kMaxBufferedSoundSize)
    {
        self = [[OOALBufferedSound alloc] initWithDecoder:decoder];
    }
    else
    {
        self = [[OOALStreamedSound alloc] initWithDecoder:decoder];
    }
    [decoder release];
    
    if (nil != self)
    {
        #ifndef NDEBUG
            OOLog(kOOLogSoundLoadingSuccess, @"Loaded sound %@", path);
        #endif
    }
    else
    {
        OOLog(kOOLogSoundLoadingError, @"Failed to load sound \"%@\"", path);
    }
    
    return self;
 
 
}

initWithCustomSoundKey:

- (id) initWithCustomSoundKey:

(NSString *)

key

Provided by category OOSound(OOCustomSounds).

Definition at line 10753 of file Universe.m.

                             :(NSString *)key
{
    [self release];
    return [[OOSound soundWithCustomSoundKey:key] retain];
}

initWithDecoder:

- (id) initWithDecoder: (OOALSoundDecoder *)  inDecoder

implementation

Reimplemented in OOALBufferedSound, and OOALStreamedSound.

Definition at line 42 of file OOALSound.m.

                     :(OOALSoundDecoder *)inDecoder
{
    [self release];
    return nil;
}

isSoundOK

+ (BOOL) isSoundOK

Definition at line 42 of file OOALSound.m.

{
  return sIsSoundOK;
}

masterVolume

+ (float) masterVolume

Definition at line 42 of file OOALSound.m.

{
    if (!sIsSetUp && ![self setUp] )
        return 0.0;
 
    OOOpenALController *controller = [OOOpenALController sharedController];
    return [controller masterVolume];
}

name

- (NSString *) name

Reimplemented in OOALBufferedSound, OOMusic, and OOALStreamedSound.

Definition at line 42 of file OOALSound.m.

{
    OOLogGenericSubclassResponsibility();
    return @"";
}

oo_jsClassName

- (NSString *) oo_jsClassName

implementation

Provided by category OOSound(OOJavaScriptExtentions).

Definition at line 257 of file OOJSSound.m.

{
    return @"Sound";
}

oo_jsDescription

- (NSString *) oo_jsDescription

implementation

Provided by category OOSound(OOJavaScriptExtentions).

Definition at line 257 of file OOJSSound.m.

{
    return [NSString stringWithFormat:@"[Sound \"%@\"]", [self name]];
}

oo_jsValueInContext:

- (jsval) oo_jsValueInContext: (JSContext *)  context

implementation

Provided by category OOSound(OOJavaScriptExtentions).

Definition at line 257 of file OOJSSound.m.

                             :(JSContext *)context
{
    JSObject                    *jsSelf = NULL;
    jsval                       result = JSVAL_NULL;
    
    jsSelf = JS_NewObject(context, &sSoundClass, sSoundPrototype, NULL);
    if (jsSelf != NULL)
    {
        if (!JS_SetPrivate(context, jsSelf, [self retain]))  jsSelf = NULL;
    }
    if (jsSelf != NULL)  result = OBJECT_TO_JSVAL(jsSelf);
    
    return result;
}

rewind

- (void) rewind

Reimplemented in OOALStreamedSound.

Definition at line 42 of file OOALSound.m.

{
    // doesn't need to do anything on seekable FDs
}

setMasterVolume:

+ (void) setMasterVolume:

(float)

fraction

Definition at line 42 of file OOALSound.m.

                        :(float) fraction
{
    if (!sIsSetUp && ![self setUp])
        return;
    
    fraction = OOClamp_0_1_f(fraction);
 
    OOOpenALController *controller = [OOOpenALController sharedController];
    if (fraction != [controller masterVolume])
    {
        [controller setMasterVolume:fraction];
        [[NSUserDefaults standardUserDefaults] setFloat:[controller masterVolume] forKey:KEY_VOLUME_CONTROL];
    }
}

Referenced by init.

Here is the caller graph for this function:

setUp

+ (BOOL) setUp

Definition at line 42 of file OOALSound.m.

{
    if (!sIsSetUp)
    {
        sIsSetUp = YES;
        OOOpenALController* controller = [OOOpenALController sharedController];
        if (controller != nil)
        {
            sIsSoundOK = YES;
            float volume = [[NSUserDefaults standardUserDefaults] oo_floatForKey:KEY_VOLUME_CONTROL defaultValue:0.5];
            [self setMasterVolume:volume];
        }
    }
    
    return sIsSoundOK;
}

soundBuffer

- (ALuint) soundBuffer

Reimplemented in OOALBufferedSound, and OOALStreamedSound.

Definition at line 42 of file OOALSound.m.

{
    OOLogGenericSubclassResponsibility();
    return 0;
}

soundIncomplete

- (BOOL) soundIncomplete

Reimplemented in OOALStreamedSound.

Definition at line 42 of file OOALSound.m.

{
    return NO;
}

soundWithCustomSoundKey:

+ (id) soundWithCustomSoundKey:

(NSString *)

key

Provided by category OOSound(OOCustomSounds).

Definition at line 10753 of file Universe.m.

                              :(NSString *)key
{
    NSString *fileName = [UNIVERSE soundNameForCustomSoundKey:key];
    if (fileName == nil)  return nil;
    return [ResourceManager ooSoundNamed:fileName inFolder:@"Sounds"];
}

Referenced by GetNamedSound().

Here is the caller graph for this function:

update

+ (void) update

Definition at line 42 of file OOALSound.m.

{
    OOSoundMixer * mixer = [OOSoundMixer sharedMixer];
    if( sIsSoundOK && mixer)
        [mixer update];
}

---

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

• src/Core/OOALSound.h
• src/Core/OOALSound.m