/usr/share/doc/libcsfml-doc/html/Music_8h.htm is in libcsfml-doc 2.3-3.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>CSFML - C binding of the Simple and Fast Multimedia Library</title>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"/>
<link rel="stylesheet" type="text/css" href="doxygen.css" title="default" media="screen,print" />
</head>
<body>
<div id="banner-container">
<div id="banner">
<span id="sfml">CSFML</span>
</div>
</div>
<div id="content">
<!-- Generated by Doxygen 1.8.11 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.htm"><span>Main Page</span></a></li>
<li><a href="annotated.htm"><span>Data Structures</span></a></li>
<li class="current"><a href="files.htm"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.htm"><span>File List</span></a></li>
<li><a href="globals.htm"><span>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.htm">include</a></li><li class="navelem"><a class="el" href="dir_c0a853e81d6f1c1f0a3eb7a27dc24256.htm">SFML</a></li><li class="navelem"><a class="el" href="dir_dd49ddb3ba8035e4a328f8c5f31cda7e.htm">Audio</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Music.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include <<a class="el" href="Audio_2Export_8h_source.htm">SFML/Audio/Export.h</a>></code><br />
<code>#include <<a class="el" href="SoundStatus_8h_source.htm">SFML/Audio/SoundStatus.h</a>></code><br />
<code>#include <<a class="el" href="Audio_2Types_8h_source.htm">SFML/Audio/Types.h</a>></code><br />
<code>#include <<a class="el" href="InputStream_8h_source.htm">SFML/System/InputStream.h</a>></code><br />
<code>#include <<a class="el" href="Time_8h_source.htm">SFML/System/Time.h</a>></code><br />
<code>#include <<a class="el" href="Vector3_8h_source.htm">SFML/System/Vector3.h</a>></code><br />
<code>#include <stddef.h></code><br />
</div>
<p><a href="Music_8h_source.htm">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ac6a0d8669cd02bc03634f59325a4f582"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> <a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="Music_8h.htm#ac6a0d8669cd02bc03634f59325a4f582">sfMusic_createFromFile</a> (const char *filename)</td></tr>
<tr class="memdesc:ac6a0d8669cd02bc03634f59325a4f582"><td class="mdescLeft"> </td><td class="mdescRight">Create a new music and load it from a file. <a href="#ac6a0d8669cd02bc03634f59325a4f582">More...</a><br /></td></tr>
<tr class="separator:ac6a0d8669cd02bc03634f59325a4f582"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a88ee84132daf826b663ded100cb30bad"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> <a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="Music_8h.htm#a88ee84132daf826b663ded100cb30bad">sfMusic_createFromMemory</a> (const void *data, size_t sizeInBytes)</td></tr>
<tr class="memdesc:a88ee84132daf826b663ded100cb30bad"><td class="mdescLeft"> </td><td class="mdescRight">Create a new music and load it from a file in memory. <a href="#a88ee84132daf826b663ded100cb30bad">More...</a><br /></td></tr>
<tr class="separator:a88ee84132daf826b663ded100cb30bad"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac2a49e8ab8a918832f4b00c384819085"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> <a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="Music_8h.htm#ac2a49e8ab8a918832f4b00c384819085">sfMusic_createFromStream</a> (<a class="el" href="structsfInputStream.htm">sfInputStream</a> *stream)</td></tr>
<tr class="memdesc:ac2a49e8ab8a918832f4b00c384819085"><td class="mdescLeft"> </td><td class="mdescRight">Create a new music and load it from a custom stream. <a href="#ac2a49e8ab8a918832f4b00c384819085">More...</a><br /></td></tr>
<tr class="separator:ac2a49e8ab8a918832f4b00c384819085"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae29136139432f4e5157dc99655665a55"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="Music_8h.htm#ae29136139432f4e5157dc99655665a55">sfMusic_destroy</a> (<a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> *music)</td></tr>
<tr class="memdesc:ae29136139432f4e5157dc99655665a55"><td class="mdescLeft"> </td><td class="mdescRight">Destroy a music. <a href="#ae29136139432f4e5157dc99655665a55">More...</a><br /></td></tr>
<tr class="separator:ae29136139432f4e5157dc99655665a55"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a30d181ea36bb17e42807bd1d40e10e52"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="Music_8h.htm#a30d181ea36bb17e42807bd1d40e10e52">sfMusic_setLoop</a> (<a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> *music, <a class="el" href="Config_8h.htm#a7559f07a31bb3a4a3d865178ce4dc70b">sfBool</a> loop)</td></tr>
<tr class="memdesc:a30d181ea36bb17e42807bd1d40e10e52"><td class="mdescLeft"> </td><td class="mdescRight">Set whether or not a music should loop after reaching the end. <a href="#a30d181ea36bb17e42807bd1d40e10e52">More...</a><br /></td></tr>
<tr class="separator:a30d181ea36bb17e42807bd1d40e10e52"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3c9e254803d15f93d4d8b8ec8f554dc1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> <a class="el" href="Config_8h.htm#a7559f07a31bb3a4a3d865178ce4dc70b">sfBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="Music_8h.htm#a3c9e254803d15f93d4d8b8ec8f554dc1">sfMusic_getLoop</a> (const <a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> *music)</td></tr>
<tr class="memdesc:a3c9e254803d15f93d4d8b8ec8f554dc1"><td class="mdescLeft"> </td><td class="mdescRight">Tell whether or not a music is in loop mode. <a href="#a3c9e254803d15f93d4d8b8ec8f554dc1">More...</a><br /></td></tr>
<tr class="separator:a3c9e254803d15f93d4d8b8ec8f554dc1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9d63be17a0f39136bc9cd34bbc80bede"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> <a class="el" href="structsfTime.htm">sfTime</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="Music_8h.htm#a9d63be17a0f39136bc9cd34bbc80bede">sfMusic_getDuration</a> (const <a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> *music)</td></tr>
<tr class="memdesc:a9d63be17a0f39136bc9cd34bbc80bede"><td class="mdescLeft"> </td><td class="mdescRight">Get the total duration of a music. <a href="#a9d63be17a0f39136bc9cd34bbc80bede">More...</a><br /></td></tr>
<tr class="separator:a9d63be17a0f39136bc9cd34bbc80bede"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a18019593c074028266db0c48c1caad82"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="Music_8h.htm#a18019593c074028266db0c48c1caad82">sfMusic_play</a> (<a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> *music)</td></tr>
<tr class="memdesc:a18019593c074028266db0c48c1caad82"><td class="mdescLeft"> </td><td class="mdescRight">Start or resume playing a music. <a href="#a18019593c074028266db0c48c1caad82">More...</a><br /></td></tr>
<tr class="separator:a18019593c074028266db0c48c1caad82"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ace02cea38831f925f972b7795c1a930c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="Music_8h.htm#ace02cea38831f925f972b7795c1a930c">sfMusic_pause</a> (<a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> *music)</td></tr>
<tr class="memdesc:ace02cea38831f925f972b7795c1a930c"><td class="mdescLeft"> </td><td class="mdescRight">Pause a music. <a href="#ace02cea38831f925f972b7795c1a930c">More...</a><br /></td></tr>
<tr class="separator:ace02cea38831f925f972b7795c1a930c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0230956eb600e4b1ca3808d149d3d007"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="Music_8h.htm#a0230956eb600e4b1ca3808d149d3d007">sfMusic_stop</a> (<a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> *music)</td></tr>
<tr class="memdesc:a0230956eb600e4b1ca3808d149d3d007"><td class="mdescLeft"> </td><td class="mdescRight">Stop playing a music. <a href="#a0230956eb600e4b1ca3808d149d3d007">More...</a><br /></td></tr>
<tr class="separator:a0230956eb600e4b1ca3808d149d3d007"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a75c5dc3bbd1138bfec0f5535d9055fd7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="Music_8h.htm#a75c5dc3bbd1138bfec0f5535d9055fd7">sfMusic_getChannelCount</a> (const <a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> *music)</td></tr>
<tr class="memdesc:a75c5dc3bbd1138bfec0f5535d9055fd7"><td class="mdescLeft"> </td><td class="mdescRight">Return the number of channels of a music. <a href="#a75c5dc3bbd1138bfec0f5535d9055fd7">More...</a><br /></td></tr>
<tr class="separator:a75c5dc3bbd1138bfec0f5535d9055fd7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a093cc8d8ae51a02c5c7753f90b2bae8b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="Music_8h.htm#a093cc8d8ae51a02c5c7753f90b2bae8b">sfMusic_getSampleRate</a> (const <a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> *music)</td></tr>
<tr class="memdesc:a093cc8d8ae51a02c5c7753f90b2bae8b"><td class="mdescLeft"> </td><td class="mdescRight">Get the sample rate of a music. <a href="#a093cc8d8ae51a02c5c7753f90b2bae8b">More...</a><br /></td></tr>
<tr class="separator:a093cc8d8ae51a02c5c7753f90b2bae8b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af87c545f32ca4a7b07aad6a9fc332839"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> <a class="el" href="SoundStatus_8h.htm#af27f85d8d7194f78432ff631bafae4ad">sfSoundStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="Music_8h.htm#af87c545f32ca4a7b07aad6a9fc332839">sfMusic_getStatus</a> (const <a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> *music)</td></tr>
<tr class="memdesc:af87c545f32ca4a7b07aad6a9fc332839"><td class="mdescLeft"> </td><td class="mdescRight">Get the current status of a music (stopped, paused, playing) <a href="#af87c545f32ca4a7b07aad6a9fc332839">More...</a><br /></td></tr>
<tr class="separator:af87c545f32ca4a7b07aad6a9fc332839"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa86edae4c0ae36c46d723862da1babae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> <a class="el" href="structsfTime.htm">sfTime</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="Music_8h.htm#aa86edae4c0ae36c46d723862da1babae">sfMusic_getPlayingOffset</a> (const <a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> *music)</td></tr>
<tr class="memdesc:aa86edae4c0ae36c46d723862da1babae"><td class="mdescLeft"> </td><td class="mdescRight">Get the current playing position of a music. <a href="#aa86edae4c0ae36c46d723862da1babae">More...</a><br /></td></tr>
<tr class="separator:aa86edae4c0ae36c46d723862da1babae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2dedcbfc4683823355725303d240205b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="Music_8h.htm#a2dedcbfc4683823355725303d240205b">sfMusic_setPitch</a> (<a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> *music, float pitch)</td></tr>
<tr class="memdesc:a2dedcbfc4683823355725303d240205b"><td class="mdescLeft"> </td><td class="mdescRight">Set the pitch of a music. <a href="#a2dedcbfc4683823355725303d240205b">More...</a><br /></td></tr>
<tr class="separator:a2dedcbfc4683823355725303d240205b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a435ee18b345211d8ff5b715a5e8f52b8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="Music_8h.htm#a435ee18b345211d8ff5b715a5e8f52b8">sfMusic_setVolume</a> (<a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> *music, float volume)</td></tr>
<tr class="memdesc:a435ee18b345211d8ff5b715a5e8f52b8"><td class="mdescLeft"> </td><td class="mdescRight">Set the volume of a music. <a href="#a435ee18b345211d8ff5b715a5e8f52b8">More...</a><br /></td></tr>
<tr class="separator:a435ee18b345211d8ff5b715a5e8f52b8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae4d45895b309eed905fb18ee987b05c8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="Music_8h.htm#ae4d45895b309eed905fb18ee987b05c8">sfMusic_setPosition</a> (<a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> *music, <a class="el" href="structsfVector3f.htm">sfVector3f</a> position)</td></tr>
<tr class="memdesc:ae4d45895b309eed905fb18ee987b05c8"><td class="mdescLeft"> </td><td class="mdescRight">Set the 3D position of a music in the audio scene. <a href="#ae4d45895b309eed905fb18ee987b05c8">More...</a><br /></td></tr>
<tr class="separator:ae4d45895b309eed905fb18ee987b05c8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8e3d9521ff47c053a7273f7106276962"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="Music_8h.htm#a8e3d9521ff47c053a7273f7106276962">sfMusic_setRelativeToListener</a> (<a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> *music, <a class="el" href="Config_8h.htm#a7559f07a31bb3a4a3d865178ce4dc70b">sfBool</a> relative)</td></tr>
<tr class="memdesc:a8e3d9521ff47c053a7273f7106276962"><td class="mdescLeft"> </td><td class="mdescRight">Make a musics's position relative to the listener or absolute. <a href="#a8e3d9521ff47c053a7273f7106276962">More...</a><br /></td></tr>
<tr class="separator:a8e3d9521ff47c053a7273f7106276962"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac192556b117b7903e4dcf3f7387b439e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="Music_8h.htm#ac192556b117b7903e4dcf3f7387b439e">sfMusic_setMinDistance</a> (<a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> *music, float distance)</td></tr>
<tr class="memdesc:ac192556b117b7903e4dcf3f7387b439e"><td class="mdescLeft"> </td><td class="mdescRight">Set the minimum distance of a music. <a href="#ac192556b117b7903e4dcf3f7387b439e">More...</a><br /></td></tr>
<tr class="separator:ac192556b117b7903e4dcf3f7387b439e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2d667140787382b9442d4b2433d465fe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="Music_8h.htm#a2d667140787382b9442d4b2433d465fe">sfMusic_setAttenuation</a> (<a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> *music, float attenuation)</td></tr>
<tr class="memdesc:a2d667140787382b9442d4b2433d465fe"><td class="mdescLeft"> </td><td class="mdescRight">Set the attenuation factor of a music. <a href="#a2d667140787382b9442d4b2433d465fe">More...</a><br /></td></tr>
<tr class="separator:a2d667140787382b9442d4b2433d465fe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a437a4cb64457d7c17af6a29706a180b2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="Music_8h.htm#a437a4cb64457d7c17af6a29706a180b2">sfMusic_setPlayingOffset</a> (<a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> *music, <a class="el" href="structsfTime.htm">sfTime</a> timeOffset)</td></tr>
<tr class="memdesc:a437a4cb64457d7c17af6a29706a180b2"><td class="mdescLeft"> </td><td class="mdescRight">Change the current playing position of a music. <a href="#a437a4cb64457d7c17af6a29706a180b2">More...</a><br /></td></tr>
<tr class="separator:a437a4cb64457d7c17af6a29706a180b2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad15fb2652bbbd395f0ff2825a98e81cf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> float </td><td class="memItemRight" valign="bottom"><a class="el" href="Music_8h.htm#ad15fb2652bbbd395f0ff2825a98e81cf">sfMusic_getPitch</a> (const <a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> *music)</td></tr>
<tr class="memdesc:ad15fb2652bbbd395f0ff2825a98e81cf"><td class="mdescLeft"> </td><td class="mdescRight">Get the pitch of a music. <a href="#ad15fb2652bbbd395f0ff2825a98e81cf">More...</a><br /></td></tr>
<tr class="separator:ad15fb2652bbbd395f0ff2825a98e81cf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aee0aae7d733240b5fd56e49ac36b55e2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> float </td><td class="memItemRight" valign="bottom"><a class="el" href="Music_8h.htm#aee0aae7d733240b5fd56e49ac36b55e2">sfMusic_getVolume</a> (const <a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> *music)</td></tr>
<tr class="memdesc:aee0aae7d733240b5fd56e49ac36b55e2"><td class="mdescLeft"> </td><td class="mdescRight">Get the volume of a music. <a href="#aee0aae7d733240b5fd56e49ac36b55e2">More...</a><br /></td></tr>
<tr class="separator:aee0aae7d733240b5fd56e49ac36b55e2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a744c0513bdadd03b298cc48dfc4d85c6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> <a class="el" href="structsfVector3f.htm">sfVector3f</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="Music_8h.htm#a744c0513bdadd03b298cc48dfc4d85c6">sfMusic_getPosition</a> (const <a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> *music)</td></tr>
<tr class="memdesc:a744c0513bdadd03b298cc48dfc4d85c6"><td class="mdescLeft"> </td><td class="mdescRight">Get the 3D position of a music in the audio scene. <a href="#a744c0513bdadd03b298cc48dfc4d85c6">More...</a><br /></td></tr>
<tr class="separator:a744c0513bdadd03b298cc48dfc4d85c6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3e6552b06bc662a544ff236fc0f8071f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> <a class="el" href="Config_8h.htm#a7559f07a31bb3a4a3d865178ce4dc70b">sfBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="Music_8h.htm#a3e6552b06bc662a544ff236fc0f8071f">sfMusic_isRelativeToListener</a> (const <a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> *music)</td></tr>
<tr class="memdesc:a3e6552b06bc662a544ff236fc0f8071f"><td class="mdescLeft"> </td><td class="mdescRight">Tell whether a music's position is relative to the listener or is absolute. <a href="#a3e6552b06bc662a544ff236fc0f8071f">More...</a><br /></td></tr>
<tr class="separator:a3e6552b06bc662a544ff236fc0f8071f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af50a57c3416970eb6ba3ab55fb7d563d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> float </td><td class="memItemRight" valign="bottom"><a class="el" href="Music_8h.htm#af50a57c3416970eb6ba3ab55fb7d563d">sfMusic_getMinDistance</a> (const <a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> *music)</td></tr>
<tr class="memdesc:af50a57c3416970eb6ba3ab55fb7d563d"><td class="mdescLeft"> </td><td class="mdescRight">Get the minimum distance of a music. <a href="#af50a57c3416970eb6ba3ab55fb7d563d">More...</a><br /></td></tr>
<tr class="separator:af50a57c3416970eb6ba3ab55fb7d563d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7abd666296de4054711ee7286f73da50"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> float </td><td class="memItemRight" valign="bottom"><a class="el" href="Music_8h.htm#a7abd666296de4054711ee7286f73da50">sfMusic_getAttenuation</a> (const <a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> *music)</td></tr>
<tr class="memdesc:a7abd666296de4054711ee7286f73da50"><td class="mdescLeft"> </td><td class="mdescRight">Get the attenuation factor of a music. <a href="#a7abd666296de4054711ee7286f73da50">More...</a><br /></td></tr>
<tr class="separator:a7abd666296de4054711ee7286f73da50"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ac6a0d8669cd02bc03634f59325a4f582"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> <a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a>* sfMusic_createFromFile </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>filename</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new music and load it from a file. </p>
<p>This function doesn't start playing the music (call sfMusic_play to do so). Here is a complete list of all the supported audio formats: ogg, wav, flac, aiff, au, raw, paf, svx, nist, voc, ircam, w64, mat4, mat5 pvf, htk, sds, avr, sd2, caf, wve, mpc2k, rf64.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filename</td><td>Path of the music file to open</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A new sfMusic object (NULL if failed) </dd></dl>
</div>
</div>
<a class="anchor" id="a88ee84132daf826b663ded100cb30bad"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> <a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a>* sfMusic_createFromMemory </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>sizeInBytes</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new music and load it from a file in memory. </p>
<p>This function doesn't start playing the music (call sfMusic_play to do so). Here is a complete list of all the supported audio formats: ogg, wav, flac, aiff, au, raw, paf, svx, nist, voc, ircam, w64, mat4, mat5 pvf, htk, sds, avr, sd2, caf, wve, mpc2k, rf64.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>Pointer to the file data in memory </td></tr>
<tr><td class="paramname">sizeInBytes</td><td>Size of the data to load, in bytes</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A new sfMusic object (NULL if failed) </dd></dl>
</div>
</div>
<a class="anchor" id="ac2a49e8ab8a918832f4b00c384819085"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> <a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a>* sfMusic_createFromStream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structsfInputStream.htm">sfInputStream</a> * </td>
<td class="paramname"><em>stream</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new music and load it from a custom stream. </p>
<p>This function doesn't start playing the music (call sfMusic_play to do so). Here is a complete list of all the supported audio formats: ogg, wav, flac, aiff, au, raw, paf, svx, nist, voc, ircam, w64, mat4, mat5 pvf, htk, sds, avr, sd2, caf, wve, mpc2k, rf64.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">stream</td><td>Source stream to read from</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A new sfMusic object (NULL if failed) </dd></dl>
</div>
</div>
<a class="anchor" id="ae29136139432f4e5157dc99655665a55"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> void sfMusic_destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> * </td>
<td class="paramname"><em>music</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy a music. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">music</td><td>Music to destroy </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a7abd666296de4054711ee7286f73da50"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> float sfMusic_getAttenuation </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> * </td>
<td class="paramname"><em>music</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the attenuation factor of a music. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">music</td><td>Music object</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Attenuation factor of the music </dd></dl>
</div>
</div>
<a class="anchor" id="a75c5dc3bbd1138bfec0f5535d9055fd7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> unsigned int sfMusic_getChannelCount </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> * </td>
<td class="paramname"><em>music</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the number of channels of a music. </p>
<p>1 channel means a mono sound, 2 means stereo, etc.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">music</td><td>Music object</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Number of channels </dd></dl>
</div>
</div>
<a class="anchor" id="a9d63be17a0f39136bc9cd34bbc80bede"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> <a class="el" href="structsfTime.htm">sfTime</a> sfMusic_getDuration </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> * </td>
<td class="paramname"><em>music</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the total duration of a music. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">music</td><td>Music object</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Music duration </dd></dl>
</div>
</div>
<a class="anchor" id="a3c9e254803d15f93d4d8b8ec8f554dc1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> <a class="el" href="Config_8h.htm#a7559f07a31bb3a4a3d865178ce4dc70b">sfBool</a> sfMusic_getLoop </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> * </td>
<td class="paramname"><em>music</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tell whether or not a music is in loop mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">music</td><td>Music object</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>sfTrue if the music is looping, sfFalse otherwise </dd></dl>
</div>
</div>
<a class="anchor" id="af50a57c3416970eb6ba3ab55fb7d563d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> float sfMusic_getMinDistance </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> * </td>
<td class="paramname"><em>music</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the minimum distance of a music. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">music</td><td>Music object</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Minimum distance of the music </dd></dl>
</div>
</div>
<a class="anchor" id="ad15fb2652bbbd395f0ff2825a98e81cf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> float sfMusic_getPitch </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> * </td>
<td class="paramname"><em>music</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the pitch of a music. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">music</td><td>Music object</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pitch of the music </dd></dl>
</div>
</div>
<a class="anchor" id="aa86edae4c0ae36c46d723862da1babae"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> <a class="el" href="structsfTime.htm">sfTime</a> sfMusic_getPlayingOffset </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> * </td>
<td class="paramname"><em>music</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current playing position of a music. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">music</td><td>Music object</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Current playing position </dd></dl>
</div>
</div>
<a class="anchor" id="a744c0513bdadd03b298cc48dfc4d85c6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> <a class="el" href="structsfVector3f.htm">sfVector3f</a> sfMusic_getPosition </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> * </td>
<td class="paramname"><em>music</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the 3D position of a music in the audio scene. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">music</td><td>Music object</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Position of the music in the world </dd></dl>
</div>
</div>
<a class="anchor" id="a093cc8d8ae51a02c5c7753f90b2bae8b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> unsigned int sfMusic_getSampleRate </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> * </td>
<td class="paramname"><em>music</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the sample rate of a music. </p>
<p>The sample rate is the number of audio samples played per second. The higher, the better the quality.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">music</td><td>Music object</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Sample rate, in number of samples per second </dd></dl>
</div>
</div>
<a class="anchor" id="af87c545f32ca4a7b07aad6a9fc332839"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> <a class="el" href="SoundStatus_8h.htm#af27f85d8d7194f78432ff631bafae4ad">sfSoundStatus</a> sfMusic_getStatus </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> * </td>
<td class="paramname"><em>music</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current status of a music (stopped, paused, playing) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">music</td><td>Music object</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Current status </dd></dl>
</div>
</div>
<a class="anchor" id="aee0aae7d733240b5fd56e49ac36b55e2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> float sfMusic_getVolume </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> * </td>
<td class="paramname"><em>music</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the volume of a music. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">music</td><td>Music object</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Volume of the music, in the range [0, 100] </dd></dl>
</div>
</div>
<a class="anchor" id="a3e6552b06bc662a544ff236fc0f8071f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> <a class="el" href="Config_8h.htm#a7559f07a31bb3a4a3d865178ce4dc70b">sfBool</a> sfMusic_isRelativeToListener </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> * </td>
<td class="paramname"><em>music</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tell whether a music's position is relative to the listener or is absolute. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">music</td><td>Music object</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>sfTrue if the position is relative, sfFalse if it's absolute </dd></dl>
</div>
</div>
<a class="anchor" id="ace02cea38831f925f972b7795c1a930c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> void sfMusic_pause </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> * </td>
<td class="paramname"><em>music</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Pause a music. </p>
<p>This function pauses the music if it was playing, otherwise (music already paused or stopped) it has no effect.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">music</td><td>Music object </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a18019593c074028266db0c48c1caad82"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> void sfMusic_play </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> * </td>
<td class="paramname"><em>music</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Start or resume playing a music. </p>
<p>This function starts the music if it was stopped, resumes it if it was paused, and restarts it from beginning if it was it already playing. This function uses its own thread so that it doesn't block the rest of the program while the music is played.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">music</td><td>Music object </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a2d667140787382b9442d4b2433d465fe"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> void sfMusic_setAttenuation </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> * </td>
<td class="paramname"><em>music</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>attenuation</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the attenuation factor of a music. </p>
<p>The attenuation is a multiplicative factor which makes the music more or less loud according to its distance from the listener. An attenuation of 0 will produce a non-attenuated music, i.e. its volume will always be the same whether it is heard from near or from far. On the other hand, an attenuation value such as 100 will make the music fade out very quickly as it gets further from the listener. The default value of the attenuation is 1.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">music</td><td>Music object </td></tr>
<tr><td class="paramname">attenuation</td><td>New attenuation factor of the music </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a30d181ea36bb17e42807bd1d40e10e52"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> void sfMusic_setLoop </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> * </td>
<td class="paramname"><em>music</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="Config_8h.htm#a7559f07a31bb3a4a3d865178ce4dc70b">sfBool</a> </td>
<td class="paramname"><em>loop</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set whether or not a music should loop after reaching the end. </p>
<p>If set, the music will restart from beginning after reaching the end and so on, until it is stopped or sfMusic_setLoop(music, sfFalse) is called. The default looping state for musics is false.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">music</td><td>Music object </td></tr>
<tr><td class="paramname">loop</td><td>sfTrue to play in loop, sfFalse to play once </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ac192556b117b7903e4dcf3f7387b439e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> void sfMusic_setMinDistance </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> * </td>
<td class="paramname"><em>music</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>distance</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the minimum distance of a music. </p>
<p>The "minimum distance" of a music is the maximum distance at which it is heard at its maximum volume. Further than the minimum distance, it will start to fade out according to its attenuation factor. A value of 0 ("inside the head
of the listener") is an invalid value and is forbidden. The default value of the minimum distance is 1.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">music</td><td>Music object </td></tr>
<tr><td class="paramname">distance</td><td>New minimum distance of the music </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a2dedcbfc4683823355725303d240205b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> void sfMusic_setPitch </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> * </td>
<td class="paramname"><em>music</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>pitch</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the pitch of a music. </p>
<p>The pitch represents the perceived fundamental frequency of a sound; thus you can make a music more acute or grave by changing its pitch. A side effect of changing the pitch is to modify the playing speed of the music as well. The default value for the pitch is 1.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">music</td><td>Music object </td></tr>
<tr><td class="paramname">pitch</td><td>New pitch to apply to the music </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a437a4cb64457d7c17af6a29706a180b2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> void sfMusic_setPlayingOffset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> * </td>
<td class="paramname"><em>music</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structsfTime.htm">sfTime</a> </td>
<td class="paramname"><em>timeOffset</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Change the current playing position of a music. </p>
<p>The playing position can be changed when the music is either paused or playing.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">music</td><td>Music object </td></tr>
<tr><td class="paramname">timeOffset</td><td>New playing position </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ae4d45895b309eed905fb18ee987b05c8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> void sfMusic_setPosition </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> * </td>
<td class="paramname"><em>music</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structsfVector3f.htm">sfVector3f</a> </td>
<td class="paramname"><em>position</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the 3D position of a music in the audio scene. </p>
<p>Only musics with one channel (mono musics) can be spatialized. The default position of a music is (0, 0, 0).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">music</td><td>Music object </td></tr>
<tr><td class="paramname">position</td><td>Position of the music in the scene </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a8e3d9521ff47c053a7273f7106276962"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> void sfMusic_setRelativeToListener </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> * </td>
<td class="paramname"><em>music</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="Config_8h.htm#a7559f07a31bb3a4a3d865178ce4dc70b">sfBool</a> </td>
<td class="paramname"><em>relative</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Make a musics's position relative to the listener or absolute. </p>
<p>Making a music relative to the listener will ensure that it will always be played the same way regardless the position of the listener. This can be useful for non-spatialized musics, musics that are produced by the listener, or musics attached to it. The default value is false (position is absolute).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">music</td><td>Music object </td></tr>
<tr><td class="paramname">relative</td><td>sfTrue to set the position relative, sfFalse to set it absolute </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a435ee18b345211d8ff5b715a5e8f52b8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> void sfMusic_setVolume </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> * </td>
<td class="paramname"><em>music</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>volume</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the volume of a music. </p>
<p>The volume is a value between 0 (mute) and 100 (full volume). The default value for the volume is 100.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">music</td><td>Music object </td></tr>
<tr><td class="paramname">volume</td><td>Volume of the music </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a0230956eb600e4b1ca3808d149d3d007"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> void sfMusic_stop </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Audio_2Types_8h.htm#a2c4fe9dfe85dc94132cbe8d61381c1aa">sfMusic</a> * </td>
<td class="paramname"><em>music</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Stop playing a music. </p>
<p>This function stops the music if it was playing or paused, and does nothing if it was already stopped. It also resets the playing position (unlike sfMusic_pause).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">music</td><td>Music object </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
</div>
<div id="footer-container">
<div id="footer">
Copyright © Laurent Gomila ::
Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen</a> ::
</div>
</div>
</body>
</html>
|