SetRecordingMode method

SetRecordingMode method

Sets the recording mode which will determine where incoming sound data will be stored inside a new recording session.

It's important to remember that recording sessions whose recording mode is set to a value different from REC_MODE_NEW must be always of the same nature, i.e. with output to memory or with output to file: trying to mix memory based sessions with file based session will cause an error.

For further details see the How to perform a recording session section.

[Visual Basic]

Public Function SetRecordingMode (

nMode as enumRecordingModes

) as enumErrorCodes

[C#]

public enumErrorCodes SetRecordingMode (

enumRecordingModes nMode

);

[C++]

public: enumErrorCodes SetRecordingMode (

enumRecordingModes nMode

);

Parameter

Description

nMode

Number representing the recording mode that will affect the behaviour of the next recording session started by methods like StartFromInputDevice.

Supported values are the following:

Mnemonic constant	Value	Meaning
REC_MODE_NEW (Default)	0	Creates a fresh new recording session.
REC_MODE_APPEND	1	Appends the new recording session to the previous one.
REC_MODE_MIX	2	Mixes the new recording session at a given position of the previous one. You can set the exact mixing position through a call to the SetMixingPos method: if you don't define a mixing position, the new recording session will be mixed starting from the beginning of the previous recording session.
REC_MODE_INSERT	3	Inserts the new recording session at a given position of the previous one. You can set the exact insert position through a call to the SetInsertPos method: if you don't define an insertion position, the new recording session will be inserted on the beginning of the previous recording session.
REC_MODE_OVERWRITE	4	Overwrites the previous recording session at a given position with the latest one. You can set the exact overwrite position through a call to the SetOverwritePos method: if you don't define an overwrite position, the new recording session will overwrite the previous one from its beginning.

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.