javax.media.j3d
Class MediaContainerRetained

java.lang.Object
  extended by javax.media.j3d.IndexedObject
      extended by javax.media.j3d.SceneGraphObjectRetained
          extended by javax.media.j3d.NodeComponentRetained
              extended by javax.media.j3d.MediaContainerRetained
All Implemented Interfaces:
java.lang.Cloneable

 class MediaContainerRetained
extends NodeComponentRetained

The MediaContainerRetained object defines all rendering state that can be set as a component object of a retained Soundscape node.


Field Summary
(package private)  boolean cached
          Gain Scale Factor applied to source with this attribute
(package private)  java.io.InputStream inputStream
           
(package private)  java.net.URL url
          URL string that references the sound data
(package private)  java.lang.String urlString
           
 
Fields inherited from class javax.media.j3d.NodeComponentRetained
changedFrequent, compChanged, duplicateOnCloneTree, mirror, refCnt, refCount, users
 
Fields inherited from class javax.media.j3d.SceneGraphObjectRetained
DONT_MERGE, inBackgroundGroup, inSetLive, MERGE, MERGE_DONE, mergeFlag, onUpdateList, source
 
Fields inherited from class javax.media.j3d.IndexedObject
listIdx
 
Constructor Summary
MediaContainerRetained()
           
 
Method Summary
(package private)  void dispatchMessage()
          Dispatch a message about a media container change
(package private)  boolean getCacheEnable()
          Retrieve Attrribute Gain (amplitude)
(package private)  java.io.InputStream getInputStream()
          Retrieve InputData
(package private)  java.net.URL getURLObject()
          Retrieve URL objects
(package private)  java.lang.String getURLString()
          Retrieve URL String
(package private)  void setCacheEnable(boolean state)
          Set Cached flag
(package private)  void setInputStream(java.io.InputStream stream)
          Set input stream reference to sound data
(package private)  void setInputStream(java.io.InputStream stream, boolean forceLoad)
          Set input stream reference to sound data
(package private)  void setURLObject(java.net.URL url)
          Set URL object that references the sound data
(package private)  void setURLObject(java.net.URL url, boolean forceLoad)
          Set URL object that references the sound data
(package private)  void setURLString(java.lang.String path)
          Set URL path that references the sound data
(package private)  void setURLString(java.lang.String path, boolean forceLoad)
          Set URL path that references the sound data
 
Methods inherited from class javax.media.j3d.NodeComponentRetained
addAMirrorUser, addUser, clearLive, clone, copyMirrorUsers, createMirrorObject, decRefCnt, doSetLive, getDuplicateOnCloneTree, getInImmCtx, incRefCnt, initMirrorObject, notifyUsers, removeAMirrorUser, removeMirrorUsers, removeUser, set, setDuplicateOnCloneTree, setFrequencyChangeMask, setInImmCtx, setLive, updateMirrorObject
 
Methods inherited from class javax.media.j3d.SceneGraphObjectRetained
clearLive, clearLive, compile, doSetLive, doSetLive, getSource, getVirtualUniverse, handleFrequencyChange, isInSetLive, isStatic, markAsLive, merge, mergeTransform, setCompiled, setLive, setLive, setSource, traverse
 
Methods inherited from class javax.media.j3d.IndexedObject
getIdxUsed, incIdxUsed
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

cached

boolean cached
Gain Scale Factor applied to source with this attribute


url

java.net.URL url
URL string that references the sound data


urlString

java.lang.String urlString

inputStream

java.io.InputStream inputStream
Constructor Detail

MediaContainerRetained

MediaContainerRetained()
Method Detail

setCacheEnable

void setCacheEnable(boolean state)
Set Cached flag

Parameters:
state - flag denoting sound data is cached by app within node

getCacheEnable

boolean getCacheEnable()
Retrieve Attrribute Gain (amplitude)

Returns:
gain amplitude scale factor

setURLObject

void setURLObject(java.net.URL url)
Set URL object that references the sound data

Parameters:
url - URL object that references the sound data

setURLObject

void setURLObject(java.net.URL url,
                  boolean forceLoad)
Set URL object that references the sound data

Parameters:
url - URL object that references the sound data
forceLoad - ensures that message about change is sent to scheduler

setURLString

void setURLString(java.lang.String path)
Set URL path that references the sound data

Parameters:
path - string of URL that references the sound data

setURLString

void setURLString(java.lang.String path,
                  boolean forceLoad)
Set URL path that references the sound data

Parameters:
path - string of URL that references the sound data
forceLoad - ensures that message about change is sent to scheduler

setInputStream

void setInputStream(java.io.InputStream stream)
Set input stream reference to sound data

Parameters:
stream - InputStream that references the sound data
forceLoad - ensures that message about change is sent to scheduler

setInputStream

void setInputStream(java.io.InputStream stream,
                    boolean forceLoad)
Set input stream reference to sound data

Parameters:
stream - InputStream that references the sound data

getURLString

java.lang.String getURLString()
Retrieve URL String

Returns:
URL string that references the sound data

getURLObject

java.net.URL getURLObject()
Retrieve URL objects

Returns:
URL object that references the sound data

getInputStream

java.io.InputStream getInputStream()
Retrieve InputData

Returns:
InputString that references the sound data

dispatchMessage

void dispatchMessage()
Dispatch a message about a media container change



Copyright 1996-2008 Sun Microsystems, Inc. All Rights Reserved. Use is subject to license terms.