ServerEventType Class

Package:
com.azure.ai.voicelive.models
Maven Artifact:
com.azure:azure-ai-voicelive:1.1.0

public final class ServerEventType
extends ExpandableStringEnum<ServerEventType>

Server event types used in VoiceLive protocol.

Field Summary

Modifier and Type Field and Description
static final ServerEventType CONVERSATION_ITEM_CREATED

Static value conversation.item.created for ServerEventType.
static final ServerEventType CONVERSATION_ITEM_DELETED

Static value conversation.item.deleted for ServerEventType.
static final ServerEventType CONVERSATION_ITEM_INPUT_AUDIO_TRANSCRIPTION_COMPLETED

Static value conversation.item.input_audio_transcription.completed for ServerEventType.
static final ServerEventType CONVERSATION_ITEM_INPUT_AUDIO_TRANSCRIPTION_DELTA

Static value conversation.item.input_audio_transcription.delta for ServerEventType.
static final ServerEventType CONVERSATION_ITEM_INPUT_AUDIO_TRANSCRIPTION_FAILED

Static value conversation.item.input_audio_transcription.failed for ServerEventType.
static final ServerEventType CONVERSATION_ITEM_RETRIEVED

Static value conversation.item.retrieved for ServerEventType.
static final ServerEventType CONVERSATION_ITEM_TRUNCATED

Static value conversation.item.truncated for ServerEventType.
static final ServerEventType ERROR

Static value error for ServerEventType.
static final ServerEventType INPUT_AUDIO_BUFFER_CLEARED

Static value input_audio_buffer.cleared for ServerEventType.
static final ServerEventType INPUT_AUDIO_BUFFER_COMMITTED

Static value input_audio_buffer.committed for ServerEventType.
static final ServerEventType INPUT_AUDIO_BUFFER_SPEECH_STARTED

Static value input_audio_buffer.speech_started for ServerEventType.
static final ServerEventType INPUT_AUDIO_BUFFER_SPEECH_STOPPED

Static value input_audio_buffer.speech_stopped for ServerEventType.
static final ServerEventType MCP_LIST_TOOLS_COMPLETED

Static value mcp_list_tools.completed for ServerEventType.
static final ServerEventType MCP_LIST_TOOLS_FAILED

Static value mcp_list_tools.failed for ServerEventType.
static final ServerEventType MCP_LIST_TOOLS_IN_PROGRESS

Static value mcp_list_tools.in_progress for ServerEventType.
static final ServerEventType OUTPUT_AUDIO_BUFFER_CLEARED

Output audio buffer has been cleared.
static final ServerEventType RESPONSE_ANIMATION_BLENDSHAPES_DELTA

Static value response.animation_blendshapes.delta for ServerEventType.
static final ServerEventType RESPONSE_ANIMATION_BLENDSHAPES_DONE

Static value response.animation_blendshapes.done for ServerEventType.
static final ServerEventType RESPONSE_ANIMATION_VISEME_DELTA

Static value response.animation_viseme.delta for ServerEventType.
static final ServerEventType RESPONSE_ANIMATION_VISEME_DONE

Static value response.animation_viseme.done for ServerEventType.
static final ServerEventType RESPONSE_AUDIO_DELTA

Static value response.audio.delta for ServerEventType.
static final ServerEventType RESPONSE_AUDIO_DONE

Static value response.audio.done for ServerEventType.
static final ServerEventType RESPONSE_AUDIO_TIMESTAMP_DELTA

Static value response.audio_timestamp.delta for ServerEventType.
static final ServerEventType RESPONSE_AUDIO_TIMESTAMP_DONE

Static value response.audio_timestamp.done for ServerEventType.
static final ServerEventType RESPONSE_AUDIO_TRANSCRIPT_ANNOTATION_ADDED

Audio transcript annotation added.
static final ServerEventType RESPONSE_AUDIO_TRANSCRIPT_DELTA

Static value response.audio_transcript.delta for ServerEventType.
static final ServerEventType RESPONSE_AUDIO_TRANSCRIPT_DONE

Static value response.audio_transcript.done for ServerEventType.
static final ServerEventType RESPONSE_CONTENT_PART_ADDED

Static value response.content_part.added for ServerEventType.
static final ServerEventType RESPONSE_CONTENT_PART_DONE

Static value response.content_part.done for ServerEventType.
static final ServerEventType RESPONSE_CREATED

Static value response.created for ServerEventType.
static final ServerEventType RESPONSE_DONE

Static value response.done for ServerEventType.
static final ServerEventType RESPONSE_FILE_SEARCH_CALL_COMPLETED

File search call completed.
static final ServerEventType RESPONSE_FILE_SEARCH_CALL_IN_PROGRESS

