Sophie

Sophie

distrib > Fedora > 14 > x86_64 > by-pkgid > ca44e7e21c4b6cd5e0c5fdfbf12b4de7 > files > 127

libnjb-devel-2.2.6-6.fc12.x86_64.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>libnjb: njb_struct Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="dirs.html"><span>Directories</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>njb_struct Struct Reference</h1><!-- doxytag: class="njb_struct" --><code>#include &lt;<a class="el" href="libnjb_8h_source.html">libnjb.h</a>&gt;</code>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct usb_device *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnjb__struct.html#5703cb46e41b303fb973b3258c0ba139">device</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">usb_dev_handle *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnjb__struct.html#5b182e45017e20b5d918f0ac3d1b6301">dev</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">u_int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnjb__struct.html#f54ed9ccc1aa24c1af05d12adfb01262">usb_config</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">u_int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnjb__struct.html#6a131a16e19be926733578a2b8ed8f46">usb_interface</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">u_int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnjb__struct.html#e41df03fa0e8d827eb57ca610b2b6ad1">usb_bulk_in_ep</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">u_int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnjb__struct.html#92169f5213824000a2e56e8528a65013">usb_bulk_out_ep</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnjb__struct.html#405f9cb824196553362aa8d4ad546c07">device_type</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnjb__struct.html#aad8fccdf8d609be04aafb7442020fd6">updated</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">u_int32_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnjb__struct.html#00d603de711b1f1c9f815cba557b097f">xfersize</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnjb__struct.html#9c34c2b8e18cdf2c494f2cfe2e1e4f5f">protocol_state</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnjb__struct.html#a0782d852f52c99002785bf17224efc9">error_stack</a></td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Main NJB object struct <dl compact><dt><b>Examples: </b></dt><dd>

<p>
<a class="el" href="cursesplay_8c-example.html#_a0">cursesplay.c</a>, <a class="el" href="delfile_8c-example.html#_a0">delfile.c</a>, <a class="el" href="deltr_8c-example.html#_a0">deltr.c</a>, <a class="el" href="dumpeax_8c-example.html#_a0">dumpeax.c</a>, <a class="el" href="dumptime_8c-example.html#_a0">dumptime.c</a>, <a class="el" href="files_8c-example.html#_a6">files.c</a>, <a class="el" href="fwupgrade_8c-example.html#_a0">fwupgrade.c</a>, <a class="el" href="getfile_8c-example.html#_a0">getfile.c</a>, <a class="el" href="getowner_8c-example.html#_a0">getowner.c</a>, <a class="el" href="gettr_8c-example.html#_a0">gettr.c</a>, <a class="el" href="getusage_8c-example.html#_a0">getusage.c</a>, <a class="el" href="handshake_8c-example.html#_a0">handshake.c</a>, <a class="el" href="pl_8c-example.html#_a9">pl.c</a>, <a class="el" href="play_8c-example.html#_a0">play.c</a>, <a class="el" href="playlists_8c-example.html#_a9">playlists.c</a>, <a class="el" href="sendfile_8c-example.html#_a0">sendfile.c</a>, <a class="el" href="sendtr_8c-example.html#_a0">sendtr.c</a>, <a class="el" href="setowner_8c-example.html#_a0">setowner.c</a>, <a class="el" href="setpbm_8c-example.html#_a0">setpbm.c</a>, <a class="el" href="settime_8c-example.html#_a8">settime.c</a>, <a class="el" href="tagtr_8c-example.html#_a0">tagtr.c</a>, and <a class="el" href="tracks_8c-example.html#_a14">tracks.c</a>.</dl><hr><h2>Field Documentation</h2>
<a class="anchor" name="5b182e45017e20b5d918f0ac3d1b6301"></a><!-- doxytag: member="njb_struct::dev" ref="5b182e45017e20b5d918f0ac3d1b6301" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">usb_dev_handle* <a class="el" href="structnjb__struct.html#5b182e45017e20b5d918f0ac3d1b6301">njb_struct::dev</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The libusb device handle for this jukebox 
<p>Referenced by <a class="el" href="base_8c_source.html#l00147">njb_close()</a>, <a class="el" href="base_8c_source.html#l00089">njb_discover()</a>, <a class="el" href="base_8c_source.html#l00290">njb_open()</a>, <a class="el" href="usb__io_8c_source.html#l00076">usb_pipe_read()</a>, <a class="el" href="usb__io_8c_source.html#l00027">usb_pipe_write()</a>, and <a class="el" href="usb__io_8c_source.html#l00123">usb_setup()</a>.</p>

