├── client-test
├── .gitignore
├── README.md
├── src
│ ├── main
│ │ ├── res
│ │ │ ├── values
│ │ │ │ ├── dimens.xml
│ │ │ │ ├── strings.xml
│ │ │ │ ├── colors.xml
│ │ │ │ └── themes.xml
│ │ │ ├── drawable
│ │ │ │ ├── logo_go.png
│ │ │ │ ├── logo_python.png
│ │ │ │ ├── logo_typescript.png
│ │ │ │ ├── mic.xml
│ │ │ │ ├── ic_mic.xml
│ │ │ │ ├── fork.xml
│ │ │ │ ├── ic_start.xml
│ │ │ │ ├── star.xml
│ │ │ │ ├── eye.xml
│ │ │ │ └── ic_micframe.xml
│ │ │ ├── mipmap-hdpi
│ │ │ │ ├── ic_launcher.png
│ │ │ │ └── ic_launcher_round.png
│ │ │ ├── mipmap-mdpi
│ │ │ │ ├── ic_launcher.png
│ │ │ │ └── ic_launcher_round.png
│ │ │ ├── mipmap-xhdpi
│ │ │ │ ├── ic_launcher.png
│ │ │ │ └── ic_launcher_round.png
│ │ │ ├── mipmap-xxhdpi
│ │ │ │ ├── ic_launcher.png
│ │ │ │ └── ic_launcher_round.png
│ │ │ ├── mipmap-xxxhdpi
│ │ │ │ ├── ic_launcher.png
│ │ │ │ └── ic_launcher_round.png
│ │ │ ├── mipmap-anydpi-v26
│ │ │ │ ├── ic_launcher.xml
│ │ │ │ └── ic_launcher_round.xml
│ │ │ ├── values-night
│ │ │ │ └── themes.xml
│ │ │ ├── layout
│ │ │ │ └── activity_main.xml
│ │ │ └── drawable-v24
│ │ │ │ └── ic_launcher_foreground.xml
│ │ ├── kotlin
│ │ │ └── com
│ │ │ │ └── speechly
│ │ │ │ └── clienttest
│ │ │ │ ├── Repo.kt
│ │ │ │ └── RepoRecyclerAdapter.kt
│ │ └── AndroidManifest.xml
│ ├── test
│ │ └── java
│ │ │ └── com
│ │ │ └── speechly
│ │ │ └── clienttest
│ │ │ └── ExampleUnitTest.kt
│ └── androidTest
│ │ └── java
│ │ └── com
│ │ └── speechly
│ │ └── clienttest
│ │ └── ExampleInstrumentedTest.kt
├── proguard-rules.pro
├── gradle.properties
└── build.gradle
├── android-client
├── consumer-rules.pro
├── gradle.properties
├── README.md
├── src
│ └── main
│ │ ├── AndroidManifest.xml
│ │ ├── res
│ │ └── drawable
│ │ │ ├── ic_mic.xml
│ │ │ ├── ic_start.xml
│ │ │ └── ic_micframe.xml
│ │ └── kotlin
│ │ └── com
│ │ └── speechly
│ │ ├── client
│ │ ├── grpc
│ │ │ └── channel.kt
│ │ ├── slu
│ │ │ ├── Segment.kt
│ │ │ └── SluClient.kt
│ │ ├── device
│ │ │ └── DeviceIdProvider.kt
│ │ ├── cache
│ │ │ └── CacheService.kt
│ │ └── identity
│ │ │ └── IdentityClient.kt
│ │ └── ui
│ │ └── SpeechlyButton.kt
└── proguard-rules.pro
├── settings.gradle
├── gradle.properties
├── gradle
└── wrapper
│ ├── gradle-wrapper.jar
│ └── gradle-wrapper.properties
├── docs
└── client
│ ├── package-list
│ ├── com.speechly.client.slu
│ ├── -segment
│ │ ├── finalize.md
│ │ ├── intent.md
│ │ ├── update-entity.md
│ │ ├── update-intent.md
│ │ ├── segment-id.md
│ │ ├── update-transcript.md
│ │ ├── context-id.md
│ │ ├── is-final.md
│ │ ├── get-entity-by-type.md
│ │ ├── -segment.md
│ │ ├── update-entities.md
│ │ ├── words.md
│ │ ├── entities.md
│ │ └── update-transcripts.md
│ ├── -grpc-slu-client
│ │ ├── close.md
│ │ ├── -grpc-slu-client.md
│ │ ├── -companion
│ │ │ ├── for-target.md
│ │ │ └── index.md
│ │ └── stream.md
│ ├── -transcript
│ │ ├── word.md
│ │ ├── component3.md
│ │ ├── component2.md
│ │ ├── segment-id.md
│ │ ├── component1.md
│ │ ├── context-id.md
│ │ ├── copy.md
│ │ ├── -transcript.md
│ │ └── -companion
│ │ │ ├── from-slu-reponse.md
│ │ │ └── from-slu-transcript.md
│ ├── -entity
│ │ ├── type.md
│ │ ├── value.md
│ │ ├── is-final.md
│ │ ├── component2.md
│ │ ├── component4.md
│ │ ├── component5.md
│ │ ├── end-position.md
│ │ ├── segment-id.md
│ │ ├── component1.md
│ │ ├── component3.md
│ │ ├── component6.md
│ │ ├── component7.md
│ │ ├── context-id.md
│ │ ├── start-position.md
│ │ ├── -companion
│ │ │ ├── from-slu-reponse.md
│ │ │ └── from-slu-entity.md
│ │ ├── -entity.md
│ │ └── copy.md
│ ├── -grpc-slu-stream
│ │ ├── close.md
│ │ ├── response-flow.md
│ │ └── -grpc-slu-stream.md
│ ├── -intent
│ │ ├── intent.md
│ │ ├── is-final.md
│ │ ├── component2.md
│ │ ├── segment-id.md
│ │ ├── component1.md
│ │ ├── component3.md
│ │ ├── component4.md
│ │ ├── context-id.md
│ │ ├── -companion
│ │ │ ├── from-slu-reponse.md
│ │ │ └── index.md
│ │ ├── -intent.md
│ │ └── copy.md
│ ├── -stream-config
│ │ ├── component3.md
│ │ ├── component1.md
│ │ ├── component2.md
│ │ ├── -language-code
│ │ │ ├── -e-n_-u-s
│ │ │ │ ├── name.md
│ │ │ │ ├── ordinal.md
│ │ │ │ └── string-value.md
│ │ │ ├── -f-i_-f-i
│ │ │ │ ├── name.md
│ │ │ │ ├── ordinal.md
│ │ │ │ └── string-value.md
│ │ │ └── string-value.md
│ │ ├── copy.md
│ │ ├── language-code.md
│ │ ├── sample-rate-hertz.md
│ │ ├── channel-count.md
│ │ └── -stream-config.md
│ ├── -response
│ │ ├── segment-id.md
│ │ └── context-id.md
│ ├── -word
│ │ ├── component2.md
│ │ ├── component3.md
│ │ ├── component4.md
│ │ ├── component1.md
│ │ ├── component5.md
│ │ ├── value.md
│ │ ├── --index--.md
│ │ ├── is-final.md
│ │ ├── end-timestamp.md
│ │ ├── start-timestamp.md
│ │ ├── -word.md
│ │ └── copy.md
│ ├── -stream-closed-exception
│ │ └── -stream-closed-exception.md
│ ├── -slu-client
│ │ └── stream.md
│ └── -slu-stream
│ │ └── index.md
│ ├── com.speechly.client.speech
│ ├── -client
│ │ ├── close.md
│ │ ├── entity-cb.md
│ │ ├── intent-cb.md
│ │ ├── transcript-cb.md
│ │ ├── segment-change-cb.md
│ │ ├── stop-context.md
│ │ ├── tentative-intent-cb.md
│ │ ├── start-context.md
│ │ ├── tentative-entities-cb.md
│ │ ├── tentative-transcript-cb.md
│ │ ├── -client.md
│ │ ├── -companion
│ │ │ └── from-activity.md
│ │ ├── on-entity.md
│ │ ├── on-intent.md
│ │ ├── on-transcript.md
│ │ ├── on-segment-change.md
│ │ ├── on-tentative-intent.md
│ │ ├── on-tentative-entities.md
│ │ └── on-tentative-transcript.md
│ ├── -audio-recorder
│ │ ├── close.md
│ │ ├── build-recorder.md
│ │ ├── stop-recording.md
│ │ ├── buffer-size.md
│ │ ├── sample-rate.md
│ │ ├── channel-mask.md
│ │ ├── activity.md
│ │ ├── start-recording.md
│ │ ├── -audio-recorder.md
│ │ └── request-permission-launcher.md
│ ├── -no-active-stream-exception
│ │ └── -no-active-stream-exception.md
│ ├── -api-client
│ │ ├── start-context.md
│ │ ├── stop-context.md
│ │ ├── on-entity.md
│ │ ├── on-intent.md
│ │ ├── on-transcript.md
│ │ ├── on-segment-change.md
│ │ ├── on-tentative-intent.md
│ │ ├── on-tentative-entities.md
│ │ └── on-tentative-transcript.md
│ └── index.md
│ ├── com.speechly.ui
│ ├── -speechly-button
│ │ ├── scale-up.md
│ │ ├── scale-down.md
│ │ ├── listener.md
│ │ ├── set-on-touch-listener.md
│ │ ├── listen-for-touch.md
│ │ └── -speechly-button.md
│ └── index.md
│ ├── com.speechly.client.identity
│ ├── -grpc-identity-client
│ │ ├── close.md
│ │ ├── login.md
│ │ ├── -grpc-identity-client.md
│ │ └── -companion
│ │ │ ├── for-target.md
│ │ │ └── index.md
│ ├── -basic-identity-service
│ │ ├── close.md
│ │ ├── -basic-identity-service.md
│ │ ├── authenticate.md
│ │ └── -companion
│ │ │ ├── for-target.md
│ │ │ └── index.md
│ ├── -caching-identity-service
│ │ ├── close.md
│ │ ├── cache-service.md
│ │ ├── -caching-identity-service.md
│ │ ├── authenticate.md
│ │ └── -companion
│ │ │ ├── for-target.md
│ │ │ └── index.md
│ ├── -auth-token
│ │ ├── component1.md
│ │ ├── component2.md
│ │ ├── component3.md
│ │ ├── component5.md
│ │ ├── -auth-scope
│ │ │ ├── -s-l-u
│ │ │ │ ├── name.md
│ │ │ │ └── ordinal.md
│ │ │ └── -w-l-u
│ │ │ │ ├── name.md
│ │ │ │ └── ordinal.md
│ │ ├── component4.md
│ │ ├── app-id.md
│ │ ├── expires-at.md
│ │ ├── device-id.md
│ │ ├── copy.md
│ │ ├── token-string.md
│ │ ├── auth-scopes.md
│ │ ├── -companion
│ │ │ ├── from-j-w-t.md
│ │ │ └── index.md
│ │ ├── validate-expiry.md
│ │ └── validate.md
│ ├── -authentication-exception
│ │ └── -authentication-exception.md
│ ├── -invalid-application-exception
│ │ └── -invalid-application-exception.md
│ ├── -invalid-j-w-t-exception
│ │ └── -invalid-j-w-t-exception.md
│ ├── -identity-client
│ │ └── login.md
│ └── -identity-service
│ │ └── authenticate.md
│ ├── com.speechly.client.device
│ ├── -random-id-provider
│ │ ├── -random-id-provider.md
│ │ └── get-device-id.md
│ ├── -caching-id-provider
│ │ ├── cache-service.md
│ │ ├── -caching-id-provider.md
│ │ └── get-device-id.md
│ ├── -device-id-provider
│ │ └── get-device-id.md
│ └── index.md
│ ├── com.speechly.client.cache
│ ├── -shared-preferences-cache
│ │ ├── -shared-preferences-cache.md
│ │ ├── -companion
│ │ │ ├── -p-r-e-f-e-r-e-n-c-e_-f-i-l-e_-k-e-y.md
│ │ │ └── from-context.md
│ │ ├── load-string.md
│ │ └── store-string.md
│ ├── -cache-service
│ │ ├── load-string.md
│ │ └── store-string.md
│ └── index.md
│ └── README.md
├── .gitignore
├── LICENSE
└── .github
└── workflows
└── publish.yml
/client-test/.gitignore:
--------------------------------------------------------------------------------
1 | /build
--------------------------------------------------------------------------------
/android-client/consumer-rules.pro:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/client-test/README.md:
--------------------------------------------------------------------------------
1 | # Android client example app
2 |
--------------------------------------------------------------------------------
/settings.gradle:
--------------------------------------------------------------------------------
1 | include ':client-test', ':android-client'
2 |
--------------------------------------------------------------------------------
/gradle.properties:
--------------------------------------------------------------------------------
1 | android.useAndroidX=true
2 | android.enableJetifier=true
3 |
--------------------------------------------------------------------------------
/android-client/gradle.properties:
--------------------------------------------------------------------------------
1 | android.useAndroidX=true
2 | android.enableJetifier=true
3 |
--------------------------------------------------------------------------------
/client-test/src/main/res/values/dimens.xml:
--------------------------------------------------------------------------------
1 |
2 | 32dp
3 |
--------------------------------------------------------------------------------
/client-test/src/main/res/values/strings.xml:
--------------------------------------------------------------------------------
1 |
2 | client-test
3 |
--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.jar:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/speechly/android-client/HEAD/gradle/wrapper/gradle-wrapper.jar
--------------------------------------------------------------------------------
/client-test/src/main/res/drawable/logo_go.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/speechly/android-client/HEAD/client-test/src/main/res/drawable/logo_go.png
--------------------------------------------------------------------------------
/client-test/src/main/res/drawable/logo_python.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/speechly/android-client/HEAD/client-test/src/main/res/drawable/logo_python.png
--------------------------------------------------------------------------------
/client-test/src/main/res/mipmap-hdpi/ic_launcher.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/speechly/android-client/HEAD/client-test/src/main/res/mipmap-hdpi/ic_launcher.png
--------------------------------------------------------------------------------
/client-test/src/main/res/mipmap-mdpi/ic_launcher.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/speechly/android-client/HEAD/client-test/src/main/res/mipmap-mdpi/ic_launcher.png
--------------------------------------------------------------------------------
/client-test/src/main/res/drawable/logo_typescript.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/speechly/android-client/HEAD/client-test/src/main/res/drawable/logo_typescript.png
--------------------------------------------------------------------------------
/client-test/src/main/res/mipmap-xhdpi/ic_launcher.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/speechly/android-client/HEAD/client-test/src/main/res/mipmap-xhdpi/ic_launcher.png
--------------------------------------------------------------------------------
/client-test/src/main/res/mipmap-xxhdpi/ic_launcher.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/speechly/android-client/HEAD/client-test/src/main/res/mipmap-xxhdpi/ic_launcher.png
--------------------------------------------------------------------------------
/client-test/src/main/res/mipmap-xxxhdpi/ic_launcher.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/speechly/android-client/HEAD/client-test/src/main/res/mipmap-xxxhdpi/ic_launcher.png
--------------------------------------------------------------------------------
/client-test/src/main/res/mipmap-hdpi/ic_launcher_round.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/speechly/android-client/HEAD/client-test/src/main/res/mipmap-hdpi/ic_launcher_round.png
--------------------------------------------------------------------------------
/client-test/src/main/res/mipmap-mdpi/ic_launcher_round.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/speechly/android-client/HEAD/client-test/src/main/res/mipmap-mdpi/ic_launcher_round.png
--------------------------------------------------------------------------------
/client-test/src/main/res/mipmap-xhdpi/ic_launcher_round.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/speechly/android-client/HEAD/client-test/src/main/res/mipmap-xhdpi/ic_launcher_round.png
--------------------------------------------------------------------------------
/client-test/src/main/res/mipmap-xxhdpi/ic_launcher_round.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/speechly/android-client/HEAD/client-test/src/main/res/mipmap-xxhdpi/ic_launcher_round.png
--------------------------------------------------------------------------------
/client-test/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/speechly/android-client/HEAD/client-test/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png
--------------------------------------------------------------------------------
/android-client/README.md:
--------------------------------------------------------------------------------
1 | ### Building the project
2 |
3 | ## Publish
4 | ```shell script
5 | ./gradlew publishReleasePublicationToSonatypeRepository --max-workers 1 closeAndReleaseSonatypeStagingRepository
6 | ```
--------------------------------------------------------------------------------
/docs/client/package-list:
--------------------------------------------------------------------------------
1 | $dokka.format:gfm-v1
2 | $dokka.linkExtension:md
3 |
4 | com.speechly.client.cache
5 | com.speechly.client.device
6 | com.speechly.client.identity
7 | com.speechly.client.slu
8 | com.speechly.client.speech
9 | com.speechly.ui
10 |
11 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Ignore Gradle project-specific cache directory
2 | .gradle
3 |
4 | # Ignore Gradle build output directory
5 | build
6 |
7 | # Github publishing credentials
8 | github.properties
9 |
10 | # Local properties
11 | local.properties
12 |
13 | .idea
14 | .DS_Store
--------------------------------------------------------------------------------
/android-client/src/main/AndroidManifest.xml:
--------------------------------------------------------------------------------
1 |
2 |
4 |
5 |
6 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-segment/finalize.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Segment](index.md)/[finalize](finalize.md)
2 |
3 |
4 |
5 | # finalize
6 | [androidJvm]
7 | Content
8 | fun [finalize](finalize.md)()
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.speech/-client/close.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.speech](../index.md)/[Client](index.md)/[close](close.md)
2 |
3 |
4 |
5 | # close
6 | [androidJvm]
7 | Content
8 | open override fun [close](close.md)()
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.ui/-speechly-button/scale-up.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.ui](../index.md)/[SpeechlyButton](index.md)/[scaleUp](scale-up.md)
2 |
3 |
4 |
5 | # scaleUp
6 | [androidJvm]
7 | Content
8 | fun [scaleUp](scale-up.md)()
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.properties:
--------------------------------------------------------------------------------
1 | #Thu Feb 04 21:59:41 EET 2021
2 | distributionBase=GRADLE_USER_HOME
3 | distributionPath=wrapper/dists
4 | zipStoreBase=GRADLE_USER_HOME
5 | zipStorePath=wrapper/dists
6 | distributionUrl=https\://services.gradle.org/distributions/gradle-7.3.3-all.zip
7 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.speech/-audio-recorder/close.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.speech](../index.md)/[AudioRecorder](index.md)/[close](close.md)
2 |
3 |
4 |
5 | # close
6 | [androidJvm]
7 | Content
8 | fun [close](close.md)()
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-grpc-slu-client/close.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[GrpcSluClient](index.md)/[close](close.md)
2 |
3 |
4 |
5 | # close
6 | [androidJvm]
7 | Content
8 | open override fun [close](close.md)()
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-transcript/word.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Transcript](index.md)/[word](word.md)
2 |
3 |
4 |
5 | # word
6 | [androidJvm]
7 | Content
8 | val [word](word.md): [Word](../-word/index.md)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.ui/-speechly-button/scale-down.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.ui](../index.md)/[SpeechlyButton](index.md)/[scaleDown](scale-down.md)
2 |
3 |
4 |
5 | # scaleDown
6 | [androidJvm]
7 | Content
8 | fun [scaleDown](scale-down.md)()
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-segment/intent.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Segment](index.md)/[intent](intent.md)
2 |
3 |
4 |
5 | # intent
6 | [androidJvm]
7 | Content
8 | var [intent](intent.md): [Intent](../-intent/index.md)? = null
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.identity/-grpc-identity-client/close.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.identity](../index.md)/[GrpcIdentityClient](index.md)/[close](close.md)
2 |
3 |
4 |
5 | # close
6 | [androidJvm]
7 | Content
8 | open override fun [close](close.md)()
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.identity/-basic-identity-service/close.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.identity](../index.md)/[BasicIdentityService](index.md)/[close](close.md)
2 |
3 |
4 |
5 | # close
6 | [androidJvm]
7 | Content
8 | open override fun [close](close.md)()
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.identity/-caching-identity-service/close.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.identity](../index.md)/[CachingIdentityService](index.md)/[close](close.md)
2 |
3 |
4 |
5 | # close
6 | [androidJvm]
7 | Content
8 | open override fun [close](close.md)()
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/client-test/src/main/res/mipmap-anydpi-v26/ic_launcher.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
--------------------------------------------------------------------------------
/client-test/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-entity/type.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Entity](index.md)/[type](type.md)
2 |
3 |
4 |
5 | # type
6 | [androidJvm]
7 | Content
8 | val [type](type.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-grpc-slu-stream/close.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[GrpcSluStream](index.md)/[close](close.md)
2 |
3 |
4 |
5 | # close
6 | [androidJvm]
7 | Content
8 | @ExperimentalCoroutinesApi()
9 |
10 | open override fun [close](close.md)()
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-transcript/component3.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Transcript](index.md)/[component3](component3.md)
2 |
3 |
4 |
5 | # component3
6 | [androidJvm]
7 | Content
8 | operator fun [component3](component3.md)(): [Word](../-word/index.md)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.speech/-audio-recorder/build-recorder.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.speech](../index.md)/[AudioRecorder](index.md)/[buildRecorder](build-recorder.md)
2 |
3 |
4 |
5 | # buildRecorder
6 | [androidJvm]
7 | Content
8 | fun [buildRecorder](build-recorder.md)()
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.speech/-audio-recorder/stop-recording.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.speech](../index.md)/[AudioRecorder](index.md)/[stopRecording](stop-recording.md)
2 |
3 |
4 |
5 | # stopRecording
6 | [androidJvm]
7 | Content
8 | fun [stopRecording](stop-recording.md)()
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-entity/value.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Entity](index.md)/[value](value.md)
2 |
3 |
4 |
5 | # value
6 | [androidJvm]
7 | Content
8 | val [value](value.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-segment/update-entity.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Segment](index.md)/[updateEntity](update-entity.md)
2 |
3 |
4 |
5 | # updateEntity
6 | [androidJvm]
7 | Content
8 | fun [updateEntity](update-entity.md)(entity: [Entity](../-entity/index.md))
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-segment/update-intent.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Segment](index.md)/[updateIntent](update-intent.md)
2 |
3 |
4 |
5 | # updateIntent
6 | [androidJvm]
7 | Content
8 | fun [updateIntent](update-intent.md)(intent: [Intent](../-intent/index.md))
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-grpc-slu-stream/response-flow.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[GrpcSluStream](index.md)/[responseFlow](response-flow.md)
2 |
3 |
4 |
5 | # responseFlow
6 | [androidJvm]
7 | Content
8 | var [responseFlow](response-flow.md): Flow? = null
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-intent/intent.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Intent](index.md)/[intent](intent.md)
2 |
3 |
4 |
5 | # intent
6 | [androidJvm]
7 | Content
8 | var [intent](intent.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-entity/is-final.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Entity](index.md)/[isFinal](is-final.md)
2 |
3 |
4 |
5 | # isFinal
6 | [androidJvm]
7 | Content
8 | val [isFinal](is-final.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-intent/is-final.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Intent](index.md)/[isFinal](is-final.md)
2 |
3 |
4 |
5 | # isFinal
6 | [androidJvm]
7 | Content
8 | var [isFinal](is-final.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.device/-random-id-provider/-random-id-provider.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.device](../index.md)/[RandomIdProvider](index.md)/[RandomIdProvider](-random-id-provider.md)
2 |
3 |
4 |
5 | # RandomIdProvider
6 | [androidJvm]
7 | Content
8 | fun [RandomIdProvider](-random-id-provider.md)()
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-segment/segment-id.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Segment](index.md)/[segmentId](segment-id.md)
2 |
3 |
4 |
5 | # segmentId
6 | [androidJvm]
7 | Content
8 | val [segmentId](segment-id.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-segment/update-transcript.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Segment](index.md)/[updateTranscript](update-transcript.md)
2 |
3 |
4 |
5 | # updateTranscript
6 | [androidJvm]
7 | Content
8 | fun [updateTranscript](update-transcript.md)(word: [Word](../-word/index.md))
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-segment/context-id.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Segment](index.md)/[contextId](context-id.md)
2 |
3 |
4 |
5 | # contextId
6 | [androidJvm]
7 | Content
8 | val [contextId](context-id.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-segment/is-final.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Segment](index.md)/[isFinal](is-final.md)
2 |
3 |
4 |
5 | # isFinal
6 | [androidJvm]
7 | Content
8 | var [isFinal](is-final.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-stream-config/component3.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[StreamConfig](index.md)/[component3](component3.md)
2 |
3 |
4 |
5 | # component3
6 | [androidJvm]
7 | Content
8 | operator fun [component3](component3.md)(): [StreamConfig.LanguageCode](-language-code/index.md)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-entity/component2.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Entity](index.md)/[component2](component2.md)
2 |
3 |
4 |
5 | # component2
6 | [androidJvm]
7 | Content
8 | operator fun [component2](component2.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-entity/component4.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Entity](index.md)/[component4](component4.md)
2 |
3 |
4 |
5 | # component4
6 | [androidJvm]
7 | Content
8 | operator fun [component4](component4.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-entity/component5.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Entity](index.md)/[component5](component5.md)
2 |
3 |
4 |
5 | # component5
6 | [androidJvm]
7 | Content
8 | operator fun [component5](component5.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-entity/end-position.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Entity](index.md)/[endPosition](end-position.md)
2 |
3 |
4 |
5 | # endPosition
6 | [androidJvm]
7 | Content
8 | val [endPosition](end-position.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-entity/segment-id.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Entity](index.md)/[segmentId](segment-id.md)
2 |
3 |
4 |
5 | # segmentId
6 | [androidJvm]
7 | Content
8 | open override val [segmentId](segment-id.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-intent/component2.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Intent](index.md)/[component2](component2.md)
2 |
3 |
4 |
5 | # component2
6 | [androidJvm]
7 | Content
8 | operator fun [component2](component2.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-intent/segment-id.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Intent](index.md)/[segmentId](segment-id.md)
2 |
3 |
4 |
5 | # segmentId
6 | [androidJvm]
7 | Content
8 | open override val [segmentId](segment-id.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-response/segment-id.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Response](index.md)/[segmentId](segment-id.md)
2 |
3 |
4 |
5 | # segmentId
6 | [androidJvm]
7 | Content
8 | abstract val [segmentId](segment-id.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-word/component2.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Word](index.md)/[component2](component2.md)
2 |
3 |
4 |
5 | # component2
6 | [androidJvm]
7 | Content
8 | operator fun [component2](component2.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-word/component3.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Word](index.md)/[component3](component3.md)
2 |
3 |
4 |
5 | # component3
6 | [androidJvm]
7 | Content
8 | operator fun [component3](component3.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-word/component4.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Word](index.md)/[component4](component4.md)
2 |
3 |
4 |
5 | # component4
6 | [androidJvm]
7 | Content
8 | operator fun [component4](component4.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-response/context-id.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Response](index.md)/[contextId](context-id.md)
2 |
3 |
4 |
5 | # contextId
6 | [androidJvm]
7 | Content
8 | abstract val [contextId](context-id.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-word/component1.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Word](index.md)/[component1](component1.md)
2 |
3 |
4 |
5 | # component1
6 | [androidJvm]
7 | Content
8 | operator fun [component1](component1.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-word/component5.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Word](index.md)/[component5](component5.md)
2 |
3 |
4 |
5 | # component5
6 | [androidJvm]
7 | Content
8 | operator fun [component5](component5.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-entity/component1.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Entity](index.md)/[component1](component1.md)
2 |
3 |
4 |
5 | # component1
6 | [androidJvm]
7 | Content
8 | operator fun [component1](component1.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-entity/component3.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Entity](index.md)/[component3](component3.md)
2 |
3 |
4 |
5 | # component3
6 | [androidJvm]
7 | Content
8 | operator fun [component3](component3.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-entity/component6.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Entity](index.md)/[component6](component6.md)
2 |
3 |
4 |
5 | # component6
6 | [androidJvm]
7 | Content
8 | operator fun [component6](component6.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-entity/component7.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Entity](index.md)/[component7](component7.md)
2 |
3 |
4 |
5 | # component7
6 | [androidJvm]
7 | Content
8 | operator fun [component7](component7.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-entity/context-id.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Entity](index.md)/[contextId](context-id.md)
2 |
3 |
4 |
5 | # contextId
6 | [androidJvm]
7 | Content
8 | open override val [contextId](context-id.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-entity/start-position.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Entity](index.md)/[startPosition](start-position.md)
2 |
3 |
4 |
5 | # startPosition
6 | [androidJvm]
7 | Content
8 | val [startPosition](start-position.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-intent/component1.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Intent](index.md)/[component1](component1.md)
2 |
3 |
4 |
5 | # component1
6 | [androidJvm]
7 | Content
8 | operator fun [component1](component1.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-intent/component3.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Intent](index.md)/[component3](component3.md)
2 |
3 |
4 |
5 | # component3
6 | [androidJvm]
7 | Content
8 | operator fun [component3](component3.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-intent/component4.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Intent](index.md)/[component4](component4.md)
2 |
3 |
4 |
5 | # component4
6 | [androidJvm]
7 | Content
8 | operator fun [component4](component4.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-intent/context-id.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Intent](index.md)/[contextId](context-id.md)
2 |
3 |
4 |
5 | # contextId
6 | [androidJvm]
7 | Content
8 | open override val [contextId](context-id.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-transcript/component2.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Transcript](index.md)/[component2](component2.md)
2 |
3 |
4 |
5 | # component2
6 | [androidJvm]
7 | Content
8 | operator fun [component2](component2.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-transcript/segment-id.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Transcript](index.md)/[segmentId](segment-id.md)
2 |
3 |
4 |
5 | # segmentId
6 | [androidJvm]
7 | Content
8 | open override val [segmentId](segment-id.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-stream-config/component1.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[StreamConfig](index.md)/[component1](component1.md)
2 |
3 |
4 |
5 | # component1
6 | [androidJvm]
7 | Content
8 | operator fun [component1](component1.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-stream-config/component2.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[StreamConfig](index.md)/[component2](component2.md)
2 |
3 |
4 |
5 | # component2
6 | [androidJvm]
7 | Content
8 | operator fun [component2](component2.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-transcript/component1.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Transcript](index.md)/[component1](component1.md)
2 |
3 |
4 |
5 | # component1
6 | [androidJvm]
7 | Content
8 | operator fun [component1](component1.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-transcript/context-id.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Transcript](index.md)/[contextId](context-id.md)
2 |
3 |
4 |
5 | # contextId
6 | [androidJvm]
7 | Content
8 | open override val [contextId](context-id.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.speech/-audio-recorder/buffer-size.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.speech](../index.md)/[AudioRecorder](index.md)/[bufferSize](buffer-size.md)
2 |
3 |
4 |
5 | # bufferSize
6 | [androidJvm]
7 | Content
8 | val [bufferSize](buffer-size.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.speech/-audio-recorder/sample-rate.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.speech](../index.md)/[AudioRecorder](index.md)/[sampleRate](sample-rate.md)
2 |
3 |
4 |
5 | # sampleRate
6 | [androidJvm]
7 | Content
8 | val [sampleRate](sample-rate.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.identity/-auth-token/component1.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.identity](../index.md)/[AuthToken](index.md)/[component1](component1.md)
2 |
3 |
4 |
5 | # component1
6 | [androidJvm]
7 | Content
8 | operator fun [component1](component1.md)(): [UUID](https://developer.android.com/reference/kotlin/java/util/UUID.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.identity/-auth-token/component2.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.identity](../index.md)/[AuthToken](index.md)/[component2](component2.md)
2 |
3 |
4 |
5 | # component2
6 | [androidJvm]
7 | Content
8 | operator fun [component2](component2.md)(): [UUID](https://developer.android.com/reference/kotlin/java/util/UUID.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.speech/-audio-recorder/channel-mask.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.speech](../index.md)/[AudioRecorder](index.md)/[channelMask](channel-mask.md)
2 |
3 |
4 |
5 | # channelMask
6 | [androidJvm]
7 | Content
8 | val [channelMask](channel-mask.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.identity/-auth-token/component3.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.identity](../index.md)/[AuthToken](index.md)/[component3](component3.md)
2 |
3 |
4 |
5 | # component3
6 | [androidJvm]
7 | Content
8 | operator fun [component3](component3.md)(): [Instant](https://developer.android.com/reference/kotlin/java/time/Instant.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.identity/-auth-token/component5.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.identity](../index.md)/[AuthToken](index.md)/[component5](component5.md)
2 |
3 |
4 |
5 | # component5
6 | [androidJvm]
7 | Content
8 | operator fun [component5](component5.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-stream-closed-exception/-stream-closed-exception.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[StreamClosedException](index.md)/[StreamClosedException](-stream-closed-exception.md)
2 |
3 |
4 |
5 | # StreamClosedException
6 | [androidJvm]
7 | Content
8 | fun [StreamClosedException](-stream-closed-exception.md)()
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.ui/-speechly-button/listener.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.ui](../index.md)/[SpeechlyButton](index.md)/[listener](listener.md)
2 |
3 |
4 |
5 | # listener
6 | [androidJvm]
7 | Content
8 | var [listener](listener.md): [View.OnTouchListener](https://developer.android.com/reference/kotlin/android/view/View.OnTouchListener.html)? = null
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-word/value.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Word](index.md)/[value](value.md)
2 |
3 |
4 |
5 | # value
6 | [androidJvm]
7 | Content
8 | val [value](value.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
9 | More info
10 |
11 |
12 | The value of the word.
13 |
14 |
15 |
16 |
17 |
18 |
--------------------------------------------------------------------------------
/client-test/src/main/kotlin/com/speechly/clienttest/Repo.kt:
--------------------------------------------------------------------------------
1 | package com.speechly.clienttest
2 |
3 | import android.graphics.drawable.Drawable
4 |
5 | data class Repo(
6 | val id: Long,
7 | val language: String,
8 | val iconId: Int,
9 | val name: String,
10 | val organisation: String,
11 | val followers: Int,
12 | val stars: Int,
13 | val forks: Int
14 | )
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.device/-caching-id-provider/cache-service.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.device](../index.md)/[CachingIdProvider](index.md)/[cacheService](cache-service.md)
2 |
3 |
4 |
5 | # cacheService
6 | [androidJvm]
7 | Content
8 | var [cacheService](cache-service.md): [CacheService](../../com.speechly.client.cache/-cache-service/index.md)? = null
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.speech/-audio-recorder/activity.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.speech](../index.md)/[AudioRecorder](index.md)/[activity](activity.md)
2 |
3 |
4 |
5 | # activity
6 | [androidJvm]
7 | Content
8 | var [activity](activity.md): [AppCompatActivity](https://developer.android.com/reference/kotlin/androidx/appcompat/app/AppCompatActivity.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.speech/-no-active-stream-exception/-no-active-stream-exception.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.speech](../index.md)/[NoActiveStreamException](index.md)/[NoActiveStreamException](-no-active-stream-exception.md)
2 |
3 |
4 |
5 | # NoActiveStreamException
6 | [androidJvm]
7 | Content
8 | fun [NoActiveStreamException](-no-active-stream-exception.md)()
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.identity/-auth-token/-auth-scope/-s-l-u/name.md:
--------------------------------------------------------------------------------
1 | //[client](../../../../index.md)/[com.speechly.client.identity](../../../index.md)/[AuthToken](../../index.md)/[AuthScope](../index.md)/[SLU](index.md)/[name](name.md)
2 |
3 |
4 |
5 | # name
6 | [androidJvm]
7 | Content
8 | val [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.identity/-auth-token/-auth-scope/-w-l-u/name.md:
--------------------------------------------------------------------------------
1 | //[client](../../../../index.md)/[com.speechly.client.identity](../../../index.md)/[AuthToken](../../index.md)/[AuthScope](../index.md)/[WLU](index.md)/[name](name.md)
2 |
3 |
4 |
5 | # name
6 | [androidJvm]
7 | Content
8 | val [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.identity/-caching-identity-service/cache-service.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.identity](../index.md)/[CachingIdentityService](index.md)/[cacheService](cache-service.md)
2 |
3 |
4 |
5 | # cacheService
6 | [androidJvm]
7 | Content
8 | var [cacheService](cache-service.md): [CacheService](../../com.speechly.client.cache/-cache-service/index.md)? = null
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-word/--index--.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Word](index.md)/[index](--index--.md)
2 |
3 |
4 |
5 | # index
6 | [androidJvm]
7 | Content
8 | val [index](--index--.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
9 | More info
10 |
11 |
12 | The index of the word within a segment.
13 |
14 |
15 |
16 |
17 |
18 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.speech/-audio-recorder/start-recording.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.speech](../index.md)/[AudioRecorder](index.md)/[startRecording](start-recording.md)
2 |
3 |
4 |
5 | # startRecording
6 | [androidJvm]
7 | Content
8 | fun [startRecording](start-recording.md)(): Flow<[ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)>
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-stream-config/-language-code/-e-n_-u-s/name.md:
--------------------------------------------------------------------------------
1 | //[client](../../../../index.md)/[com.speechly.client.slu](../../../index.md)/[StreamConfig](../../index.md)/[LanguageCode](../index.md)/[EN_US](index.md)/[name](name.md)
2 |
3 |
4 |
5 | # name
6 | [androidJvm]
7 | Content
8 | val [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-stream-config/-language-code/-f-i_-f-i/name.md:
--------------------------------------------------------------------------------
1 | //[client](../../../../index.md)/[com.speechly.client.slu](../../../index.md)/[StreamConfig](../../index.md)/[LanguageCode](../index.md)/[FI_FI](index.md)/[name](name.md)
2 |
3 |
4 |
5 | # name
6 | [androidJvm]
7 | Content
8 | val [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.identity/-auth-token/-auth-scope/-s-l-u/ordinal.md:
--------------------------------------------------------------------------------
1 | //[client](../../../../index.md)/[com.speechly.client.identity](../../../index.md)/[AuthToken](../../index.md)/[AuthScope](../index.md)/[SLU](index.md)/[ordinal](ordinal.md)
2 |
3 |
4 |
5 | # ordinal
6 | [androidJvm]
7 | Content
8 | val [ordinal](ordinal.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.identity/-auth-token/-auth-scope/-w-l-u/ordinal.md:
--------------------------------------------------------------------------------
1 | //[client](../../../../index.md)/[com.speechly.client.identity](../../../index.md)/[AuthToken](../../index.md)/[AuthScope](../index.md)/[WLU](index.md)/[ordinal](ordinal.md)
2 |
3 |
4 |
5 | # ordinal
6 | [androidJvm]
7 | Content
8 | val [ordinal](ordinal.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-stream-config/-language-code/string-value.md:
--------------------------------------------------------------------------------
1 | //[client](../../../index.md)/[com.speechly.client.slu](../../index.md)/[StreamConfig](../index.md)/[LanguageCode](index.md)/[stringValue](string-value.md)
2 |
3 |
4 |
5 | # stringValue
6 | [androidJvm]
7 | Content
8 | val [stringValue](string-value.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-word/is-final.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Word](index.md)/[isFinal](is-final.md)
2 |
3 |
4 |
5 | # isFinal
6 | [androidJvm]
7 | Content
8 | val [isFinal](is-final.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
9 | More info
10 |
11 |
12 | Whether the word was detected as final.
13 |
14 |
15 |
16 |
17 |
18 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.speech/-client/entity-cb.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.speech](../index.md)/[Client](index.md)/[entityCb](entity-cb.md)
2 |
3 |
4 |
5 | # entityCb
6 | [androidJvm]
7 | Content
8 | var [entityCb](entity-cb.md): (entity: [Entity](../../com.speechly.client.slu/-entity/index.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)? = null
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.speech/-client/intent-cb.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.speech](../index.md)/[Client](index.md)/[intentCb](intent-cb.md)
2 |
3 |
4 |
5 | # intentCb
6 | [androidJvm]
7 | Content
8 | var [intentCb](intent-cb.md): (intent: [Intent](../../com.speechly.client.slu/-intent/index.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)? = null
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/client-test/src/main/res/values/colors.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 | #FFBB86FC
4 | #FF6200EE
5 | #FF3700B3
6 | #FF03DAC5
7 | #FF018786
8 | #FF000000
9 | #FFFFFFFF
10 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.identity/-auth-token/component4.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.identity](../index.md)/[AuthToken](index.md)/[component4](component4.md)
2 |
3 |
4 |
5 | # component4
6 | [androidJvm]
7 | Content
8 | operator fun [component4](component4.md)(): [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)<[AuthToken.AuthScope](-auth-scope/index.md)>
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-segment/get-entity-by-type.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Segment](index.md)/[getEntityByType](get-entity-by-type.md)
2 |
3 |
4 |
5 | # getEntityByType
6 | [androidJvm]
7 | Content
8 | fun [getEntityByType](get-entity-by-type.md)(type: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [Entity](../-entity/index.md)?
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-stream-config/-language-code/-e-n_-u-s/ordinal.md:
--------------------------------------------------------------------------------
1 | //[client](../../../../index.md)/[com.speechly.client.slu](../../../index.md)/[StreamConfig](../../index.md)/[LanguageCode](../index.md)/[EN_US](index.md)/[ordinal](ordinal.md)
2 |
3 |
4 |
5 | # ordinal
6 | [androidJvm]
7 | Content
8 | val [ordinal](ordinal.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-stream-config/-language-code/-f-i_-f-i/ordinal.md:
--------------------------------------------------------------------------------
1 | //[client](../../../../index.md)/[com.speechly.client.slu](../../../index.md)/[StreamConfig](../../index.md)/[LanguageCode](../index.md)/[FI_FI](index.md)/[ordinal](ordinal.md)
2 |
3 |
4 |
5 | # ordinal
6 | [androidJvm]
7 | Content
8 | val [ordinal](ordinal.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-segment/-segment.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Segment](index.md)/[Segment](-segment.md)
2 |
3 |
4 |
5 | # Segment
6 | [androidJvm]
7 | Content
8 | fun [Segment](-segment.md)(contextId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), segmentId: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.device/-caching-id-provider/-caching-id-provider.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.device](../index.md)/[CachingIdProvider](index.md)/[CachingIdProvider](-caching-id-provider.md)
2 |
3 |
4 |
5 | # CachingIdProvider
6 | [androidJvm]
7 | Content
8 | fun [CachingIdProvider](-caching-id-provider.md)(baseProvider: [DeviceIdProvider](../-device-id-provider/index.md) = RandomIdProvider())
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-segment/update-entities.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Segment](index.md)/[updateEntities](update-entities.md)
2 |
3 |
4 |
5 | # updateEntities
6 | [androidJvm]
7 | Content
8 | fun [updateEntities](update-entities.md)(entities: [MutableList](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html)<[Entity](../-entity/index.md)>)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-segment/words.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Segment](index.md)/[words](words.md)
2 |
3 |
4 |
5 | # words
6 | [androidJvm]
7 | Content
8 | var [words](words.md): [MutableMap](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), [Word](../-word/index.md)>
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.speech/-api-client/start-context.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.speech](../index.md)/[ApiClient](index.md)/[startContext](start-context.md)
2 |
3 |
4 |
5 | # startContext
6 | [androidJvm]
7 | Content
8 | abstract fun [startContext](start-context.md)()
9 | More info
10 |
11 |
12 | Starts a new SLU context by sending a start context event to the API and unmuting the microphone.
13 |
14 |
15 |
16 |
17 |
18 |
--------------------------------------------------------------------------------
/client-test/src/test/java/com/speechly/clienttest/ExampleUnitTest.kt:
--------------------------------------------------------------------------------
1 | package com.speechly.clienttest
2 |
3 | import org.junit.Test
4 |
5 | import org.junit.Assert.*
6 |
7 | /**
8 | * Example local unit test, which will execute on the development machine (host).
9 | *
10 | * See [testing documentation](http://d.android.com/tools/testing).
11 | */
12 | class ExampleUnitTest {
13 | @Test
14 | fun addition_isCorrect() {
15 | assertEquals(4, 2 + 2)
16 | }
17 | }
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.speech/-client/transcript-cb.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.speech](../index.md)/[Client](index.md)/[transcriptCb](transcript-cb.md)
2 |
3 |
4 |
5 | # transcriptCb
6 | [androidJvm]
7 | Content
8 | var [transcriptCb](transcript-cb.md): (transcript: [Transcript](../../com.speechly.client.slu/-transcript/index.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)? = null
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-stream-config/-language-code/-e-n_-u-s/string-value.md:
--------------------------------------------------------------------------------
1 | //[client](../../../../index.md)/[com.speechly.client.slu](../../../index.md)/[StreamConfig](../../index.md)/[LanguageCode](../index.md)/[EN_US](index.md)/[stringValue](string-value.md)
2 |
3 |
4 |
5 | # stringValue
6 | [androidJvm]
7 | Content
8 | val [stringValue](string-value.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-stream-config/-language-code/-f-i_-f-i/string-value.md:
--------------------------------------------------------------------------------
1 | //[client](../../../../index.md)/[com.speechly.client.slu](../../../index.md)/[StreamConfig](../../index.md)/[LanguageCode](../index.md)/[FI_FI](index.md)/[stringValue](string-value.md)
2 |
3 |
4 |
5 | # stringValue
6 | [androidJvm]
7 | Content
8 | val [stringValue](string-value.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-word/end-timestamp.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Word](index.md)/[endTimestamp](end-timestamp.md)
2 |
3 |
4 |
5 | # endTimestamp
6 | [androidJvm]
7 | Content
8 | val [endTimestamp](end-timestamp.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
9 | More info
10 |
11 |
12 | End timestamp of the word within the audio of the context.
13 |
14 |
15 |
16 |
17 |
18 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.ui/-speechly-button/set-on-touch-listener.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.ui](../index.md)/[SpeechlyButton](index.md)/[setOnTouchListener](set-on-touch-listener.md)
2 |
3 |
4 |
5 | # setOnTouchListener
6 | [androidJvm]
7 | Content
8 | open override fun [setOnTouchListener](set-on-touch-listener.md)(listener: [View.OnTouchListener](https://developer.android.com/reference/kotlin/android/view/View.OnTouchListener.html))
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.speech/-client/segment-change-cb.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.speech](../index.md)/[Client](index.md)/[segmentChangeCb](segment-change-cb.md)
2 |
3 |
4 |
5 | # segmentChangeCb
6 | [androidJvm]
7 | Content
8 | var [segmentChangeCb](segment-change-cb.md): (segment: [Segment](../../com.speechly.client.slu/-segment/index.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)? = null
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-segment/entities.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Segment](index.md)/[entities](entities.md)
2 |
3 |
4 |
5 | # entities
6 | [androidJvm]
7 | Content
8 | var [entities](entities.md): [MutableMap](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), [Entity](../-entity/index.md)>
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-segment/update-transcripts.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Segment](index.md)/[updateTranscripts](update-transcripts.md)
2 |
3 |
4 |
5 | # updateTranscripts
6 | [androidJvm]
7 | Content
8 | fun [updateTranscripts](update-transcripts.md)(transcripts: [MutableList](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html)<[Transcript](../-transcript/index.md)>)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-transcript/copy.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Transcript](index.md)/[copy](copy.md)
2 |
3 |
4 |
5 | # copy
6 | [androidJvm]
7 | Content
8 | fun [copy](copy.md)(contextId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), segmentId: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), word: [Word](../-word/index.md)): [Transcript](index.md)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-word/start-timestamp.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Word](index.md)/[startTimestamp](start-timestamp.md)
2 |
3 |
4 |
5 | # startTimestamp
6 | [androidJvm]
7 | Content
8 | val [startTimestamp](start-timestamp.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
9 | More info
10 |
11 |
12 | Start timestamp of the word within the audio of the context.
13 |
14 |
15 |
16 |
17 |
18 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.speech/-client/stop-context.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.speech](../index.md)/[Client](index.md)/[stopContext](stop-context.md)
2 |
3 |
4 |
5 | # stopContext
6 | [androidJvm]
7 | Content
8 | open override fun [stopContext](stop-context.md)()
9 | More info
10 |
11 |
12 | Stops current SLU context by sending a stop context event to the API and muting the microphone delayed by contextStopDelay = 250 ms
13 |
14 |
15 |
16 |
17 |
18 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.speech/-client/tentative-intent-cb.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.speech](../index.md)/[Client](index.md)/[tentativeIntentCb](tentative-intent-cb.md)
2 |
3 |
4 |
5 | # tentativeIntentCb
6 | [androidJvm]
7 | Content
8 | var [tentativeIntentCb](tentative-intent-cb.md): (intent: [Intent](../../com.speechly.client.slu/-intent/index.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)? = null
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.speech/-api-client/stop-context.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.speech](../index.md)/[ApiClient](index.md)/[stopContext](stop-context.md)
2 |
3 |
4 |
5 | # stopContext
6 | [androidJvm]
7 | Content
8 | abstract fun [stopContext](stop-context.md)()
9 | More info
10 |
11 |
12 | Stops current SLU context by sending a stop context event to the API and muting the microphone delayed by contextStopDelay = 250 ms
13 |
14 |
15 |
16 |
17 |
18 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.ui/-speechly-button/listen-for-touch.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.ui](../index.md)/[SpeechlyButton](index.md)/[listenForTouch](listen-for-touch.md)
2 |
3 |
4 |
5 | # listenForTouch
6 | [androidJvm]
7 | Content
8 | fun [listenForTouch](listen-for-touch.md)(v: [View](https://developer.android.com/reference/kotlin/android/view/View.html)?, event: [MotionEvent](https://developer.android.com/reference/kotlin/android/view/MotionEvent.html)?)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.identity/-authentication-exception/-authentication-exception.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.identity](../index.md)/[AuthenticationException](index.md)/[AuthenticationException](-authentication-exception.md)
2 |
3 |
4 |
5 | # AuthenticationException
6 | [androidJvm]
7 | Content
8 | fun [AuthenticationException](-authentication-exception.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html))
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-entity/-companion/from-slu-reponse.md:
--------------------------------------------------------------------------------
1 | //[client](../../../index.md)/[com.speechly.client.slu](../../index.md)/[Entity](../index.md)/[Companion](index.md)/[fromSluReponse](from-slu-reponse.md)
2 |
3 |
4 |
5 | # fromSluReponse
6 | [androidJvm]
7 | Content
8 | fun [fromSluReponse](from-slu-reponse.md)(response: Slu.SLUResponse, isFinal: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = true): [Entity](../index.md)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-intent/-companion/from-slu-reponse.md:
--------------------------------------------------------------------------------
1 | //[client](../../../index.md)/[com.speechly.client.slu](../../index.md)/[Intent](../index.md)/[Companion](index.md)/[fromSluReponse](from-slu-reponse.md)
2 |
3 |
4 |
5 | # fromSluReponse
6 | [androidJvm]
7 | Content
8 | fun [fromSluReponse](from-slu-reponse.md)(response: Slu.SLUResponse, isFinal: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = true): [Intent](../index.md)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-transcript/-transcript.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Transcript](index.md)/[Transcript](-transcript.md)
2 |
3 |
4 |
5 | # Transcript
6 | [androidJvm]
7 | Content
8 | fun [Transcript](-transcript.md)(contextId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), segmentId: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), word: [Word](../-word/index.md))
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.speech/-client/start-context.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.speech](../index.md)/[Client](index.md)/[startContext](start-context.md)
2 |
3 |
4 |
5 | # startContext
6 | [androidJvm]
7 | Content
8 | @ExperimentalCoroutinesApi()
9 |
10 | open override fun [startContext](start-context.md)()
11 | More info
12 |
13 |
14 | Starts a new SLU context by sending a start context event to the API and unmuting the microphone.
15 |
16 |
17 |
18 |
19 |
20 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.ui/-speechly-button/-speechly-button.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.ui](../index.md)/[SpeechlyButton](index.md)/[SpeechlyButton](-speechly-button.md)
2 |
3 |
4 |
5 | # SpeechlyButton
6 | [androidJvm]
7 | Content
8 | fun [SpeechlyButton](-speechly-button.md)(context: [Context](https://developer.android.com/reference/kotlin/android/content/Context.html), attr: [AttributeSet](https://developer.android.com/reference/kotlin/android/util/AttributeSet.html))
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-transcript/-companion/from-slu-reponse.md:
--------------------------------------------------------------------------------
1 | //[client](../../../index.md)/[com.speechly.client.slu](../../index.md)/[Transcript](../index.md)/[Companion](index.md)/[fromSluReponse](from-slu-reponse.md)
2 |
3 |
4 |
5 | # fromSluReponse
6 | [androidJvm]
7 | Content
8 | fun [fromSluReponse](from-slu-reponse.md)(response: Slu.SLUResponse, isFinal: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = true): [Transcript](../index.md)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.cache/-shared-preferences-cache/-shared-preferences-cache.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.cache](../index.md)/[SharedPreferencesCache](index.md)/[SharedPreferencesCache](-shared-preferences-cache.md)
2 |
3 |
4 |
5 | # SharedPreferencesCache
6 | [androidJvm]
7 | Content
8 | fun [SharedPreferencesCache](-shared-preferences-cache.md)(preferences: [SharedPreferences](https://developer.android.com/reference/kotlin/android/content/SharedPreferences.html))
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/client-test/src/main/res/values-night/themes.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
10 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.identity/-invalid-application-exception/-invalid-application-exception.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.identity](../index.md)/[InvalidApplicationException](index.md)/[InvalidApplicationException](-invalid-application-exception.md)
2 |
3 |
4 |
5 | # InvalidApplicationException
6 | [androidJvm]
7 | Content
8 | fun [InvalidApplicationException](-invalid-application-exception.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html))
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-stream-config/copy.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[StreamConfig](index.md)/[copy](copy.md)
2 |
3 |
4 |
5 | # copy
6 | [androidJvm]
7 | Content
8 | fun [copy](copy.md)(channelCount: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), sampleRateHertz: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), languageCode: [StreamConfig.LanguageCode](-language-code/index.md)): [StreamConfig](index.md)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.speech/-audio-recorder/-audio-recorder.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.speech](../index.md)/[AudioRecorder](index.md)/[AudioRecorder](-audio-recorder.md)
2 |
3 |
4 |
5 | # AudioRecorder
6 | [androidJvm]
7 | Content
8 | fun [AudioRecorder](-audio-recorder.md)(activity: [AppCompatActivity](https://developer.android.com/reference/kotlin/androidx/appcompat/app/AppCompatActivity.html), sampleRate: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.cache/-shared-preferences-cache/-companion/-p-r-e-f-e-r-e-n-c-e_-f-i-l-e_-k-e-y.md:
--------------------------------------------------------------------------------
1 | //[client](../../../index.md)/[com.speechly.client.cache](../../index.md)/[SharedPreferencesCache](../index.md)/[Companion](index.md)/[PREFERENCE_FILE_KEY](-p-r-e-f-e-r-e-n-c-e_-f-i-l-e_-k-e-y.md)
2 |
3 |
4 |
5 | # PREFERENCE_FILE_KEY
6 | [androidJvm]
7 | Content
8 | const val [PREFERENCE_FILE_KEY](-p-r-e-f-e-r-e-n-c-e_-f-i-l-e_-k-e-y.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.device/-device-id-provider/get-device-id.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.device](../index.md)/[DeviceIdProvider](index.md)/[getDeviceId](get-device-id.md)
2 |
3 |
4 |
5 | # getDeviceId
6 | [androidJvm]
7 | Content
8 | abstract fun [getDeviceId](get-device-id.md)(): [DeviceId](../index.md#%5Bcom.speechly.client.device%2FDeviceId%2F%2F%2FPointingToDeclaration%2F%5D%2FClasslikes%2F-126307046)
9 | More info
10 |
11 |
12 | Returns the identifier of the device. Must not throw exceptions.
13 |
14 |
15 |
16 |
17 |
18 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.device/-random-id-provider/get-device-id.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.device](../index.md)/[RandomIdProvider](index.md)/[getDeviceId](get-device-id.md)
2 |
3 |
4 |
5 | # getDeviceId
6 | [androidJvm]
7 | Content
8 | open override fun [getDeviceId](get-device-id.md)(): [DeviceId](../index.md#%5Bcom.speechly.client.device%2FDeviceId%2F%2F%2FPointingToDeclaration%2F%5D%2FClasslikes%2F-126307046)
9 | More info
10 |
11 |
12 | Returns the identifier of the device. Must not throw exceptions.
13 |
14 |
15 |
16 |
17 |
18 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.device/-caching-id-provider/get-device-id.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.device](../index.md)/[CachingIdProvider](index.md)/[getDeviceId](get-device-id.md)
2 |
3 |
4 |
5 | # getDeviceId
6 | [androidJvm]
7 | Content
8 | open override fun [getDeviceId](get-device-id.md)(): [DeviceId](../index.md#%5Bcom.speechly.client.device%2FDeviceId%2F%2F%2FPointingToDeclaration%2F%5D%2FClasslikes%2F-126307046)
9 | More info
10 |
11 |
12 | Returns the identifier of the device. Must not throw exceptions.
13 |
14 |
15 |
16 |
17 |
18 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.speech/-client/tentative-entities-cb.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.speech](../index.md)/[Client](index.md)/[tentativeEntitiesCb](tentative-entities-cb.md)
2 |
3 |
4 |
5 | # tentativeEntitiesCb
6 | [androidJvm]
7 | Content
8 | var [tentativeEntitiesCb](tentative-entities-cb.md): (entities: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[Entity](../../com.speechly.client.slu/-entity/index.md)>) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)? = null
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.speech/-audio-recorder/request-permission-launcher.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.speech](../index.md)/[AudioRecorder](index.md)/[requestPermissionLauncher](request-permission-launcher.md)
2 |
3 |
4 |
5 | # requestPermissionLauncher
6 | [androidJvm]
7 | Content
8 | val [requestPermissionLauncher](request-permission-launcher.md): [ActivityResultLauncher](https://developer.android.com/reference/kotlin/androidx/activity/result/ActivityResultLauncher.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.speech/-client/tentative-transcript-cb.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.speech](../index.md)/[Client](index.md)/[tentativeTranscriptCb](tentative-transcript-cb.md)
2 |
3 |
4 |
5 | # tentativeTranscriptCb
6 | [androidJvm]
7 | Content
8 | var [tentativeTranscriptCb](tentative-transcript-cb.md): (transcripts: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[Transcript](../../com.speechly.client.slu/-transcript/index.md)>) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)? = null
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-intent/-intent.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Intent](index.md)/[Intent](-intent.md)
2 |
3 |
4 |
5 | # Intent
6 | [androidJvm]
7 | Content
8 | fun [Intent](-intent.md)(contextId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), segmentId: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), isFinal: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), intent: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html))
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-intent/copy.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Intent](index.md)/[copy](copy.md)
2 |
3 |
4 |
5 | # copy
6 | [androidJvm]
7 | Content
8 | fun [copy](copy.md)(contextId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), segmentId: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), isFinal: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), intent: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [Intent](index.md)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-entity/-companion/from-slu-entity.md:
--------------------------------------------------------------------------------
1 | //[client](../../../index.md)/[com.speechly.client.slu](../../index.md)/[Entity](../index.md)/[Companion](index.md)/[fromSluEntity](from-slu-entity.md)
2 |
3 |
4 |
5 | # fromSluEntity
6 | [androidJvm]
7 | Content
8 | fun [fromSluEntity](from-slu-entity.md)(audioContext: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), segmentId: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), entity: Slu.SLUEntity, isFinal: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = true): [Entity](../index.md)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-word/-word.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Word](index.md)/[Word](-word.md)
2 |
3 |
4 |
5 | # Word
6 | [androidJvm]
7 | Content
8 | fun [Word](-word.md)(value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), startTimestamp: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), endTimestamp: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), isFinal: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-word/copy.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Word](index.md)/[copy](copy.md)
2 |
3 |
4 |
5 | # copy
6 | [androidJvm]
7 | Content
8 | fun [copy](copy.md)(value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), startTimestamp: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), endTimestamp: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), isFinal: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Word](index.md)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-transcript/-companion/from-slu-transcript.md:
--------------------------------------------------------------------------------
1 | //[client](../../../index.md)/[com.speechly.client.slu](../../index.md)/[Transcript](../index.md)/[Companion](index.md)/[fromSluTranscript](from-slu-transcript.md)
2 |
3 |
4 |
5 | # fromSluTranscript
6 | [androidJvm]
7 | Content
8 | fun [fromSluTranscript](from-slu-transcript.md)(audioContext: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), segmentId: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), transcript: Slu.SLUTranscript, isFinal: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = true): [Transcript](../index.md)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/client-test/src/main/res/drawable/mic.xml:
--------------------------------------------------------------------------------
1 |
6 |
10 |
14 |
15 |
--------------------------------------------------------------------------------
/client-test/src/main/res/drawable/ic_mic.xml:
--------------------------------------------------------------------------------
1 |
6 |
10 |
14 |
15 |
--------------------------------------------------------------------------------
/android-client/src/main/res/drawable/ic_mic.xml:
--------------------------------------------------------------------------------
1 |
6 |
10 |
14 |
15 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.identity/-auth-token/app-id.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.identity](../index.md)/[AuthToken](index.md)/[appId](app-id.md)
2 |
3 |
4 |
5 | # appId
6 | [androidJvm]
7 | Content
8 | val [appId](app-id.md): [UUID](https://developer.android.com/reference/kotlin/java/util/UUID.html)
9 | More info
10 |
11 |
12 | ## Parameters
13 |
14 | androidJvm
15 |
16 | | Name| Summary|
17 | |---|---|
18 | | appId|
the ID of Speechly application that will be accessed with this token.
19 |
20 |
21 |
22 |
23 |
24 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.identity/-auth-token/expires-at.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.identity](../index.md)/[AuthToken](index.md)/[expiresAt](expires-at.md)
2 |
3 |
4 |
5 | # expiresAt
6 | [androidJvm]
7 | Content
8 | val [expiresAt](expires-at.md): [Instant](https://developer.android.com/reference/kotlin/java/time/Instant.html)
9 | More info
10 |
11 |
12 | ## Parameters
13 |
14 | androidJvm
15 |
16 | | Name| Summary|
17 | |---|---|
18 | | expiresAt|
the timestamp of token expiration.
19 |
20 |
21 |
22 |
23 |
24 |
--------------------------------------------------------------------------------
/client-test/src/main/res/drawable/fork.xml:
--------------------------------------------------------------------------------
1 |
6 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.identity/-auth-token/device-id.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.identity](../index.md)/[AuthToken](index.md)/[deviceId](device-id.md)
2 |
3 |
4 |
5 | # deviceId
6 | [androidJvm]
7 | Content
8 | val [deviceId](device-id.md): [UUID](https://developer.android.com/reference/kotlin/java/util/UUID.html)
9 | More info
10 |
11 |
12 | ## Parameters
13 |
14 | androidJvm
15 |
16 | | Name| Summary|
17 | |---|---|
18 | | deviceId|
Speechly device identifier that is authorised to use this token.
19 |
20 |
21 |
22 |
23 |
24 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-stream-config/language-code.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[StreamConfig](index.md)/[languageCode](language-code.md)
2 |
3 |
4 |
5 | # languageCode
6 | [androidJvm]
7 | Content
8 | val [languageCode](language-code.md): [StreamConfig.LanguageCode](-language-code/index.md)
9 | More info
10 |
11 |
12 | ## Parameters
13 |
14 | androidJvm
15 |
16 | | Name| Summary|
17 | |---|---|
18 | | languageCode|
the language of the audio, as BCP-47 compatible language tag.
19 |
20 |
21 |
22 |
23 |
24 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.identity/-auth-token/copy.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.identity](../index.md)/[AuthToken](index.md)/[copy](copy.md)
2 |
3 |
4 |
5 | # copy
6 | [androidJvm]
7 | Content
8 | fun [copy](copy.md)(appId: [UUID](https://developer.android.com/reference/kotlin/java/util/UUID.html), deviceId: [UUID](https://developer.android.com/reference/kotlin/java/util/UUID.html), expiresAt: [Instant](https://developer.android.com/reference/kotlin/java/time/Instant.html), authScopes: [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)<[AuthToken.AuthScope](-auth-scope/index.md)>, tokenString: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [AuthToken](index.md)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.identity/-auth-token/token-string.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.identity](../index.md)/[AuthToken](index.md)/[tokenString](token-string.md)
2 |
3 |
4 |
5 | # tokenString
6 | [androidJvm]
7 | Content
8 | val [tokenString](token-string.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
9 | More info
10 |
11 |
12 | ## Parameters
13 |
14 | androidJvm
15 |
16 | | Name| Summary|
17 | |---|---|
18 | | tokenString|
the token value that should be passed to API when accessing it.
19 |
20 |
21 |
22 |
23 |
24 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-stream-config/sample-rate-hertz.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[StreamConfig](index.md)/[sampleRateHertz](sample-rate-hertz.md)
2 |
3 |
4 |
5 | # sampleRateHertz
6 | [androidJvm]
7 | Content
8 | val [sampleRateHertz](sample-rate-hertz.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
9 | More info
10 |
11 |
12 | ## Parameters
13 |
14 | androidJvm
15 |
16 | | Name| Summary|
17 | |---|---|
18 | | sampleRateHertz|
the sample rate of the audio, in Hertz.
19 |
20 |
21 |
22 |
23 |
24 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.ui/index.md:
--------------------------------------------------------------------------------
1 | //[client](../index.md)/[com.speechly.ui](index.md)
2 |
3 |
4 |
5 | # Package com.speechly.ui
6 |
7 |
8 | ## Types
9 |
10 | | Name| Summary|
11 | |---|---|
12 | | [SpeechlyButton](-speechly-button/index.md)| [androidJvm]
Content
class [SpeechlyButton](-speechly-button/index.md)(**context**: [Context](https://developer.android.com/reference/kotlin/android/content/Context.html), **attr**: [AttributeSet](https://developer.android.com/reference/kotlin/android/util/AttributeSet.html)) : [AppCompatImageView](https://developer.android.com/reference/kotlin/androidx/appcompat/widget/AppCompatImageView.html)
13 |
14 |
--------------------------------------------------------------------------------
/android-client/src/main/kotlin/com/speechly/client/grpc/channel.kt:
--------------------------------------------------------------------------------
1 | package com.speechly.client.grpc
2 |
3 | import io.grpc.ManagedChannel
4 | import io.grpc.ManagedChannelBuilder
5 |
6 | /**
7 | * Performs a login against the API using provided request.
8 | *
9 | * @param target the address of the API endpoint, e.g. "api.speechly.com"
10 | * @param secure whether to use secured (TLS) or plaintext connection
11 | */
12 | internal fun buildChannel(target: String, secure: Boolean): ManagedChannel {
13 | val builder = if (secure) {
14 | ManagedChannelBuilder
15 | .forTarget(target)
16 | .useTransportSecurity()
17 | } else {
18 | ManagedChannelBuilder
19 | .forTarget(target)
20 | .usePlaintext()
21 | }
22 |
23 | return builder.build()
24 | }
25 |
--------------------------------------------------------------------------------
/android-client/src/main/res/drawable/ic_start.xml:
--------------------------------------------------------------------------------
1 |
6 |
10 |
14 |
15 |
--------------------------------------------------------------------------------
/client-test/src/main/res/drawable/ic_start.xml:
--------------------------------------------------------------------------------
1 |
6 |
10 |
14 |
15 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-stream-config/channel-count.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[StreamConfig](index.md)/[channelCount](channel-count.md)
2 |
3 |
4 |
5 | # channelCount
6 | [androidJvm]
7 | Content
8 | val [channelCount](channel-count.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
9 | More info
10 |
11 |
12 | ## Parameters
13 |
14 | androidJvm
15 |
16 | | Name| Summary|
17 | |---|---|
18 | | channelCount|
the number of channels contained in the audio data (e.g. 1 is mono, 2 is stereo, etc.).
19 |
20 |
21 |
22 |
23 |
24 |
--------------------------------------------------------------------------------
/client-test/src/androidTest/java/com/speechly/clienttest/ExampleInstrumentedTest.kt:
--------------------------------------------------------------------------------
1 | package com.speechly.clienttest
2 |
3 | import android.support.test.InstrumentationRegistry
4 | import android.support.test.runner.AndroidJUnit4
5 |
6 | import org.junit.Test
7 | import org.junit.runner.RunWith
8 |
9 | import org.junit.Assert.*
10 |
11 | /**
12 | * Instrumented test, which will execute on an Android device.
13 | *
14 | * See [testing documentation](http://d.android.com/tools/testing).
15 | */
16 | @RunWith(AndroidJUnit4::class)
17 | class ExampleInstrumentedTest {
18 | @Test
19 | fun useAppContext() {
20 | // Context of the app under test.
21 | val appContext = InstrumentationRegistry.getInstrumentation().targetContext
22 | assertEquals("com.speechly.clienttest", appContext.packageName)
23 | }
24 | }
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.identity/-auth-token/auth-scopes.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.identity](../index.md)/[AuthToken](index.md)/[authScopes](auth-scopes.md)
2 |
3 |
4 |
5 | # authScopes
6 | [androidJvm]
7 | Content
8 | val [authScopes](auth-scopes.md): [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)<[AuthToken.AuthScope](-auth-scope/index.md)>
9 | More info
10 |
11 |
12 | ## Parameters
13 |
14 | androidJvm
15 |
16 | | Name| Summary|
17 | |---|---|
18 | | authScopes|
Speechly APIs that can be accessed with this token.
19 |
20 |
21 |
22 |
23 |
24 |
--------------------------------------------------------------------------------
/client-test/proguard-rules.pro:
--------------------------------------------------------------------------------
1 | # Add project specific ProGuard rules here.
2 | # You can control the set of applied configuration files using the
3 | # proguardFiles setting in build.gradle.
4 | #
5 | # For more details, see
6 | # http://developer.android.com/guide/developing/tools/proguard.html
7 |
8 | # If your project uses WebView with JS, uncomment the following
9 | # and specify the fully qualified class name to the JavaScript interface
10 | # class:
11 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview {
12 | # public *;
13 | #}
14 |
15 | # Uncomment this to preserve the line number information for
16 | # debugging stack traces.
17 | #-keepattributes SourceFile,LineNumberTable
18 |
19 | # If you keep the line number information, uncomment this to
20 | # hide the original source file name.
21 | #-renamesourcefileattribute SourceFile
--------------------------------------------------------------------------------
/android-client/proguard-rules.pro:
--------------------------------------------------------------------------------
1 | # Add project specific ProGuard rules here.
2 | # You can control the set of applied configuration files using the
3 | # proguardFiles setting in build.gradle.
4 | #
5 | # For more details, see
6 | # http://developer.android.com/guide/developing/tools/proguard.html
7 |
8 | # If your project uses WebView with JS, uncomment the following
9 | # and specify the fully qualified class name to the JavaScript interface
10 | # class:
11 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview {
12 | # public *;
13 | #}
14 |
15 | # Uncomment this to preserve the line number information for
16 | # debugging stack traces.
17 | #-keepattributes SourceFile,LineNumberTable
18 |
19 | # If you keep the line number information, uncomment this to
20 | # hide the original source file name.
21 | #-renamesourcefileattribute SourceFile
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-entity/-entity.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Entity](index.md)/[Entity](-entity.md)
2 |
3 |
4 |
5 | # Entity
6 | [androidJvm]
7 | Content
8 | fun [Entity](-entity.md)(contextId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), segmentId: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), isFinal: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), startPosition: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), endPosition: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), type: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html))
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-entity/copy.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[Entity](index.md)/[copy](copy.md)
2 |
3 |
4 |
5 | # copy
6 | [androidJvm]
7 | Content
8 | fun [copy](copy.md)(contextId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), segmentId: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), isFinal: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), startPosition: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), endPosition: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), type: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [Entity](index.md)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/client-test/src/main/res/drawable/star.xml:
--------------------------------------------------------------------------------
1 |
6 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.speech/-client/-client.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.speech](../index.md)/[Client](index.md)/[Client](-client.md)
2 |
3 |
4 |
5 | # Client
6 | [androidJvm]
7 | Content
8 | fun [Client](-client.md)(appId: [UUID](https://developer.android.com/reference/kotlin/java/util/UUID.html), language: [StreamConfig.LanguageCode](../../com.speechly.client.slu/-stream-config/-language-code/index.md), deviceIdProvider: [DeviceIdProvider](../../com.speechly.client.device/-device-id-provider/index.md), identityService: [IdentityService](../../com.speechly.client.identity/-identity-service/index.md), sluClient: [GrpcSluClient](../../com.speechly.client.slu/-grpc-slu-client/index.md), audioRecorder: [AudioRecorder](../-audio-recorder/index.md), activity: [AppCompatActivity](https://developer.android.com/reference/kotlin/androidx/appcompat/app/AppCompatActivity.html))
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.speech/-client/-companion/from-activity.md:
--------------------------------------------------------------------------------
1 | //[client](../../../index.md)/[com.speechly.client.speech](../../index.md)/[Client](../index.md)/[Companion](index.md)/[fromActivity](from-activity.md)
2 |
3 |
4 |
5 | # fromActivity
6 | [androidJvm]
7 | Content
8 | fun [fromActivity](from-activity.md)(activity: [AppCompatActivity](https://developer.android.com/reference/kotlin/androidx/appcompat/app/AppCompatActivity.html), appId: [UUID](https://developer.android.com/reference/kotlin/java/util/UUID.html), language: [StreamConfig.LanguageCode](../../../com.speechly.client.slu/-stream-config/-language-code/index.md) = StreamConfig.LanguageCode.EN_US, target: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = "api.speechly.com", secure: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = true): [Client](../index.md)
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.identity/-invalid-j-w-t-exception/-invalid-j-w-t-exception.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.identity](../index.md)/[InvalidJWTException](index.md)/[InvalidJWTException](-invalid-j-w-t-exception.md)
2 |
3 |
4 |
5 | # InvalidJWTException
6 | [androidJvm]
7 | Content
8 | fun [InvalidJWTException](-invalid-j-w-t-exception.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html))
9 | More info
10 |
11 |
12 | ## Parameters
13 |
14 | androidJvm
15 |
16 | | Name| Summary|
17 | |---|---|
18 | | message|
detailed message describing the specifics of the exception.
19 |
20 |
21 |
22 |
23 |
24 |
--------------------------------------------------------------------------------
/docs/client/README.md:
--------------------------------------------------------------------------------
1 | //[client](index.md)
2 |
3 |
4 |
5 | # client
6 |
7 |
8 | ## Packages
9 |
10 | | Name| Summary|
11 | |---|---|
12 | | [com.speechly.client.cache](com.speechly.client.cache/index.md) |
13 | | [com.speechly.client.device](com.speechly.client.device/index.md) |
14 | | [com.speechly.client.identity](com.speechly.client.identity/index.md) |
15 | | [com.speechly.client.slu](com.speechly.client.slu/index.md) |
16 | | [com.speechly.client.speech](com.speechly.client.speech/index.md) |
17 | | [com.speechly.ui](com.speechly.ui/index.md) |
18 |
19 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.identity/-basic-identity-service/-basic-identity-service.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.identity](../index.md)/[BasicIdentityService](index.md)/[BasicIdentityService](-basic-identity-service.md)
2 |
3 |
4 |
5 | # BasicIdentityService
6 | [androidJvm]
7 | Content
8 | fun [BasicIdentityService](-basic-identity-service.md)(client: [IdentityClient](../-identity-client/index.md))
9 | More info
10 |
11 |
12 | ## Parameters
13 |
14 | androidJvm
15 |
16 | | Name| Summary|
17 | |---|---|
18 | | client|
an implementation of identity client logic.
19 |
20 |
21 |
22 |
23 |
24 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.identity/-identity-client/login.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.identity](../index.md)/[IdentityClient](index.md)/[login](login.md)
2 |
3 |
4 |
5 | # login
6 | [androidJvm]
7 | Content
8 | abstract suspend fun [login](login.md)(request: IdentityOuterClass.LoginRequest): IdentityOuterClass.LoginResponse
9 | More info
10 |
11 |
12 | Performs a login against the API using provided request.
13 |
14 |
15 |
16 | ## Parameters
17 |
18 | androidJvm
19 |
20 | | Name| Summary|
21 | |---|---|
22 | | request|
the login request that is sent to the API.
23 |
24 |
25 |
26 |
27 |
28 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.identity/-grpc-identity-client/login.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.identity](../index.md)/[GrpcIdentityClient](index.md)/[login](login.md)
2 |
3 |
4 |
5 | # login
6 | [androidJvm]
7 | Content
8 | open suspend override fun [login](login.md)(request: IdentityOuterClass.LoginRequest): IdentityOuterClass.LoginResponse
9 | More info
10 |
11 |
12 | Performs a login against the API using provided request.
13 |
14 |
15 |
16 | ## Parameters
17 |
18 | androidJvm
19 |
20 | | Name| Summary|
21 | |---|---|
22 | | request|
the login request that is sent to the API.
23 |
24 |
25 |
26 |
27 |
28 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.identity/-auth-token/-companion/from-j-w-t.md:
--------------------------------------------------------------------------------
1 | //[client](../../../index.md)/[com.speechly.client.identity](../../index.md)/[AuthToken](../index.md)/[Companion](index.md)/[fromJWT](from-j-w-t.md)
2 |
3 |
4 |
5 | # fromJWT
6 | [androidJvm]
7 | Content
8 | fun [fromJWT](from-j-w-t.md)(jwt: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [AuthToken](../index.md)
9 | More info
10 |
11 |
12 | Parses the authentication token from its string representation.
13 |
14 |
15 |
16 | ## Parameters
17 |
18 | androidJvm
19 |
20 | | Name| Summary|
21 | |---|---|
22 | | jwt|
the string representation of the token, normally returned by Speechly Identity service.
23 |
24 |
25 |
26 |
27 |
28 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.identity/-auth-token/validate-expiry.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.identity](../index.md)/[AuthToken](index.md)/[validateExpiry](validate-expiry.md)
2 |
3 |
4 |
5 | # validateExpiry
6 | [androidJvm]
7 | Content
8 | fun [validateExpiry](validate-expiry.md)(expiresAt: [Instant](https://developer.android.com/reference/kotlin/java/time/Instant.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
9 | More info
10 |
11 |
12 | Validates the expiry of the token against provided timestamp.
13 |
14 |
15 |
16 | ## Parameters
17 |
18 | androidJvm
19 |
20 | | Name| Summary|
21 | |---|---|
22 | | expiresAt|
timestamp to check expiration against.
23 |
24 |
25 |
26 |
27 |
28 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.speech/-client/on-entity.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.speech](../index.md)/[Client](index.md)/[onEntity](on-entity.md)
2 |
3 |
4 |
5 | # onEntity
6 | [androidJvm]
7 | Content
8 | open override fun [onEntity](on-entity.md)(block: (entity: [Entity](../../com.speechly.client.slu/-entity/index.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
9 | More info
10 |
11 |
12 | Adds a listener for entity responses from the API.
13 |
14 |
15 |
16 | ## Parameters
17 |
18 | androidJvm
19 |
20 | | Name| Summary|
21 | |---|---|
22 | | block| - the callback to invoke on an entity response.
23 |
24 |
25 |
26 |
27 |
28 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.speech/-client/on-intent.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.speech](../index.md)/[Client](index.md)/[onIntent](on-intent.md)
2 |
3 |
4 |
5 | # onIntent
6 | [androidJvm]
7 | Content
8 | open override fun [onIntent](on-intent.md)(block: (intent: [Intent](../../com.speechly.client.slu/-intent/index.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
9 | More info
10 |
11 |
12 | Adds a listener for intent responses from the API.
13 |
14 |
15 |
16 | ## Parameters
17 |
18 | androidJvm
19 |
20 | | Name| Summary|
21 | |---|---|
22 | | block| - the callback to invoke on an intent response.
23 |
24 |
25 |
26 |
27 |
28 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.speech/-api-client/on-entity.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.speech](../index.md)/[ApiClient](index.md)/[onEntity](on-entity.md)
2 |
3 |
4 |
5 | # onEntity
6 | [androidJvm]
7 | Content
8 | abstract fun [onEntity](on-entity.md)(block: (entity: [Entity](../../com.speechly.client.slu/-entity/index.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
9 | More info
10 |
11 |
12 | Adds a listener for entity responses from the API.
13 |
14 |
15 |
16 | ## Parameters
17 |
18 | androidJvm
19 |
20 | | Name| Summary|
21 | |---|---|
22 | | block| - the callback to invoke on an entity response.
23 |
24 |
25 |
26 |
27 |
28 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.speech/-api-client/on-intent.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.speech](../index.md)/[ApiClient](index.md)/[onIntent](on-intent.md)
2 |
3 |
4 |
5 | # onIntent
6 | [androidJvm]
7 | Content
8 | abstract fun [onIntent](on-intent.md)(block: (intent: [Intent](../../com.speechly.client.slu/-intent/index.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
9 | More info
10 |
11 |
12 | Adds a listener for intent responses from the API.
13 |
14 |
15 |
16 | ## Parameters
17 |
18 | androidJvm
19 |
20 | | Name| Summary|
21 | |---|---|
22 | | block| - the callback to invoke on an intent response.
23 |
24 |
25 |
26 |
27 |
28 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.cache/-cache-service/load-string.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.cache](../index.md)/[CacheService](index.md)/[loadString](load-string.md)
2 |
3 |
4 |
5 | # loadString
6 | [androidJvm]
7 | Content
8 | abstract fun [loadString](load-string.md)(key: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?
9 | More info
10 |
11 |
12 | Reads the specified key from the cache and returns the data as string. If the key is missing or the data cannot be parsed into a string, returns null.
13 |
14 |
15 |
16 | ## Parameters
17 |
18 | androidJvm
19 |
20 | | Name| Summary|
21 | |---|---|
22 | | key|
the key to read from
23 |
24 |
25 |
26 |
27 |
28 |
--------------------------------------------------------------------------------
/client-test/src/main/res/drawable/eye.xml:
--------------------------------------------------------------------------------
1 |
6 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.speech/-client/on-transcript.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.speech](../index.md)/[Client](index.md)/[onTranscript](on-transcript.md)
2 |
3 |
4 |
5 | # onTranscript
6 | [androidJvm]
7 | Content
8 | open override fun [onTranscript](on-transcript.md)(block: (transcript: [Transcript](../../com.speechly.client.slu/-transcript/index.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
9 | More info
10 |
11 |
12 | Adds a listener for transcript responses from the API.
13 |
14 |
15 |
16 | ## Parameters
17 |
18 | androidJvm
19 |
20 | | Name| Summary|
21 | |---|---|
22 | | block| - the callback to invoke on a transcript response.
23 |
24 |
25 |
26 |
27 |
28 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.cache/-shared-preferences-cache/load-string.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.cache](../index.md)/[SharedPreferencesCache](index.md)/[loadString](load-string.md)
2 |
3 |
4 |
5 | # loadString
6 | [androidJvm]
7 | Content
8 | open override fun [loadString](load-string.md)(key: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?
9 | More info
10 |
11 |
12 | Reads the specified key from the cache and returns the data as string. If the key is missing or the data cannot be parsed into a string, returns null.
13 |
14 |
15 |
16 | ## Parameters
17 |
18 | androidJvm
19 |
20 | | Name| Summary|
21 | |---|---|
22 | | key|
the key to read from
23 |
24 |
25 |
26 |
27 |
28 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.speech/-api-client/on-transcript.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.speech](../index.md)/[ApiClient](index.md)/[onTranscript](on-transcript.md)
2 |
3 |
4 |
5 | # onTranscript
6 | [androidJvm]
7 | Content
8 | abstract fun [onTranscript](on-transcript.md)(block: (transcript: [Transcript](../../com.speechly.client.slu/-transcript/index.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
9 | More info
10 |
11 |
12 | Adds a listener for transcript responses from the API.
13 |
14 |
15 |
16 | ## Parameters
17 |
18 | androidJvm
19 |
20 | | Name| Summary|
21 | |---|---|
22 | | block| - the callback to invoke on a transcript response.
23 |
24 |
25 |
26 |
27 |
28 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.speech/-client/on-segment-change.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.speech](../index.md)/[Client](index.md)/[onSegmentChange](on-segment-change.md)
2 |
3 |
4 |
5 | # onSegmentChange
6 | [androidJvm]
7 | Content
8 | open override fun [onSegmentChange](on-segment-change.md)(block: (segment: [Segment](../../com.speechly.client.slu/-segment/index.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
9 | More info
10 |
11 |
12 | Adds a listener for current segment change events.
13 |
14 |
15 |
16 | ## Parameters
17 |
18 | androidJvm
19 |
20 | | Name| Summary|
21 | |---|---|
22 | | block| - the callback to invoke on segment change events.
23 |
24 |
25 |
26 |
27 |
28 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.speech/-api-client/on-segment-change.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.speech](../index.md)/[ApiClient](index.md)/[onSegmentChange](on-segment-change.md)
2 |
3 |
4 |
5 | # onSegmentChange
6 | [androidJvm]
7 | Content
8 | abstract fun [onSegmentChange](on-segment-change.md)(block: (segment: [Segment](../../com.speechly.client.slu/-segment/index.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
9 | More info
10 |
11 |
12 | Adds a listener for current segment change events.
13 |
14 |
15 |
16 | ## Parameters
17 |
18 | androidJvm
19 |
20 | | Name| Summary|
21 | |---|---|
22 | | block| - the callback to invoke on segment change events.
23 |
24 |
25 |
26 |
27 |
28 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.speech/-client/on-tentative-intent.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.speech](../index.md)/[Client](index.md)/[onTentativeIntent](on-tentative-intent.md)
2 |
3 |
4 |
5 | # onTentativeIntent
6 | [androidJvm]
7 | Content
8 | open override fun [onTentativeIntent](on-tentative-intent.md)(block: (intent: [Intent](../../com.speechly.client.slu/-intent/index.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
9 | More info
10 |
11 |
12 | Adds a listener for tentative intent responses from the API.
13 |
14 |
15 |
16 | ## Parameters
17 |
18 | androidJvm
19 |
20 | | Name| Summary|
21 | |---|---|
22 | | block| - the callback to invoke on a tentative intent response.
23 |
24 |
25 |
26 |
27 |
28 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.speech/-api-client/on-tentative-intent.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.speech](../index.md)/[ApiClient](index.md)/[onTentativeIntent](on-tentative-intent.md)
2 |
3 |
4 |
5 | # onTentativeIntent
6 | [androidJvm]
7 | Content
8 | abstract fun [onTentativeIntent](on-tentative-intent.md)(block: (intent: [Intent](../../com.speechly.client.slu/-intent/index.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
9 | More info
10 |
11 |
12 | Adds a listener for tentative intent responses from the API.
13 |
14 |
15 |
16 | ## Parameters
17 |
18 | androidJvm
19 |
20 | | Name| Summary|
21 | |---|---|
22 | | block| - the callback to invoke on a tentative intent response.
23 |
24 |
25 |
26 |
27 |
28 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2020 Speechly
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/android-client/src/main/res/drawable/ic_micframe.xml:
--------------------------------------------------------------------------------
1 |
7 |
11 |
14 |
15 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
--------------------------------------------------------------------------------
/client-test/src/main/res/drawable/ic_micframe.xml:
--------------------------------------------------------------------------------
1 |
7 |
11 |
14 |
15 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
--------------------------------------------------------------------------------
/client-test/src/main/AndroidManifest.xml:
--------------------------------------------------------------------------------
1 |
2 |
4 |
5 |
6 |
7 |
8 |
9 |
17 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-grpc-slu-client/-grpc-slu-client.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[GrpcSluClient](index.md)/[GrpcSluClient](-grpc-slu-client.md)
2 |
3 |
4 |
5 | # GrpcSluClient
6 | [androidJvm]
7 | Content
8 | fun [GrpcSluClient](-grpc-slu-client.md)(channel: ManagedChannel, shutdownTimeout: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) = 5)
9 | More info
10 |
11 |
12 | ## Parameters
13 |
14 | androidJvm
15 |
16 | | Name| Summary|
17 | |---|---|
18 | | channel|
the gRPC channel to use for sending requests to the API
19 | | shutdownTimeout|
the timeout for closing the gRPC channel
20 |
21 |
22 |
23 |
24 |
25 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.cache/index.md:
--------------------------------------------------------------------------------
1 | //[client](../index.md)/[com.speechly.client.cache](index.md)
2 |
3 |
4 |
5 | # Package com.speechly.client.cache
6 |
7 |
8 | ## Types
9 |
10 | | Name| Summary|
11 | |---|---|
12 | | [CacheService](-cache-service/index.md)| [androidJvm]
Content
interface [CacheService](-cache-service/index.md)
More info
An interface for a persistent cache for storing key-value pairs in the device storage.
13 | | [SharedPreferencesCache](-shared-preferences-cache/index.md)| [androidJvm]
Content
class [SharedPreferencesCache](-shared-preferences-cache/index.md)(**preferences**: [SharedPreferences](https://developer.android.com/reference/kotlin/android/content/SharedPreferences.html)) : [CacheService](-cache-service/index.md)
More info
An implementation of persistent cache that uses Android shared preferences as the storage.
14 |
15 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.speech/-client/on-tentative-entities.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.speech](../index.md)/[Client](index.md)/[onTentativeEntities](on-tentative-entities.md)
2 |
3 |
4 |
5 | # onTentativeEntities
6 | [androidJvm]
7 | Content
8 | open override fun [onTentativeEntities](on-tentative-entities.md)(block: (entities: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[Entity](../../com.speechly.client.slu/-entity/index.md)>) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
9 | More info
10 |
11 |
12 | Adds a listener for tentative entities responses from the API.
13 |
14 |
15 |
16 | ## Parameters
17 |
18 | androidJvm
19 |
20 | | Name| Summary|
21 | |---|---|
22 | | block| - the callback to invoke on a tentative entities response.
23 |
24 |
25 |
26 |
27 |
28 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.speech/-api-client/on-tentative-entities.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.speech](../index.md)/[ApiClient](index.md)/[onTentativeEntities](on-tentative-entities.md)
2 |
3 |
4 |
5 | # onTentativeEntities
6 | [androidJvm]
7 | Content
8 | abstract fun [onTentativeEntities](on-tentative-entities.md)(block: (entities: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[Entity](../../com.speechly.client.slu/-entity/index.md)>) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
9 | More info
10 |
11 |
12 | Adds a listener for tentative entities responses from the API.
13 |
14 |
15 |
16 | ## Parameters
17 |
18 | androidJvm
19 |
20 | | Name| Summary|
21 | |---|---|
22 | | block| - the callback to invoke on a tentative entities response.
23 |
24 |
25 |
26 |
27 |
28 |
--------------------------------------------------------------------------------
/client-test/gradle.properties:
--------------------------------------------------------------------------------
1 | # Project-wide Gradle settings.
2 | # IDE (e.g. Android Studio) users:
3 | # Gradle settings configured through the IDE *will override*
4 | # any settings specified in this file.
5 | # For more details on how to configure your build environment visit
6 | # http://www.gradle.org/docs/current/userguide/build_environment.html
7 | # Specifies the JVM arguments used for the daemon process.
8 | # The setting is particularly useful for tweaking memory settings.
9 | org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8
10 | # When configured, Gradle will run in incubating parallel mode.
11 | # This option should only be used with decoupled projects. More details, visit
12 | # http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects
13 | # org.gradle.parallel=true
14 | # AndroidX package structure to make it clearer which packages are bundled with the
15 | # Android operating system, and which are packaged with your app"s APK
16 | # https://developer.android.com/topic/libraries/support-library/androidx-rn
17 | android.useAndroidX=true
18 | # Automatically convert third-party libraries to use AndroidX
19 | android.enableJetifier=true
20 | # Kotlin code style for this project: "official" or "obsolete":
21 | kotlin.code.style=official
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.speech/-client/on-tentative-transcript.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.speech](../index.md)/[Client](index.md)/[onTentativeTranscript](on-tentative-transcript.md)
2 |
3 |
4 |
5 | # onTentativeTranscript
6 | [androidJvm]
7 | Content
8 | open override fun [onTentativeTranscript](on-tentative-transcript.md)(block: (transcripts: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[Transcript](../../com.speechly.client.slu/-transcript/index.md)>) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
9 | More info
10 |
11 |
12 | Adds a listener for tentative transcript responses from the API.
13 |
14 |
15 |
16 | ## Parameters
17 |
18 | androidJvm
19 |
20 | | Name| Summary|
21 | |---|---|
22 | | block| - the callback to invoke on a tentative transcript response.
23 |
24 |
25 |
26 |
27 |
28 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.speech/-api-client/on-tentative-transcript.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.speech](../index.md)/[ApiClient](index.md)/[onTentativeTranscript](on-tentative-transcript.md)
2 |
3 |
4 |
5 | # onTentativeTranscript
6 | [androidJvm]
7 | Content
8 | abstract fun [onTentativeTranscript](on-tentative-transcript.md)(block: (transcripts: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[Transcript](../../com.speechly.client.slu/-transcript/index.md)>) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
9 | More info
10 |
11 |
12 | Adds a listener for tentative transcript responses from the API.
13 |
14 |
15 |
16 | ## Parameters
17 |
18 | androidJvm
19 |
20 | | Name| Summary|
21 | |---|---|
22 | | block| - the callback to invoke on a tentative transcript response.
23 |
24 |
25 |
26 |
27 |
28 |
--------------------------------------------------------------------------------
/client-test/src/main/res/values/themes.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
16 |
17 |
21 |
22 |
23 |
24 |
25 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.identity/-grpc-identity-client/-grpc-identity-client.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.identity](../index.md)/[GrpcIdentityClient](index.md)/[GrpcIdentityClient](-grpc-identity-client.md)
2 |
3 |
4 |
5 | # GrpcIdentityClient
6 | [androidJvm]
7 | Content
8 | fun [GrpcIdentityClient](-grpc-identity-client.md)(channel: ManagedChannel, shutdownTimeout: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) = 5)
9 | More info
10 |
11 |
12 | ## Parameters
13 |
14 | androidJvm
15 |
16 | | Name| Summary|
17 | |---|---|
18 | | channel|
the gRPC channel to use for sending requests to the API
19 | | shutdownTimeout|
the timeout for closing the gRPC channel
20 |
21 |
22 |
23 |
24 |
25 |
--------------------------------------------------------------------------------
/.github/workflows/publish.yml:
--------------------------------------------------------------------------------
1 | name: Publish
2 |
3 | on:
4 | release:
5 | types:
6 | - released
7 |
8 | jobs:
9 | publish:
10 | name: Release build and publish
11 | runs-on: ubuntu-latest
12 | steps:
13 | - name: Check out code
14 | uses: actions/checkout@v2
15 | - uses: actions/setup-java@v2
16 | with:
17 | distribution: "zulu"
18 | java-version: "11"
19 |
20 | # Builds the release artifacts of the library
21 | - name: Release build
22 | run: |
23 | ./gradlew :android-client:assembleRelease
24 | ./gradlew androidSourcesJar javadocJar
25 | ./gradlew -s publishReleasePublicationToSonatypeRepository --max-workers 1 closeAndReleaseSonatypeStagingRepository
26 | env:
27 | ORG_GRADLE_PROJECT_LIBRARY_VERSION: ${{ github.event.release.tag_name }}
28 | ORG_GRADLE_PROJECT_OSSRH_USERNAME: ${{ secrets.ORG_GRADLE_PROJECT_OSSRH_USERNAME }}
29 | ORG_GRADLE_PROJECT_OSSRH_PASSWORD: ${{ secrets.ORG_GRADLE_PROJECT_OSSRH_PASSWORD }}
30 | ORG_GRADLE_PROJECT_SIGNING_KEY_ID: ${{ secrets.ORG_GRADLE_PROJECT_SIGNING_KEY_ID }}
31 | ORG_GRADLE_PROJECT_SIGNING_KEY_PASSPHRASE: ${{ secrets.ORG_GRADLE_PROJECT_SIGNING_KEY_PASSPHRASE }}
32 | ORG_GRADLE_PROJECT_SIGNING_KEY: ${{ secrets.ORG_GRADLE_PROJECT_SIGNING_KEY }}
33 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.cache/-cache-service/store-string.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.cache](../index.md)/[CacheService](index.md)/[storeString](store-string.md)
2 |
3 |
4 |
5 | # storeString
6 | [androidJvm]
7 | Content
8 | abstract fun [storeString](store-string.md)(key: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
9 | More info
10 |
11 |
12 | Stores the string value to the cache under specified key. Returns true if the operation succeeds, false otherwise.
13 |
14 |
15 |
16 | ## Parameters
17 |
18 | androidJvm
19 |
20 | | Name| Summary|
21 | |---|---|
22 | | key|
the key to write to
23 | | value|
the value to write
24 |
25 |
26 |
27 |
28 |
29 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.identity/-identity-service/authenticate.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.identity](../index.md)/[IdentityService](index.md)/[authenticate](authenticate.md)
2 |
3 |
4 |
5 | # authenticate
6 | [androidJvm]
7 | Content
8 | abstract suspend fun [authenticate](authenticate.md)(appId: [UUID](https://developer.android.com/reference/kotlin/java/util/UUID.html), deviceId: [UUID](https://developer.android.com/reference/kotlin/java/util/UUID.html)): [AuthToken](../-auth-token/index.md)
9 | More info
10 |
11 |
12 | Fetches a new authentication token and decodes it into AuthToken.
13 |
14 |
15 |
16 | ## Parameters
17 |
18 | androidJvm
19 |
20 | | Name| Summary|
21 | |---|---|
22 | | appId|
Speechly application ID to use for authentication.
23 | | deviceId|
Speechly device ID to use for authentication.
24 |
25 |
26 |
27 |
28 |
29 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-grpc-slu-client/-companion/for-target.md:
--------------------------------------------------------------------------------
1 | //[client](../../../index.md)/[com.speechly.client.slu](../../index.md)/[GrpcSluClient](../index.md)/[Companion](index.md)/[forTarget](for-target.md)
2 |
3 |
4 |
5 | # forTarget
6 | [androidJvm]
7 | Content
8 | fun [forTarget](for-target.md)(target: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), secure: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [GrpcSluClient](../index.md)
9 | More info
10 |
11 |
12 | Constructs a new client that connects to specified API endpoint.
13 |
14 |
15 |
16 | ## Parameters
17 |
18 | androidJvm
19 |
20 | | Name| Summary|
21 | |---|---|
22 | | target|
the address of the API endpoint to connect to, e.g. "api.speechly.com"
23 | | secure|
whether to use secured (TLS) or plaintext connection
24 |
25 |
26 |
27 |
28 |
29 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.identity/-caching-identity-service/-caching-identity-service.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.identity](../index.md)/[CachingIdentityService](index.md)/[CachingIdentityService](-caching-identity-service.md)
2 |
3 |
4 |
5 | # CachingIdentityService
6 | [androidJvm]
7 | Content
8 | fun [CachingIdentityService](-caching-identity-service.md)(baseService: [IdentityService](../-identity-service/index.md))
9 | More info
10 |
11 |
12 | ## Parameters
13 |
14 | androidJvm
15 |
16 | | Name| Summary|
17 | |---|---|
18 | | baseService|
an IdentityService implementation used for fetching tokens in case of cache miss
19 | | cacheService|
an implementation of PersistentCache that is used for storing cached tokens
20 |
21 |
22 |
23 |
24 |
25 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.identity/-basic-identity-service/authenticate.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.identity](../index.md)/[BasicIdentityService](index.md)/[authenticate](authenticate.md)
2 |
3 |
4 |
5 | # authenticate
6 | [androidJvm]
7 | Content
8 | open suspend override fun [authenticate](authenticate.md)(appId: [UUID](https://developer.android.com/reference/kotlin/java/util/UUID.html), deviceId: [UUID](https://developer.android.com/reference/kotlin/java/util/UUID.html)): [AuthToken](../-auth-token/index.md)
9 | More info
10 |
11 |
12 | Fetches a new authentication token and decodes it into AuthToken.
13 |
14 |
15 |
16 | ## Parameters
17 |
18 | androidJvm
19 |
20 | | Name| Summary|
21 | |---|---|
22 | | appId|
Speechly application ID to use for authentication.
23 | | deviceId|
Speechly device ID to use for authentication.
24 |
25 |
26 |
27 |
28 |
29 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.cache/-shared-preferences-cache/store-string.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.cache](../index.md)/[SharedPreferencesCache](index.md)/[storeString](store-string.md)
2 |
3 |
4 |
5 | # storeString
6 | [androidJvm]
7 | Content
8 | open override fun [storeString](store-string.md)(key: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
9 | More info
10 |
11 |
12 | Stores the string value to the cache under specified key. Returns true if the operation succeeds, false otherwise.
13 |
14 |
15 |
16 | ## Parameters
17 |
18 | androidJvm
19 |
20 | | Name| Summary|
21 | |---|---|
22 | | key|
the key to write to
23 | | value|
the value to write
24 |
25 |
26 |
27 |
28 |
29 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.identity/-caching-identity-service/authenticate.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.identity](../index.md)/[CachingIdentityService](index.md)/[authenticate](authenticate.md)
2 |
3 |
4 |
5 | # authenticate
6 | [androidJvm]
7 | Content
8 | open suspend override fun [authenticate](authenticate.md)(appId: [UUID](https://developer.android.com/reference/kotlin/java/util/UUID.html), deviceId: [UUID](https://developer.android.com/reference/kotlin/java/util/UUID.html)): [AuthToken](../-auth-token/index.md)
9 | More info
10 |
11 |
12 | Fetches a new authentication token and decodes it into AuthToken.
13 |
14 |
15 |
16 | ## Parameters
17 |
18 | androidJvm
19 |
20 | | Name| Summary|
21 | |---|---|
22 | | appId|
Speechly application ID to use for authentication.
23 | | deviceId|
Speechly device ID to use for authentication.
24 |
25 |
26 |
27 |
28 |
29 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.identity/-grpc-identity-client/-companion/for-target.md:
--------------------------------------------------------------------------------
1 | //[client](../../../index.md)/[com.speechly.client.identity](../../index.md)/[GrpcIdentityClient](../index.md)/[Companion](index.md)/[forTarget](for-target.md)
2 |
3 |
4 |
5 | # forTarget
6 | [androidJvm]
7 | Content
8 | fun [forTarget](for-target.md)(target: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), secure: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [GrpcIdentityClient](../index.md)
9 | More info
10 |
11 |
12 | Constructs a new client that connects to specified API endpoint.
13 |
14 |
15 |
16 | ## Parameters
17 |
18 | androidJvm
19 |
20 | | Name| Summary|
21 | |---|---|
22 | | target|
the address of the API endpoint to connect to, e.g. "api.speechly.com"
23 | | secure|
whether to use secured (TLS) or plaintext connection
24 |
25 |
26 |
27 |
28 |
29 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.identity/-basic-identity-service/-companion/for-target.md:
--------------------------------------------------------------------------------
1 | //[client](../../../index.md)/[com.speechly.client.identity](../../index.md)/[BasicIdentityService](../index.md)/[Companion](index.md)/[forTarget](for-target.md)
2 |
3 |
4 |
5 | # forTarget
6 | [androidJvm]
7 | Content
8 | fun [forTarget](for-target.md)(target: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = "api.speechly.com", secure: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = true): [BasicIdentityService](../index.md)
9 | More info
10 |
11 |
12 | Creates a new identity service using default gRPC client implementation.
13 |
14 |
15 |
16 | ## Parameters
17 |
18 | androidJvm
19 |
20 | | Name| Summary|
21 | |---|---|
22 | | target|
the address of the API endpoint to connect to, e.g. "api.speechly.com"
23 | | secure|
whether to use secured (TLS) or plaintext connection
24 |
25 |
26 |
27 |
28 |
29 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.identity/-caching-identity-service/-companion/for-target.md:
--------------------------------------------------------------------------------
1 | //[client](../../../index.md)/[com.speechly.client.identity](../../index.md)/[CachingIdentityService](../index.md)/[Companion](index.md)/[forTarget](for-target.md)
2 |
3 |
4 |
5 | # forTarget
6 | [androidJvm]
7 | Content
8 | fun [forTarget](for-target.md)(target: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = "api.speechly.com", secure: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = true): [CachingIdentityService](../index.md)
9 | More info
10 |
11 |
12 | Creates a new identity service using default gRPC client implementation.
13 |
14 |
15 |
16 | ## Parameters
17 |
18 | androidJvm
19 |
20 | | Name| Summary|
21 | |---|---|
22 | | target|
the address of the API endpoint to connect to, e.g. "api.speechly.com"
23 | | secure|
whether to use secured (TLS) or plaintext connection
24 |
25 |
26 |
27 |
28 |
29 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.cache/-shared-preferences-cache/-companion/from-context.md:
--------------------------------------------------------------------------------
1 | //[client](../../../index.md)/[com.speechly.client.cache](../../index.md)/[SharedPreferencesCache](../index.md)/[Companion](index.md)/[fromContext](from-context.md)
2 |
3 |
4 |
5 | # fromContext
6 | [androidJvm]
7 | Content
8 | fun [fromContext](from-context.md)(context: [Context](https://developer.android.com/reference/kotlin/android/content/Context.html), preferenceFileName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = PREFERENCE_FILE_KEY): [SharedPreferencesCache](../index.md)
9 | More info
10 |
11 |
12 | Creates a new shared preferences cache from a context instance.
13 |
14 |
15 |
16 | ## Parameters
17 |
18 | androidJvm
19 |
20 | | Name| Summary|
21 | |---|---|
22 | | context|
the context to get preferences from
23 | | preferenceFileName|
the file name to use for storing preferences
24 |
25 |
26 |
27 |
28 |
29 |
--------------------------------------------------------------------------------
/client-test/src/main/res/layout/activity_main.xml:
--------------------------------------------------------------------------------
1 |
2 |
8 |
12 |
13 |
20 |
21 |
22 |
29 |
38 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-slu-client/stream.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[SluClient](index.md)/[stream](stream.md)
2 |
3 |
4 |
5 | # stream
6 | [androidJvm]
7 | Content
8 | abstract fun [stream](stream.md)(authToken: [AuthToken](../../com.speechly.client.identity/-auth-token/index.md), streamConfig: [StreamConfig](../-stream-config/index.md), audioFlow: Flow<[ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)>): [SluStream](../-slu-stream/index.md)
9 | More info
10 |
11 |
12 | Creates a new SLU stream between the client and the API.
13 |
14 |
15 |
16 | ## Parameters
17 |
18 | androidJvm
19 |
20 | | Name| Summary|
21 | |---|---|
22 | | authToken|
token to use for authenticating to the API.
23 | | streamConfig|
the configuration of the SLU stream.
24 |
25 |
26 |
27 |
28 |
29 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-grpc-slu-client/stream.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[GrpcSluClient](index.md)/[stream](stream.md)
2 |
3 |
4 |
5 | # stream
6 | [androidJvm]
7 | Content
8 | @ExperimentalCoroutinesApi()
9 |
10 | open override fun [stream](stream.md)(authToken: [AuthToken](../../com.speechly.client.identity/-auth-token/index.md), streamConfig: [StreamConfig](../-stream-config/index.md), audioFlow: Flow<[ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)>): [GrpcSluStream](../-grpc-slu-stream/index.md)
11 | More info
12 |
13 |
14 | Creates a new SLU stream between the client and the API.
15 |
16 |
17 |
18 | ## Parameters
19 |
20 | androidJvm
21 |
22 | | Name| Summary|
23 | |---|---|
24 | | authToken|
token to use for authenticating to the API.
25 | | streamConfig|
the configuration of the SLU stream.
26 |
27 |
28 |
29 |
30 |
31 |
--------------------------------------------------------------------------------
/client-test/src/main/res/drawable-v24/ic_launcher_foreground.xml:
--------------------------------------------------------------------------------
1 |
7 |
8 |
9 |
15 |
18 |
21 |
22 |
23 |
24 |
30 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.identity/-auth-token/validate.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.identity](../index.md)/[AuthToken](index.md)/[validate](validate.md)
2 |
3 |
4 |
5 | # validate
6 | [androidJvm]
7 | Content
8 | fun [validate](validate.md)(appId: [UUID](https://developer.android.com/reference/kotlin/java/util/UUID.html), deviceId: [UUID](https://developer.android.com/reference/kotlin/java/util/UUID.html), expiresAt: [Instant](https://developer.android.com/reference/kotlin/java/time/Instant.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
9 | More info
10 |
11 |
12 | Validates the token against provided identifiers and expiration date. Returns true if the token is valid, false otherwise.
13 |
14 |
15 |
16 | ## Parameters
17 |
18 | androidJvm
19 |
20 | | Name| Summary|
21 | |---|---|
22 | | appId|
Speechly application ID to verify against.
23 | | deviceId|
Speechly device ID to verify against.
24 | | expiresAt|
timestamp to check expiration against.
25 |
26 |
27 |
28 |
29 |
30 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-stream-config/-stream-config.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[StreamConfig](index.md)/[StreamConfig](-stream-config.md)
2 |
3 |
4 |
5 | # StreamConfig
6 | [androidJvm]
7 | Content
8 | fun [StreamConfig](-stream-config.md)(channelCount: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), sampleRateHertz: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), languageCode: [StreamConfig.LanguageCode](-language-code/index.md))
9 | More info
10 |
11 |
12 | ## Parameters
13 |
14 | androidJvm
15 |
16 | | Name| Summary|
17 | |---|---|
18 | | channelCount|
the number of channels contained in the audio data (e.g. 1 is mono, 2 is stereo, etc.).
19 | | sampleRateHertz|
the sample rate of the audio, in Hertz.
20 | | languageCode|
the language of the audio, as BCP-47 compatible language tag.
21 |
22 |
23 |
24 |
25 |
26 |
--------------------------------------------------------------------------------
/client-test/build.gradle:
--------------------------------------------------------------------------------
1 | plugins {
2 | id 'com.android.application'
3 | id 'kotlin-android'
4 | }
5 |
6 | android {
7 | compileSdkVersion 31
8 | buildToolsVersion "30.0.3"
9 |
10 | defaultConfig {
11 | applicationId "com.speechly.clienttest"
12 | minSdkVersion 26
13 | targetSdkVersion 30
14 | versionCode 1
15 | versionName "1.0"
16 |
17 | testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
18 | }
19 |
20 | buildTypes {
21 | release {
22 | minifyEnabled false
23 | proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
24 | }
25 | }
26 | compileOptions {
27 | sourceCompatibility JavaVersion.VERSION_1_8
28 | targetCompatibility JavaVersion.VERSION_1_8
29 | }
30 | kotlinOptions {
31 | jvmTarget = '1.8'
32 | }
33 |
34 | sourceSets["main"].java.srcDir("src/main/kotlin")
35 | }
36 |
37 | dependencies {
38 | implementation project(':android-client')
39 | implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
40 | implementation "org.jetbrains.kotlinx:kotlinx-coroutines-core:$kotlin_coroutines_version"
41 | implementation 'androidx.core:core-ktx:1.7.0'
42 | implementation 'androidx.appcompat:appcompat:1.4.1'
43 | implementation 'com.google.android.material:material:1.5.0'
44 | implementation 'androidx.constraintlayout:constraintlayout:2.1.3'
45 | implementation 'androidx.navigation:navigation-fragment-ktx:2.3.5'
46 | implementation 'androidx.navigation:navigation-ui-ktx:2.3.5'
47 | implementation 'com.android.support.constraint:constraint-layout:2.0.4'
48 | implementation 'androidx.constraintlayout:constraintlayout:2.1.3'
49 | implementation "androidx.cardview:cardview:1.0.0"
50 | implementation 'androidx.recyclerview:recyclerview:1.2.1'
51 | testImplementation 'junit:junit:4.13.2'
52 | androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.2'
53 | }
54 |
--------------------------------------------------------------------------------
/android-client/src/main/kotlin/com/speechly/ui/SpeechlyButton.kt:
--------------------------------------------------------------------------------
1 | package com.speechly.ui
2 |
3 | import android.animation.ValueAnimator
4 | import android.content.Context
5 | import android.util.AttributeSet
6 | import android.view.MotionEvent
7 | import android.view.View
8 | import androidx.appcompat.widget.AppCompatImageView
9 | import com.speechly.client.R
10 |
11 | class SpeechlyButton(context: Context, attr: AttributeSet) : AppCompatImageView(context, attr) {
12 |
13 | var listener: OnTouchListener? = null
14 | private var started: Boolean = false
15 |
16 | init {
17 | super.setOnTouchListener(object : View.OnTouchListener {
18 | override fun onTouch(v: View?, event: MotionEvent?): Boolean {
19 | listenForTouch(v, event)
20 | return true
21 | }
22 | })
23 |
24 | setBackgroundResource(R.drawable.ic_micframe)
25 | setImageResource(R.drawable.ic_start)
26 | }
27 |
28 | fun listenForTouch(v: View?, event: MotionEvent?) {
29 | when (event?.action) {
30 | MotionEvent.ACTION_DOWN -> {
31 | if (!started) {
32 | setImageResource(R.drawable.ic_mic)
33 | started = true
34 | }
35 | scaleUp()
36 | }
37 |
38 | MotionEvent.ACTION_UP -> {
39 | scaleDown()
40 | }
41 | }
42 | this.listener?.onTouch(v, event)
43 | }
44 |
45 | override fun setOnTouchListener(listener: OnTouchListener) {
46 | this.listener = listener
47 | }
48 |
49 | fun scaleUp() {
50 | val va = ValueAnimator.ofFloat(1f, 1.2f)
51 | va.duration = 500L
52 | va.addUpdateListener { animation ->
53 | setScaleX(animation.animatedValue as Float)
54 | setScaleY(animation.animatedValue as Float)
55 | }
56 | va.start()
57 | }
58 |
59 | fun scaleDown() {
60 | val va = ValueAnimator.ofFloat(1.2f, 1f)
61 | va.duration = 300L
62 | va.addUpdateListener { animation ->
63 | setScaleX(animation.animatedValue as Float)
64 | setScaleY(animation.animatedValue as Float)
65 | }
66 | va.start()
67 | }
68 | }
--------------------------------------------------------------------------------
/android-client/src/main/kotlin/com/speechly/client/slu/Segment.kt:
--------------------------------------------------------------------------------
1 | package com.speechly.client.slu
2 |
3 | /**
4 | * The smallest component of SLU API, defined by an intent.
5 | */
6 | class Segment(
7 | val contextId: String,
8 | val segmentId: Int
9 | ) {
10 | var isFinal: Boolean = false
11 | var intent: Intent? = null
12 | var entities: MutableMap = mutableMapOf()
13 | var words: MutableMap = mutableMapOf()
14 |
15 | fun updateTranscript(word: Word): Unit {
16 | if (!this.isFinal || word.isFinal) {
17 | this.words.set(word.index, word)
18 | }
19 | }
20 |
21 | fun updateTranscripts(transcripts: MutableList): Unit {
22 | transcripts.forEach({ transcript ->
23 | // Only accept tentative words if the segment is tentative.
24 | if (!this.isFinal || transcript.word.isFinal) {
25 | this.words.set(transcript.word.index, transcript.word)
26 | }
27 | })
28 | }
29 |
30 | fun updateEntity(entity: Entity): Unit {
31 | if (!this.isFinal || entity.isFinal) {
32 | this.entities.set("${entity.startPosition}:${entity.endPosition}", entity)
33 | }
34 | }
35 |
36 | fun updateEntities(entities: MutableList): Unit {
37 | entities.forEach( { entity ->
38 | // Only accept tentative entities if the segment is tentative.
39 | if (!this.isFinal || entity.isFinal) {
40 | this.entities.set("${entity.startPosition}:${entity.endPosition}", entity)
41 | }
42 | })
43 | }
44 |
45 | fun updateIntent(intent: Intent): Unit {
46 | if (!this.isFinal || intent.isFinal) {
47 | this.intent = intent
48 | }
49 | }
50 |
51 | fun finalize() {
52 | words = words.filter { (_, word) -> word.isFinal }.toMutableMap()
53 | entities.forEach {(key, entity) -> if (!entity.isFinal) entities.remove(key)}
54 | if (this.intent?.isFinal == false) {
55 | this.intent?.intent = ""
56 | this.intent?.isFinal = true
57 | }
58 | isFinal = true
59 | }
60 |
61 | fun getEntityByType(type: String): Entity? {
62 | return this.entities.values.filter{it.type == type}.firstOrNull()
63 | }
64 | }
--------------------------------------------------------------------------------
/android-client/src/main/kotlin/com/speechly/client/device/DeviceIdProvider.kt:
--------------------------------------------------------------------------------
1 | package com.speechly.client.device
2 |
3 | import com.speechly.client.cache.CacheService
4 | import java.util.UUID
5 |
6 | /**
7 | * Speechly device identifier type.
8 | *
9 | * Device identifiers are required by the SLU API for configuring the recognition model.
10 | *
11 | * A valid device identifier is represented by an UUIDv4 string.
12 | */
13 | typealias DeviceId = UUID
14 |
15 | /**
16 | * An interface that provides Speechly device identifiers to be consumed by the SLU API client.
17 | */
18 | interface DeviceIdProvider {
19 | /**
20 | * Returns the identifier of the device.
21 | * Must not throw exceptions.
22 | */
23 | fun getDeviceId(): DeviceId
24 | }
25 |
26 | /**
27 | * A device id provider implementation that returns a random UUIDv4.
28 | */
29 | class RandomIdProvider : DeviceIdProvider {
30 | override fun getDeviceId(): DeviceId {
31 | return UUID.randomUUID()
32 | }
33 | }
34 |
35 | /**
36 | * A device id provider implementation that uses a persistent cache for storing and retrieving
37 | * device identifiers generated by a base device id provider.
38 | *
39 | * By default it uses a random id provider for generating a new id in case of a cache miss.
40 | */
41 | class CachingIdProvider(
42 | private val baseProvider: DeviceIdProvider = RandomIdProvider()
43 | ) : DeviceIdProvider {
44 |
45 | var cacheService: CacheService? = null
46 |
47 | private val cacheKey = "speechly-device-id"
48 |
49 | override fun getDeviceId(): DeviceId {
50 | return this.loadFromCache() ?: this.storeAndReturn()
51 | }
52 |
53 | private fun loadFromCache(): DeviceId? {
54 | val cached = this.cacheService?.loadString(this.cacheKey) ?: return null
55 |
56 | return try {
57 | UUID.fromString(cached)
58 | } catch (_: Throwable) {
59 | null
60 | }
61 | }
62 |
63 | private fun storeAndReturn(): DeviceId {
64 | val id = this.baseProvider.getDeviceId()
65 |
66 | // `storeString` returns false if the write operation has failed.
67 | // Current we choose to ignore failed writes and instead re-generate the id on the next call.
68 | this.cacheService?.storeString(this.cacheKey, id.toString())
69 |
70 | return id
71 | }
72 | }
--------------------------------------------------------------------------------
/client-test/src/main/kotlin/com/speechly/clienttest/RepoRecyclerAdapter.kt:
--------------------------------------------------------------------------------
1 | package com.speechly.clienttest
2 |
3 | import android.view.LayoutInflater
4 | import android.view.View
5 | import android.view.ViewGroup
6 | import android.widget.ImageView
7 | import android.widget.TextView
8 | import androidx.recyclerview.widget.RecyclerView
9 |
10 | class RepoRecyclerAdapter : RecyclerView.Adapter() {
11 |
12 | private var items: List = ArrayList()
13 |
14 | override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): RepoViewHolder {
15 | val itemView = LayoutInflater.from(parent.context).inflate(R.layout.repo,
16 | parent, false)
17 | return RepoViewHolder(itemView)
18 | }
19 |
20 | override fun onBindViewHolder(holder: RecyclerView.ViewHolder, position: Int) {
21 | if (holder is RepoViewHolder) {
22 | holder.bind(items.get(position))
23 | }
24 | }
25 |
26 | override fun getItemCount() = items.size
27 |
28 | fun submitList(repoList: List){
29 | items = repoList
30 | }
31 |
32 | class RepoViewHolder(itemView: View) : RecyclerView.ViewHolder(itemView) {
33 | val imageView: ImageView = itemView.findViewById(R.id.imageView)
34 | val textView1: TextView = itemView.findViewById(R.id.textView1)
35 | val textView3: TextView = itemView.findViewById(R.id.textView3)
36 | val textView5: TextView = itemView.findViewById(R.id.textView5)
37 | val textView6: TextView = itemView.findViewById(R.id.textView6)
38 | val textView7: TextView = itemView.findViewById(R.id.textView7)
39 |
40 | fun bind(repo: Repo) {
41 | imageView.setImageResource(repo.iconId)
42 | textView1.text = repo.organisation
43 | textView3.text = repo.name
44 | textView5.text = formatNumber(repo.forks)
45 | textView6.text = formatNumber(repo.stars)
46 | textView7.text = formatNumber(repo.followers)
47 | }
48 |
49 | fun formatNumber(value: Int): String {
50 | if (value < 1000) {
51 | return value.toString()
52 | }
53 |
54 | if (value < 10000) {
55 | return "${(value / 1000.0).toString()}K"
56 | }
57 |
58 | return "${(value / 1000).toString()}K"
59 | }
60 | }
61 | }
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.device/index.md:
--------------------------------------------------------------------------------
1 | //[client](../index.md)/[com.speechly.client.device](index.md)
2 |
3 |
4 |
5 | # Package com.speechly.client.device
6 |
7 |
8 | ## Types
9 |
10 | | Name| Summary|
11 | |---|---|
12 | | [CachingIdProvider](-caching-id-provider/index.md)| [androidJvm]
Content
class [CachingIdProvider](-caching-id-provider/index.md)(**baseProvider**: [DeviceIdProvider](-device-id-provider/index.md)) : [DeviceIdProvider](-device-id-provider/index.md)
More info
A device id provider implementation that uses a persistent cache for storing and retrieving device identifiers generated by a base device id provider.
13 | | [DeviceId](index.md#%5Bcom.speechly.client.device%2FDeviceId%2F%2F%2FPointingToDeclaration%2F%5D%2FClasslikes%2F-126307046)| [androidJvm]
Content
typealias [DeviceId](index.md#%5Bcom.speechly.client.device%2FDeviceId%2F%2F%2FPointingToDeclaration%2F%5D%2FClasslikes%2F-126307046) = [UUID](https://developer.android.com/reference/kotlin/java/util/UUID.html)
More info
Speechly device identifier type.
Device identifiers are required by the SLU API for configuring the recognition model.
A valid device identifier is represented by an UUIDv4 string.
14 | | [DeviceIdProvider](-device-id-provider/index.md)| [androidJvm]
Content
interface [DeviceIdProvider](-device-id-provider/index.md)
More info
An interface that provides Speechly device identifiers to be consumed by the SLU API client.
15 | | [RandomIdProvider](-random-id-provider/index.md)| [androidJvm]
Content
class [RandomIdProvider](-random-id-provider/index.md) : [DeviceIdProvider](-device-id-provider/index.md)
More info
A device id provider implementation that returns a random UUIDv4.
16 |
17 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.identity/-auth-token/-companion/index.md:
--------------------------------------------------------------------------------
1 | //[client](../../../index.md)/[com.speechly.client.identity](../../index.md)/[AuthToken](../index.md)/[Companion](index.md)
2 |
3 |
4 |
5 | # Companion
6 | [androidJvm] object [Companion](index.md)
7 |
8 |
9 | ## Functions
10 |
11 | | Name| Summary|
12 | |---|---|
13 | | [equals](../../../com.speechly.ui/-speechly-button/index.md#%5Bkotlin%2FAny%2Fequals%2F%23kotlin.Any%3F%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)| [androidJvm]
Content
open operator fun [equals](../../../com.speechly.ui/-speechly-button/index.md#%5Bkotlin%2FAny%2Fequals%2F%23kotlin.Any%3F%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)(other: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
14 | | [fromJWT](from-j-w-t.md)| [androidJvm]
Content
fun [fromJWT](from-j-w-t.md)(jwt: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [AuthToken](../index.md)
More info
Parses the authentication token from its string representation.
15 | | [hashCode](../../../com.speechly.ui/-speechly-button/index.md#%5Bkotlin%2FAny%2FhashCode%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)| [androidJvm]
Content
open fun [hashCode](../../../com.speechly.ui/-speechly-button/index.md#%5Bkotlin%2FAny%2FhashCode%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
16 | | [toString](../../../com.speechly.client.speech/-client/-companion/index.md#%5Bkotlin%2FAny%2FtoString%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)| [androidJvm]
Content
open fun [toString](../../../com.speechly.client.speech/-client/-companion/index.md#%5Bkotlin%2FAny%2FtoString%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
17 |
18 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.speech/index.md:
--------------------------------------------------------------------------------
1 | //[client](../index.md)/[com.speechly.client.speech](index.md)
2 |
3 |
4 |
5 | # Package com.speechly.client.speech
6 |
7 |
8 | ## Types
9 |
10 | | Name| Summary|
11 | |---|---|
12 | | [ApiClient](-api-client/index.md)| [androidJvm]
Content
interface [ApiClient](-api-client/index.md) : [Closeable](https://developer.android.com/reference/kotlin/java/io/Closeable.html)
More info
A client for Speechly Spoken Language Understanding (SLU) API.
13 | | [AudioRecorder](-audio-recorder/index.md)| [androidJvm]
Content
class [AudioRecorder](-audio-recorder/index.md)(**activity**: [AppCompatActivity](https://developer.android.com/reference/kotlin/androidx/appcompat/app/AppCompatActivity.html), **sampleRate**: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
14 | | [Client](-client/index.md)| [androidJvm]
Content
class [Client](-client/index.md)(**appId**: [UUID](https://developer.android.com/reference/kotlin/java/util/UUID.html), **language**: [StreamConfig.LanguageCode](../com.speechly.client.slu/-stream-config/-language-code/index.md), **deviceIdProvider**: [DeviceIdProvider](../com.speechly.client.device/-device-id-provider/index.md), **identityService**: [IdentityService](../com.speechly.client.identity/-identity-service/index.md), **sluClient**: [GrpcSluClient](../com.speechly.client.slu/-grpc-slu-client/index.md), **audioRecorder**: [AudioRecorder](-audio-recorder/index.md), **activity**: [AppCompatActivity](https://developer.android.com/reference/kotlin/androidx/appcompat/app/AppCompatActivity.html)) : [ApiClient](-api-client/index.md)
15 | | [NoActiveStreamException](-no-active-stream-exception/index.md)| [androidJvm]
Content
class [NoActiveStreamException](-no-active-stream-exception/index.md) : [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)
More info
This class represents an exception indicating that there is no active stream to interact with.
16 |
17 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-intent/-companion/index.md:
--------------------------------------------------------------------------------
1 | //[client](../../../index.md)/[com.speechly.client.slu](../../index.md)/[Intent](../index.md)/[Companion](index.md)
2 |
3 |
4 |
5 | # Companion
6 | [androidJvm] object [Companion](index.md)
7 |
8 |
9 | ## Functions
10 |
11 | | Name| Summary|
12 | |---|---|
13 | | [equals](../../../com.speechly.ui/-speechly-button/index.md#%5Bkotlin%2FAny%2Fequals%2F%23kotlin.Any%3F%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)| [androidJvm]
Content
open operator fun [equals](../../../com.speechly.ui/-speechly-button/index.md#%5Bkotlin%2FAny%2Fequals%2F%23kotlin.Any%3F%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)(other: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
14 | | [fromSluReponse](from-slu-reponse.md)| [androidJvm]
Content
fun [fromSluReponse](from-slu-reponse.md)(response: Slu.SLUResponse, isFinal: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = true): [Intent](../index.md)
15 | | [hashCode](../../../com.speechly.ui/-speechly-button/index.md#%5Bkotlin%2FAny%2FhashCode%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)| [androidJvm]
Content
open fun [hashCode](../../../com.speechly.ui/-speechly-button/index.md#%5Bkotlin%2FAny%2FhashCode%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
16 | | [toString](../../../com.speechly.client.speech/-client/-companion/index.md#%5Bkotlin%2FAny%2FtoString%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)| [androidJvm]
Content
open fun [toString](../../../com.speechly.client.speech/-client/-companion/index.md#%5Bkotlin%2FAny%2FtoString%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
17 |
18 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-grpc-slu-stream/-grpc-slu-stream.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[GrpcSluStream](index.md)/[GrpcSluStream](-grpc-slu-stream.md)
2 |
3 |
4 |
5 | # GrpcSluStream
6 | [androidJvm]
7 | Content
8 | fun [GrpcSluStream](-grpc-slu-stream.md)(clientStub: SLUGrpcKt.SLUCoroutineStub, streamConfig: [StreamConfig](../-stream-config/index.md), audioFlow: Flow<[ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)>)
9 | More info
10 |
11 |
12 | ## Parameters
13 |
14 | androidJvm
15 |
16 | | Name| Summary|
17 | |---|---|
18 | | clientStub|
client stub for the API, with metadata attached.
19 | | streamConfig|
SLU configuration to use for this stream.
20 | | requestChannel|
(optional) channel to use for sending the audio chunks.
21 | | responseChannel|
(optional) channel to use for receiving responses.
22 |
23 |
24 |
25 |
26 |
27 |
--------------------------------------------------------------------------------
/android-client/src/main/kotlin/com/speechly/client/cache/CacheService.kt:
--------------------------------------------------------------------------------
1 | package com.speechly.client.cache
2 |
3 | import android.content.Context
4 | import android.content.SharedPreferences
5 |
6 | /**
7 | * An interface for a persistent cache for storing key-value pairs in the device storage.
8 | */
9 | interface CacheService {
10 | /**
11 | * Reads the specified key from the cache and returns the data as string.
12 | * If the key is missing or the data cannot be parsed into a string, returns null.
13 | * @param key the key to read from
14 | */
15 | fun loadString(key: String): String?
16 |
17 | /**
18 | * Stores the string value to the cache under specified key.
19 | * Returns true if the operation succeeds, false otherwise.
20 | * @param key the key to write to
21 | * @param value the value to write
22 | */
23 | fun storeString(key: String, value: String): Boolean
24 | }
25 |
26 | /**
27 | * An implementation of persistent cache that uses Android shared preferences as the storage.
28 | * See more at https://developer.android.com/reference/kotlin/android/content/SharedPreferences.
29 | *
30 | * This implementation is not safe to share by multiple applications on the same device.
31 | * A user must ensure that preference files are not shared by multiple applications
32 | * by providing app-specific file names.
33 | */
34 | class SharedPreferencesCache(private val preferences: SharedPreferences) : CacheService {
35 | companion object {
36 | const val PREFERENCE_FILE_KEY = "speechly.preferences.cache"
37 |
38 | /**
39 | * Creates a new shared preferences cache from a context instance.
40 | * @param context the context to get preferences from
41 | * @param preferenceFileName the file name to use for storing preferences
42 | */
43 | fun fromContext(
44 | context: Context,
45 | preferenceFileName: String = PREFERENCE_FILE_KEY
46 | ): SharedPreferencesCache {
47 | return SharedPreferencesCache(
48 | context.getSharedPreferences(preferenceFileName, Context.MODE_PRIVATE)
49 | )
50 | }
51 | }
52 |
53 | override fun loadString(key: String): String? {
54 | return try {
55 | this.preferences.getString(key, null)
56 | } catch (_: Throwable) {
57 | null
58 | }
59 | }
60 |
61 | override fun storeString(key: String, value: String): Boolean {
62 | return try {
63 | with (this.preferences.edit()) {
64 | putString(key, value)
65 | apply()
66 | }
67 |
68 | true
69 | } catch (_: Throwable) {
70 | false
71 | }
72 | }
73 | }
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-grpc-slu-client/-companion/index.md:
--------------------------------------------------------------------------------
1 | //[client](../../../index.md)/[com.speechly.client.slu](../../index.md)/[GrpcSluClient](../index.md)/[Companion](index.md)
2 |
3 |
4 |
5 | # Companion
6 | [androidJvm] object [Companion](index.md)
7 |
8 |
9 | ## Functions
10 |
11 | | Name| Summary|
12 | |---|---|
13 | | [equals](../../../com.speechly.ui/-speechly-button/index.md#%5Bkotlin%2FAny%2Fequals%2F%23kotlin.Any%3F%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)| [androidJvm]
Content
open operator fun [equals](../../../com.speechly.ui/-speechly-button/index.md#%5Bkotlin%2FAny%2Fequals%2F%23kotlin.Any%3F%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)(other: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
14 | | [forTarget](for-target.md)| [androidJvm]
Content
fun [forTarget](for-target.md)(target: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), secure: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [GrpcSluClient](../index.md)
More info
Constructs a new client that connects to specified API endpoint.
15 | | [hashCode](../../../com.speechly.ui/-speechly-button/index.md#%5Bkotlin%2FAny%2FhashCode%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)| [androidJvm]
Content
open fun [hashCode](../../../com.speechly.ui/-speechly-button/index.md#%5Bkotlin%2FAny%2FhashCode%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
16 | | [toString](../../../com.speechly.client.speech/-client/-companion/index.md#%5Bkotlin%2FAny%2FtoString%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)| [androidJvm]
Content
open fun [toString](../../../com.speechly.client.speech/-client/-companion/index.md#%5Bkotlin%2FAny%2FtoString%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
17 |
18 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.identity/-grpc-identity-client/-companion/index.md:
--------------------------------------------------------------------------------
1 | //[client](../../../index.md)/[com.speechly.client.identity](../../index.md)/[GrpcIdentityClient](../index.md)/[Companion](index.md)
2 |
3 |
4 |
5 | # Companion
6 | [androidJvm] object [Companion](index.md)
7 |
8 |
9 | ## Functions
10 |
11 | | Name| Summary|
12 | |---|---|
13 | | [equals](../../../com.speechly.ui/-speechly-button/index.md#%5Bkotlin%2FAny%2Fequals%2F%23kotlin.Any%3F%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)| [androidJvm]
Content
open operator fun [equals](../../../com.speechly.ui/-speechly-button/index.md#%5Bkotlin%2FAny%2Fequals%2F%23kotlin.Any%3F%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)(other: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
14 | | [forTarget](for-target.md)| [androidJvm]
Content
fun [forTarget](for-target.md)(target: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), secure: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [GrpcIdentityClient](../index.md)
More info
Constructs a new client that connects to specified API endpoint.
15 | | [hashCode](../../../com.speechly.ui/-speechly-button/index.md#%5Bkotlin%2FAny%2FhashCode%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)| [androidJvm]
Content
open fun [hashCode](../../../com.speechly.ui/-speechly-button/index.md#%5Bkotlin%2FAny%2FhashCode%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
16 | | [toString](../../../com.speechly.client.speech/-client/-companion/index.md#%5Bkotlin%2FAny%2FtoString%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)| [androidJvm]
Content
open fun [toString](../../../com.speechly.client.speech/-client/-companion/index.md#%5Bkotlin%2FAny%2FtoString%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
17 |
18 |
--------------------------------------------------------------------------------
/android-client/src/main/kotlin/com/speechly/client/slu/SluClient.kt:
--------------------------------------------------------------------------------
1 | package com.speechly.client.slu
2 |
3 | import com.speechly.api.slu.v1.SLUGrpcKt
4 | import com.speechly.client.grpc.buildChannel
5 | import com.speechly.client.identity.AuthToken
6 | import io.grpc.ManagedChannel
7 | import io.grpc.Metadata
8 | import io.grpc.stub.MetadataUtils
9 | import java.io.Closeable
10 | import java.util.concurrent.TimeUnit
11 | import kotlinx.coroutines.flow.Flow
12 | import java.util.UUID
13 | import kotlinx.coroutines.ExperimentalCoroutinesApi as ExperimentalCoroutinesApi
14 |
15 | /**
16 | * An interface representing a client for Speechly SLU API.
17 | */
18 | interface SluClient : Closeable {
19 | /**
20 | * Creates a new SLU stream between the client and the API.
21 | *
22 | * @param authToken token to use for authenticating to the API.
23 | * @param streamConfig the configuration of the SLU stream.
24 | */
25 | @ExperimentalCoroutinesApi
26 | fun stream(authToken: AuthToken, streamConfig: StreamConfig, audioFlow: Flow, contextAppId: UUID?): SluStream
27 | }
28 |
29 | /**
30 | * A client for Speechly gRPC SLU API.
31 | *
32 | * @param channel the gRPC channel to use for sending requests to the API
33 | * @param shutdownTimeout the timeout for closing the gRPC channel
34 | */
35 | class GrpcSluClient(
36 | private val channel: ManagedChannel,
37 | private val shutdownTimeout: Long = 5
38 | ) : SluClient {
39 | private val clientStub = SLUGrpcKt.SLUCoroutineStub(this.channel)
40 |
41 | companion object {
42 | /**
43 | * Constructs a new client that connects to specified API endpoint.
44 | *
45 | * @param target the address of the API endpoint to connect to, e.g. "api.speechly.com"
46 | * @param secure whether to use secured (TLS) or plaintext connection
47 | */
48 | fun forTarget(target: String, secure: Boolean): GrpcSluClient {
49 | return GrpcSluClient(
50 | buildChannel(target, secure)
51 | )
52 | }
53 | }
54 |
55 | @ExperimentalCoroutinesApi
56 | override fun stream(authToken: AuthToken, streamConfig: StreamConfig, audioFlow: Flow, contextAppId: UUID?): GrpcSluStream {
57 | val metadata = Metadata()
58 | metadata.put(
59 | Metadata.Key.of("Authorization", Metadata.ASCII_STRING_MARSHALLER),
60 | "Bearer ${authToken.tokenString}"
61 | )
62 |
63 | return GrpcSluStream(
64 | MetadataUtils.attachHeaders(this.clientStub, metadata),
65 | streamConfig,
66 | audioFlow,
67 | contextAppId
68 | )
69 | }
70 |
71 | override fun close() {
72 | this.channel.shutdown().awaitTermination(this.shutdownTimeout, TimeUnit.SECONDS)
73 | }
74 | }
75 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.identity/-basic-identity-service/-companion/index.md:
--------------------------------------------------------------------------------
1 | //[client](../../../index.md)/[com.speechly.client.identity](../../index.md)/[BasicIdentityService](../index.md)/[Companion](index.md)
2 |
3 |
4 |
5 | # Companion
6 | [androidJvm] object [Companion](index.md)
7 |
8 |
9 | ## Functions
10 |
11 | | Name| Summary|
12 | |---|---|
13 | | [equals](../../../com.speechly.ui/-speechly-button/index.md#%5Bkotlin%2FAny%2Fequals%2F%23kotlin.Any%3F%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)| [androidJvm]
Content
open operator fun [equals](../../../com.speechly.ui/-speechly-button/index.md#%5Bkotlin%2FAny%2Fequals%2F%23kotlin.Any%3F%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)(other: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
14 | | [forTarget](for-target.md)| [androidJvm]
Content
fun [forTarget](for-target.md)(target: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = "api.speechly.com", secure: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = true): [BasicIdentityService](../index.md)
More info
Creates a new identity service using default gRPC client implementation.
15 | | [hashCode](../../../com.speechly.ui/-speechly-button/index.md#%5Bkotlin%2FAny%2FhashCode%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)| [androidJvm]
Content
open fun [hashCode](../../../com.speechly.ui/-speechly-button/index.md#%5Bkotlin%2FAny%2FhashCode%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
16 | | [toString](../../../com.speechly.client.speech/-client/-companion/index.md#%5Bkotlin%2FAny%2FtoString%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)| [androidJvm]
Content
open fun [toString](../../../com.speechly.client.speech/-client/-companion/index.md#%5Bkotlin%2FAny%2FtoString%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
17 |
18 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.identity/-caching-identity-service/-companion/index.md:
--------------------------------------------------------------------------------
1 | //[client](../../../index.md)/[com.speechly.client.identity](../../index.md)/[CachingIdentityService](../index.md)/[Companion](index.md)
2 |
3 |
4 |
5 | # Companion
6 | [androidJvm] object [Companion](index.md)
7 |
8 |
9 | ## Functions
10 |
11 | | Name| Summary|
12 | |---|---|
13 | | [equals](../../../com.speechly.ui/-speechly-button/index.md#%5Bkotlin%2FAny%2Fequals%2F%23kotlin.Any%3F%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)| [androidJvm]
Content
open operator fun [equals](../../../com.speechly.ui/-speechly-button/index.md#%5Bkotlin%2FAny%2Fequals%2F%23kotlin.Any%3F%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)(other: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
14 | | [forTarget](for-target.md)| [androidJvm]
Content
fun [forTarget](for-target.md)(target: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = "api.speechly.com", secure: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = true): [CachingIdentityService](../index.md)
More info
Creates a new identity service using default gRPC client implementation.
15 | | [hashCode](../../../com.speechly.ui/-speechly-button/index.md#%5Bkotlin%2FAny%2FhashCode%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)| [androidJvm]
Content
open fun [hashCode](../../../com.speechly.ui/-speechly-button/index.md#%5Bkotlin%2FAny%2FhashCode%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
16 | | [toString](../../../com.speechly.client.speech/-client/-companion/index.md#%5Bkotlin%2FAny%2FtoString%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)| [androidJvm]
Content
open fun [toString](../../../com.speechly.client.speech/-client/-companion/index.md#%5Bkotlin%2FAny%2FtoString%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
17 |
18 |
--------------------------------------------------------------------------------
/docs/client/com.speechly.client.slu/-slu-stream/index.md:
--------------------------------------------------------------------------------
1 | //[client](../../index.md)/[com.speechly.client.slu](../index.md)/[SluStream](index.md)
2 |
3 |
4 |
5 | # SluStream
6 | [androidJvm] interface [SluStream](index.md) : [Closeable](https://developer.android.com/reference/kotlin/java/io/Closeable.html)
7 |
8 | An interface representing a single SLU stream between the client and Speechly SLU API.
9 |
10 |
11 |
12 |
13 | ## Functions
14 |
15 | | Name| Summary|
16 | |---|---|
17 | | [close](../../com.speechly.client.speech/-api-client/index.md#%5Bjava.io%2FCloseable%2Fclose%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)| [androidJvm]
Content
abstract override fun [close](../../com.speechly.client.speech/-api-client/index.md#%5Bjava.io%2FCloseable%2Fclose%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)()
18 | | [equals](../../com.speechly.ui/-speechly-button/index.md#%5Bkotlin%2FAny%2Fequals%2F%23kotlin.Any%3F%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)| [androidJvm]
Content
open operator fun [equals](../../com.speechly.ui/-speechly-button/index.md#%5Bkotlin%2FAny%2Fequals%2F%23kotlin.Any%3F%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)(other: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
19 | | [hashCode](../../com.speechly.ui/-speechly-button/index.md#%5Bkotlin%2FAny%2FhashCode%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)| [androidJvm]
Content
open fun [hashCode](../../com.speechly.ui/-speechly-button/index.md#%5Bkotlin%2FAny%2FhashCode%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
20 | | [toString](../../com.speechly.client.speech/-client/-companion/index.md#%5Bkotlin%2FAny%2FtoString%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)| [androidJvm]
Content
open fun [toString](../../com.speechly.client.speech/-client/-companion/index.md#%5Bkotlin%2FAny%2FtoString%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-126307046)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
21 |
22 |
23 | ## Inheritors
24 |
25 | | Name|
26 | |---|
27 | | [GrpcSluStream](../-grpc-slu-stream/index.md)
28 |
29 |
--------------------------------------------------------------------------------
/android-client/src/main/kotlin/com/speechly/client/identity/IdentityClient.kt:
--------------------------------------------------------------------------------
1 | package com.speechly.client.identity
2 |
3 | import com.speechly.identity.v2.LoginRequest
4 | import com.speechly.identity.v2.LoginResponse
5 | import com.speechly.client.grpc.buildChannel
6 | import com.speechly.identity.v2.IdentityAPIGrpcKt
7 | import io.grpc.ManagedChannel
8 | import io.grpc.Status
9 | import java.io.Closeable
10 | import java.util.concurrent.TimeUnit
11 |
12 | /**
13 | * An interface representing a client for Speechly Identity API.
14 | */
15 | interface IdentityClient : Closeable {
16 | /**
17 | * Performs a login against the API using provided request.
18 | *
19 | * @param request the login request that is sent to the API.
20 | */
21 | suspend fun login(request: LoginRequest): LoginResponse
22 | }
23 |
24 | /**
25 | * An exception that represents an invalid appId rejected by the API.
26 | */
27 | class InvalidApplicationException(message: String): Throwable(message)
28 |
29 | /**
30 | * An exception that represents a general authentication error returned by the API.
31 | */
32 | class AuthenticationException(message: String): Throwable(message)
33 |
34 |
35 | /**
36 | * A client for Speechly gRPC Identity API.
37 | *
38 | * @param channel the gRPC channel to use for sending requests to the API
39 | * @param shutdownTimeout the timeout for closing the gRPC channel
40 | */
41 | class GrpcIdentityClient(
42 | private val channel: ManagedChannel,
43 | private val shutdownTimeout: Long = 5
44 | ) : IdentityClient {
45 | private val clientStub = IdentityAPIGrpcKt.IdentityAPICoroutineStub(this.channel)
46 |
47 | companion object {
48 | /**
49 | * Constructs a new client that connects to specified API endpoint.
50 | *
51 | * @param target the address of the API endpoint to connect to, e.g. "api.speechly.com"
52 | * @param secure whether to use secured (TLS) or plaintext connection
53 | */
54 | fun forTarget(target: String, secure: Boolean): GrpcIdentityClient {
55 | return GrpcIdentityClient(
56 | buildChannel(target, secure)
57 | )
58 | }
59 | }
60 |
61 | override suspend fun login(request: LoginRequest): LoginResponse {
62 | val response: LoginResponse
63 |
64 | try {
65 | response = this.clientStub.login(request)
66 | } catch (t: Throwable) {
67 | when (val s = Status.fromThrowable(t)) {
68 | Status.PERMISSION_DENIED -> throw AuthenticationException(s.description ?: "Authentication failed")
69 | Status.NOT_FOUND -> throw InvalidApplicationException(s.description ?: "Invalid appId")
70 | else -> throw t
71 | }
72 | }
73 |
74 | return response
75 | }
76 |
77 | override fun close() {
78 | this.channel.shutdown().awaitTermination(this.shutdownTimeout, TimeUnit.SECONDS)
79 | }
80 | }
81 |
--------------------------------------------------------------------------------