Rumble Player API

The following is functionality that can be called on the API class provided from the optional configuration parameter api.

Ex:

Rumble("play", {video: "vabcd", div: "rumblePlayer", api: function(api) {
  /* API calls can go here, or you can pass the API to your own functions */
}});

Player Methods

API.loadVideo(video, [play])

• Changed the video currently in the player
• Parameters:
  • video – video ID to be loaded
  • play – [optional] whether to auto play the video, only able to do this on your own videos and if a user has already clicked on the player before

API.getCurrentVideo()

• Returns an object with the following:
  • id - the video ID
  • link - Link to the video on rumble.com
  • own - Whether the video is your own video
  • plays - Number of times this video has been played
  • thumb - Thumbnail of the video
  • title - Title of the video

API.play([force])

• Plays the video loaded. This function will only be successful if one of the following conditions are met:
  1. The video has already played and has since been paused or ended
  2. You own the video and the player has previously been clicked on.
  3. You own the video and you call the function with true for the force optional parameter.
• Please note that if the video has not be interacted with previously and you try to force the video the browser may block it unless you mute the video first.

API.pause()

• Pauses the current video if it is playing

API.getPaused()

• Returns true or false depending if the video is playing or not.

API.mute()

• Mute the volume on the player

API.unmute()

• Un-mute the volume on the player

API.getMuted()

• Returns true or false whether the player is muted

API.setVolume(vol)

• Sets the volume on the player. The value passed should be between 0 and 1 inclusively, with 1 being full volume. If the player is muted this will unmute it automatically.

API.getVolume()

• Returns the volume of the player. If the player is muted the value for this will be 0

API.getDuration()

• Get the length of the currently loaded video in seconds

API.setCurrentTime(time)

• Seek the current video to the time in number of seconds, if the video is playing it will skip to the time and continue playing.

API.getCurrentTime()

• Get the current time of where the video is playing in seconds.

API.off(eventName, [func])

• Removes event listeners on the player. All functions are removed if the optional “func” parameter is not provided, otherwise the function provided in “func” is only removed”. A list of all events available is listed in API.on

API.on(eventName, func)

• Add an event listener to the player. An object is passed to your function if there is need for more than one value for the event. Here is a list of available events.