All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class quicktime.io.QTFile

java.lang.Object
   |
   +----java.io.File
           |
           +----quicktime.io.QTFile

public final class QTFile
extends File
implements QuickTimeLib
The QTFile class represents a file for QuickTime movies.


Variable Index

 o kDeletePermission
Permission flags used to test security accessibility of a file path
 o kReadPermission
Permission flags used to test security accessibility of a file path
 o kStandardQTFileTypes
Standard types used in get file.
 o kWritePermission
Permission flags used to test security accessibility of a file path

Constructor Index

 o QTFile(File)
Used to return a QTFile object from a Java file object.
 o QTFile(String)
Used to return a QTFile object from a full path specification

Method Index

 o checkSecurity(String, int)
This method will assume that the incoming path is a full path specification for a file and will check the security manager settings to see if the current security settings allow this file to be read from or written to.
 o convertToMovieFile(QTFile, int, int)
This method takes a specified file and converts it to a movie file.
 o convertToMovieFile(QTFile, int, int, MovieImporter)
This method takes a specified file and converts it to a movie file.
 o convertToMovieFile(QTFile, int, int, MovieImporter, MovieProgress)
This method takes a specified file and converts it to a movie file.
 o createMovieFile(int, int)
Creates a file as specified by this QTFile.
 o createShortcutMovieFile(int, int, int, DataRef)
Creates a short cut movie file as specified by this QTFile.
 o delete()
This method deletes a movie file.
 o fromGraphicsImporter(GraphicsImporter)
Determines the file that the graphics resides in.
 o fromGraphicsImporter(GraphicsImporter, QTFile, String)
Presents a dialog box letting the user save an image in a foreign file format.
 o fromSequenceGrabber(SequenceGrabber)
Allows you to determine the movie file that is currently assigned to a sequence grabber component.
 o getFSSpec(boolean, int)
Returns the byte array containing the fsspec.
 o newAlias(boolean)
Creates an alias record that describes the specified target.
 o resolveAlias(AliasHandle)
This method will take an alias and will resolve it, returning the full path name of the resolved file.
 o resolveAlias(boolean)
Returns the target FSSpec passed in

QuickTime::ResolveAliasFile
 o standardGetFilePreview(int[])
Present a standard open file panel to the user to retrieve a file.

Variables

 o kStandardQTFileTypes
 public static final int kStandardQTFileTypes[]
Standard types used in get file.

 o kReadPermission
 public static final int kReadPermission
Permission flags used to test security accessibility of a file path

 o kWritePermission
 public static final int kWritePermission
Permission flags used to test security accessibility of a file path

 o kDeletePermission
 public static final int kDeletePermission
Permission flags used to test security accessibility of a file path

Constructors

 o QTFile
 public QTFile(String pathName)
Used to return a QTFile object from a full path specification

Parameters:
pathName - the full path name of the file
 o QTFile
 public QTFile(File file)
Used to return a QTFile object from a Java file object.

Parameters:
file - a java File object

Methods

 o fromGraphicsImporter
 public static QTFile fromGraphicsImporter(GraphicsImporter g) throws QTException
Determines the file that the graphics resides in.

QuickTime::GraphicsImportGetDataFile

Returns:
The file that contains the graphics data.
See Also:
getDataFile
 o fromGraphicsImporter
 public static GraphicsImporterInfo fromGraphicsImporter(GraphicsImporter g,
                                                         QTFile inDefaultSpec,
                                                         String prompt) throws QTException
Presents a dialog box letting the user save an image in a foreign file format.

QuickTime::GraphicsImportDoExportImageFileDialog

Parameters:
inDefaultSpec - suggests the default name for the file. If you do not want to suggest a default name, pass null.
prompt - A prompt that appears in the standard put dialog box; it may be nil, in which case a default string is used.
See Also:
doExportImageFileDialog
 o fromSequenceGrabber
 public static QTFile fromSequenceGrabber(SequenceGrabber s) throws QTException
Allows you to determine the movie file that is currently assigned to a sequence grabber component.

QuickTime::SGGetDataOutput

Returns:
The QTFile movie file.
See Also:
getDataOutputFile
 o checkSecurity
 public static void checkSecurity(String fileName,
                                  int permission)
This method will assume that the incoming path is a full path specification for a file and will check the security manager settings to see if the current security settings allow this file to be read from or written to. If the requested security access is dissallowed a SecurityException is thrown.

