capturesdk library

Classes

AppInfo

This is the app information used to access the API. These credentials are generated when you register your app on the Socket Mobile website.

ButtonsState

The mask to apply for each button that is pressed

Capture

The main entrypoint for Socket Mobile CaptureSDK. Where connection to Capture library is initiated, maintained and through which requests are made.

CaptureEvent

Response from the capture library based on user interaction. When you use the scanner to scan a barcode, you will recieve a CaptureEvent of the decoded data.

CaptureEventIds

The different types of IDs used to differentiate different types of capture events.

CaptureEventTypes

CapturePlugin

CaptureProperty

Class for properties recieved/submitted in requests to Capture library. Capture properties can represent a device name, device type, monitor mode, etc.

CapturePropertyIds

Ids associated with different properties in capture events.

CapturePropertyTypes

CaptureVersion

What version of capture is being used.

ConnectBeepConfig

The connect beep configuration allows to turn off or on the connection beep when the scanner connects

ConnectReason

defines the reason as of how the device connects to the host

Counter

identifiers for the statistic counters

DataConfirmationBeep

Define the sound for data confirmation

DataConfirmationLed

Define the LED for data confirmation

DataConfirmationMode

Data Confirmation Mode indicates what is expected to the send the Data ACK back to the scanner

DataConfirmationRumble

Define the rumble for data confirmation

DataFormat

Identifies the data format the device should send the data to the host

DataSource

Where the event data stems from.

DataSourceIos

Datasource interface to map to datasource class to iOS via pigeon.

DecodedData

Data recieved from a device scan; response from device scan will be a capture event containing decoded data.

DeletePairing

Delete the pairing of the device

DeviceDataAcknowledgment

Device Data Acknowledgment mode

DeviceInfo

Basic properties for a paired or stored device.

Disconnect

Disconnect parameters to instruct the device what to do after disconnection

Flash

Define the flash setting

HttpTransport

Main transport for establishing and making requests on Android. utilizing json rpc as well as Websockets to establish channel.

IosAppInfo

App info class specifically for iOS.

IosTransport

Extends HostApi class as metadata . This file is meant to define a communication interface used to connect our existing classes to iOS.

IosTransportAdaptor

iOS counterpart for HttpTransport. Given that iOS doesn't require HTTP and we leverage the existing iOS library we have a separate and unique transport builder for iOS.

IosTransportHandle

Handle class specifically for iOS.

IosTransportNotification

Establishes event channel using StreamSubscription. Returns a capture event and establishes channel listener.

IosTransportResult

Transport result class pecifically for iOS.

JRpcRequest

JRpcResponse

JsonRpc

LassoDeviceStatus

Define the Lasso experience

LocalDecodeAction

Define the action for a local decode

Logger

Used to establish logging capability for developers. Optional to use but provides typified interface for custom logging and stack tracing.

MonitorDbg

Define the monitor feature (DEBUG build only)

Notifications

Configuration masks for selecting the notifications the device should send to the host

Params

Used in requests as well as storing device or property details.

PowerState

Define the possible power states

ProfileConfig

Configure a profile for the device (None, Acceptor, Initiator)

ProfileSelect

Select a profile for the device (None, SPP, HID, Reader, Coupler)

Property

Property interface to map to property class to iOS via pigeon.

RumbleActionType

Rumble configuration for the a type of action

SecurityMode

Security Mode

SktErrors

defines the Errors used in Capture

SocketCam

Define the SocketCam experience

SoundActionType

sound configuration for the a type of action

SoundFrequency

Sound frequency configuration

StandConfig

The stand configuration defines the operational mode of the device when used with a stand.

StartUpRoleSpp

The start up role SPP defines the start up role when using the SPP profile.

ThemeSelection

The mask to apply for each theme

ThemeSelectionMask

Mask for the Theme selection property. It applies the theme selection on the given device(s) set with the mask

Timer

Identifies the timers used in the device, (trigger lock, disconnected, connected)

Transport

Initial transport Interface. Here is where we check the operating system and determine which subclass transport to use (HttpTransport or IosTransport)

Trigger

trigger parameter

TriggerMode

defines the operational mode of the device

Version

Version interface to map to version class to iOS via pigeon.

Constants

SocketCamTypes → const List<int>

Properties

defaultHost ↔ String

getter/setter pair

defaultLogger ↔ Logger

getter/setter pair

Functions

capturePropertyFromProperty(Property prop) → CaptureProperty

Helper for determining which property should be assigned to the value (used in response) property.

convertFromPlatformException(dynamic exception, String? method, String? type) → CaptureException

Converting a platform exception to a generic CaptureException.

propertyFromCaptureProperty(CaptureProperty prop) → Property

Helper for determining which property generic value (from response) should be assigned to.

Exceptions / Errors

CaptureException

Wraps any errors in a uniform class to ensure user only has to check for one data type and one set of properties.