JRTCExpressEngine class

JRTCExpressEngine

Available extensions

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

createCanvasView(dynamic onViewCreated(int viewID), String viewTag, {Key? key}) → Future<Widget?>

Available on JRTCExpressEngine, provided by the JRTCExpressCanvasViewUtils extension

获取到对应的VideoView。
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

instance → JRTCExpressEngine
JRTCExpressEngine singleton instance
final
onAudioOutputTypeChange ↔ void Function(int audioRouteType)?
音频输出类型变化回调。
getter/setter pair
onCameraUpdate ↔ void Function()?
摄像头变化回调。
getter/setter pair
onChannelUpdate ↔ void Function(String channelId, ChannelInfo channelInfo)?
频道属性变化回调。
getter/setter pair
onClientInitResult ↔ void Function(bool result)?
SDK初始化事件的回调 @param result 初始化结果
getter/setter pair
onError ↔ void Function(int reason)?
SDK内部报错回调。
getter/setter pair
onMessageReceived ↔ void Function(String channelId, String fromUserId, String content)?
接收频道消息的回调。
getter/setter pair
onNeedKeyFrame ↔ void Function()?
标记下一次输入关键帧回调。
getter/setter pair
onOtherJoined ↔ void Function(String channelId, UserInfo userInfo)?
新成员加入回调。
getter/setter pair
onOtherLeft ↔ void Function(String channelId, UserInfo userInfo)?
成员离开回调。
getter/setter pair
onRenderReceived ↔ void Function()?
收到第一帧数据回调
getter/setter pair
onRenderStart ↔ void Function()?
渲染开始回调
getter/setter pair
onSelfJoined ↔ void Function(String channelId, bool result, int reason, UserInfo userInfo)?
加入频道结果回调。
getter/setter pair
onSelfJoinStateChange ↔ void Function(String channelId, int state, int oldState)?
自身频道状态变化回调。
getter/setter pair
onSelfLeft ↔ void Function(String channelId, int reason)?
离开频道结果回调。
getter/setter pair
onUserUpdate ↔ void Function(String channelId, UserInfo userInfo)?
成员更新回调。
getter/setter pair
onVideoError ↔ void Function()?
视频渲染错误回调
getter/setter pair
onVolumeChange ↔ void Function(String channelId, String uid, int volume)?
成员声音变化回调。
getter/setter pair

Static Methods

createEngine(String appKey, JRTCEngineConfig config) → Future<bool>
初始化JRTCSDK。
debug(String tag, String msg) → Future<int>
写入debug级别日志
destroyEngine() → Future<void>
释放资源。
enableAudioOutput(String channelId, bool enable) → Future<int>
开启/关闭音频输出。
enableScreenShare(String channelId, bool enable, ScreenShareParam param) → Future<int>
开启/关闭屏幕分享。
enableSpeaker(bool enable) → Future<int>
开启/关闭扬声器。
enableVideoFile(bool enable) → Future<int>
启动视频文件输入源。
error(String tag, String msg) → Future<int>
写入error级别日志
freezeRenderEffect(String videoCavansTag, bool enable) → Future<int>
是否冻结渲染。
getAllCameras() → Future<List<JRTCMediaDeviceCamera>?>
获取所有的摄像头列表。
getAudioOutputData(int sampleRateHz, int channels) → Future<Uint8List>
获取音频输出数据。
getAudioRoute() → Future<int>
获取音频路由类型。
getCamera() → Future<JRTCMediaDeviceCamera?>
获取当前已打开的摄像头或者默认摄像头。
getCameraMaxZoom() → Future<int>
获取摄像头最大缩放级别。
getCameraMinZoom() → Future<int>
获取摄像头最小缩放级别。
getExposureCompensationStep() → Future<double>
获取摄像头曝光补偿步长
getMaxExposureCompensation() → Future<int>
获取摄像头曝光补偿最大值,单位EV
getMinExposureCompensation() → Future<int>
获取摄像头曝光补偿最小值,单位EV
getNetType() → Future<int>
网络类型。
getSdkVersion() → Future<String?>
获取SDK版本号。
getStatistics(String channelId) → Future<String>
获取频道的统计信息
hasNet() → Future<bool>
是否有网。
info(String tag, String msg) → Future<int>
写入info级别日志
inputCustomAudioData(int sampleRateHz, int channels, Uint8List list, int playDelayMS, int recDelayMS, int clockDrift) → Future<int>
将音频输入数据输入到媒体层。
inputVideoFileFrame(Uint8List list, int format, int width, int height, int angle, int mirror, bool keyFrame) → Future<int>
将视频输入数据输入到媒体层。
isCameraTorchSupported() → Future<bool?>
查询摄像头是否支持闪光灯.
joinChannel(String channelId, String uid, String? token, JRTCEngineChannelConfig config) → Future<int>
加入频道。
leaveChannel(String channelId) → Future<int>
离开频道。
muteLocalAudioStream(String channelId, bool mute) → Future<int>
是否发送静音包。
muteLocalVideoStream(String channelId, bool mute) → Future<int>
是否停止发送本地视频流。
playAudio(int iSampleRateHz, int iChannels) → Future<int>
播放音频
playRemoteAudioStream(String channelId, String uid, bool play) → Future<int>
订阅或取消订阅指定用户音频，并播放，默认订阅远端音频。
playRemoteVideoStream(String channelId, String uid, String viewTag, int viewID, bool play, int pictureSize, int renderType, double width, double height) → Future<String>
开始或停止渲染指定用户的视频，默认不订阅远端视频。
publishLocalAudioStream(String channelId, bool publish) → Future<int>
开启或关闭发送本地音频流。
publishLocalVideoStream(String channelId, bool publish) → Future<int>
开启或关闭发送本地视频流。
sendMessage(String channelId, String content, String? toUserId) → Future<int>
发送文本消息。
setCameraExposureLevel(int level) → Future<int?>
设置手动曝光度。
setCameraExposureLevelIos(double level) → Future<int?>
IOS设置手动曝光度。
setCameraFocus(double xPercent, double yPercent) → Future<int>
设置触屏对焦。
setCameraTorchOn(bool enable) → Future<int?>
设置是否打开闪光灯。
setCameraZoom(int zoomRatio) → Future<int>
设置摄像头缩放级别。
setLocalCaptureAngle(int angle) → Future<int>
设置本地视频采集窗体角度--设置本地采集的视频角度。
setMediaConfig(JRTCEngineMediaConfig config) → Future<int>
设置JRTCEngineMediaConfig。
setRenderAngle(String videoCavansTag, int angle) → Future<int>
旋转角度，必须是90的倍数，该角度表示与屏幕正方向旋转后的夹角。
setRenderEffect(String videoCavansTag, String enEffectType, String strJson, Uint8List? extraObjs) → Future<int>
设置渲染特效。
setRenderMirror(String videoCavansTag, int mirrorType) → Future<int>
设置本地渲染的画面镜像。
startLocalVideoDevice(JRTCMediaDeviceCamera? camera, String viewTag, int viewID, int renderType, bool play, double width, double height) → Future<String?>
启动视频模块，是否开启本地视频采集并渲染。
startScreenShareVideo(String viewTag, int viewID, String channelId, int renderType, int pictureSize, bool play, double width, double height) → Future<String>
启动频道成员的屏幕分享视频渲染。
stopAudio() → Future<int>
停止播放音频
switchCamera(JRTCMediaDeviceCamera camera) → Future<int>
切换摄像头
takeOnceSnapshot(String videoCavansTag, int width, int height, String? filePath) → Future<int>
视频画面截图。
uploadLog(String reason) → Future<int>
上传log日志