Playing Audio on an iPhone using AVAudioPlayer (iOS 4)

From Techotopia
Jump to: navigation, search
PreviousTable of ContentsNext
Basic iOS 4 iPhone Animation using Core AnimationRecording Audio on an iPhone with AVAudioRecorder (iOS 4)

Purchase the fully updated iOS 12 / Xcode 10 edition of this book in eBook format for only $24.99.
iOS 12 App Development Essentials eBook (ePub/PDF/Kindle) edition contains over 120 chapters. Learn more...

Buy Print Preview Book

The iOS 4 SDK provides a number of mechanisms for implementing audio playback from within an iPhone application. The easiest technique from the perspective of the application developer is to use the AVAudioPlayer class which is part of the AV Foundation Framework.

The goal of this chapter is to provide an overview of audio playback using the AVAudioPlayer class. Once the basics have been covered, a tutorial is worked through step by step. The topic of recording audio from within an iPhone application is covered in the next chapter entitled Recording Audio on an iPhone with AVAudioRecorder (iOS 4).

Support Audio Formats

The AV Foundation framework supports the playback of a variety of different audio formats and codecs including both software and hardware based decoding. Codecs and formats currently supported are as follows:

  • AAC (MPEG-4 Advanced Audio Coding)
  • ALAC (Apple Lossless)
  • AMR (Adaptive Multi-rate)
  • HE-AAC (MPEG-4 High Efficiency AAC)
  • iLBC (internet Low Bit Rate Codec)
  • Linear PCM (uncompressed, linear pulse code modulation)
  • MP3 (MPEG-1 audio layer 3)
  • µ-law and a-law

If an audio file is to be included as part of the resource bundle for an application it may be converted to a supported audio format prior to inclusion in the application project using the Mac OS X afconvert command-line tool. For details on how to use this tool, run the following command in a Terminal window:

afconvert –h

Receiving Playback Notifications

An application receives notifications from an AVAudioPlayer instance by declaring itself as the object’s delegate and implementing some or all the following AVAudioPlayerDelegate protocol methods:

  • audioPlayerDidFinishPlaying: – Called when the audio playback finishes. An argument passed through to the method indicates whether the playback completed successfully or failed due to an error.
  • audioPlayerDecodeErrorDidOccur: - Called when a decoding error is encountered by the AVAudioPlayer object during audio playback. An error object containing information about the nature of the problem is passed through to this method as an argument.
  • audioPlayerBeginInterruption: – Called when audio playback has been interrupted by a system event such as an incoming phone call. Playback is automatically paused and the current audio session deactivated.
  • audioPlayerEndInterruption: - Called after an interruption ends. The current audio session is automatically activated and playback may be resumed by calling the play method of the corresponding AVAudioPlayer instance.

Controlling and Monitoring Playback

<google>IOSBOX</google> Once an AVAudioPlayer instance has been created the playback of audio may be controlled and monitored programmatically via the methods and properties of the instance. For example, the self explanatory play, pause and stop methods may be used to control playback. Similarly, the volume property may be used to adjust the volume level of the audio playback whilst the playing property may be accessed to identify whether or not the AVAudioPlayer object is currently playing audio.

In addition, playback may be delayed to begin at a later time using the playAtTime instance method which takes as an argument the number of seconds (as an NSTimeInterval value) to delay before beginning playback.

The length of the current audio playback may be obtained via the duration property whilst the time current point in the playback is stored in the currentTime property.

Playback may also be programmed to loop back and repeat play a specified number of times using the numberofLoops property.

Creating the iPhone Audio Example Application

The remainder of this chapter will work through the creation of a simple iPhone iOS application that plays an audio file. The user interface of the application will consist of play and stop buttons to control playback and a slider to adjust the playback volume level.

Being by launching Xcode and creating a new iPhone iOS view-based application named audio.

Adding the AVFoundation Framework

Since the iOS 4 AVAudioPlayer class is part of the AV Foundation framework it will be necessary to add the framework to the project. To achieve this Ctrl-click on the Frameworks entry of the Groups & Files panel of the main Xcode project window and select Add -> Existing Frameworks…. Select AVFoundation.framework from the list and click on Add.

Adding an Audio File to the Project Resources

In order to experience audio playback it will be necessary to add an audio file to the project resources. For this purpose, any supported audio format file will be suitable. Having identified a suitable audio file, drag and drop it into the Resources category of the Groups & Files panel of the main Xcode window. For the purposes of this tutorial we will be using an MP3 file named Kalimba.mp3.

Creating Actions and Outlets

The application is going to need action methods for the play and stop buttons in addition to the volume control. Since we will need to be able to read the current value of the volume slider control it will also be necessary to declare a corresponding outlet. We also need to declare a reference to an AVAudioPlayer audioPlayer object and specify that the view controller class implements the AVAudioPlayerDelegate protocol. Select the audioViewController.h file and modify it to import the <AVFoundation/AVFoundation.h> file and declare these references and actions:

