DingRtcEngine接口

接口说明

目录

基础接口

频道相关接口

发布相关接口

订阅相关接口

视频相关接口

共享视频相关接口

音频伴奏混音相关接口

预览相关接口

远端用户查询接口

白板管理器接口

白板接口

其他接口

接口详情

• create： 获取DingRtcEngine实例。

   public DingRtcEngine create (Context context, String extras)

  该方法为同步调用，提供一个SDK对象实例。

  参数说明

  参数	类型	描述

  参数	类型	描述
  context	Context	Android上下文。
  extras	String	用于接收来自客户灰度下发的参数，通过JSON配置SDK的特别功能，可以是空字符串。详情请参见官网

  重要

  调用destroy 方法进行资源释放。

• destroy： 销毁DingRtcEngine实例。

   public abstract void destroy ()

  调用该方法将会释放所有内部使用的资源, 当完成音视频通信之后都建议调用该方法释放实例.调用该方法后，你将不能再使用 DingRtcEngine 的其他方法和任何回调，如需要再次使用需要重新调用 getInstance 方法创建一个新的实例。

  重要

  该方法为同步调用, 需要等待内部资源释放之后才能执行其他方法, 为避免主线程阻塞，建议开发者放在子线程调用该方法，但需要注意的是如需在销毁后再次创建 DingRtcEngine 实例，请开发者务必保证 destroy 方法执行结束后再创建实例。

  为避免死锁，不建议在任何SDK的回调中调用本方法。

• setRtcEngineEventListener： 设置Engine回调。

   public abstract void setRtcEngineEventListener (DingRtcEngineEventListener listener)

  DingRtcEngineEventListener类是SDK向应用回调事件的通知,应用开发者需要实现该接口类的方法来获取相关事件通知。默认所有接口都有空实现，开发者不需要实现所有方法，可根据自身业务来实现对应的事件方法。

  参数说明

  参数	类型	描述

  参数	类型	描述
  listener	DingRtcEngineEventListener	用于接收来自engine的消息。

  重要

  所有的回调方法都是SDK内部的线程，不可以做UI操作，有UI相关操作需要抛主线程操作。

  不建议在回调方法中做耗时操作，如调用engine本身的destroy方法，这将有可能引起不必要的阻塞从而影响SDK的运行。

• joinChannel： 加入频道。

   public abstract int joinChannel (DingRtcAuthInfo authInfo, String userName)

  该方法让用户加入频道，一个频道内可以加入多个用户进行互相通话。

  参数说明

  参数	类型	描述

  参数	类型	描述
  authInfo	DingRtcAuthInfo	认证信息，从AppServer获取。
  userName	String	任意用于显示的用户名称，不是UserID。

  返回说明

  0：成功；<0：失败。

  重要

  异步接口。是否成功入会，通过 onJoinChannelResult 判断。

  正常情况一个Appid对应一个App，只有同一个AppId的应用可进行互相童话,不同AppId和channelID不同都不能互通。

  当入会成功后，会触发远端用户收到 onRemoteUserOnLineNotify 回调。

  如果已在会中想重新入会，需要先调用 leaveChannel 离会，且确保 onLeaveChannelResult 回调收到后，再次调用进行入会。

  用户加入频道后，默认订阅频道内所有其他用户的音视频流，默认推送音视频流到远端，因此将会产生计费，如果想要取消默认订阅可以joinChannel 前调用 subscribeAllRemoteAudioStreams 和 subscribeAllRemoteVideoStreams。

• leaveChannel： 离开频道。

   public abstract int leaveChannel ()

  返回说明

  • 0：成功；
  • <0：失败。
  重要

  失败原因错误码见回调函数：onLeaveChannelResult 。

  如果调用了 leaveChannel 后立刻调用 destroy 方法，SDK将会无法触发 onLeaveChannelResult。

• isInCall： 获取当前是否在频道中。

   public abstract boolean isInCall ()

  返回说明

  • true：当前已经加入了频道；
  • false：当前不在频道中。
  重要

  该方法可在加入频道前或加入频道后调用。

• publishLocalVideoStream： 是否推送本地视频流。

   public abstract int publishLocalVideoStream (boolean enabled)

  参数说明

  参数	类型	描述

  参数	类型	描述
  enabled	boolean	是否开启/关闭本地视频流推送。 true：开启视频流推送。 false：关闭视频流推送。

  返回说明

  • 0：设置成功；
  • <0：设置失败，返回错误码。
  重要

  SDK默认设置推送视频流，在加入频道前也可以调用此接口修改默认值，并在加入频道成功时生效。

• publishLocalAudioStream： 是否推送音频流。

   public abstract int publishLocalAudioStream (boolean enabled)

  参数说明

  参数	类型	描述

  参数	类型	描述
  enabled	boolean	是否开启/关闭本地音频流推送。 true：开启音频流推送。 false：关闭音频流推送。

  返回说明

  • 0：设置成功；
  • <0：设置失败，返回错误码。
  重要

  SDK默认设置推送音频流，在加入频道前也可以调用此接口修改默认值，并在加入频道成功时生效。

• isLocalVideoStreamPublished： 查询是否设置推送视频流。

   public abstract boolean isLocalVideoStreamPublished ()

  返回说明

  • true： 已设置推送；
  • false：未设置推送。
  重要

  SDK默认设置推送视频流，如果需要取消推送视频流，可以通过publishLocalVideoStream方法设置为不推送。

• isLocalAudioStreamPublished： 查询是否设置推送音频流。

   public abstract boolean isLocalAudioStreamPublished ()

  返回说明

  • true： 已设置推送；
  • false：未设置推送。
  重要

  SDK默认设置推送音频流，如果需要取消推送音频流，可以通过publishLocalAudioStream方法设置为不推送。

