de.clab.osami.conferencing.vlc.conferencingSystem
Class ConferencingSystem

java.lang.Object
  extended by de.clab.osami.conferencing.vlc.conferencingSystem.ConferencingSystem
All Implemented Interfaces:
IVideoConference, VcConfig, VcControl

public class ConferencingSystem
extends java.lang.Object
implements VcControl, VcConfig, IVideoConference


Constructor Summary
ConferencingSystem(IProcessor processor)
           
 
Method Summary
 int getAudioBitrate()
          Gets the audio bitrate.
 int getAudioChannels()
          Gets the audio channels.
 java.lang.String[] getAudioInputDevices()
          Gets the audio input devices.
 int getAudioSampleRate()
          Gets the audio sample rate.
 int getCaptureCaching()
          Gets the capture caching.
 IConfiguration getCofiguration()
           
 java.awt.Panel getConfigurationPanel()
          Gets the configuration panel.
 java.lang.String getCurrentAudioCodec()
          Gets the current audio codec.
 java.lang.String getCurrentAudioInputDevice()
          Gets the current audio input device.
 java.lang.String getCurrentVideoCodec()
          Gets the current video codec.
 java.lang.String getCurrentVideoInputDevice()
          Gets the current video input device.
 java.lang.String getIp()
          Gets the IP of the VC.
 int getLocalPort()
          Gets the local port.
 int getReceiveCaching()
          Gets the receive caching.
 java.lang.String getStreamingLocalIp()
           
 java.lang.String[] getSupportedAudioCodecs()
          Gets the supported audio codecs.
 java.lang.String[] getSupportedVideoCodecs()
          Gets the supported video codecs.
 int getTargetPort()
          Gets the target port.
 int getVideoBitrate()
          Gets the video bitrate.
 int getVideoFrameRate()
          Gets the video frame rate.
 java.lang.String[] getVideoInputDevices()
          Gets the video input devices.
 java.lang.Object getVideoLocalComponent()
          Gets the video local component.
 java.lang.Object getVideoRemoteComponent()
          Gets the video remote component.
 float getVideoScale()
          Gets the video scale.
 java.awt.Dimension getVideoSize()
          Gets the video size.
 boolean isAudioEnabled()
          Checks if audio is enabled.
 boolean isVideoEnabled()
          Checks if video is enabled.
 java.lang.String loadConfiguration(java.lang.String location)
          Load configuration.
 java.lang.String reconfigure()
          Reconfigure the VC.
 java.lang.String saveConfiguration(java.lang.String location)
          Save configuration.
 java.lang.String setAudioBitRate(int bitrate)
          Sets the audio bit rate.
 java.lang.String setAudioChannels(byte channels)
          Sets the audio channels.
 java.lang.String setAudioCodec(java.lang.String codec)
          Sets the audio codec.
 java.lang.String setAudioEnabled(boolean flag)
          Enables or disables the audio.
 java.lang.String setAudioInputDevice(java.lang.String device)
          Sets the audio input device.
 java.lang.String setAudioSampleRate(int sampleRate)
          Sets the audio sample rate.
 java.lang.String setCaptureCaching(int ms)
          Sets the capture caching.
 java.lang.String setIp(java.lang.String ipv4)
          Sets the IP of the VC.
 java.lang.String setLocalPort(int port)
          Sets the local port.
 java.lang.String setLoggingEnabled(boolean flag)
          Enables or disables the logging.
 java.lang.String setReceiveCaching(int ms)
          Sets the receive caching.
 void setStreamingLocalIp(java.lang.String localIp)
           
 java.lang.String setTargetPort(int port)
          Sets the target port.
 java.lang.String setVideoBitRate(int bitrate)
          Sets the video bit rate.
 java.lang.String setVideoCodec(java.lang.String codec)
          Sets the video codec.
 java.lang.String setVideoEnabled(boolean flag)
          Enables or disables the video enabled.
 java.lang.String setVideoFrameRate(int framerate)
          Sets the video frame rate.
 java.lang.String setVideoInputDevice(java.lang.String device)
          Sets the video input device.
 java.lang.String setVideoLocalComponent(java.lang.Object p)
          Sets the video local component.
 void setVideoLocalEnabled(java.lang.Boolean flag)
          Enables or disables the local video component
 java.lang.String setVideoRemoteComponent(java.lang.Object p)
          Sets the video remote component.
 void setVideoRemoteEnabled(java.lang.Boolean flag)
          Enables or disables the remote video component
 java.lang.String setVideoScale(float scale)
          Sets the video scale.
 java.lang.String setVideoSize(java.awt.Dimension size)
          Sets the video size.
 java.lang.String start()
          Start the VC.
 java.lang.String start(java.lang.String ip)
          Start the VC.
 java.lang.String stop()
          Stop the VC.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ConferencingSystem

