IRTCSession
The IRTCSession interface contains methods and properties related to sessions. The IRTCClient::CreateSession method creates the Session object.
Methods in Vtable Order
The IRTCSession interface inherits the methods of the standard COM interface IUnknown.
In addition, IRTCSession defines the following methods.
| Method | Description |
|---|---|
| get_Client | Returns an IRTCClient interface for the parent RTC Client object. |
| get_State | Returns the current state of the session. |
| get_Type | Returns the type of session. |
| get_Profile | Returns the profile currently used by the session. |
| get_Participants | Returns a collection of participants in this session, excluding the local user. This method is intended for applications written in Visual Basic. C and C++ applications should use the EnumerateParticipants method. |
| Answer | Answers an incoming session. |
| Terminate | Terminates a session. |
| Redirect | Enables the user to change the type of session and profile for the redirected call. This method is called when an outgoing call is redirected. |
| AddParticipant | Creates a participant and adds it to the session. Adding a participant to an idle session initiates the call. |
| RemoveParticipant | Removes a participant from the session. |
| EnumerateParticipants | Returns an enumeration of the participants in this session, excluding the local user. This method is intended for C and C++ applications. Visual Basic applications should use the get_Participants method. |
| get_CanAddParticipants | Gets an indication of whether it is possible to add participants to this session. |
| get_RedirectedUserURI | Gets the URI of the current user in the redirection list. |
| get_RedirectedUserName | Gets the displayable name of the current user in the redirection list. |
| NextRedirectedUser | Advances the index in the array of addresses kept by the redirection context. |
| SendMessage | Sends an instant message. |
| SendMessageStatus | Sends the user's typing status for a messaging window. |
| AddStream | Adds one new media stream to the session. |
| RemoveStream | Removes one media stream from the session. |
| put_EncryptionKey | Sets the encryption key to be used for one or more media streams. |
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_IRTCSession is defined as 387c8086-99be-42fb-9973-7c0fc0ca9fa8.