Capture class
The main entrypoint for Socket Mobile CaptureSDK. Where connection to Capture library is initiated, maintained and through which requests are made.
Constructors
Properties
- clientOrDeviceHandle ↔ int?
-
getter/setter pair
- guid → dynamic
-
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- host ↔ String
-
getter/setter pair
- iOS ↔ bool?
-
getter/setter pair
- logger ↔ Logger?
-
getter/setter pair
- onEventNotification ↔ Function?
-
getter/setter pair
- rootCapture ↔ Capture?
-
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- transport ↔ Transport?
-
getter/setter pair
- transportHandle ↔ int?
-
getter/setter pair
Methods
-
close(
[int? handle]) → Future< int> - close capture connection. Remove any handles and reset root transport and capture.
-
getProperty(
CaptureProperty property) → Future< CaptureProperty> - Request to retrieve a capture property from a given device.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
openClient(
AppInfo appInfo, Function eventNotification, [CaptureOptions? options]) → Future< int?> - Request that opens capture connection. Requires credentials to open capture client and establish connection to SDK. Starts transport initialization.
-
openDevice(
String guid, Capture? capture) → Future< int> - Initiate connection to open physical device. Set new root capture in order to work within device ecosystem. If successful, set clientOrDeviceHandle to response value and return code for 'no error' (0).
-
setProperty(
CaptureProperty property) → Future< CaptureProperty> - Request to update a capture property for a given device.
-
toJson(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
-
transportHelper(
AppInfo appInfo, Function eventNotification, [CaptureOptions? options]) → Future< int?> - Initialize transport for capture.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited