如果你希望从此前版本的 Electron 客户端 SDK 升级到最新的客户端 SDK，请在工程文件中，替换最新的客户端 SDK 文件，并参考本文完成 API，回调，参数类型等的替换。
升级过程中，你可能需要参考老版本 API 文档归档。
| 变更详情 | 功能模块 | 方法 | 说明 |
|---|---|---|---|
| 参数变更 | 引擎管理 | feedback | 参数数据类型变更 |
| 接口名称变更 | CDN 推流 | startLiveTranscoding | 用 startPushMixedStreamToCDN 替代 |
stopLiveTranscoding | 用 stopPushStreamToCDN 替代 | ||
updateLiveTranscoding | 用 updatePushMixedStreamToCDN 替代 | ||
接口废弃 | 高级功能 |
| 用 |
| 用 |
| 变更详情 | 方法 | 说明 |
|---|---|---|
参数变更 | 参数
|
| 变更详情 | 错误码 | 说明 |
|---|---|---|
枚举值变更 |
|
名称变更：
|
ErrorCode | 新增错误码枚举值：kErrorCodeJoinRoomRoomForbidden=-1025 和 kErrorCodeJoinRoomUserForbidden=-1026。当服务端在指定房间封禁指定用户，而此用户加入房间失败，或从房间中被踢出时收到。 | |
废弃枚举值：kErrorCodeOverScreenPublishLimit=-1081，用 kErrorCodeOverStreamPublishLimit=-1080 代替。 |
接口类名称由 veRTCVideo 变更为 RTCVideo，veRTCRoom 变更为 RTCRoom。
| 变更详情 | 功能模块 | 变动前方法 | 变动后方法 | 备注 |
|---|---|---|---|---|
| 拆分 | 视频管理 | registerFaceDetectionObserver | * enableFaceDetection * disableFaceDetection | 解除人脸识别与视频特效之间的耦合，提升接口易用性。 |
| 废弃 | 范围语音 | registerRangeAudioObserver onRangeAudioInfor | None | 此前，在手动订阅的场景下，如果你希望使用范围语音功能，你必须注册相关回调获取的衰减系数，设定音量。 自此版本起，无论是手动订阅还是自动订阅，衰减效果都由 SDK 实现，无需使用此接口。 |
| 替代 | 音频管理 | muteAudioPlayback | setPlaybackVolume | 将本地音量设置为 0 可静音本地音频播放 |
| 参数类型变更 | 屏幕共享 | public setVideoEncoderConfig(solutions: VideoEncoderConfig[]): number | setScreenVideoEncoderConfig(screenSolution: VideoEncoderConfig): any; | 参数类型变更为新增的 VideoEncoderConfig |
| 拆分 | 音视频处理 | * checkLicense * setAlgoModelPath | initCVResource | |
| enableEffect | * enableVideoEffect * disableVideoEffect | |||
| updateNode | updateEffectNode | |||
| setBackgroundSticker | * enableVirtualBackground * disableVirtualBackground | |||
| 参数变更 | 消息 | public sendSEIMessage(stream_index: number, message: Uint8Array, repeat_count: number) => number | public sendSEIMessage(stream_index: number,message: Uint8Array,repeat_count: number,mode: SEICountPerFrame): number | 支持 SEI 多发模式，即在 1 帧间隔内多次发送 SEI 数据时，多个 SEI 随下个视频帧同时发送。 |
以下表格中的回调发生了变化。你需要在工程文件中找到该回调，并进行相关修改：
| 变更详情 | 功能模块 | 变动前方法 | 变动后方法 | 备注 |
|---|---|---|---|---|
| 参数变更 | 消息 | onPublicStreamSEIMessageReceived(public_stream_id: string, message: string) => void | onPublicStreamSEIMessageReceived(public_stream_id: string, source_type: SEIMessageSourceType) => void | 新增参数 source_type |
| 接口废弃 | 音频管理 | onRemoteAudioStateChanged 和 onRemoteVideoStateChanged | / | |
| 接口废弃 | 音频管理 | onLocalAudioStateChanged 和 onLocalVideoStateChanged | 使用 onAudioDeviceStateChanged 和 onVideoDeviceStateChanged 代替 | |
| 替代 | CDN 推流 | * onStreamMixingVideoFrame * onStreamMixingAudioFrame * onStreamMixingDataFrame | * onMixingVideoFrame * onMixingAudioFrame * onMixingDataFrame |
| 变更详情 | 数据类型 | 备注 |
|---|---|---|
| 成员变量变更 | FaceDetectResult | 新增成员变量：frame_timestamp_us |
| 成员变量变更 | TranscoderAudioParam | 新增成员变量：audio_codec_type |
| 成员变量变更 | TranscoderVideoParam | 新增成员变量：bFrame 删除了：lowLatency 名称变更：video_codec_profile 变更为 video_codec_type，类型由 TranscoderVideoCodecProfile 改为 TranscoderVideoCodecType |
| 成员变量变更 | TranscoderLayoutRegion | 新增成员变量： corner_radius type data data_param spatial_position |
| 成员变量变更，名称变更 | ITranscoderParam | 类型名称由 TranscoderParam 改为 ITranscoderParam 新增成员变量：expected_mix_type: StreamMixingType |
| 枚举值变更 | TranscoderAudioCodecProfile | 删除了 kByteAACProfileMain kByteAACProfileHEv1 对应的数值由 2 变更为 1 kByteAACProfileHEv2 对应的数值由 3 变更为 2 |
| 配置变更 | RoomProfileType | 房间属性的默认值 kRoomProfileTypeCommunication = 0，对应的由 kRoomProfileTypeChatRoom = 6 变更为 kRoomProfileTypeMeeting = 16。 |
| 新增 | PublicStreamErrorCode | onPlayPublicStreamResult 和 onPushPublicStreamResult 中的 errorCode 参数类型由 int 改为 PublicStreamErrorCode |
| 参数数据结构改动 | AudioPropertiesConfig | 数据结构中，新增参数 smooth |
| 取值范围拓展 | TranscoderLayoutRegion 中，width 和 height | 取值范围由 (0.0, 1.0] 拓展为 [0.0, 1.0]。 |