Edit

PartyLocalChatControl::SetAudioRenderVolume

  • Article

Configures the volume setting for audio received from a target chat control that will be used for the local chat control.

Syntax

PartyError SetAudioRenderVolume(  
    const PartyChatControl* targetChatControl,  
    float volume  
)

Parameters

targetChatControl   PartyChatControl*

The target chat control.

volume   float

The volume.

Return value

PartyError

c_partyErrorSuccess if the call succeeded or an error code otherwise. The human-readable form of the error code can be retrieved via PartyManager::GetErrorMessage().

Remarks

The volume is a fractional percentage between 0.0 (quietest possible) and 1.0 (the standard chat volume).

This is a local setting that takes effect immediately.

Requirements

Header: Party.h

See also

PartyLocalChatControl