• setRemoteVideoStreamType： 设置订阅视频流分辨率规格。

   public abstract int setRemoteVideoStreamType (String uid, DingRtcVideoStreamType streamType)

  参数说明

  参数	类型	描述

  参数	类型	描述
  uid	String	用户ID，从Appserver分配的唯一标示符。
  streamType	DingRtcVideoStreamType	视频流的分辨率规格，详见DingRtcVideoStreamType。

  返回说明

  • 0：成功；
  • 非0：失败。

• setRemoteDefaultVideoStreamType： 设置默认订阅的视频流分辨率规格；如果不设置，则默认订阅最大的分辨率规格。

   public abstract int setRemoteDefaultVideoStreamType (DingRtcVideoStreamType streamType)

  参数说明

  参数	类型	描述

  参数	类型	描述
  streamType	DingRtcVideoStreamType	视频流的分辨率规格，详见DingRtcVideoStreamType。

  返回说明

  • 0：成功；
  • 非0：失败。

• subscribeAllRemoteAudioStreams： 停止/恢复订阅所有远端音频流，包含后入会成员的订阅。

   public abstract int subscribeAllRemoteAudioStreams (boolean sub)

  参数说明

  参数	类型	描述

  参数	类型	描述
  sub	boolean	true：订阅所有用户的音频流，后入会成员会自动订阅其音频。 false：停止订阅所有用户的音频流，后入会成员也不会自动订阅其音频。

  返回说明

  • 0：成功；
  • 非0：失败。
  重要

  入会前入会后均可以调用。

• subscribeAllRemoteVideoStreams： 停止/恢复订阅所有远端视频流，包含后入会成员的订阅。

   public abstract int subscribeAllRemoteVideoStreams (boolean sub)

  参数说明

  参数	类型	描述

  参数	类型	描述
  sub	boolean	true：接收所有用户的视频流，后入会成员会自动订阅其视频。 false：停止允许接收所有用户的视频流，后入会成员也不会自动订阅其视频。

  返回说明

  • 0：成功；
  • 入会前入会后均可以调用；
  • 如果设置了 subscribeAllRemoteVideoStreams(false)，会取消订阅已订阅的远端视频流，同时后面再入会的人不会进行自动订阅；但是依然可以通过 com 来主动订阅某个人的远端视频流；

• subscribeRemoteVideoStream： 停止/恢复订阅远端用户的视频流。

   public abstract int subscribeRemoteVideoStream (String uid, DingRtcVideoTrack track, boolean sub)

  参数说明

  参数	类型	描述

  参数	类型	描述
  uid	String	用户ID，从Appserver分配的唯一标示符。
  track	DingRtcVideoTrack	视频流类型。
  sub	boolean	true：接收指定用户的视频流。 false：停止接收指定用户的视频流。

  返回说明

  • 0：成功；
  • 非0：失败。
  重要

  入会前入会后均可以调用；如果设置了 subscribeAllRemoteVideoStreams(false)，会取消订阅已订阅的远端视频流，同时后面再入会的人不会进行自动订阅；但是依然可以通过 subscribeRemoteVideoStream 来主动订阅某个人的远端视频流；

• setCameraCapturerConfiguration： 采集偏好设置。

   public abstract int setCameraCapturerConfiguration (DingEngineCameraCapturerConfiguration cameraCapturerConfiguration)

  参数说明

  参数	类型	描述

  参数	类型	描述
  cameraCapturerConfiguration	DingEngineCameraCapturerConfiguration	偏好设置

  返回说明

  • 0：成功；
  • 非0：表示失败。
  重要

  必须在打开摄像头之前设置，如startPreview之前设置。

• createRenderSurfaceView： 创建视频显示的SurfaceView。

   public abstract SurfaceView createRenderSurfaceView (Context context)

  显示视频视图必须调用该方法，而不是直接调用SurfaceView。如果需要创建TextureView，则调用createRenderTextureView。 将返回值赋值view，调用setLocalViewConfig设置本地预览显示视图或者调用setRemoteViewConfig。 设置远程预览显示视图。

  参数说明

  参数	类型	描述

  参数	类型	描述
  context	Context	活动上下文。

  返回说明

  SurfaceView类型的实例。

  重要

  请在主线程调用该方法。

• createRenderTextureView： 创建视频显示的TextureView。

   public abstract TextureView createRenderTextureView (Context context)

  显示视频视图必须调用该方法，而不是直接调用TextureView。如果需要创建SurfaceView，则调用createRenderSurfaceView。 将返回值赋值view，调用setLocalViewConfig设置本地预览显示视图或者调用setRemoteViewConfig 设置远程预览显示视图。

  参数说明

  参数	类型	描述

  参数	类型	描述
  context	Context	活动上下文。

  返回说明

  TextureView类型的实例。

  重要

  请在主线程调用该方法。

• setLocalViewConfig： 设置本地预览显示视图。

   public abstract int setLocalViewConfig (DingRtcVideoCanvas viewConfig, DingRtcVideoTrack track)

  参数说明

  参数	类型	描述

  参数	类型	描述
  viewConfig	DingRtcVideoCanvas	本地视频显示属性。
  track	DingRtcVideoTrack	只支持DingRtcVideoTrackCamera和DingRtcVideoTrackScreen。

  返回说明

  • 0：成功；
  • < 0：失败。
  重要

  支持joinChannel之前和之后切换窗口。如果canvas或者view为null，则停止显示。 如果需要重新设置renderMode，请保持canvas中其他属性不变，仅修改 renderMode。 如果需要重新设置mirrorMode，请保持canvas中其他属性不变，仅修改 mirrorMode。

