AbstractVolumeService

AbstractVolumeService ⇐ Abstract#

Kind: global abstract class
Extends: Abstract
Service:
Properties

• AbstractVolumeService ⇐ Abstract
  • new AbstractVolumeService()
  • .init() ⇒ Promise.<*, Error>
  • .dimVolume(dimming) ⇒ Promise.<number>
  • .setVolume(volume, [options]) ⇒ Promise.<number>
  • .getVolume([options]) ⇒ Promise.<number>
  • .volumeUp([options]) ⇒ Promise.<number>
  • .volumeDown([options]) ⇒ Promise.<number>
  • .mute([options]) ⇒ Promise
  • .unMute([options]) ⇒ Promise
  • .toggleMute([options]) ⇒ Promise.<boolean>
  • .isMuted([options]) ⇒ Promise.<boolean>
  • .restoreLastVolume([options]) ⇒ Promise.<number>
  • ._init() ⇒ Promise
  • ._setVolume(volume) ⇒ Promise.<number>
  • ._getVolume() ⇒ Promise.<number>
  • ._mute() ⇒ Promise
  • ._unMute() ⇒ Promise
  • ._isMuted() ⇒ Promise.<boolean>
  • ._storeLastVolume(volume) ⇒ Promise.<number>
  • ._restoreLastVolume() ⇒ Promise.<number>
  • ._onVolumeChange(volume) ⇒ Promise
  • ._onMuteStateChange(muted) ⇒ Promise
  • “volumeChange” (volume)
  • “muteStateChange” (muted)

AbstractVolumeService()#

The AbstractVolumeService handles the volume management.

init() ⇒ Promise.<*, Error>#

Init the service.

Kind: instance method of AbstractVolumeService
Returns: Promise.<*, Error> - Promise resolved when init is done

dimVolume(dimming) ⇒ Promise.<number>#

Allows to dim volume by a percentage dimming value

Kind: instance method of AbstractVolumeService
Returns: Promise.<number> - A Promise resolved when the dimming is actually changed, with the new dimming percentage between 0 and this.maxVolume inclusive.

setVolume(volume, [options]) ⇒ Promise.<number>#

Set the main volume.

Kind: instance method of AbstractVolumeService
Returns: Promise.<number> - A Promise resolved when the main volume is actually changed, with the new volume percentage between 0 and this.maxVolume inclusive.
Emits: volumeChange

getVolume([options]) ⇒ Promise.<number>#

Get the current main volume.

Kind: instance method of AbstractVolumeService
Returns: Promise.<number> - A Promise resolved with the main volume percentage between 0 and 100 inclusive.

volumeUp([options]) ⇒ Promise.<number>#

Increase the volume by volumeStepPercent.

Kind: instance method of AbstractVolumeService
Returns: Promise.<number> - A Promise resolved with the new main volume percentage between 0 and 100 inclusive.
Emits: volumeChange

volumeDown([options]) ⇒ Promise.<number>#

Decrease the volume by volumeStepPercent.

Kind: instance method of AbstractVolumeService
Returns: Promise.<number> - A Promise resolved with the new main volume percentage between 0 and 100 inclusive.
Emits: volumeChange

mute([options]) ⇒ Promise#

Mute the main volume. Note: not equivalent to setVolume(0) ! Mute preserves the current volume.

Kind: instance method of AbstractVolumeService
Returns: Promise - A Promise resolved when the main volume is actually muted.
Emits: muteStateChange

unMute([options]) ⇒ Promise#

UnMute the main volume.

Kind: instance method of AbstractVolumeService
Returns: Promise - A Promise resolved when the main volume is actually unMuted.
Emits: muteStateChange

toggleMute([options]) ⇒ Promise.<boolean>#

Toggle the main volume mute status.

Kind: instance method of AbstractVolumeService
Returns: Promise.<boolean> - A Promise resolved with the main volume mute status.
Emits: muteStateChange

isMuted([options]) ⇒ Promise.<boolean>#

Check if the main volume is muted.

Kind: instance method of AbstractVolumeService
Returns: Promise.<boolean> - A Promise resolved with the main volume mute status.

restoreLastVolume([options]) ⇒ Promise.<number>#

Restore the last volume, ie set the volume to the last value it was set Note: it does not trigger the #volumeChange event

Kind: instance method of AbstractVolumeService
Returns: Promise.<number> - A Promise resolved when the last volume

_init() ⇒ Promise#

Kind: instance method of AbstractVolumeService
Returns: Promise - A Promise resolved when the service is initialized

_setVolume(volume) ⇒ Promise.<number>#

Kind: instance abstract method of AbstractVolumeService
Returns: Promise.<number> - A Promise resolved when the main volume is actually changed, with the volume percentage between 0 and this.maxVolume inclusive.

_getVolume() ⇒ Promise.<number>#

Kind: instance abstract method of AbstractVolumeService
Returns: Promise.<number> - A Promise resolved with the main volume percentage between 0 and this.maxVolume inclusive.

_mute() ⇒ Promise#

Kind: instance abstract method of AbstractVolumeService
Returns: Promise - A Promise resolved when the main volume is actually muted.

_unMute() ⇒ Promise#

Kind: instance abstract method of AbstractVolumeService
Returns: Promise - A Promise resolved when the main volume is actually unmuted.
Access: protected

_isMuted() ⇒ Promise.<boolean>#

Kind: instance abstract method of AbstractVolumeService
Returns: Promise.<boolean> - A Promise resolved with the main volume mute status.

_storeLastVolume(volume) ⇒ Promise.<number>#

Kind: instance abstract method of AbstractVolumeService
Returns: Promise.<number> - A Promise resolved when the last volume

_restoreLastVolume() ⇒ Promise.<number>#

Kind: instance abstract method of AbstractVolumeService
Returns: Promise.<number> - A Promise resolved when the last volume

_onVolumeChange(volume) ⇒ Promise#

Kind: instance method of AbstractVolumeService
Access: protected

_onMuteStateChange(muted) ⇒ Promise#

Kind: instance method of AbstractVolumeService
Access: protected

“volumeChange” (volume)#

Fired when the main volume has been changed

Kind: event emitted by AbstractVolumeService

“muteStateChange” (muted)#

Fired when the main volume mute state has been changed

Kind: event emitted by AbstractVolumeService