LogoLogo
PlaygroundVideosBlogPricing
  • Welcome
  • Convai Playground
    • Playground Walkthrough
    • Get Started
    • Character Creator Tool
      • Create Character
      • Language and Speech
      • Knowledge Bank
      • Personality and Style
      • State of Mind
      • Memory
      • Actions
      • Narrative Design
      • Character Versioning
    • F.A.Q
  • Plugins & Integrations
    • Introduction
    • Unity Plugin
      • Pre-Requisites
      • Compatibility
      • Downloads
        • Limitations of WebGL Plugin
      • Setting Up Unity Plugin
      • Troubleshooting Guide
        • Disable Assembly Validation
        • Missing Newtonsoft Json
        • Microphone Permission Issues
        • Default Animations Incompatibility
        • Animations have Facial Blendshapes
        • Jaw Bone in Avatar is not Free
        • macOS Permission Issues
      • Creating a Convai Powered Scene from Template
      • Importing Ready Player Me (RPM) Characters
      • Importing Custom Characters
      • Adding Actions to your Character
      • Adding Lip-Sync to your Character
      • Adding Narrative Design to your Character
        • Narrative Design Keys
      • Adding NPC to NPC Conversation
      • Adding Scene Reference and Point-At Crosshairs
      • Utilities
        • Character Emotion
        • Player Data Container
        • Long Term Memory
        • Language Support
        • Managing sessionID Locally
        • Transcript UI System
        • Pre-built UI Prefabs
        • Input Management
        • Notification System
        • Settings Panel
        • Dynamic Information Context
      • Building For Supported Platforms
        • Building for iOS/iPadOS
        • Building for WebGL
        • Convai XR
          • Building for VR
            • VR Automatic Installation
            • VR Manual Installation
          • Building for MR
            • MR Automatic Installation
            • MR Manual Installation
          • Building for AR
          • Interacting with XR UI Elements
        • Building for macOS Universal apps
      • Changelogs
      • Tutorials
        • Narrative Design
        • NPC2NPC
    • Unreal Engine
      • Supported Platforms
      • Installation
      • Guides
        • Dynamic Environment Info
        • Change AI Character Movement Speed
        • Integration with Pixel Streaming
        • Adjust Interaction Radius
        • Creating MetaHuman Characters
          • Adding MetaHuman
          • Adding LipSync to MetaHuman (From plugin version 3.0.0 or later )
          • Change the Parent Class for MetaHuman
          • Change the parent class for Player.
          • Adding LipSync to MetaHuman (Deprecated)
        • Creating ReadyPlayerMe Characters
          • Download Plugins
          • Adding ReadyPlayerMe Character
          • Change the parent class for Player.
        • Creating Reallusion Characters
          • Creating a Reallusion Character
          • Importing Reallusion character and setting up the Convai plugin
          • Binding objects to Reallusion Character
        • Event-Aware Convai Characters
        • Operations Based on the Presence of Certain Words
        • Narrative Design
          • Narrative Design Trigger
          • Narrative Design Keys
        • Actions Guide
          • Stage 1: Default Actions
            • Moves To
            • Follows
          • Stage 2: Custom Actions
            • Simple actions
            • Adding Descriptions to Actions
          • Stage 3: Custom Actions with Single Parameter
          • Main Character and Attention Object
        • Customization
          • Push to Talk
          • Alter Character Response Audio Rate
        • Speech To Text Transcription
        • Enable Multiplayer Support
        • 3D Chat Widget
        • Long Term Memory
        • Saving and Loading Session
      • Blueprints Reference
        • Convai Player
        • Convai Chatbot
        • Convai Environment
        • Convai Object Entry
        • Convai Result Action
        • Convai Extra Params
        • Speech To Text
        • Text To Speech
        • Utility Functions
      • Troubleshoot Guide
        • Missing Unreal Engine Tool Set in Microsoft Visual Studio Toolchain
        • Convai Module Not Found
        • MetaHuman Plugin Conflict
        • Failure to Load Character IDs
      • Microphone Settings
        • Set Audio Gain
        • Set Microphone
        • Microphone test
        • List Microphone Devices
      • Mac Microphone Permission: Required for UE 5.0 and 5.3
      • Guides V2 (Under Development)
        • Getting Started
          • Installation
          • Simple Talking Cube
          • Adding Premade Chat and Settings UI
    • Web Plugin
      • PlayCanvas Plugin
        • Adding External Script
        • First Person View
        • Adding characters to scene
        • Character Animations
        • Convai Integration
        • Chat Overlay
      • Convai Web SDK
        • Getting Started
        • Facial Expressions
        • Actions
      • JavaScript Chat UI SDK
        • Getting Started
        • ChatBubble Props
      • Narrative Design Guide
        • Narrative Design Triggers
        • Narrative Design Keys
      • GLB Characters for Convai
      • GLB/FBX animations for Convai
    • Modding Framework
      • Modding Cyberpunk 2077
    • Other Integrations
      • Roblox
        • Sample Game 1
        • Sample Game 2
        • Code Example
          • Character Conversation API
      • Discord
        • Create a Discord Bot
        • Hosting Discord Bot from Personal Server
        • Hosting Discord Bot from Replit
      • Omniverse Extension
      • Third-Party API Integrations
        • ElevenLabs API Integration
  • Reference
    • Core API Reference
      • Character Base API
      • Interaction API
      • Core AI Setting API
      • Backstory API
      • Chat History API
      • Knowledge Bank API
      • Narrative Design API
      • Action API
      • Language List API
      • Voice List API
      • Character List API
      • Evaluation API
