libnjb-doc 2.2.7~dfsg0-4build1 / usr / share / doc / libnjb-doc / html / protocol3_8c.html

This file is indexed.

/usr/share/doc/libnjb-doc/html/protocol3_8c.html is in libnjb-doc 2.2.7~dfsg0-4build1.

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
<!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.9.1"/>
<title>libnjb: /build/libnjb-D7xUne/libnjb-2.2.7~dfsg0/src/protocol3.c File 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="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 style="padding-left: 0.5em;">
   <div id="projectname">libnjb
   &#160;<span id="projectnumber">2.2.7</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a>  </div>
  <div class="headertitle">
<div class="title">protocol3.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;stdio.h&gt;</code><br />
<code>#include &lt;stdlib.h&gt;</code><br />
<code>#include &lt;fcntl.h&gt;</code><br />
<code>#include &lt;errno.h&gt;</code><br />
<code>#include &lt;string.h&gt;</code><br />
<code>#include &quot;<a class="el" href="libnjb_8h_source.html">libnjb.h</a>&quot;</code><br />
<code>#include &quot;protocol.h&quot;</code><br />
<code>#include &quot;<a class="el" href="protocol3_8h_source.html">protocol3.h</a>&quot;</code><br />
<code>#include &quot;unicode.h&quot;</code><br />
<code>#include &quot;byteorder.h&quot;</code><br />
<code>#include &quot;njb_error.h&quot;</code><br />
<code>#include &quot;usb_io.h&quot;</code><br />
<code>#include &quot;ioutil.h&quot;</code><br />
<code>#include &quot;defs.h&quot;</code><br />
<code>#include &quot;base.h&quot;</code><br />
<code>#include &quot;eax.h&quot;</code><br />
<code>#include &quot;datafile.h&quot;</code><br />
<code>#include &quot;njbtime.h&quot;</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a62e227f18d3a17362052f14a81031035"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="protocol3_8c.html#a62e227f18d3a17362052f14a81031035">njb3_init_state</a> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb)</td></tr>
<tr class="separator:a62e227f18d3a17362052f14a81031035"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afdb2050ba7226f2fff40c2c8dad32d63"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afdb2050ba7226f2fff40c2c8dad32d63"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>njb3_capture</b> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb)</td></tr>
<tr class="separator:afdb2050ba7226f2fff40c2c8dad32d63"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aba0acbc4afe2e0601b4f2bd843033f7a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aba0acbc4afe2e0601b4f2bd843033f7a"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>njb3_release</b> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb)</td></tr>
<tr class="separator:aba0acbc4afe2e0601b4f2bd843033f7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a11ff9d3e1e3a638168f290e68f6a8a20"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="protocol3_8c.html#a11ff9d3e1e3a638168f290e68f6a8a20">njb3_get_codecs</a> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb)</td></tr>
<tr class="separator:a11ff9d3e1e3a638168f290e68f6a8a20"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a175d51cffb0743f1e357096ba6385e72"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a175d51cffb0743f1e357096ba6385e72"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>njb3_ping</b> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb, int type)</td></tr>
<tr class="separator:a175d51cffb0743f1e357096ba6385e72"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a01ddb94dde9f1369519cea9159947291"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="protocol3_8c.html#a01ddb94dde9f1369519cea9159947291">njb3_power_status</a> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb, int *battery_level, int *charging, int *ac_power)</td></tr>
<tr class="separator:a01ddb94dde9f1369519cea9159947291"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7a904a08e61daab9b451a0b1be93154"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac7a904a08e61daab9b451a0b1be93154"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>njb3_readid</b> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb, u_int8_t *sdmiid)</td></tr>
<tr class="separator:ac7a904a08e61daab9b451a0b1be93154"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a68d645693b732a574e60042087836c15"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a68d645693b732a574e60042087836c15"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>njb3_get_disk_usage</b> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb, u_int64_t *totalbytes, u_int64_t *freebytes)</td></tr>
<tr class="separator:a68d645693b732a574e60042087836c15"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8924e6b2003a843df267b8fc5b553809"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8924e6b2003a843df267b8fc5b553809"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>njb3_turnoff_flashing</b> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb)</td></tr>
<tr class="separator:a8924e6b2003a843df267b8fc5b553809"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b1d962a42af73abb8f54a71a7d89454"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3b1d962a42af73abb8f54a71a7d89454"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>njb3_get_owner_string</b> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb, char *name)</td></tr>
<tr class="separator:a3b1d962a42af73abb8f54a71a7d89454"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a285b143109393ab6c2994ddbc9b9767b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a285b143109393ab6c2994ddbc9b9767b"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>njb3_set_owner_string</b> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb, const char *name)</td></tr>
<tr class="separator:a285b143109393ab6c2994ddbc9b9767b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6fcc88f9b6d77b4cef7bccf94bac98f7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6fcc88f9b6d77b4cef7bccf94bac98f7"></a>
<a class="el" href="group__types.html#gaf9e1f9bd6e9ec54c7f9fca05421def85">njb_time_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>njb3_get_time</b> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb)</td></tr>
<tr class="separator:a6fcc88f9b6d77b4cef7bccf94bac98f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a22acc85e6102a1192c59c481d20b07aa"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="protocol3_8c.html#a22acc85e6102a1192c59c481d20b07aa">njb3_set_bitmap</a> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb, u_int16_t x_size, u_int16_t y_size, const unsigned char *bitmap)</td></tr>
<tr class="separator:a22acc85e6102a1192c59c481d20b07aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a24ed2882d1e7e5613abc47cdf0da6315"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a24ed2882d1e7e5613abc47cdf0da6315"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>njb3_current_track</b> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb, u_int16_t *position)</td></tr>
<tr class="separator:a24ed2882d1e7e5613abc47cdf0da6315"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa759a34d97424ddd6fe5c1b71ad14cde"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa759a34d97424ddd6fe5c1b71ad14cde"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>njb3_elapsed_time</b> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb, u_int16_t *elapsed, int *change)</td></tr>
<tr class="separator:aa759a34d97424ddd6fe5c1b71ad14cde"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1113dd4798f8bc3365e2bff62f898ae5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1113dd4798f8bc3365e2bff62f898ae5"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>njb3_queue_track</b> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb, u_int32_t trackid)</td></tr>
<tr class="separator:a1113dd4798f8bc3365e2bff62f898ae5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf8324cb82c2e94b128c26921714fb83"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acf8324cb82c2e94b128c26921714fb83"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>njb3_play_track</b> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb, u_int32_t trackid)</td></tr>
<tr class="separator:acf8324cb82c2e94b128c26921714fb83"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad4467e4d30cfd8c459c77bd127d9a5c1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad4467e4d30cfd8c459c77bd127d9a5c1"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>njb3_seek_track</b> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb, u_int32_t pos)</td></tr>
<tr class="separator:ad4467e4d30cfd8c459c77bd127d9a5c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a26bdc06f27e9bd3a7c4d3a3d609888de"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a26bdc06f27e9bd3a7c4d3a3d609888de"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>njb3_clear_play_queue</b> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb)</td></tr>
<tr class="separator:a26bdc06f27e9bd3a7c4d3a3d609888de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a96ab0ff8931cd3289910f176bfa6c80d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a96ab0ff8931cd3289910f176bfa6c80d"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>njb3_ctrl_playing</b> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb, int cmd)</td></tr>
<tr class="separator:a96ab0ff8931cd3289910f176bfa6c80d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9558b5c73e653512eff11368f54c999a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9558b5c73e653512eff11368f54c999a"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>njb3_set_time</b> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb, <a class="el" href="group__types.html#gaf9e1f9bd6e9ec54c7f9fca05421def85">njb_time_t</a> *time)</td></tr>
<tr class="separator:a9558b5c73e653512eff11368f54c999a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4850e792bd60d885a97e9e18e69e2cd1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4850e792bd60d885a97e9e18e69e2cd1"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>njb3_reset_get_track_tag</b> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb)</td></tr>
<tr class="separator:a4850e792bd60d885a97e9e18e69e2cd1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2697f9e22c794a3a3a1eb65a8e56da16"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2697f9e22c794a3a3a1eb65a8e56da16"></a>
<a class="el" href="group__types.html#ga2aafa65a7621da928873ff6e1188a55f">njb_songid_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>njb3_get_next_track_tag</b> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb)</td></tr>
<tr class="separator:a2697f9e22c794a3a3a1eb65a8e56da16"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d8dffadc9e0e8238ffc840075cc2293"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="protocol3_8c.html#a7d8dffadc9e0e8238ffc840075cc2293">njb3_reset_get_playlist_tag</a> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb)</td></tr>
<tr class="separator:a7d8dffadc9e0e8238ffc840075cc2293"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8dabd50507d0c7da1eb50e61cf0a9725"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8dabd50507d0c7da1eb50e61cf0a9725"></a>
<a class="el" href="group__types.html#ga7984899d4039a5362edd96e978af8a14">njb_playlist_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>njb3_get_next_playlist_tag</b> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb)</td></tr>
<tr class="separator:a8dabd50507d0c7da1eb50e61cf0a9725"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed14b36adbbd0c6d045f0be3e86c5a37"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="protocol3_8c.html#aed14b36adbbd0c6d045f0be3e86c5a37">njb3_reset_get_datafile_tag</a> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb)</td></tr>
<tr class="separator:aed14b36adbbd0c6d045f0be3e86c5a37"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa528e1750eb39e0847148e496214dd31"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa528e1750eb39e0847148e496214dd31"></a>
<a class="el" href="group__types.html#gaf65b414e23c5aaa13e67700158b494c5">njb_datafile_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>njb3_get_next_datafile_tag</b> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb)</td></tr>
<tr class="separator:aa528e1750eb39e0847148e496214dd31"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab3bd6aa4236ca180dbc0e52261727fbd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab3bd6aa4236ca180dbc0e52261727fbd"></a>
<a class="el" href="group__types.html#gac0440b30392b9cf97b2bbe1de02a3e72">njb_keyval_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>njb3_get_keys</b> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb)</td></tr>
<tr class="separator:ab3bd6aa4236ca180dbc0e52261727fbd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a39f5e56cf736150456085eda4f411980"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a39f5e56cf736150456085eda4f411980"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>njb3_read_keys</b> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb)</td></tr>
<tr class="separator:a39f5e56cf736150456085eda4f411980"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a956618fea29be076067bf608190398bf"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="protocol3_8c.html#a956618fea29be076067bf608190398bf">njb3_request_file_chunk</a> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb, u_int32_t fileid, u_int32_t offset)</td></tr>
<tr class="separator:a956618fea29be076067bf608190398bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abaa0008a62887dbbd36f6b27a8e740d8"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="protocol3_8c.html#abaa0008a62887dbbd36f6b27a8e740d8">njb3_get_file_block</a> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb, unsigned char *data, u_int32_t maxsize)</td></tr>
<tr class="separator:abaa0008a62887dbbd36f6b27a8e740d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8358969ecbddc9de8059f46942ecacf8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8358969ecbddc9de8059f46942ecacf8"></a>
u_int32_t&#160;</td><td class="memItemRight" valign="bottom"><b>njb3_create_file</b> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb, unsigned char *ptag, u_int32_t tagsize, u_int16_t database)</td></tr>
<tr class="separator:a8358969ecbddc9de8059f46942ecacf8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a134aa663a2ea12f7861d0d13237efbea"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a134aa663a2ea12f7861d0d13237efbea"></a>
u_int32_t&#160;</td><td class="memItemRight" valign="bottom"><b>njb3_send_file_chunk</b> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb, unsigned char *chunk, u_int32_t chunksize, u_int32_t fileid)</td></tr>
<tr class="separator:a134aa663a2ea12f7861d0d13237efbea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab09e267d5412bb0e83171eb7fd02f909"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab09e267d5412bb0e83171eb7fd02f909"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>njb3_send_file_complete</b> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb, u_int32_t fileid)</td></tr>
<tr class="separator:ab09e267d5412bb0e83171eb7fd02f909"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af84b3480f5145a28f6be1ebb5aa5f9e1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af84b3480f5145a28f6be1ebb5aa5f9e1"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>njb3_create_folder</b> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb, const char *name, u_int32_t *folderid)</td></tr>
<tr class="separator:af84b3480f5145a28f6be1ebb5aa5f9e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a05c0085f0ae2ab2044ad9acecc574901"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a05c0085f0ae2ab2044ad9acecc574901"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>njb3_delete_item</b> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb, u_int32_t itemid)</td></tr>
<tr class="separator:a05c0085f0ae2ab2044ad9acecc574901"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a37d979a879932b2fe83ada01e5bc1f0b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="protocol3_8c.html#a37d979a879932b2fe83ada01e5bc1f0b">njb3_update_16bit_frame</a> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb, u_int32_t itemid, u_int16_t frameid, u_int16_t value)</td></tr>
<tr class="separator:a37d979a879932b2fe83ada01e5bc1f0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af4c77c8c12bea8f1a8c125e70019d5c1"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="protocol3_8c.html#af4c77c8c12bea8f1a8c125e70019d5c1">njb3_update_string_frame</a> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb, u_int32_t itemid, u_int16_t frameid, unsigned char *str)</td></tr>
<tr class="separator:af4c77c8c12bea8f1a8c125e70019d5c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ebd3fa717d5de9b1031a4a0afbab84f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="protocol3_8c.html#a2ebd3fa717d5de9b1031a4a0afbab84f">njb3_update_tag</a> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb, u_int32_t itemid, unsigned char *ptag, u_int32_t ptagsize)</td></tr>
<tr class="separator:a2ebd3fa717d5de9b1031a4a0afbab84f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a91831b3fc1d2c5ccafd2f62629733074"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="protocol3_8c.html#a91831b3fc1d2c5ccafd2f62629733074">njb3_create_playlist</a> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb, char *name, u_int32_t *plid)</td></tr>
<tr class="separator:a91831b3fc1d2c5ccafd2f62629733074"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a120bb9ef7afb94102b2e1f29515de0dd"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="protocol3_8c.html#a120bb9ef7afb94102b2e1f29515de0dd">njb3_add_multiple_tracks_to_playlist</a> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb, u_int32_t *plid, u_int32_t *trids, u_int16_t ntracks)</td></tr>
<tr class="separator:a120bb9ef7afb94102b2e1f29515de0dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6fe00399de0e30cfd70220b28c49e781"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="protocol3_8c.html#a6fe00399de0e30cfd70220b28c49e781">njb3_control_eax_processor</a> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb, u_int16_t state)</td></tr>
<tr class="separator:a6fe00399de0e30cfd70220b28c49e781"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa8ba4ddaec2c9a8169c295b3471c03f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaa8ba4ddaec2c9a8169c295b3471c03f"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>njb3_adjust_eax</b> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb, u_int16_t eaxid, u_int16_t patchindex, u_int16_t active, u_int16_t scalevalue)</td></tr>
<tr class="separator:aaa8ba4ddaec2c9a8169c295b3471c03f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae554d66361acc1fc602bdf57cdb51165"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae554d66361acc1fc602bdf57cdb51165"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>njb3_read_eaxtypes</b> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb)</td></tr>
<tr class="separator:ae554d66361acc1fc602bdf57cdb51165"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac05d1f73a99bb9badbb25d983a8d18a1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac05d1f73a99bb9badbb25d983a8d18a1"></a>
<a class="el" href="group__types.html#ga73659426f8a09253f5f33fccbe29d04a">njb_eax_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>njb3_get_nexteax</b> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb)</td></tr>
<tr class="separator:ac05d1f73a99bb9badbb25d983a8d18a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea0edf60a976fbe68c0fd3e0aae10984"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="protocol3_8c.html#aea0edf60a976fbe68c0fd3e0aae10984">njb3_announce_firmware</a> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb, u_int32_t size)</td></tr>
<tr class="separator:aea0edf60a976fbe68c0fd3e0aae10984"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b9e5af429aa7667396bf28ef310b698"><td class="memItemLeft" align="right" valign="top">u_int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="protocol3_8c.html#a2b9e5af429aa7667396bf28ef310b698">njb3_send_firmware_chunk</a> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb, u_int32_t chunksize, unsigned char *chunk)</td></tr>
<tr class="separator:a2b9e5af429aa7667396bf28ef310b698"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a11c183e62511af9c23f15e5f1d7a1912"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="protocol3_8c.html#a11c183e62511af9c23f15e5f1d7a1912">njb3_get_firmware_confirmation</a> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb)</td></tr>
<tr class="separator:a11c183e62511af9c23f15e5f1d7a1912"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6cb6360d563df97d2ee763389ca94343"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="protocol3_8c.html#a6cb6360d563df97d2ee763389ca94343">njb3_destroy_state</a> (<a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *njb)</td></tr>
<tr class="separator:a6cb6360d563df97d2ee763389ca94343"><td class="memSeparator" colspan="2">&#160;</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:a60db410c9e82d9e61b1bf0be607922ed"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="protocol3_8c.html#a60db410c9e82d9e61b1bf0be607922ed">__sub_depth</a></td></tr>
<tr class="separator:a60db410c9e82d9e61b1bf0be607922ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This file contains the protocol code for the series 3 devices. This protocol is believed to have the internal name "PDE" at Creative. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a120bb9ef7afb94102b2e1f29515de0dd"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int njb3_add_multiple_tracks_to_playlist </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *&#160;</td>
          <td class="paramname"><em>njb</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u_int32_t *&#160;</td>
          <td class="paramname"><em>plid</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u_int32_t *&#160;</td>
          <td class="paramname"><em>trids</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u_int16_t&#160;</td>
          <td class="paramname"><em>ntracks</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This takes an array of 32-bit track ID:s and adds it to a certain playlist.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">plid</td><td>a pointer to the ID of the playlist to add tracks to. The ID will change during this operation, so it is important to pass in a pointer. </td></tr>
    <tr><td class="paramname">trids</td><td>an array of tracks to add </td></tr>
    <tr><td class="paramname">ntracks</td><td>absolute number of tracks in the array. </td></tr>
  </table>
  </dd>
</dl>

<p>References <a class="el" href="group__errors.html#ga5c208b472a9c60a87594ce1bfb242dc2">EO_BADSTATUS</a>, <a class="el" href="group__errors.html#ga2ab3784c31667eb7bd6dbc4296818720">EO_NOMEM</a>, <a class="el" href="group__errors.html#ga8de17ff66996c8931a20cfe89d11ccdd">EO_RDSHORT</a>, <a class="el" href="group__errors.html#ga97318c787753893aeb11144235d44528">EO_USBBLK</a>, <a class="el" href="byteorder_8c.html#a3cb7e2df65722e11213de39bb33c1e8e">from_16bit_to_njb3_bytes()</a>, <a class="el" href="byteorder_8c.html#a4380f8c5e2841f39c2f63ce44d64df59">from_32bit_to_njb3_bytes()</a>, <a class="el" href="byteorder_8c.html#acb74cfe4128d22e25013ed54b85a8d59">njb3_bytes_to_16bit()</a>, <a class="el" href="byteorder_8c.html#a618da9efc31dbc8fd27fd163d8555c47">njb3_bytes_to_32bit()</a>, and <a class="el" href="usb__io_8c.html#a8c28681c955500d111dcf28ff9532b94">usb_pipe_read()</a>.</p>

<p>Referenced by <a class="el" href="group__playlistapi.html#gae1873045c0cd0eb27465992c3479b975">NJB_Update_Playlist()</a>.</p>

