<sound>

Description

A sound node plays a sound. The sound can have directional properties, so the stereo effect moves with the camera, even for mono sound sources. For stereo sound sources, the channels are mixed and reverse to match the direction of the sound. Sounds can either be streamed live from the location, or they can be preloaded.

Sounds should be in mp3 format. The '#membername' syntax to load a resource from a cast can not be used with sound nodes at this time; sounds have to be external files.

Syntax

<tour>
  <scene>
    <sound id="soundID" behavior="someBehavior" 
      src="yoursound.mp3" volume="90" ambient="20" pan="15" tilt="5" radius="10"
      streaming="true" loop="true" active="false" />
    ...
  </scene>
  ...

</tour>

Attributes

• id

  Unique id to reference the sound by.

• src

  Relative url of the mp3 file to use.

• pan

  If set, sets the pan value of the source of the sound in the scene. If the pan value is not set, but a tilt value is set, the sound volume will change according to the camera tilt, but the stereo image will not change.
  Values: true or false, defaults to false

• tilt

  If set, sets the tilt value of the source of the sound in the scene. If the tilt value is not set, but a pan value is set, the sound is still directional but tilting the camera will not change the sound.
  Values: 0 - 360, or none

• radius

  If pan and/or tilt are set, radius determines the camera angle in which the sound fades from 'volume' to 'ambient'
  Values: 0.01 - 180, defaults to 90

• volume

  Turns the sound on or off.
  Values: 0 - 100, defaults to 100

• ambient

  If the sound is directional, this is the residual volume ouside the specified radius.
  Values: 0 - 100, defaults to 0

• active

  Turns the sound on or off.
  Values: true or false, defaults to false

• loop

  Sets the number of times a sound plays.
  
  Values: 1 or higher, ot 'true'. If set to 'true', sounds loops indefinately. Defaults to 1

• streaming

  Specifies whether the sound resource is downloaded before playback commences. If set to true, only a short buffer will be downloaded before the sound playback is started.
  Values: true or false, defaults to false

Events

• ready

  Fires when the sound file is done loading and streaming = false.

• start

  Fires when the sounds starts playing.

• stop

  Fires when sound reaches its end and loop = false.

• loop

  Fires when sound reaches its end and loop = true.

• change

  Fires during sound playback (on each iteration).

Children

• behavior

History

• 22-Nov-07: Restored lost documentation