Methods > Players and stream mixers > LoadSoundForEAX method

Remarks

Loads a song from the specified file with EAX compatible settings (Mono). The song file can be a stream or a MOD music file.

Accepted sound formats are MP3, MP2, MP1 (Stereo or Mono) and sounds in Mono as supported by the LoadSound method.

A successful call to this method invokes the CallbackForPlayersEvents delegate with the nEvent parameter set to EV_SOUND_LOADED.

Note that songs loaded with this method will not have the possibility to change Tempo, Playback rate or Pitch and cannot be attached to custom stream mixers.

For further details about EAX effects take a look to the How to apply special effects to a playing sound section.

Syntax

[Visual Basic]

Public Function LoadSoundForEAX (

nPlayer as Int16,

strFileName as String,

bFast as Boolean

) as enumErrorCodes

[C#]

public enumErrorCodes LoadSoundForEAX (

Int16 nPlayer,

string strFileName,

bool bFast

);

[C++]

public: enumErrorCodes LoadSoundForEAX (

Int16 nPlayer,

string strFileName,

bool bFast

);

Parameter	Description

nPlayer	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.
bFast	Flag that determines if a less detailed analysis must be performed for files in MP3 format: the use of this method is indicated when you need an immediate loading of MP3 files from a network.

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.

(*) Requires Microsoft Windows Media Format modules already installed on the target PC: you can verify the presence of these modules through a call to the IsWmaAvailable method.

(**) Performs sound tracks only (no video): requires Microsoft Windows Media Format modules already installed on the target PC

(***) Performs sound tracks only (no video)

The Windows Media Format modules can be installed using the redistribution setup package (wmfdist.exe) provided by Microsoft. Details about the integration of these modules inside your own setup package can be found on the following link of the official Microsoft web site (note that in the future this link could change due to the Microsoft site maintenance).