Events.h

Go to the documentation of this file.

#pragma once

#include <cmp.h>

#include "Buttons.h"

[    
    dispinterface,
    uuid("E46798A9-0613-4197-A011-B5624EE681FE"),
    helpstring("Citrix Mobility Events interface")
]
__interface ICMPEvents
{
    [id(0x81)] HRESULT SessionStateChanged([in]CMP_SESSION_STATE SessState);
    [id(0x82)] HRESULT ChannelStateChanged([in]CMP_CHANNEL_STATE ChnlState);
    [id(0x83)] HRESULT OrientationChanged([in]CMPRESULT rc,
                                          [in]CMP_ORIENTATION_POSITION DeviceOrientation,
                                          [in]CMP_ORIENTATION_POSITION AppOrientation,
                                          [in]INT16 OrientationFlags);
    [id(0x84)] HRESULT PictureTaken([in]CMPRESULT rc, [in]CMP_UNIQUE_ID PictureID, [in]CMP_IMAGE_FORMAT Format, 
                                    [in]INT32 PictureSize, [in]BSTR Filename);
    [id(0x85)] HRESULT SMSStarted([in]CMPRESULT rc, [in]CMP_UNIQUE_ID MsgId);
    [id(0x87)] HRESULT ButtonPressed([in]CMP_BUTTON_ID Button);

    [id(0x8A)] HRESULT DisplaySettingsChanged([in]INT16 MetricsFlags,
                                              [in]INT32 PixelWidth, [in]INT32 PixelHeight,
                                              [in]INT16 ColorDepth, [in]INT32 XPixelsPerInch, [in]INT32 YPixelsPerInch,
                                              [in]CMP_ORIENTATION_POSITION DeviceOrientation,
                                              [in]INT32 WidthMilliInches, [in]INT32 HeightMilliInches,
                                              [in]INT32 NormalizedDPI);

    [id(0x8B)] HRESULT ScrollModeChanged([in]CMPRESULT rc, [in]CMP_SCROLL_MODE ScrollMode);
    [id(0x8C)] HRESULT KeyboardStateChanged([in]CMPRESULT rc, [in]CMP_KEYBOARD_TYPE KybdType, [in]INT16 KybdFlags, 
                                            [in]CMP_KEYBOARD_AUTOCAPS KybdAutoCaps, [in]CMP_KEYBOARD_RETURNKEY KybdReturnKey);

    [id(0x8E)] HRESULT ViewportOriginChanged([in]CMPRESULT rc, [in]INT32 xLeft, [in]INT32 yTop);
    [id(0x8F)] HRESULT ButtonTargetChanged([in]CMPRESULT rc, [in]CMP_BUTTON_ID Button, [in]CMP_BUTTON_TARGET ButtonTarget);
    [id(0x90)] HRESULT ControlStateChanged([in]CMPRESULT rc, [in]INT16 ControlState);
    [id(0x91)] HRESULT PhoneCallStarted([in]CMPRESULT rc, [in]CMP_UNIQUE_ID CallId);
    [id(0x94)] HRESULT UserNotified([in]CMPRESULT rc, [in]CMP_UNIQUE_ID NotificationId);
    [id(0x95)] HRESULT CameraPictureRemoved([in]CMPRESULT rc, [in]CMP_UNIQUE_ID pictureId);
    [id(0x96)] HRESULT EventFilterChanged([in]CMPRESULT rc, [in]CMP_EVENT_ID EventId, [in]INT16 FilterFlags);
    [id(0x97)] HRESULT PickerControlStateChanged([in]CMP_UNIQUE_ID ControlId, [in]INT16 PickerFlags, [in]CMPRESULT result, [in]INT16 SelectedItemIndex);
    [id(0x98)] HRESULT ViewportChanged([in]CMPRESULT rc, [in]INT16 flags, [in]INT16 zoomFactor, 
                                       [in]INT32 x0Server, [in]INT32 y0Server, [in]INT32 x1Server, [in]INT32 y1Server,
                                       [in]INT32 x0Client, [in]INT32 y0Client, [in]INT32 x1Client, [in]INT32 y1Client);

    // Note: all the capture events return their option structs, but with the values set to what
    // was actually used for the capture operation. As with all structs we flatten them into
    // the individual members to keep .NET interop happy. We also use the original struct member
    // names to avoid typelib bugs as per the notes at the top.
    [id(0x99)] HRESULT PictureCaptured([in]CMPRESULT rc, [in]CMP_UNIQUE_LONG_ID uniqueId, [in]BSTR pictureMetadata, [in]BSTR filename, [in]BSTR thumbnail, [in]INT32 pictureSize, [in]CMP_CAPTURE_QUALITY Quality, [in]CMP_CAPTURE_CAMERA CameraSelection, [in]CMP_IMAGE_FORMAT Encoding, [in]INT32 DesiredWidth, [in]INT32 DesiredHeight, [in]CMP_THUMBNAIL_TYPE ThumbnailType, [in]INT16 ThumbnailWidth, [in]INT16 ThumbnailHeight);
    [id(0x9A)] HRESULT VideoCaptured([in]CMPRESULT rc, [in]CMP_UNIQUE_LONG_ID uniqueId, [in]BSTR videoMetadata, [in]BSTR filename, [in]INT32 videoSize, [in]CMP_CAPTURE_QUALITY Quality, [in]CMP_CAPTURE_CAMERA CameraSelection, [in]CMP_VIDEO_ENCODING Encoding, [in]INT32 DesiredWidth, [in]INT32 DesiredHeight, [in]INT32 DurationLimit);
    [id(0x9B)] HRESULT AudioCaptured([in]CMPRESULT rc, [in]CMP_UNIQUE_LONG_ID uniqueId, [in]BSTR audioMetadata, [in]BSTR filename, [in]INT32 audioSize, [in]CMP_CAPTURE_QUALITY Quality, [in]CMP_AUDIO_ENCODING Encoding, [in]INT32 DurationLimit);

    [id(0x9C)] HRESULT SupportedOrientationsChanged([in]CMPRESULT rc, [in]CMP_SUPPORTED_ORIENTATIONS supportedOrientations);

    [id(0x9D)] HRESULT AppForeground();
    [id(0x9E)] HRESULT AppBackground();
    [id(0x9F)] HRESULT ForegroundAppChanged([in]DWORD foregroundProcessId);
    [id(0xA0)] HRESULT CaptureMediaRemoved([in]CMPRESULT rc, [in]CMP_UNIQUE_LONG_ID captureId);

};

