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

文档中心

导航

实时音视频

概览

最近更新时间：2025.03.18 15:43:22首次发布时间：2024.05.23 11:25:58

方法

初始化登录

方法	描述
initSDK	初始化 SDK。
initSDKWithStringUid	使用字符串 uid 初始化 SDK。
unInitSDK	注销 SDK，释放内存缓存资源、注销监听等。
logout	登出服务器。
login	登录服务器。
getCurrentUserID	获取当前用户 ID。
getVersion	获取 SDK 版本号。
createTextMessage	创建文本消息。
createCustomMessage	创建自定义消息。
addConnectListener	设置长链状态监听。
removeConnectListener	移除长链状态监听。

直播群

方法	描述
getAllLiveGroupList	获取当前应用下的所有直播群列表。
getOwnerLiveGroupList	获取我是群主和管理员的直播群列表。
leaveLiveGroup	离开直播群。
dissolveLiveGroup	解散直播群，仅群主可操作。
joinLiveGroup	加入直播群，加入直播群后可以收发当前群的信息，直播群不提供本地存储。
joinLiveGroup	加入直播群并设置当前用户成员信息。
addLiveGroupMessageListener	设置直播群消息监听。
removeLiveGroupMessageListener	移除直播群消息监听。
addLiveConversationListener	设置直播群会话监听。
removeLiveConversationListener	移除直播群会话监听。
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	设置群头像。
sendLiveGroupMessage	发送直播群消息。
sendLiveGroupMessage	发送直播群消息。
getLiveGroupMemberOnlineInfo	获取直播群成员在线信息。
manageLiveGroupMarkTypes	管理群成员标记类型。
addLiveGroupMarkTypeListener	新增直播群标记事件监听。
removeLiveGroupMarkTypeListener	移除直播群标记事件监听。
markLiveGroupMemberList	标记群成员。
getLiveGroupMarkTypeList	获取群聊标记类型列表。
getLiveGroupMemberOnlineList	根据标记获取直播群在线用户列表。支持拉取近 1000 个在线游客。
getLiveGroupHistoryMessageList	获取直播群历史消息(从新到旧)。
createLiveGroup	创建直播群。
addLiveGroupMemberListener	设置直播群成员监听。
removeLiveGroupMemberListener	移除直播群成员监听。
getLiveGroup	获取直播群信息。
getLiveGroupOnlineMemberCount	获取直播群在线人数。

回调

初始化登录

回调	描述
onTokenInvalid	Token 失效回调。
onConnectStatusChanged	长链状态改变回调。

直播群

回调	描述
onConversationChanged	直播群信息发生变化。
onMemberJoined	成员加入群聊。
onMemberLeave	成员离开直播群。
onMemberKicked	成员被踢出直播群。
onMemberOwnerChanged	群主发生变化。
onMemberSilent	群成员被禁言/解禁。
onAllMemberSilent	禁言、取消会话(禁言、取消所有人)。
onAddAdmin	添加管理员。
onRemoveAdmin	移除管理员。
onMemberInfoChanged	成员信息变更。
onBatchMemberInfoChanged	批量成员信息变更。
onReceiveMessage	收到新消息。
onDeleteMessage	收到的消息被删除。
onUpdateMessage	收到的消息被修改。（内容+扩展）
onSendMessage	发送消息请求前调用。
onMarkTypeAdd	直播群新增标记类型。
onMarkTypeDeleted	直播群删除标记类型。