...
Code Block |
---|
https://[IP address or hostname]:[port]/video/ |
WILL BE DEPRECATED IN NEXT RELEASE, USE /channels
Returns stored video from the camera with the given camera number and options (start time, end time, length, framerate, and/or resolution). Note: Datetime values are formatted according to the ISO 8601 specification: YYYY-MM-DDTHH:MM:SS For example, 2012-12-05T13:40:27. For more information, see this article from the W3C W3.org: Date and Time Formats.
...
Code Block | ||
---|---|---|
| ||
<CreateGenericEventDefinition xmlns="http://3vr.com"> <eventDefinition> <Name>string</Name> <ShortName>string</ShortName> <GUID>string</GUID> <HelpText>string</HelpText> <MetadataFields> <MetadataField> <GUID>string</GUID> <Name>string</Name> <Description>string</Description> <Type>String or Number or DateTime or EnumeratedType</Type> <DisplayPosition>int</DisplayPosition> <DisplayFormat>string</DisplayFormat> <EnumeratedData xsi:nil="true" /> </MetadataField> <MetadataField> ... </MetadataField> </MetadataFields> </eventDefinition> </CreateGenericEventDefinition> |
Note: The ellipsis (…) means tags repeated from the previous block have been omitted.
Here is an example of a simple CreateGenericEventDefinition named "Example Event":
Code Block | ||
---|---|---|
| ||
<CreateGenericEventDefinition xmlns="http://3vr.com">
<eventDefinition>
<Name>Example Event</Name>
<ShortName>Example</ShortName>
<GUID>66B886FA-F097-4290-89DD-E308E5E05A5</GUID>
<HelpText>Some help text that describes an Example Event.</HelpText>
<MetadataFields>
<MetadataField>
<GUID>1FE84583-F770-4b89-AE2B-FD247C90785</GUID>
<Name>Data</Name>
<Description>Data for the example</Description>
<Type>String</Type>
<DisplayPosition>1</DisplayPosition>
<DisplayFormat>{name} {value}</DisplayFormat>
</MetadataField>
</MetadataFields>
</eventDefinition>
</CreateGenericEventDefinition> |
If we were to generate a generic event with this definition on a 3VR Appliance, "Example Event" would appear as an option in the event selector in OpCenter's Monitor and Search panels.
Furthermore, since Example Event has a metadata item with the <name> "Data" that is of <type> "string", users could create a search that would return only Example Events with a "Data" value matching their search string.
Generic Event Definition DisplayFormat
There are seven tags that can be used to format the text displayed for a generic event data field: {name}, {value}, {bold}, {newline}, {oneline}, {joinline}, and {wrap}. All other text inserted into the display format will be displayed as plain text.
To display a field with the name “Amount” and the value “$100” as “Amount: $100”, then, would require the following display format: Format: {name}: {value}
Result: Amount: $100
Bolding a portion of the text field requires putting a {bold} tag at the beginning and end of that section of text. There can only be two{bold} tags, and the first must be at the beginning of the display format. Displaying “Amount: $100” would require the following display format: {bold}{name}:{bold} {value}
The {newline} tag inserts a newline character into the text. The display format {name}:{newline}{value} will result in
Amount: $100
Conversely, the {oneline} tag removes all newline characters from the name and value strings not explicitly defined by a {newline} tag, replacing them with a single space.
The {joinline} tag can be used to put two or more fields on a single line. Placing {joinline} in a field’s display format will
cause the next field to be displayed on the same line, to the right of the current field. For two fields, one describing gender and the
other eye color, to be displayed as “Gender: Male Eye Color: Brown”, both fields can be given the following display format: {name}:
{value} {joinline}. An arbitrary number of fields can be placed on the same line, limited only by screen space.
By default, OpCenter will display as much of each line as possible, and truncate any text that does not fit in the available space. If
you do not wish to truncate text, use the {wrap} tag to wrap oversized strings in a given field onto multiple lines. This tag cannot be
used in conjunction with the {joinline} tag.
Putting it all together, the Bank Teller event card shown here: