[]Jimmy's World.org
Because you all make me very, very tired.
[]
Jimmy's World Games
Not a Member? - Login or Create an Account
[] Tuesday the 6th of January 2009 @ 03:21am
News Journal Creative Writing Projects Your JW About

LibN2L-4 Library Code Reference

Classes
Compounds
Files
Members
Method Index
Full Reference

n2l::cAudioChunk Class Reference

A class representing an audio sample. More...

#include <cAudioChunk.h>

Collaboration diagram for n2l::cAudioChunk:

Collaboration graph
[legend]
List of all members.

Public Member Functions


Detailed Description

A class representing an audio sample.

Definition at line 44 of file cAudioChunk.h.


Constructor & Destructor Documentation

n2l::cAudioChunk::cAudioChunk  ) 
 

Definition at line 36 of file cAudioChunk.cpp.

n2l::cAudioChunk::cAudioChunk const cVfsNodeInterface iFile  ) 
 

Definition at line 43 of file cAudioChunk.cpp.

References load().

n2l::cAudioChunk::~cAudioChunk  ) 
 

Definition at line 51 of file cAudioChunk.cpp.


Member Function Documentation

void n2l::cAudioChunk::free  ) 
 

Definition at line 86 of file cAudioChunk.cpp.

Referenced by load().

const tUint n2l::cAudioChunk::length  )  const
 

Return the length of the sample in milliseconds.

Definition at line 92 of file cAudioChunk.cpp.

References n2l::cAudioMixer::inited().

void n2l::cAudioChunk::load const cVfsNodeInterface iFile  ) 
 

Definition at line 57 of file cAudioChunk.cpp.

References n2l::cAudioMixer::Channels_Stereo, free(), n2l::cAudioMixer::frequency(), n2l::cVfsNodeInterface::getRWops(), n2l::cAudioMixer::inited(), n2l::cVfsNodeInterface::likeFile(), n2l::cVfsNodeInterface::name(), n2l::cAudioMixer::sampleSize(), and n2l::cAudioMixer::soundChannels().

Referenced by cAudioChunk().

const tAudioChannel n2l::cAudioChunk::play const tFloat iLRBias,
const tFloat iVol,
const tAudioChannel  iChannel = Audio_AnyFreeChannel
const
 

Definition at line 157 of file cAudioChunk.cpp.

References n2l::cAudioMixer::inited(), n2l::n2lMax(), and n2l::n2lMin().

const tAudioChannel n2l::cAudioChunk::play const tAudioVolume  iLeft,
const tAudioVolume  iRight,
const tAudioChannel  iChannel = Audio_AnyFreeChannel
const
 

Play on a specific channel, with the provided properties.

Definition at line 135 of file cAudioChunk.cpp.

References n2l::cAudioMixer::inited().

const tAudioChannel n2l::cAudioChunk::play const tBool  iLoop = false  )  const
 

Simply play the requested chunk on the first available channel from the mixer.

Definition at line 118 of file cAudioChunk.cpp.

References n2l::cAudioMixer::inited().

const tAudioChannel n2l::cAudioChunk::playAtPos const tFloat iDeg,
const tFloat iDist,
const tAudioChannel  iChannel = Audio_AnyFreeChannel
const
 

Definition at line 186 of file cAudioChunk.cpp.

References n2l::cAudioMixer::inited(), and n2l::n2lMin().

const tUint n2l::cAudioChunk::size  )  const
 

Return the size of the sample in bytes.

Note:
The size returned is after resampling to the selected output format not the size of the original sample.

Definition at line 105 of file cAudioChunk.cpp.

References n2l::cAudioMixer::inited().


The documentation for this class was generated from the following files:
©2009 Aaron Cameron
Benchmarks