Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AudioPannerNode

3D空间音效节点类。用于AudioSource组件处理3D空间音效。

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

  • 构造函数

    memberof

    AudioPannerNode

    Parameters

    • Optional creator: any

      节点创造者，可为空。

    Returns AudioPannerNode

Accessors

bypass

  • get bypass(): boolean
  • set bypass(val: boolean): void

  • 是否绕过音效。
    true：绕过。即禁用音效。
    false: 不绕过。即启用音效。

    memberof

    AudioEffectNode

    Returns boolean

  • 是否绕过音效。
    true：绕过。即禁用音效。
    false: 不绕过。即启用音效。

    Parameters

    • val: boolean

    Returns void

coneInnerAngle

  • get coneInnerAngle(): number
  • set coneInnerAngle(val: number): void

  • 在3D空间里，声音在播放方向上的圆锥体角度，以度为单位。
    音频系统使用圆锥体来描述声音的传播方向。在此属性定义的圆锥体内，音量不会降低，即声音不受coneOuterGain属性影响（但是声音还是会受到距离和其他音效的影响）。
    值360：表示声音向任意方向传播，即在任意方向上均可听到该声音。

    memberof

    AudioPannerNode

    Returns number

  • 在3D空间里，声音在播放方向上的圆锥体角度，以度为单位。
    音频系统使用圆锥体来描述声音的传播方向。在此属性定义的圆锥体内，音量不会降低，即声音不受coneOuterGain属性影响（但是声音还是会受到距离和其他音效的影响）。
    值360：表示声音向任意方向传播，即在任意方向上均可听到该声音。

    Parameters

    • val: number

    Returns void

coneOuterAngle

  • get coneOuterAngle(): number
  • set coneOuterAngle(val: number): void

  • 在3D空间里，声音在播放方向上的圆锥体角度，以度为单位。
    在此属性定义的圆锥体外，音量将减少到恒定的coneOuterGain属性定义的值。
    值360：表示声音在任意方向上音量都不会受到coneOuterGain属性影响而减少（但是声音还是会受到距离和其他音效的影响）。

    memberof

    AudioPannerNode

    Returns number

  • 在3D空间里，声音在播放方向上的圆锥体角度，以度为单位。
    在此属性定义的圆锥体外，音量将减少到恒定的coneOuterGain属性定义的值。
    值360：表示声音在任意方向上音量都不会受到coneOuterGain属性影响而减少（但是声音还是会受到距离和其他音效的影响）。

    Parameters

    • val: number

    Returns void

coneOuterGain

  • get coneOuterGain(): number
  • set coneOuterGain(val: number): void

  • 在3D空间里，声音在coneOuterAngle属性定义的圆锥体外的音量衰减值。
    值1：表示不衰减；值0：表示静音。

    memberof

    AudioPannerNode

    Returns number

  • 在3D空间里，声音在coneOuterAngle属性定义的圆锥体外的音量衰减值。
    值1：表示不衰减；值0：表示静音。

    Parameters

    • val: number

    Returns void

creator

  • get creator(): any
  • set creator(val: any): void

  • 节点的创造者。即节点被谁创造

    memberof

    AudioBaseNode

    Returns any

  • 节点的创造者。即节点被谁创造

    Parameters

    • val: any

    Returns void

distanceModel

  • 3D空间音效里，音量随距离变化而变化的算法模型

    memberof

    AudioPannerNode

    Returns PannerDistanceModel

  • 3D空间音效里，音量随距离变化而变化的算法模型

    Parameters

    Returns void

id

  • get id(): string
  • set id(val: string): void

  • 节点id

    memberof

    AudioBaseNode

    Returns string

  • 节点id

    Parameters

    • val: string

    Returns void

input

  • get input(): AudioNode

  • 节点主路路由输入接口

    memberof

    AudioEffectNode

    Returns AudioNode

inputList

  • 节点主路路由输入信号的发送者节点列表

    memberof

    AudioBaseNode

    Returns AudioBaseNode[]

isDestroyed

  • get isDestroyed(): boolean

  • 节点是否已销毁

    memberof

    AudioBaseNode

    Returns boolean

maxDistance

  • get maxDistance(): number
  • set maxDistance(val: number): void

  • 在3D空间里，当AudioSource和AudioListener之间的距离大于该值，音量保持不变，不再衰减。

    memberof

    AudioPannerNode

    Returns number

  • 在3D空间里，当AudioSource和AudioListener之间的距离大于该值，音量保持不变，不再衰减。

    Parameters

    • val: number

    Returns void

