Function description

The MediaPlayer Kit is a powerful player that supports playing local and online media resources. With this player, you can either locally play media resources or synchronously share currently playing media resources with remote users in the Agora channel.

Usage notice

  • Currently supported media formats: Local files in AVI, MP4, MP3, MKV, and FLV formats; online media streams using HTTP, RTMP and RTSP protocols.
  • When locally playing media resources, you only need the separate MediaPlayer Kit. When synchronously sharing media resources with remote users, you need to use the MediaPlayer Kit, Agora Native SDK, and RtcChannelPublishPlugin at the same time. The MediaPlayer Kit supports the local user to use the player function, the Native SDK supports live interactive streaming scenarios, and the RtcChannelPublishPlugin supports publishing media streams to remote users in Agora channel.
  • When sharing media resources with remote users, the playback window occupies the local user's video as captured by the camera. Therefore, if you want remote users to see both the local user's and the player's window, you need to start another process to capture the local user's video.

Set up the development environment


  • Xcode 9.0 or later
  • A macOS device running macOS 10.10 or later

Open the specified ports in Firewall Requirements if your network has a firewall.

A valid Agora account (Sign up for free) is necessary when sharing media resources to remote users.

Create a macOS project

Now, let's build a macOS project from scratch.

Create a macOS project
  1. Open Xcode and click Create a new Xcode project.

  2. Choose App as the template and click Next.

  3. Input the project information, such as the project name, team, organization name, and language, and click Next.

  4. Choose the storage path of the project and click Create.

  5. Go to the TARGETS > Project Name > Signing & Capabilities menu, choose Automatically manage signing, and then click Enable Automatic on the pop-up window.

Integrate the MediaPlayer Kit

  1. Go to Downloads, download the latest version of the MediaPlayer Kit, and unzip the download package.

  2. Add the AgoraMediaPlayer.framework file in the libs folder to the project folder.

  3. In Xcode, click TARGETS > Project Name > General > Frameworks, Libraries, and Embedded Content to change the status of AgoraMediaPlayer.framework to Embed & Sign.

    According to the requirement of Apple, the Extension of app cannot contain the dynamic library. If you need to integrate the MediaPlayer Kit with the dynamic library in the Extension, change the file status as Do Not Embed.

  4. Go to the TARGETS > Project Name > Build Phases > Link Binary with Libraries menu, and click + to add the following frameworks and libraries. To add the AgoraMediaPlayer.framework file, remember to click Add Other... after clicking +.

    • AgoraMediaPlayer.framework
    • Accelerate.framework
    • CoreWLAN.framework
    • libc++.tbd
    • libresolv.9.tbd
    • SystemConfiguration.framework
    • VideoToolbox.framework
  1. Add the following permissions in the info.plist file for device access according to your needs:

    Key Type Value
    Privacy - Microphone Usage Description String To access the microphone, such as for a video or audio call.
    Privacy - Camera Usage Description String To access the camera, such as for a video call.

Integrate the Native SDK

Version requirements: 2.4.0 or later

Integration steps: See Integrate the Native SDK.

Integrate the RtcChannelPublishPlugin

  1. Download and unzip the
  2. Unzip the ./MediaPlayerExtensions/apple/ and add to your project folder.


Play media resources locally

After integrating the MediaPlayer Kit, follow these steps to implement the local playback function.

Create a player instance

Create an instance of AgoraMediaPlayer.

To play different media resources simultaneously, you should create multiple instances.

Receive event callbacks
Override the AgoraMediaPlayerDelegate delegate method to receive the following event callbacks:

  • didChangedToPosition, which reports the current playback progress.
  • didChangedToState, which reports the playback state change.
  • didOccurEvent, which reports the result of a seek operation to a new playback position.
  • didReceiveData, which occurs each time the player receives the media metadata.
  • didReceiveAudioFrame, which occurs each time the player receives an audio frame.
  • didReceiveVideoFrame, which occurs each time the player receives a video frame.

By listening for these events, you can have more control over the playback process and enable your app to support data in custom formats (media metadata). If an exception occurs, you can use these event callbacks for troubleshooting.

Preparations for playback

  1. Call the setView method in the AgoraMediaPlayer interface to set the render view of the player.

  2. Call the setRenderMode method in the AgoraMediaPlayer interface to set the rendering mode of the player's view.

  3. Call the open method in the AgoraMediaPlayer interface to open the media resource. The media resource path can be a network path or a local path. Both absolute and relative paths are supported.

    Do not proceed until you receive the didChangedToState callback reporting AgoraMediaPlayerStateOpenCompleted(2).

  4. Call the play method in the AgoraMediaPlayer interface to play the media resource locally.

Adjust playback settings

You can call several other methods in the AgoraMediaPlayer interface to implement various playback settings:

  • Pause/resume playback, adjust playback progress, adjust local playback volume, and so on.
  • Get the total duration of the media resource, get the current playback progress, get the current playback state, get the number of media streams in the media resource and detailed information about each media stream.

Stop playback

  1. Call the stop method in the AgoraMediaPlayer interface to stop playback.
  2. Set view in the setView method to NULL to release the view.
  3. Use the ARC memory management mechanism to release the AgoraMediaPlayer instance.

Sample code

_mediaPlayerKit = [[AgoraMediaPlayer alloc] initWithDelegate:self];
[_mediaPlayerKit setView:self.containerView];
[_mediaPlayerKit open:url startPos:0];
[_mediaPlayerKit play];
[_mediaPlayerKit stop];
[_mediaPlayerKit seekToPosition:value];

 // Receives event callbacks.
- (void)AgoraMediaPlayer:(AgoraMediaPlayer *_Nonnull)playerKit

- (void)AgoraMediaPlayer:(AgoraMediaPlayer *_Nonnull)playerKit

- (void)AgoraMediaPlayer:(AgoraMediaPlayer *_Nonnull)playerKit

- (void)AgoraMediaPlayer:(AgoraMediaPlayer *_Nonnull)playerKit
          didReceiveData:(NSString *)data

- (void)AgoraMediaPlayer:(AgoraMediaPlayer *_Nonnull)playerKit

- (void)AgoraMediaPlayer:(AgoraMediaPlayer *_Nonnull)playerKit

Share media resources to remote

After integrating the MediaPlayer Kit, the Agora Native SDK, and the RtcChannelPublishPlugin, follow these steps to synchronously share media resources played by the local user to all the remote users in the Agora channel.

Instantiate required objects

  1. Instantiate an AgoraRtcEngineKit object.
  2. Instantiate the AgoraMediaPlayer and RtcChannelPublishHelper objects.

Enable the player to complete playback preparations

Register the player, audio, and video observer objects, and complete the preparations for playback. See Play media resources locally for details.

Do not proceed until you receive the didChangedToState callback reporting AgoraMediaPlayerStatePlaying(3).

Enable the local user to join the channel by using the SDK

Refer to the RTC quickstart guide for details about how to enable the local user to join the LIVE_BROADCASTING channel in the role of BROADCASTER:

  1. Call the setChannelProfile method to set the channel mode to LIVE_BROADCASTING.

  2. Call the setClientRole method to set the local user role as the host.

  3. Call the enableVideo method to enable the video module.

  4. Call the joinChannel method to enable the local user to join the channel.

    Do not proceed until you receive the joinSuccessBlock or didJoinChannel callback.

When the role of the remote user is BROADCASTER, the Native SDK automatically enables the echo cancellation module. To prevent the remote user from hearing the echo, Agora recommends enabling the remote user to join the channel as the host instead of as the audience.

Start sharing by using the helper

  1. Call the attachPlayerToRtc method to bundle the player with the Agora channel. And the playback window fully occupies the local user's view.

  2. To prevent the remote user from hearing the echo, call the adjustPlayoutSignalVolume method to set the playback volume to 0 and then call the mute(YES) method of the AgoraMediaPlayer interface.

  3. Call the publishVideo/publishAudio method to share the video/audio stream in the media resource to remote users in the Agora channel.

  4. Call the adjustPublishSignalVolume method to adjust the playback volume heard by the remote user.

Cancel sharing by using the helper

  1. Call the unpublishVideo/unpublishAudio method to unshare the video/audio stream in the media resource.

  2. Call the detachPlayerFromRtc method to unbind the player from the Agora channel.

  3. (Optional) Call the setVideoSource method to switch the player's window back to the local user's view and enable the remote users to see the local user again.

Do not skip this section and directly call the leaveChannel method to cancel the media stream being shared, otherwise abnormal behaviors occur when the local user rejoins the channel:
  • The previously unshared media stream automatically sends to the remote users.
  • The audio and video streams are not synchronized during playback.
  • Sample code

    _rtcEnginekit = [AgoraRtcEngineKit sharedEngineWithAppId:@"YOUR_APPID" delegate:self];
    [_rtcEnginekit setChannelProfile:AgoraChannelProfileLiveBroadcasting];
    [_rtcEnginekit setClientRole:AgoraClientRoleBroadcaster];
    [_rtcEnginekit enableVideo];
    [_rtcEnginekit joinChannelByToken:token channelId:channelid info:""  uid:"" joinSuccess:NULL];
    [[AgoraRtcChannelPublishHelper shareInstance] attachPlayerToRtc:_mediaPlayerKit RtcEngine:_rtcEnginekit];
    [[AgoraRtcChannelPublishHelper shareInstance] publishAudio];
    [[AgoraRtcChannelPublishHelper shareInstance] publishVideo];
    [[AgoraRtcChannelPublishHelper shareInstance] detachPlayerFromRtc];
        _defaultCamera = [[AgoraRtcDefaultCamera alloc] init];
    [_rtcEngineKit setVideoSource:NULL];
    [_rtcEngineKit setVideoSource:_defaultCamera];

    Get the log file

    The log file contains all the log events generated by the mediaplayer kit during runtime. The path of the log file is App Sandbox/Library/caches/agoraplayer.log.


    Common audio routers include Bluetooth devices, ordinary headsets, and device speakers. To avoid the problem that the new audio router is abnormally muted when the local user switches the audio router during playback, Agora recommends the following steps:

    • When playing media resources locally, Agora recommends switching the audio router before calling the open method.

      If the local user switches the audio router after calling the open method, the new audio router will be muted and you need to call the open and play methods again to re-play the media resource.

    • When sharing media resources, Agora recommends using the Native SDK v3.0.0 and switching the audio router after calling the mute method.

    API documentation

    See the API documentation.