IRTCClient::get_PreferredVolume

The get_PreferredVolume property returns the volume on the specified audio device. This method retrieves the preferred volume set in IRTCClient::put_PreferredVolume.

HRESULT get_PreferredVolume(RTC_AUDIO_DEVICEenDevice,
long*plVolume);

Parameters

  • enDevice
    [in] An RTC_AUDIO_DEVICE enumeration that specifies the audio media type for the returned volume.
  • plVolume
    [out] Pointer to a long containing the current volume. The valid volume range is 0x0000 to 0xFFFF.

Return Values

RTC methods may return an RTC_E_ constant.

Value Meaning
RTC_E_CLIENT_NOT_INITIALIZED The client has not been initialized.

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::put_PreferredVolume, IRTCClient::get_Volume, IRTCClient::put_Volume