PlayerHandle class final
One media player (main by default) of one venue.
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- playerId → String
-
Player id or
main.final - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
states
→ Stream<
PlaybackSnapshot> -
State changes (replays the latest value; keeps the topic subscribed while listened to).
no setter
- value → PlaybackSnapshot?
-
Latest known state (null before the first read / event).
no setter
- venueId → String
-
Venue id or
default.final
Methods
-
next(
) → Future< PlayerState?> - Next playlist item.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
pause(
) → Future< PlayerState?> - Pauses.
-
play(
PlayTarget target, {Duration? position, DateTime? at}) → Future< PlayerState?> -
Starts
target(or continues what is loaded) atposition, optionally at the server timeat(multi-node sync). Live control: fails fast with OfflineException while offline. -
previous(
) → Future< PlayerState?> - Previous playlist item.
-
refresh(
) → Future< PlaybackSnapshot> - Reads the state over REST (served from the cache, marked stale, when offline).
-
resume(
) → Future< PlayerState?> - Resumes.
-
seek(
Duration position) → Future< PlayerState?> -
Seeks to
position(or to a timelinemarker); scrubbing coalesces to the latest position. -
seekToMarker(
String marker) → Future< PlayerState?> -
Seeks to the timeline marker
marker. -
setLoop(
bool loop) → Future< PlayerState?> - Loop on / off.
-
setOpacity(
double v) → Future< PlayerState?> - Player opacity 0..1 (fader; coalesced).
-
setRate(
double rate) → Future< PlayerState?> - Playback rate (fader; coalesced).
-
setVolume(
double v) → Future< PlayerState?> - Player volume 0..1 (fader; coalesced).
-
stop(
) → Future< PlayerState?> - Stops.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited