homeassistant.components.cast.media_player.CastMediaPlayerEntity Class Reference

Inheritance diagram for homeassistant.components.cast.media_player.CastMediaPlayerEntity:

Collaboration diagram for homeassistant.components.cast.media_player.CastMediaPlayerEntity:

Public Member Functions
None	__init__ (self, HomeAssistant hass, ChromecastInfo cast_info)
def	app_id (self)
def	app_name (self)
None	async_added_to_hass (self)
BrowseMedia	async_browse_media (self, MediaType|str|None media_content_type=None, str|None media_content_id=None)
None	async_play_media (self, MediaType|str media_type, str media_id, **Any kwargs)
None	async_will_remove_from_hass (self)
def	load_media_failed (self, queue_item_id, error_code)
def	media_album_artist (self)
def	media_album_name (self)
def	media_artist (self)
str|None	media_content_id (self)
MediaType|None	media_content_type (self)
def	media_duration (self)
def	media_episode (self)
def	media_image_url (self)
None	media_next_track (self)
None	media_pause (self)
None	media_play (self)
def	media_position (self)
def	media_position_updated_at (self)
None	media_previous_track (self)
def	media_season (self)
None	media_seek (self, float position)
def	media_series_title (self)
None	media_stop (self)
def	media_title (self)
def	media_track (self)
def	multizone_new_media_status (self, group_uuid, media_status)
None	mute_volume (self, bool mute)
def	new_cast_status (self, cast_status)
def	new_connection_status (self, connection_status)
def	new_media_status (self, media_status)
None	set_volume_level (self, float volume)
MediaPlayerState|None	state (self)
MediaPlayerEntityFeature	supported_features (self)
None	turn_off (self)
None	turn_on (self)
Public Member Functions inherited from homeassistant.components.media_player.MediaPlayerEntity
str	access_token (self)
None	async_clear_playlist (self)
tuple[bytes|None, str|None]	async_get_browse_image (self, str media_content_type, str media_content_id, str|None media_image_id=None)
tuple[bytes|None, str|None]	async_get_media_image (self)
None	async_join_players (self, list[str] group_members)
None	async_media_next_track (self)
None	async_media_pause (self)
None	async_media_play (self)
None	async_media_play_pause (self)
None	async_media_previous_track (self)
None	async_media_seek (self, float position)
None	async_media_stop (self)
None	async_mute_volume (self, bool mute)
None	async_select_sound_mode (self, str sound_mode)
None	async_select_source (self, str source)
None	async_set_repeat (self, RepeatMode repeat)
None	async_set_shuffle (self, bool shuffle)
None	async_set_volume_level (self, float volume)
None	async_toggle (self)
None	async_turn_off (self)
None	async_turn_on (self)
None	async_unjoin_player (self)
None	async_volume_down (self)
None	async_volume_up (self)
dict[str, Any]	capability_attributes (self)
None	clear_playlist (self)
MediaPlayerDeviceClass|None	device_class (self)
str|None	entity_picture (self)
str	get_browse_image_url (self, str media_content_type, str media_content_id, str|None media_image_id=None)
list[str]|None	group_members (self)
bool|None	is_volume_muted (self)
None	join_players (self, list[str] group_members)
str|None	media_channel (self)
str|None	media_image_hash (self)
str|None	media_image_local (self)
bool	media_image_remotely_accessible (self)
str|None	media_playlist (self)
None	play_media (self, MediaType|str media_type, str media_id, **Any kwargs)
RepeatMode|str|None	repeat (self)
None	select_sound_mode (self, str sound_mode)
None	select_source (self, str source)
None	set_repeat (self, RepeatMode repeat)
None	set_shuffle (self, bool shuffle)
bool|None	shuffle (self)
str|None	sound_mode (self)
list[str]|None	sound_mode_list (self)
str|None	source (self)
list[str]|None	source_list (self)
dict[str, Any]	state_attributes (self)
bool	support_clear_playlist (self)
bool	support_grouping (self)
bool	support_next_track (self)
bool	support_pause (self)
bool	support_play (self)
bool	support_play_media (self)
bool	support_previous_track (self)
bool	support_seek (self)
bool	support_select_sound_mode (self)
bool	support_select_source (self)
bool	support_shuffle_set (self)
bool	support_stop (self)
bool	support_volume_mute (self)
bool	support_volume_set (self)
MediaPlayerEntityFeature	supported_features_compat (self)
None	unjoin_player (self)
float|None	volume_level (self)
float	volume_step (self)
Public Member Functions inherited from homeassistant.helpers.entity.Entity
None	__init_subclass__ (cls, **Any kwargs)
str	__repr__ (self)
None	add_to_platform_abort (self)
None	add_to_platform_finish (self)
None	add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
bool	assumed_state (self)
None	async_device_update (self, bool warning=True)
None	async_internal_added_to_hass (self)
None	async_internal_will_remove_from_hass (self)
None	async_on_remove (self, CALLBACK_TYPE func)
None	async_registry_entry_updated (self)
None	async_remove (self, *bool force_remove=False)
None	async_removed_from_registry (self)
None	async_schedule_update_ha_state (self, bool force_refresh=False)
None	async_set_context (self, Context context)
None	async_update_ha_state (self, bool force_refresh=False)
None	async_write_ha_state (self)
str|None	attribution (self)
bool	available (self)
DeviceInfo|None	device_info (self)
bool	enabled (self)
EntityCategory|None	entity_category (self)
bool	entity_registry_enabled_default (self)
bool	entity_registry_visible_default (self)
Mapping[str, Any]|None	extra_state_attributes (self)
bool	force_update (self)
HassJobType	get_hassjob_type (self, str function_name)
er.EntityOptionsType|None	get_initial_entity_options (self)
bool	has_entity_name (self)
str|None	icon (self)
str|UndefinedType|None	name (self)
None	schedule_update_ha_state (self, bool force_refresh=False)
bool	should_poll (self)
str|None	suggested_object_id (self)
str|None	translation_key (self)
Mapping[str, str]	translation_placeholders (self)
str|None	unique_id (self)
str|None	unit_of_measurement (self)
bool	use_device_name (self)
Public Member Functions inherited from homeassistant.helpers.entity.CachedProperties
None	__init__ (cls, str name, tuple[type,...] bases, dict[Any, Any] namespace, **Any kwargs)
Any	__new__ (mcs, str name, tuple[type,...] bases, dict[Any, Any] namespace, set[str]|None cached_properties=None, **Any kwargs)

Public Attributes
	app_id
	cast_status
	media_status
	media_status_received
	mz_media_status
	mz_media_status_received
Public Attributes inherited from homeassistant.components.cast.media_player.CastDevice
	mz_mgr
Public Attributes inherited from homeassistant.components.media_player.MediaPlayerEntity
	state
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry
	entity_id
	hass
	parallel_updates
	platform
	registry_entry

Private Member Functions
def	_async_connect_to_chromecast (self)
def	_async_disconnect (self)
def	_async_root_payload (self, content_filter)
def	_handle_signal_show_view (self, HomeAssistantControllerData controller_data, str entity_id, str view_path, str|None url_path)
def	_invalidate (self)
def	_media_controller (self)
def	_media_status (self)
None	_quick_play (self, str app_name, dict[str, Any] data)
None	_quit_app (self)
None	_start_app (self, str app_id)

Private Attributes
	_attr_available
	_attr_device_class
	_attr_device_info
	_attr_is_volume_muted
	_attr_unique_id
	_attr_volume_level
	_cast_view_remove_handler
	_hass_cast_controller

Static Private Attributes
bool	_attr_has_entity_name = True
bool	_attr_media_image_remotely_accessible = True
	_attr_name = None
bool	_attr_should_poll = False
bool	_mz_only = False

Additional Inherited Members
Static Public Attributes inherited from homeassistant.components.media_player.MediaPlayerEntity
	bool
	MediaPlayerEntityFeature
	None
Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool
	EntityPlatform
	HomeAssistant
	None
	StateInfo
	StateType
	str

Detailed Description

Representation of a Cast device on the network.

Definition at line 293 of file media_player.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.cast.media_player.CastMediaPlayerEntity.__init__	(		self,
		HomeAssistant	hass,
		ChromecastInfo	cast_info
	)

Initialize the cast device.

Reimplemented from homeassistant.components.cast.media_player.CastDevice.

Definition at line 302 of file media_player.py.

Member Function Documentation

