HyperDeckConnection class
Connection-oriented client for the complete HyperDeck Ethernet protocol.
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- isConnected → bool
-
no setter
-
notifications
→ Stream<
HyperDeckResponse> -
Device messages that arrive without a matching command response.
no setter
-
responses
→ Stream<
HyperDeckResponse> -
All complete messages received from the device.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- socket → Socket
-
final
Methods
-
authenticate(
Map< String, Object?> credentials) → Future<HyperDeckResponse> - Authenticates with the supplied protocol credentials.
-
cacheInfo(
) → Future< HyperDeckResponse> - Requests cache information.
-
clearPlayRange(
) → Future< HyperDeckResponse> - Clears the playback range.
-
clipInfo(
[Map< String, Object?> parameters = const {}]) → Future<HyperDeckResponse> - Requests clip information with optional protocol parameters.
-
clipsAdd(
Map< String, Object?> parameters) → Future<HyperDeckResponse> - Adds a clip using protocol parameters.
-
clipsClear(
) → Future< HyperDeckResponse> - Removes every clip.
-
clipsCount(
) → Future< HyperDeckResponse> - Requests the number of clips.
-
clipsGet(
[Map< String, Object?> parameters = const {}]) → Future<HyperDeckResponse> - Retrieves clips with optional protocol parameters.
-
clipsRebuild(
) → Future< HyperDeckResponse> - Rebuilds the clip list.
-
clipsRemove(
int clipId) → Future< HyperDeckResponse> -
Removes the clip identified by
clipId. -
close(
) → Future< void> -
command(
String name, [Map< String, Object?> parameters = const {}]) → Future<HyperDeckResponse> - Sends any single-line protocol command and waits for its response.
-
configuration(
[Map< String, Object?> parameters = const {}]) → Future<HyperDeckResponse> - Requests or configures device settings.
-
confirmFormat(
String token) → Future< HyperDeckResponse> -
Confirms a pending format operation with
token. -
deviceInfo(
) → Future< HyperDeckResponse> - Requests device information.
-
diskList(
[Map< String, Object?> parameters = const {}]) → Future<HyperDeckResponse> - Lists disks, optionally filtered with protocol parameters.
-
dynamicRange(
[Map< String, Object?> parameters = const {}]) → Future<HyperDeckResponse> - Requests or configures the dynamic range.
-
externalDriveList(
) → Future< HyperDeckResponse> - Lists connected external drives.
-
externalDriveSelect(
String device) → Future< HyperDeckResponse> -
Selects an external drive by
device. -
externalDriveSelected(
) → Future< HyperDeckResponse> - Requests the selected external drive.
-
goTo(
Map< String, Object?> position) → Future<HyperDeckResponse> -
Moves the transport to
position. -
help(
) → Future< HyperDeckResponse> - Requests the device's command help.
-
identify(
bool enabled) → Future< HyperDeckResponse> - Enables or disables device identification.
-
jog(
String timecode) → Future< HyperDeckResponse> -
Jogs the transport to
timecode. -
multilineCommand(
String name, Map< String, Object?> parameters) → Future<HyperDeckResponse> - Sends any multi-line protocol command and waits for its response.
-
nasAdd(
Map< String, Object?> values) → Future<HyperDeckResponse> - Adds a NAS location using protocol values.
-
nasDeselect(
) → Future< HyperDeckResponse> - Deselects the active NAS location.
-
nasDiscovered(
) → Future< HyperDeckResponse> - Lists discovered NAS locations.
-
nasList(
) → Future< HyperDeckResponse> - Lists configured NAS locations.
-
nasRemove(
String url) → Future< HyperDeckResponse> -
Removes the NAS location at
url. -
nasSelect(
String url) → Future< HyperDeckResponse> -
Selects the NAS location at
url. -
nasSelected(
) → Future< HyperDeckResponse> - Requests the selected NAS location.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
notificationSettings(
[Map< String, Object?> parameters = const {}]) → Future<HyperDeckResponse> - Requests or configures notifications.
-
ping(
) → Future< HyperDeckResponse> - Checks whether the device is reachable.
-
play(
[Map< String, Object?> parameters = const {}]) → Future<HyperDeckResponse> - Starts playback with optional protocol parameters.
-
playOnStartup(
[Map< String, Object?> parameters = const {}]) → Future<HyperDeckResponse> - Requests or configures playback on startup.
-
playOption(
[Map< String, Object?> parameters = const {}]) → Future<HyperDeckResponse> - Requests or configures playback options.
-
playRange(
) → Future< HyperDeckResponse> - Requests the current playback range.
-
prepareFormat(
Map< String, Object?> parameters) → Future<HyperDeckResponse> - Prepares a format operation using protocol parameters.
-
preview(
bool enabled) → Future< HyperDeckResponse> - Enables or disables preview mode.
-
quit(
) → Future< HyperDeckResponse> - Ends the Ethernet protocol session.
-
reboot(
) → Future< HyperDeckResponse> - Reboots the device.
-
record(
[Map< String, Object?> parameters = const {}]) → Future<HyperDeckResponse> - Starts recording with optional protocol parameters.
-
recordSpill(
) → Future< HyperDeckResponse> - Starts spill recording.
-
recordSpillToSlot(
int slotId) → Future< HyperDeckResponse> -
Starts spill recording to
slotId. -
remote(
[Map< String, Object?> parameters = const {}]) → Future<HyperDeckResponse> - Requests or configures remote control.
-
send(
String command) → Future< HyperDeckResponse> - Sends raw protocol text. The text must contain exactly one command.
-
setConnectionProtocolVersion(
int version) → Future< HyperDeckResponse> -
Sets the connection protocol
version. -
setPlayRange(
Map< String, Object?> parameters) → Future<HyperDeckResponse> - Sets the playback range using protocol parameters.
-
setSlateClips(
Map< String, Object?> values) → Future<HyperDeckResponse> - Sets slate clip metadata using protocol values.
-
setSlateLens(
Map< String, Object?> values) → Future<HyperDeckResponse> - Sets slate lens metadata using protocol values.
-
setSlateProject(
Map< String, Object?> values) → Future<HyperDeckResponse> - Sets slate project metadata using protocol values.
-
shortHelp(
) → Future< HyperDeckResponse> - Requests abbreviated command help.
-
shuttle(
int speed) → Future< HyperDeckResponse> -
Shuttles at
speed. -
slateClips(
) → Future< HyperDeckResponse> - Requests slate clip metadata.
-
slateLens(
) → Future< HyperDeckResponse> - Requests slate lens metadata.
-
slateProject(
) → Future< HyperDeckResponse> - Requests slate project metadata.
-
slotInfo(
[Map< String, Object?> parameters = const {}]) → Future<HyperDeckResponse> - Requests slot information with optional protocol parameters.
-
slotSelect(
Map< String, Object?> parameters) → Future<HyperDeckResponse> - Selects a slot using protocol parameters.
-
slotUnblock(
[Map< String, Object?> parameters = const {}]) → Future<HyperDeckResponse> - Unblocks slots matching the supplied protocol parameters.
-
spillOrder(
) → Future< HyperDeckResponse> - Requests the spill-recording order.
-
stop(
) → Future< HyperDeckResponse> - Stops playback or recording.
-
supportedCommands(
) → Future< HyperDeckResponse> - Lists the commands supported by the device.
-
toString(
) → String -
A string representation of this object.
inherited
-
transportInfo(
) → Future< HyperDeckResponse> - Requests transport information.
-
uptime(
) → Future< HyperDeckResponse> - Requests the device uptime.
-
watchdog(
int seconds) → Future< HyperDeckResponse> - Configures the watchdog period in seconds.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited