![]() |
C# Sample
Demonstrates how to create a C# application using the VideoXpert SDK
|
Public Member Functions | |
MainForm () | |
Initializes a new instance of the MainForm class. More... | |
void | OnInternalEvent (InternalEvent internalEvent) |
The OnInternalEvent method. More... | |
void | OnSystemEvent (Event systemEvent) |
The OnSystemEvent method. More... | |
async Task< HttpResponseMessage > | SendRequest (Uri uri) |
The SendRequest method. More... | |
void | WriteToLog (string message) |
The WriteToLog method. More... | |
void | SetManualRecordingStatus () |
Sets the state of the manual recording UI elements based on the manual recording status of the current stream. More... | |
void | SubscribeToInternalEvents () |
Subscribes to internal VxSDK events. More... | |
Properties | |
static List< Device > | CurrentDevices [get, set] |
Gets or sets the CurrentDevices property. More... | |
static List< DataSource > | CurrentDataSources [get, set] |
Gets or sets the CurrentDataSources property. More... | |
static string | CurrentPassword [get, set] |
Gets or sets the CurrentPassword property. More... | |
static VXSystem | CurrentSystem [get, set] |
Gets or sets the CurrentSystem property. More... | |
static string | CurrentUserName [get, set] |
Gets or sets the CurrentUserName property. More... | |
static string | LogPath [get, set] |
Gets or sets the LogPath property. More... | |
static string | SnapshotBasePath [get, set] |
Gets or sets the SnapshotBasePath property. More... | |
static MainForm | Instance [get, private set] |
Gets the Instance property. More... | |
static PTZControlForm | PtzForm [get, set] |
Gets or sets the PtzForm property. More... | |
ControlManager | Control [get, set] |
Gets or sets the Control property. More... | |
Private Member Functions | |
void | ButtonLive_Click (object sender, EventArgs args) |
The ButtonLive_Click method. More... | |
void | ButtonManualRecord_Click (object sender, EventArgs args) |
The ButtonManualRecord_Click method. More... | |
void | ButtonPause_Click (object sender, EventArgs args) |
The ButtonPause_Click method. More... | |
void | ButtonPlay_Click (object sender, EventArgs args) |
The ButtonPlay_Click method. More... | |
void | ButtonRefreshDataSources_Click (object sender, EventArgs args) |
The ButtonRefreshDataSources_Click method. More... | |
void | ButtonSeek_Click (object sender, EventArgs args) |
The ButtonSeek_Click method. More... | |
void | ButtonSnapshot_Click (object sender, EventArgs args) |
The ButtonSnapshot_Click method. More... | |
void | ButtonStop_Click (object sender, EventArgs args) |
The ButtonStop_Click method. More... | |
void | GridViewDataSources_CellDoubleClick (object sender, DataGridViewCellEventArgs args) |
The GridViewDataSources_CellDoubleClick method. More... | |
void | MenuItemLog_Click (object sender, EventArgs args) |
The MenuItemLog_Click method. More... | |
void | MenuItemAlarmInputManager_Click (object sender, EventArgs args) |
The MenuItemAlarmInputManager_Click method. More... | |
void | MenuItemBookmarkManager_Click (object sender, EventArgs args) |
The MenuItemBookmarkManager_Click method. More... | |
void | MenuItemClusterConfig_Click (object sender, EventArgs args) |
The MenuItemClusterConfig_Click method. More... | |
void | MenuItemDataObjectManager_Click (object sender, EventArgs args) |
The MenuItemDataObjectManager_Click method. More... | |
void | MenuItemDataSourceManager_Click (object sender, EventArgs args) |
The MenuItemDataSourceManager_Click method. More... | |
void | MenuItemDataStorageManager_Click (object sender, EventArgs args) |
The MenuItemDataStorageManager_Click method. More... | |
void | MenuItemConnect_Click (object sender, EventArgs args) |
The MenuItemConnect_Click method. More... | |
void | MenuItemExit_Click (object sender, EventArgs args) |
The MenuItemExit_Click method. More... | |
void | MenuItemDeviceManager_Click (object sender, EventArgs args) |
The MenuItemDeviceManager_Click method. More... | |
void | MenuItemDrawingManager_Click (object sender, EventArgs args) |
The MenuItemDrawingManager_Click method. More... | |
void | MenuItemExportManager_Click (object sender, EventArgs args) |
The MenuItemExportManager_Click method. More... | |
void | MenuItemInsertEvent_Click (object sender, EventArgs args) |
The MenuItemInsertEvent_Click method. More... | |
void | MenuItemLogLevel_Click (object sender, EventArgs args) |
The MenuItemLogLevel_Click method. More... | |
void | MenuItemLicenseDetails_Click (object sender, EventArgs args) |
The MenuItemLicenseDetails_Click method. More... | |
void | MenuItemLogout_Click (object sender, EventArgs args) |
The MenuItemLogout_Click method. More... | |
void | MenuItemModifyLoggingPath_Click (object sender, EventArgs args) |
The MenuItemModifyLoggingPath_Click method. More... | |
void | MenuItemMonitors_Click (object sender, EventArgs args) |
The MenuItemMonitors_Click method. More... | |
void | MenuItemNotifications_Click (object sender, EventArgs args) |
The MenuItemNotifications_Click method. More... | |
void | MenuItemProtocol_Click (object sender, EventArgs args) |
The MenuItemProtocol_Click method. More... | |
void | MenuItemQuickLog_Click (object sender, EventArgs args) |
The MenuItemQuickLog_Click method. More... | |
void | MenuItemQuickReport_Click (object sender, EventArgs args) |
The MenuItemQuickReport_Click method. More... | |
void | MenuItemRelayOutputManager_Click (object sender, EventArgs args) |
The MenuItemRelayOutputManager_Click method. More... | |
void | MenuItemRoleManager_Click (object sender, EventArgs args) |
The MenuItemRoleManager_Click method. More... | |
void | MenuItemScheduleManager_Click (object sender, EventArgs args) |
The MenuItemScheduleManager_Click method. More... | |
void | MenuItemSearchEvents_Click (object sender, EventArgs args) |
The MenuItemScheduleManager_Click method. More... | |
void | MenuItemShowPtzControls_Click (object sender, EventArgs args) |
The MenuItemShowPtzControls_Click method. More... | |
void | MenuItemSituationManager_Click (object sender, EventArgs args) |
The MenuItemSituationManager_Click method. More... | |
void | MenuItemTagManager_Click (object sender, EventArgs args) |
The MenuItemTagManager_Click method. More... | |
void | MenuItemSnapshotPath_Click (object sender, EventArgs args) |
The MenuItemSnapshotPath_Click method. More... | |
void | MenuItemSubscribe_Click (object sender, EventArgs args) |
The MenuItemSubscribe_Click method. More... | |
void | MenuItemSubscribeByType_Click (object sender, EventArgs args) |
The MenuItemSubscribeByType_Click method. More... | |
void | MenuItemDisplayEventDialogs_Click (object sender, EventArgs args) |
The MenuItemDisplayEventDialogs_Click method. More... | |
void | MenuItemUserManager_Click (object sender, EventArgs args) |
The MenuItemUserManager_Click method. More... | |
void | PanelVideoStream_Click (object sender, EventArgs args) |
The PanelVideoStream_Click method. More... | |
void | PanelVideoStream_MouseEnter (object sender, EventArgs args) |
The PanelVideoStream_MouseEnter method. More... | |
void | PanelVideoStream_MouseLeave (object sender, EventArgs args) |
The PanelVideoStream_MouseLeave method. More... | |
void | PanelVideoStream_MouseWheel (object sender, MouseEventArgs args) |
The PanelVideoStream_MouseWheel method. More... | |
void | PanelVideoStreamLeft_MouseClick (object sender, MouseEventArgs args) |
The PanelVideoStreamLeft_MouseClick method. More... | |
void | PanelVideoStreamRight_MouseClick (object sender, MouseEventArgs args) |
The PanelVideoStreamRight_MouseClick method. More... | |
async void | SaveSnapshotLive (DataSource dataSource) |
The SaveSnapshotLive method. More... | |
async void | SaveSnapshotRecorded (DataSource dataSource) |
The SaveSnapshotRecorded method. More... | |
void | SetupPtzControls (DataSource dataSource) |
The SetupPtzControls method. More... | |
DataInterface | SelectDataInterface (VxStreamProtocol selProtocol, DataSource dataSource, bool showWindow) |
The SelectDataInterface method. More... | |
void | StartStream (DateTime seekTime=default(DateTime)) |
The StartStream method. More... | |
void | StopAllStreams () |
The StopAllStreams method. More... | |
void | StopStream () |
The StopStream method. More... | |
void | SelectAudioData (DataSource videoSource, bool showWindow, out DataSource audioSource, out DataInterface audioInterface) |
Select the audio data source and data interfaces from the MainForm.CurrentDataSources More... | |
Static Private Member Functions | |
static string | EncodeToBase64 (string toEncode) |
The EncodeToBase64 method. More... | |
static void | ShowSnapshotDialog (string fileName) |
The ShowSnapshotDialog method. More... | |
The MainForm class.
This class contains the main UI form.
Definition at line 22 of file MainForm.cs.
Inherits Form.
|
inline |
Initializes a new instance of the MainForm class.
Definition at line 27 of file MainForm.cs.
|
inlineprivate |
The ButtonLive_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 201 of file MainForm.cs.
|
inlineprivate |
The ButtonManualRecord_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 219 of file MainForm.cs.
|
inlineprivate |
The ButtonPause_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 265 of file MainForm.cs.
|
inlineprivate |
The ButtonPlay_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 283 of file MainForm.cs.
|
inlineprivate |
The ButtonRefreshDataSources_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 293 of file MainForm.cs.
|
inlineprivate |
The ButtonSeek_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 304 of file MainForm.cs.
|
inlineprivate |
The ButtonSnapshot_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 315 of file MainForm.cs.
|
inlineprivate |
The ButtonStop_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 333 of file MainForm.cs.
|
inlinestaticprivate |
The EncodeToBase64 method.
toEncode | The string to encode to Base64. |
Definition at line 177 of file MainForm.cs.
|
inlineprivate |
The GridViewDataSources_CellDoubleClick method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 343 of file MainForm.cs.
|
inlineprivate |
The MenuItemAlarmInputManager_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 374 of file MainForm.cs.
|
inlineprivate |
The MenuItemBookmarkManager_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 387 of file MainForm.cs.
|
inlineprivate |
The MenuItemClusterConfig_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 400 of file MainForm.cs.
|
inlineprivate |
The MenuItemConnect_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 453 of file MainForm.cs.
|
inlineprivate |
The MenuItemDataObjectManager_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 414 of file MainForm.cs.
|
inlineprivate |
The MenuItemDataSourceManager_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 427 of file MainForm.cs.
|
inlineprivate |
The MenuItemDataStorageManager_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 440 of file MainForm.cs.
|
inlineprivate |
The MenuItemDeviceManager_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 476 of file MainForm.cs.
|
inlineprivate |
The MenuItemDisplayEventDialogs_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 863 of file MainForm.cs.
|
inlineprivate |
The MenuItemDrawingManager_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 489 of file MainForm.cs.
|
inlineprivate |
The MenuItemExit_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 466 of file MainForm.cs.
|
inlineprivate |
The MenuItemExportManager_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 502 of file MainForm.cs.
|
inlineprivate |
The MenuItemInsertEvent_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 515 of file MainForm.cs.
|
inlineprivate |
The MenuItemLicenseDetails_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 550 of file MainForm.cs.
|
inlineprivate |
The MenuItemLog_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 353 of file MainForm.cs.
|
inlineprivate |
The MenuItemLogLevel_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 528 of file MainForm.cs.
|
inlineprivate |
The MenuItemLogout_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 563 of file MainForm.cs.
|
inlineprivate |
The MenuItemModifyLoggingPath_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 596 of file MainForm.cs.
|
inlineprivate |
The MenuItemMonitors_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 618 of file MainForm.cs.
|
inlineprivate |
The MenuItemNotifications_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 631 of file MainForm.cs.
|
inlineprivate |
The MenuItemProtocol_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 644 of file MainForm.cs.
|
inlineprivate |
The MenuItemQuickLog_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 666 of file MainForm.cs.
|
inlineprivate |
The MenuItemQuickReport_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 679 of file MainForm.cs.
|
inlineprivate |
The MenuItemRelayOutputManager_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 692 of file MainForm.cs.
|
inlineprivate |
The MenuItemRoleManager_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 705 of file MainForm.cs.
|
inlineprivate |
The MenuItemScheduleManager_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 718 of file MainForm.cs.
|
inlineprivate |
The MenuItemScheduleManager_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 731 of file MainForm.cs.
|
inlineprivate |
The MenuItemShowPtzControls_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 744 of file MainForm.cs.
|
inlineprivate |
The MenuItemSituationManager_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 754 of file MainForm.cs.
|
inlineprivate |
The MenuItemSnapshotPath_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 780 of file MainForm.cs.
|
inlineprivate |
The MenuItemSubscribe_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 802 of file MainForm.cs.
|
inlineprivate |
The MenuItemSubscribeByType_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 831 of file MainForm.cs.
|
inlineprivate |
The MenuItemTagManager_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 767 of file MainForm.cs.
|
inlineprivate |
The MenuItemUserManager_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 873 of file MainForm.cs.
|
inline |
The OnInternalEvent method.
internalEvent | The internalEvent parameter. |
Definition at line 107 of file MainForm.cs.
|
inline |
The OnSystemEvent method.
systemEvent | The systemEvent parameter. |
Definition at line 116 of file MainForm.cs.
|
inlineprivate |
The PanelVideoStream_Click method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 886 of file MainForm.cs.
|
inlineprivate |
The PanelVideoStream_MouseEnter method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 935 of file MainForm.cs.
|
inlineprivate |
The PanelVideoStream_MouseLeave method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 955 of file MainForm.cs.
|
inlineprivate |
The PanelVideoStream_MouseWheel method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 975 of file MainForm.cs.
|
inlineprivate |
The PanelVideoStreamLeft_MouseClick method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 998 of file MainForm.cs.
|
inlineprivate |
The PanelVideoStreamRight_MouseClick method.
sender | The sender parameter. |
args | The args parameter. |
Definition at line 1013 of file MainForm.cs.
|
inlineprivate |
The SaveSnapshotLive method.
dataSource | The data source to use for the snapshot. |
Definition at line 1027 of file MainForm.cs.
|
inlineprivate |
The SaveSnapshotRecorded method.
dataSource | The data source to use for the snapshot. |
Definition at line 1068 of file MainForm.cs.
|
inlineprivate |
Select the audio data source and data interfaces from the MainForm.CurrentDataSources
videoSource | Video data source |
showWindow | Specifies wheather to show the window or not |
audioSource | Out parameter for audio data source |
audioInterface | Out parameter for audio data interface |
Definition at line 1411 of file MainForm.cs.
|
inlineprivate |
The SelectDataInterface method.
selProtocol | The selected protocol. |
dataSource | The selected data source. |
showWindow | Selects the first available stream if False. |
Definition at line 1161 of file MainForm.cs.
|
inline |
The SendRequest method.
uri | The request Uri . |
Definition at line 142 of file MainForm.cs.
|
inline |
Sets the state of the manual recording UI elements based on the manual recording status of the current stream.
Definition at line 1200 of file MainForm.cs.
|
inlineprivate |
The SetupPtzControls method.
dataSource | The dataSource parameter. |
Checks if PTZ is enabled on the device. If enabled, it also gets the available presets and patterns for the device.
Definition at line 1148 of file MainForm.cs.
|
inlinestaticprivate |
The ShowSnapshotDialog method.
fileName | The file name of the snapshot image. |
Definition at line 188 of file MainForm.cs.
|
inlineprivate |
The StartStream method.
seekTime | The seekTime in UTC format. If no value or a default DateTime object is given then the stream is started in live mode. |
Definition at line 1237 of file MainForm.cs.
|
inlineprivate |
The StopAllStreams method.
Definition at line 1349 of file MainForm.cs.
|
inlineprivate |
The StopStream method.
Definition at line 1369 of file MainForm.cs.
|
inline |
Subscribes to internal VxSDK events.
Definition at line 1341 of file MainForm.cs.
|
inline |
The WriteToLog method.
message | The message parameter. |
Definition at line 163 of file MainForm.cs.
|
getset |
|
staticgetset |
Gets or sets the CurrentDataSources property.
The current list of data sources found on the VideoXpert system.
Definition at line 53 of file MainForm.cs.
|
staticgetset |
Gets or sets the CurrentDevices property.
The current list of devices found on the VideoXpert system.
Definition at line 47 of file MainForm.cs.
|
staticgetset |
Gets or sets the CurrentPassword property.
The current VideoXpert system password.
Definition at line 59 of file MainForm.cs.
|
staticgetset |
Gets or sets the CurrentSystem property.
The current VideoXpert system.
Definition at line 65 of file MainForm.cs.
|
staticgetset |
Gets or sets the CurrentUserName property.
The current VideoXpert system user name.
Definition at line 71 of file MainForm.cs.
|
staticgetprivate set |
Gets the Instance property.
The current MainForm instance.
Definition at line 89 of file MainForm.cs.
|
staticgetset |
Gets or sets the LogPath property.
The logging directory for the VxSDK.
Definition at line 77 of file MainForm.cs.
|
staticgetset |
|
staticgetset |
Gets or sets the SnapshotBasePath property.
The directory to save snapshots.
Definition at line 83 of file MainForm.cs.