跳转到内容

BackgroundRenderProps

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

背景渲染组件的属性

Properties

PropertyTypeDescriptionDefined in
album?string | HTMLImageElement | HTMLVideoElement设置背景专辑资源react/src/bg-render.tsx:27
albumIsVideo?boolean设置专辑资源是否为视频react/src/bg-render.tsx:31
flowSpeed?number设置当前动画流动速度,如果为 undefined 则默认为 2react/src/bg-render.tsx:43
fps?number设置当前背景动画帧率,如果为 undefined 则默认为 30react/src/bg-render.tsx:35
hasLyric?boolean设置背景是否根据“是否有歌词”这个特征调整自身效果,例如有歌词时会变得更加活跃 部分渲染器会根据这个特征调整自身效果 如果不确定是否需要赋值或无法知晓是否包含歌词,请传入 true 或不做任何处理(默认值为 true)react/src/bg-render.tsx:51
lowFreqVolume?number设置低频的音量大小,范围在 80hz-120hz 之间为宜,取值范围在 [0.0-1.0] 之间 部分渲染器会根据音量大小调整背景效果(例如根据鼓点跳动) 如果无法获取到类似的数据,请传入 undefined 或 1.0 作为默认值,或不做任何处理(默认值即 1.0)react/src/bg-render.tsx:59
playing?boolean设置当前播放状态,如果为 undefined 则默认为 truereact/src/bg-render.tsx:39
renderer?(…args: [HTMLCanvasElement]) => BaseRenderer设置渲染器,如果为 undefined 则默认为 PixiRenderer 默认渲染器有可能会随着版本更新而更换react/src/bg-render.tsx:73
renderScale?number设置当前渲染缩放比例,如果为 undefined 则默认为 0.5react/src/bg-render.tsx:63
staticMode?boolean是否启用静态模式,即图片在更换后就会保持静止状态并禁用更新,以节省性能 默认为 falsereact/src/bg-render.tsx:68