System::recordStop

FMOD Studio API

Firelight Technologies FMOD Studio API

System::recordStop

Stops the recording engine from recording to the specified recording sound.

C++ Syntax

FMOD_RESULT System::recordStop(
  int id
);

C Syntax

FMOD_RESULT FMOD_System_RecordStop(
  FMOD_SYSTEM *system,
  int id
);

C# Syntax

RESULT System.recordStop(
  int id
);

JavaScript Syntax

System.recordStop(
  id                               
);

Parameters

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

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.

Remarks

Returns no error if unplugged or already stopped.

See Also




Version 1.10.03 Built on Feb 1, 2018