🧰
Developer
  • ENGAGE SDK overview
  • Setting up the ENGAGE SDK
    • Registering as an ENGAGE developer
    • Setting up your local git repository
    • Installing the Unity Editor
    • Opening the ENGAGE SDK Unity project
    • Checking for SDK updates
    • Installing a platform build module
  • ENGAGE SDK project folders
  • General guidelines for 3D models
    • Optimizing 3D models
  • Locations
    • Guidelines for locations
    • Creating a new location
    • Building a location bundle
    • Testing a location locally on Windows
    • Configuring an object as a teleport target
    • Configuring the start position
    • Seats
      • Creating a seat
      • Using the summon to seat system
    • Network states
      • Network State Manager
      • Location Network States
      • Example network state configurations
        • Network state toggle object
        • Network state animation start/stop
        • Network state change animation
          • Creating an animation in Unity
          • Using Animator.Play(string)
          • Defining Animator transitions
          • Using Animator.SetTrigger(string)
        • Network state sync animation
        • Network state position toggle
        • Network state automatic door
        • Network state toggle skybox
        • Network state change materials
    • Adding grabable objects to a location
      • Resetting network objects with a button
      • Resetting network objects when out of bounds
    • Locations reference information
      • Basic requirements for a location
  • Immersive Effects (IFX)
    • Guidelines for IFX
    • Creating an IFX
    • Building an IFX bundle
    • Testing IFX locally on Windows
    • Specialized IFX
      • Animated IFX
        • Animation overrides
          • Legacy animations
          • Animator animations
          • Configuring additional Effect Life Run Control properties
      • Audio IFX
      • Interactive IFX
  • List of available prefabs
  • Available scripts
    • External Video Player
  • Profiling
  • Publishing to ENGAGE
    • Publishing checklists
    • Pushing files to your GitHub repository
  • AFX
    • Getting started
      • Changelog
    • AFX Graphs
      • Creating an AFX graph
      • Editing an AFX graph
      • Navigation and keyboard shortcuts
      • Adding an AFX graph to a game object
      • Nodes
      • Ports
      • Connections
      • Flows
        • Starting a flow
        • Using multiple flows
        • Chaining flows
        • Controlling flows
      • References
      • Using AFX Events
    • Networking AFX
      • Network State Modules
      • Ownership of networked objects
    • Animation curves
    • Node dictionary
      • ENGAGE
        • AFX Companion
          • Constant Collision
          • Grab Object
          • PathData
        • Networking
          • Network State Modules
        • Physics
        • Player
        • Seat
      • Events
        • Collision
        • Unity
        • AFX Events
      • Flow
      • Reference
      • Unity
        • Component
          • Animation
            • Set Parameters
          • Audio
            • Audio Reverb Zone
            • Audio Source
          • Collider
          • FX
          • Rendering
            • Camera
            • Light
            • Material
          • UI
        • Constraint
        • GameObject
        • Input
        • Physics
          • Raycast
            • Layer Mask
          • RigidBody
            • Joint
              • Hinge
              • Spring
          • Wheel Collider
        • Time
        • Transform
          • Get
          • Set
          • Space Switching
      • Variable
        • Bool
        • Comparison
        • Float
        • Int
        • List
        • Math
          • MathF
        • String
        • Unity Component
        • Vector
          • Quaternion
          • Vector2
          • Vector 3
            • Vector3 Math
    • Sample graphs
Powered by GitBook
On this page
  • Audio Source Info
  • Set value nodes
  1. AFX
  2. Node dictionary
  3. Unity
  4. Component
  5. Audio

Audio Source

PreviousAudio Reverb ZoneNextCollider

Last updated 7 months ago

Audio Source Info

Access information about an Audio Source.

Name
Type
Description

Audio Source In

Audio Source

Reference to an Audio Source object.

Outputs:

Name
Type
Description

Is Playing

Boolean

True if the Audio Source is currently playing. Otherwise, false.

Time

Float

The number of seconds from the start of the audio clip that's currently being played.

Volume

Float

How loud the sound is.

Set value nodes

The set nodes for an Audio Source have a similar arrangement of inputs and outputs, as described in the following sections.

Inputs:

Name
Type
Description

Enter

Flow

Flow to activate the node.

Audio Source In

Audio Source

Reference to an Audio Source object.

<property>

<varies> [editable]

The value to set for the chosen property.

Outputs:

Name
Type
Description

Exit

Flow

Continue the activating flow.

Available nodes:

Name
Input type
Description

Set Audio Clip

Audio Clip

Sets the Audio Clip to be played.

Set Doppler Level

Float

Determines how much Doppler effect will be applied to this audio source (if is set to 0, then no effect is applied).

Set Loop

Boolean

If true, the audio clip repeats after it reaches the end.

Set Max Distance

Float

The distance where the sound stops attenuating at.

Set Min Distance

Float

Within the MinDistance, the sound will stay at loudest possible. Outside MinDistance it will begin to attenuate.

Set Mute

Boolean

If true, the audio is muted.

Set Pitch

Float

The pitch of the audio. 1.0 is normal pitch.

Set Play on Awake

Boolean

If true, the audio will begin to play when the scene loads. If false, you will need to play the audio.

Set Reverb Zone Mix

Float

Sets the amount of the output signal that gets routed to the reverb zones.

Set Spacial Blend

Float

Sets how much the 3D engine has an effect on the audio source.

Set Spread

Float

Sets the spread angle to 3D stereo or multichannel sound in speaker space.

Set Stereo Pan

Float

Sets the position in the stereo field of 2D sounds.

Set Volume

Float

The loudness of the sound.

Rolloff

[Parameter list]

There are multiple nodes that you can use to set properties of an Audio Source. For more information, refer to the page in the Unity documentation.

How fast the sound fades. The available options are logarithmic, linear, or custom. For more information, refer to the Types of Rolloff section on the page of the Unity documentation.

Audio Source
Audio Source
Example set node for an Audio Source - the Set Audio Clip node