VideoOS.Platform.Messaging.MessageId.SmartClient Class Reference

This class is a collection of static strings mostly for use when executing in the Smart Client
The 4 playback message Id's can also be used for a ImageViewerControl running in the .Net Library. More...

Static Public Attributes
const string	AddToExportCommand = "SmartClient.AddToExportCommand"
	Adds a list of cameras to the export workspace in Smart Client. The Data field needs to be filled with an instance of the AddToExportCommandData class.
const String	ApplicationControlCommand = "SmartClient.ApplicationControlCommand"
	A set of commands to control how the Smart Client application panels looks. The Data field should contain one of the commands defined in ApplicationControlCommandData. The commands are the same as can be issued by the Smart Client user when is clicking or double clicking at specific places.
const String	ChangeModeCommand = "SmartClient.ChangeModeCommand"
	Instruct the Smart Client to change mode. The Data field should contain the new Mode. Relevant values for the Smart Client are: ClientSetup, ClientLive and ClientPlayback.
const String	ChangeThemeCommand = "SmartClient.ChangeThemeCommand"
	Instruct the Smart Client to change the current theme. The Data field should contain the new theme.
const String	ChangeWorkSpaceStateCommand = "SmartClient.ChangeWorkSpaceStateCommand"
	Instruct the Smart Client to change the current workspace state. The Data field should contain the new workspace state.
const String	ClearIndicatorCommand = "SmartClient.ClearIndicatorCommand"
	Clear the motion and event indicators on the top bar of the ImageViewerControl. The Data field need to contains one of the ClearIndicatorCommandData strings to instruct what to clear.
const String	GetCurrentPlaybackTimeRequest = "SmartClient.GetCurrentPlaybackTimeRequest"
	This request can be send by a plug-in executing in the Smart Client and the .Net Library to retrieve the current time of the playback. the result is a DateTime.
const string	GetCurrentWorkspaceRequest = "SmartClient.GetCurrentWorkspaceRequest"
	Request the currently shown workspace for the window specified in the destination parameter. The Destination parameter of SendMessage is used to identify from which window to get the result. Default (or null) means main window. The response will be the item representing the workspace.
const String	GetSelectedCameraRequest = "SmartClient.GetSelectedCameraRequest"
	To request the current selected camera FQID. The returned object is the selected camera FQID, or null if none is selected.
const String	GetSelectedViewItemRequest = "SmartClient.GetSelectedViewItemRequest"
	To request the current selected view item. The returned object is the FQID representing the selected view item, and can be used to match up with the ViewAndLayoutItem (and children) send out by the SelectedViewChangedIndication.
const string	GetTimelineSelectedIntervalRequest = "SmartClient.GetTimelineSelectedIntervalRequest"
	This request can be send by a plug-in executing in the Smart Client to retrieve the current selected interval of the timeline. The destination should be null for the main window timeline and otherwise the FQID of the playback controller for any other window. The result is a TimeInterval or TimeInterval.Zero if no selection is available.
const string	IsDirectInputHIDHandledByPlugInRequest = "SmartClient.HID.IsDirectInputHIDHandledByPluginRequest"
	Send by the DirectInput HID plugin to request other HID plugins to respond on whether they handle a specific DirectInput device. The device identification can be extracted through the Data property of the message. The Data property of the message is of type IsDirectInputHIDHandledByPlugInRequestData. The response to this message should be a boolean value. If the response is set to true the DirectInput HID plugin will ignore the device.
const String	MultiWindowCommand = "SmartClient.MultiWindowCommand"
	Contain a set of commands to control windows, views and screens for the Smart Client. By this command you can select views, open and close floating windows and more. The Data field must contain the MultiWindowCommandData structure filled with relevant fields. The MultiWindowCommandData field must contains one of the command contained in the MultiWindowCommand class, e.g. same namespace as this command! What fields is used for each command is documented for each command.
const String	PlaybackCommand = "SmartClient.PlaybackCommand"
	Playback Commands can used to sent to the Playback control - just as if a user had set the time on the UI control. The Data field need to be filled with the PlaybackCommandData structure, where the PlaybackCommandData.Command contains one of the commands defined in PlaybackData class, and for the GoTo command the PlaybackCommandData.DateTime field need to be filled.
const String	PlaybackCurrentTimeIndication = "SmartClient.PlaybackCurrentTimeIndication"
	The PlaybackCurrentTimeIndication can be used to retrieve display time when the playback UserControl, either because of user action or running playback. If running normal speed playback, this message will be retrieved very often, e.g. 25 times a second. The actual DateTime will be stored in the Message.Data field. This message can be used to synchronize other kind of data and text with the video being shown.
const String	PlaybackIndication = "SmartClient.PlaybackIndication"
	When the PlaybackController has received a command to change speed, mode, direction etc - this message will be send with the Data field containing the PlaybackCommandData content. This can be used to synchronize other kind of data and text with the video being shown.
const String	PlaybackSkipModeCommand = "SmartClient.PlaybackSkipModeCommand"
	Is used to instruct a PlaybackController what to do when end of a sequence (e.g. continues video) is reached on selected ImageViewerControl. The Data field is filled with one of the modes in: PlaybackSkipModeData, e.g. PlaybackSkipModeData.Skip, PlaybackSkipModeData.NoSkip, PlaybackSkipModeData.StopAtSequenceEnd.
const String	PlaybackTimeInformation = "SmartClient.PlaybackDeviceInformation"
	This command is used to inform the PlaybackController at what time there is data from a specific Item. The Data field must contain the PlaybackTimeInformationData class with relevant content.
const string	PtzCommandOccurredIndication = "SmartClient.PtzCommandOccurredIndication"
	Send when the operator moves a camera. The RelatedFQID contains the camera's FQID.
const string	RefreshTimelineRequest = "SmartClient.RefreshTimelineRequest"
	Instruct the Smart Client to refresh the time in relation to the TimelineSequenceSource in RelatedFQID (only ObjectId is used). The Data field is not used for this message.
const String	ReloadConfigurationCommand = "SmartClient.ReloadConfigurationCommand"
	This message will reload the entire configuration from all sites and all views from the server. This message takes time, please use with care.
const string	SelectAlarmCommand = "SmartClient.SelectAlarmCommand"
	Request the Smart Client Alarm List to select the alarm. Data in the request should contain the Guid of the alarm. If the destination is null, all windows will be affected. If destination contains a FQID, it has to be the ID of the window which should select the alarm. Windows will ignore the alarm, if the FQID isn't theirs.
const String	SelectedCameraChangedIndication = "SmartClient.SelectedCameraChangedIndication"
	Send when the user selects a new camera view item. RelatedFQID contains new ID.
const String	SelectedViewChangedIndication = "SmartClient.SelectedViewChangedIndication"
	Send by the Smart Client when a view has changed. The Data field contains the ViewAndLayoutItem for the new view, or null when a floating or secondary window is being closed. The sender FQID contains the id for the window, e.g. null or ObjectId == Kind.Window for main window, otherwise a specific FQID.
const String	SelectedViewItemChangedIndication = "SmartClient.SelectedViewItemChangedIndication"
	Is send by the Smart Client when the operator selects any ViewItem. The RelatedFQID identifies the selected ViewItem, and can be used to match up with the ViewAndLayoutItem (and children) send out by the SelectedViewChangedIndication.
const String	SelectMicrophoneCommand = "SmartClient.SelectMicrophoneCommand"
	Sets the selected microphone in the Smart Client's side panel to RelatedFQID passed with this message. Note: Only works in the Smart Client.
const String	SelectSpeakerCommand = "SmartClient.SelectSpeakerCommand"
	Sets the selected speaker in the Smart Client's side panel to RelatedFQID passed with this message. Note: Only works in the Smart Client.
const String	SetCameraInViewCommand = "SmartClient.SetCameraInViewCommand"
	This command requires the SetCameraInViewCommandData to be filled and assigned in the Data field.
const String	SetSelectedViewItemCommand = "SmartClient.SetSelectedViewItemCommand"
	Set a specific ViewItem as selected within current Window. The SetSelectedViewItemData needs to be filled and assigned to the Data field of the message.
const string	ShowCamerasInFloatingWindowCommand = "SmartClient.ShowCamerasInFloatingWindowCommand"
	Creates a new floating window with a set of cameras. The Data field needs to be filled with the ShowCamerasInFloatingWindowData class.
static String	ShownWorkSpaceChangedIndication = "SmartClient.ShownWorkSpaceChangedIndication"
	Is send when the Smart Client changed the shown workspace. The Data field contains the item for the new workspace.
const string	ShowSettingsDialogCommand = "SmartClient.ShowSettingsDialogCommand"
	Opens the settings dialog and optionally navigates to a specific tab in the settings dialog. The Data field can optionally be filled with the ID of the SettingsPanelPlugin (or OptionsDialogPlugin) to navigate to.
const String	ShowWorkSpaceCommand = "SmartClient.ShowWorkSpaceCommand"
	Instruct the Smart Client show a workspace. RelatedFQID contains the id of the work space to show.
const String	SmartClientMessageButtonClickedIndication = "SmartClient.SmartClientMessageButtonClickedIndication"
	This message is sent within the SmartClient when a message button is clicked by the user. The Data field contains the MessageId of the relevant job message.
