CitrixMobility.ICMPEvents Interface Reference

Inherited by CitrixMobility.ICMPEvents_SinkHelper.

List of all members.

Public Member Functions
void	SessionStateChanged ([In] CMP_SESSION_STATE SessState)
	Event: Session state changed.
void	ChannelStateChanged ([In] CMP_CHANNEL_STATE ChnlState)
	Event: Channel state changed.
void	OrientationChanged ([In, ComAliasName("CitrixMobility.CMPRESULT")] int rc,[In] CMP_ORIENTATION_POSITION DeviceOrientation,[In] CMP_ORIENTATION_POSITION AppOrientation,[In] short OrientationFlags)
	Event: Orientation changed.
void	PictureTaken ([In, ComAliasName("CitrixMobility.CMPRESULT")] int rc,[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int PictureID,[In] CMP_IMAGE_FORMAT Format,[In] int PictureSize,[In, MarshalAs(UnmanagedType.BStr)] string Filename)
	Event: Picture taken.
void	SMSStarted ([In, ComAliasName("CitrixMobility.CMPRESULT")] int rc,[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int MsgId)
	Event: Send SMS Started.
void	ButtonPressed ([In] CMP_BUTTON_ID Button)
	Event: Device button was pressed.
void	DisplaySettingsChanged ([In] short MetricsFlags,[In] int PixelWidth,[In] int PixelHeight,[In] short ColorDepth,[In] int XPixelsPerInch,[In] int YPixelsPerInch,[In] CMP_ORIENTATION_POSITION DeviceOrientation,[In] int WidthMilliInches,[In] int HeightMilliInches,[In] int NormalizedDPI)
	Event: Display settings have changed.
void	ScrollModeChanged ([In, ComAliasName("CitrixMobility.CMPRESULT")] int rc,[In] CMP_SCROLL_MODE ScrollMode)
	Event: Scroll mode changed.
void	KeyboardStateChanged ([In, ComAliasName("CitrixMobility.CMPRESULT")] int rc,[In] CMP_KEYBOARD_TYPE KybdType,[In] short KybdFlags,[In] CMP_KEYBOARD_AUTOCAPS KybdAutoCaps,[In] CMP_KEYBOARD_RETURNKEY KybdReturnKey)
	Event: Keyboard state changed.
void	ViewportOriginChanged ([In, ComAliasName("CitrixMobility.CMPRESULT")] int rc,[In] int xLeft,[In] int yTop)
	Event: Viewport origin changed.
void	ButtonTargetChanged ([In, ComAliasName("CitrixMobility.CMPRESULT")] int rc,[In] CMP_BUTTON_ID Button,[In] CMP_BUTTON_TARGET ButtonTarget)
	Event: Button target changed.
void	ControlStateChanged ([In, ComAliasName("CitrixMobility.CMPRESULT")] int rc,[In] short ControlState)
	Event: Control state changed.
void	PhoneCallStarted ([In, ComAliasName("CitrixMobility.CMPRESULT")] int rc,[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int CallId)
	Event: Phone call started.
void	UserNotified ([In, ComAliasName("CitrixMobility.CMPRESULT")] int rc,[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int NotificationId)
	Event: User notified.
void	CameraPictureRemoved ([In, ComAliasName("CitrixMobility.CMPRESULT")] int rc,[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int PictureID)
	Event: Picture removed.
void	EventFilterChanged ([In, ComAliasName("CitrixMobility.CMPRESULT")] int rc,[In] CMP_EVENT_ID EventId,[In] short FilterFlags)
	Event: Filter changed.
void	PickerControlStateChanged ([In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int ControlId,[In] short PickerFlags,[In, ComAliasName("CitrixMobility.CMPRESULT")] int result,[In] short SelectedItemIndex)
	Event: Picker control state changed.
void	ViewportChanged ([In, ComAliasName("CitrixMobility.CMPRESULT")] int rc,[In] short flags,[In] short zoomFactor,[In] int x0Server,[In] int y0Server,[In] int x1Server,[In] int y1Server,[In] int x0Client,[In] int y0Client,[In] int x1Client,[In] int y1Client)
	Event: Viewport changed.
void	PictureCaptured ([In, ComAliasName("CitrixMobility.CMPRESULT")] int rc,[In, ComAliasName("CitrixMobility.CMP_UNIQUE_LONG_ID")] long uniqueId,[In, MarshalAs(UnmanagedType.BStr)] string pictureMetadata,[In, MarshalAs(UnmanagedType.BStr)] string Filename,[In, MarshalAs(UnmanagedType.BStr)] string thumbnail,[In] int PictureSize,[In] CMP_CAPTURE_QUALITY Quality,[In] CMP_CAPTURE_CAMERA CameraSelection,[In] CMP_IMAGE_FORMAT Encoding,[In] int DesiredWidth,[In] int DesiredHeight,[In] CMP_THUMBNAIL_TYPE ThumbnailType,[In] short ThumbnailWidth,[In] short ThumbnailHeight)
void	VideoCaptured ([In, ComAliasName("CitrixMobility.CMPRESULT")] int rc,[In, ComAliasName("CitrixMobility.CMP_UNIQUE_LONG_ID")] long uniqueId,[In, MarshalAs(UnmanagedType.BStr)] string videoMetadata,[In, MarshalAs(UnmanagedType.BStr)] string Filename,[In] int videoSize,[In] CMP_CAPTURE_QUALITY Quality,[In] CMP_CAPTURE_CAMERA CameraSelection,[In] CMP_VIDEO_ENCODING Encoding,[In] int DesiredWidth,[In] int DesiredHeight,[In] int DurationLimit)
void	AudioCaptured ([In, ComAliasName("CitrixMobility.CMPRESULT")] int rc,[In, ComAliasName("CitrixMobility.CMP_UNIQUE_LONG_ID")] long uniqueId,[In, MarshalAs(UnmanagedType.BStr)] string audioMetadata,[In, MarshalAs(UnmanagedType.BStr)] string Filename,[In] int audioSize,[In] CMP_CAPTURE_QUALITY Quality,[In] CMP_AUDIO_ENCODING Encoding,[In] int DurationLimit)
void	SupportedOrientationsChanged ([In, ComAliasName("CitrixMobility.CMPRESULT")] int rc,[In] CMP_SUPPORTED_ORIENTATIONS supportedOrientations)
void	AppForeground ()
void	AppBackground ()
void	ForegroundAppChanged ([In] uint foregroundProcessId)
void	CaptureMediaRemoved ([In, ComAliasName("CitrixMobility.CMPRESULT")] int rc,[In, ComAliasName("CitrixMobility.CMP_UNIQUE_LONG_ID")] long captureId)

---

Member Function Documentation

void CitrixMobility.ICMPEvents.AppBackground

(

)

Implemented in CitrixMobility.ICMPEvents_SinkHelper.

void CitrixMobility.ICMPEvents.AppForeground

(

)

Implemented in CitrixMobility.ICMPEvents_SinkHelper.

void CitrixMobility.ICMPEvents.AudioCaptured	(	[In, ComAliasName("CitrixMobility.CMPRESULT")] int	rc,
		[In, ComAliasName("CitrixMobility.CMP_UNIQUE_LONG_ID")] long	uniqueId,
		[In, MarshalAs(UnmanagedType.BStr)] string	audioMetadata,
		[In, MarshalAs(UnmanagedType.BStr)] string	Filename,
		[In] int	audioSize,
		[In] CMP_CAPTURE_QUALITY	Quality,
		[In] CMP_AUDIO_ENCODING	Encoding,
		[In] int	DurationLimit
	)

Implemented in CitrixMobility.ICMPEvents_SinkHelper.

void ICMPEvents::ButtonPressed

(

[In] CMP_BUTTON_ID

Button

)

Event: Device button was pressed.

Parameters:

[in]

Button

button that was pressed

Implemented in CitrixMobility.ICMPEvents_SinkHelper.

void ICMPEvents::ButtonTargetChanged	(	[In, ComAliasName("CitrixMobility.CMPRESULT")] int	rc,
		[In] CMP_BUTTON_ID	Button,
		[In] CMP_BUTTON_TARGET	ButtonTarget
	)

Event: Button target changed.

Parameters:

[in]	rc	result of last request
[in]	Button	button identifier
[in]	ButtonTarget	either client or host location

Implemented in CitrixMobility.ICMPEvents_SinkHelper.

void ICMPEvents::CameraPictureRemoved	(	[In, ComAliasName("CitrixMobility.CMPRESULT")] int	rc,
		[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int	PictureID
	)

Event: Picture removed.

Parameters:

[in]	rc	result of last request
[in]	PictureID	unique picture identifier

Implemented in CitrixMobility.ICMPEvents_SinkHelper.

void CitrixMobility.ICMPEvents.CaptureMediaRemoved	(	[In, ComAliasName("CitrixMobility.CMPRESULT")] int	rc,
		[In, ComAliasName("CitrixMobility.CMP_UNIQUE_LONG_ID")] long	captureId
	)

Implemented in CitrixMobility.ICMPEvents_SinkHelper.

void ICMPEvents::ChannelStateChanged

(

[In] CMP_CHANNEL_STATE

ChnlState

)

Event: Channel state changed.

Parameters:

[in]

ChnlState

latest state for the channel

Implemented in CitrixMobility.ICMPEvents_SinkHelper.

void ICMPEvents::ControlStateChanged	(	[In, ComAliasName("CitrixMobility.CMPRESULT")] int	rc,
		[In] short	ControlState
	)

Event: Control state changed.

Parameters:

[in]	rc	result of last request
[in]	ControlState	flags that indicate the state of the receiver controls

Implemented in CitrixMobility.ICMPEvents_SinkHelper.

void ICMPEvents::DisplaySettingsChanged	(	[In] short	MetricsFlags,
		[In] int	PixelWidth,
		[In] int	PixelHeight,
		[In] short	ColorDepth,
		[In] int	XPixelsPerInch,
		[In] int	YPixelsPerInch,
		[In] CMP_ORIENTATION_POSITION	DeviceOrientation,
		[In] int	WidthMilliInches,
		[In] int	HeightMilliInches,
		[In] int	NormalizedDPI
	)

Event: Display settings have changed.

Parameters:

[in]	MetricsFlags	flags that indicate which of the following parameters is valid
[in]	PixelWidth	width of display in pixels
[in]	PixelHeight	height of display in pixels
[in]	ColorDepth	color bits per pixel
[in]	XPixelsPerInch	pixels per inch on horizontal axis
[in]	YPixelsPerInch	pixels per inch on vertical axis
[in]	DeviceOrientation	device orientation
[in]	WidthMilliInches	width in milli-inches (1/1000 of an inch)
[in]	HeightMilliInches	height in milli-inches (1/1000 of an inch)
[in]	NormalizedDPI	some devices only report this approximate DPI value

Implemented in CitrixMobility.ICMPEvents_SinkHelper.

void ICMPEvents::EventFilterChanged	(	[In, ComAliasName("CitrixMobility.CMPRESULT")] int	rc,
		[In] CMP_EVENT_ID	EventId,
		[In] short	FilterFlags
	)

Event: Filter changed.

Parameters:

[in]	rc	result of last request
[in]	EventId	event identifier
[in]	FilterFlags	flags for event filter (disable or enable)

Implemented in CitrixMobility.ICMPEvents_SinkHelper.

void CitrixMobility.ICMPEvents.ForegroundAppChanged

(

[In] uint

foregroundProcessId

)

Implemented in CitrixMobility.ICMPEvents_SinkHelper.

void ICMPEvents::KeyboardStateChanged	(	[In, ComAliasName("CitrixMobility.CMPRESULT")] int	rc,
		[In] CMP_KEYBOARD_TYPE	KybdType,
		[In] short	KybdFlags,
		[In] CMP_KEYBOARD_AUTOCAPS	KybdAutoCaps,
		[In] CMP_KEYBOARD_RETURNKEY	KybdReturnKey
	)

Event: Keyboard state changed.

Parameters:

[in]	rc	result of last request
[in]	KybdType	type of keyboard that is displayed
[in]	KybdFlags	flags associated with keyboard
[in]	KybdAutoCaps	auto capitalization mode selected
[in]	KybdReturnKey	return key text selected

Implemented in CitrixMobility.ICMPEvents_SinkHelper.

void ICMPEvents::OrientationChanged	(	[In, ComAliasName("CitrixMobility.CMPRESULT")] int	rc,
		[In] CMP_ORIENTATION_POSITION	DeviceOrientation,
		[In] CMP_ORIENTATION_POSITION	AppOrientation,
		[In] short	OrientationFlags
	)

Event: Orientation changed.

Parameters:

[in]	rc	result of last request
[in]	DeviceOrientation	orientation position of the device
[in]	AppOrientation	orientation of the application
[in]	OrientationFlags	Either sensor follow or lock

Implemented in CitrixMobility.ICMPEvents_SinkHelper.

void ICMPEvents::PhoneCallStarted	(	[In, ComAliasName("CitrixMobility.CMPRESULT")] int	rc,
		[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int	CallId
	)

Event: Phone call started.

Parameters:

[in]	rc	result of last request
[in]	CallId	unique phone call identifier for request

Implemented in CitrixMobility.ICMPEvents_SinkHelper.

void ICMPEvents::PickerControlStateChanged	(	[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int	ControlId,
		[In] short	PickerFlags,
		[In, ComAliasName("CitrixMobility.CMPRESULT")] int	result,
		[In] short	SelectedItemIndex
	)

Event: Picker control state changed.

Parameters:

[in]	ControlId	unique identifier for picker control
[in]	PickerFlags	flags for picker control
[in]	result	result of last request
[in]	SelectedItemIndex	selected list item

Implemented in CitrixMobility.ICMPEvents_SinkHelper.

void CitrixMobility.ICMPEvents.PictureCaptured	(	[In, ComAliasName("CitrixMobility.CMPRESULT")] int	rc,
		[In, ComAliasName("CitrixMobility.CMP_UNIQUE_LONG_ID")] long	uniqueId,
		[In, MarshalAs(UnmanagedType.BStr)] string	pictureMetadata,
		[In, MarshalAs(UnmanagedType.BStr)] string	Filename,
		[In, MarshalAs(UnmanagedType.BStr)] string	thumbnail,
		[In] int	PictureSize,
		[In] CMP_CAPTURE_QUALITY	Quality,
		[In] CMP_CAPTURE_CAMERA	CameraSelection,
		[In] CMP_IMAGE_FORMAT	Encoding,
		[In] int	DesiredWidth,
		[In] int	DesiredHeight,
		[In] CMP_THUMBNAIL_TYPE	ThumbnailType,
		[In] short	ThumbnailWidth,
		[In] short	ThumbnailHeight
	)

Implemented in CitrixMobility.ICMPEvents_SinkHelper.

void ICMPEvents::PictureTaken	(	[In, ComAliasName("CitrixMobility.CMPRESULT")] int	rc,
		[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int	PictureID,
		[In] CMP_IMAGE_FORMAT	Format,
		[In] int	PictureSize,
		[In, MarshalAs(UnmanagedType.BStr)] string	Filename
	)

Event: Picture taken.

Parameters:

[in]	rc	result of last request
[in]	PictureID	unique picture identifier
[in]	Format	type of picture taken (JPEG, PNG)
[in]	PictureSize	size of the picture
[in]	Filename	location of picture using filename

Implemented in CitrixMobility.ICMPEvents_SinkHelper.

void ICMPEvents::ScrollModeChanged	(	[In, ComAliasName("CitrixMobility.CMPRESULT")] int	rc,
		[In] CMP_SCROLL_MODE	ScrollMode
	)

Event: Scroll mode changed.

Parameters:

[in]	rc	result of last request
[in]	ScrollMode	current scroll mode

Implemented in CitrixMobility.ICMPEvents_SinkHelper.

void ICMPEvents::SessionStateChanged

(

[In] CMP_SESSION_STATE

SessState

)

Event: Session state changed.

Parameters:

[in]

SessState

latest state for the session

Implemented in CitrixMobility.ICMPEvents_SinkHelper.

void ICMPEvents::SMSStarted	(	[In, ComAliasName("CitrixMobility.CMPRESULT")] int	rc,
		[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int	MsgId
	)

Event: Send SMS Started.

Parameters:

[in]	rc	result of last request
[in]	MsgId	unique SMS identifier for request

Implemented in CitrixMobility.ICMPEvents_SinkHelper.

void CitrixMobility.ICMPEvents.SupportedOrientationsChanged	(	[In, ComAliasName("CitrixMobility.CMPRESULT")] int	rc,
		[In] CMP_SUPPORTED_ORIENTATIONS	supportedOrientations
	)

Implemented in CitrixMobility.ICMPEvents_SinkHelper.

void ICMPEvents::UserNotified	(	[In, ComAliasName("CitrixMobility.CMPRESULT")] int	rc,
		[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int	NotificationId
	)

Event: User notified.

Parameters:

[in]	rc	result of last request
[in]	NotificationId	unique notification identifier

Implemented in CitrixMobility.ICMPEvents_SinkHelper.

void CitrixMobility.ICMPEvents.VideoCaptured	(	[In, ComAliasName("CitrixMobility.CMPRESULT")] int	rc,
		[In, ComAliasName("CitrixMobility.CMP_UNIQUE_LONG_ID")] long	uniqueId,
		[In, MarshalAs(UnmanagedType.BStr)] string	videoMetadata,
		[In, MarshalAs(UnmanagedType.BStr)] string	Filename,
		[In] int	videoSize,
		[In] CMP_CAPTURE_QUALITY	Quality,
		[In] CMP_CAPTURE_CAMERA	CameraSelection,
		[In] CMP_VIDEO_ENCODING	Encoding,
		[In] int	DesiredWidth,
		[In] int	DesiredHeight,
		[In] int	DurationLimit
	)

Implemented in CitrixMobility.ICMPEvents_SinkHelper.

void ICMPEvents::ViewportChanged	(	[In, ComAliasName("CitrixMobility.CMPRESULT")] int	rc,
		[In] short	flags,
		[In] short	zoomFactor,
		[In] int	x0Server,
		[In] int	y0Server,
		[In] int	x1Server,
		[In] int	y1Server,
		[In] int	x0Client,
		[In] int	y0Client,
		[In] int	x1Client,
		[In] int	y1Client
	)

Event: Viewport changed.

Parameters:

[in]	rc	result of last request
[in]	flags	indicates which fields are valid
[in]	zoomFactor	amount of zoom to applied to server viewport
[in]	x0Server	server viewport left x coordinate
[in]	y0Server	server viewport top y coordinate
[in]	x1Server	server viewport right x coordinate
[in]	y1Server	server viewport bottom y coordinate
[in]	x0Client	client viewport left x coordinate
[in]	y0Client	client viewport top y coordinate
[in]	x1Client	client viewport right x coordinate
[in]	y1Client	client viewport bottom y coordinate

Implemented in CitrixMobility.ICMPEvents_SinkHelper.

void ICMPEvents::ViewportOriginChanged	(	[In, ComAliasName("CitrixMobility.CMPRESULT")] int	rc,
		[In] int	xLeft,
		[In] int	yTop
	)

Event: Viewport origin changed.

Parameters:

[in]	rc	result of last request
[in]	xLeft	left most position
[in]	yTop	top most position

Implemented in CitrixMobility.ICMPEvents_SinkHelper.

---

The documentation for this interface was generated from the following files:

• InteropCMPReflector.cs
• cmpcom_en.txt