TCICController class

Constructors

TCICController({bool playbackMode = false})

Properties

assetPathCache → Map<String, String>
final
documentController → DocumentObs
no setter
hashCode → int
The hash code for this object.
no setterinherited
heartBeatInterval ↔ int
getter/setter pair
imInitSuccess ↔ bool
getter/setter pair
imLoginSuccess ↔ bool
getter/setter pair
isClassEndedLocked → bool
no setter
isRecording → bool
获取录制状态
no setter
isTCICDestroy ↔ bool
getter/setter pair
joinClassSuccess ↔ bool
getter/setter pair
joinClassTimeStamp ↔ int
getter/setter pair
networkObs → NetworkObs
no setter
networkService → NetworkService
final
networkTipsObs → NetworkTipsObs
no setter
playbackMode → bool
回放模式:跳过 TRTC 实例化(回放仅用 media_kit/ExoPlayer 播 mp4 + TIW WebView 回放, 不进行实时音视频,无需在冷启动时拉起 liteav 全量初始化,避免与白板 WebView 抢 CPU)。 若回放中确有功能用到 TRTC,TRTC.getInstance 内部已是懒加载,会按需创建。
final
recordingFilePath → String?
获取录制文件路径
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sharedPreferences ↔ SharedPreferences
latefinal
sharedPreferencesFuture ↔ Future<SharedPreferences>
latefinal
skipQuitClass ↔ bool
getter/setter pair
taskController → TaskController
no setter
toolsController → ToolsController
no setter
userSig ↔ String?
getter/setter pair

Methods

addDocument(DocumentInfo doc) → dynamic
addLivePlayerListener(V2TXLivePlayer livePlayer) → void
addTRTCListener() → Future<void>
addWhiteboardBoard() → Future<void>
添加白板
addWhiteboardEventListener(String eventName, dynamic callback(dynamic)) → Future<void>
添加白板事件监听器
addWhiteboardImagesFile({required List<String> urls, String? title, bool? needSwitch}) → Future<void>
添加图片文件
addWhiteboardSyncData(String data) → Future<void>
添加同步数据
addWhiteboardTranscodeFile({required String title, required int pages, required String resolution, required String url}) → Future<void>
添加转码文件
addWhiteboardVideoFile({required String url, String? title, bool? needSwitch}) → Future<void>
添加视频文件
cancelHeartBeatTimer() → dynamic
checkCameraPermission() → Future<bool>
checkMicrophonePermission() → Future<bool>
cleanHandUpList() → dynamic
clearHandUpList() → Future<void>
clearLogFilePath() → dynamic
clearObsData() → dynamic
closeCamera(String from, {bool needUIDisabled = true, bool needToast = true}) → Future<void>
closeMic(String from, {bool needUIDisabled = true, bool needToast = true}) → Future<void>
closeSmallWindowMode() → Future<void>
debugTestNetworkTips({Duration step = const Duration(seconds: 5)}) → void
Debug/测试入口:通过直接修改 networkTipsObs.currentTip 演示网络状态 tip 的 UI 效果。
deleteWhiteboardBoard(String boardId) → Future<void>
删除白板
deleteWhiteboardFile(String fileId) → Future<void>
删除文件
destroy([bool needQuitClass = true]) → Future<void>
destroySharedInstance() → dynamic
enableMirror(bool enable) → Future<void>
endClass() → dynamic
enterRTCRoom(String from) → Future<void>
enterSmallWindowMode() → Future<void>
exitRTCRoom() → dynamic
fireMainBreakEvent(MainProcessBreakenEventEnum type, int errorCode, {String? requestId}) → dynamic
getAbsolutePathFromAsset(String assetPath) → Future<String>
getAllMembersObs() → AllMembersObs
getCallback() → TCICCallback
getCameraList() → Future<void>
getClassDocument() → Future<DocumentResult?>
getClassInfo() → Future<ClassInfo?>
getClassInfoFromServer(String from) → Future<ClassInfo?>
getClassInfoObs() → ClassInfoObs
getCloudControlConfig() → dynamic
getComponentConfig<T>(Type type) → T?
getComponentConfigObs() → ComponentConfigObs
getConfig() → TCICConfig
getCosToken() → Future<TGetCosTokenResult?>
getCpuMonitorObs() → CpuMonitorObs
getCurrentBoard() → Future<String?>
获取当前白板ID
getCurrentLoginUser() → String
getCurrentWhiteboardFile() → Future<String?>
获取当前文件ID
getDestroyFuture() → dynamic
getEffectiveChatTarget() → String
getEffectiveCmdTarget() → String
getErrorMessageFromErrorCode(int errorCode) → dynamic
getEventBus() → TCICEventbus
getHandsUpInfoObs() → HandsUpInfoObs
getHandUpList() → Future<void>
getIconController() → TCICIconController
getImJoinTargets() → Set<String>
getIsTCICDestroy() → bool
getLiveSteamInfoObs() → LiveSteamInfoObs
getLoopStageObs() → LoopStageObs
getMemberInfoByUserId(String userId) → Member?
getMemberList(String from, {String groupLiveCode = ''}) → dynamic
getMembersInfoObs() → MembersInfoObs
getMessageListObs() → IMMessageListObs
getMicrophoneList() → Future<void>
getNextPageMemberList({String groupLiveCode = ''}) → dynamic
getPermissionList() → Future<void>
getPip() → TCICPip
getPlayBackObs() → PlayBackObs
getResolutionByType(int type) → TRTCVideoResolution
getRole() → RoleEnum
getRootContext() → BuildContext?
getSchoolInfo() → Future<TCICGetSchoolInfoRepModel?>
getSchoolInfoAsync({TCICGetSchoolInfoRepModel? cacheSchoolInfo, bool needFireEvent = true}) → Future<TCICGetSchoolInfoRepModel?>
getSchoolInfoFromServer() → Future<TCICGetSchoolInfoRepModel?>
getSchoolInfoObs() → SchoolInfoObs
getScreenCaptureSources() → Future<TRTCScreenCaptureSourceList?>
getSelectedGroupLiveCode() → String
getSelfInfo() → Future<TCICSelfInfoModel?>
getSpeakerList() → Future<void>
getStateDataController() → TCICStateDataObs
getStateInfoObs() → TCICStateDataObs
getStreamType() → StreamTypeEnum
getStringObs() → StringObs
getSystemDocumentDir() → Future<String>
getTaskList(int seq) → Future<GetTaskResult?>
getThemeObs() → ThemeObs
getTRTCInstance() → dynamic
getTrtcStreamInfoObs() → TRTCStreamInfoObs
getUiInfoObs() → UiInfoObs
getVideoEncoderParam() → TRTCVideoEncParam?
getVirtualBackgroundData() → UnrealBgData
getWhiteboardToolType() → Future<double?>
获取工具类型
gotoWhiteboardBoard(String boardId) → Future<void>
跳转到指定白板
handUp(String userId) → Future<void>
handUpCancel(String userId) → Future<void>
hasBoardCustomStream() → bool
ignoreHandUp(List<String> members) → dynamic
initCpuMonitor() → Future<void>
initWhiteboard(Map<String, dynamic> config) → Future<void>
初始化白板
isAssistant() → bool
isBigRoom() → bool
isClassStart() → bool
isClassStarted() → bool
isGroupRoom() → bool
isInSmallWindowMode() → bool
isRandomChooseEnabled() → bool
isRelevantChatGroupId(String? groupId) → bool
isRelevantCmdGroupId(String? groupId) → bool
isSeizeAnswerEnabled() → bool
isSmallRoom() → bool
isStudent() → bool
isTeacher() → bool
joinClass() → Future<void>
keepScreenOff() → Future<void>
keepScreenOn() → Future<void>
loopUpStage() → dynamic
markClassEnded({String source = 'unknown'}) → bool
mergeLocalCloudControlConfig(Map<String, dynamic> localCloudControlConfigMap) → dynamic
muteAll() → dynamic
nextWhiteboardBoard() → Future<void>
下一页白板
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onAppToBackground() → Future<void>
onAppToForeground() → Future<void>
onlyExitRTCRoom() → dynamic
openCamera(String from, {bool needUIDisabled = true, bool needToast = true, bool byTap = false}) → Future<void>
openMic(String from, {bool needUIDisabled = true, bool needToast = true, bool byTap = false}) → Future<void>
openSystemAppSettings() → dynamic
pauseAudio(V2TXLivePlayer livePlayer) → Future<int>
pauseLivePlayer(LivePlayerTypeEnum playerType) → dynamic
pauseScreenCapture() → dynamic
popNavigator(BuildContext context, [bool useRootNavigator = false]) → dynamic
prevWhiteboardBoard() → Future<void>
上一页白板
quitClass() → dynamic
reEnterClass() → dynamic
removeLivePlayerListener(V2TXLivePlayer livePlayer) → void
removeTRTCListener() → Future<void>
resetComponentConfig() → dynamic
重置所有组件配置为默认值
resetControllerInstance() → void
resumeAudio(V2TXLivePlayer livePlayer) → Future<int>
resumeLivePlayer(LivePlayerTypeEnum playerType) → dynamic
resumeScreenCapture() → dynamic
rightPanelVisible(bool visible, RightPannelActionTypeEnum actionType, [dynamic data]) → dynamic
selectScreenCaptureTarget(TRTCScreenCaptureSourceInfo sourceInfo) → Future
selfErrorStatusReport(int state, StateTypeEnum type) → dynamic
sendAction(String userId, MemberActionType actionType) → Future<TCICActionRepModel?>
sendAward(String userId) → dynamic
sendAwardToAll() → dynamic
setAudioRoute(TXAudioRoute audioRoute) → Future<void>
setBeautyStyle(TRTCBeautyStyle style, int beautyLevel, int whitenessLevel, int ruddinessLevel) → Future<void>
setCallback(TCICCallback cb) → dynamic
setCameraType(int type) → Future<void>
setConfig(TCICConfig conf) → dynamic
setCurrentCamera(String id) → Future<void>
setCurrentMicrophone(String id) → Future<void>
setCurrentSpeaker(String id) → Future<void>
setCustomVirtualBackgroundImagePaths(List<String> imagePaths) → void
setCustomVirtualBackgroundImages(List<TCICVirtualBackgroundImage> images) → void
setIsInSmallWindowMode(bool value) → dynamic
setIsTCICDestroy(bool value) → dynamic
setLanguage(TranslateLangEnum language) → dynamic
setLayoutOrientation(LayoutOrientation orientation) → Future<void>
setLocalRenderParams(TRTCRenderParams params) → Future<void>
setMicVolume(int volume) → Future<void>
setRenderViewID(V2TXLivePlayer livePlayer, int viewId) → Future<int>
setTrtcLogLevel(TRTCLogLevel level) → dynamic
setupLiveplayer() → Future<void>
setUserInfo(String userName, String avatar) → Future<void>
setVedioPlaceHolder() → dynamic
setVideoEncoderParam(TRTCVideoResolution resolution, {int? fps, int? bitrate, TRTCVideoResolutionMode? resolutionMode}) → dynamic
setVirtualBackground({String? path, int? backgroundType, int? blurLevel, int? color, bool? enable}) → Future<void>
setVirtualBackgroundByIndex(int index) → Future<void>
setWhiteboardDrawEnable(bool enable) → Future<void>
设置绘制使能
setWhiteboardHandwritingEnable(bool enable) → Future<void>
设置手写使能
setWhiteboardToolType(int type) → Future<void>
设置工具类型
showHeaderBar() → void
showSmallWindowFloat() → Future<bool>
snapshotCustomLiveVideo() → Future<void>
snapshotLocalVideo() → dynamic
视频截图相关
snapshotRemoteVideo(String userId) → dynamic
snapshotWhiteboard() → Future<void>
截图
softTeardownForSwitch() → Future<void>
软销毁:为课堂自动切换场景设计,仅清理课堂级资源,保留:
startClass() → dynamic
startHeartBeat() → Future<void>
startLivePlay(V2TXLivePlayer livePlayer, String url) → Future<int>
startLivePlayer(LivePlayerTypeEnum playerType) → dynamic
startLocalPreview() → Future<void>
startScreenCapture([int? viewId]) → dynamic
startScreenRecording({String? fileName}) → Future<bool>
开始屏幕录制
startStageLoop() → dynamic
stopLivePlayer(LivePlayerTypeEnum playerType) → dynamic
stopLocalPreview() → Future<void>
stopPlay(V2TXLivePlayer livePlayer) → Future<int>
stopScreenCapture() → dynamic
stopScreenRecording() → Future<String?>
停止屏幕录制
stopStageLoop() → dynamic
switchLayoutOrientation({BuildContext? context}) → Future<void>
switchWhiteboardFile({required String fileId, String? boardId, String? stepIndex}) → Future<void>
切换文件
testNetwork() → Future<void>
toggleScreenRecording({String? fileName}) → Future
切换屏幕录制状态(开始/停止)
toolsVisible(bool visible) → dynamic
toString() → String
A string representation of this object.
inherited
triggerClassSwitch(String newClassId) → Future<void>
公开入口:软销毁 + 加入新课堂。供 ClassSwitcher 调用, 内部组合 softTeardownForSwitch 与 _joinNewClass。 抛 ClassSwitchError。
undoWhiteboard() → Future<void>
撤销操作
unmuteAll() → dynamic
updateAllMembersObs(TCICGetMemberListRepModel data) → dynamic
updateComponentConfig(TCICComponentConfig config) → dynamic
updateConfig(TCICConfig config) → dynamic
updatePerformanceMetrics() → dynamic
updateStageLoop() → dynamic
updateTask(UpdateTaskParams params) → dynamic
updateTeacherFloatingShown(bool shown) → void
updateVideoEncoderParam(TRTCVideoEncParam param) → Future<void>
uploadDocument({required String srcPath, required String fileName, required bool isPublic, required Uint8List? bytes}) → dynamic
白板相关
uploadLogs() → Future<bool>
uploadLogsToCos(File zipFile) → Future<bool>
上传日志工具函数 zipFile 压缩后的zip文件 @example
useRememberConfig() → dynamic
userLivePlayer() → dynamic

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

floatingManager → FloatingManager
final
heartBeatSeq ↔ int
getter/setter pair
instance → TCICController
no setter
isSmallWindowMode ↔ bool
getter/setter pair
layoutTimestamp ↔ int
getter/setter pair
pageInitTimestamp ↔ int
getter/setter pair
smallWindowFloating ↔ Floating?
getter/setter pair
smallWindowFloatingKey → String
final

Static Methods

setRootContext(BuildContext context) → void