Options
All
  • Public
  • Public/Protected
  • All
Menu

Smooth audio level changes when volume is modified, or if volume limiting has started/ended.

Hierarchy

  • VolumeManager

Index

Constructors

Accessors

  • get isLimiting(): boolean
  • get limitLevel(): number
  • set limitLevel(value: number): void
  • Target level to lower volume to.

    remarks

    Expressed as a value between 0.0 and 1.0. The value is applied based upon the configured levelType. The default value is 0.1.

    For a level type of LevelType.fixed the value is the exact level the volume will be lowered to. The default value of 0.1 would cause the volume to be lowered to 0.1.

    For a level type of LevelType.percentage the value is the percentage by which the volume level should be lowered to. The default value of 0.1 would cause the volume to be lowered to 10% of its starting value.

    Returns number

  • Target level to lower volume to.

    remarks

    Expressed as a value between 0.0 and 1.0. The value is applied based upon the configured levelType. The default value is 0.1.

    For a level type of LevelType.fixed the value is the exact level the volume will be lowered to. The default value of 0.1 would cause the volume to be lowered to 0.1.

    For a level type of LevelType.percentage the value is the percentage by which the volume level should be lowered to. The default value of 0.1 would cause the volume to be lowered to 10% of its starting value.

    Parameters

    • value: number

    Returns void

  • get volume(): number
  • set volume(value: number): void
  • The selected volume.

    remarks

    Expressed as a value between 0.0 and 1.0. The default value is 1.0. Can be used for things like volume sliders.

    Does not return the current volume if limiting is enabled, but the desired volume.

    Returns number

  • The selected volume.

    remarks

    Expressed as a value between 0.0 and 1.0. The default value is 1.0. Can be used for things like volume sliders.

    Does not return the current volume if limiting is enabled, but the desired volume.

    Parameters

    • value: number

    Returns void

  • get volumeChangeDuration(): number
  • set volumeChangeDuration(value: number): void

Methods

  • startLimiting(): void
  • stopLimiting(): void

Generated using TypeDoc