Added twitch stream title the stream category icon in live portal

Author: SilenusTA

extensions/liveportal/views/scripts/datahandler.ejs

@@ -31,7 +31,7 @@
     const default_serverConfig = {
         // version number only needs updating if changing or deleting a variable.
         // new variables do not need the version updated.        
-        __version__: "0.6",
+        __version__: "0.7",
         // extensions vars
         extensionname: "liveportal",
         channel: "LIVE_PORTAL",
@@ -75,9 +75,32 @@
         currentchatAsPlatform: "twitch",
 
         // ##### settings widget variables
+
         // TTS settings
         TTSVoiceFilter: "English", // filter out voices you are interested in
-        //twith tts
+
+        // #################################################
+        // Partially updated code, needs finishing
+        // the tts data following this object should be updated to all come from this structure.
+        platformData:
+        {
+            twitch:
+            {
+                streamCategory: "",
+                streamCategoryImageCode: "",
+                streamTitle: "",
+                //twitch tts
+                /*
+                TTStwitchenabled: "off",
+                TTSVolume: "1",
+                TTSBlackList: "",
+                TTSVoiceName: "Please select a windows voice",
+                TTSVoiceIndex: -1,
+                */
+            }
+
+        },
+        //twitch tts
         winttstwitchenabled: "off",
         twitchTTSVolume: "1",
         twitchBlackList: "",
@@ -95,6 +118,9 @@
         kickBlackList: "",
         kickTTSVoiceName: "Please select a windows voice",
         kickTTSVoiceIndex: -1,
+
+        // Partially updated code end comment
+        // #################################################
         // random facts twitter settings
         randomfactsenabled: "on",
         randomfactstimeout: 1800000,//30 min
@@ -1067,11 +1093,17 @@
                 }
                 else if (extension_packet.type === "trigger_TwitchGamedChanged")
                 {
-                    let ele = document.getElementById("liveportaltitleTwitchCategoryImage")
                     let imagecode = extension_packet.data.parameters.imageURL.replace("{width}", 30).replace("{height}", 30)
-                    ele.title = extension_packet.data.parameters.name;
-                    ele.innerHTML = "<img style='border: 5px solid #6441a5; border-radius:50%' src='" + imagecode + "'>"
+                    serverConfig.platformData.twitch.streamCategory = extension_packet.data.parameters.name;
+                    serverConfig.platformData.twitch.streamCategoryImageCode = imagecode
+                    updateTwitchCategoryAndTitle()
                 }
+                else if (extension_packet.type === "trigger_TwitchTitleChanged")
+                {
+                    serverConfig.platformData.twitch.streamTitle = extension_packet.data.parameters.title
+                    updateTwitchCategoryAndTitle();
+                }
+
             }
             // -------------------------------------------------------------------------------------------------
             //                           DISCORD_CHAT
