Configuration structure used to initialize HCA-MXThis is a structure for specifying the operation specifications of HCA-MX.
This is specified as an argument to the criAtomExHcaMx_Initialize function.
More...
#include <cri_le_atom_ex.h>
Configuration structure used to initialize HCA-MX
This is a structure for specifying the operation specifications of HCA-MX.
This is specified as an argument to the criAtomExHcaMx_Initialize function.
- Remarks:
- If you want to use the default settings, set the default parameters in a structure using the criAtomExHcaMx_SetDefaultConfig macro, then specify the structure in the criAtomExHcaMx_Initialize function.
- Attention
- More members will be added in the future. Therefore, if you are not using the criAtomExHcaMx_SetDefaultConfig macro, make sure to initialize the structure to zero before using it.
(Make sure that no member of the structure has an undefined value.)
- See also
- criAtomExHcaMx_Initialize, criAtomExHcaMx_SetDefaultConfig
◆ server_frequency
| CriFloat32 server_frequency |
Execution frequency of the server process.
- Description:
- Specifies the execution frequency of the server process.
- Attention
- Set the same value than for server_frequency in the CriAtomExConfig structure when you initialize the Atom library.
- See also
- CriAtomExConfig
◆ num_mixers
Number of mixers.
- Description:
- Specifies the number of mixers to which the HCA-MX decoding results are sent.
By creating multiple mixers, different DSP FX can be assigned to each of them.
- Attention
- The load of the HCA-MX decoding and processing will grow proportionally to the number of mixers.
A mixer will be created even if this parameter is set to 0.
(This is to maintain the compatibility with older versions.)
When HCA-MX is not used, set both this parameter and max_voices to 0.
◆ max_voices
Maximum number of voices that can be used with a mixer.
- Description:
- Specifies the maximum number of HCA-MX voices that can be used with a mixer.
When creating an HCA-MX Voice Pool, make sure the total number of voices does not exceed num_mixers x max_voices.
◆ max_input_channels
| CriSint32 max_input_channels |
Maximum number of channels of input data.
- Description:
- Specifies the maximum number of channels for the HCA-MX data played back by the application.
Specify 1 if the audio data is mono or 2 if it is stereo.
- Remarks:
- The number of sound buffers that can be played back simultaneously is less than or equal to the number specified for max_input_channels during the initialization of HCA-MX.
For example, if max_input_channels is set to 6, not only 5.1-channel sounds can be played but also mono and stereo sounds.
When you want to play back 99 mono buffers and one stereo buffer out of 100 sound buffers, you must set max_input_channels to 2.
◆ max_sampling_rate
| CriSint32 max_sampling_rate |
Maximum sampling rate.
- Description:
- Specifies the maximum sampling rate for the HCA-MX output.
It is used to change the pitch at the final mixer's output.
If you don't want to change the pitch, specify the same value than the output_sampling_rate.
- Remarks:
- For example, if you want to pass 2.0f to the criAtomExHcaMx_SetFrequencyRatio function to increase the pitch, you need to initialize HCA-MX by specifying output_sampling_rate * 2 here.
◆ output_channels
| CriSint32 output_channels |
Number of output channels.
- Description:
- Specifies the number of output channels for the HCA-MX data.
Usually, you should specify the number of speakers (maximum number of channels of the output device) connected to the target.
- Remarks:
- When only mono sounds are played back and panning is not controlled, the processing load can be reduced by setting output_channels to 1.
- Attention
- A value less than or equal to max_input_channels cannot be set for output_channels.
◆ output_sampling_rate
| CriSint32 output_sampling_rate |
Output sampling rate.
- Description:
- Specifies the sampling rate for the HCA-MX data.
When creating the HCA-MX data, always use the same sampling rate for all the audio data, and specify this value for output_sampling_rate.
- Remarks:
- With the HCA-MX codec, sampling rates cannot be changed individually for each sound.
◆ sound_renderer_type
Sound renderer type.
- Description:
- Specifies the output destination of the HCA-MX data.
If you specify CRIATOM_SOUND_RENDERER_DEFAULT for sound_renderer_type, the audio data will be transferred to the default sound renderer.
If you specify CRIATOM_SOUND_RENDERER_NATIVE for sound_renderer_type, the audio data will be transferred to the default sound output of each platform.
If you specify CRIATOM_SOUND_RENDERER_ASR for sound_renderer_type, the audio data will be transferred to the ASR (Atom Sound Renderer).
(The output destination of the ASR is specified separately, during the initialization of the ASR.)
The documentation for this struct was generated from the following file:
