OpenRoadCode
Public API reference for OpenRoadCode
Loading...
Searching...
No Matches
apps.carUi.system.volume_manager.VolumeManager Class Reference

Handle volume requests and publish normalized system volume state. More...

Inheritance diagram for apps.carUi.system.volume_manager.VolumeManager:
ui.system.volume_request_handler_if.VolumeRequestHandlerIf

Public Member Functions

None refresh (self)
 Read and publish the current system volume and mute state.
 
None request_volume (self, float volume_percent)
 Apply a requested normalized volume percentage.
 
None request_volume_up (self)
 Increase system volume by the controller-defined increment.
 
None request_volume_down (self)
 Decrease system volume by the controller-defined increment.
 
None request_mute (self, bool muted)
 Apply a requested mute state.
 
None volume_up (self)
 Increase system volume for legacy action bindings.
 
None volume_down (self)
 Decrease system volume for legacy action bindings.
 
None toggle_mute (self)
 Invert the current system mute state.
 

Detailed Description

Handle volume requests and publish normalized system volume state.

Member Function Documentation

◆ request_mute()

None apps.carUi.system.volume_manager.VolumeManager.request_mute (   self,
bool  muted 
)

Apply a requested mute state.

Parameters
mutedTrue to mute system audio.

Reimplemented from ui.system.volume_request_handler_if.VolumeRequestHandlerIf.

◆ request_volume()

None apps.carUi.system.volume_manager.VolumeManager.request_volume (   self,
float  volume_percent 
)

Apply a requested normalized volume percentage.

Parameters
volume_percentRequested volume clamped to 0 through 100.

Reimplemented from ui.system.volume_request_handler_if.VolumeRequestHandlerIf.


The documentation for this class was generated from the following file: