Class AudioSource3D

声源

See

https://developer.mozilla.org/en-US/docs/Web/API/AudioContext

Hierarchy

Constructors

constructor

Properties

_coneInnerAngle _coneOuterAngle _coneOuterGain _connect _disconnect _distanceModel _enablePosition _enabledChanged _entity _getAudioNodes _loop _maxDistance _onScenetransformChanged _onUrlChanged _panningModel _refDistance _rolloffFactor _volume buffer emitter enabled gain hideFlags panner runEnvironment source url

Accessors

coneInnerAngle coneOuterAngle coneOuterGain distanceModel enablePosition entity isVisibleAndEnabled loop maxDistance node panningModel refDistance rolloffFactor volume

Methods

addComponent beforeRender destroy getComponent getComponentInChildren getComponentInParent getComponents getComponentsInChildren getComponentsInParent getShareTargets init play setEntity stop __create__ getDependencies isSingleComponent

Constructors

constructor

Properties

Private _coneInnerAngle

_coneInnerAngle: any

Private _coneOuterAngle

_coneOuterAngle: any

Private _coneOuterGain

_coneOuterGain: any

Private _connect

_connect: any

Private _disconnect

_disconnect: any

Private _distanceModel

_distanceModel: any

Private _enablePosition

_enablePosition: any

Private _enabledChanged

_enabledChanged: any

Protected _entity

_entity: Node3D

Private _getAudioNodes

_getAudioNodes: any

Private _loop

_loop: any

Private _maxDistance

_maxDistance: any

Private _onScenetransformChanged

_onScenetransformChanged: any

Private _onUrlChanged

_onUrlChanged: any

Private _panningModel

_panningModel: any

Private _refDistance

_refDistance: any

Private _rolloffFactor

_rolloffFactor: any

Private _volume

_volume: any

Private buffer

buffer: any

Readonly emitter

emitter: EventEmitter<Node3DEventMap>

enabled

enabled: boolean

是否启用update方法

Private gain

gain: any

hideFlags

hideFlags: HideFlags

隐藏标记，用于控制是否在层级界面、检查器显示，是否保存

Private panner

panner: any

runEnvironment

runEnvironment: RunEnvironment

可运行环境

Private source

source: any

url

url: string

声音文件路径

Accessors

coneInnerAngle

  • get coneInnerAngle(): number

  • Returns number

  • set coneInnerAngle(v): void

  • Parameters

    • v: number

    Returns void

coneOuterAngle

  • get coneOuterAngle(): number

  • Returns number

  • set coneOuterAngle(v): void

  • Parameters

    • v: number

    Returns void

coneOuterGain

  • get coneOuterGain(): number

  • Returns number

  • set coneOuterGain(v): void

  • Parameters

    • v: number

    Returns void

distanceModel

  • get distanceModel(): DistanceModelType

  • 该接口的distanceModel属性PannerNode是一个枚举值，用于确定在音频源离开收听者时用于减少音频源音量的算法。

    可能的值是：

    • linear：根据以下公式计算由距离引起的增益的线性距离模型： 1 - rolloffFactor * (distance - refDistance) / (maxDistance - refDistance)
    • inverse：根据以下公式计算由距离引起的增益的反距离模型： refDistance / (refDistance + rolloffFactor * (distance - refDistance))
    • exponential：按照下式计算由距离引起的增益的指数距离模型 pow(distance / refDistance, -rolloffFactor)。

    inverse是的默认值distanceModel。

    Returns DistanceModelType

  • set distanceModel(v): void

  • Parameters

    Returns void

enablePosition

  • get enablePosition(): boolean

  • 是否启用位置影响声音

    Returns boolean

  • set enablePosition(v): void

  • Parameters

    • v: boolean

    Returns void

entity

  • get entity(): Node3D

  • 此组件附加到的游戏对象。组件总是附加到游戏对象上。

    Returns Node3D

isVisibleAndEnabled

  • get isVisibleAndEnabled(): boolean

  • Has the Behaviour had enabled called. 是否所在Object3D显示且该行为已启动。

    Returns boolean

loop

  • get loop(): boolean

  • 是否循环播放

    Returns boolean

  • set loop(v): void

  • Parameters

    • v: boolean

    Returns void

maxDistance

  • get maxDistance(): number

  • 表示音频源和收听者之间的最大距离，之后音量不会再降低。该值仅由linear距离模型使用。默认值是10000。

    Returns number

  • set maxDistance(v): void

  • Parameters

    • v: number

    Returns void

node

  • get node(): Node

  • 2D节点。

    Returns Node

panningModel

  • get panningModel(): PanningModelType

  • Returns PanningModelType

  • set panningModel(v): void

  • Parameters

    • v: PanningModelType

    Returns void

refDistance

  • get refDistance(): number

  • 表示随着音频源远离收听者而减小音量的参考距离。此值由所有距离模型使用。默认值是1。

    Returns number

  • set refDistance(v): void

  • Parameters

    • v: number

    Returns void

rolloffFactor

  • get rolloffFactor(): number

  • 描述了音源离开收听者音量降低的速度。此值由所有距离模型使用。默认值是1。

    Returns number

  • set rolloffFactor(v): void

  • Parameters

    • v: number

    Returns void

volume

  • get volume(): number

  • 音量

    Returns number

  • set volume(v): void

  • Parameters

    • v: number

    Returns void

Methods

addComponent

  • Adds a component class of type componentType to the game object.

    Type Parameters

    • K extends keyof ComponentMap

    Parameters

    • type: K

      组件类定义。

    • Optional params: gPartial<ComponentMap[K]>

    Returns ComponentMap[K]

    被添加的组件。

beforeRender

  • Parameters

    Returns void

destroy

  • 销毁

    Returns void

getComponent

  • 返回游戏对象附加的一个指定类型的组件，如果没有，则返回 null。

    使用 Entity.GetComponent 将返回找到的第一个组件。如果您希望有多个相同类型的组件，请改用 Entity.GetComponents，并循环通过返回的组件测试某些唯一属性。

    Type Parameters

    • K extends keyof ComponentMap

    Parameters

    • component: K

      要检索的组件类型。

    Returns ComponentMap[K]

    要检索的组件。

getComponentInChildren

  • 使用深度优先搜索返回 Entity 或其任何子项中的 Type 组件。

    Type Parameters

    • K extends keyof ComponentMap

    Parameters

    • component: K

      要检索的组件类型。

    • Optional includeInactive: boolean

      是否包含不活跃组件。

    Returns ComponentMap[K]

    匹配类型的组件（如果找到）。

getComponentInParent

  • 检索 Entity 或其任何父项type中的 Type 组件。

    此方法向上递归，直到找到具有匹配组件的 Entity。仅匹配活动游戏对象上的组件。

    Type Parameters

    • K extends keyof ComponentMap

    Parameters

    • component: K

      要查找的组件类型。

    • Optional includeInactive: boolean

      是否包含不活跃组件。

    Returns ComponentMap[K]

    如果找到与类型匹配的组件，则返回一个组件。否则返回 null。

getComponents

  • 返回Entity中指定类型的所有组件。

    Type Parameters

    • K extends keyof ComponentMap

    Parameters

    • type: K

      要检索的组件类型。

    • Optional results: ComponentMap[K][]

      列出接收找到的组件。

    Returns ComponentMap[K][]

    实体中指定类型的所有组件。

getComponentsInChildren

  • 使用深度优先搜索返回 当前实体 或其任何子子项中 Type 的所有组件。递归工作。

    在子游戏对象上递归搜索组件。这意味着它还包括目标实体的所有子实体，以及所有后续子实体。

    Type Parameters

    • K extends keyof ComponentMap

    Parameters

    • component: K

      要检索的组件类型。

    • Optional includeInactive: boolean

      非活动游戏对象上的组件是否应该包含在搜索结果中？

    • Optional results: ComponentMap[K][]

      列出接收找到的组件。

    Returns ComponentMap[K][]

    所有找到的组件。

getComponentsInParent

  • 返回当前实体或其任何父级中指定的所有组件。

    Type Parameters

    • K extends keyof ComponentMap

    Parameters

    • component: K

      要检索的组件类型。

    • Optional includeInactive: boolean

      非活动组件是否应该包含在搜索结果中？

    • Optional results: ComponentMap[K][]

      列出找到的组件。

    Returns ComponentMap[K][]

    实体或其任何父级中指定的所有组件。

getShareTargets

  • 把事件分享到实体上。

    Returns Entity[]

init

  • 初始化组件

    在添加到Entity时立即被调用。

    Returns void

play

  • Returns void

Private setEntity

  • Private

    该方法仅在Entity中使用

    Parameters

    • entity: Entity

      游戏对象

    Returns void

stop

  • Returns void

Static Private __create__

  • __create__<T>(this): T
  • Private

    组件无法直接使用关键字 new 来构造。

    Type Parameters

    • T

    Parameters

    Returns T

    新建的组件实例。

    See

    getInstance

Static getDependencies

  • 获取组件依赖列表

    Type Parameters

    • K extends keyof ComponentMap

    Parameters

    • component: K

      组件类定义

    Returns "Component"[]

Static isSingleComponent

  • 判断组件是否为唯一组件。

    Type Parameters

    • K extends keyof ComponentMap

    Parameters

    • component: K | ComponentMap[K] | Constructor<ComponentMap[K]>

      组件类定义

    Returns boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc