Live/AndroidSDK
(→常用类及名词解释) |
|||
第59行: | 第59行: | ||
== 接口参数 == | == 接口参数 == | ||
+ | |||
+ | '''创建直播类''' | ||
+ | |||
+ | {| border="1" cellspacing="0" cellpadding="0" width="100%" class="parameters" style="border-color:#CCCCCC;" | ||
+ | |- | ||
+ | !width="20%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|接口名称 | ||
+ | !width="10%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|参数类型 | ||
+ | !width="58%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|说明 | ||
+ | !width="12%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|是否调用 | ||
+ | {{api_args|void setAc|Activity|传递当前所属Activity|必需}} | ||
+ | {{api_args|void setTitle|String|设置直播标题|必需}} | ||
+ | {{api_args|void setWidth|String|设置直播宽度|必需}} | ||
+ | {{api_args|void setHeight|String|设置直播高度|必需}} | ||
+ | {{api_args|void setSummary|String|设置微博文本内容,少于130汉字|非必需}} | ||
+ | {{api_args|void setPublished|String|微博是否发布,0:公开发布,1:仅自己可见,默认为0|非必需}} | ||
+ | {{api_args|void setImage|String|封面图地址,注意封面图的宽高和直播的宽高比例要一致,建议分辨率不要太高|非必需}} | ||
+ | {{api_args|void setReplay|String|是否录制,0:不录制,1:录制,默认为1|非必需}} | ||
+ | {{api_args|void setPanoLive|String|是否全景直播,0:不是,1:是,默认为0|非必需}} | ||
+ | {{api_args|void createLive|RequestListener|创建直播,并提供回调。onComplete表示接口成功返回,s为返回值;onWeiboException表示接口请求失败|必需}} | ||
+ | |} | ||
+ | |||
+ | '''更新直播类''' | ||
+ | |||
+ | {| border="1" cellspacing="0" cellpadding="0" width="100%" class="parameters" style="border-color:#CCCCCC;" | ||
+ | |- | ||
+ | !width="20%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|接口名称 | ||
+ | !width="10%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|参数类型 | ||
+ | !width="58%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|说明 | ||
+ | !width="12%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|是否调用 | ||
+ | {{api_args|void setId|String|设置要更新的直播id|必需}} | ||
+ | {{api_args|void setTitle|String|设置直播对象描述|非必需}} | ||
+ | {{api_args|void setSummary|String|设置微博文本内容,少于130汉字|非必需}} | ||
+ | {{api_args|void setPublished|String|设置是否重发微博,0:公开发布,1:仅自己可见,2:不发布,默认为2|非必需}} | ||
+ | {{api_args|void setImage|String|封面图地址,注意封面图的宽高和直播的宽高比例要一致,建议分辨率不要太高|非必需}} | ||
+ | {{api_args|void setStop|String|设置直播状态,0:直播中,1:直播结束,默认0|非必需}} | ||
+ | {{api_args|void setReplayUrl|String|设置直播回放地址|非必需}} | ||
+ | {{api_args|void updateLive|RequestListener|更新直播,并提供回调。onComplete表示接口成功返回,s为返回值;onWeiboException表示接口请求失败|必需}} | ||
+ | |} | ||
+ | |||
+ | '''获取直播信息类''' | ||
+ | |||
+ | {| border="1" cellspacing="0" cellpadding="0" width="100%" class="parameters" style="border-color:#CCCCCC;" | ||
+ | |- | ||
+ | !width="20%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|接口名称 | ||
+ | !width="10%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|参数类型 | ||
+ | !width="58%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|说明 | ||
+ | !width="12%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|是否调用 | ||
+ | {{api_args|void setId|String|设置直播id|必需}} | ||
+ | {{api_args|void setDetail|String|设置是否返回直播详情,0返回,1不返回,默认0|非必需}} | ||
+ | {{api_args|void getInfoLive|RequestListener|获取直播信息,并提供回调。onComplete表示接口成功返回,s为返回值;onWeiboException表示接口请求失败|必需}} | ||
+ | |} | ||
+ | |||
+ | '''删除直播类''' | ||
+ | |||
+ | {| border="1" cellspacing="0" cellpadding="0" width="100%" class="parameters" style="border-color:#CCCCCC;" | ||
+ | |- | ||
+ | !width="20%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|接口名称 | ||
+ | !width="10%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|参数类型 | ||
+ | !width="58%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|说明 | ||
+ | !width="12%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|是否调用 | ||
+ | {{api_args|void setId|String|设置要删除的直播id|必需}} | ||
+ | {{api_args|void deleteLive|RequestListener|删除直播,并提供回调。onComplete表示接口成功返回,s为返回值;onWeiboException表示接口请求失败|必需}} | ||
+ | |} | ||
== 联系方式 == | == 联系方式 == | ||
+ | 接入及调试代码等工作,可联系jinya3@staff.weibo.com |
2017年6月2日 (五) 18:03的版本
微博直播SDK接入方法-Android
阅读以下文档,帮助了解如何使用微博直播SDK。
目录 |
服务端文档
服务端直播接口wiki: 请参考直播OPEN API
接入方法
demo工程请参考: ,直播相关接口请参考:直播接口参数
1.首先申请微博授权接入权限,见 微博授权
2.申请微博直播所需权限,需提交appKey、Android签名信息等,申请直播接口及直播互动接口权限,见直播权限申请
3.参考weibosdkdemo工程,将WeiboLiveOpenapi.jar导入。 新增类似WBLive*Activity相关的代码,用于调用WeiboLiveOpenApi中的接口
4.创建直播:初始化WeiboLiveCreate类,设置参数后,调用createLive接口创建直播,解析回调函数返回值,并保存正确返回值留待推流、互动、删除等其他用途。注意:在创建直播时将进行开播权限验证,若无开播权限,将进入实名认证页面。被禁播的用户将弹窗提示
5.更新直播:初始化WeiboLiveUpdate类,设置参数后,调用updateLive接口更新直播,解析回调函数返回值。
6.获取直播信息: 初始化WeiboLiveGetInfo类,设置参数后,调用getInfoLive接口获取直播信息,解析回调函数返回值。
7.删除直播:初始化WeiboLiveDelete类,设置参数后,调用deleteLive接口更新直播,解析回调函数返回值。
常用类及名词解释
类名 | 用途 | 所属包 |
---|---|---|
WeiboLiveCreate | 新建直播对象,获取直播推流地址,并同时发微博 | 直播sdk |
WeiboLiveDelete | 删除直播对象,不可逆(不删除微博) | 直播sdk |
WeiboLiveGetInfo | 获取直播对象信息、互动信息等 | 直播sdk |
WeiboLiveUpdate | 更新直播对象信息、状态等 | 直播sdk |
Oauth2AccessToken | accessToken类 | 授权sdk |
RequestListener | 接口事件回调,需要实现 | 授权sdk |
WeiboException | 接口错误信息,需要实现 | 授权sdk |
AccessTokenKeeper | 保存AccessToken | 授权sdk |
以下参数在直播sdk接口初始化时使用
参数字段 | 字段类型 | 字段说明 |
---|---|---|
context | Context | Android app的上下文环境 |
appKey | String | 申请权限时使用的appKey |
accessToken | Oauth2AccessToken | 从授权sdk获取的token |
接口参数
创建直播类
接口名称 | 参数类型 | 说明 | 是否调用 |
---|---|---|---|
void setAc | Activity | 传递当前所属Activity | 必需 |
void setTitle | String | 设置直播标题 | 必需 |
void setWidth | String | 设置直播宽度 | 必需 |
void setHeight | String | 设置直播高度 | 必需 |
void setSummary | String | 设置微博文本内容,少于130汉字 | 非必需 |
void setPublished | String | 微博是否发布,0:公开发布,1:仅自己可见,默认为0 | 非必需 |
void setImage | String | 封面图地址,注意封面图的宽高和直播的宽高比例要一致,建议分辨率不要太高 | 非必需 |
void setReplay | String | 是否录制,0:不录制,1:录制,默认为1 | 非必需 |
void setPanoLive | String | 是否全景直播,0:不是,1:是,默认为0 | 非必需 |
void createLive | RequestListener | 创建直播,并提供回调。onComplete表示接口成功返回,s为返回值;onWeiboException表示接口请求失败 | 必需 |
更新直播类
接口名称 | 参数类型 | 说明 | 是否调用 |
---|---|---|---|
void setId | String | 设置要更新的直播id | 必需 |
void setTitle | String | 设置直播对象描述 | 非必需 |
void setSummary | String | 设置微博文本内容,少于130汉字 | 非必需 |
void setPublished | String | 设置是否重发微博,0:公开发布,1:仅自己可见,2:不发布,默认为2 | 非必需 |
void setImage | String | 封面图地址,注意封面图的宽高和直播的宽高比例要一致,建议分辨率不要太高 | 非必需 |
void setStop | String | 设置直播状态,0:直播中,1:直播结束,默认0 | 非必需 |
void setReplayUrl | String | 设置直播回放地址 | 非必需 |
void updateLive | RequestListener | 更新直播,并提供回调。onComplete表示接口成功返回,s为返回值;onWeiboException表示接口请求失败 | 必需 |
获取直播信息类
接口名称 | 参数类型 | 说明 | 是否调用 |
---|---|---|---|
void setId | String | 设置直播id | 必需 |
void setDetail | String | 设置是否返回直播详情,0返回,1不返回,默认0 | 非必需 |
void getInfoLive | RequestListener | 获取直播信息,并提供回调。onComplete表示接口成功返回,s为返回值;onWeiboException表示接口请求失败 | 必需 |
删除直播类
接口名称 | 参数类型 | 说明 | 是否调用 |
---|---|---|---|
void setId | String | 设置要删除的直播id | 必需 |
void deleteLive | RequestListener | 删除直播,并提供回调。onComplete表示接口成功返回,s为返回值;onWeiboException表示接口请求失败 | 必需 |
联系方式
接入及调试代码等工作,可联系jinya3@staff.weibo.com