RtcEngine接口

RtcEngine

本章节介绍了Android SDK的RtcEngine接口详情。

表7.2.4.1-1 接口详情

createVideo

void createVideo(Context mContext, String id, ISDPVideoEngineListener listener)

【功能说明】

创建ISDPRTC引擎实例。

【请求参数】

 mContext    上下文
  id          appId
  listener    ISDPVideoEngineListener
   

【返回参数】

无

onDestroy

void onDestroy();

【功能说明】

销毁ISDPRTC引擎实例。

【请求参数】

无

【返回参数】

无

joinChannel

int joinChannel(String channelId, String token, String info, String userId,
            ChannelMediaOptions mediaOptions, ISDPVideoEngineListener listener);

【功能说明】

加入房间

【请求参数】

 channelId   频道ID
 token       使用accessKey签名token
 info        扩展参数，可为空
 userId       用户ID
 appId       应用ID
 listener    ISDPVideoEngineListener

【返回参数】

RtcEngine对象

leaveChannel

 int leaveChannel();

【功能说明】

离开房间

【请求参数】

无

【返回参数】

int 0表示成功

leaveSubChannel

int leaveChannel();

【功能说明】

离开某个指定房间

【请求参数】

    channelId  频道ID

【返回参数】

无

renewToken

int renewToken(String token);

【功能说明】

更新鉴权签名

【请求参数】

    token 鉴权令牌

【返回参数】

int 0表示成功

createRendererView

 SurfaceView createRendererView(Context context);

【功能说明】

创建渲染视图

【请求参数】

context  上下文环境

【返回参数】

SurfaceView对象

createSubRendererView

SurfaceView createSubRendererView(Context context, String userId);

【功能说明】

创建子渲染视图，只对某个用户的渲染视图

【请求参数】

 context  上下文环境
 userId   用户唯一标识

【返回参数】

SurfaceView对象

setupLocalVideo

   int setupLocalVideo(SurfaceView view, int renderMode, String userId);

【功能说明】

设置本地视频视图，可指定某个用户

【请求参数】

  view surfaceView对象
  userId  用户唯一标识  

【返回参数】

int 0表示成功

setupRemoteVideo

int setupRemoteVideo(SurfaceView view, int renderMode, String channel, String userId);

【功能说明】

设置远端视频视图，可指定某个用户

【请求参数】

 view        SurfaceView对象
     renderMode  渲染模式，可为空
     channel     频道ID
     userId      用户ID

【返回参数】

int 0表示成功

resetResolution

void resetResolution(int width, int height, int framerate);

【功能说明】

设置视频编码属性，每个属性对应一套视频参数，如分辨率、帧率、码率、视频方向等

【请求参数】

Height 高  Width 宽 Framerate 帧率

【返回参数】

int 0表示成功

enableVideo

 int enableVideo();

【功能说明】

本地视频可用(true表示可用，false反之)

【请求参数】

【返回参数】

true表示可用，false反之

enableLocalVideo

 int enableLocalVideo(boolean enabled);

【功能说明】

本地视频可用(true表示可用，false反之)

【请求参数】

enabled true表示可用，false表示不可用

【返回参数】

int 0表示成功

disableVideo

  int disableVideo();

【功能说明】

关闭本地视频

【请求参数】

无

【返回参数】

无

muteRemoteVideoStream

 int muteRemoteVideoStream(String userId, boolean muted);
 

【功能说明】

禁用远程视频流

【请求参数】

  * @param userId  用户ID
  * @param muted   true 表示禁用视频流，false表示开启视频流

【返回参数】

int 0表示成功

muteAllRemoteVideoStreams

int muteAllRemoteVideoStreams(boolean muted);

【功能说明】

禁用房间内所有远程用户视频流

【请求参数】

  * @param muted true表示禁止，false表示取消禁止

【返回参数】

  * @return int 0表示成功

enableAudio

 int enableAudio();

【功能说明】

启用本地音频

【请求参数】

无

【返回参数】

无

enableLocalAudio

 int enableLocalAudio(boolean enabled);

【功能说明】

开启本地音频功能

【请求参数】

     * @param enabled true表示可用，false反之

【返回参数】

int 0表示成功

disableAudio

   int disableAudio();

【功能说明】

本地音频不可用

【请求参数】

无

【返回参数】

int 0表示成功

muteLocalAudioStream

 int muteLocalAudioStream(boolean muted);

【功能说明】

禁止远程所有音频流 ---取消或恢复订阅所有远端用户的音频流

【请求参数】

   * @param muted true 取消订阅音频流，false-（默认）订阅音频流

【返回参数】

int 0表示成功