跳转到内容

BackgroundRenderProps

Defined in: react/src/bg-render.tsx:26

背景渲染组件的属性

Property Type Description Defined in
album? string | HTMLImageElement | HTMLVideoElement 设置背景专辑资源 react/src/bg-render.tsx:30
albumIsVideo? boolean 设置专辑资源是否为视频 react/src/bg-render.tsx:34
configureRenderer? (renderer) => void 配置当前渲染器实例。 渲染器创建或回调变化后调用,可用于下发特定渲染器才支持的选项。 react/src/bg-render.tsx:84
flowSpeed? number 设置当前动画流动速度,如果为 undefined 则默认为 2 react/src/bg-render.tsx:46
fps? number 设置当前背景动画帧率,如果为 undefined 则默认为 30 react/src/bg-render.tsx:38
hasLyric? boolean 设置背景是否根据“是否有歌词”这个特征调整自身效果,例如有歌词时会变得更加活跃 部分渲染器会根据这个特征调整自身效果 如果不确定是否需要赋值或无法知晓是否包含歌词,请传入 true 或不做任何处理(默认值为 true) react/src/bg-render.tsx:54
lowFreqVolume? number 设置低频的音量大小,范围在 80hz-120hz 之间为宜,取值范围在 [0.0-1.0] 之间 部分渲染器会根据音量大小调整背景效果(例如根据鼓点跳动) 如果无法获取到类似的数据,请传入 undefined 或 1.0 作为默认值,或不做任何处理(默认值即 1.0) react/src/bg-render.tsx:62
playing? boolean 设置当前播放状态,如果为 undefined 则默认为 true react/src/bg-render.tsx:42
renderer? (…args) => BaseRenderer 设置渲染器,如果为 undefined 则默认为 MeshGradientRenderer 默认渲染器有可能会随着版本更新而更换 react/src/bg-render.tsx:76
renderScale? number 设置当前渲染缩放比例,如果为 undefined 则默认为 0.5 react/src/bg-render.tsx:66
staticMode? boolean 是否启用静态模式,即图片在更换后就会保持静止状态并禁用更新,以节省性能 默认为 false react/src/bg-render.tsx:71