ViewControllerに紐づけられているボタンの状態を別のクラスから変化させたい．

Question

前提・実現したいこと

現在，macOS版の音楽再生アプリを作成しています．
そこで音楽再生ボタンやシークバーなどをStoryBoardで生成して，それをViewController.swift(初期生成されるファイル)のViewControllerに紐づけてボタン操作で音楽再生・停止を行うことができるようになりました．しかし，音楽再生が止まった時にボタンの状態は再生状態になるのでボタンの状態も停止状態にしたいと考えています．

音楽再生のプロパティーやファンクションは別ファイル**(Player.swift)**のPlayerクラスに書いており，再生が停止した後に呼び出されるクロージャーで，ボタンの状態をON状態からOFF状態に変更したいと考えています．

class ViewController: NSViewController {

ここではPlayerButtonのOutletは定義せずにPlayerクラスで定義する
//@IBOutlet weak var PlayerButton: NSButton!　→　Playerクラス
 
//中略

 @IBAction func pushPlayButton(_ sender: NSButton) {

    guard (playurl != nil) else {
            sender.setNextState()
            return
        }
        
        
        if sender.state == NSControl.StateValue.on{
            player.play()

            
            sender.image = NSImage(named: "NSTouchBarPauseTemplate")
            
        }else{
            
            player.pause()
            
            sender.image = NSImage(named:"NSTouchBarPlayTemplate")
        }

}
}

Player:ViewController{
//音楽再生のパラメータの諸々
//AVAudioPlayerNodeを使用している．
var audioPlayerNode:AVAudioPlayerNode!

//ボタンの状態を変更するためにここで紐付け
 @IBOutlet weak var PlayerButton: NSButton!

func play(){
        let remainFrames = AVAudioFrameCount(Float(sampleRate * length))

//任意の長さのファイルを指定の位置から再生させる
        audioPlayerNode.scheduleSegment(audioFile, startingFrame: AVAudioFramePosition(Float(sampleRate * sPosition)), frameCount: remainFrames, at: nil){
//再生が終わったら呼ばれるハンドラ内

//問題点→ ViewControllerのボタン状態を変更させる.これを実行したい．

                self.TeacherPlayButton.state = NSControl.StateValue.off
                self.TeacherPlayButton.image = NSImage(named: "NSTouchBarPauseTemplate")
            　　　
            
        }

}

問題点

• ViewControllerに紐づけられているボタンの状態を別のクラスから変化させたい．(クロージャーを使用していなくても良い)
• どういった方法を使用すれば実現できるのかわからない

試したこと(自信ない)

delegageの使い方がいまいちわかっていないのですが，PlayerクラスにViewControllerクラスを継承しdelegateで解決すればよいかと思って継承してPlayerクラスにStoryBoardからControl^ + マウス操作でIBOutletを行ってやってみたのですが，

Thread 1: Fatal error: Unexpectedly found nil while implicitly unwrapping an Optional value

のエラーがでてきてViewControllerのボタンのオブジェクトをきちんと継承できていないと直感で感じましたが，ここからどうやって解決すれば良いかと頭を悩ませています．delegateの方法を使用すればいいのかもっと他の方法があるのか，
よろしければ解決方法を教えていただきたいです．

macOS版iOS版どちらのアドバイスでも良いのでよろしくお願いします！

補足情報（FW/ツールのバージョンなど）

• xcode 11.3.1
• macOSアプリ開発

Answer 1

Thread 1: Fatal error: Unexpectedly found nil while implicitly unwrapping an Optional value

で落ちたのは、playerクラスに紐づけたButtonのインスタンスが無いからだとおもいます。

簡単に解決するのは delegate だとおもいます。

問題点とその解決策は

問題点 -> ViewControllerのボタン状態を変更させる.これを実行したい．
解決策 -> delegate 先の playDidFinished() で処理させる

です。

delegate先をViewControllerにして、そのクラス内に記述したplayDidFinished()でラベルの更新などを行えばいいと思います。

delegate を使うのであればこんな感じかな、と思います。

作り溜めのサンプルからコンパイルせずに流用しているので、typoがあったら許してください。

##Player.swift

// ** PlayerDelegate プロトコルを定義（プロトコルの名前は独自に設定する）
protocol PlayerDelegate : class {
    // *** 別のクラスで具体的に行わせたい処理
    // 具体的に行わせたい処理は、PlayerDelegate を準拠したクラスの中に記述する
    func playDidFinished()
}

class Player {
    // 様々な設定

    // ** delegate 先のクラス（この時点では未定なのでオプショナル型で定義）
    // ** 循環参照を防ぐために weak で定義
    weak var delegate: PlayerDelegate?

    func play(){
        // 様々な処理

        //任意の長さのファイルを指定の位置から再生させる
        audioPlayerNode.scheduleSegment(audioFile, startingFrame: AVAudioFramePosition(Float(sampleRate * sPosition)), frameCount: remainFrames, at: nil){
               // 再生が終わったら呼ばれるハンドラ内

　　　　　　　　　// 様々な処理

               // *** delegate先のクラスで定義された playDidFinished() を実行
               // *** 仮に delegate == nil の場合は次の行は実行されない(optional chainingの性質)
               // 問題点 -> ViewControllerのボタン状態を変更させる.これを実行したい．
               // 解決策 -> delegate 先の playDidFinished() で処理させる
               delegate?.playDidFinished()

               // 他の処理
        }
    }
}

ViewController.swift

// *** PlayerDelegate プロトコルを採用させる
class ViewController: NSViewController, PlayerDelegate {
    // NSButton は復活させる
    @IBOutlet weak var PlayerButton: NSButton!

    // 音楽再生させるクラスのインスタンスを作成
    var player = Player()

    // viewWillAppear(_)か適当なところで delegate を設定
    override func viewWillAppear(_ animated: Bool) {
        super.viewWillAppear(animated)

        // *** delegate を設定（自分自身のインスタンスにする）
        player.delegate = self

        // 他の処理があれば実行
    }

    //中略
    // Player.swift の delegate?.playDidFinished()で呼び出されるメソッドの具体的な処理

    func playDidFinished() {
        // ** 音楽再生が終わったらこの関数が呼び出されるので、ここでラベルを更新する
    }
}

合わせて読みたい

• カウントダウンの数値を別ViewControllerのラベルに表示させたい

-- delegate の具体的な実装について

• delegateでdissmissが機能しない

-- hoshi-takanoriさんが詳しく解説されています。

Comments

[techiro]

@TsukubaDepotさん

とてもわかりやすく解説いただきありがとうございます．
問題を解決することができました．
また，今回の問題解決によりdelegateの使い方を理解することができました．

私の以前の理解だと，クラスを継承すればそのクラスのオブジェクトを扱えるといった認識でした.
delegateとクラスの継承をごっちゃに考えていました.

おかげさまでdelegateを使用してのコードが増えそうです．
ありがとうございました！

[TsukubaDepot]

私も delegate を自分で実装するまではピンとこなくて悩んでいました。参考になってよかったです。
delegateを実装するには、プロトコルとか、クラスの弱参照などの話も絡んでくるのですが、そちらは hoshi-takanori さんがかなり詳しく解説されているので、合わせて読んでいただければと思います。