File search call is in progress.
static final ServerEventType RESPONSE_FILE_SEARCH_CALL_SEARCHING

File search call is searching.
static final ServerEventType RESPONSE_FUNCTION_CALL_ARGUMENTS_DELTA

Static value response.function_call_arguments.delta for ServerEventType.
static final ServerEventType RESPONSE_FUNCTION_CALL_ARGUMENTS_DONE

Static value response.function_call_arguments.done for ServerEventType.
static final ServerEventType RESPONSE_INVOCATION_DELTA

Invocation passthrough delta from hosted agent.
static final ServerEventType RESPONSE_MCP_CALL_ARGUMENTS_DELTA

Static value response.mcp_call_arguments.delta for ServerEventType.
static final ServerEventType RESPONSE_MCP_CALL_ARGUMENTS_DONE

Static value response.mcp_call_arguments.done for ServerEventType.
static final ServerEventType RESPONSE_MCP_CALL_COMPLETED

Static value response.mcp_call.completed for ServerEventType.
static final ServerEventType RESPONSE_MCP_CALL_FAILED

Static value response.mcp_call.failed for ServerEventType.
static final ServerEventType RESPONSE_MCP_CALL_IN_PROGRESS

Static value response.mcp_call.in_progress for ServerEventType.
static final ServerEventType RESPONSE_OUTPUT_ITEM_ADDED

Static value response.output_item.added for ServerEventType.
static final ServerEventType RESPONSE_OUTPUT_ITEM_DONE

Static value response.output_item.done for ServerEventType.
static final ServerEventType RESPONSE_TEXT_DELTA

Static value response.text.delta for ServerEventType.
static final ServerEventType RESPONSE_TEXT_DONE

Static value response.text.done for ServerEventType.
static final ServerEventType RESPONSE_VIDEO_DELTA

Delta update for avatar video frames.
static final ServerEventType RESPONSE_WEB_SEARCH_CALL_COMPLETED

Web search call completed.
static final ServerEventType RESPONSE_WEB_SEARCH_CALL_IN_PROGRESS

Web search call is in progress.
static final ServerEventType RESPONSE_WEB_SEARCH_CALL_SEARCHING

Web search call is searching.
static final ServerEventType SESSION_AVATAR_CONNECTING

Static value session.avatar.connecting for ServerEventType.
static final ServerEventType SESSION_AVATAR_SWITCH_TO_IDLE

Avatar switches to idle state.
static final ServerEventType SESSION_AVATAR_SWITCH_TO_SPEAKING

Avatar switches to speaking state.
static final ServerEventType SESSION_CREATED

Static value session.created for ServerEventType.
static final ServerEventType SESSION_UPDATED

Static value session.updated for ServerEventType.
static final ServerEventType WARNING

Static value warning for ServerEventType.

Constructor Summary

Constructor Description
ServerEventType()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of ServerEventType value.

Method Summary

Modifier and Type Method and Description
static ServerEventType fromString(String name)

Creates or finds a ServerEventType from its string representation.
static Collection<ServerEventType> values()

Gets known ServerEventType values.

Methods inherited from ExpandableStringEnum

<T>fromString <T>values equals getValue hashCode toString

Methods inherited from java.lang.Object

clone finalize getClass notify notifyAll wait wait wait

Field Details

CONVERSATION_ITEM_CREATED

public static final ServerEventType CONVERSATION_ITEM_CREATED

Static value conversation.item.created for ServerEventType.

CONVERSATION_ITEM_DELETED

public static final ServerEventType CONVERSATION_ITEM_DELETED

Static value conversation.item.deleted for ServerEventType.

CONVERSATION_ITEM_INPUT_AUDIO_TRANSCRIPTION_COMPLETED

public static final ServerEventType CONVERSATION_ITEM_INPUT_AUDIO_TRANSCRIPTION_COMPLETED

Static value conversation.item.input_audio_transcription.completed for ServerEventType.

CONVERSATION_ITEM_INPUT_AUDIO_TRANSCRIPTION_DELTA

public static final ServerEventType CONVERSATION_ITEM_INPUT_AUDIO_TRANSCRIPTION_DELTA

Static value conversation.item.input_audio_transcription.delta for ServerEventType.

CONVERSATION_ITEM_INPUT_AUDIO_TRANSCRIPTION_FAILED

public static final ServerEventType CONVERSATION_ITEM_INPUT_AUDIO_TRANSCRIPTION_FAILED

Static value conversation.item.input_audio_transcription.failed for ServerEventType.

CONVERSATION_ITEM_RETRIEVED

public static final ServerEventType CONVERSATION_ITEM_RETRIEVED

Static value conversation.item.retrieved for ServerEventType.

CONVERSATION_ITEM_TRUNCATED

