Methods > Recorders > StartFromClipboard method

Remarks

Starts a new recording session from a sound contained inside the system clipboard.

In order to understand if a CF_WAVE format sound is available inside the clipboard you can call the IsSoundAvailableInClipboard 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 StartFromClipboard (

strOutputPath as string

) as enumErrorCodes

[C#]

public enumErrorCodes StartFromClipboard (

string strOutputPath

);

[C++]

public: enumErrorCodes StartFromClipboard (

string strOutputPath

);

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.

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.