animatedledstrip-core/animatedledstrip.communication/ClientParams

ClientParams

data class ClientParams(var sendDefinedAnimationInfoOnConnection: Boolean = true, var sendRunningAnimationInfoOnConnection: Boolean = true, var sendSectionInfoOnConnection: Boolean = true, var sendStripInfoOnConnection: Boolean = true, var sendAnimationStart: MessageFrequency = MessageFrequency.IMMEDIATE, var sendAnimationEnd: MessageFrequency = MessageFrequency.IMMEDIATE, var sendSectionCreation: MessageFrequency = MessageFrequency.IMMEDIATE, var sendLogs: Boolean = false, var bufferedMessageInterval: Long = 500) : SendableData

Settings for a server-client connection.

This should be sent by the client to the server to initialize the connection.

Constructors

ClientParams

constructor(sendDefinedAnimationInfoOnConnection: Boolean = true, sendRunningAnimationInfoOnConnection: Boolean = true, sendSectionInfoOnConnection: Boolean = true, sendStripInfoOnConnection: Boolean = true, sendAnimationStart: MessageFrequency = MessageFrequency.IMMEDIATE, sendAnimationEnd: MessageFrequency = MessageFrequency.IMMEDIATE, sendSectionCreation: MessageFrequency = MessageFrequency.IMMEDIATE, sendLogs: Boolean = false, bufferedMessageInterval: Long = 500)

Properties

bufferedMessageInterval

var bufferedMessageInterval: Long

If any data is set to be sent in regular intervals (MessageFrequency.INTERVAL), how long in milliseconds should the server wait between sends?

sendAnimationEnd

var sendAnimationEnd: MessageFrequency

Should the server send a message whenever an animation is stopped? (See MessageFrequency)

sendAnimationStart

var sendAnimationStart: MessageFrequency

Should the server send a message whenever a new animation is started? (See MessageFrequency)

sendDefinedAnimationInfoOnConnection

var sendDefinedAnimationInfoOnConnection: Boolean

Should the server send information about all supported animations to the client when this is received?

sendLogs

var sendLogs: Boolean

Should the server send log outputs to the client?

sendRunningAnimationInfoOnConnection

var sendRunningAnimationInfoOnConnection: Boolean

Should the server send information about all currently running animations to the client when this is received?

sendSectionCreation

var sendSectionCreation: MessageFrequency

Should the server send a message whenever a new strip section is created? (See MessageFrequency)

sendSectionInfoOnConnection

var sendSectionInfoOnConnection: Boolean

Should the server send information about all currently defined strip sections to the client when this is received?

sendStripInfoOnConnection

var sendStripInfoOnConnection: Boolean

Should the server send information about the strip to the client when this is received?

Functions

json

open fun json(): ByteArray

jsonString

open fun jsonString(): String

jsonStringWithDelimiter

open fun jsonStringWithDelimiter(): String

jsonWithDelimiter

open fun jsonWithDelimiter(): ByteArray