UgsVivox
23 tools in this family (folder Editor/Tools/UgsVivox/ in the bridge package). Effect: writes changes the project or the scene, read-only does not, destructive deletes or overwrites and the client asks before running it.
| Tool | Effect | Description |
|---|---|---|
ugs_vivox_block_participant | writes | Local block: refuse direct messages from a participant for the current login session. action='block'… |
ugs_vivox_export_setup | read-only | Export the current Vivox state as a JSON snapshot: package availability, session info, joined channe… |
ugs_vivox_get_input_devices | read-only | Enumerate available microphones (id, name, is_active). In production this queries the OS via the Viv… |
ugs_vivox_get_output_devices | read-only | Enumerate available speakers / headphones (id, name, is_active). Read-only. |
ugs_vivox_init | writes | Verify UGS Authentication is initialized and the player is signed in (Vivox requires UGS Auth before… |
ugs_vivox_join_echo_channel | writes | Join a loopback echo channel — anything you say comes back to your own speakers. Useful for diagnosi… |
ugs_vivox_join_group_channel | writes | Join a 2D group channel — flat voice/chat for team or lobby chat. No spatial attenuation. capability… |
ugs_vivox_join_positional_channel | writes | Join a 3D positional channel — voice attenuates with distance between listener and speaker. The serv… |
ugs_vivox_leave_all_channels | writes | Leave every joined channel in one shot. Does not log out — call ugs_vivox_logout to also disconnect. |
ugs_vivox_leave_channel | writes | Leave a specific joined channel. Idempotent — leaving a channel that's not joined returns ok with |
ugs_vivox_login | writes | Connect this player to the Vivox network with a display name. Optional flags: enable_tts (text-to-sp… |
ugs_vivox_logout | writes | Disconnect this player from Vivox. Implicitly leaves all joined channels. Idempotent — calling when |
ugs_vivox_mute_input | writes | Self-mute the microphone. Different from transmission_mode = None: 'mute_input' silences the device |
ugs_vivox_mute_output | writes | Self-deafen — silences all incoming voice + chat audio at the local speaker. The user can still send… |
ugs_vivox_mute_participant | writes | ADMIN: server-side mute a participant on a channel — they cannot transmit audio for duration_seconds… |
ugs_vivox_send_channel_message | writes | Broadcast a text message to every participant in a joined channel. Channels created with |
ugs_vivox_send_direct_message | writes | Send a private text message to one participant. The recipient does NOT need to share a channel with |
ugs_vivox_set_3d_position | writes | Update the local listener position (and the local speaker source position) on a 3D positional channe… |
ugs_vivox_set_active_input | writes | Switch to a specific microphone by device id (returned by ugs_vivox_get_input_devices). Takes effect… |
ugs_vivox_set_active_output | writes | Switch to a specific speaker / headphone device by id (returned by ugs_vivox_get_output_devices). |
ugs_vivox_set_transmission_mode | writes | Control where your microphone goes: 'None' = muted everywhere (push-to-talk released), 'Single' = |
ugs_vivox_set_volume | writes | Set a volume in Vivox's symmetric -50..+50 scale (0 = no change, -50 = silent, +50 = max boost). The… |
ugs_vivox_status | read-only | Return the current Vivox session state: is_logged_in, display_name, transmission mode, joined channe… |