概览--实时音视频-火山引擎

文档中心

导航

实时音视频

概览

最近更新时间：2025.09.05 13:02:06首次发布时间：2025.02.12 17:22:54

初始化登录

方法	描述
initSDK	初始化 SDK。
unInitSDK	注销 SDK, 释放内存缓存资源、注销监听等。
login	登录服务器。
logout	登出服务器。
addConnectListener	设置长链状态监听。
removeConnectListener	移除长链状态监听。
getCurrentUserID	获取当前用户 ID。
getAppID	获取当前 appID。
getVersion	获取 SDK 版本号名称。
getVersionCode	获取 SDK 版本号。
getSDKDid	获取设备 did。

群组会话

方法	描述
getConversationList	获取会话列表。
addConversationListener	添加会话监听。
removeConversationListener	移除会话监听。
getConversation	获取指定单个会话。
getTotalUnreadMessageCount	获取所有会话的未读消息总数。
markConversationRead	标记会话已读。
addGroupMemberList	添加群成员。
removeGroupMemberList	移除群成员。
setGroupMemberRole	设置群成员角色。
dissolveGroup	解散群组。
leaveGroup	离开群组。
setGroupName	设置群组名称。
setGroupNotice	设置群公告。
setConversationLocalExt	设置会话本地额外信息。
setConversationMyExt	设置会话私有额外信息。
setConversationCoreExt	设置会话额外信息。
stickTopConversation	置顶会话。
muteConversation	设置会话免打扰。
createSingleConversation	创建单聊会话。
createGroupConversation	创建群聊。
getConversationMemberList	获取群成员。
setConversationDraft	设置会话草稿。
deleteConversation	通过会话 ID 删除会话。
modifyMessage	修改消息内容和ext。
modifyMessageProperty	批量修改消息属性。
refreshMediaMessage	刷新媒体信息，媒体 URL 过期时调用该方法。

消息收发

方法	描述
getHistoryMessageList	获取历史消息（锚点之前的消息），返回消息顺序从新到旧。
addMessageListener	设置消息监听。
removeMessageListener	移除消息监听。
sendMessage	发送消息。
deleteMessage	删除本地和服务端消息。
recallMessage	撤回消息。
createTextMessage	创建文本消息。
createImageMessage	创建图片消息。
createTextMessageFullInfo	创建带引用消息的文本消息。
createVideoMessage	创建视频消息。
createFileMessage	创建文件消息。
createAudioMessage	创建语音消息。
createCustomMessage	创建自定义消息。
searchLocalMessage	搜索本地消息。

直播群

方法	描述
addLiveGroupMessageListener	设置直播群消息监听。
removeLiveGroupMessageListener	设置直播群消息监听。
addLiveConversationListener	设置直播群会话监听。
removeLiveConversationListener	移除直播群会话监听。
addLiveGroupMemberListener	设置直播群成员监听。
removeLiveGroupMemberListener	移除直播群成员监听。
getOwnerLiveGroupList	获取我是群主和管理员的直播群列表。
getAllLiveGroupList	获取当前应用下的所有直播群列表。
createLiveGroup	创建直播群。
getLiveGroup	获取直播群信息。
getLiveGroupHistoryMessageList	获取直播群历史消息(从新到旧)。
joinLiveGroup	加入直播群，加入直播群后可以收发当前群的信息，直播群不提供本地存储。
joinLiveGroupWithInfo	加入直播群并设置当前用户成员信息。
sendLiveGroupMessage	发送直播群消息。
leaveLiveGroup	离开直播群。
refreshLiveGroupMediaMessage	刷新直播群媒体信息，媒体 URL 过期时调用该方法。
getLiveGroupOnLineCount	获取直播群在线人数。
dissolveLiveGroup	解散直播群，仅群主可操作。
getLiveGroupMemberOnlineList	获取直播群在线用户列表。
getLiveGroupMemberList	获取直播群群主管理员等常驻成员列表。
getLiveGroupMemberSilentWhiteList	获取会话禁言白名单。
addLiveGroupMemberSilentWhiteList	添加禁言会话白名单。
removeLiveGroupMemberSilentWhiteList	移除禁言会话白名单。
getLiveGroupMemberBlockList	获取直播群进群黑名单。
addLiveGroupMemberBlockList	添加群进群黑名单。
removeLiveGroupMemberBlockList	移除群进群黑名单。
getLiveGroupMemberSilentList	获取直播群禁言用户列表。
setLiveGroupSilent	设置会话禁言(所有成员禁言)。
addLiveGroupMemberSilentList	添加群成员禁言。
removeLiveGroupMemberSilentList	移出群成员禁言。
kickLiveGroupMemberList	踢出在线成员。
transLiveGroupOwner	转让群主。
addLiveGroupAdmin	设置直播群管理员。
removeLiveGroupAdmin	移除直播群管理员。
setLiveGroupMemberRole	设置成员角色。
setLiveGroupMemberInfo	设置直播群成员信息，覆盖服务端存储。
setLiveGroupMemberAlias	设置直播群成员昵称。
setLiveGroupMemberAvatar	设置直播群成员头像。
addLiveGroupMemberExt	设置直播群成员自定义信息，相同 key 会覆盖。
getLiveGroupMemberInfo	获取直播群成员信息，其中包括当前在直播群的成员以及群主管理员，退出群的游客信息无法获取。
setLiveGroupNotice	设置群公告。
setLiveGroupDescription	设置群描述。
setLiveGroupName	设置群名称。
setLiveGroupIcon	设置群头像。
getLiveGroupMemberOnlineInfo	获取直播群成员在线信息。