ClearOne StreamNet Integration User Manual

Page 19

Chapter 3: ASCII Overview

#mENU_RESP {{tier2>etc”
disppath=”TierName” display=”Item ID” otherData=”123456” moreData=”xyz” />}}

The StreamNet service will respond to a #mENULIST message with a series of menu response messages,
one for each menu item requested. The payload of the menu response message is XML-like, items may or may
not be present and the order of the listed items may change.
The following are some of the items that will always be present:

This is the identifier for this item.

display

This is the text shown in the menu for this item. This should be a more readable
version of the “id”.

children

This is how many items are in the next tier menu below this item. 0 indicates that this
is a terminal item, and there is no menu tier below this item.

itemnum

This indicates the item number within the menu list. Receiving itemnum=”-n” (any
negative integer) indicates that there are no more items at this tier of the menu.

idpath

This is the menu navigation path taken to arrive at this menu tier. The path is specified
by a list of “id” fields separated by the greater-than sign, “>”.

disppath

This is a more readable version of the idpath to be used on user interfaces.

menuName

Generally, this may be ignored.

In addition to the required items there may be any number of context specific items. These items provide
additional information but are only defined for that specific menu.
#mENU_SEL {{menuPath}}
Where {{menuPath}} is the navigation path of the item being selected. The MenuPath is created by
concatenating the idpath with the itemId as in: {{idpath>itemId}}.

NOTE

: Do not use the #mENU_SEL outside of the context of menu navigation. Menus can

and will change.