Share via


RTC Client API Interfaces

Other versions of this page are also available for the following:

Windows Mobile Not SupportedWindows Embedded CE Supported

8/28/2008

The following table shows the RTC Client API interfaces with a description of the purpose of each.

Programming element Description

IRTCBuddy

This interface represents a Buddy object.

IRTCBuddy2

This interface adds support for presence properties and profiles.

IRTCBuddyEvent

This interface retrieves information about an event of type RTCE_BUDDY.

IRTCBuddyEvent2

This interface retrieves information when the presence state of a buddy changes, or when roaming buddy information is updated.

IRTCBuddyGroup

This interface exposes the properties of a group object and allows buddies to be added or removed from the group.

IRTCBuddyGroupEvent

This interface retrieves information about an event of type RTCE_GROUP.

IRTCClient

This interface represents the RTC Client object.

IRTCClient2

This interface contains additional methods and properties for the Client object.

IRTCClientEvent

This interface retrieves information about an event of type RTCE_CLIENT.

IRTCClientPortManagement

This interface provides methods that allow the client application to supply additional IP addresses and ports on which the RTC Client API can listen.

IRTCClientPresence

This interface contains all methods and properties related to a client presence.

IRTCClientPresence2

This interface adds roaming and grouping capabilities for presence objects to the client.

IRTCClientProvisioning

This interface contains all methods and properties related to provisioning.

IRTCClientProvisioning2

This interface provides a method for enabling an RTC 1.2 XML server profile.

IRTCClientSIPPrivacy

This interface adds privacy support for all SIP traffic for an IRTCClient. It implements a subset of RFC 3323, RFC 3324, and 3325.

IRTCClientSubscriber

This interface enables applications to create new subscriptions. Applications can access this interface by calling QueryInterface on an IRTCClientobject. This interface is intended for C and C++ applications.

IRTCClientSubscriber2

Applies to Windows Embedded CE 6.0 R2

The interface creates a subscription object buts does not send the SUBSCRIBE out on the network. IRTCSubscription2 can be used to start the SUBSCRIBE request.

IRTCCollection

This interface enables Automation Client applications to retrieve collection information.

IRTCEnumBuddies

This interface provides COM-standard enumeration methods for the IRTCBuddyEvent interface.

IRTCEnumGroups

This interface provides COM-standard enumeration methods for the IRTCBuddyGroup interface.

IRTCEnumParticipants

This interface provides COM-standard enumeration methods for the IRTCParticipant interface.

IRTCEnumPresenceDevices

This interface provides COM-standard enumeration methods for the IRTCPresenceDevice interface.

IRTCEnumProfiles

This interface provides COM-standard enumeration methods for the IRTCProfile interface.

IRTCEnumUserSearchResults

This interface provides COM-standard enumeration methods for the IRTCUserSearchResult interface.

IRTCEnumWatchers

This interface provides COM-standard enumeration methods for the IRTCWatcher interface.

IRTCEventNotification::Event

This interface represents an event notification.

IRTCInfoEvent

This interface retrieves information about an event of type RTCE_INFO.

IRTCIntensityEvent

This interface retrieves information about an event of type RTCE_INTENSITY.

IRTCIntensityEvent2

This interface adds methods and properties related to an event of type RTCE_INTENSITY.

IRTCMediaEvent:IDispatch

This interface retrieves information about an event of type RTCE_MEDIA.

IRTCMediaEvent2

This interface adds methods and properties related to an event of type RTCE_MEDIA.

IRTCMediaRequestEvent

This interface retrieves information about an event of type RTCE_MEDIA_REQUEST.

IRTCMessagingEvent

This interface retrieves information about an event of type RTCE_MESSAGING.

IRTCParticipant

This interface contains all methods related to a Participant object.

IRTCParticipant2

This interface adds methods and properties related to the Participant object.

IRTCParticipant3

This interface adds methods and properties related to the Participant object.

IRTCParticipantStateChangeEvent

This interface retrieves information about an event of type RTCE_PARTICIPANT_STATE_CHANGE.

IRTCPluggableVideoEncoder

Applies to Windows Embedded CE 6.0 R2

This interface supports implementation of the parsing of RTP packets before they are sent to the underlying codec.

IRTCPluggableVideoDecoder

Applies to Windows Embedded CE 6.0 R2

This interface supports the generation of RTP packets to be sent over the network which contain non-media data that the filter does not natively generate.

IRTCPortManager

This interface represents the RTC Port Manager for network address translation (NAT) mappings.

IRTCPortManager2

This interface adds methods and properties related to the RTC Port Manager.

IRTCPortManager3

This interface adds methods and properties related to the RTC Port Manager and Port Manager 2.

IRTCPresenceContact

This interface represents a presence contact.

IRTCPresenceDataEvent

This interface retrieves information about an event of type RTCE_PRESENCE_DATA.

IRTCPresenceDevice

This interface retrieves information about a presence device available for a specified buddy.

IRTCPresenceDevice2

This interface adds methods and properties related to the presence device.

IRTCPresencePropertyEvent

This interface retrieves information about an event of type RTCE_PRESENCE_PROPERTY.

IRTCPresenceStatusEvent

This interface retrieves information about an event of type RTCE_PRESENCE_STATUS.

IRTCProfile

This interface represents a Profile object, and retrieves information from the provisioning profile.

IRTCProfile2

