Pleora Technologies Inc. eBUS SDK v6.2.8.5877 API



IPvMultiPartContainer Class Reference

Interface to a multi-part container. More...

Additional Inherited Members

- Public Member Functions inherited from IPvMultiPartContainerWriter
virtual void Reset ()=0
 Resets the multi-part container index to empty - no parts.
 
virtual PvResult AddImagePart (PvMultiPartDataType aDataType, uint32_t aWidth, uint32_t aMaxHeight, PvPixelType aPixelType, uint32_t aOffsetX=0, uint32_t aOffsetY=0, uint16_t aPaddingX=0)=0
 Adds an image part to the index of a multi-part container. More...
 
virtual PvResult AddJPEGPart (PvMultiPartDataType aDataType, uint32_t aMaxLength, uint8_t aFlag, uint64_t aTimestampTickFrequency, uint32_t aDataFormat)=0
 Adds a JPEG part to the index of a multi-part container. More...
 
virtual PvResult AddChunkPart (uint32_t aMaxLength, uint32_t aChunkLayoutID)=0
 Adds a chunk data part to the index of a multi-part container. More...
 
virtual PvResult SetPartIDs (uint32_t aIndex, uint32_t aSourceID, uint32_t aDataPurposeID, uint32_t aRegionID)=0
 Sets the source, data purpose and region IDs of a part. More...
 
virtual PvResult SetPartZoneInfo (uint32_t aIndex, uint8_t aAdditionalZones, uint32_t aZoneDirectionMask)=0
 Sets the zone info of a part. More...
 
virtual PvResult AllocAllParts ()=0
 Allocates memory for all parts defined by the part index of the multi-part container. More...
 
virtual PvResult AllocPart (uint32_t aIndex)=0
 Allocates memory for one of the parts as defined by the index of the part. More...
 
virtual PvResult AttachPart (uint32_t aIndex, uint8_t *aBuffer, uint64_t aLength)=0
 Attaches a part to an external memory buffer. More...
 
virtual PvResult SetPartFinalLength (uint32_t aIndex, uint32_t aLength)=0
 Sets the final length of a part. More...
 
virtual PvResult SetPartFinalImageHeight (uint32_t aIndex, uint32_t aHeight)=0
 Sets the final height of an image part. More...
 
virtual PvResult Validate ()=0
 Validates the part index and allocated/attached part memory. More...
 
- Public Member Functions inherited from IPvMultiPartContainerReader
virtual uint32_t GetPartCount ()=0
 Part count of the multi-part container. More...
 
virtual const IPvMultiPartSectionGetPart (uint32_t aIndex) const =0
 Indexed part (section) const accessor. More...
 
virtual IPvMultiPartSectionGetPart (uint32_t aIndex)=0
 Indexed part (section) accessor. More...
 
virtual const IPvMultiPartSectionoperator[] (uint32_t aIndex) const =0
 Indexed part (section) const accessor. More...
 
virtual IPvMultiPartSectionoperator[] (uint32_t aIndex)=0
 Indexed part (section) accessor. More...
 

Detailed Description

Interface to a multi-part container.

Implements both IPvMultiPartContainerReader and IPvMultiPartContainerWriter.

See IPvMultiPartContainerReader for more information on how to access a multi-part buffer as received from a GigE Vision source.

See IPvMultiPartContainerWriter for more information on how to create and populate a multi-part buffer in order to transmit it from a GigE Vision source.

Returns
Includes:

The documentation for this class was generated from the following file:

Copyright (c) 2002-2021 Pleora Technologies Inc.
www.pleora.com