Firelight Technologies FMOD Studio API

System::recordStart

Starts the recording engine recording to the specified recording sound.

C++ Syntax

FMOD_RESULT System::recordStart(
  int id,
  FMOD::Sound *sound,
  bool loop
);

C Syntax

FMOD_RESULT FMOD_System_RecordStart(
  FMOD_SYSTEM *system,
  int id,
  FMOD_SOUND *sound,
  FMOD_BOOL loop
);

Parameters

id

Enumerated driver ID. This must be in a valid range delimited by System::getRecordNumDrivers.

sound

User created sound for the user to record to.

loop

Boolean flag to tell the recording engine whether to continue recording to the provided sound from the start again, after it has reached the end. If this is set to true the data will be continually be overwritten once every loop. See remarks.

Return Values

If the function succeeds then the return value is FMOD_OK.
If the function fails then the return value will be one of the values defined in the FMOD_RESULT enumeration.

See Also

• System::recordStop

Version 1.03.06 Built on Apr 17, 2014