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

K2 Edge Protocol Manual – document version 1.0 – Page 15
4.9. Sub command preload
Function: prepares a template for playback.
field name field type
value
cmd mandatory nre
subcmd mandatory preload
template mandatory Name of the template to be preloaded, as defined in Channel
Composer.
exid mandatory External ID. Free format. See above.
inst mandatory Unique template instance ID. Numeric. See above.
stm optional Start time for the preload command in hh:mm:ss:ff timecode format.
When not specified, the command starts as soon as possible.
spname0
...
spvalue0
...
optional Optional scene parameters. See above.
sg-select optional Embedded alternative to separate sg-select sub command, where
the value for this field must be set to what the rootfolder field
expects in the sg-select command. See section on sub command
sg-select below for details.
sg-inst optional Scene graph instance ID needed alongside the sg-select field
described above.
ttl optional Time-to-live value in seconds for all needed assets (clips, etc) claimed
during this preload command. The asset resources will be freed after
the given time. Make sure ttl is long enough to cover the distance in
time between this preload- and the follow up play sub command.
Numeric, in seconds. Value 0 indicates no ttl. Value -1 indicates default
ttl value as defined in the nexos init params channel section.
role optional Role field. See above.
fb-sw optional Feedback switch. Set value to true to request feedback. See
dedicated chapter on feedback.
fb-lev optional Feedback detail level. Supported values are basic, most and full.
Default is basic.
The combination of the template and inst field values uniquely identifies the template instance. The follow
up play command must define the same template and inst values.
Example:
{cmd=nre; subcmd=preload; template=PlayMovie; inst=0; exid=1;
stm=14:13:00:00; spname0=clipname; spvalue0=a0000123.mpg;}
Newlines do not exist in K2 Edge API commands. Examples are wrapped for layout purposes only.