QuanteecConfig
The QUANTEEC plugin for AVPlayer is currently in a beta state. This documentation might change in the future, according to our development.
public class QuanteecConfig
A class for setting up the initial parameters of a QuanteecCore
In your QUANTEEC configuration, remember to set a different videoID if you have different formats of the same stream (e.g., one DASH stream and one HLS stream) or two variants of the same stream (one stream with English audio and one stream with another language).
Summary
Public fields
| Bool | activated |
| String | analyticsVideoID |
| Bool | cellularActivated |
| Bool | checkUrls |
| [String] | collections |
| String | ignoreTokenInUrls |
| String | logLevel |
| Bool | lowLatency |
| Double | maxUploadPercent |
| Bool | p2pActivated |
| String | p2pConfiguration |
| Bool | sendingActivated iOS only |
| String | tracker |
| String | videoID |
Public constructors
| QuanteecConfig(videoID: String, quanteecKey: String) |
Public fields
activated
public activated: Bool
Activate or deactivate QUANTEEC, including the connection with the controller and the analytics retrieval. This value overrides p2pActivated, which does not stop the connection to the controller.
Default value: true
analyticsVideoID
public analyticsVideoID: String
Specific name to identify a video for the analytics process. By default, the videoID is used.
Default value: The value of the videoID
cellularActivated
public cellularActivated: Bool
Indicates if data can be sent or not when QUANTEEC is used on a cellular network. If true, the device will not be allowed to send data to other viewers through P2P (but it can still receive the data through P2P).
Default value: true
collections
public collections: [String]
A list of collections to which the video belongs. It is useful for analytics purposes.
checkUrls
public checkUrls: Bool
If true, QUANTEEC checks the url of the segments in addition to the segment number before sending the data in P2P. It is useful for Server-Side Ad-Insertion (SSAI) use cases when different viewers may have different ads.
Default value: false
ignoreTokenInUrls
public ignoreTokenInUrls: String
A string that can contain a regular expression. It is useful in case where checkUrls is set to true. The URLs will be checked without the regex defined in ignoreTokenInUrls. It is useful if the url embeds a unique token for every viewer for security reasons.
Default value: ""
logLevel
public logLevel: Int
Indicates the loglevel of the plugin.
4 levels are possible: MyLogger.LOG_LEVEL_ERROR, MyLogger.LOG_LEVEL_INFOS, MyLogger.LOG_LEVEL_DEBUG, MyLogger.LOG_LEVEL_TRACE.
Default value: MyLogger.LOG_LEVEL_INFOS
lowLatency
public lowLatency: Bool
Activates or deactivates the low-latency mode of QUANTEEC. Only set this value to true for low-latency streams, using DASH-LL or HLS-LL.
Default value: false
maxUploadPercent
public maxUploadPercent: Double
Percentage of upload bandwidth to use. Number between 0 and 1. If 0, nothing is sent, but the peer still receives data.
Default value: 0.5
p2pActivated
public p2pActivated: Double
Activates QUANTEEC P2P system.
Default value: true
When setting this parameter to false, all the exchanges between the viewers are not allowed.
To deactivate data sending ONLY, set the parameters maxUploadPercent to 0 or sendingActivated to false . This will allow the viewers to receive data from other viewers, but sending data will not be allowed.
p2pConfiguration
public p2pConfiguration: String
Select a collection and use the P2P configurations associated with this configuration for this plugin. If the name of the collection is invalid, the configuration used will fall back to the configuration selected for this video in the panel.
quanteecKey
public quanteecKey: String
Your personal QUANTEEC key used to authenticate the plugin.
Default value: ""
sendingActivated
public sendingActivated: Bool
Activate or deactivate data sending in P2P.
Setting this parameter to false gives the same result as setting maxUploadPercent to '0'.
Default value: true
tracker
public tracker: String
Used to define a specific URL for the tracker. Used only in specific scenarios where the signaling server is deployed on premises.
Default value: ""
videoID
public videoID: String
Specific name to identify a video in the QUANTEEC system. It is useful if the video source URL contains a token that is different for every viewer.
Default value: The Url of the source
Public constructors
QuanteecConfig ()
public QuanteecConfig(videoID: String, quanteecKey: String)
Parameters
| Name | Type | Description |
|---|---|---|
| videoID | String | Specific name to identify a video in QUANTEEC system. It is useful if the video source URL contains a token that is different for every viewer. |
| quanteecKey | String | Your personal QUANTEEC key used to authenticate the plugin. |