BackgroundRender
Defined in: packages/vue/src/BackgroundRender.tsx:117
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
album? | readonly | string | HTMLImageElement | HTMLVideoElement | 设置背景专辑资源 | packages/vue/src/BackgroundRender.tsx:38 |
albumIsVideo | readonly | boolean | 设置专辑资源是否为视频 | packages/vue/src/BackgroundRender.tsx:47 |
flowSpeed? | readonly | number | 设置当前动画流动速度，如果为 undefined 则默认为 2 | packages/vue/src/BackgroundRender.tsx:68 |
fps? | readonly | number | 设置当前背景动画帧率，如果为 undefined 则默认为 30 | packages/vue/src/BackgroundRender.tsx:54 |
hasLyric | readonly | boolean | 设置背景是否根据“是否有歌词”这个特征调整自身效果，例如有歌词时会变得更加活跃 部分渲染器会根据这个特征调整自身效果 如果不确定是否需要赋值或无法知晓是否包含歌词，请传入 true 或不做任何处理（默认值为 true） | packages/vue/src/BackgroundRender.tsx:79 |
lowFreqVolume? | readonly | number | 设置低频的音量大小，范围在 80hz-120hz 之间为宜，取值范围在 [0.0-1.0] 之间 部分渲染器会根据音量大小调整背景效果（例如根据鼓点跳动） 如果无法获取到类似的数据，请传入 undefined 或 1.0 作为默认值，或不做任何处理（默认值即 1.0） | packages/vue/src/BackgroundRender.tsx:90 |
playing | readonly | boolean | 设置当前播放状态，如果为 undefined 则默认为 true | packages/vue/src/BackgroundRender.tsx:61 |
renderer? | readonly | (…args: [HTMLCanvasElement]) => BaseRenderer | 设置渲染器，如果为 undefined 则默认为 MeshGradientRenderer 默认渲染器有可能会随着版本更新而更换 | packages/vue/src/BackgroundRender.tsx:105 |
renderScale? | readonly | number | 设置当前渲染缩放比例，如果为 undefined 则默认为 0.5 | packages/vue/src/BackgroundRender.tsx:97 |