Parameters:
fileName - a full path file specification path
permission - the requested permission.
 o resolveAlias
 public static QTFile resolveAlias(AliasHandle alias) throws QTException
This method will take an alias and will resolve it, returning the full path name of the resolved file. You must have read permission to the resultant file path or a SecurityException will be thrown.

QuickTime::ResolveAlias

Parameters:
alias - the alias to resolve
Returns:
the QTFile object of the resolved alias
 o standardGetFilePreview
 public static QTFile standardGetFilePreview(int fileTypes[]) throws QTException
Present a standard open file panel to the user to retrieve a file.

QuickTime::StandardGetFilePreview()

Parameters:
fileTypes - the particular file types you want the user to see. No fileTypes assumes all files. Max of 4.
Returns:
The file object.
 o getFSSpec
 public final byte[] getFSSpec(boolean fileExists,
                               int permissions) throws QTIOException
Returns the byte array containing the fsspec.

Parameters:
flag - if true then the file must exist or a fnfError is thrown otherwise it is not required that the file exist
permissions - you must specify whether the file will be reading or writing.
Returns:
the byte array
 o convertToMovieFile
 public void convertToMovieFile(QTFile outputFile,
                                int fCreator,
                                int inFlags) throws QTException
This method takes a specified file and converts it to a movie file.

QuickTime::ConvertFileToMovieFile()

Parameters:
outputFie - the destination movie file.
fCreator - Specifies the creator value for the file if it is a new one.
inFlags - Controls movie file conversion flags.
 o convertToMovieFile
 public void convertToMovieFile(QTFile outputFile,
                                int fCreator,
                                int inFlags,
                                MovieImporter mic) throws QTException
This method takes a specified file and converts it to a movie file. The specified files must be full paths or a fnfErr exception will be thrown

QuickTime::ConvertFileToMovieFile()

Parameters:
outputFile - the destination movie file.
fCreator - Specifies the creator value for the file if it is a new one.
inFlags - Controls movie file conversion flags.
mec - Specifies the movie export component if used for translation, null otherwise.
 o convertToMovieFile
 public void convertToMovieFile(QTFile outputFile,
                                int fCreator,
                                int flags,
                                MovieImporter mic,
                                MovieProgress mp) throws QTException
This method takes a specified file and converts it to a movie file. The specified files must be full paths or a fnfErr exception will be thrown

QuickTime::ConvertFileToMovieFile()

Parameters:
outputFile - the destination movie file.
fCreator - Specifies the creator value for the file if it is a new one.
flags - Controls movie file conversion flags.
mec - Specifies the movie export component if used for translation, null otherwise.
mp - Specifies the movie progress object or null otherwise.
 o createMovieFile
 public void createMovieFile(int fCreator,
                             int flags) throws QTIOException
Creates a file as specified by this QTFile. This call will not open the created movie file.

QuickTime::CreateMovieFile()

Parameters:
pathName - specifies the complete pathName of the file that is to be created.
fCreator - Specifies the creator of the file.
flags - Specifies the behaviour when creating the file.
 o createShortcutMovieFile
 public void createShortcutMovieFile(int creator,
                                     int scriptTag,
                                     int createMovieFileFlags,
                                     DataRef targetDataRef) throws QTException
Creates a short cut movie file as specified by this QTFile. A Shortcut movie just contains a data reference which refers to another movie.

QuickTime::CreateShortcutMovieFile()

Parameters:
pathName - specifies the complete pathName of the file that is to be created.
creator - Specifies the creator of the file.
scriptTag - the system script identifier
createMovieFileFlags - Specifies the behaviour when creating the file.
targetDataRef - this is a data reference to the location of the data that is referred to by the resultant movie that this call creates.
 o newAlias
 public AliasHandle newAlias(boolean minimal) throws QTException
Creates an alias record that describes the specified target.

QuickTime::QTNewAlias

Parameters:
minimal - if true then the alias is a minimal alias.
Returns:
an AliasHandle that represents the QTFile
 o resolveAlias
 public QTFile resolveAlias(boolean resolveAliasChains) throws QTIOException
Returns the target FSSpec passed in

QuickTime::ResolveAliasFile

Parameters:
resolveAliasChains - set to true if all aliases to be resolved in a chain.
 o delete
 public boolean delete()
This method deletes a movie file.

QuickTime::DeleteMovieFile()

Returns:
true if the file is successfully deleted; false otherwise.
Overrides:
delete in class File

All Packages  Class Hierarchy  This Package  Previous  Next  Index