-
Notifications
You must be signed in to change notification settings - Fork 7.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Added a troubleshooting guide #3814
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Two small comments, looks good otherwise.
nor adaptive streaming is a consideration, MP4 is a good choice. | ||
|
||
#### I need adaptive streaming or live streaming | ||
Use HLS with [videojs-contrib-hls]()https://github.com/videojs/videojs-contrib-dash or |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Link is outside parentheses and links to -dash instead of -hls. 😄
* If you are using HLS or DASH your server must implement CORS headers if the video is served from a different domain than your page. This is also true for text tracks such as captions. | ||
|
||
## Problems with Fullscreen | ||
* If your player is in an iframe, make sure it and any parent iframes have the fullscreen attributes allowfullscreen webkitallowfullscreen mozallowfullscreen. Without these, the browser will not allow fullscreen mode. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should probably use ` here to call out the attribute names.
## Problems with media formats | ||
Make sure you are using formats that video.js can play: | ||
* Does your browser/OS support the type of video that you are trying to play? | ||
* Do you have a plugin that will add support for that video format? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be clear that we're talking about video.js plugins and not the likes of Flash.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe link to videojs-contrib-hls/dash and videojs-youtube as non-exhaustive examples.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
video or audio format
Make sure you are using formats that video.js can play: | ||
* Does your browser/OS support the type of video that you are trying to play? | ||
* Do you have a plugin that will add support for that video format? | ||
* Verify that you are using the correct mime-type/content-type for your videos. This used to determine if video.js can play a video. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you are specifying the correct media type for your source, whether you are using the <source>
element or the src()
API method.
Maybe link to http://www.iana.org/assignments/media-types/media-types.xhtml#video ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
seems like a good idea will do!
* Some low end phones save video in 3GP format but give it an MP4 extension. These files will not play. | ||
|
||
|
||
Make sure that Flash is installed and that the Flash tech is included with video.js: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This reads as Flash is required. "If you are using Flash videos, ..."
HLS is more convenient as mobile browsers have native support. | ||
|
||
## Problems when hosting video | ||
* Your server must support byte-range requests as Chrome and Safari rely on it. Most servers support this by default, but we have seen many issues with PHP as it does not support byte-range by default. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd leave out the part after the comma as the next bullet addresses PHP
## Problems when hosting video | ||
* Your server must support byte-range requests as Chrome and Safari rely on it. Most servers support this by default, but we have seen many issues with PHP as it does not support byte-range by default. | ||
* If you are proxying the media files via a server side script (PHP), this script must implement ranges. The impact of not doing this ranges from seeking being broken to no playback at all (on iOS). | ||
* Your server must return the correct mime-type/content-type for the video formats. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the correct media type in the Content-type header for the video or audio format being sent
* Your server must support byte-range requests as Chrome and Safari rely on it. Most servers support this by default, but we have seen many issues with PHP as it does not support byte-range by default. | ||
* If you are proxying the media files via a server side script (PHP), this script must implement ranges. The impact of not doing this ranges from seeking being broken to no playback at all (on iOS). | ||
* Your server must return the correct mime-type/content-type for the video formats. | ||
* If you are using HLS or DASH your server must implement CORS headers if the video is served from a different domain than your page. This is also true for text tracks such as captions. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Link to enablecors.org
* Do you have a video.js plugin that will add support for a media format to video.js? For Example: | ||
* [videojs-contrib-hls][hls] | ||
* [videojs-contrib-dash][dash] | ||
* [videojs-contrib-youtube][youtube] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it's just videojs-youtube.
|
||
### If you are using Flash videos: | ||
* Make sure that Flash is installed | ||
* Make sure the Flash tech is included with video.js (in video.js it won't be, see [videojs-flash][flash]) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This isn't true right now
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ahh meant to type in video.js >= v6.0.0
. Good catch
Description
Added a troubleshooting guide
Requirements Checklist