Camera API - manage video capture devices

Typedefs
typedef struct _MSWebCamManager	MSWebCamManager
typedef struct _MSWebCamDesc	MSWebCamDesc
typedef struct _MSWebCam	MSWebCam

Functions
MSWebCamManager *	ms_web_cam_manager_get (void)
void	ms_web_cam_manager_destroy (void)
MSWebCam *	ms_web_cam_manager_get_cam (MSWebCamManager *m, const char *id)
MSWebCam *	ms_web_cam_manager_get_default_cam (MSWebCamManager *m)
const MSList *	ms_web_cam_manager_get_list (MSWebCamManager *m)
void	ms_web_cam_manager_add_cam (MSWebCamManager *m, MSWebCam *c)
void	ms_web_cam_manager_prepend_cam (MSWebCamManager *m, MSWebCam *c)
void	ms_web_cam_manager_register_desc (MSWebCamManager *m, MSWebCamDesc *desc)
void	ms_web_cam_manager_reload (MSWebCamManager *m)
void	ms_web_cam_manager_update (MSWebCamManager *m)
struct _MSFilter *	ms_web_cam_create_reader (MSWebCam *obj)
MSWebCam *	ms_web_cam_new (MSWebCamDesc *desc)
void	ms_web_cam_destroy (MSWebCam *obj)
const char *	ms_web_cam_get_driver_type (const MSWebCam *obj)
const char *	ms_web_cam_get_name (const MSWebCam *obj)
const char *	ms_web_cam_get_string_id (MSWebCam *obj)

Detailed Description

Typedef Documentation

MSWebCamManager

MSWebCamManager

Structure for webcam manager object.

MSWebCamDesc

MSWebCamDesc

Structure for sound card description object.

MSWebCam

MSWebCam

Structure for sound card object.

Function Documentation

ms_web_cam_manager_get()

MSWebCamManager* ms_web_cam_manager_get

(

void

)

Retreive a webcam manager object.

Returns: MSWebCamManager if successful, NULL otherwise.

ms_web_cam_manager_destroy()

void ms_web_cam_manager_destroy

(

void

)

Destroy the webcam manager object.

ms_web_cam_manager_get_cam()

MSWebCam* ms_web_cam_manager_get_cam	(	MSWebCamManager *	m,
		const char *	id
	)

Retreive a webcam object based on its name.

Parameters

m	A webcam manager containing webcam.
id	A name for card to search.

Returns: MSWebCam if successful, NULL otherwise.

ms_web_cam_manager_get_default_cam()

MSWebCam* ms_web_cam_manager_get_default_cam

(

MSWebCamManager *

m

)

Retreive the default webcam object.

Parameters

m	A webcam manager containing webcams.

Returns: MSWebCam if successful, NULL otherwise.

ms_web_cam_manager_get_list()

const MSList* ms_web_cam_manager_get_list

(

MSWebCamManager *

m

)

Retreive the list of webcam objects.

Parameters

m	A webcam manager containing webcams.

Returns: MSList of cards if successful, NULL otherwise.

ms_web_cam_manager_add_cam()

void ms_web_cam_manager_add_cam	(	MSWebCamManager *	m,
		MSWebCam *	c
	)

Add a webcam object in a webcam manager's list.

Parameters

m	A webcam manager containing webcams
c	A web cam object.

ms_web_cam_manager_prepend_cam()

void ms_web_cam_manager_prepend_cam	(	MSWebCamManager *	m,
		MSWebCam *	c
	)

Add a webcam object on top of list of the webcam manager's list.

Parameters

m	A webcam manager containing webcams
c	A web cam object.

ms_web_cam_manager_register_desc()

void ms_web_cam_manager_register_desc	(	MSWebCamManager *	m,
		MSWebCamDesc *	desc
	)

Register a webcam descriptor in a webcam manager.

Parameters

m	A webcam manager containing sound cards.
desc	A webcam descriptor object.

ms_web_cam_manager_reload()

void ms_web_cam_manager_reload

(

MSWebCamManager *

m

)

Ask all registered MSWebCamDesc to detect the webcams again.

Parameters

m	A webcam manager

ms_web_cam_manager_update()

void ms_web_cam_manager_update

(

MSWebCamManager *

m

)

Ask all registered MSWebCamDesc to detect webcam modifications.

Parameters

m	A webcam manager

ms_web_cam_create_reader()

struct _MSFilter* ms_web_cam_create_reader

(

MSWebCam *

obj

)

Create an INPUT filter based on the selected camera.

Parameters

obj	A webcam object.

Returns: A MSFilter if successful, NULL otherwise.

ms_web_cam_new()

MSWebCam* ms_web_cam_new

(

MSWebCamDesc *

desc

)

Create a new webcam object.

Parameters

desc	A webcam description object.

Returns: MSWebCam if successful, NULL otherwise.

ms_web_cam_destroy()

void ms_web_cam_destroy

(

MSWebCam *

obj

)

Destroy webcam object.

Parameters

obj	A MSWebCam object.

ms_web_cam_get_driver_type()

const char* ms_web_cam_get_driver_type

(

const MSWebCam *

obj

)

Retreive a webcam's driver type string.

Internal driver types are either: "V4L V4LV2"

Parameters

obj	A webcam object.

Returns: a string if successful, NULL otherwise.

ms_web_cam_get_name()

const char* ms_web_cam_get_name

(

const MSWebCam *

obj

)

Retreive a webcam's name.

Parameters

obj	A webcam object.

Returns: a string if successful, NULL otherwise.

ms_web_cam_get_string_id()

const char* ms_web_cam_get_string_id

(

MSWebCam *

obj

)

Retreive webcam's id: ($driver_type: $name).

Parameters

obj	A webcam object.

Returns: A string if successful, NULL otherwise.