const String	SmartClientMessageCommand = "SmartClient.SmartClientMessageCommand"
	Identifies that a message is to be displayed to the operator. Currently the message is displayed in the message bar located at the top of the main Smart Client window. The message is configured by filling out a F object that is added to the Data field of the message command. The Message can be updated by successive message commands with a SmartClientMessageData containing the same messageId. Use the properties of SmartClientMessageData to control the appearance of the message. E.g. display a button or a progress bar as part of the messages, or control whether the user can close the message or not. Set up message listeners on SmartClientMessageButtonClickedIndication and SmartClientMessageRemovedIndication to get notifications about when the user clicks the message button or the message is removed respectively. The Data field needs to be filled with the SmartClientMessageData class. Setting the SmartClientMessageData.Message to string.Empty will remove the message.
const String	SmartClientMessageRemovedIndication = "SmartClient.SmartClientMessageRemovedIndication"
	This message is sent within the SmartClient when a message created by a plugin is removed from the UI. The Data field contains the MessageId of the relevant job message.
const String	SmartClientTimeZoneChangedIndication = "SmartClient.SmartClientTimeZoneChangedIndication"
	This message is sent within the SmartClient when the ClientControl.SelectedTimeZone has changed. The plugin should display all date/time information in the selected time zone. The Data field contains the new TimeZoneInfo.
const string	SmartMapGetPositionRequest = "SmartClient.SmartMapGetPositionRequest"
	Request the currently shown position from the Smart Map. The Data field needs to be filled with an instance of the SmartMapGetPositionRequestData class. The response will be an instance of the SmartMapPositionData class. Destination parameter of SendMessage/PostMessage is ignored. Destination instance is specified in the data object.
const string	SmartMapGoToAreaCommand = "SmartClient.SmartMapGoToAreaCommand"
	Instruct the Smart Map to go to a specific area. The Data field needs to be filled with an instance of the SmartMapGoToAreaCommandData class. Destination parameter of SendMessage/PostMessage is ignored. Destination instance is specified in the data object.
const string	SmartMapGoToLocationCommand = "SmartClient.SmartMapGoToLocationCommand"
	Instruct the Smart Map to go to a specific location. The Data field needs to be filled with an instance of the SmartMapGoToLocationCommandData class. Destination parameter of SendMessage/PostMessage is ignored. Destination instance is specified in the data object.
const string	SmartMapGoToPositionCommand = "SmartClient.SmartMapGoToPositionCommand"
	Instruct the Smart Map to go to a specific coordinate. The Data field needs to be filled with an instance of the SmartMapGoToPositionCommandData class. Destination parameter of SendMessage/PostMessage is ignored. Destination instance is specified in the data object.
const string	SmartMapNavigateToCamera = "SmartClient.SmartMapNavigateToCamera"
	This message is sent by Smart Client to navigate to camera in Smart Map. The Data field needs to be filled with an instance of the SmartMapNavigateToCameraData class. Destination parameter of SendMessage/PostMessage is ignored. Destination instance is specified in the data object.
const string	SmartMapNavigateToDevice = "SmartClient.SmartMapNavigateToDevice"
	This message is sent by Smart Client to navigate to a device in Smart Map. The Data field needs to be filled with an instance of the SmartMapNavigateToDeviceData class. Destination parameter of SendMessage/PostMessage is ignored. Destination instance is specified in the data object.
const string	SmartMapPositionChangedIndication = "SmartClient.SmartMapPositionChangedIndication"
	This message is sent by Smart Client when a Smart Map position is changed in Smart Client, for instance, when there is panning or zooming action on the map. The Data field needs to be filled with an instance of the SmartMapPositionData class. Destination parameter of SendMessage/PostMessage is ignored. Destination instance is specified in the data object.
const string	SmartMapSelectItemCommand = "SmartClient.SmartMapSelectItemCommand"
	Instruct the Smart Map to go to and select an item. Currently, it only supports Camera item The Data field needs to be filled with an instance of the SmartMapSelectItemCommandData class. Destination parameter of SendMessage/PostMessage is ignored. Destination instance is specified in the data object.
const String	TalkToSpeakerCommand = "SmartClient.TalkToSpeakerCommand"
	To open the PC microphone for audio going from PC to speaker attached to selected camera.
static String	ThemeChangedIndication = "SmartClient.ThemeChangedIndication"
	Is send when the Smart Client theme has changed. The Data field contains the new theme.
const String	ToastHideCommand = "SmartClient.ToastHideCommand"
	Requests that a toast message currently displayed by the Smart Client is removed. The id of the toast message that should be removed is set on the data field of the message command.
const String	ToastShowCommand = "SmartClient.ToastShowCommand"
	Requests that a toast message is displayed by the Smart Client. A toast message is a non-intrusive message that is displayed in the lower right corner of the screen. The toast message is configured by filling a specific specialization of SmartClientToastData and add it to the data field of the message command. The toast message can be updated by successive ToastShowCommand messages with a SmartClientToastData containing the same id, or removed completely using the ToastHideCommand message.
