Skip to content

docs and support for player and library events#241

Open
dexter21767-dev wants to merge 3 commits into
feat/library-and-player-resourcesfrom
feat/library-player-events-docs
Open

docs and support for player and library events#241
dexter21767-dev wants to merge 3 commits into
feat/library-and-player-resourcesfrom
feat/library-player-events-docs

Conversation

@dexter21767-dev

Copy link
Copy Markdown
Member

No description provided.

@elpiel elpiel left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM so far!
We still need to define the request of routes in protocol.md:

  • define library route and params
  • define player route and params

Comment thread docs/api/requests/definePlayerHandler.md

@elpiel elpiel left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let me know if I've missed something @dexter21767-dev

Comment thread docs/protocol.md
To define a minimal addon, you only need an HTTP server/endpoint serving a `/manifest.json` file and responding to resource requests at `/{resource}/{type}/{id}.json`.

Currently used resources are: `catalog`, `meta`, `stream`, `subtitles`, `watchStatus`.
Currently used resources are: `catalog`, `meta`, `stream`, `subtitles`, `player`, `library`.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • add playback

Comment thread docs/api/requests/definePlayerHandler.md
Comment thread docs/protocol.md
Comment on lines 29 to 32
- Play: `action=play&currentTime={milliseconds}&duration={milliseconds}`
- Start: `action=start&currentTime={milliseconds}&duration={milliseconds}`
- End: `action=end&currentTime={milliseconds}&duration={milliseconds}`
- Pause: `action=pause&currentTime={milliseconds}&duration={milliseconds}`

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Play and Pause should be separated into the playback events resource
  • As we've discussed in Slack, duration and currentTime might not be available and are not required for each of these actions and must be made optional. Only Play and Pause make sense with those arguments.

Comment thread docs/protocol.md
Comment on lines +37 to +38
- Add to library: `action=libraryAdd`
- Remove from library: `action=libraryRemove`

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest to rename these to add and remove respectively.
We are already under the library resource and a simple action name would be sufficient

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants