/usr/share/doc/libjuce/apiref/classOutputStream.html is in libjuce-doc 4.3.0~repack-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 | <!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>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>JUCE: OutputStream Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">JUCE
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="classOutputStream-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">OutputStream Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>The base class for streams that write data to some kind of destination.
<a href="classOutputStream.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for OutputStream:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center">
<img src="classOutputStream.png" usemap="#OutputStream_map" alt=""/>
<map id="OutputStream_map" name="OutputStream_map">
<area href="classFileOutputStream.html" title="An output stream that writes into a local file. " alt="FileOutputStream" shape="rect" coords="0,56,185,80"/>
<area href="classGZIPCompressorOutputStream.html" title="A stream which uses zlib to compress the data written into it. " alt="GZIPCompressorOutputStream" shape="rect" coords="195,56,380,80"/>
<area href="classMemoryOutputStream.html" title="Writes data to an internal memory buffer, which grows as required. " alt="MemoryOutputStream" shape="rect" coords="390,56,575,80"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a3c3286bd6c6c8fb6b16ce7f88745075b"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classOutputStream.html#a3c3286bd6c6c8fb6b16ce7f88745075b">~OutputStream</a> ()</td></tr>
<tr class="memdesc:a3c3286bd6c6c8fb6b16ce7f88745075b"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a3c3286bd6c6c8fb6b16ce7f88745075b">More...</a><br /></td></tr>
<tr class="separator:a3c3286bd6c6c8fb6b16ce7f88745075b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2b731aef87084c3779bea292f85e800d"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOutputStream.html#a2b731aef87084c3779bea292f85e800d">flush</a> ()=0</td></tr>
<tr class="memdesc:a2b731aef87084c3779bea292f85e800d"><td class="mdescLeft"> </td><td class="mdescRight">If the stream is using a buffer, this will ensure it gets written out to the destination. <a href="#a2b731aef87084c3779bea292f85e800d">More...</a><br /></td></tr>
<tr class="separator:a2b731aef87084c3779bea292f85e800d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae95d7b4edfe5eac6a0913b079684572a"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOutputStream.html#ae95d7b4edfe5eac6a0913b079684572a">setPosition</a> (<a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> newPosition)=0</td></tr>
<tr class="memdesc:ae95d7b4edfe5eac6a0913b079684572a"><td class="mdescLeft"> </td><td class="mdescRight">Tries to move the stream's output position. <a href="#ae95d7b4edfe5eac6a0913b079684572a">More...</a><br /></td></tr>
<tr class="separator:ae95d7b4edfe5eac6a0913b079684572a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a84ec99ccacf0326e79070d34f178e3d3"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOutputStream.html#a84ec99ccacf0326e79070d34f178e3d3">getPosition</a> ()=0</td></tr>
<tr class="memdesc:a84ec99ccacf0326e79070d34f178e3d3"><td class="mdescLeft"> </td><td class="mdescRight">Returns the stream's current position. <a href="#a84ec99ccacf0326e79070d34f178e3d3">More...</a><br /></td></tr>
<tr class="separator:a84ec99ccacf0326e79070d34f178e3d3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0658d05adfcb1f7363ebe418f84fee21"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOutputStream.html#a0658d05adfcb1f7363ebe418f84fee21">write</a> (const void *dataToWrite, size_t numberOfBytes)=0</td></tr>
<tr class="memdesc:a0658d05adfcb1f7363ebe418f84fee21"><td class="mdescLeft"> </td><td class="mdescRight">Writes a block of data to the stream. <a href="#a0658d05adfcb1f7363ebe418f84fee21">More...</a><br /></td></tr>
<tr class="separator:a0658d05adfcb1f7363ebe418f84fee21"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaa3aee845d1cd8db87533313c12c0963"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOutputStream.html#aaa3aee845d1cd8db87533313c12c0963">writeByte</a> (char byte)</td></tr>
<tr class="memdesc:aaa3aee845d1cd8db87533313c12c0963"><td class="mdescLeft"> </td><td class="mdescRight">Writes a single byte to the stream. <a href="#aaa3aee845d1cd8db87533313c12c0963">More...</a><br /></td></tr>
<tr class="separator:aaa3aee845d1cd8db87533313c12c0963"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aac4bd355924dfb91aa71aa5c6c251924"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOutputStream.html#aac4bd355924dfb91aa71aa5c6c251924">writeBool</a> (bool boolValue)</td></tr>
<tr class="memdesc:aac4bd355924dfb91aa71aa5c6c251924"><td class="mdescLeft"> </td><td class="mdescRight">Writes a boolean to the stream as a single byte. <a href="#aac4bd355924dfb91aa71aa5c6c251924">More...</a><br /></td></tr>
<tr class="separator:aac4bd355924dfb91aa71aa5c6c251924"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa0c31878ffe72db678ad2df92f977b79"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOutputStream.html#aa0c31878ffe72db678ad2df92f977b79">writeShort</a> (short value)</td></tr>
<tr class="memdesc:aa0c31878ffe72db678ad2df92f977b79"><td class="mdescLeft"> </td><td class="mdescRight">Writes a 16-bit integer to the stream in a little-endian byte order. <a href="#aa0c31878ffe72db678ad2df92f977b79">More...</a><br /></td></tr>
<tr class="separator:aa0c31878ffe72db678ad2df92f977b79"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2f5dec34d9771edea9c0535eb5b58860"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOutputStream.html#a2f5dec34d9771edea9c0535eb5b58860">writeShortBigEndian</a> (short value)</td></tr>
<tr class="memdesc:a2f5dec34d9771edea9c0535eb5b58860"><td class="mdescLeft"> </td><td class="mdescRight">Writes a 16-bit integer to the stream in a big-endian byte order. <a href="#a2f5dec34d9771edea9c0535eb5b58860">More...</a><br /></td></tr>
<tr class="separator:a2f5dec34d9771edea9c0535eb5b58860"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a75f455e1a6e4da9190cd77bc01657622"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOutputStream.html#a75f455e1a6e4da9190cd77bc01657622">writeInt</a> (int value)</td></tr>
<tr class="memdesc:a75f455e1a6e4da9190cd77bc01657622"><td class="mdescLeft"> </td><td class="mdescRight">Writes a 32-bit integer to the stream in a little-endian byte order. <a href="#a75f455e1a6e4da9190cd77bc01657622">More...</a><br /></td></tr>
<tr class="separator:a75f455e1a6e4da9190cd77bc01657622"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac42573016fc3f343dc9692d55d455f1b"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOutputStream.html#ac42573016fc3f343dc9692d55d455f1b">writeIntBigEndian</a> (int value)</td></tr>
<tr class="memdesc:ac42573016fc3f343dc9692d55d455f1b"><td class="mdescLeft"> </td><td class="mdescRight">Writes a 32-bit integer to the stream in a big-endian byte order. <a href="#ac42573016fc3f343dc9692d55d455f1b">More...</a><br /></td></tr>
<tr class="separator:ac42573016fc3f343dc9692d55d455f1b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a078351d61263e8e8141ccde1a0c07816"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOutputStream.html#a078351d61263e8e8141ccde1a0c07816">writeInt64</a> (<a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> value)</td></tr>
<tr class="memdesc:a078351d61263e8e8141ccde1a0c07816"><td class="mdescLeft"> </td><td class="mdescRight">Writes a 64-bit integer to the stream in a little-endian byte order. <a href="#a078351d61263e8e8141ccde1a0c07816">More...</a><br /></td></tr>
<tr class="separator:a078351d61263e8e8141ccde1a0c07816"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5962dcaca71153338180ef0c17e11152"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOutputStream.html#a5962dcaca71153338180ef0c17e11152">writeInt64BigEndian</a> (<a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> value)</td></tr>
<tr class="memdesc:a5962dcaca71153338180ef0c17e11152"><td class="mdescLeft"> </td><td class="mdescRight">Writes a 64-bit integer to the stream in a big-endian byte order. <a href="#a5962dcaca71153338180ef0c17e11152">More...</a><br /></td></tr>
<tr class="separator:a5962dcaca71153338180ef0c17e11152"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0a1d967388deb957e573a8bfa0aede56"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOutputStream.html#a0a1d967388deb957e573a8bfa0aede56">writeFloat</a> (float value)</td></tr>
<tr class="memdesc:a0a1d967388deb957e573a8bfa0aede56"><td class="mdescLeft"> </td><td class="mdescRight">Writes a 32-bit floating point value to the stream in a binary format. <a href="#a0a1d967388deb957e573a8bfa0aede56">More...</a><br /></td></tr>
<tr class="separator:a0a1d967388deb957e573a8bfa0aede56"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a84cb925582b87dc5c1f5e6d569a74208"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOutputStream.html#a84cb925582b87dc5c1f5e6d569a74208">writeFloatBigEndian</a> (float value)</td></tr>
<tr class="memdesc:a84cb925582b87dc5c1f5e6d569a74208"><td class="mdescLeft"> </td><td class="mdescRight">Writes a 32-bit floating point value to the stream in a binary format. <a href="#a84cb925582b87dc5c1f5e6d569a74208">More...</a><br /></td></tr>
<tr class="separator:a84cb925582b87dc5c1f5e6d569a74208"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af48e3b3934bf5b4624dcbe00989581a0"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOutputStream.html#af48e3b3934bf5b4624dcbe00989581a0">writeDouble</a> (double value)</td></tr>
<tr class="memdesc:af48e3b3934bf5b4624dcbe00989581a0"><td class="mdescLeft"> </td><td class="mdescRight">Writes a 64-bit floating point value to the stream in a binary format. <a href="#af48e3b3934bf5b4624dcbe00989581a0">More...</a><br /></td></tr>
<tr class="separator:af48e3b3934bf5b4624dcbe00989581a0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a03a42d49d4a1aba31b38a2069cbe18b0"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOutputStream.html#a03a42d49d4a1aba31b38a2069cbe18b0">writeDoubleBigEndian</a> (double value)</td></tr>
<tr class="memdesc:a03a42d49d4a1aba31b38a2069cbe18b0"><td class="mdescLeft"> </td><td class="mdescRight">Writes a 64-bit floating point value to the stream in a binary format. <a href="#a03a42d49d4a1aba31b38a2069cbe18b0">More...</a><br /></td></tr>
<tr class="separator:a03a42d49d4a1aba31b38a2069cbe18b0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2971fbd11a1c278f85ae02726c20d3be"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOutputStream.html#a2971fbd11a1c278f85ae02726c20d3be">writeRepeatedByte</a> (<a class="el" href="juce__MathsFunctions_8h.html#adde6aaee8457bee49c2a92621fe22b79">uint8</a> byte, size_t numTimesToRepeat)</td></tr>
<tr class="memdesc:a2971fbd11a1c278f85ae02726c20d3be"><td class="mdescLeft"> </td><td class="mdescRight">Writes a byte to the output stream a given number of times. <a href="#a2971fbd11a1c278f85ae02726c20d3be">More...</a><br /></td></tr>
<tr class="separator:a2971fbd11a1c278f85ae02726c20d3be"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac01d789588295c52ce4034bf792d9b20"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOutputStream.html#ac01d789588295c52ce4034bf792d9b20">writeCompressedInt</a> (int value)</td></tr>
<tr class="memdesc:ac01d789588295c52ce4034bf792d9b20"><td class="mdescLeft"> </td><td class="mdescRight">Writes a condensed binary encoding of a 32-bit integer. <a href="#ac01d789588295c52ce4034bf792d9b20">More...</a><br /></td></tr>
<tr class="separator:ac01d789588295c52ce4034bf792d9b20"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a63a79aac70bc3ad976cd3fb3a6d57ffd"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOutputStream.html#a63a79aac70bc3ad976cd3fb3a6d57ffd">writeString</a> (const <a class="el" href="classString.html">String</a> &text)</td></tr>
<tr class="memdesc:a63a79aac70bc3ad976cd3fb3a6d57ffd"><td class="mdescLeft"> </td><td class="mdescRight">Stores a string in the stream in a binary format. <a href="#a63a79aac70bc3ad976cd3fb3a6d57ffd">More...</a><br /></td></tr>
<tr class="separator:a63a79aac70bc3ad976cd3fb3a6d57ffd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a94dd75c2e93c3ae9239e2d9479586876"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOutputStream.html#a94dd75c2e93c3ae9239e2d9479586876">writeText</a> (const <a class="el" href="classString.html">String</a> &text, bool asUTF16, bool writeUTF16ByteOrderMark)</td></tr>
<tr class="memdesc:a94dd75c2e93c3ae9239e2d9479586876"><td class="mdescLeft"> </td><td class="mdescRight">Writes a string of text to the stream. <a href="#a94dd75c2e93c3ae9239e2d9479586876">More...</a><br /></td></tr>
<tr class="separator:a94dd75c2e93c3ae9239e2d9479586876"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9f80423e8a780f4124d9b7910d712cb1"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOutputStream.html#a9f80423e8a780f4124d9b7910d712cb1">writeFromInputStream</a> (<a class="el" href="classInputStream.html">InputStream</a> &source, <a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> maxNumBytesToWrite)</td></tr>
<tr class="memdesc:a9f80423e8a780f4124d9b7910d712cb1"><td class="mdescLeft"> </td><td class="mdescRight">Reads data from an input stream and writes it to this stream. <a href="#a9f80423e8a780f4124d9b7910d712cb1">More...</a><br /></td></tr>
<tr class="separator:a9f80423e8a780f4124d9b7910d712cb1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3cd9133af8d3e6a04b8c983290649909"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOutputStream.html#a3cd9133af8d3e6a04b8c983290649909">setNewLineString</a> (const <a class="el" href="classString.html">String</a> &newLineString)</td></tr>
<tr class="memdesc:a3cd9133af8d3e6a04b8c983290649909"><td class="mdescLeft"> </td><td class="mdescRight">Sets the string that will be written to the stream when the writeNewLine() method is called. <a href="#a3cd9133af8d3e6a04b8c983290649909">More...</a><br /></td></tr>
<tr class="separator:a3cd9133af8d3e6a04b8c983290649909"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9ca663ec96b69491053385b6c26e6572"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classString.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classOutputStream.html#a9ca663ec96b69491053385b6c26e6572">getNewLineString</a> () const noexcept</td></tr>
<tr class="memdesc:a9ca663ec96b69491053385b6c26e6572"><td class="mdescLeft"> </td><td class="mdescRight">Returns the current new-line string that was set by <a class="el" href="classOutputStream.html#a3cd9133af8d3e6a04b8c983290649909" title="Sets the string that will be written to the stream when the writeNewLine() method is called...">setNewLineString()</a>. <a href="#a9ca663ec96b69491053385b6c26e6572">More...</a><br /></td></tr>
<tr class="separator:a9ca663ec96b69491053385b6c26e6572"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a1159b7032e052493fdec603a3deeff70"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOutputStream.html#a1159b7032e052493fdec603a3deeff70">OutputStream</a> ()</td></tr>
<tr class="separator:a1159b7032e052493fdec603a3deeff70"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The base class for streams that write data to some kind of destination. </p>
<p>Input and output streams are used throughout the library - subclasses can override some or all of the virtual functions to implement their behaviour.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classInputStream.html" title="The base class for streams that read data. ">InputStream</a>, <a class="el" href="classMemoryOutputStream.html" title="Writes data to an internal memory buffer, which grows as required. ">MemoryOutputStream</a>, <a class="el" href="classFileOutputStream.html" title="An output stream that writes into a local file. ">FileOutputStream</a> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a1159b7032e052493fdec603a3deeff70"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1159b7032e052493fdec603a3deeff70">§ </a></span>OutputStream()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">OutputStream::OutputStream </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a3c3286bd6c6c8fb6b16ce7f88745075b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3c3286bd6c6c8fb6b16ce7f88745075b">§ </a></span>~OutputStream()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual OutputStream::~OutputStream </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
<p>Some subclasses might want to do things like call <a class="el" href="classOutputStream.html#a2b731aef87084c3779bea292f85e800d" title="If the stream is using a buffer, this will ensure it gets written out to the destination. ">flush()</a> during their destructors. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a2b731aef87084c3779bea292f85e800d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b731aef87084c3779bea292f85e800d">§ </a></span>flush()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void OutputStream::flush </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>If the stream is using a buffer, this will ensure it gets written out to the destination. </p>
<p>Implemented in <a class="el" href="classMemoryOutputStream.html#ac44c1c655acca94ee3a867eba6d31b5e">MemoryOutputStream</a>, <a class="el" href="classFileOutputStream.html#afc63785b8744278d51814c4892207414">FileOutputStream</a>, and <a class="el" href="classGZIPCompressorOutputStream.html#a4b2e3135b2b9707edaf8fac8d74d557a">GZIPCompressorOutputStream</a>.</p>
<p>Referenced by <a class="el" href="classMemoryOutputStream.html#abedf6ef0d5e12b672e5c8dcab75f0d33">MemoryOutputStream::getDataSize()</a>, and <a class="el" href="classFileOutputStream.html#a5b0c2bc1b12469f38d4a2929711b66d9">FileOutputStream::openedOk()</a>.</p>
</div>
</div>
<a id="ae95d7b4edfe5eac6a0913b079684572a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae95d7b4edfe5eac6a0913b079684572a">§ </a></span>setPosition()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool OutputStream::setPosition </td>
<td>(</td>
<td class="paramtype"><a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> </td>
<td class="paramname"><em>newPosition</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Tries to move the stream's output position. </p>
<p>Not all streams will be able to seek to a new position - this will return false if it fails to work.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classOutputStream.html#a84ec99ccacf0326e79070d34f178e3d3" title="Returns the stream's current position. ">getPosition</a> </dd></dl>
<p>Implemented in <a class="el" href="classMemoryOutputStream.html#a4099015681b9cd1171f1ecd27443732b">MemoryOutputStream</a>, <a class="el" href="classFileOutputStream.html#adfaac72947e3a9bf5bf99669d253219f">FileOutputStream</a>, and <a class="el" href="classGZIPCompressorOutputStream.html#a5d41bcadc8a2604935f0614ee83d1252">GZIPCompressorOutputStream</a>.</p>
<p>Referenced by <a class="el" href="classMemoryOutputStream.html#a073726d692e159414b5c074f16dadeb9">MemoryOutputStream::getPosition()</a>, and <a class="el" href="classFileOutputStream.html#a5b0c2bc1b12469f38d4a2929711b66d9">FileOutputStream::openedOk()</a>.</p>
</div>
</div>
<a id="a84ec99ccacf0326e79070d34f178e3d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84ec99ccacf0326e79070d34f178e3d3">§ </a></span>getPosition()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> OutputStream::getPosition </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the stream's current position. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classOutputStream.html#ae95d7b4edfe5eac6a0913b079684572a" title="Tries to move the stream's output position. ">setPosition</a> </dd></dl>
<p>Implemented in <a class="el" href="classMemoryOutputStream.html#a073726d692e159414b5c074f16dadeb9">MemoryOutputStream</a>, <a class="el" href="classFileOutputStream.html#ad9c8bd54d832a6739a9a4af57f4b8254">FileOutputStream</a>, and <a class="el" href="classGZIPCompressorOutputStream.html#a2c4af78b2fe5d6499acbb59516417055">GZIPCompressorOutputStream</a>.</p>
<p>Referenced by <a class="el" href="classFileOutputStream.html#a5b0c2bc1b12469f38d4a2929711b66d9">FileOutputStream::openedOk()</a>.</p>
</div>
</div>
<a id="a0658d05adfcb1f7363ebe418f84fee21"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0658d05adfcb1f7363ebe418f84fee21">§ </a></span>write()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool OutputStream::write </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>dataToWrite</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>numberOfBytes</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes a block of data to the stream. </p>
<p>When creating a subclass of <a class="el" href="classOutputStream.html" title="The base class for streams that write data to some kind of destination. ">OutputStream</a>, this is the only write method that needs to be overloaded - the base class has methods for writing other types of data which use this to do the work.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dataToWrite</td><td>the target buffer to receive the data. This must not be null. </td></tr>
<tr><td class="paramname">numberOfBytes</td><td>the number of bytes to write. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>false if the write operation fails for some reason </dd></dl>
<p>Implemented in <a class="el" href="classMemoryOutputStream.html#a3aa6fc52e07213477bc68301267fa79c">MemoryOutputStream</a>, <a class="el" href="classFileOutputStream.html#ae2028e7cfc77d246d160f316db61f60f">FileOutputStream</a>, and <a class="el" href="classGZIPCompressorOutputStream.html#a65127167237b8f998cbad09622edec3a">GZIPCompressorOutputStream</a>.</p>
<p>Referenced by <a class="el" href="classMemoryOutputStream.html#abedf6ef0d5e12b672e5c8dcab75f0d33">MemoryOutputStream::getDataSize()</a>, and <a class="el" href="classFileOutputStream.html#a5b0c2bc1b12469f38d4a2929711b66d9">FileOutputStream::openedOk()</a>.</p>
</div>
</div>
<a id="aaa3aee845d1cd8db87533313c12c0963"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaa3aee845d1cd8db87533313c12c0963">§ </a></span>writeByte()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool OutputStream::writeByte </td>
<td>(</td>
<td class="paramtype">char </td>
<td class="paramname"><em>byte</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes a single byte to the stream. </p>
<dl class="section return"><dt>Returns</dt><dd>false if the write operation fails for some reason </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classInputStream.html#a2e5944641712d84b6da2eee5d394326a" title="Reads a byte from the stream. ">InputStream::readByte</a> </dd></dl>
</div>
</div>
<a id="aac4bd355924dfb91aa71aa5c6c251924"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aac4bd355924dfb91aa71aa5c6c251924">§ </a></span>writeBool()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool OutputStream::writeBool </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>boolValue</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes a boolean to the stream as a single byte. </p>
<p>This is encoded as a binary byte (not as text) with a value of 1 or 0. </p><dl class="section return"><dt>Returns</dt><dd>false if the write operation fails for some reason </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classInputStream.html#a37d1e4956da4fb9f765f16f9c4b4ec3b" title="Reads a boolean from the stream. ">InputStream::readBool</a> </dd></dl>
</div>
</div>
<a id="aa0c31878ffe72db678ad2df92f977b79"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa0c31878ffe72db678ad2df92f977b79">§ </a></span>writeShort()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool OutputStream::writeShort </td>
<td>(</td>
<td class="paramtype">short </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes a 16-bit integer to the stream in a little-endian byte order. </p>
<p>This will write two bytes to the stream: (value & 0xff), then (value >> 8). </p><dl class="section return"><dt>Returns</dt><dd>false if the write operation fails for some reason </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classInputStream.html#a0c4b0f9f1fa9515fea5a98d2ffe7ae02" title="Reads two bytes from the stream as a little-endian 16-bit value. ">InputStream::readShort</a> </dd></dl>
</div>
</div>
<a id="a2f5dec34d9771edea9c0535eb5b58860"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f5dec34d9771edea9c0535eb5b58860">§ </a></span>writeShortBigEndian()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool OutputStream::writeShortBigEndian </td>
<td>(</td>
<td class="paramtype">short </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes a 16-bit integer to the stream in a big-endian byte order. </p>
<p>This will write two bytes to the stream: (value >> 8), then (value & 0xff). </p><dl class="section return"><dt>Returns</dt><dd>false if the write operation fails for some reason </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classInputStream.html#ac33bbf8ae4597a30bde70cbdbc6bfa5b" title="Reads two bytes from the stream as a little-endian 16-bit value. ">InputStream::readShortBigEndian</a> </dd></dl>
</div>
</div>
<a id="a75f455e1a6e4da9190cd77bc01657622"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a75f455e1a6e4da9190cd77bc01657622">§ </a></span>writeInt()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool OutputStream::writeInt </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes a 32-bit integer to the stream in a little-endian byte order. </p>
<dl class="section return"><dt>Returns</dt><dd>false if the write operation fails for some reason </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classInputStream.html#a59eb456ebfbe9d4c7fdfd4c14337e19a" title="Reads four bytes from the stream as a little-endian 32-bit value. ">InputStream::readInt</a> </dd></dl>
</div>
</div>
<a id="ac42573016fc3f343dc9692d55d455f1b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac42573016fc3f343dc9692d55d455f1b">§ </a></span>writeIntBigEndian()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool OutputStream::writeIntBigEndian </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes a 32-bit integer to the stream in a big-endian byte order. </p>
<dl class="section return"><dt>Returns</dt><dd>false if the write operation fails for some reason </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classInputStream.html#a84ab1bcc547eee621c4c6c2502af808d" title="Reads four bytes from the stream as a big-endian 32-bit value. ">InputStream::readIntBigEndian</a> </dd></dl>
</div>
</div>
<a id="a078351d61263e8e8141ccde1a0c07816"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a078351d61263e8e8141ccde1a0c07816">§ </a></span>writeInt64()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool OutputStream::writeInt64 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes a 64-bit integer to the stream in a little-endian byte order. </p>
<dl class="section return"><dt>Returns</dt><dd>false if the write operation fails for some reason </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classInputStream.html#a58941fd7cf4279e49d4697750f837a56" title="Reads eight bytes from the stream as a little-endian 64-bit value. ">InputStream::readInt64</a> </dd></dl>
</div>
</div>
<a id="a5962dcaca71153338180ef0c17e11152"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5962dcaca71153338180ef0c17e11152">§ </a></span>writeInt64BigEndian()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool OutputStream::writeInt64BigEndian </td>
<td>(</td>
<td class="paramtype"><a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes a 64-bit integer to the stream in a big-endian byte order. </p>
<dl class="section return"><dt>Returns</dt><dd>false if the write operation fails for some reason </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classInputStream.html#a8894f1c01c6e0de4b5dd9b9c1fe06c4b" title="Reads eight bytes from the stream as a big-endian 64-bit value. ">InputStream::readInt64BigEndian</a> </dd></dl>
</div>
</div>
<a id="a0a1d967388deb957e573a8bfa0aede56"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0a1d967388deb957e573a8bfa0aede56">§ </a></span>writeFloat()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool OutputStream::writeFloat </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes a 32-bit floating point value to the stream in a binary format. </p>
<p>The binary 32-bit encoding of the float is written as a little-endian int. </p><dl class="section return"><dt>Returns</dt><dd>false if the write operation fails for some reason </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classInputStream.html#a46d7f191f1872bc27550db3fa0733f59" title="Reads four bytes as a 32-bit floating point value. ">InputStream::readFloat</a> </dd></dl>
</div>
</div>
<a id="a84cb925582b87dc5c1f5e6d569a74208"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84cb925582b87dc5c1f5e6d569a74208">§ </a></span>writeFloatBigEndian()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool OutputStream::writeFloatBigEndian </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes a 32-bit floating point value to the stream in a binary format. </p>
<p>The binary 32-bit encoding of the float is written as a big-endian int. </p><dl class="section return"><dt>Returns</dt><dd>false if the write operation fails for some reason </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classInputStream.html#a4d19fef152296085c477882e0650b011" title="Reads four bytes as a 32-bit floating point value. ">InputStream::readFloatBigEndian</a> </dd></dl>
</div>
</div>
<a id="af48e3b3934bf5b4624dcbe00989581a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af48e3b3934bf5b4624dcbe00989581a0">§ </a></span>writeDouble()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool OutputStream::writeDouble </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes a 64-bit floating point value to the stream in a binary format. </p>
<p>The eight raw bytes of the double value are written out as a little-endian 64-bit int. </p><dl class="section return"><dt>Returns</dt><dd>false if the write operation fails for some reason </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classInputStream.html#a31626a82ad48629a202135ac925ffecd" title="Reads eight bytes as a 64-bit floating point value. ">InputStream::readDouble</a> </dd></dl>
</div>
</div>
<a id="a03a42d49d4a1aba31b38a2069cbe18b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a03a42d49d4a1aba31b38a2069cbe18b0">§ </a></span>writeDoubleBigEndian()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool OutputStream::writeDoubleBigEndian </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes a 64-bit floating point value to the stream in a binary format. </p>
<p>The eight raw bytes of the double value are written out as a big-endian 64-bit int. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classInputStream.html#a7c7a2928053424caf51986d9e6fdaa35" title="Reads eight bytes as a 64-bit floating point value. ">InputStream::readDoubleBigEndian</a> </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>false if the write operation fails for some reason </dd></dl>
</div>
</div>
<a id="a2971fbd11a1c278f85ae02726c20d3be"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2971fbd11a1c278f85ae02726c20d3be">§ </a></span>writeRepeatedByte()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool OutputStream::writeRepeatedByte </td>
<td>(</td>
<td class="paramtype"><a class="el" href="juce__MathsFunctions_8h.html#adde6aaee8457bee49c2a92621fe22b79">uint8</a> </td>
<td class="paramname"><em>byte</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>numTimesToRepeat</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes a byte to the output stream a given number of times. </p>
<dl class="section return"><dt>Returns</dt><dd>false if the write operation fails for some reason </dd></dl>
<p>Reimplemented in <a class="el" href="classMemoryOutputStream.html#ab8029d0df31f60579d5fc2fbfc34c6ed">MemoryOutputStream</a>, and <a class="el" href="classFileOutputStream.html#a8b8d8a24b6e3eb021a5cb333c22a5de8">FileOutputStream</a>.</p>
<p>Referenced by <a class="el" href="classMemoryOutputStream.html#a073726d692e159414b5c074f16dadeb9">MemoryOutputStream::getPosition()</a>, and <a class="el" href="classFileOutputStream.html#a5b0c2bc1b12469f38d4a2929711b66d9">FileOutputStream::openedOk()</a>.</p>
</div>
</div>
<a id="ac01d789588295c52ce4034bf792d9b20"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac01d789588295c52ce4034bf792d9b20">§ </a></span>writeCompressedInt()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool OutputStream::writeCompressedInt </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes a condensed binary encoding of a 32-bit integer. </p>
<p>If you're storing a lot of integers which are unlikely to have very large values, this can save a lot of space, because values under 0xff will only take up 2 bytes, under 0xffff only 3 bytes, etc.</p>
<p>The format used is: number of significant bytes + up to 4 bytes in little-endian order.</p>
<dl class="section return"><dt>Returns</dt><dd>false if the write operation fails for some reason </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classInputStream.html#a3e3643991f4103c5cfc1b8c61c6a3e92" title="Reads an encoded 32-bit number from the stream using a space-saving compressed format. ">InputStream::readCompressedInt</a> </dd></dl>
</div>
</div>
<a id="a63a79aac70bc3ad976cd3fb3a6d57ffd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a63a79aac70bc3ad976cd3fb3a6d57ffd">§ </a></span>writeString()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool OutputStream::writeString </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>text</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Stores a string in the stream in a binary format. </p>
<p>This isn't the method to use if you're trying to append text to the end of a text-file! It's intended for storing a string so that it can be retrieved later by <a class="el" href="classInputStream.html#abff18ad6e416d45f19d347abd3433665" title="Reads a zero-terminated UTF-8 string from the stream. ">InputStream::readString()</a>.</p>
<p>It writes the string to the stream as UTF8, including the null termination character.</p>
<p>For appending text to a file, instead use writeText, or operator<<</p>
<dl class="section return"><dt>Returns</dt><dd>false if the write operation fails for some reason </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classInputStream.html#abff18ad6e416d45f19d347abd3433665" title="Reads a zero-terminated UTF-8 string from the stream. ">InputStream::readString</a>, <a class="el" href="classOutputStream.html#a94dd75c2e93c3ae9239e2d9479586876" title="Writes a string of text to the stream. ">writeText</a>, operator<< </dd></dl>
</div>
</div>
<a id="a94dd75c2e93c3ae9239e2d9479586876"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a94dd75c2e93c3ae9239e2d9479586876">§ </a></span>writeText()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool OutputStream::writeText </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>asUTF16</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>writeUTF16ByteOrderMark</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes a string of text to the stream. </p>
<p>It can either write the text as UTF-8 or UTF-16, and can also add the UTF-16 byte-order-mark bytes (0xff, 0xfe) to indicate the endianness (these should only be used at the start of a file).</p>
<p>The method also replaces '\n' characters in the text with '\r\n'. </p><dl class="section return"><dt>Returns</dt><dd>false if the write operation fails for some reason </dd></dl>
</div>
</div>
<a id="a9f80423e8a780f4124d9b7910d712cb1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9f80423e8a780f4124d9b7910d712cb1">§ </a></span>writeFromInputStream()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> OutputStream::writeFromInputStream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classInputStream.html">InputStream</a> & </td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> </td>
<td class="paramname"><em>maxNumBytesToWrite</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads data from an input stream and writes it to this stream. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>the stream to read from </td></tr>
<tr><td class="paramname">maxNumBytesToWrite</td><td>the number of bytes to read from the stream (if this is less than zero, it will keep reading until the input is exhausted) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of bytes written </dd></dl>
<p>Reimplemented in <a class="el" href="classMemoryOutputStream.html#aae9401ec7495276cc1090cbf3937d2a5">MemoryOutputStream</a>.</p>
<p>Referenced by <a class="el" href="classMemoryOutputStream.html#a073726d692e159414b5c074f16dadeb9">MemoryOutputStream::getPosition()</a>.</p>
</div>
</div>
<a id="a3cd9133af8d3e6a04b8c983290649909"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3cd9133af8d3e6a04b8c983290649909">§ </a></span>setNewLineString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void OutputStream::setNewLineString </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>newLineString</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the string that will be written to the stream when the writeNewLine() method is called. </p>
<p>By default this will be set the value of <a class="el" href="classNewLine.html#ab07d21b3c535b0bf3897893cc87b765e" title="Returns the default new-line sequence that the library uses. ">NewLine::getDefault()</a>. </p>
</div>
</div>
<a id="a9ca663ec96b69491053385b6c26e6572"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9ca663ec96b69491053385b6c26e6572">§ </a></span>getNewLineString()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classString.html">String</a>& OutputStream::getNewLineString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the current new-line string that was set by <a class="el" href="classOutputStream.html#a3cd9133af8d3e6a04b8c983290649909" title="Sets the string that will be written to the stream when the writeNewLine() method is called...">setNewLineString()</a>. </p>
<p>References <a class="el" href="juce__StandardHeader_8h.html#a65961b3bfbda0ffb83750d914cee38fb">JUCE_API</a>, <a class="el" href="juce__PlatformDefs_8h.html#af0b3f78ca801d88a7912f4c6bbf50e58">JUCE_CALLTYPE</a>, <a class="el" href="juce__PlatformDefs_8h.html#a851b02724a8158a7f746c66b5758b3dd">JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR</a>, and <a class="el" href="juce__OutputStream_8h.html#a8ed75a09f5e10cfa2f52b4417d7e0e94">operator<<()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__OutputStream_8h.html">juce_OutputStream.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|