Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AudioSource

音频源组件类。

export

Hierarchy

Index

Constructors

constructor

Properties

Readonly entity

entity: Entity

Readonly id

id: number = ...

Readonly isDestroyed

isDestroyed: boolean = false

Readonly isDestroying

isDestroying: boolean = false

Readonly priority

priority: number = ...

Static Priority

Priority: { Align: number; Layout: number; Low: number; Physics: number; Render: number; Tool: number } = ...

Type declaration

  • Align: number
  • Layout: number
  • Low: number
  • Physics: number
  • Render: number
  • Tool: number

Static Optional Serialize

Serialize: (...args: any[]) => any

Type declaration

    • (...args: any[]): any
    • Parameters

      • Rest ...args: any[]

      Returns any

Accessors

active

  • get active(): boolean
  • set active(value: boolean): void
  • Returns boolean

  • Parameters

    • value: boolean

    Returns void

activeInHierarchy

  • get activeInHierarchy(): boolean
  • 在场景树中是否active

    readonly
    memberof

    Component

    Returns boolean

audioPriority

  • get audioPriority(): number
  • set audioPriority(val: number): void
  • AudioSource播放的声音的优先级。
    值为0:表示优先级最高。值为255:表示优先级最低。
    值为0,AudioSource播放的声音不会被设置为虚拟音频,即AudioSource播放的声音一定会被听到。

    memberof

    AudioSource

    Returns number

  • AudioSource播放的声音的优先级。
    值为0:表示优先级最高。值为255:表示优先级最低。
    值为0,AudioSource播放的声音不会被设置为虚拟音频,即AudioSource播放的声音一定会被听到。

    Parameters

    • val: number

    Returns void

audioSourceNode

  • 音频源节点对象。

    memberof

    AudioSource

    Returns AudioSourceNode

bypassEffects

  • get bypassEffects(): boolean
  • set bypassEffects(val: boolean): void
  • 是否绕过AudioSource所在节点的所有音效。

    memberof

    AudioSource

    Returns boolean

  • 是否绕过AudioSource所在节点的所有音效。

    Parameters

    • val: boolean

    Returns void

bypassListenerEffects

  • get bypassListenerEffects(): boolean
  • set bypassListenerEffects(val: boolean): void
  • 是否绕过AudioListener所在节点的所有音效。
    无论AudioSource播放的声音是直接被AudioListener接收,还是先经过AudioMixer处理,再被AudioListener接收,此属性均有效。
    当节点上有且只有一个AudioSource时,此属性才有效。即当节点上存在多个AudioSource时,这些AudioSource播放的声音一定会被AudioListener所在节点的所有音效处理。

    memberof

    AudioSource

    Returns boolean

  • 是否绕过AudioListener所在节点的所有音效。
    无论AudioSource播放的声音是直接被AudioListener接收,还是先经过AudioMixer处理,再被AudioListener接收,此属性均有效。
    当节点上有且只有一个AudioSource时,此属性才有效。即当节点上存在多个AudioSource时,这些AudioSource播放的声音一定会被AudioListener所在节点的所有音效处理。

    Parameters

    • val: boolean

    Returns void

canplay

  • get canplay(): boolean
  • 资源是否就绪,可以播放。

    memberof

    AudioSource

    Returns boolean

clip

  • 要播放的音频剪辑audioclip资源。

    memberof

    AudioSource

    Returns AudioClip

  • 要播放的音频剪辑audioclip资源。

    Parameters

    Returns void

coneInnerAngle

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

    memberof

    AudioSource

    Returns number

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

    Parameters

    • val: number

    Returns void

coneOuterAngle

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

    memberof

    AudioSource

    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

    AudioSource

    Returns number

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

    Parameters

    • val: number

    Returns void

currentTime

  • get currentTime(): number
  • 当前音频的播放时间。

    memberof

    AudioSource

    Returns number

distanceModel

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

    memberof

    AudioSource

    Returns PannerDistanceModel

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

    Parameters

    Returns void

duration

  • get duration(): number
  • 音频时长。

    memberof

    AudioSource

    Returns number

effectNode

isVirtual

  • get isVirtual(): boolean
  • set isVirtual(val: boolean): void
  • 声音是否处于虚拟状态。

    memberof

    AudioSource

    Returns boolean

  • 声音是否处于虚拟状态。

    Parameters

    • val: boolean

    Returns void

loop

  • get loop(): boolean
  • set loop(val: boolean): void
  • 是否循环播放。

    memberof

    AudioSource

    Returns boolean

  • 是否循环播放。

    Parameters

    • val: boolean

    Returns void

maxDistance

  • get maxDistance(): number
  • set maxDistance(val: number): void
  • 在3D空间里,当AudioSource和AudioListener之间的距离大于该值,音量保持不变,不再衰减。

    memberof

    AudioSource

    Returns number

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

    Parameters

    • val: number

    Returns void

minDistance

  • get minDistance(): number
  • set minDistance(val: number): void
  • 在3D空间里,当AudioSource和AudioListener之间的距离小于该值,音量不因距离而衰减。若距离大于该值,声音开始衰减。

    memberof

    AudioSource

    Returns number

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

    Parameters

    • val: number

    Returns void

mute

  • get mute(): boolean
  • set mute(val: boolean): void
  • 是否静音。

    memberof

    AudioSource

    Returns boolean

  • 是否静音。

    Parameters

    • val: boolean

    Returns void

