/usr/share/doc/libzvbi-doc/html/group__Proxy.html is in libzvbi-doc 0.2.35-13.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ZVBI Library: VBI capture proxy interface</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ZVBI Library
 <span id="projectnumber">0.2.35</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">VBI capture proxy interface<div class="ingroups"><a class="el" href="group__Raw.html">Raw VBI</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Receiving sliced or raw data from VBI proxy daemon.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__channel__profile.html">vbi_channel_profile</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Proxy scheduler parameters for background channel switching. <a href="structvbi__channel__profile.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga4005728b4ad4d31d9fefeb5276ceaaec"><td class="memItemLeft" align="right" valign="top"><a id="ga4005728b4ad4d31d9fefeb5276ceaaec"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Proxy.html#ga4005728b4ad4d31d9fefeb5276ceaaec">VBIPROXY_VERSION</a>   0x00000100</td></tr>
<tr class="memdesc:ga4005728b4ad4d31d9fefeb5276ceaaec"><td class="mdescLeft"> </td><td class="mdescRight">Proxy protocol version: major, minor and patchlevel. <br /></td></tr>
<tr class="separator:ga4005728b4ad4d31d9fefeb5276ceaaec"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gaab2f04f908db9ebbf164b449627a14d5"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__Proxy.html#gaab2f04f908db9ebbf164b449627a14d5">vbi_proxy_client</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Proxy.html#gaab2f04f908db9ebbf164b449627a14d5">vbi_proxy_client</a></td></tr>
<tr class="memdesc:gaab2f04f908db9ebbf164b449627a14d5"><td class="mdescLeft"> </td><td class="mdescRight">Proxy client context. <a href="#gaab2f04f908db9ebbf164b449627a14d5">More...</a><br /></td></tr>
<tr class="separator:gaab2f04f908db9ebbf164b449627a14d5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6167d8b953d67d12588d8498683febb0"><td class="memItemLeft" align="right" valign="top">typedef void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Proxy.html#ga6167d8b953d67d12588d8498683febb0">VBI_PROXY_CLIENT_CALLBACK</a>(void *p_client_data, <a class="el" href="group__Proxy.html#gabfd77fe6f5a861be3b969296dbf3d5e6">VBI_PROXY_EV_TYPE</a> ev_mask)</td></tr>
<tr class="memdesc:ga6167d8b953d67d12588d8498683febb0"><td class="mdescLeft"> </td><td class="mdescRight">Function prototype for proxy client callback. <a href="#ga6167d8b953d67d12588d8498683febb0">More...</a><br /></td></tr>
<tr class="separator:ga6167d8b953d67d12588d8498683febb0"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:gabfd77fe6f5a861be3b969296dbf3d5e6"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Proxy.html#gabfd77fe6f5a861be3b969296dbf3d5e6">VBI_PROXY_EV_TYPE</a> { <br />
  <a class="el" href="group__Proxy.html#ggabfd77fe6f5a861be3b969296dbf3d5e6a285660044a32dd0580e4622268c00082">VBI_PROXY_EV_CHN_GRANTED</a> = 1<<0,
<br />
  <a class="el" href="group__Proxy.html#ggabfd77fe6f5a861be3b969296dbf3d5e6addcfbfc01b52bdfe124ea9f42be241b8">VBI_PROXY_EV_CHN_CHANGED</a> = 1<<1,
<br />
  <a class="el" href="group__Proxy.html#ggabfd77fe6f5a861be3b969296dbf3d5e6a15cb820873d66434caa0a6d2c570e1bb">VBI_PROXY_EV_NORM_CHANGED</a> = 1<<2,
<br />
  <a class="el" href="group__Proxy.html#ggabfd77fe6f5a861be3b969296dbf3d5e6a0028ea2bc152c1c64ab36c8c5dc77e6b">VBI_PROXY_EV_CHN_RECLAIMED</a> = 1<<3,
<br />
  <a class="el" href="group__Proxy.html#ggabfd77fe6f5a861be3b969296dbf3d5e6a835427be7576f6d4382b1f33f4ceb0d3">VBI_PROXY_EV_NONE</a> = 0
<br />
}<tr class="memdesc:gabfd77fe6f5a861be3b969296dbf3d5e6"><td class="mdescLeft"> </td><td class="mdescRight">Bits in event mask parameter to proxy client callback function. <a href="group__Proxy.html#gabfd77fe6f5a861be3b969296dbf3d5e6">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:gabfd77fe6f5a861be3b969296dbf3d5e6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga28e1cf279bbebd767bb0306d58f23c12"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Proxy.html#ga28e1cf279bbebd767bb0306d58f23c12">VBI_PROXY_SUSPEND</a> { <br />
  <a class="el" href="group__Proxy.html#gga28e1cf279bbebd767bb0306d58f23c12aa16b05f1dad8d4d55c048e254bffd026">VBI_PROXY_SUSPEND_START</a>,
<br />
  <a class="el" href="group__Proxy.html#gga28e1cf279bbebd767bb0306d58f23c12a0d9f01abd95b7fbc3c2e43f0fa14b1ae">VBI_PROXY_SUSPEND_STOP</a>
<br />
}<tr class="memdesc:ga28e1cf279bbebd767bb0306d58f23c12"><td class="mdescLeft"> </td><td class="mdescRight">Modes for channel suspend requests. <a href="group__Proxy.html#ga28e1cf279bbebd767bb0306d58f23c12">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:ga28e1cf279bbebd767bb0306d58f23c12"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9ca63563efa7a5d9a8bb6c7adf340a35"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Proxy.html#ga9ca63563efa7a5d9a8bb6c7adf340a35">VBI_CHN_PRIO</a> { <br />
  <a class="el" href="group__Proxy.html#gga9ca63563efa7a5d9a8bb6c7adf340a35a6962df92254babcc38cedc34b2cedff0">VBI_CHN_PRIO_BACKGROUND</a> = 1,
<br />
  <a class="el" href="group__Proxy.html#gga9ca63563efa7a5d9a8bb6c7adf340a35a668674cf7d12cf074a872eac6dc6c72e">VBI_CHN_PRIO_INTERACTIVE</a> = 2,
<br />
  <a class="el" href="group__Proxy.html#gga9ca63563efa7a5d9a8bb6c7adf340a35a0ebe0fbef345199f0285781a11e569f7">VBI_CHN_PRIO_DEFAULT</a> = VBI_CHN_PRIO_INTERACTIVE,
