sy_rtc_flutter_sdk library
Classes
- SyAudioDeviceInfo
- 音频设备信息
- SyAudioEffectConfiguration
- 音效配置
- SyAudioMixingConfiguration
- 音频混音配置
- SyAudioPublishStateChangedEvent
- 音频发布状态变化事件
- SyAudioRecordingConfiguration
- 本地录音配置。两端原生 SDK 规则相同:
- SyAudioRoutingChangedEvent
- 音频路由变化事件
- SyAudioSubscribeStateChangedEvent
- 音频订阅状态变化事件
- SyBeautyOptions
- 美颜配置
- SyChannelMessageEvent
- 频道消息事件(原始消息)
- SyConnectionStateChangedEvent
- 连接状态变化事件
- SyErrorEvent
- 错误事件
- SyFirstLocalVideoFrameEvent
- 视频大小变化事件 本地视频轨(摄像头、自定义采集或屏幕共享)新建后的第一帧。
- SyFirstRemoteVideoDecodedEvent
- 首帧远端视频解码事件
- SyFirstRemoteVideoFrameEvent
- 首帧远端视频渲染事件
- SyJoinChannelSuccessEvent
- 加入频道成功事件
- SyKickedEvent
- 被服务端踢出房间事件(控制面信令 / poll;非 SFU 强制断流)
- SyLeaveChannelEvent
- 离开频道事件
- SyLocalAudioStateChangedEvent
- 本地音频状态变化事件
- SyLocalVideoStateChangedEvent
- 本地视频状态变化事件
- SyNetworkQualityEvent
- 网络质量事件
- SyReconnectedEvent
-
重连成功(同时也会有
onRejoinChannelSuccess)。 - SyReconnectFailedEvent
-
重连次数用完。之后还会有
onError(1003),需要 leave 后重新 join。 - SyReconnectingEvent
-
开始第 attempt 次重连。reason 为
signaling或ice。 - SyReconnectPolicy
-
重连策略,与 Android
ReconnectPolicy、iOSSyRtcReconnectPolicy相同(原生执行,这里只是常量)。 - SyRejoinChannelSuccessEvent
- 重新加入频道成功事件
- SyRemoteAudioStateChangedEvent
- 远端音频状态变化事件
- SyRemoteVideoStateChangedEvent
- 远端视频状态变化事件
- SyRequestTokenEvent
- Token 已过期事件
- SyRoomInfo
- 房间信息
- SyRoomService
- SY RTC 房间服务
- SyRtcConfig
- SY RTC配置类
- SyRtcEngine
- SY RTC引擎主类
- SyRtcErrorCode
-
onError(code, message)的错误码。与 AndroidRtcErrorCode、iOSSyRtcErrorCode取值相同。 - SyRtcEvent
- SY RTC事件基类
- SyRtcEventHandler
- SY RTC事件处理器
- SyRtcStats
- 通话统计数据
- SyRtcStatsEvent
- 通话统计信息事件
- SyRtcVideoView
- Native video surface (AndroidView / UiKitView) wired to SyRtcEngine.setupLocalVideo / SyRtcEngine.setupRemoteVideo.
- SyScreenCaptureConfiguration
- 屏幕共享配置
- SySeiMessageEvent
- Android DataChannel 上的 SEI 风格消息。不是 H.264 码流 SEI。iOS 不会发这个事件。
- SyServerMuteAudioEvent
- 服务端静音/解静音事件(控制面 mute-audio;非 SFU ACL)
- SyStreamExtraInfoEvent
- 对端通过信令更新的流附加信息。同一条原文仍会先走频道消息。
- SyStreamMessageErrorEvent
- 数据流消息错误事件
- SyStreamMessageEvent
- 数据流消息事件
- SyTokenErrorEvent
- Token 业务错误事件。在通用 SyErrorEvent 之外再发一次,方便按码分支。
- SyTokenPrivilegeWillExpireEvent
- Token 即将过期事件(30秒前)
- SyUserJoinedEvent
- 用户加入事件
- SyUserMuteAudioEvent
- 远端用户静音/取消静音事件
- SyUserMuteVideoEvent
-
远端用户开关了自己的视频(两端互通,信令
user-media)。 - SyUserOfflineEvent
- 用户离开事件
- SyVideoDeviceInfo
- 视频设备信息
- SyVideoEncoderConfiguration
- 视频编码配置
- SyVideoQualityPreset
- 视频画质预设配置
- SyVideoSizeChangedEvent
- SyVolumeIndicationEvent
- 音量指示事件
Enums
- SyAudioCodecType
- 录音编码格式
- SyAudioProfile
- 音频配置
- SyAudioQualityLevel
- 音频质量等级
- SyAudioRecordingQuality
- 录音质量
- SyAudioRoute
- 播放路由。两端不同的原生整数在 Dart 层翻译成同一个枚举。
- SyAudioScenario
- 音频场景
- SyConnectionChangedReason
- 连接状态变化原因
- SyConnectionState
- 连接状态枚举
- SyDegradationPreference
- 编码降级偏好
- SyLocalAudioStreamError
- 本地音频流错误
- SyLocalAudioStreamState
- 本地音频流状态
- SyLocalVideoStreamError
- 本地视频流错误
- SyLocalVideoStreamState
- 本地视频流状态
- SyNetworkQuality
- 旧的网络质量枚举,名字与原生字符串一致。新代码请用 SyNetworkQualityLevel。
- SyNetworkQualityLevel
-
两端统一的网络质量档位(语义对齐 ZEGO
ZegoStreamQualityLevel)。 - SyQualityTier
- 后端 Token 画质档位。
- SyRemoteAudioState
- 远端音频状态
- SyRemoteAudioStateReason
- 远端音频状态原因
- SyRemoteVideoState
- 远端视频状态
- SyRemoteVideoStateReason
- 远端视频状态原因
- SyStreamPublishState
- 流发布状态
- SyStreamSubscribeState
- 流订阅状态
- SyTokenBusinessCode
-
访问凭证业务码(服务端
errcode.Credential*)。 - SyVideoMirrorModeType
- 视频镜像模式
- SyVideoOutputOrientationMode
- 视频输出方向模式
- SyVideoQualityLevel
- 画质等级
Constants
- kSyRtcFlutterSdkVersion → const String
- 与 pubspec、原生坐标、官网和包市场对齐的插件版本。
Functions
-
syConnectionReasonFromNative(
String raw) → SyConnectionChangedReason -
把原生 reason 映射到 SyConnectionChangedReason。两端 3.2.0 起用同一组字符串:
joining/join_success/signaling/ice/rejoin_success/leaving/leave。 -
syNetworkQualityFromNative(
String raw) → SyNetworkQuality - 把原生质量字符串映射成枚举。无法识别时返回 SyNetworkQuality.unknown。
Exceptions / Errors
- SyTokenException
-
Token 业务错误。仍然是 Exception,旧的
on Exception可以接住。