文档反馈
文档反馈

总体参数说明

AVChatAudioFrame语音数据类说明

属性 类型 说明
data ByteBuffer 语音数据
samplesPerChannel int number of samples per channel
samplesPerSec int number of samples per seconds
channels int Channel, always 1
bytesPerSample int number of bytes per sample

AVChatAudioDevice语音播放设备说明

属性 类型 说明
SPEAKER_PHONE int 扬声器
WIRED_HEADSET int 有线耳机
EARPIECE int 听筒
BLUETOOTH_HEADSET int 蓝牙耳机
WIRED_SPEAKER int 有线外放
BLUETOOTH_SPEAKER int 蓝牙外放

AVChatAudioMixingEvent伴音事件类说明

属性 类型 说明
MIXING_STARTED int 伴音开始
MIXING_ERROR int 伴音出错
MIXING_FINISHED int 伴音结束

AVChatCallback音视频回调接口说明

方法 说明
onSuccess 成功时的回调
onFailed 失败时的回调
onException 异常时的回调

AVChatCalleeAckEvent音视频通话对方操作通知类说明

方法 说明
getChatId 获取通话ID
getAccount 获取对方帐号, 多人通话时无效
getChatType 获取通话的类型
getTimeTag 获取当前事件发生的时间戳
getExtra 获取自定义
getPushSound 获取推送铃声
getEvent 获取事件类型

AVChatChannelInfo音视频会话信息类说明

方法 说明
getTimetagMs 获取当前事件发生的时间戳, 返回值的单位是毫秒

AVChatCommonEvent音视频通话事件类说明

方法 说明
getChatId 获取通话ID
getAccount 获取对方帐号, 多人通话时无效
getChatType 获取通话的类型
getTimeTag 获取当前事件发生的时间戳
getExtra 获取自定义
getPushSound 获取推送铃声
getEvent 获取事件类型

AVChatConnectionType网络类型类说明

属性 类型 说明
CONNECTION_UNKNOWN int Unknown data connection.
CONNECTION_ETHERNET int The Ethernet data connection.
CONNECTION_WIFI int The WIFI data connection.
CONNECTION_2G int The Mobile(2G) data connection.
CONNECTION_3G int The Mobile(3G) data connection.
CONNECTION_4G int The Mobile(4G) data connection.
CONNECTION_BLUETOOTH int The Bluetooth data connection.
CONNECTION_NONE int The absence of a connection type.

AVChatData请求音视频通话信息类说明

方法 说明
getChatId 获取通话ID
getAccount 获取对方帐号, 多人通话时无效
getChatType 获取通话的类型
getTimeTag 获取当前事件发生的时间戳
getExtra 获取自定义
getPushSound 获取

AVChatDeviceEvent设备操作事件类说明

属性 类型 说明
VIDEO_CAMERA_OPENING int 正在打开摄像头
VIDEO_CAMERA_OPEN_ERROR int 摄像头打开失败
VIDEO_CAMERA_RUNNING_FREEZED int 摄像头数据冻结
VIDEO_CAMERA_CLOSED int 摄像头关闭
VIDEO_CAMERA_OPENED int 摄像头成功打开
VIDEO_CAMERA_SWITCH_OK int 换摄像头成功
VIDEO_CAMERA_SWITCH_ERROR int 切换摄像头失败
AUDIO_RECORDER_OPENING int 录音设备正在打开
AUDIO_RECORDER_OPEN_ERROR int 录音设备打开失败
AUDIO_RECORDER_CLOSED int 录音设备关闭
AUDIO_RECORDER_OPENED int 录音设备成功打开
AUDIO_RECORDER_RUNNING_FREEZED int 录音设备读取数据失败

AVChatMediaCodecMode编解码模式类说明

属性 类型 说明
MEDIA_CODEC_AUTO String 系统自动选择编解码器
MEDIA_CODEC_HARDWARE String 优先使用硬件编解码器
MEDIA_CODEC_SOFTWARE String 优先使用软件编解码器

AVChatNetDetectType网络探测类型

属性 类型 说明
AUDIO int 音频
VIDEO_QUALITY_DEFAULT int 视频默认分辨率
VIDEO_QUALITY_LOW int 视频低分辨率, (240x160)
VIDEO_QUALITY_MEDIUM int 视频中等分辨率, (352x288)
VIDEO_QUALITY_HIGH int 视频高分辨率, (480x320)
VIDEO_QUALITY_480P int 视频480P, (640x480)
VIDEO_QUALITY_540P int 视频540P, (960x540)
VIDEO_QUALITY_720P int 视频720P, (1280x720)

AVChatNetworkQuality网络质量类说明

属性 类型 说明
EXCELLENT int 极好
GOOD int
POOR int 不好
BAD int
VERY_BAD int 非常差, 建议不要发送视频数据
VIDEO_OFF int 网络极差,视频发送已经关闭

AVChatNetworkStats网络状态统计信息类说明

属性 类型 说明
rtt int 时延
audioLostRate int 语音丢包率(1-100)
videoLostRate int 视频丢包率(1-100)

AVChatNotifyOption推送通知选项参数类说明

属性 类型 说明
apnsInuse boolean 网络通话请求是否附带推送(iOS)
apnsBadge boolean 推送是否需要角标计数(iOS)
apnsWithPrefix boolean 推送消息是否需要带前缀(iOS)
apnsContent String apns推送文案(iOS)
apnsPayload String apns推送Payload(iOS)
pushSound String 推送声音文件(iOS)
extendMessage String 扩展消息
forceKeepCalling boolean 是否强制持续呼叫

