Package Acquisition.pamAudio
Interface PamAudioFileLoader
- All Known Implementing Classes:
FlacAudioFile
,SudAudioFile
,WavAudioFile
public interface PamAudioFileLoader
Interface for PAMGuard opening a sound file.
- Author:
- Jamie Macaulay
-
Method Summary
Modifier and TypeMethodDescriptiongetAudioStream
(File soundFile) Get the audio stream for the fileGet file extensions associated with the file typegetName()
Get the name of the file.Get a settings pane for the audio loaderboolean
loadAudioData
(OfflineFileServer offlineFileServer, PamDataBlock dataBlock, OfflineDataLoadInfo offlineDataLoadInfo, ViewLoadObserver loadObserver) Load a section of audio data.
-
Method Details
-
getFileExtensions
Get file extensions associated with the file type- Returns:
- a list of the file extensions (e.g.".wav")
-
getName
String getName()Get the name of the file.- Returns:
- the name of the file
-
getAudioStream
Get the audio stream for the file- Returns:
- the audio input stream.
-
loadAudioData
boolean loadAudioData(OfflineFileServer offlineFileServer, PamDataBlock dataBlock, OfflineDataLoadInfo offlineDataLoadInfo, ViewLoadObserver loadObserver) Load a section of audio data.- Parameters:
offlineFileServer
- - the offline file server.dataBlock
- - the data block.offlineDataLoadInfo
- - the offline data load info.- Returns:
- true if the file has been loaded
-
getSettingsPane
PamAudioSettingsPane getSettingsPane()Get a settings pane for the audio loader- Returns:
- settings pane for audio loader - can be null.
-