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
);

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 channel management tutorial for more details about how channel virtualization works.

See Also




Version 1.03.06 Built on Apr 17, 2014