public ConferencingSystem(IProcessor processor)
Method Detail

reconfigure

public java.lang.String reconfigure()
Description copied from interface: VcConfig
Reconfigure the VC.

Specified by:
reconfigure in interface IVideoConference
Specified by:
reconfigure in interface VcConfig
Returns:
null on success or a string containing an error message on failure

loadConfiguration

public java.lang.String loadConfiguration(java.lang.String location)
Description copied from interface: VcConfig
Load configuration.

Specified by:
loadConfiguration in interface IVideoConference
Specified by:
loadConfiguration in interface VcConfig
Parameters:
location - the location
Returns:
null on success or a string containing an error message on failure

saveConfiguration

public java.lang.String saveConfiguration(java.lang.String location)
Description copied from interface: VcConfig
Save configuration.

Specified by:
saveConfiguration in interface IVideoConference
Specified by:
saveConfiguration in interface VcConfig
Parameters:
location - the location
Returns:
null on success or a string containing an error message on failure

start

public java.lang.String start()
Description copied from interface: VcControl
Start the VC.

Specified by:
start in interface IVideoConference
Specified by:
start in interface VcControl
Returns:
null on success or a string containing an error message on failure

start

public java.lang.String start(java.lang.String ip)
Description copied from interface: VcControl
Start the VC.

Specified by:
start in interface IVideoConference
Specified by:
start in interface VcControl
Parameters:
ip - the IPv4 address the VC will connect to
Returns:
null on success or a string containing an error message on failure

stop

public java.lang.String stop()
Description copied from interface: VcControl
Stop the VC.

Specified by:
stop in interface IVideoConference
Specified by:
stop in interface VcControl
Returns:
null on success or a string containing an error message on failure

getCofiguration

public IConfiguration getCofiguration()

getAudioBitrate

public int getAudioBitrate()
Description copied from interface: VcConfig
Gets the audio bitrate.

Specified by:
getAudioBitrate in interface IVideoConference
Specified by:
getAudioBitrate in interface VcConfig
Returns:
the audio bitrate

getAudioChannels

public int getAudioChannels()
Description copied from interface: VcConfig
Gets the audio channels.

Specified by:
getAudioChannels in interface IVideoConference
Specified by:
getAudioChannels in interface VcConfig
Returns:
the audio channels

getAudioInputDevices

public java.lang.String[] getAudioInputDevices()
Description copied from interface: VcConfig
Gets the audio input devices.

Specified by:
getAudioInputDevices in interface IVideoConference
Specified by:
getAudioInputDevices in interface VcConfig
Returns:
the audio input devices

getAudioSampleRate

public int getAudioSampleRate()
Description copied from interface: VcConfig
Gets the audio sample rate.

Specified by:
getAudioSampleRate in interface IVideoConference
Specified by:
getAudioSampleRate in interface VcConfig
Returns:
the audio sample rate

getCaptureCaching

public int getCaptureCaching()
Description copied from interface: VcConfig
Gets the capture caching.

Specified by:
getCaptureCaching in interface IVideoConference
Specified by:
getCaptureCaching in interface VcConfig
Returns:
the capture caching

getConfigurationPanel

public java.awt.Panel getConfigurationPanel()
Description copied from interface: VcConfig
Gets the configuration panel.

Specified by:
getConfigurationPanel in interface IVideoConference
Specified by:
getConfigurationPanel in interface VcConfig
Returns:
the configuration panel

getCurrentAudioCodec

public java.lang.String getCurrentAudioCodec()
Description copied from interface: VcConfig
Gets the current audio codec.

Specified by:
getCurrentAudioCodec in interface IVideoConference
Specified by:
getCurrentAudioCodec in interface VcConfig
Returns:
the current audio codec

getCurrentAudioInputDevice

public java.lang.String getCurrentAudioInputDevice()
Description copied from interface: VcConfig
Gets the current audio input device.

