CriAtomExVoicePool Class Reference

Abstract class for controlling a voice pool More...

Inheritance diagram for CriAtomExVoicePool:

Classes
struct	PlayerConfig
	A configuration structure used when creating Voices More...
struct	UsedVoicesInfo
	Structure for representing the usage of Voices in the Voice Pool More...

Public Types
enum	VoicePoolId {   StandardMemory = StandardMemoryAsrVoicePoolId, StandardStreaming = StandardStreamingAsrVoicePoolId, StandardMemory = StandardMemoryNsrVoicePoolId, StandardStreaming = StandardStreamingNsrVoicePoolId,   HcaMxMemory = 4, HcaMxStreaming = 5, LowLatencyMemory = StandardMemoryNsrVoicePoolId, LowLatencyStreaming = StandardStreamingNsrVoicePoolId }
	The ID to access the Voice Pool created inside the plug-in More...
enum	PitchShifterMode : int
	Pitch shifter DSP operation mode More...

Public Member Functions
override void	Dispose ()
	Discards the Voice Pool More...
UsedVoicesInfo	GetNumUsedVoices ()
	Gets the usage of Voices in the Voice Pool More...
void	AttachDspTimeStretch ()
	Attaches the time stretch DSP More...
void	AttachDspPitchShifter (PitchShifterMode mode=PitchShifterMode.Music, int windosSize=1024, int overlapTimes=4)
	Attaches the pitch shifter DSP More...
void	DetachDsp ()
	Detaches DSP More...

Static Public Member Functions
static UsedVoicesInfo	GetNumUsedVoices (VoicePoolId voicePoolId)
	Gets the usage of Voices in the Voice Pool More...

Properties
uint	identifier [get]
	Voice Pool identifier More...

Detailed Description

Abstract class for controlling a voice pool

Description:

This is an abstract class for the control of a Voice Pool.
When creating a Voice Pool, an inherited class corresponding to the codec/playback format desired will be used.

Member Enumeration Documentation

enum VoicePoolId

strong

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

enum PitchShifterMode : int

strong

Pitch shifter DSP operation mode

Description:

Specifies the pitch shift processing method (algorithm).

See also

CriAtomExVoicePool.AttachDspPitchShifter, CriAtomExPlayer.SetDspParameter

Member Function Documentation

static UsedVoicesInfo GetNumUsedVoices ( VoicePoolId  voicePoolId )

inlinestatic

Gets the usage of Voices in the Voice Pool

Parameters

voicePoolId

Voice Pool ID

Returns

Voice usage

Description:

Gets the Voice usage of the specified Voice Pool.

Note:

Use this function only for debugging purposes.

See also

CriAtomExVoicePool::VoicePoolId, CriAtomExVoicePool::UsedVoicesInfo

override void Dispose ( )

inline

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.

UsedVoicesInfo GetNumUsedVoices ( )

inline

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

void AttachDspTimeStretch ( )

inline

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  )

inline

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

void DetachDsp ( )

inline

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

Property Documentation

uint identifier

get

Voice Pool identifier

Description:

The voice pool identifier is the ID used to identify the voice pool.

Note:

By setting the same identifier for both the player (CriAtomExPlayer.SetVoicePoolIdentifier) and the Voice Pool,
the player will only get Voices from the configured Voice Pool.

See also

CriAtomExVoicePool::VoicePoolId, CriAtomExVoicePool::UsedVoicesInfo

---

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

• CriAtomExVoicePool.cs