RtmFlutterPlugin class

Constructors

RtmFlutterPlugin()

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Properties

mRoomId ↔ String

getter/setter pair

mUserId ↔ String

getter/setter pair

Static Methods

chatroomBlackUser(String rid, String blackid, bool isAdd) → Future<int>

添加黑名单 rid 房间ID 成功返回0, 否则返回非0

clearPrivateAllUnreadMsg(int type) → Future<int>

把所有收到的私信未读消息标记为已读 @param uid 用户id 成功返回处理条数, 否则返回<0的值

clearPrivateSessionUnreadMsg(String uid, int type) → Future<int>

把某个会话中所有未读消息标记为已读 @param uid 用户id @param type 私信或群组消息 成功返回处理条数, 否则返回<0的值

deleteLocalPrivateSession(String uid) → Future<int>

删除本地私信会话记录 @param uid 用户id 成功返回删除条数, 失败返回<0的值

downloadAudio(Map json) → Future<SendMessageResult>

下载音频文件

downloadFile(String key, int filetype, String pathExtension) → Future<int>

下载文件

downloadImage(Map json) → Future<SendMessageResult>

下载图片文件

downloadThumbnailImage(Map json) → Future<SendMessageResult>

下载图片文件缩略图

downloadVideo(Map json) → Future<SendMessageResult>

下载视频文件

downloadVideoImage(Map json) → Future<SendMessageResult>

下载视频首帧图片

downloadVideoThumbnailImage(Map json) → Future<SendMessageResult>

下载视频缩略图

getPrivateMessageBlack(int index) → Future<PrivateMessageBlackResult>

获取用户私信黑名单列表 index 分页下标,第一页传入0，例如,每页20条数据,第一页传0,第二页传20 PrivateMessageBlackResult的字段eCode成功返回0, 否则返回非0

getSdkVersion() → Future<String>

SDK 内部版本号，汇报给 linkv 时可以提供该版本号

initImSDK(String appId, String appSign, bool isDebugEnv) → Future<int>

即时通讯 SDK 鉴权 @param appId 向LinkV申请的appId @param appSign SDK签名字符串 @param isTestEnv true 为使用测试环境，false 为不使用测试环境

initRtcAndImSDK(String appId, String appSign, bool isDebugEnv, bool isInternationalEnv) → Future<LvInitResultBean>

音视频和即时通讯 SDK 鉴权 @param appId 向LinkV申请的appId @param appSign SDK签名字符串 @param isDebugEnv true 为使用测试环境，false 为不使用测试环境 @param isInternationalEnv true 为国际版本，false 为国内版本

initRtcSDK(String appId, String appSign, bool isDebugEnv, bool isInternationalEnv) → Future<int>

音视频 SDK 鉴权 @param appId 向LinkV申请的appId @param appSign SDK签名字符串 @param isDebugEnv true 为使用测试环境，false 为不使用测试环境 @param isInternationalEnv true 为国际版本，false 为国内版本

isIMAuthed() → Future<bool>

IM 鉴权是否成功

isIMLoginSucceed() → Future<bool>

IM 是否登录成功

localPathWithFileContent(String key, int filetype, String pathExtension) → Future<String>

获取本地路径

loginRoom(String roomId, String userId, bool isHost, bool isAudioOnly) → void

加入房间（音视频和聊天） @param roomId 房间 ID @param userId 用户 ID @param isHost 是否是主持人 @param isOnlyAudio 是否以音频模式加入

loginRoomWithCallback(String roomId, String userId, bool isHost, bool isAudioOnly, LinkVVideoCallback? callback) → void

loginUser(String userId, int loginType) → Future<int>

登录，请使用自己的用户账号系统，确保userId唯一标识用户。 @param 用户ID @return 0代表登录成功，-6代表已经是登录状态，其它代表失败。

logoutRoom() → void

退出房间

logoutUser() → void

退出当前登录用户

queryAllSessionList(int type) → Future<List>

查询本地数据库中全部的会话列表

queryLocalPrivateHistoryMessage(String uid, int dbid, int limit) → Future<List<LVIMMsg>>

查询本地私信消息历史记录【DESC，距离当前时间最近的一条消息会在第一位】 @param uid 目标的id @param dbid 消息的数据库id —— 传0表示从最近的一条消息开始查询 @param limit 限制结果条数

queryRemoteSessionMessage(String tuid, int sequence, int size, int type) → Future<Map>

拉取远程某个会话的历史消息 ，"默认传0的给20条最新的，然后这20条的顺序是从旧到新的" type = LVIM_MESSAGE_LVDTYPE.类型 sequence 分页，第一页传0，第二页传之前取到的消息的第一条sequence size 条目 成功返回 {"eCode":eCode,"rCode":rCode,"messages":list}

querySessionList(int type) → Future<List>

获取消息会话列表

queryUnReadMessageList(String uid, int dbid, int limit, bool desc) → Future<List<LVIMMsg>>

查询未读消息数据，可分页返回数据

queryUnReadMessageNum() → Future<int>

查询当前未读消息数

requestDebugToken(String userId, String username) → Future<Map>

sendAudioMessageRequest(String uid, String tid, String title, String body, String audioPath, bool isGroup) → Future<SendMessageResult>

构建音频请求