This interface adds methods and properties related to the provisioning profile.

IRTCProfile3

This interface adds methods and properties related to the provisioning profile.

IRTCProfileEvent

This interface retrieves information about an event of type RTCE_PROFILE.

IRTCProfileEvent2

This interface adds functionality to retrieve information about a provisioning profile event.

IRTCProfilePortManagement

This interface specifies the interface that is used to allow network address translation (NAT) mappings, for the Profile object.

IRTCRegistrationStateChangeEvent

This interface retrieves information about an event of type RTCE_REGISTRATION_STATE_CHANGE.

IRTCReInviteEvent

This interface retrieves information about an event of type RTCE_REINVITE.

IRTCReInviteEvent2

This interface adds methods and properties related to the event of type RTCE_REINVITE.

IRTCRoamingEvent

This interface retrieves information about an event of type RTCE_ROAMING.

IRTCSDPValidator

Applies to Windows Embedded CE 6.0 R2

This interface may be implemented optionally for a given codec type to check whether the underlying codec can support given media options.

IRTCSession

This interface represents a Session object.

IRTCSession2

This interface adds methods and properties related to a session.

IRTCSession3

This interface adds methods and properties related to a session.

IRTCSessionCallControl

This interface contains methods and properties related to control of session calls.

IRTCSessionCallControl2

Applies to Windows Embedded CE 6.0 R2

This interface enables the application to implement attended call transfer, call park, and call pickup.

IRTCSessionConsultantReferredEvent

Applies to Windows Embedded CE 6.0 R2

This interface enables the application to implement attended call transfer.

IRTCSessionDescriptionManager

This interface defines a Session Description Manager that the application is responsible for implementing.

IRTCSessionNotificationEvent

Applies to Windows Embedded CE 6.0 R2

This interface retrieves information about an event of type RTCE_SESSION_NOTIFICATION.

IRTCSessionOperationCompleteEvent

This interface retrieves information for an event of type RTCE_SESSION_OPERATION_COMPLETE.

IRTCSessionOperationCompleteEvent2

This interface adds a method to obtain the participant in a session operation.

IRTCSessionPortManagement

This interface specifies the interface that is used to allow network address translation (NAT) mappings.

IRTCSessionReferredEvent

This interface retrieves information about an event of type RTCE_SESSION_REFERRED.

IRTCSessionSIPPrivacy

This interface adds privacy support for all SIP traffic for an IRTCSession. It implements a subset of RFC 3323, RFC 3324, and 3325. Settings for the session object will override any settings for the parent IRTCClientobject.

IRTCSessionReferStatusEvent

This interface retrieves information about an event of type RTCE_SESSION_REFER_STATUS.

IRTCSessionStateChangeEvent

This interface retrieves information about an event of type RTCE_SESSION_STATE_CHANGE.

IRTCSessionStateChangeEvent2

This interface retrieves additional information related to session state change events.

IRTCSessionStateChangeEvent3

Applies to Windows Embedded CE 6.0 R2

This interface enables the application to implement attended call transfer, call park, and call pickup.

IRTCSIPEvent

Applies to Windows Embedded CE 6.0 R2

This interface gets the SIP message.

IRTCSIPMessage

Applies to Windows Embedded CE 6.0 R2

This interface retrieves the information about the header of any incoming SIP message that triggers an asynchronous event.

IRTCSIPObject

Applies to Windows Embedded CE 6.0 R2

This interface allows an application to examine the message headers when the application receives an asynchronous event and RTC has already responded properly.

IRTCSubscription

This interface represents the RTC Subscription object, which represents a SIP SUBSCRIBE dialog. It can be queried for state and can resubscribe/unsubscribe from a service.

IRTCSubscription2

Applies to Windows Embedded CE 6.0 R2

This interface sends the first SUBSCRIBE request to the User Agent Server.

IRTCSubscriptionNotificationEvent

This interface represents the RTC Subscription Notification Event object. This object is sent after receiving an incoming SIP NOTIFY message, which corresponds to a custom subscription (IRTCSubscription).

IRTCSubscriptionStateChangeEvent

This interface represents the RTC Subscription State Change Event object. This object is a notification event concerning the status of a SUBSCRIBE transaction. It is completely analogous to IRTCSessionStateChangeEvent.

IRTCUnsolicitedNotificationEvent

Applies to Windows Embedded CE 6.0 R2

This interface retrieves information about an event of type RTCE_UNSOLICITED_NOTIFY_EVENT.

IRTCUnsolicitedSubscription

Applies to Windows Embedded CE 6.0 R2

This interface encapsulates the unsolicited notification registration.

IRTCUserSearchResultsEvent:IDispatch

This interface represents an RTC user search.

IRTCUserSearchQuery

This interface defines a user search query.

IRTCUserSearchResult

This interface retrieves search result values for specific data columns in a user search result.

IRTCUserSearchResultsEvent:IDispatch

This interface retrieves information about an event of type RTCE_USERSEARCH.

IRTCWatcher

This interface represents an RTC Watcher object.

IRTCWatcher2

This interface adds methods and properties for determining watcher access privileges.

IRTCWatcherEvent

This interface retrieves information about an event of type RTCE_WATCHER.

IRTCWatcherEvent2

This interface adds methods and properties concerning an event of type RTCE_WATCHER.

See Also

Other Resources

RTC Client API Reference