Configuration structure for initializing ASRThis structure is used for specifying the behavior of the software sound renderer ASR.
This structure is specified as an argument of the criAtomExAsr_Initialize function.
More...

#include <cri_le_atom_asr.h>

Data Fields
CriFloat32	server_frequency
	Execution frequency of server process. More...

CriSint32	num_buses
	Number of buses. More...

CriSint32	output_channels
	Number of output channels. More...

CriAtomSpeakerMapping	speaker_mapping
	Mixer speaker mapping. More...

CriSint32	output_sampling_rate
	Output sampling rate. More...

CriAtomSoundRendererType	sound_renderer_type
	Sound renderer type. More...

void *	context
	Pointer to platform-specific parameters. More...

CriSint32	max_racks
	Maximum number of ASR racks. More...

CriAtomAmbisonicsOrderType	ambisonics_order_type
	Ambisonics order type（廃止） More...

Detailed Description

Configuration structure for initializing ASR

This structure is used for specifying the behavior of the software sound renderer ASR.
This structure is specified as an argument of the criAtomExAsr_Initialize function.

Remarks:: When using default settings, after setting default parameters for the structure using the criAtomExAsr_SetDefaultConfig macro, set the structure to the criAtomExAsr_Initialize function.

Attention: More members will be added in the future. So, when not using the criAtomExAsr_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.)

See also: criAtomExAsr_Initialize, criAtomExAsr_SetDefaultConfig

Field Documentation

◆ server_frequency

CriFloat32 server_frequency

Execution frequency of server process.

Description:: Specifies the execution frequency of the server process.

Attention: Set the same value as the one (server_frequency of the CriAtomExConfig structure) set at the initialization of the Atom library.

See also: CriAtomConfig

◆ num_buses

CriSint32 num_buses

Number of buses.

Description:: Specifies the number of buses created by ASR.
Buses mix sounds, manage effects, and perform other tasks.
Be sure to set a value of 1 or greater to include one master bus area.

◆ output_channels

CriSint32 output_channels

Number of output channels.

Description:: Specifies the number of output channels for ASR.
Specify 6 or more channels when the Pan3D or 3D positioning function is used.

◆ speaker_mapping

CriAtomSpeakerMapping speaker_mapping

Mixer speaker mapping.

Description:: Specifies speaker mapping for the ASR rack.

◆ output_sampling_rate

CriSint32 output_sampling_rate

Output sampling rate.

Description:: Specifies the sampling rate used for output and other processes.
Usually, specify the sampling rate of the sound device of the target.

Remarks:: By decreasing the value, processing load can be reduced but the sound quality is degraded.

◆ sound_renderer_type

CriAtomSoundRendererType sound_renderer_type

Sound renderer type.

Description:: Specifies the type of output destination sound renderer for ASR.
If you specify CRIATOM_SOUND_RENDERER_NATIVE for sound_renderer_type, audio data are transferred to the default sound output of each platform.

Attention: Do not specify CRIATOM_SOUND_RENDERER_ASR and CRIATOM_SOUND_RENDERER_DEFAULT.

◆ context

void* context

Pointer to platform-specific parameters.

Description:: Specifies the pointer to platform-specific parameters. If NULL is specified, an ASR is created with default parameters for each platform.
Parameter structures are defined in each platform-specific header. If parameter structures are not defined for a platform, always specify NULL.

◆ max_racks

CriSint32 max_racks

Maximum number of ASR racks.

Description:: Maximum number of the ASR racks that can be created.

◆ ambisonics_order_type

CriAtomAmbisonicsOrderType ambisonics_order_type

Ambisonics order type（廃止）

Description:: This member variable is deprecated and should not be used.
To play Ambisonics, use CRIATOM_SOUND_RENDERER_AMBISONICS .
See the manual for more information.

The documentation for this struct was generated from the following file:

cri_le_atom_asr.h

Data Fields