Package net.webpdf.wsclient.openapi

Class OperationSoundActionPlaySound

  • public class OperationSoundActionPlaySound
extends Object
    When activated, the playSound Element plays the specified audio data.

    • Constructor Detail

      • OperationSoundActionPlaySound

        public OperationSoundActionPlaySound()

    • Method Detail

      • getMix

        @Nullable
public @Nullable Boolean getMix()
        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.
        Returns:
        mix

      • setMix

        public void setMix​(Boolean mix)

      • getRepeat

        @Nullable
public @Nullable Boolean getRepeat()
        If this value is set to true, the audio track should be repeated endlessly.
        Returns:
        repeat

      • setRepeat

        public void setRepeat​(Boolean repeat)

      • getSampleSize

        @Nullable
public @Nullable Integer getSampleSize()
        The number of bits per sample per audio channel. minimum: 1
        Returns:
        sampleSize

      • setSampleSize

        public void setSampleSize​(Integer sampleSize)

      • getSamplingRate

        @Nullable
public @Nullable Float getSamplingRate()
        The Sample Rate in Samples per Second. minimum: 1
        Returns:
        samplingRate

      • setSamplingRate

        public void setSamplingRate​(Float samplingRate)

      • getSound

        @NotNull
public @NotNull List<byte[]> getSound()
        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.
        Returns:
        sound

      • setSound

        public void setSound​(List<byte[]> sound)

      • getSoundChannels

        @Nullable
public @Nullable Integer getSoundChannels()
        The number of audio channels. minimum: 1
        Returns:
        soundChannels

      • setSoundChannels

        public void setSoundChannels​(Integer soundChannels)

      • getSynchronous

        @Nullable
public @Nullable Boolean getSynchronous()
        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.
        Returns:
        synchronous

      • setSynchronous

        public void setSynchronous​(Boolean synchronous)

      • getVolume

        @Nullable
public @Nullable Integer getVolume()
        A floating-point number between 100 and -100 that configures the volume for audio playback (as a percentage). minimum: -100 maximum: 100
        Returns:
        volume

      • setVolume

        public void setVolume​(Integer volume)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object