forked from wzpan/wukong-robot
-
Notifications
You must be signed in to change notification settings - Fork 0
/
plugins.html
568 lines (421 loc) · 30 KB
/
plugins.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
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="zh-CN" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="zh-CN" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>plugins package — wukong-robot 1.2.0 文档</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/translations.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="索引" href="genindex.html" />
<link rel="search" title="搜索" href="search.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> wukong-robot
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<!-- Local TOC -->
<div class="local-toc"><ul>
<li><a class="reference internal" href="#">plugins package</a><ul>
<li><a class="reference internal" href="#submodules">Submodules</a></li>
<li><a class="reference internal" href="#module-plugins.Camera">plugins.Camera module</a></li>
<li><a class="reference internal" href="#module-plugins.CleanCache">plugins.CleanCache module</a></li>
<li><a class="reference internal" href="#module-plugins.Echo">plugins.Echo module</a></li>
<li><a class="reference internal" href="#module-plugins.Email">plugins.Email module</a></li>
<li><a class="reference internal" href="#module-plugins.Geek">plugins.Geek module</a></li>
<li><a class="reference internal" href="#module-plugins.LocalPlayer">plugins.LocalPlayer module</a></li>
<li><a class="reference internal" href="#module-plugins.Poem">plugins.Poem module</a></li>
<li><a class="reference internal" href="#module-plugins">Module contents</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">wukong-robot</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>plugins package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/plugins.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="plugins-package">
<h1>plugins package<a class="headerlink" href="#plugins-package" title="永久链接至标题">¶</a></h1>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="永久链接至标题">¶</a></h2>
</div>
<div class="section" id="module-plugins.Camera">
<span id="plugins-camera-module"></span><h2>plugins.Camera module<a class="headerlink" href="#module-plugins.Camera" title="永久链接至标题">¶</a></h2>
<dl class="class">
<dt id="plugins.Camera.Plugin">
<em class="property">class </em><code class="descclassname">plugins.Camera.</code><code class="descname">Plugin</code><span class="sig-paren">(</span><em>con</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/plugins/Camera.html#Plugin"><span class="viewcode-link">[源代码]</span></a><a class="headerlink" href="#plugins.Camera.Plugin" title="永久链接至目标">¶</a></dt>
<dd><p>基类：<a class="reference internal" href="robot.sdk.html#robot.sdk.AbstractPlugin.AbstractPlugin" title="robot.sdk.AbstractPlugin.AbstractPlugin"><code class="xref py py-class docutils literal notranslate"><span class="pre">robot.sdk.AbstractPlugin.AbstractPlugin</span></code></a></p>
<dl class="attribute">
<dt id="plugins.Camera.Plugin.SLUG">
<code class="descname">SLUG</code><em class="property"> = 'camera'</em><a class="headerlink" href="#plugins.Camera.Plugin.SLUG" title="永久链接至目标">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="plugins.Camera.Plugin.handle">
<code class="descname">handle</code><span class="sig-paren">(</span><em>text</em>, <em>parsed</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/plugins/Camera.html#Plugin.handle"><span class="viewcode-link">[源代码]</span></a><a class="headerlink" href="#plugins.Camera.Plugin.handle" title="永久链接至目标">¶</a></dt>
<dd><p>处理逻辑</p>
<p>参数：
query – 用户的指令字符串
parsed – 用户指令经过 NLU 解析后的结果</p>
</dd></dl>
<dl class="method">
<dt id="plugins.Camera.Plugin.isValid">
<code class="descname">isValid</code><span class="sig-paren">(</span><em>text</em>, <em>parsed</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/plugins/Camera.html#Plugin.isValid"><span class="viewcode-link">[源代码]</span></a><a class="headerlink" href="#plugins.Camera.Plugin.isValid" title="永久链接至目标">¶</a></dt>
<dd><p>是否适合由该插件处理</p>
<p>参数：
query – 用户的指令字符串
parsed – 用户指令经过 NLU 解析后的结果</p>
<p>返回：
True: 适合由该插件处理
False: 不适合由该插件处理</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-plugins.CleanCache">
<span id="plugins-cleancache-module"></span><h2>plugins.CleanCache module<a class="headerlink" href="#module-plugins.CleanCache" title="永久链接至标题">¶</a></h2>
<dl class="class">
<dt id="plugins.CleanCache.Plugin">
<em class="property">class </em><code class="descclassname">plugins.CleanCache.</code><code class="descname">Plugin</code><span class="sig-paren">(</span><em>con</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/plugins/CleanCache.html#Plugin"><span class="viewcode-link">[源代码]</span></a><a class="headerlink" href="#plugins.CleanCache.Plugin" title="永久链接至目标">¶</a></dt>
<dd><p>基类：<a class="reference internal" href="robot.sdk.html#robot.sdk.AbstractPlugin.AbstractPlugin" title="robot.sdk.AbstractPlugin.AbstractPlugin"><code class="xref py py-class docutils literal notranslate"><span class="pre">robot.sdk.AbstractPlugin.AbstractPlugin</span></code></a></p>
<dl class="attribute">
<dt id="plugins.CleanCache.Plugin.SLUG">
<code class="descname">SLUG</code><em class="property"> = 'cleancache'</em><a class="headerlink" href="#plugins.CleanCache.Plugin.SLUG" title="永久链接至目标">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="plugins.CleanCache.Plugin.handle">
<code class="descname">handle</code><span class="sig-paren">(</span><em>text</em>, <em>parsed</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/plugins/CleanCache.html#Plugin.handle"><span class="viewcode-link">[源代码]</span></a><a class="headerlink" href="#plugins.CleanCache.Plugin.handle" title="永久链接至目标">¶</a></dt>
<dd><p>处理逻辑</p>
<p>参数：
query – 用户的指令字符串
parsed – 用户指令经过 NLU 解析后的结果</p>
</dd></dl>
<dl class="method">
<dt id="plugins.CleanCache.Plugin.isValid">
<code class="descname">isValid</code><span class="sig-paren">(</span><em>text</em>, <em>parsed</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/plugins/CleanCache.html#Plugin.isValid"><span class="viewcode-link">[源代码]</span></a><a class="headerlink" href="#plugins.CleanCache.Plugin.isValid" title="永久链接至目标">¶</a></dt>
<dd><p>是否适合由该插件处理</p>
<p>参数：
query – 用户的指令字符串
parsed – 用户指令经过 NLU 解析后的结果</p>
<p>返回：
True: 适合由该插件处理
False: 不适合由该插件处理</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-plugins.Echo">
<span id="plugins-echo-module"></span><h2>plugins.Echo module<a class="headerlink" href="#module-plugins.Echo" title="永久链接至标题">¶</a></h2>
<dl class="class">
<dt id="plugins.Echo.Plugin">
<em class="property">class </em><code class="descclassname">plugins.Echo.</code><code class="descname">Plugin</code><span class="sig-paren">(</span><em>con</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/plugins/Echo.html#Plugin"><span class="viewcode-link">[源代码]</span></a><a class="headerlink" href="#plugins.Echo.Plugin" title="永久链接至目标">¶</a></dt>
<dd><p>基类：<a class="reference internal" href="robot.sdk.html#robot.sdk.AbstractPlugin.AbstractPlugin" title="robot.sdk.AbstractPlugin.AbstractPlugin"><code class="xref py py-class docutils literal notranslate"><span class="pre">robot.sdk.AbstractPlugin.AbstractPlugin</span></code></a></p>
<dl class="method">
<dt id="plugins.Echo.Plugin.handle">
<code class="descname">handle</code><span class="sig-paren">(</span><em>text</em>, <em>parsed</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/plugins/Echo.html#Plugin.handle"><span class="viewcode-link">[源代码]</span></a><a class="headerlink" href="#plugins.Echo.Plugin.handle" title="永久链接至目标">¶</a></dt>
<dd><p>处理逻辑</p>
<p>参数：
query – 用户的指令字符串
parsed – 用户指令经过 NLU 解析后的结果</p>
</dd></dl>
<dl class="method">
<dt id="plugins.Echo.Plugin.isValid">
<code class="descname">isValid</code><span class="sig-paren">(</span><em>text</em>, <em>parsed</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/plugins/Echo.html#Plugin.isValid"><span class="viewcode-link">[源代码]</span></a><a class="headerlink" href="#plugins.Echo.Plugin.isValid" title="永久链接至目标">¶</a></dt>
<dd><p>是否适合由该插件处理</p>
<p>参数：
query – 用户的指令字符串
parsed – 用户指令经过 NLU 解析后的结果</p>
<p>返回：
True: 适合由该插件处理
False: 不适合由该插件处理</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-plugins.Email">
<span id="plugins-email-module"></span><h2>plugins.Email module<a class="headerlink" href="#module-plugins.Email" title="永久链接至标题">¶</a></h2>
<dl class="class">
<dt id="plugins.Email.Plugin">
<em class="property">class </em><code class="descclassname">plugins.Email.</code><code class="descname">Plugin</code><span class="sig-paren">(</span><em>con</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/plugins/Email.html#Plugin"><span class="viewcode-link">[源代码]</span></a><a class="headerlink" href="#plugins.Email.Plugin" title="永久链接至目标">¶</a></dt>
<dd><p>基类：<a class="reference internal" href="robot.sdk.html#robot.sdk.AbstractPlugin.AbstractPlugin" title="robot.sdk.AbstractPlugin.AbstractPlugin"><code class="xref py py-class docutils literal notranslate"><span class="pre">robot.sdk.AbstractPlugin.AbstractPlugin</span></code></a></p>
<dl class="attribute">
<dt id="plugins.Email.Plugin.SLUG">
<code class="descname">SLUG</code><em class="property"> = 'email'</em><a class="headerlink" href="#plugins.Email.Plugin.SLUG" title="永久链接至目标">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="plugins.Email.Plugin.fetchUnreadEmails">
<code class="descname">fetchUnreadEmails</code><span class="sig-paren">(</span><em>since=None</em>, <em>markRead=False</em>, <em>limit=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/plugins/Email.html#Plugin.fetchUnreadEmails"><span class="viewcode-link">[源代码]</span></a><a class="headerlink" href="#plugins.Email.Plugin.fetchUnreadEmails" title="永久链接至目标">¶</a></dt>
<dd><p>Fetches a list of unread email objects from a user’s email inbox.</p>
<p>Arguments:
since – if provided, no emails before this date will be returned
markRead – if True, marks all returned emails as read in target inbox</p>
<p>Returns:
A list of unread email objects.</p>
</dd></dl>
<dl class="method">
<dt id="plugins.Email.Plugin.getDate">
<code class="descname">getDate</code><span class="sig-paren">(</span><em>email</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/plugins/Email.html#Plugin.getDate"><span class="viewcode-link">[源代码]</span></a><a class="headerlink" href="#plugins.Email.Plugin.getDate" title="永久链接至目标">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="plugins.Email.Plugin.getMostRecentDate">
<code class="descname">getMostRecentDate</code><span class="sig-paren">(</span><em>emails</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/plugins/Email.html#Plugin.getMostRecentDate"><span class="viewcode-link">[源代码]</span></a><a class="headerlink" href="#plugins.Email.Plugin.getMostRecentDate" title="永久链接至目标">¶</a></dt>
<dd><p>Returns the most recent date of any email in the list provided.</p>
<p>Arguments:
emails – a list of emails to check</p>
<p>Returns:
Date of the most recent email.</p>
</dd></dl>
<dl class="method">
<dt id="plugins.Email.Plugin.getSender">
<code class="descname">getSender</code><span class="sig-paren">(</span><em>msg</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/plugins/Email.html#Plugin.getSender"><span class="viewcode-link">[源代码]</span></a><a class="headerlink" href="#plugins.Email.Plugin.getSender" title="永久链接至目标">¶</a></dt>
<dd><p>Returns the best-guess sender of an email.</p>
<p>Arguments:
msg – the email whose sender is desired</p>
<p>Returns:
Sender of the sender.</p>
</dd></dl>
<dl class="method">
<dt id="plugins.Email.Plugin.getSubject">
<code class="descname">getSubject</code><span class="sig-paren">(</span><em>msg</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/plugins/Email.html#Plugin.getSubject"><span class="viewcode-link">[源代码]</span></a><a class="headerlink" href="#plugins.Email.Plugin.getSubject" title="永久链接至目标">¶</a></dt>
<dd><p>Returns the title of an email</p>
<p>Arguments:
msg – the email</p>
<p>Returns:
Title of the email.</p>
</dd></dl>
<dl class="method">
<dt id="plugins.Email.Plugin.handle">
<code class="descname">handle</code><span class="sig-paren">(</span><em>text</em>, <em>parsed</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/plugins/Email.html#Plugin.handle"><span class="viewcode-link">[源代码]</span></a><a class="headerlink" href="#plugins.Email.Plugin.handle" title="永久链接至目标">¶</a></dt>
<dd><p>处理逻辑</p>
<p>参数：
query – 用户的指令字符串
parsed – 用户指令经过 NLU 解析后的结果</p>
</dd></dl>
<dl class="method">
<dt id="plugins.Email.Plugin.isNewEmail">
<code class="descname">isNewEmail</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/plugins/Email.html#Plugin.isNewEmail"><span class="viewcode-link">[源代码]</span></a><a class="headerlink" href="#plugins.Email.Plugin.isNewEmail" title="永久链接至目标">¶</a></dt>
<dd><p>Wether an email is a new email</p>
</dd></dl>
<dl class="method">
<dt id="plugins.Email.Plugin.isSelfEmail">
<code class="descname">isSelfEmail</code><span class="sig-paren">(</span><em>msg</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/plugins/Email.html#Plugin.isSelfEmail"><span class="viewcode-link">[源代码]</span></a><a class="headerlink" href="#plugins.Email.Plugin.isSelfEmail" title="永久链接至目标">¶</a></dt>
<dd><p>Whether the email is sent by the user</p>
</dd></dl>
<dl class="method">
<dt id="plugins.Email.Plugin.isValid">
<code class="descname">isValid</code><span class="sig-paren">(</span><em>text</em>, <em>parsed</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/plugins/Email.html#Plugin.isValid"><span class="viewcode-link">[源代码]</span></a><a class="headerlink" href="#plugins.Email.Plugin.isValid" title="永久链接至目标">¶</a></dt>
<dd><p>是否适合由该插件处理</p>
<p>参数：
query – 用户的指令字符串
parsed – 用户指令经过 NLU 解析后的结果</p>
<p>返回：
True: 适合由该插件处理
False: 不适合由该插件处理</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-plugins.Geek">
<span id="plugins-geek-module"></span><h2>plugins.Geek module<a class="headerlink" href="#module-plugins.Geek" title="永久链接至标题">¶</a></h2>
<dl class="class">
<dt id="plugins.Geek.Plugin">
<em class="property">class </em><code class="descclassname">plugins.Geek.</code><code class="descname">Plugin</code><span class="sig-paren">(</span><em>con</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/plugins/Geek.html#Plugin"><span class="viewcode-link">[源代码]</span></a><a class="headerlink" href="#plugins.Geek.Plugin" title="永久链接至目标">¶</a></dt>
<dd><p>基类：<a class="reference internal" href="robot.sdk.html#robot.sdk.AbstractPlugin.AbstractPlugin" title="robot.sdk.AbstractPlugin.AbstractPlugin"><code class="xref py py-class docutils literal notranslate"><span class="pre">robot.sdk.AbstractPlugin.AbstractPlugin</span></code></a></p>
<dl class="attribute">
<dt id="plugins.Geek.Plugin.IS_IMMERSIVE">
<code class="descname">IS_IMMERSIVE</code><em class="property"> = True</em><a class="headerlink" href="#plugins.Geek.Plugin.IS_IMMERSIVE" title="永久链接至目标">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="plugins.Geek.Plugin.handle">
<code class="descname">handle</code><span class="sig-paren">(</span><em>text</em>, <em>parsed</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/plugins/Geek.html#Plugin.handle"><span class="viewcode-link">[源代码]</span></a><a class="headerlink" href="#plugins.Geek.Plugin.handle" title="永久链接至目标">¶</a></dt>
<dd><p>处理逻辑</p>
<p>参数：
query – 用户的指令字符串
parsed – 用户指令经过 NLU 解析后的结果</p>
</dd></dl>
<dl class="method">
<dt id="plugins.Geek.Plugin.isValid">
<code class="descname">isValid</code><span class="sig-paren">(</span><em>text</em>, <em>parsed</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/plugins/Geek.html#Plugin.isValid"><span class="viewcode-link">[源代码]</span></a><a class="headerlink" href="#plugins.Geek.Plugin.isValid" title="永久链接至目标">¶</a></dt>
<dd><p>是否适合由该插件处理</p>
<p>参数：
query – 用户的指令字符串
parsed – 用户指令经过 NLU 解析后的结果</p>
<p>返回：
True: 适合由该插件处理
False: 不适合由该插件处理</p>
</dd></dl>
<dl class="method">
<dt id="plugins.Geek.Plugin.isValidImmersive">
<code class="descname">isValidImmersive</code><span class="sig-paren">(</span><em>text</em>, <em>parsed</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/plugins/Geek.html#Plugin.isValidImmersive"><span class="viewcode-link">[源代码]</span></a><a class="headerlink" href="#plugins.Geek.Plugin.isValidImmersive" title="永久链接至目标">¶</a></dt>
<dd><p>是否适合在沉浸模式下处理，
仅适用于有沉浸模式的插件（如音乐等）
当用户唤醒时，可以响应更多指令集。
例如：“”上一首”、”下一首” 等</p>
</dd></dl>
<dl class="method">
<dt id="plugins.Geek.Plugin.onAsk">
<code class="descname">onAsk</code><span class="sig-paren">(</span><em>input</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/plugins/Geek.html#Plugin.onAsk"><span class="viewcode-link">[源代码]</span></a><a class="headerlink" href="#plugins.Geek.Plugin.onAsk" title="永久链接至目标">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="plugins.Geek.Plugin.restore">
<code class="descname">restore</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/plugins/Geek.html#Plugin.restore"><span class="viewcode-link">[源代码]</span></a><a class="headerlink" href="#plugins.Geek.Plugin.restore" title="永久链接至目标">¶</a></dt>
<dd><p>恢复当前插件，
仅适用于有沉浸模式的插件（如音乐等）
当用户误唤醒或者唤醒进行闲聊后，
可以自动恢复当前插件的处理逻辑</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-plugins.LocalPlayer">
<span id="plugins-localplayer-module"></span><h2>plugins.LocalPlayer module<a class="headerlink" href="#module-plugins.LocalPlayer" title="永久链接至标题">¶</a></h2>
<dl class="class">
<dt id="plugins.LocalPlayer.Plugin">
<em class="property">class </em><code class="descclassname">plugins.LocalPlayer.</code><code class="descname">Plugin</code><span class="sig-paren">(</span><em>con</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/plugins/LocalPlayer.html#Plugin"><span class="viewcode-link">[源代码]</span></a><a class="headerlink" href="#plugins.LocalPlayer.Plugin" title="永久链接至目标">¶</a></dt>
<dd><p>基类：<a class="reference internal" href="robot.sdk.html#robot.sdk.AbstractPlugin.AbstractPlugin" title="robot.sdk.AbstractPlugin.AbstractPlugin"><code class="xref py py-class docutils literal notranslate"><span class="pre">robot.sdk.AbstractPlugin.AbstractPlugin</span></code></a></p>
<dl class="attribute">
<dt id="plugins.LocalPlayer.Plugin.IS_IMMERSIVE">
<code class="descname">IS_IMMERSIVE</code><em class="property"> = True</em><a class="headerlink" href="#plugins.LocalPlayer.Plugin.IS_IMMERSIVE" title="永久链接至目标">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="plugins.LocalPlayer.Plugin.get_song_list">
<code class="descname">get_song_list</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/plugins/LocalPlayer.html#Plugin.get_song_list"><span class="viewcode-link">[源代码]</span></a><a class="headerlink" href="#plugins.LocalPlayer.Plugin.get_song_list" title="永久链接至目标">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="plugins.LocalPlayer.Plugin.handle">
<code class="descname">handle</code><span class="sig-paren">(</span><em>text</em>, <em>parsed</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/plugins/LocalPlayer.html#Plugin.handle"><span class="viewcode-link">[源代码]</span></a><a class="headerlink" href="#plugins.LocalPlayer.Plugin.handle" title="永久链接至目标">¶</a></dt>
<dd><p>处理逻辑</p>
<p>参数：
query – 用户的指令字符串
parsed – 用户指令经过 NLU 解析后的结果</p>
</dd></dl>
<dl class="method">
<dt id="plugins.LocalPlayer.Plugin.init_music_player">
<code class="descname">init_music_player</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/plugins/LocalPlayer.html#Plugin.init_music_player"><span class="viewcode-link">[源代码]</span></a><a class="headerlink" href="#plugins.LocalPlayer.Plugin.init_music_player" title="永久链接至目标">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="plugins.LocalPlayer.Plugin.isValid">
<code class="descname">isValid</code><span class="sig-paren">(</span><em>text</em>, <em>parsed</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/plugins/LocalPlayer.html#Plugin.isValid"><span class="viewcode-link">[源代码]</span></a><a class="headerlink" href="#plugins.LocalPlayer.Plugin.isValid" title="永久链接至目标">¶</a></dt>
<dd><p>是否适合由该插件处理</p>
<p>参数：
query – 用户的指令字符串
parsed – 用户指令经过 NLU 解析后的结果</p>
<p>返回：
True: 适合由该插件处理
False: 不适合由该插件处理</p>
</dd></dl>
<dl class="method">
<dt id="plugins.LocalPlayer.Plugin.isValidImmersive">
<code class="descname">isValidImmersive</code><span class="sig-paren">(</span><em>text</em>, <em>parsed</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/plugins/LocalPlayer.html#Plugin.isValidImmersive"><span class="viewcode-link">[源代码]</span></a><a class="headerlink" href="#plugins.LocalPlayer.Plugin.isValidImmersive" title="永久链接至目标">¶</a></dt>
<dd><p>是否适合在沉浸模式下处理，
仅适用于有沉浸模式的插件（如音乐等）
当用户唤醒时，可以响应更多指令集。
例如：“”上一首”、”下一首” 等</p>
</dd></dl>
<dl class="method">
<dt id="plugins.LocalPlayer.Plugin.pause">
<code class="descname">pause</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/plugins/LocalPlayer.html#Plugin.pause"><span class="viewcode-link">[源代码]</span></a><a class="headerlink" href="#plugins.LocalPlayer.Plugin.pause" title="永久链接至目标">¶</a></dt>
<dd><p>暂停当前正在处理的任务，
当处于该沉浸模式下且被唤醒时，
将自动触发这个方法，
可以用于强制暂停一个耗时的操作</p>
</dd></dl>
<dl class="method">
<dt id="plugins.LocalPlayer.Plugin.restore">
<code class="descname">restore</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/plugins/LocalPlayer.html#Plugin.restore"><span class="viewcode-link">[源代码]</span></a><a class="headerlink" href="#plugins.LocalPlayer.Plugin.restore" title="永久链接至目标">¶</a></dt>
<dd><p>恢复当前插件，
仅适用于有沉浸模式的插件（如音乐等）
当用户误唤醒或者唤醒进行闲聊后，
可以自动恢复当前插件的处理逻辑</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-plugins.Poem">
<span id="plugins-poem-module"></span><h2>plugins.Poem module<a class="headerlink" href="#module-plugins.Poem" title="永久链接至标题">¶</a></h2>
<dl class="class">
<dt id="plugins.Poem.Plugin">
<em class="property">class </em><code class="descclassname">plugins.Poem.</code><code class="descname">Plugin</code><span class="sig-paren">(</span><em>con</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/plugins/Poem.html#Plugin"><span class="viewcode-link">[源代码]</span></a><a class="headerlink" href="#plugins.Poem.Plugin" title="永久链接至目标">¶</a></dt>
<dd><p>基类：<a class="reference internal" href="robot.sdk.html#robot.sdk.AbstractPlugin.AbstractPlugin" title="robot.sdk.AbstractPlugin.AbstractPlugin"><code class="xref py py-class docutils literal notranslate"><span class="pre">robot.sdk.AbstractPlugin.AbstractPlugin</span></code></a></p>
<dl class="attribute">
<dt id="plugins.Poem.Plugin.SLUG">
<code class="descname">SLUG</code><em class="property"> = 'poem'</em><a class="headerlink" href="#plugins.Poem.Plugin.SLUG" title="永久链接至目标">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="plugins.Poem.Plugin.handle">
<code class="descname">handle</code><span class="sig-paren">(</span><em>text</em>, <em>parsed</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/plugins/Poem.html#Plugin.handle"><span class="viewcode-link">[源代码]</span></a><a class="headerlink" href="#plugins.Poem.Plugin.handle" title="永久链接至目标">¶</a></dt>
<dd><p>处理逻辑</p>
<p>参数：
query – 用户的指令字符串
parsed – 用户指令经过 NLU 解析后的结果</p>
</dd></dl>
<dl class="method">
<dt id="plugins.Poem.Plugin.isValid">
<code class="descname">isValid</code><span class="sig-paren">(</span><em>text</em>, <em>parsed</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/plugins/Poem.html#Plugin.isValid"><span class="viewcode-link">[源代码]</span></a><a class="headerlink" href="#plugins.Poem.Plugin.isValid" title="永久链接至目标">¶</a></dt>
<dd><p>是否适合由该插件处理</p>
<p>参数：
query – 用户的指令字符串
parsed – 用户指令经过 NLU 解析后的结果</p>
<p>返回：
True: 适合由该插件处理
False: 不适合由该插件处理</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-plugins">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-plugins" title="永久链接至标题">¶</a></h2>
</div>
</div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2019, wzpan
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>