jc_sdk 2.16.2 copy "jc_sdk: ^2.16.2" to clipboard
jc_sdk: ^2.16.2 copied to clipboard

Published 20 days ago
SDKFlutter
PlatformAndroidiOS
→

Metadata

JC Flutter SDK is a flutter plugin wrapper based on Juphoon RTC SDK (Android & IOS), providing real-time audio/video services.

More...

JC Dart API Reference for Flutter 2.16.2 #

概况 #

  • [JCClient] 用于初始化sdk以及登录 Juphoon Cloud 平台
  • [JCClientCallback] 用于回调登录相关事件
  • [JCMediaDevice] 用于管理设备
  • [JCMediaDeviceCallback] 用于回调设备相关事件
  • [JCMediaVolumeCallback] 用于回调音量相关事件
  • [JCCall] 用于管理一对一通话
  • [JCCallCallback] 用于回调一对一通话相关事件
  • [JCMediaChannel] 用于管理多方通话
  • [JCMediaChannelCallback] 用于回调多方通话相关事件

登录管理 #

方法 描述
[JCClient.create] 创建 JCClient 对象
[JCClient.destroy] 销毁 JCClient 对象
[JCClient.getAppkey] 获取Appkey
[JCClient.setForeground] 设置是否为前台
[JCClient.getState] 获取当前状态
[JCClient.login] 登录 Juphoon Cloud 平台
[JCClient.logout] 登出 Juphoon Cloud 平台

登录事件 #

事件 描述
[JCClientCallback.onLogin] 登录结果回调
[JCClientCallback.onLogout] 登出回调
[JCClientCallback.onClientStateChange] 登录状态变化通知

账号管理 #

方法 描述
[JCClient.setDisplayName] 设置昵称
[JCClient.getDisplayName] 获取昵称
[JCClient.getCreateParam] 获取创建参数
[JCClient.getLoginParam] 获取登录参数
[JCClient.getUserId] 获得用户标识

在线消息 #

方法 描述
[JCClient.sendOnlineMessage] 发送在线消息

在线消息事件 #

方法 描述
[JCClientCallback.onOnlineMessageSendResult] 在线消息发送结果
[JCClientCallback.onOnlineMessageReceive] 收到在线消息

设备管理 #

事件 描述
[JCMediaDevice.create] 创建 JCMediaDevice 对象
[JCMediaDevice.destroy] 销毁 JCMediaDevice 对象

音频管理 #

方法 描述
[JCMediaDevice.isSpeakerOn] 扬声器是否已打开
[JCMediaDevice.isAudioStart] 音频是否已打开
[JCMediaDevice.startAudio] 启动音频
[JCMediaDevice.stopAudio] 停止音频
[JCMediaDevice.enableSpeaker] 开启关闭扬声器
[JCMediaDevice.getAudioRouteType] 音频路由类型
[JCMediaDevice.setAudioFrameCallback] 设置语音观测器对象
[JCMediaDevice.inputCustomAudioData] 将音频输入数据输入到媒体层
[JCMediaDevice.getAudioOutputData] 获取音频输出数据
[JCMediaDevice.getOutputVolume] 获取音频播放音量
[JCMediaDevice.getInputVolume] 获取音频采集音量
[JCMediaDevice.addVolumeCallback] 添加音量上报回调
[JCMediaDevice.removeVolumeCallback] 移除音量上报回调

音频事件 #

事件 描述
[JCMediaDeviceCallback.onAudioOutputTypeChange] 音频输出类型变化
[JCAudioFrameCallback.onAudioInputFrame] 获得采集的音频
[JCAudioFrameCallback.onAudioOutputFrame] 获得播放的音频
[JCMediaDeviceCallback.onAudioError] 音频设备报错
[JCMediaDeviceCallback.onAudioResume] 音频设备恢复
[JCCallCallback.onEarlyMediaReceived] 收到早期媒体的回调
[JCCallCallback.onSipRingInfoReceived] 收到早期媒体的回调收到sip振铃信息
[JCMediaVolumeCallback.outputVolume] 音频播放数据音量
[JCMediaVolumeCallback.inputVolume] 音频采集数据音量

视频管理 #

