通过阅读本文,您可以了解到小程序SDK的AliRTCMiniAppEngine接口详情。

目录

基础接口

API 描述 支持的最低版本
join 加入频道。 2.5.2
leave 退出频道。 2.5.2
setChannelProfile 设置频道模式。 2.5.2
setRole 设置用户角色。 2.5.2

发布相关接口

API 描述 支持的最低版本
publish 通知发布音视频流。 2.5.2
unpublish 停止发布音视频流。 2.5.2

订阅相关接口

API 描述 支持的最低版本
subscribe 订阅远端音视频流。 2.5.2
unsubscribe 停止订阅远端音视频流。 2.5.2

其他接口

API 描述 支持的最低版本
muteLocal 停止发送本地音视频流。 2.5.2
unmuteLocal 恢复发送本地音视频流。 2.5.2
on 监听事件。 2.5.2
off 取消监听事件。 2.5.2

详情

  • 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 用户角色。取值:
    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 要取消监听的事件,详情请参见回调与监听