• enableLocalVideo： 禁用或启用本地视频采集。

   public abstract int enableLocalVideo (boolean enabled)

  参数说明

  参数	类型	描述

  参数	类型	描述
  enabled	boolean	true：启用本地视频采集。 false：禁用本地视频采集。

  返回说明

  • 0：成功；
  • < 0：失败。
  重要

  默认为开启状态。

• muteLocalCamera： 暂停/恢复本地视频流的发送。

   public abstract int muteLocalCamera (boolean mute, DingRtcVideoTrack track)

  参数说明

  参数	类型	描述

  参数	类型	描述
  mute	boolean	true：表示暂停视频流的发送。 false：表示恢复视频流的发送。
  track	DingRtcVideoTrack	只支持DingRtcVideoTrackCamera和DingRtcVideoTrackScreen。

  返回说明

  • 0：成功；
  • 非0：失败。
  重要

  视频流暂停发送时，采集和编码模块仍然在工作。

• snapshotVideo： 视频截图功能。

   public abstract int snapshotVideo (String uid, DingRtcVideoTrack track, String path)

  参数说明

  参数	类型	描述

  参数	类型	描述
  uid	String	用户ID，uid为""代表本地用户。
  track	DingRtcVideoTrack	视频流类型，只支持DingRtcVideoTrackCamera和DingRtcVideoTrackScreen。
  path	String	截图保存路径。

  返回说明

  • 0 ：仅代表调用该接口成功，是否获取到截图画面，详细见com 。
  • < 0 ：失败。
  重要

  视频截图功能为异步接口，通过监听onSnapshotComplete回调获取当前截图画面。

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

   public abstract void setVideoEncoderConfiguration (DingRtcVideoEncoderConfiguration config)

  该方法用于设置相机流视频编码属性对应的视频参数，如分辨率、帧率、码率、视频方向等所有设置的参数都有相应的范围限制，如果设置的参数不在有效范围内，SDK会自动调节。

  参数说明

  参数	类型	描述

  参数	类型	描述
  config	DingRtcVideoEncoderConfiguration	预定义的编码属性。

  重要

  该方法在入会前和入会后都可以调用，如果每次入会只需要设置一次相机流视频编码属性，建议在入会前调用。

• setRemoteViewConfig： 设置远端视频显示视图。

   public abstract int setRemoteViewConfig (DingRtcVideoCanvas canvas, String uid, DingRtcVideoTrack track)

  参数说明

  参数	类型	描述

  参数	类型	描述
  canvas	DingRtcVideoCanvas	视频显示属性。
  uid	String	用户ID,从Appserver分配的唯一标示符。
  track	DingRtcVideoTrack	只支持DingRtcVideoTrackCamera和DingRtcVideoTrackScreen。

  返回说明

  • 0：成功；
  • < 0：失败。
  重要

  支持joinChannel之前和之后切换窗口。如果canvas或者view为null，则停止显示。 如果需要重新设置renderMode，请保持canvas中其他属性不变，仅修改 renderMode。 如果需要重新设置mirrorMode，请保持canvas中其他属性不变，仅修改 mirrorMode。

• updateViewConfig： 更新本地或远端视图属性。

   public abstract int updateViewConfig (DingRtcVideoCanvas canvas, String uid, DingRtcVideoTrack track)

  参数说明

  参数	类型	描述

  参数	类型	描述
  canvas	DingRtcVideoCanvas	视频显示属性。
  uid	String	用户ID,从Appserver分配的唯一标示符。本地用户设置为""。
  track	DingRtcVideoTrack	只支持DingRtcVideoTrackCamera和DingRtcVideoTrackScreen。

  返回说明

  • 0：成功；
  • < 0：失败。
  重要

  支持joinChannel之前和之后设置。设置view为需要更新的view， 目前支持更新mirrorMode， renderMode， rotationMode

• getCameraList： 获取当前所有的视频设备。

   public abstract List< DingRtcVideoDeviceInfo > getCameraList ()

  返回说明

  视频设备信息

• getCurrentCameraName： 获取当前使用的摄像头名称。

   public abstract String getCurrentCameraName ()

  返回说明

  摄像头名称。

• getCurrentCameraID： 获取当前使用的摄像头ID。

   public abstract String getCurrentCameraID ()

  返回说明

  摄像头ID。

• setCurrentCameraName： 选择摄像头名称。

   public abstract int setCurrentCameraName (String cameraName)

  参数说明

  参数	类型	描述

  参数	类型	描述
  cameraName	String	摄像头名称。

  返回说明

  • 0：成功；
  • 非0：失败。

• setCurrentCameraID： 选择摄像头ID。

   public abstract int setCurrentCameraID (String cameraID)

  参数说明

  参数	类型	描述

  参数	类型	描述
  cameraID	String	摄像头ID。

  返回说明

  • 0：成功；
  • 非0：失败。

• isCameraOn： 检查camera是否打开。

   public abstract boolean isCameraOn ()

  返回说明

  • true：摄像头已打开；
  • false：摄像头没有打开。
  重要

  该接口用于检查当前camera的状态。

• getCurrentCameraDirection： 获取当前摄像头方向。

   public abstract DingRtcCameraDirection getCurrentCameraDirection ()

  返回说明

  摄像头方向

• switchCamera： 切换前后摄像头。

   public abstract int switchCamera ()

  返回说明

  • 0：成功；
  • 非0：失败。
  重要

  只有iOS和android提供这个接口。

• setCameraZoom： 设置摄像头缩放。

   public abstract int setCameraZoom (float zoom)

  参数说明

  参数	类型	描述

  参数	类型	描述
  zoom	float	缩放级别，范围从1到camera支持的最大zoom值。

  返回说明

  • 0：成功；
  • 非0：失败。

• setCameraFlash： 设置摄像头闪光灯开关。

   public abstract int setCameraFlash (boolean flash)

  参数说明

  参数	类型	描述

  参数	类型	描述
  flash	boolean	是否打开闪光灯。

  返回说明

  • 0：成功；
  • 非0：失败。