方法 描述
[JCMediaDevice.isCameraOpen] 摄像头是否已打开
[JCMediaDevice.getCamera] 获取当前的摄像头
[JCMediaDevice.getCameras] 获取摄像头列表
[JCMediaDevice.startCameraVideo] 开始自身视频渲染
[JCMediaDevice.startVideo] 开始其他端的视频渲染
[JCMediaDevice.stopVideo] 停止视频渲染
[JCMediaDevice.startCamera] 开启摄像头
[JCMediaDevice.stopCamera] 关闭摄像头
[JCMediaDevice.switchCamera] 切换摄像头
[JCMediaDevice.switchCamera(JCMediaDeviceCamera)] 切换摄像头(指定摄像头)
[JCMediaDevice.setCameraProperty] 设置摄像头采集属性
[JCMediaDevice.setScreenCaptureProperty] 设置屏幕共享采集属性
[JCMediaDevice.getCameraType] 获得摄像头类型
[JCMediaDevice.isVideoFileOpen] 文件视频源是否已开启
[JCMediaDevice.getVideoFileId] 获取文件视频源渲染id
[JCMediaDevice.startVideoFile] 开启视频文件作为视频输入源
[JCMediaDevice.setVideoFileFrame] 逐帧采集视频画面
[JCMediaDevice.stopVideoFile] 关闭逐帧采集画面
[JCMediaDevice.setVideoAngle] 设置视频窗体角度
[JCMediaDevice.getVideoAngle] 获取视频窗体角度
[JCMediaDevice.setVideoFrameCallback] 设置视频观测器对象

视频事件 #

事件 描述
[JCMediaDeviceCallback.onCameraUpdate] 摄像头变化
[JCMediaDeviceCallback.onRenderReceived] 收到第一帧数据
[JCMediaDeviceCallback.onRenderStart] 渲染开始
[JCVideoFrameCallback.onVideoCaptureFrame] 获得采集的视频
[JCVideoFrameCallback.onVideoRenderFrame] 获得播放的视频

一对一通话管理 #

方法 描述
[JCCall.create] 创建 JCCall 对象
[JCCall.destroy] 销毁 JCCall 对象
[JCCall.call] 发起一对一呼叫
[JCCall.term] 挂断
[JCCall.answer] 接听
[JCCall.mute] 静音
[JCCall.muteSpeaker] 音频输出静音
[JCCall.muteMicrophone] 音频输入静音
[JCCall.setMicScale] 麦克风声音放大
[JCCall.hold] 呼叫保持
[JCCall.becomeActive] 切换活跃通话
[JCCall.getCallItems] 获得通话对象列表
[JCCall.getActiveCallItem] 获得当前活跃的通话
[JCCall.getStatistics] 获得当前通话统计信息

一对一通话事件 #

事件 描述
[JCCallCallback.onCallItemAdd] 新增通话回调
[JCCallCallback.onCallItemRemove] 移除通话回调
[JCCallCallback.onCallItemUpdate] 通话状态更新回调
[JCCallCallback.onMissedCallItem] 上报服务器拉取的未接来电

通话录音管理 #

方法 描述
[JCCall.audioRecord] 语音通话录音
[JCCall.videoRecord] 视频通话录制

DTMF #

方法 描述
[JCCall.sendDtmf] 发送DTMF信息

DTMF事件 #

方法 描述
[JCCallCallback.onDtmfReceived] 通话中收到DTMF回调

通话中消息管理 #