outputMixerGroup

  • get outputMixerGroup(): AudioMixerGroup
  • set outputMixerGroup(val: AudioMixerGroup): void
  • 混音器音频组AudioMixer Group。
    指定AudioSource播放的声音输出到指定混音器的指定音频组。
    为空,则声音直接输出到AudioListener。当然,在输出到AudioListener前可能会先经过AudioListener所在节点的音效处理。

    memberof

    AudioSource

    Returns AudioMixerGroup

  • 混音器音频组AudioMixer Group。
    指定AudioSource播放的声音输出到指定混音器的指定音频组。
    为空,则声音直接输出到AudioListener。当然,在输出到AudioListener前可能会先经过AudioListener所在节点的音效处理。

    Parameters

    • val: AudioMixerGroup

    Returns void

pannerNode

  • 3D空间音效节点对象。

    memberof

    AudioSource

    Returns AudioPannerNode

panningModel

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

    memberof

    AudioSource

    Returns PanningModel

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

    Parameters

    Returns void

paused

  • get paused(): boolean
  • 是否暂停中

    memberof

    AudioSource

    Returns boolean

pitch

  • get pitch(): number
  • set pitch(val: number): void
  • 声音播放速率。
    值1:表示正常播放速度。慢速或快速播放会引起音高的变化。

    memberof

    AudioSource

    Returns number

  • 声音播放速率。
    值1:表示正常播放速度。慢速或快速播放会引起音高的变化。

    Parameters

    • val: number

    Returns void

playOnAwake

  • get playOnAwake(): boolean
  • set playOnAwake(val: boolean): void
  • 如果启用此选项,声音将在场景启动时自动播放。
    如果禁用此选项,需要通过脚本调用 AudioSource.play 函数播放声音。

    memberof

    AudioSource

    Returns boolean

  • 如果启用此选项,声音将在场景启动时自动播放。
    如果禁用此选项,需要通过脚本调用 AudioSource.play 函数播放声音。

    Parameters

    • val: boolean

    Returns void

playing

  • get playing(): boolean
  • 是否播放中。

    memberof

    AudioSource

    Returns boolean

rolloffFactor

  • get rolloffFactor(): number
  • set rolloffFactor(val: number): void
  • 此属性是distanceModel定义的算法中的一个因子。

    memberof

    AudioSource

    Returns number

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

    Parameters

    • val: number

    Returns void

spatialBlend

  • get spatialBlend(): number
  • set spatialBlend(val: number): void
  • 3D空间对音频源的影响程度。
    值0:只有2D声音,忽略所有3D空间音效的影响;值1:完全3D音效。

    memberof

    AudioSource

    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

    AudioSource

    Returns number

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

    Parameters

    • val: number

    Returns void

volume

  • get volume(): number
  • set volume(val: number): void
  • 声音的原始音量。
    值1:表示音量不变;值0:表示静音。

    memberof

    AudioSource

    Returns number

  • 声音的原始音量。
    值1:表示音量不变;值0:表示静音。

    Parameters

    • val: number

    Returns void

Methods

destroy

  • destroy(): void

getTypeName

  • getTypeName(): string

isDetached

  • isDetached(): boolean

pause

  • pause(): void
  • 暂停播放

    memberof

    AudioSource

    Returns void

play

  • play(time?: number): void
  • 从音频的指定时间开始播放或者从暂停状态恢复播放

    memberof

    AudioSource

    Parameters

    • time: number = 0

      音频开始播放的时间,单位秒。缺省值为0。小于等于0:表示;从暂停状态恢复播放或者重新播放

    Returns void

playClip

  • 使用AudioSource的配置,播放指定audioClip资源。
    成功则返回新创建的AudioSourceNode对象。此对象会在AudioSource销毁时自动销毁。开发者也可以自行调用AudioSourceNode.destroy来销毁。

    memberof

    AudioSource

    Parameters

    • clip: AudioClip

      需要播放的clip资源

    • volumeScale: number = 1

      AudioSource音量的系数,即AudioSource.volume * volumeScale作为新的初始音量

    • startCtxTime: number = 0

      在音频系统时间坐标系上指定时间点开始播放,单位秒。 0或者小于音频系统当前时间,表示立刻播放。

    • startTime: number = 0

      从音频的指定时间开始播放。单位秒。

    Returns AudioSourceNode

playScheduled

  • playScheduled(startCtxTime: number, startTime: number): void
  • 计划播放。
    在音频系统时间坐标系上指定时间点,从音频的指定时间开始播放。
    播放状态下不能调用playScheduled。

    memberof

    AudioSource

    Parameters

    • startCtxTime: number

      音频系统时间坐标系上的时间点,单位秒。0或者小于音频系统当前时间,表示立刻播放。

    • startTime: number

      以音频文件时间为参考的时间,单位秒。

    Returns void

resetProperties

  • resetProperties(): void

seek

  • seek(time: number): void
  • 从音频的指定时间点播放。
    只有暂停状态或者调用过play和playScheduled方法后才能调用seek,否则出错。

    memberof

    AudioSource

    Parameters

    • time: number

      以音频文件时间为参考的时间,单位秒。

    Returns void

stop

  • stop(): void
  • 停止播放

    memberof

    AudioSource

    Returns void

stopScheduled

  • stopScheduled(startCtxTime: number): void
  • 计划停止播放。
    在音频系统时间坐标系上指定时间点,停止播放

    memberof

    AudioSource

    Parameters

    • startCtxTime: number

      音频系统时间坐标系上的时间点,单位秒。0或者小于音频系统当前时间,表示立刻停止。

    Returns void

Generated using TypeDoc