const String	ViewGroupModifiedIndication = "SmartClient.ViewGroupModifiedIndication"
	This message is send by the Smart Client when a view group has been modified. The Data field is null.
const String	ViewGroupsLoadedIndication = "SmartClient.ViewGroupsLoadedIndication"
	This message is sent by the Smart Client when all view groups has been loaded. Use the ClientControl.Instance.GetViewGroupItems() or ClientControl.Instance.GetSmartWallItems() to access the view groups.
const String	ViewItemControlCommand = "SmartClient.ViewItemControlCommand"
	A command that can instruct the Smart Client to minimize and maximize a ViewItem, as well as tick the digital zoom check mark on or off. The Data field should contain one of the commands defined in ViewItemControlCommandData.
const String	WindowStateChangedIndication = "SmartClient.WindowStateChangedIndication"
	Send when a window has changed state, the sender FQID identifies the window being changed, where main window is null.
const string	WorkSpaceReadyIndication = "SmartClient.WorkSpaceReadyIndication"
	This indication is fired after the ApplicationLoggedOnIndication, as an indication that the workspaces has been created in the Smart Client, and all workspace commands can be used.
static String	WorkSpaceStateChangedIndication = "SmartClient.WorkSpaceStateChangedIndication"
	Is send when the Smart Client workspace state has changed. The Data field contains the new WorkSpaceState.

Detailed Description

This class is a collection of static strings mostly for use when executing in the Smart Client
The 4 playback message Id's can also be used for a ImageViewerControl running in the .Net Library.

Member Data Documentation

AddToExportCommand

const string VideoOS.Platform.Messaging.MessageId.SmartClient.AddToExportCommand = "SmartClient.AddToExportCommand"

static

Adds a list of cameras to the export workspace in Smart Client. The Data field needs to be filled with an instance of the AddToExportCommandData class.

Supported from Smart Client 2022 R2

ApplicationControlCommand

const String VideoOS.Platform.Messaging.MessageId.SmartClient.ApplicationControlCommand = "SmartClient.ApplicationControlCommand"

static

A set of commands to control how the Smart Client application panels looks. The Data field should contain one of the commands defined in ApplicationControlCommandData. The commands are the same as can be issued by the Smart Client user when is clicking or double clicking at specific places.

ChangeModeCommand

const String VideoOS.Platform.Messaging.MessageId.SmartClient.ChangeModeCommand = "SmartClient.ChangeModeCommand"

static

Instruct the Smart Client to change mode. The Data field should contain the new Mode.
Relevant values for the Smart Client are: ClientSetup, ClientLive and ClientPlayback.

Note: Do not use this message in Smart Client plugins when handling the main window, in that case use ShowWorkSpaceCommand instead.
Note: For changing mode on a PlaybackController - see the System.ModeChangeCommand message

ChangeThemeCommand

const String VideoOS.Platform.Messaging.MessageId.SmartClient.ChangeThemeCommand = "SmartClient.ChangeThemeCommand"

static

Instruct the Smart Client to change the current theme. The Data field should contain the new theme.

ChangeWorkSpaceStateCommand

const String VideoOS.Platform.Messaging.MessageId.SmartClient.ChangeWorkSpaceStateCommand = "SmartClient.ChangeWorkSpaceStateCommand"

static

Instruct the Smart Client to change the current workspace state. The Data field should contain the new workspace state.

ClearIndicatorCommand

const String VideoOS.Platform.Messaging.MessageId.SmartClient.ClearIndicatorCommand = "SmartClient.ClearIndicatorCommand"

static

Clear the motion and event indicators on the top bar of the ImageViewerControl.
The Data field need to contains one of the ClearIndicatorCommandData strings to instruct what to clear.

GetCurrentPlaybackTimeRequest

const String VideoOS.Platform.Messaging.MessageId.SmartClient.GetCurrentPlaybackTimeRequest = "SmartClient.GetCurrentPlaybackTimeRequest"

static

This request can be send by a plug-in executing in the Smart Client and the .Net Library to retrieve the current time of the playback.
the result is a DateTime.

GetCurrentWorkspaceRequest

const string VideoOS.Platform.Messaging.MessageId.SmartClient.GetCurrentWorkspaceRequest = "SmartClient.GetCurrentWorkspaceRequest"

static

Request the currently shown workspace for the window specified in the destination parameter.
The Destination parameter of SendMessage is used to identify from which window to get the result. Default (or null) means main window.
The response will be the item representing the workspace.

GetSelectedCameraRequest

const String VideoOS.Platform.Messaging.MessageId.SmartClient.GetSelectedCameraRequest = "SmartClient.GetSelectedCameraRequest"

static

To request the current selected camera FQID. The returned object is the selected camera FQID, or null if none is selected.

GetSelectedViewItemRequest

const String VideoOS.Platform.Messaging.MessageId.SmartClient.GetSelectedViewItemRequest = "SmartClient.GetSelectedViewItemRequest"

static

To request the current selected view item. The returned object is the FQID representing the selected view item, and can be used to match up with the ViewAndLayoutItem (and children) send out by the SelectedViewChangedIndication.

GetTimelineSelectedIntervalRequest

const string VideoOS.Platform.Messaging.MessageId.SmartClient.GetTimelineSelectedIntervalRequest = "SmartClient.GetTimelineSelectedIntervalRequest"

static

This request can be send by a plug-in executing in the Smart Client to retrieve the current selected interval of the timeline.
The destination should be null for the main window timeline and otherwise the FQID of the playback controller for any other window.
The result is a TimeInterval or TimeInterval.Zero if no selection is available.

IsDirectInputHIDHandledByPlugInRequest

const string VideoOS.Platform.Messaging.MessageId.SmartClient.IsDirectInputHIDHandledByPlugInRequest = "SmartClient.HID.IsDirectInputHIDHandledByPluginRequest"

static

Send by the DirectInput HID plugin to request other HID plugins to respond on whether they handle a specific DirectInput device. The device identification can be extracted through the Data property of the message. The Data property of the message is of type IsDirectInputHIDHandledByPlugInRequestData.
The response to this message should be a boolean value. If the response is set to true the DirectInput HID plugin will ignore the device.

MultiWindowCommand

const String VideoOS.Platform.Messaging.MessageId.SmartClient.MultiWindowCommand = "SmartClient.MultiWindowCommand"

static

Contain a set of commands to control windows, views and screens for the Smart Client.
By this command you can select views, open and close floating windows and more.
The Data field must contain the MultiWindowCommandData structure filled with relevant fields. The MultiWindowCommandData field must contains one of the command contained in the MultiWindowCommand class, e.g. same namespace as this command!
What fields is used for each command is documented for each command.

PlaybackCommand

const String VideoOS.Platform.Messaging.MessageId.SmartClient.PlaybackCommand = "SmartClient.PlaybackCommand"

static

Playback Commands can used to sent to the Playback control - just as if a user had set the time on the UI control. The Data field need to be filled with the PlaybackCommandData structure, where the PlaybackCommandData.Command contains one of the commands defined in PlaybackData class, and for the GoTo command the PlaybackCommandData.DateTime field need to be filled.

PlaybackCurrentTimeIndication

const String VideoOS.Platform.Messaging.MessageId.SmartClient.PlaybackCurrentTimeIndication = "SmartClient.PlaybackCurrentTimeIndication"

static

The PlaybackCurrentTimeIndication can be used to retrieve display time when the playback UserControl, either because of user action or running playback.
If running normal speed playback, this message will be retrieved very often, e.g. 25 times a second.
The actual DateTime will be stored in the Message.Data field.
This message can be used to synchronize other kind of data and text with the video being shown.

PlaybackIndication

const String VideoOS.Platform.Messaging.MessageId.SmartClient.PlaybackIndication = "SmartClient.PlaybackIndication"

static

When the PlaybackController has received a command to change speed, mode, direction etc - this message will be send with the Data field containing the PlaybackCommandData content.
This can be used to synchronize other kind of data and text with the video being shown.

PlaybackSkipModeCommand

const String VideoOS.Platform.Messaging.MessageId.SmartClient.PlaybackSkipModeCommand = "SmartClient.PlaybackSkipModeCommand"

static

Is used to instruct a PlaybackController what to do when end of a sequence (e.g. continues video) is reached on selected ImageViewerControl. The Data field is filled with one of the modes in: PlaybackSkipModeData, e.g. PlaybackSkipModeData.Skip, PlaybackSkipModeData.NoSkip, PlaybackSkipModeData.StopAtSequenceEnd.

The destination for the SendMessage must be the identification of the PlaybackController that should act on the command. This can be either null, for the built-in default playback controller, or the FQID returned from the creation of a playback controller ClientControl.Instance.GeneratePlaybackController().

PlaybackTimeInformation

const String VideoOS.Platform.Messaging.MessageId.SmartClient.PlaybackTimeInformation = "SmartClient.PlaybackDeviceInformation"

static

This command is used to inform the PlaybackController at what time there is data from a specific Item.
The Data field must contain the PlaybackTimeInformationData class with relevant content.

PtzCommandOccurredIndication

const string VideoOS.Platform.Messaging.MessageId.SmartClient.PtzCommandOccurredIndication = "SmartClient.PtzCommandOccurredIndication"

static

Send when the operator moves a camera. The RelatedFQID contains the camera's FQID.

