All Products
Search
Document Center

:Data Structures

Last Updated:Aug 06, 2025

This topic describes the data types that are used in the Android SDK.

Data structure overview

Note

Deprecated parameters and methods exist in earlier SDK versions. We recommend that you upgrade the SDK to the latest version. For more information, see Android SDK usage guide.

Structure type

Data type

Description

Enum

ARTCAICallAgentType

AI agent type

ARTCAICallRobotState

The current state of the robot

AICallErrorCode

An error occurred during the current AI call

VoicePrintStatusCode

The status code returned by ASR

ARTCAICallSpeakingInterruptedReason

The reason why the agent's speech was interrupted

ARTCAICallAudioProfile

Audio encoding configurations

ARTCAICallAudioScenario

Audio scenario configurations

ARTCAICallVideoRenderMode

Video rendering mode

ARTCAICallVideoRotationMode

Video rotation angle

ARTCAICallVideoRenderMirrorMode

Video rendering mirror mode

ARTCAICallTurnDetectionMode

The mode to determine whether the user has finished speaking

Class

ARTCAICallConfig

Call configuration object

ARTCAICallVideoConfig

Video configuration parameters

ARTCAICallAudioConfig

Audio configuration parameters

ARTCAICallAgentTemplateConfig (Deprecated)

Configurable parameters for a call

ARTCAICallChatSyncConfig

Configuration for synchronizing agent chat history in message-based conversations

ARTCAICallAgentInfo

Agent runtime information

ARTCAICallSendTextToAgentRequest

Request object for sending text to an agent

ARTCAICallVisionCustomCaptureRequest

Request object for custom frame capturing by the visual large model

ARTCAICallVideoCanvas

Video rendering configuration object

ARTCAICallAgentConfig

Configurable parameters for a call

ARTCAICallAgentAsrConfig

Speech recognition configuration

ARTCAICallAgentTtsConfig

Speech synthesis configuration

ARTCAICallAgentLlmConfig

Large language model configuration

ARTCAICallAgentAvatarConfig

Digital human configuration

ARTCAICallAgentInterruptConfig

Interruption configuration

ARTCAICallAgentVoiceprintConfig

Voiceprint-based noise reduction configuration

ARTCAICallAgentTurnDetectionConfig

Turn detection configuration

ARTCAICallAgentVcrResult

VCR detection result

FrameMotionResult

VCR video frame detection result

PeopleCountResult

VCR people count detection result

EquipmentResult

VCR electronic device detection result

HeadMotionResult

VCR head motion detection result

ARTCAICallAgentVcrConfig

VCR configuration

ARTCAICallAgentVcrBaseConfig

Basic VCR detection configuration

ARTCAICallAgentVcrFrameMotionConfig

VCR video frame detection configuration

ARTCAICallExperimentalConfig

Experimental parameters used to control specific logic policies

Data structure details

Enum

ARTCAICallAgentType

The type of AI agent.

Enumeration name

Description

VoiceAgent

Voice-only call

AvatarAgent

Digital human call

VisionAgent

Visual understanding call

VideoAgent

Video call

ChatBot

Message-based conversation

ARTCAICallRobotState

The current state of the robot.

Enumeration name

Description

Listening

Listening

Thinking

Thinking

Speaking

Speaking

AICallErrorCode

The current AI call encountered a fault.

Enumeration name

Description

None

None

InvalidAction

Invalid API call

InvalidParams

Invalid parameters are passed to the API

StartFailed

Failed to start the call

AgentSubscriptionRequired

Failed to initiate the call. The daily free trial quota is exceeded

AgentNotFund

The agent is not found

TokenExpired

The authentication token for the call has expired

ConnectionFailed

The connection failed and the call was interrupted

KickedByUserReplace

The call cannot proceed because different devices with the same user ID have joined the same call

KickedBySystem

The call cannot proceed because the user was kicked out by the system

LocalDeviceException

The call cannot proceed due to an on-premises device issue

AgentLeaveChannel

The agent left the channel and the call ended

AgentConcurrentLimit

The number of concurrent digital human agents reaches the upper limit

AgentAudioSubscribeFailed

Failed to subscribe to the agent's audio

AiAgentAsrUnavailable

