com.esri.arcgis.animation
Class AnimationExporterSeqImages

java.lang.Object
  com.esri.arcgis.animation.AnimationExporterSeqImages

All Implemented Interfaces:

ISequentialImageExporter, IVideoExporter, IVideoExporter2, IConnectionPointContainer, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class AnimationExporterSeqImages
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISequentialImageExporter, IVideoExporter2, IConnectionPointContainer

An exporter of animations to a folder of sequential images.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:

Serialized Form

Constructor Summary

AnimationExporterSeqImages()
Constructs a AnimationExporterSeqImages using ArcGIS Engine.

AnimationExporterSeqImages(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AnimationExporterSeqImages theAnimationExporterSeqImages = (AnimationExporterSeqImages) obj;

Method Summary

void	addIAnimationEventsListener(IAnimationEvents theListener) addIAnimationEventsListener.
void	enumConnectionPoints(IEnumConnectionPoints[] ppEnum) enumConnectionPoints
boolean	equals(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 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.
int	getEndFrame() The last frame in frame based export.
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.
String	getFolderName() The folder name to be used during sequential image export.
int	getFolderSize() The folder size to be written during sequential image export.
int	getFrameDuration() The duration of each frame in milliseconds.
int	getFrameRate() The frame rate in images per second.
int	getImageCount() The number of images to be exported during sequential image export.
String	getImageFolderName() The complete path name of the folder with the images to be exported.
String	getImageFormat() The image format to be used during sequential image export.
String	getImagePrefix() The image prefix to be used during sequential image export.
int	getImagesPerSecond() The images per second to be exported during sequential image export.
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).
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	removeIAnimationEventsListener(IAnimationEvents theListener) removeIAnimationEventsListener.
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	setEndFrame(int pEndFrame) The last frame in frame based export.
void	setExportFileName(String fileName) The exported file name.
void	setFolderName(String pFolderName) The folder name to be used during sequential image export.
void	setFrameDuration(int pFrameDuration) The duration of each frame in milliseconds.
void	setFrameRate(int pImagesPerSecond) The frame rate in images per second.
void	setImageFolderName(String pImageFolderName) The complete path name of the folder with the images to be exported.
void	setImageFormat(String pImageFormat) The image format to be used during sequential image export.
void	setImagePrefix(String pImagePrefix) The image prefix to be used during sequential image export.
void	setImagesPerSecond(int pImagesPerSecond) The images per second to be exported during sequential image export.
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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

AnimationExporterSeqImages

public AnimationExporterSeqImages()
                           throws IOException,
                                  UnknownHostException

Constructs a AnimationExporterSeqImages using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

AnimationExporterSeqImages

public AnimationExporterSeqImages(Object obj)
                           throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AnimationExporterSeqImages theAnimationExporterSeqImages = (AnimationExporterSeqImages) obj;

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

addIAnimationEventsListener

public void addIAnimationEventsListener(IAnimationEvents theListener)
                                 throws IOException

addIAnimationEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.animation.IAnimationEvents interface.

Throws:

IOException - If there are communications problems.

removeIAnimationEventsListener

public void removeIAnimationEventsListener(IAnimationEvents theListener)
                                    throws IOException

removeIAnimationEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.animation.IAnimationEvents interface.

Throws:

IOException - If there are communications problems.

setFolderName

public void setFolderName(String pFolderName)
                   throws IOException,
                          AutomationException

The folder name to be used during sequential image export.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setFolderName in interface ISequentialImageExporter

Parameters:

pFolderName - The pFolderName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFolderName

public String getFolderName()
                     throws IOException,
                            AutomationException

The folder name to be used during sequential image export.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getFolderName in interface ISequentialImageExporter

Returns:

The pFolderName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setImagePrefix

public void setImagePrefix(String pImagePrefix)
                    throws IOException,
                           AutomationException

The image prefix to be used during sequential image export.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setImagePrefix in interface ISequentialImageExporter

Parameters:

pImagePrefix - The pImagePrefix (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getImagePrefix

public String getImagePrefix()
                      throws IOException,
                             AutomationException

The image prefix to be used during sequential image export.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getImagePrefix in interface ISequentialImageExporter

Returns:

The pImagePrefix

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setImageFormat

public void setImageFormat(String pImageFormat)
                    throws IOException,
                           AutomationException

The image format to be used during sequential image export.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setImageFormat in interface ISequentialImageExporter

Specified by:

setImageFormat in interface IVideoExporter2

Parameters:

pImageFormat - The pImageFormat (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getImageFormat

public String getImageFormat()
                      throws IOException,
                             AutomationException

The image format to be used during sequential image export.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getImageFormat in interface ISequentialImageExporter

Specified by:

getImageFormat in interface IVideoExporter2

Returns:

The pImageFormat

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setImagesPerSecond

public void setImagesPerSecond(int pImagesPerSecond)
                        throws IOException,
                               AutomationException

The images per second to be exported during sequential image export.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setImagesPerSecond in interface ISequentialImageExporter

Parameters:

pImagesPerSecond - The pImagesPerSecond (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getImagesPerSecond

public int getImagesPerSecond()
                       throws IOException,
                              AutomationException

The images per second to be exported during sequential image export.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getImagesPerSecond in interface ISequentialImageExporter

Returns:

The pImagesPerSecond

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getImageCount

public int getImageCount()
                  throws IOException,
                         AutomationException

The number of images to be exported during sequential image export.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getImageCount in interface ISequentialImageExporter

Returns:

The pImageCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFolderSize

public int getFolderSize()
                  throws IOException,
                         AutomationException

The folder size to be written during sequential image export.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getFolderSize in interface ISequentialImageExporter

Returns:

The pFolderSize

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseFrameExport

public void setUseFrameExport(boolean pbUseFrameExport)
                       throws IOException,
                              AutomationException

Indicates if frame based export is to be used.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setUseFrameExport in interface IVideoExporter2

Parameters:

pbUseFrameExport - The pbUseFrameExport (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseFrameExport

public boolean isUseFrameExport()
                         throws IOException,
                                AutomationException

Indicates if frame based export is to be used.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isUseFrameExport in interface IVideoExporter2

Returns:

The pbUseFrameExport

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStartFrame

public void setStartFrame(int pStartFrame)
                   throws IOException,
                          AutomationException

The first frame in frame based export.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setStartFrame in interface IVideoExporter2

Parameters:

pStartFrame - The pStartFrame (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStartFrame

public int getStartFrame()
                  throws IOException,
                         AutomationException

The first frame in frame based export.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getStartFrame in interface IVideoExporter2

Returns:

The pStartFrame

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEndFrame

public void setEndFrame(int pEndFrame)
                 throws IOException,
                        AutomationException

The last frame in frame based export.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setEndFrame in interface IVideoExporter2

Parameters:

pEndFrame - The pEndFrame (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEndFrame

public int getEndFrame()
                throws IOException,
                       AutomationException

The last frame in frame based export.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getEndFrame in interface IVideoExporter2

Returns:

The pEndFrame

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTotalFrames

public void setTotalFrames(int pTotalFrames)
                    throws IOException,
                           AutomationException

The total frames to be exported.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setTotalFrames in interface IVideoExporter2

Parameters:

pTotalFrames - The pTotalFrames (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTotalFrames

public int getTotalFrames()
                   throws IOException,
                          AutomationException

The total frames to be exported.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getTotalFrames in interface IVideoExporter2

Returns:

The pTotalFrames

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseTwoStageExport

public void setUseTwoStageExport(boolean pbUseTwoStageExport)
                          throws IOException,
                                 AutomationException

Indicates if two stage export is to be used.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setUseTwoStageExport in interface IVideoExporter2

Parameters:

pbUseTwoStageExport - The pbUseTwoStageExport (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseTwoStageExport

public boolean isUseTwoStageExport()
                            throws IOException,
                                   AutomationException

Indicates if two stage export is to be used.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isUseTwoStageExport in interface IVideoExporter2

Returns:

The pbUseTwoStageExport

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseExportFromImages

public void setUseExportFromImages(boolean pbUseExportFromImages)
                            throws IOException,
                                   AutomationException

Indicates if export from images is to be used.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setUseExportFromImages in interface IVideoExporter2

Parameters:

pbUseExportFromImages - The pbUseExportFromImages (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseExportFromImages

public boolean isUseExportFromImages()
                              throws IOException,
                                     AutomationException

Indicates if export from images is to be used.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isUseExportFromImages in interface IVideoExporter2

Returns:

The pbUseExportFromImages

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setImageFolderName

public void setImageFolderName(String pImageFolderName)
                        throws IOException,
                               AutomationException

The complete path name of the folder with the images to be exported.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setImageFolderName in interface IVideoExporter2

Parameters:

pImageFolderName - The pImageFolderName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getImageFolderName

public String getImageFolderName()
                          throws IOException,
                                 AutomationException

The complete path name of the folder with the images to be exported.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getImageFolderName in interface IVideoExporter2

Returns:

The pImageFolderName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exportVideoFromImages

public void exportVideoFromImages(double duration)
                           throws IOException,
                                  AutomationException

Export a video from a folder of images.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

exportVideoFromImages in interface IVideoExporter2

Parameters:

duration - The duration (in, optional, pass 0.0 if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWriteAGVFile

public void setWriteAGVFile(boolean pbWriteAGVFile)
                     throws IOException,
                            AutomationException

Indicates if an AGV file is to be written out during export.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setWriteAGVFile in interface IVideoExporter2

Parameters:

pbWriteAGVFile - The pbWriteAGVFile (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isWriteAGVFile

public boolean isWriteAGVFile()
                       throws IOException,
                              AutomationException

Indicates if an AGV file is to be written out during export.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isWriteAGVFile in interface IVideoExporter2

Returns:

The pbWriteAGVFile

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exportVideoFromTimeSlider

public void exportVideoFromTimeSlider()
                               throws IOException,
                                      AutomationException

Export a video from the time slider.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

exportVideoFromTimeSlider in interface IVideoExporter2

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

The name of the exporter.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getName in interface IVideoExporter

Returns:

The name

Throws:

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 IOException,
                            AutomationException

Export the animation into a video file.

Remarks

Note that the animation exporting honors the animation environment settings. When exporting to an animation to a video, you need to specify the output file name and the CodecCode used in compression. Optionally, you can set other video properties such as the frame rate, quality, etc.

If you choose to use custom size for the video, first you need to set the UseCustomSize property to true before calling the PutCustomSize method.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFilter

public String getFilter()
                 throws IOException,
                        AutomationException

The filter string used in the CFileDialog class.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getFilter in interface IVideoExporter

Returns:

The filter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFileExtension

public String getFileExtension()
                        throws IOException,
                               AutomationException

The file extension associated with the current exporter.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getFileExtension in interface IVideoExporter

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExportFileName

public void setExportFileName(String fileName)
                       throws IOException,
                              AutomationException

The exported file name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setExportFileName in interface IVideoExporter

Parameters:

fileName - The fileName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExportFileName

public String getExportFileName()
                         throws IOException,
                                AutomationException

The exported file name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getExportFileName in interface IVideoExporter

Returns:

The fileName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFrameRate

public void setFrameRate(int pImagesPerSecond)
                  throws IOException,
                         AutomationException

The frame rate in images per second.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setFrameRate in interface IVideoExporter

Parameters:

pImagesPerSecond - The pImagesPerSecond (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFrameRate

public int getFrameRate()
                 throws IOException,
                        AutomationException

The frame rate in images per second.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getFrameRate in interface IVideoExporter

Returns:

The pImagesPerSecond

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseCustomSize

public void setUseCustomSize(boolean pbUseCustomSize)
                      throws IOException,
                             AutomationException

Indicates if a custom image size should be used.

Remarks

If you choose to use custom size for the video, first you need to set the UseCustomSize property to true before calling the PutCustomSize method, as shown by the following code segment:

'To use custom size during the exporting, set the UseCustomSize property to true first

pVideoExporter.UseCustomSize = True

'then call the PutCustomSize method

Call pVideoExporter.PutCustomSize(500, 500)

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setUseCustomSize in interface IVideoExporter

Parameters:

pbUseCustomSize - The pbUseCustomSize (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseCustomSize

public boolean isUseCustomSize()
                        throws IOException,
                               AutomationException

Indicates if a custom image size should be used.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isUseCustomSize in interface IVideoExporter

Returns:

The pbUseCustomSize

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putCustomSize

public void putCustomSize(int width,
                          int height)
                   throws IOException,
                          AutomationException

The custom image size for video export.

Remarks

If you choose to use custom size for the video, first you need to set the UseCustomSize property to true before calling the PutCustomSize method, as shown by the following code segment:

'To use custom size during the exporting, set the UseCustomSize property to true first

pVideoExporter.UseCustomSize = True

'then call the PutCustomSize method

Call pVideoExporter.PutCustomSize(500, 500)

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

putCustomSize in interface IVideoExporter

Parameters:

width - The width (in)

height - The height (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCustomSize

public void getCustomSize(int[] pWidth,
                          int[] pHeight)
                   throws IOException,
                          AutomationException

The custom image size for video export.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getCustomSize in interface IVideoExporter

Parameters:

pWidth - The pWidth (out: use single element array)

pHeight - The pHeight (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isInstalled

public boolean isInstalled()
                    throws IOException,
                           AutomationException

Indicates if the video exporter is installed.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isInstalled in interface IVideoExporter

Returns:

The pbIsInstalled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCodecList

public IStringArray getCodecList()
                          throws IOException,
                                 AutomationException

The list of names of available codecs.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getCodecList in interface IVideoExporter

Returns:

A reference to a com.esri.arcgis.system.IStringArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCodecCodeList

public IStringArray getCodecCodeList()
                              throws IOException,
                                     AutomationException

The list of unique codes of available codecs.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getCodecCodeList in interface IVideoExporter

Returns:

A reference to a com.esri.arcgis.system.IStringArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCodec

public void setCodec(String pCodecName)
              throws IOException,
                     AutomationException

The current video codec.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setCodec in interface IVideoExporter

Parameters:

pCodecName - The pCodecName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCodec

public String getCodec()
                throws IOException,
                       AutomationException

The current video codec.

Remarks

For AnimationExporterAVI, the default codec used by the video exporter is related to the quality setting. If the quality is below 90, then the Intel Indeo(R) Video R3.2 codec is used. Otherwise, the Cinepak Codec by Radius codec is used.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getCodec in interface IVideoExporter

Returns:

The pCodecName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCodecCode

public void setCodecCode(String pCodecCode)
                  throws IOException,
                         AutomationException

The current video codec's unique code.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setCodecCode in interface IVideoExporter

Parameters:

pCodecCode - The pCodecCode (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCodecCode

public String getCodecCode()
                    throws IOException,
                           AutomationException

The current video codec's unique code.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getCodecCode in interface IVideoExporter

Returns:

The pCodecCode

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setColorDepth

public void setColorDepth(short pColorDepth)
                   throws IOException,
                          AutomationException

The number of bits per pixel in each video frame.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setColorDepth in interface IVideoExporter

Parameters:

pColorDepth - The pColorDepth (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColorDepth

public short getColorDepth()
                    throws IOException,
                           AutomationException

The number of bits per pixel in each video frame.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getColorDepth in interface IVideoExporter

Returns:

The pColorDepth

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setQuality

public void setQuality(int pQualityPercent)
                throws IOException,
                       AutomationException

The quality of video compression (1-100). 200 - Lossless.

Remarks

This property is used to control the quality of the exported video, which ranges from 0 to 100. For AVI exporter (AnimationExporterAVI), the default value is 90. For QuickTime exporter, the default value is 50.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setQuality in interface IVideoExporter

Parameters:

pQualityPercent - The pQualityPercent (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getQuality

public int getQuality()
               throws IOException,
                      AutomationException

The quality of video compression (1-100). 200 - Lossless.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getQuality in interface IVideoExporter

Returns:

The pQualityPercent

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setKeyFrameRate

public void setKeyFrameRate(int pKeyFrameRate)
                     throws IOException,
                            AutomationException

The frequency of keyframes in the video.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setKeyFrameRate in interface IVideoExporter

Parameters:

pKeyFrameRate - The pKeyFrameRate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getKeyFrameRate

public int getKeyFrameRate()
                    throws IOException,
                           AutomationException

The frequency of keyframes in the video.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getKeyFrameRate in interface IVideoExporter

Returns:

The pKeyFrameRate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDataRate

public void setDataRate(int pDataRate)
                 throws IOException,
                        AutomationException

The maximum number of bytes per second.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setDataRate in interface IVideoExporter

Parameters:

pDataRate - The pDataRate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataRate

public int getDataRate()
                throws IOException,
                       AutomationException

The maximum number of bytes per second.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getDataRate in interface IVideoExporter

Returns:

The pDataRate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFrameDuration

public void setFrameDuration(int pFrameDuration)
                      throws IOException,
                             AutomationException

The duration of each frame in milliseconds.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setFrameDuration in interface IVideoExporter

Parameters:

pFrameDuration - The pFrameDuration (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFrameDuration

public int getFrameDuration()
                     throws IOException,
                            AutomationException

The duration of each frame in milliseconds.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getFrameDuration in interface IVideoExporter

Returns:

The pFrameDuration

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRecordWindow

public void setRecordWindow(boolean pbRecordAppWindow)
                     throws IOException,
                            AutomationException

Indicates if entire window is to be recorded.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setRecordWindow in interface IVideoExporter

Parameters:

pbRecordAppWindow - The pbRecordAppWindow (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRecordWindow

public boolean isRecordWindow()
                       throws IOException,
                              AutomationException

Indicates if entire window is to be recorded.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isRecordWindow in interface IVideoExporter

Returns:

The pbRecordAppWindow

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRecordOffScreen

public void setRecordOffScreen(boolean pbRecordOffScreen)
                        throws IOException,
                               AutomationException

Indicates if video is to be recorded offscreen.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setRecordOffScreen in interface IVideoExporter

Parameters:

pbRecordOffScreen - The pbRecordOffScreen (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRecordOffScreen

public boolean isRecordOffScreen()
                          throws IOException,
                                 AutomationException

Indicates if video is to be recorded offscreen.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isRecordOffScreen in interface IVideoExporter

Returns:

The pbRecordOffScreen

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowSettingsDialog

public void setShowSettingsDialog(boolean pbShowSettingsDialog)
                           throws IOException,
                                  AutomationException

Indicates if video compression settings dialog is to be displayed.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setShowSettingsDialog in interface IVideoExporter

Parameters:

pbShowSettingsDialog - The pbShowSettingsDialog (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowSettingsDialog

public boolean isShowSettingsDialog()
                             throws IOException,
                                    AutomationException

Indicates if video compression settings dialog is to be displayed.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isShowSettingsDialog in interface IVideoExporter

Returns:

The pbShowSettingsDialog

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setResizeExportWindow

public void setResizeExportWindow(boolean pbResizeExportWindow)
                           throws IOException,
                                  AutomationException

Indicates if the viewer window is to be resized during video export.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setResizeExportWindow in interface IVideoExporter

Parameters:

pbResizeExportWindow - The pbResizeExportWindow (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isResizeExportWindow

public boolean isResizeExportWindow()
                             throws IOException,
                                    AutomationException

Indicates if the viewer window is to be resized during video export.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isResizeExportWindow in interface IVideoExporter

Returns:

The pbResizeExportWindow

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

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

enumConnectionPoints

Description

IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

enumConnectionPoints in interface IConnectionPointContainer

Parameters:

ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

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

findConnectionPoint

Description

IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.