libcore/io.mimi.sdk.core/MimiCoreServices

MimiCoreServices

Definition of the MimiCore main public API; providing access to key functionality such as authentication, personalization and test management. It handles all aspects of communication with the Mimi API, providing a robust framework that can be used to integrate an app into the Mimi eco-system.

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

Since

5.0.0

Inheritors

MimiCore

Properties

allowsUsageDataCollection

abstract var allowsUsageDataCollection: Boolean

Whether collection of MSDK usage data is enabled for Mimi.

configuration

abstract val configuration: MimiConfiguration

Mimi configuration

groupController

abstract val groupController: GroupController

Group Controller class offering all the methods related with Group Personalization

personalizationController

abstract val personalizationController: PersonalizationController

Personalization Controller class in charge of loading Mimi presets from the backend

processingController

abstract val processingController: ProcessingController

Processing Controller class acting as a middle man between all the different controllers and the processing handler, which is ultimately the final responsible for the processing

testsController

abstract val testsController: TestsController

User Controller class in charge of handling changes and operations related to the Mimi User object and its current authentication session

userController

abstract val userController: UserController

Tests Controller class offering all the methods related with Hearing Test handling

Functions

analytics

@MsdkInternalApi

abstract fun analytics(secret: String): AnalyticsService

Internal Analytics Service used by Mimi to collect MSDK usage data

dispose

abstract fun dispose()

Call dispose to ensure that all resources are properly disposed (e.g. canceling pending network requests).

setMimiEventsListener

abstract fun setMimiEventsListener(mimiEvents: MimiEvents)

Sets the MimiEvents interface implementation necessary to listen to Mimi SDK related events

start

abstract fun start(context: Context, clientId: String, clientSecret: String, configuration: MimiConfiguration = MimiConfiguration())

Set up MimiCore for use with your client.