Unigine.Plugins.FMOD.FMODCore Class

FMODCore Class

Members

void Close ( ) #

void Release ( ) #

void Update ( ) #

void InitCore ( int max_channels, FMODEnums.INIT_FLAGS flags ) #

Arguments

• int max_channels - Maximum number of Channel objects available for playback, also known as virtual channels. Virtual channels will play with minimal overhead, with a subset of 'real' voices that are mixed, and selected based on priority and audibility. Range: [0; 4095]
• FMODEnums.INIT_FLAGS flags - Initialization flags. More than one mode can be set at once by combining them with the OR operator.

Sound CreateSound ( string name_of_data, FMODEnums.FMOD_MODE mode ) #

Arguments

• string name_of_data - Name of the file or URL to open (UTF-8 string) or a pointer to a preloaded sound memory block.
• FMODEnums.FMOD_MODE mode - Behavior modifier for opening the sound.

Return value

Sound CreateStream ( string url ) #

Arguments

• string url - URL of the resource.

Return value

Channel PlaySound ( Sound[] OUT_sound, ChannelGroup[] OUT_channel_group, bool paused ) #

Arguments

• Sound[] OUT_sound - Sound to play.
  Notice

  This output buffer is to be filled by the Engine as a result of executing the method.
• ChannelGroup[] OUT_channel_group - Group to output to instead of the master.
  Notice

  This output buffer is to be filled by the Engine as a result of executing the method.
• bool paused - Determines whether to start in the paused state. Start a Channel paused to allow altering attributes without it being audible, then follow it up with a call to ChannelControl::setPaused with paused = False.

Return value

void SetListener3DAttributes ( int listener, vec3 position, vec3 up, vec3 forward, vec3 velocity ) #

Arguments

• int listener - Listener index.
• vec3 position - Position in world space used for panning and attenuation.
• vec3 up - Upwards orientation, must be of unit length (1.0) and perpendicular to forward.
• vec3 forward - Forwards orientation, must be of unit length (1.0) and perpendicular to up.
• vec3 velocity - Velocity in world space used for doppler.

void GetListener3DAttributes ( int listener, out Vec3 position, out Vec3 up, out Vec3 forward, out Vec3 velocity ) #

Arguments

• int listener - Listener index.
• out Vec3 position - Position in world space.
• out Vec3 up - Upwards orientation.
• out Vec3 forward - Forwards orientation.
• out Vec3 velocity - Velocity in world space.

Channel GetChannel ( int index ) #

Arguments

• int index - Channel index.

Return value

ChannelGroup CreateChannelGroup ( string name ) #

Arguments

• string name - Label for identification purposes, in the UTF-8 format.

Return value