• 2023/2/15
• 4分

【SwiftUI】AVAudioPlayerで音(サウンド)を鳴らす方法！

＼ アプリをリリースしました ／

友達や家族の誕生日をメモ！通知も届く-みんなの誕生日-

posted withアプリーチ

SwiftUIでアプリから音を出す方法

流れ

1. オーディオファイル(音)の用意
2. XcodeのAssetに追加
3. NSDataAssetクラスでデータを指定
4. AVAudioPlayerクラスで再生

流れとしては上記の通りです。まずは実装してみます。また今回はAVFoundationフレームワークのAVAudioPlayerクラスを使用しますが、Audio Toolboxフレームワークを使用しても音を鳴らすことが可能です。

おすすめ記事：【Swift】システムサウンドの再生方法！AudioServicesPlaySystemSoundの使い方

オーディオファイル(音)の用意

まずは鳴らしたい音データを用意します。今回は「無料効果音」(無料で効果音を提供しているサイト)の「ゲーム・ボタン音」＞「button05.mp3」を使用します。

無料効果音

XcodeのAssetに追加

ダウンロードしたオーディオファイル(mp3)をXcodeのAssetにドラッグ&ドロップで追加します。これで前準備が完了しました。

NSDataAssetクラスでデータを指定

続いてXcode内でコードを記述し再生させていきます。まずはAVFoundationフレームワークを読み込み、NSDataAssetクラスで再生したいデータインスタンスを作っておきます。またAVAudioPlayerインスタンス格納用のプロパティも準備しておきます。

import SwiftUI
import AVFoundation // 追加

let musicData = NSDataAsset(name: "button05")!.data

var musicPlayer:AVAudioPlayer!

struct AudioPlayerView: View {
    var body: some View {

    }
}

AVAudioPlayerクラスで再生

AVAudioPlayerクラスに先ほどの音データインスタンスを渡し、playメソッドを呼び出すことで再生できます。

Button {
    do{
        musicPlayer = try AVAudioPlayer(data: musicData)
        musicPlayer.play()
    }catch{
        print("音の再生に失敗しました。")
    }
    
} label: {
    Text("Play")
}

実際にボタンをクリックして再生されているか確認してみてください。

NSDataAssetクラスとは？

参考文献： 公式リファレンス-NSDataAssetクラス

NSDataAssetはAssetに保存されているデータを参照するためのクラスです。引数には任意のAsset名を指定することで対象のデータをNSDataAsset型で取得し、そのdataプロパティからAVAudioPlayerクラスで必要となるData型に参照できます。

let musicData = NSDataAsset(name: "button05")!.data

AVAudioPlayerクラス

参考文献： 公式リファレンス-AVAudioPlayerクラス

AVAudioPlayerはオーディオデータを再生するクラスです。オーディオの再生だけでなく、音量調節やループ制御など様々な機能を提供しています。

イニシャライザにはthrowsが付与されているのでtry文の記述が必要になります。またdo-catch文を使用して適切にエラーハンドリングを行っておきます。

init(data: Data) throws

おすすめ記事：【Swift】do-catchとthrows文の使い方！エラーハンドリングのやり方

引数に対象のデータを渡しAVAudioPlayerインスタンスを生成して操作していきます。エラーが発生した場合はnilが返ります。

do{
    musicPlayer = try AVAudioPlayer(data: musicData)
}catch{
    print("音の再生に失敗しました。")
} 

AVAudioPlayerの操作方法

オーディオの再生や一時停止などと言った操作はメソッドとして用意されています。

// 再生
musicPlayer.play()
// 一時停止
musicPlayer.pause() 
//  停止
musicPlayer.stop()

Assetにサウンドファイル追加時に発生したエラー

効果音ラボ

最初「効果音ラボ」(無料で効果音を提供しているサイト)の音源「決定ボタンを押す2.mp3」をダウンロードしてそのままAssetに追加した際に以下のような2つのエラーが発生してしまいました。

The data set "サウンドファイル名.mp3" has an unassigned child.

The file "サウンドファイル名.mp3" for the image set "サウンドファイル名" does not exist.

翻訳してみると追加したファイルが正しく認識されていないようです。

解決法

ファイル名を以下のように変更したところ正しく認識されるようになりました。全角数字も別に使用できるはずなのに原因はよくわかりませんでしたが、ダウンロードしたサウンドファイルは自分の識別しやすい任意の名前に変更しておくと良いのかもしれません。

「決定ボタンを押す2.mp3」
　　　　　↓  
「決定ボタンを押す.mp3」

まだまだ勉強中ですので間違っている点や至らぬ点がありましたら教えていただけると助かります。

ご覧いただきありがとうございました。