文档

数据类型

更新时间:

通过阅读本文,您可以了解iOS SDK和Mac SDK涉及的数据类型。

目录

数据类型

描述

支持的最低版本

DingRtcVideoTrack

视频流类型。

3.0

DingRtcAudioTrack

音频流类型。

3.0

DingRtcNetworkQuality

网络质量。

3.0

DingRtcAudioProfile

音频编码模式。

3.0

DingRtcAudioScenario

音频场景模式。

3.0

DingRtcRenderMode

视图显示模式。

3.0

DingRtcLogLevel

Log级别。

3.0

DingRtcVideoEncoderFrameRate

视频编码帧率。

3.0

DingRtcVideoEncoderMirrorMode

编码视频镜像模式。

3.0

DingRtcRotationMode

视频旋转角度。

3.0

DingRtcVideoEncoderOrientationMode

编码视频旋转模式。

3.0

DingRtcOrientationMode

设备方向(仅适用于iOS系统)。

3.0

DingRtcAudioSessionOperationRestriction

SDK对AudioSession的控制权限(仅适用于iOS系统)。

3.0

DingRtcVideoStreamType

相机流类型。

3.0

DingRtcDeviceVolumeType

设备音量类型(仅适用于iOS系统)。

3.0

DingRtcVideoSource

视频裸数据源类型。

3.0

DingRtcAudioObservePosition

音频数据源类型。

3.1

DingRtcAudioSource

音频数据源类型。

3.0

DingRtcVideoFormat

视频数据格式。

3.0

DingRtcBufferType

视频数据类型。

3.0

DingRtcAudioNumChannel

音频声道数。

3.0

DingRtcRecordingQuality

文件录制质量(仅适用于iOS系统)。

3.0

DingRtcAudioEffectVoiceChangerMode

变声音效模式。

3.0

DingRtcAudioEffectReverbMode

音效混响模式。

3.0

DingRtcAudioEffectReverbParamType

音效混响参数。

3.0

DingRtcConnectionStatus

网络连接状态。

3.0

DingRtcConnectionStatusChangeReason

引起网络状态变更原因。

3.0

DingRtcChannelProfile

频道类型。

3.0

DingRtcClientRole

角色类型。

3.0

DingRtcMuteLocalAudioMode

本地静音模式。

3.0

DingRtcRenderMirrorMode

镜像模式。

3.0

DingRtcAudioPlayingStateCode

音乐伴奏播放状态。

3.0

DingRtcAudioPlayingErrorCode

音乐伴奏播放错误码。

3.0

DingRtcAudioQuality

录制音频质量。

3.0

DingRtcVideoQuality

录制视频质量。

3.0

DingRtcAudioSampleRate

录制音频采样率。

3.0

DingRtcAudioRouteType

语音路由(仅适用于iOS系统)。

3.0

DingRtcShowDebugViewType

显示仪表盘类型。

3.0

DingRtcScreenShareMode

屏幕共享模式支持位运算按需组合。

3.0

DingRtcErrorCode

错误码。

3.0

DingRtcOnByeType

OnBye类型。

3.0

DingRtcCaptureOutputPreference

采集偏好。

3.0

DingRtcCameraDirection

摄像头方向(仅适用于iOS系统)。

3.0

DingRtcPublishState

推流状态。

3.0

DingRtcSubscribeState

订阅状态。

3.0

DingRtcUserOfflineReason

用户离线原因。

3.0

DingRtcScreenShareType

桌面分享类型(仅适用于Mac系统)。

3.0

DingRtcExternalDeviceType

外接设备类型(仅适用于Mac系统)。

3.0

DingRtcExternalDeviceState

外接设备状态(仅适用于Mac系统)。

3.0

DingRtcDeviceTransportType

设备传输类型(仅适用于Mac系统)。

3.0

DingRtcVideoState

视频状态。

3.0

DingRtcVideoEncodedFrameType

Qos反馈外置编码器请求帧类型

3.0

DingRtcVideoFrameType

视频帧类型。

3.0

DingRtcVideoPixelFormat

视频数据格式。

3.0

DingRtcRecordAudioConfig

录制音频设置。

3.0

DingRtcRecordVideoCanvasConfig

录制视频分辨率(仅适用于Mac系统)。

3.0 画布大小。

DingRtcRecordVideoRational

录制视频坐标(仅适用于Mac系统)。

3.0

DingRtcRecordVideoRectangle

录制视频位置信息(仅适用于Mac系统)。

3.0

DingRtcRecordVideoConfig

录制视频设置。

3.0

DingRtcQualityReport

质量报告数据。

3.0

DingRtcStats

基础统计信息。

3.0

DingRtcLocalVideoStats

本地视频统计信息。

3.0

DingRtcRemoteVideoStats

远端视频统计信息。

3.0

DingRtcLocalAudioStats

本地音频统计信息。

3.0

DingRtcRemoteAudioStats

远端音频统计信息。

3.0

DingRtcUserVolumeInfo

发言人音量信息。

3.0

DingRtcAuthInfo

入会鉴权信息。

3.0

DingRtcWatermarkConfig

水印配置。

3.0

DingRtcVideoCanvas

显示视图配置。

3.0

DingRtcAudioDataSample

音频数据采样。

3.0

DingRtcCameraCapturerConfiguration

摄像头采集偏好。

3.0

DingRtcVideoEncoderConfiguration

相机流视频编码属性设置。

3.0

DingRtcScreenShareEncoderConfiguration

屏幕流编码属性设置。

3.0

DingRtcVideoFrame

视频帧数据结构。

3.0

DingRtcVideoExternalEncoderParameter

Qos反馈外置编码器参数结构体。

3.0

DingRtcScreenShareRegion

屏幕分享区域(仅适用于Mac系统)。

3.0

DingRtcScreenShareConfig

屏幕分享配置(仅适用于Mac系统)。

3.0

DingRtcScreenSourceInfo

屏幕分享源信息(仅适用于Mac系统)。

3.0

DingRtcScreenShareInfo

