📴 SoundModeManager 📳

Detect silent / ring mode on the device.

Languages
Platforms
CocoaPods
Build

Preview

🚀 Installation

CocoaPods

For usage and installation instructions, visit their website. To integrate AirKit into your Xcode project using CocoaPods, specify it in your Podfile:

pod 'SoundModeManager'

💻 Usage

Sound mode manager doesn’t work on simulators!

Create a new instance of manager:

import SoundModeManager

// Fully customized instance.
let manager = SoundModeManager(soundUrl: customSoundUrl, soundUpdatingInterval: 5)

// With custom sound file only.
let manager = SoundModeManager(soundUrl: customSoundUrl)

// With default silent sound and custom updating interval. 
let manager = SoundModeManager(soundUpdatingInterval: 5)

// Default manager configuration. 
let manager = SoundModeManager()

Update current mode once (not recommended):

import SoundModeManager

let manager = SoundModeManager()

// Mode is not determined by default.
manager.currentMode // SoundMode.notDetermined
        
// Update current mode and receive callback.
manager.updateCurrentMode { mode in
    // Mode is `.silent` or `.ring`
    manager.currentMode == mode // true
}

Observe current mode changes:

import SoundModeManager

let manager = SoundModeManager()

// Mode is not determined by default.
manager.currentMode // SoundMode.notDetermined

// Save token to manage observer and subscribe to receive changes.
let observationToken = sut.observeCurrentMode { mode in
    // Block will be called only when new mode is not the same as previous.  
    // Mode is `.silent` or `.ring`.
    manager.currentMode == mode // true
}

// Start observing current mode.
manager.beginUpdatingCurrentMode()

// End observing current mode. This method suspend all notification, but all observers are still valid.
manager.endUpdatingCurrentMode()

Invalidate observation token:

// Invalidate observation token is working the same as `NSKeyValueObservation`;
// So you are able to invalidate it manually if you need;
// Token will be invalidated automatically when it is deinited.  
observationToken.invalidate()

📜 License

Released under the MIT license. See LICENSE for details.

GitHub

View Github