Displayupdateeventsubscribe; Displayupdateeventunsubscribe - Roku M1000 Software Manual

DisplayUpdateEventSubscribe

DisplayUpdateEventUnsubscribe

Syntax:
DisplayUpdateEventSubscribe
DisplayUpdateEventUnsubscribe
Classification:
Subscription
Result Type:
No results
Responses:
ErrorAlreadySubscribed – requested subscription
but already subscribed
ErrorNotSubscribed – requested unsubscription but
not currently subscribed
OK – indicates success
Example:
DisplayUpdateEventSubscribe
DisplayUpdateEventSubscribe: OK
DisplayUpdateEvent: 682
DisplayUpdateEventUnsubscribe
DisplayUpdateEventUnsubscribe: OK
DisplayUpdateEventSubscribe turns on a mode in which changes in the virtual
display are reported to the RCP session. For example, if the user uses the
remote control to change menus, the virtual display is updated, and that fact is
reported as an update event. The number following the update event is the
number of changes that the display has encountered since boot, and is for
informational purposes only. The GetDisplayData command should be used to
discover exactly how the virtual display has changed.
Once a DisplayUpdateEvent has been sent to the RCP client, no further
DisplayUpdateEvents are sent until the RCP client calls GetDisplayData, even if
the display continues to change. Once the RCP client does call GetDisplayData,
a DisplayUpdateEvent is sent the very next time the display is changed.
NOTE: The RCP host does NOT send an initial DisplayUpdateEvent on
subscription, but it instead waits for the display to change first.
Copyright© 2006 Roku, LLC Page 109 www.rokulabs.com