CriAtomHcaMxConfigTag结构体 参考

HCA-MX initialization configuration structureThis structure is used for specifying the behavior of the HCA-MX.
This structure is specified as an argument of the ::criAtomHcaMx_Initialize function.
更多...

#include <cri_le_atom.h>

成员变量
CriFloat32	server_frequency
	Execution frequency of server process 更多...
CriSint32	num_mixers
	Number of mixers 更多...
CriSint32	max_players
	Maximum number of players that can be registered with a mixer 更多...
CriSint32	max_input_channels
	Maximum number of input data channels 更多...
CriSint32	max_sampling_rate
	Maximum sampling rate 更多...
CriSint32	output_channels
	Number of output channels 更多...
CriSint32	output_sampling_rate
	Output sampling rate 更多...
CriAtomSoundRendererType	sound_renderer_type
	Sound renderer type 更多...

详细描述

HCA-MX initialization configuration structure

This structure is used for specifying the behavior of the HCA-MX.
This structure is specified as an argument of the ::criAtomHcaMx_Initialize function.

Remarks:

When using default settings, after setting default parameters for the structure using the ::criAtomHcaMx_SetDefaultConfig macro, specify the structure in the ::criAtomHcaMx_Initialize function.

注意

More members will be added in the future. So, when not using the ::criAtomHcaMx_SetDefaultConfig macro, make sure to initialize the structure to zero before using it.
(Make sure that no indefinite value is set to any member of the structure.)

参见

criAtomHcaMx_Initialize, criAtomHcaMx_SetDefaultConfig

结构体成员变量说明

server_frequency

CriFloat32 server_frequency

Execution frequency of server process

Description:

Specifies the execution frequency of the server process.

注意

You must set the same value as the value specified during Atom library initialization (server_frequency in CriAtomConfig structure).

参见

CriAtomConfig

num_mixers

CriSint32 num_mixers

Number of mixers

Description:

Specifies the number of mixers to send the HCA-MX decode result.
By creating multiple mixers, different bus effect can be applied to each mixer.

注意

The load of HCA-MX decode process and normal process increase proportionally with the number of mixers.

max_players

CriSint32 max_players

Maximum number of players that can be registered with a mixer

Description:

Specifies the number of HCA-MX players that can be registered with a mixer.

max_input_channels

CriSint32 max_input_channels

Maximum number of input data channels

Description:

Specifies the maximum number of HCA-MX data channels played back in an application.
Specify 1 if the data played back is monophonic and 2 if it is sterophonic.

Remarks:

Audio data not exceeding max_input_channels specified during HCA-MX initialization can be played back.
For example, if max_input_channels is 6, in addition to 5.1ch audio, monophonic and sterophonic playback are also possible.
Even if 99 out of 100 data is monophonic and 1 is sterophonic, you must specify 2 for max_input_channels.

max_sampling_rate

CriSint32 max_sampling_rate

Maximum sampling rate

Description:

Specifies the maximum sampling rate that can be set to HCA-MX output.

Remarks:

For example, when specifying 2.0f for the ::criAtomHcaMx_SetFrequencyRatio function, set output_sampling_rate * 2 .

output_channels

CriSint32 output_channels

Number of output channels

Description:

Specifies the number of HCA-MX data output channels.
Normally, specify the number of speakers (maximum number output device of channels) connected to the target machine.

Remarks:

If playing only monophonic audio without pan control, processing load can be reduced by specifying 1 for output_channels.

注意

output_channels cannot be equal to or less than max_input_channels.

output_sampling_rate

CriSint32 output_sampling_rate

Output sampling rate

Description:

Specifies the sampling rate of HCA-MX data to play back.
HCA-MX does not allow changing of sampling rate per sound unit.
When creating HCA-MX data, create all audio data with the same sampling rate and specify that value for output_sampling_rate.

sound_renderer_type

CriAtomSoundRendererType sound_renderer_type

Sound renderer type

Description:

Specifies the type of HCA-MX output sound renderer.
If you specify CRIATOM_SOUND_RENDERER_DEFAULT as sound_renderer_type, audio data is sent to the default sound renderer.
If you specify CRIATOM_SOUND_RENDERER_NATIVE as sound_renderer_type, audio data is sent to sound output of each default platform.
If you specify CRIATOM_SOUND_RENDERER_ASR as sound_renderer_type, audio data is sent to ASR (Atom Sound Renderer).
(ASR output destination is specified during ASR initialization.)

---

该结构体的文档由以下文件生成:

• cri_le_atom.h