Pleora Technologies Inc. eBUS SDK v6.2.8.5877 API



PvStream\ GigE\ Vision\ Parameters


Category: Root/Configuration


Parameter Description Additional Information Visibility
FirstPacketTimeout The maximum time (in milliseconds) the data receiver waits for the first packet of a block. This timer starts when the first packet of the stream is received. The value of zero implies that no first packet timeout will be enforced. Upon expiry of this timer, the buffer is returned with an operation result describing the error . Unbound unsigned 64 bits integer Beginner
InterPacketTimeout The maximum time (in milliseconds) to wait in between two packets of a block. If set to 0, no maximum inter packet timeout is enforced. Upon expiry of this timer, the buffer is returned with an operation result describing the error. Unbound unsigned 64 bits integer Beginner
RequestTimeout The maximum time (in milliseconds) that the data receiver waits for all the packets of a block. Upon expiry of this timer, the buffer is returned with an operation result describing the error. This timer starts when the first packet of the stream is received. Unbound unsigned 64 bits integer Beginner
PreemptiveResendTimeout The time (in milliseconds) that the data receiver waits to receive a packet from the most recent block before making a resend request when no activity is detected. If set to 0, a pre-emptive resend will not occur. Unbound unsigned 64 bits integer Beginner
MaximumPendingResends Maximum number of packets in a block that can be missing, at any one time, before the buffer is returned with an operation result describing the error. A value of zero indicates that there is no limit to the number of pending resend requests. Unsigned 64 bits integer
Max: 4096
Beginner
RequestMissingPackets If enabled, missing packets are requested. Other parameters that control the resend request behaviour include MaximumResendRequestRetryByPacket, MaximumResendGroupSize, ResendRequestTimeout, MaximumPendingResends and ResendDelay. Boolean Beginner
LatencyLevel Only available when receiving data through the eBUS Universal Pro driver for windows. This value allows the tuning of the driver to modify the acceptable amount of latency at the cost of using greater CPU resources. A value of 0 minimizes latency as much as possible. Unsigned 64 bits integer
Max: 3
Guru
AutoResetOnLackOfResources The threshold of buffers available to be filled in the data receiver. When the number of buffers available to be filled is less than this threshold, all incomplete buffers are returned with an operation result describing the error. Unbound unsigned 64 bits integer Expert
MaximumResendRequestRetryByPacket The maximum number of times a resend request can be issued before the buffer is returned with an operation result describing the error. A value of zero indicates that there is no limit on the number of resend requests. Unbound unsigned 64 bits integer Guru
MaximumResendGroupSize GigE Vision allows for a single resend request to contain requests for 1 or more packets. This parameter defines the maximum number of packets that can be requested at one time. A value of zero indicates that there is no limit to the resend group size. If the number of consecutive missing packets is larger than this value, the operation result is set to TOO_MANY_CONSECUTIVE_RESENDS. Unbound unsigned 64 bits integer Guru
ResendRequestTimeout The amount of time (in microseconds) the data receiver waits for a response to a resend request before issuing the request again. Unbound unsigned 64 bits integer Guru
ResendDelay Time (in microseconds) to wait before issuing a resend request for a missing packet. Unbound unsigned 64 bits integer Guru
ResetOnIdle This parameter defines the time that the data receiver waits for while there is no GVSP packet coming before resetting itself. On a reset, 1) All the Receiving block buffers to Ready for Processing states with error code AUTO_ABORTED. All Empty block buffers are still in the data receiver and ready for receiving. 2) The data receiver goes back to the pre stream start status. This parameter allows the data receiver to better handle the cases where the data receiver receives no packets for a long time due to a connection loss or a large number of packets are dropped on the network. Without this parameter, the data receiver may not be able to recover quickly as it may try to request many packets resends. This parameter also can help the data receiver work properly in the situation that the application is only a data receiver and the transmitter resets the block_id. For example, the transmitter transmitted the block_id n and data receiver received it. Then data receiver is excepting block_id n+1 but if the transmitter resets the block_id to 1. Without this parameter to reset it back to the pre stream start status the data receiver will ignore the new coming in blocks until it receives block_id n+1. For some transmitter devices, acquisition stop and start resets the block_id to 1. For a software transmitter, for instance Pleora Video server, after you call PvTransmitterGEV::Close() and then PvTransmitterRaw::Open() then the block_id resets to 1. In both cases if the stream destination IP address and port remain same as before then the data receiver application still receives those blocks. Data receiver could not tell if those block data are from new coming block data or the packet resend for the same block_id which has been received before. Unsigned 64 bits integer
Max: 4294967296
Guru
EnableMissingPacketsList Enables the data receiver to keep track of packets that were lost while attempting to receive a block. Enable if you plan on using PvBuffer::GetMissingPacketIdsCount and PvBuffer::GetMissingPacketIds . Boolean Guru
MaximumPreQueuedBuffers Only available when receiving data through the eBUS Universal Pro driver. Number of buffers queued before passing the buffers between user space and kernel space. Increasing this number reduces the number of times data is exchanged between the SDK in user space and the driver in kernel space. This can increase performance in the case where data is being streamed at high frame rates. Before using this parameter, ensure that a sufficient number of buffers queued into the stream. Unsigned 64 bits integer
Min: 1
Max: 32
Guru
OnlyStartOnFirstPacket When set to true, GVSP packets are discarded until a GVSP leader of a block is received. When it is set to false, SDK starts processing the first received GVSP packet regardless of its packet id, at which point the SDK requests that the device resend the lost packets. Setting this feature to false can cause multiple unwanted resend requests on multicast system. Boolean Guru
ExtraBlockCompletion Add extra condition for block completion Enumeration.
Entries: Disabled,
OnNextBlockStart,
OnBlockTrailer
Guru


