selector-table.rst

Selector Table

Before implementing a handler for a certain selector, make sure that it is really necessary for your importer. Many selectors are optional, and only useful for certain special needs.

The Synth column indicates whether or not the selector is applicable to synthetic importers. Custom importers can respond to any of the selectors.

Selector	param1	param2	Synth
:ref:`importers/selector-descriptions.imInit`	:ref:`imImportInfoRec* <importers/structure-descriptions.imImportInfoRec>`	unused	Yes
:ref:`importers/selector-descriptions.imShutdown`	unused	unused	Yes
:ref:`importers/selector-descriptions.imGetIndFormat`	(int) index	:ref:`imIndFormatRec* <importers/structure-descriptions.imIndFormatRec>`	Yes
:ref:`importers/selector-descriptions.imGetSupports8`	unused	unused	Yes
:ref:`importers/selector-descriptions.imGetSupports7`	unused	unused	Yes
:ref:`importers/selector-descriptions.imGetInfo8`	:ref:`imFileAccessRec8* <importers/structure-descriptions.imFileAccessRec8>`	:ref:`imFileInfoRec8* <importers/structure-descriptions.imFileInfoRec8>`	Yes
:ref:`importers/selector-descriptions.imCloseFile`	:ref:`imFileRef* <importers/structure-descriptions.imFileRef>`	(void*) PrivateData**	No
:ref:`importers/selector-descriptions.imGetIndPixelFormat`	(int) index	:ref:`imIndPixelFormatRec* <importers/structure-descriptions.imIndPixelFormatRec>`	Yes
:ref:`importers/selector-descriptions.imGetPreferredFrameSize`	:ref:`imPreferredFrameSizeRec* <importers/structure-descriptions.imPreferredFrameSizeRec>`	unused	Yes
:ref:`importers/selector-descriptions.imSelectClipFrameDescriptor`	:ref:`importers/structure-descriptions.imFileRef`	:ref:`imClipFrameDescriptorRec* <importers/structure-descriptions.imClipFrameDescriptorRec>`	Yes
:ref:`importers/selector-descriptions.imGetSourceVideo`	:ref:`importers/structure-descriptions.imFileRef`	:ref:`imSourceVideoRec* <importers/structure-descriptions.imSourceVideoRec>`	Yes
:ref:`importers/selector-descriptions.imCreateAsyncImporter`	:ref:`imAsyncImporterCreationRec* <importers/structure-descriptions.imAsyncImporterCreationRec>`	unused	Yes
:ref:`importers/selector-descriptions.imImportImage`	:ref:`importers/structure-descriptions.imFileRef`	:ref:`imImportImageRec* <importers/structure-descriptions.imImportImageRec>`	Yes
:ref:`importers/selector-descriptions.imImportAudio7`	:ref:`importers/structure-descriptions.imFileRef`	:ref:`imImportAudioRec7* <importers/structure-descriptions.imImportAudioRec7>`	Yes
imResetSequentialAudio	:ref:`importers/structure-descriptions.imFileRef`	:ref:`imImportAudioRec7* <importers/structure-descriptions.imImportAudioRec7>`	Yes
imGetSequentialAudio	:ref:`importers/structure-descriptions.imFileRef`	:ref:`imImportAudioRec7* <importers/structure-descriptions.imImportAudioRec7>`	Yes
:ref:`importers/selector-descriptions.imGetPrefs8`	:ref:`imFileAccessRec8* <importers/structure-descriptions.imFileAccessRec8>`	:ref:`imGetPrefsRec* <importers/structure-descriptions.imGetPrefsRec>`	Yes
:ref:`importers/selector-descriptions.imGetEmbeddedLUT`	(int) index	:ref:`imIndEmbeddedLUTRec* <importers/structure-descriptions.EmbeddedLUTRec>`	Yes

The following selectors are optional, to provide custom file handling:

Selector	param1	param2	Synth
:ref:`importers/selector-descriptions.imOpenFile8`	:ref:`imFileRef* <importers/structure-descriptions.imFileRef>`	:ref:`imFileOpenRec8* <importers/structure-descriptions.imFileOpenRec8>`	No
:ref:`importers/selector-descriptions.imQuietFile`	:ref:`imFileRef* <importers/structure-descriptions.imFileRef>`	(void*) PrivateData**	No
:ref:`importers/selector-descriptions.imSaveFile8`	:ref:`imSaveFileRec8* <importers/structure-descriptions.imSaveFileRec8>`	unused	No
:ref:`importers/selector-descriptions.imDeleteFile`	:ref:`imDeleteFileRec* <importers/structure-descriptions.imDeleteFileRec>`	unused	No

The following selectors are optional, for better support copying and trimming files using the Project Manager:

