IRTCClient::put_PreferredVolume

  • Article

The put_PreferredVolume property sets the preferred volume on the specified audio device. This method sets the volume retrieved in IRTCClient::get_PreferredVolume.

HRESULT put_PreferredVolume(RTC_AUDIO_DEVICEenDevice,
longlVolume);

Parameters

  • enDevice
    [in] The RTC_AUDIO_DEVICE enumeration that specifies which audio media to set.
  • lVolume
    [in] The volume level that is set. The valid range for volume is 0X0000 - 0XFFFF.

Return Values

RTC methods may return an RTC_E_ constant.

Value Meaning
RTC_E_CLIENT_NOT_INITIALIZED The client has not been initialized.

Remarks

The value that this method sets will persist for each user after the application is shut down.

The put_PreferredVolume method does not set the value for the system volume; it is only a storage place for the application to save a value. To set the system volume, use the IRTCClient::put_Volume method.

Requirements

Client: Requires Windows XP.
Server: Requires Windows Server 2003.
Redistributable: Requires Rtcdll.dll on Windows 2000, and Windows Me/98.
Header: Declared in Rtccore.h.
Library: Included as a resource in Rtcdll.dll.
GUID: IID_IRTCClient is defined as 07829e45-9a34-408e-a011-bddf13487cd1.

See Also

IRTCClient, RTC_AUDIO_DEVICE, IRTCClient::get_Volume, IRTCClient::put_Volume, IRTCClient::get_PreferredVolume