# 前端小程序SDK接口

# 接口概述

模块	接口名	SDK版本	说明	备注
基础	FxExt.getUserInfo	1.0.0	获取当前用户信息
	FxExt.getStarInfo	1.0.0	获取当前直播间主播信息
	FxExt.isAnchor	1.0.0	判断当前用户是否为主播
	FxExt.onExit	1.0.0	监听小程序退出事件
网络请求	FxExt.fetch	1.0.0	发起 HTTPS 网络请求
礼物	FxExt.sendGift	1.0.1	直播间送礼
礼物	FxExt.getGiftList	1.0.4	获取直播间礼物列表
公聊区消息	FxExt.subscribeChatMessage	1.0.2	订阅直播间公聊区聊天信息	需申请权限，且仅限主播模式
公聊区消息	FxExt.delSubscribeChatMessage	1.0.2	取消订阅直播间公聊区聊天信息	需申请权限，且仅限主播模式
邀请	FxExt.openInvitePanel	1.0.0	打开邀请主播面板	仅限主播模式
	FxExt.subscribeInviteMessage	1.0.0	订阅邀请信息	仅限主播模式
	FxExt.openInviteUsersPanel	1.0.6	打开邀请用户面板	案例请查看：邀请玩家
	FxExt.onInviteUsers	1.0.6	监听邀请用户信息
	FxExt.offInviteUsers	1.0.6	取消监听邀请用户信息
分享	FxExt.shareAppMessage	1.0.6	分享小程序信息
	FxExt.onShareAppMessage	1.0.6	监听分享小程序信息	案例请查看：分享信息
	FxExt.offShareAppMessage	1.0.6	取消监听分享小程序信息
交互	FxExt.openGiftPanel	1.0.0	打开直播间礼物栏
	FxExt.openRankingList	1.0.0	打开游戏榜单
	FxExt.openUserInfoCard	1.0.0	打开用户信息卡片
	FxExt.showModal	1.0.0	显示模态对话框
	FxExt.toggleRunningAppDisplay	1.0.0	显示/隐藏运行中的小程序
导航栏	FxExt.setTitle	1.0.0	设置当前导航栏标题
	FxExt.setTitleBarColor	1.0.0	设置当前导航栏背景色
	FxExt.setStyle	1.0.0	设置导航栏颜色主题
WebSocket	FxExt.connectSocket	1.0.0	创建一个 WebSocket 连接
	FxExt.sendSocketMessage	1.0.0	通过 WebSocket 连接发送数据
	FxExt.closeSocket	1.0.0	关闭 WebSocket 连接
	FxExt.onSocketOpen	1.0.0	监听 WebSocket 连接打开事件
	FxExt.onSocketMessage	1.0.0	监听 WebSocket 接受到服务器的消息事件
	FxExt.onSocketClose	1.0.0	监听 WebSocket 连接关闭事件
	FxExt.onSocketError	1.0.0	监听 WebSocket 错误事件
多人语音连麦	FxExt.micConnectAccredit	1.0.0	语音连麦授权	仅限主播模式
	FxExt.joinVoiceMicConnect	1.0.0	加入语音连麦
	FxExt.exitVoiceMicConnect	1.0.0	退出语音连麦
	FxExt.setVoiceMicMute	1.0.0	语音连麦设置静音
	FxExt.onVoiceMicConnectStatus	1.0.0	监听语音连麦状态
	FxExt.onMicVolumeChange	1.0.0	监听语音连麦用户音量
双人视频连麦	FxExt.startMicLive	1.0.5	进入视频推流	需申请权限，且仅限主播模式
	FxExt.switchToNormalLive	1.0.5	退出视频推流
	FxExt.onMicStatusChange	1.0.5	监听视频连麦状态
	FxExt.offMicStatusChange	1.0.5	取消监听视频连麦状态
白板	FxExt.createWB	1.0.5	创建白板	仅限主播模式案例请查看：白板
	FxExt.deleteWB	1.0.5	删除白板
	FxExt.onExtraWBMessage	1.0.5	监听独立白板消息
	FxExt.sendToExtraWB	1.0.5	发送消息到独立白板
	FxExt.getWBInfo	1.0.5	获取当前白板信息
	FxExt.getStreamInfo	1.0.5	获取推流信息
服务通知	FxExt.checkSubscribeMessageAuth	1.0.6	检查订阅消息授权	案例请查看：服务通知
服务通知	FxExt.requestSubscribeMessage	1.0.6	授权订阅消息
游戏服务	FxExt.reportGameStatus	1.0.5	上报游戏状态
	FxExt.onMatchingResult	1.0.7	监听游戏匹配结果	案例请查看：悬赏、陪玩
	FxExt.offMatchingResult	1.0.7	取消监听游戏匹配结果
	FxExt.openGameResultPanel	1.0.7	打开游戏结果面板

说明：

关于小程序模式介绍，请点击查看小程序模式
特殊权限请进入开发者中心申请

# 基础

# FxExt.getUserInfo()

获取当前用户信息

# 说明

获取当前用户信息时，需用户授权

# 参数

无

# 返回值

参数	类型	说明
promise	Promise	返回Promise

其中resolve的数据为:

参数	类型	说明
res	Object	响应
res.nickName	String	用户昵称
res.userLogo	String	用户Logo
res.userId	String	用户openId

# 示例

FxExt.getUserInfo().then(({ nickName }) => {
  console.log(`当前用户昵称为: ${ nickName }`);
}).catch(err => {
  console.log(`获取用户信息失败，错误信息: ${err.msg}`);
});

# 错误码

错误码	说明
100005	用户未登陆
100008	获取用户信息失败
100009	用户信息授权失败

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.0	支持	4.96.20	4.96.20	-	10.0.5

# FxExt.getStarInfo()

获取当前直播间主播信息

# 参数

无

# 返回值

参数	类型	说明
promise	Promise	返回Promise

其中resolve的数据为:

参数	类型	说明
res	Object	响应
res.nickName	String	主播昵称
res.userLogo	String	主播Logo
res.userId	String	主播openId

# 示例

FxExt.getStarInfo().then(({ nickName }) => {
  console.log(`当前主播昵称为: ${ nickName }`);
}).catch(err => {
  console.log(`获取主播信息失败，错误信息: ${err.msg}`);
});

# 错误码

错误码	说明
100010	获取主播信息失败

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.0	支持	4.96.20	4.96.20	-	10.0.5

# FxExt.isAnchor()

判断当前用户是否为主播

# 参数

无

# 返回值

参数	类型	说明
promise	Promise	返回Promise

其中resolve的数据为:

参数	类型	说明
res	Object	响应
res.isAnchor	Boolean	是否为主播

# 示例

FxExt.isAnchor().then(({ isAnchor }) => {
  console.log(`当前用户为: ${ isAnchor ? '主播' : '观众' }`);
}).catch(err => {
  console.log(`获取当前用户角色失败，错误信息: ${err.msg}`);
});

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.0	支持	4.96.20	4.96.20	-	10.0.5

# FxExt.onExit(Function)

监听小程序退出事件

# 参数

Function function(res)

属性	类型	必需	说明
res.code	Number	是	状态码，成功为0
res.msg	String	是	消息
res.data	Object	是	返回数据，当前data为空对象

# 返回值

无

# 示例

FxExt.onExit(() => {
  console.log('小程序退出了！');
});

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.0	支持	4.96.20	4.96.20	-	10.0.5

# 网络请求

# FxExt.fetch(Object)

发起 HTTPS 网络请求

# 说明

当type为POST时，data必须为Object类型
发起请求前，会校验是否在白名单内，若不在白名单内会返回100012状态码，请前往开发者中心配置

# 参数

Object object

属性	类型	默认值	必填	说明
url	String		是	开发者服务器接口地址
data	String/Object/ArrayBuffer		否	请求的参数
headers	Object		否	设置请求的 header
timeout	Number		否	超时时间，单位为毫秒
type	String	GET	否	HTTP 请求方法
dataType	String	json	否	返回的数据格式
cache	Boolean	true	否	开启 cache

# 返回值

参数	类型	说明
promise	Promise	返回Promise

其中resolve的数据为:

参数	类型	说明
res	String/Object/Arraybuffer	开发者服务器返回的数据

# 示例

FxExt.fetch({
  url: 'https://fanxing.kugou.com/test',
  type: 'GET',
  dataType: 'json',
  cache: false,
  data: {
    x: '1',
  }
}).then(({ code, deta }) => {
  if (code === 0) {
    console.log('请求成功');
  }
}).catch(err => {
  console.log(`请求失败，错误信息: ${err.msg}`);
});

# 错误码

错误码	说明
100006	参数不规范
100011	网络请求异常
100012	域名不在白名单内

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.0	支持	4.96.20	4.96.20	-	10.0.5

# 礼物

# FxExt.sendGift(Object)

直播间送礼

# 说明

当前观众送礼，送给当前直播间主播
需要用户授权使用
单次送礼数量不能超过999个

# 图例

小程序送礼UI图例

# 参数

Object object

属性	类型	默认值	必填	说明
giftId	Number		是	礼物Id
giftCount	Number		是	礼物数量,上限为999

# 返回值

参数	类型	说明
promise	Promise	返回Promise

其中resolve的数据为:

参数	类型	说明
res	Object	响应
res.id	String	送礼记录Id

# 示例

FxExt.sendGift({
  giftId: 1,
  giftCount: 1
}).then(({ id }) => {
  console.log(`送礼记录Id为: ${ id }`);
}).catch(err => {
  console.log(`送礼失败，错误信息: ${err.msg}`);
});

# 错误码

错误码	说明
100001	操作太频繁
100013	用户余额不足
101000	礼物不存在
101001	获取礼物信息失败
101002	送礼数量不规范
101003	送礼失败
101004	取消送礼

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.1	支持	4.99.60	4.99.60	-	-

# FxExt.getGiftList()

获取直播间礼物列表

# 说明

该礼物列表已经过滤掉特殊礼物

# 返回值

参数	类型	说明
promise	Promise	返回Promise

其中resolve的数据为:

参数	类型	说明
res	Object	响应
res.categories	Object[]	礼物种类
res.gifts	Object[]	礼物列表

其中 gifts 中对象的参数为：

字段名	字段类型	描述
classId	long	分类id
className	string	分类名称
sortIndex	int	分类序号
id	long	礼物id
name	string	礼物名称
pic	string	礼物图标
price	long	礼物价格
category	long	礼物种类
sortIndex	int	礼物序号
image	string	礼物图片
type	int	类型
mobileImage	string	手机端礼物图片

# 示例

FxExt.getGiftList().then(({ categories, gifts }) => {
  console.log('礼物种类', categories);
  console.log('礼物列表', gifts);
}).catch(err => {
  console.log(`获取礼物列表失败，错误信息: ${err.msg}`);
});

# 错误码

错误码	说明
100001	操作太频繁
100011	网络请求异常

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.4	支持	5.06.00	5.06.00	-	-

# 公聊区

# FxExt.subscribeChatMessage(Object, Function)

订阅直播间公聊区聊天信息

# 说明

只保留最新的一次监听
只允许PC主播端调用
神秘嘉宾的用户，senderOpenId为空字符串
该API调用需要申请权限：请进入开发者中心申请

# 参数

Object filterOption 过滤条件

属性	类型	必需	说明
content	String	否	聊天内容，模糊匹配
senderNickName	String	否	发送者昵称，完全匹配

Function callback(res) 回调函数

属性	类型	必需	说明
res.code	Number	是	状态码
res.msg	String	是	错误信息
res.data	Object	是	返回数据
res.data.senderOpenId	String	是	发送者openId
res.data.senderNickname	String	是	发送者昵称
res.data.senderLogo	String	是	发送者头像
res.data.content	String	是	聊天信息

# 返回值

无

# 示例

FxExt.subscribeChatMessage({}, ({ content }) => {
  console.log(`聊天为：${ content }`);
});

# 错误码