_async_connect_to_chromecast()

def homeassistant.components.cast.media_player.CastMediaPlayerEntity._async_connect_to_chromecast (   self )

private

Set up the chromecast object.

Reimplemented from homeassistant.components.cast.media_player.CastDevice.

Definition at line 346 of file media_player.py.

_async_disconnect()

def homeassistant.components.cast.media_player.CastMediaPlayerEntity._async_disconnect (   self )

private

Disconnect Chromecast object if it is set.

Reimplemented from homeassistant.components.cast.media_player.CastDevice.

Definition at line 355 of file media_player.py.

_async_root_payload()

def homeassistant.components.cast.media_player.CastMediaPlayerEntity._async_root_payload (   self,   content_filter  )

private

Generate root node.

Definition at line 590 of file media_player.py.

_handle_signal_show_view()

def homeassistant.components.cast.media_player.CastMediaPlayerEntity._handle_signal_show_view (   self, HomeAssistantControllerData  controller_data, str  entity_id, str  view_path, str | None  url_path  )

private

Handle a show view signal.

Definition at line 999 of file media_player.py.

_invalidate()

def homeassistant.components.cast.media_player.CastMediaPlayerEntity._invalidate (   self )

private

Invalidate some attributes.

Reimplemented from homeassistant.components.cast.media_player.CastDevice.

Definition at line 362 of file media_player.py.

_media_controller()

def homeassistant.components.cast.media_player.CastMediaPlayerEntity._media_controller (   self )

private

Return media controller.

First try from our own cast, then groups which our cast is a member in.

Definition at line 485 of file media_player.py.

_media_status()

def homeassistant.components.cast.media_player.CastMediaPlayerEntity._media_status (   self )

private

Return media status.

First try from our own cast, then groups which our cast is a member in.

Definition at line 781 of file media_player.py.

_quick_play()

None homeassistant.components.cast.media_player.CastMediaPlayerEntity._quick_play (   self, str  app_name, dict[str, Any]  data  )

private

Launch the app `app_name` and start playing media defined by `data`.

Definition at line 506 of file media_player.py.

_quit_app()

None homeassistant.components.cast.media_player.CastMediaPlayerEntity._quit_app (   self )

private

Quit the currently running app.

Definition at line 511 of file media_player.py.

_start_app()

None homeassistant.components.cast.media_player.CastMediaPlayerEntity._start_app (   self, str  app_id  )

private

Start an app.

Definition at line 516 of file media_player.py.

app_id()

def homeassistant.components.cast.media_player.CastMediaPlayerEntity.app_id

(

self

)

Return the ID of the current running app.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 927 of file media_player.py.

app_name()

def homeassistant.components.cast.media_player.CastMediaPlayerEntity.app_name

(

self

)

Name of the current running app.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 932 of file media_player.py.

async_added_to_hass()

None homeassistant.components.cast.media_player.CastMediaPlayerEntity.async_added_to_hass

(

self

)

Create chromecast object when added to hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 330 of file media_player.py.

async_browse_media()

BrowseMedia homeassistant.components.cast.media_player.CastMediaPlayerEntity.async_browse_media	(		self,
		MediaType | str | None	media_content_type = None,
		str | None	media_content_id = None
	)

Implement the websocket media browsing helper.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 628 of file media_player.py.

async_play_media()

None homeassistant.components.cast.media_player.CastMediaPlayerEntity.async_play_media	(		self,
		MediaType | str	media_type,
		str	media_id,
		**Any	kwargs
	)

Play a piece of media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 667 of file media_player.py.

async_will_remove_from_hass()

None homeassistant.components.cast.media_player.CastMediaPlayerEntity.async_will_remove_from_hass

(

self

)

Disconnect Chromecast object when removed.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 338 of file media_player.py.

load_media_failed()

def homeassistant.components.cast.media_player.CastMediaPlayerEntity.load_media_failed	(		self,
			queue_item_id,
			error_code
	)

Handle load media failed.

Definition at line 419 of file media_player.py.

media_album_artist()

def homeassistant.components.cast.media_player.CastMediaPlayerEntity.media_album_artist

(

self

)

Album artist of current playing media (Music track only).

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 897 of file media_player.py.

media_album_name()

def homeassistant.components.cast.media_player.CastMediaPlayerEntity.media_album_name

