SheenLyricsView class Music

Synced lyrics: large lines, the one being sung bright and the rest dim, scrolling by themselves to keep the current line in the upper third. A tap on a line jumps the song there. With no timed lines, plain lyrics show as text.

The view stops following the song for a few seconds after the user scrolls, so reading ahead is possible.

SheenLyricsView(lines: lyrics.lines, position: state.position, onSeek: player.seek)
Inheritance

Constructors

SheenLyricsView({Key? key, required List<SheenLyricsLine> lines, Duration position = Duration.zero, ValueChanged<Duration>? onSeek, String? plain, Color? color, EdgeInsetsGeometry padding = const EdgeInsets.symmetric(horizontal: SheenSpace.xxl, vertical: SheenSpace.xxl)})
Lyrics for lines at position.
const

Properties

color → Color?
The text colour; the theme's text colour by default.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
lines → List<SheenLyricsLine>
The timed lines, in order.
final
onSeek → ValueChanged<Duration>?
Called with a line's start when it is tapped.
final
padding → EdgeInsetsGeometry
Space around the lines.
final
plain → String?
Untimed lyrics, shown when lines is empty.
final
position → Duration
Where the song is.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<SheenLyricsView>
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, int wrapWidth = 65}) → 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

Static Methods

indexAt(List<SheenLyricsLine> lines, Duration position) → int
The index of the line being sung at position, or -1 before the first.