PolygonWaveform class

PolygonWaveform paints the standard waveform that is used for audio waveforms, a sharp continuous line joining the points of a waveform.

{@tool snippet} Example :

PolygonWaveform(
  maxDuration: maxDuration,
  elapsedDuration: elapsedDuration,
  samples: samples,
  height: 300,
  width: MediaQuery.of(context).size.width,
)

{@end-tool}

Inheritance

Constructors

PolygonWaveform({Key? key, required List<double> samples, required double height, required double width, Duration? maxDuration, Duration? elapsedDuration, Color activeColor = Colors.red, Color inactiveColor = Colors.blue, Gradient? activeGradient, Gradient? inactiveGradient, PaintingStyle style = PaintingStyle.stroke, bool showActiveWaveform = true, bool absolute = false, bool invert = false})

Properties

absolute → bool
Makes the waveform absolute. Draws the waveform along the positive y-axis. Samples are processed such that we end up with positive sample values.
finalinherited
activeColor → Color
active waveform color
final
activeGradient → Gradient?
active waveform gradient
final
elapsedDuration → Duration?
Elapsed duration of the audio.
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
height → double
Height of the canvas on which the waveform will be drawn.
finalinherited
inactiveColor → Color
inactive waveform color
final
inactiveGradient → Gradient?
inactive waveform gradient
final
invert → bool
Inverts/Flips the waveform along x-axis. Samples are processed such that we end up with samples having opposite sign.
finalinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
maxDuration → Duration?
Maximum duration of the audio.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
samples → List<double>
Audio samples raw input. This raw samples are processed before being used to paint the waveform.
finalinherited
showActiveWaveform → bool
Whether to show the active waveform or not.
finalinherited
style → PaintingStyle
waveform style
final
waveformAlignment → WaveformAlignment
Alignment of the waveform in the canvas.
finalinherited
width → double
Width of the canvas on which the waveform will be drawn.
finalinherited

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → AudioWaveformState<PolygonWaveform>
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited