VolumeSettings class

Model for Alarm volume settings.

Annotations

• @JsonSerializable(constructor: '_')

Constructors

VolumeSettings.fade({required Duration fadeDuration, double? volume, bool volumeEnforced = false})

Constructs VolumeSettings with fading volume level.

const

VolumeSettings.fixed({double? volume, bool volumeEnforced = false})

Constructs VolumeSettings with fixed volume level.

const

VolumeSettings.fromJson(Map<String, dynamic> json)

Converts the JSON object to a VolumeSettings instance.

factory

VolumeSettings.fromWire(VolumeSettingsWire wire)

Converts from wire datatype.

VolumeSettings.staircaseFade({required List<VolumeFadeStep> fadeSteps, double? volume, bool volumeEnforced = false})

Constructs VolumeSettings with slowly increasing (stepped) volume level.

factory

Properties

fadeDuration → Duration?

Duration over which to fade the alarm ringtone. Set to null by default, which means no fade.

final

fadeSteps → List<VolumeFadeStep>

Controls how the alarm volume will fade over time.

final

hashCode → int

The hash code for this object.

no setter, inherited

props → List<Object?>

The list of properties that will be used to determine whether two instances are equal.

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

stringify → bool?

If set to true, the toString method will be overridden to output this instance's props.

no setter, inherited

volume → double?

Specifies the system volume level to be set when the alarm goes off.

final

volumeEnforced → bool

If true, the alarm volume is enforced, automatically resetting to the original alarm volume if the user attempts to adjust it. This prevents the user from lowering the alarm volume. Won't work if app is killed.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

Converts the VolumeSettings instance to a JSON object.

toString() → String

A string representation of this object.

inherited

toWire() → VolumeSettingsWire

Converts to wire datatype which is used for host platform communication.

Operators

operator ==(Object other) → bool

The equality operator.

inherited