音楽ファイルの再生停止などの制御をする「DCAudioPlayer」クラス改訂版

音楽ファイルの再生停止などの制御をする「DCAudioPlayer」クラスを改訂しました。

オーディオの再生／停止／一時停止／再生状況の取得、ボリュームコントロールスライダーの生成などを行えます。

このクラスの使用には AVFoundationフレームワークが必要になります。

今回の変更内容は下記の通りです。

変更内容

オーディオ再生終了時のデリゲートメソッドを指定出来るよう変更しました (初期化時にデリゲート使用有無を指定)
オーディオのバックグラウンド再生をサポートしました

バックグラウンド再生するために必要な手順

info.plistファイルを編集

info.plistファイルを Xcode左側のプロジェクトメニューから開く
Keyに Required background modesを追加
Item 0 の Valueを App plays audio に指定

下記よりサンプルとソースコードのダウンロードが行えます。

ダウンロード

https://github.com/masakihirokawa/objc-classes-dc-audio-player2

使用方法

オーディオファイルを指定し初期化

_audioPlayer = [[DCAudioPlayer alloc] initWithAudio:AUDIO_RESOURCE_FILE_NAME
                                                ext:AUDIO_RESOURCE_FILE_EXT
                                      isUseDelegate:YES];

再生

[_audioPlayer play];

停止

[_audioPlayer stop];

一時停止

[_audioPlayer pause];

ボリュームコントロールスライダーの取得

_audioVolumeSlider = [_audioPlayer volumeControlSlider:self
                                                 point:CGPointMake(50, 150)
                                          defaultValue:0.5f
                                              selector:@selector(sliderValueChanged:)];

- (void)sliderValueChanged:(UISlider *)slider
{
    if (_audioPlayer) {
        [_audioPlayer setVolume:slider.value];
    }
}

音量の指定

[_audioPlayer setVolume:0.5f];

現在の再生フレームの指定

[_audioPlayer setCurrentTime:0];

再生ループ回数の指定

[_audioPlayer setNumberOfLoops:-1];

再生状況の取得

BOOL isPlaying = _audioPlayer.isPlaying;

ソースコード

DCAudioPlayer.h

#import <AVFoundation/AVFoundation.h>

#define AUDIO_VOLUME_SLIDER_WIDTH  220
#define AUDIO_VOLUME_SLIDER_HEIGHT 0
#define AUDIO_MAX_VOLUME           1.0f
#define AUDIO_MIN_VOLUME           0.0f

@protocol DCAudioPlayerDelegate;

@interface DCAudioPlayer : AVAudioPlayer <AVAudioPlayerDelegate> {
    id<DCAudioPlayerDelegate> _ap_delegate;
}

#pragma mark - property
@property (nonatomic, assign)                 id<DCAudioPlayerDelegate> ap_delegate;
@property AVAudioPlayer                       *audioPlayer;
@property NSTimeInterval                      currentTime;
@property (readonly) NSData                   *data;
@property (assign) id <AVAudioPlayerDelegate> delegate;
@property NSTimeInterval                      duration;
@property (getter=isMeteringEnabled) BOOL     meteringEnabled;
@property (readonly) NSUInteger               numberOfChannels;
@property NSInteger                           numberOfLoops;
@property (readonly, getter=isPlaying) BOOL   playing;
@property (readonly) NSURL                    *url;
@property float                               volume;

#pragma mark - public method
- (id)initWithAudio:(NSString *)fileName ext:(NSString *)ext isUseDelegate:(BOOL)isUseDelegate;
- (void)play;
- (void)pause;
- (void)stop;
- (UISlider *)volumeControlSlider:(id)delegate point:(CGPoint)point defaultValue:(float)defaultValue selector:(SEL)selector;
- (void)setVolume:(float)volume;
- (void)setCurrentTime:(NSTimeInterval)currentTime;
- (void)setNumberOfLoops:(NSInteger)numberOfLoops;
- (BOOL)isPlaying;

@end

#pragma mark - delegate method
@protocol DCAudioPlayerDelegate <NSObject>
@optional
@end

DCAudioPlayer.m

#import "DCAudioPlayer.h"

@implementation DCAudioPlayer

@synthesize ap_delegate;

