Graphical User Interface Functions

Contains functions providing a basic graphical user interface for common tasks. More...

Data Structures

struct

A structure containing options customizing the appearance and behavior of the property dialog displayed by the ic4_gui_grabber_show_device_properties() and ic4_gui_show_property_map() functions. More...

Enumerations

enum

IC4_PROPERTY_DIALOG_FLAGS {
IC4_PROPERTY_DIALOG_DEFAULT = 0 , IC4_PROPERTY_DIALOG_ALLOW_STREAM_RESTART = 1 , IC4_PROPERTY_DIALOG_RESTORE_STATE_ON_CANCEL = 2 , IC4_PROPERTY_DIALOG_SHOW_TOP_CATEGORY = 4 ,
IC4_PROPERTY_DIALOG_HIDE_FILTER = 8
}

Defines a set of flags to customize the behavior of the dialogs displayed by theic4_gui_grabber_show_device_properties() and ic4_gui_show_property_map() functions.

Functions

IC4GUI_API bool	ic4_gui_grabber_select_device (IC4_WINDOW_HANDLE hParent, struct IC4_GRABBER *pGrabber) Shows a dialog that allows the user to select a video capture device.
IC4GUI_API bool	ic4_gui_select_device (IC4_WINDOW_HANDLE hParent, struct IC4_DEVICE_INFO **ppInfo) Shows a dialog that allows the user to select a video capture device.
IC4GUI_API bool	ic4_gui_grabber_show_device_properties (IC4_WINDOW_HANDLE hParent, struct IC4_GRABBER pGrabber, const struct IC4_PROPERTY_DIALOG_OPTIONS options) Shows a dialog box allowing the user to configure the properties of the video capture opened in the passed IC4_GRABBER.
IC4GUI_API bool	ic4_gui_show_property_map (IC4_WINDOW_HANDLE hParent, struct IC4_PROPERTY_MAP pPropertyMap, const struct IC4_PROPERTY_DIALOG_OPTIONS options) Shows a dialog box allowing the user to configure the properties of a IC4_PROPERTY_MAP.

Detailed Description

Contains functions providing a basic graphical user interface for common tasks.

The GUI support functions are declared in ic4gui/C_ic4gui.h.

Function Documentation

◆ ic4_gui_grabber_select_device()

IC4GUI_API bool ic4_gui_grabber_select_device	(	IC4_WINDOW_HANDLE	hParent,
		struct IC4_GRABBER *	pGrabber
	)

Shows a dialog that allows the user to select a video capture device.

The device is opened in the passed IC4_GRABBER object.

Parameters

[in]	hParent	A parent window for the dialog
[in]	pGrabber	A grabber object in which the new device is to be opened

Returns: true, if a device was selected and opened succesfully, otherwise false.

◆ ic4_gui_grabber_show_device_properties()

IC4GUI_API bool ic4_gui_grabber_show_device_properties	(	IC4_WINDOW_HANDLE	hParent,
		struct IC4_GRABBER *	pGrabber,
		const struct IC4_PROPERTY_DIALOG_OPTIONS *	options
	)

Shows a dialog box allowing the user to configure the properties of the video capture opened in the passed IC4_GRABBER.

Parameters

[in]	hParent	A parent window for the dialog
	pGrabber	A grabber object whose video capture device is to be configured
[in]	options	An options structure to customize the dialog's behavior

Returns: true, if the user closed the dialog using the OK button, otherwise false.

◆ ic4_gui_select_device()

IC4GUI_API bool ic4_gui_select_device	(	IC4_WINDOW_HANDLE	hParent,
		struct IC4_DEVICE_INFO **	ppInfo
	)

Shows a dialog that allows the user to select a video capture device.

A IC4_DEVICE_INFO representing the selected device is returned in an output parameter.

Parameters

[in]	hParent	A parent window for the dialog
[out]	ppInfo	A pointer to a handle to receive the device information object. When the device information object is no longer required, release the object reference using ic4_devinfo_unref().

Returns: true, if a device was selected, otherwise false.

◆ ic4_gui_show_property_map()

IC4GUI_API bool ic4_gui_show_property_map	(	IC4_WINDOW_HANDLE	hParent,
		struct IC4_PROPERTY_MAP *	pPropertyMap,
		const struct IC4_PROPERTY_DIALOG_OPTIONS *	options
	)

Shows a dialog box allowing the user to configure the properties of a IC4_PROPERTY_MAP.

Parameters

[in]	hParent	A parent window for the dialog
[in]	pPropertyMap	A property map to configure
[in]	options	An options structure to customize the dialog's behavior

Returns: true, if the user closed the dialog using the OK button, otherwise false.