Specified by:
getCurrentAudioInputDevice in interface IVideoConference
Specified by:
getCurrentAudioInputDevice in interface VcConfig
Returns:
the current audio input device

getCurrentVideoCodec

public java.lang.String getCurrentVideoCodec()
Description copied from interface: VcConfig
Gets the current video codec.

Specified by:
getCurrentVideoCodec in interface IVideoConference
Specified by:
getCurrentVideoCodec in interface VcConfig
Returns:
the current video codec

getCurrentVideoInputDevice

public java.lang.String getCurrentVideoInputDevice()
Description copied from interface: VcConfig
Gets the current video input device.

Specified by:
getCurrentVideoInputDevice in interface IVideoConference
Specified by:
getCurrentVideoInputDevice in interface VcConfig
Returns:
the current video input device

getIp

public java.lang.String getIp()
Description copied from interface: VcConfig
Gets the IP of the VC.

Specified by:
getIp in interface IVideoConference
Specified by:
getIp in interface VcConfig
Returns:
the IP of the VC

getLocalPort

public int getLocalPort()
Description copied from interface: VcConfig
Gets the local port.

Specified by:
getLocalPort in interface IVideoConference
Specified by:
getLocalPort in interface VcConfig
Returns:
the local port

getReceiveCaching

public int getReceiveCaching()
Description copied from interface: VcConfig
Gets the receive caching.

Specified by:
getReceiveCaching in interface IVideoConference
Specified by:
getReceiveCaching in interface VcConfig
Returns:
the receive caching

getSupportedAudioCodecs

public java.lang.String[] getSupportedAudioCodecs()
Description copied from interface: VcConfig
Gets the supported audio codecs.

Specified by:
getSupportedAudioCodecs in interface IVideoConference
Specified by:
getSupportedAudioCodecs in interface VcConfig
Returns:
the supported audio codecs

getSupportedVideoCodecs

public java.lang.String[] getSupportedVideoCodecs()
Description copied from interface: VcConfig
Gets the supported video codecs.

Specified by:
getSupportedVideoCodecs in interface IVideoConference
Specified by:
getSupportedVideoCodecs in interface VcConfig
Returns:
the supported video codecs

getTargetPort

public int getTargetPort()
Description copied from interface: VcConfig
Gets the target port.

Specified by:
getTargetPort in interface IVideoConference
Specified by:
getTargetPort in interface VcConfig
Returns:
null on success or a string containing an error message on failure

getVideoBitrate

public int getVideoBitrate()
Description copied from interface: VcConfig
Gets the video bitrate.

Specified by:
getVideoBitrate in interface IVideoConference
Specified by:
getVideoBitrate in interface VcConfig
Returns:
the video bitrate

getVideoFrameRate

public int getVideoFrameRate()
Description copied from interface: VcConfig
Gets the video frame rate.

Specified by:
getVideoFrameRate in interface IVideoConference
Specified by:
getVideoFrameRate in interface VcConfig
Returns:
the video frame rate

getVideoInputDevices

public java.lang.String[] getVideoInputDevices()
Description copied from interface: VcConfig
Gets the video input devices.

Specified by:
getVideoInputDevices in interface IVideoConference
Specified by:
getVideoInputDevices in interface VcConfig
Returns:
the video input devices

getVideoLocalComponent

public java.lang.Object getVideoLocalComponent()
Description copied from interface: VcConfig
Gets the video local component.

Specified by:
getVideoLocalComponent in interface IVideoConference
Specified by:
getVideoLocalComponent in interface VcConfig
Returns:
the video local component

getVideoRemoteComponent

public java.lang.Object getVideoRemoteComponent()
Description copied from interface: VcConfig
Gets the video remote component.

Specified by:
getVideoRemoteComponent in interface IVideoConference
Specified by:
getVideoRemoteComponent in interface VcConfig
Returns:
the video remote component

getVideoScale

public float getVideoScale()
Description copied from interface: VcConfig
Gets the video scale.

Specified by:
getVideoScale in interface IVideoConference
Specified by:
getVideoScale in interface VcConfig
Returns:
the video scale

getVideoSize

public java.awt.Dimension getVideoSize()
Description copied from interface: VcConfig
Gets the video size.

Specified by:
getVideoSize in interface IVideoConference
Specified by:
getVideoSize in interface VcConfig
Returns:
the video size

isAudioEnabled

public boolean isAudioEnabled()
Description copied from interface: VcConfig
Checks if audio is enabled.

Specified by:
isAudioEnabled in interface IVideoConference
Specified by:
isAudioEnabled in interface VcConfig
Returns:
true, if audio is enabled

setAudioBitRate

public java.lang.String setAudioBitRate(int bitrate)
Description copied from interface: VcConfig
Sets the audio bit rate.

Specified by:
setAudioBitRate in interface IVideoConference
Specified by:
setAudioBitRate in interface VcConfig
Parameters:
bitrate - the audio bitrate
Returns:
null on success or a string containing an error message on failure

setAudioChannels

public java.lang.String setAudioChannels(byte channels)
Description copied from interface: VcConfig
Sets the audio channels.

Specified by:
setAudioChannels in interface IVideoConference
Specified by:
setAudioChannels in interface VcConfig
Parameters:
channels - the channels
Returns:
null on success or a string containing an error message on failure

setAudioCodec

public java.lang.String setAudioCodec(java.lang.String codec)
Description copied from interface: VcConfig
Sets the audio codec.

Specified by:
setAudioCodec in interface IVideoConference
Specified by:
setAudioCodec in interface VcConfig
Parameters:
codec - the codec
Returns:
null on success or a string containing an error message on failure

setAudioEnabled

public java.lang.String setAudioEnabled(boolean flag)
Description copied from interface: VcConfig
Enables or disables the audio.

Specified by:
setAudioEnabled in interface IVideoConference
Specified by:
setAudioEnabled in interface VcConfig
Parameters:
flag - the flag
Returns:
null on success or a string containing an error message on failure

setAudioInputDevice

public java.lang.String setAudioInputDevice(java.lang.String device)
Description copied from interface: VcConfig
Sets the audio input device.

Specified by:
setAudioInputDevice in interface IVideoConference
Specified by:
setAudioInputDevice in interface VcConfig
Parameters:
device - the device
Returns:
null on success or a string containing an error message on failure

setAudioSampleRate

public java.lang.String setAudioSampleRate(int sampleRate)
Description copied from interface: VcConfig
Sets the audio sample rate.

Specified by:
setAudioSampleRate in interface IVideoConference
Specified by:
setAudioSampleRate in interface VcConfig
Parameters:
sampleRate - the sample rate
Returns:
null on success or a string containing an error message on failure

setCaptureCaching

public java.lang.String setCaptureCaching(int ms)
Description copied from interface: VcConfig
Sets the capture caching.

Specified by:
setCaptureCaching in interface IVideoConference
Specified by:
setCaptureCaching in interface VcConfig
Parameters:
ms - the time in milliseconds
Returns:
null on success or a string containing an error message on failure

setIp

public java.lang.String setIp(java.lang.String ipv4)
Description copied from interface: VcConfig
Sets the IP of the VC.

Specified by:
setIp in interface IVideoConference
Specified by:
setIp in interface VcConfig
Parameters:
ipv4 - the ipv4
Returns:
the string

setLocalPort

public java.lang.String setLocalPort(int port)
Description copied from interface: VcConfig
Sets the local port.

Specified by:
setLocalPort in interface IVideoConference
Specified by:
setLocalPort in interface VcConfig
Parameters:
port - the port
Returns:
null on success or a string containing an error message on failure

setLoggingEnabled

public java.lang.String setLoggingEnabled(boolean flag)
Description copied from interface: VcConfig
Enables or disables the logging.

Specified by:
setLoggingEnabled in interface IVideoConference
Specified by:
setLoggingEnabled in interface VcConfig
Parameters:
flag - the flag that determines whether logging should be enabled or disabled
Returns:
null on success or a string containing an error message on failure

setReceiveCaching

public java.lang.String setReceiveCaching(int ms)
Description copied from interface: VcConfig
Sets the receive caching.

Specified by:
setReceiveCaching in interface IVideoConference
Specified by:
setReceiveCaching in interface VcConfig
Parameters:
ms - the time in milliseconds
Returns:
null on success or a string containing an error message on failure

setTargetPort

public java.lang.String setTargetPort(int port)
Description copied from interface: VcConfig
Sets the target port.

Specified by:
setTargetPort in interface IVideoConference
Specified by:
setTargetPort in interface VcConfig
Parameters:
port - the port
Returns:
null on success or a string containing an error message on failure

