-
Notifications
You must be signed in to change notification settings - Fork 1
/
classrespeaker_1_1ReSpeaker.html
897 lines (848 loc) · 43.5 KB
/
classrespeaker_1_1ReSpeaker.html
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
<!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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>librespeaker: respeaker::ReSpeaker Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">librespeaker
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacerespeaker.html">respeaker</a></li><li class="navelem"><a class="el" href="classrespeaker_1_1ReSpeaker.html">ReSpeaker</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="classrespeaker_1_1ReSpeaker-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">respeaker::ReSpeaker Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="respeaker_8h_source.html">respeaker.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a79f5b9622b7603bb97f688d94de0bcd3"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1ReSpeaker.html#a79f5b9622b7603bb97f688d94de0bcd3">SetLogLevel</a> (<a class="el" href="namespacerespeaker.html#a20e1a7db6be2c508966379af4c46db3d">LogLevel</a> log_level)=0</td></tr>
<tr class="separator:a79f5b9622b7603bb97f688d94de0bcd3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad92eb40da02d097227b4895eff7f09d4"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1ReSpeaker.html#ad92eb40da02d097227b4895eff7f09d4">RegisterChainByHead</a> (<a class="el" href="classrespeaker_1_1BaseNode.html">BaseNode</a> *head_node)=0</td></tr>
<tr class="separator:ad92eb40da02d097227b4895eff7f09d4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac06e89b92cdfcca6b08bbcfeadb908f1"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1ReSpeaker.html#ac06e89b92cdfcca6b08bbcfeadb908f1">RegisterDirectionManagerNode</a> (<a class="el" href="classrespeaker_1_1DirectionManagerNode.html">DirectionManagerNode</a> *dir_manager_node)=0</td></tr>
<tr class="separator:ac06e89b92cdfcca6b08bbcfeadb908f1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4d246376a66fcade2ba9eaefca93494d"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1ReSpeaker.html#a4d246376a66fcade2ba9eaefca93494d">RegisterHotwordDetectionNode</a> (<a class="el" href="classrespeaker_1_1HotwordDetectionNode.html">HotwordDetectionNode</a> *hotword_detection_node)=0</td></tr>
<tr class="separator:a4d246376a66fcade2ba9eaefca93494d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab936880d322ca8da21925a269d06f3be"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1ReSpeaker.html#ab936880d322ca8da21925a269d06f3be">RegisterOutputNode</a> (<a class="el" href="classrespeaker_1_1BaseNode.html">BaseNode</a> *output_node)=0</td></tr>
<tr class="separator:ab936880d322ca8da21925a269d06f3be"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad751960137fb5453e966e96c7fb0cdd0"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1ReSpeaker.html#ad751960137fb5453e966e96c7fb0cdd0">Start</a> (bool *interrupt)=0</td></tr>
<tr class="separator:ad751960137fb5453e966e96c7fb0cdd0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad5fb1bab671f0435e614d9deeba09f51"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1ReSpeaker.html#ad5fb1bab671f0435e614d9deeba09f51">Stop</a> ()=0</td></tr>
<tr class="separator:ad5fb1bab671f0435e614d9deeba09f51"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a95f64bdc200f74800c51e3f778e8019e"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1ReSpeaker.html#a95f64bdc200f74800c51e3f778e8019e">DetectHotword</a> ()=0</td></tr>
<tr class="separator:a95f64bdc200f74800c51e3f778e8019e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af7a0a6846f4e9036a69e804f1a424f6a"><td class="memItemLeft" align="right" valign="top">virtual const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1ReSpeaker.html#af7a0a6846f4e9036a69e804f1a424f6a">DetectHotword</a> (int &detected)=0</td></tr>
<tr class="separator:af7a0a6846f4e9036a69e804f1a424f6a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa029f18dd346b7f4319e3ed1b142adc4"><td class="memItemLeft" align="right" valign="top">virtual const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1ReSpeaker.html#aa029f18dd346b7f4319e3ed1b142adc4">Listen</a> (int block_time_length_ms)=0</td></tr>
<tr class="separator:aa029f18dd346b7f4319e3ed1b142adc4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aac7cc985dc432d4e2840a5761085b8f7"><td class="memItemLeft" align="right" valign="top">virtual const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1ReSpeaker.html#aac7cc985dc432d4e2840a5761085b8f7">Listen</a> ()=0</td></tr>
<tr class="separator:aac7cc985dc432d4e2840a5761085b8f7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad487a99e498731ff4d31492220d9cbf8"><td class="memItemLeft" align="right" valign="top">virtual const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1ReSpeaker.html#ad487a99e498731ff4d31492220d9cbf8">ListenToSilence</a> (int cmd_silence_gap_ms=3000, int cmd_max_timeout_ms=10000)=0</td></tr>
<tr class="separator:ad487a99e498731ff4d31492220d9cbf8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a41304795404dc5a56bd2d2917b872b5e"><td class="memItemLeft" align="right" valign="top">virtual const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1ReSpeaker.html#a41304795404dc5a56bd2d2917b872b5e">ListenToSilence</a> (void(*DirectionReportCallback)(int), int cmd_silence_gap_ms=3000, int cmd_max_timeout_ms=10000)=0</td></tr>
<tr class="separator:a41304795404dc5a56bd2d2917b872b5e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8540441a8b65a96bf1bd5cc038f4d0cf"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1ReSpeaker.html#a8540441a8b65a96bf1bd5cc038f4d0cf">GetDirection</a> ()=0</td></tr>
<tr class="separator:a8540441a8b65a96bf1bd5cc038f4d0cf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0326f063691d51e3e6ffe7aec12d18df"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1ReSpeaker.html#a0326f063691d51e3e6ffe7aec12d18df">SetDirection</a> (int dir)=0</td></tr>
<tr class="separator:a0326f063691d51e3e6ffe7aec12d18df"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a18c9f9a2c1d8dd8e4555e693b672fd0b"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1ReSpeaker.html#a18c9f9a2c1d8dd8e4555e693b672fd0b">GetVad</a> ()=0</td></tr>
<tr class="separator:a18c9f9a2c1d8dd8e4555e693b672fd0b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4164daf86f69a5396b8b85daf75f7723"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1ReSpeaker.html#a4164daf86f69a5396b8b85daf75f7723">SetChainState</a> (<a class="el" href="namespacerespeaker.html#a5372a69a95f6fd5424740ce4157651d9">ChainState</a> state)=0</td></tr>
<tr class="separator:a4164daf86f69a5396b8b85daf75f7723"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abdeb0f1af01bbe97fad98123bb4b3b8c"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1ReSpeaker.html#abdeb0f1af01bbe97fad98123bb4b3b8c">Pause</a> ()=0</td></tr>
<tr class="separator:abdeb0f1af01bbe97fad98123bb4b3b8c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aee40f071a316d3d4f5f3cc56e73c087b"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1ReSpeaker.html#aee40f071a316d3d4f5f3cc56e73c087b">Resume</a> ()=0</td></tr>
<tr class="separator:aee40f071a316d3d4f5f3cc56e73c087b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a37a988b7415acda3ab960467ae7a54df"><td class="memItemLeft" align="right" valign="top"><a id="a37a988b7415acda3ab960467ae7a54df"></a>
virtual <a class="el" href="structrespeaker_1_1ChainSharedData.html">ChainSharedData</a> * </td><td class="memItemRight" valign="bottom"><b>GetChainSharedDataPtr</b> ()=0</td></tr>
<tr class="separator:a37a988b7415acda3ab960467ae7a54df"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a13d1bceb8df7a112c3d4d789615a6db2"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1ReSpeaker.html#a13d1bceb8df7a112c3d4d789615a6db2">GetNumOutputChannels</a> ()=0</td></tr>
<tr class="separator:a13d1bceb8df7a112c3d4d789615a6db2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeef2b96d6177f0666fcd6a0d9f37078c"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1ReSpeaker.html#aeef2b96d6177f0666fcd6a0d9f37078c">GetNumOutputRate</a> ()=0</td></tr>
<tr class="separator:aeef2b96d6177f0666fcd6a0d9f37078c"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a99e0306ff4b87c9c8a826f2072bc5e1c"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classrespeaker_1_1ReSpeaker.html">ReSpeaker</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1ReSpeaker.html#a99e0306ff4b87c9c8a826f2072bc5e1c">Create</a> (<a class="el" href="namespacerespeaker.html#a20e1a7db6be2c508966379af4c46db3d">LogLevel</a> log_level=<a class="el" href="namespacerespeaker.html#a20e1a7db6be2c508966379af4c46db3da564b3555c691282f8258d64fe7d03c6f">DEBUG_LOG_LEVEL</a>)</td></tr>
<tr class="separator:a99e0306ff4b87c9c8a826f2072bc5e1c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a66aa816c5476d74fdb22c1f8201063ad"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classrespeaker_1_1ReSpeaker.html">ReSpeaker</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1ReSpeaker.html#a66aa816c5476d74fdb22c1f8201063ad">Create</a> (<a class="el" href="namespacerespeaker.html#a20e1a7db6be2c508966379af4c46db3d">LogLevel</a> log_level, std::string log_conf_file)</td></tr>
<tr class="separator:a66aa816c5476d74fdb22c1f8201063ad"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The <code><a class="el" href="classrespeaker_1_1ReSpeaker.html">ReSpeaker</a></code> class is a container/supervisor of node classes.</p>
<p><code><a class="el" href="classrespeaker_1_1ReSpeaker.html">ReSpeaker</a></code> maintains the following nodes:</p><ul>
<li>Head node - which typically is a collector node and used to access the whole chain</li>
<li>DirectionManager node - this is an interface class, nodes derived from it can report DoA direction or set DoA direction</li>
<li>HotwordDetection node - this is an interface class, nodes derived from it can report hotword trigger event</li>
<li>Output node - from which we fetch final stream </li>
</ul>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a99e0306ff4b87c9c8a826f2072bc5e1c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a99e0306ff4b87c9c8a826f2072bc5e1c">◆ </a></span>Create() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classrespeaker_1_1ReSpeaker.html">ReSpeaker</a>* respeaker::ReSpeaker::Create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacerespeaker.html#a20e1a7db6be2c508966379af4c46db3d">LogLevel</a> </td>
<td class="paramname"><em>log_level</em> = <code><a class="el" href="namespacerespeaker.html#a20e1a7db6be2c508966379af4c46db3da564b3555c691282f8258d64fe7d03c6f">DEBUG_LOG_LEVEL</a></code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create an instance of <code><a class="el" href="classrespeaker_1_1ReSpeaker.html">ReSpeaker</a></code> class. This is a static method, you may call this using: </p><div class="fragment"><div class="line"><a class="code" href="classrespeaker_1_1ReSpeaker.html#a99e0306ff4b87c9c8a826f2072bc5e1c">ReSpeaker::Create</a>(<a class="code" href="namespacerespeaker.html#a20e1a7db6be2c508966379af4c46db3da70aab646e11630333a9bdea7d397153f">INFO_LOG_LEVEL</a>)</div></div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">log_level</td><td>- One of <a class="el" href="namespacerespeaker.html#a20e1a7db6be2c508966379af4c46db3d">respeaker::LogLevel</a>, the default is DEBUG_LOG_LEVEL.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>ReSpeaker* - The pointer of the instance. </dd></dl>
</div>
</div>
<a id="a66aa816c5476d74fdb22c1f8201063ad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a66aa816c5476d74fdb22c1f8201063ad">◆ </a></span>Create() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classrespeaker_1_1ReSpeaker.html">ReSpeaker</a>* respeaker::ReSpeaker::Create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacerespeaker.html#a20e1a7db6be2c508966379af4c46db3d">LogLevel</a> </td>
<td class="paramname"><em>log_level</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string </td>
<td class="paramname"><em>log_conf_file</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create an instance of <code><a class="el" href="classrespeaker_1_1ReSpeaker.html">ReSpeaker</a></code> class. This is a static method, you may call this using: </p><div class="fragment"><div class="line"><a class="code" href="classrespeaker_1_1ReSpeaker.html#a99e0306ff4b87c9c8a826f2072bc5e1c">ReSpeaker::Create</a>(<a class="code" href="namespacerespeaker.html#a20e1a7db6be2c508966379af4c46db3da70aab646e11630333a9bdea7d397153f">INFO_LOG_LEVEL</a>)</div></div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">log_level</td><td>- One of <a class="el" href="namespacerespeaker.html#a20e1a7db6be2c508966379af4c46db3d">respeaker::LogLevel</a> </td></tr>
<tr><td class="paramname">log_conf_file</td><td>- The path to the configuration file, which follows the syntax of log4cplus.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>ReSpeaker* </dd></dl>
</div>
</div>
<a id="a95f64bdc200f74800c51e3f778e8019e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a95f64bdc200f74800c51e3f778e8019e">◆ </a></span>DetectHotword() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int respeaker::ReSpeaker::DetectHotword </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if the keyword has been detected. Need to iterate this function quickly to drain the stream buffer if you don't call the <code>Listen</code> method to drain it.</p>
<dl class="section return"><dt>Returns</dt><dd>int - Whether or not the keyword has been detected. -2: Silence. -1: Error. 0: No event. 1: Hotword 1 triggered. 2: Hotword 2 triggered. 3 or More: Hotword 3 or other index of the hotword triggered. </dd></dl>
</div>
</div>
<a id="af7a0a6846f4e9036a69e804f1a424f6a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af7a0a6846f4e9036a69e804f1a424f6a">◆ </a></span>DetectHotword() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const std::string respeaker::ReSpeaker::DetectHotword </td>
<td>(</td>
<td class="paramtype">int & </td>
<td class="paramname"><em>detected</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if the keyword has been detected. Need to iterate this function quickly to drain the stream buffer if you don't call the <code>Listen</code> method to drain it.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">detected</td><td>[Out] - Whether or not the keyword has been detected. -2: Silence. -1: Error. 0: No event. 1: Hotword 1 triggered. 2: Hotword 2 triggered. 3 or More: Hotword 3 or other index of the hotword triggered.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>const std::string - The audio block being processed is returned. </dd></dl>
</div>
</div>
<a id="a8540441a8b65a96bf1bd5cc038f4d0cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8540441a8b65a96bf1bd5cc038f4d0cf">◆ </a></span>GetDirection()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int respeaker::ReSpeaker::GetDirection </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the direction of DoA.</p>
<dl class="section return"><dt>Returns</dt><dd>int - The degree of direction, [0, 360] </dd></dl>
</div>
</div>
<a id="a13d1bceb8df7a112c3d4d789615a6db2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a13d1bceb8df7a112c3d4d789615a6db2">◆ </a></span>GetNumOutputChannels()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual size_t respeaker::ReSpeaker::GetNumOutputChannels </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number of channels of the output node. </p>
</div>
</div>
<a id="aeef2b96d6177f0666fcd6a0d9f37078c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeef2b96d6177f0666fcd6a0d9f37078c">◆ </a></span>GetNumOutputRate()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int respeaker::ReSpeaker::GetNumOutputRate </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number of rate of the output node. </p>
</div>
</div>
<a id="a18c9f9a2c1d8dd8e4555e693b672fd0b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a18c9f9a2c1d8dd8e4555e693b672fd0b">◆ </a></span>GetVad()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool respeaker::ReSpeaker::GetVad </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get if there is active voice at the current time in the processed stream.</p>
<dl class="section return"><dt>Returns</dt><dd>bool - When someone is speaking, it returns true. </dd></dl>
</div>
</div>
<a id="aa029f18dd346b7f4319e3ed1b142adc4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa029f18dd346b7f4319e3ed1b142adc4">◆ </a></span>Listen() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const std::string respeaker::ReSpeaker::Listen </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>block_time_length_ms</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Fetch the stream data for a duration of <code>block_time_length_ms</code> millisenconds.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">block_time_length_ms</td><td>- How many milliseconds of data you want to fetch.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>const string - the stream data block </dd></dl>
</div>
</div>
<a id="aac7cc985dc432d4e2840a5761085b8f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aac7cc985dc432d4e2840a5761085b8f7">◆ </a></span>Listen() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const std::string respeaker::ReSpeaker::Listen </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Fetch the stream data, the length is the output node's default output length. </p><dl class="section return"><dt>Returns</dt><dd>const string - the stream data block </dd></dl>
</div>
</div>
<a id="ad487a99e498731ff4d31492220d9cbf8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad487a99e498731ff4d31492220d9cbf8">◆ </a></span>ListenToSilence() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const std::string respeaker::ReSpeaker::ListenToSilence </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>cmd_silence_gap_ms</em> = <code>3000</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>cmd_max_timeout_ms</em> = <code>10000</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Fetch a whole data chunk of a sentence which is splited out by a <code>cmd_timeout_ms</code> silence gap and which has the maximum length of <code>max_cmd_time_ms</code>.</p>
<dl class="section return"><dt>Returns</dt><dd>const string - the stream data chunk </dd></dl>
</div>
</div>
<a id="a41304795404dc5a56bd2d2917b872b5e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a41304795404dc5a56bd2d2917b872b5e">◆ </a></span>ListenToSilence() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const std::string respeaker::ReSpeaker::ListenToSilence </td>
<td>(</td>
<td class="paramtype">void(*)(int) </td>
<td class="paramname"><em>DirectionReportCallback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>cmd_silence_gap_ms</em> = <code>3000</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>cmd_max_timeout_ms</em> = <code>10000</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">DirectionReportCallback</td><td>- The callback will be running in the same thread as the caller's thread, typically the main thread of an application. </td></tr>
<tr><td class="paramname">cmd_silence_gap_ms</td><td>- How many milliseconds of silence will be waited before we consider the sentence is over. </td></tr>
<tr><td class="paramname">cmd_max_timeout_ms</td><td>- Over this length of time, the sentence will be cut even there's still valid voice.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>const std::string - the stream data chunk </dd></dl>
</div>
</div>
<a id="abdeb0f1af01bbe97fad98123bb4b3b8c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abdeb0f1af01bbe97fad98123bb4b3b8c">◆ </a></span>Pause()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void respeaker::ReSpeaker::Pause </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Pause the collector node </p>
</div>
</div>
<a id="ad92eb40da02d097227b4895eff7f09d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad92eb40da02d097227b4895eff7f09d4">◆ </a></span>RegisterChainByHead()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void respeaker::ReSpeaker::RegisterChainByHead </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classrespeaker_1_1BaseNode.html">BaseNode</a> * </td>
<td class="paramname"><em>head_node</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Register the head node into the <a class="el" href="classrespeaker_1_1ReSpeaker.html">ReSpeaker</a> supervisor.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">head_node</td><td>- The pointer to the head node </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac06e89b92cdfcca6b08bbcfeadb908f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac06e89b92cdfcca6b08bbcfeadb908f1">◆ </a></span>RegisterDirectionManagerNode()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void respeaker::ReSpeaker::RegisterDirectionManagerNode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classrespeaker_1_1DirectionManagerNode.html">DirectionManagerNode</a> * </td>
<td class="paramname"><em>dir_manager_node</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Register the node which does DoA</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dir_manager_node</td><td>- The pointer of the node </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a4d246376a66fcade2ba9eaefca93494d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d246376a66fcade2ba9eaefca93494d">◆ </a></span>RegisterHotwordDetectionNode()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void respeaker::ReSpeaker::RegisterHotwordDetectionNode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classrespeaker_1_1HotwordDetectionNode.html">HotwordDetectionNode</a> * </td>
<td class="paramname"><em>hotword_detection_node</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Register the node which does hotword search.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">hotword_detection_node</td><td>- The pointer of the node </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ab936880d322ca8da21925a269d06f3be"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab936880d322ca8da21925a269d06f3be">◆ </a></span>RegisterOutputNode()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void respeaker::ReSpeaker::RegisterOutputNode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classrespeaker_1_1BaseNode.html">BaseNode</a> * </td>
<td class="paramname"><em>output_node</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Register the output node</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">output_node</td><td>- The pointer of the node </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aee40f071a316d3d4f5f3cc56e73c087b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aee40f071a316d3d4f5f3cc56e73c087b">◆ </a></span>Resume()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void respeaker::ReSpeaker::Resume </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Resume the audio collection of the collector node </p>
</div>
</div>
<a id="a4164daf86f69a5396b8b85daf75f7723"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4164daf86f69a5396b8b85daf75f7723">◆ </a></span>SetChainState()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void respeaker::ReSpeaker::SetChainState </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacerespeaker.html#a5372a69a95f6fd5424740ce4157651d9">ChainState</a> </td>
<td class="paramname"><em>state</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the state machine of the audio processing chain. The state of the chain will be changed automatically to <code>LISTEN_QUIETLY</code> or <code>LISTEN_WITH_BGM</code> by the hot word detection node when hot word triggered. Users should however pay attention to switch the state of the chain back to <code>WAIT_TRIGGER_QUIETLY</code> or <code>WAIT_TRIGGER_WITH_BGM</code> when listened audio has been processed, uploaded to cloud ASR for an example, otherwise the trigger isn't gonna to happen again. This is usefully when users implement application logic like this:</p><ul>
<li>wait trigger</li>
<li>when triggered, fetch audio block by <code>HotwordDection</code> or <code>Listen</code>, upload audio to cloud ASR, in the background, some algorithms may be skipped to lower the CPU load since the chain knows it doen't need to do those algorithms( e.g. hotword searching) by sensing the state machine.</li>
<li>cloud ASR return <code>stop capture</code> event</li>
<li><code>SetChainState</code> back to WAIT_TRIGGER_*</li>
</ul>
<dl class="section note"><dt>Note</dt><dd>In some cases, if the cloud ASR can accept constant audio stream, users can disable the automatic state transfer by calling <code>DisableAutoStateTransfer</code> of the hotword detection node if provided. After disabled, there's no need to call this method in anywhere.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">state</td><td>- enum <a class="el" href="namespacerespeaker.html#a5372a69a95f6fd5424740ce4157651d9">respeaker::ChainState</a> in <a class="el" href="chain__shared_8h_source.html">chain_shared.h</a></td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="namespacerespeaker.html#a5372a69a95f6fd5424740ce4157651d9">respeaker::ChainState</a> </dd></dl>
</div>
</div>
<a id="a0326f063691d51e3e6ffe7aec12d18df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0326f063691d51e3e6ffe7aec12d18df">◆ </a></span>SetDirection()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void respeaker::ReSpeaker::SetDirection </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>dir</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the direction of DoA. (Not used, reserve)</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dir</td><td>- The degree of direction, [0, 360] </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a79f5b9622b7603bb97f688d94de0bcd3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a79f5b9622b7603bb97f688d94de0bcd3">◆ </a></span>SetLogLevel()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void respeaker::ReSpeaker::SetLogLevel </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacerespeaker.html#a20e1a7db6be2c508966379af4c46db3d">LogLevel</a> </td>
<td class="paramname"><em>log_level</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the log level after creation of the <a class="el" href="classrespeaker_1_1ReSpeaker.html">ReSpeaker</a> instance.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">log_level</td><td>- One of <a class="el" href="namespacerespeaker.html#a20e1a7db6be2c508966379af4c46db3d">respeaker::LogLevel</a> </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad751960137fb5453e966e96c7fb0cdd0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad751960137fb5453e966e96c7fb0cdd0">◆ </a></span>Start()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool respeaker::ReSpeaker::Start </td>
<td>(</td>
<td class="paramtype">bool * </td>
<td class="paramname"><em>interrupt</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Start the theads</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">interrupt</td><td>- The pointer to a boolean variable, when the value of this variable comes to <code>true</code>, the loops inside will be interupted immediately.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>bool - If <code>false</code> is returned, it means the parameter of the input of some node doesn't meet the requirements of that node. </dd></dl>
</div>
</div>
<a id="ad5fb1bab671f0435e614d9deeba09f51"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad5fb1bab671f0435e614d9deeba09f51">◆ </a></span>Stop()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool respeaker::ReSpeaker::Stop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Stop the threads with safe. Please note that there might be some delay before all the threads join, since some of them will actually exit when they come active from sleeping. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/home/gitlab-runner/builds/dc7d1974/0/seeedstudio/librespeaker/include/<a class="el" href="respeaker_8h_source.html">respeaker.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>