video-dev/can-autoplay

Name: can-autoplay

Owner: video-dev

Description: The auto-play feature detection in HTMLMediaElement (

Created: 2017-11-16 16:19:12.0

Updated: 2018-05-21 11:51:28.0

Pushed: 2018-02-28 01:53:15.0

Homepage: https://video-dev.github.io/can-autoplay/

Size: 167

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

can-autoplay.js

The auto-play feature detection in HTMLMediaElement (<audio> or <video>).

Demo page

Table of contents:

• Installation
• Files
• API
• audio(options)
• video(options)
• Example
• Media
• Implementation Details

Installation

install can-autoplay

Files

Build files are available in the build/ directory. Bundlers will choose get the correct file chosen for them but if you just want to include it on the page, grab the build/can-autoplay.js file.

API

audio(options)

Parameters:

• options.inline <Boolean>, check if auto-play is possible for an inline playback, default value is false
• options.muted <Boolean>, check if auto-play is possible for a muted content
• options.timeout <Number>, timeout for a check, default value is 250 ms

Returns:

• <Promise>, resoles to a <Object>:
• result <Boolean>, true - if auto-play is possible
• error <Error>, internal or timeout Error object

utoplay.audio().then(({result}) => {
 (result === true) {
// Can auto-play
else {
// Can not auto-play

video(options)

Parameters:

• options.inline <Boolean>, check if auto-play is possible for an inline playback, default value is false
• options.muted <Boolean>, check if auto-play is possible for a muted content
• options.timeout <Number>, timeout for a check, default value is 250 ms

Returns:

• <Promise>, resoles to a <Object>:
• result <Boolean>, true - if auto-play is possible
• error <Error>, internal or timeout Error object

utoplay.video().then(({result}) => {
 (result === true) {
// Can autoplay
else {
// Can not autoplay

Example

rt canAutoPlay from 'can-autoplay';

utoPlay
.video({timeout: 100, muted: true})
.then(({result, error}) => {
    if(result === false){
        console.warn('Error did occur: ', error)
    }
})

Media

• audio.mp3. Created by Weston Ruter (@westonruter). Smallest possible (<0.000001 seconds long) audio file.
• video.mp4. Source: https://github.com/mathiasbynens/small

Implementation Details

If it's required to have a legacy browser support you could use latest v2.x.x version of the library.