Category: Root/Connection


Parameter Description Additional Information Visibility
Transport Transport used for GVSP. Enumeration.
Entries: UDP,
TCP
Beginner
DataPort UDP port to which the GigE Vision transmitter should send data. For unicast data, this is the local (PC side) port number. For multicast data, this is the port number to which the receiver is subscribed. Unbound unsigned 64 bits integer Beginner
MulticastIPAddress Address of the multicast group, if applicable. Unbound unsigned 64 bits integer Beginner
LocalIPAddress Local IP address used to receive data from the GigE Vision transmitter. Unbound unsigned 64 bits integer Beginner
DeviceIPAddress IP address of the GigE Vision transmitter from which the stream is receiving data. Unbound unsigned 64 bits integer Beginner
Channel The GigE Vision streaming channel from which data is received. Unbound unsigned 64 bits integer Beginner


Category: Root/General


Parameter Description Additional Information Visibility
Reset Resets all stream statistic counters Command Beginner
BitsCount Number of data payload bits received by the stream. Unbound unsigned 64 bits integer Beginner
BytesCount Number of data payload bytes received by the stream. Unbound unsigned 64 bits integer Beginner
BlockCount Number of blocks received from the device. Unbound unsigned 64 bits integer Beginner
SamplingTime The time elapsed (in ms) between the first block received and the latest block received. Note the definition of the first block in this case would be the first block received after having either opening the stream or issuing the Reset command. Unbound unsigned 64 bits integer Beginner
AcquisitionRate Instant acquisition rate. Float Beginner
AcquisitionRateAverage Average acquisition rate since the first block was received. Float Beginner
Bandwidth Instant throughput in bits per second. Note that this value is calculated based on a finite sequence of received blocks within a finite period of time. Float Beginner
BandwidthAverage Average throughput since the last reset in bits per second. Float Beginner
TimeoutCountedAsError When enabled, timeouts are considered errors. Depending on the nature and behavior of an application, timeouts can be normal occurrences or represent real errors. Boolean Guru
AbortCountedAsError When enabled, aborted buffers are considered errors. Depending on the nature and behavior of an application, aborted buffers can be normal occurrences or represent real errors. Boolean Guru
ErrorCount Count of RetrieveBuffer operation result errors since the last reset. Unbound unsigned 64 bits integer Beginner
LastError Last RetrieveBuffer operation result error. Enumeration.
Entries: None,
NOT_INITIALIZED,
NOT_FOUND,
CANNOT_OPEN_FILE,
NO_MORE_ITEM,
NOT_CONNECTED,
STATE_ERROR,
THREAD_ERROR,
INVALID_DATA_FORMAT,
ABORTED,
NOT_ENOUGH_MEMORY,
GENERIC_ERROR,
INVALID_PARAMETER,
CANCEL,
PENDING,
TIMEOUT,
NO_LICENSE,
GENICAM_XML_ERROR,
NOT_IMPLEMENTED,
NOT_SUPPORTED,
FILE_ERROR,
ERR_OVERFLOW,
IMAGE_ERROR,
MISSING_PACKETS,
BUFFER_TOO_SMALL,
TOO_MANY_RESENDS,
RESENDS_FAILURE,
TOO_MANY_CONSECUTIVE_RESENDS,
AUTO_ABORTED,
BAD_VERSION,
NO_MORE_ENTRY,
NO_AVAILABLE_DATA,
NETWORK_ERROR,
RESYNC,
BUSY,
CORRUPTED_DATA
Beginner
TimestampSourceEffective Source of the buffer timestamps in use. Hardware refers to the device timestamp present in the GVSP header. Software refers to host-side timestamps recorded when a buffer is delivered by the data receiver. Enumeration.
Entries: Hardware,
Software
Guru
TimestampSourcePreferred Preferred source of the buffer timestamps used to track statistics. Hardware refers to the device timestamp present in the GVSP header. Software refers to host-side timestamps recorded when a buffer is delivered by the data receiver. Enumeration.
Entries: Hardware,
Software
Guru


