Firelight Technologies FMOD Studio API
System::isRecording
Retrieves the state of the FMOD recording API, ie if it is currently recording or not.
C++ Syntax
FMOD_RESULT System::isRecording(
int id,
bool *recording
);
C Syntax
FMOD_RESULT FMOD_System_IsRecording(
FMOD_SYSTEM *system,
int id,
FMOD_BOOL *recording
);
C# Syntax
RESULT System.isRecording(
int id,
out bool recording
);
JavaScript Syntax
System.isRecording(
id,
recording // writes value to recording.val
);
Parameters
- id
- Enumerated driver ID. This must be in a valid range delimited by System::getRecordNumDrivers.
- recording
- Address of a variable to receive the current recording state. True or non zero if the FMOD recording api is currently in the middle of recording, false or zero if the recording api is stopped / not recording.
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
Recording can be started with System::recordStart.
Will return FMOD_ERR_RECORD_DISCONNECTED if the driver is unplugged.
PS4 specific note: Record devices are virtual so 'recording' will continue to report true if the device is unplugged (the OS is generating silence). This function will still report FMOD_ERR_RECORD_DISCONNECTED for your information though.
See Also
Version 1.10.03 Built on Feb 1, 2018