</div>
</div>
<a class="anchor" id="aea0edf60a976fbe68c0fd3e0aae10984"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int njb3_announce_firmware </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *&#160;</td>
          <td class="paramname"><em>njb</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u_int32_t&#160;</td>
          <td class="paramname"><em>size</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This announces a firmware image which will then be sent in several chunks.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">njb</td><td>a pointer to the njb device object to use </td></tr>
    <tr><td class="paramname">size</td><td>the total size of the firmware image </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, -1 on failure </dd></dl>

<p>References <a class="el" href="byteorder_8c.html#a4380f8c5e2841f39c2f63ce44d64df59">from_32bit_to_njb3_bytes()</a>, and <a class="el" href="protocol3_8c.html#aea0edf60a976fbe68c0fd3e0aae10984">njb3_announce_firmware()</a>.</p>

<p>Referenced by <a class="el" href="protocol3_8h.html#aea0edf60a976fbe68c0fd3e0aae10984">njb3_announce_firmware()</a>, and <a class="el" href="group__basic.html#ga5d9a7922425646d198ac81692e8e99ce">NJB_Send_Firmware()</a>.</p>

</div>
</div>
<a class="anchor" id="a6fe00399de0e30cfd70220b28c49e781"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int njb3_control_eax_processor </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *&#160;</td>
          <td class="paramname"><em>njb</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u_int16_t&#160;</td>
          <td class="paramname"><em>state</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This command turns the EAX DSP processor on or off. You will also have to adjust the currently used EAX effect with njb3_adjust_eax() below. </p>

