1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
/* $Id$ */
/*
* Copyright (C) 2008-2011 Teluu Inc. (http://www.teluu.com)
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#ifndef __PJMEDIA_VIDEODEV_VIDEODEV_H__
#define __PJMEDIA_VIDEODEV_VIDEODEV_H__
/**
* @file videodev.h
* @brief Video device API.
*/
#include <pjmedia/videodev.h>
PJ_BEGIN_DECL
/**
* @defgroup video_device_reference Video Subsystem API Reference
* @ingroup video_subsystem_api
* @brief API Reference
* @{
*/
/**
* Initialize the video device subsystem. This will register all supported
* video device factories to the video device subsystem. This function may be
* called more than once, but each call to this function must have the
* corresponding #pjmedia_vid_dev_subsys_shutdown() call.
*
* @param pf The pool factory.
*
* @return PJ_SUCCESS on successful operation or the appropriate
* error code.
*/
PJ_DECL(pj_status_t) pjmedia_vid_dev_subsys_init(pj_pool_factory *pf);
/**
* Get the pool factory registered to the video device subsystem.
*
* @return The pool factory.
*/
PJ_DECL(pj_pool_factory*) pjmedia_vid_dev_subsys_get_pool_factory(void);
/**
* Shutdown the video device subsystem. This will destroy all video device
* factories registered in the video device subsystem. Note that currently
* opened video streams may or may not be closed, depending on the
* implementation of the video device factories.
*
* @return PJ_SUCCESS on successful operation or the appropriate
* error code.
*/
PJ_DECL(pj_status_t) pjmedia_vid_dev_subsys_shutdown(void);
/**
* Register a supported video device factory to the video device subsystem.
* Application can either register a function to create the factory, or
* an instance of an already created factory.
*
* This function can only be called after calling
* #pjmedia_vid_dev_subsys_init().
*
* @param vdf The factory creation function. Either vdf or factory
* argument must be specified.
* @param factory Factory instance. Either vdf or factory
* argument must be specified.
*
* @return PJ_SUCCESS on successful operation or the appropriate
* error code.
*/
PJ_DECL(pj_status_t)
pjmedia_vid_register_factory(pjmedia_vid_dev_factory_create_func_ptr vdf,
pjmedia_vid_dev_factory *factory);
/**
* Unregister a video device factory from the video device subsystem. This
* function can only be called after calling #pjmedia_vid_dev_subsys_init().
* Devices from this factory will be unlisted. If a device from this factory
* is currently in use, then the behavior is undefined.
*
* @param vdf The video device factory. Either vdf or factory argument
* must be specified.
* @param factory The factory instance. Either vdf or factory argument
* must be specified.
*
* @return PJ_SUCCESS on successful operation or the appropriate
* error code.
*/
PJ_DECL(pj_status_t)
pjmedia_vid_unregister_factory(pjmedia_vid_dev_factory_create_func_ptr vdf,
pjmedia_vid_dev_factory *factory);
/**
* @}
*/
PJ_END_DECL
#endif /* __PJMEDIA_VIDEODEV_VIDEODEV_H__ */
|
