IRTCClient
The IRTCClient interface is the main interface to the RTC Client object. The IRTCClient2 interface is created by performing a QueryInterface on the IRTCClient object.
For information on how to create and initialize the Client object, see the Initialize RTC code example.
Methods in Vtable Order
The IRTCClient interface inherits the methods of the standard COM interface IUnknown.
In addition, IRTCClient defines the following methods.
| Method | Description |
|---|---|
| Initialize | Initializes the Client object. This must be called before any other methods are called on this interface. |
| Shutdown | Cleans up the Client object. This must be called before the Client object is released. |
| PrepareForShutdown | Asynchronously prepares the Client object for shutting down. |
| put_EventFilter | Sets the event filter that is used to deliver events. This affects all attached event sinks. |
| get_EventFilter | Returns the current event filter. |
| SetPreferredMediaTypes | Sets the media types that are preferred for use by new (outgoing or incoming) sessions. |
| get_PreferredMediaTypes | Returns the media types that are preferred for use by new (outgoing or incoming) sessions. |
| get_MediaCapabilities | Returns the media types that are supported by the current hardware. |
| CreateSession | Creates a session. |
| put_ListenForIncomingSessions | Sets the way the Client behaves for incoming sessions. |
| get_ListenForIncomingSessions | Returns the way the Client is listening for incoming sessions. |
| get_NetworkAddresses | Retrieves the IP addresses and ports that the Client is listening on. |
| put_Volume | Sets the volume on the specified audio device. |
| get_Volume | Returns the volume on the specified audio device. |
| put_AudioMuted | Sets the mute on the specified audio device. |
| get_AudioMuted | Gets the mute on the specified audio device. |
| get_IVideoWindow | Gets the IVideoWindow interface associated with the specified video window. |
| put_PreferredAudioDevice | Sets the preferred audio device for audio capturing or rendering. |
| get_PreferredAudioDevice | Gets the preferred audio device for audio capturing or rendering. |
| put_PreferredVolume | Sets the preferred volume on the specified audio device. |
| get_PreferredVolume | Returns the volume on the specified audio device. |
| put_PreferredAEC | Enables or disables the preferred AEC (Acoustic Echo Cancelation) mode. |
| get_PreferredAEC | Gets the preferred AEC (Acoustic Echo Cancelation) mode. |
| put_PreferredVideoDevice | Sets the preferred video capture device. |
| get_PreferredVideoDevice | Gets the preferred video capture device. |
| get_ActiveMedia | Returns the media types for streams that are currently active in the session. |
| put_MaxBitrate | Sets the maximum bitrate the user is willing to use for all media streaming. |
| get_MaxBitrate | Gets the maximum bitrate the user is willing to use for all media streaming. |
| put_TemporalSpatialTradeOff | Sets the temporal-spatial trade-off for all media streaming. |
| get_TemporalSpatialTradeOff | Gets the temporal-spatial trade-off for all media streaming. |
| get_NetworkQuality | Returns a value that describes the quality of the network connection. |
| StartT120Applet | Starts a T120 applet. |
| StopT120Applets | Stops all running T120 applets. |
| get_IsT120AppletRunning | Checks to see if a T120 applet is running. |
| get_LocalUserURI | Gets the SIP URI used in the From: header of the messages sent from this Client. |
| put_LocalUserURI | Sets the SIP URI used in the From: header of messages sent from this Client. |
| get_LocalUserName | Gets the displayable name used in the From: header of the messages sent from this Client. |
| put_LocalUserName | Sets the displayable name used in the From: header of the messages sent from this Client. The default value is the logon user. |
| PlayRing | Plays a ring on the OS default audio device or on the RTC default audio device. |
| SendDTMF | Sends a DTMF to the active session and plays a feedback tone to the RTC default audio device. |
| InvokeTuningWizard | Invokes the tuning wizard. |
| get_IsTuned | Returns the tuning status (whether the tuning wizard has ever been invoked or not). |
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.