Latitude Version SDK Release Notes

Transcription

1 Latitude Version SDK Release Notes In this document you can check out what s new, understand the known issues, and read through the frequently asked questions about the latest version of the Latitude Software Development Kit (SDK). As always, you re encouraged to provide feedback using this link. (EngineeringServices@dvtel.com) Version 6.2.1, released May, 2012

2 Table of Contents WHAT S NEW?... 3 PTZ movement events... 3 Entity References... 4 IExternalDataEntity Additional properties... 4 Monitor SDK application with SafRun... 5.NET4 support... 5 New Samples... 5 KNOWN ISSUES AND GUIDELINES... 6 Breaking Changes... 6 Installation and upgrades:... 6 Admin Center... 6 PTZ Drivers... 6 PTZ Control and Feedback... 6 Directory Plugin Guidelines... 7 Miscellaneous... 7 Samples & Documentation... 7 Plugin Loading... 7 External entity addition by SDK application and plugin... 8 FIXES... 9 FREQUENTLY ASKED QUESTIONS DVTel Latitude V6.2.1 SDK Release notes v1.1 2

3 What s New? PTZ movement events Two new events are introduced: o IPTZMovementStartedEventEntity IUserBaseEntity User { get; } - indicates who is the user that caused the PTZ movement. o IPTZMovementEndedEventEntity SDK applications can identify when a PTZ movement started/ended by registering to those events. It can be used when an application needs to calculate the location of a camera. PTZ movement operation is considered as one of the following operations, that can be done via Latitude clients or via the SDK: o Pan o Tilt o Zoom o Preset o Go to Preset Number o Go to Location o Pattern o Home o Flip Let s define T as the time after the first PTZ movement operation is done on a scene S. IPTZMovementStartedEventEntity will be fired upon the first PTZ movement operation is done on a scene S, and then T countdown will be started. During T, if more PTZ operations are done on S, no other IPTZMovementStartedEventEntity events will be fired. T countdown will be reset upon any PTZ movement operation done on S during T. After T, IPTZMovementEndedEventEntity will be fired. New property of ISystemRootEntity is introduced: o int DelayedPTZMovementEndedValue { get; set; } o It represents T and has a default value of 10 seconds, configurable only via SDK. The relevant scene is the firing entity of the events. The events are part of Latitude: o An action can be configured for these events of the camera actions tab PTZ moved. o Audit support, with default of no auditing. The events names in Latitude are PTZ movement started/ended Disclaimers: o Any commands that are done not via Latitude will not trigger these events. o There is no sample for this feature, but those events are like any other events in the system. DVTel Latitude V6.2.1 SDK Release notes v1.1 3

4 Entity References There wasn t any formal way to understand what the current structure of external entities of integrations. There can be external entities that can be removed or are invalid by the integration rules. Finding these entities is needed mainly for debugging and finding problems. This feature enables SDK applications to retrieve the entities that reference a specific entity and which property. New interface is introduced IEntityReferencer. o Represents an entity which references another entity. It has the following properties: IConfigurationEntity Entity { get;} - Gets the referencing entity from the cache, If only the entity's id is required please use EntityId property for better performance. Enum ReferencingPropertyId { get; } - Gets the referencing property id. Guid EntityId { get; } - Gets the referencing entity id. New method is introduced to IConfigurationEntity: o IList<IEntityReferencer> GetEntityReferencers(); o It retrieves the entities to which a specific entity is referenced by, and by which properties. Code Example: IList<IEntityReferencer> referencers = entity.getentityreferencers(); foreach (IEntityReferencer entityreferencer in referencers) { DVTelTrace.info("Entity {0} is referencing entity {1} with property {2}", entityreferencer.entity.getshortdebugdescription(), entity entityreferencer.referencingpropertyid); } IExternalDataEntity Additional properties There wasn t any straight forward way to get/set additional information of IExternalDataEntity as ExternalId and ExternalType. This information can be used for several integrations and by the common infrastructure. It will simplify the IExternalDataEntity usage and flexibility. The following properties were added to IExternalDataEntity: o ExternalId string {get; set;} o ExternalType - string {get; set;} The default value for both properties will be null, also for upgrade. Today there are only SharedEntitiesCollection properties to IExternalDataEntity. It means that in order to add an integration hierarchy that is built from external entities, the entities should be added one by one. The same goes for update. These operations can take a lot of time, and should be synchronized. The ability to add an integration hierarchy at once will simplify the SDK usage and speed up the performance. The following collection property was added to IExternalDataEntity: o ComposedEntitiesCollection IReadWriteEntitiesCollection<IConfigurationEntity>{get; set;} Entities in the ComposedEntitiesCollection should not be added/updated/removed separately. The entity that holds the collection can be added at once with the entities in the collection. Default is an empty collection, also for upgrade. DVTel Latitude V6.2.1 SDK Release notes v1.1 4

5 There is a plugin sample for the feature: DVTel.SDK.Samples.DirectoryPluginComposedTree Monitor SDK application with SafRun SafRun was used to monitor DVTel servers and in order to monitor SDK application on machines without Latitude services, SDK users had to implement their own way of monitoring the SDK application. In this feature we added the ability to monitor SDK applications within SafRun. SafRun will be installed also when SDK pack is selected during the installation. Any installation combination that includes SDK pack should install SafRun. In order to have SafRun app monitored by SafRun, it should be added to the config file. SDK applications and services should be monitored by SafRun by adding them to the SafRun config file, for example: <add key="process1" value="'c:\demo\application\app2run\app.exe' -a " /> <add key="service1" value="'c:\demo\service\runservice.exe',servicename " /> Installation of the SDK application should be responsible to edit SafRun config file either automatically or manually SafRun service and application will NOT start automatically if only SDK is installed. The SafRun section of the service config file will be empty. The SafRun service should be started manually in order it to run, only after the config file was modified..net4 support Latitude is compiled under.net 4.0 which means that all SDK applications and plugins should be recompiled against.net 4.0 in order for them to work. Important note: SDK plug-ins (Directory, Control Center, Presentation, etc ) that were compiled against.net.3.5 might work without the need to recompile them against.net 4, since they run in the context of Latitude services/applications. It is not guaranteed and we highly recommend recompiling them also against.net 4.0. New Samples New directory plugin sample was added to demonstrate the new properties of IExternalDataEntity: DVTel.SDK.Samples.DirectoryPluginComposedTree. DVTel Latitude V6.2.1 SDK Release notes v1.1 5

6 Known Issues and Guidelines Breaking Changes Latitude is compiled under.net 4.0 that means that all SDK applications and plugins should be recompiled against.net 4.0 in order for them to work. Any application compiled in.net 4.0 that uses video component in the system, including video (live or playback), export, DSF and audio should add this line to the application configuration file: <startup uselegacyv2runtimeactivationpolicy="true"> <supportedruntime version="v4.0" sku=".netframework,version=v4.0" /> </startup> Please note, for the GA version it will not be required to add the above entry to the config file. It will be done automatically by a common code that runs during the SDK application initialization. IPtzItemEntity was moved from DVTel.API.Entities.Physical to DVTel.API.Entities.Logical, so if you use it please update a reference. Installation and upgrades: Uninstalling Latitude NVMS V6.2 will completely remove all DVTel folders, thus it is recommended not to keep any new projects under the SDK samples folder. Before uninstalling Latitude NVMS V6.2, all applications or plugins should be uninstalled prior to uninstalling Latitude. Admin Center When two federations are declared with the same name, only one will be saved in the FederationHosts.xml file. Therefore, it is recommended to make sure each federation has a unique name. When adding a collapsible box to a Latitude entity other than an external entity using a presentation plugin (e.g. adding a box to the VideoInSceneEntity general page), the box will only appear if the entity which has your plugin s workspace id is pressed first by the user. Therefore, it is recommended to add the additional GUI to all Latitude entities from the same type (for example: all VideoInSceneEntity entities) PTZ Drivers PTZBase and PTZPerformerBase which used to be internal classes containing the basic functionality for PTZ drivers are now open source! You may find the code under SDK/Samples/Drivers. Instead of inheriting the above mentioned classes, just add the code to your PTZ driver and you re good to go. This way you can easily modify or extend those classes. PTZ Control and Feedback IPTZPerformer has a new method GetLocation which enables you to get the current Pan, Tilt and Zoom of a PTZ camera which supports a location feedback. DVTel Latitude V6.2.1 SDK Release notes v1.1 6

