Class Audio

音频组件

Export

Date

2022.6.14

Author

yj

Hierarchy

Constructors

constructor

Properties

_engine _entity userData

Accessors

enabled engine entity isPlaying loop volume

Methods

_onAwake _onDestroy _onDisable _onEnable addEventListener destroy dispatchEvent dispose pause play removeAllEventListeners removeEventListener removeEventListenerByEventId setActive stop updateProperties

Constructors

constructor

Properties

Protected _engine

_engine: Engine

Protected _entity

_entity: Entity

userData

userData: {
    [key: string]: any;
} = {}

用户数据

Type declaration

  • [key: string]: any

Memberof

Component

Accessors

enabled

  • get enabled(): boolean

  • 获取组件是否启用

    Returns boolean

    Memberof

    Component

  • set enabled(value): void

  • 启用或禁用组件

    Parameters

    • value: boolean

    Returns void

    Memberof

    Component

engine

  • get engine(): Engine

  • 获取引擎对象

    Returns Engine

    Memberof

    EngineObject

entity

  • get entity(): Entity

  • 获取组件所属实体

    Returns Entity

    Memberof

    Component

isPlaying

  • get isPlaying(): boolean

  • 获取是否正在播放音频

    Returns boolean

    Memberof

    Audio

loop

  • get loop(): boolean

  • 获取是否循环播放音频

    Returns boolean

    Memberof

    Audio

  • set loop(value): void

  • 设置是否循环播放音频

    Parameters

    • value: boolean

      是否循环

    Returns void

    Memberof

    Audio

volume

  • get volume(): number

  • 获取音频音量

    Returns number

    Memberof

    Audio

  • set volume(value): void

  • 设置音频音量

    Parameters

    • value: number

      音量0-1

    Returns void

    Memberof

    Audio

Methods

Protected _onAwake

  • _onAwake(): void
  • Protected

    唤醒组件

    Returns void

    Memberof

    Component

Protected _onDestroy

  • _onDestroy(): void
  • Protected

    销毁组件

    Returns void

    Memberof

    Audio

Protected _onDisable

  • _onDisable(): void
  • Protected

    禁用组件

    Returns void

    Memberof

    Component

Protected _onEnable

  • _onEnable(): void
  • Protected

    启用组件

    Returns void

    Memberof

    Component

addEventListener

  • 添加事件监听器

    Parameters

    • type: string

      事件类型（不区分大小写）

    • callback: ((event) => void)

      事件监听回调

        • (event): void

        • Parameters

          • event: {
                type: string;
                [key: string]: any;
            }
            • [key: string]: any
            • type: string

          Returns void

    • Optional parameters: {
          priority?: Priority;
          target?: any;
      } = {}

      事件参数

      • Optional priority?: Priority
      • Optional target?: any

    Returns number

    Memberof

    EventDispatcher

destroy

  • 销毁组件

    Returns void

    Memberof

    Component

dispatchEvent

  • 分发事件

    Parameters

    • event: {
          type: string;
          [key: string]: any;
      }
      • [key: string]: any
      • type: string

    Returns void

    Memberof

    EventDispatcher

dispose

  • 释放接口

    Returns void

    Memberof

    EventDispatcher

pause

  • 暂停音频

    Returns void

    Memberof

    Audio

play

  • 播放音频

    Parameters

    • delay: number = 0

      延迟时间

    Returns void

    Memberof

    Audio

removeAllEventListeners

removeEventListener

  • 移除事件监听器

    Parameters

    • type: string

      事件类型（不区分大小写）

    • Optional callback: ((event) => void)

      事件监听回调（可选，不设置则表示移除所有监听器）

        • (event): void

        • Parameters

          • event: {
                type: string;
                [key: string]: any;
            }
            • [key: string]: any
            • type: string

          Returns void

    Returns void

    Memberof

    EventDispatcher

removeEventListenerByEventId

  • 通过事件Id移除事件监听器

    Parameters

    • eventID: number

    Returns void

    Memberof

    EventDispatcher

setActive

  • 激活或冻结组件

    Parameters

    • value: boolean

    Returns void

    Memberof

    Component

stop

  • 停止音频

    Returns void

    Memberof

    Audio

updateProperties

  • 批量更新组件属性

    Parameters

    • parameters: {
          [key: string]: any;
      }
      • [key: string]: any

    Returns Promise<void>

    Memberof

    Component

Settings

Member Visibility

Theme

On This Page