Share via


Windows Desktop Sharing Interfaces

Windows Desktop Sharing provides the following scriptable interfaces.

In this section

_IRDPSessionEvents

Implement this interface to receive notifications when events occur.

IRDPSRAPIApplication

Groups the sharable windows within a process. Each application object contains a list of window objects. If an application object is shared, all its windows are shared.

IRDPSRAPIApplicationFilter

Manages the shared desktop area at the window and process level. Applications can use the enumerators to display lists of objects in the session that can be shared.

IRDPSRAPIApplicationList

Manages the application list.

IRDPSRAPIAttendee

Attendee objects are created as a result of clients connecting to the session and being authenticated. After an attendee object is created, it is automatically added to the attendees list.

IRDPSRAPIAttendeeDisconnectInfo

Contains information about the reason an attendee disconnected.

IRDPSRAPIAttendeeManager

Manages attendee objects.

IRDPSRAPIAudioStream

Enables sending an audio stream from the collaboration sharer Microsoft ActiveX control to collaboration viewer controls.

IRDPSRAPIClipboardUseEvents

Implement this interface on the sharer side to track or control use of the clipboard. If you do not enable clipboard sharing, this interface has no effect. You need to set a value for the SetClipboardRedirectCallback property described in Property.

This interface is available starting with Windows 10, version 1511.

IRDPSRAPIFrameBuffer

Provides data about the frame buffer size and format and allows the contents to be retrieved.

Applications can get a pointer to this interface from the FrameBuffer property of the IRDPSRAPISharingSession2 interface.

IRDPSRAPIInvitation

Invitations enable a person or group of persons to connect to a session. When an attendee connects to a session, the client sends a ticket and a password. These two pieces of information are used to authenticate an attendee.

IRDPSRAPIInvitationManager

Manages invitation objects.

IRDPSRAPIPerfCounterLogger

Enables a client application to implement custom performance logging.

IRDPSRAPIPerfCounterLoggingManager

Manages IRDPSRAPIPerfCounterLogger objects.

IRDPSRAPISessionProperties

Use this interface to get or set session properties.

IRDPSRAPISharingSession

The main object that an application must create to start a collaboration session.

IRDPSRAPISharingSession2

The main object that an application must create to start a collaboration session.

IRDPSRAPITcpConnectionInfo

Supports the methods to retrieve the TCP connection information on the viewer and on the sharer side.

IRDPSRAPITransportStream

Exposes methods that perform operations with streams.

IRDPSRAPITransportStreamBuffer

Created and used by the IRDPSRAPITransportStream interface for sending and receiving data.

IRDPSRAPITransportStreamEvents

Exposes methods called by the stream interface (IRDPSRAPITransportStream) to notify the Remote Desktop Protocol (RDP) stack about the completion of events.

IRDPSRAPIViewer

The ActiveX interface that is used on the viewer side.

IRDPSRAPIVirtualChannel

Manages the virtual channel.

IRDPSRAPIVirtualChannelManager

Manages the list of virtual channels.

IRDPSRAPIWindow

Represents a one-to-one mapping to a sharable window.

IRDPSRAPIWindowList

Manages the window list.

IRDPViewerInputSink

Sends mouse and keyboard events, and supports touch input.

IRDPViewerRenderingSurface

Manages the rendering surface for the viewer.