Streamquality

For clients to the Spot CAM StreamQuality service.

class bosdyn.client.spot_cam.streamquality.StreamQualityClient[source]

Bases: BaseClient

A client calling Spot CAM StreamQuality service.

default_service_name = 'spot-cam-stream-quality'
service_type = 'bosdyn.api.spot_cam.StreamQualityService'
set_stream_params(target_bitrate=None, refresh_interval=None, idr_interval=None, awb_mode=None, auto_exposure=None, sync_auto_exposure=None, manual_exposure=None, **kwargs)[source]

Change image compression and postprocessing.

At most one of auto_exposure, sync_auto_exposure, and manual_exposure can be specified. The others should be set to None if one is specified. Otherwise, they should all be None.

Parameters:
  • target_bitrate (int) – The compression level in target BPS

  • refreshinterval (int) – How often the entire feed should be refreshed (in frames)

  • idrinterval (int) – How often an IDR message should get sent (in frames)

  • awb_mode (AwbModeEnum) – Options for automatic white balancing mode

  • auto_exposure (AutoExposure) – Runs exposure independently on each of the ring cameras

  • sync_auto_exposure (SyncAutoExposure) – Runs a single autoexposure algorithm that takes into account data from all ring cameras

  • manual_exposure (ManualExposure) – Manual exposure sets an exposure for all ring cameras

set_stream_params_async(target_bitrate=None, refresh_interval=None, idr_interval=None, awb_mode=None, auto_exposure=None, sync_auto_exposure=None, manual_exposure=None, **kwargs)[source]

Async version of set_stream_params().

get_stream_params(**kwargs)[source]

Get image quality and processing settings.

get_stream_params_async(**kwargs)[source]

Async version of get_stream_params().

enable_congestion_control(enable=True, **kwargs)[source]

Enable congestion control.

enable_congestion_control_async(enable=True, **kwargs)[source]

Async version of enable_congestion_control().