stream

mio stream

Command group for StreamDevice

Usage

mio stream [OPTIONS] COMMAND [ARGS]...

capture

Capture video from a StreamDevice device, optionally saving as an encoded video or as raw binary

Usage

mio stream capture [OPTIONS]

Options

-c, --config <config>

Required Either a config id or a path to device config YAML file for streamDaq. If you aren’t using id you can ignore them.(see models.stream.StreamDevConfig). If path is relative, treated as relative to the current directory, and then if no matching file is found, relative to the user config_dir (see mio config –help).

--mode <mode>

Capture mode. - ‘capture’ (default) capture video/metadata; - ‘ber’ runs a PRBS bit-error-rate test and produces no video/metadata output.

Default:

'capture'

Options:

capture | ber

-f, --freq_mask_config <freq_mask_config>

Path to, or ID of frequency masking config YAML file - applies frequency masking to the displayed video, but preserves raw video and does not modify the video output written to disk (apply postprocessing separately).

-m, --metadata_display

Display metadata in real time. WARNING: This is still an EXPERIMENTAL feature and is UNSTABLE.

-b, --binary_export

Save binary to a .bin file

--no-display

Don’t show video in real time

-ok, --output-kwarg <okwarg>

Output kwargs (passed to StreamDevice.init_video). passed as (potentially multiple) calls like

mio stream capture -ok key1 val1 -ok key2 val2

-o, --output <output>

Output file basename for video, metadata, and binary exports

test

Run StreamDevice in testing mode, using the okDevMock rather than the actual device

Usage

mio stream test [OPTIONS]

Options

-c, --config <config>

Required Either a config id or a path to device config YAML file for streamDaq. If you aren’t using id you can ignore them.(see models.stream.StreamDevConfig). If path is relative, treated as relative to the current directory, and then if no matching file is found, relative to the user config_dir (see mio config –help).

-s, --source <source>

Required Path to RAW FPGA data to plug into okDevMock

-p, --profile

Run with profiler (not implemented yet)

--mode <mode>

Capture mode. - ‘capture’ (default) capture video/metadata; - ‘ber’ runs a PRBS bit-error-rate test and produces no video/metadata output.

Default:

'capture'

Options:

capture | ber

-f, --freq_mask_config <freq_mask_config>

Path to, or ID of frequency masking config YAML file - applies frequency masking to the displayed video, but preserves raw video and does not modify the video output written to disk (apply postprocessing separately).

-m, --metadata_display

Display metadata in real time. WARNING: This is still an EXPERIMENTAL feature and is UNSTABLE.

-b, --binary_export

Save binary to a .bin file

--no-display

Don’t show video in real time

-ok, --output-kwarg <okwarg>

Output kwargs (passed to StreamDevice.init_video). passed as (potentially multiple) calls like

mio stream capture -ok key1 val1 -ok key2 val2

-o, --output <output>

Output file basename for video, metadata, and binary exports