DingRtcSDK接口说明-阿里云帮助中心

通过阅读本文，您可以了解到Ohos SDK的DingRtcSDK接口详情。

接口说明

API	描述	支持的最低版本
setRemoteVideoStreamType	设置订阅视频流分辨率规格。	3.0
setRemoteDefaultVideoStreamType	设置默认订阅的视频流分辨率规格；如果不设置，则默认订阅最大的分辨率规格。	3.0
subscribeAllRemoteAudioStreams	停止/恢复订阅所有远端音频流，包含后入会成员的订阅。	3.0
subscribeAllRemoteVideoStreams	停止/恢复订阅所有远端视频流，包含后入会成员的订阅。	3.0
subscribeRemoteVideoStream	停止/恢复订阅远端用户的视频流。	3.0

共享视频相关接口

API	描述	支持的最低版本
setScreenShareEncoderConfiguration	设置屏幕流视频编码属性。	3.0
isScreenSharePublished	查询是否设置推送屏幕分享。	3.0
startScreenShare	启动屏幕分享。	3.0
stopScreenShare	停止屏幕共享。	3.0

视频相关接口

API	描述	支持的最低版本
setLocalViewConfig	设置本地预览显示视图。	3.0
enableLocalVideo	禁用或启用本地视频采集。	3.0
muteLocalVideo	暂停/恢复本地视频流的发送。	3.0
snapshotVideo	视频截图功能。	3.0
setVideoEncoderConfiguration	设置相机流视频编码属性。	3.0
setRemoteViewConfig	设置远端视频显示视图。	3.0
updateViewConfig	更新本地或远端视图属性。	3.0
switchCamera	切换前后摄像头。	3.0

音频相关接口

API	描述	支持的最低版本
muteLocalAudio	停止/恢复本地音频数据发送。	3.0
enableSpeakerphone	设置音频输出为听筒还是扬声器。	3.0
isSpeakerphoneEnabled	获取当前音频输出为听筒还是扬声器。	3.0
setAudioProfile	设置音频profile。	3.0
enableAudioVolumeIndication	设置音量回调频率和平滑系数。	3.0

预览相关接口

API	描述	支持的最低版本
startPreview	开启本地视频预览。	3.0
stopPreview	关闭本地视频预览。	3.0

远端用户查询接口

API	描述	支持的最低版本
getOnlineRemoteUsers	获取远端在线用户列表。	3.0
getUserInfo	查询远端用户状态。	3.0
isUserOnline	查询用户是否在线。	3.0

其他接口

API	描述	支持的最低版本
setLogLevel	设置日志等级。	3.0
setLogDir	设置SDK日志文件保存路径。	3.0

setLogLevel

DingRtcSDK.setLogLevel(level: DingRtcConstants.LogLevel): void

Parameters
- ```
level: DingRtcConstants.LogLevel
```
Ingroup
- OHOS_DingRtcEngineOthers
Since
- 3.0
Brief
- 设置日志等级。
Return
- - 0：成功；
  - 非0：失败。比如没有先调用SetLogDirPath。
Note
- 调用此接口，请在调用其他所有SDK接口前调用本接口，避免日志出现丢失。同时，App必须保证指定的目录已存在并且可以写入。
Note
- 如果，目标路径不可写入或创建日志文件失败，则会使用默认日志路径。本次设置将无效。
Note
- 。
Note
- 调用此接口，请先于SetLogDirPath接口调用之前调用本接口，否则可能不起作用。
Note
- 如果设置为RtcEngineLogLevelNone，那么停止日志输出。

setLogDir

DingRtcSDK.setLogDir(dir: string): number

Parameters
- ```
dir: string
```
Returns
```
number
```
Ingroup
- OHOS_DingRtcEngineBase
Since
- 3.0
Brief
- 设置SDK日志文件保存路径。
Return
- ：路径已存在或因权限问题不可访问。
Note
- 调用此接口，请在调用其他所有SDK接口前调用本接口，避免日志出现丢失。同时，App必须保证指定的目录已存在并且可以写入。
Note
- 如果，目标路径不可写入或创建日志文件失败，则会使用默认日志路径。本次设置将无效。
Note
- 默认路径：data/app/el2/100/base/packageName/files/dingrtc/log。

create

DingRtcSDK.create(context: Context, extras?: string): DingRtc

