API接口详情

获取当前通话的UserId

var userId: String? {get}

是否通话中, 从接通后到挂断或出错前为true，其他为false

var isOnCall: Bool { get }

获取当前智能体信息，包括：类型、频道Id、智能体在频道中的uid、智能体运行实例ID，详细内容，请参见ARTCAICallAgentInfo。

var agentInfo: ARTCAICallAgentInfo? { get }

获取当前智能体状态，包括：聆听中\思考中\讲话中。详细内容，请参见ARTCAICallAgentState。

var agentState: ARTCAICallAgentState { get }

设置和获取回调事件。更多回调事件，请参见ARTCAICallEngineDelegate。

weak var delegate: ARTCAICallEngineDelegate? { get set }

开始通话

func call(userId: String, token: String, agentInfo: ARTCAICallAgentInfo, completed:((_ error: NSError?) -> Void)?)

参数详情：

通过通话配置来开始通话

func call(config: ARTCAICallConfig) -> Bool

参数详情：

退出通话

 func handup(_ stopAIAgent: Bool)

参数详情：

音频配置，包括编码配置（采样率、声道数、码率等）与场景配置（默认场景、音乐场景）。详细内容，请参见ARTCAICallAudioConfig，该参数在通话前设置才能生效。

var audioConfig: ARTCAICallAudioConfig { set get }

视频配置，在通话前设置才能生效（仅针对VisionAgent/VideoAgent有效），详细内容请参见ARTCAICallVideoConfig

var videoConfig: ARTCAICallVideoConfig { set get }

设置本地摄像头渲染视图及配置（当前仅针对VisionAgent/VideoAgent有效），详细内容请参见ARTCAICallViewConfig

func setLocalViewConfig(viewConfig: ARTCAICallViewConfig?)

参数详情：

设置智能体渲染视图配置，当智能体有画面渲染时需要设置（当前仅针对VisionAgent/VideoAgent有效），详细内容请参见ARTCAICallViewConfig

func setAgentViewConfig(viewConfig: ARTCAICallViewConfig?)

参数详情：

打断智能体讲话

func interruptSpeaking() -> Bool

开启/关闭智能打断

func enableVoiceInterrupt(enable: Bool) -> Bool

参数详情：

切换音色

func switchVoiceId(voiceId: String) -> Bool

参数详情：

开启/关闭扬声器

func enableSpeaker(enable: Bool) -> Bool

参数详情：

开启/关闭对讲机模式，对讲机模式下，只有在finishPushToTalk被调用后，智能体才会播报结果

func enablePushToTalk(enable: Bool) -> Bool

参数详情：

对讲机模式下，开始讲话

func startPushToTalk() -> Bool

对讲机模式下，结束讲话

func finishPushToTalk() -> Bool

对讲机模式下，取消这次讲话

func cancelPushToTalk() -> Bool

静音/取消禁音麦克风

func muteMicrophone(mute: Bool) -> Bool

参数详情：

停止/恢复智能体音频流的播放

func muteAgentAudioPlaying(mute: Bool) -> Bool

参数详情：

使用视觉智能体时需要设置，且在通话前设置才能生效。视觉配置，包括分辨率、帧率等。详细内容，请参见ARTCAICallVisionConfig。

var visionConfig: ARTCAICallVisionConfig { set get }

关闭/取消关闭摄像头。

func muteLocalCamera(mute: Bool) -> Bool

参数详情：

切换前后摄像头

func switchCamera() -> Bool

解析一个分享的智能体信息，解析成功则返回一个ARTCAICallAgentShareConfig类型的实例，可以通过该实例启动一个分享出来的智能体通话

func parseShareAgentCall(shareInfo: String) -> ARTCAICallAgentShareConfig?

参数详情：

启动一个分享的智能体通话

func generateShareAgentCall(shareConfig: ARTCAICallAgentShareConfig, userId: String, completed: ((_ rsp: ARTCAICallAgentInfo?, _ token: String?, _ error: NSError?, _ reqId: String) -> Void)?)

参数详情：

获取RTC引擎

func getRTCInstance() -> AnyObject?

给智能体发送文本消息

func sendTextToAgent(req: ARTCAICallSendTextToAgentRequest) -> Bool

参数详情：

给Server发送自定义消息，需要在接通后调用

func sendCustomMessageToServer(msg: String) -> Bool

参数详情：

更新LLM的系统提示词，需要在接通后调用。

func updateLlmSystemPrompt(prompt: String) -> Bool

参数详情：

更新百炼应用中心参数

func updateBailianAppParams(params: [String: Any]) -> Bool

参数详情：

更新VCR配置

 func updateVcrConfig(vcrConfig: ARTCAICallAgentVcrConfig) -> Bool

参数详情：

视觉理解智能体，开始启动自定义截帧，启动后，无法通过语音与智能体通话，需要在接通后调用

func startVisionCustomCapture(req: ARTCAICallVisionCustomCaptureRequest) -> Bool

参数详情：

视觉理解智能体，结束自定义截帧，需要在接通后调用

func stopVisionCustomCapture() -> Bool

释放资源

func destroy()

当前通话时发生了错误

@objc optional func onErrorOccurs(code: ARTCAICallErrorCode)

参数详情：

通话智能体已启动

@objc optional func onAgentStarted()

通话开始

@objc optional func onCallBegin()

通话结束

@objc optional func onCallEnd()

智能体视频是否可用

@objc optional func onAgentVideoAvailable(available: Bool)

参数详情：

智能体音频是否可用

@objc optional func onAgentAudioAvailable(available: Bool)

参数详情：

RTC引擎被成功创建，可以在这个回调里调用getRTCInstance获取到rtc引擎实例

@objc optional func onRTCEngineCreated()

当前通话的对讲机模式是否启用

@objc optional func onPushToTalk(enable: Bool)

参数详情：

当前智能体即将离开（结束当前通话）

@objc optional func onAgentWillLeave(reason: Int32, message: String)

参数详情：

收到当前智能体发过来的自定义消息

@objc optional func onReceivedAgentCustomMessage(data: [String: Any]?)

参数详情：

智能体状态改变

@objc optional func onAgentStateChanged(state: ARTCAICallAgentState)

参数详情：

网络状态改变

@objc optional func onNetworkStatusChanged(uid: String, quality: ARTCAICallNetworkQuality)

参数详情：

音量变化通知

@objc optional func onVoiceVolumeChanged(uid: String, volume: Int32)

参数详情：

用户提问被智能体识别结果的通知

@objc optional func onUserSubtitleNotify(text: String, isSentenceEnd: Bool, sentenceId: Int)

参数详情：

智能体回答结果通知

@objc optional func onVoiceAgentSubtitleNotify(text: String, isSentenceEnd: Bool, userAsrSentenceId: Int)

参数详情：

当前通话中，LLM回答完毕

@objc optional func onLLMReplyCompleted(text: String, userAsrSentenceId: Int)

参数详情：

当前通话的音色发生了改变

@objc optional func onVoiceIdChanged(voiceId: String)

参数详情：

当前通话的语音打断是否启用

@objc optional func onVoiceInterrupted(enable: Bool)

参数详情：

智能体当前讲话被打断

@objc optional func onSpeakingInterrupted(reason: ARTCAICallSpeakingInterruptedReason)

参数详情：

当前视觉理解通话是否启用了自定义截帧模式

@objc optional func onVisionCustomCapture(enable: Bool)

参数详情：

智能体数字人首帧渲染

@objc optional func onAgentAvatarFirstFrameDrawn()

当真人即将接管当前智能体

@objc optional func onHumanTakeoverWillStart(takeoverUid: String, takeoverMode: Int)

参数详情：

当真人接管已经接通

@objc optional func onHumanTakeoverConnected(takeoverUid: String)

参数详情：

智能体情绪结果通知

@objc optional func onAgentEmotionNotify(emotion: String, userAsrSentenceId: Int)

参数详情：

智能体消息通道可用性回调，该回调触发后，才可以给智能体发送消息

@objc optional func onAgentDataChannelAvailable()

收到当前智能体发过来VCR结果。详情，请参见ARTCAICallAgentVcrResult。

@objc optional func onReceivedAgentVcrResult(result: ARTCAICallAgentVcrResult)

创建默认的引擎实例

public static func createEngine() -> ARTCAICallEngineInterface