ChannelGroup::get3DSpread

FMOD Studio API

Firelight Technologies FMOD Studio API

ChannelGroup::get3DSpread

Retrieves the spread of a 3D sound in speaker space.

C++ Syntax

FMOD_RESULT ChannelGroup::get3DSpread(
  float *angle
);

C Syntax

FMOD_RESULT FMOD_ChannelGroup_Get3DSpread(
  FMOD_CHANNELGROUP *channelgroup,
  float *angle
);

C# Syntax

RESULT ChannelGroup.get3DSpread(
  out float angle
);

JavaScript Syntax

ChannelGroup.get3DSpread(
  angle                            // writes value to angle.val
);

Parameters

angle
Address of a variable that receives the speaker spread angle.

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




Version 1.10.03 Built on Feb 1, 2018