Get/BindUserSpeaking (Unity)

Owned by bert
Last updated: Apr 19, 2024 by Kyle
1 min read

- Declaration

public static bool GetUserSpeaking(this CavrnusUser user)

public static IDisposable BindUserSpeaking(this CavrnusUser user, Action<bool> onSpeakingChanged)

- Description

Gets or Binds a bool to tell if the given user is currently speaking. “Speaking” is defined as having a volume slightly above 0, so note that coughing or very heavy breathing may also cause this to trip.

Note: Under-the-hood this is actually just calling: user.SpaceConnection.GetBoolPropertyValue(user.ContainerId, "speaking");

Since "speaking" is a well-known value assigned by the server, we wrote this function as a helpful convenience.

NOTE: Since this value is representing data coming from outside the Properties system it cannot be assigned to, only read.

- Sample