[iOS]電話がかかってきたとき、ヘッドホンジャックが抜かれたときの対応

（2021年10月更新。Xcode 13 + Swift 5 に書き改めました）

オーディオ系アプリで、電話がかかってきたとき、ヘッドフォンジャックが抜かれたときの対応。

電話がかかってきたとき、ヘッドホンが抜かれたときには、音楽を再生していた場合対処する必要があります。
電話がかかってきたとき、ヘッドホンが抜かれたときを検知して対応するには、Notification Centerを使った通知の仕組みを使います。

NotificationCenter – Foundation | Apple Developer Documentation
Notification centerにイベントを監視(Observe)するよう登録します。イベントからNotirication Centerに通知(Post Notification)があると、Notification Centerは、対応するメソッドを呼び出します。
今回は、割り込み(AVAudioSession.interruptionNotification)とルートチェンジ(AVAudioSession.routeChangeNotification)を監視するように記します。

こちらのドキュメントにそって、実装します。
Responding to Audio Session Route Changes | Apple Developer Documentation
Responding to Audio Session Interruptions | Apple Developer Documentation
このドキュメントによると、AVPlayerの場合は、適切なタイミングでポーズ・再開が行われます。
それ以外のオーディオ再生方法では、適切なポーズ・再開は自動的には行われません。
ですので、ポーズや再開は自前で実装する必要があります。またUIを適切なものに更新することも必要です。
(AVAudioPlayerに関しては、最初にこの記事を書いた2015年においては、ヘッドホンが抜かれたときに自動的に再生が止まった記憶があります。しかし、2019年6月現在、音楽が一旦途切れたあと再生されます。）
（実験したところ、電話などの割り込みの際には、現在のところ音楽はとまります。）

以下は、SpeechSynthesizerで音声を出力して、そのさいヘッドフォンをぬくと再生を止めるという実験です。ヘッドホンを抜き差しすると、メッセージラベルに状況が表示されます。

メッセージラベル、Speakボタン、Pauseボタンを貼り付けます。

メッセージラベルとViewControllerをOutletで結びます。
@IBOutlet weak var messageLabel: UILabel!

SpeakボタンとViewControllerをActionで結びます。
@IBAction func speakBtnTapped(_ sender: Any) 

PauseボタンとViewControllerをActionで結びます。
@IBAction func pauseBtnTapped(_ sender: Any)

ViewController.swift

import UIKit
import AVFoundation
import AVKit

class ViewController: UIViewController {

    @IBOutlet weak var messageLabel: UILabel!
    
    let syntherizer = AVSpeechSynthesizer()
    
    override func viewDidLoad() {
        super.viewDidLoad()
        // Do any additional setup after loading the view.
        
        addAudioSessionObservers()
        
    }
    
    // 電話による割り込みと、オーディオルートの変化を監視します
    func addAudioSessionObservers() {
        
        AVAudioSession.sharedInstance()
        
        let center = NotificationCenter.default
        center.addObserver(self, selector: #selector(handleInterruption(_:)), name: AVAudioSession.interruptionNotification, object: AVAudioSession.sharedInstance())
        center.addObserver(self, selector: #selector(audioSessionRouteChanged(_:)), name: AVAudioSession.routeChangeNotification, object: nil)
        
    }
    
    /// Interruption : 電話による割り込み
    @objc func handleInterruption(_ notification: Notification) {
        guard let userInfo = notification.userInfo,
            let typeValue = userInfo[AVAudioSessionInterruptionTypeKey] as? UInt,
            let type = AVAudioSession.InterruptionType(rawValue: typeValue) else {
                return
        }
        
        if type == .began {
            // interruptionが開始した時(電話がかかってきたなど)
        }
        else if type == .ended {
            // interruptionが終了した時の処理
            if let optionsValue = userInfo[AVAudioSessionInterruptionOptionKey] as? UInt {
                let options = AVAudioSession.InterruptionOptions(rawValue: optionsValue)
                if options.contains(.shouldResume) {
                    // Interruption Ended - playback should resume
                } else {
                    // Interruption Ended - playback should NOT resume
                }
            }
        }
    }
    
    /// Audio Session Route Change : ルートが変化した(ヘッドフォンが抜き差しされた)
    @objc func audioSessionRouteChanged(_ notification: Notification) {
        guard let userInfo = notification.userInfo,
            let reasonValue = userInfo[AVAudioSessionRouteChangeReasonKey] as? UInt,
            let reason = AVAudioSession.RouteChangeReason(rawValue:reasonValue) else {
                return
        }
        
        DispatchQueue.main.async {
            self.messageLabel.text = self.routeChangeReasonDescription(reason: reason)
        }

        switch reason {
        case .newDeviceAvailable:
            let session = AVAudioSession.sharedInstance()
            for output in session.currentRoute.outputs where output.portType == AVAudioSession.Port.headphones {
                // ヘッドフォンがつながった
                
                break
            }
        case .oldDeviceUnavailable:
            if let previousRoute =
                userInfo[AVAudioSessionRouteChangePreviousRouteKey] as? AVAudioSessionRouteDescription {
                for output in previousRoute.outputs where output.portType == AVAudioSession.Port.headphones {
                    // ヘッドフォンが外れた
                    
                    // このサンプルでは音声をpauseしています
                    syntherizer.pauseSpeaking(at: .immediate)
                    
                    break
                }
            }
        default: ()
        }
        
    }
    
    private func speak() {
        let voice = AVSpeechSynthesisVoice(language: "ja-JP")
        let utterance = AVSpeechUtterance(string: "おはようございます。今日もいい天気ですね。音声合成で読み上げています。文章をうまくよめていますか？")
        utterance.voice = voice
        //utterance.preUtteranceDelay = 5
        if syntherizer.isPaused {
            syntherizer.continueSpeaking()
        } else {
            syntherizer.speak(utterance)
        }
    }
    

    /// Speakボタンが押された
    @IBAction func speakBtnTapped(_ sender: Any) {
        // 音声出力を行う
        speak()
    }
    
    /// pauseボタンが押された
    @IBAction func pauseBtnTapped(_ sender: Any) {
        // ポーズする
        syntherizer.pauseSpeaking(at: .immediate)
    }
    
    /// 監視する必要がなくなった段階で、Observerを取り外します
    private func removeAudioSessionObservers() {
        let center = NotificationCenter.default
        
        // AVAudio Session
        center.removeObserver(self, name: AVAudioSession.interruptionNotification, object: nil)
        center.removeObserver(self, name: AVAudioSession.routeChangeNotification, object: nil)
        
    }
    
    /// route変更の理由表示用
    private func routeChangeReasonDescription(reason: AVAudioSession.RouteChangeReason) -> String {
        switch reason {
        case .unknown:
            return "unknown"
        case .newDeviceAvailable:
            return "newDeviceAvailable"
        case .oldDeviceUnavailable:
            return "oldDeviceUnailable"
        case .categoryChange:
            return "categoryChange"
        case .override:
            return "override"
        case .wakeFromSleep:
            return "wakeFromSleep"
        case .noSuitableRouteForCategory:
            return "noSuitableRouteForCategory"
        case .routeConfigurationChange:
            return "routeConfigurationChange"
        default:
            return "default"
        }
    }
    
}