Package com.pspdfkit.ui.audio

Interface AudioModeManager

  • All Implemented Interfaces:
    com.pspdfkit.ui.audio.AudioModeListeners 
    
public interface AudioModeManager
 implements AudioModeListeners

    Interface for objects managing audio modes.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      abstract void enterAudioPlaybackMode(@NonNull() SoundAnnotation annotation) Activates audio playback mode when the sound annotation contains valid sound data in supported format.
      abstract void enterAudioRecordingMode(@NonNull() SoundAnnotation annotation) Activates audio recording mode when the sound annotation can be recorded into.
      abstract boolean canPlay(@NonNull() SoundAnnotation annotation) Checks whether sound annotation audio data is supported for playback.
      abstract boolean canRecord(@NonNull() SoundAnnotation annotation) Checks whether sound annotation can be recorded into.
      abstract void exitActiveAudioMode() Leaves currently active audio mode (playback or recording).

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • enterAudioPlaybackMode

         abstract void enterAudioPlaybackMode(@NonNull() SoundAnnotation annotation)

        Activates audio playback mode when the sound annotation contains valid sound data in supported format. If recording mode is active, it is left first before entering audio playback mode.

        Parameters:
        annotation - Sound annotation to playback.

      • enterAudioRecordingMode

         abstract void enterAudioRecordingMode(@NonNull() SoundAnnotation annotation)

        Activates audio recording mode when the sound annotation can be recorded into. If playback mode is active, it is left first before entering audio recording mode.

        Parameters:
        annotation - Sound annotation to record into.

      • canPlay

         abstract boolean canPlay(@NonNull() SoundAnnotation annotation)

        Checks whether sound annotation audio data is supported for playback.

        Parameters:
        annotation - Sound annotation we wish to play.
        Returns:

        true if the annotation contains valid sound data in supported format.

      • canRecord

         abstract boolean canRecord(@NonNull() SoundAnnotation annotation)

        Checks whether sound annotation can be recorded into.

        Parameters:
        annotation - Sound annotation we wish to record into.
        Returns:

        true if the annotation does not have recording already.

      • exitActiveAudioMode

         abstract void exitActiveAudioMode()

        Leaves currently active audio mode (playback or recording).