Grass Valley K2 Edge Protocol Manual v1.0 User Manual
Page 37

K2 Edge Protocol Manual – document version 1.0 – Page 37
Notes:
1) 1) The command is considered valid at the reception point and the command completed
successfully. The requested object was found, and the associated information is returned through
the fb-info field.
2) The command is considered invalid at the reception point. The command is not executed.
3) The command is considered valid at the reception point but failed to execute because either the
requested object was not found in the indicated scene graph, or some other problem occurred.
The fb-info field will describe the actual problem.
At the moment object-info will only work for template objects. The information returned on template
objects is the list of scene parameters.
NRE object
type
fb-info value
comment
template
{spname0=xxx;
spname1=yyy;}
List of scene parameter names defined for the given template. Note
that the return value is a complex string. The list will be empty for
templates that have no scene parameters defined.
Example:
Here is an example of an object-info command sent to nexos, and the two feedback messages received
from nexos in the default basic feedback level. (The other feedback levels would have produced the exact
same result for this command.)
The command instructs nexos to return information on the NRE template object named ShowLogo.
{cmd=nre; subcmd=object-info; object=ShowLogo; exid=4;
fb-sw=true; fb-lev=basic;}
The feedback messages from nexos, assuming the success path, are these:
{cmd=nre; subcmd=object-info; object=ShowLogo; exid=4;
fb-sw=true; fb-lev=basic; fb-event=ack; fb-stat=ok;}
{cmd=nre; subcmd=object-info; object=ShowLogo; exid=4;
fb-sw=true; fb-lev=basic; fb-event=ready; fb-stat=ok; fb-term-sw=true;
fb-info={spname0=logoname; spname1=widthpx; spname2=heightpx;};}
The messages above were wrapped for layout purposes. Newlines do not exist in K2 Edge API
commands.
Note again the presence and value of
fb-term-sw in the last message, indicating feedback ends for this
command. Also note that the
fb-info field value is a nested complex string, that is by itself terminated
with a semicolon, as all field values are.