详情

该方法初始化一个 AgoraRtcEngineKit 单例。使用 AgoraRtcEngineKit，必须先调用该接口进行初始化。

详情

该方法用于释放 Agora SDK 使用的所有对象资源。帮助偶尔使用音视频通话的 App 在无需通话时释放资源。一旦 App 调用了 destroy 接口销毁创建的 AgoraRtcEngineKit 实例，将无法调用 SDK 内的任何方法也不再会有任何回调产生。如需重启通话，请调用初始化方法 sharedEngineWithAppId:delegate: 创建一个新的 AgoraRtcEngineKit 实例。

Note:

• 该方法需要在子线程中操作
• 该方法为同步调用。 App 不得在 SDK 生成的回调中调用该方法，不然 SDK 只能等候该回调返回才能重新获取相应的对象资源造成死锁。

详情

Agora SDK 需知道应用程序的使用场景(例如通信模式或直播模式), 从而使用不同的优化手段。

目前 Agora Native SDK 支持以下几种模式:

• 通信模式 (默认)
• 直播模式
• 游戏语音模式 （仅适用于 Agora Gaming SDK）

Note:

• 相同频道内的所有用户必须使用相同的频道模式。
• 如果想要切换模式，则需要先调用 destroy 销毁当前引擎，然后在 sharedEngineWithAppId 方法重新创建引擎，再调用该方法切换频道模式。
• 该方法必须在加入频道前调用和进行设置，进入频道后无法再设置。
• 目前通信模式下不支持自采集的 Texture 编码，只支持原始音视频数据。

详情

该方法仅适用于直播模式。

在加入频道前，用户需要通过本方法设置观众(默认)或主播模式。在加入频道后，用户可以通过本方法切换用户模式。

详情

该方法让用户加入通话频道，在同一个频道内的用户可以互相通话，多个用户加入同一个频道，可以群聊。 使用不同 App ID 的 App 是不能互通的。如果已在通话中，用户必须调用 leaveChannel 退出当前通话，才能进入下一个频道。 SDK 在通话中使用 iOS 系统的 AVAudioSession 共享对象进行录音和播放， App 对该对象的操作可能会影响 SDK 的音频相关功能。

调用该 API 后会触发 joinSuccessBlock 或 didJoinChannel 回调。block 比 delegate 优先级高，如果两种回调都实现了，只有 block 会触发。若需要触发 delegate 回调 didJoinChannel，请将 joinSuccessBlock 设置为 nil。

Note:

频道内每个用户的 UID 必须是唯一的。如果将 UID 设为 0，系统将自动分配一个 UID。

详情

离开频道，即挂断或退出通话。

当调用 joinChannelByToken 方法后，必须调用 leaveChannel 结束通话，否则无法开始下一次通话。 不管当前是否在通话中，都可以调用本方法，没有副作用。该方法会把会话相关的所有资源释放掉。该方法是异步操作，调用返回时并没有真正退出频道。在真正退出频道后，SDK 会触发 didLeaveChannelWithStats 回调。

Note:

• 如果你调用了本方法后立即调用 destroy 方法，SDK 将无法触发 didLeaveChannelWithStats 回调。

• 如果你在旁路推流时调用本方法， SDK 将自动调用 removePublishStreamUrl 方法。

• 在调用本方法时，iOS 默认情况下 SDK 会停用 audio session，可能会对其他应用程序造成影响。如果想改变这种默认行为，可以通过setAudioSessionOperationRestriction 方法设置 AgoraAudioSessionOperationRestrictionDeactivateSession，这样在 leaveChannel 时，SDK 不会停用 audio session。

详情

该方法用于更新 Token。如果启用了 Token 机制，过一段时间后使用的 Token 会失效。当以下任意一种情况发生时：

• tokenPrivilegeWillExpire 回调
• didOccurError 回调报告 ERR_TOKEN_EXPIRED(-109)
• rtcEngineRequestToken 报告 ERR_TOKEN_EXPIRED(-109)

App 应重新获取 Token，然后调用该 API 更新 Token，否则 SDK 无法和服务器建立连接。

详情

该方法仅适用于直播模式。通信模式默认与 Web SDK 互通，无需调用该方法。

详情

本方法可以启用音频模块。（音频模块默认为开启状态）

Note:

• 该方法设置的是内部引擎为开启状态，在频道内和频道外均可调用，且在 leaveChannel 后仍然有效。

• 该方法重置整个引擎，响应速度较慢，因此 Agora 建议使用如下方法来控制音频模块：

  • enableLocalAudio：是否启动麦克风采集并创建本地音频流
  • muteLocalAudioStream：是否发布本地音频流
  • muteRemoteAudioStream：是否接收并播放远端音频流
  • muteAllRemoteAudioStreams：是否接收并播放所有远端音频流

