/usr/share/gir-1.0/GstAudio-1.0.gir is in libgstreamer-plugins-base1.0-dev 1.4.4-2+deb8u1.
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 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 | <?xml version="1.0"?>
<!-- This file was automatically generated from C sources - DO NOT EDIT!
To affect the contents of this file, edit the original C definitions,
and/or use gtk-doc annotations. -->
<repository version="1.2"
xmlns="http://www.gtk.org/introspection/core/1.0"
xmlns:c="http://www.gtk.org/introspection/c/1.0"
xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
<include name="Gst" version="1.0"/>
<include name="GstBase" version="1.0"/>
<include name="GstTag" version="1.0"/>
<package name="gstreamer-audio-1.0"/>
<c:include name="gst/audio/audio.h"/>
<namespace name="GstAudio"
version="1.0"
shared-library="libgstaudio-1.0.so.0"
c:identifier-prefixes="Gst"
c:symbol-prefixes="gst">
<constant name="AUDIO_CHANNELS_RANGE"
value="(int) [ 1, max ]"
c:type="GST_AUDIO_CHANNELS_RANGE">
<doc xml:space="preserve">Maximum range of allowed channels, for use in template caps strings.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="AUDIO_DECODER_MAX_ERRORS"
value="10"
c:type="GST_AUDIO_DECODER_MAX_ERRORS">
<doc xml:space="preserve">Default maximum number of errors tolerated before signaling error.</doc>
<type name="gint" c:type="gint"/>
</constant>
<constant name="AUDIO_DECODER_SINK_NAME"
value="sink"
c:type="GST_AUDIO_DECODER_SINK_NAME">
<doc xml:space="preserve">The name of the templates for the sink pad.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="AUDIO_DECODER_SRC_NAME"
value="src"
c:type="GST_AUDIO_DECODER_SRC_NAME">
<doc xml:space="preserve">The name of the templates for the source pad.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="AUDIO_DEF_CHANNELS"
value="2"
c:type="GST_AUDIO_DEF_CHANNELS">
<doc xml:space="preserve">Standard number of channels used in consumer audio.</doc>
<type name="gint" c:type="gint"/>
</constant>
<constant name="AUDIO_DEF_FORMAT"
value="S16LE"
c:type="GST_AUDIO_DEF_FORMAT">
<doc xml:space="preserve">Standard format used in consumer audio.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="AUDIO_DEF_RATE" value="44100" c:type="GST_AUDIO_DEF_RATE">
<doc xml:space="preserve">Standard sampling rate used in consumer audio.</doc>
<type name="gint" c:type="gint"/>
</constant>
<constant name="AUDIO_ENCODER_SINK_NAME"
value="sink"
c:type="GST_AUDIO_ENCODER_SINK_NAME">
<doc xml:space="preserve">the name of the templates for the sink pad</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="AUDIO_ENCODER_SRC_NAME"
value="src"
c:type="GST_AUDIO_ENCODER_SRC_NAME">
<doc xml:space="preserve">the name of the templates for the source pad</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="AUDIO_FORMATS_ALL"
value=" { S8, U8, S16LE, S16BE, U16LE, U16BE, S24_32LE, S24_32BE, U24_32LE, U24_32BE, S32LE, S32BE, U32LE, U32BE, S24LE, S24BE, U24LE, U24BE, S20LE, S20BE, U20LE, U20BE, S18LE, S18BE, U18LE, U18BE, F32LE, F32BE, F64LE, F64BE }"
c:type="GST_AUDIO_FORMATS_ALL">
<doc xml:space="preserve">List of all audio formats, for use in template caps strings.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="AUDIO_RATE_RANGE"
value="(int) [ 1, max ]"
c:type="GST_AUDIO_RATE_RANGE">
<doc xml:space="preserve">Maximum range of allowed sample rates, for use in template caps strings.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<class name="AudioBaseSink"
c:symbol-prefix="audio_base_sink"
c:type="GstAudioBaseSink"
parent="GstBase.BaseSink"
glib:type-name="GstAudioBaseSink"
glib:get-type="gst_audio_base_sink_get_type"
glib:type-struct="AudioBaseSinkClass">
<doc xml:space="preserve">This is the base class for audio sinks. Subclasses need to implement the
::create_ringbuffer vmethod. This base class will then take care of
writing samples to the ringbuffer, synchronisation, clipping and flushing.</doc>
<virtual-method name="create_ringbuffer" invoker="create_ringbuffer">
<doc xml:space="preserve">Create and return the #GstAudioRingBuffer for @sink. This function will
call the ::create_ringbuffer vmethod and will set @sink as the parent of
the returned buffer (see gst_object_set_parent()).</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The new ringbuffer of @sink.</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</return-value>
<parameters>
<instance-parameter name="sink" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioBaseSink.</doc>
<type name="AudioBaseSink" c:type="GstAudioBaseSink*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="payload">
<return-value transfer-ownership="full">
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</return-value>
<parameters>
<instance-parameter name="sink" transfer-ownership="none">
<type name="AudioBaseSink" c:type="GstAudioBaseSink*"/>
</instance-parameter>
<parameter name="buffer" transfer-ownership="none">
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</parameter>
</parameters>
</virtual-method>
<method name="create_ringbuffer"
c:identifier="gst_audio_base_sink_create_ringbuffer">
<doc xml:space="preserve">Create and return the #GstAudioRingBuffer for @sink. This function will
call the ::create_ringbuffer vmethod and will set @sink as the parent of
the returned buffer (see gst_object_set_parent()).</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The new ringbuffer of @sink.</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</return-value>
<parameters>
<instance-parameter name="sink" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioBaseSink.</doc>
<type name="AudioBaseSink" c:type="GstAudioBaseSink*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_alignment_threshold"
c:identifier="gst_audio_base_sink_get_alignment_threshold">
<doc xml:space="preserve">Get the current alignment threshold, in nanoseconds, used by @sink.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The current alignment threshold used by @sink.</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</return-value>
<parameters>
<instance-parameter name="sink" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioBaseSink</doc>
<type name="AudioBaseSink" c:type="GstAudioBaseSink*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_discont_wait"
c:identifier="gst_audio_base_sink_get_discont_wait">
<doc xml:space="preserve">Get the current discont wait, in nanoseconds, used by @sink.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The current discont wait used by @sink.</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</return-value>
<parameters>
<instance-parameter name="sink" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioBaseSink</doc>
<type name="AudioBaseSink" c:type="GstAudioBaseSink*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_drift_tolerance"
c:identifier="gst_audio_base_sink_get_drift_tolerance">
<doc xml:space="preserve">Get the current drift tolerance, in microseconds, used by @sink.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The current drift tolerance used by @sink.</doc>
<type name="gint64" c:type="gint64"/>
</return-value>
<parameters>
<instance-parameter name="sink" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioBaseSink</doc>
<type name="AudioBaseSink" c:type="GstAudioBaseSink*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_provide_clock"
c:identifier="gst_audio_base_sink_get_provide_clock">
<doc xml:space="preserve">Queries whether @sink will provide a clock or not. See also
gst_audio_base_sink_set_provide_clock.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @sink will provide a clock.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="sink" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioBaseSink</doc>
<type name="AudioBaseSink" c:type="GstAudioBaseSink*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_slave_method"
c:identifier="gst_audio_base_sink_get_slave_method">
<doc xml:space="preserve">Get the current slave method used by @sink.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The current slave method used by @sink.</doc>
<type name="AudioBaseSinkSlaveMethod"
c:type="GstAudioBaseSinkSlaveMethod"/>
</return-value>
<parameters>
<instance-parameter name="sink" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioBaseSink</doc>
<type name="AudioBaseSink" c:type="GstAudioBaseSink*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_alignment_threshold"
c:identifier="gst_audio_base_sink_set_alignment_threshold">
<doc xml:space="preserve">Controls the sink's alignment threshold.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="sink" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioBaseSink</doc>
<type name="AudioBaseSink" c:type="GstAudioBaseSink*"/>
</instance-parameter>
<parameter name="alignment_threshold" transfer-ownership="none">
<doc xml:space="preserve">the new alignment threshold in nanoseconds</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</parameter>
</parameters>
</method>
<method name="set_discont_wait"
c:identifier="gst_audio_base_sink_set_discont_wait">
<doc xml:space="preserve">Controls how long the sink will wait before creating a discontinuity.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="sink" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioBaseSink</doc>
<type name="AudioBaseSink" c:type="GstAudioBaseSink*"/>
</instance-parameter>
<parameter name="discont_wait" transfer-ownership="none">
<doc xml:space="preserve">the new discont wait in nanoseconds</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</parameter>
</parameters>
</method>
<method name="set_drift_tolerance"
c:identifier="gst_audio_base_sink_set_drift_tolerance">
<doc xml:space="preserve">Controls the sink's drift tolerance.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="sink" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioBaseSink</doc>
<type name="AudioBaseSink" c:type="GstAudioBaseSink*"/>
</instance-parameter>
<parameter name="drift_tolerance" transfer-ownership="none">
<doc xml:space="preserve">the new drift tolerance in microseconds</doc>
<type name="gint64" c:type="gint64"/>
</parameter>
</parameters>
</method>
<method name="set_provide_clock"
c:identifier="gst_audio_base_sink_set_provide_clock">
<doc xml:space="preserve">Controls whether @sink will provide a clock or not. If @provide is %TRUE,
gst_element_provide_clock() will return a clock that reflects the datarate
of @sink. If @provide is %FALSE, gst_element_provide_clock() will return
NULL.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="sink" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioBaseSink</doc>
<type name="AudioBaseSink" c:type="GstAudioBaseSink*"/>
</instance-parameter>
<parameter name="provide" transfer-ownership="none">
<doc xml:space="preserve">new state</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_slave_method"
c:identifier="gst_audio_base_sink_set_slave_method">
<doc xml:space="preserve">Controls how clock slaving will be performed in @sink.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="sink" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioBaseSink</doc>
<type name="AudioBaseSink" c:type="GstAudioBaseSink*"/>
</instance-parameter>
<parameter name="method" transfer-ownership="none">
<doc xml:space="preserve">the new slave method</doc>
<type name="AudioBaseSinkSlaveMethod"
c:type="GstAudioBaseSinkSlaveMethod"/>
</parameter>
</parameters>
</method>
<property name="alignment-threshold"
writable="1"
transfer-ownership="none">
<type name="guint64" c:type="guint64"/>
</property>
<property name="buffer-time" writable="1" transfer-ownership="none">
<type name="gint64" c:type="gint64"/>
</property>
<property name="can-activate-pull"
writable="1"
transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="discont-wait" writable="1" transfer-ownership="none">
<doc xml:space="preserve">A window of time in nanoseconds to wait before creating a discontinuity as
a result of breaching the drift-tolerance.</doc>
<type name="guint64" c:type="guint64"/>
</property>
<property name="drift-tolerance" writable="1" transfer-ownership="none">
<doc xml:space="preserve">Controls the amount of time in microseconds that clocks are allowed
to drift before resynchronisation happens.</doc>
<type name="gint64" c:type="gint64"/>
</property>
<property name="latency-time" writable="1" transfer-ownership="none">
<type name="gint64" c:type="gint64"/>
</property>
<property name="provide-clock" writable="1" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="slave-method" writable="1" transfer-ownership="none">
<type name="AudioBaseSinkSlaveMethod"/>
</property>
<field name="element">
<type name="GstBase.BaseSink" c:type="GstBaseSink"/>
</field>
<field name="ringbuffer">
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</field>
<field name="buffer_time">
<type name="guint64" c:type="guint64"/>
</field>
<field name="latency_time">
<type name="guint64" c:type="guint64"/>
</field>
<field name="next_sample">
<type name="guint64" c:type="guint64"/>
</field>
<field name="provided_clock">
<type name="Gst.Clock" c:type="GstClock*"/>
</field>
<field name="eos_rendering">
<type name="gboolean" c:type="gboolean"/>
</field>
<field name="priv" readable="0" private="1">
<type name="AudioBaseSinkPrivate" c:type="GstAudioBaseSinkPrivate*"/>
</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="AudioBaseSinkClass"
c:type="GstAudioBaseSinkClass"
glib:is-gtype-struct-for="AudioBaseSink">
<doc xml:space="preserve">#GstAudioBaseSink class. Override the vmethod to implement
functionality.</doc>
<field name="parent_class">
<doc xml:space="preserve">the parent class.</doc>
<type name="GstBase.BaseSinkClass" c:type="GstBaseSinkClass"/>
</field>
<field name="create_ringbuffer">
<callback name="create_ringbuffer">
<return-value transfer-ownership="none">
<doc xml:space="preserve">The new ringbuffer of @sink.</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</return-value>
<parameters>
<parameter name="sink" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioBaseSink.</doc>
<type name="AudioBaseSink" c:type="GstAudioBaseSink*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="payload">
<callback name="payload">
<return-value transfer-ownership="full">
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</return-value>
<parameters>
<parameter name="sink" transfer-ownership="none">
<type name="AudioBaseSink" c:type="GstAudioBaseSink*"/>
</parameter>
<parameter name="buffer" transfer-ownership="none">
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</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="AudioBaseSinkPrivate"
c:type="GstAudioBaseSinkPrivate"
disguised="1">
</record>
<enumeration name="AudioBaseSinkSlaveMethod"
glib:type-name="GstAudioBaseSinkSlaveMethod"
glib:get-type="gst_audio_base_sink_slave_method_get_type"
c:type="GstAudioBaseSinkSlaveMethod">
<doc xml:space="preserve">Different possible clock slaving algorithms used when the internal audio
clock is not selected as the pipeline master clock.</doc>
<member name="resample"
value="0"
c:identifier="GST_AUDIO_BASE_SINK_SLAVE_RESAMPLE"
glib:nick="resample">
<doc xml:space="preserve">Resample to match the master clock</doc>
</member>
<member name="skew"
value="1"
c:identifier="GST_AUDIO_BASE_SINK_SLAVE_SKEW"
glib:nick="skew">
<doc xml:space="preserve">Adjust playout pointer when master clock
drifts too much.</doc>
</member>
<member name="none"
value="2"
c:identifier="GST_AUDIO_BASE_SINK_SLAVE_NONE"
glib:nick="none">
<doc xml:space="preserve">No adjustment is done.</doc>
</member>
</enumeration>
<class name="AudioBaseSrc"
c:symbol-prefix="audio_base_src"
c:type="GstAudioBaseSrc"
parent="GstBase.PushSrc"
glib:type-name="GstAudioBaseSrc"
glib:get-type="gst_audio_base_src_get_type"
glib:type-struct="AudioBaseSrcClass">
<doc xml:space="preserve">This is the base class for audio sources. Subclasses need to implement the
::create_ringbuffer vmethod. This base class will then take care of
reading samples from the ringbuffer, synchronisation and flushing.</doc>
<virtual-method name="create_ringbuffer" invoker="create_ringbuffer">
<doc xml:space="preserve">Create and return the #GstAudioRingBuffer for @src. This function will call
the ::create_ringbuffer vmethod and will set @src as the parent of the
returned buffer (see gst_object_set_parent()).</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The new ringbuffer of @src.</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</return-value>
<parameters>
<instance-parameter name="src" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioBaseSrc.</doc>
<type name="AudioBaseSrc" c:type="GstAudioBaseSrc*"/>
</instance-parameter>
</parameters>
</virtual-method>
<method name="create_ringbuffer"
c:identifier="gst_audio_base_src_create_ringbuffer">
<doc xml:space="preserve">Create and return the #GstAudioRingBuffer for @src. This function will call
the ::create_ringbuffer vmethod and will set @src as the parent of the
returned buffer (see gst_object_set_parent()).</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The new ringbuffer of @src.</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</return-value>
<parameters>
<instance-parameter name="src" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioBaseSrc.</doc>
<type name="AudioBaseSrc" c:type="GstAudioBaseSrc*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_provide_clock"
c:identifier="gst_audio_base_src_get_provide_clock">
<doc xml:space="preserve">Queries whether @src will provide a clock or not. See also
gst_audio_base_src_set_provide_clock.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @src will provide a clock.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="src" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioBaseSrc</doc>
<type name="AudioBaseSrc" c:type="GstAudioBaseSrc*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_slave_method"
c:identifier="gst_audio_base_src_get_slave_method">
<doc xml:space="preserve">Get the current slave method used by @src.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The current slave method used by @src.</doc>
<type name="AudioBaseSrcSlaveMethod"
c:type="GstAudioBaseSrcSlaveMethod"/>
</return-value>
<parameters>
<instance-parameter name="src" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioBaseSrc</doc>
<type name="AudioBaseSrc" c:type="GstAudioBaseSrc*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_provide_clock"
c:identifier="gst_audio_base_src_set_provide_clock">
<doc xml:space="preserve">Controls whether @src will provide a clock or not. If @provide is %TRUE,
gst_element_provide_clock() will return a clock that reflects the datarate
of @src. If @provide is %FALSE, gst_element_provide_clock() will return NULL.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="src" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioBaseSrc</doc>
<type name="AudioBaseSrc" c:type="GstAudioBaseSrc*"/>
</instance-parameter>
<parameter name="provide" transfer-ownership="none">
<doc xml:space="preserve">new state</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_slave_method"
c:identifier="gst_audio_base_src_set_slave_method">
<doc xml:space="preserve">Controls how clock slaving will be performed in @src.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="src" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioBaseSrc</doc>
<type name="AudioBaseSrc" c:type="GstAudioBaseSrc*"/>
</instance-parameter>
<parameter name="method" transfer-ownership="none">
<doc xml:space="preserve">the new slave method</doc>
<type name="AudioBaseSrcSlaveMethod"
c:type="GstAudioBaseSrcSlaveMethod"/>
</parameter>
</parameters>
</method>
<property name="actual-buffer-time" transfer-ownership="none">
<doc xml:space="preserve">Actual configured size of audio buffer in microseconds.</doc>
<type name="gint64" c:type="gint64"/>
</property>
<property name="actual-latency-time" transfer-ownership="none">
<doc xml:space="preserve">Actual configured audio latency in microseconds.</doc>
<type name="gint64" c:type="gint64"/>
</property>
<property name="buffer-time" writable="1" transfer-ownership="none">
<type name="gint64" c:type="gint64"/>
</property>
<property name="latency-time" writable="1" transfer-ownership="none">
<type name="gint64" c:type="gint64"/>
</property>
<property name="provide-clock" writable="1" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="slave-method" writable="1" transfer-ownership="none">
<type name="AudioBaseSrcSlaveMethod"/>
</property>
<field name="element">
<type name="GstBase.PushSrc" c:type="GstPushSrc"/>
</field>
<field name="ringbuffer">
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</field>
<field name="buffer_time">
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</field>
<field name="latency_time">
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</field>
<field name="next_sample">
<type name="guint64" c:type="guint64"/>
</field>
<field name="clock">
<type name="Gst.Clock" c:type="GstClock*"/>
</field>
<field name="priv" readable="0" private="1">
<type name="AudioBaseSrcPrivate" c:type="GstAudioBaseSrcPrivate*"/>
</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="AudioBaseSrcClass"
c:type="GstAudioBaseSrcClass"
glib:is-gtype-struct-for="AudioBaseSrc">
<doc xml:space="preserve">#GstAudioBaseSrc class. Override the vmethod to implement
functionality.</doc>
<field name="parent_class">
<doc xml:space="preserve">the parent class.</doc>
<type name="GstBase.PushSrcClass" c:type="GstPushSrcClass"/>
</field>
<field name="create_ringbuffer">
<callback name="create_ringbuffer">
<return-value transfer-ownership="none">
<doc xml:space="preserve">The new ringbuffer of @src.</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</return-value>
<parameters>
<parameter name="src" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioBaseSrc.</doc>
<type name="AudioBaseSrc" c:type="GstAudioBaseSrc*"/>
</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="AudioBaseSrcPrivate"
c:type="GstAudioBaseSrcPrivate"
disguised="1">
</record>
<enumeration name="AudioBaseSrcSlaveMethod"
glib:type-name="GstAudioBaseSrcSlaveMethod"
glib:get-type="gst_audio_base_src_slave_method_get_type"
c:type="GstAudioBaseSrcSlaveMethod">
<doc xml:space="preserve">Different possible clock slaving algorithms when the internal audio clock was
not selected as the pipeline clock.</doc>
<member name="resample"
value="0"
c:identifier="GST_AUDIO_BASE_SRC_SLAVE_RESAMPLE"
glib:nick="resample">
<doc xml:space="preserve">Resample to match the master clock.</doc>
</member>
<member name="re_timestamp"
value="1"
c:identifier="GST_AUDIO_BASE_SRC_SLAVE_RETIMESTAMP"
glib:nick="re-timestamp">
<doc xml:space="preserve">Retimestamp output buffers with master
clock time.</doc>
</member>
<member name="skew"
value="2"
c:identifier="GST_AUDIO_BASE_SRC_SLAVE_SKEW"
glib:nick="skew">
<doc xml:space="preserve">Adjust capture pointer when master clock
drifts too much.</doc>
</member>
<member name="none"
value="3"
c:identifier="GST_AUDIO_BASE_SRC_SLAVE_NONE"
glib:nick="none">
<doc xml:space="preserve">No adjustment is done.</doc>
</member>
</enumeration>
<class name="AudioCdSrc"
c:symbol-prefix="audio_cd_src"
c:type="GstAudioCdSrc"
parent="GstBase.PushSrc"
glib:type-name="GstAudioCdSrc"
glib:get-type="gst_audio_cd_src_get_type"
glib:type-struct="AudioCdSrcClass">
<doc xml:space="preserve"><para>
Provides a base class for CD digital audio (CDDA) sources, which handles
things like seeking, querying, discid calculation, tags, and buffer
timestamping.
</para>
<refsect2>
<title>Using GstAudioCdSrc-based elements in applications</title>
<para>
GstAudioCdSrc registers two #GstFormat<!-- -->s of its own, namely
the "track" format and the "sector" format. Applications will usually
only find the "track" format interesting. You can retrieve that #GstFormat
for use in seek events or queries with gst_format_get_by_nick("track").
</para>
<para>
In order to query the number of tracks, for example, an application would
set the CDDA source element to READY or PAUSED state and then query the
the number of tracks via gst_element_query_duration() using the track
format acquired above. Applications can query the currently playing track
in the same way.
</para>
<para>
Alternatively, applications may retrieve the currently playing track and
the total number of tracks from the taglist that will posted on the bus
whenever the CD is opened or the currently playing track changes. The
taglist will contain GST_TAG_TRACK_NUMBER and GST_TAG_TRACK_COUNT tags.
</para>
<para>
Applications playing back CD audio using playbin and cdda://n URIs should
issue a seek command in track format to change between tracks, rather than
setting a new cdda://n+1 URI on playbin (as setting a new URI on playbin
involves closing and re-opening the CD device, which is much much slower).
</para>
<refsect2>
</refsect2>
<title>Tags and meta-information</title>
<para>
CDDA sources will automatically emit a number of tags, details about which
can be found in the libgsttag documentation. Those tags are:
#GST_TAG_CDDA_CDDB_DISCID, #GST_TAG_CDDA_CDDB_DISCID_FULL,
#GST_TAG_CDDA_MUSICBRAINZ_DISCID, #GST_TAG_CDDA_MUSICBRAINZ_DISCID_FULL,
among others.
</para>
</refsect2>
<refsect2>
<title>Tracks and Table of Contents (TOC)</title>
<para>
Applications will be informed of the available tracks via a TOC message
on the pipeline's #GstBus. The #GstToc will contain a #GstTocEntry for
each track, with information about each track. The duration for each
track can be retrieved via the #GST_TAG_DURATION tag from each entry's
tag list, or calculated via gst_toc_entry_get_start_stop_times().
The track entries in the TOC will be sorted by track number.
</para>
</refsect2></doc>
<implements name="Gst.URIHandler"/>
<virtual-method name="close">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="src" transfer-ownership="none">
<type name="AudioCdSrc" c:type="GstAudioCdSrc*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="open">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="src" transfer-ownership="none">
<type name="AudioCdSrc" c:type="GstAudioCdSrc*"/>
</instance-parameter>
<parameter name="device" transfer-ownership="none">
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="read_sector">
<return-value transfer-ownership="full">
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</return-value>
<parameters>
<instance-parameter name="src" transfer-ownership="none">
<type name="AudioCdSrc" c:type="GstAudioCdSrc*"/>
</instance-parameter>
<parameter name="sector" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</virtual-method>
<method name="add_track" c:identifier="gst_audio_cd_src_add_track">
<doc xml:space="preserve">CDDA sources use this function from their start vfunc to announce the
available data and audio tracks to the base source class. The caller
should allocate @track on the stack, the base source will do a shallow
copy of the structure (and take ownership of the taglist if there is one).</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">FALSE on error, otherwise TRUE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="src" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioCdSrc</doc>
<type name="AudioCdSrc" c:type="GstAudioCdSrc*"/>
</instance-parameter>
<parameter name="track" transfer-ownership="none">
<doc xml:space="preserve">address of #GstAudioCdSrcTrack to add</doc>
<type name="AudioCdSrcTrack" c:type="GstAudioCdSrcTrack*"/>
</parameter>
</parameters>
</method>
<property name="device" writable="1" transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="mode" writable="1" transfer-ownership="none">
<type name="AudioCdSrcMode"/>
</property>
<property name="track" writable="1" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</property>
<field name="pushsrc">
<type name="GstBase.PushSrc" c:type="GstPushSrc"/>
</field>
<field name="tags">
<type name="Gst.TagList" c:type="GstTagList*"/>
</field>
<field name="priv" readable="0" private="1">
<type name="AudioCdSrcPrivate" c:type="GstAudioCdSrcPrivate*"/>
</field>
<field name="_gst_reserved1" readable="0" private="1">
<array zero-terminated="0" c:type="guint" fixed-size="2">
<type name="guint" c:type="guint"/>
</array>
</field>
<field name="_gst_reserved2" readable="0" private="1">
<array zero-terminated="0" c:type="gpointer" fixed-size="2">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</class>
<record name="AudioCdSrcClass"
c:type="GstAudioCdSrcClass"
glib:is-gtype-struct-for="AudioCdSrc">
<doc xml:space="preserve">Audio CD source base class.</doc>
<field name="pushsrc_class">
<doc xml:space="preserve">the parent class</doc>
<type name="GstBase.PushSrcClass" c:type="GstPushSrcClass"/>
</field>
<field name="open">
<callback name="open">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="src" transfer-ownership="none">
<type name="AudioCdSrc" c:type="GstAudioCdSrc*"/>
</parameter>
<parameter name="device" transfer-ownership="none">
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="close">
<callback name="close">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="src" transfer-ownership="none">
<type name="AudioCdSrc" c:type="GstAudioCdSrc*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="read_sector">
<callback name="read_sector">
<return-value transfer-ownership="full">
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</return-value>
<parameters>
<parameter name="src" transfer-ownership="none">
<type name="AudioCdSrc" c:type="GstAudioCdSrc*"/>
</parameter>
<parameter name="sector" 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="20">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<enumeration name="AudioCdSrcMode"
glib:type-name="GstAudioCdSrcMode"
glib:get-type="gst_audio_cd_src_mode_get_type"
c:type="GstAudioCdSrcMode">
<doc xml:space="preserve">Mode in which the CD audio source operates. Influences timestamping,
EOS handling and seeking.</doc>
<member name="normal"
value="0"
c:identifier="Stream consists of a single track"
glib:nick="normal">
</member>
<member name="continuous"
value="1"
c:identifier="Stream consists of the whole disc"
glib:nick="continuous">
</member>
</enumeration>
<record name="AudioCdSrcPrivate"
c:type="GstAudioCdSrcPrivate"
disguised="1">
</record>
<record name="AudioCdSrcTrack" c:type="GstAudioCdSrcTrack">
<doc xml:space="preserve">CD track abstraction to communicate TOC entries to the base class.
This structure is only for use by sub-classed in connection with
gst_audio_cd_src_add_track().
Applications will be informed of the available tracks via a TOC message
on the pipeline's #GstBus instead.</doc>
<field name="is_audio" writable="1">
<doc xml:space="preserve">Whether this is an audio track</doc>
<type name="gboolean" c:type="gboolean"/>
</field>
<field name="num" writable="1">
<doc xml:space="preserve">Track number in TOC (usually starts from 1, but not always)</doc>
<type name="guint" c:type="guint"/>
</field>
<field name="start" writable="1">
<doc xml:space="preserve">The first sector of this track (LBA)</doc>
<type name="guint" c:type="guint"/>
</field>
<field name="end" writable="1">
<doc xml:space="preserve">The last sector of this track (LBA)</doc>
<type name="guint" c:type="guint"/>
</field>
<field name="tags" writable="1">
<doc xml:space="preserve">Track-specific tags (e.g. from cd-text information), or NULL</doc>
<type name="Gst.TagList" c:type="GstTagList*"/>
</field>
<field name="_gst_reserved1" readable="0" private="1">
<array zero-terminated="0" c:type="guint" fixed-size="2">
<type name="guint" c:type="guint"/>
</array>
</field>
<field name="_gst_reserved2" readable="0" private="1">
<array zero-terminated="0" c:type="gpointer" fixed-size="2">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<enumeration name="AudioChannelPosition"
glib:type-name="GstAudioChannelPosition"
glib:get-type="gst_audio_channel_position_get_type"
c:type="GstAudioChannelPosition">
<doc xml:space="preserve">Audio channel positions.
These are the channels defined in SMPTE 2036-2-2008
Table 1 for 22.2 audio systems with the Surround and Wide channels from
DTS Coherent Acoustics (v.1.3.1) and 10.2 and 7.1 layouts. In the caps the
actual channel layout is expressed with a channel count and a channel mask,
which describes the existing channels. The positions in the bit mask correspond
to the enum values.
For negotiation it is allowed to have more bits set in the channel mask than
the number of channels to specify the allowed channel positions but this is
not allowed in negotiated caps. It is not allowed in any situation other
than the one mentioned below to have less bits set in the channel mask than
the number of channels.
@GST_AUDIO_CHANNEL_POSITION_MONO can only be used with a single mono channel that
has no direction information and would be mixed into all directional channels.
This is expressed in caps by having a single channel and no channel mask.
@GST_AUDIO_CHANNEL_POSITION_NONE can only be used if all channels have this position.
This is expressed in caps by having a channel mask with no bits set.
As another special case it is allowed to have two channels without a channel mask.
This implicitely means that this is a stereo stream with a front left and front right
channel.</doc>
<member name="none"
value="-3"
c:identifier="GST_AUDIO_CHANNEL_POSITION_NONE"
glib:nick="none">
<doc xml:space="preserve">used for position-less channels, e.g.
from a sound card that records 1024 channels; mutually exclusive with
any other channel position</doc>
</member>
<member name="mono"
value="-2"
c:identifier="GST_AUDIO_CHANNEL_POSITION_MONO"
glib:nick="mono">
<doc xml:space="preserve">Mono without direction;
can only be used with 1 channel</doc>
</member>
<member name="invalid"
value="-1"
c:identifier="GST_AUDIO_CHANNEL_POSITION_INVALID"
glib:nick="invalid">
<doc xml:space="preserve">invalid position</doc>
</member>
<member name="front_left"
value="0"
c:identifier="GST_AUDIO_CHANNEL_POSITION_FRONT_LEFT"
glib:nick="front-left">
<doc xml:space="preserve">Front left</doc>
</member>
<member name="front_right"
value="1"
c:identifier="GST_AUDIO_CHANNEL_POSITION_FRONT_RIGHT"
glib:nick="front-right">
<doc xml:space="preserve">Front right</doc>
</member>
<member name="front_center"
value="2"
c:identifier="GST_AUDIO_CHANNEL_POSITION_FRONT_CENTER"
glib:nick="front-center">
<doc xml:space="preserve">Front center</doc>
</member>
<member name="lfe1"
value="3"
c:identifier="GST_AUDIO_CHANNEL_POSITION_LFE1"
glib:nick="lfe1">
<doc xml:space="preserve">Low-frequency effects 1 (subwoofer)</doc>
</member>
<member name="rear_left"
value="4"
c:identifier="GST_AUDIO_CHANNEL_POSITION_REAR_LEFT"
glib:nick="rear-left">
<doc xml:space="preserve">Rear left</doc>
</member>
<member name="rear_right"
value="5"
c:identifier="GST_AUDIO_CHANNEL_POSITION_REAR_RIGHT"
glib:nick="rear-right">
<doc xml:space="preserve">Rear right</doc>
</member>
<member name="front_left_of_center"
value="6"
c:identifier="GST_AUDIO_CHANNEL_POSITION_FRONT_LEFT_OF_CENTER"
glib:nick="front-left-of-center">
<doc xml:space="preserve">Front left of center</doc>
</member>
<member name="front_right_of_center"
value="7"
c:identifier="GST_AUDIO_CHANNEL_POSITION_FRONT_RIGHT_OF_CENTER"
glib:nick="front-right-of-center">
<doc xml:space="preserve">Front right of center</doc>
</member>
<member name="rear_center"
value="8"
c:identifier="GST_AUDIO_CHANNEL_POSITION_REAR_CENTER"
glib:nick="rear-center">
<doc xml:space="preserve">Rear center</doc>
</member>
<member name="lfe2"
value="9"
c:identifier="GST_AUDIO_CHANNEL_POSITION_LFE2"
glib:nick="lfe2">
<doc xml:space="preserve">Low-frequency effects 2 (subwoofer)</doc>
</member>
<member name="side_left"
value="10"
c:identifier="GST_AUDIO_CHANNEL_POSITION_SIDE_LEFT"
glib:nick="side-left">
<doc xml:space="preserve">Side left</doc>
</member>
<member name="side_right"
value="11"
c:identifier="GST_AUDIO_CHANNEL_POSITION_SIDE_RIGHT"
glib:nick="side-right">
<doc xml:space="preserve">Side right</doc>
</member>
<member name="top_front_left"
value="12"
c:identifier="GST_AUDIO_CHANNEL_POSITION_TOP_FRONT_LEFT"
glib:nick="top-front-left">
<doc xml:space="preserve">Top front left</doc>
</member>
<member name="top_front_right"
value="13"
c:identifier="GST_AUDIO_CHANNEL_POSITION_TOP_FRONT_RIGHT"
glib:nick="top-front-right">
<doc xml:space="preserve">Top front right</doc>
</member>
<member name="top_front_center"
value="14"
c:identifier="GST_AUDIO_CHANNEL_POSITION_TOP_FRONT_CENTER"
glib:nick="top-front-center">
<doc xml:space="preserve">Top front center</doc>
</member>
<member name="top_center"
value="15"
c:identifier="GST_AUDIO_CHANNEL_POSITION_TOP_CENTER"
glib:nick="top-center">
<doc xml:space="preserve">Top center</doc>
</member>
<member name="top_rear_left"
value="16"
c:identifier="GST_AUDIO_CHANNEL_POSITION_TOP_REAR_LEFT"
glib:nick="top-rear-left">
<doc xml:space="preserve">Top rear left</doc>
</member>
<member name="top_rear_right"
value="17"
c:identifier="GST_AUDIO_CHANNEL_POSITION_TOP_REAR_RIGHT"
glib:nick="top-rear-right">
<doc xml:space="preserve">Top rear right</doc>
</member>
<member name="top_side_left"
value="18"
c:identifier="GST_AUDIO_CHANNEL_POSITION_TOP_SIDE_LEFT"
glib:nick="top-side-left">
<doc xml:space="preserve">Top side right</doc>
</member>
<member name="top_side_right"
value="19"
c:identifier="GST_AUDIO_CHANNEL_POSITION_TOP_SIDE_RIGHT"
glib:nick="top-side-right">
<doc xml:space="preserve">Top rear right</doc>
</member>
<member name="top_rear_center"
value="20"
c:identifier="GST_AUDIO_CHANNEL_POSITION_TOP_REAR_CENTER"
glib:nick="top-rear-center">
<doc xml:space="preserve">Top rear center</doc>
</member>
<member name="bottom_front_center"
value="21"
c:identifier="GST_AUDIO_CHANNEL_POSITION_BOTTOM_FRONT_CENTER"
glib:nick="bottom-front-center">
<doc xml:space="preserve">Bottom front center</doc>
</member>
<member name="bottom_front_left"
value="22"
c:identifier="GST_AUDIO_CHANNEL_POSITION_BOTTOM_FRONT_LEFT"
glib:nick="bottom-front-left">
<doc xml:space="preserve">Bottom front left</doc>
</member>
<member name="bottom_front_right"
value="23"
c:identifier="GST_AUDIO_CHANNEL_POSITION_BOTTOM_FRONT_RIGHT"
glib:nick="bottom-front-right">
<doc xml:space="preserve">Bottom front right</doc>
</member>
<member name="wide_left"
value="24"
c:identifier="GST_AUDIO_CHANNEL_POSITION_WIDE_LEFT"
glib:nick="wide-left">
<doc xml:space="preserve">Wide left (between front left and side left)</doc>
</member>
<member name="wide_right"
value="25"
c:identifier="GST_AUDIO_CHANNEL_POSITION_WIDE_RIGHT"
glib:nick="wide-right">
<doc xml:space="preserve">Wide right (between front right and side right)</doc>
</member>
<member name="surround_left"
value="26"
c:identifier="GST_AUDIO_CHANNEL_POSITION_SURROUND_LEFT"
glib:nick="surround-left">
<doc xml:space="preserve">Surround left (between rear left and side left)</doc>
</member>
<member name="surround_right"
value="27"
c:identifier="GST_AUDIO_CHANNEL_POSITION_SURROUND_RIGHT"
glib:nick="surround-right">
<doc xml:space="preserve">Surround right (between rear right and side right)</doc>
</member>
</enumeration>
<class name="AudioClock"
c:symbol-prefix="audio_clock"
c:type="GstAudioClock"
parent="Gst.SystemClock"
glib:type-name="GstAudioClock"
glib:get-type="gst_audio_clock_get_type"
glib:type-struct="AudioClockClass">
<doc xml:space="preserve">#GstAudioClock makes it easy for elements to implement a #GstClock, they
simply need to provide a function that returns the current clock time.
This object is internally used to implement the clock in #GstAudioBaseSink.</doc>
<constructor name="new" c:identifier="gst_audio_clock_new">
<doc xml:space="preserve">Create a new #GstAudioClock instance. Whenever the clock time should be
calculated it will call @func with @user_data. When @func returns
#GST_CLOCK_TIME_NONE, the clock will return the last reported time.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a new #GstAudioClock casted to a #GstClock.</doc>
<type name="Gst.Clock" c:type="GstClock*"/>
</return-value>
<parameters>
<parameter name="name" transfer-ownership="none">
<doc xml:space="preserve">the name of the clock</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="func"
transfer-ownership="none"
scope="notified"
closure="2"
destroy="3">
<doc xml:space="preserve">a function</doc>
<type name="AudioClockGetTimeFunc"
c:type="GstAudioClockGetTimeFunc"/>
</parameter>
<parameter name="user_data" transfer-ownership="none">
<doc xml:space="preserve">user data</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="destroy_notify"
transfer-ownership="none"
scope="async">
<doc xml:space="preserve">#GDestroyNotify for @user_data</doc>
<type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
</parameter>
</parameters>
</constructor>
<function name="adjust" c:identifier="gst_audio_clock_adjust">
<doc xml:space="preserve">Adjust @time with the internal offset of the audio clock.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">@time adjusted with the internal offset.</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</return-value>
<parameters>
<parameter name="clock" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioClock</doc>
<type name="Gst.Clock" c:type="GstClock*"/>
</parameter>
<parameter name="time" transfer-ownership="none">
<doc xml:space="preserve">a #GstClockTime</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</parameter>
</parameters>
</function>
<function name="get_time" c:identifier="gst_audio_clock_get_time">
<doc xml:space="preserve">Report the time as returned by the #GstAudioClockGetTimeFunc without applying
any offsets.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the time as reported by the time function of the audio clock</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</return-value>
<parameters>
<parameter name="clock" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioClock</doc>
<type name="Gst.Clock" c:type="GstClock*"/>
</parameter>
</parameters>
</function>
<function name="invalidate" c:identifier="gst_audio_clock_invalidate">
<doc xml:space="preserve">Invalidate the clock function. Call this function when the provided
#GstAudioClockGetTimeFunc cannot be called anymore, for example, when the
user_data becomes invalid.
After calling this function, @clock will return the last returned time for
the rest of its lifetime.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="clock" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioClock</doc>
<type name="Gst.Clock" c:type="GstClock*"/>
</parameter>
</parameters>
</function>
<method name="reset" c:identifier="gst_audio_clock_reset">
<doc xml:space="preserve">Inform @clock that future calls to #GstAudioClockGetTimeFunc will return values
starting from @time. The clock will update an internal offset to make sure that
future calls to internal_time will return an increasing result as required by
the #GstClock object.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="clock" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioClock</doc>
<type name="AudioClock" c:type="GstAudioClock*"/>
</instance-parameter>
<parameter name="time" transfer-ownership="none">
<doc xml:space="preserve">a #GstClockTime</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</parameter>
</parameters>
</method>
<field name="clock">
<type name="Gst.SystemClock" c:type="GstSystemClock"/>
</field>
<field name="func">
<type name="AudioClockGetTimeFunc" c:type="GstAudioClockGetTimeFunc"/>
</field>
<field name="user_data">
<type name="gpointer" c:type="gpointer"/>
</field>
<field name="destroy_notify">
<type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
</field>
<field name="last_time" readable="0" private="1">
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</field>
<field name="time_offset" readable="0" private="1">
<type name="Gst.ClockTimeDiff" c:type="GstClockTimeDiff"/>
</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="AudioClockClass"
c:type="GstAudioClockClass"
glib:is-gtype-struct-for="AudioClock">
<field name="parent_class">
<type name="Gst.SystemClockClass" c:type="GstSystemClockClass"/>
</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>
<callback name="AudioClockGetTimeFunc" c:type="GstAudioClockGetTimeFunc">
<doc xml:space="preserve">This function will be called whenever the current clock time needs to be
calculated. If this function returns #GST_CLOCK_TIME_NONE, the last reported
time will be returned by the clock.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the current time or #GST_CLOCK_TIME_NONE if the previous time should
be used.</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</return-value>
<parameters>
<parameter name="clock" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioClock</doc>
<type name="Gst.Clock" c:type="GstClock*"/>
</parameter>
<parameter name="user_data" transfer-ownership="none" closure="1">
<doc xml:space="preserve">user data</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
<class name="AudioDecoder"
c:symbol-prefix="audio_decoder"
c:type="GstAudioDecoder"
parent="Gst.Element"
abstract="1"
glib:type-name="GstAudioDecoder"
glib:get-type="gst_audio_decoder_get_type"
glib:type-struct="AudioDecoderClass">
<doc xml:space="preserve">This base class is for audio decoders turning encoded data into
raw audio samples.
GstAudioDecoder and subclass should cooperate as follows.
<orderedlist>
<listitem>
<itemizedlist><title>Configuration</title>
<listitem><para>
Initially, GstAudioDecoder calls @start when the decoder element
is activated, which allows subclass to perform any global setup.
Base class (context) parameters can already be set according to subclass
capabilities (or possibly upon receive more information in subsequent
@set_format).
</para></listitem>
<listitem><para>
GstAudioDecoder calls @set_format to inform subclass of the format
of input audio data that it is about to receive.
While unlikely, it might be called more than once, if changing input
parameters require reconfiguration.
</para></listitem>
<listitem><para>
GstAudioDecoder calls @stop at end of all processing.
</para></listitem>
</itemizedlist>
</listitem>
As of configuration stage, and throughout processing, GstAudioDecoder
provides various (context) parameters, e.g. describing the format of
output audio data (valid when output caps have been set) or current parsing state.
Conversely, subclass can and should configure context to inform
base class of its expectation w.r.t. buffer handling.
<listitem>
<itemizedlist>
<title>Data processing</title>
<listitem><para>
Base class gathers input data, and optionally allows subclass
to parse this into subsequently manageable (as defined by subclass)
chunks. Such chunks are subsequently referred to as 'frames',
though they may or may not correspond to 1 (or more) audio format frame.
</para></listitem>
<listitem><para>
Input frame is provided to subclass' @handle_frame.
</para></listitem>
<listitem><para>
If codec processing results in decoded data, subclass should call
@gst_audio_decoder_finish_frame to have decoded data pushed
downstream.
</para></listitem>
<listitem><para>
Just prior to actually pushing a buffer downstream,
it is passed to @pre_push. Subclass should either use this callback
to arrange for additional downstream pushing or otherwise ensure such
custom pushing occurs after at least a method call has finished since
setting src pad caps.
</para></listitem>
<listitem><para>
During the parsing process GstAudioDecoderClass will handle both
srcpad and sinkpad events. Sink events will be passed to subclass
if @event callback has been provided.
</para></listitem>
</itemizedlist>
</listitem>
<listitem>
<itemizedlist><title>Shutdown phase</title>
<listitem><para>
GstAudioDecoder class calls @stop to inform the subclass that data
parsing will be stopped.
</para></listitem>
</itemizedlist>
</listitem>
</orderedlist>
Subclass is responsible for providing pad template caps for
source and sink pads. The pads need to be named "sink" and "src". It also
needs to set the fixed caps on srcpad, when the format is ensured. This
is typically when base class calls subclass' @set_format function, though
it might be delayed until calling @gst_audio_decoder_finish_frame.
In summary, above process should have subclass concentrating on
codec data processing while leaving other matters to base class,
such as most notably timestamp handling. While it may exert more control
in this area (see e.g. @pre_push), it is very much not recommended.
In particular, base class will try to arrange for perfect output timestamps
as much as possible while tracking upstream timestamps.
To this end, if deviation between the next ideal expected perfect timestamp
and upstream exceeds #GstAudioDecoder:tolerance, then resync to upstream
occurs (which would happen always if the tolerance mechanism is disabled).
In non-live pipelines, baseclass can also (configurably) arrange for
output buffer aggregation which may help to redue large(r) numbers of
small(er) buffers being pushed and processed downstream.
On the other hand, it should be noted that baseclass only provides limited
seeking support (upon explicit subclass request), as full-fledged support
should rather be left to upstream demuxer, parser or alike. This simple
approach caters for seeking and duration reporting using estimated input
bitrates.
Things that subclass need to take care of:
<itemizedlist>
<listitem><para>Provide pad templates</para></listitem>
<listitem><para>
Set source pad caps when appropriate
</para></listitem>
<listitem><para>
Set user-configurable properties to sane defaults for format and
implementing codec at hand, and convey some subclass capabilities and
expectations in context.
</para></listitem>
<listitem><para>
Accept data in @handle_frame and provide encoded results to
@gst_audio_decoder_finish_frame. If it is prepared to perform
PLC, it should also accept NULL data in @handle_frame and provide for
data for indicated duration.
</para></listitem>
</itemizedlist></doc>
<virtual-method name="close">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="decide_allocation">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</instance-parameter>
<parameter name="query" transfer-ownership="none">
<type name="Gst.Query" c:type="GstQuery*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="flush">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</instance-parameter>
<parameter name="hard" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="handle_frame">
<return-value transfer-ownership="none">
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</instance-parameter>
<parameter name="buffer" transfer-ownership="none">
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="negotiate" invoker="negotiate">
<doc xml:space="preserve">Negotiate with downstream elements to currently configured #GstAudioInfo.
Unmark GST_PAD_FLAG_NEED_RECONFIGURE in any case. But mark it again if
negotiate fails.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">#TRUE if the negotiation succeeded, else #FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioDecoder</doc>
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="open">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="parse">
<return-value transfer-ownership="none">
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</instance-parameter>
<parameter name="adapter" transfer-ownership="none">
<type name="GstBase.Adapter" c:type="GstAdapter*"/>
</parameter>
<parameter name="offset" transfer-ownership="none">
<type name="gint" c:type="gint*"/>
</parameter>
<parameter name="length" transfer-ownership="none">
<type name="gint" c:type="gint*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="pre_push">
<return-value transfer-ownership="none">
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</instance-parameter>
<parameter name="buffer" transfer-ownership="none">
<type name="Gst.Buffer" c:type="GstBuffer**"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="propose_allocation">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</instance-parameter>
<parameter name="query" transfer-ownership="none">
<type name="Gst.Query" c:type="GstQuery*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="set_format">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</instance-parameter>
<parameter name="caps" transfer-ownership="none">
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="sink_event">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</instance-parameter>
<parameter name="event" transfer-ownership="none">
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="src_event">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</instance-parameter>
<parameter name="event" transfer-ownership="none">
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="start">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="stop">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</instance-parameter>
</parameters>
</virtual-method>
<method name="allocate_output_buffer"
c:identifier="gst_audio_decoder_allocate_output_buffer">
<doc xml:space="preserve">Helper function that allocates a buffer to hold an audio frame
for @dec's current output format.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">allocated buffer</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioDecoder</doc>
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</instance-parameter>
<parameter name="size" transfer-ownership="none">
<doc xml:space="preserve">size of the buffer</doc>
<type name="gsize" c:type="gsize"/>
</parameter>
</parameters>
</method>
<method name="finish_frame"
c:identifier="gst_audio_decoder_finish_frame">
<doc xml:space="preserve">Collects decoded data and pushes it downstream.
@buf may be NULL in which case the indicated number of frames
are discarded and considered to have produced no output
(e.g. lead-in or setup frames).
Otherwise, source pad caps must be set when it is called with valid
data in @buf.
Note that a frame received in gst_audio_decoder_handle_frame() may be
invalidated by a call to this function.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #GstFlowReturn that should be escalated to caller (of caller)</doc>
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioDecoder</doc>
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</instance-parameter>
<parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">decoded data</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</parameter>
<parameter name="frames" transfer-ownership="none">
<doc xml:space="preserve">number of decoded frames represented by decoded data</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="get_allocator"
c:identifier="gst_audio_decoder_get_allocator">
<doc xml:space="preserve">Lets #GstAudioDecoder sub-classes to know the memory @allocator
used by the base class and its @params.
Unref the @allocator after use it.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioDecoder</doc>
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</instance-parameter>
<parameter name="allocator"
direction="out"
caller-allocates="0"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve">the #GstAllocator
used</doc>
<type name="Gst.Allocator" c:type="GstAllocator**"/>
</parameter>
<parameter name="params"
direction="out"
caller-allocates="1"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve">the
#GstAllocatorParams of @allocator</doc>
<type name="Gst.AllocationParams" c:type="GstAllocationParams*"/>
</parameter>
</parameters>
</method>
<method name="get_audio_info"
c:identifier="gst_audio_decoder_get_audio_info">
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GstAudioInfo describing the input audio format</doc>
<type name="AudioInfo" c:type="GstAudioInfo*"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioDecoder</doc>
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_delay" c:identifier="gst_audio_decoder_get_delay">
<return-value transfer-ownership="none">
<doc xml:space="preserve">currently configured decoder delay</doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioDecoder</doc>
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_drainable"
c:identifier="gst_audio_decoder_get_drainable">
<doc xml:space="preserve">Queries decoder drain handling.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if drainable handling is enabled.
MT safe.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioDecoder</doc>
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_estimate_rate"
c:identifier="gst_audio_decoder_get_estimate_rate">
<return-value transfer-ownership="none">
<doc xml:space="preserve">currently configured byte to time conversion setting</doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioDecoder</doc>
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_latency" c:identifier="gst_audio_decoder_get_latency">
<doc xml:space="preserve">Sets the variables pointed to by @min and @max to the currently configured
latency.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioDecoder</doc>
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</instance-parameter>
<parameter name="min"
direction="out"
caller-allocates="0"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve">a pointer to storage to hold minimum latency</doc>
<type name="Gst.ClockTime" c:type="GstClockTime*"/>
</parameter>
<parameter name="max"
direction="out"
caller-allocates="0"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve">a pointer to storage to hold maximum latency</doc>
<type name="Gst.ClockTime" c:type="GstClockTime*"/>
</parameter>
</parameters>
</method>
<method name="get_max_errors"
c:identifier="gst_audio_decoder_get_max_errors">
<return-value transfer-ownership="none">
<doc xml:space="preserve">currently configured decoder tolerated error count.</doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioDecoder</doc>
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_min_latency"
c:identifier="gst_audio_decoder_get_min_latency">
<doc xml:space="preserve">Queries decoder's latency aggregation.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">aggregation latency.
MT safe.</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioDecoder</doc>
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_needs_format"
c:identifier="gst_audio_decoder_get_needs_format">
<doc xml:space="preserve">Queries decoder required format handling.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if required format handling is enabled.
MT safe.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioDecoder</doc>
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_parse_state"
c:identifier="gst_audio_decoder_get_parse_state">
<doc xml:space="preserve">Return current parsing (sync and eos) state.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioDecoder</doc>
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</instance-parameter>
<parameter name="sync" transfer-ownership="none">
<doc xml:space="preserve">a pointer to a variable to hold the current sync state</doc>
<type name="gboolean" c:type="gboolean*"/>
</parameter>
<parameter name="eos" transfer-ownership="none">
<doc xml:space="preserve">a pointer to a variable to hold the current eos state</doc>
<type name="gboolean" c:type="gboolean*"/>
</parameter>
</parameters>
</method>
<method name="get_plc" c:identifier="gst_audio_decoder_get_plc">
<doc xml:space="preserve">Queries decoder packet loss concealment handling.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if packet loss concealment is enabled.
MT safe.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioDecoder</doc>
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_plc_aware"
c:identifier="gst_audio_decoder_get_plc_aware">
<return-value transfer-ownership="none">
<doc xml:space="preserve">currently configured plc handling</doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioDecoder</doc>
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_tolerance"
c:identifier="gst_audio_decoder_get_tolerance">
<doc xml:space="preserve">Queries current audio jitter tolerance threshold.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">decoder audio jitter tolerance threshold.
MT safe.</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioDecoder</doc>
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</instance-parameter>
</parameters>
</method>
<method name="merge_tags" c:identifier="gst_audio_decoder_merge_tags">
<doc xml:space="preserve">Adds tags to so-called pending tags, which will be processed
before pushing out data downstream.
Note that this is provided for convenience, and the subclass is
not required to use this and can still do tag handling on its own,
although it should be aware that baseclass already takes care
of the usual CODEC/AUDIO_CODEC tags.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioDecoder</doc>
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</instance-parameter>
<parameter name="tags" transfer-ownership="none">
<doc xml:space="preserve">a #GstTagList to merge</doc>
<type name="Gst.TagList" c:type="const GstTagList*"/>
</parameter>
<parameter name="mode" transfer-ownership="none">
<doc xml:space="preserve">the #GstTagMergeMode to use</doc>
<type name="Gst.TagMergeMode" c:type="GstTagMergeMode"/>
</parameter>
</parameters>
</method>
<method name="negotiate" c:identifier="gst_audio_decoder_negotiate">
<doc xml:space="preserve">Negotiate with downstream elements to currently configured #GstAudioInfo.
Unmark GST_PAD_FLAG_NEED_RECONFIGURE in any case. But mark it again if
negotiate fails.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">#TRUE if the negotiation succeeded, else #FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioDecoder</doc>
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_drainable"
c:identifier="gst_audio_decoder_set_drainable">
<doc xml:space="preserve">Configures decoder drain handling. If drainable, subclass might
be handed a NULL buffer to have it return any leftover decoded data.
Otherwise, it is not considered so capable and will only ever be passed
real data.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioDecoder</doc>
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</instance-parameter>
<parameter name="enabled" transfer-ownership="none">
<doc xml:space="preserve">new state</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_estimate_rate"
c:identifier="gst_audio_decoder_set_estimate_rate">
<doc xml:space="preserve">Allows baseclass to perform byte to time estimated conversion.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioDecoder</doc>
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</instance-parameter>
<parameter name="enabled" transfer-ownership="none">
<doc xml:space="preserve">whether to enable byte to time conversion</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_latency" c:identifier="gst_audio_decoder_set_latency">
<doc xml:space="preserve">Sets decoder latency.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioDecoder</doc>
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</instance-parameter>
<parameter name="min" transfer-ownership="none">
<doc xml:space="preserve">minimum latency</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</parameter>
<parameter name="max" transfer-ownership="none">
<doc xml:space="preserve">maximum latency</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</parameter>
</parameters>
</method>
<method name="set_max_errors"
c:identifier="gst_audio_decoder_set_max_errors">
<doc xml:space="preserve">Sets numbers of tolerated decoder errors, where a tolerated one is then only
warned about, but more than tolerated will lead to fatal error. You can set
-1 for never returning fatal errors. Default is set to
GST_AUDIO_DECODER_MAX_ERRORS.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioDecoder</doc>
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</instance-parameter>
<parameter name="num" transfer-ownership="none">
<doc xml:space="preserve">max tolerated errors</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="set_min_latency"
c:identifier="gst_audio_decoder_set_min_latency">
<doc xml:space="preserve">Sets decoder minimum aggregation latency.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioDecoder</doc>
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</instance-parameter>
<parameter name="num" transfer-ownership="none">
<doc xml:space="preserve">new minimum latency</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</parameter>
</parameters>
</method>
<method name="set_needs_format"
c:identifier="gst_audio_decoder_set_needs_format">
<doc xml:space="preserve">Configures decoder format needs. If enabled, subclass needs to be
negotiated with format caps before it can process any data. It will then
never be handed any data before it has been configured.
Otherwise, it might be handed data without having been configured and
is then expected being able to do so either by default
or based on the input data.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioDecoder</doc>
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</instance-parameter>
<parameter name="enabled" transfer-ownership="none">
<doc xml:space="preserve">new state</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_output_format"
c:identifier="gst_audio_decoder_set_output_format">
<doc xml:space="preserve">Configure output info on the srcpad of @dec.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE on success.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioDecoder</doc>
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</instance-parameter>
<parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">#GstAudioInfo</doc>
<type name="AudioInfo" c:type="const GstAudioInfo*"/>
</parameter>
</parameters>
</method>
<method name="set_plc" c:identifier="gst_audio_decoder_set_plc">
<doc xml:space="preserve">Enable or disable decoder packet loss concealment, provided subclass
and codec are capable and allow handling plc.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioDecoder</doc>
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</instance-parameter>
<parameter name="enabled" transfer-ownership="none">
<doc xml:space="preserve">new state</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_plc_aware"
c:identifier="gst_audio_decoder_set_plc_aware">
<doc xml:space="preserve">Indicates whether or not subclass handles packet loss concealment (plc).</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioDecoder</doc>
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</instance-parameter>
<parameter name="plc" transfer-ownership="none">
<doc xml:space="preserve">new plc state</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_tolerance"
c:identifier="gst_audio_decoder_set_tolerance">
<doc xml:space="preserve">Configures decoder audio jitter tolerance threshold.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioDecoder</doc>
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</instance-parameter>
<parameter name="tolerance" transfer-ownership="none">
<doc xml:space="preserve">new tolerance</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</parameter>
</parameters>
</method>
<property name="min-latency" writable="1" transfer-ownership="none">
<type name="gint64" c:type="gint64"/>
</property>
<property name="plc" writable="1" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="tolerance" writable="1" transfer-ownership="none">
<type name="gint64" c:type="gint64"/>
</property>
<field name="element">
<type name="Gst.Element" c:type="GstElement"/>
</field>
<field name="sinkpad">
<type name="Gst.Pad" c:type="GstPad*"/>
</field>
<field name="srcpad">
<type name="Gst.Pad" c:type="GstPad*"/>
</field>
<field name="stream_lock">
<type name="GLib.RecMutex" c:type="GRecMutex"/>
</field>
<field name="input_segment">
<type name="Gst.Segment" c:type="GstSegment"/>
</field>
<field name="output_segment">
<type name="Gst.Segment" c:type="GstSegment"/>
</field>
<field name="priv" readable="0" private="1">
<type name="AudioDecoderPrivate" c:type="GstAudioDecoderPrivate*"/>
</field>
<field name="_gst_reserved" readable="0" private="1">
<array zero-terminated="0" c:type="gpointer" fixed-size="20">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</class>
<record name="AudioDecoderClass"
c:type="GstAudioDecoderClass"
glib:is-gtype-struct-for="AudioDecoder">
<doc xml:space="preserve">Subclasses can override any of the available virtual methods or not, as
needed. At minimum @handle_frame (and likely @set_format) needs to be
overridden.</doc>
<field name="element_class">
<doc xml:space="preserve">The parent class structure</doc>
<type name="Gst.ElementClass" c:type="GstElementClass"/>
</field>
<field name="start">
<callback name="start">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="dec" transfer-ownership="none">
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="stop">
<callback name="stop">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="dec" transfer-ownership="none">
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="set_format">
<callback name="set_format">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="dec" transfer-ownership="none">
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</parameter>
<parameter name="caps" transfer-ownership="none">
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="parse">
<callback name="parse">
<return-value transfer-ownership="none">
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<parameter name="dec" transfer-ownership="none">
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</parameter>
<parameter name="adapter" transfer-ownership="none">
<type name="GstBase.Adapter" c:type="GstAdapter*"/>
</parameter>
<parameter name="offset" transfer-ownership="none">
<type name="gint" c:type="gint*"/>
</parameter>
<parameter name="length" transfer-ownership="none">
<type name="gint" c:type="gint*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="handle_frame">
<callback name="handle_frame">
<return-value transfer-ownership="none">
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<parameter name="dec" transfer-ownership="none">
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</parameter>
<parameter name="buffer" transfer-ownership="none">
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="flush">
<callback name="flush">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="dec" transfer-ownership="none">
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</parameter>
<parameter name="hard" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</callback>
</field>
<field name="pre_push">
<callback name="pre_push">
<return-value transfer-ownership="none">
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<parameter name="dec" transfer-ownership="none">
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</parameter>
<parameter name="buffer" transfer-ownership="none">
<type name="Gst.Buffer" c:type="GstBuffer**"/>
</parameter>
</parameters>
</callback>
</field>
<field name="sink_event">
<callback name="sink_event">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="dec" transfer-ownership="none">
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</parameter>
<parameter name="event" transfer-ownership="none">
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="src_event">
<callback name="src_event">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="dec" transfer-ownership="none">
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</parameter>
<parameter name="event" transfer-ownership="none">
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="open">
<callback name="open">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="dec" transfer-ownership="none">
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="close">
<callback name="close">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="dec" transfer-ownership="none">
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="negotiate">
<callback name="negotiate">
<return-value transfer-ownership="none">
<doc xml:space="preserve">#TRUE if the negotiation succeeded, else #FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="dec" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioDecoder</doc>
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="decide_allocation">
<callback name="decide_allocation">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="dec" transfer-ownership="none">
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</parameter>
<parameter name="query" transfer-ownership="none">
<type name="Gst.Query" c:type="GstQuery*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="propose_allocation">
<callback name="propose_allocation">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="dec" transfer-ownership="none">
<type name="AudioDecoder" c:type="GstAudioDecoder*"/>
</parameter>
<parameter name="query" transfer-ownership="none">
<type name="Gst.Query" c:type="GstQuery*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="_gst_reserved" readable="0" private="1">
<array zero-terminated="0" c:type="gpointer" fixed-size="20">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<record name="AudioDecoderPrivate"
c:type="GstAudioDecoderPrivate"
disguised="1">
</record>
<record name="AudioDownmixMeta" c:type="GstAudioDownmixMeta">
<doc xml:space="preserve">Extra buffer metadata describing audio downmixing matrix. This metadata is
attached to audio buffers and contains a matrix to downmix the buffer number
of channels to @channels.
@matrix is an two-dimensional array of @to_channels times @from_channels
coefficients, i.e. the i-th output channels is constructed by multiplicating
the input channels with the coefficients in @matrix[i] and taking the sum
of the results.</doc>
<field name="meta" writable="1">
<doc xml:space="preserve">parent #GstMeta</doc>
<type name="Gst.Meta" c:type="GstMeta"/>
</field>
<field name="from_position" writable="1">
<doc xml:space="preserve">the channel positions of the source</doc>
<type name="AudioChannelPosition" c:type="GstAudioChannelPosition*"/>
</field>
<field name="to_position" writable="1">
<doc xml:space="preserve">the channel positions of the destination</doc>
<type name="AudioChannelPosition" c:type="GstAudioChannelPosition*"/>
</field>
<field name="from_channels" writable="1">
<doc xml:space="preserve">the number of channels of the source</doc>
<type name="gint" c:type="gint"/>
</field>
<field name="to_channels" writable="1">
<doc xml:space="preserve">the number of channels of the destination</doc>
<type name="gint" c:type="gint"/>
</field>
<field name="matrix" writable="1">
<doc xml:space="preserve">the matrix coefficients.</doc>
<type name="gfloat" c:type="gfloat**"/>
</field>
<function name="get_info" c:identifier="gst_audio_downmix_meta_get_info">
<return-value transfer-ownership="none">
<type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
</return-value>
</function>
</record>
<class name="AudioEncoder"
c:symbol-prefix="audio_encoder"
c:type="GstAudioEncoder"
parent="Gst.Element"
abstract="1"
glib:type-name="GstAudioEncoder"
glib:get-type="gst_audio_encoder_get_type"
glib:type-struct="AudioEncoderClass">
<doc xml:space="preserve">This base class is for audio encoders turning raw audio samples into
encoded audio data.
GstAudioEncoder and subclass should cooperate as follows.
<orderedlist>
<listitem>
<itemizedlist><title>Configuration</title>
<listitem><para>
Initially, GstAudioEncoder calls @start when the encoder element
is activated, which allows subclass to perform any global setup.
</para></listitem>
<listitem><para>
GstAudioEncoder calls @set_format to inform subclass of the format
of input audio data that it is about to receive. Subclass should
setup for encoding and configure various base class parameters
appropriately, notably those directing desired input data handling.
While unlikely, it might be called more than once, if changing input
parameters require reconfiguration.
</para></listitem>
<listitem><para>
GstAudioEncoder calls @stop at end of all processing.
</para></listitem>
</itemizedlist>
</listitem>
As of configuration stage, and throughout processing, GstAudioEncoder
maintains various parameters that provide required context,
e.g. describing the format of input audio data.
Conversely, subclass can and should configure these context parameters
to inform base class of its expectation w.r.t. buffer handling.
<listitem>
<itemizedlist>
<title>Data processing</title>
<listitem><para>
Base class gathers input sample data (as directed by the context's
frame_samples and frame_max) and provides this to subclass' @handle_frame.
</para></listitem>
<listitem><para>
If codec processing results in encoded data, subclass should call
gst_audio_encoder_finish_frame() to have encoded data pushed
downstream. Alternatively, it might also call
gst_audio_encoder_finish_frame() (with a NULL buffer and some number of
dropped samples) to indicate dropped (non-encoded) samples.
</para></listitem>
<listitem><para>
Just prior to actually pushing a buffer downstream,
it is passed to @pre_push.
</para></listitem>
<listitem><para>
During the parsing process GstAudioEncoderClass will handle both
srcpad and sinkpad events. Sink events will be passed to subclass
if @event callback has been provided.
</para></listitem>
</itemizedlist>
</listitem>
<listitem>
<itemizedlist><title>Shutdown phase</title>
<listitem><para>
GstAudioEncoder class calls @stop to inform the subclass that data
parsing will be stopped.
</para></listitem>
</itemizedlist>
</listitem>
</orderedlist>
Subclass is responsible for providing pad template caps for
source and sink pads. The pads need to be named "sink" and "src". It also
needs to set the fixed caps on srcpad, when the format is ensured. This
is typically when base class calls subclass' @set_format function, though
it might be delayed until calling @gst_audio_encoder_finish_frame.
In summary, above process should have subclass concentrating on
codec data processing while leaving other matters to base class,
such as most notably timestamp handling. While it may exert more control
in this area (see e.g. @pre_push), it is very much not recommended.
In particular, base class will either favor tracking upstream timestamps
(at the possible expense of jitter) or aim to arrange for a perfect stream of
output timestamps, depending on #GstAudioEncoder:perfect-timestamp.
However, in the latter case, the input may not be so perfect or ideal, which
is handled as follows. An input timestamp is compared with the expected
timestamp as dictated by input sample stream and if the deviation is less
than #GstAudioEncoder:tolerance, the deviation is discarded.
Otherwise, it is considered a discontuinity and subsequent output timestamp
is resynced to the new position after performing configured discontinuity
processing. In the non-perfect-timestamp case, an upstream variation
exceeding tolerance only leads to marking DISCONT on subsequent outgoing
(while timestamps are adjusted to upstream regardless of variation).
While DISCONT is also marked in the perfect-timestamp case, this one
optionally (see #GstAudioEncoder:hard-resync)
performs some additional steps, such as clipping of (early) input samples
or draining all currently remaining input data, depending on the direction
of the discontuinity.
If perfect timestamps are arranged, it is also possible to request baseclass
(usually set by subclass) to provide additional buffer metadata (in OFFSET
and OFFSET_END) fields according to granule defined semantics currently
needed by oggmux. Specifically, OFFSET is set to granulepos (= sample count
including buffer) and OFFSET_END to corresponding timestamp (as determined
by same sample count and sample rate).
Things that subclass need to take care of:
<itemizedlist>
<listitem><para>Provide pad templates</para></listitem>
<listitem><para>
Set source pad caps when appropriate
</para></listitem>
<listitem><para>
Inform base class of buffer processing needs using context's
frame_samples and frame_bytes.
</para></listitem>
<listitem><para>
Set user-configurable properties to sane defaults for format and
implementing codec at hand, e.g. those controlling timestamp behaviour
and discontinuity processing.
</para></listitem>
<listitem><para>
Accept data in @handle_frame and provide encoded results to
gst_audio_encoder_finish_frame().
</para></listitem>
</itemizedlist></doc>
<implements name="Gst.Preset"/>
<virtual-method name="close">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="decide_allocation">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
<parameter name="query" transfer-ownership="none">
<type name="Gst.Query" c:type="GstQuery*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="flush">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="getcaps">
<return-value transfer-ownership="full">
<type name="Gst.Caps" c:type="GstCaps*"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
<parameter name="filter" transfer-ownership="none">
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="handle_frame">
<return-value transfer-ownership="none">
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
<parameter name="buffer" transfer-ownership="none">
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="negotiate" invoker="negotiate">
<doc xml:space="preserve">Negotiate with downstream elements to currently configured #GstCaps.
Unmark GST_PAD_FLAG_NEED_RECONFIGURE in any case. But mark it again if
negotiate fails.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">#TRUE if the negotiation succeeded, else #FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioEncoder</doc>
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="open">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="pre_push">
<return-value transfer-ownership="none">
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
<parameter name="buffer" transfer-ownership="none">
<type name="Gst.Buffer" c:type="GstBuffer**"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="propose_allocation">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
<parameter name="query" transfer-ownership="none">
<type name="Gst.Query" c:type="GstQuery*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="set_format">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
<parameter name="info" transfer-ownership="none">
<type name="AudioInfo" c:type="GstAudioInfo*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="sink_event">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
<parameter name="event" transfer-ownership="none">
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="src_event">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
<parameter name="event" transfer-ownership="none">
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="start">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="stop">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
</parameters>
</virtual-method>
<method name="allocate_output_buffer"
c:identifier="gst_audio_encoder_allocate_output_buffer">
<doc xml:space="preserve">Helper function that allocates a buffer to hold an encoded audio frame
for @enc's current output format.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">allocated buffer</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioEncoder</doc>
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
<parameter name="size" transfer-ownership="none">
<doc xml:space="preserve">size of the buffer</doc>
<type name="gsize" c:type="gsize"/>
</parameter>
</parameters>
</method>
<method name="finish_frame"
c:identifier="gst_audio_encoder_finish_frame">
<doc xml:space="preserve">Collects encoded data and pushes encoded data downstream.
Source pad caps must be set when this is called.
If @samples < 0, then best estimate is all samples provided to encoder
(subclass) so far. @buf may be NULL, in which case next number of @samples
are considered discarded, e.g. as a result of discontinuous transmission,
and a discontinuity is marked.
Note that samples received in gst_audio_encoder_handle_frame()
may be invalidated by a call to this function.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #GstFlowReturn that should be escalated to caller (of caller)</doc>
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioEncoder</doc>
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
<parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve">encoded data</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</parameter>
<parameter name="samples" transfer-ownership="none">
<doc xml:space="preserve">number of samples (per channel) represented by encoded data</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="get_allocator"
c:identifier="gst_audio_encoder_get_allocator">
<doc xml:space="preserve">Lets #GstAudioEncoder sub-classes to know the memory @allocator
used by the base class and its @params.
Unref the @allocator after use it.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioEncoder</doc>
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
<parameter name="allocator"
direction="out"
caller-allocates="0"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve">the #GstAllocator
used</doc>
<type name="Gst.Allocator" c:type="GstAllocator**"/>
</parameter>
<parameter name="params"
direction="out"
caller-allocates="1"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve">the
#GstAllocatorParams of @allocator</doc>
<type name="Gst.AllocationParams" c:type="GstAllocationParams*"/>
</parameter>
</parameters>
</method>
<method name="get_audio_info"
c:identifier="gst_audio_encoder_get_audio_info">
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GstAudioInfo describing the input audio format</doc>
<type name="AudioInfo" c:type="GstAudioInfo*"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioEncoder</doc>
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_drainable"
c:identifier="gst_audio_encoder_get_drainable">
<doc xml:space="preserve">Queries encoder drain handling.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if drainable handling is enabled.
MT safe.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioEncoder</doc>
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_frame_max"
c:identifier="gst_audio_encoder_get_frame_max">
<return-value transfer-ownership="none">
<doc xml:space="preserve">currently configured maximum handled frames</doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioEncoder</doc>
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_frame_samples_max"
c:identifier="gst_audio_encoder_get_frame_samples_max">
<return-value transfer-ownership="none">
<doc xml:space="preserve">currently maximum requested samples per frame</doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioEncoder</doc>
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_frame_samples_min"
c:identifier="gst_audio_encoder_get_frame_samples_min">
<return-value transfer-ownership="none">
<doc xml:space="preserve">currently minimum requested samples per frame</doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioEncoder</doc>
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_hard_min"
c:identifier="gst_audio_encoder_get_hard_min">
<doc xml:space="preserve">Queries encoder hard minimum handling.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if hard minimum handling is enabled.
MT safe.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioEncoder</doc>
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_hard_resync"
c:identifier="gst_audio_encoder_get_hard_resync">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_latency" c:identifier="gst_audio_encoder_get_latency">
<doc xml:space="preserve">Sets the variables pointed to by @min and @max to the currently configured
latency.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioEncoder</doc>
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
<parameter name="min"
direction="out"
caller-allocates="0"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve">a pointer to storage to hold minimum latency</doc>
<type name="Gst.ClockTime" c:type="GstClockTime*"/>
</parameter>
<parameter name="max"
direction="out"
caller-allocates="0"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve">a pointer to storage to hold maximum latency</doc>
<type name="Gst.ClockTime" c:type="GstClockTime*"/>
</parameter>
</parameters>
</method>
<method name="get_lookahead"
c:identifier="gst_audio_encoder_get_lookahead">
<return-value transfer-ownership="none">
<doc xml:space="preserve">currently configured encoder lookahead</doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioEncoder</doc>
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_mark_granule"
c:identifier="gst_audio_encoder_get_mark_granule">
<doc xml:space="preserve">Queries if the encoder will handle granule marking.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if granule marking is enabled.
MT safe.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioEncoder</doc>
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_perfect_timestamp"
c:identifier="gst_audio_encoder_get_perfect_timestamp">
<doc xml:space="preserve">Queries encoder perfect timestamp behaviour.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if perfect timestamp setting enabled.
MT safe.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioEncoder</doc>
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_tolerance"
c:identifier="gst_audio_encoder_get_tolerance">
<doc xml:space="preserve">Queries current audio jitter tolerance threshold.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">encoder audio jitter tolerance threshold.
MT safe.</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioEncoder</doc>
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
</parameters>
</method>
<method name="merge_tags" c:identifier="gst_audio_encoder_merge_tags">
<doc xml:space="preserve">Adds tags to so-called pending tags, which will be processed
before pushing out data downstream.
Note that this is provided for convenience, and the subclass is
not required to use this and can still do tag handling on its own,
although it should be aware that baseclass already takes care
of the usual CODEC/AUDIO_CODEC tags.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioEncoder</doc>
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
<parameter name="tags" transfer-ownership="none">
<doc xml:space="preserve">a #GstTagList to merge</doc>
<type name="Gst.TagList" c:type="const GstTagList*"/>
</parameter>
<parameter name="mode" transfer-ownership="none">
<doc xml:space="preserve">the #GstTagMergeMode to use</doc>
<type name="Gst.TagMergeMode" c:type="GstTagMergeMode"/>
</parameter>
</parameters>
</method>
<method name="negotiate" c:identifier="gst_audio_encoder_negotiate">
<doc xml:space="preserve">Negotiate with downstream elements to currently configured #GstCaps.
Unmark GST_PAD_FLAG_NEED_RECONFIGURE in any case. But mark it again if
negotiate fails.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">#TRUE if the negotiation succeeded, else #FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioEncoder</doc>
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
</parameters>
</method>
<method name="proxy_getcaps"
c:identifier="gst_audio_encoder_proxy_getcaps">
<doc xml:space="preserve">Returns caps that express @caps (or sink template caps if @caps == NULL)
restricted to channel/rate combinations supported by downstream elements
(e.g. muxers).</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GstCaps owned by caller</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioEncoder</doc>
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
<parameter name="caps" transfer-ownership="none">
<doc xml:space="preserve">initial caps</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
<parameter name="filter" transfer-ownership="none">
<doc xml:space="preserve">filter caps</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
</parameters>
</method>
<method name="set_drainable"
c:identifier="gst_audio_encoder_set_drainable">
<doc xml:space="preserve">Configures encoder drain handling. If drainable, subclass might
be handed a NULL buffer to have it return any leftover encoded data.
Otherwise, it is not considered so capable and will only ever be passed
real data.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioEncoder</doc>
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
<parameter name="enabled" transfer-ownership="none">
<doc xml:space="preserve">new state</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_frame_max"
c:identifier="gst_audio_encoder_set_frame_max">
<doc xml:space="preserve">Sets max number of frames accepted at once (assumed minimally 1).
Requires @frame_samples_min and @frame_samples_max to be the equal.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioEncoder</doc>
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
<parameter name="num" transfer-ownership="none">
<doc xml:space="preserve">number of frames</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="set_frame_samples_max"
c:identifier="gst_audio_encoder_set_frame_samples_max">
<doc xml:space="preserve">Sets number of samples (per channel) subclass needs to be handed,
at most or will be handed all available if 0.
If an exact number of samples is required, gst_audio_encoder_set_frame_samples_min()
must be called with the same number.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioEncoder</doc>
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
<parameter name="num" transfer-ownership="none">
<doc xml:space="preserve">number of samples per frame</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="set_frame_samples_min"
c:identifier="gst_audio_encoder_set_frame_samples_min">
<doc xml:space="preserve">Sets number of samples (per channel) subclass needs to be handed,
at least or will be handed all available if 0.
If an exact number of samples is required, gst_audio_encoder_set_frame_samples_max()
must be called with the same number.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioEncoder</doc>
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
<parameter name="num" transfer-ownership="none">
<doc xml:space="preserve">number of samples per frame</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="set_hard_min"
c:identifier="gst_audio_encoder_set_hard_min">
<doc xml:space="preserve">Configures encoder hard minimum handling. If enabled, subclass
will never be handed less samples than it configured, which otherwise
might occur near end-of-data handling. Instead, the leftover samples
will simply be discarded.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioEncoder</doc>
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
<parameter name="enabled" transfer-ownership="none">
<doc xml:space="preserve">new state</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_hard_resync"
c:identifier="gst_audio_encoder_set_hard_resync">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
<parameter name="enabled" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_headers" c:identifier="gst_audio_encoder_set_headers">
<doc xml:space="preserve">Set the codec headers to be sent downstream whenever requested.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioEncoder</doc>
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
<parameter name="headers" transfer-ownership="full">
<doc xml:space="preserve">a list of
#GstBuffer containing the codec header</doc>
<type name="GLib.List" c:type="GList*">
<type name="Gst.Buffer"/>
</type>
</parameter>
</parameters>
</method>
<method name="set_latency" c:identifier="gst_audio_encoder_set_latency">
<doc xml:space="preserve">Sets encoder latency.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioEncoder</doc>
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
<parameter name="min" transfer-ownership="none">
<doc xml:space="preserve">minimum latency</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</parameter>
<parameter name="max" transfer-ownership="none">
<doc xml:space="preserve">maximum latency</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</parameter>
</parameters>
</method>
<method name="set_lookahead"
c:identifier="gst_audio_encoder_set_lookahead">
<doc xml:space="preserve">Sets encoder lookahead (in units of input rate samples)</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioEncoder</doc>
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
<parameter name="num" transfer-ownership="none">
<doc xml:space="preserve">lookahead</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="set_mark_granule"
c:identifier="gst_audio_encoder_set_mark_granule">
<doc xml:space="preserve">Enable or disable encoder granule handling.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioEncoder</doc>
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
<parameter name="enabled" transfer-ownership="none">
<doc xml:space="preserve">new state</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_output_format"
c:identifier="gst_audio_encoder_set_output_format">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
<parameter name="caps" transfer-ownership="none">
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
</parameters>
</method>
<method name="set_perfect_timestamp"
c:identifier="gst_audio_encoder_set_perfect_timestamp">
<doc xml:space="preserve">Enable or disable encoder perfect output timestamp preference.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioEncoder</doc>
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
<parameter name="enabled" transfer-ownership="none">
<doc xml:space="preserve">new state</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_tolerance"
c:identifier="gst_audio_encoder_set_tolerance">
<doc xml:space="preserve">Configures encoder audio jitter tolerance threshold.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioEncoder</doc>
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</instance-parameter>
<parameter name="tolerance" transfer-ownership="none">
<doc xml:space="preserve">new tolerance</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</parameter>
</parameters>
</method>
<property name="hard-resync" writable="1" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="mark-granule" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="perfect-timestamp"
writable="1"
transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="tolerance" writable="1" transfer-ownership="none">
<type name="gint64" c:type="gint64"/>
</property>
<field name="element">
<type name="Gst.Element" c:type="GstElement"/>
</field>
<field name="sinkpad">
<type name="Gst.Pad" c:type="GstPad*"/>
</field>
<field name="srcpad">
<type name="Gst.Pad" c:type="GstPad*"/>
</field>
<field name="stream_lock">
<type name="GLib.RecMutex" c:type="GRecMutex"/>
</field>
<field name="input_segment">
<type name="Gst.Segment" c:type="GstSegment"/>
</field>
<field name="output_segment">
<type name="Gst.Segment" c:type="GstSegment"/>
</field>
<field name="priv" readable="0" private="1">
<type name="AudioEncoderPrivate" c:type="GstAudioEncoderPrivate*"/>
</field>
<field name="_gst_reserved" readable="0" private="1">
<array zero-terminated="0" c:type="gpointer" fixed-size="20">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</class>
<record name="AudioEncoderClass"
c:type="GstAudioEncoderClass"
glib:is-gtype-struct-for="AudioEncoder">
<doc xml:space="preserve">Subclasses can override any of the available virtual methods or not, as
needed. At minimum @set_format and @handle_frame needs to be overridden.</doc>
<field name="element_class">
<doc xml:space="preserve">The parent class structure</doc>
<type name="Gst.ElementClass" c:type="GstElementClass"/>
</field>
<field name="start">
<callback name="start">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="enc" transfer-ownership="none">
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="stop">
<callback name="stop">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="enc" transfer-ownership="none">
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="set_format">
<callback name="set_format">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="enc" transfer-ownership="none">
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</parameter>
<parameter name="info" transfer-ownership="none">
<type name="AudioInfo" c:type="GstAudioInfo*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="handle_frame">
<callback name="handle_frame">
<return-value transfer-ownership="none">
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<parameter name="enc" transfer-ownership="none">
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</parameter>
<parameter name="buffer" transfer-ownership="none">
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="flush">
<callback name="flush">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="enc" transfer-ownership="none">
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="pre_push">
<callback name="pre_push">
<return-value transfer-ownership="none">
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<parameter name="enc" transfer-ownership="none">
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</parameter>
<parameter name="buffer" transfer-ownership="none">
<type name="Gst.Buffer" c:type="GstBuffer**"/>
</parameter>
</parameters>
</callback>
</field>
<field name="sink_event">
<callback name="sink_event">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="enc" transfer-ownership="none">
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</parameter>
<parameter name="event" transfer-ownership="none">
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="src_event">
<callback name="src_event">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="enc" transfer-ownership="none">
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</parameter>
<parameter name="event" transfer-ownership="none">
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="getcaps">
<callback name="getcaps">
<return-value transfer-ownership="full">
<type name="Gst.Caps" c:type="GstCaps*"/>
</return-value>
<parameters>
<parameter name="enc" transfer-ownership="none">
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</parameter>
<parameter name="filter" transfer-ownership="none">
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="open">
<callback name="open">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="enc" transfer-ownership="none">
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="close">
<callback name="close">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="enc" transfer-ownership="none">
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="negotiate">
<callback name="negotiate">
<return-value transfer-ownership="none">
<doc xml:space="preserve">#TRUE if the negotiation succeeded, else #FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="enc" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioEncoder</doc>
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="decide_allocation">
<callback name="decide_allocation">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="enc" transfer-ownership="none">
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</parameter>
<parameter name="query" transfer-ownership="none">
<type name="Gst.Query" c:type="GstQuery*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="propose_allocation">
<callback name="propose_allocation">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="enc" transfer-ownership="none">
<type name="AudioEncoder" c:type="GstAudioEncoder*"/>
</parameter>
<parameter name="query" transfer-ownership="none">
<type name="Gst.Query" c:type="GstQuery*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="_gst_reserved" readable="0" private="1">
<array zero-terminated="0" c:type="gpointer" fixed-size="20">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<record name="AudioEncoderPrivate"
c:type="GstAudioEncoderPrivate"
disguised="1">
</record>
<class name="AudioFilter"
c:symbol-prefix="audio_filter"
c:type="GstAudioFilter"
parent="GstBase.BaseTransform"
abstract="1"
glib:type-name="GstAudioFilter"
glib:get-type="gst_audio_filter_get_type"
glib:type-struct="AudioFilterClass">
<doc xml:space="preserve">#GstAudioFilter is a #GstBaseTransform<!-- -->-derived base class for simple audio
filters, ie. those that output the same format that they get as input.
#GstAudioFilter will parse the input format for you (with error checking)
before calling your setup function. Also, elements deriving from
#GstAudioFilter may use gst_audio_filter_class_add_pad_templates() from
their class_init function to easily configure the set of caps/formats that
the element is able to handle.
Derived classes should override the #GstAudioFilterClass.setup() and
#GstBaseTransformClass.transform_ip() and/or
#GstBaseTransformClass.transform()
virtual functions in their class_init function.</doc>
<virtual-method name="setup">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="filter" transfer-ownership="none">
<type name="AudioFilter" c:type="GstAudioFilter*"/>
</instance-parameter>
<parameter name="info" transfer-ownership="none">
<type name="AudioInfo" c:type="const GstAudioInfo*"/>
</parameter>
</parameters>
</virtual-method>
<field name="basetransform">
<type name="GstBase.BaseTransform" c:type="GstBaseTransform"/>
</field>
<field name="info">
<type name="AudioInfo" c:type="GstAudioInfo"/>
</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="AudioFilterClass"
c:type="GstAudioFilterClass"
glib:is-gtype-struct-for="AudioFilter">
<doc xml:space="preserve">In addition to the @setup virtual function, you should also override the
GstBaseTransform::transform and/or GstBaseTransform::transform_ip virtual
function.</doc>
<field name="basetransformclass">
<doc xml:space="preserve">parent class</doc>
<type name="GstBase.BaseTransformClass"
c:type="GstBaseTransformClass"/>
</field>
<field name="setup">
<callback name="setup">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="filter" transfer-ownership="none">
<type name="AudioFilter" c:type="GstAudioFilter*"/>
</parameter>
<parameter name="info" transfer-ownership="none">
<type name="AudioInfo" c:type="const GstAudioInfo*"/>
</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>
<method name="add_pad_templates"
c:identifier="gst_audio_filter_class_add_pad_templates">
<doc xml:space="preserve">Convenience function to add pad templates to this element class, with
@allowed_caps as the caps that can be handled.
This function is usually used from within a GObject class_init function.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="klass" transfer-ownership="none">
<doc xml:space="preserve">an #GstAudioFilterClass</doc>
<type name="AudioFilterClass" c:type="GstAudioFilterClass*"/>
</instance-parameter>
<parameter name="allowed_caps" transfer-ownership="none">
<doc xml:space="preserve">what formats the filter can handle, as #GstCaps</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
</parameters>
</method>
</record>
<bitfield name="AudioFlags"
glib:type-name="GstAudioFlags"
glib:get-type="gst_audio_flags_get_type"
c:type="GstAudioFlags">
<doc xml:space="preserve">Extra audio flags</doc>
<member name="none"
value="0"
c:identifier="GST_AUDIO_FLAG_NONE"
glib:nick="none">
<doc xml:space="preserve">no valid flag</doc>
</member>
<member name="unpositioned"
value="1"
c:identifier="GST_AUDIO_FLAG_UNPOSITIONED"
glib:nick="unpositioned">
<doc xml:space="preserve">the position array explicitly
contains unpositioned channels.</doc>
</member>
</bitfield>
<enumeration name="AudioFormat"
glib:type-name="GstAudioFormat"
glib:get-type="gst_audio_format_get_type"
c:type="GstAudioFormat">
<doc xml:space="preserve">Enum value describing the most common audio formats.</doc>
<member name="unknown"
value="0"
c:identifier="GST_AUDIO_FORMAT_UNKNOWN"
glib:nick="unknown">
<doc xml:space="preserve">unknown or unset audio format</doc>
</member>
<member name="encoded"
value="1"
c:identifier="GST_AUDIO_FORMAT_ENCODED"
glib:nick="encoded">
<doc xml:space="preserve">encoded audio format</doc>
</member>
<member name="s8"
value="2"
c:identifier="GST_AUDIO_FORMAT_S8"
glib:nick="s8">
<doc xml:space="preserve">8 bits in 8 bits, signed</doc>
</member>
<member name="u8"
value="3"
c:identifier="GST_AUDIO_FORMAT_U8"
glib:nick="u8">
<doc xml:space="preserve">8 bits in 8 bits, unsigned</doc>
</member>
<member name="s16le"
value="4"
c:identifier="GST_AUDIO_FORMAT_S16LE"
glib:nick="s16le">
<doc xml:space="preserve">16 bits in 16 bits, signed, little endian</doc>
</member>
<member name="s16be"
value="5"
c:identifier="GST_AUDIO_FORMAT_S16BE"
glib:nick="s16be">
<doc xml:space="preserve">16 bits in 16 bits, signed, big endian</doc>
</member>
<member name="u16le"
value="6"
c:identifier="GST_AUDIO_FORMAT_U16LE"
glib:nick="u16le">
<doc xml:space="preserve">16 bits in 16 bits, unsigned, little endian</doc>
</member>
<member name="u16be"
value="7"
c:identifier="GST_AUDIO_FORMAT_U16BE"
glib:nick="u16be">
<doc xml:space="preserve">16 bits in 16 bits, unsigned, big endian</doc>
</member>
<member name="s24_32le"
value="8"
c:identifier="GST_AUDIO_FORMAT_S24_32LE"
glib:nick="s24-32le">
<doc xml:space="preserve">24 bits in 32 bits, signed, little endian</doc>
</member>
<member name="s24_32be"
value="9"
c:identifier="GST_AUDIO_FORMAT_S24_32BE"
glib:nick="s24-32be">
<doc xml:space="preserve">24 bits in 32 bits, signed, big endian</doc>
</member>
<member name="u24_32le"
value="10"
c:identifier="GST_AUDIO_FORMAT_U24_32LE"
glib:nick="u24-32le">
<doc xml:space="preserve">24 bits in 32 bits, unsigned, little endian</doc>
</member>
<member name="u24_32be"
value="11"
c:identifier="GST_AUDIO_FORMAT_U24_32BE"
glib:nick="u24-32be">
<doc xml:space="preserve">24 bits in 32 bits, unsigned, big endian</doc>
</member>
<member name="s32le"
value="12"
c:identifier="GST_AUDIO_FORMAT_S32LE"
glib:nick="s32le">
<doc xml:space="preserve">32 bits in 32 bits, signed, little endian</doc>
</member>
<member name="s32be"
value="13"
c:identifier="GST_AUDIO_FORMAT_S32BE"
glib:nick="s32be">
<doc xml:space="preserve">32 bits in 32 bits, signed, big endian</doc>
</member>
<member name="u32le"
value="14"
c:identifier="GST_AUDIO_FORMAT_U32LE"
glib:nick="u32le">
<doc xml:space="preserve">32 bits in 32 bits, unsigned, little endian</doc>
</member>
<member name="u32be"
value="15"
c:identifier="GST_AUDIO_FORMAT_U32BE"
glib:nick="u32be">
<doc xml:space="preserve">32 bits in 32 bits, unsigned, big endian</doc>
</member>
<member name="s24le"
value="16"
c:identifier="GST_AUDIO_FORMAT_S24LE"
glib:nick="s24le">
<doc xml:space="preserve">24 bits in 24 bits, signed, little endian</doc>
</member>
<member name="s24be"
value="17"
c:identifier="GST_AUDIO_FORMAT_S24BE"
glib:nick="s24be">
<doc xml:space="preserve">24 bits in 24 bits, signed, big endian</doc>
</member>
<member name="u24le"
value="18"
c:identifier="GST_AUDIO_FORMAT_U24LE"
glib:nick="u24le">
<doc xml:space="preserve">24 bits in 24 bits, unsigned, little endian</doc>
</member>
<member name="u24be"
value="19"
c:identifier="GST_AUDIO_FORMAT_U24BE"
glib:nick="u24be">
<doc xml:space="preserve">24 bits in 24 bits, unsigned, big endian</doc>
</member>
<member name="s20le"
value="20"
c:identifier="GST_AUDIO_FORMAT_S20LE"
glib:nick="s20le">
<doc xml:space="preserve">20 bits in 24 bits, signed, little endian</doc>
</member>
<member name="s20be"
value="21"
c:identifier="GST_AUDIO_FORMAT_S20BE"
glib:nick="s20be">
<doc xml:space="preserve">20 bits in 24 bits, signed, big endian</doc>
</member>
<member name="u20le"
value="22"
c:identifier="GST_AUDIO_FORMAT_U20LE"
glib:nick="u20le">
<doc xml:space="preserve">20 bits in 24 bits, unsigned, little endian</doc>
</member>
<member name="u20be"
value="23"
c:identifier="GST_AUDIO_FORMAT_U20BE"
glib:nick="u20be">
<doc xml:space="preserve">20 bits in 24 bits, unsigned, big endian</doc>
</member>
<member name="s18le"
value="24"
c:identifier="GST_AUDIO_FORMAT_S18LE"
glib:nick="s18le">
<doc xml:space="preserve">18 bits in 24 bits, signed, little endian</doc>
</member>
<member name="s18be"
value="25"
c:identifier="GST_AUDIO_FORMAT_S18BE"
glib:nick="s18be">
<doc xml:space="preserve">18 bits in 24 bits, signed, big endian</doc>
</member>
<member name="u18le"
value="26"
c:identifier="GST_AUDIO_FORMAT_U18LE"
glib:nick="u18le">
<doc xml:space="preserve">18 bits in 24 bits, unsigned, little endian</doc>
</member>
<member name="u18be"
value="27"
c:identifier="GST_AUDIO_FORMAT_U18BE"
glib:nick="u18be">
<doc xml:space="preserve">18 bits in 24 bits, unsigned, big endian</doc>
</member>
<member name="f32le"
value="28"
c:identifier="GST_AUDIO_FORMAT_F32LE"
glib:nick="f32le">
<doc xml:space="preserve">32-bit floating point samples, little endian</doc>
</member>
<member name="f32be"
value="29"
c:identifier="GST_AUDIO_FORMAT_F32BE"
glib:nick="f32be">
<doc xml:space="preserve">32-bit floating point samples, big endian</doc>
</member>
<member name="f64le"
value="30"
c:identifier="GST_AUDIO_FORMAT_F64LE"
glib:nick="f64le">
<doc xml:space="preserve">64-bit floating point samples, little endian</doc>
</member>
<member name="f64be"
value="31"
c:identifier="GST_AUDIO_FORMAT_F64BE"
glib:nick="f64be">
<doc xml:space="preserve">64-bit floating point samples, big endian</doc>
</member>
<member name="s16"
value="4"
c:identifier="GST_AUDIO_FORMAT_S16"
glib:nick="s16">
<doc xml:space="preserve">16 bits in 16 bits, signed, native endianness</doc>
</member>
<member name="u16"
value="6"
c:identifier="GST_AUDIO_FORMAT_U16"
glib:nick="u16">
<doc xml:space="preserve">16 bits in 16 bits, unsigned, native endianness</doc>
</member>
<member name="s24_32"
value="8"
c:identifier="GST_AUDIO_FORMAT_S24_32"
glib:nick="s24-32">
<doc xml:space="preserve">24 bits in 32 bits, signed, native endianness</doc>
</member>
<member name="u24_32"
value="10"
c:identifier="GST_AUDIO_FORMAT_U24_32"
glib:nick="u24-32">
<doc xml:space="preserve">24 bits in 32 bits, unsigned, native endianness</doc>
</member>
<member name="s32"
value="12"
c:identifier="GST_AUDIO_FORMAT_S32"
glib:nick="s32">
<doc xml:space="preserve">32 bits in 32 bits, signed, native endianness</doc>
</member>
<member name="u32"
value="14"
c:identifier="GST_AUDIO_FORMAT_U32"
glib:nick="u32">
<doc xml:space="preserve">32 bits in 32 bits, unsigned, native endianness</doc>
</member>
<member name="s24"
value="16"
c:identifier="GST_AUDIO_FORMAT_S24"
glib:nick="s24">
<doc xml:space="preserve">24 bits in 24 bits, signed, native endianness</doc>
</member>
<member name="u24"
value="18"
c:identifier="GST_AUDIO_FORMAT_U24"
glib:nick="u24">
<doc xml:space="preserve">24 bits in 24 bits, unsigned, native endianness</doc>
</member>
<member name="s20"
value="20"
c:identifier="GST_AUDIO_FORMAT_S20"
glib:nick="s20">
<doc xml:space="preserve">20 bits in 24 bits, signed, native endianness</doc>
</member>
<member name="u20"
value="22"
c:identifier="GST_AUDIO_FORMAT_U20"
glib:nick="u20">
<doc xml:space="preserve">20 bits in 24 bits, unsigned, native endianness</doc>
</member>
<member name="s18"
value="24"
c:identifier="GST_AUDIO_FORMAT_S18"
glib:nick="s18">
<doc xml:space="preserve">18 bits in 24 bits, signed, native endianness</doc>
</member>
<member name="u18"
value="26"
c:identifier="GST_AUDIO_FORMAT_U18"
glib:nick="u18">
<doc xml:space="preserve">18 bits in 24 bits, unsigned, native endianness</doc>
</member>
<member name="f32"
value="28"
c:identifier="GST_AUDIO_FORMAT_F32"
glib:nick="f32">
<doc xml:space="preserve">32-bit floating point samples, native endianness</doc>
</member>
<member name="f64"
value="30"
c:identifier="GST_AUDIO_FORMAT_F64"
glib:nick="f64">
<doc xml:space="preserve">64-bit floating point samples, native endianness</doc>
</member>
<function name="build_integer"
c:identifier="gst_audio_format_build_integer">
<doc xml:space="preserve">Construct a #GstAudioFormat with given parameters.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioFormat or GST_AUDIO_FORMAT_UNKNOWN when no audio format
exists with the given parameters.</doc>
<type name="AudioFormat" c:type="GstAudioFormat"/>
</return-value>
<parameters>
<parameter name="sign" transfer-ownership="none">
<doc xml:space="preserve">signed or unsigned format</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
<parameter name="endianness" transfer-ownership="none">
<doc xml:space="preserve">G_LITTLE_ENDIAN or G_BIG_ENDIAN</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve">amount of bits used per sample</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="depth" transfer-ownership="none">
<doc xml:space="preserve">amount of used bits in @width</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</function>
<function name="fill_silence"
c:identifier="gst_audio_format_fill_silence">
<doc xml:space="preserve">Fill @length bytes in @dest with silence samples for @info.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioFormatInfo</doc>
<type name="AudioFormatInfo" c:type="const GstAudioFormatInfo*"/>
</parameter>
<parameter name="dest" transfer-ownership="none">
<doc xml:space="preserve">a destination
to fill</doc>
<array length="2" zero-terminated="0" c:type="gpointer">
<type name="guint8"/>
</array>
</parameter>
<parameter name="length" transfer-ownership="none">
<doc xml:space="preserve">the length to fill</doc>
<type name="gsize" c:type="gsize"/>
</parameter>
</parameters>
</function>
<function name="from_string" c:identifier="gst_audio_format_from_string">
<doc xml:space="preserve">Convert the @format string to its #GstAudioFormat.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioFormat for @format or GST_AUDIO_FORMAT_UNKNOWN when the
string is not a known format.</doc>
<type name="AudioFormat" c:type="GstAudioFormat"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">a format string</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="get_info" c:identifier="gst_audio_format_get_info">
<doc xml:space="preserve">Get the #GstAudioFormatInfo for @format</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The #GstAudioFormatInfo for @format.</doc>
<type name="AudioFormatInfo" c:type="const GstAudioFormatInfo*"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioFormat</doc>
<type name="AudioFormat" c:type="GstAudioFormat"/>
</parameter>
</parameters>
</function>
<function name="to_string" c:identifier="gst_audio_format_to_string">
<return-value transfer-ownership="none">
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<type name="AudioFormat" c:type="GstAudioFormat"/>
</parameter>
</parameters>
</function>
</enumeration>
<bitfield name="AudioFormatFlags"
glib:type-name="GstAudioFormatFlags"
glib:get-type="gst_audio_format_flags_get_type"
c:type="GstAudioFormatFlags">
<doc xml:space="preserve">The different audio flags that a format info can have.</doc>
<member name="integer"
value="1"
c:identifier="GST_AUDIO_FORMAT_FLAG_INTEGER"
glib:nick="integer">
<doc xml:space="preserve">integer samples</doc>
</member>
<member name="float"
value="2"
c:identifier="GST_AUDIO_FORMAT_FLAG_FLOAT"
glib:nick="float">
<doc xml:space="preserve">float samples</doc>
</member>
<member name="signed"
value="4"
c:identifier="GST_AUDIO_FORMAT_FLAG_SIGNED"
glib:nick="signed">
<doc xml:space="preserve">signed samples</doc>
</member>
<member name="complex"
value="16"
c:identifier="GST_AUDIO_FORMAT_FLAG_COMPLEX"
glib:nick="complex">
<doc xml:space="preserve">complex layout</doc>
</member>
<member name="unpack"
value="32"
c:identifier="GST_AUDIO_FORMAT_FLAG_UNPACK"
glib:nick="unpack">
<doc xml:space="preserve">the format can be used in
#GstAudioFormatUnpack and #GstAudioFormatPack functions</doc>
</member>
</bitfield>
<record name="AudioFormatInfo" c:type="GstAudioFormatInfo">
<doc xml:space="preserve">Information for an audio format.</doc>
<field name="format" writable="1">
<doc xml:space="preserve">#GstAudioFormat</doc>
<type name="AudioFormat" c:type="GstAudioFormat"/>
</field>
<field name="name" writable="1">
<doc xml:space="preserve">string representation of the format</doc>
<type name="utf8" c:type="const gchar*"/>
</field>
<field name="description" writable="1">
<doc xml:space="preserve">user readable description of the format</doc>
<type name="utf8" c:type="const gchar*"/>
</field>
<field name="flags" writable="1">
<doc xml:space="preserve">#GstAudioFormatFlags</doc>
<type name="AudioFormatFlags" c:type="GstAudioFormatFlags"/>
</field>
<field name="endianness" writable="1">
<doc xml:space="preserve">the endianness</doc>
<type name="gint" c:type="gint"/>
</field>
<field name="width" writable="1">
<doc xml:space="preserve">amount of bits used for one sample</doc>
<type name="gint" c:type="gint"/>
</field>
<field name="depth" writable="1">
<doc xml:space="preserve">amount of valid bits in @width</doc>
<type name="gint" c:type="gint"/>
</field>
<field name="silence" writable="1">
<doc xml:space="preserve">@width/8 bytes with 1 silent sample</doc>
<array zero-terminated="0" c:type="guint8" fixed-size="8">
<type name="guint8" c:type="guint8"/>
</array>
</field>
<field name="unpack_format" writable="1">
<doc xml:space="preserve">the format of the unpacked samples</doc>
<type name="AudioFormat" c:type="GstAudioFormat"/>
</field>
<field name="unpack_func" writable="1">
<doc xml:space="preserve">function to unpack samples</doc>
<type name="AudioFormatUnpack" c:type="GstAudioFormatUnpack"/>
</field>
<field name="pack_func" writable="1">
<doc xml:space="preserve">function to pack samples</doc>
<type name="AudioFormatPack" c:type="GstAudioFormatPack"/>
</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>
<callback name="AudioFormatPack" c:type="GstAudioFormatPack">
<doc xml:space="preserve">Packs @length samples from @src to the data array in format @info.
The samples from source have each channel interleaved
and will be packed into @data.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioFormatInfo</doc>
<type name="AudioFormatInfo" c:type="const GstAudioFormatInfo*"/>
</parameter>
<parameter name="flags" transfer-ownership="none">
<type name="AudioPackFlags" c:type="GstAudioPackFlags"/>
</parameter>
<parameter name="src" transfer-ownership="none">
<doc xml:space="preserve">a source array</doc>
<array zero-terminated="0" c:type="gpointer">
<type name="guint8"/>
</array>
</parameter>
<parameter name="data" transfer-ownership="none">
<doc xml:space="preserve">pointer to the destination
data</doc>
<array zero-terminated="0" c:type="gpointer">
<type name="guint8"/>
</array>
</parameter>
<parameter name="length" transfer-ownership="none">
<doc xml:space="preserve">the amount of samples to pack.</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</callback>
<callback name="AudioFormatUnpack" c:type="GstAudioFormatUnpack">
<doc xml:space="preserve">Unpacks @length samples from the given data of format @info.
The samples will be unpacked into @dest which each channel
interleaved. @dest should at least be big enough to hold @length *
channels * size(unpack_format) bytes.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioFormatInfo</doc>
<type name="AudioFormatInfo" c:type="const GstAudioFormatInfo*"/>
</parameter>
<parameter name="flags" transfer-ownership="none">
<type name="AudioPackFlags" c:type="GstAudioPackFlags"/>
</parameter>
<parameter name="dest" transfer-ownership="none">
<doc xml:space="preserve">a destination array</doc>
<array zero-terminated="0" c:type="gpointer">
<type name="guint8"/>
</array>
</parameter>
<parameter name="data" transfer-ownership="none">
<doc xml:space="preserve">pointer to the audio data</doc>
<array zero-terminated="0" c:type="gpointer">
<type name="guint8"/>
</array>
</parameter>
<parameter name="length" transfer-ownership="none">
<doc xml:space="preserve">the amount of samples to unpack.</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</callback>
<record name="AudioInfo"
c:type="GstAudioInfo"
glib:type-name="GstAudioInfo"
glib:get-type="gst_audio_info_get_type"
c:symbol-prefix="audio_info">
<doc xml:space="preserve">Information describing audio properties. This information can be filled
in from GstCaps with gst_audio_info_from_caps().
Use the provided macros to access the info in this structure.</doc>
<field name="finfo" writable="1">
<doc xml:space="preserve">the format info of the audio</doc>
<type name="AudioFormatInfo" c:type="const GstAudioFormatInfo*"/>
</field>
<field name="flags" writable="1">
<doc xml:space="preserve">additional audio flags</doc>
<type name="AudioFlags" c:type="GstAudioFlags"/>
</field>
<field name="layout" writable="1">
<doc xml:space="preserve">audio layout</doc>
<type name="AudioLayout" c:type="GstAudioLayout"/>
</field>
<field name="rate" writable="1">
<doc xml:space="preserve">the audio sample rate</doc>
<type name="gint" c:type="gint"/>
</field>
<field name="channels" writable="1">
<doc xml:space="preserve">the number of channels</doc>
<type name="gint" c:type="gint"/>
</field>
<field name="bpf" writable="1">
<doc xml:space="preserve">the number of bytes for one frame, this is the size of one
sample * @channels</doc>
<type name="gint" c:type="gint"/>
</field>
<field name="position" writable="1">
<doc xml:space="preserve">the positions for each channel</doc>
<array zero-terminated="0"
c:type="GstAudioChannelPosition"
fixed-size="64">
<type name="AudioChannelPosition" c:type="GstAudioChannelPosition"/>
</array>
</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>
<constructor name="new" c:identifier="gst_audio_info_new">
<doc xml:space="preserve">Allocate a new #GstAudioInfo that is also initialized with
gst_audio_info_init().</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new #GstAudioInfo. free with gst_audio_info_free().</doc>
<type name="AudioInfo" c:type="GstAudioInfo*"/>
</return-value>
</constructor>
<method name="convert" c:identifier="gst_audio_info_convert">
<doc xml:space="preserve">Converts among various #GstFormat types. This function handles
GST_FORMAT_BYTES, GST_FORMAT_TIME, and GST_FORMAT_DEFAULT. For
raw audio, GST_FORMAT_DEFAULT corresponds to audio frames. This
function can be used to handle pad queries of the type GST_QUERY_CONVERT.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the conversion was successful.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioInfo</doc>
<type name="AudioInfo" c:type="const GstAudioInfo*"/>
</instance-parameter>
<parameter name="src_fmt" transfer-ownership="none">
<doc xml:space="preserve">#GstFormat of the @src_val</doc>
<type name="Gst.Format" c:type="GstFormat"/>
</parameter>
<parameter name="src_val" transfer-ownership="none">
<doc xml:space="preserve">value to convert</doc>
<type name="gint64" c:type="gint64"/>
</parameter>
<parameter name="dest_fmt" transfer-ownership="none">
<doc xml:space="preserve">#GstFormat of the @dest_val</doc>
<type name="Gst.Format" c:type="GstFormat"/>
</parameter>
<parameter name="dest_val" transfer-ownership="none">
<doc xml:space="preserve">pointer to destination value</doc>
<type name="gint64" c:type="gint64*"/>
</parameter>
</parameters>
</method>
<method name="copy" c:identifier="gst_audio_info_copy">
<doc xml:space="preserve">Copy a GstAudioInfo structure.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new #GstAudioInfo. free with gst_audio_info_free.</doc>
<type name="AudioInfo" c:type="GstAudioInfo*"/>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioInfo</doc>
<type name="AudioInfo" c:type="const GstAudioInfo*"/>
</instance-parameter>
</parameters>
</method>
<method name="free" c:identifier="gst_audio_info_free">
<doc xml:space="preserve">Free a GstAudioInfo structure previously allocated with gst_audio_info_new()
or gst_audio_info_copy().</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioInfo</doc>
<type name="AudioInfo" c:type="GstAudioInfo*"/>
</instance-parameter>
</parameters>
</method>
<method name="from_caps" c:identifier="gst_audio_info_from_caps">
<doc xml:space="preserve">Parse @caps and update @info.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if @caps could be parsed</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioInfo</doc>
<type name="AudioInfo" c:type="GstAudioInfo*"/>
</instance-parameter>
<parameter name="caps" transfer-ownership="none">
<doc xml:space="preserve">a #GstCaps</doc>
<type name="Gst.Caps" c:type="const GstCaps*"/>
</parameter>
</parameters>
</method>
<method name="init" c:identifier="gst_audio_info_init">
<doc xml:space="preserve">Initialize @info with default values.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioInfo</doc>
<type name="AudioInfo" c:type="GstAudioInfo*"/>
</instance-parameter>
</parameters>
</method>
<method name="is_equal"
c:identifier="gst_audio_info_is_equal"
version="1.2">
<doc xml:space="preserve">Compares two #GstAudioInfo and returns whether they are equal or not</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @info and @other are equal, else %FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioInfo</doc>
<type name="AudioInfo" c:type="const GstAudioInfo*"/>
</instance-parameter>
<parameter name="other" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioInfo</doc>
<type name="AudioInfo" c:type="const GstAudioInfo*"/>
</parameter>
</parameters>
</method>
<method name="set_format" c:identifier="gst_audio_info_set_format">
<doc xml:space="preserve">Set the default info for the audio info of @format and @rate and @channels.
Note: This initializes @info first, no values are preserved.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioInfo</doc>
<type name="AudioInfo" c:type="GstAudioInfo*"/>
</instance-parameter>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">the format</doc>
<type name="AudioFormat" c:type="GstAudioFormat"/>
</parameter>
<parameter name="rate" transfer-ownership="none">
<doc xml:space="preserve">the samplerate</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="channels" transfer-ownership="none">
<doc xml:space="preserve">the number of channels</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="position" transfer-ownership="none">
<doc xml:space="preserve">the channel positions</doc>
<type name="AudioChannelPosition"
c:type="const GstAudioChannelPosition*"/>
</parameter>
</parameters>
</method>
<method name="to_caps" c:identifier="gst_audio_info_to_caps">
<doc xml:space="preserve">Convert the values of @info into a #GstCaps.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the new #GstCaps containing the
info of @info.</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioInfo</doc>
<type name="AudioInfo" c:type="const GstAudioInfo*"/>
</instance-parameter>
</parameters>
</method>
</record>
<enumeration name="AudioLayout"
glib:type-name="GstAudioLayout"
glib:get-type="gst_audio_layout_get_type"
c:type="GstAudioLayout">
<doc xml:space="preserve">Layout of the audio samples for the different channels.</doc>
<member name="interleaved"
value="0"
c:identifier="GST_AUDIO_LAYOUT_INTERLEAVED"
glib:nick="interleaved">
<doc xml:space="preserve">interleaved audio</doc>
</member>
<member name="non_interleaved"
value="1"
c:identifier="GST_AUDIO_LAYOUT_NON_INTERLEAVED"
glib:nick="non-interleaved">
<doc xml:space="preserve">non-interleaved audio</doc>
</member>
</enumeration>
<enumeration name="AudioPackFlags"
glib:type-name="GstAudioPackFlags"
glib:get-type="gst_audio_pack_flags_get_type"
c:type="GstAudioPackFlags">
<doc xml:space="preserve">The different flags that can be used when packing and unpacking.</doc>
<member name="none"
value="0"
c:identifier="GST_AUDIO_PACK_FLAG_NONE"
glib:nick="none">
<doc xml:space="preserve">No flag</doc>
</member>
</enumeration>
<class name="AudioRingBuffer"
c:symbol-prefix="audio_ring_buffer"
c:type="GstAudioRingBuffer"
parent="Gst.Object"
abstract="1"
glib:type-name="GstAudioRingBuffer"
glib:get-type="gst_audio_ring_buffer_get_type"
glib:type-struct="AudioRingBufferClass">
<doc xml:space="preserve"><refsect2>
<para>
This object is the base class for audio ringbuffers used by the base
audio source and sink classes.
</para>
<para>
The ringbuffer abstracts a circular buffer of data. One reader and
one writer can operate on the data from different threads in a lockfree
manner. The base class is sufficiently flexible to be used as an
abstraction for DMA based ringbuffers as well as a pure software
implementations.
</para>
</refsect2></doc>
<function name="debug_spec_buff"
c:identifier="gst_audio_ring_buffer_debug_spec_buff">
<doc xml:space="preserve">Print debug info about the buffer sized in @spec to the debug log.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="spec" transfer-ownership="none">
<doc xml:space="preserve">the spec to debug</doc>
<type name="AudioRingBufferSpec" c:type="GstAudioRingBufferSpec*"/>
</parameter>
</parameters>
</function>
<function name="debug_spec_caps"
c:identifier="gst_audio_ring_buffer_debug_spec_caps">
<doc xml:space="preserve">Print debug info about the parsed caps in @spec to the debug log.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="spec" transfer-ownership="none">
<doc xml:space="preserve">the spec to debug</doc>
<type name="AudioRingBufferSpec" c:type="GstAudioRingBufferSpec*"/>
</parameter>
</parameters>
</function>
<function name="parse_caps"
c:identifier="gst_audio_ring_buffer_parse_caps">
<doc xml:space="preserve">Parse @caps into @spec.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the caps could be parsed.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="spec" transfer-ownership="none">
<doc xml:space="preserve">a spec</doc>
<type name="AudioRingBufferSpec" c:type="GstAudioRingBufferSpec*"/>
</parameter>
<parameter name="caps" transfer-ownership="none">
<doc xml:space="preserve">a #GstCaps</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
</parameters>
</function>
<virtual-method name="acquire" invoker="acquire">
<doc xml:space="preserve">Allocate the resources for the ringbuffer. This function fills
in the data pointer of the ring buffer with a valid #GstBuffer
to which samples can be written.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the device could be acquired, FALSE on error.
MT safe.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer to acquire</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</instance-parameter>
<parameter name="spec" transfer-ownership="none">
<doc xml:space="preserve">the specs of the buffer</doc>
<type name="AudioRingBufferSpec" c:type="GstAudioRingBufferSpec*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="activate" invoker="activate">
<doc xml:space="preserve">Activate @buf to start or stop pulling data.
MT safe.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the device could be activated in the requested mode,
FALSE on error.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer to activate</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</instance-parameter>
<parameter name="active" transfer-ownership="none">
<doc xml:space="preserve">the new mode</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="clear_all" invoker="clear_all">
<doc xml:space="preserve">Fill the ringbuffer with silence.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer to clear</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="close_device" invoker="close_device">
<doc xml:space="preserve">Close the audio device associated with the ring buffer. The ring buffer
should already have been released via gst_audio_ring_buffer_release().</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the device could be closed, FALSE on error.
MT safe.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="commit" invoker="commit">
<doc xml:space="preserve">Commit @in_samples samples pointed to by @data to the ringbuffer @buf.
@in_samples and @out_samples define the rate conversion to perform on the
samples in @data. For negative rates, @out_samples must be negative and
@in_samples positive.
When @out_samples is positive, the first sample will be written at position @sample
in the ringbuffer. When @out_samples is negative, the last sample will be written to
@sample in reverse order.
@out_samples does not need to be a multiple of the segment size of the ringbuffer
although it is recommended for optimal performance.
@accum will hold a temporary accumulator used in rate conversion and should be
set to 0 when this function is first called. In case the commit operation is
interrupted, one can resume the processing by passing the previously returned
@accum value back to this function.
MT safe.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The number of samples written to the ringbuffer or -1 on error. The
number of samples written can be less than @out_samples when @buf was interrupted
with a flush or stop.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer to commit</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</instance-parameter>
<parameter name="sample" transfer-ownership="none">
<doc xml:space="preserve">the sample position of the data</doc>
<type name="guint64" c:type="guint64*"/>
</parameter>
<parameter name="data" transfer-ownership="none">
<doc xml:space="preserve">the data to commit</doc>
<type name="guint8" c:type="guint8*"/>
</parameter>
<parameter name="in_samples" transfer-ownership="none">
<doc xml:space="preserve">the number of samples in the data to commit</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="out_samples" transfer-ownership="none">
<doc xml:space="preserve">the number of samples to write to the ringbuffer</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="accum" transfer-ownership="none">
<doc xml:space="preserve">accumulator for rate conversion.</doc>
<type name="gint" c:type="gint*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="delay" invoker="delay">
<doc xml:space="preserve">Get the number of samples queued in the audio device. This is
usually less than the segment size but can be bigger when the
implementation uses another internal buffer between the audio
device.
For playback ringbuffers this is the amount of samples transfered from the
ringbuffer to the device but still not played.
For capture ringbuffers this is the amount of samples in the device that are
not yet transfered to the ringbuffer.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The number of samples queued in the audio device.
MT safe.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer to query</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="open_device" invoker="open_device">
<doc xml:space="preserve">Open the audio device associated with the ring buffer. Does not perform any
setup on the device. You must open the device before acquiring the ring
buffer.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the device could be opened, FALSE on error.
MT safe.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="pause" invoker="pause">
<doc xml:space="preserve">Pause processing samples from the ringbuffer.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the device could be paused, FALSE on error.
MT safe.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer to pause</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="release" invoker="release">
<doc xml:space="preserve">Free the resources of the ringbuffer.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the device could be released, FALSE on error.
MT safe.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer to release</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="resume">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="buf" transfer-ownership="none">
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="start" invoker="start">
<doc xml:space="preserve">Start processing samples from the ringbuffer.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the device could be started, FALSE on error.
MT safe.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer to start</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="stop" invoker="stop">
<doc xml:space="preserve">Stop processing samples from the ringbuffer.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the device could be stopped, FALSE on error.
MT safe.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer to stop</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</instance-parameter>
</parameters>
</virtual-method>
<method name="acquire" c:identifier="gst_audio_ring_buffer_acquire">
<doc xml:space="preserve">Allocate the resources for the ringbuffer. This function fills
in the data pointer of the ring buffer with a valid #GstBuffer
to which samples can be written.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the device could be acquired, FALSE on error.
MT safe.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer to acquire</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</instance-parameter>
<parameter name="spec" transfer-ownership="none">
<doc xml:space="preserve">the specs of the buffer</doc>
<type name="AudioRingBufferSpec" c:type="GstAudioRingBufferSpec*"/>
</parameter>
</parameters>
</method>
<method name="activate" c:identifier="gst_audio_ring_buffer_activate">
<doc xml:space="preserve">Activate @buf to start or stop pulling data.
MT safe.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the device could be activated in the requested mode,
FALSE on error.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer to activate</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</instance-parameter>
<parameter name="active" transfer-ownership="none">
<doc xml:space="preserve">the new mode</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="advance" c:identifier="gst_audio_ring_buffer_advance">
<doc xml:space="preserve">Subclasses should call this function to notify the fact that
@advance segments are now processed by the device.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer to advance</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</instance-parameter>
<parameter name="advance" transfer-ownership="none">
<doc xml:space="preserve">the number of segments written</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="clear" c:identifier="gst_audio_ring_buffer_clear">
<doc xml:space="preserve">Clear the given segment of the buffer with silence samples.
This function is used by subclasses.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer to clear</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</instance-parameter>
<parameter name="segment" transfer-ownership="none">
<doc xml:space="preserve">the segment to clear</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="clear_all" c:identifier="gst_audio_ring_buffer_clear_all">
<doc xml:space="preserve">Fill the ringbuffer with silence.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer to clear</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</instance-parameter>
</parameters>
</method>
<method name="close_device"
c:identifier="gst_audio_ring_buffer_close_device">
<doc xml:space="preserve">Close the audio device associated with the ring buffer. The ring buffer
should already have been released via gst_audio_ring_buffer_release().</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the device could be closed, FALSE on error.
MT safe.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</instance-parameter>
</parameters>
</method>
<method name="commit" c:identifier="gst_audio_ring_buffer_commit">
<doc xml:space="preserve">Commit @in_samples samples pointed to by @data to the ringbuffer @buf.
@in_samples and @out_samples define the rate conversion to perform on the
samples in @data. For negative rates, @out_samples must be negative and
@in_samples positive.
When @out_samples is positive, the first sample will be written at position @sample
in the ringbuffer. When @out_samples is negative, the last sample will be written to
@sample in reverse order.
@out_samples does not need to be a multiple of the segment size of the ringbuffer
although it is recommended for optimal performance.
@accum will hold a temporary accumulator used in rate conversion and should be
set to 0 when this function is first called. In case the commit operation is
interrupted, one can resume the processing by passing the previously returned
@accum value back to this function.
MT safe.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The number of samples written to the ringbuffer or -1 on error. The
number of samples written can be less than @out_samples when @buf was interrupted
with a flush or stop.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer to commit</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</instance-parameter>
<parameter name="sample" transfer-ownership="none">
<doc xml:space="preserve">the sample position of the data</doc>
<type name="guint64" c:type="guint64*"/>
</parameter>
<parameter name="data" transfer-ownership="none">
<doc xml:space="preserve">the data to commit</doc>
<type name="guint8" c:type="guint8*"/>
</parameter>
<parameter name="in_samples" transfer-ownership="none">
<doc xml:space="preserve">the number of samples in the data to commit</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="out_samples" transfer-ownership="none">
<doc xml:space="preserve">the number of samples to write to the ringbuffer</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="accum" transfer-ownership="none">
<doc xml:space="preserve">accumulator for rate conversion.</doc>
<type name="gint" c:type="gint*"/>
</parameter>
</parameters>
</method>
<method name="convert" c:identifier="gst_audio_ring_buffer_convert">
<doc xml:space="preserve">Convert @src_val in @src_fmt to the equivalent value in @dest_fmt. The result
will be put in @dest_val.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the conversion succeeded.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</instance-parameter>
<parameter name="src_fmt" transfer-ownership="none">
<doc xml:space="preserve">the source format</doc>
<type name="Gst.Format" c:type="GstFormat"/>
</parameter>
<parameter name="src_val" transfer-ownership="none">
<doc xml:space="preserve">the source value</doc>
<type name="gint64" c:type="gint64"/>
</parameter>
<parameter name="dest_fmt" transfer-ownership="none">
<doc xml:space="preserve">the destination format</doc>
<type name="Gst.Format" c:type="GstFormat"/>
</parameter>
<parameter name="dest_val" transfer-ownership="none">
<doc xml:space="preserve">a location to store the converted value</doc>
<type name="gint64" c:type="gint64*"/>
</parameter>
</parameters>
</method>
<method name="delay" c:identifier="gst_audio_ring_buffer_delay">
<doc xml:space="preserve">Get the number of samples queued in the audio device. This is
usually less than the segment size but can be bigger when the
implementation uses another internal buffer between the audio
device.
For playback ringbuffers this is the amount of samples transfered from the
ringbuffer to the device but still not played.
For capture ringbuffers this is the amount of samples in the device that are
not yet transfered to the ringbuffer.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The number of samples queued in the audio device.
MT safe.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer to query</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</instance-parameter>
</parameters>
</method>
<method name="device_is_open"
c:identifier="gst_audio_ring_buffer_device_is_open">
<doc xml:space="preserve">Checks the status of the device associated with the ring buffer.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the device was open, FALSE if it was closed.
MT safe.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</instance-parameter>
</parameters>
</method>
<method name="is_acquired"
c:identifier="gst_audio_ring_buffer_is_acquired">
<doc xml:space="preserve">Check if the ringbuffer is acquired and ready to use.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the ringbuffer is acquired, FALSE on error.
MT safe.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer to check</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</instance-parameter>
</parameters>
</method>
<method name="is_active" c:identifier="gst_audio_ring_buffer_is_active">
<doc xml:space="preserve">Check if @buf is activated.
MT safe.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the device is active.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</instance-parameter>
</parameters>
</method>
<method name="is_flushing"
c:identifier="gst_audio_ring_buffer_is_flushing">
<doc xml:space="preserve">Check if @buf is flushing.
MT safe.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the device is flushing.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</instance-parameter>
</parameters>
</method>
<method name="may_start" c:identifier="gst_audio_ring_buffer_may_start">
<doc xml:space="preserve">Tell the ringbuffer that it is allowed to start playback when
the ringbuffer is filled with samples.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</instance-parameter>
<parameter name="allowed" transfer-ownership="none">
<doc xml:space="preserve">the new value</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="open_device"
c:identifier="gst_audio_ring_buffer_open_device">
<doc xml:space="preserve">Open the audio device associated with the ring buffer. Does not perform any
setup on the device. You must open the device before acquiring the ring
buffer.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the device could be opened, FALSE on error.
MT safe.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</instance-parameter>
</parameters>
</method>
<method name="pause" c:identifier="gst_audio_ring_buffer_pause">
<doc xml:space="preserve">Pause processing samples from the ringbuffer.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the device could be paused, FALSE on error.
MT safe.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer to pause</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</instance-parameter>
</parameters>
</method>
<method name="prepare_read"
c:identifier="gst_audio_ring_buffer_prepare_read">
<doc xml:space="preserve">Returns a pointer to memory where the data from segment @segment
can be found. This function is mostly used by subclasses.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">FALSE if the buffer is not started.
MT safe.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer to read from</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</instance-parameter>
<parameter name="segment" transfer-ownership="none">
<doc xml:space="preserve">the segment to read</doc>
<type name="gint" c:type="gint*"/>
</parameter>
<parameter name="readptr" transfer-ownership="none">
<doc xml:space="preserve">the pointer to the memory where samples can be read</doc>
<type name="guint8" c:type="guint8**"/>
</parameter>
<parameter name="len" transfer-ownership="none">
<doc xml:space="preserve">the number of bytes to read</doc>
<type name="gint" c:type="gint*"/>
</parameter>
</parameters>
</method>
<method name="read" c:identifier="gst_audio_ring_buffer_read">
<doc xml:space="preserve">Read @len samples from the ringbuffer into the memory pointed
to by @data.
The first sample should be read from position @sample in
the ringbuffer.
@len should not be a multiple of the segment size of the ringbuffer
although it is recommended.
@timestamp will return the timestamp associated with the data returned.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The number of samples read from the ringbuffer or -1 on
error.
MT safe.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer to read from</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</instance-parameter>
<parameter name="sample" transfer-ownership="none">
<doc xml:space="preserve">the sample position of the data</doc>
<type name="guint64" c:type="guint64"/>
</parameter>
<parameter name="data" transfer-ownership="none">
<doc xml:space="preserve">where the data should be read</doc>
<type name="guint8" c:type="guint8*"/>
</parameter>
<parameter name="len" transfer-ownership="none">
<doc xml:space="preserve">the number of samples in data to read</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="timestamp" transfer-ownership="none">
<doc xml:space="preserve">where the timestamp is returned</doc>
<type name="Gst.ClockTime" c:type="GstClockTime*"/>
</parameter>
</parameters>
</method>
<method name="release" c:identifier="gst_audio_ring_buffer_release">
<doc xml:space="preserve">Free the resources of the ringbuffer.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the device could be released, FALSE on error.
MT safe.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer to release</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</instance-parameter>
</parameters>
</method>
<method name="samples_done"
c:identifier="gst_audio_ring_buffer_samples_done">
<doc xml:space="preserve">Get the number of samples that were processed by the ringbuffer
since it was last started. This does not include the number of samples not
yet processed (see gst_audio_ring_buffer_delay()).</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The number of samples processed by the ringbuffer.
MT safe.</doc>
<type name="guint64" c:type="guint64"/>
</return-value>
<parameters>
<instance-parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer to query</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_callback"
c:identifier="gst_audio_ring_buffer_set_callback">
<doc xml:space="preserve">Sets the given callback function on the buffer. This function
will be called every time a segment has been written to a device.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer to set the callback on</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</instance-parameter>
<parameter name="cb"
transfer-ownership="none"
scope="async"
closure="1">
<doc xml:space="preserve">the callback to set</doc>
<type name="AudioRingBufferCallback"
c:type="GstAudioRingBufferCallback"/>
</parameter>
<parameter name="user_data" transfer-ownership="none">
<doc xml:space="preserve">user data passed to the callback</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</method>
<method name="set_channel_positions"
c:identifier="gst_audio_ring_buffer_set_channel_positions">
<doc xml:space="preserve">Tell the ringbuffer about the device's channel positions. This must
be called in when the ringbuffer is acquired.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</instance-parameter>
<parameter name="position" transfer-ownership="none">
<doc xml:space="preserve">the device channel positions</doc>
<type name="AudioChannelPosition"
c:type="const GstAudioChannelPosition*"/>
</parameter>
</parameters>
</method>
<method name="set_flushing"
c:identifier="gst_audio_ring_buffer_set_flushing">
<doc xml:space="preserve">Set the ringbuffer to flushing mode or normal mode.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer to flush</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</instance-parameter>
<parameter name="flushing" transfer-ownership="none">
<doc xml:space="preserve">the new mode</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_sample"
c:identifier="gst_audio_ring_buffer_set_sample">
<doc xml:space="preserve">Make sure that the next sample written to the device is
accounted for as being the @sample sample written to the
device. This value will be used in reporting the current
sample position of the ringbuffer.
This function will also clear the buffer with silence.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer to use</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</instance-parameter>
<parameter name="sample" transfer-ownership="none">
<doc xml:space="preserve">the sample number to set</doc>
<type name="guint64" c:type="guint64"/>
</parameter>
</parameters>
</method>
<method name="set_timestamp"
c:identifier="gst_audio_ring_buffer_set_timestamp">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="buf" transfer-ownership="none">
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</instance-parameter>
<parameter name="readseg" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="timestamp" transfer-ownership="none">
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</parameter>
</parameters>
</method>
<method name="start" c:identifier="gst_audio_ring_buffer_start">
<doc xml:space="preserve">Start processing samples from the ringbuffer.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the device could be started, FALSE on error.
MT safe.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer to start</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</instance-parameter>
</parameters>
</method>
<method name="stop" c:identifier="gst_audio_ring_buffer_stop">
<doc xml:space="preserve">Stop processing samples from the ringbuffer.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the device could be stopped, FALSE on error.
MT safe.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer to stop</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</instance-parameter>
</parameters>
</method>
<field name="object">
<type name="Gst.Object" c:type="GstObject"/>
</field>
<field name="cond">
<doc xml:space="preserve">used to signal start/stop/pause/resume actions</doc>
<type name="GLib.Cond" c:type="GCond"/>
</field>
<field name="open">
<doc xml:space="preserve">boolean indicating that the ringbuffer is open</doc>
<type name="gboolean" c:type="gboolean"/>
</field>
<field name="acquired">
<doc xml:space="preserve">boolean indicating that the ringbuffer is acquired</doc>
<type name="gboolean" c:type="gboolean"/>
</field>
<field name="memory">
<doc xml:space="preserve">data in the ringbuffer</doc>
<type name="guint8" c:type="guint8*"/>
</field>
<field name="size">
<doc xml:space="preserve">size of data in the ringbuffer</doc>
<type name="gsize" c:type="gsize"/>
</field>
<field name="timestamps">
<type name="Gst.ClockTime" c:type="GstClockTime*"/>
</field>
<field name="spec">
<doc xml:space="preserve">format and layout of the ringbuffer data</doc>
<type name="AudioRingBufferSpec" c:type="GstAudioRingBufferSpec"/>
</field>
<field name="samples_per_seg">
<doc xml:space="preserve">number of samples in one segment</doc>
<type name="gint" c:type="gint"/>
</field>
<field name="empty_seg">
<doc xml:space="preserve">pointer to memory holding one segment of silence samples</doc>
<type name="guint8" c:type="guint8*"/>
</field>
<field name="state">
<doc xml:space="preserve">state of the buffer</doc>
<type name="gint" c:type="gint"/>
</field>
<field name="segdone">
<doc xml:space="preserve">readpointer in the ringbuffer</doc>
<type name="gint" c:type="gint"/>
</field>
<field name="segbase">
<doc xml:space="preserve">segment corresponding to segment 0 (unused)</doc>
<type name="gint" c:type="gint"/>
</field>
<field name="waiting">
<doc xml:space="preserve">is a reader or writer waiting for a free segment</doc>
<type name="gint" c:type="gint"/>
</field>
<field name="callback" readable="0" private="1">
<type name="AudioRingBufferCallback"
c:type="GstAudioRingBufferCallback"/>
</field>
<field name="cb_data" readable="0" private="1">
<type name="gpointer" c:type="gpointer"/>
</field>
<field name="need_reorder" readable="0" private="1">
<type name="gboolean" c:type="gboolean"/>
</field>
<field name="channel_reorder_map" readable="0" private="1">
<array zero-terminated="0" c:type="gint" fixed-size="64">
<type name="gint" c:type="gint"/>
</array>
</field>
<field name="flushing" readable="0" private="1">
<type name="gboolean" c:type="gboolean"/>
</field>
<field name="may_start" readable="0" private="1">
<type name="gint" c:type="gint"/>
</field>
<field name="active" readable="0" private="1">
<type name="gboolean" c:type="gboolean"/>
</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>
<callback name="AudioRingBufferCallback"
c:type="GstAudioRingBufferCallback">
<doc xml:space="preserve">This function is set with gst_audio_ring_buffer_set_callback() and is
called to fill the memory at @data with @len bytes of samples.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="rbuf" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioRingBuffer</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</parameter>
<parameter name="data" transfer-ownership="none">
<doc xml:space="preserve">target to fill</doc>
<array length="2" zero-terminated="0" c:type="guint8*">
<type name="guint8" c:type="guint8"/>
</array>
</parameter>
<parameter name="len" transfer-ownership="none">
<doc xml:space="preserve">amount to fill</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="user_data" transfer-ownership="none" closure="3">
<doc xml:space="preserve">user data</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
<record name="AudioRingBufferClass"
c:type="GstAudioRingBufferClass"
glib:is-gtype-struct-for="AudioRingBuffer">
<doc xml:space="preserve">The vmethods that subclasses can override to implement the ringbuffer.</doc>
<field name="parent_class">
<doc xml:space="preserve">parent class</doc>
<type name="Gst.ObjectClass" c:type="GstObjectClass"/>
</field>
<field name="open_device">
<callback name="open_device">
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the device could be opened, FALSE on error.
MT safe.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="acquire">
<callback name="acquire">
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the device could be acquired, FALSE on error.
MT safe.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer to acquire</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</parameter>
<parameter name="spec" transfer-ownership="none">
<doc xml:space="preserve">the specs of the buffer</doc>
<type name="AudioRingBufferSpec"
c:type="GstAudioRingBufferSpec*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="release">
<callback name="release">
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the device could be released, FALSE on error.
MT safe.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer to release</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="close_device">
<callback name="close_device">
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the device could be closed, FALSE on error.
MT safe.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="start">
<callback name="start">
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the device could be started, FALSE on error.
MT safe.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer to start</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="pause">
<callback name="pause">
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the device could be paused, FALSE on error.
MT safe.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer to pause</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="resume">
<callback name="resume">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="buf" transfer-ownership="none">
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="stop">
<callback name="stop">
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the device could be stopped, FALSE on error.
MT safe.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer to stop</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="delay">
<callback name="delay">
<return-value transfer-ownership="none">
<doc xml:space="preserve">The number of samples queued in the audio device.
MT safe.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer to query</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="activate">
<callback name="activate">
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the device could be activated in the requested mode,
FALSE on error.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer to activate</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</parameter>
<parameter name="active" transfer-ownership="none">
<doc xml:space="preserve">the new mode</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</callback>
</field>
<field name="commit">
<callback name="commit">
<return-value transfer-ownership="none">
<doc xml:space="preserve">The number of samples written to the ringbuffer or -1 on error. The
number of samples written can be less than @out_samples when @buf was interrupted
with a flush or stop.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer to commit</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</parameter>
<parameter name="sample" transfer-ownership="none">
<doc xml:space="preserve">the sample position of the data</doc>
<type name="guint64" c:type="guint64*"/>
</parameter>
<parameter name="data" transfer-ownership="none">
<doc xml:space="preserve">the data to commit</doc>
<type name="guint8" c:type="guint8*"/>
</parameter>
<parameter name="in_samples" transfer-ownership="none">
<doc xml:space="preserve">the number of samples in the data to commit</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="out_samples" transfer-ownership="none">
<doc xml:space="preserve">the number of samples to write to the ringbuffer</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="accum" transfer-ownership="none">
<doc xml:space="preserve">accumulator for rate conversion.</doc>
<type name="gint" c:type="gint*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="clear_all">
<callback name="clear_all">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioRingBuffer to clear</doc>
<type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
</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="AudioRingBufferFormatType"
glib:type-name="GstAudioRingBufferFormatType"
glib:get-type="gst_audio_ring_buffer_format_type_get_type"
c:type="GstAudioRingBufferFormatType">
<doc xml:space="preserve">The format of the samples in the ringbuffer.</doc>
<member name="raw"
value="0"
c:identifier="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_RAW"
glib:nick="raw">
<doc xml:space="preserve">samples in linear or float</doc>
</member>
<member name="mu_law"
value="1"
c:identifier="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_MU_LAW"
glib:nick="mu-law">
<doc xml:space="preserve">samples in mulaw</doc>
</member>
<member name="a_law"
value="2"
c:identifier="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_A_LAW"
glib:nick="a-law">
<doc xml:space="preserve">samples in alaw</doc>
</member>
<member name="ima_adpcm"
value="3"
c:identifier="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_IMA_ADPCM"
glib:nick="ima-adpcm">
<doc xml:space="preserve">samples in ima adpcm</doc>
</member>
<member name="mpeg"
value="4"
c:identifier="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_MPEG"
glib:nick="mpeg">
<doc xml:space="preserve">samples in mpeg audio (but not AAC) format</doc>
</member>
<member name="gsm"
value="5"
c:identifier="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_GSM"
glib:nick="gsm">
<doc xml:space="preserve">samples in gsm format</doc>
</member>
<member name="iec958"
value="6"
c:identifier="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_IEC958"
glib:nick="iec958">
<doc xml:space="preserve">samples in IEC958 frames (e.g. AC3)</doc>
</member>
<member name="ac3"
value="7"
c:identifier="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_AC3"
glib:nick="ac3">
<doc xml:space="preserve">samples in AC3 format</doc>
</member>
<member name="eac3"
value="8"
c:identifier="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_EAC3"
glib:nick="eac3">
<doc xml:space="preserve">samples in EAC3 format</doc>
</member>
<member name="dts"
value="9"
c:identifier="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_DTS"
glib:nick="dts">
<doc xml:space="preserve">samples in DTS format</doc>
</member>
<member name="mpeg2_aac"
value="10"
c:identifier="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_MPEG2_AAC"
glib:nick="mpeg2-aac">
<doc xml:space="preserve">samples in MPEG-2 AAC format</doc>
</member>
<member name="mpeg4_aac"
value="11"
c:identifier="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_MPEG4_AAC"
glib:nick="mpeg4-aac">
<doc xml:space="preserve">samples in MPEG-4 AAC format</doc>
</member>
</enumeration>
<record name="AudioRingBufferSpec" c:type="GstAudioRingBufferSpec">
<doc xml:space="preserve">The structure containing the format specification of the ringbuffer.</doc>
<field name="caps" writable="1">
<doc xml:space="preserve">The caps that generated the Spec.</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</field>
<field name="type" writable="1">
<doc xml:space="preserve">the sample type</doc>
<type name="AudioRingBufferFormatType"
c:type="GstAudioRingBufferFormatType"/>
</field>
<field name="info" writable="1">
<doc xml:space="preserve">the #GstAudioInfo</doc>
<type name="AudioInfo" c:type="GstAudioInfo"/>
</field>
<field name="latency_time" writable="1">
<doc xml:space="preserve">the latency in microseconds</doc>
<type name="guint64" c:type="guint64"/>
</field>
<field name="buffer_time" writable="1">
<doc xml:space="preserve">the total buffer size in microseconds</doc>
<type name="guint64" c:type="guint64"/>
</field>
<field name="segsize" writable="1">
<doc xml:space="preserve">the size of one segment in bytes</doc>
<type name="gint" c:type="gint"/>
</field>
<field name="segtotal" writable="1">
<doc xml:space="preserve">the total number of segments</doc>
<type name="gint" c:type="gint"/>
</field>
<field name="seglatency" writable="1">
<doc xml:space="preserve">number of segments queued in the lower level device,
defaults to segtotal</doc>
<type name="gint" c:type="gint"/>
</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="AudioRingBufferState"
glib:type-name="GstAudioRingBufferState"
glib:get-type="gst_audio_ring_buffer_state_get_type"
c:type="GstAudioRingBufferState">
<doc xml:space="preserve">The state of the ringbuffer.</doc>
<member name="stopped"
value="0"
c:identifier="GST_AUDIO_RING_BUFFER_STATE_STOPPED"
glib:nick="stopped">
<doc xml:space="preserve">The ringbuffer is stopped</doc>
</member>
<member name="paused"
value="1"
c:identifier="GST_AUDIO_RING_BUFFER_STATE_PAUSED"
glib:nick="paused">
<doc xml:space="preserve">The ringbuffer is paused</doc>
</member>
<member name="started"
value="2"
c:identifier="GST_AUDIO_RING_BUFFER_STATE_STARTED"
glib:nick="started">
<doc xml:space="preserve">The ringbuffer is started</doc>
</member>
<member name="error"
value="3"
c:identifier="GST_AUDIO_RING_BUFFER_STATE_ERROR"
glib:nick="error">
<doc xml:space="preserve">The ringbuffer has encountered an
error after it has been started, e.g. because the device was
disconnected (Since 1.2)</doc>
</member>
</enumeration>
<class name="AudioSink"
c:symbol-prefix="audio_sink"
c:type="GstAudioSink"
parent="AudioBaseSink"
glib:type-name="GstAudioSink"
glib:get-type="gst_audio_sink_get_type"
glib:type-struct="AudioSinkClass">
<doc xml:space="preserve">This is the most simple base class for audio sinks that only requires
subclasses to implement a set of simple functions:
<variablelist>
<varlistentry>
<term>open()</term>
<listitem><para>Open the device.</para></listitem>
</varlistentry>
<varlistentry>
<term>prepare()</term>
<listitem><para>Configure the device with the specified format.</para></listitem>
</varlistentry>
<varlistentry>
<term>write()</term>
<listitem><para>Write samples to the device.</para></listitem>
</varlistentry>
<varlistentry>
<term>reset()</term>
<listitem><para>Unblock writes and flush the device.</para></listitem>
</varlistentry>
<varlistentry>
<term>delay()</term>
<listitem><para>Get the number of samples written but not yet played
by the device.</para></listitem>
</varlistentry>
<varlistentry>
<term>unprepare()</term>
<listitem><para>Undo operations done by prepare.</para></listitem>
</varlistentry>
<varlistentry>
<term>close()</term>
<listitem><para>Close the device.</para></listitem>
</varlistentry>
</variablelist>
All scheduling of samples and timestamps is done in this base class
together with #GstAudioBaseSink using a default implementation of a
#GstAudioRingBuffer that uses threads.</doc>
<virtual-method name="close">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="sink" transfer-ownership="none">
<type name="AudioSink" c:type="GstAudioSink*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="delay">
<return-value transfer-ownership="none">
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="sink" transfer-ownership="none">
<type name="AudioSink" c:type="GstAudioSink*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="open">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="sink" transfer-ownership="none">
<type name="AudioSink" c:type="GstAudioSink*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="prepare">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="sink" transfer-ownership="none">
<type name="AudioSink" c:type="GstAudioSink*"/>
</instance-parameter>
<parameter name="spec" transfer-ownership="none">
<type name="AudioRingBufferSpec" c:type="GstAudioRingBufferSpec*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="reset">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="sink" transfer-ownership="none">
<type name="AudioSink" c:type="GstAudioSink*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="unprepare">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="sink" transfer-ownership="none">
<type name="AudioSink" c:type="GstAudioSink*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="write">
<return-value transfer-ownership="none">
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="sink" transfer-ownership="none">
<type name="AudioSink" c:type="GstAudioSink*"/>
</instance-parameter>
<parameter name="data" transfer-ownership="none">
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="length" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</virtual-method>
<field name="element">
<type name="AudioBaseSink" c:type="GstAudioBaseSink"/>
</field>
<field name="thread" readable="0" private="1">
<type name="GLib.Thread" c:type="GThread*"/>
</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="AudioSinkClass"
c:type="GstAudioSinkClass"
glib:is-gtype-struct-for="AudioSink">
<doc xml:space="preserve">#GstAudioSink class. Override the vmethods to implement functionality.</doc>
<field name="parent_class">
<doc xml:space="preserve">the parent class structure.</doc>
<type name="AudioBaseSinkClass" c:type="GstAudioBaseSinkClass"/>
</field>
<field name="open">
<callback name="open">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="sink" transfer-ownership="none">
<type name="AudioSink" c:type="GstAudioSink*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="prepare">
<callback name="prepare">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="sink" transfer-ownership="none">
<type name="AudioSink" c:type="GstAudioSink*"/>
</parameter>
<parameter name="spec" transfer-ownership="none">
<type name="AudioRingBufferSpec"
c:type="GstAudioRingBufferSpec*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="unprepare">
<callback name="unprepare">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="sink" transfer-ownership="none">
<type name="AudioSink" c:type="GstAudioSink*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="close">
<callback name="close">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="sink" transfer-ownership="none">
<type name="AudioSink" c:type="GstAudioSink*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="write">
<callback name="write">
<return-value transfer-ownership="none">
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<parameter name="sink" transfer-ownership="none">
<type name="AudioSink" c:type="GstAudioSink*"/>
</parameter>
<parameter name="data" transfer-ownership="none">
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="length" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</callback>
</field>
<field name="delay">
<callback name="delay">
<return-value transfer-ownership="none">
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<parameter name="sink" transfer-ownership="none">
<type name="AudioSink" c:type="GstAudioSink*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="reset">
<callback name="reset">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="sink" transfer-ownership="none">
<type name="AudioSink" c:type="GstAudioSink*"/>
</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="AudioSrc"
c:symbol-prefix="audio_src"
c:type="GstAudioSrc"
parent="AudioBaseSrc"
glib:type-name="GstAudioSrc"
glib:get-type="gst_audio_src_get_type"
glib:type-struct="AudioSrcClass">
<doc xml:space="preserve">This is the most simple base class for audio sources that only requires
subclasses to implement a set of simple functions:
<variablelist>
<varlistentry>
<term>open()</term>
<listitem><para>Open the device.</para></listitem>
</varlistentry>
<varlistentry>
<term>prepare()</term>
<listitem><para>Configure the device with the specified format.</para></listitem>
</varlistentry>
<varlistentry>
<term>read()</term>
<listitem><para>Read samples from the device.</para></listitem>
</varlistentry>
<varlistentry>
<term>reset()</term>
<listitem><para>Unblock reads and flush the device.</para></listitem>
</varlistentry>
<varlistentry>
<term>delay()</term>
<listitem><para>Get the number of samples in the device but not yet read.
</para></listitem>
</varlistentry>
<varlistentry>
<term>unprepare()</term>
<listitem><para>Undo operations done by prepare.</para></listitem>
</varlistentry>
<varlistentry>
<term>close()</term>
<listitem><para>Close the device.</para></listitem>
</varlistentry>
</variablelist>
All scheduling of samples and timestamps is done in this base class
together with #GstAudioBaseSrc using a default implementation of a
#GstAudioRingBuffer that uses threads.</doc>
<virtual-method name="close">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="src" transfer-ownership="none">
<type name="AudioSrc" c:type="GstAudioSrc*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="delay">
<return-value transfer-ownership="none">
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="src" transfer-ownership="none">
<type name="AudioSrc" c:type="GstAudioSrc*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="open">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="src" transfer-ownership="none">
<type name="AudioSrc" c:type="GstAudioSrc*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="prepare">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="src" transfer-ownership="none">
<type name="AudioSrc" c:type="GstAudioSrc*"/>
</instance-parameter>
<parameter name="spec" transfer-ownership="none">
<type name="AudioRingBufferSpec" c:type="GstAudioRingBufferSpec*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="read">
<return-value transfer-ownership="none">
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="src" transfer-ownership="none">
<type name="AudioSrc" c:type="GstAudioSrc*"/>
</instance-parameter>
<parameter name="data" transfer-ownership="none">
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="length" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="timestamp" transfer-ownership="none">
<type name="Gst.ClockTime" c:type="GstClockTime*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="reset">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="src" transfer-ownership="none">
<type name="AudioSrc" c:type="GstAudioSrc*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="unprepare">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="src" transfer-ownership="none">
<type name="AudioSrc" c:type="GstAudioSrc*"/>
</instance-parameter>
</parameters>
</virtual-method>
<field name="element">
<type name="AudioBaseSrc" c:type="GstAudioBaseSrc"/>
</field>
<field name="thread" readable="0" private="1">
<type name="GLib.Thread" c:type="GThread*"/>
</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="AudioSrcClass"
c:type="GstAudioSrcClass"
glib:is-gtype-struct-for="AudioSrc">
<doc xml:space="preserve">#GstAudioSrc class. Override the vmethod to implement
functionality.</doc>
<field name="parent_class">
<doc xml:space="preserve">the parent class.</doc>
<type name="AudioBaseSrcClass" c:type="GstAudioBaseSrcClass"/>
</field>
<field name="open">
<callback name="open">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="src" transfer-ownership="none">
<type name="AudioSrc" c:type="GstAudioSrc*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="prepare">
<callback name="prepare">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="src" transfer-ownership="none">
<type name="AudioSrc" c:type="GstAudioSrc*"/>
</parameter>
<parameter name="spec" transfer-ownership="none">
<type name="AudioRingBufferSpec"
c:type="GstAudioRingBufferSpec*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="unprepare">
<callback name="unprepare">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="src" transfer-ownership="none">
<type name="AudioSrc" c:type="GstAudioSrc*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="close">
<callback name="close">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="src" transfer-ownership="none">
<type name="AudioSrc" c:type="GstAudioSrc*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="read">
<callback name="read">
<return-value transfer-ownership="none">
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<parameter name="src" transfer-ownership="none">
<type name="AudioSrc" c:type="GstAudioSrc*"/>
</parameter>
<parameter name="data" transfer-ownership="none">
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="length" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="timestamp" transfer-ownership="none">
<type name="Gst.ClockTime" c:type="GstClockTime*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="delay">
<callback name="delay">
<return-value transfer-ownership="none">
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<parameter name="src" transfer-ownership="none">
<type name="AudioSrc" c:type="GstAudioSrc*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="reset">
<callback name="reset">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="src" transfer-ownership="none">
<type name="AudioSrc" c:type="GstAudioSrc*"/>
</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>
<constant name="META_TAG_AUDIO_CHANNELS_STR"
value="channels"
c:type="GST_META_TAG_AUDIO_CHANNELS_STR"
version="1.2">
<doc xml:space="preserve">This metadata stays relevant as long as channels are unchanged.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="META_TAG_AUDIO_STR"
value="audio"
c:type="GST_META_TAG_AUDIO_STR"
version="1.2">
<doc xml:space="preserve">This metadata is relevant for audio streams.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<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 #playbin.
</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">
<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">
<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">
<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">
<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">
<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" 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">
<doc xml:space="preserve">Linear scale factor, 1.0 = 100%</doc>
</member>
<member name="cubic"
value="1"
c:identifier="GST_STREAM_VOLUME_FORMAT_CUBIC">
<doc xml:space="preserve">Cubic volume scale</doc>
</member>
<member name="db" value="2" c:identifier="GST_STREAM_VOLUME_FORMAT_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="iface">
<type name="GObject.TypeInterface" c:type="GTypeInterface"/>
</field>
</record>
<function name="audio_buffer_clip" c:identifier="gst_audio_buffer_clip">
<doc xml:space="preserve">Clip the buffer to the given %GstSegment.
After calling this function the caller does not own a reference to
@buffer anymore.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">%NULL if the buffer is completely outside the configured segment,
otherwise the clipped buffer is returned.
If the buffer has no timestamp, it is assumed to be inside the segment and
is not clipped</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</return-value>
<parameters>
<parameter name="buffer" transfer-ownership="full">
<doc xml:space="preserve">The buffer to clip.</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</parameter>
<parameter name="segment" transfer-ownership="none">
<doc xml:space="preserve">Segment in %GST_FORMAT_TIME or %GST_FORMAT_DEFAULT to which
the buffer should be clipped.</doc>
<type name="Gst.Segment" c:type="GstSegment*"/>
</parameter>
<parameter name="rate" transfer-ownership="none">
<doc xml:space="preserve">sample rate.</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="bpf" transfer-ownership="none">
<doc xml:space="preserve">size of one audio frame in bytes. This is the size of one sample
* channels.</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</function>
<function name="audio_buffer_reorder_channels"
c:identifier="gst_audio_buffer_reorder_channels">
<doc xml:space="preserve">Reorders @buffer from the channel positions @from to the channel
positions @to. @from and @to must contain the same number of
positions and the same positions, only in a different order.
@buffer must be writable.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the reordering was possible.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve">The buffer to reorder.</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</parameter>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">The %GstAudioFormat of the buffer.</doc>
<type name="AudioFormat" c:type="GstAudioFormat"/>
</parameter>
<parameter name="channels" transfer-ownership="none">
<doc xml:space="preserve">The number of channels.</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="from" transfer-ownership="none">
<doc xml:space="preserve">The channel positions in the buffer.</doc>
<array zero-terminated="0" c:type="GstAudioChannelPosition*">
<type name="AudioChannelPosition"
c:type="GstAudioChannelPosition"/>
</array>
</parameter>
<parameter name="to" transfer-ownership="none">
<doc xml:space="preserve">The channel positions to convert to.</doc>
<array zero-terminated="0" c:type="GstAudioChannelPosition*">
<type name="AudioChannelPosition"
c:type="GstAudioChannelPosition"/>
</array>
</parameter>
</parameters>
</function>
<function name="audio_channel_positions_from_mask"
c:identifier="gst_audio_channel_positions_from_mask">
<doc xml:space="preserve">Convert the @channels present in @channel_mask to a @position array
(which should have at least @channels entries ensured by caller).
If @channel_mask is set to 0, it is considered as 'not present' for purpose
of conversion.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if channel and channel mask are valid and could be converted</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="channels" transfer-ownership="none">
<doc xml:space="preserve">The number of channels</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="channel_mask" transfer-ownership="none">
<doc xml:space="preserve">The input channel_mask</doc>
<type name="guint64" c:type="guint64"/>
</parameter>
<parameter name="position" transfer-ownership="none">
<doc xml:space="preserve">The
%GstAudioChannelPosition<!-- -->s</doc>
<array length="0"
zero-terminated="0"
c:type="GstAudioChannelPosition*">
<type name="AudioChannelPosition"
c:type="GstAudioChannelPosition"/>
</array>
</parameter>
</parameters>
</function>
<function name="audio_channel_positions_to_mask"
c:identifier="gst_audio_channel_positions_to_mask">
<doc xml:space="preserve">Convert the @position array of @channels channels to a bitmask.
If @force_order is %TRUE it additionally checks if the channels are
in the order required by GStreamer.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the channel positions are valid and could be converted.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="position" transfer-ownership="none">
<doc xml:space="preserve">The %GstAudioChannelPositions</doc>
<array length="1"
zero-terminated="0"
c:type="GstAudioChannelPosition*">
<type name="AudioChannelPosition"
c:type="GstAudioChannelPosition"/>
</array>
</parameter>
<parameter name="channels" transfer-ownership="none">
<doc xml:space="preserve">The number of channels.</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="force_order" transfer-ownership="none">
<doc xml:space="preserve">Only consider the GStreamer channel order.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
<parameter name="channel_mask" transfer-ownership="none">
<doc xml:space="preserve">the output channel mask</doc>
<array zero-terminated="0" c:type="guint64*">
<type name="guint64" c:type="guint64"/>
</array>
</parameter>
</parameters>
</function>
<function name="audio_channel_positions_to_valid_order"
c:identifier="gst_audio_channel_positions_to_valid_order">
<doc xml:space="preserve">Reorders the channel positions in @position from any order to
the GStreamer channel order.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the channel positions are valid and reordering
was successful.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="position" transfer-ownership="none">
<doc xml:space="preserve">The channel positions to
reorder to.</doc>
<array length="1"
zero-terminated="0"
c:type="GstAudioChannelPosition*">
<type name="AudioChannelPosition"
c:type="GstAudioChannelPosition"/>
</array>
</parameter>
<parameter name="channels" transfer-ownership="none">
<doc xml:space="preserve">The number of channels.</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</function>
<function name="audio_check_valid_channel_positions"
c:identifier="gst_audio_check_valid_channel_positions">
<doc xml:space="preserve">Checks if @position contains valid channel positions for
@channels channels. If @force_order is %TRUE it additionally
checks if the channels are in the order required by GStreamer.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the channel positions are valid.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="position" transfer-ownership="none">
<doc xml:space="preserve">The %GstAudioChannelPositions
to check.</doc>
<array length="1"
zero-terminated="0"
c:type="GstAudioChannelPosition*">
<type name="AudioChannelPosition"
c:type="GstAudioChannelPosition"/>
</array>
</parameter>
<parameter name="channels" transfer-ownership="none">
<doc xml:space="preserve">The number of channels.</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="force_order" transfer-ownership="none">
<doc xml:space="preserve">Only consider the GStreamer channel order.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</function>
<function name="audio_downmix_meta_api_get_type"
c:identifier="gst_audio_downmix_meta_api_get_type">
<return-value transfer-ownership="none">
<type name="GType" c:type="GType"/>
</return-value>
</function>
<function name="audio_downmix_meta_get_info"
c:identifier="gst_audio_downmix_meta_get_info"
moved-to="AudioDownmixMeta.get_info">
<return-value transfer-ownership="none">
<type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
</return-value>
</function>
<function name="audio_format_build_integer"
c:identifier="gst_audio_format_build_integer"
moved-to="AudioFormat.build_integer">
<doc xml:space="preserve">Construct a #GstAudioFormat with given parameters.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioFormat or GST_AUDIO_FORMAT_UNKNOWN when no audio format
exists with the given parameters.</doc>
<type name="AudioFormat" c:type="GstAudioFormat"/>
</return-value>
<parameters>
<parameter name="sign" transfer-ownership="none">
<doc xml:space="preserve">signed or unsigned format</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
<parameter name="endianness" transfer-ownership="none">
<doc xml:space="preserve">G_LITTLE_ENDIAN or G_BIG_ENDIAN</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve">amount of bits used per sample</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="depth" transfer-ownership="none">
<doc xml:space="preserve">amount of used bits in @width</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</function>
<function name="audio_format_fill_silence"
c:identifier="gst_audio_format_fill_silence"
moved-to="AudioFormat.fill_silence">
<doc xml:space="preserve">Fill @length bytes in @dest with silence samples for @info.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioFormatInfo</doc>
<type name="AudioFormatInfo" c:type="const GstAudioFormatInfo*"/>
</parameter>
<parameter name="dest" transfer-ownership="none">
<doc xml:space="preserve">a destination
to fill</doc>
<array length="2" zero-terminated="0" c:type="gpointer">
<type name="guint8"/>
</array>
</parameter>
<parameter name="length" transfer-ownership="none">
<doc xml:space="preserve">the length to fill</doc>
<type name="gsize" c:type="gsize"/>
</parameter>
</parameters>
</function>
<function name="audio_format_from_string"
c:identifier="gst_audio_format_from_string"
moved-to="AudioFormat.from_string">
<doc xml:space="preserve">Convert the @format string to its #GstAudioFormat.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the #GstAudioFormat for @format or GST_AUDIO_FORMAT_UNKNOWN when the
string is not a known format.</doc>
<type name="AudioFormat" c:type="GstAudioFormat"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">a format string</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="audio_format_get_info"
c:identifier="gst_audio_format_get_info"
moved-to="AudioFormat.get_info">
<doc xml:space="preserve">Get the #GstAudioFormatInfo for @format</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The #GstAudioFormatInfo for @format.</doc>
<type name="AudioFormatInfo" c:type="const GstAudioFormatInfo*"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">a #GstAudioFormat</doc>
<type name="AudioFormat" c:type="GstAudioFormat"/>
</parameter>
</parameters>
</function>
<function name="audio_format_info_get_type"
c:identifier="gst_audio_format_info_get_type">
<return-value transfer-ownership="none">
<type name="GType" c:type="GType"/>
</return-value>
</function>
<function name="audio_format_to_string"
c:identifier="gst_audio_format_to_string"
moved-to="AudioFormat.to_string">
<return-value transfer-ownership="none">
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<type name="AudioFormat" c:type="GstAudioFormat"/>
</parameter>
</parameters>
</function>
<function name="audio_get_channel_reorder_map"
c:identifier="gst_audio_get_channel_reorder_map">
<doc xml:space="preserve">Returns a reorder map for @from to @to that can be used in
custom channel reordering code, e.g. to convert from or to the
GStreamer channel order. @from and @to must contain the same
number of positions and the same positions, only in a
different order.
The resulting @reorder_map can be used for reordering by assigning
channel i of the input to channel reorder_map[i] of the output.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the channel positions are valid and reordering
is possible.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="channels" transfer-ownership="none">
<doc xml:space="preserve">The number of channels.</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="from" transfer-ownership="none">
<doc xml:space="preserve">The channel positions to reorder from.</doc>
<array zero-terminated="0" c:type="GstAudioChannelPosition*">
<type name="AudioChannelPosition"
c:type="GstAudioChannelPosition"/>
</array>
</parameter>
<parameter name="to" transfer-ownership="none">
<doc xml:space="preserve">The channel positions to reorder to.</doc>
<array zero-terminated="0" c:type="GstAudioChannelPosition*">
<type name="AudioChannelPosition"
c:type="GstAudioChannelPosition"/>
</array>
</parameter>
<parameter name="reorder_map" transfer-ownership="none">
<doc xml:space="preserve">Pointer to the reorder map.</doc>
<array zero-terminated="0" c:type="gint*">
<type name="gint" c:type="gint"/>
</array>
</parameter>
</parameters>
</function>
<function name="audio_iec61937_frame_size"
c:identifier="gst_audio_iec61937_frame_size">
<doc xml:space="preserve">Calculated the size of the buffer expected by gst_audio_iec61937_payload() for
payloading type from @spec.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the size or 0 if the given @type is not supported or cannot be
payloaded.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<parameter name="spec" transfer-ownership="none">
<doc xml:space="preserve">the ringbufer spec</doc>
<type name="AudioRingBufferSpec"
c:type="const GstAudioRingBufferSpec*"/>
</parameter>
</parameters>
</function>
<function name="audio_iec61937_payload"
c:identifier="gst_audio_iec61937_payload">
<doc xml:space="preserve">Payloads @src in the form specified by IEC 61937 for the type from @spec and
stores the result in @dst. @src must contain exactly one frame of data and
the frame is not checked for errors.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">transfer-full: %TRUE if the payloading was successful, %FALSE
otherwise.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="src" transfer-ownership="none">
<doc xml:space="preserve">a buffer containing the data to payload</doc>
<array length="1" zero-terminated="0" c:type="guint8*">
<type name="guint8" c:type="guint8"/>
</array>
</parameter>
<parameter name="src_n" transfer-ownership="none">
<doc xml:space="preserve">size of @src in bytes</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="dst" transfer-ownership="none">
<doc xml:space="preserve">the destination buffer to store the
payloaded contents in. Should not overlap with @src</doc>
<array length="3" zero-terminated="0" c:type="guint8*">
<type name="guint8" c:type="guint8"/>
</array>
</parameter>
<parameter name="dst_n" transfer-ownership="none">
<doc xml:space="preserve">size of @dst in bytes</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="spec" transfer-ownership="none">
<doc xml:space="preserve">the ringbufer spec for @src</doc>
<type name="AudioRingBufferSpec"
c:type="const GstAudioRingBufferSpec*"/>
</parameter>
<parameter name="endianness" transfer-ownership="none">
<doc xml:space="preserve">the expected byte order of the payloaded data</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</function>
<function name="audio_reorder_channels"
c:identifier="gst_audio_reorder_channels">
<doc xml:space="preserve">Reorders @data from the channel positions @from to the channel
positions @to. @from and @to must contain the same number of
positions and the same positions, only in a different order.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the reordering was possible.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="data" transfer-ownership="none">
<doc xml:space="preserve">The pointer to
the memory.</doc>
<array length="1" zero-terminated="0" c:type="gpointer">
<type name="guint8"/>
</array>
</parameter>
<parameter name="size" transfer-ownership="none">
<doc xml:space="preserve">The size of the memory.</doc>
<type name="gsize" c:type="gsize"/>
</parameter>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">The %GstAudioFormat of the buffer.</doc>
<type name="AudioFormat" c:type="GstAudioFormat"/>
</parameter>
<parameter name="channels" transfer-ownership="none">
<doc xml:space="preserve">The number of channels.</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="from" transfer-ownership="none">
<doc xml:space="preserve">The channel positions in the buffer.</doc>
<array zero-terminated="0" c:type="GstAudioChannelPosition*">
<type name="AudioChannelPosition"
c:type="GstAudioChannelPosition"/>
</array>
</parameter>
<parameter name="to" transfer-ownership="none">
<doc xml:space="preserve">The channel positions to convert to.</doc>
<array zero-terminated="0" c:type="GstAudioChannelPosition*">
<type name="AudioChannelPosition"
c:type="GstAudioChannelPosition"/>
</array>
</parameter>
</parameters>
</function>
<function name="buffer_add_audio_downmix_meta"
c:identifier="gst_buffer_add_audio_downmix_meta"
introspectable="0">
<doc xml:space="preserve">Attaches #GstAudioDownmixMeta metadata to @buffer with the given parameters.
@matrix is an two-dimensional array of @to_channels times @from_channels
coefficients, i.e. the i-th output channels is constructed by multiplicating
the input channels with the coefficients in @matrix[i] and taking the sum
of the results.</doc>
<return-value>
<doc xml:space="preserve">the #GstAudioDownmixMeta on @buffer.</doc>
<type name="AudioDownmixMeta" c:type="GstAudioDownmixMeta*"/>
</return-value>
<parameters>
<parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve">a #GstBuffer</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</parameter>
<parameter name="from_position" transfer-ownership="none">
<doc xml:space="preserve">the channel positions
of the source</doc>
<array length="2"
zero-terminated="0"
c:type="GstAudioChannelPosition*">
<type name="AudioChannelPosition"
c:type="GstAudioChannelPosition"/>
</array>
</parameter>
<parameter name="from_channels" transfer-ownership="none">
<doc xml:space="preserve">The number of channels of the source</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="to_position" transfer-ownership="none">
<doc xml:space="preserve">the channel positions of
the destination</doc>
<array length="4"
zero-terminated="0"
c:type="GstAudioChannelPosition*">
<type name="AudioChannelPosition"
c:type="GstAudioChannelPosition"/>
</array>
</parameter>
<parameter name="to_channels" transfer-ownership="none">
<doc xml:space="preserve">The number of channels of the destination</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="matrix" transfer-ownership="none">
<doc xml:space="preserve">The matrix coefficients.</doc>
<type name="gfloat" c:type="const gfloat**"/>
</parameter>
</parameters>
</function>
<function name="buffer_get_audio_downmix_meta_for_channels"
c:identifier="gst_buffer_get_audio_downmix_meta_for_channels"
introspectable="0">
<doc xml:space="preserve">Find the #GstAudioDownmixMeta on @buffer for the given destination
channel positions.</doc>
<return-value>
<doc xml:space="preserve">the #GstAudioDownmixMeta on @buffer.</doc>
<type name="AudioDownmixMeta" c:type="GstAudioDownmixMeta*"/>
</return-value>
<parameters>
<parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve">a #GstBuffer</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</parameter>
<parameter name="to_position" transfer-ownership="none">
<doc xml:space="preserve">the channel positions of
the destination</doc>
<array length="2"
zero-terminated="0"
c:type="GstAudioChannelPosition*">
<type name="AudioChannelPosition"
c:type="GstAudioChannelPosition"/>
</array>
</parameter>
<parameter name="to_channels" transfer-ownership="none">
<doc xml:space="preserve">The number of channels of the destination</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</function>
<function name="stream_volume_convert_volume"
c:identifier="gst_stream_volume_convert_volume"
moved-to="StreamVolume.convert_volume">
<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>
|