diff --git a/dita/RTC-AIDOC/API/api_agoramediametadatadatasource_metadatamaxsize.dita b/dita/RTC-AIDOC/API/api_agoramediametadatadatasource_metadatamaxsize.dita
new file mode 100644
index 00000000000..3a72abb7f33
--- /dev/null
+++ b/dita/RTC-AIDOC/API/api_agoramediametadatadatasource_metadatamaxsize.dita
@@ -0,0 +1,30 @@
+
+
+
+ 调用 调用 方法调用成功,返回你希望使用的元数据缓冲区的最大大小,单位为字节。最大值为 1024 字节。 方法调用成功,返回你希望使用的元数据缓冲区的最大大小,单位为字节。最大值为 1024 字节。
+ 该回调在 SDK 准备好发送元数据时触发。 该回调在 SDK 准备好发送元数据时触发。 当 SDK 准备好发送元数据时触发。 当 SDK 准备好发送元数据时触发。 你希望发送的元数据,格式为
+
+
你希望发送的元数据,格式为
+
你需要在调用
你需要在调用
你为原始视频数据设置的期望格式,详见
你为原始视频数据设置的期望格式,详见
+
触发该回调以报告类型为
触发该回调以报告类型为
该回调在媒体播放器接收到视频源的像素缓冲区时被触发。
+该回调在媒体播放器接收到视频源的像素缓冲区时被触发。
+
+
该回调在播放器每次接收到视频帧时被触发。
+该回调在播放器每次接收到视频帧时被触发。
+
+
当你需要使用播放器播放视频时,可以调用该方法向视频渲染器添加一个视图,以显示视频内容。
+当你需要使用播放器播放视频时,可以调用该方法将视图添加到视频渲染器中,以显示视频内容。
+你可以调用该方法将视图添加到视频渲染器中,以显示视频内容。
+你可以调用该方法将视图添加到视频渲染器中,以显示视频内容。
+当你需要使用播放器播放视频时,可以调用此方法将视图添加到视频渲染器中,以显示视频内容。
+该方法必须在调用
必须在调用
你必须在调用
你必须在调用
视图是否添加成功: +
+
+
+
在调用
+
在调用
你必须在调用
你需要在调用
你需要在调用
+
+
+
+
调用
调用
调用
该方法必须在调用
该方法必须在调用
必须在调用
必须在调用
+
调用失败时,SDK 会抛出异常,并返回相应的错误信息。你需要捕获异常并进行处理。
++
+
+
该方法必须在调用
该方法需要在调用
你必须在调用
你必须在调用
配置是否成功: +
+
+
+
该方法必须在调用
你必须在调用
你必须在调用
方法调用成功,返回当前设置的镜像模式,详见
方法调用成功,返回视频镜像模式,详见
当前设置的镜像模式,详见
当前设置的镜像模式,详见
+
该方法必须在调用
你需要在调用
你需要在调用
你需要在调用
当前设置的视频渲染模式,详见
方法调用成功,返回当前设置的视频镜像模式。详见
当前设置的视频渲染模式。详见
当前设置的视频渲染模式。详见
+
你必须在调用
该方法必须在调用
你必须在调用
你必须在调用
你必须在调用
+
该方法必须在调用
+
+
+
+
如果你希望将媒体流转发到多个频道,最多可调用该方法四次。
++
+
+
+
+
方法调用成功时,返回已设置的 App ID。 +方法调用失败,返回空字符串。
++
+
+
调用
调用
必须在调用
该方法必须在调用
+
方法调用成功时,返回已配置的 JSON 设置。 +方法调用失败,返回空字符串。
++
+
+
该方法必须在调用
你必须在调用
你必须在调用
你必须在调用
+
你可以在需要设置私有参数或使用自定义功能时调用此方法。
+你可以根据实际需求设置播放器的私有参数,具体设置方式可参考声网 SA 的建议。
+当你需要设置私有参数或使用定制功能时,可以调用此方法。
+当你需要设置私有参数或使用定制功能时,可以调用此方法。
+当你需要设置私有参数或使用定制化功能时,可以调用此方法。
+该方法必须在调用
+
当 API 调用失败时,你可以调用该方法获取错误码。
+当 API 调用失败时,你可以调用该方法获取错误码。
+当 API 调用失败时,可以调用此方法获取错误码。
+你可以在 API 调用失败时调用此方法获取错误码。
+当 API 调用失败时,你可以调用该方法获取错误码。
+当 API 调用失败时,你可以调用该方法获取错误码。
+方法调用成功,返回错误码,详见
+
方法调用成功时,返回错误码,详见
方法调用成功时,返回错误码,详见
+
当 API 调用失败时,你可以调用该方法获取错误信息,以帮助排查问题。
+当 API 调用失败时,可以调用该方法获取错误信息,以帮助排查问题。
+当 API 调用失败时,你可以调用此方法获取错误信息,以帮助排查问题。
+当 API 调用失败时,你可以调用此方法获取错误信息,以帮助排查问题。
++
+
+
+
+
+
+
如果在调用该方法前调用了
方法调用成功,返回音频播放设备或音频采集设备的总数。
+
+
该方法仅适用于 macOS 平台。调用该方法前,你需要先调用
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
该方法返回一个
+
+
该方法返回一个
+
+
该方法仅适用于 Windows 和 macOS 平台。
++
+
+
+
+
+
该方法仅适用于 Windows 和 macOS 平台。
++
+
+
+
+
+
该方法仅适用于 macOS 平台。
++
+
+
+
+
+
+
+
+
+
该方法仅适用于 macOS 平台。
++
+
+
+
+
+
+
SDK 默认使用当前播放设备作为声卡采集设备。如果你希望指定其他音频设备作为声卡采集设备,可以调用该方法,并将
该方法适用的典型场景如下: +使用 App A 通过蓝牙耳机播放音乐,同时使用 App B 进行视频通话并通过扬声器播放: +
+
+
你可以调用此方法更改当前使用的音频路由,但不会更改默认音频路由。例如,若默认音频路由为扬声器 1,在加入频道前调用此方法将音频路由设置为扬声器 2 并开始设备测试,SDK 会在扬声器 2 上进行设备测试。设备测试完成并加入频道后,SDK 仍会使用默认音频路由扬声器 1。
++
+
+
+
+
+
你可以调用此方法更改当前使用的音频路由,但不会更改默认音频路由。例如,默认音频路由为麦克风,在加入频道前调用此方法将音频路由设置为蓝牙耳机并开始设备测试,SDK 会在蓝牙耳机上进行设备测试。设备测试完成并加入频道后,SDK 仍使用麦克风进行音频采集。
++
+
+
+
该方法仅适用于 Windows 和 macOS 平台。
++
+
该方法用于测试本地音频采集设备和播放设备是否正常工作。调用该方法后,音频采集设备会采集本地音频,音频播放设备会播放采集到的音频。SDK 会按照设置的时间间隔触发两个独立的
+
+
该方法用于测试本地音频播放设备是否正常工作。调用该方法后,SDK 会播放你指定的音频文件。如果你能听到声音,说明播放设备工作正常。调用该方法后,SDK 每 100 毫秒触发一次
+
+
调用该方法可以测试本地音频采集设备是否正常工作。调用后,SDK 会按照设定的时间间隔触发
+
+
+
+
调用
+
+
调用
+
+
你需要在调用
调用
你需要在调用
方法调用成功,返回耳返音频数据格式对象,详见
耳返音频数据格式,详见
方法调用成功,返回耳返音频数据格式对象,详见
+
你需要在调用
调用
你需要在调用
方法调用成功,返回混合后的采集和播放音频数据对象,详见
方法调用成功,返回
方法调用成功,返回混合后的采集和播放音频数据对象,详见
+
成功注册音频数据观察器后,SDK 会在每个特定的音频帧处理节点使用该回调,以判断是否触发以下回调: +
成功注册音频数据观察器后,SDK 会在每个特定的音频帧处理节点调用该回调,以判断是否触发以下回调: +
成功注册音频数据观察器后,SDK 会在每个特定的音频帧处理节点使用该回调,以判断是否触发以下回调: +
返回一个位掩码,用于设置观察位置,具体取值如下,详见
返回一个位掩码,用于设置观察位置,具体取值如下: +
返回一个位掩码,用于设置观察位置,具体取值如下,详见
+
你需要在调用
你需要在调用
你需要在调用
方法调用成功,返回用于播放的音频参数对象,详见
方法调用成功,返回
方法调用成功,返回用于播放的音频参数对象,详见
+
调用
调用
调用
方法调用成功,返回采集的音频参数对象,详见
方法调用成功,返回
方法调用成功,返回采集的音频参数对象,详见
+
调用
方法调用成功时,返回一个
+
调用
方法调用成功时,返回一个
+
成功注册音频数据观察器后,SDK 会在每个特定的音频帧处理节点调用该回调,以判断是否触发以下回调: +
一个位掩码,用于设置观察位置,具体取值如下: +
+
你需要在调用
方法调用成功时,返回一个用于播放的音频参数,详见
+
调用
方法调用成功时,返回一个
+
调用该方法后,你将无法再听到任何远端用户的声音。离开频道后,为避免资源浪费,也可以调用该方法。
+调用该方法后,本地用户将无法再听到任何远端用户的声音。你也可以在离开频道后调用该方法以释放资源。
+调用该方法后,你将无法再听到任何远端用户的声音。离开频道后,为避免资源浪费,也可以调用该方法。
++
+
+
+
调用该方法后,你将停止或恢复订阅所有远端用户的音频流,包括后续加入频道的用户。
+调用该方法后,本地用户将停止或恢复订阅所有远端用户的音频流,包括后续加入频道的用户。
+调用该方法后,你将停止或恢复订阅所有远端用户的音频流,包括后续加入频道的用户。
++
+
+
+
你可以通过该方法停止或恢复发布本地音频流。
+
+该方法不会影响任何正在进行的音频录制,因为它不会禁用音频采集设备。
+使用空间音效时,如果你需要设置是否停止订阅指定用户的音频流,声网推荐你调用该方法,而不是
你可以通过该方法停止或恢复发布本地音频流。
+
+该方法不会影响任何正在进行的音频录制,因为它不会禁用音频采集设备。
+使用空间音效时,如果你需要设置是否停止订阅指定用户的音频流,声网推荐你调用该方法,而不是
请在加入频道后调用该方法。
+请在加入频道后调用该方法。
++
+
+
+
+
+
+
+
设置成功后,你只能听到在设定范围内或与你属于同一队伍的远端用户的音频。你可以在任意时刻调用该方法以更新音频接收范围。
+你可以在任意时间调用该方法以更新音频接收范围。设置成功后,本地用户只能接收设定范围内或同一队伍中远端用户的音频。
+设置成功后,你只能听到在设定范围内或与你属于同一队伍的远端用户的音频。你可以在任意时刻调用该方法以更新音频接收范围。
++
+
+
+
声网的空间音效算法中,距离以米为单位进行测量。SDK 默认将游戏引擎中的每个单位距离转换为 1 米。你可以调用
在声网的空间音效算法中,距离以米为单位进行计算。SDK 默认将游戏引擎中的每个单位距离转换为 1 米。你可以调用该方法将游戏引擎中的每个单位距离转换为指定的米数。
+声网的空间音效算法中,距离以米为单位进行测量。SDK 默认将游戏引擎中的每个单位距离转换为 1 米。你可以调用
+
+
+
+
如果可接收的音频流数量超过该设置值,你将接收距离你最近的
如果可接收的音频流数量超过该设置值,本地用户将接收距离其最近的
如果可接收的音频流数量超过该设置值,你将接收距离你最近的
+
+
+
+
+
+
+
+
在虚拟互动场景中,你可以使用此方法设置隔音区域和声音衰减系数。 +
在虚拟互动场景中,你可以使用该方法设置隔音区域及声音衰减系数。当声源(可以是用户或媒体播放器)和接收者分别处于隔音区域的内外时,可以体验到类似真实环境中声音遇到建筑隔断时的衰减效果: +
在虚拟互动场景中,你可以使用此方法设置隔音区域和声音衰减系数。 +
+
+
+
+
调用该方法后,本地用户可以听到媒体播放器空间位置的变化。
+你可以在加入频道前或后调用该方法。
+该方法可以在加入频道前或加入频道后调用。
+你可以在加入频道前或后调用该方法。
++
+
+
+
你需要将该方法与
你需要将该方法与
+
+
+
+
当你使用原生 iOS 框架(如
+
+
成功调用该方法后,你将无法听到任何远端用户的声音。离开频道后,为避免资源浪费,也可以调用该方法移除所有远端用户的空间位置。
++
+
在调用
方法调用成功,返回
+
在调用
+
+
+
+
+
调用该方法后,本地用户将停止或恢复订阅所有远端用户的音频流,包括后续加入频道的用户。
++
+
+
+
+
+
调用该方法可释放
调用该方法后,将无法再使用
该方法会释放
该方法会释放
+
调用该方法后,本地用户将无法再听到指定远端用户的声音。离开频道后,为避免浪费计算资源,建议调用该方法移除该远端用户的空间位置信息,否则该信息将持续保留。当远端用户数量超过通过
调用该方法成功后,你将不再听到指定远端用户的声音。离开频道后,为避免浪费计算资源,建议调用该方法移除指定远端用户的空间位置信息。否则,该用户的空间位置信息将持续保留。当远端用户数量超过通过
调用该方法后,你将不再听到该远端用户的声音。离开频道后,为避免浪费计算资源,建议调用该方法删除指定远端用户的空间位置信息。否则,该用户的空间位置信息将持续保留。当远端用户数量超过通过
调用该方法后,你将不再听到该远端用户的声音。离开频道后,为避免浪费计算资源,建议调用该方法删除指定远端用户的空间位置信息。否则,该用户的空间位置信息将持续保留。当远端用户数量超过通过
+
+
+
+
+
设置成功后,本地用户只能听到在设定范围内或属于同一队伍的远端用户的音频。你可以随时调用该方法更新音频接收范围。
++
+
在声网的空间音效算法中,距离以米为单位进行测量,而游戏引擎中的距离单位是自定义的。SDK 默认将游戏引擎中的每个单位距离转换为 1 米。你可以调用
+
+
如果可接收的音频流数量超过该值,本地用户将接收距离其最近的
+
+
+
+
+
+
+
+
+
在虚拟互动场景中,你可以使用该方法设置隔音区域及其声音衰减系数。当声源(用户或媒体播放器)和接收者分别位于隔音区域的内外时,可以模拟现实中声音被建筑物阻隔时的衰减效果: +
+
+
调用该方法后,本地用户可以听到媒体播放器空间位置的变化。
+该方法可以在加入频道前或加入频道后调用。
++
+
调用该方法后,SDK 会根据本地用户与远端用户之间的相对位置计算空间音效参数。
+成功调用该方法后,SDK 会根据本地用户与远端用户之间的相对位置计算空间音效参数。
+成功调用该方法后,SDK 会根据本地用户与远端用户之间的相对位置计算空间音效参数。
+请在调用
+
+
+
+
+
该方法属于
+
+
要发布自定义音频源,请按照以下步骤操作: +
该方法需要在加入频道前调用。
++
+
+
+
调用该方法后,App 会拉取解码并混音后的音频数据用于播放。该方法需要在加入频道后调用。在调用该方法前,请先调用
该方法需要在加入频道后调用。
++
+
在调用该方法推送外部音频数据前,请先完成以下操作: +
+
+
要发布自定义视频源,请按照以下步骤操作: +
自 v4.2.3 起,SDK 支持
+
+
调用该方法可注册音频帧观测器对象。当你需要 SDK 触发
在加入频道前调用该方法。
++
+
如果你只需要监听编码后的视频帧(例如 H.264 格式),而不进行解码和渲染,建议通过此方法注册一个自定义的
+
+
通过此方法注册自定义的
在加入频道前调用此方法。
++
+
启用外部音频渲染器后,你可以调用
请在加入频道前调用该方法。
++
+
在加入频道前调用该方法。
++
+
该方法用于替换 SDK 默认的远端 EGL 上下文,便于你自行管理 EGL 上下文。当引擎被销毁时,SDK 会自动释放该上下文。
+请在加入频道前调用该方法。
++
+
调用该方法启用外部视频源后,可以调用
请在加入频道前调用该方法。
++
+
加入频道前后均可调用。
+该方法可以在加入频道前或加入频道后调用。
+该方法可在加入频道前或加入频道后调用。
+你可以在加入频道前或加入频道后调用该方法。
+你可以在加入频道前或加入频道后调用该方法。
无。
++
+
+
+
+
你可以调用该方法调节远端用户听到的媒体文件音量。
+你可以调用该方法调节远端用户听到的媒体文件音量。该方法可以在加入频道前或加入频道后调用。
+你可以调用该方法调节远端用户听到的媒体文件音量。该方法可以在加入频道前或加入频道后调用。
+该方法可以在加入频道前或后调用。
+该方法可以在加入频道前或加入频道后调用。
+该方法可以在加入频道前或加入频道后调用。
+该方法可以在加入频道前或加入频道后调用。
++
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
你可以通过该方法获取本地播放音量,取值范围为 0 到 100。
+你可以通过该方法获取本地播放音量,取值范围为 0 到 100。
++
方法调用成功,返回本地播放音量,取值范围为 0 到 100。 +0 表示静音,100(默认)表示原始音量。
+方法调用成功,返回本地播放音量,取值范围为 0 到 100。 +0 表示静音,100(默认)表示原始音量。
+方法调用成功,返回本地播放音量,取值范围为 0 到 100。 +0 表示静音,100(默认)表示原始音量。
+
+
+
+
+
+
+
+
方法调用成功时,返回当前正在播放的媒体资源路径。 +方法调用失败,返回空字符串。
+方法调用成功时,返回正在播放的媒体资源路径。 +方法调用失败时,返回空字符串。
+方法调用成功时,返回正在播放的媒体资源路径。 +方法调用失败时,返回空字符串。
+
+
+
+
+
+
+
方法调用成功,返回当前播放状态,详见
方法调用成功,返回当前播放状态。详见
方法调用成功,返回当前播放状态,详见
方法调用成功,返回当前播放状态,详见
+
+
+
+
+
+
调用
调用该方法可获取指定索引的媒体流的详细信息。
+调用该方法可获取指定索引的媒体流的详细信息。
+在调用
在调用
在调用
在调用
+
+
+
+
+
你可以在加入频道前或加入频道后调用该方法。
+你可以在加入频道前或加入频道后调用该方法。
+你可以在加入频道前或加入频道后调用该方法。
+你可以在加入频道前或加入频道后调用该方法。
++
+
+
+
+
支持播放以
该方法可以在加入频道前或加入频道后调用。
+该方法可以在加入频道前或后调用。
+该方法可以在加入频道前或加入频道后调用。
+该方法可以在加入频道前或加入频道后调用。
++
+
+
+
+
+
+
该方法支持打开来自不同来源的媒体文件,包括自定义媒体源,并允许你配置播放场景。
+该方法支持打开不同类型的媒体文件,包括以
该方法支持打开不同类型的媒体文件,包括以
该方法支持打开不同类型的媒体文件,包括以
你可以在加入频道前或后调用该方法。
+你可以在加入频道前或加入频道后调用该方法。
+你可以在加入频道前或加入频道后调用该方法。
+你可以在加入频道前或加入频道后调用该方法。
++
+
+
+
+
你可以在加入频道前或加入频道后调用该方法。
+你可以在加入频道前或加入频道后调用此方法。
+你可以在加入频道前或后调用该方法。
+你可以在加入频道前或后调用该方法。
++
+
+
+
+
你可以调用该方法播放媒体文件。
+你可以调用该方法播放媒体文件。
++
+
+
+
+
+
+
+
+
调用
调用
调用
调用
+
+
+
+
+
你可以调用该方法将媒体资源预加载到播放列表中。如果需要预加载多个媒体资源,可以多次调用该方法。调用该方法后,如果在
调用该方法后,如果在
你可以调用此方法将媒体资源预加载到播放列表中。如果需要预加载多个媒体资源,可以多次调用此方法。如果预加载成功并希望播放该媒体资源,请调用
你可以调用此方法将媒体资源预加载到播放列表中。如果需要预加载多个媒体资源,可以多次调用此方法。如果预加载成功并希望播放该媒体资源,请调用
+
+
+
+
+
你需要实现
+
+
+
+
+
用于监听播放过程中的事件。
+用于监听媒体播放器播放过程中的事件。
+该方法可以在加入频道前或加入频道后调用。
+该方法可以在加入频道前或加入频道后调用。
++
+
+
你需要实现
你需要实现
+
+
+
+
+
+
+
+
如果在播放完成后调用
如果在播放完成后调用
+
+
你可以在加入频道前或后调用该方法。
+你可以在加入频道前或后调用此方法。
+你可以在加入频道前或后调用该方法。
+你可以在加入频道前或后调用该方法。
++
+
+
+
+
获取音频文件的音轨索引后,可以调用该方法指定要播放的音轨。例如,如果一个多音轨文件的不同音轨存储了不同语言的歌曲,可以调用该方法设置播放语言。
+获取音频文件的轨道索引后,可以调用该方法选择指定的音频轨道进行播放。例如,如果一个多轨道文件的不同轨道存储了不同语言的音频内容,可以调用该方法设置播放语言。
+获取音频文件的音轨索引后,可以调用该方法指定任意音轨进行播放。例如,如果一个多音轨文件的不同音轨存储了不同语言的歌曲,可以调用该方法设置播放语言。
+获取音频文件的音轨索引后,可以调用该方法指定任意音轨进行播放。例如,如果一个多音轨文件的不同音轨存储了不同语言的歌曲,可以调用该方法设置播放语言。
++
+
+
+
+
调用该方法前,需要使用
在调用该方法前,你需要通过
调用该方法可分别设置要在本地设备上播放和发布到频道的音轨。在调用该方法前,需要先调用
调用该方法可分别设置要在本地设备上播放和发布到频道的音轨。在调用该方法前,需要先调用
该方法适用于例如 KTV 场景:主持人可以选择在本地播放原唱音轨,同时将伴奏音轨发布到频道。
++
+
+
+
+
在立体声音乐文件中,左声道和右声道可以存储不同的音频数据。你可以根据需要将声道模式设置为原始模式、左声道模式、右声道模式或混合声道模式。例如,在 KTV 场景中,音乐文件的左声道存储伴奏,右声道存储人声。如果你只需要听伴奏,可以调用该方法将声道模式设置为左声道模式;如果你需要同时听到伴奏和人声,可以将声道模式设置为混合声道模式。
+在立体声音频文件中,左右声道可以存储不同的音频数据。你可以根据需要将声道模式设置为原始模式、左声道模式、右声道模式或混合声道模式。例如,在 KTV 场景中,音乐文件的左声道存储伴奏,右声道存储人声。如果你只需要听伴奏,可以将声道模式设置为左声道模式;如果你需要同时听到伴奏和人声,可以将声道模式设置为混合声道模式。
+你可以使用该方法设置当前音频文件的声道模式,包括原始模式、左声道模式、右声道模式或混合声道模式。例如,在 KTV 场景中,音乐文件的左声道存储伴奏,右声道存储人声。如果你只需要听伴奏,可以调用该方法将声道模式设置为左声道模式;如果你需要同时听到伴奏和人声,可以将声道模式设置为混合声道模式。
+你可以使用该方法设置当前音频文件的声道模式,包括原始模式、左声道模式、右声道模式或混合声道模式。例如,在 KTV 场景中,音乐文件的左声道存储伴奏,右声道存储人声。如果你只需要听伴奏,可以调用该方法将声道模式设置为左声道模式;如果你需要同时听到伴奏和人声,可以将声道模式设置为混合声道模式。
++
+
+
+
+
+
+
+
+
+
调用该方法可设置音效的循环播放次数。循环播放完成后,SDK 会触发
调用此方法可设置循环播放次数。循环播放完成后,SDK 会触发
调用此方法可设置循环播放次数。循环播放完成后,SDK 会触发
+
+
+
+
+
调用该方法前,需要先调用
调用该方法前,需要先调用
调用该方法前,需要先调用
调用该方法前,需要先调用
+
+
+
+
+
该方法用于通过
该方法用于通过
你可以通过
你可以通过
适用于需要技术预览或特殊定制功能的场景。
+请在调用
请在调用
在调用
在调用
+
+
+
+
+
该方法用于通过
该方法与
你可以通过
你可以通过
适用于需要技术预览或特殊定制功能的场景。
+请在调用
请在调用
在调用
在调用
+
+
+
+
+
+
+
+
+
+
调用该方法成功设置媒体播放器的空间音效参数后,SDK 会为媒体播放器启用空间音效,本地用户可以听到具有空间感的媒体资源。若需关闭空间音效,请将
若需关闭空间音效,请将
成功设置媒体播放器的空间音效参数后,SDK 会为媒体播放器启用空间音效。若需关闭媒体播放器的空间音效,请将
成功设置媒体播放器的空间音效参数后,SDK 会为媒体播放器启用空间音效。若需关闭媒体播放器的空间音效,请将
+
+
+
+
+
调用该方法注册视频帧观察者后,你可以根据需要在
调用该方法注册视频帧观察者后,你可以根据需要在
+
+
+
你可以在加入频道前或加入频道后调用该方法。
+你可以在加入频道前或加入频道后调用该方法。
+你可以在加入频道前或加入后调用该方法。
+你可以在加入频道前或加入后调用该方法。
++
+
+
+
+
调用该方法停止播放后,如需再次播放,需要调用
调用该方法后,如需再次播放,需要调用
调用该方法停止播放后,如果你需要再次播放,需要调用
调用该方法停止播放后,如果你需要再次播放,需要调用
在播放后调用该方法。
+请在播放后调用此方法。
+请在播放后调用该方法。
+请在播放后调用该方法。
++
+
+
+
+
你可以根据当前的网络状况调用该方法切换播放的媒体资源。例如: +
你可以调用此方法根据当前网络状态切换播放的媒体资源地址。例如: +
你可以根据当前的网络状态调用该方法切换要播放的媒体资源。例如: +
你可以根据当前的网络状态调用该方法切换要播放的媒体资源。例如: +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
启用该功能后,如果缓存的媒体文件数量或大小超过设置的限制,SDK 会自动删除最近最少使用的缓存文件。
+当缓存的媒体文件数量或大小超过设置的限制时,启用该功能后,SDK 会自动删除最近最少使用的缓存文件。
+当缓存的媒体文件超过设置的数量或大小限制时,如果启用该功能,SDK 会自动删除最近最少使用的缓存文件。
+当缓存的媒体文件超过设置的数量或大小限制时,如果启用该功能,SDK 会自动删除最近最少使用的缓存文件。
++
+
+
+
+
如果在调用该方法前未调用
如果在调用该方法之前未调用
如果在调用该方法前未调用
如果在调用该方法前未调用
+
方法调用成功时,返回缓存媒体文件的存储路径。 +方法调用失败,返回空字符串。
++
+
+
+
+
+
+
+
默认情况下,可缓存的媒体文件最大数量为 1000。
+默认情况下,最多可以缓存 1,000 个媒体文件。
+默认情况下,最多可以缓存 1,000 个媒体文件。
++
+
方法调用成功,返回可缓存的媒体文件的最大数量。 +
方法调用成功,返回可缓存的媒体文件的最大数量。 +
+
你可以调用
你可以调用
你可以调用
你可以调用
+
+
+
+
+
在调用
在调用
在调用
在调用
调用时序:请确保在调用该方法前已初始化
确保在调用
确保在调用此方法之前已初始化
确保在调用此方法之前已初始化
+
方法调用成功,返回
方法调用成功,返回
方法调用成功,返回
+
+
+
+
+
+
+
+
+
+
+
当缓存文件存储空间即将达到上限时,你可以调用该方法,SDK 会删除最少使用的缓存媒体文件。
+你可以在缓存文件的存储空间即将达到上限时调用该方法。调用该方法后,SDK 会删除最少使用的缓存媒体文件。
+当缓存文件的存储空间即将达到上限时,你可以调用该方法删除一个缓存媒体文件。SDK 会删除最少使用的缓存媒体文件。
+当缓存文件的存储空间即将达到上限时,你可以调用该方法删除一个缓存媒体文件。SDK 会删除最少使用的缓存媒体文件。
++
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
方法调用成功,返回
方法调用成功,返回
+
如果不将回调方法派发到主线程,应用应将 UI 操作派发到主线程。
+如果不将回调方法派发到主线程,应用应将 UI 操作派发到主线程。
++
+
+
该方法用于设置音视频录制的回调,使应用在录制过程中能够接收录制状态和信息通知。 +在调用该方法前,请确保: +
该方法用于设置音视频录制的回调,使你在录制过程中能够获取音视频流的录制状态和相关信息。
+
+在调用该方法前,请确保已创建并初始化
该方法用于设置音视频录制的回调,使你在录制过程中能够获取音视频流的录制状态和相关信息。
+
+在调用该方法前,请确保已创建并初始化
+
+
+
+
+
该方法用于开始录制音频和视频流,支持同时录制本地和远端用户的音视频流。 +在调用该方法前,请确保: +
该方法用于开始录制音频和视频流。声网 SDK 支持同时录制本地和远端用户的音视频流。 +在调用该方法前,请确保: +
该方法用于开始录制音频和视频流。声网 SDK 支持同时录制本地和远端用户的音视频流。 +在开始录制前,请确保: +
该方法用于开始录制音频和视频流。声网 SDK 支持同时录制本地和远端用户的音视频流。 +在开始录制前,请确保: +
+
+
+
+
+
+
+
+
+
+
调用
调用
方法调用成功,返回你希望使用的元数据
方法调用成功,返回你希望使用的元数据
+
如果你需要播放来自声网 Music Content Center 的音乐资源,必须先调用
如果你需要播放来自版权音乐中心的音乐资源,必须先调用该方法创建一个音乐播放器。
+如果你需要播放来自音乐内容中心的音乐资源,必须先调用该方法。
++
+
+
+
你必须在调用
你必须在调用
+
当你不再需要使用音乐播放器时,可以调用此方法销毁该对象。如果销毁后需要再次使用音乐播放器,请调用
当你不再需要使用音乐播放器时,可以调用此方法销毁音乐播放器对象。如果在销毁后需要再次使用音乐播放器,必须调用
如果在销毁后需要再次使用音乐播放器,必须调用
该方法可以在加入频道前或加入频道后调用,但必须在调用
你可以在加入频道前或后调用此方法,但必须确保在调用
你可以在加入频道前或加入频道后调用此方法,但必须确保在调用
+
+
+
+
如果你不将回调方法派发到主线程,你需要手动将 UI 操作派发到主线程。
+
+
调用该方法前,需要预先分配内存用于存储已缓存音乐资源的信息。如果希望设置可缓存的音乐资源数量,可以通过
在调用此方法前,你需要分配足够的内存来存储缓存音乐资源的信息。如果你想设置可缓存的音乐资源数量,可以通过
在调用该方法前,你需要预先分配内存空间,用于存储已缓存音乐资源的信息。如果需要设置可缓存的音乐资源数量,可以通过
+
+
+
+
在播放音乐资源的副歌片段前,需调用该方法,结合参数
调用该方法可结合音乐资源的
在播放音乐资源的副歌片段前,需调用该方法,结合音乐资源的
+
+
+
+
调用该方法后,SDK 会触发
调用该方法后,SDK 会触发
+
+
+
+
调用该方法后,SDK 会触发
调用该方法时,SDK 会触发
+
方法调用成功时,返回一个唯一标识该请求的
+
+
调用该方法后,SDK 会触发
成功调用该方法后,SDK 会触发
+
方法调用成功时,返回唯一标识该请求的
+
+
成功调用该方法后,SDK 会触发
+
+
调用该方法前,你需要先获取目标音乐资源的歌曲编号。你可以通过调用
在调用该方法前,你需要先获取对应音乐资源的标识符。你可以通过调用
在调用该方法前,你需要先获取目标音乐资源的标识符。你可以通过调用
+
方法调用成功时,返回唯一标识此次请求的
+
+
在调用
你必须先调用该方法初始化
在调用
+
+
+
+
该方法为同步调用。若需预加载新的音乐资源,请调用
该方法为同步调用。你可以调用
该方法为同步调用。
++
+
+
+
你可以调用该方法预加载想要播放的音乐资源。成功调用该方法后,SDK 会触发
你可以调用此方法预加载你想播放的音乐资源。
+调用成功后,SDK 会触发
+
+
+
+
调用该方法可以预加载想要播放的音乐资源。调用成功后,SDK 会触发
你可以调用此方法预加载你想播放的音乐资源。调用成功后,SDK 会触发
成功调用该方法后,SDK 会触发
+
+
+
+
+
+
+
+
该方法必须在调用
+
你可以调用此方法删除指定的已缓存音乐资源。若需删除多个资源,请多次调用此方法。
+你可以调用此方法删除已缓存的音乐资源。如需删除多个音乐资源,可以多次调用此方法。
+若需删除多个音乐资源,可多次调用此方法。
++
+
+
+
当用于鉴权的 Token 即将过期或已经过期时,你可以调用该方法传入新生成的 Token。
+当用于鉴权的 Token 即将过期或已经过期时,可以调用该方法传入新生成的 Token。
+当用于鉴权的 Token 即将过期或已经过期时,可以调用该方法传入新生成的 Token。
++
+
+
+
调用该方法后,SDK 会触发
调用该方法后,SDK 会触发
+
+
+
+
+
+
+
+
+
+
+
你需要在打开音乐资源后调用此方法: +
+
+
调用该方法会触发
+
+
在调用该方法前,请确保要播放的音乐资源已加载。你可以调用
调用该方法前,请确保要播放的音乐资源已加载完成。你可以通过调用
调用该方法后,将触发
+
+
+
+
你可以调用该方法启用原唱、伴奏或导唱模式。如果不调用该方法,默认播放伴奏;若音乐资源不包含伴奏,则播放原唱。
+你可以调用此方法启用原唱、人声伴奏或导唱。如果不调用此方法,默认播放人声伴奏。如果音乐资源不包含人声伴奏,则播放原唱。
+如果你未调用该方法设置播放模式,默认播放人声伴奏;如果音乐资源不包含人声伴奏,则播放原唱。
+在在线 K 歌或才艺展示等娱乐场景中,如果你需要播放由声网内容中心提供的版权音乐,可以调用该方法设置播放模式。
+该方法必须在调用
你必须在调用
你必须在调用
+
+
+
+
+
+
+
SDK 使用
+
添加水印图像后,频道内的所有用户(包括 CDN 观众)以及视频采集设备都可以看到并采集该图像。如果你只想在 CDN 推流中添加水印,请参见
该方法在直播场景中向本地视频流添加 PNG 格式的水印图像。频道内的所有用户(包括 CDN 观众)以及视频采集设备都可以看到并采集该水印图像。如果你只想向 CDN 推流添加水印,请使用
该方法在直播场景中向本地视频流添加 PNG 格式的水印图像。添加水印图像后,频道内的所有用户(包括 CDN 观众)以及视频采集设备都可以看到并采集该图像。如果你只想向 CDN 推流添加水印,请参见
该方法在直播场景中向本地视频流添加 PNG 格式的水印图像。添加水印图像后,频道内的所有用户(包括 CDN 观众)以及视频采集设备都可以看到并采集该图像。如果你只想向 CDN 推流添加水印,请参见
+
+
+
+
+
该方法在直播中向本地视频添加 PNG 格式的水印图像。添加后,频道中的所有观众(包括 CDN 观众)以及采集设备都可以看到并采集该图像。声网 SDK 每次仅支持添加一张水印图像,新添加的图像会替换之前的图像。
+水印图像的坐标依赖于
该方法在直播中向本地视频添加 PNG 格式的水印图像。添加水印后,频道中的所有观众(包括 CDN 观众)以及采集设备都可以看到并采集到该水印图像。声网 SDK 每个直播视频流仅支持添加一张水印图像,新添加的水印会替换之前的图像。
+水印图像的位置依赖于
该方法在直播中向本地视频添加 PNG 格式的水印图像。添加水印图像后,频道中的所有观众(包括 CDN 观众)以及采集设备都可以看到并采集该图像。声网 SDK 仅支持在一个直播视频流中添加一张水印图像,新添加的水印图像会替换之前的图像。
+水印图像的坐标依赖于
该方法在直播中向本地视频添加 PNG 格式的水印图像。添加水印图像后,频道中的所有观众(包括 CDN 观众)以及采集设备都可以看到并采集该图像。声网 SDK 仅支持在一个直播视频流中添加一张水印图像,新添加的水印图像会替换之前的图像。
+水印图像的坐标依赖于
+
+
+
+
+
你可以使用该方法在本地视频流中叠加水印图像,并通过
你可以使用该方法通过
你可以使用此方法在本地视频流上叠加水印图像,并通过
你可以使用此方法在本地视频流上叠加水印图像,并通过
+
+
+
+
+
你需要在调用
你需要在调用
你需要在调用
你需要在调用
你需要在调用
你需要在调用
你需要在调用
+
+
+
+
+
该方法用于调节发送给其他用户的混音音量。
+你可以调用该方法调节用于发布(发送给其他用户)的混音音量。
+你可以调用该方法调节用于发布(发送给其他用户)的混音音量。
+请在调用
请在调用
在调用
在调用
+
+
+
+
+
该方法用于在本地客户端和远端客户端上调节混音音量。
+你可以通过该方法在本地客户端和远端客户端调节混音音量。
+你可以通过该方法在本地客户端和远端客户端调节混音音量。
+请在调用
请在调用
请在调用
请在调用
+
+
+
+
+
如果你想更改本地播放的音频音量,需要再次调用该方法。
+如果你希望更改本地播放的音频音量,需要再次调用该方法。
+如果你想更改本地播放的音频音量,需要再次调用该方法。
+如果你想更改本地播放的音频音量,需要再次调用该方法。
++
+
+
+
+
如果你想更改远端播放的音频音量,需要再次调用该方法。
+如果你想更改远端播放的音频音量,需要再次调用该方法。
+如果你想更改远端播放的音频音量,需要再次调用此方法。
+如果你想更改远端播放的音频音量,需要再次调用此方法。
++
+
+
+
+
在调用
调用
+
+
+
如果你需要调节某个指定远端用户的本地播放音量,建议调用
如果你需要调节某个指定远端用户在本地播放的音量,建议调用
该方法用于调节本地混音播放的所有远端用户的信号音量。如果你需要调节本地播放的指定远端用户的信号音量,建议调用
该方法用于调节本地混音播放的所有远端用户的信号音量。如果你需要调节本地播放的指定远端用户的信号音量,建议调用
该方法可以在加入频道前或加入频道后调用。
+该方法可以在加入频道前或加入频道后调用。
+该方法可以在加入频道前或后调用。
+该方法可以在加入频道前或后调用。
++
+
+
+
+
如果你只需要静音音频信号,声网建议使用
如果你只需要静音音频信号,声网建议使用
如果你只需要静音音频信号,声网建议使用
如果你只需要静音音频信号,声网建议使用
该方法可以在加入频道前或加入频道后调用。
+该方法可以在加入频道前或加入频道后调用。
+该方法可以在加入频道前或后调用。
+该方法可以在加入频道前或后调用。
++
+
+
+
+
你可以调用该方法调整指定远端用户的播放音量。若需调整多个远端用户的播放音量,请分别多次调用该方法,每次针对一个远端用户。
+你可以调用该方法调节指定远端用户的播放音量。若需调节多个远端用户的播放音量,请分别多次调用该方法,每次针对一个远端用户。
+你可以调用该方法调整指定远端用户的播放音量。若需调整多个远端用户的播放音量,请分别多次调用该方法,每次针对一个远端用户。
+你可以调用该方法调整指定远端用户的播放音量。若需调整多个远端用户的播放音量,请分别多次调用该方法,每次针对一个远端用户。
+请在加入频道后调用该方法。
+请在加入频道后调用该方法。
+请在加入频道后调用此方法。
+请在加入频道后调用此方法。
++
+
+
+
+
+
+
+
+
+
请在用户离开频道后调用该方法。
+请在用户离开频道后调用该方法。
+请在你离开频道后调用该方法。
+请在你离开频道后调用该方法。
++
+
+
+
+
调用
调用
调用
调用
该方法可以在加入频道前或后调用。
+该方法可以在加入频道前或后调用。
+该方法可以在加入频道前或后调用。
+该方法可以在加入频道前或后调用。
++
+
+
+
+
你可以使用该方法创建并初始化
你可以使用该方法创建并初始化
+
方法调用成功,返回已初始化的
+
+
声网 RTC SDK v4.x 每个 App 仅支持创建一个
+
+
要发布自定义音频源,请按照以下步骤操作: +
你可以通过以下步骤发布自定义音频源: +
要发布自定义音频源,请按照以下步骤操作: +
+
+
+
+
要发布自定义视频源,请按照以下步骤操作: +
调用该方法创建一个视频轨道,并获取视频轨道 ID。该 ID 可用于发布自定义视频源。要发布自定义视频源,请按照以下步骤操作: +
要发布自定义视频源,请按照以下步骤操作: +
要发布自定义视频源,请按照以下步骤操作: +
+
+
+
+
+
你可以调用该方法创建一个数据流,以提升数据传输的可靠性和顺序性。你可以在加入频道前或后调用该方法。
+你可以调用该方法创建一个数据流,以提升数据传输的可靠性和顺序性。你可以在加入频道前或后调用该方法。
+你可以在加入频道前或后调用此方法。
+你可以在加入频道前或后调用此方法。
+你可以在加入频道前或后调用该方法。
+你可以在加入频道前或后调用该方法。
++
+
+
+
+
该方法不保证数据传输的可靠性。如果数据包在发送后五秒内未被接收,SDK 会直接丢弃该数据包。与
该方法不保证数据传输的可靠性。如果数据包在发送后五秒内未被接收,SDK 会直接丢弃该数据。
+与
与
你可以在加入频道前或加入频道后调用该方法。
+你可以在加入频道前或加入频道后调用该方法。
+你可以在加入频道前或加入频道后调用该方法。
+你可以在加入频道前或加入频道后调用该方法。
++
+
+
+
+
在调用
你需要调用此方法来创建一个媒体播放器实例。如果需要多个实例,可以多次调用此方法。
+在调用
在调用
你可以在加入频道前或加入频道后调用此方法。
+你可以在加入频道前或加入频道后调用此方法。
+你可以在加入频道前或加入频道后调用此方法。
+你可以在加入频道前或加入频道后调用此方法。
++
方法调用成功,返回
+
+
+
在开始录制音频和视频流之前,你需要调用该方法创建一个录制器实例。SDK 支持录制来自本地或远端用户的多个音视频流。你可以多次调用该方法创建多个录制器实例,并通过参数
在开始录制音视频流之前,你需要调用该方法创建一个录制器实例。你可以多次调用该方法创建多个录制器,并通过
在开始音视频流录制之前,你需要调用该方法创建一个媒体录制器实例。SDK 支持录制来自本地或远端用户的多个音视频流。你可以多次调用该方法创建多个录制器实例,并使用
在开始音视频流录制之前,你需要调用该方法创建一个媒体录制器实例。SDK 支持录制来自本地或远端用户的多个音视频流。你可以多次调用该方法创建多个录制器实例,并使用
方法调用成功,返回
+
+
+
+
返回一个
返回一个
+
方法调用成功,返回
+
+
+
SDK 通过
SDK 通过
+
当你不再需要实时通信时,调用此方法以释放
当你不再需要实时通信时,调用该方法以释放
当你不再需要实时通信时,调用此方法以释放
+
+
+
+
+
+
+
+
+
+
+
+
+
+
当你不再需要录制音频和视频流时,可以调用此方法销毁对应的录制器实例。调用此方法前,请确保已调用
如果当前正在录制,请先调用
当你不再需要录制音视频流时,可以调用此方法销毁对应的音视频录制器实例。如果录制正在进行中,请先调用
当你不再需要录制音视频流时,可以调用此方法销毁对应的音视频录制器实例。如果录制正在进行中,请先调用
+
+
+
+
+
+
+
+
+
+
音频模块默认启用。你可以调用该方法来禁用。
+音频模块默认启用。你可以调用该方法禁用音频模块。
+音频模块默认启用。你可以调用该方法禁用音频模块。
+该方法可以在加入频道前或加入频道后调用。离开频道后仍然有效。
+该方法可以在加入频道前或加入频道后调用。离开频道后仍然有效。
+该方法可以在加入频道前或加入频道后调用。离开频道后仍然有效。
+该方法可以在加入频道前或加入频道后调用。离开频道后仍然有效。
++
+
+
+
+
调用
调用
如果你已调用
如果你已调用
+
+
+
+
+
该方法会影响内部引擎,且可以在离开频道后调用。调用该方法会重置整个引擎,可能导致响应时间变慢。你可以根据实际需求,使用以下方法分别控制视频模块的具体功能: +
该方法用于禁用视频模块。
+该方法用于禁用视频模块。
+该方法可以在加入频道前或加入频道后调用: +
该方法可在加入频道前或加入频道后调用。 +
该方法可在加入频道前或加入频道后调用。 +
该方法可在加入频道前或加入频道后调用。 +
+
+
+
+
+
音频模块默认处于启用状态。调用
调用
音频模块默认处于启用状态。你在调用
音频模块默认处于启用状态。你在调用
该方法可以在加入频道前或加入频道后调用,离开频道后仍然有效。
+该方法可以在加入频道前或加入频道后调用,离开频道后仍然有效。
+该方法可以在加入频道前或加入频道后调用,离开频道后仍然有效。
+该方法可以在加入频道前或加入频道后调用,离开频道后仍然有效。
++
+
+
+
+
你可以注册音频频谱观察器并调用该方法以获取本地或远端用户的音频频谱数据。
+如果你希望获取本地或远端用户的音频频谱数据,可以注册音频频谱观察器并调用该方法。
+如果你希望获取本地或远端用户的音频频谱数据,可以注册音频频谱观察器并调用该方法。
+你可以在加入频道前或加入频道后调用此方法。
++
+
+
+
+
该方法用于启用 SDK 定期向应用上报本地发送音频流的用户和瞬时音量最大的最多三位远端用户的音量信息。
+该方法用于启用 SDK 定期向应用上报本地发送流的用户和音量瞬时值最高的最多三位远端用户的音量信息。
+该方法用于启用 SDK 定期向你报告本地发送音频流用户和瞬时音量最高的最多三位远端用户的音量信息。
+该方法用于启用 SDK 定期向你报告本地发送音频流用户和瞬时音量最高的最多三位远端用户的音量信息。
+该方法可以在加入频道前或加入频道后调用。
+该方法可以在加入频道前或加入频道后调用。
+该方法可以在加入频道前或后调用。
+该方法可以在加入频道前或后调用。
++
+
+
+
+
默认情况下,人像锁定功能处于关闭状态。你需要调用此方法来开启该功能。如需关闭该功能,请再次调用该方法并将
人像锁定功能默认关闭。你需要调用此方法来开启该功能。如果需要关闭此功能,你需要再次调用此方法并将
人像锁定功能默认关闭。你需要调用此方法来开启该功能。如果需要关闭此功能,你需要再次调用此方法并将
人像锁定功能适用于在线会议、演出、在线教育等场景。主持人可以使用该功能确保无论是否移动,始终处于画面中央,从而获得更好的展示效果。
+必须在成功启用摄像头之后调用此方法,即 SDK 触发
必须在成功开启摄像头之后调用此方法,即 SDK 触发
必须在成功开启摄像头之后调用此方法,即 SDK 触发
+
+
+
+
启用该功能后,SDK 会根据你在
SDK 会根据在
调用该方法后,SDK 会根据在
调用该方法后,SDK 会根据在
该方法可以在加入频道前或加入频道后调用。
+该方法可以在加入频道前或加入频道后调用。
+你可以在加入频道前或加入频道后调用该方法。
+你可以在加入频道前或加入频道后调用该方法。
++
+
+
+
+
调用该方法可开启外部音频源的本地播放。如需停止播放,可再次调用该方法并将
你可以调用
调用该方法启用外部音频源的本地播放后,如需停止本地播放,可再次调用该方法并将
调用该方法启用外部音频源的本地播放后,如需停止本地播放,可再次调用该方法并将
+
+
+
+
+
双流由一对视频大流和视频小流组成: +
启用双流模式后,你可以调用
不同质量层级的视频流是一对视频大流和视频小流的组合: +
不同质量层级的视频流是一对视频大流和视频小流的组合: +
+
+
+
+
+
你可以调用此方法在发送端启用或关闭双流模式。双流模式指同时发送视频大流和视频小流: +
你可以调用此方法在发送端启用或关闭双流模式。双流由一路视频大流和一路视频小流组成: +
你可以调用该方法在发送端启用或关闭不同质量层级的视频流(dual-stream)模式。不同质量层级的视频流包括一对视频大流和视频小流: +
你可以调用该方法在发送端启用或关闭不同质量层级的视频流(dual-stream)模式。不同质量层级的视频流包括一对视频大流和视频小流: +
+
+
+
+
+
用户离开频道后,SDK 会自动关闭内置加密功能。若需启用该功能,请在用户重新加入频道前调用该方法。
+用户离开频道后,SDK 会自动关闭内置加密功能。请在用户重新加入频道前调用该方法。
+用户离开频道后,SDK 会自动关闭内置加密。若需启用内置加密,请在用户重新加入频道前调用此方法。
+用户离开频道后,SDK 会自动关闭内置加密。若需启用内置加密,请在用户重新加入频道前调用此方法。
+适用于安全性要求较高的场景。
+请在加入频道前调用该方法。
+请在加入频道前调用该方法。
+请在加入频道前调用此方法。
+请在加入频道前调用此方法。
++
+
+
+
+
通过调用该方法,你可以在不更改处理流程的情况下动态启用或禁用插件。例如,启用或禁用
通过调用该方法,你可以动态启用或禁用扩展功能,而无需更改处理流程。
+该方法建议在你加入频道后调用。
+该方法建议在你加入频道后调用。
++
+
+
+
+
你可以通过该方法启用或关闭本地用户的人脸检测功能。该方法需要在摄像头启动后调用,例如调用
该方法需在调用
该方法需要在摄像头启动后调用,例如调用
该方法需在调用
+
+
+
+
你可以调用该方法启用或关闭耳返监听功能。
+你可以调用该方法启用或关闭耳返监听功能。
+该方法可以在加入频道前或加入频道后调用。
+该方法可以在加入频道前或加入频道后调用。
+该方法可以在加入频道前或加入频道后调用。
++
+
+
+
你可以在加入频道前或加入频道后调用该方法。
+该方法可以在加入频道前或加入频道后调用。
+该方法可以在加入频道前或加入频道后调用。
+该方法可以在加入频道前或加入频道后调用。
++
+
+
+
+
调用该方法后,SDK 会启用极速帧渲染模式,从而加快用户加入频道后首帧的渲染速度。
+成功调用该方法后,SDK 会启用即时帧渲染模式,从而加快用户加入频道后首帧的渲染速度。
+调用该方法后,SDK 会启用极速帧渲染模式,从而加快你加入频道后首帧的渲染速度。
+调用该方法后,SDK 会启用极速帧渲染模式,从而加快你加入频道后首帧的渲染速度。
+声网建议在极速直播场景中为观众开启该模式。
+该方法需要在加入频道前调用。
+该方法需要在加入频道前调用。
+请在加入频道前调用该方法。
+请在加入频道前调用该方法。
++
+
+
+
+
该方法用于关闭或重新启用本地音频功能,从而停止或重新开始本地音频采集。
+该方法与
你可以在加入频道前或加入频道后调用该方法。在加入频道前调用该方法仅设置设备状态,并在加入频道后立即生效。
+你可以在加入频道前或加入频道后调用该方法。在加入频道前调用该方法仅设置设备状态,并在加入频道后立即生效。
+你可以在加入频道前或加入频道后调用该方法。在加入频道前调用时,仅设置设备状态,加入频道后立即生效。
+你可以在加入频道前或加入频道后调用该方法。在加入频道前调用时,仅设置设备状态,加入频道后立即生效。
++
+
+
+
+
该方法用于关闭或重新启用本地视频采集,不影响接收远端视频流。调用
该方法用于禁用或重新启用本地视频采集,不影响接收远端视频流。如果在频道内调用
该方法用于关闭或重新开启本地视频采集,不影响接收远端视频流。调用
该方法用于关闭或重新开启本地视频采集,不影响接收远端视频流。调用
+
+
+
+
+
启用该功能后,声卡的输出音频会被混入发送到远端的音频流中。
+如果你启用了声卡回采功能,声卡的输出会被混入发送到远端的音频流中。
++
+
+
如果未将回调方法派发到主线程,则需要自行将 UI 操作派发到主线程。
+如果未将回调方法派发到主线程,则需要自行将 UI 操作派发到主线程。
++
+
+
声网建议你在已有摄像头用于视频采集的场景中,按照以下步骤使用多个摄像头进行视频采集和发布: +
声网建议你在已有摄像头用于视频采集的场景中,按照以下步骤使用多摄像头进行视频采集和发布: +
+
+
+
请确保在加入频道前调用该方法。本地用户随后可以调用
请在加入频道前调用该方法。启用后,本地用户可以通过调用
请确保在加入频道前调用该方法,从而使你可以通过调用
请确保在加入频道前调用该方法,从而使你可以通过调用
+
+
+
+
+
启用空间音效后,你可以调用
你可以调用
你可以在加入频道前或加入频道后调用该方法。启用空间音效后,可以调用
你可以在加入频道前或加入频道后调用该方法。启用空间音效后,可以调用
+
+
+
+
+
默认情况下,视频模块处于关闭状态。调用该方法可启用视频模块。如果你需要在之后关闭视频模块,需要调用
默认情况下,视频模块处于禁用状态。调用该方法可启用视频模块。如果之后需要禁用视频模块,需要调用
默认情况下视频模块处于关闭状态,调用该方法可启用视频模块。如果需要关闭视频模块,需要调用
默认情况下视频模块处于关闭状态,调用该方法可启用视频模块。如果需要关闭视频模块,需要调用
该方法可以在加入频道前或加入频道后调用: +
该方法可以在加入频道前或加入频道后调用: +
该方法可以在加入频道前或加入频道后调用。
+该方法可以在加入频道前或加入频道后调用。
++
+
+
+
+
你可以调用该方法,在发布视频流时用自定义图片替代当前的视频画面。启用该功能后,可通过
你可以在发布视频流时调用该方法,用自定义图片替代当前的视频画面。启用该功能后,可通过
你可以调用该方法在发布视频流时使用自定义图片替代当前视频画面。启用该功能后,可以通过参数
你可以调用该方法在发布视频流时使用自定义图片替代当前视频画面。启用该功能后,可以通过参数
请在加入频道后调用该方法。
+请在加入频道后调用该方法。
+请在加入频道后调用该方法。
+请在加入频道后调用该方法。
++
+
+
+
+
虚拟背景功能支持本地用户将原始背景替换为静态图片、动态视频、模糊背景或人像背景分割,以实现画中画效果。启用虚拟背景功能后,频道内的所有用户都可以看到自定义背景。请在调用
虚拟背景功能支持本地用户将原始背景替换为静态图片、动态视频、模糊背景或人像背景分割,以实现画中画效果。启用该功能后,频道内所有用户都可以看到自定义背景。请在调用
虚拟背景功能支持你将原始背景替换为静态图片、动态视频、模糊背景或人像背景分割,以实现画中画效果。启用该功能后,频道内的所有用户都可以看到你设置的自定义背景。请在调用
虚拟背景功能支持你将原始背景替换为静态图片、动态视频、模糊背景或人像背景分割,以实现画中画效果。启用该功能后,频道内的所有用户都可以看到你设置的自定义背景。请在调用
+
+
+
+
+
虚拟背景功能支持你将原始背景替换为静态图片、动态视频、模糊背景或人像背景分割,以实现画中画效果。启用该功能后,频道内的所有用户都可以看到自定义背景。该方法与
该方法用于启用或关闭虚拟背景功能。你可以将原始背景替换为静态图片、动态视频、模糊背景或人像背景分割,以实现画中画效果。启用后,频道内所有用户都可以看到自定义背景。
+
+该方法与
虚拟背景功能支持你将原始背景替换为静态图片、动态视频、模糊背景或人像背景分割,以实现画中画效果。启用该功能后,频道内的所有用户都可以看到自定义背景。该方法与
+
+
+
+
支持增强音质和调整音色风格。
+支持增强音质和调整音色风格。
+支持增强音质和调整音色风格。
+社交娱乐场景,包括在线 KTV、在线播客和展厅直播等对音质要求较高的场景。
+该方法可在加入频道前或后调用。
+该方法可在加入频道前或后调用。
+你可以在加入频道前或后调用该方法。
+你可以在加入频道前或后调用该方法。
++
+
+
+
+
你可以调用该方法启用或关闭与声网 Web SDK 的互通功能。如果频道中有 Web SDK 用户,必须调用该方法,否则 Native 用户的视频画面在 Web 端会显示为黑屏。该方法仅适用于极速直播场景,在语音通话场景中默认启用互通功能。
+如果频道中存在 Web SDK 用户,必须调用该方法,否则 Native 用户的视频画面在 Web 端将显示为黑屏。该方法仅适用于极速直播场景,在语音通话场景中默认启用互通功能。
+你可以调用该方法启用或关闭与声网 Web SDK 的互通功能。如果频道中有 Web SDK 用户,确保调用该方法,否则 Native 用户的视频画面在 Web 端将显示为黑屏。该方法仅适用于极速直播场景,在语音通话场景中默认启用互通功能。
+你可以调用该方法启用或关闭与声网 Web SDK 的互通功能。如果频道中有 Web SDK 用户,确保调用该方法,否则 Native 用户的视频画面在 Web 端将显示为黑屏。该方法仅适用于极速直播场景,在语音通话场景中默认启用互通功能。
++
+
+
+
+
该方法返回一个
+
+
当系统默认音频播放设备发生变化时,SDK 会根据你的设置自动切换音频播放设备。
++
+
+
+
调用该方法可以获取音频设备是否支持超低延迟采集和播放。
++
方法调用成功,返回
+
方法调用成功,返回
+
获取音频混音的播放位置(毫秒)。
+获取音频混音的播放位置(毫秒)。
++
+
+
+
+
请在调用
请在调用
在调用
在调用
+
+
+
+
+
你可以调用该方法获取混音音频文件的本地播放音量,有助于排查与音量相关的问题。
+你可以调用该方法获取混音音频文件的本地播放音量,有助于排查与音量相关的问题。
+你可以调用此方法获取混音音频文件的本地播放音量,有助于排查与音量相关的问题。
+你可以调用此方法获取混音音频文件的本地播放音量,有助于排查与音量相关的问题。
+请在调用
在调用
请在调用
请在调用
+
+
+
+
+
该方法有助于排查音频音量相关的问题。
+该方法有助于你排查与音频音量相关的问题。
+该方法有助于你排查与音频音量相关的问题。
++
+
+
+
+
+
+
+
+
+
当用户在客户端加入频道时,SDK 会生成一个用于标识该通话的
客户端在用户加入频道后会生成一个用于标识当前通话的
当你在客户端加入频道时,系统会生成一个用于标识该通话的
当你在客户端加入频道时,系统会生成一个用于标识该通话的
在加入频道后调用该方法。
+该方法需要在加入频道后调用。
+请在加入频道后调用此方法。
+请在加入频道后调用此方法。
++
+
+
+
+
方法调用成功,返回摄像头支持的最大变焦倍数。
+方法调用成功,返回摄像头支持的最大变焦倍数。
+方法调用成功,返回摄像头支持的最大变焦倍数。
+
+
该方法可以在加入频道前或加入频道后调用。
+该方法可以在加入频道前或加入频道后调用。
+该方法可以在加入频道前或加入频道后调用。
+该方法可以在加入频道前或加入频道后调用。
+方法调用成功,返回当前连接状态,详见
+
方法调用成功时,返回当前连接状态,详见
方法调用成功时,返回当前连接状态,详见
+
在自定义视频采集或自定义音频采集场景中,为确保音视频同步,建议调用该方法获取 SDK 当前的单调时间(单位为毫秒),并将该值传入采集的视频帧(
在自定义视频采集和自定义音频采集场景中,为确保音视频同步,声网建议调用该方法获取 SDK 当前的单调时间,并将该值传入采集的视频帧 (
单调时间是指一个随时间递增的时间序列,单位为毫秒。在自定义视频采集和自定义音频采集场景中,为确保音视频同步,声网建议你调用该方法获取 SDK 当前的单调时间,并将该值传入采集的视频帧(
单调时间是指一个随时间递增的时间序列,单位为毫秒。在自定义视频采集和自定义音频采集场景中,为确保音视频同步,声网建议你调用该方法获取 SDK 当前的单调时间,并将该值传入采集的视频帧(
该方法可以在加入频道前或加入频道后调用。
+该方法可在加入频道前或加入频道后调用。
+该方法可以在加入频道前或加入频道后调用。
+该方法可以在加入频道前或加入频道后调用。
++
+
+
+
+
+
+
你可以通过该方法,根据
+
+
+
+
获取指定音效文件的播放位置,单位为毫秒。
+获取指定音效文件的播放位置,单位为毫秒。
++
+
+
+
+
+
+
+
+
+
音量为 0 到 100 之间的整数,默认值为 100,表示原始音量。
+音量为整数,范围为 0 到 100。默认值为 100,表示原始音量。
+音量为整数,范围为 0 到 100。默认值为 100,表示原始音量。
+音量为整数,范围为 0 到 100。默认值为 100,表示原始音量。
++
+
+
+
+
你可以通过该方法获取由 SDK 报告的警告或错误码所对应的描述信息。
+你可以通过该方法获取由 SDK 报告的警告或错误码所对应的描述信息。
++
方法调用成功时,返回错误码对应的描述信息。 +方法调用失败,返回空字符串。
+方法调用成功时,返回错误码对应的描述信息。
+方法调用成功时,返回错误码对应的描述信息。
+
+
该方法可以在加入频道前或加入频道后调用。
+该方法可以在加入频道前或加入频道后调用。
+该方法可以在加入频道前或加入频道后调用。
++
+
+
+
该方法可以在加入频道前或加入频道后调用。
+该方法可以在加入频道前或后调用。
+该方法可以在加入频道前或后调用。
++
+
+
+
+
当用户在应用中打开美型区域和塑形强度菜单时,可以调用该方法获取当前的美颜特效选项,然后根据结果刷新用户界面中的菜单并更新 UI。
+在调用
在调用
在调用
在调用
+
+
方法调用成功,返回
方法调用成功,返回
+
你可以调用该方法获取当前美颜效果的设置选项,并根据返回结果刷新界面菜单,更新 UI。
+当你在 App 中打开美型区域和强度设置菜单时,可以调用此方法获取当前的美颜特效选项,然后根据结果刷新菜单并更新 UI。
+在调用
在调用
在调用
方法调用成功,返回
+
方法调用成功,返回
+
当用户在应用中打开美颜风格和风格强度菜单时,可以调用此方法,并根据返回结果刷新菜单和更新 UI。
+当用户在应用中打开美型风格和风格强度菜单时,可以调用该方法获取当前的美型选项,然后根据结果刷新用户界面中的菜单,并更新 UI。
+在调用
在调用
在调用
在调用
+
方法调用成功,返回
+
+
+
当你在应用中打开风格妆容和风格强度菜单时,可以调用该方法获取当前的美颜特效设置,然后根据结果刷新菜单并更新 UI。
+在调用
在调用
在调用
+
+
+
+
该方法用于获取 SDK 的 C++ 句柄,可用于注册音频和视频帧观察器。
+该方法可用于注册音频和视频帧观察器。
+该方法用于获取 SDK 的 C++ 句柄,可用于注册音频和视频帧观察器。
+方法调用成功,返回 SDK 的原生句柄。
+方法调用成功,返回 SDK 的原生句柄。
+方法调用成功,返回 SDK 的原生句柄。
+
+
你可以在任意阶段调用此方法获取当前使用的网络类型。
+你可以在任意阶段调用此方法获取当前使用的网络类型。
+你可以在任意阶段调用此方法获取当前使用的网络类型。
++
+
+
+
+
在实时合唱场景中,尤其是当多个接收端因网络问题导致下行链路不一致时,可以调用该方法获取当前的 NTP 时间作为参考时间,以对齐多个接收端的歌词和音乐,实现合唱同步。
+在实时合唱场景中,尤其是当多个接收端因网络问题导致下行链路连接不一致时,可以调用该方法获取当前 NTP 时间作为参考时间,以对齐多个接收端的歌词和音乐,实现合唱同步。
+在实时合唱场景中,尤其是当多个接收端因网络问题导致下行连接不一致时,可以调用该方法获取当前的 NTP 时间作为参考时间,以对齐多个接收端的歌词和音乐,实现合唱同步。
+在实时合唱场景中,尤其是当多个接收端因网络问题导致下行连接不一致时,可以调用该方法获取当前的 NTP 时间作为参考时间,以对齐多个接收端的歌词和音乐,实现合唱同步。
+方法调用成功,返回当前 NTP 时间的 Unix 时间戳(毫秒)。
+方法调用成功,返回当前 NTP 时间的 Unix 时间戳(毫秒)。
+方法调用成功,返回当前 NTP 时间的 Unix 时间戳(毫秒)。
+方法调用成功,返回当前 NTP 时间的 Unix 时间戳(毫秒)。
+
+
你可以在共享屏幕或窗口前调用该方法,获取可共享的屏幕和窗口列表。用户可通过列表中的缩略图轻松选择要共享的屏幕或窗口。该列表还包含窗口 ID 和屏幕 ID 等信息,你可以使用这些信息调用
你可以在共享屏幕或窗口前调用该方法,以获取可共享的屏幕和窗口列表。用户可以通过列表中的缩略图轻松选择要共享的特定屏幕或窗口。该列表还包含窗口 ID 和屏幕 ID 等信息,你可以使用这些信息调用
+
+
+
当远端用户加入频道后,SDK 会获取该远端用户的用户 ID 和用户 User Account,并将其缓存在一个映射表中,并在本地客户端触发
当远端用户加入频道后,SDK 会获取该远端用户的用户 ID 和用户 User Account,并将其缓存在映射表中,同时在本地客户端触发
远端用户加入频道后,SDK 会获取该用户的用户 ID 和用户 User Account,并将其缓存在映射表对象中,同时在本地客户端触发
远端用户加入频道后,SDK 会获取该用户的用户 ID 和用户 User Account,并将其缓存在映射表对象中,同时在本地客户端触发
在收到
该方法在收到
在收到
在收到
+
+
+
+
+
远端用户加入频道后,SDK 会获取该远端用户的用户 ID 和用户 User Account,并将其缓存在映射表中,同时在本地客户端触发
当远端用户加入频道后,SDK 会获取该远端用户的用户 ID 和用户 User Account,并将其缓存在映射表中,同时在本地客户端触发
远端用户加入频道后,SDK 会获取该远端用户的用户 ID 和用户 User Account,并将其缓存在映射表对象中,然后在本地客户端触发
远端用户加入频道后,SDK 会获取该远端用户的用户 ID 和用户 User Account,并将其缓存在映射表对象中,然后在本地客户端触发
在收到
该方法应在收到
该方法应在收到
+
+
+
+
+
+
方法调用成功时,返回 SDK 的版本号字符串。 +方法调用失败,返回空字符串。
+方法调用成功时,返回 SDK 的版本号,类型为
方法调用成功时,返回 SDK 的版本号,类型为
+
+
+
+
+
+
你可以通过调用此方法或
你可以通过调用此方法或调用
你可以通过调用此方法或调用
在调用其他 API 之前,必须先调用
在调用其他 API 之前,必须先调用此方法创建
在调用其他 API 之前,必须先调用此方法创建
在调用其他 API 之前,必须先调用此方法创建
+
方法调用成功,返回初始化后的
+
+
+
+
+
+
+
+
建议在调用
在调用
在调用
必须在摄像头成功启用后调用,即 SDK 触发
你必须在摄像头成功启用后调用该方法,即 SDK 触发
你必须在摄像头成功启用后调用该方法,即 SDK 触发
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
必须在 SDK 触发
你必须在 SDK 触发
必须在 SDK 触发
+
+
+
你可以通过该方法判断当前设备是否满足使用虚拟背景、图像增强等高级功能的性能要求,从而避免在低性能设备上启用相关功能导致性能下降或功能不可用。根据返回结果,你可以决定是否展示或启用对应功能按钮,或在设备性能不足时提示用户。
+在使用高级功能前,建议调用该方法判断当前设备的能力是否满足要求,以避免在低端设备上启用高级功能时出现性能下降或功能不可用的情况。你可以根据该方法的返回值决定是否显示或启用相应的功能按钮,或在设备能力不足时提示用户。
+你可以使用该方法检查当前设备的能力是否满足虚拟背景、图像增强等高级功能的要求。该方法适用于在启用高级功能前进行设备能力判断,以避免在低端设备上启用功能时出现性能下降或功能不可用的问题。你可以根据该方法的返回值决定是否显示或启用相应的功能按钮,或在设备能力不足时通知用户。
+你可以使用该方法检查当前设备的能力是否满足虚拟背景、图像增强等高级功能的要求。该方法适用于在启用高级功能前进行设备能力判断,以避免在低端设备上启用功能时出现性能下降或功能不可用的问题。你可以根据该方法的返回值决定是否显示或启用相应的功能按钮,或在设备能力不足时通知用户。
++
+
+
+
+
你可以在加入频道前或加入频道后调用该方法。
+你可以在加入频道前或加入频道后调用该方法。
+你可以在加入频道前或加入频道后调用该方法。
++
+
+
+
+
+
默认情况下,用户会订阅频道中其他所有用户的音视频流,从而产生使用量和计费。如需停止订阅指定流或所有远端流,请调用管理发布与订阅的相关方法。
+默认情况下,用户会订阅频道中其他所有用户的音视频流,从而产生使用量和计费。如需停止订阅指定流或所有远端流,请调用管理发布与订阅的相关方法。
+默认情况下,你会订阅频道中其他所有用户的音视频流,从而产生使用量和计费。如需停止订阅指定流或所有远端流,请调用管理发布与订阅的相关方法。请在调用
默认情况下,你会订阅频道中其他所有用户的音视频流,从而产生使用量和计费。如需停止订阅指定流或所有远端流,请调用管理发布与订阅的相关方法。请在调用
该方法需要在调用
请在调用
请在调用
请在调用
+
+
+
+
+
该方法相比
该方法新增
与
与
请在调用
请在调用
请在调用
请在调用
+
+
0:方法调用成功。 +< 0:方法调用失败。 +
0:方法调用成功。 +< 0:方法调用失败。 +
+
在调用该方法之前,如果你尚未调用
调用
在调用该方法之前,如果你尚未调用
在调用该方法之前,如果你尚未调用
在调用
请在调用
在调用
在调用
+
+
+
+
+
在调用该方法前,如果你尚未调用
该方法新增了
在调用该方法之前,如果你尚未调用
在调用该方法之前,如果你尚未调用
请在调用
在调用
请在调用
请在调用
+
+
0:方法调用成功。 +< 0:方法调用失败。 +
0:方法调用成功。 +< 0:方法调用失败。 +
+
在调用该方法之前,如果你尚未调用
该方法适用于多频道场景。
+请在调用
+
+
调用该方法后,SDK 会终止音视频互动,离开当前频道,并释放与会话相关的所有资源。加入频道后,必须调用该方法结束通话,否则无法开始下一次通话。
+调用该方法后,SDK 会终止音视频互动,释放与会话相关的所有资源。加入频道后,必须调用该方法结束通话,否则无法开始下一次通话。
+调用该方法后,SDK 会终止音视频互动,离开当前频道,并释放与会话相关的所有资源。加入频道后,必须调用该方法结束通话,否则无法开始下一次通话。
+调用该方法后,SDK 会终止音视频互动,离开当前频道,并释放与会话相关的所有资源。加入频道后,必须调用该方法结束通话,否则无法开始下一次通话。
+在加入频道后调用该方法。
+在加入频道后调用该方法。
+在加入频道后调用该方法。
+在加入频道后调用该方法。
++
+
+
+
+
调用该方法后,SDK 会终止音视频互动,离开当前频道,并释放与会话相关的所有资源。如果你调用了
调用该方法后,SDK 会终止音视频互动,离开当前频道,并释放与会话相关的所有资源。如果你调用了
调用该方法后,SDK 会终止音视频互动,离开当前频道,并释放与会话相关的所有资源。加入频道后,必须调用该方法或
调用该方法后,SDK 会终止音视频互动,离开当前频道,并释放与会话相关的所有资源。加入频道后,必须调用该方法或
在加入频道后调用该方法。
+在加入频道后调用该方法。
+在加入频道后调用该方法。
+在加入频道后调用该方法。
++
+
+
+
+
该方法用于将 SDK 外部的扩展(例如来自云市场或 SDK 扩展)加载到 SDK 中。
+请确保在调用该方法前已初始化
+
+
你可以通过该方法监控外部音视频设备(如外接摄像头)的插拔和更换。
+
+
该方法用于停止或恢复接收所有通过
请在加入频道后调用该方法。本地用户将停止或恢复订阅所有远端用户的音频流,包括之后加入频道的用户。
+调用该方法后,你将停止或恢复订阅所有远端用户的音频流,包括之后加入频道的用户。
+调用该方法后,你将停止或恢复订阅所有远端用户的音频流,包括之后加入频道的用户。
+请在加入频道后调用该方法。
+该方法需要在加入频道后调用。
+该方法需要在加入频道后调用。
++
+
+
+
+
该方法对所有通过
请在加入频道后调用该方法。调用该方法后,本地用户将停止或恢复订阅所有远端用户的视频流,包括之后加入频道的用户。
+调用该方法后,你会停止或恢复订阅所有远端用户的视频流,包括后续加入频道的用户。
+调用该方法后,你会停止或恢复订阅所有远端用户的视频流,包括后续加入频道的用户。
+请在加入频道后调用该方法。
+请在加入频道后调用该方法。
+请在加入频道后调用该方法。
++
+
+
+
+
调用该方法停止发布本地采集的音频流时,音频采集设备仍会继续工作,不受影响。
+调用该方法停止发布本地音频流时,音频采集设备仍会正常工作,不受影响。
+该方法用于控制是否发布本地采集的音频流。如果你调用该方法停止发布音频流,音频采集设备仍会正常工作,不受影响。
+该方法用于控制是否发布本地采集的音频流。如果你调用该方法停止发布音频流,音频采集设备仍会正常工作,不受影响。
+该方法可以在加入频道前或后调用。
+该方法可以在加入频道前或加入频道后调用。
+该方法可以在加入频道前或加入频道后调用。
+该方法可以在加入频道前或加入频道后调用。
++
+
+
+
+
该方法用于控制是否发布本地采集的视频流。如果你调用该方法停止发布本地视频流,视频采集设备仍然正常工作,不受影响。
+相比通过将
该方法用于控制是否发布本地采集的视频流。调用该方法停止发布本地视频流时,视频采集设备仍会继续工作,不受影响。相比通过将
该方法用于控制是否发布本地采集的视频流。调用该方法停止发布本地采集的视频流时,视频采集设备仍会继续工作,不受影响。
+
+与调用
该方法用于控制是否发布本地采集的视频流。调用该方法停止发布本地采集的视频流时,视频采集设备仍会继续工作,不受影响。
+
+与调用
该方法可以在加入频道前或后调用。
+该方法可以在加入频道前或加入频道后调用。
+该方法可以在加入频道前或后调用。
+该方法可以在加入频道前或后调用。
++
+
+
+
+
如果你已经调用
如果你已经调用了
如果你已经调用了
如果你已经调用了
该方法可以在加入频道前或后调用。
+该方法可以在加入频道前或后调用。
+该方法可以在加入频道前或后调用。
+该方法可以在加入频道前或后调用。
++
+
+
+
+
请在加入频道后调用该方法。
+在加入频道后调用该方法。
+在加入频道后调用该方法。
+在加入频道后调用该方法。
++
+
+
+
+
在加入频道后调用该方法。
+请在加入频道后调用该方法。
+请在加入频道后调用该方法。
+请在加入频道后调用该方法。
++
+
+
+
+
你可以在开始跨频道媒体流转发后调用该方法,以暂停向所有目标频道转发媒体流。如需恢复转发,请调用
你可以调用该方法暂停向所有目标频道转发媒体流。如需恢复转发,请调用
跨频道媒体流转发开始后,你可以调用此方法暂停向所有目标频道转发媒体流。如需恢复转发,请调用
跨频道媒体流转发开始后,你可以调用此方法暂停向所有目标频道转发媒体流。如需恢复转发,请调用
+
+
+
+
+
+
+
+
+
+
调用
调用
调用
调用
请在加入频道后调用该方法。
+请在加入频道后调用该方法。
+请在加入频道后调用该方法。
+请在加入频道后调用该方法。
++
+
+
+
+
你可以调用该方法暂停指定的音效文件。
+你可以调用该方法暂停指定的音效文件。
++
+
+
+
+
多次调用
多次调用
在多次调用
在多次调用
+
+
+
+
+
你可以多次调用该方法,并传入不同的
你可以多次调用该方法,并传入不同的
你可以在加入频道前或加入频道后调用该方法。
+你可以在加入频道前或加入频道后调用该方法。
+0:方法调用成功。 +< 0:方法调用失败。
+0:方法调用成功。 +< 0:方法调用失败。
+
+
你可以多次调用该方法并传入不同的
该方法支持播放以
你可以多次调用该方法并传入不同的
你可以在加入频道前或加入频道后调用该方法。
+你可以在加入频道前或后调用该方法。
+你可以在加入频道前或加入频道后调用该方法。
++
+
+
+
要同时播放多个音效文件,请使用不同的
该方法支持播放以
你可以多次调用该方法并传入不同的
你可以多次调用该方法并传入不同的
你可以在加入频道前或后调用该方法。
+你可以在加入频道前或加入频道后调用该方法。
+你可以在加入频道前或加入频道后调用该方法。
+你可以在加入频道前或加入频道后调用该方法。
++
+
+
+
+
当观众需要频繁切换不同频道时,调用该方法可以缩短加入频道的时间,从而减少观众听到和看到主播的延迟时间。如果你加入了一个已预加载的频道,离开后又想重新加入该频道,除非用于预加载频道的 Token 过期,否则无需再次调用该方法。
+当观众需要频繁切换不同频道时,调用该方法可以缩短加入频道的时间,从而减少观众听到和看到主播的延迟时间。如果你加入了一个已预加载的频道,离开后想重新加入该频道,除非用于预加载频道的 Token 过期,否则无需再次调用该方法。
+该方法用于预加载指定频道。当你作为观众需要频繁切换频道时,调用该方法可以缩短加入频道的时间,从而减少你听到和看到主播的延迟。该方法需要在加入频道前调用。如果你加入了一个已预加载的频道,离开后想要重新加入该频道,除非用于预加载的 Token 过期,否则无需再次调用该方法。为提升预加载频道的用户体验,声网建议你在确认频道名和用户信息后尽早调用该方法。
+该方法用于预加载指定频道。当你作为观众需要频繁切换频道时,调用该方法可以缩短加入频道的时间,从而减少你听到和看到主播的延迟。该方法需要在加入频道前调用。如果你加入了一个已预加载的频道,离开后想要重新加入该频道,除非用于预加载的 Token 过期,否则无需再次调用该方法。为提升预加载频道的用户体验,声网建议你在确认频道名和用户信息后尽早调用该方法。
+为提升预加载频道的用户体验,声网建议在确认频道名和用户信息后尽早调用该方法。
+该方法需要在加入频道前调用。
+该方法需要在加入频道前调用。
++
+
+
+
+
当观众用户需要频繁切换不同频道时,调用该方法可以缩短加入频道的时间,从而减少观众听到和看到主播的延迟时间。如果你加入了一个已预加载的频道,离开后想重新加入该频道,除非用于预加载频道的 Token 过期,否则无需再次调用该方法。
+当观众需要频繁切换不同频道时,调用该方法可以缩短加入频道的时间,从而减少观众听到和看到主播的延迟。如果你加入了一个已预加载的频道,离开后想重新加入同一个频道,除非用于预加载频道的 Token 过期,否则无需再次调用该方法。
+当你需要频繁切换不同频道时,调用该方法可以缩短加入频道的时间,从而减少你听到和看到主播的延迟。如果你加入了一个已预加载的频道,离开后想重新加入同一个频道,除非用于预加载频道的 Token 过期,否则无需再次调用该方法。声网建议你在确认频道名和用户信息后尽早调用该方法,以提升预加载频道的用户体验。
+当你需要频繁切换不同频道时,调用该方法可以缩短加入频道的时间,从而减少你听到和看到主播的延迟。如果你加入了一个已预加载的频道,离开后想重新加入同一个频道,除非用于预加载频道的 Token 过期,否则无需再次调用该方法。声网建议你在确认频道名和用户信息后尽早调用该方法,以提升预加载频道的用户体验。
+为提升预加载频道的用户体验,声网建议在确认频道名和用户信息后尽早调用该方法。
+为提升预加载频道的用户体验,声网建议在确认频道名和用户信息后尽早调用该方法。
+该方法需要在加入频道前调用。
+该方法需要在加入频道前调用。
++
+
+
+
+
确保所有预加载文件的总大小不超过限制。
+你可以多次调用该方法,将多个音效文件预加载到内存中。预加载完成后,可以调用
确保所有预加载文件的总大小不超过限制。
+确保所有预加载文件的总大小不超过限制。
+建议在加入频道前调用该方法。
+声网建议你在加入频道前调用该方法。
+声网建议你在加入频道前调用该方法。
++
+
+
+
+
确保所有预加载文件的总大小不超过限制。关于该方法支持的音频文件格式,详见[声网 RTC SDK 支持哪些音频文件格式](https://doc.shengwang.cn/faq/general-product-inquiry/audio-format)。
+确保所有预加载文件的总大小不超过限制。支持的音频文件格式,详见[声网 RTC SDK 支持哪些音频文件格式](https://doc.shengwang.cn/faq/general-product-inquiry/audio-format)。
+确保所有预加载文件的总大小不超过限制。关于该方法支持的音频文件格式,详见[声网 RTC SDK 支持哪些音频文件格式](https://doc.shengwang.cn/faq/general-product-inquiry/audio-format)。
+声网建议你在加入频道前调用该方法。
+声网建议在加入频道前调用该方法。
+声网建议你在加入频道前调用该方法。
++
+
+
+
调用该方法成功后,你可以拉取解码并混音后的远端音频数据用于播放。调用该方法前,请先调用
调用该方法前,请先调用
调用该方法成功后,你可以拉取解码并混音后的远端音频数据用于播放。调用该方法前,请先调用
在加入频道后调用该方法。
+该方法需要在加入频道后调用。
+在加入频道后调用该方法。
++
+
+
+
在调用该方法之前,你需要调用
+
+
调用该方法后,你可以拉取解码并混音后的音频数据用于播放。
+调用该方法后,你可以拉取解码并混音后的音频数据用于播放。
+方法调用成功,返回
方法调用成功,返回
+
你可以调用该方法通过音频轨道向 SDK 推送外部音频帧。 +调用该方法前,请先完成以下操作: +
你可以调用该方法通过音频轨道向 SDK 推送外部音频帧。 +调用该方法前,请先完成以下操作: +
+
+
+
+
+
+
+
在调用该方法推送外部音频数据之前,你需要完成以下操作: +
在调用该方法推送外部音频数据之前,你需要完成以下操作: +
+
+
+
要发布自定义视频源,请按照以下步骤操作: +
要发布自定义视频源,请按照以下步骤操作: +
要发布自定义视频源,请按照以下步骤操作: +
+
+
+
+
调用
调用
调用
+
+
+
+
要发布自定义视频源,请按照以下步骤操作: +
+
+
调用
+
+
如果你希望在视频采集中启用广角或超广角模式,建议先调用该方法检查设备是否支持所需的焦距能力。然后根据查询结果调用
如果你希望在视频采集中启用广角或超广角模式,建议你首先调用
建议在启用广角或超广角模式进行视频采集前,调用该方法检查设备是否支持所需的焦距能力。根据查询结果调用
+
+
+
+
+
方法调用成功,返回
+
+
+
在高清或超高清的视频场景中,可以调用该方法查询设备评分。如果返回的评分较低(例如低于 60),建议降低视频分辨率,以避免影响视频体验。不同业务场景对设备评分的最低要求不同,具体建议请[联系技术支持](https://ticket.shengwang.cn/)。
+你可以调用该方法查询设备评分。如果返回的评分较低(例如低于 60),你需要降低视频分辨率,以避免影响视频体验。不同业务场景对设备评分的最低要求不同,具体评分建议请[联系技术支持](https://ticket.shengwang.cn/)。
+在高清或超高清的视频场景中,你可以先调用该方法查询设备评分。如果返回的评分较低(例如低于 60),你需要降低视频分辨率,以避免影响视频体验。不同业务场景对设备评分的最低要求不同。具体评分建议请[联系技术支持](https://ticket.shengwang.cn/)。
+在高清或超高清的视频场景中,你可以先调用该方法查询设备评分。如果返回的评分较低(例如低于 60),你需要降低视频分辨率,以避免影响视频体验。不同业务场景对设备评分的最低要求不同。具体评分建议请[联系技术支持](https://ticket.shengwang.cn/)。
++
+
+
+
+
+
+
为了确保屏幕共享的最佳性能,特别是在启用如 60 fps 的高帧率时,建议你在共享前调用该方法,查询设备支持的最高帧率。如果设备不支持高帧率,你可以相应地降低屏幕共享流的帧率,以避免影响共享质量。
+为了确保屏幕共享的最佳性能,特别是在启用如 60 fps 的高帧率时,声网建议你在共享前使用该方法查询设备支持的最大帧率。如果设备无法支持如此高的帧率,你可以相应地调整屏幕共享流的帧率,以避免影响共享质量。
+为确保屏幕共享的最佳性能,特别是在启用如 60 fps 的高帧率时,建议你在共享前使用该方法查询设备支持的最高帧率。
+你可以在开始屏幕共享前调用该方法,查询设备支持的最高帧率,以确保屏幕共享的最佳性能,特别是在启用如 60 fps 的高帧率时。如果设备不支持高帧率,你可以相应地降低屏幕共享流的帧率,以避免影响共享质量,确保共享效果符合预期。
++
+
+
+
+
+
+
+
+
+
+
+
+
+
调用此方法可注册音频帧观察者对象。当你需要 SDK 触发
调用该方法注册音频帧观测器对象后,SDK 会触发
调用此方法可注册音频帧观察者对象。当你需要 SDK 触发
该方法需要在加入频道前调用。
+在加入频道前调用此方法。
+该方法需要在加入频道前调用。
++
+
+
+
成功注册音频频谱观察器并调用
成功注册音频频谱观察器并调用
成功注册音频频谱观察者并调用
成功注册音频频谱观察者并调用
+
+
+
+
+
对于 SDK 外部的扩展(例如来自云市场和 SDK 扩展),你需要在调用该方法前先加载它们。对于 SDK 内部的扩展(即包含在完整 SDK 包中的扩展),在初始化
+
对于 SDK 外部的扩展(例如来自 Extensions Marketplace 和 SDK Extensions 的扩展),你需要在调用此方法前加载它们。对于 SDK 内部的扩展(即包含在完整 SDK 包中的扩展),在初始化
对于 SDK 外部的扩展(例如来自 Extensions Marketplace 和 SDK Extensions 的扩展),你需要在调用此方法前加载它们。对于 SDK 内部的扩展(即包含在完整 SDK 包中的扩展),在初始化
声网建议你在初始化
声网建议你在初始化
声网建议你在初始化
声网建议你在初始化
+
+
+
+
+
该方法用于注册用户 User Account。注册成功后,用户 User Account 可用于在加入频道时标识本地用户身份。你可以选择以下任一方式使用用户 User Account 加入频道: +
该方法用于注册用户 User Account。注册成功后,用户 User Account 可用于在加入频道时标识本地用户身份。该方法为可选项。如果你希望使用用户 User Account 加入频道,可以选择以下任一方式: +
+
+
+
+
+
你需要实现
你需要实现
你需要实现
你需要实现
+
+
+
+
+
调用该方法注册一个数据包观察器。当声网 SDK 触发用于语音或视频数据包传输的
+
+
如果你只想观察编码后的视频帧(例如 H.264 格式),而不进行解码和渲染,声网建议你通过此方法实现一个
建议通过此方法注册一个
如果你只想观察编码后的视频帧(例如 H.264 格式),而不进行解码和渲染,声网建议你通过此方法实现一个
+
+
+
+
如果你希望观察原始视频帧(例如 YUV 或 RGBA 格式),声网建议你通过此方法实现一个
建议通过该方法注册一个
如果你希望观察原始视频帧(例如 YUV 或 RGBA 格式),声网建议你通过此方法实现一个
该方法需要在加入频道前调用。
+请在加入频道前调用此方法。
+该方法需要在加入频道前调用。
++
+
+
+
该方法释放声网 SDK 占用的所有资源,适用于用户偶尔进行语音或视频通话的场景。当用户不再通话时,可以释放资源以供其他操作使用。调用该方法成功后,将无法再使用 SDK 中的任何方法或回调。如需再次使用实时通信功能,必须调用
该方法释放所有由声网 SDK 占用的资源。成功调用该方法后,将无法再使用 SDK 中的任何方法或回调。如需再次使用实时通信功能,必须调用
该方法会释放 SDK 使用的所有资源。适用于用户偶尔进行语音或视频通话的场景。当你不再进行通话时,可以通过该方法释放资源,以便用于其他操作。成功调用该方法后,将无法再使用 SDK 中的任何方法或回调。如需再次使用实时通信功能,必须调用
该方法会释放 SDK 使用的所有资源。适用于用户偶尔进行语音或视频通话的场景。当你不再进行通话时,可以通过该方法释放资源,以便用于其他操作。成功调用该方法后,将无法再使用 SDK 中的任何方法或回调。如需再次使用实时通信功能,必须调用
+
该方法用于移除指定的回调处理器。对于只需监听一次的回调事件,在接收到事件后,可以调用该方法移除对应的回调处理器。
+
+
该方法根据指定的唯一 ID,从本地视频流中移除之前添加的水印图像。
+该方法使用指定的唯一 ID,从本地视频流中移除之前添加的水印图像。
+该方法使用你指定的唯一标识符,从本地视频流中移除之前添加的水印图像。
+该方法使用你指定的唯一标识符,从本地视频流中移除之前添加的水印图像。
++
+
+
+
+
成功调用该方法后,SDK 会触发
调用该方法更新 Token。调用成功后,SDK 会触发
该方法用于更新 Token。调用该方法成功后,SDK 会触发
该方法用于更新 Token。调用该方法成功后,SDK 会触发
+
+
+
+
+
调用
调用
调用
+
+
+
+
+
调用
调用
调用
调用
请在调用
请在调用
请在调用
请在调用
+
+
+
+
+
调用
调用
调用
调用
请在加入频道后调用该方法。
+请在加入频道后调用此方法。
+请在加入频道后调用此方法。
+请在加入频道后调用此方法。
++
+
+
+
+
+
+
+
+
+
获取音频文件的音轨索引后,可以调用该方法指定任意音轨进行播放。例如,如果一个多音轨文件的不同音轨存储了不同语言的歌曲,可以调用该方法设置播放语言。
+获取音频文件的音轨索引后,可以调用该方法指定任意音轨进行播放。例如,如果一个多音轨文件的不同音轨存储了不同语言的歌曲,可以调用该方法设置播放语言。
+获取音频文件的音轨索引后,可以调用该方法指定任意音轨进行播放。例如,如果多音轨文件的不同音轨存储了不同语言的歌曲,可以调用该方法设置播放语言。
+获取音频文件的音轨索引后,可以调用该方法指定任意音轨进行播放。例如,如果多音轨文件的不同音轨存储了不同语言的歌曲,可以调用该方法设置播放语言。
++
+
+
+
+
该功能处于测试阶段,支持上报和分析自定义消息,当前提供免费试用。在测试版本中,最多支持在 6 秒内上报 10 条消息,每条消息不超过 256 字节,每个字符串不超过 100 字节。如需试用该功能,请联系销售并与我们讨论自定义消息的格式。
+该功能目前处于测试阶段,提供免费试用。在测试版本中,最多支持在 6 秒内上报 10 条消息,每条消息不超过 256 字节,每个字符串不超过 100 字节。如需试用该功能,请[联系技术支持](https://ticket.shengwang.cn/),并与我们讨论自定义消息的格式。
+声网支持你上报和分析自定义消息。该功能目前处于测试阶段,提供免费试用。在测试版本中,最多支持在 6 秒内上报 10 条消息,每条消息不超过 256 字节,每个字符串不超过 100 字节。如需试用该功能,请[联系技术支持](https://ticket.shengwang.cn/),并与我们讨论自定义消息的格式。
+声网支持你上报和分析自定义消息。该功能目前处于测试阶段,提供免费试用。在测试版本中,最多支持在 6 秒内上报 10 条消息,每条消息不超过 256 字节,每个字符串不超过 100 字节。如需试用该功能,请[联系技术支持](https://ticket.shengwang.cn/),并与我们讨论自定义消息的格式。
++
+
+
+
+
调用
调用
调用
调用
+
+
+
+
+
如果你有高级音频处理需求,例如采集和发送立体声音频,可以调用该方法设置高级音频选项。
+如果你有高级音频处理需求,例如采集和发送立体声音频,可以调用此方法。
+如果你有高级音频处理需求,例如采集和发送立体声音频,可以调用此方法设置音频高级选项。
+如果你有高级音频处理需求,例如采集和发送立体声音频,可以调用此方法设置音频高级选项。
++
+
+
+
+
你可以调用该方法启用 AI 降噪功能。启用后,SDK 会在保证人声质量的前提下,自动检测并减少音频中的稳态和非稳态噪声。 +稳态噪声是指在观察时间内平均统计特性恒定、幅度波动极小的噪声信号。常见来源包括: +
你可以调用此方法启用 AI 降噪功能。启用后,SDK 会在保证人声质量的前提下,自动检测并减少音频中的稳态和非稳态噪声。 +
你可以调用此方法启用 AI 降噪功能。启用后,SDK 会在保证人声质量的前提下,自动检测并减少音频中的稳定噪声和非稳定噪声。 +稳定噪声是指在观察时间内平均统计特性恒定、音量波动极小的噪声信号。常见的稳定噪声来源包括: +
你可以调用此方法启用 AI 降噪功能。启用后,SDK 会在保证人声质量的前提下,自动检测并减少音频中的稳定噪声和非稳定噪声。 +稳定噪声是指在观察时间内平均统计特性恒定、音量波动极小的噪声信号。常见的稳定噪声来源包括: +
在连麦、在线教育和视频会议等场景中,该功能可检测并减少背景噪声,从而提升体验。
+你可以在加入频道前或后调用该方法。
+你可以在加入频道前或加入频道后调用此方法。
+你可以在加入频道前或加入频道后调用此方法。
+你可以在加入频道前或加入频道后调用此方法。
++
+
0:方法调用成功。 +< 0:方法调用失败。
+0:方法调用成功。 +< 0:方法调用失败。
+
+
调用该方法可以为发送音频流的本地用户设置以下参数: +
调用该方法可以为发送音频流的本地用户设置以下参数: +
调用该方法可为发送音频流的本地用户设置以下参数: +
调用该方法可为发送音频流的本地用户设置以下参数: +
你可以在加入频道前或加入频道后调用该方法。
++
+
+
+
+
调用该方法为发送音频流的本地用户设置 SDK 预设的音效效果。该音效不会改变原始声音的性别特征。设置后,频道内所有用户都能听到该效果。 +为了获得更好的音效效果,建议在调用该方法前,先调用以下方法: +
该方法不会改变原始声音的性别特征。设置后,频道内所有用户都能听到该效果。 +为获得更好的人声效果,建议在调用该方法前先调用以下方法: +
你可以调用该方法为发送音频流的本地用户设置声网预设的音效效果。该音效不会改变原始声音的性别特征。设置后,频道内所有用户都能听到该音效效果。 +建议你在调用该方法前,先调用以下 API 以获得更好的人声效果: +
你可以调用该方法为发送音频流的本地用户设置声网预设的音效效果。该音效不会改变原始声音的性别特征。设置后,频道内所有用户都能听到该音效效果。 +建议你在调用该方法前,先调用以下 API 以获得更好的人声效果: +
该方法可以在加入频道前或加入频道后调用。
+该方法可在加入频道前或加入频道后调用。
+该方法可以在加入频道前或加入频道后调用。
+该方法可以在加入频道前或加入频道后调用。
++
+
+
+
+
在立体声音乐文件中,左右声道可以存储不同的音频数据。你可以根据需要将声道模式设置为原始模式、左声道模式、右声道模式或混合声道模式。
+你可以根据需要将音频文件的声道模式设置为原始模式、左声道模式、右声道模式或混合声道模式。例如,在 KTV 场景中,音乐文件的左声道存储伴奏,右声道存储原唱人声。你可以根据实际需求进行设置: +
在立体声音乐文件中,左声道和右声道可以存储不同的音频数据。你可以根据需要将声道模式设置为原始模式、左声道模式、右声道模式或混合声道模式。例如,在 KTV 场景中,音乐文件的左声道存储伴奏,右声道存储原唱人声: +
在立体声音乐文件中,左声道和右声道可以存储不同的音频数据。你可以根据需要将声道模式设置为原始模式、左声道模式、右声道模式或混合声道模式。例如,在 KTV 场景中,音乐文件的左声道存储伴奏,右声道存储原唱人声: +
在 KTV 场景中,音乐文件的左声道存储伴奏,右声道存储原唱人声。你可以根据实际需求进行设置: +
在调用
在调用
在调用
在调用
+
+
+
+
+
调用该方法可在本地音乐文件与本地人声混音时,单独调整本地音乐文件的音调。
+你需要在调用
调用该方法可在本地音乐文件与本地人声混音时,仅调整本地音乐文件的音调。
+调用该方法可在本地音乐文件与本地人声混音时,仅调整本地音乐文件的音调。
+你需要在调用
你需要在调用
你需要在调用
你需要在调用
+
+
+
+
+
请确保在调用
请确保在调用
请在调用
请在调用
+
+
+
+
+
调用该方法可将音乐文件的播放位置设置为指定的起始位置,默认从头开始播放。
+你可以调用该方法将音乐文件的播放位置设置为指定的起始位置。
+你可以调用该方法将音乐文件的播放位置设置为指定的起始位置。
+请在调用
请在调用
请在调用
请在调用
+
+
+
+
+
该方法适用于多种音频场景,可根据需要选择。例如,在音乐教学等对音质要求较高的场景中,建议将
该方法适用于多种音频场景,可根据需要选择。例如,在音乐教学等对音质要求较高的场景中,建议将
该方法适用于多种音频场景,你可以根据实际需求进行选择。例如,在对音质要求较高的场景(如音乐教学)中,建议将
你可以在加入频道前或后调用该方法。
+你可以在加入频道前或加入频道后调用该方法。
+你可以在加入频道前或加入频道后调用该方法。
++
+
+
+
+
如果你需要设置音频场景,可以调用
如果你需要设置音频场景,可以调用
如果你需要设置音频场景,可以调用
你可以根据实际需求选择合适的音频配置文件。例如,在音乐教学等对音质要求较高的场景中,建议将
你可以在加入频道前或后调用该方法。
+你可以在加入频道前或加入频道后调用该方法。
+你可以在加入频道前或后调用该方法。
+你可以在加入频道前或后调用该方法。
++
+
+
+
+
该方法适用于多种音频场景。你可以根据需要进行选择。例如,在音乐教学等对音质要求较高的场景中,建议将
该方法适用于多种音频场景。你可以根据需要进行选择。例如,在音乐教学等对音质要求较高的场景中,建议将
该方法适用于多种音频场景。例如,在对音质要求较高的音乐教学场景中,建议将
你可以在加入频道前或加入频道后调用该方法。
+你可以在加入频道前或后调用该方法。
+你可以在加入频道前或后调用该方法。
+你可以在加入频道前或后调用该方法。
++
+
+
+
+
默认情况下,SDK 和 App 都可以配置音频会话。如果你只希望由 App 配置音频会话,可以通过该方法限制 SDK 的操作权限。你可以在加入频道前或后调用该方法。一旦调用该方法进行限制,当 SDK 需要更改音频会话时,该限制将生效。
+默认情况下,SDK 和 App 都可以配置音频会话。如果你只需要使用 App 来配置音频会话,可以通过该方法限制 SDK 对音频会话的操作权限。你可以在加入频道前或后调用该方法。一旦调用该方法限制 SDK 的操作权限,该限制会在 SDK 需要更改音频会话时生效。
++
+
用户可能会使用两台独立设备分别发送音频和视频流。为了确保接收端的音视频同步,你可以在视频发送端调用该方法,并传入音频发送端的频道名和用户 ID。SDK 会以音频流的时间戳为参考,自动调整视频流,即使两台发送设备处于不同的上行网络(如 Wi-Fi 和 4G),也能实现音视频同步。
+你可以在视频发布设备上调用该方法,并传入音频发布设备所在频道的频道名和用户 ID。SDK 会以发送的音频流的时间戳为参考,自动调整视频流,从而确保即使两个发布设备的上行网络条件不同(例如一个使用 Wi-Fi,另一个使用 4G),接收端的音视频也能实现时间同步。
+你可以使用两台独立设备分别发送音频和视频流。为了确保接收端的音视频同步,你需要在视频发布设备上调用该方法,并传入音频发布设备所在的频道名和用户 ID。SDK 会根据发送音频流的时间戳自动调整视频流,从而确保即使两个发布设备处于不同的上行网络(例如 Wi-Fi 和 4G)时,接收端也能实现音视频同步。
+你可以使用两台独立设备分别发送音频和视频流。为了确保接收端的音视频同步,你需要在视频发布设备上调用该方法,并传入音频发布设备所在的频道名和用户 ID。SDK 会根据发送音频流的时间戳自动调整视频流,从而确保即使两个发布设备处于不同的上行网络(例如 Wi-Fi 和 4G)时,接收端也能实现音视频同步。
++
+
+
+
+
你可以通过该方法启用或禁用图像增强功能,并设置相关选项。请在调用
你可以通过该方法启用或禁用图像增强功能,并设置相关选项。请在调用
在调用
在调用
请在调用
请在调用
+
+
+
+
+
该方法与
该方法用于启用或禁用图像增强功能,并设置相关选项。与
该方法与
请在调用
在调用
请在调用
+
+
+
+
+
+
+
默认情况下,SDK 在 Android 上禁用人脸自动对焦,在 iOS 上启用。你可以调用该方法设置是否启用人脸自动对焦功能。
+你可以通过调用该方法关闭人像自动对焦功能。SDK 默认启用该功能。
+必须在 SDK 触发
必须在 SDK 触发
必须在 SDK 触发
+
+
+
+
在启用本地摄像头采集之前调用该方法,例如调用
该方法需要在启用本地视频采集前调用,例如调用
在启用本地摄像头采集前调用此方法,例如在调用
在启用本地摄像头采集前调用此方法,例如在调用
在启用本地摄像头采集之前调用,例如调用
该方法需要在启用本地视频采集前调用,例如调用
在启用本地摄像头采集前调用,例如在调用
在启用本地摄像头采集前调用,例如在调用
+
+
+
+
+
+
+
你可以通过此方法调整摄像头的曝光值,以获得最佳的视频质量。
++
无实际意义。
++
+
+
+
+
+
你必须在调用
+
+
+
+
摄像头防抖模式默认关闭。你需要调用该方法开启防抖功能,并设置合适的防抖模式。
+你需要调用该方法以开启防抖功能并设置合适的防抖模式。摄像头防抖模式默认关闭。
+在移动拍摄、低光环境或使用移动设备时,可以设置摄像头防抖模式,以减少抖动带来的影响,获得更稳定清晰的画面。
+该方法需在摄像头成功开启后调用,即 SDK 触发
你必须在摄像头成功开启后调用该方法,即 SDK 触发
+
+
+
+
+
+
+
对于配备多镜头后置摄像头的 iOS 设备,例如双摄(广角和超广角)或三摄(广角、超广角和长焦)设备,你可以先调用
你可以调用
+
+
+
+
SDK 会根据不同的频道场景采用不同的优化策略。例如,在极速直播场景中,SDK 会优先保证视频质量。初始化 SDK 后,默认频道场景为极速直播。
+SDK 会根据不同的频道场景采用不同的优化策略,例如在极速直播场景中优先保证视频质量。初始化 SDK 后,默认频道场景为极速直播。
+你可以调用该方法设置频道场景。SDK 会针对不同的频道场景采用不同的优化策略。例如,在极速直播场景中,SDK 会优先保证视频质量。初始化 SDK 后,默认频道场景为极速直播。
+你可以调用该方法设置频道场景。SDK 会针对不同的频道场景采用不同的优化策略。例如,在极速直播场景中,SDK 会优先保证视频质量。初始化 SDK 后,默认频道场景为极速直播。
+请在加入频道前调用此方法。
+在加入频道前调用此方法。
+该方法需要在加入频道前调用。
+该方法需要在加入频道前调用。
++
+
0:方法调用成功。 +< 0:方法调用失败。 +
0:方法调用成功。 +< 0:方法调用失败。 +
+
+
你可以调用该方法将用户角色设置为主播或观众。用户角色决定了用户在 SDK 层的权限,包括是否可以在频道中发布音视频流。 +你可以在加入频道前或加入频道后调用该方法: +
你可以调用该方法设置用户角色。默认情况下,SDK 会将用户角色设置为观众。用户角色决定了你在 SDK 层级的权限,包括是否可以在频道中发布音视频流。 +你可以在加入频道前或加入频道后调用该方法: +
你可以调用该方法设置用户角色。默认情况下,SDK 会将用户角色设置为观众。用户角色决定了你在 SDK 层级的权限,包括是否可以在频道中发布音视频流。 +你可以在加入频道前或加入频道后调用该方法: +
你可以在加入频道前或加入频道后调用该方法。
+你可以在加入频道前或加入频道后调用此方法。
+你可以在加入频道前或加入频道后调用此方法。
+你可以在加入频道前或加入频道后调用此方法。
++
+
+
+
+
该方法用于设置用户角色以及观众延迟等级。你可以调用该方法将用户角色设置为主播。用户角色
默认情况下,SDK 会将用户角色设置为观众。你可以调用此方法将用户角色设置为主播。用户角色 (
你可以调用该方法设置用户角色为主播或观众。用户角色(
你可以调用该方法设置用户角色为主播或观众。用户角色(
你可以在加入频道前或加入频道后调用此方法。
+你可以在加入频道前或加入频道后调用此方法。
+你可以在加入频道前或加入频道后调用此方法。
+你可以在加入频道前或加入频道后调用此方法。
++
+
0:方法调用成功。 +< 0:方法调用失败。 +
0:方法调用成功。 +< 0:方法调用失败。 +
+
当用户的网络访问受防火墙限制时,需要先配置防火墙,允许访问声网提供的特定 IP 地址和端口,然后调用该方法启用云代理,并通过
当用户的网络访问受防火墙限制时,需要先配置防火墙,允许访问声网提供的特定 IP 地址和端口,然后调用该方法启用云代理,并通过
当你的网络访问受防火墙限制时,需要先配置防火墙,允许声网提供的特定 IP 地址和端口,然后调用此方法启用云代理,并通过
当你的网络访问受防火墙限制时,需要先配置防火墙,允许声网提供的特定 IP 地址和端口,然后调用此方法启用云代理,并通过
+
+
+
+
+
摄像头采集的视频图像可能存在色彩失真。色彩增强功能可智能调整视频的饱和度和对比度等特性,从而增强视频的色彩丰富度和还原度,使画面更加生动。
+摄像头采集的视频图像可能存在色彩失真。该功能可智能调整视频的饱和度和对比度等参数,从而提升视频的色彩丰富度和还原度,使画面更加生动。
+摄像头采集的视频图像可能存在色彩失真。色彩增强功能可智能调整视频的饱和度和对比度等特性,从而增强视频的色彩丰富度和色彩还原度,使视频画面更加生动。你可以调用
摄像头采集的视频图像可能存在色彩失真。色彩增强功能可智能调整视频的饱和度和对比度等特性,从而增强视频的色彩丰富度和色彩还原度,使视频画面更加生动。你可以调用
+
+
+
+
+
摄像头采集的视频图像可能存在色彩失真。色彩增强功能可智能调整视频的饱和度和对比度等特性,从而增强视频的色彩丰富度和色彩还原度,使视频画面更加生动。该方法与
摄像头采集的视频图像可能存在色彩失真。色彩增强功能可智能调整视频的饱和度和对比度等参数,从而提升视频的色彩丰富度和还原度,使画面更加生动。该方法与
摄像头采集的视频图像可能存在色彩失真。色彩增强功能可智能调整视频的饱和度和对比度等特性,从而增强视频的色彩丰富度和色彩还原度,使视频画面更加生动。该方法与
+
+
+
+
大多数手机有两个音频路由:顶部的听筒和底部的扬声器。听筒音量较低,扬声器音量较高。你可以通过该方法设置在未连接外部音频设备时,默认使用听筒或扬声器播放音频。 +不同场景下系统的默认音频路由如下: +
大多数手机有两个音频路由:顶部的听筒和底部的扬声器。听筒音量较低,扬声器音量较高。你可以通过该方法设置在未连接外部音频设备时,音频是通过听筒还是扬声器播放。 +在不同场景下,系统的默认音频路由如下: +
大多数手机有两个音频路由:顶部的听筒和底部的扬声器。你可以通过调用该方法设置默认音频路由,在未连接外部音频设备时决定音频是通过听筒还是扬声器播放。 +在不同场景下,系统的默认音频路由如下: +
在加入频道前调用此方法。如果需要在加入频道后更改音频路由,请调用
该方法需要在加入频道前调用。
+请在加入频道前调用该方法。如果需要在加入频道后更改音频路由,请调用
+
+
+
+
+
+
设置音频或视频采集或播放设备的音量。
++
+
当你在
当你在
当你在
当你在
+
+
+
+
+
该方法仅影响通过摄像头、屏幕或自定义视频采集源采集的视频流。当你在
该方法仅影响通过摄像头、屏幕或自定义视频源采集的视频流。也就是说,当你在
该方法仅影响通过摄像头、屏幕或自定义视频源采集的视频流。也就是说,当你在
该方法仅影响通过摄像头、屏幕或自定义视频源采集的视频流。也就是说,当你在
+
+
+
+
+
SDK 默认在发送端开启视频小流的自适应模式(
你可以调用该方法设置发送端的视频流模式。
+SDK 默认在发送端启用视频小流自适应模式(
SDK 默认在发送端开启视频小流自适应模式(
SDK 默认在发送端开启视频小流自适应模式(
+
+
+
+
+
SDK 默认在发送端开启视频小流自适应模式(
SDK 默认在发送端开启视频小流自适应模式(
SDK 默认在发送端开启视频小流的自适应模式(
SDK 默认在发送端开启视频小流的自适应模式(
+
+
0:方法调用成功。 +< 0:方法调用失败。
+0:方法调用成功。 +< 0:方法调用失败。
+
+
该方法用于设置
该方法用于设置
该方法用于设置
该方法用于设置
+
+
+
+
+
设置成功后,音效文件将从指定位置开始播放。
+设置成功后,本地音效文件会从指定位置开始播放。
+设置成功后,本地音效文件会从指定位置开始播放。
++
+
+
+
+
该方法需要在调用
在调用
该方法需要在调用
在调用
在调用
+
+
+
+
+
你可以调用该方法切换当前频道中的音频路由,以满足不同的音频播放需求。
+如果 SDK 的默认音频路由或
请在加入频道后调用该方法。
+请在加入频道后调用该方法。
+请在加入频道后调用该方法。
++
+
+
+
启用扩展组件后,可以调用该方法设置其属性。
+启用扩展后,可以调用该方法设置扩展的属性。
+启用扩展后,可以调用该方法设置扩展的属性。
+在调用
在调用
在调用
+
+
+
+
+
调用该方法可设置扩展提供方的属性,并根据提供方的类型初始化相关参数。
+你可以调用该方法根据扩展提供方的类型初始化相关参数。
+你可以调用此方法根据扩展提供方的类型初始化相关参数。
+你可以调用此方法根据扩展提供方的类型初始化相关参数。
+在调用
在调用
在调用
在调用
+
+
+
+
+
启用外部音频渲染后,你可以调用
启用外部音频渲染器后,你可以调用
启用外部音频渲染后,你可以调用
适用于需要使用外部音频数据进行播放的场景。
+该方法需要在加入频道前调用。
+请在加入频道前调用该方法。
+该方法需要在加入频道前调用。
++
+
在调用
在调用
在调用
+
+
+
+
请你在加入频道前调用该方法。
+在加入频道前调用该方法。
+请你在加入频道前调用该方法。
++
+
+
+
调用该方法后,你设置的外部
调用该方法成功后,设置的外部
如果你已申请到
在调用
在调用
+
+
+
该方法用于替换 SDK 默认的远端 EGL 上下文,便于你自行管理 EGL 上下文。当引擎销毁时,SDK 会自动释放该上下文。
+该方法适用于使用自定义渲染方式(如 Texture 格式)替代 SDK 默认渲染方式渲染远端视频帧的场景。
+请在加入频道前调用该方法。
++
+
调用该方法启用外部视频源后,可以调用
调用该方法后,可以调用
调用该方法启用外部视频源后,可以调用
该方法需要在加入频道前调用。
+请在加入频道前调用该方法。
+该方法需要在加入频道前调用。
++
+
如果通过
如果通过
如果通过
如果通过
在调用
在调用
在调用
在调用
+
+
+
+
+
如果通过
你可以调用该方法设置面部区域选项,单独微调面部的每个部分,从而实现更精细的美颜效果。
+如果通过
在调用
请在调用
在调用
+
+
+
+
调用该方法可以通过预设参数一次性调整多个面部部位,实现瘦脸、放大眼睛、瘦鼻等轻度美颜效果,并支持整体调节美型强度。
+该方法可通过预设参数一次性调整面部多个部位,实现瘦脸、放大眼睛、瘦鼻等轻度美型效果,并支持整体调节美型强度。该方法与
调用该方法可以通过预设参数一次性修改面部多个部位,实现瘦脸、放大眼睛、瘦鼻等轻度美型效果,并支持整体调整美型强度。该方法支持指定应用美颜特效的媒体源。
+调用该方法可以通过预设参数一次性修改面部多个部位,实现瘦脸、放大眼睛、瘦鼻等轻度美型效果,并支持整体调整美型强度。该方法支持指定应用美颜特效的媒体源。
+在调用
在调用
在调用
在调用
+
+
+
+
+
调用该方法可以调整面部的特定部位,实现瘦脸、放大眼睛和瘦鼻等美型效果。
+调用该方法可以调整面部的特定部位,实现瘦脸、放大眼睛和瘦鼻等美型效果。
+在调用
在调用
在调用
+
+
+
+
该方法允许你设置滤镜特效参数,并指定滤镜特效应用的媒体源。
+该方法与
该方法与
在调用
在调用
在调用
在调用
+
+
+
+
+
在调用
在调用
在调用
在调用
在调用
+
+
+
+
在空间音效场景中,如果调用
如果调用
如果你调用
如果你调用
+
+
+
+
+
该方法主要用于空间音效场景。你可以选择预设的耳机均衡器来聆听音频,以获得预期的音频体验。
+该方法主要用于空间音效场景中。你可以选择预设的耳机均衡器来聆听音频,以实现预期的音频体验。
+该方法主要用于空间音效场景。你可以选择预设的耳机均衡器来聆听音频,以实现预期的音频体验。
+该方法主要用于空间音效场景。你可以选择预设的耳机均衡器来聆听音频,以实现预期的音频体验。
++
+
+
+
+
该方法可以在加入频道前或加入频道后调用。
+该方法可以在加入频道前或加入频道后调用。
+该方法可以在加入频道前或加入频道后调用。
+该方法可以在加入频道前或加入频道后调用。
++
+
+
+
+
成功部署声网私有媒体服务器并在内网客户端集成 4.x RTC SDK 后,你可以调用该方法指定本地接入点,并将接入模块分配给 SDK。
+成功部署声网混合云解决方案并将 4.x RTC SDK 集成到内网客户端后,可以调用该方法指定本地接入点,并将接入模块分配给 SDK。
+成功部署声网私有媒体服务器并在内网客户端集成 4.x RTC SDK 后,你可以调用该方法指定本地接入点,并将接入模块分配给 SDK。
+成功部署声网私有媒体服务器并在内网客户端集成 4.x RTC SDK 后,你可以调用该方法指定本地接入点,并将接入模块分配给 SDK。
+该方法必须在加入频道前调用。
+必须在加入频道前调用该方法。
+你必须在加入频道前调用该方法。
+你必须在加入频道前调用该方法。
++
+
+
+
+
你可以在初始化本地视频画面后调用该方法,更新其渲染模式和镜像模式。该方法仅影响本地用户看到的视频画面,不影响发布的视频流。
+你可以调用该方法设置本地视频的显示模式。在通话过程中可以多次调用以动态调整显示模式。
+你可以在通话过程中多次调用该方法以更改本地视频的显示模式。
+你可以在通话过程中多次调用该方法以更改本地视频的显示模式。
++
+
+
+
+
你可以在初始化本地视频画面后调用该方法,更新其渲染模式和镜像模式。该方法仅影响本地用户看到的视频画面,不影响本地视频的发布。
+该方法仅影响本地用户看到的视频画面,不影响本地视频的发布。
+你可以在初始化本地视频视图后调用该方法,更新其渲染模式和镜像模式。该方法仅影响你本地看到的视频视图,不影响本地视频的发布。
+你可以在初始化本地视频视图后调用该方法,更新其渲染模式和镜像模式。该方法仅影响你本地看到的视频视图,不影响本地视频的发布。
++
确保在调用此方法前已调用
调用时序: +
调用时序: +
+
+
+
+
+
你可以在对视频渲染帧率要求不高的场景中调用该方法,例如屏幕共享或在线教育。SDK 会尝试将本地渲染的实际帧率保持在该值附近,从而降低 CPU 消耗并提升系统性能。
+在对视频渲染帧率要求不高的场景(如屏幕共享或在线教育)中,可以调用该方法设置本地视频渲染的最大帧率。SDK 会尝试将本地渲染的实际帧率保持在该值附近,从而降低 CPU 消耗并提升系统性能。
+在对视频渲染帧率要求不高的场景(如屏幕共享或在线教育)中,可以调用该方法设置本地视频渲染的最大帧率。SDK 会尝试将本地渲染的实际帧率保持在该值附近,从而降低 CPU 消耗并提升系统性能。
+在对视频渲染帧率要求不高的场景(如屏幕共享或在线教育)中,你可以调用该方法设置本地视频渲染的最大帧率。SDK 会尝试将本地渲染的实际帧率保持在该值附近,以降低 CPU 消耗并提升系统性能。
+你可以在加入频道前或加入频道后调用该方法。
+你可以在加入频道前或后调用该方法。
+你可以在加入频道前或后调用该方法。
+你可以在加入频道前或后调用该方法。
++
+
+
+
+
+
+
+
+
+
该方法可以在加入频道前或加入频道后调用。
+该方法可在加入频道前或加入频道后调用。
+该方法可以在加入频道前或加入频道后调用。
+该方法可以在加入频道前或加入频道后调用。
++
+
+
+
+
共振峰比例会影响声音的音色。值越小,声音越低沉;值越大,声音越尖锐。如果你希望同时改变音色和音调,建议同时使用
共振峰比例会影响声音的音色。值越小,声音越低沉;值越大,声音越尖锐。如果你希望同时改变音色和音调,建议同时使用
共振峰比例会影响声音的音色。值越小,声音越低沉;值越大,声音越尖锐。设置共振峰比例后,频道内所有用户都能听到改变后的声音。如果你希望同时改变音色和音调,声网建议同时使用
共振峰比例会影响声音的音色。值越小,声音越低沉;值越大,声音越尖锐。设置共振峰比例后,频道内所有用户都能听到改变后的声音。如果你希望同时改变音色和音调,声网建议同时使用
你可以调用该方法设置本地音频的共振峰比例,以改变人声音色。
+该方法可以在加入频道前或加入频道后调用。
+该方法可以在加入频道前或加入频道后调用。
+该方法可以在加入频道前或加入频道后调用。
+该方法可以在加入频道前或加入频道后调用。
++
+
+
+
+
你可以在加入频道前或加入频道后调用该方法。
+你可以在加入频道前或加入频道后调用该方法。
+该方法可以在加入频道前或加入频道后调用。
+该方法可以在加入频道前或加入频道后调用。
++
+
+
+
+
你也可以使用更易用的方法
你可以使用更易用的方法
你可以在加入频道前或加入频道后调用该方法。SDK 提供了更易用的方法
你可以在加入频道前或加入频道后调用该方法。SDK 提供了更易用的方法
你可以在加入频道前或加入频道后调用该方法。
++
+
+
+
+
用于指定 SDK 输出日志的文件路径,日志文件记录 SDK 运行过程中的所有日志数据。你需要在调用
该方法需在调用
指定一个 SDK 输出日志文件。该日志文件记录 SDK 运行过程中的所有日志数据。
+指定一个 SDK 输出日志文件。该日志文件记录 SDK 运行过程中的所有日志数据。
+该方法需要在调用
该方法需在调用
该方法需在调用
该方法需在调用
+
+
+
+
+
默认情况下,SDK 会生成五个 SDK 日志文件和五个 API 调用日志文件,规则如下: +
默认情况下,SDK 会生成五个 SDK 日志文件和五个 API 调用日志文件,规则如下: +
默认情况下,SDK 会生成五个 SDK 日志文件和五个 API 调用日志文件,规则如下: +
默认情况下,SDK 会生成五个 SDK 日志文件和五个 API 调用日志文件,规则如下: +
+
+
+
+
+
你可以使用一个或多个日志过滤等级的组合来设置 SDK 的日志输出等级。日志等级的顺序为
你可以使用一个或多个日志过滤等级的组合。日志等级的顺序为
你可以使用该方法设置 SDK 的日志输出等级。日志等级按以下顺序排列:
你可以使用该方法设置 SDK 的日志输出等级。日志等级按以下顺序排列:
+
+
+
+
+
选择一个日志等级,以查看该等级及以上的日志信息。
+选择一个日志等级,以查看该等级及更高级别的日志信息。
+你可以选择一个日志等级,以查看该等级及更高级别的日志信息。详见
你可以选择一个日志等级,以查看该等级及更高级别的日志信息。详见
+
+
+
+
+
你可以调用该方法启用暗光增强功能,并设置增强效果的参数。
+你可以调用此方法开启暗光增强功能并设置暗光增强效果的选项。
+你可以调用此方法开启暗光增强功能并设置暗光增强效果的选项。
+暗光增强功能可自适应调整在背光、多云或黑暗等低光或光线不均的场景中采集的视频亮度值,恢复或突出图像细节,提升视频整体视觉效果。
+请在调用
请在调用
在调用
在调用
+
+
+
+
+
该方法与
该方法用于设置低光增强选项,并允许你指定应用低光增强的媒体源类型。
+该方法与
在黑暗环境中或使用低端视频采集设备时,视频图像可能会出现明显噪点,影响视频质量。在实时互动场景中,视频噪点还会占用码流资源,降低编码效率。
+请在调用
请在调用
请在调用
+
+
+
+
你需要在该方法中实现
你需要在该方法中实现
+
+
+
SDK 会根据该方法中设置的
SDK 会根据你设置的
SDK 会根据你设置的
请在加入频道前调用该方法。
+请在加入频道前调用该方法。
+请在加入频道前调用该方法。
+请在加入频道前调用该方法。
++
+
+
+
+
请[联系技术支持](https://ticket.shengwang.cn/)以获取 JSON 配置方法。
++
+
+
+
+
SDK 会根据采样间隔触发
SDK 会根据采样间隔触发
你可以在加入频道前调用该方法,设置混音前原始音频播放数据的采样率和声道数。SDK 会根据采样间隔触发
你可以在加入频道前调用该方法,设置混音前原始音频播放数据的采样率和声道数。SDK 会根据采样间隔触发
请在加入频道前调用此方法。
+请在加入频道前调用此方法。
+在加入频道前调用该方法。
+在加入频道前调用该方法。
++
+
+
+
+
设置
用于设置
用于设置
请在加入频道前调用此方法。
++
+
+
+
+
SDK 会根据该方法中设置的
SDK 会根据
SDK 会根据你设置的
SDK 会根据你设置的
请在加入频道前调用该方法。
+请在加入频道前调用该方法。
+请在加入频道前调用该方法。
+请在加入频道前调用该方法。
++
+
+
+
+
SDK 会根据
SDK 会根据你设置的
SDK 会根据你设置的
请在加入频道前调用该方法。
+请在加入频道前调用该方法。
+请在加入频道前调用该方法。
+请在加入频道前调用该方法。
++
+
+
+
+
根据发送端的默认行为,以及调用
根据发送端的默认行为以及调用
根据发送端的默认行为以及调用
根据发送端的默认行为以及调用
请在加入频道前调用此方法。
+请在加入频道前调用该方法。SDK 不支持在加入频道后更改默认订阅的视频流类型。
+该方法需要在加入频道前调用。SDK 不支持在加入频道后更改默认订阅的视频流类型。
+该方法需要在加入频道前调用。SDK 不支持在加入频道后更改默认订阅的视频流类型。
++
+
+
+
+
根据发送端的默认行为以及调用
请在加入频道前调用该方法。SDK 不支持在加入频道后更改默认订阅的视频流类型。
++
+
你可以在初始化远端用户视频视图后调用此方法,更新其渲染模式和镜像模式。该方法仅影响本地用户看到的远端视频视图。
+你可以调用该方法更新远端用户视频视图的渲染模式和镜像模式。该方法仅影响本地用户看到的视频视图。
+初始化远端用户的视频视图后,你可以调用该方法更新其渲染模式和镜像模式。该方法仅影响本地用户看到的视频视图。
+初始化远端用户的视频视图后,你可以调用该方法更新其渲染模式和镜像模式。该方法仅影响本地用户看到的视频视图。
++
+
+
+
+
在对视频渲染帧率要求不高的场景(如屏幕共享、在线教育)或远端用户使用中低端设备时,可以调用该方法设置远端客户端的视频渲染最大帧率。SDK 会尽可能将实际渲染帧率控制在该值附近,从而降低 CPU 消耗并提升系统性能。
+在视频渲染帧率要求不高的场景(例如屏幕共享、在线教育)或远端用户使用中低端设备的情况下,你可以调用该方法设置远端客户端的视频渲染最大帧率。SDK 会尽可能将实际渲染帧率控制在该值附近,从而降低 CPU 消耗并提升系统性能。
+在视频渲染帧率要求不高的场景(例如屏幕共享、在线教育)或远端用户使用中低端设备的情况下,你可以调用该方法设置远端客户端的视频渲染最大帧率。SDK 会尽可能将实际渲染帧率控制在该值附近,从而降低 CPU 消耗并提升系统性能。
+在视频渲染帧率要求不高的场景(例如屏幕共享、在线教育)或远端用户使用中低端设备的情况下,你可以调用该方法设置远端客户端的视频渲染最大帧率。SDK 会尽可能将实际渲染帧率控制在该值附近,从而降低 CPU 消耗并提升系统性能。
+你可以在加入频道前或加入频道后调用该方法。
+你可以在加入频道前或加入频道后调用该方法。
+你可以在加入频道前或加入频道后调用该方法。
+你可以在加入频道前或加入频道后调用该方法。
++
+
+
+
+
不稳定的网络会影响视频通话或互动直播中的音视频质量。你可以通过设置
如果将
不稳定的网络会影响视频通话或互动直播中的音视频质量。如果你将
不稳定的网络会影响视频通话或互动直播中的音视频质量。如果你将
+
+
+
+
+
不稳定的网络会影响视频通话或互动直播中的音视频质量。当下行网络无法同时支持音视频时,若将
+
+
调用
在调用
调用
调用
+
+
+
+
+
根据发送端的默认行为以及调用
根据发送端的默认行为以及调用
根据发送端的默认行为以及调用
根据发送端的默认行为以及调用
你可以在加入频道前或加入频道后调用该方法
++
+
+
+
+
根据发送端的默认行为以及调用
+
+
当远端用户开启双流模式时,你可以调用该方法设置订阅该远端用户发送的视频流的选项。SDK 默认的远端视频流订阅行为取决于注册的视频观察器类型: +
你可以调用该方法设置订阅远端用户发送的视频流的选项,适用于远端用户开启双流模式的场景。SDK 默认的远端视频流订阅行为取决于注册的视频观察器类型: +
当远端用户开启双流模式时,你可以调用此方法设置订阅该远端用户发送的视频流的选项。SDK 默认的远端视频流订阅行为取决于注册的视频观察者类型: +
当远端用户开启双流模式时,你可以调用此方法设置订阅该远端用户发送的视频流的选项。SDK 默认的远端视频流订阅行为取决于注册的视频观察者类型: +
+
+
+
+
+
该方法设置远端用户的二维位置和音量,帮助你更清晰地听到并识别远端用户的位置。通过左右声道的声音差异,你可以实时感知远端用户的方位,从而营造空间感。该方法适用于大型多人在线游戏,例如大逃杀类游戏。
+该方法通过左右声道的声音差异设置远端用户的语音位置和音量,使本地用户可以更容易地识别远端用户的位置,从而营造空间感。该方法适用于大型多人在线游戏,例如大逃杀类游戏。
+该方法设置远端用户的二维位置和音量,使你可以更容易地听到并识别远端用户的位置。通过左右声道的声音差异,你可以实时追踪远端用户的位置,从而营造空间感。该方法适用于大型多人在线游戏,例如大逃杀类游戏。
+该方法设置远端用户的二维位置和音量,使你可以更容易地听到并识别远端用户的位置。通过左右声道的声音差异,你可以实时追踪远端用户的位置,从而营造空间感。该方法适用于大型多人在线游戏,例如大逃杀类游戏。
++
+
+
+
+
该方法用于将音频路由从蓝牙耳机切换为听筒、有线耳机或扬声器。
+该方法可以在加入频道前或加入频道后调用。
+该方法可以在加入频道前或加入频道后调用。
++
+
+
该方法用于设置屏幕共享的内容类型提示,以便 SDK 针对不同类型的内容应用相应的优化算法。如果你未调用该方法,默认内容提示为
+
+
调用该方法设置屏幕共享场景,SDK 会根据场景自动优化共享的视频质量和用户体验。
+SDK 会根据设置的场景自动调整共享的视频质量和用户体验。
+调用该方法设置屏幕共享场景。SDK 会根据设置的场景优化共享的视频质量和用户体验。
+调用该方法设置屏幕共享场景。SDK 会根据设置的场景优化共享的视频质量和用户体验。
++
+
+
+
+
你可以调用此方法来指定希望订阅的用户的音频流。
+你可以调用此方法来指定希望订阅的用户的音频流。
++
+
+
+
+
你可以调用此方法来指定不希望订阅的用户的音频流。
+你可以调用此方法来指定不希望订阅的用户的音频流。
++
+
+
+
+
你可以调用该方法来指定你想要订阅的用户的视频流。
+你可以调用该方法来指定你想要订阅的用户的视频流。
++
+
+
+
+
你可以调用此方法来指定不希望订阅的用户的视频流。
+你可以调用此方法来指定不希望订阅的用户的视频流。
++
+
+
+
+
该方法在本地设备上初始化本地视频流的画面视图,仅影响本地用户看到的视频画面,不影响本地视频的发布。你可以调用该方法将本地视频流绑定到指定的视频视图(
你可以调用该方法将本地视频流绑定到视频画面(
该方法在本地设备上初始化本地视频流的画面,仅影响你本地看到的视频内容,不影响本地视频的发布。你可以调用该方法将本地视频流绑定到指定的视频画面(
该方法在本地设备上初始化本地视频流的画面,仅影响你本地看到的视频内容,不影响本地视频的发布。你可以调用该方法将本地视频流绑定到指定的视频画面(
初始化后调用该方法设置本地视频,然后加入频道。在实时互动场景中,如需在本地预览中同时查看多个不同观察位置的画面,可多次调用该方法设置不同的
你可以在加入频道前或后调用该方法。
+你可以在加入频道前或后调用该方法。
+你可以在加入频道前或后调用该方法。
+你可以在加入频道前或后调用该方法。
++
+
+
+
+
该方法在本地设备上初始化远端视频流的视频视图,仅影响本地用户所见的视频画面。你可以通过该方法将远端视频流绑定到指定视图,并设置该视图的渲染模式和镜像模式。你需要在调用该方法时指定远端用户的 ID。如果应用尚未获取远端用户的 ID,请在收到
该方法在本地设备上初始化远端视频流的视图,仅影响本地用户看到的视频画面。调用该方法可将远端视频流绑定到视频视图,并设置该视图的渲染模式和镜像模式。你需要在该方法中指定远端用户的 ID。如果应用尚未获取远端用户的 ID,请在收到
该方法在本地设备上初始化远端视频流的视频视图,仅影响你本地看到的视频画面。调用该方法可以将远端视频流绑定到指定视图,并设置该视图的渲染模式和镜像模式。你需要在该方法中指定远端用户 ID。如果你尚未获取远端用户 ID,请在收到
该方法在本地设备上初始化远端视频流的视频视图,仅影响你本地看到的视频画面。调用该方法可以将远端视频流绑定到指定视图,并设置该视图的渲染模式和镜像模式。你需要在该方法中指定远端用户 ID。如果你尚未获取远端用户 ID,请在收到
+
+
+
+
+
你可以调用该方法设置视频降噪效果的相关选项。
+你可以调用该方法开启视频降噪功能,并设置视频降噪效果的选项。
+你可以调用该方法开启视频降噪功能,并设置视频降噪效果的选项。
+在光线较暗的环境中或使用低端视频采集设备时,视频图像可能会出现明显噪点,影响视频质量。在实时互动场景中,视频噪点还会占用码流资源,降低编码效率。该方法适用于多频道场景。
+调用
调用
请在调用
请在调用
+
+
+
+
+
你可以调用此方法启用视频降噪功能并设置视频降噪效果的选项。此方法与
你可以调用此方法启用视频降噪功能并设置视频降噪效果的选项。该方法与
你可以调用此方法启用视频降噪功能并设置视频降噪效果的选项。此方法与
在光线较暗的环境中或使用低端视频采集设备时,视频图像可能会出现明显噪点,影响视频质量。在实时互动场景中,视频噪点还会占用码流资源,降低编码效率。
+请在调用
请在调用
请在调用
+
+
+
+
设置本地视频的编码配置。每个配置文件对应一组视频参数,包括分辨率、帧率和码率。
+设置本地视频的编码配置。每个配置文件对应一组视频参数,包括分辨率、帧率和码率。
+你可以在加入频道前或后调用该方法。如果在加入频道后不需要重新设置视频编码属性,声网建议在调用
你可以在加入频道前或加入频道后调用此方法。如果用户在加入频道后不需要重新设置视频编码属性,声网建议在调用
你可以在加入频道前或后调用此方法。如果你在加入频道后不需要重新设置视频编码属性,声网建议你在调用
你可以在加入频道前或后调用此方法。如果你在加入频道后不需要重新设置视频编码属性,声网建议你在调用
+
+
+
+
+
+
+
+
成功调用该方法后,SDK 会根据指定的视频应用场景自动启用最佳实践策略,并调整关键性能指标,以优化视频体验。
+调用该方法后,SDK 会根据指定的视频应用场景自动启用最佳实践策略,并调整关键性能指标,以优化视频体验。
+调用该方法后,SDK 会根据指定的视频应用场景自动启用最佳实践策略,并调整关键性能指标,以优化视频体验。
++
+
+
+
+
调用该方法为本地发送音频流的用户设置歌唱美声特效的性别特征和混响效果。设置后,频道内所有用户都能听到该效果。 +为了获得更好的人声效果,建议在调用该方法前先调用以下 API: +
为了获得更好的人声效果,建议在调用该方法前先调用以下 API: +
调用该方法为美声特效设置性别特征和混响效果。该方法为发送音频流的本地用户设置参数。设置完成后,频道内所有用户都能听到该效果。为了获得更好的人声效果,建议在调用本方法前调用以下 API: +
调用该方法为美声特效设置性别特征和混响效果。该方法为发送音频流的本地用户设置参数。设置完成后,频道内所有用户都能听到该效果。为了获得更好的人声效果,建议在调用本方法前调用以下 API: +
你可以在加入频道前或加入频道后调用该方法。
++
+
+
+
+
调用该方法为发送音频流的本地用户设置预设的美声特效。你可以根据不同场景选择不同的美声特效。设置后,频道内所有用户都能听到该特效。
+你可以根据不同场景设置不同的美声效果。 +为获得更好的人声效果,建议在调用该方法前调用以下 API: +
调用该方法为发送音频流的本地用户设置预设的美声特效。设置后,频道内所有用户都能听到该特效。你可以根据不同场景设置不同的美声特效。
+调用该方法为发送音频流的本地用户设置预设的美声特效。设置后,频道内所有用户都能听到该特效。你可以根据不同场景设置不同的美声特效。
+该方法可以在加入频道前或加入频道后调用。
+该方法可在加入频道前或加入频道后调用。
+该方法可以在加入频道前或加入频道后调用。
+该方法可以在加入频道前或加入频道后调用。
++
+
+
+
+
调用该方法为发布音频流的本地用户设置预设的变声效果。设置后,频道内所有用户都能听到该变声效果。你可以根据不同场景为用户设置不同的变声效果。 +为了获得更好的语音效果,建议在调用该方法前调用以下方法: +
你可以调用该方法为发布音频流的本地用户设置预设的变声效果。设置后,频道内所有用户都能听到该变声效果。你可以根据不同场景为用户设置不同的变声效果。 +为了获得更好的音效效果,建议在调用该方法前调用以下 API: +
调用该方法为在频道中发布音频流的本地用户设置预设的变声效果。设置后,频道内所有用户都能听到该变声效果。你可以根据不同的场景为用户设置不同的变声效果。
+调用该方法为在频道中发布音频流的本地用户设置预设的变声效果。设置后,频道内所有用户都能听到该变声效果。你可以根据不同的场景为用户设置不同的变声效果。
+该方法可在加入频道前或加入频道后调用。
+该方法可在加入频道前或加入频道后调用。
+该方法可以在加入频道前或加入频道后调用。为获得更好的音效,建议在调用该方法前先调用以下方法: +
该方法可以在加入频道前或加入频道后调用。为获得更好的音效,建议在调用该方法前先调用以下方法: +
+
+
+
+
+
在调用
调用
调用
在调用
在调用
在调用
在调用
+
+
+
+
+
该方法用于测试本地音频采集设备和播放设备是否正常工作。调用该方法后,音频采集设备会采集本地音频,音频播放设备会播放采集到的音频。
++
+
如果本地音乐文件不存在、SDK 不支持该文件格式,或无法访问音乐文件的 URL,SDK 会返回
该方法支持播放以
关于该方法支持的音频文件格式,详见[声网 RTC SDK 支持哪些音频文件格式](https://doc.shengwang.cn/faq/general-product-inquiry/audio-format)。如果本地音乐文件不存在、SDK 不支持该文件格式,或 SDK 无法访问音乐文件的 URL,SDK 会返回
关于该方法支持的音频文件格式,详见[声网 RTC SDK 支持哪些音频文件格式](https://doc.shengwang.cn/faq/general-product-inquiry/audio-format)。如果本地音乐文件不存在、SDK 不支持该文件格式,或 SDK 无法访问音乐文件的 URL,SDK 会返回
你可以在加入频道前或后调用该方法。
+你可以在加入频道前或后调用该方法。
+你可以在加入频道前或加入频道后调用该方法。
+你可以在加入频道前或加入频道后调用该方法。
++
+
+
+
+
如果本地音乐文件不存在、SDK 不支持该文件格式,或无法访问音乐文件的 URL,SDK 会返回
该方法支持播放以
关于该方法支持的音频文件格式,详见[声网 RTC SDK 支持哪些音频文件格式](https://doc.shengwang.cn/faq/general-product-inquiry/audio-format)。如果本地音乐文件不存在、SDK 不支持该文件格式,或无法访问音乐文件的 URL,SDK 会返回
关于该方法支持的音频文件格式,详见[声网 RTC SDK 支持哪些音频文件格式](https://doc.shengwang.cn/faq/general-product-inquiry/audio-format)。如果本地音乐文件不存在、SDK 不支持该文件格式,或无法访问音乐文件的 URL,SDK 会返回
你可以在加入频道前或加入频道后调用该方法。
+你可以在加入频道前或加入频道后调用该方法。
+你可以在加入频道前或加入频道后调用该方法。
+你可以在加入频道前或加入频道后调用该方法。
++
+
+
+
+
调用该方法后,你可以在通话过程中录制频道中所有用户的音频,并生成包含所有声音的录音文件。录音文件仅支持以下格式: +
你必须在调用
你可以在通话过程中调用该方法进行客户端录音。该方法会录制频道中所有用户的音频,并生成包含所有用户声音的录音文件。录音文件仅支持以下格式: +
你可以在通话过程中调用该方法进行客户端录音。该方法会录制频道中所有用户的音频,并生成包含所有用户声音的录音文件。录音文件仅支持以下格式: +
+
+
+
+
+
调用该方法后,你可以在通话过程中在客户端录制频道中所有用户的音频,并生成包含所有声音的录音文件。录音文件仅支持以下格式: +
+
+
调用
调用该方法后,你可以录制频道中用户的音频并获取录音文件。录音文件仅支持以下格式: +
调用该方法后,你可以录制频道中用户的音频并生成录音文件。录音文件仅支持以下格式: +
调用该方法后,你可以录制频道中用户的音频并生成录音文件。录音文件仅支持以下格式: +
该方法必须在加入频道后调用。
+你必须在加入频道后调用该方法。
+该方法必须在加入频道后调用。
+该方法必须在加入频道后调用。
++
+
+
+
+
你可以调用该方法并指定
你可以调用该方法,并通过指定
你可以调用此方法并指定
你可以调用此方法并指定
+
+
+
+
+
声网不支持将媒体流重复推送到同一个 URL。
+声网不支持同时将
声网不支持同时将
声网不支持将媒体流重复推送到同一个 URL。
+声网不支持同时将
声网不支持将媒体流重复推送到同一个 URL。
+声网不支持同时将
+
+
+
+
+
你可以调用该方法进行音视频通话回路测试,用于检测本地音视频设备以及上下行网络是否正常。开始测试后,你需要发出声音或面对摄像头,音频或视频将在约两秒后回放。 +
你可以调用该方法执行一次音视频通话回路测试,用于检测音视频设备以及用户上下行网络是否正常工作。开始测试后,用户需要发出声音或面对摄像头,音频或视频将在约两秒后输出。
+你可以调用该方法执行音视频通话回路测试,以测试你本地的发送和接收流是否正常。该测试会验证音视频设备以及上下行网络是否正常工作。开始测试后,你需要发出声音或面对摄像头,音频或视频将在约两秒后输出。如果音频播放正常,说明音频设备和上下行网络正常;如果视频播放正常,说明视频设备和上下行网络正常。
+你可以调用该方法执行音视频通话回路测试,以测试你本地的发送和接收流是否正常。该测试会验证音视频设备以及上下行网络是否正常工作。开始测试后,你需要发出声音或面对摄像头,音频或视频将在约两秒后输出。如果音频播放正常,说明音频设备和上下行网络正常;如果视频播放正常,说明视频设备和上下行网络正常。
+你可以在加入频道前或加入频道后调用该方法。
+你可以在加入频道前或加入频道后调用此方法。
+你可以在加入频道前或加入频道后调用该方法。
+你可以在加入频道前或加入频道后调用该方法。
++
+
+
+
+
调用时序:在收到
该方法在加入频道前启动 Last-mile 网络探测测试,用于获取上行和下行的网络统计信息,包括带宽、丢包率、抖动和往返时延(RTT)。
+该方法在加入频道前启动 Last mile 网络探测测试,以获取上行和下行 Last mile 网络的统计数据,包括带宽、丢包率、抖动和往返时延(RTT)。
+该方法在加入频道前启动 Last mile 网络探测测试,以获取上行和下行 Last mile 网络的统计数据,包括带宽、丢包率、抖动和往返时延(RTT)。
++
+
+
+
+
该方法支持将多个音频流在本地合并为一个音频流,例如将本地麦克风采集的音频流、媒体播放器的音频流、声卡的音频流以及远端用户的音频流合并为一个音频流,并将该合并后的音频流发布到频道中。 +
该方法支持在本地将多个音频流合并为一个音频流。例如,可以将本地麦克风采集的音频流、媒体播放器、声卡以及远端用户的音频流混合为一个音频流,并将其发布到频道中。 +
该方法支持在本地将多个音频流合并为一个音频流。例如,将本地麦克风采集的音频流、媒体播放器、声卡和远端用户的音频流合并为一个音频流,并将该合并后的音频流发布到频道中。 +
该方法支持在本地将多个音频流合并为一个音频流。例如,将本地麦克风采集的音频流、媒体播放器、声卡和远端用户的音频流合并为一个音频流,并将该合并后的音频流发布到频道中。 +
你可以在以下场景中启用该功能: +
你可以在加入频道前或加入频道后调用该方法。
+你可以在加入频道前或加入频道后调用此方法。
+你可以在加入频道前或后调用此方法。
+你可以在加入频道前或后调用此方法。
++
+
+
+
+
你可以调用该方法在本地将多个视频流合并为一个视频流,例如摄像头采集的视频流、屏幕共享、媒体播放器、远端视频、视频文件、图片等,并将混流后的视频流发布到频道中。 +以下是实现人像画中画效果的典型用例: +
调用该方法后,你可以在本地将多个视频流合并为一个视频流,例如摄像头采集的视频流、屏幕共享、媒体播放器、远端视频、视频文件、图片等,然后将混合后的视频流发布到频道中。以下是实现人像画中画效果的典型用例: +
调用该方法后,你可以在本地将多个视频流合并为一个视频流。例如,你可以将摄像头采集的视频流、屏幕共享、媒体播放器、远端视频、视频文件、图片等视频流合并为一个视频流,并将该合图视频流发布到频道中。
+调用该方法后,你可以在本地将多个视频流合并为一个视频流。例如,你可以将摄像头采集的视频流、屏幕共享、媒体播放器、远端视频、视频文件、图片等视频流合并为一个视频流,并将该合图视频流发布到频道中。
+适用于远程会议、直播、在线教育等场景,便于用户查看和管理多个视频流,并支持人像画中画等功能。
++
+
如果需要合成本地采集的视频流,需要在调用
如果需要合成本地采集的视频流,需要在调用
+
+
0:方法调用成功。 +< 0:方法调用失败。
+0:方法调用成功。 +< 0:方法调用失败。
+
+
从成功调用该方法开始,SDK 会追踪频道中视频帧的渲染状态,并通过
从成功调用该方法开始,SDK 会追踪频道中视频帧的渲染状态,并通过
从成功调用该方法开始,SDK 会追踪频道中视频帧的渲染状态,并通过
从成功调用该方法开始,SDK 会追踪频道中视频帧的渲染状态,并通过
你可以结合应用中的 UI 设置(如按钮、滑块)调用该方法,以提升用户体验。例如,在用户点击“加入频道”按钮时调用该方法,然后通过
+
+
+
+
+
首次成功调用该方法会将媒体流从源频道转发到目标频道。若需将媒体流转发到其他频道,或停止转发到某个频道,可再次调用该方法更新目标频道。最多支持转发到六个目标频道。
+首次成功调用该方法会将媒体流从源频道转发到目标频道。若需将媒体流转发到其他频道,或退出当前的某个媒体流转发,可再次调用该方法以更新目标频道。该功能最多支持将媒体流转发到六个目标频道。
+首次成功调用该方法会开始将媒体流从源频道转发到目标频道。若需将媒体流转发到其他频道,或退出当前的某个媒体流转发,可再次调用该方法更新目标频道。该功能最多支持将媒体流转发到六个目标频道。
+调用该方法成功后,SDK 会触发
首次成功调用该方法会开始将媒体流从源频道转发到目标频道。若需将媒体流转发到其他频道,或退出当前的某个媒体流转发,可再次调用该方法更新目标频道。该功能最多支持将媒体流转发到六个目标频道。
+调用该方法成功后,SDK 会触发
+
+
+
+
+
该方法用于测试本地音频播放设备是否正常工作。调用该方法后,SDK 会播放你指定的音频文件。如果你能听到声音,说明播放设备工作正常。
+调用该方法后,SDK 会播放你指定的音频文件。如果你能听到音频,说明播放设备工作正常。调用该方法后,SDK 每 100 毫秒触发一次
该方法用于测试本地音频播放设备是否正常工作。调用该方法后,SDK 会播放你指定的音频文件。如果你能听到声音,说明播放设备工作正常。
++
+
+
+
你可以调用此方法启用本地视频预览。
+你可以调用此方法启用本地视频预览。
+此方法必须在调用
必须在调用
必须在调用
必须在调用
+
+
+
+
+
该方法用于启动本地视频预览,并指定出现在预览画面中的视频源。
+该方法用于启动本地视频预览,并指定出现在预览画面中的视频源。
+必须在调用
该方法必须在调用
必须在调用
必须在调用
+
+
+
+
+
该方法用于测试音频采集设备是否正常工作。调用该方法后,SDK 会按照设置的时间间隔触发
调用该方法后,SDK 会按照设置的时间间隔触发
该方法用于测试音频采集设备是否正常工作。调用该方法后,SDK 会按照设置的时间间隔触发
+
+
+
+
启用虚拟节拍器后,SDK 会从头开始播放指定的音效文件,并根据你在
启用虚拟节拍器后,SDK 会从头开始播放指定的音效文件,并根据你在
启用虚拟节拍器后,SDK 会从头开始播放你指定的音效文件,并根据
启用虚拟节拍器后,SDK 会从头开始播放你指定的音效文件,并根据
在音乐教育、体育教学等场景中,教师通常需要使用节拍器帮助学生按照正确的节奏进行练习。节拍由强拍和弱拍组成,每小节的第一个节拍称为强拍,其余为弱拍。
+该方法可以在加入频道前或加入频道后调用。
+该方法可以在加入频道前或后调用。
+该方法可以在加入频道前或加入频道后调用。
+该方法可以在加入频道前或加入频道后调用。
++
+
+
+
+
声网推荐你使用更加完善的服务端推流功能,详见[实现服务端旁路推流](https://doc.shengwang.cn/doc/media-push/restful/landing-page)。 +你可以调用该方法将音频或视频流推送到指定的 CDN 地址。该方法每次只能向一个 CDN 地址推送媒体流,如需推送到多个地址,请多次调用该方法。
+声网推荐你使用更加完善的服务端推流功能,详见[实现服务端旁路推流](https://doc.shengwang.cn/doc/media-push/restful/landing-page)。 +你可以调用该方法将音频或视频流推送到指定的 CDN 地址。该方法每次只能向一个 CDN 地址推送媒体流,如果需要推送到多个地址,请多次调用该方法。
+声网推荐你使用更加完善的服务端推流功能,详见[实现服务端旁路推流](https://doc.shengwang.cn/doc/media-push/restful/landing-page)。 +你可以调用该方法将音频或视频流推送到指定的 CDN 地址。该方法每次只能向一个 CDN 地址推流,如果需要推送到多个地址,请多次调用该方法。
+声网推荐你使用更加完善的服务端推流功能,详见[实现服务端旁路推流](https://doc.shengwang.cn/doc/media-push/restful/landing-page)。 +你可以调用该方法将音频或视频流推送到指定的 CDN 地址。该方法每次只能向一个 CDN 地址推流,如果需要推送到多个地址,请多次调用该方法。
++
+
+
+
+
声网推荐你使用更加完善的服务端推流功能,详见[实现服务端旁路推流](https://doc.shengwang.cn/doc/media-push/restful/landing-page)。 +你可以调用该方法将实时音视频流推送到指定的 CDN 地址,并设置转码配置。该方法每次只能将媒体流推送到一个 CDN 地址。如果你需要推送到多个地址,请多次调用该方法。在同一个声网项目下,默认最多支持 200 个并发的媒体流推送任务。如果你需要更高的配额,请[联系技术支持](https://ticket.shengwang.cn/)。
+声网推荐你使用更加完善的服务端推流功能,详见[实现服务端旁路推流](https://doc.shengwang.cn/doc/media-push/restful/landing-page)。 +你可以调用该方法将实时音视频流推送到指定的 CDN 地址,并设置转码配置。该方法每次只能将媒体流推送到一个 CDN 地址。如果需要推送到多个地址,请多次调用该方法。在一个声网项目下,默认最多可同时进行 200 个媒体流推送任务。如需更高配额,请[联系技术支持](https://ticket.shengwang.cn/)。
+声网推荐你使用更加完善的服务端推流功能,详见[实现服务端旁路推流](https://doc.shengwang.cn/doc/media-push/restful/landing-page)。 +你可以调用该方法将音视频流推送到指定的 CDN 地址,并设置转码配置。该方法每次只能推送到一个 CDN 地址,如需推送到多个地址,请多次调用该方法。在一个声网项目下,默认最多支持 200 个并发的旁路推流任务。如需更高配额,请[联系技术支持](https://ticket.shengwang.cn/)。
+声网推荐你使用更加完善的服务端推流功能,详见[实现服务端旁路推流](https://doc.shengwang.cn/doc/media-push/restful/landing-page)。 +你可以调用该方法将音视频流推送到指定的 CDN 地址,并设置转码配置。该方法每次只能推送到一个 CDN 地址,如需推送到多个地址,请多次调用该方法。在一个声网项目下,默认最多支持 200 个并发的旁路推流任务。如需更高配额,请[联系技术支持](https://ticket.shengwang.cn/)。
++
+
+
+
+
你可以在加入频道前或后调用该方法,具体如下: +
你可以在加入频道前或加入频道后调用该方法开始采集屏幕视频流,具体如下: +
你可以调用该方法开始采集屏幕视频流。
+你可以调用该方法开始采集屏幕视频流。
+在屏幕共享场景中。
+你可以在加入频道前或加入频道后调用此方法。
+你可以在加入频道前或加入频道后调用此方法,具体区别如下: +
你可以在加入频道前或加入频道后调用此方法,具体区别如下: +
+
+
+
+
+
该方法支持从指定的视频源开始屏幕采集,适用于多频道或本地合图等场景。声网 SDK 提供多种屏幕采集方法,请根据实际需求选择: +
适用于屏幕共享场景,支持多频道使用。
+你可以在加入频道前或后调用该方法,具体如下: +
+
+
+
采集整个屏幕或部分屏幕区域的视频流。
+在屏幕共享场景中,你需要调用此方法开始采集屏幕视频流。
+你可以在加入频道前或加入频道后调用该方法,具体区别如下: +
你可以在加入频道前或加入频道后调用此方法,具体区别如下: +
+
+
+
你可以通过该方法共享整个屏幕或部分屏幕,需要指定要共享的屏幕区域。你可以在加入频道前或加入频道后调用该方法: +
+
+
该方法支持通过指定窗口 ID 采集整个或部分窗口,支持 UWP(通用 Windows 平台)应用的窗口共享。
+
+声网使用最新 SDK 对主流 UWP 应用进行了测试,详情如下:
+
你需要指定要采集的窗口的 ID,可以采集整个窗口或窗口的部分区域。
+在屏幕共享场景中,你需要调用该方法开始采集屏幕视频流。
+你可以在加入频道前或加入频道后调用该方法,具体如下: +
你可以在加入频道前或加入频道后调用该方法,具体如下: +
+
+
+
该回调在设备状态发生变化时被触发。
+
+
调用该方法可以停止所有音效的播放。如果只需暂停播放,请调用
如果你只需要暂停播放,请调用
当你不再需要播放音效时,可以调用此方法停止播放所有音效。如果你只需要暂停播放,请调用
当你不再需要播放音效时,可以调用此方法停止播放所有音效。如果你只需要暂停播放,请调用
请在调用
在调用
请在调用
请在调用
+
+
+
+
+
+
+
调用
调用
调用
调用
请在加入频道后调用该方法。
+请在加入频道后调用此方法。
+请在加入频道后调用该方法。
+请在加入频道后调用该方法。
++
+
+
+
+
+
+
+
+
+
调用
你可以调用
调用
调用
+
+
+
+
+
调用该方法停止跨频道媒体流转发。一旦转发停止,主播会退出所有目标频道。
+调用该方法后,主播会退出所有目标频道。
+调用该方法停止跨频道媒体流转发。调用成功后,主播会退出所有目标频道。SDK 会触发
调用该方法停止跨频道媒体流转发。调用成功后,主播会退出所有目标频道。SDK 会触发
+
+
+
+
+
+
+
+
+
+
调用
调用
调用
调用
+
+
+
+
+
调用该方法可停止播放指定的音效。如果只需暂停播放,请调用
如果只需要暂停播放,请调用
当你不再需要播放某个音效时,可以调用该方法停止播放。如果你只需要暂停播放,请调用
当你不再需要播放某个音效时,可以调用该方法停止播放。如果你只需要暂停播放,请调用
请在调用
在调用
在调用
在调用
+
+
+
+
+
+
+
+
+
+
调用
调用
调用
调用
请在调用
请在调用
请在调用
请在调用
+
+
+
+
+
调用
调用
调用
调用
+
+
+
+
+
调用
你需要在调用
调用
+
+
+
+
调用
在调用
在加入频道前或离开频道后调用此方法。
+在加入频道前或离开频道后调用此方法。
++
+
+
+
+
调用
调用
在加入频道前或离开频道后调用该方法。
+在加入频道前或离开频道后调用此方法。
+在加入频道前或离开频道后调用该方法。
+在加入频道前或离开频道后调用该方法。
++
+
+
+
+
该方法用于停止音频采集设备测试。你必须在调用
你必须在调用
该方法用于停止音频采集设备测试。你必须在调用
+
+
+
+
调用
你可以调用该方法来禁用虚拟节拍器。
+调用
调用
+
+
+
+
+
声网推荐你使用更加完善的服务端推流功能,详见[实现服务端旁路推流](https://doc.shengwang.cn/doc/media-push/restful/landing-page)。 +你可以调用该方法停止向指定 CDN 地址的直播推流。该方法每次只能停止一个地址的推流,如需停止多个地址的推流,请多次调用该方法。
+声网推荐你使用更加完善的服务端推流功能,详见[实现服务端旁路推流](https://doc.shengwang.cn/doc/media-push/restful/landing-page)。 +你可以调用该方法停止向指定的 CDN 地址推送媒体流。该方法每次只能停止一个地址的推流,如需停止多个地址的推流,请多次调用该方法。
+声网推荐你使用更加完善的服务端推流功能,详见[实现服务端旁路推流](https://doc.shengwang.cn/doc/media-push/restful/landing-page)。 +你可以调用该方法停止向指定的 CDN 地址推送直播流。该方法每次只能停止向一个 CDN 地址推送媒体流。如果需要停止多个地址的推流,请多次调用该方法。
+声网推荐你使用更加完善的服务端推流功能,详见[实现服务端旁路推流](https://doc.shengwang.cn/doc/media-push/restful/landing-page)。 +你可以调用该方法停止向指定的 CDN 地址推送直播流。该方法每次只能停止向一个 CDN 地址推送媒体流。如果需要停止多个地址的推流,请多次调用该方法。
++
+
+
+
+
如果你通过调用
如果你通过调用
适用于以下场景: +
你可以在加入频道前或加入频道后调用该方法。
+你可以在加入频道前或后调用此方法。
+你可以在加入频道前或后调用此方法。
+你可以在加入频道前或后调用此方法。
++
+
+
+
+
如果你通过调用
调用
你可以在加入频道前或后调用此方法。
+你可以在加入频道前或后调用此方法。
++
+
+
你可以调用此方法在应用运行过程中根据实际可用的摄像头动态切换前后摄像头,无需重启视频流或重新配置视频源。
+你可以调用此方法,根据应用运行时实际可用的摄像头动态切换前后摄像头,无需重新启动视频流或重新配置视频源。
+你可以调用该方法在应用运行过程中根据实际可用的摄像头动态切换前置或后置摄像头,无需重启视频流或重新配置视频源。该方法与
必须在摄像头成功启用后调用,即 SDK 触发
必须在摄像头成功启用后调用,即 SDK 触发
必须在摄像头成功启用后调用,即 SDK 触发
+
+
+
+
你可以调用该方法在应用运行过程中根据实际可用的摄像头动态切换摄像头,无需重启视频流或重新配置视频源。该方法与
必须在摄像头成功启用后调用,即 SDK 触发
+
+
该方法用于从指定用户的视频流中截取一帧图像,生成 JPG 图片,并保存到指定路径。
+该方法从指定用户的视频流中截取快照,并将生成的 JPG 图像保存到指定路径。
+该方法从指定用户的视频流中截取快照,并将生成的 JPG 图像保存到指定路径。
+请在加入频道后调用该方法。
+请在加入频道后调用该方法。
+请在加入频道后调用该方法。
+请在加入频道后调用该方法。
++
+
+
+
+
该方法截取指定用户的视频流的快照,生成 JPG 图像,并将其保存到指定路径。
+该方法截取指定用户的视频流的快照,生成 JPG 图像,并将其保存到指定路径。
+在加入频道后调用该方法。
+请在加入频道后调用该方法。
+请在加入频道后调用该方法。
+请在加入频道后调用该方法。
++
+
+
+
+
+
+
调用
调用
调用
调用
你可以在加入频道前或加入频道后调用此方法。
+你可以在加入频道前或加入频道后调用此方法。
+你可以在加入频道前或后调用此方法。
+你可以在加入频道前或后调用此方法。
++
+
+
+
+
调用
调用
如果你已调用
如果你已调用
+
+
+
+
+
+
+
+
你可以在加入频道后调用该方法更新频道媒体选项。
+你可以在加入频道后调用该方法更新频道媒体选项。
++
+
+
+
+
调用
调用
调用
请在调用
请在调用
在调用
在调用
+
+
+
+
+
调用
调用
调用
调用
+
+
+
+
+
你需要自行维护通配 Token 的生命周期。当该 Token 过期时,需要生成新的通配 Token,并调用该方法传入新 Token。
+你需要自行维护通配 Token 的生命周期。当该 Token 过期时,需要生成新的通配 Token,并调用该方法传入新的 Token。
+你需要自行维护通配 Token 的生命周期。当该 Token 过期时,你需要生成一个新的通配 Token,并调用此方法传入新的 Token。
+你需要自行维护通配 Token 的生命周期。当该 Token 过期时,你需要生成一个新的通配 Token,并调用此方法传入新的 Token。
+适用于涉及多个频道的场景,例如在不同频道之间切换时,使用通配 Token 可以避免用户每次加入新频道时都申请新的 Token,从而节省切换频道的时间,并减轻你的 Token 服务器的压力。
++
+
+
+
+
声网推荐你使用更加完善的服务端推流功能,详见[实现服务端旁路推流](https://doc.shengwang.cn/doc/media-push/restful/landing-page)。
+开始使用转码功能将媒体流推送到 CDN 后,你可以根据实际场景动态更新转码配置。更新配置后,SDK 会触发
声网推荐你使用更加完善的服务端推流功能,详见[实现服务端旁路推流](https://doc.shengwang.cn/doc/media-push/restful/landing-page)。
+声网推荐你使用更加完善的服务端推流功能,详见[实现服务端旁路推流](https://doc.shengwang.cn/doc/media-push/restful/landing-page)。 +你可以在开启带转码的旁路推流后,根据场景动态更新转码配置。
+声网推荐你使用更加完善的服务端推流功能,详见[实现服务端旁路推流](https://doc.shengwang.cn/doc/media-push/restful/landing-page)。 +你可以在开启带转码的旁路推流后,根据场景动态更新转码配置。
++
+
+
+
+
如果在开启屏幕共享时未采集系统音频,之后希望更新参数并发布系统音频,可参考以下步骤: +
+
+
+
+
+
+
+
请在开始屏幕共享或窗口共享后调用此方法。
++
+
你可以通过该方法更新屏幕或窗口的采集区域。
++
+
当调用
+
该方法在直播中向本地视频添加 PNG 格式的水印图像。添加后,频道中的所有观众(包括 CDN 观众)和采集设备都可以看到并采集该图像。声网 SDK 每个直播视频流仅支持添加一张水印图像,新添加的图像会替换之前的图像。
+水印图像的位置依赖于
该方法在直播中向本地视频添加 PNG 格式的水印图像。添加水印图像后,频道中的所有观众(包括 CDN 观众)以及采集设备都可以看到并采集该图像。声网 SDK 仅支持在一个直播视频流中添加一张水印图像,新添加的水印图像会替换之前的图像。
+水印图像的坐标依赖于
该方法在直播中向本地视频添加 PNG 格式的水印图像。添加水印图像后,频道中的所有观众(包括 CDN 观众)以及采集设备都可以看到并采集该图像。声网 SDK 仅支持在一个直播视频流中添加一张水印图像,新添加的水印图像会替换之前的图像。
+水印图像的坐标依赖于
该方法在直播中向本地视频添加 PNG 格式的水印图像。添加水印图像后,频道中的所有观众(包括 CDN 观众)以及采集设备都可以看到并采集该图像。声网 SDK 仅支持在一个直播视频流中添加一张水印图像,新添加的水印图像会替换之前的图像。
+水印图像的坐标依赖于
该方法适用于多频道场景。
++
+
+
+
+
该方法适用于多频道场景。
++
+
+
+
+
你可以调用该方法调整指定远端用户的播放音量。若需调整多个远端用户的播放音量,请分别多次调用该方法,每次针对一个远端用户。
+你可以调用此方法调整指定远端用户的播放音量。若需调整多个远端用户的播放音量,请分别多次调用此方法,每次针对一个远端用户。
+你可以调用此方法调节指定远端用户的播放音量。若需调节多个远端用户的播放音量,请分别多次调用此方法,每次针对一个远端用户。
+你可以调用此方法调节指定远端用户的播放音量。若需调节多个远端用户的播放音量,请分别多次调用此方法,每次针对一个远端用户。
+该方法适用于多频道场景。
+请在调用
请在调用
请在调用
请在调用
+
+
+
+
+
该方法适用于多频道场景。
++
+
+
+
+
你可以调用此方法创建一个数据流,以提升数据传输的可靠性和顺序性。
+你可以调用此方法创建一个数据流,以提升数据传输的可靠性和顺序性。
+该方法适用于多频道场景。
+在调用
请在调用
请在调用
请在调用
+
+
+
+
+
与
该方法不保证数据传输的可靠性。如果数据包在发送后五秒内未被接收,SDK 会直接丢弃该数据。
+该方法不保证数据传输的可靠性。如果数据包在发送后五秒内未被接收,SDK 会直接丢弃该数据。
+该方法适用于多频道场景。
+在调用
请在调用
请在调用
请在调用
+
+
+
+
+
该方法用于启用 SDK 定期向应用上报本地发送音频流的用户和音量瞬时值最高的最多三位远端用户的音量信息。
+该方法使 SDK 能够定期向应用上报本地发送音频流的用户和音量瞬时值最高的最多三位远端用户的音量信息。
+该方法用于启用 SDK 定期向发送音频流的本地用户和音量瞬时值最高的最多三位远端用户的应用程序上报音量信息。
+该方法用于启用 SDK 定期向发送音频流的本地用户和音量瞬时值最高的最多三位远端用户的应用程序上报音量信息。
+该方法适用于多频道场景。
+请在调用
请在调用
请在调用
请在调用
+
+
+
+
+
该方法可对多个视频流进行截图并上传。启用该功能后,SDK 会根据你在
启用该功能后,SDK 会根据你在
该方法可对多个视频流进行截图并上传。启用该功能后,SDK 会根据你在
该方法可对多个视频流进行截图并上传。启用该功能后,SDK 会根据你在
该方法适用于多频道场景。
+该方法可在加入频道前或加入频道后调用。
+该方法可在加入频道前或后调用。
+该方法可在加入频道前或加入频道后调用。
+该方法可在加入频道前或加入频道后调用。
++
+
+
+
+
不同质量层级的视频流由一对视频大流和视频小流组成: +
你可以调用此方法在发送端启用或关闭双流模式。双流由一对视频大流和视频小流组成: +
你可以调用此方法在发布端启用或关闭不同质量层级的视频流。不同质量层级的视频流由一对视频大流和视频小流组成: +
你可以调用此方法在发布端启用或关闭不同质量层级的视频流。不同质量层级的视频流由一对视频大流和视频小流组成: +
该方法适用于多频道场景。
++
+
+
+
+
用户离开频道后,SDK 会自动关闭内置加密。若需启用内置加密,请在用户重新加入频道前调用该方法。
+用户离开频道后,SDK 会自动关闭内置加密。你需要在用户重新加入频道前调用该方法。
+你离开频道后,SDK 会自动关闭内置加密。若需启用内置加密,请在重新加入频道前调用该方法。
+你离开频道后,SDK 会自动关闭内置加密。若需启用内置加密,请在重新加入频道前调用该方法。
+适用于多频道场景,或对安全性要求较高的场景。
+请在加入频道前调用该方法。
+请在加入频道前调用该方法。
+该方法需要在加入频道前调用。
+该方法需要在加入频道前调用。
++
+
+
+
+
启用该功能后,声卡的输出会被混入发送到远端的音频流中。
+启用该方法后,声卡的输出会被混入发送到远端的音频流中。
+该方法适用于多频道场景。
++
+
+
当用户在客户端加入频道时,SDK 会生成一个用于标识该通话的
你可以调用该方法获取
当你在客户端加入频道时,SDK 会生成一个用于标识该通话的
当你在客户端加入频道时,SDK 会生成一个用于标识该通话的
该方法适用于多频道场景。
+请在加入频道后调用该方法。
+请在加入频道后调用此方法。
+在加入频道后调用此方法。
+在加入频道后调用此方法。
++
方法调用成功时,返回通话 ID。 +方法调用失败,返回空字符串。
++
+
+
该方法适用于多频道场景。
+该方法可以在加入频道前或加入频道后调用。
+该方法可以在加入频道前或后调用。
+该方法可以在加入频道前或后调用。
+该方法可以在加入频道前或后调用。
+当前的连接状态。详见
+
当前的连接状态。详见
当前的连接状态。详见
+
该方法通过传入用户 ID 获取用户信息。功能与
当远端用户加入频道后,SDK 会获取该远端用户的用户 ID 和用户 User Account,并将其缓存在映射表中,同时在本地客户端触发
远端用户加入频道后,SDK 会获取该远端用户的用户 ID 和用户 User Account,并将其缓存在映射表对象中,然后在本地客户端触发
远端用户加入频道后,SDK 会获取该远端用户的用户 ID 和用户 User Account,并将其缓存在映射表对象中,然后在本地客户端触发
适用于多频道场景。
++
+
方法调用成功,返回
方法调用成功,返回
+
该方法通过传入用户 User Account 获取用户信息,功能与
远端用户加入频道后,SDK 会获取该远端用户的用户 ID 和用户 User Account,并将其缓存在映射表中,同时在本地客户端触发
远端用户加入频道后,SDK 会获取该远端用户的用户 ID 和用户 User Account,并将其缓存在映射表对象中,然后在本地客户端触发
远端用户加入频道后,SDK 会获取该远端用户的用户 ID 和用户 User Account,并将其缓存在映射表对象中,然后在本地客户端触发
该方法适用于多频道场景。
++
+
方法调用成功,返回指定用户的
方法调用成功,返回指定用户的
+
你可以多次调用该方法加入多个频道。
+在多摄像头采集场景中,调用该方法后需要调用
你可以多次调用此方法加入多个频道。
+
+在多摄像头采集场景中,调用此方法后需要调用
在调用该方法之前,如果你尚未调用
在调用该方法之前,如果你尚未调用
该方法适用于多频道场景。
+请在调用
在调用
在调用
在调用
+
+
0:方法调用成功。 +< 0:方法调用失败。 +
0:方法调用成功。 +< 0:方法调用失败。 +
+
在调用该方法之前,如果你尚未调用
在调用此方法之前,如果你尚未调用
在调用该方法之前,如果你尚未调用
该方法适用于多频道场景。
+在调用
在调用
在调用
0:方法调用成功。 +< 0:方法调用失败。 +
+
0:方法调用成功。 +< 0:方法调用失败。 +
+
调用该方法后,SDK 会终止音视频互动,离开当前频道,并释放与会话相关的所有资源。调用
调用该方法后,SDK 会终止音视频互动,离开当前频道,并释放与会话相关的所有资源。调用
调用该方法后,SDK 会终止音视频互动,离开当前频道,并释放与会话相关的所有资源。调用
调用该方法后,SDK 会终止音视频互动,离开当前频道,并释放与会话相关的所有资源。调用
该方法适用于多频道场景。
+该方法需要在调用
在调用
在调用
在调用
+
+
+
+
+
调用该方法后,SDK 会终止音视频互动,离开当前频道,并释放与会话相关的所有资源。调用
调用该方法后,SDK 会终止音视频互动,并释放与会话相关的所有资源。调用
调用该方法后,SDK 会终止音视频互动,离开当前频道,并释放与会话相关的所有资源。调用
调用该方法后,SDK 会终止音视频互动,离开当前频道,并释放与会话相关的所有资源。调用
该方法适用于多频道场景。
+该方法需要在调用
在调用
请在调用
请在调用
+
+
0:方法调用成功。 +< 0:方法调用失败。
+0:方法调用成功。 +< 0:方法调用失败。
+
+
调用该方法后,本地用户会停止或恢复订阅所有远端用户的音频流,包括在调用该方法后加入频道的用户。
+调用该方法后,你将停止或恢复订阅所有远端用户的音频流,包括在调用该方法后加入频道的用户。
+调用该方法后,你将停止或恢复订阅所有远端用户的音频流,包括在调用该方法后加入频道的用户。
+该方法适用于多频道场景。
++
+
+
+
+
+
调用该方法后,本地用户将停止或恢复订阅所有远端用户的视频流,包括之后加入频道的用户。
+调用该方法后,你将停止或恢复订阅所有远端用户的视频流,包括之后加入频道的用户。
+调用该方法后,会停止或恢复订阅所有远端用户的视频流,包括之后加入频道的所有远端用户。
+调用该方法后,会停止或恢复订阅所有远端用户的视频流,包括之后加入频道的所有远端用户。
+该方法适用于多频道场景。
++
+
+
+
+
成功调用该方法后,远端客户端会收到
成功调用该方法后,远端会触发
成功调用该方法后,远端会触发
该方法适用于多频道场景。
++
+
+
+
+
该方法不会影响正在进行的视频录制,因为不会关闭摄像头。
+成功调用该方法后,远端客户端会触发
该方法适用于多频道场景。
++
+
+
+
+
你可以在加入频道前或加入频道后调用该方法。如果用户离开频道,该方法的设置将失效。
+你可以在加入频道前或加入频道后调用该方法。如果用户离开频道,方法的设置将失效。
+你可以在加入频道前或加入频道后调用该方法。如果用户离开频道,该方法中的设置将失效。
+你可以在加入频道前或加入频道后调用该方法。如果用户离开频道,该方法中的设置将失效。
+该方法适用于多频道场景。
++
+
+
+
+
你可以在加入频道前或加入频道后调用该方法。如果该用户离开频道,设置将失效。
+你可以在加入频道前或加入频道后调用该方法。如果远端用户离开频道,该方法中的设置将失效。
+你可以在加入频道前或加入频道后调用该方法。如果远端用户离开频道,该方法中的设置将失效。
+该方法适用于多频道场景。
+你可以在加入频道前或加入频道后调用该方法,用于停止或恢复接收指定远端用户的视频流。如果该用户离开频道,该设置将失效。
++
+
+
+
+
你可以在开始跨频道媒体流转发后调用该方法,暂停向所有目标频道转发媒体流。如需恢复转发,请调用
你可以调用该方法暂停向所有目标频道转发媒体流。如需恢复转发,请调用
你可以调用该方法暂停向所有目标频道转发媒体流。如需恢复转发,请调用
你可以调用该方法暂停向所有目标频道转发媒体流。如需恢复转发,请调用
该方法适用于多频道场景。
++
+
+
+
+
你可以调用该方法在频道内向所有用户播放指定音效。每次调用该方法只能播放一个音效。若需同时播放多个音效,请使用不同的
你可以调用该方法将指定音效播放给频道内的所有用户。每次调用该方法只能播放一个音效。若需同时播放多个音效,请使用不同的
该方法用于设置是否在频道中发布音效。若需同时播放多个音效文件,只需使用不同的
该方法用于设置是否在频道中发布音效。若需同时播放多个音效文件,只需使用不同的
该方法适用于多频道场景。
++
+
+
+
+
该方法用于设置是否在频道中发布音效。若需同时播放多个音效文件,只需使用不同的
调用
该方法用于设置是否在频道中发布音效。若需同时播放多个音效文件,只需使用不同的
该方法适用于多频道场景。
++
+
+
+
该方法用于设置是否在频道中发布音效。要同时播放多个音效文件,你只需使用不同的
该方法用于设置是否在频道中发布音效。要同时播放多个音效文件,你只需使用不同的
该方法适用于多频道场景。
++
+
+
你可以通过该方法设置是否在频道中发布音效。调用
你可以通过该方法设置是否在频道中发布音效。调用
该方法适用于多频道场景。
++
+
+
每次调用该方法只能将一个音效文件预加载到内存中。如果你需要预加载多个音效文件,请多次调用该方法。预加载完成后,你可以调用
每次调用该方法只能将一个音效文件预加载到内存中。如果需要预加载多个音效文件,请多次调用该方法。你可以调用
每次调用该方法时,只能将一个音效文件预加载到内存中。如果需要预加载多个音效文件,请多次调用该方法。预加载完成后,可以调用
每次调用该方法时,只能将一个音效文件预加载到内存中。如果需要预加载多个音效文件,请多次调用该方法。预加载完成后,可以调用
该方法适用于多频道场景。
++
+
+
+
+
每次调用该方法只能将一个音效文件预加载到内存中。如果你需要预加载多个音效文件,请多次调用该方法。预加载完成后,你可以调用
每次调用该方法时只能将一个音效文件预加载到内存中。如果需要预加载多个音效文件,请多次调用该方法。预加载完成后,你可以调用
每次调用该方法只能将一个音效文件预加载到内存中。如果你需要预加载多个音效文件,请多次调用该方法。预加载完成后,你可以调用
该方法适用于多频道场景。
++
+
+
+
该方法适用于多频道场景。
++
+
+
+
+
调用
调用
调用
该方法适用于多频道场景。
++
+
+
+
+
该功能目前处于测试阶段,提供免费试用。在测试版本中,最多支持在 6 秒内上报 10 条消息,每条消息不超过 256 字节,每个字符串不超过 100 字节。如需试用该功能,请联系销售并与我们讨论自定义消息的格式。
+该功能目前处于测试阶段,提供免费试用。在测试版本中,最多支持在 6 秒内上报 10 条消息,每条消息不超过 256 字节,每个字符串不超过 100 字节。如需试用该功能,请[联系技术支持](https://ticket.shengwang.cn/)并与我们讨论自定义消息的格式。
+该方法支持上报和分析自定义消息。目前该功能处于测试阶段,提供免费试用。在测试版本中,最多支持在 6 秒内上报 10 条消息,每条消息不超过 256 字节,每个字符串不超过 100 字节。如需试用该功能,请[联系技术支持](https://ticket.shengwang.cn/),并与我们讨论自定义消息的格式。
+该方法支持上报和分析自定义消息。目前该功能处于测试阶段,提供免费试用。在测试版本中,最多支持在 6 秒内上报 10 条消息,每条消息不超过 256 字节,每个字符串不超过 100 字节。如需试用该功能,请[联系技术支持](https://ticket.shengwang.cn/),并与我们讨论自定义消息的格式。
+该方法适用于多频道场景。
++
+
+
+
+
调用
调用
该方法适用于多频道场景。
++
+
+
SDK 默认在发送端开启视频小流自适应模式(
SDK 默认在发送端开启视频小流自适应模式(
SDK 默认在发送端开启视频小流的自适应模式(
SDK 默认在发送端开启视频小流的自适应模式(
该方法适用于多频道场景。
++
+
+
+
+
调用
请在调用
你可以调用该方法更新远端用户的视频渲染模式和镜像模式。该方法仅影响你本地看到的远端用户视频视图。
+你可以调用该方法更新远端用户的视频渲染模式和镜像模式。该方法仅影响你本地看到的远端用户视频视图。
+该方法适用于多频道场景。
++
+
+
+
+
根据发送端的默认行为以及调用
根据发送端的默认行为以及调用
根据发送端的默认行为以及调用
根据发送端的默认行为以及调用
该方法适用于多频道场景。
++
+
+
+
+
根据发送端的默认行为以及调用
该方法适用于多频道场景。
++
+
当远端用户开启双流模式时,可以调用该方法设置是否订阅该远端用户的视频流及其具体选项。
+该方法适用于多频道场景。当远端用户开启双流模式时,你可以调用该方法设置订阅该远端用户发送的视频流的选项。
+当远端用户开启双流模式时,你可以调用该方法选择订阅该远端用户发送的视频流的选项。
+当远端用户开启双流模式时,你可以调用该方法选择订阅该远端用户发送的视频流的选项。
+该方法适用于多频道场景。
++
+
+
+
+
声网通过左右声道的声音差异,让你能够实时感知远端用户的位置,从而营造空间感。该方法适用于大型多人在线游戏,例如大逃杀类游戏。
+该方法用于设置远端用户的语音位置和音量。调用该方法后,左右声道的声音差异可以让你实时感知远端用户的位置,从而营造空间感。该方法适用于大型多人在线游戏,例如大逃杀类游戏。
+你可以使用该方法设置远端用户的语音位置和音量。调用该方法设置远端用户的语音位置后,左右声道的声音差异可以帮助你实时感知远端用户的位置,增强空间感。该方法适用于大型多人在线游戏,例如大逃杀类游戏。
+你可以使用该方法设置远端用户的语音位置和音量。调用该方法设置远端用户的语音位置后,左右声道的声音差异可以帮助你实时感知远端用户的位置,增强空间感。该方法适用于大型多人在线游戏,例如大逃杀类游戏。
+该方法适用于多频道场景。
++
+
+
+
+
你可以调用此方法来指定你想要订阅的用户的音频流。
+你可以调用此方法来指定你想要订阅的用户的音频流。
+该方法适用于多频道场景。
++
+
+
+
+
你可以调用该方法指定不希望订阅的用户的音频流。
+你可以调用此方法来指定不希望订阅的用户的音频流。
+你可以调用此方法来指定不希望订阅的用户的音频流。
+该方法适用于多频道场景。
++
+
+
+
+
你可以调用该方法指定希望订阅的用户的视频流。
+你可以调用该方法来指定希望订阅的用户的视频流。
+你可以调用该方法来指定希望订阅的用户的视频流。
+该方法适用于多频道场景。
++
+
+
+
+
你可以调用此方法来指定不希望订阅的用户的视频流。
+你可以调用此方法来指定不希望订阅的用户的视频流。
+该方法适用于多频道场景。
++
+
+
+
+
该方法在本地设备上初始化远端视频流的视图,仅影响你本地看到的画面。调用该方法可以将远端视频流绑定到指定视图,并设置该视图的渲染模式和镜像模式。
+
+你需要在远端用户加入频道前,通过
你可以调用该方法将远端视频流绑定到视频视图,并设置视频视图的渲染模式和镜像模式。该方法仅影响本地用户看到的视频视图。
+应用需在远端用户加入频道前,通过
该方法在本地设备上初始化远端视频流的视频视图,仅影响你所看到的远端视频画面。你可以调用该方法将远端视频流绑定到指定的视频视图,并设置渲染模式和镜像模式。
+
+你需要在远端用户加入频道前,通过
该方法在本地设备上初始化远端视频流的视频视图,仅影响你所看到的远端视频画面。你可以调用该方法将远端视频流绑定到指定的视频视图,并设置渲染模式和镜像模式。
+
+你需要在远端用户加入频道前,通过
该方法适用于多频道场景。
++
+
0:方法调用成功。 +< 0:方法调用失败。
+0:方法调用成功。 +< 0:方法调用失败。
+
+
每个配置文件对应一组视频参数,包括分辨率、帧率和码率。
设置本地视频的编码器配置。每个配置文件对应一组视频参数,包括分辨率、帧率和码率。
+设置本地视频的编码器配置。每个配置文件对应一组视频参数,包括分辨率、帧率和码率。
+该方法适用于多频道场景。
+请在调用
在调用
请在调用
请在调用
+
+
+
+
+
调用该方法后,SDK 会从调用时刻开始追踪频道中视频帧的渲染状态,并通过
从成功调用该方法开始,SDK 会追踪频道中视频帧的渲染状态,并通过
从成功调用该方法开始,SDK 会追踪频道中视频帧的渲染状态,并通过
从成功调用该方法开始,SDK 会追踪频道中视频帧的渲染状态,并通过
该方法适用于多频道场景。
++
+
+
+
+
首次成功调用该方法会开始将媒体流从源频道转发到目标频道。若需将媒体流转发到其他频道,或退出当前的某个媒体流转发,可再次调用该方法以更新目标频道。该功能最多支持将媒体流转发到六个目标频道。调用该方法成功后,SDK 会触发
首次成功调用该方法会将媒体流从源频道转发到目标频道。若需将媒体流转发到其他频道,或退出当前的某个媒体流转发,可再次调用该方法以更新目标频道。该功能最多支持将媒体流转发到六个目标频道。
+首次成功调用该方法会开始将媒体流从源频道转发到目标频道。若需将媒体流转发到其他频道,或退出当前的某个媒体流转发,可再次调用该方法更新目标频道。该功能最多支持将媒体流转发到六个目标频道。
+首次成功调用该方法会开始将媒体流从源频道转发到目标频道。若需将媒体流转发到其他频道,或退出当前的某个媒体流转发,可再次调用该方法更新目标频道。该功能最多支持将媒体流转发到六个目标频道。
+该方法适用于多频道场景。
++
+
0:方法调用成功。 +< 0:方法调用失败。 +
0:方法调用成功。 +< 0:方法调用失败。 +
+
声网推荐你使用更加完善的服务端推流功能,详见[实现服务端旁路推流](https://doc.shengwang.cn/doc/media-push/restful/landing-page)。
+你可以调用该方法将音频或视频流推送到指定的 CDN 地址。该方法一次只能向一个 CDN 地址推送媒体流。如需推送到多个地址,请多次调用该方法。调用该方法后,SDK 会在本地客户端触发
声网推荐你使用更加完善的服务端推流功能,详见[实现服务端旁路推流](https://doc.shengwang.cn/doc/media-push/restful/landing-page)。 +你可以调用该方法将音频或视频流推送到指定的 CDN 地址。该方法一次只能向一个 CDN 地址推送媒体流,如果需要推送到多个地址,请多次调用该方法。
+声网推荐你使用更加完善的服务端推流功能,详见[实现服务端旁路推流](https://doc.shengwang.cn/doc/media-push/restful/landing-page)。 +你可以调用该方法将音频或视频流推送到指定的 CDN 地址。该方法每次只能推送到一个 CDN 地址,如果需要推送到多个地址,请多次调用该方法。
+声网推荐你使用更加完善的服务端推流功能,详见[实现服务端旁路推流](https://doc.shengwang.cn/doc/media-push/restful/landing-page)。 +你可以调用该方法将音频或视频流推送到指定的 CDN 地址。该方法每次只能推送到一个 CDN 地址,如果需要推送到多个地址,请多次调用该方法。
+该方法适用于多频道场景。
++
+
+
+
+
声网推荐你使用更加完善的服务端推流功能,详见[实现服务端旁路推流](https://doc.shengwang.cn/doc/media-push/restful/landing-page)。 +你可以调用该方法将实时音视频流推送到指定的 CDN 地址,并设置转码配置。该方法每次只能将媒体流推送到一个 CDN 地址,如果需要推送到多个地址,请多次调用该方法。
+声网推荐你使用更加完善的服务端推流功能,详见[实现服务端旁路推流](https://doc.shengwang.cn/doc/media-push/restful/landing-page)。 +你可以调用该方法将音视频直播流推送到指定的 CDN 地址,并设置转码配置。该方法每次只能将媒体流推送到一个 CDN 地址,如果需要推送到多个地址,请多次调用该方法。
+声网推荐你使用更加完善的服务端推流功能,详见[实现服务端旁路推流](https://doc.shengwang.cn/doc/media-push/restful/landing-page)。 +你可以调用该方法将音视频流推送到指定的 CDN 地址,并设置转码配置。该方法每次只能推送到一个 CDN 地址,如需推送到多个地址,请多次调用该方法。
+声网推荐你使用更加完善的服务端推流功能,详见[实现服务端旁路推流](https://doc.shengwang.cn/doc/media-push/restful/landing-page)。 +你可以调用该方法将音视频流推送到指定的 CDN 地址,并设置转码配置。该方法每次只能推送到一个 CDN 地址,如需推送到多个地址,请多次调用该方法。
+该方法适用于多频道场景。
++
+
+
+
+
调用该方法可停止跨频道媒体流转发。一旦转发停止,主播会退出所有目标频道。
+调用该方法停止跨频道媒体流转发。一旦转发停止,主播会退出所有目标频道。
+调用该方法停止跨频道媒体流转发。调用成功后,主播会退出所有目标频道,SDK 会触发
调用该方法停止跨频道媒体流转发。调用成功后,主播会退出所有目标频道,SDK 会触发
该方法适用于多频道场景。
++
+
+
+
+
声网推荐你使用更加完善的服务端推流功能,详见[实现服务端旁路推流](https://doc.shengwang.cn/doc/media-push/restful/landing-page)。 +你可以调用该方法停止向指定的 CDN 地址推送媒体流。该方法每次只能停止一个地址的推流,如需停止多个地址的推流,请多次调用该方法。
+声网推荐你使用更加完善的服务端推流功能,详见[实现服务端旁路推流](https://doc.shengwang.cn/doc/media-push/restful/landing-page)。 +你可以调用该方法停止向指定 CDN 地址的直播推流。该方法每次只能停止向一个 CDN 地址推流,如果需要停止多个地址的推流,请多次调用该方法。
+声网推荐你使用更加完善的服务端推流功能,详见[实现服务端旁路推流](https://doc.shengwang.cn/doc/media-push/restful/landing-page)。 +你可以调用该方法停止向指定的 CDN 地址进行直播推流。该方法每次只能停止向一个 CDN 地址推送媒体流,如果需要停止多个地址的推流,请多次调用该方法。
+声网推荐你使用更加完善的服务端推流功能,详见[实现服务端旁路推流](https://doc.shengwang.cn/doc/media-push/restful/landing-page)。 +你可以调用该方法停止向指定的 CDN 地址进行直播推流。该方法每次只能停止向一个 CDN 地址推送媒体流,如果需要停止多个地址的推流,请多次调用该方法。
+该方法适用于多频道场景。
++
+
+
+
+
该方法为异步调用,调用该方法时 SDK 尚未完成截图操作。用于本地视频截图时,会对
该方法对指定用户的视频流进行截图,生成 JPG 图像并保存到指定路径。该方法为异步调用,方法返回时 SDK 尚未完成截图操作。当用于本地视频截图时,该方法会对
该方法对指定用户的视频流进行截图,生成 JPG 图像并保存到指定路径。该方法为异步调用,方法返回时 SDK 尚未完成截图操作。当用于本地视频截图时,该方法会对
适用于多频道场景。
+请在调用
请在调用
请在调用
请在调用
+
+
+
+
+
该方法从指定用户的视频流中截取一帧图像,生成 JPG 图片,并保存到指定路径。截图结果中会包含视频预处理效果,例如水印或美颜。
+该方法从指定用户的视频流中截取一帧图像,生成 JPG 图片,并保存到指定路径。
+
+该方法为异步调用,调用返回时 SDK 尚未完成截图。
+
+用于本地视频截图时,该方法会对
该方法从指定用户的视频流中截取一帧图像,生成 JPG 图片,并保存到指定路径。
+
+该方法为异步调用,调用返回时 SDK 尚未完成截图。
+
+用于本地视频截图时,该方法会对
适用于多频道场景。
+请在调用
请在调用
请在调用
请在调用
+
+
+
+
+
该方法适用于多频道场景。
++
+
+
+
+
声网推荐你使用更加完善的服务端推流功能,详见[实现服务端旁路推流](https://doc.shengwang.cn/doc/media-push/restful/landing-page)。
+开始使用转码功能将媒体流推送到 CDN 后,你可以根据实际场景动态更新转码配置。更新配置后,SDK 会触发
声网推荐你使用更加完善的服务端推流功能,详见[实现服务端旁路推流](https://doc.shengwang.cn/doc/media-push/restful/landing-page)。
+开始使用转码功能将媒体流推送到 CDN 后,你可以根据场景动态更新转码配置。更新配置后,SDK 会触发
声网推荐你使用更加完善的服务端推流功能,详见[实现服务端旁路推流](https://doc.shengwang.cn/doc/media-push/restful/landing-page)。 +你可以在开启带转码的 CDN 推流后,根据场景动态更新转码配置。
+声网推荐你使用更加完善的服务端推流功能,详见[实现服务端旁路推流](https://doc.shengwang.cn/doc/media-push/restful/landing-page)。 +你可以在开启带转码的 CDN 推流后,根据场景动态更新转码配置。
+该方法适用于多频道场景。
++
+
+
+
+
方法调用成功,返回可共享窗口和屏幕的数量。
+
+
在获取
方法调用成功,返回
+
获取可共享窗口和屏幕列表后,为避免内存泄漏,请调用该方法释放
+
方法调用成功,返回系统中已索引的视频采集设备总数。
+
+
+
+
+
+
+
该方法返回一个
+
+
调用
+
+
+
+
你可以调用该方法获取指定视频采集设备支持的视频格式数量,然后调用
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
用于获取视频特效中指定
用于获取视频特效中指定
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
如果你希望获取的视频数据是原始视频的镜像图像,需要在调用
如果你希望获取的视频数据是原始视频的镜像图像,需要在调用
如果你希望获取的视频数据是原始视频的镜像图像,在调用
如果你希望获取的视频数据是原始视频的镜像图像,在调用
每次 SDK 接收到视频帧时触发。
+该回调在 SDK 每次接收到视频帧时被触发。
+每次 SDK 接收到视频帧时触发。
+每次 SDK 接收到视频帧时触发。
++
是否对采集的视频进行镜像: +
是否镜像采集的视频: +
是否镜像采集的视频: +
+
在成功注册视频数据观察器后,SDK 会通过该回调判断是否在特定的视频帧处理位置触发
在成功注册视频数据观察器后,SDK 会通过该回调判断是否在特定的视频帧处理位置触发
在你成功注册视频数据观察器后,SDK 会通过该回调判断是否在特定的视频帧处理位置触发
在你成功注册视频数据观察器后,SDK 会通过该回调判断是否在特定的视频帧处理位置触发
方法调用成功,返回用于控制视频观察器帧位置的位掩码。详见
方法调用成功,返回用于控制视频观察器帧位置的位掩码: +
用于控制你希望观察的视频帧位置的位掩码。详见
用于控制你希望观察的视频帧位置的位掩码。详见
+
如果你希望根据
如果你希望根据
如果采集设备上的视频已根据
如果采集设备上的视频已根据
每次 SDK 接收到视频帧时触发。
+该回调在 SDK 每次接收到视频帧时被触发。
++
+
+
+
+
调用
调用
调用
调用
设置 SDK 输出的原始数据格式,详见
方法调用成功,返回 SDK 输出的原始数据格式: +
方法调用成功时,返回原始视频数据的格式,详见
方法调用成功时,返回原始视频数据的格式,详见
+
在你成功注册视频帧观察器后,SDK 每次接收到视频帧时都会触发该回调。你需要通过该回调的返回值设置你偏好的处理模式。
+在成功注册视频帧观察器后,SDK 每次接收到视频帧时会触发
在你成功注册视频帧观察器后,SDK 每次接收到视频帧时都会触发该回调。你需要在该回调的返回值中设置你偏好的处理模式。
+在你成功注册视频帧观察器后,SDK 每次接收到视频帧时都会触发该回调。你需要在该回调的返回值中设置你偏好的处理模式。
+每次 SDK 接收到视频帧时触发。
+每次 SDK 接收到视频帧时触发。
+每次 SDK 接收到视频帧时触发。
+方法调用成功时,返回一个
视频帧的处理模式: +
方法调用成功时,返回你设置的视频帧处理模式,详见
方法调用成功时,返回你设置的视频帧处理模式,详见
+
如果
+
+
+
+
+
+
方法调用成功,返回默认的
方法调用成功,返回默认的
+
+
+
+
+
方法调用成功,返回背景颜色的十六进制 RGB 值。
+
+
方法调用成功,返回
+
方法调用成功,返回背景颜色的蓝色分量。
+
+
方法调用成功,返回背景颜色的绿色分量。
+
+
方法调用成功,返回背景颜色的红色分量。
+
+
方法调用成功,返回在 CDN 推流中进行转码的用户数量。
+
+
返回的用户列表为只读,不应修改。
++
+
方法调用成功,返回
+
+
+
+
+
+
+
+
+
通过该方法可以启用或禁用带转码的 RTMP 或 RTMPS 推流的高级功能。
+通过该方法可以启用或禁用带转码的 RTMP 或 RTMPS 推流的高级功能。
+
+
颜色格式为 RGB 十六进制值。
+
+
+
+
+
+
该方法用于用新的用户数据替换旧的数据,设置所有参与 CDN 推流的用户。
+
+
该方法用于批量设置所有参与 CDN 推流的用户,并用新的用户数据替换旧的数据。
+
+
+
+
方法调用成功,返回当前请求中的音乐排行榜数量。
+
+
方法调用成功,返回当前请求中的音乐项数量。
+
+
+
+
方法调用成功,返回当前页码。
+
+
方法调用成功,返回 SDK 实际返回的音乐资源数量。
+
+
方法调用成功,返回音乐资源的总数。
+
+
在调用
该方法必须在调用
你必须在调用
你必须在调用
+
+
+
+
你可以使用该方法获取播放器和媒体流的详细信息,例如音频采样率、视频帧大小等。
+你可以使用该方法获取播放器和媒体流相关的信息,例如音频采样率和视频帧尺寸。
+你可以使用该方法获取播放器和媒体流相关的信息,例如音频采样率和视频帧尺寸。
+在调用
该方法必须在调用
+
+
+
+
该方法用于获取当前播放的时间位置,单位为毫秒。
+该方法用于获取当前播放的时间位置,单位为毫秒。
+方法调用成功,返回当前播放位置,单位为毫秒。
+方法调用成功,返回当前的播放位置,单位为毫秒。
+方法调用成功时,返回当前播放位置,单位为毫秒。
+方法调用成功时,返回当前播放位置,单位为毫秒。
+
+
该方法通过回调异步返回播放器的统计信息,包括解码情况、渲染帧率、音视频码率等。
+该方法通过回调异步返回播放器的统计信息。
+该方法用于获取播放器的统计信息,并通过回调函数异步返回结果。统计信息包括解码和渲染帧率、音视频码率等。
+该方法用于获取播放器的统计信息,并通过回调函数异步返回结果。统计信息包括解码和渲染帧率、音视频码率等。
+该方法必须在调用
该方法必须在调用
+
该方法必须在调用
该方法需要在调用
你必须在调用
你必须在调用
+
+
+
该方法必须在调用
你必须在调用
你必须在调用
你必须在调用
+
+
+
该方法支持通过 URL 打开实时流媒体资源。如果你希望加快 URL 的打开速度,可以在调用该方法前调用
该方法支持通过 URL 打开实时流媒体资源。如果你希望加快打开速度,可以在调用该方法前使用
该方法支持通过 URL 打开实时流媒体资源。若希望加快打开 URL 资源的速度,可以在调用该方法前先调用
该方法支持通过 URL 打开实时流媒体资源。若希望加快打开 URL 资源的速度,可以在调用该方法前先调用
该方法必须在
该方法必须在
该方法必须在调用
该方法必须在调用
+
调用
调用
调用
调用
该方法必须在调用
该方法必须在调用
你必须在调用
你必须在调用
+
+
+
+
如果你已关闭自动播放,在使用
如果你已关闭自动播放,在使用
如果你已关闭自动播放,在使用
在收到
仅在收到状态为
仅在收到
仅在收到
播放是否成功: +
+
+
+
该方法必须在调用
该方法必须在调用
你必须在调用
你必须在调用
+
预加载成功后,通过
成功预加载资源可以加快使用
你可以在调用
你可以在调用
在打开媒体资源前预加载,可以减少用户等待时间,提供更流畅的视听体验。
+该方法必须在调用
必须在调用
是否预加载成功: +
+
+
+
在调用该方法前,你需要实现一个继承自
在调用此方法之前,你需要实现一个继承自
在调用此方法之前,你需要实现一个继承自
该方法必须在调用
你必须在调用
是否注册成功: +
+
+
+
+
+
+
+
该方法用于指定一个 `Canvas`` 对象用于显示视频。一旦视频流成功播放,视频将显示在该
该方法用于设置用于显示视频的
该方法用于设置用于显示视频的视图窗口。在视频流成功开始播放后,视频将渲染在指定的
该方法用于设置用于显示视频的视图窗口。在视频流成功开始播放后,视频将渲染在指定的
该方法必须在调用
该方法必须在调用
+
+
+
+
你可以调用该方法配置播放器,例如启用自动播放、订阅不同分辨率和码率的视频流等。
+你可以调用此方法配置播放器,例如启用自动播放、订阅不同分辨率和码率的视频流。
+你可以调用此方法配置播放器,例如启用自动播放、订阅不同分辨率和码率的视频流。
+该方法必须在调用
此方法必须在调用
配置是否成功: +
+
+
+
成功调用
如果使用
此方法必须在调用
该方法必须在调用
+
+
+
+
当 SDK 返回播放器状态为
+
调用
调用
调用
该方法必须在调用
该方法必须在调用
该方法必须在调用
+
+
+
+
在调用
你必须在调用
你必须在调用
你必须在调用
方法调用成功时,返回已配置的视频流回退选项,详见
方法调用成功,返回已配置的视频流回退选项。详见
已配置的视频流分层回退选项,详见
已配置的视频流分层回退选项,详见
+
在调用
你需要在调用
你必须在调用
你必须在调用
方法调用成功,返回当前设置的视频质量层级,详见
方法调用成功,返回当前设置的视频质量层级。详见
当前设置的视频质量层级,详见
当前设置的视频质量层级,详见
+
你可以调用此方法获取媒体播放器当前的自动播放设置。
+你可以调用此方法获取媒体播放器当前的自动播放设置。
+在调用
此方法必须在调用
必须在调用
必须在调用
是否成功获取自动播放设置: +
+
是否成功获取自动播放设置: +
是否成功获取自动播放设置: +
+
方法调用成功,返回媒体文件的循环次数。
+方法调用成功,返回媒体文件的循环播放次数。
+方法调用成功时,返回媒体文件的循环次数。
+方法调用成功时,返回媒体文件的循环次数。
+
+
方法调用成功,返回播放速度值。
+方法调用成功,返回播放速度的值。
+方法调用成功时,返回播放速度的值。
+方法调用成功时,返回播放速度的值。
+
+
方法调用成功,返回播放器的音量值。
+方法调用成功,返回媒体播放器的播放音量级别。
+方法调用成功,返回媒体播放器的播放音量。
+方法调用成功,返回媒体播放器的播放音量。
+
+
在网络状况较差时,SDK 会将视频流的分辨率降级为指定的回退质量层,以保证播放的连续性。不同的质量层对应不同的分辨率和码率。SDK 会持续监测网络状况,在网络恢复后自动将视频流恢复为订阅的质量层。
+默认情况下,仅支持回退到
在网络状况不佳时,SDK 会将已订阅远端视频流的分辨率降级到指定的视频质量层。每个质量层对应特定的分辨率和码率。网络恢复后,SDK 会将视频流恢复至原始质量层。
+在网络条件较差时,实时音视频通信的质量可能会下降。调用该方法后,SDK 会在网络变差时将远端视频流的分辨率回退到指定的视频质量层级。每个视频质量层级对应特定的分辨率和码率。SDK 会持续监测网络质量,在网络改善时恢复到原始订阅的视频质量层级。
+
+默认情况下,调用该方法后只能选择回退到
在网络条件较差时,实时音视频通信的质量可能会下降。调用该方法后,SDK 会在网络变差时将远端视频流的分辨率回退到指定的视频质量层级。每个视频质量层级对应特定的分辨率和码率。SDK 会持续监测网络质量,在网络改善时恢复到原始订阅的视频质量层级。
+
+默认情况下,调用该方法后只能选择回退到
一般场景下,可调用该方法并将回退质量层设置为
该方法必须在调用
必须在调用
必须在调用
必须在调用
+
你可以根据实际网络状况在不同的视频流质量层级之间切换,每个层级对应不同的分辨率。默认情况下,调用该方法后,订阅端只能在高低画质之间切换,即
你可以根据实际网络状况,在所订阅的视频流中切换不同的视频质量等级。如果你需要更高级的视频分辨率切换控制,可以[联系技术支持](https://ticket.shengwang.cn/)开启 ABR(自适应码率)功能。开启后,你可以为每个视频质量等级自定义分辨率,使观众可以根据需要在多质量层级视频流的所有等级之间切换。
+你可以根据实际的网络状况,在多质量层级视频流中切换不同的视频质量层级,每个层级对应不同的分辨率。默认情况下,调用该方法后,观众只能在高、低两个视频流之间切换,即
你可以根据实际的网络状况,在多质量层级视频流中切换不同的视频质量层级,每个层级对应不同的分辨率。默认情况下,调用该方法后,观众只能在高、低两个视频流之间切换,即
在网络环境不稳定的场景中,订阅端可根据实际网络状况选择合适的视频质量层级,以保障流畅的观看体验。
+该方法必须在调用
该方法必须在调用
你必须在调用
你必须在调用
+
在调用
你可以在调用
你可以在调用
你可以在调用
该方法必须在调用
此方法必须在调用
该方法必须在调用
该方法必须在调用
+
+
你可以在调用
+
你可以使用该方法设置播放音量。有效范围为 [0, 400]。
+你可以使用该方法设置播放音量。有效范围为 [0, 400]。
+
+
该方法会释放
该方法会释放
+
+
+
+
在调用
该方法必须在调用
你必须在调用
你必须在调用
+
+
+
+
通过该方法创建的
通过该方法创建的
通过调用此方法创建的
通过调用此方法创建的
在调用此方法之前,请确保你已调用
调用此方法前,请确保已调用
在调用此方法之前,请确保你已通过调用
在调用此方法之前,请确保你已通过调用
+
方法调用成功,返回
方法调用成功,返回一个
方法调用成功,返回一个
+
该方法为异步方法,通过回调函数返回初始化结果。你需要在创建
该方法为异步方法,通过回调函数返回初始化结果。你需要在创建
该方法为异步方法,通过回调函数返回初始化结果。你需要在创建
该方法必须在创建
你需要在创建
你需要在创建
+
+
+
+
该方法必须在调用
你必须在调用
你必须在调用
你必须在调用
+
+
+
你可以调用该方法设置如 App ID 等信息。
+你可以调用此方法设置如 App ID 等信息。
+你可以调用此方法设置如 App ID 等信息。
+该方法必须在调用
该方法必须在调用
+
+
+
+
方法调用成功,返回
+
该方法仅在打开 RTE URL 时有效。
+方法调用成功,返回当前订阅的视频层级,详见
方法调用成功,返回
+
方法调用成功,返回每个音频采样的位数,单位为 bit。
+方法调用成功,返回每个音频采样点的位数,单位为 bit。
+
+
方法调用成功,返回音频的声道数。
+方法调用成功,返回音频通道数。
+
+
方法调用成功,返回音频采样率,单位为 Hz。
+方法调用成功,返回音频采样率,单位为 Hz。
+
+
+
方法调用成功时,返回当前正在播放的 URL。 +方法调用失败,返回空字符串。
+
+
方法调用成功,返回当前媒体资源的时长,单位为毫秒。
+方法调用成功,返回当前媒体资源的时长,单位为毫秒。
+
+
+
+
+
+
+
+
+
+
+
+
+
方法调用成功时,返回当前播放器状态,详见
方法调用成功,返回当前播放器的状态。
+
+
该方法仅在打开非 RTE URL 时有效。
+方法调用成功,返回当前播放源中的流数量。
+方法调用成功,返回流的数量。
+
+
方法调用成功,返回视频分辨率的高度,单位为像素。
+方法调用成功,返回视频分辨率的高度,单位为像素。
+
+
方法调用成功,返回视频分辨率的宽度,单位为像素。
+方法调用成功,返回视频分辨率的宽度,单位为像素。
+
+
方法调用成功,返回初始化后的
方法调用成功,返回初始化后的
+
方法调用成功,返回
方法调用成功,返回
+
方法调用成功时,返回包含水印图像数据的
+
方法调用成功,返回水印图像缓冲区的格式。
+
+
方法调用成功,返回水印图像的高度,单位为像素。
+
+
用于从
+
+
方法调用成功,返回水印图像的宽度,单位为像素。
+
+
+
+
方法调用成功,返回
+
方法调用成功,返回水印类型: +
+
方法调用成功,返回一个包含四个元素的整数数组,依次表示水印矩形的 x、y、宽度和高度。
+
+
方法调用成功,返回一个包含四个元素的整数数组,分别表示水印矩形的 x、y、宽度和高度。
+
+
方法调用成功,返回水印图像的 Z-order 索引。
+
+
+
+
该回调在异步操作完成时被触发,用于报告操作结果。
+
+
调用
调用
调用
调用
该回调在调用
该回调在调用
+
调用
调用
调用
调用
该回调在获取远端用户编码音频数据时被触发。
+该回调在获取到所有远端用户的编码音频数据时被触发。
+该回调在获取到所有远端用户的编码音频数据时被触发。
+
+
调用
调用
调用
调用
该回调在获取到本地用户的编码音频数据时被触发。
+该回调在获取到本地用户的编码音频数据时被触发。
+
+
为了确保你获取的耳返音频数据符合预期,声网建议你通过以下两种方式之一设置耳返音频数据格式: +
该回调用于获取耳返音频数据。为了确保获取的数据符合预期,声网建议你通过以下任一方式设置音频数据格式: +
为了确保你获取的耳返音频数据符合预期,声网建议你通过以下两种方式之一设置耳返音频数据格式: +
该回调在采样间隔到达时被触发。
+该回调在采样间隔到达时被触发。
++
+
+
+
为了确保混合后的采集和播放音频帧的数据格式符合预期,声网建议你通过以下两种方式之一设置音频数据格式: +
声网建议通过以下两种方式之一设置音频数据格式,以确保混合采集和播放音频帧的数据格式符合预期: +
为了确保混合后的采集和播放音频帧的数据格式符合预期,声网建议你通过以下两种方式之一设置音频数据格式: +
该回调在获取混合后的采集和播放音频帧时被触发。
+该回调在获取混合后的采集和播放音频帧时被触发。
++
+
+
+
为了确保播放音频帧的数据格式符合预期,声网建议你通过以下两种方法之一设置音频数据格式: +
你可以通过以下两种方式之一设置音频数据格式: +
为了确保播放音频帧的数据格式符合预期,声网建议你通过以下两种方法之一设置音频数据格式: +
该回调在 SDK 获取到用于播放的音频帧时被触发。
+该回调在 SDK 获取到用于播放的音频帧时被触发。
++
+
+
+
该回调在获取远端用户音频帧并在混音前触发。
++
+
+
+
你可以通过以下两种方式之一设置音频数据格式,以确保采集到的音频帧格式符合预期: +
你可以通过以下两种方式之一设置音频数据格式: +
你可以通过以下两种方式之一设置音频数据格式,以确保采集到的音频帧格式符合预期: +
该回调在采集到音频帧时被触发。
+该回调在采集到音频帧时被触发。
++
+
+
+
为了确保获取的耳返音频数据符合预期,声网建议你通过以下两种方法之一设置耳返音频数据格式: +
+
+
为了确保混合采集和播放音频帧的数据格式符合预期,声网建议通过以下两种方式之一设置音频数据格式: +
+
+
为了确保播放音频帧的数据格式符合预期,声网建议你通过以下两种方式之一设置音频数据格式: +
+
+
+
+
为了确保采集到的音频帧格式符合预期,你可以通过以下两种方式之一设置音频数据格式: +
SDK 根据采样间隔触发该回调。
++
+
注册音频帧观察器后,每次播放器接收到音频帧时,都会触发该回调,并报告该音频帧的详细信息。
+注册音频帧观察器后,每次播放器接收到音频帧时,都会触发该回调,报告音频帧的详细信息。
+注册音频帧观察器后,每次播放器接收到音频帧时,都会触发该回调,报告音频帧的详细信息。
+每次播放器接收到音频帧时触发。
+每次播放器接收到音频帧时触发。
+每次播放器接收到音频帧时触发。
+
+
调用
在成功调用
成功调用
成功调用
该回调在启用音频频谱监测并设置时间间隔后,由 SDK 按照设置的时间间隔在编码前触发。
++
是否接收到频谱数据: +
+
+
+
成功调用
成功调用
你调用
你调用
SDK 会按照你设置的时间间隔触发该回调,报告接收到的远端音频数据频谱。
+该回调在成功调用
该回调在接收到远端音频频谱数据时被触发。
+该回调在接收到远端音频频谱数据时被触发。
++
+
+
+
+
当主播直接向 CDN 推流时,若推流状态发生变化,SDK 会触发该回调,报告变化后的推流状态、错误码及相关信息。
+当主播直接向 CDN 推流时,如果推流状态发生变化,SDK 会触发该回调,报告变化后的推流状态、错误码及其他信息。你可以参考该回调进行问题排查。
+当主播直接向 CDN 推流时,如果推流状态发生变化,SDK 会触发该回调,报告变化后的推流状态、错误码及其他信息。你可以通过该回调排查问题。
+当主播直接向 CDN 推流时,如果推流状态发生变化,SDK 会触发该回调,报告变化后的推流状态、错误码及其他信息。你可以通过该回调排查问题。
+该回调在主播直接向 CDN 推流过程中,推流状态发生变化时被触发。
+该回调在 CDN 推流状态发生变化时被触发。
+该回调在 CDN 推流状态发生变化时被触发。
+
+
当主播直接向 CDN 推送媒体流时,SDK 每秒触发一次该回调。
+当主播直接向 CDN 推送媒体流时,SDK 每秒触发一次该回调。
+该回调在主播直接向 CDN 推送媒体流时每秒触发一次。
+该回调在主播直接向 CDN 推送媒体流时每秒触发一次。
+该回调在主播直接向 CDN 推送媒体流时每秒触发一次。
+
+
注册音频帧观察器后,该回调会在播放器每次接收到音频帧时触发。
+该回调在播放器接收到音频帧时被触发。
+在调用
+
当你调用
当你调用
+
+
+
该回调在调用
当你调用
+
+
+
该回调每 200 毫秒触发一次。
+该回调每 200 毫秒触发一次。
+该回调每 200 毫秒触发一次,用于报告当前媒体播放器的音量。
+该回调每 200 毫秒触发一次,用于报告当前媒体播放器的音量。
+该回调每 200 毫秒触发一次,用于报告媒体播放器的当前音量。
+该回调每 200 毫秒触发一次。
+该回调每 200 毫秒触发一次。
+
+
该回调在播放器接收到媒体元数据时触发。
+该回调在播放器接收到媒体元数据时被触发。
+播放器接收到媒体元数据时,会触发该回调并上报媒体元数据的详细信息。
+播放器接收到媒体元数据时,会触发该回调并上报媒体元数据的详细信息。
+该回调在播放器接收到媒体元数据时被触发。
+该回调在播放器接收到媒体元数据时触发。
+该回调在播放器接收到媒体元数据时触发。
+
+
当播放在线媒体资源时,SDK 每两秒触发一次该回调,用于报告当前缓冲数据可支持的播放时长。 +
该回调在播放在线媒体资源时每两秒触发一次。 +
+
+
播放在线媒体资源时,SDK 每两秒触发一次该回调。
+该回调在播放在线媒体资源时每两秒被触发。
+播放在线媒体资源时,SDK 每两秒触发一次该回调。
+播放在线媒体资源时,SDK 每两秒触发一次该回调。
+
+
调用
调用
该回调在调用
该回调在你调用
该回调在你调用
+
调用
调用
调用
调用
该回调在你调用
该回调在你调用
+
你可以通过该回调获取媒体播放器信息的变化,用于故障排查。
+你可以使用该回调进行故障排查。
+你可以通过该回调获取媒体播放器的最新信息,用于故障排查。
+你可以通过该回调获取媒体播放器的最新信息,用于故障排查。
+该回调在媒体播放器相关信息发生变化时被触发。
+该回调在媒体播放器相关信息发生变化时被触发。
+该回调在媒体播放器相关信息发生变化时被触发。
+无。
+
+
该回调每秒触发一次,用于报告播放中的媒体文件的统计信息。
+该回调在媒体文件播放过程中每秒触发一次。
+该回调在媒体文件播放过程中每秒触发一次。
+该回调每秒触发一次,用于报告正在播放的媒体文件的统计信息。
+该回调每秒触发一次,用于报告正在播放的媒体文件的统计信息。
+
+
当媒体播放器状态发生变化时,SDK 会触发该回调报告当前播放状态。
+当媒体播放器的状态发生变化时,SDK 会触发该回调。
+播放状态发生变化时触发的回调。
+播放状态发生变化时触发的回调。
+该回调在媒体播放器播放状态发生变化时被触发。
+该回调在媒体播放器播放状态发生变化时被触发。
+
+
该回调在播放媒体文件过程中每两秒触发一次,用于报告播放源信息的变化。
+该回调在播放媒体文件过程中每两秒触发一次,用于报告播放源信息的变化。
+该回调在媒体资源的视频码率发生变化时被触发。
+该回调在播放媒体文件过程中每两秒触发一次。
+该回调在播放媒体文件过程中每两秒触发一次。
+
+
该回调在播放媒体文件时每两秒触发一次,用于报告当前播放进度。
+该回调用于报告媒体文件的播放进度。
+该回调在播放过程中每秒触发一次,用于报告当前播放进度。
+该回调在播放过程中每秒触发一次,用于报告当前播放进度。
+该回调在播放媒体文件时每两秒被触发。
+该回调在播放过程中每秒触发一次。
+该回调在播放过程中每秒触发一次。
+
+
该回调用于上报预加载媒体资源过程中发生的事件。
+该回调在媒体资源预加载过程中发生事件时被触发。
+该回调在媒体资源预加载过程中发生事件时被触发。
+
+
注册视频帧观察器后,该回调在播放器接收到视频帧时被触发。
+该回调在播放器接收到视频帧时被触发。
+
+
成功注册该回调并开始音视频流录制后,SDK 会根据
在你成功注册该回调并开始音视频流录制后,SDK 会根据你在
在你成功注册该回调并开始音视频流录制后,SDK 会根据你在
在你成功注册该回调并开始音视频流录制后,SDK 会根据你在
成功注册该回调并开始音视频流录制后,SDK 会定期触发该回调。
+该回调在你成功注册回调并开始音视频流录制后,根据
该回调在你成功注册并开始音视频流录制后,SDK 会周期性地触发。
+该回调在你成功注册并开始音视频流录制后,SDK 会周期性地触发。
+
+
当音视频流的录制状态发生变化时,SDK 会触发该回调,报告当前的录制状态及其变化原因。
+SDK 在音视频流的录制状态发生变化时会触发该回调,报告当前的录制状态及其变化原因。
+当音视频流的录制状态发生变化时触发。
+当音视频流的录制状态发生变化时触发。
+
+
该回调在本地用户接收到元数据时被触发。
+该回调在本地用户接收到元数据时被触发。
+该回调在本地用户接收到元数据时被触发。
+
+
当 SDK 准备好发送元数据时触发。
+该回调在 SDK 准备好发送元数据时被触发。
++
方法调用成功时,返回希望发送的元数据,格式为字节数组。
+
+
调用
调用
调用
该回调在你调用
该回调在调用
+
调用
你调用
该回调在调用
该回调在你调用
该回调在调用
+
调用
当你调用
该回调在调用
调用
该回调在你调用
+
调用
调用
调用
该回调在调用
该回调在调用
+
调用
当你调用
调用
该回调在你调用
该回调在调用
+
+
+
+
+
调用
成功调用
成功调用
成功调用
该回调在检测到最活跃的远端说话人时被触发。
+该回调在检测到最活跃的远端说话人时被触发。
+该回调在检测到最活跃的远端说话人时被触发。
+
+
该回调用于通知音频设备的状态发生变化,例如设备上的耳机被拔出。
+
+
+
当本地音效文件播放结束时,会触发该回调。你可以通过该回调获知指定音效是否已播放完成。
+该回调在本地音效文件播放完成时触发。
+该回调在本地音效文件播放完成时触发。
+该回调在本地音效文件播放完成时被触发。
+该回调在本地音效文件播放完成时被触发。
+该回调在本地音效文件播放完成时被触发。
+
+
调用
调用
调用
调用
调用
该回调在本地音乐文件播放结束时被触发。
+调用
调用
+
调用
调用
你调用
你调用
该回调在调用
你调用
你调用
+
+
该回调在音乐文件的播放状态发生变化时触发,并报告当前的播放状态和错误码。
+该回调报告当前音乐文件的播放状态和错误码。
+该回调在音乐文件的播放状态发生变化时触发,并报告当前的状态和错误码。
+该回调在音乐文件的播放状态发生变化时触发,并报告当前的状态和错误码。
+该回调在音乐文件播放状态发生变化时被触发。
+该回调在音乐文件的播放状态发生变化时被触发。
+该回调在音乐文件的播放状态发生变化时被触发。
+
+
该回调在音频发布状态发生变化时触发。
+该回调在音频发布状态发生变化时触发。
+该回调在音频发布状态发生变化时被触发。
+该回调在音频发布状态发生变化时触发。
+该回调在音频发布状态发生变化时触发。
+
+
SDK 每两秒触发一次该回调,用于报告每个正在发送音频流的远端用户的音频质量。如果频道中有多个用户发送音频流,SDK 会触发多次该回调。
+该回调每两秒触发一次,用于报告每个正在发送音频流的远端用户的音频质量。
+
+
该回调在本地音频路由发生变化时触发,例如从听筒切换到扬声器。
+该回调在本地音频路由发生变化时触发,例如从听筒切换到扬声器。
+该回调在本地音频路由发生变化时被触发。
+该回调在本地音频路由发生变化时被触发。
+该回调在本地音频路由发生变化时被触发。
+
+
该回调在本地用户订阅远端音频流的状态发生变化时触发。
+该回调在音频订阅状态发生变化时触发。
+该回调在音频订阅状态发生变化时触发。
+该回调在本地用户订阅远端音频流的状态发生变化时被触发。
+
+
默认情况下,该回调处于关闭状态。你可以通过调用
默认情况下,该回调处于关闭状态。你可以通过调用
你可以通过调用
你可以通过调用
当启用音量提示并有用户发送音频流时触发。
+该回调在启用音量提示并有用户发送音频流时被触发。
+该回调在启用音量提示并有用户发送音频流时被触发。
+
+
当本地用户调用
当你调用
当本地用户调用
该回调在你调用
该回调在调用
+
调用
当本地用户调用
该回调在你调用
+
该回调在摄像头成功打开并准备好采集视频时触发。
+该回调在摄像头成功开启并准备好采集视频时被触发。
+
+
该回调返回当前跨频道媒体流转发的状态和错误码信息。
+该回调返回当前跨频道媒体流转发的错误信息。
+该回调返回当前跨频道媒体流转发的状态及错误码。
+该回调返回当前跨频道媒体流转发的状态及错误码。
+该回调在跨频道媒体流转发状态发生变化时被触发。
+该回调在跨频道媒体流转发状态发生变化时触发。
+该回调在跨频道媒体流转发状态发生变化时触发。
+
+
在以下任一情况下会触发该回调: +
该回调在以下任一情况下被触发: +
该回调会在以下任一情况下触发: +
该回调会在以下任一情况下触发: +
+
该回调用于报告切换用户角色失败的原因和当前的用户角色。
+该回调用于通知切换用户角色失败的原因以及当前的用户角色。
+当本地用户加入频道后调用
该回调在本地用户加入频道后调用
该回调在你加入频道后调用
该回调在你加入频道后调用
+
该回调在连接被声网服务器封禁时触发。
+该回调在连接被声网服务器封禁时触发。
+该回调在连接被声网服务器封禁时被触发。
+该回调在连接被声网服务器封禁时触发。
+该回调在连接被声网服务器封禁时触发。
+
+
当 SDK 建立连接后与服务器断开超过 4 秒时,会触发该回调。触发后,SDK 会尝试重新连接服务器。你可以通过该回调实现弹窗提醒功能。
+该回调在 SDK 建立连接后与服务器断开连接超过四秒时被触发。触发该回调后,SDK 会尝试重新连接服务器。你可以通过该回调实现弹窗提醒功能。
+该回调与
当 SDK 在建立连接后与服务器断开连接超过四秒时,会触发该回调。触发该回调后,SDK 会尝试重新连接服务器。你可以使用该回调实现弹窗提醒功能。该回调与
当 SDK 在建立连接后与服务器断开连接超过四秒时,会触发该回调。触发该回调后,SDK 会尝试重新连接服务器。你可以使用该回调实现弹窗提醒功能。该回调与
当 SDK 与服务器的连接中断超过 4 秒时触发。
+该回调在 SDK 与服务器断开连接超过四秒时被触发。
+该回调在 SDK 与服务器的连接中断超过四秒时被触发。
+该回调在 SDK 与服务器的连接中断超过四秒时被触发。
+
+
调用
无论是否在频道中,当调用
调用
调用
当 SDK 与声网边缘服务器的连接中断后 10 秒内无法重新连接时触发。
+该回调在调用
当 SDK 与声网边缘服务器的连接中断后 10 秒仍无法重连时触发。
+当 SDK 与声网边缘服务器的连接中断后 10 秒仍无法重连时触发。
+
+
该回调在网络连接状态发生变化时触发,报告当前的连接状态以及导致状态变化的原因。
+SDK 会在网络连接状态发生变化时触发该回调,并报告当前的连接状态及其变化原因。
+该回调在网络连接状态发生变化时触发,报告当前的连接状态以及导致状态变化的原因。
+该回调在网络连接状态发生变化时触发,报告当前的连接状态以及导致状态变化的原因。
+该回调在网络连接状态发生变化时被触发。
+该回调在网络连接状态发生变化时被触发。
+该回调在网络连接状态发生变化时被触发。
+
+
调用
如果在调用
当你调用
当你调用
该回调在加密或解密过程中发生错误时被触发。
+该回调在加密或解密过程中发生错误时被触发。
+该回调在加密或解密过程中发生错误时被触发。
+
+
该回调表示 SDK 运行过程中发生了网络或媒体相关的错误。在大多数情况下,SDK 无法自动修复该问题并继续运行,需要你在应用层进行处理或提示用户。
+该回调表示 SDK 运行期间发生了网络或媒体相关的错误。在大多数情况下,SDK 无法自动修复该问题并继续运行,需要你在应用层进行处理或通知用户。
+该回调在 SDK 运行过程中发生错误时触发。
+该回调在 SDK 运行过程中发生错误时触发。
+该回调在 SDK 运行期间发生错误时被触发。
+该回调在 SDK 运行过程中发生错误时触发。
+该回调在 SDK 运行过程中发生错误时触发。
+
+
当扩展启用失败或运行时发生错误时,会触发该回调,并返回错误码和错误原因。
+当扩展启用失败或运行时发生错误时,会触发该回调,并报告错误码及原因。
+当扩展启用失败或运行时发生错误时,会触发该回调,并报告错误码及原因。
+该回调在扩展启用失败或运行过程中发生错误时被触发。
+该回调在扩展启用失败或运行时发生错误时被触发。
+该回调在扩展启用失败或运行时发生错误时被触发。
+
+
在扩展运行期间监听事件时,你需要注册该回调。
+你需要注册该回调,用于在扩展运行期间监听事件。
+你需要注册该回调以在扩展运行期间监听事件。
+你需要注册该回调以在扩展运行期间监听事件。
+
+
该回调在扩展成功启用后被触发。
+该回调在扩展成功启用后被触发。
+该回调在扩展成功启用后被触发。
+
+
当扩展被成功禁用后触发该回调。
+该回调在扩展被成功禁用后触发。
+该回调在扩展成功被禁用后触发。
+该回调在扩展成功被禁用后触发。
+
+
调用
调用
调用
当检测到人脸位置变化时触发。
+该回调在检测到人脸位置或数量发生变化时被触发。
+
+
当满足以下任一条件时,SDK 会触发该回调: +
该回调在本地音频首帧成功发布时被触发,触发时机包括: +
该回调在本地音频首帧成功发布时被触发,触发时机包括: +
该回调在以下任一情况下由 SDK 触发: +
该回调在本地音频首帧发布时被触发。
+该回调在本地音频首帧成功发布时被触发。
+该回调在本地音频首帧成功发布时被触发。
+
+
当本地视频画面首次在本地视图中显示时触发。
+当本地视频视图上显示首帧本地视频画面时触发。
+当本地视频视图上显示首帧本地视频画面时触发。
+
+
当满足以下任一条件时,SDK 会触发该回调: +
当满足以下任一条件时,SDK 会触发该回调: +
当首帧本地视频发布时触发。
+该回调在本地视频首帧发布时被触发。
+该回调在发布首帧本地视频时触发,触发时机包括: +
该回调在发布首帧本地视频时触发,触发时机包括: +
+
当远端用户首次发送音频流,或音频从离线恢复为在线重新发送音频时触发。
+该回调在以下场景中被触发: +
该回调在 SDK 解码来自某个远端用户的首帧音频时被触发。
+该回调在 SDK 解码来自某个远端用户的首帧音频时被触发。
+
+
该回调在 SDK 收到来自某个远端用户的首帧音频时被触发。
+该回调在接收到并解码远端用户的第一帧音频时触发。
+该回调在接收到并解码远端用户的第一帧音频时触发。
+
+
SDK 在以下任一情况下会触发该回调: +
当远端用户加入频道并发送视频流,或在停止发送视频流 15 秒后重新发送时触发。中断的原因包括:远端用户离开频道、掉线或调用
该回调在接收到并解码首帧远端视频时被触发。
+该回调在以下场景中被触发: +
该回调在以下场景中被触发: +
+
当渲染器接收到远端视频的首帧时触发。
+该回调在渲染器接收到远端视频的首帧时被触发。
+该回调在远端用户的视频首帧被 SDK 渲染时触发。
+该回调在远端用户的视频首帧被 SDK 渲染时触发。
+
+
该回调在本地用户成功加入指定频道时触发。
+该回调在本地用户成功加入指定频道时触发。
+当你调用
该回调在你调用
该回调在调用
该回调在调用
+
调用
该回调在调用
该回调在调用
该回调在调用
该回调在调用
该回调在调用
该回调在调用
+
该回调在加入频道前触发,用于报告本地用户与声网边缘服务器之间连接的网络质量(即 last-mile 网络状况)。调用
该回调在用户加入频道前触发,用于上报本地用户与声网边缘服务器之间连接的 Last-mile 网络质量。在调用
该回调在用户加入频道前,由 SDK 在调用
该回调在用户加入频道前,由 SDK 在调用
该回调在调用
该回调在调用
该回调在调用
+
你可以获取通话的总时长以及 SDK 的收发数据量。
+你可以通过该回调获取通话的总时长以及 SDK 的收发数据量。
+你可以通过该回调获取通话的总时长以及 SDK 的收发数据量。
+在你调用
该回调在你调用
该回调在你调用
该回调在你调用
+
当本地音频流的状态(包括音频采集和编码状态)发生变化时,SDK 会触发该回调报告当前状态,帮助你排查音频异常问题。
+当本地音频流的状态发生变化时,SDK 会触发该回调以报告当前状态,便于你在音频异常时排查问题。
+当本地音频流状态(包括音频采集和编码状态)发生变化时,SDK 会触发该回调以报告当前状态,便于你在出现音频异常时排查问题。
+当本地音频流状态(包括音频采集和编码状态)发生变化时,SDK 会触发该回调以报告当前状态,便于你在出现音频异常时排查问题。
+该回调在本地音频流状态发生变化时被触发。
+该回调在本地音频流状态发生变化时被触发。
+该回调在本地音频流状态发生变化时被触发。
+
+
该回调每两秒触发一次。
+SDK 每两秒触发一次该回调。
+该回调每两秒触发一次。
+该回调每两秒触发一次。
+该回调每两秒触发一次。
+
+
当本地用户成功调用
当本地用户成功调用
当你成功调用
当你成功调用
该回调在本地用户成功注册用户 User Account 或加入频道后被触发。
+该回调在你注册用户 User Account 或加入频道成功后被触发。
+该回调在你注册用户 User Account 或加入频道成功后被触发。
+
+
你可以通过该回调及时了解本地视频流的状态变化,并根据变化原因采取相应措施,以更好地管理和排查视频流相关问题。
+当本地视频状态发生变化时,SDK 会触发该回调,报告当前本地视频状态及其变化原因。你可以通过该回调及时了解本地视频流的状态变化,并根据变化原因采取相应措施,以更好地管理和排查视频流相关问题。
+当本地视频状态发生变化时,SDK 会触发该回调,报告当前本地视频状态及其变化原因。你可以通过该回调及时了解本地视频流的状态变化,并根据变化原因采取相应措施,以更好地管理和排查视频流相关问题。
+SDK 在以下情况下会触发该回调,并将
该回调在以下情况下被触发,状态为
该回调在以下情况下被触发,
该回调在以下情况下被触发,
+
该回调每两秒触发一次。
+SDK 每两秒触发一次该回调。
+该回调每两秒触发一次。
+该回调每两秒触发一次。
+该回调每两秒触发一次。
+
+
当调用
当调用
当你调用
当你调用
该回调在调用
该回调在本地合图过程中发生错误时被触发。
+该回调在本地合图过程中发生错误时被触发。
+
+
该回调在你将
该回调在你将
该回调在你将
该回调在你将
+
该回调报告频道中每个用户的 Last-mile 网络状况。Last-mile 指的是本地设备与声网边缘服务器之间的连接。SDK 每两秒触发一次该回调。如果频道中有多个用户,SDK 会触发多次该回调。该回调通过在频道内发送和接收广播数据包来反馈网络质量。为避免广播风暴导致频道内数据传输量过大,该回调默认最多同时反馈 4 个远端用户的网络质量。
+该回调通过在频道内发送和接收广播数据包来反馈网络质量。过多的广播数据包可能导致广播风暴。为防止广播风暴造成频道内大量数据传输,该回调默认最多同时反馈 4 个远端用户的网络质量。
+该回调每两秒触发一次。
+该回调在 SDK 每两秒检测一次网络质量时被触发。
+该回调在 SDK 每两秒检测一次网络质量时被触发。
+
+
你可以通过该回调获取连接状态及其变化原因。当网络连接中断时,该回调可用于判断中断是由于网络类型变化还是网络状况不佳导致的。
+你可以通过该回调获取连接状态及其变化原因。当网络连接中断时,该回调会指示中断是由于网络类型变化还是由于网络状况不佳导致的。
+该回调在本地用户的连接状态发生变化时触发。你可以通过该回调获取连接状态及其变化原因。当网络连接中断时,该回调会指示中断是由于网络类型变化还是网络状况不佳导致。
+该回调在本地用户的连接状态发生变化时触发。你可以通过该回调获取连接状态及其变化原因。当网络连接中断时,该回调会指示中断是由于网络类型变化还是网络状况不佳导致。
+该回调在本地网络类型发生变化时被触发。
+
+
该回调在 SDK 无法获取设备权限时触发,用于报告无法获取的设备权限类型。
+该回调在 SDK 无法获取设备权限时被触发,用于报告无法获取的权限类型。
+该回调在 SDK 无法获取设备权限时被触发。
+该回调在 SDK 无法获取设备权限时被触发。
+该回调在 SDK 无法获取设备权限时被触发。
+
+
当用户调用
你可以使用该回调监听 SDK 的代理连接状态。例如,当你调用
你可以使用该回调监听 SDK 的代理连接状态。例如,当你调用
该回调在用户调用
该回调在你调用
该回调在你调用
+
当用户因网络问题与服务器断开连接时,SDK 会自动尝试重连,并在重连成功后触发该回调。
+该回调在用户因网络问题与服务器断开连接后,SDK 自动尝试重连并成功重连时触发。
+当用户因网络问题与服务器断开连接后,SDK 自动尝试重连并成功后触发该回调。
+该回调在用户因网络问题与服务器断开连接后,SDK 自动尝试重连并成功重连时被触发。
+该回调在因网络问题与服务器断开连接后,SDK 自动尝试重连并在重新连接成功时触发。
+该回调在因网络问题与服务器断开连接后,SDK 自动尝试重连并在重新连接成功时触发。
+
+
该回调在语音/视频通话频道中的远端用户或直播频道中的主播的音频状态发生变化时被触发,用于报告远端音频流的当前状态。
+当语音/视频通话频道中的远端用户,或直播频道中的主播的音频状态发生变化时,SDK 会触发该回调以报告远端音频流的当前状态。
+当语音/视频通话频道中的远端用户,或直播频道中的主播的音频状态发生变化时,SDK 会触发该回调以报告远端音频流的当前状态。
+当远端用户的音频状态发生变化时触发。
+该回调在远端用户的音频状态发生变化时被触发。
+该回调在远端用户的音频状态发生变化时被触发。
+该回调在远端用户的音频状态发生变化时被触发。
+
+
该回调每两秒触发一次,用于报告每个正在发送音频流的远端用户的传输层统计信息。如果频道中有多个远端用户,SDK 会分别为每个用户触发该回调。
+该回调每两秒触发一次。如果频道中有多个远端用户,SDK 会分别为每个用户触发该回调。
+该回调每两秒触发一次,用于上报每个正在发送音频流的远端用户的传输层统计信息。如果频道中有多个远端用户,SDK 会分别为每个用户触发该回调。
+该回调每两秒触发一次,用于上报每个正在发送音频流的远端用户的传输层统计信息。如果频道中有多个远端用户,SDK 会分别为每个用户触发该回调。
+该回调每两秒触发一次。
+该回调每两秒触发一次。
+
+
该回调报告传输层的统计信息,例如在本地用户接收到远端用户的音频数据包后,数据包的丢失率和网络时延。该回调在通话过程中每 2 秒触发一次。
+该回调上报远端音频流的传输层统计信息,例如本地用户接收到远端用户音频包后的丢包率和网络时延。
+在通话过程中,每当本地用户接收到远端用户发送的音频数据包时,每 2 秒触发一次。
+该回调在通话过程中,当本地用户接收到远端用户发送的音频包时每 2 秒被触发。
+该回调在通话过程中,当你接收到远端用户发送的音频包时,每 2 秒触发一次。
+该回调在通话过程中,当你接收到远端用户发送的音频包时,每 2 秒触发一次。
+
+
如果你调用了
如果你调用了
如果你调用了
如果你调用了
该回调在远端媒体流因网络变化在音频流与视频流之间切换时被触发。
+该回调在远端媒体流因网络不佳降级为纯音频流,或在网络改善后恢复为视频流时被触发。
+该回调在远端媒体流因网络不佳降级为纯音频流,或在网络改善后恢复为视频流时被触发。
+
+
当远端视频流状态发生变化时触发。
+该回调在远端视频状态发生变化时被触发。
+该回调在远端视频状态发生变化时被触发。
+该回调在远端视频状态发生变化时被触发。
+
+
SDK 每两秒为每个远端用户触发一次该回调。如果频道中有多个用户或主播发送视频流,SDK 会相应地多次触发该回调。
+SDK 每两秒为每位远端用户触发一次该回调。如果频道中有多个用户或主播发送视频流,SDK 会相应地多次触发该回调。
+该回调在 SDK 每两秒收集到远端用户的视频流统计信息时被触发。
+该回调每两秒为每位远端用户触发一次。如果频道中有多个用户或主播发送视频流,SDK 会触发多次该回调。
+该回调每两秒为每位远端用户触发一次。如果频道中有多个用户或主播发送视频流,SDK 会触发多次该回调。
+
+
该回调上报传输层的统计信息,例如丢包率和网络时延。该回调在通话过程中,当本地用户接收到远端用户或主播发送的视频包时,每 2 秒触发一次。
+通话过程中,当你接收到远端用户或主播发送的视频包时,每 2 秒触发一次该回调。
+该回调在通话过程中,当本地用户接收到远端用户或主播发送的视频包时,每 2 秒触发一次。
+该回调在通话过程中,每当接收到远端用户或主播发送的视频包时,每 2 秒触发一次。
+该回调在通话过程中,每当接收到远端用户或主播发送的视频包时,每 2 秒触发一次。
+
+
当你调用
该回调在调用
该回调在你调用
该回调在你调用
该回调在你调用
+
收到该回调后,你需要在你的 Token 服务器上生成新的 Token,并通过以下方式之一进行更新: +
该回调在 Token 过期时被触发。收到该回调后,你需要在 Token 服务器上生成新的 Token,并通过以下方式之一更新 Token: +
当 Token 过期时,SDK 会触发该回调。收到该回调后,你需要在你的 Token 服务器上生成一个新的 Token,并可以通过以下方式之一更新 Token: +
当 Token 过期时,SDK 会触发该回调。收到该回调后,你需要在你的 Token 服务器上生成一个新的 Token,并可以通过以下方式之一更新 Token: +
当 Token 过期时触发该回调。
+该回调在 Token 过期时被触发。
+当 Token 过期时触发。
+当 Token 过期时触发。
+
+
该回调用于报告虚拟节拍器的当前状态,指示本地音频流的状态,帮助你在音频异常时排查问题。
+该回调用于报告虚拟节拍器的当前状态,指示本地音频流的状态,帮助你在音频异常发生时排查问题。
+当虚拟节拍器状态发生变化时,SDK 会触发该回调以报告当前虚拟节拍器的状态。该回调指示本地音频流的状态,并帮助你在音频异常发生时排查问题。
+当虚拟节拍器状态发生变化时,SDK 会触发该回调以报告当前虚拟节拍器的状态。该回调指示本地音频流的状态,并帮助你在音频异常发生时排查问题。
+当虚拟节拍器状态发生变化时触发。
+该回调在虚拟节拍器状态发生变化时被触发。
+该回调在虚拟节拍器状态发生变化时被触发。
+该回调在虚拟节拍器状态发生变化时被触发。
+
+
用户加入频道后,SDK 每两秒触发一次该回调。
+该回调在用户加入频道后每两秒触发一次。
+该回调在你加入频道后每两秒触发一次。
+该回调在你加入频道后每两秒触发一次。
+
+
该回调在旁路推流过程中发生事件时被触发。
+该回调在旁路推流过程中发生事件时被触发。
+
+
当旁路推流状态发生变化时,SDK 会触发该回调,并报告对应的 URL 和当前的旁路推流状态。当出现异常时,你可以参考错误码参数中的详细错误信息进行排查。
+该回调用于指示旁路推流的状态。当旁路推流状态发生变化时,SDK 会触发该回调,并返回对应的 URL 地址和当前的推流状态。当出现异常时,你可以参考错误码参数中的详细错误信息进行排查。
+当 RTMP 或 RTMPS 推流状态发生变化时,SDK 会触发该回调,用于报告你调用
当 RTMP 或 RTMPS 推流状态发生变化时,SDK 会触发该回调,用于报告你调用
该回调在旁路推流状态发生变化时被触发。
+该回调在你调用
该回调在你调用
+
调用
该回调在调用
调用
调用
调用
该回调在调用
调用
调用
+
当本地用户收到远端用户通过调用
当你收到远端用户通过调用
当你收到远端用户通过调用
该回调在本地用户收到远端用户通过
该回调在你收到远端用户发送的数据流时被触发。
+该回调在你收到远端用户发送的数据流时被触发。
+
+
该回调在本地用户未能接收到远端用户通过调用
该回调在本地用户未能接收到远端用户通过调用
当本地用户未能接收到远端用户通过调用
当本地用户未能接收到远端用户通过调用
该回调在本地用户未能接收到远端用户通过
该回调在本地用户未收到远端用户发送的数据流时被触发。
+该回调在本地用户未收到远端用户发送的数据流时被触发。
+
+
当收到该回调时,你需要在 Token 服务器上生成一个新的 Token,并通过以下方式之一更新 Token: +
收到该回调时,你需要在 Token 服务器上生成一个新的 Token,并通过以下方式之一更新 Token: +
收到该回调时,你需要在你的 Token 服务器上生成一个新的 Token,并可以通过以下方式之一更新 Token: +
收到该回调时,你需要在你的 Token 服务器上生成一个新的 Token,并可以通过以下方式之一更新 Token: +
SDK 会在 Token 过期前 30 秒触发该回调,提醒你更新 Token。
+该回调在 Token 过期前 30 秒被触发。
+该回调在 Token 过期前 30 秒被触发,提醒你更新 Token。
+该回调在 Token 过期前 30 秒被触发,提醒你更新 Token。
+
+
当你首次接收到视频合图服务器发送的合图视频,或合图布局信息发生变化时,SDK 会触发该回调,报告合图视频中每个子视频流的布局信息。
+该回调在你首次接收到由视频合流服务器发送的合图视频,或混合流的布局信息发生变化时被触发。
+当本地用户首次接收到由视频合图服务器发送的合图视频流,或该视频流的布局信息发生变化时,SDK 会触发该回调,报告该合图视频流中每个子视频流的布局信息。
+当本地用户首次接收到视频合流服务器发送的合图视频,或混合流的布局信息发生变化时触发。
+该回调在你首次接收到由视频合流服务器发送的合图视频,或混合流的布局信息发生变化时被触发。
+该回调在本地用户首次接收到合图视频流,或该视频流的布局信息发生变化时被触发。
+
+
当你调用
当调用
当你在
当你在
该回调在发布端的云端转码配置发生更新时被触发。
+当发布端的云端转码设置更新时触发。
+当发布端的云端转码设置更新时触发。
+
+
该回调在上行网络信息发生变化时被触发。
+当上行网络信息发生变化时触发。
+当上行网络信息发生变化时触发。
+
+
当远端用户调用
当远端用户调用
当远端用户调用
该回调在远端用户调用
该回调在远端用户调用
该回调在远端用户调用
+
一旦视频模块被关闭,用户只能进行语音通话,无法发送或接收任何视频。
+该回调在远端用户调用
当远端用户调用
当远端用户调用
该回调在远端用户调用
该回调在远端用户启用或关闭视频模块时被触发。
+该回调在远端用户调用
该回调在远端用户调用
+
远端用户加入频道后,SDK 会获取该用户的用户 ID 和用户 User Account,并将其缓存在映射表中,然后在本地客户端触发该回调。
+当远端用户加入频道后,SDK 会获取该用户的用户 ID 和用户 User Account,并将其缓存在映射表中,然后在本地客户端触发该回调。
+远端用户加入频道后,SDK 会获取该远端用户的用户 ID 和用户 User Account,并将其缓存在映射表对象中,然后在本地客户端触发该回调。
+远端用户加入频道后,SDK 会获取该远端用户的用户 ID 和用户 User Account,并将其缓存在映射表对象中,然后在本地客户端触发该回调。
+该回调在远端用户加入频道后,SDK 获取到其用户 ID 和用户 User Account 时被触发。
+该回调在远端用户加入频道后,SDK 获取到其用户 ID 和用户 User Account 时被触发。
+该回调在远端用户加入频道后,SDK 获取到其用户 ID 和用户 User Account 时被触发。
+
+
在通信频道中,该回调表示有远端用户加入频道。当本地用户加入频道时,SDK 也会触发该回调报告频道中已有的用户。 +在极速直播频道中,该回调表示有主播加入频道。当主播加入频道时,SDK 也会触发该回调报告频道中已有的主播。声网建议将连麦主播数量限制为 32 人,最多支持 17 路视频主播。
+在通信频道中,该回调表示有远端用户加入频道。当本地用户加入频道时,SDK 也会触发该回调报告频道中已有的用户。在极速直播频道中,该回调表示有主播加入频道。声网建议将连麦主播数量限制为 32 人,最多支持 17 路视频主播。
+在通信频道中,该回调表示有远端用户加入频道。当你加入频道时,SDK 也会触发该回调报告频道中已有的用户。 +在直播频道中,该回调表示有主播加入频道。声网建议将连麦主播数量限制为 32 人,最多支持 17 路视频主播。
+在通信频道中,该回调表示有远端用户加入频道。当你加入频道时,SDK 也会触发该回调报告频道中已有的用户。 +在直播频道中,该回调表示有主播加入频道。声网建议将连麦主播数量限制为 32 人,最多支持 17 路视频主播。
+SDK 在以下任一情况下触发该回调: +
该回调在以下任一情况下被触发: +
该回调在以下任一情况下被触发: +
该回调在以下任一情况下被触发: +
+
当远端用户调用
该回调在远端用户调用
当远端用户调用
当远端用户调用
该回调在远端用户调用
该回调在远端用户或主播停止或恢复发送音频流时被触发。
+该回调在远端用户或主播停止或恢复发送音频流时被触发。
+
+
当远端用户调用
当远端用户调用
当远端用户调用
当远端用户调用
该回调在远端用户调用
该回调在远端用户调用
该回调在远端用户调用
+
用户离线通常有以下两种情况: +
用户离线通常有以下两种原因: +
用户离线通常有两个原因: +
用户离线通常有两个原因: +
当远端用户(通信频道场景)或主播(极速直播频道场景)离开频道时触发该回调。
+该回调在远端用户(在频道场景中)或主播(在极速直播场景中)离开频道时被触发。
+该回调在远端用户(在频道场景中)或主播(在极速直播场景中)离开频道时触发。
+该回调在远端用户(在频道场景中)或主播(在极速直播场景中)离开频道时触发。
+
+
该回调用于报告系统视频设备的状态变化,例如设备被拔出或移除。在 Windows 设备上,如果使用外接摄像头进行视频采集,当外接摄像头被拔出时,视频功能将被禁用。
+
+
该回调在视频发布状态发生变化时触发。
+该回调在视频发布状态发生变化时触发。
+该回调在视频发布状态发生变化时触发。
+该回调在视频发布状态发生变化时触发。
+
+
调用
调用
调用
调用
调用
该回调在调用
该回调在调用
+
该回调在指定用户的视频尺寸或旋转角度发生变化时被触发。
+
+
你可以在该回调中更改视图的配置,例如在视图中显示其他图片。
+该回调在视频停止播放时触发。你可以通过该回调更改视图的配置,例如在视图中显示其他图片。
+该回调在视频停止播放时触发。你可以通过该回调更改视图的配置,例如在视图中显示其他图片。
+该回调在视频停止播放时被触发。
+该回调在视频停止播放时触发。
+该回调在视频停止播放时触发。
+
+
该回调在你订阅远端视频流的状态发生变化时触发。
+该回调在你订阅远端视频流的状态发生变化时触发。
+该回调在本地用户订阅远端视频流的状态发生变化时被触发。
+
+
该回调在调用
该回调在调用
+
如果你调用了
如果你调用了
如果你调用了
如果你调用了
该回调在你设置
该回调在你设置
+
+
+
+
+
该回调用于获取本地设备采集的原始视频数据,并进行预处理。你可以在该回调中直接修改
你可以通过该回调获取本地设备采集的原始视频数据,并根据需要进行预处理。预处理完成后,可以直接在该回调中修改
你可以通过该回调获取本地设备采集的原始视频数据,并根据需要进行预处理。预处理完成后,你可以直接在该回调中修改
你可以通过该回调获取本地设备采集的原始视频数据,并根据需要进行预处理。预处理完成后,你可以直接在该回调中修改
成功注册视频数据观察器后,每次 SDK 采集到视频帧时触发。
+该回调在成功注册视频数据观察器后,每次 SDK 采集到视频帧时被触发。
+该回调在成功注册视频数据观察器后,每次 SDK 采集到视频帧时被触发。
+该回调在成功注册视频数据观察器后,每次 SDK 采集到视频帧时被触发。
++
+
+
+
+
注册视频帧观察器后,该回调会在播放器每次接收到视频帧时触发,并上报视频帧的详细信息。
+
+
当你成功注册视频帧观察器后,SDK 每次接收到视频帧时都会触发该回调。在该回调中,你可以获取编码前的视频数据,并根据具体场景进行处理。处理完成后,可以将处理后的视频数据返回给 SDK。
+在你成功注册视频帧观察器后,SDK 每次接收到视频帧时都会触发该回调。在该回调中,你可以获取编码前的视频数据,并根据具体场景对数据进行处理。处理完成后,可以将处理后的视频数据返回给 SDK。
+在你成功注册视频帧观察器后,SDK 每次接收到视频帧时都会触发该回调。在该回调中,你可以获取编码前的视频数据,并根据具体场景对其进行处理。处理完成后,你可以将处理后的视频数据返回给 SDK。
+在你成功注册视频帧观察器后,SDK 每次接收到视频帧时都会触发该回调。在该回调中,你可以获取编码前的视频数据,并根据具体场景对其进行处理。处理完成后,你可以将处理后的视频数据返回给 SDK。
+当 SDK 在编码前接收到视频帧时触发。
+该回调在 SDK 每次接收到编码前的视频帧时被触发。
+该回调在每次 SDK 在编码前接收到视频帧时被触发。
+该回调在每次 SDK 在编码前接收到视频帧时被触发。
++
+
+
+
+
当你成功注册视频帧观察器后,SDK 每次接收到远端用户发送的视频帧时会触发该回调。在该回调中,你可以在渲染前获取远端的视频数据,并根据具体场景进行处理。默认返回的视频格式为
在你成功注册视频帧观察器后,SDK 每次接收到远端用户发送的视频帧时会触发该回调。你可以在渲染前获取远端发送的视频数据,并根据具体场景进行处理。通过该回调获取的视频帧默认格式可能为
在你成功注册视频帧观察器后,SDK 每次接收到视频帧时都会触发该回调。在该回调中,你可以在渲染前获取远端发送的视频数据,并根据具体场景进行处理。通过该回调获取的视频格式默认为 I420 或
在你成功注册视频帧观察器后,SDK 每次接收到视频帧时都会触发该回调。在该回调中,你可以在渲染前获取远端发送的视频数据,并根据具体场景进行处理。通过该回调获取的视频格式默认为 I420 或
该回调在每次 SDK 接收到远端用户发送的视频帧时触发。
+该回调在 SDK 接收到远端用户发送的视频帧时被触发。
+该回调在 SDK 每次接收到远端用户发送的视频帧时被触发。
+该回调在 SDK 每次接收到远端用户发送的视频帧时被触发。
++
+
+
+
+
该回调在异步获取媒体资源信息的操作完成时被触发。
+
+
当播放器的音量发生变化时,SDK 会触发该回调。
+该回调在播放器音量发生变化时被触发。
+当播放器音量发生变化时,SDK 会触发该回调。
+当播放器音量发生变化时,SDK 会触发该回调。
+
+
调用
如果你需要监听播放器事件,必须先调用
如果你需要监听播放器事件,必须先调用
如果你需要监听播放器事件,必须先调用
当播放器事件发生时,SDK 会触发该回调。
+该回调在播放器事件发生变化时被触发。
+该回调在播放器事件发生变化时被触发。
+该回调在播放器事件发生变化时被触发。
+
+
如果你需要从媒体流中获取元数据,必须先调用
调用
如果你需要从输入在线媒体流中获取元数据,必须先调用
如果你需要从输入在线媒体流中获取元数据,必须先调用
当 SDK 从正在播放的媒体流中解析出元数据后,会触发该回调报告元数据类型及其内容。
+该回调在 SDK 解析播放器正在播放的媒体流中的附加信息后触发,报告数据类型及其具体内容。
+该回调在 SDK 从输入在线媒体流中解析出元数据后触发,用于上报数据的类型和内容。
+该回调在 SDK 从输入在线媒体流中解析出元数据后触发,用于上报数据的类型和内容。
+
+
如果你需要获取播放器和媒体流的信息,必须先调用
你可以调用
如果你希望获取播放器或媒体流的信息,需要先调用
如果你希望获取播放器或媒体流的信息,需要先调用
当播放器或媒体流的信息发生变化时,SDK 会触发此回调。
+该回调在播放器和媒体流信息发生变化时被触发。
+当播放器或媒体流信息发生变化时,SDK 会触发该回调。
+当播放器或媒体流信息发生变化时,SDK 会触发该回调。
+
+
该回调在媒体播放过程中每秒触发一次。
+该回调在媒体资源播放过程中每秒触发一次。
+该回调在媒体资源播放过程中每秒触发一次。
+该回调在媒体资源播放过程中每秒触发一次。
+
+
如果你需要监控播放器播放的视频流的分辨率变化,必须先调用
你必须先调用
如果你需要监控播放器正在播放的视频流的分辨率变化,必须先调用
如果你需要监控播放器正在播放的视频流的分辨率变化,必须先调用
当视频流的分辨率发生变化时,SDK 会触发该回调以报告当前视频的宽度和高度。
+该回调在视频流的分辨率发生变化时被触发,报告当前视频的宽度和高度。
+该回调在视频流的分辨率发生变化时被触发,报告当前视频的宽度和高度。
+该回调在视频流的分辨率发生变化时被触发,报告当前视频的宽度和高度。
+
+
如果你需要监听播放器状态的变化,必须先调用
如果你需要监听播放器状态的变化,必须先调用
如果你需要监听播放器状态的变化,必须先调用
如果你需要监听播放器状态的变化,必须先调用
当播放器状态发生变化时,SDK 会触发该回调以报告当前状态和之前的状态。
+该回调在播放器状态发生变化时被触发。
+该回调在播放器状态发生变化时被触发,用于报告当前状态和之前的状态。
+该回调在播放器状态发生变化时被触发,用于报告当前状态和之前的状态。
+
+
+
+
+
用于描述人脸在本地视频中的位置信息,包括坐标、尺寸和与设备的距离。
+
+
+
+
+
+
+
你可以在以下 API 中传入
你可以在以下接口中传入
你可以在以下 API 中传入
你可以在以下 API 中传入
+
+
+
+
+
用于表示本地或远端用户的音量、语音活动状态和音高信息。
+用于表示本地或远端用户的音量、语音活动状态和音高信息。
+
+
+
+
+
+
支持在同一个
支持在同一个
支持在同一个
支持在同一个
+
+
+
+
+
用于表示设备在不同视频质量下的硬件和软件解码能力等级。
+用于表示设备在不同视频质量下的硬件和软件解码能力等级。
+
+
+
+
SDK 会将视频截图和附加信息上传至声网服务器。上传完成后,声网服务器会将回调通知和附加信息发送至你的服务器。
+用于设置截图和上传的相关参数。
+用于配置本地截图上传功能。上传完成后,声网服务器会将附加信息和回调通知发送至你的服务器。
+用于配置本地截图上传功能。上传完成后,声网服务器会将附加信息和回调通知发送至你的服务器。
+
+
+
下表展示了在不同参数组合下 SDK 的行为:
+
下表展示了在不同参数组合下 SDK 的行为:
+
下表展示了在不同参数设置下 SDK 的行为:
+
下表展示了在不同参数设置下 SDK 的行为:
+
+
+
+
+
+
+
+
用于配置内置加密的参数。
+用于配置内置加密的参数。
+
+
+
+
+
+
+
+
该接口用于接收编码后的音频帧事件回调。
+该接口用于接收编码后的音频帧事件回调。
+将音频帧数据传递给你的应用程序。
+将音频帧数据传递给你的应用程序。
+该协议用于接收和处理来自媒体播放器的音频帧数据回调。
+该协议用于接收和处理来自媒体播放器的音频帧数据回调。
+
+
如果你想同时播放多个媒体源,请创建多个媒体播放器源对象。
+如果你想同时播放多个媒体源,可以创建多个媒体播放器源对象。
你可以使用该协议提供的方法设置缓存参数、删除缓存文件以及获取缓存信息。
+你可以使用该协议提供的方法设置缓存参数、删除缓存文件以及获取缓存信息。
+播放器会持续调用该接口,请求你填充需要播放的数据流。
+你可以通过实现
你可以通过实现
你可以使用
你可以使用
你可以通过实现该协议,在音频或视频录制过程中接收录制状态更新和相关信息。
+你可以通过实现该协议,在音频或视频录制过程中接收录制状态更新和相关信息。
+建议避免在关键线程中执行耗时操作。
+建议避免在关键线程中执行耗时操作。
+该类用于管理声网提供的音乐内容资源,支持音乐内容的搜索、加载、播放等功能。
+声网建议在同一线程中调用
SDK 通过该类向 App 发送回调事件通知。你可以继承该类中的方法来获取所需的事件通知。该类中的所有方法均提供默认(空)实现,你可以按需选择性地继承部分方法。在回调方法中,应避免执行耗时操作或调用阻塞 API,否则可能影响 SDK 的正常运行。
+SDK 通过
SDK 通过
扩展了
扩展了
你可以实现该协议中的方法以按需处理接收到的编码后视频帧。
+你可以实现该协议中的方法以按需处理接收到的编码后视频帧。
+你可以通过实现
你可以通过实现该协议中的方法,接收并处理本地设备采集或远端用户发送的视频帧。
+你可以通过实现该协议中的方法,接收并处理本地设备采集或远端用户发送的视频帧。
+
+
+
+
+
+
如需启用带转码推流的高级功能,请[联系技术支持](https://ticket.shengwang.cn/)。
+如果你希望启用带转码推流的高级功能,请[联系技术支持](https://ticket.shengwang.cn/)。
+如果你希望启用带转码推流的高级功能,请[联系技术支持](https://ticket.shengwang.cn/)。
+
+
+
+
+
+
+
用于设置本地客户端的视频合图参数。
+用于设置本地客户端的视频合图参数。
+
+
+
+
+
用于设置低光增强的模式和强度等级。
+用于设置低光增强的模式和强度等级。
+
+
+
+
+
+
+
+
+
+
+
用于描述当前请求中的音乐资源列表信息,包括资源数量、分页信息和当前页的音乐资源详情。
+
+
+
+
+
+
+
+
+
+
+
+
+
如果不设置该参数,SDK 默认选择整个屏幕或窗口作为目标区域。
+
+
用于汇报远端用户加入频道后的音频统计信息。
+
+
+
+
+
+
用于设置实时视频中水印图像和背景图像的属性。
+
+
+
+
+
+
仅当
仅当
仅当
+
+
用于设置屏幕共享的视频编码参数。
+
+
用于设置屏幕共享的视频编码参数。
+
+
该信息通过
+
仅当参数
+
+
用于设置编码参数,包括分辨率、码率和帧率。
+
+
+
用于设置远端用户或媒体播放器相对于本地用户的空间音频参数。
+用于设置远端用户或媒体播放器相对于本地用户的空间音频参数。
+
+
+
+
可在
+
用于设置每位主播在合流转码中的视频位置、图层顺序、透明度以及音频通道。
+用于设置每位主播在合流转码中的视频位置、图层顺序、透明度以及音频通道。
+
+
用于配置本地合图中各个视频流的位置、尺寸、图层等信息。
+
+
+
+
+
+
+
+
你可以自定义分辨率,或从预设分辨率中选择。支持设置不同的编码码率和帧率,以适配不同的频道场景类型,还可以指定视频编码方向、镜像模式和编码器优先策略等。
+
+
+
注意,缓冲区是指向指针的指针。该接口无法修改缓冲区的指针,但可以修改缓冲区的内容。
+缓冲区提供的是指针的指针。该接口无法修改缓冲区的指针,但可以修改缓冲区的内容。
+缓冲区提供的是指针的指针。该接口无法修改缓冲区的指针,但可以修改缓冲区的内容。
+
+
描述混流中某个子视频流在合流画布中的位置、尺寸和显示状态。
+
+
描述合图视频的布局信息。
+
+
+
+
+
用于定义水印图像的缓冲区数据结构。
+包括图像的宽度、高度、长度、图像数据缓冲区和格式。
+包括图像的宽度、高度、长度、图像数据缓冲区和格式。
+
+
+
用于配置添加的水印图像。
+用于设置水印图像的显示配置。
+用于设置水印图像的显示配置。
+
+
+
仅当用户角色设置为
仅当用户角色设置为
仅当用户角色设置为
为了获得更好的音效效果,声网建议在使用预设音效效果前调用
为了获得更好的音效效果,Agora 建议在使用预设音效前调用
为了获得更好的音效效果,Agora 建议在使用预设音效前调用
在
在
在
在
在
在需要增强真实感的场景中,例如音乐会,本地用户可能需要采集立体声并将立体声音频信号发送给远端用户。例如,歌手、吉他手和鼓手站在舞台上的不同位置,音频采集设备采集他们的立体声音频并将其发送给远端用户。远端用户可以从不同方向听到歌曲、吉他和鼓声,就像置身于音乐厅中一样。你可以设置双声道处理以实现立体声。声网推荐以下设置: +
在需要增强真实感的场景中,例如音乐会,本地用户可能需要采集立体声并将其发送给远端用户。例如,歌手、吉他手和鼓手站在舞台的不同位置,音频采集设备采集他们的立体声音频并将其发送给远端用户。远端用户可以从不同方向听到歌曲、吉他和鼓声,就像置身于观众席一样。你可以通过设置双声道处理来实现立体声。声网推荐以下设置: +
在需要增强真实感的场景中,例如音乐会,本地用户可能需要采集立体声并将立体声音频信号发送给远端用户。例如,歌手、吉他手和鼓手站在舞台上的不同位置,音频采集设备采集他们的立体声音频并将其发送给远端用户。远端用户可以从不同方向听到歌曲、吉他和鼓声,就像置身于音乐厅中一样。你可以设置双声道处理以实现立体声。声网推荐以下设置: +
防抖效果依次增强:1 < 2 < 3,延迟也随之增加。
+防抖效果按(1)<(2)<(3)的顺序增强,延迟也会相应增加。
+声网推荐使用
声网推荐使用
声网推荐使用
声网推荐使用
在
在
RTC SDK 支持用户同时加入多个频道,可以同时在多个频道中接收和发布音视频流。
+