HyperDeckRestClient class
HTTP client for the HyperDeck Control REST API.
Use request for every documented endpoint; it supports arbitrary paths, HTTP verbs and JSON request bodies, including device-specific additions.
Constructors
- HyperDeckRestClient(Uri baseUri, {HttpClient? httpClient})
Properties
Methods
-
activeMedia(
) → Future< HyperDeckRestResponse> -
addNasBookmark(
String url, {String? username, String? password}) → Future< HyperDeckRestResponse> -
addTimelineClips(
Object clips, {int? insertBefore}) → Future< HyperDeckRestResponse> -
appendTimelineClips(
Object clips) → Future< HyperDeckRestResponse> -
cleanFeed(
String displayName) → Future< HyperDeckRestResponse> -
clearTimeline(
) → Future< HyperDeckRestResponse> -
clearTimelineDeprecated(
) → Future< HyperDeckRestResponse> -
clearTimelinePlayRange(
) → Future< HyperDeckRestResponse> -
clipIndex(
) → Future< HyperDeckRestResponse> -
clips(
) → Future< HyperDeckRestResponse> -
clipsOnDevice(
String deviceName) → Future< HyperDeckRestResponse> -
close(
{bool force = false}) → Future< void> -
codecFormat(
) → Future< HyperDeckRestResponse> -
connectEvents(
{String path = '/event'}) → Future< HyperDeckEventSocket> -
currentClip(
) → Future< HyperDeckRestResponse> -
defaultTimelineVideoFormat(
) → Future< HyperDeckRestResponse> -
delete(
String path) → Future< HyperDeckRestResponse> -
discoveredNasHosts(
) → Future< HyperDeckRestResponse> -
displayFocusAssist(
String displayName) → Future< HyperDeckRestResponse> -
displayFrameGrids(
String displayName) → Future< HyperDeckRestResponse> -
displayLut(
String displayName) → Future< HyperDeckRestResponse> -
displays(
) → Future< HyperDeckRestResponse> -
displayZebra(
String displayName) → Future< HyperDeckRestResponse> -
eventList(
) → Future< HyperDeckRestResponse> -
externalMedia(
) → Future< HyperDeckRestResponse> -
falseColor(
String displayName) → Future< HyperDeckRestResponse> -
focusAssist(
) → Future< HyperDeckRestResponse> -
formatMediaDevice(
String deviceName, {required String key, required String filesystem, String? volume}) → Future< HyperDeckRestResponse> -
formatSupportedFilesystems(
) → Future< HyperDeckRestResponse> -
frameGrids(
) → Future< HyperDeckRestResponse> -
frameGuide(
String displayName) → Future< HyperDeckRestResponse> -
frameGuideRatio(
) → Future< HyperDeckRestResponse> -
frameGuideRatioPresets(
) → Future< HyperDeckRestResponse> -
get(
String path) → Future< HyperDeckRestResponse> -
identify(
bool enabled) → Future< HyperDeckRestResponse> -
inputVideoFormat(
) → Future< HyperDeckRestResponse> -
inputVideoSource(
) → Future< HyperDeckRestResponse> -
isPlaying(
) → Future< HyperDeckRestResponse> -
isRecordCacheEnabled(
) → Future< HyperDeckRestResponse> -
isStopped(
) → Future< HyperDeckRestResponse> -
mediaDevice(
String deviceName) → Future< HyperDeckRestResponse> -
nasBookmark(
String url) → Future< HyperDeckRestResponse> -
nasBookmarks(
) → Future< HyperDeckRestResponse> -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
play(
) → Future< HyperDeckRestResponse> -
playback(
) → Future< HyperDeckRestResponse> -
playDeprecated(
) → Future< HyperDeckRestResponse> -
post(
String path, [Object? body]) → Future< HyperDeckRestResponse> -
prepareFormat(
String deviceName) → Future< HyperDeckRestResponse> -
product(
) → Future< HyperDeckRestResponse> -
put(
String path, [Object? body]) → Future< HyperDeckRestResponse> -
reboot(
) → Future< HyperDeckRestResponse> -
rebuildTimeline(
) → Future< HyperDeckRestResponse> -
record(
[String? clipName]) → Future< HyperDeckRestResponse> -
recordAudioFormat(
) → Future< HyperDeckRestResponse> -
recordCache(
) → Future< HyperDeckRestResponse> -
recordFilenameConfiguration(
) → Future< HyperDeckRestResponse> -
recording(
) → Future< HyperDeckRestResponse> -
recordSpillOrder(
) → Future< HyperDeckRestResponse> -
recordTrigger(
) → Future< HyperDeckRestResponse> -
removeNasBookmark(
String url) → Future< HyperDeckRestResponse> -
removeTimelineClip(
int timelineClipIndex) → Future< HyperDeckRestResponse> -
request(
String method, String path, {Object? body, Map< String, String> ? headers}) → Future<HyperDeckRestResponse> -
selectedExternalMedia(
) → Future< HyperDeckRestResponse> -
selectedNasBookmark(
) → Future< HyperDeckRestResponse> -
selectExternalMedia(
String deviceName) → Future< HyperDeckRestResponse> -
selectNasBookmark(
String? url) → Future< HyperDeckRestResponse> -
setActiveMedia(
int workingsetIndex) → Future< HyperDeckRestResponse> -
setCleanFeed(
String displayName, bool enabled) → Future< HyperDeckRestResponse> -
setCodecFormat(
Map< String, Object?> format) → Future<HyperDeckRestResponse> -
setDefaultTimelineVideoFormat(
Map< String, Object?> format) → Future<HyperDeckRestResponse> -
setDisplayFocusAssist(
String displayName, Map< String, Object?> settings) → Future<HyperDeckRestResponse> -
setDisplayFrameGrids(
String displayName, bool enabled) → Future< HyperDeckRestResponse> -
setDisplayLut(
String displayName, bool enabled) → Future< HyperDeckRestResponse> -
setDisplayZebra(
String displayName, bool enabled) → Future< HyperDeckRestResponse> -
setFalseColor(
String displayName, bool enabled) → Future< HyperDeckRestResponse> -
setFocusAssist(
Map< String, Object?> settings) → Future<HyperDeckRestResponse> -
setFrameGrids(
List< String> grids) → Future<HyperDeckRestResponse> -
setFrameGuide(
String displayName, bool enabled) → Future< HyperDeckRestResponse> -
setFrameGuideRatio(
String ratio) → Future< HyperDeckRestResponse> -
setInputVideoSource(
String source) → Future< HyperDeckRestResponse> -
setPlayback(
Map< String, Object?> value) → Future<HyperDeckRestResponse> -
setRecordAudioFormat(
{required String codec, required int numChannels}) → Future< HyperDeckRestResponse> -
setRecordCacheEnabled(
bool enabled) → Future< HyperDeckRestResponse> -
setRecordFilenameConfiguration(
Map< String, Object?> configuration) → Future<HyperDeckRestResponse> -
setRecording(
bool recording, {String? clipName}) → Future< HyperDeckRestResponse> -
setRecordTrigger(
String trigger) → Future< HyperDeckRestResponse> -
setTimelinePlayRange(
Map< String, Object?> ? playRange) → Future<HyperDeckRestResponse> -
setTimelineVideoFormat(
Map< String, Object?> format) → Future<HyperDeckRestResponse> -
setTransportMode(
String mode) → Future< HyperDeckRestResponse> -
setVideoFormat(
Map< String, Object?> format) → Future<HyperDeckRestResponse> -
setZebraLevel(
int level) → Future< HyperDeckRestResponse> -
spillRecordingToNewFile(
) → Future< HyperDeckRestResponse> -
spillRecordingToNextDevice(
) → Future< HyperDeckRestResponse> -
stop(
) → Future< HyperDeckRestResponse> -
stopDeprecated(
) → Future< HyperDeckRestResponse> -
supportedCodecFormats(
) → Future< HyperDeckRestResponse> -
supportedInputVideoSources(
) → Future< HyperDeckRestResponse> -
supportedRecordAudioFormats(
) → Future< HyperDeckRestResponse> -
supportedVideoFormats(
) → Future< HyperDeckRestResponse> -
supportedZebraLevels(
) → Future< HyperDeckRestResponse> -
system(
) → Future< HyperDeckRestResponse> -
timecode(
) → Future< HyperDeckRestResponse> -
timecodeSource(
) → Future< HyperDeckRestResponse> -
timeline(
) → Future< HyperDeckRestResponse> -
timelinePlayRange(
) → Future< HyperDeckRestResponse> -
timelineVideoFormat(
) → Future< HyperDeckRestResponse> -
toString(
) → String -
A string representation of this object.
inherited
-
transport(
) → Future< HyperDeckRestResponse> -
updateNasBookmark(
String url, {String? username, String? password}) → Future< HyperDeckRestResponse> -
uptime(
) → Future< HyperDeckRestResponse> -
videoFormat(
) → Future< HyperDeckRestResponse> -
workingSet(
) → Future< HyperDeckRestResponse> -
zebra(
) → Future< HyperDeckRestResponse>
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited