LyricPlayer
Defined in: packages/vue/src/LyricPlayer.tsx:195
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
alignAnchor | readonly | "top" | "bottom" | "center" | 设置歌词行的对齐方式，如果为 undefined 则默认为 center - 设置成 top 的话将会向目标歌词行的顶部对齐 - 设置成 bottom 的话将会向目标歌词行的底部对齐 - 设置成 center 的话将会向目标歌词行的垂直中心对齐 | packages/vue/src/LyricPlayer.tsx:49 |
alignPosition | readonly | number | 设置默认的歌词行对齐位置，相对于整个歌词播放组件的大小位置，如果为 undefined 则默认为 0.5 可以设置一个 [0.0-1.0] 之间的任意数字，代表组件高度由上到下的比例位置 | packages/vue/src/LyricPlayer.tsx:59 |
currentTime | readonly | number | 设置当前播放进度，单位为毫秒且必须是整数，此时将会更新内部的歌词进度信息 内部会根据调用间隔和播放进度自动决定如何滚动和显示歌词，所以这个的调用频率越快越准确越好 | packages/vue/src/LyricPlayer.tsx:110 |
disabled | readonly | boolean | 是否禁用歌词播放组件，默认为 false，歌词组件启用后将会开始逐帧更新歌词的动画效果，并对传入的其他参数变更做出反馈。 如果禁用了歌词组件动画，你也可以通过引用取得原始渲染组件实例，手动逐帧调用其 update 函数来更新动画效果。 | packages/vue/src/LyricPlayer.tsx:31 |
enableBlur | readonly | boolean | 设置是否启用歌词行的模糊效果，默认为 true | packages/vue/src/LyricPlayer.tsx:77 |
enableScale | readonly | boolean | 设置是否使用物理弹簧算法实现歌词动画效果，默认启用 如果启用，则会通过弹簧算法实时处理歌词位置，但是需要性能足够强劲的电脑方可流畅运行 如果不启用，则会回退到基于 transition 的过渡效果，对低性能的机器比较友好，但是效果会比较单一 | packages/vue/src/LyricPlayer.tsx:88 |
enableSpring | readonly | boolean | 设置是否使用物理弹簧算法实现歌词动画效果，默认启用 如果启用，则会通过弹簧算法实时处理歌词位置，但是需要性能足够强劲的电脑方可流畅运行 如果不启用，则会回退到基于 transition 的过渡效果，对低性能的机器比较友好，但是效果会比较单一 | packages/vue/src/LyricPlayer.tsx:70 |
hidePassedLines | readonly | boolean | 设置是否隐藏已经播放过的歌词行，默认不隐藏 | packages/vue/src/LyricPlayer.tsx:95 |
linePosXSpringParams? | readonly | Partial<SpringParams> | 设置所有歌词行在横坐标上的弹簧属性，包括重量、弹力和阻力。 Param 需要设置的弹簧属性，提供的属性将会覆盖原来的属性，未提供的属性将会保持原样 | packages/vue/src/LyricPlayer.tsx:132 |
linePosYSpringParams? | readonly | Partial<SpringParams> | 设置所有歌词行在纵坐标上的弹簧属性，包括重量、弹力和阻力。 Param 需要设置的弹簧属性，提供的属性将会覆盖原来的属性，未提供的属性将会保持原样 | packages/vue/src/LyricPlayer.tsx:141 |
lineScaleSpringParams? | readonly | Partial<SpringParams> | 设置所有歌词行在缩放大小上的弹簧属性，包括重量、弹力和阻力。 Param 需要设置的弹簧属性，提供的属性将会覆盖原来的属性，未提供的属性将会保持原样 | packages/vue/src/LyricPlayer.tsx:150 |
lyricLines? | readonly | LyricLine[] | 设置当前播放歌词，要注意传入后这个数组内的信息不得修改，否则会发生错误 | packages/vue/src/LyricPlayer.tsx:102 |
lyricPlayer? | readonly | (…args: [HTMLCanvasElement]) => BaseRenderer | 设置渲染器，如果为 undefined 则默认为 MeshGradientRenderer 默认渲染器有可能会随着版本更新而更换 | packages/vue/src/LyricPlayer.tsx:158 |
onLineClick? | public | (…args: [LyricLineMouseEvent]) => any | - | |
onLineContextmenu? | public | (…args: [LyricLineMouseEvent]) => any | - | |
playing | readonly | boolean | 是否演出部分效果，目前会控制播放间奏点的动画的播放暂停与否，默认为 true | packages/vue/src/LyricPlayer.tsx:38 |
wordFadeWidth | readonly | number | 设置文字动画的渐变宽度，单位以歌词行的主文字字体大小的倍数为单位，默认为 0.5，即一个全角字符的一半宽度 如果要模拟 Apple Music for Android 的效果，可以设置为 1 如果要模拟 Apple Music for iPad 的效果，可以设置为 0.5 如果想要近乎禁用渐变效果，可以设置成非常接近 0 的小数（例如 0.0001 ），但是不可以为 0 | packages/vue/src/LyricPlayer.tsx:123 |