|
6 | 6 | <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
7 | 7 | <meta name="generator" content="Doxygen 1.9.1"/> |
8 | 8 | <meta name="viewport" content="width=device-width, initial-scale=1"/> |
9 | | -<title>ARA SDK 2.0.0: Plug-In Entry</title> |
| 9 | +<title>ARA SDK 2.1.0: Plug-In Entry</title> |
10 | 10 | <link rel="icon" type="image/png" sizes="96x96" href="favicon-96x96.png"> |
11 | 11 | <link rel="icon" type="image/png" sizes="32x32" href="favicon-32x32.png"> |
12 | 12 | <link rel="icon" type="image/png" sizes="16x16" href="favicon-16x16.png"> |
@@ -165,6 +165,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#class_a_r_a_1_1_plug_in_1 |
165 | 165 | <tr class="memitem:af2b77443300649a0b4aac93f45666e55"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group___model___playback___region.html#ga258336ff5f674225e3ec403493461179">ARAPlaybackTransformationFlags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_r_a___library___a_r_a_plug___plug_in_entry.html#af2b77443300649a0b4aac93f45666e55">getSupportedPlaybackTransformationFlags</a> () const noexcept</td></tr> |
166 | 166 | <tr class="memdesc:af2b77443300649a0b4aac93f45666e55"><td class="mdescLeft"> </td><td class="mdescRight">Set of transformations that the plug-in supports when configuring playback regions. These flags allow the host to determine whether e.g. the plug-in can be used as time-stretch engine. <a href="group___a_r_a___library___a_r_a_plug___plug_in_entry.html#af2b77443300649a0b4aac93f45666e55">More...</a><br /></td></tr> |
167 | 167 | <tr class="separator:af2b77443300649a0b4aac93f45666e55"><td class="memSeparator" colspan="2"> </td></tr> |
| 168 | +<tr class="memitem:a37f87a4ecf4ec0d6d6cb20df7746ade7"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_r_a___library___a_r_a_plug___plug_in_entry.html#a37f87a4ecf4ec0d6d6cb20df7746ade7">supportsStoringAudioFileChunks</a> () const noexcept</td></tr> |
| 169 | +<tr class="memdesc:a37f87a4ecf4ec0d6d6cb20df7746ade7"><td class="mdescLeft"> </td><td class="mdescRight">Flag whether the plug-in supports exporting ARA audio file chunks via <a class="el" href="group___plug-_in___document___controller.html#a4759249602a579d2d561745eaa92182a" title="Create an archive of the internal state of the specified audio source suitable to be embedded into th...">ARADocumentControllerInterface::storeAudioSourceToAudioFileChunk()</a>. Note that reading such chunks is unaffected by this flag - as long as the documentArchiveID in the chunk is compatible, the plug-in must be able to read the data via <a class="el" href="group___plug-_in___document___controller.html#a6ad2b9f4070e12178057c3c9590f4c32" title="Unarchive the internal state of the specified objects. This call can be used both for unarchiving ent...">ARADocumentControllerInterface::restoreObjectsFromArchive()</a>. <a href="group___a_r_a___library___a_r_a_plug___plug_in_entry.html#a37f87a4ecf4ec0d6d6cb20df7746ade7">More...</a><br /></td></tr> |
| 170 | +<tr class="separator:a37f87a4ecf4ec0d6d6cb20df7746ade7"><td class="memSeparator" colspan="2"> </td></tr> |
168 | 171 | </table> |
169 | 172 | <h4 class="groupheader">Member Function Documentation</h4> |
170 | 173 | <a id="aae299f1edf33c6e6e0827624b9c3eab7"></a> |
@@ -516,6 +519,33 @@ <h2 class="memtitle"><span class="permalink"><a href="#a2c730711a4bc4daca565f90f |
516 | 519 |
|
517 | 520 | <p>Version string of the plug-in to display to the user. </p> |
518 | 521 |
|
| 522 | +</div> |
| 523 | +</div> |
| 524 | +<a id="a37f87a4ecf4ec0d6d6cb20df7746ade7"></a> |
| 525 | +<h2 class="memtitle"><span class="permalink"><a href="#a37f87a4ecf4ec0d6d6cb20df7746ade7">◆ </a></span>supportsStoringAudioFileChunks()</h2> |
| 526 | + |
| 527 | +<div class="memitem"> |
| 528 | +<div class="memproto"> |
| 529 | +<table class="mlabels"> |
| 530 | + <tr> |
| 531 | + <td class="mlabels-left"> |
| 532 | + <table class="memname"> |
| 533 | + <tr> |
| 534 | + <td class="memname">virtual bool ARA::PlugIn::FactoryConfig::supportsStoringAudioFileChunks </td> |
| 535 | + <td>(</td> |
| 536 | + <td class="paramname"></td><td>)</td> |
| 537 | + <td> const</td> |
| 538 | + </tr> |
| 539 | + </table> |
| 540 | + </td> |
| 541 | + <td class="mlabels-right"> |
| 542 | +<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">noexcept</span></span> </td> |
| 543 | + </tr> |
| 544 | +</table> |
| 545 | +</div><div class="memdoc"> |
| 546 | + |
| 547 | +<p>Flag whether the plug-in supports exporting ARA audio file chunks via <a class="el" href="group___plug-_in___document___controller.html#a4759249602a579d2d561745eaa92182a" title="Create an archive of the internal state of the specified audio source suitable to be embedded into th...">ARADocumentControllerInterface::storeAudioSourceToAudioFileChunk()</a>. Note that reading such chunks is unaffected by this flag - as long as the documentArchiveID in the chunk is compatible, the plug-in must be able to read the data via <a class="el" href="group___plug-_in___document___controller.html#a6ad2b9f4070e12178057c3c9590f4c32" title="Unarchive the internal state of the specified objects. This call can be used both for unarchiving ent...">ARADocumentControllerInterface::restoreObjectsFromArchive()</a>. </p> |
| 548 | + |
519 | 549 | </div> |
520 | 550 | </div> |
521 | 551 |
|
@@ -587,7 +617,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ab1f2cdc93d55890bc575e29d |
587 | 617 | <div class="line">{</div> |
588 | 618 | <div class="line"> <span class="keywordflow">return</span> PlugInEntry::getPlugInEntry<MyFactoryConfig, MyDocumentController> ()->getFactory ();</div> |
589 | 619 | <div class="line">}</div> |
590 | | -<div class="ttc" id="agroup___plug-_in___factory_html_struct_a_r_a_factory"><div class="ttname"><a href="group___plug-_in___factory.html#struct_a_r_a_factory">ARAFactory</a></div><div class="ttdoc">Static plug-in factory. All pointers herein must remain valid as long as the binary is loaded....</div><div class="ttdef"><b>Definition:</b> ARAInterface.h:3092</div></div> |
| 620 | +<div class="ttc" id="agroup___plug-_in___factory_html_struct_a_r_a_factory"><div class="ttname"><a href="group___plug-_in___factory.html#struct_a_r_a_factory">ARAFactory</a></div><div class="ttdoc">Static plug-in factory. All pointers herein must remain valid as long as the binary is loaded....</div><div class="ttdef"><b>Definition:</b> ARAInterface.h:3109</div></div> |
591 | 621 | </div><!-- fragment --> |
592 | 622 | </div> |
593 | 623 | </div> |
|
0 commit comments