@@ -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/7a2617f /src/Spokestack.ts#L591)_
221
+ _Defined in [src/Spokestack.ts:591](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9 /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/7a2617f /src/Spokestack.ts#L611)_
242
+ _Defined in [src/Spokestack.ts:611](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9 /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/7a2617f /src/Spokestack.ts#L475)_
262
+ _Defined in [src/Spokestack.ts:475](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9 /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/7a2617f /src/SpokestackTray.tsx#L90)_
284
+ _Defined in [src/SpokestackTray.tsx:90](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9 /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/7a2617f /src/SpokestackTray.tsx#L55)_
292
+ _Defined in [src/SpokestackTray.tsx:55](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9 /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/7a2617f /src/SpokestackTray.tsx#L62)_
303
+ _Defined in [src/SpokestackTray.tsx:62](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9 /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/7a2617f /src/SpokestackTray.tsx#L92)_
314
+ _Defined in [src/SpokestackTray.tsx:92](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9 /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/7a2617f /src/SpokestackTray.tsx#L94)_
322
+ _Defined in [src/SpokestackTray.tsx:94](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9 /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/7a2617f /src/SpokestackTray.tsx#L96)_
330
+ _Defined in [src/SpokestackTray.tsx:96](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9 /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/7a2617f /src/SpokestackTray.tsx#L101)_
338
+ _Defined in [src/SpokestackTray.tsx:101](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9 /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/7a2617f /src/SpokestackTray.tsx#L106)_
357
+ _Defined in [src/SpokestackTray.tsx:106](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9 /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/7a2617f /src/SpokestackTray.tsx#L111)_
366
+ _Defined in [src/SpokestackTray.tsx:111](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9 /src/SpokestackTray.tsx#L111)_
367
367
368
368
Font to use for "LISTENING...", "LOADING...",
369
369
and chat bubble text.
@@ -372,15 +372,15 @@ and chat bubble text.
372
372
373
373
• **gradientColors**? : _string[]_
374
374
375
- _Defined in [src/SpokestackTray.tsx:115](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f /src/SpokestackTray.tsx#L115)_
375
+ _Defined in [src/SpokestackTray.tsx:115](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9 /src/SpokestackTray.tsx#L115)_
376
376
377
377
Colors for the linear gradient shown when listening
378
378
379
379
### `Optional` greet
380
380
381
381
• **greet**? : _boolean_ (Default: **false**)
382
382
383
- _Defined in [src/SpokestackTray.tsx:121](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f /src/SpokestackTray.tsx#L121)_
383
+ _Defined in [src/SpokestackTray.tsx:121](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9 /src/SpokestackTray.tsx#L121)_
384
384
385
385
Whether to greet the user with a welcome message
386
386
when the tray opens.
@@ -390,7 +390,7 @@ Default: false
390
390
391
391
• **handleIntent**: _function_
392
392
393
- _Defined in [src/SpokestackTray.tsx:72](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f /src/SpokestackTray.tsx#L72)_
393
+ _Defined in [src/SpokestackTray.tsx:72](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9 /src/SpokestackTray.tsx#L72)_
394
394
395
395
This function takes an intent from the NLU
396
396
and returns an object with a unique conversation
@@ -416,7 +416,7 @@ if sound has been turned off.
416
416
417
417
• **haptic**? : _boolean_ (Default: **true**)
418
418
419
- _Defined in [src/SpokestackTray.tsx:126](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f /src/SpokestackTray.tsx#L126)_
419
+ _Defined in [src/SpokestackTray.tsx:126](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9 /src/SpokestackTray.tsx#L126)_
420
420
421
421
Set this to false to disable the haptic
422
422
that gets played whenever the tray starts listening.
@@ -425,15 +425,15 @@ that gets played whenever the tray starts listening.
425
425
426
426
• **minHeight**? : _number_ (Default: **170**)
427
427
428
- _Defined in [src/SpokestackTray.tsx:128](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f /src/SpokestackTray.tsx#L128)_
428
+ _Defined in [src/SpokestackTray.tsx:128](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9 /src/SpokestackTray.tsx#L128)_
429
429
430
430
Minimum height for the tray
431
431
432
432
### `Optional` nluModelUrls
433
433
434
434
• **nluModelUrls**? : _object_
435
435
436
- _Defined in [src/SpokestackTray.tsx:136](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f /src/SpokestackTray.tsx#L136)_
436
+ _Defined in [src/SpokestackTray.tsx:136](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9 /src/SpokestackTray.tsx#L136)_
437
437
438
438
The URLs of your NLU model files.
439
439
These models will be automatically downloaded
@@ -453,7 +453,7 @@ See https://spokestack.io/docs/Concepts/nlu
453
453
454
454
• **onClose**? : _function_
455
455
456
- _Defined in [src/SpokestackTray.tsx:144](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f /src/SpokestackTray.tsx#L144)_
456
+ _Defined in [src/SpokestackTray.tsx:144](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9 /src/SpokestackTray.tsx#L144)_
457
457
458
458
Called whenever the tray has closed
459
459
@@ -465,7 +465,7 @@ Called whenever the tray has closed
465
465
466
466
• **onError**? : _function_
467
467
468
- _Defined in [src/SpokestackTray.tsx:146](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f /src/SpokestackTray.tsx#L146)_
468
+ _Defined in [src/SpokestackTray.tsx:146](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9 /src/SpokestackTray.tsx#L146)_
469
469
470
470
Called whenever there' s an error from Spokestack
471
471
@@ -483,7 +483,7 @@ Called whenever there's an error from Spokestack
483
483
484
484
• ** onOpen** ? : _function_
485
485
486
- _Defined in [src/ SpokestackTray .tsx : 148 ](https: // github.com/spokestack/react-native-spokestack-tray/blob/7a2617f /src/SpokestackTray.tsx#L148)_
486
+ _Defined in [src/ SpokestackTray .tsx : 148 ](https: // github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9 /src/SpokestackTray.tsx#L148)_
487
487
488
488
Called whenever the tray has opened
489
489
@@ -495,15 +495,15 @@ Called whenever the tray has opened
495
495
496
496
• ** orientation** ? : _" left" | " right" _
497
497
498
- _Defined in [src/ SpokestackTray .tsx : 152 ](https: // github.com/spokestack/react-native-spokestack-tray/blob/7a2617f /src/SpokestackTray.tsx#L152)_
498
+ _Defined in [src/ SpokestackTray .tsx : 152 ](https: // github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9 /src/SpokestackTray.tsx#L152)_
499
499
500
500
The tray button can be oriented on either side of the screen
501
501
502
502
### ` Optional` primaryColor
503
503
504
504
• ** primaryColor** ? : _string_ (Default: ** " **)
505
505
506
- _Defined in [src/SpokestackTray.tsx:157](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f /src/SpokestackTray.tsx#L157)_
506
+ _Defined in [src/SpokestackTray.tsx:157](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9 /src/SpokestackTray.tsx#L157)_
507
507
508
508
This color is used to theme the tray
509
509
and is used in the mic button and speech bubbles.
@@ -512,7 +512,7 @@ and is used in the mic button and speech bubbles.
512
512
513
513
• **refreshModels**? : _boolean_
514
514
515
- _Defined in [src/SpokestackTray.tsx:164](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f /src/SpokestackTray.tsx#L164)_
515
+ _Defined in [src/SpokestackTray.tsx:164](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9 /src/SpokestackTray.tsx#L164)_
516
516
517
517
Use this sparingly to refresh the
518
518
wakeword and NLU models on device
@@ -523,7 +523,7 @@ wakeword and NLU models on device
523
523
524
524
• **sayGreeting**? : _boolean_ (Default: **true**)
525
525
526
- _Defined in [src/SpokestackTray.tsx:171](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f /src/SpokestackTray.tsx#L171)_
526
+ _Defined in [src/SpokestackTray.tsx:171](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9 /src/SpokestackTray.tsx#L171)_
527
527
528
528
Whether to speak the greeting or only display
529
529
a chat bubble with the greet message,
@@ -534,55 +534,55 @@ Default: true
534
534
535
535
• **soundOffImage**? : _React.ReactNode_
536
536
537
- _Defined in [src/SpokestackTray.tsx:175](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f /src/SpokestackTray.tsx#L175)_
537
+ _Defined in [src/SpokestackTray.tsx:175](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9 /src/SpokestackTray.tsx#L175)_
538
538
539
539
Replace the sound off image by passing an <Image />
540
540
541
541
### `Optional` soundOnImage
542
542
543
543
• **soundOnImage**? : _React.ReactNode_
544
544
545
- _Defined in [src/SpokestackTray.tsx:173](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f /src/SpokestackTray.tsx#L173)_
545
+ _Defined in [src/SpokestackTray.tsx:173](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9 /src/SpokestackTray.tsx#L173)_
546
546
547
547
Replace the sound on image by passing an <Image />
548
548
549
549
### `Optional` startHeight
550
550
551
551
• **startHeight**? : _number_ (Default: **220**)
552
552
553
- _Defined in [src/SpokestackTray.tsx:177](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f /src/SpokestackTray.tsx#L177)_
553
+ _Defined in [src/SpokestackTray.tsx:177](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9 /src/SpokestackTray.tsx#L177)_
554
554
555
555
Starting height for tray
556
556
557
557
### `Optional` style
558
558
559
559
• **style**? : _Animated.WithAnimatedValue‹StyleProp‹ViewStyle››_
560
560
561
- _Defined in [src/SpokestackTray.tsx:179](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f /src/SpokestackTray.tsx#L179)_
561
+ _Defined in [src/SpokestackTray.tsx:179](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9 /src/SpokestackTray.tsx#L179)_
562
562
563
563
This style prop is passed to the tray's container
564
564
565
565
### `Optional` ttsFormat
566
566
567
567
• **ttsFormat**? : _TTSFormat_ (Default: **TTSFormat.TEXT**)
568
568
569
- _Defined in [src/SpokestackTray.tsx:181](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f /src/SpokestackTray.tsx#L181)_
569
+ _Defined in [src/SpokestackTray.tsx:181](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9 /src/SpokestackTray.tsx#L181)_
570
570
571
571
The format for the text passed to Spokestack.synthesize
572
572
573
573
### `Optional` voice
574
574
575
575
• **voice**? : _string_ (Default: **" demo- male" **)
576
576
577
- _Defined in [src/SpokestackTray.tsx:183](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f /src/SpokestackTray.tsx#L183)_
577
+ _Defined in [src/SpokestackTray.tsx:183](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9 /src/SpokestackTray.tsx#L183)_
578
578
579
579
A key for a voice in Spokestack ASR, passed to Spokestack.synthesize
580
580
581
581
### wakewordModelUrls
582
582
583
583
• **wakewordModelUrls**: _object_
584
584
585
- _Defined in [src/SpokestackTray.tsx:84](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f /src/SpokestackTray.tsx#L84)_
585
+ _Defined in [src/SpokestackTray.tsx:84](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9 /src/SpokestackTray.tsx#L84)_
586
586
587
587
The URLs of your wakeword model files.
588
588
These models will be automatically downloaded
@@ -684,7 +684,7 @@ spokestackTray.current.say('Here is something for Spokestack to say')
684
684
685
685
▸ **open**(): _void_
686
686
687
- _Defined in [src/SpokestackTray.tsx:578](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f /src/SpokestackTray.tsx#L578)_
687
+ _Defined in [src/SpokestackTray.tsx:578](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9 /src/SpokestackTray.tsx#L578)_
688
688
689
689
Open the tray, greet (if applicable), and listen
690
690
@@ -696,7 +696,7 @@ Open the tray, greet (if applicable), and listen
696
696
697
697
▸ **close**(): _void_
698
698
699
- _Defined in [src/SpokestackTray.tsx:585](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f /src/SpokestackTray.tsx#L585)_
699
+ _Defined in [src/SpokestackTray.tsx:585](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9 /src/SpokestackTray.tsx#L585)_
700
700
701
701
Close the tray, stop listening, and restart wakeword
702
702
@@ -708,7 +708,7 @@ Close the tray, stop listening, and restart wakeword
708
708
709
709
▸ **say**(`input`: string): _Promise‹void›_
710
710
711
- _Defined in [src/SpokestackTray.tsx:593](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f /src/SpokestackTray.tsx#L593)_
711
+ _Defined in [src/SpokestackTray.tsx:593](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9 /src/SpokestackTray.tsx#L593)_
712
712
713
713
Passes the input to Spokestack.synthesize(),
714
714
plays the audio, and adds a speech bubble.
@@ -727,7 +727,7 @@ plays the audio, and adds a speech bubble.
727
727
728
728
▸ **addBubble**(`bubble`: Bubble): _void_
729
729
730
- _Defined in [src/SpokestackTray.tsx:631](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f /src/SpokestackTray.tsx#L631)_
730
+ _Defined in [src/SpokestackTray.tsx:631](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9 /src/SpokestackTray.tsx#L631)_
731
731
732
732
Add a bubble (system or user)
733
733
to the chat interface
@@ -752,7 +752,7 @@ to the chat interface
752
752
753
753
▸ **toggleSilent**(): _Promise‹boolean›_
754
754
755
- _Defined in [src/SpokestackTray.tsx:643](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f /src/SpokestackTray.tsx#L643)_
755
+ _Defined in [src/SpokestackTray.tsx:643](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9 /src/SpokestackTray.tsx#L643)_
756
756
757
757
Toggle silent mode
758
758
@@ -764,7 +764,7 @@ Toggle silent mode
764
764
765
765
▸ **isSilent**(): _boolean_
766
766
767
- _Defined in [src/SpokestackTray.tsx:655](https://github.com/spokestack/react-native-spokestack-tray/blob/7a2617f /src/SpokestackTray.tsx#L655)_
767
+ _Defined in [src/SpokestackTray.tsx:655](https://github.com/spokestack/react-native-spokestack-tray/blob/59ce3e9 /src/SpokestackTray.tsx#L655)_
768
768
769
769
Returns whether the tray is in silent mode
770
770
0 commit comments