My IMP(低代码音视频工厂)SDK v1.5.0
IMP SDK API Reference Manual for Android Platforms
Public Member Functions | List of all members
com.aliyun.roompaas.rtc.exposable.RtcService Interface Reference
Inheritance diagram for com.aliyun.roompaas.rtc.exposable.RtcService:
com.aliyun.roompaas.base.exposable.PluginService< EH > com.aliyun.roompaas.base.exposable.IEventHandlerManager< EH >

Public Member Functions

boolean hasRtc ()
 
void listRtcUser (RtcUserParam param, Callback< PageModel< ConfUserModel > > callback)
 
void listRtcApplyUser (RtcApplyUserParam param, Callback< PageModel< ConfUserModel > > callback)
 
View startRtcPreview ()
 
void joinRtc (String nick)
 
void joinRtcWithConfig (RtcStreamConfig config, String nick)
 
void setCustomBypassLiveLayout (Collection< RTCBypassPeerVideoConfig > configCollection, Callback< Void > callback)
 
void startRoadPublish (Callback< Void > callback)
 
void stopRoadPublish (Callback< Void > callback)
 
void stopPlayRoad ()
 
void applyJoinRtc (boolean apply, Callback< Void > callback)
 
void inviteJoinRtc (List< ConfUserModel > userModels, Callback< Void > callback)
 
void handleApplyJoinRtc (String userId, boolean agree, Callback< Void > callback)
 
void reportJoinStatus (RtcUserStatus status, Callback< Void > callback)
 
void kickUserFromRtc (List< String > userIds, Callback< Void > callback)
 
void getRtcDetail (Callback< ConfInfoModel > callback)
 
void queryRtcDetail (String conferenceId, Callback< ConfInfoModel > callback)
 
ConfInfoModel getRtcDetail ()
 
void leaveRtc (boolean destroyRtc)
 
void startPreview ()
 
void stopPreview ()
 
void setRemoteViewConfig (AliRtcEngine.AliRtcVideoCanvas videoCanvas, String userId, AliRtcEngine.AliRtcVideoTrack videoTrack)
 
void setLocalViewConfig (AliRtcEngine.AliRtcVideoCanvas videoCanvas, AliRtcEngine.AliRtcVideoTrack videoTrack)
 
void configRemoteCameraTrack (String userId, boolean isMainStream, boolean enable)
 
void muteLocalMic (boolean muteLocalMic)
 
void muteRemoteAudioPlaying (String uid, boolean mute)
 
void muteAllRemoteAudioPlaying (boolean mute)
 
void muteLocalCamera (boolean muteLocalCamera)
 
boolean switchCamera ()
 
void setPreviewMirror (boolean enable)
 
void setVideoStreamMirror (boolean enable)
 
void setLayout (List< String > userIds, RtcLayoutModel layoutModel, Callback< Void > callback)
 
void startRecord (Callback callback)
 
void stopRecord (Callback callback)
 
int publishLocalAudio (boolean enable)
 
int publishLocalVideo (boolean enable)
 
int enableLocalVideo (boolean enable)
 
int subscribeRemoteAudioStream (String uid, boolean sub)
 
int subscribeAllRemoteAudioStreams (boolean sub)
 
int subscribeRemoteVideoStream (String uid, AliRtcEngine.AliRtcVideoTrack track, boolean sub)
 
int subscribeAllRemoteVideoStreams (boolean sub)
 
int setAudioOnlyMode (boolean audioOnly)
 
boolean isAudioOnly ()
 
int setBasicFaceBeauty (boolean enable, float whiteningLevel, float smoothnessLevel)
 设置基础美颜 More...
 
int startScreenShare ()
 
int stopScreenShare ()
 
int addVideoWatermark (AliRtcEngine.AliRtcVideoTrack track, String imageUrl, AliRtcEngine.AliRtcWatermarkConfig config)
 
- Public Member Functions inherited from com.aliyun.roompaas.base.exposable.PluginService< EH >
String getPluginId ()
 
String getInstanceId ()
 
void onLeaveRoom (boolean existPage)
 
void onSyncEvent (RoomNotificationModel model)
 