<p>References <a class="el" href="group__errors.html#ga5c208b472a9c60a87594ce1bfb242dc2">EO_BADSTATUS</a>, and <a class="el" href="byteorder_8c.html#a3cb7e2df65722e11213de39bb33c1e8e">from_16bit_to_njb3_bytes()</a>.</p>

<p>Referenced by <a class="el" href="group__eaxapi.html#gab488254f5ddf7783105eb859ac4a14e1">NJB_Adjust_EAX()</a>.</p>

</div>
</div>
<a class="anchor" id="a91831b3fc1d2c5ccafd2f62629733074"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int njb3_create_playlist </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *&#160;</td>
          <td class="paramname"><em>njb</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u_int32_t *&#160;</td>
          <td class="paramname"><em>plid</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This function creates a new playlist on the device.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>the name of the playlist to create, as a string. </td></tr>
    <tr><td class="paramname">plid</td><td>a pointer to a 32-bit numer that will contain the new playlist ID after this routine has been called. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, -1 on failure. </dd></dl>

<p>References <a class="el" href="group__errors.html#ga5c208b472a9c60a87594ce1bfb242dc2">EO_BADSTATUS</a>, <a class="el" href="group__errors.html#ga2ab3784c31667eb7bd6dbc4296818720">EO_NOMEM</a>, <a class="el" href="group__errors.html#ga8de17ff66996c8931a20cfe89d11ccdd">EO_RDSHORT</a>, <a class="el" href="group__errors.html#ga97318c787753893aeb11144235d44528">EO_USBBLK</a>, <a class="el" href="byteorder_8c.html#a3cb7e2df65722e11213de39bb33c1e8e">from_16bit_to_njb3_bytes()</a>, <a class="el" href="byteorder_8c.html#acb74cfe4128d22e25013ed54b85a8d59">njb3_bytes_to_16bit()</a>, <a class="el" href="byteorder_8c.html#a618da9efc31dbc8fd27fd163d8555c47">njb3_bytes_to_32bit()</a>, <a class="el" href="unicode_8c.html#acd147761736f45b4282bebb6147c440a">ucs2strlen()</a>, and <a class="el" href="usb__io_8c.html#a8c28681c955500d111dcf28ff9532b94">usb_pipe_read()</a>.</p>

