Packagecom.dwuser.ss4.pseudoStyleClasses
Classpublic class AudioGallery

Holds the style parameters which control the gallery level audio. This class does not actually exist for any practical purposes; instead, it is used to document the available AudioGallery 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.

Gallery level audio is the audio which is associated with a specific gallery and only plays when that gallery is open.

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>
   ...
      <AudioGallery
         volume="75"
         volumeChangeTime="1000"
         loop="false"
         useCache="true"
         buffer="4"
         autoplay="true"
         errorReporting="true"
      />
   ...
   </styles>
   



Public Methods
 MethodDefined by
  
AudioGallery
Styles
 StyleDescriptionDefined by
  
autoplay
Type: Boolean   CSS Inheritance: no
Specifies if the gallery level audio should automatically start playing. The default value is true.
AudioGallery
  
buffer
Type: Number   CSS Inheritance: no
Specifies the minimum duration, in milliseconds, of the gallery level audio which should be loaded into the buffer before playing begins. The default value is 4.
AudioGallery
  
errorReporting
Type: Boolean   CSS Inheritance: no
Specifies if a 'Fatal Error' message should be displayed if the gallery level audio fails to load. This setting should generally be set to 'false' for production. The default value is true.
AudioGallery
  
loop
Type: Boolean   CSS Inheritance: no
Specifies whether the gallery level audio should automatically loop. The default value is false.
AudioGallery
  
useCache
Type: Boolean   CSS Inheritance: no
Specifies whether a cached version of the audio file for the gallery 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.
AudioGallery
  
volume
Type: Number   CSS Inheritance: no
Specifies the initial volume level for the gallery level audio. Valid values range from 0 (muted) to 100 (full volume). The default value is 75.
AudioGallery
  
volumeChangeTime
Type: Number   Format: Time   CSS Inheritance: no
Specifies the duration, in milliseconds, over which volume changes take place for gallery level audio. This allows for a fade-in or fade-out effect when the volume is changed. The default value is 1000.
AudioGallery
Constructor detail
AudioGallery()constructor
public function AudioGallery()