Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.vizio.media_player.VizioDevice Class Reference
Inheritance diagram for homeassistant.components.vizio.media_player.VizioDevice:
[legend]
Collaboration diagram for homeassistant.components.vizio.media_player.VizioDevice:
[legend]

Public Member Functions

None __init__ (self, ConfigEntry config_entry, VizioAsync device, str name, MediaPlayerDeviceClass device_class, VizioAppsDataUpdateCoordinator|None apps_coordinator)
 
def app_id (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_mute_volume (self, bool mute)
 
None async_select_sound_mode (self, str sound_mode)
 
None async_select_source (self, str source)
 
None async_set_volume_level (self, float volume)
 
None async_turn_off (self)
 
None async_turn_on (self)
 
None async_update (self)
 
None async_update_setting (self, str setting_type, str setting_name, int|str new_value)
 
None async_volume_down (self)
 
None async_volume_up (self)
 
str|None source (self)
 
list[strsource_list (self)
 
- Public Member Functions inherited from homeassistant.components.media_player.MediaPlayerEntity
str access_token (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|Noneasync_get_browse_image (self, str media_content_type, str media_content_id, str|None media_image_id=None)
 
tuple[bytes|None, str|Noneasync_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_play_media (self, MediaType|str media_type, str media_id, **Any kwargs)
 
None async_set_repeat (self, RepeatMode repeat)
 
None async_set_shuffle (self, bool shuffle)
 
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)
 
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)
 
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)
 
str|None media_title (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)
 
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 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)
 
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, strtranslation_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

 source
 
- 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

list[str_apps_list (self, list[str] apps)
 
None _async_update_options (self, ConfigEntry config_entry)
 
list[str_get_additional_app_names (self)
 

Static Private Member Functions

None _async_send_update_options_signal (HomeAssistant hass, ConfigEntry config_entry)
 

Private Attributes

 _additional_app_configs
 
 _all_apps
 
 _apps_coordinator
 
 _attr_app_name
 
 _attr_assumed_state
 
 _attr_available
 
 _attr_device_class
 
 _attr_device_info
 
 _attr_is_volume_muted
 
 _attr_sound_mode
 
 _attr_sound_mode_list
 
 _attr_state
 
 _attr_supported_features
 
 _attr_unique_id
 
 _attr_volume_level
 
 _available_apps
 
 _available_inputs
 
 _conf_apps
 
 _config_entry
 
 _current_app_config
 
 _current_input
 
 _device
 
 _max_volume
 
 _received_device_info
 
 _volume_step
 

Static Private Attributes

bool _attr_has_entity_name = True
 
 _attr_name = None
 
bool _received_device_info = 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

Media Player implementation which performs REST requests to device.

Definition at line 131 of file media_player.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.vizio.media_player.VizioDevice.__init__ (   self,
ConfigEntry  config_entry,
VizioAsync  device,
str  name,
MediaPlayerDeviceClass  device_class,
VizioAppsDataUpdateCoordinator | None  apps_coordinator 
)
Initialize Vizio device.

Definition at line 138 of file media_player.py.

Member Function Documentation

◆ _apps_list()

list[str] homeassistant.components.vizio.media_player.VizioDevice._apps_list (   self,
list[str apps 
)
private
Return process apps list based on configured filters.

Definition at line 180 of file media_player.py.

◆ _async_send_update_options_signal()

None homeassistant.components.vizio.media_player.VizioDevice._async_send_update_options_signal ( HomeAssistant  hass,
ConfigEntry   config_entry 
)
staticprivate
Send update event when Vizio config entry is updated.

Definition at line 304 of file media_player.py.

◆ _async_update_options()

None homeassistant.components.vizio.media_player.VizioDevice._async_update_options (   self,
ConfigEntry  config_entry 
)
private
Update options if the update signal comes from this entity.

Definition at line 313 of file media_player.py.

◆ _get_additional_app_names()

list[str] homeassistant.components.vizio.media_player.VizioDevice._get_additional_app_names (   self)
private
Return list of additional apps that were included in configuration.yaml.

Definition at line 297 of file media_player.py.

◆ app_id()

def homeassistant.components.vizio.media_player.VizioDevice.app_id (   self)
Return the ID of the current app if it is unknown by pyvizio.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 393 of file media_player.py.

◆ async_added_to_hass()

None homeassistant.components.vizio.media_player.VizioDevice.async_added_to_hass (   self)
Register callbacks when entity is added.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 330 of file media_player.py.

◆ async_media_next_track()

None homeassistant.components.vizio.media_player.VizioDevice.async_media_next_track (   self)
Send next channel command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 435 of file media_player.py.

◆ async_media_pause()

None homeassistant.components.vizio.media_player.VizioDevice.async_media_pause (   self)
Pause whatever media is currently active.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 492 of file media_player.py.

◆ async_media_play()

None homeassistant.components.vizio.media_player.VizioDevice.async_media_play (   self)
Play whatever media is currently active.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 488 of file media_player.py.

◆ async_media_previous_track()

None homeassistant.components.vizio.media_player.VizioDevice.async_media_previous_track (   self)
Send previous channel command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 431 of file media_player.py.

◆ async_mute_volume()

None homeassistant.components.vizio.media_player.VizioDevice.async_mute_volume (   self,
bool  mute 
)
Mute the volume.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 422 of file media_player.py.

◆ async_select_sound_mode()

None homeassistant.components.vizio.media_player.VizioDevice.async_select_sound_mode (   self,
str  sound_mode 
)
Select sound mode.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 404 of file media_player.py.

◆ async_select_source()

None homeassistant.components.vizio.media_player.VizioDevice.async_select_source (   self,
str  source 
)
Select input source.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 439 of file media_player.py.

◆ async_set_volume_level()

None homeassistant.components.vizio.media_player.VizioDevice.async_set_volume_level (   self,
float  volume 
)
Set volume level.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 475 of file media_player.py.

◆ async_turn_off()

None homeassistant.components.vizio.media_player.VizioDevice.async_turn_off (   self)
Turn the device off.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 418 of file media_player.py.

◆ async_turn_on()

None homeassistant.components.vizio.media_player.VizioDevice.async_turn_on (   self)
Turn the device on.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 414 of file media_player.py.

◆ async_update()

None homeassistant.components.vizio.media_player.VizioDevice.async_update (   self)
Retrieve latest state of the device.

Definition at line 190 of file media_player.py.

◆ async_update_setting()

None homeassistant.components.vizio.media_player.VizioDevice.async_update_setting (   self,
str  setting_type,
str  setting_name,
int | str   new_value 
)
Update a setting when update_setting service is called.

Definition at line 319 of file media_player.py.

◆ async_volume_down()

None homeassistant.components.vizio.media_player.VizioDevice.async_volume_down (   self)
Decrease volume of the device.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 466 of file media_player.py.

◆ async_volume_up()

None homeassistant.components.vizio.media_player.VizioDevice.async_volume_up (   self)
Increase volume of the device.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 457 of file media_player.py.

◆ source()

str | None homeassistant.components.vizio.media_player.VizioDevice.source (   self)
Return current input of the device.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 363 of file media_player.py.

◆ source_list()

list[str] homeassistant.components.vizio.media_player.VizioDevice.source_list (   self)
Return list of available inputs of the device.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 371 of file media_player.py.

Member Data Documentation

◆ _additional_app_configs

homeassistant.components.vizio.media_player.VizioDevice._additional_app_configs
private

Definition at line 157 of file media_player.py.

◆ _all_apps

homeassistant.components.vizio.media_player.VizioDevice._all_apps
private

Definition at line 155 of file media_player.py.

◆ _apps_coordinator

homeassistant.components.vizio.media_player.VizioDevice._apps_coordinator
private

Definition at line 148 of file media_player.py.

◆ _attr_app_name

homeassistant.components.vizio.media_player.VizioDevice._attr_app_name
private

Definition at line 227 of file media_player.py.

◆ _attr_assumed_state

homeassistant.components.vizio.media_player.VizioDevice._attr_assumed_state
private

Definition at line 162 of file media_player.py.

◆ _attr_available

homeassistant.components.vizio.media_player.VizioDevice._attr_available
private

Definition at line 199 of file media_player.py.

◆ _attr_device_class

homeassistant.components.vizio.media_player.VizioDevice._attr_device_class
private

Definition at line 173 of file media_player.py.

◆ _attr_device_info

homeassistant.components.vizio.media_player.VizioDevice._attr_device_info
private

Definition at line 174 of file media_player.py.

◆ _attr_has_entity_name

bool homeassistant.components.vizio.media_player.VizioDevice._attr_has_entity_name = True
staticprivate

Definition at line 134 of file media_player.py.

◆ _attr_is_volume_muted

homeassistant.components.vizio.media_player.VizioDevice._attr_is_volume_muted
private

Definition at line 225 of file media_player.py.

◆ _attr_name

homeassistant.components.vizio.media_player.VizioDevice._attr_name = None
staticprivate

Definition at line 135 of file media_player.py.

◆ _attr_sound_mode

homeassistant.components.vizio.media_player.VizioDevice._attr_sound_mode
private

Definition at line 229 of file media_player.py.

◆ _attr_sound_mode_list

homeassistant.components.vizio.media_player.VizioDevice._attr_sound_mode_list
private

Definition at line 166 of file media_player.py.

◆ _attr_state

homeassistant.components.vizio.media_player.VizioDevice._attr_state
private

Definition at line 223 of file media_player.py.

◆ _attr_supported_features

homeassistant.components.vizio.media_player.VizioDevice._attr_supported_features
private

Definition at line 167 of file media_player.py.

◆ _attr_unique_id

homeassistant.components.vizio.media_player.VizioDevice._attr_unique_id
private

Definition at line 172 of file media_player.py.

◆ _attr_volume_level

homeassistant.components.vizio.media_player.VizioDevice._attr_volume_level
private

Definition at line 224 of file media_player.py.

◆ _available_apps

homeassistant.components.vizio.media_player.VizioDevice._available_apps
private

Definition at line 281 of file media_player.py.

◆ _available_inputs

homeassistant.components.vizio.media_player.VizioDevice._available_inputs
private

Definition at line 271 of file media_player.py.

◆ _conf_apps

homeassistant.components.vizio.media_player.VizioDevice._conf_apps
private

Definition at line 156 of file media_player.py.

◆ _config_entry

homeassistant.components.vizio.media_player.VizioDevice._config_entry
private

Definition at line 147 of file media_player.py.

◆ _current_app_config

homeassistant.components.vizio.media_player.VizioDevice._current_app_config
private

Definition at line 228 of file media_player.py.

◆ _current_input

homeassistant.components.vizio.media_player.VizioDevice._current_input
private

Definition at line 226 of file media_player.py.

◆ _device

homeassistant.components.vizio.media_player.VizioDevice._device
private

Definition at line 160 of file media_player.py.

◆ _max_volume

homeassistant.components.vizio.media_player.VizioDevice._max_volume
private

Definition at line 161 of file media_player.py.

◆ _received_device_info [1/2]

bool homeassistant.components.vizio.media_player.VizioDevice._received_device_info = False
staticprivate

Definition at line 136 of file media_player.py.

◆ _received_device_info [2/2]

homeassistant.components.vizio.media_player.VizioDevice._received_device_info
private

Definition at line 220 of file media_player.py.

◆ _volume_step

homeassistant.components.vizio.media_player.VizioDevice._volume_step
private

Definition at line 150 of file media_player.py.

◆ source

homeassistant.components.vizio.media_player.VizioDevice.source

Definition at line 395 of file media_player.py.


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