RefreshTimelineRequest

const string VideoOS.Platform.Messaging.MessageId.SmartClient.RefreshTimelineRequest = "SmartClient.RefreshTimelineRequest"

static

Instruct the Smart Client to refresh the time in relation to the TimelineSequenceSource in RelatedFQID (only ObjectId is used). The Data field is not used for this message.

ReloadConfigurationCommand

const String VideoOS.Platform.Messaging.MessageId.SmartClient.ReloadConfigurationCommand = "SmartClient.ReloadConfigurationCommand"

static

This message will reload the entire configuration from all sites and all views from the server. This message takes time, please use with care.

SelectAlarmCommand

const string VideoOS.Platform.Messaging.MessageId.SmartClient.SelectAlarmCommand = "SmartClient.SelectAlarmCommand"

static

Request the Smart Client Alarm List to select the alarm. Data in the request should contain the Guid of the alarm. If the destination is null, all windows will be affected. If destination contains a FQID, it has to be the ID of the window which should select the alarm. Windows will ignore the alarm, if the FQID isn't theirs.

SelectedCameraChangedIndication

const String VideoOS.Platform.Messaging.MessageId.SmartClient.SelectedCameraChangedIndication = "SmartClient.SelectedCameraChangedIndication"

static

Send when the user selects a new camera view item. RelatedFQID contains new ID.

Notice: from 2017R3 floating windows will also issue this command, the 'sender' field will contain the FQID of the window sending this command.

SelectedViewChangedIndication

const String VideoOS.Platform.Messaging.MessageId.SmartClient.SelectedViewChangedIndication = "SmartClient.SelectedViewChangedIndication"

static

Send by the Smart Client when a view has changed. The Data field contains the ViewAndLayoutItem for the new view, or null when a floating or secondary window is being closed. The sender FQID contains the id for the window, e.g. null or ObjectId == Kind.Window for main window, otherwise a specific FQID.

SelectedViewItemChangedIndication

const String VideoOS.Platform.Messaging.MessageId.SmartClient.SelectedViewItemChangedIndication = "SmartClient.SelectedViewItemChangedIndication"

static

Is send by the Smart Client when the operator selects any ViewItem. The RelatedFQID identifies the selected ViewItem, and can be used to match up with the ViewAndLayoutItem (and children) send out by the SelectedViewChangedIndication.

SelectMicrophoneCommand

const String VideoOS.Platform.Messaging.MessageId.SmartClient.SelectMicrophoneCommand = "SmartClient.SelectMicrophoneCommand"

static

Sets the selected microphone in the Smart Client's side panel to RelatedFQID passed with this message.
Note: Only works in the Smart Client.

SelectSpeakerCommand

const String VideoOS.Platform.Messaging.MessageId.SmartClient.SelectSpeakerCommand = "SmartClient.SelectSpeakerCommand"

static

Sets the selected speaker in the Smart Client's side panel to RelatedFQID passed with this message.
Note: Only works in the Smart Client.

SetCameraInViewCommand

const String VideoOS.Platform.Messaging.MessageId.SmartClient.SetCameraInViewCommand = "SmartClient.SetCameraInViewCommand"

static

This command requires the SetCameraInViewCommandData to be filled and assigned in the Data field.

The Data contains a camera FQID and the index it should be inserted in. The index is numbered from zero to the max number of view items. The top left view item is index zero for all built-in view layouts, but can be different for plug-in developed view layouts.
The SendMessage() method or PostMessage() method will pass on this command to the window identified by the destination FQID. The window FQID can come from the MultiWindowCommand.OpenFloatingWindow or found through ItemPicker dialog or some search method.
The modification is NOT saved permanently. Note that you can send this command with CameraFQID = null to remove the current camera.

SetSelectedViewItemCommand

const String VideoOS.Platform.Messaging.MessageId.SmartClient.SetSelectedViewItemCommand = "SmartClient.SetSelectedViewItemCommand"

static

Set a specific ViewItem as selected within current Window.
The SetSelectedViewItemData needs to be filled and assigned to the Data field of the message.

ShowCamerasInFloatingWindowCommand

const string VideoOS.Platform.Messaging.MessageId.SmartClient.ShowCamerasInFloatingWindowCommand = "SmartClient.ShowCamerasInFloatingWindowCommand"

static

Creates a new floating window with a set of cameras.
The Data field needs to be filled with the ShowCamerasInFloatingWindowData class.

ShownWorkSpaceChangedIndication

String VideoOS.Platform.Messaging.MessageId.SmartClient.ShownWorkSpaceChangedIndication = "SmartClient.ShownWorkSpaceChangedIndication"

static

Is send when the Smart Client changed the shown workspace. The Data field contains the item for the new workspace.

ShowSettingsDialogCommand

