Skip to main content

QuanteecConfig

public class QuanteecConfig

A class for setting up the initial parameters of a QuanteecCore

warning

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).

Click here to find more informations on videoID

Summary

Public fields

booleanactivated
StringanalyticsVideoID
booleancellularActivated
booleancheckUrls
StringignoreTokenInUrls
StringlogLevel
booleanlowLatency
doublemaxUploadPercent
booleanp2pActivated
StringquanteecKey
boolean sendingActivated  
Android only
Stringtracker
StringvideoID

Public constructors

QuanteecConfig(String videoID, String quanteecKey)

Public fields

activated

public boolean activated

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 String analyticsVideoID

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 boolean cellularActivated

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

checkUrls

public boolean checkUrls

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 String ignoreTokenInUrls

A string that can contain a regular expression. It is useful in cases 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 int logLevel

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 boolean lowLatency

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 double maxUploadPercent

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 double p2pActivated

Activates QUANTEEC P2P system.

Default value: true

info

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.

quanteecKey

public String quanteecKey

Your personal QUANTEEC key, used to authenticate the plugin.

Default value: ""

sendingActivated

public boolean sendingActivated

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 String tracker

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 String videoID

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(String videoID, String quanteecKey)

Parameters

NameTypeDescription
videoIDStringSpecific name to identify a video in the QUANTEEC system. Useful if the video source URL contains a token that is different for every viewer.
quanteecKeyStringYour personal QUANTEEC key used to authenticate the plugin.