Voice Chat API Reference
This section documents all Voice Chat Blueprint nodes provided by PloxTools: Steam Integration.
All functions require Steam to be initialized unless stated otherwise.
Voice Chat
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| Start Steam Voice Chat | – | bool Error Message: string |
Starts Steam Voice Chat for the current managed Steam multiplayer game. |
| Stop Steam Voice Chat | – | – | Stops Steam Voice Chat for the current multiplayer game. |
| Set Steam Voice Chat Enabled | bEnabled (bool) |
– | Enables or disables local microphone transmission and remote voice playback without leaving the current multiplayer game. |
| Set Steam Voice Input Mode | InputMode (ESteamVoiceInputMode) |
– | Selects when the local microphone is transmitted: Push To Talk, Voice Activation, or Always On. |
| Set Steam Push To Talk Active | bActive (bool) |
– | Sets the current Push To Talk button state. Only affects Push To Talk input mode. |
| Set Steam Voice Activation Threshold | Threshold (float) |
– | Sets the normalized RMS microphone threshold used by Voice Activation. Valid range is 0 to 1. |
| Set Steam Voice Chat Mode | Mode (ESteamVoiceChatMode) |
– | Selects whether remote Steam Voice is heard globally or from bound game Actors using proximity audio. |
| Is Local Steam Player Speaking | – | bool | Returns whether the local Steam player is currently producing transmitted voice data. |
| Is Steam Player Speaking | UserID (FSteamUserID) |
bool | Returns whether the specified Steam player is currently speaking in Voice Chat. |
| Mute Steam Player | UserID (FSteamUserID) |
– | Mutes the specified remote Steam player for this local user. |
| Unmute Steam Player | UserID (FSteamUserID) |
– | Unmutes the specified remote Steam player for this local user. |
| Is Steam Player Muted | UserID (FSteamUserID) |
bool | Returns whether the specified remote Steam player is muted locally. |
| Set Steam Player Volume | UserID (FSteamUserID)Volume (float) |
– | Sets local playback volume for the specified remote Steam player. Volume is clamped to 0 through 1. |
| Get Steam Player Volume | UserID (FSteamUserID) |
float | Returns local playback volume for the specified remote Steam player. Default is 1. |
Proximity
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| Set Steam Proximity Voice Distances | FullVolumeDistance (float)MaximumDistance (float)bSpatializationEnabled (bool) |
– | Sets Proximity Voice distances in Unreal units. Voice is full volume inside Full Volume Distance and fades to silence by Maximum Distance. |
| Set Steam Player Voice Actor | UserID (FSteamUserID)Actor (AActor*) |
– | Binds a remote Steam player to the game Actor used as that player's Proximity Voice sound source. |
| Clear Steam Player Voice Actor | UserID (FSteamUserID) |
– | Clears the game Actor currently used as the specified Steam player's Proximity Voice source. |
Events
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| Subscribe To Local Steam Player Started Speaking | – | On StartedFSteamVoiceChatListenerHandle |
Registers a persistent listener fired when the local Steam player starts transmitting voice. |
| Subscribe To Local Steam Player Stopped Speaking | – | On StoppedFSteamVoiceChatListenerHandle |
Registers a persistent listener fired when the local Steam player stops transmitting voice. |
| Subscribe To Remote Steam Player Started Speaking | – | On Started (User ID: FSteamUserID)FSteamVoiceChatListenerHandle |
Registers a persistent listener fired when a remote Steam player starts speaking. |
| Subscribe To Remote Steam Player Stopped Speaking | – | On Stopped (User ID: FSteamUserID)FSteamVoiceChatListenerHandle |
Registers a persistent listener fired when a remote Steam player stops speaking. |
| Subscribe To Steam Voice Chat Error | – | On Error (Error Message: string)FSteamVoiceChatListenerHandle |
Registers a persistent listener fired when Steam Voice Chat reports an error. |
| Unsubscribe From Local Steam Player Started Speaking | Handle (FSteamVoiceChatListenerHandle) |
– | Removes a persistent Local Steam Player Started Speaking listener. |
| Unsubscribe From Local Steam Player Stopped Speaking | Handle (FSteamVoiceChatListenerHandle) |
– | Removes a persistent Local Steam Player Stopped Speaking listener. |
| Unsubscribe From Remote Steam Player Started Speaking | Handle (FSteamVoiceChatListenerHandle) |
– | Removes a persistent Remote Steam Player Started Speaking listener. |
| Unsubscribe From Remote Steam Player Stopped Speaking | Handle (FSteamVoiceChatListenerHandle) |
– | Removes a persistent Remote Steam Player Stopped Speaking listener. |
| Unsubscribe From Steam Voice Chat Error | Handle (FSteamVoiceChatListenerHandle) |
– | Removes a persistent Steam Voice Chat Error listener. |