Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.animation
Interface IVideoExporter

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
IVideoExporter2
All Known Implementing Classes:
AnimationExporterAVI, AnimationExporterQT, AnimationExporterSeqImages, IVideoExporter2Proxy, IVideoExporterProxy
public interface IVideoExporter
extends java.io.Serializable

COM Interface 'IVideoExporter'. Generated 3/19/2015 1:20:51 PM from 'C:\ArcGIS\COM\esriAnimation.olb'

Description: 'Provides access to members that control the video exporters.' 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 =

Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IIDc6c65fc9_4041_4e16_83c6_9f3c9dc13dbd
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void exportAnimation(IAGAnimationTracks pTracks, IAGAnimationEnvironment pAnimEnv, IStatusBar pStatusBar)
          Export the animation into a video file.
 java.lang.String getCodec()
          The current video codec.
 java.lang.String getCodecCode()
          The current video codec's unique code.
 IStringArray getCodecCodeList()
          The list of unique codes of available codecs.
 IStringArray getCodecList()
          The list of names of available codecs.
 short getColorDepth()
          The number of bits per pixel in each video frame.
 void getCustomSize(int[] pWidth, int[] pHeight)
          The custom image size for video export.
 int getDataRate()
          The maximum number of bytes per second.
 java.lang.String getExportFileName()
          The exported file name.
 java.lang.String getFileExtension()
          The file extension associated with the current exporter.
 java.lang.String getFilter()
          The filter string used in the CFileDialog class.
 int getFrameDuration()
          The duration of each frame in milliseconds.
 int getFrameRate()
          The frame rate in images per second.
 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).
 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.
 void putCustomSize(int width, int height)
          The custom image size for video export.
 void setCodec(java.lang.String pCodecName)
          The current video codec.
 void setCodecCode(java.lang.String pCodecCode)
          The current video codec's unique code.
 void setColorDepth(short pColorDepth)
          The number of bits per pixel in each video frame.
 void setDataRate(int pDataRate)
          The maximum number of bytes per second.
 void setExportFileName(java.lang.String fileName)
          The exported file name.
 void setFrameDuration(int pFrameDuration)
          The duration of each frame in milliseconds.
 void setFrameRate(int pImagesPerSecond)
          The frame rate in images per second.
 void setKeyFrameRate(int pKeyFrameRate)
          The frequency of keyframes in the video.
 void setQuality(int pQualityPercent)
          The quality of video compression (1-100).
 void setRecordOffScreen(boolean pbRecordOffScreen)
          Indicates if video is to be recorded offscreen.
 void setRecordWindow(boolean pbRecordAppWindow)
          Indicates if entire window is to be recorded.
 void 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 setUseCustomSize(boolean pbUseCustomSize)
          Indicates if a custom image size should be used.
 

Field Detail

IIDc6c65fc9_4041_4e16_83c6_9f3c9dc13dbd

static final int IIDc6c65fc9_4041_4e16_83c6_9f3c9dc13dbd
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

getName

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

Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

exportAnimation

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

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

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

Returns:
The filter
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFileExtension

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

Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExportFileName

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

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

getExportFileName

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

Returns:
The fileName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFrameRate

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

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

getFrameRate

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

Returns:
The pImagesPerSecond
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUseCustomSize

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

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

isUseCustomSize

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

Returns:
The pbUseCustomSize
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

putCustomSize

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

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

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

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

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

Returns:
The pbIsInstalled
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCodecList

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

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

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

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

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

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

getCodec

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

Returns:
The pCodecName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCodecCode

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

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

getCodecCode

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

Returns:
The pCodecCode
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setColorDepth

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

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

getColorDepth

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

Returns:
The pColorDepth
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setQuality

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

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

getQuality

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

Returns:
The pQualityPercent
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setKeyFrameRate

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

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

getKeyFrameRate

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

Returns:
The pKeyFrameRate
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDataRate

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

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

getDataRate

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

Returns:
The pDataRate
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFrameDuration

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

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

getFrameDuration

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

Returns:
The pFrameDuration
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRecordWindow

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

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

isRecordWindow

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

Returns:
The pbRecordAppWindow
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRecordOffScreen

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

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

isRecordOffScreen

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

Returns:
The pbRecordOffScreen
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowSettingsDialog

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

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

isShowSettingsDialog

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

Returns:
The pbShowSettingsDialog
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setResizeExportWindow

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

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

isResizeExportWindow

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

Returns:
The pbResizeExportWindow
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD