IRTCSession2
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 adds methods and properties related to a session. It extends the functionality provided by the IRTCSession interface. The IRTCClient::CreateSession or IRTCClient2::CreateSessionWithDescription method creates the Session object.
Methods
The following tables show 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 IRTCSession interfaces.
The following table shows the IRTCSession methods.
| Method | Description |
|---|---|
Gets the parent RTC Client object. |
|
Gets the current state of the session. |
|
Gets the type of session. |
|
Gets the profile currently used by the session. |
|
Gets a collection of the participants in this session, excluding the local user. |
|
Answers an incoming session. |
|
Terminates a session. |
|
Changes the type of session and profile for a redirected call. |
|
Creates a participant and adds it to the session. |
|
Removes a participant from the session. |
|
Retrieves an enumeration of the participants in this session, excluding the local user. |
|
Gets a value indicating if it is possible to add participants to this session. |
|
Gets the Universal Resource Identifier (URI) of the current user in the redirection list. |
|
Gets the displayable name of the current user in the redirection list. |
|
Advances the index in the array of addresses kept by the redirection context. |
|
Sends an instant message. |
|
Sends a user's typing status for a messaging window. |
|
Adds one new media stream to this session. |
|
Removes one media stream from this session. |
|
Sets the encryption key to be used for one or more media streams. |
The following table shows the IRTCSession2 methods.
| Method | Description |
|---|---|
Sends a SIP INFO message. |
|
Sets or gets the preferred encryption level for the media type for this session. |
|
Determines if encryption is enabled for the specified security type. |
|
Allows applications to accept an incoming request for a session and provide the session description with the reply. |
|
Allows applications to include a session description with a REINVITE request. |
Obtaining a Pointer
To discover the IRTCSession2 interface for RTC 1.2 implementations, the application should call IUnknown::QueryInterface on the Session object.
Requirements
| Header | rtccore.h, rtccore.idl |
| Library | uuid.lib |
| Windows Embedded CE | Windows CE .NET 4.2 and later |
See Also
Reference
RTC Client API Interfaces
IRTCSession