org.j3d.aviatrix3d.pipeline.audio
Interface AudioRenderPipeline

All Superinterfaces:

RenderPipeline

All Known Implementing Classes:

DefaultAudioPipeline

public interface AudioRenderPipeline
extends RenderPipeline

A marker interface that represents a single complete audio rendering pipeline.

A pipeline represents all of the steps that may be accomplished within a rendering cycle - culling, sorting and drawing. While an end-user may wish to directly call the methods on this interface directly to control their own rendering, it is recommended that a dedicated pipeline manager be used for this task.

If the pipeline does not have a audio device registered, it will still complete all the steps up to that point. If no scene is registered, no functionality is performed - render() will return immediately.

Version:

$Revision: 2.0 $

Author:

Alan Hudson

Method Summary

AudioOutputDevice	getAudioOutputDevice() Get the currently registered audio device instance.
void	setAudioOutputDevice(AudioOutputDevice device) Register an audio output device that this pipeline will send its output to.

Methods inherited from interface org.j3d.aviatrix3d.pipeline.RenderPipeline

displayOnly, halt, render, setErrorReporter, setRenderableLayers, setRequestData

Method Detail

setAudioOutputDevice

void setAudioOutputDevice(AudioOutputDevice device)

Register an audio output device that this pipeline will send its output to. Setting a null value will remove the current device.

Parameters:

device - The device instance to use or replace

getAudioOutputDevice

AudioOutputDevice getAudioOutputDevice()

Get the currently registered audio device instance. If none is set, return null.

Returns:

The currently set device instance or null