Skip to content

Commit

Permalink
docs: Fix Player#src API documentation. (#4454)
Browse files Browse the repository at this point in the history
  • Loading branch information
misteroneill authored and gkatsev committed Jul 14, 2017
1 parent 4f43616 commit 7579fc1
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions src/js/player.js
Original file line number Diff line number Diff line change
Expand Up @@ -2247,17 +2247,19 @@ class Player extends Component {
}

/**
* The source function updates the video source
* There are three types of variables you can pass as the argument.
* **URL string**: A URL to the the video file. Use this method if you are sure
* the current playback technology (HTML5/Flash) can support the source you
* provide. Currently only MP4 files can be used in both HTML5 and Flash.
* Get or set the video source.
*
* @param {Tech~SourceObject|Tech~SourceObject[]} [source]
* One SourceObject or an array of SourceObjects
* @param {Tech~SourceObject|Tech~SourceObject[]|string} [source]
* A SourceObject, an array of SourceObjects, or a string referencing
* a URL to a media source. It is _highly recommended_ that an object
* or array of objects is used here, so that source selection
* algorithms can take the `type` into account.
*
* @return {string}
* The current video source when getting
* If not provided, this method acts as a getter.
*
* @return {string|undefined}
* If the `source` argument is missing, returns the current source
* URL. Otherwise, returns nothing/undefined.
*/
src(source) {
// getter usage
Expand Down

0 comments on commit 7579fc1

Please sign in to comment.