ArvGvStream

ArvGvStream — Gigabit ethernet camera stream

Synopsis

enum                ArvGvStreamSocketBuffer;
enum                ArvGvStreamPacketResend;
                    ArvGvStream;
ArvStream * 	       arv_gv_stream_new                   (GInetAddress *device_address,
                                                         guint16 port,
                                                         ArvStreamCallback callback,
                                                         void *user_data,
                                                         guint64 timestamp_tick_frequency,
                                                         guint packet_size);
guint16             arv_gv_stream_get_port              (ArvGvStream *gv_stream);
void                arv_gv_stream_get_statistics        (ArvGvStream *gv_stream,
                                                         guint64 *n_resent_packets,
                                                         guint64 *n_missing_packets);

Object Hierarchy

  GObject
   +----ArvStream
         +----ArvGvStream

Properties

  "frame-retention"          guint                 : Read / Write
  "packet-resend"            ArvGvStreamPacketResend  : Read / Write
  "packet-timeout"           guint                 : Read / Write
  "socket-buffer"            ArvGvStreamSocketBuffer  : Read / Write
  "socket-buffer-size"       gint                  : Read / Write

Description

Details

enum ArvGvStreamSocketBuffer

typedef enum {
	ARV_GV_STREAM_SOCKET_BUFFER_FIXED,
	ARV_GV_STREAM_SOCKET_BUFFER_AUTO
} ArvGvStreamSocketBuffer;

ARV_GV_STREAM_SOCKET_BUFFER_FIXED

 socket buffer is set to a given fixed value

ARV_GV_STREAM_SOCKET_BUFFER_AUTO

 sockect buffer is set with respect to the payload size

enum ArvGvStreamPacketResend

typedef enum {
	ARV_GV_STREAM_PACKET_RESEND_NEVER,
	ARV_GV_STREAM_PACKET_RESEND_ALWAYS
} ArvGvStreamPacketResend;

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;

arv_gv_stream_new ()

ArvStream * 	       arv_gv_stream_new                   (GInetAddress *device_address,
                                                         guint16 port,
                                                         ArvStreamCallback callback,
                                                         void *user_data,
                                                         guint64 timestamp_tick_frequency,
                                                         guint packet_size);

device_address :

 inet device address for gvsp

port :

 inet port

callback :

 processing callback. [scope call]

user_data :

 user data for callback. [closure]

timestamp_tick_frequency :

 camera tick frequency for timestamping

packet_size :

 gvsp packet size, in bytes Return value: (transfer full): a new ArvStream.

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);

Property Details

The "frame-retention" property

  "frame-retention"          guint                 : Read / Write

Packet retention, in µs.

Allowed values: [1000,10000000]

Default value: 200000

The "packet-resend" property

  "packet-resend"            ArvGvStreamPacketResend  : Read / Write

Packet resend behaviour.

Default value: ARV_GV_STREAM_PACKET_RESEND_ALWAYS

The "packet-timeout" property

  "packet-timeout"           guint                 : Read / Write

Packet timeout, in µs.

Allowed values: [1000,10000000]

Default value: 40000

The "socket-buffer" property

  "socket-buffer"            ArvGvStreamSocketBuffer  : Read / Write

Socket buffer behaviour.

Default value: ARV_GV_STREAM_SOCKET_BUFFER_AUTO

The "socket-buffer-size" property

  "socket-buffer-size"       gint                  : Read / Write

Socket buffer size, in bytes.

Allowed values: >= G_MAXULONG

Default value: 0

Generated by GTK-Doc V1.17