eBUS SDK v7.0.1.7536 APIStreaming channel source interface with GenDC (Generic Data Container) support. More...
#include <PvSoftDeviceGEVInterfaces.h>
Public Member Functions | |
| virtual void | AssignGenDCManager (IPvGenDCManager *aManager)=0 |
| Assigns the GenDC manager to the streaming channel source. | |
| virtual void | SetupGenDCContainer ()=0 |
| Sets up the GenDC container before device initialization. | |
| virtual bool | GetGenDCStreamingMode () const =0 |
| Gets the current GenDC streaming mode state. | |
| virtual PvResult | SetGenDCStreamingMode (bool aEnabled)=0 |
| Enables or disables GenDC streaming mode. | |
 Public Member Functions inherited from IPvSWStreamingChannelSource | |
| virtual | ~IPvSWStreamingChannelSource () |
| Virtual destructor. | |
| virtual PvBuffer * | AllocBuffer ()=0 |
| Request by the PvSoftDeviceGEV to allocate a PvBuffer. | |
| virtual void | FreeBuffer (PvBuffer *aBuffer)=0 |
| Request by the PvSoftDeviceGEV to free or release a buffer allocated with AllocBuffer. | |
| virtual PvResult | GetTxNumBuffersToUse (uint32_t &aNumBuffer)=0 |
| This method is requested by PvSoftDeviceGEV to limit the number of buffers used by the transmitter. It will be called before MySource->OnStreamingStart(). To specify a different number of buffers, override this method in your source and return an integer value aNumBuffer. | |
| virtual PvResult | QueueBuffer (PvBuffer *aBuffer)=0 |
| Request by the PvSoftDeviceGEV to queue a buffer for acquisition. | |
| virtual PvResult | RetrieveBuffer (PvBuffer **aBuffer)=0 |
| Request by the PvSoftDeviceGEV to retrieve a buffer from the streaming source. | |
| virtual void | AbortQueuedBuffers ()=0 |
| Request by the PvSoftDeviceGEV to abort all buffers queued for acquisition. | |
| Public Member Functions inherited from IPvStreamingChannelSource | |
| virtual | ~IPvStreamingChannelSource () |
| Virtual destructor. | |
| virtual uint32_t | GetWidth () const =0 |
| Returns the current image width. | |
| virtual uint32_t | GetHeight () const =0 |
| Returns the current image height. | |
| virtual uint32_t | GetOffsetX () const =0 |
| Returns the current image offset X. | |
| virtual uint32_t | GetOffsetY () const =0 |
| Returns the current image offset Y. | |
| virtual PvPixelType | GetPixelType () const =0 |
| Returns the current pixel type. | |
| virtual void | GetWidthInfo (uint32_t &aMin, uint32_t &aMax, uint32_t &aInc) const =0 |
| Returns the stream channel width attributes. | |
| virtual void | GetHeightInfo (uint32_t &aMin, uint32_t &aMax, uint32_t &aInc) const =0 |
| Returns the stream channel height attributes. | |
| virtual uint32_t | GetChunksSize () const =0 |
| Gets the stream channel chunk size attributes. | |
| virtual uint32_t | GetPayloadSize () const =0 |
| Stream channel payload size in bytes. Return zero to have it inferred from width, height and pixel format. | |
| virtual PvScanType | GetScanType () const =0 |
| Returns the scan type that is used by the streaming source. | |
| virtual bool | GetChunkModeActive () const =0 |
| Indicates whether the current master chunk mode is active. | |
| virtual bool | GetChunkEnable (uint32_t aChunkID) const =0 |
| Returns the current chunk enabled state. | |
| virtual PvResult | GetSupportedPixelType (int aIndex, PvPixelType &aPixelType) const =0 |
| Obtains an index of supported pixel types. Used at PvSoftDeviceGEV::Start time to create the GenICam XML of the device. | |
| virtual PvResult | GetSupportedChunk (int aIndex, uint32_t &aID, PvString &aName) const =0 |
| Returns the indexed supported chunk type. Used at PvSoftDeviceGEV::Start time to create the GenICam XML of the device. | |
| virtual PvResult | GetGevSCPSPacketSizeInfo (uint32_t &aMax) const |
| Get the customized max value for GevSCPSPacketSize. Used at PvSoftDeviceGEV::Start time to create the GenICam XML of the device. | |
| virtual PvResult | SetWidth (uint32_t aWidth)=0 |
| Request from the PvSoftDeviceGEV to change the image width. | |
| virtual PvResult | SetHeight (uint32_t aHeight)=0 |
| Request from the PvSoftDeviceGEV to change the image height. | |
| virtual PvResult | SetOffsetX (uint32_t aOffsetX)=0 |
| Request from the PvSoftDeviceGEV to change the image offset X. | |
| virtual PvResult | SetOffsetY (uint32_t aOffsetY)=0 |
| Request from the PvSoftDeviceGEV to change the image offset Y. | |
| virtual PvResult | SetPixelType (PvPixelType aPixelType)=0 |
| Request from the PvSoftDeviceGEV to change the image pixel type. | |
| virtual PvResult | SetChunkModeActive (bool aEnabled)=0 |
| Set the master chunk mode active state. | |
| virtual PvResult | SetChunkEnable (uint32_t aChunkID, bool aEnabled)=0 |
| Sets the chunk enabled state for a specific chunk type. | |
| virtual void | OnOpen (const PvString &aDestIP, uint16_t aDestPort)=0 |
| Notification from the PvSoftDeviceGEV that this streaming channel has been opened. | |
| virtual void | OnClose ()=0 |
| Notification from the PvSoftDeviceGEV that this streaming channel has been closed. | |
| virtual void | OnStreamingStart ()=0 |
| Notification that the GigE Vision controller has requested that the device start streaming on this channel. | |
| virtual void | OnStreamingStop ()=0 |
| Notification that the GigE Vision controller has requested that the device stop streaming on this channel. | |
| virtual void | CreateRegisters (IPvRegisterMap *aRegisterMap, IPvRegisterFactory *aFactory) |
| When called, the streaming channel source should create its custom registers if they are needed. | |
| virtual void | CreateGenApiFeatures (IPvRegisterMap *aRegisterMap, IPvGenApiFactory *aFactory) |
| When called, the streaming channel source should create its custom GenApi parameters if they are needed. | |
| virtual bool | IsPayloadTypeSupported (PvPayloadType aPayloadType) |
| When called, the streaming source has to return whether the specificed payload type is supported or not. | |
| virtual void | SetMultiPartAllowed (bool aAllowed) |
| Sets whether the streaming source is allowed or not, but not forced, to transmit multi-part data. | |
| virtual void | SetLargeLeaderTrailerEnabled (bool aEnabled, uint32_t aMaxMultiPartCount) |
| Sets whether the streaming source which transmit multi-part data uses large data leader and trailer packets. | |
| virtual PvResult | SetTestPayloadFormatMode (PvPayloadType aPayloadType) |
| When called, the streaming source has to ensure it can stream buffers of the specified payload type. | |
Streaming channel source interface with GenDC (Generic Data Container) support.
This class extends IPvSWStreamingChannelSource to provide GenDC streaming capabilities. GenDC allows transmission of complex data structures beyond simple image frames.
|
pure virtual |
Assigns the GenDC manager to the streaming channel source.
Required for the internal libraries to provide a connection to the GenDC manager. This method is called internally by the device framework to establish the connection between the source and the GenDC management system.
| [in] | aManager | Pointer to the IPvGenDCManager interface. |
|
pure virtual |
Gets the current GenDC streaming mode state.
|
pure virtual |
Enables or disables GenDC streaming mode.
| [in] | aEnabled | True to enable GenDC streaming mode, false to disable. |
|
pure virtual |
Sets up the GenDC container before device initialization.
Gives the user a chance to set up their container before the software device powers up. This method is called during device initialization to allow configuration of the GenDC container structure, components, and parts.
Copyright (c) 2002-2026 Pleora Technologies Inc.
www.pleora.com