Mux Analytics

The AmpMux plugin offers a quick way to integrate AmpPlayer with Mux SDK. This plugin enables the reporting of data collected by Mux in your application, efectively tracking your video activity.

You can check out our basic implementation, please refer to our application samples:

Adding the Plugin to the Xcode project

Manual Installation

To manually install the plugin you’ll need to download our latest distribution. You will be using AmpMux.xcframework and the AmpCore.xcframework to integrate this plugin.

You will also need the Mux Analytics which you can download it on the release page.

The latest version of the Mux Analytics used by this plugin is 5.0.1 , newer versions may be used, but you may run into unexpected errors until an update is released.

After acquiring the frameworks you can just drag them to you Xcode project directory.

The last step, is to mark every imported framework for Embed & Sign in the project’s general tab.

CocoaPods

If you don’t have CocoaPods installed, refer to the CocoaPods documentation. To use CocoaPods, first create a Podfile in the directory containing the Xcode project. For the AmpMux plugin, the Podfile should look like this:

target "ProjectName" do

  use_frameworks!

  pod 'AmpCore'
  pod 'AmpMux'
  pod 'Mux-Stats-Core'

end

Once you have added the Podfile just run the command pod install --repo-update in the directory it’s located. Once the command has been completed you should se a new .xcworkspace file in your folder. Now you can start integrating the library.

Implementation

You need a working implementation of the AmpPlayer before using this plugin. If you need the implementation guide for AmpPlayer please refer to our documentation.

Import

The first step is to import the AmpCore, AmpMux, and Mux plugins.

import AmpCore
import AmpMux
import MuxCore

Defining the Video Data

After importing the libraries to the file, the next step is to define the metadata of your video

let videoMetadata = MUXSDKCustomerVideoData()
videoMetadata.videoTitle = VIDEO_NAME
videoMetadata.videoCdn = CDN_NAME
videoMetadata.videoContentType = CONTENT_TYPE
videoMetadata.videoStreamType = STREAM_TYEP
videoMetadata.videoSourceUrl = SRC_URL

Creating a new instance

To create a new instance you’ll have to provide the metadata of your video and the environment key provided by Mux. If you need additional information regarding the environment key, please refer to their docs.

let muxInfo = AmpMuxInfo(environmentKey: ENV_KEY, videoMetaData: videoMetadata)

Link with the player

To link the video session information to the player to start reporting the playback events you will only have to create a new instance of the AmpMuxManager.

let muxManager = AmpMuxManager(player: player_instance, info: muxInfo)

Additional Information

This guide was written on 7/26/2024 and it’s last revision was made on 7/26/2024. If you need any additional support please contact us through our offical support email.