Skip to content

Rename MediaPlayerDevice to MediaPlayerEntity #479

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MartinHjelmare merged 4 commits into from
Apr 26, 2020
Merged

Rename MediaPlayerDevice to MediaPlayerEntity #479

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d458e5e
Rename MediaPlayerDevice to MediaPlayerEntity
emontnemery Apr 25, 2020
7778503
Add link to base class
emontnemery Apr 25, 2020
874e12e
Wording
MartinHjelmare Apr 25, 2020
99ca0d7
Update entity_media_player.md
emontnemery Apr 26, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/entity_media_player.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_label: Media Player
:::info Incomplete
This entry is incomplete. Contribution welcome.
:::
A media player entity controls a media player. Derive a platform entity from [`homeassistant.components.media_player.MediaPlayerEntity`](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/media_player/__init__.py).

## Properties

Expand All @@ -27,7 +28,7 @@ Properties should always only return information from memory and not do I/O (lik
### Select sound mode
Optional. Switch the sound mode of the media player.

class MyMediaPlayer(MediaPlayerDevice):
class MyMediaPlayer(MediaPlayerEntity):
# Implement one of these methods.

def select_sound_mode(self, sound_mode):
Expand All @@ -39,7 +40,7 @@ Optional. Switch the sound mode of the media player.
### Select source
Optional. Switch the selected input source for the media player.

class MyMediaPlayer(MediaPlayerDevice):
class MyMediaPlayer(MediaPlayerEntity):
# Implement one of these methods.

def select_source(self, source):
Expand All @@ -65,7 +66,7 @@ Required. Returns one of the defined constants from the below list that matches
|MEDIA_TYPE_GAME|
|MEDIA_TYPE_APP|

class MyMediaPlayer(MediaPlayerDevice):
class MyMediaPlayer(MediaPlayerEntity):
# Implement the following method.

@property
Expand Down