BackgroundRenderProps

背景渲染组件的属性

Properties

album?

optional album: string | HTMLImageElement | HTMLVideoElement

设置背景专辑资源

Defined in

packages/react/src/bg-render.tsx:27

---

albumIsVideo?

optional albumIsVideo: boolean

设置专辑资源是否为视频

Defined in

packages/react/src/bg-render.tsx:31

---

flowSpeed?

optional flowSpeed: number

设置当前动画流动速度，如果为 undefined 则默认为 2

Defined in

packages/react/src/bg-render.tsx:43

---

fps?

optional fps: number

设置当前背景动画帧率，如果为 undefined 则默认为 30

Defined in

packages/react/src/bg-render.tsx:35

---

hasLyric?

optional hasLyric: boolean

设置背景是否根据“是否有歌词”这个特征调整自身效果，例如有歌词时会变得更加活跃

部分渲染器会根据这个特征调整自身效果

如果不确定是否需要赋值或无法知晓是否包含歌词，请传入 true 或不做任何处理（默认值为 true）

Defined in

packages/react/src/bg-render.tsx:51

---

lowFreqVolume?

optional lowFreqVolume: number

设置低频的音量大小，范围在 80hz-120hz 之间为宜，取值范围在 [0.0-1.0] 之间

部分渲染器会根据音量大小调整背景效果（例如根据鼓点跳动）

如果无法获取到类似的数据，请传入 undefined 或 1.0 作为默认值，或不做任何处理（默认值即 1.0）

Defined in

packages/react/src/bg-render.tsx:59

---

playing?

optional playing: boolean

设置当前播放状态，如果为 undefined 则默认为 true

Defined in

packages/react/src/bg-render.tsx:39

---

renderer()?

optional renderer: (…args) => BaseRenderer

设置渲染器，如果为 undefined 则默认为 PixiRenderer 默认渲染器有可能会随着版本更新而更换

Parameters

• …args: [HTMLCanvasElement]

Returns

BaseRenderer

Defined in

packages/react/src/bg-render.tsx:73

---

renderScale?

optional renderScale: number

设置当前渲染缩放比例，如果为 undefined 则默认为 0.5

Defined in

packages/react/src/bg-render.tsx:63

---

staticMode?

optional staticMode: boolean

是否启用静态模式，即图片在更换后就会保持静止状态并禁用更新，以节省性能 默认为 false

Defined in

packages/react/src/bg-render.tsx:68