7 The GotoLocation method will send the PTZ camera to the desired pan tilt and zoom location. When using PTZ lock, in order to unlock it you should explicitly call the Unlock method (disposing the session is not enough) or it will stay locked until the user logs out of the system. This enhancement is effective from 6.0 SP1. Although the Latitude SDK supports PTZ absolute positioning via the GoToLocation and GetCurrentLocation methods of IPtzClient, the support of the functionality is also dependent on the PTZ driver being used (for example Pelco D), as well as the hardware being used (camera or encoder). For example, some hardware devices might not support communication from the device to the Latitude system and therefore calling GetCurrentLocation would fail with a timeout. Directory Plugin Guidelines A Directory Plugin should be used in order to intervene with basic directory operations on entities in Latitude NVMS.e.g. in order to modify each camera just before it is added to the Directory server, you can add an AddEntityListener which will be invoked whenever a new entity is about to be saved. No caching of entities need to be done in a Directory Plugin. Modifying entities (i.e. using IAdministrationAPI) must always be performed synchronously, within a transaction. Therefore, if you re performing an operation not within a transaction you should use ExecuteInTransaction method. Events returned by the Directory Application API listener callbacks are already inside a transaction, i.e. no need to open a new transaction (e.g. performing some operations within the EntityAdded event). Do not keep a local reference to an entity. Getting an entity within a transaction (that was not received as a parameter of the listener callback) should be done by invoking the method GetTransactionalEntity(Guid). Miscellaneous When registering to an event, make sure that all actions you perform when receiving this event are performed in a new thread. This is in order to prevent a situation in which the SDK event dispatcher is waiting for your code to complete before dispatching the next event in queue. When using the DVTelTrace class to write messages to the log, always check that your trace level is compatible with your message trace level. Example: If (DVTelTrace.Error()) { DVTelTrace.error("Archiver is null"); } Samples & Documentation SDK API Samples located under the solution DVTel.SDK.Samples are now compiled in.net4. Also the SDK Plugins Samples are now compiled in.net 4. Samples can be compiled only on VS2010. Samples are not supported in VS2005/2008 Plugin Loading Verify that the plugin code is executed by specific servers/clients only after receiving the callback when the relevant application API is ready. Verify the relevant plugin code runs only by the relevant server/client. For example, Directory plugin code is executed only in the Directory and etc. DVTel Latitude V6.2.1 SDK Release notes v1.1 7

8 Plugin should be installed on all machines. External entity addition by SDK application and plugin When using directory plugin for AddGetTreeParentsListener / AddGetAdditionalChildrenLocationsListener and SDK application to add/update an external entity, please note that the plugin code will run asynchronous; hence the SDK can receive the call back for entity added/updated before the directory plugin AddGetTreeParentsListener / AddGetAdditionalChildrenLocationsListener callbacks ended. The solution is to register at the SDK application for the right event, fired after the directory plugin finished its code. If you need to create an hirerchi of external entities at once, you can use ComposedEntitiesCollection of the IExternalDataEntity that was introduced in DVTel Latitude V6.2.1 SDK Release notes v1.1 8

9 Fixes # Name Description Sample Browser SDK Samples get stuck when file browser window is supposed to be displayed. It works from the sample itself WPF sample WPF Sample does not display live video on.net Application server Application server - ServingStop event is not fired when killing the service via Safrun Application server Application server's cache does not receive status events Casebuilder sample CB sample process remains open even after sample is closed Help Files Help files - DVTEL icon is missing Users Sample SDK - Users sample - Exception is thrown when performing remove to user when running from VS debug\release Connect Encoder To Decoder sample Cross thread exception when performing connect between encoder and decoder - no functional aspect Export Sample sample crashes after trying to save export configuration on JIT exception Player Sample sample process remains open even after sample is closed Application Server On release environment only - Application server fails to start from the batch file General SDK Application never exits before forced timeout of 30 seconds Install / Uninstall SDK should not be install if key is not provide in ini.file from C:\Windows\Downloaded Installations\{1669F4B0}\Features\SDKPack Export Sample Sample throws an exception when trying to perform an export with a format different than DVT and with specific units Upgrade Upgrade when SDK exists fails, installation key is missing Installation Installing when SDK key is missing - an error message pops up indicating that installation key is missing. This error message should not appear StreamingAPI IStreamingAPI - "Not supported" General SDK integrations - consider adding capability to add.net4 framework entry support in integrations config file programmatically Installation Installation - win7 x64 - Uninstall of client with SDK doesn't remove DVTEL folder containing other folders under program files Upgrade Upgrade - Upgrade of Client + SDK creates two entries (6.2 and 6.2.1) under start programs Installation SDK component installation via "Modify" fails DVTel Latitude V6.2.1 SDK Release notes v1.1 9

10 19389 Help Files IArchiveController API documentation is incorrect General AddGetTileContextMenuActionsListener works for live streams but fails for archived Sample Browser SDK - Sample Browser - SDK Samples get stuck when file browser window is supposed to be displayed. It works from the sample itself Help Files Maps HTML code snippets in the help file contain extra spaces/carriage returns DVTel Latitude V6.2.1 SDK Release notes v1.1 10

11 Frequently Asked Questions Q When working with the SDK Samples solution, I get a Loader Lock Exception each time I m in debug mode. How can I avoid that? A In order to avoid that, go to Debug->Exceptions page (usually Ctrl+Alt+E), click Find, and search for LoaderLock, then uncheck the Thrown checkbox. Q When using a ControlCenter plugin (ActionBox) can I get notified when one of my External Entities is focused in a ControlCenter tile? A Register to the IControlCenterAPI.ExternalEntityFocusGained event to get a notification whenever a tile containing an External Entity gains focus. DVTel Latitude V6.2.1 SDK Release notes v1.1 11