Added javadoc to the audio/video binding classes

This commit is contained in:
Diego Waxemberg
2013-12-29 11:53:16 -05:00
parent 8e3390a7d5
commit c0632f6999
3 changed files with 63 additions and 0 deletions

View File

@@ -8,11 +8,24 @@ import com.limelight.binding.video.SwingCpuDecoderRenderer;
import com.limelight.nvstream.av.audio.AudioRenderer;
import com.limelight.nvstream.av.video.VideoDecoderRenderer;
/**
* Used for platform-specific video/audio bindings.
* @author Cameron Gutman
*/
public class PlatformBinding {
/**
* Gets an instance of a video decoder/renderer.
* @return a video decoder and renderer
*/
public static VideoDecoderRenderer getVideoDecoderRenderer() {
return new SwingCpuDecoderRenderer();
}
/**
* Gets the name of this device.
* <br>Currently, the hostname of the system.
* @return the name of this device
*/
public static String getDeviceName() {
try {
return InetAddress.getLocalHost().getHostName();
@@ -21,6 +34,10 @@ public class PlatformBinding {
}
}
/**
* Gets an instance of an audio decoder/renderer.
* @return an audio decoder and renderer
*/
public static AudioRenderer getAudioRenderer() {
return new JavaxAudioRenderer();
}