| 
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.esri.arcgis.analyst3d.AVIExporter
public class AVIExporter
An exporter to AVI video format.
| Constructor Summary | |
|---|---|
AVIExporter()
Constructs a AVIExporter using ArcGIS Engine.  | 
|
AVIExporter(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.  AVIExporter theAVIExporter = (AVIExporter) obj; | 
|
| Method Summary | |
|---|---|
 boolean | 
equals(Object o)
Compare this object with another  | 
 void | 
exportScene(IScene pScene)
Exports the scene.  | 
static String | 
getClsid()
getClsid.  | 
 String | 
getCodec()
The current video codec.  | 
 String | 
getCodecCode()
The current video codec's unique code.  | 
 IStringArray | 
getCodecCodeList()
The list of unique codes of available codecs.  | 
 IStringArray | 
getCodecList()
The list of names of available codecs.  | 
 short | 
getColorDepth()
The number of bits per pixel in each video frame.  | 
 void | 
getCustomSize(int[] pWidth,
              int[] pHeight)
The custom image size for video export.  | 
 int | 
getDataRate()
The maximum number of bytes per second.  | 
 String | 
getExportFileName()
The exported file name.  | 
 String | 
getFileExtension()
The file extension associated with the current exporter.  | 
 String | 
getFilter()
The filter string used in the CFileDialog class.  | 
 int | 
getFrameDuration()
The duration of each frame in milliseconds.  | 
 int | 
getFrameRate()
The frame rate in images per second.  | 
 int | 
getKeyFrameRate()
The frequency of keyframes in the video.  | 
 String | 
getName()
The name of the exporter.  | 
 int | 
getQuality()
The quality of video compression (1-100).  | 
 double | 
getVideoDuration()
The duration of the animation in seconds.  | 
 int | 
hashCode()
the hashcode for this object  | 
 boolean | 
isInstalled()
Indicates if the video exporter is installed.  | 
 boolean | 
isRecordOffScreen()
Indicates if video is to be recorded offscreen.  | 
 boolean | 
isRecordWindow()
Indicates if entire window is to be recorded.  | 
 boolean | 
isShowSettingsDialog()
Indicates if video compression settings dialog is to be displayed.  | 
 boolean | 
isUseCustomSize()
Indicates if a custom image size should be used.  | 
 void | 
putCustomSize(int width,
              int height)
The custom image size for video export.  | 
 void | 
setCodec(String pCodecName)
The current video codec.  | 
 void | 
setCodecCode(String pCodecCode)
The current video codec's unique code.  | 
 void | 
setColorDepth(short pColorDepth)
The number of bits per pixel in each video frame.  | 
 void | 
setDataRate(int pDataRate)
The maximum number of bytes per second.  | 
 void | 
setExportFileName(String fileName)
The exported file name.  | 
 void | 
setFrameDuration(int pFrameDuration)
The duration of each frame in milliseconds.  | 
 void | 
setFrameRate(int pImagesPerSecond)
The frame rate in images per second.  | 
 void | 
setKeyFrameRate(int pKeyFrameRate)
The frequency of keyframes in the video.  | 
 void | 
setQuality(int pQualityPercent)
The quality of video compression (1-100).  | 
 void | 
setRecordOffScreen(boolean pbRecordOffScreen)
Indicates if video is to be recorded offscreen.  | 
 void | 
setRecordWindow(boolean pbRecordAppWindow)
Indicates if entire window is to be recorded.  | 
 void | 
setShowSettingsDialog(boolean pbShowSettingsDialog)
Indicates if video compression settings dialog is to be displayed.  | 
 void | 
setUseCustomSize(boolean pbUseCustomSize)
Indicates if a custom image size should be used.  | 
 void | 
setVideoDuration(double pSeconds)
The duration of the animation in seconds.  | 
 void | 
setViewerByRef(ISceneViewer rhs1)
The animated viewer to be exported.  | 
| Methods inherited from class java.lang.Object | 
|---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait | 
| Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef | 
|---|
getJintegraDispatch, release | 
| Constructor Detail | 
|---|
public AVIExporter()
            throws IOException,
                   UnknownHostException
IOException - if there are interop problems
UnknownHostException - if there are interop problems
public AVIExporter(Object obj)
            throws IOException
 AVIExporter theAVIExporter = (AVIExporter) obj;
obj to AVIExporter.
obj - an object returned from ArcGIS Engine or Server
IOException - if there are interop problems| Method Detail | 
|---|
public static String getClsid()
public boolean equals(Object o)
equals in class Objectpublic int hashCode()
hashCode in class Object
public String getName()
               throws IOException,
                      AutomationException
getName in interface ISceneExporter3dIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getFilter()
                 throws IOException,
                        AutomationException
getFilter in interface ISceneExporter3dIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getFileExtension()
                        throws IOException,
                               AutomationException
getFileExtension in interface ISceneExporter3dIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setExportFileName(String fileName)
                       throws IOException,
                              AutomationException
setExportFileName in interface ISceneExporter3dfileName - The fileName  (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getExportFileName()
                         throws IOException,
                                AutomationException
getExportFileName in interface ISceneExporter3dIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void exportScene(IScene pScene)
                 throws IOException,
                        AutomationException
exportScene in interface ISceneExporter3dpScene - A reference to a com.esri.arcgis.analyst3d.IScene  (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setViewerByRef(ISceneViewer rhs1)
                    throws IOException,
                           AutomationException
setViewerByRef in interface ISceneVideoExporterrhs1 - A reference to a com.esri.arcgis.analyst3d.ISceneViewer  (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setVideoDuration(double pSeconds)
                      throws IOException,
                             AutomationException
setVideoDuration in interface ISceneVideoExporterpSeconds - The pSeconds  (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public double getVideoDuration()
                        throws IOException,
                               AutomationException
getVideoDuration in interface ISceneVideoExporterIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setFrameRate(int pImagesPerSecond)
                  throws IOException,
                         AutomationException
setFrameRate in interface ISceneVideoExporterpImagesPerSecond - The pImagesPerSecond  (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getFrameRate()
                 throws IOException,
                        AutomationException
getFrameRate in interface ISceneVideoExporterIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setUseCustomSize(boolean pbUseCustomSize)
                      throws IOException,
                             AutomationException
setUseCustomSize in interface ISceneVideoExporterpbUseCustomSize - The pbUseCustomSize  (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isUseCustomSize()
                        throws IOException,
                               AutomationException
isUseCustomSize in interface ISceneVideoExporterIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void putCustomSize(int width,
                          int height)
                   throws IOException,
                          AutomationException
putCustomSize in interface ISceneVideoExporterwidth - The width  (in)height - The height  (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getCustomSize(int[] pWidth,
                          int[] pHeight)
                   throws IOException,
                          AutomationException
getCustomSize in interface ISceneVideoExporterpWidth - The pWidth  (out: use single element array)pHeight - The pHeight  (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isInstalled()
                    throws IOException,
                           AutomationException
isInstalled in interface IVideoExporterPropertiesIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IStringArray getCodecList()
                          throws IOException,
                                 AutomationException
getCodecList in interface IVideoExporterPropertiesIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IStringArray getCodecCodeList()
                              throws IOException,
                                     AutomationException
getCodecCodeList in interface IVideoExporterPropertiesIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setCodec(String pCodecName)
              throws IOException,
                     AutomationException
setCodec in interface IVideoExporterPropertiespCodecName - The pCodecName  (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getCodec()
                throws IOException,
                       AutomationException
The Codec property is an identifier showing what the current codec is used when exporting to a video format. When you check for the Codec property, be it an AVI or QuickTime video, it's always in Code:Codec format, where the Code is a four-letter string that uniquely identifies a particular codec. The codec name proper (i.e. the codec name without the four-letter code name and the colon in front), however, may not be unique in some situations. For some AVI codecs, the name proper could even be blank. In this scenario the only identifier for that codec would be the four-letter code. Some codec code names (i.e. the four-letter string) may appear as three-letter codes - the fourth one is just a blank space, which is also a valid character. All the four-letter code names are not case sensitive.
getCodec in interface IVideoExporterPropertiesIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setCodecCode(String pCodecCode)
                  throws IOException,
                         AutomationException
setCodecCode in interface IVideoExporterPropertiespCodecCode - The pCodecCode  (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getCodecCode()
                    throws IOException,
                           AutomationException
getCodecCode in interface IVideoExporterPropertiesIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setColorDepth(short pColorDepth)
                   throws IOException,
                          AutomationException
setColorDepth in interface IVideoExporterPropertiespColorDepth - The pColorDepth  (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public short getColorDepth()
                    throws IOException,
                           AutomationException
getColorDepth in interface IVideoExporterPropertiesIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setQuality(int pQualityPercent)
                throws IOException,
                       AutomationException
setQuality in interface IAVIExportersetQuality in interface IVideoExporterPropertiespQualityPercent - The pQualityPercent  (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getQuality()
               throws IOException,
                      AutomationException
getQuality in interface IAVIExportergetQuality in interface IVideoExporterPropertiesIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setKeyFrameRate(int pKeyFrameRate)
                     throws IOException,
                            AutomationException
setKeyFrameRate in interface IVideoExporterPropertiespKeyFrameRate - The pKeyFrameRate  (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getKeyFrameRate()
                    throws IOException,
                           AutomationException
getKeyFrameRate in interface IVideoExporterPropertiesIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setDataRate(int pDataRate)
                 throws IOException,
                        AutomationException
setDataRate in interface IVideoExporterPropertiespDataRate - The pDataRate  (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getDataRate()
                throws IOException,
                       AutomationException
getDataRate in interface IVideoExporterPropertiesIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setFrameDuration(int pFrameDuration)
                      throws IOException,
                             AutomationException
setFrameDuration in interface IVideoExporterPropertiespFrameDuration - The pFrameDuration  (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getFrameDuration()
                     throws IOException,
                            AutomationException
getFrameDuration in interface IVideoExporterPropertiesIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setRecordWindow(boolean pbRecordAppWindow)
                     throws IOException,
                            AutomationException
setRecordWindow in interface IVideoExporterPropertiespbRecordAppWindow - The pbRecordAppWindow  (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isRecordWindow()
                       throws IOException,
                              AutomationException
isRecordWindow in interface IVideoExporterPropertiesIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setRecordOffScreen(boolean pbRecordOffScreen)
                        throws IOException,
                               AutomationException
setRecordOffScreen in interface IVideoExporterPropertiespbRecordOffScreen - The pbRecordOffScreen  (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isRecordOffScreen()
                          throws IOException,
                                 AutomationException
isRecordOffScreen in interface IVideoExporterPropertiesIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setShowSettingsDialog(boolean pbShowSettingsDialog)
                           throws IOException,
                                  AutomationException
setShowSettingsDialog in interface IVideoExporterPropertiespbShowSettingsDialog - The pbShowSettingsDialog  (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isShowSettingsDialog()
                             throws IOException,
                                    AutomationException
isShowSettingsDialog in interface IVideoExporterPropertiesIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
  | 
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||