@@ -218,7 +218,7 @@ These functions are available as exports from react-native-spokestack-tray
218
218
219
219
▸ **listen**(): _Promise‹boolean›_
220
220
221
- _Defined in [src/Spokestack.ts:591](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36 /src/Spokestack.ts#L591)_
221
+ _Defined in [src/Spokestack.ts:591](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a /src/Spokestack.ts#L591)_
222
222
223
223
Tell Spokestack to start listening.
224
224
This will also open the tray.
@@ -239,7 +239,7 @@ await listen()
239
239
240
240
▸ **stopListening**(): _Promise‹boolean›_
241
241
242
- _Defined in [src/Spokestack.ts:611](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36 /src/Spokestack.ts#L611)_
242
+ _Defined in [src/Spokestack.ts:611](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a /src/Spokestack.ts#L611)_
243
243
244
244
Tell Spokestack to stop listening with ASR.
245
245
@@ -259,7 +259,7 @@ stopListening()
259
259
260
260
▸ **isListening**(): _boolean_
261
261
262
- _Defined in [src/Spokestack.ts:475](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36 /src/Spokestack.ts#L475)_
262
+ _Defined in [src/Spokestack.ts:475](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a /src/Spokestack.ts#L475)_
263
263
264
264
Returns whether Spokestack is currently listening with ASR
265
265
@@ -281,15 +281,15 @@ if (isListening()) {
281
281
282
282
• **buttonWidth**? : _number_ (Default: **60**)
283
283
284
- _Defined in [src/SpokestackTray.tsx:90](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36 /src/SpokestackTray.tsx#L90)_
284
+ _Defined in [src/SpokestackTray.tsx:90](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a /src/SpokestackTray.tsx#L90)_
285
285
286
286
Width (and height) of the mic button
287
287
288
288
### clientId
289
289
290
290
• **clientId**: _string_
291
291
292
- _Defined in [src/SpokestackTray.tsx:55](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36 /src/SpokestackTray.tsx#L55)_
292
+ _Defined in [src/SpokestackTray.tsx:55](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a /src/SpokestackTray.tsx#L55)_
293
293
294
294
Your Spokestack tokens generated in your Spokestack account
295
295
at https://spokestack.io/account.
@@ -300,7 +300,7 @@ This is from the "ID" field.
300
300
301
301
• **clientSecret**: _string_
302
302
303
- _Defined in [src/SpokestackTray.tsx:62](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36 /src/SpokestackTray.tsx#L62)_
303
+ _Defined in [src/SpokestackTray.tsx:62](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a /src/SpokestackTray.tsx#L62)_
304
304
305
305
Your Spokestack tokens generated in your Spokestack account
306
306
at https://spokestack.io/account.
@@ -311,31 +311,31 @@ This is from the "secret" field.
311
311
312
312
• **closeDelay**? : _number_ (Default: **0**)
313
313
314
- _Defined in [src/SpokestackTray.tsx:92](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36 /src/SpokestackTray.tsx#L92)_
314
+ _Defined in [src/SpokestackTray.tsx:92](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a /src/SpokestackTray.tsx#L92)_
315
315
316
316
How long to wait to close the tray after speaking (ms)
317
317
318
318
### `Optional` duration
319
319
320
320
• **duration**? : _number_ (Default: **500**)
321
321
322
- _Defined in [src/SpokestackTray.tsx:94](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36 /src/SpokestackTray.tsx#L94)_
322
+ _Defined in [src/SpokestackTray.tsx:94](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a /src/SpokestackTray.tsx#L94)_
323
323
324
324
Duration for the tray animation (ms)
325
325
326
326
### `Optional` easing
327
327
328
328
• **easing**? : _EasingFunction_ (Default: **Easing.bezier**)
329
329
330
- _Defined in [src/SpokestackTray.tsx:96](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36 /src/SpokestackTray.tsx#L96)_
330
+ _Defined in [src/SpokestackTray.tsx:96](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a /src/SpokestackTray.tsx#L96)_
331
331
332
332
Easing function for the tray animation
333
333
334
334
### `Optional` editTranscript
335
335
336
336
• **editTranscript**? : _function_
337
337
338
- _Defined in [src/SpokestackTray.tsx:101](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36 /src/SpokestackTray.tsx#L101)_
338
+ _Defined in [src/SpokestackTray.tsx:101](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a /src/SpokestackTray.tsx#L101)_
339
339
340
340
Edit the transcript before classification
341
341
and before the user response bubble is shown.
@@ -354,7 +354,7 @@ and before the user response bubble is shown.
354
354
355
355
• **exitNodes**? : _string[]_
356
356
357
- _Defined in [src/SpokestackTray.tsx:106](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36 /src/SpokestackTray.tsx#L106)_
357
+ _Defined in [src/SpokestackTray.tsx:106](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a /src/SpokestackTray.tsx#L106)_
358
358
359
359
All nodes in this array should end
360
360
the conversation and close the tray
@@ -363,7 +363,7 @@ the conversation and close the tray
363
363
364
364
• **fontFamily**? : _string_
365
365
366
- _Defined in [src/SpokestackTray.tsx:111](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36 /src/SpokestackTray.tsx#L111)_
366
+ _Defined in [src/SpokestackTray.tsx:111](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a /src/SpokestackTray.tsx#L111)_
367
367
368
368
Font to use for "LISTENING...", "LOADING...",
369
369
and chat bubble text.
@@ -372,7 +372,7 @@ and chat bubble text.
372
372
373
373
• **gradientColors**? : _string[]_
374
374
375
- _Defined in [src/SpokestackTray.tsx:116](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36 /src/SpokestackTray.tsx#L116)_
375
+ _Defined in [src/SpokestackTray.tsx:116](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a /src/SpokestackTray.tsx#L116)_
376
376
377
377
Colors for the linear gradient shown when listening
378
378
Can be any number of colors (recommended: 2-3)
@@ -381,7 +381,7 @@ Can be any number of colors (recommended: 2-3)
381
381
382
382
• **greet**? : _boolean_ (Default: **false**)
383
383
384
- _Defined in [src/SpokestackTray.tsx:122](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36 /src/SpokestackTray.tsx#L122)_
384
+ _Defined in [src/SpokestackTray.tsx:122](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a /src/SpokestackTray.tsx#L122)_
385
385
386
386
Whether to greet the user with a welcome message
387
387
when the tray opens.
@@ -391,7 +391,7 @@ Default: false
391
391
392
392
• **handleIntent**: _function_
393
393
394
- _Defined in [src/SpokestackTray.tsx:72](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36 /src/SpokestackTray.tsx#L72)_
394
+ _Defined in [src/SpokestackTray.tsx:72](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a /src/SpokestackTray.tsx#L72)_
395
395
396
396
This function takes an intent from the NLU
397
397
and returns an object with a unique conversation
@@ -417,7 +417,7 @@ if sound has been turned off.
417
417
418
418
• **haptic**? : _boolean_ (Default: **true**)
419
419
420
- _Defined in [src/SpokestackTray.tsx:127](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36 /src/SpokestackTray.tsx#L127)_
420
+ _Defined in [src/SpokestackTray.tsx:127](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a /src/SpokestackTray.tsx#L127)_
421
421
422
422
Set this to false to disable the haptic
423
423
that gets played whenever the tray starts listening.
@@ -426,15 +426,15 @@ that gets played whenever the tray starts listening.
426
426
427
427
• **minHeight**? : _number_ (Default: **170**)
428
428
429
- _Defined in [src/SpokestackTray.tsx:129](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36 /src/SpokestackTray.tsx#L129)_
429
+ _Defined in [src/SpokestackTray.tsx:129](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a /src/SpokestackTray.tsx#L129)_
430
430
431
431
Minimum height for the tray
432
432
433
433
### `Optional` nluModelUrls
434
434
435
435
• **nluModelUrls**? : _object_
436
436
437
- _Defined in [src/SpokestackTray.tsx:137](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36 /src/SpokestackTray.tsx#L137)_
437
+ _Defined in [src/SpokestackTray.tsx:137](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a /src/SpokestackTray.tsx#L137)_
438
438
439
439
The URLs of your NLU model files.
440
440
These models will be automatically downloaded
@@ -454,7 +454,7 @@ See https://spokestack.io/docs/Concepts/nlu
454
454
455
455
• **onClose**? : _function_
456
456
457
- _Defined in [src/SpokestackTray.tsx:145](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36 /src/SpokestackTray.tsx#L145)_
457
+ _Defined in [src/SpokestackTray.tsx:145](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a /src/SpokestackTray.tsx#L145)_
458
458
459
459
Called whenever the tray has closed
460
460
@@ -466,7 +466,7 @@ Called whenever the tray has closed
466
466
467
467
• **onError**? : _function_
468
468
469
- _Defined in [src/SpokestackTray.tsx:147](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36 /src/SpokestackTray.tsx#L147)_
469
+ _Defined in [src/SpokestackTray.tsx:147](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a /src/SpokestackTray.tsx#L147)_
470
470
471
471
Called whenever there' s an error from Spokestack
472
472
@@ -484,7 +484,7 @@ Called whenever there's an error from Spokestack
484
484
485
485
• ** onOpen** ? : _function_
486
486
487
- _Defined in [src/ SpokestackTray .tsx : 149 ](https: // github.com/spokestack/react-native-spokestack-tray/blob/7569d36 /src/SpokestackTray.tsx#L149)_
487
+ _Defined in [src/ SpokestackTray .tsx : 149 ](https: // github.com/spokestack/react-native-spokestack-tray/blob/b689c1a /src/SpokestackTray.tsx#L149)_
488
488
489
489
Called whenever the tray has opened
490
490
@@ -496,15 +496,15 @@ Called whenever the tray has opened
496
496
497
497
• ** orientation** ? : _" left" | " right" _
498
498
499
- _Defined in [src/ SpokestackTray .tsx : 153 ](https: // github.com/spokestack/react-native-spokestack-tray/blob/7569d36 /src/SpokestackTray.tsx#L153)_
499
+ _Defined in [src/ SpokestackTray .tsx : 153 ](https: // github.com/spokestack/react-native-spokestack-tray/blob/b689c1a /src/SpokestackTray.tsx#L153)_
500
500
501
501
The tray button can be oriented on either side of the screen
502
502
503
503
### ` Optional` primaryColor
504
504
505
505
• ** primaryColor** ? : _string_ (Default: ** " **)
506
506
507
- _Defined in [src/SpokestackTray.tsx:158](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36 /src/SpokestackTray.tsx#L158)_
507
+ _Defined in [src/SpokestackTray.tsx:158](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a /src/SpokestackTray.tsx#L158)_
508
508
509
509
This color is used to theme the tray
510
510
and is used in the mic button and speech bubbles.
@@ -513,7 +513,7 @@ and is used in the mic button and speech bubbles.
513
513
514
514
• **refreshModels**? : _boolean_
515
515
516
- _Defined in [src/SpokestackTray.tsx:165](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36 /src/SpokestackTray.tsx#L165)_
516
+ _Defined in [src/SpokestackTray.tsx:165](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a /src/SpokestackTray.tsx#L165)_
517
517
518
518
Use this sparingly to refresh the
519
519
wakeword and NLU models on device
@@ -524,7 +524,7 @@ wakeword and NLU models on device
524
524
525
525
• **sayGreeting**? : _boolean_ (Default: **true**)
526
526
527
- _Defined in [src/SpokestackTray.tsx:172](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36 /src/SpokestackTray.tsx#L172)_
527
+ _Defined in [src/SpokestackTray.tsx:172](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a /src/SpokestackTray.tsx#L172)_
528
528
529
529
Whether to speak the greeting or only display
530
530
a chat bubble with the greet message,
@@ -535,55 +535,55 @@ Default: true
535
535
536
536
• **soundOffImage**? : _React.ReactNode_
537
537
538
- _Defined in [src/SpokestackTray.tsx:176](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36 /src/SpokestackTray.tsx#L176)_
538
+ _Defined in [src/SpokestackTray.tsx:176](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a /src/SpokestackTray.tsx#L176)_
539
539
540
540
Replace the sound off image by passing an <Image />
541
541
542
542
### `Optional` soundOnImage
543
543
544
544
• **soundOnImage**? : _React.ReactNode_
545
545
546
- _Defined in [src/SpokestackTray.tsx:174](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36 /src/SpokestackTray.tsx#L174)_
546
+ _Defined in [src/SpokestackTray.tsx:174](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a /src/SpokestackTray.tsx#L174)_
547
547
548
548
Replace the sound on image by passing an <Image />
549
549
550
550
### `Optional` startHeight
551
551
552
552
• **startHeight**? : _number_ (Default: **220**)
553
553
554
- _Defined in [src/SpokestackTray.tsx:178](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36 /src/SpokestackTray.tsx#L178)_
554
+ _Defined in [src/SpokestackTray.tsx:178](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a /src/SpokestackTray.tsx#L178)_
555
555
556
556
Starting height for tray
557
557
558
558
### `Optional` style
559
559
560
560
• **style**? : _Animated.WithAnimatedValue‹StyleProp‹ViewStyle››_
561
561
562
- _Defined in [src/SpokestackTray.tsx:180](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36 /src/SpokestackTray.tsx#L180)_
562
+ _Defined in [src/SpokestackTray.tsx:180](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a /src/SpokestackTray.tsx#L180)_
563
563
564
564
This style prop is passed to the tray's container
565
565
566
566
### `Optional` ttsFormat
567
567
568
568
• **ttsFormat**? : _TTSFormat_ (Default: **TTSFormat.TEXT**)
569
569
570
- _Defined in [src/SpokestackTray.tsx:182](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36 /src/SpokestackTray.tsx#L182)_
570
+ _Defined in [src/SpokestackTray.tsx:182](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a /src/SpokestackTray.tsx#L182)_
571
571
572
572
The format for the text passed to Spokestack.synthesize
573
573
574
574
### `Optional` voice
575
575
576
576
• **voice**? : _string_ (Default: **" demo- male" **)
577
577
578
- _Defined in [src/SpokestackTray.tsx:184](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36 /src/SpokestackTray.tsx#L184)_
578
+ _Defined in [src/SpokestackTray.tsx:184](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a /src/SpokestackTray.tsx#L184)_
579
579
580
580
A key for a voice in Spokestack ASR, passed to Spokestack.synthesize
581
581
582
582
### wakewordModelUrls
583
583
584
584
• **wakewordModelUrls**: _object_
585
585
586
- _Defined in [src/SpokestackTray.tsx:84](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36 /src/SpokestackTray.tsx#L84)_
586
+ _Defined in [src/SpokestackTray.tsx:84](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a /src/SpokestackTray.tsx#L84)_
587
587
588
588
The URLs of your wakeword model files.
589
589
These models will be automatically downloaded
@@ -685,7 +685,7 @@ spokestackTray.current.say('Here is something for Spokestack to say')
685
685
686
686
▸ **open**(): _void_
687
687
688
- _Defined in [src/SpokestackTray.tsx:579](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36 /src/SpokestackTray.tsx#L579)_
688
+ _Defined in [src/SpokestackTray.tsx:579](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a /src/SpokestackTray.tsx#L579)_
689
689
690
690
Open the tray, greet (if applicable), and listen
691
691
@@ -697,7 +697,7 @@ Open the tray, greet (if applicable), and listen
697
697
698
698
▸ **close**(): _void_
699
699
700
- _Defined in [src/SpokestackTray.tsx:590](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36 /src/SpokestackTray.tsx#L590)_
700
+ _Defined in [src/SpokestackTray.tsx:590](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a /src/SpokestackTray.tsx#L590)_
701
701
702
702
Close the tray, stop listening, and restart wakeword
703
703
@@ -709,7 +709,7 @@ Close the tray, stop listening, and restart wakeword
709
709
710
710
▸ **say**(`input`: string): _Promise‹void›_
711
711
712
- _Defined in [src/SpokestackTray.tsx:602](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36 /src/SpokestackTray.tsx#L602)_
712
+ _Defined in [src/SpokestackTray.tsx:602](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a /src/SpokestackTray.tsx#L602)_
713
713
714
714
Passes the input to Spokestack.synthesize(),
715
715
plays the audio, and adds a speech bubble.
@@ -728,7 +728,7 @@ plays the audio, and adds a speech bubble.
728
728
729
729
▸ **addBubble**(`bubble`: Bubble): _void_
730
730
731
- _Defined in [src/SpokestackTray.tsx:640](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36 /src/SpokestackTray.tsx#L640)_
731
+ _Defined in [src/SpokestackTray.tsx:640](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a /src/SpokestackTray.tsx#L640)_
732
732
733
733
Add a bubble (system or user)
734
734
to the chat interface
@@ -753,7 +753,7 @@ to the chat interface
753
753
754
754
▸ **toggleSilent**(): _Promise‹boolean›_
755
755
756
- _Defined in [src/SpokestackTray.tsx:652](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36 /src/SpokestackTray.tsx#L652)_
756
+ _Defined in [src/SpokestackTray.tsx:652](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a /src/SpokestackTray.tsx#L652)_
757
757
758
758
Toggle silent mode
759
759
@@ -765,7 +765,7 @@ Toggle silent mode
765
765
766
766
▸ **isSilent**(): _boolean_
767
767
768
- _Defined in [src/SpokestackTray.tsx:664](https://github.com/spokestack/react-native-spokestack-tray/blob/7569d36 /src/SpokestackTray.tsx#L664)_
768
+ _Defined in [src/SpokestackTray.tsx:664](https://github.com/spokestack/react-native-spokestack-tray/blob/b689c1a /src/SpokestackTray.tsx#L664)_
769
769
770
770
Returns whether the tray is in silent mode
771
771
0 commit comments