Methods > Editors > LoadSound method

Remarks

Loads a sound from a given pathname for editing purposes. The sound file can be a stream, a MOD music file or a CD audio track.

You can manage how loaded sound will be added to the existing editing session through a previous call to the SetLoadingMode method.

You can limit the range of sound data that will be loaded from the given sound file with a previous call to the SetLoadingRange method.

Accepted stream formats are: MP1, MP2, MP3, MP4 (***), AIFF, AAC, M4A, AC3, FLAC, WavPack, ALAC, WAV, OGG Vorbis, OPUS, WMA (*), ASF (**), WMV (**), W64, AU, PAF, SVX, NIST, VOC, IRCAM, PVF, CAF, Speex, Musepack, Monkey's Audio (APE). MIDI.

Formats wrapped inside a RIFF container (for example GSM 6.10, ADPCM, CCITT, etc. ) are supported if the specific ACM (Audio Compression Manager) codec is installed inside the system.

Multi-channel WAV, AIFF, OGG Vorbis, OPUS and WMA formats are supported natively when the MultiChannelLoadingModeSet method has been invoked with the nMode parameter set to MULTICHAN_DOWNMIX_NONE while in other cases will be converted to stereo during the loading procedure.

Accepted MOD formats are: MOD, MTM, S3M, XM, IT and MO3.

Accepted CD audio tracks format is CDA.

For loading files in RAW format use the LoadSoundFromRawFile method.

In case you should need loading a specific single channel of the audio file, use the LoadSoundChannel method.

During the execution of the loading session the CallbackPercentage delegate is invoked, with the nOperation parameter set to OPERATION_SOUND_LOADING, in order to notify about the percentage of advancement of the loading session.

For further details about callback delegates see the How to synchronize the container application with the API tutorial.

Syntax

[Visual Basic]

Public Function LoadSound (

strPathname as String

) as enumErrorCodes

[C#]

public enumErrorCodes LoadSound (

string strPathname

);

[C++]

public: enumErrorCodes LoadSound (

string strPathname

);

Parameter	Description

strPathname	String representing the absolute pathname of the input file.

Return value

Value	Meaning

Negative value	An error occurred. Check the LastError property value in order to see the last error.
enumErrorCodes.ERR_NOERROR (0)	The method call was successful.

(*) 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.

(**) Only sound stream supported (no video): requires Microsoft Windows Media Format modules already installed on the target PC

(***) Only sound stream supported (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).