Powered by GitBook
On this page
  • Text to Speech and Speech To Speech
  • Microphone Settings
  • StartTalking() and SendText() Parameters

Was this helpful?

  1. Plugins & Integrations
  2. Unreal Engine
  3. Blueprints Reference

Convai Player

Actor component for the player

PreviousBlueprints ReferenceNextConvai Chatbot

Last updated 3 months ago

Was this helpful?

Convai Player is an Actor component responsible for capturing microphone audio and streaming it to a Convai character.

For voice chat to work in multiplayer, this component must be added to the player's possessed object and not the PlayerController.

Text to Speech and Speech To Speech

Functions
Returns
Description

Is Recording()

Boolean

Returns True if microphone audio is recorded, False otherwise.

Is Talking()

Boolean

Returns True is microphone audio is been streamed, false otherwise.

Start Recording()

Void

Start recording audio from microphone, use "Finish Recording" function afterwards.

Finish Recording()

USoundWave*

Stops recording from the microphone and outputs the recorded audio from microphone.

Send Text(

UConvaiChatbotComponent* ConvaiChatbotComponent,

FString Text,

UConvaiEnvironment* Environment, bool GenerateActions,

bool VoiceResponse,

bool RunOnServer,

bool UseServerAPI_Key

)

Void

Sends text to character.

Start Talking(

UConvaiChatbotComponent* ConvaiChatbotComponent, UConvaiEnvironment* Environment, bool GenerateActions,

bool VoiceResponse,

bool RunOnServer,

bool StreamPlayerMic,

bool UseServerAPI_Key

)

Void

Starts streaming microphone audio to the character. Use "Finish Talking" afterwards to let the character know that you are doing talking.

Finish Talking()

Void

Stops streaming microphone audio to the character.

Microphone Settings

Functions
Returns
Description

Get Available Capture Device Names()

TArray<FString>

Returns all the available capture devices.

Get Microphone Volume Multiplier()

Void

Gets microphone volume multiplier.

Set Capture Device Name()

Boolean

Sets the capture device name.

Set Microphone Volume Multiplier()

Void

Sets the microphone volume multiplier.

Get Active Capture Device()

Void

Gets info about active capture device.

StartTalking() and SendText() Parameters

Parameter
Description

UConvaiChatbotComponent* ConvaiChatbotComponent

The character to talk to.

UConvaiEnvironment* Environment

Holds all relevant objects and characters in the scene including the (Player), and also all the actions doable by the character. Use the CreateConvaiEnvironment() function to create and then use functions like AddAction(), AddCharacter(), AddMainCharacter() to fill it up.

FString Text

Text to be sent to the character.

bool GenerateActions

Whether or not to generate actions (Environment has to be given and valid)

bool VoiceResponse

If true it will generate a voice response, otherwise, it will only generate a text response.

bool RunOnServer

If true it will run this function on the server, this can be used in multiplayer sessions to allow other players to hear the character's voice response.

bool StreamPlayerMic

If true it will stream the player's voice to other players in the multiplayer session, this is the same effect as voice chat.

Convai Player functions