Namespace: YoutubePlayer

YoutubePlayer

Class reprensenting a YoutubePlayer
Source:

Example

const player = new YoutubePlayer()

Members

(static) EventTypes :Object

Return event types
Type:
  • Object
Source:
Example
const EventTypes = Player.EventTypes

{
      LOG: 'log',
      ERROR: 'error',
      READY: 'ready',
      PLAY: 'play',
      REPLAY: 'replay',
      PAUSE: 'pause',
      STOP: 'pause',
      NEXT: 'next',
      PREVIOUS: 'previous',
      RANDOM: 'random',
      REPEAT: 'repeat',
      PLAYBACK_RATE: 'playbackRate',
      VOLUME: 'volume',
      MAX_VOLUME: 'maxVolume',
      MUTED: 'muted',
      ENDED: 'ended',
      ENQUEUE: 'enqueue',
      DEQUE: 'deque',
      EMPTY_QUEUE: 'emptyQueue',
      STATE_CHANGE: 'stateChange'
}

Methods

deque() → {Promise}

Deques an YouTube video from queue
Source:
Returns:
Type
Promise
Example
player.deque()

emptyQueue() → {Promise}

Empties queue
Source:
Returns:
Type
Promise
Example
player.emptyQueue()

enqueue(url) → {Promise}

Enqueue a YouTube url to play
Parameters:
Name Type Description
url String a YouTube url
Source:
Returns:
Type
Promise
Example
const url = 'https://www.youtube.com/watch?v=qk1nnAHI1mI'

player.enqueue(url)

getCurrentTime() → {Number}

Return elapsed time in seconds since the YouTube video started playing
Source:
Returns:
time - current time
Type
Number
Example
player.getCurrentTime()

getCurrentUrl() → {String}

Get currently playing YouTube video url
Source:
Returns:
Type
String
Example
const url = player.getCurrentUrl()

getDuration() → {Number}

Get duration of YouTube video
Source:
Returns:
duration - duration of YouTube video
Type
Number
Example
player.getDuration()

getMaxVolume() → {Number}

Get max volume value
Source:
Returns:
maxVolume - max volume value
Type
Number
Example
player.getMaxVolume()

getPlaybackRate() → {Number}

Get the current plaback rate speed
Source:
Returns:
playback rate speed
Type
Number
Example
const playbackRate = player.getPlaybackRate()

getVolume() → {Number}

Get current volume value
Source:
Returns:
volume - current volume value
Type
Number
Example
player.getVolume()

hasNext() → {Boolean}

Return true if there's a YouTube video to play next in queue
Source:
Returns:
hasNext
Type
Boolean
Example
const hasNext = player.hasNext()

hasPrevious() → {Boolean}

Return true if there's a previous YouTube video in queue
Source:
Returns:
hasPrevious
Type
Boolean
Example
const hasPrevious = player.hasPrevious()

next() → {Promise}

Play next YouTube video in queue
Source:
Returns:
Type
Promise
Example
player.next()

on(eventName, callback)

Listen for player events
Parameters:
Name Type Description
eventName String name of even
callback function called when the event occurs
Source:
Examples
player.on(Player.EventTypes.PLAY, () => {

})
player.on(Player.EventTypes.PLAYBACK_RATE, () => {

})

pause() → {Promise}

Pause playing current YouTube video
Source:
Returns:
Type
Promise
Example
player.pause()

play() → {Promise}

Plays current YouTube video in queue
Source:
Returns:
Type
Promise
Example
player.play()

playQueue() → {Promise}

Start playing YouTube video in queue
Source:
Returns:
Type
Promise
Example
player.playQueue()

playUrl(url) → {Promise}

Play YouTube url
Parameters:
Name Type Description
url String YouTube url
Source:
Returns:
Type
Promise
Example
const url = 'https://www.youtube.com/watch?v=qk1nnAHI1mI'

player.playUrl(url)

previous() → {Promise}

Play previous YouTube video in queue
Source:
Returns:
Type
Promise
Example
player.previous()

replay() → {Promise}

Replay current YouTube video
Source:
Returns:
Type
Promise
Example
player.replay()

seekTo(seconds) → {Promise}

Seek to a specified time in YouTube video
Parameters:
Name Type Description
seconds Number number of seconds to seek to
Source:
Returns:
Type
Promise
Example
const seconds = 45

player.seekTo(seconds)

setMaxVolume(maxVolume) → {Promise}

Set the maximum volume limit. For example if max volume is set to 0.6, then when volume is scaled from 0-0.6, meaning that volume level at 1 will play at 0.6
Parameters:
Name Type Description
maxVolume Number max volume, range 0-1
Source:
Returns:
Type
Promise
Example
player.setMaxVolume(0.8)

setMuted(enabled) → {Promise}

Set volume level to muted
Parameters:
Name Type Description
enabled Boolean boolean to enable mute
Source:
Returns:
Type
Promise
Example
player.setMuted(true)

setPlaybackRate(playbackRate) → {Promise}

Set the plaback rate speed, range 0.75-2
Parameters:
Name Type Description
playbackRate Number new playback rate
Source:
Returns:
Type
Promise
Example
player.setPlaybackRate(2)

setRandom(enabled) → {Promise}

Enable to disable random playback
Parameters:
Name Type Description
enabled Boolean boolean to enable random playback
Source:
Returns:
Type
Promise
Example
player.setRandom(true)

setRepeat(enabled) → {Promise}

Enable to disable repeat mode. Repeat mode replays the YouTube videos once the entire queue has finished playing.
Parameters:
Name Type Description
enabled Boolean boolean to enable repeat mode
Source:
Returns:
Type
Promise
Example
player.setRepeat(true)

setVolume(volume) → {Promise}

Set volume, range 0-1
Parameters:
Name Type Description
volume Number volume value
Source:
Returns:
Type
Promise
Example
player.setVolume(0.9)

stop() → {Promise}

Stop playing current YouTube video
Source:
Returns:
Type
Promise
Example
player.stop()