</div>
</div><p>
<a class="anchor" name="5703cb46e41b303fb973b3258c0ba139"></a><!-- doxytag: member="njb_struct::device" ref="5703cb46e41b303fb973b3258c0ba139" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct usb_device* <a class="el" href="structnjb__struct.html#5703cb46e41b303fb973b3258c0ba139">njb_struct::device</a><code> [read]</code>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The libusb device for this jukebox 
<p>Referenced by <a class="el" href="base_8c_source.html#l00089">njb_discover()</a>, and <a class="el" href="base_8c_source.html#l00290">njb_open()</a>.</p>

</div>
</div><p>
<a class="anchor" name="405f9cb824196553362aa8d4ad546c07"></a><!-- doxytag: member="njb_struct::device_type" ref="405f9cb824196553362aa8d4ad546c07" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="structnjb__struct.html#405f9cb824196553362aa8d4ad546c07">njb_struct::device_type</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
what kind of jukebox this is <dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="handshake_8c-example.html#a10">handshake.c</a>.</dl>
<p>Referenced by <a class="el" href="datafile_8c_source.html#l00321">datafile_pack3()</a>, <a class="el" href="datafile_8c_source.html#l00426">new_folder_pack3()</a>, <a class="el" href="procedure_8c_source.html#l02008">NJB_Adjust_EAX()</a>, <a class="el" href="procedure_8c_source.html#l00223">NJB_Capture()</a>, <a class="el" href="procedure_8c_source.html#l00184">NJB_Close()</a>, <a class="el" href="base_8c_source.html#l00147">njb_close()</a>, <a class="el" href="procedure_8c_source.html#l01872">NJB_Create_Folder()</a>, <a class="el" href="procedure_8c_source.html#l02453">NJB_Delete_Datafile()</a>, <a class="el" href="procedure_8c_source.html#l02167">NJB_Delete_Playlist()</a>, <a class="el" href="procedure_8c_source.html#l02415">NJB_Delete_Track()</a>, <a class="el" href="base_8c_source.html#l00387">njb_device_is_usb20()</a>, <a class="el" href="base_8c_source.html#l00089">njb_discover()</a>, <a class="el" href="procedure_8c_source.html#l02740">NJB_Elapsed_Time()</a>, <a class="el" href="procedure_8c_source.html#l03366">NJB_Get_Auxpower()</a>, <a class="el" href="procedure_8c_source.html#l03328">NJB_Get_Battery_Charging()</a>, <a class="el" href="procedure_8c_source.html#l03294">NJB_Get_Battery_Level()</a>, <a class="el" href="procedure_8c_source.html#l03043">NJB_Get_Bitmap_Dimensions()</a>, <a class="el" href="procedure_8c_source.html#l00846">NJB_Get_Datafile_Tag()</a>, <a class="el" href="procedure_8c_source.html#l03456">NJB_Get_Device_Name()</a>, <a class="el" href="base_8c_source.html#l00396">njb_get_device_protocol()</a>, <a class="el" href="procedure_8c_source.html#l00657">NJB_Get_Disk_Usage()</a>, <a class="el" href="procedure_8c_source.html#l01952">NJB_Get_EAX_Type()</a>, <a class="el" href="procedure_8c_source.html#l03509">NJB_Get_Firmware_Revision()</a>, <a class="el" href="procedure_8c_source.html#l03542">NJB_Get_Hardware_Revision()</a>, <a class="el" href="procedure_8c_source.html#l03203">NJB_Get_NJB1_Libcounter()</a>, <a class="el" href="procedure_8c_source.html#l00697">NJB_Get_Owner_String()</a>, <a class="el" href="procedure_8c_source.html#l00592">NJB_Get_Playlist()</a>, <a class="el" href="procedure_8c_source.html#l03411">NJB_Get_SDMI_ID()</a>, <a class="el" href="procedure_8c_source.html#l02079">NJB_Get_Time()</a>, <a class="el" href="procedure_8c_source.html#l00980">NJB_Get_Track_fd()</a>, <a class="el" href="procedure_8c_source.html#l00503">NJB_Get_Track_Tag()</a>, <a class="el" href="base_8c_source.html#l00369">njb_get_usb_device_name()</a>, <a class="el" href="procedure_8c_source.html#l00297">NJB_Handshake()</a>, <a class="el" href="procedure_8c_source.html#l00130">NJB_Open()</a>, <a class="el" href="procedure_8c_source.html#l03131">NJB_Ping()</a>, <a class="el" href="procedure_8c_source.html#l02503">NJB_Play_Track()</a>, <a class="el" href="procedure_8c_source.html#l02551">NJB_Queue_Track()</a>, <a class="el" href="procedure_8c_source.html#l00266">NJB_Release()</a>, <a class="el" href="procedure_8c_source.html#l02895">NJB_Replace_Track_Tag()</a>, <a class="el" href="procedure_8c_source.html#l00811">NJB_Reset_Get_Datafile_Tag()</a>, <a class="el" href="procedure_8c_source.html#l01915">NJB_Reset_Get_EAX_Type()</a>, <a class="el" href="procedure_8c_source.html#l00556">NJB_Reset_Get_Playlist()</a>, <a class="el" href="procedure_8c_source.html#l00460">NJB_Reset_Get_Track_Tag()</a>, <a class="el" href="procedure_8c_source.html#l01723">NJB_Send_File()</a>, <a class="el" href="procedure_8c_source.html#l01592">NJB_Send_Track()</a>, <a class="el" href="procedure_8c_source.html#l00746">NJB_Set_Owner_String()</a>, <a class="el" href="procedure_8c_source.html#l02113">NJB_Set_Time()</a>, <a class="el" href="procedure_8c_source.html#l02643">NJB_Stop_Play()</a>, and <a class="el" href="procedure_8c_source.html#l02206">NJB_Update_Playlist()</a>.</p>

