Firelight Technologies FMOD Studio API

Studio::EventDescription::getSoundSize

Retrieves the sound size for 3D panning of the event.

C++ Syntax

FMOD_RESULT Studio::EventDescription::getSoundSize(
  float *size
);

C Syntax

FMOD_RESULT FMOD_Studio_EventDescription_GetSoundSize(
  FMOD_STUDIO_EVENTDESCRIPTION *eventdescription,
  float *size
);

C# Syntax

RESULT Studio.EventDescription.getSoundSize(
  out float size
);

JavaScript Syntax

EventDescription.getSoundSize(
  size                             // writes value to size.val
);

Parameters

size

Address of a variable to receive the sound size.

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

This is the largest Sound Size value out of all of the event's 3D Panners, or zero if there are no 3D Panners.

Version 1.10.03 Built on Feb 1, 2018