Skip to content

com.oscleton.sdk / OscletonSDK

OscletonSDK

class OscletonSDK

The main entry point to use Oscleton SDK.

This singleton provides multiple features splitted in different classes:

  • Configuration is responsible for the settings needed to establish the connection.
  • Controller lets you control a Live set from your Android device.
  • Receiver lets you receive Live set events in real time on your Android device.

Since 0.1

Constructors

Name Summary
<init> OscletonSDK()
The main entry point to use Oscleton SDK.

Properties

Name Summary
config val config:Configuration
controller val controller:Controller
receiver val receiver:Receiver

Functions

Name Summary
connect fun connect():Unit
Connect the device and prepare to listen for incoming changes.
disconnect fun disconnect():Unit
Disconnect the device and close the incoming changes listener.
initialize fun initialize():Unit
Initialize the SDK.
startListening fun startListening():Unit
Start listening for incoming changes.
stopListening fun stopListening():Unit
Stop listening for incoming changes.

Companion Object Properties

Name Summary
instance val instance:OscletonSDK

Extension Properties

Name Summary
boolean valAny.boolean:Boolean
Extension property to cast an Any to Boolean.
float valAny.float:Float
Extension property to cast an Any to Float.
int valAny.int:Int
Extension property to cast an Any to Int.
string valAny.string:String
Extension property to cast an Any to String.