QNTypeDefine
- QNErrorCode
- QNLogLevel
- QNTransportPolicy
- QNClientMode
- QNClientRole
- QNConnectionState
- Type
- QNTrackProfile
- Reason
- QNNetworkGrade
- QNDegradationPreference
- QNEncoderStretchMode
- QNCameraFacing
- QNStretchMode
- QNVideoWaterMarkSize
- QNRTCSetting
- QNLogConfig
- QNRTCClientConfig
- QNAudioQuality
- QNMicrophoneAudioTrackConfig
- QNVideoEncoderConfig
- QNVideoCaptureConfig
- QNCameraVideoTrackConfig
- QNNetworkQuality
- QNLocalAudioTrackStats
- QNLocalVideoTrackStats
- QNRemoteAudioTrackStats
- QNRemoteVideoTrackStats
- QNDirectLiveStreamingConfig
- QNConnectionDisconnectedInfo
- QNLiveStreamingErrorInfo
- QNZoomRatioRange
- QNExposureBiasRange
- QNCustomMessage
- export enum QNErrorCode
-
错误码
code describe message OK 成功 无 TokenError 加房 token 错误 请检查 token 是否合法 TokenExpired 加房 token 过期 请检查 token 的时效性 RoomClosed 房间被管理员关闭 无 RoomFull 房间人数已满 无 UserAlreadyExist 房间内已经有同名用户 后台如果配置为开启【禁止自动踢人】,则同一用户重复加入/未正常退出再加入会触发此错误,您的业务可根据实际情况选择配置 NoPermission 发布等动作无权限 无 InvalidParameter 操作参数错误,请检查操作的参数是否合法 无 MediaNotSupport 媒体能力不支持 无 StreamExist 单路转推的 StreamID 已存在 无 AuthFailed 加入房间认证失败 服务验证时出错,可能为服务网络异常。建议重新尝试加入房间 InvalidState 非法状态下进行接口调用 请检查实际房间状态 ReconnectFailed 房间连接状态断开,并且重连失败 无 NetworkTimeout 信令交互超时 无 Fatal 无法处理的、非预期的错误,通常这个错误会有具体的错误提示 无 StreamNotExist 单路转推流不存在 无 ServerUnavailable 服务不可用 无 OperationTimeout 操作超时 无 LiveStreamingClosed 转推任务已关闭 无 CameraInitFailed 系统摄像头错误 无 CameraCaptureFailed 摄像头被其他应用抢占 无 MicInitFailed 麦克风初始化失败,有可能是没有权限或者设备麦克风被占用 无 MicCaptureFailed 麦克风采集失败 无 SpeakerInitFailed 扬声器初始化失败 无 SpeakerPlayoutFailed 扬声器播放失败 无 InvalidClientMode 非法连接模式 无 InvalidClientRole 非法用户角色 无 FetchTokenFailed 上传日志获取 token 失败 无 ReadFileFailed 上传日志文件读取失败 无 InvalidDir 非法的日志文件存储路径 无 NotInitialized 对象实例未初始化 无 UnauthorizedDomain CDN 转推域名未授权 无 DuplicatedOperation DuplicatedOperation 无
- export enum QNLogLevel
-
日志等级
code describe message None 关闭日志 无 Verbose Verbose 等级 无 Info Info 等级 无 Warning Warning 等级 无 Error Error 等级 无
- export enum QNTransportPolicy
-
媒体传输策略
code describe message UDP 强制使用 UDP 做媒体传输 无 TCP 强制使用 TCP 做媒体传输 无 PreferUDP 优先使用 UDP 做媒体传输,允许自动切换 TCP 无
- export enum QNClientMode
-
房间的模式
code describe message RTC 通信场景,用于常见的一对一通话或群聊,该场景中的用户均可以发布和订阅音视频轨道 无 Live 直播场景,有主播和观众两种用户角色,可以通过 QNRTCClient.setClientRole 方法设置用户角色为主播或观众。主播可以发布和订阅音视频轨道,而观众只能订阅音视频轨道,无法发布 无
- export enum QNClientRole
-
房间的模式
code describe message Broadcaster 主播角色,拥有发布和订阅权限 无 Audience 观众角色,仅有订阅权限,且仅在房间类型为 Live 时生效 无
- export enum QNConnectionState
-
房间连接状态
code describe message Disconnected,SDK 出现无法恢复错误时也进入该状态 未连接状态 无 Connecting 正在连接 无 Connected 连接成功 无 Reconnecting 正在重连 无 Reconnected 重连成功 无
- export enum Type
-
转推操作类型
code describe message Start 开始推流的操作 无 Stop 停止推流的操作 无
- export enum QNTrackProfile
-
大小流等级
code describe message Low 低分辨率 无 Medium 中分辨率 无 High 高分辨率 无
- export enum Reason
-
连接断开的原因
code describe message Leave 主动退出 无 KickedOut 被踢出房间 无 RoomClosed 房间被关 无 RoomFull 房间人数已满 无 ReasonError 发生错误异常断开 无
- export enum QNNetworkGrade
-
网络质量等级
code describe message Invalid 初始状态 无 Excellent 网络优 无 Good 网络良 无 General 网络一般 无 Poor 网络差 无
- export enum QNDegradationPreference
-
视频质量降级模式
code describe message MaintainFrameRate 保持帧率 无 MaintainResolution 保持分辨率 无 Blanced 平衡调节分辨率和帧率 无 AdaptBitrateOnly 保持分辨率和帧率,适当调节码率 无 Default RTC 模式下使用 Blanced,Live 模式下使用 MaintainResolution 无
- export enum QNEncoderStretchMode
-
视频编码缩放模式
code describe message ResolutionAdaptive 裁剪模式,画面不能保证完整,当采集宽高比和编码宽高比不一致时,SDK 内部会自动调整裁剪画面 无 ResolutionFit 填充模式,保证画面完整,当采集宽高比和编码宽高比不一致时,造成的视窗未被填满的区域填充黑色 无
- export enum QNCameraFacing
-
定义 Track 的类型
code describe message Invalid 无效的摄像头 无 Front 前置摄像头 无 Back 后置摄像头 无
- export enum QNStretchMode
-
定义 Track 的类型
code describe message StretchInvalid 无效的渲染模式 无 StretchFill 在保持长宽比的前提下,缩放视频,使其充满容器 无 StretchFit 在保持长宽比的前提下,缩放视频,使其在容器内完整显示,边缘部分填充黑边 无 StretchScaleToFit 缩放视频,使其填充满容器,可能导致拉伸变形 无
- export enum QNVideoWaterMarkSize
-
定义水印相对尺寸
code describe message LARGE 0.4 相对比例 无 MEDIUM 0.3 相对比例 无 SMALL 0.2 相对比例 无
- export class QNRTCSetting
-
RTC SDK 初始化配置项
Parameters-
isEncoderQualityModeEnabled: booleam
是否开启编码器质量优先
-
logLevel: QNLogLevel
日志等级配置
-
policy: QNTransportPolicy
传输策略配置
-
encoderType: QNVideoEncoderType
编码类型配置
-
mcuDomains: string[]
自定义域名配置
-
reconnectionTimeout: number
重连超时时间配置
-
- export class QNLogConfig
-
日志配置类
Parameters-
dir: string
日志存储路径
-
tag: string
日志的标签
-
maxSizeInBytes: number
设置日志文件大小的最大限制
-
logLevel: QNLogLevel
设置日志等级
-
- export class QNRTCClientConfig
-
连接对象配置类
Parameters-
mode: QNClientMode
连接模式,可配置 RTC 和 LIVE
-
role: QNClientRole
用户角色,可配置主播和观众
-
- export class QNAudioQuality
-
音频质量配置类
Parameters-
sampleRate: number
采样率
-
channelCount: number
声道数
-
bitsPerSample: number
位宽
-
bitrate: number
码率,单位 kbps
-
- export class QNMicrophoneAudioTrackConfig
-
麦克风采集配置
Parameters-
audioQuality: QNAudioQuality
音频质量
-
tag: string
标签
-
- export class QNVideoEncoderConfig
-
视频编码配置类
Parameters-
width: number
编码宽度
-
height: number
编码高度
-
frameRate: number
编码帧率
-
bitrate: number
编码码率,单位 kbps
-
prefer: number
码率控制策略
-
stretchMode: number
缩放模式
-
- export class QNVideoCaptureConfig
-
视频采集配置类
Parameters-
width: number
采集宽度
-
height: number
采集高度
-
frameRate: number
采样帧率
-
- export class QNCameraVideoTrackConfig
-
摄像头 Track 配置类
Parameters-
tag: string
标签
-
encoderConfig: QNVideoEncoderConfig
编码配置
-
captureConfig: QNVideoCaptureConfig
采集配置
-
cameraFacing: number
摄像头方向
-
- export class QNNetworkQuality
-
网络质量
Parameters-
uplink_network_grade: QNNetworkGrade
上行网络质量
-
downlink_network_grade: QNNetworkGrade
下行网络质量
-
- export class QNLocalAudioTrackStats
-
近端音频轨道的统计数据
Parameters-
uplinkBitrate: number
近端音频上行码率,单位 bps
-
uplinkRtt: number
近端音频上行网络延时,单位毫秒
-
uplinkLostrate: number
近端音频上行丢包率百分比,范围 [0, 100]
-
- export class QNLocalVideoTrackStats
-
近端视频轨道的统计数据
Parameters-
profile: QNTrackProfile
近端视频上行 profile
-
uplinkFramerate: number
近端视频上行帧率
-
uplinkBitrate: number
近端视频上行码率,单位 bps
-
uplinkRtt: number
近端视频上行网络延时,单位毫秒
-
uplinkLostrate: number
近端视频上行丢包率百分比,范围 [0, 100]
-
uplinkFrameWidth: number
近端上行视频帧的宽度,该数值为 SDK 实际对齐后编码发布的视频帧宽度
-
uplinkFrameHeight: number
近端上行视频帧的高度,该数值为 SDK 实际对齐后编码发布的视频帧高度
-
captureFramerate: number
本地采集的视频帧率,单位 fps
-
captureFrameWidth: number
本地采集的视频帧宽度
-
captureFrameHeight: number
本地采集的视频帧高度
-
targetFramerate: number
期望的视频编码帧率,单位 fps
-
targetFrameWidth: number
期望的视频编码宽度
-
targetFrameHeight: number
期望的视频编码高度
-
- export class QNRemoteAudioTrackStats
-
远端音频轨道的统计数据
Parameters-
downlinkBitrate: number
远端音频下行码率,单位 bps(当前应用下载对应轨道时的码率,和远端用户上行无关)
-
downlinkLostrate: number
远端音频下行丢包率,范围 [0, 100](当前应用下载对应轨道时的丢包率,和远端用户上行无关)
-
uplinkRtt: number
远端音频上行网络延时,单位毫秒(表示远端用户上传自身音频数据时的延时)
-
uplinkLostrate: number
远端音频上行丢包率百分比,范围 [0, 100](表示远端用户上传自身音频数据时的丢包率)
-
- export class QNRemoteVideoTrackStats
-
远端视频轨道的统计数据
Parameters-
profile: QNTrackProfile
远端视频 profile(当前应用正在接收的视频轨道的 profile)
-
downlinkFramerate: number
远端视频下行帧率(当前应用正在下载的轨道的帧率)
-
downlinkBitrate: number
远端视频下行码率,单位 bps(当前应用下载对应轨道时的码率,和远端用户上行无关)
-
downlinkLostrate: number
远端视频下行丢包率,范围 [0, 100](当前应用下载对应轨道时的丢包率,和远端用户上行无关)
-
uplinkRtt: number
远端视频上行网络时延,单位毫秒(表示远端用户上传自身视频数据时的延时)
-
uplinkLostrate: number
远端视频上行丢包率百分比,范围 [0, 100](表示远端用户上传自身音频数据时的丢包率))
-
uplinkFrameWidth: number
远端上行视频帧宽度(表示远端用户编码输出的视频宽度)
-
uplinkFrameHeight: number
远端上行视频帧高度(表示远端用户编码输出的视频高度)
-
- export class QNDirectLiveStreamingConfig
-
远端视频轨道的统计数据
Parameters-
localAudioTrack: QNLocalAudioTrack | null
单路转推任务中的音频轨
-
localVideoTrack: QNLocalVideoTrack | null
单路转推任务中的视频轨
-
streamId: string
转推任务的 streamID
-
publishUrl: string
转推任务的推流地址
-
- export class QNConnectionDisconnectedInfo
-
连接断开信息
Parameters-
reason: Reason
连接断开的原因
-
errorCode: QNErrorCode
连接断开的错误码
-
errorMessage: string
连接断开的错误信息
-
- export class QNLiveStreamingErrorInfo
-
连接断开信息
Parameters-
type: Type
出现错误的操作类型
-
code: number
错误码
-
message: string
错误信息
-
- export class QNZoomRatioRange
-
摄像头缩放范围
Parameters-
min: number
设备支持的缩放最小值
-
max: number
设备支持的缩放最大值
-
- export class QNExposureBiasRange
-
摄像头曝光范围
Parameters-
min: number
设备支持的曝光最小值
-
max: number
设备支持的曝光最大值
-
- export class QNCustomMessage
-
自定义消息接收回调信息
Parameters-
msgId: string
消息唯一 ID
-
msgSendId: string
消息发送者的 ID
-
msgText: string
消息内容
-
msgText: number
消息时间戳
-
- export type QNPublishResultCallback = (onPublished: boolean, errorCode: number, errorMessage: string) => void
-
用户发布 Track 的 Callback
此接口的回调在调用 Publish 配置之后返回
- export type QNUploadLogResultCallback = (fileName: string, code: number, remaining: number) => void
-
日志文件上传结果的 Callback.
此接口的回调在调用 SetLogConfig 设置日志文件配置之后才会有效,如有需要可关注返回的 code 值,方便定位失败原因
- export type QNCameraSwitchResultCallback = (facing: QNCameraFacing, errorMessage: string) => void
-
切换摄像头返回结果的 Callback.
此接口的回调在调用 SwitchCamera 配置之后返回