错误码	说明
100003	该API仅限PC主播端调用
105013	无权限调用该API

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.2	支持	-	-	-	-

# FxExt.delSubscribeChatMessage()

取消订阅直播间公聊区聊天信息

# 返回值

无

# 示例

FxExt.delSubscribeChatMessage();

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.2	支持	-	-	-	-

# 邀请

# FxExt.openInvitePanel()

打开邀请主播面板

# 说明

该API仅限主播模式小程序调用
提供通过主播房间号，搜索平台所有主播进行邀请
提供相互关注主播列表，进行快速邀请
提供主播当前状态，如不在线、才艺PK等，如不符合条件的不能进行邀请
被邀请主播，会在直播界面显示邀请信息弹窗
当被邀请主播点击“愉快接受”按钮后，会自动打开发出邀请的小程序首页
当被邀请主播点击“残忍拒绝”按钮后，邀请者会收到被拒绝信息弹窗

# 参数

无

# 返回值

参数	类型	说明
promise	Promise	返回Promise

其中resolve的数据为空

# 示例

FxExt.openInvitePanel().then(() => {
  console.log('邀请主播面板已打开');
}).catch(err => {
  console.log(`打开邀请主播面板失败，错误信息: ${err.msg}`);
});

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.0	支持	4.97.62	4.97.62	-	-

# FxExt.subscribeInviteMessage(Function)

订阅邀请信息

# 说明

该API仅限主播模式小程序调用
配合FxExt.openInvitePanel使用

# 参数

Function function(res)

属性	类型	必需	说明
res.code	Number	是	状态码
res.msg	String	是	消息
res.data	Object	是	返回数据
res.data.userId	String	是	邀请者openId
res.data.userName	String	是	邀请者昵称

# 返回值

无

# 示例

FxExt.subscribeInviteMessage(({ userName }) => {
  console.log(`邀请用户为：${ userName }`);
});

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.0	支持	-	-	-	-

# FxExt.openInviteUsersPanel(Object)

打开邀请用户面板

# 说明

提供通过主播房间号，搜索平台所有主播进行邀请
提供互关好友、房间观众列表，进行快速邀请
显示用户在线状态，不在线、才艺PK等不符合条件的不能进行邀请
邀请成功后，被邀请者可以在IM中查看邀请信息
被邀请对象为主播时，被邀请主播直播间显示邀请消息弹窗
当被邀请主播点击“愉快接受”按钮后，会自动打开发出邀请的小程序
当被邀请主播点击“残忍拒绝”按钮后，一天内无法再邀请该用户
邀请消息的标题、副标题会进行敏感词校验
邀请消息自定义参数字符长度不能超过100，否则截取

# 参数

Object object

属性	类型	默认值	必填	说明
userType	Array	[1]	是	邀请用户类型, 1: 全部好友（包含主播、观众）2: 好友主播 3: 房间观众
title	String	小程序名称	否	邀请消息标题
subTitle	String	我正在玩《小程序名称》，快来一起加入吧！！	否	邀请消息副标题
paramStr	String		否	邀请消息自定义参数

# 返回值

参数	类型	说明
promise	Promise	返回Promise

其中resolve的数据为空

# 示例

FxExt.openInvitePanel({
  userType: [1, 3],
  title: '大话骰',
  subTitle: '我正在玩《大话骰》，快来一起加入吧～',
  paramStr: 'id=1&name=test'
}).then(() => {
  console.log('邀请用户面板已打开');
}).catch(err => {
  console.log(`打开邀请用户面板失败，错误信息: ${err.msg}`);
});

# 错误码

错误码	说明
100005	用户未登录
100006	标题或副标题包含敏感词

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.6	支持	5.30.00	5.30.00	-	-

# FxExt.onInviteUsers(Function)

监听邀请用户信息

# 说明

配合FxExt.openInviteUsersPanel使用

# 参数

Function function(res)

属性	类型	必需	说明
res.code	Number	是	状态码
res.msg	String	是	消息
res.data	Object	是	返回数据
res.data.userId	String	是	邀请者openId
res.data.userName	String	是	邀请者昵称
res.data.paramStr	String	是	邀请消息自定义参数

# 返回值

无

# 示例

FxExt.onInviteUsers(({ data }) => {
  console.log(`邀请用户为：${ data.userName }`);
});

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.6	支持	5.30.00	5.30.00	-	-

# FxExt.offInviteUsers(Function)

取消监听邀请用户信息

# 参数

Function function(res)

属性	类型	必需	说明
res.code	Number	是	状态码
res.msg	String	是	消息
res.data	Object	是	空对象

# 返回值

无

# 示例

FxExt.offInviteUsers();

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.6	支持	5.30.00	5.30.00	-	-

# 分享

# FxExt.shareAppMessage(Object)

分享小程序信息

# 说明

分享消息的标题、副标题会进行敏感词校验
分享消息自定义参数字符长度不能超过100，否则截取
分享渠道目前支持微信好友、微信朋友圈、QQ、QQ空间

# 参数

Object object

属性	类型	默认值	必填	说明
title	String	小程序名称	否	分享消息标题
subTitle	String	《小程序名称》，这个游戏太好玩了！！	否	分享消息副标题
paramStr	String		否	分享消息自定义参数

# 返回值

参数	类型	说明
promise	Promise	返回Promise

其中resolve的数据为空

# 示例

FxExt.shareAppMessage({
  title: '大话骰',
  subTitle: '《大话骰》这个游戏太好玩了,快来一起加入吧～',
  paramStr: 'id=1&name=test'
}).then(() => {
  console.log('分享成功');
}).catch(err => {
  console.log(`分享失败，错误信息: ${err.msg}`);
});

# 错误码

错误码	说明
100006	标题或副标题包含敏感词
100015	取消分享

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.6	-	5.30.00	5.30.00	-	-

# FxExt.onShareAppMessage(Function)

监听分享小程序信息

# 说明

配合FxExt.shareAppMessage使用

# 参数

Function function(res)

属性	类型	必需	说明
res.code	Number	是	状态码
res.msg	String	是	消息
res.data	Object	是	返回数据
res.data.userId	String	是	分享者openId
res.data.userName	String	是	分享者昵称
res.data.paramStr	String	是	分享消息自定义参数

# 返回值

无

# 示例

FxExt.onInviteUsers(({ data }) => {
  console.log(`分享用户为：${ data.userName }`);
});

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.6	-	5.30.00	5.30.00	-	-

# FxExt.offShareAppMessage(Function)

取消监听分享小程序信息

# 参数

Function function(res)

属性	类型	必需	说明
res.code	Number	是	状态码
res.msg	String	是	消息
res.data	Object	是	空对象

# 返回值

无

# 示例

FxExt.offShareAppMessage();

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.6	-	5.30.00	5.30.00	-	-

# 交互

# FxExt.openGiftPanel(Object)

打开直播间礼物栏

# 说明

当giftId为0时，仅拉起礼物栏，当giftId为某礼物id时，拉起礼物栏后，选择对应礼物

# 参数

Object object

属性	类型	默认值	必填	说明
giftId	Number	0	是	礼物id

# 返回值

参数	类型	说明
promise	Promise	返回Promise

其中resolve的数据为空

# 示例

FxExt.openGiftPanel({
  giftId: 225
}).then(() => {
  console.log('礼物栏已打开');
}).catch(err => {
  console.log(`打开礼物栏失败，错误信息: ${err.msg}`);
});

# 错误码

错误码	说明
101000	匹配不到对应礼物

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.0	支持	4.96.60	4.96.60	-	-

# FxExt.openRankingList(Object)

打开游戏榜单

# 说明

榜单限制最多显示10条数据

# 参数

Object object

属性	类型	默认值	必填	说明
list	Array		是	榜单数据

每项榜单数据格式为:

属性	类型	必填	说明
sort	Number	是	排名
id	String	是	用户openId
value	String	是	排名显示文本，如分数等

# 返回值

参数	类型	说明
promise	Promise	返回Promise

其中resolve的数据为空

# 示例

FxExt.openRankingList({
  list: [
    { sort: 1, id: '11111', value: '14分' },
    { sort: 2, id: '22222', value: '13分' }
  ]
}).then(() => {
  console.log('游戏榜单已打开');
}).catch(err => {
  console.log(`打开游戏榜单失败，错误信息: ${err.msg}`);
});

# 错误码

错误码	说明
100006	参数不规范
300001	超过榜单显示上限

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.0	支持	4.97.62	4.97.62	-	-

# FxExt.openUserInfoCard(Object)

打开用户信息卡片

# 说明

Web端是打开个人档案页
APP端主播：打开主播动态页
APP端观众：打开个人信息卡片

# 参数

Object object

属性	类型	默认值	必填	说明
userId	String		是	用户openId

# 返回值

参数	类型	说明
promise	Promise	返回Promise

其中resolve的数据为空

# 示例

FxExt.openUserInfoCard({
  userId: '11111'
}).then(() => {
  console.log('用户信息卡片已打开');
}).catch(err => {
  console.log(`打开用户信息卡片失败，错误信息: ${err.msg}`);
});

# 错误码

错误码	说明
300005	用户不存在

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.0	支持	4.97.62	4.97.62	-	-

# FxExt.showModal(Object)

显示模态对话框

# 说明

模态对话框显示内容会经过平台鉴定，若不符合规范，则不显示模态框

# 参数

Object object

属性	类型	默认值	必填	说明
content	String		是	提示的内容

# 返回值

参数	类型	说明
promise	Promise	返回Promise

其中resolve的数据为空

# 示例

FxExt.showModal({
  content: '这是要显示的内容'
}).then(() => {
  console.log('模态对话框已显示');
}).catch(err => {
  console.log(`模态对话框未显示，错误信息: ${err.msg}`);
});

# 错误码

错误码	说明
100006	参数不规范

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.0	支持	4.97.62	4.97.62	-	-

# FxExt.toggleRunningAppDisplay(Object)

显示/隐藏运行中的小程序

# 参数

Object object

属性	类型	默认值	必填	说明
action	String	show	是	显/隐切换, 'show'/'hide'

# 返回值

参数	类型	说明
promise	Promise	返回Promise

其中resolve的数据为空

# 示例

FxExt.toggleRunningAppDisplay({
  action: 'hide'
}).then(() => {
  console.log('小程序显示/隐藏设置成功');
}).catch(err => {
  console.log(`小程序显示/隐藏设置失败，错误原因: ${err.msg}`);
});

# 错误码

错误码	说明
100006	参数不规范

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.0	支持	4.97.62	4.97.62	-	-

# 导航栏

# FxExt.setTitle(Object)

动态设置当前导航栏标题

# 参数

Object object

属性	类型	默认值	必填	说明
title	String	' '	是	导航栏标题

# 返回值

参数	类型	说明
promise	Promise	返回Promise

其中resolve的数据为空

# 示例

FxExt.setTitle({
  title: '这是导航栏标题内容'
}).then(() => {
  console.log('导航栏标题设置成功');
}).catch(err => {
  console.log(`导航栏标题设置失败，错误信息: ${err.msg}`);
});

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.0	支持	4.96.20	4.96.20	-	10.0.5

# FxExt.setTitleBarColor(Object)

设置当前导航栏背景色

# 参数

Object object

属性	类型	默认值	必填	说明
color	String		是	导航栏背景

# 返回值

参数	类型	说明
promise	Promise	返回Promise

其中resolve的数据为空

# 示例

FxExt.setTitleBarColor({
  color: '#3E2597'
}).then(() => {
  console.log('导航栏背景色设置成功');
}).catch(err => {
  console.log(`导航栏背景色设置失败，错误信息: ${err.msg}`);
});

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.0	支持	4.96.20	4.96.20	-	10.0.5

# FxExt.setStyle(Object)

设置导航栏文案颜色、按钮颜色主题

# 参数

Object object

属性	类型	默认值	必填	说明
type	String	white	是	主题类型，目前仅支持'black'/'white'

# 返回值