AVChatResCode常见错误类说明

属性 类型 说明
COMMON_OK int 请求成功
ERROR_USER_OFFLINE int 通话不可送达,对方离线状态
ERROR_CREATE_ROOM_ALREADY_EXIST int 房间已经创建好
ERROR_JOIN_ROOM_NON_EXISTENT int 频道不存在

内部类JoinChannelCode加入频道时错误码类说明

属性 类型 说明
OK int 连接成功
ERROR_TIMEOUT int 连接频道服务器超时
ERROR_MODE_INCORRECT int 加入模式和房间模式不匹配
ERROR_LIVE_MODE_INCORRECT int 加入房间需要开启互动直播
ERROR_LIVE_USER_LIMIT int 互动直播房间用户数已达到上限
ERROR_LIVE_HOST_LIMIT int 互动直播房间主播已经存在
ERROR_INVALID_CHANNEL int 无效的频道
ERROR_INVALID_PARAMS int 参数不对
ERROR_AUTH_FAILED int ERROR_AUTH_FAILED
ERROR_LIVE_HOST_INVALID int 互动直播房间主播错误
ERROR_LIVE_LAYOUT_ERROR int 互动直播自定义布局错误
ERROR_SAMPLE_RATE_ILLEGALITY int 房间不支持高清语音

内部类LiveEventCode互动直播事件码类说明

属性 类型 说明
LIVE_INITIAL int 初始化
LIVE_PIP_LAYOUT_ERROR int 设置画中画布局错误
LIVE_START_CONNECTING int 互动直播开始链接
LIVE_CONNECTED int 互动直播链接成功
LIVE_CONNECT_FAIL int 互动直播链接失败
LIVE_PUSHING int 互动直播推流中
LIVE_PUSH_FAIL int 互动直播推流失败
LIVE_INNER_ERROR int 互动直播内部错误
LIVE_USER_COUNT_LIMIT int 人数超出限制

AVChatSessionStats实时状态统计类说明

属性 类型 说明
audioFreeze int 语音卡播比。周期性统计,结束时汇报整个会话卡播比
audioGapPacket int 语音卡顿数据包个数。周期性统计,结束时汇报整个会话的卡顿数据包个数。
audioTotalPacket int 语音数据包总数。周期性统计,数据时汇报整个会话的数据包总数。
rxBytes int 会话接收字节数(bytes)
txBytes int 会话发送字节数(bytes)
rxVideoPacketsPerSecond int 每秒接收的视频包个数,瞬时值
rxAudioPacketsPerSecond int 每秒接收的音频包个数,瞬时值
txVideoPacketsPerSecond int 每秒发送的视频包个数,瞬时值
txAudioPacketsPerSecond int 每秒发送的音频包个数,瞬时值
txAudioEncodedBitrate int 语音编码比特率,kbps
txAudioSentBitrate int 语音数据实际发送比特率,kbps
txVideoEncodedBitrate int 视频数据编码比特率,kbps
txVideoSentBitrate int 视频数据实际发送速率,kbps
appCpuFreq int 实时获取的cpu当前频率,瞬时值(KHz)
appMemoryUse int 当前应用程序占用的内存(MB)
sysMemoryAvailable int 当前设备可用内存(MB)
sessionDuration int 会话时长

AVChatType网络通话类型枚举类说明

属性 说明
UNKNOWN 未定义
AUDIO 音频通话
VIDEO 视频通话

AVChatUserQuitType用户退出类型定义类说明

属性 类型 说明
NORMAL int 正常退出
TIMEOUT int 超时退出

AVChatVideoFrame视频数据类说明

属性 类型 说明
data byte[] 视频数据
dataMirror byte[] 镜像后的视频数据。 输出时无效,仅支持外部对原始视频数据镜像后传入。
dualInput boolean 是否需要输入双路数据。
width int 视频数据宽度
height int 视频数据高度
dataLen int 视频数据有效长度
rotation int 视频画面旋转角度
format int 视频数据格式

VideoFilterParameter视频数据类说明

属性 类型 说明
displayRotation int 视频显示窗口角度
frameRotation int 视频画面的旋转角度
isExternalMirror boolean 是否需要外部镜像处理
isInternalMirrored boolean 数据是否内部镜像过

RoomServerCode事件码说明

属性 类型 说明
ROOM_SERVER_REQUEST_OK int 请求成功
ROOM_SERVER_NOT_LIVE_MODE int 非互动直播
ROOM_SERVER_NOT_ANCHOR int 非主播
ROOM_SERVER_REQUEST_FAILED int 请求失败
ROOM_SERVER_REQUEST_INVALID int 认证错误
ROOM_SERVER_REQUEST_CHANNEL_NOT_EXIST int 请求不存在(频道号)
ROOM_SERVER_REQUEST_USER_NOT_EXIST int 房间下的uid不存在
ROOM_SERVER_REQUEST_DATA_ERROR int 请求数据不对
ROOM_SERVER_REQUEST_TURN_SERVER_ERROR int 内部错误(TurnServer请求异常)
ROOM_SERVER_REQUEST_SERVER_ERROR int 服务器内部错误
×

反馈成功

非常感谢您的反馈,我们会继续努力做得更好。