/usr/share/gtk-doc/html/libunicap/libunicap-unicap.html is in libunicap-docs 0.9.12-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>unicap</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Unicap Reference Manual">
<link rel="up" href="ch01.html" title="unicap">
<link rel="prev" href="ch01.html" title="unicap">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="ch01.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Unicap Reference Manual</th>
<td> </td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libunicap-unicap.synopsis" class="shortcut">Top</a>
|
<a href="#libunicap-unicap.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libunicap-unicap"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libunicap-unicap.top_of_page"></a>unicap</span></h2>
<p>unicap</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libunicap-unicap.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">enum <a class="link" href="libunicap-unicap.html#unicap-buffer-type-t" title="enum unicap_buffer_type_t">unicap_buffer_type_t</a>;
<a class="link" href="libunicap-unicap.html#unicap-device-t" title="unicap_device_t">unicap_device_t</a>;
<a class="link" href="libunicap-unicap.html#unicap-rect-t" title="unicap_rect_t">unicap_rect_t</a>;
<a class="link" href="libunicap-unicap.html#unicap-format-t" title="unicap_format_t">unicap_format_t</a>;
<a class="link" href="libunicap-unicap.html#unicap-data-buffer-t" title="unicap_data_buffer_t">unicap_data_buffer_t</a>;
enum <a class="link" href="libunicap-unicap.html#unicap-property-flags-t" title="enum unicap_property_flags_t">unicap_property_flags_t</a>;
<a class="link" href="libunicap-unicap.html#unicap-property-range-t" title="unicap_property_range_t">unicap_property_range_t</a>;
<a class="link" href="libunicap-unicap.html#unicap-property-value-list-t" title="unicap_property_value_list_t">unicap_property_value_list_t</a>;
<a class="link" href="libunicap-unicap.html#unicap-property-menu-t" title="unicap_property_menu_t">unicap_property_menu_t</a>;
enum <a class="link" href="libunicap-unicap.html#unicap-property-type-enum-t" title="enum unicap_property_type_enum_t">unicap_property_type_enum_t</a>;
<a class="link" href="libunicap-unicap.html#unicap-property-t" title="unicap_property_t">unicap_property_t</a>;
enum <a class="link" href="libunicap-unicap.html#unicap-event-t" title="enum unicap_event_t">unicap_event_t</a>;
#define <a class="link" href="libunicap-unicap.html#UNICAP-FLAGS-MANUAL:CAPS" title="UNICAP_FLAGS_MANUAL">UNICAP_FLAGS_MANUAL</a>
#define <a class="link" href="libunicap-unicap.html#UNICAP-FLAGS-AUTO:CAPS" title="UNICAP_FLAGS_AUTO">UNICAP_FLAGS_AUTO</a>
#define <a class="link" href="libunicap-unicap.html#UNICAP-FLAGS-ONE-PUSH:CAPS" title="UNICAP_FLAGS_ONE_PUSH">UNICAP_FLAGS_ONE_PUSH</a>
#define <a class="link" href="libunicap-unicap.html#UNICAP-FLAGS-READ-OUT:CAPS" title="UNICAP_FLAGS_READ_OUT">UNICAP_FLAGS_READ_OUT</a>
#define <a class="link" href="libunicap-unicap.html#UNICAP-FLAGS-ON-OFF:CAPS" title="UNICAP_FLAGS_ON_OFF">UNICAP_FLAGS_ON_OFF</a>
#define <a class="link" href="libunicap-unicap.html#UNICAP-FLAGS-READ-ONLY:CAPS" title="UNICAP_FLAGS_READ_ONLY">UNICAP_FLAGS_READ_ONLY</a>
#define <a class="link" href="libunicap-unicap.html#UNICAP-FLAGS-FORMAT-CHANGE:CAPS" title="UNICAP_FLAGS_FORMAT_CHANGE">UNICAP_FLAGS_FORMAT_CHANGE</a>
<span class="returnvalue">void</span> (<a class="link" href="libunicap-unicap.html#unicap-callback-t" title="unicap_callback_t ()">*unicap_callback_t</a>) (<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-event-t" title="enum unicap_event_t"><span class="type">unicap_event_t</span></a> event</code></em>,
<em class="parameter"><code>...</code></em>);
<span class="returnvalue">void</span> (<a class="link" href="libunicap-unicap.html#unicap-new-frame-callback-t" title="unicap_new_frame_callback_t ()">*unicap_new_frame_callback_t</a>) (<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-event-t" title="enum unicap_event_t"><span class="type">unicap_event_t</span></a> event</code></em>,
<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-data-buffer-t" title="unicap_data_buffer_t"><span class="type">unicap_data_buffer_t</span></a> *buffer</code></em>,
<em class="parameter"><code><span class="type">void</span> *user_ptr</code></em>);
<span class="returnvalue">void</span> (<a class="link" href="libunicap-unicap.html#unicap-drop-frame-callback-t" title="unicap_drop_frame_callback_t ()">*unicap_drop_frame_callback_t</a>) (<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-event-t" title="enum unicap_event_t"><span class="type">unicap_event_t</span></a> event</code></em>,
<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><span class="type">void</span> *user_ptr</code></em>);
<span class="returnvalue">void</span> (<a class="link" href="libunicap-unicap.html#unicap-new-device-callback-t" title="unicap_new_device_callback_t ()">*unicap_new_device_callback_t</a>) (<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-event-t" title="enum unicap_event_t"><span class="type">unicap_event_t</span></a> event</code></em>,
<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-device-t" title="unicap_device_t"><span class="type">unicap_device_t</span></a> *device</code></em>,
<em class="parameter"><code><span class="type">void</span> *user_ptr</code></em>);
<span class="returnvalue">unicap_status_t</span> <a class="link" href="libunicap-unicap.html#unicap-check-version" title="unicap_check_version ()">unicap_check_version</a> (<em class="parameter"><code>unsigned <span class="type">int</span> major</code></em>,
<em class="parameter"><code>unsigned <span class="type">int</span> minor</code></em>,
<em class="parameter"><code>unsigned <span class="type">int</span> micro</code></em>);
<span class="returnvalue">unicap_status_t</span> <a class="link" href="libunicap-unicap.html#unicap-reenumerate-devices" title="unicap_reenumerate_devices ()">unicap_reenumerate_devices</a> (<em class="parameter"><code><span class="type">int</span> *count</code></em>);
<span class="returnvalue">unicap_status_t</span> <a class="link" href="libunicap-unicap.html#unicap-enumerate-devices" title="unicap_enumerate_devices ()">unicap_enumerate_devices</a> (<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-device-t" title="unicap_device_t"><span class="type">unicap_device_t</span></a> *specifier</code></em>,
<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-device-t" title="unicap_device_t"><span class="type">unicap_device_t</span></a> *device</code></em>,
<em class="parameter"><code><span class="type">int</span> index</code></em>);
<span class="returnvalue">unicap_status_t</span> <a class="link" href="libunicap-unicap.html#unicap-open" title="unicap_open ()">unicap_open</a> (<em class="parameter"><code><span class="type">unicap_handle_t</span> *handle</code></em>,
<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-device-t" title="unicap_device_t"><span class="type">unicap_device_t</span></a> *device</code></em>);
<span class="returnvalue">unicap_status_t</span> <a class="link" href="libunicap-unicap.html#unicap-register-callback" title="unicap_register_callback ()">unicap_register_callback</a> (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-event-t" title="enum unicap_event_t"><span class="type">unicap_event_t</span></a> event</code></em>,
<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-callback-t" title="unicap_callback_t ()"><span class="type">unicap_callback_t</span></a> callback</code></em>,
<em class="parameter"><code><span class="type">void</span> *user_ptr</code></em>);
<span class="returnvalue">unicap_status_t</span> <a class="link" href="libunicap-unicap.html#unicap-close" title="unicap_close ()">unicap_close</a> (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>);
<span class="returnvalue">unicap_status_t</span> <a class="link" href="libunicap-unicap.html#unicap-get-device" title="unicap_get_device ()">unicap_get_device</a> (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-device-t" title="unicap_device_t"><span class="type">unicap_device_t</span></a> *device</code></em>);
<span class="returnvalue">unicap_handle_t</span> <a class="link" href="libunicap-unicap.html#unicap-clone-handle" title="unicap_clone_handle ()">unicap_clone_handle</a> (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>);
<span class="returnvalue">unicap_status_t</span> <a class="link" href="libunicap-unicap.html#unicap-reenumerate-formats" title="unicap_reenumerate_formats ()">unicap_reenumerate_formats</a> (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><span class="type">int</span> *count</code></em>);
<span class="returnvalue">unicap_status_t</span> <a class="link" href="libunicap-unicap.html#unicap-enumerate-formats" title="unicap_enumerate_formats ()">unicap_enumerate_formats</a> (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-format-t" title="unicap_format_t"><span class="type">unicap_format_t</span></a> *specifier</code></em>,
<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-format-t" title="unicap_format_t"><span class="type">unicap_format_t</span></a> *format</code></em>,
<em class="parameter"><code><span class="type">int</span> index</code></em>);
<span class="returnvalue">unicap_status_t</span> <a class="link" href="libunicap-unicap.html#unicap-set-format" title="unicap_set_format ()">unicap_set_format</a> (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-format-t" title="unicap_format_t"><span class="type">unicap_format_t</span></a> *format</code></em>);
<span class="returnvalue">unicap_status_t</span> <a class="link" href="libunicap-unicap.html#unicap-get-format" title="unicap_get_format ()">unicap_get_format</a> (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-format-t" title="unicap_format_t"><span class="type">unicap_format_t</span></a> *format</code></em>);
<span class="returnvalue">unicap_status_t</span> <a class="link" href="libunicap-unicap.html#unicap-reenumerate-properties" title="unicap_reenumerate_properties ()">unicap_reenumerate_properties</a> (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><span class="type">int</span> *count</code></em>);
<span class="returnvalue">unicap_status_t</span> <a class="link" href="libunicap-unicap.html#unicap-enumerate-properties" title="unicap_enumerate_properties ()">unicap_enumerate_properties</a> (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-property-t" title="unicap_property_t"><span class="type">unicap_property_t</span></a> *specifier</code></em>,
<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-property-t" title="unicap_property_t"><span class="type">unicap_property_t</span></a> *property</code></em>,
<em class="parameter"><code><span class="type">int</span> index</code></em>);
<span class="returnvalue">unicap_status_t</span> <a class="link" href="libunicap-unicap.html#unicap-set-property" title="unicap_set_property ()">unicap_set_property</a> (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-property-t" title="unicap_property_t"><span class="type">unicap_property_t</span></a> *property</code></em>);
<span class="returnvalue">unicap_status_t</span> <a class="link" href="libunicap-unicap.html#unicap-set-property-value" title="unicap_set_property_value ()">unicap_set_property_value</a> (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><span class="type">char</span> *identifier</code></em>,
<em class="parameter"><code><span class="type">double</span> value</code></em>);
<span class="returnvalue">unicap_status_t</span> <a class="link" href="libunicap-unicap.html#unicap-set-property-manual" title="unicap_set_property_manual ()">unicap_set_property_manual</a> (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><span class="type">char</span> *identifier</code></em>);
<span class="returnvalue">unicap_status_t</span> <a class="link" href="libunicap-unicap.html#unicap-set-property-auto" title="unicap_set_property_auto ()">unicap_set_property_auto</a> (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><span class="type">char</span> *identifier</code></em>);
<span class="returnvalue">unicap_status_t</span> <a class="link" href="libunicap-unicap.html#unicap-set-property-one-push" title="unicap_set_property_one_push ()">unicap_set_property_one_push</a> (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><span class="type">char</span> *identifier</code></em>);
<span class="returnvalue">unicap_status_t</span> <a class="link" href="libunicap-unicap.html#unicap-get-property" title="unicap_get_property ()">unicap_get_property</a> (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-property-t" title="unicap_property_t"><span class="type">unicap_property_t</span></a> *property</code></em>);
<span class="returnvalue">unicap_status_t</span> <a class="link" href="libunicap-unicap.html#unicap-get-property-value" title="unicap_get_property_value ()">unicap_get_property_value</a> (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *identifier</code></em>,
<em class="parameter"><code><span class="type">double</span> *value</code></em>);
<span class="returnvalue">unicap_status_t</span> <a class="link" href="libunicap-unicap.html#unicap-get-property-menu" title="unicap_get_property_menu ()">unicap_get_property_menu</a> (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *identifier</code></em>,
<em class="parameter"><code><span class="type">char</span> **value</code></em>);
<span class="returnvalue">unicap_status_t</span> <a class="link" href="libunicap-unicap.html#unicap-get-property-auto" title="unicap_get_property_auto ()">unicap_get_property_auto</a> (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *identifier</code></em>,
<em class="parameter"><code><span class="type">int</span> *enabled</code></em>);
<span class="returnvalue">unicap_status_t</span> <a class="link" href="libunicap-unicap.html#unicap-start-capture" title="unicap_start_capture ()">unicap_start_capture</a> (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>);
<span class="returnvalue">unicap_status_t</span> <a class="link" href="libunicap-unicap.html#unicap-stop-capture" title="unicap_stop_capture ()">unicap_stop_capture</a> (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>);
<span class="returnvalue">unicap_status_t</span> <a class="link" href="libunicap-unicap.html#unicap-queue-buffer" title="unicap_queue_buffer ()">unicap_queue_buffer</a> (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-data-buffer-t" title="unicap_data_buffer_t"><span class="type">unicap_data_buffer_t</span></a> *data_buffer</code></em>);
<span class="returnvalue">unicap_status_t</span> <a class="link" href="libunicap-unicap.html#unicap-dequeue-buffer" title="unicap_dequeue_buffer ()">unicap_dequeue_buffer</a> (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-data-buffer-t" title="unicap_data_buffer_t"><span class="type">unicap_data_buffer_t</span></a> **data_buffer</code></em>);
<span class="returnvalue">unicap_status_t</span> <a class="link" href="libunicap-unicap.html#unicap-wait-buffer" title="unicap_wait_buffer ()">unicap_wait_buffer</a> (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-data-buffer-t" title="unicap_data_buffer_t"><span class="type">unicap_data_buffer_t</span></a> **data_buffer</code></em>);
<span class="returnvalue">unicap_status_t</span> <a class="link" href="libunicap-unicap.html#unicap-poll-buffer" title="unicap_poll_buffer ()">unicap_poll_buffer</a> (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><span class="type">int</span> *count</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libunicap-unicap.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="libunicap-unicap.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="unicap-buffer-type-t"></a><h3>enum unicap_buffer_type_t</h3>
<pre class="programlisting">typedef enum {
UNICAP_BUFFER_TYPE_USER = 0,
UNICAP_BUFFER_TYPE_SYSTEM,
} unicap_buffer_type_t;
</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="UNICAP-BUFFER-TYPE-USER:CAPS"></a><span class="term"><code class="literal">UNICAP_BUFFER_TYPE_USER</code></span></p></td>
<td>buffer is provided by the application
</td>
</tr>
<tr>
<td><p><a name="UNICAP-BUFFER-TYPE-SYSTEM:CAPS"></a><span class="term"><code class="literal">UNICAP_BUFFER_TYPE_SYSTEM</code></span></p></td>
<td>buffer is provided by the driver or library
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unicap-device-t"></a><h3>unicap_device_t</h3>
<pre class="programlisting">typedef struct {
char identifier[128];
char model_name[128];
char vendor_name[128];
unsigned long long model_id;
unsigned int vendor_id;
char cpi_layer[1024];
char device[1024];
unsigned int flags;
} unicap_device_t;
</pre>
<p>
A struct defining a device
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><span class="type">char</span> <em class="structfield"><code><a name="unicap-device-t.identifier"></a>identifier</code></em>[128];</span></p></td>
<td>unique textual ID of a device</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">char</span> <em class="structfield"><code><a name="unicap-device-t.model-name"></a>model_name</code></em>[128];</span></p></td>
<td>model name of the device</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">char</span> <em class="structfield"><code><a name="unicap-device-t.vendor-name"></a>vendor_name</code></em>[128];</span></p></td>
<td>name of the device vendor</td>
</tr>
<tr>
<td><p><span class="term">unsigned <span class="type">int</span> <em class="structfield"><code><a name="unicap-device-t.vendor-id"></a>vendor_id</code></em>;</span></p></td>
<td>numerical ID of the vendor ( eg. USB Vendor ID )</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">char</span> <em class="structfield"><code><a name="unicap-device-t.cpi-layer"></a>cpi_layer</code></em>[1024];</span></p></td>
<td>name of the plugin used to communicate with the device</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">char</span> <em class="structfield"><code><a name="unicap-device-t.device"></a>device</code></em>[1024];</span></p></td>
<td>name of the device file, if any</td>
</tr>
<tr>
<td><p><span class="term">unsigned <span class="type">int</span> <em class="structfield"><code><a name="unicap-device-t.flags"></a>flags</code></em>;</span></p></td>
<td>flags</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unicap-rect-t"></a><h3>unicap_rect_t</h3>
<pre class="programlisting">typedef struct {
int x;
int y;
int width;
int height;
} unicap_rect_t;
</pre>
<p>
A struct defining a rectangle
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="unicap-rect-t.x"></a>x</code></em>;</span></p></td>
<td>horizontal position</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="unicap-rect-t.y"></a>y</code></em>;</span></p></td>
<td>vertical position</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="unicap-rect-t.width"></a>width</code></em>;</span></p></td>
<td>width of the rectangle</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="unicap-rect-t.height"></a>height</code></em>;</span></p></td>
<td>height of the rectangle</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unicap-format-t"></a><h3>unicap_format_t</h3>
<pre class="programlisting">typedef struct {
char identifier[128];
unicap_rect_t size;
unicap_rect_t min_size;
unicap_rect_t max_size;
int h_stepping;
int v_stepping;
unicap_rect_t *sizes;
int size_count;
int bpp;
unsigned int fourcc;
unicap_format_flags_t flags;
unsigned int buffer_types;
int system_buffer_count;
size_t buffer_size;
unicap_buffer_type_t buffer_type;
} unicap_format_t;
</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><span class="type">char</span> <em class="structfield"><code><a name="unicap-format-t.identifier"></a>identifier</code></em>[128];</span></p></td>
<td>unique textual identifier of this format</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="libunicap-unicap.html#unicap-rect-t" title="unicap_rect_t"><span class="type">unicap_rect_t</span></a> <em class="structfield"><code><a name="unicap-format-t.size"></a>size</code></em>;</span></p></td>
<td>size of the format</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="libunicap-unicap.html#unicap-rect-t" title="unicap_rect_t"><span class="type">unicap_rect_t</span></a> <em class="structfield"><code><a name="unicap-format-t.min-size"></a>min_size</code></em>;</span></p></td>
<td>minimum size</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="libunicap-unicap.html#unicap-rect-t" title="unicap_rect_t"><span class="type">unicap_rect_t</span></a> <em class="structfield"><code><a name="unicap-format-t.max-size"></a>max_size</code></em>;</span></p></td>
<td>maximum size</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="unicap-format-t.h-stepping"></a>h_stepping</code></em>;</span></p></td>
<td>horizontal stepping</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="unicap-format-t.v-stepping"></a>v_stepping</code></em>;</span></p></td>
<td>vertical stepping</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="libunicap-unicap.html#unicap-rect-t" title="unicap_rect_t"><span class="type">unicap_rect_t</span></a> *<em class="structfield"><code><a name="unicap-format-t.sizes"></a>sizes</code></em>;</span></p></td>
<td>array of allowed sizes. Might be NULL</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="unicap-format-t.size-count"></a>size_count</code></em>;</span></p></td>
<td>number of element in the sizes array</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="unicap-format-t.bpp"></a>bpp</code></em>;</span></p></td>
<td>bits per pixel</td>
</tr>
<tr>
<td><p><span class="term">unsigned <span class="type">int</span> <em class="structfield"><code><a name="unicap-format-t.fourcc"></a>fourcc</code></em>;</span></p></td>
<td>FOURCC describing the colour format</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">unicap_format_flags_t</span> <em class="structfield"><code><a name="unicap-format-t.flags"></a>flags</code></em>;</span></p></td>
<td></td>
</tr>
<tr>
<td><p><span class="term">unsigned <span class="type">int</span> <em class="structfield"><code><a name="unicap-format-t.buffer-types"></a>buffer_types</code></em>;</span></p></td>
<td></td>
</tr>
<tr>
<td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="unicap-format-t.system-buffer-count"></a>system_buffer_count</code></em>;</span></p></td>
<td></td>
</tr>
<tr>
<td><p><span class="term"><span class="type">size_t</span> <em class="structfield"><code><a name="unicap-format-t.buffer-size"></a>buffer_size</code></em>;</span></p></td>
<td>amount of memory required by one data buffer of this
format</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="libunicap-unicap.html#unicap-buffer-type-t" title="enum unicap_buffer_type_t"><span class="type">unicap_buffer_type_t</span></a> <em class="structfield"><code><a name="unicap-format-t.buffer-type"></a>buffer_type</code></em>;</span></p></td>
<td></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unicap-data-buffer-t"></a><h3>unicap_data_buffer_t</h3>
<pre class="programlisting">typedef struct {
unicap_format_t format;
int frame_number;
struct timeval fill_time;
struct timeval duration;
struct timeval capture_start_time;
unsigned char *data;
size_t buffer_size;
unicap_buffer_type_t type;
unicap_buffer_flags_t flags;
unicap_data_buffer_private_t *private;
} unicap_data_buffer_t;
</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><a class="link" href="libunicap-unicap.html#unicap-format-t" title="unicap_format_t"><span class="type">unicap_format_t</span></a> <em class="structfield"><code><a name="unicap-data-buffer-t.format"></a>format</code></em>;</span></p></td>
<td>a <a class="link" href="libunicap-unicap.html#unicap-format-t" title="unicap_format_t"><span class="type">unicap_format_t</span></a> describing the layout of the data
buffer</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="unicap-data-buffer-t.frame-number"></a>frame_number</code></em>;</span></p></td>
<td></td>
</tr>
<tr>
<td><p><span class="term">struct <span class="type">timeval</span> <em class="structfield"><code><a name="unicap-data-buffer-t.fill-time"></a>fill_time</code></em>;</span></p></td>
<td>the time when capturing completed on this buffer</td>
</tr>
<tr>
<td><p><span class="term">struct <span class="type">timeval</span> <em class="structfield"><code><a name="unicap-data-buffer-t.duration"></a>duration</code></em>;</span></p></td>
<td>frame duration of this buffer ( might not be present on
all devices )</td>
</tr>
<tr>
<td><p><span class="term">struct <span class="type">timeval</span> <em class="structfield"><code><a name="unicap-data-buffer-t.capture-start-time"></a>capture_start_time</code></em>;</span></p></td>
<td>the time when the capturing started on this
buffer ( might not be supported on all devices )</td>
</tr>
<tr>
<td><p><span class="term">unsigned <span class="type">char</span> *<em class="structfield"><code><a name="unicap-data-buffer-t.data"></a>data</code></em>;</span></p></td>
<td>the image data</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">size_t</span> <em class="structfield"><code><a name="unicap-data-buffer-t.buffer-size"></a>buffer_size</code></em>;</span></p></td>
<td>size of the memory buffer pointed to by data</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="libunicap-unicap.html#unicap-buffer-type-t" title="enum unicap_buffer_type_t"><span class="type">unicap_buffer_type_t</span></a> <em class="structfield"><code><a name="unicap-data-buffer-t.type"></a>type</code></em>;</span></p></td>
<td></td>
</tr>
<tr>
<td><p><span class="term"><span class="type">unicap_buffer_flags_t</span> <em class="structfield"><code><a name="unicap-data-buffer-t.flags"></a>flags</code></em>;</span></p></td>
<td></td>
</tr>
<tr>
<td><p><span class="term"><span class="type">unicap_data_buffer_private_t</span> *<em class="structfield"><code><a name="unicap-data-buffer-t.private"></a>private</code></em>;</span></p></td>
<td></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unicap-property-flags-t"></a><h3>enum unicap_property_flags_t</h3>
<pre class="programlisting">typedef enum {
UNICAP_FLAGS_MANUAL = 1ULL,
UNICAP_FLAGS_AUTO = (1ULL<<1ULL),
UNICAP_FLAGS_ONE_PUSH = (1ULL<<2ULL),
UNICAP_FLAGS_READ_OUT = (1ULL<<3ULL),
UNICAP_FLAGS_ON_OFF = (1ULL<<4ULL),
UNICAP_FLAGS_READ_ONLY = (1ULL<<5ULL),
UNICAP_FLAGS_FORMAT_CHANGE = (1ULL<<6ULL),
UNICAP_FLAGS_WRITE_ONLY = (1ULL<<7ULL),
UNICAP_FLAGS_CHECK_STEPPING = (1ULL<<32ULL),
UNICAP_FLAGS_DUMMY_VALUE = (0xffffffffffffffffULL)
} unicap_property_flags_t;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="unicap-property-range-t"></a><h3>unicap_property_range_t</h3>
<pre class="programlisting">typedef struct {
double min;
double max;
} unicap_property_range_t;
</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><span class="type">double</span> <em class="structfield"><code><a name="unicap-property-range-t.min"></a>min</code></em>;</span></p></td>
<td>minimum value</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">double</span> <em class="structfield"><code><a name="unicap-property-range-t.max"></a>max</code></em>;</span></p></td>
<td>maximum value</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unicap-property-value-list-t"></a><h3>unicap_property_value_list_t</h3>
<pre class="programlisting">typedef struct {
double *values;
int value_count;
} unicap_property_value_list_t;
</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><span class="type">double</span> *<em class="structfield"><code><a name="unicap-property-value-list-t.values"></a>values</code></em>;</span></p></td>
<td>array of values</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="unicap-property-value-list-t.value-count"></a>value_count</code></em>;</span></p></td>
<td>number of elements in values array</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unicap-property-menu-t"></a><h3>unicap_property_menu_t</h3>
<pre class="programlisting">typedef struct {
char **menu_items;
int menu_item_count;
} unicap_property_menu_t;
</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><span class="type">char</span> **<em class="structfield"><code><a name="unicap-property-menu-t.menu-items"></a>menu_items</code></em>;</span></p></td>
<td>an array of menu items</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="unicap-property-menu-t.menu-item-count"></a>menu_item_count</code></em>;</span></p></td>
<td>number of elements in the menu_items array</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unicap-property-type-enum-t"></a><h3>enum unicap_property_type_enum_t</h3>
<pre class="programlisting">typedef enum {
UNICAP_PROPERTY_TYPE_RANGE = 0,
UNICAP_PROPERTY_TYPE_VALUE_LIST,
UNICAP_PROPERTY_TYPE_MENU,
UNICAP_PROPERTY_TYPE_DATA,
UNICAP_PROPERTY_TYPE_FLAGS,
UNICAP_PROPERTY_TYPE_UNKNOWN
} unicap_property_type_enum_t;
</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="UNICAP-PROPERTY-TYPE-RANGE:CAPS"></a><span class="term"><code class="literal">UNICAP_PROPERTY_TYPE_RANGE</code></span></p></td>
<td>a property with a value in a given
range
</td>
</tr>
<tr>
<td><p><a name="UNICAP-PROPERTY-TYPE-VALUE-LIST:CAPS"></a><span class="term"><code class="literal">UNICAP_PROPERTY_TYPE_VALUE_LIST</code></span></p></td>
<td>a property with a value out of a
list of values
</td>
</tr>
<tr>
<td><p><a name="UNICAP-PROPERTY-TYPE-MENU:CAPS"></a><span class="term"><code class="literal">UNICAP_PROPERTY_TYPE_MENU</code></span></p></td>
<td></td>
</tr>
<tr>
<td><p><a name="UNICAP-PROPERTY-TYPE-DATA:CAPS"></a><span class="term"><code class="literal">UNICAP_PROPERTY_TYPE_DATA</code></span></p></td>
<td></td>
</tr>
<tr>
<td><p><a name="UNICAP-PROPERTY-TYPE-FLAGS:CAPS"></a><span class="term"><code class="literal">UNICAP_PROPERTY_TYPE_FLAGS</code></span></p></td>
<td>a property where only the flags are valid
</td>
</tr>
<tr>
<td><p><a name="UNICAP-PROPERTY-TYPE-UNKNOWN:CAPS"></a><span class="term"><code class="literal">UNICAP_PROPERTY_TYPE_UNKNOWN</code></span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unicap-property-t"></a><h3>unicap_property_t</h3>
<pre class="programlisting">typedef struct {
char identifier[128];
char category[128];
char unit[128];
char **relations;
int relations_count;
union
double value;
char menu_item[128];
union
unicap_property_range_t range;
unicap_property_value_list_t value_list;
unicap_property_menu_t menu;
double stepping;
unicap_property_type_enum_t type;
unicap_property_flags_t flags;
unicap_property_flags_t flags_mask;
void *property_data;
size_t property_data_size;
} unicap_property_t;
</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><span class="type">char</span> <em class="structfield"><code><a name="unicap-property-t.identifier"></a>identifier</code></em>[128];</span></p></td>
<td>unique textual identifier of this properties</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">char</span> <em class="structfield"><code><a name="unicap-property-t.category"></a>category</code></em>[128];</span></p></td>
<td>a category for this property, for example: 'Lens Control' for zoom and focus properties</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">char</span> <em class="structfield"><code><a name="unicap-property-t.unit"></a>unit</code></em>[128];</span></p></td>
<td>optional unit, for example: 's' for Exposure
denoting the Exposure time in seconds</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">char</span> **<em class="structfield"><code><a name="unicap-property-t.relations"></a>relations</code></em>;</span></p></td>
<td>properties that might their state or value when
changing this property</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="unicap-property-t.relations-count"></a>relations_count</code></em>;</span></p></td>
<td>size of the relations array</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">char</span> <em class="structfield"><code><a name="unicap-property-t.menu-item"></a>menu_item</code></em>[128];</span></p></td>
<td>for UNICAP_PROPERTY_TYPE_MENU properties: selected menu entry</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="libunicap-unicap.html#unicap-property-value-list-t" title="unicap_property_value_list_t"><span class="type">unicap_property_value_list_t</span></a> <em class="structfield"><code><a name="unicap-property-t.value-list"></a>value_list</code></em>;</span></p></td>
<td>for UNICAP_PROPERTY_TYPE_VALUE_LIST properties: list
of valid values</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="libunicap-unicap.html#unicap-property-menu-t" title="unicap_property_menu_t"><span class="type">unicap_property_menu_t</span></a> <em class="structfield"><code><a name="unicap-property-t.menu"></a>menu</code></em>;</span></p></td>
<td>for UNICAP_PROPERTY_TYPE_MENU properties: menu</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">double</span> <em class="structfield"><code><a name="unicap-property-t.stepping"></a>stepping</code></em>;</span></p></td>
<td>for UNICAP_PROPERTY_TYPE_RANGE properties: stepping</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="libunicap-unicap.html#unicap-property-type-enum-t" title="enum unicap_property_type_enum_t"><span class="type">unicap_property_type_enum_t</span></a> <em class="structfield"><code><a name="unicap-property-t.type"></a>type</code></em>;</span></p></td>
<td>the type of the property</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="libunicap-unicap.html#unicap-property-flags-t" title="enum unicap_property_flags_t"><span class="type">unicap_property_flags_t</span></a> <em class="structfield"><code><a name="unicap-property-t.flags"></a>flags</code></em>;</span></p></td>
<td>when enumerated, this field contains the default flags for the property; for get/set operations, this
field contains the actual flags</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="libunicap-unicap.html#unicap-property-flags-t" title="enum unicap_property_flags_t"><span class="type">unicap_property_flags_t</span></a> <em class="structfield"><code><a name="unicap-property-t.flags-mask"></a>flags_mask</code></em>;</span></p></td>
<td>when enumerated, this field contains the allowed flags for the property; for get/set operations, this field acts as a mask</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">void</span> *<em class="structfield"><code><a name="unicap-property-t.property-data"></a>property_data</code></em>;</span></p></td>
<td>a pointer to an opaque data structure</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">size_t</span> <em class="structfield"><code><a name="unicap-property-t.property-data-size"></a>property_data_size</code></em>;</span></p></td>
<td>size of the data structure pointed at by property_data</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unicap-event-t"></a><h3>enum unicap_event_t</h3>
<pre class="programlisting">typedef enum {
UNICAP_EVENT_FIRST = 0,
UNICAP_EVENT_DEVICE_REMOVED = 0,
UNICAP_EVENT_NEW_DEVICE,
UNICAP_EVENT_NEW_FRAME,
UNICAP_EVENT_DROP_FRAME,
UNICAP_EVENT_LAST
} unicap_event_t;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="UNICAP-FLAGS-MANUAL:CAPS"></a><h3>UNICAP_FLAGS_MANUAL</h3>
<pre class="programlisting">#define UNICAP_FLAGS_MANUAL (1ULL)
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="UNICAP-FLAGS-AUTO:CAPS"></a><h3>UNICAP_FLAGS_AUTO</h3>
<pre class="programlisting">#define UNICAP_FLAGS_AUTO (1ULL<<1ULL)
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="UNICAP-FLAGS-ONE-PUSH:CAPS"></a><h3>UNICAP_FLAGS_ONE_PUSH</h3>
<pre class="programlisting">#define UNICAP_FLAGS_ONE_PUSH (1ULL<<2ULL)
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="UNICAP-FLAGS-READ-OUT:CAPS"></a><h3>UNICAP_FLAGS_READ_OUT</h3>
<pre class="programlisting">#define UNICAP_FLAGS_READ_OUT (1ULL<<3ULL)
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="UNICAP-FLAGS-ON-OFF:CAPS"></a><h3>UNICAP_FLAGS_ON_OFF</h3>
<pre class="programlisting">#define UNICAP_FLAGS_ON_OFF (1ULL<<4ULL)
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="UNICAP-FLAGS-READ-ONLY:CAPS"></a><h3>UNICAP_FLAGS_READ_ONLY</h3>
<pre class="programlisting">#define UNICAP_FLAGS_READ_ONLY (1ULL<<5ULL)
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="UNICAP-FLAGS-FORMAT-CHANGE:CAPS"></a><h3>UNICAP_FLAGS_FORMAT_CHANGE</h3>
<pre class="programlisting">#define UNICAP_FLAGS_FORMAT_CHANGE (1ULL<<6ULL)
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="unicap-callback-t"></a><h3>unicap_callback_t ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*unicap_callback_t) (<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-event-t" title="enum unicap_event_t"><span class="type">unicap_event_t</span></a> event</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="unicap-new-frame-callback-t"></a><h3>unicap_new_frame_callback_t ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*unicap_new_frame_callback_t) (<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-event-t" title="enum unicap_event_t"><span class="type">unicap_event_t</span></a> event</code></em>,
<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-data-buffer-t" title="unicap_data_buffer_t"><span class="type">unicap_data_buffer_t</span></a> *buffer</code></em>,
<em class="parameter"><code><span class="type">void</span> *user_ptr</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="unicap-drop-frame-callback-t"></a><h3>unicap_drop_frame_callback_t ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*unicap_drop_frame_callback_t) (<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-event-t" title="enum unicap_event_t"><span class="type">unicap_event_t</span></a> event</code></em>,
<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><span class="type">void</span> *user_ptr</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="unicap-new-device-callback-t"></a><h3>unicap_new_device_callback_t ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*unicap_new_device_callback_t) (<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-event-t" title="enum unicap_event_t"><span class="type">unicap_event_t</span></a> event</code></em>,
<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-device-t" title="unicap_device_t"><span class="type">unicap_device_t</span></a> *device</code></em>,
<em class="parameter"><code><span class="type">void</span> *user_ptr</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="unicap-check-version"></a><h3>unicap_check_version ()</h3>
<pre class="programlisting"><span class="returnvalue">unicap_status_t</span> unicap_check_version (<em class="parameter"><code>unsigned <span class="type">int</span> major</code></em>,
<em class="parameter"><code>unsigned <span class="type">int</span> minor</code></em>,
<em class="parameter"><code>unsigned <span class="type">int</span> micro</code></em>);</pre>
<p>
Checks that the unicap library version is compatible with given
version
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>major</code></em> :</span></p></td>
<td>major version to check against</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>minor</code></em> :</span></p></td>
<td>minor version to check against</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>micro</code></em> :</span></p></td>
<td>micro version to check against</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if compatible</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unicap-reenumerate-devices"></a><h3>unicap_reenumerate_devices ()</h3>
<pre class="programlisting"><span class="returnvalue">unicap_status_t</span> unicap_reenumerate_devices (<em class="parameter"><code><span class="type">int</span> *count</code></em>);</pre>
<p>
Rebuild internal list of devices.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>count</code></em> :</span></p></td>
<td>if not NULL, receives number of devices found</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>status</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unicap-enumerate-devices"></a><h3>unicap_enumerate_devices ()</h3>
<pre class="programlisting"><span class="returnvalue">unicap_status_t</span> unicap_enumerate_devices (<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-device-t" title="unicap_device_t"><span class="type">unicap_device_t</span></a> *specifier</code></em>,
<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-device-t" title="unicap_device_t"><span class="type">unicap_device_t</span></a> *device</code></em>,
<em class="parameter"><code><span class="type">int</span> index</code></em>);</pre>
<p>
Enumerates currently connected video capture devices
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>specifier</code></em> :</span></p></td>
<td>specifies which devices should be returned, or NULL</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td>
<td>receives the device</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td>
<td>number of the device to be enumerated</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>status</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unicap-open"></a><h3>unicap_open ()</h3>
<pre class="programlisting"><span class="returnvalue">unicap_status_t</span> unicap_open (<em class="parameter"><code><span class="type">unicap_handle_t</span> *handle</code></em>,
<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-device-t" title="unicap_device_t"><span class="type">unicap_device_t</span></a> *device</code></em>);</pre>
<p>
Acquire a handle to a device.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td>receives the new handle</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td>
<td>device to open, as returned by <a class="link" href="libunicap-unicap.html#unicap-enumerate-devices" title="unicap_enumerate_devices ()"><span class="type">unicap_enumerate_devices</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>status</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unicap-register-callback"></a><h3>unicap_register_callback ()</h3>
<pre class="programlisting"><span class="returnvalue">unicap_status_t</span> unicap_register_callback (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-event-t" title="enum unicap_event_t"><span class="type">unicap_event_t</span></a> event</code></em>,
<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-callback-t" title="unicap_callback_t ()"><span class="type">unicap_callback_t</span></a> callback</code></em>,
<em class="parameter"><code><span class="type">void</span> *user_ptr</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td>a handle</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
<td>event to register a callback for</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td>the callback function to call when the event occurs</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_ptr</code></em> :</span></p></td>
<td>user provided data that gets passed to the callback function</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unicap-close"></a><h3>unicap_close ()</h3>
<pre class="programlisting"><span class="returnvalue">unicap_status_t</span> unicap_close (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>);</pre>
<p>
Clsoing a handle decrements the reference count on the device. If
the reference count is 0, all resources associated with the device
get freed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td>a handle</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>status</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unicap-get-device"></a><h3>unicap_get_device ()</h3>
<pre class="programlisting"><span class="returnvalue">unicap_status_t</span> unicap_get_device (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-device-t" title="unicap_device_t"><span class="type">unicap_device_t</span></a> *device</code></em>);</pre>
<p>
Gets the device controled by handle
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td>a handle</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td>
<td>a pointer to the location where the device should be stored</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>status</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unicap-clone-handle"></a><h3>unicap_clone_handle ()</h3>
<pre class="programlisting"><span class="returnvalue">unicap_handle_t</span> unicap_clone_handle (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>);</pre>
<p>
Copies the handle, increment the reference count
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td>the handle to clone</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>new handle</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unicap-reenumerate-formats"></a><h3>unicap_reenumerate_formats ()</h3>
<pre class="programlisting"><span class="returnvalue">unicap_status_t</span> unicap_reenumerate_formats (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><span class="type">int</span> *count</code></em>);</pre>
<p>
Re-create the list of formats supported by the device. Invalidates all data returned by prior calls
to <code class="function">unicap_emumerate_formats()</code> and <a class="link" href="libunicap-unicap.html#unicap-get-format" title="unicap_get_format ()"><code class="function">unicap_get_format()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td>A handle</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>count</code></em> :</span></p></td>
<td>Receives the number of formats currently supported by the device. Might be NULL</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>status</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unicap-enumerate-formats"></a><h3>unicap_enumerate_formats ()</h3>
<pre class="programlisting"><span class="returnvalue">unicap_status_t</span> unicap_enumerate_formats (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-format-t" title="unicap_format_t"><span class="type">unicap_format_t</span></a> *specifier</code></em>,
<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-format-t" title="unicap_format_t"><span class="type">unicap_format_t</span></a> *format</code></em>,
<em class="parameter"><code><span class="type">int</span> index</code></em>);</pre>
<p>
Enumerate formats known to the device
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td>A handle</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>specifier</code></em> :</span></p></td>
<td>limits the enumerated formats to the ones matching the fields in specifier. Fields set to -1 in the specifier are ignored</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
<td>A pointer to allocated storage where the enumerated format shoudl be stored</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td>
<td>index of the format in the enumeration</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>STATUS_NO_MORE_FORMATS: end of the list of matching formats has been reached</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unicap-set-format"></a><h3>unicap_set_format ()</h3>
<pre class="programlisting"><span class="returnvalue">unicap_status_t</span> unicap_set_format (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-format-t" title="unicap_format_t"><span class="type">unicap_format_t</span></a> *format</code></em>);</pre>
<p>
Set a format.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td>a handle</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
<td>the format to set</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>STATUS_NO_MATCH: given format not valid for device</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unicap-get-format"></a><h3>unicap_get_format ()</h3>
<pre class="programlisting"><span class="returnvalue">unicap_status_t</span> unicap_get_format (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-format-t" title="unicap_format_t"><span class="type">unicap_format_t</span></a> *format</code></em>);</pre>
<p>
Get the current format
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td>a handle</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
<td>a pointer to the location where the returned format should be stored</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>status</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unicap-reenumerate-properties"></a><h3>unicap_reenumerate_properties ()</h3>
<pre class="programlisting"><span class="returnvalue">unicap_status_t</span> unicap_reenumerate_properties (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><span class="type">int</span> *count</code></em>);</pre>
<p>
Re-create the list of properties supported by the device. This invalidates all data returned by prior calls to
<a class="link" href="libunicap-unicap.html#unicap-enumerate-properties" title="unicap_enumerate_properties ()"><code class="function">unicap_enumerate_properties()</code></a> and <a class="link" href="libunicap-unicap.html#unicap-get-property" title="unicap_get_property ()"><code class="function">unicap_get_property()</code></a>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td>a handle</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>count</code></em> :</span></p></td>
<td>receives number of properties supported by the device. Might be NULL</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>status</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unicap-enumerate-properties"></a><h3>unicap_enumerate_properties ()</h3>
<pre class="programlisting"><span class="returnvalue">unicap_status_t</span> unicap_enumerate_properties (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-property-t" title="unicap_property_t"><span class="type">unicap_property_t</span></a> *specifier</code></em>,
<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-property-t" title="unicap_property_t"><span class="type">unicap_property_t</span></a> *property</code></em>,
<em class="parameter"><code><span class="type">int</span> index</code></em>);</pre>
<p>
Enumerate properties matching "specifier"
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td>a handle</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>specifier</code></em> :</span></p></td>
<td>specifier</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td>
<td>a pointer to the location where the enumerated property should be stored</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td>
<td>index of the property</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>status</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unicap-set-property"></a><h3>unicap_set_property ()</h3>
<pre class="programlisting"><span class="returnvalue">unicap_status_t</span> unicap_set_property (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-property-t" title="unicap_property_t"><span class="type">unicap_property_t</span></a> *property</code></em>);</pre>
<p>
Set a device property
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td>a handle</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td>
<td>the property to set</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>status</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unicap-set-property-value"></a><h3>unicap_set_property_value ()</h3>
<pre class="programlisting"><span class="returnvalue">unicap_status_t</span> unicap_set_property_value (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><span class="type">char</span> *identifier</code></em>,
<em class="parameter"><code><span class="type">double</span> value</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="unicap-set-property-manual"></a><h3>unicap_set_property_manual ()</h3>
<pre class="programlisting"><span class="returnvalue">unicap_status_t</span> unicap_set_property_manual (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><span class="type">char</span> *identifier</code></em>);</pre>
<p>
Sets a property to manual mode, disabling the automatic mode
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td>A handle</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>identifier</code></em> :</span></p></td>
<td>identifier of the property to set</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>status</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unicap-set-property-auto"></a><h3>unicap_set_property_auto ()</h3>
<pre class="programlisting"><span class="returnvalue">unicap_status_t</span> unicap_set_property_auto (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><span class="type">char</span> *identifier</code></em>);</pre>
<p>
Sets the property to automatic mode
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td>A handle</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>identifier</code></em> :</span></p></td>
<td>identifier of the property to set</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>status</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unicap-set-property-one-push"></a><h3>unicap_set_property_one_push ()</h3>
<pre class="programlisting"><span class="returnvalue">unicap_status_t</span> unicap_set_property_one_push (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><span class="type">char</span> *identifier</code></em>);</pre>
<p>
Enable one push mode on a property
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td>a handle</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>identifier</code></em> :</span></p></td>
<td>identifier of the property to set</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>status</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unicap-get-property"></a><h3>unicap_get_property ()</h3>
<pre class="programlisting"><span class="returnvalue">unicap_status_t</span> unicap_get_property (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-property-t" title="unicap_property_t"><span class="type">unicap_property_t</span></a> *property</code></em>);</pre>
<p>
Get a device property
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td>a handle</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td>
<td>a pointer to the location where the returned property should be stored</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>status</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unicap-get-property-value"></a><h3>unicap_get_property_value ()</h3>
<pre class="programlisting"><span class="returnvalue">unicap_status_t</span> unicap_get_property_value (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *identifier</code></em>,
<em class="parameter"><code><span class="type">double</span> *value</code></em>);</pre>
<p>
Returns the value of a property
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td>a handle</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>identifier</code></em> :</span></p></td>
<td>identifier of the property to query</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>a pointer to the location where the value should be stored</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>status</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unicap-get-property-menu"></a><h3>unicap_get_property_menu ()</h3>
<pre class="programlisting"><span class="returnvalue">unicap_status_t</span> unicap_get_property_menu (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *identifier</code></em>,
<em class="parameter"><code><span class="type">char</span> **value</code></em>);</pre>
<p>
Returns the menu string of a property. Property must be of
UNICAP_PROPERTY_TYPE_MENU type. The returned string is owned by the
unicap library and might be overwritten by subsequent calls to unicap_get_property_menu.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td>A handle</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>identifier</code></em> :</span></p></td>
<td>identifier of the property to query</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>pointer to store the string location</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>status</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unicap-get-property-auto"></a><h3>unicap_get_property_auto ()</h3>
<pre class="programlisting"><span class="returnvalue">unicap_status_t</span> unicap_get_property_auto (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *identifier</code></em>,
<em class="parameter"><code><span class="type">int</span> *enabled</code></em>);</pre>
<p>
Retrieve the current property auto mode
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td>a handle</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>identifier</code></em> :</span></p></td>
<td>identifier of the property to query</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>enabled</code></em> :</span></p></td>
<td>location to store the enabled flag</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>status</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unicap-start-capture"></a><h3>unicap_start_capture ()</h3>
<pre class="programlisting"><span class="returnvalue">unicap_status_t</span> unicap_start_capture (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>);</pre>
<p>
Start the capture device. After this call, unicap_wait_buffer calls are allowed
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td>a handle</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>status</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unicap-stop-capture"></a><h3>unicap_stop_capture ()</h3>
<pre class="programlisting"><span class="returnvalue">unicap_status_t</span> unicap_stop_capture (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>);</pre>
<p>
Stop the capture device
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td>A handle</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>status</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unicap-queue-buffer"></a><h3>unicap_queue_buffer ()</h3>
<pre class="programlisting"><span class="returnvalue">unicap_status_t</span> unicap_queue_buffer (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-data-buffer-t" title="unicap_data_buffer_t"><span class="type">unicap_data_buffer_t</span></a> *data_buffer</code></em>);</pre>
<p>
Queue a buffer to be filled by the capture device. The queued
buffer must not be touched ( especially not be freed ) until it is
in the ready queue or dequeued. Supplied buffer must be at least of
the buffer size returned by get_format
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td>A handle</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_buffer</code></em> :</span></p></td>
<td>A pointer to the buffer to queue</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>status</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unicap-dequeue-buffer"></a><h3>unicap_dequeue_buffer ()</h3>
<pre class="programlisting"><span class="returnvalue">unicap_status_t</span> unicap_dequeue_buffer (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-data-buffer-t" title="unicap_data_buffer_t"><span class="type">unicap_data_buffer_t</span></a> **data_buffer</code></em>);</pre>
<p>
Removes the first buffer from the queue. Depending on the
device:Can only be called if the capture device is stopped.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td>A handle</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_buffer</code></em> :</span></p></td>
<td>receives the dequeued buffer or NULL if no buffer was queued</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>status</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unicap-wait-buffer"></a><h3>unicap_wait_buffer ()</h3>
<pre class="programlisting"><span class="returnvalue">unicap_status_t</span> unicap_wait_buffer (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><a class="link" href="libunicap-unicap.html#unicap-data-buffer-t" title="unicap_data_buffer_t"><span class="type">unicap_data_buffer_t</span></a> **data_buffer</code></em>);</pre>
<p>
Removes a buffer from the ready queue. If no buffer is available, this function blocks until a buffer got filled.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td>A handle</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_buffer</code></em> :</span></p></td>
<td>A pointer to the location where the returned buffer should be stored</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>status</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unicap-poll-buffer"></a><h3>unicap_poll_buffer ()</h3>
<pre class="programlisting"><span class="returnvalue">unicap_status_t</span> unicap_poll_buffer (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><span class="type">int</span> *count</code></em>);</pre>
<p>
Poll for buffers in the fill queue
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td>A handle</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>count</code></em> :</span></p></td>
<td>A pointer to the location where return value should be stored</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>status</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|