ERTC SDK API概览-Windows.mdERTC API概览ERTCEngine Api简介方法说明初始化getERtcShareInstance创建ERTCEngine实例destroyERtcShareInstance销毁ERtcEngine实例initialize初始化接口setCallback设置ERTC事件回调setAccessToken设置 ERTC AccessToken房间管理enterRoom加入房间exitRoom退出房间视频管理startLocalPreview开启本地摄像头的预览画面stopLocalPreview停止摄像头预览enableSmallVideoStream开启大小画面双路编码模式setVideoEncoderParam设置视频编码器的编码参数视频订阅startRemoteView订阅远端用户的视频流并绑定视频渲染控件stopRemoteView停止订阅远端用户的视频流并释放渲染控件setRemoteVideoStreamType切换指定远端用户的大小画面muteAllRemoteVideoStreams暂停/恢复订阅所有远端用户的视频流音频管理startLocalAudio开启本地音频的采集和发布stopLocalAudio停止本地音频的采集和发布enableAudioVolumeEvaluation启用音量大小提示屏幕共享管理startScreenCapture开始桌面端屏幕分享stopScreenCapture停止屏幕分享getScreenCaptureSources枚举可分享的屏幕和窗口网络测试startSpeedTest开始进行网速测试stopSpeedTest停止网络测试自定义消息sendCustomMsg发送自定义消息调试相关接口getSDKVersion获取 SDK 版本信息setPlatformAddr设置 测试 平台地址setConfigInfo通用配置(比方质量回调间隔)Api详情getERtcShareInstance创建ERTCEngine实例ERTC_API static ERtcEngine* getERtcShareInstance();destroyERtcShareInstance销毁 ERtcEngine 实例ERTC_API static void destroyERtcShareInstance();initialize初始化virtual int initialize(const ERTCEngineContext context) 0;setCallback设置事件回调virtual void setCallback(ERtcCallback* eventHandler) 0;enterRoom进入房间进入成功后自己端将收到onEnterRoomSuccess, 房间内其它用户将收到onRemoteUserEnterRoomvirtual int enterRoom(const ERTCParams param) 0;exitRoom退出房间退出后其它用户端将收到onRemoteUserLeaveRoomvirtual void exitRoom() 0;startLocalPreview开启本地摄像头的预览画面。加入房间前调用则加入后自动推流加入房间后调用则直接推流. 调用后其它用户将收到 onUserVideoAvailablevirtual int startLocalPreview(EView view) 0;stopLocalPreview停止摄像头预览。加入房间前调用则加入后自动推流加入房间后调用则直接推流. 调用后其它用户将收到 onUserVideoAvailablevirtual void stopLocalPreview() 0;startLocalAudio开启本地音频的采集和发布调用成功后其它用户将收到 onUserAudioAvailablevirtual void startLocalAudio() 0;stopLocalAudio停止本地音频的采集和发布调用成功后其它用户将收到 onUserAudioAvailablevirtual void stopLocalAudio() 0;setVideoEncoderParam设置视频编码参数virtual void setVideoEncoderParam(const ERTCVideoEncParam param) 0;enableSmallVideoStream开启大小画面双路编码模式,默认开启大码流如果开启小码流则是大小码流一起推送virtual void enableSmallVideoStream(bool enable, const ERTCVideoEncParam smallVideoEncParam) 0;enableAudioVolumeEvaluation启用音量大小提示 开启此功能后SDK 会 onUserVoiceVolume 回调中反馈远端音频的音量大小 如需打开此功能请在 enableLocalAudio 之前调用才可以生效virtual void enableAudioVolumeEvaluation(unsigned int interval) 0;说明interval 设置 onUserVoiceVolume 回调的触发间隔单位为ms最小间隔为100ms如果小于等于 0 则会关闭回调建议设置为500msstartScreenCapture开启屏幕共享virtual void startScreenCapture(EView view, const ERTCScreenCaptureSourceInfo source, ERTCVideoEncParam* encParam) 0;stopScreenCapture停止屏幕分享virtual void stopScreenCapture() 0;sendCustomMsg发送自定义消息给房间内所有用户virtual bool sendCustomMsg(const uint8_t* data, uint32_t dataSize) 0;说明待发送的消息单个消息的最大长度被限制为 1KBstartSpeedTest开始网络测试virtual int startSpeedTest(const ERTCSpeedTestParams params) 0;stopSpeedTest停止网络测试virtual void stopSpeedTest() 0;startRemoteView订阅远端用户的视频流并绑定视频渲染控件virtual void startRemoteView(const char* userId, ERTCVideoStreamType streamType, EView view) 0;startRemoteView停止订阅远端用户的视频流并释放渲染控件virtual void stopRemoteView(const char* userId, ERTCVideoStreamType streamType) 0;muteAllRemoteVideoStreams暂停/恢复订阅所有远端用户的视频流virtual void muteAllRemoteVideoStreams(bool mute) 0;getSDKVersion获取 SDK 版本信息virtual const char* getSDKVersion() 0;setPlatformAddr设置 测试 平台地址virtual void setPlatformAddr(const char* addr) 0;setConfigInfo通用配置(比方质量回调间隔)virtual void setConfigInfo(ERTCConfigKey key, int value) 0;萤石致力于成为全球领先的智能视觉物联网服务商构建了全球领先的视觉物联网云平台打造了硬件产品软件云服务一体化的物联网服务体系。萤石云通过构建多数据中心就近服务点的方式服务于全球客户。截至2025 年底萤石物联网云平台在全球拥有超过120 个数据站点平台上的IoT 设备接入数超过3.6 亿其中视频类设备超过3 亿。在夯实自身平台能力的基础上萤石进一步开放技术能力将物联价值延伸至千行百业。萤石开放平台深度融合AI中台能力涵盖音视频多媒体、消息通知处理、智能算法调度、视频存储备份、ERTC、大数据、物联接入等已为智慧连锁、智慧养老、文教娱乐、畜牧养殖等42万余位行业客户提供数智化转型升级支撑萤石物联专有云支持专有化部署助力中大型企业和组织的数字化转型升级。