Menu

Lumen help

Configure Mesh Delivery for iOS, iPadOS, & tvOS

Introduction

There are some optional configuration options available for Mesh Delivery for Streaming which will allow you to configure Mesh Delivery to match your integration policy, your business logic and also to optimize the performance of Mesh Delivery.

 

These options can be passed in the builder when building a new instance of the SDK. Please refer to the integration documentation for more details.

 

The following options can be configured. Click on the option name to learn more.
 

OPTION NAME

TYPE

DEFAULT

meshProperty

String

"default"

contentId

String

default generator

Example

                let deliveryClient = LMDeliveryClientBuilder.clientBuilder()
    .playerInteractor(playerInteractor)
    //...
    .meshProperty(<meshProperty>)
    .contentId(<contentID>)
    //...
    .build(<contentURL>)

Introduction

Property can be used to group your streams according to your business logic, and different settings can be applied to each property. Learn how to apply settings directly in your dashboard here.

meshProperty   - string (optional)

The default property can't be deleted in the dashboard and will be applied in the following cases:

 

  • you don't specify any property in the LMDeliveryClient builder options

  • the property set in the LMDeliveryClient builder options doesn't match any property in the dashboard

  • the property set in the LMDeliveryClient builder options is “default”
     

To set your property, you need to pass the string as  a build parameter to your Mesh Delivery SDK instance.

Example

                builder.meshProperty(<String>);

Introduction

The content ID is an identifier used by our backend to match Mesh sources that are watching the same content. It is an optional parameter, and by default, we generate contentId from the content URL by removing any query parameters and protocol from it.

The content ID is an identifier used by our backend to match Mesh sources that are watching the same content. It is an optional parameter, and by default, we generate contentId from the content URL by removing any query parameters and protocol from it.

 

In some cases, you might want to implement your own content ID generation logic.

 

  • You must ensure that the generator function returns a string that identifies the content in a truly unique manner. Any ambiguity may result in matching Mesh sources that are not watching the same content together.

  • We require the content identified by the same ID to be packaged identically. If packaging is handled at the origin, and edges are used as merely caches, it should be fine. On the other hand, if you are packaging at the edge, content coming from different edge servers must not be identified as the same content. We therefore advise using default ID generation logic only (full URL without the query string).

  • Be careful about elements non-related to the content in your ID. For example, if you derive your content ID from its URL and you have a user-specific token in your query string, you must strip that token from the ID. Similarly, if you have query parameters identifying the device, you'll want to remove them if your content is packaged identically for all devices but keep it if the content is different for mobile and desktop

contentId  - string (optional)

The value cannot be null or empty.

                builder.contentId(<String>);

Dashboard Overview

In addition to the LumenDeliveryClient builder, the Mesh Delivery dashboard can also provide some options for configuration of Mesh Delivery, particularly for the 'property' option. Before a 'property'  can be passed to the builder, it needs to be created on the dashboard.

Learn more about Mesh Delivery dashboard and its various features