• isCameraFocusPointSupported： 摄像头是否支持手动聚焦。

   public abstract boolean isCameraFocusPointSupported ()

  返回说明

  • true：支持；
  • false：不支持。

• setCameraFocusPoint： 设置摄像头手动聚焦点。

   public abstract int setCameraFocusPoint (float x, float y)

  参数说明

  参数	类型	描述

  参数	类型	描述
  x	float	聚焦点坐标，（相对坐标，取值范围0~1）。
  y	float	聚焦点坐标，（相对坐标，取值范围0~1）。

  返回说明

  • 0：成功；
  • 非0：失败。

• setCameraExposurePoint： 设置摄像头曝光点。

   public abstract int setCameraExposurePoint (float x, float y)

  参数说明

  参数	类型	描述

  参数	类型	描述
  point		曝光点，（相对坐标，取值范围0~1）。

  返回说明

  • 0：成功；
  • 非0：失败。

• isCameraAutoFocusFaceModeSupported： 摄像头是否支持人脸聚焦

   public abstract boolean isCameraAutoFocusFaceModeSupported ()

  返回说明

  • true：支持；
  • false：不支持。
  重要

  摄像头采集过程中调用有效

• setCameraAutoFocusFaceModeEnabled： 设置摄像头人脸聚焦

   public abstract int setCameraAutoFocusFaceModeEnabled (boolean enable)

  参数说明

  参数	类型	描述

  参数	类型	描述
  enable	boolean	true：开启人脸聚焦；false：关闭人脸聚焦；默认值false。

  返回说明

  • 0：成功；
  • 非0：失败。
  重要

  摄像头采集过程中调用有效

• setCameraExposureCompensation： 设置摄像头曝光补偿

   public abstract int setCameraExposureCompensation (float value)

  参数说明

  参数	类型	描述

  参数	类型	描述
  value	float	曝光补偿值

  返回说明

  • 0：成功；
  • 非0：失败。

• getCameraMinExposureCompensation： 获取摄像头最小曝光补偿

   public abstract float getCameraMinExposureCompensation ()

  返回说明

  最小曝光补偿值。

• getCameraMaxExposureCompensation： 获取摄像头最大曝光补偿

   public abstract float getCameraMaxExposureCompensation ()

  返回说明

  最大曝光补偿值。

• enableVirtualBackground： 开启或关闭虚拟背景功能，并设置参数

   public abstract int enableVirtualBackground (boolean enable, DingRtcVirtualBackgroundOptions options)

  参数说明

  参数	类型	描述

  参数	类型	描述
  enable	boolean	true：开启虚拟背景功能。 false：关闭虚拟背景功能。
  options	DingRtcVirtualBackgroundOptions	虚拟背景参数，详细定义见DingRtcVirtualBackgroundOptions。

  返回说明

  • 0：成功
  • < 0：失败

• setScreenShareEncoderConfiguration： 设置屏幕流视频编码属性。

   public abstract void setScreenShareEncoderConfiguration (DingRtcScreenShareEncoderConfiguration config)

  该方法用于设置屏幕流视频编码属性对应的视频参数，如分辨率、帧率、码率、视频方向等所有设置的参数都有相应的范围限制，如果设置的参数不在有效范围内，SDK会自动调节。

  参数说明

  参数	类型	描述

  参数	类型	描述
  config	DingRtcScreenShareEncoderConfiguration	预定义的屏幕共享编码属性。

  重要

  该方法在入会前和入会后都可以调用，如果每次入会只需要设置一次屏幕流视频编码属性，建议在入会前调用。

• isScreenSharePublished： 查询是否设置推送屏幕分享。

   public abstract boolean isScreenSharePublished ()

  返回说明

  • true： 已设置推送；
  • false：未设置推送。
  重要

  SDK默认设置不推送屏幕分享，如果需要推送屏幕共享，可以通过startScreenShare方法开启屏幕共享推送。

• startScreenShare： 启动屏幕分享，包括音频和视频。

   public abstract int startScreenShare ()

  返回说明

  • 0：成功；
  • 非0：失败。

• startScreenShare： 启动屏幕分享。

   public abstract int startScreenShare (DingRtcScreenShareMode screenShareMode)

  参数说明

  参数	类型	描述

  参数	类型	描述
  screenShareMode	DingRtcScreenShareMode	屏幕共享模式，只共享音频/视频/音视频。

  返回说明

  • 0：成功；
  • 非0：失败。

• startScreenShare： 启动屏幕分享。用于请求用户授予共享权限操作在SDK外部执行的场合。如果需要由SDK内部控制用户权限申请，请调用不带有Intent参数的API。

   public abstract int startScreenShare (Intent intent, DingRtcScreenShareMode screenShareMode)

  参数说明

  参数	类型	描述

  参数	类型	描述
  intent	Intent	通过MediaProjectionManager.createScreenCaptureIntent()获取的Intent
  screenShareMode	DingRtcScreenShareMode	屏幕共享模式，只共享音频/视频/音视频。

  返回说明

  • 0：成功；
  • 非0：失败。
  重要

  此接口即将废弃，建议使用新接口 startScreenShare(DingRtcScreenShareMode)。

• stopScreenShare： 停止屏幕共享。

   public abstract int stopScreenShare ()

  返回说明

  • 0：成功；
  • 非0：失败。

• createAudioMixing： 创建伴奏混音实例。

   public int createAudioMixing (int id, String filePath)

  参数说明

  参数	类型	描述

  参数	类型	描述
  id	int	伴奏文件id，用户分配。
  filePath	String	伴奏文件路径。

  返回说明

  • 0：成功；
  • 非0：失败。

