mirror of
https://github.com/aaru-dps/libaaruformat.git
synced 2026-11-04 19:35:12 +00:00
Update documentation.
This commit is contained in:
@@ -3,12 +3,12 @@
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
||||
<meta name="generator" content="Doxygen 1.16.1"/>
|
||||
<meta name="generator" content="Doxygen 1.18.0"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>libaaruformat: TrackEntry Struct 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>
|
||||
<script type="text/javascript" src="codefolding.js"></script>
|
||||
<script type="text/javascript" src="clipboard.js"></script>
|
||||
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
@@ -35,22 +35,47 @@
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.16.1 -->
|
||||
<!-- Generated by Doxygen 1.18.0 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
||||
let searchBox = new SearchBox("searchBox", "search/",'.html');
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
$(function() { codefold.init(); });
|
||||
document.addEventListener('DOMContentLoaded', codefold.init);
|
||||
</script>
|
||||
<script type="application/json" id="doxygen-config">
|
||||
{
|
||||
"relPath": "",
|
||||
"generateTreeView": true,
|
||||
"searchEngine": true,
|
||||
"serverBasedSearch": false,
|
||||
"disableIndex": false,
|
||||
"dynamicMenus": true,
|
||||
"fullSidebar": false
|
||||
}
|
||||
</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',true);
|
||||
$(function() { init_search(); });
|
||||
});
|
||||
</script>
|
||||
<div id="main-nav"></div>
|
||||
<div id="main-nav-mobile">
|
||||
<div class="sm sm-dox"><input id="main-menu-state" type="checkbox"/>
|
||||
<label class="main-menu-btn" for="main-menu-state">
|
||||
<span class="main-menu-btn-icon"></span> Toggle main menu visibility</label>
|
||||
<span id="searchBoxPos1"></span>
|
||||
</div>
|
||||
</div><!-- main-nav-mobile -->
|
||||
<div id="main-nav">
|
||||
<ul class="sm sm-dox" id="main-menu">
|
||||
<li id="searchBoxPos2">
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<span id="MSearchSelect" class="search-icon"><span class="search-icon-dropdown"></span></span>
|
||||
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><div id="MSearchCloseImg" class="close-icon"></div></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div><!-- main-nav -->
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
@@ -58,20 +83,16 @@ $(function() {
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
<div id="splitbar" class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(function(){initNavTree('structTrackEntry.html','',''); });
|
||||
document.addEventListener('DOMContentLoaded',() => { initNavTree('structTrackEntry.html','',''); });
|
||||
</script>
|
||||
<div id="container">
|
||||
<div id="doc-content">
|
||||
<!-- window showing the filter options -->
|
||||
<div id="MSearchSelectWindow"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||
<div id="MSearchSelectWindow">
|
||||
</div>
|
||||
|
||||
<!-- iframe showing the search results (closed by default) -->
|
||||
@@ -101,7 +122,7 @@ $(function(){initNavTree('structTrackEntry.html','',''); });
|
||||
<tr class="heading"><td colspan="2"><h2 id="header-pub-attribs" class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
|
||||
Data Fields</h2></td></tr>
|
||||
<tr class="memitem:aa6464108b61ee648a5aa8e6ffcc9a59a" id="r_aa6464108b61ee648a5aa8e6ffcc9a59a"><td class="memItemLeft">uint8_t </td><td class="memItemRight"><a class="el" href="#aa6464108b61ee648a5aa8e6ffcc9a59a">sequence</a></td></tr>
|
||||
<tr class="memdesc:aa6464108b61ee648a5aa8e6ffcc9a59a"><td class="mdescLeft"> </td><td class="mdescRight">Track number (1..99 typical for CD audio/data). 0 may indicate placeholder/non-standard. <br /></td></tr>
|
||||
<tr class="memdesc:aa6464108b61ee648a5aa8e6ffcc9a59a"><td class="mdescLeft"> </td><td class="mdescRight">Track number (1..99 typical for CD audio/data). <br /></td></tr>
|
||||
<tr class="memitem:ac8dd4cd45f2757b51a27385c7731dde4" id="r_ac8dd4cd45f2757b51a27385c7731dde4"><td class="memItemLeft">uint8_t </td><td class="memItemRight"><a class="el" href="#ac8dd4cd45f2757b51a27385c7731dde4">type</a></td></tr>
|
||||
<tr class="memdesc:ac8dd4cd45f2757b51a27385c7731dde4"><td class="mdescLeft"> </td><td class="mdescRight">Track type (value from <a class="el" href="enums_8h.html#ad80740dd555f7d3688d2c4d9f44d3b04" title="TrackType">TrackType</a>). <br /></td></tr>
|
||||
<tr class="memitem:aa82e4a2aa2cfecee9891f117e9494cdf" id="r_aa82e4a2aa2cfecee9891f117e9494cdf"><td class="memItemLeft">int64_t </td><td class="memItemRight"><a class="el" href="#aa82e4a2aa2cfecee9891f117e9494cdf">start</a></td></tr>
|
||||
@@ -136,9 +157,9 @@ Data Fields</h2></td></tr>
|
||||
|
||||
<p>Inclusive ending LBA of the track. </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="optical_8h_source.html#l00076">76</a> of file <a class="el" href="optical_8h_source.html">optical.h</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="optical_8h_source.html#l00077">77</a> of file <a class="el" href="optical_8h_source.html">optical.h</a>.</p>
|
||||
|
||||
<p class="reference">Referenced by <a class="el" href="write_8c_source.html#l00102">aaruf_write_sector()</a>, and <a class="el" href="write_8c_source.html#l00623">aaruf_write_sector_long()</a>.</p>
|
||||
<p class="reference">Referenced by <a class="el" href="write_8c_source.html#l00152">aaruf_write_sector()</a>, and <a class="el" href="write_8c_source.html#l00682">aaruf_write_sector_long()</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -156,9 +177,9 @@ Data Fields</h2></td></tr>
|
||||
|
||||
<p>Control / attribute bitfield (see file documentation for suggested bit mapping). </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="optical_8h_source.html#l00080">80</a> of file <a class="el" href="optical_8h_source.html">optical.h</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="optical_8h_source.html#l00081">81</a> of file <a class="el" href="optical_8h_source.html">optical.h</a>.</p>
|
||||
|
||||
<p class="reference">Referenced by <a class="el" href="read_8c_source.html#l02240">aaruf_read_sector_tag()</a>, and <a class="el" href="write_8c_source.html#l02273">aaruf_write_sector_tag()</a>.</p>
|
||||
<p class="reference">Referenced by <a class="el" href="read_8c_source.html#l02295">aaruf_read_sector_tag()</a>, and <a class="el" href="write_8c_source.html#l02306">aaruf_write_sector_tag()</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -176,9 +197,9 @@ Data Fields</h2></td></tr>
|
||||
|
||||
<p>ISRC raw 13-byte code (no null terminator). All zeros if not present. </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="optical_8h_source.html#l00079">79</a> of file <a class="el" href="optical_8h_source.html">optical.h</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="optical_8h_source.html#l00080">80</a> of file <a class="el" href="optical_8h_source.html">optical.h</a>.</p>
|
||||
|
||||
<p class="reference">Referenced by <a class="el" href="read_8c_source.html#l02240">aaruf_read_sector_tag()</a>, and <a class="el" href="write_8c_source.html#l02273">aaruf_write_sector_tag()</a>.</p>
|
||||
<p class="reference">Referenced by <a class="el" href="read_8c_source.html#l02295">aaruf_read_sector_tag()</a>, and <a class="el" href="write_8c_source.html#l02306">aaruf_write_sector_tag()</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -196,7 +217,7 @@ Data Fields</h2></td></tr>
|
||||
|
||||
<p>Pre-gap length in sectors preceding track start (0 if none). </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="optical_8h_source.html#l00077">77</a> of file <a class="el" href="optical_8h_source.html">optical.h</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="optical_8h_source.html#l00078">78</a> of file <a class="el" href="optical_8h_source.html">optical.h</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -212,11 +233,12 @@ Data Fields</h2></td></tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Track number (1..99 typical for CD audio/data). 0 may indicate placeholder/non-standard. </p>
|
||||
<p>Track number (1..99 typical for CD audio/data). </p>
|
||||
<p>0 is a valid hidden track preceding track 1, as used by CD-i Ready and similar discs. </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="optical_8h_source.html#l00073">73</a> of file <a class="el" href="optical_8h_source.html">optical.h</a>.</p>
|
||||
|
||||
<p class="reference">Referenced by <a class="el" href="read_8c_source.html#l01274">aaruf_read_track_sector()</a>, <a class="el" href="optical_8c_source.html#l00393">aaruf_set_tracks()</a>, <a class="el" href="write_8c_source.html#l00102">aaruf_write_sector()</a>, <a class="el" href="write_8c_source.html#l00623">aaruf_write_sector_long()</a>, and <a class="el" href="optical_8c_source.html#l00112">process_tracks_block()</a>.</p>
|
||||
<p class="reference">Referenced by <a class="el" href="read_8c_source.html#l01282">aaruf_read_track_sector()</a>, <a class="el" href="optical_8c_source.html#l00428">aaruf_set_tracks()</a>, <a class="el" href="write_8c_source.html#l00152">aaruf_write_sector()</a>, <a class="el" href="write_8c_source.html#l00682">aaruf_write_sector_long()</a>, and <a class="el" href="optical_8c_source.html#l00116">process_tracks_block()</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -234,9 +256,9 @@ Data Fields</h2></td></tr>
|
||||
|
||||
<p>Session number (1-based). 1 for single-session discs. </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="optical_8h_source.html#l00078">78</a> of file <a class="el" href="optical_8h_source.html">optical.h</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="optical_8h_source.html#l00079">79</a> of file <a class="el" href="optical_8h_source.html">optical.h</a>.</p>
|
||||
|
||||
<p class="reference">Referenced by <a class="el" href="write_8c_source.html#l00102">aaruf_write_sector()</a>.</p>
|
||||
<p class="reference">Referenced by <a class="el" href="write_8c_source.html#l00152">aaruf_write_sector()</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -254,9 +276,9 @@ Data Fields</h2></td></tr>
|
||||
|
||||
<p>Inclusive starting LBA of the track. </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="optical_8h_source.html#l00075">75</a> of file <a class="el" href="optical_8h_source.html">optical.h</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="optical_8h_source.html#l00076">76</a> of file <a class="el" href="optical_8h_source.html">optical.h</a>.</p>
|
||||
|
||||
<p class="reference">Referenced by <a class="el" href="read_8c_source.html#l01430">aaruf_read_sector_long()</a>, <a class="el" href="read_8c_source.html#l02240">aaruf_read_sector_tag()</a>, <a class="el" href="read_8c_source.html#l01274">aaruf_read_track_sector()</a>, <a class="el" href="write_8c_source.html#l00102">aaruf_write_sector()</a>, <a class="el" href="write_8c_source.html#l00623">aaruf_write_sector_long()</a>, and <a class="el" href="write_8c_source.html#l02273">aaruf_write_sector_tag()</a>.</p>
|
||||
<p class="reference">Referenced by <a class="el" href="read_8c_source.html#l01438">aaruf_read_sector_long()</a>, <a class="el" href="read_8c_source.html#l02295">aaruf_read_sector_tag()</a>, <a class="el" href="read_8c_source.html#l01282">aaruf_read_track_sector()</a>, <a class="el" href="write_8c_source.html#l00152">aaruf_write_sector()</a>, <a class="el" href="write_8c_source.html#l00682">aaruf_write_sector_long()</a>, and <a class="el" href="write_8c_source.html#l02306">aaruf_write_sector_tag()</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -274,9 +296,9 @@ Data Fields</h2></td></tr>
|
||||
|
||||
<p>Track type (value from <a class="el" href="enums_8h.html#ad80740dd555f7d3688d2c4d9f44d3b04" title="TrackType">TrackType</a>). </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="optical_8h_source.html#l00074">74</a> of file <a class="el" href="optical_8h_source.html">optical.h</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="optical_8h_source.html#l00075">75</a> of file <a class="el" href="optical_8h_source.html">optical.h</a>.</p>
|
||||
|
||||
<p class="reference">Referenced by <a class="el" href="read_8c_source.html#l01430">aaruf_read_sector_long()</a>, <a class="el" href="write_8c_source.html#l00102">aaruf_write_sector()</a>, and <a class="el" href="write_8c_source.html#l00623">aaruf_write_sector_long()</a>.</p>
|
||||
<p class="reference">Referenced by <a class="el" href="read_8c_source.html#l01438">aaruf_read_sector_long()</a>, <a class="el" href="write_8c_source.html#l00152">aaruf_write_sector()</a>, and <a class="el" href="write_8c_source.html#l00682">aaruf_write_sector_long()</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -297,7 +319,7 @@ Data Fields</h2></td></tr>
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a href="structTrackEntry.html">TrackEntry</a></li>
|
||||
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.16.1 </li>
|
||||
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.18.0 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
|
||||
Reference in New Issue
Block a user