Add customizable key for frame seeking

hanydd · Feb 21, 2024 · f82fb79 · f82fb79
1 parent ff9641e
commit f82fb79
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 16 deletions.
diff --git a/public/_locales b/public/_locales
diff --git a/public/options/options.html b/public/options/options.html
@@ -427,13 +427,13 @@
 					<div class="inline"></div>
 				</div>
 
-				<div data-type="keybind-change" data-sync="nextChapterKeybind">
-					<label class="optionLabel">__MSG_nextChapterKeybind__:</label>
+				<div data-type="keybind-change" data-sync="nextFrameKeybind">
+					<label class="optionLabel">__MSG_nextFrameKeybind__:</label>
 					<div class="inline"></div>
 				</div>
 
-				<div data-type="keybind-change" data-sync="previousChapterKeybind">
-					<label class="optionLabel">__MSG_previousChapterKeybind__:</label>
+				<div data-type="keybind-change" data-sync="previousFrameKeybind">
+					<label class="optionLabel">__MSG_previousFrameKeybind__:</label>
 					<div class="inline"></div>
 				</div>
 

diff --git a/src/config.ts b/src/config.ts
@@ -88,8 +88,8 @@ interface SBConfig {
     submitKeybind: Keybind;
     actuallySubmitKeybind: Keybind;
     previewKeybind: Keybind;
-    nextChapterKeybind: Keybind;
-    previousChapterKeybind: Keybind;
+    nextFrameKeybind: Keybind;
+    previousFrameKeybind: Keybind;
     closeSkipNoticeKeybind: Keybind;
 
     // What categories should be skipped
@@ -332,8 +332,8 @@ const syncDefaults = {
     submitKeybind: { key: "'" },
     actuallySubmitKeybind: { key: "'", ctrl: true },
     previewKeybind: { key: ";", ctrl: true },
-    nextChapterKeybind: { key: "ArrowRight", ctrl: true },
-    previousChapterKeybind: { key: "ArrowLeft", ctrl: true },
+    nextFrameKeybind: { key: "." },
+    previousFrameKeybind: { key: "," },
     closeSkipNoticeKeybind: { key: "Backspace" },
 
     categorySelections: [{

diff --git a/src/content.ts b/src/content.ts
@@ -2101,7 +2101,7 @@ function openSubmissionMenu() {
     if (sponsorTimesSubmitting !== undefined && sponsorTimesSubmitting.length > 0) {
         submissionNotice = new SubmissionNotice(skipNoticeContentContainer, sendSubmitMessage);
         // Add key bind for jumpping to next frame, for easier sponsor time editting
-        document.addEventListener("keydown", seekFrameByKeyPress);
+        document.addEventListener("keydown", seekFrameByKeyPressListener);
     }
 }
 
@@ -2350,14 +2350,18 @@ function hotkeyListener(e: KeyboardEvent): void {
 /**
  * Hot keys to jump to the next or previous frame, for easier segment time editting
  * only effective when the SubmissionNotice is open
- * @param e keydown event
+ *
+ * Uses 1/30s as the frame rate, as it's the most common frame rate for videos
+ * @param key keydown event
  */
-export function seekFrameByKeyPress(e) {
+export function seekFrameByKeyPressListener(key) {
     const vid = getVideo()
     if (!vid.paused) return
-    if (e.key === ".") { // next frame
+
+    // TODO: better way to check framerate or next frame
+    if (keybindEquals(key, Config.config.nextFrameKeybind)) { // next frame
         vid.currentTime += 1 / 30;
-    } else if (e.key === ",") { // previous frame
+    } else if (keybindEquals(key, Config.config.previousFrameKeybind)) { // previous frame
         vid.currentTime -= 1 / 30;
     }
 }

diff --git a/src/render/SubmissionNotice.tsx b/src/render/SubmissionNotice.tsx
@@ -6,7 +6,7 @@ const utils = new Utils();
 
 import SubmissionNoticeComponent from "../components/SubmissionNoticeComponent";
 import { ContentContainer } from "../types";
-import { seekFrameByKeyPress } from "../content";
+import { seekFrameByKeyPressListener } from "../content";
 
 class SubmissionNotice {
     // Contains functions and variables from the content script needed by the skip notice
@@ -53,7 +53,7 @@ class SubmissionNotice {
 
         this.noticeElement.remove();
 
-        document.removeEventListener("keydown", seekFrameByKeyPress);
+        document.removeEventListener("keydown", seekFrameByKeyPressListener);
     }
 
     submit(): void {