198c401647a225070593f04b06bdac020cc7f02a
[rtmpclient.git] / app / src / main / jni / libuvc-0.0.6 / standard-units.yaml
1 units:
2   camera_terminal:
3     type: standard
4     description: Standard camera input terminal (captures images from sensor)
5     control_prefix: CT
6     controls:
7       scanning_mode:
8         control: SCANNING_MODE
9         length: 1
10         fields:
11           mode:
12             type: int
13             position: 0
14             length: 1
15             doc: '0: interlaced, 1: progressive'
16       ae_mode:
17         control: AE_MODE
18         length: 1
19         fields:
20           mode:
21             type: int
22             position: 0
23             length: 1
24             doc: '1: manual mode; 2: auto mode; 4: shutter priority mode; 8: aperture
25               priority mode'
26         doc:
27           get: |-
28             @brief Reads camera's auto-exposure mode.
29
30             See uvc_set_ae_mode() for a description of the available modes.
31           set: |-
32             @brief Sets camera's auto-exposure mode.
33
34             Cameras may support any of the following AE modes:
35              * UVC_AUTO_EXPOSURE_MODE_MANUAL (1) - manual exposure time, manual iris
36              * UVC_AUTO_EXPOSURE_MODE_AUTO (2) - auto exposure time, auto iris
37              * UVC_AUTO_EXPOSURE_MODE_SHUTTER_PRIORITY (4) - manual exposure time, auto iris
38              * UVC_AUTO_EXPOSURE_MODE_APERTURE_PRIORITY (8) - auto exposure time, manual iris
39
40             Most cameras provide manual mode and aperture priority mode.
41       ae_priority:
42         control: AE_PRIORITY
43         length: 1
44         fields:
45           priority:
46             type: int
47             position: 0
48             length: 1
49             doc: '0: frame rate must remain constant; 1: frame rate may be varied
50               for AE purposes'
51         doc:
52           get: |-
53             @brief Checks whether the camera may vary the frame rate for exposure control reasons.
54             See uvc_set_ae_priority() for a description of the `priority` field.
55           set: |-
56             @brief Chooses whether the camera may vary the frame rate for exposure control reasons.
57             A `priority` value of zero means the camera may not vary its frame rate. A value of 1
58             means the frame rate is variable. This setting has no effect outside of the `auto` and
59             `shutter_priority` auto-exposure modes.
60       exposure_abs:
61         control: EXPOSURE_TIME_ABSOLUTE
62         length: 4
63         fields:
64           time:
65             type: int
66             position: 0
67             length: 4
68             doc: ''
69         doc:
70           get: |-
71             @brief Gets the absolute exposure time.
72
73             See uvc_set_exposure_abs() for a description of the `time` field.
74           set: |-
75             @brief Sets the absolute exposure time.
76
77             The `time` parameter should be provided in units of 0.0001 seconds (e.g., use the value 100
78             for a 10ms exposure period). Auto exposure should be set to `manual` or `shutter_priority`
79             before attempting to change this setting.
80       exposure_rel:
81         control: EXPOSURE_TIME_RELATIVE
82         length: 1
83         fields:
84           step:
85             type: int
86             position: 0
87             length: 1
88             signed: true
89             doc: number of steps by which to change the exposure time, or zero to
90               set the default exposure time
91         doc: '@brief {gets_sets} the exposure time relative to the current setting.'
92       focus_abs:
93         control: FOCUS_ABSOLUTE
94         length: 2
95         fields:
96           focus:
97             type: int
98             position: 0
99             length: 2
100             doc: focal target distance in millimeters
101         doc: '@brief {gets_sets} the distance at which an object is optimally focused.'
102       focus_rel:
103         control: FOCUS_RELATIVE
104         length: 2
105         fields:
106           focus_rel:
107             type: int
108             position: 0
109             length: 1
110             signed: true
111             doc: TODO
112           speed:
113             type: int
114             position: 1
115             length: 1
116             doc: TODO
117       focus_simple_range:
118         control: FOCUS_SIMPLE
119         length: 1
120         fields:
121           focus:
122             type: int
123             position: 0
124             length: 1
125             doc: TODO
126       focus_auto:
127         control: FOCUS_AUTO
128         length: 1
129         fields:
130           state:
131             type: int
132             position: 0
133             length: 1
134             doc: TODO
135       iris_abs:
136         control: IRIS_ABSOLUTE
137         length: 2
138         fields:
139           iris:
140             type: int
141             position: 0
142             length: 2
143             doc: TODO
144       iris_rel:
145         control: IRIS_RELATIVE
146         length: 1
147         fields:
148           iris_rel:
149             type: int
150             position: 0
151             length: 1
152             doc: TODO
153       zoom_abs:
154         control: ZOOM_ABSOLUTE
155         length: 2
156         fields:
157           focal_length:
158             type: int
159             position: 0
160             length: 2
161             doc: TODO
162       zoom_rel:
163         control: ZOOM_RELATIVE
164         length: 3
165         fields:
166           zoom_rel:
167             type: int
168             position: 0
169             length: 1
170             signed: true
171             doc: TODO
172           digital_zoom:
173             type: int
174             position: 1
175             length: 1
176             doc: TODO
177           speed:
178             type: int
179             position: 2
180             length: 1
181             doc: TODO
182       pantilt_abs:
183         control: PANTILT_ABSOLUTE
184         length: 8
185         fields:
186           pan:
187             type: int
188             position: 0
189             length: 4
190             signed: true
191             doc: TODO
192           tilt:
193             type: int
194             position: 4
195             length: 4
196             signed: true
197             doc: TODO
198       pantilt_rel:
199         control: PANTILT_RELATIVE
200         length: 4
201         fields:
202           pan_rel:
203             type: int
204             position: 0
205             length: 1
206             signed: true
207             doc: TODO
208           pan_speed:
209             type: int
210             position: 1
211             length: 1
212             doc: TODO
213           tilt_rel:
214             type: int
215             position: 2
216             length: 1
217             signed: true
218             doc: TODO
219           tilt_speed:
220             type: int
221             position: 3
222             length: 1
223             doc: TODO
224       roll_abs:
225         control: ROLL_ABSOLUTE
226         length: 2
227         fields:
228           roll:
229             type: int
230             position: 0
231             length: 2
232             signed: true
233             doc: TODO
234       roll_rel:
235         control: ROLL_RELATIVE
236         length: 2
237         fields:
238           roll_rel:
239             type: int
240             position: 0
241             length: 1
242             signed: true
243             doc: TODO
244           speed:
245             type: int
246             position: 1
247             length: 1
248             doc: TODO
249       privacy:
250         control: PRIVACY
251         length: 1
252         fields:
253           privacy:
254             type: int
255             position: 0
256             length: 1
257             doc: TODO
258       digital_window:
259         control: DIGITAL_WINDOW
260         length: 12
261         fields:
262           window_top:
263             type: int
264             position: 0
265             length: 2
266             doc: TODO
267           window_left:
268             type: int
269             position: 2
270             length: 2
271             doc: TODO
272           window_bottom:
273             type: int
274             position: 4
275             length: 2
276             doc: TODO
277           window_right:
278             type: int
279             position: 6
280             length: 2
281             doc: TODO
282           num_steps:
283             type: int
284             position: 8
285             length: 2
286             doc: TODO
287           num_steps_units:
288             type: int
289             position: 10
290             length: 2
291             doc: TODO
292       digital_roi:
293         control: REGION_OF_INTEREST
294         length: 10
295         fields:
296           roi_top:
297             type: int
298             position: 0
299             length: 2
300             doc: TODO
301           roi_left:
302             type: int
303             position: 2
304             length: 2
305             doc: TODO
306           roi_bottom:
307             type: int
308             position: 4
309             length: 2
310             doc: TODO
311           roi_right:
312             type: int
313             position: 6
314             length: 2
315             doc: TODO
316           auto_controls:
317             type: int
318             position: 8
319             length: 2
320             doc: TODO
321   processing_unit:
322     type: standard
323     description: Standard processing unit (processes images between other units)
324     control_prefix: PU
325     controls:
326       backlight_compensation:
327         control: BACKLIGHT_COMPENSATION
328         length: 2
329         fields:
330           backlight_compensation:
331             type: int
332             position: 0
333             length: 2
334             doc: device-dependent backlight compensation mode; zero means backlight
335               compensation is disabled
336       brightness:
337         control: BRIGHTNESS
338         length: 2
339         fields:
340           brightness:
341             type: int
342             position: 0
343             length: 2
344             signed: true
345             doc: TODO
346       contrast:
347         control: CONTRAST
348         length: 2
349         fields:
350           contrast:
351             type: int
352             position: 0
353             length: 2
354             doc: TODO
355       contrast_auto:
356         control: CONTRAST_AUTO
357         length: 1
358         fields:
359           contrast_auto:
360             type: int
361             position: 0
362             length: 1
363             doc: TODO
364       gain:
365         control: GAIN
366         length: 2
367         fields:
368           gain:
369             type: int
370             position: 0
371             length: 2
372             doc: TODO
373       power_line_frequency:
374         control: POWER_LINE_FREQUENCY
375         length: 1
376         fields:
377           power_line_frequency:
378             type: int
379             position: 0
380             length: 1
381             doc: TODO
382       hue:
383         control: HUE
384         length: 2
385         fields:
386           hue:
387             type: int
388             position: 0
389             length: 2
390             signed: true
391             doc: TODO
392       hue_auto:
393         control: HUE_AUTO
394         length: 1
395         fields:
396           hue_auto:
397             type: int
398             position: 0
399             length: 1
400             doc: TODO
401       saturation:
402         control: SATURATION
403         length: 2
404         fields:
405           saturation:
406             type: int
407             position: 0
408             length: 2
409             doc: TODO
410       sharpness:
411         control: SHARPNESS
412         length: 2
413         fields:
414           sharpness:
415             type: int
416             position: 0
417             length: 2
418             doc: TODO
419       gamma:
420         control: GAMMA
421         length: 2
422         fields:
423           gamma:
424             type: int
425             position: 0
426             length: 2
427             doc: TODO
428       white_balance_temperature:
429         control: WHITE_BALANCE_TEMPERATURE
430         length: 2
431         fields:
432           temperature:
433             type: int
434             position: 0
435             length: 2
436             doc: TODO
437       white_balance_temperature_auto:
438         control: WHITE_BALANCE_TEMPERATURE_AUTO
439         length: 1
440         fields:
441           temperature_auto:
442             type: int
443             position: 0
444             length: 1
445             doc: TODO
446       white_balance_component:
447         control: WHITE_BALANCE_COMPONENT
448         length: 4
449         fields:
450           blue:
451             type: int
452             position: 0
453             length: 2
454             doc: TODO
455           red:
456             type: int
457             position: 2
458             length: 2
459             doc: TODO
460       white_balance_component_auto:
461         control: WHITE_BALANCE_COMPONENT_AUTO
462         length: 1
463         fields:
464           white_balance_component_auto:
465             type: int
466             position: 0
467             length: 1
468             doc: TODO
469       digital_multiplier:
470         control: DIGITAL_MULTIPLIER
471         length: 2
472         fields:
473           multiplier_step:
474             type: int
475             position: 0
476             length: 2
477             doc: TODO
478       digital_multiplier_limit:
479         control: DIGITAL_MULTIPLIER_LIMIT
480         length: 2
481         fields:
482           multiplier_step:
483             type: int
484             position: 0
485             length: 2
486             doc: TODO
487       analog_video_standard:
488         control: ANALOG_VIDEO_STANDARD
489         length: 1
490         fields:
491           video_standard:
492             type: int
493             position: 0
494             length: 1
495             doc: TODO
496       analog_video_lock_status:
497         control: ANALOG_LOCK_STATUS
498         length: 1
499         fields:
500           status:
501             type: int
502             position: 0
503             length: 1
504             doc: TODO
505   selector_unit:
506     type: standard
507     description: Standard selector unit (controls connectivity between other units)
508     control_prefix: SU
509     controls:
510       input_select:
511         control: INPUT_SELECT
512         length: 1
513         fields:
514           selector:
515             type: int
516             position: 0
517             length: 1
518             doc: TODO