sendEventMessage(String tid, String type, String content, LVPushContent? lvPushContent) → Future<SendMessageResult>

发送事件消息

sendFileMessageRequest(String path, int filetype) → Future<int>

构建文件上传请求

sendImageMessageRequest(String uid, String tid, String title, String body, String imagePath, bool isGroup) → Future<SendMessageResult>

构建图片请求

sendMessage(LVIMMsg msg) → Future<SendMessageResult>

发送消息，主要用于失败重发

sendMessageHasRead(String tid, int messageSendTime) → Future<SendMessageResult>

发送某条消息已读的消息

sendPrivateMessage(int messageType, String tid, String type, String content, LVPushContent? lvPushContent) → Future<SendMessageResult>

发送私信消息

sendPrivateMessageReadedAck(List<Map> listMsg, String sessionId) → Future<int>

设置私信已读消息 listMsg 需要被设置为已读的列表，最大条数最好不超过50条。 sessionId 私信传需要设置为已读消息的发送者uid，群组为会话id 成功返回0, 否则返回非0

sendPrivateReadedAckWithStime(int sTime, String sessionId) → Future<SendReadedAckWithStimeResult>

根据时间戳标记消息已读 sTime 时间戳 sessionId 会话ID，私聊时为对方的uid，群组时为群组id SendReadedAckWithStimeResult的字段eCode和rCode成功返回0, 否则返回非0

sendRoomMessage(String targetId, String msgContent, String msgType) → Future<SendMessageResult>

发送房间消息

sendVideoMessageRequest(String uid, String tid, String title, String body, String filePath, bool isGroup) → Future<SendMessageResult>

构建视频请求

setAVConfig(LVAVConfig config) → void

设置视频编码参数 @param config 视频分辨率 @discussion 注：如果后面设置的视频采集分辨率大于之前设置的分辨率，摄像头可能会进行重置操作

setBeautyLevel(LVBeauty beauty, double level) → void

设置美颜 @param beauty 目前包含：美颜、明亮度、饱和度 @param level 取值范围为0~1，关闭美颜传-1

setIMEventCallback(LVIMEventCallback callback) → void

设置SDK事件监听

setIMToken(String uid, String token) → void

setLogOpen(bool isOpen) → void

setMuteOutput(bool isMute) → void

静音推流 @param isMute 是否静音

setPlayQualityMonitor(int seconds) → void

设置拉流时数据统计信息回调的频率，回调方法请看 OnPlayQualityUpate 回调 @param seconds 回调频率

setPrivateDBStorageMax(int max) → Future<int>

设置私信消息最大存储量 如果接入方设置存储上限为1万，那么超过一万的消息就会被删除掉【删除距离现在时间最早的消息】 @param max 最大消息存储量

setPublishQualityMonitorCycle(int seconds) → void

设置推流时数据统计信息回调的频率，回调方法请看 OnPublishQualityUpdate 回调 @param seconds 回调频率

setVideoCallback(LinkVVideoCallback callback) → void

设置房间事件监听

setVideoConfig(int videoConfigLevel) → void

推流参数配置

startCapture(int viewId) → void

开始视频采集

startPlayingStream(String userId, bool isZOrderMediaOverlay) → void

开始播放一路音视频流，播放状态的变更通过 OnPlayStateUpdate:userId: 回调 @param isZOrderMediaOverlay surfaceView的层级 @param userId 要播放的音视频流用户 ID

startPublishing() → void

发布音视频数据（推流），如果登录房间时 isOnlyAudio 为 YES 则只发送音频数据，视频数据不发送，推流状态的变更通过 OnPublishStateUpdate: 回调

stopCapture(int viewId) → void

停止视频采集

stopPlayingStream(String userId) → void

停止播放一路音视频流 @param userId 要停止播放的音视频流用户 ID

stopPublishStream() → void

停止发布音视频数据

switchCamera(bool isFrontCamera) → void

切换摄像头 @param position 摄像头位置

transVideo(String uid, String tid, String title, String body, String filePath, bool isGroup) → Future<int>

转换视频数据 成功返回0, 否则返回非0

unInitImSDK() → void

卸载即时通讯SDK，销毁单例对象资源

unInitRtcAndImSDK() → void

卸载音视频和即时通讯SDK，销毁单例对象资源

unInitRtcSDK() → void

卸载音视频SDK，销毁单例对象资源

updateMsgAsReadByStime(String uid, int stime, int type) → Future<int>

把某个会话中小于等于stime的所有收到的未读消息标记为已读 @param uid 目标的id @param stime 消息的服务端时间戳 @param type 私信或群组消息 成功返回处理条数, 否则返回<0的值

updatePrivateMessageBlack(String uid, bool isAdd) → Future<int>

用户私信黑名单管理 uid 被拉黑的用户ID isAdd true为添加,false为删除 成功返回0, 否则返回非0

uploadPushToken(String token, {bool isSandbox = false}) → Future<UploadPushTokenResult>

上传push token @param token 推送的token UploadPushTokenResult的字段eCode返回0为成功，其它为错误码。 isSandbox 是否是沙盒环境，ios环境使用 默认false

Constants

EVENT_START_CAPTURE → const String

EVENT_STOP_CAPTURE → const String

IM_CMDTYPE_EVENT → const int

TYPE_MESSAGE_HAD_READ → const String