Parameters
- ```
context: Context
```
- ```
extras?: string
```
Returns
```
DingRtc
```
Ingroup
- OHOS_DingRtcEngineBase
Since
- 3.0
Brief
- 创建一个RtcEngine实例。
Details
- 该方法为同步调用，支持多实例。

enableAudioLevelObserver

enableAudioLevelObserver(deviceType: DingRtcConstants.RtcEngineDeviceType, enable: boolean): number

Parameters
- ```
deviceType: DingRtcConstants.RtcEngineDeviceType
```
  音频设备类型。
- ```
enable: boolean
```
```
     - true表示开启音量观测。
     - false表示关闭音量观测。
```
Returns
```
number
```
Ingroup
- CPP_DingRtcEngineAudioDevice
Since
- 3.0
Brief
- 开启/关闭音频设备音量观测。
Return
- - 0：成功；
  - 非0：失败。
Note
- 回调采集和播放设备音量值。

enableAudioVolumeIndication

enableAudioVolumeIndication(interval: number, smooth: number, reportVad: number): number

Parameters
- ```
interval: number
```
  时间间隔，单位毫秒，最小值不得小于100ms, 建议设置300-500ms, <= 0表示不启用音量提示和说话人提示功能。
- ```
smooth: number
```
  平滑系数，数值越大平滑程度越高，反之越低，实时性越好，建议设置3，范围[0, 9]。
- ```
reportVad: number
```
  说话人检测开关。
  - 1：开启。
  - 0：关闭。
Returns
```
number
```
Ingroup
- OHOS_DingRtcEngineAudio
Since
- 3.0
Brief
- 设置音量回调频率和平滑系数。
Return
- - 0：成功；
  - <0：失败。

enableLocalVideo

enableLocalVideo(enabled: boolean): number

Parameters
- ```
enabled: boolean
```
```
     - true ：启用本地视频采集。
     - false ：禁用本地视频采集。
```
Returns
```
number
```
Ingroup
- OHOS_DingRtcEngineVideo
Since
- 3.0
Brief
- 禁用或启用本地视频采集。
Return
- - 0：成功；
  - 非0：失败。
Note
- 默认为开启状态。

enableSpeakerphone

enableSpeakerphone(enable: boolean): number

Parameters
- ```
enable: boolean
```
  true:扬声器模式；false:听筒模式。
Returns
```
number
```
Brief
- 设置音频输出为听筒还是扬声器（默认扬声器）。
Return
- - 0：成功；
  - 非0：失败。

getOnlineRemoteUsers

```
getOnlineRemoteUsers(): Array<string>
```
Returns
```
Array<string>
```
Ingroup
- OHOS_DingRtcEngineUserInfo
Since
- 3.0
Brief
- 获取远端在线用户列表。

getUserInfo

getUserInfo(uid: string): DingRtcConstants.UserInfo

Parameters
- ```
uid: string
```
  用户ID。从App server分配的唯一标示符。
Returns
```
DingRtcConstants.UserInfo
```
Ingroup
- OHOS_DingRtcEngineUserInfo
Since
- 3.0
Brief
- 查询远端用户状态。
Details
- 通过 uid 查询，指定远端用户的状态信息。
Return
- - 0：成功；
  - 非0：失败，返回值为具体的错误码。

isInCall

```
isInCall(): boolean
```
Returns
```
boolean
```
Ingroup
- OHOS_DingRtcEngineChannel
Since
- 3.0
Brief
- 获取状态：当前是否在频道中。
Return
- - - true：表示当前已经加入了频道；
  - false：表示当前不在频道中。
Note
- 该方法可在加入频道前或加入频道后调用。

isLocalAudioStreamPublished

```
isLocalAudioStreamPublished(): boolean
```
Returns
```
boolean
```
Ingroup
- OHOS_DingRtcEnginePub
Since
- 3.0
Brief
- 是否推送音频流。
Return
- - true：会推送；
  - false：不会推送。

isLocalVideoStreamPublished

```
isLocalVideoStreamPublished(): boolean
```
Returns
```
boolean
```
Ingroup
- OHOS_DingRtcEnginePub
Since
- 3.0
Brief
- 查询是否推送视频流。
Return
- - true：会推送；
  - false：不会推送。

