API 说明

最近更新时间:2024-08-23 15:29:37

我的收藏
SDK 接口除初始化接口,其余接口均由 HTTP 实现,请求格式为:
http:://${XNet.proxyOf}${func}?${param}
注意
在初始化返回值为 false 或 XNet.proxyOf 时,意味着没有成功使用 P2P 播放视频,不应再向其发起 HTTP 请求,否则会遇到502等错误,也可作为没有成功使用 P2P 播放器的标志。

统计

接口描述

描述:请求对应频道的统计数据
方法:GET
路径:/stat?xresid=${resource}

请求参数

参数名称
必选
类型
说明
xresid
string
默认为 URL 中的 resource,否则为频道请求中的 xresid 值


返回参数

返回码
说明
查询成功
404
查询失败,频道不存在
其中,返回码 200 返回的 JSON 内容,格式详细说明如下:
参数名称
类型
说明
flow.p2pBytes
num
对应频道 P2P 流量
flow.cdnBytes
num
对应频道 CDN 流量

示例

请求示例
http://127.0.0.1:16080/live.p2p.com/stat?xresid=${yourURL}
说明
xresid 默认为 http://127.0.0.1:16080/live.p2p.com/streamId.flv 中的 streamId,或用户在播放时主动指定直播流资源唯一的 ID。
返回示例
"{"flow":{"p2pBytes":0,"cdnBytes":0}}"

设置上下行

接口描述

描述:请求设置 P2P 上行与下行,0为关闭,1为开启
方法:GET
路径:/feature?download=${0or1}&upload=${0or1}

请求参数

参数名称
必选
类型
说明
download
num
0为关闭,1为开启(默认值)
upload
num
0为关闭,1为开启(默认值)

返回参数

返回的 JSON 内容,格式说明如下:
参数名称
必选
类型
说明
ret
num
0为正常
msg
string
相关信息,调试使用
upload
bool
1为开启,0为关闭
download
bool
1为开启,0为关闭

示例

请求样例:
http://127.0.0.1:16080/live.p2p.com/feature?download=1&upload=0
说明
一般情况下移动网络需要关闭上传。
返回样例:
"{"ret":0, "msg":"ok", "download":0,"upload":0}}"