libcore/io.mimi.sdk.core.controller.processing/MimiProcessingParameter

MimiProcessingParameter

interface MimiProcessingParameter<T> : ProcessingParameter<T>

A standard ProcessingParameter.

Important: This interface is not stable for inheritance, as new methods may be added, but is stable for use.

Since

5.0.0

Parameters

The parameter value type

Properties

deliveryMode

abstract var deliveryMode: ParameterDeliveryMode

Defines how requests to update the ProcessingParameter value are performed.

value

abstract val value: T

The current value of the ProcessingParameter - it is the most recent successfully applied value.

Functions

addApplicator

abstract fun addApplicator(canApply: (value: T) -> Boolean, apply: suspend (value: T) -> Unit, applyTimeoutMillis: Long): MimiParameterApplicator

Adds an out-of-date MimiParameterApplicator to the ProcessingParameter.

abstract suspend fun addApplicator(value: T, canApply: (value: T) -> Boolean, apply: suspend (value: T) -> Unit, applyTimeoutMillis: Long): Pair<MimiParameterApplicator, ProcessingParameterResult>

Adds an already up-to-date MimiParameterApplicator to the ProcessingParameter and triggers a call to attempt to update all other MimiParameterApplicator with that value.

apply

abstract suspend fun apply(value: T): ProcessingParameterResult

Apply

observe

abstract suspend fun observe(tag: String? = null, applying: ApplyingHandler<T>? = null, failed: FailedHandler<T>? = null, ready: ReadyHandler<T>? = null)

Receives updates indicating the current state of the MimiProcessingParameter.

synchronize

abstract suspend fun synchronize(): ProcessingParameterResult

Synchronize