Class AudioSource

Hierarchy (view full)

Accessors

ShouldPlay Sound activeAndEnabled context destroyed enabled forward hideFlags isComponent isPlaying layer loop maxDistance minDistance name right scene spatialBlend static tag time up volume worldEuler worldPosition worldQuaternion worldRotation userInteractionRegistered

Methods

addEventListener awake destroy dispatchEvent earlyUpdate? lateUpdate? onAfterRender? onBeforeRender? onCollisionEnter? onCollisionExit? onCollisionStay? onDestroy onDisable onEnable onPausedChanged? onTriggerEnter? onTriggerExit? onTriggerStay? onValidate? pause play removeEventListener resolveGuids? setWorldPosition setWorldQuaternion setWorldRotation start? startCoroutine stop stopCoroutine update registerWaitForAllowAudio

Accessors

ShouldPlay

  • get ShouldPlay(): boolean

  • Returns boolean

Sound

  • get Sound(): any

  • Returns any

activeAndEnabled

  • get activeAndEnabled(): boolean

  • Returns boolean

context

  • get context(): Context

  • Returns Context

  • set context(context): void

  • Parameters

    Returns void

destroyed

  • get destroyed(): boolean

  • Returns boolean

enabled

  • get enabled(): boolean

  • Returns boolean

  • set enabled(val): void

  • Parameters

    • val: boolean

    Returns void

forward

  • get forward(): Vector3

  • Forward (0,0,-1) vector in world space

    Returns Vector3

hideFlags

  • get hideFlags(): HideFlags

  • Returns HideFlags

isComponent

  • get isComponent(): boolean

  • Returns boolean

isPlaying

  • get isPlaying(): boolean

  • Returns boolean

  • set isPlaying(_): void

  • Parameters

    • _: boolean

    Returns void

layer

  • get layer(): number

  • Returns number

loop

  • get loop(): boolean

  • Returns boolean

  • set loop(val): void

  • Parameters

    • val: boolean

    Returns void

maxDistance

  • get maxDistance(): number

  • Returns number

  • set maxDistance(val): void

  • Parameters

    • val: number

    Returns void

minDistance

  • get minDistance(): number

  • Returns number

  • set minDistance(val): void

  • Parameters

    • val: number

    Returns void

name

  • get name(): string

  • Returns string

  • set name(str): void

  • Parameters

    • str: string

    Returns void

right

  • get right(): Vector3

  • Right (1,0,0) vector in world space

    Returns Vector3

scene

  • get scene(): Scene

  • Returns Scene

spatialBlend

  • get spatialBlend(): number

  • 0 = 2D, 1 = 3D

    Returns number

  • set spatialBlend(val): void

  • Parameters

    • val: number

    Returns void

static

  • get static(): any

  • Returns any

tag

  • get tag(): string

  • Returns string

  • set tag(str): void

  • Parameters

    • str: string

    Returns void

time

  • get time(): number

  • Returns number

  • set time(val): void

  • Parameters

    • val: number

    Returns void

up

  • get up(): Vector3

  • Up (0,1,0) vector in world space

    Returns Vector3

volume

  • get volume(): number

  • Returns number

  • set volume(val): void

  • Parameters

    • val: number

    Returns void

worldEuler

  • get worldEuler(): Euler

  • Returns Euler

  • set worldEuler(val): void

  • Parameters

    • val: Euler

    Returns void

worldPosition

  • get worldPosition(): Vector3

  • Returns Vector3

  • set worldPosition(val): void

  • Parameters

    • val: Vector3

    Returns void

worldQuaternion

  • get worldQuaternion(): Quaternion

  • Returns Quaternion

  • set worldQuaternion(val): void

  • Parameters

    • val: Quaternion

    Returns void

worldRotation

  • get worldRotation(): Vector3

  • Returns Vector3

  • set worldRotation(val): void

  • Parameters

    • val: Vector3

    Returns void

Static userInteractionRegistered

  • get userInteractionRegistered(): boolean

  • Returns boolean

Methods

addEventListener

  • addEventListener<T>(type, listener): void

  • Type Parameters

    Parameters

    • type: string
    • listener: ((evt) => any)
        • (evt): any

        • Parameters

          • evt: T

          Returns any

    Returns void

awake

  • awake(): void

  • called once when the component becomes active for the first time

    Returns void

destroy

dispatchEvent

Optional earlyUpdate

Optional lateUpdate

Optional onAfterRender

Optional onBeforeRender

Optional onCollisionEnter

Optional onCollisionExit

Optional onCollisionStay

onDestroy

onDisable

onEnable

  • onEnable(): void

  • called every time when the component gets enabled (this is invoked after awake and before start)

    Returns void

Optional onPausedChanged

  • onPausedChanged(isPaused, wasPaused): void

  • Called for all scripts when the context gets paused or unpaused

    Parameters

    • isPaused: boolean
    • wasPaused: boolean

    Returns void

Optional onTriggerEnter

Optional onTriggerExit

Optional onTriggerStay

Optional onValidate

  • onValidate(prop?): void

  • called when you decorate fields with the @validate() decorator

    Parameters

    • Optional prop: string

    Returns void

pause

  • pause(): void

  • Returns void

play

  • play(clip?): void

  • Play a mediastream

    Parameters

    Returns void

removeEventListener

  • removeEventListener<T>(type, listener): void

  • Type Parameters

    Parameters

    • type: string
    • listener: ((arg) => any)
        • (arg): any

        • Parameters

          • arg: T

          Returns any

    Returns void

Optional resolveGuids

  • resolveGuids(guidsMap): void

  • called on a component with a map of old to new guids (e.g. when instantiate generated new guids and e.g. timeline track bindings needs to remape them)

    Parameters

    • guidsMap: GuidsMap

    Returns void

setWorldPosition

setWorldQuaternion

  • setWorldQuaternion(x, y, z, w): void

  • Parameters

    • x: number
    • y: number
    • z: number
    • w: number

    Returns void

setWorldRotation

  • setWorldRotation(x, y, z, degrees?): void

  • Parameters

    • x: number
    • y: number
    • z: number
    • degrees: boolean = true

    Returns void

Optional start

startCoroutine

stop

  • stop(): void

  • Returns void

stopCoroutine

  • stopCoroutine(routine, evt?): void

  • Parameters

    • routine: Generator<unknown, any, unknown>
    • evt: FrameEvent = FrameEvent.Update

    Returns void

update

Static registerWaitForAllowAudio

  • registerWaitForAllowAudio(cb): void

  • Parameters

    Returns void

Settings

Member Visibility

Theme

On This Page

ShouldPlaySoundactiveAndEnabledcontextdestroyedenabledforwardhideFlagsisComponentisPlayinglayerloopmaxDistanceminDistancenamerightscenespatialBlendstatictagtimeupvolumeworldEulerworldPositionworldQuaternionworldRotationuserInteractionRegisteredaddEventListenerawakedestroydispatchEventearlyUpdatelateUpdateonAfterRenderonBeforeRenderonCollisionEnteronCollisionExitonCollisionStayonDestroyonDisableonEnableonPausedChangedonTriggerEnteronTriggerExitonTriggerStayonValidatepauseplayremoveEventListenerresolveGuidssetWorldPositionsetWorldQuaternionsetWorldRotationstartstartCoroutinestopstopCoroutineupdateregisterWaitForAllowAudio

Generated using TypeDoc