// 初期化
- (id)initWithAudio:(NSString *)fileName ext:(NSString *)ext isUseDelegate:(BOOL)isUseDelegate
{
    if (self = [super init]) {
        // オーディオプレイヤー初期化
        NSBundle *mainBundle = [NSBundle mainBundle];
        NSString *filePath = [mainBundle pathForResource:fileName
                                                  ofType:ext];
        NSURL *fileUrl = [NSURL fileURLWithPath:filePath];
        NSError *error = nil;
        AVAudioPlayer *audioPlayer = [[AVAudioPlayer alloc] initWithContentsOfURL:fileUrl error:&error];

        // バックグラウンド再生を許可
        AVAudioSession *audioSession = [AVAudioSession sharedInstance];
        [audioSession setCategory:AVAudioSessionCategoryPlayback error:nil];
        [audioSession setActive:YES error:nil];

        // エラーであれば処理しない
        if (!error) {
            // オーディオプレイヤー保持
            _audioPlayer = audioPlayer;

            // デリゲート指定
            if (isUseDelegate) {
                [_audioPlayer setDelegate:self];
            }

            // バッファを保持
            [_audioPlayer prepareToPlay];
        }
    }
    return self;
}

// 再生
- (void)play
{
    if (_audioPlayer) {
        if (!_audioPlayer.isPlaying) {
            [_audioPlayer prepareToPlay];
            [_audioPlayer play];
        }
    }
}

// 一時停止
- (void)pause
{
    if (_audioPlayer) {
        if (_audioPlayer.isPlaying) {
            [_audioPlayer pause];
        }
    }
}

// 停止
- (void)stop
{
    if (_audioPlayer) {
        if (_audioPlayer.isPlaying) {
            [_audioPlayer setCurrentTime:0];
            [_audioPlayer stop];
            [_audioPlayer prepareToPlay];
        }
    }
}

// ボリュームコントロールスライダー
- (UISlider *)volumeControlSlider:(id)delegate point:(CGPoint)point defaultValue:(float)defaultValue selector:(SEL)selector
{
    UISlider *audioVolumeSlider = [[UISlider alloc] initWithFrame:CGRectMake(point.x,
                                                                             point.y,
                                                                             AUDIO_VOLUME_SLIDER_WIDTH,
                                                                             AUDIO_VOLUME_SLIDER_HEIGHT)];
    audioVolumeSlider.minimumValue = AUDIO_MIN_VOLUME;
    audioVolumeSlider.maximumValue = AUDIO_MAX_VOLUME;
    if (defaultValue > AUDIO_MAX_VOLUME) defaultValue = AUDIO_MAX_VOLUME;
    if (defaultValue < AUDIO_MIN_VOLUME) defaultValue = AUDIO_MIN_VOLUME;
    audioVolumeSlider.value = defaultValue;
    [audioVolumeSlider addTarget:delegate
                          action:selector
                forControlEvents:UIControlEventValueChanged];
    return audioVolumeSlider;
}

// ボリューム指定
- (void)setVolume:(float)volume
{
    if (_audioPlayer) {
        _audioPlayer.volume = volume;
    }
}

// 現在の再生フレーム指定
- (void)setCurrentTime:(NSTimeInterval)currentTime
{
    if (_audioPlayer) {
        _audioPlayer.currentTime = currentTime;
    }
}

// ループ回数指定
- (void)setNumberOfLoops:(NSInteger)numberOfLoops
{
    if (_audioPlayer) {
        _audioPlayer.numberOfLoops = numberOfLoops;
    }
}

// 再生状況の取得
- (BOOL)isPlaying
{
    return _audioPlayer.playing;
}

#pragma mark - AVAudioPlayerDelegate

- (void)audioPlayerDidFinishPlaying:(AVAudioPlayer *)player successfully:(BOOL)successfully
{
    if (successfully) {
        // ここでデリゲートメソッドを指定する

    }
}

@end

お薦めの参考書

本気ではじめるiPhoneアプリ作り Xcode 7.x+Swift 2.x対応
iOSアプリ開発をこれから始める方に最もお薦めな一冊です。解り辛い点は図解入りで解説されており、プログラミングの動作の仕組みから詳しく知ることができます。基本から通信処理まで押さえられており、アプリ公開の手順についても解説されています。