开放平台

加入频道

  public abstract joinChannel(key: string, channel: string, optionalInfo: string, uid: number): number;

加入频道后，默认情况下用户订阅频道内所有其他用户的音频流和视频流

参数

token 在服务端生成的用于鉴权的动态密钥 channelId 频道名。该参数标识用户进行实时音视频互动的频道 optionalInfo (非必选项) uid 用户 ID。该参数用于标识在实时音视频互动频道中的用户

返回值

0：方法调用成功。 < 0：方法调用失败

离开频道

  public abstract leaveChannel(options?: LeaveChannelOptions): number;

该方法需要在加入频道后调用,调用该方法后，SDK 会终止音视频互动、离开当前频道，并会释放会话相关的所有资源。

参数

options 离开频道的选项

返回值

0: 方法调用成功。 < 0: 方法调用失败

更新 Token

  public abstract renewToken(token: string): number;

该方法用于更新 Token。Token 会在一定时间后失效，此时 SDK 将无法和服务器建立连接

参数

token 新生成的 Token。

返回值

0: 方法调用成功。 < 0: 方法调用失败

启用音频模块

  public abstract enableAudio(): number;

音频模块默认开启。如果你调用 disableAudio 关闭了音频模块，可调用该方法重新开启。

关闭音频模块

  public abstract disableAudio(): number;

音频模块默认开启，你可以调用该方法关闭音频模块。

调节音频采集信号音量

  public abstract adjustRecordingSignalVolume(volume: number): number;

调用时机

加入频道前后均可调用

参数

volume 音量，取值范围为 [0,400]。

返回值

0: 方法调用成功。 < 0: 方法调用失败

开关本地视频采集

  public abstract enableLocalVideo(enabled: boolean): number;

关闭视频模块

  public abstract disableVideo(): number;

启用视频模块

  public abstract enableVideo(): number;

开启视频预览

  public abstract startPreview(sourceType?: Constants.VideoSourceType): number;

该方法用于启动本地视频预览，并指定出现在预览画面中的视频源。

参数

sourceType 视频源的类型，详见 VideoSourceType。

返回值

0：方法调用成功。 < 0：方法调用失败

停止视频预览

  public abstract stopPreview(sourceType?: Constants.VideoSourceType): number;

调用 startPreview 开启预览后，如果你想关闭本地视频预览，请调用该方法

参数

sourceType视频源的类型，详见 VideoSourceType。

返回值

0：方法调用成功。 < 0：方法调用失败

设置视频编码属性

  public abstract setVideoEncoderConfiguration(configuration: VideoEncoderConfiguration): number;

设置本地视频的编码属性。每一种视频编码属性对应一系列视频相关参数设置，包含分辨率、帧率和码率。

参数

config 视频编码参数配置

返回值

0: 方法调用成功。 < 0: 方法调用失败

本地视频首帧回调

  onFirstLocalVideoFrame?:(source:Constants.VideoSourceType,width:number,height:number,elapsed:number) =>void;

参数

source 视频源的类型。详见 VideoSourceType。 width 本地渲染视频的宽 (px) 。 height 本地渲染视频的高 (px)。 elapsed 从调用 joinChannel 或 joinChannelWithOptions 加入频道时到发生此事件过去的时间（毫秒）。如果在加入频道前调用了 startPreview，则该参数表示从调用 startPreview 开启本地视频预览到发生此事件过去的时间。

首帧远端视频回调

  onFirstRemoteVideoFrame?:(uid:number,width:number,height:number,elapsed:number) =>void;

参数

uid 用户 ID，指定是哪个用户的视频流。 width 视频流宽（px）。 height 视频流高（px）。 elapsed 从本地调用 joinChannel 或 joinChannelWithOptions 到发生此事件过去的时间（毫秒）