com.oscleton.sdk.configuration / Configuration

Configuration

class Configuration

Configuration is responsible for the SDK settings, like the IP address in order to establish the connection between the Android device and the computer running Live.

Since 0.1

Properties

Name	Summary
liveVersion	`val ~~liveVersion~~: Observable<String>` Live software version
onComputerIPDiscoveryCancel	`val ~~onComputerIPDiscoveryCancel~~: Observable<Empty>` Discovery cancel message in response of cancelComputerIPDiscovery call.
onComputerIPDiscoveryError	`val ~~onComputerIPDiscoveryError~~: Observable<String>` Discovery error message in response of startComputerIPDiscovery call.
onComputerIPDiscoveryProgress	`val ~~onComputerIPDiscoveryProgress~~: Observable<Float>` Discovery progress indicator in response of startComputerIPDiscovery call, from 0 to 1.
onComputerIPDiscoveryStart	`val ~~onComputerIPDiscoveryStart~~: Observable<Empty>` Discovery start message in response of startComputerIPDiscovery call.
onComputerIPDiscoverySuccess	`val ~~onComputerIPDiscoverySuccess~~: Observable<String>` Discovery success message in response of startComputerIPDiscovery call.
onConnectionError	`val ~~onConnectionError~~: Observable<String>` Connection error message in response of setComputerIP call.
onConnectionSuccess	`val ~~onConnectionSuccess~~: Observable<Empty>` Connection success message in response of setComputerIP call.
onQuit	`val ~~onQuit~~: Observable<Empty>` Message sent when Live quits.
onStart	`val ~~onStart~~: Observable<Empty>` Message sent when Live starts.
scriptVersion	`val ~~scriptVersion~~: Observable<String>` Oscleton MIDI Remote Script version in Live
sdkVersion	`val ~~sdkVersion~~:String` Oscleton SDK version

Functions

Name	Summary
cancelComputerIPDiscovery	`fun cancelComputerIPDiscovery():Unit` Cancel the current computer IP discovery.
disableLiveParameters	`fun disableLiveParameters(parameters:List<String>):Unit` Disable a list of LiveParameter so they won't be emitted by ReactiveReceiver or CallbackReceiver. Useful in case of breaking changes due to Oscleton SDK / MIDI Remote Script version incompatibility to avoid unstable SDK behaviors.
enableAllLiveParameters	`fun enableAllLiveParameters():Unit` Enable all LiveParameters so they will be emitted by ReactiveReceiver or CallbackReceiver. Useful after having been disabled in case of breaking changes due to Oscleton SDK / MIDI Remote Script version incompatibility.
removeOnComputerIPDiscoveryCancelListener	`fun ~~removeOnComputerIPDiscoveryCancelListener~~():Unit` Remove the current OnComputerIPDiscoveryCancelListener.
removeOnComputerIPDiscoveryErrorListener	`fun ~~removeOnComputerIPDiscoveryErrorListener~~():Unit` Remove the current OnComputerIPDiscoveryErrorListener.
removeOnComputerIPDiscoveryProgressListener	`fun ~~removeOnComputerIPDiscoveryProgressListener~~():Unit` Remove the current OnComputerIPDiscoveryProgressListener.
removeOnComputerIPDiscoveryStartListener	`fun ~~removeOnComputerIPDiscoveryStartListener~~():Unit` Remove the current OnComputerIPDiscoveryStartListener.
removeOnComputerIPDiscoverySuccessListener	`fun ~~removeOnComputerIPDiscoverySuccessListener~~():Unit` Remove the current OnComputerIPDiscoverySuccessListener.
removeOnConnectionErrorListener	`fun ~~removeOnConnectionErrorListener~~():Unit` Remove the current OnConnectionErrorListener.
removeOnConnectionSuccessListener	`fun ~~removeOnConnectionSuccessListener~~():Unit` Remove the current OnConnectionSuccessListener.
removeOnQuitListener	`fun ~~removeOnQuitListener~~():Unit` Remove the current OnQuitListener.
removeOnStartListener	`fun ~~removeOnStartListener~~():Unit` Remove the current OnStartListener.
set	`fun ~~set~~(listener:OnStartListener):Unit` Register a callback to be invoked when Ableton Live starts`fun ~~set~~(listener:OnQuitListener):Unit` Register a callback to be invoked when Ableton Live quits`fun ~~set~~(listener:OnConnectionSuccessListener):Unit` Register a callback to be invoked when the mobile device is connected to the computer running Ableton Live.`fun ~~set~~(listener:OnConnectionErrorListener):Unit` Register a callback to be invoked when the connection to the computer running Ableton Live failed.`fun ~~set~~(listener:OnComputerIPDiscoveryStartListener):Unit` Register a callback to be invoked when the computer IP discovery starts in order to connect automatically to the computer running Ableton Live.`fun ~~set~~(listener:OnComputerIPDiscoveryProgressListener):Unit` Register a callback to be invoked when the computer IP discovery progress updates, from 0 to 1.`fun ~~set~~(listener:OnComputerIPDiscoverySuccessListener):Unit` Register a callback to be invoked when the computer IP discovery succeeded to connect automatically to the computer running Ableton Live.`fun ~~set~~(listener:OnComputerIPDiscoveryErrorListener):Unit` Register a callback to be invoked when the computer IP discovery failed to connect automatically to the computer running Ableton Live.`fun ~~set~~(listener:OnComputerIPDiscoveryCancelListener):Unit` Register a callback to be invoked when the computer IP discovery is cancelled.
setAppTrack	`fun setAppTrack(appTrack:String):Unit` Set the application track used for the Oscleton MIDI Remote Script auto-update process. This also sets the application platform as "android".
setComputerIP	`fun setComputerIP(ip:String):SDKResult` Set the computer IP address in order to send actions.
startComputerIPDiscovery	`fun startComputerIPDiscovery():SDKResult` Start the computer IP discovery in order to connect automatically to the computer running Ableton Live.

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.