帮你快速理解、总结文档立即下载

TXIoTCallSession

最近更新时间:2026-09-20 16:47:02
我的收藏

概述

TXIoTCallSession 负责与设备之间的音视频通话,包括发起呼叫、挂断、远端画面渲染、麦克风/摄像头控制及音频输出设备选择。TXIoTCallSession 通过 TXIoTEngine.getCallSession 获取实例,需在登录成功后调用。
说明:
回调模型:通话事件通过 TXIoTCallListener 接口回调,所有 Listener 回调在主线程触发,公共类型与错误码定义见 TXIoTEngineDef

方法列表

方法签名
描述
添加通话事件监听器。
移除通话事件监听器。
绑定 iot-player 渲染组件。
向设备发起通话(音频/视频)。
hangup
挂断当前通话。
开始渲染远端视频。
停止渲染远端视频。
打开麦克风。
关闭麦克风。
打开摄像头并设置本地预览视图。
关闭摄像头。
切换摄像头(前后置)。
选择音频播放设备(扬声器/听筒)。

addListener

addListener
addListener
(TXIoTCallListener listener)
添加通话事件监听器
参数
描述
listener
TXIoTCallListener;监听器实例。

removeListener

removeListener
removeListener
(TXIoTCallListener listener)
移除通话事件监听器
参数
描述
listener
TXIoTCallListener;监听器实例。

setIoTPlayer

setIoTPlayer
setIoTPlayer
(TXIoTCallUser callUser, String iotPlayerComponentId)
绑定渲染组件
把某个远端用户与其对应的 iot-player 组件绑定,SDK 会在该组件上渲染远端用户的音视频。音频通话没有视频画面时也需要绑定组件,音频通过该组件播放。
参数
描述
callUser
TXIoTCallUser;参与通话的用户。
iotPlayerComponentId
Stringiot-player 组件的 componentId。

callDevice

callDevice
callDevice
(TXIoTDeviceId deviceId, TXIoTCallMediaType callType)
向设备发起通话(音频/视频)
参数
描述
deviceId
TXIoTDeviceId;设备标识(含 productId / deviceName)。
callType
TXIoTCallMediaType;通话类型(音频/视频)。

hangup

hangup
hangup
()
挂断当前进行中的通话

startRemoteView

startRemoteView
startRemoteView
(TXIoTCallUser callUser)
开始渲染远端视频
参数
描述
callUser
TXIoTCallUser;参与通话的用户。

stopRemoteView

stopRemoteView
stopRemoteView
(TXIoTCallUser callUser)
停止渲染远端视频
参数
描述
callUser
TXIoTCallUser;参与通话的用户。

openMicrophone

openMicrophone
openMicrophone
()
打开麦克风

closeMicrophone

closeMicrophone
closeMicrophone
()
关闭麦克风

openCamera

openCamera
openCamera
(TXIoTCamera camera)
打开摄像头并设置本地预览视图
参数
描述
camera
TXIoTCamera;摄像头(前置/后置)。

closeCamera

closeCamera
closeCamera
()
关闭摄像头

switchCamera

switchCamera
switchCamera
(TXIoTCamera camera)
切换摄像头(前后置)
参数
描述
camera
TXIoTCamera;摄像头(前置/后置)。

selectAudioPlaybackDevice

selectAudioPlaybackDevice
selectAudioPlaybackDevice
(TXIoTAudioPlaybackDevice device)
选择音频播放设备(扬声器/听筒)
参数
描述
device
TXIoTAudioPlaybackDevice;音频播放设备(扬声器/听筒)。

通话事件回调

TXIoTCallListener
回调方法
说明
onError(code: Number, msg: String)
通话发生错误。
onCallBegin(mediaType: Number)
通话开始。类型为 TXIoTCallMediaType
onCallEnd(mediaType: Number, reason: Number)
通话结束,携带结束原因。原因类型为 TXIoTCallEndReason
onCallRejected(callUser: TXIoTCallUser)
通话被对方拒接。
onCallNoResponse(callUser: TXIoTCallUser)
对方无应答。
onCallLineBusy(callUser: TXIoTCallUser)
对方占线。
onCallUserOffline(callUser: TXIoTCallUser)
对方离线。
onCallUserAudioAvailable(callUser: TXIoTCallUser, available: boolean)
远端用户音频状态发生变化。
onCallUserVideoAvailable(callUser: TXIoTCallUser, available: boolean)
远端用户视频状态发生变化。

通话相关数据结构与枚举

TXIoTCallMediaType

TXIoTCallMediaType
枚举
说明
AUDIO
音频通话。
VIDEO
视频通话。

TXIoTCallEndReason

TXIoTCallEndReason
枚举
说明
UNKNOWN
未知原因。
LOCAL_HANGUP
本地挂断。
REMOTE_HANGUP
远端挂断。
CALL_PERMISSION_DENIED
呼叫权限被拒绝。
NETWORK_ERROR
网络错误。

TXIoTAudioPlaybackDevice

TXIoTAudioPlaybackDevice
枚举
说明
SPEAKERPHONE
扬声器(外放)。
EARPIECE
听筒。

TXIoTCamera

TXIoTCamera
枚举
说明
FRONT
前置摄像头。
BACK
后置摄像头。

TXIoTCallUser

TXIoTCallUser
字段
说明
deviceId
参与通话的设备 ID。