Update README
Add documentation for the changes introduced by the PlaylistLoader.
Showing
1 changed file
with
12 additions
and
6 deletions
... | @@ -68,19 +68,25 @@ See html5rocks's [article](http://www.html5rocks.com/en/tutorials/cors/) | ... | @@ -68,19 +68,25 @@ See html5rocks's [article](http://www.html5rocks.com/en/tutorials/cors/) |
68 | for more info. | 68 | for more info. |
69 | 69 | ||
70 | ### Runtime Properties | 70 | ### Runtime Properties |
71 | #### player.hls.master | 71 | #### player.hls.playlists.master |
72 | Type: `object` | 72 | Type: `object` |
73 | 73 | ||
74 | An object representing the parsed master playlist. If a media playlist | 74 | An object representing the parsed master playlist. If a media playlist |
75 | is loaded directly, a master playlist with only one entry will be | 75 | is loaded directly, a master playlist with only one entry will be |
76 | created. | 76 | created. |
77 | 77 | ||
78 | #### player.hls.media | 78 | #### player.hls.playlists.media |
79 | Type: `object` | 79 | Type: `function` |
80 | 80 | ||
81 | An object representing the currently selected media playlist. This is | 81 | A function that can be used to retrieve or modify the currently active |
82 | the playlist that is being referred to when a additional video data | 82 | media playlist. The active media playlist is referred to when a |
83 | needs to be downloaded. | 83 | additional video data needs to be downloaded. Calling this function |
84 | with no arguments returns the parsed playlist object for the active | ||
85 | media playlist. Calling this function with a playlist object from the | ||
86 | master playlist or a URI string as specified in the master playlist | ||
87 | will kick off an asynchronous load of the specified media | ||
88 | playlist. Once it has been retreived, it will become the active media | ||
89 | playlist. | ||
84 | 90 | ||
85 | #### player.hls.mediaIndex | 91 | #### player.hls.mediaIndex |
86 | Type: `number` | 92 | Type: `number` | ... | ... |
-
Please register or sign in to post a comment