@@ -239,7 +239,7 @@ These functions are available as exports from react-native-spokestack-tray
239
239
240
240
▸ **listen**(): _Promise‹boolean›_
241
241
242
- _Defined in [src/Spokestack.ts:615](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720 /src/Spokestack.ts#L615)_
242
+ _Defined in [src/Spokestack.ts:615](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a /src/Spokestack.ts#L615)_
243
243
244
244
Tell Spokestack to start listening.
245
245
This will also open the tray.
@@ -260,7 +260,7 @@ await listen()
260
260
261
261
▸ **stopListening**(): _Promise‹boolean›_
262
262
263
- _Defined in [src/Spokestack.ts:635](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720 /src/Spokestack.ts#L635)_
263
+ _Defined in [src/Spokestack.ts:635](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a /src/Spokestack.ts#L635)_
264
264
265
265
Tell Spokestack to stop listening with ASR.
266
266
@@ -280,7 +280,7 @@ stopListening()
280
280
281
281
▸ **isListening**(): _boolean_
282
282
283
- _Defined in [src/Spokestack.ts:498](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720 /src/Spokestack.ts#L498)_
283
+ _Defined in [src/Spokestack.ts:498](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a /src/Spokestack.ts#L498)_
284
284
285
285
Returns whether Spokestack is currently listening with ASR
286
286
@@ -302,15 +302,15 @@ if (isListening()) {
302
302
303
303
• **buttonWidth**? : _number_ (Default: **60**)
304
304
305
- _Defined in [src/SpokestackTray.tsx:102](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720 /src/SpokestackTray.tsx#L102)_
305
+ _Defined in [src/SpokestackTray.tsx:102](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a /src/SpokestackTray.tsx#L102)_
306
306
307
307
Width (and height) of the mic button
308
308
309
309
### clientId
310
310
311
311
• **clientId**: _string_
312
312
313
- _Defined in [src/SpokestackTray.tsx:67](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720 /src/SpokestackTray.tsx#L67)_
313
+ _Defined in [src/SpokestackTray.tsx:67](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a /src/SpokestackTray.tsx#L67)_
314
314
315
315
Your Spokestack tokens generated in your Spokestack account
316
316
at https://spokestack.io/account.
@@ -321,7 +321,7 @@ This is from the "ID" field.
321
321
322
322
• **clientSecret**: _string_
323
323
324
- _Defined in [src/SpokestackTray.tsx:74](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720 /src/SpokestackTray.tsx#L74)_
324
+ _Defined in [src/SpokestackTray.tsx:74](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a /src/SpokestackTray.tsx#L74)_
325
325
326
326
Your Spokestack tokens generated in your Spokestack account
327
327
at https://spokestack.io/account.
@@ -332,39 +332,39 @@ This is from the "secret" field.
332
332
333
333
• **closeDelay**? : _number_ (Default: **0**)
334
334
335
- _Defined in [src/SpokestackTray.tsx:104](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720 /src/SpokestackTray.tsx#L104)_
335
+ _Defined in [src/SpokestackTray.tsx:104](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a /src/SpokestackTray.tsx#L104)_
336
336
337
337
How long to wait to close the tray after speaking (ms)
338
338
339
339
### ` Optional` debug
340
340
341
341
• **debug**? : _boolean_
342
342
343
- _Defined in [src/SpokestackTray.tsx:106](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720 /src/SpokestackTray.tsx#L106)_
343
+ _Defined in [src/SpokestackTray.tsx:106](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a /src/SpokestackTray.tsx#L106)_
344
344
345
345
Show debug messages from react-native-spokestack
346
346
347
347
### ` Optional` duration
348
348
349
349
• **duration**? : _number_ (Default: **500**)
350
350
351
- _Defined in [src/SpokestackTray.tsx:108](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720 /src/SpokestackTray.tsx#L108)_
351
+ _Defined in [src/SpokestackTray.tsx:108](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a /src/SpokestackTray.tsx#L108)_
352
352
353
353
Duration for the tray animation (ms)
354
354
355
355
### ` Optional` easing
356
356
357
357
• **easing**? : _EasingFunction_ (Default: **Easing.bezier**)
358
358
359
- _Defined in [src/SpokestackTray.tsx:110](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720 /src/SpokestackTray.tsx#L110)_
359
+ _Defined in [src/SpokestackTray.tsx:110](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a /src/SpokestackTray.tsx#L110)_
360
360
361
361
Easing function for the tray animation
362
362
363
363
### ` Optional` editTranscript
364
364
365
365
• **editTranscript**? : _function_
366
366
367
- _Defined in [src/SpokestackTray.tsx:115](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720 /src/SpokestackTray.tsx#L115)_
367
+ _Defined in [src/SpokestackTray.tsx:115](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a /src/SpokestackTray.tsx#L115)_
368
368
369
369
Edit the transcript before classification
370
370
and before the user response bubble is shown.
@@ -383,7 +383,7 @@ and before the user response bubble is shown.
383
383
384
384
• **exitNodes**? : _string[]_
385
385
386
- _Defined in [src/SpokestackTray.tsx:120](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720 /src/SpokestackTray.tsx#L120)_
386
+ _Defined in [src/SpokestackTray.tsx:120](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a /src/SpokestackTray.tsx#L120)_
387
387
388
388
All nodes in this array should end
389
389
the conversation and close the tray
@@ -392,7 +392,7 @@ the conversation and close the tray
392
392
393
393
• **fontFamily**? : _string_
394
394
395
- _Defined in [src/SpokestackTray.tsx:125](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720 /src/SpokestackTray.tsx#L125)_
395
+ _Defined in [src/SpokestackTray.tsx:125](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a /src/SpokestackTray.tsx#L125)_
396
396
397
397
Font to use for "LISTENING...", "LOADING...",
398
398
and chat bubble text.
@@ -401,7 +401,7 @@ and chat bubble text.
401
401
402
402
• **gradientColors**? : _string[]_
403
403
404
- _Defined in [src/SpokestackTray.tsx:130](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720 /src/SpokestackTray.tsx#L130)_
404
+ _Defined in [src/SpokestackTray.tsx:130](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a /src/SpokestackTray.tsx#L130)_
405
405
406
406
Colors for the linear gradient shown when listening
407
407
Can be any number of colors (recommended: 2-3)
@@ -410,7 +410,7 @@ Can be any number of colors (recommended: 2-3)
410
410
411
411
• **greet**? : _boolean_ (Default: **false**)
412
412
413
- _Defined in [src/SpokestackTray.tsx:136](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720 /src/SpokestackTray.tsx#L136)_
413
+ _Defined in [src/SpokestackTray.tsx:136](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a /src/SpokestackTray.tsx#L136)_
414
414
415
415
Whether to greet the user with a welcome message
416
416
when the tray opens.
@@ -420,7 +420,7 @@ Note: `handleIntent` must respond to the "greet" intent.
420
420
421
421
• **handleIntent**: _function_
422
422
423
- _Defined in [src/SpokestackTray.tsx:84](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720 /src/SpokestackTray.tsx#L84)_
423
+ _Defined in [src/SpokestackTray.tsx:84](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a /src/SpokestackTray.tsx#L84)_
424
424
425
425
This function takes an intent from the NLU
426
426
and returns an object with a unique conversation
@@ -446,7 +446,7 @@ if sound has been turned off.
446
446
447
447
• **haptic**? : _boolean_ (Default: **true**)
448
448
449
- _Defined in [src/SpokestackTray.tsx:141](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720 /src/SpokestackTray.tsx#L141)_
449
+ _Defined in [src/SpokestackTray.tsx:141](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a /src/SpokestackTray.tsx#L141)_
450
450
451
451
Set this to false to disable the haptic
452
452
that gets played whenever the tray starts listening.
@@ -455,15 +455,15 @@ that gets played whenever the tray starts listening.
455
455
456
456
• **minHeight**? : _number_ (Default: **170**)
457
457
458
- _Defined in [src/SpokestackTray.tsx:143](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720 /src/SpokestackTray.tsx#L143)_
458
+ _Defined in [src/SpokestackTray.tsx:143](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a /src/SpokestackTray.tsx#L143)_
459
459
460
460
Minimum height for the tray
461
461
462
462
### ` Optional` nluModelUrls
463
463
464
464
• **nluModelUrls**? : _object_
465
465
466
- _Defined in [src/SpokestackTray.tsx:151](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720 /src/SpokestackTray.tsx#L151)_
466
+ _Defined in [src/SpokestackTray.tsx:151](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a /src/SpokestackTray.tsx#L151)_
467
467
468
468
The URLs of your NLU model files.
469
469
These models will be automatically downloaded
@@ -483,7 +483,7 @@ See https://spokestack.io/docs/Concepts/nlu
483
483
484
484
• **onClose**? : _function_
485
485
486
- _Defined in [src/SpokestackTray.tsx:159](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720 /src/SpokestackTray.tsx#L159)_
486
+ _Defined in [src/SpokestackTray.tsx:159](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a /src/SpokestackTray.tsx#L159)_
487
487
488
488
Called whenever the tray has closed
489
489
@@ -495,7 +495,7 @@ Called whenever the tray has closed
495
495
496
496
• **onError**? : _function_
497
497
498
- _Defined in [src/SpokestackTray.tsx:161](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720 /src/SpokestackTray.tsx#L161)_
498
+ _Defined in [src/SpokestackTray.tsx:161](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a /src/SpokestackTray.tsx#L161)_
499
499
500
500
Called whenever there's an error from Spokestack
501
501
@@ -513,7 +513,7 @@ Called whenever there's an error from Spokestack
513
513
514
514
• **onOpen**? : _function_
515
515
516
- _Defined in [src/SpokestackTray.tsx:163](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720 /src/SpokestackTray.tsx#L163)_
516
+ _Defined in [src/SpokestackTray.tsx:163](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a /src/SpokestackTray.tsx#L163)_
517
517
518
518
Called whenever the tray has opened
519
519
@@ -525,15 +525,15 @@ Called whenever the tray has opened
525
525
526
526
• **orientation**? : _"left" | "right"_
527
527
528
- _Defined in [src/SpokestackTray.tsx:167](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720 /src/SpokestackTray.tsx#L167)_
528
+ _Defined in [src/SpokestackTray.tsx:167](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a /src/SpokestackTray.tsx#L167)_
529
529
530
530
The tray button can be oriented on either side of the screen
531
531
532
532
### ` Optional` primaryColor
533
533
534
534
• **primaryColor**? : _string_ (Default: **"**)
535
535
536
- _Defined in [src/SpokestackTray.tsx:172](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720 /src/SpokestackTray.tsx#L172)_
536
+ _Defined in [src/SpokestackTray.tsx:172](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a /src/SpokestackTray.tsx#L172)_
537
537
538
538
This color is used to theme the tray
539
539
and is used in the mic button and speech bubbles.
@@ -542,7 +542,7 @@ and is used in the mic button and speech bubbles.
542
542
543
543
• **refreshModels**? : _boolean_
544
544
545
- _Defined in [src/SpokestackTray.tsx:179](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720 /src/SpokestackTray.tsx#L179)_
545
+ _Defined in [src/SpokestackTray.tsx:179](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a /src/SpokestackTray.tsx#L179)_
546
546
547
547
Use this sparingly to refresh the
548
548
wakeword and NLU models on device
@@ -553,7 +553,7 @@ wakeword and NLU models on device
553
553
554
554
• **sayGreeting**? : _boolean_ (Default: **true**)
555
555
556
- _Defined in [src/SpokestackTray.tsx:185](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720 /src/SpokestackTray.tsx#L185)_
556
+ _Defined in [src/SpokestackTray.tsx:185](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a /src/SpokestackTray.tsx#L185)_
557
557
558
558
Whether to speak the greeting or only display
559
559
a chat bubble with the greet message,
@@ -563,55 +563,55 @@ even if sound is on.
563
563
564
564
• **soundOffImage**? : _React.ReactNode_
565
565
566
- _Defined in [src/SpokestackTray.tsx:189](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720 /src/SpokestackTray.tsx#L189)_
566
+ _Defined in [src/SpokestackTray.tsx:189](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a /src/SpokestackTray.tsx#L189)_
567
567
568
568
Replace the sound off image by passing an <Image />
569
569
570
570
### ` Optional` soundOnImage
571
571
572
572
• **soundOnImage**? : _React.ReactNode_
573
573
574
- _Defined in [src/SpokestackTray.tsx:187](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720 /src/SpokestackTray.tsx#L187)_
574
+ _Defined in [src/SpokestackTray.tsx:187](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a /src/SpokestackTray.tsx#L187)_
575
575
576
576
Replace the sound on image by passing an <Image />
577
577
578
578
### ` Optional` startHeight
579
579
580
580
• **startHeight**? : _number_ (Default: **220**)
581
581
582
- _Defined in [src/SpokestackTray.tsx:191](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720 /src/SpokestackTray.tsx#L191)_
582
+ _Defined in [src/SpokestackTray.tsx:191](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a /src/SpokestackTray.tsx#L191)_
583
583
584
584
Starting height for tray
585
585
586
586
### ` Optional` style
587
587
588
588
• **style**? : _Animated.WithAnimatedValue‹StyleProp‹ViewStyle››_
589
589
590
- _Defined in [src/SpokestackTray.tsx:193](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720 /src/SpokestackTray.tsx#L193)_
590
+ _Defined in [src/SpokestackTray.tsx:193](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a /src/SpokestackTray.tsx#L193)_
591
591
592
592
This style prop is passed to the tray's container
593
593
594
594
### ` Optional` ttsFormat
595
595
596
596
• **ttsFormat**? : _TTSFormat_ (Default: **TTSFormat.TEXT**)
597
597
598
- _Defined in [src/SpokestackTray.tsx:195](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720 /src/SpokestackTray.tsx#L195)_
598
+ _Defined in [src/SpokestackTray.tsx:195](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a /src/SpokestackTray.tsx#L195)_
599
599
600
600
The format for the text passed to Spokestack.synthesize
601
601
602
602
### ` Optional` voice
603
603
604
604
• **voice**? : _string_ (Default: **"demo-male"**)
605
605
606
- _Defined in [src/SpokestackTray.tsx:197](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720 /src/SpokestackTray.tsx#L197)_
606
+ _Defined in [src/SpokestackTray.tsx:197](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a /src/SpokestackTray.tsx#L197)_
607
607
608
608
A key for a voice in Spokestack ASR, passed to Spokestack.synthesize
609
609
610
610
### wakewordModelUrls
611
611
612
612
• **wakewordModelUrls**: _object_
613
613
614
- _Defined in [src/SpokestackTray.tsx:96](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720 /src/SpokestackTray.tsx#L96)_
614
+ _Defined in [src/SpokestackTray.tsx:96](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a /src/SpokestackTray.tsx#L96)_
615
615
616
616
The URLs of your wakeword model files.
617
617
These models will be automatically downloaded
@@ -715,7 +715,7 @@ spokestackTray.current.say('Here is something for Spokestack to say')
715
715
716
716
▸ **open**(): _void_
717
717
718
- _Defined in [src/SpokestackTray.tsx:586](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720 /src/SpokestackTray.tsx#L586)_
718
+ _Defined in [src/SpokestackTray.tsx:586](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a /src/SpokestackTray.tsx#L586)_
719
719
720
720
Open the tray, greet (if applicable), and listen
721
721
@@ -727,7 +727,7 @@ Open the tray, greet (if applicable), and listen
727
727
728
728
▸ **close**(): _void_
729
729
730
- _Defined in [src/SpokestackTray.tsx:597](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720 /src/SpokestackTray.tsx#L597)_
730
+ _Defined in [src/SpokestackTray.tsx:597](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a /src/SpokestackTray.tsx#L597)_
731
731
732
732
Close the tray, stop listening, and restart wakeword
733
733
@@ -739,7 +739,7 @@ Close the tray, stop listening, and restart wakeword
739
739
740
740
▸ **say**(` input` : string): _Promise‹void›_
741
741
742
- _Defined in [src/SpokestackTray.tsx:609](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720 /src/SpokestackTray.tsx#L609)_
742
+ _Defined in [src/SpokestackTray.tsx:609](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a /src/SpokestackTray.tsx#L609)_
743
743
744
744
Passes the input to Spokestack.synthesize(),
745
745
plays the audio, and adds a speech bubble.
@@ -758,7 +758,7 @@ plays the audio, and adds a speech bubble.
758
758
759
759
▸ **addBubble**(` bubble` : Bubble): _void_
760
760
761
- _Defined in [src/SpokestackTray.tsx:647](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720 /src/SpokestackTray.tsx#L647)_
761
+ _Defined in [src/SpokestackTray.tsx:647](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a /src/SpokestackTray.tsx#L647)_
762
762
763
763
Add a bubble (system or user)
764
764
to the chat interface
@@ -783,7 +783,7 @@ to the chat interface
783
783
784
784
▸ **toggleSilent**(): _Promise‹boolean›_
785
785
786
- _Defined in [src/SpokestackTray.tsx:659](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720 /src/SpokestackTray.tsx#L659)_
786
+ _Defined in [src/SpokestackTray.tsx:659](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a /src/SpokestackTray.tsx#L659)_
787
787
788
788
Toggle silent mode
789
789
@@ -795,7 +795,7 @@ Toggle silent mode
795
795
796
796
▸ **isSilent**(): _boolean_
797
797
798
- _Defined in [src/SpokestackTray.tsx:671](https://github.com/spokestack/react-native-spokestack-tray/blob/172f720 /src/SpokestackTray.tsx#L671)_
798
+ _Defined in [src/SpokestackTray.tsx:671](https://github.com/spokestack/react-native-spokestack-tray/blob/7661c6a /src/SpokestackTray.tsx#L671)_
799
799
800
800
Returns whether the tray is in silent mode
801
801
0 commit comments