• destroyAudioMixing： 销毁伴奏混音实例。

   public int destroyAudioMixing (int id)

  参数说明

  参数	类型	描述

  参数	类型	描述
  id	int	伴奏文件id。

  返回说明

  • 0：成功；
  • 非0：失败。

• startAudioMixing： 开始伴奏混音。

   public int startAudioMixing (int id, DingRtcEngine.DingRtcAudioMixingConfig config)

  参数说明

  参数	类型	描述

  参数	类型	描述
  id	int	伴奏文件id。
  config	DingRtcEngine.DingRtcAudioMixingConfig	伴奏文件配置，参考DingRtcAudioMixingConfig。

  返回说明

  • 0：成功；
  • 非0：失败。
  重要

  可通过OnAudioMixingStateChanged监听播放状态。

• stopAudioMixing： 停止伴奏混音。

   public int stopAudioMixing (int id)

  参数说明

  参数	类型	描述

  参数	类型	描述
  id	int	伴奏文件id。

  返回说明

  • 0：成功；
  • 非0：失败。

• pauseAudioMixing： 暂停伴奏混音。

   public int pauseAudioMixing (int id)

  参数说明

  参数	类型	描述

  参数	类型	描述
  id	int	伴奏文件id。

  返回说明

  • 0：成功；
  • 非0：失败。

• resumeAudioMixing： 暂停后恢复伴奏混音。

   public int resumeAudioMixing (int id)

  参数说明

  参数	类型	描述

  参数	类型	描述
  id	int	伴奏文件id。

  返回说明

  • 0：成功；
  • 非0：失败。

• getAudioMixingDuration： 获取伴奏时长。

   public long getAudioMixingDuration (int id)

  参数说明

  参数	类型	描述

  参数	类型	描述
  id	int	伴奏文件id。

  返回说明

  伴奏时长，单位ms。返回值为1时，说明获取时长失败。

• getAudioMixingCurrentPosition： 获取当前伴奏播放时长。

   public long getAudioMixingCurrentPosition (int id)

  参数说明

  参数	类型	描述

  参数	类型	描述
  id	int	伴奏文件id。

  返回说明

  当前伴奏播放时长，单位ms。返回值为1时，说明获取时长失败。

• setAudioMixingPosition： 设置伴奏播放位置。

   public int setAudioMixingPosition (int id, long position)

  参数说明

  参数	类型	描述

  参数	类型	描述
  id	int	伴奏文件id。
  position	long	设置伴奏播放位置，单位ms。

  返回说明

  • 0：成功；
  • 非0：失败。

• setAudioMixingVolume： 设置伴奏音量。

   public int setAudioMixingVolume (int id, int volume)

  参数说明

  参数	类型	描述

  参数	类型	描述
  id	int	伴奏文件id。
  volume	int	伴奏音量，取值[0,100]。

  返回说明

  • 0：成功；
  • 非0：失败。

• getAudioMixingVolume： 获取伴奏音量。

   public int getAudioMixingVolume (int id)

  参数说明

  参数	类型	描述

  参数	类型	描述
  id	int	伴奏文件id。

  返回说明

  伴奏音量， < 0 代表获取失败。

• setAudioMixingPublishVolume： 设置伴奏推流音量。

   public int setAudioMixingPublishVolume (int id, int volume)

  参数说明

  参数	类型	描述

  参数	类型	描述
  id	int	伴奏文件id。
  volume	int	伴奏推流音量，取值[0,100]。

  返回说明

  • 0：成功；
  • 非0：失败。

• getAudioMixingPublishVolume： 获取伴奏推流音量。

   public int getAudioMixingPublishVolume (int id)

  参数说明

  参数	类型	描述

  参数	类型	描述
  id	int	伴奏文件id。

  返回说明

  伴奏推流音量， < 0 代表获取失败。

• setAudioMixingPlayoutVolume： 设置伴奏播放音量。

   public int setAudioMixingPlayoutVolume (int id, int volume)

  参数说明

  参数	类型	描述

  参数	类型	描述
  id	int	伴奏文件id。
  volume	int	伴奏播放音量，取值[0,100]。

  返回说明

  • 0：成功；
  • 非0：失败。

• getAudioMixingPlayoutVolume： 获取伴奏播放音量。

   public int getAudioMixingPlayoutVolume (int id)

  参数说明

  参数	类型	描述

  参数	类型	描述
  id	int	伴奏文件id。

  返回说明

  伴奏播放音量， < 0 代表获取失败。

• startPreview： 开启本地视频预览。

   public abstract int startPreview ()

  返回说明

  0：成功；< 0：失败。

  重要

  如果没有调用setLocalViewConfig设置显示的view，则无法预览，但不影响推流。

  可以在joinChannel之前就开启预览会自动打开摄像头。

• stopPreview： 关闭本地视频预览。

   public abstract int stopPreview ()

  返回说明

  0：成功； < 0：失败。

  重要

  leaveChannel会自动停止本地预览；如果没有在推相机流，则会自动关闭摄像头。

• getOnlineRemoteUsers： 获取远端在线用户列表。

   public abstract String[] getOnlineRemoteUsers ()

  返回说明

  当前频道内所有在线用户userid列表。

  重要

  若当前频道ChannelProfile设置为 DingRtcSdkInteractiveLive 模式，只有设置角色为 DingRtcSdkInteractive 的用户为在线用户，本方法不返回角色为 DingRtcSdkLive 的用户。

• getUserInfo： 查询远端用户状态。

   public abstract DingRtcRemoteUserInfo getUserInfo (String uid)

  通过 uid 查询指定远端用户的状态信息。

  参数说明

  参数	类型	描述

  参数	类型	描述
  uid	String	用户ID。从Appserver分配的唯一标示符。

  返回说明

  返回一个远端用户对象。详见com

• isUserOnline： 查询用户是否在线。

   public abstract boolean isUserOnline (String uid)

  参数说明

  参数	类型	描述

  参数	类型	描述
  uid	String	用户ID，从Appserver分配的唯一标示符。不可为NULL。

  返回说明

  • true：用户在线；
  • false：用户不在线。
  重要

  根据特定的UserID，查询该用户是否在线。

• setWhiteboardManagerEventListener： 设置白板管理器监听器。

   public int setWhiteboardManagerEventListener (DingRtcEngineWhiteboardManagerListener listener)

  参数说明

  参数	类型	描述

  参数	类型	描述
  listener	DingRtcEngineWhiteboardManagerListener	用于接收来自白板管理器的事件

  返回说明

  int

• createWhiteboard： 创建白板对象。

   public DingRtcEngineWhiteboard createWhiteboard (String whiteboardId, DingRtcWBConfig config)

  参数说明

  参数	类型	描述

  参数	类型	描述
  config		白板配置

  返回说明

  白板类接口

• getWhiteboard： 获取白板对象。

   public DingRtcEngineWhiteboard getWhiteboard (String whiteboardId)

  参数说明

  参数	类型	描述

  参数	类型	描述
  whiteboardId	String	白板ID

  返回说明

  白板类接口

• open： 打开白板。

   public int open (DingRtcWhiteboardView view)

  返回说明

  0：成功；<0：失败。

• close： 关闭白板。

   public int close ()

  返回说明

  0：成功；<0：失败。

• join： 加入白板。

   public int join ()

  返回说明

  0：成功；<0：失败。

• leave： 离开白板。

   public int leave ()

  返回说明

  0：成功；<0：失败。

• stop： 结束白板。

   public int stop ()

  返回说明

  0：成功；<0：失败。

• setRole： 设置白板角色。

   public int setRole (DingRtcWBRoleType role)

  参数说明

  参数	类型	描述

  参数	类型	描述
  role	DingRtcWBRoleType	白板角色

  返回说明

  0：成功；<0：失败。

• setToolType： 设置工具类型。

   public int setToolType (DingRtcWBToolType toolType)

  参数说明

  参数	类型	描述

  参数	类型	描述
  toolType	DingRtcWBToolType	工具类型。

  返回说明

  0：成功；<0：失败。

• setLineWidth： 设置线宽。

   public int setLineWidth (int size)

  参数说明

  参数	类型	描述

  参数	类型	描述
  size	int	线宽。有效值为1-20。

  返回说明

  0：成功；<0：失败。

• setColor： 设置颜色。

   public int setColor (DingRtcWBColor color)

  参数说明

  参数	类型	描述

  参数	类型	描述
  color	DingRtcWBColor	颜色。

  返回说明

  0：成功；<0：失败。

• setFillColor： 设置填充颜色。

   public int setFillColor (DingRtcWBColor color)

  参数说明

  参数	类型	描述

  参数	类型	描述
  color	DingRtcWBColor	填充颜色。

  返回说明

  0：成功；<0：失败。

• setFillType： 设置填充类型。

   public int setFillType (DingRtcWBFillType type)

  参数说明

  参数	类型	描述

  参数	类型	描述
  type	DingRtcWBFillType	填充类型。

  返回说明

  0：成功；<0：失败。

• setFontStyle： 设置字体样式。

   public int setFontStyle (DingRtcWBFontStyle style)

  参数说明

  参数	类型	描述

  参数	类型	描述
  style	DingRtcWBFontStyle	字体样式。

  返回说明

  0：成功；<0：失败。

• setFontSize： 设置字体大小。

   public int setFontSize (int size)

  参数说明

  参数	类型	描述

  参数	类型	描述
  size	int	字体大小。

  返回说明

  0：成功；<0：失败。

• undo： 撤消。

   public int undo ()

  返回说明

  0：成功；<0：失败。

• redo： 重做。

   public int redo ()

  返回说明

  0：成功；<0：失败。

• getToolType： 获取工具类型。

   public DingRtcWBToolType getToolType ()

  返回说明

  WBToolType 工具类型。

• getUndoStatus： 是否可以撤消。

   public boolean getUndoStatus ()

  返回说明

  bool

• getRedoStatus： 是否可以恢复重做。

   public boolean getRedoStatus ()

  返回说明

  bool

• addStamp： 添加图章资源。

   public int addStamp (DingRtcWBStamp stamp)

  参数说明

  参数	类型	描述

  参数	类型	描述
  stamp	DingRtcWBStamp	图章。

  返回说明

  int

• setStamp： 设置图章资源。

   public int setStamp (String stampId)

  参数说明

  参数	类型	描述

  参数	类型	描述
  stampId	String	图章资源ID。

  返回说明

  int

• setZoomScale： 设置缩放比例。

   public int setZoomScale (float scale)

  参数说明

  参数	类型	描述

  参数	类型	描述
  scale	float	缩放比例。

  返回说明

  0：成功；<0：失败。

• setZoomScaleWithTranslate： 设置缩放比例及基于原始中心点缩放后的平移。

   public int setZoomScaleWithTranslate (float scale, float tx, float ty)

  参数说明

  参数	类型	描述

  参数	类型	描述
  scale	float	缩放比例。
  tx	float	缩放后x轴平移。
  ty	float	缩放后y轴平移。

  返回说明

  0：成功；<0：失败。

• setMinZoomScale： 设置最小缩放比例。

   public int setMinZoomScale (float scale)

  参数说明

  参数	类型	描述

  参数	类型	描述
  scale	float	缩放比例。

  返回说明

  0：成功；<0：失败。

