AbstractAudioVideoInputService

AbstractAudioVideoInputService ⇐ Abstract#

Kind: global abstract class
Extends: Abstract
Service:

• AbstractAudioVideoInputService ⇐ Abstract
  • new AbstractAudioVideoInputService()
  • .init() ⇒ Promise
  • .mute(sourceType, [options]) ⇒ Promise.<boolean>
  • .unMute(sourceType, [options]) ⇒ Promise
  • .toggleMute(sourceType, [options]) ⇒ Promise.<boolean>
  • .isMuted(sourceType, [options]) ⇒ Promise.<boolean>
  • ._init() ⇒ Promise
  • ._mute(sourceType, [options]) ⇒ Promise.<boolean>
  • ._unMute(sourceType, [options]) ⇒ Promise
  • ._isMuted(sourceType, [options]) ⇒ Promise.<boolean>
  • ._onMuteStateChange(sourceType, muted) ⇒ Promise
  • “muteStateChange” (sourceType, muted)

AbstractAudioVideoInputService()#

This class represents the audio and video setting service, for inputs.

init() ⇒ Promise#

Init the service

Kind: instance method of AbstractAudioVideoInputService

mute(sourceType, [options]) ⇒ Promise.<boolean>#

Mute the input source

Kind: instance method of AbstractAudioVideoInputService
Returns: Promise.<boolean> - A Promise resolved if muted
Emits: AbstractVolumeService#event:muteStateChange

unMute(sourceType, [options]) ⇒ Promise#

UnMute the input source

Kind: instance method of AbstractAudioVideoInputService
Returns: Promise - A Promise resolved if unmuted
Emits: AbstractVolumeService#event:muteStateChange

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

Toggle the mute status of an input source

Kind: instance method of AbstractAudioVideoInputService
Returns: Promise.<boolean> - A Promise resolved with mute status.
Emits: AbstractVolumeService#event:muteStateChange

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

Check if the input source is muted.

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

_init() ⇒ Promise#

Init the service.

Kind: instance abstract method of AbstractAudioVideoInputService
Access: protected

_mute(sourceType, [options]) ⇒ Promise.<boolean>#

Kind: instance abstract method of AbstractAudioVideoInputService
Returns: Promise.<boolean> - A Promise resolved if muted

_unMute(sourceType, [options]) ⇒ Promise#

Kind: instance abstract method of AbstractAudioVideoInputService
Returns: Promise - A Promise resolved when if unmuted.
Access: protected

_isMuted(sourceType, [options]) ⇒ Promise.<boolean>#

Kind: instance abstract method of AbstractAudioVideoInputService
Returns: Promise.<boolean> - A Promise resolved with the input source mute status.

_onMuteStateChange(sourceType, muted) ⇒ Promise#

Kind: instance method of AbstractAudioVideoInputService
Access: protected

“muteStateChange” (sourceType, muted)#

Fired when the mute state of an input source has been changed

Kind: event emitted by AbstractAudioVideoInputService