Merge pull request #69 from AleziaKurdis/FixRecordApp

Fix the "Record" app
overte-org · May 24, 2024 · 1d9292d · 1d9292d
2 parents 4fe8017 + 70783fe
commit 1d9292d
Show file tree

Hide file tree

Showing 5 changed files with 202 additions and 207 deletions.
diff --git a/applications/record/README.md b/applications/record/README.md
diff --git a/applications/record/html/js/record.js b/applications/record/html/js/record.js
@@ -1,10 +1,10 @@
 "use strict";
-
 //
 //  record.js
 //
-//  Created by David Rowe on 5 Apr 2017.
+//  Created by David Rowe on April 5th, 2017.
 //  Copyright 2017 High Fidelity, Inc.
+//  Copyright 2024, Overte e.V.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
@@ -289,5 +289,9 @@ function onBodyLoaded() {
 
     elFinishOnOpenLabel = document.getElementById("finish-on-open-label");
 
+    var currentPath = window.location.protocol + "//" + window.location.host + window.location.pathname;
+    var ROOT = currentPath.replace("html/record.html", ""); //<=== Could be useful
+    document.getElementById("aCscriptUrl").value = ROOT + "playRecordingAC.js";
+
     signalBodyLoaded();
 }
diff --git a/applications/record/html/record.html b/applications/record/html/record.html
@@ -1,9 +1,10 @@
 <!--
 //  record.html
 //
-//  Created by David Rowe on 5 Apr 2017.
+//  Created by David Rowe on April 5th, 2017.
 //  Copyright 2017 High Fidelity, Inc.
 //  Copyright 2020 Vircadia contributors.
+//  Copyright 2024, Overte e.V.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
@@ -38,13 +39,13 @@
                     <tbody id="instructions" class="hidden">
                         <tr>
                             <td colspan="2">
-                                <p>This app lets you record and play back multiple instances of your avatar in your Sandbox.</p>
+                                <p>This app lets you record and play back multiple instances of your avatar in your domain.</p>
                                 <h1>Setup Instructions</h1>
-                                <p>In your sandbox domain:</p>
+                                <p>In your domain server:</p>
                                 <ul>
-                                    <li>Right-click the Vircadia Sandbox icon in your system tray and click &ldquo;Settings&rdquo;.</li>
+                                    <li>Right-click the domain server icon in your system tray and click &ldquo;Settings&rdquo;.</li>
                                     <li>In the &ldquo;Scripts&rdquo; section add a new row and paste in this script URL:<br />
-                                        <input type="text" value="https://cdn.vircadia.com/community-apps/applications/record/playRecordingAC.js" readonly />
+                                        <input type="text" id= "aCscriptUrl" value="" readonly />
                                     </li>
                                     <li>Set the number of recordings you&rsquo;d like to run at a given time in the &ldquo;Instances&rdquo; slot.</li>
                                     <li>Click &ldquo;Save and restart&rdquo;.</li>

diff --git a/applications/record/playRecordingAC.js b/applications/record/playRecordingAC.js
@@ -1,10 +1,10 @@
 "use strict";
-
 //
 //  playRecordingAC.js
 //
-//  Created by David Rowe on 7 Apr 2017.
+//  Created by David Rowe on April 7th, 2017.
 //  Copyright 2017 High Fidelity, Inc.
+//  Copyright 2024, Overte e.V.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
@@ -24,7 +24,6 @@
         AUTOPLAY_SEARCH_INTERVAL = 5000,
         AUTOPLAY_ERROR_INTERVAL = 30000,  // 30s
         scriptUUID,
-
         Entity,
         Player;
 
@@ -39,8 +38,8 @@
             updateTimestampTimer = null,
             ENTITY_NAME = "Recording",
             ENTITY_DESCRIPTION = "Avatar recording to play back",
-            ENTITIY_POSITION = { x: -16382, y: -16382, z: -16382 },  // Near but not right on domain corner.
-            ENTITY_SEARCH_DELTA = { x: 1, y: 1, z: 1 },  // Allow for position imprecision.
+            ENTITIY_POSITION = { "x": -16382, "y": -16382, "z": -16382 },  // Near but not right on domain corner.
+            ENTITY_SEARCH_DELTA = { "x": 1, "y": 1, "z": 1 },  // Allow for position imprecision.
             SEARCH_IDLE = 0,
             SEARCH_SEARCHING = 1,
             SEARCH_CLAIMING = 2,
@@ -50,7 +49,6 @@
             otherPlayersPlayingCounts,
             pauseCount,
             isDestroyLater = false,
-
             destroy;
 
         function onUpdateTimestamp() {
@@ -60,7 +58,7 @@
             }
 
             userData.timestamp = Date.now();
-            Entities.editEntity(entityID, { userData: JSON.stringify(userData) });
+            Entities.editEntity(entityID, { "userData": JSON.stringify(userData) });
             EntityViewer.queryOctree();  // Keep up to date ready for find().
         }
 
@@ -104,20 +102,20 @@
             searchState = SEARCH_IDLE;
 
             userData = {
-                recording: filename,
-                position: position,
-                orientation: orientation,
-                scriptUUID: scriptUUID,
-                timestamp: Date.now()
+                "recording": filename,
+                "position": position,
+                "orientation": orientation,
+                "scriptUUID": scriptUUID,
+                "timestamp": Date.now()
             };
 
             properties = {
-                type: "Box",
-                name: ENTITY_NAME,
-                description: ENTITY_DESCRIPTION,
-                position: ENTITIY_POSITION,
-                visible: false,
-                userData: JSON.stringify(userData)
+                "type": "Box",
+                "name": ENTITY_NAME,
+                "description": ENTITY_DESCRIPTION,
+                "position": ENTITIY_POSITION,
+                "visible": false,
+                "userData": JSON.stringify(userData)
             };
 
             entityID = Entities.addEntity(properties);
@@ -162,75 +160,74 @@
                 result = null;
 
             switch (searchState) {
+                case SEARCH_IDLE:
+                    log("Start searching");
+                    otherPlayersPlaying = [];
+                    otherPlayersPlayingCounts = [];
+                    Messages.subscribe(HIFI_RECORDER_CHANNEL);
+                    Messages.messageReceived.connect(onMessageReceived);
+                    searchState = SEARCH_SEARCHING;
+                    break;
 
-            case SEARCH_IDLE:
-                log("Start searching");
-                otherPlayersPlaying = [];
-                otherPlayersPlayingCounts = [];
-                Messages.subscribe(HIFI_RECORDER_CHANNEL);
-                Messages.messageReceived.connect(onMessageReceived);
-                searchState = SEARCH_SEARCHING;
-                break;
-
-            case SEARCH_SEARCHING:
-                // Find an entity that isn't being played or claimed.
-                entityIDs = Entities.findEntities(ENTITIY_POSITION, ENTITY_SEARCH_DELTA.x);
-                if (entityIDs.length > 0) {
-                    index = -1;
-                    while (!found && index < entityIDs.length - 1) {
-                        index += 1;
-                        if (otherPlayersPlaying.indexOf(entityIDs[index]) === -1) {
-                            properties = Entities.getEntityProperties(entityIDs[index], ["name", "userData"]);
-                            userData = JSON.parse(properties.userData);
-                            found = properties.name === ENTITY_NAME && userData.recording !== undefined;
+                case SEARCH_SEARCHING:
+                    // Find an entity that isn't being played or claimed.
+                    entityIDs = Entities.findEntities(ENTITIY_POSITION, ENTITY_SEARCH_DELTA.x);
+                    if (entityIDs.length > 0) {
+                        index = -1;
+                        while (!found && index < entityIDs.length - 1) {
+                            index += 1;
+                            if (otherPlayersPlaying.indexOf(entityIDs[index]) === -1) {
+                                properties = Entities.getEntityProperties(entityIDs[index], ["name", "userData"]);
+                                userData = JSON.parse(properties.userData);
+                                found = properties.name === ENTITY_NAME && userData.recording !== undefined;
+                            }
                         }
                     }
-                }
 
-                // Claim entity if found.
-                if (found) {
-                    log("Claim entity " + entityIDs[index]);
-                    entityID = entityIDs[index];
-                    searchState = SEARCH_CLAIMING;
-                }
-                break;
-
-            case SEARCH_CLAIMING:
-                // How many other players are claiming (or playing) this entity?
-                index = otherPlayersPlaying.indexOf(entityID);
-                numberOfClaims = index !== -1 ? otherPlayersPlayingCounts[index] : 0;
-
-                // Have found an entity to play if no other players are also claiming it.
-                if (numberOfClaims === 0) {
-                    log("Complete claim " + entityID);
-                    Messages.messageReceived.disconnect(onMessageReceived);
-                    Messages.unsubscribe(HIFI_RECORDER_CHANNEL);
-                    searchState = SEARCH_IDLE;
-                    userData.scriptUUID = scriptUUID;
-                    userData.timestamp = Date.now();
-                    Entities.editEntity(entityID, { userData: JSON.stringify(userData) });
-                    updateTimestampTimer = Script.setInterval(onUpdateTimestamp, TIMESTAMP_UPDATE_INTERVAL);
-                    result = { recording: userData.recording, position: userData.position, orientation: userData.orientation };
+                    // Claim entity if found.
+                    if (found) {
+                        log("Claim entity " + entityIDs[index]);
+                        entityID = entityIDs[index];
+                        searchState = SEARCH_CLAIMING;
+                    }
                     break;
-                }
 
-                // Otherwise back off for a bit before resuming search.
-                log("Release claim " + entityID + " and pause searching");
-                entityID = null;
-                pauseCount = randomInt(0, otherPlayersPlaying.length);
-                searchState = SEARCH_PAUSING;
-                break;
+                case SEARCH_CLAIMING:
+                    // How many other players are claiming (or playing) this entity?
+                    index = otherPlayersPlaying.indexOf(entityID);
+                    numberOfClaims = index !== -1 ? otherPlayersPlayingCounts[index] : 0;
+
+                    // Have found an entity to play if no other players are also claiming it.
+                    if (numberOfClaims === 0) {
+                        log("Complete claim " + entityID);
+                        Messages.messageReceived.disconnect(onMessageReceived);
+                        Messages.unsubscribe(HIFI_RECORDER_CHANNEL);
+                        searchState = SEARCH_IDLE;
+                        userData.scriptUUID = scriptUUID;
+                        userData.timestamp = Date.now();
+                        Entities.editEntity(entityID, { userData: JSON.stringify(userData) });
+                        updateTimestampTimer = Script.setInterval(onUpdateTimestamp, TIMESTAMP_UPDATE_INTERVAL);
+                        result = { recording: userData.recording, position: userData.position, orientation: userData.orientation };
+                        break;
+                    }
 
-            case SEARCH_PAUSING:
-                // Resume searching if have paused long enough.
-                pauseCount -= 1;
-                if (pauseCount < 0) {
-                    log("Resume searching");
-                    otherPlayersPlaying = [];
-                    otherPlayersPlayingCounts = [];
-                    searchState = SEARCH_SEARCHING;
-                }
-                break;
+                    // Otherwise back off for a bit before resuming search.
+                    log("Release claim " + entityID + " and pause searching");
+                    entityID = null;
+                    pauseCount = randomInt(0, otherPlayersPlaying.length);
+                    searchState = SEARCH_PAUSING;
+                    break;
+
+                case SEARCH_PAUSING:
+                    // Resume searching if have paused long enough.
+                    pauseCount -= 1;
+                    if (pauseCount < 0) {
+                        log("Resume searching");
+                        otherPlayersPlaying = [];
+                        otherPlayersPlayingCounts = [];
+                        searchState = SEARCH_SEARCHING;
+                    }
+                    break;
             }
 
             EntityViewer.queryOctree();
@@ -269,13 +266,13 @@
         }
 
         return {
-            id: id,
-            create: create,
-            find: find,
-            destroy: destroy,
-            destroyLater: destroyLater,
-            setUp: setUp,
-            tearDown: tearDown
+            "id": id,
+            "create": create,
+            "find": find,
+            "destroy": destroy,
+            "destroyLater": destroyLater,
+            "setUp": setUp,
+            "tearDown": tearDown
         };
     }());
 
@@ -285,16 +282,15 @@
             isPlayingRecording = false,
             recordingFilename = "",
             autoPlayTimer = null,
-
             autoPlay,
             playRecording;
 
         function error(message) {
             // Send error message to user.
             Messages.sendMessage(HIFI_RECORDER_CHANNEL, JSON.stringify({
-                command: RECORDER_COMMAND_ERROR,
-                user: userID,
-                message: message
+                "command": RECORDER_COMMAND_ERROR,
+                "user": userID,
+                "message": message
             }));
         }
 
@@ -422,21 +418,21 @@
         }
 
         return {
-            autoPlay: autoPlay,
-            play: play,
-            stop: stop,
-            isPlaying: isPlaying,
-            recording: recording,
-            setUp: setUp,
-            tearDown: tearDown
+            "autoPlay": autoPlay,
+            "play": play,
+            "stop": stop,
+            "isPlaying": isPlaying,
+            "recording": recording,
+            "setUp": setUp,
+            "tearDown": tearDown
         };
     }());
 
     function sendHeartbeat() {
         Messages.sendMessage(HIFI_RECORDER_CHANNEL, JSON.stringify({
-            playing: Player.isPlaying(),
-            recording: Player.recording(),
-            entity: Entity.id()
+            "playing": Player.isPlaying(),
+            "recording": Player.recording(),
+            "entity": Entity.id()
         }));
     }