视频基础功能
disableVideo
关闭视频模块。
public abstract int disableVideo();
该方法用于关闭视频模块。
调用时机
- 如果在加入频道前调用,则开启纯音频模式。
- 如果在加入频道后调用,则由视频模式切换为纯音频模式,然后再调用 enableVideo 方法可开启视频模式。
调用限制
- 该方法设置的是内部引擎为禁用状态,在离开频道后仍然有效。
- 调用该方法会重置整个引擎,响应时间较慢。你可以根据实际需求用以下方法来独立控制视频模块的某一项功能:
- enableLocalVideo: 是否启动摄像头采集并创建本地视频流。
- muteLocalVideoStream: 是否发布本地视频流。
- muteRemoteVideoStream: 是否接收并播放远端视频流。
- muteAllRemoteVideoStreams: 是否接收并播放所有远端视频流。
相关回调
成功调用该方法后,远端会触发 onUserEnableVideo (false
) 回调。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
enableLocalVideo
开关本地视频采集。
public abstract int enableLocalVideo(boolean enabled);
详情
该方法禁用或重新启用本地视频采集,不影响接收远端视频。
调用 enableVideo 后,本地视频采集即默认开启。
如果你在频道内调用 enableLocalVideo(false
) 关闭本地视频采集,也会同时停止在频道内发布视频流。如果想要重新开启,则可调用 enableLocalVideo(true
),然后调用 updateChannelMediaOptions 并设置 options 参数,将本地采集的视频流发布到频道中。
成功禁用或启用本地视频采集后,远端会触发 onRemoteVideoStateChanged 回调。
- 该方法在加入频道前后都能调用。
- 该方法设置内部引擎为启用状态,在离开频道后仍然有效。
参数
- enabled
是否开启本地视频采集。
true
:(默认)开启本地视频采集。false
: 关闭本地视频采集。关闭后,远端用户会接收不到本地用户的视频流;但本地用户依然可以接收远端用户的视频流。设置为false
时,该方法不需要本地有摄像头。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
enableVideo
启用视频模块。
public abstract int enableVideo();
视频模块默认为关闭状态,需要调用该方法启用。如果后续需要关闭视频模块,需调用 disableVideo 方法。
调用时机
- 如果在加入频道前调用,则开启视频模块。
- 如果在纯音频通话中调用,则音频通话将自动切换为视频通话。
调用限制
- 该方法设置的是内部引擎为启用状态,在离开频道后仍然有效。
- 调用该方法会重置整个引擎,响应时间较慢。你可以根据实际需求用以下方法来独立控制视频模块的某一项功能:
- enableLocalVideo: 是否启动摄像头采集并创建本地视频流。
- muteLocalVideoStream: 是否发布本地视频流。
- muteRemoteVideoStream: 是否接收并播放远端视频流。
- muteAllRemoteVideoStreams: 是否接收并播放所有远端视频流。
- 在频道内调用该方法时,会重置 enableLocalVideo、muteRemoteVideoStream 和 muteAllRemoteVideoStreams 的设置,需谨慎使用。
相关回调
成功调用该方法后,远端会触发 onRemoteVideoStateChanged 回调。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
queryCodecCapability
查询 SDK 支持的视频编解码能力。
public abstract CodecCapInfo[] queryCodecCapability();
详情
返回值
- 如果调用成功,则返回 CodecCapInfo 数组,表示 SDK 的视频编码能力。
- 如果调用超时,请修改调用逻辑,不要在主线程中调用该方法。
setVideoEncoderConfiguration
设置视频编码属性。
public abstract int setVideoEncoderConfiguration(VideoEncoderConfiguration config);
设置本地视频的编码属性。每一种视频编码属性对应一系列视频相关参数设置,包含分辨率、帧率和码率。
调用时机
该方法在加入频道前后都能调用。如果用户在加入频道后不需要重新设置视频编码属性,则建议在 enableVideo 前调用该方法,可以加快首帧出图的时间。
调用限制
- 该方法和 getMirrorApplied 方法均支持设置镜像效果,声网建议你仅选择一种方法进行设置,同时使用两种方法会导致镜像效果叠加从而造成设置镜像失败。
- 该方法的 config 参数设置是在理想网络状态下能达到的最大值。如果网络状态不好,视频引擎便不能使用该 config 渲染本地视频,它会自动降低到一个合适的视频参数设置。
参数
- config
- 视频编码参数配置。详见 VideoEncoderConfiguration。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
setVideoEncoderConfigurationEx
设置视频编码属性。
public abstract int setVideoEncoderConfigurationEx(
VideoEncoderConfiguration config, RtcConnection connection);
设置本地视频的编码属性。每一种视频编码属性对应一系列视频相关参数设置,包含分辨率、帧率和码率。
调用时机
该方法需要在 joinChannelEx 之后调用。
调用限制
该方法的 config 参数设置是在理想网络状态下能达到的最大值。如果网络状态不好,视频引擎便不能使用该 config 渲染本地视频,它会自动降低到一个合适的视频参数设置。
参数
- config
- 视频编码参数配置。详见 VideoEncoderConfiguration。
- connection
- Connection 信息。详见 RtcConnection。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
setVideoScenario
设置视频业务场景。
public abstract int setVideoScenario(Constants.VideoScenario scenarioType);
详情
成功调用该方法设置视频业务场景后,SDK 会基于指定场景启用最佳实践策略,自动调整关键性能指标,进而优化视频体验质量。
参数
- scenarioType
- 视频业务场景。详见 VideoScenario。APPLICATION_SCENARIO_MEETING (1) 适用于会议场景。SDK 会针对该场景启用以下策略:
- 针对会议场景对小流码率要求较高的情况,自动启用多项抗弱网技术,提升小流的抗弱网能力,确保多路流订阅时接收端的流畅性。
- 实时监测接收端大流的订阅人数,根据订阅人数动态调节大流配置:
- 无人订阅大流时,会自动降低大流的码率和帧率,节省上行带宽和消耗。
- 有人订阅大流时,大流会重置为用户最近一次调用 setVideoEncoderConfiguration 时的 VideoEncoderConfiguration 配置。如果用户此前没有进行设置,则使用如下值:
- 视频分辨率:960 × 540
- 视频帧率:15 fps
- 码率:1000 Kbps
- 实时监测接收端小流的订阅人数,根据订阅人数动态开启和关闭小流: 信息如果用户已调用 setDualStreamMode [2/2] 将小流设置为始终不发送 (DISABLE_SIMULCAST_STREAM),会议场景对小流的动态开关不生效。
- 无人订阅小流时,自动关闭小流,节省上行带宽和消耗。
- 有人订阅小流时,开启小流并重置为用户最近一次调用 setDualStreamMode [2/2] 时的 SimulcastStreamConfig 配置。如果用户此前没有进行设置,则使用如下值:
- 视频分辨率:480 × 272
- 视频帧率:15 fps
- 码率:500 Kbps
APPLICATION_SCENARIO_1V1 (2) 适用于视频 1v1 通话场景。针对该场景低延迟、高画质的体验要求,SDK 进行了策略调优,提升了画质、首帧出图、中低端机延迟及弱网流畅度等性能表现。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
- -1:一般性的错误(未明确归类)。
- -4:不支持设置视频业务场景。可能的原因是当前使用的是音频 SDK。
- -7:RtcEngine 对象尚未初始化。你需要在调用该方法前成功初始化 RtcEngine 对象。
startPreview [1/2]
开启视频预览。
public abstract int startPreview();
该方法用于启动本地视频预览。
调用时机
该方法必须在 enableVideo 和 setupLocalVideo 之后调用。
调用限制
- 本地预览默认开启镜像功能。
- 在离开频道后,本地预览依然处于开启状态。你需要调用 stopPreview [1/2] 关闭本地预览。
返回值
- 0:方法调用成功。
- < 0:方法调用失败。详见错误码了解详情和解决建议。
startPreview [2/2]
开启视频预览并指定预览的视频源。
public abstract int startPreview(Constants.VideoSourceType sourceType);
该方法用于启动本地视频预览,并指定出现在预览画面中的视频源。
调用时机
该方法必须在 enableVideo 和 setupLocalVideo 之后调用。
调用限制
- 本地预览默认开启镜像功能。
- 在离开频道后,本地预览依然处于开启状态。你需要调用 stopPreview [1/2] 关闭本地预览。
参数
- sourceType
- 视频源的类型,详见 VideoSourceType。
返回值
- 0:方法调用成功。
- < 0:方法调用失败。详见错误码了解详情和解决建议。
stopPreview [1/2]
停止视频预览。
public abstract int stopPreview();
适用场景
调用 startPreview [1/2] 开启预览后,如果你想关闭本地视频预览,请调用该方法。
调用时机
请在加入频道前或离开频道后调用该方法。
调用限制
无。
返回值
- 0:方法调用成功。
- < 0:方法调用失败。详见错误码了解详情和解决建议。
stopPreview [2/2]
停止视频预览。
public abstract int stopPreview(Constants.VideoSourceType sourceType);
适用场景
调用 startPreview [2/2] 开启预览后,如果你想关闭本地视频预览,请调用该方法。
调用时机
请在加入频道前或离开频道后调用该方法。
调用限制
无。
参数
- sourceType
- 视频源的类型,详见 VideoSourceType。
返回值
- 0:方法调用成功。
- < 0:方法调用失败。详见错误码了解详情和解决建议。
onFirstLocalVideoFrame
已显示本地视频首帧回调。
public void onFirstLocalVideoFrame(
Constants.VideoSourceType source, int width, int height, int elapsed) {}
详情
本地视频首帧显示在本地视图上时,SDK 会触发此回调。
参数
- source
- 视频源的类型。详见 VideoSourceType。
- width
- 本地渲染视频的宽 (px) 。
- height
- 本地渲染视频的高 (px)。
- elapsed
- 从调用 joinChannel [1/2] 或 joinChannel [2/2] 加入频道时到发生此事件过去的时间(毫秒)。如果在加入频道前调用了 startPreview [1/2]/startPreview [2/2],则该参数表示从调用 startPreview [1/2] 或 startPreview [2/2] 开启本地视频预览到发生此事件过去的时间。
onFirstLocalVideoFramePublished
已发布本地视频首帧回调。
public void onFirstLocalVideoFramePublished(Constants.VideoSourceType source, int elapsed) {}
详情
- 开启本地视频模块的情况下,调用 joinChannel [1/2] 或 joinChannel [2/2] 成功加入频道后。
- 调用 muteLocalVideoStream(
true
),再调用 muteLocalVideoStream(false
) 后。 - 调用 disableVideo,再调用 enableVideo 后。
- 调用 pushExternalVideoFrameById [1/2] 成功向 SDK 推送视频帧后。
参数
- source
- 视频源的类型。详见 VideoSourceType。
- elapsed
- 从调用 joinChannel [1/2] 或 joinChannel [2/2] 方法到触发该回调的时间间隔(毫秒)。
onFirstRemoteVideoDecoded
已接收到远端视频并完成解码回调。
public void onFirstRemoteVideoDecoded(int uid, int width, int height, int elapsed) {}
详情
- 远端用户首次上线后发送视频。
- 远端用户视频离线再上线后发送视频。出现这种中断的可能原因包括:
- 远端用户离开频道。
- 远端用户掉线。
- 远端用户调用 disableVideo 方法关闭视频模块。
参数
- uid
- 用户 ID,指定是哪个用户的视频流。
- width
- 视频流宽(px)。
- height
- 视频流高(px)。
- elapsed
- 从本地调用 joinChannel [1/2] 或 joinChannel [2/2] 开始到该回调触发的延迟(毫秒)。
onFirstRemoteVideoFrame
onLocalVideoStateChanged
本地视频状态发生改变回调。
public void onLocalVideoStateChanged(Constants.VideoSourceType source, int state, int reason) {}
本地视频的状态发生改变时,SDK 会触发该回调,报告当前的本地视频状态以及状态改变的原因。
适用场景
你可以通过该回调及时了解本地视频流的状态变化,并根据状态改变的原因采取相应的措施,更好地管理和调试视频流相关的问题。
触发时机
- SDK 会在如下情况触发该回调,且 state 为 LOCAL_VIDEO_STREAM_STATE_FAILED,reason 为
LOCAL_VIDEO_STREAM_REASON_CAPTURE_FAILURE
:- Android 9 及以上版本,App 切后台一段时间后,系统会收回相机权限。
- Android 6 及以上版本,如果相机被第三方应用占用一段时间后释放,则 SDK 会触发该回调,并报告 onLocalVideoStateChanged(
LOCAL_VIDEO_STREAM_STATE_CAPTURING,LOCAL_VIDEO_STREAM_REASON_OK
) 回调。 - 摄像头正常启动,但连续 4 秒都没有输出采集的视频。
- 当摄像头输出采集的视频帧时,如果 SDK 检测到连续 15 个重复的视频帧,会触发该回调,且 state 为 LOCAL_VIDEO_STREAM_STATE_CAPTURING,reason 为 LOCAL_VIDEO_STREAM_REASON_CAPTURE_FAILURE。 信息帧重复检测仅针对分辨率大于 200 × 200、帧率大于等于 10 fps、码率小于 20 Kbps 的视频帧。
使用限制
对某些机型而言,当本地视频采集设备正在使用中时,SDK 不会在本地视频状态发生改变时触发该回调,你需要自行做超时判断。
参数
- source
- 视频源的类型。详见 VideoSourceType。
- state
- LOCAL_VIDEO_STREAM_STATE_STOPPED (0): 本地视频默认初始状态。
- LOCAL_VIDEO_STREAM_STATE_CAPTURING (1): 本地视频采集设备启动成功。
- LOCAL_VIDEO_STREAM_STATE_ENCODING (2): 本地视频首帧编码成功。
- LOCAL_VIDEO_STREAM_STATE_FAILED (3): 本地视频启动失败。
- reason
- LOCAL_VIDEO_STREAM_REASON_OK (0): 本地视频状态正常。
- LOCAL_VIDEO_STREAM_REASON_FAILURE (1): 出错原因不明确。
- LOCAL_VIDEO_STREAM_REASON_DEVICE_BUSY (3): 本地视频采集设备正在使用中。请提示用户检查摄像头是否被其他 App 占用,或者尝试重新加入频道。
- LOCAL_VIDEO_STREAM_REASON_CAPTURE_FAILURE (4): 本地视频采集失败。请提示用户检查视频采集设备是否正常工作,检查摄像头是否被其他 App 占用,或者尝试重新加入频道。
- LOCAL_VIDEO_STREAM_REASON_CODEC_NOT_SUPPORT (5):本地视频编码失败。
- LOCAL_VIDEO_STREAM_REASON_DEVICE_NOT_FOUND (8):找不到本地视频采集设备。需检查摄像头是否与设备正常连接、摄像头是否正常工作,或者尝试重新加入频道。
- LOCAL_VIDEO_STREAM_REASON_DEVICE_INTERRUPT (14):视频采集中断。可能的原因是:
- 摄像头被其他 App 占用。请提示用户检查摄像头是否被其他 App 占用。
- 设备已锁屏,或当前 App 已被切换到后台。可以使用前台服务通知操作系统,确保 App 在切换到后台时仍可采集视频。详见为什么部分 Android 版本应用锁屏或切后台后采集音视频无效?。
- LOCAL_VIDEO_STREAM_REASON_DEVICE_FATAL_ERROR (15):视频采集设备出错。请提示用户关闭并重新启动摄像头以恢复功能,如果该操作不能解决问题,请检查摄像头是否出现硬件故障。
onLocalVideoStats
本地视频流统计信息回调。
public void onLocalVideoStats(Constants.VideoSourceType source, LocalVideoStats stats) {}
详情
该回调描述本地设备发送视频流的统计信息,每 2 秒触发一次。
参数
- source
- 视频源的类型。详见 VideoSourceType。
- stats
- 本地视频流统计信息。详见 LocalVideoStats。
onRemoteVideoStateChanged
远端视频状态发生改变回调。
public void onRemoteVideoStateChanged(int uid, int state, int reason, int elapsed) {}
详情
参数
- uid
- 发生视频状态改变的远端用户 ID。
- state
- 远端视频流状态:
- REMOTE_VIDEO_STATE_STOPPED (0):远端视频默认初始状态。在 REMOTE_VIDEO_STATE_REASON_LOCAL_MUTED (3)、REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED (5) 或 REMOTE_VIDEO_STATE_REASON_REMOTE_OFFLINE (7) 的情况下,会报告该状态。
- REMOTE_VIDEO_STATE_STARTING (1):本地用户已接收远端视频首包。
- REMOTE_VIDEO_STATE_DECODING (2): 远端视频流正在解码,正常播放。在 REMOTE_VIDEO_STATE_REASON_NETWORK_RECOVERY (2)、REMOTE_VIDEO_STATE_REASON_LOCAL_UNMUTED (4)、REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED (6) 或 REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK_RECOVERY (9) 的情况下,会报告该状态。
- REMOTE_VIDEO_STATE_FROZEN (3):远端视频流卡顿。在 REMOTE_VIDEO_STATE_REASON_NETWORK_CONGESTION (1) 或 REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK (8) 的情况下,会报告该状态。
- REMOTE_VIDEO_STATE_FAILED (4):远端视频流播放失败。在 REMOTE_VIDEO_STATE_REASON_INTERNAL (0) 的情况下,会报告该状态。
- reason
- 远端视频流状态改变的具体原因:
- REMOTE_VIDEO_STATE_REASON_INTERNAL (0):内部原因。
- REMOTE_VIDEO_STATE_REASON_NETWORK_CONGESTION (1):网络阻塞。
- REMOTE_VIDEO_STATE_REASON_NETWORK_RECOVERY (2):网络恢复正常。
- REMOTE_VIDEO_STATE_REASON_LOCAL_MUTED (3):本地用户停止接收远端视频流或本地用户禁用视频模块。
- REMOTE_VIDEO_STATE_REASON_LOCAL_UNMUTED (4):本地用户恢复接收远端视频流或本地用户启动视频模块。
- REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED (5):远端用户停止发送视频流或远端用户禁用视频模块。
- REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED (6):远端用户恢复发送视频流或远端用户启用视频模块。
- REMOTE_VIDEO_STATE_REASON_REMOTE_OFFLINE (7):远端用户离开频道。
- REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK (8):远端视频流已回退为音频流。
- REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK_RECOVERY (9):回退的远端音频流恢复为视频流。
- REMOTE_VIDEO_STATE_REASON_CODEC_NOT_SUPPORT (13):本地的视频解码器不支持对收到的远端视频流进行解码。
- elapsed
- 从本地用户调用 joinChannel [2/2] 方法到发生本事件经历的时间,单位为毫秒。
onRemoteVideoStats
通话中远端视频流的统计信息回调。
public void onRemoteVideoStats(RemoteVideoStats stats) {}
详情
该回调描述远端用户在通话中端到端的视频流统计信息, 针对每个远端用户/主播每 2 秒触发一次。如果远端同时存在多个用户/主播, 该回调每 2 秒会被触发多次。
参数
- stats
- 远端视频统计数据。详见 RemoteVideoStats。
onRemoteVideoTransportStats
通话中远端视频流传输的统计信息回调。
public void onRemoteVideoTransportStats(int uid, int delay, int lost, int rxKBitRate) {}
详情
该回调描述远端用户通话中端到端的网络统计信息,通过视频包计算,用客观的数据,如丢包、 网络延迟等,展示当前网络状态。
通话中,当用户收到远端用户/主播发送的视频数据包后,会每 2 秒触发一次该回调。
参数
- uid
- 用户 ID,指定是哪个用户/主播的视频包。
- delay
- 视频包从发送端到接收端的延时(毫秒)。
- lost
- 视频包从发送端到接收端的丢包率 (%)。
- rxKBitRate
- 远端视频包的接收码率(Kbps)。
onUserEnableLocalVideo
远端用户开/关本地视频采集回调。
public void onUserEnableLocalVideo(int uid, boolean enabled) {}
详情
- REMOTE_VIDEO_STATE_STOPPED(0) 和 REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED(5)。
- REMOTE_VIDEO_STATE_DECODING (2) 和 REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED(6)。
该回调是由远端用户调用 enableLocalVideo 方法开启或关闭视频采集触发的。
参数
- uid
- 用户 ID,提示是哪个用户的视频流。
- enabled
- 远端用户是否启用视频采集:
-
true
: 该用户已启用视频功能。启用后,其他用户可以接收到该用户的视频流。 -
false
: 该用户已关闭视频功能。关闭后,该用户仍然可以接收其他用户的视频流,但其他用户接收不到该用户的视频流。
-
onUserEnableVideo
远端用户开/关视频模块回调。
public void onUserEnableVideo(int uid, boolean enabled) {}
详情
关闭视频功能是指该用户只能进行语音通话,不能显示、发送自己的视频,也不能接收、显示别人的视频。
该回调是由远端用户调用 enableVideo 或 disableVideo 方法开启或关闭视频模块触发的。
参数
- uid
- 用户 ID,提示是哪个用户的视频流。
- enabled
-
true
: 该用户已启用视频功能。 -
false
: 该用户已关闭视频功能。
-
onUserMuteVideo
远端用户取消或恢复发布视频流回调。
public void onUserMuteVideo(int uid, boolean muted) {}
详情
当远端用户调用 muteLocalVideoStream 取消或恢复发布视频流时,SDK 会触发该回调向本地用户报告远端用户的发流状况。
参数
- uid
- 远端用户 ID。
- muted
- 远端用户是否取消发布视频流:
true
: 取消发布视频流。false
: 发布视频流。
onVideoPublishStateChanged
视频发布状态改变回调。
public void onVideoPublishStateChanged(Constants.VideoSourceType source, String channel,
int oldState, int newState, int elapseSinceLastState) {}
参数
- channel
- 频道名。
- source
- 视频源的类型。详见 VideoSourceType。
- oldState
- 之前的发布状态,详见 STREAM_PUBLISH_STATE。
- newState
- 当前的发布状态,详见 STREAM_PUBLISH_STATE。
- elapseSinceLastState
- 两次状态变化时间间隔(毫秒)。
onVideoSizeChanged
本地或远端视频大小和旋转信息发生改变回调。
public void onVideoSizeChanged(
Constants.VideoSourceType source, int uid, int width, int height, int rotation) {}
参数
- source
- 视频源的类型。详见 VideoSourceType。
- uid
- 图像尺寸和旋转信息发生变化的用户 ID(本地用户的 uid 为 0。此时视频为本地用户的视频预览)。
- width
- 视频流的宽度(像素)。
- height
- 视频流的高度(像素)。
- rotation
- 旋转信息,取值范围 [0,360)。
onVideoStopped
视频功能已停止回调。
public void onVideoStopped() {}
详情
App 如需在停止视频后对 view 做其他处理(比如显示其他画面),可以在这个回调中进行。