Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.pulseaudio_loopback.switch Namespace Reference

Classes

class  PALoopbackSwitch
 

Functions

None setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback add_entities, DiscoveryInfoType|None discovery_info=None)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
string CONF_SINK_NAME = "sink_name"
 
string CONF_SOURCE_NAME = "source_name"
 
string DEFAULT_NAME = "paloopback"
 
int DEFAULT_PORT = 4713
 
string DOMAIN = "pulseaudio_loopback"
 
string IGNORED_SWITCH_WARN = "Switch is already in the desired state. Ignoring."
 
 PLATFORM_SCHEMA
 

Detailed Description

Switch logic for loading/unloading pulseaudio loopback modules.

Function Documentation

◆ setup_platform()

None homeassistant.components.pulseaudio_loopback.switch.setup_platform ( HomeAssistant  hass,
ConfigType  config,
AddEntitiesCallback  add_entities,
DiscoveryInfoType | None   discovery_info = None 
)
Read in all of our configuration, and initialize the loopback switch.

Definition at line 44 of file switch.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.pulseaudio_loopback.switch._LOGGER = logging.getLogger(__name__)
private

Definition at line 23 of file switch.py.

◆ CONF_SINK_NAME

string homeassistant.components.pulseaudio_loopback.switch.CONF_SINK_NAME = "sink_name"

Definition at line 25 of file switch.py.

◆ CONF_SOURCE_NAME

string homeassistant.components.pulseaudio_loopback.switch.CONF_SOURCE_NAME = "source_name"

Definition at line 26 of file switch.py.

◆ DEFAULT_NAME

string homeassistant.components.pulseaudio_loopback.switch.DEFAULT_NAME = "paloopback"

Definition at line 28 of file switch.py.

◆ DEFAULT_PORT

int homeassistant.components.pulseaudio_loopback.switch.DEFAULT_PORT = 4713

Definition at line 29 of file switch.py.

◆ DOMAIN

string homeassistant.components.pulseaudio_loopback.switch.DOMAIN = "pulseaudio_loopback"

Definition at line 21 of file switch.py.

◆ IGNORED_SWITCH_WARN

string homeassistant.components.pulseaudio_loopback.switch.IGNORED_SWITCH_WARN = "Switch is already in the desired state. Ignoring."

Definition at line 31 of file switch.py.

◆ PLATFORM_SCHEMA

homeassistant.components.pulseaudio_loopback.switch.PLATFORM_SCHEMA
Initial value:
1 = SWITCH_PLATFORM_SCHEMA.extend(
2  {
3  vol.Required(CONF_SINK_NAME): cv.string,
4  vol.Required(CONF_SOURCE_NAME): cv.string,
5  vol.Optional(CONF_HOST): cv.string,
6  vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
7  vol.Optional(CONF_PORT, default=DEFAULT_PORT): cv.port,
8  }
9 )

Definition at line 33 of file switch.py.