Share via

IRTCClient::PlayRing

  • Article

The PlayRing method plays a ring on the OS default audio device or on the RTC default audio device.

HRESULT PlayRing(RTC_RING_TYPEenType,
VARIANT_BOOLbPlay);

Parameters

  • enType
    [in] An RTC_RING_TYPE enumeration that specifies the type of sound rendered.
  • bPlay
    [in] If VARIANT_TRUE, a ring will be played. If VARIANT_FALSE, any currently rendered ring will be stopped.

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

Answer a Call, IRTCClient, RTC_RING_TYPE