IRTCClient2
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 contains additional methods and properties for the Client object. It extends the IRTCClient 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. This interface inherits the methods for the IUnknown and IRTCClient interfaces.
The following table shows the IRTCClient methods.
| 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. |
The following table shows the IRTCClient2 methods.
| Method | Description |
|---|---|
Sets or gets the ports the client uses to listen for incoming sessions. |
|
Sets or gets the answer mode for a session type. |
|
This method is not supported in Windows Embedded CE. |
|
Gets the version of the client. |
|
Sets the name of the application that is used in the User-Agent header. |
|
Sets the version of the application for the User-Agent header. |
|
Specifies additional information about the mode of initialization, such as disabling for the media stack or UPnP support. |
|
Creates a session and specifies that the application is responsible for all negotiations with the session. |
|
Sets the application's Session Description Manager that handles session negotiations. |
|
Sets or gets the encryption level for each media type required for the session. |
Obtaining a Pointer
The application can obtain the client object using CoCreateInstance for CLSID_RTCClient (GUID = {7a42ea29-a2b7-40c4-b091-f6f024aa89be}). The RTC client object can be subsequently queried for the presence of IRTCClient2 using IUnknown::QueryInterface.
The object can be used as an inproc server only.
Requirements
| Header | rtccore.h, rtccore.idl |
| Library | uuid.lib |
| Windows Embedded CE | Windows CE .NET 4.2 and later |