com.esri.arcgis.analyst3d
Class AVIExporter

java.lang.Object
  extended by com.esri.arcgis.analyst3d.AVIExporter
All Implemented Interfaces:
IAVIExporter, ISceneExporter3d, ISceneVideoExporter, IVideoExporterProperties, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class AVIExporter
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ISceneExporter3d, ISceneVideoExporter, IVideoExporterProperties, IAVIExporter

COM Class 'AVIExporter'. Generated 3/19/2015 1:20:41 PM from 'C:\ArcGIS\COM\esri3DAnalyst.olb'

Description 'An exporter to AVI video format.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.esri.arcgis.analyst3d.ISceneExporter3d
IID, IID3044c30b_37d0_11d4_a167_444553547777, xxDummy
 
Fields inherited from interface com.esri.arcgis.analyst3d.ISceneVideoExporter
IID, IID4251ba07_9106_11d5_b29f_00508bcdde28, xxDummy
 
Fields inherited from interface com.esri.arcgis.analyst3d.IVideoExporterProperties
IID, IID26eb3a30_9e6d_443c_b904_79b16c5028aa, xxDummy
 
Fields inherited from interface com.esri.arcgis.analyst3d.IAVIExporter
IID, IID4251ba08_9106_11d5_b29f_00508bcdde28, xxDummy
 
Constructor Summary
AVIExporter()
          Constructs a AVIExporter using ArcGIS Engine.
