MultimediaExtractor ClassByteScout PDF Extractor SDK
Extracts videos from PDF document.
Inheritance Hierarchy

SystemObject
  Bytescout.PDFExtractorBaseExtractor
    Bytescout.PDFExtractorMultimediaExtractor

Namespace:  Bytescout.PDFExtractor
Assembly:  Bytescout.PDFExtractor (in Bytescout.PDFExtractor.dll) Version: 12.0.0.4062-master
Syntax

public class MultimediaExtractor : BaseExtractor, 
	IMultimediaExtractor

The MultimediaExtractor type exposes the following members.

Constructors

  NameDescription
Public methodMultimediaExtractor
Initializes a new instance of the MultimediaExtractor class.
Public methodMultimediaExtractor(String, String)
Initializes a new instance of the MultimediaExtractor class.
Top
Properties

  NameDescription
Public propertyCheckPermissions
Defines whether to respect permissions set by document owner. If True, extractor throws exception when the extraction is prohibited. IMPORTANT: THIS OPTION HAVE TO BE ENABLED AND SET TO "TRUE" TO RESPECT OWNERS OF PDF DOCUMENTS. IF YOU SET IT TO FALSE TO IGNORE PERMISSIONS WHICH ARE SET IN PDF DOCUMENT THEN YOU ARE SOLELY LIABLE FOR THIS ACTION AND ANY COPYRIGHT OR OTHER VIOLATIONS AT YOUR OWN RISK. BYTESCOUT IS NOT LIABLE FOR ANY DAMAGES, LOSSES, COPYRIGHT INFRINGEMENTS OR ANY OTHER CONSEQUENCES CAUSED BY IGNORING PERMISSIONS OF PDF DOCUMENT. BY CHANGING THIS OPTION YOU ARE CONFIRMING YOU ARE UNDERSTANDING ALL WRITTEN ABOVE AND DOING IT AT YOUR OWN RISK.
(Inherited from BaseExtractor.)
Public propertyComHelpers
Set of utility functions and properties to use from COM/ActiveX.
(Inherited from BaseExtractor.)
Public propertyContentType
Returns content type of PDF document: normal document, portfolio or XFA form. To extract files from PDF portfolio use AttachmentExtractor class. To extract XFA form content use XFAFormExtractor class.
(Inherited from BaseExtractor.)
Public propertyEmbeddedFileCount Obsolete.
Property is disabled to speed up the document loading. Use AttachmentExtractor to work with attachments.
(Inherited from BaseExtractor.)
Public propertyEncrypted
Gets whether the document is encrypted.
(Inherited from BaseExtractor.)
Public propertyExtractionArea
Sets the extraction area by coordinates and dimensions.
(Inherited from BaseExtractor.)
Public propertyExtractionAreaRect
Sets the extraction area by rectangle.
(Inherited from BaseExtractor.)
Public propertyExtractionAreaUsageMode
Controls how an extraction area (if any defined) is used when doing a text search to control if we are searching within any objects intersecting with an area or only within objects completely inside an area
(Inherited from BaseExtractor.)
Public propertyIsDocumentLoaded
Get the document loaded state.
(Inherited from BaseExtractor.)
Public propertyLicenseInfo
Gets license information.
(Inherited from BaseExtractor.)
Public propertyPageDataCaching
Controls page data caching behavior.
(Inherited from BaseExtractor.)
Public propertyPassword
PDF document password.
(Inherited from BaseExtractor.)
Public propertyProfiles
Comma-separated list of profiles to apply to the extractor. Profiles must be previously loaded.
(Inherited from BaseExtractor.)
Public propertyRegistrationKey
Registration key.
(Inherited from BaseExtractor.)
Public propertyRegistrationName
Registration name.
(Inherited from BaseExtractor.)
Public propertyVersion
Gets the component version number.
(Inherited from BaseExtractor.)
Top
Methods

  NameDescription
Public methodCreateProfile(String, Boolean) (Inherited from BaseExtractor.)
Public methodCreateProfile(String, String, Boolean) (Inherited from BaseExtractor.)
Public methodDispose
Releases the unmanaged resources used by the instance and optionally releases the managed resources.
(Inherited from BaseExtractor.)
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Protected methodFireParsingError (Inherited from BaseExtractor.)
Protected methodFireProgressChanged (Inherited from BaseExtractor.)
Public methodGetCurrent3DAsArrayOfBytes
Returns current 3D animation as array of bytes.
Public methodGetCurrent3DBytesSize
Returns size of current 3D animation.
Public methodGetCurrent3DExtension
Gets the current 3D animation file extension.
Public methodGetCurrent3DType
Gets the type of the current 3D animation.
Public methodGetCurrentAudioAsArrayOfBytes
Returns current audio as array of bytes.
Public methodGetCurrentAudioBytesSize
Returns size of current audio.
Public methodGetCurrentAudioExtension
Gets the current audio file extension.
Public methodGetCurrentAudioType
Gets the type of the current audio.
Public methodGetCurrentVideoAsArrayOfBytes
Returns current video as array of bytes.
Public methodGetCurrentVideoBytesSize
Returns size of current video.
Public methodGetCurrentVideoExtension
Gets the current video file extension.
Public methodGetCurrentVideoType
Gets the type of the current video.
Public methodGetDocument3DCount
Returns count of 3D animations in the document.
Public methodGetDocumentAudioCount
Returns count of audios in the document.
Public methodGetDocumentVideoCount
Returns count of videos in the document.
Public methodGetFirst3D
Initializes enumeration of 3D animations in the document. If GetFirst3D() returned true, you can get the video using SaveCurrent3D*() or GetCurrent3D*() methods.
Public methodGetFirstAudio
Initializes enumeration of audios in the document. If GetFirstVideo() returned true, you can get the video using SaveCurrentAudio*() or GetCurrentAudio*() methods.
Public methodGetFirstVideo
Initializes enumeration of videos in the document. If GetFirstVideo() returned true, you can get the video using SaveCurrentVideo*() or GetCurrentVideo*() methods.
Public methodGetHashCode (Inherited from Object.)
Public methodGetNext3D
Advances 3D animations enumeration to next 3D animation object. If GetNext3D() returned true, you can get the 3D animation using SaveCurrent3D*() or GetCurrent3D*() methods.
Public methodGetNextAudio
Advances audio enumeration to next video. If GetNextAudio() returned true, you can get the video using SaveCurrentAudio*() or GetCurrentAudio*() methods.
Public methodGetNextVideo
Advances video enumeration to next video. If GetNextVideo() returned true, you can get the video using SaveCurrentVideo*() or GetCurrentVideo*() methods.
Public methodGetPageCount
Returns document page count.
(Inherited from BaseExtractor.)
Public methodGetPageRect_Height
Gets the specified page height.
(Inherited from BaseExtractor.)
Public methodGetPageRect_Left
Gets the specified page left coordinate.
(Inherited from BaseExtractor.)
Public methodGetPageRect_Top
Gets the specified page top coordinate.
(Inherited from BaseExtractor.)
Public methodGetPageRect_Width
Gets the specified page width.
(Inherited from BaseExtractor.)
Public methodGetPageRectangle(Int32)
Gets the page rectangle in PDF Points (1 Point = 1/72 in.).
(Inherited from BaseExtractor.)
Public methodGetPageRectangle(Int32, Boolean)
Gets the page rectangle in PDF Points (1 Point = 1/72 in.).
(Inherited from BaseExtractor.)
Public methodGetPageRotationAngle
Returns the rotation angle of specified page.
(Inherited from BaseExtractor.)
Public methodGetType (Inherited from Object.)
Public methodIsEncrypted
Gets the document encrypted state.
(Inherited from BaseExtractor.)
Public methodLoadAndApplyProfiles
Loads profiles from JSON string and automatically applies them. Note that profiles containing detection keywords will be deferred until the extraction.
(Inherited from BaseExtractor.)
Public methodLoadDocumentFromFile
Loads PDF document from specified file.
(Inherited from BaseExtractor.)
Public methodLoadDocumentFromStream
Loads PDF document from provided stream.
(Overrides BaseExtractorLoadDocumentFromStream(Stream).)
Public methodLoadProfiles
Loads profiles from JSON file.
(Inherited from BaseExtractor.)
Public methodLoadProfilesFromString
Loads profiles from JSON string.
(Inherited from BaseExtractor.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodReset
Resets the instance, disposes internal resources and releases the file. Use this method before loading another PDF file.
(Overrides BaseExtractorReset.)
Public methodResetExtractionArea
Resets the extraction area to the full page.
(Inherited from BaseExtractor.)
Public methodSaveCurrent3DToFile
Saves current 3D animation to file with specified name.
Public methodSaveCurrent3DToStream
Saves current 3D animation to provided stream.
Public methodSaveCurrentAudioToFile
Saves current audio to file with specified name.
Public methodSaveCurrentAudioToStream
Saves current audio to provided stream.
Public methodSaveCurrentVideoToFile
Saves current video to file with specified name.
Public methodSaveCurrentVideoToStream
Saves current video to provided stream.
Public methodSetExtractionArea(RectangleF)
Sets the extraction area by rectangle.
(Inherited from BaseExtractor.)
Public methodSetExtractionArea(Double, Double, Double, Double)
Sets the extraction area by coordinates and dimensions.
(Inherited from BaseExtractor.)
Public methodSetExtractionArea(Single, Single, Single, Single)
Sets the extraction area by coordinates and dimensions.
(Inherited from BaseExtractor.)
Public methodToString (Inherited from Object.)
Top
Events

  NameDescription
Public eventParsingError
Raised on PDF document parsing errors. This usually indicates a damaged document.
(Inherited from BaseExtractor.)
Public eventPasswordRequired
Occurs when the password required to decrypt the document.
(Inherited from BaseExtractor.)
Public eventProgressChanged
Raised for each reported progress value. Allows to cancel the processing.
(Inherited from BaseExtractor.)
Top
Fields

  NameDescription
Protected fieldExtractionAreaInternal (Inherited from BaseExtractor.)
Top
See Also

Reference