CRI ADX  Last Updated: 2024-07-17 10:47 p
CriAtomExDspPitchShifterConfigTag Struct Reference

Configuration structure used to attach a pitch shifter effect. More...

#include <cri_le_atom_ex.h>

Data Fields

CriSint32 num_dsp
 Number of DSPs created. More...
 
CriSint32 max_channels
 Maximum number of channels for DSP. More...
 
CriSint32 max_sampling_rate
 Maximum sampling rate used for DSP. More...
 
CriAtomDspPitchShifterConfig specific
 Structure for DSP-specific settings. More...
 

Detailed Description

Configuration structure used to attach a pitch shifter effect.

Description:
Structure used to attach a pitch shifter to a Voice Pool.
Attention
More members will be added in the future, so if you are not using the criAtomExVoicePool_SetDefaultConfigForDspPitchShifter macro, make sure to initialize the whole structure to zero before using it.
(Make sure that no member of the structure has an undefined value.)
See also
criAtomExVoicePool_AttachDspPitchShifter, criAtomExVoicePool_CalculateWorkSizeForDspPitchShifter, criAtomExVoicePool_SetDefaultConfigForDspPitchShifter

Field Documentation

◆ num_dsp

CriSint32 num_dsp

Number of DSPs created.

Description:
Specify the same value here as the number of voices in the attached destination.

◆ max_channels

CriSint32 max_channels

Maximum number of channels for DSP.

Description:
Specifies the maximum number of channels that can be processed by a DSP.
Specify the same value here as the maximum number of channels (max_channels) in the player settings of a Voice Pool for the attached destination.

◆ max_sampling_rate

CriSint32 max_sampling_rate

Maximum sampling rate used for DSP.

Description:
Specifies the maximum sampling rate that can be processed by a DSP.
Specify the same value here as the maximum sampling rate (max_sampling_rate) in the player settings of a Voice Pool for the attached destination.

◆ specific

Structure for DSP-specific settings.

Description:
Structure used for DSP-specific configuration settings.
For details, see CriAtomDspPitchShifterConfig .

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