FEC-11861 Add fastData config support (#38)

Added fastData config support Updated ReadMe file with fastData values. Co-authored-by: Elisabet Massó <elisabet.masso@nicepeopleatwork.com>
kaltura · Apr 1, 2022 · d33149b · d33149b
1 parent 22f65a8
commit d33149b
Show file tree

Hide file tree

Showing 4 changed files with 53 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -175,6 +175,14 @@ let youboraPluginParams: [String: Any] = [
         "fatal": ["123", "errorcode"],
         "nonFatal": ["123", "errorcode"],
         "ignore": ["123", "errorcode"]
+    ],
+    "fastDataConfig": [
+        "host": "fastDataHost",
+        "code": "fastDataCode",
+        "pingTime": 60,
+        "beatTime": 30,
+        "expirationTime": 600,
+        "youboraId": "fastDataYouboraId"
     ]
 ]
 

diff --git a/Sources/YouboraConfig.swift b/Sources/YouboraConfig.swift
@@ -37,6 +37,9 @@ struct YouboraConfig: Decodable {
     let app: App?
     let session: Session?
     let errors: Errors?
+
+    // For YBFastDataConfig
+    let fastDataConfig: FastDataConfig?
 
     // Kaltura additional data
     fileprivate let kalturaInfo: KalturaInfo?
@@ -378,6 +381,15 @@ struct Errors: Decodable {
     // MARK: -
 }
 
+struct FastDataConfig: Decodable {
+    let host: String?
+    let code: String?
+    let pingTime: Double?
+    let beatTime: Double?
+    let expirationTime: Double?
+    let youboraId: String?
+}
+
 private struct KalturaInfo: Codable {
     let sessionId: String?
     let entryId: String?
@@ -632,3 +644,20 @@ extension YouboraConfig {
     }
 }
 
+extension YouboraConfig {
+
+    func getYBFastDataConfig() -> YBFastDataConfig? {
+        if let fastDataConfig = fastDataConfig {
+            let ybFastDataConfig = YBFastDataConfig()
+            ybFastDataConfig.host = fastDataConfig.host
+            ybFastDataConfig.code = fastDataConfig.code
+            ybFastDataConfig.pingTime = fastDataConfig.pingTime as NSNumber?
+            ybFastDataConfig.beatTime = fastDataConfig.beatTime as NSNumber?
+            ybFastDataConfig.expirationTime = fastDataConfig.expirationTime as NSNumber?
+            ybFastDataConfig.youboraId = fastDataConfig.youboraId
+            return ybFastDataConfig
+        }
+        return nil
+    }
+}
+
diff --git a/Sources/YouboraPlugin.swift b/Sources/YouboraPlugin.swift
@@ -75,7 +75,7 @@ public class YouboraPlugin: BasePlugin, AppStateObservable {
 
         YBLog.setDebugLevel(.debug)
 
-        ybPlugin = YBPlugin(options: youboraConfig?.options(), andAdapter: pkYouboraPlayerAdapter)
+        ybPlugin = YBPlugin(options: youboraConfig?.options(), adapter: pkYouboraPlayerAdapter, andConfig: youboraConfig?.getYBFastDataConfig())
         ybPlugin?.adsAdapter = pkYouboraAdsAdapter
 
         // Monitor app state changes

diff --git a/docs/YouboraSessions.md b/docs/YouboraSessions.md
@@ -0,0 +1,15 @@
+# Youbora sessions integration
+
+## To integrate youbora sessions follow this documentation:
+https://documentation.npaw.com/npaw-integration/docs/application-analytics-custom-events-data-collection
+This means: create a plugin instance that can be accessed globally, and call fireEvent() and fireNav() to report what you want.
+
+## Mix session analytics and video analytics
+After, to communicate youbora plugin for sessions and kaltura player:
+
+### Before instantiating the player:
+
+let youboradataconfig = plugin.viewTransform.fastDataConfig
+
+### When instantiating the player, and before starting any video view set the object obtained previously in youboraconfig object used in player's constructor.
+