homeassistant.components.emby.media_player.EmbyDevice Class Reference

Inheritance diagram for homeassistant.components.emby.media_player.EmbyDevice:

Collaboration diagram for homeassistant.components.emby.media_player.EmbyDevice:

Public Member Functions
def	__init__ (self, emby, device_id)
def	app_name (self)
None	async_added_to_hass (self)
None	async_media_next_track (self)
None	async_media_pause (self)
None	async_media_play (self)
None	async_media_previous_track (self)
None	async_media_seek (self, float position)
None	async_media_stop (self)
def	async_update_callback (self, msg)
def	media_album_artist (self)
def	media_album_name (self)
def	media_artist (self)
def	media_content_id (self)
MediaType|str|None	media_content_type (self)
def	media_duration (self)
def	media_episode (self)
def	media_image_url (self)
def	media_position (self)
def	media_position_updated_at (self)
def	media_season (self)
def	media_series_title (self)
def	media_title (self)
def	name (self)
None	set_available (self, bool value)
MediaPlayerState|None	state (self)
MediaPlayerEntityFeature	supported_features (self)
def	supports_remote_control (self)
Public Member Functions inherited from homeassistant.components.media_player.MediaPlayerEntity
str	access_token (self)
str|None	app_id (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_mute_volume (self, bool mute)
None	async_play_media (self, MediaType|str media_type, str media_id, **Any kwargs)
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)
None	media_next_track (self)
None	media_pause (self)
None	media_play (self)
str|None	media_playlist (self)
None	media_previous_track (self)
None	media_seek (self, float position)
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_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)
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)
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
	device
	device_id
	emby
	media_status_last_position
	media_status_received
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 Attributes
	_attr_available
	_attr_unique_id

Static Private Attributes
bool	_attr_should_poll = 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 an Emby device.

Definition at line 133 of file media_player.py.

Constructor & Destructor Documentation

__init__()

def homeassistant.components.emby.media_player.EmbyDevice.__init__	(		self,
			emby,
			device_id
	)

Initialize the Emby device.

Definition at line 138 of file media_player.py.

Member Function Documentation

app_name()

def homeassistant.components.emby.media_player.EmbyDevice.app_name

(

self

)

Return current user as app_name.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 198 of file media_player.py.

async_added_to_hass()

None homeassistant.components.emby.media_player.EmbyDevice.async_added_to_hass

(

self

)

Register callback.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 150 of file media_player.py.

async_media_next_track()

None homeassistant.components.emby.media_player.EmbyDevice.async_media_next_track

(

self

)

Send next track command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 305 of file media_player.py.

async_media_pause()

None homeassistant.components.emby.media_player.EmbyDevice.async_media_pause

(

self

)

Pause the media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 297 of file media_player.py.

async_media_play()

None homeassistant.components.emby.media_player.EmbyDevice.async_media_play

(

self

)

Play media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 293 of file media_player.py.

async_media_previous_track()

None homeassistant.components.emby.media_player.EmbyDevice.async_media_previous_track

(

self

)

Send next track command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 309 of file media_player.py.

async_media_seek()

None homeassistant.components.emby.media_player.EmbyDevice.async_media_seek	(		self,
		float	position
	)

Send seek command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 313 of file media_player.py.

async_media_stop()

None homeassistant.components.emby.media_player.EmbyDevice.async_media_stop

(

self

)

Stop the media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 301 of file media_player.py.

async_update_callback()

def homeassistant.components.emby.media_player.EmbyDevice.async_update_callback	(		self,
			msg
	)

Handle device updates.

Definition at line 155 of file media_player.py.

media_album_artist()

def homeassistant.components.emby.media_player.EmbyDevice.media_album_artist

(

self

)

Return the album artist of current playing media (Music only).

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 282 of file media_player.py.

media_album_name()

def homeassistant.components.emby.media_player.EmbyDevice.media_album_name

(

self

)

Return the album name of current playing media (Music only).

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 272 of file media_player.py.

media_artist()

def homeassistant.components.emby.media_player.EmbyDevice.media_artist

(

self

)

Return the artist of current playing media (Music track only).

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 277 of file media_player.py.

media_content_id()

def homeassistant.components.emby.media_player.EmbyDevice.media_content_id

(

self

)

Content ID of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 204 of file media_player.py.

media_content_type()

MediaType | str | None homeassistant.components.emby.media_player.EmbyDevice.media_content_type

(

self

)

Content type of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 209 of file media_player.py.

media_duration()

def homeassistant.components.emby.media_player.EmbyDevice.media_duration

(

self

)

Return the duration of current playing media in seconds.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 229 of file media_player.py.

media_episode()

def homeassistant.components.emby.media_player.EmbyDevice.media_episode

(

self

)

Return the episode of current playing media (TV only).

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 267 of file media_player.py.

media_image_url()

def homeassistant.components.emby.media_player.EmbyDevice.media_image_url

(

self

)

Return the image URL of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 247 of file media_player.py.

media_position()

def homeassistant.components.emby.media_player.EmbyDevice.media_position

(

self

)

Return the position of current playing media in seconds.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 234 of file media_player.py.

media_position_updated_at()

def homeassistant.components.emby.media_player.EmbyDevice.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 239 of file media_player.py.

media_season()

def homeassistant.components.emby.media_player.EmbyDevice.media_season

(

self

)

Season of current playing media (TV Show only).

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 257 of file media_player.py.

media_series_title()

def homeassistant.components.emby.media_player.EmbyDevice.media_series_title

(

self

)

Return the title of the series of current playing media (TV).

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 262 of file media_player.py.

media_title()

def homeassistant.components.emby.media_player.EmbyDevice.media_title

(

self

)

Return the title of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 252 of file media_player.py.

name()

def homeassistant.components.emby.media_player.EmbyDevice.name

(

self

)

Return the name of the device.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 179 of file media_player.py.

set_available()

None homeassistant.components.emby.media_player.EmbyDevice.set_available	(		self,
		bool	value
	)

Set available property.

Definition at line 169 of file media_player.py.

state()

MediaPlayerState | None homeassistant.components.emby.media_player.EmbyDevice.state

(

self

)

Return the state of the device.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 184 of file media_player.py.

supported_features()

MediaPlayerEntityFeature homeassistant.components.emby.media_player.EmbyDevice.supported_features

(

self

)

Flag media player features that are supported.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 287 of file media_player.py.

supports_remote_control()

def homeassistant.components.emby.media_player.EmbyDevice.supports_remote_control

(

self

)

Return control ability.

Definition at line 174 of file media_player.py.

Member Data Documentation

_attr_available

homeassistant.components.emby.media_player.EmbyDevice._attr_available

private

Definition at line 171 of file media_player.py.

_attr_should_poll

bool homeassistant.components.emby.media_player.EmbyDevice._attr_should_poll = False

staticprivate

Definition at line 136 of file media_player.py.

_attr_unique_id

homeassistant.components.emby.media_player.EmbyDevice._attr_unique_id

private

Definition at line 148 of file media_player.py.

device

homeassistant.components.emby.media_player.EmbyDevice.device

Definition at line 143 of file media_player.py.

device_id

homeassistant.components.emby.media_player.EmbyDevice.device_id

Definition at line 142 of file media_player.py.

emby

homeassistant.components.emby.media_player.EmbyDevice.emby

Definition at line 141 of file media_player.py.

media_status_last_position

homeassistant.components.emby.media_player.EmbyDevice.media_status_last_position

Definition at line 145 of file media_player.py.

media_status_received

homeassistant.components.emby.media_player.EmbyDevice.media_status_received

Definition at line 146 of file media_player.py.

---

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

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