Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AudioDuckNode

闪避音效节点类。可将音效作用于AudioMixer Group。

Hierarchy

Index

Constructors

constructor

  • 构造函数

    memberof

    AudioDuckNode

    Parameters

    • Optional creator: any

      音效节点创建者。可为空

    Returns AudioDuckNode

Accessors

attack

  • get attack(): number
  • set attack(val: number): void
  • 压缩主路路由信号时,降低增益10dB所需时间。
    范围 0 至 1000,单位毫秒。

    memberof

    AudioDuckNode

    Returns number

  • 压缩主路路由信号时,降低增益10dB所需时间。
    范围 0 至 1000,单位毫秒。

    Parameters

    • val: number

    Returns void

creator

  • get creator(): any
  • set creator(val: any): void
  • 节点的创造者。即节点被谁创造

    memberof

    AudioBaseNode

    Returns any

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

    Parameters

    • val: any

    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

    AudioBaseNode

    Returns AudioNode

inputList

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

    memberof

    AudioBaseNode

    Returns AudioBaseNode[]

isDestroyed

  • get isDestroyed(): boolean
  • 节点是否已销毁

    memberof

    AudioBaseNode

    Returns boolean

knee

  • get knee(): number
  • set knee(val: number): void
  • 压缩主路路由信号时,使信号变成压缩比率ratio定义的信号的平滑变化程度。
    knee值越大,越平滑。
    范围 0 至 40。

    memberof

    AudioDuckNode

    Returns number

  • 压缩主路路由信号时,使信号变成压缩比率ratio定义的信号的平滑变化程度。
    knee值越大,越平滑。
    范围 0 至 40。

    Parameters

    • val: number

    Returns void

makeUpGain

  • get makeUpGain(): number
  • set makeUpGain(val: number): void
  • 被压缩后的主路路由信号的补偿增益。
    范围 -80 至 40,单位dB。

    memberof

    AudioDuckNode

    Returns number

  • 被压缩后的主路路由信号的补偿增益。
    范围 -80 至 40,单位dB。

    Parameters

    • val: number

    Returns void

name

  • get name(): string
  • 节点名称

    memberof

    AudioBaseNode

    Returns string

numberOfSideChain

  • get numberOfSideChain(): number
  • 节点的侧链接口数量

    memberof

    AudioBaseNode

    Returns number

output

  • get output(): AudioNode
  • 节点主路路由输出接口

    memberof

    AudioBaseNode

    Returns AudioNode

outputList

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

    memberof

    AudioBaseNode

    Returns AudioBaseNode[]

outputSideChain

  • get outputSideChain(): AudioNode
  • 节点侧链路由输出接口

    memberof

    AudioBaseNode

    Returns AudioNode

outputSideChainList

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

    memberof

    AudioBaseNode

    Returns Map<AudioNode | AudioParam, ISideChainInterfaceInfo>

ratio

  • get ratio(): number
  • set ratio(val: number): void
  • 压缩主路路由信号时使用的压缩比率。即输入多少dB增益变化,以产生1dB的输出变化。
    ratio越大,压缩效果越明显,压缩后声音越小。
    范围从 1 至 20。

    memberof

    AudioDuckNode

    Returns number

  • 压缩主路路由信号时使用的压缩比率。即输入多少dB增益变化,以产生1dB的输出变化。
    ratio越大,压缩效果越明显,压缩后声音越小。
    范围从 1 至 20。

    Parameters

    • val: number

    Returns void

release

  • get release(): number
  • set release(val: number): void
  • 压缩主路路由信号时,升高增益10dB所需时间。
    范围 0 至 1000,单位毫秒。

    memberof

    AudioDuckNode

    Returns number

  • 压缩主路路由信号时,升高增益10dB所需时间。
    范围 0 至 1000,单位毫秒。

    Parameters

    • val: number

    Returns void

sideChainInputList

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

    memberof

    AudioBaseNode

    Returns AudioBaseNode[][]

sideChainMix

  • get sideChainMix(): number
  • set sideChainMix(val: number): void
  • 主路路由和侧链的信号混合程度。范围 0 至 1 。
    值0:表示完全使用主路路由信号控制压缩器。
    值1:表示完全使用侧链信号控制压缩器。

    memberof

    AudioDuckNode

    Returns number

  • 主路路由和侧链的信号混合程度。范围 0 至 1 。
    值0:表示完全使用主路路由信号控制压缩器。
    值1:表示完全使用侧链信号控制压缩器。

    Parameters

    • val: number

    Returns void

threshold

  • get threshold(): number
  • set threshold(val: number): void
  • 声音压缩阈值。
    当主路路由和侧链的混合信号(混合程度取决于sideChainMix属性的值)分贝值高于threshold属性值,则使用threshold值压缩主路路由信号(压缩分贝值高于threshold值的信号)。
    如果混合信号分贝值低于threshold属性值,不压缩主路路由信号。
    范围从 -80 至 0,单位dB。

    memberof

    AudioDuckNode

    Returns number

  • 声音压缩阈值。
    当主路路由和侧链的混合信号(混合程度取决于sideChainMix属性的值)分贝值高于threshold属性值,则使用threshold值压缩主路路由信号(压缩分贝值高于threshold值的信号)。
    如果混合信号分贝值低于threshold属性值,不压缩主路路由信号。
    范围从 -80 至 0,单位dB。

    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

    AudioDuckNode

    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