com.dwuser.ss4.pseudoStyleClasses.AudioIntro

Package	com.dwuser.ss4.pseudoStyleClasses
Class	public class AudioIntro

Holds the style parameters which control the intro/background level audio. This class does not actually exist for any practical purposes; instead, it is used to document the available AudioIntro style values which can be applied in the <styles> section of the XML configuration file. This class is not implemented by a visual element; instead, it only provides control over settings which have no visual representation.

Background level audio is the audio which plays when a slideshow first opens, and is not associated with any specific gallery or image.

Style XML Implementation Example:

The following example code goes in the <styles> section of the main <slideshow> holder node in a slideshow XML configuration file.

   <styles>
   ...
      <AudioIntro
         stopOnGalleryOpen="false"
         volume="75"
         volumeChangeTime="1000"
         loop="false"
         useCache="true"
         buffer="4"
         autoplay="true"
         errorReporting="true"
      />
   ...
   </styles>

	Method	Defined by
		AudioIntro()	AudioIntro

Styles

	Description	Defined by
autoplay	Type: Boolean CSS Inheritance: no Specifies if the intro/background level audio should automatically start playing. The default value is `true`.	AudioIntro
buffer	Type: Number CSS Inheritance: no Specifies the minimum duration, in milliseconds, of the intro/background level audio which should be loaded into the buffer before playing begins. The default value is `4`.	AudioIntro
errorReporting	Type: Boolean CSS Inheritance: no Specifies if a 'Fatal Error' message should be displayed if the intro/background level audio fails to load. This setting should generally be set to 'false' for production. The default value is `true`.	AudioIntro
loop	Type: Boolean CSS Inheritance: no Specifies whether the intro/background level audio should automatically loop. The default value is `false`.	AudioIntro
stopOnGalleryOpen	Type: Boolean CSS Inheritance: no Specifies whether the intro/background level audio should automatically stop as soon as a gallery is opened. If you have specified both intro/background audio and gallery-specific audio, you'll likely want to enable this setting so that background audio will stop playing before the gallery audio starts playing. This allows for "lobby" audio prior to a user opening a specific gallery. The default value is `false`.	AudioIntro
useCache	Type: Boolean CSS Inheritance: no Specifies whether a cached version of the audio file for the intro/background level audio should be used if available. If you frequently replace an audio file with a new version, then disable caching by setting this parameter to `false`. Otherwise, leave it at `true`, as this will provide the best loading performance. The default value is `true`.	AudioIntro
volume	Type: Number CSS Inheritance: no Specifies the initial volume level for the intro/background level audio. Valid values range from 0 (muted) to 100 (full volume). The default value is `75`.	AudioIntro
volumeChangeTime	Type: Number Format: Time CSS Inheritance: no Specifies the duration, in milliseconds, over which volume changes take place for intro/background level audio. This allows for a fade-in or fade-out effect when the volume is changed. The default value is `1000`.	AudioIntro

XML Flash Slideshow v4 - Class Documentation	All Packages \| All Classes \| Index \| Frames No Frames
Class AudioIntro	Methods \| Styles