libprocessing/io.mimi.sdk.processing

Package-level declarations

Types

MimiApplicatorResult

sealed class MimiApplicatorResult

Defines the result of a Applicator application attempt.

MimiPresetParameterDataSource

fun interface MimiPresetParameterDataSource : MimiProcessingParameterDataSource<Personalization.PersonalizationPreset?>

Defines how a Preset MimiProcessingParameter has its value updated.

MimiProcessingParameter

interface MimiProcessingParameter<T>

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

MimiProcessingParameterDataSource

fun interface MimiProcessingParameterDataSource<T>

Defines how a MimiProcessingParameter has its value updated.

ProcessingParameterApplicatorFailedException

class ProcessingParameterApplicatorFailedException : Exception

Used as ProcessingParameterResult.Failure.cause when a Applicator fails to apply an update.

ProcessingParameterDataSourceException

class ProcessingParameterDataSourceException : Exception

Used as ProcessingParameterResult.Failure.cause when a MimiProcessingParameter fails to retrieve from its asynchronous data source.

ProcessingParameterDataSourceUndefinedException

class ProcessingParameterDataSourceUndefinedException : Exception

Used as ProcessingParameterResult.Failure.cause when a MimiProcessingParameter fails to retrieve from its asynchronous data source because the Parameter does not have a MimiProcessingParameterDataSource.

ProcessingParameterRefusedException

class ProcessingParameterRefusedException : Exception

Used as ProcessingParameterResult.Failure.cause when a MimiProcessingParameter indicates that it cannot apply an update.

ProcessingParameterResult

sealed class ProcessingParameterResult

Result class that contains the status of update process from an MimiProcessingParameter class. Status is Success, if value is successfully applied, otherwise the status is a Failure.

ProcessingParameterState

data class ProcessingParameterState<T>(val value: T, val updateState: ProcessingParameterUpdateState<T>)

Represents the state of a io.mimi.sdk.processing.MimiProcessingParameter.

ProcessingParameterUpdateState

interface ProcessingParameterUpdateState<out T>

Represents the update state of a io.mimi.sdk.processing.MimiProcessingParameter value applicable sequence.

ProcessingSession

class ProcessingSession @MsdkInternalApi constructor(val soundPersonalization: SoundPersonalizationFeature? = null, val voiceClarity: VoiceClarityFeature? = null)

Holds the MimiProcessingParameter instances, providing access to control Mimi Personalization Processing.