<br />
  <a class="el" href="group__Proxy.html#gga9ca63563efa7a5d9a8bb6c7adf340a35a5b9343488d5c95932fda1b08b4dda059">VBI_CHN_PRIO_RECORD</a> = 3
<br />
}<tr class="memdesc:ga9ca63563efa7a5d9a8bb6c7adf340a35"><td class="mdescLeft"> </td><td class="mdescRight">Priority levels for channel switching (equivalent to enum v4l2_priority) <a href="group__Proxy.html#ga9ca63563efa7a5d9a8bb6c7adf340a35">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:ga9ca63563efa7a5d9a8bb6c7adf340a35"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6fb45c3d8d84da5474293868a0bb19f6"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Proxy.html#ga6fb45c3d8d84da5474293868a0bb19f6">VBI_CHN_SUBPRIO</a> { <br />
  <a class="el" href="group__Proxy.html#gga6fb45c3d8d84da5474293868a0bb19f6a6307bc4f8947e2ac90cc58077ed1067e">VBI_CHN_SUBPRIO_MINIMAL</a> = 0x00,
<br />
  <a class="el" href="group__Proxy.html#gga6fb45c3d8d84da5474293868a0bb19f6a347f5d1cd95d0c29d911ee37876d93d0">VBI_CHN_SUBPRIO_CHECK</a> = 0x10,
<br />
  <a class="el" href="group__Proxy.html#gga6fb45c3d8d84da5474293868a0bb19f6a454cab0d20e7c49b2c6cc40731020318">VBI_CHN_SUBPRIO_UPDATE</a> = 0x20,
<br />
  <a class="el" href="group__Proxy.html#gga6fb45c3d8d84da5474293868a0bb19f6a98d4a0b5bc9ca9ba9fb7b2fccea4dbc5">VBI_CHN_SUBPRIO_INITIAL</a> = 0x30,
<br />
  <a class="el" href="group__Proxy.html#gga6fb45c3d8d84da5474293868a0bb19f6a214e0812e830d59685cf4f2f97c9733e">VBI_CHN_SUBPRIO_VPS_PDC</a> = 0x40
<br />
}<tr class="memdesc:ga6fb45c3d8d84da5474293868a0bb19f6"><td class="mdescLeft"> </td><td class="mdescRight">Sub-priorities for channel scheduling at "background" priority. <a href="group__Proxy.html#ga6fb45c3d8d84da5474293868a0bb19f6">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:ga6fb45c3d8d84da5474293868a0bb19f6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae91928475c4bcdd0dac2ee99b9cd00cc"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Proxy.html#gae91928475c4bcdd0dac2ee99b9cd00cc">VBI_PROXY_DAEMON_FLAGS</a> { <a class="el" href="group__Proxy.html#ggae91928475c4bcdd0dac2ee99b9cd00cca358fb7caa13dd304b1e473f8554a3dee">VBI_PROXY_DAEMON_NO_TIMEOUTS</a> = 1<<0
}<tr class="memdesc:gae91928475c4bcdd0dac2ee99b9cd00cc"><td class="mdescLeft"> </td><td class="mdescRight">General flags sent by the proxy daemon to clients during connect. <a href="group__Proxy.html#gae91928475c4bcdd0dac2ee99b9cd00cc">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:gae91928475c4bcdd0dac2ee99b9cd00cc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga581f5300956a18bbb02a44781dc4a426"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Proxy.html#ga581f5300956a18bbb02a44781dc4a426">VBI_PROXY_CLIENT_FLAGS</a> { <br />
  <a class="el" href="group__Proxy.html#gga581f5300956a18bbb02a44781dc4a426a857579ec05cb945ce259968572df7ffb">VBI_PROXY_CLIENT_NO_TIMEOUTS</a> = 1<<0,
<br />
  <a class="el" href="group__Proxy.html#gga581f5300956a18bbb02a44781dc4a426aaf044fb11fdaba2fdd32610e0af2e0aa">VBI_PROXY_CLIENT_NO_STATUS_IND</a> = 1<<1
<br />
}<tr class="memdesc:ga581f5300956a18bbb02a44781dc4a426"><td class="mdescLeft"> </td><td class="mdescRight">General flags sent by clients to the proxy daemon during connect. <a href="group__Proxy.html#ga581f5300956a18bbb02a44781dc4a426">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:ga581f5300956a18bbb02a44781dc4a426"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae4aeb134137c683f751a9f2a8c71dbac"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Proxy.html#gae4aeb134137c683f751a9f2a8c71dbac">VBI_PROXY_CHN_FLAGS</a> { <br />
  <a class="el" href="group__Proxy.html#ggae4aeb134137c683f751a9f2a8c71dbaca7cc3ddc1ac2cf3a2f70c4a7b6b479ebb">VBI_PROXY_CHN_RELEASE</a> = 1<<0,
<br />
  <a class="el" href="group__Proxy.html#ggae4aeb134137c683f751a9f2a8c71dbaca1f9975b7c0dff51d8f3eeba591082b79">VBI_PROXY_CHN_TOKEN</a> = 1<<1,
<br />
  <a class="el" href="group__Proxy.html#ggae4aeb134137c683f751a9f2a8c71dbaca5fe94ed6e9ff0a4edf0f44ba8991fd39">VBI_PROXY_CHN_FLUSH</a> = 1<<2,
<br />
  <a class="el" href="group__Proxy.html#ggae4aeb134137c683f751a9f2a8c71dbaca7d790dcd715ab5bb49716906f0336ec2">VBI_PROXY_CHN_NORM</a> = 1<<3,
<br />
  <a class="el" href="group__Proxy.html#ggae4aeb134137c683f751a9f2a8c71dbaca26b75480c6d3223e2a463f68e9586baa">VBI_PROXY_CHN_FAIL</a> = 1<<4,
<br />
  <b>VBI_PROXY_CHN_NONE</b> = 0
<br />
}<tr class="memdesc:gae4aeb134137c683f751a9f2a8c71dbac"><td class="mdescLeft"> </td><td class="mdescRight">Channel notification flags. <a href="group__Proxy.html#gae4aeb134137c683f751a9f2a8c71dbac">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:gae4aeb134137c683f751a9f2a8c71dbac"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafc94b45e79b4b6e95727eefc4719f886"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Proxy.html#gafc94b45e79b4b6e95727eefc4719f886">VBI_DRIVER_API_REV</a> { <br />
  <a class="el" href="group__Proxy.html#ggafc94b45e79b4b6e95727eefc4719f886af0bcffa97d087fe46399db74d4551209">VBI_API_UNKNOWN</a>,
