com.realtime.crossfire.jxclient.sound.ClipLoader Class Reference

Collaboration diagram for com.realtime.crossfire.jxclient.sound.ClipLoader:

Public Member Functions
DataLine	allocateClip (@NotNull final CharSequence action)
	ClipLoader (@NotNull final AudioFileLoader audioFileLoader, @Nullable final DebugWriter debugSound)
void	freeClip (@NotNull final Line clip)

Private Attributes
final AudioFileLoader	audioFileLoader
final DebugWriter	debugSound

Detailed Description

Allocates new sound clips.

Author

Andreas Kirschbaum

Definition at line 43 of file ClipLoader.java.

Constructor & Destructor Documentation

ClipLoader()

com.realtime.crossfire.jxclient.sound.ClipLoader.ClipLoader	(	@NotNull final AudioFileLoader	audioFileLoader,
		@Nullable final DebugWriter	debugSound
	)

Creates a new instance.

Parameters

audioFileLoader	the audio file loader for loading audio files
debugSound	the writer for logging sound related information or null to not log

Definition at line 64 of file ClipLoader.java.

References com.realtime.crossfire.jxclient.sound.ClipLoader.audioFileLoader, and com.realtime.crossfire.jxclient.sound.ClipLoader.debugSound.

Member Function Documentation

allocateClip()

DataLine com.realtime.crossfire.jxclient.sound.ClipLoader.allocateClip

(

@NotNull final CharSequence

action

)

Allocates a new clip.

Parameters

action

the action name of the clip to allocate

Returns

the new clip, or

null 

if an error occurs

Definition at line 86 of file ClipLoader.java.

References com.realtime.crossfire.jxclient.sound.ClipLoader.audioFileLoader, com.realtime.crossfire.jxclient.util.DebugWriter.debugProtocolWrite(), com.realtime.crossfire.jxclient.sound.ClipLoader.debugSound, and com.realtime.crossfire.jxclient.sound.AudioFileLoader.getInputStream().

Referenced by com.realtime.crossfire.jxclient.sound.ClipManager.ClipLoadTask.getCallable().

Here is the call graph for this function:

Here is the caller graph for this function:

freeClip()

void com.realtime.crossfire.jxclient.sound.ClipLoader.freeClip

(

@NotNull final Line

clip

)

Deallocates a clip.

Parameters

clip	the clip to deallocate

Definition at line 73 of file ClipLoader.java.

References com.realtime.crossfire.jxclient.util.DebugWriter.debugProtocolWrite(), and com.realtime.crossfire.jxclient.sound.ClipLoader.debugSound.

Referenced by com.realtime.crossfire.jxclient.sound.ClipManager.ClipFreeTask.getCallable().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

audioFileLoader

final AudioFileLoader com.realtime.crossfire.jxclient.sound.ClipLoader.audioFileLoader

private

The AudioFileLoader for loading audio files.

Definition at line 49 of file ClipLoader.java.

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

debugSound

final DebugWriter com.realtime.crossfire.jxclient.sound.ClipLoader.debugSound

private

The writer for logging sound related information or

null 

to not log.

Definition at line 56 of file ClipLoader.java.

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

---

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

• src/gui/src/main/java/com/realtime/crossfire/jxclient/sound/ClipLoader.java