MultimediaExtractor Class
Free Trial Web API version Licensing Request A Quote
HAVE QUESTIONS OR NEED HELP?SUBMIT THE SUPPORT REQUEST FORM or write email toSUPPORT@BYTESCOUT.COM
Extracts videos from PDF document.
Inheritance Hierarchy
Bytescout.PDFExtractorBaseExtractor
Bytescout.PDFExtractorMultimediaExtractor
Namespace:Bytescout.PDFExtractor
Assembly: Bytescout.PDFExtractor (in Bytescout.PDFExtractor.dll) Version: 13.4.0.4760-master
Syntax
The MultimediaExtractor type exposes the following members.
Constructors
Name | Description | |
---|---|---|
MultimediaExtractor | Initializes a new instance of the MultimediaExtractor class. | |
MultimediaExtractor(String, String) | Initializes a new instance of the MultimediaExtractor class. |
Properties
Name | Description | |
---|---|---|
CheckPermissions | 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.) | |
ComHelpers | Set of utility functions and properties to use from COM/ActiveX. (Inherited from BaseExtractor.) | |
ContentType | 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.) | |
EmbeddedFileCount | Obsolete. Property is disabled to speed up the document loading. Use AttachmentExtractor to work with attachments. (Inherited from BaseExtractor.) | |
Encrypted | Gets whether the document is encrypted. (Inherited from BaseExtractor.) | |
ExtractionArea | Sets the extraction area by coordinates and dimensions (left, top, width, height). (Inherited from BaseExtractor.) | |
ExtractionAreaRect | Sets the extraction area by rectangle. (Inherited from BaseExtractor.) | |
ExtractionAreaUsageMode | Gets or sets how to use the ExtractionArea: whether to extract any object intersecting with the area or only objects completely located inside the area. (Inherited from BaseExtractor.) | |
IsDocumentLoaded | Get the document loaded state. (Inherited from BaseExtractor.) | |
LicenseInfo | Gets license information. (Inherited from BaseExtractor.) | |
PageDataCaching | Controls page data caching behavior. (Inherited from BaseExtractor.) | |
Password | PDF document password. (Inherited from BaseExtractor.) | |
Profiles | Comma-separated list of profiles to apply to the extractor. Profiles must be previously loaded. (Inherited from BaseExtractor.) | |
RegistrationKey | Registration key. (Inherited from BaseExtractor.) | |
RegistrationName | Registration name. (Inherited from BaseExtractor.) | |
Version | Gets the component version number. (Inherited from BaseExtractor.) |
Methods
Name | Description | |
---|---|---|
CreateProfile(String, Boolean, Boolean, Boolean) | Creates JSON profile will all extractor properties with current values. (Inherited from BaseExtractor.) | |
CreateProfile(String, String, Boolean, Boolean, Boolean) | Creates JSON profile will all extractor properties with current values. (Inherited from BaseExtractor.) | |
Dispose | Releases the unmanaged resources used by the instance and optionally releases the managed resources. (Inherited from BaseExtractor.) | |
Equals | (Inherited from Object.) | |
Finalize | (Inherited from Object.) | |
FireParsingError | (Inherited from BaseExtractor.) | |
FireProgressChanged | (Inherited from BaseExtractor.) | |
GetCurrent3DAsArrayOfBytes | Returns current 3D animation as array of bytes. | |
GetCurrent3DAsVariant | Returns current 3D animation as COM/ActiveX-compatible array of bytes ('Variant()'). | |
GetCurrent3DBytesSize | Returns size of current 3D animation. | |
GetCurrent3DExtension | Gets the current 3D animation file extension. | |
GetCurrent3DType | Gets the type of the current 3D animation. | |
GetCurrentAudioAsArrayOfBytes | Returns current audio as array of bytes. | |
GetCurrentAudioAsVariant | Returns current audio as COM/ActiveX-compatible array of bytes ('Variant()'). | |
GetCurrentAudioBytesSize | Returns size of current audio. | |
GetCurrentAudioExtension | Gets the current audio file extension. | |
GetCurrentAudioType | Gets the type of the current audio. | |
GetCurrentVideoAsArrayOfBytes | Returns current video as array of bytes. | |
GetCurrentVideoAsVariant | Returns current video as COM/ActiveX-compatible array of bytes ('Variant()'). | |
GetCurrentVideoBytesSize | Returns size of current video. | |
GetCurrentVideoExtension | Gets the current video file extension. | |
GetCurrentVideoType | Gets the type of the current video. | |
GetDocument3DCount | Returns count of 3D animations in the document. | |
GetDocumentAudioCount | Returns count of audios in the document. | |
GetDocumentVideoCount | Returns count of videos in the document. | |
GetFirst3D | Initializes enumeration of 3D animations in the document. If GetFirst3D() returned true, you can get the video using SaveCurrent3D*() or GetCurrent3D*() methods. | |
GetFirstAudio | Initializes enumeration of audios in the document. If GetFirstVideo() returned true, you can get the video using SaveCurrentAudio*() or GetCurrentAudio*() methods. | |
GetFirstVideo | Initializes enumeration of videos in the document. If GetFirstVideo() returned true, you can get the video using SaveCurrentVideo*() or GetCurrentVideo*() methods. | |
GetHashCode | (Inherited from Object.) | |
GetNext3D | Advances 3D animations enumeration to next 3D animation object. If GetNext3D() returned true, you can get the 3D animation using SaveCurrent3D*() or GetCurrent3D*() methods. | |
GetNextAudio | Advances audio enumeration to next video. If GetNextAudio() returned true, you can get the video using SaveCurrentAudio*() or GetCurrentAudio*() methods. | |
GetNextVideo | Advances video enumeration to next video. If GetNextVideo() returned true, you can get the video using SaveCurrentVideo*() or GetCurrentVideo*() methods. | |
GetPageCount | Returns document page count. (Inherited from BaseExtractor.) | |
GetPageRect_Height | Gets the specified page height. (Inherited from BaseExtractor.) | |
GetPageRect_Left | Gets the specified page left coordinate. (Inherited from BaseExtractor.) | |
GetPageRect_Top | Gets the specified page top coordinate. (Inherited from BaseExtractor.) | |
GetPageRect_Width | Gets the specified page width. (Inherited from BaseExtractor.) | |
GetPageRectangle(Int32) | Gets the page rectangle in PDF Points (1 Point = 1/72 in.). (Inherited from BaseExtractor.) | |
GetPageRectangle(Int32, Boolean) | Gets the page rectangle in PDF Points (1 Point = 1/72 in.). (Inherited from BaseExtractor.) | |
GetPageRotationAngle | Returns the rotation angle of specified page. (Inherited from BaseExtractor.) | |
GetType | (Inherited from Object.) | |
IsEncrypted | Gets the document encrypted state. (Inherited from BaseExtractor.) | |
LoadAndApplyProfiles | Loads profiles from JSON string and automatically applies them. Note that profiles containing detection keywords will be deferred until the extraction. (Inherited from BaseExtractor.) | |
LoadDocumentFromFile | Loads PDF document from specified file. (Inherited from BaseExtractor.) | |
LoadDocumentFromStream | Loads PDF document from provided stream. (Overrides BaseExtractorLoadDocumentFromStream(Stream).) | |
LoadDocumentFromVariant | Loads PDF document from byte array presented as array of Variant or Byte objects ('Variant()' or 'Byte()'). This is COM/ActiveX-compatible version of the method LoadDocumentFromStream(Stream) for in-memory processing of PDF files. (Inherited from BaseExtractor.) | |
LoadProfiles | Loads profiles from JSON file. (Inherited from BaseExtractor.) | |
LoadProfilesFromString | Loads profiles from JSON string. (Inherited from BaseExtractor.) | |
MemberwiseClone | (Inherited from Object.) | |
Reset | Resets the instance, disposes internal resources and releases the file. Use this method before loading another PDF file. (Overrides BaseExtractorReset.) | |
ResetExtractionArea | Resets the extraction area to the full page. (Inherited from BaseExtractor.) | |
SaveCurrent3DToFile | Saves current 3D animation to file with specified name. | |
SaveCurrent3DToStream | Saves current 3D animation to provided stream. | |
SaveCurrentAudioToFile | Saves current audio to file with specified name. | |
SaveCurrentAudioToStream | Saves current audio to provided stream. | |
SaveCurrentVideoToFile | Saves current video to file with specified name. | |
SaveCurrentVideoToStream | Saves current video to provided stream. | |
SetExtractionArea(RectangleF) | Sets the extraction area by rectangle. (Inherited from BaseExtractor.) | |
SetExtractionArea(Double, Double, Double, Double) | Sets the extraction area by coordinates and dimensions. (Inherited from BaseExtractor.) | |
SetExtractionArea(Single, Single, Single, Single) | Sets the extraction area by coordinates and dimensions. (Inherited from BaseExtractor.) | |
ToString | (Inherited from Object.) |
Events
Name | Description | |
---|---|---|
ParsingError | Raised on PDF document parsing errors. This usually indicates a damaged document. (Inherited from BaseExtractor.) | |
PasswordRequired | Occurs when the password required to decrypt the document. (Inherited from BaseExtractor.) | |
ProgressChanged | Raised for each reported progress value. Allows to cancel the processing. (Inherited from BaseExtractor.) |
Fields
Name | Description | |
---|---|---|
ExtractionAreaInternal | (Inherited from BaseExtractor.) |
See Also