minDistance

  • get minDistance(): number
  • set minDistance(val: number): void

  • 在3D空间里，当AudioSource和AudioListener之间的距离小于该值，音量不因距离而衰减。若距离大于该值，声音开始衰减。

    memberof

    AudioPannerNode

    Returns number

  • 在3D空间里，当AudioSource和AudioListener之间的距离小于该值，音量不因距离而衰减。若距离大于该值，声音开始衰减。

    Parameters

    • val: number

    Returns void

name

  • get name(): string

  • 节点名称

    memberof

    AudioBaseNode

    Returns string

numberOfSideChain

  • get numberOfSideChain(): number

  • 节点的侧链接口数量

    memberof

    AudioBaseNode

    Returns number

orientationX

  • get orientationX(): number
  • set orientationX(val: number): void

  • 在3D空间里，音源朝向X坐标

    memberof

    AudioPannerNode

    Returns number

  • 在3D空间里，音源朝向X坐标

    Parameters

    • val: number

    Returns void

orientationY

  • get orientationY(): number
  • set orientationY(val: number): void

  • 在3D空间里，音源朝向Y轴坐标

    memberof

    AudioPannerNode

    Returns number

  • 在3D空间里，音源朝向Y轴坐标

    Parameters

    • val: number

    Returns void

orientationZ

  • get orientationZ(): number
  • set orientationZ(val: number): void

  • 在3D空间里，音源朝向Z轴坐标

    memberof

    AudioPannerNode

    Returns number

  • 在3D空间里，音源朝向Z轴坐标

    Parameters

    • val: number

    Returns void

output

  • get output(): AudioNode

  • 节点主路路由输出接口

    memberof

    AudioEffectNode

    Returns AudioNode

outputList

  • 节点主路路由输出信号的接收者节点列表

    memberof

    AudioBaseNode

    Returns AudioBaseNode[]

outputSideChain

  • get outputSideChain(): AudioNode

  • 节点侧链路由输出接口

    memberof

    AudioEffectNode

    Returns AudioNode

outputSideChainList

  • 节点侧链输出信号的接收者节点列表。列表描述了信号被哪些节点的哪个侧链接口所接收。

    memberof

    AudioBaseNode

    Returns Map<AudioNode | AudioParam, ISideChainInterfaceInfo>

panningModel

  • 计算3D空间音效所使用的算法。

    memberof

    AudioPannerNode

    Returns PanningModel

  • 计算3D空间音效所使用的算法。

    Parameters

    Returns void

positionX

  • get positionX(): number
  • set positionX(val: number): void

  • 在3D空间里，音源位置X坐标

    memberof

    AudioPannerNode

    Returns number

  • 在3D空间里，音源位置X坐标

    Parameters

    • val: number

    Returns void

positionY

  • get positionY(): number
  • set positionY(val: number): void

  • 在3D空间里，音源位置Y坐标

    memberof

    AudioPannerNode

    Returns number

  • 在3D空间里，音源位置Y坐标

    Parameters

    • val: number

    Returns void

positionZ

  • get positionZ(): number
  • set positionZ(val: number): void

  • 在3D空间里，音源位置Z坐标

    memberof

    AudioPannerNode

    Returns number

  • 在3D空间里，音源位置Z坐标

    Parameters

    • val: number

    Returns void

rolloffFactor

  • get rolloffFactor(): number
  • set rolloffFactor(val: number): void

  • 此属性是distanceModel定义的算法中的一个因子。

    memberof

    AudioPannerNode

    Returns number

  • 此属性是distanceModel定义的算法中的一个因子。

    Parameters

    • val: number

    Returns void

sideChainInputList

  • 节点侧链输入信号的发送者列表

    memberof

    AudioBaseNode

    Returns AudioBaseNode[][]

spatialBlend

  • get spatialBlend(): number
  • set spatialBlend(val: number): void

  • 3D空间对音频源的影响程度。
    值0：只有2D声音，忽略所有3D空间音效的影响；值1：完全3D音效。

    memberof

    AudioPannerNode

    Returns number

  • 3D空间对音频源的影响程度。
    值0：只有2D声音，忽略所有3D空间音效的影响；值1：完全3D音效。

    Parameters

    • val: number

    Returns void

