通过阅读本文，您可以了解Electron SDK涉及的数据类型。
目录
详情
说明 枚举类型如果没有标注枚举值，枚举值默认从0开始递增。
- AliEngineAudioPlayingType：音乐伴奏播放状态。
枚举名 枚举值 描述 AliEngineAudioPlayingStarted 100 开始播放。 AliEngineAudioPlayingStopped 101 停止播放。 AliEngineAudioPlayingPaused 102 暂停播放。 AliEngineAudioPlayingResumed 103 重启播放。 AliEngineAudioPlayingEnded 104 播放结束。 AliEngineAudioPlayingBuffering 105 播放缓冲中。 AliEngineAudioPlayingBufferingEnd 106 播放缓冲完。 AliEngineAudioPlayingFailed 107 播放失败。 - AliEngineAudioPlayingErrorCode：音乐伴奏播放错误码。
枚举名 枚举值 描述 AliEngineAudioPlayingNoError 0 伴奏播放正常。 AliEngineAudioPlayingOpenFailed -100 伴奏播放打开失败。 AliEngineAudioPlayingDecodeFailed -101 伴奏播放解码失败。 - AliEngineConnectionStatus：网络连接状态。
枚举名 描述 AliEngineConnectionInit 初始化完成。 AliEngineConnectionDisconnected 网络连接断开。 AliEngineConnectionConnecting 建立网络连接中。 AliEngineConnectionConnected 网络已连接。 AliEngineConnectionReconnecting 重新建立网络连接中。 AliEngineConnectionFailed 网络连接失败。 - AliEngineConnectionStatusChangeReason：网络连接状态变更原因。
枚举名 描述 AliEngineConnectionChangedDummyReason 未知原因。 AliEngineConnectionMediaPathChanged 媒体通道变更。 AliEngineConnectionSignalingHeartbeatTimeout 心跳超时。 AliEngineConnectionSignalingHeartbeatAlive 心跳恢复。 AliEngineConnectionSignalingHttpdnsResolved DNS解析成功。 AliEngineConnectionSignalingHttpdnsFailure DNS解析失败。 AliEngineConnectionSignalingGslbFailure GSLB请求失败。 AliEngineConnectionSignalingGslbSucccess GSLB请求成功。 AliEngineConnectionSignalingJoinChannelFailure 加入频道失败。 AliEngineConnectionSignalingJoinChannelSuccess 加入频道成功。 AliEngineConnectionSignalingLeaveChannel 离开频道。 AliEngineConnectionSignalingConnecting 信令建立连接。 - AliEnginePublishState：推流状态。
枚举名 描述 AliEngineStatsPublishIdle 初始状态。 AliEngineStatsNoPublish 未推流。 AliEngineStatsPublishing 推流中。 AliEngineStatsPublished 已推流。 - AliEngineSubscribeState：订阅状态。
枚举名 描述 AliEngineStatsSubscribeIdle 初始状态。 AliEngineStatsNoSubscribe 未订阅。 AliEngineStatsSubscribing 订阅中。 AliEngineStatsSubscribed 已订阅。 - AliEngineVideoTrack：视频流类型。
枚举名 描述 AliEngineVideoTrackNo 无视频流。 AliEngineVideoTrackCamera 摄像头流。 AliEngineVideoTrackScreen 屏幕共享流。 AliEngineVideoTrackBoth 摄像头和屏幕共享。 - AliEngineAudioTrack：音频流类型。
枚举名 描述 AliEngineAudioTrackNo 无音频流。 AliEngineAudioTrackMic 麦克风流。 - AliEngineVideoStreamType：相机流类型。
枚举名 描述 AliEngineVideoStreamTypeNone 无视频流。 AliEngineVideoStreamTypeHigh 大流。 AliEngineVideoStreamTypeLow 小流。 - AliEngineVideoRecordSource：录制视频数据源。
枚举名 描述 AliEngineVideoRecordSourceCamera 摄像头流。 AliEngineVideoRecordSourceScreenShare 屏幕共享流。 AliEngineVideoRecordSourceBoth 摄像头和屏幕共享流。 - AliEngineRotationMode：视频旋转角度。
枚举名 枚举值 描述 AliEngineRotationMode_0 0 旋转0度。 AliEngineRotationMode_90 90 旋转90度。 AliEngineRotationMode_180 180 旋转180度。 AliEngineRotationMode_270 270 旋转270度。 - AliEngineAudioSampleRate：音频采样率类型。
枚举名 描述 AliEngineAudioSampleRate_8000 8000Hz。 AliEngineAudioSampleRate_11025 11025Hz。 AliEngineAudioSampleRate_16000 16000Hz。 AliEngineAudioSampleRate_22050 22050Hz。 AliEngineAudioSampleRate_32000 32000Hz。 AliEngineAudioSampleRate_44100 44100Hz。 AliEngineAudioSampleRate_48000 48000Hz。 - AliEngineNetworkQuality：网络质量。
枚举名 描述 AliEngineNetworkQualityExcellent 网络极好，流畅度清晰度质量好。 AliEngineNetworkQualityGood 网络质量好，流畅度清晰度和极好差不多。 AliEngineNetworkQualityPoor 网络质量较差，音视频流畅度清晰度有瑕疵，不影响沟通。 AliEngineNetworkQualityBad 网络质量差，视频卡顿严重，音频能正常沟通。 AliEngineNetworkQualityVeryBad 网络质量极差，基本无法沟通。 AliEngineNetworkQualityDisconnect 网络中断。 AliEngineNetworkQualityUnknow 未知。 - AliEngineAuthInfo：鉴权信息。
参数 类型 描述 channel string 频道号。 userid string 用户ID。 appid string 应用ID。 nonce string 令牌随机码。 token string 令牌。 timestamp number 时间戳。 gslb Array<string> 服务器地址。 displayName string 用户名字 - AliEngineOnByeType：OnBye类型。
枚举名 枚举值 描述 AliEngineOnByeBeKickOut 1 当前用户被踢出频道。 AliEngineOnByeChannelTerminated 2 频道结束。 AliEngineOnByeUserReplaced 3 相同用户在其他设备加入频道，当前设备被下线。 - AliEngineUserOfflineReason：用户离线原因。
枚举名 描述 AliEngineUserOfflineQuit 用户主动离开。 AliEngineUserOfflineDropped 因过长时间收不到对方数据包，超时掉线。 AliEngineUserOfflineBecomeAudience 用户身份从主播切换为观众时触发。 - AliEngineScreenShareType：桌面分享类型。
枚举名 描述 AliEngineScreenShareDesktop 桌面分享。 AliEngineScreenShareWindow 窗口分享。 - AliEngineClientRole：角色类型。
枚举名 枚举值 描述 AliEngineClientRoleInteractive 1 参与互动角色。 AliEngineClientRoleLive 2 仅观看角色。 - AliEngineExternalDeviceType：外接设备类型。
枚举名 枚举值 描述 AliEngineExternalTypeUnknown -1 未知类型。 AliEngineExternalTypeAudioCapture 0 音频采集设备。 AliEngineExternalTypeAudioPlayout 1 音频播放设备。 AliEngineExternalTypeVideoCapture 2 视频采集设备。 - AliEngineExternalDeviceState：外接设备状态。
枚举名 描述 AliEngineExternalDeviceAdd 新增外接设备。 AliEngineExternalDeviceRemove 移除外接设备。 - AliEngineMuteLocalAudioMode：本地静音模式。
枚举名 描述。 AliEngineMuteLocalAudioModeDefault 默认静音。 AliEngineMuteLocalAudioModeMuteAll 禁止本地所有音。 AliEngineMuteLocalAudioModeMuteOnlyMic 禁止麦克风。 - AliEngineUserVolumeInfo：用户音量信息。
参数 类型 描述 uid string 用户ID（从AppServer下发的唯一标示符）。 volume number 用户音量，取值范围：[0,255]。 speechState number 语音状态，取值： - 0：当前未说话。
- 1：当前在说话。
- AliEngineScreenShareRegion：屏幕共享区域。
参数 类型 描述 originX number x轴。 originY number y轴。 width number 宽度。 height number 高度。 - AliEngineScreenShareEncoderConfiguration：屏幕流码属性设置。
参数 类型 描述 dimensions AliEngineVideoDimensions 视频分辨率。 frameRate AliEngineFrameRate 视频帧率。 bitrate number 码率。 rotationMode AliEngineRotationMode 视频旋转角度。 - AliEngineScreenShareConfig：屏幕共享参数配置。
参数 类型 描述 isShareByRegion boolean 是否指定区域，默认false。 shareRegion AliEngineScreenShareRegion 屏幕分享区域。 - AliEngineScreenShareInfo：屏幕共享配置信息。
参数 类型 描述 shareType AliEngineScreenShareType 桌面分享类型。 shareSourceId number 共享源ID。 shareConfig AliEngineScreenShareConfig 屏幕共享参数配置。 - AliEngineStats：会话数据统计信息。
参数 类型 描述 sentKBitrate number 发送码率。 rcvdKBitrate number 接收码率。 sentBytes number 发送字节数。 rcvdBytes number 接收字节数。 systemCpu number 电脑CPU使用率。 appCpu number RTC进程CPU使用率。 videoRcvdKBitrate number 视频接收码率。 videoSentKBitrate number 视频发送码率。 callDuration number 通话时长，单位：秒。 sentLossRate number 发送丢包率。 lastmileDelay number 延时时长，单位：毫秒。 - AliEngineLocalVideoStats：本地视频统计信息。
参数 类型 描述 track AliEngineVideoTrack 视频流类型。 sentBitrate number 发送码率。 sentFps number 发送帧率。 encodeFps number 编码器输出帧率。 - AliEngineRemoteVideoStats：远端视频统计信息。
参数 类型 描述 userid string 用户ID。 track AliEngineVideoTrack 视频流类型。 width number 宽。 height number 高。 decodeFps number 编码器输出帧率。 renderFps number 渲染器输出帧率。 frozenTimes number 卡顿次数。 - AliEngineLocalAudioStats：本地音频统计信息。
参数 类型 描述 track AliEngineAudioTrack 音频流类型。 sentBitrate number 发送码率。 sentSamplerate number 发送的采样率。 numChannel number 声道数。 inputLevel number 输入音量。 - AliEngineRemoteAudioStats：远端音频统计信息。
参数 类型 描述 userid string 远端用户UID。 track AliEngineAudioTrack 音频流类型。 quality number 音质。 networkTransportDelay number 网络传输延时。 jitterBufferDelay number jitterBuffer延时。 audioLossRate number 音频丢包率。 rcvdBitrate number 接收码率。 totalFrozenTimes number 卡顿次数。 - AliEngineAudioProfile：音频编码配置。
枚举名 枚举值 描述 AliEngineLowQualityMode 0x0000 低音质。 AliEngineBasicQualityMode 0x0001 标准音质。 AliEngineHighQualityMode 0x0010 高音质。 AliEngineStereoHighQualityMode 0x0011 立体高音质。 AliEngineSuperHighQualityMode 0x0012 超高音质。 AliEngineStereoSuperHighQualityMode 0x0013 立体超高音质。 - AliEngineAudioScenario：音频场景。
枚举名 枚举值 描述 AliEngineSceneDefaultMode 0x0000 默认场景。 AliEngineSceneEducationMode 0x0100 教育场景。 AliEngineSeneMediaMode 0x0200 媒体场景。 AliEngineSceneMusicMode 0x0300 音乐场景。 - AliEngineRecordType：录制类型。
枚举名 描述 AliEngineRecordTypeAudio 纯音频录制。 AliEngineRecordTypeVideo 纯视频录制。 AliEngineRecordTypeBoth 音视频录制。 - AliEngineRecordFormat：录制格式。
枚举名 描述 AliEngineRecordFormatAAC AAC文件。 AliEngineRecordFormatWAV WAV文件。 AliEngineRecordFormatMP4 MP4文件。 - AliEngineAudioQuality：录制音频质量。
枚举名 描述 AliEngineAudioQualityLow 低。 AliEngineAudioQualityMidium 中。 AliEngineAudioQualityHigh 高。 - AliEngineVideoQuality：录制视频质量。
枚举名 描述 AliEngineVideoQualityDefault 默认和采集保持一致（例如采集能力为1080P，默认就录制1080P的视频流）。 - AliEngineRecordAudioConfig：录制音频设置。
参数 类型 描述 sampleRate AliEngineAudioSampleRate 音频采样率。 quality AliEngineAudioQuality 音频质量。 externalPcmCaptureRecording boolean 外部PCM输入录制。 externalPcmRenderRecording boolean 外部PCM渲染录制。 - AliEngineRecordVideoConfig：录制视频设置。
参数 类型 描述 fps number 帧率。 bitrate number 码率。 quality AliEngineVideoQuality 视频质量。 sourceType AliEngineVideoRecordSource 视频源类型。 - AliEngineFrameRate：视频帧率。
枚举名 枚举值 描述 AliEngineFrameRateFps5 5 5 fps。 AliEngineFrameRateFps10 10 10 fps。 AliEngineFrameRateFps15 15 15 fps。 AliEngineFrameRateFps20 20 20 fps。 AliEngineFrameRateFps25 25 25 fps。 AliEngineFrameRateFps30 30 30 fps。 - AliEngineOption：引擎初始化参数。
参数 类型 描述 h5CompatibleMode boolean 是否开启H5兼容。 extension Object 扩展参数。 - AliEngineVideoEncoderOrientationMode：视频输出模式。
枚举名 描述 AliEngineVideoEncoderOrientationModeAdaptive 自适应模式（默认值）。 AliEngineVideoEncoderOrientationModeFixedLandscape 横向模式。 AliEngineVideoEncoderOrientationModeFixedPortrait 纵向模式。 - AliEngineVideoMirrorMode：视频镜像模式。
枚举名 描述 AliEngineVideoMirrorModeDisabled 无镜像。 AliEngineVideoMirrorModeEnable 镜像。 - AliEngineVideoDimensions：视频分辨率。
参数 类型 描述 width number 宽。 height number 高。 - AliEngineVideoEncoderConfiguration：视频编码属性设置。
参数 类型 描述 dimensions AliEngineVideoDimensions 视频分辨率。 frameRate AliEngineFrameRate 视频帧率。 bitrate number 码率。 orientationMode AliEngineVideoEncoderOrientationMode 视频输出模式。 mirrorMode AliEngineVideoMirrorMode 视频镜像模式。 rotationMode AliEngineRotationMode 视频旋转模式。 - AliEngineChannelProfile：频道类型。
枚举名 描述 AliEngineCommunication 通信模式。 AliEngineInteractiveLive 互动模式。 - AliEngineErrorCode：SDK错误码。
枚举名 描述 AliEngineErrorJoinBadAppId App ID不存在。 AliEngineErrorJoinInvaildAppId App ID已失效。 AliEngineErrorJoinBadChannel 频道不存在。 AliEngineErrorJoinInvaildChannel 频道已失效。 AliEngineErrorJoinBadToken Token不存在。 AliEngineErrorJoinTimeout 加入频道超时。 AliEngineErrorJoinBadParam 加入频道参数错误。 AliEngineErrorJoinChannelFailed 加入频道失败。 AliEngineErrorMicOpenFail 采集设备初始化失败。 AliEngineErrorSpeakerOpenFail 播放设备初始化失败。 AliEngineErrorMicInterrupt 采集过程中出现异常。 AliEngineErrorSpeakerInterrupt 播放过程中出现异常。 AliEngineErrorMicAuthFail 麦克风设备授权失败。 AliEngineErrorMicNotAvailable 麦克风设备未授权。 AliEngineErrorSpeakerNotAvailable 无可用的音频采集设备。 AliEngineErrorCameraOpenFail 相机设备初始化失败。 AliEngineErrorCameraInterrupt 相机采集中发生异常。 AliEngineErrorVideoDisplayOpenFail 渲染设备初始化失败。 AliEngineErrorVideoDisplayInterrupt 渲染过程中出现异常。 AliEngineErrorAudioBufferFull 音频输入的buffer已满。 AliEngineErrorVideoBufferFull 视频输入的buffer已满。 AliEngineErrorAudioStreamError 音频流错误。 AliEngineErrorAudioFileOpenFail 音频文件打开失败。 AliEngineErrorAudioFormatNotSupported 音频格式不支持。 AliEngineErrorIceConnectionConnectFail 媒体通道建立失败。 AliEngineErrorIceConnectionReconnectFail 媒体通道重连失败。 AliEngineErrorIceConnectionHeartbeatTimeout 信令心跳超时。 AliEngineErrorLowLatencyLiveCommunicationFail 低延时互动直播信令失败。 AliEngineErrorLowLatencyLiveMediaSettingFail 低延时互动直播媒体设置错误。 AliEngineErrorLowLatencyLiveNoneBroadcaster 低延时互动直播当前房间没有主播推流。 AliEngineErrorLowLatencyLiveNeedRestart 低延时互动直播错误，应用层需要重新创建新的SDK实例。 AliEngineErrorLowLatencyLiveNeedRestartAgainLater 低延时互动直播错误，应用层需要稍等一定时间（自定义间隔）重新创建新的SDK实例。 AliEngineErrorLowLatencyLiveServiceUnavailable 低延时互动直播服务不可用或者服务降级。 AliEngineErrorLowLatencyLiveMediaConnectionInterrruption 低延时互动直播网络中断错误。 AliEngineErrorUpdateRoleChannel 更新频道角色失败。 AliEngineErrorPublishInvaild 推流无效。 AliEngineErrorPublishNotJoinChannel 未入会推流错误。 AliEngineErrorPublishAudioStreamFailed 推音频流失败。 AliEngineErrorPublishVideoStreamFailed 推视频流失败。 AliEngineErrorPublishDualStreamFailed 推双流失败。 AliEngineErrorPublishScreenShareFailed 推共享流失败。 AliEngineErrorPublishScreenShareConfigError 推共享流配置失败。 AliEngineErrorSubscribeInvaild 订阅无效。 AliEngineErrorSubscribeNotJoinChannel 未入会订阅错误。 AliEngineErrorSubscribeAudioStreamFailed 订阅音频流失败。 AliEngineErrorSubscribeVideoStreamFailed 订阅视频流失败。 AliEngineErrorSubscribeDualStreamFailed 订阅双流失败。 AliEngineErrorSubscribeScreenShareFailed 订阅共享流失败。 AliEngineErrorInvaildState SDK内部状态错误。 AliEngineErrorSessionRemoved session已经被移除。 AliEngineErrorInvaildArgument 无效的参数。 AliEngineErrorInner SDK内部错误。 - AliEngineBeautyConfig：美颜设置。
参数 类型 描述 whiteningLevel number 美白，范围：[0,1]，数值越大美白效果越好。 smoothnessLevel number 磨皮，范围：[0,1]，数值越大磨皮效果越好。 - AliEngineDeviceInfo：设备信息。
参数 类型 描述 deviceName string 设备名称。 deviceID string 设备ID。 - ChannelMediaOptions：入会选项。
参数 类型 描述 autoSubscribeAudio boolean 自动订阅音频，默认true。 autoSubscribeVideo boolean 自动订阅视频，默认true。 - AliEngineScreenItemInfo：屏幕共享源信息。
参数 类型 描述 sourceId string 源ID。 sourceTitle string 源名称。 - AliEngineUserInfo：用户信息。
参数 类型 描述 userid string 用户ID。 displayName string 用户昵称。 hasCameraMaster boolean 是否正在推大流。 hasCameraSlave boolean 是否正在推小流。 hasScreenSharing boolean 是否正在推屏幕流。 hasAudio boolean 是否正在推音频。 muteAudioPlaying boolean 是否正在静音。