livespace.services.entities.vtc
Class VTCEntity

java.lang.Object
  dsto.dfc.databeans.AbstractDataObject
      dsto.dfc.databeans.SimpleDataObject
          dsto.dfc.databeans.FancyDataObject
              livespace.services.Entity
                  livespace.services.entities.vtc.VTCEntity

All Implemented Interfaces:

IDataObject, IDataObjectChildListener, Cloneable

public class VTCEntity
extends Entity

Represents a Video Teleconference (VTC) device within a LiveSpace

Author:

Steven Johnson Created on 20/09/2005

Field Summary

static String	ALLOW_FECC Property name for the optional property which specifies if the vtc device will allow remote participants to control the local camera or not.
int	audioVolume Specifies the audio volume as a percentage (in the range 0 - 100)
static String	AUTO_ANSWER Property name for the optional auto answer property which specifies whether auto answer is turned on or off
EntityRegistry	calls A registry of the CallEntity's available on the vtc device
EntityRegistry	cameras A registry of the CameraEntity's available on the vtc device
EntityRegistry	directory A registry of the DirectoryEntryEntity's on the vtc
static String	DO_NOT_DISTURB Property name for the optional do not disturb property which specifies whether the vtc is in do not disturb mode or not (i.e.
static String	ENTITY_TYPE
String	mainVideoSource The id of the current VideoInputEntity to use as the main video source to send to remote participants
boolean	microphonesOn Specifies whether the microphones are turned on or off
EntityRegistry	pictureProgramLayouts A registry of the PictureProgramLayoutEntity's supported by the vtc device
EntityRegistry	pictures A registry of the PictureEntity's available on the vtc
static String	SCREENSAVER_ON Property name for the optional property which specifies if the screensaver for the vtc device is activated or not.
static String	SECONDARY_VIDEO_SOURCE Property name for the optional property which specifies the id of the VideoInputEntity to use as the secondary video source to send to remote participants.
static String	SEND_SECONDARY_VIDEO Property name for the optional property which specifies whether secondary video will be sent to remote parties or not.
EntityRegistry	videoInputs A registry of the VideoInputEntity's to represent the video inputs on the vtc device.
EntityRegistry	videoOutputs A registry of the VideoOutputEntity's to represent the video outputs on the vtc device.
EntityRegistry	virtualMonitors A registry of the VirtualMonitorEntity's available on the vtc

Fields inherited from class livespace.services.Entity

container, id, lastTouched, name, unconfirmedUpdates

Fields inherited from class dsto.dfc.databeans.AbstractDataObject

listeners

Fields inherited from interface dsto.dfc.databeans.IDataObject

OVERRIDE, PERSISTENT, PERSISTENT_OVERRIDE, TRANSIENT, TRANSIENT_OVERRIDE

Constructor Summary

VTCEntity()

VTCEntity(String id)

VTCEntity(String id, String name)

Method Summary

String

getType() The type of the object (eg "room", "light", "volume", etc).

Methods inherited from class livespace.services.Entity

create, createId, getElvin, getType, getTypeInfo, mutex, sameEntity, shallowClone, waitForProperty, waitForProperty, waitForProperty, waitForProperty

Methods inherited from class dsto.dfc.databeans.FancyDataObject

childPropertyChanged, getValue, isTransient, propertyIterator, setValue

Methods inherited from class dsto.dfc.databeans.SimpleDataObject

getFieldNames, setValue

Methods inherited from class dsto.dfc.databeans.AbstractDataObject

addFirstPropertyListener, addPropertyListener, firePropertyChangedEvent, firePropertyChangedEvent, firePropertyChangedEvent, firePropertyChangedEvent, firePropertyChangedEvent, firePropertyChangedEvent, getBeanValue, getBooleanValue, getBooleanValue, getCharValue, getCharValue, getDoubleValue, getDoubleValue, getFloatValue, getFloatValue, getIntValue, getIntValue, getLongValue, getLongValue, getObjectValue, getPropertyListeners, getShortValue, getStringValue, registerValue, removePropertyListener, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, unregisterValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ENTITY_TYPE

public static final String ENTITY_TYPE

See Also:

Constant Field Values

AUTO_ANSWER

public static final String AUTO_ANSWER

Property name for the optional auto answer property which specifies whether auto answer is turned on or off

See Also:

Constant Field Values

DO_NOT_DISTURB

public static final String DO_NOT_DISTURB

Property name for the optional do not disturb property which specifies whether the vtc is in do not disturb mode or not (i.e. if it will or will not accept incoming calls)

See Also:

Constant Field Values

ALLOW_FECC

public static final String ALLOW_FECC

Property name for the optional property which specifies if the vtc device will allow remote participants to control the local camera or not.

See Also:

Constant Field Values

SCREENSAVER_ON

public static final String SCREENSAVER_ON

Property name for the optional property which specifies if the screensaver for the vtc device is activated or not.

See Also:

Constant Field Values

SECONDARY_VIDEO_SOURCE

public static final String SECONDARY_VIDEO_SOURCE

Property name for the optional property which specifies the id of the VideoInputEntity to use as the secondary video source to send to remote participants. If the value of this property is null then secondary video will be turned off (i.e. not sent to remote sites).

See Also:

Constant Field Values

SEND_SECONDARY_VIDEO

public static final String SEND_SECONDARY_VIDEO

Property name for the optional property which specifies whether secondary video will be sent to remote parties or not.

See Also:

Constant Field Values

microphonesOn

public boolean microphonesOn

Specifies whether the microphones are turned on or off

audioVolume

public int audioVolume

Specifies the audio volume as a percentage (in the range 0 - 100)

mainVideoSource

public String mainVideoSource

The id of the current VideoInputEntity to use as the main video source to send to remote participants

videoInputs

public EntityRegistry videoInputs

A registry of the VideoInputEntity's to represent the video inputs on the vtc device.

videoOutputs

public EntityRegistry videoOutputs

A registry of the VideoOutputEntity's to represent the video outputs on the vtc device.

virtualMonitors

public EntityRegistry virtualMonitors

A registry of the VirtualMonitorEntity's available on the vtc

pictures

public EntityRegistry pictures

A registry of the PictureEntity's available on the vtc

pictureProgramLayouts

public EntityRegistry pictureProgramLayouts

A registry of the PictureProgramLayoutEntity's supported by the vtc device

calls

public EntityRegistry calls

A registry of the CallEntity's available on the vtc device

cameras

public EntityRegistry cameras

A registry of the CameraEntity's available on the vtc device

directory

public EntityRegistry directory

A registry of the DirectoryEntryEntity's on the vtc

Constructor Detail

VTCEntity

public VTCEntity()

VTCEntity

public VTCEntity(String id)

VTCEntity

public VTCEntity(String id,
                 String name)

Method Detail

getType

public String getType()

Description copied from class: Entity

The type of the object (eg "room", "light", "volume", etc). This must be unique to the entity class.

NOTE: it is also a good practice to provide a static field that defines the entity type on the class: eg

 public static final String ENTITY_TYPE = "room";
 

Specified by:

getType in class Entity