Crossfire JXClient, Trunk
Public Member Functions | Private Attributes | List of all members
com.realtime.crossfire.jxclient.sound.AudioFileLoader Class Reference
Collaboration diagram for com.realtime.crossfire.jxclient.sound.AudioFileLoader:
Collaboration graph

Public Member Functions

 AudioFileLoader (@Nullable final DebugWriter debugSound)
 
InputStream getInputStream (@NotNull final CharSequence name) throws IOException
 

Private Attributes

final DebugWriter debugSound
 

Detailed Description

Locates audio files.

Author
Andreas Kirschbaum

Definition at line 41 of file AudioFileLoader.java.

Constructor & Destructor Documentation

◆ AudioFileLoader()

com.realtime.crossfire.jxclient.sound.AudioFileLoader.AudioFileLoader ( @Nullable final DebugWriter  debugSound)

Private constructor to prevent instantiation.

Parameters
debugSoundthe writer for logging sound related information or
null
to not log

Definition at line 55 of file AudioFileLoader.java.

References com.realtime.crossfire.jxclient.sound.AudioFileLoader.debugSound.

Member Function Documentation

◆ getInputStream()

InputStream com.realtime.crossfire.jxclient.sound.AudioFileLoader.getInputStream ( @NotNull final CharSequence  name) throws IOException

Returns an input stream for an audio file.

action

identifies the audio file.

name

is an optional prefix.

Parameters
namethe name
Returns
the input stream
Exceptions
IOExceptionif the file cannot be located

Definition at line 67 of file AudioFileLoader.java.

References com.realtime.crossfire.jxclient.util.DebugWriter.debugProtocolWrite(), com.realtime.crossfire.jxclient.sound.AudioFileLoader.debugSound, and com.realtime.crossfire.jxclient.settings.Filenames.getSettingsFile().

Referenced by com.realtime.crossfire.jxclient.sound.ClipLoader.allocateClip(), and com.realtime.crossfire.jxclient.sound.Processor.openAudioInputStream().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ debugSound

final DebugWriter com.realtime.crossfire.jxclient.sound.AudioFileLoader.debugSound
private

The writer for logging sound related information or

null

to not log.

Definition at line 48 of file AudioFileLoader.java.

Referenced by com.realtime.crossfire.jxclient.sound.AudioFileLoader.AudioFileLoader(), and com.realtime.crossfire.jxclient.sound.AudioFileLoader.getInputStream().


The documentation for this class was generated from the following file: