MimiProcessingController

public protocol MimiProcessingController : AnyObject

Controller that provides access to Mimi Processing.

  • Currently active processing session.

    This publisher is nil when there is no activated processing session. A session can be activated with the activate(configuration:) function.

    Declaration

    Swift

    var sessionPublisher: AnyPublisher<MimiProcessingSession?, Never> { get }
  • The session publisher value.

    Declaration

    Swift

    var session: MimiProcessingSession? { get }
  • Activate a new Processing Session.

    A processing session should be activated when an application requires access to Mimi Processing.

    For example, to activate a processing session for FineTuning personalization:

    let config = mimiProcessingConfiguration {
        Personalization {
            FineTuning(fitting: MimiPersonalization.Fitting(...))
        }
    }
    
    let session = try await activate(configuration: config)
    

    Warning

    If a session has already been activated this function will throw an error.

    Declaration

    Swift

    func activate(configuration: MimiProcessingConfiguring) async throws -> MimiProcessingSession
    Parameters
    configuration

    Configuration for the processing session.

  • Deactivate the current processing session if one is activated.

    Warning

    This will destroy the active session and mean that it is no longer updated or valid.
    Declaration

    Swift

    func deactivate() async