<br />
  <a class="el" href="group__Proxy.html#ggafc94b45e79b4b6e95727eefc4719f886adfb540192720d6bfcf3235437ea7322d">VBI_API_V4L1</a>,
<br />
  <a class="el" href="group__Proxy.html#ggafc94b45e79b4b6e95727eefc4719f886a442bf707b98497bd723948b10ec29b30">VBI_API_V4L2</a>,
<br />
  <a class="el" href="group__Proxy.html#ggafc94b45e79b4b6e95727eefc4719f886a2fefcd42220b87db61461ac2e1c3eefa">VBI_API_BKTR</a>
<br />
}<tr class="memdesc:gafc94b45e79b4b6e95727eefc4719f886"><td class="mdescLeft"> </td><td class="mdescRight">Identification of the VBI device driver type. <a href="group__Proxy.html#gafc94b45e79b4b6e95727eefc4719f886">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:gafc94b45e79b4b6e95727eefc4719f886"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaf151aaa16e1e75028ebc14f5806764b1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__Proxy.html#gaab2f04f908db9ebbf164b449627a14d5">vbi_proxy_client</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Proxy.html#gaf151aaa16e1e75028ebc14f5806764b1">vbi_proxy_client_create</a> (const char *dev_name, const char *p_client_name, <a class="el" href="group__Proxy.html#ga581f5300956a18bbb02a44781dc4a426">VBI_PROXY_CLIENT_FLAGS</a> client_flags, char **pp_errorstr, int trace_level)</td></tr>
<tr class="separator:gaf151aaa16e1e75028ebc14f5806764b1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaee5e06c064de7a4beace254ba8fbfe24"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Proxy.html#gaee5e06c064de7a4beace254ba8fbfe24">vbi_proxy_client_destroy</a> (<a class="el" href="group__Proxy.html#gaab2f04f908db9ebbf164b449627a14d5">vbi_proxy_client</a> *vpc)</td></tr>
<tr class="separator:gaee5e06c064de7a4beace254ba8fbfe24"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga72f0ac4a7555b0b7b800b91da55a5f89"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structvbi__capture.html">vbi_capture</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Proxy.html#ga72f0ac4a7555b0b7b800b91da55a5f89">vbi_proxy_client_get_capture_if</a> (<a class="el" href="group__Proxy.html#gaab2f04f908db9ebbf164b449627a14d5">vbi_proxy_client</a> *vpc)</td></tr>
<tr class="memdesc:ga72f0ac4a7555b0b7b800b91da55a5f89"><td class="mdescLeft"> </td><td class="mdescRight">Returns capture interface for an initialized proxy client. <a href="#ga72f0ac4a7555b0b7b800b91da55a5f89">More...</a><br /></td></tr>
<tr class="separator:ga72f0ac4a7555b0b7b800b91da55a5f89"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8a18d110b84474c80c1e20a58dafc87b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__Proxy.html#ga6167d8b953d67d12588d8498683febb0">VBI_PROXY_CLIENT_CALLBACK</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Proxy.html#ga8a18d110b84474c80c1e20a58dafc87b">vbi_proxy_client_set_callback</a> (<a class="el" href="group__Proxy.html#gaab2f04f908db9ebbf164b449627a14d5">vbi_proxy_client</a> *vpc, <a class="el" href="group__Proxy.html#ga6167d8b953d67d12588d8498683febb0">VBI_PROXY_CLIENT_CALLBACK</a> *p_callback, void *p_data)</td></tr>
<tr class="memdesc:ga8a18d110b84474c80c1e20a58dafc87b"><td class="mdescLeft"> </td><td class="mdescRight">Installs callback function for asynchronous events. <a href="#ga8a18d110b84474c80c1e20a58dafc87b">More...</a><br /></td></tr>
<tr class="separator:ga8a18d110b84474c80c1e20a58dafc87b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac9e40a9fc8899b4d19658498d977714d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__Proxy.html#gafc94b45e79b4b6e95727eefc4719f886">VBI_DRIVER_API_REV</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Proxy.html#gac9e40a9fc8899b4d19658498d977714d">vbi_proxy_client_get_driver_api</a> (<a class="el" href="group__Proxy.html#gaab2f04f908db9ebbf164b449627a14d5">vbi_proxy_client</a> *vpc)</td></tr>
<tr class="memdesc:gac9e40a9fc8899b4d19658498d977714d"><td class="mdescLeft"> </td><td class="mdescRight">Returns the driver type behind the actual capture device. <a href="#gac9e40a9fc8899b4d19658498d977714d">More...</a><br /></td></tr>
<tr class="separator:gac9e40a9fc8899b4d19658498d977714d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6df1340cb05b5bd3892f68ccdd649431"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Proxy.html#ga6df1340cb05b5bd3892f68ccdd649431">vbi_proxy_client_channel_request</a> (<a class="el" href="group__Proxy.html#gaab2f04f908db9ebbf164b449627a14d5">vbi_proxy_client</a> *vpc, <a class="el" href="group__Proxy.html#ga9ca63563efa7a5d9a8bb6c7adf340a35">VBI_CHN_PRIO</a> chn_prio, <a class="el" href="structvbi__channel__profile.html">vbi_channel_profile</a> *chn_profile)</td></tr>
<tr class="separator:ga6df1340cb05b5bd3892f68ccdd649431"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae413ccff125269262a6a4512df66af70"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Proxy.html#gae413ccff125269262a6a4512df66af70">vbi_proxy_client_channel_notify</a> (<a class="el" href="group__Proxy.html#gaab2f04f908db9ebbf164b449627a14d5">vbi_proxy_client</a> *vpc, <a class="el" href="group__Proxy.html#gae4aeb134137c683f751a9f2a8c71dbac">VBI_PROXY_CHN_FLAGS</a> notify_flags, unsigned int scanning)</td></tr>
<tr class="separator:gae413ccff125269262a6a4512df66af70"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga11ec95f6b94e2dd93c0a46cb4a08a98c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Proxy.html#ga11ec95f6b94e2dd93c0a46cb4a08a98c">vbi_proxy_client_channel_suspend</a> (<a class="el" href="group__Proxy.html#gaab2f04f908db9ebbf164b449627a14d5">vbi_proxy_client</a> *vpc, <a class="el" href="group__Proxy.html#ga28e1cf279bbebd767bb0306d58f23c12">VBI_PROXY_SUSPEND</a> cmd)</td></tr>
<tr class="separator:ga11ec95f6b94e2dd93c0a46cb4a08a98c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1d7c1a8a506ae8eec540f62e2551708a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Proxy.html#ga1d7c1a8a506ae8eec540f62e2551708a">vbi_proxy_client_device_ioctl</a> (<a class="el" href="group__Proxy.html#gaab2f04f908db9ebbf164b449627a14d5">vbi_proxy_client</a> *vpc, int request, void *p_arg)</td></tr>
<tr class="memdesc:ga1d7c1a8a506ae8eec540f62e2551708a"><td class="mdescLeft"> </td><td class="mdescRight">Wrapper for ioctl requests on the VBI device. <a href="#ga1d7c1a8a506ae8eec540f62e2551708a">More...</a><br /></td></tr>
<tr class="separator:ga1d7c1a8a506ae8eec540f62e2551708a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga30512e9c958d378e7ced6441673b9bd0"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Proxy.html#ga30512e9c958d378e7ced6441673b9bd0">vbi_proxy_client_get_channel_desc</a> (<a class="el" href="group__Proxy.html#gaab2f04f908db9ebbf164b449627a14d5">vbi_proxy_client</a> *vpc, unsigned int *p_scanning, vbi_bool *p_granted)</td></tr>
<tr class="separator:ga30512e9c958d378e7ced6441673b9bd0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa411ff2caabf63c07365b1a1696132e9"><td class="memItemLeft" align="right" valign="top">vbi_bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Proxy.html#gaa411ff2caabf63c07365b1a1696132e9">vbi_proxy_client_has_channel_control</a> (<a class="el" href="group__Proxy.html#gaab2f04f908db9ebbf164b449627a14d5">vbi_proxy_client</a> *vpc)</td></tr>
<tr class="memdesc:gaa411ff2caabf63c07365b1a1696132e9"><td class="mdescLeft"> </td><td class="mdescRight">Query if the client is currently allowed to switch channels. <a href="#gaa411ff2caabf63c07365b1a1696132e9">More...</a><br /></td></tr>
<tr class="separator:gaa411ff2caabf63c07365b1a1696132e9"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Receiving sliced or raw data from VBI proxy daemon. </p>
<p>Using the VBI proxy daemon instead of capturing directly from a VBI device allows multiple clients to capture concurrently, e.g. to decode multiple data services. </p>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="gaab2f04f908db9ebbf164b449627a14d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaab2f04f908db9ebbf164b449627a14d5">§ </a></span>vbi_proxy_client</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="group__Proxy.html#gaab2f04f908db9ebbf164b449627a14d5">vbi_proxy_client</a> <a class="el" href="group__Proxy.html#gaab2f04f908db9ebbf164b449627a14d5">vbi_proxy_client</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Proxy client context. </p>
<p>A reference to this anonymous structure is returned by vbi_proxy_client_create and must be passed to the device capture interface and/or all subsequent calls to proxy client interface functions. The contents of this structure are private and must not be accessed or changed by the caller. </p>
</div>
</div>
<a id="ga6167d8b953d67d12588d8498683febb0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6167d8b953d67d12588d8498683febb0">§ </a></span>VBI_PROXY_CLIENT_CALLBACK</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void VBI_PROXY_CLIENT_CALLBACK(void *p_client_data, <a class="el" href="group__Proxy.html#gabfd77fe6f5a861be3b969296dbf3d5e6">VBI_PROXY_EV_TYPE</a> ev_mask)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Function prototype for proxy client callback. </p>
<p>The first parameter is the value which the client passed when installing the callback; it's just passed through to the callback unmodified. The second parameter contains one or more bits to describe which events occured wince the last call. </p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="gabfd77fe6f5a861be3b969296dbf3d5e6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabfd77fe6f5a861be3b969296dbf3d5e6">§ </a></span>VBI_PROXY_EV_TYPE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__Proxy.html#gabfd77fe6f5a861be3b969296dbf3d5e6">VBI_PROXY_EV_TYPE</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Bits in event mask parameter to proxy client callback function. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggabfd77fe6f5a861be3b969296dbf3d5e6a285660044a32dd0580e4622268c00082"></a>VBI_PROXY_EV_CHN_GRANTED </td><td class="fielddoc"><p>Channel control token was granted, client may now change the channel. Note: client should return the token after the channel change was completed (the channel will still remain reserved for the requested time) </p>
</td></tr>
<tr><td class="fieldname"><a id="ggabfd77fe6f5a861be3b969296dbf3d5e6addcfbfc01b52bdfe124ea9f42be241b8"></a>VBI_PROXY_EV_CHN_CHANGED </td><td class="fielddoc"><p>Channel (e.g. TV tuner frequency) was changed by another client. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggabfd77fe6f5a861be3b969296dbf3d5e6a15cb820873d66434caa0a6d2c570e1bb"></a>VBI_PROXY_EV_NORM_CHANGED </td><td class="fielddoc"><p>Norm was changed by another client (in a way which affects VBI, e.g. changes between PAL/SECAM are ignored.) The client must update its services, else no data will be forwarded by the proxy until the norm is changed back. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggabfd77fe6f5a861be3b969296dbf3d5e6a0028ea2bc152c1c64ab36c8c5dc77e6b"></a>VBI_PROXY_EV_CHN_RECLAIMED </td><td class="fielddoc"><p>Proxy requests to return the channel control token. The client is no longer allowed to switch the channel and must immediately reply with a channel notification with flag <code>VBI_PROXY_CHN_TOKEN</code> </p>
</td></tr>
<tr><td class="fieldname"><a id="ggabfd77fe6f5a861be3b969296dbf3d5e6a835427be7576f6d4382b1f33f4ceb0d3"></a>VBI_PROXY_EV_NONE </td><td class="fielddoc"><p>Empty event mask </p>
</td></tr>
</table>
</div>
</div>
<a id="ga28e1cf279bbebd767bb0306d58f23c12"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga28e1cf279bbebd767bb0306d58f23c12">§ </a></span>VBI_PROXY_SUSPEND</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__Proxy.html#ga28e1cf279bbebd767bb0306d58f23c12">VBI_PROXY_SUSPEND</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Modes for channel suspend requests. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga28e1cf279bbebd767bb0306d58f23c12aa16b05f1dad8d4d55c048e254bffd026"></a>VBI_PROXY_SUSPEND_START </td><td class="fielddoc"><p>Request proxy daemon to stop acquisition (e.g. required by some device drivers to allow a norm change.) Depending on the driver this may result in the proxy closing the device file handle or just stopping the VBI data stream. Note this command is only allowed when the client is in control of the channel. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga28e1cf279bbebd767bb0306d58f23c12a0d9f01abd95b7fbc3c2e43f0fa14b1ae"></a>VBI_PROXY_SUSPEND_STOP </td><td class="fielddoc"><p>Restart data acquisition after a previous suspension. </p>
</td></tr>
</table>
</div>
</div>
<a id="ga9ca63563efa7a5d9a8bb6c7adf340a35"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9ca63563efa7a5d9a8bb6c7adf340a35">§ </a></span>VBI_CHN_PRIO</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__Proxy.html#ga9ca63563efa7a5d9a8bb6c7adf340a35">VBI_CHN_PRIO</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Priority levels for channel switching (equivalent to enum v4l2_priority) </p>
<p>These priorities are used to cooperativly resolve conflicts between channel requests of multiple capture applications. While a capture application with a higher priority has opened a device, channel change requests of applications with lower priority will fail with error "EBUSY". </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga9ca63563efa7a5d9a8bb6c7adf340a35a6962df92254babcc38cedc34b2cedff0"></a>VBI_CHN_PRIO_BACKGROUND </td><td class="fielddoc"><p>Priority level to be used for non-interactive, background data harvesting, i.e. applications which permanently run in the background (e.g. teletext cache, EPG data acquisition) </p>
</td></tr>
<tr><td class="fieldname"><a id="gga9ca63563efa7a5d9a8bb6c7adf340a35a668674cf7d12cf074a872eac6dc6c72e"></a>VBI_CHN_PRIO_INTERACTIVE </td><td class="fielddoc"><p>Interactive (default): should be used when channels are changed on request of the user (e.g. TV viewer, Radio, teletext reader) </p>
</td></tr>
<tr><td class="fieldname"><a id="gga9ca63563efa7a5d9a8bb6c7adf340a35a0ebe0fbef345199f0285781a11e569f7"></a>VBI_CHN_PRIO_DEFAULT </td><td class="fielddoc"><p>Default priority for client which have not (yet) set a priority. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga9ca63563efa7a5d9a8bb6c7adf340a35a5b9343488d5c95932fda1b08b4dda059"></a>VBI_CHN_PRIO_RECORD </td><td class="fielddoc"><p>Scheduled recording (e.g. PVR): usually only one application should run at this level (although this is not enforced by the proxy daemon, must be checked by the user or applications) </p>
</td></tr>
</table>
</div>
</div>
<a id="ga6fb45c3d8d84da5474293868a0bb19f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6fb45c3d8d84da5474293868a0bb19f6">§ </a></span>VBI_CHN_SUBPRIO</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__Proxy.html#ga6fb45c3d8d84da5474293868a0bb19f6">VBI_CHN_SUBPRIO</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sub-priorities for channel scheduling at "background" priority. </p>
<p>This enum describes recommended sub-priority levels for channel profiles. They're intended for channel switching through a VBI proxy at background priority level. The daemon uses this priority to decide which request to grant first if there are multiple outstanding requests. To the daemon these are just numbers (highest wins) but for successful cooperation clients need to use agree on values for similar tasks. Hence the following values are recommended: </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga6fb45c3d8d84da5474293868a0bb19f6a6307bc4f8947e2ac90cc58077ed1067e"></a>VBI_CHN_SUBPRIO_MINIMAL </td><td class="fielddoc"><p>Minimal priority level. Client will get channel control only after all other clients. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga6fb45c3d8d84da5474293868a0bb19f6a347f5d1cd95d0c29d911ee37876d93d0"></a>VBI_CHN_SUBPRIO_CHECK </td><td class="fielddoc"><p>After phases "initial" or "check" are completed, clients can use this level to continuously check for change marks. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga6fb45c3d8d84da5474293868a0bb19f6a454cab0d20e7c49b2c6cc40731020318"></a>VBI_CHN_SUBPRIO_UPDATE </td><td class="fielddoc"><p>A change in the data transmission has been detected or a long time has passed since the initial reading, so data needs to be read newly. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga6fb45c3d8d84da5474293868a0bb19f6a98d4a0b5bc9ca9ba9fb7b2fccea4dbc5"></a>VBI_CHN_SUBPRIO_INITIAL </td><td class="fielddoc"><p>Initial reading of data after program start (and long pause since last start); once all data is read the client should lower it's priority. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga6fb45c3d8d84da5474293868a0bb19f6a214e0812e830d59685cf4f2f97c9733e"></a>VBI_CHN_SUBPRIO_VPS_PDC </td><td class="fielddoc"><p>Scanning for VPS/PDC labels to wait for the start of a recording. </p>
</td></tr>
</table>
</div>
</div>
<a id="gae91928475c4bcdd0dac2ee99b9cd00cc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae91928475c4bcdd0dac2ee99b9cd00cc">§ </a></span>VBI_PROXY_DAEMON_FLAGS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__Proxy.html#gae91928475c4bcdd0dac2ee99b9cd00cc">VBI_PROXY_DAEMON_FLAGS</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>General flags sent by the proxy daemon to clients during connect. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggae91928475c4bcdd0dac2ee99b9cd00cca358fb7caa13dd304b1e473f8554a3dee"></a>VBI_PROXY_DAEMON_NO_TIMEOUTS </td><td class="fielddoc"><p>Don't drop connection upon timeouts in socket I/O or message response; Intended for debugging, i.e. when remote party runs in a debugger </p>
</td></tr>
</table>
</div>
</div>
<a id="ga581f5300956a18bbb02a44781dc4a426"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga581f5300956a18bbb02a44781dc4a426">§ </a></span>VBI_PROXY_CLIENT_FLAGS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__Proxy.html#ga581f5300956a18bbb02a44781dc4a426">VBI_PROXY_CLIENT_FLAGS</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>General flags sent by clients to the proxy daemon during connect. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga581f5300956a18bbb02a44781dc4a426a857579ec05cb945ce259968572df7ffb"></a>VBI_PROXY_CLIENT_NO_TIMEOUTS </td><td class="fielddoc"><p>Don't drop connection upon timeouts in socket I/O or message response (e.g. when waiting for connect confirm) Intended for debugging, i.e. when remote party runs in a debugger </p>
</td></tr>
<tr><td class="fieldname"><a id="gga581f5300956a18bbb02a44781dc4a426aaf044fb11fdaba2fdd32610e0af2e0aa"></a>VBI_PROXY_CLIENT_NO_STATUS_IND </td><td class="fielddoc"><p>Suppress sending of channel change and similar indications, i.e. limit messages to slicer data forward and synchronous messages (i.e. RPC reply). Used to make sure that the proxy client socket only becomes readable when data is available for applications which are not proxy-aware. </p>
</td></tr>
</table>
</div>
</div>
<a id="gae4aeb134137c683f751a9f2a8c71dbac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae4aeb134137c683f751a9f2a8c71dbac">§ </a></span>VBI_PROXY_CHN_FLAGS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__Proxy.html#gae4aeb134137c683f751a9f2a8c71dbac">VBI_PROXY_CHN_FLAGS</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Channel notification flags. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggae4aeb134137c683f751a9f2a8c71dbaca7cc3ddc1ac2cf3a2f70c4a7b6b479ebb"></a>VBI_PROXY_CHN_RELEASE </td><td class="fielddoc"><p>Revoke a previous channel request and return the channel switch token to the daemon. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggae4aeb134137c683f751a9f2a8c71dbaca1f9975b7c0dff51d8f3eeba591082b79"></a>VBI_PROXY_CHN_TOKEN </td><td class="fielddoc"><p>Return the channel token to the daemon without releasing the channel; This should always be done when the channel switch has been completed to allow faster scheduling in the daemon (i.e. the daemon can grant the token to a different client without having to reclaim it first.) </p>
</td></tr>
<tr><td class="fieldname"><a id="ggae4aeb134137c683f751a9f2a8c71dbaca5fe94ed6e9ff0a4edf0f44ba8991fd39"></a>VBI_PROXY_CHN_FLUSH </td><td class="fielddoc"><p>Indicate that the channel was changed and VBI buffer queue must be flushed; Should be called as fast as possible after the channel and/or norm was changed. Note this affects other clients' capturing too, so use with care. Other clients will be informed about this change by a channel change indication. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggae4aeb134137c683f751a9f2a8c71dbaca7d790dcd715ab5bb49716906f0336ec2"></a>VBI_PROXY_CHN_NORM </td><td class="fielddoc"><p>Indicate a norm change. The new norm should be supplied in the scanning parameter in cae the daemon is not able to determine it from the device directly. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggae4aeb134137c683f751a9f2a8c71dbaca26b75480c6d3223e2a463f68e9586baa"></a>VBI_PROXY_CHN_FAIL </td><td class="fielddoc"><p>Indicate that the client failed to switch the channel because the device was busy. Used to notify the channel scheduler that the current time slice cannot be used by the client. If the client isn't able to schedule periodic re-attempts it should also return the token. </p>
</td></tr>
</table>
</div>
</div>
<a id="gafc94b45e79b4b6e95727eefc4719f886"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafc94b45e79b4b6e95727eefc4719f886">§ </a></span>VBI_DRIVER_API_REV</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__Proxy.html#gafc94b45e79b4b6e95727eefc4719f886">VBI_DRIVER_API_REV</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Identification of the VBI device driver type. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggafc94b45e79b4b6e95727eefc4719f886af0bcffa97d087fe46399db74d4551209"></a>VBI_API_UNKNOWN </td><td class="fielddoc"><p>Unknown device API - only used in error cases. Normally the proxy will always be aware of the driver API as it's determined by the type of capture context creation function used when the device is opened. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggafc94b45e79b4b6e95727eefc4719f886adfb540192720d6bfcf3235437ea7322d"></a>VBI_API_V4L1 </td><td class="fielddoc"><p>Video4Linux version 1 (i.e. Linux kernels 2.4 or older or old device drivers which have not been ported yet) </p>
</td></tr>
<tr><td class="fieldname"><a id="ggafc94b45e79b4b6e95727eefc4719f886a442bf707b98497bd723948b10ec29b30"></a>VBI_API_V4L2 </td><td class="fielddoc"><p>Video4Linux version 2 (i.e. Linux kernels 2.6 and later) </p>
</td></tr>
<tr><td class="fieldname"><a id="ggafc94b45e79b4b6e95727eefc4719f886a2fefcd42220b87db61461ac2e1c3eefa"></a>VBI_API_BKTR </td><td class="fielddoc"><p>BSD Brooktree capture driver. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="gaf151aaa16e1e75028ebc14f5806764b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf151aaa16e1e75028ebc14f5806764b1">§ </a></span>vbi_proxy_client_create()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__Proxy.html#gaab2f04f908db9ebbf164b449627a14d5">vbi_proxy_client</a>* vbi_proxy_client_create </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>p_dev_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>p_client_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__Proxy.html#ga581f5300956a18bbb02a44781dc4a426">VBI_PROXY_CLIENT_FLAGS</a> </td>
<td class="paramname"><em>client_flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>pp_errorstr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>trace_level</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p_dev_name</td><td>Name of the device to open, usually one of <code>/dev/vbi</code> or <code>/dev/vbi0</code> and up. Note: should be the same path as used by the proxy daemon, else the client may not be able to connect. </td></tr>
<tr><td class="paramname">p_client_name</td><td>Name of the client application, typically identical to argv[0] (without the path though) Can be used by the proxy daemon to fine-tune scheduling or to present the user with a list of currently connected applications. </td></tr>
<tr><td class="paramname">client_flags</td><td>Can contain one or more members of VBI_PROXY_CLIENT_FLAGS </td></tr>
<tr><td class="paramname">pp_errorstr</td><td>If not <code>NULL</code> this function stores a pointer to an error description here. You must free() this string when no longer needed. </td></tr>
<tr><td class="paramname">trace_level</td><td>Enable debug output to stderr if non-zero. Larger values produce more output.</td></tr>
</table>
</dd>
</dl>
<p>This function initializes a proxy daemon client context with the given parameters. (Note this function does not yet connect the daemon.)</p>
<dl class="section return"><dt>Returns</dt><dd>Initialized proxy client context, <code>NULL</code> on failure</dd></dl>
<dl class="section since"><dt>Since</dt><dd>0.2.9 </dd></dl>
</div>
</div>
<a id="gaee5e06c064de7a4beace254ba8fbfe24"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaee5e06c064de7a4beace254ba8fbfe24">§ </a></span>vbi_proxy_client_destroy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vbi_proxy_client_destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Proxy.html#gaab2f04f908db9ebbf164b449627a14d5">vbi_proxy_client</a> * </td>
<td class="paramname"><em>vpc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">vpc</td><td>Pointer to initialized proxy client context</td></tr>
</table>
</dd>
</dl>
<p>This function closes the connection to the proxy daemon and frees all resources. The given context must no longer be used after this function was called. If the context was used via the capture device interface, the <a class="el" href="structvbi__capture.html">vbi_capture</a> context must be destroyed first.</p>
<dl class="section since"><dt>Since</dt><dd>0.2.9 </dd></dl>
</div>
</div>
<a id="ga72f0ac4a7555b0b7b800b91da55a5f89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga72f0ac4a7555b0b7b800b91da55a5f89">§ </a></span>vbi_proxy_client_get_capture_if()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structvbi__capture.html">vbi_capture</a>* vbi_proxy_client_get_capture_if </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Proxy.html#gaab2f04f908db9ebbf164b449627a14d5">vbi_proxy_client</a> * </td>
<td class="paramname"><em>vpc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns capture interface for an initialized proxy client. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">vpc</td><td>Pointer to initialized and active proxy client context</td></tr>
</table>
</dd>
</dl>
<p>This function is for convenience only: it returns the same pointer as the previous call to <a class="el" href="group__Device.html#gadd95797407676b4d2d31a2cbf6682b4d">vbi_capture_proxy_new()</a>, so that the client need not store it. This pointer is required for function calls through the capture device API (e.g. reading raw or sliced data)</p>
<dl class="section return"><dt>Returns</dt><dd>Pointer to a <a class="el" href="structvbi__capture.html">vbi_capture</a> structure, should be treated as void * by caller, i.e. acessed neither for read nor write. Returns <code>NULL</code> upon error (i.e. if the client is not connected to the daemon)</dd></dl>
<dl class="section since"><dt>Since</dt><dd>0.2.9 </dd></dl>
</div>
</div>
<a id="ga8a18d110b84474c80c1e20a58dafc87b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8a18d110b84474c80c1e20a58dafc87b">§ </a></span>vbi_proxy_client_set_callback()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__Proxy.html#ga6167d8b953d67d12588d8498683febb0">VBI_PROXY_CLIENT_CALLBACK</a>* vbi_proxy_client_set_callback </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Proxy.html#gaab2f04f908db9ebbf164b449627a14d5">vbi_proxy_client</a> * </td>
<td class="paramname"><em>vpc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__Proxy.html#ga6167d8b953d67d12588d8498683febb0">VBI_PROXY_CLIENT_CALLBACK</a> * </td>
<td class="paramname"><em>p_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>p_data</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Installs callback function for asynchronous events. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">vpc</td><td>Pointer to initialized proxy client context </td></tr>
<tr><td class="paramname">p_callback</td><td>Pointer to callback function </td></tr>
<tr><td class="paramname">p_data</td><td>Void pointer which will be passed through to the callback function unmodified.</td></tr>
</table>
</dd>
</dl>
<p>This function installs a callback function which will be invoked upon asynchronous events (e.g. channel changes by other clients.) Since the proxy client has no "life" on it's own (i.e. it's not using an internal thread or process) callbacks will only occur from inside other proxy client function calls. The client's file description will become readable when an asynchronous message has arrived from the daemon. Typically the application then will call read to obtain sliced data and the callback will be invoked from inside the read function. Usually in this case the read call will return zero, i.e. indicate an timeout since no actual sliced data has arrived.</p>
<p>Note for channel requests the callback to grant channel control may be invoked before the request function returns. Note you can call any interface function from inside the callback, including the destroy operator.</p>
<dl class="section return"><dt>Returns</dt><dd>Returns pointer to the previous callback or <code>NULL</code> if none.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>0.2.9 </dd></dl>
</div>
</div>
<a id="gac9e40a9fc8899b4d19658498d977714d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac9e40a9fc8899b4d19658498d977714d">§ </a></span>vbi_proxy_client_get_driver_api()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__Proxy.html#gafc94b45e79b4b6e95727eefc4719f886">VBI_DRIVER_API_REV</a> vbi_proxy_client_get_driver_api </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Proxy.html#gaab2f04f908db9ebbf164b449627a14d5">vbi_proxy_client</a> * </td>
<td class="paramname"><em>vpc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the driver type behind the actual capture device. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">vpc</td><td>Pointer to initialized proxy client context</td></tr>
</table>
</dd>
</dl>
<p>This function can be used to query which driver is behind the device which is currently opened by the VBI proxy daemon. Applications which use libzvbi's capture API only need not care about this. The information is only relevant to applications which need to change channels or norms.</p>
<p>The function will fail if the client is currently not connected to the daemon, i.e. VPI capture has to be started first.</p>
<dl class="section return"><dt>Returns</dt><dd>Driver type or -1 on error.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>0.2.9 </dd></dl>
<p>References <a class="el" href="group__Proxy.html#ggafc94b45e79b4b6e95727eefc4719f886af0bcffa97d087fe46399db74d4551209">VBI_API_UNKNOWN</a>.</p>
</div>
</div>
<a id="ga6df1340cb05b5bd3892f68ccdd649431"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6df1340cb05b5bd3892f68ccdd649431">§ </a></span>vbi_proxy_client_channel_request()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int vbi_proxy_client_channel_request </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Proxy.html#gaab2f04f908db9ebbf164b449627a14d5">vbi_proxy_client</a> * </td>
<td class="paramname"><em>vpc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__Proxy.html#ga9ca63563efa7a5d9a8bb6c7adf340a35">VBI_CHN_PRIO</a> </td>
<td class="paramname"><em>chn_prio</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structvbi__channel__profile.html">vbi_channel_profile</a> * </td>
<td class="paramname"><em>p_chn_profile</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">vpc</td><td>Pointer to initialized proxy client context </td></tr>
<tr><td class="paramname">chn_prio</td><td>Channel change priority level. If there are other clients with higher priority the client will be refused any channel changes. </td></tr>
<tr><td class="paramname">p_chn_profile</td><td>Channel profile for scheduling at background priority level.</td></tr>
</table>
</dd>
</dl>
<p>This function is used to request permission to switch channels or norm. Since the VBI device can be shared with other proxy clients, clients should wait for permission, so that the proxy daemon can fairly schedule channel requests.</p>
<p>Scheduling differs at the 3 priority levels. For an explanation of priorities see enum VBI_CHN_PRIO. At background level channel changes are coordinated by introduction of a virtual token: only the one client which holds the token is allowed to switch channels. The daemon will wait for the token to be returned before it's granted to another client. This way conflicting channel changes are avoided.</p>
<p>At the upper level the latest request always wins. To avoid interference the application still might wait until it gets indicated that the token has been returned to the daemon.</p>
<p>The token may be granted right away or at a later time, e.g. when it has to be reclaimed from another client first, or if there are other clients with higher priority. If a callback has been registered, it will be invoked when the token arrives; otherwise <a class="el" href="group__Proxy.html#gaa411ff2caabf63c07365b1a1696132e9" title="Query if the client is currently allowed to switch channels. ">vbi_proxy_client_has_channel_control()</a> can be used to poll for it.</p>
<p>Note: to set the priority level to "background" only without requesting a channel, set the is_valid member in the profile to <code>FALSE</code>.</p>
<dl class="section return"><dt>Returns</dt><dd>1 if change is allowed, 0 if not allowed, -1 on error, examine <code>errno</code> for details.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>0.2.9 </dd></dl>
</div>
</div>
<a id="gae413ccff125269262a6a4512df66af70"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae413ccff125269262a6a4512df66af70">§ </a></span>vbi_proxy_client_channel_notify()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int vbi_proxy_client_channel_notify </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Proxy.html#gaab2f04f908db9ebbf164b449627a14d5">vbi_proxy_client</a> * </td>
<td class="paramname"><em>vpc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__Proxy.html#gae4aeb134137c683f751a9f2a8c71dbac">VBI_PROXY_CHN_FLAGS</a> </td>
<td class="paramname"><em>notify_flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>scanning</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">vpc</td><td>Pointer to initialized proxy client context </td></tr>
<tr><td class="paramname">notify_flags</td><td>Combination of event notification bits </td></tr>
<tr><td class="paramname">scanning</td><td>New norm, if norm event bit is set</td></tr>
</table>
</dd>
</dl>
<p>Send channel control request to proxy daemon. See description of the flags for details.</p>
<dl class="section return"><dt>Returns</dt><dd>0 upon success, -1 on error, examine <code>errno</code> for details.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>0.2.9 </dd></dl>
</div>
</div>
<a id="ga11ec95f6b94e2dd93c0a46cb4a08a98c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga11ec95f6b94e2dd93c0a46cb4a08a98c">§ </a></span>vbi_proxy_client_channel_suspend()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int vbi_proxy_client_channel_suspend </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Proxy.html#gaab2f04f908db9ebbf164b449627a14d5">vbi_proxy_client</a> * </td>
<td class="paramname"><em>vpc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__Proxy.html#ga28e1cf279bbebd767bb0306d58f23c12">VBI_PROXY_SUSPEND</a> </td>
<td class="paramname"><em>cmd</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">vpc</td><td>Pointer to initialized proxy client context </td></tr>
<tr><td class="paramname">cmd</td><td>Control command</td></tr>
</table>
</dd>
</dl>
<p>Request to temporarily suspend capturing</p>
<dl class="section return"><dt>Returns</dt><dd>0 upon success, -1 on error, examine <code>errno</code> for details.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>0.2.9 </dd></dl>
</div>
</div>
<a id="ga1d7c1a8a506ae8eec540f62e2551708a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1d7c1a8a506ae8eec540f62e2551708a">§ </a></span>vbi_proxy_client_device_ioctl()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int vbi_proxy_client_device_ioctl </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Proxy.html#gaab2f04f908db9ebbf164b449627a14d5">vbi_proxy_client</a> * </td>
<td class="paramname"><em>vpc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>request</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>p_arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Wrapper for ioctl requests on the VBI device. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">vpc</td><td>Pointer to initialized proxy client context </td></tr>
<tr><td class="paramname">request</td><td>Ioctl request code to be passed to driver </td></tr>
<tr><td class="paramname">p_arg</td><td>Ioctl argument buffer to be passed to driver. For ioctls which return data, the buffer will by modified by the call (i.e. same as if the ioctl had ben called directly) Note the required buffer size depends on the request code.</td></tr>
</table>
</dd>
</dl>
<p>This function allows to manipulate parameters of the underlying VBI device. Not all ioctls are allowed here. It's mainly intended to be used for channel enumeration and channel/norm changes. The request codes and parameters are the same as for the actual device. The caller has to query the driver API first and use the respective ioctl codes, same as if the device would be used directly.</p>
<dl class="section return"><dt>Returns</dt><dd>Same as for the ioctl, i.e. -1 on error and errno set appropriately. The funtion also will fail with errno <code>EBUSY</code> if the client doesn't have permission to control the channel.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>0.2.9 </dd></dl>
</div>
</div>
<a id="ga30512e9c958d378e7ced6441673b9bd0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga30512e9c958d378e7ced6441673b9bd0">§ </a></span>vbi_proxy_client_get_channel_desc()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int vbi_proxy_client_get_channel_desc </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Proxy.html#gaab2f04f908db9ebbf164b449627a14d5">vbi_proxy_client</a> * </td>
<td class="paramname"><em>vpc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int * </td>
<td class="paramname"><em>p_scanning</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vbi_bool * </td>
<td class="paramname"><em>p_granted</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">vpc</td><td>Pointer to initialized proxy client context </td></tr>
<tr><td class="paramname">p_scanning</td><td>Returns new scanning after channel change </td></tr>
<tr><td class="paramname">p_granted</td><td>Returns<code>TRUE</code> if client is currently allowed to switch channels</td></tr>
</table>
</dd>
</dl>
<p>Retrieve info sent by the proxy daemon in a channel change indication.</p>
<dl class="section return"><dt>Returns</dt><dd>0 upon success, -1 on error.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>0.2.9 </dd></dl>
</div>
</div>
<a id="gaa411ff2caabf63c07365b1a1696132e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa411ff2caabf63c07365b1a1696132e9">§ </a></span>vbi_proxy_client_has_channel_control()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vbi_bool vbi_proxy_client_has_channel_control </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Proxy.html#gaab2f04f908db9ebbf164b449627a14d5">vbi_proxy_client</a> * </td>
<td class="paramname"><em>vpc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Query if the client is currently allowed to switch channels. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">vpc</td><td>Pointer to initialized proxy client context</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns <code>TRUE</code> if client is currently allowed to switch channels.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>0.2.9 </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.12
</small></address>
</body>
</html>
|