Difference between revisions of "Global notification specification"

From MythTV Official Wiki
Jump to: navigation, search
(Global notification dialog specification)
 
m (mark as outdated)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
{{outdated2|This capability is now provided by [[MythMessage]] in 0.25 and later.}}
 +
 +
Currently being implemented by [[User:Mattwire|Matthew Wire]].
 +
 
Currently MythNotify and MythTVOSD allow for notifications to be sent around the network and display as an OSD when using the internal player.
 
Currently MythNotify and MythTVOSD allow for notifications to be sent around the network and display as an OSD when using the internal player.
  
Line 18: Line 22:
 
* Use Mythfrontend network control interface to create/manage dialogs.
 
* Use Mythfrontend network control interface to create/manage dialogs.
  
  POPUP message defaultButton timeout button1 button2 buttonN - ''Creates popup''
+
  '''POPUP message defaultButton timeout button1 button2 buttonN''' - ''Creates popup''
 +
  ''Note: Use underscores ("_") instead of spaces for message and button text!''
 +
  * defaultButton: integer (starts at 0 for first button).
 +
  * timeout: integer (seconds).
 
   returns identifier OK
 
   returns identifier OK
  POPUP status ''Gets status of popup''
+
  '''POPUP status''' - ''Gets status of popup''
 
   returns identifier ACTIVE|CLOSED
 
   returns identifier ACTIVE|CLOSED
  POPUP close - ''Closes active popup''
+
  '''POPUP close''' - ''Closes active popup''
 
   returns identifier CLOSED
 
   returns identifier CLOSED
 +
* If there is no popup identifier (eg. popup close called when there is no popup)
 +
  then identifier will return 0.
 +
* NEED a way to query which button was pressed and some code to do it.  Ideas?
 +
 +
 +
== Resources ==
 +
* See [[http://www.gossamer-threads.com/lists/mythtv/dev/284692 http://www.gossamer-threads.com/lists/mythtv/dev/284692]] for a discussion on this.
 +
* Draft implementation: [[http://www.gossamer-threads.com/lists/mythtv/dev/285166 http://www.gossamer-threads.com/lists/mythtv/dev/285166]].
  
* If there is no popup identifier (eg. popup close called when there is no popup) then identifier will return 0.
+
== Suggestions ==
* NEED a way to query which button was pressed.  Ideas?
 

Latest revision as of 00:49, 15 March 2012

Time.png Outdated: This capability is now provided by MythMessage in 0.25 and later.

Currently being implemented by Matthew Wire.

Currently MythNotify and MythTVOSD allow for notifications to be sent around the network and display as an OSD when using the internal player.

There is no facility built into MythTV for displaying notifications anywhere else.


Use Cases

  • Mythshutdown -x tries to shutdown but cannot. It pops up a dialog telling the user why it can't shutdown and asking if they want to override and shutdown anyway.
  • Mytharchive needs a blank dvd inserting to continue. It pops up a dialog asking for the user to insert a blank dvd. The dialog automatically disappears when the dvd is inserted.


Requirements

  • Must be well integrated into mythtv - it must be themed correctly, and be controllable via LIRC etc.
  • Must be configurable for number of buttons and message displayed (also specify which button has focus).
  • Configurable timeout to automatically dismiss the dialog.
  • Easy to execute/display.

Implementation

  • Use Mythfrontend network control interface to create/manage dialogs.
POPUP message defaultButton timeout button1 button2 buttonN - Creates popup
 Note: Use underscores ("_") instead of spaces for message and button text!
 * defaultButton: integer (starts at 0 for first button).
 * timeout: integer (seconds).
 returns identifier OK
POPUP status - Gets status of popup
 returns identifier ACTIVE|CLOSED
POPUP close - Closes active popup
 returns identifier CLOSED
* If there is no popup identifier (eg. popup close called when there is no popup)
  then identifier will return 0.
  • NEED a way to query which button was pressed and some code to do it. Ideas?


Resources

Suggestions