Unreal Engine SDK V5.4.128
|
namespace nertc 更多...
类型定义 | |
typedef uint64_t | uid_t |
typedef uint64_t | channel_id_t |
typedef void * | source_id_t |
typedef void(* | onFrameDataCallback) (uid_t uid, void *data, uint32_t type, uint32_t width, uint32_t height, uint32_t count, uint32_t offset[4], uint32_t stride[4], uint32_t rotation, void *user_data) |
函数 | |
NERTC_UE_API IRtcEngineEx *NERTC_UE_CALL | createNERtcEngine () |
namespace nertc
typedef uint64_t nertc::channel_id_t |
64位无符号整数。建议设置范围:1到 263-1,并保证唯一性。
typedef void(* nertc::onFrameDataCallback) (uid_t uid, void *data, uint32_t type, uint32_t width, uint32_t height, uint32_t count, uint32_t offset[4], uint32_t stride[4], uint32_t rotation, void *user_data) |
视频帧数据回调
uid | 用户id |
data | 数据指针 |
type | 数据类型NERtcVideoType |
width | 宽度 |
height | 高度 |
count | 数据类型个数,即offset及stride的数目 |
offset | 每类数据偏移 |
stride | 每类数据步进 |
rotation | 画面旋转角度NERtcVideoRotation |
user_data | 用户透传数据 |
typedef void* nertc::source_id_t |
用于标识屏幕捕捉的源,代表某个窗口或屏幕。源为窗口时, Windows上该类型会转换为HWND, MAC上转换为整形。源为屏幕时会转换为整形。
typedef uint64_t nertc::uid_t |
64位无符号整数。建议设置范围:1到 263-1,并保证唯一性。
音频设备错误码。
音频设备连接类型。
音乐文件播放状态。
枚举值 | |
---|---|
kNERtcAudioMixingStateFinished | 音乐文件播放结束。 |
kNERtcAudioMixingStateFailed | 音乐文件报错。详见: NERtcAudioMixingErrorCode |
音频属性。设置采样率,码率,编码模式和声道数。
音频应用场景。不同的场景设置对应不同的音频采集模式、播放模式。
音频会话控制权限。
SDK 对 Audio Session 的控制权限。
美颜类型。
设置摄像头的采集偏好。
枚举值 | |
---|---|
kNERtcCameraOutputDefault | (默认)优先保证设备性能。SDK 根据设备性能,参考用户在 setVideoConfig 中设置编码器的分辨率和帧率,选择最接近的摄像头输出参数。在这种情况下,预览质量接近于编码器的输出质量。 |
kNERtcCameraOutputQuality | 优先保证视频预览质量。SDK 自动设置画质较高的摄像头输出参数,提高预览画面质量。此时会消耗更多的 CPU 及内存做视频前处理。 |
kNERtcCameraOutputManual | 采用用户自定义设置的摄像头输出参数。此时用户可以通过 NERtcCameraCaptureConfig 中的 captureWidth 和 captureHeight 设置本地摄像头采集的视频宽高。 |
媒体流转发回调事件。
枚举值 | |
---|---|
kNERtcChannelMediaRelayEventDisconnect | 媒体流转发停止。 |
kNERtcChannelMediaRelayEventConnecting | SDK 正在连接服务器,开始尝试转发媒体流。 |
kNERtcChannelMediaRelayEventConnected | 连接服务器成功。 |
kNERtcChannelMediaRelayEventVideoSentToDestChannelSuccess | 视频音频媒体流成功转发到目标房间。 |
kNERtcChannelMediaRelayEventAudioSentToDestChannelSuccess | 音频媒体流成功转发到目标房间。 |
kNERtcChannelMediaRelayEventOtherStreamSentToDestChannelSuccess | 媒体流屏幕共享等其他流成功转发到目标房间。 |
kNERtcChannelMediaRelayEventFailure | 媒体流转发失败。原因包括:
|
媒体流转发状态
NERtcDegradationPreference 视频编码策略。
错误代码。
错误代码意味着 SDK 遇到不可恢复的错误,需要应用程序干预。
视频水印状态。
enum nertc::NERtcLogLevel |
日志级别。
网络质量类型。
连接状态变更原因
room server相关错误码。TODO:NERtcErrorCode
屏幕分享状态
空间音效中房间材质名称
上行、下行弱网时的回退选项。
屏幕共享功能的编码策略倾向。
枚举值 | |
---|---|
kNERtcSubStreamContentPreferMotion | 动画模式。 |
kNERtcSubStreamContentPreferDetails | 细节模式。 |
视频旋转的方向模式。
视频编码配置。用于衡量编码质量。
虚拟背景未成功启用的原因或确认成功的信息。
预设的美声效果
音效均衡波段的中心频率
enum nertc::NERtcWarnCode |
NERTC_UE_API IRtcEngineEx *NERTC_UE_CALL nertc::createNERtcEngine | ( | ) |
创建 RTC 引擎对象并返回指针。