IRTCClient
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/28/2008
This interface represents the RTC Client object. The client can also support an IRTCClient2 interface.
Methods
The following table shows the methods for this interface in vtable order. This is the order in which the compiler calls the methods. Like all COM interfaces, this interface inherits the methods for the IUnknown interface.
| Method | Description |
|---|---|
Initializes the Client object. |
|
Cleans up the Client object. |
|
Asynchronously prepares the client for shutting down. |
|
Sets or gets the event filter that is used for all attached event sinks. |
|
Sets the preferred media types for new sessions. |
|
Gets the preferred media types for new sessions. |
|
Gets the media types supported by the current hardware. |
|
Creates a session. |
|
Sets or gets the listening mode that the client uses for incoming sessions. |
|
Gets the IP addresses and ports on which the client is listening. |
|
Sets or gets the volume on an audio device. |
|
Sets or gets the muting on an audio device. |
|
This method is not supported in Windows Embedded CE. |
|
Sets or gets the preferred audio device for audio capturing or rendering. |
|
Sets or gets the preferred volume on an audio device. |
|
This method is not supported in Windows Embedded CE. |
|
Gets the media types for currently active streams in a session. |
|
Sets or gets the maximum bit rate (bps) for a session. |
|
Sets or gets the temporal-spatial tradeoff for a session. |
|
Gets the quality value of the network connection. |
|
This method is not supported in Windows Embedded CE. |
|
This method is not supported in Windows Embedded CE. |
|
This method is not supported in Windows Embedded CE. |
|
Sets or gets the SIP URI used in the From: header of the messages sent from the client. |
|
Sets or gets the displayable name used in the From: header of the messages sent from the client. |
|
Plays a ring on the operating system default audio device or on the RTC default audio device. |
|
Sends a Dual-Tone Multi-Frequency (DTMF) tone to the active session and plays a feedback tone to the RTC default audio device. |
|
This method is not supported in Windows Embedded CE. |
|
Gets the tuning status of the tuning wizard. |
Obtaining a Pointer
The application can obtain a pointer to the IRTCClient interface by calling the CoCreateInstance function, using the CLSID_RTCClient GUID of 7a42ea29-a2b7-40c4-b091-f6f024aa89be.
Note
The client object can only be used as an inproc server.
For information on how to create and initialize the client object, see the Initialize RTC code example.
Requirements
| Header | rtccore.h, rtccore.idl |
| Library | uuid.lib |
| Windows Embedded CE | Windows CE .NET 4.0 and later |