All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class quicktime.std.movies.media.DataRef

java.lang.Object
   |
   +----quicktime.QTObject
           |
           +----quicktime.util.QTHandleRef
                   |
                   +----quicktime.util.QTHandle
                           |
                           +----quicktime.std.movies.media.DataRef

public final class DataRef
extends QTHandle
implements QuickTimeLib
The DataRef class implements the data reference structure of the Movie Toolbox.


Constructor Index

 o DataRef(AliasHandle)
This constructor creates a DataRef that represents an AliasHandle.
 o DataRef(QTFile)
This constructor creates a DataRef that represents a QTFile.
 o DataRef(QTHandleRef)
This constructor creates a DataRef that references the given QTHandle so the dataRefType is a handle DataRef ('hndl').
 o DataRef(QTHandleRef, int, String)
This constructor creates a DataRef that references the given QTHandle so the dataRefType is a handle DataRef ('hndl').
 o DataRef(String)
This constructor creates a DataRef that represents any URL.

Method Index

 o fromMedia(Media, int)
This method returns a copy of a specified data reference.
 o fromMovie(Movie)
This method allows your application to get the default data reference for the movie.
 o fromSequenceGrabber(SequenceGrabber)
Determines the data reference that is currently assigned to a sequence grabber component.
 o getAttributes()
This method returns the data reference attributes.
 o getType()
This method returns the data reference type.
 o getUniversalResourceLocator()
Returns a string representating the location of this object.

Constructors

 o DataRef
 public DataRef(String url) throws QTException
This constructor creates a DataRef that represents any URL. If there is no DataHandler for this URL an invalidDataRef exception is thrown

Parameters:
url - the URL that is used to create a DataReference.
 o DataRef
 public DataRef(QTFile f) throws QTException
This constructor creates a DataRef that represents a QTFile.

Parameters:
file - the QTFile that is used to create a DataReference.
 o DataRef
 public DataRef(AliasHandle a) throws IOException, QTException
This constructor creates a DataRef that represents an AliasHandle.

Parameters:
a - the AliasHandle that is reference by this DataRef.
 o DataRef
 public DataRef(QTHandleRef handle) throws QTException
This constructor creates a DataRef that references the given QTHandle so the dataRefType is a handle DataRef ('hndl').

Parameters:
handle - Specifies the data (a handle) that this reference should point to.
 o DataRef
 public DataRef(QTHandleRef handle,
                int hintFlag,
                String hintString) throws QTException
This constructor creates a DataRef that references the given QTHandle so the dataRefType is a handle DataRef ('hndl'). Hints can be given to QuickTime (and should if at all possible) about the format of the data that is contained within the handle. Hints can take one of three forms The preferred usage is to pass in either the MacOS File Type (which will also work on non-MacOS platforms) or the MIME type information. The File extension is a more arbitrary indicator and should be the least referred to. If the hint information is not specified a paramErr exception is thrown

Parameters:
handle - Specifies the data (a handle) that this reference should point to.
hintFlag - describes the hint data that is used
hintString - contains the hint information

Methods

 o fromMovie
 public static DataRef fromMovie(Movie m) throws QTException
This method allows your application to get the default data reference for the movie.

QuickTime::GetMovieDefaultDataRef()

Returns:
a DataRef object specifiying the default data reference for the movie.
See Also:
getDefaultDataRef
 o fromSequenceGrabber
 public static DataRef fromSequenceGrabber(SequenceGrabber sg) throws StdQTException
Determines the data reference that is currently assigned to a sequence grabber component.

QuickTime::SGGetDataRef

Returns:
the dataRef
See Also:
getDataRef
 o fromMedia
 public static DataRef fromMedia(Media m,
                                 int index) throws QTException
This method returns a copy of a specified data reference.

QuickTime::GetMediaDataRef()

Parameters:
index - Identifies the data reference.
Returns:
a copy of a specified data reference.
See Also:
getDataRef
 o getType
 public int getType()
This method returns the data reference type.

Returns:
the data reference type.
 o getAttributes
 public int getAttributes()
This method returns the data reference attributes.

Returns:
the data reference attributes.
 o getUniversalResourceLocator
 public String getUniversalResourceLocator() throws QTException
Returns a string representating the location of this object. If the DataRef points to a File or URL the path will be printed, if not then an empty string is returned.


All Packages  Class Hierarchy  This Package  Previous  Next  Index