概述
更新时间：2025-05-07
概述
本文档主要介绍如何将 RTC macOS SDK 集成到您的项目中，并介绍各类功能的使用方法。在使用本文档前，您需要先了解RTC的一些基本知识，并已经开通了RTC服务。若您还不了解RTC，可以参考产品描述。
RTC macOS SDK 能够帮助您实现登录音视频通信房间并开始通信，并可以对发布/订阅、音视频参数、设备参数进行设置。
接口概览
RTC macOS SDK 提供以下接口
初始化接口
| API | 描述 |
|---|---|
| initSDKWithAppID | 初始化SDK |
| setParamSettings | 音视频相关参数设置 |
| getParamSettings | 获取音视频相关设置参数 |
| setEngineStateStatistics | RTC统计信息开关 |
房间相关接口
| API | 描述 |
|---|---|
| loginRtcRoomWithRoomName | 登录房间 |
| logoutRtcRoom | 退出房间 |
| kickOffUserWithId | 踢除聊天 |
| shutUpUserWithId | 禁言 |
| disbandRoom | 解散房间 |
| queryUserListOfRoom | 查询媒体用户 |
| queryMessageUserListOfRoom | 查询房间用户 |
发布/订阅流相关接口
| API | 描述 |
|---|---|
| publishStreaming | 发布流 |
| stopPublishStreaming | 停止发布流 |
| subsribeStreaming | 订阅流 |
| stopSubscribeStreaming | 停止订阅流 |
消息相关接口
| API | 描述 |
|---|---|
| sendMessage2 | 广播消息 |
| sendMessage2WithUserId | 指定用户发送消息 |
| setUserAttribute | attribute 属性设置 |
| getUserAttribute | attribute属性获取 |
视频相关接口
| API | 描述 |
|---|---|
| startPreview | 本地预览 |
| stopPreview | 停止预览 |
| setLocalDisplay | 本地显示view设置 |
| setRemoteDisplay | 远端view设置 |
| setRemoteDisplay: userId: | 多人模式设置指定用户远端view |
| updateDisplay: userId: | 多人模式更新指定用户远端view |
| setVideoCaptureFactory | 外部采集代理设置 |
| setRenderDelegate | 外部渲染代理设置 |
| setRemoteVideoPlayState | 设置远端视频流订阅状态 |
摄像头相关接口
| API | 描述 |
|---|---|
| switchCamera | 摄像头切换 |
| muteCamera | 关闭/打开摄像头 |
| setCameraFace | 关闭/打开摄像头 |
| cameraFocusWithPoint | 摄像头对焦 |
音频相关接口
| API | 描述 |
|---|---|
| muteMicphone | 关闭麦克风 |
| getRemoteAudioLevels | 获取远端用户音量 |
| setRemoteAudioPlayState | 指定某个远端用户音频暂停/播放 |
美颜相关接口
| API | 描述 |
|---|---|
| setWhitenFactor | 美白度设置 |
| setRedenFactor | 红润度设置 |
| setBuffingFactor | 磨皮度设置 |
转推配置相关接口
| API | 描述 |
|---|---|
| configLiveServerWithUrl | 转推配置 |
通知相关接口
| API | 描述 |
|---|---|
| onRoomEventUpdate | 用户信息通知 |
| onPeerConnectStateUpdate | server端连接状态通知 |
| onStreamInfoUpdate | 媒体流通知 |
| onErrorInfoUpdate | 错误通知 |
| onEngineStatisticsInfo | RTC引擎状态信息统计 |
| onTextMessageArrival2 | 消息通知 |
| onTextMessageAttribute | 属性更新通知 |
其他接口
| API | 描述 |
|---|---|
| version | 版本号 |
| setUseTestEnv | 是否启用测试环境 |
| setVerbose | 是否打开调试信息 |
| upLoadLog | 上报日志 |
| setBaiduRtcAppID | 动态设置AppId和TokenStr |
| queryEngineStatisticsInfo | 查询RTC统计信息 |
| enableStatsToServer | RTC统计信息上报 |