1.0.5 • Published 2 years ago

react-youtube-music-player v1.0.5

Weekly downloads
-
License
ISC
Repository
-
Last release
2 years ago

react-youtube-music-player

NPM JavaScript Style Guide

alt text

For example player, click here

Installation

npm install react-youtube-music-player

Usage

import { useYoutube } from "react-youtube-music-player";
const { playerDetails, actions } = useYoutube({
  id: "RDLbqzhXWl33U",
  type: "playlist",
});

Input props

PropDescription
idThe id of a video or playlist to play
typeSet video or playlist depending on the id
optionsorigin: Origin domain for additional security autoplay: Whether to autoplay the video host: Points host to correct origin for CORS loop: Whether a single video should be looped mute: Whether to start the video muted start: Time, in seconds from the beginning of the video, when to start playing end: Points host to correct origin for CORS host: Time, in seconds from the beginning of the video, when to stop playing
eventsonReady: Called when media is initialized and ready to play onStateChanged: Called when video state changed onError: Called when error occurs

Return props

State of the player: playerDetails

PropDescription
idThe id of currently playing video
stateCurrent state of the media - UNSTARTED(-1), ENDED(0), PLAYING(1), PAUSED(2), BUFFERING(3), CUED(5)
titleTitle of the video
durationDuration of the media, in seconds
currentTimeNumber of seconds that have been played
volumeVolume of the player

Internal player functions: actions

Function nameDescription
playVideo()Play video
stopVideo()Stop video
pauseVideo()Pause video
nextVideo()Play next video
previousVideo()Play previous video
setVolume(volume)Set the volume of the player, between 0-100
seekTo(seconds, allowSeekAhead)Seek to the given number of seconds
1.0.5

2 years ago

1.0.4

2 years ago

1.0.3

2 years ago

1.0.2

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago