|
Foxit PDF SDK
|
Public Member Functions | |
| def | ExportData (is_raw_data) |
| Export stream data. More... | |
| def | GetData (is_raw_data, size, out_buffer) |
| Get stream data. More... | |
| def | GetDataSize (is_raw_data) |
| Get the size of stream data, in bytes. More... | |
| def | GetDictionary () |
| Get the PDF dictionary object associated to current PDF stream object. More... | |
| def | GetStreamFilter () |
| Get the type of stream filter which indicate how the stream data must be decoded before the data is used. More... | |
| def | ImportData (file_read, stream_filter) |
| Import stream data. More... | |
| def | SetData (buffer, size) |
| Set stream data. More... | |
A PDF stream object consists of a direct dictionary object and stream data. For more details, please refer to Section 3.2.7 "Stream Objects" in <PDF Reference 1.7>.
Class fsdk.PDFStream is derived from PDFObject and offers functions to create a new PDF stream object and get/set stream data.
| def fsdk.PDFStream.ExportData | ( | is_raw_data | ) |
Export stream data.
This function provides an efficient way to get the stream data, especially for large stream data.
| [in] | is_raw_data | A boolean value that indicates whether to get raw data or not: true means to get raw data, and false means to get decoded data (original data). |
| def fsdk.PDFStream.GetData | ( | is_raw_data, | |
| size, | |||
| out_buffer | |||
| ) |
Get stream data.
When calling this function, user should pass a memory block with enough size to retrieve data. User is recommended to call function fsdk.PDFStream.GetDataSize (with same parameter is_raw_data) to get the expected size, then prepare the memory block, and then call this function to get data.
| [in] | is_raw_data | A boolean value that indicates whether to get raw data or not: true means to get raw data, and false means to get decoded data (original data). |
| [in] | size | Size of parameter out_buffer, in bytes. It should be equal to or larger than the actual data size. |
| [out] | out_buffer | A memory block (with enough size) used as output parameter that receives the stream data. It should not be null. |
| def fsdk.PDFStream.GetDataSize | ( | is_raw_data | ) |
Get the size of stream data, in bytes.
| [in] | is_raw_data | A boolean value that indicates whether to get raw data or not: true means to get raw data, and false means to get decoded data (original data). |
| def fsdk.PDFStream.GetDictionary | ( | ) |
Get the PDF dictionary object associated to current PDF stream object.
| def fsdk.PDFStream.GetStreamFilter | ( | ) |
Get the type of stream filter which indicate how the stream data must be decoded before the data is used.
| def fsdk.PDFStream.ImportData | ( | file_read, | |
| stream_filter | |||
| ) |
Import stream data.
| [in] | file_read | A fsdk.FileReaderCallback object implemented by user. Foxit PDF SDK will use this to read stream data and set to current PDF stream object. User should keep this callback valid until the related PDF document is closed or current stream object is released because of useless. |
| [in] | stream_filter | Type of stream filter, which specifies how to decode the data which is read through parameter file_read. Please refer to values starting from fsdk.PDFStreamE_NoneDecode and this should be one of these values except fsdk.PDFStreamE_Unknown . |
| def fsdk.PDFStream.SetData | ( | buffer, | |
| size | |||
| ) |
Set stream data.
| [in] | buffer | A memory block that represents the new stream data to be set. |
| [in] | size | Size of parameter buffer, in bytes. |