Class AnamClient

Constructors

constructor

new AnamClient(sessionToken, personaConfig, options?): AnamClient
Parameters
- sessionToken: undefined | string
- personaConfig: PersonaConfig
- Optional options: AnamClientOptions
Returns AnamClient

Properties

`Private` _isStreaming

_isStreaming: boolean = false

`Private` apiClient

apiClient: CoreApiRestClient

`Protected` apiKey

apiKey: undefined | string

`Private` clientOptions

clientOptions: undefined | AnamClientOptions

`Private` inputAudioState

inputAudioState: InputAudioState = ...

`Private` internalEventEmitter

internalEventEmitter: InternalEventEmitter

`Protected` messageHistoryClient

messageHistoryClient: MessageHistoryClient

`Private` personaConfig

personaConfig: undefined | PersonaConfig

`Private` publicEventEmitter

publicEventEmitter: PublicEventEmitter

`Private` sessionId

sessionId: null | string = null

`Protected` sessionToken

sessionToken: undefined | string

`Private` streamingClient

streamingClient: null | StreamingClient = null

Methods

addListener

addListener<K>(event, callback): void
Event handling
Type Parameters
- K extends AnamEvent
Parameters
- event: K
- callback: EventCallbacks[K]
Returns void

`Private` buildStartSessionOptionsForClient

buildStartSessionOptionsForClient(): undefined | StartSessionOptions
Returns undefined | StartSessionOptions

createTalkMessageStream

createTalkMessageStream(correlationId?): TalkMessageStream
Parameters
- Optional correlationId: string
Returns TalkMessageStream

getInputAudioState

getInputAudioState(): InputAudioState
Returns InputAudioState

getPersonaConfig

getPersonaConfig(): undefined | PersonaConfig
Returns undefined | PersonaConfig

isStreaming

isStreaming(): boolean
Returns boolean

muteInputAudio

muteInputAudio(): InputAudioState
Returns InputAudioState

removeListener

removeListener<K>(event, callback): void
Type Parameters
- K extends AnamEvent
Parameters
- event: K
- callback: EventCallbacks[K]
Returns void

sendDataMessage

sendDataMessage(message): void
Parameters
- message: string
Returns void

setPersonaConfig

setPersonaConfig(personaConfig): void
Parameters
- personaConfig: PersonaConfig
Returns void

`Private` startSession

startSession(userProvidedAudioStream?): Promise<string>
Parameters
- Optional userProvidedAudioStream: MediaStream
Returns Promise<string>

`Private` startSessionIfNeeded

startSessionIfNeeded(userProvidedMediaStream?): Promise<void>
Parameters
- Optional userProvidedMediaStream: MediaStream
Returns Promise<void>

stopStreaming

stopStreaming(): Promise<void>
Returns Promise<void>

stream

stream(userProvidedAudioStream?): Promise<MediaStream[]>
Parameters
- Optional userProvidedAudioStream: MediaStream
Returns Promise<MediaStream[]>

streamToVideoAndAudioElements

streamToVideoAndAudioElements(videoElementId, audioElementId, userProvidedMediaStream?): Promise<void>
Parameters
- videoElementId: string
- audioElementId: string
- Optional userProvidedMediaStream: MediaStream
Returns Promise<void>

talk

talk(content): Promise<void>
Parameters
- content: string
Returns Promise<void>

unmuteInputAudio

unmuteInputAudio(): InputAudioState
Returns InputAudioState

`Private` validateClientConfig

validateClientConfig(sessionToken, personaConfig, options?): undefined | string
Parameters
- sessionToken: undefined | string
- personaConfig: PersonaConfig
- Optional options: AnamClientOptions
Returns undefined | string