#import <UIKit/UIKit.h>
#import <AVFoundation/AVFoundation.h>

@interface audioViewController : UIViewController
        AVAudioPlayer *audioPlayer;
        UISlider *volumeControl;
@property (nonatomic, retain) IBOutlet UISlider *volumeControl;
-(IBAction) playAudio;
-(IBAction) stopAudio;
-(IBAction) adjustVolume;

Once the file has been modified as outlined, save the changes before proceeding.

Implementing the Action Methods

The next step in our iPhone audio player tutorial is to implement the action methods for the two buttons and the slider. Select the audioViewController.m file and add these methods as outlined in the following code fragment (note also the addition of the synthesize directive for the silderControl):

#import "audioViewController.h"

@implementation audioViewController
@synthesize volumeControl;

    [audioPlayer play];
    [audioPlayer stop];
    if (audioPlayer != nil)
         audioPlayer.volume = volumeControl.value;

Creating Initializing the AVAudioPlayer Object

Now that we have an audio file to play and appropriate action methods written the next step is to create an AVAudioPlayer instance and initialize it with a reference to the audio file. Since we only need to initialize the object once when the application launches a good place to write this code is in the viewDidLoad method of the audioViewController.m file. Remove the comment markers (/* and */) from around this method and modify it as follows:

- (void)viewDidLoad {
    [super viewDidLoad];
    NSURL *url = [NSURL fileURLWithPath:[[NSBundle mainBundle]

        NSError *error;
        audioPlayer = [[AVAudioPlayer alloc]
        if (error)
                NSLog(@"Error in audioPlayer: %@", 
                      [error localizedDescription]);
        } else {
                audioPlayer.delegate = self;
                [audioPlayer prepareToPlay];

In the above code we create an NSURL reference using the filename and type of the audio file added to the project resources. Keep in mind that this will need to be modified to reflect the audio file used in your own project.

Next, an AVAudioPlayer instance is created using the URL of the audio file. Assuming no errors were detected, the current class is designated as the delegate for the audio player object. Finally a call is made to the audioPlayer object’s prepareToPlay method. This performs initial buffering tasks so that there is no buffering delay when the play button is subsequently selected by the user.

Implementing the AVAudioPlayerDelegate Protocol Methods

As previously discussed, by declaring our view controller as the delegate for our AVAudioPlayer instance our application will be able to receive notifications relating to the playback. Templates of these methods are as follows and may be placed in the audioViewController.m file as follows:

-(void)audioPlayerDidFinishPlaying:(AVAudioPlayer *)player successfully:(BOOL)flag
-(void)audioPlayerDecodeErrorDidOccur:(AVAudioPlayer *)player error:(NSError *)error
-(void)audioPlayerBeginInterruption:(AVAudioPlayer *)player
-(void)audioPlayerEndInterruption:(AVAudioPlayer *)player

For the purposes of this tutorial it is not necessary to implement any code for these methods and they are provided solely for completeness.

Designing the User Interface

Double click on the audioViewController.xib file to launch the Interface Builder tool. Drag and drop components from the Library onto the View window and modify properties so that the interface appears as illustrated in the following figure:

The user interface for an iPhone iOS 4 Audio Player application

Ctrl-click on the File’s Owner entry, drag the blue line to the slider control in the View window and select the sliderControl outlet from the resulting menu to connect the control to the outlet.

Select the Play button in the View window and display the connections inspector (Command+2). Click on the small circle to the right of the Touch Up Inside event and drag the line to the File’s Owner entry in the documents window. Release the pointer and select the playAudio action from the resulting menu. Repeat these steps to connect the Touch Up Inside event of the Stop button to the stopAudio action and the Value Changed event of the slider control to the adjustVolume method.

Save the design and exit from interface Builder.

Releasing Memory

The last step before trying out the application is to release any memory allocated during the application lifecycle:

- (void)viewDidUnload {
    // Release any retained subviews of the main view.
    // e.g. self.myOutlet = nil;
    audioPlayer = nil;
    volumeControl = nil;
- (void)dealloc {
    [audioPlayer release];
    [volumeControl release];
    [super dealloc];

Building and Running the Application

Once all the requisite changes have been made and saved, test the application in the iOS Simulator by clicking on the Build and Run button located in the main Xcode project window. Once the application appears, click on the Play button to begin playback. Adjust the volume using the slider and stop playback using the Stop button.

Now that the basics of audio playback have been covered the next chapter will look at Recording Audio on an iPhone with AVAudioRecorder (iOS 4).

Purchase the fully updated iOS 12 / Xcode 10 edition of this book in eBook format for only $24.99.
iOS 12 App Development Essentials eBook (ePub/PDF/Kindle) edition contains over 120 chapters. Learn more...

Buy Print Preview Book

PreviousTable of ContentsNext
Basic iOS 4 iPhone Animation using Core AnimationRecording Audio on an iPhone with AVAudioRecorder (iOS 4)