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
|
/*
* Copyright (C) 2005-2018 Team Kodi
* This file is part of Kodi - https://kodi.tv
*
* SPDX-License-Identifier: GPL-2.0-or-later
* See LICENSES/README.md for more information.
*/
#pragma once
#include "AddonClass.h"
#include "Tuple.h"
#include "utils/StreamDetails.h"
#include "video/VideoInfoTag.h"
namespace XBMCAddon
{
namespace xbmc
{
///
/// \defgroup python_xbmc_actor Actor
/// \ingroup python_xbmc
/// @{
/// @brief **Actor class used in combination with InfoTagVideo.**
///
/// \python_class{ xbmc.Actor([name, role, order, thumbnail]) }
///
/// Represents a single actor in the cast of a video item wrapped by InfoTagVideo.
///
///
///-------------------------------------------------------------------------
/// @python_v20 New class added.
///
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ...
/// actor = xbmc.Actor('Sean Connery', 'James Bond', order=1)
/// ...
/// ~~~~~~~~~~~~~
///
class Actor : public AddonClass
{
public:
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmc_actor Actor
/// @brief \python_func{ xbmc.Actor([name, role, order, thumbnail]) }
/// Creates a single actor for the cast of a video item wrapped by InfoTagVideo.
///
/// @param name [opt] string - Name of the actor.
/// @param role [opt] string - Role of the actor in the specific video item.
/// @param order [opt] integer - Order of the actor in the cast of the specific video item.
/// @param thumbnail [opt] string - Path / URL to the thumbnail of the actor.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ...
/// actor = xbmc.Actor('Sean Connery', 'James Bond', order=1)
/// ...
/// ~~~~~~~~~~~~~
///
Actor(...);
#else
explicit Actor(const String& name = emptyString,
const String& role = emptyString,
int order = -1,
const String& thumbnail = emptyString);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmc_actor
/// @brief \python_func{ getName() }
/// Get the name of the actor.
///
/// @return [string] Name of the actor
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
getName();
#else
String getName() const { return m_name; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmc_actor
/// @brief \python_func{ getRole() }
/// Get the role of the actor in the specific video item.
///
/// @return [string] Role of the actor in the specific video item
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
getRole();
#else
String getRole() const { return m_role; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmc_actor
/// @brief \python_func{ getOrder() }
/// Get the order of the actor in the cast of the specific video item.
///
/// @return [integer] Order of the actor in the cast of the specific video item
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
getOrder();
#else
int getOrder() const { return m_order; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmc_actor
/// @brief \python_func{ getThumbnail() }
/// Get the path / URL to the thumbnail of the actor.
///
/// @return [string] Path / URL to the thumbnail of the actor
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
getThumbnail();
#else
String getThumbnail() const { return m_thumbnail; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmc_actor
/// @brief \python_func{ setName(name) }
/// Set the name of the actor.
///
/// @param name string - Name of the actor.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setName(...);
#else
void setName(const String& name) { m_name = name; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmc_actor
/// @brief \python_func{ setRole(role) }
/// Set the role of the actor in the specific video item.
///
/// @param role string - Role of the actor in the specific video item.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setRole(...);
#else
void setRole(const String& role) { m_role = role; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmc_actor
/// @brief \python_func{ setOrder(order) }
/// Set the order of the actor in the cast of the specific video item.
///
/// @param order integer - Order of the actor in the cast of the specific video item.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setOrder(...);
#else
void setOrder(int order) { m_order = order; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmc_actor
/// @brief \python_func{ setThumbnail(thumbnail) }
/// Set the path / URL to the thumbnail of the actor.
///
/// @param thumbnail string - Path / URL to the thumbnail of the actor.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setThumbnail(...);
#else
void setThumbnail(const String& thumbnail) { m_thumbnail = thumbnail; }
#endif
#ifndef SWIG
SActorInfo ToActorInfo() const;
#endif
private:
String m_name;
String m_role;
int m_order;
String m_thumbnail;
};
/// @}
///
/// \defgroup python_xbmc_videostreamdetail VideoStreamDetail
/// \ingroup python_xbmc
/// @{
/// @brief **Video stream details class used in combination with InfoTagVideo.**
///
/// \python_class{ xbmc.VideoStreamDetail([width, height, aspect, duration, codec, stereoMode, language, hdrType]) }
///
/// Represents a single selectable video stream for a video item wrapped by InfoTagVideo.
///
///
///-------------------------------------------------------------------------
/// @python_v20 New class added.
///
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ...
/// videostream = xbmc.VideoStreamDetail(1920, 1080, language='English')
/// ...
/// ~~~~~~~~~~~~~
///
class VideoStreamDetail : public AddonClass
{
public:
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmc_videostreamdetail
/// @brief \python_func{ xbmc.VideoStreamDetail([width, height, aspect, duration, codec, stereomode, language, hdrtype]) }
/// Creates a single video stream details class for a video item wrapped by InfoTagVideo.
///
/// @param width [opt] integer - Width of the video stream in pixel.
/// @param height [opt] integer - Height of the video stream in pixel.
/// @param aspect [opt] float - Aspect ratio of the video stream.
/// @param duration [opt] integer - Duration of the video stream in seconds.
/// @param codec [opt] string - Codec of the video stream.
/// @param stereomode [opt] string - Stereo mode of the video stream.
/// @param language [opt] string - Language of the video stream.
/// @param hdrtype [opt] string - HDR type of the video stream.
/// The following types are supported:
/// dolbyvision, hdr10, hlg
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ...
/// videostream = xbmc.VideoStreamDetail(1920, 1080, language='English')
/// ...
/// ~~~~~~~~~~~~~
///
VideoStreamDetail(...);
#else
explicit VideoStreamDetail(int width = 0,
int height = 0,
float aspect = 0.0f,
int duration = 0,
const String& codec = emptyString,
const String& stereomode = emptyString,
const String& language = emptyString,
const String& hdrtype = emptyString);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmc_videostreamdetail
/// @brief \python_func{ getWidth() }
/// Get the width of the video stream in pixel.
///
/// @return [integer] Width of the video stream
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
getWidth();
#else
int getWidth() const { return m_width; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmc_videostreamdetail
/// @brief \python_func{ getHeight() }
/// Get the height of the video stream in pixel.
///
/// @return [integer] Height of the video stream
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
getHeight();
#else
int getHeight() const { return m_height; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmc_videostreamdetail
/// @brief \python_func{ getAspect() }
/// Get the aspect ratio of the video stream.
///
/// @return [float] Aspect ratio of the video stream
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
getAspect();
#else
float getAspect() const { return m_aspect; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmc_videostreamdetail
/// @brief \python_func{ getDuration() }
/// Get the duration of the video stream in seconds.
///
/// @return [float] Duration of the video stream in seconds
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
getDuration();
#else
int getDuration() const { return m_duration; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmc_videostreamdetail
/// @brief \python_func{ getCodec() }
/// Get the codec of the stream.
///
/// @return [string] Codec of the stream
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
getCodec();
#else
String getCodec() const { return m_codec; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmc_videostreamdetail
/// @brief \python_func{ getStereoMode() }
/// Get the stereo mode of the video stream.
///
/// @return [string] Stereo mode of the video stream
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
getStereoMode();
#else
String getStereoMode() const { return m_stereoMode; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmc_videostreamdetail
/// @brief \python_func{ getLanguage() }
/// Get the language of the stream.
///
/// @return [string] Language of the stream
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
getLanguage();
#else
String getLanguage() const { return m_language; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmc_videostreamdetail
/// @brief \python_func{ getHDRType() }
/// Get the HDR type of the stream.
///
/// @return [string] HDR type of the stream
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
getHDRType();
#else
String getHDRType() const { return m_hdrType; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmc_videostreamdetail
/// @brief \python_func{ setWidth(width) }
/// Set the width of the video stream in pixel.
///
/// @param width integer - Width of the video stream in pixel.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setWidth(...);
#else
void setWidth(int width) { m_width = width; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmc_videostreamdetail
/// @brief \python_func{ setHeight(height) }
/// Set the height of the video stream in pixel.
///
/// @param height integer - Height of the video stream in pixel.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setHeight(...);
#else
void setHeight(int height) { m_height = height; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmc_videostreamdetail
/// @brief \python_func{ setAspect(aspect) }
/// Set the aspect ratio of the video stream.
///
/// @param aspect float - Aspect ratio of the video stream.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setAspect(...);
#else
void setAspect(float aspect) { m_aspect = aspect; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmc_videostreamdetail
/// @brief \python_func{ setDuration(duration) }
/// Set the duration of the video stream in seconds.
///
/// @param duration integer - Duration of the video stream in seconds.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setDuration(...);
#else
void setDuration(int duration) { m_duration = duration; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmc_videostreamdetail
/// @brief \python_func{ setCodec(codec) }
/// Set the codec of the stream.
///
/// @param codec string - Codec of the stream.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setCodec(...);
#else
void setCodec(const String& codec) { m_codec = codec; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmc_videostreamdetail
/// @brief \python_func{ setStereoMode(stereomode) }
/// Set the stereo mode of the video stream.
///
/// @param stereomode string - Stereo mode of the video stream.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setStereoMode(...);
#else
void setStereoMode(const String& stereomode) { m_stereoMode = stereomode; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmc_videostreamdetail
/// @brief \python_func{ setLanguage(language) }
/// Set the language of the stream.
///
/// @param language string - Language of the stream.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setLanguage(...);
#else
void setLanguage(const String& language) { m_language = language; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmc_videostreamdetail
/// @brief \python_func{ setHDRType(hdrtype) }
/// Set the HDR type of the stream.
///
/// @param hdrtype string - HDR type of the stream.
/// The following types are supported:
/// dolbyvision, hdr10, hlg
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setHDRType(...);
#else
void setHDRType(const String& hdrtype) { m_hdrType = hdrtype; }
#endif
#ifndef SWIG
CStreamDetailVideo* ToStreamDetailVideo() const;
#endif
private:
int m_width;
int m_height;
float m_aspect;
int m_duration;
String m_codec;
String m_stereoMode;
String m_language;
String m_hdrType;
};
/// @}
///
/// \defgroup python_xbmc_audiostreamdetail AudioStreamDetail
/// \ingroup python_xbmc
/// @{
/// @brief **Audio stream details class used in combination with InfoTagVideo.**
///
/// \python_class{ xbmc.AudioStreamDetail([channels, codec, language]) }
///
/// Represents a single selectable audio stream for a video item wrapped by InfoTagVideo.
///
///
///-------------------------------------------------------------------------
/// @python_v20 New class added.
///
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ...
/// audiostream = xbmc.AudioStreamDetail(6, 'DTS', 'English')
/// ...
/// ~~~~~~~~~~~~~
///
class AudioStreamDetail : public AddonClass
{
public:
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmc_audiostreamdetail AudioStreamDetail
/// @brief \python_func{ xbmc.AudioStreamDetail([channels, codec, language]) }
/// Creates a single audio stream details class for a video item wrapped by InfoTagVideo.
///
/// @param channels [opt] integer - Number of channels in the audio stream.
/// @param codec [opt] string - Codec of the audio stream.
/// @param language [opt] string - Language of the audio stream.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ...
/// audiostream = xbmc.AudioStreamDetail(6, 'DTS', 'English')
/// ...
/// ~~~~~~~~~~~~~
///
AudioStreamDetail(...);
#else
explicit AudioStreamDetail(int channels = -1,
const String& codec = emptyString,
const String& language = emptyString);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmc_audiostreamdetail
/// @brief \python_func{ getChannels() }
/// Get the number of channels in the stream.
///
/// @return [integer] Number of channels in the stream
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
getChannels();
#else
int getChannels() const { return m_channels; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmc_audiostreamdetail
/// @brief \python_func{ getCodec() }
/// Get the codec of the stream.
///
/// @return [string] Codec of the stream
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
getCodec();
#else
String getCodec() const { return m_codec; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmc_audiostreamdetail
/// @brief \python_func{ getLanguage() }
/// Get the language of the stream.
///
/// @return [string] Language of the stream
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
getLanguage();
#else
String getLanguage() const { return m_language; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmc_audiostreamdetail
/// @brief \python_func{ setChannels(channels) }
/// Set the number of channels in the stream.
///
/// @param channels integer - Number of channels in the stream.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setChannels(...);
#else
void setChannels(int channels) { m_channels = channels; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmc_audiostreamdetail
/// @brief \python_func{ setCodec(codec) }
/// Set the codec of the stream.
///
/// @param codec string - Codec of the stream.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setCodec(...);
#else
void setCodec(const String& codec) { m_codec = codec; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmc_audiostreamdetail
/// @brief \python_func{ setLanguage(language) }
/// Set the language of the stream.
///
/// @param language string - Language of the stream.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setLanguage(...);
#else
void setLanguage(const String& language) { m_language = language; }
#endif
#ifndef SWIG
CStreamDetailAudio* ToStreamDetailAudio() const;
#endif
private:
int m_channels;
String m_codec;
String m_language;
};
/// @}
///
/// \defgroup python_xbmc_subtitlestreamdetail SubtitleStreamDetail
/// \ingroup python_xbmc
/// @{
/// @brief **Subtitle stream details class used in combination with InfoTagVideo.**
///
/// \python_class{ xbmc.SubtitleStreamDetail([language]) }
///
/// Represents a single selectable subtitle stream for a video item wrapped by InfoTagVideo.
///
///
///-------------------------------------------------------------------------
/// @python_v20 New class added.
///
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ...
/// subtitlestream = xbmc.SubtitleStreamDetail('English')
/// ...
/// ~~~~~~~~~~~~~
///
class SubtitleStreamDetail : public AddonClass
{
public:
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmc_subtitlestreamdetail SubtitleStreamDetail
/// @brief \python_func{ xbmc.SubtitleStreamDetail([language]) }
/// Creates a single subtitle stream details class for a video item wrapped by InfoTagVideo.
///
/// @param language [opt] string - Language of the subtitle.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ...
/// subtitlestream = xbmc.SubtitleStreamDetail('English')
/// ...
/// ~~~~~~~~~~~~~
///
SubtitleStreamDetail(...);
#else
explicit SubtitleStreamDetail(const String& language = emptyString);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmc_subtitlestreamdetail
/// @brief \python_func{ getLanguage() }
/// Get the language of the stream.
///
/// @return [string] Language of the stream
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
getLanguage();
#else
String getLanguage() const { return m_language; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmc_subtitlestreamdetail
/// @brief \python_func{ setLanguage(language) }
/// Set the language of the stream.
///
/// @param language string - Language of the stream.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setLanguage(...);
#else
void setLanguage(const String& language) { m_language = language; }
#endif
#ifndef SWIG
CStreamDetailSubtitle* ToStreamDetailSubtitle() const;
#endif
private:
String m_language;
};
/// @}
///
/// \defgroup python_InfoTagVideo InfoTagVideo
/// \ingroup python_xbmc
/// @{
/// @brief **Kodi's video info tag class.**
///
/// \python_class{ xbmc.InfoTagVideo([offscreen]) }
///
/// Access and / or modify the video metadata of a ListItem.
///
///
///-------------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ...
/// tag = xbmc.Player().getVideoInfoTag()
///
/// title = tag.getTitle()
/// file = tag.getFile()
/// ...
/// ~~~~~~~~~~~~~
///
class InfoTagVideo : public AddonClass
{
private:
CVideoInfoTag* infoTag;
bool offscreen;
bool owned;
public:
#ifndef SWIG
explicit InfoTagVideo(const CVideoInfoTag* tag);
explicit InfoTagVideo(CVideoInfoTag* tag, bool offscreen = false);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ xbmc.InfoTagVideo([offscreen]) }
/// Create a video info tag.
///
/// @param offscreen [opt] bool (default `False`) - if GUI based locks should be
/// avoided. Most of the times listitems are created
/// offscreen and added later to a container
/// for display (e.g. plugins) or they are not
/// even displayed (e.g. python scrapers).
/// In such cases, there is no need to lock the
/// GUI when creating the items (increasing your addon
/// performance).
/// Note however, that if you are creating listitems
/// and managing the container itself (e.g using
/// WindowXML or WindowXMLDialog classes) subsquent
/// modifications to the item will require locking.
/// Thus, in such cases, use the default value (`False`).
///
///
///-----------------------------------------------------------------------
/// @python_v20 Added **offscreen** argument.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ...
/// videoinfo = xbmc.InfoTagVideo(offscreen=False)
/// ...
/// ~~~~~~~~~~~~~
///
InfoTagVideo(...);
#else
explicit InfoTagVideo(bool offscreen = false);
#endif
~InfoTagVideo() override;
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getDbId() }
/// Get identification number of tag in database
///
/// @return [integer] database id
///
///
///-----------------------------------------------------------------------
/// @python_v17 New function added.
///
getDbId();
#else
int getDbId();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getDirector() }
/// Get [film director](https://en.wikipedia.org/wiki/Film_director)
/// who has made the film (if present).
///
/// @return [string] Film director name.
///
///
///-----------------------------------------------------------------------
/// @python_v20 Deprecated. Use **getDirectors()** instead.
///
getDirector();
#else
String getDirector();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getDirectors() }
/// Get a list of [film directors](https://en.wikipedia.org/wiki/Film_director)
/// who have made the film (if present).
///
/// @return [list] List of film director names.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
getDirectors();
#else
std::vector<String> getDirectors();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getWritingCredits() }
/// Get the writing credits if present from video info tag.
///
/// @return [string] Writing credits
///
///
///-----------------------------------------------------------------------
/// @python_v20 Deprecated. Use **getWriters()** instead.
///
getWritingCredits();
#else
String getWritingCredits();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getWriters() }
/// Get the list of writers (if present) from video info tag.
///
/// @return [list] List of writers
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
getWriters();
#else
std::vector<String> getWriters();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getGenre() }
/// To get the [Video Genre](https://en.wikipedia.org/wiki/Film_genre)
/// if available.
///
/// @return [string] Genre name
///
///
///-----------------------------------------------------------------------
/// @python_v20 Deprecated. Use **getGenres()** instead.
///
getGenre();
#else
String getGenre();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getGenres() }
/// Get the list of [Video Genres](https://en.wikipedia.org/wiki/Film_genre)
/// if available.
///
/// @return [list] List of genres
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
getGenres();
#else
std::vector<String> getGenres();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getTagLine() }
/// Get video tag line if available.
///
/// @return [string] Video tag line
///
///
///-----------------------------------------------------------------------
///
///
getTagLine();
#else
String getTagLine();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getPlotOutline() }
/// Get the outline plot of the video if present.
///
/// @return [string] Outline plot
///
///
///-----------------------------------------------------------------------
///
///
getPlotOutline();
#else
String getPlotOutline();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getPlot() }
/// Get the plot of the video if present.
///
/// @return [string] Plot
///
///
///-----------------------------------------------------------------------
///
///
getPlot();
#else
String getPlot();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getPictureURL() }
/// Get a picture URL of the video to show as screenshot.
///
/// @return [string] Picture URL
///
///
///-----------------------------------------------------------------------
///
///
getPictureURL();
#else
String getPictureURL();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getTitle() }
/// Get the video title.
///
/// @return [string] Video title
///
///
///-----------------------------------------------------------------------
///
///
getTitle();
#else
String getTitle();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getTVShowTitle() }
/// Get the video TV show title.
///
/// @return [string] TV show title
///
///
///-----------------------------------------------------------------------
/// @python_v17 New function added.
///
getTVShowTitle();
#else
String getTVShowTitle();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getMediaType() }
/// Get the media type of the video.
///
/// @return [string] media type
///
/// Available strings about media type for video:
/// | String | Description |
/// |---------------:|:--------------------------------------------------|
/// | video | For normal video
/// | set | For a selection of video
/// | musicvideo | To define it as music video
/// | movie | To define it as normal movie
/// | tvshow | If this is it defined as tvshow
/// | season | The type is used as a series season
/// | episode | The type is used as a series episode
///
///-----------------------------------------------------------------------
/// @python_v17 New function added.
///
getMediaType();
#else
String getMediaType();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getVotes() }
/// Get the video votes if available from video info tag.
///
/// @return [string] Votes
///
///
///-----------------------------------------------------------------------
/// @python_v20 Deprecated. Use **getVotesAsInt()** instead.
///
getVotes();
#else
String getVotes();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getVotesAsInt([type]) }
/// Get the votes of the rating (if available) as an integer.
///
/// @param type [opt] string - the type of the rating.
/// - Some rating type values (any string possible):
/// | Label | Type |
/// |---------------|--------------------------------------------------|
/// | imdb | string - type name
/// | tvdb | string - type name
/// | tmdb | string - type name
/// | anidb | string - type name
///
/// @return [integer] Votes
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
getVotesAsInt(type);
#else
int getVotesAsInt(const String& type = "");
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getCast() }
/// To get the cast of the video when available.
///
/// @return [string] Video casts
///
///
///-----------------------------------------------------------------------
/// @python_v20 Deprecated. Use **getActors()** instead.
///
getCast();
#else
String getCast();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getActors() }
/// Get the cast of the video if available.
///
/// @return [list] List of actors
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
getActors();
#else
std::vector<Actor*> getActors();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getFile() }
/// To get the video file name.
///
/// @return [string] File name
///
///
///-----------------------------------------------------------------------
///
///
getFile();
#else
String getFile();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getPath() }
/// To get the path where the video is stored.
///
/// @return [string] Path
///
///
///-----------------------------------------------------------------------
///
///
getPath();
#else
String getPath();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getFilenameAndPath() }
/// To get the full path with filename where the video is stored.
///
/// @return [string] File name and Path
///
///
///-----------------------------------------------------------------------
/// @python_v19 New function added.
///
getFilenameAndPath();
#else
String getFilenameAndPath();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getIMDBNumber() }
/// To get the [IMDb](https://en.wikipedia.org/wiki/Internet_Movie_Database)
/// number of the video (if present).
///
/// @return [string] IMDb number
///
///
///-----------------------------------------------------------------------
///
///
getIMDBNumber();
#else
String getIMDBNumber();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getSeason() }
/// To get season number of a series
///
/// @return [integer] season number
///
///
///-----------------------------------------------------------------------
/// @python_v17 New function added.
///
getSeason();
#else
int getSeason();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getEpisode() }
/// To get episode number of a series
///
/// @return [integer] episode number
///
///
///-----------------------------------------------------------------------
/// @python_v17 New function added.
///
getEpisode();
#else
int getEpisode();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getYear() }
/// Get production year of video if present.
///
/// @return [integer] Production Year
///
///
///-----------------------------------------------------------------------
///
///
getYear();
#else
int getYear();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getRating([type]) }
/// Get the video rating if present as float (double where supported).
///
/// @param type [opt] string - the type of the rating.
/// - Some rating type values (any string possible):
/// | Label | Type |
/// |---------------|--------------------------------------------------|
/// | imdb | string - type name
/// | tvdb | string - type name
/// | tmdb | string - type name
/// | anidb | string - type name
///
/// @return [float] The rating of the video
///
///
///-----------------------------------------------------------------------
/// @python_v20 Optional `type` parameter added.
///
getRating(type);
#else
double getRating(const String& type = "");
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getUserRating() }
/// Get the user rating if present as integer.
///
/// @return [integer] The user rating of the video
///
///
///-----------------------------------------------------------------------
///
///
getUserRating();
#else
int getUserRating();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getPlayCount() }
/// To get the number of plays of the video.
///
/// @return [integer] Play Count
///
///
///-----------------------------------------------------------------------
///
///
getPlayCount();
#else
int getPlayCount();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getLastPlayed() }
/// Get the last played date / time as string.
///
/// @return [string] Last played date / time
///
///
///-----------------------------------------------------------------------
/// @python_v20 Deprecated. Use **getLastPlayedAsW3C()** instead.
///
getLastPlayed();
#else
String getLastPlayed();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getLastPlayedAsW3C() }
/// Get last played datetime as string in W3C format (YYYY-MM-DDThh:mm:ssTZD).
///
/// @return [string] Last played datetime (W3C)
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
getLastPlayedAsW3C();
#else
String getLastPlayedAsW3C();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getOriginalTitle() }
/// To get the original title of the video.
///
/// @return [string] Original title
///
///
///-----------------------------------------------------------------------
///
///
getOriginalTitle();
#else
String getOriginalTitle();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getPremiered() }
/// To get [premiered](https://en.wikipedia.org/wiki/Premiere) date
/// of the video, if available.
///
/// @return [string]
///
///
///-----------------------------------------------------------------------
/// @python_v20 Deprecated. Use **getPremieredAsW3C()** instead.
///
getPremiered();
#else
String getPremiered();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getPremieredAsW3C() }
/// Get [premiered](https://en.wikipedia.org/wiki/Premiere) date as string in W3C format (YYYY-MM-DD).
///
/// @return [string] Premiered date (W3C)
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
getPremieredAsW3C();
#else
String getPremieredAsW3C();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getFirstAired() }
/// Returns first aired date as string from info tag.
///
/// @return [string] First aired date
///
///
///-----------------------------------------------------------------------
/// @python_v20 Deprecated. Use **getFirstAiredAsW3C()** instead.
///
getFirstAired();
#else
String getFirstAired();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getFirstAiredAsW3C() }
/// Get first aired date as string in W3C format (YYYY-MM-DD).
///
/// @return [string] First aired date (W3C)
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
getFirstAiredAsW3C();
#else
String getFirstAiredAsW3C();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getTrailer() }
/// To get the path where the trailer is stored.
///
/// @return [string] Trailer path
///
///
///-----------------------------------------------------------------------
/// @python_v17 New function added.
///
getTrailer();
#else
String getTrailer();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getArtist() }
/// To get the artist name (for musicvideos)
///
/// @return [std::vector<std::string>] Artist name
///
///
///-----------------------------------------------------------------------
/// @python_v18 New function added.
///
getArtist();
#else
std::vector<std::string> getArtist();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getAlbum() }
/// To get the album name (for musicvideos)
///
/// @return [string] Album name
///
///
///-----------------------------------------------------------------------
/// @python_v18 New function added.
///
getAlbum();
#else
String getAlbum();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getTrack() }
/// To get the track number (for musicvideos)
///
/// @return [int] Track number
///
///
///-----------------------------------------------------------------------
/// @python_v18 New function added.
///
getTrack();
#else
int getTrack();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getDuration() }
/// To get the duration
///
/// @return [unsigned int] Duration
///
///
///-----------------------------------------------------------------------
/// @python_v18 New function added.
///
getDuration();
#else
unsigned int getDuration();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getResumeTime()) }
/// Gets the resume time of the video item.
///
/// @return [double] Resume time
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
getResumeTime(...);
#else
double getResumeTime();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getResumeTimeTotal()) }
/// Gets the total duration stored with the resume time of the video item.
///
/// @return [double] Total duration stored with the resume time
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
getResumeTimeTotal(...);
#else
double getResumeTimeTotal();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ getUniqueID(key) }
/// Get the unique ID of the given key.
/// A unique ID is an identifier used by a (online) video database used to
/// identify a video in its database.
///
/// @param key string - uniqueID name.
/// - Some default uniqueID values (any string possible):
/// | Label | Type |
/// |---------------|--------------------------------------------------|
/// | imdb | string - uniqueid name
/// | tvdb | string - uniqueid name
/// | tmdb | string - uniqueid name
/// | anidb | string - uniqueid name
///
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
getUniqueID(key);
#else
String getUniqueID(const char* key);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setUniqueID(uniqueid, [type], [isdefault]) }
/// Set the given unique ID.
/// A unique ID is an identifier used by a (online) video database used to
/// identify a video in its database.
///
/// @param uniqueid string - value of the unique ID.
/// @param type [opt] string - type / label of the unique ID.
/// @param isdefault [opt] bool - whether the given unique ID is the default unique ID.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setUniqueID(...);
#else
void setUniqueID(const String& uniqueid, const String& type = "", bool isdefault = false);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setUniqueIDs(values, defaultuniqueid) }
/// Set the given unique IDs.
/// A unique ID is an identifier used by a (online) video database used to
/// identify a video in its database.
///
/// @param values dictionary - pairs of `{ 'label': 'value' }`.
/// @param defaultuniqueid [opt] string - the name of default uniqueID.
///
/// - Some example values (any string possible):
/// | Label | Type |
/// |:-------------:|:--------------------------------------------------|
/// | imdb | string - uniqueid name
/// | tvdb | string - uniqueid name
/// | tmdb | string - uniqueid name
/// | anidb | string - uniqueid name
///
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setUniqueIDs(...);
#else
void setUniqueIDs(const std::map<String, String>& uniqueIDs,
const String& defaultuniqueid = "");
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setDbId(dbid) }
/// Set the database identifier of the video item.
///
/// @param dbid integer - Database identifier.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setDbId(...);
#else
void setDbId(int dbid);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setYear(year) }
/// Set the year of the video item.
///
/// @param year integer - Year.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setYear(...);
#else
void setYear(int year);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setEpisode(episode) }
/// Set the episode number of the episode.
///
/// @param episode integer - Episode number.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setEpisode(...);
#else
void setEpisode(int episode);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setSeason(season) }
/// Set the season number of the video item.
///
/// @param season integer - Season number.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setSeason(...);
#else
void setSeason(int season);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setSortEpisode(sortepisode) }
/// Set the episode sort number of the episode.
///
/// @param sortepisode integer - Episode sort number.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setSortEpisode(...);
#else
void setSortEpisode(int sortepisode);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setSortSeason(sortseason) }
/// Set the season sort number of the season.
///
/// @param sortseason integer - Season sort number.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setSortSeason(...);
#else
void setSortSeason(int sortseason);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setEpisodeGuide(episodeguide) }
/// Set the episode guide of the video item.
///
/// @param episodeguide string - Episode guide.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setEpisodeGuide(...);
#else
void setEpisodeGuide(const String& episodeguide);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setTop250(top250) }
/// Set the top 250 number of the video item.
///
/// @param top250 integer - Top 250 number.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setTop250(...);
#else
void setTop250(int top250);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setSetId(setid) }
/// Set the movie set identifier of the video item.
///
/// @param setid integer - Set identifier.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setSetId(...);
#else
void setSetId(int setid);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setTrackNumber(tracknumber) }
/// Set the track number of the music video item.
///
/// @param tracknumber integer - Track number.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setTrackNumber(...);
#else
void setTrackNumber(int tracknumber);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setRating(rating, [votes], [type], [isdefault]) }
/// Set the rating of the video item.
///
/// @param rating float - Rating number.
/// @param votes integer - Number of votes.
/// @param type string - Type of the rating.
/// @param isdefault bool - Whether the rating is the default or not.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setRating(...);
#else
void setRating(float rating, int votes = 0, const String& type = "", bool isdefault = false);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setRatings(ratings, [defaultrating]) }
/// Set the ratings of the video item.
///
/// @param ratings dictionary - `{ 'type': (rating, votes) }`.
/// @param defaultrating string - Type / Label of the default rating.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setRatings(...);
#else
void setRatings(const std::map<String, Tuple<float, int>>& ratings,
const String& defaultrating = "");
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setUserRating(userrating) }
/// Set the user rating of the video item.
///
/// @param userrating integer - User rating.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setUserRating(...);
#else
void setUserRating(int userrating);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setPlaycount(playcount) }
/// Set the playcount of the video item.
///
/// @param playcount integer - Playcount.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setPlaycount(...);
#else
void setPlaycount(int playcount);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setMpaa(mpaa) }
/// Set the MPAA rating of the video item.
///
/// @param mpaa string - MPAA rating.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setMpaa(...);
#else
void setMpaa(const String& mpaa);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setPlot(plot) }
/// Set the plot of the video item.
///
/// @param plot string - Plot.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setPlot(...);
#else
void setPlot(const String& plot);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setPlotOutline(plotoutline) }
/// Set the plot outline of the video item.
///
/// @param plotoutline string - Plot outline.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setPlotOutline(...);
#else
void setPlotOutline(const String& plotoutline);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setTitle(title) }
/// Set the title of the video item.
///
/// @param title string - Title.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setTitle(...);
#else
void setTitle(const String& title);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setOriginalTitle(originaltitle) }
/// Set the original title of the video item.
///
/// @param originaltitle string - Original title.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setOriginalTitle(...);
#else
void setOriginalTitle(const String& originaltitle);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setSortTitle(sorttitle) }
/// Set the sort title of the video item.
///
/// @param sorttitle string - Sort title.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setSortTitle(...);
#else
void setSortTitle(const String& sorttitle);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setTagLine(tagline) }
/// Set the tagline of the video item.
///
/// @param tagline string - Tagline.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setTagLine(...);
#else
void setTagLine(const String& tagline);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setTvShowTitle(tvshowtitle) }
/// Set the TV show title of the video item.
///
/// @param tvshowtitle string - TV show title.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setTvShowTitle(...);
#else
void setTvShowTitle(const String& tvshowtitle);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setTvShowStatus(tvshowstatus) }
/// Set the TV show status of the video item.
///
/// @param status string - TV show status.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setTvShowStatus(...);
#else
void setTvShowStatus(const String& status);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setGenres(genre) }
/// Set the genres of the video item.
///
/// @param genre list - Genres.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setGenres(...);
#else
void setGenres(std::vector<String> genre);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setCountries(countries) }
/// Set the countries of the video item.
///
/// @param countries list - Countries.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setCountries(...);
#else
void setCountries(std::vector<String> countries);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setDirectors(directors) }
/// Set the directors of the video item.
///
/// @param directors list - Directors.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setDirectors(...);
#else
void setDirectors(std::vector<String> directors);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setStudios(studios) }
/// Set the studios of the video item.
///
/// @param studios list - Studios.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setStudios(...);
#else
void setStudios(std::vector<String> studios);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setWriters(writers) }
/// Set the writers of the video item.
///
/// @param writers list - Writers.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setWriters(...);
#else
void setWriters(std::vector<String> writers);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setDuration(duration) }
/// Set the duration of the video item.
///
/// @param duration integer - Duration in seconds.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setDuration(...);
#else
void setDuration(int duration);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setPremiered(premiered) }
/// Set the premiere date of the video item.
///
/// @param premiered string - Premiere date.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setPremiered(...);
#else
void setPremiered(const String& premiered);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setSet(set) }
/// Set the movie set (name) of the video item.
///
/// @param set string - Movie set (name).
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setSet(...);
#else
void setSet(const String& set);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setSetOverview(setoverview) }
/// Set the movie set overview of the video item.
///
/// @param setoverview string - Movie set overview.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setSetOverview(...);
#else
void setSetOverview(const String& setoverview);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setTags(tags) }
/// Set the tags of the video item.
///
/// @param tags list - Tags.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setTags(...);
#else
void setTags(std::vector<String> tags);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setProductionCode(const String& productioncode) }
/// Set the production code of the video item.
///
/// @param productioncode string - Production code.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setProductionCode(...);
#else
void setProductionCode(const String& productioncode);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setFirstAired(firstaired) }
/// Set the first aired date of the video item.
///
/// @param firstaired string - First aired date.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setFirstAired(...);
#else
void setFirstAired(const String& firstaired);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setLastPlayed(lastplayed) }
/// Set the last played date of the video item.
///
/// @param lastplayed string - Last played date (YYYY-MM-DD HH:MM:SS).
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setLastPlayed(...);
#else
void setLastPlayed(const String& lastplayed);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setAlbum(album) }
/// Set the album of the video item.
///
/// @param album string - Album.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setAlbum(...);
#else
void setAlbum(const String& album);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setVotes(votes) }
/// Set the number of votes of the video item.
///
/// @param votes integer - Number of votes.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setVotes(...);
#else
void setVotes(int votes);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setTrailer(trailer) }
/// Set the trailer of the video item.
///
/// @param trailer string - Trailer.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setTrailer(...);
#else
void setTrailer(const String& trailer);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setPath(path) }
/// Set the path of the video item.
///
/// @param path string - Path.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setPath(...);
#else
void setPath(const String& path);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setFilenameAndPath(filenameandpath) }
/// Set the filename and path of the video item.
///
/// @param filenameandpath string - Filename and path.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setFilenameAndPath(...);
#else
void setFilenameAndPath(const String& filenameandpath);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setIMDBNumber(imdbnumber) }
/// Set the IMDb number of the video item.
///
/// @param imdbnumber string - IMDb number.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setIMDBNumber(...);
#else
void setIMDBNumber(const String& imdbnumber);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setDateAdded(dateadded) }
/// Set the date added of the video item.
///
/// @param dateadded string - Date added (YYYY-MM-DD HH:MM:SS).
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setDateAdded(...);
#else
void setDateAdded(const String& dateadded);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setMediaType(mediatype) }
/// Set the media type of the video item.
///
/// @param mediatype string - Media type.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setMediaType(...);
#else
void setMediaType(const String& mediatype);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setShowLinks(showlinks) }
/// Set the TV show links of the movie.
///
/// @param showlinks list - TV show links.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setShowLinks(...);
#else
void setShowLinks(std::vector<String> showlinks);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setArtists(artists) }
/// Set the artists of the music video item.
///
/// @param artists list - Artists.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setArtists(...);
#else
void setArtists(std::vector<String> artists);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setCast(actors) }
/// Set the cast / actors of the video item.
///
/// @param actors list - Cast / Actors.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setCast(...);
#else
void setCast(const std::vector<const Actor*>& actors);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ setResumePoint(time, [totaltime]) }
/// Set the resume point of the video item.
///
/// @param time float - Resume point in seconds.
/// @param totaltime float - Total duration in seconds.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setResumePoint(...);
#else
void setResumePoint(double time, double totaltime = 0.0);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ addSeason(number, [name]) }
/// Add a season with name. It needs at least the season number.
///
/// @param number int - the number of the season.
/// @param name string - the name of the season. Default "".
///
///
///-----------------------------------------------------------------------
///
/// @python_v20 New function added.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ...
/// # addSeason(number, name))
/// infotagvideo.addSeason(1, "Murder House")
/// ...
/// ~~~~~~~~~~~~~
///
addSeason(...);
#else
void addSeason(int number, std::string name = "");
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ addSeasons(namedseasons) }
/// Add named seasons to the TV show.
///
/// @param namedseasons list - `[ (season, name) ]`.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
addSeasons(...);
#else
void addSeasons(const std::vector<Tuple<int, std::string>>& namedseasons);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ addVideoStream(stream) }
/// Add a video stream to the video item.
///
/// @param stream VideoStreamDetail - Video stream.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
addVideoStream(...);
#else
void addVideoStream(const VideoStreamDetail* stream);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ addAudioStream(stream) }
/// Add an audio stream to the video item.
///
/// @param stream AudioStreamDetail - Audio stream.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
addAudioStream(...);
#else
void addAudioStream(const AudioStreamDetail* stream);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ addSubtitleStream(stream) }
/// Add a subtitle stream to the video item.
///
/// @param stream SubtitleStreamDetail - Subtitle stream.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
addSubtitleStream(...);
#else
void addSubtitleStream(const SubtitleStreamDetail* stream);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagVideo
/// @brief \python_func{ addAvailableArtwork(images) }
/// Add an image to available artworks (needed for video scrapers)
///
/// @param url string - image path url
/// @param arttype string - image type
/// @param preview [opt] string - image preview path url
/// @param referrer [opt] string - referrer url
/// @param cache [opt] string - filename in cache
/// @param post [opt] bool - use post to retrieve the image (default false)
/// @param isgz [opt] bool - use gzip to retrieve the image (default false)
/// @param season [opt] integer - number of season in case of season thumb
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ...
/// infotagvideo.addAvailableArtwork(path_to_image_1, "thumb")
/// ...
/// ~~~~~~~~~~~~~
///
addAvailableArtwork(...);
#else
void addAvailableArtwork(const std::string& url,
const std::string& arttype = "",
const std::string& preview = "",
const std::string& referrer = "",
const std::string& cache = "",
bool post = false,
bool isgz = false,
int season = -1);
#endif
/// @}
#ifndef SWIG
static void setDbIdRaw(CVideoInfoTag* infoTag, int dbId);
static void setUniqueIDRaw(CVideoInfoTag* infoTag,
const String& uniqueID,
const String& type = "",
bool isDefault = false);
static void setUniqueIDsRaw(CVideoInfoTag* infoTag,
std::map<String, String> uniqueIDs,
const String& defaultUniqueID = "");
static void setYearRaw(CVideoInfoTag* infoTag, int year);
static void setEpisodeRaw(CVideoInfoTag* infoTag, int episode);
static void setSeasonRaw(CVideoInfoTag* infoTag, int season);
static void setSortEpisodeRaw(CVideoInfoTag* infoTag, int sortEpisode);
static void setSortSeasonRaw(CVideoInfoTag* infoTag, int sortSeason);
static void setEpisodeGuideRaw(CVideoInfoTag* infoTag, const String& episodeGuide);
static void setTop250Raw(CVideoInfoTag* infoTag, int top250);
static void setSetIdRaw(CVideoInfoTag* infoTag, int setId);
static void setTrackNumberRaw(CVideoInfoTag* infoTag, int trackNumber);
static void setRatingRaw(CVideoInfoTag* infoTag,
float rating,
int votes = 0,
const std::string& type = "",
bool isDefault = false);
static void setRatingsRaw(CVideoInfoTag* infoTag,
const std::map<String, Tuple<float, int>>& ratings,
const String& defaultRating = "");
static void setUserRatingRaw(CVideoInfoTag* infoTag, int userRating);
static void setPlaycountRaw(CVideoInfoTag* infoTag, int playcount);
static void setMpaaRaw(CVideoInfoTag* infoTag, const String& mpaa);
static void setPlotRaw(CVideoInfoTag* infoTag, const String& plot);
static void setPlotOutlineRaw(CVideoInfoTag* infoTag, const String& plotOutline);
static void setTitleRaw(CVideoInfoTag* infoTag, const String& title);
static void setOriginalTitleRaw(CVideoInfoTag* infoTag, const String& originalTitle);
static void setSortTitleRaw(CVideoInfoTag* infoTag, const String& sortTitle);
static void setTagLineRaw(CVideoInfoTag* infoTag, const String& tagLine);
static void setTvShowTitleRaw(CVideoInfoTag* infoTag, const String& tvshowTitle);
static void setTvShowStatusRaw(CVideoInfoTag* infoTag, const String& tvshowStatus);
static void setGenresRaw(CVideoInfoTag* infoTag, std::vector<String> genre);
static void setCountriesRaw(CVideoInfoTag* infoTag, std::vector<String> countries);
static void setDirectorsRaw(CVideoInfoTag* infoTag, std::vector<String> directors);
static void setStudiosRaw(CVideoInfoTag* infoTag, std::vector<String> studios);
static void setWritersRaw(CVideoInfoTag* infoTag, std::vector<String> writers);
static void setDurationRaw(CVideoInfoTag* infoTag, int duration);
static void setPremieredRaw(CVideoInfoTag* infoTag, const String& premiered);
static void setSetRaw(CVideoInfoTag* infoTag, const String& set);
static void setSetOverviewRaw(CVideoInfoTag* infoTag, const String& setOverview);
static void setTagsRaw(CVideoInfoTag* infoTag, std::vector<String> tags);
static void setProductionCodeRaw(CVideoInfoTag* infoTag, const String& productionCode);
static void setFirstAiredRaw(CVideoInfoTag* infoTag, const String& firstAired);
static void setLastPlayedRaw(CVideoInfoTag* infoTag, const String& lastPlayed);
static void setAlbumRaw(CVideoInfoTag* infoTag, const String& album);
static void setVotesRaw(CVideoInfoTag* infoTag, int votes);
static void setTrailerRaw(CVideoInfoTag* infoTag, const String& trailer);
static void setPathRaw(CVideoInfoTag* infoTag, const String& path);
static void setFilenameAndPathRaw(CVideoInfoTag* infoTag, const String& filenameAndPath);
static void setIMDBNumberRaw(CVideoInfoTag* infoTag, const String& imdbNumber);
static void setDateAddedRaw(CVideoInfoTag* infoTag, const String& dateAdded);
static void setMediaTypeRaw(CVideoInfoTag* infoTag, const String& mediaType);
static void setShowLinksRaw(CVideoInfoTag* infoTag, std::vector<String> showLinks);
static void setArtistsRaw(CVideoInfoTag* infoTag, std::vector<String> artists);
static void setCastRaw(CVideoInfoTag* infoTag, std::vector<SActorInfo> cast);
static void setResumePointRaw(CVideoInfoTag* infoTag, double time, double totalTime = 0.0);
static void addSeasonRaw(CVideoInfoTag* infoTag, int number, std::string name = "");
static void addSeasonsRaw(CVideoInfoTag* infoTag,
const std::vector<Tuple<int, std::string>>& namedSeasons);
static void addStreamRaw(CVideoInfoTag* infoTag, CStreamDetail* stream);
static void finalizeStreamsRaw(CVideoInfoTag* infoTag);
static void addAvailableArtworkRaw(CVideoInfoTag* infoTag,
const std::string& url,
const std::string& art_type = "",
const std::string& preview = "",
const std::string& referrer = "",
const std::string& cache = "",
bool post = false,
bool isgz = false,
int season = -1);
#endif
};
}
}
|