Field identifier, Field value, Nested complex string field values – Grass Valley K2 Edge Protocol Manual v1.0 User Manual

Page 51

Advertising
background image

K2 Edge Protocol Manual – document version 1.0 – Page 51

8.3. Field identifier

The field identifiers (or field names) consist of lower case letters, digits and the hyphen '-' (not the

underscore). Field identifiers always start with a lower case letter. In the example above,

file is one of

the field identifiers.

Examples of valid and invalid field identifiers are:


identifier

comment

file

Valid field name.

bock-size

Valid field name.

channel-0

Valid field name.

File

Invalid! No uppercase characters allowed.

video_stream Invalid! No underscores allowed.
0file

Invalid! Field identifiers must start with lower case alpha character.

8.4. Field value

The field value is a string of characters. The string starts right after the equals sign (=) and is terminated

by the semi-colon (;). the semi-colon ends the field-value-pair. All characters found between the = and ;

delimiters are part of the value string, including any spaces found. The value part can be an empty string,

clearing the associated field.

8.5. Nested complex string field values

Field values can be nested. For example:

{ count=42; list={a=1;b=2;c=3;}; }

This example shows a complex string with two fields:

count and list.The value for list is a (nested)

string that looks like this:

{a=1;b=2;c=3;}.

Note how the value part of field

list is terminated with the standard semicolon, as is done with all field

values.

Nesting of complex strings is not restricted, but readability will suffer when nesting more than one level

deep.

Advertising