Inheritance diagram for homeassistant.components.roku.media_player.RokuMediaPlayer:

Collaboration diagram for homeassistant.components.roku.media_player.RokuMediaPlayer:

Public Member Functions
None	__init__ (self, RokuDataUpdateCoordinator coordinator)

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)

tuple[bytes\|None, str\|None]	async_get_browse_image (self, MediaType\|str media_content_type, str media_content_id, str\|None media_image_id=None)

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_mute_volume (self, bool mute)

None	async_play_media (self, MediaType\|str media_type, str media_id, **Any kwargs)

None	async_select_source (self, str source)

None	async_turn_off (self)

None	async_turn_on (self)

None	async_volume_down (self)

None	async_volume_up (self)

str\|None	media_channel (self)

MediaType\|None	media_content_type (self)

int\|None	media_duration (self)

str\|None	media_image_url (self)

int\|None	media_position (self)

dt.datetime\|None	media_position_updated_at (self)

str\|None	media_title (self)

None	search (self, str keyword)

str\|None	source (self)

list[str]	source_list (self)

MediaPlayerState\|None	state (self)

Public Member Functions inherited from homeassistant.components.roku.entity.RokuEntity
None	__init__ (self, *RokuDataUpdateCoordinator coordinator, EntityDescription\|None description=None)

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.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_seek (self, float position)

None	async_media_stop (self)

None	async_select_sound_mode (self, str sound_mode)

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_content_id (self)

str\|None	media_episode (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)

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)

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)

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

Public Attributes inherited from homeassistant.components.roku.entity.RokuEntity
	entity_description

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
bool	_media_playback_trackable (self)

Private Attributes
	_attr_device_class

Static Private Attributes
	_attr_name = None

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 Roku media player on the network.

Definition at line 109 of file media_player.py.

Constructor & Destructor Documentation

◆ init()

None homeassistant.components.roku.media_player.RokuMediaPlayer.__init__	(		self,
		RokuDataUpdateCoordinator	coordinator
	)

Initialize the Roku device.

Definition at line 127 of file media_player.py.

Member Function Documentation

◆ _media_playback_trackable()

bool homeassistant.components.roku.media_player.RokuMediaPlayer._media_playback_trackable ( self )

private

Detect if we have enough media data to track playback.

Definition at line 135 of file media_player.py.

◆ app_id()

str | None homeassistant.components.roku.media_player.RokuMediaPlayer.app_id ( self )

Return the ID of the current running app.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 195 of file media_player.py.

◆ app_name()

str | None homeassistant.components.roku.media_player.RokuMediaPlayer.app_name ( self )

Name of the current running app.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 187 of file media_player.py.

◆ async_browse_media()

BrowseMedia homeassistant.components.roku.media_player.RokuMediaPlayer.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 283 of file media_player.py.

◆ async_get_browse_image()

tuple[bytes \| None, str \| None] homeassistant.components.roku.media_player.RokuMediaPlayer.async_get_browse_image	(		self,
		MediaType \| str	media_content_type,
		str	media_content_id,
		str \| None	media_image_id = `None`
	)

Fetch media browser image to serve via proxy.

Definition at line 270 of file media_player.py.

◆ async_media_next_track()

None homeassistant.components.roku.media_player.RokuMediaPlayer.async_media_next_track ( self )

Send next track command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 337 of file media_player.py.

◆ async_media_pause()

None homeassistant.components.roku.media_player.RokuMediaPlayer.async_media_pause ( self )

Send pause command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 310 of file media_player.py.

◆ async_media_play()

None homeassistant.components.roku.media_player.RokuMediaPlayer.async_media_play ( self )

Send play command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 317 of file media_player.py.

◆ async_media_play_pause()

None homeassistant.components.roku.media_player.RokuMediaPlayer.async_media_play_pause ( self )

Send play/pause command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 324 of file media_player.py.

◆ async_media_previous_track()

None homeassistant.components.roku.media_player.RokuMediaPlayer.async_media_previous_track ( self )

Send previous track command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 331 of file media_player.py.

◆ async_mute_volume()

None homeassistant.components.roku.media_player.RokuMediaPlayer.async_mute_volume	(		self,
		bool	mute
	)

Mute the volume.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 343 of file media_player.py.

◆ async_play_media()

None homeassistant.components.roku.media_player.RokuMediaPlayer.async_play_media	(		self,
		MediaType \| str	media_type,
		str	media_id,
		**Any	kwargs
	)

Play media from a URL or file, launch an application, or tune to a channel.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 359 of file media_player.py.

◆ async_select_source()

None homeassistant.components.roku.media_player.RokuMediaPlayer.async_select_source	(		self,
		str	source
	)

Select input source.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 474 of file media_player.py.

◆ async_turn_off()

None homeassistant.components.roku.media_player.RokuMediaPlayer.async_turn_off ( self )

