react native spokestack tray скачать - react native spokestack tray Source Code Скачать

Отреагировать нативный поднос для спикштака

Настоящий нативный компонент React для добавления Spokestack в любое нативное приложение React.

Пример приложения

Установка

Установите эту библиотеку с зависимостью со стороны сверстников

Одностроитель для установки всех зависимостей

npm install react-native-spokestack-tray react-native-spokestack @react-native-community/async-storage react-native-video react-native-haptic-feedback react-native-linear-gradient react-native-permissions

Каждая зависимость от его использования.

$ npm install react-native-spokestack-tray react-native-spokestack

# Used for storing a simple boolean to turn on/off sound
$ npm install @react-native-community/async-storage

# Used to play TTS audio prompts.
# Despite its name, we think this is one of the best
# plugins (if not the best) for playing audio.
# In iOS, Audio and Video are intertwined anyway.
$ npm install react-native-video

# Used to show an animating gradient when Spokestack listens
$ npm install react-native-linear-gradient

# Used to check microphone and speech recognition permissions
$ npm install react-native-permissions

# Used to generate a haptic whenever Spokestack listens.
# This can be turned off, but the dependency is still needed.
$ npm install react-native-haptic-feedback

Затем следуйте инструкциям для каждой платформы, чтобы связать реагируемое явление на вашем проекте:

Установка iOS

Детали iOS

Установите цель развертывания

React-Con-Spokestack использует относительно новые API, доступные только в iOS 13+. Обязательно установите цель развертывания на iOS 13.

Во -первых, откройте Xcode и перейдите в Project -> Информация, чтобы установить цель развертывания iOS на 13,0 или выше.

Кроме того, установите развертывание на 13.0 в Target -> General -> Информация о развертывании.

Удалить неверный путь поиска библиотеки

Когда Flipper был введен для реагирования нативного, некоторые пути поиска библиотеки были установлены для Swift. Была давняя проблема с путями поиска по умолчанию в нативных проектах React, потому что для Swift 5.0 был добавлен путь поиска, что помешало любым другими нативными библиотеками React использовать API, доступные только в Swift 5.2 или более поздней версии. Spokestack-IOIS, зависимость от реагируемого явления, используя эти API, и Xcode не сможет построить.

К счастью, исправление довольно простое. Перейдите к своей цели -> Настройки сборки и поиск «Пути поиска библиотеки».

Удалить ""$(TOOLCHAIN_DIR)/usr/lib/swift-5.0/$(PLATFORM_NAME)"" из списка.

Редактировать Podfile

Перед запуском pod install , обязательно сделайте следующие изменения.

 platform :ios , '13.0'

Нам также нужно использовать use_frameworks! В нашем Podfile для поддержки зависимостей, написанных в Swift.

 target 'SpokestackExample' do
  use_frameworks!
  #...

На данный момент, use_frameworks! Не работает с Flipper, поэтому нам также нужно отключить Flipper. Удалите любые линии, связанные с флиппером, в вашем Podfile. В React Native 0,63,2 они выглядят так:

  # X Remove or comment out these lines X
  # use_flipper!
  # post_install do |installer|
  #   flipper_post_install(installer)
  # end
  # XX

Реактивные капсулы

Мы используем реагируемые по имени, чтобы проверить и запросить разрешение на микрофон (iOS и Android) и разрешение на распознавание речи (только iOS). Эта библиотека разделяет каждое разрешение на свой капсул, чтобы избежать раздувания вашего приложения кодом, который вы не используете. Добавьте следующие стручки в свой Podfile:

 target 'SpokestackTrayExample' do
  # ...
  permissions_path = '../node_modules/react-native-permissions/ios'
  pod 'Permission-Microphone' , :path => " #{ permissions_path } /Microphone.podspec"
  pod 'Permission-SpeechRecognition' , :path => " #{ permissions_path } /SpeechRecognition.podspec"

Ошибка в React Native 0,64,0 (должна быть зафиксирована в 0,64,1)

React Native 0.64.0 сломал любые проекты, используя use_frameworks! в их поборах.

Для получения дополнительной информации об этой ошибке см. Facebook/React-родной#31149.

