Client configuration

Command-line Arguments

Use the --help option to get a help message like the one below

option: -t, --threads type: unsigned int default: 1

The amount of threads to use for the ZMQ context. Default should likely suffice.

option: -v, --verbose type: flag

The flag to enable verbose log messages for the main thread. Quite useless.

positional: <file> type: string

The JSON file to be parsed. If it is not found, the program fails silently.

JSON File

key: "name", type: string

The title for the stream window and log messages.

key: "address", type: string

The address to connect to. Follows the form <protocol>://<address>:<port> where protocol would likely be tcp. e.g tcp://192.168.0.100:554, tcp://mycomputer:5000

key: "prefix", type: string

The prefix used in validating incoming ZMQ messages. Keep this consistent across a client-server pair and try not to use long prefixes. e.g camera 1, mystream

key: "fps", type: unsigned int > 0

The hard FPS limit for the stream. Not recommended for use on client as you probably want to be receiving frames as fast as possible.

key: "verbose", type: bool

The flag to enable verbose log messages. This includes outputting the FPS.

key: "width", type: unsigned int > 0

The custom width for the stream.

key: "height", type: unsigned int > 0

The custom height for the stream.

key: "gamma", type unsigned int >= 0

The gamma adjustment of the stream. Values less than 1 will make bright colours brighter and dark colours darker, ideal for dark rooms. Values greater than 1 will saturate darker colours, ideal for bright rooms.