public static final ServerEventType CONVERSATION_ITEM_TRUNCATED

Static value conversation.item.truncated for ServerEventType.

ERROR

public static final ServerEventType ERROR

Static value error for ServerEventType.

INPUT_AUDIO_BUFFER_CLEARED

public static final ServerEventType INPUT_AUDIO_BUFFER_CLEARED

Static value input_audio_buffer.cleared for ServerEventType.

INPUT_AUDIO_BUFFER_COMMITTED

public static final ServerEventType INPUT_AUDIO_BUFFER_COMMITTED

Static value input_audio_buffer.committed for ServerEventType.

INPUT_AUDIO_BUFFER_SPEECH_STARTED

public static final ServerEventType INPUT_AUDIO_BUFFER_SPEECH_STARTED

Static value input_audio_buffer.speech_started for ServerEventType.

INPUT_AUDIO_BUFFER_SPEECH_STOPPED

public static final ServerEventType INPUT_AUDIO_BUFFER_SPEECH_STOPPED

Static value input_audio_buffer.speech_stopped for ServerEventType.

MCP_LIST_TOOLS_COMPLETED

public static final ServerEventType MCP_LIST_TOOLS_COMPLETED

Static value mcp_list_tools.completed for ServerEventType.

MCP_LIST_TOOLS_FAILED

public static final ServerEventType MCP_LIST_TOOLS_FAILED

Static value mcp_list_tools.failed for ServerEventType.

MCP_LIST_TOOLS_IN_PROGRESS

public static final ServerEventType MCP_LIST_TOOLS_IN_PROGRESS

Static value mcp_list_tools.in_progress for ServerEventType.

OUTPUT_AUDIO_BUFFER_CLEARED

public static final ServerEventType OUTPUT_AUDIO_BUFFER_CLEARED

Output audio buffer has been cleared.

RESPONSE_ANIMATION_BLENDSHAPES_DELTA

public static final ServerEventType RESPONSE_ANIMATION_BLENDSHAPES_DELTA

Static value response.animation_blendshapes.delta for ServerEventType.

RESPONSE_ANIMATION_BLENDSHAPES_DONE

public static final ServerEventType RESPONSE_ANIMATION_BLENDSHAPES_DONE

Static value response.animation_blendshapes.done for ServerEventType.

RESPONSE_ANIMATION_VISEME_DELTA

public static final ServerEventType RESPONSE_ANIMATION_VISEME_DELTA

Static value response.animation_viseme.delta for ServerEventType.

RESPONSE_ANIMATION_VISEME_DONE

public static final ServerEventType RESPONSE_ANIMATION_VISEME_DONE

Static value response.animation_viseme.done for ServerEventType.

RESPONSE_AUDIO_DELTA

public static final ServerEventType RESPONSE_AUDIO_DELTA

Static value response.audio.delta for ServerEventType.

RESPONSE_AUDIO_DONE

public static final ServerEventType RESPONSE_AUDIO_DONE

Static value response.audio.done for ServerEventType.

RESPONSE_AUDIO_TIMESTAMP_DELTA

public static final ServerEventType RESPONSE_AUDIO_TIMESTAMP_DELTA

Static value response.audio_timestamp.delta for ServerEventType.

RESPONSE_AUDIO_TIMESTAMP_DONE

public static final ServerEventType RESPONSE_AUDIO_TIMESTAMP_DONE

Static value response.audio_timestamp.done for ServerEventType.

RESPONSE_AUDIO_TRANSCRIPT_ANNOTATION_ADDED

public static final ServerEventType RESPONSE_AUDIO_TRANSCRIPT_ANNOTATION_ADDED

Audio transcript annotation added.

RESPONSE_AUDIO_TRANSCRIPT_DELTA

public static final ServerEventType RESPONSE_AUDIO_TRANSCRIPT_DELTA

Static value response.audio_transcript.delta for ServerEventType.

RESPONSE_AUDIO_TRANSCRIPT_DONE

public static final ServerEventType RESPONSE_AUDIO_TRANSCRIPT_DONE

Static value response.audio_transcript.done for ServerEventType.

RESPONSE_CONTENT_PART_ADDED

public static final ServerEventType RESPONSE_CONTENT_PART_ADDED

Static value response.content_part.added for ServerEventType.

RESPONSE_CONTENT_PART_DONE

public static final ServerEventType RESPONSE_CONTENT_PART_DONE

Static value response.content_part.done for ServerEventType.

RESPONSE_CREATED

public static final ServerEventType RESPONSE_CREATED

Static value response.created for ServerEventType.

RESPONSE_DONE

public static final ServerEventType RESPONSE_DONE

Static value response.done for ServerEventType.

RESPONSE_FILE_SEARCH_CALL_COMPLETED