Чтобы обезвредить эту проблему, добавьте следующее в свой Podfile:

 # Moves 'Generate Specs' build_phase to be first for FBReactNativeSpec
post_install do | installer |
  installer . pods_project . targets . each do | target |
    if ( target . name &. eql? ( 'FBReactNativeSpec' ) )
      target . build_phases . each do | build_phase |
        if ( build_phase . respond_to? ( :name ) && build_phase . name . eql? ( '[CP-User] Generate Specs' ) )
          target . build_phases . move ( build_phase , 0 )
        end
      end
    end
  end
end

POD установка

Удалите существующую папку Podfile.lock и Pods, чтобы обеспечить отсутствие конфликтов, затем установите стручки:

$ npx pod-install

Редактировать info.plist

Добавьте следующее в свой info.plist, чтобы разрешить разрешения. В XCode также убедитесь, что ваша цель развертывания в iOS установлена на 13,0 или выше.

< key >NSMicrophoneUsageDescription</ key >
< string >This app uses the microphone to hear voice commands</ string >
< key >NSSpeechRecognitionUsageDescription</ key >
< string >This app uses speech recognition to process voice commands</ string >

Удалить флиппер

В то время как Flipper работает над исправлением своей стручки для use_frameworks! , мы должны отключить флиппер. Мы уже удалили зависимости Flipper из стручков выше, но в appdelegate.m остается какой -то код, который импортирует Flipper. Есть два способа исправить это.

Вы можете отключить импорт Flipper, не удаляя код из AppDelegate. Для этого откройте свой файл XCWorkspace в XCode. Перейдите к своей цели, затем постройте настройки, найдите «C Flags», удалите -DFB_SONARKIT_ENABLED=1 из флагов.
Удалите весь код, связанный с флиппером, из вашего appdelegate.m.

В нашем примере примера мы сделали вариант 1 и оставили в коде Flipper, если они заработают его в будущем, и мы сможем добавить его обратно.

Редактировать Appdelegate.m

Добавить AvFoundation в импорт

# import < AVFoundation/AVFoundation.h >

Категория Audiosession

Установите категорию Audiosession. Есть несколько конфигураций, которые работают.

Ниже приводится предложение, которое должно соответствовать большинству вариантов использования:

- ( BOOL )application:(UIApplication *)application didFinishLaunchingWithOptions:( NSDictionary *)launchOptions
{
  AVAudioSession *session = [AVAudioSession sharedInstance ];
  [session setCategory: AVAudioSessionCategoryPlayAndRecord
     mode: AVAudioSessionModeDefault
  options: AVAudioSessionCategoryOptionDefaultToSpeaker | AVAudioSessionCategoryOptionAllowAirPlay | AVAudioSessionCategoryOptionAllowBluetoothA2DP | AVAudioSessionCategoryOptionAllowBluetooth
    error: nil ];
  [session setActive: YES error: nil ];

  // ...

Установка Android

Андоидные детали

Поддержка ASR

В примере использования используется предоставленная система ASRS ( AndroidSpeechRecognizer и AppleSpeechRecognizer ). Тем не менее, AndroidSpeechRecognizer недоступен на 100% устройств. Если ваше приложение поддерживает устройство, которое не имеет встроенного распознавания речи, вместо этого используйте Spokestack ASR, установив profile в профиль Spokestack, используя profile .

Смотрите нашу документацию ASR для получения дополнительной информации.

Редактировать root build.gradle ( не приложение/build.gradle)

 // ...
  ext {
    // Minimum SDK is 21
    minSdkVersion = 21
// ...
  dependencies {
    // Minimium gradle is 3.0.1+
    // The latest React Native already has this
    classpath( " com.android.tools.build:gradle:3.5.3 " )

Редактировать Androidmanifest.xml

Добавьте необходимые разрешения в свой AndroidManifest.xml . Первое разрешение часто уже есть. Второй необходим для использования микрофона.

    <!-- For TTS -->
    < uses-permission android : name = " android.permission.INTERNET " />
    <!-- For wakeword and ASR -->
    < uses-permission android : name = " android.permission.RECORD_AUDIO " />
    <!-- For ensuring no downloads happen over cellular, unless forced -->
    < uses-permission android : name = " android.permission.ACCESS_NETWORK_STATE " />

Использование

 import SpokestackTray , { listen } from 'react-native-spokestack-tray'

// ...

export default function ConversationHandler ( { navigation } ) {
  return (
    < SpokestackTray
      clientId = { process . env . SPOKESTACK_CLIENT_ID }
      clientSecret = { process . env . SPOKESTACK_CLIENT_SECRET }
      handleIntent = { ( intent , slots , utterance ) => {
        switch ( intent ) {
          // These cases would be for all
          // the possible intents defined in your NLU.
          case 'request.select' :
            // As an example, search with some service
            // with the given value from the NLU
            const recipe = SearchService . find ( slots . recipe ?. value )
            // An example of navigating to some scene to show
            // data, a recipe in our example.
            navigation . navigate ( 'Recipe' , { recipe } )
            return {
              node : 'info.recipe' ,
              prompt : 'We found your recipe!'
            }
          default :
            return {
              node : 'welcome' ,
              prompt : 'Let us help you find a recipe.'
            }
        }
      } }
      // The NLU models are downloaded and then cached
      // when the app is first installed.
      // See https://spokestack.io/docs/concepts/nlu
      // for more info on NLU.
      nlu = { {
        nlu : 'https://somecdn/nlu.tflite' ,
        vocab : 'https://somecdn/vocab.txt' ,
        metadata : 'https://somecdn/metadata.json'
      } }
    />
  )
}

Включая модельные файлы в пакет приложения

Чтобы включить модельные файлы локально в ваше приложение (вместо того, чтобы загружать их из CDN), вам также необходимо добавить необходимые расширения, чтобы файлы могли быть включены Babel. Чтобы сделать это, отредактируйте свой metro.config.js .

 const defaults = require ( 'metro-config/src/defaults/defaults' )

module . exports = {
  resolver : {
    // json is already in the list
    assetExts : defaults . assetExts . concat ( [ 'tflite' , 'txt' , 'sjson' ] )
  }
}

Затем включите файлы моделей, используя исходные объекты:

 < SpokestackTray
  clientId = { process . env . SPOKESTACK_CLIENT_ID }
  clientSecret = { process . env . SPOKESTACK_CLIENT_SECRET }
  handleIntent = { handleIntent }
  wakeword = { {
    filter : require ( './filter.tflite' ) ,
    detect : require ( './detect.tflite' ) ,
    encode : require ( './encode.tflite' )
  } }
  nlu = { {
    model : require ( './nlu.tflite' ) ,
    vocab : require ( './vocab.txt' ) ,
    // Be sure not to use "json" here.
    // We use a different extension (.sjson) so that the file is not
    // immediately parsed as json and instead
    // passes a require source object to Spokestack.
    // The special extension is only necessary for local files.
    metadata : require ( './metadata.sjson' )
  } }
/>

Это не требуется. Пропустите удаленные URL -адреса к тем же параметрам конфигурации, и файлы будут загружены и кэшируются при первом вызове initialize .

Внося

См. Руководство по содействию, чтобы узнать, как внести свой вклад в репозиторий и рабочий процесс разработки.

Документация

`<SpokestackTray />` props компонента

путовиза

• Optional путовида : number (по умолчанию: 60 )

Ширина (и высота) кнопки микрофона

Определено в

src/spokestacktray.tsx: 132

ClientId

• ClientId : string

Ваши жетоны Spokestack сгенерировали в вашей учетной записи Spokestack по адресу https://spokestack.io/account. Создайте учетную запись бесплатно, а затем генерируйте токен. Это с поля "ID".

Определено в

src/spokestacktray.tsx: 74

Clientsecret

• Clientsecret : string

Определено в

src/spokestacktray.tsx: 81

закрытый

• Optional закрытый налет : number (по умолчанию: 0 )

Как долго ждать, чтобы закрыть поднос после выступления (MS)

Определено в

src/spokestacktray.tsx: 134

отлаживать

• Optional отладка : boolean

Показать сообщения отладки от React-Con-Spokestack

Определено в

src/spokestacktray.tsx: 136

продолжительность

• Optional продолжительность : number (по умолчанию: 500 )

Продолжительность для анимации лотка (MS)

Определено в

src/spokestacktray.tsx: 138

ослабление

• Optional смягчение : EasingFunction (по умолчанию: eareing.bezier (0,77, 0,41, 0,2, 0,84) )

Функция смягчения для анимации лотка

Определено в

src/spokestacktray.tsx: 140

выходящие

• Optional выходы : string []

Все узлы в этом массиве должны закончить разговор и закрыть поднос

Определено в

src/spokestacktray.tsx: 150

Фонфимилия

• Optional семейство : string

Шрифт для использования для «прослушивания ...», «Загрузка ...» и текст пузыря чата.

Определено в

src/spokestacktray.tsx: 155

GradientColors

• Optional GradientColors : string [] (по умолчанию: ["#61FAE9", "#2F5BEA"] )

Цвета для линейного градиента, показанного при прослушивании, могут быть любым количеством цветов (рекомендуется: 2-3)

Определено в

src/spokestacktray.tsx: 160

приветствовать

• Optional приветствие : boolean (по умолчанию: ложь )

Приветствовать ли пользователя с приветственным сообщением, когда откроется лоток. ПРИМЕЧАНИЕ. handleIntent должно ответить на намерение «приветствие».

Определено в

src/spokestacktray.tsx: 166

гаптик

• Optional тактичный : boolean (по умолчанию: TRUE )

Установите это на false, чтобы отключить тактику, которое воспроизводится всякий раз, когда поднос начинает слушать.

Определено в

src/spokestacktray.tsx: 171

ключевое слово

• Optional ключевое слово : KeywordConfig

Конфигурация для распознавания ключевых слов

Поле фильтра, обнаружения, кодирования и метаданных принимают 2 типа значений.

Строка, представляющая удаленный URL, с которого можно загрузить и кэшировать файл (предположительно из CDN).
Исходный объект, полученный по require или import (например, model: require('./nlu.tflite') )

См. Https://www.spokestack.io/docs/concepts/keywords, чтобы узнать больше о распознавании ключевых слов.

example

 // ...
keyword = { {
  detect : 'https://s.spokestack.io/u/UbMeX/detect.tflite' ,
  encode : 'https://s.spokestack.io/u/UbMeX/encode.tflite' ,
  filter : 'https://s.spokestack.io/u/UbMeX/filter.tflite' ,
  metadata : 'https://s.spokestack.io/u/UbMeX/metadata.json'
} }

Вы также можете загрузить модели заранее и включить их из локальных файлов. Примечание. Это требует изменения в вашем metro.config.js. Для получения дополнительной информации см. «Включение модельных файлов в пакет приложения» в readme.md.

 // ...
keyword = { {
  detect : require ( './detect.tflite' ) ,
  encode : require ( './encode.tflite' ) ,
  filter : require ( './filter.tflite' ) ,
  // IMPORTANT: a special extension is used for local metadata JSON files (`.sjson`) when using `require` or `import`
  // so the file is not parsed when included but instead imported as a source object. This makes it so the
  // file is read and parsed by the underlying native libraries instead.
  metadata : require ( './metadata.sjson' )
} }

Конфигурация ключевых слов также принимает поле класса, когда метаданные не указаны.

 // ...
keyword = { {
  detect : require ( './detect.tflite' ) ,
  encode : require ( './encode.tflite' ) ,
  filter : require ( './filter.tflite' ) ,
  classes : [ 'one' , 'two' , 'three]
} }

Определено в

src/spokestacktray.tsx: 221

Минхейт

• Optional Minheight : number (по умолчанию: 170 )

Минимальная высота для подноса

Определено в

src/spokestacktray.tsx: 223

НЛУ

• nlu : NLUConfig

Модель NLU Tensorflow Lite (.tflite), метаданные JSON и словарь NLU (.txt)

Все 3 поля принимают 2 типа значений.

Строка, представляющая удаленный URL, с которого можно загрузить и кэшировать файл (предположительно из CDN).
Исходный объект, полученный по require или import (например, model: require('./nlu.tflite') )

См. Https://spokestack.io/docs/concepts/nlu, чтобы узнать больше о NLU.

 // ...
nlu = { {
  model : 'https://somecdn.com/nlu.tflite' ,
  vocab : 'https://somecdn.com/vocab.txt' ,
  metadata : 'https://somecdn.com/metadata.json'
} }

Вы также можете передать локальные файлы. Примечание. Это требует изменения в вашем metro.config.js. Для получения дополнительной информации см. «Включение модельных файлов в пакет приложения» в readme.md.

 // ...
nlu = { {
  model : require ( './nlu.tflite' ) ,
  vocab : require ( './vocab.txt' ) ,
  // IMPORTANT: a special extension is used for local metadata JSON files (`.sjson`) when using `require` or `import`
  // so the file is not parsed when included but instead imported as a source object. This makes it so the
  // file is read and parsed by the underlying native libraries instead.
  metadata : require ( './metadata.sjson' )
} }

Определено в

src/spokestacktray.tsx: 130

ориентация

• Optional ориентация : "left" | "right" (по умолчанию: "слева" )

Кнопка подноса может быть ориентирована по обе стороны от экрана

Определено в

src/spokestacktray.tsx: 235

PrimaryColor

• Optional PrimaryColor : string (по умолчанию: "#2f5bea" )

Этот цвет используется для тематического подноса и используется в кнопке MIC и речевых пузырьках.

Определено в

src/spokestacktray.tsx: 240

профиль

• Optional профиль : PipelineProfile

Профиль конфигурации Spokestack для прохождения в React-Contive-Spokestack. Они доступны от React-C-Spokestack, начиная с версии 4.0.0.

Если указаны файлы конфигурации WakeWord, по умолчанию будет TFLITE_WAKEWORD_NATIVE_ASR . В противном случае по умолчанию PTT_NATIVE_ASR .

 import SpokestackTray from 'react-native-spokestack-tray'
import { PipelineProfile } from 'react-native-spokestack'

// ...
< SpokestackTray
 profile = { PipelineProfile . TFLITE_WAKEWORD_SPOKESTACK_ASR }
// ...

Определено в

src/spokestacktray.tsx: 261

обновления

• Optional обновления : boolean

Используйте это экономно, чтобы обновить модели WakeWord, Keyword и NLU на устройстве (PIRCE RITE). <SpokestackTray refreshModels={process.env.NODE_ENV !== 'production'} ... />

Определено в

src/spokestacktray.tsx: 268

Saygreeting

• Optional Saygreeting : boolean (по умолчанию: True )

Говорить ли приветствие или отображать только пузырь чата с приветствием, даже если звук включен.

Определено в

src/spokestacktray.tsx: 274

Soundoffimage

• Optional SoundOffImage : ReactNode (по умолчанию: (<image source = {soundoffimage} style = {{width: 30, высота: 30}} />) )

Замените изображение звука, передавая компонент изображения React

Определено в

src/spokestacktray.tsx: 278

Soundonimage

• Optional SoundonImage : ReactNode (по умолчанию: (<Image Source = {soundonimage} style = {{width: 30, высота: 30}} />) )

Замените звук на изображении, передавая компонент изображения React

Определено в

src/spokestacktray.tsx: 276

SpokestackConfig

• Optional SpokestackConfig : Partial SpokestackConfig

Пропустите параметры непосредственно в функцию spokestack.initialize () из React-Con-Spokestack. См. Https://github.com/spokestack/react-native-pokestack для доступных вариантов.

Определено в

src/spokestacktray.tsx: 285

Startheight

• Optional StarTheight : number (по умолчанию: 220 )

Начальная высота для подноса

Определено в

src/spokestacktray.tsx: 287

стиль

Этот стиль опора передается в контейнер для подноса

Определено в

src/spokestacktray.tsx: 289

ttsformat

• Optional TTSFormat : TTSFormat (по умолчанию: ttsformat.text )

Формат текста, переданный в Spokestack.synthesize

Определено в

src/spokestacktray.tsx: 291

голос

• Optional голос : string (по умолчанию: «Демо-мужчина» )

Ключ для голоса в Spokestack TTS, перешел в spokestack.synthesize. Это может быть изменено только в том случае, если вы создали пользовательский голос, используя учетную запись Spokestack Maker. Смотрите https://spokestack.io/pricing#maker. Если не указано, используется бесплатный голос Spokestack «демонстрация».

Определено в

src/spokestacktray.tsx: 298

WakeWord

• Optional WakeWord : WakewordConfig

Модели NLU Tensorflow Lite (.tflite) для WakeWord.

Все 3 поля принимают 2 типа значений.

Строка, представляющая удаленный URL, с которого можно загрузить и кэшировать файл (предположительно из CDN).
Исходный объект, полученный по require или import (например, model: require('./nlu.tflite') )

Смотрите https://spokestack.io/docs/concepts/wakeword-dels, чтобы узнать больше о WakeWord

Spokestack предлагает образцы файлов модели WakeWord ("Spokestack"):

 // ...
wakeword = { {
  detect : 'https://s.spokestack.io/u/hgmYb/detect.tflite' ,
  encode : 'https://s.spokestack.io/u/hgmYb/encode.tflite' ,
  filter : 'https://s.spokestack.io/u/hgmYb/filter.tflite'
} }

Вы также можете загрузить эти модели заранее и включить их из локальных файлов. Примечание. Это требует изменения в вашем metro.config.js. Для получения дополнительной информации см. «Включение модельных файлов в пакет приложения» в readme.md.

 // ...
wakeword = { {
  detect : require ( './detect.tflite' ) ,
  encode : require ( './encode.tflite' ) ,
  filter : require ( './filter.tflite' )
} }

Определено в

src/spokestacktray.tsx: 332

Методы

EditTranscript

▸ Optional EditTranscript ( transcript ): string

Отредактируйте стенограмму перед классификацией и до того, как будет показан пузырь ответа пользователя.

Параметры

Имя	Тип
`transcript`	`string`

Возврат

string

Определено в

src/spokestacktray.tsx: 145

ручка

▸ Handletent ( intent , slots? utterance? ): [IntentResult](#IntentResult)

Эта функция получает намерение от NLU и возвращает объект с уникальным именем узла разговора (которое вы определяете) и подсказкой, которая будет обработана TTS и разговорами.

Примечание. Подсказка отображается только в чате только в том случае, если звук был отключен.

Параметры

Имя	Тип
`intent`	`string`
`slots?`	`SpokestackNLUSlots`
`utterance?`	`string`

Возврат

[IntentResult](#IntentResult)

Определено в

src/spokestacktray.tsx: 91

Onclose

▸ Optional onclose (): void

Вызывается всякий раз, когда лоток закрывается

Возврат

void

Определено в

src/spokestacktray.tsx: 227

Onerror

▸ Optional Onerror ( e ): void

Вызывается всякий раз, когда возникает ошибка в Spokestack

Параметры

Имя	Тип
`e`	`SpokestackErrorEvent`

Возврат

void

Определено в

src/spokestacktray.tsx: 229

OnoPen

▸ Optional OnoPen (): void

Называется всякий раз, когда лоток открылся

Возврат

void

Определено в

src/spokestacktray.tsx: 231

Intentresult

данные

• Optional данные : any

Любые другие данные, которые вы можете добавить

Определено в

src/spokestacktray.tsx: 64

ни nointerrupt

• Optional nointerrupt : boolean

Установите true , чтобы остановить распознаватель WakeWord во время воспроизведения подсказки.

Определено в

src/spokestacktray.tsx: 62

узел

• Узел : string

Пользовательский ключ для указания, где пользователь находится в разговоре, включает это в опору exitNodes , если Spokestack не должен слушать снова после того, как высказывая подсказку.

Определено в

src/spokestacktray.tsx: 55

быстрый

• Приглашение : string

Будет обработана в речь, если лоток не в тихой режиме

Определено в

src/spokestacktray.tsx: 57

`<SpokestackTray />` методы компонентов

Эти методы доступны в компоненте Spokestacktray. Используйте React Ref для доступа к этим методам.

 const spokestackTray = useRef ( null )

  // ...
  < SpokestackTray ref = { spokestackTray }

// ...
spokestackTray . current . say ( 'Here is something for Spokestack to say' )

Примечание . В большинстве случаев вы должны позвонить listen вместо open .

открыть

▸ Open (): void

Откройте поднос, приветствуйте (если применимо) и послушайте

Возврат

void

Определено в

src/spokestacktray.tsx: 743

закрывать

▸ Close (): void

Закройте поднос, перестаньте слушать и перезапустите WakeWord

Возврат

void

Определено в

src/spokestacktray.tsx: 754

сказать

▸ Скажите ( input ): Promise void

Передает вход в spokestack.synthesize (), играет аудио и добавляет речевой пузырь.

Параметры

Имя	Тип
`input`	`string`

Возврат

Promise void

Определено в

src/spokestacktray.tsx: 766

addbubble

▸ addbubble ( bubble ): void

Добавить пузырь (система или пользователь) в интерфейс чата

Параметры

Имя	Тип
`bubble`	`Bubble`

Возврат

void

Определено в

src/spokestacktray.tsx: 799

Пузырь

остров

• Остров : boolean

Определено в

SRC/Components/Speechbubs.tsx: 9

текст

• Текст : string

Определено в

SRC/Components/Speechbubs.tsx: 8

ToggleSilent

▸ ToggleSilent (): Promise boolean

Переключить молчаливый режим

Возврат

Promise boolean

Определено в

src/spokestacktray.tsx: 816

Issilent

▸ issilent (): boolean

Возвращает, находится ли поднос в безмолвом режиме

Возврат

boolean

Определено в

src/spokestacktray.tsx: 828

Функции Spokestack

Эти функции доступны в качестве экспорта из дрейва с реагирующим явлением

слушать

▸ Слушай (): Promise void

Сообщает речевому трубопроводу Spokestack, чтобы начать слушать. Также запрашивает разрешение на прослушивание при необходимости. Он попытается запустить трубопровод, прежде чем активировать, если он еще не начнется. Эта функция ничего не сделает, если приложение находится в фоновом режиме.

 import { listen } from 'react-native-spokestack-tray'
try {
  await listen()
} catch (error) {
  console.error(error)
}

Возврат

Promise void

Определено в

src/spokestack.ts: 21

остановка списка

▸ Stoplistening (): Promise void

Возврат

Promise void

Определено в

src/spokestack.ts: 30

ИСПРАВЛЕНИЕ

▸ Const islistening (): Promise boolean

Возвращает, слушает ли Spokestack в настоящее время

 console . log ( `isListening: ${ await isListening ( ) } ` )

Возврат

Promise boolean

Определено в

src/index.ts: 19

Изинициализован

▸ Const isInitialized (): Promise boolean

Возвращает, был ли Spokestack инициализирован

 console . log ( `isInitialized: ${ await isInitialized ( ) } ` )

Возврат

Promise boolean

Определено в

src/index.ts: 27

Isstarted

▸ Const Isstarted (): Promise boolean

Возвращает, был ли начатый речевой трубопровод

 console . log ( `isStarted: ${ await isStarted ( ) } ` )

Возврат

Promise boolean

Определено в

src/index.ts: 35

addEventListener

▸ Const addEventListener ( eventType , listener , context? ): EmitterSubscription

Приведите к любому событию, испускаемому нативными библиотеками. События: «распознавать», «partial_recognize», «ошибка», «активировать», «деактивировать» и «тайм -аут». Смотрите дно readme.md для описания событий.

 useEffect ( ( ) => {
  const listener = addEventListener ( 'recognize' , onRecognize )
  // Unsubscribe by calling remove when components are unmounted
  return ( ) => {
    listener . remove ( )
  }
} , [ ] )

Параметры

Имя	Тип
`eventType`	`string`
`listener`	( `event` : `any` ) => `void`
`context?`	`Object`

Возврат

EmitterSubscription

Определено в

src/index.ts: 51

Удалить EventListener

▸ Const RemoveEventListener ( eventType , listener ): void

Удалить слушателя событий

 removeEventListener ( 'recognize' , onRecognize )

Параметры

Имя	Тип
`eventType`	`string`
`listener`	(... `args` : `any` []) => `any`

Возврат

void

Определено в

src/index.ts: 59

Removealllisteners

▸ Const removealllisteners (): void

Удалить любых существующих слушателей

 componentWillUnmount ( ) {
  removeAllListeners ( )
}

Возврат

void

Определено в

src/index.ts: 69

События

Используйте addEventListener() , removeEventListener() и removeAllListeners() чтобы добавить и удалить обработчики событий. Все события доступны как в iOS, так и в Android.

Имя	Данные	Описание
распознавать	`{ transcript: string }`	Уволен всякий раз, когда распознавание речи успешно завершается.
partial_recognize	`{ transcript: string }`	Уволен всякий раз, когда транскрипт меняется во время распознавания речи.
начинать	`null`	Уволен, когда начинается речевой трубопровод (который начинает слушать WakeWord или начинает VAD).
останавливаться	`null`	Уволен, когда речевой трубопровод останавливается.
активировать	`null`	Выстрелил, когда речевой трубопровод активируется либо через VAD, WakeWord, либо при вызове `.activate()` .
деактивировать	`null`	Уволен, когда речевой трубопровод деактивирует.
играть	`{ playing: boolean }`	Уволен, когда воспроизведение TTS начинается и останавливается. Смотрите функцию `speak()` .
тайм -аут	`null`	Выстрелил, когда активный трубопровод выходит из -за отсутствия признания.
след	`{ message: string }`	Уволен для следов сообщений. Морская способность определяется опцией `traceLevel` .
ошибка	`{ error: string }`	Уволен, когда в Spokestack возникает ошибка.

Когда событие ошибки запускается, любые существующие обещания отклоняются.

Проверка разрешений на речь

Эти коммунальные функции используются Spokestack для проверки разрешения микрофона на iOS и Android и разрешении на распознавание речи на iOS.

CheckSpeech

▸ CheckSpeech (): Promise boolean

Эта функция может быть использована для проверки того, дал ли пользователь необходимое разрешение на речь. На iOS это включает в себя как микрофон, так и речевую речь. На Android необходим только микрофон.

 import { checkSpeech } from 'react-native-spokestack-tray'

// ...

const hasPermission = await checkSpeech ( )

Возврат

Promise boolean

Определено в

src/utils/permissions.ts: 78

requestSpeech

▸ requestSpeech (): Promise boolean

Эта функция может быть использована для фактического запроса необходимого разрешения для речи. На iOS это включает в себя как микрофон, так и речевую речь. На Android необходим только микрофон.

Примечание. Если пользователь отказался в прошлом на iOS, пользователь должен быть отправлен в настройки.

 import { requestSpeech } from 'react-native-spokestack-tray'

// ...

const hasPermission = await requestSpeech ( )

Возврат

Promise boolean

Определено в

src/utils/permissions.ts: 106

Лицензия

Грань

Расширять

react native spokestack tray

Установка

Каждая зависимость от его использования.

Установка iOS

Установите цель развертывания

Удалить неверный путь поиска библиотеки

Редактировать Podfile

Реактивные капсулы

Ошибка в React Native 0,64,0 (должна быть зафиксирована в 0,64,1)

POD установка

Редактировать info.plist

Удалить флиппер

Редактировать Appdelegate.m

Добавить AvFoundation в импорт

Категория Audiosession

Установка Android

Поддержка ASR

Редактировать root build.gradle ( не приложение/build.gradle)

Редактировать Androidmanifest.xml

Использование

Включая модельные файлы в пакет приложения

Внося

Документация

<SpokestackTray /> props компонента

путовиза

Определено в

ClientId

Определено в

Clientsecret

Определено в

закрытый

Определено в

отлаживать

Определено в

продолжительность

Определено в

ослабление

Определено в

выходящие

Определено в

Фонфимилия

Определено в

GradientColors

Определено в

приветствовать

Определено в

гаптик

Определено в

ключевое слово

Определено в

Минхейт

Определено в

НЛУ

Определено в

ориентация

Определено в

PrimaryColor

Определено в

профиль

Определено в

обновления

Определено в

Saygreeting

Определено в

Soundoffimage

Определено в

Soundonimage

Определено в

SpokestackConfig

Определено в

Startheight

Определено в

стиль

Определено в

ttsformat

Определено в

голос

Определено в

WakeWord

Определено в

`<SpokestackTray />` props компонента

`<SpokestackTray />` методы компонентов