Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.cast Namespace Reference

Namespaces

 config_flow
 
 const
 
 discovery
 
 helpers
 
 home_assistant_cast
 
 media_player
 

Classes

class  CastProtocol
 

Functions

def _register_cast_platform (HomeAssistant hass, str integration_domain, CastProtocol platform)
 
bool async_remove_config_entry_device (HomeAssistant hass, ConfigEntry config_entry, dr.DeviceEntry device_entry)
 
None async_remove_entry (HomeAssistant hass, ConfigEntry entry)
 
bool async_setup_entry (HomeAssistant hass, ConfigEntry entry)
 

Variables

list PLATFORMS = [Platform.MEDIA_PLAYER]
 

Detailed Description

Component to embed Google Cast.

Function Documentation

◆ _register_cast_platform()

def homeassistant.components.cast._register_cast_platform ( HomeAssistant  hass,
str  integration_domain,
CastProtocol   platform 
)
private
Register a cast platform.

Definition at line 70 of file __init__.py.

◆ async_remove_config_entry_device()

bool homeassistant.components.cast.async_remove_config_entry_device ( HomeAssistant  hass,
ConfigEntry  config_entry,
dr.DeviceEntry   device_entry 
)
Remove cast config entry from a device.

The actual cleanup is done in CastMediaPlayerEntity.async_will_remove_from_hass.

Definition at line 88 of file __init__.py.

◆ async_remove_entry()

None homeassistant.components.cast.async_remove_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Remove Home Assistant Cast user.

Definition at line 83 of file __init__.py.

◆ async_setup_entry()

bool homeassistant.components.cast.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Set up Cast from a config entry.

Definition at line 25 of file __init__.py.

Variable Documentation

◆ PLATFORMS

list homeassistant.components.cast.PLATFORMS = [Platform.MEDIA_PLAYER]

Definition at line 22 of file __init__.py.