- Public Member Functions inherited from com.aliyun.roompaas.base.exposable.IEventHandlerManager< EH >
void addEventHandler (EH eventHandler)
 
void removeEventHandler (EH eventHandler)
 
void removeAllEventHandler ()
 

Detailed Description

Author
puke
Version
2021/6/21

Member Function Documentation

◆ addVideoWatermark()

int com.aliyun.roompaas.rtc.exposable.RtcService.addVideoWatermark ( AliRtcEngine.AliRtcVideoTrack  track,
String  imageUrl,
AliRtcEngine.AliRtcWatermarkConfig  config 
)

添加水印

Parameters
track
imageUrl
config
Returns

◆ applyJoinRtc()

void com.aliyun.roompaas.rtc.exposable.RtcService.applyJoinRtc ( boolean  apply,
Callback< Void >  callback 
)

(取消)申请入会

Parameters
applytrue: 申请; false: 取消申请;
callback回调函数

◆ configRemoteCameraTrack()

void com.aliyun.roompaas.rtc.exposable.RtcService.configRemoteCameraTrack ( String  userId,
boolean  isMainStream,
boolean  enable 
)

订阅远端相机流，默认为订阅大流，手动订阅

Parameters
userId用户Id
isMainStreamtrue 优先订阅大流，false订阅小流
enabletrue 订阅远端相机流，false停止订阅无端相机流

◆ enableLocalVideo()

int com.aliyun.roompaas.rtc.exposable.RtcService.enableLocalVideo ( boolean  enable)

禁用或重新启用本地视频采集

Returns

◆ getRtcDetail() [1/2]

ConfInfoModel com.aliyun.roompaas.rtc.exposable.RtcService.getRtcDetail ( )
Returns
获取会议详情

◆ getRtcDetail() [2/2]

void com.aliyun.roompaas.rtc.exposable.RtcService.getRtcDetail ( Callback< ConfInfoModel >  callback)

查询会议详情

Parameters
callback回调函数

◆ handleApplyJoinRtc()

void com.aliyun.roompaas.rtc.exposable.RtcService.handleApplyJoinRtc ( String  userId,
boolean  agree,
Callback< Void >  callback 
)

处理申请入会事件

Parameters
userId处理的用户Id
agreetrue: 统一入会; false: 拒绝入会;
callback回调函数

◆ hasRtc()

boolean com.aliyun.roompaas.rtc.exposable.RtcService.hasRtc ( )
Returns
判断是否有Rtc

◆ inviteJoinRtc()

void com.aliyun.roompaas.rtc.exposable.RtcService.inviteJoinRtc ( List< ConfUserModel >  userModels,
Callback< Void >  callback 
)

邀请入会

Parameters
userModels被邀请人Id
callback回调函数

◆ isAudioOnly()

boolean com.aliyun.roompaas.rtc.exposable.RtcService.isAudioOnly ( )

获取音频或音视频模式

Returns

◆ joinRtc()

void com.aliyun.roompaas.rtc.exposable.RtcService.joinRtc ( String  nick)

进入会议

1. 大班课
   1.1 老师端:
       1.1.1 开始上课: 入会, 上麦, 订阅(enterSeat, startPublish)
             1.1.1.1 开始推流: 旁路推流(pushLiveStream)
             1.1.1.2 停止推流: 停止旁路推流
       1.1.2 停止上课: 下麦, 离会
   1.2 学生端: 旁路拉流(rtc待添加)
       1.2.1 被邀请上麦: 入会, 上麦, 订阅, 关闭旁路拉流
       1.2.2 下麦: 开始旁路拉流, 取消订阅, 下麦, 离会

2. 小班课
   2.1 老师端: 入会, 上麦, 订阅(enterSeat, startPublish)
   2.2 学生端: 入会, 上麦, 订阅(enterSeat, startPublish)
Parameters
nick入会昵称

◆ joinRtcWithConfig()

void com.aliyun.roompaas.rtc.exposable.RtcService.joinRtcWithConfig ( RtcStreamConfig  config,
String  nick 
)

进入会议

Parameters
configRTC配置参数
nick昵称

◆ kickUserFromRtc()

