com.esri.arcgis.animation
Class AnimationExporterAVI

java.lang.Object
  extended by com.esri.arcgis.animation.AnimationExporterAVI
All Implemented Interfaces:
IVideoExporter, IVideoExporter2, IConnectionPointContainer, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class AnimationExporterAVI
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IVideoExporter, IVideoExporter2, IConnectionPointContainer

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

Description 'An exporter of animations 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.animation.IVideoExporter2
IID, IIDcebd50af_a7ec_4c98_b74d_a6b2937b1f06, xxDummy
 
Fields inherited from interface com.esri.arcgis.animation.IVideoExporter
IIDc6c65fc9_4041_4e16_83c6_9f3c9dc13dbd
 
Fields inherited from interface com.esri.arcgis.display.IConnectionPointContainer
IID, IIDb196b284_bab4_101a_b69c_00aa00341d07, xxDummy
 
Constructor Summary
AnimationExporterAVI()
          Constructs a AnimationExporterAVI using ArcGIS Engine.
AnimationExporterAVI(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AnimationExporterAVI theAnimationExporterAVI = (AnimationExporterAVI) obj;
 
Method Summary
 void addIAnimationEventsListener(IAnimationEvents theListener)
          addIAnimationEventsListener.
 void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
          enumConnectionPoints
 boolean equals(java.lang.Object o)
          Compare this object with another
 void exportAnimation(IAGAnimationTracks pTracks, IAGAnimationEnvironment pAnimEnv, IStatusBar pStatusBar)
          Export the animation into a video file.
 void exportVideoFromImages(double duration)
          Export a video from a folder of images.
 void exportVideoFromTimeSlider()
          Export a video from the time slider.
 void findConnectionPoint(GUID riid, IConnectionPoint[] ppCP)
          findConnectionPoint
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.
 int getEndFrame()
          The last frame in frame based export.
 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.
 java.lang.String getImageFolderName()
          The complete path name of the folder with the images to be exported.
 java.lang.String getImageFormat()
          The source format of images to be used when exporting a video.
 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).
 int getStartFrame()
          The first frame in frame based export.
 int getTotalFrames()
          The total frames to be exported.
 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 isResizeExportWindow()
          Indicates if the viewer window is to be resized during video export.
 boolean isShowSettingsDialog()
          Indicates if video compression settings dialog is to be displayed.
 boolean isUseCustomSize()
          Indicates if a custom image size should be used.
 boolean isUseExportFromImages()
          Indicates if export from images is to be used.
 boolean isUseFrameExport()
          Indicates if frame based export is to be used.
 boolean isUseTwoStageExport()
          Indicates if two stage export is to be used.
 boolean isWriteAGVFile()
          Indicates if an AGV file is to be written out during export.
 void putCustomSize(int width, int height)
          The custom image size for video export.
 void release()
          Release a AnimationExporterAVI.
 void removeIAnimationEventsListener(IAnimationEvents theListener)
          removeIAnimationEventsListener.
 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 setEndFrame(int pEndFrame)
          The last frame in frame based export.
 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 setImageFolderName(java.lang.String pImageFolderName)
          The complete path name of the folder with the images to be exported.
 void setImageFormat(java.lang.String pImageFormat)
          The source format of images to be used when exporting a video.
 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 setResizeExportWindow(boolean pbResizeExportWindow)
          Indicates if the viewer window is to be resized during video export.
 void setShowSettingsDialog(boolean pbShowSettingsDialog)
          Indicates if video compression settings dialog is to be displayed.
 void setStartFrame(int pStartFrame)
          The first frame in frame based export.
 void setTotalFrames(int pTotalFrames)
          The total frames to be exported.
 void setUseCustomSize(boolean pbUseCustomSize)
          Indicates if a custom image size should be used.
 void setUseExportFromImages(boolean pbUseExportFromImages)
          Indicates if export from images is to be used.
 void setUseFrameExport(boolean pbUseFrameExport)
          Indicates if frame based export is to be used.
 void setUseTwoStageExport(boolean pbUseTwoStageExport)
          Indicates if two stage export is to be used.
 void setWriteAGVFile(boolean pbWriteAGVFile)
          Indicates if an AGV file is to be written out during export.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AnimationExporterAVI

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

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

AnimationExporterAVI

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

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

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

addIAnimationEventsListener

public void addIAnimationEventsListener(IAnimationEvents theListener)
                                 throws java.io.IOException
addIAnimationEventsListener. Listen to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.animation.IAnimationEvents interface.
Throws:
java.io.IOException - If there are communications problems.

removeIAnimationEventsListener

public void removeIAnimationEventsListener(IAnimationEvents theListener)
                                    throws java.io.IOException
removeIAnimationEventsListener. Stop listening to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.animation.IAnimationEvents interface.
Throws:
java.io.IOException - If there are communications problems.

release

public void release()
Release a AnimationExporterAVI.

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 IVideoExporter
Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

exportAnimation

public void exportAnimation(IAGAnimationTracks pTracks,
                            IAGAnimationEnvironment pAnimEnv,
                            IStatusBar pStatusBar)
                     throws java.io.IOException,
                            AutomationException
Export the animation into a video file.

Specified by:
exportAnimation in interface IVideoExporter
Parameters:
pTracks - A reference to a com.esri.arcgis.animation.IAGAnimationTracks (in)
pAnimEnv - A reference to a com.esri.arcgis.animation.IAGAnimationEnvironment (in)
pStatusBar - A reference to a com.esri.arcgis.system.IStatusBar (in)
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 IVideoExporter
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 IVideoExporter
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 IVideoExporter
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 IVideoExporter
Returns:
The fileName
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 IVideoExporter
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 IVideoExporter
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 IVideoExporter
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 IVideoExporter
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 IVideoExporter
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 IVideoExporter
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 IVideoExporter
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 IVideoExporter
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 IVideoExporter
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 IVideoExporter
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 IVideoExporter
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 IVideoExporter
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 IVideoExporter
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 IVideoExporter
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 IVideoExporter
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 IVideoExporter
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 IVideoExporter
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 IVideoExporter
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 IVideoExporter
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 IVideoExporter
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 IVideoExporter
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 IVideoExporter
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 IVideoExporter
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 IVideoExporter
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 IVideoExporter
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 IVideoExporter
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 IVideoExporter
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 IVideoExporter
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 IVideoExporter
Returns:
The pbShowSettingsDialog
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setResizeExportWindow

public void setResizeExportWindow(boolean pbResizeExportWindow)
                           throws java.io.IOException,
                                  AutomationException
Indicates if the viewer window is to be resized during video export.

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

isResizeExportWindow

public boolean isResizeExportWindow()
                             throws java.io.IOException,
                                    AutomationException
Indicates if the viewer window is to be resized during video export.

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

setUseFrameExport

public void setUseFrameExport(boolean pbUseFrameExport)
                       throws java.io.IOException,
                              AutomationException
Indicates if frame based export is to be used.

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

isUseFrameExport

public boolean isUseFrameExport()
                         throws java.io.IOException,
                                AutomationException
Indicates if frame based export is to be used.

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

setStartFrame

public void setStartFrame(int pStartFrame)
                   throws java.io.IOException,
                          AutomationException
The first frame in frame based export.

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

getStartFrame

public int getStartFrame()
                  throws java.io.IOException,
                         AutomationException
The first frame in frame based export.

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

setEndFrame

public void setEndFrame(int pEndFrame)
                 throws java.io.IOException,
                        AutomationException
The last frame in frame based export.

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

getEndFrame

public int getEndFrame()
                throws java.io.IOException,
                       AutomationException
The last frame in frame based export.

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

setTotalFrames

public void setTotalFrames(int pTotalFrames)
                    throws java.io.IOException,
                           AutomationException
The total frames to be exported.

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

getTotalFrames

public int getTotalFrames()
                   throws java.io.IOException,
                          AutomationException
The total frames to be exported.

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

setUseTwoStageExport

public void setUseTwoStageExport(boolean pbUseTwoStageExport)
                          throws java.io.IOException,
                                 AutomationException
Indicates if two stage export is to be used.

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

isUseTwoStageExport

public boolean isUseTwoStageExport()
                            throws java.io.IOException,
                                   AutomationException
Indicates if two stage export is to be used.

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

setUseExportFromImages

public void setUseExportFromImages(boolean pbUseExportFromImages)
                            throws java.io.IOException,
                                   AutomationException
Indicates if export from images is to be used.

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

isUseExportFromImages

public boolean isUseExportFromImages()
                              throws java.io.IOException,
                                     AutomationException
Indicates if export from images is to be used.

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

setImageFolderName

public void setImageFolderName(java.lang.String pImageFolderName)
                        throws java.io.IOException,
                               AutomationException
The complete path name of the folder with the images to be exported.

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

getImageFolderName

public java.lang.String getImageFolderName()
                                    throws java.io.IOException,
                                           AutomationException
The complete path name of the folder with the images to be exported.

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

setImageFormat

public void setImageFormat(java.lang.String pImageFormat)
                    throws java.io.IOException,
                           AutomationException
The source format of images to be used when exporting a video.

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

getImageFormat

public java.lang.String getImageFormat()
                                throws java.io.IOException,
                                       AutomationException
The source format of images to be used when exporting a video.

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

exportVideoFromImages

public void exportVideoFromImages(double duration)
                           throws java.io.IOException,
                                  AutomationException
Export a video from a folder of images.

Specified by:
exportVideoFromImages in interface IVideoExporter2
Parameters:
duration - The duration (in, optional, pass 0.0 if not required)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setWriteAGVFile

public void setWriteAGVFile(boolean pbWriteAGVFile)
                     throws java.io.IOException,
                            AutomationException
Indicates if an AGV file is to be written out during export.

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

isWriteAGVFile

public boolean isWriteAGVFile()
                       throws java.io.IOException,
                              AutomationException
Indicates if an AGV file is to be written out during export.

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

exportVideoFromTimeSlider

public void exportVideoFromTimeSlider()
                               throws java.io.IOException,
                                      AutomationException
Export a video from the time slider.

Specified by:
exportVideoFromTimeSlider in interface IVideoExporter2
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws java.io.IOException,
                                 AutomationException
enumConnectionPoints

Specified by:
enumConnectionPoints in interface IConnectionPointContainer
Parameters:
ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws java.io.IOException,
                                AutomationException
findConnectionPoint

Specified by:
findConnectionPoint in interface IConnectionPointContainer
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.