Skip to content

MimiSDK 11.0.0 Migration Guide

This document outlines the various changes required to migrate to MSDK 11.0.0 from an MSDK 10.x.x version.

What is new?

This major release focuses on improvements to the TestFlow, in particular the PTT test.

Due to these changes and the removal of past deprecations, some migration steps are required.

In most cases, these steps will be quite simple to perform.

Required Migrations

Replace connectedHeadphoneProvider with notifyMimiHeadphoneConnected

If you were previously using the io.mimi.sdk.core.controller.TestsController connectedHeadphoneProvider mechanism, it should be replaced by notifyMimiHeadphoneConnected.

Before

MimiCore.testsController.connectedHeadphoneProvider = MimiConnectedHeadphoneProvider { MimiHeadphoneIdentifier(model) }

After

MimiCore.testsController.notifyMimiHeadphoneConnected(MimiHeadphoneIdentifier(model))

Refer to our Supporting PTT Hearing Tests guide for more information.

Replace submitTestForResult() with submitTest()

The simplified the Hearing Test submission APIs in io.mimi.sdk.core.controller.TestsController now only have a single submitTest() function.

Replace any existing calls to submitTestForResult() with submitTest().

MimiTestResultIssue replaces MimiTestResultError

This class has been renamed to avoid confusion when classifying hearing test warning and errors.

References to MimiTestResultError should be replaced with MimiTestResultIssue.

MimiTestResultIssueReason replaces MTResultError and PTTResultError

MimiTestResultIssueReason now enumerates the various types of warnings and errors which can be received in response to submitting a hearing test.

References MTResultError and PTTResultError should be replaced.

MSDK 10.x - MTResultError MSDK 11.0.0 - MimiTestResultIssueReason
VISUALIZATION_COMPUTATION VisualizationComputation
VISUALIZATION_MISSING_DATA VisualizationMissingData
VALIDATION_MISSING_DATA ValidationMissingData
INSIGHT_COMPUTATION_FAILED InsightComputationFailed
MSDK 10.x - PTTResultError MSDK 11.0.0 - MimiTestResultIssueReason
VISUALIZATION_MISSING_FREQUENCY Removed
VISUALIZATION_OUT_OF_CALIBRATED_LIMITS Removed
MISSING_AUDIOGRAM Removed
MISSING_CENTER_FREQUENCY Removed
UNCALIBRATED_HEADPHONES UncalibratedHeadphones
LOUD_ENVIRONMENT LoudEnvironment

MimiTestResultIssueReason also includes new issue reasons:

  • UnsupportedTest
  • BluetoothAbsoluteVolumeUnknownHost
  • AudiogramTechnicalLimits
  • AudiogramThresholdsClipped
  • MissingPTA4
  • ReversalInterpolationError
  • Unknown is provided for forward compatibility with future new issue codes.

Removal of io.mimi.sdk.profile.MimiProfileLauncher.

The deprecated io.mimi.sdk.profile.MimiProfileLauncher has been removed. If you are still using it and need such functionality, then you are now required to implement your own equivalent UI component.

You should also remove references to the theming attribute; mimiLauncherCardCornerRadius from your app's custom theme.