Turn off the Roku.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 304 of file media_player.py.

◆ async_turn_on()

None homeassistant.components.roku.media_player.RokuMediaPlayer.async_turn_on ( self )

Turn on the Roku.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 298 of file media_player.py.

◆ async_volume_down()

None homeassistant.components.roku.media_player.RokuMediaPlayer.async_volume_down ( self )

Volume down media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 354 of file media_player.py.

◆ async_volume_up()

None homeassistant.components.roku.media_player.RokuMediaPlayer.async_volume_up ( self )

Volume up media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 349 of file media_player.py.

◆ media_channel()

str | None homeassistant.components.roku.media_player.RokuMediaPlayer.media_channel ( self )

Return the TV channel currently tuned.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 203 of file media_player.py.

◆ media_content_type()

MediaType | None homeassistant.components.roku.media_player.RokuMediaPlayer.media_content_type ( self )

Content type of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 168 of file media_player.py.

◆ media_duration()

int | None homeassistant.components.roku.media_player.RokuMediaPlayer.media_duration ( self )

Duration of current playing media in seconds.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 224 of file media_player.py.

◆ media_image_url()

str | None homeassistant.components.roku.media_player.RokuMediaPlayer.media_image_url ( self )

Image url of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 179 of file media_player.py.

◆ media_position()

int | None homeassistant.components.roku.media_player.RokuMediaPlayer.media_position ( self )

Position of current playing media in seconds.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 232 of file media_player.py.

◆ media_position_updated_at()

dt.datetime | None homeassistant.components.roku.media_player.RokuMediaPlayer.media_position_updated_at ( self )

When was the position of the current playing media valid.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 240 of file media_player.py.

◆ media_title()

str | None homeassistant.components.roku.media_player.RokuMediaPlayer.media_title ( self )

Return the title of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 213 of file media_player.py.

◆ search()

None homeassistant.components.roku.media_player.RokuMediaPlayer.search	(		self,
		str	keyword
	)

Emulate opening the search screen and entering the search keyword.

Definition at line 266 of file media_player.py.

◆ source()

str | None homeassistant.components.roku.media_player.RokuMediaPlayer.source ( self )

Return the current input source.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 248 of file media_player.py.

◆ source_list()

list[str] homeassistant.components.roku.media_player.RokuMediaPlayer.source_list ( self )

List of available input sources.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 256 of file media_player.py.

◆ state()

MediaPlayerState | None homeassistant.components.roku.media_player.RokuMediaPlayer.state ( self )

Return the state of the device.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 143 of file media_player.py.

Member Data Documentation

◆ _attr_device_class

homeassistant.components.roku.media_player.RokuMediaPlayer._attr_device_class

private

Definition at line 131 of file media_player.py.

◆ _attr_name

homeassistant.components.roku.media_player.RokuMediaPlayer._attr_name = None

staticprivate

Definition at line 112 of file media_player.py.

◆ _attr_supported_features

tuple homeassistant.components.roku.media_player.RokuMediaPlayer._attr_supported_features

staticprivate

Initial value:

=  (
        MediaPlayerEntityFeature.PREVIOUS_TRACK
        | MediaPlayerEntityFeature.NEXT_TRACK
        | MediaPlayerEntityFeature.VOLUME_STEP
        | MediaPlayerEntityFeature.VOLUME_MUTE
        | MediaPlayerEntityFeature.SELECT_SOURCE
        | MediaPlayerEntityFeature.PAUSE
        | MediaPlayerEntityFeature.PLAY
        | MediaPlayerEntityFeature.PLAY_MEDIA
        | MediaPlayerEntityFeature.TURN_ON
        | MediaPlayerEntityFeature.TURN_OFF
        | MediaPlayerEntityFeature.BROWSE_MEDIA
    )

Definition at line 113 of file media_player.py.

◆ app_id

homeassistant.components.roku.media_player.RokuMediaPlayer.app_id

Definition at line 173 of file media_player.py.

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

core/homeassistant/components/roku/media_player.py

Home Assistant Unofficial Reference 2024.12.1

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _media_playback_trackable()

◆ app_id()

◆ app_name()

◆ async_browse_media()

◆ async_get_browse_image()

◆ async_media_next_track()

◆ async_media_pause()

◆ async_media_play()

◆ async_media_play_pause()

◆ async_media_previous_track()

◆ async_mute_volume()

◆ async_play_media()

◆ async_select_source()

◆ async_turn_off()

◆ async_turn_on()

◆ async_volume_down()

◆ async_volume_up()

◆ media_channel()

◆ media_content_type()

◆ media_duration()

◆ media_image_url()

◆ media_position()

◆ media_position_updated_at()

◆ media_title()

◆ search()

◆ source()

◆ source_list()

◆ state()

Member Data Documentation

◆ _attr_device_class

◆ _attr_name

◆ _attr_supported_features

◆ app_id

◆ init()