/usr/share/gir-1.0/GstInterfaces-0.10.gir is in libgstreamer-plugins-base0.10-dev 0.10.36-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 | <?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="0.10"/>
<package name="gstreamer-interfaces-0.10"/>
<c:include name="gst/interfaces/colorbalance.h"/>
<c:include name="gst/interfaces/colorbalancechannel.h"/>
<c:include name="gst/interfaces/interfaces-enumtypes.h"/>
<c:include name="gst/interfaces/mixer.h"/>
<c:include name="gst/interfaces/mixeroptions.h"/>
<c:include name="gst/interfaces/mixertrack.h"/>
<c:include name="gst/interfaces/navigation.h"/>
<c:include name="gst/interfaces/propertyprobe.h"/>
<c:include name="gst/interfaces/streamvolume.h"/>
<c:include name="gst/interfaces/tuner.h"/>
<c:include name="gst/interfaces/tunerchannel.h"/>
<c:include name="gst/interfaces/tunernorm.h"/>
<c:include name="gst/interfaces/videoorientation.h"/>
<c:include name="gst/interfaces/xoverlay.h"/>
<namespace name="GstInterfaces"
version="0.10"
shared-library="libgstinterfaces-0.10.so.0"
c:identifier-prefixes="Gst"
c:symbol-prefixes="gst">
<interface name="ColorBalance"
c:symbol-prefix="color_balance"
c:type="GstColorBalance"
glib:type-name="GstColorBalance"
glib:get-type="gst_color_balance_get_type">
<doc xml:space="preserve"><refsect2><para>
This interface is implemented by elements which can perform some color
balance operation on video frames they process. For example, modifying
the brightness, contrast, hue or saturation.
</para><para>
Example elements are 'xvimagesink' and 'colorbalance'
</para>
</refsect2></doc>
<prerequisite name="Gst.Element"/>
<prerequisite name="Gst.ImplementsInterface"/>
<method name="get_balance_type"
c:identifier="gst_color_balance_get_balance_type"
version="0.10.24">
<doc xml:space="preserve">Get the #GstColorBalanceType of this implementation.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">A the #GstColorBalanceType.</doc>
<type name="ColorBalanceType" c:type="GstColorBalanceType"/>
</return-value>
<parameters>
<instance-parameter name="balance" transfer-ownership="none">
<doc xml:space="preserve">The #GstColorBalance implementation</doc>
<type name="ColorBalance" c:type="GstColorBalance*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_value" c:identifier="gst_color_balance_get_value">
<doc xml:space="preserve">Retrieve the current value of the indicated channel, between min_value
and max_value.
See Also: The #GstColorBalanceChannel.min_value and
#GstColorBalanceChannel.max_value members of the
#GstColorBalanceChannel object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The current value of the channel.</doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="balance" transfer-ownership="none">
<doc xml:space="preserve">A #GstColorBalance instance</doc>
<type name="ColorBalance" c:type="GstColorBalance*"/>
</instance-parameter>
<parameter name="channel" transfer-ownership="none">
<doc xml:space="preserve">A #GstColorBalanceChannel instance</doc>
<type name="ColorBalanceChannel" c:type="GstColorBalanceChannel*"/>
</parameter>
</parameters>
</method>
<method name="list_channels"
c:identifier="gst_color_balance_list_channels"
introspectable="0">
<doc xml:space="preserve">Retrieve a list of the available channels.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">A GList containing pointers to #GstColorBalanceChannel objects.
The list is owned by the #GstColorBalance instance and must not
be freed.</doc>
<type name="GLib.List" c:type="const GList*">
<type name="gpointer" c:type="gpointer"/>
</type>
</return-value>
<parameters>
<instance-parameter name="balance" transfer-ownership="none">
<doc xml:space="preserve">A #GstColorBalance instance</doc>
<type name="ColorBalance" c:type="GstColorBalance*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_value" c:identifier="gst_color_balance_set_value">
<doc xml:space="preserve">Sets the current value of the channel to the passed value, which must
be between min_value and max_value.
See Also: The #GstColorBalanceChannel.min_value and
#GstColorBalanceChannel.max_value members of the
#GstColorBalanceChannel object.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="balance" transfer-ownership="none">
<doc xml:space="preserve">A #GstColorBalance instance</doc>
<type name="ColorBalance" c:type="GstColorBalance*"/>
</instance-parameter>
<parameter name="channel" transfer-ownership="none">
<doc xml:space="preserve">A #GstColorBalanceChannel instance</doc>
<type name="ColorBalanceChannel" c:type="GstColorBalanceChannel*"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">The new value for the channel.</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="value_changed"
c:identifier="gst_color_balance_value_changed">
<doc xml:space="preserve">A helper function called by implementations of the GstColorBalance
interface. It fires the #GstColorBalance::value-changed signal on the
instance, and the #GstColorBalanceChannel::value-changed signal on the
channel object.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="balance" transfer-ownership="none">
<doc xml:space="preserve">A #GstColorBalance instance</doc>
<type name="ColorBalance" c:type="GstColorBalance*"/>
</instance-parameter>
<parameter name="channel" transfer-ownership="none">
<doc xml:space="preserve">A #GstColorBalanceChannel whose value has changed</doc>
<type name="ColorBalanceChannel" c:type="GstColorBalanceChannel*"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">The new value of the channel</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<glib:signal name="value-changed" when="last">
<doc xml:space="preserve">Fired when the value of the indicated channel has changed.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="channel" transfer-ownership="none">
<doc xml:space="preserve">The #GstColorBalanceChannel</doc>
<type name="ColorBalanceChannel"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">The new value</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</glib:signal>
</interface>
<class name="ColorBalanceChannel"
c:symbol-prefix="color_balance_channel"
c:type="GstColorBalanceChannel"
parent="GObject.Object"
glib:type-name="GstColorBalanceChannel"
glib:get-type="gst_color_balance_channel_get_type"
glib:type-struct="ColorBalanceChannelClass">
<doc xml:space="preserve"><refsect2><para>The #GstColorBalanceChannel object represents a parameter
for modifying the color balance implemented by an element providing the
#GstColorBalance interface. For example, Hue or Saturation.
</para></refsect2></doc>
<virtual-method name="value_changed">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="channel" transfer-ownership="none">
<type name="ColorBalanceChannel" c:type="GstColorBalanceChannel*"/>
</instance-parameter>
<parameter name="value" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</virtual-method>
<field name="parent">
<type name="GObject.Object" c:type="GObject"/>
</field>
<field name="label">
<doc xml:space="preserve">A string containing a descriptive name for this channel</doc>
<type name="utf8" c:type="gchar*"/>
</field>
<field name="min_value">
<doc xml:space="preserve">The minimum valid value for this channel.</doc>
<type name="gint" c:type="gint"/>
</field>
<field name="max_value">
<doc xml:space="preserve">The maximum valid value for this channel.</doc>
<type name="gint" c:type="gint"/>
</field>
<glib:signal name="value-changed" when="last">
<doc xml:space="preserve">Fired when the value of the indicated channel has changed.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">The new value</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</glib:signal>
</class>
<record name="ColorBalanceChannelClass"
c:type="GstColorBalanceChannelClass"
glib:is-gtype-struct-for="ColorBalanceChannel">
<doc xml:space="preserve">Color-balance channel class.</doc>
<field name="parent">
<doc xml:space="preserve">the parent interface</doc>
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="value_changed">
<callback name="value_changed">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="channel" transfer-ownership="none">
<type name="ColorBalanceChannel"
c:type="GstColorBalanceChannel*"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</callback>
</field>
<field name="_gst_reserved" readable="0" private="1">
<array zero-terminated="0" c:type="gpointer" fixed-size="4">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<record name="ColorBalanceClass" c:type="GstColorBalanceClass">
<doc xml:space="preserve">Color-balance interface.</doc>
<field name="klass" writable="1">
<doc xml:space="preserve">the parent interface</doc>
<type name="GObject.TypeInterface" c:type="GTypeInterface"/>
</field>
<field name="balance_type" writable="1">
<doc xml:space="preserve">implementation type</doc>
<type name="ColorBalanceType" c:type="GstColorBalanceType"/>
</field>
<field name="list_channels" introspectable="0">
<callback name="list_channels" introspectable="0">
<return-value transfer-ownership="none">
<type name="GLib.List" c:type="const GList*">
<type name="gpointer" c:type="gpointer"/>
</type>
</return-value>
<parameters>
<parameter name="balance" transfer-ownership="none">
<type name="ColorBalance" c:type="GstColorBalance*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="set_value">
<callback name="set_value">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="balance" transfer-ownership="none">
<type name="ColorBalance" c:type="GstColorBalance*"/>
</parameter>
<parameter name="channel" transfer-ownership="none">
<type name="ColorBalanceChannel"
c:type="GstColorBalanceChannel*"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</callback>
</field>
<field name="get_value">
<callback name="get_value">
<return-value transfer-ownership="none">
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<parameter name="balance" transfer-ownership="none">
<type name="ColorBalance" c:type="GstColorBalance*"/>
</parameter>
<parameter name="channel" transfer-ownership="none">
<type name="ColorBalanceChannel"
c:type="GstColorBalanceChannel*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="value_changed">
<callback name="value_changed">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="balance" transfer-ownership="none">
<type name="ColorBalance" c:type="GstColorBalance*"/>
</parameter>
<parameter name="channel" transfer-ownership="none">
<type name="ColorBalanceChannel"
c:type="GstColorBalanceChannel*"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</callback>
</field>
<field name="_gst_reserved" readable="0" private="1">
<array zero-terminated="0" c:type="gpointer" fixed-size="4">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<enumeration name="ColorBalanceType"
glib:type-name="GstColorBalanceType"
glib:get-type="gst_color_balance_type_get_type"
c:type="GstColorBalanceType">
<doc xml:space="preserve">An enumeration indicating whether an element implements color balancing
operations in software or in dedicated hardware. In general, dedicated
hardware implementations (such as those provided by xvimagesink) are
preferred.</doc>
<member name="hardware"
value="0"
c:identifier="GST_COLOR_BALANCE_HARDWARE"
glib:nick="hardware">
<doc xml:space="preserve">Color balance is implemented with dedicated
hardware.</doc>
</member>
<member name="software"
value="1"
c:identifier="GST_COLOR_BALANCE_SOFTWARE"
glib:nick="software">
<doc xml:space="preserve">Color balance is implemented via software
processing.</doc>
</member>
</enumeration>
<interface name="Mixer"
c:symbol-prefix="mixer"
c:type="GstMixer"
glib:type-name="GstMixer"
glib:get-type="gst_mixer_get_type">
<doc xml:space="preserve">Basic interface for hardware mixer controls.
Applications rarely need to use this interface, it is provided mainly
for system-level mixer applets and the like. Volume control in playback
applications should be done using a <classname>volume</classname>
element or, if available, using the <quote>volume</quote> property of
the audio sink element used (as provided by <classname>pulsesink</classname>
for example), or even better: just use the <classname>playbin2</classname>
element's <quote>volume</quote> property.
Usage: In order to use the <classname>GstMixer</classname> interface, the
element needs to be at least in READY state (so that the element has opened
the mixer device). Once the element has been set to READY state or higher,
it can be cast to a <classname>GstMixer</classname> using the GST_MIXER
macro (in C) and the mixer API can be used.</doc>
<prerequisite name="Gst.Element"/>
<prerequisite name="Gst.ImplementsInterface"/>
<function name="message_get_type"
c:identifier="gst_mixer_message_get_type"
version="0.10.14">
<doc xml:space="preserve">Check a bus message to see if it is a GstMixer notification
message and return the GstMixerMessageType identifying which
type of notification it is.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The type of the GstMixerMessage, or GST_MIXER_MESSAGE_INVALID
if the message is not a GstMixer notification.</doc>
<type name="MixerMessageType" c:type="GstMixerMessageType"/>
</return-value>
<parameters>
<parameter name="message" transfer-ownership="none">
<doc xml:space="preserve">A GstMessage to inspect.</doc>
<type name="Gst.Message" c:type="GstMessage*"/>
</parameter>
</parameters>
</function>
<function name="message_parse_mute_toggled"
c:identifier="gst_mixer_message_parse_mute_toggled"
version="0.10.14">
<doc xml:space="preserve">Extracts the contents of a mute-toggled bus message. Reads
the GstMixerTrack that has changed, and the new value of the mute
flag.
The GstMixerTrack remains valid until the message is freed.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="message" transfer-ownership="none">
<doc xml:space="preserve">A mute-toggled change notification message.</doc>
<type name="Gst.Message" c:type="GstMessage*"/>
</parameter>
<parameter name="track" transfer-ownership="none">
<doc xml:space="preserve">Pointer to hold a GstMixerTrack object, or NULL.</doc>
<type name="MixerTrack" c:type="GstMixerTrack**"/>
</parameter>
<parameter name="mute" transfer-ownership="none">
<doc xml:space="preserve">A pointer to a gboolean variable, or NULL.</doc>
<type name="gboolean" c:type="gboolean*"/>
</parameter>
</parameters>
</function>
<function name="message_parse_option_changed"
c:identifier="gst_mixer_message_parse_option_changed"
version="0.10.14">
<doc xml:space="preserve">Extracts the GstMixerOptions and new value from a option-changed bus notification
message.
The options and value returned remain valid until the message is freed.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="message" transfer-ownership="none">
<doc xml:space="preserve">A volume-changed change notification message.</doc>
<type name="Gst.Message" c:type="GstMessage*"/>
</parameter>
<parameter name="options" transfer-ownership="none">
<doc xml:space="preserve">Pointer to hold a GstMixerOptions object, or NULL.</doc>
<type name="MixerOptions" c:type="GstMixerOptions**"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">Result location to receive the new options value, or NULL.</doc>
<type name="utf8" c:type="const gchar**"/>
</parameter>
</parameters>
</function>
<function name="message_parse_options_list_changed"
c:identifier="gst_mixer_message_parse_options_list_changed"
version="0.10.18">
<doc xml:space="preserve">Extracts the GstMixerOptions whose value list has changed from an
options-list-changed bus notification message.
The options object returned remains valid until the message is freed. You
do not need to unref it.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="message" transfer-ownership="none">
<doc xml:space="preserve">A volume-changed change notification message.</doc>
<type name="Gst.Message" c:type="GstMessage*"/>
</parameter>
<parameter name="options" transfer-ownership="none">
<doc xml:space="preserve">Pointer to hold a GstMixerOptions object, or NULL.</doc>
<type name="MixerOptions" c:type="GstMixerOptions**"/>
</parameter>
</parameters>
</function>
<function name="message_parse_record_toggled"
c:identifier="gst_mixer_message_parse_record_toggled"
version="0.10.14">
<doc xml:space="preserve">Extracts the contents of a record-toggled bus message. Reads
the GstMixerTrack that has changed, and the new value of the
recording flag.
The GstMixerTrack remains valid until the message is freed.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="message" transfer-ownership="none">
<doc xml:space="preserve">A record-toggled change notification message.</doc>
<type name="Gst.Message" c:type="GstMessage*"/>
</parameter>
<parameter name="track" transfer-ownership="none">
<doc xml:space="preserve">Pointer to hold a GstMixerTrack object, or NULL.</doc>
<type name="MixerTrack" c:type="GstMixerTrack**"/>
</parameter>
<parameter name="record" transfer-ownership="none">
<doc xml:space="preserve">A pointer to a gboolean variable, or NULL.</doc>
<type name="gboolean" c:type="gboolean*"/>
</parameter>
</parameters>
</function>
<function name="message_parse_volume_changed"
c:identifier="gst_mixer_message_parse_volume_changed"
version="0.10.14">
<doc xml:space="preserve">Parses a volume-changed notification message and extracts the track object
it refers to, as well as an array of volumes and the size of the volumes array.
The track object remains valid until the message is freed.
The caller must free the array returned in the volumes parameter using g_free
when they are done with it.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="message" transfer-ownership="none">
<doc xml:space="preserve">A volume-changed change notification message.</doc>
<type name="Gst.Message" c:type="GstMessage*"/>
</parameter>
<parameter name="track" transfer-ownership="none">
<doc xml:space="preserve">Pointer to hold a GstMixerTrack object, or NULL.</doc>
<type name="MixerTrack" c:type="GstMixerTrack**"/>
</parameter>
<parameter name="volumes" transfer-ownership="none">
<doc xml:space="preserve">A pointer to receive an array of gint values, or NULL.</doc>
<type name="gint" c:type="gint**"/>
</parameter>
<parameter name="num_channels" transfer-ownership="none">
<doc xml:space="preserve">Result location to receive the number of channels, or NULL.</doc>
<type name="gint" c:type="gint*"/>
</parameter>
</parameters>
</function>
<method name="get_mixer_flags" c:identifier="gst_mixer_get_mixer_flags">
<doc xml:space="preserve">Get the set of supported flags for this mixer implementation.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">A set of or-ed GstMixerFlags for supported features.</doc>
<type name="MixerFlags" c:type="GstMixerFlags"/>
</return-value>
<parameters>
<instance-parameter name="mixer" transfer-ownership="none">
<doc xml:space="preserve">The #GstMixer implementation</doc>
<type name="Mixer" c:type="GstMixer*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_mixer_type"
c:identifier="gst_mixer_get_mixer_type"
version="0.10.24">
<doc xml:space="preserve">Get the #GstMixerType of this mixer implementation.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">A the #GstMixerType.</doc>
<type name="MixerType" c:type="GstMixerType"/>
</return-value>
<parameters>
<instance-parameter name="mixer" transfer-ownership="none">
<doc xml:space="preserve">The #GstMixer implementation</doc>
<type name="Mixer" c:type="GstMixer*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_option" c:identifier="gst_mixer_get_option">
<doc xml:space="preserve">Get the current value of a name/value option in the mixer.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">current value of the name/value option.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="mixer" transfer-ownership="none">
<doc xml:space="preserve">The #GstMixer (a #GstElement) that owns the optionlist.</doc>
<type name="Mixer" c:type="GstMixer*"/>
</instance-parameter>
<parameter name="opts" transfer-ownership="none">
<doc xml:space="preserve">The #GstMixerOptions that we operate on.</doc>
<type name="MixerOptions" c:type="GstMixerOptions*"/>
</parameter>
</parameters>
</method>
<method name="get_volume" c:identifier="gst_mixer_get_volume">
<doc xml:space="preserve">Get the current volume(s) on the given track.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="mixer" transfer-ownership="none">
<doc xml:space="preserve">the #GstMixer (a #GstElement) that owns the track</doc>
<type name="Mixer" c:type="GstMixer*"/>
</instance-parameter>
<parameter name="track" transfer-ownership="none">
<doc xml:space="preserve">the GstMixerTrack to get the volume from.</doc>
<type name="MixerTrack" c:type="GstMixerTrack*"/>
</parameter>
<parameter name="volumes" transfer-ownership="none">
<doc xml:space="preserve">a pre-allocated array of integers (of size
track->num_channels) to store the current volume
of each channel in the given track in.</doc>
<type name="gint" c:type="gint*"/>
</parameter>
</parameters>
</method>
<method name="list_tracks"
c:identifier="gst_mixer_list_tracks"
introspectable="0">
<doc xml:space="preserve">Returns a list of available tracks for this mixer/element. Note
that it is allowed for sink (output) elements to only provide
the output tracks in this list. Likewise, for sources (inputs),
it is allowed to only provide input elements in this list.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">A #GList consisting of zero or more #GstMixerTracks.
The list is owned by the #GstMixer instance and must not be freed
or modified.</doc>
<type name="GLib.List" c:type="const GList*">
<type name="gpointer" c:type="gpointer"/>
</type>
</return-value>
<parameters>
<instance-parameter name="mixer" transfer-ownership="none">
<doc xml:space="preserve">the #GstMixer (a #GstElement) to get the tracks from.</doc>
<type name="Mixer" c:type="GstMixer*"/>
</instance-parameter>
</parameters>
</method>
<method name="mixer_changed"
c:identifier="gst_mixer_mixer_changed"
version="0.10.18">
<doc xml:space="preserve">This function is called by the mixer implementation to produce
a notification message on the bus indicating that the list of available
mixer tracks for a given mixer object has changed. Applications should
rebuild their interface when they receive this message.
This function only works for GstElements that are implementing the
GstMixer interface, and the element needs to have been provided a bus.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="mixer" transfer-ownership="none">
<doc xml:space="preserve">the #GstMixer (a #GstElement) which has changed</doc>
<type name="Mixer" c:type="GstMixer*"/>
</instance-parameter>
</parameters>
</method>
<method name="mute_toggled" c:identifier="gst_mixer_mute_toggled">
<doc xml:space="preserve">This function is called by the mixer implementation to produce
a notification message on the bus indicating that the given track
has changed mute state.
This function only works for GstElements that are implementing the
GstMixer interface, and the element needs to have been provided a bus.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="mixer" transfer-ownership="none">
<doc xml:space="preserve">the #GstMixer (a #GstElement) that owns the track</doc>
<type name="Mixer" c:type="GstMixer*"/>
</instance-parameter>
<parameter name="track" transfer-ownership="none">
<doc xml:space="preserve">the GstMixerTrack that has change mute state.</doc>
<type name="MixerTrack" c:type="GstMixerTrack*"/>
</parameter>
<parameter name="mute" transfer-ownership="none">
<doc xml:space="preserve">the new state of the mute flag on the track</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="option_changed" c:identifier="gst_mixer_option_changed">
<doc xml:space="preserve">This function is called by the mixer implementation to produce
a notification message on the bus indicating that the given options
object has changed state.
This function only works for GstElements that are implementing the
GstMixer interface, and the element needs to have been provided a bus.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="mixer" transfer-ownership="none">
<doc xml:space="preserve">the #GstMixer (a #GstElement) that owns the options</doc>
<type name="Mixer" c:type="GstMixer*"/>
</instance-parameter>
<parameter name="opts" transfer-ownership="none">
<doc xml:space="preserve">the GstMixerOptions that has changed value.</doc>
<type name="MixerOptions" c:type="GstMixerOptions*"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">the new value of the GstMixerOptions.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="options_list_changed"
c:identifier="gst_mixer_options_list_changed"
version="0.10.18">
<doc xml:space="preserve">This function is called by the mixer implementation to produce
a notification message on the bus indicating that the list of possible
options of a given options object has changed.
The new options are not contained in the message on purpose. Applications
should call gst_mixer_options_get_values() on @opts to make @opts update
its internal state and obtain the new list of values.
This function only works for GstElements that are implementing the
GstMixer interface, and the element needs to have been provided a bus
for this to work.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="mixer" transfer-ownership="none">
<doc xml:space="preserve">the #GstMixer (a #GstElement) that owns the options</doc>
<type name="Mixer" c:type="GstMixer*"/>
</instance-parameter>
<parameter name="opts" transfer-ownership="none">
<doc xml:space="preserve">the GstMixerOptions whose list of values has changed</doc>
<type name="MixerOptions" c:type="GstMixerOptions*"/>
</parameter>
</parameters>
</method>
<method name="record_toggled" c:identifier="gst_mixer_record_toggled">
<doc xml:space="preserve">This function is called by the mixer implementation to produce
a notification message on the bus indicating that the given track
has changed recording state.
This function only works for GstElements that are implementing the
GstMixer interface, and the element needs to have been provided a bus.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="mixer" transfer-ownership="none">
<doc xml:space="preserve">the #GstMixer (a #GstElement) that owns the track</doc>
<type name="Mixer" c:type="GstMixer*"/>
</instance-parameter>
<parameter name="track" transfer-ownership="none">
<doc xml:space="preserve">the GstMixerTrack that has changed recording state.</doc>
<type name="MixerTrack" c:type="GstMixerTrack*"/>
</parameter>
<parameter name="record" transfer-ownership="none">
<doc xml:space="preserve">the new state of the record flag on the track</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_mute" c:identifier="gst_mixer_set_mute">
<doc xml:space="preserve">Mutes or unmutes the given channel. To find out whether a
track is currently muted, use GST_MIXER_TRACK_HAS_FLAG ().</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="mixer" transfer-ownership="none">
<doc xml:space="preserve">the #GstMixer (a #GstElement) that owns the track.</doc>
<type name="Mixer" c:type="GstMixer*"/>
</instance-parameter>
<parameter name="track" transfer-ownership="none">
<doc xml:space="preserve">the #GstMixerTrack to operate on.</doc>
<type name="MixerTrack" c:type="GstMixerTrack*"/>
</parameter>
<parameter name="mute" transfer-ownership="none">
<doc xml:space="preserve">a boolean value indicating whether to turn on or off
muting.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_option" c:identifier="gst_mixer_set_option">
<doc xml:space="preserve">Sets a name/value option in the mixer to the requested value.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="mixer" transfer-ownership="none">
<doc xml:space="preserve">The #GstMixer (a #GstElement) that owns the optionlist.</doc>
<type name="Mixer" c:type="GstMixer*"/>
</instance-parameter>
<parameter name="opts" transfer-ownership="none">
<doc xml:space="preserve">The #GstMixerOptions that we operate on.</doc>
<type name="MixerOptions" c:type="GstMixerOptions*"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">The requested new option value.</doc>
<type name="utf8" c:type="gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_record" c:identifier="gst_mixer_set_record">
<doc xml:space="preserve">Enables or disables recording on the given track. Note that
this is only possible on input tracks, not on output tracks
(see GST_MIXER_TRACK_HAS_FLAG () and the GST_MIXER_TRACK_INPUT
flag).</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="mixer" transfer-ownership="none">
<doc xml:space="preserve">The #GstMixer (a #GstElement) that owns the track.</doc>
<type name="Mixer" c:type="GstMixer*"/>
</instance-parameter>
<parameter name="track" transfer-ownership="none">
<doc xml:space="preserve">the #GstMixerTrack to operate on.</doc>
<type name="MixerTrack" c:type="GstMixerTrack*"/>
</parameter>
<parameter name="record" transfer-ownership="none">
<doc xml:space="preserve">a boolean value that indicates whether to turn on
or off recording.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_volume" c:identifier="gst_mixer_set_volume">
<doc xml:space="preserve">Sets the volume on each channel in a track. Short note about
naming: a track is defined as one separate stream owned by
the mixer/element, such as 'Line-in' or 'Microphone'. A
channel is said to be a mono-stream inside this track. A
stereo track thus contains two channels.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="mixer" transfer-ownership="none">
<doc xml:space="preserve">The #GstMixer (a #GstElement) that owns the track.</doc>
<type name="Mixer" c:type="GstMixer*"/>
</instance-parameter>
<parameter name="track" transfer-ownership="none">
<doc xml:space="preserve">The #GstMixerTrack to set the volume on.</doc>
<type name="MixerTrack" c:type="GstMixerTrack*"/>
</parameter>
<parameter name="volumes" transfer-ownership="none">
<doc xml:space="preserve">an array of integers (of size track->num_channels)
that gives the wanted volume for each channel in
this track.</doc>
<type name="gint" c:type="gint*"/>
</parameter>
</parameters>
</method>
<method name="volume_changed" c:identifier="gst_mixer_volume_changed">
<doc xml:space="preserve">This function is called by the mixer implementation to produce
a notification message on the bus indicating that the volume(s) for the
given track have changed.
This function only works for GstElements that are implementing the
GstMixer interface, and the element needs to have been provided a bus.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="mixer" transfer-ownership="none">
<doc xml:space="preserve">the #GstMixer (a #GstElement) that owns the track</doc>
<type name="Mixer" c:type="GstMixer*"/>
</instance-parameter>
<parameter name="track" transfer-ownership="none">
<doc xml:space="preserve">the GstMixerTrack that has changed.</doc>
<type name="MixerTrack" c:type="GstMixerTrack*"/>
</parameter>
<parameter name="volumes" transfer-ownership="none">
<doc xml:space="preserve">Array of volume values, one per channel on the mixer track.</doc>
<type name="gint" c:type="gint*"/>
</parameter>
</parameters>
</method>
<glib:signal name="mute-toggled" when="last">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="object" transfer-ownership="none">
<type name="MixerTrack"/>
</parameter>
<parameter name="p0" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="option-changed" when="last">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="object" transfer-ownership="none">
<type name="MixerOptions"/>
</parameter>
<parameter name="p0" transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="record-toggled" when="last">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="object" transfer-ownership="none">
<type name="MixerTrack"/>
</parameter>
<parameter name="p0" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="volume-changed" when="last">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="object" transfer-ownership="none">
<type name="MixerTrack"/>
</parameter>
<parameter name="p0" transfer-ownership="none">
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</glib:signal>
</interface>
<record name="MixerClass" c:type="GstMixerClass">
<field name="klass" writable="1">
<type name="GObject.TypeInterface" c:type="GTypeInterface"/>
</field>
<field name="mixer_type" writable="1">
<type name="MixerType" c:type="GstMixerType"/>
</field>
<field name="list_tracks" introspectable="0">
<callback name="list_tracks" introspectable="0">
<return-value transfer-ownership="none">
<type name="GLib.List" c:type="const GList*">
<type name="gpointer" c:type="gpointer"/>
</type>
</return-value>
<parameters>
<parameter name="mixer" transfer-ownership="none">
<type name="Mixer" c:type="GstMixer*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="set_volume">
<callback name="set_volume">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="mixer" transfer-ownership="none">
<type name="Mixer" c:type="GstMixer*"/>
</parameter>
<parameter name="track" transfer-ownership="none">
<type name="MixerTrack" c:type="GstMixerTrack*"/>
</parameter>
<parameter name="volumes" transfer-ownership="none">
<type name="gint" c:type="gint*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="get_volume">
<callback name="get_volume">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="mixer" transfer-ownership="none">
<type name="Mixer" c:type="GstMixer*"/>
</parameter>
<parameter name="track" transfer-ownership="none">
<type name="MixerTrack" c:type="GstMixerTrack*"/>
</parameter>
<parameter name="volumes" transfer-ownership="none">
<type name="gint" c:type="gint*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="set_mute">
<callback name="set_mute">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="mixer" transfer-ownership="none">
<type name="Mixer" c:type="GstMixer*"/>
</parameter>
<parameter name="track" transfer-ownership="none">
<type name="MixerTrack" c:type="GstMixerTrack*"/>
</parameter>
<parameter name="mute" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</callback>
</field>
<field name="set_record">
<callback name="set_record">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="mixer" transfer-ownership="none">
<type name="Mixer" c:type="GstMixer*"/>
</parameter>
<parameter name="track" transfer-ownership="none">
<type name="MixerTrack" c:type="GstMixerTrack*"/>
</parameter>
<parameter name="record" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</callback>
</field>
<field name="mute_toggled">
<callback name="mute_toggled">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="mixer" transfer-ownership="none">
<type name="Mixer" c:type="GstMixer*"/>
</parameter>
<parameter name="channel" transfer-ownership="none">
<type name="MixerTrack" c:type="GstMixerTrack*"/>
</parameter>
<parameter name="mute" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</callback>
</field>
<field name="record_toggled">
<callback name="record_toggled">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="mixer" transfer-ownership="none">
<type name="Mixer" c:type="GstMixer*"/>
</parameter>
<parameter name="channel" transfer-ownership="none">
<type name="MixerTrack" c:type="GstMixerTrack*"/>
</parameter>
<parameter name="record" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</callback>
</field>
<field name="volume_changed">
<callback name="volume_changed">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="mixer" transfer-ownership="none">
<type name="Mixer" c:type="GstMixer*"/>
</parameter>
<parameter name="channel" transfer-ownership="none">
<type name="MixerTrack" c:type="GstMixerTrack*"/>
</parameter>
<parameter name="volumes" transfer-ownership="none">
<type name="gint" c:type="gint*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="set_option">
<callback name="set_option">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="mixer" transfer-ownership="none">
<type name="Mixer" c:type="GstMixer*"/>
</parameter>
<parameter name="opts" transfer-ownership="none">
<type name="MixerOptions" c:type="GstMixerOptions*"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="get_option">
<callback name="get_option">
<return-value transfer-ownership="none">
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="mixer" transfer-ownership="none">
<type name="Mixer" c:type="GstMixer*"/>
</parameter>
<parameter name="opts" transfer-ownership="none">
<type name="MixerOptions" c:type="GstMixerOptions*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="option_changed">
<callback name="option_changed">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="mixer" transfer-ownership="none">
<type name="Mixer" c:type="GstMixer*"/>
</parameter>
<parameter name="opts" transfer-ownership="none">
<type name="MixerOptions" c:type="GstMixerOptions*"/>
</parameter>
<parameter name="option" transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="get_mixer_flags">
<callback name="get_mixer_flags">
<return-value transfer-ownership="none">
<type name="MixerFlags" c:type="GstMixerFlags"/>
</return-value>
<parameters>
<parameter name="mixer" transfer-ownership="none">
<type name="Mixer" c:type="GstMixer*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="_gst_reserved" readable="0" private="1">
<array zero-terminated="0" c:type="gpointer" fixed-size="3">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<bitfield name="MixerFlags"
version="0.10.14"
glib:type-name="GstMixerFlags"
glib:get-type="gst_mixer_flags_get_type"
c:type="GstMixerFlags">
<doc xml:space="preserve">Flags indicating which optional features are supported by a mixer
implementation.</doc>
<member name="none"
value="0"
c:identifier="GST_MIXER_FLAG_NONE"
glib:nick="none">
<doc xml:space="preserve">No flags</doc>
</member>
<member name="auto_notifications"
value="1"
c:identifier="GST_MIXER_FLAG_AUTO_NOTIFICATIONS"
glib:nick="auto-notifications">
<doc xml:space="preserve">The mixer implementation automatically
sends notification messages.</doc>
</member>
<member name="has_whitelist"
value="2"
c:identifier="GST_MIXER_FLAG_HAS_WHITELIST"
glib:nick="has-whitelist">
<doc xml:space="preserve">The mixer implementation flags tracks that
should be displayed by default (whitelisted). Since: 0.10.23</doc>
</member>
<member name="grouping"
value="4"
c:identifier="GST_MIXER_FLAG_GROUPING"
glib:nick="grouping">
<doc xml:space="preserve">The mixer implementation will leave some controls
marked without either input or output. Controls marked as input or
output should be grouped with input & output sliders, even if they
are options or bare switches. Since: 0.10.23</doc>
</member>
</bitfield>
<enumeration name="MixerMessageType"
version="0.10.14"
glib:type-name="GstMixerMessageType"
glib:get-type="gst_mixer_message_type_get_type"
c:type="GstMixerMessageType">
<doc xml:space="preserve">An enumeration for the type of a GstMixer message received on the bus</doc>
<member name="invalid"
value="0"
c:identifier="GST_MIXER_MESSAGE_INVALID"
glib:nick="invalid">
<doc xml:space="preserve">Not a GstMixer message</doc>
</member>
<member name="mute_toggled"
value="1"
c:identifier="GST_MIXER_MESSAGE_MUTE_TOGGLED"
glib:nick="mute-toggled">
<doc xml:space="preserve">A mute-toggled GstMixer message</doc>
</member>
<member name="record_toggled"
value="2"
c:identifier="GST_MIXER_MESSAGE_RECORD_TOGGLED"
glib:nick="record-toggled">
<doc xml:space="preserve">A record-toggled GstMixer message</doc>
</member>
<member name="volume_changed"
value="3"
c:identifier="GST_MIXER_MESSAGE_VOLUME_CHANGED"
glib:nick="volume-changed">
<doc xml:space="preserve">A volume-changed GstMixer message</doc>
</member>
<member name="option_changed"
value="4"
c:identifier="GST_MIXER_MESSAGE_OPTION_CHANGED"
glib:nick="option-changed">
<doc xml:space="preserve">An option-changed GstMixer message</doc>
</member>
<member name="options_list_changed"
value="5"
c:identifier="GST_MIXER_MESSAGE_OPTIONS_LIST_CHANGED"
glib:nick="options-list-changed">
<doc xml:space="preserve">An options-list-changed
GstMixer message, posted when the list of available options for a
GstMixerOptions object has changed (Since: 0.10.18)</doc>
</member>
<member name="mixer_changed"
value="6"
c:identifier="GST_MIXER_MESSAGE_MIXER_CHANGED"
glib:nick="mixer-changed">
<doc xml:space="preserve">A mixer-changed GstMixer message, posted
when the list of available mixer tracks has changed. The application
should re-build its interface in this case (Since: 0.10.18)</doc>
</member>
</enumeration>
<class name="MixerOptions"
c:symbol-prefix="mixer_options"
c:type="GstMixerOptions"
parent="MixerTrack"
glib:type-name="GstMixerOptions"
glib:get-type="gst_mixer_options_get_type"
glib:type-struct="MixerOptionsClass">
<doc xml:space="preserve">Mixer control object that allows switching between multiple options.
Note that <classname>GstMixerOptions</classname> is a subclass of
<classname>GstMixerTrack</classname>.</doc>
<virtual-method name="get_values"
invoker="get_values"
introspectable="0">
<doc xml:space="preserve">Get the values for the mixer option.</doc>
<return-value>
<doc xml:space="preserve">A list of strings with all the possible values for the mixer
option. You must not free or modify the list or its contents, it belongs
to the @mixer_options object.</doc>
<type name="GLib.List" c:type="GList*">
<type name="gpointer" c:type="gpointer"/>
</type>
</return-value>
<parameters>
<instance-parameter name="opts" transfer-ownership="none">
<type name="MixerOptions" c:type="GstMixerOptions*"/>
</instance-parameter>
</parameters>
</virtual-method>
<method name="get_values"
c:identifier="gst_mixer_options_get_values"
introspectable="0">
<doc xml:space="preserve">Get the values for the mixer option.</doc>
<return-value>
<doc xml:space="preserve">A list of strings with all the possible values for the mixer
option. You must not free or modify the list or its contents, it belongs
to the @mixer_options object.</doc>
<type name="GLib.List" c:type="GList*">
<type name="gpointer" c:type="gpointer"/>
</type>
</return-value>
<parameters>
<instance-parameter name="mixer_options" transfer-ownership="none">
<doc xml:space="preserve">The #GstMixerOptions item that owns the values.</doc>
<type name="MixerOptions" c:type="GstMixerOptions*"/>
</instance-parameter>
</parameters>
</method>
<field name="parent">
<type name="MixerTrack" c:type="GstMixerTrack"/>
</field>
<field name="values">
<doc xml:space="preserve">List of option strings. Do not access this member directly,
always use gst_mixer_options_get_values() instead.</doc>
<type name="GLib.List" c:type="GList*">
<type name="gpointer" c:type="gpointer"/>
</type>
</field>
<field name="_gst_reserved" readable="0" private="1">
<array zero-terminated="0" c:type="gpointer" fixed-size="4">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</class>
<record name="MixerOptionsClass"
c:type="GstMixerOptionsClass"
glib:is-gtype-struct-for="MixerOptions">
<field name="parent">
<doc xml:space="preserve">the parent interface</doc>
<type name="MixerTrackClass" c:type="GstMixerTrackClass"/>
</field>
<field name="get_values" introspectable="0">
<callback name="get_values" introspectable="0">
<return-value>
<doc xml:space="preserve">A list of strings with all the possible values for the mixer
option. You must not free or modify the list or its contents, it belongs
to the @mixer_options object.</doc>
<type name="GLib.List" c:type="GList*">
<type name="gpointer" c:type="gpointer"/>
</type>
</return-value>
<parameters>
<parameter name="opts" transfer-ownership="none">
<type name="MixerOptions" c:type="GstMixerOptions*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="_gst_reserved">
<array zero-terminated="0" c:type="gpointer" fixed-size="3">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<class name="MixerTrack"
c:symbol-prefix="mixer_track"
c:type="GstMixerTrack"
parent="GObject.Object"
glib:type-name="GstMixerTrack"
glib:get-type="gst_mixer_track_get_type"
glib:type-struct="MixerTrackClass">
<doc xml:space="preserve">Basic mixer control object (note that it is a GObject and not a GstObject).
A mixer track represents a single slider control of none, one or more
channels. A mixer track with no channels is usually interpreted as a
on/off switch control.
Note the presence of both min_volume and max_volume fields. Applications
must not assume that min_volume is 0 or max_volume is any particular
value.</doc>
<property name="flags" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</property>
<property name="index"
version="0.10.21"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve">Index of the mixer track, if available. Mixer track implementations
must set this at construct time. This can be used to discern between
multiple tracks with identical labels.</doc>
<type name="guint" c:type="guint"/>
</property>
<property name="label" transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="max-volume" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</property>
<property name="min-volume" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</property>
<property name="num-channels" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</property>
<property name="untranslated-label"
version="0.10.13"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve">The untranslated label of the mixer track, if available. Mixer track
implementations must set this at construct time. Applications may find
this useful to determine icons for various kind of tracks. However,
applications mustn't make any assumptions about the naming of tracks,
the untranslated labels are purely informational and may change.</doc>
<type name="utf8" c:type="gchar*"/>
</property>
<field name="parent">
<type name="GObject.Object" c:type="GObject"/>
</field>
<field name="label">
<type name="utf8" c:type="gchar*"/>
</field>
<field name="flags">
<type name="MixerTrackFlags" c:type="GstMixerTrackFlags"/>
</field>
<field name="num_channels">
<type name="gint" c:type="gint"/>
</field>
<field name="min_volume">
<type name="gint" c:type="gint"/>
</field>
<field name="max_volume">
<type name="gint" c:type="gint"/>
</field>
</class>
<record name="MixerTrackClass"
c:type="GstMixerTrackClass"
glib:is-gtype-struct-for="MixerTrack">
<field name="parent">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="_gst_reserved">
<array zero-terminated="0" c:type="gpointer" fixed-size="4">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<bitfield name="MixerTrackFlags"
glib:type-name="GstMixerTrackFlags"
glib:get-type="gst_mixer_track_flags_get_type"
c:type="GstMixerTrackFlags">
<doc xml:space="preserve">Mixer track flags.</doc>
<member name="input"
value="1"
c:identifier="GST_MIXER_TRACK_INPUT"
glib:nick="input">
<doc xml:space="preserve">mixer track is for input</doc>
</member>
<member name="output"
value="2"
c:identifier="GST_MIXER_TRACK_OUTPUT"
glib:nick="output">
<doc xml:space="preserve">mixer track is for output</doc>
</member>
<member name="mute"
value="4"
c:identifier="GST_MIXER_TRACK_MUTE"
glib:nick="mute">
<doc xml:space="preserve">input or output is muted</doc>
</member>
<member name="record"
value="8"
c:identifier="GST_MIXER_TRACK_RECORD"
glib:nick="record">
<doc xml:space="preserve">input is audible in speakers attached to output
(for #GST_MIXER_TRACK_INPUT mixer tracks only)</doc>
</member>
<member name="master"
value="16"
c:identifier="GST_MIXER_TRACK_MASTER"
glib:nick="master">
<doc xml:space="preserve">this mixer track is likely to be the master control</doc>
</member>
<member name="software"
value="32"
c:identifier="GST_MIXER_TRACK_SOFTWARE"
glib:nick="software">
<doc xml:space="preserve">mixer track's' volume control is implemented
in software (as opposed to a hardware control)</doc>
</member>
<member name="no_record"
value="64"
c:identifier="GST_MIXER_TRACK_NO_RECORD"
glib:nick="no-record">
<doc xml:space="preserve">input track lacks support for recordable.
Since: 0.10.23</doc>
</member>
<member name="no_mute"
value="128"
c:identifier="GST_MIXER_TRACK_NO_MUTE"
glib:nick="no-mute">
<doc xml:space="preserve">play track doesn't support mute. Since: 0.10.23</doc>
</member>
<member name="whitelist"
value="256"
c:identifier="GST_MIXER_TRACK_WHITELIST"
glib:nick="whitelist">
<doc xml:space="preserve">track should be displayed "by default" in apps.
Since: 0.10.23</doc>
</member>
<member name="readonly"
value="512"
c:identifier="GST_MIXER_TRACK_READONLY"
glib:nick="readonly">
<doc xml:space="preserve">track is read-only. Since: 0.10.25</doc>
</member>
<member name="writeonly"
value="1024"
c:identifier="GST_MIXER_TRACK_WRITEONLY"
glib:nick="writeonly">
<doc xml:space="preserve">track is write-only. Since: 0.10.25</doc>
</member>
</bitfield>
<enumeration name="MixerType"
glib:type-name="GstMixerType"
glib:get-type="gst_mixer_type_get_type"
c:type="GstMixerType">
<doc xml:space="preserve">Mixer classification.</doc>
<member name="hardware"
value="0"
c:identifier="GST_MIXER_HARDWARE"
glib:nick="hardware">
<doc xml:space="preserve">mixing is implemented with dedicated hardware.</doc>
</member>
<member name="software"
value="1"
c:identifier="GST_MIXER_SOFTWARE"
glib:nick="software">
<doc xml:space="preserve">mixing is implemented via software processing.</doc>
</member>
</enumeration>
<interface name="Navigation"
c:symbol-prefix="navigation"
c:type="GstNavigation"
glib:type-name="GstNavigation"
glib:get-type="gst_navigation_get_type"
glib:type-struct="NavigationInterface">
<doc xml:space="preserve">The Navigation interface is used for creating and injecting navigation related
events such as mouse button presses, cursor motion and key presses. The associated
library also provides methods for parsing received events, and for sending and
receiving navigation related bus events. One main usecase is DVD menu navigation.
The main parts of the API are:
<itemizedlist>
<listitem>
<para>
The GstNavigation interface, implemented by elements which provide an application
with the ability to create and inject navigation events into the pipeline.
</para>
</listitem>
<listitem>
<para>
GstNavigation event handling API. GstNavigation events are created in response to
calls on a GstNavigation interface implementation, and sent in the pipeline. Upstream
elements can use the navigation event API functions to parse the contents of received
messages.
</para>
</listitem>
<listitem>
<para>
GstNavigation message handling API. GstNavigation messages may be sent on the message
bus to inform applications of navigation related changes in the pipeline, such as the
mouse moving over a clickable region, or the set of available angles changing.
</para><para>
The GstNavigation message functions provide functions for creating and parsing
custom bus messages for signaling GstNavigation changes.
</para>
</listitem>
</itemizedlist></doc>
<function name="event_get_type"
c:identifier="gst_navigation_event_get_type"
version="0.10.23">
<doc xml:space="preserve">Inspect a #GstEvent and return the #GstNavigationEventType of the event, or
#GST_NAVIGATION_EVENT_INVALID if the event is not a #GstNavigation event.</doc>
<return-value transfer-ownership="none">
<type name="NavigationEventType" c:type="GstNavigationEventType"/>
</return-value>
<parameters>
<parameter name="event" transfer-ownership="none">
<doc xml:space="preserve">A #GstEvent to inspect.</doc>
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
</parameters>
</function>
<function name="event_parse_command"
c:identifier="gst_navigation_event_parse_command"
version="0.10.23">
<doc xml:space="preserve">Inspect a #GstNavigation command event and retrieve the enum value of the
associated command.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the navigation command could be extracted, otherwise FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="event" transfer-ownership="none">
<doc xml:space="preserve">A #GstEvent to inspect.</doc>
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
<parameter name="command" transfer-ownership="none">
<doc xml:space="preserve">Pointer to GstNavigationCommand to receive the type of the
navigation event.</doc>
<type name="NavigationCommand" c:type="GstNavigationCommand*"/>
</parameter>
</parameters>
</function>
<function name="event_parse_key_event"
c:identifier="gst_navigation_event_parse_key_event"
version="0.10.23">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="event" transfer-ownership="none">
<doc xml:space="preserve">A #GstEvent to inspect.</doc>
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
<parameter name="key" transfer-ownership="none">
<doc xml:space="preserve">A pointer to a location to receive the string identifying the key
press. The returned string is owned by the event, and valid only until the
event is unreffed.</doc>
<type name="utf8" c:type="const gchar**"/>
</parameter>
</parameters>
</function>
<function name="event_parse_mouse_button_event"
c:identifier="gst_navigation_event_parse_mouse_button_event"
version="0.10.23">
<doc xml:space="preserve">Retrieve the details of either a #GstNavigation mouse button press event or
a mouse button release event. Determine which type the event is using
gst_navigation_event_get_type() to retrieve the #GstNavigationEventType.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the button number and both coordinates could be extracted,
otherwise FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="event" transfer-ownership="none">
<doc xml:space="preserve">A #GstEvent to inspect.</doc>
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
<parameter name="button" transfer-ownership="none">
<doc xml:space="preserve">Pointer to a gint that will receive the button number associated
with the event.</doc>
<type name="gint" c:type="gint*"/>
</parameter>
<parameter name="x" transfer-ownership="none">
<doc xml:space="preserve">Pointer to a gdouble to receive the x coordinate of the mouse button
event.</doc>
<type name="gdouble" c:type="gdouble*"/>
</parameter>
<parameter name="y" transfer-ownership="none">
<doc xml:space="preserve">Pointer to a gdouble to receive the y coordinate of the mouse button
event.</doc>
<type name="gdouble" c:type="gdouble*"/>
</parameter>
</parameters>
</function>
<function name="event_parse_mouse_move_event"
c:identifier="gst_navigation_event_parse_mouse_move_event"
version="0.10.23">
<doc xml:space="preserve">Inspect a #GstNavigation mouse movement event and extract the coordinates
of the event.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if both coordinates could be extracted, otherwise FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="event" transfer-ownership="none">
<doc xml:space="preserve">A #GstEvent to inspect.</doc>
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
<parameter name="x" transfer-ownership="none">
<doc xml:space="preserve">Pointer to a gdouble to receive the x coordinate of the mouse movement.</doc>
<type name="gdouble" c:type="gdouble*"/>
</parameter>
<parameter name="y" transfer-ownership="none">
<doc xml:space="preserve">Pointer to a gdouble to receive the y coordinate of the mouse movement.</doc>
<type name="gdouble" c:type="gdouble*"/>
</parameter>
</parameters>
</function>
<function name="message_get_type"
c:identifier="gst_navigation_message_get_type"
version="0.10.23">
<doc xml:space="preserve">Check a bus message to see if it is a #GstNavigation event, and return
the #GstNavigationMessageType identifying the type of the message if so.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The type of the #GstMessage, or
#GST_NAVIGATION_MESSAGE_INVALID if the message is not a #GstNavigation
notification.</doc>
<type name="NavigationMessageType"
c:type="GstNavigationMessageType"/>
</return-value>
<parameters>
<parameter name="message" transfer-ownership="none">
<doc xml:space="preserve">A #GstMessage to inspect.</doc>
<type name="Gst.Message" c:type="GstMessage*"/>
</parameter>
</parameters>
</function>
<function name="message_new_angles_changed"
c:identifier="gst_navigation_message_new_angles_changed"
version="0.10.23"
introspectable="0">
<doc xml:space="preserve">Creates a new #GstNavigation message with type
#GST_NAVIGATION_MESSAGE_ANGLES_CHANGED for notifying an application
that the current angle, or current number of angles available in a
multiangle video has changed.</doc>
<return-value>
<doc xml:space="preserve">The new #GstMessage.</doc>
<type name="Gst.Message" c:type="GstMessage*"/>
</return-value>
<parameters>
<parameter name="src" transfer-ownership="none">
<doc xml:space="preserve">A #GstObject to set as source of the new message.</doc>
<type name="Gst.Object" c:type="GstObject*"/>
</parameter>
<parameter name="cur_angle" transfer-ownership="none">
<doc xml:space="preserve">The currently selected angle.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="n_angles" transfer-ownership="none">
<doc xml:space="preserve">The number of viewing angles now available.</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</function>
<function name="message_new_commands_changed"
c:identifier="gst_navigation_message_new_commands_changed"
version="0.10.23"
introspectable="0">
<doc xml:space="preserve">Creates a new #GstNavigation message with type
#GST_NAVIGATION_MESSAGE_COMMANDS_CHANGED</doc>
<return-value>
<doc xml:space="preserve">The new #GstMessage.</doc>
<type name="Gst.Message" c:type="GstMessage*"/>
</return-value>
<parameters>
<parameter name="src" transfer-ownership="none">
<doc xml:space="preserve">A #GstObject to set as source of the new message.</doc>
<type name="Gst.Object" c:type="GstObject*"/>
</parameter>
</parameters>
</function>
<function name="message_new_mouse_over"
c:identifier="gst_navigation_message_new_mouse_over"
version="0.10.23"
introspectable="0">
<doc xml:space="preserve">Creates a new #GstNavigation message with type
#GST_NAVIGATION_MESSAGE_MOUSE_OVER.</doc>
<return-value>
<doc xml:space="preserve">The new #GstMessage.</doc>
<type name="Gst.Message" c:type="GstMessage*"/>
</return-value>
<parameters>
<parameter name="src" transfer-ownership="none">
<doc xml:space="preserve">A #GstObject to set as source of the new message.</doc>
<type name="Gst.Object" c:type="GstObject*"/>
</parameter>
<parameter name="active" transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the mouse has entered a clickable area of the display.
%FALSE if it over a non-clickable area.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</function>
<function name="message_parse_angles_changed"
c:identifier="gst_navigation_message_parse_angles_changed"
version="0.10.23">
<doc xml:space="preserve">Parse a #GstNavigation message of type GST_NAVIGATION_MESSAGE_ANGLES_CHANGED
and extract the @cur_angle and @n_angles parameters.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the message could be successfully parsed. %FALSE if not.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="message" transfer-ownership="none">
<doc xml:space="preserve">A #GstMessage to inspect.</doc>
<type name="Gst.Message" c:type="GstMessage*"/>
</parameter>
<parameter name="cur_angle" transfer-ownership="none">
<doc xml:space="preserve">A pointer to a #guint to receive the new current angle number,
or NULL</doc>
<type name="guint" c:type="guint*"/>
</parameter>
<parameter name="n_angles" transfer-ownership="none">
<doc xml:space="preserve">A pointer to a #guint to receive the new angle count, or NULL.</doc>
<type name="guint" c:type="guint*"/>
</parameter>
</parameters>
</function>
<function name="message_parse_mouse_over"
c:identifier="gst_navigation_message_parse_mouse_over"
version="0.10.23">
<doc xml:space="preserve">Parse a #GstNavigation message of type #GST_NAVIGATION_MESSAGE_MOUSE_OVER
and extract the active/inactive flag. If the mouse over event is marked
active, it indicates that the mouse is over a clickable area.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the message could be successfully parsed. %FALSE if not.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="message" transfer-ownership="none">
<doc xml:space="preserve">A #GstMessage to inspect.</doc>
<type name="Gst.Message" c:type="GstMessage*"/>
</parameter>
<parameter name="active" transfer-ownership="none">
<doc xml:space="preserve">A pointer to a gboolean to receive the active/inactive state,
or NULL.</doc>
<type name="gboolean" c:type="gboolean*"/>
</parameter>
</parameters>
</function>
<function name="query_get_type"
c:identifier="gst_navigation_query_get_type"
version="0.10.23">
<doc xml:space="preserve">Inspect a #GstQuery and return the #GstNavigationQueryType associated with
it if it is a #GstNavigation query.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The #GstNavigationQueryType of the query, or
#GST_NAVIGATION_QUERY_INVALID</doc>
<type name="NavigationQueryType" c:type="GstNavigationQueryType"/>
</return-value>
<parameters>
<parameter name="query" transfer-ownership="none">
<doc xml:space="preserve">The query to inspect</doc>
<type name="Gst.Query" c:type="GstQuery*"/>
</parameter>
</parameters>
</function>
<function name="query_new_angles"
c:identifier="gst_navigation_query_new_angles"
version="0.10.23"
introspectable="0">
<doc xml:space="preserve">Create a new #GstNavigation angles query. When executed, it will
query the pipeline for the set of currently available angles, which may be
greater than one in a multiangle video.</doc>
<return-value>
<doc xml:space="preserve">The new query.</doc>
<type name="Gst.Query" c:type="GstQuery*"/>
</return-value>
</function>
<function name="query_new_commands"
c:identifier="gst_navigation_query_new_commands"
version="0.10.23"
introspectable="0">
<doc xml:space="preserve">Create a new #GstNavigation commands query. When executed, it will
query the pipeline for the set of currently available commands.</doc>
<return-value>
<doc xml:space="preserve">The new query.</doc>
<type name="Gst.Query" c:type="GstQuery*"/>
</return-value>
</function>
<function name="query_parse_angles"
c:identifier="gst_navigation_query_parse_angles"
version="0.10.23">
<doc xml:space="preserve">Parse the current angle number in the #GstNavigation angles @query into the
#guint pointed to by the @cur_angle variable, and the number of available
angles into the #guint pointed to by the @n_angles variable.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the query could be successfully parsed. %FALSE if not.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="query" transfer-ownership="none">
<doc xml:space="preserve">a #GstQuery</doc>
<type name="Gst.Query" c:type="GstQuery*"/>
</parameter>
<parameter name="cur_angle" transfer-ownership="none">
<doc xml:space="preserve">Pointer to a #guint into which to store the currently selected
angle value from the query, or NULL</doc>
<type name="guint" c:type="guint*"/>
</parameter>
<parameter name="n_angles" transfer-ownership="none">
<doc xml:space="preserve">Pointer to a #guint into which to store the number of angles
value from the query, or NULL</doc>
<type name="guint" c:type="guint*"/>
</parameter>
</parameters>
</function>
<function name="query_parse_commands_length"
c:identifier="gst_navigation_query_parse_commands_length"
version="0.10.23">
<doc xml:space="preserve">Parse the number of commands in the #GstNavigation commands @query.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the query could be successfully parsed. %FALSE if not.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="query" transfer-ownership="none">
<doc xml:space="preserve">a #GstQuery</doc>
<type name="Gst.Query" c:type="GstQuery*"/>
</parameter>
<parameter name="n_cmds" transfer-ownership="none">
<doc xml:space="preserve">the number of commands in this query.</doc>
<type name="guint" c:type="guint*"/>
</parameter>
</parameters>
</function>
<function name="query_parse_commands_nth"
c:identifier="gst_navigation_query_parse_commands_nth"
version="0.10.23">
<doc xml:space="preserve">Parse the #GstNavigation command query and retrieve the @nth command from
it into @cmd. If the list contains less elements than @nth, @cmd will be
set to #GST_NAVIGATION_COMMAND_INVALID.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the query could be successfully parsed. %FALSE if not.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="query" transfer-ownership="none">
<doc xml:space="preserve">a #GstQuery</doc>
<type name="Gst.Query" c:type="GstQuery*"/>
</parameter>
<parameter name="nth" transfer-ownership="none">
<doc xml:space="preserve">the nth command to retrieve.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="cmd" transfer-ownership="none">
<doc xml:space="preserve">a pointer to store the nth command into.</doc>
<type name="NavigationCommand" c:type="GstNavigationCommand*"/>
</parameter>
</parameters>
</function>
<function name="query_set_angles"
c:identifier="gst_navigation_query_set_angles"
version="0.10.23">
<doc xml:space="preserve">Set the #GstNavigation angles query result field in @query.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="query" transfer-ownership="none">
<doc xml:space="preserve">a #GstQuery</doc>
<type name="Gst.Query" c:type="GstQuery*"/>
</parameter>
<parameter name="cur_angle" transfer-ownership="none">
<doc xml:space="preserve">the current viewing angle to set.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="n_angles" transfer-ownership="none">
<doc xml:space="preserve">the number of viewing angles to set.</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</function>
<function name="query_set_commands"
c:identifier="gst_navigation_query_set_commands"
version="0.10.23"
introspectable="0">
<doc xml:space="preserve">Set the #GstNavigation command query result fields in @query. The number
of commands passed must be equal to @n_commands.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="query" transfer-ownership="none">
<doc xml:space="preserve">a #GstQuery</doc>
<type name="Gst.Query" c:type="GstQuery*"/>
</parameter>
<parameter name="n_cmds" transfer-ownership="none">
<doc xml:space="preserve">the number of commands to set.</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">A list of @GstNavigationCommand values, @n_cmds entries long.</doc>
<varargs/>
</parameter>
</parameters>
</function>
<function name="query_set_commandsv"
c:identifier="gst_navigation_query_set_commandsv"
version="0.10.23">
<doc xml:space="preserve">Set the #GstNavigation command query result fields in @query. The number
of commands passed must be equal to @n_commands.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="query" transfer-ownership="none">
<doc xml:space="preserve">a #GstQuery</doc>
<type name="Gst.Query" c:type="GstQuery*"/>
</parameter>
<parameter name="n_cmds" transfer-ownership="none">
<doc xml:space="preserve">the number of commands to set.</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="cmds" transfer-ownership="none">
<doc xml:space="preserve">An array containing @n_cmds @GstNavigationCommand values.</doc>
<type name="NavigationCommand" c:type="GstNavigationCommand*"/>
</parameter>
</parameters>
</function>
<virtual-method name="send_event" invoker="send_event">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="navigation" transfer-ownership="none">
<type name="Navigation" c:type="GstNavigation*"/>
</instance-parameter>
<parameter name="structure" transfer-ownership="none">
<type name="Gst.Structure" c:type="GstStructure*"/>
</parameter>
</parameters>
</virtual-method>
<method name="send_command"
c:identifier="gst_navigation_send_command"
version="0.10.23">
<doc xml:space="preserve">Sends the indicated command to the navigation interface.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="navigation" transfer-ownership="none">
<doc xml:space="preserve">The navigation interface instance</doc>
<type name="Navigation" c:type="GstNavigation*"/>
</instance-parameter>
<parameter name="command" transfer-ownership="none">
<doc xml:space="preserve">The command to issue</doc>
<type name="NavigationCommand" c:type="GstNavigationCommand"/>
</parameter>
</parameters>
</method>
<method name="send_event" c:identifier="gst_navigation_send_event">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="navigation" transfer-ownership="none">
<type name="Navigation" c:type="GstNavigation*"/>
</instance-parameter>
<parameter name="structure" transfer-ownership="none">
<type name="Gst.Structure" c:type="GstStructure*"/>
</parameter>
</parameters>
</method>
<method name="send_key_event"
c:identifier="gst_navigation_send_key_event">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="navigation" transfer-ownership="none">
<doc xml:space="preserve">The navigation interface instance</doc>
<type name="Navigation" c:type="GstNavigation*"/>
</instance-parameter>
<parameter name="event" transfer-ownership="none">
<doc xml:space="preserve">The type of the key event. Recognised values are "key-press" and
"key-release"</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="key" transfer-ownership="none">
<doc xml:space="preserve">Character representation of the key. This is typically as produced
by XKeysymToString.</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="send_mouse_event"
c:identifier="gst_navigation_send_mouse_event">
<doc xml:space="preserve">Sends a mouse event to the navigation interface. Mouse event coordinates
are sent relative to the display space of the related output area. This is
usually the size in pixels of the window associated with the element
implementing the #GstNavigation interface.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="navigation" transfer-ownership="none">
<doc xml:space="preserve">The navigation interface instance</doc>
<type name="Navigation" c:type="GstNavigation*"/>
</instance-parameter>
<parameter name="event" transfer-ownership="none">
<doc xml:space="preserve">The type of mouse event, as a text string. Recognised values are
"mouse-button-press", "mouse-button-release" and "mouse-move".</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="button" transfer-ownership="none">
<doc xml:space="preserve">The button number of the button being pressed or released. Pass 0
for mouse-move events.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="x" transfer-ownership="none">
<doc xml:space="preserve">The x coordinate of the mouse event.</doc>
<type name="gdouble" c:type="double"/>
</parameter>
<parameter name="y" transfer-ownership="none">
<doc xml:space="preserve">The y coordinate of the mouse event.</doc>
<type name="gdouble" c:type="double"/>
</parameter>
</parameters>
</method>
</interface>
<enumeration name="NavigationCommand"
version="0.10.23"
glib:type-name="GstNavigationCommand"
glib:get-type="gst_navigation_command_get_type"
c:type="GstNavigationCommand">
<doc xml:space="preserve">A set of commands that may be issued to an element providing the
#GstNavigation interface. The available commands can be queried via
the gst_navigation_query_new_commands() query.
For convenience in handling DVD navigation, the MENU commands are aliased as:
GST_NAVIGATION_COMMAND_DVD_MENU = @GST_NAVIGATION_COMMAND_MENU1
GST_NAVIGATION_COMMAND_DVD_TITLE_MENU = @GST_NAVIGATION_COMMAND_MENU2
GST_NAVIGATION_COMMAND_DVD_ROOT_MENU = @GST_NAVIGATION_COMMAND_MENU3
GST_NAVIGATION_COMMAND_DVD_SUBPICTURE_MENU = @GST_NAVIGATION_COMMAND_MENU4
GST_NAVIGATION_COMMAND_DVD_AUDIO_MENU = @GST_NAVIGATION_COMMAND_MENU5
GST_NAVIGATION_COMMAND_DVD_ANGLE_MENU = @GST_NAVIGATION_COMMAND_MENU6
GST_NAVIGATION_COMMAND_DVD_CHAPTER_MENU = @GST_NAVIGATION_COMMAND_MENU7</doc>
<member name="invalid"
value="0"
c:identifier="GST_NAVIGATION_COMMAND_INVALID"
glib:nick="invalid">
<doc xml:space="preserve">An invalid command entry</doc>
</member>
<member name="menu1"
value="1"
c:identifier="GST_NAVIGATION_COMMAND_MENU1"
glib:nick="menu1">
<doc xml:space="preserve">Execute navigation menu command 1. For DVD,
this enters the DVD root menu, or exits back to the title from the menu.</doc>
</member>
<member name="menu2"
value="2"
c:identifier="GST_NAVIGATION_COMMAND_MENU2"
glib:nick="menu2">
<doc xml:space="preserve">Execute navigation menu command 2. For DVD,
this jumps to the DVD title menu.</doc>
</member>
<member name="menu3"
value="3"
c:identifier="GST_NAVIGATION_COMMAND_MENU3"
glib:nick="menu3">
<doc xml:space="preserve">Execute navigation menu command 3. For DVD,
this jumps into the DVD root menu.</doc>
</member>
<member name="menu4"
value="4"
c:identifier="GST_NAVIGATION_COMMAND_MENU4"
glib:nick="menu4">
<doc xml:space="preserve">Execute navigation menu command 4. For DVD,
this jumps to the Subpicture menu.</doc>
</member>
<member name="menu5"
value="5"
c:identifier="GST_NAVIGATION_COMMAND_MENU5"
glib:nick="menu5">
<doc xml:space="preserve">Execute navigation menu command 5. For DVD,
the jumps to the audio menu.</doc>
</member>
<member name="menu6"
value="6"
c:identifier="GST_NAVIGATION_COMMAND_MENU6"
glib:nick="menu6">
<doc xml:space="preserve">Execute navigation menu command 6. For DVD,
this jumps to the angles menu.</doc>
</member>
<member name="menu7"
value="7"
c:identifier="GST_NAVIGATION_COMMAND_MENU7"
glib:nick="menu7">
<doc xml:space="preserve">Execute navigation menu command 7. For DVD,
this jumps to the chapter menu.</doc>
</member>
<member name="left"
value="20"
c:identifier="GST_NAVIGATION_COMMAND_LEFT"
glib:nick="left">
<doc xml:space="preserve">Select the next button to the left in a menu,
if such a button exists.</doc>
</member>
<member name="right"
value="21"
c:identifier="GST_NAVIGATION_COMMAND_RIGHT"
glib:nick="right">
<doc xml:space="preserve">Select the next button to the right in a menu,
if such a button exists.</doc>
</member>
<member name="up"
value="22"
c:identifier="GST_NAVIGATION_COMMAND_UP"
glib:nick="up">
<doc xml:space="preserve">Select the button above the current one in a
menu, if such a button exists.</doc>
</member>
<member name="down"
value="23"
c:identifier="GST_NAVIGATION_COMMAND_DOWN"
glib:nick="down">
<doc xml:space="preserve">Select the button below the current one in a
menu, if such a button exists.</doc>
</member>
<member name="activate"
value="24"
c:identifier="GST_NAVIGATION_COMMAND_ACTIVATE"
glib:nick="activate">
<doc xml:space="preserve">Activate (click) the currently selected
button in a menu, if such a button exists.</doc>
</member>
<member name="prev_angle"
value="30"
c:identifier="GST_NAVIGATION_COMMAND_PREV_ANGLE"
glib:nick="prev-angle">
<doc xml:space="preserve">Switch to the previous angle in a
multiangle feature.</doc>
</member>
<member name="next_angle"
value="31"
c:identifier="GST_NAVIGATION_COMMAND_NEXT_ANGLE"
glib:nick="next-angle">
<doc xml:space="preserve">Switch to the next angle in a multiangle
feature.</doc>
</member>
</enumeration>
<enumeration name="NavigationEventType"
version="0.10.23"
glib:type-name="GstNavigationEventType"
glib:get-type="gst_navigation_event_type_get_type"
c:type="GstNavigationEventType">
<doc xml:space="preserve">Enum values for the various events that an element implementing the
GstNavigation interface might send up the pipeline.</doc>
<member name="invalid"
value="0"
c:identifier="GST_NAVIGATION_EVENT_INVALID"
glib:nick="invalid">
<doc xml:space="preserve">Returned from
gst_navigation_event_get_type() when the passed event is not a navigation event.</doc>
</member>
<member name="key_press"
value="1"
c:identifier="GST_NAVIGATION_EVENT_KEY_PRESS"
glib:nick="key-press">
<doc xml:space="preserve">A key press event. Use
gst_navigation_event_parse_key_event() to extract the details from the event.</doc>
</member>
<member name="key_release"
value="2"
c:identifier="GST_NAVIGATION_EVENT_KEY_RELEASE"
glib:nick="key-release">
<doc xml:space="preserve">A key release event. Use
gst_navigation_event_parse_key_event() to extract the details from the event.</doc>
</member>
<member name="mouse_button_press"
value="3"
c:identifier="GST_NAVIGATION_EVENT_MOUSE_BUTTON_PRESS"
glib:nick="mouse-button-press">
<doc xml:space="preserve">A mouse button press event. Use
gst_navigation_event_parse_mouse_button_event() to extract the details from the
event.</doc>
</member>
<member name="mouse_button_release"
value="4"
c:identifier="GST_NAVIGATION_EVENT_MOUSE_BUTTON_RELEASE"
glib:nick="mouse-button-release">
<doc xml:space="preserve">A mouse button release event. Use
gst_navigation_event_parse_mouse_button_event() to extract the details from the
event.</doc>
</member>
<member name="mouse_move"
value="5"
c:identifier="GST_NAVIGATION_EVENT_MOUSE_MOVE"
glib:nick="mouse-move">
<doc xml:space="preserve">A mouse movement event. Use
gst_navigation_event_parse_mouse_move_event() to extract the details from the
event.</doc>
</member>
<member name="command"
value="6"
c:identifier="GST_NAVIGATION_EVENT_COMMAND"
glib:nick="command">
<doc xml:space="preserve">A navigation command event. Use
gst_navigation_event_parse_command() to extract the details from the event.</doc>
</member>
</enumeration>
<record name="NavigationInterface"
c:type="GstNavigationInterface"
glib:is-gtype-struct-for="Navigation">
<doc xml:space="preserve">Color-balance interface.</doc>
<field name="g_iface">
<doc xml:space="preserve">the parent interface</doc>
<type name="GObject.TypeInterface" c:type="GTypeInterface"/>
</field>
<field name="send_event">
<callback name="send_event">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="navigation" transfer-ownership="none">
<type name="Navigation" c:type="GstNavigation*"/>
</parameter>
<parameter name="structure" transfer-ownership="none">
<type name="Gst.Structure" c:type="GstStructure*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="_gst_reserved" readable="0" private="1">
<array zero-terminated="0" c:type="gpointer" fixed-size="4">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<enumeration name="NavigationMessageType"
version="0.10.23"
glib:type-name="GstNavigationMessageType"
glib:get-type="gst_navigation_message_type_get_type"
c:type="GstNavigationMessageType">
<doc xml:space="preserve">A set of notifications that may be received on the bus when navigation
related status changes.</doc>
<member name="invalid"
value="0"
c:identifier="GST_NAVIGATION_MESSAGE_INVALID"
glib:nick="invalid">
<doc xml:space="preserve">Returned from
gst_navigation_message_get_type() when the passed message is not a
navigation message.</doc>
</member>
<member name="mouse_over"
value="1"
c:identifier="GST_NAVIGATION_MESSAGE_MOUSE_OVER"
glib:nick="mouse-over">
<doc xml:space="preserve">Sent when the mouse moves over or leaves a
clickable region of the output, such as a DVD menu button.</doc>
</member>
<member name="commands_changed"
value="2"
c:identifier="GST_NAVIGATION_MESSAGE_COMMANDS_CHANGED"
glib:nick="commands-changed">
<doc xml:space="preserve">Sent when the set of available commands
changes and should re-queried by interested applications.</doc>
</member>
<member name="angles_changed"
value="3"
c:identifier="GST_NAVIGATION_MESSAGE_ANGLES_CHANGED"
glib:nick="angles-changed">
<doc xml:space="preserve">Sent when display angles in a multi-angle
feature (such as a multiangle DVD) change - either angles have appeared or
disappeared.</doc>
</member>
</enumeration>
<enumeration name="NavigationQueryType"
glib:type-name="GstNavigationQueryType"
glib:get-type="gst_navigation_query_type_get_type"
c:type="GstNavigationQueryType">
<doc xml:space="preserve">Tyoes of navigation interface queries.</doc>
<member name="invalid"
value="0"
c:identifier="GST_NAVIGATION_QUERY_INVALID"
glib:nick="invalid">
<doc xml:space="preserve">invalid query</doc>
</member>
<member name="commands"
value="1"
c:identifier="GST_NAVIGATION_QUERY_COMMANDS"
glib:nick="commands">
<doc xml:space="preserve">command query</doc>
</member>
<member name="angles"
value="2"
c:identifier="GST_NAVIGATION_QUERY_ANGLES"
glib:nick="angles">
<doc xml:space="preserve">viewing angle query</doc>
</member>
</enumeration>
<interface name="PropertyProbe"
c:symbol-prefix="property_probe"
c:type="GstPropertyProbe"
glib:type-name="GstPropertyProbe"
glib:get-type="gst_property_probe_get_type"
glib:type-struct="PropertyProbeInterface">
<doc xml:space="preserve">The property probe is a way to autodetect allowed values for a GObject
property. It's primary use is to autodetect device-names in several elements.
The interface is implemented by many hardware sources and sinks.</doc>
<virtual-method name="get_properties"
invoker="get_properties"
introspectable="0">
<doc xml:space="preserve">Get a list of properties for which probing is supported.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the list of #GParamSpec * pointers representing
properties for which probing is supported by this element.</doc>
<type name="GLib.List" c:type="const GList*">
<type name="gpointer" c:type="gpointer"/>
</type>
</return-value>
<parameters>
<instance-parameter name="probe" transfer-ownership="none">
<doc xml:space="preserve">the #GstPropertyProbe to get the properties for.</doc>
<type name="PropertyProbe" c:type="GstPropertyProbe*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="get_values">
<return-value transfer-ownership="full">
<type name="GObject.ValueArray" c:type="GValueArray*"/>
</return-value>
<parameters>
<instance-parameter name="probe" transfer-ownership="none">
<type name="PropertyProbe" c:type="GstPropertyProbe*"/>
</instance-parameter>
<parameter name="prop_id" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="pspec" transfer-ownership="none">
<type name="GObject.ParamSpec" c:type="const GParamSpec*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="needs_probe">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="probe" transfer-ownership="none">
<type name="PropertyProbe" c:type="GstPropertyProbe*"/>
</instance-parameter>
<parameter name="prop_id" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="pspec" transfer-ownership="none">
<type name="GObject.ParamSpec" c:type="const GParamSpec*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="probe_needed">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="probe" transfer-ownership="none">
<type name="PropertyProbe" c:type="GstPropertyProbe*"/>
</instance-parameter>
<parameter name="pspec" transfer-ownership="none">
<type name="GObject.ParamSpec" c:type="const GParamSpec*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="probe_property">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="probe" transfer-ownership="none">
<type name="PropertyProbe" c:type="GstPropertyProbe*"/>
</instance-parameter>
<parameter name="prop_id" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="pspec" transfer-ownership="none">
<type name="GObject.ParamSpec" c:type="const GParamSpec*"/>
</parameter>
</parameters>
</virtual-method>
<method name="get_properties"
c:identifier="gst_property_probe_get_properties"
introspectable="0">
<doc xml:space="preserve">Get a list of properties for which probing is supported.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the list of #GParamSpec * pointers representing
properties for which probing is supported by this element.</doc>
<type name="GLib.List" c:type="const GList*">
<type name="gpointer" c:type="gpointer"/>
</type>
</return-value>
<parameters>
<instance-parameter name="probe" transfer-ownership="none">
<doc xml:space="preserve">the #GstPropertyProbe to get the properties for.</doc>
<type name="PropertyProbe" c:type="GstPropertyProbe*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_property"
c:identifier="gst_property_probe_get_property">
<doc xml:space="preserve">Get #GParamSpec for a property for which probing is supported.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the #GParamSpec of %NULL.</doc>
<type name="GObject.ParamSpec" c:type="const GParamSpec*"/>
</return-value>
<parameters>
<instance-parameter name="probe" transfer-ownership="none">
<doc xml:space="preserve">the #GstPropertyProbe to get the properties for.</doc>
<type name="PropertyProbe" c:type="GstPropertyProbe*"/>
</instance-parameter>
<parameter name="name" transfer-ownership="none">
<doc xml:space="preserve">name of the property.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="get_values" c:identifier="gst_property_probe_get_values">
<doc xml:space="preserve">Gets the possible (probed) values for the given property,
requires the property to have been probed before.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A list of valid values for the given property.</doc>
<type name="GObject.ValueArray" c:type="GValueArray*"/>
</return-value>
<parameters>
<instance-parameter name="probe" transfer-ownership="none">
<doc xml:space="preserve">the #GstPropertyProbe object.</doc>
<type name="PropertyProbe" c:type="GstPropertyProbe*"/>
</instance-parameter>
<parameter name="pspec" transfer-ownership="none">
<doc xml:space="preserve">the #GParamSpec property identifier.</doc>
<type name="GObject.ParamSpec" c:type="const GParamSpec*"/>
</parameter>
</parameters>
</method>
<method name="get_values_name"
c:identifier="gst_property_probe_get_values_name">
<doc xml:space="preserve">Same as gst_property_probe_get_values ().</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A list of valid values for the given property.</doc>
<type name="GObject.ValueArray" c:type="GValueArray*"/>
</return-value>
<parameters>
<instance-parameter name="probe" transfer-ownership="none">
<doc xml:space="preserve">the #GstPropertyProbe object.</doc>
<type name="PropertyProbe" c:type="GstPropertyProbe*"/>
</instance-parameter>
<parameter name="name" transfer-ownership="none">
<doc xml:space="preserve">the name of the property to get values for.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="needs_probe" c:identifier="gst_property_probe_needs_probe">
<doc xml:space="preserve">Checks whether a property needs a probe. This might be because
the property wasn't initialized before, or because host setup
changed. This might be, for example, because a new device was
added, and thus device probing needs to be refreshed to display
the new device.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the property needs a new probe, FALSE if not.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="probe" transfer-ownership="none">
<doc xml:space="preserve">the #GstPropertyProbe object to which the given property belongs.</doc>
<type name="PropertyProbe" c:type="GstPropertyProbe*"/>
</instance-parameter>
<parameter name="pspec" transfer-ownership="none">
<doc xml:space="preserve">a #GParamSpec that identifies the property to check.</doc>
<type name="GObject.ParamSpec" c:type="const GParamSpec*"/>
</parameter>
</parameters>
</method>
<method name="needs_probe_name"
c:identifier="gst_property_probe_needs_probe_name">
<doc xml:space="preserve">Same as gst_property_probe_needs_probe ().</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the property needs a new probe, FALSE if not.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="probe" transfer-ownership="none">
<doc xml:space="preserve">the #GstPropertyProbe object to which the given property belongs.</doc>
<type name="PropertyProbe" c:type="GstPropertyProbe*"/>
</instance-parameter>
<parameter name="name" transfer-ownership="none">
<doc xml:space="preserve">the name of the property to check.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="probe_and_get_values"
c:identifier="gst_property_probe_probe_and_get_values">
<doc xml:space="preserve">Check whether the given property requires a new probe. If so,
fo the probe. After that, retrieve a value list. Meant as a
utility function that wraps the above functions.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the list of valid values for this property.</doc>
<type name="GObject.ValueArray" c:type="GValueArray*"/>
</return-value>
<parameters>
<instance-parameter name="probe" transfer-ownership="none">
<doc xml:space="preserve">the #GstPropertyProbe object.</doc>
<type name="PropertyProbe" c:type="GstPropertyProbe*"/>
</instance-parameter>
<parameter name="pspec" transfer-ownership="none">
<doc xml:space="preserve">The #GParamSpec property identifier.</doc>
<type name="GObject.ParamSpec" c:type="const GParamSpec*"/>
</parameter>
</parameters>
</method>
<method name="probe_and_get_values_name"
c:identifier="gst_property_probe_probe_and_get_values_name">
<doc xml:space="preserve">Same as gst_property_probe_probe_and_get_values ().</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the list of valid values for this property.</doc>
<type name="GObject.ValueArray" c:type="GValueArray*"/>
</return-value>
<parameters>
<instance-parameter name="probe" transfer-ownership="none">
<doc xml:space="preserve">the #GstPropertyProbe object.</doc>
<type name="PropertyProbe" c:type="GstPropertyProbe*"/>
</instance-parameter>
<parameter name="name" transfer-ownership="none">
<doc xml:space="preserve">the name of the property to get values for.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="probe_property"
c:identifier="gst_property_probe_probe_property">
<doc xml:space="preserve">Runs a probe on the property specified by @pspec</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="probe" transfer-ownership="none">
<doc xml:space="preserve">the #GstPropertyProbe to check.</doc>
<type name="PropertyProbe" c:type="GstPropertyProbe*"/>
</instance-parameter>
<parameter name="pspec" transfer-ownership="none">
<doc xml:space="preserve">#GParamSpec of the property.</doc>
<type name="GObject.ParamSpec" c:type="const GParamSpec*"/>
</parameter>
</parameters>
</method>
<method name="probe_property_name"
c:identifier="gst_property_probe_probe_property_name">
<doc xml:space="preserve">Runs a probe on the property specified by @name.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="probe" transfer-ownership="none">
<doc xml:space="preserve">the #GstPropertyProbe to check.</doc>
<type name="PropertyProbe" c:type="GstPropertyProbe*"/>
</instance-parameter>
<parameter name="name" transfer-ownership="none">
<doc xml:space="preserve">name of the property.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<glib:signal name="probe-needed" when="last">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="object" transfer-ownership="none">
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</glib:signal>
</interface>
<record name="PropertyProbeInterface"
c:type="GstPropertyProbeInterface"
glib:is-gtype-struct-for="PropertyProbe">
<doc xml:space="preserve">#GstPropertyProbe interface.</doc>
<field name="klass">
<doc xml:space="preserve">parent interface type.</doc>
<type name="GObject.TypeInterface" c:type="GTypeInterface"/>
</field>
<field name="probe_needed">
<callback name="probe_needed">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="probe" transfer-ownership="none">
<type name="PropertyProbe" c:type="GstPropertyProbe*"/>
</parameter>
<parameter name="pspec" transfer-ownership="none">
<type name="GObject.ParamSpec" c:type="const GParamSpec*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="get_properties" introspectable="0">
<callback name="get_properties" introspectable="0">
<return-value transfer-ownership="none">
<doc xml:space="preserve">the list of #GParamSpec * pointers representing
properties for which probing is supported by this element.</doc>
<type name="GLib.List" c:type="const GList*">
<type name="gpointer" c:type="gpointer"/>
</type>
</return-value>
<parameters>
<parameter name="probe" transfer-ownership="none">
<doc xml:space="preserve">the #GstPropertyProbe to get the properties for.</doc>
<type name="PropertyProbe" c:type="GstPropertyProbe*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="needs_probe">
<callback name="needs_probe">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="probe" transfer-ownership="none">
<type name="PropertyProbe" c:type="GstPropertyProbe*"/>
</parameter>
<parameter name="prop_id" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="pspec" transfer-ownership="none">
<type name="GObject.ParamSpec" c:type="const GParamSpec*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="probe_property">
<callback name="probe_property">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="probe" transfer-ownership="none">
<type name="PropertyProbe" c:type="GstPropertyProbe*"/>
</parameter>
<parameter name="prop_id" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="pspec" transfer-ownership="none">
<type name="GObject.ParamSpec" c:type="const GParamSpec*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="get_values">
<callback name="get_values">
<return-value transfer-ownership="full">
<type name="GObject.ValueArray" c:type="GValueArray*"/>
</return-value>
<parameters>
<parameter name="probe" transfer-ownership="none">
<type name="PropertyProbe" c:type="GstPropertyProbe*"/>
</parameter>
<parameter name="prop_id" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="pspec" transfer-ownership="none">
<type name="GObject.ParamSpec" c:type="const GParamSpec*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="_gst_reserved" readable="0" private="1">
<array zero-terminated="0" c:type="gpointer" fixed-size="4">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<interface name="StreamVolume"
c:symbol-prefix="stream_volume"
c:type="GstStreamVolume"
glib:type-name="GstStreamVolume"
glib:get-type="gst_stream_volume_get_type"
glib:type-struct="StreamVolumeInterface">
<doc xml:space="preserve"><refsect2>
<para>
This interface is implemented by elements that provide a stream volume. Examples for
such elements are #volume and #playbin2.
</para>
<para>
Applications can use this interface to get or set the current stream volume. For this
the "volume" #GObject property can be used or the helper functions gst_stream_volume_set_volume()
and gst_stream_volume_get_volume(). This volume is always a linear factor, i.e. 0.0 is muted
1.0 is 100%. For showing the volume in a GUI it might make sense to convert it to
a different format by using gst_stream_volume_convert_volume(). Volume sliders should usually
use a cubic volume.
Separate from the volume the stream can also be muted by the "mute" #GObject property or
gst_stream_volume_set_mute() and gst_stream_volume_get_mute().
</para>
<para>
Elements that provide some kind of stream volume should implement the "volume" and
"mute" #GObject properties and handle setting and getting of them properly.
The volume property is defined to be a linear volume factor.
</para>
</refsect2></doc>
<function name="convert_volume"
c:identifier="gst_stream_volume_convert_volume"
version="0.10.25">
<return-value transfer-ownership="none">
<doc xml:space="preserve">the converted volume</doc>
<type name="gdouble" c:type="gdouble"/>
</return-value>
<parameters>
<parameter name="from" transfer-ownership="none">
<doc xml:space="preserve">#GstStreamVolumeFormat to convert from</doc>
<type name="StreamVolumeFormat" c:type="GstStreamVolumeFormat"/>
</parameter>
<parameter name="to" transfer-ownership="none">
<doc xml:space="preserve">#GstStreamVolumeFormat to convert to</doc>
<type name="StreamVolumeFormat" c:type="GstStreamVolumeFormat"/>
</parameter>
<parameter name="val" transfer-ownership="none">
<doc xml:space="preserve">Volume in @from format that should be converted</doc>
<type name="gdouble" c:type="gdouble"/>
</parameter>
</parameters>
</function>
<method name="get_mute"
c:identifier="gst_stream_volume_get_mute"
version="0.10.25">
<return-value transfer-ownership="none">
<doc xml:space="preserve">Returns %TRUE if the stream is muted</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="volume" transfer-ownership="none">
<doc xml:space="preserve">#GstStreamVolume that should be used</doc>
<type name="StreamVolume" c:type="GstStreamVolume*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_volume"
c:identifier="gst_stream_volume_get_volume"
version="0.10.25">
<return-value transfer-ownership="none">
<doc xml:space="preserve">The current stream volume as linear factor</doc>
<type name="gdouble" c:type="gdouble"/>
</return-value>
<parameters>
<instance-parameter name="volume" transfer-ownership="none">
<doc xml:space="preserve">#GstStreamVolume that should be used</doc>
<type name="StreamVolume" c:type="GstStreamVolume*"/>
</instance-parameter>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">#GstStreamVolumeFormat which should be returned</doc>
<type name="StreamVolumeFormat" c:type="GstStreamVolumeFormat"/>
</parameter>
</parameters>
</method>
<method name="set_mute"
c:identifier="gst_stream_volume_set_mute"
version="0.10.25">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="volume" transfer-ownership="none">
<doc xml:space="preserve">#GstStreamVolume that should be used</doc>
<type name="StreamVolume" c:type="GstStreamVolume*"/>
</instance-parameter>
<parameter name="mute" transfer-ownership="none">
<doc xml:space="preserve">Mute state that should be set</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_volume"
c:identifier="gst_stream_volume_set_volume"
version="0.10.25">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="volume" transfer-ownership="none">
<doc xml:space="preserve">#GstStreamVolume that should be used</doc>
<type name="StreamVolume" c:type="GstStreamVolume*"/>
</instance-parameter>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">#GstStreamVolumeFormat of @val</doc>
<type name="StreamVolumeFormat" c:type="GstStreamVolumeFormat"/>
</parameter>
<parameter name="val" transfer-ownership="none">
<doc xml:space="preserve">Linear volume factor that should be set</doc>
<type name="gdouble" c:type="gdouble"/>
</parameter>
</parameters>
</method>
<property name="mute" writable="1" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="volume" writable="1" transfer-ownership="none">
<type name="gdouble" c:type="gdouble"/>
</property>
</interface>
<enumeration name="StreamVolumeFormat"
version="0.10.25"
glib:type-name="GstStreamVolumeFormat"
glib:get-type="gst_stream_volume_format_get_type"
c:type="GstStreamVolumeFormat">
<doc xml:space="preserve">Different representations of a stream volume. gst_stream_volume_convert_volume()
allows to convert between the different representations.
Formulas to convert from a linear to a cubic or dB volume are
cbrt(val) and 20 * log10 (val).</doc>
<member name="linear"
value="0"
c:identifier="GST_STREAM_VOLUME_FORMAT_LINEAR"
glib:nick="linear">
<doc xml:space="preserve">Linear scale factor, 1.0 = 100%</doc>
</member>
<member name="cubic"
value="1"
c:identifier="GST_STREAM_VOLUME_FORMAT_CUBIC"
glib:nick="cubic">
<doc xml:space="preserve">Cubic volume scale</doc>
</member>
<member name="db"
value="2"
c:identifier="GST_STREAM_VOLUME_FORMAT_DB"
glib:nick="db">
<doc xml:space="preserve">Logarithmic volume scale (dB, amplitude not power)</doc>
</member>
</enumeration>
<record name="StreamVolumeInterface"
c:type="GstStreamVolumeInterface"
glib:is-gtype-struct-for="StreamVolume">
<field name="parent">
<type name="GObject.TypeInterface" c:type="GTypeInterface"/>
</field>
<field name="_gst_reserved" readable="0" private="1">
<array zero-terminated="0" c:type="gpointer" fixed-size="4">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<interface name="Tuner"
c:symbol-prefix="tuner"
c:type="GstTuner"
glib:type-name="GstTuner"
glib:get-type="gst_tuner_get_type">
<doc xml:space="preserve"><refsect2>
<para>
The GstTuner interface is provided by elements that have the ability to
tune into multiple input signals, for example TV or radio capture cards.
</para><para>
The interpretation of 'tuning into' an input stream depends on the element
implementing the interface. For v4lsrc, it might imply selection of an
input source and/or frequency to be configured on a TV card. Another
GstTuner implementation might be to allow selection of an active input pad
from multiple input pads.
</para><para>
That said, the GstTuner interface functions are biased toward the
TV capture scenario.
</para><para>
The general parameters provided are for configuration are:
<itemizedlist>
<listitem>Selection of a current #GstTunerChannel. The current channel
represents the input source (e.g. Composite, S-Video etc for TV capture).
</listitem>
<listitem>The #GstTunerNorm for the channel. The norm chooses the
interpretation of the incoming signal for the current channel. For example,
PAL or NTSC, or more specific variants there-of.
</listitem>
<listitem>Channel frequency. If the current channel has the ability to tune
between multiple frequencies (if it has the GST_TUNER_CHANNEL_FREQUENCY flag)
then the frequency can be changed/retrieved via the
gst_tuner_set_frequency() and gst_tuner_get_frequency() methods.
</listitem>
</itemizedlist>
</para>
<para>
Where applicable, the signal strength can be retrieved and/or monitored
via a signal.
</para>
</refsect2></doc>
<prerequisite name="Gst.Element"/>
<prerequisite name="Gst.ImplementsInterface"/>
<method name="channel_changed" c:identifier="gst_tuner_channel_changed">
<doc xml:space="preserve">Called by elements implementing the #GstTuner interface when the
current channel changes. Fires the #GstTuner::channel-changed signal.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="tuner" transfer-ownership="none">
<doc xml:space="preserve">A #GstTuner instance</doc>
<type name="Tuner" c:type="GstTuner*"/>
</instance-parameter>
<parameter name="channel" transfer-ownership="none">
<doc xml:space="preserve">A #GstTunerChannel instance</doc>
<type name="TunerChannel" c:type="GstTunerChannel*"/>
</parameter>
</parameters>
</method>
<method name="find_channel_by_name"
c:identifier="gst_tuner_find_channel_by_name"
introspectable="0">
<doc xml:space="preserve">Look up a #GstTunerChannel by name.</doc>
<return-value>
<doc xml:space="preserve">A #GstTunerChannel, or NULL if no channel with the provided name
is available.</doc>
<type name="TunerChannel" c:type="GstTunerChannel*"/>
</return-value>
<parameters>
<instance-parameter name="tuner" transfer-ownership="none">
<doc xml:space="preserve">A #GstTuner instance</doc>
<type name="Tuner" c:type="GstTuner*"/>
</instance-parameter>
<parameter name="channel" transfer-ownership="none">
<doc xml:space="preserve">A string containing the name of a #GstTunerChannel</doc>
<type name="utf8" c:type="gchar*"/>
</parameter>
</parameters>
</method>
<method name="find_norm_by_name"
c:identifier="gst_tuner_find_norm_by_name"
introspectable="0">
<doc xml:space="preserve">Look up a #GstTunerNorm by name.</doc>
<return-value>
<doc xml:space="preserve">A #GstTunerNorm, or NULL if no norm with the provided name
is available.</doc>
<type name="TunerNorm" c:type="GstTunerNorm*"/>
</return-value>
<parameters>
<instance-parameter name="tuner" transfer-ownership="none">
<doc xml:space="preserve">A #GstTuner instance</doc>
<type name="Tuner" c:type="GstTuner*"/>
</instance-parameter>
<parameter name="norm" transfer-ownership="none">
<doc xml:space="preserve">A string containing the name of a #GstTunerNorm</doc>
<type name="utf8" c:type="gchar*"/>
</parameter>
</parameters>
</method>
<method name="frequency_changed"
c:identifier="gst_tuner_frequency_changed">
<doc xml:space="preserve">Called by elements implementing the #GstTuner interface when the
configured frequency changes. Fires the #GstTuner::frequency-changed
signal on the tuner, and the #GstTunerChannel::frequency-changed signal
on the channel.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="tuner" transfer-ownership="none">
<doc xml:space="preserve">A #GstTuner instance</doc>
<type name="Tuner" c:type="GstTuner*"/>
</instance-parameter>
<parameter name="channel" transfer-ownership="none">
<doc xml:space="preserve">The current #GstTunerChannel</doc>
<type name="TunerChannel" c:type="GstTunerChannel*"/>
</parameter>
<parameter name="frequency" transfer-ownership="none">
<doc xml:space="preserve">The new frequency setting</doc>
<type name="gulong" c:type="gulong"/>
</parameter>
</parameters>
</method>
<method name="get_channel"
c:identifier="gst_tuner_get_channel"
introspectable="0">
<doc xml:space="preserve">Retrieve the current channel from the tuner.</doc>
<return-value>
<doc xml:space="preserve">the current channel of the tuner object.</doc>
<type name="TunerChannel" c:type="GstTunerChannel*"/>
</return-value>
<parameters>
<instance-parameter name="tuner" transfer-ownership="none">
<doc xml:space="preserve">the #GstTuner (a #GstElement) to get the current channel from.</doc>
<type name="Tuner" c:type="GstTuner*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_frequency" c:identifier="gst_tuner_get_frequency">
<doc xml:space="preserve">Retrieve the current frequency from the given channel. As for
gst_tuner_set_frequency(), the #GstTunerChannel must support frequency
operations, as indicated by the GST_TUNER_CHANNEL_FREQUENCY flag.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The current frequency, or 0 on error.</doc>
<type name="gulong" c:type="gulong"/>
</return-value>
<parameters>
<instance-parameter name="tuner" transfer-ownership="none">
<doc xml:space="preserve">The #GstTuner (a #GstElement) that owns the given channel.</doc>
<type name="Tuner" c:type="GstTuner*"/>
</instance-parameter>
<parameter name="channel" transfer-ownership="none">
<doc xml:space="preserve">The #GstTunerChannel to retrieve the frequency from.</doc>
<type name="TunerChannel" c:type="GstTunerChannel*"/>
</parameter>
</parameters>
</method>
<method name="get_norm"
c:identifier="gst_tuner_get_norm"
introspectable="0">
<doc xml:space="preserve">Get the current video norm from the given tuner object for the
currently selected channel.</doc>
<return-value>
<doc xml:space="preserve">the current norm.</doc>
<type name="TunerNorm" c:type="GstTunerNorm*"/>
</return-value>
<parameters>
<instance-parameter name="tuner" transfer-ownership="none">
<doc xml:space="preserve">the #GstTuner (a #GstElement) to get the current norm from.</doc>
<type name="Tuner" c:type="GstTuner*"/>
</instance-parameter>
</parameters>
</method>
<method name="list_channels"
c:identifier="gst_tuner_list_channels"
introspectable="0">
<doc xml:space="preserve">Retrieve a #GList of #GstTunerChannels available
(e.g. 'composite', 's-video', ...) from the given tuner object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">A list of channels available on this tuner. The list is
owned by the GstTuner and must not be freed.</doc>
<type name="GLib.List" c:type="const GList*">
<type name="gpointer" c:type="gpointer"/>
</type>
</return-value>
<parameters>
<instance-parameter name="tuner" transfer-ownership="none">
<doc xml:space="preserve">the #GstTuner (a #GstElement) to get the channels from.</doc>
<type name="Tuner" c:type="GstTuner*"/>
</instance-parameter>
</parameters>
</method>
<method name="list_norms"
c:identifier="gst_tuner_list_norms"
introspectable="0">
<doc xml:space="preserve">Retrieve a GList of available #GstTunerNorm settings for the currently
tuned channel on the given tuner object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">A list of norms available on the current channel for this
tuner object. The list is owned by the GstTuner and must not
be freed.</doc>
<type name="GLib.List" c:type="const GList*">
<type name="gpointer" c:type="gpointer"/>
</type>
</return-value>
<parameters>
<instance-parameter name="tuner" transfer-ownership="none">
<doc xml:space="preserve">the #GstTuner (*a #GstElement) to get the list of norms from.</doc>
<type name="Tuner" c:type="GstTuner*"/>
</instance-parameter>
</parameters>
</method>
<method name="norm_changed" c:identifier="gst_tuner_norm_changed">
<doc xml:space="preserve">Called by elements implementing the #GstTuner interface when the
current norm changes. Fires the #GstTuner::norm-changed signal.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="tuner" transfer-ownership="none">
<doc xml:space="preserve">A #GstTuner instance</doc>
<type name="Tuner" c:type="GstTuner*"/>
</instance-parameter>
<parameter name="norm" transfer-ownership="none">
<doc xml:space="preserve">A #GstTunerNorm instance</doc>
<type name="TunerNorm" c:type="GstTunerNorm*"/>
</parameter>
</parameters>
</method>
<method name="set_channel" c:identifier="gst_tuner_set_channel">
<doc xml:space="preserve">Tunes the object to the given channel, which should be one of the
channels returned by gst_tuner_list_channels().</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="tuner" transfer-ownership="none">
<doc xml:space="preserve">the #GstTuner (a #GstElement) that owns the channel.</doc>
<type name="Tuner" c:type="GstTuner*"/>
</instance-parameter>
<parameter name="channel" transfer-ownership="none">
<doc xml:space="preserve">the channel to tune to.</doc>
<type name="TunerChannel" c:type="GstTunerChannel*"/>
</parameter>
</parameters>
</method>
<method name="set_frequency" c:identifier="gst_tuner_set_frequency">
<doc xml:space="preserve">Sets a tuning frequency on the given tuner/channel. Note that this
requires the given channel to be a "tuning" channel, which can be
checked using GST_TUNER_CHANNEL_HAS_FLAG (), with the proper flag
being GST_TUNER_CHANNEL_FREQUENCY.
The frequency is in Hz, with minimum steps indicated by the
frequency_multiplicator provided in the #GstTunerChannel. The
valid range is provided in the min_frequency and max_frequency properties
of the #GstTunerChannel.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="tuner" transfer-ownership="none">
<doc xml:space="preserve">The #GstTuner (a #GstElement) that owns the given channel.</doc>
<type name="Tuner" c:type="GstTuner*"/>
</instance-parameter>
<parameter name="channel" transfer-ownership="none">
<doc xml:space="preserve">The #GstTunerChannel to set the frequency on.</doc>
<type name="TunerChannel" c:type="GstTunerChannel*"/>
</parameter>
<parameter name="frequency" transfer-ownership="none">
<doc xml:space="preserve">The frequency to tune in to.</doc>
<type name="gulong" c:type="gulong"/>
</parameter>
</parameters>
</method>
<method name="set_norm" c:identifier="gst_tuner_set_norm">
<doc xml:space="preserve">Changes the video norm on this tuner to the given norm, which should be
one of the norms returned by gst_tuner_list_norms().</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="tuner" transfer-ownership="none">
<doc xml:space="preserve">the #GstTuner (a #GstElement) to set the norm on.</doc>
<type name="Tuner" c:type="GstTuner*"/>
</instance-parameter>
<parameter name="norm" transfer-ownership="none">
<doc xml:space="preserve">the norm to use for the current channel.</doc>
<type name="TunerNorm" c:type="GstTunerNorm*"/>
</parameter>
</parameters>
</method>
<method name="signal_changed" c:identifier="gst_tuner_signal_changed">
<doc xml:space="preserve">Called by elements implementing the #GstTuner interface when the
incoming signal strength changes. Fires the #GstTuner::signal-changed
signal on the tuner and the #GstTunerChannel::signal-changed signal on
the channel.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="tuner" transfer-ownership="none">
<doc xml:space="preserve">A #GstTuner instance</doc>
<type name="Tuner" c:type="GstTuner*"/>
</instance-parameter>
<parameter name="channel" transfer-ownership="none">
<doc xml:space="preserve">The current #GstTunerChannel</doc>
<type name="TunerChannel" c:type="GstTunerChannel*"/>
</parameter>
<parameter name="signal" transfer-ownership="none">
<doc xml:space="preserve">The new signal strength</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="signal_strength" c:identifier="gst_tuner_signal_strength">
<doc xml:space="preserve">Get the strength of the signal on this channel. Note that this
requires the current channel to be a "tuning" channel, i.e. a
channel on which frequency can be set. This can be checked using
GST_TUNER_CHANNEL_HAS_FLAG (), and the appropriate flag to check
for is GST_TUNER_CHANNEL_FREQUENCY.
The valid range of the signal strength is indicated in the
min_signal and max_signal properties of the #GstTunerChannel.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">Signal strength, or 0 on error.</doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="tuner" transfer-ownership="none">
<doc xml:space="preserve">the #GstTuner (a #GstElement) that owns the given channel.</doc>
<type name="Tuner" c:type="GstTuner*"/>
</instance-parameter>
<parameter name="channel" transfer-ownership="none">
<doc xml:space="preserve">the #GstTunerChannel to get the signal strength from.</doc>
<type name="TunerChannel" c:type="GstTunerChannel*"/>
</parameter>
</parameters>
</method>
<glib:signal name="channel-changed" when="last">
<doc xml:space="preserve">Reports that the current #GstTunerChannel has changed.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="channel" transfer-ownership="none">
<doc xml:space="preserve">The new configured channel.</doc>
<type name="TunerChannel"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="frequency-changed" when="last">
<doc xml:space="preserve">Reports that the current frequency has changed.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="object" transfer-ownership="none">
<type name="TunerChannel"/>
</parameter>
<parameter name="p0" transfer-ownership="none">
<type name="gulong" c:type="gulong"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="norm-changed" when="last">
<doc xml:space="preserve">Reports that the current #GstTunerNorm has changed.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="norm" transfer-ownership="none">
<doc xml:space="preserve">The new configured norm.</doc>
<type name="TunerNorm"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="signal-changed" when="last">
<doc xml:space="preserve">Reports that the signal strength has changed.
See Also: gst_tuner_signal_strength()</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="channel" transfer-ownership="none">
<doc xml:space="preserve">The current #GstTunerChannel</doc>
<type name="TunerChannel"/>
</parameter>
<parameter name="signal" transfer-ownership="none">
<doc xml:space="preserve">The new signal strength (an integer)</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</glib:signal>
</interface>
<class name="TunerChannel"
c:symbol-prefix="tuner_channel"
c:type="GstTunerChannel"
parent="GObject.Object"
glib:type-name="GstTunerChannel"
glib:get-type="gst_tuner_channel_get_type"
glib:type-struct="TunerChannelClass">
<doc xml:space="preserve"><refsect2>
<para>The #GstTunerChannel object is provided by an element implementing
the #GstTuner interface.
</para>
<para>
GstTunerChannel provides a name and flags to determine the type and
capabilities of the channel. If the GST_TUNER_CHANNEL_FREQUENCY flag is
set, then the channel also information about the minimum and maximum
frequency, and range of the reported signal strength.
</para>
</refsect2></doc>
<virtual-method name="frequency_changed">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="channel" transfer-ownership="none">
<type name="TunerChannel" c:type="GstTunerChannel*"/>
</instance-parameter>
<parameter name="frequency" transfer-ownership="none">
<type name="gulong" c:type="gulong"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="signal_changed">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="channel" transfer-ownership="none">
<type name="TunerChannel" c:type="GstTunerChannel*"/>
</instance-parameter>
<parameter name="signal" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</virtual-method>
<field name="parent">
<type name="GObject.Object" c:type="GObject"/>
</field>
<field name="label">
<doc xml:space="preserve">A string containing a descriptive name for this channel</doc>
<type name="utf8" c:type="gchar*"/>
</field>
<field name="flags">
<doc xml:space="preserve">A set of #GstTunerChannelFlags for this channel</doc>
<type name="TunerChannelFlags" c:type="GstTunerChannelFlags"/>
</field>
<field name="freq_multiplicator">
<doc xml:space="preserve">The step size (in Hz) for the frequency setting.</doc>
<type name="gfloat" c:type="gfloat"/>
</field>
<field name="min_frequency">
<doc xml:space="preserve">Minimum valid frequency setting (in Hz).</doc>
<type name="gulong" c:type="gulong"/>
</field>
<field name="max_frequency">
<doc xml:space="preserve">Maximum valid frequency setting (in Hz).</doc>
<type name="gulong" c:type="gulong"/>
</field>
<field name="min_signal">
<doc xml:space="preserve">Minimum reported signal strength value.</doc>
<type name="gint" c:type="gint"/>
</field>
<field name="max_signal">
<doc xml:space="preserve">Maximum reported signal strength value.</doc>
<type name="gint" c:type="gint"/>
</field>
<glib:signal name="frequency-changed" when="last">
<doc xml:space="preserve">Reports that the current frequency has changed.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="frequency" transfer-ownership="none">
<doc xml:space="preserve">The new frequency (an unsigned long)</doc>
<type name="gulong" c:type="gulong"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="signal-changed" when="last">
<doc xml:space="preserve">Reports that the signal strength has changed.
See Also: gst_tuner_signal_strength()</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="signal" transfer-ownership="none">
<doc xml:space="preserve">The new signal strength (an integer)</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</glib:signal>
</class>
<record name="TunerChannelClass"
c:type="GstTunerChannelClass"
glib:is-gtype-struct-for="TunerChannel">
<field name="parent">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="frequency_changed">
<callback name="frequency_changed">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="channel" transfer-ownership="none">
<type name="TunerChannel" c:type="GstTunerChannel*"/>
</parameter>
<parameter name="frequency" transfer-ownership="none">
<type name="gulong" c:type="gulong"/>
</parameter>
</parameters>
</callback>
</field>
<field name="signal_changed">
<callback name="signal_changed">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="channel" transfer-ownership="none">
<type name="TunerChannel" c:type="GstTunerChannel*"/>
</parameter>
<parameter name="signal" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</callback>
</field>
<field name="_gst_reserved" readable="0" private="1">
<array zero-terminated="0" c:type="gpointer" fixed-size="4">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<bitfield name="TunerChannelFlags"
glib:type-name="GstTunerChannelFlags"
glib:get-type="gst_tuner_channel_flags_get_type"
c:type="GstTunerChannelFlags">
<doc xml:space="preserve">An enumeration for flags indicating the available capabilities
of a #GstTunerChannel.</doc>
<member name="input"
value="1"
c:identifier="GST_TUNER_CHANNEL_INPUT"
glib:nick="input">
<doc xml:space="preserve">The channel is for input</doc>
</member>
<member name="output"
value="2"
c:identifier="GST_TUNER_CHANNEL_OUTPUT"
glib:nick="output">
<doc xml:space="preserve">The channel is for output</doc>
</member>
<member name="frequency"
value="4"
c:identifier="GST_TUNER_CHANNEL_FREQUENCY"
glib:nick="frequency">
<doc xml:space="preserve">The channel has a frequency setting
and signal strength.</doc>
</member>
<member name="audio"
value="8"
c:identifier="GST_TUNER_CHANNEL_AUDIO"
glib:nick="audio">
<doc xml:space="preserve">The channel carries audio.</doc>
</member>
</bitfield>
<record name="TunerClass" c:type="GstTunerClass">
<doc xml:space="preserve">Tuner interface.</doc>
<field name="klass" writable="1">
<doc xml:space="preserve">the parent interface</doc>
<type name="GObject.TypeInterface" c:type="GTypeInterface"/>
</field>
<field name="list_channels" introspectable="0">
<callback name="list_channels" introspectable="0">
<return-value transfer-ownership="none">
<type name="GLib.List" c:type="const GList*">
<type name="gpointer" c:type="gpointer"/>
</type>
</return-value>
<parameters>
<parameter name="tuner" transfer-ownership="none">
<type name="Tuner" c:type="GstTuner*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="set_channel">
<callback name="set_channel">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="tuner" transfer-ownership="none">
<type name="Tuner" c:type="GstTuner*"/>
</parameter>
<parameter name="channel" transfer-ownership="none">
<type name="TunerChannel" c:type="GstTunerChannel*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="get_channel" introspectable="0">
<callback name="get_channel" introspectable="0">
<return-value>
<type name="TunerChannel" c:type="GstTunerChannel*"/>
</return-value>
<parameters>
<parameter name="tuner" transfer-ownership="none">
<type name="Tuner" c:type="GstTuner*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="list_norms" introspectable="0">
<callback name="list_norms" introspectable="0">
<return-value transfer-ownership="none">
<type name="GLib.List" c:type="const GList*">
<type name="gpointer" c:type="gpointer"/>
</type>
</return-value>
<parameters>
<parameter name="tuner" transfer-ownership="none">
<type name="Tuner" c:type="GstTuner*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="set_norm">
<callback name="set_norm">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="tuner" transfer-ownership="none">
<type name="Tuner" c:type="GstTuner*"/>
</parameter>
<parameter name="norm" transfer-ownership="none">
<type name="TunerNorm" c:type="GstTunerNorm*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="get_norm" introspectable="0">
<callback name="get_norm" introspectable="0">
<return-value>
<type name="TunerNorm" c:type="GstTunerNorm*"/>
</return-value>
<parameters>
<parameter name="tuner" transfer-ownership="none">
<type name="Tuner" c:type="GstTuner*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="set_frequency">
<callback name="set_frequency">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="tuner" transfer-ownership="none">
<type name="Tuner" c:type="GstTuner*"/>
</parameter>
<parameter name="channel" transfer-ownership="none">
<type name="TunerChannel" c:type="GstTunerChannel*"/>
</parameter>
<parameter name="frequency" transfer-ownership="none">
<type name="gulong" c:type="gulong"/>
</parameter>
</parameters>
</callback>
</field>
<field name="get_frequency">
<callback name="get_frequency">
<return-value transfer-ownership="none">
<type name="gulong" c:type="gulong"/>
</return-value>
<parameters>
<parameter name="tuner" transfer-ownership="none">
<type name="Tuner" c:type="GstTuner*"/>
</parameter>
<parameter name="channel" transfer-ownership="none">
<type name="TunerChannel" c:type="GstTunerChannel*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="signal_strength">
<callback name="signal_strength">
<return-value transfer-ownership="none">
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<parameter name="tuner" transfer-ownership="none">
<type name="Tuner" c:type="GstTuner*"/>
</parameter>
<parameter name="channel" transfer-ownership="none">
<type name="TunerChannel" c:type="GstTunerChannel*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="channel_changed">
<callback name="channel_changed">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="tuner" transfer-ownership="none">
<type name="Tuner" c:type="GstTuner*"/>
</parameter>
<parameter name="channel" transfer-ownership="none">
<type name="TunerChannel" c:type="GstTunerChannel*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="norm_changed">
<callback name="norm_changed">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="tuner" transfer-ownership="none">
<type name="Tuner" c:type="GstTuner*"/>
</parameter>
<parameter name="norm" transfer-ownership="none">
<type name="TunerNorm" c:type="GstTunerNorm*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="frequency_changed">
<callback name="frequency_changed">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="tuner" transfer-ownership="none">
<type name="Tuner" c:type="GstTuner*"/>
</parameter>
<parameter name="channel" transfer-ownership="none">
<type name="TunerChannel" c:type="GstTunerChannel*"/>
</parameter>
<parameter name="frequency" transfer-ownership="none">
<type name="gulong" c:type="gulong"/>
</parameter>
</parameters>
</callback>
</field>
<field name="signal_changed">
<callback name="signal_changed">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="tuner" transfer-ownership="none">
<type name="Tuner" c:type="GstTuner*"/>
</parameter>
<parameter name="channel" transfer-ownership="none">
<type name="TunerChannel" c:type="GstTunerChannel*"/>
</parameter>
<parameter name="signal" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</callback>
</field>
<field name="_gst_reserved" readable="0" private="1">
<array zero-terminated="0" c:type="gpointer" fixed-size="4">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<class name="TunerNorm"
c:symbol-prefix="tuner_norm"
c:type="GstTunerNorm"
parent="GObject.Object"
glib:type-name="GstTunerNorm"
glib:get-type="gst_tuner_norm_get_type"
glib:type-struct="TunerNormClass">
<doc xml:space="preserve"><refsect2>
<para>The #GstTunerNorm object is created by an element implementing the
#GstTuner interface and encapsulates the selection of a capture/output format
for a selected #GstTunerChannel.
</para>
</refsect2></doc>
<field name="parent">
<type name="GObject.Object" c:type="GObject"/>
</field>
<field name="label">
<doc xml:space="preserve">A string containing a descriptive name for the norm</doc>
<type name="utf8" c:type="gchar*"/>
</field>
<field name="framerate">
<doc xml:space="preserve">A GValue containing the framerate associated with this norm,
if any. (May be unset).</doc>
<type name="GObject.Value" c:type="GValue"/>
</field>
</class>
<record name="TunerNormClass"
c:type="GstTunerNormClass"
glib:is-gtype-struct-for="TunerNorm">
<field name="parent">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="_gst_reserved">
<array zero-terminated="0" c:type="gpointer" fixed-size="4">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<interface name="VideoOrientation"
c:symbol-prefix="video_orientation"
c:type="GstVideoOrientation"
glib:type-name="GstVideoOrientation"
glib:get-type="gst_video_orientation_get_type"
glib:type-struct="VideoOrientationInterface">
<doc xml:space="preserve">The interface allows unified access to control flipping and autocenter
operation of video-sources or operators.</doc>
<prerequisite name="Gst.Element"/>
<prerequisite name="Gst.ImplementsInterface"/>
<virtual-method name="get_hcenter"
invoker="get_hcenter"
version="0.10.11">
<doc xml:space="preserve">Get the horizontal centering offset from the given object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports centering</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="video_orientation"
transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</instance-parameter>
<parameter name="center" transfer-ownership="none">
<doc xml:space="preserve">return location for the result</doc>
<type name="gint" c:type="gint*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="get_hflip" invoker="get_hflip" version="0.10.11">
<doc xml:space="preserve">Get the horizontal flipping state (%TRUE for flipped) from the given object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports flipping</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="video_orientation"
transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</instance-parameter>
<parameter name="flip" transfer-ownership="none">
<doc xml:space="preserve">return location for the result</doc>
<type name="gboolean" c:type="gboolean*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="get_vcenter"
invoker="get_vcenter"
version="0.10.11">
<doc xml:space="preserve">Get the vertical centering offset from the given object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports centering</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="video_orientation"
transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</instance-parameter>
<parameter name="center" transfer-ownership="none">
<doc xml:space="preserve">return location for the result</doc>
<type name="gint" c:type="gint*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="get_vflip" invoker="get_vflip" version="0.10.11">
<doc xml:space="preserve">Get the vertical flipping state (%TRUE for flipped) from the given object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports flipping</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="video_orientation"
transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</instance-parameter>
<parameter name="flip" transfer-ownership="none">
<doc xml:space="preserve">return location for the result</doc>
<type name="gboolean" c:type="gboolean*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="set_hcenter"
invoker="set_hcenter"
version="0.10.11">
<doc xml:space="preserve">Set the horizontal centering offset for the given object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports centering</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="video_orientation"
transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</instance-parameter>
<parameter name="center" transfer-ownership="none">
<doc xml:space="preserve">centering offset</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="set_hflip" invoker="set_hflip" version="0.10.11">
<doc xml:space="preserve">Set the horizontal flipping state (%TRUE for flipped) for the given object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports flipping</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="video_orientation"
transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</instance-parameter>
<parameter name="flip" transfer-ownership="none">
<doc xml:space="preserve">use flipping</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="set_vcenter"
invoker="set_vcenter"
version="0.10.11">
<doc xml:space="preserve">Set the vertical centering offset for the given object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports centering</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="video_orientation"
transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</instance-parameter>
<parameter name="center" transfer-ownership="none">
<doc xml:space="preserve">centering offset</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="set_vflip" invoker="set_vflip" version="0.10.11">
<doc xml:space="preserve">Set the vertical flipping state (%TRUE for flipped) for the given object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports flipping</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="video_orientation"
transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</instance-parameter>
<parameter name="flip" transfer-ownership="none">
<doc xml:space="preserve">use flipping</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</virtual-method>
<method name="get_hcenter"
c:identifier="gst_video_orientation_get_hcenter"
version="0.10.11">
<doc xml:space="preserve">Get the horizontal centering offset from the given object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports centering</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="video_orientation"
transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</instance-parameter>
<parameter name="center" transfer-ownership="none">
<doc xml:space="preserve">return location for the result</doc>
<type name="gint" c:type="gint*"/>
</parameter>
</parameters>
</method>
<method name="get_hflip"
c:identifier="gst_video_orientation_get_hflip"
version="0.10.11">
<doc xml:space="preserve">Get the horizontal flipping state (%TRUE for flipped) from the given object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports flipping</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="video_orientation"
transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</instance-parameter>
<parameter name="flip" transfer-ownership="none">
<doc xml:space="preserve">return location for the result</doc>
<type name="gboolean" c:type="gboolean*"/>
</parameter>
</parameters>
</method>
<method name="get_vcenter"
c:identifier="gst_video_orientation_get_vcenter"
version="0.10.11">
<doc xml:space="preserve">Get the vertical centering offset from the given object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports centering</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="video_orientation"
transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</instance-parameter>
<parameter name="center" transfer-ownership="none">
<doc xml:space="preserve">return location for the result</doc>
<type name="gint" c:type="gint*"/>
</parameter>
</parameters>
</method>
<method name="get_vflip"
c:identifier="gst_video_orientation_get_vflip"
version="0.10.11">
<doc xml:space="preserve">Get the vertical flipping state (%TRUE for flipped) from the given object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports flipping</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="video_orientation"
transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</instance-parameter>
<parameter name="flip" transfer-ownership="none">
<doc xml:space="preserve">return location for the result</doc>
<type name="gboolean" c:type="gboolean*"/>
</parameter>
</parameters>
</method>
<method name="set_hcenter"
c:identifier="gst_video_orientation_set_hcenter"
version="0.10.11">
<doc xml:space="preserve">Set the horizontal centering offset for the given object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports centering</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="video_orientation"
transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</instance-parameter>
<parameter name="center" transfer-ownership="none">
<doc xml:space="preserve">centering offset</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="set_hflip"
c:identifier="gst_video_orientation_set_hflip"
version="0.10.11">
<doc xml:space="preserve">Set the horizontal flipping state (%TRUE for flipped) for the given object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports flipping</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="video_orientation"
transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</instance-parameter>
<parameter name="flip" transfer-ownership="none">
<doc xml:space="preserve">use flipping</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_vcenter"
c:identifier="gst_video_orientation_set_vcenter"
version="0.10.11">
<doc xml:space="preserve">Set the vertical centering offset for the given object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports centering</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="video_orientation"
transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</instance-parameter>
<parameter name="center" transfer-ownership="none">
<doc xml:space="preserve">centering offset</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="set_vflip"
c:identifier="gst_video_orientation_set_vflip"
version="0.10.11">
<doc xml:space="preserve">Set the vertical flipping state (%TRUE for flipped) for the given object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports flipping</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="video_orientation"
transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</instance-parameter>
<parameter name="flip" transfer-ownership="none">
<doc xml:space="preserve">use flipping</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
</interface>
<record name="VideoOrientationInterface"
c:type="GstVideoOrientationInterface"
glib:is-gtype-struct-for="VideoOrientation">
<doc xml:space="preserve">#GstVideoOrientationInterface interface.</doc>
<field name="parent">
<doc xml:space="preserve">parent interface type.</doc>
<type name="GObject.TypeInterface" c:type="GTypeInterface"/>
</field>
<field name="get_hflip">
<callback name="get_hflip">
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports flipping</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="video_orientation" transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</parameter>
<parameter name="flip" transfer-ownership="none">
<doc xml:space="preserve">return location for the result</doc>
<type name="gboolean" c:type="gboolean*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="get_vflip">
<callback name="get_vflip">
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports flipping</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="video_orientation" transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</parameter>
<parameter name="flip" transfer-ownership="none">
<doc xml:space="preserve">return location for the result</doc>
<type name="gboolean" c:type="gboolean*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="get_hcenter">
<callback name="get_hcenter">
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports centering</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="video_orientation" transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</parameter>
<parameter name="center" transfer-ownership="none">
<doc xml:space="preserve">return location for the result</doc>
<type name="gint" c:type="gint*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="get_vcenter">
<callback name="get_vcenter">
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports centering</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="video_orientation" transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</parameter>
<parameter name="center" transfer-ownership="none">
<doc xml:space="preserve">return location for the result</doc>
<type name="gint" c:type="gint*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="set_hflip">
<callback name="set_hflip">
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports flipping</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="video_orientation" transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</parameter>
<parameter name="flip" transfer-ownership="none">
<doc xml:space="preserve">use flipping</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</callback>
</field>
<field name="set_vflip">
<callback name="set_vflip">
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports flipping</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="video_orientation" transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</parameter>
<parameter name="flip" transfer-ownership="none">
<doc xml:space="preserve">use flipping</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</callback>
</field>
<field name="set_hcenter">
<callback name="set_hcenter">
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports centering</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="video_orientation" transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</parameter>
<parameter name="center" transfer-ownership="none">
<doc xml:space="preserve">centering offset</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</callback>
</field>
<field name="set_vcenter">
<callback name="set_vcenter">
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports centering</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="video_orientation" transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</parameter>
<parameter name="center" transfer-ownership="none">
<doc xml:space="preserve">centering offset</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</callback>
</field>
<field name="_gst_reserved" readable="0" private="1">
<array zero-terminated="0" c:type="gpointer" fixed-size="4">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<interface name="XOverlay"
c:symbol-prefix="x_overlay"
c:type="GstXOverlay"
glib:type-name="GstXOverlay"
glib:get-type="gst_x_overlay_get_type">
<doc xml:space="preserve"><refsect2>
<para>
The XOverlay interface is used for 2 main purposes :
<itemizedlist>
<listitem>
<para>
To get a grab on the Window where the video sink element is going to render.
This is achieved by either being informed about the Window identifier that
the video sink element generated, or by forcing the video sink element to use
a specific Window identifier for rendering.
</para>
</listitem>
<listitem>
<para>
To force a redrawing of the latest video frame the video sink element
displayed on the Window. Indeed if the #GstPipeline is in #GST_STATE_PAUSED
state, moving the Window around will damage its content. Application
developers will want to handle the Expose events themselves and force the
video sink element to refresh the Window's content.
</para>
</listitem>
</itemizedlist>
</para>
<para>
Using the Window created by the video sink is probably the simplest scenario,
in some cases, though, it might not be flexible enough for application
developers if they need to catch events such as mouse moves and button
clicks.
</para>
<para>
Setting a specific Window identifier on the video sink element is the most
flexible solution but it has some issues. Indeed the application needs to set
its Window identifier at the right time to avoid internal Window creation
from the video sink element. To solve this issue a #GstMessage is posted on
the bus to inform the application that it should set the Window identifier
immediately. Here is an example on how to do that correctly:
|[
static GstBusSyncReply
create_window (GstBus * bus, GstMessage * message, GstPipeline * pipeline)
{
// ignore anything but 'prepare-xwindow-id' element messages
if (GST_MESSAGE_TYPE (message) != GST_MESSAGE_ELEMENT)
return GST_BUS_PASS;
if (!gst_structure_has_name (message-&gt;structure, "prepare-xwindow-id"))
return GST_BUS_PASS;
win = XCreateSimpleWindow (disp, root, 0, 0, 320, 240, 0, 0, 0);
XSetWindowBackgroundPixmap (disp, win, None);
XMapRaised (disp, win);
XSync (disp, FALSE);
gst_x_overlay_set_window_handle (GST_X_OVERLAY (GST_MESSAGE_SRC (message)),
win);
gst_message_unref (message);
return GST_BUS_DROP;
}
...
int
main (int argc, char **argv)
{
...
bus = gst_pipeline_get_bus (GST_PIPELINE (pipeline));
gst_bus_set_sync_handler (bus, (GstBusSyncHandler) create_window, pipeline);
...
}
]|
</para>
</refsect2>
<refsect2>
<title>Two basic usage scenarios</title>
<para>
There are two basic usage scenarios: in the simplest case, the application
knows exactly what particular element is used for video output, which is
usually the case when the application creates the videosink to use
(e.g. #xvimagesink, #ximagesink, etc.) itself; in this case, the application
can just create the videosink element, create and realize the window to
render the video on and then call gst_x_overlay_set_window_handle() directly
with the XID or native window handle, before starting up the pipeline.
</para>
<para>
In the other and more common case, the application does not know in advance
what GStreamer video sink element will be used for video output. This is
usually the case when an element such as #autovideosink or #gconfvideosink
is used. In this case, the video sink element itself is created
asynchronously from a GStreamer streaming thread some time after the
pipeline has been started up. When that happens, however, the video sink
will need to know right then whether to render onto an already existing
application window or whether to create its own window. This is when it
posts a prepare-xwindow-id message, and that is also why this message needs
to be handled in a sync bus handler which will be called from the streaming
thread directly (because the video sink will need an answer right then).
</para>
<para>
As response to the prepare-xwindow-id element message in the bus sync
handler, the application may use gst_x_overlay_set_window_handle() to tell
the video sink to render onto an existing window surface. At this point the
application should already have obtained the window handle / XID, so it
just needs to set it. It is generally not advisable to call any GUI toolkit
functions or window system functions from the streaming thread in which the
prepare-xwindow-id message is handled, because most GUI toolkits and
windowing systems are not thread-safe at all and a lot of care would be
required to co-ordinate the toolkit and window system calls of the
different threads (Gtk+ users please note: prior to Gtk+ 2.18
GDK_WINDOW_XID() was just a simple structure access, so generally fine to do
within the bus sync handler; this macro was changed to a function call in
Gtk+ 2.18 and later, which is likely to cause problems when called from a
sync handler; see below for a better approach without GDK_WINDOW_XID()
used in the callback).
</para>
</refsect2>
<refsect2>
<title>GstXOverlay and Gtk+</title>
<para>
|[
#include &lt;gst/interfaces/xoverlay.h&gt;
#include &lt;gtk/gtk.h&gt;
#ifdef GDK_WINDOWING_X11
#include &lt;gdk/gdkx.h&gt; // for GDK_WINDOW_XID
#endif
...
static gulong video_window_xid = 0;
...
static GstBusSyncReply
bus_sync_handler (GstBus * bus, GstMessage * message, gpointer user_data)
{
// ignore anything but 'prepare-xwindow-id' element messages
if (GST_MESSAGE_TYPE (message) != GST_MESSAGE_ELEMENT)
return GST_BUS_PASS;
if (!gst_structure_has_name (message-&gt;structure, "prepare-xwindow-id"))
return GST_BUS_PASS;
if (video_window_xid != 0) {
GstXOverlay *xoverlay;
// GST_MESSAGE_SRC (message) will be the video sink element
xoverlay = GST_X_OVERLAY (GST_MESSAGE_SRC (message));
gst_x_overlay_set_window_handle (xoverlay, video_window_xid);
} else {
g_warning ("Should have obtained video_window_xid by now!");
}
gst_message_unref (message);
return GST_BUS_DROP;
}
...
static void
video_widget_realize_cb (GtkWidget * widget, gpointer data)
{
#if GTK_CHECK_VERSION(2,18,0)
// This is here just for pedagogical purposes, GDK_WINDOW_XID will call
// it as well in newer Gtk versions
if (!gdk_window_ensure_native (widget->window))
g_error ("Couldn't create native window needed for GstXOverlay!");
#endif
#ifdef GDK_WINDOWING_X11
video_window_xid = GDK_WINDOW_XID (gtk_widget_get_window (video_window));
#endif
}
...
int
main (int argc, char **argv)
{
GtkWidget *video_window;
GtkWidget *app_window;
...
app_window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
...
video_window = gtk_drawing_area_new ();
g_signal_connect (video_window, "realize",
G_CALLBACK (video_widget_realize_cb), NULL);
gtk_widget_set_double_buffered (video_window, FALSE);
...
// usually the video_window will not be directly embedded into the
// application window like this, but there will be many other widgets
// and the video window will be embedded in one of them instead
gtk_container_add (GTK_CONTAINER (ap_window), video_window);
...
// show the GUI
gtk_widget_show_all (app_window);
// realize window now so that the video window gets created and we can
// obtain its XID before the pipeline is started up and the videosink
// asks for the XID of the window to render onto
gtk_widget_realize (video_window);
// we should have the XID now
g_assert (video_window_xid != 0);
...
// set up sync handler for setting the xid once the pipeline is started
bus = gst_pipeline_get_bus (GST_PIPELINE (pipeline));
gst_bus_set_sync_handler (bus, (GstBusSyncHandler) bus_sync_handler, NULL);
gst_object_unref (bus);
...
gst_element_set_state (pipeline, GST_STATE_PLAYING);
...
}
]|
</para>
</refsect2>
<refsect2>
<title>GstXOverlay and Qt</title>
<para>
|[
#include &lt;glib.h&gt;
#include &lt;gst/gst.h&gt;
#include &lt;gst/interfaces/xoverlay.h&gt;
#include &lt;QApplication&gt;
#include &lt;QTimer&gt;
#include &lt;QWidget&gt;
int main(int argc, char *argv[])
{
if (!g_thread_supported ())
g_thread_init (NULL);
gst_init (&argc, &argv);
QApplication app(argc, argv);
app.connect(&app, SIGNAL(lastWindowClosed()), &app, SLOT(quit ()));
// prepare the pipeline
GstElement *pipeline = gst_pipeline_new ("xvoverlay");
GstElement *src = gst_element_factory_make ("videotestsrc", NULL);
GstElement *sink = gst_element_factory_make ("xvimagesink", NULL);
gst_bin_add_many (GST_BIN (pipeline), src, sink, NULL);
gst_element_link (src, sink);
// prepare the ui
QWidget window;
window.resize(320, 240);
window.show();
WId xwinid = window.winId();
gst_x_overlay_set_window_handle (GST_X_OVERLAY (sink), xwinid);
// run the pipeline
GstStateChangeReturn sret = gst_element_set_state (pipeline,
GST_STATE_PLAYING);
if (sret == GST_STATE_CHANGE_FAILURE) {
gst_element_set_state (pipeline, GST_STATE_NULL);
gst_object_unref (pipeline);
// Exit application
QTimer::singleShot(0, QApplication::activeWindow(), SLOT(quit()));
}
int ret = app.exec();
window.hide();
gst_element_set_state (pipeline, GST_STATE_NULL);
gst_object_unref (pipeline);
return ret;
}
]|
</para>
</refsect2></doc>
<prerequisite name="Gst.Element"/>
<prerequisite name="Gst.ImplementsInterface"/>
<method name="expose" c:identifier="gst_x_overlay_expose">
<doc xml:space="preserve">Tell an overlay that it has been exposed. This will redraw the current frame
in the drawable even if the pipeline is PAUSED.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="overlay" transfer-ownership="none">
<doc xml:space="preserve">a #GstXOverlay to expose.</doc>
<type name="XOverlay" c:type="GstXOverlay*"/>
</instance-parameter>
</parameters>
</method>
<method name="got_window_handle"
c:identifier="gst_x_overlay_got_window_handle">
<doc xml:space="preserve">This will post a "have-xwindow-id" element message on the bus.
This function should only be used by video overlay plugin developers.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="overlay" transfer-ownership="none">
<doc xml:space="preserve">a #GstXOverlay which got a window</doc>
<type name="XOverlay" c:type="GstXOverlay*"/>
</instance-parameter>
<parameter name="handle" transfer-ownership="none">
<doc xml:space="preserve">a platform-specific handle referencing the window</doc>
<type name="guintptr" c:type="guintptr"/>
</parameter>
</parameters>
</method>
<method name="got_xwindow_id"
c:identifier="gst_x_overlay_got_xwindow_id"
deprecated="1">
<doc xml:space="preserve">This will post a "have-xwindow-id" element message on the bus.
This function should only be used by video overlay plugin developers.</doc>
<doc-deprecated xml:space="preserve">Use gst_x_overlay_got_window_handle() instead.</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="overlay" transfer-ownership="none">
<doc xml:space="preserve">a #GstXOverlay which got a XWindow.</doc>
<type name="XOverlay" c:type="GstXOverlay*"/>
</instance-parameter>
<parameter name="xwindow_id" transfer-ownership="none">
<doc xml:space="preserve">a XID referencing the XWindow.</doc>
<type name="gulong" c:type="gulong"/>
</parameter>
</parameters>
</method>
<method name="handle_events"
c:identifier="gst_x_overlay_handle_events"
version="0.10.12">
<doc xml:space="preserve">Tell an overlay that it should handle events from the window system. These
events are forwarded upstream as navigation events. In some window system,
events are not propagated in the window hierarchy if a client is listening
for them. This method allows you to disable events handling completely
from the XOverlay.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="overlay" transfer-ownership="none">
<doc xml:space="preserve">a #GstXOverlay to expose.</doc>
<type name="XOverlay" c:type="GstXOverlay*"/>
</instance-parameter>
<parameter name="handle_events" transfer-ownership="none">
<doc xml:space="preserve">a #gboolean indicating if events should be handled or not.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="prepare_xwindow_id"
c:identifier="gst_x_overlay_prepare_xwindow_id">
<doc xml:space="preserve">This will post a "prepare-xwindow-id" element message on the bus
to give applications an opportunity to call
gst_x_overlay_set_xwindow_id() before a plugin creates its own
window.
This function should only be used by video overlay plugin developers.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="overlay" transfer-ownership="none">
<doc xml:space="preserve">a #GstXOverlay which does not yet have an XWindow.</doc>
<type name="XOverlay" c:type="GstXOverlay*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_render_rectangle"
c:identifier="gst_x_overlay_set_render_rectangle"
version="0.10.29">
<doc xml:space="preserve">Configure a subregion as a video target within the window set by
gst_x_overlay_set_window_handle(). If this is not used or not supported
the video will fill the area of the window set as the overlay to 100%.
By specifying the rectangle, the video can be overlayed to a specific region
of that window only. After setting the new rectangle one should call
gst_x_overlay_expose() to force a redraw. To unset the region pass -1 for
the @width and @height parameters.
This method is needed for non fullscreen video overlay in UI toolkits that
do not support subwindows.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%FALSE if not supported by the sink.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="overlay" transfer-ownership="none">
<doc xml:space="preserve">a #GstXOverlay</doc>
<type name="XOverlay" c:type="GstXOverlay*"/>
</instance-parameter>
<parameter name="x" transfer-ownership="none">
<doc xml:space="preserve">the horizontal offset of the render area inside the window</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="y" transfer-ownership="none">
<doc xml:space="preserve">the vertical offset of the render area inside the window</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve">the width of the render area inside the window</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:space="preserve">the height of the render area inside the window</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="set_window_handle"
c:identifier="gst_x_overlay_set_window_handle"
version="0.10.31">
<doc xml:space="preserve">This will call the video overlay's set_window_handle method. You
should use this method to tell to a XOverlay to display video output to a
specific window (e.g. an XWindow on X11). Passing 0 as the @handle will
tell the overlay to stop using that window and create an internal one.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="overlay" transfer-ownership="none">
<doc xml:space="preserve">a #GstXOverlay to set the window on.</doc>
<type name="XOverlay" c:type="GstXOverlay*"/>
</instance-parameter>
<parameter name="handle" transfer-ownership="none">
<doc xml:space="preserve">a handle referencing the window.</doc>
<type name="guintptr" c:type="guintptr"/>
</parameter>
</parameters>
</method>
<method name="set_xwindow_id"
c:identifier="gst_x_overlay_set_xwindow_id"
deprecated="1">
<doc xml:space="preserve">This will call the video overlay's set_xwindow_id method. You should
use this method to tell to a XOverlay to display video output to a
specific XWindow. Passing 0 as the @xwindow_id will tell the overlay to
stop using that window and create an internal one.</doc>
<doc-deprecated xml:space="preserve">Use gst_x_overlay_set_window_handle() instead.</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="overlay" transfer-ownership="none">
<doc xml:space="preserve">a #GstXOverlay to set the window on.</doc>
<type name="XOverlay" c:type="GstXOverlay*"/>
</instance-parameter>
<parameter name="xwindow_id" transfer-ownership="none">
<doc xml:space="preserve">a XID referencing the XWindow.</doc>
<type name="gulong" c:type="gulong"/>
</parameter>
</parameters>
</method>
</interface>
<record name="XOverlayClass" c:type="GstXOverlayClass">
<doc xml:space="preserve">#GstXOverlay interface</doc>
<field name="klass" writable="1">
<doc xml:space="preserve">parent interface type.</doc>
<type name="GObject.TypeInterface" c:type="GTypeInterface"/>
</field>
<field name="set_xwindow_id">
<callback name="set_xwindow_id">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="overlay" transfer-ownership="none">
<type name="XOverlay" c:type="GstXOverlay*"/>
</parameter>
<parameter name="xwindow_id" transfer-ownership="none">
<type name="gulong" c:type="gulong"/>
</parameter>
</parameters>
</callback>
</field>
<field name="expose">
<callback name="expose">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="overlay" transfer-ownership="none">
<type name="XOverlay" c:type="GstXOverlay*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="handle_events">
<callback name="handle_events">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="overlay" transfer-ownership="none">
<type name="XOverlay" c:type="GstXOverlay*"/>
</parameter>
<parameter name="handle_events" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</callback>
</field>
<field name="set_render_rectangle">
<callback name="set_render_rectangle">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="overlay" transfer-ownership="none">
<type name="XOverlay" c:type="GstXOverlay*"/>
</parameter>
<parameter name="x" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="y" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</callback>
</field>
<field name="set_window_handle">
<callback name="set_window_handle">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="overlay" transfer-ownership="none">
<type name="XOverlay" c:type="GstXOverlay*"/>
</parameter>
<parameter name="handle" transfer-ownership="none">
<type name="guintptr" c:type="guintptr"/>
</parameter>
</parameters>
</callback>
</field>
<field name="_gst_reserved" readable="0" private="1">
<array zero-terminated="0" c:type="gpointer" fixed-size="1">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<function name="interfaces_marshal_VOID__OBJECT_BOOLEAN"
c:identifier="gst_interfaces_marshal_VOID__OBJECT_BOOLEAN">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="closure" transfer-ownership="none">
<type name="GObject.Closure" c:type="GClosure*"/>
</parameter>
<parameter name="return_value" transfer-ownership="none">
<type name="GObject.Value" c:type="GValue*"/>
</parameter>
<parameter name="n_param_values" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="param_values" transfer-ownership="none">
<type name="GObject.Value" c:type="const GValue*"/>
</parameter>
<parameter name="invocation_hint" transfer-ownership="none">
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="marshal_data" transfer-ownership="none">
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</function>
<function name="interfaces_marshal_VOID__OBJECT_INT"
c:identifier="gst_interfaces_marshal_VOID__OBJECT_INT">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="closure" transfer-ownership="none">
<type name="GObject.Closure" c:type="GClosure*"/>
</parameter>
<parameter name="return_value" transfer-ownership="none">
<type name="GObject.Value" c:type="GValue*"/>
</parameter>
<parameter name="n_param_values" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="param_values" transfer-ownership="none">
<type name="GObject.Value" c:type="const GValue*"/>
</parameter>
<parameter name="invocation_hint" transfer-ownership="none">
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="marshal_data" transfer-ownership="none">
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</function>
<function name="interfaces_marshal_VOID__OBJECT_POINTER"
c:identifier="gst_interfaces_marshal_VOID__OBJECT_POINTER">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="closure" transfer-ownership="none">
<type name="GObject.Closure" c:type="GClosure*"/>
</parameter>
<parameter name="return_value" transfer-ownership="none">
<type name="GObject.Value" c:type="GValue*"/>
</parameter>
<parameter name="n_param_values" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="param_values" transfer-ownership="none">
<type name="GObject.Value" c:type="const GValue*"/>
</parameter>
<parameter name="invocation_hint" transfer-ownership="none">
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="marshal_data" transfer-ownership="none">
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</function>
<function name="interfaces_marshal_VOID__OBJECT_STRING"
c:identifier="gst_interfaces_marshal_VOID__OBJECT_STRING">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="closure" transfer-ownership="none">
<type name="GObject.Closure" c:type="GClosure*"/>
</parameter>
<parameter name="return_value" transfer-ownership="none">
<type name="GObject.Value" c:type="GValue*"/>
</parameter>
<parameter name="n_param_values" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="param_values" transfer-ownership="none">
<type name="GObject.Value" c:type="const GValue*"/>
</parameter>
<parameter name="invocation_hint" transfer-ownership="none">
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="marshal_data" transfer-ownership="none">
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</function>
<function name="interfaces_marshal_VOID__OBJECT_ULONG"
c:identifier="gst_interfaces_marshal_VOID__OBJECT_ULONG">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="closure" transfer-ownership="none">
<type name="GObject.Closure" c:type="GClosure*"/>
</parameter>
<parameter name="return_value" transfer-ownership="none">
<type name="GObject.Value" c:type="GValue*"/>
</parameter>
<parameter name="n_param_values" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="param_values" transfer-ownership="none">
<type name="GObject.Value" c:type="const GValue*"/>
</parameter>
<parameter name="invocation_hint" transfer-ownership="none">
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="marshal_data" transfer-ownership="none">
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</function>
<function name="mixer_message_get_type"
c:identifier="gst_mixer_message_get_type"
moved-to="Mixer.message_get_type"
version="0.10.14">
<doc xml:space="preserve">Check a bus message to see if it is a GstMixer notification
message and return the GstMixerMessageType identifying which
type of notification it is.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The type of the GstMixerMessage, or GST_MIXER_MESSAGE_INVALID
if the message is not a GstMixer notification.</doc>
<type name="MixerMessageType" c:type="GstMixerMessageType"/>
</return-value>
<parameters>
<parameter name="message" transfer-ownership="none">
<doc xml:space="preserve">A GstMessage to inspect.</doc>
<type name="Gst.Message" c:type="GstMessage*"/>
</parameter>
</parameters>
</function>
<function name="mixer_message_parse_mute_toggled"
c:identifier="gst_mixer_message_parse_mute_toggled"
moved-to="Mixer.message_parse_mute_toggled"
version="0.10.14">
<doc xml:space="preserve">Extracts the contents of a mute-toggled bus message. Reads
the GstMixerTrack that has changed, and the new value of the mute
flag.
The GstMixerTrack remains valid until the message is freed.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="message" transfer-ownership="none">
<doc xml:space="preserve">A mute-toggled change notification message.</doc>
<type name="Gst.Message" c:type="GstMessage*"/>
</parameter>
<parameter name="track" transfer-ownership="none">
<doc xml:space="preserve">Pointer to hold a GstMixerTrack object, or NULL.</doc>
<type name="MixerTrack" c:type="GstMixerTrack**"/>
</parameter>
<parameter name="mute" transfer-ownership="none">
<doc xml:space="preserve">A pointer to a gboolean variable, or NULL.</doc>
<type name="gboolean" c:type="gboolean*"/>
</parameter>
</parameters>
</function>
<function name="mixer_message_parse_option_changed"
c:identifier="gst_mixer_message_parse_option_changed"
moved-to="Mixer.message_parse_option_changed"
version="0.10.14">
<doc xml:space="preserve">Extracts the GstMixerOptions and new value from a option-changed bus notification
message.
The options and value returned remain valid until the message is freed.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="message" transfer-ownership="none">
<doc xml:space="preserve">A volume-changed change notification message.</doc>
<type name="Gst.Message" c:type="GstMessage*"/>
</parameter>
<parameter name="options" transfer-ownership="none">
<doc xml:space="preserve">Pointer to hold a GstMixerOptions object, or NULL.</doc>
<type name="MixerOptions" c:type="GstMixerOptions**"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">Result location to receive the new options value, or NULL.</doc>
<type name="utf8" c:type="const gchar**"/>
</parameter>
</parameters>
</function>
<function name="mixer_message_parse_options_list_changed"
c:identifier="gst_mixer_message_parse_options_list_changed"
moved-to="Mixer.message_parse_options_list_changed"
version="0.10.18">
<doc xml:space="preserve">Extracts the GstMixerOptions whose value list has changed from an
options-list-changed bus notification message.
The options object returned remains valid until the message is freed. You
do not need to unref it.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="message" transfer-ownership="none">
<doc xml:space="preserve">A volume-changed change notification message.</doc>
<type name="Gst.Message" c:type="GstMessage*"/>
</parameter>
<parameter name="options" transfer-ownership="none">
<doc xml:space="preserve">Pointer to hold a GstMixerOptions object, or NULL.</doc>
<type name="MixerOptions" c:type="GstMixerOptions**"/>
</parameter>
</parameters>
</function>
<function name="mixer_message_parse_record_toggled"
c:identifier="gst_mixer_message_parse_record_toggled"
moved-to="Mixer.message_parse_record_toggled"
version="0.10.14">
<doc xml:space="preserve">Extracts the contents of a record-toggled bus message. Reads
the GstMixerTrack that has changed, and the new value of the
recording flag.
The GstMixerTrack remains valid until the message is freed.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="message" transfer-ownership="none">
<doc xml:space="preserve">A record-toggled change notification message.</doc>
<type name="Gst.Message" c:type="GstMessage*"/>
</parameter>
<parameter name="track" transfer-ownership="none">
<doc xml:space="preserve">Pointer to hold a GstMixerTrack object, or NULL.</doc>
<type name="MixerTrack" c:type="GstMixerTrack**"/>
</parameter>
<parameter name="record" transfer-ownership="none">
<doc xml:space="preserve">A pointer to a gboolean variable, or NULL.</doc>
<type name="gboolean" c:type="gboolean*"/>
</parameter>
</parameters>
</function>
<function name="mixer_message_parse_volume_changed"
c:identifier="gst_mixer_message_parse_volume_changed"
moved-to="Mixer.message_parse_volume_changed"
version="0.10.14">
<doc xml:space="preserve">Parses a volume-changed notification message and extracts the track object
it refers to, as well as an array of volumes and the size of the volumes array.
The track object remains valid until the message is freed.
The caller must free the array returned in the volumes parameter using g_free
when they are done with it.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="message" transfer-ownership="none">
<doc xml:space="preserve">A volume-changed change notification message.</doc>
<type name="Gst.Message" c:type="GstMessage*"/>
</parameter>
<parameter name="track" transfer-ownership="none">
<doc xml:space="preserve">Pointer to hold a GstMixerTrack object, or NULL.</doc>
<type name="MixerTrack" c:type="GstMixerTrack**"/>
</parameter>
<parameter name="volumes" transfer-ownership="none">
<doc xml:space="preserve">A pointer to receive an array of gint values, or NULL.</doc>
<type name="gint" c:type="gint**"/>
</parameter>
<parameter name="num_channels" transfer-ownership="none">
<doc xml:space="preserve">Result location to receive the number of channels, or NULL.</doc>
<type name="gint" c:type="gint*"/>
</parameter>
</parameters>
</function>
<function name="navigation_event_get_type"
c:identifier="gst_navigation_event_get_type"
moved-to="Navigation.event_get_type"
version="0.10.23">
<doc xml:space="preserve">Inspect a #GstEvent and return the #GstNavigationEventType of the event, or
#GST_NAVIGATION_EVENT_INVALID if the event is not a #GstNavigation event.</doc>
<return-value transfer-ownership="none">
<type name="NavigationEventType" c:type="GstNavigationEventType"/>
</return-value>
<parameters>
<parameter name="event" transfer-ownership="none">
<doc xml:space="preserve">A #GstEvent to inspect.</doc>
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
</parameters>
</function>
<function name="navigation_event_parse_command"
c:identifier="gst_navigation_event_parse_command"
moved-to="Navigation.event_parse_command"
version="0.10.23">
<doc xml:space="preserve">Inspect a #GstNavigation command event and retrieve the enum value of the
associated command.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the navigation command could be extracted, otherwise FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="event" transfer-ownership="none">
<doc xml:space="preserve">A #GstEvent to inspect.</doc>
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
<parameter name="command" transfer-ownership="none">
<doc xml:space="preserve">Pointer to GstNavigationCommand to receive the type of the
navigation event.</doc>
<type name="NavigationCommand" c:type="GstNavigationCommand*"/>
</parameter>
</parameters>
</function>
<function name="navigation_event_parse_key_event"
c:identifier="gst_navigation_event_parse_key_event"
moved-to="Navigation.event_parse_key_event"
version="0.10.23">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="event" transfer-ownership="none">
<doc xml:space="preserve">A #GstEvent to inspect.</doc>
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
<parameter name="key" transfer-ownership="none">
<doc xml:space="preserve">A pointer to a location to receive the string identifying the key
press. The returned string is owned by the event, and valid only until the
event is unreffed.</doc>
<type name="utf8" c:type="const gchar**"/>
</parameter>
</parameters>
</function>
<function name="navigation_event_parse_mouse_button_event"
c:identifier="gst_navigation_event_parse_mouse_button_event"
moved-to="Navigation.event_parse_mouse_button_event"
version="0.10.23">
<doc xml:space="preserve">Retrieve the details of either a #GstNavigation mouse button press event or
a mouse button release event. Determine which type the event is using
gst_navigation_event_get_type() to retrieve the #GstNavigationEventType.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the button number and both coordinates could be extracted,
otherwise FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="event" transfer-ownership="none">
<doc xml:space="preserve">A #GstEvent to inspect.</doc>
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
<parameter name="button" transfer-ownership="none">
<doc xml:space="preserve">Pointer to a gint that will receive the button number associated
with the event.</doc>
<type name="gint" c:type="gint*"/>
</parameter>
<parameter name="x" transfer-ownership="none">
<doc xml:space="preserve">Pointer to a gdouble to receive the x coordinate of the mouse button
event.</doc>
<type name="gdouble" c:type="gdouble*"/>
</parameter>
<parameter name="y" transfer-ownership="none">
<doc xml:space="preserve">Pointer to a gdouble to receive the y coordinate of the mouse button
event.</doc>
<type name="gdouble" c:type="gdouble*"/>
</parameter>
</parameters>
</function>
<function name="navigation_event_parse_mouse_move_event"
c:identifier="gst_navigation_event_parse_mouse_move_event"
moved-to="Navigation.event_parse_mouse_move_event"
version="0.10.23">
<doc xml:space="preserve">Inspect a #GstNavigation mouse movement event and extract the coordinates
of the event.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if both coordinates could be extracted, otherwise FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="event" transfer-ownership="none">
<doc xml:space="preserve">A #GstEvent to inspect.</doc>
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
<parameter name="x" transfer-ownership="none">
<doc xml:space="preserve">Pointer to a gdouble to receive the x coordinate of the mouse movement.</doc>
<type name="gdouble" c:type="gdouble*"/>
</parameter>
<parameter name="y" transfer-ownership="none">
<doc xml:space="preserve">Pointer to a gdouble to receive the y coordinate of the mouse movement.</doc>
<type name="gdouble" c:type="gdouble*"/>
</parameter>
</parameters>
</function>
<function name="navigation_message_get_type"
c:identifier="gst_navigation_message_get_type"
moved-to="Navigation.message_get_type"
version="0.10.23">
<doc xml:space="preserve">Check a bus message to see if it is a #GstNavigation event, and return
the #GstNavigationMessageType identifying the type of the message if so.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The type of the #GstMessage, or
#GST_NAVIGATION_MESSAGE_INVALID if the message is not a #GstNavigation
notification.</doc>
<type name="NavigationMessageType" c:type="GstNavigationMessageType"/>
</return-value>
<parameters>
<parameter name="message" transfer-ownership="none">
<doc xml:space="preserve">A #GstMessage to inspect.</doc>
<type name="Gst.Message" c:type="GstMessage*"/>
</parameter>
</parameters>
</function>
<function name="navigation_message_parse_angles_changed"
c:identifier="gst_navigation_message_parse_angles_changed"
moved-to="Navigation.message_parse_angles_changed"
version="0.10.23">
<doc xml:space="preserve">Parse a #GstNavigation message of type GST_NAVIGATION_MESSAGE_ANGLES_CHANGED
and extract the @cur_angle and @n_angles parameters.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the message could be successfully parsed. %FALSE if not.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="message" transfer-ownership="none">
<doc xml:space="preserve">A #GstMessage to inspect.</doc>
<type name="Gst.Message" c:type="GstMessage*"/>
</parameter>
<parameter name="cur_angle" transfer-ownership="none">
<doc xml:space="preserve">A pointer to a #guint to receive the new current angle number,
or NULL</doc>
<type name="guint" c:type="guint*"/>
</parameter>
<parameter name="n_angles" transfer-ownership="none">
<doc xml:space="preserve">A pointer to a #guint to receive the new angle count, or NULL.</doc>
<type name="guint" c:type="guint*"/>
</parameter>
</parameters>
</function>
<function name="navigation_message_parse_mouse_over"
c:identifier="gst_navigation_message_parse_mouse_over"
moved-to="Navigation.message_parse_mouse_over"
version="0.10.23">
<doc xml:space="preserve">Parse a #GstNavigation message of type #GST_NAVIGATION_MESSAGE_MOUSE_OVER
and extract the active/inactive flag. If the mouse over event is marked
active, it indicates that the mouse is over a clickable area.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the message could be successfully parsed. %FALSE if not.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="message" transfer-ownership="none">
<doc xml:space="preserve">A #GstMessage to inspect.</doc>
<type name="Gst.Message" c:type="GstMessage*"/>
</parameter>
<parameter name="active" transfer-ownership="none">
<doc xml:space="preserve">A pointer to a gboolean to receive the active/inactive state,
or NULL.</doc>
<type name="gboolean" c:type="gboolean*"/>
</parameter>
</parameters>
</function>
<function name="navigation_query_get_type"
c:identifier="gst_navigation_query_get_type"
moved-to="Navigation.query_get_type"
version="0.10.23">
<doc xml:space="preserve">Inspect a #GstQuery and return the #GstNavigationQueryType associated with
it if it is a #GstNavigation query.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The #GstNavigationQueryType of the query, or
#GST_NAVIGATION_QUERY_INVALID</doc>
<type name="NavigationQueryType" c:type="GstNavigationQueryType"/>
</return-value>
<parameters>
<parameter name="query" transfer-ownership="none">
<doc xml:space="preserve">The query to inspect</doc>
<type name="Gst.Query" c:type="GstQuery*"/>
</parameter>
</parameters>
</function>
<function name="navigation_query_parse_angles"
c:identifier="gst_navigation_query_parse_angles"
moved-to="Navigation.query_parse_angles"
version="0.10.23">
<doc xml:space="preserve">Parse the current angle number in the #GstNavigation angles @query into the
#guint pointed to by the @cur_angle variable, and the number of available
angles into the #guint pointed to by the @n_angles variable.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the query could be successfully parsed. %FALSE if not.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="query" transfer-ownership="none">
<doc xml:space="preserve">a #GstQuery</doc>
<type name="Gst.Query" c:type="GstQuery*"/>
</parameter>
<parameter name="cur_angle" transfer-ownership="none">
<doc xml:space="preserve">Pointer to a #guint into which to store the currently selected
angle value from the query, or NULL</doc>
<type name="guint" c:type="guint*"/>
</parameter>
<parameter name="n_angles" transfer-ownership="none">
<doc xml:space="preserve">Pointer to a #guint into which to store the number of angles
value from the query, or NULL</doc>
<type name="guint" c:type="guint*"/>
</parameter>
</parameters>
</function>
<function name="navigation_query_parse_commands_length"
c:identifier="gst_navigation_query_parse_commands_length"
moved-to="Navigation.query_parse_commands_length"
version="0.10.23">
<doc xml:space="preserve">Parse the number of commands in the #GstNavigation commands @query.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the query could be successfully parsed. %FALSE if not.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="query" transfer-ownership="none">
<doc xml:space="preserve">a #GstQuery</doc>
<type name="Gst.Query" c:type="GstQuery*"/>
</parameter>
<parameter name="n_cmds" transfer-ownership="none">
<doc xml:space="preserve">the number of commands in this query.</doc>
<type name="guint" c:type="guint*"/>
</parameter>
</parameters>
</function>
<function name="navigation_query_parse_commands_nth"
c:identifier="gst_navigation_query_parse_commands_nth"
moved-to="Navigation.query_parse_commands_nth"
version="0.10.23">
<doc xml:space="preserve">Parse the #GstNavigation command query and retrieve the @nth command from
it into @cmd. If the list contains less elements than @nth, @cmd will be
set to #GST_NAVIGATION_COMMAND_INVALID.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the query could be successfully parsed. %FALSE if not.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="query" transfer-ownership="none">
<doc xml:space="preserve">a #GstQuery</doc>
<type name="Gst.Query" c:type="GstQuery*"/>
</parameter>
<parameter name="nth" transfer-ownership="none">
<doc xml:space="preserve">the nth command to retrieve.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="cmd" transfer-ownership="none">
<doc xml:space="preserve">a pointer to store the nth command into.</doc>
<type name="NavigationCommand" c:type="GstNavigationCommand*"/>
</parameter>
</parameters>
</function>
<function name="navigation_query_set_angles"
c:identifier="gst_navigation_query_set_angles"
moved-to="Navigation.query_set_angles"
version="0.10.23">
<doc xml:space="preserve">Set the #GstNavigation angles query result field in @query.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="query" transfer-ownership="none">
<doc xml:space="preserve">a #GstQuery</doc>
<type name="Gst.Query" c:type="GstQuery*"/>
</parameter>
<parameter name="cur_angle" transfer-ownership="none">
<doc xml:space="preserve">the current viewing angle to set.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="n_angles" transfer-ownership="none">
<doc xml:space="preserve">the number of viewing angles to set.</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</function>
<function name="navigation_query_set_commandsv"
c:identifier="gst_navigation_query_set_commandsv"
moved-to="Navigation.query_set_commandsv"
version="0.10.23">
<doc xml:space="preserve">Set the #GstNavigation command query result fields in @query. The number
of commands passed must be equal to @n_commands.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="query" transfer-ownership="none">
<doc xml:space="preserve">a #GstQuery</doc>
<type name="Gst.Query" c:type="GstQuery*"/>
</parameter>
<parameter name="n_cmds" transfer-ownership="none">
<doc xml:space="preserve">the number of commands to set.</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="cmds" transfer-ownership="none">
<doc xml:space="preserve">An array containing @n_cmds @GstNavigationCommand values.</doc>
<type name="NavigationCommand" c:type="GstNavigationCommand*"/>
</parameter>
</parameters>
</function>
<function name="stream_volume_convert_volume"
c:identifier="gst_stream_volume_convert_volume"
moved-to="StreamVolume.convert_volume"
version="0.10.25">
<return-value transfer-ownership="none">
<doc xml:space="preserve">the converted volume</doc>
<type name="gdouble" c:type="gdouble"/>
</return-value>
<parameters>
<parameter name="from" transfer-ownership="none">
<doc xml:space="preserve">#GstStreamVolumeFormat to convert from</doc>
<type name="StreamVolumeFormat" c:type="GstStreamVolumeFormat"/>
</parameter>
<parameter name="to" transfer-ownership="none">
<doc xml:space="preserve">#GstStreamVolumeFormat to convert to</doc>
<type name="StreamVolumeFormat" c:type="GstStreamVolumeFormat"/>
</parameter>
<parameter name="val" transfer-ownership="none">
<doc xml:space="preserve">Volume in @from format that should be converted</doc>
<type name="gdouble" c:type="gdouble"/>
</parameter>
</parameters>
</function>
</namespace>
</repository>
|