@@ -3989,7 +4021,7 @@
                     sr_api.ExtensionPacket(
                         "action_youtubeAPIPostLiveChatMessage",
                         serverConfig.extensionname,
-                        // need to read accounts from twitchchat ext and give an option to chose who to send the message as
+                        // need to read accounts from youtube ext and give an option to chose who to send the message as
                         {
                             platform: "youtube",
                             message: msg,
@@ -4006,7 +4038,7 @@
                     sr_api.ExtensionPacket(
                         "action_youtubePostLiveChatMessage",
                         serverConfig.extensionname,
-                        // need to read accounts from twitchchat ext and give an option to chose who to send the message as
+                        // need to read accounts from youtube ext and give an option to chose who to send the message as
                         {
                             platform: "youtube",
                             message: msg,
@@ -4729,4 +4761,16 @@
             sr_api.ServerPacket("ExtensionReady", serverConfig.extensionname));
         startupRequests()
     }
+    // ============================================================================
+    //                           FUNCTION: updateTwitchCategoryAndTitle
+    // ============================================================================
+    /**
+     * 
+     */
+    function updateTwitchCategoryAndTitle ()
+    {
+        let ele = document.getElementById("liveportaltitleTwitchCategoryImage")
+        ele.title = serverConfig.platformData.twitch.streamCategory + " : " + serverConfig.platformData.twitch.streamTitle;
+        ele.innerHTML = "<img style='border: 5px solid #6441a5; border-radius:50%' src='" + serverConfig.platformData.twitch.streamCategoryImageCode + "'>"
+    }
 </script>

extensions/twitch/server/server.js

@@ -60,6 +60,7 @@ const localConfig =
     twitchCategoryErrorsText: "",
     twitchCategoryErrorsShowCounter: 0,
     currentTwitchGameCategoryId: -1, // as reported by twitch
+    currentTwitchStreamTitle: "", // as reported by twitch
 
     sendUserTwitchChatCredentialsTimeout: 5000,
     sendUserTwitchChatCredentialsHandle: null,
@@ -2196,7 +2197,7 @@ function onDataCenterMessage (server_packet)
             // -----------------------------------------------------------------------------------
             else if (extension_packet.type === "action_GetTwitchStats")
             {
-                sendCurrentGameData(extension_packet.data.actionID)
+                sendTwitchStats(extension_packet.data.actionID)
             }
             // -----------------------------------------------------------------------------------
             //                   action_GetTwitchStats
@@ -2629,6 +2630,7 @@ async function connectTwitch ()
 
                 // set our current game id and add it to the history
                 localConfig.currentTwitchGameCategoryId = channelData.gameId;
+                localConfig.currentTwitchStreamTitle = channelData.title;
                 // need to do this here as we don't have the game image in the current data.
                 addGameToHistoryFromGameName(channelData.gameName)
                 // Connect to the pub sub event listener
@@ -2645,7 +2647,7 @@ async function connectTwitch ()
                 //to start up (if we have just started the server)
                 setTimeout(() =>
                 {
-                    sendCurrentGameData("twitch")
+                    sendTwitchStats("twitch")
                 }, 5000);
 
             })
@@ -4021,13 +4023,13 @@ function sendGameCategoriesTrigger (id = "twitch")
     sendTrigger(trigger)
 }
 // ===========================================================================
-//                           FUNCTION: sendCurrentGameData
+//                           FUNCTION: sendTwitchStats
 // ===========================================================================
 /**
  * sends trigger_TwitchGamedChanged
  * @param {number} [triggerId="twitch"] ref id from action
  */
-function sendCurrentGameData (triggerId = "twitch")
+function sendTwitchStats (triggerId = "twitch")
 {
     let trigger = findTriggerByMessageType("trigger_TwitchGamedChanged");
     const game = serverConfig.twitchCategoriesHistory.find(e => e.id === localConfig.currentTwitchGameCategoryId);
@@ -4036,6 +4038,14 @@ function sendCurrentGameData (triggerId = "twitch")
         trigger.parameters = { triggerId: triggerId, id: game.id, name: game.name, imageURL: game.imageURL }
         sendTrigger(trigger)
     }
+
+    trigger = findTriggerByMessageType("trigger_TwitchTitleChanged");
+    if (game)
+    {
+        trigger.parameters = { triggerId: triggerId, title: localConfig.currentTwitchStreamTitle }
+        sendTrigger(trigger)
+    }
+
 }
 // ===========================================================================
 //                           FUNCTION: raidChannel
@@ -4083,6 +4093,16 @@ function pubSubTriggerCallback (trigger)
         //save the serverConfig so we remember the changes
         SaveConfigToServer()
     }
+    else if (trigger.messagetype == "trigger_TwitchTitleChanged")
+    {
+        // change our setup so it matches the data from twitch
+        localConfig.currentTwitchStreamTitle = trigger.parameters.title;
+
+        //update any of our modals
+        SendSettingsWidgetSmall()
+        //save the serverConfig so we remember the changes
+        SaveConfigToServer()
+    }
     else
         logger.log(localConfig.SYSTEM_LOGGING_TAG + serverConfig.extensionname + ".getClipById", "pubSubTriggerCallback() no handler for ", trigger.messagetype, " twitch callback message");
 }