ClearOne StreamNet Integration - Manual (Page 20)

14 Technical Sales: 1.800.705.2103
menu Navigation
The menu navigation process begins with the controller or user interface device requesting the top level of a
menu. Menus can be very long so it is recommended that requests specify a small range of menu items to be
returned. The controller must then repeat the #mENU_LIST command changing the specified range until it
has all of the menu items desired.
The requestor must request the menu by name:
#mENU_LIST 1,6, {{menuName}}
In response the requested items are returned, one #mENU_RESP for each item requested plus one if the end
of the list is reached.
#mENU_RESP {{disppath=”menu Name” display=”Item ID” otherData=”123456” moreData=”xyz” />}}
Menus can be very long so it is recommended that requests specify a small range of menu items to be returned.
The controller must then repeat the #mENU_LIST command changing the specified range until it has all of
the menu items desired. When all of the items in the menu tier have been sent a separate #mENU_RESP
message will be sent with itemnum=”-n”.
Note that if exactly the maximum number of items are requested then an additional and final f
#mENU_RESP will be returned with itemnum=”-n”.
The user interface should display a list of the items’ “display” fields.
Next the user selects an item from the menu.
If the item is a terminal item the UI device sends a #mENU_SEL command specifying the “path” of the item
selected to indicate that an action has been requested.
#mENU_SEL {{menuName>tier1ItemId}}
If the item is not terminal then the UI device will send a #mENU_LIST message to request the next tier of the
menu:
#mENU_LIST StartingItemNumber, EndingItemNumber, {{menuName>tier1ItemId}}
The StreamNet service then returns the next tier of the menu. There can be an arbitrary number of menu
tiers.
Path names can be of arbitrary length. Some example path names are:
{{ media}}
{{ media>rock}}
{{ media>rock>artists}}
{{ media>rock>artists>beatles}}
{{ media>rock>artists>beatles>white album}}
{{ media>rock>artists>beatles>white album>helter skelter}}
{{sources>dvd1}}