// IEventSource
[
    object,
    uuid("BDD168D6-7916-4D04-A8BF-8F258C7A632C"),
    helpstring("IEventSource interface")
]
__interface IEventSource
{
    [id(0x01)] HRESULT FireSessionStateChangedEvent([in]CMP_SESSION_STATE State);
    [id(0x02)] HRESULT FireChannelStateChangedEvent([in]CMP_CHANNEL_STATE State);
    [id(0x03)] HRESULT FireOrientationChangedEvent([in]CMPRESULT rc, [in]CMP_ORIENTATION_DATA *OrientationData);
    [id(0x04)] HRESULT FirePictureTakenEvent([in]CMPRESULT rc, [in]CMP_UNIQUE_ID ImageID, [in]CMP_IMAGE_FORMAT Format, [in]INT32 PictureSize, [in]BSTR filename);
    [id(0x05)] HRESULT FireSMSStartedEvent([in]CMPRESULT rc, [in]CMP_UNIQUE_ID MsgID);
    [id(0x07)] HRESULT FireButtonPressedEvent([in]CMP_BUTTON_ID Button);

    [id(0x0A)] HRESULT FireDisplaySettingsChangedEvent([in]CMP_DISPLAY_SETTINGS *DisplayMetrics);
    [id(0x0B)] HRESULT FireScrollModeChangedEvent([in]CMPRESULT rc, [in]CMP_SCROLL_MODE ScrollMode);
    [id(0x0C)] HRESULT FireKeyboardStateChangedEvent([in]CMPRESULT rc, [in]CMP_KEYBOARD_STATE* KeyboardState);
    [id(0x0E)] HRESULT FireViewportOriginChangedEvent([in]CMPRESULT rc, [in]CMP_DISPLAY_POINT *point);
    [id(0x0F)] HRESULT FireButtonTargetChangedEvent([in]CMPRESULT rc, [in]CMP_BUTTON_ID Button, [in]CMP_BUTTON_TARGET ButtonTarget);
    [id(0x10)] HRESULT FireControlStateChangedEvent([in]CMPRESULT rc, [in]INT16 ControlState);
    [id(0x11)] HRESULT FirePhoneCallStartedEvent([in]CMPRESULT rc, [in]CMP_UNIQUE_ID CallId);
    [id(0x14)] HRESULT FireUserNotifiedEvent([in]CMPRESULT rc, [in]CMP_UNIQUE_ID NotificationId);
    [id(0x15)] HRESULT FireCameraPictureRemovedEvent([in]CMPRESULT rc, [in]CMP_UNIQUE_ID pictureId);
    [id(0x16)] HRESULT FireEventFilterChangedEvent([in]CMPRESULT rc, [in]CMP_EVENT_ID EventId, [in]INT16 FilterFlags);
    [id(0x17)] HRESULT FirePickerControlStateChangedEvent([in]CMP_UNIQUE_ID ControlId, [in]INT16 PickerFlags, [in]CMPRESULT result, [in]INT16 SelectedItemIndex);
    [id(0x18)] HRESULT FireViewportChangedEvent([in]CMPRESULT rc, [in]INT16 flags, [in]INT16 zoomFactor, [in]CMP_DISPLAY_RECT* serverViewport, [in]CMP_DISPLAY_RECT* clientViewport);

    [id(0x19)] HRESULT FirePictureCaptured([in]CMPRESULT rc, [in]CMP_UNIQUE_LONG_ID uniqueId, [in]BSTR pictureMetadata, [in]BSTR filename, [in]BSTR thumbnail, [in]UINT32 pictureSize, [in]CMP_CAPTURE_PICTURE_OPTIONS *options);
    [id(0x1A)] HRESULT FireVideoCaptured([in]CMPRESULT rc, [in]CMP_UNIQUE_LONG_ID uniqueId, [in]BSTR videoMetadata, [in]BSTR filename, [in]UINT32 videoSize, [in]CMP_CAPTURE_VIDEO_OPTIONS *options);
    [id(0x1B)] HRESULT FireAudioCaptured([in]CMPRESULT rc, [in]CMP_UNIQUE_LONG_ID uniqueId, [in]BSTR audioMetadata, [in]BSTR filename, [in]UINT32 audioSize, [in]CMP_CAPTURE_AUDIO_OPTIONS *options);

    [id(0x1C)] HRESULT FireSupportedOrientationsChanged([in]CMPRESULT rc, [in]CMP_SUPPORTED_ORIENTATIONS supportedOrientations);

    [id(0x1D)] HRESULT FireAppForeground();
    [id(0x1E)] HRESULT FireAppBackground();
    [id(0x1F)] HRESULT FireForegroundAppChanged([in]DWORD foregroundProcessId);
    [id(0x20)] HRESULT FireCaptureMediaRemoved([in]CMPRESULT rc, [in]CMP_UNIQUE_LONG_ID captureId);
};

[
    object,
    uuid("B18C4A5E-0017-4E66-B9E4-067D01E62856"),
    helpstring("Citrix Event Filter Interface")
]
__interface IEventFilter: IUnknown
{
    HRESULT FilterEvent([in]CMP_EVENT_ID eventId, [in]INT16 filterFlags, [out, retval]CMPRESULT* result);
};