Sound Interface Plugin soundinterface.swf / soundinterface.js

• The Sound Interface plugin extends krpano with actions for playing and controlling sounds directly from xml.
• The plugin must be loaded only once for all sounds. The sounds itself will be started / stopped / controlled by calling the Sound Interface actions.
  
• See also the HTML5 / iOS (iPhone/iPad) notes.

Syntax

<plugin name="soundinterface"
        url.flash="soundinterface.swf"
        url.html5="soundinterface.js"
        preload="true"
        rootpath=""
        volume="1.0"
        mute="false"
        />

Plugin Attributes

• rootpath  (optionally)
  • root path for the the sound files
  • relative from the xml file, default=""
  • it's possible to use placeholders like %SWFPATH% here
• volume  (optionally)
  • the global volume for all sounds
  • 0.0 - 1.0, default=1.0
  • can be dynamically changed by actions (set(), tween(), ...)
• mute  (optionally)
  • set the global mute for all sounds
  • true or false, default=false
  • can be dynamically changed by actions (set(), ...)

Plugin Actions

• preloadsound(audiofile)
  • preloads a sound file
  • this can be used to reduce the latency when starting to play
  • audiofilefile = the path and filename of a sound file
• playsound(name, audiofile, loops*, oncomplete*)
  • plays a sound file
  • name = unique identification name for the sound (use "auto" for an automatic id)
  • audiofile = the path and filename of a sound file
  • loops = number of loops, 0=endless, default=1 (*optional)
  • oncomplete = actions that will be called on complete (*optional)
• playsound2D(name, audiofile, volume*, pan*, loops*, oncomplete*)  (Flash only)
  • plays a sound file with adjustable volume and panning
  • name = unique identification name for the sound (use "auto" for an automatic id)
  • audiofile = the path and filename of a sound file
  • volume = sound volume (0.0 - 1.0, default=1.0) (*optional)
  • pan = left/right panning (-1.0(=left) - +1.0(=right), default=0.0) (*optional)
  • loops = number of loops, 0=endless, default=1 (*optional)
  • oncomplete = actions that will be called on complete (*optional)
• playsound3D(name, audiofile, ath, atv, range*, volume*, loops*, oncomplete*)  (Flash only)
  • plays a directional 3D sound at a given spherical position
  • name = unique identification name for the sound (use "auto" for an automatic id)
  • audiofile = the path and filename of a sound file
  • ath = horizontal sound source position (-180 .. 180)
  • atv = vertical sound source position (-90 .. +90)
  • range = range of the sound (in degrees, default=90) (*optional)
  • volume = sound volume (0.0 - 1.0, default=1.0) (*optional)
  • loops = number of loops, 0=endless, default=1 (*optional)
  • oncomplete = actions that will be called on complete (*optional)
• playsound3Dh(name, audiofile, ath, range*, volume*, loops*, oncomplete*)  (Flash only)
  • plays a directional 3D sound at a given horizontal position
  • independent of the vertical looking direction
  • name = unique identification name for the sound (use "auto" for an automatic id)
  • audiofile = the path and filename of a sound file
  • ath = horizontal sound source position (-180 .. 180)
  • atv = vertical sound source position (-90 .. +90)
  • range = range of the sound (in degrees, default=90) (*optional)
  • volume = sound volume (0.0 - 1.0, default=1.0) (*optional)
  • loops = number of loops, 0=endless, default=1 (*optional)
  • oncomplete = actions that will be called on complete (*optional)
• playsound3DHS(name, audiofile, hotspotname, range*, volume*, loops*, oncomplete*)  (Flash only)
  • plays a directional 3D sound at a hotspot position
  • when the hotspot moves the sound will follow it
  • name = unique identification name for the sound (use "auto" for an automatic id)
  • audiofile = the path and filename of a sound file
  • hotspotname = name of the hotspot
  • range = range of the sound (in degrees, default=90) (*optional)
  • volume = sound volume (0.0 - 1.0, default=1.0) (*optional)
  • loops = number of loops, 0=endless, default=1 (*optional)
  • oncomplete = actions that will be called on complete (*optional)
• pausesound(name)
  • pauses a sound
  • name = identification name of the sound
• resumesound(name)
  • resumes a paused sound
  • name = identification name of the sound
• pausesoundtoggle(name)
  • pauses OR resumes a sound
  • name = identification name of the sound
• stopsound(name)
  • stops playing a sound
  • name = identification name of the sound
• stopallsounds(globalstop*)
  • stop all playing sounds
  • globalstop = true or false, default=false (*optional)
    By default only the sounds started by the soundinterface will be stopped, but with true as parameter also all other flash sounds, e.g. from the videoplayer plugin or any other source, will be stopped.

HTML5 and iOS (iPhone / iPad) Notes

playsound(bg, 'sound.mp3|sound.ogg');

iOS (iPhone / iPad) Notes