chat_user_local::audio_render_volume

Article
06/22/2023

Provides the current volume setting for audio received from the target user that will be used for the local user.

Syntax

_Ret_range_(0, 1)
float audio_render_volume(
    _In_ chat_user * targetUser
    )

Parameters

Return value

Type: float _Ret_range_(0, 1)

Remarks

The volume is a fractional percentage between 0.0 (quietest possible) and 1.0 (the standard chat volume). Values outside the [0, 1] range are clamped to the nearest extremum.

If the local user is on a shared audio device, such as Kinect, the effective volume will be the minimum of all volumes set the target user and local users on the shared device. E.g. if User A and User B are on a Kinect, and User A has set remote User C's volume to 0.5, while User B has set remote User C's volume to 0.6, Game Chat will render remote User C's audio to the Kinect with a volume of 0.5.

Requirements

Header: GameChat2.h

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

Share via