RealtimeAPIClient
Constructors
Methods
addEventListener(event: | , callback: Function
): void
Adds a handler for the specified Inworld.RealtimeAPIEvents or Inworld.Events event.
Parameters
event:
Event class (i.e., Inworld.RealtimeAPIEvents.SessionCreated).
callback:
Function
Handler function. A single parameter is passed - object with event information.
Returns
type:
void
clearMediaBuffer(parameters: ): void
Clears the Inworld WebSocket media buffer.
Parameters
parameters:
OptionalOptional. Media buffer clearing parameters.
Returns
type:
void
close(): void
Closes the Inworld connection (over WebSocket) or connection attempt.
Returns
type:
void
conversationItemCreate(parameters: Object
): void
Add a conversation item (message, function call result, etc.). https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket
Parameters
parameters:
Object
Event payload object.
Returns
type:
void
conversationItemDelete(parameters: Object
): void
Delete a conversation item by ID. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket
Parameters
parameters:
Object
Event payload object.
Returns
type:
void
conversationItemRetrieve(parameters: Object
): void
Retrieve a conversation item by ID. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket
Parameters
parameters:
Object
Event payload object.
Returns
type:
void
conversationItemTruncate(parameters: Object
): void
Truncate an assistant message's audio. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket
Parameters
parameters:
Object
Event payload object.
Returns
type:
void
id(): string
Returns the RealtimeAPIClient id.
Returns
type:
string
inputAudioBufferAppend(parameters: Object
): void
Append audio bytes to the input buffer. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket
Parameters
parameters:
Object
Event payload object.
Returns
type:
void
inputAudioBufferClear(parameters: Object
): void
Discard all audio in the input buffer. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket
Parameters
parameters:
Object
Event payload object.
Returns
type:
void
inputAudioBufferCommit(parameters: Object
): void
Commit the buffered audio as a user message. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket
Parameters
parameters:
Object
Event payload object.
Returns
type:
void
outputAudioBufferClear(parameters: Object
): void
Clear the server's output audio buffer, stopping playback. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket
Parameters
parameters:
Object
Event payload object.
Returns
type:
void
removeEventListener(event: | , callback: Function
): void
Removes a handler for the specified Inworld.RealtimeAPIEvents or Inworld.Events event.
Parameters
event:
Event class (i.e., Inworld.RealtimeAPIEvents.SessionCreated).
callback:
Function
OptionalOptional. Handler function. If not specified, all handler functions are removed.
Returns
type:
void
responseCancel(parameters: Object
): void
Cancel an in-progress response. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket
Parameters
parameters:
Object
Event payload object.
Returns
type:
void
responseCreate(parameters: Object
): void
Trigger a model response. The server streams back response events. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket
Parameters
parameters:
Object
Event payload object.
Returns
type:
void
sendMediaTo(mediaUnit: , parameters: ): void
Starts sending media from the Inworld (via WebSocket) to the media unit.
Parameters
mediaUnit:
Media unit that receives media.
parameters:
OptionalOptional interaction parameters.
Returns
type:
void
sessionUpdate(parameters: Object
): void
Update the session configuration. The server responds with a session.updated event. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket
Parameters
parameters:
Object
Event payload object.
Returns
type:
void
stopMediaTo(mediaUnit: ): void
Stops sending media from the Inworld (via WebSocket) to the media unit.
Parameters
mediaUnit:
Media unit that stops receiving media.
Returns
type:
void
webSocketId(): string
Returns the Inworld WebSocket id.
Returns
type:
string