本章节为您介绍了Android SDK的AliRtcEngine接口详情。

目录

基础接口

API 描述 以上版本支持
setH5CompatibleMode 设置H5兼容模式 1.1
getH5CompatibleMode 检查当前是否兼容H5 1.1
getInstance 创建AliRTCEngine实例(同一时间只会存在一个实例),只能在主线程调用 1.1
setRtcEngineEventListener 设置本地用户行为的回调事件的监听 1.1
setRtcEngineNotify 设置远端用户行为的通知事件的监听 1.1
destroy 销毁引擎 1.1
uploadLog 上传日志 1.15

频道相关接口

API 描述 以上版本支持
setAutoPublish 设置是否自动发布,是否自动订阅 1.1
joinChannel 加入频道 1.1
leaveChannel 离开频道 1.1
isInCall 检查当前是否在频道中 1.1

发布相关接口

API 描述 以上版本支持
isAutoPublish 查询当前是否为自动发布模式 1.1
configLocalCameraPublish 设置是否允许发布相机流 1.1
isLocalCameraPublishEnabled 查询当前是否允许发布相机流 1.1
configLocalScreenPublish 设置是否允许发布屏幕流 1.1
isLocalScreenPublishEnabled 查询当前是否允许发布屏幕流 1.1
configLocalAudioPublish 设置是否允许发布音频流 1.1
isLocalAudioPublishEnabled 查询当前是否允许发布音频流 1.1
configLocalSimulcast 设置是否允许发布次要视频流 1.1
isLocalSimulcastEnabled 查询当前是否允许发布次要视频流 1.1
publish 手动发布视频和音频流 1.1

订阅相关接口

API 描述 以上版本支持
isAutoSubscribe 查询当前是否为自动订阅模式 1.1
configRemoteCameraTrack 设置是否订阅远端相机流 1.1
configRemoteScreenTrack 设置是否订阅远端屏幕流 1.1
configRemoteAudio 设置是否订阅远端音频流 1.1
subscribe 手动订阅视频和音频流 1.1

视频相关接口

API 描述 以上版本支持
setVideoProfile 设置视频流参数 1.1
getVideoProfile 查询当前视频流参数 1.1
setLocalViewConfig 为本地预览设置渲染窗口以及绘制参数 1.1
muteLocalCamera 设置是否停止发布本地视频流 1.1
setRemoteViewConfig 为远端的视频设置渲染窗口以及绘制参数 1.1
switchCamera 切换前后摄像头 1.1
getCurrentCameraType 获取当前摄像头类型 1.1
setPreCameraType 预设值摄像头方向 1.1
getPreCameraType 获取预设值摄像头方向 1.1
setCameraZoom 设置摄像头参数 1.1
isCameraOn 检查摄像头是否打开 1.1
isCameraSupportExposurePoint 相机是否支持手动曝光 1.14
isCameraSupportFocusPoint 相机是否支持手动聚焦 1.14
setCameraExposurePoint 设置手动曝光的坐标点 1.14
setCameraFocusPoint 设置手动聚焦的坐标点 1.14
isCameraFlash 是否开启了闪光灯 1.14
getCameraZoom 获取相机的zoom值 1.14
RegisterPreprocessVideoObserver 注册人脸识别预处理 1.14
setChannelProfile 设置频道模式 1.15

音频相关接口

API 描述 以上版本支持
setAudioOnlyMode 设置纯音频模式还是音视频模式 1.1
isAudioOnly 查询当前是否为纯音频模式 1.1
muteLocalMic 设置是否停止发布本地音频 1.1
muteRemoteAudioPlaying 设置是否停止播放远端音频流 1.1
enableSpeakerphone 切换听筒、扬声器输出 1.1
isSpeakerOn 查询是否开启扬声器 1.1
startAudioCapture 开启音频采集 1.11
stopAudioCapture 关闭音频采集 1.11
startAudioPlayer 开启音频播放 1.11
stopAudioPlayer 关闭音频播放 1.11
enableEarBack 设置耳返开关 1.15
startAudioAccompany 开始播放伴奏 1.15
pauseAudioAccompany 暂停播放伴奏 1.15
resumeAudioAccompany 恢复播放伴奏 1.15
stopAudioAccompany 结束播放伴奏 1.15
setAudioAccompanyPublishVolume 设置伴奏推流音量 1.15
setAudioAccompanyPlayoutVolume 设置伴奏本地音量 1.15
getAudioAccompanyPublishVolume 获取伴奏推流音量 1.15
getAudioAccompanyPlayoutVolume 获取伴奏本地音量 1.15
setAudioAccompanyVolume 设置伴奏推流和本地音量 1.15
preloadAudioEffect 预加载音效 1.15
unloadAudioEffect 清除预加载音效 1.15
playAudioEffect 开始播放音效 1.15
setAudioEffectPublishVolume 设置音效推流音量 1.15
getAudioEffectPublishVolume 获取音效推流音量 1.15
setAudioEffectPlayoutVolume 设置音效本地音量 1.15
getAudioEffectPlayoutVolume 获取音效本地音量 1.15
pauseAudioEffect 暂停播放音效 1.15
resumeAudioEffect 恢复播放音效 1.15
stopAudioEffect 停止播放音效 1.15
setEarBackVolume 设置耳返音量 1.15
setRecordingVolume 设置录音音量 1.16
setPlayoutVolume 设置播放音量 1.16

