Remarks
Loads a song from the specified file in RAW format.
RAW files cannot be used in the following situations:
| • | with the automatic fader |
| • | initial and final silence positions detection |
| • | loading from Internet stream |
| • | tempo, playback rate and pitch change |
A successful call to this method invokes the CallbackForPlayersEvents delegate with the nEvent parameter set to EV_SOUND_LOADED.
Syntax
[Visual Basic]
Public Function LoadSoundFromRawFile (
nPlayerIndex as Int16,
strFileName as String,
nEncodeMode as enumRAWEncodeModes,
bIsBigEndian as bool,
nFrequency as Int32,
nChannels as Int32
) as enumErrorCodes
|
|
[C#]
public enumErrorCodes LoadSoundFromRawFile (
Int16 nPlayerIndex,
string strFileName,
enumRAWEncodeModes nEncodeMode,
bool bIsBigEndian,
Int32 nFrequency,
Int32 nChannels
);
|
|
[C++]
public: enumErrorCodes LoadSoundFromRawFile (
Int16 nPlayerIndex,
string strFileName,
enumRAWEncodeModes nEncodeMode,
bool bIsBigEndian,
Int32 nFrequency,
Int32 nChannels
);
|
|
Parameter
|
Description
|
|
|
nPlayerIndex
|
Number representing the zero-based index of the player that will load the sound
|
strFilename
|
String containing the name of the song file to load. It can be a full path name (ex. c:\mysounds\sound.mp3) or a filename (ex: sound.mp3) if the SoundsDirectory property has already been specified.
|
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 specifies 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
|
|
|
enumErrorCodes.NOERROR (0)
|
The song file has been loaded successfully.
|
Negative value
|
An error occurred: see the LastError property for further error details or for a list of the possible error values.
|
|