详情

Note:

• 该方法设置的是内部引擎为禁用状态，在频道内和频道外均可调用，且在 leaveChannel 后仍然有效。

• 该方法重置整个引擎，响应速度较慢，因此 Agora 建议使用如下方法来控制音频模块：

  • enableLocalAudio：是否启动麦克风采集并创建本地音频流
  • muteLocalAudioStream：是否发布本地音频流
  • muteRemoteAudioStream：是否接收并播放远端音频流
  • muteAllRemoteAudioStreams：是否接收并播放所有远端音频流

详情

Note:

• 该方法需要在 joinChannelByToken 之前设置好，joinChannelByToken 之后设置不生效
• 通信模式下，该方法设置 profile 生效，设置 scenario 不生效
• 通信和直播模式下，音质（码率）会有网络自适应的调整，通过该方法设置的是一个最高码率
• 音乐教学场景下，建议将 profile 设置为 AgoraAudioProfileMusicHighQuality（4），scenario 设置为 AgoraAudioScenarioGameStreaming（3）

详情

该方法允许 SDK 定期向 App 反馈当前谁在说话以及说话者的音量。

详情

当 App 加入频道时，它的语音功能默认是开启的。该方法可以关闭或重新开启本地语音功能，停止或重新开始本地音频采集及处理。

该方法不影响接收或播放远端音频流，适用于只听不发的用户场景。

语音功能关闭或重新开启后，会收到回调 didMicrophoneEnabled。

该方法需要在 joinChannelByToken 之后调用才能生效。

该方法与 muteLocalAudioStream 的区别在于：

• enableLocalAudio：开启或关闭本地语音采集及处理

• muteLocalAudioStream：停止或继续发送本地音频流

详情

该方法用于允许/禁止往网络发送本地音频流。

Note:

该方法不影响录音状态，并没有禁用麦克风。

详情

Note:

如果之前有调用过 muteAllRemoteAudioStreams(YES) 对所有远端音频进行静音，在调用本 API 之前请确保你已调用 muteAllRemoteAudioStreams(NO) 。 muteAllRemoteAudioStreams 是全局控制，muteRemoteAudioStream 是精细控制。

详情

该方法在加入频道前后都可调用。如果加入频道后调用该方法，会收不到后面加入频道的用户的音频流。

详情

该方法用于打开视频模式。可以在加入频道前或者通话中调用，在加入频道前调用，则自动开启视频模式，在通话中调用则由音频模式切换为视频模式。调用 disableVideo 方法可关闭视频模式。

Note:

• 该方法设置的是内部引擎为启用状态，在 leaveChannel 后仍然有效。

• 该方法重置整个引擎，响应速度较慢，因此 Agora 建议使用如下方法来控制视频模块：

  • enableLocalVideo：是否启动摄像头采集并创建本地视频流
  • muteLocalVideoStream：是否发布本地视频流
  • muteRemoteVideoStream：是否接收并播放远端视频流
  • muteAllRemoteVideoStreams：是否接收并播放所有远端视频流

详情

该方法用于关闭视频。可以在加入频道前或者通话中调用，在加入频道前调用，则自动开启纯音频模式，在通话中调用则由视频模式切换为纯音频模式。调用 enableVideo 方法可开启视频模式。

Note:

• 该方法设置的是内部引擎为启用状态，在 leaveChannel 后仍然有效。

• 该方法重置整个引擎，响应速度较慢，因此 Agora 建议使用如下方法来控制视频模块：

  • enableLocalVideo：是否启动摄像头采集并创建本地视频流
  • muteLocalVideoStream：是否发布本地视频流
  • muteRemoteVideoStream：是否接收并播放远端视频流
  • muteAllRemoteVideoStreams：是否接收并播放所有远端视频流

详情

该方法设置视频编码配置。每个配置对应一套视频参数，如分辨率、帧率、码率、视频方向等。 所有设置的参数均为理想情况下的最大值。当视频引擎因网络环境等原因无法达到设置的分辨率、帧率或码率的最大值时，会取最接近最大值的那个值。

如果加入频道后不需要重新设置视频编码配置，Agora 建议在 enableVideo 之前调用该方法，可以加快首帧出图时间。

Note:

在 v2.3.0 版本中，如下接口已废弃，Agora 不再推荐使用:

• setVideoProfile
• setVideoResolution

详情

