Aravis.GvStream¶

Subclasses:: None

Methods¶

Inherited:: Aravis.Stream (17), GObject.Object (37), Gio.Initable (2)
Structs:: GObject.ObjectClass (5)

	`get_port` ()
	`get_statistics` ()

Virtual Methods¶

Inherited:: Aravis.Stream (3), GObject.Object (7), Gio.Initable (1)

Properties¶

Inherited:: Aravis.Stream (5)

Name	Type	Flags	Short Description
`frame-retention`	`int`	r/w/c	Packet retention, in µs
`initial-packet-timeout`	`int`	r/w/c	Initial packet timeout, in µs
`packet-request-ratio`	`float`	r/w/c	Packet resend request limit as a percentage of frame packet number
`packet-resend`	`Aravis.GvStreamPacketResend`	r/w/c	Packet resend behaviour
`packet-timeout`	`int`	r/w/c	Packet timeout, in µs
`socket-buffer`	`Aravis.GvStreamSocketBuffer`	r/w/c	Socket buffer behaviour
`socket-buffer-size`	`int`	r/w/c	Socket buffer size, in bytes

Signals¶

Inherited:: Aravis.Stream (1), GObject.Object (1)

Fields¶

Inherited:: Aravis.Stream (1), GObject.Object (1)

Class Details¶

class Aravis.GvStream(**kwargs)¶

Bases:: Aravis.Stream
Abstract:: No
Structure:: Aravis.GvStreamClass

get_port()¶

Return type:: int

get_statistics()¶

Return type:: (n_resent_packets: int, n_missing_packets: int)

Property Details¶

Aravis.GvStream.props.frame_retention¶

Name:: frame-retention
Type:: int
Default Value:: 100000
Flags:: READABLE, WRITABLE, CONSTRUCT

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.

Aravis.GvStream.props.initial_packet_timeout¶

Name:: initial-packet-timeout
Type:: int
Default Value:: 1000
Flags:: READABLE, WRITABLE, CONSTRUCT

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.

New in version 0.8.15.

Aravis.GvStream.props.packet_request_ratio¶

Name:: packet-request-ratio
Type:: float
Default Value:: 0.25
Flags:: READABLE, WRITABLE, CONSTRUCT

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

Aravis.GvStream.props.packet_resend¶

Name:: packet-resend
Type:: Aravis.GvStreamPacketResend
Default Value:: Aravis.GvStreamPacketResend.ALWAYS
Flags:: READABLE, WRITABLE, CONSTRUCT

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

Aravis.GvStream.props.packet_timeout¶

Name:: packet-timeout
Type:: int
Default Value:: 20000
Flags:: READABLE, WRITABLE, CONSTRUCT

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

Aravis.GvStream.props.socket_buffer¶

Name:: socket-buffer
Type:: Aravis.GvStreamSocketBuffer
Default Value:: Aravis.GvStreamSocketBuffer.FIXED
Flags:: READABLE, WRITABLE, CONSTRUCT

Incoming socket buffer policy.

Aravis.GvStream.props.socket_buffer_size¶

Name:: socket-buffer-size
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, CONSTRUCT

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.