• setMaxZoomScale： 设置最大缩放比例。

   public int setMaxZoomScale (float scale)

  参数说明

  参数	类型	描述

  参数	类型	描述
  scale	float	缩放比例。

  返回说明

  0：成功；<0：失败。

• getZoomScale： 获取缩放比例。

   public float getZoomScale ()

  返回说明

  scale 缩放比例。

• getMinZoomScale： 获取最小缩放比例。

   public float getMinZoomScale ()

  返回说明

  scale 缩放比例。

• getMaxZoomScale： 获取最大缩放比例。

   public float getMaxZoomScale ()

  返回说明

  scale 缩放比例。

• setScalingMode： 设置缩放模式。

   public int setScalingMode (DingRtcWBScalingMode mode)

  参数说明

  参数	类型	描述

  参数	类型	描述
  mode	DingRtcWBScalingMode	缩放模式。

  返回说明

  0：成功；<0：失败。

• getCurrentPageNumber： 获取当前白板页码。

   public int getCurrentPageNumber ()

  返回说明

  WBPageNumber

• getTotalNumberOfPages： 获取白板页数。

   public int getTotalNumberOfPages ()

  返回说明

  0：成功；<0：失败。

• addPage： 添加一页到最后。

   public int addPage (boolean autoSwitch)

  参数说明

  参数	类型	描述

  参数	类型	描述
  autoSwitch	boolean	自动切换到新添加的页面。

  返回说明

  0：成功；<0：失败。

• insertPage： 插入一页到指定页之后。

   public int insertPage (int pageNo, boolean autoSwitch)

  参数说明

  参数	类型	描述

  参数	类型	描述
  pageNo	int	指定页的页码。
  autoSwitch	boolean	自动切换到新添加的页面。

  返回说明

  0：成功；<0：失败。

• removePage： 删除一页。

   public int removePage (int pageNo, boolean switchNext)

  参数说明

  参数	类型	描述

  参数	类型	描述
  pageNo	int	被删除页的页码。
  switchNext	boolean	切换到删除页的下一页。

  返回说明

  0：成功；<0：失败。

  重要

  删除页的默认行为是切换到删除页的前一页。设置switchNext为true改为切换到删除页的下一页。

• gotoPage： 跳转到指定页。

   public int gotoPage (int pageNo)

  参数说明

  参数	类型	描述

  参数	类型	描述
  pageNo	int	跳转页的页码。

  返回说明

  0：成功；<0：失败。

• nextPage： 下一页。

   public int nextPage ()

  返回说明

  0：成功；<0：失败。

• prevPage： 上一页。

   public int prevPage ()

  返回说明

  0：成功；<0：失败。

• getCurrentDocID： 获取当前白板文档ID。

   public String getCurrentDocID ()

  返回说明

  const char*

• getDocInfo： 获取白板信息。

   public DingRtcWhiteboardDocInfo getDocInfo (String docId)

  参数说明

  参数	类型	描述

  参数	类型	描述
  docId	String	白板文档ID。

  返回说明

  WBDocInfo*

• getDocList： 获取白板文档列表。

   public List< String > getDocList ()

  返回说明

  白板文档列表

• createDoc： 基于外部内容创建白板文档。

   public String createDoc (DingRtcWBDocExtContents contents, boolean autoSwitch)

  参数说明

  参数	类型	描述

  参数	类型	描述
  contents	DingRtcWBDocExtContents	外部文档信息。
  autoSwitch	boolean	自动切换到新创建的文档。

  返回说明

  const char* 白板文档ID。

• createDoc： 基于内容创建白板文档。

   public String createDoc (DingRtcWBDocContents contents, boolean autoSwitch)

  参数说明

  参数	类型	描述

  参数	类型	描述
  contents	DingRtcWBDocContents	文档信息。
  autoSwitch	boolean	自动切换到新创建的文档。

  返回说明

  const char* 白板文档ID。

• deleteDoc： 删除白板文档。

   public int deleteDoc (String docId)

  参数说明

  参数	类型	描述

  参数	类型	描述
  docId	String	白板文档ID。

  返回说明

  0：成功；<0：失败。

• switchDoc： 切换白板文档。

   public int switchDoc (String docId)

  参数说明

  参数	类型	描述

  参数	类型	描述
  docId	String	白板文档ID。

  返回说明

  0：成功；<0：失败。

• copyDocPage： 复制白板文档页内容。

   public int copyDocPage (String srcDocId, int srcPageNum, String dstDocId, int dstPageNum, boolean clearDstPage)

  参数说明

  参数	类型	描述

  参数	类型	描述
  srcDocId	String	源白板文档ID。
  srcPageNum	int	源白板文档页码。
  dstDocId	String	目标白板文档ID。
  dstPageNum	int	目标白板文档页码。
  clearDstPage	boolean	是否清空目标白板文档页。

  返回说明

  0：成功；<0：失败。

• saveDocToImages： 保存白板文档为多张图片。

   public int saveDocToImages (String docId, String outputDir)

  参数说明

  参数	类型	描述

  参数	类型	描述
  docId	String	白板文档ID。
  outputDir	String	输出目录

  返回说明

  0：成功；<0：失败。

• sendUserMessage： 发送自定义消息给指定用户。

   public int sendUserMessage (String userId, String msg, int size)

  参数说明

  参数	类型	描述

  参数	类型	描述
  userId	String	用户ID。
  msg	String	要发送的消息。
  size	int	消息大小，最大不超过16KB。

  返回说明

  0：成功；<0：失败。

• broadcastMessage： 广播消息给所有用户。

   public int broadcastMessage (String msg, int size)

  参数说明

  参数	类型	描述

  参数	类型	描述
  msg	String	要发送的消息。
  size	int	消息大小，最大不超过16KB。

  返回说明

  0：成功；<0：失败。

