Grass Valley K2 Edge Protocol Manual v1.0 - Manual (Page 19)

K2 Edge Protocol Manual – document version 1.0 – Page 19
4.13. Sub command object-info
Function: returns information via feedback on an NRE object (e.g. a template) with given name as found in
either the active- or selected scene graph.
field name
field type value
cmd mandatory nre
subcmd mandatory object-info
exid mandatory External ID. Free format. See above.
object mandatory Name of object as defined in the scene graph. For templates, this is
the template name as defined in Channel
Composer.
active-sw mandatory If true the active scene graph will be tested for given object, and
else the selected scene graph will be tested. See section Selected
and active scene graph, above.
stm optional Start time for the command in hh:mm:ss:ff timecode format. When
not specified, the command starts as soon as possible.
role optional Role field. See above.
fb-sw optional Make sure to enable feedback to get the results of the object-info
sub command returned.
The requested info will be returned via the standard feedback mechanism, so it is important to enable
feedback with fb-sw=true with this command.
Two feedback messages will be returned: the standard ack or nak message followed by a final message
holding the requested information. In this final message field fb-stat will reflect the presence of the
given object in the selected scene graph. Value ok indicates the object exists, and value error indicates
the object could not be found.
When the object was found, field fb-info holds the object information. Note that at the moment
information will only be returned on template objects, and this information is currently restricted to the set
of scene parameters defined for the template.