Refreshing UI from a Sage Event.

[broconne]

I am trying to figure out how to cause a UI refresh to be triggered by a particular sage event.

For example, when "RecordingComplete" event is fired, I want to refresh my UI. However, I don't understand how I can push the command to the active UIs from my non STVI - plugin?

[PLUCKYHD]

You could write a sagetv plugin implementation class but that seems overkill and it would be tricky to refresh the correct uicontext.I believe there is hooks in the stv for this you can fire off. Look how the default recordings menu does it.

I also would set a variable when in your menu and leaving your menu so you know if you need to refresh or not and you aren't firing it when they aren't in your menu.

[GKusnick]

From a Java event listener, you can execute API calls on any connected client using the appropriate UI context. How exactly you do that will depend on which (if any) API wrappers you're using. But basically, to force a refresh on all clients, you would enumerate the results of GetConnectedClients() and GetUIContextNames() and call the Refresh() API method on each one.

But as Plucky indicates, there may not be much point in forcing a refresh on clients that are sitting at the Main Menu. It might help if you describe what you're trying to accomplish in more detail so we can target our advice to your specific requirements.

[broconne]

Originally Posted by GKusnick

It might help if you describe what you're trying to accomplish in more detail so we can target our advice to your specific requirements.

I am looking to refresh my UI when a Recording is started or stopped.

[GKusnick]

Sorry, but I'm still unclear on what you mean by "my UI", since you said earlier that your plugin is not a UI mod (STVI) plugin. So what UI do you have that needs refreshing? Or are you saying you want to force a refresh of all connected clients, even if they're sitting at the Main Menu (or running some totally unrelated third-party UI)?

In fact you may find that you don't need to do anything. The screen is going to refresh anyway to show or hide the red REC icon in the menu header. This is accomplished by the global RecordingScheduleChanged hook in the stock STV.

If depending on that makes you nervous, then what I'd probably do in any UI mod that displays information based on the recording schedule would be to put a local RecordingScheduleChanged hook on the panel containing such information, and do a targeted RefreshArea on that panel, rather than a blanket Refresh of the whole screen.

But all of this can be done completely within Studio. So I'm not sure where your Java-based plugin comes into it (assuming I haven't misunderstood that part of your original post).

[broconne]

Originally Posted by GKusnick

Sorry, but I'm still unclear on what you mean by "my UI", since you said earlier that your plugin is not a UI mod (STVI) plugin. So what UI do you have that needs refreshing? Or are you saying you want to force a refresh of all connected clients, even if they're sitting at the Main Menu (or running some totally unrelated third-party UI)?

My plugin consists of two parts. An API part (Java/implements STVPlugin) and an STVI mod. I wanted to refresh the STVI from the API based on an event coming into the API part of my plugin.

In fact you may find that you don't need to do anything. The screen is going to refresh anyway to show or hide the red REC icon in the menu header. This is accomplished by the global RecordingScheduleChanged hook in the stock STV.

Hmmm. I had tried the RecordingScheduleChanged hook and when it fired it seemed as if the newly recorded show was not yet appearing GetMediaFiles.. But based on what you are saying that hook should detect a recording, start, stop, etc.. I will add some more logging and try again.

If depending on that makes you nervous, then what I'd probably do in any UI mod that displays information based on the recording schedule would be to put a local RecordingScheduleChanged hook on the panel containing such information, and do a targeted RefreshArea on that panel, rather than a blanket Refresh of the whole screen.

Yep, RefreshArea is what I plan to do.

But all of this can be done completely within Studio. So I'm not sure where your Java-based plugin comes into it (assuming I haven't misunderstood that part of your original post).

Yep, my post wasn't clear that my plugin has two parts. Thanks for all the help - I will mess around with RecordingScheduleChanged hook and see if I can't get that to work for me.