isScreenSharePublished

```
isScreenSharePublished(): boolean
```
Returns
```
boolean
```
Ingroup
- OHOS_DingRtcEngineScreenShare
Since
- 3.0
Brief
- 是否推送屏幕分享。
Return
- - true：会推送；
  - false：不会推送。
Note
- 方法开启屏幕共享推送。

isSpeakerphoneEnabled

```
isSpeakerphoneEnabled(): boolean
```
Returns
```
boolean
```
Brief
- 获取是否已开启扬声器。
Return
- - true：已开启扬声器；
  - false：未开启扬声器。

isUserOnline

```
isUserOnline(uid: string): boolean
```
Parameters
- ```
uid: string
```
  用户ID，从App server分配的唯一标示符。不可为NULL。
Returns
```
boolean
```
Ingroup
- OHOS_DingRtcEngineUserInfo
Since
- 3.0
Brief
- 查询用户是否在线。
Return
- - true：用户在线；
  - false：用户不在线。
Note
- 根据特定的UserID，查询该用户是否在线。

joinChannel

joinChannel(authInfo: DingRtcConstants.AuthInfo, userName: string): number

Parameters
- ```
authInfo: DingRtcConstants.AuthInfo
```
  认证信息，从App Server获取。
- ```
userName: string
```
Returns
```
number
```
Ingroup
- OHOS_DingRtcEngineChannel
Since
- 3.0
Brief
- 该方法让用户加入频道，一个频道内可以加入多个用户进行互相通话。
Return
- - 0：成功；
  - <0：失败。
Note
- 回调收到后，再次调用进行入会。
  - userNameUtf8如果过长，超过64个字节，调用会失败。App业务系统应当避免过长的userNameUtf8传入进来。一般汉字占用3个字节，简单的emoji占用4~8个字节，一个复杂emoji占用34甚至更多字节。

leaveChannel

```
leaveChannel(): number
```
Returns
```
number
```
Ingroup
- OHOS_DingRtcEngineChannel
Since
- 3.0
Brief
- 离开频道，即挂断或者停止通话。
Details
- 会产生消息通知频道内其他用户。
Details
- 离开频道，否则无法进入下一个频道通话。
Details
- 回调。
Return
- - 0：成功；
  - 非0：失败。
Note
- 。

muteLocalAudio

```
muteLocalAudio(mute: boolean): number
```
Parameters
- ```
mute: boolean
```
```
    - true表示静音本地音频，发送静音帧。
    - false表示取消静音。
```
Returns
```
number
```
Ingroup
- OHOS_DingRtcEngineAudio
Since
- 3.0
Brief
- 静音/取消静音本地音频数据。
Return
- - 0：成功；
  - 非0：失败。
Note
- mute状态会保持，除非再次调用MuteLocalAudio更新，或者重新创建engine instance。

muteLocalVideo

muteLocalVideo(mute: boolean, track: DingRtcConstants.RtcEngineVideoTrack): number

Parameters
- ```
mute: boolean
```
```
     - true表示暂停视频流的发送。
     - false表示恢复视频流的发送。
```
- ```
track: DingRtcConstants.RtcEngineVideoTrack
```
  。
Returns
```
number
```
Ingroup
- OHOS_DingRtcEngineVideo
Since
- 3.0
Brief
- 暂停/恢复本地视频流的发送。
Return
- - 0：成功；
  - 非0：失败。
Note
- 视频流暂停发送时，采集和编码模块仍然在工作。

publishLocalAudioStream

publishLocalAudioStream(enable: boolean): number

Parameters
- ```
enable: boolean
```
  - 是否开启/关闭本地音频流推送。
  - true：开启音频流推送。
  - false：关闭音频流推送。
Returns
```
number
```
Ingroup
- OHOS_DingRtcEnginePub
Since
- 3.0
Brief
- 是否推送本地音频流。
Return
- - 0：设置成功；
  - <0：设置失败，返回错误码。
Note
- SDK默认设置不推送音频流，在加入频道前也可以调用此接口修改默认值，并在加入频道成功时生效。

publishLocalVideoStream

publishLocalVideoStream(enable: boolean): number

Parameters
- ```
enable: boolean
```
  - 是否开启/关闭本地视频流推送。
  - true：开启视频流推送。
  - false：关闭视频流推送。
Returns
```
number
```
Ingroup
- OHOS_DingRtcEnginePub
Since
- 3.0
Brief
- 是否推送本地视频（摄像头）流。
Return
- - 0：设置成功；
  - <0：设置失败，返回错误码。
Note
- SDK默认设置不推送视频流，在加入频道前也可以调用此接口修改默认值，并在加入频道成功时生效。

release

```
release(): void
```
Returns
```
void
```
Ingroup
- OHOS_DingRtcEngineBase
Since
- 3.0
Brief
- 销毁RtcEngine实例。
Details
- 方法创建一个新的实例。
Note
- 该方法为同步调用，需要等待内部资源释放之后才能执行其他方法。
Note
- 为避免死锁，不建议在任何SDK的回调中调用本方法。

setAudioProfile

setAudioProfile(profile: DingRtcConstants.AudioProfile, scene: DingRtcConstants.AudioScenario): number

Parameters
- ```
profile: DingRtcConstants.AudioProfile
```
- ```
scene: DingRtcConstants.AudioScenario
```
Returns
```
number
```
Ingroup
- OHOS_DingRtcEngineAudio
Since
- 3.0
Brief
- 设置音频profile。
Return
- - 0：成功；
  - 其他：失败。
Note
- 前设置有效。
Note
- 缺省RtcEngineHighQualityMode模式。

setDefaultAudioRouteToSpeakerphone

setDefaultAudioRouteToSpeakerphone(defaultToSpeakerphone: boolean): number

Parameters
- ```
defaultToSpeakerphone: boolean
```
  true：扬声器模式(默认扬声器)；false：听筒模式。
Returns
```
number
```
Brief
- 设置默认音频输出是否从扬声器出声，默认从扬声器出声。
Return
- - 0：成功；
  - 非0：失败。

setEventListener

setEventListener(listener: DingRtcEventListener): any

Parameters
- ```
listener: DingRtcEventListener
```
  用于接收来自engine的消息。
Ingroup
- OHOS_DingRtcEngineBase
Since
- 3.0
Brief
- 设置相关监听事件回调。
Details
- 类是SDK向应用发送自身回调事件的通知, 应用开发者需要实现该接口类的方法来获取相关事件通知。默认所有接口都有空实现，开发者不需要实现所有方法，可根据自身业务来实现对应的事件方法。
Note
- 所有的回调方法都是SDK内部的线程,不可以做UI操作，有UI相关操作需要抛主线程操作。
Note
- 不建议在回调方法中做耗时操作,如调用RtcEngine本身的Destroy方法，这将有可能引起不必要的阻塞从而影响SDK的运行。

setLocalViewConfig

setLocalViewConfig(renderConfig: DingRtcConstants.RtcEngineVideoCanvas, track: DingRtcConstants.RtcEngineVideoTrack): number

Parameters
- ```
renderConfig: DingRtcConstants.RtcEngineVideoCanvas
```
  本地视频显示属性。
- ```
track: DingRtcConstants.RtcEngineVideoTrack
```
  。
Returns
```
number
```
Ingroup
- OHOS_DingRtcEngineVideo
Since
- 3.0
Brief
- 设置本地预览显示视图。
Return
- - 0：成功；
  - 非0：失败。
Note
- 。

setRemoteDefaultVideoStreamType

setRemoteDefaultVideoStreamType(streamType: DingRtcConstants.RtcEngineVideoStreamType): number

Parameters
- ```
streamType: DingRtcConstants.RtcEngineVideoStreamType
```
  视频流的分辨率规格。
Returns
```
number
```
Ingroup
- OHOS_DingRtcEngineSub
Since
- 3.0
Brief
- 设置默认订阅的视频流分辨率规格；如果不设置，则默认订阅最大的分辨率规格。
Return
- - 0：成功；
  - 非0：失败。

setRemoteVideoStreamType

setRemoteVideoStreamType(uid: string, streamType: DingRtcConstants.RtcEngineVideoStreamType): number

Parameters
- ```
uid: string
```
  用户ID，从App server分配的唯一标示符。
- ```
streamType: DingRtcConstants.RtcEngineVideoStreamType
```
  视频流的分辨率规格。
Returns
```
number
```
Ingroup
- OHOS_DingRtcEngineSub
Since
- 3.0
Brief
- 设置订阅视频流分辨率规格。
Return
- - 0：成功；
  - 非0：失败。

