Standard Voice Pool
More...
|
| struct | Config |
| | Configuration structure for the initialization of a standard Voice Pool More...
|
| |
The ID to access the Voice Pool created inside the plug-in
- See also
- CriAtomExVoicePool.GetNumUsedVoices
| Enumerator |
|---|
| StandardMemory |
Model standard memory playback Voice Pool ID
|
| StandardStreaming |
Model standard streaming playback Voice Pool ID
|
| StandardMemory |
Model standard memory playback Voice Pool ID
|
| StandardStreaming |
Model standard streaming playback Voice Pool ID
|
| HcaMxMemory |
HCA-MX memory playback Voice Pool ID
|
| HcaMxStreaming |
A Voice Pool ID for HCA-MX streaming playback
|
| LowLatencyMemory |
[Android] Low latency memory playback Voice Pool ID
|
| LowLatencyStreaming |
[Android] Low latency streaming playback Voice Pool ID
|
Creates an additional standard Voice Pool
- Parameters
-
| config | Configuration structure for the initialization of a standard Voice Pool |
- Returns
- Standard Voice Pool
- Description:
- Create an additional standard Voice Pool.
Please use this function if you want to play audio with more than 6 channels or need an additional Voice Pool.
- Note:
- Be sure to call the Dispose function to destroy the object after the playback is complete.
If you want to explicitly set a particular CriAtomExPlayer to get voices from the created voice pool,
please create the voice pool with a non-zero identifier (0 is the default identifier),
and call the CriAtomExPlayer::SetVoicePoolIdentifier function.
- See also
- CriAtomExPlayer::SetVoicePoolIdentifier
Creates an additional standard Voice Pool
- Parameters
-
| numVoices | The number of Voices |
| maxChannels | Maximum number of channels |
| maxSamplingRate | Maximum sampling rate |
| streamingFlag | Streaming playback flag |
| identifier | Voice Pool identifier |
- Returns
- Standard Voice Pool
- Description:
- Creates an additional standard Voice Pool.
If you want to play a sound with six or more channels, create a Voice Pool using this API.
If false is specified for streamingFlag, a voice pool for in-memory playback will be created.
If you specify true for streamingFlag, the created voice pool will be capable of streaming playback in addition to in-memory playback.
maxSamplingRate specifies the maximum sampling rate of the materials in the Cue to be played, which uses the voice pool being created.
If the audio pitch is expected to change, please select a maximum sampling rate based on the highest pitch.
If you want to use the time-stretch feature, you need to double the maximum sampling rate.
- Note:
- Be sure to call the Dispose function to destroy the object after the playback is complete.
If you want to explicitly set a particular CriAtomExPlayer to get voices from the created voice pool,
please create the voice pool with a non-zero identifier (0 is the default identifier),
and call the CriAtomExPlayer::SetVoicePoolIdentifier function.
- See also
- CriAtomExPlayer::SetVoicePoolIdentifier
Gets the usage of Voices in the Voice Pool
- Returns
- Voice usage
- Description:
- Gets the Voice usage.
- Note:
- Use this function only for debugging purposes.
- See also
- CriAtomExVoicePool::UsedVoicesInfo
| override void Dispose |
( |
| ) |
|
|
inlineinherited |
Discards the Voice Pool
- Description:
- Discards the Voice Pool object.
Be sure to discard the created object using this API. Otherwise, a resource leak occurs.
| void AttachDspTimeStretch |
( |
| ) |
|
|
inlineinherited |
Attaches the time stretch DSP
- Description:
- Adds a time stretch DSP to the Voice Pool.
- Note:
- This function is a return-on-complete function.
Calling this function blocks the server processing of the Atom library for a while.
If this function is called during sound playback, problems such as sound interruption may occur, so call this function at a timing when load fluctuations is accepted such as when switching scenes.
- See also
- CriAtomExVoicePool::DetachInsertionDsp
| void AttachDspPitchShifter |
( |
PitchShifterMode |
mode = PitchShifterMode.Music, |
|
|
int |
windosSize = 1024, |
|
|
int |
overlapTimes = 4 |
|
) |
| |
|
inlineinherited |
Attaches the pitch shifter DSP
- Parameters
-
| mode | Pitch shift mode |
| windosSize | Window size |
| overlapTimes | The number of overlaps |
- Description:
- Adds a pitch shifter DSP to the Voice Pool.
- Note:
- This function is a return-on-complete function.
Calling this function blocks the server processing of the Atom library for a while.
If this function is called during sound playback, problems such as sound interruption may occur, so call this function at a timing when load fluctuations is accepted such as when switching scenes.
- See also
- CriAtomExVoicePool::DetachInsertionDsp
Detaches DSP
- Description:
- Removes the DSP added to the Voice Pool.
- Note:
- This function is a return-on-complete function.
Calling this function blocks the server processing of the Atom library for a while.
If this function is called during sound playback, problems such as sound interruption may occur, so call this function at a timing when load fluctuations is accepted such as when switching scenes.
- See also
- CriAtomExVoicePool::AttachDspPitchShifter, CriAtomExVoicePool::AttachDspTimeStretch
The documentation for this class was generated from the following file:
