stingray.SteamVoipRoom namespace reference

Description

This represents a room where people can talk to each other in over the Internet.

The creator of the room decides who should be in it.

Other related reference items

	stingray.SteamVoip
	Steam

Functions

add_member ( room_id, peer_id ) Adds the specified peer to the room.

Parameters

room_id :	string	The ID of the room that the peer should join.
peer_id :	string	The ID of the peer you want to add to the room.

Returns

This function does not return any values.

Other related reference items

stingray.SteamVoip

broken_members ( room_id ) : string[]? Queries for members that the room has lost contact with.

Parameters

room_id :

string

The ID of the room to query.

Returns

string[]?

A table that lists the IDs of all peers that cannot communicate with the room. 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. The ? notation indicates that this type is optional: there may be zero or one instances of it.

• If this function returns nil, all is well.
• If it returns a table, that table contains all members that the room can no longer communicate with. You should typically respond by removing those peers from the room.

members ( room_id ) : string[] Returns a list of all peers in the specified room.

Parameters

room_id :

string

The ID of the room whose members you want to retrieve.

Returns

string[]

A table that contains the ID of each member. 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.

remove_member ( room_id, peer_id ) Removes the specified peer from the room.

Parameters

room_id :	string	The ID of the room that the peer should be removed from.
peer_id :	string	The ID of the peer you want to remove from the room.

Returns

This function does not return any values.