Warning

This documentation is actively being updated as the project evolves and may not be complete in all areas.

Ustreamer driver

jumpstarter-driver-ustreamer provides functionality for using the ustreamer video streaming server driven by the jumpstarter exporter. This driver takes a video device and exposes both snapshot and streaming interfaces.

Installation

pip3 install --extra-index-url https://pkg.jumpstarter.dev/simple/ jumpstarter-driver-ustreamer

Configuration

Example configuration:

type: "jumpstarter_driver_ustreamer.driver.UStreamer"
config:
  # name or path of the ustreamer executable
  # defaults to finding ustreamer from path
  executable: "ustreamer"
  args: # extra arguments to pass to ustreamer
    brightness: auto # --brightness=auto
    contrast: default # --contract=default

API Reference

class jumpstarter_driver_ustreamer.client.UStreamerClient

UStreamer client class

Client methods for the UStreamer driver.

snapshot()

Get a snapshot image from the video input

Returns:

PIL Image object of the snapshot image

Return type:

PIL.Image

state()

Get state of ustreamer service