mediastreamer2 5.2.0
Data Structures | Macros | Typedefs | Functions
Camera API - manage video capture devices
Collaboration diagram for Camera API - manage video capture devices:

Data Structures

struct  _MSWebCamManager
 
struct  _MSWebCamDesc
 
struct  _MSWebCam
 

Macros

#define MS_STATIC_IMAGE_SET_IMAGE    MS_FILTER_METHOD(MS_STATIC_IMAGE_ID,0,const char)
 

Typedefs

typedef struct _MSWebCamManager MSWebCamManager
 
typedef void(* MSWebCamDetectFunc) (MSWebCamManager *obj)
 
typedef void(* MSWebCamInitFunc) (struct _MSWebCam *obj)
 
typedef void(* MSWebCamUninitFunc) (struct _MSWebCam *obj)
 
typedef struct _MSFilter *(* MSWebCamCreateReaderFunc) (struct _MSWebCam *obj)
 
typedef bool_t(* MSWebCamEncodeToMimeType) (struct _MSWebCam *obj, const char *mime_type)
 
typedef struct _MSWebCamDesc MSWebCamDesc
 
typedef struct _MSWebCam MSWebCam
 

Functions

MSWebCamManagerms_web_cam_manager_get (void)
 
MSFactoryms_web_cam_get_factory (MSWebCam *c)
 
MSWebCamManagerms_web_cam_manager_new (void)
 
void ms_web_cam_manager_destroy (MSWebCamManager *scm)
 
MSWebCamms_web_cam_manager_get_cam (MSWebCamManager *m, const char *id)
 
MSWebCamms_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)
 
MSWebCamms_web_cam_manager_create_cam (MSWebCamManager *m, MSWebCamDesc *desc)
 
void ms_web_cam_set_manager (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)
 
struct _MSFilterms_web_cam_create_reader (MSWebCam *obj)
 
MSWebCamms_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)
 
void ms_static_image_set_default_image (const char *path)
 
const char * ms_static_image_get_default_image (void)
 

Detailed Description

Macro Definition Documentation

◆ MS_STATIC_IMAGE_SET_IMAGE

#define MS_STATIC_IMAGE_SET_IMAGE    MS_FILTER_METHOD(MS_STATIC_IMAGE_ID,0,const char)

method for the "nowebcam" filter

Typedef Documentation

◆ MSWebCam

Structure for sound card object.

◆ MSWebCamDesc

Structure for sound card description object.

◆ MSWebCamManager

Structure for webcam manager object.

Function Documentation

◆ ms_web_cam_create_reader()

struct _MSFilter * ms_web_cam_create_reader ( MSWebCam obj)

Create an INPUT filter based on the selected camera.

Parameters
objA webcam object.

Returns: A MSFilter if successfull, NULL otherwise.

◆ ms_web_cam_destroy()

void ms_web_cam_destroy ( MSWebCam obj)

Destroy webcam object.

Parameters
objA 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
objA webcam object.

Returns: a string if successfull, NULL otherwise.

◆ ms_web_cam_get_factory()

MSFactory * ms_web_cam_get_factory ( MSWebCam c)

Returns the factory from the webcam object.

Parameters
cMSWebCam used to get to the factory.

◆ ms_web_cam_get_name()

const char * ms_web_cam_get_name ( const MSWebCam obj)

Retreive a webcam's name.

Parameters
objA webcam object.

Returns: a string if successfull, 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
objA webcam object.

Returns: A string if successfull, 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
mA webcam manager containing webcams
cA web cam object.

◆ ms_web_cam_manager_destroy()

void ms_web_cam_manager_destroy ( MSWebCamManager scm)

Destroy the webcam manager object. You usually don't need this function, ms_factory_destroy() doing the job for you.

◆ ms_web_cam_manager_get()

MSWebCamManager * ms_web_cam_manager_get ( void  )

Retrieve a webcam manager object.

Returns
: MSWebCamManager if successfull, NULL otherwise.
Deprecated:
use ms_factory_get_web_cam_manager().

◆ 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
mA webcam manager containing webcam.
idA name for card to search.

Returns: MSWebCam if successfull, 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
mA webcam manager containing webcams.

Returns: MSWebCam if successfull, 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
mA webcam manager containing webcams.

Returns: MSList of cards if successfull, NULL otherwise.

◆ ms_web_cam_manager_new()

MSWebCamManager * ms_web_cam_manager_new ( void  )

Create a webcam manager object. You usually do not need this function, instead get the webcam manager from a factory with ms_factory_get_web_cam_manager().

◆ 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
mA webcam manager containing webcams
cA 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
mA webcam manager containing sound cards.
descA 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
mA webcam manager

◆ ms_web_cam_new()

MSWebCam * ms_web_cam_new ( MSWebCamDesc desc)

Create a new webcam object.

Parameters
descA webcam description object.

Returns: MSWebCam if successfull, NULL otherwise.