homeassistant.components.pandora.media_player.PandoraMediaPlayer Class Reference

Inheritance diagram for homeassistant.components.pandora.media_player.PandoraMediaPlayer:

Collaboration diagram for homeassistant.components.pandora.media_player.PandoraMediaPlayer:

Public Member Functions
def	__init__ (self, name)
None	media_next_track (self)
None	media_pause (self)
None	media_play (self)
str|None	media_title (self)
None	select_source (self, str source)
None	turn_off (self)
None	turn_on (self)
def	update_playing_status (self)
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_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_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_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)
MediaType|str|None	media_content_type (self)
int|None	media_duration (self)
str|None	media_episode (self)
str|None	media_image_hash (self)
str|None	media_image_local (self)
bool	media_image_remotely_accessible (self)
str|None	media_image_url (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	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)
MediaPlayerState|None	state (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 (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_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)
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
	state
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	_clear_buffer (self)
def	_log_match (self)
def	_query_for_playing_status (self)
def	_send_pianobar_command (self, service_cmd)
def	_send_station_list_command (self)
def	_update_current_song (self, response)
def	_update_current_station (self, response)
def	_update_song_position (self)
def	_update_stations (self)

Private Attributes
	_attr_media_album_name
	_attr_media_artist
	_attr_media_duration
	_attr_media_title
	_attr_name
	_attr_source
	_attr_source_list
	_attr_state
	_pianobar
	_time_remaining

Static Private Attributes
	_attr_media_content_type = MediaType.MUSIC
tuple	_attr_supported_features

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

A media player that uses the Pianobar interface to Pandora.

Definition at line 68 of file media_player.py.

Constructor & Destructor Documentation

__init__()

def homeassistant.components.pandora.media_player.PandoraMediaPlayer.__init__	(		self,
			name
	)

Initialize the Pandora device.

Definition at line 83 of file media_player.py.

Member Function Documentation

_clear_buffer()

def homeassistant.components.pandora.media_player.PandoraMediaPlayer._clear_buffer (   self )

private

Clear buffer from pexpect.

This is necessary because there are a bunch of 00:00 in the buffer

Definition at line 312 of file media_player.py.

_log_match()

def homeassistant.components.pandora.media_player.PandoraMediaPlayer._log_match (   self )

private

Log grabbed values from console.

Definition at line 278 of file media_player.py.

_query_for_playing_status()

def homeassistant.components.pandora.media_player.PandoraMediaPlayer._query_for_playing_status (   self )

private

Query system for info about current track.

Definition at line 201 of file media_player.py.

_send_pianobar_command()

def homeassistant.components.pandora.media_player.PandoraMediaPlayer._send_pianobar_command (   self,   service_cmd  )

private

Send a command to Pianobar.

Definition at line 287 of file media_player.py.

_send_station_list_command()

def homeassistant.components.pandora.media_player.PandoraMediaPlayer._send_station_list_command (   self )

private

Send a station list command.

Definition at line 181 of file media_player.py.

_update_current_song()

def homeassistant.components.pandora.media_player.PandoraMediaPlayer._update_current_song (   self,   response  )

private

Update info about current song.

Definition at line 243 of file media_player.py.

_update_current_station()

def homeassistant.components.pandora.media_player.PandoraMediaPlayer._update_current_station (   self,   response  )

private

Update current station.

Definition at line 235 of file media_player.py.

_update_song_position()

def homeassistant.components.pandora.media_player.PandoraMediaPlayer._update_song_position (   self )

private

Get the song position and duration.

It's hard to predict whether or not the music will start during init
so we have to detect state by checking the ticker.

Definition at line 256 of file media_player.py.

_update_stations()

def homeassistant.components.pandora.media_player.PandoraMediaPlayer._update_stations (   self )

private

List defined Pandora stations.

Definition at line 296 of file media_player.py.

media_next_track()

None homeassistant.components.pandora.media_player.PandoraMediaPlayer.media_next_track

(

self

)

Go to next track.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 155 of file media_player.py.

media_pause()

None homeassistant.components.pandora.media_player.PandoraMediaPlayer.media_pause

(

self

)

Send pause command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 149 of file media_player.py.

media_play()

None homeassistant.components.pandora.media_player.PandoraMediaPlayer.media_play

(

self

)

Send play command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 143 of file media_player.py.

media_title()

str | None homeassistant.components.pandora.media_player.PandoraMediaPlayer.media_title

(

self

)

Title of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 161 of file media_player.py.

select_source()

None homeassistant.components.pandora.media_player.PandoraMediaPlayer.select_source	(		self,
		str	source
	)

Choose a different Pandora station and play it.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 166 of file media_player.py.

turn_off()

None homeassistant.components.pandora.media_player.PandoraMediaPlayer.turn_off

(

self

)

Turn the media player off.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 126 of file media_player.py.

turn_on()

None homeassistant.components.pandora.media_player.PandoraMediaPlayer.turn_on

(

self

)

Turn the media player on.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 96 of file media_player.py.

update_playing_status()

def homeassistant.components.pandora.media_player.PandoraMediaPlayer.update_playing_status

(

self

)

Query pianobar for info about current media_title, station.

Definition at line 192 of file media_player.py.

Member Data Documentation

_attr_media_album_name

homeassistant.components.pandora.media_player.PandoraMediaPlayer._attr_media_album_name

private

Definition at line 90 of file media_player.py.

_attr_media_artist

homeassistant.components.pandora.media_player.PandoraMediaPlayer._attr_media_artist

private

Definition at line 89 of file media_player.py.

_attr_media_content_type

homeassistant.components.pandora.media_player.PandoraMediaPlayer._attr_media_content_type = MediaType.MUSIC

staticprivate

Definition at line 71 of file media_player.py.

_attr_media_duration

homeassistant.components.pandora.media_player.PandoraMediaPlayer._attr_media_duration

private

Definition at line 93 of file media_player.py.

_attr_media_title

homeassistant.components.pandora.media_player.PandoraMediaPlayer._attr_media_title

private

Definition at line 88 of file media_player.py.

_attr_name

homeassistant.components.pandora.media_player.PandoraMediaPlayer._attr_name

private

Definition at line 85 of file media_player.py.

_attr_source

homeassistant.components.pandora.media_player.PandoraMediaPlayer._attr_source

private

Definition at line 87 of file media_player.py.

_attr_source_list

homeassistant.components.pandora.media_player.PandoraMediaPlayer._attr_source_list

private

Definition at line 91 of file media_player.py.

_attr_state

homeassistant.components.pandora.media_player.PandoraMediaPlayer._attr_state

private

Definition at line 86 of file media_player.py.

_attr_supported_features

tuple homeassistant.components.pandora.media_player.PandoraMediaPlayer._attr_supported_features

staticprivate

Initial value:

=  (
        MediaPlayerEntityFeature.PAUSE
        | MediaPlayerEntityFeature.TURN_ON
        | MediaPlayerEntityFeature.TURN_OFF
        | MediaPlayerEntityFeature.NEXT_TRACK
        | MediaPlayerEntityFeature.SELECT_SOURCE
        | MediaPlayerEntityFeature.PLAY
    )

Definition at line 74 of file media_player.py.

_pianobar

homeassistant.components.pandora.media_player.PandoraMediaPlayer._pianobar

private

Definition at line 94 of file media_player.py.

_time_remaining

homeassistant.components.pandora.media_player.PandoraMediaPlayer._time_remaining

private

Definition at line 92 of file media_player.py.

state

homeassistant.components.pandora.media_player.PandoraMediaPlayer.state

Definition at line 274 of file media_player.py.

---

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

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