Click or drag to resize

ICameoSdk Interface

The interface to basic functionality of the SDK, like startup/shutdown, connection state, configuration state.
Other features of the SDK are exposed via DeviceManager, ControlFactory, MediaPlayerFactory and ExporterFactory properties and corresponding interfaces.

Namespace: Bosch.Vms.CameoSdk
Assembly: Bosch.Vms.CameoSdk (in Bosch.Vms.CameoSdk.dll) Version: 1.6.0.0
Syntax
C#
public interface ICameoSdk

The ICameoSdk type exposes the following members.

Properties
 NameDescription
Public propertyControlFactory Returns interface to control factory, that allows to create Image pane controls.
Public propertyDeviceManager Returns interface to device manager, that is responsible for device discovery.
Public propertyExporterFactory Returns interface to exporter factory, that allows to export video recordings.
Public propertyMediaPlayerFactory Returns interface to media player factory, that allows to create media player for playback functionality.
Top
Methods
 NameDescription
Public methodGetConfigurationState Returns current configuration state to the specified server.
Public methodGetServerConnectionState Returns current connection state to the specified server.
Public methodShutdown Disconnects from the server and shuts down the SDK. This method must be called before application is closed in order to release all internal resources.
Public methodShutdownAsync Async analog of the Shutdown method.
Completion of the method and result is notified by ShutdownCompleted event.
Public methodStartup Initializes SDK.
Depending on StartupMode it can either connect to server and perform remote authorization and update the configuration or use locally cached configuration with local authorization.
Public methodStartupAsync Async analog of the Startup(String, String, String, StartupMode) method.
Completion of the method and result is notified by the StartupCompleted event.
Top
Events
 NameDescription
Public eventConfigurationStateChanged Raised when configuration state of any server is changed.
The ConfigurationStateChangedEventArgs contains a description of the state and related server address.
Public eventConnectionStateChanged Raised when connection state to any server is changed.
The ConnectionStateEventArgs contains a description of the state and related server address.
Public eventScheduleLogoffRequired Occurs when user is not allowed to work in the configured time.
Public eventShutdownCompleted Raised when ShutdownAsync method is completed.
Public eventStartupCompleted Raised when StartupAsync(String, String, String, StartupMode) method is completed.
The StartupCompletedEventArgs contains results of start.
Top
See Also