de.clab.osami.conferencing.vlc.ServiceInterfaces
Interface IVideoConference

All Known Implementing Classes:
ConferencingSystem

public interface IVideoConference

The interface IVideoConference

Author:
Christian Thanos

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.
 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 surface)
          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 surface)
          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 ipv4)
          Start the VC.
 java.lang.String stop()
          Stop the VC.
 

Method Detail

start

java.lang.String start(java.lang.String ipv4)
Start the VC.

Parameters:
ipv4 - the IPv4 address the VC will connect to
Returns:
null on success or a string containing an error message on failure

start

java.lang.String start()
Start the VC.

Returns:
null on success or a string containing an error message on failure

stop

java.lang.String stop()
Stop the VC.

Returns:
null on success or a string containing an error message on failure

getIp

java.lang.String getIp()
Gets the IP of the VC.

Returns:
the IP of the VC

setIp

java.lang.String setIp(java.lang.String ipv4)
Sets the IP of the VC.

Parameters:
ipv4 - the ipv4
Returns:
the string

getTargetPort

int getTargetPort()
Gets the target port.

Returns:
null on success or a string containing an error message on failure

setTargetPort

java.lang.String setTargetPort(int port)
Sets the target port.

Parameters:
port - the port
Returns:
null on success or a string containing an error message on failure

getLocalPort

int getLocalPort()
Gets the local port.

Returns:
the local port

setLocalPort

java.lang.String setLocalPort(int port)
Sets the local port.

Parameters:
port - the port
Returns:
null on success or a string containing an error message on failure

getCaptureCaching

int getCaptureCaching()
Gets the capture caching.

Returns:
the capture caching

setCaptureCaching

java.lang.String setCaptureCaching(int ms)
Sets the capture caching.

Parameters:
ms - the time in milliseconds
Returns:
null on success or a string containing an error message on failure

getReceiveCaching

int getReceiveCaching()
Gets the receive caching.

Returns:
the receive caching

setReceiveCaching

java.lang.String setReceiveCaching(int ms)
Sets the receive caching.

Parameters:
ms - the time in milliseconds
Returns:
null on success or a string containing an error message on failure

getVideoInputDevices

java.lang.String[] getVideoInputDevices()
Gets the video input devices.

Returns:
the video input devices

getCurrentVideoInputDevice

java.lang.String getCurrentVideoInputDevice()
Gets the current video input device.

Returns:
the current video input device

setVideoInputDevice

java.lang.String setVideoInputDevice(java.lang.String device)
Sets the video input device.

Parameters:
device - the device
Returns:
null on success or a string containing an error message on failure

getAudioInputDevices

java.lang.String[] getAudioInputDevices()
Gets the audio input devices.

Returns:
the audio input devices

getCurrentAudioInputDevice

java.lang.String getCurrentAudioInputDevice()
Gets the current audio input device.

Returns:
the current audio input device

setAudioInputDevice

java.lang.String setAudioInputDevice(java.lang.String device)
Sets the audio input device.

Parameters:
device - the device
Returns:
null on success or a string containing an error message on failure

setVideoEnabled

java.lang.String setVideoEnabled(boolean flag)
Enables or disables the video enabled.

Parameters:
flag - the flag
Returns:
null on success or a string containing an error message on failure

isVideoEnabled

boolean isVideoEnabled()
Checks if video is enabled.

Returns:
true, if video is enabled

setAudioEnabled

java.lang.String setAudioEnabled(boolean flag)
Enables or disables the audio.

Parameters:
flag - the flag
Returns:
null on success or a string containing an error message on failure

isAudioEnabled

boolean isAudioEnabled()
Checks if audio is enabled.

Returns:
true, if audio is enabled

setVideoCodec

java.lang.String setVideoCodec(java.lang.String codec)
Sets the video codec.

Parameters:
codec - the codec
Returns:
null on success or a string containing an error message on failure

getCurrentVideoCodec

java.lang.String getCurrentVideoCodec()
Gets the current video codec.

Returns:
the current video codec

getSupportedVideoCodecs

java.lang.String[] getSupportedVideoCodecs()
Gets the supported video codecs.

Returns:
the supported video codecs

setAudioCodec

java.lang.String setAudioCodec(java.lang.String codec)
Sets the audio codec.

Parameters:
codec - the codec
Returns:
null on success or a string containing an error message on failure

getCurrentAudioCodec

java.lang.String getCurrentAudioCodec()
Gets the current audio codec.

Returns:
the current audio codec

getSupportedAudioCodecs

java.lang.String[] getSupportedAudioCodecs()
Gets the supported audio codecs.

Returns:
the supported audio codecs

setVideoBitRate

java.lang.String setVideoBitRate(int bitrate)
Sets the video bit rate.

Parameters:
bitrate - the video bitrate
Returns:
null on success or a string containing an error message on failure

getVideoBitrate

int getVideoBitrate()
Gets the video bitrate.

Returns:
the video bitrate

setAudioBitRate

java.lang.String setAudioBitRate(int bitrate)
Sets the audio bit rate.

Parameters:
bitrate - the audio bitrate
Returns:
null on success or a string containing an error message on failure

getAudioBitrate

int getAudioBitrate()
Gets the audio bitrate.

Returns:
the audio bitrate

setVideoFrameRate

java.lang.String setVideoFrameRate(int framerate)
Sets the video frame rate.

Parameters:
framerate - the video framerate
Returns:
null on success or a string containing an error message on failure

getVideoFrameRate

int getVideoFrameRate()
Gets the video frame rate.

Returns:
the video frame rate

setVideoSize

java.lang.String setVideoSize(java.awt.Dimension size)
Sets the video size.

Parameters:
size - the video size
Returns:
null on success or a string containing an error message on failure

getVideoSize

java.awt.Dimension getVideoSize()
Gets the video size.

Returns:
the video size

getVideoScale

float getVideoScale()
Gets the video scale.

Returns:
the video scale

setVideoScale

java.lang.String setVideoScale(float scale)
Sets the video scale.

Parameters:
scale - the video scale
Returns:
null on success or a string containing an error message on failure

getVideoLocalComponent

java.lang.Object getVideoLocalComponent()
Gets the video local component.

Returns:
the video local component

setVideoLocalComponent

java.lang.String setVideoLocalComponent(java.lang.Object surface)
Sets the video local component.

Parameters:
surface - the surface
Returns:
null on success or a string containing an error message on failure

getVideoRemoteComponent

java.lang.Object getVideoRemoteComponent()
Gets the video remote component.

Returns:
the video remote component

setVideoRemoteComponent

java.lang.String setVideoRemoteComponent(java.lang.Object surface)
Sets the video remote component.

Parameters:
surface - the surface
Returns:
null on success or a string containing an error message on failure

getAudioChannels

int getAudioChannels()
Gets the audio channels.

Returns:
the audio channels

setAudioChannels

java.lang.String setAudioChannels(byte channels)
Sets the audio channels.

Parameters:
channels - the channels
Returns:
null on success or a string containing an error message on failure

getAudioSampleRate

int getAudioSampleRate()
Gets the audio sample rate.

Returns:
the audio sample rate

setAudioSampleRate

java.lang.String setAudioSampleRate(int sampleRate)
Sets the audio sample rate.

Parameters:
sampleRate - the sample rate
Returns:
null on success or a string containing an error message on failure

setLoggingEnabled

java.lang.String setLoggingEnabled(boolean flag)
Enables or disables the logging.

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

getConfigurationPanel

java.awt.Panel getConfigurationPanel()
Gets the configuration panel.

Returns:
the configuration panel

loadConfiguration

java.lang.String loadConfiguration(java.lang.String location)
Load configuration.

Parameters:
location - the location
Returns:
null on success or a string containing an error message on failure

saveConfiguration

java.lang.String saveConfiguration(java.lang.String location)
Save configuration.

Parameters:
location - the location
Returns:
null on success or a string containing an error message on failure

reconfigure

java.lang.String reconfigure()
Reconfigure the VC.

Returns:
null on success or a string containing an error message on failure

getStreamingLocalIp

java.lang.String getStreamingLocalIp()
Returns:
See Also:
IConfiguration.getLocalIp()

setStreamingLocalIp

void setStreamingLocalIp(java.lang.String localIp)
Parameters:
localIp -
See Also:
IConfiguration.setLocalIp(java.lang.String)

setVideoLocalEnabled

void setVideoLocalEnabled(java.lang.Boolean flag)
Enables or disables the local video component

Parameters:
flag -

setVideoRemoteEnabled

void setVideoRemoteEnabled(java.lang.Boolean flag)
Enables or disables the remote video component

Parameters:
flag -