/usr/share/gtk-doc/html/libnice/NiceAgent.html is in libnice-doc 0.1.14-1.
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 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>NiceAgent: libnice Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="libnice Reference Manual">
<link rel="up" href="ch01.html" title="">
<link rel="prev" href="ch01.html" title="">
<link rel="next" href="libnice-NiceAddress.html" title="NiceAddress">
<meta name="generator" content="GTK-Doc V1.25 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#NiceAgent.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#NiceAgent.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#NiceAgent.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#NiceAgent.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch01.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libnice-NiceAddress.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="NiceAgent"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="NiceAgent.top_of_page"></a>NiceAgent</span></h2>
<p>NiceAgent — ICE agent API implementation</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="NiceAgent.stability-level"></a><h2>Stability Level</h2>
<acronym title="The intention of a Stable interface is to enable arbitrary third parties to
develop applications to these interfaces, release them, and have confidence that
they will run on all minor releases of the product (after the one in which the
interface was introduced, and within the same major release). Even at a major
release, incompatible changes are expected to be rare, and to have strong
justifications.
"><span class="acronym">Stable</span></acronym>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="NiceAgent.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="NiceAgent.html#NiceAgentRecvFunc" title="NiceAgentRecvFunc ()">*NiceAgentRecvFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="NiceAgent.html" title="NiceAgent"><span class="returnvalue">NiceAgent</span></a> *
</td>
<td class="function_name">
<a class="link" href="NiceAgent.html#nice-agent-new" title="nice_agent_new ()">nice_agent_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="NiceAgent.html" title="NiceAgent"><span class="returnvalue">NiceAgent</span></a> *
</td>
<td class="function_name">
<a class="link" href="NiceAgent.html#nice-agent-new-reliable" title="nice_agent_new_reliable ()">nice_agent_new_reliable</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="NiceAgent.html#nice-agent-add-local-address" title="nice_agent_add_local_address ()">nice_agent_add_local_address</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="NiceAgent.html#nice-agent-set-port-range" title="nice_agent_set_port_range ()">nice_agent_set_port_range</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
</td>
<td class="function_name">
<a class="link" href="NiceAgent.html#nice-agent-add-stream" title="nice_agent_add_stream ()">nice_agent_add_stream</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="NiceAgent.html#nice-agent-remove-stream" title="nice_agent_remove_stream ()">nice_agent_remove_stream</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="NiceAgent.html#nice-agent-set-relay-info" title="nice_agent_set_relay_info ()">nice_agent_set_relay_info</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="NiceAgent.html#nice-agent-forget-relays" title="nice_agent_forget_relays ()">nice_agent_forget_relays</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="NiceAgent.html#nice-agent-gather-candidates" title="nice_agent_gather_candidates ()">nice_agent_gather_candidates</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="NiceAgent.html#nice-agent-set-remote-credentials" title="nice_agent_set_remote_credentials ()">nice_agent_set_remote_credentials</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="NiceAgent.html#nice-agent-get-local-credentials" title="nice_agent_get_local_credentials ()">nice_agent_get_local_credentials</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="NiceAgent.html#nice-agent-set-local-credentials" title="nice_agent_set_local_credentials ()">nice_agent_set_local_credentials</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="NiceAgent.html#nice-agent-set-remote-candidates" title="nice_agent_set_remote_candidates ()">nice_agent_set_remote_candidates</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glibglib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *
</td>
<td class="function_name">
<a class="link" href="NiceAgent.html#nice-agent-get-remote-candidates" title="nice_agent_get_remote_candidates ()">nice_agent_get_remote_candidates</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glibglib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *
</td>
<td class="function_name">
<a class="link" href="NiceAgent.html#nice-agent-get-local-candidates" title="nice_agent_get_local_candidates ()">nice_agent_get_local_candidates</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="NiceAgent.html#nice-agent-get-selected-pair" title="nice_agent_get_selected_pair ()">nice_agent_get_selected_pair</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
</td>
<td class="function_name">
<a class="link" href="NiceAgent.html#nice-agent-send" title="nice_agent_send ()">nice_agent_send</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
</td>
<td class="function_name">
<a class="link" href="NiceAgent.html#nice-agent-send-messages-nonblocking" title="nice_agent_send_messages_nonblocking ()">nice_agent_send_messages_nonblocking</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gssize"><span class="returnvalue">gssize</span></a>
</td>
<td class="function_name">
<a class="link" href="NiceAgent.html#nice-agent-recv" title="nice_agent_recv ()">nice_agent_recv</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
</td>
<td class="function_name">
<a class="link" href="NiceAgent.html#nice-agent-recv-messages" title="nice_agent_recv_messages ()">nice_agent_recv_messages</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gssize"><span class="returnvalue">gssize</span></a>
</td>
<td class="function_name">
<a class="link" href="NiceAgent.html#nice-agent-recv-nonblocking" title="nice_agent_recv_nonblocking ()">nice_agent_recv_nonblocking</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
</td>
<td class="function_name">
<a class="link" href="NiceAgent.html#nice-agent-recv-messages-nonblocking" title="nice_agent_recv_messages_nonblocking ()">nice_agent_recv_messages_nonblocking</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="NiceAgent.html#nice-agent-attach-recv" title="nice_agent_attach_recv ()">nice_agent_attach_recv</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="NiceAgent.html#nice-agent-set-selected-pair" title="nice_agent_set_selected_pair ()">nice_agent_set_selected_pair</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="NiceAgent.html#nice-agent-set-selected-remote-candidate" title="nice_agent_set_selected_remote_candidate ()">nice_agent_set_selected_remote_candidate</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="NiceAgent.html#nice-agent-set-stream-tos" title="nice_agent_set_stream_tos ()">nice_agent_set_stream_tos</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="NiceAgent.html#nice-agent-set-software" title="nice_agent_set_software ()">nice_agent_set_software</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="NiceAgent.html#nice-agent-restart" title="nice_agent_restart ()">nice_agent_restart</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="NiceAgent.html#nice-agent-restart-stream" title="nice_agent_restart_stream ()">nice_agent_restart_stream</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="NiceAgent.html#nice-agent-set-stream-name" title="nice_agent_set_stream_name ()">nice_agent_set_stream_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="NiceAgent.html#nice-agent-get-stream-name" title="nice_agent_get_stream_name ()">nice_agent_get_stream_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="NiceCandidate.html" title="NiceCandidate"><span class="returnvalue">NiceCandidate</span></a> *
</td>
<td class="function_name">
<a class="link" href="NiceAgent.html#nice-agent-get-default-local-candidate" title="nice_agent_get_default_local_candidate ()">nice_agent_get_default_local_candidate</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="NiceAgent.html#nice-agent-generate-local-sdp" title="nice_agent_generate_local_sdp ()">nice_agent_generate_local_sdp</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="NiceAgent.html#nice-agent-generate-local-stream-sdp" title="nice_agent_generate_local_stream_sdp ()">nice_agent_generate_local_stream_sdp</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="NiceAgent.html#nice-agent-generate-local-candidate-sdp" title="nice_agent_generate_local_candidate_sdp ()">nice_agent_generate_local_candidate_sdp</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="NiceAgent.html#nice-agent-parse-remote-sdp" title="nice_agent_parse_remote_sdp ()">nice_agent_parse_remote_sdp</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glibglib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *
</td>
<td class="function_name">
<a class="link" href="NiceAgent.html#nice-agent-parse-remote-stream-sdp" title="nice_agent_parse_remote_stream_sdp ()">nice_agent_parse_remote_stream_sdp</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="NiceCandidate.html" title="NiceCandidate"><span class="returnvalue">NiceCandidate</span></a> *
</td>
<td class="function_name">
<a class="link" href="NiceAgent.html#nice-agent-parse-remote-candidate-sdp" title="nice_agent_parse_remote_candidate_sdp ()">nice_agent_parse_remote_candidate_sdp</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/gioGIOStream.html#GIOStream-struct"><span class="returnvalue">GIOStream</span></a> *
</td>
<td class="function_name">
<a class="link" href="NiceAgent.html#nice-agent-get-io-stream" title="nice_agent_get_io_stream ()">nice_agent_get_io_stream</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/gioGSocket.html#GSocket-struct"><span class="returnvalue">GSocket</span></a> *
</td>
<td class="function_name">
<a class="link" href="NiceAgent.html#nice-agent-get-selected-socket" title="nice_agent_get_selected_socket ()">nice_agent_get_selected_socket</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="NiceAgent.html#NiceComponentState" title="enum NiceComponentState"><span class="returnvalue">NiceComponentState</span></a>
</td>
<td class="function_name">
<a class="link" href="NiceAgent.html#nice-agent-get-component-state" title="nice_agent_get_component_state ()">nice_agent_get_component_state</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="NiceAgent.html#nice-component-state-to-string" title="nice_component_state_to_string ()">nice_component_state_to_string</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="NiceAgent.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="NiceAgent.html#NiceAgent--bytestream-tcp" title="The “bytestream-tcp” property">bytestream-tcp</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a></td>
<td class="property_name"><a class="link" href="NiceAgent.html#NiceAgent--compatibility" title="The “compatibility” property">compatibility</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="NiceAgent.html#NiceAgent--controlling-mode" title="The “controlling-mode” property">controlling-mode</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="NiceAgent.html#NiceAgent--force-relay" title="The “force-relay” property">force-relay</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="NiceAgent.html#NiceAgent--full-mode" title="The “full-mode” property">full-mode</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="NiceAgent.html#NiceAgent--ice-tcp" title="The “ice-tcp” property">ice-tcp</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="NiceAgent.html#NiceAgent--ice-udp" title="The “ice-udp” property">ice-udp</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="NiceAgent.html#NiceAgent--keepalive-conncheck" title="The “keepalive-conncheck” property">keepalive-conncheck</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></td>
<td class="property_name"><a class="link" href="NiceAgent.html#NiceAgent--main-context" title="The “main-context” property">main-context</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a></td>
<td class="property_name"><a class="link" href="NiceAgent.html#NiceAgent--max-connectivity-checks" title="The “max-connectivity-checks” property">max-connectivity-checks</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="NiceAgent.html#NiceAgent--proxy-ip" title="The “proxy-ip” property">proxy-ip</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="NiceAgent.html#NiceAgent--proxy-password" title="The “proxy-password” property">proxy-password</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a></td>
<td class="property_name"><a class="link" href="NiceAgent.html#NiceAgent--proxy-port" title="The “proxy-port” property">proxy-port</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a></td>
<td class="property_name"><a class="link" href="NiceAgent.html#NiceAgent--proxy-type" title="The “proxy-type” property">proxy-type</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="NiceAgent.html#NiceAgent--proxy-username" title="The “proxy-username” property">proxy-username</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="NiceAgent.html#NiceAgent--reliable" title="The “reliable” property">reliable</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a></td>
<td class="property_name"><a class="link" href="NiceAgent.html#NiceAgent--stun-pacing-timer" title="The “stun-pacing-timer” property">stun-pacing-timer</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="NiceAgent.html#NiceAgent--stun-server" title="The “stun-server” property">stun-server</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a></td>
<td class="property_name"><a class="link" href="NiceAgent.html#NiceAgent--stun-server-port" title="The “stun-server-port” property">stun-server-port</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="NiceAgent.html#NiceAgent--upnp" title="The “upnp” property">upnp</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a></td>
<td class="property_name"><a class="link" href="NiceAgent.html#NiceAgent--upnp-timeout" title="The “upnp-timeout” property">upnp-timeout</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="NiceAgent.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="NiceAgent.html#NiceAgent-candidate-gathering-done" title="The “candidate-gathering-done” signal">candidate-gathering-done</a></td>
<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobjectgobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="NiceAgent.html#NiceAgent-component-state-changed" title="The “component-state-changed” signal">component-state-changed</a></td>
<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobjectgobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="NiceAgent.html#NiceAgent-initial-binding-request-received" title="The “initial-binding-request-received” signal">initial-binding-request-received</a></td>
<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobjectgobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="NiceAgent.html#NiceAgent-new-candidate" title="The “new-candidate” signal">new-candidate</a></td>
<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobjectgobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="NiceAgent.html#NiceAgent-new-candidate-full" title="The “new-candidate-full” signal">new-candidate-full</a></td>
<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobjectgobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="NiceAgent.html#NiceAgent-new-remote-candidate" title="The “new-remote-candidate” signal">new-remote-candidate</a></td>
<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobjectgobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="NiceAgent.html#NiceAgent-new-remote-candidate-full" title="The “new-remote-candidate-full” signal">new-remote-candidate-full</a></td>
<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobjectgobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="NiceAgent.html#NiceAgent-new-selected-pair" title="The “new-selected-pair” signal">new-selected-pair</a></td>
<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobjectgobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="NiceAgent.html#NiceAgent-new-selected-pair-full" title="The “new-selected-pair-full” signal">new-selected-pair-full</a></td>
<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobjectgobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="NiceAgent.html#NiceAgent-reliable-transport-writable" title="The “reliable-transport-writable” signal">reliable-transport-writable</a></td>
<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobjectgobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="NiceAgent.html#NiceAgent-streams-removed" title="The “streams-removed” signal">streams-removed</a></td>
<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobjectgobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="NiceAgent.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="NiceAgent.html#NiceAgent-struct" title="NiceAgent">NiceAgent</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="NiceAgent.html#NiceComponentState" title="enum NiceComponentState">NiceComponentState</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="NiceAgent.html#NiceComponentType" title="enum NiceComponentType">NiceComponentType</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="NiceAgent.html#NiceProxyType" title="enum NiceProxyType">NiceProxyType</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="NiceAgent.html#NiceCompatibility" title="enum NiceCompatibility">NiceCompatibility</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="NiceAgent.html#NiceInputMessage" title="NiceInputMessage">NiceInputMessage</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="NiceAgent.html#NiceOutputMessage" title="NiceOutputMessage">NiceOutputMessage</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="NiceAgent.html#NICE-AGENT-MAX-REMOTE-CANDIDATES:CAPS" title="NICE_AGENT_MAX_REMOTE_CANDIDATES">NICE_AGENT_MAX_REMOTE_CANDIDATES</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="NiceAgent.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobjectgobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> NiceAgent
</pre>
</div>
<div class="refsect1">
<a name="NiceAgent.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <agent.h>
</pre>
</div>
<div class="refsect1">
<a name="NiceAgent.description"></a><h2>Description</h2>
<p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> is your main object when using libnice.
It is the agent that will take care of everything relating to ICE.
It will take care of discovering your local candidates and do
connectivity checks to create a stream of data between you and your peer.</p>
<p>A <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> must always be used with a <a href="/usr/share/gtk-doc/html/glibglib-The-Main-Event-Loop.html#GMainLoop"><span class="type">GMainLoop</span></a> running the <a href="/usr/share/gtk-doc/html/glibglib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a>
passed into <a class="link" href="NiceAgent.html#nice-agent-new" title="nice_agent_new ()"><code class="function">nice_agent_new()</code></a> (or <a class="link" href="NiceAgent.html#nice-agent-new-reliable" title="nice_agent_new_reliable ()"><code class="function">nice_agent_new_reliable()</code></a>). Without the
<a href="/usr/share/gtk-doc/html/glibglib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> being iterated, the agent’s timers will not fire, etc.</p>
<p>Streams and their components are referenced by integer IDs (with respect to a
given <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a>). These IDs are guaranteed to be positive (i.e. non-zero)
for valid streams/components.</p>
<p>To complete the ICE connectivity checks, the user must either register
an I/O callback (with <a class="link" href="NiceAgent.html#nice-agent-attach-recv" title="nice_agent_attach_recv ()"><code class="function">nice_agent_attach_recv()</code></a>) or call <a class="link" href="NiceAgent.html#nice-agent-recv-messages" title="nice_agent_recv_messages ()"><code class="function">nice_agent_recv_messages()</code></a>
in a loop on a dedicated thread.
Technically, <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> does not poll the streams on its own, since
user data could arrive at any time; to receive STUN packets
required for establishing ICE connectivity, it is backpiggying
on the facility chosen by the user. <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> will handle all STUN
packets internally; they're never actually passed to the I/O callback
or returned from <a class="link" href="NiceAgent.html#nice-agent-recv-messages" title="nice_agent_recv_messages ()"><code class="function">nice_agent_recv_messages()</code></a> and related functions.</p>
<p>Each stream can receive data in one of two ways: using
<a class="link" href="NiceAgent.html#nice-agent-attach-recv" title="nice_agent_attach_recv ()"><code class="function">nice_agent_attach_recv()</code></a> or <a class="link" href="NiceAgent.html#nice-agent-recv-messages" title="nice_agent_recv_messages ()"><code class="function">nice_agent_recv_messages()</code></a> (and the derived
<span class="type">NiceInputStream</span> and <span class="type">NiceIOStream</span> classes accessible using
<a class="link" href="NiceAgent.html#nice-agent-get-io-stream" title="nice_agent_get_io_stream ()"><code class="function">nice_agent_get_io_stream()</code></a>). <a class="link" href="NiceAgent.html#nice-agent-attach-recv" title="nice_agent_attach_recv ()"><code class="function">nice_agent_attach_recv()</code></a> is non-blocking: it
takes a user-provided callback function and attaches the stream’s socket to
the provided <a href="/usr/share/gtk-doc/html/glibglib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a>, invoking the callback in that context for every
packet received. <a class="link" href="NiceAgent.html#nice-agent-recv-messages" title="nice_agent_recv_messages ()"><code class="function">nice_agent_recv_messages()</code></a> instead blocks on receiving a
packet, and writes it directly into a user-provided buffer. This reduces the
number of callback invokations and (potentially) buffer copies required to
receive packets. <a class="link" href="NiceAgent.html#nice-agent-recv-messages" title="nice_agent_recv_messages ()"><code class="function">nice_agent_recv_messages()</code></a> (or <span class="type">NiceInputStream</span>) is designed
to be used in a blocking loop in a separate thread.</p>
<div class="example">
<a name="id-1.2.2.1.10.7"></a><p class="title"><b>Example 1. Simple example on how to use libnice</b></p>
<div class="example-contents">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>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</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="usertype">guint</span><span class="normal"> stream_id</span><span class="symbol">;</span>
<span class="usertype">gchar</span><span class="normal"> buffer</span><span class="symbol">[]</span><span class="normal"> </span><span class="symbol">=</span><span class="normal"> </span><span class="string">"hello world!"</span><span class="symbol">;</span>
<span class="usertype">gchar</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">ufrag </span><span class="symbol">=</span><span class="normal"> <a href="/usr/share/gtk-doc/html/liboilliboil-liboiljunk.html#NULL:CAPS">NULL</a></span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">pwd </span><span class="symbol">=</span><span class="normal"> <a href="/usr/share/gtk-doc/html/liboilliboil-liboiljunk.html#NULL:CAPS">NULL</a></span><span class="symbol">;</span>
<span class="usertype">gchar</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">remote_ufrag</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">remote_pwd</span><span class="symbol">;</span>
<span class="usertype">GSList</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">lcands </span><span class="symbol">=</span><span class="normal"> <a href="/usr/share/gtk-doc/html/liboilliboil-liboiljunk.html#NULL:CAPS">NULL</a></span><span class="symbol">;</span>
<span class="comment">// Create a nice agent, passing in the global default GMainContext.</span>
<span class="usertype">NiceAgent</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">agent </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="NiceAgent.html#nice-agent-new">nice_agent_new</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal"><a href="/usr/share/gtk-doc/html/liboilliboil-liboiljunk.html#NULL:CAPS">NULL</a></span><span class="symbol">,</span><span class="normal"> <a href="NiceAgent.html#NICE-COMPATIBILITY-RFC5245:CAPS">NICE_COMPATIBILITY_RFC5245</a></span><span class="symbol">);</span>
<span class="function">spawn_thread_to_run_main_loop</span><span class="normal"> </span><span class="symbol">(</span><span class="function"><a href="/usr/share/gtk-doc/html/glibglib-The-Main-Event-Loop.html#g-main-loop-new">g_main_loop_new</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal"><a href="/usr/share/gtk-doc/html/liboilliboil-liboiljunk.html#NULL:CAPS">NULL</a></span><span class="symbol">,</span><span class="normal"> <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#FALSE:CAPS">FALSE</a></span><span class="symbol">));</span>
<span class="comment">// Connect the signals</span>
<span class="function"><a href="/usr/share/gtk-doc/html/gobjectgobject-Signals.html#g-signal-connect">g_signal_connect</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function"><a href="/usr/share/gtk-doc/html/gobjectgobject-The-Base-Object-Type.html#G-OBJECT:CAPS">G_OBJECT</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">agent</span><span class="symbol">),</span><span class="normal"> </span><span class="string">"candidate-gathering-done"</span><span class="symbol">,</span>
<span class="normal"> </span><span class="function"><a href="/usr/share/gtk-doc/html/gobjectgobject-Closures.html#G-CALLBACK:CAPS">G_CALLBACK</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">cb_candidate_gathering_done</span><span class="symbol">),</span><span class="normal"> <a href="/usr/share/gtk-doc/html/liboilliboil-liboiljunk.html#NULL:CAPS">NULL</a></span><span class="symbol">);</span>
<span class="function"><a href="/usr/share/gtk-doc/html/gobjectgobject-Signals.html#g-signal-connect">g_signal_connect</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function"><a href="/usr/share/gtk-doc/html/gobjectgobject-The-Base-Object-Type.html#G-OBJECT:CAPS">G_OBJECT</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">agent</span><span class="symbol">),</span><span class="normal"> </span><span class="string">"component-state-changed"</span><span class="symbol">,</span>
<span class="normal"> </span><span class="function"><a href="/usr/share/gtk-doc/html/gobjectgobject-Closures.html#G-CALLBACK:CAPS">G_CALLBACK</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">cb_component_state_changed</span><span class="symbol">),</span><span class="normal"> <a href="/usr/share/gtk-doc/html/liboilliboil-liboiljunk.html#NULL:CAPS">NULL</a></span><span class="symbol">);</span>
<span class="function"><a href="/usr/share/gtk-doc/html/gobjectgobject-Signals.html#g-signal-connect">g_signal_connect</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function"><a href="/usr/share/gtk-doc/html/gobjectgobject-The-Base-Object-Type.html#G-OBJECT:CAPS">G_OBJECT</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">agent</span><span class="symbol">),</span><span class="normal"> </span><span class="string">"new-selected-pair"</span><span class="symbol">,</span>
<span class="normal"> </span><span class="function"><a href="/usr/share/gtk-doc/html/gobjectgobject-Closures.html#G-CALLBACK:CAPS">G_CALLBACK</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">cb_new_selected_pair</span><span class="symbol">),</span><span class="normal"> <a href="/usr/share/gtk-doc/html/liboilliboil-liboiljunk.html#NULL:CAPS">NULL</a></span><span class="symbol">);</span>
<span class="comment">// Create a new stream with one component and start gathering candidates</span>
<span class="normal">stream_id </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="NiceAgent.html#nice-agent-add-stream">nice_agent_add_stream</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">agent</span><span class="symbol">,</span><span class="normal"> </span><span class="number">1</span><span class="symbol">);</span>
<span class="function"><a href="NiceAgent.html#nice-agent-gather-candidates">nice_agent_gather_candidates</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">agent</span><span class="symbol">,</span><span class="normal"> stream_id</span><span class="symbol">);</span>
<span class="comment">// Attach I/O callback the component to ensure that:</span>
<span class="comment">// 1) agent gets its STUN packets (not delivered to cb_nice_recv)</span>
<span class="comment">// 2) you get your own data</span>
<span class="function"><a href="NiceAgent.html#nice-agent-attach-recv">nice_agent_attach_recv</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">agent</span><span class="symbol">,</span><span class="normal"> stream_id</span><span class="symbol">,</span><span class="normal"> </span><span class="number">1</span><span class="symbol">,</span><span class="normal"> <a href="/usr/share/gtk-doc/html/liboilliboil-liboiljunk.html#NULL:CAPS">NULL</a></span><span class="symbol">,</span>
<span class="normal"> cb_nice_recv</span><span class="symbol">,</span><span class="normal"> <a href="/usr/share/gtk-doc/html/liboilliboil-liboiljunk.html#NULL:CAPS">NULL</a></span><span class="symbol">);</span>
<span class="comment">// ... Wait until the signal candidate-gathering-done is fired ...</span>
<span class="normal">lcands </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="NiceAgent.html#nice-agent-get-local-candidates">nice_agent_get_local_candidates</a></span><span class="symbol">(</span><span class="normal">agent</span><span class="symbol">,</span><span class="normal"> stream_id</span><span class="symbol">,</span><span class="normal"> </span><span class="number">1</span><span class="symbol">);</span>
<span class="function"><a href="NiceAgent.html#nice-agent-get-local-credentials">nice_agent_get_local_credentials</a></span><span class="symbol">(</span><span class="normal">agent</span><span class="symbol">,</span><span class="normal"> stream_id</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">&</span><span class="normal">ufrag</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">&</span><span class="normal">pwd</span><span class="symbol">);</span>
<span class="comment">// ... Send local candidates and credentials to the peer</span>
<span class="comment">// Set the peer's remote credentials and remote candidates</span>
<span class="function"><a href="NiceAgent.html#nice-agent-set-remote-credentials">nice_agent_set_remote_credentials</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">agent</span><span class="symbol">,</span><span class="normal"> stream_id</span><span class="symbol">,</span><span class="normal"> remote_ufrag</span><span class="symbol">,</span><span class="normal"> remote_pwd</span><span class="symbol">);</span>
<span class="function"><a href="NiceAgent.html#nice-agent-set-remote-candidates">nice_agent_set_remote_candidates</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">agent</span><span class="symbol">,</span><span class="normal"> stream_id</span><span class="symbol">,</span><span class="normal"> </span><span class="number">1</span><span class="symbol">,</span><span class="normal"> rcands</span><span class="symbol">);</span>
<span class="comment">// ... Wait until the signal new-selected-pair is fired ...</span>
<span class="comment">// Send our message!</span>
<span class="function"><a href="NiceAgent.html#nice-agent-send">nice_agent_send</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">agent</span><span class="symbol">,</span><span class="normal"> stream_id</span><span class="symbol">,</span><span class="normal"> </span><span class="number">1</span><span class="symbol">,</span><span class="normal"> </span><span class="keyword">sizeof</span><span class="symbol">(</span><span class="normal">buffer</span><span class="symbol">),</span><span class="normal"> buffer</span><span class="symbol">);</span>
<span class="comment">// Anything received will be received through the cb_nice_recv callback.</span>
<span class="comment">// You must be running a GMainLoop on the global default GMainContext in</span>
<span class="comment">// another thread for this to work.</span>
<span class="comment">// Destroy the object</span>
<span class="function"><a href="/usr/share/gtk-doc/html/gobjectgobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="symbol">(</span><span class="normal">agent</span><span class="symbol">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
</div>
<br class="example-break"><p>Refer to the examples in the examples/ subdirectory of the libnice source for
more complete examples.</p>
</div>
<div class="refsect1">
<a name="NiceAgent.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="NiceAgentRecvFunc"></a><h3>NiceAgentRecvFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*NiceAgentRecvFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> stream_id</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> component_id</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> len</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *buf</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>Callback function when data is received on a component</p>
<div class="refsect3">
<a name="NiceAgentRecvFunc.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> Object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_id</p></td>
<td class="parameter_description"><p>The id of the stream</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>component_id</p></td>
<td class="parameter_description"><p>The id of the component of the stream
which received the data</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>len</p></td>
<td class="parameter_description"><p>The length of the data</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>buf</p></td>
<td class="parameter_description"><p>The buffer containing the data received</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>The user data set in <a class="link" href="NiceAgent.html#nice-agent-attach-recv" title="nice_agent_attach_recv ()"><code class="function">nice_agent_attach_recv()</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="nice-agent-new"></a><h3>nice_agent_new ()</h3>
<pre class="programlisting"><a class="link" href="NiceAgent.html" title="NiceAgent"><span class="returnvalue">NiceAgent</span></a> *
nice_agent_new (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> *ctx</code></em>,
<em class="parameter"><code><a class="link" href="NiceAgent.html#NiceCompatibility" title="enum NiceCompatibility"><span class="type">NiceCompatibility</span></a> compat</code></em>);</pre>
<p>Create a new <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a>.
The returned object must be freed with <a href="/usr/share/gtk-doc/html/gobjectgobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a></p>
<div class="refsect3">
<a name="nice-agent-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>ctx</p></td>
<td class="parameter_description"><p>The Glib Mainloop Context to use for timers</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>compat</p></td>
<td class="parameter_description"><p>The compatibility mode of the agent</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nice-agent-new.returns"></a><h4>Returns</h4>
<p> The new agent GObject</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="nice-agent-new-reliable"></a><h3>nice_agent_new_reliable ()</h3>
<pre class="programlisting"><a class="link" href="NiceAgent.html" title="NiceAgent"><span class="returnvalue">NiceAgent</span></a> *
nice_agent_new_reliable (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> *ctx</code></em>,
<em class="parameter"><code><a class="link" href="NiceAgent.html#NiceCompatibility" title="enum NiceCompatibility"><span class="type">NiceCompatibility</span></a> compat</code></em>);</pre>
<p>Create a new <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> in reliable mode. If the connectivity is established
through ICE-UDP, then a <a class="link" href="libnice-Pseudo-TCP-Socket.html#PseudoTcpSocket"><span class="type">PseudoTcpSocket</span></a> will be transparently used to
ensure reliability of the messages.
The returned object must be freed with <a href="/usr/share/gtk-doc/html/gobjectgobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a></p>
<p> See also: <a class="link" href="NiceAgent.html#NiceAgent-reliable-transport-writable" title="The “reliable-transport-writable” signal"><span class="type">“reliable-transport-writable”</span></a> </p>
<div class="refsect3">
<a name="nice-agent-new-reliable.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>ctx</p></td>
<td class="parameter_description"><p>The Glib Mainloop Context to use for timers</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>compat</p></td>
<td class="parameter_description"><p>The compatibility mode of the agent</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nice-agent-new-reliable.returns"></a><h4>Returns</h4>
<p> The new agent GObject</p>
</div>
<p class="since">Since: <a class="link" href="ix08.html#api-index-0.0.11">0.0.11</a></p>
</div>
<hr>
<div class="refsect2">
<a name="nice-agent-add-local-address"></a><h3>nice_agent_add_local_address ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
nice_agent_add_local_address (<em class="parameter"><code><a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent</code></em>,
<em class="parameter"><code><a class="link" href="libnice-NiceAddress.html#NiceAddress" title="NiceAddress"><span class="type">NiceAddress</span></a> *addr</code></em>);</pre>
<p>Add a local address from which to derive local host candidates for
candidate gathering.</p>
<p>
Since 0.0.5, if this method is not called, libnice will automatically
discover the local addresses available
</p>
<p>See also: <a class="link" href="NiceAgent.html#nice-agent-gather-candidates" title="nice_agent_gather_candidates ()"><code class="function">nice_agent_gather_candidates()</code></a></p>
<div class="refsect3">
<a name="nice-agent-add-local-address.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> Object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>addr</p></td>
<td class="parameter_description"><p>The address to listen to
If the port is 0, then a random port will be chosen by the system</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nice-agent-add-local-address.returns"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on fatal (memory allocation) errors</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="nice-agent-set-port-range"></a><h3>nice_agent_set_port_range ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
nice_agent_set_port_range (<em class="parameter"><code><a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> stream_id</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> component_id</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> min_port</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> max_port</code></em>);</pre>
<p>Sets a preferred port range for allocating host candidates.</p>
<p>
If a local host candidate cannot be created on that port
range, then the <a class="link" href="NiceAgent.html#nice-agent-gather-candidates" title="nice_agent_gather_candidates ()"><code class="function">nice_agent_gather_candidates()</code></a> call will fail.
</p>
<p>
This MUST be called before <a class="link" href="NiceAgent.html#nice-agent-gather-candidates" title="nice_agent_gather_candidates ()"><code class="function">nice_agent_gather_candidates()</code></a>
</p>
<div class="refsect3">
<a name="nice-agent-set-port-range.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> Object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_id</p></td>
<td class="parameter_description"><p>The ID of the stream</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>component_id</p></td>
<td class="parameter_description"><p>The ID of the component</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>min_port</p></td>
<td class="parameter_description"><p>The minimum port to use</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>max_port</p></td>
<td class="parameter_description"><p>The maximum port to use</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="nice-agent-add-stream"></a><h3>nice_agent_add_stream ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
nice_agent_add_stream (<em class="parameter"><code><a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> n_components</code></em>);</pre>
<p>Adds a data stream to <em class="parameter"><code>agent</code></em>
containing <em class="parameter"><code>n_components</code></em>
components. The
returned stream ID is guaranteed to be positive on success.</p>
<div class="refsect3">
<a name="nice-agent-add-stream.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> Object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n_components</p></td>
<td class="parameter_description"><p>The number of components to add to the stream</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nice-agent-add-stream.returns"></a><h4>Returns</h4>
<p> The ID of the new stream, 0 on failure</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="nice-agent-remove-stream"></a><h3>nice_agent_remove_stream ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
nice_agent_remove_stream (<em class="parameter"><code><a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> stream_id</code></em>);</pre>
<p>Remove and free a previously created data stream from <em class="parameter"><code>agent</code></em>
. If any I/O
streams have been created using <a class="link" href="NiceAgent.html#nice-agent-get-io-stream" title="nice_agent_get_io_stream ()"><code class="function">nice_agent_get_io_stream()</code></a>, they should be
closed completely using <a href="/usr/share/gtk-doc/html/gioGIOStream.html#g-io-stream-close"><code class="function">g_io_stream_close()</code></a> before this is called, or they
will get broken pipe errors.</p>
<div class="refsect3">
<a name="nice-agent-remove-stream.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> Object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_id</p></td>
<td class="parameter_description"><p>The ID of the stream to remove</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="nice-agent-set-relay-info"></a><h3>nice_agent_set_relay_info ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
nice_agent_set_relay_info (<em class="parameter"><code><a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> stream_id</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> component_id</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *server_ip</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> server_port</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *username</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *password</code></em>,
<em class="parameter"><code><a class="link" href="NiceCandidate.html#NiceRelayType" title="enum NiceRelayType"><span class="type">NiceRelayType</span></a> type</code></em>);</pre>
<p>Sets the settings for using a relay server during the candidate discovery.
This may be called multiple times to add multiple relay servers to the
discovery process; one TCP and one UDP, for example.</p>
<div class="refsect3">
<a name="nice-agent-set-relay-info.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> Object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_id</p></td>
<td class="parameter_description"><p>The ID of the stream</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>component_id</p></td>
<td class="parameter_description"><p>The ID of the component</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>server_ip</p></td>
<td class="parameter_description"><p>The IP address of the TURN server</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>server_port</p></td>
<td class="parameter_description"><p>The port of the TURN server</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>username</p></td>
<td class="parameter_description"><p>The TURN username to use for the allocate</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>password</p></td>
<td class="parameter_description"><p>The TURN password to use for the allocate</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>type</p></td>
<td class="parameter_description"><p>The type of relay to use</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nice-agent-set-relay-info.returns"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the TURN settings were accepted.
<a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the address was invalid.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="nice-agent-forget-relays"></a><h3>nice_agent_forget_relays ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
nice_agent_forget_relays (<em class="parameter"><code><a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> stream_id</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> component_id</code></em>);</pre>
<p>Forget all the relay servers previously added using
<a class="link" href="NiceAgent.html#nice-agent-set-relay-info" title="nice_agent_set_relay_info ()"><code class="function">nice_agent_set_relay_info()</code></a>. Currently connected streams will keep
using the relay as long as they have not been restarted and haven't
succesfully negotiated a different path.</p>
<div class="refsect3">
<a name="nice-agent-forget-relays.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> Object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_id</p></td>
<td class="parameter_description"><p>The ID of the stream</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>component_id</p></td>
<td class="parameter_description"><p>The ID of the component</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nice-agent-forget-relays.returns"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the component could not be found, <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> otherwise</p>
</div>
<p class="since">Since: <a class="link" href="ix11.html#api-index-0.1.6">0.1.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="nice-agent-gather-candidates"></a><h3>nice_agent_gather_candidates ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
nice_agent_gather_candidates (<em class="parameter"><code><a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> stream_id</code></em>);</pre>
<p>Allocate and start listening on local candidate ports and start the remote
candidate gathering process.
Once done, <a class="link" href="NiceAgent.html#NiceAgent-candidate-gathering-done" title="The “candidate-gathering-done” signal"><span class="type">“candidate-gathering-done”</span></a> is called for the stream.
As soon as this function is called, <a class="link" href="NiceAgent.html#NiceAgent-new-candidate" title="The “new-candidate” signal"><span class="type">“new-candidate”</span></a> signals may be
emitted, even before this function returns.</p>
<p>nice_agent_get_local_candidates() will only return non-empty results after
calling this function.</p>
<p>See also: <a class="link" href="NiceAgent.html#nice-agent-add-local-address" title="nice_agent_add_local_address ()"><code class="function">nice_agent_add_local_address()</code></a></p>
<p>See also: <a class="link" href="NiceAgent.html#nice-agent-set-port-range" title="nice_agent_set_port_range ()"><code class="function">nice_agent_set_port_range()</code></a></p>
<div class="refsect3">
<a name="nice-agent-gather-candidates.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_id</p></td>
<td class="parameter_description"><p>The ID of the stream to start</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nice-agent-gather-candidates.returns"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the stream ID is invalid or if a host candidate couldn't
be allocated on the requested interfaces/ports; <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> otherwise</p>
<div class="note">
<p>
Local addresses can be previously set with <a class="link" href="NiceAgent.html#nice-agent-add-local-address" title="nice_agent_add_local_address ()"><code class="function">nice_agent_add_local_address()</code></a>
</p>
<p>
Since 0.0.5, If no local address was previously added, then the nice agent
will automatically detect the local address using
<a class="link" href="libnice-Network-interfaces-discovery.html#nice-interfaces-get-local-ips" title="nice_interfaces_get_local_ips ()"><code class="function">nice_interfaces_get_local_ips()</code></a>
</p>
</div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="nice-agent-set-remote-credentials"></a><h3>nice_agent_set_remote_credentials ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
nice_agent_set_remote_credentials (<em class="parameter"><code><a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> stream_id</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *ufrag</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *pwd</code></em>);</pre>
<p>Sets the remote credentials for stream <em class="parameter"><code>stream_id</code></em>
.</p>
<div class="note">
<p>
Stream credentials do not override per-candidate credentials if set
</p>
<p>
Due to the native of peer-reflexive candidates, any agent using a per-stream
credentials (RFC5245, WLM2009, OC2007R2 and DRAFT19) instead of
per-candidate credentials (GOOGLE, MSN, OC2007), must
use the <a class="link" href="NiceAgent.html#nice-agent-set-remote-credentials" title="nice_agent_set_remote_credentials ()"><code class="function">nice_agent_set_remote_credentials()</code></a> API instead of setting the
username and password on the candidates.
</p>
</div>
<div class="refsect3">
<a name="nice-agent-set-remote-credentials.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> Object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_id</p></td>
<td class="parameter_description"><p>The ID of the stream</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>ufrag</p></td>
<td class="parameter_description"><p>nul-terminated string containing an ICE username fragment
(length must be between 22 and 256 chars)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>pwd</p></td>
<td class="parameter_description"><p>nul-terminated string containing an ICE password
(length must be between 4 and 256 chars)</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nice-agent-set-remote-credentials.returns"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="nice-agent-get-local-credentials"></a><h3>nice_agent_get_local_credentials ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
nice_agent_get_local_credentials (<em class="parameter"><code><a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> stream_id</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **ufrag</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **pwd</code></em>);</pre>
<p>Gets the local credentials for stream <em class="parameter"><code>stream_id</code></em>
. This may be called any time
after creating a stream using <a class="link" href="NiceAgent.html#nice-agent-add-stream" title="nice_agent_add_stream ()"><code class="function">nice_agent_add_stream()</code></a>.</p>
<p>An error will be returned if this is called for a non-existent stream, or if
either of <em class="parameter"><code>ufrag</code></em>
or <em class="parameter"><code>pwd</code></em>
are <a href="/usr/share/gtk-doc/html/liboilliboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
<div class="refsect3">
<a name="nice-agent-get-local-credentials.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> Object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_id</p></td>
<td class="parameter_description"><p>The ID of the stream</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>ufrag</p></td>
<td class="parameter_description"><p> return location for a nul-terminated string
containing an ICE username fragment; must be freed with <a href="/usr/share/gtk-doc/html/glibglib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out callee-allocates</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>pwd</p></td>
<td class="parameter_description"><p> return location for a nul-terminated string
containing an ICE password; must be freed with <a href="/usr/share/gtk-doc/html/glibglib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out callee-allocates</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nice-agent-get-local-credentials.returns"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="nice-agent-set-local-credentials"></a><h3>nice_agent_set_local_credentials ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
nice_agent_set_local_credentials (<em class="parameter"><code><a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> stream_id</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *ufrag</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *pwd</code></em>);</pre>
<p>Sets the local credentials for stream <em class="parameter"><code>stream_id</code></em>
.</p>
<div class="note"><p>
This is only effective before ICE negotiation has started.
</p></div>
<p>Since 0.1.11</p>
<div class="refsect3">
<a name="nice-agent-set-local-credentials.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> Object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_id</p></td>
<td class="parameter_description"><p>The ID of the stream</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>ufrag</p></td>
<td class="parameter_description"><p>nul-terminated string containing an ICE username fragment
(length must be between 22 and 256 chars)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>pwd</p></td>
<td class="parameter_description"><p>nul-terminated string containing an ICE password
(length must be between 4 and 256 chars)</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nice-agent-set-local-credentials.returns"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="nice-agent-set-remote-candidates"></a><h3>nice_agent_set_remote_candidates ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
nice_agent_set_remote_candidates (<em class="parameter"><code><a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> stream_id</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> component_id</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glibglib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *candidates</code></em>);</pre>
<p>Sets, adds or updates the remote candidates for a component of a stream.</p>
<div class="note">
<p>
NICE_AGENT_MAX_REMOTE_CANDIDATES is the absolute maximum limit
for remote candidates.
</p>
<p>
You must first call <a class="link" href="NiceAgent.html#nice-agent-gather-candidates" title="nice_agent_gather_candidates ()"><code class="function">nice_agent_gather_candidates()</code></a> and wait for the
<a class="link" href="NiceAgent.html#NiceAgent-candidate-gathering-done" title="The “candidate-gathering-done” signal"><span class="type">“candidate-gathering-done”</span></a> signale before
calling <a class="link" href="NiceAgent.html#nice-agent-set-remote-candidates" title="nice_agent_set_remote_candidates ()"><code class="function">nice_agent_set_remote_candidates()</code></a>
</p>
<p>
Since 0.1.3, there is no need to wait for the candidate-gathering-done signal.
Remote candidates can be set even while gathering local candidates.
Newly discovered local candidates will automatically be paired with
existing remote candidates.
</p>
</div>
<div class="refsect3">
<a name="nice-agent-set-remote-candidates.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> Object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_id</p></td>
<td class="parameter_description"><p>The ID of the stream the candidates are for</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>component_id</p></td>
<td class="parameter_description"><p>The ID of the component the candidates are for</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>candidates</p></td>
<td class="parameter_description"><p> a <a href="/usr/share/gtk-doc/html/glibglib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> of
<a class="link" href="NiceCandidate.html" title="NiceCandidate"><span class="type">NiceCandidate</span></a> items describing each candidate to add. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> NiceCandidate][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nice-agent-set-remote-candidates.returns"></a><h4>Returns</h4>
<p> The number of candidates added, negative on errors (memory
allocation error or invalid component)</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="nice-agent-get-remote-candidates"></a><h3>nice_agent_get_remote_candidates ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *
nice_agent_get_remote_candidates (<em class="parameter"><code><a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> stream_id</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> component_id</code></em>);</pre>
<p>Get a list of the remote candidates set on a stream's component</p>
<div class="note">
<p>
The caller owns the returned GSList as well as the candidates contained
within it.
</p>
<p>
The list of remote candidates can change during processing.
The client should register for the <a class="link" href="NiceAgent.html#NiceAgent-new-remote-candidate" title="The “new-remote-candidate” signal"><span class="type">“new-remote-candidate”</span></a> signal
to get notified of new remote candidates.
</p>
</div>
<div class="refsect3">
<a name="nice-agent-get-remote-candidates.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> Object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_id</p></td>
<td class="parameter_description"><p>The ID of the stream</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>component_id</p></td>
<td class="parameter_description"><p>The ID of the component</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nice-agent-get-remote-candidates.returns"></a><h4>Returns</h4>
<p> a <a href="/usr/share/gtk-doc/html/glibglib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> of
<a href="NiceCandidate.html#NiceCandidate-struct"><span class="type">NiceCandidates</span></a> objects representing the remote candidates set on the <em class="parameter"><code>agent</code></em>
. </p>
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> NiceCandidate][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="nice-agent-get-local-candidates"></a><h3>nice_agent_get_local_candidates ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *
nice_agent_get_local_candidates (<em class="parameter"><code><a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> stream_id</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> component_id</code></em>);</pre>
<p>Retrieve from the agent the list of all local candidates
for a stream's component</p>
<div class="note"><p>
The caller owns the returned GSList as well as the candidates contained
within it.
To get full results, the client should wait for the
<a class="link" href="NiceAgent.html#NiceAgent-candidate-gathering-done" title="The “candidate-gathering-done” signal"><span class="type">“candidate-gathering-done”</span></a> signal.
</p></div>
<div class="refsect3">
<a name="nice-agent-get-local-candidates.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> Object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_id</p></td>
<td class="parameter_description"><p>The ID of the stream</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>component_id</p></td>
<td class="parameter_description"><p>The ID of the component</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nice-agent-get-local-candidates.returns"></a><h4>Returns</h4>
<p> a <a href="/usr/share/gtk-doc/html/glibglib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> of
<a class="link" href="NiceCandidate.html" title="NiceCandidate"><span class="type">NiceCandidate</span></a> objects representing the local candidates of <em class="parameter"><code>agent</code></em>
. </p>
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> NiceCandidate][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="nice-agent-get-selected-pair"></a><h3>nice_agent_get_selected_pair ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
nice_agent_get_selected_pair (<em class="parameter"><code><a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> stream_id</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> component_id</code></em>,
<em class="parameter"><code><a class="link" href="NiceCandidate.html" title="NiceCandidate"><span class="type">NiceCandidate</span></a> **local</code></em>,
<em class="parameter"><code><a class="link" href="NiceCandidate.html" title="NiceCandidate"><span class="type">NiceCandidate</span></a> **remote</code></em>);</pre>
<p>Retreive the selected candidate pair for media transmission
for a given stream's component.</p>
<div class="refsect3">
<a name="nice-agent-get-selected-pair.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> Object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_id</p></td>
<td class="parameter_description"><p>The ID of the stream</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>component_id</p></td>
<td class="parameter_description"><p>The ID of the component</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>local</p></td>
<td class="parameter_description"><p>The local selected candidate</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>remote</p></td>
<td class="parameter_description"><p>The remote selected candidate</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nice-agent-get-selected-pair.returns"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if there is no selected candidate pair</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="nice-agent-send"></a><h3>nice_agent_send ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
nice_agent_send (<em class="parameter"><code><a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> stream_id</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> component_id</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> len</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *buf</code></em>);</pre>
<p>Sends a data payload over a stream's component.</p>
<div class="note">
<p>
Component state MUST be NICE_COMPONENT_STATE_READY, or as a special case,
in any state if component was in READY state before and was then restarted
</p>
<p>
In reliable mode, the -1 error value means either that you are not yet
connected or that the send buffer is full (equivalent to EWOULDBLOCK).
In both cases, you simply need to wait for the
<a class="link" href="NiceAgent.html#NiceAgent-reliable-transport-writable" title="The “reliable-transport-writable” signal"><span class="type">“reliable-transport-writable”</span></a> signal to be fired before resending
the data.
</p>
<p>
In non-reliable mode, it will virtually never happen with UDP sockets, but
it might happen if the active candidate is a TURN-TCP connection that got
disconnected.
</p>
<p>
In both reliable and non-reliable mode, a -1 error code could also mean that
the stream_id and/or component_id are invalid.
</p>
</div>
<div class="refsect3">
<a name="nice-agent-send.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> Object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_id</p></td>
<td class="parameter_description"><p>The ID of the stream to send to</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>component_id</p></td>
<td class="parameter_description"><p>The ID of the component to send to</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>len</p></td>
<td class="parameter_description"><p>The length of the buffer to send</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>buf</p></td>
<td class="parameter_description"><p>The buffer of data to send</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nice-agent-send.returns"></a><h4>Returns</h4>
<p> The number of bytes sent, or negative error code</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="nice-agent-send-messages-nonblocking"></a><h3>nice_agent_send_messages_nonblocking ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
nice_agent_send_messages_nonblocking (<em class="parameter"><code><a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> stream_id</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> component_id</code></em>,
<em class="parameter"><code>const <a class="link" href="NiceAgent.html#NiceOutputMessage" title="NiceOutputMessage"><span class="type">NiceOutputMessage</span></a> *messages</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> n_messages</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gioGCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Sends multiple messages on the socket identified by the given
stream/component pair. Transmission is non-blocking, so a
<a href="/usr/share/gtk-doc/html/giogio-GIOError.html#G-IO-ERROR-WOULD-BLOCK:CAPS"><code class="literal">G_IO_ERROR_WOULD_BLOCK</code></a> error may be returned if the send buffer is full.</p>
<p>As with <a class="link" href="NiceAgent.html#nice-agent-send" title="nice_agent_send ()"><code class="function">nice_agent_send()</code></a>, the given component must be in
<a class="link" href="NiceAgent.html#NICE-COMPONENT-STATE-READY:CAPS"><code class="literal">NICE_COMPONENT_STATE_READY</code></a> or, as a special case, in any state if it was
previously ready and was then restarted.</p>
<p>On success, the number of messages written to the socket will be returned,
which may be less than <em class="parameter"><code>n_messages</code></em>
if transmission would have blocked
part-way through. Zero will be returned if <em class="parameter"><code>n_messages</code></em>
is zero, or if
transmission would have blocked on the first message.</p>
<p>In reliable mode, it is instead recommended to use
<a class="link" href="NiceAgent.html#nice-agent-send" title="nice_agent_send ()"><code class="function">nice_agent_send()</code></a>. The return value can be less than <em class="parameter"><code>n_messages</code></em>
or 0 even if it is still possible to send a partial message. In
this case, "nice-agent-writable" will never be triggered, so the
application would have to use <code class="function">nice_agent_sent()</code> to fill the buffer or have
to retry sending at a later point.</p>
<p>On failure, -1 will be returned and <em class="parameter"><code>error</code></em>
will be set. If the <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> is
reliable and the socket is not yet connected, <a href="/usr/share/gtk-doc/html/giogio-GIOError.html#G-IO-ERROR-BROKEN-PIPE:CAPS"><code class="literal">G_IO_ERROR_BROKEN_PIPE</code></a> will be
returned; if the write buffer is full, <a href="/usr/share/gtk-doc/html/giogio-GIOError.html#G-IO-ERROR-WOULD-BLOCK:CAPS"><code class="literal">G_IO_ERROR_WOULD_BLOCK</code></a> will be
returned. In both cases, wait for the <a class="link" href="NiceAgent.html#NiceAgent-reliable-transport-writable" title="The “reliable-transport-writable” signal"><span class="type">“reliable-transport-writable”</span></a>
signal before trying again. If the given <em class="parameter"><code>stream_id</code></em>
or <em class="parameter"><code>component_id</code></em>
are
invalid or not yet connected, <a href="/usr/share/gtk-doc/html/giogio-GIOError.html#G-IO-ERROR-BROKEN-PIPE:CAPS"><code class="literal">G_IO_ERROR_BROKEN_PIPE</code></a> will be returned.
<a href="/usr/share/gtk-doc/html/giogio-GIOError.html#G-IO-ERROR-FAILED:CAPS"><code class="literal">G_IO_ERROR_FAILED</code></a> will be returned for other errors.</p>
<div class="refsect3">
<a name="nice-agent-send-messages-nonblocking.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>a <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_id</p></td>
<td class="parameter_description"><p>the ID of the stream to send to</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>component_id</p></td>
<td class="parameter_description"><p>the ID of the component to send to</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>messages</p></td>
<td class="parameter_description"><p> array of messages to send, of at least
<em class="parameter"><code>n_messages</code></em>
entries in length. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_messages]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>n_messages</p></td>
<td class="parameter_description"><p>number of entries in <em class="parameter"><code>messages</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p> a <a href="/usr/share/gtk-doc/html/gioGCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> to cancel the operation from
another thread, or <a href="/usr/share/gtk-doc/html/liboilliboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p> return location for a <a href="/usr/share/gtk-doc/html/glibglib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/liboilliboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nice-agent-send-messages-nonblocking.returns"></a><h4>Returns</h4>
<p> the number of messages sent (may be zero), or -1 on error</p>
</div>
<p class="since">Since: <a class="link" href="ix10.html#api-index-0.1.5">0.1.5</a></p>
</div>
<hr>
<div class="refsect2">
<a name="nice-agent-recv"></a><h3>nice_agent_recv ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gssize"><span class="returnvalue">gssize</span></a>
nice_agent_recv (<em class="parameter"><code><a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> stream_id</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> component_id</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint8"><span class="type">guint8</span></a> *buf</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gsize"><span class="type">gsize</span></a> buf_len</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gioGCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>A single-message version of <a class="link" href="NiceAgent.html#nice-agent-recv-messages" title="nice_agent_recv_messages ()"><code class="function">nice_agent_recv_messages()</code></a>.</p>
<div class="refsect3">
<a name="nice-agent-recv.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>a <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_id</p></td>
<td class="parameter_description"><p>the ID of the stream to receive on</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>component_id</p></td>
<td class="parameter_description"><p>the ID of the component to receive on</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>buf</p></td>
<td class="parameter_description"><p> caller-allocated buffer
to write the received data into, of length at least <em class="parameter"><code>buf_len</code></em>
. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=buf_len][<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out caller-allocates</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>buf_len</p></td>
<td class="parameter_description"><p>length of <em class="parameter"><code>buf</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p> a <a href="/usr/share/gtk-doc/html/gioGCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> to allow the operation to be
cancelled from another thread, or <a href="/usr/share/gtk-doc/html/liboilliboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p> return location for a <a href="/usr/share/gtk-doc/html/glibglib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/liboilliboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nice-agent-recv.returns"></a><h4>Returns</h4>
<p> the number of bytes written to <em class="parameter"><code>buf</code></em>
on success (guaranteed to be
greater than 0 unless <em class="parameter"><code>buf_len</code></em>
is 0), 0 if in reliable mode and the remote
peer closed the stream, or -1 on error</p>
</div>
<p class="since">Since: <a class="link" href="ix10.html#api-index-0.1.5">0.1.5</a></p>
</div>
<hr>
<div class="refsect2">
<a name="nice-agent-recv-messages"></a><h3>nice_agent_recv_messages ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
nice_agent_recv_messages (<em class="parameter"><code><a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> stream_id</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> component_id</code></em>,
<em class="parameter"><code><a class="link" href="NiceAgent.html#NiceInputMessage" title="NiceInputMessage"><span class="type">NiceInputMessage</span></a> *messages</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> n_messages</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gioGCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Block on receiving data from the given stream/component combination on
<em class="parameter"><code>agent</code></em>
, returning only once exactly <em class="parameter"><code>n_messages</code></em>
messages have been received
and written into <em class="parameter"><code>messages</code></em>
, the stream is closed by the other end or by
calling <a class="link" href="NiceAgent.html#nice-agent-remove-stream" title="nice_agent_remove_stream ()"><code class="function">nice_agent_remove_stream()</code></a>, or <em class="parameter"><code>cancellable</code></em>
is cancelled.</p>
<p>Any STUN packets received will not be added to <em class="parameter"><code>messages</code></em>
; instead,
they'll be passed for processing to <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> itself. Since <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a>
does not poll for messages on its own, it's therefore essential to keep
calling this function for ICE connection establishment to work.</p>
<p>In the non-error case, in reliable mode, this will block until all buffers in
all <em class="parameter"><code>n_messages</code></em>
have been filled with received data (i.e. <em class="parameter"><code>messages</code></em>
is
treated as a large, flat array of buffers). In non-reliable mode, it will
block until <em class="parameter"><code>n_messages</code></em>
messages have been received, each of which does not
have to fill all the buffers in its <a class="link" href="NiceAgent.html#NiceInputMessage" title="NiceInputMessage"><span class="type">NiceInputMessage</span></a>. In the non-reliable
case, each <a class="link" href="NiceAgent.html#NiceInputMessage" title="NiceInputMessage"><span class="type">NiceInputMessage</span></a> must have enough buffers to contain an entire
message (65536 bytes), or any excess data may be silently dropped.</p>
<p>For each received message, <span class="type">“length”</span> will be set to the
number of valid bytes stored in the message’s buffers. The bytes are stored
sequentially in the buffers; there are no gaps apart from at the end of the
buffer array (in non-reliable mode). If non-<a href="/usr/share/gtk-doc/html/liboilliboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> on input,
<span class="type">“from”</span> will have the address of the sending peer stored in
it. The base addresses, sizes, and number of buffers in each message will not
be modified in any case.</p>
<p>This must not be used in combination with <a class="link" href="NiceAgent.html#nice-agent-attach-recv" title="nice_agent_attach_recv ()"><code class="function">nice_agent_attach_recv()</code></a> on the
same stream/component pair.</p>
<p>If the stream/component pair doesn’t exist, or if a suitable candidate socket
hasn’t yet been selected for it, a <a href="/usr/share/gtk-doc/html/giogio-GIOError.html#G-IO-ERROR-BROKEN-PIPE:CAPS"><code class="literal">G_IO_ERROR_BROKEN_PIPE</code></a> error will be
returned. A <a href="/usr/share/gtk-doc/html/giogio-GIOError.html#G-IO-ERROR-CANCELLED:CAPS"><code class="literal">G_IO_ERROR_CANCELLED</code></a> error will be returned if the operation was
cancelled. <a href="/usr/share/gtk-doc/html/giogio-GIOError.html#G-IO-ERROR-FAILED:CAPS"><code class="literal">G_IO_ERROR_FAILED</code></a> will be returned for other errors.</p>
<div class="refsect3">
<a name="nice-agent-recv-messages.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>a <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_id</p></td>
<td class="parameter_description"><p>the ID of the stream to receive on</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>component_id</p></td>
<td class="parameter_description"><p>the ID of the component to receive on</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>messages</p></td>
<td class="parameter_description"><p> caller-allocated
array of <a href="NiceAgent.html#NiceInputMessage"><span class="type">NiceInputMessages</span></a> to write the received messages into, of length at
least <em class="parameter"><code>n_messages</code></em>
. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_messages][<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out caller-allocates</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>n_messages</p></td>
<td class="parameter_description"><p>number of entries in <em class="parameter"><code>messages</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p> a <a href="/usr/share/gtk-doc/html/gioGCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> to allow the operation to be
cancelled from another thread, or <a href="/usr/share/gtk-doc/html/liboilliboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p> return location for a <a href="/usr/share/gtk-doc/html/glibglib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/liboilliboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nice-agent-recv-messages.returns"></a><h4>Returns</h4>
<p> the number of valid messages written to <em class="parameter"><code>messages</code></em>
on success
(guaranteed to be greater than 0 unless <em class="parameter"><code>n_messages</code></em>
is 0), 0 if the remote
peer closed the stream, or -1 on error</p>
</div>
<p class="since">Since: <a class="link" href="ix10.html#api-index-0.1.5">0.1.5</a></p>
</div>
<hr>
<div class="refsect2">
<a name="nice-agent-recv-nonblocking"></a><h3>nice_agent_recv_nonblocking ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gssize"><span class="returnvalue">gssize</span></a>
nice_agent_recv_nonblocking (<em class="parameter"><code><a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> stream_id</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> component_id</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint8"><span class="type">guint8</span></a> *buf</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gsize"><span class="type">gsize</span></a> buf_len</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gioGCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>A single-message version of <a class="link" href="NiceAgent.html#nice-agent-recv-messages-nonblocking" title="nice_agent_recv_messages_nonblocking ()"><code class="function">nice_agent_recv_messages_nonblocking()</code></a>.</p>
<div class="refsect3">
<a name="nice-agent-recv-nonblocking.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>a <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_id</p></td>
<td class="parameter_description"><p>the ID of the stream to receive on</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>component_id</p></td>
<td class="parameter_description"><p>the ID of the component to receive on</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>buf</p></td>
<td class="parameter_description"><p> caller-allocated buffer
to write the received data into, of length at least <em class="parameter"><code>buf_len</code></em>
. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=buf_len][<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out caller-allocates</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>buf_len</p></td>
<td class="parameter_description"><p>length of <em class="parameter"><code>buf</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p> a <a href="/usr/share/gtk-doc/html/gioGCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> to allow the operation to be
cancelled from another thread, or <a href="/usr/share/gtk-doc/html/liboilliboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p> return location for a <a href="/usr/share/gtk-doc/html/glibglib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/liboilliboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nice-agent-recv-nonblocking.returns"></a><h4>Returns</h4>
<p> the number of bytes received into <em class="parameter"><code>buf</code></em>
on success (guaranteed to be
greater than 0 unless <em class="parameter"><code>buf_len</code></em>
is 0), 0 if in reliable mode and the remote
peer closed the stream, or -1 on error</p>
</div>
<p class="since">Since: <a class="link" href="ix10.html#api-index-0.1.5">0.1.5</a></p>
</div>
<hr>
<div class="refsect2">
<a name="nice-agent-recv-messages-nonblocking"></a><h3>nice_agent_recv_messages_nonblocking ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
nice_agent_recv_messages_nonblocking (<em class="parameter"><code><a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> stream_id</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> component_id</code></em>,
<em class="parameter"><code><a class="link" href="NiceAgent.html#NiceInputMessage" title="NiceInputMessage"><span class="type">NiceInputMessage</span></a> *messages</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> n_messages</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gioGCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Try to receive data from the given stream/component combination on <em class="parameter"><code>agent</code></em>
,
without blocking. If receiving data would block, -1 is returned and
<a href="/usr/share/gtk-doc/html/giogio-GIOError.html#G-IO-ERROR-WOULD-BLOCK:CAPS"><code class="literal">G_IO_ERROR_WOULD_BLOCK</code></a> is set in <em class="parameter"><code>error</code></em>
. If any other error occurs, -1 is
returned and <em class="parameter"><code>error</code></em>
is set accordingly. Otherwise, 0 is returned if (and only
if) <em class="parameter"><code>n_messages</code></em>
is 0. In all other cases, the number of valid messages stored
in <em class="parameter"><code>messages</code></em>
is returned, and will be greater than 0.</p>
<p>This function behaves similarly to <a class="link" href="NiceAgent.html#nice-agent-recv-messages" title="nice_agent_recv_messages ()"><code class="function">nice_agent_recv_messages()</code></a>, except that it
will not block on filling (in reliable mode) or receiving (in non-reliable
mode) exactly <em class="parameter"><code>n_messages</code></em>
messages. In reliable mode, it will receive bytes
into <em class="parameter"><code>messages</code></em>
until it would block; in non-reliable mode, it will receive
messages until it would block.</p>
<p>Any STUN packets received will not be added to <em class="parameter"><code>messages</code></em>
; instead,
they'll be passed for processing to <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> itself. Since <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a>
does not poll for messages on its own, it's therefore essential to keep
calling this function for ICE connection establishment to work.</p>
<p>As this function is non-blocking, <em class="parameter"><code>cancellable</code></em>
is included only for parity
with <a class="link" href="NiceAgent.html#nice-agent-recv-messages" title="nice_agent_recv_messages ()"><code class="function">nice_agent_recv_messages()</code></a>. If <em class="parameter"><code>cancellable</code></em>
is cancelled before this
function is called, a <a href="/usr/share/gtk-doc/html/giogio-GIOError.html#G-IO-ERROR-CANCELLED:CAPS"><code class="literal">G_IO_ERROR_CANCELLED</code></a> error will be returned
immediately.</p>
<p>This must not be used in combination with <a class="link" href="NiceAgent.html#nice-agent-attach-recv" title="nice_agent_attach_recv ()"><code class="function">nice_agent_attach_recv()</code></a> on the
same stream/component pair.</p>
<div class="refsect3">
<a name="nice-agent-recv-messages-nonblocking.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>a <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_id</p></td>
<td class="parameter_description"><p>the ID of the stream to receive on</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>component_id</p></td>
<td class="parameter_description"><p>the ID of the component to receive on</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>messages</p></td>
<td class="parameter_description"><p> caller-allocated
array of <a href="NiceAgent.html#NiceInputMessage"><span class="type">NiceInputMessages</span></a> to write the received messages into, of length at
least <em class="parameter"><code>n_messages</code></em>
. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_messages][<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out caller-allocates</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>n_messages</p></td>
<td class="parameter_description"><p>number of entries in <em class="parameter"><code>messages</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p> a <a href="/usr/share/gtk-doc/html/gioGCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> to allow the operation to be
cancelled from another thread, or <a href="/usr/share/gtk-doc/html/liboilliboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p> return location for a <a href="/usr/share/gtk-doc/html/glibglib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/liboilliboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nice-agent-recv-messages-nonblocking.returns"></a><h4>Returns</h4>
<p> the number of valid messages written to <em class="parameter"><code>messages</code></em>
on success
(guaranteed to be greater than 0 unless <em class="parameter"><code>n_messages</code></em>
is 0), 0 if in reliable
mode and the remote peer closed the stream, or -1 on error</p>
</div>
<p class="since">Since: <a class="link" href="ix10.html#api-index-0.1.5">0.1.5</a></p>
</div>
<hr>
<div class="refsect2">
<a name="nice-agent-attach-recv"></a><h3>nice_agent_attach_recv ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
nice_agent_attach_recv (<em class="parameter"><code><a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> stream_id</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> component_id</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> *ctx</code></em>,
<em class="parameter"><code><a class="link" href="NiceAgent.html#NiceAgentRecvFunc" title="NiceAgentRecvFunc ()"><span class="type">NiceAgentRecvFunc</span></a> func</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
<p>Attaches the stream's component's sockets to the Glib Mainloop Context in
order to be notified whenever data becomes available for a component,
and to enable <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> to receive STUN messages (during the
establishment of ICE connectivity).</p>
<p>This must not be used in combination with <a class="link" href="NiceAgent.html#nice-agent-recv-messages" title="nice_agent_recv_messages ()"><code class="function">nice_agent_recv_messages()</code></a> (or
<span class="type">NiceIOStream</span> or <span class="type">NiceInputStream</span>) on the same stream/component pair.</p>
<p>Calling <a class="link" href="NiceAgent.html#nice-agent-attach-recv" title="nice_agent_attach_recv ()"><code class="function">nice_agent_attach_recv()</code></a> with a <a href="/usr/share/gtk-doc/html/liboilliboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> <em class="parameter"><code>func</code></em>
will detach any existing
callback and cause reception to be paused for the given stream/component
pair. You must iterate the previously specified <a href="/usr/share/gtk-doc/html/glibglib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> sufficiently to
ensure all pending I/O callbacks have been received before calling this
function to unset <em class="parameter"><code>func</code></em>
, otherwise data loss of received packets may occur.</p>
<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
<div class="refsect3">
<a name="nice-agent-attach-recv.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> Object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_id</p></td>
<td class="parameter_description"><p>The ID of stream</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>component_id</p></td>
<td class="parameter_description"><p>The ID of the component</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>ctx</p></td>
<td class="parameter_description"><p>The Glib Mainloop Context to use for listening on the component</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>func</p></td>
<td class="parameter_description"><p>The callback function to be called when data is received on
the stream's component (will not be called for STUN messages that
should be handled by <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> itself)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>user data associated with the callback</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nice-agent-attach-recv.returns"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the stream or component IDs are invalid.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="nice-agent-set-selected-pair"></a><h3>nice_agent_set_selected_pair ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
nice_agent_set_selected_pair (<em class="parameter"><code><a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> stream_id</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> component_id</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *lfoundation</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *rfoundation</code></em>);</pre>
<p>Sets the selected candidate pair for media transmission
for a given stream's component. Calling this function will
disable all further ICE processing (connection check,
state machine updates, etc). Note that keepalives will
continue to be sent.</p>
<div class="refsect3">
<a name="nice-agent-set-selected-pair.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> Object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_id</p></td>
<td class="parameter_description"><p>The ID of the stream</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>component_id</p></td>
<td class="parameter_description"><p>The ID of the component</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>lfoundation</p></td>
<td class="parameter_description"><p>The local foundation of the candidate to use</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>rfoundation</p></td>
<td class="parameter_description"><p>The remote foundation of the candidate to use</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nice-agent-set-selected-pair.returns"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the candidate pair cannot be found</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="nice-agent-set-selected-remote-candidate"></a><h3>nice_agent_set_selected_remote_candidate ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
nice_agent_set_selected_remote_candidate
(<em class="parameter"><code><a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> stream_id</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> component_id</code></em>,
<em class="parameter"><code><a class="link" href="NiceCandidate.html" title="NiceCandidate"><span class="type">NiceCandidate</span></a> *candidate</code></em>);</pre>
<p>Sets the selected remote candidate for media transmission
for a given stream's component. This is used to force the selection of
a specific remote candidate even when connectivity checks are failing
(e.g. non-ICE compatible candidates).
Calling this function will disable all further ICE processing
(connection check, state machine updates, etc). Note that keepalives will
continue to be sent.</p>
<div class="refsect3">
<a name="nice-agent-set-selected-remote-candidate.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> Object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_id</p></td>
<td class="parameter_description"><p>The ID of the stream</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>component_id</p></td>
<td class="parameter_description"><p>The ID of the component</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>candidate</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceCandidate.html" title="NiceCandidate"><span class="type">NiceCandidate</span></a> to select</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nice-agent-set-selected-remote-candidate.returns"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on failure</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="nice-agent-set-stream-tos"></a><h3>nice_agent_set_stream_tos ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
nice_agent_set_stream_tos (<em class="parameter"><code><a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> stream_id</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gint"><span class="type">gint</span></a> tos</code></em>);</pre>
<p>Sets the IP_TOS and/or IPV6_TCLASS field on the stream's sockets' options</p>
<div class="refsect3">
<a name="nice-agent-set-stream-tos.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> Object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_id</p></td>
<td class="parameter_description"><p>The ID of the stream</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>tos</p></td>
<td class="parameter_description"><p>The ToS to set</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.0.9">0.0.9</a></p>
</div>
<hr>
<div class="refsect2">
<a name="nice-agent-set-software"></a><h3>nice_agent_set_software ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
nice_agent_set_software (<em class="parameter"><code><a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *software</code></em>);</pre>
<p>This function will set the value of the SOFTWARE attribute to be added to
STUN requests, responses and error responses sent during connectivity checks.</p>
<p>
The SOFTWARE attribute will only be added in the <a class="link" href="NiceAgent.html#NICE-COMPATIBILITY-RFC5245:CAPS"><span class="type">NICE_COMPATIBILITY_RFC5245</span></a>
and <a class="link" href="NiceAgent.html#NICE-COMPATIBILITY-WLM2009:CAPS"><span class="type">NICE_COMPATIBILITY_WLM2009</span></a> compatibility modes.
</p>
<div class="note">
<p>
The <em class="parameter"><code>software</code></em> argument will be appended with the libnice version before
being sent.
</p>
<p>
The <em class="parameter"><code>software</code></em> argument must be in UTF-8 encoding and only the first
128 characters will be sent.
</p>
</div>
<div class="refsect3">
<a name="nice-agent-set-software.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> Object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>software</p></td>
<td class="parameter_description"><p>The value of the SOFTWARE attribute to add.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-0.0.10">0.0.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="nice-agent-restart"></a><h3>nice_agent_restart ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
nice_agent_restart (<em class="parameter"><code><a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent</code></em>);</pre>
<p>Restarts the session as defined in ICE draft 19. This function
needs to be called both when initiating (ICE spec section 9.1.1.1.
"ICE Restarts"), as well as when reacting (spec section 9.2.1.1.
"Detecting ICE Restart") to a restart.</p>
<div class="refsect3">
<a name="nice-agent-restart.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> Object</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nice-agent-restart.returns"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on error</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="nice-agent-restart-stream"></a><h3>nice_agent_restart_stream ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
nice_agent_restart_stream (<em class="parameter"><code><a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> stream_id</code></em>);</pre>
<p>Restarts a single stream as defined in RFC 5245. This function
needs to be called both when initiating (ICE spec section 9.1.1.1.
"ICE Restarts"), as well as when reacting (spec section 9.2.1.1.
"Detecting ICE Restart") to a restart.</p>
<p>Unlike <a class="link" href="NiceAgent.html#nice-agent-restart" title="nice_agent_restart ()"><code class="function">nice_agent_restart()</code></a>, this applies to a single stream. It also
does not generate a new tie breaker.</p>
<div class="refsect3">
<a name="nice-agent-restart-stream.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> Object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_id</p></td>
<td class="parameter_description"><p>The ID of the stream</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nice-agent-restart-stream.returns"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on error</p>
</div>
<p class="since">Since: <a class="link" href="ix11.html#api-index-0.1.6">0.1.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="nice-agent-set-stream-name"></a><h3>nice_agent_set_stream_name ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
nice_agent_set_stream_name (<em class="parameter"><code><a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> stream_id</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
<p>This function will assign a media type to a stream. The only values
that can be used to produce a valid SDP are: "audio", "video",
"text", "application", "image" and "message".</p>
<p>This is only useful when parsing and generating an SDP of the
candidates.</p>
<p>See also: <a class="link" href="NiceAgent.html#nice-agent-generate-local-sdp" title="nice_agent_generate_local_sdp ()"><code class="function">nice_agent_generate_local_sdp()</code></a></p>
<p>See also: <a class="link" href="NiceAgent.html#nice-agent-parse-remote-sdp" title="nice_agent_parse_remote_sdp ()"><code class="function">nice_agent_parse_remote_sdp()</code></a></p>
<p>See also: <a class="link" href="NiceAgent.html#nice-agent-get-stream-name" title="nice_agent_get_stream_name ()"><code class="function">nice_agent_get_stream_name()</code></a></p>
<div class="refsect3">
<a name="nice-agent-set-stream-name.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> Object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_id</p></td>
<td class="parameter_description"><p>The ID of the stream to change</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The new name of the stream or <a href="/usr/share/gtk-doc/html/liboilliboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nice-agent-set-stream-name.returns"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the name has been set. <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> in case of error
(invalid stream or duplicate name).</p>
</div>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.1.4">0.1.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="nice-agent-get-stream-name"></a><h3>nice_agent_get_stream_name ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
nice_agent_get_stream_name (<em class="parameter"><code><a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> stream_id</code></em>);</pre>
<p>This function will return the name assigned to a stream.</p>
<p>See also: <a class="link" href="NiceAgent.html#nice-agent-set-stream-name" title="nice_agent_set_stream_name ()"><code class="function">nice_agent_set_stream_name()</code></a></p>
<div class="refsect3">
<a name="nice-agent-get-stream-name.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> Object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_id</p></td>
<td class="parameter_description"><p>The ID of the stream to change</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nice-agent-get-stream-name.returns"></a><h4>Returns</h4>
<p> The name of the stream. The name is only valid while the stream
exists or until it changes through a call to <a class="link" href="NiceAgent.html#nice-agent-set-stream-name" title="nice_agent_set_stream_name ()"><code class="function">nice_agent_set_stream_name()</code></a>.</p>
</div>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.1.4">0.1.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="nice-agent-get-default-local-candidate"></a><h3>nice_agent_get_default_local_candidate ()</h3>
<pre class="programlisting"><a class="link" href="NiceCandidate.html" title="NiceCandidate"><span class="returnvalue">NiceCandidate</span></a> *
nice_agent_get_default_local_candidate
(<em class="parameter"><code><a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> stream_id</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> component_id</code></em>);</pre>
<p>This helper function will return the recommended default candidate to be
used for non-ICE compatible clients. This will usually be the candidate
with the lowest priority, since it will be the longest path but the one with
the most chances of success.</p>
<div class="note"><p>
This function is only useful in order to manually generate the
local SDP
</p></div>
<div class="refsect3">
<a name="nice-agent-get-default-local-candidate.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> Object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_id</p></td>
<td class="parameter_description"><p>The ID of the stream</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>component_id</p></td>
<td class="parameter_description"><p>The ID of the component</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nice-agent-get-default-local-candidate.returns"></a><h4>Returns</h4>
<p> The candidate to be used as the default candidate, or <a href="/usr/share/gtk-doc/html/liboilliboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> in case
of error. Must be freed with <a class="link" href="NiceCandidate.html#nice-candidate-free" title="nice_candidate_free ()"><code class="function">nice_candidate_free()</code></a> once done.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="nice-agent-generate-local-sdp"></a><h3>nice_agent_generate_local_sdp ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
nice_agent_generate_local_sdp (<em class="parameter"><code><a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent</code></em>);</pre>
<p>Generate an SDP string containing the local candidates and credentials for
all streams and components in the agent.</p>
<div class="note">
<p>
The SDP will not contain any codec lines and the 'm' line will not list
any payload types.
</p>
<p>
It is highly recommended to set names on the streams prior to calling this
function. Unnamed streams will show up as '-' in the 'm' line, but the SDP
will not be parseable with <a class="link" href="NiceAgent.html#nice-agent-parse-remote-sdp" title="nice_agent_parse_remote_sdp ()"><code class="function">nice_agent_parse_remote_sdp()</code></a> if a stream is
unnamed.
</p>
<p>
The default candidate in the SDP will be selected based on the lowest
priority candidate for the first component.
</p>
</div>
<p>See also: <a class="link" href="NiceAgent.html#nice-agent-set-stream-name" title="nice_agent_set_stream_name ()"><code class="function">nice_agent_set_stream_name()</code></a> </p>
<p>See also: <a class="link" href="NiceAgent.html#nice-agent-parse-remote-sdp" title="nice_agent_parse_remote_sdp ()"><code class="function">nice_agent_parse_remote_sdp()</code></a> </p>
<p>See also: <a class="link" href="NiceAgent.html#nice-agent-generate-local-stream-sdp" title="nice_agent_generate_local_stream_sdp ()"><code class="function">nice_agent_generate_local_stream_sdp()</code></a> </p>
<p>See also: <a class="link" href="NiceAgent.html#nice-agent-generate-local-candidate-sdp" title="nice_agent_generate_local_candidate_sdp ()"><code class="function">nice_agent_generate_local_candidate_sdp()</code></a> </p>
<p>See also: <a class="link" href="NiceAgent.html#nice-agent-get-default-local-candidate" title="nice_agent_get_default_local_candidate ()"><code class="function">nice_agent_get_default_local_candidate()</code></a> </p>
<div class="refsect3">
<a name="nice-agent-generate-local-sdp.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> Object</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nice-agent-generate-local-sdp.returns"></a><h4>Returns</h4>
<p> A string representing the local SDP. Must be freed with <a href="/usr/share/gtk-doc/html/glibglib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>
once done.</p>
</div>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.1.4">0.1.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="nice-agent-generate-local-stream-sdp"></a><h3>nice_agent_generate_local_stream_sdp ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
nice_agent_generate_local_stream_sdp (<em class="parameter"><code><a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> stream_id</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> include_non_ice</code></em>);</pre>
<p>Generate an SDP string containing the local candidates and credentials
for a stream.</p>
<div class="note">
<p>
The SDP will not contain any codec lines and the 'm' line will not list
any payload types.
</p>
<p>
It is highly recommended to set the name of the stream prior to calling this
function. Unnamed streams will show up as '-' in the 'm' line.
</p>
<p>
The default candidate in the SDP will be selected based on the lowest
priority candidate.
</p>
</div>
<p>See also: <a class="link" href="NiceAgent.html#nice-agent-set-stream-name" title="nice_agent_set_stream_name ()"><code class="function">nice_agent_set_stream_name()</code></a> </p>
<p>See also: <a class="link" href="NiceAgent.html#nice-agent-parse-remote-stream-sdp" title="nice_agent_parse_remote_stream_sdp ()"><code class="function">nice_agent_parse_remote_stream_sdp()</code></a> </p>
<p>See also: <a class="link" href="NiceAgent.html#nice-agent-generate-local-sdp" title="nice_agent_generate_local_sdp ()"><code class="function">nice_agent_generate_local_sdp()</code></a> </p>
<p>See also: <a class="link" href="NiceAgent.html#nice-agent-generate-local-candidate-sdp" title="nice_agent_generate_local_candidate_sdp ()"><code class="function">nice_agent_generate_local_candidate_sdp()</code></a> </p>
<p>See also: <a class="link" href="NiceAgent.html#nice-agent-get-default-local-candidate" title="nice_agent_get_default_local_candidate ()"><code class="function">nice_agent_get_default_local_candidate()</code></a> </p>
<div class="refsect3">
<a name="nice-agent-generate-local-stream-sdp.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> Object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_id</p></td>
<td class="parameter_description"><p>The ID of the stream</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>include_non_ice</p></td>
<td class="parameter_description"><p>Whether or not to include non ICE specific lines
(m=, c= and a=rtcp: lines)</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nice-agent-generate-local-stream-sdp.returns"></a><h4>Returns</h4>
<p> A string representing the local SDP for the stream. Must be freed
with <a href="/usr/share/gtk-doc/html/glibglib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> once done.</p>
</div>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.1.4">0.1.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="nice-agent-generate-local-candidate-sdp"></a><h3>nice_agent_generate_local_candidate_sdp ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
nice_agent_generate_local_candidate_sdp
(<em class="parameter"><code><a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent</code></em>,
<em class="parameter"><code><a class="link" href="NiceCandidate.html" title="NiceCandidate"><span class="type">NiceCandidate</span></a> *candidate</code></em>);</pre>
<p>Generate an SDP string representing a local candidate.</p>
<p>See also: <a class="link" href="NiceAgent.html#nice-agent-parse-remote-candidate-sdp" title="nice_agent_parse_remote_candidate_sdp ()"><code class="function">nice_agent_parse_remote_candidate_sdp()</code></a> </p>
<p>See also: <a class="link" href="NiceAgent.html#nice-agent-generate-local-sdp" title="nice_agent_generate_local_sdp ()"><code class="function">nice_agent_generate_local_sdp()</code></a> </p>
<p>See also: <a class="link" href="NiceAgent.html#nice-agent-generate-local-stream-sdp" title="nice_agent_generate_local_stream_sdp ()"><code class="function">nice_agent_generate_local_stream_sdp()</code></a> </p>
<div class="refsect3">
<a name="nice-agent-generate-local-candidate-sdp.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> Object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>candidate</p></td>
<td class="parameter_description"><p>The candidate to generate</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nice-agent-generate-local-candidate-sdp.returns"></a><h4>Returns</h4>
<p> A string representing the SDP for the candidate. Must be freed
with <a href="/usr/share/gtk-doc/html/glibglib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> once done.</p>
</div>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.1.4">0.1.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="nice-agent-parse-remote-sdp"></a><h3>nice_agent_parse_remote_sdp ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
nice_agent_parse_remote_sdp (<em class="parameter"><code><a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *sdp</code></em>);</pre>
<p>Parse an SDP string and extracts candidates and credentials from it and sets
them on the agent.</p>
<div class="note"><p>
This function will return an error if a stream has not been assigned a name
with <a class="link" href="NiceAgent.html#nice-agent-set-stream-name" title="nice_agent_set_stream_name ()"><code class="function">nice_agent_set_stream_name()</code></a> as it becomes troublesome to assign the
streams from the agent to the streams in the SDP.
</p></div>
<p>See also: <a class="link" href="NiceAgent.html#nice-agent-set-stream-name" title="nice_agent_set_stream_name ()"><code class="function">nice_agent_set_stream_name()</code></a> </p>
<p>See also: <a class="link" href="NiceAgent.html#nice-agent-generate-local-sdp" title="nice_agent_generate_local_sdp ()"><code class="function">nice_agent_generate_local_sdp()</code></a> </p>
<p>See also: <a class="link" href="NiceAgent.html#nice-agent-parse-remote-stream-sdp" title="nice_agent_parse_remote_stream_sdp ()"><code class="function">nice_agent_parse_remote_stream_sdp()</code></a> </p>
<p>See also: <a class="link" href="NiceAgent.html#nice-agent-parse-remote-candidate-sdp" title="nice_agent_parse_remote_candidate_sdp ()"><code class="function">nice_agent_parse_remote_candidate_sdp()</code></a> </p>
<div class="refsect3">
<a name="nice-agent-parse-remote-sdp.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> Object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sdp</p></td>
<td class="parameter_description"><p>The remote SDP to parse</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nice-agent-parse-remote-sdp.returns"></a><h4>Returns</h4>
<p> The number of candidates added, negative on errors</p>
</div>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.1.4">0.1.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="nice-agent-parse-remote-stream-sdp"></a><h3>nice_agent_parse_remote_stream_sdp ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *
nice_agent_parse_remote_stream_sdp (<em class="parameter"><code><a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> stream_id</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *sdp</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **ufrag</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **pwd</code></em>);</pre>
<p>Parse an SDP string representing a single stream and extracts candidates
and credentials from it.</p>
<p>See also: <a class="link" href="NiceAgent.html#nice-agent-generate-local-stream-sdp" title="nice_agent_generate_local_stream_sdp ()"><code class="function">nice_agent_generate_local_stream_sdp()</code></a> </p>
<p>See also: <a class="link" href="NiceAgent.html#nice-agent-parse-remote-sdp" title="nice_agent_parse_remote_sdp ()"><code class="function">nice_agent_parse_remote_sdp()</code></a> </p>
<p>See also: <a class="link" href="NiceAgent.html#nice-agent-parse-remote-candidate-sdp" title="nice_agent_parse_remote_candidate_sdp ()"><code class="function">nice_agent_parse_remote_candidate_sdp()</code></a> </p>
<div class="refsect3">
<a name="nice-agent-parse-remote-stream-sdp.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> Object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_id</p></td>
<td class="parameter_description"><p>The ID of the stream to parse</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sdp</p></td>
<td class="parameter_description"><p>The remote SDP to parse</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>ufrag</p></td>
<td class="parameter_description"><p>Pointer to store the ice ufrag if non <a href="/usr/share/gtk-doc/html/liboilliboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. Must be freed with
<a href="/usr/share/gtk-doc/html/glibglib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> after use</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>pwd</p></td>
<td class="parameter_description"><p>Pointer to store the ice password if non <a href="/usr/share/gtk-doc/html/liboilliboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. Must be freed with
<a href="/usr/share/gtk-doc/html/glibglib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> after use</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nice-agent-parse-remote-stream-sdp.returns"></a><h4>Returns</h4>
<p> A <a href="/usr/share/gtk-doc/html/glibglib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> of
candidates parsed from the SDP, or <a href="/usr/share/gtk-doc/html/liboilliboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> in case of errors. </p>
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> NiceCandidate][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.1.4">0.1.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="nice-agent-parse-remote-candidate-sdp"></a><h3>nice_agent_parse_remote_candidate_sdp ()</h3>
<pre class="programlisting"><a class="link" href="NiceCandidate.html" title="NiceCandidate"><span class="returnvalue">NiceCandidate</span></a> *
nice_agent_parse_remote_candidate_sdp (<em class="parameter"><code><a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> stream_id</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *sdp</code></em>);</pre>
<p>Parse an SDP string and extracts the candidate from it.</p>
<p>See also: <a class="link" href="NiceAgent.html#nice-agent-generate-local-candidate-sdp" title="nice_agent_generate_local_candidate_sdp ()"><code class="function">nice_agent_generate_local_candidate_sdp()</code></a> </p>
<p>See also: <a class="link" href="NiceAgent.html#nice-agent-parse-remote-sdp" title="nice_agent_parse_remote_sdp ()"><code class="function">nice_agent_parse_remote_sdp()</code></a> </p>
<p>See also: <a class="link" href="NiceAgent.html#nice-agent-parse-remote-stream-sdp" title="nice_agent_parse_remote_stream_sdp ()"><code class="function">nice_agent_parse_remote_stream_sdp()</code></a> </p>
<div class="refsect3">
<a name="nice-agent-parse-remote-candidate-sdp.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> Object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_id</p></td>
<td class="parameter_description"><p>The ID of the stream the candidate belongs to</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sdp</p></td>
<td class="parameter_description"><p>The remote SDP to parse</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nice-agent-parse-remote-candidate-sdp.returns"></a><h4>Returns</h4>
<p> The parsed candidate or <a href="/usr/share/gtk-doc/html/liboilliboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> if there was an error.</p>
</div>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.1.4">0.1.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="nice-agent-get-io-stream"></a><h3>nice_agent_get_io_stream ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gioGIOStream.html#GIOStream-struct"><span class="returnvalue">GIOStream</span></a> *
nice_agent_get_io_stream (<em class="parameter"><code><a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> stream_id</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> component_id</code></em>);</pre>
<p>Gets a <a href="/usr/share/gtk-doc/html/gioGIOStream.html#GIOStream-struct"><span class="type">GIOStream</span></a> wrapper around the given stream and component in
<em class="parameter"><code>agent</code></em>
. The I/O stream will be valid for as long as <em class="parameter"><code>stream_id</code></em>
is valid.
The <a href="/usr/share/gtk-doc/html/gioGInputStream.html#GInputStream-struct"><span class="type">GInputStream</span></a> and <a href="/usr/share/gtk-doc/html/gioGOutputStream.html#GOutputStream-struct"><span class="type">GOutputStream</span></a> implement <a href="/usr/share/gtk-doc/html/gioGPollableInputStream.html#GPollableInputStream-struct"><span class="type">GPollableInputStream</span></a> and
<a href="/usr/share/gtk-doc/html/gioGPollableOutputStream.html#GPollableOutputStream-struct"><span class="type">GPollableOutputStream</span></a>.</p>
<p>This function may only be called on reliable <a href="NiceAgent.html#NiceAgent-struct"><span class="type">NiceAgents</span></a>. It is a
programming error to try and create an I/O stream wrapper for an
unreliable stream.</p>
<div class="refsect3">
<a name="nice-agent-get-io-stream.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>A <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_id</p></td>
<td class="parameter_description"><p>The ID of the stream to wrap</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>component_id</p></td>
<td class="parameter_description"><p>The ID of the component to wrap</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nice-agent-get-io-stream.returns"></a><h4>Returns</h4>
<p> A <a href="/usr/share/gtk-doc/html/gioGIOStream.html#GIOStream-struct"><span class="type">GIOStream</span></a>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix10.html#api-index-0.1.5">0.1.5</a></p>
</div>
<hr>
<div class="refsect2">
<a name="nice-agent-get-selected-socket"></a><h3>nice_agent_get_selected_socket ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gioGSocket.html#GSocket-struct"><span class="returnvalue">GSocket</span></a> *
nice_agent_get_selected_socket (<em class="parameter"><code><a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> stream_id</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> component_id</code></em>);</pre>
<p>Retreive the local socket associated with the selected candidate pair
for media transmission for a given stream's component.</p>
<p>This is useful for adding ICE support to legacy applications that already
have a protocol that maintains a connection. If the socket is duplicated
before unrefing the agent, the application can take over and continue to use
it. New applications are encouraged to use the built in libnice stream
handling instead and let libnice handle the connection maintenance.</p>
<p>Users of this method are encouraged to not use a TURN relay or any kind
of proxy, as in this case, the socket will not be available to the
application because the packets are encapsulated.</p>
<div class="refsect3">
<a name="nice-agent-get-selected-socket.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> Object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_id</p></td>
<td class="parameter_description"><p>The ID of the stream</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>component_id</p></td>
<td class="parameter_description"><p>The ID of the component</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nice-agent-get-selected-socket.returns"></a><h4>Returns</h4>
<p> pointer to the <a href="/usr/share/gtk-doc/html/gioGSocket.html#GSocket-struct"><span class="type">GSocket</span></a>, or <a href="/usr/share/gtk-doc/html/liboilliboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> if
there is no selected candidate or if the selected candidate is a relayed
candidate. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix10.html#api-index-0.1.5">0.1.5</a></p>
</div>
<hr>
<div class="refsect2">
<a name="nice-agent-get-component-state"></a><h3>nice_agent_get_component_state ()</h3>
<pre class="programlisting"><a class="link" href="NiceAgent.html#NiceComponentState" title="enum NiceComponentState"><span class="returnvalue">NiceComponentState</span></a>
nice_agent_get_component_state (<em class="parameter"><code><a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> stream_id</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> component_id</code></em>);</pre>
<p>Retrieves the current state of a component.</p>
<div class="refsect3">
<a name="nice-agent-get-component-state.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> Object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_id</p></td>
<td class="parameter_description"><p>The ID of the stream</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>component_id</p></td>
<td class="parameter_description"><p>The ID of the component</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nice-agent-get-component-state.returns"></a><h4>Returns</h4>
<p> the <a class="link" href="NiceAgent.html#NiceComponentState" title="enum NiceComponentState"><span class="type">NiceComponentState</span></a> of the component and
<a class="link" href="NiceAgent.html#NICE-COMPONENT-STATE-FAILED:CAPS"><code class="literal">NICE_COMPONENT_STATE_FAILED</code></a> if the component was invalid.</p>
</div>
<p class="since">Since: <a class="link" href="ix12.html#api-index-0.1.8">0.1.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="nice-component-state-to-string"></a><h3>nice_component_state_to_string ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
nice_component_state_to_string (<em class="parameter"><code><a class="link" href="NiceAgent.html#NiceComponentState" title="enum NiceComponentState"><span class="type">NiceComponentState</span></a> state</code></em>);</pre>
<p>Returns a string representation of the state, generally to use in debug
messages.</p>
<div class="refsect3">
<a name="nice-component-state-to-string.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>state</p></td>
<td class="parameter_description"><p>a <a class="link" href="NiceAgent.html#NiceComponentState" title="enum NiceComponentState"><span class="type">NiceComponentState</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nice-component-state-to-string.returns"></a><h4>Returns</h4>
<p> a string representation of <em class="parameter"><code>state</code></em>
. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix11.html#api-index-0.1.6">0.1.6</a></p>
</div>
</div>
<div class="refsect1">
<a name="NiceAgent.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="NiceAgent-struct"></a><h3>NiceAgent</h3>
<pre class="programlisting">typedef struct _NiceAgent NiceAgent;</pre>
<p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> is the main GObject of the libnice library and represents
the ICE agent.</p>
</div>
<hr>
<div class="refsect2">
<a name="NiceComponentState"></a><h3>enum NiceComponentState</h3>
<p>An enum representing the state of a component.</p>
<p> See also: <a class="link" href="NiceAgent.html#NiceAgent-component-state-changed" title="The “component-state-changed” signal"><span class="type">“component-state-changed”</span></a> </p>
<div class="refsect3">
<a name="NiceComponentState.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="NICE-COMPONENT-STATE-DISCONNECTED:CAPS"></a>NICE_COMPONENT_STATE_DISCONNECTED</p></td>
<td class="enum_member_description">
<p>No activity scheduled</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="NICE-COMPONENT-STATE-GATHERING:CAPS"></a>NICE_COMPONENT_STATE_GATHERING</p></td>
<td class="enum_member_description">
<p>Gathering local candidates</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="NICE-COMPONENT-STATE-CONNECTING:CAPS"></a>NICE_COMPONENT_STATE_CONNECTING</p></td>
<td class="enum_member_description">
<p>Establishing connectivity</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="NICE-COMPONENT-STATE-CONNECTED:CAPS"></a>NICE_COMPONENT_STATE_CONNECTED</p></td>
<td class="enum_member_description">
<p>At least one working candidate pair</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="NICE-COMPONENT-STATE-READY:CAPS"></a>NICE_COMPONENT_STATE_READY</p></td>
<td class="enum_member_description">
<p>ICE concluded, candidate pair selection
is now final</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="NICE-COMPONENT-STATE-FAILED:CAPS"></a>NICE_COMPONENT_STATE_FAILED</p></td>
<td class="enum_member_description">
<p>Connectivity checks have been completed,
but connectivity was not established</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="NICE-COMPONENT-STATE-LAST:CAPS"></a>NICE_COMPONENT_STATE_LAST</p></td>
<td class="enum_member_description">
<p>Dummy state</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="NiceComponentType"></a><h3>enum NiceComponentType</h3>
<p>Convenience enum representing the type of a component for use as the
component_id for RTP/RTCP usages.</p>
<div class="example">
<a name="id-1.2.2.1.12.4.4"></a><p class="title"><b>Example 2. Example of use.</b></p>
<div class="example-contents">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="function"><a href="NiceAgent.html#nice-agent-send">nice_agent_send</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">agent</span><span class="symbol">,</span><span class="normal"> stream_id</span><span class="symbol">,</span><span class="normal"> <a href="NiceAgent.html#NICE-COMPONENT-TYPE-RTP:CAPS">NICE_COMPONENT_TYPE_RTP</a></span><span class="symbol">,</span><span class="normal"> len</span><span class="symbol">,</span><span class="normal"> buf</span><span class="symbol">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
</div>
<br class="example-break"><div class="refsect3">
<a name="NiceComponentType.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="NICE-COMPONENT-TYPE-RTP:CAPS"></a>NICE_COMPONENT_TYPE_RTP</p></td>
<td class="enum_member_description">
<p>RTP Component type</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="NICE-COMPONENT-TYPE-RTCP:CAPS"></a>NICE_COMPONENT_TYPE_RTCP</p></td>
<td class="enum_member_description">
<p>RTCP Component type</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="NiceProxyType"></a><h3>enum NiceProxyType</h3>
<p>An enum to specify which proxy type to use for relaying.
Note that the proxies will only be used with TCP TURN relaying.</p>
<p> See also: <a class="link" href="NiceAgent.html#NiceAgent--proxy-type" title="The “proxy-type” property"><span class="type">“proxy-type”</span></a> </p>
<div class="refsect3">
<a name="NiceProxyType.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="NICE-PROXY-TYPE-NONE:CAPS"></a>NICE_PROXY_TYPE_NONE</p></td>
<td class="enum_member_description">
<p>Do not use a proxy</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="NICE-PROXY-TYPE-SOCKS5:CAPS"></a>NICE_PROXY_TYPE_SOCKS5</p></td>
<td class="enum_member_description">
<p>Use a SOCKS5 proxy</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="NICE-PROXY-TYPE-HTTP:CAPS"></a>NICE_PROXY_TYPE_HTTP</p></td>
<td class="enum_member_description">
<p>Use an HTTP proxy</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="NICE-PROXY-TYPE-LAST:CAPS"></a>NICE_PROXY_TYPE_LAST</p></td>
<td class="enum_member_description">
<p>Dummy last proxy type</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix03.html#api-index-0.0.4">0.0.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="NiceCompatibility"></a><h3>enum NiceCompatibility</h3>
<p>An enum to specify which compatible specifications the <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> should use.
Use with <a class="link" href="NiceAgent.html#nice-agent-new" title="nice_agent_new ()"><code class="function">nice_agent_new()</code></a></p>
<div class="warning">
<em class="parameter"><code>NICE_COMPATIBILITY_DRAFT19</code></em> is deprecated and should not be used
in newly-written code. It is kept for compatibility reasons and
represents the same compatibility as <em class="parameter"><code>NICE_COMPATIBILITY_RFC5245</code></em>
</div>
<div class="note"><p>
If <em class="parameter"><code>NICE_COMPATIBILITY_RFC5245</code></em> compatibility mode is used for a non-reliable
agent, then ICE-UDP will be used with higher priority and ICE-TCP will also
be used when the UDP connectivity fails. If it is used with a reliable agent,
then ICE-UDP will be used with the TCP-Over-UDP (<a class="link" href="libnice-Pseudo-TCP-Socket.html#PseudoTcpSocket"><span class="type">PseudoTcpSocket</span></a>) if ICE-TCP
fails and ICE-UDP succeeds.
</p></div>
<div class="refsect3">
<a name="NiceCompatibility.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="NICE-COMPATIBILITY-RFC5245:CAPS"></a>NICE_COMPATIBILITY_RFC5245</p></td>
<td class="enum_member_description">
<p>Use compatibility with the RFC5245 ICE-UDP specs
and RFC6544 ICE-TCP specs</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="NICE-COMPATIBILITY-DRAFT19:CAPS"></a>NICE_COMPATIBILITY_DRAFT19</p></td>
<td class="enum_member_description">
<p>Use compatibility for ICE Draft 19 specs</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="NICE-COMPATIBILITY-GOOGLE:CAPS"></a>NICE_COMPATIBILITY_GOOGLE</p></td>
<td class="enum_member_description">
<p>Use compatibility for Google Talk specs</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="NICE-COMPATIBILITY-MSN:CAPS"></a>NICE_COMPATIBILITY_MSN</p></td>
<td class="enum_member_description">
<p>Use compatibility for MSN Messenger specs</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="NICE-COMPATIBILITY-WLM2009:CAPS"></a>NICE_COMPATIBILITY_WLM2009</p></td>
<td class="enum_member_description">
<p>Use compatibility with Windows Live Messenger
2009</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="NICE-COMPATIBILITY-OC2007:CAPS"></a>NICE_COMPATIBILITY_OC2007</p></td>
<td class="enum_member_description">
<p>Use compatibility with Microsoft Office Communicator 2007</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="NICE-COMPATIBILITY-OC2007R2:CAPS"></a>NICE_COMPATIBILITY_OC2007R2</p></td>
<td class="enum_member_description">
<p>Use compatibility with Microsoft Office Communicator 2007 R2</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="NICE-COMPATIBILITY-LAST:CAPS"></a>NICE_COMPATIBILITY_LAST</p></td>
<td class="enum_member_description">
<p>Dummy last compatibility mode</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="NiceInputMessage"></a><h3>NiceInputMessage</h3>
<pre class="programlisting">typedef struct {
GInputVector *buffers;
gint n_buffers; /* may be -1 to indicate @buffers is NULL-terminated */
NiceAddress *from; /* return location for address of message sender */
gsize length; /* sum of the lengths of @buffers */
} NiceInputMessage;
</pre>
<p>Represents a single message received off the network. For reliable
connections, this is essentially just an array of buffers (specifically,
<em class="parameter"><code>from</code></em>
can be ignored). for non-reliable connections, it represents a single
packet as received from the OS.</p>
<p><em class="parameter"><code>n_buffers</code></em>
may be -1 to indicate that <em class="parameter"><code>buffers</code></em>
is terminated by a
<a href="/usr/share/gtk-doc/html/gioGSocket.html#GInputVector"><span class="type">GInputVector</span></a> with a <a href="/usr/share/gtk-doc/html/liboilliboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> buffer pointer.</p>
<p>By providing arrays of <a href="NiceAgent.html#NiceInputMessage"><span class="type">NiceInputMessages</span></a> to functions like
<a class="link" href="NiceAgent.html#nice-agent-recv-messages" title="nice_agent_recv_messages ()"><code class="function">nice_agent_recv_messages()</code></a>, multiple messages may be received with a single
call, which is more efficient than making multiple calls in a loop. In this
manner, <a class="link" href="NiceAgent.html#nice-agent-recv-messages" title="nice_agent_recv_messages ()"><code class="function">nice_agent_recv_messages()</code></a> is analogous to <code class="function">recvmmsg()</code>; and
<a class="link" href="NiceAgent.html#NiceInputMessage" title="NiceInputMessage"><span class="type">NiceInputMessage</span></a> to struct mmsghdr.</p>
<div class="refsect3">
<a name="NiceInputMessage.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/gioGSocket.html#GInputVector"><span class="type">GInputVector</span></a> *<em class="structfield"><code><a name="NiceInputMessage.buffers"></a>buffers</code></em>;</p></td>
<td class="struct_member_description"><p> unowned array of <a href="/usr/share/gtk-doc/html/gioGSocket.html#GInputVector"><span class="type">GInputVector</span></a> buffers to
store data in for this message. </p></td>
<td class="struct_member_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_buffers]</span></td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="NiceInputMessage.n-buffers"></a>n_buffers</code></em>;</p></td>
<td class="struct_member_description"><p>number of <a href="/usr/share/gtk-doc/html/gioGSocket.html#GInputVector"><span class="type">GInputVectors</span></a> in <em class="parameter"><code>buffers</code></em>
, or -1 to indicate <em class="parameter"><code>buffers</code></em>
is <a href="/usr/share/gtk-doc/html/liboilliboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a class="link" href="libnice-NiceAddress.html#NiceAddress" title="NiceAddress"><span class="type">NiceAddress</span></a> *<em class="structfield"><code><a name="NiceInputMessage.from"></a>from</code></em>;</p></td>
<td class="struct_member_description"><p> return location to store the address of the peer who
transmitted the message, or <a href="/usr/share/gtk-doc/html/liboilliboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="struct_member_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gsize"><span class="type">gsize</span></a> <em class="structfield"><code><a name="NiceInputMessage.length"></a>length</code></em>;</p></td>
<td class="struct_member_description"><p>total number of valid bytes contiguously stored in <em class="parameter"><code>buffers</code></em>
</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix10.html#api-index-0.1.5">0.1.5</a></p>
</div>
<hr>
<div class="refsect2">
<a name="NiceOutputMessage"></a><h3>NiceOutputMessage</h3>
<pre class="programlisting">typedef struct {
GOutputVector *buffers;
gint n_buffers;
} NiceOutputMessage;
</pre>
<p>Represents a single message to transmit on the network. For
reliable connections, this is essentially just an array of
buffer. for non-reliable connections, it represents a single packet
to send to the OS.</p>
<p><em class="parameter"><code>n_buffers</code></em>
may be -1 to indicate that <em class="parameter"><code>buffers</code></em>
is terminated by a
<a href="/usr/share/gtk-doc/html/gioGSocket.html#GOutputVector"><span class="type">GOutputVector</span></a> with a <a href="/usr/share/gtk-doc/html/liboilliboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> buffer pointer.</p>
<p>By providing arrays of <a href="NiceAgent.html#NiceOutputMessage"><span class="type">NiceOutputMessages</span></a> to functions like
<a class="link" href="NiceAgent.html#nice-agent-send-messages-nonblocking" title="nice_agent_send_messages_nonblocking ()"><code class="function">nice_agent_send_messages_nonblocking()</code></a>, multiple messages may be transmitted
with a single call, which is more efficient than making multiple calls in a
loop. In this manner, <a class="link" href="NiceAgent.html#nice-agent-send-messages-nonblocking" title="nice_agent_send_messages_nonblocking ()"><code class="function">nice_agent_send_messages_nonblocking()</code></a> is analogous to
<code class="function">sendmmsg()</code>; and <a class="link" href="NiceAgent.html#NiceOutputMessage" title="NiceOutputMessage"><span class="type">NiceOutputMessage</span></a> to struct mmsghdr.</p>
<div class="refsect3">
<a name="NiceOutputMessage.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/gioGSocket.html#GOutputVector"><span class="type">GOutputVector</span></a> *<em class="structfield"><code><a name="NiceOutputMessage.buffers"></a>buffers</code></em>;</p></td>
<td class="struct_member_description"><p> unowned array of <a href="/usr/share/gtk-doc/html/gioGSocket.html#GOutputVector"><span class="type">GOutputVector</span></a> buffers
which contain data to transmit for this message. </p></td>
<td class="struct_member_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_buffers]</span></td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="NiceOutputMessage.n-buffers"></a>n_buffers</code></em>;</p></td>
<td class="struct_member_description"><p>number of <a href="/usr/share/gtk-doc/html/gioGSocket.html#GOutputVector"><span class="type">GOutputVectors</span></a> in <em class="parameter"><code>buffers</code></em>
, or -1 to indicate <em class="parameter"><code>buffers</code></em>
is <a href="/usr/share/gtk-doc/html/liboilliboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix10.html#api-index-0.1.5">0.1.5</a></p>
</div>
<hr>
<div class="refsect2">
<a name="NICE-AGENT-MAX-REMOTE-CANDIDATES:CAPS"></a><h3>NICE_AGENT_MAX_REMOTE_CANDIDATES</h3>
<pre class="programlisting">#define NICE_AGENT_MAX_REMOTE_CANDIDATES 25
</pre>
<p>A hard limit for the number of remote candidates. This
limit is enforced to protect against malevolent remote
clients.</p>
</div>
</div>
<div class="refsect1">
<a name="NiceAgent.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="NiceAgent--bytestream-tcp"></a><h3>The <code class="literal">“bytestream-tcp”</code> property</h3>
<pre class="programlisting"> “bytestream-tcp” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>This property defines whether receive/send over a TCP or pseudo-TCP, in
reliable mode, are considered as packetized or as bytestream.
In unreliable mode, every send/recv is considered as packetized, and
this property is ignored and cannot be set.</p>
<p>
In reliable mode, this property will always return <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> in the
<a class="link" href="NiceAgent.html#NICE-COMPATIBILITY-GOOGLE:CAPS"><code class="literal">NICE_COMPATIBILITY_GOOGLE</code></a> compatibility mode.
</p>
<p>If the property is <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, the stream is considered in bytestream mode
and data can be read with any receive size. If the property is <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, then
the stream is considred packetized and each receive will return one packet
of the same size as what was sent from the peer. If in packetized mode,
then doing a receive with a size smaller than the packet, will cause the
remaining bytes in the packet to be dropped, breaking the reliability
of the stream.</p>
<p>
This property is currently read-only, and will become read/write once
bytestream mode will be supported.
</p>
<p>Flags: Read</p>
<p>Default value: FALSE</p>
<p class="since">Since: <a class="link" href="ix12.html#api-index-0.1.8">0.1.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="NiceAgent--compatibility"></a><h3>The <code class="literal">“compatibility”</code> property</h3>
<pre class="programlisting"> “compatibility” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a></pre>
<p>The Nice agent can work in various compatibility modes depending on
what the application/peer needs.</p>
<p> See also: <a class="link" href="NiceAgent.html#NiceCompatibility" title="enum NiceCompatibility"><span class="type">NiceCompatibility</span></a></p>
<p>Flags: Read / Write / Construct Only</p>
<p>Allowed values: <= 5</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="NiceAgent--controlling-mode"></a><h3>The <code class="literal">“controlling-mode”</code> property</h3>
<pre class="programlisting"> “controlling-mode” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Whether the agent is in controlling mode.</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="NiceAgent--force-relay"></a><h3>The <code class="literal">“force-relay”</code> property</h3>
<pre class="programlisting"> “force-relay” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Force all traffic to go through a relay for added privacy, this
allows hiding the local IP address. When this is enabled, so
local candidates are available before relay servers have been set
with <a class="link" href="NiceAgent.html#nice-agent-set-relay-info" title="nice_agent_set_relay_info ()"><code class="function">nice_agent_set_relay_info()</code></a>.</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
<p class="since">Since: <a class="link" href="ix13.html#api-index-0.1.14">0.1.14</a></p>
</div>
<hr>
<div class="refsect2">
<a name="NiceAgent--full-mode"></a><h3>The <code class="literal">“full-mode”</code> property</h3>
<pre class="programlisting"> “full-mode” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Whether agent runs in ICE full mode.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2">
<a name="NiceAgent--ice-tcp"></a><h3>The <code class="literal">“ice-tcp”</code> property</h3>
<pre class="programlisting"> “ice-tcp” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Whether the agent should use ICE-TCP when gathering candidates.
If the option is disabled, no TCP candidates will be generated. If the
agent is in reliable mode, then pseudotcp will need to be used over UDP
candidates.</p>
<p>
This option should be set before gathering candidates and should not be
modified afterwards.
</p>
<p>The <a class="link" href="NiceAgent.html#NiceAgent--ice-tcp" title="The “ice-tcp” property"><span class="type">“ice-tcp”</span></a> property can be set at the same time as the
<a class="link" href="NiceAgent.html#NiceAgent--ice-udp" title="The “ice-udp” property"><span class="type">“ice-udp”</span></a> property, but both cannot be unset at the same time.
If <a class="link" href="NiceAgent.html#NiceAgent--ice-udp" title="The “ice-udp” property"><span class="type">“ice-udp”</span></a> is set to <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, then this property cannot be set
to <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> as well.</p>
<div class="note"><p>
ICE-TCP is only supported for <a class="link" href="NiceAgent.html#NICE-COMPATIBILITY-RFC5245:CAPS"><code class="literal">NICE_COMPATIBILITY_RFC5245</code></a>,
<a class="link" href="NiceAgent.html#NICE-COMPATIBILITY-OC2007:CAPS"><code class="literal">NICE_COMPATIBILITY_OC2007</code></a> and <a class="link" href="NiceAgent.html#NICE-COMPATIBILITY-OC2007R2:CAPS"><code class="literal">NICE_COMPATIBILITY_OC2007R2</code></a> compatibility
modes.
</p></div>
<p>Flags: Read / Write</p>
<p>Default value: TRUE</p>
<p class="since">Since: <a class="link" href="ix12.html#api-index-0.1.8">0.1.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="NiceAgent--ice-udp"></a><h3>The <code class="literal">“ice-udp”</code> property</h3>
<pre class="programlisting"> “ice-udp” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Whether the agent should use ICE-UDP when gathering candidates.
If the option is disabled, no UDP candidates will be generated. If the
agent is in reliable mode, then pseudotcp will not be used since pseudotcp
works on top of UDP candidates.</p>
<p>
This option should be set before gathering candidates and should not be
modified afterwards.
</p>
<p>The <a class="link" href="NiceAgent.html#NiceAgent--ice-udp" title="The “ice-udp” property"><span class="type">“ice-udp”</span></a> property can be set at the same time as the
<a class="link" href="NiceAgent.html#NiceAgent--ice-tcp" title="The “ice-tcp” property"><span class="type">“ice-tcp”</span></a> property, but both cannot be unset at the same time.
If <a class="link" href="NiceAgent.html#NiceAgent--ice-tcp" title="The “ice-tcp” property"><span class="type">“ice-tcp”</span></a> is set to <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, then this property cannot be set
to <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> as well.</p>
<p>Flags: Read / Write</p>
<p>Default value: TRUE</p>
<p class="since">Since: <a class="link" href="ix12.html#api-index-0.1.8">0.1.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="NiceAgent--keepalive-conncheck"></a><h3>The <code class="literal">“keepalive-conncheck”</code> property</h3>
<pre class="programlisting"> “keepalive-conncheck” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Use binding requests as keepalives instead of binding
indications. This means that the keepalives may time out which
will change the component state to <a class="link" href="NiceAgent.html#NICE-COMPONENT-STATE-FAILED:CAPS"><code class="literal">NICE_COMPONENT_STATE_FAILED</code></a>.</p>
<p>Enabing this is a slight violation of RFC 5245 section 10 which
recommends using Binding Indications for keepalives.</p>
<p>This is always enabled if the compatibility mode is
<a class="link" href="NiceAgent.html#NICE-COMPATIBILITY-GOOGLE:CAPS"><code class="literal">NICE_COMPATIBILITY_GOOGLE</code></a>.</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
<p class="since">Since: <a class="link" href="ix12.html#api-index-0.1.8">0.1.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="NiceAgent--main-context"></a><h3>The <code class="literal">“main-context”</code> property</h3>
<pre class="programlisting"> “main-context” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></pre>
<p>A GLib main context is needed for all timeouts used by libnice.
This is a property being set by the <a class="link" href="NiceAgent.html#nice-agent-new" title="nice_agent_new ()"><code class="function">nice_agent_new()</code></a> call.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
<hr>
<div class="refsect2">
<a name="NiceAgent--max-connectivity-checks"></a><h3>The <code class="literal">“max-connectivity-checks”</code> property</h3>
<pre class="programlisting"> “max-connectivity-checks” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a></pre>
<p>Upper limit for the total number of connectivity checks performed.</p>
<p>Flags: Read / Write</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="NiceAgent--proxy-ip"></a><h3>The <code class="literal">“proxy-ip”</code> property</h3>
<pre class="programlisting"> “proxy-ip” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>The proxy server IP used to bypass a proxy firewall</p>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
<p class="since">Since: <a class="link" href="ix03.html#api-index-0.0.4">0.0.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="NiceAgent--proxy-password"></a><h3>The <code class="literal">“proxy-password”</code> property</h3>
<pre class="programlisting"> “proxy-password” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>The password used to authenticate with the proxy</p>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
<p class="since">Since: <a class="link" href="ix03.html#api-index-0.0.4">0.0.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="NiceAgent--proxy-port"></a><h3>The <code class="literal">“proxy-port”</code> property</h3>
<pre class="programlisting"> “proxy-port” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a></pre>
<p>The proxy server port used to bypass a proxy firewall</p>
<p>Flags: Read / Write</p>
<p>Allowed values: [1,65536]</p>
<p>Default value: 1</p>
<p class="since">Since: <a class="link" href="ix03.html#api-index-0.0.4">0.0.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="NiceAgent--proxy-type"></a><h3>The <code class="literal">“proxy-type”</code> property</h3>
<pre class="programlisting"> “proxy-type” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a></pre>
<p>The type of proxy set in the proxy-ip property</p>
<p>Flags: Read / Write</p>
<p>Allowed values: <= 2</p>
<p>Default value: 0</p>
<p class="since">Since: <a class="link" href="ix03.html#api-index-0.0.4">0.0.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="NiceAgent--proxy-username"></a><h3>The <code class="literal">“proxy-username”</code> property</h3>
<pre class="programlisting"> “proxy-username” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>The username used to authenticate with the proxy</p>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
<p class="since">Since: <a class="link" href="ix03.html#api-index-0.0.4">0.0.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="NiceAgent--reliable"></a><h3>The <code class="literal">“reliable”</code> property</h3>
<pre class="programlisting"> “reliable” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Whether the agent is providing a reliable transport of messages (through
ICE-TCP or PseudoTCP over ICE-UDP)</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: FALSE</p>
<p class="since">Since: <a class="link" href="ix08.html#api-index-0.0.11">0.0.11</a></p>
</div>
<hr>
<div class="refsect2">
<a name="NiceAgent--stun-pacing-timer"></a><h3>The <code class="literal">“stun-pacing-timer”</code> property</h3>
<pre class="programlisting"> “stun-pacing-timer” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a></pre>
<p>Timer 'Ta' (msecs) used in the IETF ICE specification for pacing candidate gathering and sending of connectivity checks.</p>
<p>Flags: Read / Write / Construct</p>
<p>Allowed values: >= 1</p>
<p>Default value: 20</p>
</div>
<hr>
<div class="refsect2">
<a name="NiceAgent--stun-server"></a><h3>The <code class="literal">“stun-server”</code> property</h3>
<pre class="programlisting"> “stun-server” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>The IP address (not the hostname) of the STUN server to use.</p>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="NiceAgent--stun-server-port"></a><h3>The <code class="literal">“stun-server-port”</code> property</h3>
<pre class="programlisting"> “stun-server-port” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a></pre>
<p>Port of the STUN server used to gather server-reflexive candidates.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: [1,65536]</p>
<p>Default value: 1</p>
</div>
<hr>
<div class="refsect2">
<a name="NiceAgent--upnp"></a><h3>The <code class="literal">“upnp”</code> property</h3>
<pre class="programlisting"> “upnp” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Whether the agent should use UPnP to open a port in the router and
get the external IP</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: TRUE</p>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.0.7">0.0.7</a></p>
</div>
<hr>
<div class="refsect2">
<a name="NiceAgent--upnp-timeout"></a><h3>The <code class="literal">“upnp-timeout”</code> property</h3>
<pre class="programlisting"> “upnp-timeout” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a></pre>
<p>The maximum amount of time (in milliseconds) to wait for UPnP discovery to
finish before signaling the <a class="link" href="NiceAgent.html#NiceAgent-candidate-gathering-done" title="The “candidate-gathering-done” signal"><span class="type">“candidate-gathering-done”</span></a> signal</p>
<p>Flags: Read / Write / Construct</p>
<p>Allowed values: [100,60000]</p>
<p>Default value: 200</p>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.0.7">0.0.7</a></p>
</div>
</div>
<div class="refsect1">
<a name="NiceAgent.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="NiceAgent-candidate-gathering-done"></a><h3>The <code class="literal">“candidate-gathering-done”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent,
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> stream_id,
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>This signal is fired whenever a stream has finished gathering its
candidates after a call to <a class="link" href="NiceAgent.html#nice-agent-gather-candidates" title="nice_agent_gather_candidates ()"><code class="function">nice_agent_gather_candidates()</code></a></p>
<div class="refsect3">
<a name="NiceAgent-candidate-gathering-done.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_id</p></td>
<td class="parameter_description"><p>The ID of the stream</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="/usr/share/gtk-doc/html/gobjectgobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
<hr>
<div class="refsect2">
<a name="NiceAgent-component-state-changed"></a><h3>The <code class="literal">“component-state-changed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent,
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> stream_id,
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> component_id,
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> state,
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>This signal is fired whenever a component’s state changes. There are many
valid state transitions.</p>
<p><span class="inlinemediaobject"><img src="states.png" alt="State transition diagram"></span></p>
<div class="refsect3">
<a name="NiceAgent-component-state-changed.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_id</p></td>
<td class="parameter_description"><p>The ID of the stream</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>component_id</p></td>
<td class="parameter_description"><p>The ID of the component</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>state</p></td>
<td class="parameter_description"><p>The new <a class="link" href="NiceAgent.html#NiceComponentState" title="enum NiceComponentState"><span class="type">NiceComponentState</span></a> of the component</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="/usr/share/gtk-doc/html/gobjectgobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
<hr>
<div class="refsect2">
<a name="NiceAgent-initial-binding-request-received"></a><h3>The <code class="literal">“initial-binding-request-received”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent,
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> stream_id,
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>This signal is fired when we received our first binding request from
the peer.</p>
<div class="refsect3">
<a name="NiceAgent-initial-binding-request-received.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_id</p></td>
<td class="parameter_description"><p>The ID of the stream</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="/usr/share/gtk-doc/html/gobjectgobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
<hr>
<div class="refsect2">
<a name="NiceAgent-new-candidate"></a><h3>The <code class="literal">“new-candidate”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent,
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> stream_id,
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> component_id,
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *foundation,
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>This signal is fired when the agent discovers a new local candidate.
When this signal is emitted, a matching <a class="link" href="NiceAgent.html#NiceAgent-new-candidate-full" title="The “new-candidate-full” signal"><span class="type">“new-candidate-full”</span></a> is
also emitted with the candidate.</p>
<p>See also: <a class="link" href="NiceAgent.html#NiceAgent-candidate-gathering-done" title="The “candidate-gathering-done” signal"><span class="type">“candidate-gathering-done”</span></a>,
<a class="link" href="NiceAgent.html#NiceAgent-new-candidate-full" title="The “new-candidate-full” signal"><span class="type">“new-candidate-full”</span></a></p>
<div class="warning">
<p><code class="literal">NiceAgent::new-candidate</code> has been deprecated since version 0.1.8 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="NiceAgent.html#NiceAgent-new-candidate-full" title="The “new-candidate-full” signal"><span class="type">“new-candidate-full”</span></a></p>
</div>
<div class="refsect3">
<a name="NiceAgent-new-candidate.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_id</p></td>
<td class="parameter_description"><p>The ID of the stream</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>component_id</p></td>
<td class="parameter_description"><p>The ID of the component</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>foundation</p></td>
<td class="parameter_description"><p>The foundation of the new candidate</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="/usr/share/gtk-doc/html/gobjectgobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
<hr>
<div class="refsect2">
<a name="NiceAgent-new-candidate-full"></a><h3>The <code class="literal">“new-candidate-full”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent,
<a class="link" href="NiceCandidate.html" title="NiceCandidate"><span class="type">NiceCandidate</span></a> *candidate,
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>This signal is fired when the agent discovers a new local candidate.
When this signal is emitted, a matching <a class="link" href="NiceAgent.html#NiceAgent-new-candidate" title="The “new-candidate” signal"><span class="type">“new-candidate”</span></a> is
also emitted with the candidate's foundation.</p>
<p>See also: <a class="link" href="NiceAgent.html#NiceAgent-candidate-gathering-done" title="The “candidate-gathering-done” signal"><span class="type">“candidate-gathering-done”</span></a>,
<a class="link" href="NiceAgent.html#NiceAgent-new-candidate" title="The “new-candidate” signal"><span class="type">“new-candidate”</span></a></p>
<div class="refsect3">
<a name="NiceAgent-new-candidate-full.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>candidate</p></td>
<td class="parameter_description"><p>The new <a class="link" href="NiceCandidate.html" title="NiceCandidate"><span class="type">NiceCandidate</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="/usr/share/gtk-doc/html/gobjectgobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
<p class="since">Since: <a class="link" href="ix12.html#api-index-0.1.8">0.1.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="NiceAgent-new-remote-candidate"></a><h3>The <code class="literal">“new-remote-candidate”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent,
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> stream_id,
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> component_id,
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *foundation,
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>This signal is fired when the agent discovers a new remote
candidate. This can happen with peer reflexive candidates. When
this signal is emitted, a matching
<a class="link" href="NiceAgent.html#NiceAgent-new-remote-candidate-full" title="The “new-remote-candidate-full” signal"><span class="type">“new-remote-candidate-full”</span></a> is also emitted with the
candidate.</p>
<p>See also: <a class="link" href="NiceAgent.html#NiceAgent-new-remote-candidate-full" title="The “new-remote-candidate-full” signal"><span class="type">“new-remote-candidate-full”</span></a></p>
<div class="warning">
<p><code class="literal">NiceAgent::new-remote-candidate</code> has been deprecated since version 0.1.8 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="NiceAgent.html#NiceAgent-new-remote-candidate-full" title="The “new-remote-candidate-full” signal"><span class="type">“new-remote-candidate-full”</span></a></p>
</div>
<div class="refsect3">
<a name="NiceAgent-new-remote-candidate.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_id</p></td>
<td class="parameter_description"><p>The ID of the stream</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>component_id</p></td>
<td class="parameter_description"><p>The ID of the component</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>foundation</p></td>
<td class="parameter_description"><p>The foundation of the new candidate</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="/usr/share/gtk-doc/html/gobjectgobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
<hr>
<div class="refsect2">
<a name="NiceAgent-new-remote-candidate-full"></a><h3>The <code class="literal">“new-remote-candidate-full”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent,
<a class="link" href="NiceCandidate.html" title="NiceCandidate"><span class="type">NiceCandidate</span></a> *candidate,
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>This signal is fired when the agent discovers a new remote candidate.
This can happen with peer reflexive candidates.
When this signal is emitted, a matching <a class="link" href="NiceAgent.html#NiceAgent-new-remote-candidate" title="The “new-remote-candidate” signal"><span class="type">“new-remote-candidate”</span></a> is
also emitted with the candidate's foundation.</p>
<p>See also: <a class="link" href="NiceAgent.html#NiceAgent-new-remote-candidate" title="The “new-remote-candidate” signal"><span class="type">“new-remote-candidate”</span></a></p>
<div class="refsect3">
<a name="NiceAgent-new-remote-candidate-full.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>candidate</p></td>
<td class="parameter_description"><p>The new <a class="link" href="NiceCandidate.html" title="NiceCandidate"><span class="type">NiceCandidate</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="/usr/share/gtk-doc/html/gobjectgobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
<p class="since">Since: <a class="link" href="ix12.html#api-index-0.1.8">0.1.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="NiceAgent-new-selected-pair"></a><h3>The <code class="literal">“new-selected-pair”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent,
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> stream_id,
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> component_id,
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *lfoundation,
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *rfoundation,
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>This signal is fired once a candidate pair is selected for data
transfer for a stream's component This is emitted along with
<a class="link" href="NiceAgent.html#NiceAgent-new-selected-pair-full" title="The “new-selected-pair-full” signal"><span class="type">“new-selected-pair-full”</span></a> which has the whole candidate,
the Foundation of a Candidate is not a unique identifier.</p>
<p>See also: <a class="link" href="NiceAgent.html#NiceAgent-new-selected-pair-full" title="The “new-selected-pair-full” signal"><span class="type">“new-selected-pair-full”</span></a></p>
<div class="warning">
<p><code class="literal">NiceAgent::new-selected-pair</code> has been deprecated since version 0.1.8 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="NiceAgent.html#NiceAgent-new-selected-pair-full" title="The “new-selected-pair-full” signal"><span class="type">“new-selected-pair-full”</span></a></p>
</div>
<div class="refsect3">
<a name="NiceAgent-new-selected-pair.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_id</p></td>
<td class="parameter_description"><p>The ID of the stream</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>component_id</p></td>
<td class="parameter_description"><p>The ID of the component</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>lfoundation</p></td>
<td class="parameter_description"><p>The local foundation of the selected candidate pair</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>rfoundation</p></td>
<td class="parameter_description"><p>The remote foundation of the selected candidate pair</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="/usr/share/gtk-doc/html/gobjectgobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
<hr>
<div class="refsect2">
<a name="NiceAgent-new-selected-pair-full"></a><h3>The <code class="literal">“new-selected-pair-full”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent,
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> stream_id,
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> component_id,
<a class="link" href="NiceCandidate.html" title="NiceCandidate"><span class="type">NiceCandidate</span></a> *lcandidate,
<a class="link" href="NiceCandidate.html" title="NiceCandidate"><span class="type">NiceCandidate</span></a> *rcandidate,
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>This signal is fired once a candidate pair is selected for data
transfer for a stream's component. This is emitted along with
<a class="link" href="NiceAgent.html#NiceAgent-new-selected-pair" title="The “new-selected-pair” signal"><span class="type">“new-selected-pair”</span></a>.</p>
<p>See also: <a class="link" href="NiceAgent.html#NiceAgent-new-selected-pair" title="The “new-selected-pair” signal"><span class="type">“new-selected-pair”</span></a></p>
<div class="refsect3">
<a name="NiceAgent-new-selected-pair-full.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_id</p></td>
<td class="parameter_description"><p>The ID of the stream</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>component_id</p></td>
<td class="parameter_description"><p>The ID of the component</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>lcandidate</p></td>
<td class="parameter_description"><p>The local <a class="link" href="NiceCandidate.html" title="NiceCandidate"><span class="type">NiceCandidate</span></a> of the selected candidate pair</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>rcandidate</p></td>
<td class="parameter_description"><p>The remote <a class="link" href="NiceCandidate.html" title="NiceCandidate"><span class="type">NiceCandidate</span></a> of the selected candidate pair</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="/usr/share/gtk-doc/html/gobjectgobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
<p class="since">Since: <a class="link" href="ix12.html#api-index-0.1.8">0.1.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="NiceAgent-reliable-transport-writable"></a><h3>The <code class="literal">“reliable-transport-writable”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent,
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> stream_id,
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> component_id,
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>This signal is fired on the reliable <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> when the underlying reliable
transport becomes writable.
This signal is only emitted when the <a class="link" href="NiceAgent.html#nice-agent-send" title="nice_agent_send ()"><code class="function">nice_agent_send()</code></a> function returns less
bytes than requested to send (or -1) and once when the connection
is established.</p>
<div class="refsect3">
<a name="NiceAgent-reliable-transport-writable.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_id</p></td>
<td class="parameter_description"><p>The ID of the stream</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>component_id</p></td>
<td class="parameter_description"><p>The ID of the component</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="/usr/share/gtk-doc/html/gobjectgobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
<p class="since">Since: <a class="link" href="ix08.html#api-index-0.0.11">0.0.11</a></p>
</div>
<hr>
<div class="refsect2">
<a name="NiceAgent-streams-removed"></a><h3>The <code class="literal">“streams-removed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> *agent,
<span class="type">_NiceAgentStreamIds</span> *stream_ids,
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>This signal is fired whenever one or more streams are removed from the
<em class="parameter"><code>agent</code></em>
.</p>
<div class="refsect3">
<a name="NiceAgent-streams-removed.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>agent</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceAgent.html" title="NiceAgent"><span class="type">NiceAgent</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_ids</p></td>
<td class="parameter_description"><p> An array of
unsigned integer stream IDs, ending with a 0 ID. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> uint]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="/usr/share/gtk-doc/html/gobjectgobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
<p class="since">Since: <a class="link" href="ix10.html#api-index-0.1.5">0.1.5</a></p>
</div>
</div>
<div class="refsect1">
<a name="NiceAgent.see-also"></a><h2>See Also</h2>
<p><a class="link" href="NiceCandidate.html" title="NiceCandidate"><span class="type">NiceCandidate</span></a>, <a class="link" href="libnice-NiceAddress.html#NiceAddress" title="NiceAddress"><span class="type">NiceAddress</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|