Class MediaModule

This class processes sound data from HTMLMediaElement. Namely, this class enables to create audio player that has higher features from HTMLMediaElement. But, this class is disadvantage to play many one shot audios. In that case, developer should use OneshotModule.

Hierarchy (View Summary)

SoundModule
- MediaModule

Constructors

constructor

new MediaModule(context: AudioContext): MediaModule
Parameters
- context: AudioContext
  This argument is in order to use Web Audio API.
Returns MediaModule
Overrides SoundModule.constructor
- Defined in MediaModule/index.ts:74

Properties

`Protected`analyser

analyser: Analyser

`Protected`autopanner

autopanner: Autopanner

`Protected`bitcrusher

bitcrusher: BitCrusher

`Protected`chorus

chorus: Chorus

`Protected`compressor

compressor: Compressor

`Protected`context

context: AudioContext

`Protected`delay

delay: Delay

`Protected`envelopegenerator

envelopegenerator: EnvelopeGenerator

`Protected`equalizer

equalizer: Equalizer

`Protected`filter

filter: Filter

`Protected`flanger

flanger: Flanger

`Protected`fuzz

fuzz: Fuzz

`Protected`listener

listener: Listener

`Protected`mastervolume

mastervolume: GainNode

`Protected`mixed

mixed: boolean = false

`Protected`modules

modules: Connectable[] = []

`Protected`noisegate

noisegate: NoiseGate

`Protected`noisesuppressor

noisesuppressor: NoiseSuppressor

`Protected`overdrive

overdrive: OverDrive

`Protected`panner

panner: Panner

`Protected`phaser

phaser: Phaser

`Protected`pitchshifter

pitchshifter: PitchShifter

`Protected`preamp

preamp: Preamp

`Protected`processor

processor: AudioWorkletNode

`Protected`recorder

recorder: Recorder

`Protected`reverb

reverb: Reverb

`Protected`ringmodulator

ringmodulator: Ringmodulator

`Protected`runningAnalyser

runningAnalyser: boolean = false

`Protected`stereo

stereo: Stereo

`Protected`tremolo

tremolo: Tremolo

`Protected`vocalcanceler

vocalcanceler: VocalCanceler

`Protected`wah

wah: Wah

`Static` `Readonly`NUMBER_OF_INPUTS

NUMBER_OF_INPUTS: 2

`Static` `Readonly`NUMBER_OF_OUTPUTS

NUMBER_OF_OUTPUTS: 2

Accessors

INPUT

get INPUT(): AudioWorkletNode
Returns AudioWorkletNode
Overrides SoundModule.INPUT
- Defined in MediaModule/index.ts:806

OUTPUT

get OUTPUT(): GainNode
Returns GainNode
Overrides SoundModule.OUTPUT
- Defined in MediaModule/index.ts:811

Methods

connect

connect(source: AudioNode): void
This method connects AudioNodes.
Parameters
- source: AudioNode
  This argument is AudioNode as sound source.
Returns void
Inherited from SoundModule.connect
- Defined in SoundModule/index.ts:251

demix

demix(): MediaModule
Returns MediaModule
Overrides SoundModule.demix
- Defined in MediaModule/index.ts:779

disconnect

disconnect(): void
This method disconnects instance of AudioWorkletNode as sound source.

Returns void
Inherited from SoundModule.disconnect
- Defined in SoundModule/index.ts:305

edit

edit(modules: Connectable[]): Connectable[]
This method edits module to use and module connection order.
Parameters
- modules: Connectable[]
  This argument is edited modules.
Returns Connectable[]
Return value is previous modules.
Inherited from SoundModule.edit
- Defined in SoundModule/index.ts:439

exitPictureInPicture

exitPictureInPicture(): Promise<void>
This method exits from Picture In Picture (PIP).

Returns Promise<void>
Return value is Promise.
- Defined in MediaModule/index.ts:587

fadeIn

fadeIn(time?: number): number | MediaModule
This method gets or sets fade-in time.
Parameters
- Optionaltime: number
  This argument is fade-in time. If this argument is omitted, this method is getter.
Returns number | MediaModule
Return value is fade-in time. Otherwise, return value is for method chain.
- Defined in MediaModule/index.ts:510

fadeOut

fadeOut(time?: number): number | MediaModule
This method gets or sets fade-out time.
Parameters
- Optionaltime: number
  This argument is fade-out time. If this argument is omitted, this method is getter.
Returns number | MediaModule
Return value is fade-out time. Otherwise, return value is for method chain.
- Defined in MediaModule/index.ts:533

get

get(): null | MediaElementAudioSourceNode
This method gets instance of MediaElementAudioSourceNode.

Returns null | MediaElementAudioSourceNode
- Defined in MediaModule/index.ts:477

hasMedia

hasMedia(): boolean
This method determines whether instance of HTMLMediaElement exists.

Returns boolean
If instance of HTMLMediaElement already exists, this value is true. Otherwise, this value is false.
- Defined in MediaModule/index.ts:485

hasSource

hasSource(): boolean
This method determines whether instance of MediaElementAudioSourceNode exists.

Returns boolean
If instance of MediaElementAudioSourceNode already exists, this value is true. Otherwise, this value is false.
- Defined in MediaModule/index.ts:493

`Protected`init

init(context: AudioContext): void
This method re-initials modules.
Parameters
- context: AudioContext
  This argument is in order to use Web Audio API.
Returns void
Inherited from SoundModule.init
- Defined in SoundModule/index.ts:469

install

install<ExtendedEffector extends Effector>(
effector: new (context: AudioContext) => ExtendedEffector,
): ExtendedEffector
This method installs customized effector.
Type Parameters
- ExtendedEffector extends Effector
Parameters
- effector: new (context: AudioContext) => ExtendedEffector
  This argument is subclass that extends Effector class.
Returns ExtendedEffector
Return value is instance of customized effector (that extends Effector class).
Inherited from SoundModule.install
- Defined in SoundModule/index.ts:314

mix

mix(): MediaModule
Returns MediaModule
Overrides SoundModule.mix
- Defined in MediaModule/index.ts:773

module

module(moduleName: "analyser"): Analyser
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "analyser"
  This argument selects module.
Returns Analyser
- Defined in MediaModule/index.ts:620
module(moduleName: "recorder"): Recorder
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "recorder"
  This argument selects module.
Returns Recorder
- Defined in MediaModule/index.ts:621
module(moduleName: "autopanner"): Autopanner
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "autopanner"
  This argument selects module.
Returns Autopanner
- Defined in MediaModule/index.ts:622
module(moduleName: "bitcrusher"): BitCrusher
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "bitcrusher"
  This argument selects module.
Returns BitCrusher
- Defined in MediaModule/index.ts:623
module(moduleName: "chorus"): Chorus
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "chorus"
  This argument selects module.
Returns Chorus
- Defined in MediaModule/index.ts:624
module(moduleName: "compressor"): Compressor
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "compressor"
  This argument selects module.
Returns Compressor
- Defined in MediaModule/index.ts:625
module(moduleName: "delay"): Delay
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "delay"
  This argument selects module.
Returns Delay
- Defined in MediaModule/index.ts:626
module(moduleName: "envelopegenerator"): EnvelopeGenerator
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "envelopegenerator"
  This argument selects module.
Returns EnvelopeGenerator
- Defined in MediaModule/index.ts:627
module(moduleName: "equalizer"): Equalizer
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "equalizer"
  This argument selects module.
Returns Equalizer
- Defined in MediaModule/index.ts:628
module(moduleName: "filter"): Filter
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "filter"
  This argument selects module.
Returns Filter
- Defined in MediaModule/index.ts:629
module(moduleName: "flanger"): Flanger
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "flanger"
  This argument selects module.
Returns Flanger
- Defined in MediaModule/index.ts:630
module(moduleName: "fuzz"): Fuzz
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "fuzz"
  This argument selects module.
Returns Fuzz
- Defined in MediaModule/index.ts:631
module(moduleName: "listener"): Listener
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "listener"
  This argument selects module.
Returns Listener
- Defined in MediaModule/index.ts:632
module(moduleName: "noisegate"): NoiseGate
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "noisegate"
  This argument selects module.
Returns NoiseGate
- Defined in MediaModule/index.ts:633
module(moduleName: "noisesuppressor"): NoiseSuppressor
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "noisesuppressor"
  This argument selects module.
Returns NoiseSuppressor
- Defined in MediaModule/index.ts:634
module(moduleName: "overdrive"): OverDrive
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "overdrive"
  This argument selects module.
Returns OverDrive
- Defined in MediaModule/index.ts:635
module(moduleName: "panner"): Panner
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "panner"
  This argument selects module.
Returns Panner
- Defined in MediaModule/index.ts:636
module(moduleName: "phaser"): Phaser
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "phaser"
  This argument selects module.
Returns Phaser
- Defined in MediaModule/index.ts:637
module(moduleName: "pitchshifter"): PitchShifter
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "pitchshifter"
  This argument selects module.
Returns PitchShifter
- Defined in MediaModule/index.ts:638
module(moduleName: "preamp"): Preamp
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "preamp"
  This argument selects module.
Returns Preamp
- Defined in MediaModule/index.ts:639
module(moduleName: "reverb"): Reverb
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "reverb"
  This argument selects module.