setVideoBitRate

public java.lang.String setVideoBitRate(int bitrate)
Description copied from interface: VcConfig
Sets the video bit rate.

Specified by:
setVideoBitRate in interface IVideoConference
Specified by:
setVideoBitRate in interface VcConfig
Parameters:
bitrate - the video bitrate
Returns:
null on success or a string containing an error message on failure

setVideoCodec

public java.lang.String setVideoCodec(java.lang.String codec)
Description copied from interface: VcConfig
Sets the video codec.

Specified by:
setVideoCodec in interface IVideoConference
Specified by:
setVideoCodec in interface VcConfig
Parameters:
codec - the codec
Returns:
null on success or a string containing an error message on failure

setVideoEnabled

public java.lang.String setVideoEnabled(boolean flag)
Description copied from interface: VcConfig
Enables or disables the video enabled.

Specified by:
setVideoEnabled in interface IVideoConference
Specified by:
setVideoEnabled in interface VcConfig
Parameters:
flag - the flag
Returns:
null on success or a string containing an error message on failure

setVideoFrameRate

public java.lang.String setVideoFrameRate(int framerate)
Description copied from interface: VcConfig
Sets the video frame rate.

Specified by:
setVideoFrameRate in interface IVideoConference
Specified by:
setVideoFrameRate in interface VcConfig
Parameters:
framerate - the video framerate
Returns:
null on success or a string containing an error message on failure

setVideoInputDevice

public java.lang.String setVideoInputDevice(java.lang.String device)
Description copied from interface: VcConfig
Sets the video input device.

Specified by:
setVideoInputDevice in interface IVideoConference
Specified by:
setVideoInputDevice in interface VcConfig
Parameters:
device - the device
Returns:
null on success or a string containing an error message on failure

setVideoLocalComponent

public java.lang.String setVideoLocalComponent(java.lang.Object p)
Description copied from interface: VcConfig
Sets the video local component.

Specified by:
setVideoLocalComponent in interface IVideoConference
Specified by:
setVideoLocalComponent in interface VcConfig
Parameters:
p - the surface
Returns:
null on success or a string containing an error message on failure

setVideoRemoteComponent

public java.lang.String setVideoRemoteComponent(java.lang.Object p)
Description copied from interface: VcConfig
Sets the video remote component.

Specified by:
setVideoRemoteComponent in interface IVideoConference
Specified by:
setVideoRemoteComponent in interface VcConfig
Parameters:
p - the surface
Returns:
null on success or a string containing an error message on failure

setVideoScale

public java.lang.String setVideoScale(float scale)
Description copied from interface: VcConfig
Sets the video scale.

Specified by:
setVideoScale in interface IVideoConference
Specified by:
setVideoScale in interface VcConfig
Parameters:
scale - the video scale
Returns:
null on success or a string containing an error message on failure

setVideoSize

public java.lang.String setVideoSize(java.awt.Dimension size)
Description copied from interface: VcConfig
Sets the video size.

Specified by:
setVideoSize in interface IVideoConference
Specified by:
setVideoSize in interface VcConfig
Parameters:
size - the video size
Returns:
null on success or a string containing an error message on failure

isVideoEnabled

public boolean isVideoEnabled()
Description copied from interface: VcConfig
Checks if video is enabled.

Specified by:
isVideoEnabled in interface IVideoConference
Specified by:
isVideoEnabled in interface VcConfig
Returns:
true, if video is enabled

getStreamingLocalIp

public java.lang.String getStreamingLocalIp()
Specified by:
getStreamingLocalIp in interface IVideoConference
Returns:
See Also:
IConfiguration.getLocalIp()

setStreamingLocalIp

public void setStreamingLocalIp(java.lang.String localIp)
Specified by:
setStreamingLocalIp in interface IVideoConference
Parameters:
localIp -
See Also:
IConfiguration.setLocalIp(java.lang.String)

setVideoLocalEnabled

public void setVideoLocalEnabled(java.lang.Boolean flag)
Description copied from interface: IVideoConference
Enables or disables the local video component

Specified by:
setVideoLocalEnabled in interface IVideoConference

setVideoRemoteEnabled

public void setVideoRemoteEnabled(java.lang.Boolean flag)
Description copied from interface: IVideoConference
Enables or disables the remote video component

Specified by:
setVideoRemoteEnabled in interface IVideoConference