General class

General Requests

Constructors

General(ObsWebSocket obsWebSocket)

Properties

hashCode int
The hash code for this object.
no setterinherited
hotkeyList Future<List<String>>
Gets an array of all hotkey names in OBS
no setter
obsWebSocket ObsWebSocket
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
stats Future<StatsResponse>
Gets statistics about OBS, obs-websocket, and the current session.
no setter
version Future<VersionResponse>
Gets data about the current plugin and RPC version.
no setter

Methods

broadcastCustomEvent(Map<String, dynamic> arg) Future<void>
Broadcasts a CustomEvent to all WebSocket clients. Receivers are clients which are identified and subscribed.
callVendorRequest({required String vendorName, required String requestType, RequestData? requestData}) Future<CallVendorRequestResponse>
Call a request registered to a vendor.
getHotkeyList() Future<List<String>>
Gets an array of all hotkey names in OBS
getStats() Future<StatsResponse>
Gets statistics about OBS, obs-websocket, and the current session.
getVersion() Future<VersionResponse>
Gets data about the current plugin and RPC version.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
obsBrowserEvent({required String eventName, dynamic eventData}) Future<CallVendorRequestResponse>
Helper method to send a VendorRequest specifically to the 'obs-browser' plugin.
sleep({int? sleepMillis, int? sleepFrames}) Future<void>
Sleeps for a time duration or number of frames. Only available in request batches with types SERIAL_REALTIME or SERIAL_FRAME.
toString() String
A string representation of this object.
inherited
triggerHotkeyByKeySequence({String? keyId, KeyModifiers? keyModifiers}) Future<void>
Triggers a hotkey using a sequence of keys.
triggerHotkeyByName(String hotkeyName) Future<void>

Operators

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