chat_user_local::set_remote_user_muted

Artikel
06/22/2023

Configures whether the remote user is muted in relation to the local user.

Syntax

void set_remote_user_muted(  
    chat_user* targetUser,  
    bool muted  
)

Parameters

targetUser _In_
Type: chat_user*

muted _In_
Type: bool

Return value

Type: void

Remarks

Muting determines whether communications (both audio and text) will be presented to the local user. When muted, the remote user's audio will not be rendered for the local user and the local user will never been in the receiver list for a text message from the remote user.

If the local user is on a shared device, such as Kinect, the mute state for the target user will apply for all local users on the shared device.

Requirements

Header: GameChat2.h

Supported platforms: Windows, Xbox One family consoles and Xbox Series consoles