Menu

Lumen help

Monitoring tools for iOS

Introduction

On top of the stats API exposed by the SDK, we created a view helper to help you integrate and understand Mesh Delivery faster. The DebugView will inform you about the different states of the SDK lifecycle and Lumen metrics.

 

 

 

The view looks like the following:

Statsview For Mesh Delivert SDK 22.01 onwards

Note: LumenStatsView is NOT intended for production

Adding a LumenStatsView is really simple, but varies slightly if you chose to integrate with our Kotlin SDK, Java SDK, or our ExoPlayer Plugin. Choose the correct code below corresponding to your integration of choice.

 

First, you will need to add the following dependency to the build.gradle

                // The implementer is in charge to create the view and to display it on top of the player controller/layer
self.deliveryClient.displayStatWiew(someView!)
            
                // The implementer is in charge to create the view and to display it on top of the player controller/layer
plugin.displayStatsView(someView!)

Note: Our sample app is using AVPlayerViewController, on iOS we are adding the view as a subview of AVPlayerViewController. On tvOS, we suggest to use customOverlayViewController instead.

What do the stats tell you?

The DebugView shows information regarding the traffic, the peer connections, cache size, buffer size, and video content related information. The details of all parameters shown are listed in the table below.

Parameter Description Unit
CDN

Total amount of bytes downloaded from the CDN.

MB

Mesh

Total amount of bytes downloaded from the Mesh network.

MB

Upload

Total amount of Bytes uploaded to the Mesh network.

MB

Offload

Global efficiency of Mesh delivery, the ratio of CDN vs Mesh.

  

Peers

Number of peers with whom the Mesh Delivery is connected.

  • "m" (match) : Number of peer candidates sent by the tracker
  • "a" (Attempted offers) : Number of connections attempted by us
  • "r" (received offers) : Number of offers received
  • "d" (disconnected) : Number of peers disconnected

 

PeerID

Unique ID of the viewer used to identify each peer in the Mesh network.

 

Content ID

ID of the content currently being played back. Either the custom one defined with the Content Id string or the default one based on the content URL.

 

P2P cache size

Current amount of the video data stored in the cache by the Mesh SDK / Total amount of data the Mesh SDK will ever take.

MB

Buffer health / Buffer target

Current amount of video data in the player buffer / Buffer amount the player will try to reach (dynamically changed by the Mesh SDK).

Seconds
Latency Delay between current position and the most recent video segment available in the playlist.   seconds
Track
 Video track bitrate (corresponding video track ID for the Mesh SDK)
 Kbps
Bandwidth The estimated bandwidth of the CDN
 Mbps

 

Learn how you can configure Mesh Delivery for iOS to best suit your needs