audio package

class audio.SoundSplitState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: DisplayStringIntEnum

OFF = 0
NVDA_BOTH_APPS_BOTH = 1
NVDA_LEFT_APPS_RIGHT = 2
NVDA_LEFT_APPS_BOTH = 3
NVDA_RIGHT_APPS_LEFT = 4
NVDA_RIGHT_APPS_BOTH = 5
NVDA_BOTH_APPS_LEFT = 6
NVDA_BOTH_APPS_RIGHT = 7
property _displayStringLabels: dict[IntEnum, str]

Specify a dictionary which takes members of the Enum and returns the translated display string.

getAppVolume() tuple[float, float]
getNVDAVolume() tuple[float, float]
audio._setSoundSplitState(state: SoundSplitState, initial: bool = False) dict
audio._toggleSoundSplitState() None

Submodules

audio.soundSplit module

class audio.soundSplit.SoundSplitState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: DisplayStringIntEnum

OFF = 0
NVDA_BOTH_APPS_BOTH = 1
NVDA_LEFT_APPS_RIGHT = 2
NVDA_LEFT_APPS_BOTH = 3
NVDA_RIGHT_APPS_LEFT = 4
NVDA_RIGHT_APPS_BOTH = 5
NVDA_BOTH_APPS_LEFT = 6
NVDA_BOTH_APPS_RIGHT = 7
property _displayStringLabels: dict[IntEnum, str]

Specify a dictionary which takes members of the Enum and returns the translated display string.

getAppVolume() tuple[float, float]
getNVDAVolume() tuple[float, float]
audio.soundSplit.initialize() None
audio.soundSplit.terminate()
class audio.soundSplit._AudioSessionNotificationWrapper(listener: pycaw.callbacks.AudioSessionNotification)

Bases: AudioSessionNotification

listener: AudioSessionNotification
on_session_created(new_session: AudioSession)

pycaw user interface

audio.soundSplit._applyToAllAudioSessions(callback: AudioSessionNotification, applyToFuture: bool = True) None

Executes provided callback function on all active audio sessions. Additionally, if applyToFuture is True, then it will register a notification with audio session manager, which will execute the same callback for all future sessions as they are created. That notification will be active until next invokation of this function, or until _unregisterCallback() is called.

audio.soundSplit._unregisterCallback() None
class audio.soundSplit._VolumeSetter(leftVolume: float, rightVolume: float, leftNVDAVolume: float, rightNVDAVolume: float, foundSessionWithNot2Channels: bool = False)

Bases: AudioSessionNotification

leftVolume: float
rightVolume: float
leftNVDAVolume: float
rightNVDAVolume: float
foundSessionWithNot2Channels: bool = False
on_session_created(new_session: AudioSession)

pycaw user interface

audio.soundSplit._setSoundSplitState(state: SoundSplitState, initial: bool = False) dict
audio.soundSplit._toggleSoundSplitState() None
class audio.soundSplit._VolumeRestorer(pid: int, audioSession: pycaw.utils.AudioSession)

Bases: AudioSessionEvents

pid: int
audioSession: AudioSession
on_state_changed(new_state: str, new_state_id: int)

pycaw user interface

restoreVolume()
unregister()