MimiProcessingSession

public protocol MimiProcessingSession : CustomDebugStringConvertible

Protocol that represents an active Mimi Processing session.

A MimiProcessingSession provides access to the processing parameters and state for an active session. It is responsible for managing the lifecycle of the session, including suspension and resumption, and provides access to sound personalization features.

  • id

    Unique identifier for the processing session.

    Declaration

    Swift

    var id: String { get }
  • metadata

    Metadata of the Mimi Processor.

    Declaration

    Swift

    var metadata: MimiProcessorMetadata? { get }
  • soundPersonalization

    The sound personalization feature associated with this session, if available.

    Declaration

    Swift

    var soundPersonalization: MimiSoundPersonalizationFeature? { get }
  • voiceClarity

    The voice clarity feature controller associated with this session, if available.

    Provides activation/deactivation control over the voice clarity feature on the processor and publishes the wrapped MimiVoiceClarityFeature while the feature is running.

    This property is non-nil if and only if the session was constructed with voice-clarity data.

    See also

    MimiProcessingFeatureControlling, MimiVoiceClarityFeature
    Declaration

    Swift

    var voiceClarity: AnyMimiProcessingFeatureControlling<MimiVoiceClarityFeature>? { get }
  • isSuspendedPublisher

    A publisher that emits the suspension state of the session.

    Emits true if the session is suspended, false otherwise.

    Declaration

    Swift

    var isSuspendedPublisher: AnyPublisher<Bool, Never> { get }
  • isSuspended

    Indicates whether the processing session is currently suspended.

    This property reflects the latest value emitted by isSuspendedPublisher. Returns true if the session is suspended, or false if it is active.

    Declaration

    Swift

    var isSuspended: Bool { get }
  • suspend()

    Suspends a processing session.

    Attempts to suspend the current processing session until resumed by calling resume().

    Declaration

    Swift

    func suspend() async throws -> Bool
    Return Value

    A Boolean indicating the suspension state: true if the session is suspended, false if the session remains active.

  • resume()

    Resumes a suspended processing session.

    Attempts to resume the processing session by restoring its previous state.

    Declaration

    Swift

    func resume() async throws -> Bool
    Return Value

    A Boolean indicating the suspension state: true if the session remains suspended, false if the session is resumed.