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

ProcessingParameter

interface ProcessingParameter<T>

Processing parameter

Since

5.0.0

Parameters

T

The parameter value type

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

Inheritors

MimiProcessingParameter

MimiFetchedProcessingParameter

Properties

abstract var deliveryMode: ParameterDeliveryMode

Defines how requests to update the ProcessingParameter value are performed.

abstract val value: T

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

Functions

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.

abstract suspend fun apply(value: T): ProcessingParameterResult

Apply

abstract suspend fun synchronize(): ProcessingParameterResult

Synchronize