该方法设置本地视频显示信息。 App 通过调用此接口绑定本地视频流的显示视图(view)，并设置视频显示模式。 在 App 开发中，通常在初始化后调用该方法进行本地视频设置，然后再加入频道。退出频道后，绑定仍然有效，如果需要解除绑定，可以指定空(NIL)View 调用本方法。

详情

该方法绑定远端用户和显示视图，即设定 uid 指定的用户用哪个视图显示。调用该接口时需要指定远端用户的 uid，一般可以在进频道前提前设置好。

如果 App 不能事先知道对方的 uid，可以在 APP 收到 didJoinedOfUid 事件时设置。如果启用了视频录制功能，视频录制服务会做为一个哑客户端加入频道，因此其他客户端也会收到它的 didJoinedOfUid 事件，App 不应给它绑定视图（因为它不会发送视频流），如果 App 不能识别哑客户端，可以在 firstRemoteVideoDecodedOfUid 事件时再绑定视图。解除某个用户的绑定视图可以把 view 设置为空。退出频道后，SDK 会把远端用户的绑定关系清除掉。

详情

该方法设置本地视图显示模式。 App 可以多次调用此方法更改显示模式。

详情

该方法设置远端视图显示模式。 App 可以多次调用此方法更改显示模式。

详情

该方法用于在进入频道前启动本地视频预览。调用该 API 前，必须

• 调用 setupLocalVideo 设置预览窗口及属性
• 调用 enableVideo 开启视频功能

启用了本地视频预览后，如果调用 leaveChannel 退出频道，本地预览依然处于启动状态，如需要关闭本地预览，需要调用 stopPreview 。

详情

该方法禁用/启用本地视频功能。该方法用于只看不发的视频场景。

请在 enableVideo 后调用本方法，否则本方法可能无法正常使用。

调用 enableVideo 后，本地视频默认开启。使用该方法可以开启或关闭本地视频采集，且不影响接收远端视频。

Note:

该方法设置的是内部引擎为启用/禁用状态，在 leaveChannel 后仍然有效。

详情

调用该方法时，SDK 不再发送本地视频流，但摄像头仍然处于工作状态。相比于 enableLocalVideo 用于控制本地视频流发送的方法，该方法响应速度更快。

该方法不影响本地视频流获取，没有禁用摄像头。

详情

该方法用于允许/禁止接收所有人的视频流。

详情

Note:

如果之前有调用过 muteAllRemoteVideoStreams (YES) 暂停接收所有远端视频，在调用本 API 之前请确保你已调用 muteAllRemoteVideoStreams (NO)。 muteAllRemoteVideoStreams 是全局控制，muteRemoteVideoStream 是精细控制。

详情

该方法设置接收到的语音从听筒或扬声器出声。如果用户不调用本方法，语音默认从听筒出声。

Note:

• 该方法仅适用于 iOS。
• 该方法只在纯音频模式下工作，在有视频的模式下不工作。
• 该方法需要在 joinChannelByToken 前设置，否则不生效。

各频道模式下默认的语音路由：

• 语音通话：听筒
• 视频通话：扬声器。如果有用户在频道中使用 disableVideo、muteLocalVideoStream 或 muteAllRemoteVideoStreams 关闭视频，则语音路由会自动切换回听筒。
• 直播：扬声器
• 游戏语音：扬声器

详情

该方法设置是否将语音路由到扬声器（外放）。

Note:

• 该方法仅适用于 iOS。
• 请确保在调用此方法前已调用过 joinChannelByToken 方法。
• SDK 会调用 setCategory(AVAudioSessionCategoryPlayAndRecord) 并配置耳麦或者外放，所以调用该方法后所有声音的路由都会按照该方法设置。
• 调用该方法后，SDK 将返回 didAudioRouteChanged 回调提示状态已更改。
• 使用耳机的时候调用该方法不会生效。

详情

该方法仅适用于 iOS。

详情

该方法仅适用于 iOS 平台。

详情

该方法仅适用于 iOS 平台。

详情

该方法改变本地说话人声音的音调。

详情

指定本地或在线音频文件来和麦克风采集的音频流进行混音或替换。替换是指用指定的音频文件替换麦克风采集到的音频流。该方法可以选择是否让对方听到本地播放的音频，并指定循环播放的次数。调用本方法播放音乐文件结束后，会触发 rtcEngineLocalAudioMixingDidFinish 回调。

Note:

• 使用本方法前请确保你的 iOS 设备版本不低于 8.0。
• 请在频道内调用该方法，如果在频道外调用该方法可能会出现问题。
• 如果播放的是在线音乐文件，请确保重复调用该 API 的间隔超过 100 ms，否则 SDK 会返回 AudioFileOpenTooFrequent（702）警告码，表示音乐文件打开过于频繁。

详情

请在频道内调用该方法。

详情

请在频道内调用该方法。

详情

请在频道内调用该方法。

详情

该方法调节混音的音乐文件在本地和远端播放的音量大小。请在频道内调用该方法。

详情

该方法调节混音的音乐文件在本地播放的音量大小。请在频道内调用该方法。

详情

该方法调节混音的音乐文件在远端播放的音量大小。请在频道内调用该方法。

详情

该方法获取音乐文件时长，单位为毫秒。请在频道内调用该方法。如果返回值 < 0，表明调用失败。

详情

请在频道内调用该方法。

详情

该方法可以设置音频文件的播放位置，这样你可以根据实际情况播放文件，而不是非得从头到尾播放一个文件。

详情

该方法可以播放指定音效文件来给应用增加音效，比如游戏中特定操作的音效。调用该方法播放音效结束后，会触发 rtcEngineDidAudioEffectFinish 回调。

详情

为保证通信畅通，请注意控制预加载音效文件的大小，并在 joinChannel 前就使用该方法完成音效预加载。

音效文件支持以下音频格式: mp3，aac，m4a，3gp，wav

详情

Agora SDK 支持通话过程中在客户端进行录音。该方法录制频道内所有用户的音频，并生成一个包含所有用户声音的录音文件，录音文件格式可以为:

• .wav: 文件大，音质保真度高
• .aac: 文件小，有一定的音质保真度损失

请确保 App 里指定的目录存在且可写。该接口需在 joinChannelByToken 之后调用。如果调用 leaveChannel 时还在录音，录音会自动停止。

详情

停止录音。

Note:

该接口需要在 leaveChannel 之前调用，不然会在调用 leaveChannel 时自动停止。

详情

该方法仅适用于 macOS。

启用声卡采集功能后，声卡播放的声音会被合到本地音频流中，从而可以发送到远端。

Note:

macOS 系统默认声卡不支持采集功能，如需开启此功能需要 App 自己启用一个虚拟声卡，并将该虚拟声卡的名字作为 deviceName 传入 SDK。 Agora 测试并推荐 soundflower 作为虚拟声卡。

详情

该方法仅适用于 iOS 平台。

该方法限制 Agora SDK 对 Audio Session 的操作权限。在默认情况下，SDK 和 App 对 Audio Session 都有控制权，但某些场景下，App 会希望限制 Agora SDK 对 Audio Session 的控制权限，而使用其他应用或第三方组件对 Audio Session 进行操控。调用该方法可以实现该功能。

该接口可以在任意时候调用，可以在任意时候通过该方法把控制权交还给 SDK。

Note:

一旦调用该方法限制了 Agora SDK 对 Audio Session 的控制权限， SDK 将无法对 Audio Session 进行相关设置，而需要用户自己或第三方组件进行维护。

详情

该方法启动语音通话测试，目的是测试系统的音频设备（耳麦、扬声器等）和网络连接是否正常。 在测试过程中，用户先说一段话，在 10 秒后，声音会回放出来。如果 10 秒后用户能正常听到自己刚才说的话，就表示系统音频设备和网络连接都是正常的。

Note:

• 调用 startEchoTest 后必须调用 stopEchoTest 以结束测试，否则不能进行下一次回声测试，或者调用 joinChannelByToken 进行通话。
• 直播模式下，只有主播用户才能调用该方法。如果用户由通信模式切换到直播模式，请务必调用 setClientRole 方法将用户角色设置为主播后再调用该方法。

详情

该方法启用网络连接质量测试，用于检测用户网络接入质量。默认该功能为关闭状态。

该方法主要用于以下场景: - 用户加入频道前，可以调用该方法判断和预测目前的上行网络质量是否足够好。 - 直播模式下，当用户角色想由观众切换为主播时，可以调用该方法判断和预测目前的上行网络质量是否足够好。

启用该方法会消耗一定的网络流量，影响通话质量。在收到 lastmileQuality 回调后须调用 disableLastmileTest 停止测试，再加入频道或切换用户角色。

Note:

• 调用该方法后，在收到 lastmileQuality 回调之前请不要调用其他方法，否则可能会由于 API 操作过于频繁导致此回调无法执行。
• 直播模式下，主播请勿调用该方法。

详情

该方法设置视频源。实时通讯过程中，Agora SDK 通常会启动默认的视频输入设备，即内置的摄像头，进行视频推流。当需要自定义视频设备时，App 可以先通过 AgoraVideoSourceProtocol 自定义视频源，然后调用该方法将自定义的视频源加入到 SDK 中。