const string VideoOS.Platform.Messaging.MessageId.SmartClient.ShowSettingsDialogCommand = "SmartClient.ShowSettingsDialogCommand"

static

Opens the settings dialog and optionally navigates to a specific tab in the settings dialog.
The Data field can optionally be filled with the ID of the SettingsPanelPlugin (or OptionsDialogPlugin) to navigate to.

ShowWorkSpaceCommand

const String VideoOS.Platform.Messaging.MessageId.SmartClient.ShowWorkSpaceCommand = "SmartClient.ShowWorkSpaceCommand"

static

Instruct the Smart Client show a workspace. RelatedFQID contains the id of the work space to show.

SmartClientMessageButtonClickedIndication

const String VideoOS.Platform.Messaging.MessageId.SmartClient.SmartClientMessageButtonClickedIndication = "SmartClient.SmartClientMessageButtonClickedIndication"

static

This message is sent within the SmartClient when a message button is clicked by the user. The Data field contains the MessageId of the relevant job message.

SmartClientMessageCommand

const String VideoOS.Platform.Messaging.MessageId.SmartClient.SmartClientMessageCommand = "SmartClient.SmartClientMessageCommand"

static

Identifies that a message is to be displayed to the operator. Currently the message is displayed in the message bar located at the top of the main Smart Client window. The message is configured by filling out a F object that is added to the Data field of the message command. The Message can be updated by successive message commands with a SmartClientMessageData containing the same messageId.
Use the properties of SmartClientMessageData to control the appearance of the message. E.g. display a button or a progress bar as part of the messages, or control whether the user can close the message or not.
Set up message listeners on SmartClientMessageButtonClickedIndication and SmartClientMessageRemovedIndication to get notifications about when the user clicks the message button or the message is removed respectively.
The Data field needs to be filled with the SmartClientMessageData class. Setting the SmartClientMessageData.Message to string.Empty will remove the message.

SmartClientMessageRemovedIndication

const String VideoOS.Platform.Messaging.MessageId.SmartClient.SmartClientMessageRemovedIndication = "SmartClient.SmartClientMessageRemovedIndication"

static

This message is sent within the SmartClient when a message created by a plugin is removed from the UI. The Data field contains the MessageId of the relevant job message.

SmartClientTimeZoneChangedIndication

const String VideoOS.Platform.Messaging.MessageId.SmartClient.SmartClientTimeZoneChangedIndication = "SmartClient.SmartClientTimeZoneChangedIndication"

static

This message is sent within the SmartClient when the ClientControl.SelectedTimeZone has changed.
The plugin should display all date/time information in the selected time zone.
The Data field contains the new TimeZoneInfo.

SmartMapGetPositionRequest

const string VideoOS.Platform.Messaging.MessageId.SmartClient.SmartMapGetPositionRequest = "SmartClient.SmartMapGetPositionRequest"

static

Request the currently shown position from the Smart Map.
The Data field needs to be filled with an instance of the SmartMapGetPositionRequestData class.
The response will be an instance of the SmartMapPositionData class.
Destination parameter of SendMessage/PostMessage is ignored. Destination instance is specified in the data object.

SmartMapGoToAreaCommand

const string VideoOS.Platform.Messaging.MessageId.SmartClient.SmartMapGoToAreaCommand = "SmartClient.SmartMapGoToAreaCommand"

static

Instruct the Smart Map to go to a specific area. The Data field needs to be filled with an instance of the SmartMapGoToAreaCommandData class.
Destination parameter of SendMessage/PostMessage is ignored. Destination instance is specified in the data object.

SmartMapGoToLocationCommand

const string VideoOS.Platform.Messaging.MessageId.SmartClient.SmartMapGoToLocationCommand = "SmartClient.SmartMapGoToLocationCommand"

static

Instruct the Smart Map to go to a specific location. The Data field needs to be filled with an instance of the SmartMapGoToLocationCommandData class.
Destination parameter of SendMessage/PostMessage is ignored. Destination instance is specified in the data object.

SmartMapGoToPositionCommand

const string VideoOS.Platform.Messaging.MessageId.SmartClient.SmartMapGoToPositionCommand = "SmartClient.SmartMapGoToPositionCommand"

static

Instruct the Smart Map to go to a specific coordinate.
The Data field needs to be filled with an instance of the SmartMapGoToPositionCommandData class.
Destination parameter of SendMessage/PostMessage is ignored. Destination instance is specified in the data object.

SmartMapNavigateToCamera

const string VideoOS.Platform.Messaging.MessageId.SmartClient.SmartMapNavigateToCamera = "SmartClient.SmartMapNavigateToCamera"

static

This message is sent by Smart Client to navigate to camera in Smart Map. The Data field needs to be filled with an instance of the SmartMapNavigateToCameraData class.
Destination parameter of SendMessage/PostMessage is ignored. Destination instance is specified in the data object.

