homeassistant.components.xbox.media_player.XboxMediaPlayer Class Reference

Inheritance diagram for homeassistant.components.xbox.media_player.XboxMediaPlayer:

Collaboration diagram for homeassistant.components.xbox.media_player.XboxMediaPlayer:

Public Member Functions
None	__init__ (self, XboxLiveClient client, SmartglassConsole console, XboxUpdateCoordinator coordinator)
def	async_browse_media (self, media_content_type=None, media_content_id=None)
None	async_media_next_track (self)
None	async_media_pause (self)
None	async_media_play (self)
None	async_media_previous_track (self)
None	async_mute_volume (self, bool mute)
None	async_play_media (self, MediaType|str media_type, str media_id, **Any kwargs)
None	async_turn_off (self)
None	async_turn_on (self)
None	async_volume_down (self)
None	async_volume_up (self)
ConsoleData	data (self)
DeviceInfo	device_info (self)
def	media_content_type (self)
bool	media_image_remotely_accessible (self)
def	media_image_url (self)
def	media_title (self)
def	name (self)
MediaPlayerState|None	state (self)
MediaPlayerEntityFeature	supported_features (self)
def	unique_id (self)
Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None	__init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
None	async_update (self)
bool	available (self)
Public Member Functions inherited from homeassistant.components.xbox.coordinator.XboxUpdateCoordinator
None	__init__ (self, HomeAssistant hass, XboxLiveClient client, SmartglassConsoleList consoles)
Public Member Functions inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
None	__init__ (self, HomeAssistant hass, logging.Logger logger, *config_entries.ConfigEntry|None|UndefinedType config_entry=UNDEFINED, str name, timedelta|None update_interval=None, Callable[[], Awaitable[_DataT]]|None update_method=None, Callable[[], Awaitable[None]]|None setup_method=None, Debouncer[Coroutine[Any, Any, None]]|None request_refresh_debouncer=None, bool always_update=True)
Callable[[], None]	async_add_listener (self, CALLBACK_TYPE update_callback, Any context=None)
None	async_config_entry_first_refresh (self)
Generator[Any]	async_contexts (self)
None	async_refresh (self)
None	async_register_shutdown (self)
None	async_request_refresh (self)
None	async_set_update_error (self, Exception err)
None	async_set_updated_data (self, _DataT data)
None	async_shutdown (self)
None	async_update_listeners (self)
timedelta|None	update_interval (self)
None	update_interval (self, timedelta|None value)
Public Member Functions inherited from homeassistant.components.media_player.MediaPlayerEntity
str	access_token (self)
str|None	app_id (self)
str|None	app_name (self)
BrowseMedia	async_browse_media (self, MediaType|str|None media_content_type=None, str|None media_content_id=None)
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_play_pause (self)
None	async_media_seek (self, float position)
None	async_media_stop (self)
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_unjoin_player (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_album_artist (self)
str|None	media_album_name (self)
str|None	media_artist (self)
str|None	media_channel (self)
str|None	media_content_id (self)
int|None	media_duration (self)
str|None	media_episode (self)
str|None	media_image_hash (self)
str|None	media_image_local (self)
None	media_next_track (self)
None	media_pause (self)
None	media_play (self)
str|None	media_playlist (self)
int|None	media_position (self)
dt.datetime|None	media_position_updated_at (self)
None	media_previous_track (self)
str|None	media_season (self)
None	media_seek (self, float position)
str|None	media_series_title (self)
None	media_stop (self)
int|None	media_track (self)
None	mute_volume (self, bool mute)
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)
None	set_volume_level (self, float volume)
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	turn_off (self)
None	turn_on (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_added_to_hass (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_will_remove_from_hass (self)
None	async_write_ha_state (self)
str|None	attribution (self)
bool	available (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)
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	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)

Additional Inherited Members
Public Attributes inherited from homeassistant.components.xbox.coordinator.XboxUpdateCoordinator
	data
Public Attributes inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
	always_update
	config_entry
	data
	hass
	last_exception
	last_update_success
	logger
	name
	setup_method
	update_interval
	update_method
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
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 an Xbox Media Player.

Definition at line 73 of file media_player.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.xbox.media_player.XboxMediaPlayer.__init__	(		self,
		XboxLiveClient	client,
		SmartglassConsole	console,
		XboxUpdateCoordinator	coordinator
	)

Initialize the Xbox Media Player.

Definition at line 76 of file media_player.py.

Member Function Documentation

async_browse_media()

def homeassistant.components.xbox.media_player.XboxMediaPlayer.async_browse_media	(		self,
			media_content_type = None,
			media_content_id = None
	)

Implement the websocket media browsing helper.

Definition at line 198 of file media_player.py.

async_media_next_track()

None homeassistant.components.xbox.media_player.XboxMediaPlayer.async_media_next_track

(

self

)

Send next track command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 194 of file media_player.py.

async_media_pause()

None homeassistant.components.xbox.media_player.XboxMediaPlayer.async_media_pause

(

self

)

Send pause command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 186 of file media_player.py.

async_media_play()

None homeassistant.components.xbox.media_player.XboxMediaPlayer.async_media_play

(

self

)

Send play command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 182 of file media_player.py.

async_media_previous_track()

None homeassistant.components.xbox.media_player.XboxMediaPlayer.async_media_previous_track

(

self

)

Send previous track command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 190 of file media_player.py.

async_mute_volume()

None homeassistant.components.xbox.media_player.XboxMediaPlayer.async_mute_volume	(		self,
		bool	mute
	)

Mute the volume.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 167 of file media_player.py.

async_play_media()

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

Launch an app on the Xbox.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 208 of file media_player.py.

async_turn_off()

None homeassistant.components.xbox.media_player.XboxMediaPlayer.async_turn_off

(

self

)

Turn the media player off.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 163 of file media_player.py.

async_turn_on()

None homeassistant.components.xbox.media_player.XboxMediaPlayer.async_turn_on

(

self

)

Turn the media player on.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 159 of file media_player.py.

async_volume_down()

None homeassistant.components.xbox.media_player.XboxMediaPlayer.async_volume_down

(

self

)

Turn volume down for media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 178 of file media_player.py.

async_volume_up()

None homeassistant.components.xbox.media_player.XboxMediaPlayer.async_volume_up

(

self

)

Turn volume up for media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 174 of file media_player.py.

data()

ConsoleData homeassistant.components.xbox.media_player.XboxMediaPlayer.data

(

self

)

Return coordinator data for this console.

Definition at line 98 of file media_player.py.

device_info()

DeviceInfo homeassistant.components.xbox.media_player.XboxMediaPlayer.device_info

(

self

)

Return a device description for device registry.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 220 of file media_player.py.

media_content_type()

def homeassistant.components.xbox.media_player.XboxMediaPlayer.media_content_type

(

self

)

Media content type.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 122 of file media_player.py.

media_image_remotely_accessible()

bool homeassistant.components.xbox.media_player.XboxMediaPlayer.media_image_remotely_accessible

(

self

)

If the image url is remotely accessible.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 155 of file media_player.py.

media_image_url()

def homeassistant.components.xbox.media_player.XboxMediaPlayer.media_image_url

(

self

)

Image url of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 140 of file media_player.py.

media_title()

def homeassistant.components.xbox.media_player.XboxMediaPlayer.media_title

(

self

)

Title of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 130 of file media_player.py.

name()

def homeassistant.components.xbox.media_player.XboxMediaPlayer.name

(

self

)

Return the device name.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 88 of file media_player.py.

state()

MediaPlayerState | None homeassistant.components.xbox.media_player.XboxMediaPlayer.state

(

self

)

State of the player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 103 of file media_player.py.

supported_features()

MediaPlayerEntityFeature homeassistant.components.xbox.media_player.XboxMediaPlayer.supported_features

(

self

)

Flag media player features that are supported.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 111 of file media_player.py.

unique_id()

def homeassistant.components.xbox.media_player.XboxMediaPlayer.unique_id

(

self

)

Console device ID.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 93 of file media_player.py.

---

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

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