Methods > Recorders > StartFromFile method

Remarks

Starts a new recording session from an input sound file.

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

Multichannel WAV, AIFF, OGG Vorbis, OPUS and WMA formats are not supported and will be resampled and 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.

Sound files in various RAW formats can be loaded using the StartFromFileRaw method.

During the recording sessions the container application is notified through the CallbackForRecordersEvents delegate which is invoked with the nEvent parameter set to EV_REC_START at the beginning and to EV_REC_STOP at the end. The current percentage of advancement is notified through the EV_REC_PERC event.

For details about recording from files see the How to record from files, memory or clipboard section.

Syntax

[Visual Basic]

Public Function StartFromFile (

strOutputPath as string,

strInputPath as string

) as enumErrorCodes

[C#]

public enumErrorCodes StartFromFile (

string strOutputPath,

string strInputPath

);

[C++]

public: enumErrorCodes StartFromFile (

string strOutputPath,

string strInputPath

);

Parameter	Description

strOutputPath	String representing the absolute pathname of the output file that will contain the recorded data. If this pathname should contain invalid characters, they would be automatically changed into an underscore '_' character. If the string is left empty, the recording session will be performed in memory.
strInputPath	String representing the absolute pathname of the input sound 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.

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

(***) Performs only sound frames (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).