预览接口

API 描述 以上版本支持
startPreview 开始本地预览 1.1
stopPreview 停止本地预览 1.1
enableHighDefinitionPreview 是否开启高清预览 1.16

远端用户查询接口

API 描述 以上版本支持
getOnlineRemoteUsers 获取远端在线用户列表 1.1
getUserInfo 查询远端用户信息 1.1
isUserOnline 查询远端用户是否在线 1.1
getMediaInfoWithUserId 获取媒体流信息 1.9

其他接口

API 描述 以上版本支持
setLogLevel 设置日志级别 1.1
getSdkVersion 获取SDK版本号 1.1
setClientRole 设置用户角色 1.16

接口详情

  • setH5CompatibleMode:设置是否兼容H5,默认不兼容H5。

    说明 该接口仅支持在创建AliRtcEngine实例前调用。
    AliRtcEngine.setH5CompatibleMode(int enable)           

    参数:

    参数 类型 说明
    enable int 0表示不兼容H5,1表示兼容H5。
  • getH5CompatibleMode:检查当前是否兼容H5,返回1表示兼容,0表示不兼容。

    说明 该接口仅支持在创建AliRtcEngine实例后调用。
    public static int getH5CompatibleMode()                 
  • getInstance:创建AliRTCEngine实例(同一时间只会存在一个实例),只能在主线程调用。

    public static AliRtcEngineImpl getInstance(Context context)          

    参数:

    参数 类型 说明
    context Context 上下文。
  • setRtcEngineEventListener:设置本地用户行为的回调事件的监听。

    public abstract void setRtcEngineEventListener(AliRtcEngineEventListener listener)                    

    参数:

    参数 类型 说明
    listener AliRtcEngineEventListener 接收回调事件的监听器。
  • setRtcEngineNotify:设置远端用户行为的通知事件的监听。

    public abstract void setRtcEngineNotify(AliRtcEngineNotify engineNotify)               

    参数:

    参数 类型 说明
    engineNotify AliRtcEngineNotify 接收通知的监听器。
  • destroy:销毁引擎。

    1.15及以上版本:销毁引擎只能通过destroy方法。

    1.15以下版本:离开频道时,AliRtcEngine实例会被销毁,如需继续加入频道等操作,需要先重新调用getInstance初始化AliRtcEngine实例。

    public abstract void destroy();                  
  • uploadLog:上传日志。

    public abstract void uploadLog();
  • setAutoPublish:设置是否自动发布,是否自动订阅。默认是自动发布和订阅,必须在加入频道之前设置。

    public int setAutoPublish(boolean autoPub, boolean autoSub);

    参数:

    参数 类型 说明
    autoPub boolean true表示自动发布;false表示手动发布。
    autoSub boolean true表示自动订阅;false表示手动订阅。
  • joinChannel:加入频道。

    加入频道成功后,如果中途需要加入其他频道,必须先调用leaveChannel离开当前频道,如果加入频道失败,需要重试时,无需先调用leaveChannel。

    public abstract void joinChannel(AliRtcAuthInfo authInfo, String userName)                    

    参数:

    参数 类型 说明
    authInfo AliRtcAuthInfo 鉴权信息,从AppServer下发,AppServer可通过API获取。
    userName String 用户的显示名称,不是uid
  • leaveChannel:离开频道。

    1.15及以上版本:调用leaveChannel不会销毁实例。

    1.15版本以下:离开频道时,AliRtcEngine实例会被销毁,如需继续加入频道等操作,需要先重新调用getInstance初始化AliRtcEngine实例。

    • 对于版本号大于1.7的SDK,请调用如下接口。
      public abstract void leaveChannel()                          
    • 对于版本号小于等于1.7的SDK,请增加timeout参数,一般建议设置为1000,表示该接口的调用超时时间为1秒。
      public abstract void leaveChannel(long timeout)                          
  • isInCall:检查当前是否在频道中,返回true表示在频道中,false表示不在频道中。

    public abstract boolean isInCall()                  
  • isAutoPublish:查询当前是否为自动发布模式,返回true为自动发布,false为手动发布。

    public abstract boolean isAutoPublish()                  
  • configLocalCameraPublish:设置是否允许发布相机流。默认为允许发布相机流,手动发布时,需要调用publish才能生效。

    public abstract void configLocalCameraPublish(boolean enable)                

    参数:

    参数 类型 说明
    enable boolean true为允许发布相机流;false表示不允许。
  • isLocalCameraPublishEnabled:查询当前是否允许发布相机流,返回true为允许,false为不允许。

    public abstract boolean isLocalCameraPublishEnabled()                   
  • configLocalScreenPublish:设置是否允许发布屏幕流。默认为不允许发布屏幕流,手动发布时,需要调用publish才能生效。

    public abstract void configLocalScreenPublish(boolean enable)                  

    参数:

    参数 类型 说明
    enable boolean true表示允许发布屏幕流;false表示不允许。
  • isLocalScreenPublishEnabled:查询当前是否允许发布屏幕流,返回true为允许,false为不允许。

    public abstract boolean isLocalScreenPublishEnabled()                   
  • configLocalAudioPublish:设置是否允许发布音频流。默认为允许发布音频流,手动发布时,需要调用publish才能生效。

    public abstract void configLocalAudioPublish(boolean enable)          

    参数:

    参数 类型 说明
    enable boolean true表示允许;false表示不允许。
  • isLocalAudioPublishEnabled:查询当前是否允许发布音频流,返回true为允许,false为不允许。

    public abstract boolean isLocalAudioPublishEnabled()                
  • configLocalSimulcast:设置是否允许发布次要视频流。默认为允许发布次要视频流,手动发布时,需要调用publish才能生效。

    public abstract int configLocalSimulcast(boolean enable, AliRtcVideoTrack track)        

    参数:

    参数 类型 说明
    enable boolean true表示允许发布次要流,false表示不允许。
    track AliRtcVideoTrack 流类型,当前只支持相机流:AliVideoTrackCamera。
  • isLocalSimulcastEnabled:查询当前是否允许发布次要视频流,返回true为允许,false为不允许。

    public abstract boolean isLocalSimulcastEnabled()                  
  • publish:手动发布视频和音频流。

    • 调用publish的实际表现需要结合configLocalCameraPublish、configLocalScreenPublish、configLocalAudioPublish、configLocalSimulcast等接口才能确定。
    • 根据您的具体业务需求配置上述4个接口的参数,以发布相应的视频和音频流。
    • 发布和停止发布都是调用publish。
    • 如需停止发布,则需要上述4个配置接口的参数都置为false,再调用publish。
    • 需要在加入频道成功之后调用该接口。
    public abstract void publish()                  
  • isAutoSubscribe:查询当前是否为自动订阅模式,返回true为自动订阅,false为手动订阅。

    public abstract boolean isAutoSubscribe()                 
  • configRemoteCameraTrack:设置是否订阅远端相机流。默认为订阅大流,手动订阅时,需要调用subscribe才能生效。

    public abstract void configRemoteCameraTrack(String uid, boolean master, boolean enable)                  

    参数:

    参数 类型 说明
    uid String 用户ID,从AppServer分配的唯一标示符。
    master boolean 是否优先订阅大流。true为订阅大流;false为订阅次小流。
    enable boolean true为订阅远端相机流,false为停止订阅远端相机流。
  • configRemoteScreenTrack:设置是否订阅远端屏幕流。默认为不订阅远端屏幕流,手动订阅时,需要调用subscribe才能生效。

    public abstract void configRemoteScreenTrack(String uid, boolean enable)                  

    参数:

    参数 类型 说明
    uid String 用户ID,从AppServer分配的唯一标示符。
    enable boolean true为订阅远端屏幕流,false为停止订阅远端屏幕流。
  • configRemoteAudio:设置是否订阅远端音频流。默认为订阅远端音频流,手动订阅时,需要调用subscribe才能生效。

    public abstract void configRemoteAudio(String uid, boolean enable)                  

    参数:

    参数 类型 说明
    uid String 用户ID,从AppServer分配的唯一标示符。
    enable boolean true为订阅远端音频流,false为停止订阅远端音频流。
  • subscribe:手动订阅视频和音频流。返回为0时说明接口执行正常,但是否订阅成功还得看回调结果;返回为非0时,说明接口执行异常中断,订阅失败。

    • 调用subscribe的实际表现需要结合configRemoteCameraTrack、configRemoteScreenTrack、configRemoteAudio等接口才能确定。
    • 根据您的具体业务需求配置上述3个接口的参数,以订阅相应的视频和音频流。
    • 订阅和停止订阅都是调用subscribe。
    • 如需停止订阅,则需要上述3个配置接口的参数都置为false,再调用subscribe。
    public abstract int subscribe(String uid)                 

    参数:

    参数 类型 说明
    uid String 用户ID,从AppServer分配的唯一标示符。
  • setVideoProfile:设置视频流参数。

    public abstract void setVideoProfile(AliRtcVideoProfile profile, AliRtcVideoTrack track)                   

    参数:

    参数 类型 说明
    profile AliRtcVideoProfile 视频流参数。
    track AliRtcVideoTrack 需要设置的视频流类型。
  • getVideoProfile:查询当前视频流参数。

    public abstract AliRtcVideoProfile getVideoProfile(AliRtcVideoTrack track)                    

    参数:

    参数 类型 说明
    track AliRtcVideoTrack 需要查询的视频流类型。
    返回值:
    返回值 描述
    AliRtcVideoProfile 视频流规格。
  • setLocalViewConfig:为本地预览设置渲染窗口以及绘制参数。

    • 支持加入频道之前和之后切换窗口。如果viewConfig为NULL或者其成员渲染视图为NULL,则停止渲染。
    • 如果在播放过程中需要重新设置渲染方式,请保持viewConfig中其他成员变量不变,仅修改renderMode。
    • viewConfig中渲染方式默认为AliRtcRenderModeAuto。
    public abstract int setLocalViewConfig(AliVideoCanvas viewConfig, AliRtcVideoTrack track)                   

    参数:

    参数 类型 说明
    viewConfig AliVideoCanvas 渲染参数,包含渲染窗口以及渲染方式。
    track AliRtcVideoTrack 预览只允许AliVideoTrackCamera。
  • muteLocalCamera:设置是否停止发布本地视频流。不改变当前视频流的采集状态。

    public abstract int muteLocalCamera(boolean mute, AliRtcVideoTrack track)                   

    参数:

    参数 类型 说明
    mute boolean true表示停止发布视频流;false表示恢复发布。
    track AliRtcVideoTrack 需要改变发布状态的videoTrack类型。
  • setRemoteViewConfig:为远端的视频设置渲染窗口以及绘制参数。

    • 支持joinChannel之前和之后切换窗口。如果canvas为NULL或者其成员渲染视图为NULL,则停止渲染相应的流。
    • 如果在播放过程中需要重新设置渲染方式,请保持canvas中其他成员变量不变,仅修改renderMode。
    • canvas中渲染方式默认为AliRtcRenderModeAuto。
    • 建议在订阅结果回调之后调用。
    public abstract int setRemoteViewConfig(AliVideoCanvas canvas, String uid, AliRtcVideoTrack track)                    

    参数:

    参数 类型 说明
    canvas AliVideoCanvas 渲染参数,包含渲染窗口以及渲染方式。
    uid String 用户ID,从AppServer分配的唯一标示符。
    track AliRtcVideoTrack 需要设置的videoTrack类型。
  • switchCamera:切换前后摄像头,返回0为切换成功,其他为切换失败。

    public abstract int switchCamera()                  
  • getCurrentCameraType:获取当前摄像头类型,返回摄像头的类型AliRTCCameraType

    public abstract AliRTCCameraType getCurrentCameraType()                   
  • setPreCameraType:预设值摄像头方向。

    public abstract void setPreCameraType(int faceTo)                    

    参数:

    参数 类型 说明
    faceTo int 0表示后置,1表示前置。
  • getPreCameraType:获取预设值摄像头方向。返回0为后置摄像头,1为前置摄像头。

    public abstract int getPreCameraType()                  
  • setCameraZoom:设置摄像头参数。返回0表示设置成功,其他表示设置失败。

    public abstract int setCameraZoom(float zoom, boolean flash, boolean autoFocus)                  

    参数:

    参数 类型 说明
    zoom float zoom变焦的级别。
    flash boolean 是否打开闪光灯。
    autoFocus boolean 是否打开自动对焦。
  • isCameraOn:检查摄像头是否打开。返回true表示摄像头已打开,false表示摄像头未打开。

    public abstract boolean isCameraOn()                   
  • isCameraSupportExposurePoint:查看摄像头是否支持手动曝光,返回true表示支持,否则返回false。

    public abstract boolean isCameraSupportExposurePoint();
  • isCameraSupportFocusPoint: 查看是否支持手动聚焦,返回true表示支持,否则返回false。

    public abstract boolean isCameraSupportFocusPoint();
  • setCameraExposurePoint: 设置手动曝光点。返回0表示设置成功,其他表示设置失败。

    public abstract int setCameraExposurePoint(float x, float y);

    参数:

    参数 类型 描述
    x float x坐标。
    y float y坐标。
  • setCameraFocusPoint:设置手动聚焦点,返回0表示设置成功,非0表示设置失败

    public abstract int setCameraFocusPoint(float x, float y);

    参数:

    参数 类型 描述
    x float x坐标。
    y float y坐标。
  • isCameraFlash():查看摄像头闪光灯是否开启,返回true表示开启,否则返回false。

    public abstract boolean isCameraFlash();
  • getCameraZoom(): 获取相机zoom值,返回值范围:1~相机支持的最大值。

    public abstract float getCameraZoom();
  • RegisterPreprocessVideoObserver:注册人脸识别预处理。

    public abstract void RegisterPreprocessVideoObserver(AliDetectObserver observer);

    参数:

    参数 类型 描述
    observer AliDetectObserver 人脸识别预处理。
  • setChannelProfile:设置频道模式。返回0为成功,非0失败。

    说明 该接口只可以在joinChannel之前调用,通信中不可以重新设置,在调用LeaveChannel后可以重新设置。
    public abstract int setChannelProfile(AliRTCSDK_Channel_Profile profile);

    参数:

    参数 类型 描述
    profile AliRTCSDK_Channel_Profile 频道模式类型。
  • setAudioOnlyMode:设置纯音频模式还是音视频模式。返回0代表设置成功,其他代表设置失败。默认为音视频模式(非纯音频),必须在joinChannel之前设置。

    public abstract int setAudioOnlyMode(boolean audioOnly)                  

    参数:

    参数 类型 说明
    audioOnly boolean true表示只有音频发布和订阅;false表示音视频都支持。
  • isAudioOnly:查询当前是否为纯音频模式,返回true为纯音频,false为音视频。

    public abstract boolean isAudioOnly()                 
  • muteLocalMic:设置是否停止发布本地音频。返回0表示设置成功,-1表示设置失败。不改变当前音频的采集状态。

    public abstract int muteLocalMic(boolean mute)                    

    参数:

    参数 类型 说明
    mute boolean true表示停止发布本地音频;false表示恢复发布。
  • muteRemoteAudioPlaying:设置是否停止播放远端音频流,返回0表示设置成功,-1表示设置失败。

    public abstract int muteRemoteAudioPlaying(String uid, boolean mute)                   

    参数:

    参数 类型 说明
    uid String 用户ID,从AppServer分配的唯一标示符。
    mute boolean true表示停止播放;false表示恢复播放。
  • enableSpeakerphone:切换听筒、扬声器输出。

    public abstract int enableSpeakerphone(boolean enable)                  

    参数:

    参数 类型 说明
    enable boolean true为扬声器模式;false为听筒模式。
  • isSpeakerOn:查询是否开启扬声器。返回true表示已开启扬声器,false表示未开启扬声器。

    public abstract boolean isSpeakerOn()                  
  • startAudioCapture:开启音频采集。您可以控制提前打开音频采集,如果不设置,SDK会在开始推流的时候打开音频采集。

    public int startAudioCapture();
  • stopAudioCapture:关闭音频采集。您可以控制关闭音频采集。

    public int stopAudioCapture();
  • startAudioPlayer:开启音频播放。您可以控制提前打开音频播放,如果不设置,SDK会在订阅成功的时候打开音频播放。

    public int startAudioPlayer();
  • stopAudioPlayer:关闭音频播放。您可以控制关闭音频播放。

    public int stopAudioPlayer();
  • enableEarBack:开启或关闭耳返功能,返回0表示操作成功,非0表示操作失败。

    public abstract int enableEarBack(boolean enable);

    参数:

    参数 类型 描述
    enable boolean true表示开启耳返,false表示关闭耳返。
  • startAudioAccompany:开始播放伴奏,返回0表示操作成功,非0表示操作失败。

    public abstract int startAudioAccompany(String fileName, boolean onlyLocalPlay, boolean replaceMic, int loopCycles);

    参数:

    参数 类型 描述
    fileName String 伴奏文件路径。
    onlyLocalPlay boolean 是否仅本地播放,true表示仅仅本地播放,false表示本地播放且推流到远端。
    replaceMic boolean 是否替换mic的音频流,true表示伴奏音频流替换本地mic音频流,false表示伴奏音频流和mic音频流同时推。
    loopCycles int 循环播放次数,-1表示一直循环。
  • pauseAudioAccompany:暂停播放伴奏,返回0表示操作成功,非0表示操作失败。

    public abstract int pauseAudioAccompany();
  • resumeAudioAccompany:恢复伴奏播放,返回0表示操作成功,非0表示操作失败。

    public abstract int resumeAudioAccompany();
  • stopAudioAccompany:停止播放伴奏,返回0表示操作成功,非0表示操作失败。

    public abstract int stopAudioAccompany();
  • setAudioAccompanyPublishVolume:设置伴奏推流音量,返回0表示操作成功,非0表示操作失败。

    public abstract int setAudioAccompanyPublishVolume(int volume);

    参数:

    参数 类型 描述
    volume int 伴奏推流音量。
  • setAudioAccompanyPlayoutVolume:设置伴奏本地播放音量,返回0表示操作成功,非0表示操作失败。

    public abstract int setAudioAccompanyPlayoutVolume(int volume);

    参数:

    参数 类型 描述
    volume int 伴奏本地播放音量。
  • getAudioAccompanyPublishVolume:获取伴奏推流音量。返回0~100的伴奏推流音量,返回-1表示获取失败。

    public abstract int getAudioAccompanyPublishVolume();
  • getAudioAccompanyPlayoutVolume:获取伴奏本地播放音量。返回0~100的伴奏本地播放音量,返回-1表示获取失败。

    public abstract int getAudioAccompanyPlayoutVolume();
  • setAudioAccompanyVolume:统一设置本地播放音量和推流音量,返回0表示操作成功, 非0表示操作失败。

    public abstract int setAudioAccompanyVolume(int volume);
  • preloadAudioEffect:预加载音效文件,返回0表示操作成功,非0表示操作失败。

    public abstract int preloadAudioEffect(int soundId, String filePath);

    参数:

    参数 类型 描述
    soundId int 音效id(此id由调用者生成)。
    filePath String 音效文件路径。
  • unloadAudioEffect:清除预加载的音效,返回0表示操作成功,非0表示操作失败。

    public abstract int unloadAudioEffect(int soundId);

    参数:

    参数 类型 描述
    soundId int 音效id(此id应与预加载时传入的id相同)。
  • playAudioEffect:播放音效,返回0表示操作成功,非0表示操作失败。

    public abstract int playAudioEffect(int soundId, String filePath, int cycles, boolean publish);

    参数:

    参数 类型 描述
    soundId int 音效id。
    filePath String 音效文件路径。
    cycles int 循环播放次数,-1表示一直循环。
    publish boolean 是否将音效音频流推到远端。
  • setAudioEffectPublishVolume:设置音效推流到远端的音量,返回0表示操作成功,非0表示操作失败。

    public abstract int setAudioEffectPublishVolume(int soundId, int volume);

    参数:

    参数 类型 描述
    soundId int 音效id。
    volume int 音效推流音量(0-100)。
  • getAudioEffectPublishVolume:获取音效推流到远端的音量。返回0~100音效推流音量,返回-1表示获取失败。

    public abstract int getAudioEffectPublishVolume(int soundId);

    参数:

    参数 类型 描述
    soundId int 音效id。
  • setAudioEffectPlayoutVolume:设置音效本地播放音量,返回0表示操作成功,非0表示操作失败。

    public abstract int setAudioEffectPlayoutVolume(int soundId, int volume);

    参数:

    参数 类型 描述
    soundId int 音效id。
    volume int 音效本地播放音量(0-100)。
  • getAudioEffectPlayoutVolume:获取音效本地播放音量。返回0~100的音效本地播放音量,返回-1时表示获取失败。

    public abstract int getAudioEffectPlayoutVolume(int soundId);

    参数:

    参数 类型 描述
    soundId int 音效id。
  • pauseAudioEffect:暂停播放音效,返回0表示操作成功,非0表示操作失败。

    public abstract int pauseAudioEffect(int soundId);

    参数:

    参数 类型 描述
    soundId int 音效id。
  • resumeAudioEffect:恢复播放音效,返回0表示操作成功,非0表示操作失败。

    public abstract int resumeAudioEffect(int soundId);

    参数:

    参数 类型 描述
    soundId int 音效id。
  • stopAudioEffect:停止播放音效,返回0表示操作成功,非0表示操作失败。

    public abstract int stopAudioEffect(int soundId);

    参数:

    参数 类型 描述
    soundId int 音效id。
  • setEarBackVolume:设置耳返的音量,返回0表示操作成功,非0表示操作失败。

    public abstract int setEarBackVolume(int volume);

    参数:

    参数 类型 描述
    volume int 耳返音量(0-100)。只有耳返开启时才能设置音量,否则该方法返回错误。
  • setRecordingVolume:设置录音音量,返回0表示操作成功,非0表示操作失败。

    public abstract int setRecordingVolume(int volume);
    参数 类型 描述
    volume int 音量,取值0~400,0表示静音。
    • 当设置>100:放大音量。
    • 当设置<100:减小音量。
  • setPlayoutVolume:设置播放音量,返回0表示操作成功,非0表示操作失败。

    public abstract int setPlayoutVolume(int volume);
    参数 类型 描述
    volume int 音量,取值0~400,0表示静音。
    • 当设置>100:放大音量。
    • 当设置<100:减小音量。
  • startPreview:开始本地预览,开始预览之前需要调用setLocalViewConfig。

    public abstract int startPreview()                  
    说明 您可以在加入频道之前开始本地预览。
  • stopPreview:停止本地预览。

    public abstract int stopPreview()                   
  • enableHighDefinitionPreview:开启高清预览 。返回0成功,返回-1表示操作失败。

    public abstract int enableHighDefinitionPreview(boolean enable);
    参数 类型 描述
    enable boolean true表示开启,false表示关闭。
  • getOnlineRemoteUsers:获取远端在线用户列表,返回用户ID列表。

    该方法在加入频道时调用有延时,建议您通过onRemoteUserOnLineNotify回调维护一个远端用户列表。

    public abstract String[] getOnlineRemoteUsers()                
  • getUserInfo:查询远端用户信息。

    public abstract AliRtcRemoteUserInfo getUserInfo(String uid)                  

    参数:

    参数 类型 说明
    uid String 用户ID,从AppServer分配的唯一标示符。
    返回值:
    返回值 描述
    AliRtcRemoteUserInfo 远程用户信息。
  • isUserOnline:查询远端用户是否在线,返回true表示在线,false表示不在线。

    public abstract boolean isUserOnline(String uid)

    参数:

    参数 类型 说明
    uid String 用户ID,从AppServer分配的唯一标示符。
  • getMediaInfoWithUserId:获取媒体流信息。

    public String getMediaInfoWithUserId(String userId, AliRtcVideoTrack track, String[] keys);

    参数:

    参数 类型 说明
    userId String 用户的userId。
    track AliRtcVideoTrack 需要查询的媒体流类型。
    keys String[] 查询key值数组。
  • setLogLevel:设置log级别。

    public abstract void setLogLevel(AliRtcLogLevel logLevel)         

    参数:

    参数 类型 说明
    logLevel AliRtcLogLevel 日志级别。
  • getSdkVersion:获取SDK版本号。

    public abstract String getSdkVersion()                   
  • setClientRole:设置频道模式。返回0表示成功,非0表示失败。您仅可以在频道模式为InteractiveLive下调用;入会前或会议中均可设置,设置成功会收到onUpdateRoleNotify;从Interactive转换为Live角色需要先停止推流,否则返回失败。

    public abstract int setClientRole(AliRTCSDK_Client_Role role);
    参数 类型 描述
    role AliRTCSDK_Client_Role 用户角色类型。