PartyChat.IsPartyChatSuppressed Property

Value that indicates whether a chat party has suppressed its microphone so that a title can be free to create a microphone for game chat.

Syntax

public:
static property bool IsPartyChatSuppressed {
         bool get ();
         void set (bool value);
}  

Property value

Type: bool 

 True if the microphone is suppressed, and false otherwise.

Remarks

Setting IsPartyChatSuppressed to true notifies the chat party of the intent to create a microphone source for game chat. Once chat is successfully suppressed, the chat party fires a PartyChat.IsPartyChatSuppressedChanged Event. At this point, the PartyChat.IsPartyChatActive Property is set to false, and a microphone for game chat can take over.

Use of IsPartyChatSuppressed depends on the existence of an entry in the title’s AppXManifest.xml file. If the manifest does not contain the following in the Extensions section, the call to this property silently fails and any expected event does not fire.

  <Extensions>
    <mx:Extension Category="xbox.multiplayer">
      <mx:XboxMultiplayer CanSuppressPartyChat="true" />
    </mx:Extension>
  </Extensions>  

Requirements

Namespace: Windows.Xbox.Multiplayer

Metadata: windows.winmd

See also

Reference

PartyChat Class

PartyChat Members

Windows.Xbox.Multiplayer Namespace