setRemoteViewConfig

setRemoteViewConfig(renderConfig: DingRtcConstants.RtcEngineVideoCanvas, uid: string, track: DingRtcConstants.RtcEngineVideoTrack): number

Parameters
- ```
renderConfig: DingRtcConstants.RtcEngineVideoCanvas
```
  远端视频显示属性。
- ```
uid: string
```
  user id。
- ```
track: DingRtcConstants.RtcEngineVideoTrack
```
  。
Returns
```
number
```
Ingroup
- OHOS_DingRtcEngineVideo
Since
- 3.0
Brief
- 设置远端视频显示视图。
Return
- - 0：成功；
  - 非0：失败。
Note
- 。

setScreenShareEncoderConfiguration

setScreenShareEncoderConfiguration(config: DingRtcConstants.RtcEngineScreenShareEncoderConfiguration): number

Parameters
- ```
config: DingRtcConstants.RtcEngineScreenShareEncoderConfiguration
```
  。
Returns
```
number
```
Ingroup
- OHOS_DingRtcEngineScreenShare
Since
- 3.0
Brief
- 设置屏幕流视频编码属性。
Details
- 该方法用于设置屏幕流视频编码属性对应的视频参数，如分辨率、帧率、码率、视频方向等所有设置的参数都有相应的范围限制，如果设置的参数不在有效范围内，SDK会自动调节。
Return
- - 0：成功；
  - <0：失败。

setVideoEncoderConfiguration

setVideoEncoderConfiguration(config: DingRtcConstants.RtcEngineVideoEncoderConfiguration): number

Parameters
- ```
config: DingRtcConstants.RtcEngineVideoEncoderConfiguration
```
  。
Returns
```
number
```
Ingroup
- OHOS_DingRtcEngineVideo
Since
- 3.0
Brief
- 设置相机流视频编码属性。
Details
- 该方法用于设置相机流视频编码属性对应的视频参数，如分辨率、帧率、码率、视频方向等所有设置的参数都有相应的范围限制，如果设置的参数不在有效范围内，SDK会自动调节。
Note
- - 该方法在入会前和入会后都可以调用，如果每次入会只需要设置一次相机流视频编码属性，建议在入会前调用。

snapshotVideo

snapshotVideo(uid: string, track: DingRtcConstants.RtcEngineVideoTrack, filePath: string): number

Parameters
- ```
uid: string
```
  用户ID，为 "" 代表本地用户。
- ```
track: DingRtcConstants.RtcEngineVideoTrack
```
  。
- ```
filePath: string
```
  截图的本地保存路径，需精确到文件名及格式，请确保目录存在且可写。如 xx/yy/zz.jpg 。
Returns
```
number
```
Ingroup
- OHOS_DingRtcEngineVideo
Brief
- 对指定用户的视频进行截图，生成一张 JPG 格式的图片，并保存至指定的路径。
Return
- ；
  - < 0：失败。
Note
- 回调获取当前截图画面。

startPreview

```
startPreview(): number
```
Returns
```
number
```
Ingroup
- OHOS_DingRtcEnginePreview
Since
- 3.0
Brief
- 开启本地视频预览。
Return
- - 0：成功；
  - 非0：失败。
Note
- 之前就开启预览会自动打开摄像头。调用LeaveChannel不会关闭本地预览，会一直保留，直到调用StopPreview结束。

startScreenShare

startScreenShare(mode: DingRtcConstants.RtcScreenShareMode): number

Parameters
- ```
mode: DingRtcConstants.RtcScreenShareMode
```
  共享模式(是否共享系统声音)。
Returns
```
number
```
Ingroup
- OHOS_DingRtcEngineScreenShare
Since
- 3.0
Brief
- 开始屏幕分享。
Return
- - 0：成功；
  - <0：失败。

stopPreview

```
stopPreview(): number
```
Returns
```
number
```
Ingroup
- OHOS_DingRtcEnginePreview
Since
- 3.0
Brief
- 关闭本地视频预览。
Return
- - 0：成功；
  - 非0：失败。
Note
- 会自动停止本地预览；如果没有在推相机流，则会自动关闭摄像头。

stopScreenShare

