livespace.services.entities
Class SpeakerEntity

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.SpeakerEntity
All Implemented Interfaces:
IDataObject, IDataObjectChildListener, Cloneable

public class SpeakerEntity
extends Entity

Represents a speaker within a room. A speaker can optionally be associated with a display using the "defaultDisplay" property.

Author:
Derek Weber
See Also:
DisplayEntity

Field Summary
 String audioSourceId
          The id of an audio source currently being played through this speaker.
static String ENTITY_TYPE
           
 String switchOutputPort
          When a speaker is connected to a video switch, this property indicates the output port it's currently plugged into.
 
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
SpeakerEntity()
           
SpeakerEntity(String id, String name, String audioSourceId, String switchOutputPort)
           
 
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

audioSourceId

public String audioSourceId
The id of an audio source currently being played through this speaker. It must match the id of a VideoSourceEntity

See Also:
ComputerEntity.audioSourceId

switchOutputPort

public String switchOutputPort
When a speaker is connected to a video switch, this property indicates the output port it's currently plugged into.

See Also:
VideoSourceEntity.VIDEO_SWITCH_PORT
Constructor Detail

SpeakerEntity

public SpeakerEntity()

SpeakerEntity

public SpeakerEntity(String id,
                     String name,
                     String audioSourceId,
                     String switchOutputPort)
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