Selector	param1	param2	Synth
:ref:`importers/selector-descriptions.imCalcSize8`	:ref:`imCalcSizeRec* <importers/structure-descriptions.imCalcSizeRec>`	:ref:`imFileAccessRec8* <importers/structure-descriptions.imFileAccessRec8>`	No
:ref:`importers/selector-descriptions.imCheckTrim8`	:ref:`imCheckTrimRec* <importers/structure-descriptions.imCheckTrimRec>`	:ref:`imFileAccessRec8* <importers/structure-descriptions.imFileAccessRec8>`	No
:ref:`importers/selector-descriptions.imTrimFile8`	:ref:`imFileAccessRec8* <importers/structure-descriptions.imFileAccessRec8>`	:ref:`imTrimFileRec8* <importers/structure-descriptions.imTrimFileRec8>`	No
:ref:`importers/selector-descriptions.imCopyFile`	:ref:`imCopyFileRec* <importers/structure-descriptions.imCopyFileRec>`	unused	No
:ref:`importers/selector-descriptions.imRetargetAccelerator`	:ref:`imAcceleratorRec* <importers/structure-descriptions.imAcceleratorRec>`	unused	No
:ref:`importers/selector-descriptions.imQueryDestinationPath`	:ref:`imQueryDestinationPathRec* <importers/structure-descriptions.imQueryDestinationPathRec>`	unused	No

The following selectors are used for embedded Closed Captioning support:

Selector	param1	param2	Synth
:ref:`importers/selector-descriptions.imInitiateAsyncClosedCaptionScan`	:ref:`importers/structure-descriptions.imFileRef`	:ref:`imInitiateAsyncClosedCaptionScanRec* <importers/structure-descriptions.imInitiateAsyncClosedCaptionScanRec>`	No
:ref:`importers/selector-descriptions.imGetNextClosedCaption`	:ref:`importers/structure-descriptions.imFileRef`	:ref:`imGetNextClosedCaptionRec* <importers/structure-descriptions.imGetNextClosedCaptionRec>`	No
:ref:`importers/selector-descriptions.imCompleteAsyncClosedCaptionScan`	:ref:`importers/structure-descriptions.imFileRef`	:ref:`imCompleteAsyncClosedCaptionScanRec* <importers/structure-descriptions.imCompleteAsyncClosedCaptionScanRec>`	No

The following selectors are optional, useful for a subset of importers:

Selector	param1	param2	Synth
:ref:`importers/selector-descriptions.imAnalysis`	:ref:`importers/structure-descriptions.imFileRef`	:ref:`imAnalysisRec* <importers/structure-descriptions.imAnalysisRec>`	Yes
:ref:`importers/selector-descriptions.imDataRateAnalysis`	:ref:`importers/structure-descriptions.imFileRef`	:ref:`imDataRateAnalysisRec* <importers/structure-descriptions.imDataRateAnalysisRec>`	No
:ref:`importers/selector-descriptions.imGetTimeInfo8`	:ref:`importers/structure-descriptions.imFileRef`	:ref:`imTimeInfoRec8* <importers/structure-descriptions.imTimeInfoRec8>`	No
:ref:`importers/selector-descriptions.imSetTimeInfo8`	:ref:`importers/structure-descriptions.imFileRef`	:ref:`imTimeInfoRec8* <importers/structure-descriptions.imTimeInfoRec8>`	No
:ref:`importers/selector-descriptions.imGetFileAttributes`	:ref:`imFileAttributesRec* <importers/structure-descriptions.imFileAttributesRec>`	unused
:ref:`importers/selector-descriptions.imGetMetaData`	:ref:`importers/structure-descriptions.imFileRef`	:ref:`imMetaDataRec* <importers/structure-descriptions.imMetaDataRec>`	No
:ref:`importers/selector-descriptions.imSetMetaData`	:ref:`importers/structure-descriptions.imFileRef`	:ref:`imMetaDataRec* <importers/structure-descriptions.imMetaDataRec>`	No
imGetRollCrawlInfo	imRollCrawlInfoRec*	unused	Yes
imRollCrawlRenderPage	rollCrawlRenderRec*	unused	Yes
:ref:`importers/selector-descriptions.imDeferredProcessing`	:ref:`imDeferredProcessingRec* <importers/structure-descriptions.imDeferredProcessingRec>`	unused	No
:ref:`importers/selector-descriptions.imGetAudioChannelLayout`	:ref:`importers/structure-descriptions.imFileRef`	:ref:`imGetAudioChannelLayoutRec* <importers/structure-descriptions.imGetAudioChannelLayoutRec>`	Yes
:ref:`importers/selector-descriptions.imGetPeakAudio`	:ref:`importers/structure-descriptions.imFileRef`	:ref:`imPeakAudioRec* <importers/structure-descriptions.imPeakAudioRec>`	Yes
:ref:`importers/selector-descriptions.imQueryContentState`	:ref:`imQueryContentStateRec* <importers/structure-descriptions.imQueryContentStateRec>`	unused	No
:ref:`importers/selector-descriptions.imQueryStreamLabel`	:ref:`imQueryStreamLabelRec* <importers/structure-descriptions.imQueryStreamLabelRec>`	unused	Yes
:ref:`importers/selector-descriptions.imGetIndColorSpace`	(int) index	:ref:`imIndColorSpaceRec* <importers/structure-descriptions.imIndColorSpaceRec>`	Yes

Used only in After Effects:

Selector	param1	param2	Synth
:ref:`importers/selector-descriptions.imGetSubTypeNames`	(csSDK_int32) fileType	:ref:`imSubTypeDescriptionRec* <importers/structure-descriptions.imSubTypeDescriptionRec>`	No
:ref:`importers/selector-descriptions.imGetIndColorProfile`	(int) index	:ref:`imIndColorProfileRec* <importers/structure-descriptions.imIndColorProfileRec>`	No
:ref:`importers/selector-descriptions.imQueryInputFileList`	:ref:`imQueryInputFileListRec* <importers/structure-descriptions.imQueryInputFileListRec>`	unused	No