Bosch. |  |
The namespace contains definition of interfaces and classes exposed by CameoSdk.
Please see description of EntryPoint class and ICameoSdk interface as a starting point to the Sdk.
Classes| Class | Description | |
|---|---|---|
 | CameoSdkException | Base generic exception that can be thrown by SDK. |
| CameoSdkParameters | The class represents parameters required for SDK initialization. |
| CameoSdkShutdownException | The exception can be thrown by any method of SDK if SDK is shutdown. |
| ConfigurationStateChangedEventArgs | Event arguments for the ConfigurationStateChanged event. |
| ConnectionStateEventArgs | Event arguments for the ConnectionStateChanged event. |
| ContentStateChangedEventArgs | Event arguments for the ContentStateChanged event. |
| DataEventArgsTKey, TValue | Event arguments for the DataSetChanged event. |
| DataSetTKey, TValue | Contains data as key value pairs. |
| DuplicateInstanceCameoSdkException |
Only one instance of SDK with given HostId is allowed. SDK-user receives this exception if he tries to initialize second instance with the same HostId. |
| EntryPoint | The class contains entry point of the SDK, see GetSdk(CameoSdkParameters) method for details. |
| ExportCompleteEventArgs | Event arguments for the ExportComplete event. |
| InstanceId | Represents unique Id of objects in BVMS. |
| NoPermissionCameoSdkException | The exception is thrown if currently logged user has no permission for operation. |
| PlaybackTimeChangedEventArgs | Event arguments for the PlaybackTimeChanged event. |
| ProgressChangedEventArgs | Event arguments for the ProgressChanged event. |
| PtzLockedCameoSdkException | The exception is thrown if PTZ control is locked by user with higher priority. |
| StartupCompletedEventArgs | Event arguments for the StartupCompleted event. |
Interfaces| Interface | Description | |
|---|---|---|
 | ICameoControl | Represents base interface for Image pane control. |
| ICameoSdk |
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. |
| ICamera | Interface that represents a camera. |
| IControlFactory |
Represents an interface, that provides access to the control factory. Control factory creates Image pane controls, that can be placed on the UI (see UIControl for details). |
| IDataSetAccessorTKey, TValue | Represents an interface that provides an access to a DataSetTKey, TValue. |
| IDevice | Base interface for devices in BVMS. |
| IDeviceManager | Represents an interface, that provides functionality to discover devices. |
| IDewarp | Interface for panoramic camera dewarped image control. |
| IDewarpController | The interface defines operations to control the image crop for the dewarped images of panoramic cameras. |
| IExporter |
Represents an interface, that provides access to the exporter. Exporter is responsible for camera recordings export. Multiple cameras export is supported. |
| IExporterFactory | Represents an interface, that provides access to the exporter factory. |
| IMediaPlayer |
Represents an interface, that provides access to the media player. Media player is responsible for playback functionality. |
| IMediaPlayerFactory | Represents an interface, that provides access to the media player factory. |
| IPtz | Represents an interface, that provides access to PTZ functionality. |
| IPtzControl | Represents an interface, that performs camera PTZ control. |
| IPtzSettings | Represents an interface, that contains PTZ control settings. |
| ISnapshotInfo | Represents an interface, that describes snapshot data. |
| IVideoCameoControl |
Represents an interface, that provides access to the Image pane control. Image pane control is responsible for showing live or playback video content. |
| IVideoCameoControl2 |
Represents an interface, that provides access to the Image pane control. Image pane control is responsible for playback video content. |
| IVideoCameoControl3 | Represents an interface, that controls the visibility of the VCA overlays in Live and Playback. |
| IVideoCameoControl4 | Represents interface that notifies whether displayed content supports an image dewarping and provides functionality for its control. |
Enumerations| Enumeration | Description | |
|---|---|---|
 | ConfigurationState | Describes configuration states possible values. |
| ContentState | Describes content states possible values. |
| DewarpingViewMode | Provides possible values for dewarping view mode. |
| ExportQuality |
Export quality. You can tune export performance using this enum. |
| PlaybackDirection | Describes playback direction possible values. |
| PlaybackSpeed | Describes playback speed possible values. |
| ServerConnectionState | Describes server connection state possible values. |
| StartupMode | Describes start up procedure options. |
| StartupResult | Describes start up procedure result possible values. |