AVIExporter(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AVIExporter theAVIExporter = (AVIExporter) obj;
 
Method Summary
 boolean equals(java.lang.Object o)
          Compare this object with another
 void exportScene(IScene pScene)
          Exports the scene.
static java.lang.String getClsid()
          getClsid.
 java.lang.String getCodec()
          The current video codec.
 java.lang.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.
 java.lang.String getExportFileName()
          The exported file name.
 java.lang.String getFileExtension()
          The file extension associated with the current exporter.
 java.lang.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.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 int getKeyFrameRate()
          The frequency of keyframes in the video.
 java.lang.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 release()
          Release a AVIExporter.
 void setCodec(java.lang.String pCodecName)
          The current video codec.
 void setCodecCode(java.lang.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(java.lang.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
 

Constructor Detail

AVIExporter

public AVIExporter()
            throws java.io.IOException,
                   java.net.UnknownHostException
Constructs a AVIExporter using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

AVIExporter

public AVIExporter(java.lang.Object obj)
            throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AVIExporter theAVIExporter = (AVIExporter) obj;

Construct a AVIExporter using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to AVIExporter.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
java.io.IOException - if there are interop problems
Method Detail

getClsid

public static java.lang.String getClsid()
getClsid.


equals

public boolean equals(java.lang.Object o)
Compare this object with another

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a AVIExporter.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
The name of the exporter.

Specified by:
getName in interface ISceneExporter3d
Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFilter

public java.lang.String getFilter()
                           throws java.io.IOException,
                                  AutomationException
The filter string used in the CFileDialog class.

Specified by:
getFilter in interface ISceneExporter3d
Returns:
The filter
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFileExtension

public java.lang.String getFileExtension()
                                  throws java.io.IOException,
                                         AutomationException
The file extension associated with the current exporter.

Specified by:
getFileExtension in interface ISceneExporter3d
Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExportFileName

public void setExportFileName(java.lang.String fileName)
                       throws java.io.IOException,
                              AutomationException
The exported file name.

Specified by:
setExportFileName in interface ISceneExporter3d
Parameters:
fileName - The fileName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExportFileName

public java.lang.String getExportFileName()
                                   throws java.io.IOException,
                                          AutomationException
The exported file name.

Specified by:
getExportFileName in interface ISceneExporter3d
Returns:
The fileName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

exportScene

public void exportScene(IScene pScene)
                 throws java.io.IOException,
                        AutomationException
Exports the scene.

Specified by:
exportScene in interface ISceneExporter3d
Parameters:
pScene - A reference to a com.esri.arcgis.analyst3d.IScene (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setViewerByRef

public void setViewerByRef(ISceneViewer rhs1)
                    throws java.io.IOException,
                           AutomationException
The animated viewer to be exported.

Specified by:
setViewerByRef in interface ISceneVideoExporter
Parameters:
rhs1 - A reference to a com.esri.arcgis.analyst3d.ISceneViewer (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setVideoDuration

public void setVideoDuration(double pSeconds)
                      throws java.io.IOException,
                             AutomationException
The duration of the animation in seconds.

Specified by:
setVideoDuration in interface ISceneVideoExporter
Parameters:
pSeconds - The pSeconds (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getVideoDuration

public double getVideoDuration()
                        throws java.io.IOException,
                               AutomationException
The duration of the animation in seconds.

Specified by:
getVideoDuration in interface ISceneVideoExporter
Returns:
The pSeconds
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFrameRate

public void setFrameRate(int pImagesPerSecond)
                  throws java.io.IOException,
                         AutomationException
The frame rate in images per second.

Specified by:
setFrameRate in interface ISceneVideoExporter
Parameters:
pImagesPerSecond - The pImagesPerSecond (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFrameRate

public int getFrameRate()
                 throws java.io.IOException,
                        AutomationException
The frame rate in images per second.

Specified by:
getFrameRate in interface ISceneVideoExporter
Returns:
The pImagesPerSecond
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUseCustomSize

public void setUseCustomSize(boolean pbUseCustomSize)
                      throws java.io.IOException,
                             AutomationException
Indicates if a custom image size should be used.

Specified by:
setUseCustomSize in interface ISceneVideoExporter
Parameters:
pbUseCustomSize - The pbUseCustomSize (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseCustomSize

public boolean isUseCustomSize()
                        throws java.io.IOException,
                               AutomationException
Indicates if a custom image size should be used.

Specified by:
isUseCustomSize in interface ISceneVideoExporter
Returns:
The pbUseCustomSize
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

putCustomSize

public void putCustomSize(int width,
                          int height)
                   throws java.io.IOException,
                          AutomationException
The custom image size for video export.

Specified by:
putCustomSize in interface ISceneVideoExporter
Parameters:
width - The width (in)
height - The height (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCustomSize

public void getCustomSize(int[] pWidth,
                          int[] pHeight)
                   throws java.io.IOException,
                          AutomationException
The custom image size for video export.

Specified by:
getCustomSize in interface ISceneVideoExporter
Parameters:
pWidth - The pWidth (out: use single element array)
pHeight - The pHeight (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isInstalled

public boolean isInstalled()
                    throws java.io.IOException,
                           AutomationException
Indicates if the video exporter is installed.

Specified by:
isInstalled in interface IVideoExporterProperties
Returns:
The pbIsInstalled
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCodecList

public IStringArray getCodecList()
                          throws java.io.IOException,
                                 AutomationException
The list of names of available codecs.

Specified by:
getCodecList in interface IVideoExporterProperties
Returns:
A reference to a com.esri.arcgis.system.IStringArray
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCodecCodeList

public IStringArray getCodecCodeList()
                              throws java.io.IOException,
                                     AutomationException
The list of unique codes of available codecs.

Specified by:
getCodecCodeList in interface IVideoExporterProperties
Returns:
A reference to a com.esri.arcgis.system.IStringArray
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCodec

public void setCodec(java.lang.String pCodecName)
              throws java.io.IOException,
                     AutomationException
The current video codec.

Specified by:
setCodec in interface IVideoExporterProperties
Parameters:
pCodecName - The pCodecName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCodec

public java.lang.String getCodec()
                          throws java.io.IOException,
                                 AutomationException
The current video codec.

Specified by:
getCodec in interface IVideoExporterProperties
Returns:
The pCodecName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCodecCode

public void setCodecCode(java.lang.String pCodecCode)
                  throws java.io.IOException,
                         AutomationException
The current video codec's unique code.

Specified by:
setCodecCode in interface IVideoExporterProperties
Parameters:
pCodecCode - The pCodecCode (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCodecCode

public java.lang.String getCodecCode()
                              throws java.io.IOException,
                                     AutomationException
The current video codec's unique code.

Specified by:
getCodecCode in interface IVideoExporterProperties
Returns:
The pCodecCode
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setColorDepth

public void setColorDepth(short pColorDepth)
                   throws java.io.IOException,
                          AutomationException
The number of bits per pixel in each video frame.

Specified by:
setColorDepth in interface IVideoExporterProperties
Parameters:
pColorDepth - The pColorDepth (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getColorDepth

public short getColorDepth()
                    throws java.io.IOException,
                           AutomationException
The number of bits per pixel in each video frame.

Specified by:
getColorDepth in interface IVideoExporterProperties
Returns:
The pColorDepth
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setQuality

public void setQuality(int pQualityPercent)
                throws java.io.IOException,
                       AutomationException
The quality of video compression (1-100). 200 - Lossless.

Specified by:
setQuality in interface IAVIExporter
Specified by:
setQuality in interface IVideoExporterProperties
Parameters:
pQualityPercent - The pQualityPercent (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getQuality

public int getQuality()
               throws java.io.IOException,
                      AutomationException
The quality of video compression (1-100). 200 - Lossless.

Specified by:
getQuality in interface IAVIExporter
Specified by:
getQuality in interface IVideoExporterProperties
Returns:
The pQualityPercent
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setKeyFrameRate

public void setKeyFrameRate(int pKeyFrameRate)
                     throws java.io.IOException,
                            AutomationException
The frequency of keyframes in the video.

Specified by:
setKeyFrameRate in interface IVideoExporterProperties
Parameters:
pKeyFrameRate - The pKeyFrameRate (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getKeyFrameRate

public int getKeyFrameRate()
                    throws java.io.IOException,
                           AutomationException
The frequency of keyframes in the video.

Specified by:
getKeyFrameRate in interface IVideoExporterProperties
Returns:
The pKeyFrameRate
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDataRate

public void setDataRate(int pDataRate)
                 throws java.io.IOException,
                        AutomationException
The maximum number of bytes per second.

Specified by:
setDataRate in interface IVideoExporterProperties
Parameters:
pDataRate - The pDataRate (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDataRate

public int getDataRate()
                throws java.io.IOException,
                       AutomationException
The maximum number of bytes per second.

Specified by:
getDataRate in interface IVideoExporterProperties
Returns:
The pDataRate
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFrameDuration

public void setFrameDuration(int pFrameDuration)
                      throws java.io.IOException,
                             AutomationException
The duration of each frame in milliseconds.

Specified by:
setFrameDuration in interface IVideoExporterProperties
Parameters:
pFrameDuration - The pFrameDuration (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFrameDuration

public int getFrameDuration()
                     throws java.io.IOException,
                            AutomationException
The duration of each frame in milliseconds.

Specified by:
getFrameDuration in interface IVideoExporterProperties
Returns:
The pFrameDuration
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRecordWindow

public void setRecordWindow(boolean pbRecordAppWindow)
                     throws java.io.IOException,
                            AutomationException
Indicates if entire window is to be recorded.

Specified by:
setRecordWindow in interface IVideoExporterProperties
Parameters:
pbRecordAppWindow - The pbRecordAppWindow (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isRecordWindow

public boolean isRecordWindow()
                       throws java.io.IOException,
                              AutomationException
Indicates if entire window is to be recorded.

Specified by:
isRecordWindow in interface IVideoExporterProperties
Returns:
The pbRecordAppWindow
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRecordOffScreen

public void setRecordOffScreen(boolean pbRecordOffScreen)
                        throws java.io.IOException,
                               AutomationException
Indicates if video is to be recorded offscreen.

Specified by:
setRecordOffScreen in interface IVideoExporterProperties
Parameters:
pbRecordOffScreen - The pbRecordOffScreen (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isRecordOffScreen

public boolean isRecordOffScreen()
                          throws java.io.IOException,
                                 AutomationException
Indicates if video is to be recorded offscreen.

Specified by:
isRecordOffScreen in interface IVideoExporterProperties
Returns:
The pbRecordOffScreen
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowSettingsDialog

public void setShowSettingsDialog(boolean pbShowSettingsDialog)
                           throws java.io.IOException,
                                  AutomationException
Indicates if video compression settings dialog is to be displayed.

Specified by:
setShowSettingsDialog in interface IVideoExporterProperties
Parameters:
pbShowSettingsDialog - The pbShowSettingsDialog (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShowSettingsDialog

public boolean isShowSettingsDialog()
                             throws java.io.IOException,
                                    AutomationException
Indicates if video compression settings dialog is to be displayed.

Specified by:
isShowSettingsDialog in interface IVideoExporterProperties
Returns:
The pbShowSettingsDialog
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.