Configuration structure used to create sound objects.
More...
#include <cri_le_atom_ex.h>
Configuration structure used to create sound objects.
- Description
- Configuration structure used when creating a sound object.
It is passed to the criAtomExSoundObject_Create function.
Internal resources will be allocated for the sound object based on the value of the parameters of this structure.
In particular, the size of the work buffer required for the sound object depends on these parameters.
- Attention
- More members will be added in the future. Use the criAtomExSoundObject_SetDefaultConfig macro to set the default values before setting each member.
(Make sure that no member of the structure has an undefined value.)
- See also
- criAtomExSoundObject_Create, criAtomExSoundObject_SetDefaultConfig
◆ enable_voice_limit_scope
| CriBool enable_voice_limit_scope |
Enable voice limit scope.
- Description:
- Specifies whether to limit the number of playing voices by voice limit group independently with this sound object.
If CRI_TRUE is specified, the number of voices played back by AtomEx players
are counted only within this sound object and the number of voices is limited by voice limit groups.
If CRI_FALSE is specified, the number of voices is not limited by voice limit groups
and instead the number of voices is limited through the entire CRI Atom library.
- Remarks:
- The default value is CRI_FALSE (do not perform voice limiting by sound object).
◆ enable_category_cue_limit_scope
| CriBool enable_category_cue_limit_scope |
Enable category Cue limit scope.
- Description:
- Specifies whether to limit the number of Cues for playback by category independently with this sound object.
If CRI_TRUE is specified, the number of Cue categories played back by AtomEx players
are counted only within this sound object and the number for playback is limited.
If CRI_FALSE is specified, the number of Cues for playback is not limited by category
and instead the number of voices is limited by category for the entire CRI Atom library.
- Remarks:
- The default value is CRI_FALSE (do not perform category Cue limiting by sound object).
The documentation for this struct was generated from the following file:
