SOContext

abstract class SOContext(val name: String, val connectionType: ConnectionType, val inTopics: Iterable<TopicIn<*>>, val outTopics: Iterable<TopicOut<*>>, val fileTopics: Iterable<FileTopic> = emptyList())

Defines a context to be used / released within the SDK.

There are predefined contexts (which are defined as static inner classes of this abstract class), which can be used:

If you declare your own context (with a corresponding inside app to that), you need to create a context extending from this class, and then register the context in the SDK.

Parameters

name

the name of the context. This should be a unique name across all contexts.

connectionType

The ConnectionType which is needed for this SOContext. Context's should always prefer to use ConnectionType.BLE if possible, and only use ConnectionType.WIFI if a larger bandwidth is needed. This connectionType only specifies the minimum needed ConnectionType. This means, that if a context declares ConnectionType.BLE here, but the SOComm device is currently connected using ConnectionType.WIFI (or switched to WIFI during the use of this context), all data communication will be changed to use ConnectionType.WIFI as long as any context needs ConnectionType.WIFI.

inTopics

The TopicIns this context allows the SDK user to send to the SOComm device (publish items to the SOComm device).

outTopics

The TopicOuts this context allows the SDK user to receive from the SOComm device (subscribe to the SOComm device).

fileTopics

The list of FileTopic this context allows the SDK user to use. May only be set to a non-empty list, if connectionType is WIFI.

Inheritors

Constructors

Link copied to clipboard
constructor(name: String, connectionType: ConnectionType, inTopics: Iterable<TopicIn<*>>, outTopics: Iterable<TopicOut<*>>, fileTopics: Iterable<FileTopic> = emptyList())

Types

Link copied to clipboard

Context for controlling the display brightness.

Link copied to clipboard

Context for camera settings for all Inside Apps excluding the Open API Inside App.

Link copied to clipboard
object Companion
Link copied to clipboard

Context for Deployment.

Link copied to clipboard

Context for controlling the display appearance.

Link copied to clipboard

Context for Live Video Streaming to external devices.

Link copied to clipboard

Context for reading and adjusting the log.

Link copied to clipboard

Context for Open API using Wifi.

Link copied to clipboard

Context for Open API using BLE.

Link copied to clipboard

Context for transferring pictures.

Link copied to clipboard

Context for transferring picture previews.

Link copied to clipboard

Context for Deployment.

Link copied to clipboard

Context for public System Information.

Link copied to clipboard

Context for Steering App System Information.

Link copied to clipboard

Context for transferring pictures.

Link copied to clipboard

Context for transferring video previews.

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
open override fun toString(): String

Returns a human-readable string for the given SOContext, which contains the name of the context, as well as a list of all topics.