详情

该方法设置本地视频渲染器。实时通讯过程中，Agora SDK 通常会启动默认的视频渲染器进行视频渲染。当需要自定义视频渲染设备时，App 可以先通过 AgoraVideoSinkProtocol 自定义渲染器，然后调用该方法将视频渲染器加入到 SDK 中。

详情

该方法设置远端视频渲染器。实时通讯过程中，Agora SDK 通常会启动默认的视频渲染器进行视频渲染。当需要自定义视频渲染设备时，App 可以先通过 AgoraVideoSinkProtocol 自定义渲染器，然后调用该方法将视频渲染器加入到 SDK 中。

详情

该方法获取远端视频渲染器。

详情

Note:

如果使用了外部视频源，请在调用 enableVideo 或 startPreview 之前调用此 API。

详情

该方法主动将视频帧数据用 AgoraVideoFrame 类封装后传递给 SDK。请确保在你调用本方法前已调用 setExternalVideoSource，并将参数 pushMode 设为 YES，不然调用本方法后会一直报错。

Note:

该接口目前仅支持在直播模式下推送 Texture 格式的视频帧；视频通话模式下不支持。

详情

该方法设置 onRecordAudioFrame 回调数据的格式，详情请参考修改原始音频数据

详情

该方法设置 onPlaybackAudioFrame 回调数据的格式，详情请参考修改原始音视频数据

详情

该方法设置 onMixedAudioFrame 回调数据的格式，详情请参考修改原始音视频数据

详情

该方法将一张 PNG 图片作为水印添加到本地发布的直播视频流上，同一直播频道中的观众，旁路推流观众，甚至录制设备都能看到或采集到该水印图片。 如果你仅仅希望在旁路推流推流中添加水印，请参考 设置直播转码 setLiveTranscoding 中描述的用法。

Note:

• 在本地直播和旁路推流中，URL 的定义不同。本地直播中，URL 指本地直播视频上水印图片的本地绝对路径；旁路推流中，URL 指旁路推流视频上水印图片的 HTTP/HTTPS 地址
• 水印图片的源文件格式必须是 PNG。如果待添加的 PNG 图片的尺寸与你该方法中设置的尺寸不一致，SDK 会对 PNG 图片进行裁剪，以与设置相符
• Agora 当前只支持在直播视频流中添加一个水印，后添加的水印会替换掉之前添加的水印
• 如果你在 setVideoEncoderConfiguration 方法中将 orientationMode 设置为 Adaptive 模式，则如果视频帧在播放端发生旋转，水印也会以其左上角为坐标原点，跟着视频帧旋转。

详情

网络不理想的环境下，发送音视频的质量都会下降。启用本地发布音视频流回退之后，SDK 会在上行弱网且音视频质量严重受影响时，自动关断视频流，从而保证或提高音频质量。同时 SDK 会持续监控网络质量，并在网络质量改善时恢复音视频流。 当本地发送的音视频流回退为音频流时，或由音频流恢复为音视频流时，SDK 会触发 本地发送的音视频流已回退为音频流 回调。

Note:

旁路推流场景下，设置本地发布音视频流回退为仅音频流可能会导致远端的 CDN 用户听到声音的时间有所延迟。因此在有旁路推流的场景下，Agora 建议不要设置回退。

详情

网络不理想的环境下，订阅音视频的质量都会下降。使用该接口开启订阅音视频流的回退选项后，SDK 会在下行弱网且音视频质量严重受影响时，将视频流切换为小流，或关断视频流，从而保证或提高通信质量。同时 SDK 会持续监控网络质量，并在网络质量改善时恢复音视频流。当远端订阅流回退为音频流时，或由音频流恢复为音视频流时，SDK 会触发 远端订阅流已回退为音频流 回调。

详情

使用该方法设置单流（默认）或者双流模式。发送端开启双流模式后，接收端可以选择接收大流还是小流。 其中，大流指高分辨率、高码率的视频流，小流指低分辨率、低码率的视频流。

详情

如果发送端选择发送视频双流（大流或小流），接收端可以选择接收大流还是小流。其中大流可以理解为高分辨率高码率的视频流，小流则是低分辨率低码率的视频流。该方法可以根据视频窗口的大小动态调整对应视频流的大小，以节约带宽和计算资源。

本方法调用状态将在 didApiCallExecute 中返回。

Agora SDK 默认收到视频大流。如需使用视频小流，调用本方法进行切换。

• 如果发送端用户已调用 enableDualStreamMode 启用了双流模式，SDK 默认接收大流。如需接收小流，可调用本方法进行切换。
• 如果发送端用户未启用双流模式，SDK 默认接收大流。

