InsightConfig

public struct InsightConfig

Defines the parameters required to Report using the Insight Agent

  • API URL to report to. Depends on the location to report to (US, EU, etc). Provided by Insight.

    Declaration

    Swift

    public let collectorURL: String

  • ID of the device reporting

    Declaration

    Swift

    public var deviceId: String

  • Operator ID Token. Provided by Insight

    Declaration

    Swift

    public var operatorId: String

  • Amount of seconds between each sample

    Declaration

    Swift

    public let samplingInterval: TimeInterval

  • Amount of seconds between each report submitted to the Insight API

    Declaration

    Swift

    public let reportingInterval: TimeInterval

  • The type of Device

    Declaration

    Swift

    public let deviceType: DeviceType?

  • Manufacturer of the Device

    Declaration

    Swift

    public let deviceManufacturer: String?

  • Model of the Device

    Declaration

    Swift

    public let deviceModel: String?

  • Name of the Video App

    Declaration

    Swift

    public let appName: String?

  • App Version

    Declaration

    Swift

    public let appVersion: String?

  • Name of the Operating System

    Declaration

    Swift

    public let osName: String?

  • Version of the Operating System

    Declaration

    Swift

    public let osVersion: String?

  • Screen width in pixel

    Declaration

    Swift

    public let screenWidth: Int?

  • Screen height in pixels

    Declaration

    Swift

    public let screenHeight: Int?

  • Screen density ratio

    Declaration

    Swift

    public let screenDensity: Int?

  • Timezone (i.e., Europe/Paris or UTC offset)

    Declaration

    Swift

    public let timezone: String?

  • Declaration

    Swift

    public let framedropsEnabled: Bool

  • When the integrationMode is enabled then some integrity checks can thow errors

    Declaration

    Swift

    public let integrationMode: Bool

  • The name of the player

    Declaration

    Swift

    public let playerName: String?

  • The version of the player

    Declaration

    Swift

    public let playerVersion: String?

  • Screen refresh rate in Hz

    Declaration

    Swift

    public let screenRefreshRate: Float?

  • Defines all the parameters to define where to report to, and about the reporting device

    Declaration

    Swift

    public init(collectorURL: String = "https://collector.insight-stats.com/api/v1/",
            deviceId: String,
            operatorId: String,
            samplingInterval: TimeInterval = 30,
            reportingInterval: TimeInterval = 60 * 5,
            framedropsEnabled: Bool = true,
            deviceType: DeviceType? = nil,
            appName: String? = nil,
            appVersion: String? = nil,
            screenWidth: Int? = nil,
            screenHeight: Int? = nil,
            screenDensity: Int? = nil,
            timezone: String? = nil,
            integrationMode: Bool = false,
            playerName: String? = nil,
            playerVersion: String? = nil,
            screenRefreshRate: Float? = nil
)

    Parameters

    collectorURL

    API URL to report to. Depends on the location to report to (US, EU, etc). Provided by Insight.
    deviceId

    ID of the device reporting
    operatorId

    Operator ID Token. Provided by Insight
    samplingInterval

    Amount of seconds between each sample
    reportingInterval

    Amount of seconds between each report submitted to the Insight API
    deviceType

    The type of Device
    deviceManufacturer

    Manufacturer of the Device
    deviceModel

    Model of the Device
    appName

    Name of the Video App
    appVersion

    App Version
    osName

    Name of the Operating System
    osVersion

    Version of the Operating System
    screenWidth

    Screen width in pixel
    screenHeight

    Screen height in pixels
    screenDensity

    Screen density ratio
    timezone

    Timezone (i.e., Europe/Paris or UTC offset)
    framedropsEnabled

    Lets the agent know if framedrop reporting is enabled
    integrationMode

    If set to true, it allows non valid operations to be detected during the integration by throwing errors. If set to false (which is the default value) then the errors will only be logged.
    playerName

    name of the player
    playerVersion

    version number of the player
    screenRefreshRate

    Screen refresh rate in Hz