VoiceChat - stingray.VoiceChat namespace reference - Stingray Lua API Reference
Description
The interface to access voice chat functionality on Xbox One.
Other related reference items 
Functions
 |
add_user_to_channel ( user_id, channel ) Starts the asynchronous task of adding a user to a chat channel.
|
user_id : | integer | Id of a local user. |
channel : | integer | Index of the chat channel. Should be between 0 and 255. |
| This function does not return any values. |
Use latest_added_users() to track when finished.
Other related reference items
| |
chat_users ( ) : chat_user[] |
| This function does not accept any parameters. |
|
List of users in chat The [] notation indicates that this type is an array: a table in which the keys of the members are sequential integers, and the value of each element is an instance of the type shown. |
| |
has_mic_focus ( ) : boolean |
| This function does not accept any parameters. |
boolean |
Returns true if the game has mic focus. |
| |
has_running_jobs ( ) : boolean |
| This function does not accept any parameters. |
boolean |
Returns true if the voice chat is waiting for asynchronous jobs to finish. |
Other related reference items
| |
init ( )Initializes the VoiceChat system to use the build in Game Chat system.
|
| This function does not accept any parameters. |
| This function does not return any values. |
Other related reference items
| |
latest_added_users ( ) : chat_user_channel*Returns the users added to chat with add_user_to_channel() since last time called.
|
| This function does not accept any parameters. |
|
List of xbox_user_id of users and the channel they have been added to. The * notation indicates that there may be zero or more instances of the specified type. |
Other related reference items
| |
latest_removed_users ( ) : chat_user_channel*Returns the users removed from chat with remove_user_from_channel() since last time called.
|
| This function does not accept any parameters. |
|
List of xbox_user_id of users and the channel they have been removed from. The * notation indicates that there may be zero or more instances of the specified type. |
Other related reference items
| |
mute_all_users ( )Mutes all users
|
| This function does not accept any parameters. |
| This function does not return any values. |
| |
mute_user ( xbox_user_id )Mutes a single user
|
xbox_user_id : | string | User to mute |
| This function does not return any values. |
| |
remove_user_from_channel ( user_id, channel )Starts the asynchronous task of removing a user from a chat channel.
|
user_id : | integer | Id of a local user. |
channel : | integer | Index of the chat channel. Should be between 0 and 255. |
| This function does not return any values. |
Use latest_removed_users() to track when finished.
Other related reference items
| |
remove_user_from_channel_with_xuid ( xbox_user_id, channel )Starts the asynchronous task of removing a user from a chat channel.
|
xbox_user_id : | string | Xbox User Id of a local user. |
channel : | integer | Index of the chat channel. Should be between 0 and 255. |
| This function does not return any values. |
Note that only local users can be removed from the chat with this function.
Use latest_removed_users() to track when finished.
| |
shutdown ( )Shuts down the VoiceChat created with VoiceChat.init().
|
| This function does not accept any parameters. |
| This function does not return any values. |
Ensure that there are no running jobs by calling VoiceChat.has_running_jobs() before shutting down.
| |
unmute_all_users ( )Unmutes all users
|
| This function does not accept any parameters. |
| This function does not return any values. |
| |
unmute_user ( xbox_user_id )Unmutes a single user
|
xbox_user_id : | string | User to unmute |
| This function does not return any values. |