视频小流默认的宽高比和视频大流的宽高比一致。根据当前大流的宽高比，系统会自动分配小流的分辨率、帧率及码率。

详情

该方法设置远端视频默认为大流或小流。

详情

在加入频道之前， App 需调用 setEncryptionSecret() 指定 secret 来启用内置的加密功能，同一频道内的所有用户应设置相同的 secret。 当用户离开频道时，该频道的 secret 会自动清除。如果未指定 secret 或将 secret 设置为空，则无法激活加密功能。

Note:

请不要在旁路推流时调用此方法。

详情

Agora Native SDK 支持内置加密功能，默认使用 AES-128-XTS 加密方式。如需使用其他加密方式，可以调用该 API 设置。同一频道内的所有用户必须设置相同的加密方式和 secret 才能进行通话。关于这几种加密方式的区别，请参考 AES 加密算法的相关资料。

在调用本方法前，请先调用 setEncryptionSecret 启用内置加密功能。

Note:

请不要在旁路推流时调用此方法。

详情

该方法通过在服务端拉取视频流并发送到频道中，将正在播放的视频导入到正在进行的直播中。可主要应用于赛事直播、多人看视频互动等直播场景。状态回调为 streamPublishedWithUrl。 导入成功后会触发 didJoinedOfUid 和 firstRemoteVideoDecodedOfUid 回调，UID 为 666，该音视频流会出现在频道中。

详情

成功删除后会触发 didOfflineOfUid 回调，UID 为 666。

详情

该方法用于添加旁路推流地址，会触发回调 streamPublishedWithUrl 。

Note:

• 请确保在成功加入频道后再调用该接口。
• 该方法每次只能增加一路旁路推流地址。若需推送多路流，则需多次调用该方法。
• URL 不支持中文等特殊字符。

详情

该方法用于删除旁路推流过程中已经设置的 RTMP 推流地址。

Note:

• 该方法每次只能删除一路旁路推流地址。若需删除多路流，则需多次调用该方法。
• URL 不支持中文等特殊字符。

详情

该方法用于创建数据流。频道内每人最多只能创建 5 个数据流。频道内数据通道最多允许数据延迟 5 秒，若超过 5 秒接收方尚未收到数据流，则数据通道会向 App 报错。 目前 Agora Native SDK 支持 99% 可靠和 100% 有序的数据传输。

Note:

请将 reliable 和 ordered 同时设置为 YES 或 NO，暂不支持交叉设置。

详情

该方法发送数据流消息到频道内所有用户。SDK 对该方法的实现进行了如下限制：频道内每秒最多能发送 30 个包，且每个包最大为 1 KB。 每个客户端每秒最多能发送 6 KB 数据。频道内每人最多能同时有 5 个数据通道。

Note:

该方法仅适用于通信模式以及直播模式下的主播用户，如果直播模式下的观众调用此方法可能会造成观众变主播。

详情

该方法仅适用于直播模式。在网络条件不好或者设备性能不足影响到直播体验的情况下，可以使用该方法设置是否要优先保障流畅度。

详情

该方法设置本地视频镜像模式，须在开启本地预览前设置。如果在开启预览后设置，需要重新开启预览才能生效。

详情

本方法仅适用于 iOS 平台，不适用于 macOS。

详情

本方法仅适用于 iOS 平台，不适用于 macOS。

详情

Note:

• 本方法仅适用于 iOS 平台，不适用于 macOS。
• 一般情况下，App 默认开启前置摄像头，因此如果你的前置摄像头不支持闪光灯常开，直接使用该方法会返回 NO。如果需要检查后置摄像头是否支持闪光灯常开，需要先使用 switchCamera 切换摄像头，再使用该方法。

详情

本方法仅适用于 iOS 平台，不适用于 macOS。

详情

本方法仅适用于 iOS 平台，不适用于 macOS。

详情

本方法仅适用于 iOS 平台，不适用于 macOS。

详情

本方法仅适用于 iOS 平台，不适用于 macOS。

详情

本方法仅适用于 iOS 平台，不适用于 macOS。

详情

本方法仅适用于 iOS 平台，不适用于 macOS。

详情

本方法仅适用于 iOS 平台，不适用于 macOS。

详情

本方法仅适用于 iOS 平台，不适用于 macOS。

详情

该方法仅支持 macOS 平台，不支持 iOS 平台。

详情

该方法仅支持 macOS 平台，不支持 iOS 平台。

详情

该方法仅支持 macOS 平台，不支持 iOS 平台。

