Skip to main content
Version: Latest

AI3DPlayer

namespace AIHuman.View

Modifier and TypeMethod / Property Description
voidInit(string aiName) Initialize the AI3DPlayer with the forwarded aiName. Applies RP character resources based on GraphicsSettings.currentRenderPipeline. (valid only when authenticated)
voidInit(string aiName, string pipeline) Initialize the AI3DPlayer with the forwarded aiName and pipeline. (pipeline : Built-in, URP) (valid only when authenticated)
voidSend(string[] requests) Let the AI speak. (using pure-text string)
voidSend(AIClipSet[] requests) Let the AI play. (using AIHuman.Model.AIClipSet)
voidStopSpeaking() Stop the current conversation. It also deletes the content in the speaking queue.
voidPause() Pauses speaking.
voidResume() Continue speaking again from when it was paused.
voidSetCustomVoice(CustomVoice cv) Set AI's voice to cv. return true if success.
CustomVoiceGetCustomVoice() Get the current CustomVoice object of set ai. It returns null if not set.
boolSetCustomVoiceForLanguage(string languageCode, string gender) Set the voice by the desired language and gender. All available languages when language null is entered, and all genders when null is entered in gender are searched and set as the first voice. If it succeeds, it returns true. Otherwise the default voice will be set.
voidDispose() Called when release AIPlayer.
voidScale(float scale) Set the AI scale.
voidScale(float scale, Transform pivot) Set AI scale based on pivot.
floatSpeed { get; set; } Get or Set the AI's speech rate.
floatVolume { get; set; } Get or Set the AI's volume.
boolIsMute { get; set; } Get or Set the AI's Mute.
AIPlayerStateState { get; } Get the state of AI3DPlayer.
stringAIName { get; } Get the AI name.
stringAIGender { get; } Get the AI gender.
stringAILanguage { get; } Get the AI language.
string[]AIGestures { get; } Get the AI gestures.
OnAIPlayerEventonAIPlayerEvent Delegate who can register event in AI3DPlayer.
OnAIPlayerErroronAIPlayerError Delegate who can register error in AI3DPlayer.