LyricLineBase

This content is not available in your language yet.

Defined in: packages/core/src/lyric-player/base/line.ts:15

Internal

所有标准歌词行的基类

Extends

EventTarget

Implements

Disposable

Properties

Property	Modifier	Type	Default value	Defined in
`blur`	`protected`	`number`	`0`	packages/core/src/lyric-player/base/line.ts:18
`delay`	`protected`	`number`	`0`	packages/core/src/lyric-player/base/line.ts:20
`lineTransforms`	`readonly`	`LineTransforms`	`undefined`	packages/core/src/lyric-player/base/line.ts:21
`opacity`	`protected`	`number`	`1`	packages/core/src/lyric-player/base/line.ts:19
`scale`	`protected`	`number`	`1`	packages/core/src/lyric-player/base/line.ts:17
`top`	`protected`	`number`	`0`	packages/core/src/lyric-player/base/line.ts:16

Methods

addEventListener()

addEventListener(
   type,
   callback,
   options?): void;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:11569

The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

MDN Reference

Parameters

Parameter	Type
`type`	`string`
`callback`	`EventListenerOrEventListenerObject` \| `null`
`options?`	`boolean` \| `AddEventListenerOptions`

Returns

void

Inherited from

EventTarget.addEventListener

disable()

abstract disable(): void;

Defined in: packages/core/src/lyric-player/base/line.ts:45

Returns

void

dispatchEvent()

dispatchEvent(event): boolean;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:11575

The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

MDN Reference

Parameters

Parameter	Type
`event`	`Event`

Returns

boolean

Inherited from

EventTarget.dispatchEvent

dispose()

dispose(): void;

Defined in: packages/core/src/lyric-player/base/line.ts:87

销毁实现了该接口的对象实例，释放占用的资源

一般情况下，调用本函数后就不可以再调用对象的任何函数了

Returns

void

Implementation of

Disposable.dispose

enable()

abstract enable(time?, shouldPlay?): void;

Defined in: packages/core/src/lyric-player/base/line.ts:44

Parameters

Parameter	Type
`time?`	`number`
`shouldPlay?`	`boolean`

Returns

void

getLine()

abstract getLine(): LyricLine;

Defined in: packages/core/src/lyric-player/base/line.ts:43

Returns

LyricLine

onLineSizeChange()

onLineSizeChange(_size): void;

Defined in: packages/core/src/lyric-player/base/line.ts:48

Parameters

Parameter	Type
`_size`	[`number`, `number`]

Returns

void

pause()

abstract pause(): void;

Defined in: packages/core/src/lyric-player/base/line.ts:47

Returns

void

rebuildElement()

rebuildElement(): void;

Defined in: packages/core/src/lyric-player/base/line.ts:65

Returns

void

removeEventListener()

removeEventListener(
   type,
   callback,
   options?): void;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:11581

The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

MDN Reference

Parameters

Parameter	Type
`type`	`string`
`callback`	`EventListenerOrEventListenerObject` \| `null`
`options?`	`boolean` \| `EventListenerOptions`

Returns

void

Inherited from

EventTarget.removeEventListener

resume()

abstract resume(): void;

Defined in: packages/core/src/lyric-player/base/line.ts:46

Returns

void

setTransform()

setTransform(
   top?,
   scale?,
   opacity?,
   blur?,
   _force?,
   delay?,
   _mode?): void;

Defined in: packages/core/src/lyric-player/base/line.ts:49

Parameters

Parameter	Type	Default value
`top`	`number`	`...`
`scale`	`number`	`...`
`opacity`	`number`	`...`
`blur`	`number`	`...`
`_force`	`boolean`	`false`
`delay`	`number`	`0`
`_mode`	`LyricLineRenderMode`	`LyricLineRenderMode.SOLID`

Returns

void

update()

abstract update(delta?): void;

Defined in: packages/core/src/lyric-player/base/line.ts:86

Parameters

Parameter	Type
`delta?`	`number`

Returns

void