参数	类型	说明
promise	Promise	返回Promise

其中resolve的数据为空

# 示例

FxExt.setStyle({
  type: 'white'
}).then(() => {
  console.log('导航栏设置主题成功');
}).catch(err => {
  console.log(`导航栏设置主题失败，错误信息: ${err.msg}`);
});

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.0	支持	4.96.20	4.96.20	-	10.0.5

# WebSocket

# FxExt.connectSocket(Object)

创建一个 WebSocket 连接

# 说明

目前只会维持一个socket连接，若有已连接则会先关闭，再连接
目前暂不支持binaryType为arraybuffer类型的数据传输
创建连接前，会校验连接地址是否在白名单内，若不在白名单内则返回100012状态码，请前往开发者中心配置

# 参数

Object object

属性	类型	默认值	必填	说明
url	string		是	开发者服务器wss/ws接口地址
binaryType	string		否	传输二进制数据的类型
timeout	number	0	否	连接超时时间。当timeout大于0时，在指定超时时间时，触发onSocketError事件，并关闭当前连接中socket

# 返回值

参数	类型	说明
promise	Promise	返回Promise

其中resolve的数据为:

参数	类型	说明
res	Object	响应
res.socketId	Number	当前socket连接Id，长度为13位的随机数

# 示例

FxExt.connectSocket({ url: 'wss://fanxing.kugou.com/websocket' })
  .then(data => {
    const { socketId } = data;
    console.log(`初始化Websocket成功，当前socketId为：${ socketId }`);
  }).catch(err => {
    const { code, msg } = err;
    console.log(`初始化Websocket失败，错误码为：`${ code }，`错误信息为：${ msg }`);
  });

# 错误码

错误码	说明
100012	域名不在白名单内
104002	WebSocket连接地址为空，即参数`url`为空

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.0	支持	4.97.62	4.97.62	-	-

# FxExt.sendSocketMessage(Object)

通过 WebSocket 连接发送数据

# 说明

会校验当前发送数据类型，若不支持，会返回104004状态码

# 参数

Object object

属性	类型	默认值	必填	说明
data	string		是	需要发送的内容

# 返回值

参数	类型	说明
promise	Promise	返回Promise

其中resolve的数据为空

# 示例

FxExt.connectSocket({ url: 'wss://fanxing.kugou.com/websocket' });
FxExt.onSocketOpen(({ code }) => {
  if (code === 0) {
    const msg = '酷狗小程序';
    FxExt.sendSocketMessage({ data: msg }).then(() => {
      console.log('数据发送成功');
    }).catch(err => {
      console.log(`数据发送失败，错误信息: ${err.msg}`);
    });
  }
});

# 错误码

错误码	说明
104001	当未创建socket连接时发送数据
104003	发送数据失败，如socket断开连接等原因导致
104004	socket发送数据类型不支持

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.0	支持	4.97.62	4.97.62	-	-

# FxExt.closeSocket(Object)

关闭 WebSocket 连接

# 参数

Object object

属性	类型	默认值	必填	说明
code	Number	4000	否	关闭代码
reason	String	' '	否	关闭原因

# 返回值

参数	类型	说明
promise	Promise	返回Promise

其中resolve的数据为:

参数	类型	说明
res	Object	响应
res.socketId	Number	当前socket连接Id，长度为13位的随机数

# 示例

FxExt.closeSocket({
  code: 4000,
  reason: '手动关闭'
}).then(() => {
  console.log('已调用WebSocket关闭');
}).catch(err => {
  console.log(`调用WebSocket关闭失败，错误信息: ${err.msg}`);
});

FxExt.onSocketClose(() => {
  console.log('WebSocket 已关闭！');
});

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.0	支持	4.97.62	4.97.62	-	-

# FxExt.onSocketOpen(Function)

监听 WebSocket 连接打开事件

# 参数

Function function(res)

属性	类型	必需	说明
res.code	Number	是	状态码
res.msg	String	是	消息
res.data	Object	是	返回数据
res.data.socketId	Number	是	当前socket连接Id，长度为13位的随机数

# 返回值

无

# 示例

FxExt.connectSocket({ url: 'wss://fanxing.kugou.com/websocket' });
FxExt.onSocketOpen(({ code }) => {
  if (code === 0) {
    const msg = '酷狗小程序';
    FxExt.sendSocketMessage({ data: msg });
  }
});

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.0	支持	4.97.62	4.97.62	-	-

# FxExt.onSocketMessage(Function)

监听 WebSocket 接受到服务器的消息事件

# 参数

Function function(res)

属性	类型	必需	说明
res.code	Number	是	状态码
res.msg	String	是	消息
res.data	Object	是	返回数据
res.data.socketId	Number	是	当前socket连接Id，长度为13位的随机数
res.data.data	String/ArrayBuffer	是	服务器返回数据

# 返回值

无

# 示例

FxExt.connectSocket({ url: 'wss://fanxing.kugou.com/websocket' });
FxExt.onSocketOpen(({ code }) => {
  if (code === 0) {
    const msg = '酷狗小程序';
    FxExt.sendSocketMessage({ data: msg });
  }
});

FxExt.onSocketMessage(({ data }) => {
  console.log('服务端返回数据：', data.data);
});

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.0	支持	4.97.62	4.97.62	-	-

# FxExt.onSocketClose(Function)

监听 WebSocket 连接关闭事件

# 参数

Function function(res)

属性	类型	必需	说明
res.code	Number	是	状态码
res.msg	String	是	消息
res.data	Object	是	返回数据
res.data.socketId	Number	是	当前socket连接Id，长度为13位的随机数

# 返回值

无

# 示例

FxExt.closeSocket({ code: 4000, reason: '手动关闭' });

FxExt.onSocketClose(() => {
  console.log('WebSocket 已关闭！');
});

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.0	支持	4.97.62	4.97.62	-	-

# FxExt.onSocketError(Function)

监听 WebSocket 错误事件

# 参数

Function function(res)