```
stopScreenShare(): number
```
Returns
```
number
```
Ingroup
- OHOS_DingRtcEngineScreenShare
Since
- 3.0
Brief
- 停止屏幕分享。
Return
- - 0：成功；
  - <0：失败。

subscribeAllRemoteAudioStreams

subscribeAllRemoteAudioStreams(sub: boolean): number

Parameters
- ```
sub: boolean
```
  - 是否订阅所有远端音频流。
  - true：订阅所有用户的音频流，后入会成员会自动订阅其音频。
  - false：停止订阅所有用户的音频流，后入会成员也不会自动订阅其音频。
Returns
```
number
```
Ingroup
- OHOS_DingRtcEngineSub
Since
- 3.0
Brief
- 停止/恢复订阅所有远端音频流，包含后入会成员的订阅。从3.4开始，“所有人”是指大厅中所有人，解释见note。
Return
- - 0：设置成功；
  - 非0：设置失败。
Note
- - 入会前入会后均可以调用。
Note
- (groupid="")来达到同样的结果。

subscribeAllRemoteVideoStreams

subscribeAllRemoteVideoStreams(sub: boolean): number

Parameters
- ```
sub: boolean
```
  - 是否订阅所有远端视频流。
  - true：订阅所有用户的视频流，后入会成员会自动订阅其视频。
  - false：停止订阅所有用户的视频流，后入会成员也不会自动订阅其视频。
Returns
```
number
```
Ingroup
- OHOS_DingRtcEngineSub
Since
- 3.0
Brief
- 停止/恢复订阅所有远端视频流，包含后入会成员的订阅。
Return
- - 0：设置成功；
  - 非0：设置失败。
Note
- 来主动订阅某个人的远端视频流。

subscribeRemoteVideoStream

subscribeRemoteVideoStream(uid: string, track: DingRtcConstants.RtcEngineVideoTrack, sub: boolean): number

Parameters
- ```
uid: string
```
  用户ID，从App server分配的唯一标示符。
- ```
track: DingRtcConstants.RtcEngineVideoTrack
```
  。
- ```
sub: boolean
```
  - 是否订阅远端用户的视频流。
  - true：订阅指定用户的视频流。
  - false：停止订阅指定用户的视频流。
Returns
```
number
```
Ingroup
- OHOS_DingRtcEngineSub
Since
- 3.0
Brief
- 停止/恢复订阅远端用户的视频流。
Return
- - 0：设置成功；
  - 非0：设置失败。
Note
- 来主动订阅某个人的远端视频流。

switchCamera

```
switchCamera(): number
```
Returns
```
number
```
Brief
- 切换前后摄。
Return
- - 0：成功；
  - 非0：失败。

updateViewConfig

updateViewConfig(renderConfig: DingRtcConstants.RtcEngineVideoCanvas, uid: string, track: DingRtcConstants.RtcEngineVideoTrack): number

Parameters
- ```
renderConfig: DingRtcConstants.RtcEngineVideoCanvas
```
  config包含了窗口以及渲染方式。
- ```
uid: string
```
  user id，为 "" 代表本地用户。
- ```
track: DingRtcConstants.RtcEngineVideoTrack
```
  。
Returns
```
number
```
Ingroup
- OHOS_DingRtcEngineVideo
Since
- 3.0
Brief
- 更新渲染配置。
Return
- - 0：成功；
  - 非0：失败。

接口说明

目录

setLogLevel

Parameters

Ingroup

Since

Brief

Return

Note

Note

Note

Note

Note

setLogDir

Parameters

Returns

Ingroup

Since

Brief

Return

Note

Note

Note

create

Parameters

Returns

Ingroup

Since

Brief

Details

enableAudioLevelObserver

Parameters

Returns

Ingroup

Since

Brief

Return

Note

enableAudioVolumeIndication

Parameters

Returns

Ingroup

Since

Brief

Return

enableLocalVideo

Parameters

Returns

Ingroup

Since

Brief

Return

Note

enableSpeakerphone

Parameters

Returns

Brief

Return

getOnlineRemoteUsers

Returns

Ingroup

Since

Brief

getUserInfo

Parameters

Returns

Ingroup

Since

Brief

Details

Return

isInCall

Returns

Ingroup

Since

Brief

Return

Note

isLocalAudioStreamPublished

Returns