Firelight Technologies FMOD Studio API

Studio::EventDescription::isSnapshot

Retrieves whether the event is a snapshot.

C++ Syntax

FMOD_RESULT Studio::EventDescription::isSnapshot(
  bool *snapshot
);

C Syntax

FMOD_RESULT FMOD_Studio_EventDescription_IsSnapshot(
  FMOD_STUDIO_EVENTDESCRIPTION *eventdescription,
  FMOD_BOOL *snapshot
);

C# Syntax

RESULT Studio.EventDescription.isSnapshot(
  out bool snapshot
);

JavaScript Syntax

EventDescription.isSnapshot(
  snapshot                         // writes value to snapshot.val
);

Parameters

snapshot

Address of a variable to receive the snapshot 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

Studio implements snapshots as a special kind of event. Use this function to distinguish a snapshot event from a regular event.

Version 1.10.03 Built on Feb 1, 2018