属性	类型	必填	说明
res.code	Number	是	状态码
res.msg	String	是	消息
res.data	Object	是	返回数据
res.data.socketId	Number	是	当前socket连接Id，长度为13位的随机数

# 返回值

无

# 示例

FxExt.onSocketError(() => {
  console.log('WebSocket 连接出错！');
});

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.0	支持	4.97.62	4.97.62	-	-

# 多人语音连麦

# FxExt.micConnectAccredit(Object)

语音连麦授权

# 说明

该API仅限主播模式小程序调用

# 参数

Object object

属性	类型	默认值	必填	说明
userId	String		是	授权用户openId

# 返回值

参数	类型	说明
promise	Promise	返回Promise

其中resolve的数据为空

# 示例

FxExt.micConnectAccredit({
  userId: '11111'
}).then(() => {
  console.log('连麦授权成功');
}).catch(err => {
  console.log(`连麦授权失败，错误信息: ${err.msg}`);
});

# 错误码

错误码	说明
100007	实名认证失败
105010	连麦授权失败

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.0	支持	4.97.62	4.97.62	-	-

# FxExt.joinVoiceMicConnect(Object)

加入语音连麦

# 说明

该API仅限主播模式小程序调用
加入语音连麦，主播端必须先开播
加入语音连麦，观众端需要进行先进行连麦授权，连麦授权流程会判断当前观众是否实名认证，若未实名认证，则先进行实名认证
目前WEB端，仅支持主播加入语音连麦

# 参数

Object object

属性	类型	默认值	必填	说明
channelId	String		是	语音频道id

# 返回值

参数	类型	说明
promise	Promise	返回Promise

其中resolve的数据为空

# 示例

FxExt.joinVoiceMicConnect({
  channelId: '11111'
}).then(() => {
  console.log('加入语音连麦成功');
}).catch(err => {
  console.log(`加入语言连麦失败，错误信息: ${err.msg}`);
});

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.0	支持	4.97.62	4.97.62	-	-

# FxExt.exitVoiceMicConnect()

退出语音连麦

# 说明

该API仅限主播模式小程序调用

# 参数

无

# 返回值

参数	类型	说明
promise	Promise	返回Promise

其中resolve的数据为空

# 示例

FxExt.exitVoiceMicConnect().then(() => {
  console.log('退出语音连麦成功');
}).catch(err => {
  console.log(`退出语言连麦失败，错误信息: ${err.msg}`);
});

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.0	支持	4.97.62	4.97.62	-	-

# FxExt.setVoiceMicMute(Object)

语音连麦设置静音

# 说明

该API仅限主播模式小程序调用
加入语音连麦后，默认是非静音，即可进行语音对话

# 参数

Object object

属性	类型	默认值	必填	说明
enable	Boolean		是	是否静音，true: 静音 false: 取消静音

# 返回值

参数	类型	说明
promise	Promise	返回Promise

其中resolve的数据为空

# 示例

FxExt.setVoiceMicMute({
  enable: true
}).then(() => {
  console.log('设置静音成功');
}).catch(err => {
  console.log(`设置静音失败，错误信息: ${err.msg}`);
});

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.0	支持	4.97.62	4.97.62	-	-

# FxExt.onVoiceMicConnectStatus(Function)

监听语音连麦状态

# 说明

该API仅限主播模式小程序调用

# 参数

Function function(res)

属性	类型	必需	说明
res.code	Number	是	状态码
res.msg	String	是	消息
res.data	Object	是	返回数据
res.data.type	String	是	连麦状态类型
res.data.statusCode	Number	是	连麦状态码

res.data.type 类型：

属性	说明
connecting	语音连麦初始化中
connected	语音连麦初始化成功，建立语音连麦
disconnect	语音连麦断开

res.data.statusCode 说明：

type	statusCode	说明
connecting	0
connected	0
disconnect	0	正常退出连麦
disconnect	105001	连麦功能被占用
disconnect	105002	连麦SDK初始化失败
disconnect	105003	连麦获取AccessToken失败
disconnect	105004	连麦加入频道失败
disconnect	105005	连麦推流失败
disconnect	105006	连麦socket连接失败
disconnect	105007	连麦登录失败
disconnect	105008	连麦网络异常
disconnect	105009	连麦设备权限异常
disconnect	105012	连麦时，接听电话
disconnect	105013	无权限调用该API

# 返回值

无

# 示例

FxExt.onVoiceMicConnectStatus(({ type, statusCode }) => {
  if (type === 'connected' && statusCode === 0) {
    console.log('连麦成功了！！')
  }
});

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.0	支持	4.97.62	4.97.62	-	-

# FxExt.onMicVolumeChange(Function)

监听语音连麦用户音量

# 说明

该API仅限主播模式小程序调用
当连麦成功后，才会返回语音用户的音量列表，包含同频道内所有用户的音量信息
间隔1秒钟更新一次
当前用户退出连麦后，将不再返回音量信息

# 参数

Function function(res)

属性	类型	必填	说明
res.code	Number	是	状态码
res.msg	String	是	消息
res.data	Object	是	返回数据
res.data.list	Array	是	连麦音量列表

res.data.list 说明：

属性	类型	说明
u	String	用户openId
v	Number	用户讲话音量值，0-100

# 返回值

无

# 示例

FxExt.onMicVolumeChange(({ list }) => {
  console.log('当前连麦频道用户音量列表: ', list);
});

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.0	支持	4.97.62	4.97.62	-	-

# 上报

# FxExt.reportGameStatus(Object)

上报游戏状态

# 说明

用户已登录状态才能调用
小程序已上线才能调用

# 参数

Object object

属性	类型	默认值	必填	说明
gameId	String		是	游戏唯一id
type	Number		是	游戏状态; 0: 创建游戏，1: 开始游戏，2: 结束游戏，3: 加入游戏，4: 退出游戏

# 返回值

参数	类型	说明
promise	Promise	返回Promise

其中resolve的数据为:

参数	类型	说明
res.code	Number	状态码
res.msg	String	消息
res.data	Object	返回数据

# 示例

