SOC VTR-4000B Evaluation and Product Development Platform
Quick-Start Guide
V1.1, 2017
© 2007- 2017 SOC Technologies Inc. | (519) 880-8609 | [email protected]
®
Page
6
of
6
Endpoint
API Functions Available
Documentation
Module API
•
CODEC Core API
•
CODEC System API
•
Video Input API
•
Flash Update
•
H.264 Encoder API Manual
•
H.265 Encoder API Manual
•
Encoder System API Manual
•
Video Input API Manual
•
Multiboot Module API Manual
The API serial format is available in two formats. You may press ESC (or ENTER without entering a
value) to cycle the prompt.
Important: Backspace is not supported.
If you make a mistake, use
ESC
to cycle back and restart the input.
New API 2.0 format
API 2.0 prompt looks like this:
“>”
The New API offers a simplified interface that is easier to automate and script. To read/write
values on module endpoints send:
Read a register value:
R <address hex>
Change a register value
W <address hex> <value hex>
Legacy API 1.0 format
Legacy API prompt looks like this:
“Enter an address(HEX):”
The API will expose an address-value prompt-loop. To change values, enter the register
address at the address prompt (in hex), and then the decimal value at the value prompt,
followed by enter. Hex values are also accepted when given an “h” prefix/suffix, (ex. 4ABCh
or h4ABC represent 0x4ABC)
You can safely press
ESC
at any time to cycle the prompt without changing current values.