Firelight Technologies FMOD Studio API

FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES

This structure holds information about a programmer sound.

C/C++ Syntax

typedef struct {
  const char *name;
  FMOD_SOUND *sound;
  int subsoundIndex;
} FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES;

JavaScript Syntax

struct FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES
{
  name,
  sound,
  subsoundIndex,
};

Members

name

The name of the programmer instrument (set in FMOD Studio).

sound

The programmer-created sound. This should be filled in by the create callback, and cleaned up by the destroy callback. The provided sound should be created with the FMOD_LOOP_NORMAL mode bit set. This can be cast to/from FMOD::Sound* type.

subsoundIndex

The index of the subsound to use. This should be filled in by the create callback, or set to -1 if the provided sound should be used directly. Defaults to -1.

Remarks

This data is passed to the event callback function when type is FMOD_STUDIO_EVENT_CALLBACK_CREATE_PROGRAMMER_SOUND or FMOD_STUDIO_EVENT_CALLBACK_DESTROY_PROGRAMMER_SOUND.

The provided sound should be created with the FMOD_LOOP_NORMAL mode bit set. FMOD will set this bit internally if it is not set, possibly incurring a slight performance penalty.

To support non-blocking loading of FSB subsounds, you can specify the subsound you want to use by setting the subsoundIndex field. This will cause FMOD to wait until the provided sound is ready and then get the specified subsound from it.

JavaScript only :

Not all fields are currently supported or may not work as expected at this time. To initialize an new instance in javascript use "FMOD.STUDIO_PROGRAMMER_SOUND_PROPERTIES()", no 'new' keyword is required.

See Also

• FMOD_STUDIO_EVENT_CALLBACK
• FMOD_STUDIO_SOUND_INFO
• Studio::EventDescription::setCallback
• Studio::EventInstance::setCallback
• Studio::System::getSoundInfo

Version 1.10.03 Built on Feb 1, 2018