@applemusic-like-lyrics/react 0.3.2 → 0.4.0

package/README.md

@@ -36,7 +36,7 @@ yarn add @applemusic-like-lyrics/react # using yarn
 
 For detailed API documentation, please refer to [./docs/modules.md](./docs/modules.md)
 
-A test program can be found in [./src/test.tsx](./src/test.tsx).
+A test program can be found in [../playground/react/src/test.tsx](../playground/react/src/test.tsx).
 
 ```tsx
 import { LyricPlayer } from "@applemusic-like-lyrics/react";

package/dist/amll-react.cjs

@@ -0,0 +1,228 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+let _applemusic_like_lyrics_core = require("@applemusic-like-lyrics/core");
+let react = require("react");
+let react_jsx_runtime = require("react/jsx-runtime");
+let react_dom = require("react-dom");
+//#region src/bg-render.tsx
+/**
+* 流体背景渲染组件，通过提供图片链接可以显示出酷似 Apple Music 的流体背景效果
+*/
+const BackgroundRender = (0, react.forwardRef)(({ album, albumIsVideo, fps, playing, flowSpeed, renderScale, staticMode, lowFreqVolume, hasLyric, renderer, style, ...props }, ref) => {
+	const coreBGRenderRef = (0, react.useRef)(null);
+	const wrapperRef = (0, react.useRef)(null);
+	const lastRendererRef = (0, react.useRef)(null);
+	const curRenderer = renderer ?? _applemusic_like_lyrics_core.MeshGradientRenderer;
+	(0, react.useEffect)(() => {
+		if (lastRendererRef.current !== curRenderer || coreBGRenderRef.current === void 0) {
+			lastRendererRef.current = curRenderer;
+			coreBGRenderRef.current?.dispose();
+			coreBGRenderRef.current = _applemusic_like_lyrics_core.BackgroundRender.new(curRenderer);
+		}
+	}, [curRenderer]);
+	(0, react.useEffect)(() => {
+		if (curRenderer && album) coreBGRenderRef.current?.setAlbum(album, albumIsVideo);
+	}, [
+		curRenderer,
+		album,
+		albumIsVideo
+	]);
+	(0, react.useEffect)(() => {
+		if (curRenderer && fps) coreBGRenderRef.current?.setFPS(fps);
+	}, [curRenderer, fps]);
+	(0, react.useEffect)(() => {
+		if (!curRenderer) return;
+		if (playing === void 0) coreBGRenderRef.current?.resume();
+		else if (playing) coreBGRenderRef.current?.resume();
+		else coreBGRenderRef.current?.pause();
+	}, [curRenderer, playing]);
+	(0, react.useEffect)(() => {
+		if (!curRenderer) return;
+		if (flowSpeed) coreBGRenderRef.current?.setFlowSpeed(flowSpeed);
+	}, [curRenderer, flowSpeed]);
+	(0, react.useEffect)(() => {
+		if (!curRenderer) return;
+		coreBGRenderRef.current?.setStaticMode(staticMode ?? false);
+	}, [curRenderer, staticMode]);
+	(0, react.useEffect)(() => {
+		if (curRenderer && renderScale) coreBGRenderRef.current?.setRenderScale(renderScale ?? .5);
+	}, [curRenderer, renderScale]);
+	(0, react.useEffect)(() => {
+		if (curRenderer && lowFreqVolume) coreBGRenderRef.current?.setLowFreqVolume(lowFreqVolume ?? 1);
+	}, [curRenderer, lowFreqVolume]);
+	(0, react.useEffect)(() => {
+		if (curRenderer && hasLyric !== void 0) coreBGRenderRef.current?.setHasLyric(hasLyric ?? true);
+	}, [curRenderer, hasLyric]);
+	(0, react.useEffect)(() => {
+		if (coreBGRenderRef.current) {
+			const el = coreBGRenderRef.current.getElement();
+			el.style.width = "100%";
+			el.style.height = "100%";
+			el.style.minHeight = "0";
+			el.style.minWidth = "0";
+			el.style.overflow = "hidden";
+			wrapperRef.current?.appendChild(el);
+		}
+	}, [coreBGRenderRef.current]);
+	(0, react.useImperativeHandle)(ref, () => ({
+		wrapperEl: wrapperRef.current,
+		bgRender: coreBGRenderRef.current
+	}), [wrapperRef.current, coreBGRenderRef.current]);
+	return /* @__PURE__ */ (0, react_jsx_runtime.jsx)("div", {
+		style: {
+			display: "contents",
+			...style
+		},
+		...props,
+		ref: wrapperRef
+	});
+});
+//#endregion
+//#region src/lyric-player.tsx
+/**
+* 歌词播放组件，本框架的核心组件
+*
+* 尽可能贴切 Apple Music for iPad 的歌词效果设计，且做了力所能及的优化措施
+*/
+const LyricPlayer = (0, react.forwardRef)(({ disabled, playing, alignAnchor, alignPosition, enableSpring, enableBlur, enableScale, maskObsceneWordsMode, maskObsceneWordChar, hidePassedLines, lyricLines, currentTime, isSeeking, wordFadeWidth, linePosXSpringParams, linePosYSpringParams, lineScaleSpringParams, bottomLine, lyricPlayer, onLyricLineClick, onLyricLineContextMenu, ...props }, ref) => {
+	const [corePlayer, setCorePlayer] = (0, react.useState)();
+	const wrapperRef = (0, react.useRef)(null);
+	const currentTimeRef = (0, react.useRef)(currentTime);
+	(0, react.useLayoutEffect)(() => {
+		const newPlayer = new (lyricPlayer ?? _applemusic_like_lyrics_core.LyricPlayer)();
+		setCorePlayer(newPlayer);
+		wrapperRef.current?.appendChild(newPlayer.getElement());
+		return () => {
+			newPlayer?.dispose();
+			setCorePlayer(void 0);
+		};
+	}, [lyricPlayer]);
+	(0, react.useLayoutEffect)(() => {
+		if (lyricLines !== void 0) {
+			corePlayer?.setLyricLines(lyricLines, currentTimeRef.current);
+			corePlayer?.update();
+		} else {
+			corePlayer?.setLyricLines([]);
+			corePlayer?.update();
+		}
+	}, [corePlayer, lyricLines]);
+	(0, react.useEffect)(() => {
+		if (!disabled) {
+			let canceled = false;
+			let lastTime = -1;
+			const onFrame = (time) => {
+				if (canceled) return;
+				if (lastTime === -1) lastTime = time;
+				corePlayer?.update(time - lastTime);
+				lastTime = time;
+				requestAnimationFrame(onFrame);
+			};
+			corePlayer?.calcLayout();
+			requestAnimationFrame(onFrame);
+			return () => {
+				canceled = true;
+			};
+		}
+	}, [corePlayer, disabled]);
+	(0, react.useEffect)(() => {
+		if (playing !== void 0) if (playing) corePlayer?.resume();
+		else corePlayer?.pause();
+		else corePlayer?.resume();
+	}, [corePlayer, playing]);
+	(0, react.useEffect)(() => {
+		if (alignAnchor !== void 0) corePlayer?.setAlignAnchor(alignAnchor);
+	}, [corePlayer, alignAnchor]);
+	(0, react.useEffect)(() => {
+		if (hidePassedLines !== void 0) corePlayer?.setHidePassedLines(hidePassedLines);
+	}, [corePlayer, hidePassedLines]);
+	(0, react.useEffect)(() => {
+		if (alignPosition !== void 0) corePlayer?.setAlignPosition(alignPosition);
+	}, [corePlayer, alignPosition]);
+	(0, react.useEffect)(() => {
+		if (enableSpring !== void 0) corePlayer?.setEnableSpring(enableSpring);
+		else corePlayer?.setEnableSpring(true);
+	}, [corePlayer, enableSpring]);
+	(0, react.useEffect)(() => {
+		if (enableScale !== void 0) corePlayer?.setEnableScale(enableScale);
+		else corePlayer?.setEnableScale(true);
+	}, [corePlayer, enableScale]);
+	(0, react.useEffect)(() => {
+		corePlayer?.setEnableBlur(enableBlur ?? true);
+	}, [corePlayer, enableBlur]);
+	(0, react.useEffect)(() => {
+		if (currentTime !== void 0) {
+			corePlayer?.setCurrentTime(currentTime, isSeeking);
+			currentTimeRef.current = currentTime;
+		} else corePlayer?.setCurrentTime(0);
+	}, [
+		corePlayer,
+		currentTime,
+		isSeeking
+	]);
+	(0, react.useEffect)(() => {
+		corePlayer?.setIsSeeking(!!isSeeking);
+	}, [corePlayer, isSeeking]);
+	(0, react.useEffect)(() => {
+		corePlayer?.setWordFadeWidth(wordFadeWidth);
+	}, [corePlayer, wordFadeWidth]);
+	(0, react.useEffect)(() => {
+		if (linePosXSpringParams !== void 0) corePlayer?.setLinePosXSpringParams(linePosXSpringParams);
+	}, [corePlayer, linePosXSpringParams]);
+	(0, react.useEffect)(() => {
+		if (linePosYSpringParams !== void 0) corePlayer?.setLinePosYSpringParams(linePosYSpringParams);
+	}, [corePlayer, linePosYSpringParams]);
+	(0, react.useEffect)(() => {
+		if (lineScaleSpringParams !== void 0) corePlayer?.setLineScaleSpringParams(lineScaleSpringParams);
+	}, [corePlayer, lineScaleSpringParams]);
+	(0, react.useEffect)(() => {
+		if (maskObsceneWordsMode !== void 0) corePlayer?.setMaskObsceneWords(maskObsceneWordsMode);
+		else corePlayer?.setMaskObsceneWords(_applemusic_like_lyrics_core.MaskObsceneWordsMode.Disabled);
+	}, [corePlayer, maskObsceneWordsMode]);
+	(0, react.useEffect)(() => {
+		if (maskObsceneWordChar !== void 0) corePlayer?.setMaskObsceneWordChar(maskObsceneWordChar);
+	}, [corePlayer, maskObsceneWordChar]);
+	(0, react.useEffect)(() => {
+		if (onLyricLineClick) {
+			const handler = (e) => onLyricLineClick(e);
+			corePlayer?.addEventListener("line-click", handler);
+			return () => corePlayer?.removeEventListener("line-click", handler);
+		}
+	}, [corePlayer, onLyricLineClick]);
+	(0, react.useEffect)(() => {
+		if (onLyricLineContextMenu) {
+			const handler = (e) => onLyricLineContextMenu(e);
+			corePlayer?.addEventListener("line-contextmenu", handler);
+			return () => corePlayer?.removeEventListener("line-contextmenu", handler);
+		}
+	}, [corePlayer, onLyricLineContextMenu]);
+	(0, react.useImperativeHandle)(ref, () => ({
+		wrapperEl: wrapperRef.current,
+		lyricPlayer: corePlayer
+	}), [corePlayer]);
+	return /* @__PURE__ */ (0, react_jsx_runtime.jsxs)(react_jsx_runtime.Fragment, { children: [/* @__PURE__ */ (0, react_jsx_runtime.jsx)("div", {
+		...props,
+		ref: wrapperRef
+	}), corePlayer?.getBottomLineElement() && bottomLine ? (0, react_dom.createPortal)(bottomLine, corePlayer?.getBottomLineElement()) : null] });
+});
+//#endregion
+exports.BackgroundRender = BackgroundRender;
+Object.defineProperty(exports, "BaseRenderer", {
+	enumerable: true,
+	get: function() {
+		return _applemusic_like_lyrics_core.BaseRenderer;
+	}
+});
+exports.LyricPlayer = LyricPlayer;
+Object.defineProperty(exports, "MeshGradientRenderer", {
+	enumerable: true,
+	get: function() {
+		return _applemusic_like_lyrics_core.MeshGradientRenderer;
+	}
+});
+Object.defineProperty(exports, "PixiRenderer", {
+	enumerable: true,
+	get: function() {
+		return _applemusic_like_lyrics_core.PixiRenderer;
+	}
+});
+
+//# sourceMappingURL=amll-react.cjs.map

package/dist/amll-react.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"amll-react.cjs","names":["MeshGradientRenderer","CoreBackgroundRender","DefaultLyricPlayer","MaskObsceneWordsMode"],"sources":["../src/bg-render.tsx","../src/lyric-player.tsx"],"sourcesContent":["import {\n\ttype AbstractBaseRenderer,\n\ttype BaseRenderer,\n\tBackgroundRender as CoreBackgroundRender,\n\tMeshGradientRenderer,\n} from \"@applemusic-like-lyrics/core\";\nimport {\n\ttype ForwardRefExoticComponent,\n\tforwardRef,\n\ttype HTMLProps,\n\ttype RefAttributes,\n\tuseEffect,\n\tuseImperativeHandle,\n\tuseRef,\n} from \"react\";\n\nexport {\n\tBaseRenderer,\n\tMeshGradientRenderer,\n\tPixiRenderer,\n} from \"@applemusic-like-lyrics/core\";\n\n/**\n * 背景渲染组件的属性\n */\nexport interface BackgroundRenderProps {\n\t/**\n\t * 设置背景专辑资源\n\t */\n\talbum?: string | HTMLImageElement | HTMLVideoElement;\n\t/**\n\t * 设置专辑资源是否为视频\n\t */\n\talbumIsVideo?: boolean;\n\t/**\n\t * 设置当前背景动画帧率，如果为 `undefined` 则默认为 `30`\n\t */\n\tfps?: number;\n\t/**\n\t * 设置当前播放状态，如果为 `undefined` 则默认为 `true`\n\t */\n\tplaying?: boolean;\n\t/**\n\t * 设置当前动画流动速度，如果为 `undefined` 则默认为 `2`\n\t */\n\tflowSpeed?: number;\n\t/**\n\t * 设置背景是否根据“是否有歌词”这个特征调整自身效果，例如有歌词时会变得更加活跃\n\t *\n\t * 部分渲染器会根据这个特征调整自身效果\n\t *\n\t * 如果不确定是否需要赋值或无法知晓是否包含歌词，请传入 true 或不做任何处理（默认值为 true）\n\t */\n\thasLyric?: boolean;\n\t/**\n\t * 设置低频的音量大小，范围在 80hz-120hz 之间为宜，取值范围在 [0.0-1.0] 之间\n\t *\n\t * 部分渲染器会根据音量大小调整背景效果（例如根据鼓点跳动）\n\t *\n\t * 如果无法获取到类似的数据，请传入 undefined 或 1.0 作为默认值，或不做任何处理（默认值即 1.0）\n\t */\n\tlowFreqVolume?: number;\n\t/**\n\t * 设置当前渲染缩放比例，如果为 `undefined` 则默认为 `0.5`\n\t */\n\trenderScale?: number;\n\t/**\n\t * 是否启用静态模式，即图片在更换后就会保持静止状态并禁用更新，以节省性能\n\t * 默认为 `false`\n\t */\n\tstaticMode?: boolean;\n\t/**\n\t * 设置渲染器，如果为 `undefined` 则默认为 `PixiRenderer`\n\t * 默认渲染器有可能会随着版本更新而更换\n\t */\n\trenderer?: {\n\t\tnew (...args: ConstructorParameters<typeof BaseRenderer>): BaseRenderer;\n\t};\n}\n\n/**\n * 背景渲染组件的引用\n */\nexport interface BackgroundRenderRef {\n\t/**\n\t * 背景渲染实例引用\n\t */\n\tbgRender?: AbstractBaseRenderer;\n\t/**\n\t * 将背景渲染实例的元素包裹起来的 DIV 元素实例\n\t */\n\twrapperEl: HTMLDivElement | null;\n}\n\n/**\n * 流体背景渲染组件，通过提供图片链接可以显示出酷似 Apple Music 的流体背景效果\n */\nexport const BackgroundRender: ForwardRefExoticComponent<\n\tOmit<HTMLProps<HTMLDivElement> & BackgroundRenderProps, \"ref\"> &\n\t\tRefAttributes<BackgroundRenderRef>\n> = forwardRef<\n\tBackgroundRenderRef,\n\tHTMLProps<HTMLDivElement> & BackgroundRenderProps\n>(\n\t(\n\t\t{\n\t\t\talbum,\n\t\t\talbumIsVideo,\n\t\t\tfps,\n\t\t\tplaying,\n\t\t\tflowSpeed,\n\t\t\trenderScale,\n\t\t\tstaticMode,\n\t\t\tlowFreqVolume,\n\t\t\thasLyric,\n\t\t\trenderer,\n\t\t\tstyle,\n\t\t\t...props\n\t\t},\n\t\tref,\n\t) => {\n\t\tconst coreBGRenderRef = useRef<AbstractBaseRenderer>(null);\n\t\tconst wrapperRef = useRef<HTMLDivElement>(null);\n\t\tconst lastRendererRef = useRef<{\n\t\t\tnew (canvas: HTMLCanvasElement): BaseRenderer;\n\t\t}>(null);\n\t\tconst curRenderer = renderer ?? MeshGradientRenderer;\n\n\t\tuseEffect(() => {\n\t\t\tif (\n\t\t\t\tlastRendererRef.current !== curRenderer ||\n\t\t\t\tcoreBGRenderRef.current === undefined\n\t\t\t) {\n\t\t\t\tlastRendererRef.current = curRenderer;\n\t\t\t\tcoreBGRenderRef.current?.dispose();\n\t\t\t\tcoreBGRenderRef.current = CoreBackgroundRender.new(curRenderer);\n\t\t\t}\n\t\t}, [curRenderer]);\n\n\t\tuseEffect(() => {\n\t\t\tif (curRenderer && album)\n\t\t\t\tcoreBGRenderRef.current?.setAlbum(album, albumIsVideo);\n\t\t}, [curRenderer, album, albumIsVideo]);\n\n\t\tuseEffect(() => {\n\t\t\tif (curRenderer && fps) coreBGRenderRef.current?.setFPS(fps);\n\t\t}, [curRenderer, fps]);\n\n\t\tuseEffect(() => {\n\t\t\tif (!curRenderer) return;\n\t\t\tif (playing === undefined) {\n\t\t\t\tcoreBGRenderRef.current?.resume();\n\t\t\t} else if (playing) {\n\t\t\t\tcoreBGRenderRef.current?.resume();\n\t\t\t} else {\n\t\t\t\tcoreBGRenderRef.current?.pause();\n\t\t\t}\n\t\t}, [curRenderer, playing]);\n\n\t\tuseEffect(() => {\n\t\t\tif (!curRenderer) return;\n\t\t\tif (flowSpeed) coreBGRenderRef.current?.setFlowSpeed(flowSpeed);\n\t\t}, [curRenderer, flowSpeed]);\n\n\t\tuseEffect(() => {\n\t\t\tif (!curRenderer) return;\n\t\t\tcoreBGRenderRef.current?.setStaticMode(staticMode ?? false);\n\t\t}, [curRenderer, staticMode]);\n\n\t\tuseEffect(() => {\n\t\t\tif (curRenderer && renderScale)\n\t\t\t\tcoreBGRenderRef.current?.setRenderScale(renderScale ?? 0.5);\n\t\t}, [curRenderer, renderScale]);\n\n\t\tuseEffect(() => {\n\t\t\tif (curRenderer && lowFreqVolume)\n\t\t\t\tcoreBGRenderRef.current?.setLowFreqVolume(lowFreqVolume ?? 1.0);\n\t\t}, [curRenderer, lowFreqVolume]);\n\n\t\tuseEffect(() => {\n\t\t\tif (curRenderer && hasLyric !== undefined)\n\t\t\t\tcoreBGRenderRef.current?.setHasLyric(hasLyric ?? true);\n\t\t}, [curRenderer, hasLyric]);\n\n\t\t// biome-ignore lint/correctness/useExhaustiveDependencies: coreBGRenderRef.current\n\t\tuseEffect(() => {\n\t\t\tif (coreBGRenderRef.current) {\n\t\t\t\tconst el = coreBGRenderRef.current.getElement();\n\t\t\t\tel.style.width = \"100%\";\n\t\t\t\tel.style.height = \"100%\";\n\t\t\t\tel.style.minHeight = \"0\";\n\t\t\t\tel.style.minWidth = \"0\";\n\t\t\t\tel.style.overflow = \"hidden\";\n\t\t\t\twrapperRef.current?.appendChild(el);\n\t\t\t}\n\t\t}, [coreBGRenderRef.current]);\n\n\t\t// biome-ignore lint/correctness/useExhaustiveDependencies: wrapperRef.current, coreBGRenderRef.current\n\t\tuseImperativeHandle(\n\t\t\tref,\n\t\t\t() => ({\n\t\t\t\twrapperEl: wrapperRef.current,\n\t\t\t\tbgRender: coreBGRenderRef.current!,\n\t\t\t}),\n\t\t\t[wrapperRef.current, coreBGRenderRef.current],\n\t\t);\n\n\t\treturn (\n\t\t\t<div\n\t\t\t\tstyle={{\n\t\t\t\t\tdisplay: \"contents\",\n\t\t\t\t\t...style,\n\t\t\t\t}}\n\t\t\t\t{...props}\n\t\t\t\tref={wrapperRef}\n\t\t\t/>\n\t\t);\n\t},\n);\n","import type {\n\tLyricLine,\n\tLyricLineMouseEvent,\n\tLyricPlayerBase,\n\tspring,\n} from \"@applemusic-like-lyrics/core\";\nimport {\n\tLyricPlayer as DefaultLyricPlayer,\n\tMaskObsceneWordsMode,\n} from \"@applemusic-like-lyrics/core\";\nimport {\n\ttype ForwardRefExoticComponent,\n\tforwardRef,\n\ttype HTMLProps,\n\ttype RefAttributes,\n\tuseEffect,\n\tuseImperativeHandle,\n\tuseLayoutEffect,\n\tuseRef,\n\tuseState,\n} from \"react\";\nimport { createPortal } from \"react-dom\";\n\n/**\n * 歌词播放组件的属性\n */\nexport interface LyricPlayerProps {\n\t/**\n\t * 是否禁用歌词播放组件，默认为 `false`，歌词组件启用后将会开始逐帧更新歌词的动画效果，并对传入的其他参数变更做出反馈。\n\t *\n\t * 如果禁用了歌词组件动画，你也可以通过引用取得原始渲染组件实例，手动逐帧调用其 `update` 函数来更新动画效果。\n\t */\n\tdisabled?: boolean;\n\t/**\n\t * 是否演出部分效果，目前会控制播放间奏点的动画的播放暂停与否，默认为 `true`\n\t */\n\tplaying?: boolean;\n\t/**\n\t * 设置歌词行的对齐方式，如果为 `undefined` 则默认为 `center`\n\t *\n\t * - 设置成 `top` 的话将会向目标歌词行的顶部对齐\n\t * - 设置成 `bottom` 的话将会向目标歌词行的底部对齐\n\t * - 设置成 `center` 的话将会向目标歌词行的垂直中心对齐\n\t */\n\talignAnchor?: \"top\" | \"bottom\" | \"center\";\n\t/**\n\t * 设置默认的歌词行对齐位置，相对于整个歌词播放组件的大小位置，如果为 `undefined`\n\t * 则默认为 `0.5`\n\t *\n\t * 可以设置一个 `[0.0-1.0]` 之间的任意数字，代表组件高度由上到下的比例位置\n\t */\n\talignPosition?: number;\n\t/**\n\t * 设置是否使用物理弹簧算法实现歌词动画效果，默认启用\n\t *\n\t * 如果启用，则会通过弹簧算法实时处理歌词位置，但是需要性能足够强劲的电脑方可流畅运行\n\t *\n\t * 如果不启用，则会回退到基于 `transition` 的过渡效果，对低性能的机器比较友好，但是效果会比较单一\n\t */\n\tenableSpring?: boolean;\n\t/**\n\t * 设置是否启用歌词行的模糊效果，默认为 `true`\n\t */\n\tenableBlur?: boolean;\n\t/**\n\t * 设置是否使用物理弹簧算法实现歌词动画效果，默认启用\n\t *\n\t * 如果启用，则会通过弹簧算法实时处理歌词位置，但是需要性能足够强劲的电脑方可流畅运行\n\t *\n\t * 如果不启用，则会回退到基于 `transition` 的过渡效果，对低性能的机器比较友好，但是效果会比较单一\n\t */\n\tenableScale?: boolean;\n\t/**\n\t * 设置是否隐藏已经播放过的歌词行，默认不隐藏\n\t */\n\thidePassedLines?: boolean;\n\t/**\n\t * 设置歌词中不雅用语的掩码模式，默认为 `MaskObsceneWordsMode.Disabled`，即不掩码\n\t */\n\tmaskObsceneWordsMode?: MaskObsceneWordsMode;\n\t/**\n\t * 设置不雅用语掩码使用的字符，默认为 `*`\n\t */\n\tmaskObsceneWordChar?: string;\n\t/**\n\t * 设置当前播放歌词，要注意传入后这个数组内的信息不得修改，否则会发生错误\n\t */\n\tlyricLines?: LyricLine[];\n\t/**\n\t * 设置当前播放进度，单位为毫秒且**必须是整数**，此时将会更新内部的歌词进度信息\n\t * 内部会根据调用间隔和播放进度自动决定如何滚动和显示歌词，所以这个的调用频率越快越准确越好\n\t */\n\tcurrentTime?: number;\n\tisSeeking?: boolean;\n\t/**\n\t * 设置文字动画的渐变宽度，单位以歌词行的主文字字体大小的倍数为单位，默认为 0.5，即一个全角字符的一半宽度\n\t *\n\t * 如果要模拟 Apple Music for Android 的效果，可以设置为 1\n\t *\n\t * 如果要模拟 Apple Music for iPad 的效果，可以设置为 0.5\n\t *\n\t * 如果想要近乎禁用渐变效果，可以设置成非常接近 0 的小数（例如 `0.0001` ），但是**不可以为 0**\n\t */\n\twordFadeWidth?: number;\n\t/**\n\t * 设置所有歌词行在横坐标上的弹簧属性，包括重量、弹力和阻力。\n\t *\n\t * @param params 需要设置的弹簧属性，提供的属性将会覆盖原来的属性，未提供的属性将会保持原样\n\t */\n\tlinePosXSpringParams?: Partial<spring.SpringParams>;\n\t/**\n\t * 设置所有歌词行在​纵坐标上的弹簧属性，包括重量、弹力和阻力。\n\t *\n\t * @param params 需要设置的弹簧属性，提供的属性将会覆盖原来的属性，未提供的属性将会保持原样\n\t */\n\tlinePosYSpringParams?: Partial<spring.SpringParams>;\n\t/**\n\t * 设置所有歌词行在​缩放大小上的弹簧属性，包括重量、弹力和阻力。\n\t *\n\t * @param params 需要设置的弹簧属性，提供的属性将会覆盖原来的属性，未提供的属性将会保持原样\n\t */\n\tlineScaleSpringParams?: Partial<spring.SpringParams>;\n\t/**\n\t * 在一个特殊的底栏元素内加入指定元素，默认是空白的，可以往内部添加任意元素\n\t *\n\t * 这个元素始终在歌词的底部，可以用于显示歌曲创作者等信息\n\t */\n\tbottomLine?: Parameters<typeof createPortal>[0];\n\t/**\n\t * 需要用于创建歌词播放组件的类实例\n\t */\n\tlyricPlayer?: {\n\t\tnew (\n\t\t\t...args: ConstructorParameters<typeof LyricPlayerBase>\n\t\t): LyricPlayerBase;\n\t};\n\t/**\n\t * 当某个歌词行被左键点击时触发的事件\n\t * @param line 歌词行的事件对象，可以访问到对应的歌词行信息和歌词行索引\n\t */\n\tonLyricLineClick?: (line: LyricLineMouseEvent) => void;\n\t/**\n\t * 当某个歌词行被右键点击时触发的事件\n\t * @param line 歌词行的事件对象，可以访问到对应的歌词行信息和歌词行索引\n\t */\n\tonLyricLineContextMenu?: (line: LyricLineMouseEvent) => void;\n}\n\n/**\n * 歌词播放组件的引用\n */\nexport interface LyricPlayerRef {\n\t/**\n\t * 歌词播放实例\n\t */\n\tlyricPlayer?: LyricPlayerBase;\n\t/**\n\t * 将歌词播放实例的元素包裹起来的 DIV 元素实例\n\t */\n\twrapperEl: HTMLDivElement | null;\n}\n\n/**\n * 歌词播放组件，本框架的核心组件\n *\n * 尽可能贴切 Apple Music for iPad 的歌词效果设计，且做了力所能及的优化措施\n */\nexport const LyricPlayer: ForwardRefExoticComponent<\n\tOmit<HTMLProps<HTMLDivElement> & LyricPlayerProps, \"ref\"> &\n\t\tRefAttributes<LyricPlayerRef>\n> = forwardRef<LyricPlayerRef, HTMLProps<HTMLDivElement> & LyricPlayerProps>(\n\t(\n\t\t{\n\t\t\tdisabled,\n\t\t\tplaying,\n\t\t\talignAnchor,\n\t\t\talignPosition,\n\t\t\tenableSpring,\n\t\t\tenableBlur,\n\t\t\tenableScale,\n\t\t\tmaskObsceneWordsMode,\n\t\t\tmaskObsceneWordChar,\n\t\t\thidePassedLines,\n\t\t\tlyricLines,\n\t\t\tcurrentTime,\n\t\t\tisSeeking,\n\t\t\twordFadeWidth,\n\t\t\tlinePosXSpringParams,\n\t\t\tlinePosYSpringParams,\n\t\t\tlineScaleSpringParams,\n\t\t\tbottomLine,\n\t\t\tlyricPlayer,\n\t\t\tonLyricLineClick,\n\t\t\tonLyricLineContextMenu,\n\t\t\t...props\n\t\t},\n\t\tref,\n\t) => {\n\t\t// const corePlayerRef = useRef<LyricPlayerBase>();\n\t\tconst [corePlayer, setCorePlayer] = useState<LyricPlayerBase>();\n\t\tconst wrapperRef = useRef<HTMLDivElement>(null);\n\t\tconst currentTimeRef = useRef(currentTime);\n\n\t\tuseLayoutEffect(() => {\n\t\t\tconst newPlayer = new (lyricPlayer ?? DefaultLyricPlayer)();\n\t\t\tsetCorePlayer(newPlayer);\n\t\t\twrapperRef.current?.appendChild(newPlayer.getElement());\n\t\t\treturn () => {\n\t\t\t\tnewPlayer?.dispose();\n\t\t\t\tsetCorePlayer(undefined);\n\t\t\t};\n\t\t}, [lyricPlayer]);\n\n\t\tuseLayoutEffect(() => {\n\t\t\tif (lyricLines !== undefined) {\n\t\t\t\tcorePlayer?.setLyricLines(lyricLines, currentTimeRef.current);\n\t\t\t\tcorePlayer?.update();\n\t\t\t} else {\n\t\t\t\tcorePlayer?.setLyricLines([]);\n\t\t\t\tcorePlayer?.update();\n\t\t\t}\n\t\t}, [corePlayer, lyricLines]);\n\n\t\tuseEffect(() => {\n\t\t\tif (!disabled) {\n\t\t\t\tlet canceled = false;\n\t\t\t\tlet lastTime = -1;\n\t\t\t\tconst onFrame = (time: number) => {\n\t\t\t\t\tif (canceled) return;\n\t\t\t\t\tif (lastTime === -1) {\n\t\t\t\t\t\tlastTime = time;\n\t\t\t\t\t}\n\t\t\t\t\tcorePlayer?.update(time - lastTime);\n\t\t\t\t\tlastTime = time;\n\t\t\t\t\trequestAnimationFrame(onFrame);\n\t\t\t\t};\n\t\t\t\tcorePlayer?.calcLayout();\n\t\t\t\trequestAnimationFrame(onFrame);\n\t\t\t\treturn () => {\n\t\t\t\t\tcanceled = true;\n\t\t\t\t};\n\t\t\t}\n\t\t\treturn;\n\t\t}, [corePlayer, disabled]);\n\n\t\tuseEffect(() => {\n\t\t\tif (playing !== undefined) {\n\t\t\t\tif (playing) {\n\t\t\t\t\tcorePlayer?.resume();\n\t\t\t\t} else {\n\t\t\t\t\tcorePlayer?.pause();\n\t\t\t\t}\n\t\t\t} else corePlayer?.resume();\n\t\t}, [corePlayer, playing]);\n\n\t\tuseEffect(() => {\n\t\t\tif (alignAnchor !== undefined) corePlayer?.setAlignAnchor(alignAnchor);\n\t\t}, [corePlayer, alignAnchor]);\n\n\t\tuseEffect(() => {\n\t\t\tif (hidePassedLines !== undefined)\n\t\t\t\tcorePlayer?.setHidePassedLines(hidePassedLines);\n\t\t}, [corePlayer, hidePassedLines]);\n\n\t\tuseEffect(() => {\n\t\t\tif (alignPosition !== undefined)\n\t\t\t\tcorePlayer?.setAlignPosition(alignPosition);\n\t\t}, [corePlayer, alignPosition]);\n\n\t\tuseEffect(() => {\n\t\t\tif (enableSpring !== undefined) corePlayer?.setEnableSpring(enableSpring);\n\t\t\telse corePlayer?.setEnableSpring(true);\n\t\t}, [corePlayer, enableSpring]);\n\n\t\tuseEffect(() => {\n\t\t\tif (enableScale !== undefined) corePlayer?.setEnableScale(enableScale);\n\t\t\telse corePlayer?.setEnableScale(true);\n\t\t}, [corePlayer, enableScale]);\n\n\t\tuseEffect(() => {\n\t\t\tcorePlayer?.setEnableBlur(enableBlur ?? true);\n\t\t}, [corePlayer, enableBlur]);\n\n\t\tuseEffect(() => {\n\t\t\tif (currentTime !== undefined) {\n\t\t\t\tcorePlayer?.setCurrentTime(currentTime, isSeeking);\n\t\t\t\tcurrentTimeRef.current = currentTime;\n\t\t\t} else corePlayer?.setCurrentTime(0);\n\t\t}, [corePlayer, currentTime, isSeeking]);\n\n\t\tuseEffect(() => {\n\t\t\tcorePlayer?.setIsSeeking(!!isSeeking);\n\t\t}, [corePlayer, isSeeking]);\n\n\t\tuseEffect(() => {\n\t\t\tcorePlayer?.setWordFadeWidth(wordFadeWidth);\n\t\t}, [corePlayer, wordFadeWidth]);\n\n\t\tuseEffect(() => {\n\t\t\tif (linePosXSpringParams !== undefined)\n\t\t\t\tcorePlayer?.setLinePosXSpringParams(linePosXSpringParams);\n\t\t}, [corePlayer, linePosXSpringParams]);\n\n\t\tuseEffect(() => {\n\t\t\tif (linePosYSpringParams !== undefined)\n\t\t\t\tcorePlayer?.setLinePosYSpringParams(linePosYSpringParams);\n\t\t}, [corePlayer, linePosYSpringParams]);\n\n\t\tuseEffect(() => {\n\t\t\tif (lineScaleSpringParams !== undefined)\n\t\t\t\tcorePlayer?.setLineScaleSpringParams(lineScaleSpringParams);\n\t\t}, [corePlayer, lineScaleSpringParams]);\n\n\t\tuseEffect(() => {\n\t\t\tif (maskObsceneWordsMode !== undefined) {\n\t\t\t\tcorePlayer?.setMaskObsceneWords(maskObsceneWordsMode);\n\t\t\t} else {\n\t\t\t\tcorePlayer?.setMaskObsceneWords(MaskObsceneWordsMode.Disabled);\n\t\t\t}\n\t\t}, [corePlayer, maskObsceneWordsMode]);\n\n\t\tuseEffect(() => {\n\t\t\tif (maskObsceneWordChar !== undefined) {\n\t\t\t\tcorePlayer?.setMaskObsceneWordChar(maskObsceneWordChar);\n\t\t\t}\n\t\t}, [corePlayer, maskObsceneWordChar]);\n\n\t\tuseEffect(() => {\n\t\t\tif (onLyricLineClick) {\n\t\t\t\tconst handler = (e: Event) =>\n\t\t\t\t\tonLyricLineClick(e as LyricLineMouseEvent);\n\t\t\t\tcorePlayer?.addEventListener(\"line-click\", handler);\n\t\t\t\treturn () => corePlayer?.removeEventListener(\"line-click\", handler);\n\t\t\t}\n\t\t\treturn;\n\t\t}, [corePlayer, onLyricLineClick]);\n\n\t\tuseEffect(() => {\n\t\t\tif (onLyricLineContextMenu) {\n\t\t\t\tconst handler = (e: Event) =>\n\t\t\t\t\tonLyricLineContextMenu(e as LyricLineMouseEvent);\n\t\t\t\tcorePlayer?.addEventListener(\"line-contextmenu\", handler);\n\t\t\t\treturn () =>\n\t\t\t\t\tcorePlayer?.removeEventListener(\"line-contextmenu\", handler);\n\t\t\t}\n\t\t\treturn;\n\t\t}, [corePlayer, onLyricLineContextMenu]);\n\n\t\tuseImperativeHandle(\n\t\t\tref,\n\t\t\t() => ({\n\t\t\t\twrapperEl: wrapperRef.current,\n\t\t\t\tlyricPlayer: corePlayer,\n\t\t\t}),\n\t\t\t[corePlayer],\n\t\t);\n\n\t\treturn (\n\t\t\t<>\n\t\t\t\t<div {...props} ref={wrapperRef} />\n\t\t\t\t{corePlayer?.getBottomLineElement() && bottomLine\n\t\t\t\t\t? createPortal(bottomLine, corePlayer?.getBottomLineElement())\n\t\t\t\t\t: null}\n\t\t\t</>\n\t\t);\n\t},\n);\n"],"mappings":";;;;;;;;;AAiGA,MAAa,oBAAA,GAAA,MAAA,aAQX,EACC,OACA,cACA,KACA,SACA,WACA,aACA,YACA,eACA,UACA,UACA,OACA,GAAG,SAEJ,QACI;CACJ,MAAM,mBAAA,GAAA,MAAA,QAA+C,KAAK;CAC1D,MAAM,cAAA,GAAA,MAAA,QAAoC,KAAK;CAC/C,MAAM,mBAAA,GAAA,MAAA,QAEH,KAAK;CACR,MAAM,cAAc,YAAYA,6BAAAA;AAEhC,EAAA,GAAA,MAAA,iBAAgB;AACf,MACC,gBAAgB,YAAY,eAC5B,gBAAgB,YAAY,KAAA,GAC3B;AACD,mBAAgB,UAAU;AAC1B,mBAAgB,SAAS,SAAS;AAClC,mBAAgB,UAAUC,6BAAAA,iBAAqB,IAAI,YAAY;;IAE9D,CAAC,YAAY,CAAC;AAEjB,EAAA,GAAA,MAAA,iBAAgB;AACf,MAAI,eAAe,MAClB,iBAAgB,SAAS,SAAS,OAAO,aAAa;IACrD;EAAC;EAAa;EAAO;EAAa,CAAC;AAEtC,EAAA,GAAA,MAAA,iBAAgB;AACf,MAAI,eAAe,IAAK,iBAAgB,SAAS,OAAO,IAAI;IAC1D,CAAC,aAAa,IAAI,CAAC;AAEtB,EAAA,GAAA,MAAA,iBAAgB;AACf,MAAI,CAAC,YAAa;AAClB,MAAI,YAAY,KAAA,EACf,iBAAgB,SAAS,QAAQ;WACvB,QACV,iBAAgB,SAAS,QAAQ;MAEjC,iBAAgB,SAAS,OAAO;IAE/B,CAAC,aAAa,QAAQ,CAAC;AAE1B,EAAA,GAAA,MAAA,iBAAgB;AACf,MAAI,CAAC,YAAa;AAClB,MAAI,UAAW,iBAAgB,SAAS,aAAa,UAAU;IAC7D,CAAC,aAAa,UAAU,CAAC;AAE5B,EAAA,GAAA,MAAA,iBAAgB;AACf,MAAI,CAAC,YAAa;AAClB,kBAAgB,SAAS,cAAc,cAAc,MAAM;IACzD,CAAC,aAAa,WAAW,CAAC;AAE7B,EAAA,GAAA,MAAA,iBAAgB;AACf,MAAI,eAAe,YAClB,iBAAgB,SAAS,eAAe,eAAe,GAAI;IAC1D,CAAC,aAAa,YAAY,CAAC;AAE9B,EAAA,GAAA,MAAA,iBAAgB;AACf,MAAI,eAAe,cAClB,iBAAgB,SAAS,iBAAiB,iBAAiB,EAAI;IAC9D,CAAC,aAAa,cAAc,CAAC;AAEhC,EAAA,GAAA,MAAA,iBAAgB;AACf,MAAI,eAAe,aAAa,KAAA,EAC/B,iBAAgB,SAAS,YAAY,YAAY,KAAK;IACrD,CAAC,aAAa,SAAS,CAAC;AAG3B,EAAA,GAAA,MAAA,iBAAgB;AACf,MAAI,gBAAgB,SAAS;GAC5B,MAAM,KAAK,gBAAgB,QAAQ,YAAY;AAC/C,MAAG,MAAM,QAAQ;AACjB,MAAG,MAAM,SAAS;AAClB,MAAG,MAAM,YAAY;AACrB,MAAG,MAAM,WAAW;AACpB,MAAG,MAAM,WAAW;AACpB,cAAW,SAAS,YAAY,GAAG;;IAElC,CAAC,gBAAgB,QAAQ,CAAC;AAG7B,EAAA,GAAA,MAAA,qBACC,YACO;EACN,WAAW,WAAW;EACtB,UAAU,gBAAgB;EAC1B,GACD,CAAC,WAAW,SAAS,gBAAgB,QAAQ,CAC7C;AAED,QACC,iBAAA,GAAA,kBAAA,KAAC,OAAD;EACC,OAAO;GACN,SAAS;GACT,GAAG;GACH;EACD,GAAI;EACJ,KAAK;EACJ,CAAA;EAGJ;;;;;;;;ACnDD,MAAa,eAAA,GAAA,MAAA,aAKX,EACC,UACA,SACA,aACA,eACA,cACA,YACA,aACA,sBACA,qBACA,iBACA,YACA,aACA,WACA,eACA,sBACA,sBACA,uBACA,YACA,aACA,kBACA,wBACA,GAAG,SAEJ,QACI;CAEJ,MAAM,CAAC,YAAY,kBAAA,GAAA,MAAA,WAA4C;CAC/D,MAAM,cAAA,GAAA,MAAA,QAAoC,KAAK;CAC/C,MAAM,kBAAA,GAAA,MAAA,QAAwB,YAAY;AAE1C,EAAA,GAAA,MAAA,uBAAsB;EACrB,MAAM,YAAY,KAAK,eAAeC,6BAAAA,cAAqB;AAC3D,gBAAc,UAAU;AACxB,aAAW,SAAS,YAAY,UAAU,YAAY,CAAC;AACvD,eAAa;AACZ,cAAW,SAAS;AACpB,iBAAc,KAAA,EAAU;;IAEvB,CAAC,YAAY,CAAC;AAEjB,EAAA,GAAA,MAAA,uBAAsB;AACrB,MAAI,eAAe,KAAA,GAAW;AAC7B,eAAY,cAAc,YAAY,eAAe,QAAQ;AAC7D,eAAY,QAAQ;SACd;AACN,eAAY,cAAc,EAAE,CAAC;AAC7B,eAAY,QAAQ;;IAEnB,CAAC,YAAY,WAAW,CAAC;AAE5B,EAAA,GAAA,MAAA,iBAAgB;AACf,MAAI,CAAC,UAAU;GACd,IAAI,WAAW;GACf,IAAI,WAAW;GACf,MAAM,WAAW,SAAiB;AACjC,QAAI,SAAU;AACd,QAAI,aAAa,GAChB,YAAW;AAEZ,gBAAY,OAAO,OAAO,SAAS;AACnC,eAAW;AACX,0BAAsB,QAAQ;;AAE/B,eAAY,YAAY;AACxB,yBAAsB,QAAQ;AAC9B,gBAAa;AACZ,eAAW;;;IAIX,CAAC,YAAY,SAAS,CAAC;AAE1B,EAAA,GAAA,MAAA,iBAAgB;AACf,MAAI,YAAY,KAAA,EACf,KAAI,QACH,aAAY,QAAQ;MAEpB,aAAY,OAAO;MAEd,aAAY,QAAQ;IACzB,CAAC,YAAY,QAAQ,CAAC;AAEzB,EAAA,GAAA,MAAA,iBAAgB;AACf,MAAI,gBAAgB,KAAA,EAAW,aAAY,eAAe,YAAY;IACpE,CAAC,YAAY,YAAY,CAAC;AAE7B,EAAA,GAAA,MAAA,iBAAgB;AACf,MAAI,oBAAoB,KAAA,EACvB,aAAY,mBAAmB,gBAAgB;IAC9C,CAAC,YAAY,gBAAgB,CAAC;AAEjC,EAAA,GAAA,MAAA,iBAAgB;AACf,MAAI,kBAAkB,KAAA,EACrB,aAAY,iBAAiB,cAAc;IAC1C,CAAC,YAAY,cAAc,CAAC;AAE/B,EAAA,GAAA,MAAA,iBAAgB;AACf,MAAI,iBAAiB,KAAA,EAAW,aAAY,gBAAgB,aAAa;MACpE,aAAY,gBAAgB,KAAK;IACpC,CAAC,YAAY,aAAa,CAAC;AAE9B,EAAA,GAAA,MAAA,iBAAgB;AACf,MAAI,gBAAgB,KAAA,EAAW,aAAY,eAAe,YAAY;MACjE,aAAY,eAAe,KAAK;IACnC,CAAC,YAAY,YAAY,CAAC;AAE7B,EAAA,GAAA,MAAA,iBAAgB;AACf,cAAY,cAAc,cAAc,KAAK;IAC3C,CAAC,YAAY,WAAW,CAAC;AAE5B,EAAA,GAAA,MAAA,iBAAgB;AACf,MAAI,gBAAgB,KAAA,GAAW;AAC9B,eAAY,eAAe,aAAa,UAAU;AAClD,kBAAe,UAAU;QACnB,aAAY,eAAe,EAAE;IAClC;EAAC;EAAY;EAAa;EAAU,CAAC;AAExC,EAAA,GAAA,MAAA,iBAAgB;AACf,cAAY,aAAa,CAAC,CAAC,UAAU;IACnC,CAAC,YAAY,UAAU,CAAC;AAE3B,EAAA,GAAA,MAAA,iBAAgB;AACf,cAAY,iBAAiB,cAAc;IACzC,CAAC,YAAY,cAAc,CAAC;AAE/B,EAAA,GAAA,MAAA,iBAAgB;AACf,MAAI,yBAAyB,KAAA,EAC5B,aAAY,wBAAwB,qBAAqB;IACxD,CAAC,YAAY,qBAAqB,CAAC;AAEtC,EAAA,GAAA,MAAA,iBAAgB;AACf,MAAI,yBAAyB,KAAA,EAC5B,aAAY,wBAAwB,qBAAqB;IACxD,CAAC,YAAY,qBAAqB,CAAC;AAEtC,EAAA,GAAA,MAAA,iBAAgB;AACf,MAAI,0BAA0B,KAAA,EAC7B,aAAY,yBAAyB,sBAAsB;IAC1D,CAAC,YAAY,sBAAsB,CAAC;AAEvC,EAAA,GAAA,MAAA,iBAAgB;AACf,MAAI,yBAAyB,KAAA,EAC5B,aAAY,oBAAoB,qBAAqB;MAErD,aAAY,oBAAoBC,6BAAAA,qBAAqB,SAAS;IAE7D,CAAC,YAAY,qBAAqB,CAAC;AAEtC,EAAA,GAAA,MAAA,iBAAgB;AACf,MAAI,wBAAwB,KAAA,EAC3B,aAAY,uBAAuB,oBAAoB;IAEtD,CAAC,YAAY,oBAAoB,CAAC;AAErC,EAAA,GAAA,MAAA,iBAAgB;AACf,MAAI,kBAAkB;GACrB,MAAM,WAAW,MAChB,iBAAiB,EAAyB;AAC3C,eAAY,iBAAiB,cAAc,QAAQ;AACnD,gBAAa,YAAY,oBAAoB,cAAc,QAAQ;;IAGlE,CAAC,YAAY,iBAAiB,CAAC;AAElC,EAAA,GAAA,MAAA,iBAAgB;AACf,MAAI,wBAAwB;GAC3B,MAAM,WAAW,MAChB,uBAAuB,EAAyB;AACjD,eAAY,iBAAiB,oBAAoB,QAAQ;AACzD,gBACC,YAAY,oBAAoB,oBAAoB,QAAQ;;IAG5D,CAAC,YAAY,uBAAuB,CAAC;AAExC,EAAA,GAAA,MAAA,qBACC,YACO;EACN,WAAW,WAAW;EACtB,aAAa;EACb,GACD,CAAC,WAAW,CACZ;AAED,QACC,iBAAA,GAAA,kBAAA,MAAA,kBAAA,UAAA,EAAA,UAAA,CACC,iBAAA,GAAA,kBAAA,KAAC,OAAD;EAAK,GAAI;EAAO,KAAK;EAAc,CAAA,EAClC,YAAY,sBAAsB,IAAI,cAAA,GAAA,UAAA,cACvB,YAAY,YAAY,sBAAsB,CAAC,GAC5D,KACD,EAAA,CAAA;EAGL"}

package/dist/amll-react.d.cts

@@ -0,0 +1,225 @@
+import { AbstractBaseRenderer, BaseRenderer, BaseRenderer as BaseRenderer$1, LyricLine, LyricLineMouseEvent, LyricPlayerBase, MaskObsceneWordsMode, MeshGradientRenderer, PixiRenderer, spring } from "@applemusic-like-lyrics/core";
+import { ForwardRefExoticComponent, HTMLProps, RefAttributes } from "react";
+import { createPortal } from "react-dom";
+
+//#region src/bg-render.d.ts
+/**
+* 背景渲染组件的属性
+*/
+interface BackgroundRenderProps {
+  /**
+  * 设置背景专辑资源
+  */
+  album?: string | HTMLImageElement | HTMLVideoElement;
+  /**
+  * 设置专辑资源是否为视频
+  */
+  albumIsVideo?: boolean;
+  /**
+  * 设置当前背景动画帧率，如果为 `undefined` 则默认为 `30`
+  */
+  fps?: number;
+  /**
+  * 设置当前播放状态，如果为 `undefined` 则默认为 `true`
+  */
+  playing?: boolean;
+  /**
+  * 设置当前动画流动速度，如果为 `undefined` 则默认为 `2`
+  */
+  flowSpeed?: number;
+  /**
+  * 设置背景是否根据“是否有歌词”这个特征调整自身效果，例如有歌词时会变得更加活跃
+  *
+  * 部分渲染器会根据这个特征调整自身效果
+  *
+  * 如果不确定是否需要赋值或无法知晓是否包含歌词，请传入 true 或不做任何处理（默认值为 true）
+  */
+  hasLyric?: boolean;
+  /**
+  * 设置低频的音量大小，范围在 80hz-120hz 之间为宜，取值范围在 [0.0-1.0] 之间
+  *
+  * 部分渲染器会根据音量大小调整背景效果（例如根据鼓点跳动）
+  *
+  * 如果无法获取到类似的数据，请传入 undefined 或 1.0 作为默认值，或不做任何处理（默认值即 1.0）
+  */
+  lowFreqVolume?: number;
+  /**
+  * 设置当前渲染缩放比例，如果为 `undefined` 则默认为 `0.5`
+  */
+  renderScale?: number;
+  /**
+  * 是否启用静态模式，即图片在更换后就会保持静止状态并禁用更新，以节省性能
+  * 默认为 `false`
+  */
+  staticMode?: boolean;
+  /**
+  * 设置渲染器，如果为 `undefined` 则默认为 `PixiRenderer`
+  * 默认渲染器有可能会随着版本更新而更换
+  */
+  renderer?: {
+    new (...args: ConstructorParameters<typeof BaseRenderer$1>): BaseRenderer$1;
+  };
+}
+/**
+* 背景渲染组件的引用
+*/
+interface BackgroundRenderRef {
+  /**
+  * 背景渲染实例引用
+  */
+  bgRender?: AbstractBaseRenderer;
+  /**
+  * 将背景渲染实例的元素包裹起来的 DIV 元素实例
+  */
+  wrapperEl: HTMLDivElement | null;
+}
+/**
+* 流体背景渲染组件，通过提供图片链接可以显示出酷似 Apple Music 的流体背景效果
+*/
+declare const BackgroundRender: ForwardRefExoticComponent<Omit<HTMLProps<HTMLDivElement> & BackgroundRenderProps, "ref"> & RefAttributes<BackgroundRenderRef>>;
+//#endregion
+//#region src/lyric-player.d.ts
+/**
+* 歌词播放组件的属性
+*/
+interface LyricPlayerProps {
+  /**
+  * 是否禁用歌词播放组件，默认为 `false`，歌词组件启用后将会开始逐帧更新歌词的动画效果，并对传入的其他参数变更做出反馈。
+  *
+  * 如果禁用了歌词组件动画，你也可以通过引用取得原始渲染组件实例，手动逐帧调用其 `update` 函数来更新动画效果。
+  */
+  disabled?: boolean;
+  /**
+  * 是否演出部分效果，目前会控制播放间奏点的动画的播放暂停与否，默认为 `true`
+  */
+  playing?: boolean;
+  /**
+  * 设置歌词行的对齐方式，如果为 `undefined` 则默认为 `center`
+  *
+  * - 设置成 `top` 的话将会向目标歌词行的顶部对齐
+  * - 设置成 `bottom` 的话将会向目标歌词行的底部对齐
+  * - 设置成 `center` 的话将会向目标歌词行的垂直中心对齐
+  */
+  alignAnchor?: "top" | "bottom" | "center";
+  /**
+  * 设置默认的歌词行对齐位置，相对于整个歌词播放组件的大小位置，如果为 `undefined`
+  * 则默认为 `0.5`
+  *
+  * 可以设置一个 `[0.0-1.0]` 之间的任意数字，代表组件高度由上到下的比例位置
+  */
+  alignPosition?: number;
+  /**
+  * 设置是否使用物理弹簧算法实现歌词动画效果，默认启用
+  *
+  * 如果启用，则会通过弹簧算法实时处理歌词位置，但是需要性能足够强劲的电脑方可流畅运行
+  *
+  * 如果不启用，则会回退到基于 `transition` 的过渡效果，对低性能的机器比较友好，但是效果会比较单一
+  */
+  enableSpring?: boolean;
+  /**
+  * 设置是否启用歌词行的模糊效果，默认为 `true`
+  */
+  enableBlur?: boolean;
+  /**
+  * 设置是否使用物理弹簧算法实现歌词动画效果，默认启用
+  *
+  * 如果启用，则会通过弹簧算法实时处理歌词位置，但是需要性能足够强劲的电脑方可流畅运行
+  *
+  * 如果不启用，则会回退到基于 `transition` 的过渡效果，对低性能的机器比较友好，但是效果会比较单一
+  */
+  enableScale?: boolean;
+  /**
+  * 设置是否隐藏已经播放过的歌词行，默认不隐藏
+  */
+  hidePassedLines?: boolean;
+  /**
+  * 设置歌词中不雅用语的掩码模式，默认为 `MaskObsceneWordsMode.Disabled`，即不掩码
+  */
+  maskObsceneWordsMode?: MaskObsceneWordsMode;
+  /**
+  * 设置不雅用语掩码使用的字符，默认为 `*`
+  */
+  maskObsceneWordChar?: string;
+  /**
+  * 设置当前播放歌词，要注意传入后这个数组内的信息不得修改，否则会发生错误
+  */
+  lyricLines?: LyricLine[];
+  /**
+  * 设置当前播放进度，单位为毫秒且**必须是整数**，此时将会更新内部的歌词进度信息
+  * 内部会根据调用间隔和播放进度自动决定如何滚动和显示歌词，所以这个的调用频率越快越准确越好
+  */
+  currentTime?: number;
+  isSeeking?: boolean;
+  /**
+  * 设置文字动画的渐变宽度，单位以歌词行的主文字字体大小的倍数为单位，默认为 0.5，即一个全角字符的一半宽度
+  *
+  * 如果要模拟 Apple Music for Android 的效果，可以设置为 1
+  *
+  * 如果要模拟 Apple Music for iPad 的效果，可以设置为 0.5
+  *
+  * 如果想要近乎禁用渐变效果，可以设置成非常接近 0 的小数（例如 `0.0001` ），但是**不可以为 0**
+  */
+  wordFadeWidth?: number;
+  /**
+  * 设置所有歌词行在横坐标上的弹簧属性，包括重量、弹力和阻力。
+  *
+  * @param params 需要设置的弹簧属性，提供的属性将会覆盖原来的属性，未提供的属性将会保持原样
+  */
+  linePosXSpringParams?: Partial<spring.SpringParams>;
+  /**
+  * 设置所有歌词行在​纵坐标上的弹簧属性，包括重量、弹力和阻力。
+  *
+  * @param params 需要设置的弹簧属性，提供的属性将会覆盖原来的属性，未提供的属性将会保持原样
+  */
+  linePosYSpringParams?: Partial<spring.SpringParams>;
+  /**
+  * 设置所有歌词行在​缩放大小上的弹簧属性，包括重量、弹力和阻力。
+  *
+  * @param params 需要设置的弹簧属性，提供的属性将会覆盖原来的属性，未提供的属性将会保持原样
+  */
+  lineScaleSpringParams?: Partial<spring.SpringParams>;
+  /**
+  * 在一个特殊的底栏元素内加入指定元素，默认是空白的，可以往内部添加任意元素
+  *
+  * 这个元素始终在歌词的底部，可以用于显示歌曲创作者等信息
+  */
+  bottomLine?: Parameters<typeof createPortal>[0];
+  /**
+  * 需要用于创建歌词播放组件的类实例
+  */
+  lyricPlayer?: {
+    new (...args: ConstructorParameters<typeof LyricPlayerBase>): LyricPlayerBase;
+  };
+  /**
+  * 当某个歌词行被左键点击时触发的事件
+  * @param line 歌词行的事件对象，可以访问到对应的歌词行信息和歌词行索引
+  */
+  onLyricLineClick?: (line: LyricLineMouseEvent) => void;
+  /**
+  * 当某个歌词行被右键点击时触发的事件
+  * @param line 歌词行的事件对象，可以访问到对应的歌词行信息和歌词行索引
+  */
+  onLyricLineContextMenu?: (line: LyricLineMouseEvent) => void;
+}
+/**
+* 歌词播放组件的引用
+*/
+interface LyricPlayerRef {
+  /**
+  * 歌词播放实例
+  */
+  lyricPlayer?: LyricPlayerBase;
+  /**
+  * 将歌词播放实例的元素包裹起来的 DIV 元素实例
+  */
+  wrapperEl: HTMLDivElement | null;
+}
+/**
+* 歌词播放组件，本框架的核心组件
+*
+* 尽可能贴切 Apple Music for iPad 的歌词效果设计，且做了力所能及的优化措施
+*/
+declare const LyricPlayer: ForwardRefExoticComponent<Omit<HTMLProps<HTMLDivElement> & LyricPlayerProps, "ref"> & RefAttributes<LyricPlayerRef>>;
+//#endregion
+export { BackgroundRender, BackgroundRenderProps, BackgroundRenderRef, BaseRenderer, LyricPlayer, LyricPlayerProps, LyricPlayerRef, MeshGradientRenderer, PixiRenderer };
+//# sourceMappingURL=amll-react.d.cts.map