| fmod.h | | fmod.h | |
| | | | |
| skipping to change at line 19 | | skipping to change at line 19 | |
| /* ========================================================================
==================== */ | | /* ========================================================================
==================== */ | |
| | | | |
| #ifndef _FMOD_H | | #ifndef _FMOD_H | |
| #define _FMOD_H | | #define _FMOD_H | |
| | | | |
| /* | | /* | |
| FMOD version number. Check this against FMOD::System::getVersion. | | FMOD version number. Check this against FMOD::System::getVersion. | |
| 0xaaaabbcc -> aaaa = major version number. bb = minor version number.
cc = development version number. | | 0xaaaabbcc -> aaaa = major version number. bb = minor version number.
cc = development version number. | |
| */ | | */ | |
| | | | |
|
| #define FMOD_VERSION 0x00043502 | | #define FMOD_VERSION 0x00043503 | |
| | | | |
| /* | | /* | |
| Compiler specific settings. | | Compiler specific settings. | |
| */ | | */ | |
| | | | |
| #if defined(__CYGWIN32__) | | #if defined(__CYGWIN32__) | |
| #define F_CDECL __cdecl | | #define F_CDECL __cdecl | |
| #define F_STDCALL __stdcall | | #define F_STDCALL __stdcall | |
| #define F_DECLSPEC __declspec | | #define F_DECLSPEC __declspec | |
| #define F_DLLEXPORT ( dllexport ) | | #define F_DLLEXPORT ( dllexport ) | |
| | | | |
| skipping to change at line 572 | | skipping to change at line 572 | |
| <li>Channel::setSpeakerMix works and every parameter is used to set the
balance of a sound in any speaker.<br> | | <li>Channel::setSpeakerMix works and every parameter is used to set the
balance of a sound in any speaker.<br> | |
| <br> | | <br> | |
| FMOD_SPEAKERMODE_PROLOGIC<br> | | FMOD_SPEAKERMODE_PROLOGIC<br> | |
| ------------------------------------------------------<br> | | ------------------------------------------------------<br> | |
| This mode is for mono, stereo, 5.1 and 7.1 speaker arrangements, as it
is backwards and forwards compatible with stereo, | | This mode is for mono, stereo, 5.1 and 7.1 speaker arrangements, as it
is backwards and forwards compatible with stereo, | |
| but to get a surround effect a Dolby Prologic or Prologic 2 hardware de
coder / amplifier is needed.<br> | | but to get a surround effect a Dolby Prologic or Prologic 2 hardware de
coder / amplifier is needed.<br> | |
| Pan behavior is the same as FMOD_SPEAKERMODE_5POINT1.<br> | | Pan behavior is the same as FMOD_SPEAKERMODE_5POINT1.<br> | |
| <br> | | <br> | |
| If this function is called the numoutputchannels setting in System::set
SoftwareFormat is overwritten.<br> | | If this function is called the numoutputchannels setting in System::set
SoftwareFormat is overwritten.<br> | |
| <br> | | <br> | |
|
| For 3D sounds, panning is determined at runtime by the 3D subsystem bas | | Output rate must be 44100, 48000 or 96000 for this to work otherwise FM | |
| ed on the speaker mode to determine which speaker the | | OD_ERR_OUTPUT_INIT will be returned.<br> | |
| sound should be placed in.<br> | | | |
| | | FMOD_SPEAKERMODE_MYEARS<br> | |
| | | ------------------------------------------------------<br> | |
| | | This mode is for headphones. This will attempt to load a MyEars profil | |
| | | e (see myears.net.au) and use it to generate | |
| | | surround sound on headphones using a personalized HRTF algorithm, for r | |
| | | ealistic 3d sound.<br> | |
| | | Pan behavior is the same as FMOD_SPEAKERMODE_7POINT1.<br> | |
| | | MyEars speaker mode will automatically be set if the speakermode is FMO | |
| | | D_SPEAKERMODE_STEREO and the MyEars profile exists.<br> | |
| | | If this mode is set explicitly, FMOD_INIT_DISABLE_MYEARS_AUTODETECT has | |
| | | no effect.<br> | |
| | | If this mode is set explicitly and the MyEars profile does not exist, F | |
| | | MOD_ERR_OUTPUT_DRIVERCALL will be returned. | |
| | | | |
| [PLATFORMS] | | [PLATFORMS] | |
| Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable,
PlayStation 3, Wii, iPhone, 3GS, NGP, Android | | Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable,
PlayStation 3, Wii, iPhone, 3GS, NGP, Android | |
| | | | |
| [SEE_ALSO] | | [SEE_ALSO] | |
| System::setSpeakerMode | | System::setSpeakerMode | |
| System::getSpeakerMode | | System::getSpeakerMode | |
| System::getDriverCaps | | System::getDriverCaps | |
| System::setSoftwareFormat | | System::setSoftwareFormat | |
| Channel::setSpeakerLevels | | Channel::setSpeakerLevels | |
| | | | |
| skipping to change at line 595 | | skipping to change at line 603 | |
| */ | | */ | |
| typedef enum | | typedef enum | |
| { | | { | |
| FMOD_SPEAKERMODE_RAW, /* There is no specific speakermode.
Sound channels are mapped in order of input to output. Use System::setSo
ftwareFormat to specify speaker count. See remarks for more information. */ | | FMOD_SPEAKERMODE_RAW, /* There is no specific speakermode.
Sound channels are mapped in order of input to output. Use System::setSo
ftwareFormat to specify speaker count. See remarks for more information. */ | |
| FMOD_SPEAKERMODE_MONO, /* The speakers are monaural. */ | | FMOD_SPEAKERMODE_MONO, /* The speakers are monaural. */ | |
| FMOD_SPEAKERMODE_STEREO, /* The speakers are stereo (DEFAULT)
. */ | | FMOD_SPEAKERMODE_STEREO, /* The speakers are stereo (DEFAULT)
. */ | |
| FMOD_SPEAKERMODE_QUAD, /* 4 speaker setup. This includes f
ront left, front right, rear left, rear right. */ | | FMOD_SPEAKERMODE_QUAD, /* 4 speaker setup. This includes f
ront left, front right, rear left, rear right. */ | |
| FMOD_SPEAKERMODE_SURROUND, /* 5 speaker setup. This includes f
ront left, front right, center, rear left, rear right. */ | | FMOD_SPEAKERMODE_SURROUND, /* 5 speaker setup. This includes f
ront left, front right, center, rear left, rear right. */ | |
| FMOD_SPEAKERMODE_5POINT1, /* 5.1 speaker setup. This includes
front left, front right, center, rear left, rear right and a subwoofer. */ | | FMOD_SPEAKERMODE_5POINT1, /* 5.1 speaker setup. This includes
front left, front right, center, rear left, rear right and a subwoofer. */ | |
| FMOD_SPEAKERMODE_7POINT1, /* 7.1 speaker setup. This includes
front left, front right, center, rear left, rear right, side left, side ri
ght and a subwoofer. */ | | FMOD_SPEAKERMODE_7POINT1, /* 7.1 speaker setup. This includes
front left, front right, center, rear left, rear right, side left, side ri
ght and a subwoofer. */ | |
|
| FMOD_SPEAKERMODE_PROLOGIC, /* Stereo output, but data is encode | | | |
| d in a way that is picked up by a Prologic/Prologic2 decoder and split into | | FMOD_SPEAKERMODE_PROLOGIC, /* Stereo output, but data is encode | |
| a 5.1 speaker setup. */ | | d to be played on a Prologic 2 / CircleSurround decoder in 5.1 via an analo | |
| | | g connection. See remarks about limitations. */ | |
| | | FMOD_SPEAKERMODE_MYEARS, /* Stereo output, but data is encode | |
| | | d using personalized HRTF algorithms. See myears.net.au */ | |
| | | | |
| FMOD_SPEAKERMODE_MAX, /* Maximum number of speaker modes s
upported. */ | | FMOD_SPEAKERMODE_MAX, /* Maximum number of speaker modes s
upported. */ | |
| FMOD_SPEAKERMODE_FORCEINT = 65536 /* Makes sure this enum is signed 32
bit. */ | | FMOD_SPEAKERMODE_FORCEINT = 65536 /* Makes sure this enum is signed 32
bit. */ | |
| } FMOD_SPEAKERMODE; | | } FMOD_SPEAKERMODE; | |
| | | | |
| /* | | /* | |
| [ENUM] | | [ENUM] | |
| [ | | [ | |
| [DESCRIPTION] | | [DESCRIPTION] | |
| These are speaker types defined for use with the Channel::setSpeakerLev
els command. | | These are speaker types defined for use with the Channel::setSpeakerLev
els command. | |
| | | | |
| skipping to change at line 712 | | skipping to change at line 722 | |
| #define FMOD_INIT_SOFTWARE_HRTF 0x00000010 /* All platforms -
All FMOD_SOFTWARE with FMOD_3D based voices will add a software lowpass fil
ter effect into the DSP chain which causes sounds to sound duller when the
sound goes behind the listener. Use System::setAdvancedSettings to adjust
cutoff frequency. */ | | #define FMOD_INIT_SOFTWARE_HRTF 0x00000010 /* All platforms -
All FMOD_SOFTWARE with FMOD_3D based voices will add a software lowpass fil
ter effect into the DSP chain which causes sounds to sound duller when the
sound goes behind the listener. Use System::setAdvancedSettings to adjust
cutoff frequency. */ | |
| #define FMOD_INIT_SOFTWARE_REVERB_LOWMEM 0x00000040 /* All platforms -
SFX reverb is run using 22/24khz delay buffers, halving the memory required
. */ | | #define FMOD_INIT_SOFTWARE_REVERB_LOWMEM 0x00000040 /* All platforms -
SFX reverb is run using 22/24khz delay buffers, halving the memory required
. */ | |
| #define FMOD_INIT_ENABLE_PROFILE 0x00000020 /* All platforms -
Enable TCP/IP based host which allows FMOD Designer or FMOD Profiler to con
nect to it, and view memory, CPU and the DSP network graph in real-time. */ | | #define FMOD_INIT_ENABLE_PROFILE 0x00000020 /* All platforms -
Enable TCP/IP based host which allows FMOD Designer or FMOD Profiler to con
nect to it, and view memory, CPU and the DSP network graph in real-time. */ | |
| #define FMOD_INIT_VOL0_BECOMES_VIRTUAL 0x00000080 /* All platforms -
Any sounds that are 0 volume will go virtual and not be processed except fo
r having their positions updated virtually. Use System::setAdvancedSetting
s to adjust what volume besides zero to switch to virtual at. */ | | #define FMOD_INIT_VOL0_BECOMES_VIRTUAL 0x00000080 /* All platforms -
Any sounds that are 0 volume will go virtual and not be processed except fo
r having their positions updated virtually. Use System::setAdvancedSetting
s to adjust what volume besides zero to switch to virtual at. */ | |
| #define FMOD_INIT_WASAPI_EXCLUSIVE 0x00000100 /* Win32 Vista only
- for WASAPI output - Enable exclusive access to hardware, lower latency a
t the expense of excluding other applications from accessing the audio hard
ware. */ | | #define FMOD_INIT_WASAPI_EXCLUSIVE 0x00000100 /* Win32 Vista only
- for WASAPI output - Enable exclusive access to hardware, lower latency a
t the expense of excluding other applications from accessing the audio hard
ware. */ | |
| #define FMOD_INIT_PS3_PREFERDTS 0x00800000 /* PS3 only - Prefe
r DTS over Dolby Digital if both are supported. Note: 8 and 6 channel LPCM
is always preferred over both DTS and Dolby Digital. */ | | #define FMOD_INIT_PS3_PREFERDTS 0x00800000 /* PS3 only - Prefe
r DTS over Dolby Digital if both are supported. Note: 8 and 6 channel LPCM
is always preferred over both DTS and Dolby Digital. */ | |
| #define FMOD_INIT_PS3_FORCE2CHLPCM 0x01000000 /* PS3 only - Force
PS3 system output mode to 2 channel LPCM. */ | | #define FMOD_INIT_PS3_FORCE2CHLPCM 0x01000000 /* PS3 only - Force
PS3 system output mode to 2 channel LPCM. */ | |
| #define FMOD_INIT_DISABLEDOLBY 0x00100000 /* Wii / 3DS - Disa
ble Dolby Pro Logic surround. Speakermode will be set to STEREO even if use
r has selected surround in the system settings. */ | | #define FMOD_INIT_DISABLEDOLBY 0x00100000 /* Wii / 3DS - Disa
ble Dolby Pro Logic surround. Speakermode will be set to STEREO even if use
r has selected surround in the system settings. */ | |
| #define FMOD_INIT_SYSTEM_MUSICMUTENOTPAUSE 0x00200000 /* Xbox 360 / PS3 -
The "music" channelgroup which by default pauses when custom 360 dashboard
/ PS3 BGM music is played, can be changed to mute (therefore continues pla
ying) instead of pausing, by using this flag. */ | | #define FMOD_INIT_SYSTEM_MUSICMUTENOTPAUSE 0x00200000 /* Xbox 360 / PS3 -
The "music" channelgroup which by default pauses when custom 360 dashboard
/ PS3 BGM music is played, can be changed to mute (therefore continues pla
ying) instead of pausing, by using this flag. */ | |
| #define FMOD_INIT_SYNCMIXERWITHUPDATE 0x00400000 /* Win32/Wii/PS3/Xb
ox/Xbox 360 - FMOD Mixer thread is woken up to do a mix when System::update
is called rather than waking periodically on its own timer. */ | | #define FMOD_INIT_SYNCMIXERWITHUPDATE 0x00400000 /* Win32/Wii/PS3/Xb
ox/Xbox 360 - FMOD Mixer thread is woken up to do a mix when System::update
is called rather than waking periodically on its own timer. */ | |
|
| #define FMOD_INIT_DTS_NEURALSURROUND 0x02000000 /* Win32/Mac/Linux/
PS3/Xbox360 - Use DTS Neural surround downmixing from 7.1 if speakermode se
t to FMOD_SPEAKERMODE_STEREO or FMOD_SPEAKERMODE_5POINT1. Always 7.1 -> 5.1
downmix for Xbox360 and PS3. Internal DSP structure will be set to 7.1. *
/ | | | |
| #define FMOD_INIT_GEOMETRY_USECLOSEST 0x04000000 /* All platforms -
With the geometry engine, only process the closest polygon rather than accu
mulating all polygons the sound to listener line intersects. */ | | #define FMOD_INIT_GEOMETRY_USECLOSEST 0x04000000 /* All platforms -
With the geometry engine, only process the closest polygon rather than accu
mulating all polygons the sound to listener line intersects. */ | |
|
| #define FMOD_INIT_DISABLE_MYEARS 0x08000000 /* Win32 - Disables
MyEars HRTF 7.1 downmixing. MyEars will otherwise be disbaled if speakerm
ode is not set to FMOD_SPEAKERMODE_STEREO or the data file is missing. */ | | #define FMOD_INIT_DISABLE_MYEARS_AUTODETECT 0x08000000 /* Win32 - Disables
automatic setting of FMOD_SPEAKERMODE_STEREO to FMOD_SPEAKERMODE_MYEARS if
the MyEars profile exists on the PC. MyEars is HRTF 7.1 downmixing throug
h headphones. */ | |
| /* [DEFINE_END] */ | | /* [DEFINE_END] */ | |
| | | | |
| /* | | /* | |
| [ENUM] | | [ENUM] | |
| [ | | [ | |
| [DESCRIPTION] | | [DESCRIPTION] | |
| These definitions describe the type of song being played. | | These definitions describe the type of song being played. | |
| | | | |
| [REMARKS] | | [REMARKS] | |
| | | | |
| | | | |
| skipping to change at line 1459 | | skipping to change at line 1468 | |
| FMOD_FILE_SEEKCALLBACK userseek; /* [w] Optional. Spe
cify 0 to ignore. Callback for seeking within this file. */ | | FMOD_FILE_SEEKCALLBACK userseek; /* [w] Optional. Spe
cify 0 to ignore. Callback for seeking within this file. */ | |
| FMOD_FILE_ASYNCREADCALLBACK userasyncread; /* [w] Optional. Spe
cify 0 to ignore. Callback for seeking within this file. */ | | FMOD_FILE_ASYNCREADCALLBACK userasyncread; /* [w] Optional. Spe
cify 0 to ignore. Callback for seeking within this file. */ | |
| FMOD_FILE_ASYNCCANCELCALLBACK userasynccancel; /* [w] Optional. Spe
cify 0 to ignore. Callback for seeking within this file. */ | | FMOD_FILE_ASYNCCANCELCALLBACK userasynccancel; /* [w] Optional. Spe
cify 0 to ignore. Callback for seeking within this file. */ | |
| FMOD_SPEAKERMAPTYPE speakermap; /* [w] Optional. Spe
cify 0 to ignore. Use this to differ the way fmod maps multichannel sounds
to speakers. See FMOD_SPEAKERMAPTYPE for more. */ | | FMOD_SPEAKERMAPTYPE speakermap; /* [w] Optional. Spe
cify 0 to ignore. Use this to differ the way fmod maps multichannel sounds
to speakers. See FMOD_SPEAKERMAPTYPE for more. */ | |
| FMOD_SOUNDGROUP *initialsoundgroup; /* [w] Optional. Spe
cify 0 to ignore. Specify a sound group if required, to put sound in as it
is created. */ | | FMOD_SOUNDGROUP *initialsoundgroup; /* [w] Optional. Spe
cify 0 to ignore. Specify a sound group if required, to put sound in as it
is created. */ | |
| unsigned int initialseekposition;/* [w] Optional. Spe
cify 0 to ignore. For streams. Specify an initial position to seek the stre
am to. */ | | unsigned int initialseekposition;/* [w] Optional. Spe
cify 0 to ignore. For streams. Specify an initial position to seek the stre
am to. */ | |
| FMOD_TIMEUNIT initialseekpostype; /* [w] Optional. Spe
cify 0 to ignore. For streams. Specify the time unit for the position set i
n initialseekposition. */ | | FMOD_TIMEUNIT initialseekpostype; /* [w] Optional. Spe
cify 0 to ignore. For streams. Specify the time unit for the position set i
n initialseekposition. */ | |
| int ignoresetfilesystem;/* [w] Optional. Spe
cify 0 to ignore. Set to 1 to use fmod's built in file system. Ignores setF
ileSystem callbacks and also FMOD_CREATESOUNEXINFO file callbacks. Useful
for specific cases where you don't want to use your own file system but wan
t to use fmod's file system (ie net streaming). */ | | int ignoresetfilesystem;/* [w] Optional. Spe
cify 0 to ignore. Set to 1 to use fmod's built in file system. Ignores setF
ileSystem callbacks and also FMOD_CREATESOUNEXINFO file callbacks. Useful
for specific cases where you don't want to use your own file system but wan
t to use fmod's file system (ie net streaming). */ | |
| int cddaforceaspi; /* [w] Optional. Spe
cify 0 to ignore. For CDDA sounds only - if non-zero use ASPI instead of NT
SCSI to access the specified CD/DVD device. */ | | int cddaforceaspi; /* [w] Optional. Spe
cify 0 to ignore. For CDDA sounds only - if non-zero use ASPI instead of NT
SCSI to access the specified CD/DVD device. */ | |
| unsigned int audioqueuepolicy; /* [w] Optional. Spe
cify 0 or FMOD_AUDIOQUEUE_CODECPOLICY_DEFAULT to ignore. Policy used to det
ermine whether hardware or software is used for decoding, see FMOD_AUDIOQUE
UE_CODECPOLICY for options (iOS >= 3.0 required, otherwise only hardware is
available) */ | | unsigned int audioqueuepolicy; /* [w] Optional. Spe
cify 0 or FMOD_AUDIOQUEUE_CODECPOLICY_DEFAULT to ignore. Policy used to det
ermine whether hardware or software is used for decoding, see FMOD_AUDIOQUE
UE_CODECPOLICY for options (iOS >= 3.0 required, otherwise only hardware is
available) */ | |
|
| unsigned int minmidigranularity; /* [w] Optional. Spe | | unsigned int minmidigranularity; /* [w] Optional. Spe | |
| cify 0 to ignore. Allows you to set a minimum desired MIDI mixer granularit | | cify 0 to ignore. Allows you to set a minimum desired MIDI mixer granularit | |
| y. Values smaller than 512 give greater than default accuracy at the cost o | | y. Values smaller than 512 give greater than default accuracy at the cost o | |
| f more CPU and vise versa. Specify 0 for default (512 samples). */ | | f more CPU and vice versa. Specify 0 for default (512 samples). */ | |
| | | int nonblockthreadid; /* [w] Optional. Spe | |
| | | cify 0 to ignore. Specifies a thread index to execute non blocking load on. | |
| | | Allows for up to 5 threads to be used for loading at once. This is to av | |
| | | oid one load blocking another. Maximum value = 4. */ | |
| } FMOD_CREATESOUNDEXINFO; | | } FMOD_CREATESOUNDEXINFO; | |
| | | | |
| /* | | /* | |
| [STRUCTURE] | | [STRUCTURE] | |
| [ | | [ | |
| [DESCRIPTION] | | [DESCRIPTION] | |
| Structure defining a reverb environment.<br> | | Structure defining a reverb environment.<br> | |
| | | | |
| [REMARKS] | | [REMARKS] | |
| Note the default reverb properties are the same as the FMOD_PRESET_GENE
RIC preset.<br> | | Note the default reverb properties are the same as the FMOD_PRESET_GENE
RIC preset.<br> | |
| | | | |
| skipping to change at line 1735 | | skipping to change at line 1745 | |
| int maxCELTcodecs; /* [r/w] Optional. Specify
0 to ignore. For use with FMOD_CREATECOMPRESSEDSAMPLE only. CELT codecs c
onsume 11,500 bytes per instance and this number will determine how many CE
LT channels can be played simultaneously. Default = 32. */ | | int maxCELTcodecs; /* [r/w] Optional. Specify
0 to ignore. For use with FMOD_CREATECOMPRESSEDSAMPLE only. CELT codecs c
onsume 11,500 bytes per instance and this number will determine how many CE
LT channels can be played simultaneously. Default = 32. */ | |
| int maxPCMcodecs; /* [r/w] Optional. Specify
0 to ignore. For use with PS3 only. PCM codecs c
onsume 12,672 bytes per instance and this number will determine how many st
reams and PCM voices can be played simultaneously. Default = 16. */ | | int maxPCMcodecs; /* [r/w] Optional. Specify
0 to ignore. For use with PS3 only. PCM codecs c
onsume 12,672 bytes per instance and this number will determine how many st
reams and PCM voices can be played simultaneously. Default = 16. */ | |
| int ASIONumChannels; /* [r/w] Optional. Specify
0 to ignore. Number of channels available on the ASIO device. */ | | int ASIONumChannels; /* [r/w] Optional. Specify
0 to ignore. Number of channels available on the ASIO device. */ | |
| char **ASIOChannelList; /* [r/w] Optional. Specify
0 to ignore. Pointer to an array of strings (number of entries defined by A
SIONumChannels) with ASIO channel names. */ | | char **ASIOChannelList; /* [r/w] Optional. Specify
0 to ignore. Pointer to an array of strings (number of entries defined by A
SIONumChannels) with ASIO channel names. */ | |
| FMOD_SPEAKER *ASIOSpeakerList; /* [r/w] Optional. Specify
0 to ignore. Pointer to a list of speakers that the ASIO channels map to.
This can be called after System::init to remap ASIO output. */ | | FMOD_SPEAKER *ASIOSpeakerList; /* [r/w] Optional. Specify
0 to ignore. Pointer to a list of speakers that the ASIO channels map to.
This can be called after System::init to remap ASIO output. */ | |
| int max3DReverbDSPs; /* [r/w] Optional. Specify
0 to ignore. The max number of 3d reverb DSP's in the system. (NOTE: CURREN
TLY DISABLED / UNUSED) */ | | int max3DReverbDSPs; /* [r/w] Optional. Specify
0 to ignore. The max number of 3d reverb DSP's in the system. (NOTE: CURREN
TLY DISABLED / UNUSED) */ | |
| float HRTFMinAngle; /* [r/w] Optional. Specify
0 to ignore. For use with FMOD_INIT_SOFTWARE_HRTF. The angle range (0-360)
of a 3D sound in relation to the listener, at which the HRTF function begi
ns to have an effect. 0 = in front of the listener. 180 = from 90 degrees t
o the left of the listener to 90 degrees to the right. 360 = behind the lis
tener. Default = 180.0. */ | | float HRTFMinAngle; /* [r/w] Optional. Specify
0 to ignore. For use with FMOD_INIT_SOFTWARE_HRTF. The angle range (0-360)
of a 3D sound in relation to the listener, at which the HRTF function begi
ns to have an effect. 0 = in front of the listener. 180 = from 90 degrees t
o the left of the listener to 90 degrees to the right. 360 = behind the lis
tener. Default = 180.0. */ | |
| float HRTFMaxAngle; /* [r/w] Optional. Specify
0 to ignore. For use with FMOD_INIT_SOFTWARE_HRTF. The angle range (0-360)
of a 3D sound in relation to the listener, at which the HRTF function has
maximum effect. 0 = front of the listener. 180 = from 90 degrees to the lef
t of the listener to 90 degrees to the right. 360 = behind the listener. De
fault = 360.0. */ | | float HRTFMaxAngle; /* [r/w] Optional. Specify
0 to ignore. For use with FMOD_INIT_SOFTWARE_HRTF. The angle range (0-360)
of a 3D sound in relation to the listener, at which the HRTF function has
maximum effect. 0 = front of the listener. 180 = from 90 degrees to the lef
t of the listener to 90 degrees to the right. 360 = behind the listener. De
fault = 360.0. */ | |
| float HRTFFreq; /* [r/w] Optional. Specify
0 to ignore. For use with FMOD_INIT_SOFTWARE_HRTF. The cutoff frequency of
the HRTF's lowpass filter function when at maximum effect. (i.e. at HRTFMa
xAngle). Default = 4000.0. */ | | float HRTFFreq; /* [r/w] Optional. Specify
0 to ignore. For use with FMOD_INIT_SOFTWARE_HRTF. The cutoff frequency of
the HRTF's lowpass filter function when at maximum effect. (i.e. at HRTFMa
xAngle). Default = 4000.0. */ | |
| float vol0virtualvol; /* [r/w] Optional. Specify
0 to ignore. For use with FMOD_INIT_VOL0_BECOMES_VIRTUAL. If this flag is
used, and the volume is 0.0, then the sound will become virtual. Use this
value to raise the threshold to a different point where a sound goes virtua
l. */ | | float vol0virtualvol; /* [r/w] Optional. Specify
0 to ignore. For use with FMOD_INIT_VOL0_BECOMES_VIRTUAL. If this flag is
used, and the volume is 0.0, then the sound will become virtual. Use this
value to raise the threshold to a different point where a sound goes virtua
l. */ | |
|
| int eventqueuesize; /* [r/w] Optional. Specify
0 to ignore. For use with FMOD Event system only. Specifies the number of
slots available for simultaneous non blocking loads. Default = 32. */ | | int eventqueuesize; /* [r/w] Optional. Specify
0 to ignore. For use with FMOD Event system only. Specifies the number of
slots available for simultaneous non blocking loads, across all threads. D
efault = 64. */ | |
| unsigned int defaultDecodeBufferSize; /* [r/w] Optional. Specify
0 to ignore. For streams. This determines the default size of the double bu
ffer (in milliseconds) that a stream uses. Default = 400ms */ | | unsigned int defaultDecodeBufferSize; /* [r/w] Optional. Specify
0 to ignore. For streams. This determines the default size of the double bu
ffer (in milliseconds) that a stream uses. Default = 400ms */ | |
| char *debugLogFilename; /* [r/w] Optional. Specify
0 to ignore. Gives fmod's logging system a path/filename. Normally the log
is placed in the same directory as the executable and called fmod.log. Whe
n using System::getAdvancedSettings, provide at least 256 bytes of memory t
o copy into. */ | | char *debugLogFilename; /* [r/w] Optional. Specify
0 to ignore. Gives fmod's logging system a path/filename. Normally the log
is placed in the same directory as the executable and called fmod.log. Whe
n using System::getAdvancedSettings, provide at least 256 bytes of memory t
o copy into. */ | |
| unsigned short profileport; /* [r/w] Optional. Specify
0 to ignore. For use with FMOD_INIT_ENABLE_PROFILE. Specify the port to li
sten on for connections by the profiler application. */ | | unsigned short profileport; /* [r/w] Optional. Specify
0 to ignore. For use with FMOD_INIT_ENABLE_PROFILE. Specify the port to li
sten on for connections by the profiler application. */ | |
| unsigned int geometryMaxFadeTime; /* [r/w] Optional. Specify
0 to ignore. The maximum time in miliseconds it takes for a channel to fade
to the new level when its occlusion changes. */ | | unsigned int geometryMaxFadeTime; /* [r/w] Optional. Specify
0 to ignore. The maximum time in miliseconds it takes for a channel to fade
to the new level when its occlusion changes. */ | |
| unsigned int maxSpectrumWaveDataBuffers; /* [r/w] Optional. Specify
0 to ignore. Tells System::init to allocate a pool of wavedata/spectrum buf
fers to prevent memory fragmentation, any additional buffers will be alloca
ted normally. */ | | unsigned int maxSpectrumWaveDataBuffers; /* [r/w] Optional. Specify
0 to ignore. Tells System::init to allocate a pool of wavedata/spectrum buf
fers to prevent memory fragmentation, any additional buffers will be alloca
ted normally. */ | |
| unsigned int musicSystemCacheDelay; /* [r/w] Optional. Specify
0 to ignore. The delay the music system should allow for loading a sample f
rom disk (in milliseconds). Default = 400 ms. */ | | unsigned int musicSystemCacheDelay; /* [r/w] Optional. Specify
0 to ignore. The delay the music system should allow for loading a sample f
rom disk (in milliseconds). Default = 400 ms. */ | |
| } FMOD_ADVANCEDSETTINGS; | | } FMOD_ADVANCEDSETTINGS; | |
| | | | |
| /* | | /* | |
| [ENUM] | | [ENUM] | |
| | | | |
End of changes. 7 change blocks. |
| 14 lines changed or deleted | | 33 lines changed or added | |
|
| fmod_event.h | | fmod_event.h | |
| | | | |
| skipping to change at line 24 | | skipping to change at line 24 | |
| | | | |
| #ifndef _FMOD_H | | #ifndef _FMOD_H | |
| #include "fmod.h" | | #include "fmod.h" | |
| #endif | | #endif | |
| | | | |
| /* | | /* | |
| FMOD EventSystem version number. Check this against FMOD::EventSystem:
:getVersion. | | FMOD EventSystem version number. Check this against FMOD::EventSystem:
:getVersion. | |
| 0xaaaabbcc -> aaaa = major version number. bb = minor version number.
cc = development version number. | | 0xaaaabbcc -> aaaa = major version number. bb = minor version number.
cc = development version number. | |
| */ | | */ | |
| | | | |
|
| #define FMOD_EVENT_VERSION 0x00043502 | | #define FMOD_EVENT_VERSION 0x00043503 | |
| | | | |
| /* | | /* | |
| FMOD event types | | FMOD event types | |
| */ | | */ | |
| | | | |
| typedef struct FMOD_EVENTSYSTEM FMOD_EVENTSYSTEM; | | typedef struct FMOD_EVENTSYSTEM FMOD_EVENTSYSTEM; | |
| typedef struct FMOD_EVENTPROJECT FMOD_EVENTPROJECT; | | typedef struct FMOD_EVENTPROJECT FMOD_EVENTPROJECT; | |
| typedef struct FMOD_EVENTGROUP FMOD_EVENTGROUP; | | typedef struct FMOD_EVENTGROUP FMOD_EVENTGROUP; | |
| typedef struct FMOD_EVENTCATEGORY FMOD_EVENTCATEGORY; | | typedef struct FMOD_EVENTCATEGORY FMOD_EVENTCATEGORY; | |
| typedef struct FMOD_EVENT FMOD_EVENT; | | typedef struct FMOD_EVENT FMOD_EVENT; | |
| | | | |
| skipping to change at line 60 | | skipping to change at line 60 | |
| [ | | [ | |
| [NAME] | | [NAME] | |
| FMOD_EVENT_INITFLAGS | | FMOD_EVENT_INITFLAGS | |
| | | | |
| [DESCRIPTION] | | [DESCRIPTION] | |
| Initialization flags. Use them with EventSystem::init in the eventflag
s parameter to change various behaviour. | | Initialization flags. Use them with EventSystem::init in the eventflag
s parameter to change various behaviour. | |
| | | | |
| [REMARKS] | | [REMARKS] | |
| | | | |
| [PLATFORMS] | | [PLATFORMS] | |
|
| Win32, Win64, Linux, Linux64, Macintosh, Xbox, Xbox360, PlayStation 2,
GameCube, PlayStation Portable, PlayStation 3 | | Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable,
PlayStation 3, Wii, iPhone, 3GS, NGP, Android | |
| | | | |
| [SEE_ALSO] | | [SEE_ALSO] | |
| EventSystem::init | | EventSystem::init | |
| EventSystem::getEventByGUID | | EventSystem::getEventByGUID | |
| FMOD_EVENT_SOUNDDEFINFO | | FMOD_EVENT_SOUNDDEFINFO | |
| FMOD_EVENT_CALLBACKTYPE | | FMOD_EVENT_CALLBACKTYPE | |
| ] | | ] | |
| */ | | */ | |
| #define FMOD_EVENT_INIT_NORMAL 0x00000000 /* All platforms
- Initialize normally */ | | #define FMOD_EVENT_INIT_NORMAL 0x00000000 /* All platforms
- Initialize normally */ | |
| #define FMOD_EVENT_INIT_USER_ASSETMANAGER 0x00000001 /* All platforms
- All wave data loading/freeing will be referred back to the programmer th
rough the FMOD_EVENT_CALLBACKTYPE_SOUNDDEF_CREATE/FMOD_EVENT_CALLBACKTYPE_S
OUNDDEF_RELEASE callback */ | | #define FMOD_EVENT_INIT_USER_ASSETMANAGER 0x00000001 /* All platforms
- All wave data loading/freeing will be referred back to the programmer th
rough the FMOD_EVENT_CALLBACKTYPE_SOUNDDEF_CREATE/FMOD_EVENT_CALLBACKTYPE_S
OUNDDEF_RELEASE callback */ | |
| | | | |
| skipping to change at line 92 | | skipping to change at line 92 | |
| /* | | /* | |
| [DEFINE] | | [DEFINE] | |
| [ | | [ | |
| [NAME] | | [NAME] | |
| FMOD_EVENT_MODE | | FMOD_EVENT_MODE | |
| | | | |
| [DESCRIPTION] | | [DESCRIPTION] | |
| Event data loading bitfields. Bitwise OR them together for controlling
how event data is loaded. | | Event data loading bitfields. Bitwise OR them together for controlling
how event data is loaded. | |
| | | | |
| [REMARKS] | | [REMARKS] | |
|
| | | FMOD_EVENT_NONBLOCKING_THREAD0-4. This flag extends FMOD_EVENT_NONBLOC | |
| | | KING to allow multiple asynchronous loads to happen on different threads at | |
| | | the same time.<br> | |
| | | FMOD_EVENT_NONBLOCKING by itself will always execute on thread 0 by def | |
| | | ault. Up to 5 simultaneous threads for loading at once are supported.<br> | |
| | | Only 1 flag should be specified at a time. If multiple flags are speci | |
| | | fied an FMOD_ERR_INVALID_PARAM error will be returned.<br> | |
| | | FMOD_EVENT_NONBLOCKING_THREAD0-4 can be specified without the FMOD_EVEN | |
| | | T_NONBLOCKING flag being used (it automatically includes it) | |
| | | | |
| [PLATFORMS] | | [PLATFORMS] | |
|
| Win32, Win64, Linux, Macintosh, Xbox, Xbox360, PlayStation 2, GameCube,
PlayStation Portable, PlayStation 3, Wii | | Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable,
PlayStation 3, Wii, iPhone, 3GS, NGP, Android | |
| | | | |
| [SEE_ALSO] | | [SEE_ALSO] | |
| EventGroup::loadEventData | | EventGroup::loadEventData | |
| EventGroup::getEvent | | EventGroup::getEvent | |
| EventGroup::getEventByIndex | | EventGroup::getEventByIndex | |
| ] | | ] | |
| */ | | */ | |
| #define FMOD_EVENT_DEFAULT 0x00000000 /* FMOD_EVENT_DEFAULT
specifies default loading behaviour i.e. event data for the whole group is
NOT cached and the function that initiated the loading process will block u
ntil loading is complete. */ | | #define FMOD_EVENT_DEFAULT 0x00000000 /* FMOD_EVENT_DEFAULT
specifies default loading behaviour i.e. event data for the whole group is
NOT cached and the function that initiated the loading process will block u
ntil loading is complete. */ | |
| #define FMOD_EVENT_NONBLOCKING 0x00000001 /* For loading event d
ata asynchronously. FMOD will use a thread to load the data. Use Event::ge
tState to find out when loading is complete. */ | | #define FMOD_EVENT_NONBLOCKING 0x00000001 /* For loading event d
ata asynchronously. FMOD will use a thread to load the data. Use Event::ge
tState to find out when loading is complete. */ | |
| #define FMOD_EVENT_ERROR_ON_DISKACCESS 0x00000002 /* For EventGroup::get
Event / EventGroup::getEventByIndex. If EventGroup::loadEventData has acci
dently been forgotten this flag will return an FMOD_ERR_FILE_UNWANTED if th
e getEvent function tries to load data. */ | | #define FMOD_EVENT_ERROR_ON_DISKACCESS 0x00000002 /* For EventGroup::get
Event / EventGroup::getEventByIndex. If EventGroup::loadEventData has acci
dently been forgotten this flag will return an FMOD_ERR_FILE_UNWANTED if th
e getEvent function tries to load data. */ | |
| #define FMOD_EVENT_INFOONLY 0x00000004 /* For EventGroup::get
Event / EventGroup::getEventByIndex. Don't allocate instances or load data
, just get a handle to allow user to get information from the event. */ | | #define FMOD_EVENT_INFOONLY 0x00000004 /* For EventGroup::get
Event / EventGroup::getEventByIndex. Don't allocate instances or load data
, just get a handle to allow user to get information from the event. */ | |
| #define FMOD_EVENT_USERDSP 0x00000008 /* For EventGroup::get
Event / EventGroup::getEventByIndex. Tells FMOD that you plan to add your
own DSP effects to this event's ChannelGroup at runtime. Omitting this flag
will yield a small memory gain. */ | | #define FMOD_EVENT_USERDSP 0x00000008 /* For EventGroup::get
Event / EventGroup::getEventByIndex. Tells FMOD that you plan to add your
own DSP effects to this event's ChannelGroup at runtime. Omitting this flag
will yield a small memory gain. */ | |
|
| | | | |
| | | #define FMOD_EVENT_NONBLOCKING_THREAD0 (FMOD_EVENT_NONBLOCKING) | |
| | | /* FMOD_EVENT_NONBLOCKING, execute on thread 0. See remarks. (default | |
| | | ) */ | |
| | | #define FMOD_EVENT_NONBLOCKING_THREAD1 (FMOD_EVENT_NONBLOCKING | 0x000100 | |
| | | 00) /* FMOD_EVENT_NONBLOCKING, execute on thread 1. See remarks. */ | |
| | | #define FMOD_EVENT_NONBLOCKING_THREAD2 (FMOD_EVENT_NONBLOCKING | 0x000200 | |
| | | 00) /* FMOD_EVENT_NONBLOCKING, execute on thread 2. See remarks. */ | |
| | | #define FMOD_EVENT_NONBLOCKING_THREAD3 (FMOD_EVENT_NONBLOCKING | 0x000400 | |
| | | 00) /* FMOD_EVENT_NONBLOCKING, execute on thread 3. See remarks. */ | |
| | | #define FMOD_EVENT_NONBLOCKING_THREAD4 (FMOD_EVENT_NONBLOCKING | 0x000800 | |
| | | 00) /* FMOD_EVENT_NONBLOCKING, execute on thread 4. See remarks. */ | |
| /* [DEFINE_END] */ | | /* [DEFINE_END] */ | |
| | | | |
| /* | | /* | |
| [DEFINE] | | [DEFINE] | |
| [ | | [ | |
| [NAME] | | [NAME] | |
| FMOD_EVENT_STATE | | FMOD_EVENT_STATE | |
| | | | |
| [DESCRIPTION] | | [DESCRIPTION] | |
| These values describe what state an event is in. | | These values describe what state an event is in. | |
| | | | |
| [REMARKS] | | [REMARKS] | |
| The flags below can be combined to set multiple states at once. Use bi
twise AND operations to test for these. | | The flags below can be combined to set multiple states at once. Use bi
twise AND operations to test for these. | |
| An example of a combined flag set would be FMOD_EVENT_STATE_READY | FMO
D_EVENT_STATE_PLAYING. | | An example of a combined flag set would be FMOD_EVENT_STATE_READY | FMO
D_EVENT_STATE_PLAYING. | |
| | | | |
| [PLATFORMS] | | [PLATFORMS] | |
|
| Win32, Win64, Linux, Macintosh, Xbox, Xbox360, PlayStation 2, GameCube,
PlayStation Portable, PlayStation 3, Wii | | Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable,
PlayStation 3, Wii, iPhone, 3GS, NGP, Android | |
| | | | |
| [SEE_ALSO] | | [SEE_ALSO] | |
| Event::getState | | Event::getState | |
| FMOD_EVENT_MODE | | FMOD_EVENT_MODE | |
| ] | | ] | |
| */ | | */ | |
| #define FMOD_EVENT_STATE_READY 0x00000001 /* Event is ready to p
lay. */ | | #define FMOD_EVENT_STATE_READY 0x00000001 /* Event is ready to p
lay. */ | |
| #define FMOD_EVENT_STATE_LOADING 0x00000002 /* Loading in progress
. */ | | #define FMOD_EVENT_STATE_LOADING 0x00000002 /* Loading in progress
. */ | |
| #define FMOD_EVENT_STATE_ERROR 0x00000004 /* Failed to open - fi
le not found, out of memory etc. See return value of Event::getState for w
hat happened. */ | | #define FMOD_EVENT_STATE_ERROR 0x00000004 /* Failed to open - fi
le not found, out of memory etc. See return value of Event::getState for w
hat happened. */ | |
| #define FMOD_EVENT_STATE_PLAYING 0x00000008 /* Event has been star
ted. This will still be true even if there are no sounds active. Event::s
top must be called or the event must stop itself using a 'one shot and stop
event' parameter mode. */ | | #define FMOD_EVENT_STATE_PLAYING 0x00000008 /* Event has been star
ted. This will still be true even if there are no sounds active. Event::s
top must be called or the event must stop itself using a 'one shot and stop
event' parameter mode. */ | |
| | | | |
| skipping to change at line 148 | | skipping to change at line 158 | |
| | | | |
| /* | | /* | |
| [ENUM] | | [ENUM] | |
| [ | | [ | |
| [DESCRIPTION] | | [DESCRIPTION] | |
| Property indices for Event::getPropertyByIndex. | | Property indices for Event::getPropertyByIndex. | |
| | | | |
| [REMARKS] | | [REMARKS] | |
| | | | |
| [PLATFORMS] | | [PLATFORMS] | |
|
| Win32, Win64, Linux, Macintosh, Xbox, Xbox360, PlayStation 2, GameCube,
PlayStation Portable, PlayStation 3, Wii | | Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable,
PlayStation 3, Wii, iPhone, 3GS, NGP, Android | |
| | | | |
| [SEE_ALSO] | | [SEE_ALSO] | |
| Event::getPropertyByIndex | | Event::getPropertyByIndex | |
| ] | | ] | |
| */ | | */ | |
| typedef enum | | typedef enum | |
| { | | { | |
| FMOD_EVENTPROPERTY_NAME = 0, /* Type : char *
- (<b>Readonly</b>) Name of event. */ | | FMOD_EVENTPROPERTY_NAME = 0, /* Type : char *
- (<b>Readonly</b>) Name of event. */ | |
| FMOD_EVENTPROPERTY_VOLUME, /* Type : float
- Relative volume of event. */ | | FMOD_EVENTPROPERTY_VOLUME, /* Type : float
- Relative volume of event. */ | |
| FMOD_EVENTPROPERTY_VOLUMERANDOMIZATION, /* Type : float
- Random deviation in volume of event. */ | | FMOD_EVENTPROPERTY_VOLUMERANDOMIZATION, /* Type : float
- Random deviation in volume of event. */ | |
| | | | |
| skipping to change at line 219 | | skipping to change at line 229 | |
| | | | |
| /* | | /* | |
| [ENUM] | | [ENUM] | |
| [ | | [ | |
| [DESCRIPTION] | | [DESCRIPTION] | |
| Event property types. | | Event property types. | |
| | | | |
| [REMARKS] | | [REMARKS] | |
| | | | |
| [PLATFORMS] | | [PLATFORMS] | |
|
| Win32, Win64, Linux, Macintosh, Xbox, Xbox360, PlayStation 2, GameCube,
PlayStation Portable, PlayStation 3, Wii | | Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable,
PlayStation 3, Wii, iPhone, 3GS, NGP, Android | |
| | | | |
| [SEE_ALSO] | | [SEE_ALSO] | |
| Event::getPropertyByIndex | | Event::getPropertyByIndex | |
| Event::getPropertyInfo | | Event::getPropertyInfo | |
| ] | | ] | |
| */ | | */ | |
| typedef enum | | typedef enum | |
| { | | { | |
| FMOD_EVENTPROPERTY_TYPE_INT = 0, /* Property is an
int, unsigned int or other type of equivalent sizee e.g. FMOD_MODE. */ | | FMOD_EVENTPROPERTY_TYPE_INT = 0, /* Property is an
int, unsigned int or other type of equivalent sizee e.g. FMOD_MODE. */ | |
| FMOD_EVENTPROPERTY_TYPE_FLOAT, /* Property is a fl
oat. */ | | FMOD_EVENTPROPERTY_TYPE_FLOAT, /* Property is a fl
oat. */ | |
| | | | |
| skipping to change at line 242 | | skipping to change at line 252 | |
| | | | |
| /* | | /* | |
| [ENUM] | | [ENUM] | |
| [ | | [ | |
| [DESCRIPTION] | | [DESCRIPTION] | |
| Pitch units for Event::setPitch and EventCategory::setPitch. | | Pitch units for Event::setPitch and EventCategory::setPitch. | |
| | | | |
| [REMARKS] | | [REMARKS] | |
| | | | |
| [PLATFORMS] | | [PLATFORMS] | |
|
| Win32, Win64, Linux, Macintosh, Xbox, Xbox360, PlayStation 2, GameCube,
PlayStation Portable, PlayStation 3, Wii | | Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable,
PlayStation 3, Wii, iPhone, 3GS, NGP, Android | |
| | | | |
| [SEE_ALSO] | | [SEE_ALSO] | |
| Event::setPitch | | Event::setPitch | |
| EventCategory::setPitch | | EventCategory::setPitch | |
| ] | | ] | |
| */ | | */ | |
| typedef enum | | typedef enum | |
| { | | { | |
| FMOD_EVENT_PITCHUNITS_RAW = 0, /* Pitch is specified in raw underl
ying units. */ | | FMOD_EVENT_PITCHUNITS_RAW = 0, /* Pitch is specified in raw underl
ying units. */ | |
| FMOD_EVENT_PITCHUNITS_OCTAVES, /* Pitch is specified in units of o
ctaves. */ | | FMOD_EVENT_PITCHUNITS_OCTAVES, /* Pitch is specified in units of o
ctaves. */ | |
| | | | |
| skipping to change at line 266 | | skipping to change at line 276 | |
| | | | |
| /* | | /* | |
| [ENUM] | | [ENUM] | |
| [ | | [ | |
| [DESCRIPTION] | | [DESCRIPTION] | |
| Flags to pass to EventGroup::loadEventData to determine what to load at
the time of calling. | | Flags to pass to EventGroup::loadEventData to determine what to load at
the time of calling. | |
| | | | |
| [REMARKS] | | [REMARKS] | |
| | | | |
| [PLATFORMS] | | [PLATFORMS] | |
|
| Win32, Win64, Linux, Macintosh, Xbox, Xbox360, PlayStation 2, GameCube,
PlayStation Portable, PlayStation 3, Wii | | Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable,
PlayStation 3, Wii, iPhone, 3GS, NGP, Android | |
| | | | |
| [SEE_ALSO] | | [SEE_ALSO] | |
| EventGroup::loadEventData | | EventGroup::loadEventData | |
| ] | | ] | |
| */ | | */ | |
| typedef enum | | typedef enum | |
| { | | { | |
| FMOD_EVENT_RESOURCE_STREAMS_AND_SAMPLES, /* Open all streams and load
all banks into memory, under this group (recursive) */ | | FMOD_EVENT_RESOURCE_STREAMS_AND_SAMPLES, /* Open all streams and load
all banks into memory, under this group (recursive) */ | |
| FMOD_EVENT_RESOURCE_STREAMS, /* Open all streams under thi
s group (recursive). No samples are loaded. */ | | FMOD_EVENT_RESOURCE_STREAMS, /* Open all streams under thi
s group (recursive). No samples are loaded. */ | |
| FMOD_EVENT_RESOURCE_SAMPLES /* Load all banks into memory
, under this group (recursive). No streams are opened. */ | | FMOD_EVENT_RESOURCE_SAMPLES /* Load all banks into memory
, under this group (recursive). No streams are opened. */ | |
| | | | |
| skipping to change at line 408 | | skipping to change at line 418 | |
| | | | |
| <b>FMOD_EVENT_CALLBACKTYPE_OCCLUSION</b> | | <b>FMOD_EVENT_CALLBACKTYPE_OCCLUSION</b> | |
| <p> | | <p> | |
| param1 = (float *) pointer to a floating point direct value that can be
read and modified after the geometry engine has calculated it for this eve
nt's channel.<br> | | param1 = (float *) pointer to a floating point direct value that can be
read and modified after the geometry engine has calculated it for this eve
nt's channel.<br> | |
| param2 = (float *) pointer to a floating point reverb value that can be
read and modified after the geometry engine has calculated it for this eve
nt's channel.<br> | | param2 = (float *) pointer to a floating point reverb value that can be
read and modified after the geometry engine has calculated it for this eve
nt's channel.<br> | |
| <p> | | <p> | |
| An FMOD_EVENT_CALLBACKTYPE_OCCLUSION callback is generated whenever an
channel has its occlusion updated via the geometry system. | | An FMOD_EVENT_CALLBACKTYPE_OCCLUSION callback is generated whenever an
channel has its occlusion updated via the geometry system. | |
| <p> <p> | | <p> <p> | |
| | | | |
| [PLATFORMS] | | [PLATFORMS] | |
|
| Win32, Win64, Linux, Macintosh, Xbox, Xbox360, PlayStation 2, GameCube,
PlayStation Portable, PlayStation 3, Wii | | Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable,
PlayStation 3, Wii, iPhone, 3GS, NGP, Android | |
| | | | |
| [SEE_ALSO] | | [SEE_ALSO] | |
| Event::setCallback | | Event::setCallback | |
| FMOD_EVENT_CALLBACK | | FMOD_EVENT_CALLBACK | |
| FMOD_EVENT_SOUNDDEFINFO | | FMOD_EVENT_SOUNDDEFINFO | |
| FMOD_EVENT_INITFLAGS | | FMOD_EVENT_INITFLAGS | |
| EventSystem::update | | EventSystem::update | |
| ] | | ] | |
| */ | | */ | |
| typedef enum | | typedef enum | |
| | | | |
| skipping to change at line 443 | | skipping to change at line 453 | |
| | | | |
| /* | | /* | |
| [STRUCTURE] | | [STRUCTURE] | |
| [ | | [ | |
| [DESCRIPTION] | | [DESCRIPTION] | |
| Structure containing realtime information about a wavebank. | | Structure containing realtime information about a wavebank. | |
| | | | |
| [REMARKS] | | [REMARKS] | |
| | | | |
| [PLATFORMS] | | [PLATFORMS] | |
|
| Win32, Win64, Linux, Linux64, Macintosh, Xbox, Xbox360, PlayStation 2,
GameCube, PlayStation Portable, PlayStation 3 | | Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable,
PlayStation 3, Wii, iPhone, 3GS, NGP, Android | |
| | | | |
| [SEE_ALSO] | | [SEE_ALSO] | |
| EventSystem::getInfo | | EventSystem::getInfo | |
| FMOD_EVENT_SYSTEMINFO | | FMOD_EVENT_SYSTEMINFO | |
| ] | | ] | |
| */ | | */ | |
| typedef struct FMOD_EVENT_WAVEBANKINFO | | typedef struct FMOD_EVENT_WAVEBANKINFO | |
| { | | { | |
| char name[256]; /* [out] Name of this wave bank. *
/ | | char name[256]; /* [out] Name of this wave bank. *
/ | |
| int streamrefcnt; /* [out] Number of stream referenc
es to this wave bank made by events in this event system. */ | | int streamrefcnt; /* [out] Number of stream referenc
es to this wave bank made by events in this event system. */ | |
| | | | |
| skipping to change at line 477 | | skipping to change at line 487 | |
| Structure containing realtime information about an event system. | | Structure containing realtime information about an event system. | |
| | | | |
| [REMARKS] | | [REMARKS] | |
| On entry, numplayingevents should be set to the number of elements in t
he playingevents array. If the actual | | On entry, numplayingevents should be set to the number of elements in t
he playingevents array. If the actual | |
| number of playing events is greater than numplayingevents then the play
ingevents array will be filled with | | number of playing events is greater than numplayingevents then the play
ingevents array will be filled with | |
| numplayingevents entries and numplayingevents will be set to the actual
number of playing events on exit. | | numplayingevents entries and numplayingevents will be set to the actual
number of playing events on exit. | |
| In short, if numplayingevents on exit > numplayingevents on entry then
the playingevents array wasn't large | | In short, if numplayingevents on exit > numplayingevents on entry then
the playingevents array wasn't large | |
| enough and some events were unable to be added to the array. | | enough and some events were unable to be added to the array. | |
| | | | |
| [PLATFORMS] | | [PLATFORMS] | |
|
| Win32, Win64, Linux, Linux64, Macintosh, Xbox, Xbox360, PlayStation 2,
GameCube, PlayStation Portable, PlayStation 3 | | Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable,
PlayStation 3, Wii, iPhone, 3GS, NGP, Android | |
| | | | |
| [SEE_ALSO] | | [SEE_ALSO] | |
| EventSystem::getInfo | | EventSystem::getInfo | |
| EventProject::getInfo | | EventProject::getInfo | |
| FMOD_EVENT_WAVEBANKINFO | | FMOD_EVENT_WAVEBANKINFO | |
| ] | | ] | |
| */ | | */ | |
| typedef struct FMOD_EVENT_SYSTEMINFO | | typedef struct FMOD_EVENT_SYSTEMINFO | |
| { | | { | |
| #ifdef __cplusplus | | #ifdef __cplusplus | |
| FMOD_EVENT_SYSTEMINFO() : numevents(0), numinstances(0), maxwavebanks(0
), wavebankinfo(0), numplayingevents(0), playingevents(0) {} | | FMOD_EVENT_SYSTEMINFO() : numevents(0), numinstances(0), maxwavebanks(0
), wavebankinfo(0), numplayingevents(0), playingevents(0) {} | |
| #endif | | #endif | |
| | | | |
|
| int numevents; /* [out] Total number of eve | | int numevents; /* [out] Total number of e | |
| nts in all event groups in this event system. */ | | vents in all event groups in this event system. */ | |
| int numinstances; /* [out] Total number of eve | | int numinstances; /* [out] Total number of e | |
| nt instances in all event groups in this event system. */ | | vent instances in all event groups in this event system. */ | |
| int maxwavebanks; /* [in/out] Out, number of w | | int maxwavebanks; /* [in/out] Out, number of | |
| avebanks loaded by the EventSystem. In. Maximum size of array of wavebanki | | wavebanks loaded by the EventSystem. In. Maximum size of array of waveban | |
| nfo structures supplied by user. Optional. */ | | kinfo structures supplied by user. Optional. */ | |
| FMOD_EVENT_WAVEBANKINFO *wavebankinfo; /* [in] Pointer to array FMO | | FMOD_EVENT_WAVEBANKINFO *wavebankinfo; /* [in] Pointer to array F | |
| D_EVENT_WAVEBANKINFO structures (max size defined by maxwavebanks). FMOD w | | MOD_EVENT_WAVEBANKINFO structures (max size defined by maxwavebanks). FMOD | |
| ill fill these in with detailed information on each wave bank. Optional. */ | | will fill these in with detailed information on each wave bank. Optional. | |
| int numplayingevents; /* [in/out] On entry, maximu | | */ | |
| m number of entries in playingevents array. On exit, actual number of entri | | int numplayingevents; /* [in/out] On entry, maxi | |
| es in playingevents array, or if playingevents is null, then it is just the | | mum number of entries in playingevents array. On exit, actual number of ent | |
| number of currently playing events. Optional. */ | | ries in playingevents array, or if playingevents is null, then it is just t | |
| FMOD_EVENT **playingevents; /* [in/out] Pointer to an ar | | he number of currently playing events. Optional. */ | |
| ray that will be filled with the event handles of all playing events. Optio | | FMOD_EVENT **playingevents; /* [in/out] Pointer to an | |
| nal. Specify 0 if not needed. Must be used in conjunction with numplayingev | | array that will be filled with the event handles of all playing events. Opt | |
| ents. */ | | ional. Specify 0 if not needed. Must be used in conjunction with numplaying | |
| int numloadsqueued; /* [out] Current number of s | | events. */ | |
| ound banks queued for loading due to using FMOD_EVENT_NONBLOCKING flag. */ | | int numloadsqueued[5]; /* [out] Current number of | |
| | | sound banks queued for loading due to using FMOD_EVENT_NONBLOCKING flag. | |
| | | Note there are 5 because there are 5 possible loading threads. Add all val | |
| | | ues together for total. */ | |
| } FMOD_EVENT_SYSTEMINFO; | | } FMOD_EVENT_SYSTEMINFO; | |
| | | | |
| /* | | /* | |
| [STRUCTURE] | | [STRUCTURE] | |
| [ | | [ | |
| [DESCRIPTION] | | [DESCRIPTION] | |
| Structure containing realtime information about an event project. | | Structure containing realtime information about an event project. | |
| | | | |
| [REMARKS] | | [REMARKS] | |
| On entry, numplayingevents should be set to the number of elements in t
he playingevents array. If the actual | | On entry, numplayingevents should be set to the number of elements in t
he playingevents array. If the actual | |
| number of playing events is greater than numplayingevents then the play
ingevents array will be filled with | | number of playing events is greater than numplayingevents then the play
ingevents array will be filled with | |
| numplayingevents entries and numplayingevents will be set to the actual
number of playing events on exit. | | numplayingevents entries and numplayingevents will be set to the actual
number of playing events on exit. | |
| In short, if numplayingevents on exit > numplayingevents on entry then
the playingevents array wasn't large | | In short, if numplayingevents on exit > numplayingevents on entry then
the playingevents array wasn't large | |
| enough and some events were unable to be added to the array. | | enough and some events were unable to be added to the array. | |
| | | | |
| [PLATFORMS] | | [PLATFORMS] | |
|
| Win32, Win64, Linux, Linux64, Macintosh, Xbox, Xbox360, PlayStation 2,
GameCube, PlayStation Portable, PlayStation 3 | | Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable,
PlayStation 3, Wii, iPhone, 3GS, NGP, Android | |
| | | | |
| [SEE_ALSO] | | [SEE_ALSO] | |
| EventProject::getInfo | | EventProject::getInfo | |
| EventSystem::getInfo | | EventSystem::getInfo | |
| FMOD_EVENT_WAVEBANKINFO | | FMOD_EVENT_WAVEBANKINFO | |
| ] | | ] | |
| */ | | */ | |
| typedef struct FMOD_EVENT_PROJECTINFO | | typedef struct FMOD_EVENT_PROJECTINFO | |
| { | | { | |
| #ifdef __cplusplus | | #ifdef __cplusplus | |
| | | | |
| skipping to change at line 551 | | skipping to change at line 560 | |
| [STRUCTURE] | | [STRUCTURE] | |
| [ | | [ | |
| [DESCRIPTION] | | [DESCRIPTION] | |
| Structure containing extended information about an event. | | Structure containing extended information about an event. | |
| | | | |
| [REMARKS] | | [REMARKS] | |
| This structure is optional! Specify 0 or NULL in Event::getInfo if you
don't need it!<br> | | This structure is optional! Specify 0 or NULL in Event::getInfo if you
don't need it!<br> | |
| This structure has members that need to be initialized before Event::ge
tInfo is called. Always initialize this structure before calling Event::get
Info! | | This structure has members that need to be initialized before Event::ge
tInfo is called. Always initialize this structure before calling Event::get
Info! | |
| | | | |
| [PLATFORMS] | | [PLATFORMS] | |
|
| Win32, Win64, Linux, Linux64, Macintosh, Xbox, Xbox360, PlayStation 2,
GameCube, PlayStation Portable, PlayStation 3 | | Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable,
PlayStation 3, Wii, iPhone, 3GS, NGP, Android | |
| | | | |
| [SEE_ALSO] | | [SEE_ALSO] | |
| Event::getInfo | | Event::getInfo | |
| FMOD_GUID | | FMOD_GUID | |
| ] | | ] | |
| */ | | */ | |
| typedef struct FMOD_EVENT_INFO | | typedef struct FMOD_EVENT_INFO | |
| { | | { | |
| #ifdef __cplusplus | | #ifdef __cplusplus | |
| FMOD_EVENT_INFO() : memoryused(0), positionms(0), lengthms(0), channels
playing(0), instancesactive(0), maxwavebanks(0), wavebankinfo(0), projectid
(0), systemid(0), audibility(0), numinstances(0), instances(0), guid(0) {} | | FMOD_EVENT_INFO() : memoryused(0), positionms(0), lengthms(0), channels
playing(0), instancesactive(0), maxwavebanks(0), wavebankinfo(0), projectid
(0), systemid(0), audibility(0), numinstances(0), instances(0), guid(0) {} | |
| | | | |
| skipping to change at line 589 | | skipping to change at line 598 | |
| | | | |
| /* | | /* | |
| [ENUM] | | [ENUM] | |
| [ | | [ | |
| [DESCRIPTION] | | [DESCRIPTION] | |
| Sound definition entry types for FMOD_EVENT_SOUNDDEFINFO. | | Sound definition entry types for FMOD_EVENT_SOUNDDEFINFO. | |
| | | | |
| [REMARKS] | | [REMARKS] | |
| | | | |
| [PLATFORMS] | | [PLATFORMS] | |
|
| Win32, Win64, Linux, Macintosh, Xbox, Xbox360, PlayStation 2, GameCube,
PlayStation Portable, PlayStation 3, Wii, Wii | | Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable,
PlayStation 3, Wii, iPhone, 3GS, NGP, Android | |
| | | | |
| [SEE_ALSO] | | [SEE_ALSO] | |
| FMOD_EVENT_SOUNDDEFINFO | | FMOD_EVENT_SOUNDDEFINFO | |
| FMOD_EVENT_CALLBACK | | FMOD_EVENT_CALLBACK | |
| FMOD_EVENT_CALLBACKTYPE | | FMOD_EVENT_CALLBACKTYPE | |
| ] | | ] | |
| */ | | */ | |
| typedef enum | | typedef enum | |
| { | | { | |
| FMOD_EVENT_SOUNDDEF_ENTRYTYPE_WAVETABLE, /* Waveform. */ | | FMOD_EVENT_SOUNDDEF_ENTRYTYPE_WAVETABLE, /* Waveform. */ | |
| | | | |
| skipping to change at line 617 | | skipping to change at line 626 | |
| [ | | [ | |
| [DESCRIPTION] | | [DESCRIPTION] | |
| Structure containing information about a sound definition. | | Structure containing information about a sound definition. | |
| | | | |
| [REMARKS] | | [REMARKS] | |
| This structure is passed as the param1 argument of all | | This structure is passed as the param1 argument of all | |
| FMOD_EVENT_CALLBACKTYPE_SOUNDDEF_SELECTINDEX callbacks if | | FMOD_EVENT_CALLBACKTYPE_SOUNDDEF_SELECTINDEX callbacks if | |
| FMOD_EVENT_INIT_DETAILED_SOUNDDEF_INFO was passed to EventSystem::init. | | FMOD_EVENT_INIT_DETAILED_SOUNDDEF_INFO was passed to EventSystem::init. | |
| | | | |
| [PLATFORMS] | | [PLATFORMS] | |
|
| Win32, Win64, Linux, Linux64, Macintosh, Xbox, Xbox360, PlayStation 2,
GameCube, PlayStation Portable, PlayStation 3 | | Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable,
PlayStation 3, Wii, iPhone, 3GS, NGP, Android | |
| | | | |
| [SEE_ALSO] | | [SEE_ALSO] | |
| FMOD_EVENT_CALLBACK | | FMOD_EVENT_CALLBACK | |
| FMOD_EVENT_CALLBACKTYPE | | FMOD_EVENT_CALLBACKTYPE | |
| EventSystem::init | | EventSystem::init | |
| FMOD_EVENT_INITFLAGS | | FMOD_EVENT_INITFLAGS | |
| FMOD_EVENT_SOUNDDEF_ENTRYTYPE | | FMOD_EVENT_SOUNDDEF_ENTRYTYPE | |
| ] | | ] | |
| */ | | */ | |
| typedef struct FMOD_EVENT_SOUNDDEFINFO | | typedef struct FMOD_EVENT_SOUNDDEFINFO | |
| | | | |
| skipping to change at line 654 | | skipping to change at line 663 | |
| Use this structure with EventSystem::load when more control is needed o
ver loading. | | Use this structure with EventSystem::load when more control is needed o
ver loading. | |
| | | | |
| [REMARKS] | | [REMARKS] | |
| This structure is optional! Specify 0 or NULL in EventSystem::load if
you don't need it!<br> | | This structure is optional! Specify 0 or NULL in EventSystem::load if
you don't need it!<br> | |
| <br> | | <br> | |
| Members marked with [in] mean the user sets the value before passing it
to the function.<br> | | Members marked with [in] mean the user sets the value before passing it
to the function.<br> | |
| Members marked with [out] mean FMOD sets the value to be used after the
function exits.<br> | | Members marked with [out] mean FMOD sets the value to be used after the
function exits.<br> | |
| Use sounddefentrylimit to limit the number of sound definition entries
- and therefore the amount of wave data - loaded for each sound definition.
This feature allows the programmer to implement a "low detail" setting at
runtime without needing a seperate "low detail" set of assets. | | Use sounddefentrylimit to limit the number of sound definition entries
- and therefore the amount of wave data - loaded for each sound definition.
This feature allows the programmer to implement a "low detail" setting at
runtime without needing a seperate "low detail" set of assets. | |
| | | | |
| [PLATFORMS] | | [PLATFORMS] | |
|
| Win32, Win64, Linux, Linux64, Macintosh, Xbox, Xbox360, PlayStation 2,
GameCube, PlayStation Portable, PlayStation 3 | | Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable,
PlayStation 3, Wii, iPhone, 3GS, NGP, Android | |
| | | | |
| [SEE_ALSO] | | [SEE_ALSO] | |
| EventSystem::load | | EventSystem::load | |
| ] | | ] | |
| */ | | */ | |
| typedef struct FMOD_EVENT_LOADINFO | | typedef struct FMOD_EVENT_LOADINFO | |
| { | | { | |
| #ifdef __cplusplus | | #ifdef __cplusplus | |
| FMOD_EVENT_LOADINFO() : size(0), encryptionkey(0), sounddefentrylimit(0
), loadfrommemory_length(0), override_category_vals(0), sizeof_instancepool
_simple(0) {} | | FMOD_EVENT_LOADINFO() : size(0), encryptionkey(0), sounddefentrylimit(0
), loadfrommemory_length(0), override_category_vals(0), sizeof_instancepool
_simple(0) {} | |
| #endif | | #endif | |
| | | | |
| skipping to change at line 687 | | skipping to change at line 696 | |
| /* | | /* | |
| [ENUM] | | [ENUM] | |
| [ | | [ | |
| [DESCRIPTION] | | [DESCRIPTION] | |
| These callback types are used with FMOD_EVENTQUEUE_CALLBACK. | | These callback types are used with FMOD_EVENTQUEUE_CALLBACK. | |
| | | | |
| [REMARKS] | | [REMARKS] | |
| <b>Note!</b> Currently the user must call EventSystem::update for these
callbacks to trigger!<p> | | <b>Note!</b> Currently the user must call EventSystem::update for these
callbacks to trigger!<p> | |
| | | | |
| [PLATFORMS] | | [PLATFORMS] | |
|
| Win32, Win64, Linux, Macintosh, Xbox, Xbox360, PlayStation 2, GameCube,
PlayStation Portable, PlayStation 3, Wii | | Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable,
PlayStation 3, Wii, iPhone, 3GS, NGP, Android | |
| | | | |
| [SEE_ALSO] | | [SEE_ALSO] | |
| EventQueue::setCallback | | EventQueue::setCallback | |
| FMOD_EVENTQUEUE_CALLBACK | | FMOD_EVENTQUEUE_CALLBACK | |
| EventSystem::update | | EventSystem::update | |
| ] | | ] | |
| */ | | */ | |
| typedef enum | | typedef enum | |
| { | | { | |
| FMOD_EVENTQUEUE_CALLBACKTYPE_PREPARE, /* Called when an entry is
being prepared for playback */ | | FMOD_EVENTQUEUE_CALLBACKTYPE_PREPARE, /* Called when an entry is
being prepared for playback */ | |
| | | | |
| skipping to change at line 715 | | skipping to change at line 724 | |
| | | | |
| /* | | /* | |
| [STRUCTURE] | | [STRUCTURE] | |
| [ | | [ | |
| [DESCRIPTION] | | [DESCRIPTION] | |
| Structure containing realtime information about the music system. | | Structure containing realtime information about the music system. | |
| | | | |
| [REMARKS] | | [REMARKS] | |
| | | | |
| [PLATFORMS] | | [PLATFORMS] | |
|
| Win32, Win64, Linux, Linux64, Macintosh, Xbox, Xbox360, PlayStation 2,
GameCube, PlayStation Portable, PlayStation 3 | | Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable,
PlayStation 3, Wii, iPhone, 3GS, NGP, Android | |
| | | | |
| [SEE_ALSO] | | [SEE_ALSO] | |
| MusicSystem::getInfo | | MusicSystem::getInfo | |
| ] | | ] | |
| */ | | */ | |
| typedef struct FMOD_MUSIC_INFO | | typedef struct FMOD_MUSIC_INFO | |
| { | | { | |
| FMOD_BOOL starving; /* [out] True if any stream
s in the music system are starving. */ | | FMOD_BOOL starving; /* [out] True if any stream
s in the music system are starving. */ | |
| FMOD_BOOL all_samples_loaded; /* [out] True if all non-st
reaming samples in the music system are loaded, false otherwise. */ | | FMOD_BOOL all_samples_loaded; /* [out] True if all non-st
reaming samples in the music system are loaded, false otherwise. */ | |
| } FMOD_MUSIC_INFO; | | } FMOD_MUSIC_INFO; | |
| | | | |
| /* | | /* | |
| [STRUCTURE] | | [STRUCTURE] | |
| [ | | [ | |
| [DESCRIPTION] | | [DESCRIPTION] | |
| Structure used to hold information about music system entites. | | Structure used to hold information about music system entites. | |
| | | | |
| [REMARKS] | | [REMARKS] | |
| | | | |
| [PLATFORMS] | | [PLATFORMS] | |
|
| Win32, Win64, Linux, Linux64, Macintosh, Xbox, Xbox360, PlayStation 2,
GameCube, PlayStation Portable, PlayStation 3 | | Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable,
PlayStation 3, Wii, iPhone, 3GS, NGP, Android | |
| | | | |
| [SEE_ALSO] | | [SEE_ALSO] | |
| FMOD_MUSIC_ITERATOR | | FMOD_MUSIC_ITERATOR | |
| ] | | ] | |
| */ | | */ | |
| typedef struct FMOD_MUSIC_ENTITY | | typedef struct FMOD_MUSIC_ENTITY | |
| { | | { | |
| const char* name; /* The name of the music ent
ity as a null terminated string. */ | | const char* name; /* The name of the music ent
ity as a null terminated string. */ | |
| FMOD_MUSIC_ID id; /* The ID of the music entit
y. */ | | FMOD_MUSIC_ID id; /* The ID of the music entit
y. */ | |
|
| | | | |
| } FMOD_MUSIC_ENTITY; | | } FMOD_MUSIC_ENTITY; | |
| | | | |
| /* | | /* | |
| [STRUCTURE] | | [STRUCTURE] | |
| [ | | [ | |
| [DESCRIPTION] | | [DESCRIPTION] | |
| Structure used to enumerate entities in the music system. | | Structure used to enumerate entities in the music system. | |
| | | | |
| [REMARKS] | | [REMARKS] | |
| The music system provides methods to initialize and advance iterators.
Iterator members should never need to be set manually. | | The music system provides methods to initialize and advance iterators.
Iterator members should never need to be set manually. | |
| | | | |
| skipping to change at line 759 | | skipping to change at line 767 | |
| /* | | /* | |
| [STRUCTURE] | | [STRUCTURE] | |
| [ | | [ | |
| [DESCRIPTION] | | [DESCRIPTION] | |
| Structure used to enumerate entities in the music system. | | Structure used to enumerate entities in the music system. | |
| | | | |
| [REMARKS] | | [REMARKS] | |
| The music system provides methods to initialize and advance iterators.
Iterator members should never need to be set manually. | | The music system provides methods to initialize and advance iterators.
Iterator members should never need to be set manually. | |
| | | | |
| [PLATFORMS] | | [PLATFORMS] | |
|
| Win32, Win64, Linux, Linux64, Macintosh, Xbox, Xbox360, PlayStation 2,
GameCube, PlayStation Portable, PlayStation 3 | | Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable,
PlayStation 3, Wii, iPhone, 3GS, NGP, Android | |
| | | | |
| [SEE_ALSO] | | [SEE_ALSO] | |
| FMOD_MUSIC_ENTITY | | FMOD_MUSIC_ENTITY | |
| MusicSystem::getCues | | MusicSystem::getCues | |
| MusicSystem::getParameters | | MusicSystem::getParameters | |
| ] | | ] | |
| */ | | */ | |
| typedef struct FMOD_MUSIC_ITERATOR | | typedef struct FMOD_MUSIC_ITERATOR | |
| { | | { | |
| const FMOD_MUSIC_ENTITY* value; /* The music entity the iter
ator points to. A null value indicates an invalid iterator. */ | | const FMOD_MUSIC_ENTITY* value; /* The music entity the iter
ator points to. A null value indicates an invalid iterator. */ | |
| | | | |
| skipping to change at line 784 | | skipping to change at line 791 | |
| /* | | /* | |
| [STRUCTURE] | | [STRUCTURE] | |
| [ | | [ | |
| [DESCRIPTION] | | [DESCRIPTION] | |
| Structure containing information about a music sample, for use with | | Structure containing information about a music sample, for use with | |
| FMOD_MUSIC_CALLBACKTYPE_SEGMENT_CREATE and FMOD_MUSIC_CALLBACKTYPE_SEGM
ENT_RELEASE. | | FMOD_MUSIC_CALLBACKTYPE_SEGMENT_CREATE and FMOD_MUSIC_CALLBACKTYPE_SEGM
ENT_RELEASE. | |
| | | | |
| [REMARKS] | | [REMARKS] | |
| | | | |
| [PLATFORMS] | | [PLATFORMS] | |
|
| Win32, Win64, Linux, Linux64, Macintosh, Xbox, Xbox360, PlayStation 2,
GameCube, PlayStation Portable, PlayStation 3 | | Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable,
PlayStation 3, Wii, iPhone, 3GS, NGP, Android | |
| | | | |
| [SEE_ALSO] | | [SEE_ALSO] | |
| FMOD_MUSIC_CALLBACK | | FMOD_MUSIC_CALLBACK | |
| FMOD_MUSIC_CALLBACKTYPE | | FMOD_MUSIC_CALLBACKTYPE | |
| ] | | ] | |
| */ | | */ | |
| typedef struct FMOD_MUSIC_SAMPLE_INFO | | typedef struct FMOD_MUSIC_SAMPLE_INFO | |
| { | | { | |
| unsigned int segment_id; /* The ID of the parent segment. */ | | unsigned int segment_id; /* The ID of the parent segment. */ | |
| unsigned int index; /* The index of the sample within the paren
t segment. */ | | unsigned int index; /* The index of the sample within the paren
t segment. */ | |
| | | | |
| skipping to change at line 808 | | skipping to change at line 815 | |
| /* | | /* | |
| [STRUCTURE] | | [STRUCTURE] | |
| [ | | [ | |
| [DESCRIPTION] | | [DESCRIPTION] | |
| Structure containing information about a music segment, for use with | | Structure containing information about a music segment, for use with | |
| FMOD_MUSIC_CALLBACKTYPE_CHANNEL_CREATED and FMOD_MUSIC_CALLBACKTYPE_CHA
NNEL_DESTROYED. | | FMOD_MUSIC_CALLBACKTYPE_CHANNEL_CREATED and FMOD_MUSIC_CALLBACKTYPE_CHA
NNEL_DESTROYED. | |
| | | | |
| [REMARKS] | | [REMARKS] | |
| | | | |
| [PLATFORMS] | | [PLATFORMS] | |
|
| Win32, Win64, Linux, Linux64, Macintosh, Xbox, Xbox360, PlayStation 2,
GameCube, PlayStation Portable, PlayStation 3 | | Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable,
PlayStation 3, Wii, iPhone, 3GS, NGP, Android | |
| | | | |
| [SEE_ALSO] | | [SEE_ALSO] | |
| FMOD_MUSIC_CALLBACK | | FMOD_MUSIC_CALLBACK | |
| FMOD_MUSIC_CALLBACKTYPE | | FMOD_MUSIC_CALLBACKTYPE | |
| ] | | ] | |
| */ | | */ | |
| typedef struct FMOD_MUSIC_SEGMENT_INFO | | typedef struct FMOD_MUSIC_SEGMENT_INFO | |
| { | | { | |
| unsigned int segment_id; /* The ID of the segment. */ | | unsigned int segment_id; /* The ID of the segment. */ | |
| unsigned int theme_id; /* The ID of the parent theme. */ | | unsigned int theme_id; /* The ID of the parent theme. */ | |
| | | | |
| skipping to change at line 831 | | skipping to change at line 838 | |
| /* | | /* | |
| [ENUM] | | [ENUM] | |
| [ | | [ | |
| [DESCRIPTION] | | [DESCRIPTION] | |
| These callback types are used with FMOD_MUSIC_CALLBACK. | | These callback types are used with FMOD_MUSIC_CALLBACK. | |
| | | | |
| [REMARKS] | | [REMARKS] | |
| <b>Note!</b> Currently the user must call EventSystem::update for thes
e callbacks to trigger!<br /> | | <b>Note!</b> Currently the user must call EventSystem::update for thes
e callbacks to trigger!<br /> | |
| | | | |
| [PLATFORMS] | | [PLATFORMS] | |
|
| Win32, Win64, Linux, Macintosh, Xbox, Xbox360, PlayStation 2, GameCube,
PlayStation Portable, PlayStation 3, Wii, Wii | | Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable,
PlayStation 3, Wii, iPhone, 3GS, NGP, Android | |
| | | | |
| [SEE_ALSO] | | [SEE_ALSO] | |
| MusicSystem::setCallback | | MusicSystem::setCallback | |
| FMOD_MUSIC_CALLBACK | | FMOD_MUSIC_CALLBACK | |
| EventSystem::update | | EventSystem::update | |
| ] | | ] | |
| */ | | */ | |
| typedef enum | | typedef enum | |
| { | | { | |
| FMOD_MUSIC_CALLBACKTYPE_SEGMENT_START, /* Called when a segment i
s started. */ | | FMOD_MUSIC_CALLBACKTYPE_SEGMENT_START, /* Called when a segment i
s started. */ | |
| | | | |
End of changes. 27 change blocks. |
| 45 lines changed or deleted | | 67 lines changed or added | |
|