腾讯云实时音视频API 概览_音视频解决方案_同尘科技

实时音视频 1年前 (2023-09-28) 浏览 45

API OVERVIEW

创建实例和事件回调

函数列表 描述
createInstance 创建 TUIRoomEngine 实例
destroyInstance 销毁 TUIRoomEngine 实例
login 登录接口,您需要先初始化用户信息后才能进入房间,并进行一系列的操作
logout 退出登录接口,会有主动离开房间操作、销毁资源
setSelfInfo 设置本地用户名称和头像
getSelfInfo 获取本地用户登录的基本信息
addObserver 设置事件回调
removeObserver 移除事件回调

房间相关主动接口

函数列表 描述
createRoom 创建房间
destroyRoom 解散房间
enterRoom 进入房间
exitRoom 离开房间
connectOtherRoom 连接其他房间
disconnectOtherRoom 断开与其他房间的连接
fetchRoomInfo 获取房间信息
updateRoomNameByAdmin 更新房间名称(只有管理员或房主能够调用)
updateRoomSpeechModeByAdmin 设置房间麦控模式(只有管理员或房主能够调用)

本地用户视图渲染、视频管理

函数列表 描述
setLocalVideoView 设置本地用户视频渲染的视图控件
openLocalCamera 打开本地摄像头
closeLocalCamera 关闭本地摄像头
startPushLocalVideo 开始推送本地视频。默认开启
stopPushLocalVideo 停止推送本地视频
updateVideoQuality 更新本地视频编码质量设置
updateVideoQualityEx 设置视频编码器的编码参数
setVideoResolutionMode 设置视频编码器分辨率模式(横屏分辨率 or 竖屏分辨率)
enableGravitySensor 开启重力感应模式
startScreenSharing 开始屏幕分享(该接口仅支持移动端)
stopScreenSharing 结束屏幕分享

本地用户音频管理

函数列表 描述
openLocalMicrophone 打开本地麦克风
closeLocalMicrophone 关闭本地麦克风
muteLocalAudio 暂停发布本地的音频流
unmuteLocalAudio 恢复发布本地的音频流

远端用户视图渲染、视频管理

函数列表 描述
setRemoteVideoView 设置远端用户视频渲染的视图控件
startPlayRemoteVideo 开始播放远端用户视频
stopPlayRemoteVideo 停止播放远端用户视频
muteRemoteAudioStream 将远端用户禁音

房间内用户信息

函数列表 描述
getUserList 获取房间内的成员列表
getUserInfo 获取成员信息

房间内用户管理

函数列表 描述
changeUserRole 修改用户角色(只有管理员或房主能够调用)
kickRemoteUserOutOfRoom 将远端用户踢出房间(只有管理员或房主能够调用)
addCategoryTagForUsers 为用户增加标记(只有房主能够调用)
removeCategoryTagForUsers 为用户移除标记(只有房主能够调用)
getUserListByTag 根据标记获取房间内用户信息

房间内用户发言管理

函数列表 描述
disableDeviceForAllUserByAdmin 全体用户媒体设备管理
openRemoteDeviceByAdmin 请求远端用户打开媒体设备(只有管理员或房主能够调用)
closeRemoteDeviceByAdmin 关闭远端用户媒体设备(只有管理员或房主能够调用)
applyToAdminToOpenLocalDevice 请求打开本地媒体设备(普通用户可用)

房间内麦位管理

函数列表 描述
setMaxSeatCount 设置最大麦位数(仅支持进房前和创建房间时设置)
getSeatList 获取麦位列表
lockSeatByAdmin 锁定麦位(只有管理员或群主能够调用,包括位置锁定、音频状态锁定和视频状态锁定)
takeSeat 上麦(上麦发言模式下,需要申请)
leaveSeat 下麦
takeUserOnSeatByAdmin 主持人/管理员 邀请用户上麦
kickUserOffSeatByAdmin 主持人/管理员 将用户下麦

文本消息

函数列表 描述
sendTextMessage 发送本文消息
sendCustomMessage 发送自定义消息
disableSendingMessageByAdmin 禁用远端用户的发送文本消息能力(只有管理员或房主能够调用)
disableSendingMessageForAllUser 禁用所有用户的发送文本消息能力(只有管理员或房主能够调用)

信令管理

函数列表 描述
cancelRequest 取消请求
responseRemoteRequest 回复请求

高级功能

函数列表 描述
switchCamera 切换前置或后置摄像头(仅适用于移动端)
setBeautyLevel 设置美颜级别
setWhitenessLevel 设置美白级别

调试相关

函数列表 描述
callExperimentalAPI 调用实验性接口

错误事件回调

函数列表 描述
onError 错误事件回调

登录状态事件回调

函数列表 描述
onKickedOffLine 用户被踢下线
onUserSigExpired 用户凭证超时事件

房间内事件回调

函数列表 描述
onRoomNameChanged 房间名称更改事件
onAllUserMicrophoneDisableChanged 房间内所有用户麦克风被禁用事件
onAllUserCameraDisableChanged 房间内所有用户摄像头被禁用事件
onSendMessageForAllUserDisableChanged 房间内用户发送文本消息被禁用事件
onRoomDismissed 房间被解散事件
onKickedOutOfRoom 被踢出房间事件
onRoomSpeechModeChanged 房间麦控模式发生变化

房间内用户事件回调

函数列表 描述
onRemoteUserEnterRoom 远端用户进房事件
onRemoteUserLeaveRoom 远端用户离开房间事件
onUserRoleChanged 用户角色发生变化事件
onUserVideoStateChanged 用户视频状态发生变化事件
onUserAudioStateChanged 用户音频状态发生变化事件
onUserVoiceVolumeChanged 用户音量变化事件
onSendMessageForUserDisableChanged 用户文本消息发送能力发生变化事件
onUserNetworkQualityChanged 用户网络状态变化事件
onUserScreenCaptureStopped 屏幕分享结束

房间内麦位事件回调

函数列表 描述
onRoomMaxSeatCountChanged 房间内最大麦位数发生变化事件(仅在会议类型房间生效)
onSeatListChanged 麦位列表发生变化事件
onKickedOffSeat 收到用户被踢下麦事件

请求信令事件回调

函数列表 描述
onRequestReceived 收到请求消息事件
onRequestCancelled 收到请求被取消的事件

房间内消息事件回调

函数列表 描述
onReceiveTextMessage 收到普通文本消息事件
onReceiveCustomMessage 收到自定义消息事件

对音视频的解决方案有疑惑?想了解解决方案收费? 联系解决方案专家

腾讯云限时活动1折起,即将结束: 马上收藏

同尘科技为腾讯云授权服务中心,购买腾讯云享受折上折,更有现金返利:同意关联,立享优惠

阿里云解决方案也看看?: 点击对比阿里云的解决方案

- 0人点赞 -

发表点评 (0条)

not found

暂无评论,你要说点什么吗?