Refresh Manifest Programmatically
Answered
I can refresh the manifest by clicking Ok, Apply, or Refresh using settingsReceived or getPluginSideSettings depending. Ok closes and reopens the window where Apply and Refresh update the manifest and refresh the window. Can I update the manifest AND refresh the window through code without having to press a button or close and reopen the window?
-
Hello James,
Can I update the manifest AND refresh the window through code without having to press a button or close and reopen the window?
No, you can't refresh the window, because it's a client side GUI action. I mean, refreshing the window in fact is rereading settings model and values from the server. That can't be triggered (pushed) from the plugin running in the Server process.
Yes, you can update manifest, meaning notify the Server about updated settings model with the pushManifest() method of the DeviceAgent class. See example in the stub_analytics_plugin of the Metadata SDK. However, settings values can be updated only in returned values of settingsReceived or getPluginSideSettings on request from the Server.
0 -
@...
As Andrey mentioned, this is not possible as of now. But we have plans to redesign this part in the client as we've got several requests like yours.
Also, if you please, elaborate, what problems/UX issues/functionality restrictions do you face? Including the user scenario and what are you trying to achieve. This will help us a lot and probably future versions will better suit your needs.0 -
The user has to click a button or close and reopen the window for it to update the manifest. Is there a way to trigger settingsReceived or getPluginSideSettings from code? Or are you both saying those can only be called via user action through the client?
0 -
@...
yep, those can be triggered only from the client, as of now. But we will add some improvements regarding this in the future. So we are collecting scenarios, that will help design this feature.
Socan you elaborate, what settings are you constructing? Why do you need this refresh? What is the user perspective?0 -
Tagir Gadelshin is there any update on this? Described my case here
0 -
@...
Unfortunately, there is no update but the feature was created and I hope we'll be able to deliver it soon. I'll let you guys know when it will become available in the form of developers early access release (Nx Meta)
VMS-323500 -
Hello Tagir Gadelshin, has this feature been released?
0 -
Hello, Brian Flinte!
To update something in the Settings window, you can use one of the following mechanisms:
-
Active Settings: This allows settings to be updated when a user interacts with a control element, such as clicking a checkbox, button, or selecting an item from a dropdown. The integration is notified and prompted to provide a new manifest with the updated settings. Examples include a user switching temperature units, requiring recalculation of values, or enabling an option that reveals additional settings.
-
Plugin-Side Settings: These settings can be changed by both the VMS and the integration. When the user opens the integration settings, the values are fetched from the integration, overriding those stored in the VMS database. This applies during server restarts or when moving a camera between servers, as the settings will be re-fetched from the integration. However, certain items, such as an already opened client window or a displayed RoI, won’t dynamically update unless the settings window is reopened.
If you need to programmatically change integration settings and ensure they're reflected in the Settings window (or on the layout item as RoI), you can use the API to update these settings, just as the desktop client would.
It would be helpful if you could provide more details about the specific problem you're trying to solve. This way, we can suggest the best solution or consider adding it as a feature to our backlog.
Thank you!
0 -
Please sign in to leave a comment.
Comments
8 comments