Unreal Integration 2.03

7. Blueprint Reference | Event Instance

These methods are used to control individual Event Instances.

Methods:

Event Instance Get Parameter Get a parameter value on an FMOD Event Instance.
Event Instance Get Parameter Value Get a parameter value on an FMOD Event Instance.
Event Instance Is Valid Return whether this FMOD Event Instance is valid. The instance will be invalidated when the sound stops.
Event Instance Play Play an FMOD Event Instance.
Event Instance Release Release an FMOD Event Instance.
Event Instance Set Parameter Set a parameter on an FMOD Event Instance.
Event Instance Set Paused Pause/Unpause an FMOD Event Instance.
Event Instance Set Pitch Set pitch on an FMOD Event Instance.
Event Instance Set Property Set an FMOD event property on an FMOD Event Instance.
Event Instance Set Transform Set 3D attributes on an FMOD Event Instance.
Event Instance Set Volume Set volume on an FMOD Event Instance.
Event Instance Stop Mute/Unmute the bus.
Event Instance Key Off Allow an FMOD Event Instance to continue past a sustain point.

Event Instance Get Parameter

Get a parameter value on an FMOD Event Instance.

Event Instance Get Parameter

C++

static float EventInstanceGetParameter(
  FFMODEventInstance EventInstance,
  FName Name
);

EventInstance: FFMODEventInstance to use.
Name: Name of parameter.

Will be deprecated in FMOD 2.01, use Event Instance Get Parameter Value instead.

Event Instance Get Parameter Value

Get a parameter value on an FMOD Event Instance.

Event Instance Get Parameter Value

C++

static void EventInstanceGetParameterValue(
  FFMODEventInstance EventInstance,
  FName Name,
  float &UserValue,
  float &FinalValue
);

EventInstance: FFMODEventInstance to use.
Name: Name of parameter.
UserValue: Parameter value as set from the public API.
FinalValue: Final combined parameter value.

Path lookups only succeed if the strings bank is loaded.

Event Instance Is Valid

Return whether this FMOD Event Instance is valid. The instance will be invalidated when the sound stops.

Event Instance Is Valid

C++

static bool EventInstanceIsValid(
  FFMODEventInstance EventInstance
);

EventInstance: FFMODEventInstance to use.

The instance will be invalidated when the sound stops.

Event Instance Key Off

Allow an FMOD Event Instance to continue past a sustain point.

Event Instance Key Off

C++

static void EventInstanceKeyOff(FFMODEventInstance EventInstance);

EventInstance: FFMODEventInstance to resume past sustain point.

Event Instance Play

Play an FMOD Event Instance.

Event Instance Play

C++

static void EventInstancePlay(
  FFMODEventInstance EventInstance
);

EventInstance: FFMODEventInstance to use.

Event Instance Release

Release an FMOD Event Instance.

Event Instance Release

C++

static void EventInstanceRelease(FFMODEventInstance EventInstance);

EventInstance: FFMODEventInstance to release.

Event Instance Set Parameter

Set a parameter on an FMOD Event Instance.

Event Instance Set Parameter

C++

static void EventInstanceSetParameter(
  FFMODEventInstance EventInstance,
  FName Name,
  float Value
);

EventInstance: FFMODEventInstance to use.
Name: Name of the parameter.
Value: Value to set the parameter to.

Path lookups only succeed if the strings bank is loaded.

Event Instance Set Paused

Pause/Unpause an FMOD Event Instance.

Event Instance Set Paused

C++

static void EventInstanceSetPaused(
  FFMODEventInstance EventInstance,
  bool Paused
);

EventInstance: FFMODEventInstance to use.
Paused: Paused value.

Event Instance Set Pitch

Set pitch on an FMOD Event Instance.

Event Instance Set Pitch

C++

static void EventInstanceSetPitch(
  FFMODEventInstance EventInstance,
  float Pitch
);

EventInstance: FFMODEventInstance to use.
Pitch: Pitch value.

Event Instance Set Property

Set an FMOD event property on an FMOD Event Instance.

Event Instance Set Property

C++

static void EventInstanceSetProperty(
  FFMODEventInstance EventInstance,
  EFMODEventProperty::Type Property,
  float Value
);

EventInstance: FFMODEventInstance to use.
Property: EFMODEventProperty to set.
Value: Value of property.

Event Instance Set Transform

Set 3D attributes on an FMOD Event Instance.

Event Instance Set Transform

C++

static void EventInstanceSetTransform(
  FFMODEventInstance EventInstance,
  const FTransform &Location
);

EventInstance: FFMODEventInstance to use.
Location: Location to place event.

Event Instance Set Volume

Set volume on an FMOD Event Instance.

Event Instance Set Volume

C++

static void EventInstanceSetVolume(
  FFMODEventInstance EventInstance,
  float Volume
);

EventInstance: FFMODEventInstance to set volume of.
Volume: Volume value to set.

Event Instance Stop

Mute/Unmute the bus.

Event Instance Stop

C++

static void EventInstanceStop(FFMODEventInstance EventInstance, bool Release = false);

EventInstance: FFMODEventInstance to stop.
Release: Whether to release the Event Instance