详情

该方法仅支持 macOS 平台，不支持 iOS 平台。

该方法用来启动设备插拔检测，这里设备指的是音视频外接设备，比如外接摄像头等。

详情

该方法仅支持 macOS 平台，不支持 iOS 平台。

该方法返回一个 NSArray 对象，包含系统中所有的音视频设备。应用程序可以通过 AgoraRtcDeviceInfo array 对象枚举设备。

Note:

不要在主线程调用该方法。

详情

该方法仅支持 macOS 平台，不支持 iOS 平台。

该方法通过 type 获取当前录音、外放或视频采集设备名称。

详情

该方法仅支持 macOS 平台，不支持 iOS 平台。

该方法通过 deviceId 参数指定播放、录音或视频采集设备。

详情

该方法仅支持 macOS 平台，不支持 iOS 平台。

该方法获取当前设备的音量。

详情

该方法仅支持 macOS 平台，不支持 iOS 平台。

设置录音或外放的音量。

详情

该方法仅支持 macOS 平台，不支持 iOS 平台。

该方法测试麦克风是否能正常工作。启动测试后，SDK 通过 reportAudioVolumeIndicationOfSpeakers 回调方法向应用程序上报音量信息。

详情

该方法仅支持 macOS 平台，不支持 iOS 平台。

该方法停止麦克风测试。调用 startRecordingDeviceTest 后，必须调用该方法停止测试。

详情

该方法仅支持 macOS 平台，不支持 iOS 平台。

该方法测试播放设备是否能正常工作。SDK 播放指定的音频文件，测试者如果能听到声音，说明播放设备能正常工作。

详情

该方法仅支持 macOS 平台，不支持 iOS 平台。

该方法停止播放设备测试。调用 startPlaybackDeviceTest 后，必须调用该方法停止测试。

详情

该方法仅支持 macOS 平台，不支持 iOS 平台。

用于测试当前视频采集设备是否工作正常，使用前需保证已调用过 enableVideo ，且传入参数的 view 窗口有效。

详情

该方法仅支持 macOS 平台，不支持 iOS 平台。

停止视频采集设备测试，如果之前调用了 startCaptureDeviceTest，必须通过该方法停止测试。

详情

客户端在每次 joinChannelByToken 后会生成一个对应的 CallId，标识该客户端的此次通话。有些方法如 rate，complain需要在通话结束后调用，向 SDK 提交反馈，这些方法必须指定 CallId 参数。使用这些反馈方法，需要在通话过程中调用 getCallId 方法获取 CallId，在通话结束后在反馈方法中作为参数传入。

详情

该方法能够让用户为通话评分，一般在通话结束后调用。

详情

该方法让用户就通话质量进行投诉。一般在通话结束后调用。

详情

如果不分发回调方法到主队列， App 应将 UI 操作分发到主队列。

详情

该方法返回当前 SDK 版本号。

详情

设置 SDK 的输出 log 文件。SDK 运行时产生的所有 log 将写入该文件。 App 必须保证指定的目录存在而且可写。

Note:

iOS 平台下日志文件的默认地址为：Library/caches/agorasdk.log。

详情

该方法获取 native SDK engine 的 C++ handle，用于包括注册音视频帧观测器在内的特殊场景。

详情

Agora Native SDK 通过指定的 delegate 通知 App 引擎运行时的事件。Delegate 中定义的所有方法都是可选实现的。

详情

JSON 选项默认不公开。声网工程师正在努力寻求以标准化方式公开 JSON 选项。

详情

该方法未公开，请联系声网支持 support@agora.io 获取详情。

详情

DEPRECATED 从 v2.3 起废弃

详情

DEPRECATED 从 v2.3 起废弃

详情

DEPRECATED 从 v2.3 起废弃

详情

DEPRECATED 从 v2.3 起废弃

该方法设置音频高音质选项。请在加入频道前调用本方法并一次性设置好三个模式。切勿在加入频道后再次调用本方法。

详情

DEPRECATED 从 v2.3 起废弃

该方法仅支持 macOS 平台，不支持 iOS 平台。

详情

DEPRECATED 从 v2.3 起废弃

该方法设置视频编码属性（Profile）。每个属性对应一套视频参数，如分辨率、帧率、码率等。 当设备的摄像头不支持指定的分辨率时，SDK 会自动选择一个合适的摄像头分辨率，但是编码分辨率仍然用本方法指定的。

Note:

• 应在调用 enableVideo 后设置视频属性。
• 应在调用 joinChannelByToken/startPreview前设置视频属性。
• 如果加入频道后不需要重新设置视频编码属性，Agora 建议在 enableVideo 之前调用该方法，可以加快首帧出图时间。