方法 描述
[JCCall.sendMessage "sendMessage" 通过通话建立的通道发送数据

通话中消息事件 #

方法 描述
[JCCallCallback.onMessageReceive] 通话中收到消息的回调

通话媒体参数管理 #

方法 描述
[JCCall.updateMediaConfig] 更新媒体参数
[JCCall.getMediaConfig] 获得当前的媒体参数

通话视频流管理 #

方法 描述
[JCCall.enableUploadVideoStream] 开启关闭视频流发送

频道管理 #

方法 描述
[JCMediaChannel.create] 创建 JCMediaChannel 对象
[JCMediaChannel.destroy] 销毁 JCMediaChannel 对象
[JCMediaChannel.getChannelUri] 获得频道 Uri
[JCMediaChannel.getChannelId] 获得频道标识
[JCMediaChannel.getPassword] 获得频道密码
[JCMediaChannel.getChannelNumber] 获得频道号
[JCMediaChannel.getTitle] 返回频道标题
[JCMediaChannel.getState] 返回当前在频道中的状态
[JCMediaChannel.query] 查询频道相关信息
[JCMediaChannel.join] 加入频道
[JCMediaChannel.leave] 离开频道
[JCMediaChannel.stop] 关闭频道
[JCMediaChannel.setCustomProperty] 设置频道自定义属性
[JCMediaChannel.getCustomProperty] 获取自定义频道属性
[JCMediaChannel.setCustomRole] 设置自定义角色
[JCMediaChannel.getCustomRole] 获得自定义角色
[JCMediaChannel.setCustomState] 设置自定义状态
[JCMediaChannel.getCustomState] 获得自定义状态
[JCMediaChannel.getSelfParticipant] 获得自身 JCMediaChannelParticipant 对象

频道事件 #

事件 描述
[JCMediaChannelCallback.onMediaChannelStateChange] 自身状态变化回调
[JCMediaChannelCallback.onMediaChannelPropertyChange] 属性变化回调
[JCMediaChannelCallback.onJoin] 加入频道结果回调
[JCMediaChannelCallback.onLeave] 离开频道结果回调
[JCMediaChannelCallback.onStop] 解散频道结果回调
[JCMediaChannelCallback.onQuery] 查询频道信息结果回调

频道音视频管理 #

方法 描述
[JCMediaChannel.getAudioOutput] 获取音频是否输出
[JCMediaChannel.enableUploadAudioStream] 开启关闭发送本地音频流
[JCMediaChannel.enableUploadVideoStream] 开启关闭发送本地视频流
[JCMediaChannel.enableAudioOutput] 开启关闭音频输出
[JCMediaChannel.requestVideo] 请求频道中其他用户的视频流
[JCMediaChannel.getStatistics] 获取统计信息
[JCMediaChannel.enableSelfVideoRatio] 设置自身视频宽高比
[JCMediaChannel.getMaxResolution] 获得频道最大分辨率

成员管理 #

事件 描述
[JCMediaChannel.getParticipants] 获得所有频道中的成员
[JCMediaChannel.getParticipant] 获取频道成员
[JCMediaChannel.inviteSipUser] 邀请Sip用户
[JCMediaChannel.kick] 将成员踢出会议
[JCMediaChannel.subscribeParticipantAudio] 订阅或取消订阅指定用户的声音

成员事件 #

事件 描述
[JCMediaChannelCallback.onParticipantJoin] 新成员加入回调
[JCMediaChannelCallback.onParticipantLeft] 成员离开回调
[JCMediaChannelCallback.onParticipantUpdate] 成员更新回调
[JCMediaChannelCallback.onInviteSipUserResult] 邀请Sip用户操作结果回调
[JCMediaChannelCallback.onParticipantVolumeChange] 成员声音变化

Cdn推流 #

事件 描述
[JCMediaChannel.enableCdn] 开关Cdn推流
[JCMediaChannel.getCdnState] 获得cdn推流状态

服务器录制 #

事件 描述
[JCMediaChannel.enableRecord] 开关视频录制
[JCMediaChannel.getRecordState] 获取视频录制状态

音频数据上传 #

事件 描述
[JCMediaChannel.getUploadLocalAudio] 获取本地音频数据是否在上传

视频数据上传 #

事件 描述
[JCMediaChannel.getUploadLocalVideo] 获取本地视频数据是否在上传

频道消息管理 #

事件 描述
[JCMediaChannel.sendMessage] 发送消息
[JCMediaChannel.sendCommand] 发送指令
[JCMediaChannel.sendCommandToDelivery] 发送命令给推流或录制器

频道消息事件 #

事件 描述
[JCMediaChannelCallback.onMessageReceive] 接收频道消息的回调

屏幕共享 #

事件 描述
[JCMediaChannel.requestScreenVideo] 请求屏幕共享的视频流
[JCMediaChannel.enableScreenShare] 开关屏幕分享
[JCMediaChannel.getScreenRenderId] 获取屏幕共享渲染标识
[JCMediaChannel.getScreenUserId] 获取开启屏幕共享的用户标识
[JCMediaChannel.startScreenShareVideo] 启动屏幕共享视频渲染
[JCMediaChannel.stopScreenShareVideo] 停止屏幕共享视频渲染

← Metadata

1
likes
145
points
160
downloads

Publisher

unverified uploader

Weekly Downloads

Metadata

JC Flutter SDK is a flutter plugin wrapper based on Juphoon RTC SDK (Android & IOS), providing real-time audio/video services.

Homepage

Documentation

API reference

License

Apache-2.0 (license)

Dependencies

flutter, plugin_platform_interface

More

Packages that depend on jc_sdk

Packages that implement jc_sdk

Back