OpenRoadCode
Public API reference for OpenRoadCode
Loading...
Searching...
No Matches
ui.system.volume_request_handler_if.VolumeRequestHandlerIf Class Reference

Handle system volume requests produced by a UI. More...

Inheritance diagram for ui.system.volume_request_handler_if.VolumeRequestHandlerIf:
apps.carUi.system.volume_manager.VolumeManager audio.system_volume_handler.SystemVolumeHandler ui.system.volume_request_handler_stub.VolumeRequestHandlerStub

Public Member Functions

None request_volume (self, float volume_percent)
 Request an absolute system volume.
 
None request_volume_up (self)
 Request one implementation-defined volume increase.
 
None request_volume_down (self)
 Request one implementation-defined volume decrease.
 
None request_mute (self, bool muted)
 Request an explicit system mute state.
 

Detailed Description

Handle system volume requests produced by a UI.

Member Function Documentation

◆ request_mute()

None ui.system.volume_request_handler_if.VolumeRequestHandlerIf.request_mute (   self,
bool  muted 
)

Request an explicit system mute state.

Parameters
mutedTrue to mute system audio; false to make it audible.

Reimplemented in apps.carUi.system.volume_manager.VolumeManager, audio.system_volume_handler.SystemVolumeHandler, and ui.system.volume_request_handler_stub.VolumeRequestHandlerStub.

◆ request_volume()

None ui.system.volume_request_handler_if.VolumeRequestHandlerIf.request_volume (   self,
float  volume_percent 
)

Request an absolute system volume.

Parameters
volume_percentRequested volume from 0 through 100.

Reimplemented in apps.carUi.system.volume_manager.VolumeManager, audio.system_volume_handler.SystemVolumeHandler, and ui.system.volume_request_handler_stub.VolumeRequestHandlerStub.


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