Firelight Technologies FMOD Studio API

Studio::EventDescription::isOneshot

Retrieves the event's oneshot status, indicating whether the event will naturally terminate.

C++ Syntax

FMOD_RESULT Studio::EventDescription::isOneshot(
  bool *oneshot
);

C Syntax

FMOD_RESULT FMOD_Studio_EventDescription_IsOneshot(
  FMOD_STUDIO_EVENTDESCRIPTION *eventdescription,
  FMOD_BOOL *oneshot
);

Parameters

oneshot

Address of a variable to receive the oneshot status.

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

If the event is oneshot then it will naturally terminate and can be used as a fire-and-forget style oneshot sound by calling Studio::EventInstance::start followed by Studio::EventInstance::release.

See Also

• Studio::EventInstance::start
• Studio::EventInstance::release

Version 1.03.06 Built on Apr 17, 2014