Failed to start the third-party ASR service

AvatarAgentUnavailable

The digital human service is unavailable

ChatLogNotFound

The chat history cannot be found

InternalError

Internal error

VoicePrintStatusCode

The status code returned by Automatic Speech Recognition (ASR).

Enumeration name

Description

Disable

Voiceprint-based noise reduction VAD is disabled, and AIVAD is disabled

EnableWithoutRegister

Voiceprint-based noise reduction VAD is enabled, but voiceprint registration is not complete

SpeakerRecognized

Voiceprint-based noise reduction VAD is enabled, and the main speaker is recognized

SpeakerNotRecognized

Voiceprint-based noise reduction VAD is enabled, but the main speaker is not recognized

DetectedSpeakerWithAIVad

AIVAD is enabled, and the main speaker is recognized

UndetectedSpeakerWithAIVad

AIVAD is enabled, but the main speaker is not recognized

Unknown

Unknown status

ARTCAICallSpeakingInterruptedReason

The reason why the agent's speech was interrupted.

Enumeration name

Description

UnKnown

Unknown reason

ByWorks

Interrupted because a specific interruption word was recognized

ByVoice

Interrupted because a voice interruption was recognized

ByInterruptSpeaking

Interrupted because the interruptSpeaking() API was called

BySpeechBroadCast

Interrupted by an active voice broadcast

ByLlmQuery

Interrupted by an active LLM query

ARTCAICallAudioProfile

Audio encoding configurations.

Enumeration name

Description

ARTCAICallAudioLowQualityMode

Low-quality audio mode. The default sample rate is 8,000 Hz, the number of sound channels is 1, and the maximum encoding bitrate is 12 kbps

ARTCAICallAudioBasicQualityMode

Standard-quality audio mode. The default sample rate is 16,000 Hz, the number of sound channels is 1, and the maximum encoding bitrate is 24 kbps

ARTCAICallAudioHighQualityMode

(Default) High-quality audio mode. The default sample rate is 48,000 Hz, the number of sound channels is 1, and the maximum encoding bitrate is 64 kbps

ARTCAICallAudioStereoHighQualityMode

High-quality stereo audio mode. The default sample rate is 48,000 Hz, the number of sound channels is 2, and the maximum encoding bitrate is 80 kbps

ARTCAICallAudioSuperHighQualityMode

Ultra-high-quality audio mode. The default sample rate is 48,000 Hz, the number of sound channels is 1, and the maximum encoding bitrate is 96 kbps

ARTCAICallAudioStereoSuperHighQualityMode

Ultra-high-quality stereo audio mode. The default sample rate is 48,000 Hz, the number of sound channels is 2, and the maximum encoding bitrate is 128 kbps

ARTCAICallAudioScenario

Audio scenario configurations.

Enumeration name

Description

ARTCAICallAudioSceneDefaultMode

Recommended for general Real-Time Communication scenarios

ARTCAICallAudioSceneMusicMode

Audio scenario configuration. Recommended for scenarios that require high-fidelity music quality, such as musical instrument teaching

ARTCAICallVideoRenderMode

Video rendering mode.

Enumeration name

Description

ARTCAICallVideoRenderModeAuto

Automatic mode

ARTCAICallVideoRenderModeStretch

Stretch mode. If the aspect ratio of the input video is different from the aspect ratio specified for stream ingest, the input video is stretched to the specified aspect ratio, which deforms the video

ARTCAICallVideoRenderModeFill

Crop mode. If the aspect ratio of the input video is different from the aspect ratio specified for stream ingest, the width or height of the input video is cropped, which causes content loss

ARTCAICallVideoRenderModeNoChange

No change

ARTCAICallVideoRotationMode

Video rotation angle.

Enumeration name

Description

ARTCAICallVideoRotationMode_0

0 degrees

ARTCAICallVideoRotationMode_90

90 degrees

ARTCAICallVideoRotationMode_180

180 degrees

ARTCAICallVideoRotationMode_270

270 degrees

ARTCAICallVideoRenderMirrorMode

Video rendering mirror mode.

Enumeration name

Description

ARTCAICallVideoRenderMirrorModeOnlyFront

