Onyx class

Constructors

Onyx(OnyxSettings settings)

Properties

connected → bool
no setter
connecting → bool
no setter
cueListByNumber ↔ Map<int, OnyxCueList>
getter/setter pair
cueLists ↔ List<OnyxCueList>
getter/setter pair
favoriteCueListNumbers ↔ Set<int>
getter/setter pair
favoriteCueLists ↔ List<OnyxCueList>
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
settings ↔ OnyxSettings
getter/setter pair
sortCueListsBy ↔ OnyxSortPreference
getter/setter pair
status ↔ OnyxConnectionStatus
getter/setter pair
updates → Stream<bool>
no setter

Methods

boostHeartbeat(int boostSeconds) → void
speeds up the heartbeat for boostSeconds seconds
clearProgrammer() → Future<OnyxMessage?>
close() → Future
connect() → Future<bool>
-- PUBLIC FUNCTIONS THAT APPLY TO THIS INSTANCE
destroy() → Future
@deprecated, use close instead
disconnect() → Future<OnyxMessage?>
doHeartbeat() → void
flagCueListAsFavorite(OnyxCueList cueList, [bool isFavorite = true]) → void
Will track this onyx cuelist as a favorite one. Favorites will persist reconnects, but they will be lost when this class instance is destroyed.
getActionList() → Future<OnyxMessage?>
getActionName(String actionNumber) → Future<String>
getActiveCueLists() → Future<OnyxMessage?>
getAvailableCueLists() → Future<OnyxMessage?>
getCommandList() → Future<OnyxMessage?>
getCommandName(String commandNumber) → Future<String>
getCueListName(String cueListNumber) → Future<String>
WARNING: DOES NOT WORK with some versions of Onyx command will probably timeout
getHelp() → Future<OnyxMessage?>
getRecentLog(String numLines) → Future<OnyxMessage?>
getScheduleList() → Future<OnyxMessage?>
getScheduleName(String scheduleNumber) → Future<String>
getStatus() → Future<OnyxMessage?>
getTimePresets() → Future<OnyxMessage?>
isCueListActive(OnyxCueList cueList) → Future<bool>
isMxRun() → Future<bool>
isSchRun() → Future<bool>
loadCueLists() → Future<void>
resets the cuelists, flags them as favorite if they should be, and sorts
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
pauseCueList(OnyxCueList cueList) → Future<OnyxMessage?>
releaseAllCuelists() → Future<OnyxMessage?>
releaseAllCuelistsAndOverrides() → Future<OnyxMessage?>
releaseAllCuelistsAndOverridesDimFirst() → Future<OnyxMessage?>
releaseAllCuelistsDimFirst() → Future<OnyxMessage?>
releaseAllOverrides() → Future<OnyxMessage?>
releaseCueList(OnyxCueList cueList) → Future<OnyxMessage?>
resetHeartbeat([Duration? delay]) → void
sendCmd(String cmd, [bool andBoost = false]) → Future<OnyxMessage?>
andBoost will flag the heartbeat to poll Onyx more frequently
setCueListLevel(OnyxCueList cueList, String level) → Future<OnyxMessage?>
setDate(String yyyy, String mm, String dd) → Future<OnyxMessage?>
setPositionDecimal(double lat, double lon) → Future<OnyxMessage?>
setSchedulerToUseCalendar() → Future<OnyxMessage?>
setTime(String hh, String mm, String ss) → Future<OnyxMessage?>
setTimePreset(String presetNumber, String hh, String mm, String ss) → Future<OnyxMessage?>
startActionGroup(String groupNumber) → Future<OnyxMessage?>
======================================================= ONYX API COMMANDS START HERE These commands will return Futures for bool, string, or OnyxMessage
startHeartbeat() → void
stopHeartbeat() → void
toString() → String
A string representation of this object.
inherited
triggerCommand(String commandNumber) → Future<OnyxMessage?>
triggerCue(OnyxCueList cueList, int cueNumber) → Future<OnyxMessage?>
triggerCueList(OnyxCueList cueList) → Future<OnyxMessage?>
triggerSchedule(String scheduleNumber) → Future<OnyxMessage?>
updateActiveCueLists() → Future<void>
will make sure the cuelists are populated then will ask for all the active ones

Operators

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