Add media position properties

[pschmitt]

Description:

This adds progress information to media_player.liveboxplaytv.

media_player:
  - platform: liveboxplaytv
    host: 192.168.1.2

[pschmitt]

E:113,34: Module 'pyteleloisirs' has no 'get_program_duration' member (no-member)
E:115,34: Module 'pyteleloisirs' has no 'get_remaining_time' member (no-member)

I don't get why pylint is thinking that these functions are unavailable. They are defined here:

• https://github.com/pschmitt/pyteleloisirs/blob/master/pyteleloisirs/pyteleloisirs.py#L115
• https://github.com/pschmitt/pyteleloisirs/blob/master/pyteleloisirs/pyteleloisirs.py#L129

EDIT: Here is a snippet that essentially does the same as liveboxplaytv. It works and still do not understand why pylint is complaining...

[emlove]

You're using Python 3.5+ async syntax in this lib. All hass code needs to support Python 3.4.

https://github.com/pschmitt/pyteleloisirs/blob/c0820789daa83cd3749b5b64839173bf7e4006e3/pyteleloisirs/pyteleloisirs.py#L49

https://stackoverflow.com/a/30195047

[pschmitt]

Thanks for the hint. What I don't get is why pylint isn't complaining about the liveboxplaytv library. It uses the async syntax as well.
https://github.com/pschmitt/python-liveboxplaytv/blob/master/liveboxplaytv/liveboxplaytv.py#L134

[emlove]

That certainly is strange, but that's what I'd try first.

[pschmitt]

You were right, @armills

[emlove]

A few small notes, but the biggest issue is the remaining time / last updated need to not change on every update.

[emlove]

Looks like a copy-paste artifact got left in here.

[emlove]

Media position and media remaining time need to only change when the player actually changes state. See vlc for an example https://github.com/home-assistant/home-assistant/blob/08b0629eca6417a2bb1b6f3c805ff19208484e4d/homeassistant/components/media_player/vlc.py#L70-L72

[pschmitt]

Okay, but the media duration only depends on the current time. So this is pretty much guaranteed to be updated every time.

[emlove]

We should either expose get_program_duration and get_remaining_time off of liveboxplaytv, or specifically call out pyteleloisirs in the requirements list since we're using it directly. We shouldn't implicitly depend on liveboxplaytv to pull in the requirement if we're calling it directly.

[emlove]

The rest of this looks good, but could you elaborate on #10076 (comment) ? I don't understand why the media duration would be changing constantly. We don't want to introduce changes that will create constant state updates.

[pschmitt]

In liveboxplaytv a program represents a live TV program. As time goes by the media position necessarily progresses.

[emlove]

Hmm, looking at the VLC example, I don't think that one is doing what we thought either. Going to ping @balloob for a weigh-in.

https://github.com/home-assistant/home-assistant/blob/08b0629eca6417a2bb1b6f3c805ff19208484e4d/homeassistant/components/media_player/vlc.py#L68-L72

[balloob]

We should never ever add the current position in the state. The frontend will calculate this when needed by doing current position of state + (now - state.media_position_updated_at)

[balloob]

If VLC does this, we should remove it from there as well.

[balloob]

So it means that current position (and updated at) should only be updated when the state of the player changes. So when it goes from play to pause etc.

[pschmitt]

okay @balloob you are saying it should be something along the lines of:

@asyncio.coroutine
    def async_update(self):
        state = self.refresh_state()
        if state != self._state:  # state changed
           self._state = state
           self._media_duration = XXX
           self._media_remaining_time = XXX

But this won't update the current program duration (media_duration) when the current program ends. There won't be any state change between the end a program and the start of the next one...

[dersger]

I don't know how often liveboxplaytv or vlc send updates. It's not really a problem if they only send updates at state changes. If it's sent too often then something like this should be ok (untested):

new_position = pyteleloisirs.get_remaining_time(program)
set_new_position = (new_state != old_state) or (new_position is None) or (self._media_remaining_time is None)
if not set_new_position and (new_state == STATE_PLAYING):
    old_position =  (dt_util.utcnow() - self._media_last_updated).total_seconds() + self._media_remaining_time
    set_new_position = abs(new_position - old_position) > 1
if set_new_position:
    self._media_remaining_time = new_position
    self._media_last_updated = dt_util.utcnow() if new_position is not None else None

Or maybe it should compare with something larger than 1. I don't know if pyteleloisirs only returns whole seconds and how big latencies may be.

Writing this I realize that it should be elapsed_time (or position), not remaining_time.

[pvizeli]

Please test this