Skip to main content

setMyCommSettings

Set the caller’s voice and video choices in the app; fields left out keep their choice. The effective scopes are the choices capped by policy, so a player can only lower what it sends and receives; the change reaches its live sessions within a second. Game plane: send the app-scoped token for this app to the app’s datacenter.

setMyCommSettings(
  appId: BigInt!
  input: SetCommSettingsInput!
): CommSettings!

Arguments​

setMyCommSettings.appId ● BigInt! non-null scalar​

The app.

setMyCommSettings.input ● SetCommSettingsInput! non-null input​

The choices to change.

Type​

CommSettings object​

A player’s voice and video settings in one app. The four scopes are the EFFECTIVE ones, which the realtime servers enforce on both sending and receiving: the player’s choice, never more than policy allows. An adult may choose anything (EVERYONE by default). For a player under 18 each medium is OFF until a parent consents to it (requestParentalConsent), and then at most CONTACTS. A block always wins: nothing passes between two players while either has blocked the other.