Only the preview of the front camera is mirrored. Other views are not mirrored

ARTCAICallVideoRenderMirrorModeAllEnabled

All views are mirrored

ARTCAICallVideoRenderMirrorModeAllDisable

No views are mirrored

ARTCAICallTurnDetectionMode

The mode to determine whether the user has finished speaking.

Enumeration name

Description

ARTCAICallTurnDetectionNormalMode

Normal mode. AI is not used to determine whether the user has finished speaking based on semantics. The silence duration of ASR is used instead.

ARTCAICallTurnDetectionSemanticMode

Semantic mode. AI is used to determine whether the user has finished speaking based on contextual semantics

Class

ARTCAICallConfig

The call configuration object.

Parameter

Type

Description

agentId

String

The agent ID

agentType

ARTCAICallAgentType

The agent type. The type must be the same as the type of the agent specified by agentId. Otherwise, an error is reported when the agent is started

agentUserId

String

The user ID of the agent. If this parameter is left empty, the agent service assigns a user ID

region

String

The region where the agent service resides. The region must be the same as the region where the agent specified by agentId resides. Otherwise, an error is reported when the agent is started

userData

String

Custom user information. This information is passed to the agent

enableAudioDelayInfo

boolean

Specifies whether to enable statistics collection for conversation latency. Default value: true

agentConfig

ARTCAICallAgentConfig

The agentConfig parameter used to start a call

audioConfig

ARTCAICallAudioConfig

On-premises audio configurations

videoConfig

ARTCAICallVideoConfig

On-premises video configurations. This parameter takes effect only when agentType is set to VisionAgent or VideoAgent

chatSyncConfig

ARTCAICallChatSyncConfig

The configuration of the associated chat agent. If this parameter is specified, the call records are synchronized to the chat agent during the call

mAiCallVideoConfig

ARTCAICallVideoConfig

Video-related configurations (deprecated in versions 2.5 and later)

mAliCallAudioConfig

ARTCAICallAudioConfig

Audio-related configurations (deprecated in versions 2.5 and later)

mAiCallAgentTemplateConfig

ARTCAICallAgentTemplateConfig (Deprecated)

Configurable parameters for creating an AI audio or video call (deprecated in versions 2.5 and later)

mAiCallChatSyncConfig

ARTCAICallChatSyncConfig

Chat synchronization configuration, used to integrate the chat content of call-type agents and message-based conversation agents into a single session (deprecated in versions 2.5 and later)

ARTCAICallVideoConfig

Video configuration parameters.

Parameter

Type

Description

useHighQualityPreview

boolean

Specifies whether to use high-definition local preview

useFrontCameraDefault

boolean

Specifies whether to start the front camera by default

cameraCaptureFrameRate

int

The frame rate for camera capture

useSurfaceView

boolean

Specifies whether to use SurfaceView for rendering. If this parameter is set to false, TextureView is used for rendering

videoEncoderWidth

int

The width for video encoding

videoEncoderHeight

int

The height for video encoding

videoEncoderFrameRate

int

The frame rate for video encoding

videoEncoderBitRate

int

The bitrate for video encoding

videoEncoderKeyFrameInterval

int

The GOP interval. Unit: milliseconds

isCameraMute

boolean

Specifies whether to mute the on-premises video. Default value: false

ARTCAICallAudioConfig

Audio configuration parameters.

Parameter

Type

Description

audioProfile

ARTCAICallAudioProfile

Audio encoding configurations. The default value is ARTCAICallAudioHighQualityMode. You can set this parameter to specify the audio sample rate and the number of sound channels

audioScenario

ARTCAICallAudioScenario

Audio scenario configuration. The default value is ARTCAICallAudioSceneMusicMode. If you want to specify Bluetooth capture, you can use ARTCAICallAudioSceneDefaultMode

enableSpeaker

boolean

Specifies whether to use the speaker or the earpiece for playback. By default, the speaker is used. Set this parameter to false to switch to the earpiece

isMicrophoneOn

boolean

Specifies whether to enable the microphone. Default value: true

ARTCAICallAgentTemplateConfig (Deprecated)

Configurable parameters for a call.

Important

This type is deprecated in versions 2.5 and later. In the latest version, use ARTCAICallAgentConfig.

