LoadSoundFromRawMemory method

LoadSoundFromRawMemory method

Remarks

Loads a sound file in RAW format stored inside a memory buffer.

A successful call to this method will fire the SoundLoaded event.

IMPORTANT TOPIC: remember that the memory buffer containing song data must not be moved by the garbage collector and needs to be available till the call to the CloseSound method.

Syntax

[Visual Basic]

control.LoadSoundFromRawMemory (

nPlayer as Integer,

pBuffer as Variant,

nBufferLen as Long,

nEncodeMode as enumRAWEncodeModes,

bIsBigEndian as enumBoolean,

nFrequency as Long,

nChannels as Long

) as enumErrorCodes

[C++]

short control.LoadSoundFromRawMemory (

short nPlayer,

const VARIANT FAR& pBuffer,

long nBufferLen,

short nEncodeMode,

short bIsBigEndian,

long nFrequency,

long nChannels

);

Parameter	Description

nPlayer	Number representing the zero-based index of the player that will load the memory sound
pBuffer	Variant parameter containing the pointer to sound data previously loaded in memory.
nBufferLen	Length in bytes of the given buffer

nEncodeMode

Encode mode used to encode the RAW file.

Supported values are the following:

Mnemonic constant	Numeric value	Meaning
RAW_ENCODE_PCM_U8	0	RAW PCM 8 bits Unsigned
RAW_ENCODE_PCM_S8	1	RAW PCM 8 bits Signed
RAW_ENCODE_PCM_S16	2	RAW PCM 16 bits Signed
RAW_ENCODE_PCM_S24	3	RAW PCM 24 bits Signed
RAW_ENCODE_PCM_S32	4	RAW PCM 32 bits Signed
RAW_ENCODE_FLOAT32	5	RAW 32 bits floating point
RAW_ENCODE_G711_ULAW	6	RAW G711 U-LAW
RAW_ENCODE_G711_ALAW	7	RAW G711 A-LAW
RAW_ENCODE_GSM_610	8	RAW GSM 6.10
RAW_ENCODE_DIALOGIC_VOX	9	RAW Dialogic ADPCM VOX

bIsBigEndian

Boolean flag that tells if bits order inside the RAW file are little-endian or big-endian

Supported values are the following:

Mnemonic Value	Meaning
BOOL_FALSE	The RAW file is encoded using little-endian
BOOL_TRUE	The RAW file is encoded using big-endian

nFrequency

Sample rate of the RAW file (e.g. 44100)

nChannels

Number of channels of the RAW file: 1 for Mono or 2 for Stereo

Return value

Value	Meaning

Negative value	An error occurred (see the LastError property for further error details)
enumErrorCodes.NOERROR (0)	The file has been loaded correctly.