Interface LoudnessNormalizationController

Handles loudness normalization by applying gain adjustments based on track loudness metadata.

interface LoudnessNormalizationController {
    gain: number;
    logPrefix: string;
    clear(): void;
    dispatch<K extends "change">(
        type: K,
        event: LoudnessNormalizationControllerEventMap[K],
    ): void;
    hasAnyListeners(): boolean;
    hasListeners(type: "change"): boolean;
    on<K extends "change">(
        type: K,
        handler: EventHandler<LoudnessNormalizationControllerEventMap[K]>,
        options?: SignalOptions,
    ): Unsubscribe;
    setTrackLoudness(value: number | null): void;
}

Hierarchy (View Summary)

EventHost<LoudnessNormalizationControllerEventMap>
Clearable
- LoudnessNormalizationController

Implemented by

LoudnessNormalizationControllerImpl

Index

Properties

Methods

clear dispatch hasAnyListeners hasListeners on setTrackLoudness

Properties

`Readonly`gain

gain: number

Loudness gain adjustment value.

`Readonly`logPrefix

logPrefix: string

A string prefix for all log statements made by this target.

Methods

clear

clear(): void
Clears this object.

Returns void
Inherited from Clearable.clear
- Defined in vinyl-util/src/core/clearable.ts:10

dispatch

dispatch<K extends "change">(
type: K,
event: LoudnessNormalizationControllerEventMap[K],
): void
Dispatches an event.
Type Parameters
- K extends "change"
Parameters
- type: K
  The key of the event within EventMap
- event: LoudnessNormalizationControllerEventMap[K]
  If the passed event is read-only, then it may be re-used/cached. Otherwise, it should be a new event object every dispatch. If no target property is set on the event, the target will be set to this host.
Returns void
Inherited from EventHost.dispatch
- Defined in vinyl-util/src/event/EventHost.ts:24

hasAnyListeners

hasAnyListeners(): boolean
Returns true if the event host has any listeners.

Returns boolean
Inherited from EventHost.hasAnyListeners
- Defined in vinyl-util/src/event/EventHost.ts:45

hasListeners

hasListeners(type: "change"): boolean
Returns true if the event host has any listeners for the given type.
Parameters
- type: "change"
Returns boolean
Inherited from EventHost.hasListeners
- Defined in vinyl-util/src/event/EventHost.ts:50

on

on<K extends "change">(
    type: K,
    handler: EventHandler<LoudnessNormalizationControllerEventMap[K]>,
    options?: SignalOptions,
): Unsubscribe
Adds an event handler for the given typed event.
Type Parameters
- K extends "change"
Parameters
- type: K
  The key representing the event type to listen for.
- handler: EventHandler<LoudnessNormalizationControllerEventMap[K]>
  A callback to invoke when the event with the given type is dispatched.
- Optionaloptions: SignalOptions
  Options for changing listening behavior.
Returns Unsubscribe
Returns a method, when invoked, removes the handler.
Inherited from EventHost.on
- Defined in vinyl-util/src/event/EventHost.ts:36

setTrackLoudness

setTrackLoudness(value: number | null): void
Sets the current track's loudness level in LUFS, for the current track played.
Parameters
- value: number | null
Returns void
- Defined in vinyl/src/playback/loudness/LoudnessNormalizationController.ts:32