Configuration structure for creating an ASR rackThis structure is used for specifying the behavior of the ASR (Atom Sound Renderer).
This structure is specified as an argument of the criAtomExAsrRack_Create function.
More...

#include <cri_le_atom_asr.h>

Data Fields
CriFloat32	server_frequency
	Execution frequency of server processing. 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...

CriAtomExAsrRackId	output_rack_id
	Destination ASR Rack ID. More...

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

Detailed Description

Configuration structure for creating an ASR rack

This structure is used for specifying the behavior of the ASR (Atom Sound Renderer).
This structure is specified as an argument of the criAtomExAsrRack_Create function.

Note:: When using default settings, set default parameters for the structure using the criAtomExAsrRack_SetDefaultConfig macro, and then specify the structure for the criAtomExAsrRack_Create function.

Attention: More members will be added in the future. Therefore, when the criAtomExAsrRack_SetDefaultConfig macro is not used, make sure to initialize the structure to zero before using it.
(A structure member must not be set to an undefined value.)

See also: criAtomExAsrRack_Create, criAtomExAsrRack_SetDefaultConfig

Field Documentation

◆ server_frequency

CriFloat32 server_frequency

Execution frequency of server processing.

Description:: Specifies how often server processing are executed.

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

See also: CriAtomConfig

◆ num_buses

CriSint32 num_buses

Number of buses.

Description:: Specifies the number of the buses created by the ASR.
The buses mix sounds and manage effects.

◆ output_channels

CriSint32 output_channels

Number of output channels.

Description:: Specifies the number of output channels for the ASR rack.
Specify six or more channels when the Pan 3D or 3D positioning feature 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 at the ASR rack.
Usually, specify the sampling rate of the sound device of the target.

Note:: A smaller value reduces the processing load but it also degrades the sound quality.

◆ sound_renderer_type

CriAtomSoundRendererType sound_renderer_type

Sound renderer type.

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

◆ output_rack_id

CriAtomExAsrRackId output_rack_id

Destination ASR Rack ID.

Description:: Specifies the ID of the destination ASR rack.
It is valid only if sound_renderer_type is set to CRIATOM_SOUND_RENDERER_ASR .

◆ 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.

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

cri_le_atom_asr.h

Data Fields