Class

AravisGvStream

Description

final class Aravis.GvStream : Aravis.Stream {
  /* No available fields */
}
No description available.

Ancestors

Implements

Instance methods

arv_gv_stream_get_port
No description available.

arv_gv_stream_get_statistics
No description available.

Methods inherited from ArvStream (17)
arv_stream_get_emit_signals

Check if stream will emit its signals.

since: 0.2.0

arv_stream_get_info_double
No description available.

since: 0.8.11

arv_stream_get_info_double_by_name
No description available.

since: 0.8.11

arv_stream_get_info_name
No description available.

since: 0.8.11

arv_stream_get_info_type
No description available.

since: 0.8.11

arv_stream_get_info_uint64
No description available.

since: 0.8.11

arv_stream_get_info_uint64_by_name
No description available.

since: 0.8.11

arv_stream_get_n_buffers

An accessor to the stream buffer queue lengths.

since: 0.2.0

arv_stream_get_n_infos
No description available.

since: 0.8.11

arv_stream_get_statistics

An accessor to the stream statistics.

since: 0.2.0

arv_stream_pop_buffer

Pops a buffer from the output queue of stream. The retrieved buffer may contain an invalid image. Caller should check the buffer status before using it. This function blocks until a buffer is available.

since: 0.2.0

arv_stream_push_buffer

Pushes a ArvBuffer to the stream thread. The stream takes ownership of buffer, and will free all the buffers still in its queues when destroyed.

since: 0.2.0

arv_stream_set_emit_signals

Make stream emit signals. This option is by default disabled because signal emission is expensive and unneeded when the application prefers to operate in pull mode.

since: 0.2.0

arv_stream_start_thread

Start the stream receiving thread. The thread is automatically started when the ArvStream object is instantiated, so this function is only useful if the thread was stopped using arv_stream_stop_thread.

since: 0.6.2

arv_stream_stop_thread

Stop the stream receiving thread, and optionally delete all the ArvBuffer stored in the stream object queues. Main use of this function is to be able to quickly change an acquisition parameter that changes the payload size, without deleting/recreating the stream object.

since: 0.6.2

arv_stream_timeout_pop_buffer

Pops a buffer from the output queue of stream, waiting no more than timeout. The retrieved buffer may contain an invalid image. Caller should check the buffer status before using it.

since: 0.2.0

arv_stream_try_pop_buffer

Pops a buffer from the output queue of stream. The retrieved buffer may contain an invalid image. Caller should check the buffer status before using it. This is the non blocking version of pop_buffer.

since: 0.2.0

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Methods inherited from GInitable (1)
g_initable_init

Initializes the object implementing the interface.

unstable since: 2.22

Properties

Aravis.GvStream:frame-retention

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:initial-packet-timeout

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.

since: 0.8.15

Aravis.GvStream:packet-request-ratio

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

Aravis.GvStream:packet-resend

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

Aravis.GvStream:packet-timeout

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

Aravis.GvStream:socket-buffer

Incoming socket buffer policy.

Aravis.GvStream:socket-buffer-size

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.

Properties inherited from ArvStream (5)
Aravis.Stream:callback
No description available.

Aravis.Stream:callback-data
No description available.

Aravis.Stream:destroy-notify
No description available.

Aravis.Stream:device
No description available.

Aravis.Stream:emit-signals
No description available.

Signals

Signals inherited from ArvStream (1)
ArvStream::new-buffer

Signal that a new buffer is available.

since: 0.2.0

Signals inherited from GObject (1)
GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure

struct AravisGvStreamClass {
  ArvStreamClass parent_class;
  
}
No description available.
Class members
parent_class: ArvStreamClass
No description available.