SmartMapNavigateToDevice

const string VideoOS.Platform.Messaging.MessageId.SmartClient.SmartMapNavigateToDevice = "SmartClient.SmartMapNavigateToDevice"

static

This message is sent by Smart Client to navigate to a device in Smart Map. The Data field needs to be filled with an instance of the SmartMapNavigateToDeviceData class.
Destination parameter of SendMessage/PostMessage is ignored. Destination instance is specified in the data object.

SmartMapPositionChangedIndication

const string VideoOS.Platform.Messaging.MessageId.SmartClient.SmartMapPositionChangedIndication = "SmartClient.SmartMapPositionChangedIndication"

static

This message is sent by Smart Client when a Smart Map position is changed in Smart Client, for instance, when there is panning or zooming action on the map. The Data field needs to be filled with an instance of the SmartMapPositionData class.
Destination parameter of SendMessage/PostMessage is ignored. Destination instance is specified in the data object.

SmartMapSelectItemCommand

const string VideoOS.Platform.Messaging.MessageId.SmartClient.SmartMapSelectItemCommand = "SmartClient.SmartMapSelectItemCommand"

static

Instruct the Smart Map to go to and select an item. Currently, it only supports Camera item The Data field needs to be filled with an instance of the SmartMapSelectItemCommandData class.
Destination parameter of SendMessage/PostMessage is ignored. Destination instance is specified in the data object.

TalkToSpeakerCommand

const String VideoOS.Platform.Messaging.MessageId.SmartClient.TalkToSpeakerCommand = "SmartClient.TalkToSpeakerCommand"

static

To open the PC microphone for audio going from PC to speaker attached to selected camera.

ThemeChangedIndication

String VideoOS.Platform.Messaging.MessageId.SmartClient.ThemeChangedIndication = "SmartClient.ThemeChangedIndication"

static

Is send when the Smart Client theme has changed. The Data field contains the new theme.

ToastHideCommand

const String VideoOS.Platform.Messaging.MessageId.SmartClient.ToastHideCommand = "SmartClient.ToastHideCommand"

static

Requests that a toast message currently displayed by the Smart Client is removed. The id of the toast message that should be removed is set on the data field of the message command.

ToastShowCommand

const String VideoOS.Platform.Messaging.MessageId.SmartClient.ToastShowCommand = "SmartClient.ToastShowCommand"

static

Requests that a toast message is displayed by the Smart Client. A toast message is a non-intrusive message that is displayed in the lower right corner of the screen. The toast message is configured by filling a specific specialization of SmartClientToastData and add it to the data field of the message command. The toast message can be updated by successive ToastShowCommand messages with a SmartClientToastData containing the same id, or removed completely using the ToastHideCommand message.

ViewGroupModifiedIndication

const String VideoOS.Platform.Messaging.MessageId.SmartClient.ViewGroupModifiedIndication = "SmartClient.ViewGroupModifiedIndication"

static

This message is send by the Smart Client when a view group has been modified. The Data field is null.

ViewGroupsLoadedIndication

const String VideoOS.Platform.Messaging.MessageId.SmartClient.ViewGroupsLoadedIndication = "SmartClient.ViewGroupsLoadedIndication"

static

This message is sent by the Smart Client when all view groups has been loaded. Use the ClientControl.Instance.GetViewGroupItems() or ClientControl.Instance.GetSmartWallItems() to access the view groups.

ViewItemControlCommand

const String VideoOS.Platform.Messaging.MessageId.SmartClient.ViewItemControlCommand = "SmartClient.ViewItemControlCommand"

static

A command that can instruct the Smart Client to minimize and maximize a ViewItem, as well as tick the digital zoom check mark on or off.
The Data field should contain one of the commands defined in ViewItemControlCommandData.

WindowStateChangedIndication

const String VideoOS.Platform.Messaging.MessageId.SmartClient.WindowStateChangedIndication = "SmartClient.WindowStateChangedIndication"

static

Send when a window has changed state, the sender FQID identifies the window being changed, where main window is null.

WorkSpaceReadyIndication

const string VideoOS.Platform.Messaging.MessageId.SmartClient.WorkSpaceReadyIndication = "SmartClient.WorkSpaceReadyIndication"

static

This indication is fired after the ApplicationLoggedOnIndication, as an indication that the workspaces has been created in the Smart Client, and all workspace commands can be used.

WorkSpaceStateChangedIndication

String VideoOS.Platform.Messaging.MessageId.SmartClient.WorkSpaceStateChangedIndication = "SmartClient.WorkSpaceStateChangedIndication"

static

Is send when the Smart Client workspace state has changed. The Data field contains the new WorkSpaceState.