FxExt.reportGameStatus({
  gameId: '1620701329383',
  type: 0,
}).then(() => {
  console.log('上报成功');
}).catch(err => {
  console.log(`上报失败，错误信息: ${err.msg}`);
});

# 错误码

错误码	说明
100003	不支持此API
100005	用户未登录
120000	参数错误
120001	操作类型错误
130000	操作失败，请重试
130100	当前用户非房主
130101	房间不存在
130102	房间已存在
130103	玩家已存在

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.5	支持	5.12.01	5.12.01	-	10.5.99

# 双人视频连麦

# FxExt.startMicLive(Object)

加入双人视频连麦

# 说明

该API仅限主播模式小程序调用
加入视频连麦，主播端必须先开播
加入双方的channelId，必需保持一致
目前只支持WEB端主播加入视频连麦
该API调用需要申请权限：请进入开发者中心申请

# 参数

Object object

属性	类型	默认值	必填	说明
channelId	String		是	连麦频道房Id，从API获取

# 返回值

参数	类型	说明
promise	Promise	返回Promise

其中resolve的数据为空

# 示例

FxExt.startMicLive({
  channelId: '11111'
}).then(() => {
  console.log('加入视频连麦成功');
}).catch(err => {
  console.log(`加入视频连麦失败，错误信息: ${err.msg}`);
});

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.5	支持	-	-	-	-

# FxExt.switchToNormalLive()

退出双人视频连麦

# 说明

该API仅限主播模式小程序调用
该API需要获取FxExt.startMicLive的权限才可以使用

# 参数

无

# 返回值

参数	类型	说明
promise	Promise	返回Promise

其中resolve的数据为空

# 示例

FxExt.switchToNormalLive().then(() => {
  console.log('退出视频连麦成功');
}).catch(err => {
  console.log(`退出视频连麦失败，错误信息: ${err.msg}`);
});

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.5	支持	-	-	-	-

# FxExt.onMicStatusChange(Object)

监听视频连麦状态

# 说明

该API仅限主播模式小程序调用
该API需要获取FxExt.startMicLive的权限才可以使用

# 参数

Object object

属性	类型	默认值	必填	说明
callback	Function		是	连麦状态回调函数

# 返回值

参数	类型	说明
promise	Promise	返回Promise

其中resolve的数据为空

# 示例

FxExt.onMicStatusChange({
  callback: (info) => {
    const {code, data} = info;
    const {status, data: connectInfo} = data;
    const {type, statusCode} = connectInfo;
    // statusCode的值请参考错误码
  };
});

# 错误码

回调方法中statusCode的值请参考错误码说明

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.5	支持	-	-	-	-

# FxExt.offMicStatusChange()

取消监听视频连麦状态

# 说明

该API仅限主播模式小程序调用
该API需要获取FxExt.startMicLive的权限才可以使用

# 返回值

参数	类型	说明
promise	Promise	返回Promise

其中resolve的数据为空

# 示例

FxExt.offMicStatusChange();

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.5	支持	-	-	-	-

# 白板

# FxExt.createWB(Object)

创建小程序白板

# 说明

该API仅限主播模式小程序调用
该API需要酷狗直播伴侣主播端才可以使用
重复创建白板会覆盖前面创建的白板

# 参数

Object object

属性	类型	默认值	必填	说明
type	String	"NORMAL"	是	创建白板类型,"NORMAL" 普通白板,"EXTRA" 独立白板
x	Number		是	白板左侧偏移量（单位是像素）
y	Number		是	白板顶部偏移量（单位是像素）
width	Number		是	白板区域宽度（单位是像素）
height	Number		是	白板高度（单位是像素）
scale	Number		否	白板在视频预览区的缩放比例，默认1
param	Object		否	独立白板初始化参数（独立白板专用）
resize	Boolean		否	是否允许改变大小，默认true
offsetX	Number		否	相对推流出去的界面左侧的偏移量（单位是像素）
offsetY	Number		否	相对推流出去的界面顶部的偏移量（单位是像素）

# 返回值

参数	类型	说明
wbId	String	白板id

# 示例

FxExt.createWB({
  type: 'NORMAL',
  x: 0,
  y: 0,
  width: 100,
  height: 100
}).then(({ wbId }) => console.log(`白板id: ${wbId}`));

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.5	支持	-	-	-	-

# FxExt.deleteWB(Object)

删除小程序白板

# 说明

该API仅限主播模式小程序调用
该API需要酷狗直播伴侣主播端才可以使用

# 参数

Object object

属性	类型	默认值	必填	说明
wbId	String		是	白板ID

# 返回值

无

# 示例

FxExt.deleteWB({
  wbId: 'xxxxx'
}).then(() => console.log('白板删除成功'));

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.5	支持	-	-	-	-

# FxExt.onExtraWBMessage(Function)

监听小程序独立白板消息

# 说明

该API仅限主播模式小程序调用
该API需要酷狗直播伴侣主播端才可以使用

# 参数

Function callback 消息回调函数

# 返回值

无

# 示例

FxExt.onExtraWBMessage(data => console.log(`小程序发来的消息${data}`));

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.5	支持	-	-	-	-

# FxExt.sendToExtraWB(Object)

要发送的数据

# 说明

该API仅限主播模式小程序调用
该API需要酷狗直播伴侣主播端才可以使用
该API只能在小程序主窗口调用

# 参数

Object object

属性	类型	默认值	必填	说明
wbId	String		是	白板ID
data	Any		是	白板ID

# 返回值

无

# 示例

FxExt.sendToExtraWB({
  wbId: 'xxxx',
  data: '发送的数据'
});

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.5	支持	-	-	-	-

# FxExt.getWBInfo()

获取当前白板信息

# 说明

该API仅限主播模式小程序调用
该API需要酷狗直播伴侣主播端才可以使用

# 参数

无

# 返回值

参数	类型	说明
wbId	String	白板id
param	Any	初始化参数

# 示例

FxExt.getWBInfo(({ param, wbId }) => console.log(`独立白板创建的初始化参数:${param}, 白板id:${wbId}`));

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.5	支持	-	-	-	-

# FxExt.getStreamInfo()

