ui.system.volume_ui_if.VolumeUiIf Class Reference

Display normalized system volume and mute state. More...

Inheritance diagram for ui.system.volume_ui_if.VolumeUiIf:

Public Member Functions
None	set_volume (self, float|None volume_percent)
	Set the displayed system volume.
None	set_muted (self, bool|None muted)
	Set the displayed system mute state.
None	set_volume_request_handler (self, VolumeRequestHandlerIf|None handler)
	Set or clear the system volume request handler.

Detailed Description

Display normalized system volume and mute state.

This contract does not prescribe discrete steps, visual indicators, audio backends, or widget placement. None means the state is unavailable.

Member Function Documentation

set_muted()

None ui.system.volume_ui_if.VolumeUiIf.set_muted	(		self,
		bool | None	muted
	)

Set the displayed system mute state.

Parameters

muted

Mute state, or None when unavailable.

Reimplemented in apps.orcUi.frontend.tk.orc_ui_app.OrcUiApp, frontends.tk.system.volume_panel.VolumePanel, and ui.system.volume_ui_stub.VolumeUiStub.

set_volume()

None ui.system.volume_ui_if.VolumeUiIf.set_volume	(		self,
		float | None	volume_percent
	)

Set the displayed system volume.

Parameters

volume_percent

Volume from 0 through 100, or None when unavailable.

Reimplemented in apps.orcUi.frontend.tk.orc_ui_app.OrcUiApp, frontends.tk.system.volume_panel.VolumePanel, and ui.system.volume_ui_stub.VolumeUiStub.

set_volume_request_handler()

None ui.system.volume_ui_if.VolumeUiIf.set_volume_request_handler	(		self,
		VolumeRequestHandlerIf | None	handler
	)

Set or clear the system volume request handler.

Parameters

handler

Volume request handler, or None to disconnect it.

Reimplemented in apps.orcUi.frontend.tk.orc_ui_app.OrcUiApp, frontends.tk.system.volume_panel.VolumePanel, and ui.system.volume_ui_stub.VolumeUiStub.

---

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

• ui/system/volume_ui_if.py