Category: Root/Counters


Parameter Description Additional Information Visibility
BlockIDsMissing The number of missing block IDs. Calculated using the block ID of incoming blocks to count blocks sent by the GigE Vision device that were not successfully delivered. This is typically caused by the application not being able to de-queue and re-queue buffers quickly enough. Unbound unsigned 64 bits integer Beginner
PipelineBlocksDropped Count of blocks dropped by the PvPipeline. The oldest blocks are dropped from the PvPipeline output queue if it runs out of resources. Unbound unsigned 64 bits integer Beginner


Category: Root/DataReceiver


Parameter Description Additional Information Visibility
PacketsRecovered The number of lost packets successfully recovered by packet resend requests. Duplicate received packets are not counted. Unbound unsigned 64 bits integer Beginner
PacketsRecoveredSingleResend The number of lost packets successfully recovered by packet resend requests without any resend request retries. Unbound unsigned 64 bits integer Beginner
UnexpectedResend Unexpected resent packet count. This includes packets received multiple times for a buffer and packets received before a buffer has been completed. Unbound unsigned 64 bits integer Beginner
ResendGroupRequested The number of resend requests issued by the data receiver Unbound unsigned 64 bits integer Beginner
ResendPacketRequested The number of packets the data receiver requests with ResendGroupRequested. Unbound unsigned 64 bits integer Beginner
LostPacket Lost packet count. This counter tracks the number of expected packets that were not received. This counter does not include the packet count of missing blocks. Unbound unsigned 64 bits integer Beginner
IgnoredPacket The number of packets received that are not related to the current set of blocks being processed. This includes packets with block ids that have already been processed. Unbound unsigned 64 bits integer Beginner
RedundantPacket Number of packets received more than once Unbound unsigned 64 bits integer Beginner
PacketOutOfOrder Number of packets received out of order Unbound unsigned 64 bits integer Beginner


Category: Root/Status


Parameter Description Additional Information Visibility
DataOverrun Count of data overrun notifications received from the device. A data overrun notification is sent when the incoming (from a sensor) data rate exceeds the device's data capture rate. Unbound unsigned 64 bits integer Beginner
PartialLineMissing Count of images that have at least one partial line missing. Only available for devices using a Pleora Video Interface. Unbound unsigned 64 bits integer Beginner
FullLineMissing Count of images that have at least on full line missing. Only available for devices using a Pleora Video Interface. Unbound unsigned 64 bits integer Beginner
BlocksDropped Count of dropped block notifications received from the device. Dropped block notifications are sent when the frame buffer is full and the incoming data cannot be processed. Only available for devices using a Pleora Video Interface. Unbound unsigned 64 bits integer Beginner
EOFByLineCount Count of frames where the previous frame was NOT the last one of a sequence of sub frames but the line count was met. Only available for devices using a Pleora Video Interface. Unbound unsigned 64 bits integer Beginner
InterlacedEven Count of interlaced even fields from an interlaced image. Only for devices using a Pleora Video Interface. Unbound unsigned 64 bits integer Beginner
InterlacedOdd Count of interlaced odd fields from an interlaced image. Only for devices using a Pleora Video Interface. Unbound unsigned 64 bits integer Beginner
LocalProblem Count of "Local Problem" status notifications received from the device. An internal problem in the device implementation occurred while processing the request. Optionally the device provides a mechanism for looking up a detailed description of the problem. (Log files, Event log, 'Get last error' mechanics). This error is intended to report problems from underlying services (operating system, 3rd party library) in the device to the client side without translating every possible error code into a GigE Vision equivalent. Unbound unsigned 64 bits integer Beginner
Unknown Count of status notifications received from the device not mapping to a known value. Unbound unsigned 64 bits integer Beginner
PacketUnavailable Count of "Packet Unavailable" status notifications received from the device. The device returns this status notification when a packet is requested but is no longer available. Unbound unsigned 64 bits integer Beginner


Category: Root/Errors