public static final ServerEventType RESPONSE_FILE_SEARCH_CALL_COMPLETED

File search call completed.

RESPONSE_FILE_SEARCH_CALL_IN_PROGRESS

public static final ServerEventType RESPONSE_FILE_SEARCH_CALL_IN_PROGRESS

File search call is in progress.

RESPONSE_FILE_SEARCH_CALL_SEARCHING

public static final ServerEventType RESPONSE_FILE_SEARCH_CALL_SEARCHING

File search call is searching.

RESPONSE_FUNCTION_CALL_ARGUMENTS_DELTA

public static final ServerEventType RESPONSE_FUNCTION_CALL_ARGUMENTS_DELTA

Static value response.function_call_arguments.delta for ServerEventType.

RESPONSE_FUNCTION_CALL_ARGUMENTS_DONE

public static final ServerEventType RESPONSE_FUNCTION_CALL_ARGUMENTS_DONE

Static value response.function_call_arguments.done for ServerEventType.

RESPONSE_INVOCATION_DELTA

public static final ServerEventType RESPONSE_INVOCATION_DELTA

Invocation passthrough delta from hosted agent.

RESPONSE_MCP_CALL_ARGUMENTS_DELTA

public static final ServerEventType RESPONSE_MCP_CALL_ARGUMENTS_DELTA

Static value response.mcp_call_arguments.delta for ServerEventType.

RESPONSE_MCP_CALL_ARGUMENTS_DONE

public static final ServerEventType RESPONSE_MCP_CALL_ARGUMENTS_DONE

Static value response.mcp_call_arguments.done for ServerEventType.

RESPONSE_MCP_CALL_COMPLETED

public static final ServerEventType RESPONSE_MCP_CALL_COMPLETED

Static value response.mcp_call.completed for ServerEventType.

RESPONSE_MCP_CALL_FAILED

public static final ServerEventType RESPONSE_MCP_CALL_FAILED

Static value response.mcp_call.failed for ServerEventType.

RESPONSE_MCP_CALL_IN_PROGRESS

public static final ServerEventType RESPONSE_MCP_CALL_IN_PROGRESS

Static value response.mcp_call.in_progress for ServerEventType.

RESPONSE_OUTPUT_ITEM_ADDED

public static final ServerEventType RESPONSE_OUTPUT_ITEM_ADDED

Static value response.output_item.added for ServerEventType.

RESPONSE_OUTPUT_ITEM_DONE

public static final ServerEventType RESPONSE_OUTPUT_ITEM_DONE

Static value response.output_item.done for ServerEventType.

RESPONSE_TEXT_DELTA

public static final ServerEventType RESPONSE_TEXT_DELTA

Static value response.text.delta for ServerEventType.

RESPONSE_TEXT_DONE

public static final ServerEventType RESPONSE_TEXT_DONE

Static value response.text.done for ServerEventType.

RESPONSE_VIDEO_DELTA

public static final ServerEventType RESPONSE_VIDEO_DELTA

Delta update for avatar video frames.

RESPONSE_WEB_SEARCH_CALL_COMPLETED

public static final ServerEventType RESPONSE_WEB_SEARCH_CALL_COMPLETED

Web search call completed.

RESPONSE_WEB_SEARCH_CALL_IN_PROGRESS

public static final ServerEventType RESPONSE_WEB_SEARCH_CALL_IN_PROGRESS

Web search call is in progress.

RESPONSE_WEB_SEARCH_CALL_SEARCHING

public static final ServerEventType RESPONSE_WEB_SEARCH_CALL_SEARCHING

Web search call is searching.

SESSION_AVATAR_CONNECTING

public static final ServerEventType SESSION_AVATAR_CONNECTING

Static value session.avatar.connecting for ServerEventType.

SESSION_AVATAR_SWITCH_TO_IDLE

public static final ServerEventType SESSION_AVATAR_SWITCH_TO_IDLE

Avatar switches to idle state.

SESSION_AVATAR_SWITCH_TO_SPEAKING

public static final ServerEventType SESSION_AVATAR_SWITCH_TO_SPEAKING

Avatar switches to speaking state.

SESSION_CREATED

public static final ServerEventType SESSION_CREATED

Static value session.created for ServerEventType.

SESSION_UPDATED

public static final ServerEventType SESSION_UPDATED

Static value session.updated for ServerEventType.

WARNING

public static final ServerEventType WARNING

Static value warning for ServerEventType.

Constructor Details

ServerEventType

@Deprecated
public ServerEventType()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of ServerEventType value.

Method Details

fromString

public static ServerEventType fromString(String name)

Creates or finds a ServerEventType from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding ServerEventType.

values

public static Collection<ServerEventType> values()

Gets known ServerEventType values.

Returns:

known ServerEventType values.

Applies to