Classes > SoundComposerMan class > Methods > SoundComposer.ItemSoundFileRawInfoGet method

Remarks

Adds a sound file, or a given range within the sound file, containing RAW audio data to the audio stream previously created through the SoundComposer.SessionCreate method.

In case the raw sound file should be stored inside a memory buffer use the SoundComposer.ItemSoundFileMemoryRawAdd method.

For further details about sound composing see the the SoundComposerMan class and the How to compose a sound tutorial.

Syntax

[Visual Basic]

Public Function ItemSoundFileRawInfoGet (

nPlayerIndex as Int16,

nUniqueId as Int32,

ByRef nEncodeMode as enumRAWEncodeModes,

ByRef bIsBigEndian as Boolean,

ByRef nFrequency as Int32,

ByRef nChannels as Int32

) as enumErrorCodes

[C#]

public enumErrorCodes ItemSoundFileRawInfoGet (

Int16 nPlayerIndex,

Int32 nUniqueId,

ref enumRAWEncodeModes nEncodeMode,

ref bool bIsBigEndian,

ref Int32 nFrequency,

ref Int32 nChannels

);

[C++]

public: enumErrorCodes ItemSoundFileRawInfoGet (

Int16 nPlayerIndex,

Int32 nUniqueId,

enumRAWEncodeModes __gc *nEncodeMode,

bool __gc *bIsBigEndian,

Int32 __gc *nFrequency,

Int32 __gc *nChannels

);

Parameter

Description

nPlayerIndex

Number representing the zero-based index of the player that owns the sound composer session

nUniqueId

The unique identifier of the sound file item previously returned by the call to one of the following methods: SoundComposer.ItemSoundFileRawAdd, SoundComposer.ItemSoundFileMemoryRawAdd.

nEncodeMode

Reference that, on return from the method call, will contain the 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

Reference that, on return from the method call, will contain the boolean flag that specifies if bits order inside the RAW file are little-endian or big-endian

Supported values are the following:

Mnemonic Value	Meaning
false	The RAW file is encoded using little-endian
true	The RAW file is encoded using big-endian

nFrequency

Reference that, on return from the method call, will contain the sample rate of the RAW file (e.g. 44100)

nChannels

Reference that, on return from the method call, will contain the number of channels of the RAW file: for example, 1 for Mono or 2 for Stereo, 6 for 5.1 formats and so on

Return value

Value	Meaning

Negative value	An error occurred (see the LastError property for further error details)
enumErrorCodes.NOERROR (0)	The method call was successful.