Returns Reverb
- Defined in MediaModule/index.ts:640
module(moduleName: "ringmodulator"): Ringmodulator
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "ringmodulator"
  This argument selects module.
Returns Ringmodulator
- Defined in MediaModule/index.ts:641
module(moduleName: "stereo"): Stereo
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "stereo"
  This argument selects module.
Returns Stereo
- Defined in MediaModule/index.ts:642
module(moduleName: "tremolo"): Tremolo
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "tremolo"
  This argument selects module.
Returns Tremolo
- Defined in MediaModule/index.ts:643
module(moduleName: "vocalcanceler"): VocalCanceler
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "vocalcanceler"
  This argument selects module.
Returns VocalCanceler
- Defined in MediaModule/index.ts:644
module(moduleName: "wah"): Wah
This method gets instance of Module (Analyser, Recorder, Effector ... etc).
Parameters
- moduleName: "wah"
  This argument selects module.
Returns Wah
- Defined in MediaModule/index.ts:645

off

off(stopTime?: number): MediaModule
Parameters
- OptionalstopTime: number
Returns MediaModule
Overrides SoundModule.off
- Defined in MediaModule/index.ts:761

on

on(startTime?: number): MediaModule
Parameters
- OptionalstartTime: number
Returns MediaModule
Overrides SoundModule.on
- Defined in MediaModule/index.ts:755

param

param(params: "mastervolume"): number
This method gets or sets parameters for media module. This method is overloaded for type interface and type check.
Parameters
- params: "mastervolume"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for media module if getter. Otherwise, return value is for method chain.
- Defined in MediaModule/index.ts:346
param(params: "autoplay"): boolean
This method gets or sets parameters for media module. This method is overloaded for type interface and type check.
Parameters
- params: "autoplay"
  This argument is string if getter. Otherwise, setter.
Returns boolean
Return value is parameter for media module if getter. Otherwise, return value is for method chain.
- Defined in MediaModule/index.ts:347
param(params: "playbackRate"): number
This method gets or sets parameters for media module. This method is overloaded for type interface and type check.
Parameters
- params: "playbackRate"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for media module if getter. Otherwise, return value is for method chain.
- Defined in MediaModule/index.ts:348
param(params: "currentTime"): number
This method gets or sets parameters for media module. This method is overloaded for type interface and type check.
Parameters
- params: "currentTime"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for media module if getter. Otherwise, return value is for method chain.
- Defined in MediaModule/index.ts:349
param(params: "controls"): boolean
This method gets or sets parameters for media module. This method is overloaded for type interface and type check.
Parameters
- params: "controls"
  This argument is string if getter. Otherwise, setter.
Returns boolean
Return value is parameter for media module if getter. Otherwise, return value is for method chain.
- Defined in MediaModule/index.ts:350
param(params: "loop"): boolean
This method gets or sets parameters for media module. This method is overloaded for type interface and type check.
Parameters
- params: "loop"
  This argument is string if getter. Otherwise, setter.
Returns boolean
Return value is parameter for media module if getter. Otherwise, return value is for method chain.
- Defined in MediaModule/index.ts:351
param(params: "muted"): boolean
This method gets or sets parameters for media module. This method is overloaded for type interface and type check.
Parameters
- params: "muted"
  This argument is string if getter. Otherwise, setter.
Returns boolean
Return value is parameter for media module if getter. Otherwise, return value is for method chain.
- Defined in MediaModule/index.ts:352
param(params: "duration"): boolean
This method gets or sets parameters for media module. This method is overloaded for type interface and type check.
Parameters
- params: "duration"
  This argument is string if getter. Otherwise, setter.
Returns boolean
Return value is parameter for media module if getter. Otherwise, return value is for method chain.
- Defined in MediaModule/index.ts:353
param(params: "duration"): boolean
This method gets or sets parameters for media module. This method is overloaded for type interface and type check.
Parameters
- params: "duration"
  This argument is string if getter. Otherwise, setter.
Returns boolean
Return value is parameter for media module if getter. Otherwise, return value is for method chain.
- Defined in MediaModule/index.ts:354
param(params: MediaModuleParams): MediaModule
This method gets or sets parameters for media module. This method is overloaded for type interface and type check.
Parameters
- params: MediaModuleParams
  This argument is string if getter. Otherwise, setter.
Returns MediaModule
Return value is parameter for media module if getter. Otherwise, return value is for method chain.
- Defined in MediaModule/index.ts:355

params

params(): Required<MediaModuleParams>
This method gets media module parameters as associative array.

Returns Required<MediaModuleParams>
Overrides SoundModule.params
- Defined in MediaModule/index.ts:789

paused

paused(): boolean
This method determines whether media is paused.

Returns boolean
If media is paused, this value is true. Otherwise, this value is false.
- Defined in MediaModule/index.ts:501

ready

ready(src: string, mimeType?: string): MediaModule
This method prepares for playing media anytime after loading media resource.
Parameters
- src: string
  This argument is Object URL or file name for media resource.
- OptionalmimeType: string
  This argument is required in case of audio streaming.
Returns MediaModule
Return value is for method chain.
- Defined in MediaModule/index.ts:198

requestPictureInPicture

requestPictureInPicture(): Promise<PictureInPictureWindow>
This method requests Picture In Picture (PIP).

Returns Promise<PictureInPictureWindow>
Return value is Promise.
- Defined in MediaModule/index.ts:555

setup

setup(
    params: {
        autoplay?: boolean;
        formats?: string[];
        listeners?: { [eventType: string]: (event: Event | Error) => void };
        media: HTMLAudioElement | HTMLVideoElement;
    },
): MediaModule
This method gets HTMLMediaElement and selects media format. In addition, this method adds event listeners that are defined by HTMLMediaElement.
Parameters
- params: {
      autoplay?: boolean;
      formats?: string[];
      listeners?: { [eventType: string]: (event: Event | Error) => void };
      media: HTMLAudioElement | HTMLVideoElement;
  }
Returns MediaModule
Return value is for method chain.
- Defined in MediaModule/index.ts:95

start

start(position?: number, errorCallback?: (error: Error) => void): MediaModule
This method starts media from designated time.
Parameters
- Optionalposition: number
  This argument is time that media is started at. The default value is 0.
- OptionalerrorCallback: (error: Error) => void
  This argument is invoked on failure.
Returns MediaModule
Return value is for method chain.
- Defined in MediaModule/index.ts:252

stop

stop(
successCallback?: () => void,
errorCallback?: (error: Error) => void,
): MediaModule
This method stops media.
Parameters
- OptionalsuccessCallback: () => void
  This argument is invoked on success.
- OptionalerrorCallback: (error: Error) => void
  This argument is invoked on failure.
Returns MediaModule
Return value is for method chain.
- Defined in MediaModule/index.ts:307

suspend

suspend(): MediaModule
Returns MediaModule
Overrides SoundModule.suspend
- Defined in MediaModule/index.ts:767

toJSON

toJSON(): string
This method gets effector's parameters as JSON.

Returns string
Inherited from SoundModule.toJSON
- Defined in SoundModule/index.ts:451

Class MediaModule

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MediaModule

Properties

Protectedanalyser

Protectedautopanner

Protectedbitcrusher

Protectedchorus

Protectedcompressor

Protectedcontext

Protecteddelay

Protectedenvelopegenerator

Protectedequalizer

Protectedfilter

Protectedflanger

Protectedfuzz

Protectedlistener

Protectedmastervolume

Protectedmixed

Protectedmodules

Protectednoisegate

Protectednoisesuppressor

Protectedoverdrive

Protectedpanner

Protectedphaser

Protectedpitchshifter

Protectedpreamp

Protectedprocessor

Protectedrecorder

Protectedreverb

Protectedringmodulator

ProtectedrunningAnalyser

Protectedstereo

Protectedtremolo

Protectedvocalcanceler

Protectedwah

Static ReadonlyNUMBER_OF_INPUTS

Static ReadonlyNUMBER_OF_OUTPUTS

Accessors

INPUT

Returns AudioWorkletNode

OUTPUT

Returns GainNode

Methods

connect

Parameters

Returns void

demix

Returns MediaModule

disconnect

Returns void

edit

Parameters

Returns Connectable[]

exitPictureInPicture

Returns Promise<void>

fadeIn

Parameters

Returns number | MediaModule

fadeOut

Parameters

Returns number | MediaModule

get

Returns null | MediaElementAudioSourceNode

hasMedia

Returns boolean

hasSource

Returns boolean

Protectedinit

Parameters

Returns void

install

`Protected`analyser

`Protected`autopanner

`Protected`bitcrusher

`Protected`chorus

`Protected`compressor

`Protected`context

`Protected`delay

`Protected`envelopegenerator

`Protected`equalizer

`Protected`filter

`Protected`flanger

`Protected`fuzz

`Protected`listener

`Protected`mastervolume

`Protected`mixed

`Protected`modules

`Protected`noisegate

`Protected`noisesuppressor

`Protected`overdrive

`Protected`panner

`Protected`phaser

`Protected`pitchshifter

`Protected`preamp

`Protected`processor

`Protected`recorder

`Protected`reverb

`Protected`ringmodulator

`Protected`runningAnalyser

`Protected`stereo

`Protected`tremolo

`Protected`vocalcanceler

`Protected`wah

`Static` `Readonly`NUMBER_OF_INPUTS

`Static` `Readonly`NUMBER_OF_OUTPUTS

`Protected`init