VoiceAgentAPIClient
Constructors
Methods
addEventListener(event: | , callback: Function
): void
Adds a handler for the specified QwenCloud.VoiceAgentAPIEvents or QwenCloud.Events event. Use only functions as handlers; anything except a function leads to the error and scenario termination when a handler is called.
Parameters
event:
Event class (i.e., QwenCloud.VoiceAgentAPIEvents.SessionCreated)
callback:
Function
Handler function. A single parameter is passed - object with event information
Returns
type:
void
clearMediaBuffer(parameters: ): void
Clears the Qwen Cloud WebSocket media buffer.
Parameters
parameters:
OptionalOptional. Media buffer clearing parameters
Returns
type:
void
close(): void
Closes the Qwen Cloud connection (over WebSocket) or connection attempt.
Returns
type:
void
conversationItemCreate(parameters: Object
): void
Inserts a conversation item (message, function_call, or function_call_output). https://docs.qwencloud.com/api-reference/qwen-audio-realtime/client-events#conversation-item-create
Parameters
parameters:
Object
Event parameters
Returns
type:
void
conversationItemDelete(parameters: Object
): void
Deletes a conversation item. https://docs.qwencloud.com/api-reference/qwen-audio-realtime/client-events#conversation-item-delete
Parameters
parameters:
Object
Event parameters
Returns
type:
void
conversationItemRetrieve(parameters: Object
): void
Retrieves a conversation item. Audio content is returned as a transcript. https://docs.qwencloud.com/api-reference/qwen-audio-realtime/client-events#conversation-item-retrieve
Parameters
parameters:
Object
Event parameters
Returns
type:
void
id(): string
Returns the VoiceAgentAPIClient id.
Returns
type:
string
inputAudioBufferClear(parameters: Object
): void
Clears uncommitted input audio. Push-to-talk mode only. https://docs.qwencloud.com/api-reference/qwen-audio-realtime/client-events#input-audio-buffer-clear
Parameters
parameters:
Object
OptionalOptional. Event parameters
Returns
type:
void
inputAudioBufferCommit(parameters: Object
): void
Commits the input audio buffer. Push-to-talk mode only. Does not start a response; call QwenCloud.VoiceAgentAPIClient.responseCreate after this. https://docs.qwencloud.com/api-reference/qwen-audio-realtime/client-events#input-audio-buffer-commit
Parameters
parameters:
Object
OptionalOptional. Event parameters
Returns
type:
void
removeEventListener(event: | , callback: Function
): void
Removes a handler for the specified QwenCloud.VoiceAgentAPIEvents or QwenCloud.Events event.
Parameters
event:
Event class (i.e., QwenCloud.VoiceAgentAPIEvents.SessionCreated)
callback:
Function
OptionalOptional. Handler function. If not specified, all handler functions are removed
Returns
type:
void
responseCancel(parameters: Object
): void
Cancels the response currently being generated. https://docs.qwencloud.com/api-reference/qwen-audio-realtime/client-events#response-cancel
Parameters
parameters:
Object
OptionalOptional. Event parameters
Returns
type:
void
responseCreate(parameters: Object
): void
Starts a response. Required in push-to-talk mode and after a function_call_output. Optional overrides: response.modalities, response.voice. https://docs.qwencloud.com/api-reference/qwen-audio-realtime/client-events#response-create
Parameters
parameters:
Object
OptionalOptional. Event parameters
Returns
type:
void
sendMediaTo(mediaUnit: , parameters: ): void
Starts sending media from Qwen Cloud (via WebSocket) to the media unit. Qwen Cloud works in real time.
Parameters
mediaUnit:
Media unit that receives media
parameters:
OptionalOptional interaction parameters
Returns
type:
void
sessionUpdate(parameters: Object
): void
Updates the session configuration. Send this before the first audio frame. turn_detection: null selects push-to-talk. https://docs.qwencloud.com/api-reference/qwen-audio-realtime/client-events#session-update
Parameters
parameters:
Object
Event parameters
Returns
type:
void
stopMediaTo(mediaUnit: ): void
Stops sending media from Qwen Cloud (via WebSocket) to the media unit.
Parameters
mediaUnit:
Media unit that stops receiving media
Returns
type:
void
webSocketId(): string
Returns the Qwen Cloud WebSocket id.
Returns
type:
string