540 lines
34 KiB
HTML
540 lines
34 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.15"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Olive: olive Namespace 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">Olive
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.15 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</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="#namespaces">Namespaces</a> |
|
|
<a href="#enum-members">Enumerations</a> |
|
|
<a href="#var-members">Variables</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">olive Namespace Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
|
|
Namespaces</h2></td></tr>
|
|
<tr class="memitem:namespaceolive_1_1timeline"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceolive_1_1timeline.html">timeline</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
|
|
Enumerations</h2></td></tr>
|
|
<tr class="memitem:a04099e7d8a7121ab6a67eb83dce7390f"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceolive.html#a04099e7d8a7121ab6a67eb83dce7390f">TimecodeType</a> { <a class="el" href="namespaceolive.html#a04099e7d8a7121ab6a67eb83dce7390fa9f83e5d8e3aad103cbb84f97188d4b71">kTimecodeDrop</a>,
|
|
<a class="el" href="namespaceolive.html#a04099e7d8a7121ab6a67eb83dce7390fa22694a17ce1c462c4eee8b52268fe2d0">kTimecodeNonDrop</a>,
|
|
<a class="el" href="namespaceolive.html#a04099e7d8a7121ab6a67eb83dce7390fae1f4674654164515c045d17dead8f8cf">kTimecodeFrames</a>,
|
|
<a class="el" href="namespaceolive.html#a04099e7d8a7121ab6a67eb83dce7390fa1fefdfdf357c4a5aef332bbbb0c01a95">kTimecodeMilliseconds</a>
|
|
}</td></tr>
|
|
<tr class="memdesc:a04099e7d8a7121ab6a67eb83dce7390f"><td class="mdescLeft"> </td><td class="mdescRight">The TimecodeType enum. <a href="namespaceolive.html#a04099e7d8a7121ab6a67eb83dce7390f">More...</a><br /></td></tr>
|
|
<tr class="separator:a04099e7d8a7121ab6a67eb83dce7390f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af40b7205c5998320e7325168589cfdfe"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceolive.html#af40b7205c5998320e7325168589cfdfe">RecordingMode</a> { <a class="el" href="namespaceolive.html#af40b7205c5998320e7325168589cfdfeaeea7cf3bddb67fd8ddef33fd57247e07">RECORD_MODE_MONO</a>,
|
|
<a class="el" href="namespaceolive.html#af40b7205c5998320e7325168589cfdfeaf5f4ae88c32311ee0ec701a108e81949">RECORD_MODE_STEREO</a>
|
|
}</td></tr>
|
|
<tr class="memdesc:af40b7205c5998320e7325168589cfdfe"><td class="mdescLeft"> </td><td class="mdescRight">The RecordingMode enum. <a href="namespaceolive.html#af40b7205c5998320e7325168589cfdfe">More...</a><br /></td></tr>
|
|
<tr class="separator:af40b7205c5998320e7325168589cfdfe"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6f523bdde126d522f9d2b23f03b148b5"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceolive.html#a6f523bdde126d522f9d2b23f03b148b5">AutoScrollMode</a> { <a class="el" href="namespaceolive.html#a6f523bdde126d522f9d2b23f03b148b5ad255804e4b6795d98f1fe8f8af99fa66">AUTOSCROLL_NO_SCROLL</a>,
|
|
<a class="el" href="namespaceolive.html#a6f523bdde126d522f9d2b23f03b148b5a34a31a9f3485349cddb6a3a6ff5e47af">AUTOSCROLL_PAGE_SCROLL</a>,
|
|
<a class="el" href="namespaceolive.html#a6f523bdde126d522f9d2b23f03b148b5a4d2c722c4d908ed0c65514a02e20a29c">AUTOSCROLL_SMOOTH_SCROLL</a>
|
|
}</td></tr>
|
|
<tr class="memdesc:a6f523bdde126d522f9d2b23f03b148b5"><td class="mdescLeft"> </td><td class="mdescRight">The AutoScrollMode enum. <a href="namespaceolive.html#a6f523bdde126d522f9d2b23f03b148b5">More...</a><br /></td></tr>
|
|
<tr class="separator:a6f523bdde126d522f9d2b23f03b148b5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a80d6149e99745ec465de6238b1c54377"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceolive.html#a80d6149e99745ec465de6238b1c54377">ProjectView</a> { <a class="el" href="namespaceolive.html#a80d6149e99745ec465de6238b1c54377a8830b609d44af082be176fa7a6fa57c9">PROJECT_VIEW_TREE</a>,
|
|
<a class="el" href="namespaceolive.html#a80d6149e99745ec465de6238b1c54377a055e31e2b4a40b3651d2fedd59527db0">PROJECT_VIEW_ICON</a>
|
|
}</td></tr>
|
|
<tr class="memdesc:a80d6149e99745ec465de6238b1c54377"><td class="mdescLeft"> </td><td class="mdescRight">The ProjectView enum. <a href="namespaceolive.html#a80d6149e99745ec465de6238b1c54377">More...</a><br /></td></tr>
|
|
<tr class="separator:a80d6149e99745ec465de6238b1c54377"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a465c6d38e7cc002c2dbb440c33543b6b"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceolive.html#a465c6d38e7cc002c2dbb440c33543b6b">FrameQueueType</a> { <a class="el" href="namespaceolive.html#a465c6d38e7cc002c2dbb440c33543b6bae4ea79ae92c0b383be31897685f77415">FRAME_QUEUE_TYPE_FRAMES</a>,
|
|
<a class="el" href="namespaceolive.html#a465c6d38e7cc002c2dbb440c33543b6baf48cfa65fef01c3f40c814359ef0a934">FRAME_QUEUE_TYPE_SECONDS</a>
|
|
}</td></tr>
|
|
<tr class="memdesc:a465c6d38e7cc002c2dbb440c33543b6b"><td class="mdescLeft"> </td><td class="mdescRight">The FrameQueueType enum. <a href="namespaceolive.html#a465c6d38e7cc002c2dbb440c33543b6b">More...</a><br /></td></tr>
|
|
<tr class="separator:a465c6d38e7cc002c2dbb440c33543b6b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
|
|
Variables</h2></td></tr>
|
|
<tr class="memitem:a22cf74e5a1e641d9efd76f5c29d37233"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_debug_dialog.html">DebugDialog</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceolive.html#a22cf74e5a1e641d9efd76f5c29d37233">DebugDialog</a> = nullptr</td></tr>
|
|
<tr class="separator:a22cf74e5a1e641d9efd76f5c29d37233"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab504a2f41d94a9a692ca0631aff6c5c4"><td class="memItemLeft" align="right" valign="top">const int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceolive.html#ab504a2f41d94a9a692ca0631aff6c5c4">kSaveVersion</a> = 190219</td></tr>
|
|
<tr class="memdesc:ab504a2f41d94a9a692ca0631aff6c5c4"><td class="mdescLeft"> </td><td class="mdescRight">Version identifier for saved projects. <a href="#ab504a2f41d94a9a692ca0631aff6c5c4">More...</a><br /></td></tr>
|
|
<tr class="separator:ab504a2f41d94a9a692ca0631aff6c5c4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af7f5b251a66624a3ffd44da298ee0c03"><td class="memItemLeft" align="right" valign="top">const int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceolive.html#af7f5b251a66624a3ffd44da298ee0c03">kMinimumSaveVersion</a> = 190219</td></tr>
|
|
<tr class="memdesc:af7f5b251a66624a3ffd44da298ee0c03"><td class="mdescLeft"> </td><td class="mdescRight">Minimum project version that this version of Olive can open. <a href="#af7f5b251a66624a3ffd44da298ee0c03">More...</a><br /></td></tr>
|
|
<tr class="separator:af7f5b251a66624a3ffd44da298ee0c03"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa545d1c0a2c95ff1299163779ab44063"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_config.html">Config</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceolive.html#aa545d1c0a2c95ff1299163779ab44063">CurrentConfig</a></td></tr>
|
|
<tr class="separator:aa545d1c0a2c95ff1299163779ab44063"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ace9c09c3b2fcee17ae33537d238c7854"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_runtime_config.html">RuntimeConfig</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceolive.html#ace9c09c3b2fcee17ae33537d238c7854">CurrentRuntimeConfig</a></td></tr>
|
|
<tr class="separator:ace9c09c3b2fcee17ae33537d238c7854"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a727b94e90c57e77ac506938f91b7f296"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_main_window.html">MainWindow</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceolive.html#a727b94e90c57e77ac506938f91b7f296">MainWindow</a></td></tr>
|
|
<tr class="separator:a727b94e90c57e77ac506938f91b7f296"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6258fb86e928c438816911faa7af5d8e"><td class="memItemLeft" align="right" valign="top">std::unique_ptr< <a class="el" href="class_olive_global.html">OliveGlobal</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceolive.html#a6258fb86e928c438816911faa7af5d8e">Global</a></td></tr>
|
|
<tr class="memdesc:a6258fb86e928c438816911faa7af5d8e"><td class="mdescLeft"> </td><td class="mdescRight">Object resource for various global functions used throughout Olive. <a href="#a6258fb86e928c438816911faa7af5d8e">More...</a><br /></td></tr>
|
|
<tr class="separator:a6258fb86e928c438816911faa7af5d8e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad9f6288bdf591993bd0754a5cf750d36"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceolive.html#ad9f6288bdf591993bd0754a5cf750d36">ActiveProjectFilename</a></td></tr>
|
|
<tr class="memdesc:ad9f6288bdf591993bd0754a5cf750d36"><td class="mdescLeft"> </td><td class="mdescRight">Currently active project filename. <a href="#ad9f6288bdf591993bd0754a5cf750d36">More...</a><br /></td></tr>
|
|
<tr class="separator:ad9f6288bdf591993bd0754a5cf750d36"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aae183b688b67aff9c80a2818235f40fb"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceolive.html#aae183b688b67aff9c80a2818235f40fb">AppName</a></td></tr>
|
|
<tr class="memdesc:aae183b688b67aff9c80a2818235f40fb"><td class="mdescLeft"> </td><td class="mdescRight">Current application name. <a href="#aae183b688b67aff9c80a2818235f40fb">More...</a><br /></td></tr>
|
|
<tr class="separator:aae183b688b67aff9c80a2818235f40fb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a744552310677c752db006db4d104e58e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_project_model.html">ProjectModel</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceolive.html#a744552310677c752db006db4d104e58e">project_model</a></td></tr>
|
|
<tr class="separator:a744552310677c752db006db4d104e58e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae3a6d85e10b5c40dc6372ae794585cff"><td class="memItemLeft" align="right" valign="top"><a class="el" href="clip_8h.html#a2a0d48184294d399b0adc41f6e1de6c7">SequencePtr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceolive.html#ae3a6d85e10b5c40dc6372ae794585cff">ActiveSequence</a> = nullptr</td></tr>
|
|
<tr class="separator:ae3a6d85e10b5c40dc6372ae794585cff"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a45d8824d54adc1b0ab260262c2ae24f3"><td class="memItemLeft" align="right" valign="top">QUndoStack </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceolive.html#a45d8824d54adc1b0ab260262c2ae24f3">UndoStack</a></td></tr>
|
|
<tr class="separator:a45d8824d54adc1b0ab260262c2ae24f3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa22772e6ca279d55442cff34c50ff59a"><td class="memItemLeft" align="right" valign="top">QCursor </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceolive.html#aa22772e6ca279d55442cff34c50ff59a">Cursor_LeftTrim</a></td></tr>
|
|
<tr class="separator:aa22772e6ca279d55442cff34c50ff59a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af68dc527a9664ecccebca6ba4e180659"><td class="memItemLeft" align="right" valign="top">QCursor </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceolive.html#af68dc527a9664ecccebca6ba4e180659">Cursor_RightTrim</a></td></tr>
|
|
<tr class="separator:af68dc527a9664ecccebca6ba4e180659"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5dd2458c58d7d43e99b5b2b883e0ac8c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_focus_filter.html">FocusFilter</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceolive.html#a5dd2458c58d7d43e99b5b2b883e0ac8c">FocusFilter</a></td></tr>
|
|
<tr class="separator:a5dd2458c58d7d43e99b5b2b883e0ac8c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1cebcb1eb862b55634168a2f886bd9b7"><td class="memItemLeft" align="right" valign="top">std::unique_ptr< <a class="el" href="class_media_icon_service.html">MediaIconService</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceolive.html#a1cebcb1eb862b55634168a2f886bd9b7">media_icon_service</a></td></tr>
|
|
<tr class="separator:a1cebcb1eb862b55634168a2f886bd9b7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a89c3d4d7982b29de454d2d8b2087ef14"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_menu_helper.html">MenuHelper</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceolive.html#a89c3d4d7982b29de454d2d8b2087ef14">MenuHelper</a></td></tr>
|
|
<tr class="memdesc:a89c3d4d7982b29de454d2d8b2087ef14"><td class="mdescLeft"> </td><td class="mdescRight">A global <a class="el" href="class_menu_helper.html">MenuHelper</a> object to assist menu creation throughout Olive. <a href="#a89c3d4d7982b29de454d2d8b2087ef14">More...</a><br /></td></tr>
|
|
<tr class="separator:a89c3d4d7982b29de454d2d8b2087ef14"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a id="a6f523bdde126d522f9d2b23f03b148b5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6f523bdde126d522f9d2b23f03b148b5">◆ </a></span>AutoScrollMode</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="namespaceolive.html#a6f523bdde126d522f9d2b23f03b148b5">olive::AutoScrollMode</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The AutoScrollMode enum. </p>
|
|
<p>The <a class="el" href="class_timeline.html">Timeline</a> in Olive can automatically scroll to follow the playhead when the sequence is playing. The <a class="el" href="class_timeline.html">Timeline</a> will respond to <a class="el" href="struct_config.html#a0ffb85ab4ef2f8e22c1e813f08de821a" title="Auto-scroll mode.">Config::autoscroll</a> set to a value from this enum. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a6f523bdde126d522f9d2b23f03b148b5ad255804e4b6795d98f1fe8f8af99fa66"></a>AUTOSCROLL_NO_SCROLL </td><td class="fielddoc"><p>Don't auto-scroll, scrolling will not follow the playhead </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a6f523bdde126d522f9d2b23f03b148b5a34a31a9f3485349cddb6a3a6ff5e47af"></a>AUTOSCROLL_PAGE_SCROLL </td><td class="fielddoc"><p>Page auto-scroll (default), if the playhead goes off-screen while playing, the scroll will jump ahead one "page" to follow it </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a6f523bdde126d522f9d2b23f03b148b5a4d2c722c4d908ed0c65514a02e20a29c"></a>AUTOSCROLL_SMOOTH_SCROLL </td><td class="fielddoc"><p>Smooth auto-scroll, Olive will scroll to keep the playhead in the center of the screen at all times while playing </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a465c6d38e7cc002c2dbb440c33543b6b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a465c6d38e7cc002c2dbb440c33543b6b">◆ </a></span>FrameQueueType</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="namespaceolive.html#a465c6d38e7cc002c2dbb440c33543b6b">olive::FrameQueueType</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The FrameQueueType enum. </p>
|
|
<p>Olive keeps a "frame queue" in memory to allow smoother playback/seeking. In order to give users control over the amount of memory consumption vs. playback performance, they can control how many frames are cached into memory. For extra fidelity, they can choose this value as a metric of either frames or seconds.</p>
|
|
<p>The playback engine (<a class="el" href="playback_8h.html">playback/playback.h</a>) responds to both <a class="el" href="struct_config.html#acd9d0f261bde3aa2737518bd898c77eb" title="Previous frame queue type.">Config::previous_queue_type</a> and <a class="el" href="struct_config.html#ad59a3771a143ff08903457f21fc8f6d6" title="Upcoming frame queue type.">Config::upcoming_queue_type</a> set to a value from this enum. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a465c6d38e7cc002c2dbb440c33543b6bae4ea79ae92c0b383be31897685f77415"></a>FRAME_QUEUE_TYPE_FRAMES </td><td class="fielddoc"><p>Queue size value is in frames </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a465c6d38e7cc002c2dbb440c33543b6baf48cfa65fef01c3f40c814359ef0a934"></a>FRAME_QUEUE_TYPE_SECONDS </td><td class="fielddoc"><p>Queue size value is in seconds </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a80d6149e99745ec465de6238b1c54377"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a80d6149e99745ec465de6238b1c54377">◆ </a></span>ProjectView</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="namespaceolive.html#a80d6149e99745ec465de6238b1c54377">olive::ProjectView</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The ProjectView enum. </p>
|
|
<p>The media in the <a class="el" href="class_project.html">Project</a> panel can be displayed as a tree hierarchy or as an icon view. The <a class="el" href="class_project.html">Project</a> panel responds to <a class="el" href="struct_config.html#a92b0d6168472eac66bfa94c914fa414f" title="Project view type.">Config::project_view_type</a> set to a value from this enum. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a80d6149e99745ec465de6238b1c54377a8830b609d44af082be176fa7a6fa57c9"></a>PROJECT_VIEW_TREE </td><td class="fielddoc"><p>Display project media in tree hierarchy </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a80d6149e99745ec465de6238b1c54377a055e31e2b4a40b3651d2fedd59527db0"></a>PROJECT_VIEW_ICON </td><td class="fielddoc"><p>Display project media in icon browser </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af40b7205c5998320e7325168589cfdfe"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af40b7205c5998320e7325168589cfdfe">◆ </a></span>RecordingMode</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="namespaceolive.html#af40b7205c5998320e7325168589cfdfe">olive::RecordingMode</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The RecordingMode enum. </p>
|
|
<p>Olive currently supports recording mono or stereo and gives users the option of which mode to use when recording audio in-app. Audio recording responds to <a class="el" href="struct_config.html#a39120b972ddcfbe11be6c5daa7053128" title="Recording mode/channel layout.">Config::recording_mode</a> to a value from this enum. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="af40b7205c5998320e7325168589cfdfeaeea7cf3bddb67fd8ddef33fd57247e07"></a>RECORD_MODE_MONO </td><td class="fielddoc"><p>Record all audio in mono </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="af40b7205c5998320e7325168589cfdfeaf5f4ae88c32311ee0ec701a108e81949"></a>RECORD_MODE_STEREO </td><td class="fielddoc"><p>Record all audio in stereo </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a04099e7d8a7121ab6a67eb83dce7390f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a04099e7d8a7121ab6a67eb83dce7390f">◆ </a></span>TimecodeType</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="namespaceolive.html#a04099e7d8a7121ab6a67eb83dce7390f">olive::TimecodeType</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The TimecodeType enum. </p>
|
|
<p>Frame numbers can be displayed in various different ways. The <a class="el" href="viewer_8cpp.html#a486644e61fff240c2cf1f8e5135b272d">timecode_to_frame()</a> and <a class="el" href="viewer_8cpp.html#a108a12b8385df3c49197f09e8cb3ba84">frame_to_timecode()</a> functions (which should be used for all frame <-> timecode conversions) respond to the timecode display type set in <a class="el" href="struct_config.html#a11feea70575afedc5989f357f345b1ac" title="Timecode display mode.">Config::timecode_view</a> corresponding to a value from this enum. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a04099e7d8a7121ab6a67eb83dce7390fa9f83e5d8e3aad103cbb84f97188d4b71"></a>kTimecodeDrop </td><td class="fielddoc"><p>Show frame number as a drop-frame timecode </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a04099e7d8a7121ab6a67eb83dce7390fa22694a17ce1c462c4eee8b52268fe2d0"></a>kTimecodeNonDrop </td><td class="fielddoc"><p>Show frame number as a non-drop-frame timecode </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a04099e7d8a7121ab6a67eb83dce7390fae1f4674654164515c045d17dead8f8cf"></a>kTimecodeFrames </td><td class="fielddoc"><p>Show frame number as-is with no modifications </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a04099e7d8a7121ab6a67eb83dce7390fa1fefdfdf357c4a5aef332bbbb0c01a95"></a>kTimecodeMilliseconds </td><td class="fielddoc"><p>Show frame number as milliseconds </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Variable Documentation</h2>
|
|
<a id="ad9f6288bdf591993bd0754a5cf750d36"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad9f6288bdf591993bd0754a5cf750d36">◆ </a></span>ActiveProjectFilename</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString olive::ActiveProjectFilename</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Currently active project filename. </p>
|
|
<p>Filename for the currently active project. Empty means the file has not been saved yet. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae3a6d85e10b5c40dc6372ae794585cff"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae3a6d85e10b5c40dc6372ae794585cff">◆ </a></span>ActiveSequence</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="clip_8h.html#a2a0d48184294d399b0adc41f6e1de6c7">SequencePtr</a> olive::ActiveSequence = nullptr</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aae183b688b67aff9c80a2818235f40fb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aae183b688b67aff9c80a2818235f40fb">◆ </a></span>AppName</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString olive::AppName</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Current application name. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa545d1c0a2c95ff1299163779ab44063"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa545d1c0a2c95ff1299163779ab44063">◆ </a></span>CurrentConfig</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="struct_config.html">Config</a> olive::CurrentConfig</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ace9c09c3b2fcee17ae33537d238c7854"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ace9c09c3b2fcee17ae33537d238c7854">◆ </a></span>CurrentRuntimeConfig</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="struct_runtime_config.html">RuntimeConfig</a> olive::CurrentRuntimeConfig</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa22772e6ca279d55442cff34c50ff59a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa22772e6ca279d55442cff34c50ff59a">◆ </a></span>Cursor_LeftTrim</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QCursor olive::Cursor_LeftTrim</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af68dc527a9664ecccebca6ba4e180659"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af68dc527a9664ecccebca6ba4e180659">◆ </a></span>Cursor_RightTrim</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QCursor olive::Cursor_RightTrim</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a22cf74e5a1e641d9efd76f5c29d37233"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a22cf74e5a1e641d9efd76f5c29d37233">◆ </a></span>DebugDialog</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_debug_dialog.html">DebugDialog</a> * olive::DebugDialog = nullptr</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5dd2458c58d7d43e99b5b2b883e0ac8c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5dd2458c58d7d43e99b5b2b883e0ac8c">◆ </a></span>FocusFilter</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_focus_filter.html">FocusFilter</a> olive::FocusFilter</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6258fb86e928c438816911faa7af5d8e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6258fb86e928c438816911faa7af5d8e">◆ </a></span>Global</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::unique_ptr< <a class="el" href="class_olive_global.html">OliveGlobal</a> > olive::Global</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Object resource for various global functions used throughout Olive. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af7f5b251a66624a3ffd44da298ee0c03"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af7f5b251a66624a3ffd44da298ee0c03">◆ </a></span>kMinimumSaveVersion</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const int olive::kMinimumSaveVersion = 190219</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Minimum project version that this version of Olive can open. </p>
|
|
<p>When loading a project, the project's version number is actually checked whether it is somewhere between kSaveVersion and this value (inclusive). This is used if the current version of Olive contains backwards compatibility functionality for older project versions, and is bumped up if such backwards compatibility is ever removed.</p>
|
|
<p>As stated in kSaveVersion documentation, ideally in the future, a system would be in place to account for all project version differences and bring them up to date for the current loading algorithm. This means ideally, this constant stays the same forever, but in this early stage it's not strictly necessary. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab504a2f41d94a9a692ca0631aff6c5c4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab504a2f41d94a9a692ca0631aff6c5c4">◆ </a></span>kSaveVersion</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const int olive::kSaveVersion = 190219</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Version identifier for saved projects. </p>
|
|
<p>This constant is used to identify what version of Olive a project file was saved with. Every project file is saved with the current version number and the version is checked whenever an Olive project is loaded to determine how compatible it'll be with the current version.</p>
|
|
<p>Sometimes this version identifier is used to invoke backwards compatibility in order to keep older project files able to load, but in this early rapidly developing stage, often backwards compatibility is abandoned. Ideally in the future, a class should be made that's able to "convert" an older project into one that the current loading system understands (so that the loading system doesn't get too bloated with backwards compatibility functions). </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a727b94e90c57e77ac506938f91b7f296"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a727b94e90c57e77ac506938f91b7f296">◆ </a></span>MainWindow</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_main_window.html">MainWindow</a> * olive::MainWindow</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1cebcb1eb862b55634168a2f886bd9b7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1cebcb1eb862b55634168a2f886bd9b7">◆ </a></span>media_icon_service</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::unique_ptr< <a class="el" href="class_media_icon_service.html">MediaIconService</a> > olive::media_icon_service</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a89c3d4d7982b29de454d2d8b2087ef14"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a89c3d4d7982b29de454d2d8b2087ef14">◆ </a></span>MenuHelper</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_menu_helper.html">MenuHelper</a> olive::MenuHelper</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>A global <a class="el" href="class_menu_helper.html">MenuHelper</a> object to assist menu creation throughout Olive. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a744552310677c752db006db4d104e58e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a744552310677c752db006db4d104e58e">◆ </a></span>project_model</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_project_model.html">ProjectModel</a> olive::project_model</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a45d8824d54adc1b0ab260262c2ae24f3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a45d8824d54adc1b0ab260262c2ae24f3">◆ </a></span>UndoStack</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QUndoStack olive::UndoStack</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.15
|
|
</small></address>
|
|
</body>
|
|
</html>
|