Package net.webpdf.wsclient.schema.operation

Class SoundActionType

  • public class SoundActionType
extends ActionEventType
     <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">When activated, the playSound Element plays the specified audio data.</p>

    Java class for SoundActionType complex type

    .

    The following schema fragment specifies the expected content contained within this class.

    
 <complexType name="SoundActionType">
   <complexContent>
     <extension base="{http://schema.webpdf.de/1.0/operation}ActionEventType">
       <all>
         <element name="sound" type="{http://www.w3.org/2001/XMLSchema}base64Binary"/>
       </all>
       <attribute name="volume" default="100">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}int">
             <minInclusive value="-100"/>
             <maxInclusive value="100"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="synchronous" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="repeat" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="mix" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="samplingRate" default="8000">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}float">
             <minInclusive value="1"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="soundChannels" default="1">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}int">
             <minInclusive value="1"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="sampleSize" default="8">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}int">
             <minInclusive value="1"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="encoding" type="{http://schema.webpdf.de/1.0/operation}AudioEncodingType" default="Raw" />
     </extension>
   </complexContent>
 </complexType>

    • Field Detail

      • sound

        protected byte[] sound
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The audio file that should be played. The file must be encoded as a BASE64 value. The passed file must be completely independent and contain all the information and data required to play it. The AIFF, AIFF-C, RIFF (*.wav), snd(*.au) audio formats are supported, for example.</p>

      • volume

        protected Integer volume
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">A floating-point number between 100 and -100 that configures the volume for audio playback (as a percentage).</p>

      • synchronous

        protected Boolean synchronous
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to true, the reader program must guarantee that the audio track will be plated in a completely synchronized manner without any interruptions and, accordingly, suppress any user interaction (except for cancelling the audio) while the audio is playing.</p>

      • repeat

        protected Boolean repeat
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to true, the audio track should be repeated endlessly.</p>

      • mix

        protected Boolean mix
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to true, it will be possible to play the audio track at the same time as other audio tracks. If it is set to false instead, any audio tracks that were already playing will be stopped previously.</p>

      • samplingRate

        protected Float samplingRate
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The Sample Rate in Samples per Second.</p>

      • soundChannels

        protected Integer soundChannels
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The number of audio channels.</p>

      • sampleSize

        protected Integer sampleSize
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The number of bits per sample per audio channel.</p>

      • encoding

        protected AudioEncodingType encoding
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The encoding of the audio file. Possible values are:
                                 <ul><li>Raw</li><li>Signed</li><li>muLaw</li><li>ALaw</li></ul></p>

    • Constructor Detail

      • SoundActionType

        public SoundActionType()

    • Method Detail

      • getSound

        public byte[] getSound()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The audio file that should be played. The file must be encoded as a BASE64 value. The passed file must be completely independent and contain all the information and data required to play it. The AIFF, AIFF-C, RIFF (*.wav), snd(*.au) audio formats are supported, for example.</p>
        Returns:
        possible object is byte[]

      • setSound

        public void setSound​(byte[] value)
        Sets the value of the sound property.
        Parameters:
        value - allowed object is byte[]
        See Also:
        getSound()

      • isSetSound

        public boolean isSetSound()

      • getVolume

        public int getVolume()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">A floating-point number between 100 and -100 that configures the volume for audio playback (as a percentage).</p>
        Returns:
        possible object is Integer

      • setVolume

        public void setVolume​(int value)
        Sets the value of the volume property.
        Parameters:
        value - allowed object is Integer
        See Also:
        getVolume()

      • isSetVolume

        public boolean isSetVolume()

      • unsetVolume

        public void unsetVolume()

      • isSynchronous

        public boolean isSynchronous()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to true, the reader program must guarantee that the audio track will be plated in a completely synchronized manner without any interruptions and, accordingly, suppress any user interaction (except for cancelling the audio) while the audio is playing.</p>
        Returns:
        possible object is Boolean

      • setSynchronous

        public void setSynchronous​(boolean value)
        Sets the value of the synchronous property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isSynchronous()

      • isSetSynchronous

        public boolean isSetSynchronous()

      • unsetSynchronous

        public void unsetSynchronous()

      • isRepeat

        public boolean isRepeat()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to true, the audio track should be repeated endlessly.</p>
        Returns:
        possible object is Boolean

      • setRepeat

        public void setRepeat​(boolean value)
        Sets the value of the repeat property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isRepeat()

      • isSetRepeat

        public boolean isSetRepeat()

      • unsetRepeat

        public void unsetRepeat()

      • isMix

        public boolean isMix()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to true, it will be possible to play the audio track at the same time as other audio tracks. If it is set to false instead, any audio tracks that were already playing will be stopped previously.</p>
        Returns:
        possible object is Boolean

      • setMix

        public void setMix​(boolean value)
        Sets the value of the mix property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isMix()

      • isSetMix

        public boolean isSetMix()

      • unsetMix

        public void unsetMix()

      • getSamplingRate

        public float getSamplingRate()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The Sample Rate in Samples per Second.</p>
        Returns:
        possible object is Float

      • setSamplingRate

        public void setSamplingRate​(float value)
        Sets the value of the samplingRate property.
        Parameters:
        value - allowed object is Float
        See Also:
        getSamplingRate()

      • isSetSamplingRate

        public boolean isSetSamplingRate()

      • unsetSamplingRate

        public void unsetSamplingRate()

      • getSoundChannels

        public int getSoundChannels()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The number of audio channels.</p>
        Returns:
        possible object is Integer

      • setSoundChannels

        public void setSoundChannels​(int value)
        Sets the value of the soundChannels property.
        Parameters:
        value - allowed object is Integer
        See Also:
        getSoundChannels()

      • isSetSoundChannels

        public boolean isSetSoundChannels()

      • unsetSoundChannels

        public void unsetSoundChannels()

      • getSampleSize

        public int getSampleSize()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The number of bits per sample per audio channel.</p>
        Returns:
        possible object is Integer

      • setSampleSize

        public void setSampleSize​(int value)
        Sets the value of the sampleSize property.
        Parameters:
        value - allowed object is Integer
        See Also:
        getSampleSize()

      • isSetSampleSize

        public boolean isSetSampleSize()

      • unsetSampleSize

        public void unsetSampleSize()

      • getEncoding

        public AudioEncodingType getEncoding()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The encoding of the audio file. Possible values are:
                                 <ul><li>Raw</li><li>Signed</li><li>muLaw</li><li>ALaw</li></ul></p>
        Returns:
        possible object is AudioEncodingType

      • isSetEncoding

        public boolean isSetEncoding()