屏幕分享配置信息(仅适用于Mac系统)。

3.0

DingRtcDeviceInfo

设备信息(仅适用于Mac系统)。

3.0

详情

  • DingRtcVideoTrack :视频流类型。

    枚举名

    描述

    DingRtcVideoTrackNo

    无摄像头和屏幕共享。

    DingRtcVideoTrackCamera

    摄像头。

    DingRtcVideoTrackScreen

    屏幕共享。

    DingRtcVideoTrackBoth

    摄像头+屏幕共享。

  • DingRtcAudioTrack :音频流类型。

    枚举名

    描述

    DingRtcAudioTrackNo

    无麦克风。

    DingRtcAudioTrackMic

    麦克风。

  • DingRtcNetworkQuality :网络质量。

    枚举名

    描述

    DingRtcNetworkQualityGood

    网络质量好。

    DingRtcNetworkQualityPoor

    网络质量差。

    DingRtcNetworkQualityDisconnect

    网络中断。

    DingRtcNetworkQualityUnknown

    未知。

  • DingRtcAudioProfile :音频编码模式。

    枚举名

    描述

    DingRtcEngineBasicQualityMode

    标准音质模式,默认16000Hz采样率,单声道,最大编码码率24kbps。

    DingRtcEngineHighQualityMode

    高音质模式,默认48000Hz采样率,单声道,最大编码码率48kbps。

    DingRtcEngineSuperHighQualityMode

    超高音质模式,默认48000Hz采样率,单声道,最大编码码率96kbps。

  • DingRtcAudioScenario :音频场景模式。

    枚举名

    描述

    DingRtcSceneDefaultMode

    默认场景,一般的音视频通信场景推荐使用。

  • DingRtcRenderMode :视图显示模式。

    枚举名

    描述

    DingRtcRenderModeAuto

    自动模式。

    DingRtcRenderModeStretch

    延伸模式。

    DingRtcRenderModeFill

    填充模式。

    DingRtcRenderModeCrop

    裁剪模式。

  • DingRtcLogLevel :Log级别。

    枚举名

    描述

    DingRtcLogLevelInfo

    只输出>=DingRtcLogLevelInfo级别的日志。

    DingRtcLogLevelWarn

    只输出>=DingRtcLogLevelWarn级别的日志。

    DingRtcLogLevelError

    只输出>=DingRtcLogLevelError级别的日志。

    DingRtcLogLevelNone

    不输出日志。

  • DingRtcVideoEncoderFrameRate :视频编码帧率。

    枚举名

    描述

    DingRtcVideoEncoderFrameRate_FPS_5

    5FPS。

    DingRtcVideoEncoderFrameRate_FPS_10

    10FPS。

    DingRtcVideoEncoderFrameRate_FPS_15

    15FPS。

    DingRtcVideoEncoderFrameRate_FPS_20

    20FPS。

    DingRtcVideoEncoderFrameRate_FPS_30

    30FPS。

  • DingRtcVideoEncoderMirrorMode :编码视频镜像模式。

    枚举名

    描述

    DingRtcVideoEncoderMirrorModeDisabled

    编码视频镜像。

    DingRtcVideoEncoderMirrorModeEnabled

    编码视频不镜像。

  • DingRtcRotationMode :视频旋转角度。

    枚举名

    描述

    DingRtcRotationMode_0

    旋转0度。

    DingRtcRotationMode_90

    旋转90度。

    DingRtcRotationMode_180

    旋转180度。

    DingRtcRotationMode_270

    旋转270度。

  • DingRtcVideoEncoderOrientationMode :编码视频旋转模式。

    枚举名

    描述

    DingRtcVideoEncoderOrientationModeAdaptive

    自适应,和采集视频保持一致。

    DingRtcVideoEncoderOrientationModeFixedLandscape

    固定横屏。

    DingRtcVideoEncoderOrientationModeFixedPortrait

    固定竖屏。

  • DingRtcOrientationMode :设备方向(仅适用于iOS系统)。

    枚举名

    描述

    DingRtcOrientationModePortrait

    竖屏模式。

    DingRtcOrientationModeLandscapeLeft

    左横屏模式。

    DingRtcOrientationModePortraitUpsideDown

    倒立模式。

    DingRtcOrientationModeLandscapeRight

    右横屏模式。

    DingRtcOrientationModeAuto

    由SDK自己决定。

  • DingRtcAudioSessionOperationRestriction :SDK对AudioSession的控制权限(仅适用于iOS系统)。

    枚举名

    描述

    DingRtcAudioSessionOperationRestrictionNone

    没有限制,SDK完全控制AVAudioSession。

    DingRtcAudioSessionOperationRestrictionSetCategory

    SDK不能修改AVAudioSession的Category。

    DingRtcAudioSessionOperationRestrictionConfigureSession

    SDK不能修改AVAudioSession的配置,包括Category,Mode,CategoryOptions。

    DingRtcAudioSessionOperationRestrictionDeactivateSession

    SDK不能关闭AVAudioSession的活动状态,离开频道时,AVAudioSession依然处于活动状态。

  • DingRtcVideoStreamType :相机流类型。

    枚举名

    描述

    DingRtcVideoStreamTypeNone

    无,在OnSubscribeStreamTypeChanged回调表示当前未订阅。

    DingRtcVideoStreamTypeFHD

    超高清流(设备性能、网络状态、推流分辨率符合要求情况下满足),对应1080P收费档。

    DingRtcVideoStreamTypeHD

    高清流(设备性能、网络状态、推流分辨率符合要求情况下满足),对应720P收费档。

    DingRtcVideoStreamTypeSD

    标清(设备性能、网络状态、推流分辨率符合要求情况下满足),对应480P收费档。

    DingRtcVideoStreamTypeLD

    流畅(设备性能、网络状态、推流分辨率符合要求情况下满足),对应480P收费档。

  • DingRtcDeviceVolumeType :设备音量类型(仅适用于iOS系统)。

    枚举名

    描述

    DingRtcDeviceVolumeTypeAuto

    SDK自动设置音量类型。

    DingRtcDeviceVolumeTypeMedia

    设置为媒体音量,适合媒体播放场景,音量可以调节到零。

    DingRtcDeviceVolumeTypeVOIP

    设置为通话音量,适合通话场景,音量无法调节到零。

  • DingRtcVideoSource :视频裸数据源类型。

    枚举名

    描述

    DingRtcVideosourceCameraType

    视频流。

    DingRtcVideosourceScreenShareType

    屏幕共享流。

    DingRtcVideosourceBoth

    Forvideorecord。

    DingRtcVideosourceTypeMax

    占位符,无意义。

  • DingRtcAudioObservePosition :音频数据源类型。

    枚举名

    描述

    DingRtcAudioObservePositionCaptured

    采集的音频数据。

    DingRtcAudioObservePositionProcessCaptured

    3A后的音频数据。

    DingRtcAudioObservePositionPub

    推流的音频数据。

    DingRtcAudioObservePositionPlayback

    播放的音频数据。

  • DingRtcAudioSource :音频数据源类型。

    枚举名

    描述

    DingRtcAudioSourceCaptured

    采集的音频数据。

    DingRtcAudioSourceProcessCaptured

    3A后的音频数据。

    DingRtcAudioSourcePub

    推流的音频数据。

    DingRtcAudioSourcePlayback

    播放的音频数据。

  • DingRtcVideoFormat :视频数据格式。

    枚举名

    描述

    DingRtcVideoFormat_UNKNOW

    未知。

    DingRtcVideoFormat_BGRA

    BGRA。

    DingRtcVideoFormat_I420

    I420。

    DingRtcVideoFormat_NV21

    NV21。

    DingRtcVideoFormat_NV12

    NV12。

    DingRtcVideoFormat_RGBA

    RGBA。

    DingRtcVideoFormat_I422

    I422。

    DingRtcVideoFormat_ARGB

    ARGB。

    DingRtcVideoFormat_ABGR

    ABGR。

    DingRtcVideoFormat_RGB24

    RGB24。

    DingRtcVideoFormat_BGR24

    BGR24。

    DingRtcVideoFormat_RGB565

    RGB565。

    DingRtcVideoFormat_H264

    H264。

  • DingRtcBufferType :视频数据类型。

    枚举名

    描述

    DingRtcBufferType_Raw_Data

    YUV裸数据。

    DingRtcBufferType_CVPixelBuffer

    CVPixelBuffer数据。

  • DingRtcAudioNumChannel :音频声道数。

    枚举名

    描述

    DingRtcMonoAudio

    单声道。

    DingRtcStereoAudio

    双声道。

  • DingRtcRecordingQuality :文件录制质量(仅适用于iOS系统)。

    枚举名

    描述

    DingRtcRecording_Low_Quality

    低质量文件录制,文件体积较小,音质一般。

    DingRtcRecording_Midium_Quality

    中等质量文件录制,文件体积中等,音质中等。

    DingRtcRecording_High_Quality

    高质量文件录制,文件体积较大,音质较好。

  • DingRtcAudioEffectVoiceChangerMode :变声音效模式。

    枚举名

    描述

    DingRtcAudioEffectvVoiceChanger_OFF

    关闭变声音效。

    DingRtcAudioEffectvVoiceChanger_OLD_MAN

    老人。

    DingRtcAudioEffectvVoiceChanger_BABYBOY

    男孩。

    DingRtcAudioEffectvVoiceChanger_BABYGILR

    女孩。

    DingRtcAudioEffectvVoiceChanger_ROBOT

    机器人。

    DingRtcAudioEffectvVoiceChanger_DAIMO

    大魔王。

    DingRtcAudioEffectvVoiceChanger_KTV

    KTV。

    DingRtcAudioEffectvVoiceChangerR_ECHO

    回声。

    DingRtcAudioEffectvVoiceChanger_MAX

    占位符。

  • DingRtcAudioEffectReverbMode :音效混响模式。

    枚举名

    描述

    DingRtcAudioEffectReverb_Off

    关闭混响。

    DingRtcAudioEffectReverb_Vocal_I

    人声I。

    DingRtcAudioEffectReverb_Vocal_II

    人声II。

    DingRtcAudioEffectReverb_Bathroom

    澡堂。

    DingRtcAudioEffectReverb_Small_Room_Bright

    明亮小房间。

    DingRtcAudioEffectReverb_Small_Room_Dark

    黑暗小房间。

    DingRtcAudioEffectReverb_Medium_Room

    中等房间。

    DingRtcAudioEffectReverb_Large_Room

    大房间。

    DingRtcAudioEffectReverb_Church_Hall

    教堂走廊。

    DingRtcAudioEffectReverb_Mode_Max

    占位符。

  • DingRtcAudioEffectReverbParamType :音效混响参数。

    枚举名

    描述

    DingRtcAudioEffectReverb_Room_Size

    房间大小,取值范围:[0,100]。

    DingRtcAudioEffectReverb_Pre_Delay

    预延时,单位ms,取值范围:[0,200]。

    DingRtcAudioEffectReverb_Revetberance

    混响感,取值范围:[0,100]。

    DingRtcAudioEffectReverb_Hf_Damping

    消声,取值范围:[0,100]。

    DingRtcAudioEffectReverb_Tone_Low

    低音调,取值范围:[0,100]。

    DingRtcAudioEffectReverb_Tone_High

    高音调,取值范围:[0,100]。

    DingRtcAudioEffectReverb_Dry_Gain

    干增益,取值范围:[-20,10]。

    DingRtcAudioEffectReverb_Wet_Gain

    湿增益,取值范围:[-20,10]。

    DingRtcAudioEffectReverb_Type_Max

    占位符。

  • DingRtcConnectionStatus :网络连接状态。

    枚举名

    描述

    DingRtcConnectionStatusInit

    初始化完成。

    DingRtcConnectionStatusDisconnected

    网络连接断开。

    DingRtcConnectionStatusConnecting

    建立网络连接中。

    DingRtcConnectionStatusConnected

    网络已连接。

    DingRtcConnectionStatusReconnecting

    重新建立网络连接中。

    DingRtcConnectionStatusFailed

    网络连接失败。

  • DingRtcConnectionStatusChangeReason :引起网络状态变更原因。

    枚举名

    描述

    DingRtcConnectionChangedDummyReason

    未知原因。

    DingRtcConnectionChangedSignalingHeartbeatTimeout

    心跳超时。

    DingRtcConnectionChangedSignalingHeartbeatDingve

    心跳恢复。

    DingRtcConnectionChangedSignalingJoinChannelFailure

    加入频道失败。

    DingRtcConnectionChangedSignalingJoinChannelSuccess

    加入频道成功。

    DingRtcConnectionChangedSignalingLeaveRoom

    离开频道。

    DingRtcConnectionChangedSignalingConnecting

    信令建立连接。

    DingRtcConnectionChangedNetworkInterrupted

    网络连接中断。

  • DingRtcChannelProfile :频道类型。

    枚举名

    描述

    DingRtcCommunication

    通信模式。

    DingRtcInteractivelive

    互动模式。

    DingRtcInteractiveWithLowLatencyLive

    低延时互动直播模式。

  • DingRtcClientRole :角色类型。

    枚举名

    描述

    DingRtcClientRoleInteractive

    互动角色。

    DingRtcClientRolelive

    观众角色。

  • DingRtcMuteLocalAudioMode :本地静音模式。

    枚举名

    描述

    DingRtcMuteAudioModeDefault

    默认模式(静音全部,包括麦克风及外部输入音频)。

    DingRtcMuteAllAudioMode

    静音全部(包括麦克风及外部输入音频)。

    DingRtcMuteOnlyMicAudioMode

    只静音麦克风。

  • DingRtcRenderMirrorMode :镜像模式。

    枚举名

    描述

    DingRtcRenderMirrorModeOnlyFrontCameraPreviewEnabled

    只有前置摄像头预览镜像,其余不镜像(仅适用于iOS系统)。

    DingRtcRenderMirrorModeAllEnabled

    镜像开启。

    DingRtcRenderMirrorModeAllDisabled

    镜像关闭。

  • DingRtcAudioPlayingStateCode :音乐伴奏播放状态。

    枚举名

    描述

    DingRtcAudioPlayingStarted

    开始播放。

    DingRtcAudioPlayingStopped

    停止播放。

    DingRtcAudioPlayingPaused

    播放暂停。

    DingRtcAudioPlayingResumed

    播放恢复。

    DingRtcAudioPlayingEnded

    播放完毕。

    DingRtcAudioPlayingBuffering

    正在缓冲。

    DingRtcAudioPlayingBufferingEnd

    缓冲结束。

    DingRtcAudioPlayingFailed

    播放失败。

  • DingRtcAudioPlayingErrorCode :音乐伴奏播放错误码。

    枚举名

    描述

    DingRtcAudioPlayingNoError

    没有错误。

    DingRtcAudioPlayingOpenFailed

    打开文件失败。

    DingRtcAudioPlayingDecodeFailed

    解码文件失败。

  • DingRtcAudioQuality :录制音频质量。

    枚举名

    描述

    DingRtcAudioQualityLow

    低质量文件录制,文件体积较小,音质一般。

    DingRtcAudioQualityMidium

    中等质量文件录制,文件体积中等,音质中等。

    DingRtcAudioQualityHigh

    高质量文件录制,文件体积较大,音质较好。

  • DingRtcVideoQuality :录制视频质量。

    枚举名

    描述

    DingRtcVideoQualityDefault

    默认,和采集保持一致。

  • DingRtcAudioSampleRate :录制音频采样率。

    枚举名

    描述

    DingRtcAudioSampleRate_8000

    采样率:8000。

    DingRtcAudioSampleRate_11025

    采样率:11025。

    DingRtcAudioSampleRate_16000

    采样率:16000。

    DingRtcAudioSampleRate_22050

    采样率:22050。

    DingRtcAudioSampleRate_32000

    采样率:32000。

    DingRtcAudioSampleRate_44100

    采样率:44100。

    DingRtcAudioSampleRate_48000

    采样率:48000。

  • DingRtcAudioRouteType :语音路由(仅适用于iOS系统)。

    枚举名

    描述

    DingRtcAudioRouteTypeDefault

    默认的语音路由。

    DingRtcAudioRouteTypeHeadset

    耳机。

    DingRtcAudioRouteTypeEarpiece

    听筒。

    DingRtcAudioRouteTypeHeadsetNoMic

    不带麦克风的耳机。

    DingRtcAudioRouteTypeSpeakerphone

    手机扬声器。

    DingRtcAudioRouteTypeLoudSpeaker

    外接扬声器。

    DingRtcAudioRouteTypeBlueTooth

    蓝牙耳机。

  • DingRtcShowDebugViewType :显示仪表盘类型。

    枚举名

    描述

    DingRtcShowTypeNone

    不显示。

    DingRtcShowTypeAudio

    音频。

    DingRtcShowTypeVideo

    视频。

    DingRtcShowTypeNetwork

    网络。

    DingRtcShowTypeAll

    全部。

  • DingRtcScreenShareMode :屏幕共享模式支持位运算按需组合。

    枚举名

    描述

    DingRtcScreenShareNone

    不共享音视频流。

    DingRtcScreenShareVideo

    共享视频流。

    DingRtcScreenShareAudioApp

    共享App音频流。

    DingRtcScreenShareAll

    共享所有音视频流,不支持屏幕共享Mic音频流,请使用SDK自带的Mic音频采集。

  • DingRtcErrorCode :错误码。

    枚举名

    描述

    DingRtcErrNone

    状态正常,无错误。

    DingRtcErrJoinBadAppId

    AppId不存在,请在控制台创建应用。

    DingRtcErrJoinInvalidAppId

    AppId已失效,请在控制台重新启用应用。

    DingRtcErrJoinBadChannel

    频道不存在,请尝试重新加入频道。如会议发起者入会后又很快离会,第二个人随后入会,发现会议已经不存在了。

    DingRtcErrJoinInvalidChannel

    频道已经失效(目前频道有效期为48小时),请重新生成频道鉴权令牌(Token)。

    DingRtcErrJoinBadToken

    Token无效。请重新生成频道鉴权令牌(Token)。

    DingRtcErrJoinTimeout

    加入频道超时,请检查网络连接是否正常。

    DingRtcErrJoinBadParam

    参数错误,DingRtcAuthInfo中的字段为空或者timestamp<=0,请检查字段是否完整。

    DingRtcErrJoinChannelFailed

    加入频道失败。

    DingRtcErrLogAlreadyInit

    日志模块已经初始化。

    DingRtcErrLogRootPathError

    日志模块根路径错误,请检查路径是否存在或路径是否具有写入权限。

    DingRtcErrMicOpenFail

    采集设备初始化失败、采集设备媒体服务异常、音频设备被占用。Mac端和Windows端查看系统设置中音频设备是否有能量条。iOS端和Android端确认是否被其他应用占用。如果都正常,请重启设备。

    DingRtcErrSpeakerOpenFail

    播放设备初始化失败、播放设备媒体服务异常、音频设备被占用。Mac端和Windows端查看系统设置中音频设备是否有能量条。iOS端和Android端确认是否被其他应用占用。如果都正常,请重启设备。

    DingRtcErrMicInterrupt

    系统性能不足、采集设备媒体服务异常、音频设备被占用。建议重启应用或重启设备。

    DingRtcErrSpeakerInterrupt

    系统性能不足,播放设备媒体服务异常,音频设备被占用。建议重启应用或重启设备。

    DingRtcErrMicAuthFail

    麦克风设备未授权,建议去系统设置中,打开麦克风授权,并且重新加入频道。

    DingRtcErrMicNotAvailable

    无可用的音频采集设备,检查是否接入了可用的麦克风,并检查系统设置中,该设备是否被禁用。

    DingRtcErrSpeakerNotAvailable

    无可用的音频播放设备,检查是否接入了可用的扬声器或耳机,并检查系统设置中,该设备是否被禁用。

    DingRtcErrCameraOpenFail

    采集设备初始化失败,检查系统相机是否可用,移动端App是否占用了相机。

    DingRtcErrCameraInterrupt

    采集过程中出现异常,Mac、Winodows电脑相机采集灯熄灭,设备被强制中断。建议重新加入频道或者重启App。

    DingRtcErrDisplayOpenFail

    渲染设备初始化失败,检查Windows端显卡驱动是否需要升级,移动端手机型号或者Android平板盒子等外设是否支持OpenGL。

    DingRtcErrDisplayInterrupt

    渲染过程中出现异常,系统异常错误导致渲染引擎报错,重新加入频道或者重启App。

    DingRtcErrIceConnectionConnectFail

    媒体通道建立失败,检查网络连接是否正常。

    DingRtcErrIceConnectionReconnectFail

    媒体通道重连失败,检查网络连接是否正常。

    DingRtcErrConnectionHeartbeatTimeout

    信令心跳超时,检查网络连接是否正常。

    DingRtcErrCdnLiveCommunicationFailed

    低延时互动直播信令失败。

    DingRtcErrCdnLiveMeidaSettingFailed

    低延时互动直播媒体设置错误。

    DingRtcErrCdnLiveNoneBroadcaster

    低延时互动直播当前房间没有主播推流。

    DingRtcErrCdnLiveNeedRestart

    低延时互动直播错误,应用层需要重新创建新的SDK实例。

    DingRtcErrCdnLiveNeedRestartAgainLater

    低延时互动直播错误,应用层需要稍等一定时间(自定义间隔)重新创建新的SDK实例。

    DingRtcErrCdnLiveServiceUnavailable

    低延迟互动直播服务不可用或者服务降级,客户端应该选择其它方式拉超大方会流,即不从cdnsfu拉流。

    DingRtcErrCdnLiveMediaConnectionInterruption

    低延迟互动直播网络中断错误,销毁当前sdk实例重新创建sdk后重新走订阅流程,已废弃。

    DingRtcErrPublishInvaild

    推流无效。

    DingRtcErrPublishNotJoinChannel

    未进入频道推流失败。

    DingRtcErrPublishAudioStreamFailed

    推送音频流失败。

    DingRtcErrPublishVideoStreamFailed

    推送视频流失败。

    DingRtcErrPublishScreenShareFailed

    推送屏幕共享失败。

    DingRtcErrPublishScreenShareConfigError

    屏幕共享配置错误。

    DingRtcErrSubscribeInvaild

    订阅无效。

    DingRtcErrSubscribeNotJoinChannel

    未进入频道订阅错误。

    DingRtcErrSubscribeAudioStreamFailed

    订阅音频流失败。

    DingRtcErrSubscribeVideoStreamFailed

    订阅视频流失败。

    DingRtcErrSubscribeScreenShareFailed

    订阅屏幕共享失败。

    DingRtcErrSdkInvalidState

    SDK状态错误,建议销毁SDK重新创建实例。

    DingRtcErrInvalidArguments

    参数不匹配。

    DingRtcErrSessionRemoved

    Session已经被移除,建议销毁实例之后重新创建实例并加入频道,已废弃。

    DingRtcErrAudioBufferFull

    buffer队列饱和,用于外部输送裸数据功能,建议降低外部输入频次,设置等待20ms,并且单次不超过40ms数据。

    DingRtcErrVideoBufferFull

    buffer队列饱和,用于外部输送裸数据功能,建议降低外部输入频次,设置等待视频帧间隔后再输入。

    DingRtcErrUpdateRoleChannel

    互动模式下设置角色错误。

    DingRtcErrInner

    SDK内部错误。

  • DingRtcOnByeType :OnBye类型。

    枚举名

    描述

    DingRtcOnByeBeKickedOut

    当前user被踢出channel。

    DingRtcOnByeChannelTerminated

    channel已结束,需要离开会议。

    DingRtcOnByeUserReplaced

    相同userID在其他设备joinChannel,当前设备被下线。

    DingRtcOnByeNeedRelogin

    信令服务失败,自动重连失败,需要用户手动重试。

  • DingRtcCaptureOutputPreference :采集偏好。

    枚举名

    描述

    DingRtcCaptureOutputPreferenceAuto

    SDK自动调整采集参数。

    DingRtcCaptureOutputPreferencePerformance

    SDK优先保证设备性能,根据设置编码参数选择最接近的摄像头输出参数。

    DingRtcCaptureOutputPreferencePreview

    SDK优先保证视频预览质量,选择较高的摄像头输出参数。

  • DingRtcCameraDirection :摄像头方向(仅适用于iOS系统)。

  • DingRtcPublishState :推流状态。

    枚举名

    描述

    DingRtcStatsPublishIdle

    0:SDK初始推流状态。

    DingRtcStatsNoPublish

    1:未推流状态,可能是因为:已设置停止推送媒体流;推送媒体流失败。

    DingRtcStatsPublishing

    2:推流链接建立过程中。

    DingRtcStatsPublished

    3:推流成功。

  • DingRtcSubscribeState :订阅状态。

    枚举名

    描述

    DingRtcStatsSubscribeIdle

    初始状态。

    DingRtcStatsNoSubscribe

    未订阅。

    DingRtcStatsSubscribing

    订阅中。

    DingRtcStatsSubscribed

    已订阅。

  • DingRtcUserOfflineReason :用户离线原因。

    枚举名

    描述

    DingRtcUserOfflineQuit

    用户主动离开。

    DingRtcUserOfflineDropped

    因过长时间收不到对方数据包,超时掉线。

    DingRtcUserOfflineBecomeAudience

    用户身份从主播切换为观众时触发。

  • DingRtcScreenShareType :桌面分享类型(仅适用于Mac系统)。

    枚举名

    描述

    DingRtcScreenShareDesktop

    桌面分享。

    DingRtcScreenShareWindow

    窗口分享。

  • DingRtcExternalDeviceType :外接设备类型(仅适用于Mac系统)。

    枚举名

    描述

    DingRtcExternalTypeUnknown

    未知类型。

    DingRtcExternalTypeAudioCapture

    音频采集设备。

    DingRtcExternalTypeAudioPlayout

    音频播放设备。

    DingRtcExternalTypeVideoCapture

    视频采集设备。

  • DingRtcExternalDeviceState :外接设备状态(仅适用于Mac系统)。

    枚举名

    描述

    DingRtcExternalDeviceAdd

    新增外接设备。

    DingRtcExternalDeviceRemove

    移除外接设备。

  • DingRtcDeviceTransportType :设备传输类型(仅适用于Mac系统)。

  • DingRtcVideoState :视频状态。

    枚举名

    描述

    DingRtcVideoClose

    视频关闭。

    DingRtcVideoOpen

    视频打开。

  • DingRtcVideoEncodedFrameType :Qos反馈外置编码器请求帧类型

    枚举名

    描述

    DingRtcVideoEncodedFrameNULL

    默认:无。

    DingRtcVideoEncodedFrameIDR

    IDR帧。

    DingRtcVideoEncodedFrameLTR

    LTR帧。

    DingRtcVideoEncodedFrameB

    B帧。

  • DingRtcVideoFrameType :视频帧类型。

    枚举名

    描述

    DingRtcVideoFrameRaw

    裸数据类型。

    DingRtcVideoFramePixelBuffer

    CVPixelBufferRef类型。

  • DingRtcVideoPixelFormat :视频数据格式。

    枚举名

    描述

    DingRtcVideoI420

    I420。

    DingRtcVideoNV12

    NV12。

    DingRtcVideoBGRA

    BGRA。

  • DingRtcRecordAudioConfig:录制音频设置。

    参数名

    类型

    描述

    sampleRate

    DingRtcAudioSampleRate

    音频采样率类型。

    quality

    DingRtcAudioQuality

    音频录制质量。

    enableRecordExternalRenderPCM

    bool

    是否允许录制外部pcm输入渲染数据。

    enableRecordExternalCapturePCM

    bool

    是否允许录制外部pcm输入采集数据(仅适用于Mac系统)。

  • DingRtcRecordVideoCanvasConfig:录制视频分辨率(仅适用于Mac系统)。

    参数名

    类型

    描述

    canvasWidth

    int

    录制视频宽。

    canvasHeight

    int

    录制视频高。

  • DingRtcRecordVideoRational:录制视频坐标(仅适用于Mac系统)。

    参数名

    类型

    描述

    numerator

    uint32_t

    denominator

    uint32_t

  • DingRtcRecordVideoRectangle:录制视频位置信息(仅适用于Mac系统)。

    参数名

    类型

    描述

    left

    DingRtcRecordVideoRational

    top

    DingRtcRecordVideoRational

    width

    DingRtcRecordVideoRational

    height

    DingRtcRecordVideoRational

  • DingRtcRecordVideoConfig:录制视频设置。

    参数名

    类型

    描述

    quality

    DingRtcVideoQuality

    视频质量。

    sourceType

    DingRtcRecordType

    录制文件类型(仅适用于Mac系统)。

    canvas

    DingRtcRecordVideoCanvasConfig

    录制文件尺寸(仅适用于Mac系统)。

    fps

    int

    录制帧率(仅适用于Mac系统)。

    bitrate

    int

    录制码率(仅适用于Mac系统)。

  • DingRtcQualityReport:质量报告数据。

    参数名

    类型

    描述

    cpu_physical_cores

    int

    cpu_logic_cores

    int

    cpu_frequency_mhz

    int

    cpu_used_by_app

    int

    cpu_used_by_other_apps

    int

    memory_total_mb

    int

    memory_used_by_app

    int

    memory_used_by_other_apps

    int

    loss_rate

    int

    丢包率。

    rtt_ms

    int

    延时。

    recv_bitrate

    int

    接收码率。

    send_bitrate

    int

    发送码率。

    signal_level

    int

    network_type

    NSString *_Nonnull

    网络类型。

    audio_send_bitrate

    int

    音频发送码率。

    audio_send_volume

    int

    音频发送音量。

    audio_recv_bitrate

    int

    音频接收码率。

    audio_recv_volume

    int

    音频接收音量。

    camera_send_bitrate

    int

    视频发送码率。

    camera_send_capture_fps

    int

    视频发送的采集帧率。

    camera_send_drop_fps

    int

    camera_send_fps

    int

    视频发送帧率。

    camera_send_hw

    int

    camera_send_width

    int

    视频发送宽度。

    camera_send_height

    int

    视频发送高度。

    screenshare_send_bitrate

    int

    屏幕共享发送码率。

    screenshare_send_capture_fps

    int

    屏幕共享采集帧率。

    screenshare_send_drop_fps

    int

    screenshare_send_fps

    int

    屏幕共享发送帧率。

    screenshare_send_hw

    int

    screenshare_send_width

    int

    屏幕共享宽度。

    screenshare_send_height

    int

    屏幕共享高度。

    camera_recv_bitrate

    int

    视频接收码率。

    camera_recv_fps

    int

    视频接收帧率。

    camera_recv_render_fps

    int

    视频渲染器帧率。

    camera_recv_hw

    int

    camera_recv_width

    int

    视频接收宽度。

    camera_recv_height

    int

    视频接收高度。

    screenshare_recv_bitrate

    int

    屏幕共享接收码率。

    screenshare_recv_fps

    int

    屏幕共享接收帧率。

    screenshare_recv_render_fps

    int

    屏幕共享渲染帧率。

    screenshare_recv_hw

    int

    screenshare_recv_width

    int

    屏幕共享接收宽度。

    screenshare_recv_height

    int

    屏幕共享接收高度。

  • DingRtcStats:基础统计信息。

    参数名

    类型

    描述

    available_sent_kbitrate

    long long

    可用带宽(kb)。

    sent_kbitrate

    long long

    总发送码率(kb)。

    recv_kbitrate

    long long

    总接收码率(kb)。

    sent_bytes

    long long

    总发送数据量(bytes)。

    recv_bytes

    long long

    总接收数据量(bytes)。

    video_recv_kbitrate

    long long

    视频接收码率(kb)。

    video_sent_kbitrate

    long long

    视频发送码率(kb)。

    audio_recv_kbitrate

    long long

    音频接收码率(kb)。

    audio_sent_kbitrate

    long long

    音频发送码率(kb)。

    call_duration

    long long

    通话时长(s)。

    cpu_usage

    unsigned int

    进程CPU使用量。

    systemCpuUsage

    unsigned int

    系统CPU使用量。

    sent_loss_rate

    long long

    客户端到服务器的丢包率。

    sent_loss_pkts

    long long

    客户端到服务器的丢包数。

    sent_expected_pkts

    long long

    客户端到服务器的总包数。

    recv_loss_rate

    long long

    客户端到服务器的下行丢包率。

    recv_loss_pkts

    long long

    客户端到服务器的下行丢包数。

    recv_expected_pkts

    long long

    客户端到服务器的下行总包数。

    lastmile_delay

    long long

    客户端到服务器的延迟(ms)。

  • DingRtcLocalVideoStats:本地视频统计信息。

    参数名

    类型

    描述

    track

    DingRtcVideoTrack

    视频流track类型。

    targetEncodeBitrate

    unsigned int

    目标编码码率。

    actualEncodeBitrate

    unsigned int

    实际编码码率。

    sentBitrate

    unsigned int

    发送码率。

    captureFps

    unsigned int

    采集帧率。

    sentFps

    unsigned int

    发送帧率。

    encodeFps

    unsigned int

    编码器输出帧率。

    renderFps

    unsigned int

    渲染帧率。

    avgQpPerSec

    unsigned int

    每秒平均QP。

    encoderFrameWidth

    unsigned int

    编码帧宽。

    encoderFrameHeight

    unsigned int

    编码帧高。

    captureFrameWidth

    unsigned int

    采集帧宽。

    captureFrameHeight

    unsigned int

    采集帧高。

  • DingRtcRemoteVideoStats:远端视频统计信息。

    参数名

    类型

    描述

    userId

    NSString *_Nonnull

    远端用户userID。

    track

    DingRtcVideoTrack

    视频流track类型。

    width

    unsigned int

    视频帧的宽。

    height

    unsigned int

    视频帧的高。

    recvBitrate

    unsigned int

    接收码率。

    decoderOutputFrameRate

    unsigned int

    解码帧率。

    rendererOutputFrameRate

    unsigned int

    渲染帧率。

    packetLossRate

    unsigned int

    丢包率。

  • DingRtcLocalAudioStats:本地音频统计信息。

    参数名

    类型

    描述

    track

    DingRtcAudioTrack

    音频流track类型。

    numChannel

    unsigned int

    声道数。

    sentSamplerate

    unsigned int

    采样率

    sentBitrate

    unsigned int

    发送端音频的瞬时码率。

    inputLevel

    unsigned int

    输入音量。

  • DingRtcRemoteAudioStats:远端音频统计信息。

    参数名

    类型

    描述

    userId

    NSString *_Nonnull

    远端用户userID。

    packetLossRate

    unsigned int

    回调周期内的音频丢帧率。

    recvBitrate

    unsigned int

    接收流的瞬时码率。

    totalFrozenTime

    unsigned int

    远端用户加入频道后音频卡顿的累计时长(ms)。

    speechExpandRate

    unsigned int

    远端用户加入频道后音频非静音样本拉伸率。

  • DingRtcUserVolumeInfo:发言人音量信息。

    参数名

    类型

    描述

    userId

    NSString *_Nonnull

    发言人的用户ID。

    speechState

    BOOL

    发言状态,YES:正在说话,NO:没有说话。

    volume

    int

    音量值,取值范围[0,255]。

  • DingRtcAuthInfo:入会鉴权信息。

    参数名

    类型

    描述

    channelId

    NSString *_Nonnull

    频道ID。

    userId

    NSString *_Nonnull

    用户ID。

    appId

    NSString *_Nonnull

    应用ID。

    token

    NSString *_Nonnull

    令牌。

    gslbServer

    NSString *_Nullable

    GSLB地址。

  • DingRtcWatermarkConfig:水印配置。

    参数名

    类型

    描述

    visibleInPreview

    BOOL

    预览水印是否可见。

    positionInPortraitMode

    CGRect

    竖屏水印坐标信息。

    positionInLandscapeMode

    CGRect

    横屏水印坐标信息。

    alpha

    float

    水印透明度。

    normalized

    BOOL

    归一化。

  • DingRtcVideoCanvas:显示视图配置。

    参数名

    类型

    描述

    view

    DingRtcOSView *_Nonnull

    显示视图。

    renderMode

    DingRtcRenderMode

    渲染模式,默认值为DingRtcRenderModeAuto。

    mirrorMode

    DingRtcRenderMirrorMode

    镜像模式,默认值为DingRtcRenderMirrorModeAllDisabled。

    backgroundColor

    int

    背景颜色,格式为RGB的Hex。

    rotationMode

    DingRtcRotationMode

    旋转角度,默认值为DingRtcRotationMode_0。

    toBeRemoved

    BOOL

    是否移除。

  • DingRtcAudioDataSample:音频数据采样。

    参数名

    类型

    描述

    data

    void *_Nonnull

    音频数据。

    numOfSamples

    int

    采样点数(每个声道)。

    bytesPerSample

    int

    每个采样点字节数,通常是16bit(即2字节)。

    numOfChannels

    int

    声道数。

    sampleRate

    int

    采样率。

  • DingRtcCameraCapturerConfiguration:摄像头采集偏好。

    参数名

    类型

    描述

    preference

    DingRtcCaptureOutputPreference

    采集偏好。

    cameraDirection

    DingRtcCameraDirection

    摄像头方向(仅适用于iOS系统)。

  • DingRtcVideoEncoderConfiguration:相机流视频编码属性设置。

    参数名

    类型

    描述

    dimensions

    CGSize

    视频分辨率,默认值640x480,可自行设置分辨率,也可以选择上面预定义的分辨率。

    frameRate

    NSInteger

    视频帧率,默认值15,最大值30。

    mirrorMode

    DingRtcVideoEncoderMirrorMode

    推流镜像,默认DingRtcVideoEncoderMirrorModeDisabled,详见DingRtcVideoEncoderMirrorMode。

    orientationMode

    DingRtcVideoEncoderOrientationMode

    视频输出方向,默认DingRtcVideoEncoderOrientationModeAdaptive,详见DingRtcVideoEncoderOrientationMode。

    rotationMode

    DingRtcRotationMode

    推流旋转,默认DingRtcRotationMode_0,详见DingRtcRotationMode。

  • DingRtcScreenShareEncoderConfiguration:屏幕流编码属性设置。

    参数名

    类型

    描述

    dimensions

    CGSize

    视频分辨率,默认值0x0,最大值3840x2160。默认值表示推流分辨率等于屏幕采集的分辨率。

    frameRate

    NSInteger

    视频帧率,默认值5,最大值30。

    rotationMode

    DingRtcRotationMode

    推流旋转,默认DingRtcRotationMode_0,详见DingRtcRotationMode。

  • DingRtcVideoFrame:视频帧数据结构。

    参数名

    类型

    描述

    frameType

    DingRtcVideoFrameType

    pixelFormat

    DingRtcVideoPixelFormat

    timestamp

    long long

    时间戳。

    width

    int

    视频帧的宽。

    height

    int

    视频帧的高。

    rotation

    int

    视频帧的旋转角度。

    count

    int

    视频帧的数量。

    data

    void *_Nonnull

    视频帧数据。

    offset

    NSArray< NSNumber * > *_Nullable

    stride

    NSArray< NSNumber * > *_Nullable

    视频帧行间距。

    pixelBuffer

    CVPixelBufferRef _Nullable

    pixelBuffer数据。

  • DingRtcVideoExternalEncoderParameter:Qos反馈外置编码器参数结构体。

    参数名

    类型

    描述

    width

    NSInteger

    视频帧的宽。

    height

    NSInteger

    视频帧的高。

    frame_rate

    NSInteger

    编码帧率。

    bitrate_bps

    NSInteger

    码率。

  • DingRtcScreenShareRegion:屏幕分享区域(仅适用于Mac系统)。

    参数名

    类型

    描述

    originX

    float

    x坐标。

    originY

    float

    y坐标。

    width

    float

    宽度。

    height

    float

    高度。

  • DingRtcScreenShareConfig:屏幕分享配置(仅适用于Mac系统)。

    参数名

    类型

    描述

    isShareByRegion

    bool

    是否是区域分享。

    shareRegion

    DingRtcScreenShareRegion *_Nonnull

    区域分享的布局信息。

  • DingRtcScreenSourceInfo:屏幕分享源信息(仅适用于Mac系统)。

    参数名

    类型

    描述

    sourceId

    NSString *_Nonnull

    分享源ID。

    sourceName

    NSString *_Nonnull

    分享源名称。

  • DingRtcScreenShareInfo:屏幕分享配置信息(仅适用于Mac系统)。

    参数名

    类型

    描述

    sourceType

    DingRtcScreenShareType

    分享类型。

    sourceId

    NSString *_Nonnull

    分享源ID。

    config

    DingRtcScreenShareConfig *_Nonnull

    屏幕分享配置。

  • DingRtcDeviceInfo:设备信息(仅适用于Mac系统)。

    参数名

    类型

    描述

    deviceName

    NSString *_Nullable

    设备名称。

    deviceID

    NSString *_Nullable

    设备ID。

    deviceTransportType

    DingRtcDeviceTransportType

    设备传输类型。