MimiProcessingSession

public final class MimiProcessingSession

extension MimiProcessingSession: CustomDebugStringConvertible

Object that represents the lifecycle of Mimi Processing availiability.

Once activated by a MimiProcessingController the session becomes the focal point for accessing processing parameters and state.

Properties

isInterrupted
Whether the processing session is currently interrupted.
Declaration
Swift

@Published public var isInterrupted: Bool { get set }
isEnabled
Parameter that describes whether processing is currently enabled.
Declaration
Swift

public var isEnabled: MimiProcessingParameter<Bool> { get }
intensity
Parameter that describes the current intensity value of processing.
Declaration
Swift

public let intensity: MimiProcessingParameter<Float>
preset
Parameter that describes the currently applied preset for processing if one is available.
Declaration
Swift

public let preset: MimiRemoteProcessingParameter<MimiPersonalization.Preset?>
presetDataSource
Data source which provides remote preset data to the preset parameter.
Declaration
Swift

public let presetDataSource: MimiPresetParameterDataSource

Interruptions


                    
                    
                    interrupt(reason:)

Interrupt a processing session.

This will attempt to disable the isEnabled processing parameter which shall remain disabled until the interruption has been resolved by calling resolve(interruption:).

Declaration

Swift

public func interrupt<T>(reason: T) -> AnyPublisher<Bool, Error> where T : Hashable

Parameters


                                reason

An instance of MimiProcessingSessionInterruption

Return Value

Publisher that wraps the the state of the interruption where true represents an interrupted and false an uninterrupted session.


                    
                    
                    resolve(interruption:)

Resolve an interrupted processing session.

This will attempt to set the isEnabled processing parameter with the value that was applied before the session was interrupted.

Declaration

Swift

public func resolve<T>(interruption: T) -> AnyPublisher<Bool, Error> where T : Hashable

Parameters


                                interruption

The interruption to resolve.

Return Value

Publisher that wraps the the state of the interruption where true represents an interrupted and false an uninterrupted session.