Skip to main content

set_system_volume

Signature:

BoosterAudioManager.set_system_volume(volume: float) -> None

Description:

Set the robot system output volume. This is a system-level output volume, distinct from the per-playback volume in play(..., volume=...); setting it to 0.0 mutes the system.

Parameters:

Parameter

Type

Default

Description

volume

float

Required

System volume, range 0.0 to 1.0.

Returns:

None

Raises:

ValueError: volume is not in the range 0.0 to 1.0.

RuntimeError: Audio subsystem is closed or system volume setting failed.

Example:

from boosteros.robots.booster import BoosterRobot

robot = BoosterRobot()
robot.audio_manager.set_system_volume(0.8)