@byomakase/omakase-player
    Preparing search index...

    Interface VuMeterConfig

    interface VuMeterConfig {
        channels?: number;
        htmlElement?: HTMLElement;
        htmlElementId: string;
        labels: string[];
        levelHoldDuration: number;
        orientation: VuMeterOrientation;
        rangeMinDb: number;
        scale: VuMeterScale;
        scaleOffsetDb: number;
        scaleStepDb: number;
        style: Partial<VuMeterStyle>;
        theme: VuMeterTheme;
    }
    Index

    Properties

    channels?: number

    Number of channels to display on the VU Meter. If not specified, the VU Meter will display as many channels as provided by the audio level source. If specified, the VU Meter will display the specified number of channels, and if the audio source provides fewer channels, the remaining channels will be displayed as empty.

    htmlElement?: HTMLElement

    Html element where the VU Meter will be rendered. Can be used instead of htmlElementId to provide the element directly. If both htmlElementId and htmlElement are provided, htmlElement will take precedence.

    htmlElementId: string

    ID of the HTML element where the VU Meter will be rendered. The element must exist in the DOM before creating the VU Meter instance.

    labels: string[]

    Labels for the levels. The labels are applied in order to the levels, so the first label corresponds to the first level, the second label to the second level, and so on. If there are more levels than labels, the remaining levels will not have labels. The default value is ['L', 'R', 'C', 'LFE', 'Ls', 'Rs'].

    levelHoldDuration: number

    Duration in milliseconds for which the hold level is displayed after a peak. The hold level is the maximum level reached since the last time the level was at or below the current level. A value of 0 means that the hold level is not displayed. The default value is 0 ms.

    orientation: VuMeterOrientation

    Orientation of the VU Meter. Can be either vertical or horizontal.

    rangeMinDb: number

    Minimum dB value for the VU Meter scale. The scale will display values from this minimum value to 0 dB. This value is typically a negative number, and common values are -60 dB, -54 dB or -48 dB. The default value is -54 dB.

    Scale type for the VU Meter. The scale controls the dB values displayed on the VU Meter. The DEFAULT scale displays values from rangeMinDb to 0 with steps of scaleStepDb. The NORDIC scale displays values from rangeMinDb to 0 with steps of 3 dB and an offset of 12 dB. The NONE scale does not display any dB values.

    scaleOffsetDb: number

    Offset in dB for the scale values. The default value is 0 dB. This value is ignored if the scale is set to NORDIC, which uses a fixed offset of 12 dB.

    scaleStepDb: number

    Step in dB between each value displayed on the scale. The default value is 6 dB. This value is ignored if the scale is set to NORDIC, which uses a fixed step of 3 dB.

    style: Partial<VuMeterStyle>

    Style configuration for the VU Meter. The style controls the visual appearance of the VU Meter, such as the colors.

    Theme for the VU Meter. The theme controls the way the levels are rendered and colored. The DEFAULT theme renders the levels as simple bars, while the LED theme renders the levels as a series of LEDs that light up based on the dB value.