(

self

)

Album of current playing media (Music track only).

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 891 of file media_player.py.

media_artist()

def homeassistant.components.cast.media_player.CastMediaPlayerEntity.media_artist

(

self

)

Artist of current playing media (Music track only).

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 885 of file media_player.py.

media_content_id()

str | None homeassistant.components.cast.media_player.CastMediaPlayerEntity.media_content_id

(

self

)

Content ID of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 827 of file media_player.py.

media_content_type()

MediaType | None homeassistant.components.cast.media_player.CastMediaPlayerEntity.media_content_type

(

self

)

Content type of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 836 of file media_player.py.

media_duration()

def homeassistant.components.cast.media_player.CastMediaPlayerEntity.media_duration

(

self

)

Duration of current playing media in seconds.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 860 of file media_player.py.

media_episode()

def homeassistant.components.cast.media_player.CastMediaPlayerEntity.media_episode

(

self

)

Episode of current playing media (TV Show only).

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 921 of file media_player.py.

media_image_url()

def homeassistant.components.cast.media_player.CastMediaPlayerEntity.media_image_url

(

self

)

Image url of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 869 of file media_player.py.

media_next_track()

None homeassistant.components.cast.media_player.CastMediaPlayerEntity.media_next_track

(

self

)

Send next track command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 579 of file media_player.py.

media_pause()

None homeassistant.components.cast.media_player.CastMediaPlayerEntity.media_pause

(

self

)

Send pause command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 561 of file media_player.py.

media_play()

None homeassistant.components.cast.media_player.CastMediaPlayerEntity.media_play

(

self

)

Send play command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 555 of file media_player.py.

media_position()

def homeassistant.components.cast.media_player.CastMediaPlayerEntity.media_position

(

self

)

Position of current playing media in seconds.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 975 of file media_player.py.

media_position_updated_at()

def homeassistant.components.cast.media_player.CastMediaPlayerEntity.media_position_updated_at

(

self

)

When was the position of the current playing media valid.

Returns value from homeassistant.util.dt.utcnow().

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 990 of file media_player.py.

media_previous_track()

None homeassistant.components.cast.media_player.CastMediaPlayerEntity.media_previous_track

(

self

)

Send previous track command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 573 of file media_player.py.

media_season()

def homeassistant.components.cast.media_player.CastMediaPlayerEntity.media_season

(

self

)

Season of current playing media (TV Show only).

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 915 of file media_player.py.

media_seek()

None homeassistant.components.cast.media_player.CastMediaPlayerEntity.media_seek	(		self,
		float	position
	)

Seek the media to a specific location.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 585 of file media_player.py.

media_series_title()

def homeassistant.components.cast.media_player.CastMediaPlayerEntity.media_series_title

(

self

)

Return the title of the series of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 909 of file media_player.py.

media_stop()

None homeassistant.components.cast.media_player.CastMediaPlayerEntity.media_stop

(

self

)

Send stop command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 567 of file media_player.py.

media_title()

def homeassistant.components.cast.media_player.CastMediaPlayerEntity.media_title

(

self

)

Title of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 879 of file media_player.py.

media_track()

def homeassistant.components.cast.media_player.CastMediaPlayerEntity.media_track

(

self

)

Track number of current playing media (Music track only).

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 903 of file media_player.py.

multizone_new_media_status()

def homeassistant.components.cast.media_player.CastMediaPlayerEntity.multizone_new_media_status	(		self,
			group_uuid,
			media_status
	)

Handle updates of audio group media status.

Definition at line 471 of file media_player.py.

mute_volume()

None homeassistant.components.cast.media_player.CastMediaPlayerEntity.mute_volume	(		self,
		bool	mute
	)

Mute the volume.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 545 of file media_player.py.

new_cast_status()

def homeassistant.components.cast.media_player.CastMediaPlayerEntity.new_cast_status	(		self,
			cast_status
	)

Handle updates of the cast status.

Definition at line 374 of file media_player.py.

new_connection_status()

def homeassistant.components.cast.media_player.CastMediaPlayerEntity.new_connection_status	(		self,
			connection_status
	)

Handle updates of connection status.

Definition at line 430 of file media_player.py.

new_media_status()

