MimiConfiguration

public struct MimiConfiguration
extension MimiConfiguration: Equatable

Object which can be used to configure and customize various Mimi features and functionality.

  • Whether to show additional tips for maintaining and improving hearing health.

    Note

    Hearing Health Tips are region specific and may not be available in all regions.
    Declaration

    Swift

    public let showHearingHealthTips: Bool
  • Whether to always show Hearing Test results if available.

    Note

    This will ensure that Hearing Results will be displayed in the Mimi Profile when they are available.

    Warning

    This might potentially impact your legal situation.
    Declaration

    Swift

    @available(*, deprecated)
    public let alwaysShowHearingResults: Bool
  • Whether to support authorizing remote Mimi compatible devices.

    Enabling this will display UI to support remote device authorization in the Mimi Profile.

    Warning

    To use this you must have an entry for NSCameraUsageDescription in your Info.plist.
    Declaration

    Swift

    public let allowRemoteDeviceAuthorization: Bool
  • Create new configuration.

    Declaration

    Swift

    @available(*, deprecated)
    public init(showHearingHealthTips: Bool,
                alwaysShowHearingResults: Bool,
                allowRemoteDeviceAuthorization: Bool)
    Parameters
    showHearingHealthTips

    Whether to show additional tips for maintaining and improving hearing health.

    alwaysShowHearingResults

    Whether to always show Hearing Test results if available.

    allowRemoteDeviceAuthorization

    Whether to support authorizing remote Mimi compatible devices.

  • Create new configuration.

    Declaration

    Swift

    public init(showHearingHealthTips: Bool,
                allowRemoteDeviceAuthorization: Bool)
    Parameters
    showHearingHealthTips

    Whether to show additional tips for maintaining and improving hearing health.

    allowRemoteDeviceAuthorization

    Whether to support authorizing remote Mimi compatible devices.

  • Declaration

    Swift

    public static func == (lhs: MimiConfiguration, rhs: MimiConfiguration) -> Bool