com.esri.arcgis.animation
Interface IVideoExporter2

All Superinterfaces:

IVideoExporter, Serializable

All Known Implementing Classes:

AnimationExporterAVI, AnimationExporterQT, AnimationExporterSeqImages

public interface IVideoExporter2
extends IVideoExporter, Serializable

Provides access to members that control the video exporters.

Product Availability

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

Method Summary

void	exportVideoFromImages(double duration) Export a video from a folder of images.
void	exportVideoFromTimeSlider() Export a video from the time slider.
int	getEndFrame() The last frame in frame based export.
String	getImageFolderName() The complete path name of the folder with the images to be exported.
String	getImageFormat() The source format of images to be used when exporting a video.
int	getStartFrame() The first frame in frame based export.
int	getTotalFrames() The total frames to be exported.
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	setEndFrame(int pEndFrame) The last frame in frame based export.
void	setImageFolderName(String pImageFolderName) The complete path name of the folder with the images to be exported.
void	setImageFormat(String pImageFormat) The source format of images to be used when exporting a video.
void	setStartFrame(int pStartFrame) The first frame in frame based export.
void	setTotalFrames(int pTotalFrames) The total frames to be exported.
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 interface com.esri.arcgis.animation.IVideoExporter

exportAnimation, getCodec, getCodecCode, getCodecCodeList, getCodecList, getColorDepth, getCustomSize, getDataRate, getExportFileName, getFileExtension, getFilter, getFrameDuration, getFrameRate, getKeyFrameRate, getName, getQuality, isInstalled, isRecordOffScreen, isRecordWindow, isResizeExportWindow, isShowSettingsDialog, isUseCustomSize, putCustomSize, setCodec, setCodecCode, setColorDepth, setDataRate, setExportFileName, setFrameDuration, setFrameRate, setKeyFrameRate, setQuality, setRecordOffScreen, setRecordWindow, setResizeExportWindow, setShowSettingsDialog, setUseCustomSize

Method Detail

setUseFrameExport

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.

Parameters:

pbUseFrameExport - The pbUseFrameExport (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseFrameExport

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.

Returns:

The pbUseFrameExport

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStartFrame

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.

Parameters:

pStartFrame - The pStartFrame (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStartFrame

int getStartFrame()
                  throws IOException,
                         AutomationException

The first frame in frame based export.

Product Availability

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

Returns:

The pStartFrame

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEndFrame

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.

Parameters:

pEndFrame - The pEndFrame (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEndFrame

int getEndFrame()
                throws IOException,
                       AutomationException

The last frame in frame based export.

Product Availability

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

Returns:

The pEndFrame

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTotalFrames

void setTotalFrames(int pTotalFrames)
                    throws IOException,
                           AutomationException

The total frames to be exported.

Product Availability

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

Parameters:

pTotalFrames - The pTotalFrames (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTotalFrames

int getTotalFrames()
                   throws IOException,
                          AutomationException

The total frames to be exported.

Product Availability

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

Returns:

The pTotalFrames

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseTwoStageExport

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.

Parameters:

pbUseTwoStageExport - The pbUseTwoStageExport (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseTwoStageExport

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.

Returns:

The pbUseTwoStageExport

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseExportFromImages

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.

Parameters:

pbUseExportFromImages - The pbUseExportFromImages (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseExportFromImages

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.

Returns:

The pbUseExportFromImages

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setImageFolderName

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.

Parameters:

pImageFolderName - The pImageFolderName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getImageFolderName

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.

Returns:

The pImageFolderName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setImageFormat

void setImageFormat(String pImageFormat)
                    throws IOException,
                           AutomationException

The source format of images to be used when exporting a video.

Product Availability

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

Parameters:

pImageFormat - The pImageFormat (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getImageFormat

String getImageFormat()
                      throws IOException,
                             AutomationException

The source format of images to be used when exporting a video.

Product Availability

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

Returns:

The pImageFormat

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exportVideoFromImages

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.

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

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.

Parameters:

pbWriteAGVFile - The pbWriteAGVFile (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isWriteAGVFile

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.

Returns:

The pbWriteAGVFile

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exportVideoFromTimeSlider

void exportVideoFromTimeSlider()
                               throws IOException,
                                      AutomationException

Export a video from the time slider.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.