Parameter Description Additional Information Visibility
ResultImageError Count of failed buffers with operation result set to IMAGE_ERROR. Incremented when a corrupt image arrives due to discontinuities in data between the camera and the hardware responsible for transmitting packets in the GigE Vision device. This can include data overrun, partial and full lines missing. Unbound unsigned 64 bits integer Beginner
ResultMissingPackets Count of failed buffers with operation result set to MISSING_PACKETS. Happens when at least one packet of the buffer is missing when it was released back to the calling application. Unbound unsigned 64 bits integer Beginner
ResultBufferTooSmall Count of failed buffers with operation result set to BUFFER_TOO_SMALL. Happens when a buffer queued for streaming was not large enough to contain the received payload. Unbound unsigned 64 bits integer Beginner
ResultTimeout Count of failed buffers with operation result set to TIMEOUT. This happens when FirstPacketTimeout has elapsed without receiving any packets or when RequestTimeout has elapsed after receiving the first packet for the buffer. Unbound unsigned 64 bits integer Beginner
ResultAborted Count of failed buffers with operation result set to ABORTED. After calling AbortQueuedBuffers all buffers in the stream are completed with the ABORTED operation result. Unbound unsigned 64 bits integer Beginner
ResultAutoAborted Count of failed buffers with operation result set to AUTO_ABORTED. The data receiver may enter a state where packets arrive for a newer block while one or more packets for an older block are still missing. The AutoResetOnLackOfResources parameter is the threshold of free buffers maintained by the data receiver. If a packet arrives for a new block and only AutoResetOnLackOfResources buffers are currently available then all incomplete buffers that have not yet finished being filled are immediately returned with result code AUTO_ABORTED. Unbound unsigned 64 bits integer Beginner
ResultStateError Count of failed buffers with operation result set to STATE_ERROR. The data receiver experienced an internal error while attempting to receive this buffer. Unbound unsigned 64 bits integer Beginner
ResultInvalidDataFormat Count of failed buffers with operation result set to INVALID_DATA_FORMAT. Poorly formatted data was received from the GigE Vision transmitter. Unbound unsigned 64 bits integer Beginner
ResultTooManyResends Count of failed buffers with operation result set to TOO_MANY_RESENDS. The data receiver stops attempting to receive a block if too many packet resends were issued. Unbound unsigned 64 bits integer Beginner
ResultTooManyConsecutiveResends Count of failed buffers with operation result set to TOO_MANY_CONSECUTIVE_RESENDS. The data receiver stops attempting to receive a block if a set of consecutive lost packets exceeds MaximumResendGroupSize. Unbound unsigned 64 bits integer Beginner
ResultResendsFailure Count of failed buffers with operation result set to RESENDS_FAILURE. The data receiver has attempted to recover missing packets by issuing resend requests. The maximum number of retries has been reached without having received the requested packet. The MaximumResendRequestRetryByPacket property can be used to configure how many times the data receiver re-attempts a request for a lost packet. Unbound unsigned 64 bits integer Beginner
ResultNotInitialized Count of buffers with an operational state that is not initialized. This operational result is used when ForceMissingPacketsAtNextBlockStart is enabled. The buffer used by the current block is skipped because of a missing block and the operational result of the buffer is set to not initialized. This means nothing in the buffer is valid. Unbound unsigned 64 bits integer Beginner
ResultNoLicense Count of buffers with an operational state that no license was available and watermarking could not be used: the buffer was not an image or too small for watermarking. Unbound unsigned 64 bits integer Beginner


Category: Root/PayloadTypes


Parameter Description Additional Information Visibility
ImageCount Count of blocks of type image received. Unbound unsigned 64 bits integer Expert
RawDataCount Count of blocks of type raw data received. Unbound unsigned 64 bits integer Expert
FileCount Count of blocks of type file received. Unbound unsigned 64 bits integer Expert
ChunkDataCount Count of blocks of type chunk data received. Unbound unsigned 64 bits integer Expert
ExtendedChunkDataCount Count of blocks of type extended chunk data received. Unbound unsigned 64 bits integer Expert
JPEGCount Count of blocks of type JPEG received. Unbound unsigned 64 bits integer Expert
JPEG2000Count Count of blocks of type JPEG 2000 received. Unbound unsigned 64 bits integer Expert
H264Count Count of blocks of type H.264 received. Unbound unsigned 64 bits integer Expert
MultiZoneImageCount Count of blocks of type multi-zone image received. Unbound unsigned 64 bits integer Expert
MultiPartCount Count of blocks of type multi-part received. Unbound unsigned 64 bits integer Expert
UnknownCount Count of blocks of unknown, non-device-specific type received. Unbound unsigned 64 bits integer Expert
DeviceSpecificCount Count of blocks of unknown, device-specific type received. Unbound unsigned 64 bits integer Expert

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