Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.cast.media_player.CastDevice Class Reference
Inheritance diagram for homeassistant.components.cast.media_player.CastDevice:
[legend]

Public Member Functions

None __init__ (self, HomeAssistant hass, ChromecastInfo cast_info)
 

Public Attributes

 mz_mgr
 

Private Member Functions

None _async_cast_discovered (self, ChromecastInfo discover)
 
None _async_cast_removed (self, ChromecastInfo discover)
 
def _async_connect_to_chromecast (self)
 
None _async_disconnect (self)
 
None _async_setup (self, str name)
 
None _async_stop (self, Event event)
 
None _async_tear_down (self)
 
pychromecast.Chromecast _get_chromecast (self)
 
None _invalidate (self)
 

Private Attributes

 _add_remove_handler
 
 _cast_info
 
 _chromecast
 
 _del_remove_handler
 
 _name
 
 _status_listener
 

Detailed Description

Representation of a Cast device or dynamic group on the network.

This class is the holder of the pychromecast.Chromecast object and its
socket client. It therefore handles all reconnects and audio groups changing
"elected leader" itself.

Definition at line 171 of file media_player.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.cast.media_player.CastDevice.__init__ (   self,
HomeAssistant  hass,
ChromecastInfo  cast_info 
)
Initialize the cast device.

Reimplemented in homeassistant.components.cast.media_player.CastMediaPlayerEntity.

Definition at line 181 of file media_player.py.

Member Function Documentation

◆ _async_cast_discovered()

None homeassistant.components.cast.media_player.CastDevice._async_cast_discovered (   self,
ChromecastInfo  discover 
)
private
Handle discovery of new Chromecast.

Definition at line 270 of file media_player.py.

◆ _async_cast_removed()

None homeassistant.components.cast.media_player.CastDevice._async_cast_removed (   self,
ChromecastInfo  discover 
)
private
Handle removal of Chromecast.

Reimplemented in homeassistant.components.cast.media_player.DynamicCastGroup.

Definition at line 279 of file media_player.py.

◆ _async_connect_to_chromecast()

def homeassistant.components.cast.media_player.CastDevice._async_connect_to_chromecast (   self)
private
Set up the chromecast object.

Reimplemented in homeassistant.components.cast.media_player.CastMediaPlayerEntity.

Definition at line 224 of file media_player.py.

◆ _async_disconnect()

None homeassistant.components.cast.media_player.CastDevice._async_disconnect (   self)
private
Disconnect Chromecast object if it is set.

Reimplemented in homeassistant.components.cast.media_player.CastMediaPlayerEntity.

Definition at line 249 of file media_player.py.

◆ _async_setup()

None homeassistant.components.cast.media_player.CastDevice._async_setup (   self,
str  name 
)
private
Create chromecast object.

Definition at line 193 of file media_player.py.

◆ _async_stop()

None homeassistant.components.cast.media_player.CastDevice._async_stop (   self,
Event  event 
)
private
Disconnect socket on Home Assistant stop.

Definition at line 282 of file media_player.py.

◆ _async_tear_down()

None homeassistant.components.cast.media_player.CastDevice._async_tear_down (   self)
private
Disconnect chromecast object and remove listeners.

Definition at line 210 of file media_player.py.

◆ _get_chromecast()

pychromecast.Chromecast homeassistant.components.cast.media_player.CastDevice._get_chromecast (   self)
private
Ensure chromecast is available, to facilitate type checking.

Definition at line 286 of file media_player.py.

◆ _invalidate()

None homeassistant.components.cast.media_player.CastDevice._invalidate (   self)
private
Invalidate some attributes.

Reimplemented in homeassistant.components.cast.media_player.CastMediaPlayerEntity.

Definition at line 261 of file media_player.py.

Member Data Documentation

◆ _add_remove_handler

homeassistant.components.cast.media_player.CastDevice._add_remove_handler
private

Definition at line 196 of file media_player.py.

◆ _cast_info

homeassistant.components.cast.media_player.CastDevice._cast_info
private

Definition at line 185 of file media_player.py.

◆ _chromecast

homeassistant.components.cast.media_player.CastDevice._chromecast
private

Definition at line 237 of file media_player.py.

◆ _del_remove_handler

homeassistant.components.cast.media_player.CastDevice._del_remove_handler
private

Definition at line 199 of file media_player.py.

◆ _name

homeassistant.components.cast.media_player.CastDevice._name
private

Definition at line 195 of file media_player.py.

◆ _status_listener

homeassistant.components.cast.media_player.CastDevice._status_listener
private

Definition at line 244 of file media_player.py.

◆ mz_mgr

homeassistant.components.cast.media_player.CastDevice.mz_mgr

Definition at line 187 of file media_player.py.


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