ArvGvStream

ArvGvStream — GigEVision stream

Functions

Properties

guint frame-retention Read / Write / Construct
guint initial-packet-timeout Read / Write / Construct
double packet-request-ratio Read / Write / Construct
ArvGvStreamPacketResend packet-resend Read / Write / Construct
guint packet-timeout Read / Write / Construct
ArvGvStreamSocketBuffer socket-buffer Read / Write / Construct
int socket-buffer-size Read / Write / Construct

Types and Values

Object Hierarchy

    GObject
    ╰── ArvStream
        ╰── ArvGvStream

Implemented Interfaces

ArvGvStream implements GInitable.

Description

Functions

arv_gv_stream_get_port ()

guint16
arv_gv_stream_get_port (ArvGvStream *gv_stream);

arv_gv_stream_get_statistics ()

void
arv_gv_stream_get_statistics (ArvGvStream *gv_stream,
                              guint64 *n_resent_packets,
                              guint64 *n_missing_packets);

Parameters

gv_stream

a ArvGvStream

 

n_resent_packets

.

[out]

n_missing_packets

.

[out]

Types and Values

enum ArvGvStreamOption

Members

ARV_GV_STREAM_OPTION_NONE

no option specified

 

ARV_GV_STREAM_OPTION_PACKET_SOCKET_DISABLED

use of packet socket is disabled

 

enum ArvGvStreamSocketBuffer

Members

ARV_GV_STREAM_SOCKET_BUFFER_FIXED

socket buffer is set to a given fixed value

 

ARV_GV_STREAM_SOCKET_BUFFER_AUTO

socket buffer size is set to the payload size

 

enum ArvGvStreamPacketResend

Members

ARV_GV_STREAM_PACKET_RESEND_NEVER

never request a packet resend

 

ARV_GV_STREAM_PACKET_RESEND_ALWAYS

request a packet resend if a packet was missing

 

ArvGvStream

typedef struct _ArvGvStream ArvGvStream;

Property Details

The “frame-retention” property

  “frame-retention”          guint

Amount of time Aravis is wating for frame completion after the last packet is received. A greater value will also increase the maximum frame latency in case of missing packets.

Owner: ArvGvStream

Flags: Read / Write / Construct

Default value: 100000


The “initial-packet-timeout” property

  “initial-packet-timeout”   guint

Delay before asking for a packet resend after the packet was detected missing for the first time. The reason for this delay is, depending on the network topology, stream packets are not always received in increasing id order. As the missing packet detection happens at each received packet, by verifying if each previous packet has been received, we could emit useless packet resend requests if they are not ordered.

Owner: ArvGvStream

Flags: Read / Write / Construct

Default value: 1000

Since: 0.8.15


The “packet-request-ratio” property

  “packet-request-ratio”     double

Maximum number of packet resend requests for a given frame, as a percentage of the number of packets per frame.

Owner: ArvGvStream

Flags: Read / Write / Construct

Allowed values: [0,2]

Default value: 0.25


The “packet-resend” property

  “packet-resend”            ArvGvStreamPacketResend

Packet resend policy. This only applies if the device supports packet resend.

Owner: ArvGvStream

Flags: Read / Write / Construct

Default value: ARV_GV_STREAM_PACKET_RESEND_ALWAYS


The “packet-timeout” property

  “packet-timeout”           guint

Timeout while waiting for a packet after a resend request, before asking again.

Owner: ArvGvStream

Flags: Read / Write / Construct

Default value: 20000


The “socket-buffer” property

  “socket-buffer”            ArvGvStreamSocketBuffer

Incoming socket buffer policy.

Owner: ArvGvStream

Flags: Read / Write / Construct

Default value: ARV_GV_STREAM_SOCKET_BUFFER_FIXED


The “socket-buffer-size” property

  “socket-buffer-size”       int

Size in bytes of the incoming socket buffer. A greater value helps to lower the number of missings packets, as the expense of an increased memory usage.

Owner: ArvGvStream

Flags: Read / Write / Construct

Allowed values: >= -1

Default value: 0