stereoPan

  • get stereoPan(): number
  • set stereoPan(val: number): void

  • 2D声音的左右声道。
    值-1：只有左声道；值0：双声道；值1：只有右声道

    memberof

    AudioPannerNode

    Returns number

  • 2D声音的左右声道。
    值-1：只有左声道；值0：双声道；值1：只有右声道

    Parameters

    • val: number

    Returns void

Methods

connect

  • 与指定节点创建主路路由链接。即将主路路由信号输出指定节点

    memberof

    AudioBaseNode

    Parameters

    Returns void

connectSideChain

  • connectSideChain(destination: AudioBaseNode, index: number): void

  • 与指定节点的指定侧链接口创建链接。即将信号输出到指定节点的指定侧链接口。

    memberof

    AudioBaseNode

    Parameters

    • destination: AudioBaseNode

      需要链接的节点

    • index: number

      侧链索引

    Returns void

connectSideChainSource

  • connectSideChainSource(source: AudioBaseNode, index: number): void

  • 以本节点指定侧链接口，接收指定节点的信号

    memberof

    AudioBaseNode

    Parameters

    Returns void

connectSource

  • 接收指定节点的主路路由信号

    memberof

    AudioBaseNode

    Parameters

    Returns void

destroy

  • destroy(): void

  • 销毁节点

    memberof

    AudioPannerNode

    Returns void

disconnect

  • 断开与指定节点在主路路由上的输出链接。则主路路由信号不会再输出到该节点。

    memberof

    AudioBaseNode

    Parameters

    • Optional destination: AudioBaseNode

      需要断开链接的节点。为空则表示断开主路路由所有输出链接。

    Returns void

disconnectSideChain

  • disconnectSideChain(): void
  • disconnectSideChain(sideChain: AudioNode | AudioParam): void
  • disconnectSideChain(baseNode: AudioBaseNode): void
  • disconnectSideChain(baseNode: AudioBaseNode, sideChainIndex: number): void

  • 断开侧链所有输出链接

    memberof

    AudioBaseNode

    Returns void

  • 断开与指定侧链接口的输出链接

    memberof

    AudioBaseNode

    Parameters

    • sideChain: AudioNode | AudioParam

      需要断开的侧链接口。可以为被封装过的WebAudio AudioParam对象，或被封装过的WebAudio AudioNode对象

    Returns void

  • 断开与指定节点的所有侧链接口的输出链接

    memberof

    AudioBaseNode

    Parameters

    • baseNode: AudioBaseNode

      需要断开所有侧链接口输出链接的节点

    Returns void

  • 断开与指定节点的指定侧链接口的输出链接

    memberof

    AudioBaseNode

    Parameters

    • baseNode: AudioBaseNode

      需要断开侧链接口输出链接的节点

    • sideChainIndex: number

      侧链接口索引

    Returns void

disconnectSideChainSource

  • disconnectSideChainSource(): void
  • disconnectSideChainSource(index: number): void
  • disconnectSideChainSource(source: AudioBaseNode, index: number): any

  • 断开所有侧链接口的所有输入链接

    memberof

    AudioBaseNode

    Returns void

  • 断开指定侧链接口的所有输入链接

    memberof

    AudioBaseNode

    Parameters

    • index: number

      侧链接口索引

    Returns void

  • 断开指定侧链接口与指定节点的链接

    memberof

    AudioBaseNode

    Parameters

    • source: AudioBaseNode

      输入信号节点

    • index: number

      侧链接口索引

    Returns any

disconnectSource

  • 断开与指定节点的主路路由输入链接。

    memberof

    AudioBaseNode

    Parameters

    • Optional source: AudioBaseNode

      需要断开链接的节点。为空则表示断开主路路由所有输入链接

    Returns void

getParameterIdByName

  • getParameterIdByName(name: string): string

  • 根据参数名，获取可被快照捕获的参数（即该参数可应用Transition）对应的id

    memberof

    AudioBaseNode

    Parameters

    • name: string

    Returns string

getSideChain

  • getSideChain(index: number): AudioNode | AudioParam

  • 根据索引获取侧链接口

    memberof

    AudioBaseNode

    Parameters

    • index: number

      侧链接口索引

    Returns AudioNode | AudioParam

Generated using TypeDoc