获取推流信息

# 说明

该API仅限主播模式小程序调用
该API需要酷狗直播伴侣主播端才可以使用

# 参数

无

# 返回值

参数	类型	说明
width	Number	宽度
height	Number	高度
roomType	String	房间开播类型normal: 横屏、vertical: 竖屏
isLive	Boolean	是否开播

# 示例

FxExt.getStreamInfo().then(({ width, height, roomType, isLive }) => console.log('获取推流信息成功'));

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.5	支持	-	-	-	-

# 服务通知

# FxExt.checkSubscribeMessageAuth()

检查订阅消息授权

# 参数

无

# 返回值

参数	类型	说明
promise	Promise	返回Promise

其中resolve的数据为:

参数	类型	说明
res	Object	响应
res.isAuth	Boolean	是否授权
res.expireTime	Number	授权过期时间

# 示例

FxExt.checkSubscribeMessageAuth().then(({ isAuth, expireTime }) => {
  console.log(`是否已授权: ${ isAuth }, 授权过期时间: ${ expireTime }`);
}).catch(err => {
  console.log(`检查失败，失败原因: ${ err.msg }`);
});

# 错误码

错误码	说明
100005	用户未登录
100011	检查授权请求异常

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.6	支持	5.30.00	5.30.00	-	-

# FxExt.requestSubscribeMessage()

授权订阅消息

# 参数

无

# 返回值

参数	类型	说明
promise	Promise	返回Promise

其中resolve的数据为空

# 示例

FxExt.requestSubscribeMessage().then() => {
  console.log('授权成功');
}).catch(err => {
  console.log(`授权失败，失败原因: ${err.msg}`);
});

# 错误码

错误码	说明
100005	用户未登录
100011	检查授权请求异常
100015	已取消授权
100016	授权失败

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.6	支持	5.30.00	5.30.00	-	-

# 游戏服务

# FxExt.onMatchingResult(Function)

监听游戏匹配结果

# 说明

该API仅限用户模式小程序调用

# 参数

Function function(res)

属性	类型	必需	说明
res.code	Number	是	状态码
res.msg	String	是	消息
res.data	Object	是	返回数据
res.data.gameId	String	是	游戏Id
res.data.playerList	Array	是	玩家列表
res.data.readyTimeout	Number	是	玩家准备超时时间（时间戳）
res.data.gameTimeout	Number	是	游戏超时时间（时间戳）

playerList 说明：

属性	类型	说明
userId	String	玩家userId
userName	String	玩家名称
userLogo	String	玩家logo

readyTimeout 说明：从匹配成功开始计时，到进入游戏后，玩家上报准备状态的超时时间。

gameTimeout 说明：从匹配成功开始计时，到进入游戏后，正常进行游戏，最后上报游戏结果的超时时间。

# 返回值

无

# 示例

FxExt.onMatchingResult(({ data }) => {
  console.log(`当局游戏Id为：${ data.gameId }`);
});

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.7	支持	5.42.00	5.42.00	-	-

# FxExt.offMatchingResult(Function)

取消监听游戏匹配结果

# 说明

该API仅限用户模式小程序调用

# 参数

Function function(res)

属性	类型	必需	说明
res.code	Number	是	状态码
res.msg	String	是	消息
res.data	Object	是	空对象

# 返回值

无

# 示例

FxExt.offMatchingResult();

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.7	支持	5.42.00	5.42.00	-	-

# FxExt.openGameResultPanel(Object)

打开游戏结果面板

# 说明

该API仅限用户模式小程序调用
用户已登录状态才能调用

# 图例

# 参数

Object object

属性	类型	默认值	必填	说明
gameId	String		是	游戏Id
winner	String		是	赢家userId

# 返回值

参数	类型	说明
promise	Promise	返回Promise

其中resolve的数据为:

参数	类型	说明
res.code	Number	状态码
res.msg	String	消息
res.data	Object	返回数据

# 示例

FxExt.openGameResultPanel({
  gameId: '1620701329383745172',
  winner: 'Bw453FdzVSsZtZFvj7irzg=='
}).then(() => {
  console.log('已打开游戏结果面板');
});

# 错误码

错误码	说明
100003	不支持此API
100005	用户未登录
100006	参数错误

# 兼容性

SDK版本	WEB	酷狗直播APP[IOS]	酷狗直播APP[Android]	酷狗音乐APP[IOS]	酷狗音乐APP[Android]
1.0.7	支持	5.42.00	5.42.00	-	-

# 错误码说明

状态码	说明
100000	没有注册api
100001	HTTP请求太频繁
100002	无网络
100003	不支持此API
100004	缺失关键参数
100005	用户未登陆
100006	参数不规范
100007	实名认证失败
100008	获取用户信息失败
100009	用户信息授权失败
100010	获取主播信息失败
100011	网络请求异常
100012	域名不在白名单内
100013	用户余额不足
100014	未实名认证
100015	操作已取消
100016	授权失败
100404	网络请网络请求状态: 404
100502	网络请求状态: 502
101000	匹配不到对应礼物
101001	获取礼物信息失败
101002	送礼数量不规范
101003	送礼失败
101004	取消送礼
104001	没有建立socket连接
104002	socket连接缺失url
104003	socket连接非法url
104004	socket发送数据类型不支持
105001	连麦功能被占用
105002	连麦SDK初始化失败
105003	连麦获取AccessToken失败
105004	连麦加入频道失败
105005	连麦推流失败
105006	连麦socket连接失败
105007	连麦登录失败
105008	连麦网络异常
105009	连麦设备权限异常
105010	连麦授权失败
105011	连麦获取音量列表失败
105012	连麦时，接听电话
105013	无权限调用该API
105014	无权限使用连麦
105015	已经在连麦中
105016	伴侣连接失败
105017	请使用startMicLive连麦
105018	获取连麦推流接口失败
105019	游戏直播禁止连麦
105020	当前连麦禁止在竖屏使用
105021	伴侣版本过低,请升级伴侣
105022	未开播，不能连麦

← 接口列表版本更新说明 →