Firelight Technologies FMOD Studio API
Channel::isVirtual
Retrieves whether the channel is virtual (emulated) or not due to the virtual channel management system.
C++ Syntax
FMOD_RESULT Channel::isVirtual(
bool *isvirtual
);
C Syntax
FMOD_RESULT FMOD_Channel_IsVirtual(
FMOD_CHANNEL *channel,
FMOD_BOOL *isvirtual
);
C# Syntax
RESULT Channel.isVirtual(
out bool isvirtual
);
JavaScript Syntax
Channel.isVirtual(
isvirtual // writes value to isvirtual.val
);
Parameters
- isvirtual
- Address of a variable that receives the virtual status. TRUE = inaudible and currently being emulated at no CPU cost, FALSE = real voice that should be audible.
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
See the Virtual Voice System page for more details about how channel virtualization works.
See Also
Version 1.10.03 Built on Feb 1, 2018