AliRTCMiniAppEngine接口

目录

基础接口

发布相关接口

订阅相关接口

其他接口

详情

• join：加入频道。

  join(
    authInfo: IAuthInfo,
    onSuccess: (uid: number) => void, 
    onFailure: (err: { code: number; reason: string }) => void
  ): void

  参数说明

  名称	类型	描述
  authInfo	IAuthInfo	鉴权信息。包含信息如下所示： appid：应用ID。 channel：频道号。 gslb：服务器地址。 nonce：令牌随机码。 timestamp：时间戳。 token：令牌。 userid：用户ID。 displayName：用户名称。
  onSuccess	无	方法调用成功时执行的回调函数，返回用户UID。
  onFailure	无	方法调用失败时执行的回调函数，返回错误码和错误信息。

• leave：退出频道。

  leave(
    onSuccess: () => void, 
    onFailure: (err: { code: number; reason: string }) => void
  ): void

  参数说明

  名称	类型	描述
  onSuccess	无	方法调用成功时执行的回调函数。
  onFailure	无	方法调用失败时执行的回调函数，返回错误码和错误信息。

• setChannelProfile：设置频道模式。

  setChannelProfile (
    profile: number,
    onSuccess: () => void,
    onFailure: (err: { code: number; reason: string }) => void
  ): void

  参数说明

  名称	类型	描述
  profile	number	频道模式。取值： 0：普通模式，该模式下所有用户都可以推流和订阅。 1：互动模式，该模式下需要调用setRole设置角色后再入会。
  onSuccess	无	方法调用成功时执行的回调函数。
  onFailure	无	方法调用失败时执行的回调函数，返回错误码和错误信息。

• setRole：设置用户角色。

  setRole(
    role: string, 
    onSuccess: () => void, 
    onFailure: (err: { code: number; reason: string }) => void
  ): void

  参数说明

  名称	类型	描述
  role	string	用户角色，非通信模式下角色类型才有效。取值： broadcaster：主播，可以调用 publish和unpublish方法。 audience（默认值）：观众，不能调用publish和unpublish方法。
  onSuccess	无	方法调用成功时执行的回调函数。
  onFailure	无	方法调用失败时执行的回调函数，返回错误码和错误信息。

• publish：通知发布音视频流。

  publish(
    onSuccess: (url: string) => void, 
    onFailure: (err: { code: number; reason: string }) => void
  ): void

  参数说明

  名称	类型	描述
  onSuccess	无	方法调用成功时执行的回调函数，返回音视频流的推流地址。
  onFailure	无	方法调用失败时执行的回调函数，返回错误码和错误信息。

• unpublish：停止发布音视频流。

  unpublish(
    onSuccess: () => void, 
    onFailure: (err: any) => void
  ): void

  参数说明

  名称	类型	描述
  onSuccess	无	方法调用成功时执行的回调函数。
  onFailure	无	方法调用失败时执行的回调函数。

• subscribe：订阅远端音视频流。

  subscribe(
    uid: number, 
    onSuccess: (url: string) => void, 
    onFailure: (err: any) => void
  ): void

  参数说明

  名称	类型	描述
  uid	number	订阅的远端用户UID。
  onSuccess	无	方法调用成功时执行的回调函数，返回音视频的拉流地址。
  onFailure	无	方法调用失败时执行的回调函数。

• unsubscribe：停止订阅远端音视频流。

  unsubscribe(
    uid: number, 
    onSuccess: () => void, 
    onFailure: (err: any) => void
  ): void

  参数说明

  名称	类型	描述
  uid	number	取消订阅的远端用户UID。
  onSuccess	无	方法调用成功时执行的回调函数。
  onFailure	无	方法调用失败时执行的回调函数。

• muteLocal：停止发送本地音视频流。

  muteLocal(
    target: string, 
    onSuccess: () => void, 
    onFailure: (err: { code: number; reason: string }) => void
  ): void

  参数说明

  名称	类型	描述
  target	string	停止发送的音频流，取值为audio。
  onSuccess	无	方法调用成功时执行的回调函数。
  onFailure	无	方法调用失败时执行的回调函数，返回错误码和错误信息。

• unmuteLocal：恢复发送本地音视频流。

  unmuteLocal(
    target: string, 
    onSuccess: () => void, 
    onFailure: (err: { code: number; reason: string }) => void
  ): void

  参数说明

  名称	类型	描述
  target	string	恢复发送的音视频流，取值为audio。
  onSuccess	无	方法调用成功时执行的回调函数。
  onFailure	无	方法调用失败时执行的回调函数，返回错误码和错误信息。

• on：监听事件。

  详情请参见回调与监听。

• off：取消监听事件。

  off(event: string): void

  参数说明

  名称	类型	描述
  event	string	要取消监听的事件，详情请参见回调与监听。