API Reference for iOS - members
更新时间: 2023-10-23 16:45:52
# members
# EnterConfig
说明
不使用多引擎token网关初始化引擎配置
# OmniRtcLiveAudioFrame
OmniRtcLiveAudioFrame
说明
引擎类型
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| samplesPerChannel | NSInteger | 采样个数 |
| bytesPerSample | NSInteger | 每个采样字节数 |
| channels | NSInteger | 通道数 |
| samplesPerSec | NSInteger | 采样率 |
| buffer | NSData* | 音频数据 |
| renderTimeMs | int64_t | 时间戳 |
# RTCEngineType
RTCEngineType
说明
引擎类型
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| RTCEngineTypeOmniRtc | NSInteger | OmniRtc |
# RTCFeature
RTCFeature
说明
特殊功能
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| RTCFeatureBeautyAudio | NSInteger | 美声 |
# RTCEngineState
RTCEngineState
说明
引擎状态
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| RTCEngineStateNew | NSInteger | 新建 |
| RTCEngineStateConnected | NSInteger | 链接完成 |
| RTCEngineStateDisConnected | NSInteger | 链接断开 |
| RTCEngineStateFailed | NSInteger | 链接失败 |
# RTCEngineAudioOutputRouting
RTCEngineAudioOutputRouting
说明
音频路由
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| RTCEngineAudioOutputRoutingDefault | NSInteger | 默认 |
| RTCEngineAudioOutputRoutingHeadset | NSInteger | 头戴式耳机 |
| RTCEngineAudioOutputRoutingEarpiece | NSInteger | 耳机 |
| RTCEngineAudioOutputRoutingHeadsetNoMic | NSInteger | 未带麦克风耳机 |
| RTCEngineAudioOutputRoutingSpeakerphone | NSInteger | 听筒 |
| RTCEngineAudioOutputRoutingLoudspeaker | NSInteger | 扬声器 |
| RTCEngineAudioOutputRoutingHeadsetBluetooth | NSInteger | 蓝牙 |
# RTC_ENGINE_VIDEO_RESOLUTION
RTC_ENGINE_VIDEO_RESOLUTION
说明
视频分辨率
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| RTC_VIDEO_RESOLUTION_120P | NSInteger | 120p |
| RTC_VIDEO_RESOLUTION_180P | NSInteger | 180p |
| RTC_VIDEO_RESOLUTION_240P | NSInteger | 240p |
| RTC_VIDEO_RESOLUTION_360P | NSInteger | 360p |
| RTC_VIDEO_RESOLUTION_480P | NSInteger | 480p |
| RTC_VIDEO_RESOLUTION_640P | NSInteger | 640p |
| RTC_VIDEO_RESOLUTION_720P | NSInteger | 720p |
# RTC_ENGINE_VIDEO_BITRATE
RTC_ENGINE_VIDEO_BITRATE
说明
视频码率
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| RTC_VIDEO_BITRATE_100 | NSInteger | 最大100kbps |
| RTC_VIDEO_BITRATE_120 | NSInteger | 最大120kbps |
| RTC_VIDEO_BITRATE_200 | NSInteger | 最大200kbps |
| RTC_VIDEO_BITRATE_350 | NSInteger | 最大350kbps |
| RTC_VIDEO_BITRATE_400 | NSInteger | 最大400kbps |
| RTC_VIDEO_BITRATE_600 | NSInteger | 最大600kbps |
| RTC_VIDEO_BITRATE_1000 | NSInteger | 最大1000kbps |
# RTCOrientationMode
RTCOrientationMode
说明
视频方向
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| RTCOrientationModeAdaptative | NSInteger | 自适应 |
| RTCOrientationModeFixedLandscape | NSInteger | 横屏 |
| RTCOrientationModeFixedPortrait | NSInteger | 竖屏 |
# RTCEngineLogLevelType
RTCEngineLogLevelType
说明
日志等级
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| RTCEngineLogLevelTypeOff | NSInteger | 不输出日志信息 |
| RTCEngineLogLevelTypeDebug | NSInteger | 输出所有API日志信息 |
| RTCEngineLogLevelTypeInfo | NSInteger | 输出CRITICAL、ERROR、WARNING和INFO级别的日志信息，推荐 |
| RTCEngineLogLevelTypeWarning | NSInteger | 输出CRITICAL、ERROR和WARNING级别的日志信息 |
| RTCEngineLogLevelTypeError | NSInteger | 输出CRITICAL和ERROR级别的日志信息 |
| RTCEngineLogLevelTypeCritical | NSInteger | 输出CRITICAL级别的日志信息 |
# RTCConnectionStateType
RTCConnectionStateType
说明
链接状态
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| RTCConnectionStateTypeDisconnected | NSInteger | 链接断开 |
| RTCConnectionStateTypeConnecting | NSInteger | 链接中 |
| RTCConnectionStateTypeConnected | NSInteger | 链接完成 |
| RTCConnectionStateTypeReconnecting | NSInteger | 重新链接 |
| RTCConnectionStateTypeFailed | NSInteger | 链接失败 |
# RTCEngineMetadataType
RTCEngineMetadataType
说明
元数据类型
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| RTCEngineMetadataTypeUnknown | NSInteger | 未知 |
| RTCEngineMetadataTypeVideo | NSInteger | 视频 |
# RTCAudioMixingStateCode
RTCAudioMixingStateCode
说明
音频混音状态
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| RTCAudioMixingStatePlaying | NSInteger | 播放 |
| RTCAudioMixingStatePaused | NSInteger | 暂停 |
| RTCAudioMixingStateStopped | NSInteger | 停止 |
| RTCAudioMixingStateFailed | NSInteger | 失败 |
# RTCAudioMixingErrorCode
RTCAudioMixingErrorCode
说明
音频混音错误
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| RTCAudioMixingErrorCanNotOpen | NSInteger | 未打开 |
| RTCAudioMixingErrorTooFrequentCall | NSInteger | 太过频繁 |
| RTCAudioMixingErrorInterruptedEOF | NSInteger | 文件结束 |
| RTCAudioMixingErrorOK | NSInteger | OK |
# RTCEngineClientRole
RTCEngineClientRole
说明
用户角色
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| RTCEngineClientRoleBroadcaster | NSInteger | 主播 |
| RTCEngineClientRoleAudience | NSInteger | 观众 |
# RTCEngineVideoRemoteState
RTCEngineVideoRemoteState
说明
远端视频状态
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| RTCEngineVideoRemoteStateStopped | NSInteger | 远端视频默认初始状态 |
| RTCEngineVideoRemoteStateStarting | NSInteger | 本地用户已接收远端视频首包 |
| RTCEngineVideoRemoteStateDecoding | NSInteger | 远端视频流正在解码，正常播放 |
| RTCEngineVideoRemoteStateFrozen | NSInteger | 远端视频流卡顿 |
| RTCEngineVideoRemoteStateFailed | NSInteger | 远端视频流播放失败 |
# RTCEngineVideoRemoteStateReason
RTCEngineVideoRemoteStateReason
说明
远端视频状态切换原因
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| RTCEngineVideoRemoteStateReasonInternal | NSInteger | 内部原因 |
| RTCEngineVideoRemoteStateReasonNetworkCongestion | NSInteger | 网络拥塞 |
| RTCEngineVideoRemoteStateReasonNetworkRecovery | NSInteger | 网络恢复 |
| RTCEngineVideoRemoteStateReasonLocalMuted | NSInteger | 本地mute |
| RTCEngineVideoRemoteStateReasonLocalUnmuted | NSInteger | 本地unmute |
| RTCEngineVideoRemoteStateReasonRemoteMuted | NSInteger | 远端mute |
| RTCEngineVideoRemoteStateReasonRemoteUnmuted | NSInteger | 远端unmute |
| RTCEngineVideoRemoteStateReasonRemoteOffline | NSInteger | 远端离线 |
| RTCEngineVideoRemoteStateReasonAudioFallback | NSInteger | 音频回退 |
| RTCEngineVideoRemoteStateReasonAudioFallbackRecovery | NSInteger | 音频回退恢复 |
# RTCAudioMode
RTCAudioMode
说明
通话模式
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| RTCAudioModeMedia | NSInteger | 媒体音量 |
| RTCAudioModeChat | NSInteger | 通话音量 |
# RTCOutputPixelFormat
RTCOutputPixelFormat
说明
像素格式
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| RTCOutputPixelFormatI420 | NSInteger | I420 |
| RTCOutputPixelFormatRGBA | NSInteger | RGBA |
| RTCOutputPixelFormatNV12 | NSInteger | NV12 |
# OmniRtcLiveAudioRawFrameOperationMode
OmniRtcLiveAudioRawFrameOperationMode
说明
音频裸数操作方式
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| OmniRtcLiveAudioRawFrameOperationModeReadOnly | NSInteger | 只读 |
| OmniRtcLiveAudioRawFrameOperationModeWriteOnly | NSInteger | 只写 |
| OmniRtcLiveAudioRawFrameOperationModeReadWrite | NSInteger | 可读写 |
# OmniRtcLiveAudioExternalSourceId
OmniRtcLiveAudioExternalSourceId
说明
混音方式
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| OmniRtcLiveAudioExternalPlayoutSource | NSInteger | 只本地播放，不做混音 |
| OmniRtcLiveAudioExternalRecordSourcePreProcess | NSInteger | 在音频处理前做混音 |
| OmniRtcLiveAudioExternalRecordSourcePostProcess | NSInteger | 在音频处理后做混音 |
# OmniRtcLiveBusinessUserRole
OmniRtcLiveBusinessUserRole
说明
业务类型
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| OmniRtcLiveBusinessUserRoleStudent | NSInteger | 学生 |
| OmniRtcLiveBusinessUserRoleTeacher | NSInteger | 老师 |
| OmniRtcLiveBusinessUserRoleTutor | NSInteger | 游客 |
# OmniRtcLiveStreamFallbackOptions
OmniRtcLiveStreamFallbackOptions
说明
大小流模式
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| OmniRtcLiveStreamFallbackOptionDisabled | NSInteger | 不自动切换 |
| OmniRtcLiveStreamFallbackOptionVideoStreamLow | NSInteger | 切换视频小流 |
| OmniRtcLiveStreamFallbackOptionAudioOnly | NSInteger | 切换为只有音频流 |
# OmniRtcLiveCameraPosition
OmniRtcLiveCameraPosition
说明
摄像头位置
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| OmniRtcLiveCameraPositionBack | NSInteger | 后置摄像头 |
| OmniRtcLiveCameraPositionFront | NSInteger | 前置摄像头 |
# OmniRtcLiveMirrorMode
OmniRtcLiveMirrorMode
说明
视频镜像莫斯
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| OmniRtcLiveMirrorModeNone | NSInteger | 不开启镜像，默认 |
| OmniRtcLiveMirrorModePreview | NSInteger | 仅本地预览镜像 |
| OmniRtcLiveMirrorModeRemote | NSInteger | 仅远端结果镜像 |
| OmniRtcLiveMirrorModeBoth | NSInteger | 本地预览和远端结果均镜像 |
# OmniRtcLiveVideoMirrorMode
OmniRtcLiveVideoMirrorMode
说明
视频镜像莫斯
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| OmniRtcLiveVideoMirrorModeAuto | NSInteger | 自动模式 |
| OmniRtcLiveVideoMirrorModeEnabled | NSInteger | 设置镜像 |
| OmniRtcLiveVideoMirrorModeDisabled | NSInteger | 设置非镜像 |
# RTCLocalVideoStreamState
RTCLocalVideoStreamState
说明
本地视频流状态
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| RTCLocalVideoStreamStateStopped | NSInteger | 视频流停止 |
| RTCLocalVideoStreamStateCapturing | NSInteger | 视频流采集 |
| RTCLocalVideoStreamStateEncoding | NSInteger | 视频流编码 |
| RTCLocalVideoStreamStateFailed | NSInteger | 视频流失败 |
# RTCLocalVideoStreamError
RTCLocalVideoStreamError
说明
本地视频流错误
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| RTCLocalVideoStreamErrorOK | NSInteger | OK |
| RTCLocalVideoStreamErrorFailure | NSInteger | 失败 |
| RTCLocalVideoStreamErrorDeviceNoPermission | NSInteger | 未授权 |
| RTCLocalVideoStreamErrorDeviceBusy | NSInteger | 设备繁忙 |
| RTCLocalVideoStreamErrorCaptureFailure | NSInteger | 采集失败 |
| RTCLocalVideoStreamErrorEncodeFailure | NSInteger | 编码失败 |
# RTCAudioProcessMode
RTCAudioProcessMode
说明
音频处理模式
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| RTCAudioProcessModeNormal | NSInteger | 默认 |
| RTCAudioProcessModeFastProcessing | NSInteger | 音频处理环节使用16K |
| RTCAudioProcessModeFastRecording | NSInteger | 全流程16K |
# OmniRtcLiveConnectionStateType
OmniRtcLiveConnectionStateType
说明
链接状态
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| OmniRtcLiveConnectionStateDisconnected | NSInteger | 断开链接 |
| OmniRtcLiveConnectionStateConnecting | NSInteger | 链接中 |
| OmniRtcLiveConnectionStateConnected | NSInteger | 链接成功 |
| OmniRtcLiveConnectionStateReconnecting | NSInteger | 重新链接 |
| OmniRtcLiveConnectionStateFailed | NSInteger | 链接失败 |
# OmniRtcLiveAudioProfile
OmniRtcLiveAudioProfile
说明
音频配置
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| OmniRtcLiveAudioProfileDefault | NSInteger | 默认 |
| OmniRtcLiveAudioProfileSpeechStandard | NSInteger | 演讲 |
| OmniRtcLiveAudioProfileMusicStandard | NSInteger | 音乐 |
| OmniRtcLiveAudioProfileMusicStandardStereo | NSInteger | 音乐双声道 |
| OmniRtcLiveAudioProfileMusicHighQuality | NSInteger | 高质量 |
| OmniRtcLiveAudioProfileMusicHighQualityStereo | NSInteger | 高质量双声道 |
# OmniRtcLiveAudioScenario
OmniRtcLiveAudioScenario
说明
音频场景
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| OmniRtcLiveAudioScenarioDefault | NSInteger | 默认设置 |
| OmniRtcLiveAudioScenarioChatRoomEntertainment | NSInteger | 娱乐场景，适用于用户需要频繁上下麦的场景 |
| OmniRtcLiveAudioScenarioEducation | NSInteger | 教育场景，适用于需要高流畅度和稳定性的场景 |
| OmniRtcLiveAudioScenarioGameStreaming | NSInteger | 高音质语聊房场景，适用于音乐为主的场景 |
| OmniRtcLiveAudioScenarioShowRoom | NSInteger | 秀场场景，适用于需要高音质的单主播场景 |
| OmniRtcLiveAudioScenarioChatRoomGaming | NSInteger | 游戏开黑场景，适用于只有人声的场景 |
| OmniRtcLiveAudioScenarioIot | NSInteger | IoT（物联网）场景，适用于使用低功耗IoT设备的场景 |
| OmniRtcLiveAudioScenarioCommunication | NSInteger | 通信场景 |
| OmniRtcLiveAudioScenarioMeeting | NSInteger | 会议场景，适用于人声为主的多人会议 |
# OmniRtcLiveEnterConfig
OmniRtcLiveEnterConfig
说明
进房间配置参数
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| roomId | NSString* | 房间号 |
| uid | long | 用户ID |
| engineType | RTCEngineType | 引擎类型 |
| appId | NSString* | 应用标识 |
| planId | NSString* | planId |
| token | NSString* | 令牌 |
# OmniRtcLiveChannelMediaOptions
OmniRtcLiveChannelMediaOptions
说明
媒体选项
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| autoSubscribeAudio | BOOL | 是否自动订阅音频流 |
| autoSubscribeVideo | BOOL | 是否自动订阅视频流 |
| publishLocalAudio | BOOL | 是否发布音频流 |
| publishLocalVideo | BOOL | 是否发布视频流 |
# RTCEngineErrorCode
RTCEngineErrorCode
说明
引擎错误类型
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| RTCEngineErrorCodeUnkonwn | NSInteger | 未知 |
| RTCEngineErrorCodeInvalidToken | NSInteger | 非法token |
| RTCEngineErrorCodeTokenExpired | NSInteger | token过期 |
| RTCEngineErrorCodesAudioError | NSInteger | 音频错误 |
| RTCEngineErrorCodePublishFailed | NSInteger | 发布失败 |
| RTCEngineErrorCodeStartCamera | NSInteger | 启动摄像头错误 |
| RTCEngineErrorCodeStartVideoRender | NSInteger | 启动渲染失败 |
| RTCEngineErrorCodeParseTokenError | NSInteger | 解析token错误 |
| RTCEngineErrorCodeSetRoleError | NSInteger | 设置角色错误 |
| RTCEngineErrorCodeNoServerTime | NSInteger | 未获取到服务器时间 |
| RTCEngineErrorCodeSEIFail | NSInteger | SEI错误 |
| RTCEngineErrorCodeAdmInterruption | NSInteger | 音频模块打断 |
| RTCEngineErrorCodeAdmExceptionInterruption | NSInteger | 音频模块异常 |
# RTCVideoRenderMode
RTCVideoRenderMode
说明
渲染模式
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| RTCVideoRenderModeFill | NSInteger | 拉伸填充模式 |
| RTCVideoRenderModeHidden | NSInteger | 剪裁填充模式 |
| RTCVideoRenderModeFit | NSInteger | 自适应模式，会保留黑边 |
# RTCChannelClientRole
RTCChannelClientRole
说明
用户角色
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| RTCChannelClientRoleBroadcaster | NSInteger | 主播 |
| RTCChannelClientRoleAudience | NSInteger | 关注 |
# RTCChannelVideoRemoteState
RTCChannelVideoRemoteState
说明
远端视频状态
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| RTCChannelVideoRemoteStateStopped | NSInteger | 远端视频默认初始状态 |
| RTCChannelVideoRemoteStateStarting | NSInteger | 本地用户已接收远端视频首包 |
| RTCChannelVideoRemoteStateDecoding | NSInteger | 远端视频流正在解码，正常播放 |
| RTCChannelVideoRemoteStateFrozen | NSInteger | 远端视频流卡顿 |
| RTCChannelVideoRemoteStateFailed | NSInteger | 远端视频流播放失败 |
# RTCChannelVideoRemoteStateReason
RTCChannelVideoRemoteStateReason
说明
远端视频状态切换原因
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| RTCChannelVideoRemoteStateReasonInternal | NSInteger | 内部原因 |
| RTCChannelVideoRemoteStateReasonNetworkCongestion | NSInteger | 网络拥塞 |
| RTCChannelVideoRemoteStateReasonNetworkRecovery | NSInteger | 网络恢复 |
| RTCChannelVideoRemoteStateReasonLocalMuted | NSInteger | 本地mute |
| RTCChannelVideoRemoteStateReasonLocalUnmuted | NSInteger | 本地unmute |
| RTCChannelVideoRemoteStateReasonRemoteOffline | NSInteger | 远端用户离线 |
| RTCChannelVideoRemoteStateReasonRemoteMuted | NSInteger | 远端用户mute |
| RTCChannelVideoRemoteStateReasonRemoteUnmuted | NSInteger | 远端用户unmute |
| RTCChannelVideoRemoteStateReasonAudioFallback | NSInteger | 音频回退 |
| RTCChannelVideoRemoteStateReasonAudioFallbackRecovery | NSInteger | 音频回退恢复 |
# RTCChannelUserOfflineReason
RTCChannelUserOfflineReason
说明
用户离线原因
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| RTCChannelUserOfflineReasonQuit | NSInteger | 用户主动离开 |
| RTCChannelUserOfflineReasonDropped | NSInteger | 超时掉线 |
| RTCChannelUserOfflineReasonBecomeAudience | NSInteger | 主播切换为观众时触发 |
# RTCChannelConnectionStateType
RTCChannelConnectionStateType
说明
网络连接状态
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| RTCChannelConnectionStateDisconnected | NSInteger | 网络连接断开 |
| RTCChannelConnectionStateConnecting | NSInteger | 建立网络连接中 |
| RTCChannelConnectionStateConnected | NSInteger | 网络已连接 |
| RTCChannelConnectionStateReconnecting | NSInteger | 重新建立网络连接中，重试20分钟 |
| RTCChannelConnectionStateFailed | NSInteger | 网络连接失败 |
# RTCChannelConnectionChangedReason
RTCChannelConnectionChangedReason
说明
网络状态变化原因
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| RTCChannelConnectionChangedConnecting | NSInteger | 建立网络连接中 |
| RTCChannelConnectionChangedJoinSuccess | NSInteger | 成功加入频道 |
| RTCChannelConnectionChangedInterrupted | NSInteger | 网络连接中断 |
| RTCChannelConnectionChangedBannedByServer | NSInteger | 网络连接被服务器禁止 |
| RTCChannelConnectionChangedJoinFailed | NSInteger | 加入频道失败，20分钟后还是没能加入频道，会返回该状态，并停止尝试重连 |
| RTCChannelConnectionChangedLeaveChannel | NSInteger | 离开频道 |
| RTCChannelConnectionChangedInvalidAppId | NSInteger | 不是有效的APPID |
| RTCChannelConnectionChangedInvalidChannelName | NSInteger | 不是有效的频道名 |
| RTCChannelConnectionChangedInvalidToken | NSInteger | 生成的Token无效 |
| RTCChannelConnectionChangedTokenExpired | NSInteger | 当前使用的Token过期 |
| RTCChannelConnectionChangedSettingProxyServer | NSInteger | 由于设置了代理服务器，SDK尝试重连 |
| RTCChannelConnectionChangedRenewToken | NSInteger | 更新Token引起网络连接状态改变 |
| RTCChannelConnectionChangedClientIpAddressChanged | NSInteger | 客户端IP地址变更 |
| RTCChannelConnectionChangedKeepAliveTimeout | NSInteger | SDK和服务器连接保活超时 |
# RTCLastMileQuality
RTCLastMileQuality
说明
最后一公里质量
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| RTC_QUALITY_UNKNOWN | NSInteger | 质量极好 |
| RTC_QUALITY_EXCELLENT | NSInteger | 质量极好 |
| RTC_QUALITY_GOOD | NSInteger | 用户主观感觉和极好差不多 |
| RTC_QUALITY_POOR | NSInteger | 用户主观感受有瑕疵但不影响沟通 |
| RTC_QUALITY_BAD | NSInteger | 勉强能沟通但不顺畅 |
| RTC_QUALITY_VBAD | NSInteger | 网络质量非常差，基本不能沟通 |
| RTC_QUALITY_DOWN | NSInteger | 完全无法沟 |
| RTC_QUALITY_DETECTING | NSInteger | SDK正在探测网络质量 |
# RTCVideoStreamType
RTCVideoStreamType
说明
视频流类型
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| RTCVideoStreamTypeHigh | NSInteger | 高码率高分辨视频流 |
| RTCVideoStreamTypeLow | NSInteger | 低码率低分辨率视频流 |
# RTCVideoBufferingState
RTCVideoBufferingState
说明
视频卡顿状态
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| RTCVideoBufferingStateStart | NSInteger | 开始卡顿 |
| RTCVideoBufferingStateEnd | NSInteger | 结束卡顿 |
# RTCAudioBufferingState
RTCAudioBufferingState
说明
音频卡顿状态
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| RTCAudioBufferingStateStart | NSInteger | 开始卡顿 |
| RTCAudioBufferingStateEnd | NSInteger | 结束卡顿 |
# RTCRtmpStreamingState
RTCRtmpStreamingState
说明
rtmp流状态
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| RTCRtmpStreamingStateIdle | NSInteger | 推流未开始或已结束 |
| RTCRtmpStreamingStateConnecting | NSInteger | 正在连接推流服务器和CDN服务器 |
| RTCRtmpStreamingStateRunning | NSInteger | 推流正在进行 |
| RTCRtmpStreamingStateRecovering | NSInteger | 正在恢复推流 |
| RTCRtmpStreamingStateFailure | NSInteger | 推流失败 |
# RTCRtmpStreamingErrorCode
RTCRtmpStreamingErrorCode
说明
rtmp推流错误码
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| RTCRtmpStreamingErrorCodeOK | NSInteger | 推流成功 |
| RTCRtmpStreamingErrorCodeInvalidParameters | NSInteger | 参数无效 |
| RTCRtmpStreamingErrorCodeEncryptedStreamNotAllowed | NSInteger | 推流已加密，不能推流 |
| RTCRtmpStreamingErrorCodeConnectionTimeout | NSInteger | 推流超时未成功 |
| RTCRtmpStreamingErrorCodeInternalServerError | NSInteger | 推流服务器出现错误 |
| RTCRtmpStreamingErrorCodeRtmpServerError | NSInteger | CDN服务器出现错误 |
| RTCRtmpStreamingErrorCodeTooOften | NSInteger | 预留参数 |
| RTCRtmpStreamingErrorCodeReachLimit | NSInteger | 单个主播的推流地址数目达到上限10 |
| RTCRtmpStreamingErrorCodeNotAuthorized | NSInteger | 主播操作不属于自己的流 |
| RTCRtmpStreamingErrorCodeStreamNotFound | NSInteger | 服务器未找到这个流 |
| RTCRtmpStreamingErrorCodeFormatNotSupported | NSInteger | 推流地址格式有错误 |
# RTCRtmpErrorCode
RTCRtmpErrorCode
说明
rtmp错误码
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| RTCRtmpErrorCodeNoError | NSInteger | 推流成功 |
| RTCRtmpErrorCodeTimeOut | NSInteger | 推流超时未成功 |
| RTCRtmpErrorCodeCDNError | NSInteger | CDN相关错误 |
| RTCRtmpErrorCodeNumReachLimit | NSInteger | 单个主播的推流地址数目达到上限10 |
| RTCRtmpErrorCodeNotAuthorized | NSInteger | 操作不属于主播自己的流 |
| RTCRtmpErrorCodeInternalServerError | NSInteger | 推流服务器出现错误 |
| RTCRtmpErrorCodeNotFound | NSInteger | 服务器未找到这个流 |
| RTCRtmpErrorCodeFormatNotSuppported | NSInteger | 推流地址格式有错误 |
# RTCChannelMediaRelayState
RTCChannelMediaRelayState
说明
转推状态码
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| RTCChannelMediaRelayStateIdle | NSInteger | 初始状态 |
| RTCChannelMediaRelayStateConnecting | NSInteger | SDK尝试跨频道 |
| RTCChannelMediaRelayStateRunning | NSInteger | 源频道主播成功加入目标频道 |
| RTCChannelMediaRelayStateFailure | NSInteger | 发生异常 |
# RTCChannelMediaRelayError
RTCChannelMediaRelayError
说明
转推错误码
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| RTCChannelMediaRelayErrorNone | NSInteger | 正常 |
| RTCChannelMediaRelayErrorServerErrorResponse | NSInteger | 服务器回应出错 |
| RTCChannelMediaRelayErrorServerNoResponse | NSInteger | 服务器无回应 |
| RTCChannelMediaRelayErrorNoResourceAvailable | NSInteger | SDK无法获取服务 |
| RTCChannelMediaRelayErrorFailedJoinSourceChannel | NSInteger | 发起跨频道转发媒体流请求失败 |
| RTCChannelMediaRelayErrorFailedJoinDestinationChannel | NSInteger | 接受跨频道转发媒体流请求失败 |
| RTCChannelMediaRelayErrorFailedPacketReceivedFromSource | NSInteger | 服务器接收跨频道转发媒体流失败 |
| RTCChannelMediaRelayErrorFailedPacketSentToDestination | NSInteger | 服务器发送跨频道转发媒体流失败 |
| RTCChannelMediaRelayErrorServerConnectionLost | NSInteger | SDK因网络质量不佳与服务器断开 |
| RTCChannelMediaRelayErrorInternalError | NSInteger | 服务器内部出错 |
| RTCChannelMediaRelayErrorSourceTokenExpired | NSInteger | 源频道的Token已过期 |
| RTCChannelMediaRelayErrorDestinationTokenExpired | NSInteger | 目标频道的Token已过期 |
# RTCChannelMediaRelayEvent
RTCChannelMediaRelayEvent
说明
转推事件
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| RTCChannelMediaRelayEventDisconnect | NSInteger | 与服务器连接断开 |
| RTCChannelMediaRelayEventConnected | NSInteger | 与服务器建立连接 |
| RTCChannelMediaRelayEventJoinedSourceChannel | NSInteger | 用户已加入源频道 |
| RTCChannelMediaRelayEventJoinedDestinationChannel | NSInteger | 用户已加入目标频道 |
| RTCChannelMediaRelayEventSentToDestinationChannel | NSInteger | SDK开始向目标频道发送数据包 |
| RTCChannelMediaRelayEventReceivedVideoPacketFromSource | NSInteger | 服务器收到了源频道发送的视频流 |
| RTCChannelMediaRelayEventReceivedAudioPacketFromSource | NSInteger | 服务器收到了源频道发送的音频流 |
| RTCChannelMediaRelayEventUpdateDestinationChannel | NSInteger | 目标频道已更新 |
| RTCChannelMediaRelayEventUpdateDestinationChannelRefused | NSInteger | 内部原因导致目标频道更新失败 |
| RTCChannelMediaRelayEventUpdateDestinationChannelNotChange | NSInteger | 目标频道未发生改变，即目标频道更新失败 |
| RTCChannelMediaRelayEventUpdateDestinationChannelIsNil | NSInteger | 目标频道名为nil |
| RTCChannelMediaRelayEventVideoProfileUpdate | NSInteger | 视频属性已发送至服务器 |
# RTCUserPriority
RTCUserPriority
说明
用户优先级
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| RTCUserPriorityHigh | NSInteger | 用户需求优先级为高 |
| RTCUserPriorityNormal | NSInteger | 用户需求优先级为正常（默认） |
# OmniRtcLiveSubscriptionStreamType
OmniRtcLiveSubscriptionStreamType
说明
订阅流质量类型
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| OmniRtcLiveSubscribeStreamTypeHigh | NSInteger | 高质量流 |
| OmniRtcLiveSubscribeStreamTypeLow | NSInteger | 低质量流 |
| OmniRtcLiveSubscribeStreamTypeAudio | NSInteger | 音频流 |
# OmniRtcLiveStreamPublishState
OmniRtcLiveStreamPublishState
说明
音视频推流状态
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| OmniRtcLiveStreamPublishIdle | NSInteger | 初始状态 |
| OmniRtcLiveStreamPublishNoPublished | NSInteger | 未发布状态 |
| OmniRtcLiveStreamPublishPublishing | NSInteger | 尝试发布状态 |
| OmniRtcLiveStreamPublishPublished | NSInteger | 发布状态 |
# OmniRtcLiveStreamSubscribeState
OmniRtcLiveStreamSubscribeState
说明
音视频拉流状态
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| OmniRtcLiveStreamSubscribeIdle | NSInteger | 初始状态 |
| OmniRtcLiveStreamSubscribeNoSubscribed | NSInteger | 未订阅状态 |
| OmniRtcLiveStreamSubscribeSubscribing | NSInteger | 尝试订阅状态 |
| OmniRtcLiveStreamSubscribeSubscribed | NSInteger | 订阅状态 |
# RTCChannelMediaRelayConfiguration
RTCChannelMediaRelayConfiguration
说明
转推配置
参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| sourceInfo | NSInteger | 源信息 |
| destinationInfos | NSInteger | 目的信息 |