VolumeBar(player, optionsopt)

The bar that contains the volume level and can be clicked on to adjust the level

new VolumeBar(player, optionsopt)
control-bar/volume-control/volume-bar.js, line 19

Creates an instance of this class.

Parameters:
Name Type Attributes Description
player Player

The Player that this class should be attached to.
options Object <optional>

The key/value store of player options.

Extends

Members

playerEvent :string
control-bar/volume-control/volume-bar.js, line 207

Call the update event for this Slider when this event happens on the player.

Methods

calculateDistance(event) → {number}
slider/slider.js, line 292

Calculate distance for slider

Parameters:
Name Type Description
event EventTarget~Event

The event that caused this function to run.
Returns:
number -

The current position of the Slider.

    - position.x for vertical `Slider`s
    - position.y for horizontal `Slider`s
Inherited From:

checkMuted()
control-bar/volume-control/volume-bar.js, line 105

If the player is muted unmute it.

createEl() → {Element}
control-bar/volume-control/volume-bar.js, line 43

Create the Component's DOM element

Returns:
Element -

The element that was created.

Overrides:

disable()
slider/slider.js, line 86

Disable controls for this slider if they are enabled

Inherited From:

enable()
slider/slider.js, line 60

Enable controls for this slider if they are disabled

Inherited From:

enabled() → {boolean}
slider/slider.js, line 53

Are controls are currently enabled for this slider or not.

Returns:
boolean -

true if controls are enabled, false otherwise

Inherited From:

getPercent() → {number}
control-bar/volume-control/volume-bar.js, line 117

Get percent of volume level

Returns:
number -

Volume level percent as a decimal number.

getProgress() → {number}
slider/slider.js, line 277

Get the percentage of the bar that should be filled but clamped and rounded.

Returns:
number -

percentage filled that the slider is

Inherited From:

handleClick(event)
slider/slider.js, line 338

Listener for click events on slider, used to prevent clicks from bubbling up to parent elements like button menus.

Parameters:
Name Type Description
event Object

Event that caused this object to run
Inherited From:

handleKeyDown(event)
slider/slider.js, line 311

Handle a keydown event on the Slider. Watches for left, rigth, up, and down arrow keys. This function will only be called when the slider has focus. See Slider#handleFocus and Slider#handleBlur.

Parameters:
Name Type Description
event EventTarget~Event

the keydown event that caused this function to run.
Listens to Events:
  • event:keydown
Inherited From:

handleMouseDown(event)
control-bar/volume-control/volume-bar.js, line 60

Handle mouse down on volume bar

Parameters:
Name Type Description
event EventTarget~Event

The mousedown event that caused this to run.
Listens to Events:
  • event:mousedown
Overrides:

handleMouseMove(event)
control-bar/volume-control/volume-bar.js, line 76

Handle movement events on the VolumeMenuButton.

Parameters:
Name Type Description
event EventTarget~Event

The event that caused this function to run.
Listens to Events:
  • event:mousemove
Overrides:

handleMouseUp(event)
slider/slider.js, line 211

Handle mouseup or touchend events on the Slider.

Parameters:
Name Type Description
event EventTarget~Event

mouseup or touchend event that triggered this function.
Fires:
Listens to Events:
  • event:touchend
  • event:mouseup
Inherited From:

stepBack()
control-bar/volume-control/volume-bar.js, line 135

Decrease volume level for keyboard users

stepForward()
control-bar/volume-control/volume-bar.js, line 127

Increase volume level for keyboard users

update() → {number}
slider/slider.js, line 240

Update the progress bar of the Slider.

Returns:
number -

The percentage of progress the progress bar represents as a number from 0 to 1.

Inherited From:

updateARIAAttributes(eventopt)
control-bar/volume-control/volume-bar.js, line 148

Update ARIA accessibility attributes

Parameters:
Name Type Attributes Description
event EventTarget~Event <optional>

The volumechange event that caused this function to run.
Listens to Events:

vertical(boolopt) → {boolean}
slider/slider.js, line 354

Get/set if slider is horizontal for vertical

Parameters:
Name Type Attributes Description
bool boolean <optional>
  • true if slider is vertical,
     - false is horizontal
Returns:
boolean -
  • true if slider is vertical, and getting
      - false if the slider is horizontal, and getting
Inherited From:

Events

slideractive
slider/slider.js, line 170

Triggered when the slider is in an active state

Type:
Inherited From:

sliderinactive
slider/slider.js, line 217

Triggered when the slider is no longer in an active state.

Type:
Inherited From: