类 SoundPlayer

En

Component used for playing background music or sound effects

Zh

用于播放背景音乐或者音效的组件

层级 (查看完整内容)

Component
- SoundPlayer

索引

构造函数

constructor

new SoundPlayer(): SoundPlayer
返回 SoundPlayer
重写了 Component.constructor
- 定义于 src/layaAir/laya/media/SoundPlayer.ts:17

属性

_extra

_extra: IComponentExtra

En

Extra data of the node.

Zh

组件的额外数据。IDE内部使用。

Blueprint Ignore

_id

_id: number

En

Unique identifier for the component.

Zh

组件的唯一标识。

_singleton

_singleton: boolean

En

Whether the component is a singleton, meaning only one instance of this type of script can be added to the same node.

Zh

是否为单例，即同一个节点只能添加此类型的脚本一次。

`只读`owner

owner: Node

En

Gets the owner Node to which the component belongs.

Zh

获取组件所属的 Node 节点。

runInEditor

runInEditor: boolean

En

Whether the script can run in the IDE environment.

Zh

是否可以在 IDE 环境中运行。

Blueprint Ignore

scriptPath

scriptPath: string

En

The path of the script file.

Zh

脚本文件的路径。

Blueprint Ignore

访问器

autoPlay

get autoPlay(): boolean
返回 boolean
En
Determines if the audio should auto-play

Zh
是否自动播放
- 定义于 src/layaAir/laya/media/SoundPlayer.ts:69
set autoPlay(value): void
参数
- value: boolean
返回 void
- 定义于 src/layaAir/laya/media/SoundPlayer.ts:73

awaked

get awaked(): boolean
返回 boolean
En
whether the component has been awakened.

Zh
组件是否已经被唤醒。
继承自 Component.awaked
- 定义于 src/layaAir/laya/components/Component.ts:136

destroyed

get destroyed(): boolean
返回 boolean
En
whether the component has been destroyed.

Zh
组件是否已经被销毁。
继承自 Component.destroyed
- 定义于 src/layaAir/laya/components/Component.ts:144

enabled

get enabled(): boolean
返回 boolean
En
whether the component is enabled.

Zh
是否启用组件。
继承自 Component.enabled
- 定义于 src/layaAir/laya/components/Component.ts:120
set enabled(value): void
参数
- value: boolean
返回 void
继承自 Component.enabled
- 定义于 src/layaAir/laya/components/Component.ts:124

hideFlags

get hideFlags(): number
返回 number
En
The hide flags that determine the hiding behavior of the component.

Zh
确定组件隐藏行为的标志。
继承自 Component.hideFlags
- 定义于 src/layaAir/laya/components/Component.ts:70
set hideFlags(value): void
参数
- value: number
返回 void
继承自 Component.hideFlags
- 定义于 src/layaAir/laya/components/Component.ts:74

id

get id(): number
返回 number
En
The unique identifier for the component.

Zh
组件的唯一标识。
继承自 Component.id
- 定义于 src/layaAir/laya/components/Component.ts:112

isMusic

get isMusic(): boolean
返回 boolean
En
Determines if the audio type is background music. If true, it's background music; otherwise, it's a sound effect.

Zh
确定音频类型是否为背景音乐。如果为true，音乐类型为背景音乐，否则为音效
- 定义于 src/layaAir/laya/media/SoundPlayer.ts:45
set isMusic(value): void
参数
- value: boolean
返回 void
- 定义于 src/layaAir/laya/media/SoundPlayer.ts:49

loop

get loop(): number
返回 number
En
The number of times the audio should loop

Zh
循环次数
- 定义于 src/layaAir/laya/media/SoundPlayer.ts:57
set loop(value): void
参数
- value: number
返回 void
- 定义于 src/layaAir/laya/media/SoundPlayer.ts:61

source

get source(): string
返回 string
En
Audio source

Zh
音频源
- 定义于 src/layaAir/laya/media/SoundPlayer.ts:27
set source(value): void
参数
- value: string
返回 void
- 定义于 src/layaAir/laya/media/SoundPlayer.ts:31

方法

destroy

destroy(): void
返回 void
En
Destroy components

Zh
销毁组件
继承自 Component.destroy
- 定义于 src/layaAir/laya/components/Component.ts:294

hasHideFlag

hasHideFlag(flag): boolean
参数
- flag: number
  The hide flag to check for.
返回 boolean
En
Checks if the component has a specific hide flag set.

Zh
检查组件是否设置了特定的隐藏标志。
继承自 Component.hasHideFlag
- 定义于 src/layaAir/laya/components/Component.ts:104

onAdded

onAdded(): void
返回 void
En
Called after the component is added to a node. Unlike Awake, onAdded is called even if the node is not active.

Zh
组件被添加到节点后调用，与 onAwake 不同的是，即使节点未激活也会调用 onAdded。

Blueprint Event
继承自 Component.onAdded
- 定义于 src/layaAir/laya/components/Component.ts:336

onAwake

onAwake(): void
返回 void
En
Executed after the component is activated. At this point, all nodes and components have been created. This method is executed only once.

Zh
组件被激活后执行，此时所有节点和组件均已创建完毕，此方法只执行一次。

Blueprint Event
继承自 Component.onAwake
- 定义于 src/layaAir/laya/components/Component.ts:352

onDestroy

onDestroy(): void
返回 void
En
Executed when the node is destroyed manually.

Zh
手动调用节点销毁时执行。

Blueprint Event
继承自 Component.onDestroy
- 定义于 src/layaAir/laya/components/Component.ts:411

onDisable

onDisable(): void
返回 void
En
Executed when the component is disabled, such as when the node is removed from the stage.

Zh
组件被禁用时执行，比如从节点从舞台移除后。

Blueprint Event
继承自 Component.onDisable
- 定义于 src/layaAir/laya/components/Component.ts:403

onEnable

onEnable(): void
返回 void
En
Executed after the component is enabled, such as when the node is added to the stage.

Zh
组件被启用后执行，比如节点被添加到舞台后。

Blueprint Event
继承自 Component.onEnable
- 定义于 src/layaAir/laya/components/Component.ts:360

`可选`onLateUpdate

onLateUpdate(): void
返回 void
En
Executed every frame during the late update phase, after the update phase.

Zh
每帧更新时执行，在 late update 阶段，update 阶段之后。

Blueprint Event
继承自 Component.onLateUpdate
- 定义于 src/layaAir/laya/components/Component.ts:382

`可选`onPostRender

onPostRender(): void
返回 void
En
Executed after rendering.

Zh
渲染之后执行。

Blueprint Event
继承自 Component.onPostRender
- 定义于 src/layaAir/laya/components/Component.ts:396

`可选`onPreRender

onPreRender(): void
返回 void
En
Executed before rendering.

Zh
渲染之前执行。

Blueprint Event
继承自 Component.onPreRender
- 定义于 src/layaAir/laya/components/Component.ts:389

`可选`onReset

onReset(): void
返回 void
En
Resets the component's parameters to their default values. If this function is implemented, the component will be reset and automatically recycled for future use. If not reset, it will not be recycled for reuse.

Zh
将组件的参数重置为默认值。如果实现了这个函数，组件将被重置并自动回收到对象池，方便下次复用。如果没有重置，则不会进行回收复用。
继承自 Component.onReset
- 定义于 src/layaAir/laya/components/Component.ts:345

`可选`onStart

onStart(): void
返回 void
En
Executed once, before the first update.

Zh
在第一次执行 update 之前执行，只会执行一次。

Blueprint Default Event
继承自 Component.onStart
- 定义于 src/layaAir/laya/components/Component.ts:368

`可选`onUpdate

onUpdate(): void
返回 void
En
Executed every frame during the update phase. Avoid writing complex loop logic or using the getComponent method here.

Zh
每帧更新时执行，在 update 阶段。尽量不要在这里写大循环逻辑或使用 getComponent 方法。

Blueprint Event
继承自 Component.onUpdate
- 定义于 src/layaAir/laya/components/Component.ts:375

play

play(loops?, complete?, startTime?): void
参数
- 可选loops: number
  The number of times to loop the audio
- 可选complete: ((success: boolean) => void)
  The callback function to be called when playback is complete
  - - (success): void
    - 参数
      success: boolean
      返回 void
- 可选startTime: number
  The time to start playing the audio from
返回 void
En
Play the audio

Zh
播放音频
- 定义于 src/layaAir/laya/media/SoundPlayer.ts:89

stop

stop(): void
返回 void
En
Stop playing the audio

Zh
停止播放音频
- 定义于 src/layaAir/laya/media/SoundPlayer.ts:108

类 SoundPlayer

En

Zh

层级 (查看完整内容)

索引

构造函数

属性

访问器

方法

构造函数

constructor

返回 SoundPlayer

属性

_extra

En

Zh

Blueprint Ignore

_id

En

Zh

_singleton

En

Zh

只读owner

En

Zh

runInEditor

En

Zh

Blueprint Ignore

scriptPath

En

Zh

Blueprint Ignore

访问器

autoPlay

返回 boolean

En

Zh

参数

返回 void

awaked

返回 boolean

En

Zh

destroyed

返回 boolean

En

Zh

enabled

返回 boolean

En

Zh

参数

返回 void

hideFlags

返回 number

En

Zh

参数

返回 void

id

返回 number

En

Zh

isMusic

返回 boolean

En

Zh

参数

返回 void

loop

返回 number

En

Zh

参数

返回 void

source

返回 string

En

`只读`owner

`可选`onLateUpdate

`可选`onPostRender

`可选`onPreRender

`可选`onReset

`可选`onStart

`可选`onUpdate