homeassistant.components.channels.media_player.ChannelsPlayer Class Reference

Inheritance diagram for homeassistant.components.channels.media_player.ChannelsPlayer:

Collaboration diagram for homeassistant.components.channels.media_player.ChannelsPlayer:

Public Member Functions
def	__init__ (self, name, host, port)
def	is_volume_muted (self)
def	media_content_id (self)
def	media_image_url (self)
None	media_next_track (self)
None	media_pause (self)
None	media_play (self)
None	media_previous_track (self)
None	media_stop (self)
def	media_title (self)
None	mute_volume (self, bool mute)
def	name (self)
None	play_media (self, MediaType|str media_type, str media_id, **Any kwargs)
def	seek_backward (self)
def	seek_by (self, seconds)
def	seek_forward (self)
None	select_source (self, str source)
def	source_list (self)
MediaPlayerState|None	state (self)
None	update (self)
def	update_favorite_channels (self)
def	update_state (self, state_hash)
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)
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)
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_playlist (self)
int|None	media_position (self)
dt.datetime|None	media_position_updated_at (self)
str|None	media_season (self)
None	media_seek (self, float position)
str|None	media_series_title (self)
int|None	media_track (self)
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)
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	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)
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
	channel_image_url
	channel_name
	channel_number
	client
	favorite_channels
	muted
	now_playing_episode_number
	now_playing_episode_title
	now_playing_image_url
	now_playing_season_number
	now_playing_summary
	now_playing_title
	status
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
	_host
	_name
	_port

Static Private Attributes
	_attr_media_content_type = MediaType.CHANNEL
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

Representation of a Channels instance.

Definition at line 67 of file media_player.py.

Constructor & Destructor Documentation

__init__()

def homeassistant.components.channels.media_player.ChannelsPlayer.__init__	(		self,
			name,
			host,
			port
	)

Initialize the Channels app.

Definition at line 82 of file media_player.py.

Member Function Documentation

is_volume_muted()

def homeassistant.components.channels.media_player.ChannelsPlayer.is_volume_muted

(

self

)

Boolean if volume is currently muted.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 173 of file media_player.py.

media_content_id()

def homeassistant.components.channels.media_player.ChannelsPlayer.media_content_id

(

self

)

Content ID of current playing channel.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 178 of file media_player.py.

media_image_url()

def homeassistant.components.channels.media_player.ChannelsPlayer.media_image_url

(

self

)

Image url of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 183 of file media_player.py.

media_next_track()

None homeassistant.components.channels.media_player.ChannelsPlayer.media_next_track

(

self

)

Seek ahead.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 222 of file media_player.py.

media_pause()

None homeassistant.components.channels.media_player.ChannelsPlayer.media_pause

(

self

)

Send media_pause command to player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 217 of file media_player.py.

media_play()

None homeassistant.components.channels.media_player.ChannelsPlayer.media_play

(

self

)

Send media_play command to player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 212 of file media_player.py.

media_previous_track()

None homeassistant.components.channels.media_player.ChannelsPlayer.media_previous_track

(

self

)

Seek back.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 227 of file media_player.py.

media_stop()

None homeassistant.components.channels.media_player.ChannelsPlayer.media_stop

(

self

)

Send media_stop command to player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 206 of file media_player.py.

media_title()

def homeassistant.components.channels.media_player.ChannelsPlayer.media_title

(

self

)

Title of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 193 of file media_player.py.

mute_volume()

None homeassistant.components.channels.media_player.ChannelsPlayer.mute_volume	(		self,
		bool	mute
	)

Mute (true) or unmute (false) player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 200 of file media_player.py.

name()

def homeassistant.components.channels.media_player.ChannelsPlayer.name

(

self

)

Return the name of the player.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 144 of file media_player.py.

play_media()

None homeassistant.components.channels.media_player.ChannelsPlayer.play_media	(		self,
		MediaType | str	media_type,
		str	media_id,
		**Any	kwargs
	)

Send the play_media command to the player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 240 of file media_player.py.

seek_backward()

def homeassistant.components.channels.media_player.ChannelsPlayer.seek_backward

(

self

)

Seek backward in the timeline.

Definition at line 256 of file media_player.py.

seek_by()

def homeassistant.components.channels.media_player.ChannelsPlayer.seek_by	(		self,
			seconds
	)

Seek backward in the timeline.

Definition at line 261 of file media_player.py.

