Firelight Technologies FMOD Studio API

Channel::get3DAttributes

Retrieves the position and velocity used to apply panning, attenuation and doppler.

C++ Syntax

FMOD_RESULT Channel::get3DAttributes(
  FMOD_VECTOR *pos,
  FMOD_VECTOR *vel,
  FMOD_VECTOR *alt_pan_pos
);

C Syntax

FMOD_RESULT FMOD_Channel_Get3DAttributes(
  FMOD_CHANNEL *channel,
  FMOD_VECTOR *pos,
  FMOD_VECTOR *vel,
  FMOD_VECTOR *alt_pan_pos
);

C# Syntax

RESULT Channel.get3DAttributes(
  out VECTOR pos,
  out VECTOR vel,
  out VECTOR alt_pan_pos
);

JavaScript Syntax

Channel.get3DAttributes(
  pos,                             // writes value to pos.val
  vel,                             // writes value to vel.val
  alt_pan_pos                      // writes value to alt_pan_pos.val
);

Parameters

pos

Address of a variable that receives the position in 3D space used for panning and attenuation. Optional, specify 0 or NULL to ignore.

vel

Address of a variable that receives the velocity in 'distance units per second' (see remarks) in 3D space. Optional, specify 0 or NULL to ignore.

alt_pan_pos

(Unimplemented).

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

A 'distance unit' is specified by System::set3DSettings. By default this is set to meters which is a distance scale of 1.0.

See Also

• ChannelControl::set3DAttributes
• System::set3DSettings
• FMOD_VECTOR

Version 1.10.03 Built on Feb 1, 2018