Intelligent Media Services：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)

通話過程中串連狀態發生變化。

@objc optional func onConnectionStatusChange(status: ARTCAICallConnectionStatus, reason: Int32)

參數詳情：

音頻迴環延遲。

@objc optional func onAudioDelayInfo(sentenceId: Int32, delayMs: Int64)

參數詳情：

當前通話中，如果通過RTC Instance進行播放音樂伴奏，則會觸發該播放回調。

 @objc optional func onAudioAccompanyStateChanged(state: ARTCAICallAudioAccompanyState, errorCode: ARTCAICallAudioAccompanyErrorCode)

參數詳情：

建立預設的引擎執行個體

public static func createEngine() -> ARTCAICallEngineInterface