Sound Struct Reference

Sound loading and playback. More...

#include <Sound.h>

Inheritance diagram for Sound:

Public Member Functions
Class *	_Sound (void)
	The Sound archetype. More...
Sound *	initWithBytes (Sound *self, const uint8_t *bytes, size_t length)
	Initializes this Sound with the specified bytes. More...
Sound *	initWithChunk (Sound *, const Chunk *)
	Initializes this Sound with the given audio chunk. More...
Sound *	initWithData (Sound *, Data *)
Sound *	initWithData (Sound *self, const Data *data)
	Initializes this Sound with the specified Data. More...
Sound *	initWithResource (Sound *, const Resource *)
	Initializes this Sound with the specified Resource. More...
Sound *	initWithResourceName (Sound *, const char *)
	Initializes this Sound with the specified Resource name. More...
Sound *	soundWithBytes (const uint8_t *bytes, size_t length)
	Instantiates an Sound with the specified bytes. More...
Sound *	soundWithChunk (Mix_Chunk *chunk)
	Instantiates an Sound with the specified chunk. More...
Sound *	soundWithData (const Data *data)
	Instantiates an Sound with the specified Data. More...
Sound *	soundWithResource (const Resource *resource)
	Instantiates an Sound with the specified Resource. More...
Sound *	soundWithResourceName (const char *name)
	Instantiates an Sound with the specified Resource name. More...

Data Fields
Mix_Chunk *	chunk
	The backing audio chunk. More...
Object	object
	The superclass. More...

Protected Attributes
SoundInterface *	interface
	The interface. More...

Detailed Description

Sound loading and playback.

Definition at line 45 of file Sound.h.

Member Function Documentation

_Sound()

Class * _Sound

(

void

)

The Sound archetype.

Returns

The Sound Class.

Definition at line 190 of file Sound.c.

                    {
    static Class *clazz;
    static Once once;
 
    do_once(&once, {
        clazz = _initialize(&(const ClassDef) {
            .name = "Sound",
            .superclass = _Object(),
            .instanceSize = sizeof(Sound),
            .interfaceOffset = offsetof(Sound, interface),
            .interfaceSize = sizeof(SoundInterface),
            .initialize = initialize,
        });
    });
 
    return clazz;
}

initWithBytes()

Sound * initWithBytes	(	Sound *	self,
		const uint8_t *	bytes,
		size_t	length
	)

Initializes this Sound with the specified bytes.

Parameters

self	The Sound.
bytes	The encoded sound data.
length	The length of bytes.

Returns

The new Sound, or NULL on error.

Definition at line 52 of file Sound.c.

                                                                              {
 
    SDL_RWops *src = SDL_RWFromConstMem(bytes, (int) length);
    if (src) {
        self = $(self, initWithChunk, Mix_LoadWAV_RW(src, 1));
    } else {
        self = release(self);
    }
 
    return self;
}

initWithChunk()

Sound * initWithChunk	(	Sound *	self,
		const Chunk *	chunk
	)

Initializes this Sound with the given audio chunk.

Parameters

self	The Sound.
chunk	The backing chunk.

Returns

The new Sound, or NULL on error.

Remarks

Designated initializer.

initWithData() [1/2]

Sound * initWithData	(	Sound *	,
		Data *
	)

initWithData() [2/2]

Sound * initWithData	(	Sound *	self,
		const Data *	data
	)

Initializes this Sound with the specified Data.

Parameters

self	The Sound.
data	The Data providing encoded audio data.

Returns

The initialized Sound, or NULL on error.

Definition at line 68 of file Sound.c.

                                                          {
 
    if (data) {
        self = $(self, initWithBytes, data->bytes, data->length);
    } else {
        self = release(self);
    }
 
    return self;
}

initWithResource()

Sound * initWithResource	(	Sound *	self,
		const Resource *	resource
	)

Initializes this Sound with the specified Resource.

Parameters

self	The Sound.
resource	The Resource providing encoded audio data.

Returns

The initialized Sound, or NULL on error.

Definition at line 98 of file Sound.c.

                                                                      {
 
    if (resource) {
        self = $(self, initWithData, resource->data);
    } else {
        self = release(self);
    }
 
    return self;
}

initWithResourceName()

Sound * initWithResourceName	(	Sound *	self,
		const char *	name
	)

Initializes this Sound with the specified Resource name.

Parameters

self	The Sound.
name	The name of the Resource providing encoded audio data.

Returns

The initialized Sound, or NULL on error.

Definition at line 113 of file Sound.c.

                                                                  {
 
    Resource *resource = $$(Resource, resourceWithName, name);
 
    self = $(self, initWithResource, resource);
 
    release(resource);
 
    return self;
}

soundWithBytes()

Sound * soundWithBytes	(	const uint8_t *	bytes,
		size_t	length
	)

Instantiates an Sound with the specified bytes.

Parameters

bytes	The encoded sound bytes.
length	The length of bytes.

Returns

The new Sound, or NULL on error.

Definition at line 128 of file Sound.c.

                                                                  {
    return $(alloc(Sound), initWithBytes, bytes, length);
}

soundWithChunk()

Sound * soundWithChunk

(

Mix_Chunk *

chunk

)

Instantiates an Sound with the specified chunk.

Parameters

chunk

The chunk.

Returns

The new Sound, or NULL on error.

Definition at line 136 of file Sound.c.

                                               {
    return $(alloc(Sound), initWithChunk, chunk);
}

soundWithData()

Sound * soundWithData

(

const Data *

data

)

Instantiates an Sound with the specified Data.

Parameters

data	The encoded sound Data.

Returns

The new Sound, or NULL on error.

Definition at line 144 of file Sound.c.

                                              {
    return $(alloc(Sound), initWithData, data);
}

soundWithResource()

Sound * soundWithResource

(

const Resource *

resource

)

Instantiates an Sound with the specified Resource.

Parameters

resource

The Resource containing encoded sound data.

Returns

The new Sound, or NULL on error.

Definition at line 152 of file Sound.c.

                                                          {
    return $(alloc(Sound), initWithResource, resource);
}

soundWithResourceName()

Sound * soundWithResourceName

(

const char *

name

)

Instantiates an Sound with the specified Resource name.

Parameters

name	The name of a Resource containing encoded sound data.

Returns

The new Sound, or NULL on error.

Definition at line 160 of file Sound.c.

                                                      {
    return $(alloc(Sound), initWithResourceName, name);
}

Field Documentation

chunk

Mix_Chunk* Sound::chunk

The backing audio chunk.

Definition at line 61 of file Sound.h.

interface

SoundInterface* Sound::interface

protected

The interface.

Definition at line 56 of file Sound.h.

object

Object Sound::object

The superclass.

Definition at line 50 of file Sound.h.

---

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

• Sources/ObjectivelyMVC/Sound.h
• Sources/ObjectivelyMVC/Sound.c