gate_video_source_t Interface Reference

General video frame reader interface. More...

#include <videosources.h>

Inheritance diagram for gate_video_source_t:

Public Member Functions
char const *	get_id ()
	Returns a system-unique-ID about the video source.
char const *	get_name ()
	Returns a human readable name of the video source.
gate_intptr_t	get_handle ()
	Returns the native handle of the internal implementation resouce.
gate_size_t	get_supported_formats (gate_video_format_t *format_buffer, gate_size_t format_buffer_count)
	Fills the given buffer with different supported frame formats (that can be used in open() method)
gate_result_t	open (gate_video_format_t const *format)
	Openes a video frame stream source to read frames in a specific format.
gate_result_t	close ()
	Closes an opened video frame stream source.
Public Member Functions inherited from gate_video_reader_t
gate_result_t	read (gate_video_frame_t *frame)
	Reads one frame from a video frame source.
Public Member Functions inherited from gate_object_t
char const *	get_interface_name ()
	Returns on object's interface path name.
void	release ()
	Decrease object's reference counter, releases the object when count reaches zero.
int	retain ()
	Increase object's reference counter.

Detailed Description

General video frame reader interface.

Member Function Documentation

get_id()

char const * get_id

(

)

Returns a system-unique-ID about the video source.

Returns

0-terminated string representing a unique ID

get_name()

char const * get_name

(

)

Returns a human readable name of the video source.

Returns

0-terminated string representing the name

get_handle()

gate_intptr_t get_handle

(

)

Returns the native handle of the internal implementation resouce.

Returns

Handle to resource

get_supported_formats()

gate_size_t get_supported_formats	(	gate_video_format_t *	format_buffer,
		gate_size_t	format_buffer_count )

Fills the given buffer with different supported frame formats (that can be used in open() method)

Parameters

[in,out]	format_buffer	Pointer to array of format, to be initialized with available supported formats
[in]	format_buffer_count	Maximum capacity of format_buffer

Returns

Amount of format-structs in the buffer, that were initialized with format informations.

open()

gate_result_t open

(

gate_video_format_t const *

format

)

Openes a video frame stream source to read frames in a specific format.

Parameters

[in]

format

Pointer to format information describing desired frame details (e.g. dimensions, color depth)

Returns

GATE_RESULT_* result codes

close()

gate_result_t close

(

)

Closes an opened video frame stream source.

Returns

GATE_RESULT_* result codes

---

The documentation for this interface was generated from the following file:

• src/gate/io/videosources.h