<p>Referenced by <a class="el" href="group__playlistapi.html#gae1873045c0cd0eb27465992c3479b975">NJB_Update_Playlist()</a>.</p>

</div>
</div>
<a class="anchor" id="a6cb6360d563df97d2ee763389ca94343"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void njb3_destroy_state </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *&#160;</td>
          <td class="paramname"><em>njb</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Cleans up any dangling lists in the njb_t state holder struct, and other stuff related to the state. </p>

<p>References <a class="el" href="structnjb__keyval__struct.html#ade5a69af8470cfb5935b078b4feae737">njb_keyval_struct::next</a>, <a class="el" href="structnjb3__state__t.html#a0344b9c490856a3f76cd4aa859e0375f">njb3_state_t::product_name</a>, and <a class="el" href="structnjb__struct.html#a9c34c2b8e18cdf2c494f2cfe2e1e4f5f">njb_struct::protocol_state</a>.</p>

<p>Referenced by <a class="el" href="group__basic.html#ga13a9c926c430f38f3a6535ecaaf3e9b9">NJB_Close()</a>.</p>

</div>
</div>
<a class="anchor" id="a11ff9d3e1e3a638168f290e68f6a8a20"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int njb3_get_codecs </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *&#160;</td>
          <td class="paramname"><em>njb</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Reads the supported audio file types. </p>

<p>References <a class="el" href="group__errors.html#ga5c208b472a9c60a87594ce1bfb242dc2">EO_BADSTATUS</a>, <a class="el" href="group__errors.html#ga8de17ff66996c8931a20cfe89d11ccdd">EO_RDSHORT</a>, <a class="el" href="group__errors.html#ga97318c787753893aeb11144235d44528">EO_USBBLK</a>, <a class="el" href="byteorder_8c.html#acb74cfe4128d22e25013ed54b85a8d59">njb3_bytes_to_16bit()</a>, and <a class="el" href="usb__io_8c.html#a8c28681c955500d111dcf28ff9532b94">usb_pipe_read()</a>.</p>

<p>Referenced by <a class="el" href="procedure_8c.html#af77a8af68d57e51d6b7959d696954e07">NJB_Handshake()</a>.</p>

</div>
</div>
<a class="anchor" id="abaa0008a62887dbbd36f6b27a8e740d8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int njb3_get_file_block </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *&#160;</td>
          <td class="paramname"><em>njb</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned char *&#160;</td>
          <td class="paramname"><em>data</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u_int32_t&#160;</td>
          <td class="paramname"><em>maxsize</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This function retrieves a part of the requested chunk. Short reads are allowed, so the caller must make sure that it is called as many times as is needed to retrieve the entire file chunk.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">data</td><td>an allocated byte array to store the retrieved chunk in. </td></tr>
    <tr><td class="paramname">maxsize</td><td>the maximum number of bytes to retrieve from this chunk at a time. </td></tr>
  </table>
  </dd>
</dl>

<p>References <a class="el" href="group__errors.html#ga97318c787753893aeb11144235d44528">EO_USBBLK</a>, and <a class="el" href="usb__io_8c.html#a8c28681c955500d111dcf28ff9532b94">usb_pipe_read()</a>.</p>

<p>Referenced by <a class="el" href="group__tagapi.html#gab99507fb41c1527e58a449812a5d99e6">NJB_Get_Track_fd()</a>.</p>

</div>
</div>
<a class="anchor" id="a11c183e62511af9c23f15e5f1d7a1912"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int njb3_get_firmware_confirmation </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *&#160;</td>
          <td class="paramname"><em>njb</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This simply reads back the device status after a firmware upgrade. </p>

<p>References <a class="el" href="group__errors.html#ga5c208b472a9c60a87594ce1bfb242dc2">EO_BADSTATUS</a>.</p>

<p>Referenced by <a class="el" href="group__basic.html#ga5d9a7922425646d198ac81692e8e99ce">NJB_Send_Firmware()</a>.</p>

</div>
</div>
<a class="anchor" id="a62e227f18d3a17362052f14a81031035"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int njb3_init_state </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *&#160;</td>
          <td class="paramname"><em>njb</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Initializes the basic state of the njb-&gt;protocol_state for the PROTOCOL3-devices. </p>

<p>References <a class="el" href="structnjb3__state__t.html#a662a0c02b8ad844581597b4c2fac0231">njb3_state_t::eax_processor_active</a>, <a class="el" href="structnjb3__state__t.html#ae68cb8235ab1d125bd5c47d4bb3c02b4">njb3_state_t::fwMajor</a>, <a class="el" href="structnjb3__state__t.html#ac7ac5bf4b8514b0c198a6cc272a3e34e">njb3_state_t::fwMinor</a>, <a class="el" href="structnjb3__state__t.html#ac3aaedbd330c61123f71d84c09f70c3e">njb3_state_t::fwRel</a>, <a class="el" href="structnjb3__state__t.html#a60e1db701cc6f1a3e6e6acbfb86ab26b">njb3_state_t::hwMajor</a>, <a class="el" href="structnjb3__state__t.html#a6492b0af17edf2b3f840c40d54df222c">njb3_state_t::hwMinor</a>, <a class="el" href="structnjb3__state__t.html#a861f0b8e9ff6cf19008fc0f21ba27b3a">njb3_state_t::hwRel</a>, <a class="el" href="group__turboflags.html#ga20569a6a8aa4559411fcc1bcbba7f161">NJB_TURBO_ON</a>, <a class="el" href="structnjb3__state__t.html#a0344b9c490856a3f76cd4aa859e0375f">njb3_state_t::product_name</a>, <a class="el" href="structnjb__struct.html#a9c34c2b8e18cdf2c494f2cfe2e1e4f5f">njb_struct::protocol_state</a>, and <a class="el" href="structnjb3__state__t.html#a86ba6395f4d2a8f171cc6251ace4b9e1">njb3_state_t::turbo_mode</a>.</p>

<p>Referenced by <a class="el" href="group__basic.html#gaa631536b597d8f8cb73eeb47eff6640a">NJB_Open()</a>.</p>

</div>
</div>
<a class="anchor" id="a01ddb94dde9f1369519cea9159947291"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int njb3_power_status </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *&#160;</td>
          <td class="paramname"><em>njb</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int *&#160;</td>
          <td class="paramname"><em>battery_level</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int *&#160;</td>
          <td class="paramname"><em>charging</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int *&#160;</td>
          <td class="paramname"><em>ac_power</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This function reads out the current battery level and charging status from a series 3 device. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">battery_level</td><td>a variable that will hold the current level after the call. </td></tr>
    <tr><td class="paramname">charging</td><td>if the battery is charging, this variable will hold 1 after the call, else 0. </td></tr>
    <tr><td class="paramname">ac_power</td><td>if the charger is connected, this variable will hold 1 after the call, else 0. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, -1 on failure. If the call fails, all other return values are invalid. </dd></dl>

<p>References <a class="el" href="group__errors.html#ga5c208b472a9c60a87594ce1bfb242dc2">EO_BADSTATUS</a>, <a class="el" href="group__errors.html#ga8de17ff66996c8931a20cfe89d11ccdd">EO_RDSHORT</a>, <a class="el" href="group__errors.html#ga97318c787753893aeb11144235d44528">EO_USBBLK</a>, <a class="el" href="byteorder_8c.html#acb74cfe4128d22e25013ed54b85a8d59">njb3_bytes_to_16bit()</a>, and <a class="el" href="usb__io_8c.html#a8c28681c955500d111dcf28ff9532b94">usb_pipe_read()</a>.</p>

<p>Referenced by <a class="el" href="group__basic.html#ga9f03a2404de7dfd084adea3c68fdb0f9">NJB_Get_Auxpower()</a>, <a class="el" href="group__basic.html#gaa5b633ed905de58a13b5682fa14c5113">NJB_Get_Battery_Charging()</a>, and <a class="el" href="group__basic.html#ga9e284653140092c2fe42fbb20e73265d">NJB_Get_Battery_Level()</a>.</p>

</div>
</div>
<a class="anchor" id="a956618fea29be076067bf608190398bf"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int njb3_request_file_chunk </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *&#160;</td>
          <td class="paramname"><em>njb</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u_int32_t&#160;</td>
          <td class="paramname"><em>fileid</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u_int32_t&#160;</td>
          <td class="paramname"><em>offset</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This function requests a chunk from a certain file. The offset may index into the file. The chunk transfer size is 1MB by default (as used by creative) but may actually exceed that.</p>
<p>Returns actual chunk size or -1 if failed. </p>

<p>References <a class="el" href="group__errors.html#ga5c208b472a9c60a87594ce1bfb242dc2">EO_BADSTATUS</a>, <a class="el" href="group__errors.html#ga8de17ff66996c8931a20cfe89d11ccdd">EO_RDSHORT</a>, <a class="el" href="group__errors.html#ga97318c787753893aeb11144235d44528">EO_USBBLK</a>, <a class="el" href="byteorder_8c.html#a4380f8c5e2841f39c2f63ce44d64df59">from_32bit_to_njb3_bytes()</a>, <a class="el" href="byteorder_8c.html#acb74cfe4128d22e25013ed54b85a8d59">njb3_bytes_to_16bit()</a>, <a class="el" href="byteorder_8c.html#a618da9efc31dbc8fd27fd163d8555c47">njb3_bytes_to_32bit()</a>, and <a class="el" href="usb__io_8c.html#a8c28681c955500d111dcf28ff9532b94">usb_pipe_read()</a>.</p>

<p>Referenced by <a class="el" href="group__tagapi.html#gab99507fb41c1527e58a449812a5d99e6">NJB_Get_Track_fd()</a>.</p>

</div>
</div>
<a class="anchor" id="aed14b36adbbd0c6d045f0be3e86c5a37"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int njb3_reset_get_datafile_tag </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *&#160;</td>
          <td class="paramname"><em>njb</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This routine retrieves the list of datafiles, and returns the first item. </p>

<p>References <a class="el" href="structnjb__struct.html#a9c34c2b8e18cdf2c494f2cfe2e1e4f5f">njb_struct::protocol_state</a>.</p>

<p>Referenced by <a class="el" href="group__datatagapi.html#gae05722e976c41992fbb6323b9edd617a">NJB_Reset_Get_Datafile_Tag()</a>.</p>

</div>
</div>
<a class="anchor" id="a7d8dffadc9e0e8238ffc840075cc2293"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int njb3_reset_get_playlist_tag </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *&#160;</td>
          <td class="paramname"><em>njb</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This routine retrieves the list of playlists, while also filling in each playlist post with it's respective track ID:s. </p>

<p>References <a class="el" href="structnjb__playlist__struct.html#a28598c46dd2b06f882f13f4fc0bcbec9">njb_playlist_struct::nextpl</a>, and <a class="el" href="structnjb__struct.html#a9c34c2b8e18cdf2c494f2cfe2e1e4f5f">njb_struct::protocol_state</a>.</p>

<p>Referenced by <a class="el" href="group__playlistapi.html#ga3781a9a6f68d7ab3ac5970fc4f2c80d9">NJB_Reset_Get_Playlist()</a>.</p>

</div>
</div>
<a class="anchor" id="a2b9e5af429aa7667396bf28ef310b698"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u_int32_t njb3_send_firmware_chunk </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *&#160;</td>
          <td class="paramname"><em>njb</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u_int32_t&#160;</td>
          <td class="paramname"><em>chunksize</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned char *&#160;</td>
          <td class="paramname"><em>chunk</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This sends a chunk of firmware. Typically the chunks are <code>NJB3_FIRMWARE_CHUNK_SIZE</code> each, except for the last chunk.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">njb</td><td>a pointer to the njb device object to use </td></tr>
    <tr><td class="paramname">chunksize</td><td>the size of this chunk </td></tr>
    <tr><td class="paramname">chunk</td><td>a pointer to the raw bytes representing this firmware chunk </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, -1 on failure </dd></dl>

</div>
</div>
<a class="anchor" id="a22acc85e6102a1192c59c481d20b07aa"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int njb3_set_bitmap </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *&#160;</td>
          <td class="paramname"><em>njb</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u_int16_t&#160;</td>
          <td class="paramname"><em>x_size</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u_int16_t&#160;</td>
          <td class="paramname"><em>y_size</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const unsigned char *&#160;</td>
          <td class="paramname"><em>bitmap</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>NJB2 only (shall be expanded for all jukeboxes). Set up the black/white bitmap shown on shutdown.</p>
<p>The bitmap must be exactly 1088 bytes large, coded as a serial bitmap of 136x64 pixels. The final 4 bits per line are not shown, because the the display of the NJB2 has only 132x64 pixels.</p>
<p>A set pixel (1) means dark, an unset means white.</p>
<p>To create a compatible bitmap, take a 132x64 PBM file (of course not a ASCII-coded, but a binary "P4") and cut off the header.</p>
<p>Explaination of the JBM1 file format: </p><pre>
Byte offset:     Contents:
0x00 - 0x03      "JBM1"
0x04 - 0x05      width of bitmap in pixels 16bit
                 unsigned bigendian integer
0x06 - 0x07      height of bitmap in pixels 16bit
                 unsigned bigendian integer
0x08 - 0x0b      file format version? contains 0x00000001
                 as a 32bit unsigned bigendian integer
0x0c - fileend   actual bitmap data
</pre><p>The bitmap data is black-and-white and each bit represents a single pixel. A set pixel is 1 and a cleared pixel is 0. The bitmap is stored in 16bit unsigned integers which are little-endian, and each of these 16bit integers form a vertical, eight-pixel high and two-pixel wide "bar". </p>

<p>References <a class="el" href="group__errors.html#ga5c208b472a9c60a87594ce1bfb242dc2">EO_BADSTATUS</a>, <a class="el" href="group__errors.html#ga2ab3784c31667eb7bd6dbc4296818720">EO_NOMEM</a>, <a class="el" href="byteorder_8c.html#a3cb7e2df65722e11213de39bb33c1e8e">from_16bit_to_njb3_bytes()</a>, and <a class="el" href="byteorder_8c.html#a4380f8c5e2841f39c2f63ce44d64df59">from_32bit_to_njb3_bytes()</a>.</p>

<p>Referenced by <a class="el" href="group__basic.html#gae5871d21d0a4c8e0c9984ffcd47c01ca">NJB_Set_Bitmap()</a>.</p>

</div>
</div>
<a class="anchor" id="a37d979a879932b2fe83ada01e5bc1f0b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int njb3_update_16bit_frame </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *&#160;</td>
          <td class="paramname"><em>njb</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u_int32_t&#160;</td>
          <td class="paramname"><em>itemid</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u_int16_t&#160;</td>
          <td class="paramname"><em>frameid</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u_int16_t&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This function will update a single 16bit metadata frame associated with a certain item (track, playlist or datafile). Only call this function to modify 16-bit values!</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">itemid</td><td>the item ID (track, playlist or datafile) to modify. </td></tr>
    <tr><td class="paramname">frameid</td><td>the frame ID of the frame to modyfy. Must be a 16-bit frame. </td></tr>
    <tr><td class="paramname">valud</td><td>the new 16-bit value. </td></tr>
  </table>
  </dd>
</dl>

<p>References <a class="el" href="group__errors.html#ga5c208b472a9c60a87594ce1bfb242dc2">EO_BADSTATUS</a>, <a class="el" href="byteorder_8c.html#a3cb7e2df65722e11213de39bb33c1e8e">from_16bit_to_njb3_bytes()</a>, and <a class="el" href="byteorder_8c.html#a4380f8c5e2841f39c2f63ce44d64df59">from_32bit_to_njb3_bytes()</a>.</p>

</div>
</div>
<a class="anchor" id="af4c77c8c12bea8f1a8c125e70019d5c1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int njb3_update_string_frame </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *&#160;</td>
          <td class="paramname"><em>njb</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u_int32_t&#160;</td>
          <td class="paramname"><em>itemid</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u_int16_t&#160;</td>
          <td class="paramname"><em>frameid</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned char *&#160;</td>
          <td class="paramname"><em>str</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This function updates a single string of metadata associated with a certain item (track, playlist or datafile). Only call this routine to modify string frames!</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">itemid</td><td>the item ID (track, playlist or datafile) to be modified. </td></tr>
    <tr><td class="paramname">frameid</td><td>the frame ID of the frame to be updated. </td></tr>
    <tr><td class="paramname">str</td><td>the new string value. </td></tr>
  </table>
  </dd>
</dl>

<p>References <a class="el" href="group__errors.html#ga5c208b472a9c60a87594ce1bfb242dc2">EO_BADSTATUS</a>, <a class="el" href="group__errors.html#ga2ab3784c31667eb7bd6dbc4296818720">EO_NOMEM</a>, <a class="el" href="byteorder_8c.html#a3cb7e2df65722e11213de39bb33c1e8e">from_16bit_to_njb3_bytes()</a>, <a class="el" href="byteorder_8c.html#a4380f8c5e2841f39c2f63ce44d64df59">from_32bit_to_njb3_bytes()</a>, and <a class="el" href="unicode_8c.html#acd147761736f45b4282bebb6147c440a">ucs2strlen()</a>.</p>

<p>Referenced by <a class="el" href="group__playlistapi.html#gae1873045c0cd0eb27465992c3479b975">NJB_Update_Playlist()</a>.</p>

</div>
</div>
<a class="anchor" id="a2ebd3fa717d5de9b1031a4a0afbab84f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int njb3_update_tag </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__types.html#gaa9ef8fd950a0f007dd4c5156f5b8079a">njb_t</a> *&#160;</td>
          <td class="paramname"><em>njb</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u_int32_t&#160;</td>
          <td class="paramname"><em>itemid</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned char *&#160;</td>
          <td class="paramname"><em>ptag</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u_int32_t&#160;</td>
          <td class="paramname"><em>ptagsize</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>A function to update a block of metadata on the series 3 devices. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">itemid</td><td>the track (or similar) whose metadata is to be updated. </td></tr>
    <tr><td class="paramname">ptag</td><td>a packed metadata structure for series 3 devices. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, -1 on failure. </dd></dl>

<p>References <a class="el" href="group__errors.html#ga5c208b472a9c60a87594ce1bfb242dc2">EO_BADSTATUS</a>, <a class="el" href="group__errors.html#ga2ab3784c31667eb7bd6dbc4296818720">EO_NOMEM</a>, and <a class="el" href="byteorder_8c.html#a4380f8c5e2841f39c2f63ce44d64df59">from_32bit_to_njb3_bytes()</a>.</p>

<p>Referenced by <a class="el" href="group__tagapi.html#ga8714367c0e56b681b75a7c7af9b2b739">NJB_Replace_Track_Tag()</a>.</p>

</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a class="anchor" id="a60db410c9e82d9e61b1bf0be607922ed"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int __sub_depth</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The current subroutine depth for all of libnjb (global) </p>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>

APT Browse - Built by Thomas Orozco.