seek_forward()

def homeassistant.components.channels.media_player.ChannelsPlayer.seek_forward

(

self

)

Seek forward in the timeline.

Definition at line 251 of file media_player.py.

select_source()

None homeassistant.components.channels.media_player.ChannelsPlayer.select_source	(		self,
		str	source
	)

Select a channel to tune to.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 232 of file media_player.py.

source_list()

def homeassistant.components.channels.media_player.ChannelsPlayer.source_list

(

self

)

List of favorite channels.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 168 of file media_player.py.

state()

MediaPlayerState | None homeassistant.components.channels.media_player.ChannelsPlayer.state

(

self

)

Return the state of the player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 149 of file media_player.py.

update()

None homeassistant.components.channels.media_player.ChannelsPlayer.update

(

self

)

Retrieve latest state.

Definition at line 162 of file media_player.py.

update_favorite_channels()

def homeassistant.components.channels.media_player.ChannelsPlayer.update_favorite_channels

(

self

)

Update the favorite channels from the client.

Definition at line 107 of file media_player.py.

update_state()

def homeassistant.components.channels.media_player.ChannelsPlayer.update_state	(		self,
			state_hash
	)

Update all the state properties with the passed in dictionary.

Definition at line 111 of file media_player.py.

Member Data Documentation

_attr_media_content_type

homeassistant.components.channels.media_player.ChannelsPlayer._attr_media_content_type = MediaType.CHANNEL

staticprivate

Definition at line 70 of file media_player.py.

_attr_supported_features

tuple homeassistant.components.channels.media_player.ChannelsPlayer._attr_supported_features

staticprivate

Initial value:

=  (
        MediaPlayerEntityFeature.PLAY
        | MediaPlayerEntityFeature.PAUSE
        | MediaPlayerEntityFeature.STOP
        | MediaPlayerEntityFeature.VOLUME_MUTE
        | MediaPlayerEntityFeature.NEXT_TRACK
        | MediaPlayerEntityFeature.PREVIOUS_TRACK
        | MediaPlayerEntityFeature.PLAY_MEDIA
        | MediaPlayerEntityFeature.SELECT_SOURCE
    )

Definition at line 71 of file media_player.py.

_host

homeassistant.components.channels.media_player.ChannelsPlayer._host

private

Definition at line 86 of file media_player.py.

_name

homeassistant.components.channels.media_player.ChannelsPlayer._name

private

Definition at line 85 of file media_player.py.

_port

homeassistant.components.channels.media_player.ChannelsPlayer._port

private

Definition at line 87 of file media_player.py.

channel_image_url

homeassistant.components.channels.media_player.ChannelsPlayer.channel_image_url

Definition at line 96 of file media_player.py.

channel_name

homeassistant.components.channels.media_player.ChannelsPlayer.channel_name

Definition at line 95 of file media_player.py.

channel_number

homeassistant.components.channels.media_player.ChannelsPlayer.channel_number

Definition at line 94 of file media_player.py.

client

homeassistant.components.channels.media_player.ChannelsPlayer.client

Definition at line 89 of file media_player.py.

favorite_channels

homeassistant.components.channels.media_player.ChannelsPlayer.favorite_channels

Definition at line 105 of file media_player.py.

muted

homeassistant.components.channels.media_player.ChannelsPlayer.muted

Definition at line 92 of file media_player.py.

now_playing_episode_number

homeassistant.components.channels.media_player.ChannelsPlayer.now_playing_episode_number

Definition at line 101 of file media_player.py.

now_playing_episode_title

homeassistant.components.channels.media_player.ChannelsPlayer.now_playing_episode_title

Definition at line 99 of file media_player.py.

now_playing_image_url

homeassistant.components.channels.media_player.ChannelsPlayer.now_playing_image_url

Definition at line 103 of file media_player.py.

now_playing_season_number

homeassistant.components.channels.media_player.ChannelsPlayer.now_playing_season_number

Definition at line 100 of file media_player.py.

now_playing_summary

homeassistant.components.channels.media_player.ChannelsPlayer.now_playing_summary

Definition at line 102 of file media_player.py.

now_playing_title

homeassistant.components.channels.media_player.ChannelsPlayer.now_playing_title

Definition at line 98 of file media_player.py.

status

homeassistant.components.channels.media_player.ChannelsPlayer.status

Definition at line 91 of file media_player.py.

---

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

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