docs(middleware): updating the middleware guide with setTech and other corrections #4926
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…d adding some corrections
incompl
reviewed
Feb 2, 2018
docs/guides/middleware.md
Outdated
|
|
||
| ## Understanding Middleware | ||
|
|
||
| Middleware are functions that return an object with methods matching those on the `Tech`. There are currently a limited set of allowed methods that will be understood by middleware. These are: `buffered`, `currentTime`, `setCurrentTime`, `duration`, `seekable`, `played`, `play`, `pause` and `paused`. | ||
| Middleware are functions that return an object, a class instance, a prototype, e.c.t, scoped to the Player with methods matching those on the `Tech`. There are currently a limited set of allowed methods that will be understood by middleware. These are: `buffered`, `currentTime`, `setCurrentTime`, `duration`, `seekable`, `played`, `play`, `pause` and `paused`. These allowed methods are split into three categories: [getters](#middleware-getters), [setters](#middleware-setters), and [mediators](#middleware-mediators). |
There was a problem hiding this comment.
Is e.c.t a correct stylization? I usually see etc.
There was a problem hiding this comment.
whoops, good catch. I often make this mistake
| * [Middleware Setters](#middleware-setters) | ||
| * [Middleware Getters](#middleware-getters) | ||
| * [Middleware Mediators](#middleware-mediators) | ||
| * [Termination and Mediators](#termination-and-mediators) | ||
| * [Using Middleware](#using-middleware) | ||
| * [Terminating Mediator Methods](#terminating-mediator-methods) | ||
| * [setSource](#setsource) | ||
|
|
||
| ## Understanding Middleware |
There was a problem hiding this comment.
I suggest starting out with a purpose statement for readers who have arrived at this page with no context. Something like "Middleware allows you to override the behavior of basic player methods."
There was a problem hiding this comment.
That's actually at the top of the file 😄
ldayananda
added
documentation
patch
gkatsev
reviewed
Feb 9, 2018
|
|
||
| ``` | ||
|
|
||
| Mediators make a round trip: starting at the `Player`, mediating to the `Tech` and returning the result to the `Player` again. A `call{method}` method must be supplied by the middleware which is used when mediating to the `Tech`. On the way back to the `Player`, the `{method}` will be called instead, with 2 arguments: `terminated`, a Boolean indicating whether a middleware terminated during the mediation to the tech portion, and `value`, which is the value returned from the `Tech`. A barebones example of a middleware with Mediator methods is: | ||
| A skeleton of a middleware with Mediator methods is given below: |
There was a problem hiding this comment.
I noticed that this example uses callPlay and pause. Should the pause be play?
docs/guides/middleware.md
Outdated
| }, | ||
| ... | ||
| setSource: function(srcObj, next) { |
There was a problem hiding this comment.
can we move setSource to be the first property of the object? Since it's required and it's important to know which source it's selected with, having it first, I think, is useful.
gkatsev
approved these changes
Feb 12, 2018
gkatsev
added
confirmed
and removed
needs: LGTM
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.