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 full)

Constructors

constructor

Properties

analyser autopanner bitcrusher chorus compressor context delay envelopegenerator equalizer filter flanger fuzz listener mastervolume mixed modules noisegate noisesuppressor overdrive panner phaser pitchshifter preamp processor recorder reverb ringmodulator runningAnalyser stereo tremolo vocalcanceler wah NUMBER_OF_INPUTS NUMBER_OF_OUTPUTS

Accessors

INPUT OUTPUT

Methods

connect demix disconnect edit exitPictureInPicture fadeIn fadeOut get hasMedia hasSource init install mix module off on param params paused ready requestPictureInPicture setup start stop suspend toJSON

Constructors

constructor

Properties

Protectedanalyser

analyser: Analyser

Protectedautopanner

autopanner: Autopanner

Protectedbitcrusher

bitcrusher: BitCrusher

Protectedchorus

chorus: Chorus

Protectedcompressor

compressor: Compressor

Protectedcontext

context: AudioContext

Protecteddelay

delay: Delay

Protectedenvelopegenerator

envelopegenerator: EnvelopeGenerator

Protectedequalizer

equalizer: Equalizer

Protectedfilter

filter: Filter

Protectedflanger

flanger: Flanger

Protectedfuzz

fuzz: Fuzz

Protectedlistener

listener: Listener

Protectedmastervolume

mastervolume: GainNode

Protectedmixed

mixed: boolean = false

Protectedmodules

modules: Connectable[] = []

Protectednoisegate

noisegate: NoiseGate

Protectednoisesuppressor

noisesuppressor: NoiseSuppressor

Protectedoverdrive

overdrive: OverDrive

Protectedpanner

panner: Panner

Protectedphaser

phaser: Phaser

Protectedpitchshifter

pitchshifter: PitchShifter

Protectedpreamp

preamp: Preamp

Protectedprocessor

processor: AudioWorkletNode

Protectedrecorder

recorder: Recorder

Protectedreverb

reverb: Reverb

Protectedringmodulator

ringmodulator: Ringmodulator

ProtectedrunningAnalyser

runningAnalyser: boolean = false

Protectedstereo

stereo: Stereo

Protectedtremolo

tremolo: Tremolo

Protectedvocalcanceler

vocalcanceler: VocalCanceler

Protectedwah

wah: Wah

Static ReadonlyNUMBER_OF_INPUTS

NUMBER_OF_INPUTS = 2

Static ReadonlyNUMBER_OF_OUTPUTS

NUMBER_OF_OUTPUTS = 2

Accessors

INPUT

OUTPUT

Methods

connect

demix

disconnect

edit

exitPictureInPicture

  • exitPictureInPicture(): Promise<void>

  • This method exits from Picture In Picture (PIP).

    Returns Promise<void>

    Return value is Promise.

fadeIn

  • fadeIn(time?): 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.

fadeOut

  • fadeOut(time?): 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.

get

  • get(): null | MediaElementAudioSourceNode

  • This method gets instance of MediaElementAudioSourceNode.

    Returns null | MediaElementAudioSourceNode

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.

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.

Protectedinit

  • init(context): void

  • This method re-initials modules.

    Parameters

    • context: AudioContext

      This argument is in order to use Web Audio API.

    Returns void

install

mix

module

off

on

param

params

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.

ready

  • ready(src, mimeType?): 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.

requestPictureInPicture

  • requestPictureInPicture(): Promise<PictureInPictureWindow>

  • This method requests Picture In Picture (PIP).

    Returns Promise<PictureInPictureWindow>

    Return value is Promise.

setup

  • setup(params): 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;
      }
      • Optionalautoplay?: boolean
      • Optionalformats?: string[]
      • Optionallisteners?: {
            [eventType: string]: ((event: Event | Error) => void);
        }
        • [eventType: string]: ((event: Event | Error) => void)
            • (event): void

            • Parameters

              • event: Event | Error

              Returns void

      • media: HTMLAudioElement | HTMLVideoElement

    Returns MediaModule

    Return value is for method chain.

start

  • start(position?, errorCallback?): 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.

        • (error): void

        • Parameters

          • error: Error

          Returns void

    Returns MediaModule

    Return value is for method chain.

stop

  • stop(successCallback?, errorCallback?): MediaModule

  • This method stops media.

    Parameters

    • OptionalsuccessCallback: (() => void)

      This argument is invoked on success.

        • (): void

        • Returns void

    • OptionalerrorCallback: ((error: Error) => void)

      This argument is invoked on failure.

        • (error): void

        • Parameters

          • error: Error

          Returns void

    Returns MediaModule

    Return value is for method chain.

suspend

toJSON

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods