Stop devices from automatically sleeping

A TypeScript upgrade was necessary to bring in the types for the wake lock API.
This commit is contained in:
Robin Townsend
2023-07-21 00:51:07 -04:00
parent e4f2d86fcc
commit c0eeb035c8
4 changed files with 202 additions and 245 deletions

56
src/useWakeLock.ts Normal file
View File

@@ -0,0 +1,56 @@
/*
Copyright 2023 New Vector Ltd
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
import { logger } from "matrix-js-sdk/src/logger";
import { useEffect } from "react";
/**
* React hook that inhibits the device from automatically going to sleep.
*/
export const useWakeLock = () => {
useEffect(() => {
if ("wakeLock" in navigator) {
let mounted = true;
let lock: WakeLockSentinel | null = null;
const onVisiblityChange = async () => {
if (document.visibilityState === "visible") {
try {
lock = await navigator.wakeLock.request("screen");
if (!mounted)
lock
.release()
.catch((e) => logger.warn("Can't release wake lock", e));
} catch (e) {
logger.warn("Can't acquire wake lock", e);
}
}
};
onVisiblityChange();
document.addEventListener("visiblitychange", onVisiblityChange);
return () => {
mounted = false;
if (lock !== null)
lock
.release()
.catch((e) => logger.warn("Can't release wake lock", e));
document.removeEventListener("visiblitychange", onVisiblityChange);
};
}
}, []);
};