/usr/share/gir-1.0/GstCheck-1.0.gir is in libgstreamer1.0-dev 1.10.4-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 | <?xml version="1.0"?>
<!-- This file was automatically generated from C sources - DO NOT EDIT!
To affect the contents of this file, edit the original C definitions,
and/or use gtk-doc annotations. -->
<repository version="1.2"
xmlns="http://www.gtk.org/introspection/core/1.0"
xmlns:c="http://www.gtk.org/introspection/c/1.0"
xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
<include name="Gst" version="1.0"/>
<package name="gstreamer-check-1.0"/>
<c:include name="gst/check/check.h"/>
<namespace name="GstCheck"
version="1.0"
shared-library="libgstcheck-1.0.so.0"
c:identifier-prefixes="Gst"
c:symbol-prefixes="gst">
<record name="CheckABIStruct" c:type="GstCheckABIStruct">
<field name="name" writable="1">
<type name="utf8" c:type="const char*"/>
</field>
<field name="size" writable="1">
<type name="gint" c:type="int"/>
</field>
<field name="abi_size" writable="1">
<type name="gint" c:type="int"/>
</field>
</record>
<record name="Harness" c:type="GstHarness" version="1.6">
<doc xml:space="preserve">#GstHarness is meant to make writing unit test for GStreamer much easier.
It can be thought of as a way of treating a #GstElement as a black box,
deterministically feeding it data, and controlling what data it outputs.
The basic structure of #GstHarness is two "floating" #GstPads that connect
to the harnessed #GstElement src and sink #GstPads like so:
<programlisting>
__________________________
_____ | _____ _____ | _____
| | | | | | | | | |
| src |--+-| sink| Element | src |-+--| sink|
|_____| | |_____| |_____| | |_____|
|__________________________|
</programlisting>
With this, you can now simulate any environment the #GstElement might find
itself in. By specifying the #GstCaps of the harness #GstPads, using
functions like gst_harness_set_src_caps() or gst_harness_set_sink_caps_str(),
you can test how the #GstElement interacts with different caps sets.
Your harnessed #GstElement can of course also be a bin, and using
gst_harness_new_parse() supporting standard gst-launch syntax, you can
easily test a whole pipeline instead of just one element.
You can then go on to push #GstBuffers and #GstEvents on to the srcpad,
using functions like gst_harness_push() and gst_harness_push_event(), and
then pull them out to examine them with gst_harness_pull() and
gst_harness_pull_event().
<example>
<title>A simple buffer-in buffer-out example</title>
<programlisting language="c">
#include &lt;gst/gst.h&gt;
#include &lt;gst/check/gstharness.h&gt;
GstHarness *h;
GstBuffer *in_buf;
GstBuffer *out_buf;
// attach the harness to the src and sink pad of GstQueue
h = gst_harness_new ("queue");
// we must specify a caps before pushing buffers
gst_harness_set_src_caps_str (h, "mycaps");
// create a buffer of size 42
in_buf = gst_harness_create_buffer (h, 42);
// push the buffer into the queue
gst_harness_push (h, in_buf);
// pull the buffer from the queue
out_buf = gst_harness_pull (h);
// validate the buffer in is the same as buffer out
fail_unless (in_buf == out_buf);
// cleanup
gst_buffer_unref (out_buf);
gst_harness_teardown (h);
</programlisting>
</example>
Another main feature of the #GstHarness is its integration with the
#GstTestClock. Operating the #GstTestClock can be very challenging, but
#GstHarness simplifies some of the most desired actions a lot, like wanting
to manually advance the clock while at the same time releasing a #GstClockID
that is waiting, with functions like gst_harness_crank_single_clock_wait().
#GstHarness also supports sub-harnesses, as a way of generating and
validating data. A sub-harness is another #GstHarness that is managed by
the "parent" harness, and can either be created by using the standard
gst_harness_new type functions directly on the (GstHarness *)->src_harness,
or using the much more convenient gst_harness_add_src() or
gst_harness_add_sink_parse(). If you have a decoder-element you want to test,
(like vp8dec) it can be very useful to add a src-harness with both a
src-element (videotestsrc) and an encoder (vp8enc) to feed the decoder data
with different configurations, by simply doing:
<example>
<programlisting language="c">
GstHarness * h = gst_harness_new (h, "vp8dec");
gst_harness_add_src_parse (h, "videotestsrc is-live=1 ! vp8enc", TRUE);
</programlisting>
</example>
and then feeding it data with:
<example>
<programlisting language="c">
gst_harness_push_from_src (h);
</programlisting>
</example></doc>
<field name="element" writable="1">
<doc xml:space="preserve">the element inside the harness</doc>
<type name="Gst.Element" c:type="GstElement*"/>
</field>
<field name="srcpad" writable="1">
<doc xml:space="preserve">the internal harness source pad</doc>
<type name="Gst.Pad" c:type="GstPad*"/>
</field>
<field name="sinkpad" writable="1">
<doc xml:space="preserve">the internal harness sink pad</doc>
<type name="Gst.Pad" c:type="GstPad*"/>
</field>
<field name="src_harness" writable="1">
<doc xml:space="preserve">the source (input) harness (if any)</doc>
<type name="Harness" c:type="GstHarness*"/>
</field>
<field name="sink_harness" writable="1">
<doc xml:space="preserve">the sink (output) harness (if any)</doc>
<type name="Harness" c:type="GstHarness*"/>
</field>
<field name="priv" readable="0" private="1">
<type name="HarnessPrivate" c:type="GstHarnessPrivate*"/>
</field>
<method name="add_element_full"
c:identifier="gst_harness_add_element_full"
version="1.6"
introspectable="0">
<doc xml:space="preserve">Adds a #GstElement to an empty #GstHarness
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="element" transfer-ownership="none">
<doc xml:space="preserve">a #GstElement to add to the harness (transfer none)</doc>
<type name="Gst.Element" c:type="GstElement*"/>
</parameter>
<parameter name="hsrc"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #GstStaticPadTemplate describing the harness srcpad.
%NULL will not create a harness srcpad.</doc>
<type name="Gst.StaticPadTemplate" c:type="GstStaticPadTemplate*"/>
</parameter>
<parameter name="element_sinkpad_name"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #gchar with the name of the element
sinkpad that is then linked to the harness srcpad. Can be a static or request
or a sometimes pad that has been added. %NULL will not get/request a sinkpad
from the element. (Like if the element is a src.)</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="hsink"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #GstStaticPadTemplate describing the harness sinkpad.
%NULL will not create a harness sinkpad.</doc>
<type name="Gst.StaticPadTemplate" c:type="GstStaticPadTemplate*"/>
</parameter>
<parameter name="element_srcpad_name"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #gchar with the name of the element
srcpad that is then linked to the harness sinkpad, similar to the
@element_sinkpad_name.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="add_element_sink_pad"
c:identifier="gst_harness_add_element_sink_pad"
version="1.6">
<doc xml:space="preserve">Links the specifed #GstPad the @GstHarness srcpad.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="sinkpad" transfer-ownership="none">
<doc xml:space="preserve">a #GstPad to link to the harness srcpad</doc>
<type name="Gst.Pad" c:type="GstPad*"/>
</parameter>
</parameters>
</method>
<method name="add_element_src_pad"
c:identifier="gst_harness_add_element_src_pad"
version="1.6">
<doc xml:space="preserve">Links the specifed #GstPad the @GstHarness sinkpad. This can be useful if
perhaps the srcpad did not exist at the time of creating the harness,
like a demuxer that provides a sometimes-pad after receiving data.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="srcpad" transfer-ownership="none">
<doc xml:space="preserve">a #GstPad to link to the harness sinkpad</doc>
<type name="Gst.Pad" c:type="GstPad*"/>
</parameter>
</parameters>
</method>
<method name="add_parse"
c:identifier="gst_harness_add_parse"
version="1.6"
introspectable="0">
<doc xml:space="preserve">Parses the @launchline and puts that in a #GstBin,
and then attches the supplied #GstHarness to the bin.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="launchline" transfer-ownership="none">
<doc xml:space="preserve">a #gchar describing a gst-launch type line</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="add_probe"
c:identifier="gst_harness_add_probe"
version="1.6">
<doc xml:space="preserve">A convenience function to allows you to call gst_pad_add_probe on a
#GstPad of a #GstElement that are residing inside the #GstHarness,
by using normal gst_pad_add_probe syntax
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="element_name" transfer-ownership="none">
<doc xml:space="preserve">a #gchar with a #GstElementFactory name</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="pad_name" transfer-ownership="none">
<doc xml:space="preserve">a #gchar with the name of the pad to attach the probe to</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="mask" transfer-ownership="none">
<doc xml:space="preserve">a #GstPadProbeType (see gst_pad_add_probe)</doc>
<type name="Gst.PadProbeType" c:type="GstPadProbeType"/>
</parameter>
<parameter name="callback"
transfer-ownership="none"
scope="notified"
closure="4"
destroy="5">
<doc xml:space="preserve">a #GstPadProbeCallback (see gst_pad_add_probe)</doc>
<type name="Gst.PadProbeCallback" c:type="GstPadProbeCallback"/>
</parameter>
<parameter name="user_data"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #gpointer (see gst_pad_add_probe)</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="destroy_data"
transfer-ownership="none"
scope="async">
<doc xml:space="preserve">a #GDestroyNotify (see gst_pad_add_probe)</doc>
<type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
</parameter>
</parameters>
</method>
<method name="add_sink"
c:identifier="gst_harness_add_sink"
version="1.6">
<doc xml:space="preserve">Similar to gst_harness_add_sink_harness, this is a convenience to
directly create a sink-harness using the @sink_element_name name specified.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="sink_element_name" transfer-ownership="none">
<doc xml:space="preserve">a #gchar with the name of a #GstElement</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="add_sink_harness"
c:identifier="gst_harness_add_sink_harness"
version="1.6">
<doc xml:space="preserve">Similar to gst_harness_add_src, this allows you to send the data coming out
of your harnessed #GstElement to a sink-element, allowing to test different
responses the element output might create in sink elements. An example might
be an existing sink providing some analytical data on the input it receives that
can be useful to your testing. If the goal is to test a sink-element itself,
this is better acheived using gst_harness_new directly on the sink.
If a sink-harness already exists it will be replaced.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="sink_harness" transfer-ownership="full">
<doc xml:space="preserve">a #GstHarness to be added as a sink-harness.</doc>
<type name="Harness" c:type="GstHarness*"/>
</parameter>
</parameters>
</method>
<method name="add_sink_parse"
c:identifier="gst_harness_add_sink_parse"
version="1.6">
<doc xml:space="preserve">Similar to gst_harness_add_sink, this allows you to specify a launch-line
instead of just an element name. See gst_harness_add_src_parse for details.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="launchline" transfer-ownership="none">
<doc xml:space="preserve">a #gchar with the name of a #GstElement</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="add_src" c:identifier="gst_harness_add_src" version="1.6">
<doc xml:space="preserve">Similar to gst_harness_add_src_harness, this is a convenience to
directly create a src-harness using the @src_element_name name specified.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="src_element_name" transfer-ownership="none">
<doc xml:space="preserve">a #gchar with the name of a #GstElement</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="has_clock_wait" transfer-ownership="none">
<doc xml:space="preserve">a #gboolean specifying if the #GstElement uses
gst_clock_wait_id internally.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="add_src_harness"
c:identifier="gst_harness_add_src_harness"
version="1.6">
<doc xml:space="preserve">A src-harness is a great way of providing the #GstHarness with data.
By adding a src-type #GstElement, it is then easy to use functions like
gst_harness_push_from_src or gst_harness_src_crank_and_push_many
to provide your harnessed element with input. The @has_clock_wait variable
is a greate way to control you src-element with, in that you can have it
produce a buffer for you by simply cranking the clock, and not have it
spin out of control producing buffers as fast as possible.
If a src-harness already exists it will be replaced.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="src_harness" transfer-ownership="full">
<doc xml:space="preserve">a #GstHarness to be added as a src-harness.</doc>
<type name="Harness" c:type="GstHarness*"/>
</parameter>
<parameter name="has_clock_wait" transfer-ownership="none">
<doc xml:space="preserve">a #gboolean specifying if the #GstElement uses
gst_clock_wait_id internally.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="add_src_parse"
c:identifier="gst_harness_add_src_parse"
version="1.6">
<doc xml:space="preserve">Similar to gst_harness_add_src, this allows you to specify a launch-line,
which can be useful for both having more then one #GstElement acting as your
src (Like a src producing raw buffers, and then an encoder, providing encoded
data), but also by allowing you to set properties like "is-live" directly on
the elements.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="launchline" transfer-ownership="none">
<doc xml:space="preserve">a #gchar describing a gst-launch type line</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="has_clock_wait" transfer-ownership="none">
<doc xml:space="preserve">a #gboolean specifying if the #GstElement uses
gst_clock_wait_id internally.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="buffers_in_queue"
c:identifier="gst_harness_buffers_in_queue"
version="1.6">
<doc xml:space="preserve">The number of #GstBuffers currently in the #GstHarness sinkpad #GAsyncQueue
MT safe.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #guint number of buffers in the queue</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
</parameters>
</method>
<method name="buffers_received"
c:identifier="gst_harness_buffers_received"
version="1.6">
<doc xml:space="preserve">The total number of #GstBuffers that has arrived on the #GstHarness sinkpad.
This number includes buffers that have been dropped as well as buffers
that have already been pulled out.
MT safe.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #guint number of buffers received</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
</parameters>
</method>
<method name="crank_multiple_clock_waits"
c:identifier="gst_harness_crank_multiple_clock_waits"
version="1.6">
<doc xml:space="preserve">Similar to gst_harness_crank_single_clock_wait(), this is the function to use
if your harnessed element(s) are using more then one gst_clock_id_wait.
Failing to do so can (and will) make it racy which #GstClockID you actually
are releasing, where as this function will process all the waits at the
same time, ensuring that one thread can't register another wait before
both are released.
MT safe.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a @gboolean %TRUE if the "crank" was successful, %FALSE if not.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="waits" transfer-ownership="none">
<doc xml:space="preserve">a #guint describing the number of #GstClockIDs to crank</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="crank_single_clock_wait"
c:identifier="gst_harness_crank_single_clock_wait"
version="1.6">
<doc xml:space="preserve">A "crank" consists of three steps:
1: Wait for a #GstClockID to be registered with the #GstTestClock.
2: Advance the #GstTestClock to the time the #GstClockID is waiting for.
3: Release the #GstClockID wait.
Together, this provides an easy way to not have to think about the details
around clocks and time, but still being able to write deterministic tests
that are dependant on this. A "crank" can be though of as the notion of
manually driving the clock forward to its next logical step.
MT safe.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a @gboolean %TRUE if the "crank" was successful, %FALSE if not.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
</parameters>
</method>
<method name="create_buffer"
c:identifier="gst_harness_create_buffer"
version="1.6">
<doc xml:space="preserve">Allocates a buffer using a #GstBufferPool if present, or else using the
configured #GstAllocator and #GstAllocationParams
MT safe.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GstBuffer of size @size</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="size" transfer-ownership="none">
<doc xml:space="preserve">a #gsize specifying the size of the buffer</doc>
<type name="gsize" c:type="gsize"/>
</parameter>
</parameters>
</method>
<method name="dump_to_file"
c:identifier="gst_harness_dump_to_file"
version="1.6">
<doc xml:space="preserve">Allows you to dump the #GstBuffers the #GstHarness sinkpad #GAsyncQueue
to a file.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="filename" transfer-ownership="none">
<doc xml:space="preserve">a #gchar with a the name of a file</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="events_in_queue"
c:identifier="gst_harness_events_in_queue"
version="1.6">
<doc xml:space="preserve">The number of #GstEvents currently in the #GstHarness sinkpad #GAsyncQueue
MT safe.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #guint number of events in the queue</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
</parameters>
</method>
<method name="events_received"
c:identifier="gst_harness_events_received"
version="1.6">
<doc xml:space="preserve">The total number of #GstEvents that has arrived on the #GstHarness sinkpad
This number includes events handled by the harness as well as events
that have already been pulled out.
MT safe.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #guint number of events received</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
</parameters>
</method>
<method name="find_element"
c:identifier="gst_harness_find_element"
version="1.6">
<doc xml:space="preserve">Most useful in conjunction with gst_harness_new_parse, this will scan the
#GstElements inside the #GstHarness, and check if any of them matches
@element_name. Typical usecase being that you need to access one of the
harnessed elements for properties and/or signals.
MT safe.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">a #GstElement or %NULL if not found</doc>
<type name="Gst.Element" c:type="GstElement*"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="element_name" transfer-ownership="none">
<doc xml:space="preserve">a #gchar with a #GstElementFactory name</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="get"
c:identifier="gst_harness_get"
version="1.6"
introspectable="0">
<doc xml:space="preserve">A convenience function to allows you to call g_object_get on a #GstElement
that are residing inside the #GstHarness, by using normal g_object_get
syntax.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="element_name" transfer-ownership="none">
<doc xml:space="preserve">a #gchar with a #GstElementFactory name</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="first_property_name" transfer-ownership="none">
<doc xml:space="preserve">a #gchar with the first property name</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">return location for the first property, followed optionally by more
name/return location pairs, followed by %NULL</doc>
<varargs/>
</parameter>
</parameters>
</method>
<method name="get_allocator"
c:identifier="gst_harness_get_allocator"
version="1.6">
<doc xml:space="preserve">Gets the @allocator and its @params that has been decided to use after an
allocation query.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="allocator"
direction="out"
caller-allocates="0"
transfer-ownership="none"
optional="1"
allow-none="1">
<doc xml:space="preserve">the #GstAllocator used</doc>
<type name="Gst.Allocator" c:type="GstAllocator**"/>
</parameter>
<parameter name="params"
direction="out"
caller-allocates="1"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve">the #GstAllocationParams of
@allocator</doc>
<type name="Gst.AllocationParams" c:type="GstAllocationParams*"/>
</parameter>
</parameters>
</method>
<method name="get_last_pushed_timestamp"
c:identifier="gst_harness_get_last_pushed_timestamp"
version="1.6">
<doc xml:space="preserve">Get the timestamp of the last #GstBuffer pushed on the #GstHarness srcpad,
typically with gst_harness_push or gst_harness_push_from_src.
MT safe.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #GstClockTime with the timestamp or %GST_CLOCK_TIME_NONE if no
#GstBuffer has been pushed on the #GstHarness srcpad</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_testclock"
c:identifier="gst_harness_get_testclock"
version="1.6">
<doc xml:space="preserve">Get the #GstTestClock. Useful if specific operations on the testclock is
needed.
MT safe.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GstTestClock, or %NULL if the testclock is not
present.</doc>
<type name="TestClock" c:type="GstTestClock*"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
</parameters>
</method>
<method name="play" c:identifier="gst_harness_play" version="1.6">
<doc xml:space="preserve">This will set the harnessed #GstElement to %GST_STATE_PLAYING.
#GstElements without a sink-#GstPad and with the %GST_ELEMENT_FLAG_SOURCE
flag set is concidered a src #GstElement
Non-src #GstElements (like sinks and filters) are automatically set to
playing by the #GstHarness, but src #GstElements are not to avoid them
starting to produce buffers.
Hence, for src #GstElement you must call gst_harness_play() explicitly.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
</parameters>
</method>
<method name="pull" c:identifier="gst_harness_pull" version="1.6">
<doc xml:space="preserve">Pulls a #GstBuffer from the #GAsyncQueue on the #GstHarness sinkpad. The pull
will timeout in 60 seconds. This is the standard way of getting a buffer
from a harnessed #GstElement.
MT safe.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GstBuffer or %NULL if timed out.</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
</parameters>
</method>
<method name="pull_event"
c:identifier="gst_harness_pull_event"
version="1.6">
<doc xml:space="preserve">Pulls an #GstEvent from the #GAsyncQueue on the #GstHarness sinkpad.
Timeouts after 60 seconds similar to gst_harness_pull.
MT safe.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GstEvent or %NULL if timed out.</doc>
<type name="Gst.Event" c:type="GstEvent*"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
</parameters>
</method>
<method name="pull_upstream_event"
c:identifier="gst_harness_pull_upstream_event"
version="1.6">
<doc xml:space="preserve">Pulls an #GstEvent from the #GAsyncQueue on the #GstHarness srcpad.
Timeouts after 60 seconds similar to gst_harness_pull.
MT safe.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GstEvent or %NULL if timed out.</doc>
<type name="Gst.Event" c:type="GstEvent*"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
</parameters>
</method>
<method name="push" c:identifier="gst_harness_push" version="1.6">
<doc xml:space="preserve">Pushes a #GstBuffer on the #GstHarness srcpad. The standard way of
interacting with an harnessed element.
MT safe.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #GstFlowReturn with the result from the push</doc>
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve">a #GstBuffer to push</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</parameter>
</parameters>
</method>
<method name="push_and_pull"
c:identifier="gst_harness_push_and_pull"
version="1.6">
<doc xml:space="preserve">Basically a gst_harness_push and a gst_harness_pull in one line. Reflects
the fact that you often want to do exactly this in your test: Push one buffer
in, and inspect the outcome.
MT safe.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GstBuffer or %NULL if timed out.</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve">a #GstBuffer to push</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</parameter>
</parameters>
</method>
<method name="push_event"
c:identifier="gst_harness_push_event"
version="1.6">
<doc xml:space="preserve">Pushes an #GstEvent on the #GstHarness srcpad.
MT safe.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #gboolean with the result from the push</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="event" transfer-ownership="none">
<doc xml:space="preserve">a #GstEvent to push</doc>
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
</parameters>
</method>
<method name="push_from_src"
c:identifier="gst_harness_push_from_src"
version="1.6">
<doc xml:space="preserve">Transfer data from the src-#GstHarness to the main-#GstHarness. It consists
of 4 steps:
1: Make sure the src is started. (see: gst_harness_play)
2: Crank the clock (see: gst_harness_crank_single_clock_wait)
3: Pull a #GstBuffer from the src-#GstHarness (see: gst_harness_pull)
4: Push the same #GstBuffer into the main-#GstHarness (see: gst_harness_push)
MT safe.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #GstFlowReturn with the result of the push</doc>
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
</parameters>
</method>
<method name="push_to_sink"
c:identifier="gst_harness_push_to_sink"
version="1.6">
<doc xml:space="preserve">Transfer one #GstBuffer from the main-#GstHarness to the sink-#GstHarness.
See gst_harness_push_from_src for details.
MT safe.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #GstFlowReturn with the result of the push</doc>
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
</parameters>
</method>
<method name="push_upstream_event"
c:identifier="gst_harness_push_upstream_event"
version="1.6">
<doc xml:space="preserve">Pushes an #GstEvent on the #GstHarness sinkpad.
MT safe.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #gboolean with the result from the push</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="event" transfer-ownership="none">
<doc xml:space="preserve">a #GstEvent to push</doc>
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
</parameters>
</method>
<method name="query_latency"
c:identifier="gst_harness_query_latency"
version="1.6">
<doc xml:space="preserve">Get the min latency reported by any harnessed #GstElement.
MT safe.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #GstClockTime with min latency</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
</parameters>
</method>
<method name="set"
c:identifier="gst_harness_set"
version="1.6"
introspectable="0">
<doc xml:space="preserve">A convenience function to allows you to call g_object_set on a #GstElement
that are residing inside the #GstHarness, by using normal g_object_set
syntax.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="element_name" transfer-ownership="none">
<doc xml:space="preserve">a #gchar with a #GstElementFactory name</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="first_property_name" transfer-ownership="none">
<doc xml:space="preserve">a #gchar with the first property name</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">value for the first property, followed optionally by more
name/value pairs, followed by %NULL</doc>
<varargs/>
</parameter>
</parameters>
</method>
<method name="set_blocking_push_mode"
c:identifier="gst_harness_set_blocking_push_mode"
version="1.6">
<doc xml:space="preserve">Setting this will make the harness block in the chain-function, and
then release when gst_harness_pull() or gst_harness_try_pull() is called.
Can be useful when wanting to control a src-element that is not implementing
gst_clock_id_wait() so it can't be controlled by the #GstTestClock, since
it otherwise would produce buffers as fast as possible.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_caps"
c:identifier="gst_harness_set_caps"
version="1.6">
<doc xml:space="preserve">Sets the @GstHarness srcpad and sinkpad caps.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="in" transfer-ownership="full">
<doc xml:space="preserve">a #GstCaps to set on the harness srcpad</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
<parameter name="out" transfer-ownership="full">
<doc xml:space="preserve">a #GstCaps to set on the harness sinkpad</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
</parameters>
</method>
<method name="set_caps_str"
c:identifier="gst_harness_set_caps_str"
version="1.6">
<doc xml:space="preserve">Sets the @GstHarness srcpad and sinkpad caps using strings.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="in" transfer-ownership="none">
<doc xml:space="preserve">a @gchar describing a #GstCaps to set on the harness srcpad</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="out" transfer-ownership="none">
<doc xml:space="preserve">a @gchar describing a #GstCaps to set on the harness sinkpad</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_drop_buffers"
c:identifier="gst_harness_set_drop_buffers"
version="1.6">
<doc xml:space="preserve">When set to %TRUE, instead of placing the buffers arriving from the harnessed
#GstElement inside the sinkpads #GAsyncQueue, they are instead unreffed.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="drop_buffers" transfer-ownership="none">
<doc xml:space="preserve">a #gboolean specifying to drop outgoing buffers or not</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_forwarding"
c:identifier="gst_harness_set_forwarding"
version="1.6">
<doc xml:space="preserve">As a convenience, a src-harness will forward %GST_EVENT_STREAM_START,
%GST_EVENT_CAPS and %GST_EVENT_SEGMENT to the main-harness if forwarding
is enabled, and forward any sticky-events from the main-harness to
the sink-harness. It will also forward the %GST_QUERY_ALLOCATION.
If forwarding is disabled, the user will have to either manually push
these events from the src-harness using gst_harness_src_push_event(), or
create and push them manually. While this will allow full control and
inspection of these events, for the most cases having forwarding enabled
will be sufficient when writing a test where the src-harness' main function
is providing data for the main-harness.
Forwarding is enabled by default.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="forwarding" transfer-ownership="none">
<doc xml:space="preserve">a #gboolean to enable/disable forwarding</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_propose_allocator"
c:identifier="gst_harness_set_propose_allocator"
version="1.6">
<doc xml:space="preserve">Sets the @allocator and @params to propose when receiving an allocation
query.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="allocator"
transfer-ownership="full"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #GstAllocator</doc>
<type name="Gst.Allocator" c:type="GstAllocator*"/>
</parameter>
<parameter name="params"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #GstAllocationParams</doc>
<type name="Gst.AllocationParams"
c:type="const GstAllocationParams*"/>
</parameter>
</parameters>
</method>
<method name="set_sink_caps"
c:identifier="gst_harness_set_sink_caps"
version="1.6">
<doc xml:space="preserve">Sets the @GstHarness sinkpad caps.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="caps" transfer-ownership="full">
<doc xml:space="preserve">a #GstCaps to set on the harness sinkpad</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
</parameters>
</method>
<method name="set_sink_caps_str"
c:identifier="gst_harness_set_sink_caps_str"
version="1.6">
<doc xml:space="preserve">Sets the @GstHarness sinkpad caps using a string.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="str" transfer-ownership="none">
<doc xml:space="preserve">a @gchar describing a #GstCaps to set on the harness sinkpad</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_src_caps"
c:identifier="gst_harness_set_src_caps"
version="1.6">
<doc xml:space="preserve">Sets the @GstHarness srcpad caps. This must be done before any buffers
can legally be pushed from the harness to the element.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="caps" transfer-ownership="full">
<doc xml:space="preserve">a #GstCaps to set on the harness srcpad</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
</parameters>
</method>
<method name="set_src_caps_str"
c:identifier="gst_harness_set_src_caps_str"
version="1.6">
<doc xml:space="preserve">Sets the @GstHarness srcpad caps using a string. This must be done before
any buffers can legally be pushed from the harness to the element.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="str" transfer-ownership="none">
<doc xml:space="preserve">a @gchar describing a #GstCaps to set on the harness srcpad</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_time"
c:identifier="gst_harness_set_time"
version="1.6">
<doc xml:space="preserve">Advance the #GstTestClock to a specific time.
MT safe.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a @gboolean %TRUE if the time could be set. %FALSE if not.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="time" transfer-ownership="none">
<doc xml:space="preserve">a #GstClockTime to advance the clock to</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</parameter>
</parameters>
</method>
<method name="set_upstream_latency"
c:identifier="gst_harness_set_upstream_latency"
version="1.6">
<doc xml:space="preserve">Sets the min latency reported by #GstHarness when receiving a latency-query</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="latency" transfer-ownership="none">
<doc xml:space="preserve">a #GstClockTime specifying the latency</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</parameter>
</parameters>
</method>
<method name="sink_push_many"
c:identifier="gst_harness_sink_push_many"
version="1.6">
<doc xml:space="preserve">Convenience that calls gst_harness_push_to_sink @pushes number of times.
Will abort the pushing if any one push fails.
MT safe.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #GstFlowReturn with the result of the push</doc>
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="pushes" transfer-ownership="none">
<doc xml:space="preserve">a #gint with the number of calls to gst_harness_push_to_sink</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="src_crank_and_push_many"
c:identifier="gst_harness_src_crank_and_push_many"
version="1.6">
<doc xml:space="preserve">Transfer data from the src-#GstHarness to the main-#GstHarness. Similar to
gst_harness_push_from_src, this variant allows you to specify how many cranks
and how many pushes to perform. This can be useful for both moving a lot
of data at the same time, as well as cases when one crank does not equal one
buffer to push and v.v.
MT safe.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #GstFlowReturn with the result of the push</doc>
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="cranks" transfer-ownership="none">
<doc xml:space="preserve">a #gint with the number of calls to gst_harness_crank_single_clock_wait</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="pushes" transfer-ownership="none">
<doc xml:space="preserve">a #gint with the number of calls to gst_harness_push</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="src_push_event"
c:identifier="gst_harness_src_push_event"
version="1.6">
<doc xml:space="preserve">Similar to what gst_harness_src_push does with #GstBuffers, this transfers
a #GstEvent from the src-#GstHarness to the main-#GstHarness. Note that
some #GstEvents are being transferred automagically. Look at sink_forward_pad
for details.
MT safe.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #gboolean with the result of the push</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
</parameters>
</method>
<method name="stress_custom_start"
c:identifier="gst_harness_stress_custom_start"
version="1.6"
introspectable="0">
<doc xml:space="preserve">Start a custom stress-thread that will call your @callback for every
iteration allowing you to do something nasty.
MT safe.</doc>
<return-value>
<doc xml:space="preserve">a #GstHarnessThread</doc>
<type name="HarnessThread" c:type="GstHarnessThread*"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="init"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #GFunc that is called initially and only once</doc>
<type name="GLib.Func" c:type="GFunc"/>
</parameter>
<parameter name="callback" transfer-ownership="none" closure="2">
<doc xml:space="preserve">a #GFunc that is called as often as possible</doc>
<type name="GLib.Func" c:type="GFunc"/>
</parameter>
<parameter name="data"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #gpointer with custom data to pass to the @callback function</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="sleep" transfer-ownership="none">
<doc xml:space="preserve">a #gulong specifying how long to sleep in (microseconds) for
each call to the @callback</doc>
<type name="gulong" c:type="gulong"/>
</parameter>
</parameters>
</method>
<method name="stress_property_start_full"
c:identifier="gst_harness_stress_property_start_full"
version="1.6"
introspectable="0">
<doc xml:space="preserve">Call g_object_set with @name and @value in intervals of @sleep microseconds
MT safe.</doc>
<return-value>
<doc xml:space="preserve">a #GstHarnessThread</doc>
<type name="HarnessThread" c:type="GstHarnessThread*"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="name" transfer-ownership="none">
<doc xml:space="preserve">a #gchar specifying a property name</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">a #GValue to set the property to</doc>
<type name="GObject.Value" c:type="const GValue*"/>
</parameter>
<parameter name="sleep" transfer-ownership="none">
<doc xml:space="preserve">a #gulong specifying how long to sleep in (microseconds) for
each g_object_set with @name and @value</doc>
<type name="gulong" c:type="gulong"/>
</parameter>
</parameters>
</method>
<method name="stress_push_buffer_start_full"
c:identifier="gst_harness_stress_push_buffer_start_full"
version="1.6"
introspectable="0">
<doc xml:space="preserve">Push a #GstBuffer in intervals of @sleep microseconds.
MT safe.</doc>
<return-value>
<doc xml:space="preserve">a #GstHarnessThread</doc>
<type name="HarnessThread" c:type="GstHarnessThread*"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="caps" transfer-ownership="none">
<doc xml:space="preserve">a #GstCaps for the #GstBuffer</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
<parameter name="segment" transfer-ownership="none">
<doc xml:space="preserve">a #GstSegment</doc>
<type name="Gst.Segment" c:type="const GstSegment*"/>
</parameter>
<parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">a #GstBuffer to push</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</parameter>
<parameter name="sleep" transfer-ownership="none">
<doc xml:space="preserve">a #gulong specifying how long to sleep in (microseconds) for
each call to gst_pad_push</doc>
<type name="gulong" c:type="gulong"/>
</parameter>
</parameters>
</method>
<method name="stress_push_buffer_with_cb_start_full"
c:identifier="gst_harness_stress_push_buffer_with_cb_start_full"
version="1.6"
introspectable="0">
<doc xml:space="preserve">Push a #GstBuffer returned by @func in intervals of @sleep microseconds.
MT safe.</doc>
<return-value>
<doc xml:space="preserve">a #GstHarnessThread</doc>
<type name="HarnessThread" c:type="GstHarnessThread*"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="caps" transfer-ownership="none">
<doc xml:space="preserve">a #GstCaps for the #GstBuffer</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
<parameter name="segment" transfer-ownership="none">
<doc xml:space="preserve">a #GstSegment</doc>
<type name="Gst.Segment" c:type="const GstSegment*"/>
</parameter>
<parameter name="func"
transfer-ownership="none"
scope="notified"
closure="3"
destroy="4">
<doc xml:space="preserve">a #GstHarnessPrepareBufferFunc function called before every iteration
to prepare / create a #GstBuffer for pushing</doc>
<type name="HarnessPrepareBufferFunc"
c:type="GstHarnessPrepareBufferFunc"/>
</parameter>
<parameter name="data"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #gpointer with data to the #GstHarnessPrepareBufferFunc function</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="notify" transfer-ownership="none" scope="async">
<doc xml:space="preserve">a #GDestroyNotify that is called when thread is stopped</doc>
<type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
</parameter>
<parameter name="sleep" transfer-ownership="none">
<doc xml:space="preserve">a #gulong specifying how long to sleep in (microseconds) for
each call to gst_pad_push</doc>
<type name="gulong" c:type="gulong"/>
</parameter>
</parameters>
</method>
<method name="stress_push_event_start_full"
c:identifier="gst_harness_stress_push_event_start_full"
version="1.6"
introspectable="0">
<doc xml:space="preserve">Push the @event onto the harnessed #GstElement sinkpad in intervals of
@sleep microseconds
MT safe.</doc>
<return-value>
<doc xml:space="preserve">a #GstHarnessThread</doc>
<type name="HarnessThread" c:type="GstHarnessThread*"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="event" transfer-ownership="none">
<doc xml:space="preserve">a #GstEvent to push</doc>
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
<parameter name="sleep" transfer-ownership="none">
<doc xml:space="preserve">a #gulong specifying how long to sleep in (microseconds) for
each gst_event_push with @event</doc>
<type name="gulong" c:type="gulong"/>
</parameter>
</parameters>
</method>
<method name="stress_push_event_with_cb_start_full"
c:identifier="gst_harness_stress_push_event_with_cb_start_full"
version="1.8"
introspectable="0">
<doc xml:space="preserve">Push a #GstEvent returned by @func onto the harnessed #GstElement sinkpad
in intervals of @sleep microseconds.
MT safe.</doc>
<return-value>
<doc xml:space="preserve">a #GstHarnessThread</doc>
<type name="HarnessThread" c:type="GstHarnessThread*"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="func"
transfer-ownership="none"
scope="notified"
closure="1"
destroy="2">
<doc xml:space="preserve">a #GstHarnessPrepareEventFunc function called before every iteration
to prepare / create a #GstEvent for pushing</doc>
<type name="HarnessPrepareEventFunc"
c:type="GstHarnessPrepareEventFunc"/>
</parameter>
<parameter name="data"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #gpointer with data to the #GstHarnessPrepareEventFunc function</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="notify" transfer-ownership="none" scope="async">
<doc xml:space="preserve">a #GDestroyNotify that is called when thread is stopped</doc>
<type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
</parameter>
<parameter name="sleep" transfer-ownership="none">
<doc xml:space="preserve">a #gulong specifying how long to sleep in (microseconds) for
each call to gst_pad_push</doc>
<type name="gulong" c:type="gulong"/>
</parameter>
</parameters>
</method>
<method name="stress_push_upstream_event_start_full"
c:identifier="gst_harness_stress_push_upstream_event_start_full"
version="1.6"
introspectable="0">
<doc xml:space="preserve">Push the @event onto the harnessed #GstElement srcpad in intervals of
@sleep microseconds.
MT safe.</doc>
<return-value>
<doc xml:space="preserve">a #GstHarnessThread</doc>
<type name="HarnessThread" c:type="GstHarnessThread*"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="event" transfer-ownership="none">
<doc xml:space="preserve">a #GstEvent to push</doc>
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
<parameter name="sleep" transfer-ownership="none">
<doc xml:space="preserve">a #gulong specifying how long to sleep in (microseconds) for
each gst_event_push with @event</doc>
<type name="gulong" c:type="gulong"/>
</parameter>
</parameters>
</method>
<method name="stress_push_upstream_event_with_cb_start_full"
c:identifier="gst_harness_stress_push_upstream_event_with_cb_start_full"
version="1.8"
introspectable="0">
<doc xml:space="preserve">Push a #GstEvent returned by @func onto the harnessed #GstElement srcpad
in intervals of @sleep microseconds.
MT safe.</doc>
<return-value>
<doc xml:space="preserve">a #GstHarnessThread</doc>
<type name="HarnessThread" c:type="GstHarnessThread*"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="func"
transfer-ownership="none"
scope="notified"
closure="1"
destroy="2">
<doc xml:space="preserve">a #GstHarnessPrepareEventFunc function called before every iteration
to prepare / create a #GstEvent for pushing</doc>
<type name="HarnessPrepareEventFunc"
c:type="GstHarnessPrepareEventFunc"/>
</parameter>
<parameter name="data"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #gpointer with data to the #GstHarnessPrepareEventFunc function</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="notify" transfer-ownership="none" scope="async">
<doc xml:space="preserve">a #GDestroyNotify that is called when thread is stopped</doc>
<type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
</parameter>
<parameter name="sleep" transfer-ownership="none">
<doc xml:space="preserve">a #gulong specifying how long to sleep in (microseconds) for
each call to gst_pad_push</doc>
<type name="gulong" c:type="gulong"/>
</parameter>
</parameters>
</method>
<method name="stress_requestpad_start_full"
c:identifier="gst_harness_stress_requestpad_start_full"
version="1.6"
introspectable="0">
<doc xml:space="preserve">Call gst_element_request_pad in intervals of @sleep microseconds
MT safe.</doc>
<return-value>
<doc xml:space="preserve">a #GstHarnessThread</doc>
<type name="HarnessThread" c:type="GstHarnessThread*"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="templ" transfer-ownership="none">
<doc xml:space="preserve">a #GstPadTemplate</doc>
<type name="Gst.PadTemplate" c:type="GstPadTemplate*"/>
</parameter>
<parameter name="name" transfer-ownership="none">
<doc xml:space="preserve">a #gchar</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="caps" transfer-ownership="none">
<doc xml:space="preserve">a #GstCaps</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
<parameter name="release" transfer-ownership="none">
<doc xml:space="preserve">a #gboolean</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
<parameter name="sleep" transfer-ownership="none">
<doc xml:space="preserve">a #gulong specifying how long to sleep in (microseconds) for
each gst_element_request_pad</doc>
<type name="gulong" c:type="gulong"/>
</parameter>
</parameters>
</method>
<method name="stress_statechange_start_full"
c:identifier="gst_harness_stress_statechange_start_full"
version="1.6"
introspectable="0">
<doc xml:space="preserve">Change the state of your harnessed #GstElement from NULL to PLAYING and
back again, only pausing for @sleep microseconds every time.
MT safe.</doc>
<return-value>
<doc xml:space="preserve">a #GstHarnessThread</doc>
<type name="HarnessThread" c:type="GstHarnessThread*"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="sleep" transfer-ownership="none">
<doc xml:space="preserve">a #gulong specifying how long to sleep in (microseconds) for
each state-change</doc>
<type name="gulong" c:type="gulong"/>
</parameter>
</parameters>
</method>
<method name="teardown"
c:identifier="gst_harness_teardown"
version="1.6">
<doc xml:space="preserve">Tears down a @GstHarness, freeing all resources allocated using it.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
</parameters>
</method>
<method name="try_pull"
c:identifier="gst_harness_try_pull"
version="1.6">
<doc xml:space="preserve">Pulls a #GstBuffer from the #GAsyncQueue on the #GstHarness sinkpad. Unlike
gst_harness_pull this will not wait for any buffers if not any are present,
and return %NULL straight away.
MT safe.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GstBuffer or %NULL if no buffers are present in the #GAsyncQueue</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
</parameters>
</method>
<method name="try_pull_event"
c:identifier="gst_harness_try_pull_event"
version="1.6">
<doc xml:space="preserve">Pulls an #GstEvent from the #GAsyncQueue on the #GstHarness sinkpad.
See gst_harness_try_pull for details.
MT safe.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GstEvent or %NULL if no buffers are present in the #GAsyncQueue</doc>
<type name="Gst.Event" c:type="GstEvent*"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
</parameters>
</method>
<method name="try_pull_upstream_event"
c:identifier="gst_harness_try_pull_upstream_event"
version="1.6">
<doc xml:space="preserve">Pulls an #GstEvent from the #GAsyncQueue on the #GstHarness srcpad.
See gst_harness_try_pull for details.
MT safe.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GstEvent or %NULL if no buffers are present in the #GAsyncQueue</doc>
<type name="Gst.Event" c:type="GstEvent*"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
</parameters>
</method>
<method name="upstream_events_in_queue"
c:identifier="gst_harness_upstream_events_in_queue"
version="1.6">
<doc xml:space="preserve">The number of #GstEvents currently in the #GstHarness srcpad #GAsyncQueue
MT safe.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #guint number of events in the queue</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
</parameters>
</method>
<method name="upstream_events_received"
c:identifier="gst_harness_upstream_events_received"
version="1.6">
<doc xml:space="preserve">The total number of #GstEvents that has arrived on the #GstHarness srcpad
This number includes events handled by the harness as well as events
that have already been pulled out.
MT safe.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #guint number of events received</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
</parameters>
</method>
<method name="use_systemclock"
c:identifier="gst_harness_use_systemclock"
version="1.6">
<doc xml:space="preserve">Sets the system #GstClock on the @GstHarness #GstElement
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
</parameters>
</method>
<method name="use_testclock"
c:identifier="gst_harness_use_testclock"
version="1.6">
<doc xml:space="preserve">Sets the #GstTestClock on the #GstHarness #GstElement
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
</parameters>
</method>
<method name="wait_for_clock_id_waits"
c:identifier="gst_harness_wait_for_clock_id_waits"
version="1.6">
<doc xml:space="preserve">Waits for @timeout seconds until @waits number of #GstClockID waits is
registered with the #GstTestClock. Useful for writing deterministic tests,
where you want to make sure that an expected number of waits have been
reached.
MT safe.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a @gboolean %TRUE if the waits have been registered, %FALSE if not.
(Could be that it timed out waiting or that more waits then waits was found)</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</instance-parameter>
<parameter name="waits" transfer-ownership="none">
<doc xml:space="preserve">a #guint describing the numbers of #GstClockID registered with
the #GstTestClock</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="timeout" transfer-ownership="none">
<doc xml:space="preserve">a #guint describing how many seconds to wait for @waits to be true</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<function name="new"
c:identifier="gst_harness_new"
version="1.6"
introspectable="0">
<doc xml:space="preserve">Creates a new harness. Works like gst_harness_new_with_padnames(), except it
assumes the #GstElement sinkpad is named "sink" and srcpad is named "src"
MT safe.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GstHarness, or %NULL if the harness could
not be created</doc>
<type name="Harness" c:type="GstHarness*"/>
</return-value>
<parameters>
<parameter name="element_name" transfer-ownership="none">
<doc xml:space="preserve">a #gchar describing the #GstElement name</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="new_empty"
c:identifier="gst_harness_new_empty"
version="1.8"
introspectable="0">
<doc xml:space="preserve">Creates a new empty harness. Use gst_harness_add_element_full() to add
an #GstElement to it.
MT safe.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GstHarness, or %NULL if the harness could
not be created</doc>
<type name="Harness" c:type="GstHarness*"/>
</return-value>
</function>
<function name="new_full"
c:identifier="gst_harness_new_full"
version="1.6"
introspectable="0">
<doc xml:space="preserve">Creates a new harness.
MT safe.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GstHarness, or %NULL if the harness could
not be created</doc>
<type name="Harness" c:type="GstHarness*"/>
</return-value>
<parameters>
<parameter name="element" transfer-ownership="none">
<doc xml:space="preserve">a #GstElement to attach the harness to (transfer none)</doc>
<type name="Gst.Element" c:type="GstElement*"/>
</parameter>
<parameter name="hsrc"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #GstStaticPadTemplate describing the harness srcpad.
%NULL will not create a harness srcpad.</doc>
<type name="Gst.StaticPadTemplate" c:type="GstStaticPadTemplate*"/>
</parameter>
<parameter name="element_sinkpad_name"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #gchar with the name of the element
sinkpad that is then linked to the harness srcpad. Can be a static or request
or a sometimes pad that has been added. %NULL will not get/request a sinkpad
from the element. (Like if the element is a src.)</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="hsink"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #GstStaticPadTemplate describing the harness sinkpad.
%NULL will not create a harness sinkpad.</doc>
<type name="Gst.StaticPadTemplate" c:type="GstStaticPadTemplate*"/>
</parameter>
<parameter name="element_srcpad_name"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #gchar with the name of the element
srcpad that is then linked to the harness sinkpad, similar to the
@element_sinkpad_name.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="new_parse"
c:identifier="gst_harness_new_parse"
version="1.6"
introspectable="0">
<doc xml:space="preserve">Creates a new harness, parsing the @launchline and putting that in a #GstBin,
and then attches the harness to the bin.
MT safe.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GstHarness, or %NULL if the harness could
not be created</doc>
<type name="Harness" c:type="GstHarness*"/>
</return-value>
<parameters>
<parameter name="launchline" transfer-ownership="none">
<doc xml:space="preserve">a #gchar describing a gst-launch type line</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="new_with_element"
c:identifier="gst_harness_new_with_element"
version="1.6"
introspectable="0">
<doc xml:space="preserve">Creates a new harness. Works in the same way as gst_harness_new_full(), only
that generic padtemplates are used for the harness src and sinkpads, which
will be sufficient in most usecases.
MT safe.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GstHarness, or %NULL if the harness could
not be created</doc>
<type name="Harness" c:type="GstHarness*"/>
</return-value>
<parameters>
<parameter name="element" transfer-ownership="none">
<doc xml:space="preserve">a #GstElement to attach the harness to (transfer none)</doc>
<type name="Gst.Element" c:type="GstElement*"/>
</parameter>
<parameter name="element_sinkpad_name"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #gchar with the name of the element
sinkpad that is then linked to the harness srcpad. %NULL does not attach a
sinkpad</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="element_srcpad_name"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #gchar with the name of the element
srcpad that is then linked to the harness sinkpad. %NULL does not attach a
srcpad</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="new_with_padnames"
c:identifier="gst_harness_new_with_padnames"
version="1.6"
introspectable="0">
<doc xml:space="preserve">Creates a new harness. Works like gst_harness_new_with_element(),
except you specify the factoryname of the #GstElement
MT safe.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GstHarness, or %NULL if the harness could
not be created</doc>
<type name="Harness" c:type="GstHarness*"/>
</return-value>
<parameters>
<parameter name="element_name" transfer-ownership="none">
<doc xml:space="preserve">a #gchar describing the #GstElement name</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="element_sinkpad_name"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #gchar with the name of the element
sinkpad that is then linked to the harness srcpad. %NULL does not attach a
sinkpad</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="element_srcpad_name"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #gchar with the name of the element
srcpad that is then linked to the harness sinkpad. %NULL does not attach a
srcpad</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="new_with_templates"
c:identifier="gst_harness_new_with_templates"
version="1.6"
introspectable="0">
<doc xml:space="preserve">Creates a new harness, like gst_harness_new_full(), except it
assumes the #GstElement sinkpad is named "sink" and srcpad is named "src"
MT safe.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GstHarness, or %NULL if the harness could
not be created</doc>
<type name="Harness" c:type="GstHarness*"/>
</return-value>
<parameters>
<parameter name="element_name" transfer-ownership="none">
<doc xml:space="preserve">a #gchar describing the #GstElement name</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="hsrc"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #GstStaticPadTemplate describing the harness srcpad.
%NULL will not create a harness srcpad.</doc>
<type name="Gst.StaticPadTemplate" c:type="GstStaticPadTemplate*"/>
</parameter>
<parameter name="hsink"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #GstStaticPadTemplate describing the harness sinkpad.
%NULL will not create a harness sinkpad.</doc>
<type name="Gst.StaticPadTemplate" c:type="GstStaticPadTemplate*"/>
</parameter>
</parameters>
</function>
<function name="stress_thread_stop"
c:identifier="gst_harness_stress_thread_stop"
version="1.6">
<doc xml:space="preserve">Stop the running #GstHarnessThread
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<parameter name="t" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarnessThread</doc>
<type name="HarnessThread" c:type="GstHarnessThread*"/>
</parameter>
</parameters>
</function>
</record>
<callback name="HarnessPrepareBufferFunc"
c:type="GstHarnessPrepareBufferFunc"
version="1.6">
<return-value transfer-ownership="full">
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</return-value>
<parameters>
<parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</parameter>
<parameter name="data"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">user data</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
<callback name="HarnessPrepareEventFunc"
c:type="GstHarnessPrepareEventFunc"
version="1.8">
<return-value transfer-ownership="full">
<type name="Gst.Event" c:type="GstEvent*"/>
</return-value>
<parameters>
<parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarness</doc>
<type name="Harness" c:type="GstHarness*"/>
</parameter>
<parameter name="data"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">user data</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
<record name="HarnessPrivate" c:type="GstHarnessPrivate" disguised="1">
</record>
<record name="HarnessThread"
c:type="GstHarnessThread"
disguised="1"
version="1.6">
<doc xml:space="preserve">Opaque handle representing a GstHarness stress testing thread.</doc>
</record>
<record name="StreamConsistency"
c:type="GstStreamConsistency"
disguised="1">
<doc xml:space="preserve">Opaque consistency checker handle.</doc>
</record>
<class name="TestClock"
c:symbol-prefix="test_clock"
c:type="GstTestClock"
version="1.2"
parent="Gst.Clock"
glib:type-name="GstTestClock"
glib:get-type="gst_test_clock_get_type"
glib:type-struct="TestClockClass">
<doc xml:space="preserve">GstTestClock is an implementation of #GstClock which has different
behaviour compared to #GstSystemClock. Time for #GstSystemClock advances
according to the system time, while time for #GstTestClock changes only
when gst_test_clock_set_time() or gst_test_clock_advance_time() are
called. #GstTestClock provides unit tests with the possibility to
precisely advance the time in a deterministic manner, independent of the
system time or any other external factors.
<example>
<title>Advancing the time of a #GstTestClock</title>
<programlisting language="c">
#include &lt;gst/gst.h&gt;
#include &lt;gst/check/gsttestclock.h&gt;
GstClock *clock;
GstTestClock *test_clock;
clock = gst_test_clock_new ();
test_clock = GST_TEST_CLOCK (clock);
GST_INFO ("Time: %" GST_TIME_FORMAT, GST_TIME_ARGS (gst_clock_get_time (clock)));
gst_test_clock_advance_time ( test_clock, 1 * GST_SECOND);
GST_INFO ("Time: %" GST_TIME_FORMAT, GST_TIME_ARGS (gst_clock_get_time (clock)));
g_usleep (10 * G_USEC_PER_SEC);
GST_INFO ("Time: %" GST_TIME_FORMAT, GST_TIME_ARGS (gst_clock_get_time (clock)));
gst_test_clock_set_time (test_clock, 42 * GST_SECOND);
GST_INFO ("Time: %" GST_TIME_FORMAT, GST_TIME_ARGS (gst_clock_get_time (clock)));
...
</programlisting>
</example>
#GstClock allows for setting up single shot or periodic clock notifications
as well as waiting for these notifications synchronously (using
gst_clock_id_wait()) or asynchronously (using gst_clock_id_wait_async() or
gst_clock_id_wait_async()). This is used by many GStreamer elements,
among them #GstBaseSrc and #GstBaseSink.
#GstTestClock keeps track of these clock notifications. By calling
gst_test_clock_wait_for_next_pending_id() or
gst_test_clock_wait_for_multiple_pending_ids() a unit tests may wait for the
next one or several clock notifications to be requested. Additionally unit
tests may release blocked waits in a controlled fashion by calling
gst_test_clock_process_next_clock_id(). This way a unit test can control the
inaccuracy (jitter) of clock notifications, since the test can decide to
release blocked waits when the clock time has advanced exactly to, or past,
the requested clock notification time.
There are also interfaces for determining if a notification belongs to a
#GstTestClock or not, as well as getting the number of requested clock
notifications so far.
N.B.: When a unit test waits for a certain amount of clock notifications to
be requested in gst_test_clock_wait_for_next_pending_id() or
gst_test_clock_wait_for_multiple_pending_ids() then these functions may block
for a long time. If they block forever then the expected clock notifications
were never requested from #GstTestClock, and so the assumptions in the code
of the unit test are wrong. The unit test case runner in gstcheck is
expected to catch these cases either by the default test case timeout or the
one set for the unit test by calling tcase_set_timeout\(\).
The sample code below assumes that the element under test will delay a
buffer pushed on the source pad by some latency until it arrives on the sink
pad. Moreover it is assumed that the element will at some point call
gst_clock_id_wait() to synchronously wait for a specific time. The first
buffer sent will arrive exactly on time only delayed by the latency. The
second buffer will arrive a little late (7ms) due to simulated jitter in the
clock notification.
<example>
<title>Demonstration of how to work with clock notifications and #GstTestClock</title>
<programlisting language="c">
#include &lt;gst/gst.h&gt;
#include &lt;gst/check/gstcheck.h&gt;
#include &lt;gst/check/gsttestclock.h&gt;
GstClockTime latency;
GstElement *element;
GstPad *srcpad;
GstClock *clock;
GstTestClock *test_clock;
GstBuffer buf;
GstClockID pending_id;
GstClockID processed_id;
latency = 42 * GST_MSECOND;
element = create_element (latency, ...);
srcpad = get_source_pad (element);
clock = gst_test_clock_new ();
test_clock = GST_TEST_CLOCK (clock);
gst_element_set_clock (element, clock);
GST_INFO ("Set time, create and push the first buffer\n");
gst_test_clock_set_time (test_clock, 0);
buf = create_test_buffer (gst_clock_get_time (clock), ...);
gst_assert_cmpint (gst_pad_push (srcpad, buf), ==, GST_FLOW_OK);
GST_INFO ("Block until element is waiting for a clock notification\n");
gst_test_clock_wait_for_next_pending_id (test_clock, &pending_id);
GST_INFO ("Advance to the requested time of the clock notification\n");
gst_test_clock_advance_time (test_clock, latency);
GST_INFO ("Release the next blocking wait and make sure it is the one from element\n");
processed_id = gst_test_clock_process_next_clock_id (test_clock);
g_assert (processed_id == pending_id);
g_assert_cmpint (GST_CLOCK_ENTRY_STATUS (processed_id), ==, GST_CLOCK_OK);
gst_clock_id_unref (pending_id);
gst_clock_id_unref (processed_id);
GST_INFO ("Validate that element produced an output buffer and check its timestamp\n");
g_assert_cmpint (get_number_of_output_buffer (...), ==, 1);
buf = get_buffer_pushed_by_element (element, ...);
g_assert_cmpint (GST_BUFFER_TIMESTAMP (buf), ==, latency);
gst_buffer_unref (buf);
GST_INFO ("Check that element does not wait for any clock notification\n");
g_assert (!gst_test_clock_peek_next_pending_id (test_clock, NULL));
GST_INFO ("Set time, create and push the second buffer\n");
gst_test_clock_advance_time (test_clock, 10 * GST_SECOND);
buf = create_test_buffer (gst_clock_get_time (clock), ...);
gst_assert_cmpint (gst_pad_push (srcpad, buf), ==, GST_FLOW_OK);
GST_INFO ("Block until element is waiting for a new clock notification\n");
(gst_test_clock_wait_for_next_pending_id (test_clock, &pending_id);
GST_INFO ("Advance past 7ms beyond the requested time of the clock notification\n");
gst_test_clock_advance_time (test_clock, latency + 7 * GST_MSECOND);
GST_INFO ("Release the next blocking wait and make sure it is the one from element\n");
processed_id = gst_test_clock_process_next_clock_id (test_clock);
g_assert (processed_id == pending_id);
g_assert_cmpint (GST_CLOCK_ENTRY_STATUS (processed_id), ==, GST_CLOCK_OK);
gst_clock_id_unref (pending_id);
gst_clock_id_unref (processed_id);
GST_INFO ("Validate that element produced an output buffer and check its timestamp\n");
g_assert_cmpint (get_number_of_output_buffer (...), ==, 1);
buf = get_buffer_pushed_by_element (element, ...);
g_assert_cmpint (GST_BUFFER_TIMESTAMP (buf), ==,
10 * GST_SECOND + latency + 7 * GST_MSECOND);
gst_buffer_unref (buf);
GST_INFO ("Check that element does not wait for any clock notification\n");
g_assert (!gst_test_clock_peek_next_pending_id (test_clock, NULL));
...
</programlisting>
</example>
Since #GstTestClock is only supposed to be used in unit tests it calls
g_assert(), g_assert_cmpint() or g_assert_cmpuint() to validate all function
arguments. This will highlight any issues with the unit test code itself.</doc>
<constructor name="new" c:identifier="gst_test_clock_new" version="1.2">
<doc xml:space="preserve">Creates a new test clock with its time set to zero.
MT safe.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GstTestClock cast to #GstClock.</doc>
<type name="Gst.Clock" c:type="GstClock*"/>
</return-value>
</constructor>
<constructor name="new_with_start_time"
c:identifier="gst_test_clock_new_with_start_time"
version="1.2">
<doc xml:space="preserve">Creates a new test clock with its time set to the specified time.
MT safe.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GstTestClock cast to #GstClock.</doc>
<type name="Gst.Clock" c:type="GstClock*"/>
</return-value>
<parameters>
<parameter name="start_time" transfer-ownership="none">
<doc xml:space="preserve">a #GstClockTime set to the desired start time of the clock.</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</parameter>
</parameters>
</constructor>
<function name="id_list_get_latest_time"
c:identifier="gst_test_clock_id_list_get_latest_time"
version="1.4">
<doc xml:space="preserve">Finds the latest time inside the list.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</return-value>
<parameters>
<parameter name="pending_list"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">List
of of pending #GstClockIDs</doc>
<type name="GLib.List" c:type="const GList*">
<type name="Gst.ClockID"/>
</type>
</parameter>
</parameters>
</function>
<method name="advance_time"
c:identifier="gst_test_clock_advance_time"
version="1.2">
<doc xml:space="preserve">Advances the time of the @test_clock by the amount given by @delta. The
time of @test_clock is monotonically increasing, therefore providing a
@delta which is negative or zero is a programming error.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="test_clock" transfer-ownership="none">
<doc xml:space="preserve">a #GstTestClock for which to increase the time</doc>
<type name="TestClock" c:type="GstTestClock*"/>
</instance-parameter>
<parameter name="delta" transfer-ownership="none">
<doc xml:space="preserve">a positive #GstClockTimeDiff to be added to the time of the clock</doc>
<type name="Gst.ClockTimeDiff" c:type="GstClockTimeDiff"/>
</parameter>
</parameters>
</method>
<method name="crank" c:identifier="gst_test_clock_crank" version="1.8">
<doc xml:space="preserve">A "crank" consists of three steps:
1: Wait for a #GstClockID to be registered with the #GstTestClock.
2: Advance the #GstTestClock to the time the #GstClockID is waiting for.
3: Release the #GstClockID wait.
A "crank" can be though of as the notion of
manually driving the clock forward to its next logical step.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the crank was successful, %FALSE otherwise.
MT safe.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="test_clock" transfer-ownership="none">
<doc xml:space="preserve">#GstTestClock to crank</doc>
<type name="TestClock" c:type="GstTestClock*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_next_entry_time"
c:identifier="gst_test_clock_get_next_entry_time"
version="1.2">
<doc xml:space="preserve">Retrieve the requested time for the next pending clock notification.
MT safe.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #GstClockTime set to the time of the next pending clock
notification. If no clock notifications have been requested
%GST_CLOCK_TIME_NONE will be returned.</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</return-value>
<parameters>
<instance-parameter name="test_clock" transfer-ownership="none">
<doc xml:space="preserve">a #GstTestClock to fetch the next clock notification time for</doc>
<type name="TestClock" c:type="GstTestClock*"/>
</instance-parameter>
</parameters>
</method>
<method name="has_id" c:identifier="gst_test_clock_has_id" version="1.2">
<doc xml:space="preserve">Checks whether @test_clock was requested to provide the clock notification
given by @id.
MT safe.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the clock has been asked to provide the given clock
notification, %FALSE otherwise.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="test_clock" transfer-ownership="none">
<doc xml:space="preserve">a #GstTestClock to ask if it provided the notification</doc>
<type name="TestClock" c:type="GstTestClock*"/>
</instance-parameter>
<parameter name="id" transfer-ownership="none">
<doc xml:space="preserve">a #GstClockID clock notification</doc>
<type name="Gst.ClockID" c:type="GstClockID"/>
</parameter>
</parameters>
</method>
<method name="peek_id_count"
c:identifier="gst_test_clock_peek_id_count"
version="1.2">
<doc xml:space="preserve">Determine the number of pending clock notifications that have been
requested from the @test_clock.
MT safe.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the number of pending clock notifications.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="test_clock" transfer-ownership="none">
<doc xml:space="preserve">a #GstTestClock for which to count notifications</doc>
<type name="TestClock" c:type="GstTestClock*"/>
</instance-parameter>
</parameters>
</method>
<method name="peek_next_pending_id"
c:identifier="gst_test_clock_peek_next_pending_id"
version="1.2">
<doc xml:space="preserve">Determines if the @pending_id is the next clock notification scheduled to
be triggered given the current time of the @test_clock.
MT safe.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @pending_id is the next clock notification to be
triggered, %FALSE otherwise.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="test_clock" transfer-ownership="none">
<doc xml:space="preserve">a #GstTestClock to check the clock notifications for</doc>
<type name="TestClock" c:type="GstTestClock*"/>
</instance-parameter>
<parameter name="pending_id"
direction="out"
caller-allocates="0"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve">a #GstClockID clock
notification to look for</doc>
<type name="Gst.ClockID" c:type="GstClockID*"/>
</parameter>
</parameters>
</method>
<method name="process_id_list"
c:identifier="gst_test_clock_process_id_list"
version="1.4">
<doc xml:space="preserve">Processes and releases the pending IDs in the list.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="test_clock" transfer-ownership="none">
<doc xml:space="preserve">#GstTestClock for which to process the pending IDs</doc>
<type name="TestClock" c:type="GstTestClock*"/>
</instance-parameter>
<parameter name="pending_list"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">List
of pending #GstClockIDs</doc>
<type name="GLib.List" c:type="const GList*">
<type name="Gst.ClockID"/>
</type>
</parameter>
</parameters>
</method>
<method name="process_next_clock_id"
c:identifier="gst_test_clock_process_next_clock_id"
version="1.2">
<doc xml:space="preserve">MT safe.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GstClockID containing the next pending clock
notification.</doc>
<type name="Gst.ClockID" c:type="GstClockID"/>
</return-value>
<parameters>
<instance-parameter name="test_clock" transfer-ownership="none">
<doc xml:space="preserve">a #GstTestClock for which to retrieve the next pending clock
notification</doc>
<type name="TestClock" c:type="GstTestClock*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_time"
c:identifier="gst_test_clock_set_time"
version="1.2">
<doc xml:space="preserve">Sets the time of @test_clock to the time given by @new_time. The time of
@test_clock is monotonically increasing, therefore providing a @new_time
which is earlier or equal to the time of the clock as given by
gst_clock_get_time() is a programming error.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="test_clock" transfer-ownership="none">
<doc xml:space="preserve">a #GstTestClock of which to set the time</doc>
<type name="TestClock" c:type="GstTestClock*"/>
</instance-parameter>
<parameter name="new_time" transfer-ownership="none">
<doc xml:space="preserve">a #GstClockTime later than that returned by gst_clock_get_time()</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</parameter>
</parameters>
</method>
<method name="wait_for_multiple_pending_ids"
c:identifier="gst_test_clock_wait_for_multiple_pending_ids"
version="1.4">
<doc xml:space="preserve">Blocks until at least @count clock notifications have been requested from
@test_clock. There is no timeout for this wait, see the main description of
#GstTestClock.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="test_clock" transfer-ownership="none">
<doc xml:space="preserve">#GstTestClock for which to await having enough pending clock</doc>
<type name="TestClock" c:type="GstTestClock*"/>
</instance-parameter>
<parameter name="count" transfer-ownership="none">
<doc xml:space="preserve">the number of pending clock notifications to wait for</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="pending_list"
direction="out"
caller-allocates="0"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve">Address
of a #GList pointer variable to store the list of pending #GstClockIDs
that expired, or %NULL</doc>
<type name="GLib.List" c:type="GList**">
<type name="Gst.ClockID"/>
</type>
</parameter>
</parameters>
</method>
<method name="wait_for_next_pending_id"
c:identifier="gst_test_clock_wait_for_next_pending_id"
version="1.2">
<doc xml:space="preserve">Waits until a clock notification is requested from @test_clock. There is no
timeout for this wait, see the main description of #GstTestClock. A reference
to the pending clock notification is stored in @pending_id.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="test_clock" transfer-ownership="none">
<doc xml:space="preserve">#GstTestClock for which to get the pending clock notification</doc>
<type name="TestClock" c:type="GstTestClock*"/>
</instance-parameter>
<parameter name="pending_id"
direction="out"
caller-allocates="0"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve">#GstClockID
with information about the pending clock notification</doc>
<type name="Gst.ClockID" c:type="GstClockID*"/>
</parameter>
</parameters>
</method>
<method name="wait_for_pending_id_count"
c:identifier="gst_test_clock_wait_for_pending_id_count"
version="1.2"
deprecated="1">
<doc xml:space="preserve">Blocks until at least @count clock notifications have been requested from
@test_clock. There is no timeout for this wait, see the main description of
#GstTestClock.</doc>
<doc-deprecated xml:space="preserve">use gst_test_clock_wait_for_multiple_pending_ids() instead.</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="test_clock" transfer-ownership="none">
<doc xml:space="preserve">#GstTestClock for which to await having enough pending clock</doc>
<type name="TestClock" c:type="GstTestClock*"/>
</instance-parameter>
<parameter name="count" transfer-ownership="none">
<doc xml:space="preserve">the number of pending clock notifications to wait for</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<property name="clock-type" writable="1" transfer-ownership="none">
<type name="Gst.ClockType"/>
</property>
<property name="start-time"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve">When a #GstTestClock is constructed it will have a certain start time set.
If the clock was created using gst_test_clock_new_with_start_time() then
this property contains the value of the @start_time argument. If
gst_test_clock_new() was called the clock started at time zero, and thus
this property contains the value 0.</doc>
<type name="guint64" c:type="guint64"/>
</property>
<field name="parent">
<type name="Gst.Clock" c:type="GstClock"/>
</field>
<field name="priv" readable="0" private="1">
<type name="TestClockPrivate" c:type="GstTestClockPrivate*"/>
</field>
</class>
<record name="TestClockClass"
c:type="GstTestClockClass"
glib:is-gtype-struct-for="TestClock"
version="1.2">
<doc xml:space="preserve">The class of a #GstTestClock, which has no virtual methods to override.</doc>
<field name="parent_class">
<doc xml:space="preserve">the parent class structure</doc>
<type name="Gst.ClockClass" c:type="GstClockClass"/>
</field>
</record>
<record name="TestClockPrivate" c:type="GstTestClockPrivate" disguised="1">
</record>
<function name="buffer_straw_get_buffer"
c:identifier="gst_buffer_straw_get_buffer">
<doc xml:space="preserve">Get one buffer from @pad. Implemented via buffer probes. This function will
block until the pipeline passes a buffer over @pad, so for robust behavior
in unit tests, you need to use check's timeout to fail out in the case that a
buffer never arrives.
You must have previously called gst_buffer_straw_start_pipeline() on
@pipeline and @pad.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the captured #GstBuffer.</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</return-value>
<parameters>
<parameter name="bin" transfer-ownership="none">
<doc xml:space="preserve">the pipeline previously started via gst_buffer_straw_start_pipeline()</doc>
<type name="Gst.Element" c:type="GstElement*"/>
</parameter>
<parameter name="pad" transfer-ownership="none">
<doc xml:space="preserve">the pad previously passed to gst_buffer_straw_start_pipeline()</doc>
<type name="Gst.Pad" c:type="GstPad*"/>
</parameter>
</parameters>
</function>
<function name="buffer_straw_start_pipeline"
c:identifier="gst_buffer_straw_start_pipeline">
<doc xml:space="preserve">Sets up a pipeline for buffer sucking. This will allow you to call
gst_buffer_straw_get_buffer() to access buffers as they pass over @pad.
This function is normally used in unit tests that want to verify that a
particular element is outputting correct buffers. For example, you would make
a pipeline via gst_parse_launch(), pull out the pad you want to monitor, then
call gst_buffer_straw_get_buffer() to get the buffers that pass through @pad.
The pipeline will block until you have sucked off the buffers.
This function will set the state of @bin to PLAYING; to clean up, be sure to
call gst_buffer_straw_stop_pipeline().
Note that you may not start two buffer straws at the same time. This function
is intended for unit tests, not general API use. In fact it calls fail_if
from libcheck, so you cannot use it outside unit tests.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="bin" transfer-ownership="none">
<doc xml:space="preserve">the pipeline to run</doc>
<type name="Gst.Element" c:type="GstElement*"/>
</parameter>
<parameter name="pad" transfer-ownership="none">
<doc xml:space="preserve">a pad on an element in @bin</doc>
<type name="Gst.Pad" c:type="GstPad*"/>
</parameter>
</parameters>
</function>
<function name="buffer_straw_stop_pipeline"
c:identifier="gst_buffer_straw_stop_pipeline">
<doc xml:space="preserve">Set @bin to #GST_STATE_NULL and release resource allocated in
gst_buffer_straw_start_pipeline().
You must have previously called gst_buffer_straw_start_pipeline() on
@pipeline and @pad.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="bin" transfer-ownership="none">
<doc xml:space="preserve">the pipeline previously started via gst_buffer_straw_start_pipeline()</doc>
<type name="Gst.Element" c:type="GstElement*"/>
</parameter>
<parameter name="pad" transfer-ownership="none">
<doc xml:space="preserve">the pad previously passed to gst_buffer_straw_start_pipeline()</doc>
<type name="Gst.Pad" c:type="GstPad*"/>
</parameter>
</parameters>
</function>
<function name="check_abi_list" c:identifier="gst_check_abi_list">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="list" transfer-ownership="none">
<type name="CheckABIStruct" c:type="GstCheckABIStruct"/>
</parameter>
<parameter name="have_abi_sizes" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</function>
<function name="check_buffer_data" c:identifier="gst_check_buffer_data">
<doc xml:space="preserve">Compare the buffer contents with @data and @size.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve">buffer to compare</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</parameter>
<parameter name="data"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">data to compare to</doc>
<type name="gpointer" c:type="gconstpointer"/>
</parameter>
<parameter name="size" transfer-ownership="none">
<doc xml:space="preserve">size of data to compare</doc>
<type name="gsize" c:type="gsize"/>
</parameter>
</parameters>
</function>
<function name="check_caps_equal" c:identifier="gst_check_caps_equal">
<doc xml:space="preserve">Compare two caps with gst_caps_is_equal and fail unless they are
equal.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="caps1" transfer-ownership="none">
<doc xml:space="preserve">first caps to compare</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
<parameter name="caps2" transfer-ownership="none">
<doc xml:space="preserve">second caps to compare</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
</parameters>
</function>
<function name="check_chain_func" c:identifier="gst_check_chain_func">
<return-value transfer-ownership="none">
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<parameter name="pad" transfer-ownership="none">
<type name="Gst.Pad" c:type="GstPad*"/>
</parameter>
<parameter name="parent" transfer-ownership="none">
<type name="Gst.Object" c:type="GstObject*"/>
</parameter>
<parameter name="buffer" transfer-ownership="none">
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</parameter>
</parameters>
</function>
<function name="check_drop_buffers" c:identifier="gst_check_drop_buffers">
<doc xml:space="preserve">Unref and remove all buffers that are in the global @buffers GList,
emptying the list.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</function>
<function name="check_element_push_buffer"
c:identifier="gst_check_element_push_buffer">
<doc xml:space="preserve">Create an element using the factory providing the @element_name and
push the @buffer_in to this element. The element should create one buffer
and this will be compared with @buffer_out. We only check the caps
and the data of the buffers. This function unrefs the buffers.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="element_name" transfer-ownership="none">
<doc xml:space="preserve">name of the element that needs to be created</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="buffer_in" transfer-ownership="none">
<doc xml:space="preserve">push this buffer to the element</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</parameter>
<parameter name="caps_in" transfer-ownership="none">
<doc xml:space="preserve">the #GstCaps expected of the sinkpad of the element</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
<parameter name="buffer_out" transfer-ownership="none">
<doc xml:space="preserve">compare the result with this buffer</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</parameter>
<parameter name="caps_out" transfer-ownership="none">
<doc xml:space="preserve">the #GstCaps expected of the srcpad of the element</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
</parameters>
</function>
<function name="check_element_push_buffer_list"
c:identifier="gst_check_element_push_buffer_list">
<doc xml:space="preserve">Create an element using the factory providing the @element_name and push the
buffers in @buffer_in to this element. The element should create the buffers
equal to the buffers in @buffer_out. We only check the size and the data of
the buffers. This function unrefs the buffers in the two lists.
The last_flow_return parameter indicates the expected flow return value from
pushing the final buffer in the list.
This can be used to set up a test which pushes some buffers and then an
invalid buffer, when the final buffer is expected to fail, for example.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="element_name" transfer-ownership="none">
<doc xml:space="preserve">name of the element that needs to be created</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="buffer_in" transfer-ownership="full">
<doc xml:space="preserve">a list of buffers that needs to be
pushed to the element</doc>
<type name="GLib.List" c:type="GList*">
<type name="Gst.Buffer"/>
</type>
</parameter>
<parameter name="caps_in" transfer-ownership="none">
<doc xml:space="preserve">the #GstCaps expected of the sinkpad of the element</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
<parameter name="buffer_out" transfer-ownership="full">
<doc xml:space="preserve">a list of buffers that we expect from
the element</doc>
<type name="GLib.List" c:type="GList*">
<type name="Gst.Buffer"/>
</type>
</parameter>
<parameter name="caps_out" transfer-ownership="none">
<doc xml:space="preserve">the #GstCaps expected of the srcpad of the element</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
<parameter name="last_flow_return" transfer-ownership="none">
<doc xml:space="preserve">the last buffer push needs to give this GstFlowReturn</doc>
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</parameter>
</parameters>
</function>
<function name="check_init" c:identifier="gst_check_init">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="argc" transfer-ownership="none">
<type name="gint" c:type="int*"/>
</parameter>
<parameter name="argv" transfer-ownership="none">
<type name="utf8" c:type="char**"/>
</parameter>
</parameters>
</function>
<function name="check_message_error"
c:identifier="gst_check_message_error">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="message" transfer-ownership="none">
<type name="Gst.Message" c:type="GstMessage*"/>
</parameter>
<parameter name="type" transfer-ownership="none">
<type name="Gst.MessageType" c:type="GstMessageType"/>
</parameter>
<parameter name="domain" transfer-ownership="none">
<type name="GLib.Quark" c:type="GQuark"/>
</parameter>
<parameter name="code" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</function>
<function name="check_object_destroyed_on_unref"
c:identifier="gst_check_object_destroyed_on_unref"
version="1.6">
<doc xml:space="preserve">Unrefs @object_to_unref and checks that is has properly been
destroyed.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="object_to_unref"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">The #GObject to unref</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</function>
<function name="check_objects_destroyed_on_unref"
c:identifier="gst_check_objects_destroyed_on_unref"
version="1.6"
introspectable="0">
<doc xml:space="preserve">Unrefs @object_to_unref and checks that is has properly been
destroyed, also checks that the other objects passed in
parametter have been destroyed as a concequence of
unrefing @object_to_unref. Last variable argument should be NULL.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="object_to_unref"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">The #GObject to unref</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="first_object"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">The first object that should be destroyed as a
concequence of unrefing @object_to_unref.</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">Additional object that should have been destroyed.</doc>
<varargs/>
</parameter>
</parameters>
</function>
<function name="check_run_suite"
c:identifier="gst_check_run_suite"
introspectable="0">
<return-value transfer-ownership="none">
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<parameter name="suite" transfer-ownership="none">
<type c:type="Suite*"/>
</parameter>
<parameter name="name" transfer-ownership="none">
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="fname" transfer-ownership="none">
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="check_setup_element"
c:identifier="gst_check_setup_element">
<doc xml:space="preserve">setup an element for a filter test with mysrcpad and mysinkpad</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new element</doc>
<type name="Gst.Element" c:type="GstElement*"/>
</return-value>
<parameters>
<parameter name="factory" transfer-ownership="none">
<doc xml:space="preserve">factory</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="check_setup_events" c:identifier="gst_check_setup_events">
<doc xml:space="preserve">Push stream-start, caps and segment event, which consist of the minimum
required events to allow streaming. Caps is optional to allow raw src
testing. If @element has more than one src or sink pad, use
gst_check_setup_events_with_stream_id() instead.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="srcpad" transfer-ownership="none">
<doc xml:space="preserve">The src #GstPad to push on</doc>
<type name="Gst.Pad" c:type="GstPad*"/>
</parameter>
<parameter name="element" transfer-ownership="none">
<doc xml:space="preserve">The #GstElement use to create the stream id</doc>
<type name="Gst.Element" c:type="GstElement*"/>
</parameter>
<parameter name="caps"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">#GstCaps in case caps event must be sent</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">The #GstFormat of the default segment to send</doc>
<type name="Gst.Format" c:type="GstFormat"/>
</parameter>
</parameters>
</function>
<function name="check_setup_events_with_stream_id"
c:identifier="gst_check_setup_events_with_stream_id">
<doc xml:space="preserve">Push stream-start, caps and segment event, which consist of the minimum
required events to allow streaming. Caps is optional to allow raw src
testing.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="srcpad" transfer-ownership="none">
<doc xml:space="preserve">The src #GstPad to push on</doc>
<type name="Gst.Pad" c:type="GstPad*"/>
</parameter>
<parameter name="element" transfer-ownership="none">
<doc xml:space="preserve">The #GstElement use to create the stream id</doc>
<type name="Gst.Element" c:type="GstElement*"/>
</parameter>
<parameter name="caps"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">#GstCaps in case caps event must be sent</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">The #GstFormat of the default segment to send</doc>
<type name="Gst.Format" c:type="GstFormat"/>
</parameter>
<parameter name="stream_id" transfer-ownership="none">
<doc xml:space="preserve">A unique identifier for the stream</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="check_setup_sink_pad"
c:identifier="gst_check_setup_sink_pad">
<doc xml:space="preserve">Does the same as #gst_check_setup_sink_pad_by_name with the <emphasis> name </emphasis> parameter equal to "src".</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new pad that can be used to check the output of @element</doc>
<type name="Gst.Pad" c:type="GstPad*"/>
</return-value>
<parameters>
<parameter name="element" transfer-ownership="none">
<doc xml:space="preserve">element to setup pad on</doc>
<type name="Gst.Element" c:type="GstElement*"/>
</parameter>
<parameter name="tmpl" transfer-ownership="none">
<doc xml:space="preserve">pad template</doc>
<type name="Gst.StaticPadTemplate" c:type="GstStaticPadTemplate*"/>
</parameter>
</parameters>
</function>
<function name="check_setup_sink_pad_by_name"
c:identifier="gst_check_setup_sink_pad_by_name">
<doc xml:space="preserve">Creates a new sink pad (based on the given @tmpl) and links it to the given @element src pad
(the pad that matches the given @name).
You can set event/chain/query functions on this pad to check the output of the @element.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new pad that can be used to check the output of @element</doc>
<type name="Gst.Pad" c:type="GstPad*"/>
</return-value>
<parameters>
<parameter name="element" transfer-ownership="none">
<doc xml:space="preserve">element to setup pad on</doc>
<type name="Gst.Element" c:type="GstElement*"/>
</parameter>
<parameter name="tmpl" transfer-ownership="none">
<doc xml:space="preserve">pad template</doc>
<type name="Gst.StaticPadTemplate" c:type="GstStaticPadTemplate*"/>
</parameter>
<parameter name="name" transfer-ownership="none">
<doc xml:space="preserve">Name of the @element src pad that will be linked to the sink pad that will be setup</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="check_setup_sink_pad_by_name_from_template"
c:identifier="gst_check_setup_sink_pad_by_name_from_template"
version="1.4">
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new pad</doc>
<type name="Gst.Pad" c:type="GstPad*"/>
</return-value>
<parameters>
<parameter name="element" transfer-ownership="none">
<doc xml:space="preserve">element to setup pad on</doc>
<type name="Gst.Element" c:type="GstElement*"/>
</parameter>
<parameter name="tmpl" transfer-ownership="none">
<doc xml:space="preserve">pad template</doc>
<type name="Gst.PadTemplate" c:type="GstPadTemplate*"/>
</parameter>
<parameter name="name" transfer-ownership="none">
<doc xml:space="preserve">name</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="check_setup_sink_pad_from_template"
c:identifier="gst_check_setup_sink_pad_from_template"
version="1.4">
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new pad</doc>
<type name="Gst.Pad" c:type="GstPad*"/>
</return-value>
<parameters>
<parameter name="element" transfer-ownership="none">
<doc xml:space="preserve">element to setup pad on</doc>
<type name="Gst.Element" c:type="GstElement*"/>
</parameter>
<parameter name="tmpl" transfer-ownership="none">
<doc xml:space="preserve">pad template</doc>
<type name="Gst.PadTemplate" c:type="GstPadTemplate*"/>
</parameter>
</parameters>
</function>
<function name="check_setup_src_pad"
c:identifier="gst_check_setup_src_pad">
<doc xml:space="preserve">Does the same as #gst_check_setup_src_pad_by_name with the <emphasis> name </emphasis> parameter equal to "sink".</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A new pad that can be used to inject data on @element</doc>
<type name="Gst.Pad" c:type="GstPad*"/>
</return-value>
<parameters>
<parameter name="element" transfer-ownership="none">
<doc xml:space="preserve">element to setup pad on</doc>
<type name="Gst.Element" c:type="GstElement*"/>
</parameter>
<parameter name="tmpl" transfer-ownership="none">
<doc xml:space="preserve">pad template</doc>
<type name="Gst.StaticPadTemplate" c:type="GstStaticPadTemplate*"/>
</parameter>
</parameters>
</function>
<function name="check_setup_src_pad_by_name"
c:identifier="gst_check_setup_src_pad_by_name">
<doc xml:space="preserve">Creates a new src pad (based on the given @tmpl) and links it to the given @element sink pad (the pad that matches the given @name).
Before using the src pad to push data on @element you need to call #gst_check_setup_events on the created src pad.
Example of how to push a buffer on @element:
|[<!-- language="C" -->
static GstStaticPadTemplate sinktemplate = GST_STATIC_PAD_TEMPLATE ("sink",
GST_PAD_SINK,
GST_PAD_ALWAYS,
GST_STATIC_CAPS (YOUR_CAPS_TEMPLATE_STRING)
);
static GstStaticPadTemplate srctemplate = GST_STATIC_PAD_TEMPLATE ("src",
GST_PAD_SRC,
GST_PAD_ALWAYS,
GST_STATIC_CAPS (YOUR_CAPS_TEMPLATE_STRING)
);
GstElement * element = gst_check_setup_element ("element");
GstPad * mysrcpad = gst_check_setup_src_pad (element, &srctemplate);
GstPad * mysinkpad = gst_check_setup_sink_pad (element, &sinktemplate);
gst_pad_set_active (mysrcpad, TRUE);
gst_pad_set_active (mysinkpad, TRUE);
fail_unless (gst_element_set_state (element, GST_STATE_PLAYING) == GST_STATE_CHANGE_SUCCESS, "could not set to playing");
GstCaps * caps = gst_caps_from_string (YOUR_DESIRED_SINK_CAPS);
gst_check_setup_events (mysrcpad, element, caps, GST_FORMAT_TIME);
gst_caps_unref (caps);
fail_unless (gst_pad_push (mysrcpad, gst_buffer_new_and_alloc(2)) == GST_FLOW_OK);
]|
For very simple input/output test scenarios checkout #gst_check_element_push_buffer_list and #gst_check_element_push_buffer.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A new pad that can be used to inject data on @element</doc>
<type name="Gst.Pad" c:type="GstPad*"/>
</return-value>
<parameters>
<parameter name="element" transfer-ownership="none">
<doc xml:space="preserve">element to setup src pad on</doc>
<type name="Gst.Element" c:type="GstElement*"/>
</parameter>
<parameter name="tmpl" transfer-ownership="none">
<doc xml:space="preserve">pad template</doc>
<type name="Gst.StaticPadTemplate" c:type="GstStaticPadTemplate*"/>
</parameter>
<parameter name="name" transfer-ownership="none">
<doc xml:space="preserve">Name of the @element sink pad that will be linked to the src pad that will be setup</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="check_setup_src_pad_by_name_from_template"
c:identifier="gst_check_setup_src_pad_by_name_from_template"
version="1.4">
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new pad</doc>
<type name="Gst.Pad" c:type="GstPad*"/>
</return-value>
<parameters>
<parameter name="element" transfer-ownership="none">
<doc xml:space="preserve">element to setup pad on</doc>
<type name="Gst.Element" c:type="GstElement*"/>
</parameter>
<parameter name="tmpl" transfer-ownership="none">
<doc xml:space="preserve">pad template</doc>
<type name="Gst.PadTemplate" c:type="GstPadTemplate*"/>
</parameter>
<parameter name="name" transfer-ownership="none">
<doc xml:space="preserve">name</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="check_setup_src_pad_from_template"
c:identifier="gst_check_setup_src_pad_from_template"
version="1.4">
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new pad</doc>
<type name="Gst.Pad" c:type="GstPad*"/>
</return-value>
<parameters>
<parameter name="element" transfer-ownership="none">
<doc xml:space="preserve">element to setup pad on</doc>
<type name="Gst.Element" c:type="GstElement*"/>
</parameter>
<parameter name="tmpl" transfer-ownership="none">
<doc xml:space="preserve">pad template</doc>
<type name="Gst.PadTemplate" c:type="GstPadTemplate*"/>
</parameter>
</parameters>
</function>
<function name="check_teardown_element"
c:identifier="gst_check_teardown_element">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="element" transfer-ownership="none">
<type name="Gst.Element" c:type="GstElement*"/>
</parameter>
</parameters>
</function>
<function name="check_teardown_pad_by_name"
c:identifier="gst_check_teardown_pad_by_name">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="element" transfer-ownership="none">
<type name="Gst.Element" c:type="GstElement*"/>
</parameter>
<parameter name="name" transfer-ownership="none">
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="check_teardown_sink_pad"
c:identifier="gst_check_teardown_sink_pad">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="element" transfer-ownership="none">
<type name="Gst.Element" c:type="GstElement*"/>
</parameter>
</parameters>
</function>
<function name="check_teardown_src_pad"
c:identifier="gst_check_teardown_src_pad">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="element" transfer-ownership="none">
<type name="Gst.Element" c:type="GstElement*"/>
</parameter>
</parameters>
</function>
<function name="consistency_checker_add_pad"
c:identifier="gst_consistency_checker_add_pad">
<doc xml:space="preserve">Sets up a data probe on the given pad which will raise assertions if the
data flow is inconsistent.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the pad was added</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="consist" transfer-ownership="none">
<doc xml:space="preserve">The #GstStreamConsistency handle</doc>
<type name="StreamConsistency" c:type="GstStreamConsistency*"/>
</parameter>
<parameter name="pad" transfer-ownership="none">
<doc xml:space="preserve">The #GstPad on which the dataflow will be checked.</doc>
<type name="Gst.Pad" c:type="GstPad*"/>
</parameter>
</parameters>
</function>
<function name="consistency_checker_free"
c:identifier="gst_consistency_checker_free">
<doc xml:space="preserve">Frees the allocated data and probes associated with @consist.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="consist" transfer-ownership="none">
<doc xml:space="preserve">The #GstStreamConsistency to free.</doc>
<type name="StreamConsistency" c:type="GstStreamConsistency*"/>
</parameter>
</parameters>
</function>
<function name="consistency_checker_new"
c:identifier="gst_consistency_checker_new"
introspectable="0">
<doc xml:space="preserve">Sets up a data probe on the given pad which will raise assertions if the
data flow is inconsistent.</doc>
<return-value>
<doc xml:space="preserve">A #GstStreamConsistency structure used to track data flow.</doc>
<type name="StreamConsistency" c:type="GstStreamConsistency*"/>
</return-value>
<parameters>
<parameter name="pad" transfer-ownership="none">
<doc xml:space="preserve">The #GstPad on which the dataflow will be checked.</doc>
<type name="Gst.Pad" c:type="GstPad*"/>
</parameter>
</parameters>
</function>
<function name="consistency_checker_reset"
c:identifier="gst_consistency_checker_reset">
<doc xml:space="preserve">Reset the stream checker's internal variables.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="consist" transfer-ownership="none">
<doc xml:space="preserve">The #GstStreamConsistency to reset.</doc>
<type name="StreamConsistency" c:type="GstStreamConsistency*"/>
</parameter>
</parameters>
</function>
<function name="harness_new"
c:identifier="gst_harness_new"
moved-to="Harness.new"
version="1.6"
introspectable="0">
<doc xml:space="preserve">Creates a new harness. Works like gst_harness_new_with_padnames(), except it
assumes the #GstElement sinkpad is named "sink" and srcpad is named "src"
MT safe.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GstHarness, or %NULL if the harness could
not be created</doc>
<type name="Harness" c:type="GstHarness*"/>
</return-value>
<parameters>
<parameter name="element_name" transfer-ownership="none">
<doc xml:space="preserve">a #gchar describing the #GstElement name</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="harness_new_empty"
c:identifier="gst_harness_new_empty"
moved-to="Harness.new_empty"
version="1.8"
introspectable="0">
<doc xml:space="preserve">Creates a new empty harness. Use gst_harness_add_element_full() to add
an #GstElement to it.
MT safe.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GstHarness, or %NULL if the harness could
not be created</doc>
<type name="Harness" c:type="GstHarness*"/>
</return-value>
</function>
<function name="harness_new_full"
c:identifier="gst_harness_new_full"
moved-to="Harness.new_full"
version="1.6"
introspectable="0">
<doc xml:space="preserve">Creates a new harness.
MT safe.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GstHarness, or %NULL if the harness could
not be created</doc>
<type name="Harness" c:type="GstHarness*"/>
</return-value>
<parameters>
<parameter name="element" transfer-ownership="none">
<doc xml:space="preserve">a #GstElement to attach the harness to (transfer none)</doc>
<type name="Gst.Element" c:type="GstElement*"/>
</parameter>
<parameter name="hsrc"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #GstStaticPadTemplate describing the harness srcpad.
%NULL will not create a harness srcpad.</doc>
<type name="Gst.StaticPadTemplate" c:type="GstStaticPadTemplate*"/>
</parameter>
<parameter name="element_sinkpad_name"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #gchar with the name of the element
sinkpad that is then linked to the harness srcpad. Can be a static or request
or a sometimes pad that has been added. %NULL will not get/request a sinkpad
from the element. (Like if the element is a src.)</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="hsink"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #GstStaticPadTemplate describing the harness sinkpad.
%NULL will not create a harness sinkpad.</doc>
<type name="Gst.StaticPadTemplate" c:type="GstStaticPadTemplate*"/>
</parameter>
<parameter name="element_srcpad_name"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #gchar with the name of the element
srcpad that is then linked to the harness sinkpad, similar to the
@element_sinkpad_name.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="harness_new_parse"
c:identifier="gst_harness_new_parse"
moved-to="Harness.new_parse"
version="1.6"
introspectable="0">
<doc xml:space="preserve">Creates a new harness, parsing the @launchline and putting that in a #GstBin,
and then attches the harness to the bin.
MT safe.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GstHarness, or %NULL if the harness could
not be created</doc>
<type name="Harness" c:type="GstHarness*"/>
</return-value>
<parameters>
<parameter name="launchline" transfer-ownership="none">
<doc xml:space="preserve">a #gchar describing a gst-launch type line</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="harness_new_with_element"
c:identifier="gst_harness_new_with_element"
moved-to="Harness.new_with_element"
version="1.6"
introspectable="0">
<doc xml:space="preserve">Creates a new harness. Works in the same way as gst_harness_new_full(), only
that generic padtemplates are used for the harness src and sinkpads, which
will be sufficient in most usecases.
MT safe.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GstHarness, or %NULL if the harness could
not be created</doc>
<type name="Harness" c:type="GstHarness*"/>
</return-value>
<parameters>
<parameter name="element" transfer-ownership="none">
<doc xml:space="preserve">a #GstElement to attach the harness to (transfer none)</doc>
<type name="Gst.Element" c:type="GstElement*"/>
</parameter>
<parameter name="element_sinkpad_name"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #gchar with the name of the element
sinkpad that is then linked to the harness srcpad. %NULL does not attach a
sinkpad</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="element_srcpad_name"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #gchar with the name of the element
srcpad that is then linked to the harness sinkpad. %NULL does not attach a
srcpad</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="harness_new_with_padnames"
c:identifier="gst_harness_new_with_padnames"
moved-to="Harness.new_with_padnames"
version="1.6"
introspectable="0">
<doc xml:space="preserve">Creates a new harness. Works like gst_harness_new_with_element(),
except you specify the factoryname of the #GstElement
MT safe.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GstHarness, or %NULL if the harness could
not be created</doc>
<type name="Harness" c:type="GstHarness*"/>
</return-value>
<parameters>
<parameter name="element_name" transfer-ownership="none">
<doc xml:space="preserve">a #gchar describing the #GstElement name</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="element_sinkpad_name"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #gchar with the name of the element
sinkpad that is then linked to the harness srcpad. %NULL does not attach a
sinkpad</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="element_srcpad_name"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #gchar with the name of the element
srcpad that is then linked to the harness sinkpad. %NULL does not attach a
srcpad</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="harness_new_with_templates"
c:identifier="gst_harness_new_with_templates"
moved-to="Harness.new_with_templates"
version="1.6"
introspectable="0">
<doc xml:space="preserve">Creates a new harness, like gst_harness_new_full(), except it
assumes the #GstElement sinkpad is named "sink" and srcpad is named "src"
MT safe.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GstHarness, or %NULL if the harness could
not be created</doc>
<type name="Harness" c:type="GstHarness*"/>
</return-value>
<parameters>
<parameter name="element_name" transfer-ownership="none">
<doc xml:space="preserve">a #gchar describing the #GstElement name</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="hsrc"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #GstStaticPadTemplate describing the harness srcpad.
%NULL will not create a harness srcpad.</doc>
<type name="Gst.StaticPadTemplate" c:type="GstStaticPadTemplate*"/>
</parameter>
<parameter name="hsink"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #GstStaticPadTemplate describing the harness sinkpad.
%NULL will not create a harness sinkpad.</doc>
<type name="Gst.StaticPadTemplate" c:type="GstStaticPadTemplate*"/>
</parameter>
</parameters>
</function>
<function name="harness_stress_thread_stop"
c:identifier="gst_harness_stress_thread_stop"
moved-to="Harness.stress_thread_stop"
version="1.6">
<doc xml:space="preserve">Stop the running #GstHarnessThread
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<parameter name="t" transfer-ownership="none">
<doc xml:space="preserve">a #GstHarnessThread</doc>
<type name="HarnessThread" c:type="GstHarnessThread*"/>
</parameter>
</parameters>
</function>
</namespace>
</repository>
|