FMOD_STUDIO_SOUND_INFO

FMOD Studio API

Firelight Technologies FMOD Studio API

FMOD_STUDIO_SOUND_INFO

Information for loading a sound from a sound table.

C/C++ Syntax

typedef struct {
  const char *name_or_data;
  FMOD_MODE mode;
  FMOD_CREATESOUNDEXINFO exinfo;
  int subsoundindex;
} FMOD_STUDIO_SOUND_INFO;

JavaScript Syntax

struct FMOD_STUDIO_SOUND_INFO
{
  name_or_data,
  mode,
  subsoundindex,
};

Members

name_or_data

The filename or memory buffer that contains the sound.

mode

Mode flags required for loading the sound.

exinfo

Extra information required for loading the sound.

subsoundindex

Subsound index for loading the sound.

Remarks

The name_or_data member points into FMOD internal memory, which will become invalid if the sound table bank is unloaded.

If mode flags such as FMOD_CREATESTREAM, FMOD_CREATECOMPRESSEDSAMPLE or FMOD_NONBLOCKING are required, it is up to the user to OR them together when calling System::createSound.

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_SOUND_INFO()", no 'new' keyword is required.

See Also



Version 1.10.03 Built on Feb 1, 2018