void com.aliyun.roompaas.rtc.exposable.RtcService.kickUserFromRtc ( List< String >  userIds,
Callback< Void >  callback 
)

会议踢人

Parameters
userIds目标用户Id
callback回调函数

◆ leaveRtc()

void com.aliyun.roompaas.rtc.exposable.RtcService.leaveRtc ( boolean  destroyRtc)

下麦 + 离会

Parameters
destroyRtc是否需要销毁会议

◆ listRtcApplyUser()

void com.aliyun.roompaas.rtc.exposable.RtcService.listRtcApplyUser ( RtcApplyUserParam  param,
Callback< PageModel< ConfUserModel > >  callback 
)

查询Rtc申请连麦的用户列表

Parameters
param查询参数
callback回调函数

◆ listRtcUser()

void com.aliyun.roompaas.rtc.exposable.RtcService.listRtcUser ( RtcUserParam  param,
Callback< PageModel< ConfUserModel > >  callback 
)

查询Rtc在线用户列表

Parameters
param查询参数
callback回调函数

◆ muteAllRemoteAudioPlaying()

void com.aliyun.roompaas.rtc.exposable.RtcService.muteAllRemoteAudioPlaying ( boolean  mute)

静音所有远端用户

Parameters
mute

◆ muteLocalCamera()

void com.aliyun.roompaas.rtc.exposable.RtcService.muteLocalCamera ( boolean  muteLocalCamera)

关闭摄像头，成功返回true

Parameters
muteLocalCamera返回0为切换成功
Returns
是否发布本地相机流

◆ muteLocalMic()

void com.aliyun.roompaas.rtc.exposable.RtcService.muteLocalMic ( boolean  muteLocalMic)

静音，成功返回true

Parameters
muteLocalMic返回0为成功
Returns
是否发布本地音频流

◆ muteRemoteAudioPlaying()

void com.aliyun.roompaas.rtc.exposable.RtcService.muteRemoteAudioPlaying ( String  uid,
boolean  mute 
)

静音远端用户

Parameters
uid
mute

◆ publishLocalAudio()

int com.aliyun.roompaas.rtc.exposable.RtcService.publishLocalAudio ( boolean  enable)

是否发布音频流

Parameters
enable

◆ publishLocalVideo()

int com.aliyun.roompaas.rtc.exposable.RtcService.publishLocalVideo ( boolean  enable)

是否发布视频流

Parameters
enable

◆ queryRtcDetail()

void com.aliyun.roompaas.rtc.exposable.RtcService.queryRtcDetail ( String  conferenceId,
Callback< ConfInfoModel >  callback 
)

查询会议详情

Parameters
conferenceId会议ID
callback回调函数

◆ reportJoinStatus()

void com.aliyun.roompaas.rtc.exposable.RtcService.reportJoinStatus ( RtcUserStatus  status,
Callback< Void >  callback 
)

上报会议状态

Parameters
status用户状态
callback回调函数

◆ setAudioOnlyMode()

int com.aliyun.roompaas.rtc.exposable.RtcService.setAudioOnlyMode ( boolean  audioOnly)

设置纯音频模式 还是 音视频模式

Parameters
audioOnlytrue: 只有音频推拉流 false
Returns

◆ setBasicFaceBeauty()

int com.aliyun.roompaas.rtc.exposable.RtcService.setBasicFaceBeauty ( boolean  enable,
float  whiteningLevel,
float  smoothnessLevel 
)

设置基础美颜

Parameters
enable基础美颜开关
whiteningLevel美白等级[0-1.0]
smoothnessLevel磨皮等级[0-1.0]

◆ setCustomBypassLiveLayout()

void com.aliyun.roompaas.rtc.exposable.RtcService.setCustomBypassLiveLayout ( Collection< RTCBypassPeerVideoConfig >  configCollection,
Callback< Void >  callback 
)

设置自定义的旁路推流的布局

◆ setLayout()

void com.aliyun.roompaas.rtc.exposable.RtcService.setLayout ( List< String >  userIds,
RtcLayoutModel  layoutModel,
Callback< Void >  callback 
)

设置RTC混流布局格式

◆ setLocalViewConfig()

void com.aliyun.roompaas.rtc.exposable.RtcService.setLocalViewConfig ( AliRtcEngine.AliRtcVideoCanvas  videoCanvas,
AliRtcEngine.AliRtcVideoTrack  videoTrack 
)

设置本地视频流渲染参数

Parameters
videoCanvas视频画布
videoTrack视频轨道

◆ setPreviewMirror()

void com.aliyun.roompaas.rtc.exposable.RtcService.setPreviewMirror ( boolean  enable)

是否开启本地预览镜像，默认为是 仅对前置摄像头画面生效

Parameters
enabletrue时打开

◆ setRemoteViewConfig()

void com.aliyun.roompaas.rtc.exposable.RtcService.setRemoteViewConfig ( AliRtcEngine.AliRtcVideoCanvas  videoCanvas,
String  userId,
AliRtcEngine.AliRtcVideoTrack  videoTrack 
)

设置远端视频渲染参数

Parameters
videoCanvas视频画布
userId用户Id
videoTrack视频轨道

◆ setVideoStreamMirror()

void com.aliyun.roompaas.rtc.exposable.RtcService.setVideoStreamMirror ( boolean  enable)

是否开启视频流镜像，默认为否 仅对前置摄像头画面生效

Parameters
enabletrue时打开

◆ startPreview()

void com.aliyun.roompaas.rtc.exposable.RtcService.startPreview ( )

开始预览画面

◆ startRecord()

void com.aliyun.roompaas.rtc.exposable.RtcService.startRecord ( Callback  callback)

RTC录制

◆ startRoadPublish()

void com.aliyun.roompaas.rtc.exposable.RtcService.startRoadPublish ( Callback< Void >  callback)

开始旁路推流

Parameters
callback回调函数

◆ startRtcPreview()

View com.aliyun.roompaas.rtc.exposable.RtcService.startRtcPreview ( )

开始Rtc预览

◆ startScreenShare()

int com.aliyun.roompaas.rtc.exposable.RtcService.startScreenShare ( )

开始屏幕分享

Returns

◆ stopPlayRoad()

void com.aliyun.roompaas.rtc.exposable.RtcService.stopPlayRoad ( )

停止旁路拉流

◆ stopPreview()

void com.aliyun.roompaas.rtc.exposable.RtcService.stopPreview ( )

结束预览画面

◆ stopRecord()

void com.aliyun.roompaas.rtc.exposable.RtcService.stopRecord ( Callback  callback)

结束RTC录制

◆ stopRoadPublish()

void com.aliyun.roompaas.rtc.exposable.RtcService.stopRoadPublish ( Callback< Void >  callback)

停止旁路推流

Parameters
callback

◆ stopScreenShare()

int com.aliyun.roompaas.rtc.exposable.RtcService.stopScreenShare ( )

结束屏幕分享

Returns

◆ subscribeAllRemoteAudioStreams()

int com.aliyun.roompaas.rtc.exposable.RtcService.subscribeAllRemoteAudioStreams ( boolean  sub)

停止或恢复接收所有远端音频流

Parameters
subture
Returns

◆ subscribeAllRemoteVideoStreams()

int com.aliyun.roompaas.rtc.exposable.RtcService.subscribeAllRemoteVideoStreams ( boolean  sub)

停止或恢复接收所有远端视频流

Parameters
sub
Returns

◆ subscribeRemoteAudioStream()

int com.aliyun.roompaas.rtc.exposable.RtcService.subscribeRemoteAudioStream ( String  uid,
boolean  sub 
)

停止或恢复指定远端用户的音频流拉取

Parameters
uid
sub
Returns

◆ subscribeRemoteVideoStream()

int com.aliyun.roompaas.rtc.exposable.RtcService.subscribeRemoteVideoStream ( String  uid,
AliRtcEngine.AliRtcVideoTrack  track,
boolean  sub 
)

停止或恢复特定远端用户的视频流拉取

Parameters
uid
track
sub
Returns

◆ switchCamera()

boolean com.aliyun.roompaas.rtc.exposable.RtcService.switchCamera ( )

切换摄像头

Returns
是够切换成功
The documentation for this interface was generated from the following file: