Pleora Technologies Inc. eBUS SDK v7.0.1.7536 API



Loading...
Searching...
No Matches
IPvSoftDeviceGEV Class Referenceabstract

Interface to the main class of the software-based GigE Vision Device. More...

#include <PvSoftDeviceGEVInterfaces.h>

Public Member Functions

 ~IPvSoftDeviceGEV ()
 Virtual destructor.
 
virtual PvResult AddStream (IPvSWStreamingChannelSource *aSource)=0
 Adds a new stream to the PvSoftDeviceGEV.
 
virtual PvResult SetTCPTransportEnabled (bool aEnabled)=0
 Enables experimental TCP transport.
 
virtual PvResult SetRTPProtocolEnabled (bool aEnabled)=0
 Enables the option of using RTP for streaming.
 
virtual PvResult SetGenDCEnabled (bool aEnabled)=0
 Enables the option of using GenDC for streaming.
 
- Public Member Functions inherited from IPvVirtualDeviceGEV
virtual ~IPvVirtualDeviceGEV ()
 Virtual destructor.
 
virtual PvResult SetUserSetCount (uint32_t aCount)=0
 Sets the number of user-sets supported by the PvSoftDeviceGEV.
 
virtual PvResult SetUserSetNotify (IPvUserSetNotify *aUserSetNotify)=0
 Binds in a class which will contain a callback which will be called when the state of a UsersetLoad/Save changes.
 
virtual PvResult SetActionHandler (PvVirtualDeviceLib::IActionHandler *aActionHandler)=0
 Sets the action handler for the PvSoftDeviceGEV.
 
virtual PvResult RegisterEventSink (IPvVirtualDeviceGEVEventSink *aEventSink)=0
 Registers an event sink to receive notifications from the PvSoftDeviceGEV.
 
virtual PvResult UnregisterEventSink (IPvVirtualDeviceGEVEventSink *aEventSink)=0
 Unregisters a previously registered event sink.
 
virtual PvResult Start (const PvString &aMACAddress)=0
 Starts the PvSoftDeviceGEV.
 
virtual PvResult Stop ()=0
 Stops the PvSoftDeviceGEV.
 
virtual IPvVirtualDeviceGEVInfoGetInfo ()=0
 Obtains the information interface of the PvSoftDeviceGEV.
 
virtual IPvRegisterMapGetRegisterMap ()=0
 Obtains the register map interface of the PvSoftDeviceGEV.
 
virtual IPvVirtualDeviceGEVStatisticsGetStatistics ()=0
 Obtains the statistics interface of the PvSoftDeviceGEV.
 
virtual IPvMessageChannelGetMessagingChannel ()=0
 Obtains the messaging channel interface of the PvSoftDeviceGEV.
 
virtual PvResult GetGenICamXMLFile (PvString &aString) const =0
 Returns the GenICam XML file of the device.
 

Detailed Description

Interface to the main class of the software-based GigE Vision Device.

Member Function Documentation

◆ AddStream()

virtual PvResult IPvSoftDeviceGEV::AddStream ( IPvSWStreamingChannelSource aSource)
pure virtual

Adds a new stream to the PvSoftDeviceGEV.

All streams must be added before starting the PvSoftDeviceGEV.

Parameters
[in]aSourceInterface to a user-provided source.
Returns
Includes:

Implemented in PvSoftDeviceGEV.

◆ SetGenDCEnabled()

virtual PvResult IPvSoftDeviceGEV::SetGenDCEnabled ( bool  aEnabled)
pure virtual

Enables the option of using GenDC for streaming.

Parameters
aEnabledToggles GenDC support.
Returns
PvResult::Code::OK

Implemented in PvSoftDeviceGEV.

◆ SetRTPProtocolEnabled()

virtual PvResult IPvSoftDeviceGEV::SetRTPProtocolEnabled ( bool  aEnabled)
pure virtual

Enables the option of using RTP for streaming.

PvSoftDeviceGEV supports optional RTP protocol for GigE Vision devices.

When RTP is enabled it can be selected as the protocol used to data transmission at the stream channel level of the GenApi interface of the device.

RTP supported is not covered by the GigE Vision specification. A GigE Vision Device actively streaming using RTP goes beyond the bounds covered by the GigE Vision standard.

The RTP implementation is however compliant with the RTP RFCs covering the transport of images (RFC 4175) and H.264 data (RFC 6184).

When a stream transmits using the RTP protocol, the stream is announced on a multicast channel (224.2.127.254:9875) using the SAP protocol with a SDP descriptor as required by the DEFSTAN 0082 specification.

Parameters
[in]aEnabledToggles RTP support.
Returns
PvResult::Code::OK

Implemented in PvSoftDeviceGEV.

◆ SetTCPTransportEnabled()

virtual PvResult IPvSoftDeviceGEV::SetTCPTransportEnabled ( bool  aEnabled)
pure virtual

Enables experimental TCP transport.

PvSoftDeviceGEV supports optional, experimental TCP transport for GigE Vision devices. It affects GVCP control, GVCP messaging channel and GVSP streaming.

When TCP is enabled the device still respond to UDP requests as usual. Additional TCP sockets are opened to optionally accept TCP connections from the host.

As long as TCP is not fully ratified by the GigE Vision specification, enabling TCP could and most likely will break GigE Vision compliance. It also means only the eBUS PvDeviceGEV and PvStreamGEV can be used to interact with the device when using TCP transport.

Parameters
[in]aEnabledToggles TCP support.
Returns
PvResult::Code::OK

Implemented in PvSoftDeviceGEV.


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

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