</div>
</div><p>
<a class="anchor" name="a0782d852f52c99002785bf17224efc9"></a><!-- doxytag: member="njb_struct::error_stack" ref="a0782d852f52c99002785bf17224efc9" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void* <a class="el" href="structnjb__struct.html#a0782d852f52c99002785bf17224efc9">njb_struct::error_stack</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Error stack, used inside libnjb 
<p>Referenced by <a class="el" href="njb__error_8c_source.html#l00368">NJB_Error_Geterror()</a>, <a class="el" href="njb__error_8c_source.html#l00303">NJB_Error_Pending()</a>, and <a class="el" href="njb__error_8c_source.html#l00342">NJB_Error_Reset_Geterror()</a>.</p>

</div>
</div><p>
<a class="anchor" name="9c34c2b8e18cdf2c494f2cfe2e1e4f5f"></a><!-- doxytag: member="njb_struct::protocol_state" ref="9c34c2b8e18cdf2c494f2cfe2e1e4f5f" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void* <a class="el" href="structnjb__struct.html#9c34c2b8e18cdf2c494f2cfe2e1e4f5f">njb_struct::protocol_state</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
dereferenced and maintained individually by protocol implementations 
<p>Referenced by <a class="el" href="protocol3_8c_source.html#l04474">njb3_destroy_state()</a>, <a class="el" href="protocol3_8c_source.html#l00041">njb3_init_state()</a>, <a class="el" href="protocol3_8c_source.html#l02908">njb3_reset_get_datafile_tag()</a>, <a class="el" href="protocol3_8c_source.html#l02703">njb3_reset_get_playlist_tag()</a>, <a class="el" href="procedure_8c_source.html#l02008">NJB_Adjust_EAX()</a>, <a class="el" href="procedure_8c_source.html#l00223">NJB_Capture()</a>, <a class="el" href="procedure_8c_source.html#l03366">NJB_Get_Auxpower()</a>, <a class="el" href="procedure_8c_source.html#l03328">NJB_Get_Battery_Charging()</a>, <a class="el" href="procedure_8c_source.html#l03294">NJB_Get_Battery_Level()</a>, <a class="el" href="procedure_8c_source.html#l03043">NJB_Get_Bitmap_Dimensions()</a>, <a class="el" href="procedure_8c_source.html#l00846">NJB_Get_Datafile_Tag()</a>, <a class="el" href="procedure_8c_source.html#l03456">NJB_Get_Device_Name()</a>, <a class="el" href="procedure_8c_source.html#l00424">NJB_Get_Extended_Tags()</a>, <a class="el" href="procedure_8c_source.html#l03509">NJB_Get_Firmware_Revision()</a>, <a class="el" href="procedure_8c_source.html#l03542">NJB_Get_Hardware_Revision()</a>, <a class="el" href="protocol_8c_source.html#l01265">njb_get_nexteax()</a>, <a class="el" href="procedure_8c_source.html#l03203">NJB_Get_NJB1_Libcounter()</a>, <a class="el" href="procedure_8c_source.html#l00592">NJB_Get_Playlist()</a>, <a class="el" href="procedure_8c_source.html#l03411">NJB_Get_SDMI_ID()</a>, <a class="el" href="procedure_8c_source.html#l00980">NJB_Get_Track_fd()</a>, <a class="el" href="procedure_8c_source.html#l00503">NJB_Get_Track_Tag()</a>, <a class="el" href="procedure_8c_source.html#l00297">NJB_Handshake()</a>, <a class="el" href="protocol_8c_source.html#l00043">njb_init_state()</a>, <a class="el" href="protocol_8c_source.html#l00285">njb_ping()</a>, <a class="el" href="protocol_8c_source.html#l01197">njb_read_eaxtypes()</a>, <a class="el" href="procedure_8c_source.html#l00811">NJB_Reset_Get_Datafile_Tag()</a>, <a class="el" href="procedure_8c_source.html#l00556">NJB_Reset_Get_Playlist()</a>, <a class="el" href="procedure_8c_source.html#l00460">NJB_Reset_Get_Track_Tag()</a>, and <a class="el" href="procedure_8c_source.html#l03580">NJB_Set_Turbo_Mode()</a>.</p>

</div>
</div><p>
<a class="anchor" name="aad8fccdf8d609be04aafb7442020fd6"></a><!-- doxytag: member="njb_struct::updated" ref="aad8fccdf8d609be04aafb7442020fd6" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="structnjb__struct.html#aad8fccdf8d609be04aafb7442020fd6">njb_struct::updated</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
If the device has been updated with some metadata 
</div>
</div><p>
<a class="anchor" name="e41df03fa0e8d827eb57ca610b2b6ad1"></a><!-- doxytag: member="njb_struct::usb_bulk_in_ep" ref="e41df03fa0e8d827eb57ca610b2b6ad1" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u_int8_t <a class="el" href="structnjb__struct.html#e41df03fa0e8d827eb57ca610b2b6ad1">njb_struct::usb_bulk_in_ep</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The BULK IN endpoint for this jukebox 
<p>Referenced by <a class="el" href="usb__io_8c_source.html#l00076">usb_pipe_read()</a>.</p>

</div>
</div><p>
<a class="anchor" name="92169f5213824000a2e56e8528a65013"></a><!-- doxytag: member="njb_struct::usb_bulk_out_ep" ref="92169f5213824000a2e56e8528a65013" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u_int8_t <a class="el" href="structnjb__struct.html#92169f5213824000a2e56e8528a65013">njb_struct::usb_bulk_out_ep</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The BULK OUT endpoint for this jukebox 
<p>Referenced by <a class="el" href="base_8c_source.html#l00147">njb_close()</a>, and <a class="el" href="usb__io_8c_source.html#l00027">usb_pipe_write()</a>.</p>

</div>
</div><p>
<a class="anchor" name="f54ed9ccc1aa24c1af05d12adfb01262"></a><!-- doxytag: member="njb_struct::usb_config" ref="f54ed9ccc1aa24c1af05d12adfb01262" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u_int8_t <a class="el" href="structnjb__struct.html#f54ed9ccc1aa24c1af05d12adfb01262">njb_struct::usb_config</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The libusb config for this jukebox 
<p>Referenced by <a class="el" href="base_8c_source.html#l00290">njb_open()</a>.</p>

</div>
</div><p>
<a class="anchor" name="6a131a16e19be926733578a2b8ed8f46"></a><!-- doxytag: member="njb_struct::usb_interface" ref="6a131a16e19be926733578a2b8ed8f46" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u_int8_t <a class="el" href="structnjb__struct.html#6a131a16e19be926733578a2b8ed8f46">njb_struct::usb_interface</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The libusb interface for this jukebox 
<p>Referenced by <a class="el" href="base_8c_source.html#l00147">njb_close()</a>, and <a class="el" href="base_8c_source.html#l00290">njb_open()</a>.</p>

</div>
</div><p>
<a class="anchor" name="00d603de711b1f1c9f815cba557b097f"></a><!-- doxytag: member="njb_struct::xfersize" ref="00d603de711b1f1c9f815cba557b097f" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u_int32_t <a class="el" href="structnjb__struct.html#00d603de711b1f1c9f815cba557b097f">njb_struct::xfersize</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The transfer size for endpoints 
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>/builddir/build/BUILD/libnjb-2.2.6/src/<a class="el" href="libnjb_8h_source.html">libnjb.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Jul 26 17:17:29 2009 for libnjb by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
</body>
</html>