ASR initialization configuration structureThis is a structure to specify the behavior of the software sound renderer ASR.
This structure is specified as an argument of the criAtomAsr_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

ASR initialization configuration structure

This is a structure to specify the behavior of the software sound renderer ASR.
This structure is specified as an argument of the criAtomAsr_Initialize function.

Remarks:: When using default settings, after setting default parameters for the structure using the criAtomAsr_SetDefaultConfig macro, specify the structure in the criAtomAsr_Initialize function.

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

Field Documentation

◆ server_frequency

CriFloat32 server_frequency

Execution frequency of server process.

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

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

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.

◆ output_channels

CriSint32 output_channels

Number of output channels.

Description:: Specifies the number of ASR output channels.
Specify at least 6 channels when using the pan 3D or 3D positioning function.

◆ 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 for output and processing.
Normally, specify the sampling rate of the target machine's sound device.

Remarks:: Lowering this value reduces the processing load but also degrades the sound quality.

◆ sound_renderer_type

CriAtomSoundRendererType sound_renderer_type

Sound renderer type.

Description:: Specifies the type of ASR output sound renderer.
If you specify CRIATOM_SOUND_RENDERER_NATIVE as sound_renderer_type, audio data is sent to sound output of each default platform.

Attention: Do not specify CRIATOM_SOUND_RENDERER_ASR or CRIATOM_SOUND_RENDERER_DEFAULT .

◆ context

void* context

Pointer to platform-specific parameters.

Description:: Specify a pointer to a platform-specific parameter. When NULL is specified, ASR rack is created with default parameters for each platform.
The parameter structure is defined in each platform specific header. Always specify NULL on platforms where no parameter structure is defined.

◆ max_racks

CriSint32 max_racks

Maximum number of ASR racks.

Description:: The maximum number of ASR racks that can be created.

◆ ambisonics_order_type

CriAtomAmbisonicsOrderType ambisonics_order_type

Ambisonics order type.

Description:: When the Atom library plays Ambisonics, it sets which order type to use.

Remarks:: For platforms that are not compatible with Ambisonics playback, this value is ignored.
Also, if you specify CRIATOMAMBISONICS_ORDER_TYPE_NONE , Ambisonics will not play.

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

cri_le_atom_asr.h

Data Fields