![]() |
![]() |
![]() |
Aravis Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy |
enum ArvStreamCallbackType; void (*ArvStreamCallback) (void *user_data
,ArvStreamCallbackType type
,ArvBuffer *buffer
); ArvStream; void arv_stream_push_buffer (ArvStream *stream
,ArvBuffer *buffer
); ArvBuffer * arv_stream_pop_buffer (ArvStream *stream
); void arv_stream_get_n_buffers (ArvStream *stream
,gint *n_input_buffers
,gint *n_output_buffers
); void arv_stream_get_statistics (ArvStream *stream
,guint64 *n_completed_buffers
,guint64 *n_failures
,guint64 *n_underruns
);
ArvStream provides an abstract base class for the implementation of video stream reception threads. The interface between the reception thread and the main thread is done using asynchronous queues, containing ArvBuffer objects.
typedef enum { ARV_STREAM_CALLBACK_TYPE_INIT, ARV_STREAM_CALLBACK_TYPE_EXIT, ARV_STREAM_CALLBACK_TYPE_START_BUFFER, ARV_STREAM_CALLBACK_TYPE_BUFFER_DONE } ArvStreamCallbackType;
Describes when the stream callback is called.
void (*ArvStreamCallback) (void *user_data
,ArvStreamCallbackType type
,ArvBuffer *buffer
);
void arv_stream_push_buffer (ArvStream *stream
,ArvBuffer *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.
|
a ArvStream |
|
buffer to push. [transfer full] |
ArvBuffer * arv_stream_pop_buffer (ArvStream *stream
);
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.
void arv_stream_get_n_buffers (ArvStream *stream
,gint *n_input_buffers
,gint *n_output_buffers
);
An accessor to the stream buffer queue lengths.
|
a ArvStream |
|
input queue length. [out][allow-none] |
|
output queue length. [out][allow-none] |
void arv_stream_get_statistics (ArvStream *stream
,guint64 *n_completed_buffers
,guint64 *n_failures
,guint64 *n_underruns
);
An accessor to the stream statistics.
|
a ArvStream |
|
number of complete received buffers. [out][allow-none] |
|
number of reception failures. [out][allow-none] |
|
number of input buffer underruns. [out][allow-none] |