Skip to content

CLASS

OSConfiguration

public class OSConfiguration: NSObject

OSConfiguration 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

sdkVersion

public var sdkVersion: String

Oscleton SDK version

  • Returns: the Oscleton SDK version
  • Since: 0.1

liveVersion

public var liveVersion: Observable<String>

Live software version

  • Returns: the Live software version
  • Since: 0.1

scriptVersion

public var scriptVersion: Observable<String>

Oscleton MIDI Remote Script version in Live

  • Returns: the Oscleton MIDI Remote Script version
  • Since: 0.1

onConnectionSuccess

public var onConnectionSuccess: Observable<Bool>

Connection success message in response of setComputerIP: call.

@return Connection success message @since 0.2 @see setComputerIP

Methods

setComputerIP(ip:)

public func setComputerIP(ip: String) -> OSResult

Set the computer IP address in order to send actions.

NB: The default port is 9000.

  • Parameter ip: the IP address of the computer running Ableton Live
  • Returns: the SDK result
  • Since: 0.1

Parameters

Name Description
ip the IP address of the computer running Ableton Live

setOnConnectionSuccessCallback(onSuccess:)

public func setOnConnectionSuccessCallback(onSuccess: @escaping () -> Void)

Register a callback to be invoked when the mobile device is connected to the computer running Ableton Live.

  • Parameter onSuccess: The callback that will run
  • Since: 0.2

Parameters

Name Description
onSuccess The callback that will run

removeOnConnectionSuccessCallback()

public func removeOnConnectionSuccessCallback()

Remove the connection success callback.

  • Since: 0.2