Parameter

Type

Description

aiAgentId

String

The agent ID. Set this parameter when you call the call interface of AICallKit to initiate an agent call.

Note

The agent ID is required and cannot be empty.

aiAgentRegion

String

The region where the agent service resides. Default value: cn-shanghai.

Note

You need to specify different regions based on the agent.

aiAgentUserId

String

The user ID corresponding to the agent. If this parameter is not set, the AI server generates a random user ID for the agent

userExtendData

String

Business extension information. A JSON string is required. This information is passed to the LLM.

aiAgentGreeting

String

The welcome message of the agent. This is a sentence that the AI agent actively says after the user joins the meeting

aiAgentUserOnlineTimeout

int

The timeout period for the agent to close the task if the user does not join the meeting. Unit: seconds. Default value: 60

aiAgentUserOfflineTimeout

int

The timeout period for the agent to close the task after the user leaves the meeting. Unit: seconds. Default value: 5

aiAgentWorkflowOverrideParams

String

Workflow override parameters. Default value: none

aiAgentBailianAppParams

String

Parameters for Alibaba Cloud Model Studio. For more information, see Pass user information to Model Studio.

aiAgentAsrMaxSilence

int

The maximum silence duration for speech recognition. Unit: milliseconds. Valid values: 200 ms to 1,200 ms. Default value: 400 ms.

aiAgentVolume

int

The volume of the agent's speech. Valid values: -1 to 100. Default value: -1. If this parameter is not specified, the adaptive volume mode recommended by Alibaba Cloud is used by default.

enableVoiceInterrupt

boolean

Specifies whether to support voice interruption. Default value: true.

enableIntelligentSegment

boolean

The switch for intelligent sentence segmentation. Default value: true.

enableVoicePrint

boolean

Specifies whether to use voiceprint recognition. Default value: false. To enable voiceprint recognition, you must turn on the enableVoicePrint switch and set voiceprintId.

voiceprintId

String

The voiceprint ID. If enableVoicePrint is set to true and voiceprintId is not empty, voiceprint-based noise reduction is enabled for the current call. If this parameter is empty, voiceprint-based noise reduction is disabled.

aiAgentVoiceId

String

The voice ID of the agent's speech.

aiAgentMaxIdleTime

int

The maximum idle waiting time for the agent. Unit: seconds. If the timeout is reached, the agent automatically goes offline. A value of -1 indicates that the agent does not exit when idle. Default value: 600s.

llmHistoryLimit

int

The maximum number of historical conversation rounds to retain for the LLM or MLLM context. If the value is less than 0, the server-side default value of 10 is used.

aiAgentGracefulShutdown

boolean

Specifies whether to perform a graceful shutdown. Default value: false.

Note

A graceful shutdown means that when the agent is stopped (for example, the call is hung up), it will finish playing the current sentence before stopping. This process can last up to 10 seconds.

enablePushToTalk

boolean

Specifies whether to enable push-to-talk mode. Default value: false

aiAgentAvatarId

String

The digital human model ID. You can specify this parameter when the agent type is AvatarAgent.

asrLanguageId

String

The ASR language ID. If this parameter is empty, the default configuration of the agent is used. Optional values:

  • zh_mandarin Chinese

  • en English

  • zh_en Chinese-English mixed

  • es Spanish

  • jp Japanese

wakeUpQuery

String

The wake-up word. This is an instruction from the user before the call starts, which the agent responds to immediately after the call starts. For example, "What's the weather like today?".

llmSystemPrompt

String

The system prompt for the LLM. For example, "You are a friendly and helpful assistant, dedicated to providing users with accurate information and advice."

Note

This is not supported if the LLM node is of the Model Studio workflow type.

interruptWords

List<String>

Trigger words for conversation interruption. For example, "Let me interrupt" or "I see".

aiAgentLlmHistoryLimit

int

The maximum number of historical conversation rounds to retain for the LLM or MLLM context. Default value: 10.

aiAgentVadLevel

int

The sensitivity parameter for AIVAD, used to resist human voice interference. Valid values: [0, 10]. The client enables AIVAD by default with a value of 3.

ARTCAICallChatSyncConfig

Configuration for synchronizing the agent's chat history in message-based conversations.

Parameter

Type

Description

sessionId

String

A unique identifier for a conversation between a user and an agent. Default value: empty.

chatBotAgentId

String

The ID of the agent associated with the message-based conversation.

receiverId

String

The receiver ID for the message-based conversation agent. This is the user's user ID.

ARTCAICallAgentInfo

Agent runtime information.

Parameter

Type

Description

agentId

String

The current agent ID.

agentType

ARTCAICallAgentType

The agent type.

agentUserId

String

The user ID of the agent in the RTC channel.

channelId

String

The RTC channel ID where the agent is located.

instanceId

String

The instance ID of the current running agent.

requestId

String

The request ID of the current running agent.

ARTCAICallSendTextToAgentRequest

The request object for sending text to an agent.

Parameter

Type

Description

text

String

The text message to ask the agent. For example, "What is this?".

ARTCAICallVisionCustomCaptureRequest

The request object for custom frame capturing by the vision model.

Parameter

Type

Description

text

String

The text parameter when requesting the multi-modal large model.

enableASR

boolean

Specifies whether to use the ASR result of the human voice as input for the large model. If true, the ASR result and the captured frame are sent to the large model. Otherwise, the text field and the captured frame are sent to the large model.

Note

This takes effect only during continuous frame capturing

isSingle

boolean

If true, it indicates single frame capturing. The custom frame capturing state is exited immediately after capturing.

If false, it indicates continuous frame capturing. The custom frame capturing state is automatically exited after the specified duration.

eachDuration

int

The interval for frame capturing (seconds).

num

int

The number of images captured each time.

duration

int

The duration for continuous frame capturing (seconds). If isSingle=true, this is ignored. Otherwise, the custom frame capturing state ends when this duration is reached.

userData

String

A JSON string for custom business information. It is passed to the large model along with the text and image frames for business processing by the enterprise.

ARTCAICallVideoCanvas

The video rendering configuration object.

Parameter

Type

Description

renderMode

ARTCAICallVideoRenderMode

The rendering mode. Default value: ARTCAICallVideoRenderModeAuto.

mirrorMode

ARTCAICallVideoRenderMirrorMode

The mirror mode. Default value: ARTCAICallVideoRenderMirrorModeOnlyFront.

rotationMode

ARTCAICallVideoRotationMode

The rotation angle. Default value: ARTCAICallVideoRotationMode_0.

zOrderOnTop

boolean

Specifies whether the SurfaceView should be displayed on a layer above all other windows. Default value: true

zOrderMediaOverlay

boolean

Specifies whether the SurfaceView should be displayed on a layer above windows such as MediaPlayer and Camera. Default value: true

ARTCAICallAgentConfig

Configurable parameters for a call.

Parameter

Type

Description

agentGreeting

String

The welcome message of the agent. If this parameter is empty, the agent's configured value is used. Maximum length: 100 characters

wakeUpQuery

String

An instruction from the user before the call starts, which the agent responds to immediately after the call starts

agentMaxIdleTime

int

The maximum idle waiting time for the agent. Unit: seconds. If the timeout is reached, the agent automatically goes offline. Default value: 600s

userOnlineTimeout

int

The timeout period for the agent to close the task if the user does not join the meeting. Default value: 60s

userOfflineTimeout

int

The timeout period for the agent to close the task after the user leaves the meeting. Default value: 5s

enablePushToTalk

boolean

Specifies whether to enable push-to-talk mode

agentGracefulShutdown

boolean

Specifies whether to perform a graceful shutdown by finishing the current sentence before stopping

volume

int

The volume of the agent's speech. Valid values: 0 to 400. Default value: 100

workflowOverrideParams

String

Workflow override parameters

enableIntelligentSegment

boolean

The switch for intelligent sentence segmentation

asrConfig

ARTCAICallAgentAsrConfig

Speech recognition configuration

ttsConfig

ARTCAICallAgentTtsConfig

Speech synthesis configuration

llmConfig

ARTCAICallAgentLlmConfig

Large language model configuration

avatarConfig

ARTCAICallAgentAvatarConfig

Digital human configuration

interruptConfig

ARTCAICallAgentInterruptConfig

Interruption configuration

voiceprintConfig

ARTCAICallAgentVoiceprintConfig

Voiceprint-based noise reduction configuration

turnDetectionConfig

ARTCAICallAgentTurnDetectionConfig

Turn detection configuration

experimentalConfig

ARTCAICallExperimentalConfig

Non-productized custom configurations

ARTCAICallAgentVcrConfig

ARTCAICallAgentVcrConfig

VCR configuration

ARTCAICallAgentAsrConfig

ASR configuration.

Parameter

Type

Description

asrLanguageId

String

The ASR language ID. If this parameter is empty, the agent's configured value is used

asrMaxSilence

int

The threshold for speech segmentation detection. If the silence duration exceeds this threshold, it is considered a sentence break. Default value: 400 ms. Valid values: 200 ms to 1,200 ms

asrHotWords

List<String>

A list of ASR hot words. Limit: up to 500 words, with each word not exceeding 10 characters

vadLevel

int

The sensitivity parameter for AIVAD. Default value: 3. Valid values: [0, 10]

customParams

String

Runtime parameters passed when self-hosting ASR. Use URL parameter format, for example, "mode=fast&sample=16000&format=wav"

vadDuration

int

The minimum duration threshold for voice activity detection, used to control the sensitivity of interruptions. A value of 0 (default) disables this feature. Valid range: 200 to 2,000 milliseconds. Common values are [200, 500], corresponding to 1-4 characters.

ARTCAICallAgentTtsConfig

Text-to-speech (TTS) configuration.

Parameter

Type

Description

agentVoiceId

String

The voice ID of the agent's speech. If this parameter is empty, the agent's configured value is used

pronunciationRules

List

An array of pronunciation rules. Up to 20 rules are supported. If nil or an empty array, no rules are used. Example:

 [
  {
      "Word": "overlap",                       // Target word
      "Pronunciation": "chongdie",              // Replacement pronunciation
      "Type": "replacement"                // Polyphone rule
  },
  {
      "Word": "action",
      "Pronunciation": "hangdong",
      "Type": "replacement"
  }
]

speechRate

double

The TTS playback speed. Supports all TTS types. Valid values: [0.5, 2.0]. Default value: 1.0. If less than 0, it is not sent to the server (the console configuration is used)

languageId

String

The TTS playback language code. This is valid when the TTS type is MiniMax

emotion

String

The TTS playback emotion type. This is valid when the TTS type is MiniMax

modelId

String

The TTS model ID. Currently, only minimax is supported. Optional values: speech-01-turbo / speech-02-turbo

ARTCAICallAgentLlmConfig

Large Language Model (LLM) configuration.

Parameter

Type

Description

llmHistoryLimit

int

The maximum number of historical conversation rounds to retain for the context. Default value: 10

llmSystemPrompt

String

The system prompt for the LLM

bailianAppParams

String

Parameters for the Model Studio Application Center

llmCompleteReply

boolean

Specifies whether to send the complete LLM result.

Note

When enabled, after the LLM generates the result, the complete LLM result is returned through the onLLMReplyCompleted event callback.

openAIExtraQuery

String

Additional query parameters for the OpenAI protocol LLM.

Note

Parameters must be in key=value format, with multiple parameters connected by &. All values must be strings.

ARTCAICallAgentAvatarConfig

Avatar configuration.

Parameter

Type

Description

agentAvatarId

String

The digital human model ID. If this parameter is empty, the agent's configured value is used

ARTCAICallAgentInterruptConfig

Interruption configuration.

Parameter

Type

Description

enableVoiceInterrupt

boolean

Specifies whether to enable intelligent interruption

interruptWords

List<String>

Specific words or phrases that trigger conversation interruption

ARTCAICallAgentVoiceprintConfig

Voiceprint-based noise reduction configuration.

Parameter

Type

Description

useVoiceprint

boolean

Specifies whether to use voiceprint-based noise reduction for the current sentence segmentation

voiceprintId

String

The voiceprint ID. If not empty, voiceprint-based noise reduction is enabled for the current call

ARTCAICallAgentTurnDetectionConfig

Turn detection configuration.

Parameter

Type

Description

turnEndWords

List<String>

Specific words for sentence segmentation, such as "over" or "I'm done"

mode

ARTCAICallTurnDetectionMode

The mode to determine whether the user has finished speaking. The default is semantic segmentation mode, which uses AI to determine whether the user has finished speaking based on contextual semantics. Default value: ARTCAICallTurnDetectionSemanticMode.

semanticWaitDuration

int

Custom waiting time for semantic segmentation. Unit: milliseconds. Range: [0, 10000]. Default: -1, AI automatically determines the appropriate waiting time

Note

The semanticWaitDuration field is invalid in ARTCAICallTurnDetectionNormalMode mode

ARTCAICallAgentVcrResult

VCR detection result.

Parameter

Type

Description

resultData

Object

All VCR detection results returned by the agent

stillFrameMotionResult

FrameMotionResult

VCR still frame detection result

invalidFrameMotionResult

FrameMotionResult

VCR invalid frame detection result

peopleCountResult

PeopleCountResult

VCR real-time people count detection result

equipmentResult

EquipmentResult

VCR electronic device detection result

headMotionResult

HeadMotionResult

VCR head motion detection result

FrameMotionResult

VCR video frame detection result.

Parameter

Type

Description

duration

int

How long ago it was sent (unit: milliseconds)

PeopleCountResult

VCR people count detection result.

Parameter

Type

Description

count

int

The number of people recognized by VCR

EquipmentResult

VCR electronic device detection result.

Parameter

Type

Description

mobilePhoneCount

int

Total number of devices

watchCount

int

Number of watches

headPhoneCount

int

Number of headphones

HeadMotionResult

VCR head motion detection result.

Parameter

Type

Description

nodDetected

boolean

Nodding

shakeDetected

boolean

Shaking head

ARTCAICallAgentVcrConfig

VCR configuration.

Parameter

Type

Description

data

JSONObject

When the user passes in a JSON object, it is cached. This object is used later to generate a JSON string, allowing for custom extensions

stillFrameMotion

ARTCAICallAgentVcrFrameMotionConfig

VCR still frame detection configuration

invalidFrameMotion

ARTCAICallAgentVcrFrameMotionConfig

VCR invalid frame detection configuration

peopleCount

ARTCAICallAgentVcrBaseConfig

VCR real-time people count detection configuration

equipment

ARTCAICallAgentVcrBaseConfig

VCR electronic device detection configuration

headMotion

ARTCAICallAgentVcrBaseConfig

VCR head motion detection configuration

ARTCAICallAgentVcrBaseConfig

Basic VCR detection configuration.

Parameter

Type

Description

enable

boolean

Specifies whether to enable

ARTCAICallAgentVcrFrameMotionConfig

VCR video frame detection configuration.

Parameter

Type

Description

callbackDelay

int

The delay in milliseconds before the callback is triggered

ARTCAICallExperimentalConfig

Experimental parameters for controlling specific logic policies.

Parameter

Type

Description

rtcSdkParams

JSONObject

RTC SDK parameters

commonParams

JSONObject

Common parameters

IARTCAICallService details

generateAIAgentShareCall

Starts a shared agent call.

/**
 * Requests to start a shared agent call
 * @param userId The ID of the current logon user
 * @param aiAgentId The agent ID
 * @param aiAgentType The agent type
 * @param artcaiCallConfig The agent configuration
 * @param callback The request callback
 */
void generateAIAgentShareCall(String userId, String aiAgentId, ARTCAICallEngine.ARTCAICallAgentType aiAgentType, ARTCAICallEngine.ARTCAICallConfig artcaiCallConfig, IARTCAICallServiceCallback callback);

ARTCAIAgentUtil details

parseAiAgentShareInfo

Parses the shared agent information.

/**
 * Parses the shared agent information
 * @param shareInfoText
 * @return The structured configuration of the shared agent
 */
public static ARTCAIAgentShareInfo parseAiAgentShareInfo(String shareInfoText);

parseAiAgentInfo

Parses the agent startup response.

/**
 * Parses the response information for agent startup
 * @param jsonObject The response information for agent startup
 * @return The structured information of the agent startup response
 */
public static ARTCAIAgentInfo parseAiAgentInfo(JSONObject jsonObject);