• setIntOption： 设置白板整数类型参数。

   public int setIntOption (DingRtcWBOption option, int param)

  参数说明

  参数	类型	描述

  参数	类型	描述
  option	DingRtcWBOption	参数类别。
  param	int	整数类型参数。

  返回说明

  0：成功；<0：失败。

• setBooleanOption： 设置白板布尔类型参数。

   public int setBooleanOption (DingRtcWBOption option, boolean param)

  参数说明

  参数	类型	描述

  参数	类型	描述
  option	DingRtcWBOption	参数类别。
  param	boolean	布尔类型参数。

  返回说明

  0：成功；<0：失败。

• setFloatOption： 设置白板浮点类型参数。

   public int setFloatOption (DingRtcWBOption option, float param)

  参数说明

  参数	类型	描述

  参数	类型	描述
  option	DingRtcWBOption	参数类别。
  param	float	浮点类型参数。

  返回说明

  0：成功；<0：失败。

• setStringOption： 设置白板字符串类型参数。

   public int setStringOption (DingRtcWBOption option, String param)

  参数说明

  参数	类型	描述

  参数	类型	描述
  option	DingRtcWBOption	参数类别。
  param	String	字符串类型参数。

  返回说明

  0：成功；<0：失败。

• clearContents： 清除白板内容。

   public int clearContents (DingRtcWBClearParam param)

  参数说明

  参数	类型	描述

  参数	类型	描述
  param	DingRtcWBClearParam	清除参数。

  返回说明

  0：成功；<0：失败。

• startShareVision： 开始视角共享。

   public int startShareVision ()

  返回说明

  0：成功；<0：失败。

• stopShareVision： 停止视角共享。

   public int stopShareVision ()

  返回说明

  0：成功；<0：失败。

• startFollowVision： 开始视角跟随。

   public int startFollowVision ()

  返回说明

  0：成功；<0：失败。

• stopFollowVision： 停止视角跟随。

   public int stopFollowVision ()

  返回说明

  0：成功；<0：失败。

• resetVision： 重置视角。

   public int resetVision ()

  返回说明

  0：成功；<0：失败。

• snapshot： 快照。

   public int snapshot (DingRtcWBSnapshotMode mode, String outputDir)

  参数说明

  参数	类型	描述

  参数	类型	描述
  mode	DingRtcWBSnapshotMode
  outputDir	String	输出目录。

  返回说明

  0：成功；<0：失败。

• setBackgroundColor： 设置背景色。

   public int setBackgroundColor (DingRtcWBColor color)

  参数说明

  参数	类型	描述

  参数	类型	描述
  color	DingRtcWBColor	背景色。

  返回说明

  0：成功；<0：失败。

• setBackgroundImage： 设置背景图片

   public int setBackgroundImage (String imageUrl, int pageNo)

  参数说明

  参数	类型	描述

  参数	类型	描述
  imageUrl	String	图片地址，可以为本地路径或网络路径
  pageNo	int	当前文档页码

  返回说明

  int

• addImageFile： 添加图片

   public int addImageFile (String imageUrl)

  参数说明

  参数	类型	描述

  参数	类型	描述
  filePath		图片地址，可以为本地路径或网络路径

  返回说明

  int

• saveDocToThumbnails： 保存白板文档为多张缩略图。

   public int saveDocToThumbnails (String docId, String outputDir)

  参数说明

  参数	类型	描述

  参数	类型	描述
  docId	String	白板文档ID。
  outputDir	String	输出目录。

  返回说明

  0：成功；<0：失败。

• destroy： 销毁白板。

   public void destroy ()

  返回说明

  void

• setLogLevel： 设置日志等级。

   public void setLogLevel (DingRtcLogLevel logLevel)

  参数说明

  参数	类型	描述

  参数	类型	描述
  logLevel	DingRtcLogLevel	Log级别，详见DingRtcLogLevel枚举类型。

  重要

  设置 SDK 的输出日志等级。默认值为 DingRtcLogLevelInfo。

  调用此接口，请在仅次于 SetLogDirPath 接口调用之后再调用本接口，避免因日志等级切换造成的打印丢失。

• setLogDirPath： 设置SDK日志文件保存路径。

   public int setLogDirPath (String logDirPath)

  参数说明

  参数	类型	描述

  参数	类型	描述
  logDirPath	String	日志文件保存目录的绝对路径，该参数是一个目录路径，而不是文件的路径。

  返回说明

  • 0，成功；
  • 非0，失败。其中有两种错误码，释义如下：
  • ERR_LOG_ROOT_PATH_ERROR：路径已存在或因权限问题不可访问。
  • ERR_LOG_ALREADY_INIT：log对象已经初始化过。
  重要

  调用此接口，请在调用其他所有SDK接口前调用本接口，避免日志出现丢失。同时，App必须保证指定的目录已存在并且可以写入。

  如果，目标路径不可写入或创建日志文件失败，则会使用默认日志路径。本次设置将无效。

• getSDKVersion： 查询SDK当前版本号。

   public String getSDKVersion ()

  返回说明

  当前的SDK版本号，格式为字符串，例："2.5.0.x"。

  重要

  在任何时刻都可以调用。

• getErrorDescription： 根据错误码，获取错误码描述。

   public String getErrorDescription (int errorCode)

  参数说明

  参数	类型	描述

  参数	类型	描述
  errorCode	int	错误码，详见DingRtcErrorCode。

  返回说明

  错误码描述字符串。

  重要

  在任何时刻都可以调用。

• getWhiteBoardManager： 获取白板管理类。

   public abstract DingRtcEngineWhiteboardManager getWhiteBoardManager ()

  返回说明

  白板管理类。

• getRtmClient： 获取RTM服务接口。

   public abstract DingRtmClient getRtmClient ()

  返回说明

  RTM服务接口。