详情

DEPRECATED 从 v2.3 起废弃

如果加入频道后不需要重新设置视频编码属性，Agora 建议在 enableVideo 之前调用该方法，可以加快首帧出图时间。

详情

DEPRECATED

该方法已被废弃。虽然你仍然可以调用该接口，声网推荐您使用以下接口：

• addPublishStreamUrl
• removePublishStreamUrl
• setLiveTranscoding

详情

DEPRECATED

该方法已被废弃。声网不建议您使用。如果您希望设置旁路推流布局，请调用 setLiveTranscoding 方法。

该方法用于在旁路推流中设置画中画布局，仅适用于从声网服务器推流的情况。当您从声网服务器推流时，您需要：

1. 设置一张画布、及其宽高（视频分辨率）、背景色以及希望显示的视频流的数目。
2. 定义画布上每条视频流的位置和尺寸以及是否裁剪或者缩放适配。

推流的 App 在生成 H.264 视频流并通过 RTMP 协议将其推送到 CDN 供应商时，会将定制布局的格式信息以 JSON 形式打包进每个关键帧辅助增强信息 SEI。

Note:

• 加入频道后再调用该方法。
• 在同一频道内 App 只能允许一个用户调用该方法。如果多个用户调用了该方法，其他用户必须调用 clearVideoCompositingLayout 方法移除相关设置。

详情

DEPRECATED

该方法用于在调用 setVideoCompositingLayout 方法后移除相关设置。

详情

DEPRECATED 从 v2.3 起废弃

详情

DEPRECATED 从 v2.3 起废弃

该方法仅支持 macOS 平台，不支持 iOS 平台。

该方法通过 type 获取当前录音、外放或视频采集设备名称。

详情

DEPRECATED 从 v2.3 起废弃

详情

DEPRECATED 从 v1.1 起废弃

默认禁用。可通过 enableAudioVolumeIndication 方法开启；开启后，无论频道内是否有人说话，都会按方法中设置的时间间隔返回提示音量。

详情

DEPRECATED 从 v1.1 起废弃

提示第一帧本地视频画面已经显示在屏幕上。

详情

DEPRECATED 从 v1.1 起废弃

详情

DEPRECATED 从 v1.1 起废弃

提示已收到第一帧远端视频流并解码。

详情

DEPRECATED 从 v1.1 起废弃

提示有用户加入了频道。如果该客户端加入频道时已经有人在频道中，SDK 也会向应用程序上报这些已在频道中的用户。

详情

DEPRECATED 从 v1.1 起废弃

提示有用户离开了频道（或掉线）。SDK 判断用户离开频道（或掉线）的依据是超时：在一定时间内（15 秒）没有收到对方的任何数据包，判定为对方掉线。在网络较差的情况下，可能会有误报。建议可靠的掉线检测应该由信令来做。

详情

DEPRECATED 从 v1.1 起废弃

提示有用户将通话静音/取消静音。

详情

DEPRECATED 从 v1.1 起废弃

详情

DEPRECATED 从 v1.1 起废弃

报告更新本地视频统计信息，该回调方法每两秒触发一次。

详情

DEPRECATED 从 v1.1 起废弃

报告更新远端视频统计信息,该回调方法每两秒触发一次。

详情

DEPRECATED 从 v1.1 起废弃

提示已成功打开摄像头，可以开始捕获视频。

详情

DEPRECATED 从 v1.1 起废弃

该回调方法表示 SDK 与服务器失去了网络连接。

详情

DEPRECATED 从 v1.1 起废弃

有时候由于网络原因，客户端可能会和服务器失去连接，SDK 会进行自动重连，自动重连成功后触发此回调方法，提示有用户重新加入了频道，且频道 ID 和用户 ID 均已分配。

详情

DEPRECATED 从 v1.1 起废弃

该回调定期上报 Rtc Engine 的运行时的状态，每两秒触发一次。

详情

DEPRECATED 从 v1.1 起废弃

显示用户离开了频道，提供会话数据信息，包括通话时长和 tx/rx 字节数。

详情

DEPRECATED 从 v1.1 起废弃

在通话中，该回调方法每两秒触发一次，报告当前通话的（嘴到耳）音频质量。

详情

DEPRECATED 从 v1.1 起废弃

该回调每 2 秒触发，向 App 报告频道内所有用户当前的上行、下行网络质量。

详情

DEPRECATED 从 v1.1 起废弃

报告本地用户的网络质量。该回调方法每两秒触发一次。

详情

DEPRECATED 从 v1.1 起废弃