livespace.services.entities
Class VideoSourceEntity

java.lang.Object
  extended by dsto.dfc.databeans.AbstractDataObject
      extended by dsto.dfc.databeans.SimpleDataObject
          extended by dsto.dfc.databeans.FancyDataObject
              extended by livespace.services.Entity
                  extended by livespace.services.entities.VideoSourceEntity
All Implemented Interfaces:
IDataObject, IDataObjectChildListener, Cloneable

public class VideoSourceEntity
extends Entity

Represents a video source in the livespace, generated by a computer, VTC, webcam or other. A video source may also be used as an audio source.

Author:
karu
See Also:
DisplayEntity, SpeakerEntity

Field Summary
static String ENTITY_TYPE
           
 int index
          The desktop index (starting at 0).
 boolean isPrimary
          True if this the system's default desktop.
static String VIDEO_SWITCH_PORT
          For rooms that use a central port-based video switch, this is the property name of the port that the display is connected to on the switch.
 
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
VideoSourceEntity()
           
VideoSourceEntity(String id)
           
VideoSourceEntity(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

VIDEO_SWITCH_PORT

public static final String VIDEO_SWITCH_PORT
For rooms that use a central port-based video switch, this is the property name of the port that the display is connected to on the switch.

See Also:
Constant Field Values

index

public int index
The desktop index (starting at 0). The index order is a hint as to the physical ordering of screens, from left to right, i.e. desktop 0 is to the left of screen 1


isPrimary

public boolean isPrimary
True if this the system's default desktop. At least one desktop will have this set to true.

Constructor Detail

VideoSourceEntity

public VideoSourceEntity()

VideoSourceEntity

public VideoSourceEntity(String id)

VideoSourceEntity

public VideoSourceEntity(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


Copyright © 2008 Commonwealth of Australia