def homeassistant.components.cast.media_player.CastMediaPlayerEntity.new_media_status	(		self,
			media_status
	)

Handle updates of the media status.

Definition at line 383 of file media_player.py.

set_volume_level()

None homeassistant.components.cast.media_player.CastMediaPlayerEntity.set_volume_level	(		self,
		float	volume
	)

Set volume level, range 0..1.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 550 of file media_player.py.

state()

MediaPlayerState | None homeassistant.components.cast.media_player.CastMediaPlayerEntity.state

(

self

)

Return the state of the player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 803 of file media_player.py.

supported_features()

MediaPlayerEntityFeature homeassistant.components.cast.media_player.CastMediaPlayerEntity.supported_features

(

self

)

Flag media player features that are supported.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 937 of file media_player.py.

turn_off()

None homeassistant.components.cast.media_player.CastMediaPlayerEntity.turn_off

(

self

)

Turn off the cast device.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 540 of file media_player.py.

turn_on()

None homeassistant.components.cast.media_player.CastMediaPlayerEntity.turn_on

(

self

)

Turn on the cast device.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 520 of file media_player.py.

Member Data Documentation

_attr_available

homeassistant.components.cast.media_player.CastMediaPlayerEntity._attr_available

private

Definition at line 312 of file media_player.py.

_attr_device_class

homeassistant.components.cast.media_player.CastMediaPlayerEntity._attr_device_class

private

Definition at line 328 of file media_player.py.

_attr_device_info

homeassistant.components.cast.media_player.CastMediaPlayerEntity._attr_device_info

private

Definition at line 317 of file media_player.py.

_attr_has_entity_name

bool homeassistant.components.cast.media_player.CastMediaPlayerEntity._attr_has_entity_name = True

staticprivate

Definition at line 296 of file media_player.py.

_attr_is_volume_muted

homeassistant.components.cast.media_player.CastMediaPlayerEntity._attr_is_volume_muted

private

Definition at line 378 of file media_player.py.

_attr_media_image_remotely_accessible

bool homeassistant.components.cast.media_player.CastMediaPlayerEntity._attr_media_image_remotely_accessible = True

staticprivate

Definition at line 299 of file media_player.py.

_attr_name

homeassistant.components.cast.media_player.CastMediaPlayerEntity._attr_name = None

staticprivate

Definition at line 297 of file media_player.py.

_attr_should_poll

bool homeassistant.components.cast.media_player.CastMediaPlayerEntity._attr_should_poll = False

staticprivate

Definition at line 298 of file media_player.py.

_attr_unique_id

homeassistant.components.cast.media_player.CastMediaPlayerEntity._attr_unique_id

private

Definition at line 316 of file media_player.py.

_attr_volume_level

homeassistant.components.cast.media_player.CastMediaPlayerEntity._attr_volume_level

private

Definition at line 377 of file media_player.py.

_cast_view_remove_handler

homeassistant.components.cast.media_player.CastMediaPlayerEntity._cast_view_remove_handler

private

Definition at line 334 of file media_player.py.

_hass_cast_controller

homeassistant.components.cast.media_player.CastMediaPlayerEntity._hass_cast_controller

private

Definition at line 371 of file media_player.py.

_mz_only

bool homeassistant.components.cast.media_player.CastMediaPlayerEntity._mz_only = False

staticprivate

Definition at line 300 of file media_player.py.

app_id

homeassistant.components.cast.media_player.CastMediaPlayerEntity.app_id

Definition at line 806 of file media_player.py.

cast_status

homeassistant.components.cast.media_player.CastMediaPlayerEntity.cast_status

Definition at line 307 of file media_player.py.

media_status

homeassistant.components.cast.media_player.CastMediaPlayerEntity.media_status

Definition at line 308 of file media_player.py.

media_status_received

homeassistant.components.cast.media_player.CastMediaPlayerEntity.media_status_received

Definition at line 309 of file media_player.py.

mz_media_status

homeassistant.components.cast.media_player.CastMediaPlayerEntity.mz_media_status

Definition at line 369 of file media_player.py.

mz_media_status_received

homeassistant.components.cast.media_player.CastMediaPlayerEntity.mz_media_status_received

Definition at line 370 of file media_player.py.

---

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

• core/homeassistant/components/cast/media_player.py