question
stringlengths 1
57
| tag
stringclasses 18
values | response
stringlengths 112
68.3k
| content
stringlengths 238
68.5k
| __index_level_0__
int64 0
12k
|
|---|---|---|---|---|
云导播信息 | 直播云 | [直播云](https://developer.qiniu.com/pili) > API 文档 >
[云导播API](https://developer.qiniu.com/pili/api/4703/caster-api) >
[云导播操作API](https://developer.qiniu.com/pili/api/4708/caster-operation-api) >
云导播信息
# 云导播信息
最近更新时间: 2018-07-09 10:22:33
# 请求包
GET /v1/static/casters/<CasterID>
Host: pili-caster.qiniuapi.com
Authorization: <StaticKey>
# 请求参数
参数名称 | 必填 | 字段类型 | 取值范围 | 说明
---|---|---|---|---
CasterID | 是 | string | - | 云导播唯一ID
# 返回包
200 OK
{
"id": "<id>",
"uid": <uid>,
"name": "<name>",
"staticKey": "<staticKey>",
"monitors": {
"0": {
"url": "<url>",
"vol": 100,
"muted": false
},
"1": {
"url": "<url>",
"vol": 100,
"muted": true
},
"2": {
"url": "<url>",
"vol": 100,
"muted": true
},
"3": {
"url": "<url>",
"vol": 100,
"muted": true
},
"4": {
"url": "<url>",
"vol": 100,
"muted": true
},
"5": {
"url": "<url>",
"vol": 100,
"muted": true
},
"6": {
"url": "<url>",
"vol": 100,
"muted": true
},
"7": {
"url": "<url>",
"vol": 100,
"muted": true
}
},
"canvas": {
"resolution": "<resolution>",
"height": <height>,
"width": <width>
},
"timeSwitch": {
"start": <start>,
"stop": <stop>
},
"pvwOutput": {
"play": "<url>",
"channel": 0,
"layout": 0
},
"pgmOutput": {
"closed": false,
"publish": "<url>",
"ab": 64,
"vb": 1000,
"channel": 0,
"overlay": {},
"text": {},
"emergencyMode": false,
"emergencyChannel": 0,
"delay": 0
},
"layouts": {
"0": {
"title": "<title>",
"overlay": {},
"text": {},
"updateAt": <timestamp>
}
},
"stage": 1,
"status": "pending",
"createAt": <timestamp>,
"updateAt": <timestamp>
}
# 返回参数
* 详细参数说明见[云导播参数说明](https://developer.qiniu.com/pili/api/4735#caster)
# 相关接口
* [云导播信息 GET /v1/static/casters/<CasterID>](https://developer.qiniu.com/pili/api/4717)
* [更新PVW监视器频道 POST /v1/static/casters/<CasterID>/pvw](https://developer.qiniu.com/pili/api/4718)
* [更新PGM监视器频道 POST /v1/static/casters/<CasterID>/pgm](https://developer.qiniu.com/pili/api/4719)
* [PVW切换至PGM POST /v1/static/casters/<CasterID>/switch](https://developer.qiniu.com/pili/api/4720)
* [更新监视器配置 POST /v1/static/casters/<CasterID>/monitors](https://developer.qiniu.com/pili/api/4721)
* [更新输出配置 POST /v1/static/casters/<CasterID>/publish](https://developer.qiniu.com/pili/api/4722)
* [更新PVW布局ID POST /v1/static/casters/<CasterID>/pvw/layouts](https://developer.qiniu.com/pili/api/4723)
* [更新布局配置 POST /v1/static/casters/<CasterID>/layouts](https://developer.qiniu.com/pili/api/4724)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > API 文档 >
[云导播API](https://developer.qiniu.com/pili/api/4703/caster-api) >
[云导播操作API](https://developer.qiniu.com/pili/api/4708/caster-operation-api) >
云导播信息
# 云导播信息
最近更新时间: 2018-07-09 10:22:33
# 请求包
GET /v1/static/casters/<CasterID>
Host: pili-caster.qiniuapi.com
Authorization: <StaticKey>
# 请求参数
参数名称 | 必填 | 字段类型 | 取值范围 | 说明
---|---|---|---|---
CasterID | 是 | string | - | 云导播唯一ID
# 返回包
200 OK
{
"id": "<id>",
"uid": <uid>,
"name": "<name>",
"staticKey": "<staticKey>",
"monitors": {
"0": {
"url": "<url>",
"vol": 100,
"muted": false
},
"1": {
"url": "<url>",
"vol": 100,
"muted": true
},
"2": {
"url": "<url>",
"vol": 100,
"muted": true
},
"3": {
"url": "<url>",
"vol": 100,
"muted": true
},
"4": {
"url": "<url>",
"vol": 100,
"muted": true
},
"5": {
"url": "<url>",
"vol": 100,
"muted": true
},
"6": {
"url": "<url>",
"vol": 100,
"muted": true
},
"7": {
"url": "<url>",
"vol": 100,
"muted": true
}
},
"canvas": {
"resolution": "<resolution>",
"height": <height>,
"width": <width>
},
"timeSwitch": {
"start": <start>,
"stop": <stop>
},
"pvwOutput": {
"play": "<url>",
"channel": 0,
"layout": 0
},
"pgmOutput": {
"closed": false,
"publish": "<url>",
"ab": 64,
"vb": 1000,
"channel": 0,
"overlay": {},
"text": {},
"emergencyMode": false,
"emergencyChannel": 0,
"delay": 0
},
"layouts": {
"0": {
"title": "<title>",
"overlay": {},
"text": {},
"updateAt": <timestamp>
}
},
"stage": 1,
"status": "pending",
"createAt": <timestamp>,
"updateAt": <timestamp>
}
# 返回参数
* 详细参数说明见[云导播参数说明](https://developer.qiniu.com/pili/api/4735#caster)
# 相关接口
* [云导播信息 GET /v1/static/casters/<CasterID>](https://developer.qiniu.com/pili/api/4717)
* [更新PVW监视器频道 POST /v1/static/casters/<CasterID>/pvw](https://developer.qiniu.com/pili/api/4718)
* [更新PGM监视器频道 POST /v1/static/casters/<CasterID>/pgm](https://developer.qiniu.com/pili/api/4719)
* [PVW切换至PGM POST /v1/static/casters/<CasterID>/switch](https://developer.qiniu.com/pili/api/4720)
* [更新监视器配置 POST /v1/static/casters/<CasterID>/monitors](https://developer.qiniu.com/pili/api/4721)
* [更新输出配置 POST /v1/static/casters/<CasterID>/publish](https://developer.qiniu.com/pili/api/4722)
* [更新PVW布局ID POST /v1/static/casters/<CasterID>/pvw/layouts](https://developer.qiniu.com/pili/api/4723)
* [更新布局配置 POST /v1/static/casters/<CasterID>/layouts](https://developer.qiniu.com/pili/api/4724)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 3,928 |
更新PVW监视器频道 | 直播云 | [直播云](https://developer.qiniu.com/pili) > API 文档 >
[云导播API](https://developer.qiniu.com/pili/api/4703/caster-api) >
[云导播操作API](https://developer.qiniu.com/pili/api/4708/caster-operation-api) >
更新PVW监视器频道
# 更新PVW监视器频道
最近更新时间: 2018-07-09 10:22:52
# 请求包
POST /v1/static/casters/<casterID>/pvw
Host: pili-caster.qiniuapi.com
Authorization: <StaticKey>
Content-Type: application/json
{
"channel": <channel>
}
# 请求参数
参数名称 | 必填 | 字段类型 | 取值范围 | 说明
---|---|---|---|---
CasterID | 是 | string | - | 云导播唯一ID
channel | 是 | int | [0,7] | 监视器频道
# 返回包
200 OK
# 返回参数
* 详细参数说明见[云导播参数说明](https://developer.qiniu.com/pili/api/4735#caster)
# 相关接口
* [云导播信息 GET /v1/static/casters/<CasterID>](https://developer.qiniu.com/pili/api/4717)
* [更新PVW监视器频道 POST /v1/static/casters/<CasterID>/pvw](https://developer.qiniu.com/pili/api/4718)
* [更新PGM监视器频道 POST /v1/static/casters/<CasterID>/pgm](https://developer.qiniu.com/pili/api/4719)
* [PVW切换至PGM POST /v1/static/casters/<CasterID>/switch](https://developer.qiniu.com/pili/api/4720)
* [更新监视器配置 POST /v1/static/casters/<CasterID>/monitors](https://developer.qiniu.com/pili/api/4721)
* [更新输出配置 POST /v1/static/casters/<CasterID>/publish](https://developer.qiniu.com/pili/api/4722)
* [更新PVW布局ID POST /v1/static/casters/<CasterID>/pvw/layouts](https://developer.qiniu.com/pili/api/4723)
* [更新布局配置 POST /v1/static/casters/<CasterID>/layouts](https://developer.qiniu.com/pili/api/4724)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > API 文档 >
[云导播API](https://developer.qiniu.com/pili/api/4703/caster-api) >
[云导播操作API](https://developer.qiniu.com/pili/api/4708/caster-operation-api) >
更新PVW监视器频道
# 更新PVW监视器频道
最近更新时间: 2018-07-09 10:22:52
# 请求包
POST /v1/static/casters/<casterID>/pvw
Host: pili-caster.qiniuapi.com
Authorization: <StaticKey>
Content-Type: application/json
{
"channel": <channel>
}
# 请求参数
参数名称 | 必填 | 字段类型 | 取值范围 | 说明
---|---|---|---|---
CasterID | 是 | string | - | 云导播唯一ID
channel | 是 | int | [0,7] | 监视器频道
# 返回包
200 OK
# 返回参数
* 详细参数说明见[云导播参数说明](https://developer.qiniu.com/pili/api/4735#caster)
# 相关接口
* [云导播信息 GET /v1/static/casters/<CasterID>](https://developer.qiniu.com/pili/api/4717)
* [更新PVW监视器频道 POST /v1/static/casters/<CasterID>/pvw](https://developer.qiniu.com/pili/api/4718)
* [更新PGM监视器频道 POST /v1/static/casters/<CasterID>/pgm](https://developer.qiniu.com/pili/api/4719)
* [PVW切换至PGM POST /v1/static/casters/<CasterID>/switch](https://developer.qiniu.com/pili/api/4720)
* [更新监视器配置 POST /v1/static/casters/<CasterID>/monitors](https://developer.qiniu.com/pili/api/4721)
* [更新输出配置 POST /v1/static/casters/<CasterID>/publish](https://developer.qiniu.com/pili/api/4722)
* [更新PVW布局ID POST /v1/static/casters/<CasterID>/pvw/layouts](https://developer.qiniu.com/pili/api/4723)
* [更新布局配置 POST /v1/static/casters/<CasterID>/layouts](https://developer.qiniu.com/pili/api/4724)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 3,931 |
更新PGM监视器频道 | 直播云 | [直播云](https://developer.qiniu.com/pili) > API 文档 >
[云导播API](https://developer.qiniu.com/pili/api/4703/caster-api) >
[云导播操作API](https://developer.qiniu.com/pili/api/4708/caster-operation-api) >
更新PGM监视器频道
# 更新PGM监视器频道
最近更新时间: 2018-07-09 10:23:11
# 请求包
POST /v1/static/casters/<casterID>/pgm
Host: pili-caster.qiniuapi.com
Authorization: <StaticKey>
Content-Type: application/json
{
"channel": <channel>
}
# 请求参数
参数名称 | 必填 | 字段类型 | 取值范围 | 说明
---|---|---|---|---
CasterID | 是 | string | - | 云导播唯一ID
channel | 否 | int | [0,7] | 监视器频道
# 返回包
200 OK
# 返回参数
* 详细参数说明见[云导播参数说明](https://developer.qiniu.com/pili/api/4735#caster)
# 相关接口
* [云导播信息 GET /v1/static/casters/<CasterID>](https://developer.qiniu.com/pili/api/4717)
* [更新PVW监视器频道 POST /v1/static/casters/<CasterID>/pvw](https://developer.qiniu.com/pili/api/4718)
* [更新PGM监视器频道 POST /v1/static/casters/<CasterID>/pgm](https://developer.qiniu.com/pili/api/4719)
* [PVW切换至PGM POST /v1/static/casters/<CasterID>/switch](https://developer.qiniu.com/pili/api/4720)
* [更新监视器配置 POST /v1/static/casters/<CasterID>/monitors](https://developer.qiniu.com/pili/api/4721)
* [更新输出配置 POST /v1/static/casters/<CasterID>/publish](https://developer.qiniu.com/pili/api/4722)
* [更新PVW布局ID POST /v1/static/casters/<CasterID>/pvw/layouts](https://developer.qiniu.com/pili/api/4723)
* [更新布局配置 POST /v1/static/casters/<CasterID>/layouts](https://developer.qiniu.com/pili/api/4724)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > API 文档 >
[云导播API](https://developer.qiniu.com/pili/api/4703/caster-api) >
[云导播操作API](https://developer.qiniu.com/pili/api/4708/caster-operation-api) >
更新PGM监视器频道
# 更新PGM监视器频道
最近更新时间: 2018-07-09 10:23:11
# 请求包
POST /v1/static/casters/<casterID>/pgm
Host: pili-caster.qiniuapi.com
Authorization: <StaticKey>
Content-Type: application/json
{
"channel": <channel>
}
# 请求参数
参数名称 | 必填 | 字段类型 | 取值范围 | 说明
---|---|---|---|---
CasterID | 是 | string | - | 云导播唯一ID
channel | 否 | int | [0,7] | 监视器频道
# 返回包
200 OK
# 返回参数
* 详细参数说明见[云导播参数说明](https://developer.qiniu.com/pili/api/4735#caster)
# 相关接口
* [云导播信息 GET /v1/static/casters/<CasterID>](https://developer.qiniu.com/pili/api/4717)
* [更新PVW监视器频道 POST /v1/static/casters/<CasterID>/pvw](https://developer.qiniu.com/pili/api/4718)
* [更新PGM监视器频道 POST /v1/static/casters/<CasterID>/pgm](https://developer.qiniu.com/pili/api/4719)
* [PVW切换至PGM POST /v1/static/casters/<CasterID>/switch](https://developer.qiniu.com/pili/api/4720)
* [更新监视器配置 POST /v1/static/casters/<CasterID>/monitors](https://developer.qiniu.com/pili/api/4721)
* [更新输出配置 POST /v1/static/casters/<CasterID>/publish](https://developer.qiniu.com/pili/api/4722)
* [更新PVW布局ID POST /v1/static/casters/<CasterID>/pvw/layouts](https://developer.qiniu.com/pili/api/4723)
* [更新布局配置 POST /v1/static/casters/<CasterID>/layouts](https://developer.qiniu.com/pili/api/4724)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 3,934 |
PVW切换至PGM | 直播云 | [直播云](https://developer.qiniu.com/pili) > API 文档 >
[云导播API](https://developer.qiniu.com/pili/api/4703/caster-api) >
[云导播操作API](https://developer.qiniu.com/pili/api/4708/caster-operation-api) >
PVW切换至PGM
# PVW切换至PGM
最近更新时间: 2018-07-09 10:23:37
# 请求包
POST /v1/static/casters/<CasterID>/switch
Host: pili-caster.qiniuapi.com
Authorization: <StaticKey>
Content-Type: application/json
{
"switchVol": false
}
# 请求参数
参数名称 | 必填 | 字段类型 | 取值范围 | 说明
---|---|---|---|---
CasterID | 是 | string | - | 云导播唯一ID
switchVol | 否 | bool | - | 同步切换音频
# 返回包
200 OK
# 返回参数
* 详细参数说明见[云导播参数说明](https://developer.qiniu.com/pili/api/4735#caster)
# 相关接口
* [云导播信息 GET /v1/static/casters/<CasterID>](https://developer.qiniu.com/pili/api/4717)
* [更新PVW监视器频道 POST /v1/static/casters/<CasterID>/pvw](https://developer.qiniu.com/pili/api/4718)
* [更新PGM监视器频道 POST /v1/static/casters/<CasterID>/pgm](https://developer.qiniu.com/pili/api/4719)
* [PVW切换至PGM POST /v1/static/casters/<CasterID>/switch](https://developer.qiniu.com/pili/api/4720)
* [更新监视器配置 POST /v1/static/casters/<CasterID>/monitors](https://developer.qiniu.com/pili/api/4721)
* [更新输出配置 POST /v1/static/casters/<CasterID>/publish](https://developer.qiniu.com/pili/api/4722)
* [更新PVW布局ID POST /v1/static/casters/<CasterID>/pvw/layouts](https://developer.qiniu.com/pili/api/4723)
* [更新布局配置 POST /v1/static/casters/<CasterID>/layouts](https://developer.qiniu.com/pili/api/4724)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > API 文档 >
[云导播API](https://developer.qiniu.com/pili/api/4703/caster-api) >
[云导播操作API](https://developer.qiniu.com/pili/api/4708/caster-operation-api) >
PVW切换至PGM
# PVW切换至PGM
最近更新时间: 2018-07-09 10:23:37
# 请求包
POST /v1/static/casters/<CasterID>/switch
Host: pili-caster.qiniuapi.com
Authorization: <StaticKey>
Content-Type: application/json
{
"switchVol": false
}
# 请求参数
参数名称 | 必填 | 字段类型 | 取值范围 | 说明
---|---|---|---|---
CasterID | 是 | string | - | 云导播唯一ID
switchVol | 否 | bool | - | 同步切换音频
# 返回包
200 OK
# 返回参数
* 详细参数说明见[云导播参数说明](https://developer.qiniu.com/pili/api/4735#caster)
# 相关接口
* [云导播信息 GET /v1/static/casters/<CasterID>](https://developer.qiniu.com/pili/api/4717)
* [更新PVW监视器频道 POST /v1/static/casters/<CasterID>/pvw](https://developer.qiniu.com/pili/api/4718)
* [更新PGM监视器频道 POST /v1/static/casters/<CasterID>/pgm](https://developer.qiniu.com/pili/api/4719)
* [PVW切换至PGM POST /v1/static/casters/<CasterID>/switch](https://developer.qiniu.com/pili/api/4720)
* [更新监视器配置 POST /v1/static/casters/<CasterID>/monitors](https://developer.qiniu.com/pili/api/4721)
* [更新输出配置 POST /v1/static/casters/<CasterID>/publish](https://developer.qiniu.com/pili/api/4722)
* [更新PVW布局ID POST /v1/static/casters/<CasterID>/pvw/layouts](https://developer.qiniu.com/pili/api/4723)
* [更新布局配置 POST /v1/static/casters/<CasterID>/layouts](https://developer.qiniu.com/pili/api/4724)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 3,937 |
更新监视器配置 | 直播云 | [直播云](https://developer.qiniu.com/pili) > API 文档 >
[云导播API](https://developer.qiniu.com/pili/api/4703/caster-api) >
[云导播操作API](https://developer.qiniu.com/pili/api/4708/caster-operation-api) >
更新监视器配置
# 更新监视器配置
最近更新时间: 2018-07-09 10:24:22
# 请求包
POST /v1/static/casters/<CasterID>/monitors
Host: pili-caster.qiniuapi.com
Authorization: <StaticKey>
Content-Type: application/json
{
"channel": 0,
"url": "",
"vol": 0,
"muted": false
}
# 请求参数
参数名称 | 必填 | 字段类型 | 取值范围 | 说明
---|---|---|---|---
CasterID | 是 | string | - | 云导播唯一ID
channel | 否 | int | [0,7] | 监视器频道
url | 否 | string | - | 监视器源流地址，支持直播流、静态视频、图片等
vol | 否 | int | [0,300] | 音量
muted | 否 | bool | - | 是否静音
# 返回包
200 OK
# 返回参数
* 详细参数说明见[云导播参数说明](https://developer.qiniu.com/pili/api/4735#caster)
# 相关接口
* [云导播信息 GET /v1/static/casters/<CasterID>](https://developer.qiniu.com/pili/api/4717)
* [更新PVW监视器频道 POST /v1/static/casters/<CasterID>/pvw](https://developer.qiniu.com/pili/api/4718)
* [更新PGM监视器频道 POST /v1/static/casters/<CasterID>/pgm](https://developer.qiniu.com/pili/api/4719)
* [PVW切换至PGM POST /v1/static/casters/<CasterID>/switch](https://developer.qiniu.com/pili/api/4720)
* [更新监视器配置 POST /v1/static/casters/<CasterID>/monitors](https://developer.qiniu.com/pili/api/4721)
* [更新输出配置 POST /v1/static/casters/<CasterID>/publish](https://developer.qiniu.com/pili/api/4722)
* [更新PVW布局ID POST /v1/static/casters/<CasterID>/pvw/layouts](https://developer.qiniu.com/pili/api/4723)
* [更新布局配置 POST /v1/static/casters/<CasterID>/layouts](https://developer.qiniu.com/pili/api/4724)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > API 文档 >
[云导播API](https://developer.qiniu.com/pili/api/4703/caster-api) >
[云导播操作API](https://developer.qiniu.com/pili/api/4708/caster-operation-api) >
更新监视器配置
# 更新监视器配置
最近更新时间: 2018-07-09 10:24:22
# 请求包
POST /v1/static/casters/<CasterID>/monitors
Host: pili-caster.qiniuapi.com
Authorization: <StaticKey>
Content-Type: application/json
{
"channel": 0,
"url": "",
"vol": 0,
"muted": false
}
# 请求参数
参数名称 | 必填 | 字段类型 | 取值范围 | 说明
---|---|---|---|---
CasterID | 是 | string | - | 云导播唯一ID
channel | 否 | int | [0,7] | 监视器频道
url | 否 | string | - | 监视器源流地址，支持直播流、静态视频、图片等
vol | 否 | int | [0,300] | 音量
muted | 否 | bool | - | 是否静音
# 返回包
200 OK
# 返回参数
* 详细参数说明见[云导播参数说明](https://developer.qiniu.com/pili/api/4735#caster)
# 相关接口
* [云导播信息 GET /v1/static/casters/<CasterID>](https://developer.qiniu.com/pili/api/4717)
* [更新PVW监视器频道 POST /v1/static/casters/<CasterID>/pvw](https://developer.qiniu.com/pili/api/4718)
* [更新PGM监视器频道 POST /v1/static/casters/<CasterID>/pgm](https://developer.qiniu.com/pili/api/4719)
* [PVW切换至PGM POST /v1/static/casters/<CasterID>/switch](https://developer.qiniu.com/pili/api/4720)
* [更新监视器配置 POST /v1/static/casters/<CasterID>/monitors](https://developer.qiniu.com/pili/api/4721)
* [更新输出配置 POST /v1/static/casters/<CasterID>/publish](https://developer.qiniu.com/pili/api/4722)
* [更新PVW布局ID POST /v1/static/casters/<CasterID>/pvw/layouts](https://developer.qiniu.com/pili/api/4723)
* [更新布局配置 POST /v1/static/casters/<CasterID>/layouts](https://developer.qiniu.com/pili/api/4724)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 3,940 |
更新PVW布局ID | 直播云 | [直播云](https://developer.qiniu.com/pili) > API 文档 >
[云导播API](https://developer.qiniu.com/pili/api/4703/caster-api) >
[云导播操作API](https://developer.qiniu.com/pili/api/4708/caster-operation-api) >
更新PVW布局ID
# 更新PVW布局ID
最近更新时间: 2018-07-09 10:24:35
# 请求包
POST /v1/static/casters/<CasterID>/pvw/layouts
Host: pili-caster.qiniuapi.com
Authorization: <StaticKey>
Content-Type: application/json
{
"layout": 0
}
# 请求参数
参数名称 | 必填 | 字段类型 | 取值范围 | 说明
---|---|---|---|---
CasterID | 是 | string | - | 云导播唯一ID
layout | 否 | int | [-1,7] | 布局ID，-1表示不使用布局
# 返回包
200 OK
# 返回参数
* 详细参数说明见[云导播参数说明](https://developer.qiniu.com/pili/api/4735#caster)
# 相关接口
* [云导播信息 GET /v1/static/casters/<CasterID>](https://developer.qiniu.com/pili/api/4717)
* [更新PVW监视器频道 POST /v1/static/casters/<CasterID>/pvw](https://developer.qiniu.com/pili/api/4718)
* [更新PGM监视器频道 POST /v1/static/casters/<CasterID>/pgm](https://developer.qiniu.com/pili/api/4719)
* [PVW切换至PGM POST /v1/static/casters/<CasterID>/switch](https://developer.qiniu.com/pili/api/4720)
* [更新监视器配置 POST /v1/static/casters/<CasterID>/monitors](https://developer.qiniu.com/pili/api/4721)
* [更新输出配置 POST /v1/static/casters/<CasterID>/publish](https://developer.qiniu.com/pili/api/4722)
* [更新PVW布局ID POST /v1/static/casters/<CasterID>/pvw/layouts](https://developer.qiniu.com/pili/api/4723)
* [更新布局配置 POST /v1/static/casters/<CasterID>/layouts](https://developer.qiniu.com/pili/api/4724)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > API 文档 >
[云导播API](https://developer.qiniu.com/pili/api/4703/caster-api) >
[云导播操作API](https://developer.qiniu.com/pili/api/4708/caster-operation-api) >
更新PVW布局ID
# 更新PVW布局ID
最近更新时间: 2018-07-09 10:24:35
# 请求包
POST /v1/static/casters/<CasterID>/pvw/layouts
Host: pili-caster.qiniuapi.com
Authorization: <StaticKey>
Content-Type: application/json
{
"layout": 0
}
# 请求参数
参数名称 | 必填 | 字段类型 | 取值范围 | 说明
---|---|---|---|---
CasterID | 是 | string | - | 云导播唯一ID
layout | 否 | int | [-1,7] | 布局ID，-1表示不使用布局
# 返回包
200 OK
# 返回参数
* 详细参数说明见[云导播参数说明](https://developer.qiniu.com/pili/api/4735#caster)
# 相关接口
* [云导播信息 GET /v1/static/casters/<CasterID>](https://developer.qiniu.com/pili/api/4717)
* [更新PVW监视器频道 POST /v1/static/casters/<CasterID>/pvw](https://developer.qiniu.com/pili/api/4718)
* [更新PGM监视器频道 POST /v1/static/casters/<CasterID>/pgm](https://developer.qiniu.com/pili/api/4719)
* [PVW切换至PGM POST /v1/static/casters/<CasterID>/switch](https://developer.qiniu.com/pili/api/4720)
* [更新监视器配置 POST /v1/static/casters/<CasterID>/monitors](https://developer.qiniu.com/pili/api/4721)
* [更新输出配置 POST /v1/static/casters/<CasterID>/publish](https://developer.qiniu.com/pili/api/4722)
* [更新PVW布局ID POST /v1/static/casters/<CasterID>/pvw/layouts](https://developer.qiniu.com/pili/api/4723)
* [更新布局配置 POST /v1/static/casters/<CasterID>/layouts](https://developer.qiniu.com/pili/api/4724)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 3,943 |
更新输出配置 | 直播云 | [直播云](https://developer.qiniu.com/pili) > API 文档 >
[云导播API](https://developer.qiniu.com/pili/api/4703/caster-api) >
[云导播操作API](https://developer.qiniu.com/pili/api/4708/caster-operation-api) >
更新输出配置
# 更新输出配置
最近更新时间: 2018-07-09 10:24:42
# 请求包
POST /v1/static/casters/<CasterID>/publish
Host: pili-caster.qiniuapi.com
Authorization: <StaticKey>
Content-Type: application/json
{
"url": "",
"vb": 0,
"ab": 0,
"closed": false,
"emergencyMode": false,
"emergencyChannel": 0,
"delay": 0
}
# 请求参数
参数名称 | 必填 | 字段类型 | 取值范围 | 说明
---|---|---|---|---
CasterID | 是 | string | - | 云导播唯一ID
url | 否 | string | - | PGM推流地址
ab | 否 | int | [64,512] | 音频码率(Kbps)，默认值为64
vb | 否 | int | [300,10240] | 视频码率(Kbps)，默认值为1000
closed | 否 | bool | - | 关闭推流
emergencyMode | 否 | bool | - | 紧急模式开关
emergencyChannel | 否 | int | [0,7] | 紧急模式监视器频道，取值范围是[0,7]，默认使用0频道
delay | 否 | int | [0,180] | 延时播放，单位: 秒
# 返回包
200 OK
# 返回参数
* 详细参数说明见[云导播参数说明](https://developer.qiniu.com/pili/api/4735#caster)
# 相关接口
* [云导播信息 GET /v1/static/casters/<CasterID>](https://developer.qiniu.com/pili/api/4717)
* [更新PVW监视器频道 POST /v1/static/casters/<CasterID>/pvw](https://developer.qiniu.com/pili/api/4718)
* [更新PGM监视器频道 POST /v1/static/casters/<CasterID>/pgm](https://developer.qiniu.com/pili/api/4719)
* [PVW切换至PGM POST /v1/static/casters/<CasterID>/switch](https://developer.qiniu.com/pili/api/4720)
* [更新监视器配置 POST /v1/static/casters/<CasterID>/monitors](https://developer.qiniu.com/pili/api/4721)
* [更新输出配置 POST /v1/static/casters/<CasterID>/publish](https://developer.qiniu.com/pili/api/4722)
* [更新PVW布局ID POST /v1/static/casters/<CasterID>/pvw/layouts](https://developer.qiniu.com/pili/api/4723)
* [更新布局配置 POST /v1/static/casters/<CasterID>/layouts](https://developer.qiniu.com/pili/api/4724)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > API 文档 >
[云导播API](https://developer.qiniu.com/pili/api/4703/caster-api) >
[云导播操作API](https://developer.qiniu.com/pili/api/4708/caster-operation-api) >
更新输出配置
# 更新输出配置
最近更新时间: 2018-07-09 10:24:42
# 请求包
POST /v1/static/casters/<CasterID>/publish
Host: pili-caster.qiniuapi.com
Authorization: <StaticKey>
Content-Type: application/json
{
"url": "",
"vb": 0,
"ab": 0,
"closed": false,
"emergencyMode": false,
"emergencyChannel": 0,
"delay": 0
}
# 请求参数
参数名称 | 必填 | 字段类型 | 取值范围 | 说明
---|---|---|---|---
CasterID | 是 | string | - | 云导播唯一ID
url | 否 | string | - | PGM推流地址
ab | 否 | int | [64,512] | 音频码率(Kbps)，默认值为64
vb | 否 | int | [300,10240] | 视频码率(Kbps)，默认值为1000
closed | 否 | bool | - | 关闭推流
emergencyMode | 否 | bool | - | 紧急模式开关
emergencyChannel | 否 | int | [0,7] | 紧急模式监视器频道，取值范围是[0,7]，默认使用0频道
delay | 否 | int | [0,180] | 延时播放，单位: 秒
# 返回包
200 OK
# 返回参数
* 详细参数说明见[云导播参数说明](https://developer.qiniu.com/pili/api/4735#caster)
# 相关接口
* [云导播信息 GET /v1/static/casters/<CasterID>](https://developer.qiniu.com/pili/api/4717)
* [更新PVW监视器频道 POST /v1/static/casters/<CasterID>/pvw](https://developer.qiniu.com/pili/api/4718)
* [更新PGM监视器频道 POST /v1/static/casters/<CasterID>/pgm](https://developer.qiniu.com/pili/api/4719)
* [PVW切换至PGM POST /v1/static/casters/<CasterID>/switch](https://developer.qiniu.com/pili/api/4720)
* [更新监视器配置 POST /v1/static/casters/<CasterID>/monitors](https://developer.qiniu.com/pili/api/4721)
* [更新输出配置 POST /v1/static/casters/<CasterID>/publish](https://developer.qiniu.com/pili/api/4722)
* [更新PVW布局ID POST /v1/static/casters/<CasterID>/pvw/layouts](https://developer.qiniu.com/pili/api/4723)
* [更新布局配置 POST /v1/static/casters/<CasterID>/layouts](https://developer.qiniu.com/pili/api/4724)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 3,946 |
更新布局配置 | 直播云 | [直播云](https://developer.qiniu.com/pili) > API 文档 >
[云导播API](https://developer.qiniu.com/pili/api/4703/caster-api) >
[云导播操作API](https://developer.qiniu.com/pili/api/4708/caster-operation-api) >
更新布局配置
# 更新布局配置
最近更新时间: 2018-07-09 10:24:47
# 请求包
POST /v1/static/casters/<CasterID>/layouts
Host: pili-caster.qiniuapi.com
Authorization: <StaticKey>
Content-Type: application/json
{
"layout": 0,
"title": "",
"overlay": {},
"text": {}
}
# 请求参数
参数名称 | 必填 | 字段类型 | 取值范围 | 说明
---|---|---|---|---
CasterID | 是 | string | - | 云导播唯一ID
layout | 否 | int | [0,7] | 布局ID
title | 否 | string | - | 布局标题，可留空
overlay | 否 | object | - | 画中画配置，key为对应的监视器频道，详细参数见[画中画配置(overlay)详细参数](https://developer.qiniu.com/pili/api/4735#overlay)
text | 否 | object | - | 文字水印配置，key为文字水印标题，详细参数见[文字水印配置(text)详细参数](https://developer.qiniu.com/pili/api/4735#text)
# 返回包
200 OK
# 返回参数
* 详细参数说明见[云导播参数说明](https://developer.qiniu.com/pili/api/4735#caster)
# 相关接口
* [云导播信息 GET /v1/static/casters/<CasterID>](https://developer.qiniu.com/pili/api/4717)
* [更新PVW监视器频道 POST /v1/static/casters/<CasterID>/pvw](https://developer.qiniu.com/pili/api/4718)
* [更新PGM监视器频道 POST /v1/static/casters/<CasterID>/pgm](https://developer.qiniu.com/pili/api/4719)
* [PVW切换至PGM POST /v1/static/casters/<CasterID>/switch](https://developer.qiniu.com/pili/api/4720)
* [更新监视器配置 POST /v1/static/casters/<CasterID>/monitors](https://developer.qiniu.com/pili/api/4721)
* [更新输出配置 POST /v1/static/casters/<CasterID>/publish](https://developer.qiniu.com/pili/api/4722)
* [更新PVW布局ID POST /v1/static/casters/<CasterID>/pvw/layouts](https://developer.qiniu.com/pili/api/4723)
* [更新布局配置 POST /v1/static/casters/<CasterID>/layouts](https://developer.qiniu.com/pili/api/4724)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > API 文档 >
[云导播API](https://developer.qiniu.com/pili/api/4703/caster-api) >
[云导播操作API](https://developer.qiniu.com/pili/api/4708/caster-operation-api) >
更新布局配置
# 更新布局配置
最近更新时间: 2018-07-09 10:24:47
# 请求包
POST /v1/static/casters/<CasterID>/layouts
Host: pili-caster.qiniuapi.com
Authorization: <StaticKey>
Content-Type: application/json
{
"layout": 0,
"title": "",
"overlay": {},
"text": {}
}
# 请求参数
参数名称 | 必填 | 字段类型 | 取值范围 | 说明
---|---|---|---|---
CasterID | 是 | string | - | 云导播唯一ID
layout | 否 | int | [0,7] | 布局ID
title | 否 | string | - | 布局标题，可留空
overlay | 否 | object | - | 画中画配置，key为对应的监视器频道，详细参数见[画中画配置(overlay)详细参数](https://developer.qiniu.com/pili/api/4735#overlay)
text | 否 | object | - | 文字水印配置，key为文字水印标题，详细参数见[文字水印配置(text)详细参数](https://developer.qiniu.com/pili/api/4735#text)
# 返回包
200 OK
# 返回参数
* 详细参数说明见[云导播参数说明](https://developer.qiniu.com/pili/api/4735#caster)
# 相关接口
* [云导播信息 GET /v1/static/casters/<CasterID>](https://developer.qiniu.com/pili/api/4717)
* [更新PVW监视器频道 POST /v1/static/casters/<CasterID>/pvw](https://developer.qiniu.com/pili/api/4718)
* [更新PGM监视器频道 POST /v1/static/casters/<CasterID>/pgm](https://developer.qiniu.com/pili/api/4719)
* [PVW切换至PGM POST /v1/static/casters/<CasterID>/switch](https://developer.qiniu.com/pili/api/4720)
* [更新监视器配置 POST /v1/static/casters/<CasterID>/monitors](https://developer.qiniu.com/pili/api/4721)
* [更新输出配置 POST /v1/static/casters/<CasterID>/publish](https://developer.qiniu.com/pili/api/4722)
* [更新PVW布局ID POST /v1/static/casters/<CasterID>/pvw/layouts](https://developer.qiniu.com/pili/api/4723)
* [更新布局配置 POST /v1/static/casters/<CasterID>/layouts](https://developer.qiniu.com/pili/api/4724)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 3,949 |
云导播参数说明 | 直播云 | [直播云](https://developer.qiniu.com/pili) > API 文档 >
[云导播API](https://developer.qiniu.com/pili/api/4703/caster-api) > 云导播参数说明
# 云导播参数说明
最近更新时间: 2021-09-28 10:39:17
# 云导播(caster)详细参数
参数名称 | 字段类型 | 取值范围 | 说明
---|---|---|---
id | string | - | 云导播唯一ID
uid | int | - | 用户ID
name | string | 允许1-18位，小写字母与数字组合 | 云导播名称
staticKey | string | 默认值为16位小写英文+数字随机值 | 云导播静态密钥，留空会生成随机密钥
monitors | object | - | 监视器配置，支持0-7共8个频道，详细参数见监视器配置(monitors)详细参数
canvas | object | - | 画布配置，详细参数见画布配置(canvas)详细参数
storage | object | - | 上传配置，详细参数见画布配置(storage)详细参数
timeSwitch | object | - | 定时开关，详细参数见定时开关(timeSwitch)详细参数
pvwOutput | object | - | PVW输出配置，详细配置见PVW输出配置(pvwOutput)详细参数
pgmOutput | object | - | PGM输出配置，详细配置见PGM输出配置(pgmOutput)详细参数
layouts | object | - | 布局配置，支持0-7共8组配置，详细参数见布局配置(layouts)详细参数
stage | int | [0,4] | 云导播逻辑状态标记位，0:初始化; 1:运行中; 2:关闭; 3:异常; 4:启动中
status | string | - | 云导播实际状态，部分接口返回值中会省略
createAt | int | - | 云导播创建时间
updateAt | int | - | 云导播更新时间
# 监视器配置(monitors)详细参数
参数名称 | 字段类型 | 取值范围 | 说明
---|---|---|---
url | string | - | 监视器源流地址，支持直播流、静态视频、图片等
vol | int | [0,300] | 音量
muted | bool | - | 是否静音
# 上传配置(storage)详细参数
参数名称 | 字段类型 | 取值范围 | 说明
---|---|---|---
Bucket | string | - | 存储空间名称，要求华东、公开。用于上传的静态资源的存储
Domain | string | - | Bucket 内静态资源的访问域名
# 画布配置(canvas)详细参数
参数名称 | 字段类型 | 取值范围 | 说明
---|---|---|---
resolution | string | [“480p”, “720p”, “1080p”,“2k”,“4k”] | 画布规格，默认为720p
height | int | （320,3840] | 画布高度
width | int | （320,3840] | 画布宽度
* 备注：resolution参数填写后，宽高即被确定，如720p的宽高即为1280和720，无法自定义height和width参数；如果需要自定义宽高参数，可以不填写resolution参数，然后自定义height和width两个宽高的参数来自定义画布（即输出视频分辨率）的大小
* 当自定义画布宽高时，导播台是以480p、720p、1080p、2k、4k来进行计费的,统计说明如下：
1. 长边小于等于640 且 短边小于等于480，统计为480p
2. 长边小于等于1280 且 短边小于等于720，统计为720p
3. 长边小于等于1920 且 短边小于等于1080，统计为1080p
4. 长边小于等于2560 且 短边小于等于1440，统计为2K
5. 长边小于等于3840 且 短边小于等于2160，统计为4K
# 定时开关(timeSwitch)详细参数
参数名称 | 字段类型 | 取值范围 | 说明
---|---|---|---
start | int | - | 云导播开启时间
stop | int | - | 云导播关闭时间
# PVW输出配置(pvwOutput)详细参数
参数名称 | 字段类型 | 取值范围 | 说明
---|---|---|---
channel | int | [0,7] | 监视器频道，默认使用0频道
layout | int | [-1,7] | 布局ID，-1表示不使用布局
# PGM输出配置(pgmOutput)详细参数
参数名称 | 字段类型 | 取值范围 | 说明
---|---|---|---
closed | bool | - | 关闭推流
publish | string | - | PGM推流地址
ab | int | [64,512] | 音频码率(Kbps)，默认值为64
vb | int | [300,10240] | 视频码率(Kbps)，默认值为1000
channel | int | [0,7] | 监视器频道，默认使用0频道
overlay | object | - | 画中画配置，key为对应的监视器频道，详细参数见画中画配置(overlay)详细参数
text | object | - | 文字水印配置，key为文字水印标题，详细参数见文字水印配置(text)详细参数
emergencyMode | bool | - | 紧急模式开关
emergencyChannel | int | [0,7] | 紧急模式监视器频道，取值范围是[0,7]，默认使用0频道
delay | int | [0,180] | 延时播放，单位: 秒
# 布局配置(layouts)详细参数
参数名称 | 字段类型 | 取值范围 | 说明
---|---|---|---
title | string | - | 布局标题，可留空
overlay | object | - | 画中画配置，key为对应的监视器频道，详细参数见画中画配置(overlay)详细参数
text | object | - | 文字水印配置，key为文字水印标题，详细参数见文字水印配置(text)详细参数
updateAt | int | - | 更新时间
# 画中画配置(overlay)详细参数
参数名称 | 字段类型 | 取值范围 | 说明
---|---|---|---
w | int | [5,#(画布宽度)] | 宽度
h | int | [5,#(画布高度)] | 高度
x | int | [0,#(画布高度)] | 距画布左侧的距离
y | int | [0,#(画布宽度)] | 距画布上侧的距离
z | int | [0,255] | 堆叠顺序
* 需要保证画中画的画面在画布内，如果超出，会强制拉伸(stretch)画面，导致源流变形
* 限制 W+X 小于 画布宽度；H+Y 小于 画布高度
# 文字水印配置(text)详细参数
参数名称 | 字段类型 | 取值范围 | 说明
---|---|---|---
content | string | - | 文字水印内容
fontcolor | string | [#000000,#FFFFFF] | 字体颜色
bgcolor | string | [#000000,#FFFFFF] | 背景颜色
opacity | int | [0,255] | 不透明度，8bit Alpha通道
size | int | [5, #(画布高度)] | 字体大小
w | int | [5,#(画布宽度)] | 宽度
h | int | [5,#(画布高度)] | 高度
x | int | [0,#(画布高度)] | 距画布左侧的距离
y | int | [0,#(画布宽度)] | 距画布上侧的距离
z | int | [0,255] | 堆叠顺序
offsetx | int | - | 距字体框左侧的距离
offsety | int | - | 距字体框上侧的距离
speedx | int | [-2000,2000] | X轴滚动速度
speedy | int | [-2000,2000] | X轴滚动速度
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > API 文档 >
[云导播API](https://developer.qiniu.com/pili/api/4703/caster-api) > 云导播参数说明
# 云导播参数说明
最近更新时间: 2021-09-28 10:39:17
# 云导播(caster)详细参数
参数名称 | 字段类型 | 取值范围 | 说明
---|---|---|---
id | string | - | 云导播唯一ID
uid | int | - | 用户ID
name | string | 允许1-18位，小写字母与数字组合 | 云导播名称
staticKey | string | 默认值为16位小写英文+数字随机值 | 云导播静态密钥，留空会生成随机密钥
monitors | object | - | 监视器配置，支持0-7共8个频道，详细参数见监视器配置(monitors)详细参数
canvas | object | - | 画布配置，详细参数见画布配置(canvas)详细参数
storage | object | - | 上传配置，详细参数见画布配置(storage)详细参数
timeSwitch | object | - | 定时开关，详细参数见定时开关(timeSwitch)详细参数
pvwOutput | object | - | PVW输出配置，详细配置见PVW输出配置(pvwOutput)详细参数
pgmOutput | object | - | PGM输出配置，详细配置见PGM输出配置(pgmOutput)详细参数
layouts | object | - | 布局配置，支持0-7共8组配置，详细参数见布局配置(layouts)详细参数
stage | int | [0,4] | 云导播逻辑状态标记位，0:初始化; 1:运行中; 2:关闭; 3:异常; 4:启动中
status | string | - | 云导播实际状态，部分接口返回值中会省略
createAt | int | - | 云导播创建时间
updateAt | int | - | 云导播更新时间
# 监视器配置(monitors)详细参数
参数名称 | 字段类型 | 取值范围 | 说明
---|---|---|---
url | string | - | 监视器源流地址，支持直播流、静态视频、图片等
vol | int | [0,300] | 音量
muted | bool | - | 是否静音
# 上传配置(storage)详细参数
参数名称 | 字段类型 | 取值范围 | 说明
---|---|---|---
Bucket | string | - | 存储空间名称，要求华东、公开。用于上传的静态资源的存储
Domain | string | - | Bucket 内静态资源的访问域名
# 画布配置(canvas)详细参数
参数名称 | 字段类型 | 取值范围 | 说明
---|---|---|---
resolution | string | [“480p”, “720p”, “1080p”,“2k”,“4k”] | 画布规格，默认为720p
height | int | （320,3840] | 画布高度
width | int | （320,3840] | 画布宽度
* 备注：resolution参数填写后，宽高即被确定，如720p的宽高即为1280和720，无法自定义height和width参数；如果需要自定义宽高参数，可以不填写resolution参数，然后自定义height和width两个宽高的参数来自定义画布（即输出视频分辨率）的大小
* 当自定义画布宽高时，导播台是以480p、720p、1080p、2k、4k来进行计费的,统计说明如下：
1. 长边小于等于640 且 短边小于等于480，统计为480p
2. 长边小于等于1280 且 短边小于等于720，统计为720p
3. 长边小于等于1920 且 短边小于等于1080，统计为1080p
4. 长边小于等于2560 且 短边小于等于1440，统计为2K
5. 长边小于等于3840 且 短边小于等于2160，统计为4K
# 定时开关(timeSwitch)详细参数
参数名称 | 字段类型 | 取值范围 | 说明
---|---|---|---
start | int | - | 云导播开启时间
stop | int | - | 云导播关闭时间
# PVW输出配置(pvwOutput)详细参数
参数名称 | 字段类型 | 取值范围 | 说明
---|---|---|---
channel | int | [0,7] | 监视器频道，默认使用0频道
layout | int | [-1,7] | 布局ID，-1表示不使用布局
# PGM输出配置(pgmOutput)详细参数
参数名称 | 字段类型 | 取值范围 | 说明
---|---|---|---
closed | bool | - | 关闭推流
publish | string | - | PGM推流地址
ab | int | [64,512] | 音频码率(Kbps)，默认值为64
vb | int | [300,10240] | 视频码率(Kbps)，默认值为1000
channel | int | [0,7] | 监视器频道，默认使用0频道
overlay | object | - | 画中画配置，key为对应的监视器频道，详细参数见画中画配置(overlay)详细参数
text | object | - | 文字水印配置，key为文字水印标题，详细参数见文字水印配置(text)详细参数
emergencyMode | bool | - | 紧急模式开关
emergencyChannel | int | [0,7] | 紧急模式监视器频道，取值范围是[0,7]，默认使用0频道
delay | int | [0,180] | 延时播放，单位: 秒
# 布局配置(layouts)详细参数
参数名称 | 字段类型 | 取值范围 | 说明
---|---|---|---
title | string | - | 布局标题，可留空
overlay | object | - | 画中画配置，key为对应的监视器频道，详细参数见画中画配置(overlay)详细参数
text | object | - | 文字水印配置，key为文字水印标题，详细参数见文字水印配置(text)详细参数
updateAt | int | - | 更新时间
# 画中画配置(overlay)详细参数
参数名称 | 字段类型 | 取值范围 | 说明
---|---|---|---
w | int | [5,#(画布宽度)] | 宽度
h | int | [5,#(画布高度)] | 高度
x | int | [0,#(画布高度)] | 距画布左侧的距离
y | int | [0,#(画布宽度)] | 距画布上侧的距离
z | int | [0,255] | 堆叠顺序
* 需要保证画中画的画面在画布内，如果超出，会强制拉伸(stretch)画面，导致源流变形
* 限制 W+X 小于 画布宽度；H+Y 小于 画布高度
# 文字水印配置(text)详细参数
参数名称 | 字段类型 | 取值范围 | 说明
---|---|---|---
content | string | - | 文字水印内容
fontcolor | string | [#000000,#FFFFFF] | 字体颜色
bgcolor | string | [#000000,#FFFFFF] | 背景颜色
opacity | int | [0,255] | 不透明度，8bit Alpha通道
size | int | [5, #(画布高度)] | 字体大小
w | int | [5,#(画布宽度)] | 宽度
h | int | [5,#(画布高度)] | 高度
x | int | [0,#(画布高度)] | 距画布左侧的距离
y | int | [0,#(画布宽度)] | 距画布上侧的距离
z | int | [0,255] | 堆叠顺序
offsetx | int | - | 距字体框左侧的距离
offsety | int | - | 距字体框上侧的距离
speedx | int | [-2000,2000] | X轴滚动速度
speedy | int | [-2000,2000] | X轴滚动速度
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 3,952 |
创建任务 | 直播云 | [直播云](https://developer.qiniu.com/pili) > API 文档 > Pub API >创建任务
# 创建任务
最近更新时间: 2023-03-17 17:24:54
在服务端创建一个pub任务。
# 请求包
**备注：如果是海外的pub转推任务，请将Host改为：pili-hw-pub.qiniuapi.com**
POST /tasks
Host: pili-pub.qiniuapi.com
Authorization: <QiniuToken>
Content-Type: application/json
{
"name": "",
"desc": "",
"sourceUrls": [
{
"url":<URL>,
"isp":<ISP>,
"seek":<SEEK>,
"videoType":<VIDEOTYPE>,
"rtspType":<RTSPTYPE>
}
],
"runType": "seek",
"forwardUrls": [
{
"url":<URL>,
"isp":<ISP>
}
],
"filter": {
"ips": <IP LIST>,
"area": <AREA>,
"isp": <ISP>
},
"loopTimes": 0,
"retryTime": 60,
"deliverStartTime": 1637100000000,
"deliverStopTime": 1637100000000,
"sustain": false,
"preload": {
"enable": true,
"preloadTime": 1637000600000
},
"statusCallback": {
"type": "JSON",
"url": <URL>,
"vars": {
"taskid": "$(taskID)",
"status": "$(status)",
"startTime": "$(startTime)",
"stopTime": "$(stopTime)"
}
}
}
参数名称 | 必填 | 说明
---|---|---
name | 是 | 字符串，任务名称 必须满足 `1-20个数字或字母`，单用户创建pub任务名唯一。
desc | 否 | 字符串，任务描述信息。
sourceUrls | 是 | 对象数组，源地址，数组必须长度必须大于等于1，大于1的情况下为播单模式。详见[参数说明](https://developer.qiniu.com/pili/api/7326/parameters-that-pub)
runType | 是 | 字符串，任务类型， normal：普通转推，seek：seek转推。
forwardUrls | 是 | 对象数组，转推地址，数组必须长度必须大于等于1。
filter | 否 | 用于筛选转推机器，有area、isp和ips字段，详见[参数说明](https://developer.qiniu.com/pili/api/7326/parameters-that-pub)
loopTimes | 否 | 整型， 表示pub任务的循环次数，不填写此参数则默认为0，不循环；-1表示无限循环。
retryTime | 否 | 整型， 表示pub任务的总断流重试时间，pub任务转推中断后会在断流重试时间内不断进行重新连接，直至重连成功或者达到设定的总断流重试时间。在单位：s，必须大于等于60。**注：任务中断（正常结束或者失败）重试后，运行时间超过1分钟，认为重连成功，会重置retryTime。（不适合点播流，存在无限循环的可能）**
deliverStartTime | 否 | 整型，任务定时开始时间，单位：ms，必须要大于当前时间且小于设置定时关闭的时间。
deliverStopTime | 否 | 整型，任务定时关闭时间，单位：ms，必须要大于当前时间且大于设置定时开始的时间。
sustain | 否 | bool，循环转推不中断设置，true表示循环不中断由一个ffmpeg进程，false（默认项）表示每次循环起一个ffmpeg。
preload | 否 | 预加载相关配置，有enable和preloadTime字段，详见[参数说明](https://developer.qiniu.com/pili/api/7326/parameters-that-pub)
statusCallback | 否 | 任务状态通知相关配置（任务正常结束或失败重试完后回调通知），详见[参数说明](https://developer.qiniu.com/pili/api/7326/parameters-that-pub)
# 参数
* 详细参数说明见[参数说明](https://developer.qiniu.com/pili/api/7326/parameters-that-pub)
# 返回包
200 {
"taskID":"taskID"
}
400 {
"error": "invalid parameter name"
}
400 {
"error": "invalid parameter deliverTime"
}
400 {
"error": "invalid parameter filter"
}
400 {
"error": "invalid parameter url"
}
400 {
"error": "invalid parameter runType"
}
400 {
"error": "invalid parameter loopTimes"
}
400 {
"error": "invalid parameter retryTime"
}
400 {
"error": "invalid parameter preload"
}
400 {
"error": "create task conflict"
}
500 {
"error": "create task fail"
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > API 文档 > Pub API >创建任务
# 创建任务
最近更新时间: 2023-03-17 17:24:54
在服务端创建一个pub任务。
# 请求包
**备注：如果是海外的pub转推任务，请将Host改为：pili-hw-pub.qiniuapi.com**
POST /tasks
Host: pili-pub.qiniuapi.com
Authorization: <QiniuToken>
Content-Type: application/json
{
"name": "",
"desc": "",
"sourceUrls": [
{
"url":<URL>,
"isp":<ISP>,
"seek":<SEEK>,
"videoType":<VIDEOTYPE>,
"rtspType":<RTSPTYPE>
}
],
"runType": "seek",
"forwardUrls": [
{
"url":<URL>,
"isp":<ISP>
}
],
"filter": {
"ips": <IP LIST>,
"area": <AREA>,
"isp": <ISP>
},
"loopTimes": 0,
"retryTime": 60,
"deliverStartTime": 1637100000000,
"deliverStopTime": 1637100000000,
"sustain": false,
"preload": {
"enable": true,
"preloadTime": 1637000600000
},
"statusCallback": {
"type": "JSON",
"url": <URL>,
"vars": {
"taskid": "$(taskID)",
"status": "$(status)",
"startTime": "$(startTime)",
"stopTime": "$(stopTime)"
}
}
}
参数名称 | 必填 | 说明
---|---|---
name | 是 | 字符串，任务名称 必须满足 `1-20个数字或字母`，单用户创建pub任务名唯一。
desc | 否 | 字符串，任务描述信息。
sourceUrls | 是 | 对象数组，源地址，数组必须长度必须大于等于1，大于1的情况下为播单模式。详见[参数说明](https://developer.qiniu.com/pili/api/7326/parameters-that-pub)
runType | 是 | 字符串，任务类型， normal：普通转推，seek：seek转推。
forwardUrls | 是 | 对象数组，转推地址，数组必须长度必须大于等于1。
filter | 否 | 用于筛选转推机器，有area、isp和ips字段，详见[参数说明](https://developer.qiniu.com/pili/api/7326/parameters-that-pub)
loopTimes | 否 | 整型， 表示pub任务的循环次数，不填写此参数则默认为0，不循环；-1表示无限循环。
retryTime | 否 | 整型， 表示pub任务的总断流重试时间，pub任务转推中断后会在断流重试时间内不断进行重新连接，直至重连成功或者达到设定的总断流重试时间。在单位：s，必须大于等于60。**注：任务中断（正常结束或者失败）重试后，运行时间超过1分钟，认为重连成功，会重置retryTime。（不适合点播流，存在无限循环的可能）**
deliverStartTime | 否 | 整型，任务定时开始时间，单位：ms，必须要大于当前时间且小于设置定时关闭的时间。
deliverStopTime | 否 | 整型，任务定时关闭时间，单位：ms，必须要大于当前时间且大于设置定时开始的时间。
sustain | 否 | bool，循环转推不中断设置，true表示循环不中断由一个ffmpeg进程，false（默认项）表示每次循环起一个ffmpeg。
preload | 否 | 预加载相关配置，有enable和preloadTime字段，详见[参数说明](https://developer.qiniu.com/pili/api/7326/parameters-that-pub)
statusCallback | 否 | 任务状态通知相关配置（任务正常结束或失败重试完后回调通知），详见[参数说明](https://developer.qiniu.com/pili/api/7326/parameters-that-pub)
# 参数
* 详细参数说明见[参数说明](https://developer.qiniu.com/pili/api/7326/parameters-that-pub)
# 返回包
200 {
"taskID":"taskID"
}
400 {
"error": "invalid parameter name"
}
400 {
"error": "invalid parameter deliverTime"
}
400 {
"error": "invalid parameter filter"
}
400 {
"error": "invalid parameter url"
}
400 {
"error": "invalid parameter runType"
}
400 {
"error": "invalid parameter loopTimes"
}
400 {
"error": "invalid parameter retryTime"
}
400 {
"error": "invalid parameter preload"
}
400 {
"error": "create task conflict"
}
500 {
"error": "create task fail"
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 3,961 |
编辑任务 | 直播云 | [直播云](https://developer.qiniu.com/pili) > API 文档 > Pub API >编辑任务
# 编辑任务
最近更新时间: 2023-03-17 17:25:28
在服务端编辑一个pub任务。
# 请求包
**备注：如果是海外的pub转推任务，请将Host改为：pili-hw-pub.qiniuapi.com**
POST /tasks/<taskID>
Host: pili-pub.qiniuapi.com
Authorization: <QiniuToken>
Content-Type: application/json
{
"runType": "seek",
"desc": "",
"sourceUrls": [
{
"url":<URL>,
"isp":<ISP>,
"seek":<SEEK>,
"videoType":<VIDEOTYPE>,
"rtspType":<RTSPTYPE>
}
],
"forwardUrls": [
{
"url":<URL>,
"isp":<ISP>
}
],
"filter": {},
"loopTimes": 0,
"retryTime": 60,
"deliverStartTime": 1637100000000,
"deliverStopTime": 1637100000000,
"preload": {
"enable": true,
"preloadTime": 1637000600000
},
"statusCallback": {
"type": "JSON",
"url": <URL>,
"vars": {
"taskid": "$(taskID)",
"status": "$(status)",
"startTime": "$(startTime)",
"stopTime": "$(stopTime)"
}
}
}
参数名称 | 必填 | 说明
---|---|---
taskID | 是 | 任务id。
sourceUrls | 是 | 对象数组，源地址，数组必须长度必须大于等于1，大于1的情况下为播单模式。详见[参数说明](https://developer.qiniu.com/pili/api/7326/parameters-that-pub)
runType | 是 | 字符串，任务类型, normal: 普通转推,seek: seek转推。
forwardUrls | 是 | 对象数组，转推地址，数组必须长度必须大于等于1。
filter | 否 | 用于筛选转推机器，有area和isp字段，详见[参数说明](https://developer.qiniu.com/pili/api/7326/parameters-that-pub)
loopTimes | 否 | 整型， 表示pub任务的循环次数，不填写此参数则默认为0，不循环；-1表示无限循环。
retryTime | 否 | 整型， 表示pub任务的总断流重试时间，pub任务转推中断后会在断流重试时间内每不断进行重新连接，直至重连成功或者达到设定的总断流重试时间。在单位：s，必须大于等于60。**注：任务中断（正常结束或者失败）重试后，运行时间超过1分钟，认为重连成功，会重置retryTime。（不适合点播流，存在无限循环的可能）**
deliverStartTime | 否 | 整型，任务定时开始时间，单位：ms,必须要大于当前时间且小于设置定时关闭的时间。
deliverStopTime | 否 | 整型，任务定时关闭时间，单位：ms,必须要大于当前时间且大于设置定时开始的时间。
preload | 否 | 预加载相关配置，有enable和preloadTime字段，详见[参数说明](https://developer.qiniu.com/pili/api/7326/parameters-that-pub)
statusCallback | 否 | 任务状态通知相关配置（任务正常结束或失败重试完后回调通知），详见[参数说明](https://developer.qiniu.com/pili/api/7326/parameters-that-pub)
# 参数
* 详细参数说明见[参数说明](https://developer.qiniu.com/pili/api/7326/parameters-that-pub)
# 返回包
200 {}
400 {
"error": "invalid parameter"
}
400 {
"error": "invalid parameter deliverTime"
}
400 {
"error": "invalid parameter filter"
}
400 {
"error": "invalid parameter url"
}
400 {
"error": "invalid parameter runType"
}
400 {
"error": "invalid parameter loopTimes"
}
400 {
"error": "invalid parameter retryTime"
}
400 {
"error": "invalid parameter preloadTime"
}
404 {
"error": "not fond"
}
500 {
"error": "query task fail"
}
400 {
"error": "task running"
}
500 {
"error": "edit task fail"
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > API 文档 > Pub API >编辑任务
# 编辑任务
最近更新时间: 2023-03-17 17:25:28
在服务端编辑一个pub任务。
# 请求包
**备注：如果是海外的pub转推任务，请将Host改为：pili-hw-pub.qiniuapi.com**
POST /tasks/<taskID>
Host: pili-pub.qiniuapi.com
Authorization: <QiniuToken>
Content-Type: application/json
{
"runType": "seek",
"desc": "",
"sourceUrls": [
{
"url":<URL>,
"isp":<ISP>,
"seek":<SEEK>,
"videoType":<VIDEOTYPE>,
"rtspType":<RTSPTYPE>
}
],
"forwardUrls": [
{
"url":<URL>,
"isp":<ISP>
}
],
"filter": {},
"loopTimes": 0,
"retryTime": 60,
"deliverStartTime": 1637100000000,
"deliverStopTime": 1637100000000,
"preload": {
"enable": true,
"preloadTime": 1637000600000
},
"statusCallback": {
"type": "JSON",
"url": <URL>,
"vars": {
"taskid": "$(taskID)",
"status": "$(status)",
"startTime": "$(startTime)",
"stopTime": "$(stopTime)"
}
}
}
参数名称 | 必填 | 说明
---|---|---
taskID | 是 | 任务id。
sourceUrls | 是 | 对象数组，源地址，数组必须长度必须大于等于1，大于1的情况下为播单模式。详见[参数说明](https://developer.qiniu.com/pili/api/7326/parameters-that-pub)
runType | 是 | 字符串，任务类型, normal: 普通转推,seek: seek转推。
forwardUrls | 是 | 对象数组，转推地址，数组必须长度必须大于等于1。
filter | 否 | 用于筛选转推机器，有area和isp字段，详见[参数说明](https://developer.qiniu.com/pili/api/7326/parameters-that-pub)
loopTimes | 否 | 整型， 表示pub任务的循环次数，不填写此参数则默认为0，不循环；-1表示无限循环。
retryTime | 否 | 整型， 表示pub任务的总断流重试时间，pub任务转推中断后会在断流重试时间内每不断进行重新连接，直至重连成功或者达到设定的总断流重试时间。在单位：s，必须大于等于60。**注：任务中断（正常结束或者失败）重试后，运行时间超过1分钟，认为重连成功，会重置retryTime。（不适合点播流，存在无限循环的可能）**
deliverStartTime | 否 | 整型，任务定时开始时间，单位：ms,必须要大于当前时间且小于设置定时关闭的时间。
deliverStopTime | 否 | 整型，任务定时关闭时间，单位：ms,必须要大于当前时间且大于设置定时开始的时间。
preload | 否 | 预加载相关配置，有enable和preloadTime字段，详见[参数说明](https://developer.qiniu.com/pili/api/7326/parameters-that-pub)
statusCallback | 否 | 任务状态通知相关配置（任务正常结束或失败重试完后回调通知），详见[参数说明](https://developer.qiniu.com/pili/api/7326/parameters-that-pub)
# 参数
* 详细参数说明见[参数说明](https://developer.qiniu.com/pili/api/7326/parameters-that-pub)
# 返回包
200 {}
400 {
"error": "invalid parameter"
}
400 {
"error": "invalid parameter deliverTime"
}
400 {
"error": "invalid parameter filter"
}
400 {
"error": "invalid parameter url"
}
400 {
"error": "invalid parameter runType"
}
400 {
"error": "invalid parameter loopTimes"
}
400 {
"error": "invalid parameter retryTime"
}
400 {
"error": "invalid parameter preloadTime"
}
404 {
"error": "not fond"
}
500 {
"error": "query task fail"
}
400 {
"error": "task running"
}
500 {
"error": "edit task fail"
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 3,966 |
任务详情 | 直播云 | [直播云](https://developer.qiniu.com/pili) > API 文档 > Pub API >任务详情
# 任务详情
最近更新时间: 2022-10-19 17:00:25
# 请求包
**备注：如果是海外的pub转推任务，请将Host改为：pili-hw-pub.qiniuapi.com**
GET /tasks/<taskID>
Host: pili-pub.qiniuapi.com
Authorization: <QiniuToken>
参数名称 | 必填 | 说明
---|---|---
taskId | 是 | 字符串，任务Id。
# 返回包
200 {
"taskID": "123",
"uid": ,
"name": "",
"desc": "",
"runType":"seek",
"sourceUrls": [
{
"url":<URL>,
"isp":<ISP>,
"seek":<SEEK>,
"videoType":<VIDEOTYPE>,
"rtspType":<RTSPTYPE>
}
],
"forwardUrls": [
{
"url":<URL>,
"isp":<ISP>
}
],
"filter": {},
"status": "",
"deliverStartTime": 1637100000000,
"deliverStopTime": 1637100000000,
"startTime": 1637100000000,
"stopTime": 1637100000000,
"createTime": 1637100000000,
"loopTimes": 0,
"retryTime": 60,
"retry": 5,
"preload": {
"enable": true,
"preloadTime": 1637000600000
},
"preloadStatus": "finished",
"statusCallback": {
"type": "JSON",
"url": <URL>,
"vars": <VARS>,
"timeout": 5,
"retryTimes": 3,
"retryInterval": 1
}
}
400 {
"error": "invalid parameter"
}
404 {
"error": "not fond"
}
500 {
"error": "query task fail"
}
# 返回参数
参数名称 | 类型 | 说明
---|---|---
taskID | 字符串 | 任务ID。
uid | 整型 | 用户ID。
name | 字符串 | 任务名称。
desc | 字符串 | 任务描述。
runType | 字符串 | 任务类型，normal：普通转推，seek：seek转推。
sourceUrls | 对象数组 | 源地址。
forwardUrls | 对象数组 | 转推地址。
filter | 对象 | 任务过滤条件。
status | 字符串 | 任务状态，pending 初始状态，running，stopped，failed，finished。
deliverStartTime | 整型 | 任务定时开始时间，单位：ms。
deliverStopTime | 整型 | 任务定时关闭时间，单位：ms。
startTime | 整型 | 任务开始时间，单位：ms。
stopTime | 整型 | 任务停止时间，单位：ms。
createTime | 整型 | 任务创建时间，单位：ms。
loopTimes | 整型 | 循环次数。
retryTime | 整型 | 断流重试时间，单位：s。
retry | 整型 | 剩余重试次数。
preload | 对象 | 预加载相关配置。
preloadStatus | 字符串 | 预加载状态，预加载运行中 running，预加载失败 failed，预加载完成finished。
* 详细参数说明见[参数说明](https://developer.qiniu.com/pili/api/7326/parameters-that-pub)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > API 文档 > Pub API >任务详情
# 任务详情
最近更新时间: 2022-10-19 17:00:25
# 请求包
**备注：如果是海外的pub转推任务，请将Host改为：pili-hw-pub.qiniuapi.com**
GET /tasks/<taskID>
Host: pili-pub.qiniuapi.com
Authorization: <QiniuToken>
参数名称 | 必填 | 说明
---|---|---
taskId | 是 | 字符串，任务Id。
# 返回包
200 {
"taskID": "123",
"uid": ,
"name": "",
"desc": "",
"runType":"seek",
"sourceUrls": [
{
"url":<URL>,
"isp":<ISP>,
"seek":<SEEK>,
"videoType":<VIDEOTYPE>,
"rtspType":<RTSPTYPE>
}
],
"forwardUrls": [
{
"url":<URL>,
"isp":<ISP>
}
],
"filter": {},
"status": "",
"deliverStartTime": 1637100000000,
"deliverStopTime": 1637100000000,
"startTime": 1637100000000,
"stopTime": 1637100000000,
"createTime": 1637100000000,
"loopTimes": 0,
"retryTime": 60,
"retry": 5,
"preload": {
"enable": true,
"preloadTime": 1637000600000
},
"preloadStatus": "finished",
"statusCallback": {
"type": "JSON",
"url": <URL>,
"vars": <VARS>,
"timeout": 5,
"retryTimes": 3,
"retryInterval": 1
}
}
400 {
"error": "invalid parameter"
}
404 {
"error": "not fond"
}
500 {
"error": "query task fail"
}
# 返回参数
参数名称 | 类型 | 说明
---|---|---
taskID | 字符串 | 任务ID。
uid | 整型 | 用户ID。
name | 字符串 | 任务名称。
desc | 字符串 | 任务描述。
runType | 字符串 | 任务类型，normal：普通转推，seek：seek转推。
sourceUrls | 对象数组 | 源地址。
forwardUrls | 对象数组 | 转推地址。
filter | 对象 | 任务过滤条件。
status | 字符串 | 任务状态，pending 初始状态，running，stopped，failed，finished。
deliverStartTime | 整型 | 任务定时开始时间，单位：ms。
deliverStopTime | 整型 | 任务定时关闭时间，单位：ms。
startTime | 整型 | 任务开始时间，单位：ms。
stopTime | 整型 | 任务停止时间，单位：ms。
createTime | 整型 | 任务创建时间，单位：ms。
loopTimes | 整型 | 循环次数。
retryTime | 整型 | 断流重试时间，单位：s。
retry | 整型 | 剩余重试次数。
preload | 对象 | 预加载相关配置。
preloadStatus | 字符串 | 预加载状态，预加载运行中 running，预加载失败 failed，预加载完成finished。
* 详细参数说明见[参数说明](https://developer.qiniu.com/pili/api/7326/parameters-that-pub)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 3,971 |
任务列表 | 直播云 | [直播云](https://developer.qiniu.com/pili) > API 文档 > Pub API >任务列表
# 任务列表
最近更新时间: 2022-10-19 17:00:54
# 请求包
**备注：如果是海外的pub转推任务，请将Host改为：pili-hw-pub.qiniuapi.com**
GET /tasks?marker=123&limit=123&name=abc
Host: pili-pub.qiniuapi.com
Authorization: <QiniuToken>
参数名称 | 必填 | 说明
---|---|---
marker | 否 | 字符串，定位标识。
limit | 否 | 整型，请求数目，上限1000。
name | 否 | 字符串，任务名称和任务描述模糊匹配。
# 返回包
200 {
"marker": "",
"isEnd": true,
"list": [
{
"taskID": "123",
"uid": 123,
"name": "",
"desc": "",
"sourceUrls": [
{
"url": "",
"isp": "",
"seek":<SEEK>,
"videoType":<VIDEOTYPE>,
"rtspType":<RTSPTYPE>
}
],
"forwardUrls": [
{
"url": "",
"isp": ""
}
],
"filter": {
"area": "",
"isp": "",
"ip": ["",""]
},
"status": "",
"deliverStartTime": 1630551226526,
"deliverStopTime": 1630551226526,
"startTime": 1630551226526,
"stopTime": 1630551226526,
"retry": 4,
"createTime": 1630551226526,
"loopTimes": 0,
"retryTime": 60,
"preload": {
"enable": true,
"preloadTime": 1637000600000
},
"preloadStatus": "finished",
"statusCallback": {
"type": "JSON",
"url": <URL>,
"vars": <VARS>,
"timeout": 5,
"retryTimes": 3,
"retryInterval": 1
}
}
]
}
400 {
"error": "invalid parameter"
}
500 {
"error": "query task fail"
}
# 返回参数
参数名称 | 类型 | 说明
---|---|---
marker | 字符串 | 定位标识。
isEnd | 布尔类型 | 是否结束。
list | 对象数组 | 任务列表。
* 详细参数说明见[参数说明](https://developer.qiniu.com/pili/api/7326/parameters-that-pub)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > API 文档 > Pub API >任务列表
# 任务列表
最近更新时间: 2022-10-19 17:00:54
# 请求包
**备注：如果是海外的pub转推任务，请将Host改为：pili-hw-pub.qiniuapi.com**
GET /tasks?marker=123&limit=123&name=abc
Host: pili-pub.qiniuapi.com
Authorization: <QiniuToken>
参数名称 | 必填 | 说明
---|---|---
marker | 否 | 字符串，定位标识。
limit | 否 | 整型，请求数目，上限1000。
name | 否 | 字符串，任务名称和任务描述模糊匹配。
# 返回包
200 {
"marker": "",
"isEnd": true,
"list": [
{
"taskID": "123",
"uid": 123,
"name": "",
"desc": "",
"sourceUrls": [
{
"url": "",
"isp": "",
"seek":<SEEK>,
"videoType":<VIDEOTYPE>,
"rtspType":<RTSPTYPE>
}
],
"forwardUrls": [
{
"url": "",
"isp": ""
}
],
"filter": {
"area": "",
"isp": "",
"ip": ["",""]
},
"status": "",
"deliverStartTime": 1630551226526,
"deliverStopTime": 1630551226526,
"startTime": 1630551226526,
"stopTime": 1630551226526,
"retry": 4,
"createTime": 1630551226526,
"loopTimes": 0,
"retryTime": 60,
"preload": {
"enable": true,
"preloadTime": 1637000600000
},
"preloadStatus": "finished",
"statusCallback": {
"type": "JSON",
"url": <URL>,
"vars": <VARS>,
"timeout": 5,
"retryTimes": 3,
"retryInterval": 1
}
}
]
}
400 {
"error": "invalid parameter"
}
500 {
"error": "query task fail"
}
# 返回参数
参数名称 | 类型 | 说明
---|---|---
marker | 字符串 | 定位标识。
isEnd | 布尔类型 | 是否结束。
list | 对象数组 | 任务列表。
* 详细参数说明见[参数说明](https://developer.qiniu.com/pili/api/7326/parameters-that-pub)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 3,975 |
删除任务 | 直播云 | [直播云](https://developer.qiniu.com/pili) > API 文档 > Pub API >删除任务
# 删除任务
最近更新时间: 2022-04-25 17:19:23
# 请求包
**备注：如果是海外的pub转推任务，请将Host改为：pili-hw-pub.qiniuapi.com**
DELETE /tasks/<taskID>
Host: pili-pub.qiniuapi.com
Authorization: <QiniuToken>
| 参数名称 | 必填 | 说明 |
| :----------- |:--------------------------------------------------------------- |
| taskID | 是 | 任务id。|
# 返回包
200 {}
400 {
"error": "invalid parameter"
}
404 {
"error": "not fond"
}
500 {
"error": "query task fail"
}
400 {
"error": "task running"
}
500 {
"error": "delete task fail"
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > API 文档 > Pub API >删除任务
# 删除任务
最近更新时间: 2022-04-25 17:19:23
# 请求包
**备注：如果是海外的pub转推任务，请将Host改为：pili-hw-pub.qiniuapi.com**
DELETE /tasks/<taskID>
Host: pili-pub.qiniuapi.com
Authorization: <QiniuToken>
| 参数名称 | 必填 | 说明 |
| :----------- |:--------------------------------------------------------------- |
| taskID | 是 | 任务id。|
# 返回包
200 {}
400 {
"error": "invalid parameter"
}
404 {
"error": "not fond"
}
500 {
"error": "query task fail"
}
400 {
"error": "task running"
}
500 {
"error": "delete task fail"
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 3,978 |
开始任务 | 直播云 | [直播云](https://developer.qiniu.com/pili) > API 文档 > Pub API >开始任务
# 开始任务
最近更新时间: 2022-04-25 17:19:31
# 请求包
**备注：如果是海外的pub转推任务，请将Host改为：pili-hw-pub.qiniuapi.com**
POST /tasks/<taskID>/start
Host: pili-pub.qiniuapi.com
Authorization: <QiniuToken>
参数名称 | 必填 | 说明
---|---|---
taskID | 是 | 任务id。
# 返回包
200 {}
400 {
"error": "invalid parameter"
}
404 {
"error": "not fond"
}
500 {
"error": "query task fail"
}
400 {
"error": "repeat operation"
}
500 {
"error": "get worker fail"
}
500 {
"error": "no worker"
}
500 {
"error": "no workers available"
}
500 {
"error": "add worker's task fail"
}
500 {
"error": "call worker fail"
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > API 文档 > Pub API >开始任务
# 开始任务
最近更新时间: 2022-04-25 17:19:31
# 请求包
**备注：如果是海外的pub转推任务，请将Host改为：pili-hw-pub.qiniuapi.com**
POST /tasks/<taskID>/start
Host: pili-pub.qiniuapi.com
Authorization: <QiniuToken>
参数名称 | 必填 | 说明
---|---|---
taskID | 是 | 任务id。
# 返回包
200 {}
400 {
"error": "invalid parameter"
}
404 {
"error": "not fond"
}
500 {
"error": "query task fail"
}
400 {
"error": "repeat operation"
}
500 {
"error": "get worker fail"
}
500 {
"error": "no worker"
}
500 {
"error": "no workers available"
}
500 {
"error": "add worker's task fail"
}
500 {
"error": "call worker fail"
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 3,980 |
停止任务 | 直播云 | [直播云](https://developer.qiniu.com/pili) > API 文档 > Pub API >停止任务
# 停止任务
最近更新时间: 2023-06-13 17:42:34
# 请求包
**备注：如果是海外的pub转推任务，请将Host改为：pili-hw-pub.qiniuapi.com**
POST /tasks/<taskID>/stop
Host: pili-pub.qiniuapi.com
Authorization: <QiniuToken>
参数名称 | 必填 | 说明
---|---|---
taskID | 是 | 任务id
# 返回包
200 {}
400 {
"error": "invalid parameter"
}
404 {
"error": "not fond"
}
500 {
"error": "query task fail"
}
400 {
"error": "repeat operation"
}
500 {
"error": "stop task fail"
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > API 文档 > Pub API >停止任务
# 停止任务
最近更新时间: 2023-06-13 17:42:34
# 请求包
**备注：如果是海外的pub转推任务，请将Host改为：pili-hw-pub.qiniuapi.com**
POST /tasks/<taskID>/stop
Host: pili-pub.qiniuapi.com
Authorization: <QiniuToken>
参数名称 | 必填 | 说明
---|---|---
taskID | 是 | 任务id
# 返回包
200 {}
400 {
"error": "invalid parameter"
}
404 {
"error": "not fond"
}
500 {
"error": "query task fail"
}
400 {
"error": "repeat operation"
}
500 {
"error": "stop task fail"
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 3,982 |
任务运行日志 | 直播云 | [直播云](https://developer.qiniu.com/pili) > API 文档 > Pub API >任务运行日志
# 任务运行日志
最近更新时间: 2022-04-25 17:20:06
# 请求包
**备注：如果是海外的pub转推任务，请将Host改为：pili-hw-pub.qiniuapi.com**
GET /tasks/<taskID>/runinfo
Host: pili-pub.qiniuapi.com
Authorization: <QiniuToken>
参数名称 | 必填 | 说明
---|---|---
taskID | 是 | 任务id。
# 返回包
200 {
"out": ""
}
400 {
"error": "invalid parameter"
}
404 {
"error": "not fond"
}
500 {
"error": "query task fail"
}
500 {
"error": "no worker"
}
500 {
"error": "query task log fail"
}
# 返回参数
参数名称 | 类型 | 说明
---|---|---
out | 字符串 | 运行日志。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > API 文档 > Pub API >任务运行日志
# 任务运行日志
最近更新时间: 2022-04-25 17:20:06
# 请求包
**备注：如果是海外的pub转推任务，请将Host改为：pili-hw-pub.qiniuapi.com**
GET /tasks/<taskID>/runinfo
Host: pili-pub.qiniuapi.com
Authorization: <QiniuToken>
参数名称 | 必填 | 说明
---|---|---
taskID | 是 | 任务id。
# 返回包
200 {
"out": ""
}
400 {
"error": "invalid parameter"
}
404 {
"error": "not fond"
}
500 {
"error": "query task fail"
}
500 {
"error": "no worker"
}
500 {
"error": "query task log fail"
}
# 返回参数
参数名称 | 类型 | 说明
---|---|---
out | 字符串 | 运行日志。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 3,984 |
任务历史记录 | 直播云 | [直播云](https://developer.qiniu.com/pili) > API 文档 > Pub API >任务历史记录
# 任务历史记录
最近更新时间: 2022-11-04 11:22:00
# 请求包
**备注：如果是海外的pub转推任务，请将Host改为：pili-hw-pub.qiniuapi.com**
GET /history?marker=<Marker>?limit=<Limit>&name=<Name>&start=<Start>&end=<End>
Host: pili-pub.qiniuapi.com
Authorization: <QiniuToken>
参数名称 | 必填 | 说明
---|---|---
marker | 否 | 字符串，定位符。
limit | 否 | 整型，限制数，上线1000。
name | 否 | 字符串，任务名称，前缀匹配。
start | 否 | 整型，开始时间，单位：毫秒。
end | 否 | 整型， 结束时间，单位：毫秒。
# 返回包
200 {
"marker": "",
"isEnd": true,
"histories" : [
{
"name": "name",
"startTime": 1667459219157,
"stopTime": 1667459220156,
"message": ""
}
]
}
400 {
"error": "invalid parameter"
}
500 {
"error": "query history fail"
}
# 返回参数
参数名称 | 类型 | 说明
---|---|---
marker | 字符串 | 定位标识。
isEnd | 布尔类型 | 是否结束。
histories | 对象数组 | 历史记录。
* 详细参数说明见[参数说明](https://developer.qiniu.com/pili/api/7326/parameters-that-pub)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > API 文档 > Pub API >任务历史记录
# 任务历史记录
最近更新时间: 2022-11-04 11:22:00
# 请求包
**备注：如果是海外的pub转推任务，请将Host改为：pili-hw-pub.qiniuapi.com**
GET /history?marker=<Marker>?limit=<Limit>&name=<Name>&start=<Start>&end=<End>
Host: pili-pub.qiniuapi.com
Authorization: <QiniuToken>
参数名称 | 必填 | 说明
---|---|---
marker | 否 | 字符串，定位符。
limit | 否 | 整型，限制数，上线1000。
name | 否 | 字符串，任务名称，前缀匹配。
start | 否 | 整型，开始时间，单位：毫秒。
end | 否 | 整型， 结束时间，单位：毫秒。
# 返回包
200 {
"marker": "",
"isEnd": true,
"histories" : [
{
"name": "name",
"startTime": 1667459219157,
"stopTime": 1667459220156,
"message": ""
}
]
}
400 {
"error": "invalid parameter"
}
500 {
"error": "query history fail"
}
# 返回参数
参数名称 | 类型 | 说明
---|---|---
marker | 字符串 | 定位标识。
isEnd | 布尔类型 | 是否结束。
histories | 对象数组 | 历史记录。
* 详细参数说明见[参数说明](https://developer.qiniu.com/pili/api/7326/parameters-that-pub)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 3,986 |
seek接口 | 直播云 | [直播云](https://developer.qiniu.com/pili) > API 文档 > Pub API >seek接口
# seek接口
最近更新时间: 2022-04-25 17:20:17
在服务端设置pub任务 seek。
# 请求包
**备注：如果是海外的pub转推任务，请将Host改为：pili-hw-pub.qiniuapi.com**
POST /tasks/<taskID>/seek
Host: pili-pub.qiniuapi.com
Authorization: <QiniuToken>
Content-Type: application/json
{
"index":0,
"seek":100
}
参数名称 | 必填 | 说明
---|---|---
index | 否 | int, sourceUrls索引号。
seek | 是 | int, seek位置,相对时间,单位: s。
# 返回包
200 {}
400 {
"error": "invalid parameter"
}
500 {
"error": "get worker fail"
}
500 {
"error": "no worker"
}
500 {
"error": "no workers available"
}
500 {
"error": "call worker fail"
}
500 {
"error": "add worker's task fail"
}
500 {
"error": "seek task fail"
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > API 文档 > Pub API >seek接口
# seek接口
最近更新时间: 2022-04-25 17:20:17
在服务端设置pub任务 seek。
# 请求包
**备注：如果是海外的pub转推任务，请将Host改为：pili-hw-pub.qiniuapi.com**
POST /tasks/<taskID>/seek
Host: pili-pub.qiniuapi.com
Authorization: <QiniuToken>
Content-Type: application/json
{
"index":0,
"seek":100
}
参数名称 | 必填 | 说明
---|---|---
index | 否 | int, sourceUrls索引号。
seek | 是 | int, seek位置,相对时间,单位: s。
# 返回包
200 {}
400 {
"error": "invalid parameter"
}
500 {
"error": "get worker fail"
}
500 {
"error": "no worker"
}
500 {
"error": "no workers available"
}
500 {
"error": "call worker fail"
}
500 {
"error": "add worker's task fail"
}
500 {
"error": "seek task fail"
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 3,988 |
参数说明 | 直播云 | [直播云](https://developer.qiniu.com/pili) > API 文档 > Pub API >参数说明
# 参数说明
最近更新时间: 2022-10-19 17:09:12
# 推拉流地址(pubUrl)详细参数
参数名称 | 是否必填 | 字段类型 | 取值范围 | 说明
---|---|---|---|---
url | 必填项 | string | - | 流地址
isp | 非必填项 | string | 电信，联通，移动 | 运营商，用于指定推拉流运营商ip，如果填写即为默认
seek | 非必填项 | int | - | seek值
videoType | 必填项 | 0:直播 1:点播 | 推流地址视频类型 |
rtspType | 非必填项 | 0:rtsp udp, 1:rtsp tcp | 拉流rtsp的传输类型，0表示udp传输类型的rtsp流；1表示tcp传输类型的rtsp流，默认参数为0 |
# 过滤条件(pubFilter)详细参数
参数名称 | 字段类型 | 取值范围 | 说明
---|---|---|---
area | string | 东北, 华北, 华中, 华东, 华南, 西北, 西南, 其它 | 地域，用于指定该地址的实例，执行任务
isp | string | 电信，联通，移动 | 运营商，过滤包含该运营商的实例
ips | string[] | pub对外ip地址 | ip地址列表，过滤包含该ip地址的实例
# 任务列表(list)详细参数
参数名称 | 字段类型 | 取值范围 | 说明
---|---|---|---
taskID | string | - | 任务ID
uid | int | - | 用户ID
name | string | - | 任务名称
desc | string | - | 任务描述
sourceUrls | 对象数组 | - | 源地址信息
forwardUrls | 对象数组 | - | 转推地址信息
filter | 对象 | - | 任务过滤条件
runType | string | normal 普通转推，seek seek转推 | 任务类型
status | string | pending 初始状态, running, stopped, failed, finished | 任务状态
deliverStartTime | int | - | 任务定时开始时间，单位：ms
deliverStopTime | int | - | 任务定时关闭时间，单位：ms
startTime | int | - | 任务开始时间，单位：ms
stopTime | int | - | 任务停止时间，单位：ms
loopTimes | int | - | 任务循环次数
retry | int | - | 剩余重试次数
retryTime | int | >=60 | 表示pub任务的总断流重试时间，pub任务转推中断后会在断流重试时间内不断进行重新连接，直至重连成功或者达到设定的总断流重试时间。在单位：s
# 任务历史(history)详细参数
参数名称 | 字段类型 | 取值范围 | 说明
---|---|---|---
name | string | - | 任务名称
startTime | int | - | 开始时间，ms
stopTime | int | - | 开始时间，ms
status | string | - | 任务状态
message | string | - | 输出日志
# 预加载(preload)详细参数
参数名称 | 字段类型 | 取值范围 | 说明
---|---|---|---
enable | bool | - | 是否开启预加载
preloadTime | int | 大于当前时间 | 预加载开始时间，ms，默认为定时任务开始时间前5min开始
# pub任务状态通知(statusCallback)详细参数
参数名称 | 字段类型 | 取值范围 | 说明
---|---|---|---
type | string | GET、FORM、JSON | 请求类型，为空表示不回调通知
url | string | | 用户自定义回调通知地址
vars | map | | 自定义配置回调参数，支持魔法变量（详见系统内置参数）
# 系统内置参数(statusCallback)
参数Value | 说明
---|---
$(taskID) | pub任务id
$(status) | pub任务状态
$(startTime) | 最新一次pub任务开始时间
$(stopTime) | 最新一次pub任务结束时间
$(params) | pub任务运行参数
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > API 文档 > Pub API >参数说明
# 参数说明
最近更新时间: 2022-10-19 17:09:12
# 推拉流地址(pubUrl)详细参数
参数名称 | 是否必填 | 字段类型 | 取值范围 | 说明
---|---|---|---|---
url | 必填项 | string | - | 流地址
isp | 非必填项 | string | 电信，联通，移动 | 运营商，用于指定推拉流运营商ip，如果填写即为默认
seek | 非必填项 | int | - | seek值
videoType | 必填项 | 0:直播 1:点播 | 推流地址视频类型 |
rtspType | 非必填项 | 0:rtsp udp, 1:rtsp tcp | 拉流rtsp的传输类型，0表示udp传输类型的rtsp流；1表示tcp传输类型的rtsp流，默认参数为0 |
# 过滤条件(pubFilter)详细参数
参数名称 | 字段类型 | 取值范围 | 说明
---|---|---|---
area | string | 东北, 华北, 华中, 华东, 华南, 西北, 西南, 其它 | 地域，用于指定该地址的实例，执行任务
isp | string | 电信，联通，移动 | 运营商，过滤包含该运营商的实例
ips | string[] | pub对外ip地址 | ip地址列表，过滤包含该ip地址的实例
# 任务列表(list)详细参数
参数名称 | 字段类型 | 取值范围 | 说明
---|---|---|---
taskID | string | - | 任务ID
uid | int | - | 用户ID
name | string | - | 任务名称
desc | string | - | 任务描述
sourceUrls | 对象数组 | - | 源地址信息
forwardUrls | 对象数组 | - | 转推地址信息
filter | 对象 | - | 任务过滤条件
runType | string | normal 普通转推，seek seek转推 | 任务类型
status | string | pending 初始状态, running, stopped, failed, finished | 任务状态
deliverStartTime | int | - | 任务定时开始时间，单位：ms
deliverStopTime | int | - | 任务定时关闭时间，单位：ms
startTime | int | - | 任务开始时间，单位：ms
stopTime | int | - | 任务停止时间，单位：ms
loopTimes | int | - | 任务循环次数
retry | int | - | 剩余重试次数
retryTime | int | >=60 | 表示pub任务的总断流重试时间，pub任务转推中断后会在断流重试时间内不断进行重新连接，直至重连成功或者达到设定的总断流重试时间。在单位：s
# 任务历史(history)详细参数
参数名称 | 字段类型 | 取值范围 | 说明
---|---|---|---
name | string | - | 任务名称
startTime | int | - | 开始时间，ms
stopTime | int | - | 开始时间，ms
status | string | - | 任务状态
message | string | - | 输出日志
# 预加载(preload)详细参数
参数名称 | 字段类型 | 取值范围 | 说明
---|---|---|---
enable | bool | - | 是否开启预加载
preloadTime | int | 大于当前时间 | 预加载开始时间，ms，默认为定时任务开始时间前5min开始
# pub任务状态通知(statusCallback)详细参数
参数名称 | 字段类型 | 取值范围 | 说明
---|---|---|---
type | string | GET、FORM、JSON | 请求类型，为空表示不回调通知
url | string | | 用户自定义回调通知地址
vars | map | | 自定义配置回调参数，支持魔法变量（详见系统内置参数）
# 系统内置参数(statusCallback)
参数Value | 说明
---|---
$(taskID) | pub任务id
$(status) | pub任务状态
$(startTime) | 最新一次pub任务开始时间
$(stopTime) | 最新一次pub任务结束时间
$(params) | pub任务运行参数
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 3,990 |
客户端 API | 直播云 | [直播云](https://developer.qiniu.com/pili) > API 文档 > 客户端 API
# 客户端 API
最近更新时间: 2023-03-20 17:17:01
直播客户端 API 参考
| 播放器 | 推流端
---|---|---
iOS 平台 | [QPlayer2-IOS __](https://developer.qiniu.com/pili/12225/qplayer2-ios-side)| [PLMediaStreamingKit __](http://cocoadocs.org/docsets/PLCameraStreamingKit/1.7.2/)
Android 平台 | [QPlayer2-Android __](https://developer.qiniu.com/pili/12214/qplayer2-android)| [PLDroidMediaStreaming __](http://pili-docs.cloudvdn.com/android-streaming/index.html)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > API 文档 > 客户端 API
# 客户端 API
最近更新时间: 2023-03-20 17:17:01
直播客户端 API 参考
| 播放器 | 推流端
---|---|---
iOS 平台 | [QPlayer2-IOS __](https://developer.qiniu.com/pili/12225/qplayer2-ios-side)| [PLMediaStreamingKit __](http://cocoadocs.org/docsets/PLCameraStreamingKit/1.7.2/)
Android 平台 | [QPlayer2-Android __](https://developer.qiniu.com/pili/12214/qplayer2-android)| [PLDroidMediaStreaming __](http://pili-docs.cloudvdn.com/android-streaming/index.html)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 3,996 |
服务端 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 服务端
# 服务端
最近更新时间: 2021-11-02 18:14:36
直播云相关功能已集成进七牛综合SDK，建议升级，原直播服务端SDK文档可见 [直播云服务端SDK历史版本
__](https://developer.qiniu.com/pili/1220/server-sdk)。
此 SDK 适用于 Go 1.10.0 及以上版本。此SDK可以帮助您快速接入七牛云直播服务，主要功能有：
1. 获取直播地址与签算结果
* 获取推流地址，包括RTMP推流地址与SRT推流地址
* 获取播放地址，包括RTMP、HLS和HDL(HTTP-FLV)播放地址
* 直播推流鉴权与播放时间戳防盗链签算方法
2. 直播空间管理
* 查询直播空间列表
* 查询直播空间信息
* 修改直播空间推流鉴权配置
* 修改直播空间hls低延迟配置
* 修改直播空间存储配置
* 修改直播空间封面配置
3. 域名管理
* 查询域名列表
* 查询域名信息
* 绑定直播域名
* 解绑直播域名
* 配置点播域名
* 修改域名证书配置
* 更新域名改写规则
4. 直播流管理
* 查询直播流列表
* 查询直播流信息
* 禁用直播流
* 查询在线流信息
* 批量查询在线流信息
* 查询直播流推流记录
* 录制直播回放
* 保存直播截图
* 修改直播流转码配置
5. 直播统计数据查询
* 查询直播上行流量
* 查询直播下行流量
* 查询直播转码使用量
* 查询直播鉴黄使用量
* 查询导播台使用量
* 查询Pub转推服务使用量
# 开源
* [Go SDK 项目地址 __](https://github.com/qiniu/go-sdk)
* [Go SDK 发布地址 __](https://github.com/qiniu/go-sdk/releases)
# 安装
推荐使用 go mod , `github.com/qiniu/go-sdk/v7` ，如 `require github.com/qiniu/go-
sdk/v7 v7.11.0`
# 鉴权
Go SDK
的所有的功能，都需要合法的授权。授权凭证的签算需要七牛账号下的一对有效的`AccessKey`和`SecretKey`，这对密钥可以通过如下步骤获得：
1. 登录 [七牛开发者平台 __](https://portal.qiniu.com/)。
2. 进入七牛 [个人中心/密钥管理 __](https://portal.qiniu.com/user/key)页面。
3. 在 密钥管理 页面，获取一对AccessKey/SecretKey。
# 直播地址与签算方法
## RTMP推流地址
获取RTMP推流地址
### 调用方法
func RTMPPublishURL(hub, domain, streamTitle string) string
### 参数说明
RTMPPublishURL 函数参数说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
hub | string | 是 | 直播空间名
domain | string | 是 | 推流域名
streamTitle | string | 是 | 直播流名
### 示例
rtmpPublishURL := RTMPPublishURL("testHub","testDomain","testStream")
## SRT推流地址
获取SRT推流地址
### 调用方法
func SRTPublishURL(hub, domain, streamTitle string) string
### 参数说明
SRTPublishURL 函数参数说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
hub | string | 是 | 直播空间名
domain | string | 是 | 推流域名
streamTitle | string | 是 | 直播流名
### 示例
srtPublishUrl := SRTPublishURL("testHub", "testDomain", "testStream")
## RTMP播放地址
获取RTMP播放地址
### 调用方法
func RTMPPlayURL(hub, domain, streamTitle string) string
### 参数说明
RTMPPlayURL 函数参数说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
hub | string | 是 | 直播空间名
domain | string | 是 | RTMP 播放域名
streamTitle | string | 是 | 直播流名
### 示例
rtmpPlayURL := RTMPPlayURL("testHub", "testDomain", "testStream")
## HLS播放地址
获取HLS播放地址
### 调用方法
func HLSPlayURL(hub, domain, streamTitle string) string
### 参数说明
HLSPlayURL 函数参数说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
hub | string | 是 | 直播空间名
domain | string | 是 | HLS 播放域名
streamTitle | string | 是 | 直播流名
### 示例
hlsPlayURL := HLSPlayURL("testHub", "testDomain", "testStream")
## HDL(HTTP-FLV)播放地址
获取HDL(HTTP-FLV)播放地址
### 调用方法
func HDLPlayURL(hub, domain, streamTitle string) string
### 参数说明
HDLPlayURL 函数参数说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
hub | string | 是 | 直播空间名
domain | string | 是 | HDL 播放域名
streamTitle | string | 是 | 直播流名
### 示例
flvPlayURL := HDLPlayURL("testHub", "testDomain", "testStream")
## 推流 URL 签算（直播鉴权）
获取推流地址签算结果
### 调用方法
func SignPublishURL(publishURL string, args SignPublishURLArgs) (string, error)
### 参数说明
SignPublishURL 函数参数说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
publishURL | string | 是 | 推流URL
args | SignPublishURLArgs | 是 | 推流URL生成签算参数
├─ SecurityType | string | 是 | 鉴权类型，支持鉴权规格为:
1、static: 静态鉴权；
2、expiry: 限时鉴权；
3、expiry_sk: 限时鉴权SK；
4、dynamic: 动态鉴权
├─ PublishKey | string | 否 | 推流鉴权秘钥，静态鉴权（static）、限时鉴权（expiry）、动态鉴权（dynamic） 类型必要参数
├─ ExpireAt | int64 | 否 | 签算URL过期时间，单位：秒。限时鉴权（expiry）、限时鉴权SK（expiry_sk） 类型必要参数
├─ Nonce | int | 否 | 随机数，要求每次推流请求的nonce值需要大于上一次推流请求的nonce值。动态鉴权（dynamic） 鉴权类型必要参数
├─ AccessKey | string | 否 | 访问密钥，限时鉴权SK（expiry_sk） 类型必要参数
├─ SecretKey | string | 否 | 访问密钥，限时鉴权SK（expiry_sk） 类型必要参数
### 示例
// manager 实例
manager := NewManager(ManagerConfig{
AppName: "live",
APIHost: APIHost,
APIHTTPScheme: APIHTTPSScheme,
AccessKey: "yourAccessKey",
SecretKey: "yourSecretKey",
Transport: http.DefaultTransport,
})
yourHub := "testHub"
yourPublishKey := "12345678" // 直播空间的推流鉴权密钥
hubInfo, err := manager.GetHubInfo(context.Background(), GetHubInfoRequest{Hub: yourHub})
if err != nil {
return err
}
rtmpPublishURL := RTMPPublishURL(yourHub, "testDomain", "testStream")
// 十分钟后过期
expireAt := time.Now().Add(10 * time.Minute).Unix()
// 此处假设直播空间推流鉴权方式为限时鉴权
signedRTMPPublishURL, err := SignPublishURL(rtmpPublishURL, SignPublishURLArgs{
SecurityType: hubInfo.PublishSecurity,
PublishKey: yourPublishKey,
ExpireAt: expireAt,
Nonce: 0, // 限时鉴权规格下，此参数可以忽略
AccessKey: "", // 非限时鉴权SK规格，此参数可以忽略
SecretKey: "", // 非限时鉴权SK规格，此参数可以忽略
})
if err != nil {
return err
}
// 此时可以使用签算后的 signedRTMPPublishURL 进行推流
## 播放 URL 签算（时间戳防盗链）
获取播放地址签算结果
### 调用方法
func SignPlayURL(playURL string, args SignPlayURLArgs) (string, error)
### 参数说明
SignPlayURL 函数参数说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
playURL | string | 是 | 播放URL
args | SignPlayURLArgs | 是 | 播放URL签算参数
├─ SecurityType | string | 是 | 鉴权类型，支持鉴权类型为：
1、tsStartMD5 时间戳防盗链开始时间限制
2、tsExpireMD5 时间戳防盗链结束时间限制
├─ Key | string | 是 | 密钥
├─ Timestamp | int64 | 是 | 时间戳，单位：秒
鉴权类型为 tsStartMD5 时，表示鉴权开始时间
鉴权类型为 tsExpireMD5 时，表示鉴权结束时间
├─ Rule | string | 是 | 签名规则，支持魔法变量的规则，最终签算结果为所有变量的md5。魔法变量如下：
1、 $(key): 密钥
2、 $(path): URL 中的 path 部分
3、$(streamKey): URL 中的 hub/stream 部分
4、 $(streamTitle): URL 中的 stream 部分
5、 $(path_): URL 中的 path 部分， 表示 path 层级
6、 $(_): URL 中的 query 字段，举例: key1=val，魔法变量中使用 $(_key1) 表示 val
├─ TsPart | string | 是 | 时间戳字段，URL 中表示时间戳的字段名
├─ TsBase | int | 否 | 时间戳进制，可选进制格式为 2-36，即 2 进制到 36 进制，默认使用 16 进制
├─ SignPart | string | 是 | 签名字段，URL 中表示 token 的字段名
### 示例
// manager 实例
manager := NewManager(ManagerConfig{
AppName: "live",
APIHost: APIHost,
APIHTTPScheme: APIHTTPSScheme,
AccessKey: "yourAccessKey",
SecretKey: "yourSecretKey",
Transport: http.DefaultTransport,
})
yourHub := "testHub"
rtmpPlayDomain := "testDomain"
domainInfo, err := manager.GetDomainInfo(context.Background(), GetDomainInfoRequest{
Hub: yourHub,
Domain: rtmpPlayDomain,
})
if err != nil {
return err
}
rtmpPlayURL := RTMPPlayURL(yourHub, rtmpPlayDomain, "testStream")
// 假设域名播放鉴权类型为 tsStartMD5
signedRTMPPlayURL, err := SignPlayURL(rtmpPlayURL, SignPlayURLArgs{
SecurityType: domainInfo.PlaySecurity.Type,
Key: domainInfo.PlaySecurity.Key1,
Timestamp: time.Now().Unix(),
Rule: domainInfo.PlaySecurity.Rule,
TsPart: domainInfo.PlaySecurity.TsPart,
TsBase: domainInfo.PlaySecurity.TsBase,
SignPart: domainInfo.PlaySecurity.SignPart,
})
if err != nil {
return err
}
// 此时可以使用签算后的 signedRTMPPlayURL 进行播放
# 直播空间管理
## 查询直播空间列表
查询您所有的直播空间，结果以列表形式返回
### 调用方法
func (m *Manager) GetHubList(ctx context.Context) (*GetHubListResponse, error)
### 参数说明
GetHubListResponse 结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Items | []object | 否 | 直播空间列表
├─ Name | string | 否 | 直播空间名
### 示例
hubs, err := manager.GetHubList(ctx)
## 查询直播空间信息
查询目标直播空间信息，包括直播空间基本信息、绑定的域名列表、存储空间信息和直播空间配置信息
### 调用方法
func (m *Manager) GetHubInfo(ctx context.Context, req GetHubInfoRequest) (*GetHubInfoResponse, error)
### 参数说明
GetHubInfoRequest 结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Hub | string | 是 | 直播空间名
GetHubInfoResponse 结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Name | string | 否 | 直播空间名
CreatedAt | int64 | 否 | 创建时间
UpdatedAt | int64 | 否 | 更新时间
Domains | []object | 否 | 直播空间下的域名列表
├─ Type | string | 否 | 域名类型
├─ Domain | string | 否 | 域名
├─ Cname | string | 否 | CNAME
DefaultDomains | []object | 否 | 直播空间默认域名
├─ Type | string | 否 | 域名类型，包括：
publishRtmp：推流域名
liveRtmp：RTMP播放域名
liveHls：HLS播放域名
liveHdl：FLV播放域名
├─ Domain | string | 否 | 域名
StorageBucket | string | 否 | 与直播空间绑定的存储空间
LiveDataExpireDays | int64 | 否 | 存储过期时间，单位：天
PublishSecurity | string | 否 | 推流鉴权方式
Nrop | object | 否 | 鉴黄配置信息
├─ Enable | bool | 否 | 是否开启直播空间级别鉴黄功能
├─ Interval | int | 否 | 截帧间隔，每个流隔多久进行截帧并鉴黄，单位：秒
├─ NotifyURL | string | 否 | 回调 URL
├─NotifyRate | float64 | 否 | 通知阈值，鉴黄结果阈值表示AI模型判断当前直播画面有多大的概率涉黄，当鉴黄结果阈值大于或等于通知阈值时，将发送回调信息到回调URL
PassiveCodecProfiles | []string | 否 | 被动转码配置，形式如：720p
Converts | []string | 否 | 主动转码配置，形式如：720p
HlsPlus | bool | 否 | 是否开启 hls 低延迟
VodDomain | string | 否 | 点播域名
AccessLog | object | 否 | 直播日志保存信息
├─SaveBucket | string | 否 | 存储空间
├─ExpireDays | int | 否 | 过期天数
SnapshotInterval | int | 否 | 直播封面的截图间隔，单位：秒
### 示例
hub, err := manager.GetHubInfo(ctx, pili.GetHubInfoRequest{Hub: "yourHub"})
## 修改直播空间推流鉴权配置
修改目标直播空间的推流鉴权方式和密钥
### 调用方法
func (m *Manager) HubSecurity(ctx context.Context, req HubSecurityRequest) error
### 参数说明
HubSecurityRequest 结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Hub | string | 是 | 直播空间名
PublishSecurity | string | 是 | 鉴权方式，可选推流鉴权类型为： expiry: 限时鉴权、expiry_sk: 限时鉴权SK
PublishKey | string | 是 | 密钥
### 示例
err := manager.HubSecurity(ctx, pili.HubSecurityRequest)
## 修改直播空间hls低延迟配置
对目标直播空间下的直播流开启或关闭hls低延迟
### 调用方法
func (m *Manager) HubHlsplus(ctx context.Context, req HubHlsplusRequest) error
### 参数说明
HubHlsplusRequest 结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Hub | string | 是 | 直播空间名
HlsPlus | bool | 是 | 是否开启 hls 低延迟
### 示例
err := manager.HubHlsplus(ctx, pili.HubHlsplusRequest{Hub:"yourHub", HlsPlus: true,})
## 修改直播空间存储配置
修改目标直播空间绑定的存储空间，以及直播存储保存时间，绑定的存储空间需要预先在七牛云存储中创建
### 调用方法
func (m *Manager) HubPersistence(ctx context.Context, req HubPersistenceRequest) error
### 参数说明
HubPersistenceRequest 结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Hub | string | 是 | 直播空间名
StorageBucket | string | 是 | 存储空间，与直播空间绑定的存储空间需要满足以下两个条件：
\- 存储区域为华北
\- 存储空间的访问控制设置为公开
LiveDataExpireDays | uint | 是 | 存储过期时间，单位：天，取值范围为60 ~ 1095
根据国家相关规定，电商直播客户的直播存储时长需要为1095天
### 示例
err := manager.HubPersistence(ctx, HubPersistenceRequest{Hub:"testHub", StorageBucket:"testBucket", LiveDataExpireDays: 60,})
## 修改直播空间封面配置
设置目标直播空间下的直播流是否使用直播封面，以及修改封面更新时间间隔
### 调用方法
func (m *Manager) HubSnapshot(ctx context.Context, req HubSnapshotRequest) error
### 参数说明
HubSnapshotRequest 结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Hub | string | 是 | 直播空间名
SnapshotInterval | int | 是 | 间隔时间，单位：秒，设置为-1时为不开启封面
### 示例
err := manager.HubSnapshot(ctx, HubSnapshotRequest{Hub:"testHub", SnapshotInterval: 30,})
# 域名管理
## 查询域名列表
返回目标直播空间下的所有直播域名，以列表形式返回
### 调用方法
func (m *Manager) GetDomainsList(ctx context.Context, req GetDomainsListRequest) (*GetDomainsListResponse, error)
### 参数说明
GetDomainsListRequest 结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Hub | string | 是 | 直播空间名
GetDomainsListResponse 结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Domains | []object | 否 | 域名列表
├─ Type | string | 否 | 域名类型，包括：
publishRtmp：推流域名
liveRtmp：RTMP播放域名
liveHls：HLS播放域名
liveHdl：FLV播放域名
├─ Domain | string | 否 | 域名
├─ Cname | string | 否 | CNAME
├─CertEnable | bool | 否 | 是否配置 SSL 证书
├─ CertName | string | 否 | 证书名称
### 示例
list, err := manager.GetDomainsList(ctx, GetDomainsListRequest{Hub: "testHub"})
## 查询域名信息
查询目标直播域名基本信息和配置信息
### 调用方法
func (m *Manager) GetDomainInfo(ctx context.Context, req GetDomainInfoRequest) (*GetDomainInfoResponse, error)
### 参数说明
GetDomainInfoRequest 结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Hub | string | 是 | 直播空间名
Domain | string | 是 | 域名
GetDomainInfoResponse 结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Domain | string | 否 | 域名
Type | string | 否 | 域名类型
Cname | string | 否 | CNAME
ConnectCallback | object | 否 | 开播回调配置
├─ Type | string | 否 | 回调类型，可选回调类型为：
留空：不开启回调功能
GET：发送GET请求回调，请求参数携带在query中
FORM：发送POST请求回调，请求参数携带在body中，Content-Type 为 `application/x-www-form-
urlencoded`
JSON: 发送POST请求回调，请求参数携带在body中，Content-Type 为 `application/json`
├─ URL | string | 否 | 回调地址,支持魔法变量
├─ Timeout | int64 | 否 | 超时时间, 与回调地址的 HTTP 连接超时时间，单位：秒, 默认值为 2 秒，配置范围为 0~10 秒
├─ Vars | map[string]string | 否 | 请求参数,支持魔法变量，至少需要一组请求参数，规则解析出错误的会设置成空字段
├─RetryTimes | int | 否 | 重试次数，选范围 0~5 次
├─RetryInterval | int | 否 | 重试间隔，可选范围 0~5 秒，单位：秒
├─SuccessCode | int | 否 | 回调成功的 http code，为 0 表示通配
├─ FailCode | int | 否 | 回调失败的 http code，为 0 表示通配，当 SuccessCode 不为 0 的情况下生效
DisconnectCallback | object | 否 | 断播回调配置
├─ Type | string | 否 | 回调类型，可选回调类型为：
留空：不开启回调功能
GET：发送GET请求回调，请求参数携带在query中
FORM：发送POST请求回调，请求参数携带在body中，Content-Type 为 `application/x-www-form-
urlencoded`
JSON：发送POST请求回调，请求参数携带在body中，Content-Type 为 `application/json`
├─ URL | string | 否 | 回调地址,支持魔法变量
├─ Timeout | int64 | 否 | 超时时间, 与回调地址的 HTTP 连接超时时间，单位：秒, 默认值为 2 秒，配置范围为 0~10 秒
├─ Vars | map[string]string | 否 | 请求参数,支持魔法变量，至少需要一组请求参数，规则解析出错误的会设置成空字段
├─RetryTimes | int | 否 | 重试次数，选范围 0~5 次
├─RetryInterval | int | 否 | 重试间隔，可选范围 0~5 秒，单位：秒
├─SuccessCode | int | 否 | 回调成功的 http code，为 0 表示通配
├─ FailCode | int | 否 | 回调失败的 http code，为 0 表示通配，当 SuccessCode 不为 0 的情况下生效
IPLimit | object | 否 | IP 访问限制
├─ WhiteList | []string | 否 | 白名单，允许推拉流的 IP 列表（CIDR 类型），配置白名单后，黑名单列表将失效
├─ BlackList | []string | 否 | 黑名单，限制推拉流的 IP 列表（CIDR 类型）
PlaySecurity | object | 否 | 时间戳防盗链配置
├─ Type | string | 否 | 防盗链类型，可选防盗链类型为：
留空：默认类型，表示继承直播空间级别配置
none：表示关闭鉴权
tsStartMD5：有效时间从 `TsPart` 表示的时间戳开始，到 `Range` 秒后截止
tsExpireMD5：有效时间从现在当前到 `TsPart` 表示的时间戳为止
├─ Key1 | string | 否 | 主密钥
├─ Key2 | string | 否 | 副密钥， 两个密钥将同时生效，便于线上业务替换密钥
├─ Range | int | 否 | 有效时间，当 防盗链类型 为 `tsStartMD5` 时生效，单位：秒
├─ Rule | string | 否 | 签名规则，支持魔法变量的规则，最终签算结果为所有变量的MD5，魔法变量如下：
$(key)：用户定义的密钥
$(path)：URL中的 `path` 部分
$(streamKey)：URL中的 `hub/stream` 部分
$(streamTitle)：URL中的 `stream` 部分
$(_query)：下划线开头为URL中 `query` 字段
├─ Rule2 | string | 否 | 签名规则2，两个签名规则将同时生效，便于线上业务更换签名规则
├─ TsPart | string | 否 | 时间戳字段，URL中表示时间戳的字段名
├─ TsBase | int | 否 | 时间戳进制，可选进制格式为 2-36，即 2 进制到 36 进制，默认使用16进制
├─ SignPart | string | 否 | 签名字段，URL中表示token的字段名
├─GapDuration | int | 否 | 时间误差值，针对 tsExpireMD5 生效，避免因签算方与服务器本地时间误差造成的鉴权失败
DisconnectDelay | int64 | 否 | 断流延迟配置，单位：秒，针对直播流短时间内闪断重连的情况，不触发断流回调，避免因为短时间内频繁断流造成大量回调
UrlRewrite | object | 否 | URL 改写规则
├─ Rules | []object | 否 | 改写规则列表
CertEnable | bool | 否 | 是否配置 SSL 证书
CertName | string | 否 | 证书名称
Disable | bool | 否 | 域名是否为禁用状态
### 示例
info, err := manager.GetDomainInfo(ctx, GetDomainInfoRequest{Hub:"testHub", Domain: "pili-publish.test.cloudvdn.com",})
## 绑定直播域名
添加直播域名到目标直播空间，包括推流域名与RTMP、HLS、HDL播放域名，绑定之后可以使用此域名推流或播放
### 调用方法
func (m *Manager) BindDomain(ctx context.Context, req BindDomainRequest) error
### 参数说明
BindDomainRequest 结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Hub | string | 是 | 直播空间名
Domain | string | 是 | 域名
Type | string | 是 | 域名类型，可选域名类型为：
publishRtmp：推流域名
liveRtmp：RTMP播放域名
liveHls：HLS播放域名
liveHdl：FLV播放域名
### 示例
err := manager.BindDomain(ctx, BindDomainRequest{Hub:"testHub", Domain:"pili-publish.go-sdk.cloudvdn.com", Type:liveRtmp,})
## 解绑直播域名
将已经绑定的直播域名从目标直播空间解绑，之后无法使用此域名推流或播放
### 调用方法
func (m *Manager) UnbindDomain(ctx context.Context, req UnbindDomainRequest) error
### 参数说明
UnbindDomainRequest 结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Hub | string | 是 | 直播空间名
Domain | string | 是 | 域名
### 示例
err := manager.UnbindDomain(ctx, UnbindDomainRequest{Hub:"testHub", Domain:"pili-publish.go-sdk.cloudvdn.com",})
## 配置点播域名
点播域名用于访问直播空间对应的存储空间中的内容，例如回放、截图文件
请在相应存储空间配置好可用域名后，将其绑定到直播空间。若未正确配置点播域名，可能无法正常使用回放录制、保存截图等功能
### 调用方法
func (m *Manager) BindVodDomain(ctx context.Context, req BindVodDomainRequest) error
### 参数说明
BindVodDomainRequest 结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Hub | string | 是 | 直播空间名
VodDomain | string | 是 | 点播域名
### 示例
err := manager.BindVodDomain(ctx, BindVodDomainRequest{Hub:"testHub", VodDomain:"pili-vod.test.cloudvdn.com",})
## 修改域名证书配置
修改域名证书配置，需要提前将证书配置到七牛 CDN 服务中，证书配置地址: https://portal.qiniu.com/certificate/ssl
配置好证书后可以获得证书名称的参数，此时可以使用获得的证书名称请求执行修改域名证书配置
### 调用方法
func (m *Manager) SetDomainCert(ctx context.Context, req SetDomainCertRequest) error
### 参数说明
SetDomainCertRequest 结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Hub | string | 是 | 直播空间名
Domain | string | 是 | 域名
CertName | string | 是 | 证书名称，需要将证书配置到七牛 CDN 服务中
### 示例
err := manager.SetDomainCert(ctx, SetDomainCertRequest{Hub:"testHub", Domain:"pili-publish.gtest.cloudvdn.com", CertName:"5f1e9df7f9537d6b37000010",})
## 更新域名改写规则
可根据业务需求自定义推拉流URL，改写后的URL应符合七牛的直播URL规范:
`<scheme>://<domain>/<hub>/<stream>[.<ext>]?<query>`
### 调用方法
func (m *Manager) SetDomainURLRewrite(ctx context.Context, req SetDomainURLRewriteRequest) error
### 参数说明
SetDomainURLRewriteRequest 结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Hub | string | 是 | 直播空间名
Domain | string | 是 | 域名
Rules | []object | 是 | URL 改写规则列表
├─ Pattern | string | 是 | 匹配规则，针对完整URL的正则表达式，形式如：`(.+)/live/(.+)/playlist.m3u8`，括号中的内容允许在 Replacement 中使用${n}引用（n表示括号顺序）
├─ Replace | string | 是 | 改写规则，希望得到的改写结果，形式如：`${1}/hub/${2}.m3u8`，改写后的URL应符合七牛的直播URL规范：`<scheme>://<domain>/<hub>/<stream>[<ext>]?<query>`
### 示例
req := pili.SetDomainURLRewriteRequest{
Hub: "testhub",
Domain: "pili-publish.test.cloudvdn.com",
Rules: []pili.DomainURLRewriteRule{
{
Pattern: "(.+)/test/(.+)",
Replace: "${1}/test/live/${2}",
},
},
}
err := manager.SetDomainURLRewrite(ctx, req)
# 直播流管理
## 查询直播流列表
查询目标直播空间下的直播流列表，可以根据直播流在线状态和直播流名称进行筛选
### 调用方法
func (m *Manager) GetStreamsList(ctx context.Context, req GetStreamListRequest) (*GetStreamsListResponse, error)
### 参数说明
GetStreamListRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Hub | string | 是 | 直播空间名
Liveonly | bool | 否 | 只返回当前在线的直播流只返回当前在线的流，true 表示查询的是正在直播的流，不指定表示返回所有的流
Prefix | string | 否 | 直播流名称前缀匹配
Limit | int | 否 | 返回值数量限制，取值范围为0～5000
Marker | string | 否 | 游标，从该位置开始返回
GetStreamsListResponse结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Items | []GetStreamsListResponseItem | 否 | 直播流列表
Marker | string | 否 | 游标，表示当前位置，若marker为空，表示遍历完成
GetStreamsListResponseItem结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Key | string | 否 | 直播流名
### 示例
a, err := manager.GetStreamsList(context.Background(), GetStreamListRequest{Hub: TestHub, LiveOnly: true, Limit: 10})
## 查询直播流信息
查询目标直播流基本信息和配置信息
### 调用方法
func (m *Manager) GetStreamBaseInfo(ctx context.Context, req GetStreamBaseInfoRequest) (*GetStreamBaseInfoResponse, error)
### 参数说明
GetStreamBaseInfoRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Hub | string | 是 | 直播空间名
Stream | string | 是 | 直播流名
GetStreamBaseInfoResponse结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
CreatedAt | int64 | 否 | 直播流创建时间，Unix 时间戳
UpdatedAt | int64 | 否 | 直播流更新时间，Unix 时间戳，对一个流的配置做修改操作会更新这个值
ExpireAt | int64 | 否 | 直播流过期时间，默认流过期时间15天，Unix 时间戳，过期的流会被自动清除。如您设置的默认存储过期时间是 N 天，那么一个流持续 N 天不推流就会被自动清除
DisabledTill | int | 否 | 禁播结束时间，Unix 时间戳，-1 表示永久禁播
Converts | []string | 否 | 转码配置
Watermark | bool | 否 | 是否开启水印
PublishSecurity | string | 否 | 推流鉴权类型
PublishKey | string | 否 | 推流密钥
NropEnable | bool | 否 | 是否开启鉴黄
### 示例
a, err := manager.GetStreamBaseInfo(context.Background(), GetStreamBaseInfoRequest{Hub: TestHub, Stream: TestStream})
## 禁用直播流
禁播或者解禁目标直播流，支持限时禁播或永久禁播
### 调用方法
func (m *Manager) StreamDisable(ctx context.Context, req StreamDisabledRequest) error
### 参数说明
StreamDisabledRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Hub | string | 是 | 直播空间名
Stream | string | 是 | 直播流名
DisabledTill | int | 否 | 禁播结束时间，Unix 时间戳，特殊值含义： -1 永久禁播；0 解除禁播
DisablePeriodSecond | int | 否 | 禁播时长，单位：秒，当 DisabledTill 为0时，DisablePeriodSecond 参数生效，值大于等于0
### 示例
err := manager.StreamDisable(context.Background(), StreamDisabledRequest{
Hub: TestHub,
Stream: TestStream,
DisablePeriodSecond: 60,
})
## 查询在线流信息
查询直播开始时间、主播IP、当前码率、当前帧率等信息
### 调用方法
func (m *Manager) GetStreamLiveStatus(ctx context.Context, req GetStreamLiveStatusRequest) (*GetStreamLiveStatusResponse, error)
### 参数说明
GetStreamLiveStatusRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Hub | string | 是 | 直播空间名
Stream | string | 是 | 直播流名
GetStreamLiveStatusResponse结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
StreamLiveStatus | StreamLiveStatus | 否 | 直播流实时状态
VideoBitRate | int | 否 | 视频码率，单位：bps
AudioBitRate | int | 否 | 音频码率，单位：bps
StreamLiveStatus结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
ServerIP | string | 否 | 服务端IP
ClientIP | string | 否 | 推流端IP
StartAt | int64 | 否 | 推流开始时间，Unix 时间戳
Key | string | 否 | 直播流名
StreamLiveStatusFPS结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Audio | int | 否 | 音频帧率
Video | int | 否 | 视频帧率
Data | int | 否 | metadata帧率
### 示例
a, err := manager.GetStreamLiveStatus(context.Background(), GetStreamLiveStatusRequest{Hub: TestHub, Stream: TestStream})
## 批量查询在线流信息
批量查询直播的开始时间、主播IP、当前码率、当前帧率等信息
### 调用方法
func (m *Manager) BatchGetStreamLiveStatus(ctx context.Context, req BatchGetStreamLiveStatusRequest) (*BatchGetStreamLiveStatusResponse, error)
### 参数说明
BatchGetStreamLiveStatusRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Hub | string | 是 | 直播空间名
Items | []string | 否 | 直播流列表，查询流列表数量不超过100
BatchGetStreamLiveStatusResponse结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Items | []StreamLiveStatus | 否 | 直播流列表
StreamLiveStatus结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
StartAt | int64 | 否 | 推流开始时间，Unix 时间戳
ServerIP | string | 否 | 服务端IP
ClientIP | string | 否 | 推流端IP
BPS | int | 否 | 推流码率
FPS | StreamLiveStatusFPS | 否 | 帧率
Key | string | 否 | 直播流名
StreamLiveStatusFPS结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Audio | int | 否 | 音频帧率
Video | int | 否 | 视频帧率
Data | int | 否 | metadata帧率
### 示例
a, err := manager.BatchGetStreamLiveStatus(context.Background(), BatchGetStreamLiveStatusRequest{
Hub: TestHub,
Items: []string{TestStream},
})
## 查询直播流推流记录
查询目标直播流在一段时间内的推流记录
### 调用方法
func (m *Manager) GetStreamHistory(ctx context.Context, req GetStreamHistoryRequest) (*GetStreamHistoryResponse, error)
### 参数说明
GetStreamHistoryRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Hub | string | 是 | 直播空间名
Stream | string | 是 | 直播流名
Start | int64 | 否 | 开始时间，单位：秒，默认为0
End | int64 | 否 | 结束时间，单位：秒，默认为当前时间
GetStreamHistoryResponse结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Items | []GetStreamHistoryItem | 否 | 直播空间名
GetStreamHistoryItem结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Start | int64 | 否 | 推流开始时间
End | int64 | 否 | 推流结束时间
ClientIP | string | 否 | 推流端IP
ServerIP | string | 否 | 服务端IP
### 示例
a, err := manager.GetStreamHistory(context.Background(), GetStreamHistoryRequest{
Hub: TestHub,
Stream: TestStream,
Start: time.Now().Add(-1 * time.Hour).Unix(),
End: time.Now().Unix(),
})
## 录制直播回放
录制目标直播流一段时间内的直播为回放文件保存在存储空间中，可选回放文件的格式有m3u8、flv和mp4。其中录制为 flv、mp4
格式需要使用多媒体处理转码服务，录制过程需要一定时间。多媒体处理服务独立计费，使用会额外产生费用，详细费用请参考 [价格表
__](https://portal.qiniu.com/financial/price)
### 调用方法
func (m *Manager) StreamSaveas(ctx context.Context, req StreamSaveasRequest) (*StreamSaveasResponse, error)
### 参数说明
StreamSaveasRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Hub | string | 是 | 直播空间名
Stream | string | 是 | 直播流名
Start | int64 | 否 | 开始时间，Unix 时间戳，默认为第一次直播开始时间
End | int64 | 否 | 结束时间，Unix 时间戳，默认为当前时间
Fname | string | 否 | 文件名，为空时会随机生成一个文件名
Format | string | 否 | 文件格式，可选文件格式为
m3u8：HLS格式，默认值
flv：FLV格式，将回放切片转封装为单个flv文件，异步模式
mp4：MP4格式，将回放切片转封装为单个mp4文件，异步模式
异步模式下，生成回放文件需要一定时间
Pipeline | string | 否 | 异步模式时，指定数据处理的队列，可以将优先级较高的任务配置到独立的队列中进行执行，参考文档：[流媒体队列 __](https://developer.qiniu.com/dora/kb/2500/streaming-media-queue-about-seven-cows)
Notify | string | 否 | 回调地址，异步模式完成任务后的回调通知地址，不指定表示不做回调，参考文档：[状态查询 __](https://developer.qiniu.com/dora/1294/persistent-processing-status-query-prefop)
ExpireDays | int | 否 | 切片文件的生命周期：
0：默认值，表示修改ts文件生命周期为永久保存
>0：表示修改ts文件的的生命周期为 `ExpireDays` 参数值
-1：表示不修改ts文件的expire属性，可显著提升接口响应速度
PersistentDeleteAfterDays | int | 否 | 生成文件的生命周期：
0：默认值，表示生成文件（m3u8/flv/mp4）永久保存
>0：表示生成文件（m3u8/flv/mp4）的生命周期为 `PersistentDeleteAfterDays` 参数值
注意，对于m3u8文件，只有当`ExpireDays`为-1时，`persistentDeleteAfterDays`才会生效
FirstTsType | byte | 否 | 过滤ts切片文件类型，部分非标准的直播流，在推流初期缺少视频帧或音频帧，过滤功能可以剔除这部分切片，
0：默认值，不做过滤
1：第一个ts切片需要是纯视频类型，不符合预期的ts切片将被跳过
2：第一个ts切片需要是纯音频类型，不符合预期的ts切片将被跳过
3：第一个ts切片需要是音视频类型，不符合预期的ts切片将被跳过
StreamSaveasResponse结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Fname | string | 否 | 文件名
Start | int64 | 否 | 开始时间，Unix 时间戳
End | int64 | 否 | 结束时间，Unix 时间戳
PersistentID | string | 否 | 异步任务ID
### 示例
m := StreamSaveasRequest{
Hub: "testhub",
Stream: "abcd",
Start: time.Now().Add(-5 * time.Hour).Unix(),
End: time.Now().Unix(),
Fname: "test",
ExpireDays: -1,
FirstTsType: 3,
}
a, err := manager.StreamSaveas(context.Background(), m)
## 保存直播截图
保存目标直播流在特定时间点的画面为图片，并保存在存储空间中。截图使用多媒体处理服务并独立计费，会额外产生费用，详细费用请参考 [价格表
__](https://portal.qiniu.com/financial/price)
### 调用方法
func (m *Manager) StreamSnapshot(ctx context.Context, req StreamSnapshotRequest) (*StreamSnapshotResponse, error)
### 参数说明
StreamSnapshotRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Hub | string | 是 | 直播空间名
Stream | string | 是 | 直播流名
Time | int | 否 | 截图时间，Unix 时间戳，不指定则为当前时间
Fname | string | 否 | 文件名，不指定系统会随机生成
Format | string | 否 | 文件格式，默认为jpg，可取值为jpg和png
Pipeline | string | 否 | 异步模式时，指定数据处理的队列，可以将优先级较高的任务配置到独立的队列中进行执行，参考文档：[流媒体队列 __](https://developer.qiniu.com/dora/kb/2500/streaming-media-queue-about-seven-cows)
Notify | string | 否 | 回调地址，若指定回调地址，则截图动作为异步模式
DeleteAfterDays | int | 否 | 生命周期，单位：天
默认值为0，表示截图文件永久保存
StreamSnapshotResponse结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Fname | string | 否 | 文件名
PersistentID | string | 否 | 异步任务ID
### 示例
ret, err := manager.StreamSnapshot(context.Background(), StreamSnapshotRequest{
Hub: "testhub",
Stream: "abcd",
Time: 1632810081,
Fname: "test",
DeleteAfterDays: 1,
})
## 修改直播流转码配置
设置目标直播流使用的转码配置，设置好转码配置的直播流在推流开始时会触发转码，推流过程中修改转码配置不会立即生效，需要重新推流。
在播放地址后面添加 `@<ProfileName>` 即可播放相应转码流，目前可转码的配置有 `480p` 和
`720p`。使用转码服务会产生额外费用，详情费用请参考 [价格表 __](https://www.qiniu.com/prices/pili)
### 调用方法
func (m *Manager) StreamConverts(ctx context.Context, req StreamConvertsRequest) error
### 参数说明
StreamConvertsRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Hub | string | 是 | 直播空间名
Stream | string | 是 | 直播流名
Converts | []string | 否 | 转码配置，如果提交的 ProfileName 为空数组，那么之前的转码配置将被取消
如果需要配置水印，则需要以wmt_开头，下划线后加水印模版名
### 示例
err := manager.StreamConverts(context.Background(), StreamConvertsRequest{
Hub: TestHub,
Stream: TestStream,
Converts: []string{"480p", "720p"},
})
# 直播统计数据查询
## 查询直播上行流量
查询一段时间内目标直播空间、域名、区域的上行流量，延迟5分钟左右。
带宽数据可以从返回的流量数据`flow`转化，计算方法为`bandwidth=flow*8/300`
### 调用方法
func (m *Manager) GetStatUpflow(ctx context.Context, req GetStatUpflowRequest) ([]StatResponse, error)
### 参数说明
GetStatUpflowRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
GetStatCommonRequest | GetStatCommonRequest | 是 | 通用请求参数
Where | map[string][]string | 否 | 查询条件
Select | []string | 是 | 查询值
GetStatCommonRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Begin | string | 是 | 开始时间，支持格式：20060102、20060102150405
End | string | 是 | 结束时间，支持格式：20060102、20060102150405，超过当前时间，则以当前时间为准，时间范围为左闭右开区间
G | string | 是 | 时间粒度，可取值为 5min、hour、day、month
Where条件字段说明
参数名称 | 必填 | 说明
---|---|---
hub | 否 | 直播空间名
domain | 否 | 域名
area | 否 | 区域，可取值为 cn(中国大陆)、hk(香港)、tw(台湾)、apac(亚太)、am(美洲)、emea(欧洲/中东/非洲)
Select值字段说明
参数名称 | 必填 | 说明
---|---|---
flow | 是 | 流量，单位：byte，带宽可以从流量转换，公式为 带宽=流量*8/时间粒度，单位：bps
StatResponse结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Time | time.Time | 否 | 时间
Values | map[string]int | 否 | 数据，形式如：“values”:{“flow”:4527162977}，其中"flow"对应select项
### 示例
a, err := manager.GetStatUpflow(context.Background(), GetStatUpflowRequest{
GetStatCommonRequest: GetStatCommonRequest{
Begin: "20210928",
End: "20210930",
G: "day",
},
Where: map[string][]string{"hub": {TestHub}, "area": {"!cn", "!hk"}},
})
## 分组查询直播上行流量
查询一段时间内目标直播空间、域名、区域的上行流量，按group分组，延迟5分钟左右。
带宽数据可以从返回的流量数据`flow`转化，计算方法为`bandwidth=flow*8/300`
### 调用方法
func (m *Manager) GroupStatUpflow(ctx context.Context, req GroupStatUpflowRequest) ([]StatGroupResponse, error)
### 参数说明
GroupStatUpflowRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
GetStatCommonRequest | GetStatCommonRequest | 是 | 通用请求参数
Group | string | 是 | 分组，取值范围为条件字段
Where | map[string][]string | 否 | 查询条件
Select | []string | 是 | 查询值
GetStatCommonRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Begin | string | 是 | 开始时间，支持格式：20060102、20060102150405
End | string | 是 | 结束时间，支持格式：20060102、20060102150405，超过当前时间，则以当前时间为准，时间范围为左闭右开区间
G | string | 是 | 时间粒度，可取值为 5min、hour、day、month
Where条件字段说明
参数名称 | 必填 | 说明
---|---|---
hub | 否 | 直播空间名
domain | 否 | 域名
area | 否 | 区域，可取值为 cn(中国大陆)、hk(香港)、tw(台湾)、apac(亚太)、am(美洲)、emea(欧洲/中东/非洲)
Select值字段说明
参数名称 | 必填 | 说明
---|---|---
flow | 是 | 流量，单位：byte，带宽可以从流量转换，公式为 带宽=流量*8/时间粒度，单位：bps
StatGroupResponse结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Time | time.Time | 否 | 时间
Values | map[string]map[string]int | 否 | 数据，形式如：“values”:{“SD”:{“flow”:4527162977}}，其中"SD"对应Group项，"flow"对应Select项
### 示例
a, err := manager.GroupStatUpflow(context.Background(), GroupStatUpflowRequest{
GetStatCommonRequest: GetStatCommonRequest{
Begin: "20210928",
End: "20210930",
G: "day",
},
Select: []string{"flow"},
Where: map[string][]string{"hub": {TestHub}},
Group: "domain",
})
## 查询直播下行流量
查询一段时间内目标直播空间、域名、区域的下行流量，延迟5分钟左右。
带宽数据可以从返回的流量数据`flow`转化，计算方法为`bandwidth=flow*8/300`
### 调用方法
func (m *Manager) GetStatDownflow(ctx context.Context, req GetStatDownflowRequest) ([]StatResponse, error)
### 参数说明
GetStatDownflowRequest结构体说明
参数名称 | 字段类型 | 是否必填 | 说明
---|---|---|---
GetStatCommonRequest | GetStatCommonRequest | 是 | 通用请求参数
Where | map[string][]string | 否 | 查询条件
Select | []string | 是 | 查询值
GetStatCommonRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Begin | string | 是 | 开始时间，支持格式：20060102、20060102150405
End | string | 是 | 结束时间，支持格式：20060102、20060102150405，超过当前时间，则以当前时间为准，时间范围为左闭右开区间
G | string | 是 | 时间粒度，可取值为 5min、hour、day、month
Where条件字段说明
参数名称 | 必填 | 说明
---|---|---
hub | 否 | 直播空间名
domain | 否 | 域名
area | 否 | 区域，可取值为 cn(中国大陆)、hk(香港)、tw(台湾)、apac(亚太)、am(美洲)、emea(欧洲/中东/非洲)
Select值字段说明
参数名称 | 必填 | 说明
---|---|---
flow | 是 | 流量，单位：byte，带宽可以从流量转换，公式为 带宽=流量*8/时间粒度，单位：bps
StatResponse结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Time | time.Time | 否 | 时间
Values | map[string]int | 否 | 数据，形式如：“values”:{“flow”:4527162977}，其中"flow"对应select项
### 示例
a, err := manager.GetStatDownflow(context.Background(), GetStatDownflowRequest{
GetStatCommonRequest: GetStatCommonRequest{
Begin: "20210928",
End: "20210930",
G: "day",
},
Select: []string{"flow"},
Where: map[string][]string{"hub": {TestHub}},
})
## 分组查询直播下行流量
查询一段时间内目标直播空间、域名、区域的下行流量，按group分组，延迟5分钟左右。
带宽数据可以从返回的流量数据`flow`转化，计算方法为`bandwidth=flow*8/300`
### 调用方法
func (m *Manager) GroupStatDownflow(ctx context.Context, req GroupStatDownflowRequest) ([]StatGroupResponse, error)
### 参数说明
GroupStatDownflowRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
GetStatCommonRequest | GetStatCommonRequest | 是 | 通用请求参数
Group | string | 是 | 分组，取值范围为条件字段
Where | map[string][]string | 否 | 查询条件
Select | []string | 是 | 查询值
GetStatCommonRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Begin | string | 是 | 开始时间，支持格式：20060102、20060102150405
End | string | 是 | 结束时间，支持格式：20060102、20060102150405，超过当前时间，则以当前时间为准，时间范围为左闭右开区间
G | string | 是 | 时间粒度，可取值为 5min、hour、day、month
Where条件字段说明
参数名称 | 必填 | 说明
---|---|---
hub | 否 | 直播空间名
domain | 否 | 域名
area | 否 | 区域，可取值为 cn(中国大陆)、hk(香港)、tw(台湾)、apac(亚太)、am(美洲)、emea(欧洲/中东/非洲)
Select值字段说明
参数名称 | 必填 | 说明
---|---|---
flow | 是 | 流量，单位：byte，带宽可以从流量转换，公式为 带宽=流量*8/时间粒度，单位：bps
StatGroupResponse结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Time | time.Time | 否 | 时间
Values | map[string]map[string]int | 否 | 数据，形式如：“values”:{“SD”:{“flow”:4527162977}}，其中"SD"对应Group项，"flow"对应Select项
### 示例
a, err := manager.GroupStatDownflow(context.Background(), GroupStatDownflowRequest{
GetStatCommonRequest: GetStatCommonRequest{
Begin: "20210928",
End: "20210930",
G: "day",
},
Select: []string{"flow"},
Where: map[string][]string{"hub": {TestHub}},
Group: "area",
})
## 查询直播转码使用量
查询一段时间内目标直播空间、转码配置的转码时长，延迟10分钟左右
### 调用方法
func (m *Manager) GetStatCodec(ctx context.Context, req GetStatCodecRequest) ([]StatResponse, error)
### 参数说明
GetStatCodecRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
GetStatCommonRequest | GetStatCommonRequest | 是 | 通用请求参数
Where | map[string][]string | 否 | 查询条件
Select | []string | 是 | 查询值
GetStatCommonRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Begin | string | 是 | 开始时间，支持格式：20060102、20060102150405
End | string | 是 | 结束时间，支持格式：20060102、20060102150405，超过当前时间，则以当前时间为准，时间范围为左闭右开区间
G | string | 是 | 时间粒度，可取值为 5min、hour、day、month
Where条件字段说明
参数名称 | 必填 | 说明
---|---|---
hub | 否 | 直播空间名
profile | 否 | 转码配置
Select值字段说明
参数名称 | 必填 | 说明
---|---|---
duration | 是 | 时长，单位：毫秒
StatResponse结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Time | time.Time | 否 | 时间
Values | map[string]int | 否 | 数据，形式如：“values”:{“duration”:4527162977}，其中"duration"对应select项
### 示例
a, err := manager.GetStatCodec(context.Background(), GetStatCodecRequest{
GetStatCommonRequest: GetStatCommonRequest{
Begin: "20210928",
End: "20210930",
G: "day",
},
Select: []string{"duration"},
Where: map[string][]string{"hub": {TestHub}, "profile": {"480p", "720p"}},
})
## 分组查询直播转码使用量
查询一段时间内目标直播空间、转码配置的转码时长，按group分组，延迟10分钟左右
### 调用方法
func (m *Manager) GroupStatCodec(ctx context.Context, req GroupStatCodecRequest) ([]StatGroupResponse, error)
### 参数说明
GroupStatCodecRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
GetStatCommonRequest | GetStatCommonRequest | 是 | 通用请求参数
Group | string | 是 | 分组，取值范围为条件字段
Where | map[string][]string | 否 | 查询条件
Select | []string | 是 | 查询值
GetStatCommonRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Begin | string | 是 | 开始时间，支持格式：20060102、20060102150405
End | string | 是 | 结束时间，支持格式：20060102、20060102150405，超过当前时间，则以当前时间为准，时间范围为左闭右开区间
G | string | 是 | 时间粒度，可取值为 5min、hour、day、month
Where条件字段说明
参数名称 | 必填 | 说明
---|---|---
hub | 否 | 直播空间名
profile | 否 | 转码配置
Select值字段说明
参数名称 | 必填 | 说明
---|---|---
duration | 是 | 时长，单位：毫秒
StatGroupResponse结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Time | time.Time | 否 | 时间
Values | map[string]map[string]int | 否 | 数据，形式如：“values”:{“SD”:{“duration”:4527162977}}，其中"SD"对应Group项，"duration"对应Select项
### 示例
a, err := manager.GroupStatCodec(context.Background(), GroupStatCodecRequest{
GetStatCommonRequest: GetStatCommonRequest{
Begin: "20210928",
End: "20210930",
G: "day",
},
Select: []string{"duration"},
Where: map[string][]string{"hub": {TestHub}, "profile": {"!480p"}},
Group: "profile",
})
## 查询直播鉴黄使用量
查询一段时间内目标直播空间的鉴黄次数，延迟10分钟左右
### 调用方法
func (m *Manager) GetStatNrop(ctx context.Context, req GetStatNropRequest) ([]StatResponse, error)
### 参数说明
GetStatNropRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
GetStatCommonRequest | GetStatCommonRequest | 是 | 通用请求参数
Where | map[string][]string | 否 | 查询条件
Select | []string | 是 | 查询值
GetStatCommonRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Begin | string | 是 | 开始时间，支持格式：20060102、20060102150405
End | string | 是 | 结束时间，支持格式：20060102、20060102150405，超过当前时间，则以当前时间为准，时间范围为左闭右开区间
G | string | 是 | 时间粒度，可取值为 5min、hour、day、month
Where条件字段说明
参数名称 | 必填 | 说明
---|---|---
hub | 否 | 直播空间名
assured | 否 | 鉴黄结果是否确定，true或false
Select值字段说明
参数名称 | 必填 | 说明
---|---|---
count | 是 | 鉴黄次数
StatResponse结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Time | time.Time | 否 | 时间
Values | map[string]int | 否 | 数据，形式如：“values”:{“count”:452}，其中"count"对应select项
### 示例
a, err := manager.GetStatNrop(context.Background(), GetStatNropRequest{
GetStatCommonRequest: GetStatCommonRequest{
Begin: "20210928",
End: "20210930",
G: "day",
},
Select: []string{"count"},
Where: map[string][]string{"hub": {"!" + TestHub}, "assured": {"false"}},
})
## 分组查询直播鉴黄使用量
查询一段时间内目标直播空间的鉴黄次数，按group分组，延迟10分钟左右
### 调用方法
func (m *Manager) GroupStatNrop(ctx context.Context, req GroupStatNropRequest) ([]StatGroupResponse, error)
### 参数说明
GroupStatNropRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
GetStatCommonRequest | GetStatCommonRequest | 是 | 通用请求参数
Group | string | 是 | 分组，取值范围为条件字段
Where | map[string][]string | 否 | 查询条件
Select | []string | 是 | 查询值
GetStatCommonRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Begin | string | 是 | 开始时间，支持格式：20060102、20060102150405
End | string | 是 | 结束时间，支持格式：20060102、20060102150405，超过当前时间，则以当前时间为准，时间范围为左闭右开区间
G | string | 是 | 时间粒度，可取值为 5min、hour、day、month
Where条件字段说明
参数名称 | 必填 | 说明
---|---|---
hub | 否 | 直播空间名
assured | 否 | 鉴黄结果是否确定，true或false
Select值字段说明
参数名称 | 必填 | 说明
---|---|---
count | 是 | 鉴黄次数
StatGroupResponse结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Time | time.Time | 否 | 时间
Values | map[string]map[string]int | 否 | 数据，形式如：“values”:{“SD”:{“count”:4527162977}}，其中"SD"对应Group项，"count"对应Select项
### 示例
a, err := manager.GroupStatNrop(context.Background(), GroupStatNropRequest{
GetStatCommonRequest: GetStatCommonRequest{
Begin: "20210928",
End: "20210930",
G: "day",
},
Select: []string{"count"},
Where: map[string][]string{"hub": {"!"+TestHub}, "assured": {"false", "true"}},
Group: "hub",
})
## 查询导播台使用量
查询一段时间内导播台使用时长，延迟分钟级
### 调用方法
func (m *Manager) GetStatCaster(ctx context.Context, req GetStatCasterRequest) ([]StatResponse, error)
### 参数说明
GetStatCasterRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
GetStatCommonRequest | GetStatCommonRequest | 是 | 通用请求参数
Where | map[string][]string | 否 | 查询条件
Select | []string | 是 | 查询值
GetStatCommonRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Begin | string | 是 | 开始时间，支持格式：20060102、20060102150405
End | string | 是 | 结束时间，支持格式：20060102、20060102150405，超过当前时间，则以当前时间为准，时间范围为左闭右开区间
G | string | 是 | 时间粒度，可取值为 5min、hour、day、month
Where条件字段说明
参数名称 | 必填 | 说明
---|---|---
container | 否 | 容器
resolution | 否 | 分辨率
Select值字段说明
参数名称 | 必填 | 说明
---|---|---
upflow | 否 | 上行流量，单位：byte
downflow | 否 | 下行流量，单位：byte
duration | 否 | 使用时长，单位：秒
StatResponse结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Time | time.Time | 否 | 时间
Values | map[string]int | 否 | 数据，形式如：“values”:{“upflow”:4527162977}，其中"upflow"对应select项
### 示例
a, err := manager.GetStatCaster(context.Background(), GetStatCasterRequest{
GetStatCommonRequest: GetStatCommonRequest{
Begin: "20211024",
End: "20211026",
G: "day",
},
Select: []string{"upflow", "downflow", "duration"},
Where: map[string][]string{},
})
## 分组查询导播台使用量
查询一段时间内导播台使用时长，按group分组，延迟分钟级
### 调用方法
func (m *Manager) GroupStatCaster(ctx context.Context, req GroupStatCasterRequest) ([]StatGroupResponse, error)
### 参数说明
GroupStatCasterRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
GetStatCommonRequest | GetStatCommonRequest | 是 | 通用请求参数
Group | string | 是 | 分组，取值范围为条件字段
Where | map[string][]string | 否 | 查询条件
Select | []string | 是 | 查询值
GetStatCommonRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Begin | string | 是 | 开始时间，支持格式：20060102、20060102150405
End | string | 是 | 结束时间，支持格式：20060102、20060102150405，超过当前时间，则以当前时间为准，时间范围为左闭右开区间
G | string | 是 | 时间粒度，可取值为 5min、hour、day、month
Where条件字段说明
参数名称 | 必填 | 说明
---|---|---
container | 否 | 容器
resolution | 否 | 分辨率
Select值字段说明
参数名称 | 必填 | 说明
---|---|---
upflow | 否 | 上行流量，单位：byte
downflow | 否 | 下行流量，单位：byte
duration | 否 | 使用时长，单位：秒
StatGroupResponse结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Time | time.Time | 否 | 时间
Values | map[string]map[string]int | 否 | 数据，形式如：“values”:{“SD”:{“upflow”:4527162977}}，其中"SD"对应Group项，"upflow"对应Select项
### 示例
a, err := manager.GroupStatCaster(context.Background(), GroupStatCasterRequest{
GetStatCommonRequest: GetStatCommonRequest{
Begin: "20210928",
End: "20210930",
G: "day",
},
Select: []string{"upflow"},
Group: "resolution",
})
## 查询Pub转推服务使用量
查询一段时间内转推服务的使用时长和次数，延迟10分钟内
### 调用方法
func (m *Manager) GetStatPub(ctx context.Context, req GetStatPubRequest) ([]StatResponse, error)
### 参数说明
GetStatPubRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
GetStatCommonRequest | GetStatCommonRequest | 是 | 通用请求参数
Where | map[string][]string | 否 | 查询条件
Select | []string | 是 | 查询值
GetStatCommonRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Begin | string | 是 | 开始时间，支持格式：20060102、20060102150405
End | string | 是 | 结束时间，支持格式：20060102、20060102150405，超过当前时间，则以当前时间为准，时间范围为左闭右开区间
G | string | 是 | 时间粒度，可取值为 5min、hour、day、month
Where条件字段说明
参数名称 | 必填 | 说明
---|---|---
tp | 否 | 状态，可选项 normal
Select值字段说明
参数名称 | 必填 | 说明
---|---|---
count | 否 | 转推次数
duration | 否 | 转推时长，单位：毫秒
StatResponse结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Time | time.Time | 否 | 时间
Values | map[string]int | 否 | 数据，形式如：“values”:{“flow”:4527162977}，其中"flow"对应select项
### 示例
a, err := manager.GetStatPub(context.Background(), GetStatPubRequest{
GetStatCommonRequest: GetStatCommonRequest{
Begin: "20211024",
End: "20211026",
G: "day",
},
Select: []string{"duration"},
Where: map[string][]string{},
})
## 分组查询Pub转推服务使用量
查询一段时间内转推服务的使用时长和次数，按group分组，延迟10分钟内
### 调用方法
func (m *Manager) GroupStatPub(ctx context.Context, req GroupStatPubRequest) ([]StatGroupResponse, error)
### 参数说明
GroupStatPubRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
GetStatCommonRequest | GetStatCommonRequest | 是 | 通用请求参数
Group | string | 是 | 分组，取值范围为条件字段
Where | map[string][]string | 否 | 查询条件
Select | []string | 是 | 查询值
GetStatCommonRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Begin | string | 是 | 开始时间，支持格式：20060102、20060102150405
End | string | 是 | 结束时间，支持格式：20060102、20060102150405，超过当前时间，则以当前时间为准，时间范围为左闭右开区间
G | string | 是 | 时间粒度，可取值为 5min、hour、day、month
Where条件字段说明
参数名称 | 必填 | 说明
---|---|---
tp | 否 | 状态，可选项 normal
Select值字段说明
参数名称 | 必填 | 说明
---|---|---
count | 否 | 转推次数
duration | 否 | 转推时长，单位：毫秒
StatGroupResponse结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Time | time.Time | 否 | 时间
Values | map[string]map[string]int | 否 | 数据，形式如：“values”:{“normal”:{“count”:4527162977}}，其中"normal"对应Group项，"count"对应Select项
### 示例
a, err := manager.GroupStatPub(context.Background(), GroupStatPubRequest{
GetStatCommonRequest: GetStatCommonRequest{
Begin: "20210928",
End: "20210930",
G: "hour",
},
Select: []string{"duration"},
Group: "tp",
})
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 服务端
# 服务端
最近更新时间: 2021-11-02 18:14:36
直播云相关功能已集成进七牛综合SDK，建议升级，原直播服务端SDK文档可见 [直播云服务端SDK历史版本
__](https://developer.qiniu.com/pili/1220/server-sdk)。
此 SDK 适用于 Go 1.10.0 及以上版本。此SDK可以帮助您快速接入七牛云直播服务，主要功能有：
1. 获取直播地址与签算结果
* 获取推流地址，包括RTMP推流地址与SRT推流地址
* 获取播放地址，包括RTMP、HLS和HDL(HTTP-FLV)播放地址
* 直播推流鉴权与播放时间戳防盗链签算方法
2. 直播空间管理
* 查询直播空间列表
* 查询直播空间信息
* 修改直播空间推流鉴权配置
* 修改直播空间hls低延迟配置
* 修改直播空间存储配置
* 修改直播空间封面配置
3. 域名管理
* 查询域名列表
* 查询域名信息
* 绑定直播域名
* 解绑直播域名
* 配置点播域名
* 修改域名证书配置
* 更新域名改写规则
4. 直播流管理
* 查询直播流列表
* 查询直播流信息
* 禁用直播流
* 查询在线流信息
* 批量查询在线流信息
* 查询直播流推流记录
* 录制直播回放
* 保存直播截图
* 修改直播流转码配置
5. 直播统计数据查询
* 查询直播上行流量
* 查询直播下行流量
* 查询直播转码使用量
* 查询直播鉴黄使用量
* 查询导播台使用量
* 查询Pub转推服务使用量
# 开源
* [Go SDK 项目地址 __](https://github.com/qiniu/go-sdk)
* [Go SDK 发布地址 __](https://github.com/qiniu/go-sdk/releases)
# 安装
推荐使用 go mod , `github.com/qiniu/go-sdk/v7` ，如 `require github.com/qiniu/go-
sdk/v7 v7.11.0`
# 鉴权
Go SDK
的所有的功能，都需要合法的授权。授权凭证的签算需要七牛账号下的一对有效的`AccessKey`和`SecretKey`，这对密钥可以通过如下步骤获得：
1. 登录 [七牛开发者平台 __](https://portal.qiniu.com/)。
2. 进入七牛 [个人中心/密钥管理 __](https://portal.qiniu.com/user/key)页面。
3. 在 密钥管理 页面，获取一对AccessKey/SecretKey。
# 直播地址与签算方法
## RTMP推流地址
获取RTMP推流地址
### 调用方法
func RTMPPublishURL(hub, domain, streamTitle string) string
### 参数说明
RTMPPublishURL 函数参数说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
hub | string | 是 | 直播空间名
domain | string | 是 | 推流域名
streamTitle | string | 是 | 直播流名
### 示例
rtmpPublishURL := RTMPPublishURL("testHub","testDomain","testStream")
## SRT推流地址
获取SRT推流地址
### 调用方法
func SRTPublishURL(hub, domain, streamTitle string) string
### 参数说明
SRTPublishURL 函数参数说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
hub | string | 是 | 直播空间名
domain | string | 是 | 推流域名
streamTitle | string | 是 | 直播流名
### 示例
srtPublishUrl := SRTPublishURL("testHub", "testDomain", "testStream")
## RTMP播放地址
获取RTMP播放地址
### 调用方法
func RTMPPlayURL(hub, domain, streamTitle string) string
### 参数说明
RTMPPlayURL 函数参数说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
hub | string | 是 | 直播空间名
domain | string | 是 | RTMP 播放域名
streamTitle | string | 是 | 直播流名
### 示例
rtmpPlayURL := RTMPPlayURL("testHub", "testDomain", "testStream")
## HLS播放地址
获取HLS播放地址
### 调用方法
func HLSPlayURL(hub, domain, streamTitle string) string
### 参数说明
HLSPlayURL 函数参数说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
hub | string | 是 | 直播空间名
domain | string | 是 | HLS 播放域名
streamTitle | string | 是 | 直播流名
### 示例
hlsPlayURL := HLSPlayURL("testHub", "testDomain", "testStream")
## HDL(HTTP-FLV)播放地址
获取HDL(HTTP-FLV)播放地址
### 调用方法
func HDLPlayURL(hub, domain, streamTitle string) string
### 参数说明
HDLPlayURL 函数参数说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
hub | string | 是 | 直播空间名
domain | string | 是 | HDL 播放域名
streamTitle | string | 是 | 直播流名
### 示例
flvPlayURL := HDLPlayURL("testHub", "testDomain", "testStream")
## 推流 URL 签算（直播鉴权）
获取推流地址签算结果
### 调用方法
func SignPublishURL(publishURL string, args SignPublishURLArgs) (string, error)
### 参数说明
SignPublishURL 函数参数说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
publishURL | string | 是 | 推流URL
args | SignPublishURLArgs | 是 | 推流URL生成签算参数
├─ SecurityType | string | 是 | 鉴权类型，支持鉴权规格为:
1、static: 静态鉴权；
2、expiry: 限时鉴权；
3、expiry_sk: 限时鉴权SK；
4、dynamic: 动态鉴权
├─ PublishKey | string | 否 | 推流鉴权秘钥，静态鉴权（static）、限时鉴权（expiry）、动态鉴权（dynamic） 类型必要参数
├─ ExpireAt | int64 | 否 | 签算URL过期时间，单位：秒。限时鉴权（expiry）、限时鉴权SK（expiry_sk） 类型必要参数
├─ Nonce | int | 否 | 随机数，要求每次推流请求的nonce值需要大于上一次推流请求的nonce值。动态鉴权（dynamic） 鉴权类型必要参数
├─ AccessKey | string | 否 | 访问密钥，限时鉴权SK（expiry_sk） 类型必要参数
├─ SecretKey | string | 否 | 访问密钥，限时鉴权SK（expiry_sk） 类型必要参数
### 示例
// manager 实例
manager := NewManager(ManagerConfig{
AppName: "live",
APIHost: APIHost,
APIHTTPScheme: APIHTTPSScheme,
AccessKey: "yourAccessKey",
SecretKey: "yourSecretKey",
Transport: http.DefaultTransport,
})
yourHub := "testHub"
yourPublishKey := "12345678" // 直播空间的推流鉴权密钥
hubInfo, err := manager.GetHubInfo(context.Background(), GetHubInfoRequest{Hub: yourHub})
if err != nil {
return err
}
rtmpPublishURL := RTMPPublishURL(yourHub, "testDomain", "testStream")
// 十分钟后过期
expireAt := time.Now().Add(10 * time.Minute).Unix()
// 此处假设直播空间推流鉴权方式为限时鉴权
signedRTMPPublishURL, err := SignPublishURL(rtmpPublishURL, SignPublishURLArgs{
SecurityType: hubInfo.PublishSecurity,
PublishKey: yourPublishKey,
ExpireAt: expireAt,
Nonce: 0, // 限时鉴权规格下，此参数可以忽略
AccessKey: "", // 非限时鉴权SK规格，此参数可以忽略
SecretKey: "", // 非限时鉴权SK规格，此参数可以忽略
})
if err != nil {
return err
}
// 此时可以使用签算后的 signedRTMPPublishURL 进行推流
## 播放 URL 签算（时间戳防盗链）
获取播放地址签算结果
### 调用方法
func SignPlayURL(playURL string, args SignPlayURLArgs) (string, error)
### 参数说明
SignPlayURL 函数参数说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
playURL | string | 是 | 播放URL
args | SignPlayURLArgs | 是 | 播放URL签算参数
├─ SecurityType | string | 是 | 鉴权类型，支持鉴权类型为：
1、tsStartMD5 时间戳防盗链开始时间限制
2、tsExpireMD5 时间戳防盗链结束时间限制
├─ Key | string | 是 | 密钥
├─ Timestamp | int64 | 是 | 时间戳，单位：秒
鉴权类型为 tsStartMD5 时，表示鉴权开始时间
鉴权类型为 tsExpireMD5 时，表示鉴权结束时间
├─ Rule | string | 是 | 签名规则，支持魔法变量的规则，最终签算结果为所有变量的md5。魔法变量如下：
1、 $(key): 密钥
2、 $(path): URL 中的 path 部分
3、$(streamKey): URL 中的 hub/stream 部分
4、 $(streamTitle): URL 中的 stream 部分
5、 $(path_): URL 中的 path 部分， 表示 path 层级
6、 $(_): URL 中的 query 字段，举例: key1=val，魔法变量中使用 $(_key1) 表示 val
├─ TsPart | string | 是 | 时间戳字段，URL 中表示时间戳的字段名
├─ TsBase | int | 否 | 时间戳进制，可选进制格式为 2-36，即 2 进制到 36 进制，默认使用 16 进制
├─ SignPart | string | 是 | 签名字段，URL 中表示 token 的字段名
### 示例
// manager 实例
manager := NewManager(ManagerConfig{
AppName: "live",
APIHost: APIHost,
APIHTTPScheme: APIHTTPSScheme,
AccessKey: "yourAccessKey",
SecretKey: "yourSecretKey",
Transport: http.DefaultTransport,
})
yourHub := "testHub"
rtmpPlayDomain := "testDomain"
domainInfo, err := manager.GetDomainInfo(context.Background(), GetDomainInfoRequest{
Hub: yourHub,
Domain: rtmpPlayDomain,
})
if err != nil {
return err
}
rtmpPlayURL := RTMPPlayURL(yourHub, rtmpPlayDomain, "testStream")
// 假设域名播放鉴权类型为 tsStartMD5
signedRTMPPlayURL, err := SignPlayURL(rtmpPlayURL, SignPlayURLArgs{
SecurityType: domainInfo.PlaySecurity.Type,
Key: domainInfo.PlaySecurity.Key1,
Timestamp: time.Now().Unix(),
Rule: domainInfo.PlaySecurity.Rule,
TsPart: domainInfo.PlaySecurity.TsPart,
TsBase: domainInfo.PlaySecurity.TsBase,
SignPart: domainInfo.PlaySecurity.SignPart,
})
if err != nil {
return err
}
// 此时可以使用签算后的 signedRTMPPlayURL 进行播放
# 直播空间管理
## 查询直播空间列表
查询您所有的直播空间，结果以列表形式返回
### 调用方法
func (m *Manager) GetHubList(ctx context.Context) (*GetHubListResponse, error)
### 参数说明
GetHubListResponse 结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Items | []object | 否 | 直播空间列表
├─ Name | string | 否 | 直播空间名
### 示例
hubs, err := manager.GetHubList(ctx)
## 查询直播空间信息
查询目标直播空间信息，包括直播空间基本信息、绑定的域名列表、存储空间信息和直播空间配置信息
### 调用方法
func (m *Manager) GetHubInfo(ctx context.Context, req GetHubInfoRequest) (*GetHubInfoResponse, error)
### 参数说明
GetHubInfoRequest 结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Hub | string | 是 | 直播空间名
GetHubInfoResponse 结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Name | string | 否 | 直播空间名
CreatedAt | int64 | 否 | 创建时间
UpdatedAt | int64 | 否 | 更新时间
Domains | []object | 否 | 直播空间下的域名列表
├─ Type | string | 否 | 域名类型
├─ Domain | string | 否 | 域名
├─ Cname | string | 否 | CNAME
DefaultDomains | []object | 否 | 直播空间默认域名
├─ Type | string | 否 | 域名类型，包括：
publishRtmp：推流域名
liveRtmp：RTMP播放域名
liveHls：HLS播放域名
liveHdl：FLV播放域名
├─ Domain | string | 否 | 域名
StorageBucket | string | 否 | 与直播空间绑定的存储空间
LiveDataExpireDays | int64 | 否 | 存储过期时间，单位：天
PublishSecurity | string | 否 | 推流鉴权方式
Nrop | object | 否 | 鉴黄配置信息
├─ Enable | bool | 否 | 是否开启直播空间级别鉴黄功能
├─ Interval | int | 否 | 截帧间隔，每个流隔多久进行截帧并鉴黄，单位：秒
├─ NotifyURL | string | 否 | 回调 URL
├─NotifyRate | float64 | 否 | 通知阈值，鉴黄结果阈值表示AI模型判断当前直播画面有多大的概率涉黄，当鉴黄结果阈值大于或等于通知阈值时，将发送回调信息到回调URL
PassiveCodecProfiles | []string | 否 | 被动转码配置，形式如：720p
Converts | []string | 否 | 主动转码配置，形式如：720p
HlsPlus | bool | 否 | 是否开启 hls 低延迟
VodDomain | string | 否 | 点播域名
AccessLog | object | 否 | 直播日志保存信息
├─SaveBucket | string | 否 | 存储空间
├─ExpireDays | int | 否 | 过期天数
SnapshotInterval | int | 否 | 直播封面的截图间隔，单位：秒
### 示例
hub, err := manager.GetHubInfo(ctx, pili.GetHubInfoRequest{Hub: "yourHub"})
## 修改直播空间推流鉴权配置
修改目标直播空间的推流鉴权方式和密钥
### 调用方法
func (m *Manager) HubSecurity(ctx context.Context, req HubSecurityRequest) error
### 参数说明
HubSecurityRequest 结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Hub | string | 是 | 直播空间名
PublishSecurity | string | 是 | 鉴权方式，可选推流鉴权类型为： expiry: 限时鉴权、expiry_sk: 限时鉴权SK
PublishKey | string | 是 | 密钥
### 示例
err := manager.HubSecurity(ctx, pili.HubSecurityRequest)
## 修改直播空间hls低延迟配置
对目标直播空间下的直播流开启或关闭hls低延迟
### 调用方法
func (m *Manager) HubHlsplus(ctx context.Context, req HubHlsplusRequest) error
### 参数说明
HubHlsplusRequest 结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Hub | string | 是 | 直播空间名
HlsPlus | bool | 是 | 是否开启 hls 低延迟
### 示例
err := manager.HubHlsplus(ctx, pili.HubHlsplusRequest{Hub:"yourHub", HlsPlus: true,})
## 修改直播空间存储配置
修改目标直播空间绑定的存储空间，以及直播存储保存时间，绑定的存储空间需要预先在七牛云存储中创建
### 调用方法
func (m *Manager) HubPersistence(ctx context.Context, req HubPersistenceRequest) error
### 参数说明
HubPersistenceRequest 结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Hub | string | 是 | 直播空间名
StorageBucket | string | 是 | 存储空间，与直播空间绑定的存储空间需要满足以下两个条件：
\- 存储区域为华北
\- 存储空间的访问控制设置为公开
LiveDataExpireDays | uint | 是 | 存储过期时间，单位：天，取值范围为60 ~ 1095
根据国家相关规定，电商直播客户的直播存储时长需要为1095天
### 示例
err := manager.HubPersistence(ctx, HubPersistenceRequest{Hub:"testHub", StorageBucket:"testBucket", LiveDataExpireDays: 60,})
## 修改直播空间封面配置
设置目标直播空间下的直播流是否使用直播封面，以及修改封面更新时间间隔
### 调用方法
func (m *Manager) HubSnapshot(ctx context.Context, req HubSnapshotRequest) error
### 参数说明
HubSnapshotRequest 结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Hub | string | 是 | 直播空间名
SnapshotInterval | int | 是 | 间隔时间，单位：秒，设置为-1时为不开启封面
### 示例
err := manager.HubSnapshot(ctx, HubSnapshotRequest{Hub:"testHub", SnapshotInterval: 30,})
# 域名管理
## 查询域名列表
返回目标直播空间下的所有直播域名，以列表形式返回
### 调用方法
func (m *Manager) GetDomainsList(ctx context.Context, req GetDomainsListRequest) (*GetDomainsListResponse, error)
### 参数说明
GetDomainsListRequest 结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Hub | string | 是 | 直播空间名
GetDomainsListResponse 结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Domains | []object | 否 | 域名列表
├─ Type | string | 否 | 域名类型，包括：
publishRtmp：推流域名
liveRtmp：RTMP播放域名
liveHls：HLS播放域名
liveHdl：FLV播放域名
├─ Domain | string | 否 | 域名
├─ Cname | string | 否 | CNAME
├─CertEnable | bool | 否 | 是否配置 SSL 证书
├─ CertName | string | 否 | 证书名称
### 示例
list, err := manager.GetDomainsList(ctx, GetDomainsListRequest{Hub: "testHub"})
## 查询域名信息
查询目标直播域名基本信息和配置信息
### 调用方法
func (m *Manager) GetDomainInfo(ctx context.Context, req GetDomainInfoRequest) (*GetDomainInfoResponse, error)
### 参数说明
GetDomainInfoRequest 结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Hub | string | 是 | 直播空间名
Domain | string | 是 | 域名
GetDomainInfoResponse 结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Domain | string | 否 | 域名
Type | string | 否 | 域名类型
Cname | string | 否 | CNAME
ConnectCallback | object | 否 | 开播回调配置
├─ Type | string | 否 | 回调类型，可选回调类型为：
留空：不开启回调功能
GET：发送GET请求回调，请求参数携带在query中
FORM：发送POST请求回调，请求参数携带在body中，Content-Type 为 `application/x-www-form-
urlencoded`
JSON: 发送POST请求回调，请求参数携带在body中，Content-Type 为 `application/json`
├─ URL | string | 否 | 回调地址,支持魔法变量
├─ Timeout | int64 | 否 | 超时时间, 与回调地址的 HTTP 连接超时时间，单位：秒, 默认值为 2 秒，配置范围为 0~10 秒
├─ Vars | map[string]string | 否 | 请求参数,支持魔法变量，至少需要一组请求参数，规则解析出错误的会设置成空字段
├─RetryTimes | int | 否 | 重试次数，选范围 0~5 次
├─RetryInterval | int | 否 | 重试间隔，可选范围 0~5 秒，单位：秒
├─SuccessCode | int | 否 | 回调成功的 http code，为 0 表示通配
├─ FailCode | int | 否 | 回调失败的 http code，为 0 表示通配，当 SuccessCode 不为 0 的情况下生效
DisconnectCallback | object | 否 | 断播回调配置
├─ Type | string | 否 | 回调类型，可选回调类型为：
留空：不开启回调功能
GET：发送GET请求回调，请求参数携带在query中
FORM：发送POST请求回调，请求参数携带在body中，Content-Type 为 `application/x-www-form-
urlencoded`
JSON：发送POST请求回调，请求参数携带在body中，Content-Type 为 `application/json`
├─ URL | string | 否 | 回调地址,支持魔法变量
├─ Timeout | int64 | 否 | 超时时间, 与回调地址的 HTTP 连接超时时间，单位：秒, 默认值为 2 秒，配置范围为 0~10 秒
├─ Vars | map[string]string | 否 | 请求参数,支持魔法变量，至少需要一组请求参数，规则解析出错误的会设置成空字段
├─RetryTimes | int | 否 | 重试次数，选范围 0~5 次
├─RetryInterval | int | 否 | 重试间隔，可选范围 0~5 秒，单位：秒
├─SuccessCode | int | 否 | 回调成功的 http code，为 0 表示通配
├─ FailCode | int | 否 | 回调失败的 http code，为 0 表示通配，当 SuccessCode 不为 0 的情况下生效
IPLimit | object | 否 | IP 访问限制
├─ WhiteList | []string | 否 | 白名单，允许推拉流的 IP 列表（CIDR 类型），配置白名单后，黑名单列表将失效
├─ BlackList | []string | 否 | 黑名单，限制推拉流的 IP 列表（CIDR 类型）
PlaySecurity | object | 否 | 时间戳防盗链配置
├─ Type | string | 否 | 防盗链类型，可选防盗链类型为：
留空：默认类型，表示继承直播空间级别配置
none：表示关闭鉴权
tsStartMD5：有效时间从 `TsPart` 表示的时间戳开始，到 `Range` 秒后截止
tsExpireMD5：有效时间从现在当前到 `TsPart` 表示的时间戳为止
├─ Key1 | string | 否 | 主密钥
├─ Key2 | string | 否 | 副密钥， 两个密钥将同时生效，便于线上业务替换密钥
├─ Range | int | 否 | 有效时间，当 防盗链类型 为 `tsStartMD5` 时生效，单位：秒
├─ Rule | string | 否 | 签名规则，支持魔法变量的规则，最终签算结果为所有变量的MD5，魔法变量如下：
$(key)：用户定义的密钥
$(path)：URL中的 `path` 部分
$(streamKey)：URL中的 `hub/stream` 部分
$(streamTitle)：URL中的 `stream` 部分
$(_query)：下划线开头为URL中 `query` 字段
├─ Rule2 | string | 否 | 签名规则2，两个签名规则将同时生效，便于线上业务更换签名规则
├─ TsPart | string | 否 | 时间戳字段，URL中表示时间戳的字段名
├─ TsBase | int | 否 | 时间戳进制，可选进制格式为 2-36，即 2 进制到 36 进制，默认使用16进制
├─ SignPart | string | 否 | 签名字段，URL中表示token的字段名
├─GapDuration | int | 否 | 时间误差值，针对 tsExpireMD5 生效，避免因签算方与服务器本地时间误差造成的鉴权失败
DisconnectDelay | int64 | 否 | 断流延迟配置，单位：秒，针对直播流短时间内闪断重连的情况，不触发断流回调，避免因为短时间内频繁断流造成大量回调
UrlRewrite | object | 否 | URL 改写规则
├─ Rules | []object | 否 | 改写规则列表
CertEnable | bool | 否 | 是否配置 SSL 证书
CertName | string | 否 | 证书名称
Disable | bool | 否 | 域名是否为禁用状态
### 示例
info, err := manager.GetDomainInfo(ctx, GetDomainInfoRequest{Hub:"testHub", Domain: "pili-publish.test.cloudvdn.com",})
## 绑定直播域名
添加直播域名到目标直播空间，包括推流域名与RTMP、HLS、HDL播放域名，绑定之后可以使用此域名推流或播放
### 调用方法
func (m *Manager) BindDomain(ctx context.Context, req BindDomainRequest) error
### 参数说明
BindDomainRequest 结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Hub | string | 是 | 直播空间名
Domain | string | 是 | 域名
Type | string | 是 | 域名类型，可选域名类型为：
publishRtmp：推流域名
liveRtmp：RTMP播放域名
liveHls：HLS播放域名
liveHdl：FLV播放域名
### 示例
err := manager.BindDomain(ctx, BindDomainRequest{Hub:"testHub", Domain:"pili-publish.go-sdk.cloudvdn.com", Type:liveRtmp,})
## 解绑直播域名
将已经绑定的直播域名从目标直播空间解绑，之后无法使用此域名推流或播放
### 调用方法
func (m *Manager) UnbindDomain(ctx context.Context, req UnbindDomainRequest) error
### 参数说明
UnbindDomainRequest 结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Hub | string | 是 | 直播空间名
Domain | string | 是 | 域名
### 示例
err := manager.UnbindDomain(ctx, UnbindDomainRequest{Hub:"testHub", Domain:"pili-publish.go-sdk.cloudvdn.com",})
## 配置点播域名
点播域名用于访问直播空间对应的存储空间中的内容，例如回放、截图文件
请在相应存储空间配置好可用域名后，将其绑定到直播空间。若未正确配置点播域名，可能无法正常使用回放录制、保存截图等功能
### 调用方法
func (m *Manager) BindVodDomain(ctx context.Context, req BindVodDomainRequest) error
### 参数说明
BindVodDomainRequest 结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Hub | string | 是 | 直播空间名
VodDomain | string | 是 | 点播域名
### 示例
err := manager.BindVodDomain(ctx, BindVodDomainRequest{Hub:"testHub", VodDomain:"pili-vod.test.cloudvdn.com",})
## 修改域名证书配置
修改域名证书配置，需要提前将证书配置到七牛 CDN 服务中，证书配置地址: https://portal.qiniu.com/certificate/ssl
配置好证书后可以获得证书名称的参数，此时可以使用获得的证书名称请求执行修改域名证书配置
### 调用方法
func (m *Manager) SetDomainCert(ctx context.Context, req SetDomainCertRequest) error
### 参数说明
SetDomainCertRequest 结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Hub | string | 是 | 直播空间名
Domain | string | 是 | 域名
CertName | string | 是 | 证书名称，需要将证书配置到七牛 CDN 服务中
### 示例
err := manager.SetDomainCert(ctx, SetDomainCertRequest{Hub:"testHub", Domain:"pili-publish.gtest.cloudvdn.com", CertName:"5f1e9df7f9537d6b37000010",})
## 更新域名改写规则
可根据业务需求自定义推拉流URL，改写后的URL应符合七牛的直播URL规范:
`<scheme>://<domain>/<hub>/<stream>[.<ext>]?<query>`
### 调用方法
func (m *Manager) SetDomainURLRewrite(ctx context.Context, req SetDomainURLRewriteRequest) error
### 参数说明
SetDomainURLRewriteRequest 结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Hub | string | 是 | 直播空间名
Domain | string | 是 | 域名
Rules | []object | 是 | URL 改写规则列表
├─ Pattern | string | 是 | 匹配规则，针对完整URL的正则表达式，形式如：`(.+)/live/(.+)/playlist.m3u8`，括号中的内容允许在 Replacement 中使用${n}引用（n表示括号顺序）
├─ Replace | string | 是 | 改写规则，希望得到的改写结果，形式如：`${1}/hub/${2}.m3u8`，改写后的URL应符合七牛的直播URL规范：`<scheme>://<domain>/<hub>/<stream>[<ext>]?<query>`
### 示例
req := pili.SetDomainURLRewriteRequest{
Hub: "testhub",
Domain: "pili-publish.test.cloudvdn.com",
Rules: []pili.DomainURLRewriteRule{
{
Pattern: "(.+)/test/(.+)",
Replace: "${1}/test/live/${2}",
},
},
}
err := manager.SetDomainURLRewrite(ctx, req)
# 直播流管理
## 查询直播流列表
查询目标直播空间下的直播流列表，可以根据直播流在线状态和直播流名称进行筛选
### 调用方法
func (m *Manager) GetStreamsList(ctx context.Context, req GetStreamListRequest) (*GetStreamsListResponse, error)
### 参数说明
GetStreamListRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Hub | string | 是 | 直播空间名
Liveonly | bool | 否 | 只返回当前在线的直播流只返回当前在线的流，true 表示查询的是正在直播的流，不指定表示返回所有的流
Prefix | string | 否 | 直播流名称前缀匹配
Limit | int | 否 | 返回值数量限制，取值范围为0～5000
Marker | string | 否 | 游标，从该位置开始返回
GetStreamsListResponse结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Items | []GetStreamsListResponseItem | 否 | 直播流列表
Marker | string | 否 | 游标，表示当前位置，若marker为空，表示遍历完成
GetStreamsListResponseItem结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Key | string | 否 | 直播流名
### 示例
a, err := manager.GetStreamsList(context.Background(), GetStreamListRequest{Hub: TestHub, LiveOnly: true, Limit: 10})
## 查询直播流信息
查询目标直播流基本信息和配置信息
### 调用方法
func (m *Manager) GetStreamBaseInfo(ctx context.Context, req GetStreamBaseInfoRequest) (*GetStreamBaseInfoResponse, error)
### 参数说明
GetStreamBaseInfoRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Hub | string | 是 | 直播空间名
Stream | string | 是 | 直播流名
GetStreamBaseInfoResponse结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
CreatedAt | int64 | 否 | 直播流创建时间，Unix 时间戳
UpdatedAt | int64 | 否 | 直播流更新时间，Unix 时间戳，对一个流的配置做修改操作会更新这个值
ExpireAt | int64 | 否 | 直播流过期时间，默认流过期时间15天，Unix 时间戳，过期的流会被自动清除。如您设置的默认存储过期时间是 N 天，那么一个流持续 N 天不推流就会被自动清除
DisabledTill | int | 否 | 禁播结束时间，Unix 时间戳，-1 表示永久禁播
Converts | []string | 否 | 转码配置
Watermark | bool | 否 | 是否开启水印
PublishSecurity | string | 否 | 推流鉴权类型
PublishKey | string | 否 | 推流密钥
NropEnable | bool | 否 | 是否开启鉴黄
### 示例
a, err := manager.GetStreamBaseInfo(context.Background(), GetStreamBaseInfoRequest{Hub: TestHub, Stream: TestStream})
## 禁用直播流
禁播或者解禁目标直播流，支持限时禁播或永久禁播
### 调用方法
func (m *Manager) StreamDisable(ctx context.Context, req StreamDisabledRequest) error
### 参数说明
StreamDisabledRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Hub | string | 是 | 直播空间名
Stream | string | 是 | 直播流名
DisabledTill | int | 否 | 禁播结束时间，Unix 时间戳，特殊值含义： -1 永久禁播；0 解除禁播
DisablePeriodSecond | int | 否 | 禁播时长，单位：秒，当 DisabledTill 为0时，DisablePeriodSecond 参数生效，值大于等于0
### 示例
err := manager.StreamDisable(context.Background(), StreamDisabledRequest{
Hub: TestHub,
Stream: TestStream,
DisablePeriodSecond: 60,
})
## 查询在线流信息
查询直播开始时间、主播IP、当前码率、当前帧率等信息
### 调用方法
func (m *Manager) GetStreamLiveStatus(ctx context.Context, req GetStreamLiveStatusRequest) (*GetStreamLiveStatusResponse, error)
### 参数说明
GetStreamLiveStatusRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Hub | string | 是 | 直播空间名
Stream | string | 是 | 直播流名
GetStreamLiveStatusResponse结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
StreamLiveStatus | StreamLiveStatus | 否 | 直播流实时状态
VideoBitRate | int | 否 | 视频码率，单位：bps
AudioBitRate | int | 否 | 音频码率，单位：bps
StreamLiveStatus结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
ServerIP | string | 否 | 服务端IP
ClientIP | string | 否 | 推流端IP
StartAt | int64 | 否 | 推流开始时间，Unix 时间戳
Key | string | 否 | 直播流名
StreamLiveStatusFPS结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Audio | int | 否 | 音频帧率
Video | int | 否 | 视频帧率
Data | int | 否 | metadata帧率
### 示例
a, err := manager.GetStreamLiveStatus(context.Background(), GetStreamLiveStatusRequest{Hub: TestHub, Stream: TestStream})
## 批量查询在线流信息
批量查询直播的开始时间、主播IP、当前码率、当前帧率等信息
### 调用方法
func (m *Manager) BatchGetStreamLiveStatus(ctx context.Context, req BatchGetStreamLiveStatusRequest) (*BatchGetStreamLiveStatusResponse, error)
### 参数说明
BatchGetStreamLiveStatusRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Hub | string | 是 | 直播空间名
Items | []string | 否 | 直播流列表，查询流列表数量不超过100
BatchGetStreamLiveStatusResponse结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Items | []StreamLiveStatus | 否 | 直播流列表
StreamLiveStatus结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
StartAt | int64 | 否 | 推流开始时间，Unix 时间戳
ServerIP | string | 否 | 服务端IP
ClientIP | string | 否 | 推流端IP
BPS | int | 否 | 推流码率
FPS | StreamLiveStatusFPS | 否 | 帧率
Key | string | 否 | 直播流名
StreamLiveStatusFPS结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Audio | int | 否 | 音频帧率
Video | int | 否 | 视频帧率
Data | int | 否 | metadata帧率
### 示例
a, err := manager.BatchGetStreamLiveStatus(context.Background(), BatchGetStreamLiveStatusRequest{
Hub: TestHub,
Items: []string{TestStream},
})
## 查询直播流推流记录
查询目标直播流在一段时间内的推流记录
### 调用方法
func (m *Manager) GetStreamHistory(ctx context.Context, req GetStreamHistoryRequest) (*GetStreamHistoryResponse, error)
### 参数说明
GetStreamHistoryRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Hub | string | 是 | 直播空间名
Stream | string | 是 | 直播流名
Start | int64 | 否 | 开始时间，单位：秒，默认为0
End | int64 | 否 | 结束时间，单位：秒，默认为当前时间
GetStreamHistoryResponse结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Items | []GetStreamHistoryItem | 否 | 直播空间名
GetStreamHistoryItem结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Start | int64 | 否 | 推流开始时间
End | int64 | 否 | 推流结束时间
ClientIP | string | 否 | 推流端IP
ServerIP | string | 否 | 服务端IP
### 示例
a, err := manager.GetStreamHistory(context.Background(), GetStreamHistoryRequest{
Hub: TestHub,
Stream: TestStream,
Start: time.Now().Add(-1 * time.Hour).Unix(),
End: time.Now().Unix(),
})
## 录制直播回放
录制目标直播流一段时间内的直播为回放文件保存在存储空间中，可选回放文件的格式有m3u8、flv和mp4。其中录制为 flv、mp4
格式需要使用多媒体处理转码服务，录制过程需要一定时间。多媒体处理服务独立计费，使用会额外产生费用，详细费用请参考 [价格表
__](https://portal.qiniu.com/financial/price)
### 调用方法
func (m *Manager) StreamSaveas(ctx context.Context, req StreamSaveasRequest) (*StreamSaveasResponse, error)
### 参数说明
StreamSaveasRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Hub | string | 是 | 直播空间名
Stream | string | 是 | 直播流名
Start | int64 | 否 | 开始时间，Unix 时间戳，默认为第一次直播开始时间
End | int64 | 否 | 结束时间，Unix 时间戳，默认为当前时间
Fname | string | 否 | 文件名，为空时会随机生成一个文件名
Format | string | 否 | 文件格式，可选文件格式为
m3u8：HLS格式，默认值
flv：FLV格式，将回放切片转封装为单个flv文件，异步模式
mp4：MP4格式，将回放切片转封装为单个mp4文件，异步模式
异步模式下，生成回放文件需要一定时间
Pipeline | string | 否 | 异步模式时，指定数据处理的队列，可以将优先级较高的任务配置到独立的队列中进行执行，参考文档：[流媒体队列 __](https://developer.qiniu.com/dora/kb/2500/streaming-media-queue-about-seven-cows)
Notify | string | 否 | 回调地址，异步模式完成任务后的回调通知地址，不指定表示不做回调，参考文档：[状态查询 __](https://developer.qiniu.com/dora/1294/persistent-processing-status-query-prefop)
ExpireDays | int | 否 | 切片文件的生命周期：
0：默认值，表示修改ts文件生命周期为永久保存
>0：表示修改ts文件的的生命周期为 `ExpireDays` 参数值
-1：表示不修改ts文件的expire属性，可显著提升接口响应速度
PersistentDeleteAfterDays | int | 否 | 生成文件的生命周期：
0：默认值，表示生成文件（m3u8/flv/mp4）永久保存
>0：表示生成文件（m3u8/flv/mp4）的生命周期为 `PersistentDeleteAfterDays` 参数值
注意，对于m3u8文件，只有当`ExpireDays`为-1时，`persistentDeleteAfterDays`才会生效
FirstTsType | byte | 否 | 过滤ts切片文件类型，部分非标准的直播流，在推流初期缺少视频帧或音频帧，过滤功能可以剔除这部分切片，
0：默认值，不做过滤
1：第一个ts切片需要是纯视频类型，不符合预期的ts切片将被跳过
2：第一个ts切片需要是纯音频类型，不符合预期的ts切片将被跳过
3：第一个ts切片需要是音视频类型，不符合预期的ts切片将被跳过
StreamSaveasResponse结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Fname | string | 否 | 文件名
Start | int64 | 否 | 开始时间，Unix 时间戳
End | int64 | 否 | 结束时间，Unix 时间戳
PersistentID | string | 否 | 异步任务ID
### 示例
m := StreamSaveasRequest{
Hub: "testhub",
Stream: "abcd",
Start: time.Now().Add(-5 * time.Hour).Unix(),
End: time.Now().Unix(),
Fname: "test",
ExpireDays: -1,
FirstTsType: 3,
}
a, err := manager.StreamSaveas(context.Background(), m)
## 保存直播截图
保存目标直播流在特定时间点的画面为图片，并保存在存储空间中。截图使用多媒体处理服务并独立计费，会额外产生费用，详细费用请参考 [价格表
__](https://portal.qiniu.com/financial/price)
### 调用方法
func (m *Manager) StreamSnapshot(ctx context.Context, req StreamSnapshotRequest) (*StreamSnapshotResponse, error)
### 参数说明
StreamSnapshotRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Hub | string | 是 | 直播空间名
Stream | string | 是 | 直播流名
Time | int | 否 | 截图时间，Unix 时间戳，不指定则为当前时间
Fname | string | 否 | 文件名，不指定系统会随机生成
Format | string | 否 | 文件格式，默认为jpg，可取值为jpg和png
Pipeline | string | 否 | 异步模式时，指定数据处理的队列，可以将优先级较高的任务配置到独立的队列中进行执行，参考文档：[流媒体队列 __](https://developer.qiniu.com/dora/kb/2500/streaming-media-queue-about-seven-cows)
Notify | string | 否 | 回调地址，若指定回调地址，则截图动作为异步模式
DeleteAfterDays | int | 否 | 生命周期，单位：天
默认值为0，表示截图文件永久保存
StreamSnapshotResponse结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Fname | string | 否 | 文件名
PersistentID | string | 否 | 异步任务ID
### 示例
ret, err := manager.StreamSnapshot(context.Background(), StreamSnapshotRequest{
Hub: "testhub",
Stream: "abcd",
Time: 1632810081,
Fname: "test",
DeleteAfterDays: 1,
})
## 修改直播流转码配置
设置目标直播流使用的转码配置，设置好转码配置的直播流在推流开始时会触发转码，推流过程中修改转码配置不会立即生效，需要重新推流。
在播放地址后面添加 `@<ProfileName>` 即可播放相应转码流，目前可转码的配置有 `480p` 和
`720p`。使用转码服务会产生额外费用，详情费用请参考 [价格表 __](https://www.qiniu.com/prices/pili)
### 调用方法
func (m *Manager) StreamConverts(ctx context.Context, req StreamConvertsRequest) error
### 参数说明
StreamConvertsRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Hub | string | 是 | 直播空间名
Stream | string | 是 | 直播流名
Converts | []string | 否 | 转码配置，如果提交的 ProfileName 为空数组，那么之前的转码配置将被取消
如果需要配置水印，则需要以wmt_开头，下划线后加水印模版名
### 示例
err := manager.StreamConverts(context.Background(), StreamConvertsRequest{
Hub: TestHub,
Stream: TestStream,
Converts: []string{"480p", "720p"},
})
# 直播统计数据查询
## 查询直播上行流量
查询一段时间内目标直播空间、域名、区域的上行流量，延迟5分钟左右。
带宽数据可以从返回的流量数据`flow`转化，计算方法为`bandwidth=flow*8/300`
### 调用方法
func (m *Manager) GetStatUpflow(ctx context.Context, req GetStatUpflowRequest) ([]StatResponse, error)
### 参数说明
GetStatUpflowRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
GetStatCommonRequest | GetStatCommonRequest | 是 | 通用请求参数
Where | map[string][]string | 否 | 查询条件
Select | []string | 是 | 查询值
GetStatCommonRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Begin | string | 是 | 开始时间，支持格式：20060102、20060102150405
End | string | 是 | 结束时间，支持格式：20060102、20060102150405，超过当前时间，则以当前时间为准，时间范围为左闭右开区间
G | string | 是 | 时间粒度，可取值为 5min、hour、day、month
Where条件字段说明
参数名称 | 必填 | 说明
---|---|---
hub | 否 | 直播空间名
domain | 否 | 域名
area | 否 | 区域，可取值为 cn(中国大陆)、hk(香港)、tw(台湾)、apac(亚太)、am(美洲)、emea(欧洲/中东/非洲)
Select值字段说明
参数名称 | 必填 | 说明
---|---|---
flow | 是 | 流量，单位：byte，带宽可以从流量转换，公式为 带宽=流量*8/时间粒度，单位：bps
StatResponse结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Time | time.Time | 否 | 时间
Values | map[string]int | 否 | 数据，形式如：“values”:{“flow”:4527162977}，其中"flow"对应select项
### 示例
a, err := manager.GetStatUpflow(context.Background(), GetStatUpflowRequest{
GetStatCommonRequest: GetStatCommonRequest{
Begin: "20210928",
End: "20210930",
G: "day",
},
Where: map[string][]string{"hub": {TestHub}, "area": {"!cn", "!hk"}},
})
## 分组查询直播上行流量
查询一段时间内目标直播空间、域名、区域的上行流量，按group分组，延迟5分钟左右。
带宽数据可以从返回的流量数据`flow`转化，计算方法为`bandwidth=flow*8/300`
### 调用方法
func (m *Manager) GroupStatUpflow(ctx context.Context, req GroupStatUpflowRequest) ([]StatGroupResponse, error)
### 参数说明
GroupStatUpflowRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
GetStatCommonRequest | GetStatCommonRequest | 是 | 通用请求参数
Group | string | 是 | 分组，取值范围为条件字段
Where | map[string][]string | 否 | 查询条件
Select | []string | 是 | 查询值
GetStatCommonRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Begin | string | 是 | 开始时间，支持格式：20060102、20060102150405
End | string | 是 | 结束时间，支持格式：20060102、20060102150405，超过当前时间，则以当前时间为准，时间范围为左闭右开区间
G | string | 是 | 时间粒度，可取值为 5min、hour、day、month
Where条件字段说明
参数名称 | 必填 | 说明
---|---|---
hub | 否 | 直播空间名
domain | 否 | 域名
area | 否 | 区域，可取值为 cn(中国大陆)、hk(香港)、tw(台湾)、apac(亚太)、am(美洲)、emea(欧洲/中东/非洲)
Select值字段说明
参数名称 | 必填 | 说明
---|---|---
flow | 是 | 流量，单位：byte，带宽可以从流量转换，公式为 带宽=流量*8/时间粒度，单位：bps
StatGroupResponse结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Time | time.Time | 否 | 时间
Values | map[string]map[string]int | 否 | 数据，形式如：“values”:{“SD”:{“flow”:4527162977}}，其中"SD"对应Group项，"flow"对应Select项
### 示例
a, err := manager.GroupStatUpflow(context.Background(), GroupStatUpflowRequest{
GetStatCommonRequest: GetStatCommonRequest{
Begin: "20210928",
End: "20210930",
G: "day",
},
Select: []string{"flow"},
Where: map[string][]string{"hub": {TestHub}},
Group: "domain",
})
## 查询直播下行流量
查询一段时间内目标直播空间、域名、区域的下行流量，延迟5分钟左右。
带宽数据可以从返回的流量数据`flow`转化，计算方法为`bandwidth=flow*8/300`
### 调用方法
func (m *Manager) GetStatDownflow(ctx context.Context, req GetStatDownflowRequest) ([]StatResponse, error)
### 参数说明
GetStatDownflowRequest结构体说明
参数名称 | 字段类型 | 是否必填 | 说明
---|---|---|---
GetStatCommonRequest | GetStatCommonRequest | 是 | 通用请求参数
Where | map[string][]string | 否 | 查询条件
Select | []string | 是 | 查询值
GetStatCommonRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Begin | string | 是 | 开始时间，支持格式：20060102、20060102150405
End | string | 是 | 结束时间，支持格式：20060102、20060102150405，超过当前时间，则以当前时间为准，时间范围为左闭右开区间
G | string | 是 | 时间粒度，可取值为 5min、hour、day、month
Where条件字段说明
参数名称 | 必填 | 说明
---|---|---
hub | 否 | 直播空间名
domain | 否 | 域名
area | 否 | 区域，可取值为 cn(中国大陆)、hk(香港)、tw(台湾)、apac(亚太)、am(美洲)、emea(欧洲/中东/非洲)
Select值字段说明
参数名称 | 必填 | 说明
---|---|---
flow | 是 | 流量，单位：byte，带宽可以从流量转换，公式为 带宽=流量*8/时间粒度，单位：bps
StatResponse结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Time | time.Time | 否 | 时间
Values | map[string]int | 否 | 数据，形式如：“values”:{“flow”:4527162977}，其中"flow"对应select项
### 示例
a, err := manager.GetStatDownflow(context.Background(), GetStatDownflowRequest{
GetStatCommonRequest: GetStatCommonRequest{
Begin: "20210928",
End: "20210930",
G: "day",
},
Select: []string{"flow"},
Where: map[string][]string{"hub": {TestHub}},
})
## 分组查询直播下行流量
查询一段时间内目标直播空间、域名、区域的下行流量，按group分组，延迟5分钟左右。
带宽数据可以从返回的流量数据`flow`转化，计算方法为`bandwidth=flow*8/300`
### 调用方法
func (m *Manager) GroupStatDownflow(ctx context.Context, req GroupStatDownflowRequest) ([]StatGroupResponse, error)
### 参数说明
GroupStatDownflowRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
GetStatCommonRequest | GetStatCommonRequest | 是 | 通用请求参数
Group | string | 是 | 分组，取值范围为条件字段
Where | map[string][]string | 否 | 查询条件
Select | []string | 是 | 查询值
GetStatCommonRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Begin | string | 是 | 开始时间，支持格式：20060102、20060102150405
End | string | 是 | 结束时间，支持格式：20060102、20060102150405，超过当前时间，则以当前时间为准，时间范围为左闭右开区间
G | string | 是 | 时间粒度，可取值为 5min、hour、day、month
Where条件字段说明
参数名称 | 必填 | 说明
---|---|---
hub | 否 | 直播空间名
domain | 否 | 域名
area | 否 | 区域，可取值为 cn(中国大陆)、hk(香港)、tw(台湾)、apac(亚太)、am(美洲)、emea(欧洲/中东/非洲)
Select值字段说明
参数名称 | 必填 | 说明
---|---|---
flow | 是 | 流量，单位：byte，带宽可以从流量转换，公式为 带宽=流量*8/时间粒度，单位：bps
StatGroupResponse结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Time | time.Time | 否 | 时间
Values | map[string]map[string]int | 否 | 数据，形式如：“values”:{“SD”:{“flow”:4527162977}}，其中"SD"对应Group项，"flow"对应Select项
### 示例
a, err := manager.GroupStatDownflow(context.Background(), GroupStatDownflowRequest{
GetStatCommonRequest: GetStatCommonRequest{
Begin: "20210928",
End: "20210930",
G: "day",
},
Select: []string{"flow"},
Where: map[string][]string{"hub": {TestHub}},
Group: "area",
})
## 查询直播转码使用量
查询一段时间内目标直播空间、转码配置的转码时长，延迟10分钟左右
### 调用方法
func (m *Manager) GetStatCodec(ctx context.Context, req GetStatCodecRequest) ([]StatResponse, error)
### 参数说明
GetStatCodecRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
GetStatCommonRequest | GetStatCommonRequest | 是 | 通用请求参数
Where | map[string][]string | 否 | 查询条件
Select | []string | 是 | 查询值
GetStatCommonRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Begin | string | 是 | 开始时间，支持格式：20060102、20060102150405
End | string | 是 | 结束时间，支持格式：20060102、20060102150405，超过当前时间，则以当前时间为准，时间范围为左闭右开区间
G | string | 是 | 时间粒度，可取值为 5min、hour、day、month
Where条件字段说明
参数名称 | 必填 | 说明
---|---|---
hub | 否 | 直播空间名
profile | 否 | 转码配置
Select值字段说明
参数名称 | 必填 | 说明
---|---|---
duration | 是 | 时长，单位：毫秒
StatResponse结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Time | time.Time | 否 | 时间
Values | map[string]int | 否 | 数据，形式如：“values”:{“duration”:4527162977}，其中"duration"对应select项
### 示例
a, err := manager.GetStatCodec(context.Background(), GetStatCodecRequest{
GetStatCommonRequest: GetStatCommonRequest{
Begin: "20210928",
End: "20210930",
G: "day",
},
Select: []string{"duration"},
Where: map[string][]string{"hub": {TestHub}, "profile": {"480p", "720p"}},
})
## 分组查询直播转码使用量
查询一段时间内目标直播空间、转码配置的转码时长，按group分组，延迟10分钟左右
### 调用方法
func (m *Manager) GroupStatCodec(ctx context.Context, req GroupStatCodecRequest) ([]StatGroupResponse, error)
### 参数说明
GroupStatCodecRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
GetStatCommonRequest | GetStatCommonRequest | 是 | 通用请求参数
Group | string | 是 | 分组，取值范围为条件字段
Where | map[string][]string | 否 | 查询条件
Select | []string | 是 | 查询值
GetStatCommonRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Begin | string | 是 | 开始时间，支持格式：20060102、20060102150405
End | string | 是 | 结束时间，支持格式：20060102、20060102150405，超过当前时间，则以当前时间为准，时间范围为左闭右开区间
G | string | 是 | 时间粒度，可取值为 5min、hour、day、month
Where条件字段说明
参数名称 | 必填 | 说明
---|---|---
hub | 否 | 直播空间名
profile | 否 | 转码配置
Select值字段说明
参数名称 | 必填 | 说明
---|---|---
duration | 是 | 时长，单位：毫秒
StatGroupResponse结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Time | time.Time | 否 | 时间
Values | map[string]map[string]int | 否 | 数据，形式如：“values”:{“SD”:{“duration”:4527162977}}，其中"SD"对应Group项，"duration"对应Select项
### 示例
a, err := manager.GroupStatCodec(context.Background(), GroupStatCodecRequest{
GetStatCommonRequest: GetStatCommonRequest{
Begin: "20210928",
End: "20210930",
G: "day",
},
Select: []string{"duration"},
Where: map[string][]string{"hub": {TestHub}, "profile": {"!480p"}},
Group: "profile",
})
## 查询直播鉴黄使用量
查询一段时间内目标直播空间的鉴黄次数，延迟10分钟左右
### 调用方法
func (m *Manager) GetStatNrop(ctx context.Context, req GetStatNropRequest) ([]StatResponse, error)
### 参数说明
GetStatNropRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
GetStatCommonRequest | GetStatCommonRequest | 是 | 通用请求参数
Where | map[string][]string | 否 | 查询条件
Select | []string | 是 | 查询值
GetStatCommonRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Begin | string | 是 | 开始时间，支持格式：20060102、20060102150405
End | string | 是 | 结束时间，支持格式：20060102、20060102150405，超过当前时间，则以当前时间为准，时间范围为左闭右开区间
G | string | 是 | 时间粒度，可取值为 5min、hour、day、month
Where条件字段说明
参数名称 | 必填 | 说明
---|---|---
hub | 否 | 直播空间名
assured | 否 | 鉴黄结果是否确定，true或false
Select值字段说明
参数名称 | 必填 | 说明
---|---|---
count | 是 | 鉴黄次数
StatResponse结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Time | time.Time | 否 | 时间
Values | map[string]int | 否 | 数据，形式如：“values”:{“count”:452}，其中"count"对应select项
### 示例
a, err := manager.GetStatNrop(context.Background(), GetStatNropRequest{
GetStatCommonRequest: GetStatCommonRequest{
Begin: "20210928",
End: "20210930",
G: "day",
},
Select: []string{"count"},
Where: map[string][]string{"hub": {"!" + TestHub}, "assured": {"false"}},
})
## 分组查询直播鉴黄使用量
查询一段时间内目标直播空间的鉴黄次数，按group分组，延迟10分钟左右
### 调用方法
func (m *Manager) GroupStatNrop(ctx context.Context, req GroupStatNropRequest) ([]StatGroupResponse, error)
### 参数说明
GroupStatNropRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
GetStatCommonRequest | GetStatCommonRequest | 是 | 通用请求参数
Group | string | 是 | 分组，取值范围为条件字段
Where | map[string][]string | 否 | 查询条件
Select | []string | 是 | 查询值
GetStatCommonRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Begin | string | 是 | 开始时间，支持格式：20060102、20060102150405
End | string | 是 | 结束时间，支持格式：20060102、20060102150405，超过当前时间，则以当前时间为准，时间范围为左闭右开区间
G | string | 是 | 时间粒度，可取值为 5min、hour、day、month
Where条件字段说明
参数名称 | 必填 | 说明
---|---|---
hub | 否 | 直播空间名
assured | 否 | 鉴黄结果是否确定，true或false
Select值字段说明
参数名称 | 必填 | 说明
---|---|---
count | 是 | 鉴黄次数
StatGroupResponse结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Time | time.Time | 否 | 时间
Values | map[string]map[string]int | 否 | 数据，形式如：“values”:{“SD”:{“count”:4527162977}}，其中"SD"对应Group项，"count"对应Select项
### 示例
a, err := manager.GroupStatNrop(context.Background(), GroupStatNropRequest{
GetStatCommonRequest: GetStatCommonRequest{
Begin: "20210928",
End: "20210930",
G: "day",
},
Select: []string{"count"},
Where: map[string][]string{"hub": {"!"+TestHub}, "assured": {"false", "true"}},
Group: "hub",
})
## 查询导播台使用量
查询一段时间内导播台使用时长，延迟分钟级
### 调用方法
func (m *Manager) GetStatCaster(ctx context.Context, req GetStatCasterRequest) ([]StatResponse, error)
### 参数说明
GetStatCasterRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
GetStatCommonRequest | GetStatCommonRequest | 是 | 通用请求参数
Where | map[string][]string | 否 | 查询条件
Select | []string | 是 | 查询值
GetStatCommonRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Begin | string | 是 | 开始时间，支持格式：20060102、20060102150405
End | string | 是 | 结束时间，支持格式：20060102、20060102150405，超过当前时间，则以当前时间为准，时间范围为左闭右开区间
G | string | 是 | 时间粒度，可取值为 5min、hour、day、month
Where条件字段说明
参数名称 | 必填 | 说明
---|---|---
container | 否 | 容器
resolution | 否 | 分辨率
Select值字段说明
参数名称 | 必填 | 说明
---|---|---
upflow | 否 | 上行流量，单位：byte
downflow | 否 | 下行流量，单位：byte
duration | 否 | 使用时长，单位：秒
StatResponse结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Time | time.Time | 否 | 时间
Values | map[string]int | 否 | 数据，形式如：“values”:{“upflow”:4527162977}，其中"upflow"对应select项
### 示例
a, err := manager.GetStatCaster(context.Background(), GetStatCasterRequest{
GetStatCommonRequest: GetStatCommonRequest{
Begin: "20211024",
End: "20211026",
G: "day",
},
Select: []string{"upflow", "downflow", "duration"},
Where: map[string][]string{},
})
## 分组查询导播台使用量
查询一段时间内导播台使用时长，按group分组，延迟分钟级
### 调用方法
func (m *Manager) GroupStatCaster(ctx context.Context, req GroupStatCasterRequest) ([]StatGroupResponse, error)
### 参数说明
GroupStatCasterRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
GetStatCommonRequest | GetStatCommonRequest | 是 | 通用请求参数
Group | string | 是 | 分组，取值范围为条件字段
Where | map[string][]string | 否 | 查询条件
Select | []string | 是 | 查询值
GetStatCommonRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Begin | string | 是 | 开始时间，支持格式：20060102、20060102150405
End | string | 是 | 结束时间，支持格式：20060102、20060102150405，超过当前时间，则以当前时间为准，时间范围为左闭右开区间
G | string | 是 | 时间粒度，可取值为 5min、hour、day、month
Where条件字段说明
参数名称 | 必填 | 说明
---|---|---
container | 否 | 容器
resolution | 否 | 分辨率
Select值字段说明
参数名称 | 必填 | 说明
---|---|---
upflow | 否 | 上行流量，单位：byte
downflow | 否 | 下行流量，单位：byte
duration | 否 | 使用时长，单位：秒
StatGroupResponse结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Time | time.Time | 否 | 时间
Values | map[string]map[string]int | 否 | 数据，形式如：“values”:{“SD”:{“upflow”:4527162977}}，其中"SD"对应Group项，"upflow"对应Select项
### 示例
a, err := manager.GroupStatCaster(context.Background(), GroupStatCasterRequest{
GetStatCommonRequest: GetStatCommonRequest{
Begin: "20210928",
End: "20210930",
G: "day",
},
Select: []string{"upflow"},
Group: "resolution",
})
## 查询Pub转推服务使用量
查询一段时间内转推服务的使用时长和次数，延迟10分钟内
### 调用方法
func (m *Manager) GetStatPub(ctx context.Context, req GetStatPubRequest) ([]StatResponse, error)
### 参数说明
GetStatPubRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
GetStatCommonRequest | GetStatCommonRequest | 是 | 通用请求参数
Where | map[string][]string | 否 | 查询条件
Select | []string | 是 | 查询值
GetStatCommonRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Begin | string | 是 | 开始时间，支持格式：20060102、20060102150405
End | string | 是 | 结束时间，支持格式：20060102、20060102150405，超过当前时间，则以当前时间为准，时间范围为左闭右开区间
G | string | 是 | 时间粒度，可取值为 5min、hour、day、month
Where条件字段说明
参数名称 | 必填 | 说明
---|---|---
tp | 否 | 状态，可选项 normal
Select值字段说明
参数名称 | 必填 | 说明
---|---|---
count | 否 | 转推次数
duration | 否 | 转推时长，单位：毫秒
StatResponse结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Time | time.Time | 否 | 时间
Values | map[string]int | 否 | 数据，形式如：“values”:{“flow”:4527162977}，其中"flow"对应select项
### 示例
a, err := manager.GetStatPub(context.Background(), GetStatPubRequest{
GetStatCommonRequest: GetStatCommonRequest{
Begin: "20211024",
End: "20211026",
G: "day",
},
Select: []string{"duration"},
Where: map[string][]string{},
})
## 分组查询Pub转推服务使用量
查询一段时间内转推服务的使用时长和次数，按group分组，延迟10分钟内
### 调用方法
func (m *Manager) GroupStatPub(ctx context.Context, req GroupStatPubRequest) ([]StatGroupResponse, error)
### 参数说明
GroupStatPubRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
GetStatCommonRequest | GetStatCommonRequest | 是 | 通用请求参数
Group | string | 是 | 分组，取值范围为条件字段
Where | map[string][]string | 否 | 查询条件
Select | []string | 是 | 查询值
GetStatCommonRequest结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Begin | string | 是 | 开始时间，支持格式：20060102、20060102150405
End | string | 是 | 结束时间，支持格式：20060102、20060102150405，超过当前时间，则以当前时间为准，时间范围为左闭右开区间
G | string | 是 | 时间粒度，可取值为 5min、hour、day、month
Where条件字段说明
参数名称 | 必填 | 说明
---|---|---
tp | 否 | 状态，可选项 normal
Select值字段说明
参数名称 | 必填 | 说明
---|---|---
count | 否 | 转推次数
duration | 否 | 转推时长，单位：毫秒
StatGroupResponse结构体说明
参数名称 | 字段类型 | 必填 | 说明
---|---|---|---
Time | time.Time | 否 | 时间
Values | map[string]map[string]int | 否 | 数据，形式如：“values”:{“normal”:{“count”:4527162977}}，其中"normal"对应Group项，"count"对应Select项
### 示例
a, err := manager.GroupStatPub(context.Background(), GroupStatPubRequest{
GetStatCommonRequest: GetStatCommonRequest{
Begin: "20210928",
End: "20210930",
G: "hour",
},
Select: []string{"duration"},
Group: "tp",
})
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 3,997 |
服务端SDK历史文档 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 >
[服务端](https://developer.qiniu.com/pili/sdk/9910/pili-service-sdk) > 服务端SDK历史文档
# 服务端SDK历史文档
最近更新时间: 2021-11-02 17:49:05
# 直播工作流模型
Client (iOS/Android/PC/Camera) 向 Server (业务逻辑服务器) 请求推流授权
* Server 颁发带授权信息的 Stream 给 Client
* Client 通过 RTMP 推流 给 Pili Streaming Cloud
* Client 向 Server 请求播放授权
* Server 向 Client 颁发播放地址
* Client 调用 播放器 SDK 打开播放地址进行播放
三方交互的业务逻辑可以借鉴如下示意图进行理解：
# 功能介绍
目前提供的服务端 SDK 有：Go, NodeJS, Ruby, Python, PHP, Java
下载地址:
* <https://github.com/pili-engineering/pili-sdk-go.v2>[__](https://github.com/pili-engineering/pili-sdk-go.v2)
* <https://github.com/pili-engineering/pili-sdk-nodejs>[__](https://github.com/pili-engineering/pili-sdk-nodejs)
* <https://github.com/pili-engineering/pili-sdk-ruby>[__](https://github.com/pili-engineering/pili-sdk-ruby)
* <https://github.com/pili-engineering/pili-sdk-python>[__](https://github.com/pili-engineering/pili-sdk-python)
* <https://github.com/pili-engineering/pili-sdk-php.v2>[__](https://github.com/pili-engineering/pili-sdk-php.v2)
* <https://github.com/pili-engineering/pili-sdk-java>[__](https://github.com/pili-engineering/pili-sdk-java)
* <https://github.com/pili-engineering/pili-sdk-csharp>[__](https://github.com/pili-engineering/pili-sdk-csharp)
* <https://github.com/pili-engineering/pili-sdk-c>[__](https://github.com/pili-engineering/pili-sdk-c)
服务端 SDK 用于颁发带授权凭证的 RTMP 推流地址、RTMP/HTTP-FLV/HLS/封面的直播地址给客户端，以及对直播流（Live
Streaming）进行创建、查询、禁播等管理。服务端 SDK 功能包括但不限于：
- RTMPPublishURL() #生成带授权凭证的 RTMP 推流地址
- RTMPPlayURL() #生成 RTMP 播放地址
- HLSPlayURL() #生成 HLS 播放地址
- HDLPlayURL() #生成 HDL(HTTP-FLV) 播放地址
- SnapshotPlayURL() #生成直播封面地址
- hub.Create() #创建流
- hub.Stream() #获得流
- hub.List() #查询流列表
- hub.ListLive() #查询直播列表
- stream.Info() #查询流信息
- stream.Disable() #禁播流（秒级禁推/禁播）
- stream.Enable() #启用流
- stream.LiveStatus() #查询直播实时信息
- stream.Save() #保存直播回放
- stream.HistoryActivity() #查询直播历史记录
# 使用样例
拿 GO SDK 举例，接入步骤如下：
## 集成SDK
// SDK 下载地址：https://github.com/pili-engineering/pili-sdk-go
import "github.com/pili-engineering/pili"
// 配置企业开发者密钥
// 密钥使用七牛账号登录 https://portal.qiniu.com/user/key 获取
mac := &pili.MAC{
AccessKey: "Your_Qiniu_AccessKey",
SecretKey: "Your_Qiniu_SecretKey",
}
// 直播空间名称
// 直播空间必须事先存在，可以在 portal.qiniu.com 上创建
hubName := "Your_Hub_Name"
## 获取 RTMP 推流地址
// 生成 RTMP 推流地址
// publishDomain: 与直播空间绑定的 RTMP 推流域名，可以在 portal.qiniu.com 上绑定
// streamKey: 流名，流不需要事先存在，推流会自动创建流
// mac: 授权信息
// expireAfterSeconds: 生成的推流地址的有效时间
publishURL := pili.RTMPPublishURL(publishDomain, hub, streamKey, mac, expireAfterSeconds)
/*
rtmp://publish-rtmp.test.com/PiliSDKTest/streamkey?e=1463023142&token=7O7hf7Ld1RrC_fpZdFvU8aCgOPuhw2K4eapYOdII:-5IVlpFNNGJHwv-2qKwVIakC0ME=
*/
## 获取直播播放地址
// 生成 RTMP 播放地址
// rtmpDomain: 直播空间绑定的 RTMP 直播域名，可以在 portal.qiniu.com 上绑定
rtmpURL := pili.RTMPPlayURL(rtmpDomain, hubName, streamKey)
/*
rtmp://live-rtmp.test.com/PiliSDKTest/streamkey
*/
// 生成 HLS 播放地址
// hlsDomain: 直播空间绑定的 HLS 直播域名，可以在 portal.qiniu.com 上绑定
hlsURL := pili.HLSPlayURL(hlsDomain, hubName, streamKey)
/*
http://live-hls.test.com/PiliSDKTest/streamkey.m3u8
*/
// 生成 HDL 播放地址
// hdlDomain: 直播空间绑定的 HDL 直播域名，可以在 portal.qiniu.com 上绑定
hdlURL := pili.HDLPlayURL(hdlDomain, hubName, streamKey)
/*
http://live-hdl.test.com/PiliSDKTest/streamkey.flv
*/
// 生成直播封面地址
// snapshotDomain: 直播空间绑定的直播封面域名，可以在 portal.qiniu.com 上绑定
snapshotURL := pili.SnapshotPlayURL(snapshotDomain, hubName, streamKey)
/*
http://live-snapshot.test.com/PiliSDKTest/streamkey.jpg
*/
## 流管理
// 初始化授权客户
client := pili.New(mac, nil)
// 初始化直播空间
hub := client.Hub(hubName)
// 初始化流对象
stream := client.Stream(streamKey)
## 禁播/启用流
// 流立即禁推、禁播
stream.Disable()
// 恢复可以推流、播流
stream.Enable()
// 禁用该流一段时间
// stream.DisableTill(10) 表示禁用 10 分钟
stream.DisableTill(time.Now().Add(time.Minute).Unix())
// 永久禁用
stream.DisableTill(-1)
## 查询直播历史记录
// start、end 指定查询的时间范围，指定为 0 值表示查询所有时间段的直播历史记录
records, _ := stream.HistoryActivity(0, 0)
/*
[{1463382401 1463382441}]
*/
## 保存直播回放
// start、end 指定要保存的直播的时间范围，start: Unix 时间戳, 起始时间, 0 值表示不指定, 则不限制起始时间，end: Unix 时间戳, 结束时间, 0 值表示当前时间.都传 0 表示获取这路流所有的直播回看
// 直播数据保存在所绑定的 Qiniu 存储空间中，文件名由系统生成
// 文件可以通过存储空间所绑定的下载域名进行访问，形如 http://<DomainOfStorageBucket>/<Fname>
fname, _ := stream.Save(0, 0)
/*
recordings/z1.PiliSDKTest.streamkey/1463382401_1463382441.m3u8
*/
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 >
[服务端](https://developer.qiniu.com/pili/sdk/9910/pili-service-sdk) > 服务端SDK历史文档
# 服务端SDK历史文档
最近更新时间: 2021-11-02 17:49:05
# 直播工作流模型
Client (iOS/Android/PC/Camera) 向 Server (业务逻辑服务器) 请求推流授权
* Server 颁发带授权信息的 Stream 给 Client
* Client 通过 RTMP 推流 给 Pili Streaming Cloud
* Client 向 Server 请求播放授权
* Server 向 Client 颁发播放地址
* Client 调用 播放器 SDK 打开播放地址进行播放
三方交互的业务逻辑可以借鉴如下示意图进行理解：
# 功能介绍
目前提供的服务端 SDK 有：Go, NodeJS, Ruby, Python, PHP, Java
下载地址:
* <https://github.com/pili-engineering/pili-sdk-go.v2>[__](https://github.com/pili-engineering/pili-sdk-go.v2)
* <https://github.com/pili-engineering/pili-sdk-nodejs>[__](https://github.com/pili-engineering/pili-sdk-nodejs)
* <https://github.com/pili-engineering/pili-sdk-ruby>[__](https://github.com/pili-engineering/pili-sdk-ruby)
* <https://github.com/pili-engineering/pili-sdk-python>[__](https://github.com/pili-engineering/pili-sdk-python)
* <https://github.com/pili-engineering/pili-sdk-php.v2>[__](https://github.com/pili-engineering/pili-sdk-php.v2)
* <https://github.com/pili-engineering/pili-sdk-java>[__](https://github.com/pili-engineering/pili-sdk-java)
* <https://github.com/pili-engineering/pili-sdk-csharp>[__](https://github.com/pili-engineering/pili-sdk-csharp)
* <https://github.com/pili-engineering/pili-sdk-c>[__](https://github.com/pili-engineering/pili-sdk-c)
服务端 SDK 用于颁发带授权凭证的 RTMP 推流地址、RTMP/HTTP-FLV/HLS/封面的直播地址给客户端，以及对直播流（Live
Streaming）进行创建、查询、禁播等管理。服务端 SDK 功能包括但不限于：
- RTMPPublishURL() #生成带授权凭证的 RTMP 推流地址
- RTMPPlayURL() #生成 RTMP 播放地址
- HLSPlayURL() #生成 HLS 播放地址
- HDLPlayURL() #生成 HDL(HTTP-FLV) 播放地址
- SnapshotPlayURL() #生成直播封面地址
- hub.Create() #创建流
- hub.Stream() #获得流
- hub.List() #查询流列表
- hub.ListLive() #查询直播列表
- stream.Info() #查询流信息
- stream.Disable() #禁播流（秒级禁推/禁播）
- stream.Enable() #启用流
- stream.LiveStatus() #查询直播实时信息
- stream.Save() #保存直播回放
- stream.HistoryActivity() #查询直播历史记录
# 使用样例
拿 GO SDK 举例，接入步骤如下：
## 集成SDK
// SDK 下载地址：https://github.com/pili-engineering/pili-sdk-go
import "github.com/pili-engineering/pili"
// 配置企业开发者密钥
// 密钥使用七牛账号登录 https://portal.qiniu.com/user/key 获取
mac := &pili.MAC{
AccessKey: "Your_Qiniu_AccessKey",
SecretKey: "Your_Qiniu_SecretKey",
}
// 直播空间名称
// 直播空间必须事先存在，可以在 portal.qiniu.com 上创建
hubName := "Your_Hub_Name"
## 获取 RTMP 推流地址
// 生成 RTMP 推流地址
// publishDomain: 与直播空间绑定的 RTMP 推流域名，可以在 portal.qiniu.com 上绑定
// streamKey: 流名，流不需要事先存在，推流会自动创建流
// mac: 授权信息
// expireAfterSeconds: 生成的推流地址的有效时间
publishURL := pili.RTMPPublishURL(publishDomain, hub, streamKey, mac, expireAfterSeconds)
/*
rtmp://publish-rtmp.test.com/PiliSDKTest/streamkey?e=1463023142&token=7O7hf7Ld1RrC_fpZdFvU8aCgOPuhw2K4eapYOdII:-5IVlpFNNGJHwv-2qKwVIakC0ME=
*/
## 获取直播播放地址
// 生成 RTMP 播放地址
// rtmpDomain: 直播空间绑定的 RTMP 直播域名，可以在 portal.qiniu.com 上绑定
rtmpURL := pili.RTMPPlayURL(rtmpDomain, hubName, streamKey)
/*
rtmp://live-rtmp.test.com/PiliSDKTest/streamkey
*/
// 生成 HLS 播放地址
// hlsDomain: 直播空间绑定的 HLS 直播域名，可以在 portal.qiniu.com 上绑定
hlsURL := pili.HLSPlayURL(hlsDomain, hubName, streamKey)
/*
http://live-hls.test.com/PiliSDKTest/streamkey.m3u8
*/
// 生成 HDL 播放地址
// hdlDomain: 直播空间绑定的 HDL 直播域名，可以在 portal.qiniu.com 上绑定
hdlURL := pili.HDLPlayURL(hdlDomain, hubName, streamKey)
/*
http://live-hdl.test.com/PiliSDKTest/streamkey.flv
*/
// 生成直播封面地址
// snapshotDomain: 直播空间绑定的直播封面域名，可以在 portal.qiniu.com 上绑定
snapshotURL := pili.SnapshotPlayURL(snapshotDomain, hubName, streamKey)
/*
http://live-snapshot.test.com/PiliSDKTest/streamkey.jpg
*/
## 流管理
// 初始化授权客户
client := pili.New(mac, nil)
// 初始化直播空间
hub := client.Hub(hubName)
// 初始化流对象
stream := client.Stream(streamKey)
## 禁播/启用流
// 流立即禁推、禁播
stream.Disable()
// 恢复可以推流、播流
stream.Enable()
// 禁用该流一段时间
// stream.DisableTill(10) 表示禁用 10 分钟
stream.DisableTill(time.Now().Add(time.Minute).Unix())
// 永久禁用
stream.DisableTill(-1)
## 查询直播历史记录
// start、end 指定查询的时间范围，指定为 0 值表示查询所有时间段的直播历史记录
records, _ := stream.HistoryActivity(0, 0)
/*
[{1463382401 1463382441}]
*/
## 保存直播回放
// start、end 指定要保存的直播的时间范围，start: Unix 时间戳, 起始时间, 0 值表示不指定, 则不限制起始时间，end: Unix 时间戳, 结束时间, 0 值表示当前时间.都传 0 表示获取这路流所有的直播回看
// 直播数据保存在所绑定的 Qiniu 存储空间中，文件名由系统生成
// 文件可以通过存储空间所绑定的下载域名进行访问，形如 http://<DomainOfStorageBucket>/<Fname>
fname, _ := stream.Save(0, 0)
/*
recordings/z1.PiliSDKTest.streamkey/1463382401_1463382441.m3u8
*/
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,076 |
低延时直播 SDK | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 低延时直播 SDK
# 低延时直播 SDK
最近更新时间: 2021-02-01 14:23:32
# 产品介绍
七牛低延时直播（Geek）构建了全新的低延时直播互动体验，相比与传统的直播能力降低了延时、优化了协议与底层技术，目前对于微信内直播多业务场景提供了更为优渥的使用体验。支持千万级并发同时拥有毫秒级开播体验，打通了用户对于直播低延时性的核心诉求。
# 产品架构
# 核心优势
### **更低延时**
低延时直播模式下，保证 95% 情况下延时 0.5s-1.5s 区间，助力多元互动直播新场景。
### **更强互动**
接近无感知的延时，满足电商/娱乐/教育等直播场景下，更为优质的互动“零距离体验”。
### **无迁移成本**
传统直播下所有能力均可无缝衔接“低延时直播”，无需任何插件，不存在任何迁移成本。
# 适用场景
基于微信场景下，私域流量以及各类直播业务进行了服务升级，将起播延时控制在1s以内。
* 电商类
全民电商时代，保证画面清晰度的同时提供了更低延时的服务，抢购加单统统不是问题。
* 教育类
支持大房间教学模式产生的高频互动场景，毫秒级延迟下保证学生老师之间的沟通质量。
* 互动娱乐
无论是户外或者是室内互动直播场景，加强后的反馈互动体验，观众与主播无限接近于“零距离”。
# Demo体验
[快速体验](https://developer.qiniu.com/pili/7741/low-latency-live-sdk-download-
experience)七牛低延迟直播效果
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 低延时直播 SDK
# 低延时直播 SDK
最近更新时间: 2021-02-01 14:23:32
# 产品介绍
七牛低延时直播（Geek）构建了全新的低延时直播互动体验，相比与传统的直播能力降低了延时、优化了协议与底层技术，目前对于微信内直播多业务场景提供了更为优渥的使用体验。支持千万级并发同时拥有毫秒级开播体验，打通了用户对于直播低延时性的核心诉求。
# 产品架构
# 核心优势
### **更低延时**
低延时直播模式下，保证 95% 情况下延时 0.5s-1.5s 区间，助力多元互动直播新场景。
### **更强互动**
接近无感知的延时，满足电商/娱乐/教育等直播场景下，更为优质的互动“零距离体验”。
### **无迁移成本**
传统直播下所有能力均可无缝衔接“低延时直播”，无需任何插件，不存在任何迁移成本。
# 适用场景
基于微信场景下，私域流量以及各类直播业务进行了服务升级，将起播延时控制在1s以内。
* 电商类
全民电商时代，保证画面清晰度的同时提供了更低延时的服务，抢购加单统统不是问题。
* 教育类
支持大房间教学模式产生的高频互动场景，毫秒级延迟下保证学生老师之间的沟通质量。
* 互动娱乐
无论是户外或者是室内互动直播场景，加强后的反馈互动体验，观众与主播无限接近于“零距离”。
# Demo体验
[快速体验](https://developer.qiniu.com/pili/7741/low-latency-live-sdk-download-
experience)七牛低延迟直播效果
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,084 |
低延时直播 SDK 下载体验 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > [低延时直播
SDK](https://developer.qiniu.com/pili/sdk/7720/low-latency-live-broadcast-of-
the-sdk) > 低延时直播 SDK 下载体验
# 低延时直播 SDK 下载体验
最近更新时间: 2024-08-05 11:26:53
> **说明：**
> SDK 名称：低延迟播放器 SDK
> 开发者：上海七牛信息技术有限公司
> 低延迟播放器 SDK 合规使用说明请参考[七牛 SDK 合规使用说明
> __](https://developer.qiniu.com/pili/12616/sdk-compliance-
> instructions)；隐私政策说明请参考[七牛 SDK 隐私策略
> __](https://developer.qiniu.com/pili/8027/sdk-privacy-policy)
# SDK 下载
Android SDK 下载：[QNRTPlayer-Android v1.0.3 __](https://github.com/pili-
engineering/QNRTPlayer-Android/tree/v1.0.3)
iOS SDK 下载：[QNRTPlayer-iOS v1.0.4 __](https://github.com/pili-
engineering/QNRTPlayer-iOS/tree/v1.0.4)
Web SDK 下载：[QNRTPlayer-Web v1.0.8 __](https://github.com/pili-
engineering/QNRTPlayer-Web)
# Demo 体验
Web Demo：<https://pili-player-demo.qiniu.com/>[ __](https://pili-player-
demo.qiniu.com/)
Android Demo:<http://fir.qiniuapi.com/dun3>[__](http://fir.qiniuapi.com/dun3)
iOS Demo:
<https://testflight.apple.com/join/qZY1QFvV>[__](https://testflight.apple.com/join/qZY1QFvV)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > [低延时直播
SDK](https://developer.qiniu.com/pili/sdk/7720/low-latency-live-broadcast-of-
the-sdk) > 低延时直播 SDK 下载体验
# 低延时直播 SDK 下载体验
最近更新时间: 2024-08-05 11:26:53
> **说明：**
> SDK 名称：低延迟播放器 SDK
> 开发者：上海七牛信息技术有限公司
> 低延迟播放器 SDK 合规使用说明请参考[七牛 SDK 合规使用说明
> __](https://developer.qiniu.com/pili/12616/sdk-compliance-
> instructions)；隐私政策说明请参考[七牛 SDK 隐私策略
> __](https://developer.qiniu.com/pili/8027/sdk-privacy-policy)
# SDK 下载
Android SDK 下载：[QNRTPlayer-Android v1.0.3 __](https://github.com/pili-
engineering/QNRTPlayer-Android/tree/v1.0.3)
iOS SDK 下载：[QNRTPlayer-iOS v1.0.4 __](https://github.com/pili-
engineering/QNRTPlayer-iOS/tree/v1.0.4)
Web SDK 下载：[QNRTPlayer-Web v1.0.8 __](https://github.com/pili-
engineering/QNRTPlayer-Web)
# Demo 体验
Web Demo：<https://pili-player-demo.qiniu.com/>[ __](https://pili-player-
demo.qiniu.com/)
Android Demo:<http://fir.qiniuapi.com/dun3>[__](http://fir.qiniuapi.com/dun3)
iOS Demo:
<https://testflight.apple.com/join/qZY1QFvV>[__](https://testflight.apple.com/join/qZY1QFvV)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,086 |
低延时 Web SDK | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > [低延时直播
SDK](https://developer.qiniu.com/pili/sdk/7720/low-latency-live-broadcast-of-
the-sdk) > 低延时 Web SDK
# 低延时 Web SDK
最近更新时间: 2024-08-20 17:02:03
# 七牛低延时直播接入指南
步骤一： 提供拉流域名做低延迟配置[（提交工单）
__](https://support.qiniu.com/tickets/new/form?category=%E5%85%B6%E4%BB%96%E7%B1%BB%E5%92%A8%E8%AF%A2&description=%E4%B8%83%E7%89%9B%E4%BD%8E%E5%BB%B6%E6%97%B6%E7%9B%B4%E6%92%AD%E6%8E%A5%E5%85%A5%E6%B5%8B%E8%AF%95%E7%94%B3%E8%AF%B7&method=PC%20%E6%8E%A8%E6%B5%81&space=%E7%9B%B4%E6%92%AD%E4%BA%91&title=%E4%B8%83%E7%89%9B%E4%BD%8E%E5%BB%B6%E6%97%B6%E7%9B%B4%E6%92%AD)
步骤二： 推流端推流（不能包含 B 帧）
步骤三： 使用七牛的播放器拉流
**服务 TIPS**
1.低延时直播采用 RTC 相关技术，大部分浏览器原生支持 RTC 播放，适用性更强；播放延迟小于 1 秒，适用于大部分对延迟有要求的直播场景。
2.推流端推流直播流中不包含 B 帧【推流命令样例：./ffmpeg -re -i “/_/_ /_/_.mp4” -c copy -c:v libx264
-bf 0 -f flv ‘rtmp://pili-publish.marsyu.site/lb-
test/20200125h265test?expire=1610992020&token=W9G5v8_h5k6mgwshHQ2l7zB6NC4=’】，不符合要求的直播流可能会出现卡顿/画面撕裂等问题；若推流侧无法自行适配，可以使用我们的服务端转码功能，在播放
URL 流名称后面添加 `@zerolatency` 转码规格 (转码将增加 200-400ms
延时，对播放延时有极高要求的客户请适配低延时推流规格，[转码将收取额外费用
__](https://developer.qiniu.com/pili/kb/2653/on-live-streaming-real-time-
transcoding-control-multi-rate-service-side-watermark))。
3.[<低延时 Web SDK>__](https://developer.qiniu.com/pili/7730/geek-web-sdk)需要浏览器支持
RTC 和 H264 解码，目前部分 Android 手机自带浏览器并未支持 RTC，在这种情况下，我们建议更换浏览器或直接使用移动端的 SDK[<低延时
iOS SDK>__](https://developer.qiniu.com/pili/7732/geek-ios-sdk)[<低延时 Android
SDK>__](https://developer.qiniu.com/pili/7731/geek-android-sdk)。
4.低延时直播 SDK 仅能播放低延时直播类型的直播流，如果需要播放 rtmp/flv/hls 或者 mp4 等视频流，请使用[标准播放器
__](https://developer.qiniu.com/pili/4262/player-sdk-introduction-and-demo-
download)进行播放。
# 产品介绍
七牛低延时直播（Geek）直播构建了全新的低延时直播互动体验，相比于传统的直播能力降低了延时、优化了协议与底层技术，目前对于**微信内直播**
的多业务场景提供了更为优渥的使用体验。支持千万级并发同时拥有毫秒级开播体验，打通了用户对于直播低延时性的核心诉求。
# 功能列表
* 支持七牛低延时直播流播放
* 支持播放状态回调
* 支持播放统计信息回调
* 支持纯音频播放
* 支持播放音量设置
* 支持 WHEP 协议拉流
# 浏览器兼容性说明
快直播依赖于浏览器提供的 WebRTC API 和 H264 解码能力，因此，SDK 是否可用，依赖于当前浏览器的支持情况。
下面是分别针对桌面端和移动端浏览器的兼容性报告。注意，由于平台和一些应用内置浏览器的实现各不相同，无法涵盖所有的浏览器，以下文档中未列举的浏览器并不代表不支持。建议在使用前，先通过下面列出的
getPlayerSupport 接口来判断 SDK 是否可用。
## 桌面端
操作系统 | 浏览器 | 版本兼容性
---|---|---
Mac OS | Safari 浏览器 | 11.0 或以上版本支持
Chrome 浏览器 | 56.0 或以上版本支持
Firefox 浏览器 | 56.0 或以上版本支持
Edge 浏览器 | 80.0 或以上版本支持
微信内置浏览器 | 支持
Windows | Chrome浏览器 | 56.0 或以上版本支持
Firefox 浏览器 | 56 或以上版本支持
QQ 浏览器 | 10.4 或以上版本支持
Edge 浏览器 | 80 或以上版本支持
微信内置浏览器 | 支持（建议最新版本）
## iOS
浏览器 | 支持情况
---|---
浏览器 | 支持情况
Safari 浏览器 | iOS 11 或以上版本支持
Chrome 浏览器 | iOS 12.1.4 或以上版本支持
Edge 浏览器 | iOS 12.1.4 或以上版本支持
企业微信浏览器 | iOS 12.1.4 或以上版本支持
微信浏览器 | iOS 12.1.4 或以上版本支持
内嵌WebView | iOS 12.1.4 或以上版本支持
## Android
浏览器 | 支持情况
---|---
浏览器 | 支持情况
Chrome 60+ | 支持
企业微信浏览器 | 支持
微信浏览器 | 支持
内嵌 Web View | 部分设备支持接收
以上列表中提供的浏览器可以大致表明兼容性情况，但由于 Android
设备上浏览器情况比较复杂，不同手机产商对自带浏览器内核或多或少做出改动，所以无法保证自带浏览器能够很好地支持 WebRTC，建议开发者使用 Chrome
浏览器。
# 接口说明
## 引入 SDK
SDK 提供了两种引入方式，可以直接下载 JS 文件，也可以通过 npm 完成引入。
### 1\. npm 引入
首先使用 npm 来将 SDK 安装到项目中。
npm install --save qn-rtplayer-web
然后在项目中使用 `import` 语法引入。
import { QNRTPlayer } from "qn-rtplayer-web";
const player = new QNRTPlayer();
### 2\. 直接导入 JS 文件
每次发布版本，我们都会将最新的 SDK JS 文件放在我们的 Github 上，每次想要升级版本时，只需要访问我们的 [Github
__](https://github.com/pili-engineering/QNRTPlayer-
Web/tree/main/releases)页面，然后替换一下自己的 JS 文件即可。
SDK 的 JS 文件在导入页面后，会自动创建一个全局对象 `QNRTPlayer`，这个对象的成员包括了 SDK 所导出的所有模块和对象。
const player = new QNRTPlayer.QNRTPlayer();
## 快速开始
使用 SDK 非常简单，完成以下几个步骤即可。
import { QNRTPlayer } from "qn-rtplayer-web";
// 1. 创建 QNRTPlayer 对象
const player = new QNRTPlayer();
// 2. 初始化配置信息
player.init();
// 3. 传入播放地址及容器，开始播放
player.play(
"webrtc://...",
document.getElementById("container");
);
## API 参考
### `init`
/**
* 传入配置对象，完成初始化配置
* @param {Config} config - 配置对象
*/
public init(config: Config): void
其中，配置对象 `Config` 的结构如下：
interface Config {
/**
* 配置到媒体元素上的 class 值
*/
className?: string;
/**
* 媒体宽度，合法的 CSS 字符串值
*/
width?: string;
/**
* 媒体高度，合法的 CSS 字符串值
*/
height?: string;
/**
* 合法的 CSS object-fit 值
*/
objectFit?: string;
/**
* 音量 0-1 范围
*/
volumn?: number;
/**
* 是否开启 video 媒体元素控制 UI
*/
controls?: boolean;
/**
* opens the inline mode of ios and WeChat on the mobile phone
* see: https://webkit.org/blog/6784/new-video-policies-for-ios/
*/
playsinline?: boolean;
}
配置对象在 SDK 中的默认值如下：
const DEFAULT_CONFIG: Required<Config> = {
className: 'qn-rtplayer-media',
width: '100%',
height: '100%',
objectFit: 'contain',
volumn: 0.6,
controls: false,
playsinline: true,
};
### `setConfig`
在播放之后，如果想要动态修改播放器的配置信息，SDK 还提供了 `setConfig` 方法，传入相应修改值即可完成修改，函数签名如下。
/**
* 修改配置
* @param {Partial<Config>} config
*/
public setConfig(config: Partial<Config>): void
### `getConfig`
/**
* 获取当前播放器配置信息
* @return {Config} config
*/
public getConfig(): Config
### `play`
在调用 `init` 方法之后，再调用 `play` 方法，即可开始播放。
/**
* 播放
* @param {string} url 播放地址
* @param {HTMLElement} container 容器
*/
public async play(url: string, container: HTMLElement): Promise<void>
如果不是在用户操作回调函数中调用该方法，可能出现播放失败的情况。建议将该方法放在用户操作回调函数中，防止浏览器自动播放策略阻止播放。如果播放失败，返回值
Promise 会进入 reject 状态。建议始终监控返回值，当出现播放失败的情况后，通过弹窗等方式引导用户操作，并在用户操作回调函数中调用
`resume` 方法来恢复播放。
### `pause`
/**
* 暂停
*/
public pause(): void
### `resume`
/**
* 恢复播放
*/
public resume(): Promise<void>
### `hasAudio`
/**
* 是否存在音频流
* @return {boolean}
*/
public hasAudio(): boolean
### `hasVideo`
/**
* 是否存在视频流
* @return {boolean}
*/
public hasVideo(): boolean
### `setAudioVolume`
/**
* 设置音量
* @param {Number} volume - 音量，范围 0-1
*/
public setAudioVolume(volume: number)
### `getAudioVolume`
/**
* 获取当前音量
* @return {number} - 音量，范围 0-1
*/
public getAudioVolume(): number
### `muteAudio`
/**
* 静音音频
*/
public muteAudio(): void
### `unmuteAudio`
/**
* 取消音频静音
*/
public unmuteAudio(): void
### `muteVideo`
/**
* 仅播放音频，不播放视频
*/
public muteVideo(): void
> 视频 mute 状态时，SDK 仍在接收视频流数据，但是不做渲染。
### `unmuteVideo`
/**
* 取消视频 mute 状态
*/
public unmuteVideo(): void
### `isPlaying`
/**
* 当前是否处于播放状态
* @return {boolean}
*/
public isPlaying(): boolean
### `stop`
/**
* 停止播放
*/
public stop(): void
### `release`
/**
* 释放状态
*/
public release(): void
> 注意，调用 `release` 方法之后，SDK 会清空所有状态，如果想要再次播放，需要重新调用 `init` 方法。
### `getPlayerSupport`
/**
* 获取支持信息
* @return {PlayerSupport | undefined} undefined 表示支持信息尚未获取完成
*/
public getPlayerSupport(): PlayerSupport | undefined
其中 `PlayerSupport` 接口结构如下：
interface PlayerSupport {
/**
* 是否支持 RTC
*/
peerConnection: boolean,
/**
* 是否支持 H264
*/
H264: boolean,
/**
* 是否支持获取流状态
*/
getStats: boolean,
}
### `setLogLevel`
指定 SDK 日志输出等级。注意这是一个静态方法。
public static setLogLevel(level: LogLevel)
### `version`
/**
* 获取 SDK 版本号
*/
public get version(): string
### `playerStateChanged` 事件
播放器内部状态改变时，会触发该事件。
player.on('playerStateChanged', (state: PlayerState) => {
// ...
});
其中，`PlayerState` 是下面的枚举值。
export enum PlayerState {
/**
* 播放器默认状态，release 后也回到该状态
*/
STATE_IDLE = 0,
/**
* 播放器已完成初始化，init 之后进入该状态
*/
STATE_INIT = 1,
/**
* 播放器连接完成状态，完成和媒体服务连接后进入该状态
*/
STATE_READY = 2,
/**
* 播放器正在播放状态，当有音视频帧渲染后进入该状态
*/
STATE_PLAYING = 3,
/**
* 播放器停止状态，stop 之后进入该状态
*/
STATE_STOP = 4,
/**
* 播放器错误状态，当播放发生错误进入该状态
*/
STATE_ERROR = 5,
}
### `stats` 事件
监听 `stats` 事件，可以获得当前媒体流的状态数据。
player.on('stats', (data: StatReport) => {
// ...
});
其中，`StatReport` 的结构如下：
interface StatReport {
/**
* 音频码率（kbps）
*/
audioBitrate: number;
/**
* 视频码率（kbps）
*/
videoBitrate: number;
/**
* 视频流宽
*/
frameWidth: number;
/**
* 视频流高
*/
frameHeight: number;
/**
* 帧率
*/
frameRate: number;
}
### `error` 事件
SDK 内部对常见的错误进行了封装，可以通过监听 `error` 事件获取错误信息。
当连接因网络等原因异常断开时，会触发 `disconnect` 事件。
player.on('error', (error: SDKError) => {
// ...
});
其中，`SDKError` 的格式为：
interface SDKError {
code: number;
errorType: string;
msg: string;
}
`SDKError` 中使用 `code` 与不同类型的错误做了分类，不同 code 的含义具体如下：
code | errorType | 含义
---|---|---
20001 | networkError | 网络错误
20002 | authFailed | 请求服务鉴权失败
20003 | playStreamNotExist | 媒体流不存在
20004 | playRequestFailed | 请求参数/服务端错误
20005 | descriptionError | SDP Description 错误
20006 | connectFailed | PeerConnection 连接异常断开
30001 | rtcNotSupport | 设备不支持 RTC/H264
### `log` 事件
监听 `log` 事件可以获取 SDK 的日志信息。
player.on('log', (data: SDKLogInfo) => {
// ...
});
其中，`SDKLogInfo` 的结构如下：
interface SDKLogInfo {
time: string;
level: LogLevel;
msg: string;
id: string;
}
type LogLevel = 'disable' | 'error' | 'warning' | 'debug' | 'log';
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > [低延时直播
SDK](https://developer.qiniu.com/pili/sdk/7720/low-latency-live-broadcast-of-
the-sdk) > 低延时 Web SDK
# 低延时 Web SDK
最近更新时间: 2024-08-20 17:02:03
# 七牛低延时直播接入指南
步骤一： 提供拉流域名做低延迟配置[（提交工单）
__](https://support.qiniu.com/tickets/new/form?category=%E5%85%B6%E4%BB%96%E7%B1%BB%E5%92%A8%E8%AF%A2&description=%E4%B8%83%E7%89%9B%E4%BD%8E%E5%BB%B6%E6%97%B6%E7%9B%B4%E6%92%AD%E6%8E%A5%E5%85%A5%E6%B5%8B%E8%AF%95%E7%94%B3%E8%AF%B7&method=PC%20%E6%8E%A8%E6%B5%81&space=%E7%9B%B4%E6%92%AD%E4%BA%91&title=%E4%B8%83%E7%89%9B%E4%BD%8E%E5%BB%B6%E6%97%B6%E7%9B%B4%E6%92%AD)
步骤二： 推流端推流（不能包含 B 帧）
步骤三： 使用七牛的播放器拉流
**服务 TIPS**
1.低延时直播采用 RTC 相关技术，大部分浏览器原生支持 RTC 播放，适用性更强；播放延迟小于 1 秒，适用于大部分对延迟有要求的直播场景。
2.推流端推流直播流中不包含 B 帧【推流命令样例：./ffmpeg -re -i “/_/_ /_/_.mp4” -c copy -c:v libx264
-bf 0 -f flv ‘rtmp://pili-publish.marsyu.site/lb-
test/20200125h265test?expire=1610992020&token=W9G5v8_h5k6mgwshHQ2l7zB6NC4=’】，不符合要求的直播流可能会出现卡顿/画面撕裂等问题；若推流侧无法自行适配，可以使用我们的服务端转码功能，在播放
URL 流名称后面添加 `@zerolatency` 转码规格 (转码将增加 200-400ms
延时，对播放延时有极高要求的客户请适配低延时推流规格，[转码将收取额外费用
__](https://developer.qiniu.com/pili/kb/2653/on-live-streaming-real-time-
transcoding-control-multi-rate-service-side-watermark))。
3.[<低延时 Web SDK>__](https://developer.qiniu.com/pili/7730/geek-web-sdk)需要浏览器支持
RTC 和 H264 解码，目前部分 Android 手机自带浏览器并未支持 RTC，在这种情况下，我们建议更换浏览器或直接使用移动端的 SDK[<低延时
iOS SDK>__](https://developer.qiniu.com/pili/7732/geek-ios-sdk)[<低延时 Android
SDK>__](https://developer.qiniu.com/pili/7731/geek-android-sdk)。
4.低延时直播 SDK 仅能播放低延时直播类型的直播流，如果需要播放 rtmp/flv/hls 或者 mp4 等视频流，请使用[标准播放器
__](https://developer.qiniu.com/pili/4262/player-sdk-introduction-and-demo-
download)进行播放。
# 产品介绍
七牛低延时直播（Geek）直播构建了全新的低延时直播互动体验，相比于传统的直播能力降低了延时、优化了协议与底层技术，目前对于**微信内直播**
的多业务场景提供了更为优渥的使用体验。支持千万级并发同时拥有毫秒级开播体验，打通了用户对于直播低延时性的核心诉求。
# 功能列表
* 支持七牛低延时直播流播放
* 支持播放状态回调
* 支持播放统计信息回调
* 支持纯音频播放
* 支持播放音量设置
* 支持 WHEP 协议拉流
# 浏览器兼容性说明
快直播依赖于浏览器提供的 WebRTC API 和 H264 解码能力，因此，SDK 是否可用，依赖于当前浏览器的支持情况。
下面是分别针对桌面端和移动端浏览器的兼容性报告。注意，由于平台和一些应用内置浏览器的实现各不相同，无法涵盖所有的浏览器，以下文档中未列举的浏览器并不代表不支持。建议在使用前，先通过下面列出的
getPlayerSupport 接口来判断 SDK 是否可用。
## 桌面端
操作系统 | 浏览器 | 版本兼容性
---|---|---
Mac OS | Safari 浏览器 | 11.0 或以上版本支持
Chrome 浏览器 | 56.0 或以上版本支持
Firefox 浏览器 | 56.0 或以上版本支持
Edge 浏览器 | 80.0 或以上版本支持
微信内置浏览器 | 支持
Windows | Chrome浏览器 | 56.0 或以上版本支持
Firefox 浏览器 | 56 或以上版本支持
QQ 浏览器 | 10.4 或以上版本支持
Edge 浏览器 | 80 或以上版本支持
微信内置浏览器 | 支持（建议最新版本）
## iOS
浏览器 | 支持情况
---|---
浏览器 | 支持情况
Safari 浏览器 | iOS 11 或以上版本支持
Chrome 浏览器 | iOS 12.1.4 或以上版本支持
Edge 浏览器 | iOS 12.1.4 或以上版本支持
企业微信浏览器 | iOS 12.1.4 或以上版本支持
微信浏览器 | iOS 12.1.4 或以上版本支持
内嵌WebView | iOS 12.1.4 或以上版本支持
## Android
浏览器 | 支持情况
---|---
浏览器 | 支持情况
Chrome 60+ | 支持
企业微信浏览器 | 支持
微信浏览器 | 支持
内嵌 Web View | 部分设备支持接收
以上列表中提供的浏览器可以大致表明兼容性情况，但由于 Android
设备上浏览器情况比较复杂，不同手机产商对自带浏览器内核或多或少做出改动，所以无法保证自带浏览器能够很好地支持 WebRTC，建议开发者使用 Chrome
浏览器。
# 接口说明
## 引入 SDK
SDK 提供了两种引入方式，可以直接下载 JS 文件，也可以通过 npm 完成引入。
### 1\. npm 引入
首先使用 npm 来将 SDK 安装到项目中。
npm install --save qn-rtplayer-web
然后在项目中使用 `import` 语法引入。
import { QNRTPlayer } from "qn-rtplayer-web";
const player = new QNRTPlayer();
### 2\. 直接导入 JS 文件
每次发布版本，我们都会将最新的 SDK JS 文件放在我们的 Github 上，每次想要升级版本时，只需要访问我们的 [Github
__](https://github.com/pili-engineering/QNRTPlayer-
Web/tree/main/releases)页面，然后替换一下自己的 JS 文件即可。
SDK 的 JS 文件在导入页面后，会自动创建一个全局对象 `QNRTPlayer`，这个对象的成员包括了 SDK 所导出的所有模块和对象。
const player = new QNRTPlayer.QNRTPlayer();
## 快速开始
使用 SDK 非常简单，完成以下几个步骤即可。
import { QNRTPlayer } from "qn-rtplayer-web";
// 1. 创建 QNRTPlayer 对象
const player = new QNRTPlayer();
// 2. 初始化配置信息
player.init();
// 3. 传入播放地址及容器，开始播放
player.play(
"webrtc://...",
document.getElementById("container");
);
## API 参考
### `init`
/**
* 传入配置对象，完成初始化配置
* @param {Config} config - 配置对象
*/
public init(config: Config): void
其中，配置对象 `Config` 的结构如下：
interface Config {
/**
* 配置到媒体元素上的 class 值
*/
className?: string;
/**
* 媒体宽度，合法的 CSS 字符串值
*/
width?: string;
/**
* 媒体高度，合法的 CSS 字符串值
*/
height?: string;
/**
* 合法的 CSS object-fit 值
*/
objectFit?: string;
/**
* 音量 0-1 范围
*/
volumn?: number;
/**
* 是否开启 video 媒体元素控制 UI
*/
controls?: boolean;
/**
* opens the inline mode of ios and WeChat on the mobile phone
* see: https://webkit.org/blog/6784/new-video-policies-for-ios/
*/
playsinline?: boolean;
}
配置对象在 SDK 中的默认值如下：
const DEFAULT_CONFIG: Required<Config> = {
className: 'qn-rtplayer-media',
width: '100%',
height: '100%',
objectFit: 'contain',
volumn: 0.6,
controls: false,
playsinline: true,
};
### `setConfig`
在播放之后，如果想要动态修改播放器的配置信息，SDK 还提供了 `setConfig` 方法，传入相应修改值即可完成修改，函数签名如下。
/**
* 修改配置
* @param {Partial<Config>} config
*/
public setConfig(config: Partial<Config>): void
### `getConfig`
/**
* 获取当前播放器配置信息
* @return {Config} config
*/
public getConfig(): Config
### `play`
在调用 `init` 方法之后，再调用 `play` 方法，即可开始播放。
/**
* 播放
* @param {string} url 播放地址
* @param {HTMLElement} container 容器
*/
public async play(url: string, container: HTMLElement): Promise<void>
如果不是在用户操作回调函数中调用该方法，可能出现播放失败的情况。建议将该方法放在用户操作回调函数中，防止浏览器自动播放策略阻止播放。如果播放失败，返回值
Promise 会进入 reject 状态。建议始终监控返回值，当出现播放失败的情况后，通过弹窗等方式引导用户操作，并在用户操作回调函数中调用
`resume` 方法来恢复播放。
### `pause`
/**
* 暂停
*/
public pause(): void
### `resume`
/**
* 恢复播放
*/
public resume(): Promise<void>
### `hasAudio`
/**
* 是否存在音频流
* @return {boolean}
*/
public hasAudio(): boolean
### `hasVideo`
/**
* 是否存在视频流
* @return {boolean}
*/
public hasVideo(): boolean
### `setAudioVolume`
/**
* 设置音量
* @param {Number} volume - 音量，范围 0-1
*/
public setAudioVolume(volume: number)
### `getAudioVolume`
/**
* 获取当前音量
* @return {number} - 音量，范围 0-1
*/
public getAudioVolume(): number
### `muteAudio`
/**
* 静音音频
*/
public muteAudio(): void
### `unmuteAudio`
/**
* 取消音频静音
*/
public unmuteAudio(): void
### `muteVideo`
/**
* 仅播放音频，不播放视频
*/
public muteVideo(): void
> 视频 mute 状态时，SDK 仍在接收视频流数据，但是不做渲染。
### `unmuteVideo`
/**
* 取消视频 mute 状态
*/
public unmuteVideo(): void
### `isPlaying`
/**
* 当前是否处于播放状态
* @return {boolean}
*/
public isPlaying(): boolean
### `stop`
/**
* 停止播放
*/
public stop(): void
### `release`
/**
* 释放状态
*/
public release(): void
> 注意，调用 `release` 方法之后，SDK 会清空所有状态，如果想要再次播放，需要重新调用 `init` 方法。
### `getPlayerSupport`
/**
* 获取支持信息
* @return {PlayerSupport | undefined} undefined 表示支持信息尚未获取完成
*/
public getPlayerSupport(): PlayerSupport | undefined
其中 `PlayerSupport` 接口结构如下：
interface PlayerSupport {
/**
* 是否支持 RTC
*/
peerConnection: boolean,
/**
* 是否支持 H264
*/
H264: boolean,
/**
* 是否支持获取流状态
*/
getStats: boolean,
}
### `setLogLevel`
指定 SDK 日志输出等级。注意这是一个静态方法。
public static setLogLevel(level: LogLevel)
### `version`
/**
* 获取 SDK 版本号
*/
public get version(): string
### `playerStateChanged` 事件
播放器内部状态改变时，会触发该事件。
player.on('playerStateChanged', (state: PlayerState) => {
// ...
});
其中，`PlayerState` 是下面的枚举值。
export enum PlayerState {
/**
* 播放器默认状态，release 后也回到该状态
*/
STATE_IDLE = 0,
/**
* 播放器已完成初始化，init 之后进入该状态
*/
STATE_INIT = 1,
/**
* 播放器连接完成状态，完成和媒体服务连接后进入该状态
*/
STATE_READY = 2,
/**
* 播放器正在播放状态，当有音视频帧渲染后进入该状态
*/
STATE_PLAYING = 3,
/**
* 播放器停止状态，stop 之后进入该状态
*/
STATE_STOP = 4,
/**
* 播放器错误状态，当播放发生错误进入该状态
*/
STATE_ERROR = 5,
}
### `stats` 事件
监听 `stats` 事件，可以获得当前媒体流的状态数据。
player.on('stats', (data: StatReport) => {
// ...
});
其中，`StatReport` 的结构如下：
interface StatReport {
/**
* 音频码率（kbps）
*/
audioBitrate: number;
/**
* 视频码率（kbps）
*/
videoBitrate: number;
/**
* 视频流宽
*/
frameWidth: number;
/**
* 视频流高
*/
frameHeight: number;
/**
* 帧率
*/
frameRate: number;
}
### `error` 事件
SDK 内部对常见的错误进行了封装，可以通过监听 `error` 事件获取错误信息。
当连接因网络等原因异常断开时，会触发 `disconnect` 事件。
player.on('error', (error: SDKError) => {
// ...
});
其中，`SDKError` 的格式为：
interface SDKError {
code: number;
errorType: string;
msg: string;
}
`SDKError` 中使用 `code` 与不同类型的错误做了分类，不同 code 的含义具体如下：
code | errorType | 含义
---|---|---
20001 | networkError | 网络错误
20002 | authFailed | 请求服务鉴权失败
20003 | playStreamNotExist | 媒体流不存在
20004 | playRequestFailed | 请求参数/服务端错误
20005 | descriptionError | SDP Description 错误
20006 | connectFailed | PeerConnection 连接异常断开
30001 | rtcNotSupport | 设备不支持 RTC/H264
### `log` 事件
监听 `log` 事件可以获取 SDK 的日志信息。
player.on('log', (data: SDKLogInfo) => {
// ...
});
其中，`SDKLogInfo` 的结构如下：
interface SDKLogInfo {
time: string;
level: LogLevel;
msg: string;
id: string;
}
type LogLevel = 'disable' | 'error' | 'warning' | 'debug' | 'log';
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,089 |
低延时 Android SDK | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > [低延时直播
SDK](https://developer.qiniu.com/pili/sdk/7720/low-latency-live-broadcast-of-
the-sdk) > 低延时 Android SDK
# 低延时 Android SDK
最近更新时间: 2024-08-20 16:14:35
# 七牛低延时直播接入指南
步骤一： 提供拉流域名做低延迟配置[（提交工单）
__](https://support.qiniu.com/tickets/new/form?category=%E5%85%B6%E4%BB%96%E7%B1%BB%E5%92%A8%E8%AF%A2&description=%E4%B8%83%E7%89%9B%E4%BD%8E%E5%BB%B6%E6%97%B6%E7%9B%B4%E6%92%AD%E6%8E%A5%E5%85%A5%E6%B5%8B%E8%AF%95%E7%94%B3%E8%AF%B7&method=PC%20%E6%8E%A8%E6%B5%81&space=%E7%9B%B4%E6%92%AD%E4%BA%91&title=%E4%B8%83%E7%89%9B%E4%BD%8E%E5%BB%B6%E6%97%B6%E7%9B%B4%E6%92%AD)
步骤二： 推流端推流（不能包含 B 帧）
步骤三： 使用七牛的播放器拉流
**服务 TIPS**
1.低延时直播采用 RTC 相关技术，大部分浏览器原生支持 RTC 播放，适用性更强；播放延迟小于 1 秒，适用于大部分对延迟有要求的直播场景
2.推流端推流直播流中不包含 B 帧【推流命令样例：./ffmpeg -re -i “/_/_ /_/_.mp4” -c copy -c:v libx264
-bf 0 -f flv ‘rtmp://pili-publish.marsyu.site/lb-
test/20200125h265test?expire=1610992020&token=W9G5v8_h5k6mgwshHQ2l7zB6NC4=’】，不符合要求的直播流可能会出现卡顿/画面撕裂等问题；若推流侧无法自行适配，可以使用我们的服务端转码功能，在播放
URL 流名称后面添加 `@zerolatency` 转码规格 (转码将增加 200-400ms
延时，对播放延时有极高要求的客户请适配低延时推流规格，[转码将收取额外费用
__](https://developer.qiniu.com/pili/kb/2653/on-live-streaming-real-time-
transcoding-control-multi-rate-service-side-watermark))
3.[<低延时 Web SDK>__](https://developer.qiniu.com/pili/7730/geek-web-sdk)需要浏览器支持
RTC 和 H264 解码，目前部分 Android 手机自带浏览器并未支持 RTC，在这种情况下，我们建议更换浏览器或直接使用移动端的 SDK[<低延时
iOS SDK>__](https://developer.qiniu.com/pili/7732/geek-ios-sdk)[<低延时 Android
SDK>__](https://developer.qiniu.com/pili/7731/geek-android-sdk)
4.低延时直播SDK仅能播放低延时直播类型的直播流，如果需要播放rtmp/flv/hls/或者mp4等视频流，请使用[标准播放器
__](https://developer.qiniu.com/pili/1210/the-android-client-sdk)进行播放
5.使用七牛的安卓推流 SDK，按照如下设置即可保证直播流中不包含B帧：
H264Profile 设置成 BASELINE
StreamingProfile.VideoProfile vProfile = new
StreamingProfile.VideoProfile(fps,
birate,
gop,
StreamingProfile.H264Profile.BASELINE);
# 1\. 概述
七牛低延时直播（Geek）直播构建了全新的低延时直播互动体验，相比于传统的直播能力降低了延时、优化了协议与底层技术，目前对于微信内直播多业务场景提供了更为优渥的使用体验。支持千万级并发同时拥有毫秒级开播体验，打通了用户对于直播低延时性的核心诉求。
# 2\. 功能列表
* 支持七牛低延时直播流播放
* 支持播放状态回调
* 支持播放统计信息回调
* 支持纯音频或纯视频播放
* 支持播放音量设置
* 支持播放画面截图
* 支持 WHEP 协议拉流
# 3\. 引入 SDK
## 3.1 设备以及系统要求
* 系统要求：Android 4.3 (API 18) 及以上
## 3.2 开发环境
* Android Studio 开发工具，官方[下载地址](http://developer.android.com/intl/zh-cn/sdk/index.html)
* Android 官方开发 SDK，官方[下载地址](https://developer.android.com/intl/zh-cn/sdk/index.html#Other)
## 3.3 下载和导入实时音视频 SDK
SDK 主要包含 demo 代码、SDK jar 包，以及 SDK 依赖的动态库文件。
其中，release 目录下是需要拷贝到您的 Android 工程的所有文件，以目前主流的 armeabi-v7a 架构为例，具体如下：
文件名称 | 功能 | 大小 | 备注
---|---|---|---
qndroid-rtplayer-x.y.z.jar | SDK 库 | 535 KB | 必须依赖
libqndroid_rtc.so | 快直播拉流播放 | 9.15 MB | 必须依赖
* 将 qndroid-rtplayer-x.y.z.jar 包拷贝到您的工程的 libs 目录下
* 将动态库拷贝到您的工程对应的目录下，例如：armeabi-v7a 目录下的 so 则拷贝到工程的 jniLibs/armeabi-v7a 目录下
> 导入后生成的 APK 与未导入前相比，大小增加了 3M。
具体可以参考 SDK 包含的 demo 工程，集成后的工程示例如下：
## 3.4 修改 build.gradle
打开工程目录下的 build.gradle，确保已经添加了如下依赖，如下所示：
dependencies {
implementation files('libs/qndroid-rtplayer-x.y.z.jar')
}
## 3.5 添加混淆
如果工程中添加了混淆，则七牛的包也需要添加混淆规则，在 proguard-rules.pro 文件下添加以下代码：
-keep class org.qnwebrtc.** {*;}
-dontwarn org.qnwebrtc.**
-keep class com.qiniu.droid.rtplayer.**{*;}
-keep interface com.qiniu.droid.rtplayer.**{*;}
## 3.6 添加相关权限
在工程的 AndroidManifest.xml 中增加如下 `uses-permission` 声明：
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
在 Android 6.0 (API 23) 开始，用户需要在应用运行时授予权限，而不是在应用安装时授予，并分为正常权限和危险权限两种类型。在快直播 SDK
中，用户需要在`WRITE_EXTERNAL_STORAGE` 权限，具体可参考 [Android 官方文档
__](https://developer.android.com/training/permissions/requesting?hl=zh-cn)。
# 4\. 快速开始
## 4.1 添加播放需要的渲染控件
用户需要在布局文件中期望的位置添加 QNSurfaceView 或者 QNTextureView 用来做播放渲染窗口。
示例代码如下：
<com.qiniu.droid.rtplayer.render.QNSurfaceView
android:id="@+id/render_view"
android:layout_width="match_parent"
android:layout_height="match_parent" />
mRenderView = findViewById(R.id.render_view);
* * *
## 4.2 创播放器对象
本操作推荐在 Activity 生命周期中的 onCreate() 中完成
mRTPlayer = QNRTPlayerFactory.createQNRTPlayer(getApplicationContext());
## 4.3 进行初始化设置以及渲染窗口设置
mRTPlayer.initPlayer(mRTPlayerSetting);
mRTPlayer.setSurfaceRenderWindow(mRenderView);
## 4.4 设置回调
QNRTPlayer.EventListener 包含了播放过程中的状态，统计和错误回调，因此需要注册该监听器：
mRTPlayer.setEventListener(listener);
## 4.5 开始播放
创建播放地址对象 QNRTPlayer 并开始播放
mRTUrl.setURL(videoPath);
mRTPlayer.playUrl(mRTUrl);
* * *
## 4.6 销毁
在整个 Activity 销毁时，用户需要调用以下代码对资源进行释放，一般此操作建议在 Activity 生命周期的 `onDestroy()`
中进行，示例代码如下：
@Override
protected void onDestroy() {
super.onDestroy();
mRTPlayer.releasePlayer();
}
# 5 API 参考
## 5.1 QNRTPlayerUrl
播放地址类
public class QNRTPlayerUrl {
/**
* 媒体流地址
*/
private String mURL;
/**
* 是否强制拉取媒体流标志
*/
private boolean mForceReset;
/**
* 请求流播放地址是否为 HTTP，默认为 true
* <p>
* 当请求播放一个实时流地址时，播放器将会根据流地址域名生成一个 HTTP / HTTPS 请求地址来发送播放请求,<br>
* 如果这个域名有做过证书绑定，应设置为 HTTPS；反之则需要设置为 HTTP
* <p/>
*/
private boolean mHttpPost = true;
}
## 5.2 QNConfiguration
播放配置类
public class QNConfiguration {
/**
* 配置播放是否回调统计信息
* <p>配置参数类型为 long 类型：<br>
* 0 表示关闭统计回调<br>
* > 0 表示以该值表示的周期回调统计信息，单位 MS<br>
* <p/>
*
* @see QNRTPlayerStats
*/
public static final String CONF_PLAY_STAT = "QNPlayConfStat";
/**
* 配置开关 SDK 日志文件
* <p>
* 配置参数类型为 boolean
* <p/>
*/
public static final String CONF_DEBUG_FILE = "QNPlayConfDebugFile";
}
## 5.3 QNRTPlayerSetting
播放设置类
public class QNRTPlayerSetting {
/**
* 获取当前解码模式枚举, 默认为 {@link QNDecodeMode#HARDWARE}
*
* @return 解码模式枚举
*/
public QNDecodeMode getDecodeMode();
/**
* 设置解码模式枚举
*
* @param mDecodeMode 解码模式枚举
*/
public QNRTPlayerSetting setDecodeMode(QNDecodeMode mDecodeMode);
/**
* 获取当前日志等级
*
* @return 日志等级枚举
*/
public QNLogLevel getLogLevel();
/**
* 设置播放器日志等级
*
* @param mLogLevel 日志等级枚举
*/
public QNRTPlayerSetting setLogLevel(QNLogLevel mLogLevel);
/**
* 抖动缓冲区的最小延迟
*
* @return 抖动缓冲区的最小延迟，单位：s
*/
public double getJitterBufferMinimumDelay();
/**
* 设置抖动缓冲区的最小延迟
* 默认为 0，不开启抖动延迟，时间单位为秒，范围 [0, 1]
*
* @param delaySeconds 抖动缓冲区最小延迟，单位：s
*/
public QNRTPlayerSetting setJitterBufferMinimumDelay(double delaySeconds);
}
## 5.4 QNRTPlayerFactory
播放对象工厂类
public class QNRTPlayerFactory {
/**
* 创建播放器对象
*
* @param context 应用 context
* @return 播放器对象
*/
public static QNRTPlayer createQNRTPlayer(Context context);
}
## 5.5 QNRTPlayer
播放核心接口类
public interface QNRTPlayer {
@Documented
@Retention(RetentionPolicy.SOURCE)
@IntDef({STATE_IDLE, STATE_INIT, STATE_READY, STATE_PLAYING,
STATE_STOP, STATE_ERROR})
@interface PlayerState {}
/**
* 播放器默认状态，{@link #releasePlayer} 也将回到该状态
*/
int STATE_IDLE = 0;
/**
* 播放器已完成初始化，{@link #initPlayer} 后进入该状态
*/
int STATE_INIT = 1;
/**
* 播放器连接完成状态，{@link #playUrl(QNRTPlayerUrl)} 完成和媒体服务连接后进入该状态
*/
int STATE_READY = 2;
/**
* 播放器正在播放状态，当有音视频帧渲染后进入该状态
*/
int STATE_PLAYING = 3;
/**
* 播放器停止状态，{@link #stopPlay()} 后进入该状态
*/
int STATE_STOP = 4;
/**
* 播放器错误状态，当播放发生错误进入该状态
*/
int STATE_ERROR = 5;
@Documented
@Retention(RetentionPolicy.SOURCE)
@IntDef({INFO_FIRST_VIDEO_DECODE, INFO_FIRST_AUDIO_DECODE,
INFO_VIDEO_SIZE_CHANGE, INFO_AUDIO_TRACK_RECEIVED, INFO_VIDEO_TRACK_RECEIVED, INFO_STATS_UPDATE})
@interface PlayerInfo {}
/**
* 收到第一个解码后的视频帧触发
* <p> 回调 onPlayerInfo#info 为空
*/
int INFO_FIRST_VIDEO_DECODE = 0;
/**
* 收到第一个解码后的音频帧触发
* <p> 回调 onPlayerInfo#info 为空
*/
int INFO_FIRST_AUDIO_DECODE = 1;
/**
* 视频帧大小变化时触发
* <p> 回调 onPlayerInfo#info 为 QNSize
*/
int INFO_VIDEO_SIZE_CHANGE = 2;
/**
* 媒体流收到音频轨道信息时触发
* <p> 回调 onPlayerInfo#info 为空
*/
int INFO_AUDIO_TRACK_RECEIVED = 3;
/**
* 媒体流收到视频轨道信息时触发
* <p> 回调 onPlayerInfo#info 为空
*/
int INFO_VIDEO_TRACK_RECEIVED = 4;
/**
* 播放器回调码率等信息时触发 {@link QNRTPlayerStats}
* <p> 回调 onPlayerInfo#info 为 QNRTPlayerStats
*/
int INFO_STATS_UPDATE = 5;
interface EventListener {
/**
* 播放状态变化回调
*
* @param state 播放状态
*/
void onPlayerStateChanged(@PlayerState int state);
/**
* 播放事件回调
*
* @param type 播放事件类型
* @param info 播放事件描对象
*/
void onPlayerInfo(@PlayerInfo int type, Object info);
/**
* 播放错误回调
*
* @param error 错误描述对象
*/
void onPlayerError(QNError error);
}
/**
* 初始化播放器
*
* @param settings 初始化参数对象
*/
void initPlayer(QNRTPlayerSetting settings);
/**
* 设置播放器监听对象
*
* @param listener 监听对象
*/
void setEventListener(EventListener listener);
/**
* 设置基于 SurfaceView 的渲染控件
*
* @param view 控件对象
*/
void setSurfaceRenderWindow(QNSurfaceView view);
/**
* 设置基于 TextureView 的渲染控件
*
* @param view 控件对象
*/
void setTextureRenderWindow(QNTextureView view);
/**
* 开始播放媒体流
*
* @param url 媒体流地址
*/
void playUrl(QNRTPlayerUrl url);
/**
* 是否正在播放
*
* @return 播放状态
*/
boolean isPlaying();
/**
* 获取当前媒体流是否含有视频轨
*
* @return 是否含有视频轨
*/
boolean hasVideo();
/**
* 获取当前媒体流是否含有音频轨
*
* @return 是否含有音频轨
*/
boolean hasAudio();
/**
* 获取当前播放状态
*
* @return 播放状态
*/
@PlayerState
int getPlayerState();
/**
* 设置视频 mute
* <p>播放器是否渲染视频帧，mute 后画面为最后一帧数据<p/>
*
* @param mute mute 标志
*/
void muteVideo(boolean mute);
/**
* 设置音频 mute
* <p>播放器不再播放音频<p/>
*
* @param mute mute 标志
*/
void muteAudio(boolean mute);
/**
* 设置播放音量
*
* @param volume 音量值 0 - 1；默认值为 1.0
*/
void setVolume(float volume);
/**
* 获取当前播放音量
*
* @return 播放音量
*/
float getVolume();
/**
* 获取视频截图
*
* @param callback 视频截图结果回调
*/
void takeSnapshot(QNTakeSnapshotCallback callback);
/**
* 设置抖动缓冲区的最小延迟
* 默认为 0，不开启抖动延迟，时间单位为秒，范围 [0, 1]
*
* @param delaySeconds 抖动缓冲区最小延迟，单位：s
*/
void setJitterBufferMinimumDelay(double delaySeconds);
/**
* 停止媒体流播放，播放器不再接收媒体数据
*/
void stopPlay();
/**
* 配置播放参数
*
* @param configure 配置描述对象
*/
void configurePlayer(QNConfiguration configure);
/**
* 获取当前播放配置
*
* @return QNConfiguration 配置对象
*/
QNConfiguration getConfigure();
/**
* 释放播放器相关资源
*/
void releasePlayer();
}
## 5.6 QNError
播放错误码
public class QNError {
/**
* 播放请求网络错误，如请求域名超时或者服务不可达
*/
public static final int QN_NETWORK_ERROR = 20001;
/**
* 播放请求鉴权错误，需要确认流地址的签算是否正确
*/
public static final int QN_PLAY_AUTH_FAILED = 20002;
/**
* 播放流地址不存在错误
*/
public static final int QN_PLAY_STREAM_NOT_EXIST = 20003;
/**
* 播放请求失败，如服务异常
*/
public static final int QN_PLAY_REQUEST_FAILED = 20004;
/**
* 播放设置内部描述信息失败
*/
public static final int QN_DESCRIPTION_ERROR = 20005;
/**
* 播放连接异常断开
*/
public static final int QN_CONNECTION_ERROR = 20006;
}
## 5.7 QNRTPlayerStats
播放统计信息对象
public class QNRTPlayerStats {
/**
* 帧率
*/
public int frameRate;
/**
* 视频码率, 单位 bps
*/
public int videoBitrate;
/**
* 音频码率, 单位 bps
*/
public int audioBitrate;
}
## 5.8 QNRenderMode
播放控件渲染模式
public enum QNRenderMode {
/**
* 在不超过控件大小情况下，显示视频帧大小
*/
SCALE_ASPECT_FIT,
/**
* 填充显示控件大小
*/
SCALE_ASPECT_FILL,
/**
* 当视频大于控件大小时，取一定比列的视频帧显示
*/
SCALE_ASPECT_BALANCED;
}
**注意：** 设置 QNRenderMode 需要保证 xml 中 `QNSurfaceView` 的布局宽高配置为 `wrap_content`
方可生效
## 5.9 QNLogLevel
SDK 日志等级
public enum QNLogLevel {
VERBOSE,
INFO,
WARNING,
ERROR,
NONE
}
日志级别如下：
日志级别 | 描述
---|---
VERBOSE | 输出大于或等于 VERBOSE 日志级别的信息
INFO | 输出大于或等于 INFO 日志级别的信息
WARNING | 输出大于或等于 WARNING 日志级别的信息
ERROR | 输出大于或等于 ERROR 日志级别的信息
NONE | 关闭日志的输出
## 5.10 QNDecodeMode
播放解码模式
public enum QNDecodeMode {
/**
* 硬件解码模式
*/
HARDWARE,
/**
* 软件解码模式
*/
SOFTWARE,
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > [低延时直播
SDK](https://developer.qiniu.com/pili/sdk/7720/low-latency-live-broadcast-of-
the-sdk) > 低延时 Android SDK
# 低延时 Android SDK
最近更新时间: 2024-08-20 16:14:35
# 七牛低延时直播接入指南
步骤一： 提供拉流域名做低延迟配置[（提交工单）
__](https://support.qiniu.com/tickets/new/form?category=%E5%85%B6%E4%BB%96%E7%B1%BB%E5%92%A8%E8%AF%A2&description=%E4%B8%83%E7%89%9B%E4%BD%8E%E5%BB%B6%E6%97%B6%E7%9B%B4%E6%92%AD%E6%8E%A5%E5%85%A5%E6%B5%8B%E8%AF%95%E7%94%B3%E8%AF%B7&method=PC%20%E6%8E%A8%E6%B5%81&space=%E7%9B%B4%E6%92%AD%E4%BA%91&title=%E4%B8%83%E7%89%9B%E4%BD%8E%E5%BB%B6%E6%97%B6%E7%9B%B4%E6%92%AD)
步骤二： 推流端推流（不能包含 B 帧）
步骤三： 使用七牛的播放器拉流
**服务 TIPS**
1.低延时直播采用 RTC 相关技术，大部分浏览器原生支持 RTC 播放，适用性更强；播放延迟小于 1 秒，适用于大部分对延迟有要求的直播场景
2.推流端推流直播流中不包含 B 帧【推流命令样例：./ffmpeg -re -i “/_/_ /_/_.mp4” -c copy -c:v libx264
-bf 0 -f flv ‘rtmp://pili-publish.marsyu.site/lb-
test/20200125h265test?expire=1610992020&token=W9G5v8_h5k6mgwshHQ2l7zB6NC4=’】，不符合要求的直播流可能会出现卡顿/画面撕裂等问题；若推流侧无法自行适配，可以使用我们的服务端转码功能，在播放
URL 流名称后面添加 `@zerolatency` 转码规格 (转码将增加 200-400ms
延时，对播放延时有极高要求的客户请适配低延时推流规格，[转码将收取额外费用
__](https://developer.qiniu.com/pili/kb/2653/on-live-streaming-real-time-
transcoding-control-multi-rate-service-side-watermark))
3.[<低延时 Web SDK>__](https://developer.qiniu.com/pili/7730/geek-web-sdk)需要浏览器支持
RTC 和 H264 解码，目前部分 Android 手机自带浏览器并未支持 RTC，在这种情况下，我们建议更换浏览器或直接使用移动端的 SDK[<低延时
iOS SDK>__](https://developer.qiniu.com/pili/7732/geek-ios-sdk)[<低延时 Android
SDK>__](https://developer.qiniu.com/pili/7731/geek-android-sdk)
4.低延时直播SDK仅能播放低延时直播类型的直播流，如果需要播放rtmp/flv/hls/或者mp4等视频流，请使用[标准播放器
__](https://developer.qiniu.com/pili/1210/the-android-client-sdk)进行播放
5.使用七牛的安卓推流 SDK，按照如下设置即可保证直播流中不包含B帧：
H264Profile 设置成 BASELINE
StreamingProfile.VideoProfile vProfile = new
StreamingProfile.VideoProfile(fps,
birate,
gop,
StreamingProfile.H264Profile.BASELINE);
# 1\. 概述
七牛低延时直播（Geek）直播构建了全新的低延时直播互动体验，相比于传统的直播能力降低了延时、优化了协议与底层技术，目前对于微信内直播多业务场景提供了更为优渥的使用体验。支持千万级并发同时拥有毫秒级开播体验，打通了用户对于直播低延时性的核心诉求。
# 2\. 功能列表
* 支持七牛低延时直播流播放
* 支持播放状态回调
* 支持播放统计信息回调
* 支持纯音频或纯视频播放
* 支持播放音量设置
* 支持播放画面截图
* 支持 WHEP 协议拉流
# 3\. 引入 SDK
## 3.1 设备以及系统要求
* 系统要求：Android 4.3 (API 18) 及以上
## 3.2 开发环境
* Android Studio 开发工具，官方[下载地址](http://developer.android.com/intl/zh-cn/sdk/index.html)
* Android 官方开发 SDK，官方[下载地址](https://developer.android.com/intl/zh-cn/sdk/index.html#Other)
## 3.3 下载和导入实时音视频 SDK
SDK 主要包含 demo 代码、SDK jar 包，以及 SDK 依赖的动态库文件。
其中，release 目录下是需要拷贝到您的 Android 工程的所有文件，以目前主流的 armeabi-v7a 架构为例，具体如下：
文件名称 | 功能 | 大小 | 备注
---|---|---|---
qndroid-rtplayer-x.y.z.jar | SDK 库 | 535 KB | 必须依赖
libqndroid_rtc.so | 快直播拉流播放 | 9.15 MB | 必须依赖
* 将 qndroid-rtplayer-x.y.z.jar 包拷贝到您的工程的 libs 目录下
* 将动态库拷贝到您的工程对应的目录下，例如：armeabi-v7a 目录下的 so 则拷贝到工程的 jniLibs/armeabi-v7a 目录下
> 导入后生成的 APK 与未导入前相比，大小增加了 3M。
具体可以参考 SDK 包含的 demo 工程，集成后的工程示例如下：
## 3.4 修改 build.gradle
打开工程目录下的 build.gradle，确保已经添加了如下依赖，如下所示：
dependencies {
implementation files('libs/qndroid-rtplayer-x.y.z.jar')
}
## 3.5 添加混淆
如果工程中添加了混淆，则七牛的包也需要添加混淆规则，在 proguard-rules.pro 文件下添加以下代码：
-keep class org.qnwebrtc.** {*;}
-dontwarn org.qnwebrtc.**
-keep class com.qiniu.droid.rtplayer.**{*;}
-keep interface com.qiniu.droid.rtplayer.**{*;}
## 3.6 添加相关权限
在工程的 AndroidManifest.xml 中增加如下 `uses-permission` 声明：
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
在 Android 6.0 (API 23) 开始，用户需要在应用运行时授予权限，而不是在应用安装时授予，并分为正常权限和危险权限两种类型。在快直播 SDK
中，用户需要在`WRITE_EXTERNAL_STORAGE` 权限，具体可参考 [Android 官方文档
__](https://developer.android.com/training/permissions/requesting?hl=zh-cn)。
# 4\. 快速开始
## 4.1 添加播放需要的渲染控件
用户需要在布局文件中期望的位置添加 QNSurfaceView 或者 QNTextureView 用来做播放渲染窗口。
示例代码如下：
<com.qiniu.droid.rtplayer.render.QNSurfaceView
android:id="@+id/render_view"
android:layout_width="match_parent"
android:layout_height="match_parent" />
mRenderView = findViewById(R.id.render_view);
* * *
## 4.2 创播放器对象
本操作推荐在 Activity 生命周期中的 onCreate() 中完成
mRTPlayer = QNRTPlayerFactory.createQNRTPlayer(getApplicationContext());
## 4.3 进行初始化设置以及渲染窗口设置
mRTPlayer.initPlayer(mRTPlayerSetting);
mRTPlayer.setSurfaceRenderWindow(mRenderView);
## 4.4 设置回调
QNRTPlayer.EventListener 包含了播放过程中的状态，统计和错误回调，因此需要注册该监听器：
mRTPlayer.setEventListener(listener);
## 4.5 开始播放
创建播放地址对象 QNRTPlayer 并开始播放
mRTUrl.setURL(videoPath);
mRTPlayer.playUrl(mRTUrl);
* * *
## 4.6 销毁
在整个 Activity 销毁时，用户需要调用以下代码对资源进行释放，一般此操作建议在 Activity 生命周期的 `onDestroy()`
中进行，示例代码如下：
@Override
protected void onDestroy() {
super.onDestroy();
mRTPlayer.releasePlayer();
}
# 5 API 参考
## 5.1 QNRTPlayerUrl
播放地址类
public class QNRTPlayerUrl {
/**
* 媒体流地址
*/
private String mURL;
/**
* 是否强制拉取媒体流标志
*/
private boolean mForceReset;
/**
* 请求流播放地址是否为 HTTP，默认为 true
* <p>
* 当请求播放一个实时流地址时，播放器将会根据流地址域名生成一个 HTTP / HTTPS 请求地址来发送播放请求,<br>
* 如果这个域名有做过证书绑定，应设置为 HTTPS；反之则需要设置为 HTTP
* <p/>
*/
private boolean mHttpPost = true;
}
## 5.2 QNConfiguration
播放配置类
public class QNConfiguration {
/**
* 配置播放是否回调统计信息
* <p>配置参数类型为 long 类型：<br>
* 0 表示关闭统计回调<br>
* > 0 表示以该值表示的周期回调统计信息，单位 MS<br>
* <p/>
*
* @see QNRTPlayerStats
*/
public static final String CONF_PLAY_STAT = "QNPlayConfStat";
/**
* 配置开关 SDK 日志文件
* <p>
* 配置参数类型为 boolean
* <p/>
*/
public static final String CONF_DEBUG_FILE = "QNPlayConfDebugFile";
}
## 5.3 QNRTPlayerSetting
播放设置类
public class QNRTPlayerSetting {
/**
* 获取当前解码模式枚举, 默认为 {@link QNDecodeMode#HARDWARE}
*
* @return 解码模式枚举
*/
public QNDecodeMode getDecodeMode();
/**
* 设置解码模式枚举
*
* @param mDecodeMode 解码模式枚举
*/
public QNRTPlayerSetting setDecodeMode(QNDecodeMode mDecodeMode);
/**
* 获取当前日志等级
*
* @return 日志等级枚举
*/
public QNLogLevel getLogLevel();
/**
* 设置播放器日志等级
*
* @param mLogLevel 日志等级枚举
*/
public QNRTPlayerSetting setLogLevel(QNLogLevel mLogLevel);
/**
* 抖动缓冲区的最小延迟
*
* @return 抖动缓冲区的最小延迟，单位：s
*/
public double getJitterBufferMinimumDelay();
/**
* 设置抖动缓冲区的最小延迟
* 默认为 0，不开启抖动延迟，时间单位为秒，范围 [0, 1]
*
* @param delaySeconds 抖动缓冲区最小延迟，单位：s
*/
public QNRTPlayerSetting setJitterBufferMinimumDelay(double delaySeconds);
}
## 5.4 QNRTPlayerFactory
播放对象工厂类
public class QNRTPlayerFactory {
/**
* 创建播放器对象
*
* @param context 应用 context
* @return 播放器对象
*/
public static QNRTPlayer createQNRTPlayer(Context context);
}
## 5.5 QNRTPlayer
播放核心接口类
public interface QNRTPlayer {
@Documented
@Retention(RetentionPolicy.SOURCE)
@IntDef({STATE_IDLE, STATE_INIT, STATE_READY, STATE_PLAYING,
STATE_STOP, STATE_ERROR})
@interface PlayerState {}
/**
* 播放器默认状态，{@link #releasePlayer} 也将回到该状态
*/
int STATE_IDLE = 0;
/**
* 播放器已完成初始化，{@link #initPlayer} 后进入该状态
*/
int STATE_INIT = 1;
/**
* 播放器连接完成状态，{@link #playUrl(QNRTPlayerUrl)} 完成和媒体服务连接后进入该状态
*/
int STATE_READY = 2;
/**
* 播放器正在播放状态，当有音视频帧渲染后进入该状态
*/
int STATE_PLAYING = 3;
/**
* 播放器停止状态，{@link #stopPlay()} 后进入该状态
*/
int STATE_STOP = 4;
/**
* 播放器错误状态，当播放发生错误进入该状态
*/
int STATE_ERROR = 5;
@Documented
@Retention(RetentionPolicy.SOURCE)
@IntDef({INFO_FIRST_VIDEO_DECODE, INFO_FIRST_AUDIO_DECODE,
INFO_VIDEO_SIZE_CHANGE, INFO_AUDIO_TRACK_RECEIVED, INFO_VIDEO_TRACK_RECEIVED, INFO_STATS_UPDATE})
@interface PlayerInfo {}
/**
* 收到第一个解码后的视频帧触发
* <p> 回调 onPlayerInfo#info 为空
*/
int INFO_FIRST_VIDEO_DECODE = 0;
/**
* 收到第一个解码后的音频帧触发
* <p> 回调 onPlayerInfo#info 为空
*/
int INFO_FIRST_AUDIO_DECODE = 1;
/**
* 视频帧大小变化时触发
* <p> 回调 onPlayerInfo#info 为 QNSize
*/
int INFO_VIDEO_SIZE_CHANGE = 2;
/**
* 媒体流收到音频轨道信息时触发
* <p> 回调 onPlayerInfo#info 为空
*/
int INFO_AUDIO_TRACK_RECEIVED = 3;
/**
* 媒体流收到视频轨道信息时触发
* <p> 回调 onPlayerInfo#info 为空
*/
int INFO_VIDEO_TRACK_RECEIVED = 4;
/**
* 播放器回调码率等信息时触发 {@link QNRTPlayerStats}
* <p> 回调 onPlayerInfo#info 为 QNRTPlayerStats
*/
int INFO_STATS_UPDATE = 5;
interface EventListener {
/**
* 播放状态变化回调
*
* @param state 播放状态
*/
void onPlayerStateChanged(@PlayerState int state);
/**
* 播放事件回调
*
* @param type 播放事件类型
* @param info 播放事件描对象
*/
void onPlayerInfo(@PlayerInfo int type, Object info);
/**
* 播放错误回调
*
* @param error 错误描述对象
*/
void onPlayerError(QNError error);
}
/**
* 初始化播放器
*
* @param settings 初始化参数对象
*/
void initPlayer(QNRTPlayerSetting settings);
/**
* 设置播放器监听对象
*
* @param listener 监听对象
*/
void setEventListener(EventListener listener);
/**
* 设置基于 SurfaceView 的渲染控件
*
* @param view 控件对象
*/
void setSurfaceRenderWindow(QNSurfaceView view);
/**
* 设置基于 TextureView 的渲染控件
*
* @param view 控件对象
*/
void setTextureRenderWindow(QNTextureView view);
/**
* 开始播放媒体流
*
* @param url 媒体流地址
*/
void playUrl(QNRTPlayerUrl url);
/**
* 是否正在播放
*
* @return 播放状态
*/
boolean isPlaying();
/**
* 获取当前媒体流是否含有视频轨
*
* @return 是否含有视频轨
*/
boolean hasVideo();
/**
* 获取当前媒体流是否含有音频轨
*
* @return 是否含有音频轨
*/
boolean hasAudio();
/**
* 获取当前播放状态
*
* @return 播放状态
*/
@PlayerState
int getPlayerState();
/**
* 设置视频 mute
* <p>播放器是否渲染视频帧，mute 后画面为最后一帧数据<p/>
*
* @param mute mute 标志
*/
void muteVideo(boolean mute);
/**
* 设置音频 mute
* <p>播放器不再播放音频<p/>
*
* @param mute mute 标志
*/
void muteAudio(boolean mute);
/**
* 设置播放音量
*
* @param volume 音量值 0 - 1；默认值为 1.0
*/
void setVolume(float volume);
/**
* 获取当前播放音量
*
* @return 播放音量
*/
float getVolume();
/**
* 获取视频截图
*
* @param callback 视频截图结果回调
*/
void takeSnapshot(QNTakeSnapshotCallback callback);
/**
* 设置抖动缓冲区的最小延迟
* 默认为 0，不开启抖动延迟，时间单位为秒，范围 [0, 1]
*
* @param delaySeconds 抖动缓冲区最小延迟，单位：s
*/
void setJitterBufferMinimumDelay(double delaySeconds);
/**
* 停止媒体流播放，播放器不再接收媒体数据
*/
void stopPlay();
/**
* 配置播放参数
*
* @param configure 配置描述对象
*/
void configurePlayer(QNConfiguration configure);
/**
* 获取当前播放配置
*
* @return QNConfiguration 配置对象
*/
QNConfiguration getConfigure();
/**
* 释放播放器相关资源
*/
void releasePlayer();
}
## 5.6 QNError
播放错误码
public class QNError {
/**
* 播放请求网络错误，如请求域名超时或者服务不可达
*/
public static final int QN_NETWORK_ERROR = 20001;
/**
* 播放请求鉴权错误，需要确认流地址的签算是否正确
*/
public static final int QN_PLAY_AUTH_FAILED = 20002;
/**
* 播放流地址不存在错误
*/
public static final int QN_PLAY_STREAM_NOT_EXIST = 20003;
/**
* 播放请求失败，如服务异常
*/
public static final int QN_PLAY_REQUEST_FAILED = 20004;
/**
* 播放设置内部描述信息失败
*/
public static final int QN_DESCRIPTION_ERROR = 20005;
/**
* 播放连接异常断开
*/
public static final int QN_CONNECTION_ERROR = 20006;
}
## 5.7 QNRTPlayerStats
播放统计信息对象
public class QNRTPlayerStats {
/**
* 帧率
*/
public int frameRate;
/**
* 视频码率, 单位 bps
*/
public int videoBitrate;
/**
* 音频码率, 单位 bps
*/
public int audioBitrate;
}
## 5.8 QNRenderMode
播放控件渲染模式
public enum QNRenderMode {
/**
* 在不超过控件大小情况下，显示视频帧大小
*/
SCALE_ASPECT_FIT,
/**
* 填充显示控件大小
*/
SCALE_ASPECT_FILL,
/**
* 当视频大于控件大小时，取一定比列的视频帧显示
*/
SCALE_ASPECT_BALANCED;
}
**注意：** 设置 QNRenderMode 需要保证 xml 中 `QNSurfaceView` 的布局宽高配置为 `wrap_content`
方可生效
## 5.9 QNLogLevel
SDK 日志等级
public enum QNLogLevel {
VERBOSE,
INFO,
WARNING,
ERROR,
NONE
}
日志级别如下：
日志级别 | 描述
---|---
VERBOSE | 输出大于或等于 VERBOSE 日志级别的信息
INFO | 输出大于或等于 INFO 日志级别的信息
WARNING | 输出大于或等于 WARNING 日志级别的信息
ERROR | 输出大于或等于 ERROR 日志级别的信息
NONE | 关闭日志的输出
## 5.10 QNDecodeMode
播放解码模式
public enum QNDecodeMode {
/**
* 硬件解码模式
*/
HARDWARE,
/**
* 软件解码模式
*/
SOFTWARE,
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,104 |
低延时 iOS SDK | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > [低延时直播
SDK](https://developer.qiniu.com/pili/sdk/7720/low-latency-live-broadcast-of-
the-sdk) > 低延时 iOS SDK
# 低延时 iOS SDK
最近更新时间: 2024-08-20 16:15:04
# 七牛低延时直播接入指南
步骤一： 提供拉流域名做低延迟配置[（提交工单）
__](https://support.qiniu.com/tickets/new/form?category=%E5%85%B6%E4%BB%96%E7%B1%BB%E5%92%A8%E8%AF%A2&description=%E4%B8%83%E7%89%9B%E4%BD%8E%E5%BB%B6%E6%97%B6%E7%9B%B4%E6%92%AD%E6%8E%A5%E5%85%A5%E6%B5%8B%E8%AF%95%E7%94%B3%E8%AF%B7&method=PC%20%E6%8E%A8%E6%B5%81&space=%E7%9B%B4%E6%92%AD%E4%BA%91&title=%E4%B8%83%E7%89%9B%E4%BD%8E%E5%BB%B6%E6%97%B6%E7%9B%B4%E6%92%AD)
步骤二： 推流端推流（不能包含 B 帧）
步骤三： 使用七牛的播放器拉流
**服务 TIPS**
1.低延时直播采用 RTC 相关技术，大部分浏览器原生支持 RTC 播放，适用性更强；播放延迟小于 1 秒，适用于大部分对延迟有要求的直播场景
2.推流端推流直播流中不包含 B 帧【推流命令样例：./ffmpeg -re -i “/_/_ /_/_.mp4” -c copy -c:v libx264
-bf 0 -f flv ‘rtmp://pili-publish.marsyu.site/lb-
test/20200125h265test?expire=1610992020&token=W9G5v8_h5k6mgwshHQ2l7zB6NC4=’】，不符合要求的直播流可能会出现卡顿/画面撕裂等问题；若推流侧无法自行适配，可以使用我们的服务端转码功能，在播放
URL 流名称后面添加 `@zerolatency` 转码规格 (转码将增加 200-400ms
延时，对播放延时有极高要求的客户请适配低延时推流规格，[转码将收取额外费用
__](https://developer.qiniu.com/pili/kb/2653/on-live-streaming-real-time-
transcoding-control-multi-rate-service-side-watermark))
3.[<低延时 Web SDK>__](https://developer.qiniu.com/pili/7730/geek-web-sdk)需要浏览器支持
RTC 和 H264 解码，目前部分 Android 手机自带浏览器并未支持 RTC，在这种情况下，我们建议更换浏览器或直接使用移动端的 SDK[<低延时
iOS SDK>__](https://developer.qiniu.com/pili/7732/geek-ios-sdk)[<低延时 Android
SDK>__](https://developer.qiniu.com/pili/7731/geek-android-sdk)
4.低延时直播SDK仅能播放低延时直播类型的直播流，如果需要播放rtmp/flv/hls/或者mp4等视频流，请使用[标准播放器
__](https://developer.qiniu.com/pili/1211/ios-playback-end-the-sdk)进行播放
5.使用七牛的 iOS 推流 SDK，按照如下设置即可保证直播流中不包含 B 帧：
PLVideoStreamingConfiguration 的 videoProfileLevel 的设置选择 H264Baseline 类型
videoProfileLevel:AVVideoProfileLevelH264BaselineAutoLevel
# QNRTPlayerKit
七牛低延时直播构建了全新的低延时直播互动体验，相比于传统的直播能力降低了延时、优化了协议与底层技术，目前对于微信内直播多业务场景提供了更为优渥的使用体验。支持千万级并发同时拥有毫秒级开播体验，打通了用户对于直播低延时性的核心诉求。
## 功能特性
* 支持 H.264 视频解码
* 支持 Opus 音频解码
* 支持 HeaderDoc 文档
* 支持 ARMv7, ARM64, i386, x86_64 架构
* 支持纯音频或纯视频播放
* 支持自定义音视频处理
* 支持苹果 ATS 安全标准
* 支持 WHEP 协议拉流
## 系统要求
* iOS Target : >= iOS 9
* iOS Device : >= iPhone 5s
## 安装方法
[CocoaPods __](https://cocoapods.org/)是针对 Objective-C 的依赖管理工具，它能够将使用类似
QNRTPlayerKit 的第三方库的安装过程变得非常简单和自动化，你能够用下面的命令来安装它：
$ sudo gem install cocoapods
### Podfile
为了使用 CoacoaPods 集成 QNRTPlayerKit 到你的 Xcode 工程当中，你需要编写你的 `Podfile`
source 'https://github.com/CocoaPods/Specs.git'
target 'TargetName' do
pod 'QNRTPlayerKit'
end
* 默认为真机版
* 若需要使用模拟器 + 真机版，则改用如下配置
pod "QNRTPlayerKit", :podspec => 'https://raw.githubusercontent.com/pili-engineering/QNRTPlayer-iOS/master/QNRTPlayerKit-Universal.podspec'
**注意：鉴于目前 iOS 上架，只支持动态库真机，请在 App 上架前，更换至真机版本**
然后，运行如下的命令：
$ pod install
## 反馈及意见
当你遇到任何问题时，可以通过在 GitHub 的 repo 提交 issues 来反馈问题，请尽可能的描述清楚遇到的问题，如果有错误信息也一同附带，并且在
Labels 中指明类型为 bug 或者其他。
[通过这里查看已有的 issues 和提交 Bug。 __](https://github.com/pili-engineering/QNRTPlayer-
iOS/issues)
# API参考
## QNRTPlayer
`QNRTPlayer` 为建立音视频播放的核心类，包含播放、停止，静音等接口。
### 属性
#### playState
#### 定义
@property (nonatomic, assign, readonly) QNRTPlayState playState;
#### 说明：播放的状态，当播放状态变更时会通过 `- (void)RTPlayer:(QNRTPlayer *)player
playStateDidChange:(QNRTPlayState)playState;` 方法回调。
#### delegate
#### 定义
@property (nonatomic, weak) id<QNRTPlayerDelegate> delegate;
#### 说明：状态回调的 delegate。
#### isPlaying
#### 定义
@property (nonatomic, assign, readonly) BOOL isPlaying;
#### 说明：是否在播放状态
#### playUrl
#### 定义
@property (nonatomic, copy, readonly) NSURL *playUrl;
#### 说明：播放的 URL
#### statisticInterval
#### 定义
@property (nonatomic, assign) NSUInteger statisticInterval;
#### 说明：统计信息回调的时间间隔，单位为秒。默认为 0，即默认不会回调统计信息。
#### volume
#### 定义
@property (nonatomic, assign) double volume;
#### 说明：播放音量
#### width
#### 定义
@property (nonatomic, assign, readonly) CGFloat width;
#### 说明：视频的宽
#### height
#### 定义
@property (nonatomic, assign, readonly) CGFloat height;
#### 说明：视频的高
#### playView
#### 定义
@property (nonatomic, strong) QNRTVideoView *playView;
#### 说明：渲染播放画面
### 方法
#### playWithUrl:supportHttps:
#### 定义
- (void)playWithUrl:(NSURL *)url supportHttps:(BOOL)isSupport;
#### 参数
参数名 | 描述
---|---
url | 需要播放的 url ，目前支持rtmp、hls、hdl和webrtc (url 以 webrtc:// 开头) 协议
isSupport | 当前播放 URL 是否支持 SSL 证书，默认为 NO
#### 说明：开始播放新的 url
#### 注意： 1. 当前 iOS 系统网络限制，默认不支持 http 带域名访问，需要支持 SSL，且 isSupport 为 YES，或者开启 ATS
支持 HTTP 带域名访问，即可正常播放。 2. 播放域名需在七牛配置并完成解析，如播放失败请联系我们处理。
#### stop
#### 定义
- (void)stop;
#### 说明：停止播放
#### muteAudio:
#### 定义
- (void)muteAudio:(BOOL)mute;
#### 参数
参数名 | 描述
---|---
mute | 是否需要静音
#### 说明：静音
#### muteVideo:
#### 定义
- (void)muteVideo:(BOOL)mute;
#### 参数
参数名 | 描述
---|---
mute | 是否需要画面渲染
#### 说明：停止画面渲染
#### setSpeakerOn:
#### 定义
- (void)setSpeakerOn:(BOOL)speakerOn;
#### 参数
参数名 | 描述
---|---
speakerOn | 扬声器开关
#### 说明：是否将声音从扬声器输出
#### 注意：默认值为 NO，传入 YES 时，会强制声音从扬声器输出。另外，由于系统原因，在某些设备（如 iPhone XS Max、iPhone 8
Plus）上，连接 AirPods 后无法通过该接口将声音强制设为扬声器输出。如有需求，可以通过使用 AVRoutePickerView 来切换。
#### takeScreenshotCallback:
#### 定义
- (void)takeScreenshotCallback:(QNScreenshotResultCallback)resultCallback;
#### 参数
参数名 | 描述
---|---
resultCallback | 截图的结果回调
#### 说明：截图播放画面
#### 注意：成功则回调图片，失败则回调错误。拉到首帧之后才可正常截图。
#### setJitterBufferMinDelay:
#### 定义
- (void)setJitterBufferMinDelay:(double)jitterBufferMinDelay;
#### 参数
参数名 | 描述
---|---
jitterBufferMinDelay | 抖动缓冲区最小延迟
#### 说明：设置抖动缓冲区的最小延迟
#### 注意：默认为 0，不开启抖动延迟，时间单位为秒，范围 [0, 1]，建议不超过 600ms。
#### enableFileLogging
#### 定义
+ (void)enableFileLogging;
#### 说明：开启文件日志，建议在 App 启动时即开启，日志文件位于 App App
Container/Library/Caches/Pili/RTLogs 目录下以 QNRTPlayer+当前时间命名的目录内
> 注意：文件日志功能主要用于排查问题，打开文件日志功能会对性能有一定影响，上线前请记得关闭文件日志功能！
#### versionInfo
#### 定义
+ (NSString *)versionInfo;
#### 说明：获取 SDK 的版本信息。
## QNRTPlayerDelegate
`QNRTPlayerDelegate` 在 QNRTPlayer 运行过程中的状态和事件回调
### 方法
#### RTPlayer:didFailWithError:
#### 定义
- (void)RTPlayer:(QNRTPlayer *)player didFailWithError:(NSError *)error;
#### 参数
参数名 | 描述
---|---
player | QNRTPlayer 实例
error | 错误内容
#### 说明：运行过程中发生错误会通过该方法回调
#### RTPlayer:playStateDidChange:
#### 定义
- (void)RTPlayer:(QNRTPlayer *)player playStateDidChange:(QNRTPlayState)playState;
#### 参数
参数名 | 描述
---|---
player | QNRTPlayer 实例
playState | playState 播放状态
#### 说明：在运行过程中，状态发生变化的回调
#### RTPlayer:didGetStatistic:
#### 定义
- (void)RTPlayer:(QNRTPlayer *)player didGetStatistic:(NSDictionary *)statistic;
#### 参数
参数名 | 描述
---|---
player | QNRTPlayer 实例
statistic | 统计信息 ，包括：音频码率，视频码率，视频帧率
#### 说明：统计信息回调，回调的时间间隔由 statisticInterval 参数决定，statisticInterval 默认为
0，即不回调统计信息。
#### RTPlayer:trackDidReceived
#### 定义
- (void)RTPlayer:(QNRTPlayer *)player trackDidReceived:(QNRTSourceKind )kind;
#### 参数
参数名 | 描述
---|---
player | QNRTPlayer 实例
kind | 数据类型
#### 说明：当前流媒体流收到数据 track。
#### RTCEngine:firstSourceDidDecode:
#### 定义
- (void)RTPlayer:(QNRTPlayer *)player firstSourceDidDecode:(QNRTSourceKind )kind;
#### 参数
参数名 | 描述
---|---
player | QNRTPlayer 实例
kind | 数据类型
#### 说明：音视频首帧解码后的回调。
## QNRTErrorDomain
`QNRTErrorDomain` 定义了播放过程中的错误信息,包括但不限于连接错误、鉴权失败等错误信息。
QNRTCErrorDomain | 错误码 | 功能
---|---|---
QNRTErrorNetworkError | 20001 | 服务请求超时，或者域名解析错误等
QNRTErrorAuthFailed | 20002 | 请求服务鉴权失败
QNRTErrorPlayStreamNotExit | 20003 | 播放流地址不存在
QNRTErrorPlayRequestFailed | 20004 | 对应服务 invalid parameter / server error
QNRTErrorDescriptionError | 20005 | 内部sdp错误
QNRTErrorConnectFailed | 20006 | 连接异常
QNRTErrorOperationNotAllowed | 20007 | 操作不被允许
## QNRTPlayState
`QNRTPlayState ` 定义了播放的状态。
QNRTPlayState | 功能
---|---
QNRTPlayStateUnknow | 未知状态，只会作为 init 前的初始状态，开始播放之后任何情况下都不会再回到此状态
QNRTPlayStateInit | 初始状态
QNRTPlayStateReady | 准备播放的状态
QNRTPlayStatePlaying | 正在播放的状态
QNRTPlayStateStoped | 停止播放的状态
QNRTPlayStateError | 播放发生错误的状态
## QNRTSourceKind
`QNRTSourceKind ` 定义了 source 的类型。
QNRTSourceKind | 功能
---|---
QNRTSourceKindAudio | 音频
QNRTSourceKindVideo | 视频
## QNRTVideoFillModeType
`QNRTVideoFillModeType` 定义了视频填充模式。
QNRTVideoFillModeType | 功能
---|---
QNRTVideoFillModeStretch | 拉伸以填充整个视图
QNRTVideoFillModePreserveAspectRatio | 画面均匀缩放的同时保持宽高比，添加指定背景色的条形
QNRTVideoFillModePreserveAspectRatioAndFill | 保持源图像的长宽比，放大其中心以填充视图
## QNScreenshotResultCallback
`QNScreenshotResultCallback` 定义了截图的回调。
typedef void (^QNScreenshotResultCallback)(UIImage *ShotImage, NSError *error);
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > [低延时直播
SDK](https://developer.qiniu.com/pili/sdk/7720/low-latency-live-broadcast-of-
the-sdk) > 低延时 iOS SDK
# 低延时 iOS SDK
最近更新时间: 2024-08-20 16:15:04
# 七牛低延时直播接入指南
步骤一： 提供拉流域名做低延迟配置[（提交工单）
__](https://support.qiniu.com/tickets/new/form?category=%E5%85%B6%E4%BB%96%E7%B1%BB%E5%92%A8%E8%AF%A2&description=%E4%B8%83%E7%89%9B%E4%BD%8E%E5%BB%B6%E6%97%B6%E7%9B%B4%E6%92%AD%E6%8E%A5%E5%85%A5%E6%B5%8B%E8%AF%95%E7%94%B3%E8%AF%B7&method=PC%20%E6%8E%A8%E6%B5%81&space=%E7%9B%B4%E6%92%AD%E4%BA%91&title=%E4%B8%83%E7%89%9B%E4%BD%8E%E5%BB%B6%E6%97%B6%E7%9B%B4%E6%92%AD)
步骤二： 推流端推流（不能包含 B 帧）
步骤三： 使用七牛的播放器拉流
**服务 TIPS**
1.低延时直播采用 RTC 相关技术，大部分浏览器原生支持 RTC 播放，适用性更强；播放延迟小于 1 秒，适用于大部分对延迟有要求的直播场景
2.推流端推流直播流中不包含 B 帧【推流命令样例：./ffmpeg -re -i “/_/_ /_/_.mp4” -c copy -c:v libx264
-bf 0 -f flv ‘rtmp://pili-publish.marsyu.site/lb-
test/20200125h265test?expire=1610992020&token=W9G5v8_h5k6mgwshHQ2l7zB6NC4=’】，不符合要求的直播流可能会出现卡顿/画面撕裂等问题；若推流侧无法自行适配，可以使用我们的服务端转码功能，在播放
URL 流名称后面添加 `@zerolatency` 转码规格 (转码将增加 200-400ms
延时，对播放延时有极高要求的客户请适配低延时推流规格，[转码将收取额外费用
__](https://developer.qiniu.com/pili/kb/2653/on-live-streaming-real-time-
transcoding-control-multi-rate-service-side-watermark))
3.[<低延时 Web SDK>__](https://developer.qiniu.com/pili/7730/geek-web-sdk)需要浏览器支持
RTC 和 H264 解码，目前部分 Android 手机自带浏览器并未支持 RTC，在这种情况下，我们建议更换浏览器或直接使用移动端的 SDK[<低延时
iOS SDK>__](https://developer.qiniu.com/pili/7732/geek-ios-sdk)[<低延时 Android
SDK>__](https://developer.qiniu.com/pili/7731/geek-android-sdk)
4.低延时直播SDK仅能播放低延时直播类型的直播流，如果需要播放rtmp/flv/hls/或者mp4等视频流，请使用[标准播放器
__](https://developer.qiniu.com/pili/1211/ios-playback-end-the-sdk)进行播放
5.使用七牛的 iOS 推流 SDK，按照如下设置即可保证直播流中不包含 B 帧：
PLVideoStreamingConfiguration 的 videoProfileLevel 的设置选择 H264Baseline 类型
videoProfileLevel:AVVideoProfileLevelH264BaselineAutoLevel
# QNRTPlayerKit
七牛低延时直播构建了全新的低延时直播互动体验，相比于传统的直播能力降低了延时、优化了协议与底层技术，目前对于微信内直播多业务场景提供了更为优渥的使用体验。支持千万级并发同时拥有毫秒级开播体验，打通了用户对于直播低延时性的核心诉求。
## 功能特性
* 支持 H.264 视频解码
* 支持 Opus 音频解码
* 支持 HeaderDoc 文档
* 支持 ARMv7, ARM64, i386, x86_64 架构
* 支持纯音频或纯视频播放
* 支持自定义音视频处理
* 支持苹果 ATS 安全标准
* 支持 WHEP 协议拉流
## 系统要求
* iOS Target : >= iOS 9
* iOS Device : >= iPhone 5s
## 安装方法
[CocoaPods __](https://cocoapods.org/)是针对 Objective-C 的依赖管理工具，它能够将使用类似
QNRTPlayerKit 的第三方库的安装过程变得非常简单和自动化，你能够用下面的命令来安装它：
$ sudo gem install cocoapods
### Podfile
为了使用 CoacoaPods 集成 QNRTPlayerKit 到你的 Xcode 工程当中，你需要编写你的 `Podfile`
source 'https://github.com/CocoaPods/Specs.git'
target 'TargetName' do
pod 'QNRTPlayerKit'
end
* 默认为真机版
* 若需要使用模拟器 + 真机版，则改用如下配置
pod "QNRTPlayerKit", :podspec => 'https://raw.githubusercontent.com/pili-engineering/QNRTPlayer-iOS/master/QNRTPlayerKit-Universal.podspec'
**注意：鉴于目前 iOS 上架，只支持动态库真机，请在 App 上架前，更换至真机版本**
然后，运行如下的命令：
$ pod install
## 反馈及意见
当你遇到任何问题时，可以通过在 GitHub 的 repo 提交 issues 来反馈问题，请尽可能的描述清楚遇到的问题，如果有错误信息也一同附带，并且在
Labels 中指明类型为 bug 或者其他。
[通过这里查看已有的 issues 和提交 Bug。 __](https://github.com/pili-engineering/QNRTPlayer-
iOS/issues)
# API参考
## QNRTPlayer
`QNRTPlayer` 为建立音视频播放的核心类，包含播放、停止，静音等接口。
### 属性
#### playState
#### 定义
@property (nonatomic, assign, readonly) QNRTPlayState playState;
#### 说明：播放的状态，当播放状态变更时会通过 `- (void)RTPlayer:(QNRTPlayer *)player
playStateDidChange:(QNRTPlayState)playState;` 方法回调。
#### delegate
#### 定义
@property (nonatomic, weak) id<QNRTPlayerDelegate> delegate;
#### 说明：状态回调的 delegate。
#### isPlaying
#### 定义
@property (nonatomic, assign, readonly) BOOL isPlaying;
#### 说明：是否在播放状态
#### playUrl
#### 定义
@property (nonatomic, copy, readonly) NSURL *playUrl;
#### 说明：播放的 URL
#### statisticInterval
#### 定义
@property (nonatomic, assign) NSUInteger statisticInterval;
#### 说明：统计信息回调的时间间隔，单位为秒。默认为 0，即默认不会回调统计信息。
#### volume
#### 定义
@property (nonatomic, assign) double volume;
#### 说明：播放音量
#### width
#### 定义
@property (nonatomic, assign, readonly) CGFloat width;
#### 说明：视频的宽
#### height
#### 定义
@property (nonatomic, assign, readonly) CGFloat height;
#### 说明：视频的高
#### playView
#### 定义
@property (nonatomic, strong) QNRTVideoView *playView;
#### 说明：渲染播放画面
### 方法
#### playWithUrl:supportHttps:
#### 定义
- (void)playWithUrl:(NSURL *)url supportHttps:(BOOL)isSupport;
#### 参数
参数名 | 描述
---|---
url | 需要播放的 url ，目前支持rtmp、hls、hdl和webrtc (url 以 webrtc:// 开头) 协议
isSupport | 当前播放 URL 是否支持 SSL 证书，默认为 NO
#### 说明：开始播放新的 url
#### 注意： 1. 当前 iOS 系统网络限制，默认不支持 http 带域名访问，需要支持 SSL，且 isSupport 为 YES，或者开启 ATS
支持 HTTP 带域名访问，即可正常播放。 2. 播放域名需在七牛配置并完成解析，如播放失败请联系我们处理。
#### stop
#### 定义
- (void)stop;
#### 说明：停止播放
#### muteAudio:
#### 定义
- (void)muteAudio:(BOOL)mute;
#### 参数
参数名 | 描述
---|---
mute | 是否需要静音
#### 说明：静音
#### muteVideo:
#### 定义
- (void)muteVideo:(BOOL)mute;
#### 参数
参数名 | 描述
---|---
mute | 是否需要画面渲染
#### 说明：停止画面渲染
#### setSpeakerOn:
#### 定义
- (void)setSpeakerOn:(BOOL)speakerOn;
#### 参数
参数名 | 描述
---|---
speakerOn | 扬声器开关
#### 说明：是否将声音从扬声器输出
#### 注意：默认值为 NO，传入 YES 时，会强制声音从扬声器输出。另外，由于系统原因，在某些设备（如 iPhone XS Max、iPhone 8
Plus）上，连接 AirPods 后无法通过该接口将声音强制设为扬声器输出。如有需求，可以通过使用 AVRoutePickerView 来切换。
#### takeScreenshotCallback:
#### 定义
- (void)takeScreenshotCallback:(QNScreenshotResultCallback)resultCallback;
#### 参数
参数名 | 描述
---|---
resultCallback | 截图的结果回调
#### 说明：截图播放画面
#### 注意：成功则回调图片，失败则回调错误。拉到首帧之后才可正常截图。
#### setJitterBufferMinDelay:
#### 定义
- (void)setJitterBufferMinDelay:(double)jitterBufferMinDelay;
#### 参数
参数名 | 描述
---|---
jitterBufferMinDelay | 抖动缓冲区最小延迟
#### 说明：设置抖动缓冲区的最小延迟
#### 注意：默认为 0，不开启抖动延迟，时间单位为秒，范围 [0, 1]，建议不超过 600ms。
#### enableFileLogging
#### 定义
+ (void)enableFileLogging;
#### 说明：开启文件日志，建议在 App 启动时即开启，日志文件位于 App App
Container/Library/Caches/Pili/RTLogs 目录下以 QNRTPlayer+当前时间命名的目录内
> 注意：文件日志功能主要用于排查问题，打开文件日志功能会对性能有一定影响，上线前请记得关闭文件日志功能！
#### versionInfo
#### 定义
+ (NSString *)versionInfo;
#### 说明：获取 SDK 的版本信息。
## QNRTPlayerDelegate
`QNRTPlayerDelegate` 在 QNRTPlayer 运行过程中的状态和事件回调
### 方法
#### RTPlayer:didFailWithError:
#### 定义
- (void)RTPlayer:(QNRTPlayer *)player didFailWithError:(NSError *)error;
#### 参数
参数名 | 描述
---|---
player | QNRTPlayer 实例
error | 错误内容
#### 说明：运行过程中发生错误会通过该方法回调
#### RTPlayer:playStateDidChange:
#### 定义
- (void)RTPlayer:(QNRTPlayer *)player playStateDidChange:(QNRTPlayState)playState;
#### 参数
参数名 | 描述
---|---
player | QNRTPlayer 实例
playState | playState 播放状态
#### 说明：在运行过程中，状态发生变化的回调
#### RTPlayer:didGetStatistic:
#### 定义
- (void)RTPlayer:(QNRTPlayer *)player didGetStatistic:(NSDictionary *)statistic;
#### 参数
参数名 | 描述
---|---
player | QNRTPlayer 实例
statistic | 统计信息 ，包括：音频码率，视频码率，视频帧率
#### 说明：统计信息回调，回调的时间间隔由 statisticInterval 参数决定，statisticInterval 默认为
0，即不回调统计信息。
#### RTPlayer:trackDidReceived
#### 定义
- (void)RTPlayer:(QNRTPlayer *)player trackDidReceived:(QNRTSourceKind )kind;
#### 参数
参数名 | 描述
---|---
player | QNRTPlayer 实例
kind | 数据类型
#### 说明：当前流媒体流收到数据 track。
#### RTCEngine:firstSourceDidDecode:
#### 定义
- (void)RTPlayer:(QNRTPlayer *)player firstSourceDidDecode:(QNRTSourceKind )kind;
#### 参数
参数名 | 描述
---|---
player | QNRTPlayer 实例
kind | 数据类型
#### 说明：音视频首帧解码后的回调。
## QNRTErrorDomain
`QNRTErrorDomain` 定义了播放过程中的错误信息,包括但不限于连接错误、鉴权失败等错误信息。
QNRTCErrorDomain | 错误码 | 功能
---|---|---
QNRTErrorNetworkError | 20001 | 服务请求超时，或者域名解析错误等
QNRTErrorAuthFailed | 20002 | 请求服务鉴权失败
QNRTErrorPlayStreamNotExit | 20003 | 播放流地址不存在
QNRTErrorPlayRequestFailed | 20004 | 对应服务 invalid parameter / server error
QNRTErrorDescriptionError | 20005 | 内部sdp错误
QNRTErrorConnectFailed | 20006 | 连接异常
QNRTErrorOperationNotAllowed | 20007 | 操作不被允许
## QNRTPlayState
`QNRTPlayState ` 定义了播放的状态。
QNRTPlayState | 功能
---|---
QNRTPlayStateUnknow | 未知状态，只会作为 init 前的初始状态，开始播放之后任何情况下都不会再回到此状态
QNRTPlayStateInit | 初始状态
QNRTPlayStateReady | 准备播放的状态
QNRTPlayStatePlaying | 正在播放的状态
QNRTPlayStateStoped | 停止播放的状态
QNRTPlayStateError | 播放发生错误的状态
## QNRTSourceKind
`QNRTSourceKind ` 定义了 source 的类型。
QNRTSourceKind | 功能
---|---
QNRTSourceKindAudio | 音频
QNRTSourceKindVideo | 视频
## QNRTVideoFillModeType
`QNRTVideoFillModeType` 定义了视频填充模式。
QNRTVideoFillModeType | 功能
---|---
QNRTVideoFillModeStretch | 拉伸以填充整个视图
QNRTVideoFillModePreserveAspectRatio | 画面均匀缩放的同时保持宽高比，添加指定背景色的条形
QNRTVideoFillModePreserveAspectRatioAndFill | 保持源图像的长宽比，放大其中心以填充视图
## QNScreenshotResultCallback
`QNScreenshotResultCallback` 定义了截图的回调。
typedef void (^QNScreenshotResultCallback)(UIImage *ShotImage, NSError *error);
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,125 |
推流 SDK 下载体验 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 推流端 >推流 SDK 下载体验
# 推流 SDK 下载体验
最近更新时间: 2024-06-21 10:24:08
> **说明：**
> SDK 名称：推流 SDK
> 开发者：上海七牛信息技术有限公司
> 推流 SDK 合规使用说明请参考[七牛 SDK 合规使用说明
> __](https://developer.qiniu.com/pili/12616/sdk-compliance-
> instructions)；隐私政策说明请参考[七牛 SDK 隐私策略
> __](https://developer.qiniu.com/pili/8027/sdk-privacy-policy)
# SDK下载
Android SDK 下载：[PLDroidMediaStreaming v3.1.6 __](https://github.com/pili-
engineering/PLDroidMediaStreaming/tree/v3.1.6)
iOS SDK 下载：[PLMediaStreamingKit v3.1.0 __](https://github.com/pili-
engineering/PLMediaStreamingKit/tree/v3.1.0)
# Demo 本地下载
Android Demo 下载：<http://fir.qiniuapi.com/plmsaui>[
__](http://fir.qiniuapi.com/plmsaui)
iOS Demo 下载：<https://testflight.apple.com/join/Jz6TvWPP>[
__](https://testflight.apple.com/join/Jz6TvWPP)
# Demo 扫码下载
Android Demo 下载：（若使用微信扫码失败，可使用安卓手机自带浏览器、QQ、支付宝尝试扫码）
iOS Demo 下载：（若使用微信扫码失败，可使用苹果手机自带相机、QQ、支付宝尝试扫码）
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 推流端 >推流 SDK 下载体验
# 推流 SDK 下载体验
最近更新时间: 2024-06-21 10:24:08
> **说明：**
> SDK 名称：推流 SDK
> 开发者：上海七牛信息技术有限公司
> 推流 SDK 合规使用说明请参考[七牛 SDK 合规使用说明
> __](https://developer.qiniu.com/pili/12616/sdk-compliance-
> instructions)；隐私政策说明请参考[七牛 SDK 隐私策略
> __](https://developer.qiniu.com/pili/8027/sdk-privacy-policy)
# SDK下载
Android SDK 下载：[PLDroidMediaStreaming v3.1.6 __](https://github.com/pili-
engineering/PLDroidMediaStreaming/tree/v3.1.6)
iOS SDK 下载：[PLMediaStreamingKit v3.1.0 __](https://github.com/pili-
engineering/PLMediaStreamingKit/tree/v3.1.0)
# Demo 本地下载
Android Demo 下载：<http://fir.qiniuapi.com/plmsaui>[
__](http://fir.qiniuapi.com/plmsaui)
iOS Demo 下载：<https://testflight.apple.com/join/Jz6TvWPP>[
__](https://testflight.apple.com/join/Jz6TvWPP)
# Demo 扫码下载
Android Demo 下载：（若使用微信扫码失败，可使用安卓手机自带浏览器、QQ、支付宝尝试扫码）
iOS Demo 下载：（若使用微信扫码失败，可使用苹果手机自带相机、QQ、支付宝尝试扫码）
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,140 |
概述 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 推流端 >Android 推流端 SDK >概述
# 概述
最近更新时间: 2023-08-31 20:31:17
# 1 概述
PLDroidMediaStreaming 是一个适用于 Android 的 RTMP 直播推流 SDK，可高度定制化和二次开发。特色是同时支持 H.264
软编／硬编和 AAC 软编／硬编。支持 Android Camera 画面捕获，并进行 H.264 编码，以及支持 Android 麦克风音频采样并进行
AAC 编码；还实现了一套可供开发者选择的编码参数集合，以便灵活调节相应的分辨率和码率；同时，SDK 提供数据源回调接口，用户可进行 Filter
处理。借助 PLDroidMediaStreaming ，开发者可以快速构建一款类似 [Meerkat
__](https://meerkatapp.co/)或[Periscope __](https://www.periscope.tv/)的 Android
直播应用。
## 1.1 SDK 下载
[PLDroidMediaStreaming __](https://github.com/pili-
engineering/PLDroidMediaStreaming)
## 1.2 功能以及版本
功能 | 描述 | 版本号
---|---|---
H.264 和 AAC 软编 | | v1.4.1(+)
H.264 和 AAC 硬编 | | v1.0.0(+)
RTMP 封包及推流 | | v1.0.0(+)
录屏 | | v2.1.0(+)
外部数据源支持 | | v2.1.0(+)
后台推流 | | v2.2.0(+)
支持双声道立体声 | | v2.2.0(+)
数据源回调接口，可自定义 Filter (滤镜) 特效处理 | | v1.4.1(+)
前后置摄像头，以及动态切换 | | v1.2.0(+)
自动手动对焦 | | v1.1.0(+)
手动对焦 | | v1.5.0(+)
支持美颜 | | v1.7.0(+)
Zoom 操作 | | v1.5.0(+)
Mute/Unmute | | v1.5.0(+)
闪光灯操作 | | v1.1.0(+)
纯音频推流，以及后台运行 | | v1.1.0(+)
截帧 | | v1.3.0(+)
动态更改 Encoding Orientation | | v1.4.5(+)
动态切换横竖屏 | | v1.4.5(+)
ARMv7a 芯片体系架构 | | v1.0.0(+)
ARM, ARM64v8a, X86 主流芯片体系架构 | | v1.3.3(+)
SEI 信息发送 | | v2.4.1(+)
SRT 传输协议支持 | | v3.1.0(+)
H.265 硬编支持 | | v3.1.5(+)
# 2 特性
* 支持 H.264 和 AAC 软编（推荐）
* 支持 H.264、H.265 和 AAC 硬编
* 支持录屏
* 软编支持 Android Min API 15（Android 4.0.3）及其以上版本
* 硬编支持 Android Min API 18（Android 4.3）及其以上版本
* 支持构造带安全授权凭证的 RTMP 推流地址
* 支持 RTMP 封包及推流
* 支持 RTMP 推流自适应网络质量动态切换码率或自定义策略
* 支持数据源回调接口，可自定义 Filter (滤镜) 特效处理
* 支持前后置摄像头，以及动态切换
* 支持自动对焦
* 支持手动对焦
* 支持动态水印
* 支持美颜，以及调节磨皮、美白、红润效果
* 支持 Encoding Mirror 设置
* 支持 Zoom 操作
* 支持 Mute/Unmute
* 支持闪光灯操作
* 支持纯音频推流，以及后台运行
* 支持截帧功能
* 支持动态更改 Encoding Orientation
* 支持动态切换横竖屏
* 支持蓝牙麦克风
* 支持后台推流
* 支持双声道立体声
* 支持 QUIC 推流
* 支持 ARM, ARMv7a, ARM64v8a, X86 主流芯片体系架构
* 支持 SEI 信息发送
* 支持 SRT 推流
# 3 阅读对象
本文档为技术文档，需要阅读者：
* 具有基本的 Android 开发能力
* 准备接入七牛直播云或已完成七牛直播云接入
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 推流端 >Android 推流端 SDK >概述
# 概述
最近更新时间: 2023-08-31 20:31:17
# 1 概述
PLDroidMediaStreaming 是一个适用于 Android 的 RTMP 直播推流 SDK，可高度定制化和二次开发。特色是同时支持 H.264
软编／硬编和 AAC 软编／硬编。支持 Android Camera 画面捕获，并进行 H.264 编码，以及支持 Android 麦克风音频采样并进行
AAC 编码；还实现了一套可供开发者选择的编码参数集合，以便灵活调节相应的分辨率和码率；同时，SDK 提供数据源回调接口，用户可进行 Filter
处理。借助 PLDroidMediaStreaming ，开发者可以快速构建一款类似 [Meerkat
__](https://meerkatapp.co/)或[Periscope __](https://www.periscope.tv/)的 Android
直播应用。
## 1.1 SDK 下载
[PLDroidMediaStreaming __](https://github.com/pili-
engineering/PLDroidMediaStreaming)
## 1.2 功能以及版本
功能 | 描述 | 版本号
---|---|---
H.264 和 AAC 软编 | | v1.4.1(+)
H.264 和 AAC 硬编 | | v1.0.0(+)
RTMP 封包及推流 | | v1.0.0(+)
录屏 | | v2.1.0(+)
外部数据源支持 | | v2.1.0(+)
后台推流 | | v2.2.0(+)
支持双声道立体声 | | v2.2.0(+)
数据源回调接口，可自定义 Filter (滤镜) 特效处理 | | v1.4.1(+)
前后置摄像头，以及动态切换 | | v1.2.0(+)
自动手动对焦 | | v1.1.0(+)
手动对焦 | | v1.5.0(+)
支持美颜 | | v1.7.0(+)
Zoom 操作 | | v1.5.0(+)
Mute/Unmute | | v1.5.0(+)
闪光灯操作 | | v1.1.0(+)
纯音频推流，以及后台运行 | | v1.1.0(+)
截帧 | | v1.3.0(+)
动态更改 Encoding Orientation | | v1.4.5(+)
动态切换横竖屏 | | v1.4.5(+)
ARMv7a 芯片体系架构 | | v1.0.0(+)
ARM, ARM64v8a, X86 主流芯片体系架构 | | v1.3.3(+)
SEI 信息发送 | | v2.4.1(+)
SRT 传输协议支持 | | v3.1.0(+)
H.265 硬编支持 | | v3.1.5(+)
# 2 特性
* 支持 H.264 和 AAC 软编（推荐）
* 支持 H.264、H.265 和 AAC 硬编
* 支持录屏
* 软编支持 Android Min API 15（Android 4.0.3）及其以上版本
* 硬编支持 Android Min API 18（Android 4.3）及其以上版本
* 支持构造带安全授权凭证的 RTMP 推流地址
* 支持 RTMP 封包及推流
* 支持 RTMP 推流自适应网络质量动态切换码率或自定义策略
* 支持数据源回调接口，可自定义 Filter (滤镜) 特效处理
* 支持前后置摄像头，以及动态切换
* 支持自动对焦
* 支持手动对焦
* 支持动态水印
* 支持美颜，以及调节磨皮、美白、红润效果
* 支持 Encoding Mirror 设置
* 支持 Zoom 操作
* 支持 Mute/Unmute
* 支持闪光灯操作
* 支持纯音频推流，以及后台运行
* 支持截帧功能
* 支持动态更改 Encoding Orientation
* 支持动态切换横竖屏
* 支持蓝牙麦克风
* 支持后台推流
* 支持双声道立体声
* 支持 QUIC 推流
* 支持 ARM, ARMv7a, ARM64v8a, X86 主流芯片体系架构
* 支持 SEI 信息发送
* 支持 SRT 推流
# 3 阅读对象
本文档为技术文档，需要阅读者：
* 具有基本的 Android 开发能力
* 准备接入七牛直播云或已完成七牛直播云接入
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,142 |
开发准备 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 推流端 >Android 推流端 SDK >开发准备
# 开发准备
最近更新时间: 2023-08-31 20:32:01
# 1 设备以及系统
* 设备要求：搭载 Android 系统的设备
* 系统要求：Android 4.3(API 18) 及其以上
# 2 前置条件
* 已注册七牛账号
* 通过[官网 __](https://portal.qiniu.com)申请并已开通直播权限
* SDK v3.0.0 及以后版本需要获取授权才可使用。可通过 400-808-9176 转 2 号线联系七牛商务咨询，或者 [通过工单 __](https://support.qiniu.com/?ref=developer.qiniu.com)联系七牛的技术支持进行授权的申请
# 3 混淆
为了保证正常使用 SDK ，请在 proguard-rules.pro 文件中添加以下代码：
-keep class com.qiniu.pili.droid.streaming.** { *; }
# 4 版本升级须知
## v3.1.5
* 从 v3.1.5 版本开始，将不再支持 armeabi 架构
## v3.1.3
* 从 v3.1.3 版本开始，HappyDNS 库务必升级到 1.0.0 版本
## v3.1.2
* 从 v3.1.2 版本开始，SDK 将不再强制要求获取 READ_PHONE_STATE 和 ACCESS_FINE_LOCATION 的权限
## v3.1.1
* 从 v3.1.1 版本开始，HappyDNS 库务必升级到 0.2.18 版本
## v3.0.2
* 从 v3.0.2 版本开始，请务必添加 `android.arch.lifecycle:extensions:x.y.z` 的依赖
* 从 v3.0.2 版本开始，`StreamingEnv.init(Context context)` 已被弃用，请更新到 `StreamingEnv.init(Context contex, String userId)` 进行环境的初始化，其中，userId 代表用户的唯一标识符，用于区分不同的用户
## v3.0.1
* 从 v3.0.1 版本开始，Happy DNS 库请务必升级到 0.2.17 版本
## v3.0.0
* **从 v3.0.0 版本开始，七牛直播推流 SDK 需要先获取授权才能使用。授权分为试用版和正式版，可通过 400-808-9176 转 2 号线联系七牛商务咨询，或者[通过工单 __](https://support.qiniu.com/?ref=developer.qiniu.com)联系七牛的技术支持。**
* **v3.0.0 之前的版本不受影响，请继续放心使用。**
* **老客户升级 v3.0.0 版本之前，请先联系七牛获取相应授权，以免发生鉴权不通过的现象。**
* 基于 114 dns 解析的不确定性，使用该解析可能会导致解析的网络 ip 无法做到最大的优化策略，进而出现推流质量不佳的现象。因此建议使用非 114 dns 解析
## v2.4.1
* 从 v2.4.1 开始，VideoProfile 对 H264 格式配置的参数由 annexb 改为 avcc，之前设置为 false 的客户，需要将配置改为 true。
例如目前设有如下配置的客户：
StreamingProfile.VideoProfile vProfile =
new StreamingProfile.VideoProfile(20, 1000 * 1024, 60, false);
需将参数调整为：
StreamingProfile.VideoProfile vProfile =
new StreamingProfile.VideoProfile(20, 1000 * 1024, 60, true);
## v2.3.0
* 从 v2.3.0 版本开始，增加 libpldroid_streaming_puic.so 库
* libpldroid_streaming_core.so 依赖于 libpldroid_streaming_puic.so，无论是否启用 QUIC 推流，都需要包含 libpldroid_streaming_puic.so 库
## v2.2.0
* 从 v2.2.0 版本开始，须要在 build.gradle 中删除 QoS 依赖
dependencies {
...
compile 'com.qiniu.pili:pili-android-qos:0.8.+'
...
}
## v2.1.0
* 使用录屏功能前，须要在 AndroidManifest.xml 中注册 SDK 内置的 Activity：
<activity
android:name="com.qiniu.pili.droid.streaming.screen.ScreenCaptureRequestActivity"
android:theme="@android:style/Theme.Translucent.NoTitleBar" >
</activity>
* pili-android-qos 最新版本为 0.8.13
* 更新 `StreamingPreviewCallback#onPreviewFrame`
StreamingPreviewCallback#onPreviewFrame(byte[] data, int width, int height)
调整为
/**
* Called if the {@link StreamingPreviewCallback} registered.
*
* @param data the contents of the preview frame in fmt format
* @param width the width of the frame
* @param height the height of the frame
* @param rotation set the clockwise rotation of frame in degrees to achieve the same effect of preview display.
* @param fmt the format of the frame. See also {@link com.qiniu.pili.droid.streaming.av.common.PLFourCC}
* @param tsInNanoTime the timestamp of the frame
*
* */
boolean StreamingPreviewCallback#onPreviewFrame(byte[] data, int width, int height, int rotation, int fmt, long tsInNanoTime);
## v2.0.1
从 v2.0.1 开始：
* 删掉废弃的 `CameraStreamingManager`，可使用 `MediaStreamingManager`
* 须在宿主项目中的 build.gradle 中加入如下语句：
dependencies {
...
compile 'com.qiniu:happy-dns:0.2.+'
compile 'com.qiniu.pili:pili-android-qos:0.8.+'
...
}
* 废弃的 `StreamingPreviewCallback#onPreviewFrame(byte[] bytes, Camera camera)` 被删掉，可使用 `StreamingPreviewCallback#onPreviewFrame(byte[] bytes, int width, int height)`
* `AudioSourceCallback#onAudioSourceAvailable(ByteBuffer byteBuffer, int size, boolean eof)` 接口回调中增加时间戳信息，更改为 `AudioSourceCallback#onAudioSourceAvailable(ByteBuffer byteBuffer, int size, long tsInNanoTime, boolean eof)`
## v2.0.0 Beta
从 [v2.0.0 Beta __](https://github.com/pili-
engineering/PLDroidMediaStreaming/releases/tag/v2.0.0-beta)开始，SDK 由
PLDroidCameraStreaming 更名为 PLDroidMediaStreaming，将会提供更丰富的功能接口。有如下重大更新：
* 新增 `MediaStreamingManager`，废弃 `CameraStreamingManager` 且不再被维护
* 新增一些辅助类并废弃相关的类
* 新增 `StreamingStateChangedListener`，并废弃 `CameraStreamingManager#StreamingStateListener`
* 新增 `StreamingState`，并废弃 `CameraStreamingManager#STATE`
* 新增 `StreamingSessionListener`，并废弃 `CameraStreamingManager#StreamingSessionListener`
* 新增 `AVCodecType`，并废弃 `CameraStreamingManager#EncodingType`
* 包名更新为 `com.qiniu.pili.droid.streaming.*;`，因此需要更新混淆相关代码
## v1.6.1
从 [v1.6.1 __](https://github.com/pili-
engineering/PLDroidMediaStreaming/releases/tag/v1.6.1)开始，为了便于用户更好地定制化，将
TransformMatrix 信息加入到`SurfaceTextureCallback#onDrawFrame`。因此更新到 v1.6.1
版本之后，若实现了 `SurfaceTextureCallback` 接口，需要将
int onDrawFrame(int texId, int texWidth, int texHeight);
更改为：
int onDrawFrame(int texId, int texWidth, int texHeight, float[] transformMatrix);
## v1.6.0
从 [v1.6.0 __](https://github.com/pili-
engineering/PLDroidMediaStreaming/releases/tag/v1.6.0)开始，在使用 SDK
之前，需要保证`StreamingEnv` 被正确初始化 ，否则在构造核心类 `CameraStreamingManager` 的阶段会抛出异常。具体可参看
[Demo __](https://github.com/pili-
engineering/PLDroidMediaStreaming/blob/master/PLDroidMediaStreamingDemo/app/src/main/java/com/qiniu/pili/droid/streaming/demo/StreamingApplication.java)。
StreamingEnv.init(getApplicationContext());
## v1.4.6
从 v1.4.6 版本开始，需要在宿主项目中的 build.gradle 中加入如下语句：
dependencies {
...
compile 'com.qiniu:happy-dns:0.2.7'
...
}
否则，在运行时会发生找不到 happydns 相关类的错误。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 推流端 >Android 推流端 SDK >开发准备
# 开发准备
最近更新时间: 2023-08-31 20:32:01
# 1 设备以及系统
* 设备要求：搭载 Android 系统的设备
* 系统要求：Android 4.3(API 18) 及其以上
# 2 前置条件
* 已注册七牛账号
* 通过[官网 __](https://portal.qiniu.com)申请并已开通直播权限
* SDK v3.0.0 及以后版本需要获取授权才可使用。可通过 400-808-9176 转 2 号线联系七牛商务咨询，或者 [通过工单 __](https://support.qiniu.com/?ref=developer.qiniu.com)联系七牛的技术支持进行授权的申请
# 3 混淆
为了保证正常使用 SDK ，请在 proguard-rules.pro 文件中添加以下代码：
-keep class com.qiniu.pili.droid.streaming.** { *; }
# 4 版本升级须知
## v3.1.5
* 从 v3.1.5 版本开始，将不再支持 armeabi 架构
## v3.1.3
* 从 v3.1.3 版本开始，HappyDNS 库务必升级到 1.0.0 版本
## v3.1.2
* 从 v3.1.2 版本开始，SDK 将不再强制要求获取 READ_PHONE_STATE 和 ACCESS_FINE_LOCATION 的权限
## v3.1.1
* 从 v3.1.1 版本开始，HappyDNS 库务必升级到 0.2.18 版本
## v3.0.2
* 从 v3.0.2 版本开始，请务必添加 `android.arch.lifecycle:extensions:x.y.z` 的依赖
* 从 v3.0.2 版本开始，`StreamingEnv.init(Context context)` 已被弃用，请更新到 `StreamingEnv.init(Context contex, String userId)` 进行环境的初始化，其中，userId 代表用户的唯一标识符，用于区分不同的用户
## v3.0.1
* 从 v3.0.1 版本开始，Happy DNS 库请务必升级到 0.2.17 版本
## v3.0.0
* **从 v3.0.0 版本开始，七牛直播推流 SDK 需要先获取授权才能使用。授权分为试用版和正式版，可通过 400-808-9176 转 2 号线联系七牛商务咨询，或者[通过工单 __](https://support.qiniu.com/?ref=developer.qiniu.com)联系七牛的技术支持。**
* **v3.0.0 之前的版本不受影响，请继续放心使用。**
* **老客户升级 v3.0.0 版本之前，请先联系七牛获取相应授权，以免发生鉴权不通过的现象。**
* 基于 114 dns 解析的不确定性，使用该解析可能会导致解析的网络 ip 无法做到最大的优化策略，进而出现推流质量不佳的现象。因此建议使用非 114 dns 解析
## v2.4.1
* 从 v2.4.1 开始，VideoProfile 对 H264 格式配置的参数由 annexb 改为 avcc，之前设置为 false 的客户，需要将配置改为 true。
例如目前设有如下配置的客户：
StreamingProfile.VideoProfile vProfile =
new StreamingProfile.VideoProfile(20, 1000 * 1024, 60, false);
需将参数调整为：
StreamingProfile.VideoProfile vProfile =
new StreamingProfile.VideoProfile(20, 1000 * 1024, 60, true);
## v2.3.0
* 从 v2.3.0 版本开始，增加 libpldroid_streaming_puic.so 库
* libpldroid_streaming_core.so 依赖于 libpldroid_streaming_puic.so，无论是否启用 QUIC 推流，都需要包含 libpldroid_streaming_puic.so 库
## v2.2.0
* 从 v2.2.0 版本开始，须要在 build.gradle 中删除 QoS 依赖
dependencies {
...
compile 'com.qiniu.pili:pili-android-qos:0.8.+'
...
}
## v2.1.0
* 使用录屏功能前，须要在 AndroidManifest.xml 中注册 SDK 内置的 Activity：
<activity
android:name="com.qiniu.pili.droid.streaming.screen.ScreenCaptureRequestActivity"
android:theme="@android:style/Theme.Translucent.NoTitleBar" >
</activity>
* pili-android-qos 最新版本为 0.8.13
* 更新 `StreamingPreviewCallback#onPreviewFrame`
StreamingPreviewCallback#onPreviewFrame(byte[] data, int width, int height)
调整为
/**
* Called if the {@link StreamingPreviewCallback} registered.
*
* @param data the contents of the preview frame in fmt format
* @param width the width of the frame
* @param height the height of the frame
* @param rotation set the clockwise rotation of frame in degrees to achieve the same effect of preview display.
* @param fmt the format of the frame. See also {@link com.qiniu.pili.droid.streaming.av.common.PLFourCC}
* @param tsInNanoTime the timestamp of the frame
*
* */
boolean StreamingPreviewCallback#onPreviewFrame(byte[] data, int width, int height, int rotation, int fmt, long tsInNanoTime);
## v2.0.1
从 v2.0.1 开始：
* 删掉废弃的 `CameraStreamingManager`，可使用 `MediaStreamingManager`
* 须在宿主项目中的 build.gradle 中加入如下语句：
dependencies {
...
compile 'com.qiniu:happy-dns:0.2.+'
compile 'com.qiniu.pili:pili-android-qos:0.8.+'
...
}
* 废弃的 `StreamingPreviewCallback#onPreviewFrame(byte[] bytes, Camera camera)` 被删掉，可使用 `StreamingPreviewCallback#onPreviewFrame(byte[] bytes, int width, int height)`
* `AudioSourceCallback#onAudioSourceAvailable(ByteBuffer byteBuffer, int size, boolean eof)` 接口回调中增加时间戳信息，更改为 `AudioSourceCallback#onAudioSourceAvailable(ByteBuffer byteBuffer, int size, long tsInNanoTime, boolean eof)`
## v2.0.0 Beta
从 [v2.0.0 Beta __](https://github.com/pili-
engineering/PLDroidMediaStreaming/releases/tag/v2.0.0-beta)开始，SDK 由
PLDroidCameraStreaming 更名为 PLDroidMediaStreaming，将会提供更丰富的功能接口。有如下重大更新：
* 新增 `MediaStreamingManager`，废弃 `CameraStreamingManager` 且不再被维护
* 新增一些辅助类并废弃相关的类
* 新增 `StreamingStateChangedListener`，并废弃 `CameraStreamingManager#StreamingStateListener`
* 新增 `StreamingState`，并废弃 `CameraStreamingManager#STATE`
* 新增 `StreamingSessionListener`，并废弃 `CameraStreamingManager#StreamingSessionListener`
* 新增 `AVCodecType`，并废弃 `CameraStreamingManager#EncodingType`
* 包名更新为 `com.qiniu.pili.droid.streaming.*;`，因此需要更新混淆相关代码
## v1.6.1
从 [v1.6.1 __](https://github.com/pili-
engineering/PLDroidMediaStreaming/releases/tag/v1.6.1)开始，为了便于用户更好地定制化，将
TransformMatrix 信息加入到`SurfaceTextureCallback#onDrawFrame`。因此更新到 v1.6.1
版本之后，若实现了 `SurfaceTextureCallback` 接口，需要将
int onDrawFrame(int texId, int texWidth, int texHeight);
更改为：
int onDrawFrame(int texId, int texWidth, int texHeight, float[] transformMatrix);
## v1.6.0
从 [v1.6.0 __](https://github.com/pili-
engineering/PLDroidMediaStreaming/releases/tag/v1.6.0)开始，在使用 SDK
之前，需要保证`StreamingEnv` 被正确初始化 ，否则在构造核心类 `CameraStreamingManager` 的阶段会抛出异常。具体可参看
[Demo __](https://github.com/pili-
engineering/PLDroidMediaStreaming/blob/master/PLDroidMediaStreamingDemo/app/src/main/java/com/qiniu/pili/droid/streaming/demo/StreamingApplication.java)。
StreamingEnv.init(getApplicationContext());
## v1.4.6
从 v1.4.6 版本开始，需要在宿主项目中的 build.gradle 中加入如下语句：
dependencies {
...
compile 'com.qiniu:happy-dns:0.2.7'
...
}
否则，在运行时会发生找不到 happydns 相关类的错误。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,147 |
快速开始 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 推流端 >Android 推流端 SDK >快速开始
# 快速开始
最近更新时间: 2022-05-19 20:06:07
# 1 开发环境配置
* 首先需要搭建好您的业务服务端。搭建好带有 [Pili Server sdk __](https://developer.qiniu.com/pili/1220/server-sdk)的业务服务端后，SDK 推流信息的输入来自服务端返回的推流地址
* Android Studio 开发工具。官方[下载地址 __](http://developer.android.com/intl/zh-cn/sdk/index.html)
* 下载 Android 官方开发SDK 。官方[下载地址 __](https://developer.android.com/intl/zh-cn/sdk/index.html#Other)。PLDroidMediaStreaming 要求 Android Min API 18
* 下载 PLDroidMediaStreaming 最新的 JAR 和 SO 文件。[下载地址 __](https://github.com/pili-engineering/PLDroidMediaStreaming/tree/master/releases)
* 请用真机调试代码，模拟器无法调试。
# 2 创建新工程
* 通过 Android Studio 创建 Project，
* 设置新项目
* 填写 Application id
* 填写 Company Domain
* 填写 Package id
* 选择 Project location
* 可以使用默认的填写项
* 选择 Target Android Devices
本例中选择使用 MinimumSDK API 18
* 选择 Empty Activity
* 填写 Main Activity 信息，作为 `android.intent.action.MAIN`
* 完成创建
# 3 导入 SDK
* 将右侧文件夹目录切换为 `Project` 视图
* 在 app/src/main 目录下创建 jniLibs 目录。按图所示，将文件导入对应的目录。
* 选中 libs 目录下找到 pldroid-media-streaming-3.0.2.jar，右键添加新建库，如图所示
* 导入完成，双击 `build.gradle` 文件查看内容，lib 目录中的文件已经自动导入，涉及的文件名如下：
// JAR, 以 v3.0.2 为例，实际开发需替换为相应的版本
pldroid-media-streaming-3.0.2.jar
// SO
libpldroid_streaming_aac_encoder.so
libpldroid_streaming_core.so
libpldroid_streaming_h264_encoder.so
libpldroid_mmprocessing.so
libpldroid_streaming_amix.so
libpldroid_streaming_puic.so
# 4 创建基础推流实例
您可以从[这里下载 __](https://dn-odum9helk.qbox.me/streaming_easy.zip)以下代码
## 4.1 添加相关权限并注册 Activity
* 在 app/src/main 目录中的 AndroidManifest.xml 中增加 `uses-permission` 和 `uses-feature` 声明，并注册推流 Activity : SWCameraStreamingActivity
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
package="com.qiniu.pili.droid.streaming.demo" >
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
<uses-feature android:name="android.hardware.camera.autofocus" />
<uses-feature
android:glEsVersion="0x00020000"
android:required="true" />
<application
android:allowBackup="true"
android:name=".StreamingApplication"
android:icon="@mipmap/ic_launcher"
android:label="@string/app_id"
android:supportsRtl="true"
android:theme="@style/AppTheme" >
<activity android:name=".MainActivity" >
<intent-filter>
<action android:name="android.intent.action.MAIN" />
<category android:name="android.intent.category.LAUNCHER" />
</intent-filter>
</activity>
<activity android:name=".StreamingByCameraActivity" >
</activity>
</application>
</manifest>
## 4.2 添加 happy-dns 依赖
* 检查在 app 目录下的 `build.gradle` ，并且按照如下修改：
* 确认在 app 目录下
* 打开如图所示目录文件
apply plugin: 'com.android.application'
android {
compileSdkVersion 29
buildToolsVersion "29.0.3"
defaultConfig {
applicationId "com.qiniu.pili.droid.streaming.demo"
minSdkVersion 18
targetSdkVersion 29
versionCode 1
versionid "1.0"
}
buildTypes {
release {
minifyEnabled false
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
}
}
}
dependencies {
// 推流 SDK jar 包，为推流 SDK 必须依赖的库
implementation files('libs/pldroid-media-streaming-3.0.2.jar')
// dns 相关 jar 包，必须依赖
implementation 'com.qiniu:happy-dns:0.2.17'
// 监听应用生命周期，必须依赖
implementation 'android.arch.lifecycle:extensions:1.1.1'
implementation 'com.android.support:appcompat-v7:28.0.0'
}
其中，不同版本的 SDK 需依赖的 HappyDns 版本可能不同，详情可参阅[版本升级须知
__](https://developer.qiniu.com/pili/3716/PLDroidMediaStreaming-preparation-
before-development#4)
## 4.3 实现自己的 Application
public class StreamingApplication extends Application {
@Override
public void onCreate() {
super.onCreate();
StreamingEnv.init(getApplicationContext(), Util.getUserId(getApplicationContext()));
}
}
其中，`StreamingEnv.init` 的第二个参数代表用户唯一标识符，用于区分不同的用户
## 4.4 创建主界面
* 查看 app/src/main/java 目录中的 MainActivity.java 文件。为了演示方便，将文件中的 `MainActivity` 父类 `AppCompatActivity` 更改为 `Activity`，即 `public class MainActivity extends AppCompatActivity`，修改为 `public class MainActivity extends Activity`，`MainActivity` 其主要工作包括：
* 通过 start Button 去 app server 异步请求推流地址
* 推流地址获取成功之后，启动 `SWCameraStreamingActivity`
public class MainActivity extends Activity {
private static final String TAG = "MainActivity";
private String requestPublishURL() {
try {
// Replace "Your app server" by your app sever url which can get the publish URL as the SDK's input.
HttpURLConnection httpConn = (HttpURLConnection) new URL("Your app server").openConnection();
httpConn.setRequestMethod("POST");
httpConn.setConnectTimeout(5000);
httpConn.setReadTimeout(10000);
int responseCode = httpConn.getResponseCode();
if (responseCode != HttpURLConnection.HTTP_OK) {
return null;
}
int length = httpConn.getContentLength();
if (length <= 0) {
return null;
}
InputStream is = httpConn.getInputStream();
byte[] data = new byte[length];
int read = is.read(data);
is.close();
if (read <= 0) {
return null;
}
return new String(data, 0, read);
} catch (Exception e) {
showToast("Network error!");
}
return null;
}
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
Button btn = (Button) findViewById(R.id.start);
btn.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
new Thread(new Runnable() {
@Override
public void run() {
try {
// Get the publish URL from http
String publishURL = requestPublishURL();
Intent intent = new Intent(MainActivity.this, StreamingByCameraActivity.class);
intent.putExtra("stream_publish_url", publishURL);
startActivity(intent);
} catch (Exception e) {
e.printStackTrace();
}
}
}).start();
}
});
}
}
## 4.5 创建主界面布局文件
* 查看 app/src/main/res/layout 目录下的 `activity_main.xml`
* 底部 TAB 切换至 Text 面板，粘贴如下代码
<?xml version="1.0" encoding="utf-8"?>
<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:tools="http://schemas.android.com/tools" android:layout_width="match_parent"
android:layout_height="match_parent" android:paddingLeft="@dimen/activity_horizontal_margin"
android:paddingRight="@dimen/activity_horizontal_margin"
android:paddingTop="@dimen/activity_vertical_margin"
android:paddingBottom="@dimen/activity_vertical_margin" tools:context=".MainActivity">
<Button
android:id="@+id/start"
android:text="start"
android:layout_width="wrap_content"
android:layout_height="wrap_content" />
</RelativeLayout>
## 4.6 创建推流界面
* 创建名为 `SWCameraStreamingActivity` 的 Empty Activity，`SWCameraStreamingActivity` 的主要工作包括：
* `SWCameraStreamingActivity` 获取 `MainActivity` 从 app server 获取到的推流地址
* 在 `onCreate` 中初始化推流的配置以及推流 SDK 的核心类 `MediaStreamingManager`
* 在 `onResume` 中调用 `mMediaStreamingManager.resume();`
* 在接收到 `READY` 之后，开始推流 `mMediaStreamingManager.startStreaming();`，`startStreaming` 需要在非 UI 线程中进行操作。
* 在 app/src/main/java 目录下创建 `StreamingByCameraActivity` 文件，代码如下：
public class StreamingByCameraActivity extends Activity
implements StreamingStateChangedListener, StreamStatusCallback, AudioSourceCallback, StreamingSessionListener {
CameraPreviewFrameView mCameraPreviewSurfaceView;
private MediaStreamingManager mMediaStreamingManager;
private StreamingProfile mProfile;
private String TAG = "StreamingByCameraActivity";
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_camera_streaming);
init();
}
private void init() {
//get form you server
String publishURLFromServer = "rtmpp://xxxx/xx/x";
mCameraPreviewSurfaceView = findViewById(R.id.cameraPreview_surfaceView);
try {
//encoding setting
mProfile = new StreamingProfile();
mProfile.setVideoQuality(StreamingProfile.VIDEO_QUALITY_HIGH1)
.setAudioQuality(StreamingProfile.AUDIO_QUALITY_MEDIUM2)
.setEncodingSizeLevel(StreamingProfile.VIDEO_ENCODING_HEIGHT_480)
.setEncoderRCMode(StreamingProfile.EncoderRCModes.QUALITY_PRIORITY)
.setPublishUrl(publishURLFromServer);
//preview setting
CameraStreamingSetting camerasetting = new CameraStreamingSetting();
camerasetting.setCameraId(Camera.CameraInfo.CAMERA_FACING_BACK)
.setContinuousFocusModeEnabled(true)
.setCameraPrvSizeLevel(CameraStreamingSetting.PREVIEW_SIZE_LEVEL.MEDIUM)
.setCameraPrvSizeRatio(CameraStreamingSetting.PREVIEW_SIZE_RATIO.RATIO_16_9);
//streaming engine init and setListener
mMediaStreamingManager = new MediaStreamingManager(this, mCameraPreviewSurfaceView, AVCodecType.SW_VIDEO_WITH_SW_AUDIO_CODEC); // soft codec
mMediaStreamingManager.prepare(camerasetting, mProfile);
mMediaStreamingManager.setStreamingStateListener(this);
mMediaStreamingManager.setStreamingSessionListener(this);
mMediaStreamingManager.setStreamStatusCallback(this);
mMediaStreamingManager.setAudioSourceCallback(this);
} catch (URISyntaxException e) {
e.printStackTrace();
}
}
@Override
public void onStateChanged(StreamingState streamingState, Object extra) {
Log.e(TAG, "streamingState = " + streamingState + "extra = " + extra);
switch (streamingState) {
case PREPARING:
Log.e(TAG, "PREPARING");
break;
case READY:
Log.e(TAG, "READY");
// start streaming when READY
new Thread(new Runnable() {
@Override
public void run() {
if (mMediaStreamingManager != null) {
mMediaStreamingManager.startStreaming();
}
}
}).start();
break;
case CONNECTING:
Log.e(TAG, "连接中");
break;
case STREAMING:
Log.e(TAG, "推流中");
// The av packet had been sent.
break;
case SHUTDOWN:
Log.e(TAG, "直播中断");
// The streaming had been finished.
break;
case IOERROR:
// Network connect error.
Log.e(TAG, "网络连接失败");
break;
case OPEN_CAMERA_FAIL:
Log.e(TAG, "摄像头打开失败");
// Failed to open camera.
break;
case DISCONNECTED:
Log.e(TAG, "已经断开连接");
// The socket is broken while streaming
break;
case TORCH_INFO:
Log.e(TAG, "开启闪光灯");
break;
}
}
@Override
protected void onResume() {
super.onResume();
mMediaStreamingManager.resume();
}
@Override
protected void onPause() {
super.onPause();
// You must invoke pause here.
mMediaStreamingManager.pause();
}
@Override
public void notifyStreamStatusChanged(StreamingProfile.StreamStatus status) {
Log.e(TAG, "StreamStatus = " + status);
}
@Override
public void onAudioSourceAvailable(ByteBuffer srcBuffer, int size, long tsInNanoTime, boolean isEof) {
}
@Override
public boolean onRecordAudioFailedHandled(int code) {
Log.i(TAG, "onRecordAudioFailedHandled");
return false;
}
@Override
public boolean onRestartStreamingHandled(int code) {
Log.i(TAG, "onRestartStreamingHandled");
new Thread(new Runnable() {
@Override
public void run() {
if (mMediaStreamingManager != null) {
mMediaStreamingManager.startStreaming();
}
}
}).start();
return false;
}
@Override
public void onBackPressed() {
super.onBackPressed();
Intent intent = new Intent(this, MainActivity.class);
startActivity(intent);
}
@Override
public Camera.Size onPreviewSizeSelected(List<Camera.Size> list) {
return null;
}
@Override
public int onPreviewFpsSelected(List<int[]> list) {
return -1;
}
## 4.7 创建推流界面布局文件
* 查看 app/src/main/res/layout 中的 `activity_swcamera_streaming.xml`
* 切换至 Text 面板，粘贴如下内容
<?xml version="1.0" encoding="utf-8"?>
<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:tools="http://schemas.android.com/tools"
android:id="@+id/content"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:background="@color/background_floating_material_dark"
tools:context=".SWCameraStreamingActivity" >
<com.qiniu.pili.droid.streaming.demo.ui.CameraPreviewFrameView
android:id="@+id/cameraPreview_surfaceView"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:layout_gravity="center" />
</RelativeLayout>
启动 APP 之后，当点击 start button，就可以开始推流了。
## 4.8 测试播放效果
* 测试方法: 从 app server 获取到推流对应的播放地址，输入到播放器中进行播放。
# 5 从 SDK DEMO 开始使用
## 5.1 下载 SDK DEMO
* 从[这里 __](https://github.com/pili-engineering/PLDroidMediaStreaming/releases)下载 SDK Demo。
## 5.2 导入 Project 到 Android Studio
* 启动 Android Studio 并选择 `Open an existing Android Studio project`。
* 选择 PLDroidCameraStreamingDemo 工程。从目录 `~/workdir/workspace/sdk/PLDroidCameraStreaming-1.4.1/` 中选择 `DroidCameraStreamingDemo` 工程，选择完成后，点击 `Choose` 按钮。
* 恭喜你，导入完成。
## 5.3 已有工程导入 SDK
* SDK [下载地址 __](https://github.com/pili-engineering/PLDroidCameraStreaming)。
* Demo Project 目录结构说明。如下图所示：
* 红色框：是 Demo 依赖 SDK 的 JAR 文件。您也可以在 build.gradle 中自定义其路径：
dependencies {
// 推流 SDK jar 包，为推流 SDK 必须依赖的库
implementation files('libs/pldroid-media-streaming-3.0.2.jar')
// dns 相关 jar 包，必须依赖
implementation 'com.qiniu:happy-dns:0.2.17'
// 监听应用生命周期，必须依赖
implementation 'android.arch.lifecycle:extensions:1.1.1'
implementation 'com.android.support:appcompat-v7:28.0.0'
}
* 绿色框：是 Demo Java 代码部分。
\- AudioStreamingActivity 是纯音频推流的样例代码
\- AVStreamingActivity 是音视频推流的样例代码
\- ImportStreamingActivity 是外部导入推流的样例代码
\- ScreenStreamingActivity 是录屏推流的样例代码
* 橙色框：是 Demo 依赖 SDK 的动态链接库文件。目前 SDK 支持主流的 ARM, ARMv7a, ARM64v8a, X86 芯片体系架构。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 推流端 >Android 推流端 SDK >快速开始
# 快速开始
最近更新时间: 2022-05-19 20:06:07
# 1 开发环境配置
* 首先需要搭建好您的业务服务端。搭建好带有 [Pili Server sdk __](https://developer.qiniu.com/pili/1220/server-sdk)的业务服务端后，SDK 推流信息的输入来自服务端返回的推流地址
* Android Studio 开发工具。官方[下载地址 __](http://developer.android.com/intl/zh-cn/sdk/index.html)
* 下载 Android 官方开发SDK 。官方[下载地址 __](https://developer.android.com/intl/zh-cn/sdk/index.html#Other)。PLDroidMediaStreaming 要求 Android Min API 18
* 下载 PLDroidMediaStreaming 最新的 JAR 和 SO 文件。[下载地址 __](https://github.com/pili-engineering/PLDroidMediaStreaming/tree/master/releases)
* 请用真机调试代码，模拟器无法调试。
# 2 创建新工程
* 通过 Android Studio 创建 Project，
* 设置新项目
* 填写 Application id
* 填写 Company Domain
* 填写 Package id
* 选择 Project location
* 可以使用默认的填写项
* 选择 Target Android Devices
本例中选择使用 MinimumSDK API 18
* 选择 Empty Activity
* 填写 Main Activity 信息，作为 `android.intent.action.MAIN`
* 完成创建
# 3 导入 SDK
* 将右侧文件夹目录切换为 `Project` 视图
* 在 app/src/main 目录下创建 jniLibs 目录。按图所示，将文件导入对应的目录。
* 选中 libs 目录下找到 pldroid-media-streaming-3.0.2.jar，右键添加新建库，如图所示
* 导入完成，双击 `build.gradle` 文件查看内容，lib 目录中的文件已经自动导入，涉及的文件名如下：
// JAR, 以 v3.0.2 为例，实际开发需替换为相应的版本
pldroid-media-streaming-3.0.2.jar
// SO
libpldroid_streaming_aac_encoder.so
libpldroid_streaming_core.so
libpldroid_streaming_h264_encoder.so
libpldroid_mmprocessing.so
libpldroid_streaming_amix.so
libpldroid_streaming_puic.so
# 4 创建基础推流实例
您可以从[这里下载 __](https://dn-odum9helk.qbox.me/streaming_easy.zip)以下代码
## 4.1 添加相关权限并注册 Activity
* 在 app/src/main 目录中的 AndroidManifest.xml 中增加 `uses-permission` 和 `uses-feature` 声明，并注册推流 Activity : SWCameraStreamingActivity
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
package="com.qiniu.pili.droid.streaming.demo" >
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
<uses-feature android:name="android.hardware.camera.autofocus" />
<uses-feature
android:glEsVersion="0x00020000"
android:required="true" />
<application
android:allowBackup="true"
android:name=".StreamingApplication"
android:icon="@mipmap/ic_launcher"
android:label="@string/app_id"
android:supportsRtl="true"
android:theme="@style/AppTheme" >
<activity android:name=".MainActivity" >
<intent-filter>
<action android:name="android.intent.action.MAIN" />
<category android:name="android.intent.category.LAUNCHER" />
</intent-filter>
</activity>
<activity android:name=".StreamingByCameraActivity" >
</activity>
</application>
</manifest>
## 4.2 添加 happy-dns 依赖
* 检查在 app 目录下的 `build.gradle` ，并且按照如下修改：
* 确认在 app 目录下
* 打开如图所示目录文件
apply plugin: 'com.android.application'
android {
compileSdkVersion 29
buildToolsVersion "29.0.3"
defaultConfig {
applicationId "com.qiniu.pili.droid.streaming.demo"
minSdkVersion 18
targetSdkVersion 29
versionCode 1
versionid "1.0"
}
buildTypes {
release {
minifyEnabled false
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
}
}
}
dependencies {
// 推流 SDK jar 包，为推流 SDK 必须依赖的库
implementation files('libs/pldroid-media-streaming-3.0.2.jar')
// dns 相关 jar 包，必须依赖
implementation 'com.qiniu:happy-dns:0.2.17'
// 监听应用生命周期，必须依赖
implementation 'android.arch.lifecycle:extensions:1.1.1'
implementation 'com.android.support:appcompat-v7:28.0.0'
}
其中，不同版本的 SDK 需依赖的 HappyDns 版本可能不同，详情可参阅[版本升级须知
__](https://developer.qiniu.com/pili/3716/PLDroidMediaStreaming-preparation-
before-development#4)
## 4.3 实现自己的 Application
public class StreamingApplication extends Application {
@Override
public void onCreate() {
super.onCreate();
StreamingEnv.init(getApplicationContext(), Util.getUserId(getApplicationContext()));
}
}
其中，`StreamingEnv.init` 的第二个参数代表用户唯一标识符，用于区分不同的用户
## 4.4 创建主界面
* 查看 app/src/main/java 目录中的 MainActivity.java 文件。为了演示方便，将文件中的 `MainActivity` 父类 `AppCompatActivity` 更改为 `Activity`，即 `public class MainActivity extends AppCompatActivity`，修改为 `public class MainActivity extends Activity`，`MainActivity` 其主要工作包括：
* 通过 start Button 去 app server 异步请求推流地址
* 推流地址获取成功之后，启动 `SWCameraStreamingActivity`
public class MainActivity extends Activity {
private static final String TAG = "MainActivity";
private String requestPublishURL() {
try {
// Replace "Your app server" by your app sever url which can get the publish URL as the SDK's input.
HttpURLConnection httpConn = (HttpURLConnection) new URL("Your app server").openConnection();
httpConn.setRequestMethod("POST");
httpConn.setConnectTimeout(5000);
httpConn.setReadTimeout(10000);
int responseCode = httpConn.getResponseCode();
if (responseCode != HttpURLConnection.HTTP_OK) {
return null;
}
int length = httpConn.getContentLength();
if (length <= 0) {
return null;
}
InputStream is = httpConn.getInputStream();
byte[] data = new byte[length];
int read = is.read(data);
is.close();
if (read <= 0) {
return null;
}
return new String(data, 0, read);
} catch (Exception e) {
showToast("Network error!");
}
return null;
}
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
Button btn = (Button) findViewById(R.id.start);
btn.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
new Thread(new Runnable() {
@Override
public void run() {
try {
// Get the publish URL from http
String publishURL = requestPublishURL();
Intent intent = new Intent(MainActivity.this, StreamingByCameraActivity.class);
intent.putExtra("stream_publish_url", publishURL);
startActivity(intent);
} catch (Exception e) {
e.printStackTrace();
}
}
}).start();
}
});
}
}
## 4.5 创建主界面布局文件
* 查看 app/src/main/res/layout 目录下的 `activity_main.xml`
* 底部 TAB 切换至 Text 面板，粘贴如下代码
<?xml version="1.0" encoding="utf-8"?>
<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:tools="http://schemas.android.com/tools" android:layout_width="match_parent"
android:layout_height="match_parent" android:paddingLeft="@dimen/activity_horizontal_margin"
android:paddingRight="@dimen/activity_horizontal_margin"
android:paddingTop="@dimen/activity_vertical_margin"
android:paddingBottom="@dimen/activity_vertical_margin" tools:context=".MainActivity">
<Button
android:id="@+id/start"
android:text="start"
android:layout_width="wrap_content"
android:layout_height="wrap_content" />
</RelativeLayout>
## 4.6 创建推流界面
* 创建名为 `SWCameraStreamingActivity` 的 Empty Activity，`SWCameraStreamingActivity` 的主要工作包括：
* `SWCameraStreamingActivity` 获取 `MainActivity` 从 app server 获取到的推流地址
* 在 `onCreate` 中初始化推流的配置以及推流 SDK 的核心类 `MediaStreamingManager`
* 在 `onResume` 中调用 `mMediaStreamingManager.resume();`
* 在接收到 `READY` 之后，开始推流 `mMediaStreamingManager.startStreaming();`，`startStreaming` 需要在非 UI 线程中进行操作。
* 在 app/src/main/java 目录下创建 `StreamingByCameraActivity` 文件，代码如下：
public class StreamingByCameraActivity extends Activity
implements StreamingStateChangedListener, StreamStatusCallback, AudioSourceCallback, StreamingSessionListener {
CameraPreviewFrameView mCameraPreviewSurfaceView;
private MediaStreamingManager mMediaStreamingManager;
private StreamingProfile mProfile;
private String TAG = "StreamingByCameraActivity";
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_camera_streaming);
init();
}
private void init() {
//get form you server
String publishURLFromServer = "rtmpp://xxxx/xx/x";
mCameraPreviewSurfaceView = findViewById(R.id.cameraPreview_surfaceView);
try {
//encoding setting
mProfile = new StreamingProfile();
mProfile.setVideoQuality(StreamingProfile.VIDEO_QUALITY_HIGH1)
.setAudioQuality(StreamingProfile.AUDIO_QUALITY_MEDIUM2)
.setEncodingSizeLevel(StreamingProfile.VIDEO_ENCODING_HEIGHT_480)
.setEncoderRCMode(StreamingProfile.EncoderRCModes.QUALITY_PRIORITY)
.setPublishUrl(publishURLFromServer);
//preview setting
CameraStreamingSetting camerasetting = new CameraStreamingSetting();
camerasetting.setCameraId(Camera.CameraInfo.CAMERA_FACING_BACK)
.setContinuousFocusModeEnabled(true)
.setCameraPrvSizeLevel(CameraStreamingSetting.PREVIEW_SIZE_LEVEL.MEDIUM)
.setCameraPrvSizeRatio(CameraStreamingSetting.PREVIEW_SIZE_RATIO.RATIO_16_9);
//streaming engine init and setListener
mMediaStreamingManager = new MediaStreamingManager(this, mCameraPreviewSurfaceView, AVCodecType.SW_VIDEO_WITH_SW_AUDIO_CODEC); // soft codec
mMediaStreamingManager.prepare(camerasetting, mProfile);
mMediaStreamingManager.setStreamingStateListener(this);
mMediaStreamingManager.setStreamingSessionListener(this);
mMediaStreamingManager.setStreamStatusCallback(this);
mMediaStreamingManager.setAudioSourceCallback(this);
} catch (URISyntaxException e) {
e.printStackTrace();
}
}
@Override
public void onStateChanged(StreamingState streamingState, Object extra) {
Log.e(TAG, "streamingState = " + streamingState + "extra = " + extra);
switch (streamingState) {
case PREPARING:
Log.e(TAG, "PREPARING");
break;
case READY:
Log.e(TAG, "READY");
// start streaming when READY
new Thread(new Runnable() {
@Override
public void run() {
if (mMediaStreamingManager != null) {
mMediaStreamingManager.startStreaming();
}
}
}).start();
break;
case CONNECTING:
Log.e(TAG, "连接中");
break;
case STREAMING:
Log.e(TAG, "推流中");
// The av packet had been sent.
break;
case SHUTDOWN:
Log.e(TAG, "直播中断");
// The streaming had been finished.
break;
case IOERROR:
// Network connect error.
Log.e(TAG, "网络连接失败");
break;
case OPEN_CAMERA_FAIL:
Log.e(TAG, "摄像头打开失败");
// Failed to open camera.
break;
case DISCONNECTED:
Log.e(TAG, "已经断开连接");
// The socket is broken while streaming
break;
case TORCH_INFO:
Log.e(TAG, "开启闪光灯");
break;
}
}
@Override
protected void onResume() {
super.onResume();
mMediaStreamingManager.resume();
}
@Override
protected void onPause() {
super.onPause();
// You must invoke pause here.
mMediaStreamingManager.pause();
}
@Override
public void notifyStreamStatusChanged(StreamingProfile.StreamStatus status) {
Log.e(TAG, "StreamStatus = " + status);
}
@Override
public void onAudioSourceAvailable(ByteBuffer srcBuffer, int size, long tsInNanoTime, boolean isEof) {
}
@Override
public boolean onRecordAudioFailedHandled(int code) {
Log.i(TAG, "onRecordAudioFailedHandled");
return false;
}
@Override
public boolean onRestartStreamingHandled(int code) {
Log.i(TAG, "onRestartStreamingHandled");
new Thread(new Runnable() {
@Override
public void run() {
if (mMediaStreamingManager != null) {
mMediaStreamingManager.startStreaming();
}
}
}).start();
return false;
}
@Override
public void onBackPressed() {
super.onBackPressed();
Intent intent = new Intent(this, MainActivity.class);
startActivity(intent);
}
@Override
public Camera.Size onPreviewSizeSelected(List<Camera.Size> list) {
return null;
}
@Override
public int onPreviewFpsSelected(List<int[]> list) {
return -1;
}
## 4.7 创建推流界面布局文件
* 查看 app/src/main/res/layout 中的 `activity_swcamera_streaming.xml`
* 切换至 Text 面板，粘贴如下内容
<?xml version="1.0" encoding="utf-8"?>
<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:tools="http://schemas.android.com/tools"
android:id="@+id/content"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:background="@color/background_floating_material_dark"
tools:context=".SWCameraStreamingActivity" >
<com.qiniu.pili.droid.streaming.demo.ui.CameraPreviewFrameView
android:id="@+id/cameraPreview_surfaceView"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:layout_gravity="center" />
</RelativeLayout>
启动 APP 之后，当点击 start button，就可以开始推流了。
## 4.8 测试播放效果
* 测试方法: 从 app server 获取到推流对应的播放地址，输入到播放器中进行播放。
# 5 从 SDK DEMO 开始使用
## 5.1 下载 SDK DEMO
* 从[这里 __](https://github.com/pili-engineering/PLDroidMediaStreaming/releases)下载 SDK Demo。
## 5.2 导入 Project 到 Android Studio
* 启动 Android Studio 并选择 `Open an existing Android Studio project`。
* 选择 PLDroidCameraStreamingDemo 工程。从目录 `~/workdir/workspace/sdk/PLDroidCameraStreaming-1.4.1/` 中选择 `DroidCameraStreamingDemo` 工程，选择完成后，点击 `Choose` 按钮。
* 恭喜你，导入完成。
## 5.3 已有工程导入 SDK
* SDK [下载地址 __](https://github.com/pili-engineering/PLDroidCameraStreaming)。
* Demo Project 目录结构说明。如下图所示：
* 红色框：是 Demo 依赖 SDK 的 JAR 文件。您也可以在 build.gradle 中自定义其路径：
dependencies {
// 推流 SDK jar 包，为推流 SDK 必须依赖的库
implementation files('libs/pldroid-media-streaming-3.0.2.jar')
// dns 相关 jar 包，必须依赖
implementation 'com.qiniu:happy-dns:0.2.17'
// 监听应用生命周期，必须依赖
implementation 'android.arch.lifecycle:extensions:1.1.1'
implementation 'com.android.support:appcompat-v7:28.0.0'
}
* 绿色框：是 Demo Java 代码部分。
\- AudioStreamingActivity 是纯音频推流的样例代码
\- AVStreamingActivity 是音视频推流的样例代码
\- ImportStreamingActivity 是外部导入推流的样例代码
\- ScreenStreamingActivity 是录屏推流的样例代码
* 橙色框：是 Demo 依赖 SDK 的动态链接库文件。目前 SDK 支持主流的 ARM, ARMv7a, ARM64v8a, X86 芯片体系架构。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,155 |
功能使用 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 推流端 >Android 推流端 SDK >功能使用
# 功能使用
最近更新时间: 2023-08-31 20:32:46
# 1 SDK 环境配置
SDK 环境相关的配置，都在 StreamingEnv 类中进行。
## 1.1 初始化 SDK 环境
/**
* 初始化 SDK 环境
* 必须在 Application 中调用此方法进行环境的初始化，否则在创建 MediaStreamingManager 的时候会抛异常
*
* @param context Application 上下文
* @param userId 用户唯一标识符，用于区分不同的用户
*/
public static void init(Context context, String userId)
/**
* 初始化 SDK 环境
* 必须在 Application 中调用此方法进行环境的初始化，否则在创建 MediaStreamingManager 的时候会抛异常
*
* @param context Application 上下文
*/
@Deprecated
public static void init(Context context)
## 1.2 检查当前鉴权状态
/**
* 检查当前鉴权状态
*
* @param callback 鉴权结果回调
*/
public static void checkAuthentication(PLAuthenticationResultCallback callback)
其中，鉴权结果回调定义如下：
/**
* 回调当前的鉴权状态
*
* @param result 鉴权状态。包括：UnCheck(-1)、UnAuthorized(0)、Authorized(1)
*/
void onAuthorizationResult(int result);
## 1.3 日志的本地保存及上报
/**
* 设置 SDK 日志等级
*
* @param level 日志等级。包括：VERBOSE、DEBUG、INFO、WARN、ERROR 以及 ASSERT
*/
public static void setLogLevel(int level)
/**
* 开启本地日志的保存，默认为关闭状态
*/
public static void setLogfileEnabled(boolean enabled);
/**
* 设置日志保存的最大文件个数，默认为 3
*/
public static void setLogFileMaxCount(int maxCount);
/**
* 获取当前的日志存储目录
*
* @return 日志存储目录
*/
public static String getLogFilePath();
/**
* 上报本地日志，上报结果会通过 FileLogHelper.LogReportCallback 返回
*/
public static void reportLogFiles(FileLogHelper.LogReportCallback callback);
**注意：**开启日志的保存之前，需要通过调用 `StreamingEnv.init(Context context, String userId)`
接口进行 SDK 环境的初始化操作。
## 1.4 更新 UserID
/**
* 更新 UserID
*
* @param userId 用户唯一标识符，用于区分不同的用户
*/
public static void updateUid(String uid)
可用于切换账号的场景下，更新 init 时传入的 userID。
# 2 摄像头参数配置
所有摄像头相关的配置，都在 CameraStreamingSetting 类中进行。
## 2.1 前置／后置摄像头配置
前后置摄像头配置：
mCameraStreamingSetting.setCameraId(Camera.CameraInfo.CAMERA_FACING_FRONT); // 前置摄像头
mCameraStreamingSetting.setCameraId(Camera.CameraInfo.CAMERA_FACING_BACK); // 后置摄像头
注：默认 `CAMERA_FACING_BACK`
若设定的摄像头打开失败，将会回调 `StreamingState.OPEN_CAMERA_FAIL` .
## 2.2 Camera 对焦相关
* `setContinuousFocusModeEnabled`
若希望关闭自动对焦功能，可以：
mCameraStreamingSetting.setContinuousFocusModeEnabled(false);
注：默认开启
* 通过 `setFocusMode` 设置对焦模式
您可以设置不同的对焦模式，目前 SDK 支持的对焦模式有:
- CameraStreamingSetting.FOCUS_MODE_CONTINUOUS_PICTURE // 自动对焦（Picture）
- CameraStreamingSetting.FOCUS_MODE_CONTINUOUS_VIDEO // 自动对焦（Video）
- CameraStreamingSetting.FOCUS_MODE_AUTO // 手动对焦
`FOCUS_MODE_CONTINUOUS_PICTURE` 与 `FOCUS_MODE_CONTINUOUS_VIDEO`
最大的区别在于，`FOCUS_MODE_CONTINUOUS_PICTURE` 对焦会比 `FOCUS_MODE_CONTINUOUS_VIDEO`
更加频繁，功耗会更高，建议使用 `FOCUS_MODE_CONTINUOUS_VIDEO`。
可以通过 `CameraStreamingSetting#setFocusMode` 来设置不同的对焦模式：
mCameraStreamingSetting.setFocusMode(CameraStreamingSetting.FOCUS_MODE_CONTINUOUS_PICTURE);
mCameraStreamingSetting.setFocusMode(CameraStreamingSetting.FOCUS_MODE_CONTINUOUS_VIDEO);
mCameraStreamingSetting.setFocusMode(CameraStreamingSetting.FOCUS_MODE_AUTO);
注：默认值为 `CameraStreamingSetting.FOCUS_MODE_CONTINUOUS_VIDEO`
* `setResetTouchFocusDelayInMs`
当对焦模式处理
`CameraStreamingSetting.FOCUS_MODE_AUTO`，并触发了手动对焦之后，若希望隔一段时间恢复到自动对焦模式，就可以调用：
mCameraStreamingSetting.setResetTouchFocusDelayInMs(3000); // 单位毫秒
注：默认值为 3000 ms
## 2.3 Camera 预览 size
为了兼容更多的 Camera ，SDK 采用了相关的措施：
* 使用 `PREVIEW_SIZE_LEVEL` 和 `PREVIEW_SIZE_RATIO` 共同确定一个 Preview Size.
* 用户也可以通过 `StreamingSessionListener#onPreviewSizeSelected` 自定义选择一个合适的 Preview Size，`onPreviewSizeSelected` 的参数 list 是 Camera 系统支持的 preview size 列表（Camera.Parameters#getSupportedPreviewSizes()），SDK 内部会对 list 做从小到大的排序，可以安全地使用 list 中的 preview size。如果 `onPreviewSizeSelected` 返回为 null，代表放弃自定义选择，那么 SDK 会使用前面的策略选择一个合适的 Preview Size，否则使用 `onPreviewSizeSelected` 的返回值。
SDK 目前分别支持的 `PREVIEW_SIZE_LEVEL` 和 `PREVIEW_SIZE_RATIO` 分别是：
// PREVIEW_SIZE_LEVEL
- SMALL
- MEDIUM
- LARGE
// PREVIEW_SIZE_RATIO
- RATIO_4_3
- RATIO_16_9
需要注意的是：在某些机型上，list 可能为 null。
## 2.4 Camera 预览 FPS
* SDK 默认会根据推流帧率自动选择一个合适的采集帧率，最终选择的帧率范围可通过 MediaStreamingManager#getPreviewFpsRange 接口获取。
* 用户也可以通过 `StreamingSessionListener#onPreviewFpsSelected` 自定义选择一个合适的预览 FPS，`onPreviewFpsSelected` 的参数 list 是 Camera 系统支持的预览 FPS 列表（Camera.Parameters#getSupportedPreviewFpsRange()）。如果 `onPreviewFpsSelected` 返回为 -1，代表放弃自定义选择，那么 SDK 会使用前面的策略选择一个合适的预览 FPS，否则使用 `onPreviewFpsSelected` 的返回值。
## 2.5 RecordingHint
可以通过 CameraStreamingSetting 对象设置 Recording hint，以此来提升数据源的帧率。
CameraStreamingSetting setting = new CameraStreamingSetting();
setting.setRecordingHint(false);
需要注意的是，在部分机型开启 Recording Hint 之后，会出现画面卡帧等风险，所以请慎用该 API。如果需要实现高 fps
推流，可以考虑开启并加入白名单机制。
## 2.6 Encoding Mirror
对于有对前置摄像头进行 Mirror 操作的用户来说，只需通过 `CameraStreamingSetting#setFrontCameraMirror`
设置即可。该操作目前仅针对播放端有效。可以避免前置摄像头拍摄字体镜像反转问题。
boolean isMirror = xxx; // false as default
mCameraStreamingSetting.setFrontCameraMirror(isMirror);
## 2.7 内置美颜
内置美颜流程的开启通过 `CameraStreamingSetting#setBuiltInFaceBeautyEnabled(boolean
eanble) ` 进行，注意，若希望自定义美颜，需要 disable 该接口，否则行为未知。
在初始化 CameraStreamingSetting 的时候，可以初始化对应的美颜参数：
// FaceBeautySetting 中的参数依次为：beautyLevel，whiten，redden，即磨皮程度、美白程度以及红润程度，取值范围为[0.0f, 1.0f]
mCameraStreamingSetting.setFaceBeautySetting(new CameraStreamingSetting.FaceBeautySetting(1.0f, 1.0f, 0.8f))
.setVideoFilter(CameraStreamingSetting.VIDEO_FILTER_TYPE.VIDEO_FILTER_BEAUTY)
# 3 麦克风参数配置
所有麦克风相关的配置，都在 `MicrophoneStreamingSetting` 类中进行。
## 3.1 设置采样率
SDK 默认采样率为 44100Hz，若需要更改音频采集的采样率，可通过调用如下接口实现：
mMicrophoneStreamingSetting.setSampleRate(16000);
**注意：设备通常不会支持所有的采样率，44100 Hz 采样率兼容性最好，因此，若无特殊需求，保持 SDK 默认值即可；其他常见采样率：16000
Hz、48000 Hz**
## 3.2 设置声道数
SDK 默认采集为单声道，若需要更改音频采集的声道数，可通过调用如下接口实现：
mMicrophoneStreamingSetting.setChannelConfig(AudioFormat.CHANNEL_IN_STEREO);
**注意：单双声道分别需要传入`AudioFormat.CHANNEL_IN_MONO` 以及
`AudioFormat.CHANNEL_IN_STEREO`**
## 3.3 是否开启蓝牙麦克风支持
若希望增加蓝牙麦克风的支持，需要：
mMicrophoneStreamingSetting.setBluetoothSCOEnabled(true);
注：默认值为 false
## 3.4 开启硬件回声消除
若需要开启设备的硬件回声消除功能，可通过调用如下接口实现：
mMicrophoneStreamingSetting.setAECEnabled(true);
**注意：硬件回声消除可能存在设备兼容性问题，建议开启硬件回声消除的场景下，使用 16kHz，单声道的音频参数进行采集，以获得更好的兼容性**
# 4 推流参数设置
所有推流相关的参数配置，都在 `StreamingProfile` 类中进行。
## 4.1 推流地址配置
从 v2.0.0 开始，在七牛加入推流域名白名单之后，可以使用如下接口直接推流：
mProfile.setPublishUrl("rtmp://xxx.xxx/xxx/xxx");
其中，推流地址的生成方式可参考[服务端文档 __](https://developer.qiniu.com/pili/1220/server-sdk)
## 4.2 VideoQuality
VideoQuality 是对视频质量相关参数的一个抽象，它的值对应的参数表如下：
Level | Fps | Video Bitrate(Kbps)
---|---|---
VIDEO_QUALITY_LOW1 | 12 | 150
VIDEO_QUALITY_LOW2 | 15 | 264
VIDEO_QUALITY_LOW3 | 15 | 350
VIDEO_QUALITY_MEDIUM1 | 30 | 512
VIDEO_QUALITY_MEDIUM2 | 30 | 800
VIDEO_QUALITY_MEDIUM3 | 30 | 1000
VIDEO_QUALITY_HIGH1 | 30 | 1200
VIDEO_QUALITY_HIGH2 | 30 | 1500
VIDEO_QUALITY_HIGH3 | 30 | 2000
你只需要通过 `StreamingProfile#setVideoQuality` 进行设置即可，如：
mStreamingProfile.setVideoQuality(StreamingProfile.VIDEO_QUALITY_MEDIUM1);
其含义为，设置视频的 fps 为 30，码率为 512 kbps
## 4.3 AudioQuality
AudioQuality 是对音频质量相关参数的一个抽象，它的值对应的参数表如下：
Level | Audio Bitrate(Kbps) | Audio Sample Rate(Hz)
---|---|---
AUDIO_QUALITY_LOW1 | 18 | 44100
AUDIO_QUALITY_LOW2 | 24 | 44100
AUDIO_QUALITY_MEDIUM1 | 32 | 44100
AUDIO_QUALITY_MEDIUM2 | 48 | 44100
AUDIO_QUALITY_HIGH1 | 96 | 44100
AUDIO_QUALITY_HIGH2 | 128 | 44100
你只需要通过 `StreamingProfile#setAudioQuality` 进行设置即可，如：
mStreamingProfile.setAudioQuality(StreamingProfile.AUDIO_QUALITY_HIGH1);
其含义为，设置音频的采样率为 44100 HZ，码率为 96 kbps。
## 4.4 AVProfile
当需要自定义 video 的 fps、bitrate、profile 或者 audio 的 sample rate、bitrate，可以通过
AVProfile 设置。
其中 video profile 有以下选项
Level | Comment
---|---
StreamingProfile.H264Profile.HIGH | 更好的质量，但有一些性能的损耗
StreamingProfile.H264Profile.MAIN | 质量与性能较好的平衡
StreamingProfile.H264Profile.BASELINE | 更好的性能，但一般的质量
AVProfile 的使用例子如下
// audio sample rate is 44100, audio bitrate is 48 * 1024 bps
StreamingProfile.AudioProfile aProfile = new StreamingProfile.AudioProfile(44100, 48 * 1024);
// fps is 20, video bitrate is 1000 * 1024 bps, maxKeyFrameInterval is 60, profile is HIGH
StreamingProfile.VideoProfile vProfile = new StreamingProfile.VideoProfile(20, 1000 * 1024, 60, StreamingProfile.H264Profile.HIGH);
StreamingProfile.AVProfile avProfile = new StreamingProfile.AVProfile(vProfile, aProfile);
mStreamingProfile.setAVProfile(avProfile)
注：44100 是 Android 平台唯一保证所以设备支持的采样率，为了避免音频兼容性问题，建议设置为 44100。
`StreamingProfile#setAVProfile` 的优先级高于 Quality，也就是说，当同时调用了 Quality 和 AVProfile
的设置，AVProfile 会覆盖 Quality 的设置值，比如：
StreamingProfile.AudioProfile aProfile = new StreamingProfile.AudioProfile(44100, 48 * 1024);
StreamingProfile.VideoProfile vProfile = new StreamingProfile.VideoProfile(20, 1000 * 1024, 60);
StreamingProfile.AVProfile avProfile = new StreamingProfile.AVProfile(vProfile, aProfile);
mStreamingProfile.setAVProfile(avProfile)
.setVideoQuality(StreamingProfile.VIDEO_QUALITY_MEDIUM1) // |30|512|90|
.setAudioQuality(StreamingProfile.AUDIO_QUALITY_HIGH1); // |96|44100|
最终设定的值应该为：
* 音频：48 * 1024, 44100
* 视频：20, 1000 * 1024, 60
## 4.5 HappyDns 支持
为了防止 Dns 被劫持，SDK 加入了 HappyDns 支持，可以从[这里 __](https://github.com/qiniu/happy-
dns-android)查阅源码。 从 v1.4.6 版本开始，必须在宿主项目中的 build.gradle 中加入如下语句：
dependencies {
...
implementation 'com.qiniu:happy-dns:x.y.z'
...
}
其中，不同版本的 SDK 需依赖的 HappyDns 版本可能不同，详情可参阅[版本升级须知
__](https://developer.qiniu.com/pili/3716/PLDroidMediaStreaming-preparation-
before-development#4)
通过 `StreamingProfile` 设定自定义 `DnsManager`，如下：
public static DnsManager getMyDnsManager() {
IResolver[] resolvers = new IResolver[2];
// 配置自定义 DNS 服务器地址
String[] udpDnsServers = new String[]{"223.5.5.5"};
resolvers[0] = new DnsUdpResolver(udpDnsServers, Record.TYPE_A, DNS_DEFAULT_TIMEOUT);
// 配置 HTTPDNS 地址
String[] httpDnsServers = new String[]{"https://223.6.6.6/dns-query"};
resolvers[1] = new DohResolver(httpDnsServers, Record.TYPE_A, DNS_DEFAULT_TIMEOUT);
return new DnsManager(NetworkInfo.normal, resolvers);
}
StreamingProfile mProfile = new StreamingProfile();
mStreamingProfile.setDnsManager(getMyDnsManager()); // 设置自定义 DnsManager
* 可通过创建 DnsUdpResolver 对象配置自定义的 DNS 服务器地址
* 可通过创建 DohResolver 对象配置支持 Doh(Dns over http) 协议的 url
其中，UDP 的方式解析速度快，但是安全性无法得到保证，HTTPDNS 的方式解析速度慢，但是安全性有保证，您可根据您的使用场景自行选择合适的解析方式。
若不调用 `StreamingProfile#setDnsManager` 方法，SDK 会默认的创建一个 `DnsManager` 来对 Dns
进行解析，默认优先使用 UDP 的解析方式。
## 4.6 码率控制模式
可通过设置 EncoderRCModes 指定推流的码率控制模式，目前 RC mode 支持的类型：
* EncoderRCModes.QUALITY_PRIORITY: 质量优先，实际的码率可能高于设置的码率
* EncoderRCModes.BITRATE_PRIORITY: 码率优先，更精确地码率控制
可通过 StreamingProfile 的 setEncoderRCMode 方法进行设置，如下：
mStreamingProfile.setEncoderRCMode(StreamingProfile.EncoderRCModes.QUALITY_PRIORITY);
注：默认值为 `EncoderRCModes.QUALITY_PRIORITY`
## 4.7 Encoding size 的设定
SDK 将 Preview size 和 Encoding size 已经分离，他们之间互不影响。Preview size 代表的是 Camera
本地预览的 size，encoding size 代表的是编码时候的 size，即播放端不做处理时候看到视频的 size。
有两种方式可以设置 Encoding size：
* 使用内置的 encoding size level：`StreamingProfile#setEncodingSizeLevel`
* 设定一个 encoding size 偏好值：`StreamingProfile#setPreferredVideoEncodingSize(int, int)`
SDK 会秉持一个原则，用户偏好值的优先级会高于内置的设置。若同时调用了上述 api，偏好设置会覆盖内置的 encoding size level。
内置的 Encoding size level 对应的分辨率：
Level | Resolution(16:9) | Resolution(4:3)
---|---|---
VIDEO_ENCODING_HEIGHT_240 | 424 x 240 | 320 x 240
VIDEO_ENCODING_HEIGHT_480 | 848 x 480 | 640 x 480
VIDEO_ENCODING_HEIGHT_544 | 960 x 544 | 720 x 544
VIDEO_ENCODING_HEIGHT_720 | 1280 x 720 | 960 x 720
VIDEO_ENCODING_HEIGHT_1088 | 1920 x 1088 | 1440 x 1088
## 4.8 StreamStatus 反馈配置
对于推流信息的反馈，可以通过 `StreamingProfile#setStreamStatusConfig` 来设定其反馈的频率：
mStreamingProfile#setStreamStatusConfig(new StreamingProfile.StreamStatusConfig(3)); // 单位为秒
其含义为，若注册了 `mMediaStreamingManager.setStreamStatusCallback` ，每隔 3 秒回调
StreamStatus 信息。
## 4.9 动态更改 Orientation
动态更改 Orientation，包括动态更改 Encoding Orientation 以及动态切换横竖屏。
* 动态更改 Encoding Orientation
更改的是编码后图像的方向，但需要重新推流才会生效；目前支持的 ENCODING_ORIENTATION 的类型有：PORT 和 LAND
用户不设置的情况下， Encoding Orientation 会依赖 Activity 的 Orientation，即有如下对应关系：
// 不调用 `setEncodingOrientation` 情况下，SDK 会默认根据如下关系进行设置 Encoding Orientation
Activity Orientation | -> | Encoding Orientation
---|---|---
ActivityInfo.SCREEN_ORIENTATION_PORTRAIT | -> | PORT
ActivityInfo.SCREEN_ORIENTATION_LANDSCAPE | -> | LAND
设置 `ENCODING_ORIENTATION.PORT` 之后，播放端会观看竖屏的画面；
设置 `ENCODING_ORIENTATION.LAND` 之后，播放端会观看横屏的画面。
其设置方式如下：
mProfile.setEncodingOrientation(StreamingProfile.ENCODING_ORIENTATION.PORT);
mMediaStreamingManager.setStreamingProfile(mProfile); // notify MediaStreamingManager that StreamingProfile had been changed.
* 动态切换横竖屏
用户切换 Activity 方向后，相应地调整 Camera 的预览显示效果。
在更改了 Activity Orientation 之后，需要调用 `notifyActivityOrientationChanged` 通知
`MediaStreamingManager`。
比如：
setRequestedOrientation(isEncOrientationPort ? ActivityInfo.SCREEN_ORIENTATION_PORTRAIT : ActivityInfo.SCREEN_ORIENTATION_LANDSCAPE);
mMediaStreamingManager.notifyActivityOrientationChanged();
需要注意的是，为了防止 `setRequestedOrientation` 调用后 Activity 的重建，需要在 AndroidManifest.xml
里面配置对应的 Activity 的如下属性：
android:configChanges="orientation|screenSize"
可查看 Demo 中的 `.SWCodecCameraStreamingActivity` 的[配置
__](https://github.com/pili-
engineering/PLDroidMediaStreaming/blob/master/PLDroidMediaStreamingDemo/app/src/main/AndroidManifest.xml)。
## 4.10 自适应码率
由于无线网络相对于有线网络，可靠性较低，会经常遇到信号覆盖不佳导致的高丢包、高延时等问题，特别是在用网高峰期，由于带宽有限，网络拥塞的情况时有发生。自
[v2.1.0 __](https://github.com/pili-
engineering/PLDroidMediaStreaming/releases/tag/v2.1.0-beta)起，PLDroidMediaStreaming
提供了对应的优化方案。可以通过如下 API 开启自适应码率(注意：SDK 默认是关闭自适应码率的)：
/**
* adaptive bitrate adjust mode
*/
public enum BitrateAdjustMode {
Auto, // SDK 自适应码率调节
Manual, // 用户自己实现码率调节, 范围：10kbps~10Mbps
Disable // 关闭码率调节
}
mProfile.setBitrateAdjustMode(StreamingProfile.BitrateAdjustMode.Auto);
开启自适应码率后，当 SDK 检测到网络状况差时，会尝试降低码率，直到 StreamingProfile.VIDEO_QUALITY_LOW1 (150
Kbps)；反之，会提升码率，直到用户设定的 Target Bitrate（通过 StreamingProfile#setVideoQuality 或
StreamingProfile#VideoProfile 设定的码率值）
另外，可以通过下面接口控制自适应码率调节的范围:
/**
* Sets the range value of video adaptive bitrate.
*
* @param minBitrate min bitrate, unit: bps
* @param maxBitrate max bitrate, unit: bps
* */
public StreamingProfile setVideoAdaptiveBitrateRange(int minBitrate, int maxBitrate)
此时，码率调节策略为：
* 用户网络没有触发自动码率调节，码率一直保持在 Target Bitrate（通过 StreamingProfile#setVideoQuality 或 StreamingProfile#VideoProfile 设定的码率值）附近
* 触发自动码率调节后：
* 向下：
* 逐级调整，直到自适应码率调节范围的下限(minBitrate)
* 向上：
* 如果调节范围的上限 (maxBitrate) 大于 Target Bitrate，最高会调整到 Target Bitrate
* 如果调节范围的上限 (maxBitrate) 小于 Target Bitrate，最高会调整到调节范围的上限(maxBitrate)
## 4.11 FilterMode 参数设置
* 当图像采集尺寸与推流尺寸不一致时，SDK 会对采集图像进行 resize 操作，通过 FilterMode 参数，可以对 resize 算法进行设置。
* 相关接口如下：
/**
* filter mode for libyuv
*/
public enum YuvFilterMode {
None, // Point sample; Fastest.
Linear, // Filter horizontally only.
Bilinear, // Faster than box, but lower quality scaling down.
Box // Highest quality.
}
/**
* Sets the YUV filter mode
* @param mode the {@link YuvFilterMode}, default: {@link YuvFilterMode#None}
* @return this
*/
public StreamingProfile setYuvFilterMode(YuvFilterMode mode)
* 该参数只对软编和硬编 YUV 有效
## 4.12 SRT 协议支持
从 v3.1.0 版本开始，新增对 SRT 传输协议的支持，开启方式如下：
/**
* 开启/关闭 SRT 协议传输
*
* @param enabled 开启/关闭 (true / false)
* @return this
*/
public StreamingProfile setSrtEnabled(boolean enabled)
开启后，使用符合官方标准的 SRT 推流地址即可实现 SRT 协议的音视频传输，SRT 推流地址标准可参考 [access-control
__](https://github.com/Haivision/srt/blob/master/docs/features/access-
control.md#general-syntax)，示例如下：
srt://pili-publish.qnsdk.com?streamid=#!::h=sdk-live/xxx,m=publish
## 4.13 视频编码格式设置
从 v3.1.5 版本开始，新增视频编码格式的设置，支持设置 H.264 或 H.265 编码格式，默认使用 H.264 编码格式。
设置方式如下：
/**
* 视频编码格式
*/
public enum PLVideoEncodeType {
H264, // H.264 编码格式
HEVC // H.265 编码格式
}
/**
* 设置视频编码格式
*
* @param videoEncodeType 视频编码格式
* @return this
*/
public StreamingProfile setVideoEncodeType(PLVideoEncodeType videoEncodeType)
基于 Android 设备的兼容性问题，视频编码格式可能由于设备不支持该编码而出现创建编码器失败的情况，最终的编码格式将会通过
**StreamingStateChangedListener** 回调接口返回。处理回调的示例代码如下：
private StreamingStateChangedListener mStreamingStateChangedListener = new StreamingStateChangedListener() {
@Override
public void onStateChanged(StreamingState streamingState, final Object extra) {
case VIDEO_ENCODER_READY:
// 编码器初始化完成，编码类型为 ((PLVideoEncodeType) extra).name())
break;
});
}
};
**注意：**HEVC(H.265) 视频编码格式仅在视频硬编且传输协议为 RTMP 和 QUIC 时生效。软编和 SRT 协议下，将会自动切换到
H.264 视频编码格式
# 5 水印设置
所有水印相关的配置，都在 `WatermarkSetting` 类中进行。
## 5.1 水印位置信息
水印的位置信息，目前内置四个方位，如：
public enum WATERMARK_LOCATION {
NORTH_WEST,
NORTH_EAST,
SOUTH_WEST,
SOUTH_EAST,
}
分别在屏幕的位置如下图所示：
/**
* define the relative location of watermark on the screen when start streaming
*
* | NorthWest | | NorthEast
* | | |
* | | |
* | --------------|----------------|--------------
* | | |
* | | |
* | | |
* | --------------|----------------|--------------
* | | |
* | | |
* | SouthWest | | SouthEast
*
*/
**自定义水印的位置信息**
除了通过 WATERMARK_LOCATION 的四个固定的内置位置，还可以自定义水印的位置信息：
/**
* Set the custom position of watermark top-left point (percentage of surfaceview).
* top-left of the surfaceview is the origin of the coordinate system.
* positive x-axis pointing right and the positive y-axis pointing down.
* normal values of both x and y MUST be [0.0f-1.0f]
*
* meanwhile unset the location
* @param x
* @param y
*/
public WatermarkSetting setCustomPosition(float x, float y);
使用方式如下：
// 以 Preview 的中心点为起点进行水印的绘制
watermarksetting.setCustomPosition(0.5f, 0.5f);
## 5.2 水印显示大小
/**
* define de relative size of watermark
*/
public enum WATERMARK_SIZE {
LARGE,
MEDIUM,
SMALL,
}
2.4.0 版本后提供了设置自定义水印像素大小的功能，使用方式如下：
watermarksetting.setCustomSize(int width, int height);
## 5.3 构造 `WatermarkSetting`
传入 drawable 对象作为水印资源：
WatermarkSetting watermarksetting = new WatermarkSetting(mContext, R.drawable.qiniu_logo, WatermarkSetting.WATERMARK_LOCATION.SOUTH_WEST, WatermarkSetting.WATERMARK_SIZE.MEDIUM, 100); // 100 为 alpha 值
传入图片的绝对路径作为水印资源：
WatermarkSetting watermarksetting = WatermarkSetting(mContext, "watermark resource absolute path", WatermarkSetting.WATERMARK_LOCATION.SOUTH_WEST, WatermarkSetting.WATERMARK_SIZE.MEDIUM, 100) {
# 6 核心类 MediaStreamingManager
所有音视频推流相关的具体操作，都在 MediaStreamingManager 中进行。
## 6.1 构造 MediaStreamingManager
在构造 MediaStreamingManager 阶段会确定其编码的类型，目前 SDK 支持的编码类型有：
- AVCodecType.HW_VIDEO_WITH_HW_AUDIO_CODEC, // 视频硬编，音频硬编
- AVCodecType.SW_VIDEO_WITH_HW_AUDIO_CODEC, // 视频软编，音频硬编
- AVCodecType.SW_VIDEO_WITH_SW_AUDIO_CODEC, // 视频软编，音频软编
- AVCodecType.SW_AUDIO_CODEC, // 纯音频软编
- AVCodecType.HW_AUDIO_CODEC, // 纯音频硬编
- AVCodecType.SW_VIDEO_CODEC, // 纯视频软编
- AVCodecType.HW_VIDEO_CODEC; // 纯视频硬编
构造带有视频 MediaStreamingManager，需要传入 GLSurfaceView
mMediaStreamingManager = new MediaStreamingManager(mContext, mGLSurfaceView, EncodingType.SW_VIDEO_WITH_SW_AUDIO_CODEC);
构造完毕后，需调用 `MediaStreamingManager#prepare` 向 SDK 提供对应的配置信息，以 v1.6.2 版本为例：
mMediaStreamingManager.prepare(mCameraStreamingSetting, mMicrophoneStreamingSetting, mWatermarkSetting, mProfile);
## 6.2 设置 Listener
为了更好的和 SDK 交互，接受各种状态和其他信息，需要注册对应的 Listener:
mMediaStreamingManager.setStreamingStateListener(this);
mMediaStreamingManager.setStreamingSessionListener(this);
mMediaStreamingManager.setStreamStatusCallback(this);
* StreamingStateChangedListener
接口原型如下：
/**
* Callback interface for Streaming State.
* <p>
*
* Called on an "arbitrary thread".
*
* */
public interface StreamingStateChangedListener {
/**
* Invoked if the {@link StreamingState} changed
*
* @param status the specified {@link StreamingState}
* @param extra the extra information
* */
void onStateChanged(StreamingState status, Object extra);
}
onStateChanged 中 status 对应的含义分别为：
public enum StreamingState {
/**
* The initial state.
*
* */
UNKNOWN,
/**
* Preparing the environment for network connection.
* <p>
* The first state after calling {@link StreamingManager#startStreaming()}
*
* */
PREPARING,
/**
* <ol>
* <li>{@link StreamingManager#resume()} done in pure audio streaming</li>
* <li>{@link StreamingManager#resume()} done and camera be activated in AV streaming.</li>
* </ol>
* */
READY,
/**
* Being connecting.
*
* */
CONNECTING,
/**
* The av datas start sending successfully.
*
* */
STREAMING,
/**
* Streaming has been finished, and you can {@link StreamingManager#startStreaming()} again.
*
* */
SHUTDOWN,
/**
* Connect error.
*
* The following is the possible case:
*
* <ol>
* <li>Stream is invalid</li>
* <li>Network is unreachable</li>
* </ol>
*
* */
IOERROR,
/**
* Notify the camera switched.
* <p>
* extra will including the info the new camera id.
*
* <ol>
* <li>Camera.CameraInfo.CAMERA_FACING_FRONT</li>
* <li>Camera.CameraInfo.CAMERA_FACING_BACK</li>
* </ol>
*
* <pre>
* <code>
* Log.i(TAG, "current camera id:" + (Integer)extra);
* </code>
* </pre>
* */
CAMERA_SWITCHED,
/**
* Notify the torch info after camera be active.
* <p>
* extra will including the info if the device support the Torch.
*
* <ol>
* <li>true, supported</li>
* <li>false, unsupported</li>
* </ol>
*
* <pre>
* <code>
* final boolean isSupportedTorch = (Boolean) extra;
* </code>
* </pre>
*
* */
TORCH_INFO,
/**
* Sending buffer is empty.
*
* */
SENDING_BUFFER_EMPTY,
/**
* Sending buffer have been full.
*
* */
SENDING_BUFFER_FULL,
/**
* Sending buffer have few items witch waiting to be sent.
*
* */
SENDING_BUFFER_HAS_FEW_ITEMS,
/**
* Sending buffer have many items witch waiting to be sent.
*
* */
SENDING_BUFFER_HAS_MANY_ITEMS,
/**
* The network connection has been broken.
*
* */
DISCONNECTED,
/**
* if the device hasn't the supported preview size, then it will select the default preview
* size which mismatch the specified {@link CameraStreamingSetting.PREVIEW_SIZE_RATIO}.
*
* */
NO_SUPPORTED_PREVIEW_SIZE,
/**
* {@link AudioRecord#startRecording()} failed.
*
* */
AUDIO_RECORDING_FAIL,
/**
* camera open failed.
*
* */
OPEN_CAMERA_FAIL,
/**
* Do not support NV21 preview format.
*
* */
NO_NV21_PREVIEW_FORMAT,
/**
* start video encoder success
*/
VIDEO_ENCODER_READY,
/**
* start video encoder failed
*/
START_VIDEO_ENCODER_FAIL,
/**
* video encoder error happened
*/
VIDEO_ENCODER_ERROR,
/**
* start audio encoder failed
*/
START_AUDIO_ENCODER_FAIL,
/**
* video encoder error happened
*/
AUDIO_ENCODER_ERROR,
/**
* Invalid streaming url.
*
* Gets the message after call {@link StreamingManager#setStreamingProfile(StreamingProfile)} if streaming
* url is invalid. Also gets the url as the extra info.
* */
INVALID_STREAMING_URL,
/**
* The network had been built successfully.
*
* */
CONNECTED,
/**
* Invalid streaming url.
*
* Gets the message after call {@link MediaStreamingManager#setStreamingProfile(StreamingProfile)} if streaming
* url is invalid. Also gets the url as the extra info.
* */
UNAUTHORIZED_STREAMING_URL,
}
**注意：** 如果出现了编码器错误相关的回调状态，如 `START_VIDEO_ENCODER_FAIL` `VIDEO_ENCODER_ERROR`
`START_AUDIO_ENCODER_FAIL` `AUDIO_ENCODER_ERROR` 等，用户可以在接收到状态回调后，更新相应的
AVCodecType 类型，再重新开始推流
* StreamingSessionListener
接口原型如下：
/**
* Callback interface for some particular Streaming incidents.
* <p>
*
* Called on an "arbitrary thread".
*
* */
public interface StreamingSessionListener {
/**
* Invoked when audio recording failed.
* <p>
*
* @param code error code. <b>Unspecified now</b>.
*
* @return true means you handled the event; otherwise, given up.
*
* */
boolean onRecordAudioFailedHandled(int code);
/**
* Restart streaming notification.
* <p>
*
* When the network-connection is broken, {@link StreamingState#DISCONNECTED} will notified first,
* and then invoked this method if the environment of restart streaming is ready.
*
* <p>
* SDK won't limit the number of invocation.
*
* @param code error code. <b>Unspecified now</b>.
*
* @return true means you handled the event; otherwise, given up and then {@link StreamingState#SHUTDOWN}
* will be notified.
*
* */
boolean onRestartStreamingHandled(int code);
/**
* Invoked after camera object constructed.
* <p>
* The supported list exists in following cases:
* <ol>
* <li>If didn't set the
* {@link CameraStreamingSetting#setCameraPrvSizeRatio} when
* initialize {@link CameraStreamingSetting},
* the whole supported list would be passed</li>
* <li>If {@link CameraStreamingSetting#setCameraPrvSizeRatio}
* was set, the supported preview size which filtered by the specified ratio would be passed</li>
* </ol>
*
* @param list supported camera preview list which sorted from smallest to largest. The list maybe null.
*
* @return null means you give up selection and SDK will help you select a proper preview
* size; otherwise, the returned size will be effective.
*
* */
Camera.Size onPreviewSizeSelected(List<Camera.Size> list);
/**
* Custom preview fps, invoked after camera object constructed.
*
* @param supportedPreviewFpsRange
* a list of supported preview fps ranges by Camera. This method returns a
* list with at least one element. Every element is an int array
* of two values - minimum fps and maximum fps.
* @return -1 means you give up selection and SDK will help you select a proper preview
* fps; otherwise, the returned index will be effective.
*/
int onPreviewFpsSelected(final List<int[]> supportedPreviewFpsRange);
}
可以在 StreamingSessionListener 处理一些重连、音频读取失败、preview size 的自定义操作。
@Override
public boolean onRecordAudioFailedHandled(int err) {
mMediaStreamingManager.updateEncodingType(AVCodecType.SW_VIDEO_CODEC);
mMediaStreamingManager.startStreaming();
return true;
}
@Override
public boolean onRestartStreamingHandled(int err) {
return mMediaStreamingManager.startStreaming();
}
@Override
public Camera.Size onPreviewSizeSelected(List<Camera.Size> list) {
if (list != null) {
for (Camera.Size s : list) {
Log.i(TAG, "w:" + s.width + ", h:" + s.height);
}
// return "your choice";
}
return null;
}
在消费了 onRecordAudioFailedHandled 或 onRestartStreamingHandled 之后，您应该返回 true 通知
SDK；若不做任何处理，返回 false。
* StreamStatusCallback
接口原型如下：
/**
* Callback interface used to notify {@link StreamingProfile.StreamStatus}.
*/
public interface StreamStatusCallback {
/**
* Called per the {@link StreamingProfile.StreamStatusConfig#getIntervalMs}
*
* @param status the new {@link StreamingProfile.StreamStatus}
*
* */
void notifyStreamStatusChanged(final StreamingProfile.StreamStatus status);
}
注意：notifyStreamStatusChanged 运行在非 UI 线程中。
StreamStatus 的定义如下：
/**
* The nested class is for feedbacking the av status in real time.
*
* <p>
* You can set the {@link StreamStatusConfig} to get the preferred callback frequency.
*
* */
public static class StreamStatus {
/**
* Audio frame per second.
* */
public int audioFps;
/**
* Video frame per second.
* */
public int videoFps;
/**
* Audio and video total bits per second.
* */
public int totalAVBitrate; // bps
/**
* Audio bits per second.
* */
public int audioBitrate; // bps
/**
* Video bits per second.
* */
public int videoBitrate; // bps
/**
* Number of dropped video frames in callback period.
* */
public int droppedVideoFrames;
}
## 6.3 resume
`MediaStreamingManager#resume` 会进行 Camera 的打开操作，当成功打开后，会返回 STATE.READY
消息，用户可以在接受到 STATE.READY 之后，安全地进行推流操作。
mMediaStreamingManager.resume();
若在一个 Activity 中进行推流操作，建议 `mMediaStreamingManager.resume()` 在
`Activity#onResume` 中被调用。
## 6.4 开始推流
由于 startStreaming 会进行网络链接相关操作，因此需要将 startStreaming 运行在非 UI 线程，否则可能会发生崩溃现象。
mMediaStreamingManager.startStreaming();
## 6.5 手动对焦
对焦之前传入 Focus Indicator , 如果不进行设置，对焦过程中将会没有对应的 UI 显示。
// You should call this after getting {@link STATE#READY}.
mMediaStreamingManager.setFocusAreaIndicator(mRotateLayout,
mRotateLayout.findViewById(R.id.focus_indicator));
点击屏幕触发手动对焦，并设置对应的坐标值。
// You should call this after getting {@link STATE#READY}.
mMediaStreamingManager.doSingleTapUp((int) e.getX(), (int) e.getY());
## 6.6 Zoom
Camera Zoom 操作。
// mCurrentZoom must be in the range of [0, mMediaStreamingManager.getMaxZoom()]
// You should call this after getting {@link STATE#READY}.
if (mMediaStreamingManager.isZoomSupported()) {
mMediaStreamingManager.setZoomValue(mCurrentZoom);
}
可以获取到当前的 Zoom 值：
mMediaStreamingManager.getZoom();
## 6.7 闪光灯操作
开启闪光灯。
mMediaStreamingManager.turnLightOn();
关闭闪光灯。
mMediaStreamingManager.turnLightOff();
## 6.8 切换摄像头
切换摄像头。
mMediaStreamingManager.switchCamera();
## 6.9 获取采集帧率范围
获取 Camera 设置的采集帧率范围。
mMediaStreamingManager.getPreviewFpsRange();
注意：
* 该接口返回的是实际帧率乘以 1000 的帧率范围，如 [10000, 30000]，代表帧率范围为 10fps～30fps
* 该接口需要在收到 OnStateChanged.READY 状态后调用，否则将会返回 null
## 6.10 禁音推流
在推流过程中，将声音禁用掉：
mMediaStreamingManager.mute(true);
恢复声音：
mMediaStreamingManager.mute(false);
注：默认为 false
## 6.11 截帧
在 Camera 正常预览之后，可以正常进行截帧功能。
在调用 captureFrame 的时候，您需要传入 width 和 height，以及 FrameCapturedCallback，如果传入的 width
或者 height 小于等于 0，SDK 返回的 Bitmap 将会是预览的尺寸 。SDK 完成截帧之后，会回调
onFrameCaptured，并将结果以参数的形式返回给调用者。
mMediaStreamingManager.captureFrame(w, h, new FrameCapturedCallback() {
@Override
public void onFrameCaptured(Bitmap bmp) {
}
}
注意：调用者有义务对 Bitmap 进行回收释放。截帧失败，bmp 会为 null。
## 6.12 停止推流
停止当前推流。
mMediaStreamingManager.stopStreaming();
## 6.13 Log 管理
当 enabled 设置为 true ，SDK Native 层的 log 将会被打开；当设置为 false，SDK Native 层的 log
将会被关闭。默认处于打开状态。
mMediaStreamingManager.setNativeLoggingEnabled(false);
注：默认值为 true。建议 Release 版本置为 false。
## 6.14 pause
退出 MediaStreamingManager，该操作会主动断开当前的流链接，并关闭 Camera 和释放相应的资源。
mMediaStreamingManager.pause();
## 6.15 destroy
释放不紧要资源。
mMediaStreamingManager.destroy();
## 6.16 自定义音频数据处理
用户可以通过下面回调接口，获取当前音频数据，实现自定义音频数据处理。
// 注册音频采集数据回调
mMediaStreamingManager.setAudioSourceCallback(AudioSourceCallback callback)；
public interface AudioSourceCallback {
/**
* 回调音频采集 PCM 数据
*
* @param srcBuffer 音频 PCM数据，该 buffer 是 direct ByteBuffer。
* @param size buffer的大小
* @param tsInNanoTime 时间戳，单位：纳秒
* @param isEof 采集结束标志
*/
void onAudioSourceAvailable(ByteBuffer srcBuffer, int size, long tsInNanoTime, boolean isEof);
}
## 6.17 动态水印
通过调用 `MediaStreamingManager.updateWatermarkSetting` 方法可以动态改变水印的内容、位置、大小。
WatermarkSetting watermarkSetting = new WatermarkSetting(context);
watermarkSetting.setResourceId(R.drawable.qiniu_logo);
watermarkSetting.setAlpha(50);
watermarkSetting.setSize(WatermarkSetting.WATERMARK_SIZE.LARGE);
watermarkSetting.setLocation(WatermarkSetting.WATERMARK_LOCATION.SOUTH_EAST);
mMediaStreamingManager.updateWatermarkSetting(newWatermarkSetting);
## 6.18 发送 SEI 信息
可以通过调用如下接口进行 SEI 信息的发送：
/**
* 发送 SEI 信息
*
* @param msg SEI 信息内容
* @param repeatCount SEI 信息需要发送的次数
*/
public void sendSEIMessage(String msg, int repeatCount);
/**
* 发送 SEI 信息
*
* @param msg SEI 信息内容
* @param repeatCount SEI 信息需要发送的次数
* @param timestampNs SEI 信息需要展示的时间
*/
public void sendSEIMessage(String msg, int repeatCount, long timestampNs)
播放端解析 SEI 的过程中，对 payloadSize 的判断需要检测收到的 SEI 信息中 `0xFF` 的个数，每增加一个 `0xFF` 代表
payloadSize 增加 255 个字节。实际组成格式如下：
* 1 byte for SEI NAL Header
* 1 byte for SEI payload type
* (n + 1) bytes for SEI payload size
* 16 bytes for SEI NALU uuid
* (n * 255 + xy) bytes for SEI NALU payload content
* 1 byte for SEI NALU rbsp railing bits
## 6.19 动态改变预览镜像
若希望在推流过程中动态改变摄像头预览的镜像效果，可以使用如下 API：
mMediaStreamingManager.setPreviewMirror(boolean mirror)
## 6.20 动态改变推流镜像
若希望在推流过程中动态改变推流的镜像效果，可以使用如下 API：
mMediaStreamingManager.setEncodingMirror(boolean mirror)
## 6.21 推流时增加背景音乐
若希望在推流过程中增加背景音乐，可以使用如下 API：
mAudioMixer = mMediaStreamingManager.getAudioMixer();
mAudioMixer.setOnAudioMixListener(new OnAudioMixListener() {
@Override
public void onStatusChanged(MixStatus mixStatus) {
mMixToggleBtn.post(new Runnable() {
@Override
public void run() {
...
}
});
}
@Override
public void onProgress(long progress, long duration) {
// time in Us
}
});
mAudioFile = Cache.getAudioFile(this); // 背景音乐文件路径
if (mAudioFile != null) {
try {
mAudioMixer.setFile(mAudioFile, true); // true/false 是否循环
} catch (IOException e) {
e.printStackTrace();
}
}
boolean s = mAudioMixer.play();
text = s ? "mixing play success" : "mixing play failed !!!";
## 6.22 返听／耳返功能
若希望在推流过程中开启返听（耳返），可以使用如下 API：
mMediaStreamingManager.startPlayback();
mMediaStreamingManager.stopPlayback();
## 6.23 QUIC 推流
QUIC 是基于 UDP 开发的可靠传输协议，在弱网下拥有更好的推流效果，相比于 TCP 拥有更低的延迟，可抵抗更高的丢包率。
* 通过下面接口开启/关闭 QUIC 推流
mProfile.setQuicEnable(quicEnable);
## 6.24 SRT 推流
SRT 协议是基于 UDT 的传输协议，抗丢包能力强，适用于复杂的网络。相比于 TCP 可抵抗更高的丢包率。
* 通过下面接口开启/关闭 SRT 推流
mProfile.setSrtEnabled(enabled);
## 6.25 图片推流
若希望在推流过程中推送图片，可以通过如下方式实现：
### 设置推流的图片
设置推流图片有两种方式：
* 推流前预设图片
推流前可以通过 StreamingPofile 的方式进行图片的预设，支持本地图片或者 resource 图片，示例代码如下：
mProfile.setPictureStreamingFilePath(mPicStreamingFilePath);
或
mProfile.setPictureStreamingResourceId(R.drawable.pause_publish);
* 推流过程中动态改变图片
推流过程中可以通过 MediaStreamingManager 的接口进行图片的更换，支持本地图片或者 resource 图片，示例代码如下：
mMediaStreamingManager.setPictureStreamingFilePath(mPicStreamingFilePath);
或
mMediaStreamingManager.setPictureStreamingResourceId(R.drawable.qiniu_logo);
**注意：图片当前仅支持 32 位 png**
### 设置图片帧率
可以在开始推流之前，通过如下调用 StreamingProfile 的如下接口进行图片帧率的设置：
/**
* 设置图片推流的帧率
*
* @param fps 帧率，仅支持 0-30 的配置
*/
public void setPictureStreamingFps(float fps)
示例代码如下：
mProfile.setPictureStreamingFps(10);
### 切换图片推流
可以通过如下接口进行图片推流的切换：
/**
* 切换图片推流。如果当前正在推图片，则停止图片推流，开启音视频推流；反之，则停止音视频推流，开启图片推流
*/
public boolean togglePictureStreaming()
示例代码如下：
boolean isOK = mMediaStreamingManager.togglePictureStreaming();
# 7 自定义滤镜
## 7.1 软编模式滤镜实现
需要分别处理预览显示的 filter 效果和 encoding 的 filter 效果：预览显示通过实现 SurfaceTextureCallback
interface；encoding 通过实现 `StreamingPreviewCallback` interface。两者分别实现，互不影响。
* encoding 部分
public interface StreamingPreviewCallback {
public boolean onPreviewFrame(byte[] bytes, int width, int height, int rotation, int fmt, long tsInNanoTime);
}
onPreviewFrame 会回调 NV21 格式的 YUV 数据，进行 filter 算法处理后的结果仍然保存在 bytes 数组中，SDK 会将
bytes 中的数据当作数据源进行后续的编码和封包等操作；onPreviewFrame 运行在名称为 CameraManagerHt
的子线程中；onPreviewFrame 仅在 STATE.STREAMING 状态下被回调。
* 预览显示部分
public interface SurfaceTextureCallback {
void onSurfaceCreated();
void onSurfaceChanged(int width, int height);
void onSurfaceDestroyed();
int onDrawFrame(int texId, int width, int height);
}
四个回调均执行在 GL rendering thread；如果 onDrawFrame 直接返回 texId，代表放弃 filter 处理，否则
onDrawFrame 应该返回一个 filter 算法处理过的纹理 id； 自定义的 Texture id，即 onDrawFrame 返回的纹理 id，
必须是 GLES20.GL_TEXTURE_2D 类型；SDK 回调的纹理 id，即 onDrawFrame 的参数 texId 类型为
GLES11Ext.GL_TEXTURE_EXTERNAL_OES。
## 7.2 硬编模式滤镜实现
硬编模式下仅需要实现 SurfaceTextureCallback interface 就可实现预览显示和 streaming。
# 8 录屏
PLDroidMediaStreaming 封装好了录屏相关的底层操作，用户可以非常方便的进行录屏推流。其步骤如下：
## 8.1 AndroidManifest.xml 修改
注册 SDK 中携带的 ScreenCaptureRequestActivity
<activity
android:name="com.qiniu.pili.droid.streaming.screen.ScreenCaptureRequestActivity"
android:theme="@android:style/Theme.Translucent.NoTitleBar" >
</activity>
**注意：** 如果你的项目 targetVersion 大于等于 29 ，那么你还需要额外注册一个 ScreenRecordService
<service
android:name="com.qiniu.pili.droid.streaming.screen.ScreenRecordService"
android:enabled="true"
android:foregroundServiceType="mediaProjection" />
## 8.2 构造核心类 `ScreenStreamingManager`
`ScreenStreamingManager` 封装了屏幕的录制、音频的采集，编码，封包和推流操作。用户只需要简单的调用相关 API 即可实现录屏推流：
// 构造 ScreenStreamingManager
ScreenStreamingManager screenStreamingManager = new ScreenStreamingManager();
// 配置相关参数
screenStreamingManager.prepare(context, screenSetting, null, streamingProfile);
// 开始推流
screenStreamingManager.startStreaming();
// 停止推流
screenStreamingManager.stopStreaming();
// 销毁
screenStreamingManager.destroy();
**注意：**如果项目 targetVersion >= 29 ，则 startStreaming() 应该运行在子线程，在开始录屏之后 SDK
内部会创建一个默认的 Notification ，如果您需要使用自定义 Notification，那么请在开始推流之前调用如下代码：
screenStreamingManager.setNotification(customNotificationId, customNotification);
如果后续想要更新此 Notification ，那么可以在更改自定义 notification 对象后调用如下代码即可：
screenStreamingManager.notifyNotification()
## 8.3 自定义音频数据处理
用户可以通过下面回调接口，获取当前音频数据，实现自定义音频数据处理。
// 注册音频采集数据回调
screenStreamingManager.setAudioSourceCallback(AudioSourceCallback callback)；
public interface AudioSourceCallback {
/**
* 回调音频采集 PCM 数据
*
* @param srcBuffer 音频 PCM数据，该 buffer 是 direct ByteBuffer。
* @param size buffer的大小
* @param tsInNanoTime 时间戳，单位：纳秒
* @param isEof 采集结束标志
*/
void onAudioSourceAvailable(ByteBuffer srcBuffer, int size, long tsInNanoTime, boolean isEof);
}
# 9 StreamingManager
`StreamingManager` 是类似 MediaStreamingManager 的一个类，两者的区别是：StreamingManager
不带采集，仅包含编码、封包推流模块，从功能层面可以理解为：
MediaStreamingManager = 采集模块 + (处理模块) + StreamingManager
其调用过程类似于 MediaStreamingManager：
构造 StreamingManager -> prepare -> resume -> startStreaming -> inputAudioFrame/inputVideoFrame -> stopStreaming -> pause -> destroy
具体可以参考 Demo 中的 [ImportStreamingActivity.java __](https://github.com/pili-
engineering/PLDroidMediaStreaming/blob/master/PLDroidMediaStreamingDemo/app/src/main/java/com/qiniu/pili/droid/streaming/demo/activity/ImportStreamingActivity.java)
PS：若希望使用自己已有项目中的采集／处理模块，可以选用 StreamingManager.
## 9.1 外部输入音频
void inputAudioFrame(ByteBuffer buffer, int size, long tsInNanoTime, boolean isEof);
void inputAudioFrame(byte[] buffer, long tsInNanoTime, boolean isEof);
可以选择传入 ByteBuffer 或者 byte[] 类型的 PCM 源数据，传入的时间戳为 nano time。
## 9.2 外部输入视频
void inputVideoFrame(ByteBuffer buffer, int size, int width, int height, int rotation, boolean mirror, int fmt, long tsInNanoTime);
void inputVideoFrame(byte[] buffer, int width, int height, int rotation, boolean mirror, int fmt, long tsInNanoTime);
可以选择传入 ByteBuffer 或者 byte[] 类型的 YUV 数据，其中：
* width 和 height，分别为该 frame 的宽和高，单位像素
* rotation ，指该 frame 需要选择的角度（0，90，180，360），若自己已经处理好角度的旋转，rotation 参数为 0
* mirror，指是否对该 frame 做镜像处理
* fmt，指该 frame 的格式，目前支持 NV21 和 I420，即：PLFourCC.FOURCC_NV21 和 PLFourCC.FOURCC_I420
* tsInNanoTime，指该 frame 对应的时间戳，单位为纳秒
## 9.3 开始推流
通过调用如下接口开始推流：
mStreamingManager.startStreaming();
## 9.4 停止推流
通过调用如下接口停止推流：
mStreamingManager.stopStreaming();
## 9.5 getInputSurface
`getInputSurface` 须在 `startStreaming` 被调用成功之后，从 `MediaCodec` 获取其 `Surface` 类型的
InputSurface，用户可以在这个 `Surface` 上面进行自定义绘制，绘制好后使用 `frameAvailable` 通知 SDK 进行编码。
若希望使用该高级功能，需在 `AVCodecType.HW_VIDEO_SURFACE_AS_INPUT_WITH_HW_AUDIO_CODEC`
模式下，否则会抛出异常。
## 9.6 发送 SEI 信息
通过调用如下接口进行 SEI 信息的发送：
/**
* 发送 SEI 信息
*
* @param msg 信息内容
* @param repeatCount 信息重复次数
*/
public void sendSEIMessage(String msg, int repeatCount)
/**
* 发送带有时间戳的 SEI 信息
*
* @param msg 信息内容
* @param repeatCount 信息重复次数
* @param timestampNs 信息显示时间
*/
public void sendSEIMessage(String msg, int repeatCount, long timestampNs)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 推流端 >Android 推流端 SDK >功能使用
# 功能使用
最近更新时间: 2023-08-31 20:32:46
# 1 SDK 环境配置
SDK 环境相关的配置，都在 StreamingEnv 类中进行。
## 1.1 初始化 SDK 环境
/**
* 初始化 SDK 环境
* 必须在 Application 中调用此方法进行环境的初始化，否则在创建 MediaStreamingManager 的时候会抛异常
*
* @param context Application 上下文
* @param userId 用户唯一标识符，用于区分不同的用户
*/
public static void init(Context context, String userId)
/**
* 初始化 SDK 环境
* 必须在 Application 中调用此方法进行环境的初始化，否则在创建 MediaStreamingManager 的时候会抛异常
*
* @param context Application 上下文
*/
@Deprecated
public static void init(Context context)
## 1.2 检查当前鉴权状态
/**
* 检查当前鉴权状态
*
* @param callback 鉴权结果回调
*/
public static void checkAuthentication(PLAuthenticationResultCallback callback)
其中，鉴权结果回调定义如下：
/**
* 回调当前的鉴权状态
*
* @param result 鉴权状态。包括：UnCheck(-1)、UnAuthorized(0)、Authorized(1)
*/
void onAuthorizationResult(int result);
## 1.3 日志的本地保存及上报
/**
* 设置 SDK 日志等级
*
* @param level 日志等级。包括：VERBOSE、DEBUG、INFO、WARN、ERROR 以及 ASSERT
*/
public static void setLogLevel(int level)
/**
* 开启本地日志的保存，默认为关闭状态
*/
public static void setLogfileEnabled(boolean enabled);
/**
* 设置日志保存的最大文件个数，默认为 3
*/
public static void setLogFileMaxCount(int maxCount);
/**
* 获取当前的日志存储目录
*
* @return 日志存储目录
*/
public static String getLogFilePath();
/**
* 上报本地日志，上报结果会通过 FileLogHelper.LogReportCallback 返回
*/
public static void reportLogFiles(FileLogHelper.LogReportCallback callback);
**注意：**开启日志的保存之前，需要通过调用 `StreamingEnv.init(Context context, String userId)`
接口进行 SDK 环境的初始化操作。
## 1.4 更新 UserID
/**
* 更新 UserID
*
* @param userId 用户唯一标识符，用于区分不同的用户
*/
public static void updateUid(String uid)
可用于切换账号的场景下，更新 init 时传入的 userID。
# 2 摄像头参数配置
所有摄像头相关的配置，都在 CameraStreamingSetting 类中进行。
## 2.1 前置／后置摄像头配置
前后置摄像头配置：
mCameraStreamingSetting.setCameraId(Camera.CameraInfo.CAMERA_FACING_FRONT); // 前置摄像头
mCameraStreamingSetting.setCameraId(Camera.CameraInfo.CAMERA_FACING_BACK); // 后置摄像头
注：默认 `CAMERA_FACING_BACK`
若设定的摄像头打开失败，将会回调 `StreamingState.OPEN_CAMERA_FAIL` .
## 2.2 Camera 对焦相关
* `setContinuousFocusModeEnabled`
若希望关闭自动对焦功能，可以：
mCameraStreamingSetting.setContinuousFocusModeEnabled(false);
注：默认开启
* 通过 `setFocusMode` 设置对焦模式
您可以设置不同的对焦模式，目前 SDK 支持的对焦模式有:
- CameraStreamingSetting.FOCUS_MODE_CONTINUOUS_PICTURE // 自动对焦（Picture）
- CameraStreamingSetting.FOCUS_MODE_CONTINUOUS_VIDEO // 自动对焦（Video）
- CameraStreamingSetting.FOCUS_MODE_AUTO // 手动对焦
`FOCUS_MODE_CONTINUOUS_PICTURE` 与 `FOCUS_MODE_CONTINUOUS_VIDEO`
最大的区别在于，`FOCUS_MODE_CONTINUOUS_PICTURE` 对焦会比 `FOCUS_MODE_CONTINUOUS_VIDEO`
更加频繁，功耗会更高，建议使用 `FOCUS_MODE_CONTINUOUS_VIDEO`。
可以通过 `CameraStreamingSetting#setFocusMode` 来设置不同的对焦模式：
mCameraStreamingSetting.setFocusMode(CameraStreamingSetting.FOCUS_MODE_CONTINUOUS_PICTURE);
mCameraStreamingSetting.setFocusMode(CameraStreamingSetting.FOCUS_MODE_CONTINUOUS_VIDEO);
mCameraStreamingSetting.setFocusMode(CameraStreamingSetting.FOCUS_MODE_AUTO);
注：默认值为 `CameraStreamingSetting.FOCUS_MODE_CONTINUOUS_VIDEO`
* `setResetTouchFocusDelayInMs`
当对焦模式处理
`CameraStreamingSetting.FOCUS_MODE_AUTO`，并触发了手动对焦之后，若希望隔一段时间恢复到自动对焦模式，就可以调用：
mCameraStreamingSetting.setResetTouchFocusDelayInMs(3000); // 单位毫秒
注：默认值为 3000 ms
## 2.3 Camera 预览 size
为了兼容更多的 Camera ，SDK 采用了相关的措施：
* 使用 `PREVIEW_SIZE_LEVEL` 和 `PREVIEW_SIZE_RATIO` 共同确定一个 Preview Size.
* 用户也可以通过 `StreamingSessionListener#onPreviewSizeSelected` 自定义选择一个合适的 Preview Size，`onPreviewSizeSelected` 的参数 list 是 Camera 系统支持的 preview size 列表（Camera.Parameters#getSupportedPreviewSizes()），SDK 内部会对 list 做从小到大的排序，可以安全地使用 list 中的 preview size。如果 `onPreviewSizeSelected` 返回为 null，代表放弃自定义选择，那么 SDK 会使用前面的策略选择一个合适的 Preview Size，否则使用 `onPreviewSizeSelected` 的返回值。
SDK 目前分别支持的 `PREVIEW_SIZE_LEVEL` 和 `PREVIEW_SIZE_RATIO` 分别是：
// PREVIEW_SIZE_LEVEL
- SMALL
- MEDIUM
- LARGE
// PREVIEW_SIZE_RATIO
- RATIO_4_3
- RATIO_16_9
需要注意的是：在某些机型上，list 可能为 null。
## 2.4 Camera 预览 FPS
* SDK 默认会根据推流帧率自动选择一个合适的采集帧率，最终选择的帧率范围可通过 MediaStreamingManager#getPreviewFpsRange 接口获取。
* 用户也可以通过 `StreamingSessionListener#onPreviewFpsSelected` 自定义选择一个合适的预览 FPS，`onPreviewFpsSelected` 的参数 list 是 Camera 系统支持的预览 FPS 列表（Camera.Parameters#getSupportedPreviewFpsRange()）。如果 `onPreviewFpsSelected` 返回为 -1，代表放弃自定义选择，那么 SDK 会使用前面的策略选择一个合适的预览 FPS，否则使用 `onPreviewFpsSelected` 的返回值。
## 2.5 RecordingHint
可以通过 CameraStreamingSetting 对象设置 Recording hint，以此来提升数据源的帧率。
CameraStreamingSetting setting = new CameraStreamingSetting();
setting.setRecordingHint(false);
需要注意的是，在部分机型开启 Recording Hint 之后，会出现画面卡帧等风险，所以请慎用该 API。如果需要实现高 fps
推流，可以考虑开启并加入白名单机制。
## 2.6 Encoding Mirror
对于有对前置摄像头进行 Mirror 操作的用户来说，只需通过 `CameraStreamingSetting#setFrontCameraMirror`
设置即可。该操作目前仅针对播放端有效。可以避免前置摄像头拍摄字体镜像反转问题。
boolean isMirror = xxx; // false as default
mCameraStreamingSetting.setFrontCameraMirror(isMirror);
## 2.7 内置美颜
内置美颜流程的开启通过 `CameraStreamingSetting#setBuiltInFaceBeautyEnabled(boolean
eanble) ` 进行，注意，若希望自定义美颜，需要 disable 该接口，否则行为未知。
在初始化 CameraStreamingSetting 的时候，可以初始化对应的美颜参数：
// FaceBeautySetting 中的参数依次为：beautyLevel，whiten，redden，即磨皮程度、美白程度以及红润程度，取值范围为[0.0f, 1.0f]
mCameraStreamingSetting.setFaceBeautySetting(new CameraStreamingSetting.FaceBeautySetting(1.0f, 1.0f, 0.8f))
.setVideoFilter(CameraStreamingSetting.VIDEO_FILTER_TYPE.VIDEO_FILTER_BEAUTY)
# 3 麦克风参数配置
所有麦克风相关的配置，都在 `MicrophoneStreamingSetting` 类中进行。
## 3.1 设置采样率
SDK 默认采样率为 44100Hz，若需要更改音频采集的采样率，可通过调用如下接口实现：
mMicrophoneStreamingSetting.setSampleRate(16000);
**注意：设备通常不会支持所有的采样率，44100 Hz 采样率兼容性最好，因此，若无特殊需求，保持 SDK 默认值即可；其他常见采样率：16000
Hz、48000 Hz**
## 3.2 设置声道数
SDK 默认采集为单声道，若需要更改音频采集的声道数，可通过调用如下接口实现：
mMicrophoneStreamingSetting.setChannelConfig(AudioFormat.CHANNEL_IN_STEREO);
**注意：单双声道分别需要传入`AudioFormat.CHANNEL_IN_MONO` 以及
`AudioFormat.CHANNEL_IN_STEREO`**
## 3.3 是否开启蓝牙麦克风支持
若希望增加蓝牙麦克风的支持，需要：
mMicrophoneStreamingSetting.setBluetoothSCOEnabled(true);
注：默认值为 false
## 3.4 开启硬件回声消除
若需要开启设备的硬件回声消除功能，可通过调用如下接口实现：
mMicrophoneStreamingSetting.setAECEnabled(true);
**注意：硬件回声消除可能存在设备兼容性问题，建议开启硬件回声消除的场景下，使用 16kHz，单声道的音频参数进行采集，以获得更好的兼容性**
# 4 推流参数设置
所有推流相关的参数配置，都在 `StreamingProfile` 类中进行。
## 4.1 推流地址配置
从 v2.0.0 开始，在七牛加入推流域名白名单之后，可以使用如下接口直接推流：
mProfile.setPublishUrl("rtmp://xxx.xxx/xxx/xxx");
其中，推流地址的生成方式可参考[服务端文档 __](https://developer.qiniu.com/pili/1220/server-sdk)
## 4.2 VideoQuality
VideoQuality 是对视频质量相关参数的一个抽象，它的值对应的参数表如下：
Level | Fps | Video Bitrate(Kbps)
---|---|---
VIDEO_QUALITY_LOW1 | 12 | 150
VIDEO_QUALITY_LOW2 | 15 | 264
VIDEO_QUALITY_LOW3 | 15 | 350
VIDEO_QUALITY_MEDIUM1 | 30 | 512
VIDEO_QUALITY_MEDIUM2 | 30 | 800
VIDEO_QUALITY_MEDIUM3 | 30 | 1000
VIDEO_QUALITY_HIGH1 | 30 | 1200
VIDEO_QUALITY_HIGH2 | 30 | 1500
VIDEO_QUALITY_HIGH3 | 30 | 2000
你只需要通过 `StreamingProfile#setVideoQuality` 进行设置即可，如：
mStreamingProfile.setVideoQuality(StreamingProfile.VIDEO_QUALITY_MEDIUM1);
其含义为，设置视频的 fps 为 30，码率为 512 kbps
## 4.3 AudioQuality
AudioQuality 是对音频质量相关参数的一个抽象，它的值对应的参数表如下：
Level | Audio Bitrate(Kbps) | Audio Sample Rate(Hz)
---|---|---
AUDIO_QUALITY_LOW1 | 18 | 44100
AUDIO_QUALITY_LOW2 | 24 | 44100
AUDIO_QUALITY_MEDIUM1 | 32 | 44100
AUDIO_QUALITY_MEDIUM2 | 48 | 44100
AUDIO_QUALITY_HIGH1 | 96 | 44100
AUDIO_QUALITY_HIGH2 | 128 | 44100
你只需要通过 `StreamingProfile#setAudioQuality` 进行设置即可，如：
mStreamingProfile.setAudioQuality(StreamingProfile.AUDIO_QUALITY_HIGH1);
其含义为，设置音频的采样率为 44100 HZ，码率为 96 kbps。
## 4.4 AVProfile
当需要自定义 video 的 fps、bitrate、profile 或者 audio 的 sample rate、bitrate，可以通过
AVProfile 设置。
其中 video profile 有以下选项
Level | Comment
---|---
StreamingProfile.H264Profile.HIGH | 更好的质量，但有一些性能的损耗
StreamingProfile.H264Profile.MAIN | 质量与性能较好的平衡
StreamingProfile.H264Profile.BASELINE | 更好的性能，但一般的质量
AVProfile 的使用例子如下
// audio sample rate is 44100, audio bitrate is 48 * 1024 bps
StreamingProfile.AudioProfile aProfile = new StreamingProfile.AudioProfile(44100, 48 * 1024);
// fps is 20, video bitrate is 1000 * 1024 bps, maxKeyFrameInterval is 60, profile is HIGH
StreamingProfile.VideoProfile vProfile = new StreamingProfile.VideoProfile(20, 1000 * 1024, 60, StreamingProfile.H264Profile.HIGH);
StreamingProfile.AVProfile avProfile = new StreamingProfile.AVProfile(vProfile, aProfile);
mStreamingProfile.setAVProfile(avProfile)
注：44100 是 Android 平台唯一保证所以设备支持的采样率，为了避免音频兼容性问题，建议设置为 44100。
`StreamingProfile#setAVProfile` 的优先级高于 Quality，也就是说，当同时调用了 Quality 和 AVProfile
的设置，AVProfile 会覆盖 Quality 的设置值，比如：
StreamingProfile.AudioProfile aProfile = new StreamingProfile.AudioProfile(44100, 48 * 1024);
StreamingProfile.VideoProfile vProfile = new StreamingProfile.VideoProfile(20, 1000 * 1024, 60);
StreamingProfile.AVProfile avProfile = new StreamingProfile.AVProfile(vProfile, aProfile);
mStreamingProfile.setAVProfile(avProfile)
.setVideoQuality(StreamingProfile.VIDEO_QUALITY_MEDIUM1) // |30|512|90|
.setAudioQuality(StreamingProfile.AUDIO_QUALITY_HIGH1); // |96|44100|
最终设定的值应该为：
* 音频：48 * 1024, 44100
* 视频：20, 1000 * 1024, 60
## 4.5 HappyDns 支持
为了防止 Dns 被劫持，SDK 加入了 HappyDns 支持，可以从[这里 __](https://github.com/qiniu/happy-
dns-android)查阅源码。 从 v1.4.6 版本开始，必须在宿主项目中的 build.gradle 中加入如下语句：
dependencies {
...
implementation 'com.qiniu:happy-dns:x.y.z'
...
}
其中，不同版本的 SDK 需依赖的 HappyDns 版本可能不同，详情可参阅[版本升级须知
__](https://developer.qiniu.com/pili/3716/PLDroidMediaStreaming-preparation-
before-development#4)
通过 `StreamingProfile` 设定自定义 `DnsManager`，如下：
public static DnsManager getMyDnsManager() {
IResolver[] resolvers = new IResolver[2];
// 配置自定义 DNS 服务器地址
String[] udpDnsServers = new String[]{"223.5.5.5"};
resolvers[0] = new DnsUdpResolver(udpDnsServers, Record.TYPE_A, DNS_DEFAULT_TIMEOUT);
// 配置 HTTPDNS 地址
String[] httpDnsServers = new String[]{"https://223.6.6.6/dns-query"};
resolvers[1] = new DohResolver(httpDnsServers, Record.TYPE_A, DNS_DEFAULT_TIMEOUT);
return new DnsManager(NetworkInfo.normal, resolvers);
}
StreamingProfile mProfile = new StreamingProfile();
mStreamingProfile.setDnsManager(getMyDnsManager()); // 设置自定义 DnsManager
* 可通过创建 DnsUdpResolver 对象配置自定义的 DNS 服务器地址
* 可通过创建 DohResolver 对象配置支持 Doh(Dns over http) 协议的 url
其中，UDP 的方式解析速度快，但是安全性无法得到保证，HTTPDNS 的方式解析速度慢，但是安全性有保证，您可根据您的使用场景自行选择合适的解析方式。
若不调用 `StreamingProfile#setDnsManager` 方法，SDK 会默认的创建一个 `DnsManager` 来对 Dns
进行解析，默认优先使用 UDP 的解析方式。
## 4.6 码率控制模式
可通过设置 EncoderRCModes 指定推流的码率控制模式，目前 RC mode 支持的类型：
* EncoderRCModes.QUALITY_PRIORITY: 质量优先，实际的码率可能高于设置的码率
* EncoderRCModes.BITRATE_PRIORITY: 码率优先，更精确地码率控制
可通过 StreamingProfile 的 setEncoderRCMode 方法进行设置，如下：
mStreamingProfile.setEncoderRCMode(StreamingProfile.EncoderRCModes.QUALITY_PRIORITY);
注：默认值为 `EncoderRCModes.QUALITY_PRIORITY`
## 4.7 Encoding size 的设定
SDK 将 Preview size 和 Encoding size 已经分离，他们之间互不影响。Preview size 代表的是 Camera
本地预览的 size，encoding size 代表的是编码时候的 size，即播放端不做处理时候看到视频的 size。
有两种方式可以设置 Encoding size：
* 使用内置的 encoding size level：`StreamingProfile#setEncodingSizeLevel`
* 设定一个 encoding size 偏好值：`StreamingProfile#setPreferredVideoEncodingSize(int, int)`
SDK 会秉持一个原则，用户偏好值的优先级会高于内置的设置。若同时调用了上述 api，偏好设置会覆盖内置的 encoding size level。
内置的 Encoding size level 对应的分辨率：
Level | Resolution(16:9) | Resolution(4:3)
---|---|---
VIDEO_ENCODING_HEIGHT_240 | 424 x 240 | 320 x 240
VIDEO_ENCODING_HEIGHT_480 | 848 x 480 | 640 x 480
VIDEO_ENCODING_HEIGHT_544 | 960 x 544 | 720 x 544
VIDEO_ENCODING_HEIGHT_720 | 1280 x 720 | 960 x 720
VIDEO_ENCODING_HEIGHT_1088 | 1920 x 1088 | 1440 x 1088
## 4.8 StreamStatus 反馈配置
对于推流信息的反馈，可以通过 `StreamingProfile#setStreamStatusConfig` 来设定其反馈的频率：
mStreamingProfile#setStreamStatusConfig(new StreamingProfile.StreamStatusConfig(3)); // 单位为秒
其含义为，若注册了 `mMediaStreamingManager.setStreamStatusCallback` ，每隔 3 秒回调
StreamStatus 信息。
## 4.9 动态更改 Orientation
动态更改 Orientation，包括动态更改 Encoding Orientation 以及动态切换横竖屏。
* 动态更改 Encoding Orientation
更改的是编码后图像的方向，但需要重新推流才会生效；目前支持的 ENCODING_ORIENTATION 的类型有：PORT 和 LAND
用户不设置的情况下， Encoding Orientation 会依赖 Activity 的 Orientation，即有如下对应关系：
// 不调用 `setEncodingOrientation` 情况下，SDK 会默认根据如下关系进行设置 Encoding Orientation
Activity Orientation | -> | Encoding Orientation
---|---|---
ActivityInfo.SCREEN_ORIENTATION_PORTRAIT | -> | PORT
ActivityInfo.SCREEN_ORIENTATION_LANDSCAPE | -> | LAND
设置 `ENCODING_ORIENTATION.PORT` 之后，播放端会观看竖屏的画面；
设置 `ENCODING_ORIENTATION.LAND` 之后，播放端会观看横屏的画面。
其设置方式如下：
mProfile.setEncodingOrientation(StreamingProfile.ENCODING_ORIENTATION.PORT);
mMediaStreamingManager.setStreamingProfile(mProfile); // notify MediaStreamingManager that StreamingProfile had been changed.
* 动态切换横竖屏
用户切换 Activity 方向后，相应地调整 Camera 的预览显示效果。
在更改了 Activity Orientation 之后，需要调用 `notifyActivityOrientationChanged` 通知
`MediaStreamingManager`。
比如：
setRequestedOrientation(isEncOrientationPort ? ActivityInfo.SCREEN_ORIENTATION_PORTRAIT : ActivityInfo.SCREEN_ORIENTATION_LANDSCAPE);
mMediaStreamingManager.notifyActivityOrientationChanged();
需要注意的是，为了防止 `setRequestedOrientation` 调用后 Activity 的重建，需要在 AndroidManifest.xml
里面配置对应的 Activity 的如下属性：
android:configChanges="orientation|screenSize"
可查看 Demo 中的 `.SWCodecCameraStreamingActivity` 的[配置
__](https://github.com/pili-
engineering/PLDroidMediaStreaming/blob/master/PLDroidMediaStreamingDemo/app/src/main/AndroidManifest.xml)。
## 4.10 自适应码率
由于无线网络相对于有线网络，可靠性较低，会经常遇到信号覆盖不佳导致的高丢包、高延时等问题，特别是在用网高峰期，由于带宽有限，网络拥塞的情况时有发生。自
[v2.1.0 __](https://github.com/pili-
engineering/PLDroidMediaStreaming/releases/tag/v2.1.0-beta)起，PLDroidMediaStreaming
提供了对应的优化方案。可以通过如下 API 开启自适应码率(注意：SDK 默认是关闭自适应码率的)：
/**
* adaptive bitrate adjust mode
*/
public enum BitrateAdjustMode {
Auto, // SDK 自适应码率调节
Manual, // 用户自己实现码率调节, 范围：10kbps~10Mbps
Disable // 关闭码率调节
}
mProfile.setBitrateAdjustMode(StreamingProfile.BitrateAdjustMode.Auto);
开启自适应码率后，当 SDK 检测到网络状况差时，会尝试降低码率，直到 StreamingProfile.VIDEO_QUALITY_LOW1 (150
Kbps)；反之，会提升码率，直到用户设定的 Target Bitrate（通过 StreamingProfile#setVideoQuality 或
StreamingProfile#VideoProfile 设定的码率值）
另外，可以通过下面接口控制自适应码率调节的范围:
/**
* Sets the range value of video adaptive bitrate.
*
* @param minBitrate min bitrate, unit: bps
* @param maxBitrate max bitrate, unit: bps
* */
public StreamingProfile setVideoAdaptiveBitrateRange(int minBitrate, int maxBitrate)
此时，码率调节策略为：
* 用户网络没有触发自动码率调节，码率一直保持在 Target Bitrate（通过 StreamingProfile#setVideoQuality 或 StreamingProfile#VideoProfile 设定的码率值）附近
* 触发自动码率调节后：
* 向下：
* 逐级调整，直到自适应码率调节范围的下限(minBitrate)
* 向上：
* 如果调节范围的上限 (maxBitrate) 大于 Target Bitrate，最高会调整到 Target Bitrate
* 如果调节范围的上限 (maxBitrate) 小于 Target Bitrate，最高会调整到调节范围的上限(maxBitrate)
## 4.11 FilterMode 参数设置
* 当图像采集尺寸与推流尺寸不一致时，SDK 会对采集图像进行 resize 操作，通过 FilterMode 参数，可以对 resize 算法进行设置。
* 相关接口如下：
/**
* filter mode for libyuv
*/
public enum YuvFilterMode {
None, // Point sample; Fastest.
Linear, // Filter horizontally only.
Bilinear, // Faster than box, but lower quality scaling down.
Box // Highest quality.
}
/**
* Sets the YUV filter mode
* @param mode the {@link YuvFilterMode}, default: {@link YuvFilterMode#None}
* @return this
*/
public StreamingProfile setYuvFilterMode(YuvFilterMode mode)
* 该参数只对软编和硬编 YUV 有效
## 4.12 SRT 协议支持
从 v3.1.0 版本开始，新增对 SRT 传输协议的支持，开启方式如下：
/**
* 开启/关闭 SRT 协议传输
*
* @param enabled 开启/关闭 (true / false)
* @return this
*/
public StreamingProfile setSrtEnabled(boolean enabled)
开启后，使用符合官方标准的 SRT 推流地址即可实现 SRT 协议的音视频传输，SRT 推流地址标准可参考 [access-control
__](https://github.com/Haivision/srt/blob/master/docs/features/access-
control.md#general-syntax)，示例如下：
srt://pili-publish.qnsdk.com?streamid=#!::h=sdk-live/xxx,m=publish
## 4.13 视频编码格式设置
从 v3.1.5 版本开始，新增视频编码格式的设置，支持设置 H.264 或 H.265 编码格式，默认使用 H.264 编码格式。
设置方式如下：
/**
* 视频编码格式
*/
public enum PLVideoEncodeType {
H264, // H.264 编码格式
HEVC // H.265 编码格式
}
/**
* 设置视频编码格式
*
* @param videoEncodeType 视频编码格式
* @return this
*/
public StreamingProfile setVideoEncodeType(PLVideoEncodeType videoEncodeType)
基于 Android 设备的兼容性问题，视频编码格式可能由于设备不支持该编码而出现创建编码器失败的情况，最终的编码格式将会通过
**StreamingStateChangedListener** 回调接口返回。处理回调的示例代码如下：
private StreamingStateChangedListener mStreamingStateChangedListener = new StreamingStateChangedListener() {
@Override
public void onStateChanged(StreamingState streamingState, final Object extra) {
case VIDEO_ENCODER_READY:
// 编码器初始化完成，编码类型为 ((PLVideoEncodeType) extra).name())
break;
});
}
};
**注意：**HEVC(H.265) 视频编码格式仅在视频硬编且传输协议为 RTMP 和 QUIC 时生效。软编和 SRT 协议下，将会自动切换到
H.264 视频编码格式
# 5 水印设置
所有水印相关的配置，都在 `WatermarkSetting` 类中进行。
## 5.1 水印位置信息
水印的位置信息，目前内置四个方位，如：
public enum WATERMARK_LOCATION {
NORTH_WEST,
NORTH_EAST,
SOUTH_WEST,
SOUTH_EAST,
}
分别在屏幕的位置如下图所示：
/**
* define the relative location of watermark on the screen when start streaming
*
* | NorthWest | | NorthEast
* | | |
* | | |
* | --------------|----------------|--------------
* | | |
* | | |
* | | |
* | --------------|----------------|--------------
* | | |
* | | |
* | SouthWest | | SouthEast
*
*/
**自定义水印的位置信息**
除了通过 WATERMARK_LOCATION 的四个固定的内置位置，还可以自定义水印的位置信息：
/**
* Set the custom position of watermark top-left point (percentage of surfaceview).
* top-left of the surfaceview is the origin of the coordinate system.
* positive x-axis pointing right and the positive y-axis pointing down.
* normal values of both x and y MUST be [0.0f-1.0f]
*
* meanwhile unset the location
* @param x
* @param y
*/
public WatermarkSetting setCustomPosition(float x, float y);
使用方式如下：
// 以 Preview 的中心点为起点进行水印的绘制
watermarksetting.setCustomPosition(0.5f, 0.5f);
## 5.2 水印显示大小
/**
* define de relative size of watermark
*/
public enum WATERMARK_SIZE {
LARGE,
MEDIUM,
SMALL,
}
2.4.0 版本后提供了设置自定义水印像素大小的功能，使用方式如下：
watermarksetting.setCustomSize(int width, int height);
## 5.3 构造 `WatermarkSetting`
传入 drawable 对象作为水印资源：
WatermarkSetting watermarksetting = new WatermarkSetting(mContext, R.drawable.qiniu_logo, WatermarkSetting.WATERMARK_LOCATION.SOUTH_WEST, WatermarkSetting.WATERMARK_SIZE.MEDIUM, 100); // 100 为 alpha 值
传入图片的绝对路径作为水印资源：
WatermarkSetting watermarksetting = WatermarkSetting(mContext, "watermark resource absolute path", WatermarkSetting.WATERMARK_LOCATION.SOUTH_WEST, WatermarkSetting.WATERMARK_SIZE.MEDIUM, 100) {
# 6 核心类 MediaStreamingManager
所有音视频推流相关的具体操作，都在 MediaStreamingManager 中进行。
## 6.1 构造 MediaStreamingManager
在构造 MediaStreamingManager 阶段会确定其编码的类型，目前 SDK 支持的编码类型有：
- AVCodecType.HW_VIDEO_WITH_HW_AUDIO_CODEC, // 视频硬编，音频硬编
- AVCodecType.SW_VIDEO_WITH_HW_AUDIO_CODEC, // 视频软编，音频硬编
- AVCodecType.SW_VIDEO_WITH_SW_AUDIO_CODEC, // 视频软编，音频软编
- AVCodecType.SW_AUDIO_CODEC, // 纯音频软编
- AVCodecType.HW_AUDIO_CODEC, // 纯音频硬编
- AVCodecType.SW_VIDEO_CODEC, // 纯视频软编
- AVCodecType.HW_VIDEO_CODEC; // 纯视频硬编
构造带有视频 MediaStreamingManager，需要传入 GLSurfaceView
mMediaStreamingManager = new MediaStreamingManager(mContext, mGLSurfaceView, EncodingType.SW_VIDEO_WITH_SW_AUDIO_CODEC);
构造完毕后，需调用 `MediaStreamingManager#prepare` 向 SDK 提供对应的配置信息，以 v1.6.2 版本为例：
mMediaStreamingManager.prepare(mCameraStreamingSetting, mMicrophoneStreamingSetting, mWatermarkSetting, mProfile);
## 6.2 设置 Listener
为了更好的和 SDK 交互，接受各种状态和其他信息，需要注册对应的 Listener:
mMediaStreamingManager.setStreamingStateListener(this);
mMediaStreamingManager.setStreamingSessionListener(this);
mMediaStreamingManager.setStreamStatusCallback(this);
* StreamingStateChangedListener
接口原型如下：
/**
* Callback interface for Streaming State.
* <p>
*
* Called on an "arbitrary thread".
*
* */
public interface StreamingStateChangedListener {
/**
* Invoked if the {@link StreamingState} changed
*
* @param status the specified {@link StreamingState}
* @param extra the extra information
* */
void onStateChanged(StreamingState status, Object extra);
}
onStateChanged 中 status 对应的含义分别为：
public enum StreamingState {
/**
* The initial state.
*
* */
UNKNOWN,
/**
* Preparing the environment for network connection.
* <p>
* The first state after calling {@link StreamingManager#startStreaming()}
*
* */
PREPARING,
/**
* <ol>
* <li>{@link StreamingManager#resume()} done in pure audio streaming</li>
* <li>{@link StreamingManager#resume()} done and camera be activated in AV streaming.</li>
* </ol>
* */
READY,
/**
* Being connecting.
*
* */
CONNECTING,
/**
* The av datas start sending successfully.
*
* */
STREAMING,
/**
* Streaming has been finished, and you can {@link StreamingManager#startStreaming()} again.
*
* */
SHUTDOWN,
/**
* Connect error.
*
* The following is the possible case:
*
* <ol>
* <li>Stream is invalid</li>
* <li>Network is unreachable</li>
* </ol>
*
* */
IOERROR,
/**
* Notify the camera switched.
* <p>
* extra will including the info the new camera id.
*
* <ol>
* <li>Camera.CameraInfo.CAMERA_FACING_FRONT</li>
* <li>Camera.CameraInfo.CAMERA_FACING_BACK</li>
* </ol>
*
* <pre>
* <code>
* Log.i(TAG, "current camera id:" + (Integer)extra);
* </code>
* </pre>
* */
CAMERA_SWITCHED,
/**
* Notify the torch info after camera be active.
* <p>
* extra will including the info if the device support the Torch.
*
* <ol>
* <li>true, supported</li>
* <li>false, unsupported</li>
* </ol>
*
* <pre>
* <code>
* final boolean isSupportedTorch = (Boolean) extra;
* </code>
* </pre>
*
* */
TORCH_INFO,
/**
* Sending buffer is empty.
*
* */
SENDING_BUFFER_EMPTY,
/**
* Sending buffer have been full.
*
* */
SENDING_BUFFER_FULL,
/**
* Sending buffer have few items witch waiting to be sent.
*
* */
SENDING_BUFFER_HAS_FEW_ITEMS,
/**
* Sending buffer have many items witch waiting to be sent.
*
* */
SENDING_BUFFER_HAS_MANY_ITEMS,
/**
* The network connection has been broken.
*
* */
DISCONNECTED,
/**
* if the device hasn't the supported preview size, then it will select the default preview
* size which mismatch the specified {@link CameraStreamingSetting.PREVIEW_SIZE_RATIO}.
*
* */
NO_SUPPORTED_PREVIEW_SIZE,
/**
* {@link AudioRecord#startRecording()} failed.
*
* */
AUDIO_RECORDING_FAIL,
/**
* camera open failed.
*
* */
OPEN_CAMERA_FAIL,
/**
* Do not support NV21 preview format.
*
* */
NO_NV21_PREVIEW_FORMAT,
/**
* start video encoder success
*/
VIDEO_ENCODER_READY,
/**
* start video encoder failed
*/
START_VIDEO_ENCODER_FAIL,
/**
* video encoder error happened
*/
VIDEO_ENCODER_ERROR,
/**
* start audio encoder failed
*/
START_AUDIO_ENCODER_FAIL,
/**
* video encoder error happened
*/
AUDIO_ENCODER_ERROR,
/**
* Invalid streaming url.
*
* Gets the message after call {@link StreamingManager#setStreamingProfile(StreamingProfile)} if streaming
* url is invalid. Also gets the url as the extra info.
* */
INVALID_STREAMING_URL,
/**
* The network had been built successfully.
*
* */
CONNECTED,
/**
* Invalid streaming url.
*
* Gets the message after call {@link MediaStreamingManager#setStreamingProfile(StreamingProfile)} if streaming
* url is invalid. Also gets the url as the extra info.
* */
UNAUTHORIZED_STREAMING_URL,
}
**注意：** 如果出现了编码器错误相关的回调状态，如 `START_VIDEO_ENCODER_FAIL` `VIDEO_ENCODER_ERROR`
`START_AUDIO_ENCODER_FAIL` `AUDIO_ENCODER_ERROR` 等，用户可以在接收到状态回调后，更新相应的
AVCodecType 类型，再重新开始推流
* StreamingSessionListener
接口原型如下：
/**
* Callback interface for some particular Streaming incidents.
* <p>
*
* Called on an "arbitrary thread".
*
* */
public interface StreamingSessionListener {
/**
* Invoked when audio recording failed.
* <p>
*
* @param code error code. <b>Unspecified now</b>.
*
* @return true means you handled the event; otherwise, given up.
*
* */
boolean onRecordAudioFailedHandled(int code);
/**
* Restart streaming notification.
* <p>
*
* When the network-connection is broken, {@link StreamingState#DISCONNECTED} will notified first,
* and then invoked this method if the environment of restart streaming is ready.
*
* <p>
* SDK won't limit the number of invocation.
*
* @param code error code. <b>Unspecified now</b>.
*
* @return true means you handled the event; otherwise, given up and then {@link StreamingState#SHUTDOWN}
* will be notified.
*
* */
boolean onRestartStreamingHandled(int code);
/**
* Invoked after camera object constructed.
* <p>
* The supported list exists in following cases:
* <ol>
* <li>If didn't set the
* {@link CameraStreamingSetting#setCameraPrvSizeRatio} when
* initialize {@link CameraStreamingSetting},
* the whole supported list would be passed</li>
* <li>If {@link CameraStreamingSetting#setCameraPrvSizeRatio}
* was set, the supported preview size which filtered by the specified ratio would be passed</li>
* </ol>
*
* @param list supported camera preview list which sorted from smallest to largest. The list maybe null.
*
* @return null means you give up selection and SDK will help you select a proper preview
* size; otherwise, the returned size will be effective.
*
* */
Camera.Size onPreviewSizeSelected(List<Camera.Size> list);
/**
* Custom preview fps, invoked after camera object constructed.
*
* @param supportedPreviewFpsRange
* a list of supported preview fps ranges by Camera. This method returns a
* list with at least one element. Every element is an int array
* of two values - minimum fps and maximum fps.
* @return -1 means you give up selection and SDK will help you select a proper preview
* fps; otherwise, the returned index will be effective.
*/
int onPreviewFpsSelected(final List<int[]> supportedPreviewFpsRange);
}
可以在 StreamingSessionListener 处理一些重连、音频读取失败、preview size 的自定义操作。
@Override
public boolean onRecordAudioFailedHandled(int err) {
mMediaStreamingManager.updateEncodingType(AVCodecType.SW_VIDEO_CODEC);
mMediaStreamingManager.startStreaming();
return true;
}
@Override
public boolean onRestartStreamingHandled(int err) {
return mMediaStreamingManager.startStreaming();
}
@Override
public Camera.Size onPreviewSizeSelected(List<Camera.Size> list) {
if (list != null) {
for (Camera.Size s : list) {
Log.i(TAG, "w:" + s.width + ", h:" + s.height);
}
// return "your choice";
}
return null;
}
在消费了 onRecordAudioFailedHandled 或 onRestartStreamingHandled 之后，您应该返回 true 通知
SDK；若不做任何处理，返回 false。
* StreamStatusCallback
接口原型如下：
/**
* Callback interface used to notify {@link StreamingProfile.StreamStatus}.
*/
public interface StreamStatusCallback {
/**
* Called per the {@link StreamingProfile.StreamStatusConfig#getIntervalMs}
*
* @param status the new {@link StreamingProfile.StreamStatus}
*
* */
void notifyStreamStatusChanged(final StreamingProfile.StreamStatus status);
}
注意：notifyStreamStatusChanged 运行在非 UI 线程中。
StreamStatus 的定义如下：
/**
* The nested class is for feedbacking the av status in real time.
*
* <p>
* You can set the {@link StreamStatusConfig} to get the preferred callback frequency.
*
* */
public static class StreamStatus {
/**
* Audio frame per second.
* */
public int audioFps;
/**
* Video frame per second.
* */
public int videoFps;
/**
* Audio and video total bits per second.
* */
public int totalAVBitrate; // bps
/**
* Audio bits per second.
* */
public int audioBitrate; // bps
/**
* Video bits per second.
* */
public int videoBitrate; // bps
/**
* Number of dropped video frames in callback period.
* */
public int droppedVideoFrames;
}
## 6.3 resume
`MediaStreamingManager#resume` 会进行 Camera 的打开操作，当成功打开后，会返回 STATE.READY
消息，用户可以在接受到 STATE.READY 之后，安全地进行推流操作。
mMediaStreamingManager.resume();
若在一个 Activity 中进行推流操作，建议 `mMediaStreamingManager.resume()` 在
`Activity#onResume` 中被调用。
## 6.4 开始推流
由于 startStreaming 会进行网络链接相关操作，因此需要将 startStreaming 运行在非 UI 线程，否则可能会发生崩溃现象。
mMediaStreamingManager.startStreaming();
## 6.5 手动对焦
对焦之前传入 Focus Indicator , 如果不进行设置，对焦过程中将会没有对应的 UI 显示。
// You should call this after getting {@link STATE#READY}.
mMediaStreamingManager.setFocusAreaIndicator(mRotateLayout,
mRotateLayout.findViewById(R.id.focus_indicator));
点击屏幕触发手动对焦，并设置对应的坐标值。
// You should call this after getting {@link STATE#READY}.
mMediaStreamingManager.doSingleTapUp((int) e.getX(), (int) e.getY());
## 6.6 Zoom
Camera Zoom 操作。
// mCurrentZoom must be in the range of [0, mMediaStreamingManager.getMaxZoom()]
// You should call this after getting {@link STATE#READY}.
if (mMediaStreamingManager.isZoomSupported()) {
mMediaStreamingManager.setZoomValue(mCurrentZoom);
}
可以获取到当前的 Zoom 值：
mMediaStreamingManager.getZoom();
## 6.7 闪光灯操作
开启闪光灯。
mMediaStreamingManager.turnLightOn();
关闭闪光灯。
mMediaStreamingManager.turnLightOff();
## 6.8 切换摄像头
切换摄像头。
mMediaStreamingManager.switchCamera();
## 6.9 获取采集帧率范围
获取 Camera 设置的采集帧率范围。
mMediaStreamingManager.getPreviewFpsRange();
注意：
* 该接口返回的是实际帧率乘以 1000 的帧率范围，如 [10000, 30000]，代表帧率范围为 10fps～30fps
* 该接口需要在收到 OnStateChanged.READY 状态后调用，否则将会返回 null
## 6.10 禁音推流
在推流过程中，将声音禁用掉：
mMediaStreamingManager.mute(true);
恢复声音：
mMediaStreamingManager.mute(false);
注：默认为 false
## 6.11 截帧
在 Camera 正常预览之后，可以正常进行截帧功能。
在调用 captureFrame 的时候，您需要传入 width 和 height，以及 FrameCapturedCallback，如果传入的 width
或者 height 小于等于 0，SDK 返回的 Bitmap 将会是预览的尺寸 。SDK 完成截帧之后，会回调
onFrameCaptured，并将结果以参数的形式返回给调用者。
mMediaStreamingManager.captureFrame(w, h, new FrameCapturedCallback() {
@Override
public void onFrameCaptured(Bitmap bmp) {
}
}
注意：调用者有义务对 Bitmap 进行回收释放。截帧失败，bmp 会为 null。
## 6.12 停止推流
停止当前推流。
mMediaStreamingManager.stopStreaming();
## 6.13 Log 管理
当 enabled 设置为 true ，SDK Native 层的 log 将会被打开；当设置为 false，SDK Native 层的 log
将会被关闭。默认处于打开状态。
mMediaStreamingManager.setNativeLoggingEnabled(false);
注：默认值为 true。建议 Release 版本置为 false。
## 6.14 pause
退出 MediaStreamingManager，该操作会主动断开当前的流链接，并关闭 Camera 和释放相应的资源。
mMediaStreamingManager.pause();
## 6.15 destroy
释放不紧要资源。
mMediaStreamingManager.destroy();
## 6.16 自定义音频数据处理
用户可以通过下面回调接口，获取当前音频数据，实现自定义音频数据处理。
// 注册音频采集数据回调
mMediaStreamingManager.setAudioSourceCallback(AudioSourceCallback callback)；
public interface AudioSourceCallback {
/**
* 回调音频采集 PCM 数据
*
* @param srcBuffer 音频 PCM数据，该 buffer 是 direct ByteBuffer。
* @param size buffer的大小
* @param tsInNanoTime 时间戳，单位：纳秒
* @param isEof 采集结束标志
*/
void onAudioSourceAvailable(ByteBuffer srcBuffer, int size, long tsInNanoTime, boolean isEof);
}
## 6.17 动态水印
通过调用 `MediaStreamingManager.updateWatermarkSetting` 方法可以动态改变水印的内容、位置、大小。
WatermarkSetting watermarkSetting = new WatermarkSetting(context);
watermarkSetting.setResourceId(R.drawable.qiniu_logo);
watermarkSetting.setAlpha(50);
watermarkSetting.setSize(WatermarkSetting.WATERMARK_SIZE.LARGE);
watermarkSetting.setLocation(WatermarkSetting.WATERMARK_LOCATION.SOUTH_EAST);
mMediaStreamingManager.updateWatermarkSetting(newWatermarkSetting);
## 6.18 发送 SEI 信息
可以通过调用如下接口进行 SEI 信息的发送：
/**
* 发送 SEI 信息
*
* @param msg SEI 信息内容
* @param repeatCount SEI 信息需要发送的次数
*/
public void sendSEIMessage(String msg, int repeatCount);
/**
* 发送 SEI 信息
*
* @param msg SEI 信息内容
* @param repeatCount SEI 信息需要发送的次数
* @param timestampNs SEI 信息需要展示的时间
*/
public void sendSEIMessage(String msg, int repeatCount, long timestampNs)
播放端解析 SEI 的过程中，对 payloadSize 的判断需要检测收到的 SEI 信息中 `0xFF` 的个数，每增加一个 `0xFF` 代表
payloadSize 增加 255 个字节。实际组成格式如下：
* 1 byte for SEI NAL Header
* 1 byte for SEI payload type
* (n + 1) bytes for SEI payload size
* 16 bytes for SEI NALU uuid
* (n * 255 + xy) bytes for SEI NALU payload content
* 1 byte for SEI NALU rbsp railing bits
## 6.19 动态改变预览镜像
若希望在推流过程中动态改变摄像头预览的镜像效果，可以使用如下 API：
mMediaStreamingManager.setPreviewMirror(boolean mirror)
## 6.20 动态改变推流镜像
若希望在推流过程中动态改变推流的镜像效果，可以使用如下 API：
mMediaStreamingManager.setEncodingMirror(boolean mirror)
## 6.21 推流时增加背景音乐
若希望在推流过程中增加背景音乐，可以使用如下 API：
mAudioMixer = mMediaStreamingManager.getAudioMixer();
mAudioMixer.setOnAudioMixListener(new OnAudioMixListener() {
@Override
public void onStatusChanged(MixStatus mixStatus) {
mMixToggleBtn.post(new Runnable() {
@Override
public void run() {
...
}
});
}
@Override
public void onProgress(long progress, long duration) {
// time in Us
}
});
mAudioFile = Cache.getAudioFile(this); // 背景音乐文件路径
if (mAudioFile != null) {
try {
mAudioMixer.setFile(mAudioFile, true); // true/false 是否循环
} catch (IOException e) {
e.printStackTrace();
}
}
boolean s = mAudioMixer.play();
text = s ? "mixing play success" : "mixing play failed !!!";
## 6.22 返听／耳返功能
若希望在推流过程中开启返听（耳返），可以使用如下 API：
mMediaStreamingManager.startPlayback();
mMediaStreamingManager.stopPlayback();
## 6.23 QUIC 推流
QUIC 是基于 UDP 开发的可靠传输协议，在弱网下拥有更好的推流效果，相比于 TCP 拥有更低的延迟，可抵抗更高的丢包率。
* 通过下面接口开启/关闭 QUIC 推流
mProfile.setQuicEnable(quicEnable);
## 6.24 SRT 推流
SRT 协议是基于 UDT 的传输协议，抗丢包能力强，适用于复杂的网络。相比于 TCP 可抵抗更高的丢包率。
* 通过下面接口开启/关闭 SRT 推流
mProfile.setSrtEnabled(enabled);
## 6.25 图片推流
若希望在推流过程中推送图片，可以通过如下方式实现：
### 设置推流的图片
设置推流图片有两种方式：
* 推流前预设图片
推流前可以通过 StreamingPofile 的方式进行图片的预设，支持本地图片或者 resource 图片，示例代码如下：
mProfile.setPictureStreamingFilePath(mPicStreamingFilePath);
或
mProfile.setPictureStreamingResourceId(R.drawable.pause_publish);
* 推流过程中动态改变图片
推流过程中可以通过 MediaStreamingManager 的接口进行图片的更换，支持本地图片或者 resource 图片，示例代码如下：
mMediaStreamingManager.setPictureStreamingFilePath(mPicStreamingFilePath);
或
mMediaStreamingManager.setPictureStreamingResourceId(R.drawable.qiniu_logo);
**注意：图片当前仅支持 32 位 png**
### 设置图片帧率
可以在开始推流之前，通过如下调用 StreamingProfile 的如下接口进行图片帧率的设置：
/**
* 设置图片推流的帧率
*
* @param fps 帧率，仅支持 0-30 的配置
*/
public void setPictureStreamingFps(float fps)
示例代码如下：
mProfile.setPictureStreamingFps(10);
### 切换图片推流
可以通过如下接口进行图片推流的切换：
/**
* 切换图片推流。如果当前正在推图片，则停止图片推流，开启音视频推流；反之，则停止音视频推流，开启图片推流
*/
public boolean togglePictureStreaming()
示例代码如下：
boolean isOK = mMediaStreamingManager.togglePictureStreaming();
# 7 自定义滤镜
## 7.1 软编模式滤镜实现
需要分别处理预览显示的 filter 效果和 encoding 的 filter 效果：预览显示通过实现 SurfaceTextureCallback
interface；encoding 通过实现 `StreamingPreviewCallback` interface。两者分别实现，互不影响。
* encoding 部分
public interface StreamingPreviewCallback {
public boolean onPreviewFrame(byte[] bytes, int width, int height, int rotation, int fmt, long tsInNanoTime);
}
onPreviewFrame 会回调 NV21 格式的 YUV 数据，进行 filter 算法处理后的结果仍然保存在 bytes 数组中，SDK 会将
bytes 中的数据当作数据源进行后续的编码和封包等操作；onPreviewFrame 运行在名称为 CameraManagerHt
的子线程中；onPreviewFrame 仅在 STATE.STREAMING 状态下被回调。
* 预览显示部分
public interface SurfaceTextureCallback {
void onSurfaceCreated();
void onSurfaceChanged(int width, int height);
void onSurfaceDestroyed();
int onDrawFrame(int texId, int width, int height);
}
四个回调均执行在 GL rendering thread；如果 onDrawFrame 直接返回 texId，代表放弃 filter 处理，否则
onDrawFrame 应该返回一个 filter 算法处理过的纹理 id； 自定义的 Texture id，即 onDrawFrame 返回的纹理 id，
必须是 GLES20.GL_TEXTURE_2D 类型；SDK 回调的纹理 id，即 onDrawFrame 的参数 texId 类型为
GLES11Ext.GL_TEXTURE_EXTERNAL_OES。
## 7.2 硬编模式滤镜实现
硬编模式下仅需要实现 SurfaceTextureCallback interface 就可实现预览显示和 streaming。
# 8 录屏
PLDroidMediaStreaming 封装好了录屏相关的底层操作，用户可以非常方便的进行录屏推流。其步骤如下：
## 8.1 AndroidManifest.xml 修改
注册 SDK 中携带的 ScreenCaptureRequestActivity
<activity
android:name="com.qiniu.pili.droid.streaming.screen.ScreenCaptureRequestActivity"
android:theme="@android:style/Theme.Translucent.NoTitleBar" >
</activity>
**注意：** 如果你的项目 targetVersion 大于等于 29 ，那么你还需要额外注册一个 ScreenRecordService
<service
android:name="com.qiniu.pili.droid.streaming.screen.ScreenRecordService"
android:enabled="true"
android:foregroundServiceType="mediaProjection" />
## 8.2 构造核心类 `ScreenStreamingManager`
`ScreenStreamingManager` 封装了屏幕的录制、音频的采集，编码，封包和推流操作。用户只需要简单的调用相关 API 即可实现录屏推流：
// 构造 ScreenStreamingManager
ScreenStreamingManager screenStreamingManager = new ScreenStreamingManager();
// 配置相关参数
screenStreamingManager.prepare(context, screenSetting, null, streamingProfile);
// 开始推流
screenStreamingManager.startStreaming();
// 停止推流
screenStreamingManager.stopStreaming();
// 销毁
screenStreamingManager.destroy();
**注意：**如果项目 targetVersion >= 29 ，则 startStreaming() 应该运行在子线程，在开始录屏之后 SDK
内部会创建一个默认的 Notification ，如果您需要使用自定义 Notification，那么请在开始推流之前调用如下代码：
screenStreamingManager.setNotification(customNotificationId, customNotification);
如果后续想要更新此 Notification ，那么可以在更改自定义 notification 对象后调用如下代码即可：
screenStreamingManager.notifyNotification()
## 8.3 自定义音频数据处理
用户可以通过下面回调接口，获取当前音频数据，实现自定义音频数据处理。
// 注册音频采集数据回调
screenStreamingManager.setAudioSourceCallback(AudioSourceCallback callback)；
public interface AudioSourceCallback {
/**
* 回调音频采集 PCM 数据
*
* @param srcBuffer 音频 PCM数据，该 buffer 是 direct ByteBuffer。
* @param size buffer的大小
* @param tsInNanoTime 时间戳，单位：纳秒
* @param isEof 采集结束标志
*/
void onAudioSourceAvailable(ByteBuffer srcBuffer, int size, long tsInNanoTime, boolean isEof);
}
# 9 StreamingManager
`StreamingManager` 是类似 MediaStreamingManager 的一个类，两者的区别是：StreamingManager
不带采集，仅包含编码、封包推流模块，从功能层面可以理解为：
MediaStreamingManager = 采集模块 + (处理模块) + StreamingManager
其调用过程类似于 MediaStreamingManager：
构造 StreamingManager -> prepare -> resume -> startStreaming -> inputAudioFrame/inputVideoFrame -> stopStreaming -> pause -> destroy
具体可以参考 Demo 中的 [ImportStreamingActivity.java __](https://github.com/pili-
engineering/PLDroidMediaStreaming/blob/master/PLDroidMediaStreamingDemo/app/src/main/java/com/qiniu/pili/droid/streaming/demo/activity/ImportStreamingActivity.java)
PS：若希望使用自己已有项目中的采集／处理模块，可以选用 StreamingManager.
## 9.1 外部输入音频
void inputAudioFrame(ByteBuffer buffer, int size, long tsInNanoTime, boolean isEof);
void inputAudioFrame(byte[] buffer, long tsInNanoTime, boolean isEof);
可以选择传入 ByteBuffer 或者 byte[] 类型的 PCM 源数据，传入的时间戳为 nano time。
## 9.2 外部输入视频
void inputVideoFrame(ByteBuffer buffer, int size, int width, int height, int rotation, boolean mirror, int fmt, long tsInNanoTime);
void inputVideoFrame(byte[] buffer, int width, int height, int rotation, boolean mirror, int fmt, long tsInNanoTime);
可以选择传入 ByteBuffer 或者 byte[] 类型的 YUV 数据，其中：
* width 和 height，分别为该 frame 的宽和高，单位像素
* rotation ，指该 frame 需要选择的角度（0，90，180，360），若自己已经处理好角度的旋转，rotation 参数为 0
* mirror，指是否对该 frame 做镜像处理
* fmt，指该 frame 的格式，目前支持 NV21 和 I420，即：PLFourCC.FOURCC_NV21 和 PLFourCC.FOURCC_I420
* tsInNanoTime，指该 frame 对应的时间戳，单位为纳秒
## 9.3 开始推流
通过调用如下接口开始推流：
mStreamingManager.startStreaming();
## 9.4 停止推流
通过调用如下接口停止推流：
mStreamingManager.stopStreaming();
## 9.5 getInputSurface
`getInputSurface` 须在 `startStreaming` 被调用成功之后，从 `MediaCodec` 获取其 `Surface` 类型的
InputSurface，用户可以在这个 `Surface` 上面进行自定义绘制，绘制好后使用 `frameAvailable` 通知 SDK 进行编码。
若希望使用该高级功能，需在 `AVCodecType.HW_VIDEO_SURFACE_AS_INPUT_WITH_HW_AUDIO_CODEC`
模式下，否则会抛出异常。
## 9.6 发送 SEI 信息
通过调用如下接口进行 SEI 信息的发送：
/**
* 发送 SEI 信息
*
* @param msg 信息内容
* @param repeatCount 信息重复次数
*/
public void sendSEIMessage(String msg, int repeatCount)
/**
* 发送带有时间戳的 SEI 信息
*
* @param msg 信息内容
* @param repeatCount 信息重复次数
* @param timestampNs 信息显示时间
*/
public void sendSEIMessage(String msg, int repeatCount, long timestampNs)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,181 |
知识补充与建议 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 推流端 >Android 推流端 SDK
>知识补充与建议
# 知识补充与建议
最近更新时间: 2017-06-01 17:15:21
# 1 编码相关参数说明
## 1.1 码率、fps、分辨率对清晰度及流畅度的影响
对于码率（BitRate）、FPS（video frame per
second）、分辨率（VideoSize）三者的关系，有必要在这里做一些说明，以便你根据自己产品的需要可以有的放矢的调节各个参数。
一个视频流个人的感受一般来说会有卡顿、模糊等消极的情况，虽然我们都不愿意接受消极情况的出现，但是在 UGC 甚至 PGC
的直播场景中，都不可避免的要面对。因为直播推流实时性很强烈，所以为了保证这一实时性，在网络带宽不足或者上行速度不佳的情况下，都需要做出选择。
要么选择更好的流程度但牺牲清晰度（模糊），要么选择更好的清晰度但牺牲流畅度（卡顿），这一层的选择大多由产品决定。
一般来说，当选定了一个分辨率后，推流过程中就不会对分辨率做变更，但可以对码率和 FPS 做出调节，从而达到上述两种情况的选择。
效果 | 码率 | FPS
---|---|---
流畅度 | 负相关 | 正相关
清晰度 | 正相关 | 负相关
通过这个关联，我们就可以容易的知道该如何从技术层面做出调整。在追求更好的流畅度时，我们可以适当降低码率，如果 FPS 已经较高（如 30）时，可以维持
FPS 不变更，如果此时因为码率太低而画面无法接受，可以再适当调低 FPS；在追求更清晰的画质时，可以提高码率，FPS 调节至 24
左右人眼大多还会识别为流畅，如果可以接受有轻微卡顿，那么可以将 FPS 设置的更低，比如 20 甚至 15。
总之，这三者之间一起构建其了画面清晰和视频流畅的感觉，但最终参数是否能满意需要自己不断调整和调优，从而满足产品层面的需求。
## 1.2 建议编码参数
提示：以下为建议值，可根据产品需求自行更改调节。
UGC 场景，因为主播方所在的网络环境参差不齐，所以不易将码率设置的过高，此处我们给出建议设定：
* WiFi: `VIDEO_QUALITY_MEDIUM2` 或者自定义编码参数时设定码率为 `800Kbps`
* 3G/4G: `VIDEO_QUALITY_MEDIUM1` 或者自定义编码参数时设定码率为 `512Kbps`
PGC 场景，因为主播方所在网络一般都会有较高的要求，并且主播网络质量大多可以保障带宽充足，此处我们给出建议设定：
* WiFi: `VIDEO_QUALITY_HIGH1` 或者自定义编码参数时设定码率为 `1200Kbps`
* 3G/4G: `VIDEO_QUALITY_MEDIUM2` 或者自定义编码参数时设定码率为 `800Kbps`
对于 PGC 中的 3G/4G 场景，假定 PGC 时会配备较好的外置热点保证上行带宽充足。
# 2 网络异常处理
## 2.1 重连
在网络断开、sendTimeOut 后没有发出数据、网络链接被服务端断开等网络异常后，SDK 会：
* `DISCONNECTED` 消息会被回调；
* 当 SDK 内部处理完一些必要的清理工作后，如果实现了 `StreamingSessionListener` interface 并调用了对应的注册函数 `mMediaStreamingManager.setStreamingSessionListener(this);`， `StreamingSessionListener.onRestartStreamingHandled` 将会被回调，用户可以在这里进行重连，即 `mMediaStreamingManager.startStreaming();`
* 若网络不可达（即网络断开等情况），尝试重连之后，会返回 `IOERROR`，可以不用担心循环重连的问题。
需要注意的是，在网络层会有三次重连的机会，即没有必要在收到 `IOERROR` 之后继续进行重连，一般接收到 `IOERROR`
代表无法通过网络和服务端建立链接。
重连可以很好地避免网络抖动导致的断流，建议正确实现重连逻辑，可以提升用户体验。
# 3 丢帧策略
这一章节，我们谈谈追帧策略，这关乎最终的直播观看体验，这里我们主要说明为何需要它，以及它带来的利弊。
## 3.1 丢帧策略的必要性
我想可能没有人会喜欢在直播中出现丢帧，但是为何我们一定要实现并提供它呢？这是我们在最初提供出丢帧策略时也在反复考虑和一再讨论过的一个问题。
原因很简单，为了保证直播的实时性。
直播作为有别于录播的富媒体传播手段，它的第一要素就是实时，没有了实时，直播的价值就会荡然无存。保证实时性就需要确保录制端的数据尽可能少的累积，尽可能快的发送，但如果没有丢帧策略，在弱网环境下，就会因为待发送数据的不断堆积而产生累计延时，最终带来延时越来越大的情况。作为推流的发起端和推送端，推流
SDK
要考虑的还不单单是实时性这一点，因为移动设备的内存有限，而视频数据对内存的占用较大，所以在推流时还要确保不会因为待发送数据堆积过多而带来内存吃紧，触发
crash 等严重问题。所以我们需要也一定要在推流端提供丢帧策略。
丢帧的方式可以有很多种，其中有些较为粗暴，会触发各类问题，比如花屏，爆音，音画不同步等问题，在反复尝试和验证了各类的丢帧策略后，我们最终选定了优先保证音频传输且不触发花屏、爆音、音画不同步问题的技术方案。这一方案可以保证在带宽不足或上行速度不佳时，优先丢弃视频帧，保证音频的持续传输，在观看端至多出现画面跳帧的情况，但声音会是连续的片段，体验上不会认为是推流端断网，确保直播的继续进行。
## 3.2 利弊
丢帧策略固然保证了直播的实时性和推流端相对的稳定性，但是它的弊端也是显然的，就是会带来观看端体验的不佳。
面对并接受这一弊端是必要，这样才可以做出更好的产品决策，我们建议从产品层面至少需要考虑两点
在主播弱网情况下，观看端体验要保证流畅度优先还是清晰度优先 在主播弱网情况下，尽可能让主播自己知晓自己网络不佳这一事实
对于流畅度和清晰度的问题，可以参见码率、fps、分辨率对清晰度及流畅度的影响这一小节。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 推流端 >Android 推流端 SDK
>知识补充与建议
# 知识补充与建议
最近更新时间: 2017-06-01 17:15:21
# 1 编码相关参数说明
## 1.1 码率、fps、分辨率对清晰度及流畅度的影响
对于码率（BitRate）、FPS（video frame per
second）、分辨率（VideoSize）三者的关系，有必要在这里做一些说明，以便你根据自己产品的需要可以有的放矢的调节各个参数。
一个视频流个人的感受一般来说会有卡顿、模糊等消极的情况，虽然我们都不愿意接受消极情况的出现，但是在 UGC 甚至 PGC
的直播场景中，都不可避免的要面对。因为直播推流实时性很强烈，所以为了保证这一实时性，在网络带宽不足或者上行速度不佳的情况下，都需要做出选择。
要么选择更好的流程度但牺牲清晰度（模糊），要么选择更好的清晰度但牺牲流畅度（卡顿），这一层的选择大多由产品决定。
一般来说，当选定了一个分辨率后，推流过程中就不会对分辨率做变更，但可以对码率和 FPS 做出调节，从而达到上述两种情况的选择。
效果 | 码率 | FPS
---|---|---
流畅度 | 负相关 | 正相关
清晰度 | 正相关 | 负相关
通过这个关联，我们就可以容易的知道该如何从技术层面做出调整。在追求更好的流畅度时，我们可以适当降低码率，如果 FPS 已经较高（如 30）时，可以维持
FPS 不变更，如果此时因为码率太低而画面无法接受，可以再适当调低 FPS；在追求更清晰的画质时，可以提高码率，FPS 调节至 24
左右人眼大多还会识别为流畅，如果可以接受有轻微卡顿，那么可以将 FPS 设置的更低，比如 20 甚至 15。
总之，这三者之间一起构建其了画面清晰和视频流畅的感觉，但最终参数是否能满意需要自己不断调整和调优，从而满足产品层面的需求。
## 1.2 建议编码参数
提示：以下为建议值，可根据产品需求自行更改调节。
UGC 场景，因为主播方所在的网络环境参差不齐，所以不易将码率设置的过高，此处我们给出建议设定：
* WiFi: `VIDEO_QUALITY_MEDIUM2` 或者自定义编码参数时设定码率为 `800Kbps`
* 3G/4G: `VIDEO_QUALITY_MEDIUM1` 或者自定义编码参数时设定码率为 `512Kbps`
PGC 场景，因为主播方所在网络一般都会有较高的要求，并且主播网络质量大多可以保障带宽充足，此处我们给出建议设定：
* WiFi: `VIDEO_QUALITY_HIGH1` 或者自定义编码参数时设定码率为 `1200Kbps`
* 3G/4G: `VIDEO_QUALITY_MEDIUM2` 或者自定义编码参数时设定码率为 `800Kbps`
对于 PGC 中的 3G/4G 场景，假定 PGC 时会配备较好的外置热点保证上行带宽充足。
# 2 网络异常处理
## 2.1 重连
在网络断开、sendTimeOut 后没有发出数据、网络链接被服务端断开等网络异常后，SDK 会：
* `DISCONNECTED` 消息会被回调；
* 当 SDK 内部处理完一些必要的清理工作后，如果实现了 `StreamingSessionListener` interface 并调用了对应的注册函数 `mMediaStreamingManager.setStreamingSessionListener(this);`， `StreamingSessionListener.onRestartStreamingHandled` 将会被回调，用户可以在这里进行重连，即 `mMediaStreamingManager.startStreaming();`
* 若网络不可达（即网络断开等情况），尝试重连之后，会返回 `IOERROR`，可以不用担心循环重连的问题。
需要注意的是，在网络层会有三次重连的机会，即没有必要在收到 `IOERROR` 之后继续进行重连，一般接收到 `IOERROR`
代表无法通过网络和服务端建立链接。
重连可以很好地避免网络抖动导致的断流，建议正确实现重连逻辑，可以提升用户体验。
# 3 丢帧策略
这一章节，我们谈谈追帧策略，这关乎最终的直播观看体验，这里我们主要说明为何需要它，以及它带来的利弊。
## 3.1 丢帧策略的必要性
我想可能没有人会喜欢在直播中出现丢帧，但是为何我们一定要实现并提供它呢？这是我们在最初提供出丢帧策略时也在反复考虑和一再讨论过的一个问题。
原因很简单，为了保证直播的实时性。
直播作为有别于录播的富媒体传播手段，它的第一要素就是实时，没有了实时，直播的价值就会荡然无存。保证实时性就需要确保录制端的数据尽可能少的累积，尽可能快的发送，但如果没有丢帧策略，在弱网环境下，就会因为待发送数据的不断堆积而产生累计延时，最终带来延时越来越大的情况。作为推流的发起端和推送端，推流
SDK
要考虑的还不单单是实时性这一点，因为移动设备的内存有限，而视频数据对内存的占用较大，所以在推流时还要确保不会因为待发送数据堆积过多而带来内存吃紧，触发
crash 等严重问题。所以我们需要也一定要在推流端提供丢帧策略。
丢帧的方式可以有很多种，其中有些较为粗暴，会触发各类问题，比如花屏，爆音，音画不同步等问题，在反复尝试和验证了各类的丢帧策略后，我们最终选定了优先保证音频传输且不触发花屏、爆音、音画不同步问题的技术方案。这一方案可以保证在带宽不足或上行速度不佳时，优先丢弃视频帧，保证音频的持续传输，在观看端至多出现画面跳帧的情况，但声音会是连续的片段，体验上不会认为是推流端断网，确保直播的继续进行。
## 3.2 利弊
丢帧策略固然保证了直播的实时性和推流端相对的稳定性，但是它的弊端也是显然的，就是会带来观看端体验的不佳。
面对并接受这一弊端是必要，这样才可以做出更好的产品决策，我们建议从产品层面至少需要考虑两点
在主播弱网情况下，观看端体验要保证流畅度优先还是清晰度优先 在主播弱网情况下，尽可能让主播自己知晓自己网络不佳这一事实
对于流畅度和清晰度的问题，可以参见码率、fps、分辨率对清晰度及流畅度的影响这一小节。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,247 |
历史记录 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 推流端 >Android 推流端 SDK >历史记录
# 历史记录
最近更新时间: 2024-03-13 18:18:26
* 3.1.6 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-3.1.6.md))
* 版本
* 发布 pldroid-media-streaming-3.1.6.jar
* 更新 libpldroid_streaming_core.so
* 功能
* 新增流状态异常情况下的 DISCONNECTED 状态回调
* 新增对 YV12 格式外部数据导入的支持
* 缺陷
* 修复频繁添加贴纸闪烁的问题
* 修复 H.265 场景下 hls 播放地址无法播放的问题
* 3.1.5.1 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-3.1.5.1.md))
* 版本
* 发布 pldroid-media-streaming-3.1.5.1.jar
* 优化
* 移除对 Android ID 的获取
* 3.1.5 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-3.1.5.md))
* 版本
* 发布 pldroid-media-streaming-3.1.5.jar
* 更新 libpldroid_streaming_core.so
* 更新 libpldroid_streaming_h264_encoder.so
* 更新 libpldroid_streaming_srt.so
* 更新 libpldroid_mmprocessing.so
* 移除 libssl.so
* 移除 libcrypto.so
* 功能
* 新增对 H.265 硬编编码格式的支持
* 缺陷
* 修复频繁切换摄像头后无法再次切换的问题
* 修复 SRT 推流音画不同步的问题
* 修复上架时提示 OpenSSL 版本存在风险的问题
* 3.1.4 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-3.1.4.md))
* 版本
* 发布 pldroid-media-streaming-3.1.4.jar
* 更新 libpldroid_streaming_core.so
* 缺陷
* 修复个别场景下的内存泄漏问题
* 修复软编场景切换摄像头后无法推流的问题
* 修复个别接口调用偶现耗时较长的问题
* 优化
* 更新默认 DNS 的配置，优化解析体验
* 3.1.3 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-3.1.3.md))
* 版本
* 发布 pldroid-media-streaming-3.1.3.jar
* 功能
* 支持 userID 变更
* 优化
* 更新 HappyDNS 版本为 1.0.0，支持配置 HTTPDNS 服务
* 3.1.2 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-3.1.2.md))
* 版本
* 发布 pldroid-media-streaming-3.1.2.jar
* 功能
* 新增硬编场景码率控制模式的设置
* 优化
* 优化自适应码率的调整逻辑
* 缺陷
* 修复个别场景下的空指针异常
* 修复录屏场景下偶现的音画不同步问题
* 3.1.1 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-3.1.1.md))
* 版本
* 发布 pldroid-media-streaming-3.1.1.jar
* 功能
* 新增直播中对动态切换蓝牙耳机的支持
* 缺陷
* 修复外部导入数据直播时间戳异常的问题
* 修复个别场景下贴纸异常的问题
* 修复个别场景下屏幕旋转导致的预览异常问题
* 修复外部导入直播修改配置失效的问题
* 修复个别场景的崩溃问题
* 3.1.0 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-3.1.0.md))
* 版本
* 发布 pldroid-media-streaming-3.1.0.jar
* 发布 libpldroid_streaming_srt.so
* 发布 libssl.so
* 发布 libcrypto.so
* 更新 libpldroid_streaming_core.so
* 更新 libpldroid_mmprocessing.so
* 更新 libpldroid_streaming_aac_encoder.so
* 更新 libpldroid_streaming_amix.so
* 更新 libpldroid_streaming_h264_encoder.so
* 功能
* 新增 SRT 传输协议支持
* 新增日志上传功能
* 缺陷
* 修复 Runtime 相关安全漏洞问题
* 修复图片推流场景下的内存泄漏问题
* 修复个别场景下的空指针问题
* 修复自定义水印导致的崩溃问题
* 修复个别场景下的编码器异常问题
* 修复频繁添加贴纸场景下的 ANR 问题
* 3.0.2 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-3.0.2.md))
* 版本
* 发布 pldroid-media-streaming-3.0.2.jar
* 更新 libpldroid_streaming_core.so
* 功能
* 新增摄像头抢占回调
* 新增编码器异常状态回调
* 优化
* 优化录屏场景下可能出现的帧率较低的问题
* 缺陷
* 修复音视频和纯音频模式动态切换失败的问题
* 修复个别机型推流画面变形的问题
* 修复添加贴纸预览和播放效果不一致的问题
* 修复软编场景实时刷新水印存在的闪烁问题
* 修复特殊场景下偶现的 ANR 问题
* 修复特殊场景下的崩溃问题
* 3.0.1 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-3.0.1.md))
* 版本
* 发布 pldroid-media-streaming-3.0.1.jar
* 更新 libpldroid_streaming_core.so
* 功能
* 新增日志保存功能
* 优化
* 优化 demo 结构
* 优化 SEI 发送功能，支持自定义大小的数据发送
* 缺陷
* 修复个别机型初始化前置摄像头失败的问题
* 修复个别机型录屏推流异常的问题
* 修复 targetSdkVersion 29 以后录屏崩溃的问题
* 3.0.0 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-3.0.0.md))
* 版本
* 发布 pldroid-media-streaming-3.0.0.jar
* 更新 libpldroid_streaming_core.so
* 功能
* 新增包名鉴权功能
* 新增外部数据导入发送 SEI 的功能
* 缺陷
* 修复个别场景下推流花屏的问题
* 修复硬编场景下个别机型图片推流卡住的问题
* 修复单声道下返听失败的问题
* 修复双声道下回放时长变长的问题
* 修复双声道下混音偶现的崩溃问题
* 修复水印导致三方美颜异常的问题
* 2.4.1 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-2.4.1.md))
* 版本
* 发布 pldroid-media-streaming-2.4.1.jar
* 更新 libpldroid_streaming_amix.so
* 更新 libpldroid_streaming_core.so
* 功能
* 新增发送 SEI 功能
* 新增设置 bitmap 水印功能
* 缺陷
* 修复截图场景下的空指针问题
* 修复软编推流水印颜色异常的问题
* 修复非循环混音场景下的崩溃问题
* 2.4.0 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-2.4.0.md))
* 版本
* 发布 pldroid-media-streaming-2.4.0.jar
* 功能
* 新增设置水印自定义像素大小功能，不仅限于固定枚举值
* 新增 Surface 硬编下，推流前的纹理回调功能
* 2.3.0 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-2.3.0.md))
* 版本
* 发布 pldroid-media-streaming-2.3.0.jar
* 新增 libpldroid_streaming_puic.so
* 更新 libpldroid_mmprocessing.so
* 更新 libpldroid_streaming_core.so
* 功能
* 新增录制时动态水印功能
* 新增 QUIC 推流功能
* 缺陷
* 修复金立 M7 黑屏问题
* 修复纯音频推流 pause 后无法 resume 问题
* 修复弱网下 pause 小概率 ANR 问题
* 注意事项
* 从 v2.3.0 版本开始，增加 libpldroid_streaming_puic.so 库
* libpldroid_streaming_core.so 依赖于 libpldroid_streaming_puic.so，无论是否启用 QUIC 推流，都需要包含 libpldroid_streaming_puic.so 库
* 2.2.6 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-2.2.6.md))
* 版本
* 发布 pldroid-media-streaming-2.2.6.jar
* 功能
* 新增 H.264 Profile 设置接口
* 缺陷
* 修复部分机型推流画面拉伸问题
* 2.2.5 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-2.2.5.md))
* 版本
* 发布 pldroid-media-streaming-2.2.5.jar
* 更新 libpldroid_mmprocessing.so
* 功能
* 新增 YUV resize 算法配置接口
* 新增 Camera 预览帧率设置回调接口
* 2.2.4 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-2.2.4.md))
* 版本
* 发布 pldroid-media-streaming-2.2.4.jar
* 缺陷
* 修复使用外部第三方美颜时，预览与推流画面旋转了 90 度的问题
* demo 层面添加重连的代码示例
* 2.2.3 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-2.2.3.md))
* 版本
* 发布 pldroid-media-streaming-2.2.3.jar
* 缺陷
* 修复未配置码率上下限导致动态码率失控的问题
* 2.2.2 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-2.2.2.md))
* 版本
* 发布 pldroid-media-streaming-2.2.2.jar
* 更新 libpldroid_streaming_amix.so
* 更新 libpldroid_streaming_core.so
* 更新 libpldroid_mmprocessing.so
* 功能
* 录屏推流中增加推图片接口
ScreenStreamingManager 类中增加:
/**
* toggle publishing the picture set in StreamingProfile
*/
public boolean togglePictureStreaming()
* 缺陷
* 修复超过 4.5 小时连续推流断开连接问题
* 修复硬编 yuv 模式在某些机型颜色不正问题
* 修复特定音频文件导致混音失败问题
* 修复后台录屏推流在某些机型声音异常问题
* 修复软编 1080p 推流在某些机型崩溃问题
* 2.2.1 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-2.2.1.md))
* 版本
* 发布 pldroid-media-streaming-2.2.1.jar
* 发布 libpldroid_streaming_amix.so
* 更新 libpldroid_streaming_h264_encoder.so
* 更新 libpldroid_mmprocessing.so
* 功能
* 新增混音功能
* 新增返听功能
* 新增图片推流过程中动态切换图片功能
* 新增推流画面自定义剪裁
* 缺陷
* 修复切换摄像头偶现的无法推流的问题
* 修复开启动态码率后在部分配置下出现的马赛克问题
* 移除 `CameraSourceImproved` 相关接口
* 2.2.0 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-2.2.0.md))
* 版本
* 发布 pldroid-media-streaming-2.2.0.jar
* 更新 libpldroid_streaming_core.so
* 更新 libpldroid_streaming_h264_encoder.so
* 更新 libpldroid_streaming_aac_encoder.so
* 更新 libpldroid_mmprocessing.so
* 功能
* `VideoProfile` 提供 `annexb` 和 `avcc` 格式的配置选项
* 新增后台推流功能
* 新增码率调节方式设置接口
* 新增手动调节码率接口
* 新增双声道推流的支持
* 实现新版日志系统，SDK 输出的日志过滤 TAG 为：`PLDroidMediaStreaming`
* 缺陷
* 修复因图片的透明度导致的硬编水印异常
* 修复自定义帧率配置不生效的问题
* 修复部分场景下停止推流低概率偶现的ANR异常
* 修复极端弱网或低内存下丢关键帧导致播放花屏的问题
* 修复软编推流 tbc 过大的问题
* 2.1.3 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-2.1.3.md))
* 版本
* 发布 pldroid-media-streaming-2.1.3.jar
* 更新 libpldroid_streaming_core.so
* 功能
* 新增动态码率上下限配置接口
* 新增设置录屏推流状态回调的接口
* 新增是否支持 `PreviewAppearance` 模式的检测接口
* 新增是否支持 `improved` 模式的接口
* 新增自定义动态码率相关阈值接口
* 缺陷
* 修复录屏推流过程中偶现的部分崩溃问题
* 修复推流音频采集过程中低概率的数组越界异常
* 修复部分 Android 机型摄像头预览画面太暗的问题
* 修复推流 AVCC 嵌套问题
* 修复自定义推流帧率配置不生效的问题
* 2.1.2 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-2.1.2.md))
* 版本
* 发布 pldroid-media-streaming-2.1.2.jar
* 更新 libpldroid_streaming_core.so
* 更新 libpldroid_mmprocessing.so
* 更新 libpldroid_streaming_aac_encoder.so
* 更新 libpldroid_streaming_h264_encoder.so
* 功能
* 新增动态 mirror 功能
* 动态改变本地预览镜像
/**
* change mirror of local preview
* @param mirror
* @return
*/
public boolean setPreviewMirror(boolean mirror)
* 动态改变推流镜像
/**
* change mirror of streaming
* @param mirror
* @return
*/
public boolean setEncodingMirror(boolean mirror)
* 在推流的 metadata 中添加了系统信息
* 增加录屏请求被拒绝后的回调
* `在 onStateChanged 新增 StreamingState REQUEST_SCREEN_CAPTURING_FAIL`
* 缺陷
* 修复在部分机型上预览画面太暗的问题
* 修复在部分机型上切换摄像头画面异常和闪屏问题
* 修复在部分机型上推流视频帧率为 0 的问题
* 修复部分外部美颜 OpenGL 报错的问题
* 修复硬编带来的各种稳定性问题
* 修复弱网优化效果不明显的问题
* 修复部分场景下停止推流产生的 crash 问题
* 修复 onPreviewSizeSelected 不回调问题
* 修复部分机型获取 Camera 预览帧率可能崩溃的问题
* 2.1.1 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-2.1.1.md))
* 缺陷
* 修复弱网情况下概率性 crash 问题
* 修复硬编模式开启 Improved 模式，导致播放端画面异常的问题
* 修复部分机型概率性导致水印显示异常
* 版本
* 发布 pldroid-media-streaming-2.1.1.jar
* 2.1.0 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-2.1.0-beta.md))
* 功能
* 新增外部数据源支持
* 新增 `StreamingManager`
class com.qiniu.pili.droid.streaming.StreamingManager {
public StreamingManager(android.content.Context);
public StreamingManager(android.content.Context, AVCodecType);
boolean prepare(StreamingProfile);
boolean resume();
void pause();
void destroy();
boolean startStreaming();
boolean stopStreaming();
void setNativeLoggingEnabled(boolean);
void setStreamingStateListener(StreamingStateChangedListener);
void setStreamingSessionListener(StreamingSessionListener);
void setStreamStatusCallback(StreamStatusCallback);
void setStreamingProfile(StreamingProfile);
Surface getInputSurface(int width, int height);
void frameAvailable(boolean endOfStream);
void inputAudioFrame(ByteBuffer buffer, int size, long tsInNanoTime, boolean isEof);
void inputAudioFrame(byte[] buffer, long tsInNanoTime, boolean isEof);
void inputVideoFrame(ByteBuffer buffer, int size, int width, int height, int rotation, boolean mirror, int fmt, long tsInNanoTime);
void inputVideoFrame(byte[] buffer, int width, int height, int rotation, boolean mirror, int fmt, long tsInNanoTime);
void updateEncodingType(AVCodecType);
}
* 新增录屏支持
* 新增 `ScreenStreamingManager`
class com.qiniu.pili.droid.streaming.ScreenStreamingManager {
public ScreenStreamingManager(android.app.Activity);
boolean prepare(ScreenSetting screenSetting, MicrophoneStreamingSetting microphoneSetting, StreamingProfile profile);
boolean startStreaming();
boolean stopStreaming();
void setStreamingStateListener(StreamingStateChangedListener);
void mute(boolean enable);
void destroy();
}
* 新增 `ScreenSetting`
class com.qiniu.pili.droid.streaming.ScreenSetting {
ScreenSetting setSize(int width, int height);
ScreenSetting setDpi(int dpi);
int getWidth();
int getHeight();
int getDpi();
}
* 注意事项：需要在 AndroidManifest.xml 增加 SDK 内置 Activity `com.qiniu.pili.droid.streaming.screen.ScreenCaptureRequestActivity` 的声明
<activity
android:name="com.qiniu.pili.droid.streaming.screen.ScreenCaptureRequestActivity"
android:theme="@android:style/Theme.Translucent.NoTitleBar" >
</activity>
* 新增 `StreamingPreviewCallback` 接口回调参数
/**
* Called if the {@link StreamingPreviewCallback} registered.
*
* @param data the contents of the preview frame in fmt format
* @param width the width of the frame
* @param height the height of the frame
* @param rotation set the clockwise rotation of frame in degrees to achieve the same effect of preview display.
* @param fmt the format of the frame. See also {@link com.qiniu.pili.droid.streaming.av.common.PLFourCC}
* @param tsInNanoTime the timestamp of the frame
*
* */
boolean StreamingPreviewCallback#onPreviewFrame(byte[] data, int width, int height, int rotation, int fmt, long tsInNanoTime);
* 优化
* 新增 Camera 数据源优化及配置
* `CameraStreamingSetting#setCameraSourceImproved(boolean)`
* 新增 Camera 预览尺寸优化
* `CameraStreamingSetting#setPreviewSizeOptimize(boolean)`
* 支持自适应码率
* `StreamingProfile#setAdaptiveBitrateEnable(boolean)`
* Min Bitrate 为 `StreamingProfile#VIDEO_QUALITY_LOW1`, Max Bitrate 为用户设置的目标码率
* 缺陷
* 修复部分水印资源显示异常问题
* 修复特殊低端机型对焦导致的 crash 问题
* 修复部分机型硬编导致的 crash 问题
* 修复特殊情况下部分机型，onDrawFrame 未运行在渲染线程导致的 crash 问题
* 修复特殊机型 INTERNET 权限已声明但不生效导致的 crash 问题
* 修复其他概率性 crash 问题
* 版本
* 发布 pldroid-media-streaming-2.1.0.jar
* 更新 libpldroid_mmprocessing.so
* 更新 libpldroid_streaming_h264_encoder.so
* Demo
* 新增避免 Android 6.0(+) 设备权限导致 crash 问题的 patch
* 新增录屏功能的 Demo 展示
* `ScreenRecorderActivity`
* 新增外部数据源功能的 Demo 展示
* `ExtCapStreamingActivity`
* 更新 Demo
* 2.0.4 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-2.0.4.md))
* 缺陷
* 修复概率性 crash 问题
* 版本
* 发布 pldroid-media-streaming-2.0.4.jar
* 2.0.3 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-2.0.3.md))
* 缺陷
* 修复 home 键退出之后，再次启动应用，导致 onPreviewFrame 回调不生效问题
* 修复硬编模式下，home 键退出导致的 crash 问题
* 修复关闭音频权限之后，开始直播并未正常返回 AUDIO_RECORDING_FAIL 问题
* 修复硬编模式下，部分机型 EglCore 导致的空指针异常
* 版本
* 发布 pldroid-media-streaming-2.0.3.jar
* 2.0.2 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-2.0.2.md))
* 功能
* 修复特殊机型黑屏问题
* 版本
* 发布 pldroid-media-streaming-2.0.2.jar
* 更新 libpldroid_streaming_h264_encoder.so
* 2.0.1 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-2.0.1.md))
* 功能
* 新增硬编模式下 YUV 数据回调支持
* 缺陷
* 兼容更多的硬编机型
* 修复硬编特殊机型音画不同步问题
* 修复特殊机型上的 crash 问题
* 修复重连可能导致的 crash 问题
* 版本
* 发布 pldroid-media-streaming-2.0.1.jar
* 依赖 compile ‘com.qiniu.pili:pili-android-qos:0.8.+’
* 更新 libpldroid_streaming_core.so
* 更新 libpldroid_streaming_h264_encoder.so
* 更新 demo 代码
* 2.0.0-Beta ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-2.0.0-beta.md))
* 功能
* 新增可直接设置由七牛直播云生成的推流地址的 API
* 新增推流节点调度机制
* 新增 MediaStreamingManager 类，并废弃 CameraStreamingManager
* 新增一些辅助类并废弃相关的类
* 新增 Audio PCM 数据回调接口
* 新增检测是否支持指定的 Camera
* 缺陷
* 修复软编模式下， Android 6.0 target 设置为 23 无法正常推流的问题
* 修复硬编模式下，快速 home 键导致异常退出的问题
* 修复特殊机型初始化时导致的 crash
* 优化
* 优化水印清晰度
* 版本
* SDK 更名为 PLDroidMediaStreaming
* SDK 包名更改为 com.qiniu.pili.droid.streaming.*
* SDK Demo 重命名为 PLDroidMediaStreamingDemo
* 发布 pldroid-media-streaming-2.0.0.jar
* 更新 libpldroid_mmprocessing.so
* 更新 libpldroid_streaming_core.so
* 更新 libpldroid_streaming_h264_encoder.so
* 1.7.1 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.7.1.md))
* 功能
* 新增自定义水印位置支持
* 新增前置闪光灯支持（需硬件支持，如美图 M4）
* 新增第三个 Camera 的支持（比如 LG G5）
* 新增 Camera 本地预览镜像反转支持
* 缺陷
* 修复软编模式下 iOS 播放器硬解失败的问题
* 修复透明水印有黑色背景问题
* 修复特殊手机（奇酷）音画不同步
* 修复内置美颜模式下，部分机型黑屏现象
* 修复软编模式下，水印在播放端可能被压缩的问题
* 修复特殊机型（美图 M4）静音模式下出现杂音的问题
* 修复特殊机型特殊场景下，音频采集初始化失败导致的 crash 问题
* 修复 demo issue
* 版本
* 发布 pldroid-camera-streaming-1.7.1.jar
* 更新 libpldroid_mmprocessing.so
* 更新 libpldroid_streaming_core.so
* 更新 libpldroid_streaming_aac_encoder.so
* 更新 libpldroid_streaming_h264_encoder.so
* 更新 Demo
* 1.7.0 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.7.0.md))
* 功能
* 新增内置美颜功能，美颜效果可调节
* 新增采集帧率控制，避免帧率飙升不可控
* 缺陷
* 修复特殊步骤下 Contex 泄露问题
* 修复硬编水印在特殊机型上（Meilan note 2）异常显示
* 优化
* 优化采集，避免过度 UI 操作导致推流帧率降低
* 优化内存使用
* 版本
* 发布 pldroid-camera-streaming-1.7.0.jar
* 更新 libpldroid_mmprocessing.so
* 更新 libpldroid_streaming_core.so
* 更新 libpldroid_streaming_h264_encoder.so
* 更新 Demo
* 1.6.2 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.6.2.md))
* 发布 pldroid-camera-streaming-1.6.2.jar
* 修复特殊情况下导致的 crash 问题
* 更新 Demo 代码
* 1.6.1 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.6.1.md))
* 发布 pldroid-camera-streaming-1.6.1.jar
* 新增 libpldroid_mmprocessing.so
* 更新 libpldroid_streaming_core.so 和 libpldroid_streaming_h264_encoder.so
* 增加水印支持
* 优化软编 codec，提升画质和码控能力
* 兼容特殊的直播设备
* 新增 TransformMatrix 到 SurfaceTextureCallback#onDrawFrame
* 修复 `CameraStreamingManager#pause` 耗时较长
* 修复硬编纯音频无法正常停止推流
* 修复硬编推流过程中特殊步骤导致的概率性 crash
* 更新 Demo 代码
* 1.6.0 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.6.0.md))
* 发布 pldroid-camera-streaming-1.6.0.jar
* 更新 libpldroid_streaming_core.so 和 libpldroid_streaming_h264_encoder.so
* 新增 mirror 支持
* 新增 `StreamingEnv`
* 修复特殊机型硬编闪屏问题
* 修复禁播导致的 crash 问题
* 改善部分机型硬编 tearing 现象
* 兼容异常输入的情况，并提供回调
* 新增质量上报支持
* 修复资源泄漏问题
* 修复特殊机型 crash 问题
* 重构 Demo 代码
* 1.5.3 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.5.3.md))
* 发布 pldroid-camera-streaming-1.5.3.jar
* 修复特殊机型概率性 crash 问题
* 优化 Jar 包体积
* 1.5.1 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.5.1.md))
* 发布 pldroid-camera-streaming-1.5.1.jar
* 更新 libpldroid_streaming_core.so 和 libpldroid_streaming_h264_encoder.so
* 新增蓝牙麦克风支持
* 新增质量上报支持
* 优化启用／关闭输入法弹框导致的屏闪现象
* 修复部分机型手动对焦引起的 crash 问题
* 修复部分机型推流过程中概率性 crash 问题
* 修复部分机型频繁切换输入法导致黑屏问题
* 修复特殊机型硬编音画不同步问题
* 更新 demo 样例代码
* 1.5.0 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.5.0.md))
* 发布 pldroid-camera-streaming-1.5.0.jar
* 更新 libpldroid_streaming_core.so 和 libpldroid_streaming_h264_encoder.so
* 支持手动对焦
* 支持 Zoom
* 支持 mute/unmute
* 新增 `setSendTimeoutInSecond` API
* 对回调方法 `sortCameraPrvSize` 的行参 supportedPreviewSizeList 进行从小到大排序
* 当 DnsManager 设置为 null 后，不进行 Dns 解析，[Issue 78 __](https://github.com/pili-engineering/PLDroidCameraStreaming/issues/78)
* 优化数据源采集和显示效率，避免 UI 卡顿
* 修复硬编模式下，重连导致概率性 crash 问题
* 方法 onPrepare(), onResume(), onPause(), onDestroy() 分别重命名为 prepare(), resume(), pause(), destroy()
* 更新 demo 样例代码
* 1.4.6 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.4.6.md))
* 发布 pldroid-camera-streaming-1.4.6.jar
* 更新 libpldroid_streaming_core.so，libpldroid_streaming_aac_encoder.so 和 libpldroid_streaming_h264_encoder.so
* 提升软编编码帧率
* 优化推流过程中前后置摄像头切换体验
* 新增 happydns 支持，并提供 `setDnsManager` API，用户可自定义 `DnsManager`
* 新增 `StreamStatus` 回调，实现 `StreamStatusCallback` 获取音视频帧率和码率
* 新增 `setRecordingHint` API，可实现高帧率推流
* 修复推流过程中，特殊操作后，推流无图像问题
* 修复推流过程中，HOME 键退出，再次启动 app，无法切换 camera 问题
* 修复部分机型音画不同步，包括切换前后置
* 修复推流过程中，概率性 crash 问题
* 更新 demo 样例代码
* 1.4.5 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.4.5.md))
* 发布 pldroid-camera-streaming-1.4.5.jar
* 更新 libpldroid_streaming_core.so，libpldroid_streaming_aac_encoder.so 和 libpldroid_streaming_h264_encoder.so
* 新增动态更改 Encoding Orientation 支持
* 新增动态切换横竖屏支持
* 新增 `onPreviewSizeSelected` 支持
* 新增 `setPreferredVideoEncodingSize` 支持
* 新增 `VIDEO_ENCODING_HEIGHT_544` 支持
* 优化网络传输
* 提升画质
* 优化前后置切换
* 标记 `VIDEO_ENCODING_SIZE_QVGA` 等 Deprecated
* 标记 `onPreviewFrame(byte[] datas, Camera camera)` Deprecated
* 修复部分机型概率性 ANR
* 更新 demo 样例代码
* 1.4.3 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.4.3.md))
* 发布 pldroid-camera-streaming-1.4.3.jar
* 更新 libpldroid_streaming_core.so，libpldroid_streaming_aac_encoder.so 和 libpldroid_streaming_h264_encoder.so
* 新增 `SharedLibraryidHelper` 绝对路径加载方式
* 新增 `StreamingSessionListener`，可方便安全地实现重连策略及 Audio 数据获取失败时的策略
* 新增 `EncodingType` 支持
* 修复硬编模式下，多次切换前后置摄像头 crash 问题
* 修复硬编模式下，部分机型截图 crash 问题
* 修复 metadata 格式问题
* 修复软编模式下，推流过程中概率性 crash 问题
* 修复概率性无视频帧问题
* 更新 demo 展示代码
* 增加支持的机型信息
* 1.4.1 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.4.1.md))
* 发布 pldroid-camera-streaming-1.4.1.jar
* 更新 libpldroid_streaming_core.so
* 新增 libpldroid_streaming_aac_encoder.so 和 libpldroid_streaming_h264_encoder.so
* 新增 H.264 和 AAC 软编支持
* 新增软编数据源回调接口，可定制化 Filter (滤镜) 特效处理
* 修复硬编部分机型 crash 问题
* 修复硬编切换前后置时长异常问题
* 更新 demo 样例代码
* 1.3.9 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.3.9.md))
* 发布 pldroid-camera-streaming-1.3.9.jar
* 更新 libpldroid_streaming_core.so
* 增加 x86 支持
* 新增 x86/libpldroid_streaming_core.so
* 优化内存，减少内存抖动，增强稳定性
* 修复 onResume 之后快速 onPause 导致的 crash 问题
* 修复部分机型截图 crash 问题
* 修复部分机型切换前后置摄像头之后，导致切片异常问题
* 修复网络异常导致的 crash 问题(issue 54)
* 1.3.8 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.3.8.md))
* 发布 pldroid-camera-streaming-1.3.8.jar
* 更新 libpldroid_streaming_core.so
* 优化切换前后置摄像头数据重发时间，增强推流过程中切换前后置摄像头的稳定性
* 优化内存使用，避免 OOM
* 修复部分机型概率性 crash 问题
* 兼容 supportedPreviewSizeList 为空的机型
* 1.3.7 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.3.7.md))
* 发布 pldroid-camera-streaming-1.3.7.jar
* 更新 libpldroid_streaming_core.so
* 修复部分机型概率性 crash 问题
* 修复部分机型前后置 camera 切换的 crash 问题
* 兼容无前置 camera 的机型
* 1.3.6 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.3.6.md))
* 发布 pldroid-camera-streaming-1.3.6.jar
* 更新 libpldroid_streaming_core.so
* 优化 video stream 流畅度
* 修复概率性断流问题
* 修复部分机型推流过程中，概率性 crash 问题
* 修复部分机型切换前后置摄像头过程中，概率性 crash 问题
* 1.3.5 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.3.5.md))
* 发布 pldroid-camera-streaming-1.3.5.jar
* 更新 libpldroid_streaming_core.so
* 修复部分机型音视频不同步问题
* 分离 preview size 与 encoding size
* 新增 `setEncodingSizeLevel` API，并提供 encoding size 参数列表
* 修复部分机型花屏问题
* 修复前后置摄像头切换概率性断流问题
* 修复概率性 crash 问题
* 1.3.4 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.3.4.md))
* 发布 pldroid-camera-streaming-1.3.4.jar
* 更新 libpldroid_streaming_core.so
* 修复采用 ART 运行时的 Android 机型的 crash 问题
* 修复封包不兼容的问题
* 1.3.3 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.3.3.md))
* 发布 pldroid-camera-streaming-1.3.3.jar
* 删除 arm64-v8a/libpldroid_ffmpegbridge.so 以及 armeabi-v7a/libpldroid_ffmpegbridge.so
* 新增 armeabi 支持
* 新增 arm64-v8a/libpldroid_streaming_core.so, armeabi-v7a/libpldroid_streaming_core.so 和 armeabi/libpldroid_streaming_core.so
* 体积裁剪数十倍，动态链接库裁剪至 69KB
* 完全移除 FFmpeg 依赖
* 修复推流过程中，切换前后置断流问题
* 修复自适应码率过程中，切换 quality 断流问题
* 修复前后置切换概率性 crash 问题
* 1.3.2 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.3.2.md))
* 发布 pldroid-camera-streaming-1.3.2.jar
* 修复输入法弹起导致预览画面调整的问题
* 1.3.1 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.3.1.md))
* 发布 pldroid-camera-streaming-1.3.1.jar
* 增加 arm64-v8a 支持，新增 arm64-v8a/libpldroid_ffmpegbridge.so
* 更新 armeabi-v7a/libpldroid_ffmpegbridge.so
* 新增切换 `Stream` 接口：setStreamingProfile
* 新增 `setLocalFileAbsolutePath` 接口
* 修复横屏下，经过特殊操作，Camera 预览显示异常的问题
* 1.3.0 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.3.0.md))
* 发布 pldroid-camera-streaming-1.3.0.jar
* 新增自适应码率功能
* 新增截帧接口
* 新增 Preview Layout `REAL/FULL` mode，解决显示黑边问题
* 修复 IOS 和 Android 使用同一个 stream 时，导致 IOS 无法正常推流的问题
* 修复部分机型切换前后置 crash 问题
* 新增自适应码率演示代码
* 新增截帧演示代码
* 新增 REAL/FULL mode 演示代码
* 1.2.3 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.2.3.md))
* 发布 pldroid-camera-streaming-1.2.3.jar
* 新增 Audio quality 和 Video quality 配置项，可自由组合音视频码率参数
* 新增 Video quality 设置接口 `setVideoQuality`
* 新增 Audio quality 设置接口 `setAudioQuality`
* 优化 jar 包，减少约 30% 体积
* 1.2.2 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.2.2.md))
* 发布 pldroid-camera-streaming-1.2.2.jar
* 更新 libpldroid_ffmpegbridge.so
* 修复概率性的 crash 问题
* 添加 `STATE.CONNECTION_TIMEOUT` 状态
* 修复部分机型因连接错误而导致屏幕 Hang 住
* 在 UI 层对点击事件加入保护逻辑，避免快速点击导致应用 crash
* 1.2.1 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.2.1.md))
* 发布 pldroid-camera-streaming-1.2.1.jar
* 更新 libpldroid_ffmpegbridge.so
* 优化内存问题，修复 OOM 异常
* 优化 Quality 配置
* 添加 `setNativeLoggingEnabled()` 接口
* 1.2.0 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.2.0.md))
* 发布 pldroid-camera-streaming-1.2.0.jar
* 更新 libpldroid_ffmpegbridge.so
* 更新 Stream 设置接口：`setStream(stream)`
* 添加 Camera 切换接口：`switchCamera`
* 修复 Android L crash 问题
* 添加 Camera 切换状态：`STATE.CAMERA_SWITCHED`
* 添加 Torch 是否支持状态：`STATE.TORCH_INFO`
* 更新状态回调接口：`onStateChanged(state, extra)`
* 修复特殊操作的概率性 crash 问题
* 修复部分机型 `turnLightOn` 及 `turnLightOff` 接口无效问题
* 修复部分机型点击 Home 按键 crash 问题
* 修复部分机型因 `PREVIEW_SIZE_LEVEL` 导致 crash 问题
* 添加 Camera 切换操作演示代码
* 更新 Torch 组件显示逻辑
* 1.1.0 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.1.0.md))
* 发布 pldroid-camera-streaming-1.1.0.jar
* 更新 libpldroid_ffmpegbridge.so
* 优化 ffmpegbridge 模块，降低 libpldroid_ffmpegbridge.so 文件大小
* 添加纯音频推流支持：添加纯音频推流 `CameraStreamingManager(Context ctx)` 构造函数
* 纯音频推流支持后台运行
* 添加 preview size 设定接口：`setCameraPrvSizeLevel` 及 `setCameraPrvSizeRatio`
* 添加 torch 操作接口： `turnLightOn` 及 `turnLightOff`
* 添加控制连续自动对焦的接口：`setContinuousFocusModeEnabled`
* 废弃 `setCameraPreviewSize` 接口
* 修复部分机型因 preivew size 不支持而导致的 crash 问题
* 添加 `AudioStreamingActivity` 及 `StreamingBaseActivity`，用来演示纯音频推流
* 添加 torch 操作演示代码
* 1.0.2 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.0.2.md))
* 发布 pldroid-camera-streaming-1.0.2.jar
* 修复无 `StreamingStateListener` 情况下的 Crash 问题
* 修复正常启动后无 READY 消息返回问题
* 更新 `Stream` 定义，并与服务端保持一致
* 增加相机正常启动后即开始推流功能
* 1.0.1 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.0.1.md))
* 发布 pldroid-camera-streaming-1.0.1.jar
* 更新 `Stream` 类结构
* 更新 `Stream` 的构造方式
* 1.0.0 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.0.0.md))
* 发布 PLDroidCameraStreaming v1.0.0
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 推流端 >Android 推流端 SDK >历史记录
# 历史记录
最近更新时间: 2024-03-13 18:18:26
* 3.1.6 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-3.1.6.md))
* 版本
* 发布 pldroid-media-streaming-3.1.6.jar
* 更新 libpldroid_streaming_core.so
* 功能
* 新增流状态异常情况下的 DISCONNECTED 状态回调
* 新增对 YV12 格式外部数据导入的支持
* 缺陷
* 修复频繁添加贴纸闪烁的问题
* 修复 H.265 场景下 hls 播放地址无法播放的问题
* 3.1.5.1 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-3.1.5.1.md))
* 版本
* 发布 pldroid-media-streaming-3.1.5.1.jar
* 优化
* 移除对 Android ID 的获取
* 3.1.5 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-3.1.5.md))
* 版本
* 发布 pldroid-media-streaming-3.1.5.jar
* 更新 libpldroid_streaming_core.so
* 更新 libpldroid_streaming_h264_encoder.so
* 更新 libpldroid_streaming_srt.so
* 更新 libpldroid_mmprocessing.so
* 移除 libssl.so
* 移除 libcrypto.so
* 功能
* 新增对 H.265 硬编编码格式的支持
* 缺陷
* 修复频繁切换摄像头后无法再次切换的问题
* 修复 SRT 推流音画不同步的问题
* 修复上架时提示 OpenSSL 版本存在风险的问题
* 3.1.4 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-3.1.4.md))
* 版本
* 发布 pldroid-media-streaming-3.1.4.jar
* 更新 libpldroid_streaming_core.so
* 缺陷
* 修复个别场景下的内存泄漏问题
* 修复软编场景切换摄像头后无法推流的问题
* 修复个别接口调用偶现耗时较长的问题
* 优化
* 更新默认 DNS 的配置，优化解析体验
* 3.1.3 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-3.1.3.md))
* 版本
* 发布 pldroid-media-streaming-3.1.3.jar
* 功能
* 支持 userID 变更
* 优化
* 更新 HappyDNS 版本为 1.0.0，支持配置 HTTPDNS 服务
* 3.1.2 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-3.1.2.md))
* 版本
* 发布 pldroid-media-streaming-3.1.2.jar
* 功能
* 新增硬编场景码率控制模式的设置
* 优化
* 优化自适应码率的调整逻辑
* 缺陷
* 修复个别场景下的空指针异常
* 修复录屏场景下偶现的音画不同步问题
* 3.1.1 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-3.1.1.md))
* 版本
* 发布 pldroid-media-streaming-3.1.1.jar
* 功能
* 新增直播中对动态切换蓝牙耳机的支持
* 缺陷
* 修复外部导入数据直播时间戳异常的问题
* 修复个别场景下贴纸异常的问题
* 修复个别场景下屏幕旋转导致的预览异常问题
* 修复外部导入直播修改配置失效的问题
* 修复个别场景的崩溃问题
* 3.1.0 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-3.1.0.md))
* 版本
* 发布 pldroid-media-streaming-3.1.0.jar
* 发布 libpldroid_streaming_srt.so
* 发布 libssl.so
* 发布 libcrypto.so
* 更新 libpldroid_streaming_core.so
* 更新 libpldroid_mmprocessing.so
* 更新 libpldroid_streaming_aac_encoder.so
* 更新 libpldroid_streaming_amix.so
* 更新 libpldroid_streaming_h264_encoder.so
* 功能
* 新增 SRT 传输协议支持
* 新增日志上传功能
* 缺陷
* 修复 Runtime 相关安全漏洞问题
* 修复图片推流场景下的内存泄漏问题
* 修复个别场景下的空指针问题
* 修复自定义水印导致的崩溃问题
* 修复个别场景下的编码器异常问题
* 修复频繁添加贴纸场景下的 ANR 问题
* 3.0.2 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-3.0.2.md))
* 版本
* 发布 pldroid-media-streaming-3.0.2.jar
* 更新 libpldroid_streaming_core.so
* 功能
* 新增摄像头抢占回调
* 新增编码器异常状态回调
* 优化
* 优化录屏场景下可能出现的帧率较低的问题
* 缺陷
* 修复音视频和纯音频模式动态切换失败的问题
* 修复个别机型推流画面变形的问题
* 修复添加贴纸预览和播放效果不一致的问题
* 修复软编场景实时刷新水印存在的闪烁问题
* 修复特殊场景下偶现的 ANR 问题
* 修复特殊场景下的崩溃问题
* 3.0.1 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-3.0.1.md))
* 版本
* 发布 pldroid-media-streaming-3.0.1.jar
* 更新 libpldroid_streaming_core.so
* 功能
* 新增日志保存功能
* 优化
* 优化 demo 结构
* 优化 SEI 发送功能，支持自定义大小的数据发送
* 缺陷
* 修复个别机型初始化前置摄像头失败的问题
* 修复个别机型录屏推流异常的问题
* 修复 targetSdkVersion 29 以后录屏崩溃的问题
* 3.0.0 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-3.0.0.md))
* 版本
* 发布 pldroid-media-streaming-3.0.0.jar
* 更新 libpldroid_streaming_core.so
* 功能
* 新增包名鉴权功能
* 新增外部数据导入发送 SEI 的功能
* 缺陷
* 修复个别场景下推流花屏的问题
* 修复硬编场景下个别机型图片推流卡住的问题
* 修复单声道下返听失败的问题
* 修复双声道下回放时长变长的问题
* 修复双声道下混音偶现的崩溃问题
* 修复水印导致三方美颜异常的问题
* 2.4.1 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-2.4.1.md))
* 版本
* 发布 pldroid-media-streaming-2.4.1.jar
* 更新 libpldroid_streaming_amix.so
* 更新 libpldroid_streaming_core.so
* 功能
* 新增发送 SEI 功能
* 新增设置 bitmap 水印功能
* 缺陷
* 修复截图场景下的空指针问题
* 修复软编推流水印颜色异常的问题
* 修复非循环混音场景下的崩溃问题
* 2.4.0 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-2.4.0.md))
* 版本
* 发布 pldroid-media-streaming-2.4.0.jar
* 功能
* 新增设置水印自定义像素大小功能，不仅限于固定枚举值
* 新增 Surface 硬编下，推流前的纹理回调功能
* 2.3.0 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-2.3.0.md))
* 版本
* 发布 pldroid-media-streaming-2.3.0.jar
* 新增 libpldroid_streaming_puic.so
* 更新 libpldroid_mmprocessing.so
* 更新 libpldroid_streaming_core.so
* 功能
* 新增录制时动态水印功能
* 新增 QUIC 推流功能
* 缺陷
* 修复金立 M7 黑屏问题
* 修复纯音频推流 pause 后无法 resume 问题
* 修复弱网下 pause 小概率 ANR 问题
* 注意事项
* 从 v2.3.0 版本开始，增加 libpldroid_streaming_puic.so 库
* libpldroid_streaming_core.so 依赖于 libpldroid_streaming_puic.so，无论是否启用 QUIC 推流，都需要包含 libpldroid_streaming_puic.so 库
* 2.2.6 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-2.2.6.md))
* 版本
* 发布 pldroid-media-streaming-2.2.6.jar
* 功能
* 新增 H.264 Profile 设置接口
* 缺陷
* 修复部分机型推流画面拉伸问题
* 2.2.5 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-2.2.5.md))
* 版本
* 发布 pldroid-media-streaming-2.2.5.jar
* 更新 libpldroid_mmprocessing.so
* 功能
* 新增 YUV resize 算法配置接口
* 新增 Camera 预览帧率设置回调接口
* 2.2.4 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-2.2.4.md))
* 版本
* 发布 pldroid-media-streaming-2.2.4.jar
* 缺陷
* 修复使用外部第三方美颜时，预览与推流画面旋转了 90 度的问题
* demo 层面添加重连的代码示例
* 2.2.3 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-2.2.3.md))
* 版本
* 发布 pldroid-media-streaming-2.2.3.jar
* 缺陷
* 修复未配置码率上下限导致动态码率失控的问题
* 2.2.2 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-2.2.2.md))
* 版本
* 发布 pldroid-media-streaming-2.2.2.jar
* 更新 libpldroid_streaming_amix.so
* 更新 libpldroid_streaming_core.so
* 更新 libpldroid_mmprocessing.so
* 功能
* 录屏推流中增加推图片接口
ScreenStreamingManager 类中增加:
/**
* toggle publishing the picture set in StreamingProfile
*/
public boolean togglePictureStreaming()
* 缺陷
* 修复超过 4.5 小时连续推流断开连接问题
* 修复硬编 yuv 模式在某些机型颜色不正问题
* 修复特定音频文件导致混音失败问题
* 修复后台录屏推流在某些机型声音异常问题
* 修复软编 1080p 推流在某些机型崩溃问题
* 2.2.1 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-2.2.1.md))
* 版本
* 发布 pldroid-media-streaming-2.2.1.jar
* 发布 libpldroid_streaming_amix.so
* 更新 libpldroid_streaming_h264_encoder.so
* 更新 libpldroid_mmprocessing.so
* 功能
* 新增混音功能
* 新增返听功能
* 新增图片推流过程中动态切换图片功能
* 新增推流画面自定义剪裁
* 缺陷
* 修复切换摄像头偶现的无法推流的问题
* 修复开启动态码率后在部分配置下出现的马赛克问题
* 移除 `CameraSourceImproved` 相关接口
* 2.2.0 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-2.2.0.md))
* 版本
* 发布 pldroid-media-streaming-2.2.0.jar
* 更新 libpldroid_streaming_core.so
* 更新 libpldroid_streaming_h264_encoder.so
* 更新 libpldroid_streaming_aac_encoder.so
* 更新 libpldroid_mmprocessing.so
* 功能
* `VideoProfile` 提供 `annexb` 和 `avcc` 格式的配置选项
* 新增后台推流功能
* 新增码率调节方式设置接口
* 新增手动调节码率接口
* 新增双声道推流的支持
* 实现新版日志系统，SDK 输出的日志过滤 TAG 为：`PLDroidMediaStreaming`
* 缺陷
* 修复因图片的透明度导致的硬编水印异常
* 修复自定义帧率配置不生效的问题
* 修复部分场景下停止推流低概率偶现的ANR异常
* 修复极端弱网或低内存下丢关键帧导致播放花屏的问题
* 修复软编推流 tbc 过大的问题
* 2.1.3 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-2.1.3.md))
* 版本
* 发布 pldroid-media-streaming-2.1.3.jar
* 更新 libpldroid_streaming_core.so
* 功能
* 新增动态码率上下限配置接口
* 新增设置录屏推流状态回调的接口
* 新增是否支持 `PreviewAppearance` 模式的检测接口
* 新增是否支持 `improved` 模式的接口
* 新增自定义动态码率相关阈值接口
* 缺陷
* 修复录屏推流过程中偶现的部分崩溃问题
* 修复推流音频采集过程中低概率的数组越界异常
* 修复部分 Android 机型摄像头预览画面太暗的问题
* 修复推流 AVCC 嵌套问题
* 修复自定义推流帧率配置不生效的问题
* 2.1.2 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-2.1.2.md))
* 版本
* 发布 pldroid-media-streaming-2.1.2.jar
* 更新 libpldroid_streaming_core.so
* 更新 libpldroid_mmprocessing.so
* 更新 libpldroid_streaming_aac_encoder.so
* 更新 libpldroid_streaming_h264_encoder.so
* 功能
* 新增动态 mirror 功能
* 动态改变本地预览镜像
/**
* change mirror of local preview
* @param mirror
* @return
*/
public boolean setPreviewMirror(boolean mirror)
* 动态改变推流镜像
/**
* change mirror of streaming
* @param mirror
* @return
*/
public boolean setEncodingMirror(boolean mirror)
* 在推流的 metadata 中添加了系统信息
* 增加录屏请求被拒绝后的回调
* `在 onStateChanged 新增 StreamingState REQUEST_SCREEN_CAPTURING_FAIL`
* 缺陷
* 修复在部分机型上预览画面太暗的问题
* 修复在部分机型上切换摄像头画面异常和闪屏问题
* 修复在部分机型上推流视频帧率为 0 的问题
* 修复部分外部美颜 OpenGL 报错的问题
* 修复硬编带来的各种稳定性问题
* 修复弱网优化效果不明显的问题
* 修复部分场景下停止推流产生的 crash 问题
* 修复 onPreviewSizeSelected 不回调问题
* 修复部分机型获取 Camera 预览帧率可能崩溃的问题
* 2.1.1 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-2.1.1.md))
* 缺陷
* 修复弱网情况下概率性 crash 问题
* 修复硬编模式开启 Improved 模式，导致播放端画面异常的问题
* 修复部分机型概率性导致水印显示异常
* 版本
* 发布 pldroid-media-streaming-2.1.1.jar
* 2.1.0 ([Release Notes __](https://github.com/pili-engineering/PLDroidMediaStreaming/blob/master/ReleaseNotes/release-notes-2.1.0-beta.md))
* 功能
* 新增外部数据源支持
* 新增 `StreamingManager`
class com.qiniu.pili.droid.streaming.StreamingManager {
public StreamingManager(android.content.Context);
public StreamingManager(android.content.Context, AVCodecType);
boolean prepare(StreamingProfile);
boolean resume();
void pause();
void destroy();
boolean startStreaming();
boolean stopStreaming();
void setNativeLoggingEnabled(boolean);
void setStreamingStateListener(StreamingStateChangedListener);
void setStreamingSessionListener(StreamingSessionListener);
void setStreamStatusCallback(StreamStatusCallback);
void setStreamingProfile(StreamingProfile);
Surface getInputSurface(int width, int height);
void frameAvailable(boolean endOfStream);
void inputAudioFrame(ByteBuffer buffer, int size, long tsInNanoTime, boolean isEof);
void inputAudioFrame(byte[] buffer, long tsInNanoTime, boolean isEof);
void inputVideoFrame(ByteBuffer buffer, int size, int width, int height, int rotation, boolean mirror, int fmt, long tsInNanoTime);
void inputVideoFrame(byte[] buffer, int width, int height, int rotation, boolean mirror, int fmt, long tsInNanoTime);
void updateEncodingType(AVCodecType);
}
* 新增录屏支持
* 新增 `ScreenStreamingManager`
class com.qiniu.pili.droid.streaming.ScreenStreamingManager {
public ScreenStreamingManager(android.app.Activity);
boolean prepare(ScreenSetting screenSetting, MicrophoneStreamingSetting microphoneSetting, StreamingProfile profile);
boolean startStreaming();
boolean stopStreaming();
void setStreamingStateListener(StreamingStateChangedListener);
void mute(boolean enable);
void destroy();
}
* 新增 `ScreenSetting`
class com.qiniu.pili.droid.streaming.ScreenSetting {
ScreenSetting setSize(int width, int height);
ScreenSetting setDpi(int dpi);
int getWidth();
int getHeight();
int getDpi();
}
* 注意事项：需要在 AndroidManifest.xml 增加 SDK 内置 Activity `com.qiniu.pili.droid.streaming.screen.ScreenCaptureRequestActivity` 的声明
<activity
android:name="com.qiniu.pili.droid.streaming.screen.ScreenCaptureRequestActivity"
android:theme="@android:style/Theme.Translucent.NoTitleBar" >
</activity>
* 新增 `StreamingPreviewCallback` 接口回调参数
/**
* Called if the {@link StreamingPreviewCallback} registered.
*
* @param data the contents of the preview frame in fmt format
* @param width the width of the frame
* @param height the height of the frame
* @param rotation set the clockwise rotation of frame in degrees to achieve the same effect of preview display.
* @param fmt the format of the frame. See also {@link com.qiniu.pili.droid.streaming.av.common.PLFourCC}
* @param tsInNanoTime the timestamp of the frame
*
* */
boolean StreamingPreviewCallback#onPreviewFrame(byte[] data, int width, int height, int rotation, int fmt, long tsInNanoTime);
* 优化
* 新增 Camera 数据源优化及配置
* `CameraStreamingSetting#setCameraSourceImproved(boolean)`
* 新增 Camera 预览尺寸优化
* `CameraStreamingSetting#setPreviewSizeOptimize(boolean)`
* 支持自适应码率
* `StreamingProfile#setAdaptiveBitrateEnable(boolean)`
* Min Bitrate 为 `StreamingProfile#VIDEO_QUALITY_LOW1`, Max Bitrate 为用户设置的目标码率
* 缺陷
* 修复部分水印资源显示异常问题
* 修复特殊低端机型对焦导致的 crash 问题
* 修复部分机型硬编导致的 crash 问题
* 修复特殊情况下部分机型，onDrawFrame 未运行在渲染线程导致的 crash 问题
* 修复特殊机型 INTERNET 权限已声明但不生效导致的 crash 问题
* 修复其他概率性 crash 问题
* 版本
* 发布 pldroid-media-streaming-2.1.0.jar
* 更新 libpldroid_mmprocessing.so
* 更新 libpldroid_streaming_h264_encoder.so
* Demo
* 新增避免 Android 6.0(+) 设备权限导致 crash 问题的 patch
* 新增录屏功能的 Demo 展示
* `ScreenRecorderActivity`
* 新增外部数据源功能的 Demo 展示
* `ExtCapStreamingActivity`
* 更新 Demo
* 2.0.4 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-2.0.4.md))
* 缺陷
* 修复概率性 crash 问题
* 版本
* 发布 pldroid-media-streaming-2.0.4.jar
* 2.0.3 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-2.0.3.md))
* 缺陷
* 修复 home 键退出之后，再次启动应用，导致 onPreviewFrame 回调不生效问题
* 修复硬编模式下，home 键退出导致的 crash 问题
* 修复关闭音频权限之后，开始直播并未正常返回 AUDIO_RECORDING_FAIL 问题
* 修复硬编模式下，部分机型 EglCore 导致的空指针异常
* 版本
* 发布 pldroid-media-streaming-2.0.3.jar
* 2.0.2 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-2.0.2.md))
* 功能
* 修复特殊机型黑屏问题
* 版本
* 发布 pldroid-media-streaming-2.0.2.jar
* 更新 libpldroid_streaming_h264_encoder.so
* 2.0.1 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-2.0.1.md))
* 功能
* 新增硬编模式下 YUV 数据回调支持
* 缺陷
* 兼容更多的硬编机型
* 修复硬编特殊机型音画不同步问题
* 修复特殊机型上的 crash 问题
* 修复重连可能导致的 crash 问题
* 版本
* 发布 pldroid-media-streaming-2.0.1.jar
* 依赖 compile ‘com.qiniu.pili:pili-android-qos:0.8.+’
* 更新 libpldroid_streaming_core.so
* 更新 libpldroid_streaming_h264_encoder.so
* 更新 demo 代码
* 2.0.0-Beta ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-2.0.0-beta.md))
* 功能
* 新增可直接设置由七牛直播云生成的推流地址的 API
* 新增推流节点调度机制
* 新增 MediaStreamingManager 类，并废弃 CameraStreamingManager
* 新增一些辅助类并废弃相关的类
* 新增 Audio PCM 数据回调接口
* 新增检测是否支持指定的 Camera
* 缺陷
* 修复软编模式下， Android 6.0 target 设置为 23 无法正常推流的问题
* 修复硬编模式下，快速 home 键导致异常退出的问题
* 修复特殊机型初始化时导致的 crash
* 优化
* 优化水印清晰度
* 版本
* SDK 更名为 PLDroidMediaStreaming
* SDK 包名更改为 com.qiniu.pili.droid.streaming.*
* SDK Demo 重命名为 PLDroidMediaStreamingDemo
* 发布 pldroid-media-streaming-2.0.0.jar
* 更新 libpldroid_mmprocessing.so
* 更新 libpldroid_streaming_core.so
* 更新 libpldroid_streaming_h264_encoder.so
* 1.7.1 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.7.1.md))
* 功能
* 新增自定义水印位置支持
* 新增前置闪光灯支持（需硬件支持，如美图 M4）
* 新增第三个 Camera 的支持（比如 LG G5）
* 新增 Camera 本地预览镜像反转支持
* 缺陷
* 修复软编模式下 iOS 播放器硬解失败的问题
* 修复透明水印有黑色背景问题
* 修复特殊手机（奇酷）音画不同步
* 修复内置美颜模式下，部分机型黑屏现象
* 修复软编模式下，水印在播放端可能被压缩的问题
* 修复特殊机型（美图 M4）静音模式下出现杂音的问题
* 修复特殊机型特殊场景下，音频采集初始化失败导致的 crash 问题
* 修复 demo issue
* 版本
* 发布 pldroid-camera-streaming-1.7.1.jar
* 更新 libpldroid_mmprocessing.so
* 更新 libpldroid_streaming_core.so
* 更新 libpldroid_streaming_aac_encoder.so
* 更新 libpldroid_streaming_h264_encoder.so
* 更新 Demo
* 1.7.0 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.7.0.md))
* 功能
* 新增内置美颜功能，美颜效果可调节
* 新增采集帧率控制，避免帧率飙升不可控
* 缺陷
* 修复特殊步骤下 Contex 泄露问题
* 修复硬编水印在特殊机型上（Meilan note 2）异常显示
* 优化
* 优化采集，避免过度 UI 操作导致推流帧率降低
* 优化内存使用
* 版本
* 发布 pldroid-camera-streaming-1.7.0.jar
* 更新 libpldroid_mmprocessing.so
* 更新 libpldroid_streaming_core.so
* 更新 libpldroid_streaming_h264_encoder.so
* 更新 Demo
* 1.6.2 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.6.2.md))
* 发布 pldroid-camera-streaming-1.6.2.jar
* 修复特殊情况下导致的 crash 问题
* 更新 Demo 代码
* 1.6.1 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.6.1.md))
* 发布 pldroid-camera-streaming-1.6.1.jar
* 新增 libpldroid_mmprocessing.so
* 更新 libpldroid_streaming_core.so 和 libpldroid_streaming_h264_encoder.so
* 增加水印支持
* 优化软编 codec，提升画质和码控能力
* 兼容特殊的直播设备
* 新增 TransformMatrix 到 SurfaceTextureCallback#onDrawFrame
* 修复 `CameraStreamingManager#pause` 耗时较长
* 修复硬编纯音频无法正常停止推流
* 修复硬编推流过程中特殊步骤导致的概率性 crash
* 更新 Demo 代码
* 1.6.0 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.6.0.md))
* 发布 pldroid-camera-streaming-1.6.0.jar
* 更新 libpldroid_streaming_core.so 和 libpldroid_streaming_h264_encoder.so
* 新增 mirror 支持
* 新增 `StreamingEnv`
* 修复特殊机型硬编闪屏问题
* 修复禁播导致的 crash 问题
* 改善部分机型硬编 tearing 现象
* 兼容异常输入的情况，并提供回调
* 新增质量上报支持
* 修复资源泄漏问题
* 修复特殊机型 crash 问题
* 重构 Demo 代码
* 1.5.3 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.5.3.md))
* 发布 pldroid-camera-streaming-1.5.3.jar
* 修复特殊机型概率性 crash 问题
* 优化 Jar 包体积
* 1.5.1 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.5.1.md))
* 发布 pldroid-camera-streaming-1.5.1.jar
* 更新 libpldroid_streaming_core.so 和 libpldroid_streaming_h264_encoder.so
* 新增蓝牙麦克风支持
* 新增质量上报支持
* 优化启用／关闭输入法弹框导致的屏闪现象
* 修复部分机型手动对焦引起的 crash 问题
* 修复部分机型推流过程中概率性 crash 问题
* 修复部分机型频繁切换输入法导致黑屏问题
* 修复特殊机型硬编音画不同步问题
* 更新 demo 样例代码
* 1.5.0 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.5.0.md))
* 发布 pldroid-camera-streaming-1.5.0.jar
* 更新 libpldroid_streaming_core.so 和 libpldroid_streaming_h264_encoder.so
* 支持手动对焦
* 支持 Zoom
* 支持 mute/unmute
* 新增 `setSendTimeoutInSecond` API
* 对回调方法 `sortCameraPrvSize` 的行参 supportedPreviewSizeList 进行从小到大排序
* 当 DnsManager 设置为 null 后，不进行 Dns 解析，[Issue 78 __](https://github.com/pili-engineering/PLDroidCameraStreaming/issues/78)
* 优化数据源采集和显示效率，避免 UI 卡顿
* 修复硬编模式下，重连导致概率性 crash 问题
* 方法 onPrepare(), onResume(), onPause(), onDestroy() 分别重命名为 prepare(), resume(), pause(), destroy()
* 更新 demo 样例代码
* 1.4.6 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.4.6.md))
* 发布 pldroid-camera-streaming-1.4.6.jar
* 更新 libpldroid_streaming_core.so，libpldroid_streaming_aac_encoder.so 和 libpldroid_streaming_h264_encoder.so
* 提升软编编码帧率
* 优化推流过程中前后置摄像头切换体验
* 新增 happydns 支持，并提供 `setDnsManager` API，用户可自定义 `DnsManager`
* 新增 `StreamStatus` 回调，实现 `StreamStatusCallback` 获取音视频帧率和码率
* 新增 `setRecordingHint` API，可实现高帧率推流
* 修复推流过程中，特殊操作后，推流无图像问题
* 修复推流过程中，HOME 键退出，再次启动 app，无法切换 camera 问题
* 修复部分机型音画不同步，包括切换前后置
* 修复推流过程中，概率性 crash 问题
* 更新 demo 样例代码
* 1.4.5 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.4.5.md))
* 发布 pldroid-camera-streaming-1.4.5.jar
* 更新 libpldroid_streaming_core.so，libpldroid_streaming_aac_encoder.so 和 libpldroid_streaming_h264_encoder.so
* 新增动态更改 Encoding Orientation 支持
* 新增动态切换横竖屏支持
* 新增 `onPreviewSizeSelected` 支持
* 新增 `setPreferredVideoEncodingSize` 支持
* 新增 `VIDEO_ENCODING_HEIGHT_544` 支持
* 优化网络传输
* 提升画质
* 优化前后置切换
* 标记 `VIDEO_ENCODING_SIZE_QVGA` 等 Deprecated
* 标记 `onPreviewFrame(byte[] datas, Camera camera)` Deprecated
* 修复部分机型概率性 ANR
* 更新 demo 样例代码
* 1.4.3 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.4.3.md))
* 发布 pldroid-camera-streaming-1.4.3.jar
* 更新 libpldroid_streaming_core.so，libpldroid_streaming_aac_encoder.so 和 libpldroid_streaming_h264_encoder.so
* 新增 `SharedLibraryidHelper` 绝对路径加载方式
* 新增 `StreamingSessionListener`，可方便安全地实现重连策略及 Audio 数据获取失败时的策略
* 新增 `EncodingType` 支持
* 修复硬编模式下，多次切换前后置摄像头 crash 问题
* 修复硬编模式下，部分机型截图 crash 问题
* 修复 metadata 格式问题
* 修复软编模式下，推流过程中概率性 crash 问题
* 修复概率性无视频帧问题
* 更新 demo 展示代码
* 增加支持的机型信息
* 1.4.1 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.4.1.md))
* 发布 pldroid-camera-streaming-1.4.1.jar
* 更新 libpldroid_streaming_core.so
* 新增 libpldroid_streaming_aac_encoder.so 和 libpldroid_streaming_h264_encoder.so
* 新增 H.264 和 AAC 软编支持
* 新增软编数据源回调接口，可定制化 Filter (滤镜) 特效处理
* 修复硬编部分机型 crash 问题
* 修复硬编切换前后置时长异常问题
* 更新 demo 样例代码
* 1.3.9 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.3.9.md))
* 发布 pldroid-camera-streaming-1.3.9.jar
* 更新 libpldroid_streaming_core.so
* 增加 x86 支持
* 新增 x86/libpldroid_streaming_core.so
* 优化内存，减少内存抖动，增强稳定性
* 修复 onResume 之后快速 onPause 导致的 crash 问题
* 修复部分机型截图 crash 问题
* 修复部分机型切换前后置摄像头之后，导致切片异常问题
* 修复网络异常导致的 crash 问题(issue 54)
* 1.3.8 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.3.8.md))
* 发布 pldroid-camera-streaming-1.3.8.jar
* 更新 libpldroid_streaming_core.so
* 优化切换前后置摄像头数据重发时间，增强推流过程中切换前后置摄像头的稳定性
* 优化内存使用，避免 OOM
* 修复部分机型概率性 crash 问题
* 兼容 supportedPreviewSizeList 为空的机型
* 1.3.7 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.3.7.md))
* 发布 pldroid-camera-streaming-1.3.7.jar
* 更新 libpldroid_streaming_core.so
* 修复部分机型概率性 crash 问题
* 修复部分机型前后置 camera 切换的 crash 问题
* 兼容无前置 camera 的机型
* 1.3.6 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.3.6.md))
* 发布 pldroid-camera-streaming-1.3.6.jar
* 更新 libpldroid_streaming_core.so
* 优化 video stream 流畅度
* 修复概率性断流问题
* 修复部分机型推流过程中，概率性 crash 问题
* 修复部分机型切换前后置摄像头过程中，概率性 crash 问题
* 1.3.5 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.3.5.md))
* 发布 pldroid-camera-streaming-1.3.5.jar
* 更新 libpldroid_streaming_core.so
* 修复部分机型音视频不同步问题
* 分离 preview size 与 encoding size
* 新增 `setEncodingSizeLevel` API，并提供 encoding size 参数列表
* 修复部分机型花屏问题
* 修复前后置摄像头切换概率性断流问题
* 修复概率性 crash 问题
* 1.3.4 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.3.4.md))
* 发布 pldroid-camera-streaming-1.3.4.jar
* 更新 libpldroid_streaming_core.so
* 修复采用 ART 运行时的 Android 机型的 crash 问题
* 修复封包不兼容的问题
* 1.3.3 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.3.3.md))
* 发布 pldroid-camera-streaming-1.3.3.jar
* 删除 arm64-v8a/libpldroid_ffmpegbridge.so 以及 armeabi-v7a/libpldroid_ffmpegbridge.so
* 新增 armeabi 支持
* 新增 arm64-v8a/libpldroid_streaming_core.so, armeabi-v7a/libpldroid_streaming_core.so 和 armeabi/libpldroid_streaming_core.so
* 体积裁剪数十倍，动态链接库裁剪至 69KB
* 完全移除 FFmpeg 依赖
* 修复推流过程中，切换前后置断流问题
* 修复自适应码率过程中，切换 quality 断流问题
* 修复前后置切换概率性 crash 问题
* 1.3.2 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.3.2.md))
* 发布 pldroid-camera-streaming-1.3.2.jar
* 修复输入法弹起导致预览画面调整的问题
* 1.3.1 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.3.1.md))
* 发布 pldroid-camera-streaming-1.3.1.jar
* 增加 arm64-v8a 支持，新增 arm64-v8a/libpldroid_ffmpegbridge.so
* 更新 armeabi-v7a/libpldroid_ffmpegbridge.so
* 新增切换 `Stream` 接口：setStreamingProfile
* 新增 `setLocalFileAbsolutePath` 接口
* 修复横屏下，经过特殊操作，Camera 预览显示异常的问题
* 1.3.0 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.3.0.md))
* 发布 pldroid-camera-streaming-1.3.0.jar
* 新增自适应码率功能
* 新增截帧接口
* 新增 Preview Layout `REAL/FULL` mode，解决显示黑边问题
* 修复 IOS 和 Android 使用同一个 stream 时，导致 IOS 无法正常推流的问题
* 修复部分机型切换前后置 crash 问题
* 新增自适应码率演示代码
* 新增截帧演示代码
* 新增 REAL/FULL mode 演示代码
* 1.2.3 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.2.3.md))
* 发布 pldroid-camera-streaming-1.2.3.jar
* 新增 Audio quality 和 Video quality 配置项，可自由组合音视频码率参数
* 新增 Video quality 设置接口 `setVideoQuality`
* 新增 Audio quality 设置接口 `setAudioQuality`
* 优化 jar 包，减少约 30% 体积
* 1.2.2 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.2.2.md))
* 发布 pldroid-camera-streaming-1.2.2.jar
* 更新 libpldroid_ffmpegbridge.so
* 修复概率性的 crash 问题
* 添加 `STATE.CONNECTION_TIMEOUT` 状态
* 修复部分机型因连接错误而导致屏幕 Hang 住
* 在 UI 层对点击事件加入保护逻辑，避免快速点击导致应用 crash
* 1.2.1 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.2.1.md))
* 发布 pldroid-camera-streaming-1.2.1.jar
* 更新 libpldroid_ffmpegbridge.so
* 优化内存问题，修复 OOM 异常
* 优化 Quality 配置
* 添加 `setNativeLoggingEnabled()` 接口
* 1.2.0 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.2.0.md))
* 发布 pldroid-camera-streaming-1.2.0.jar
* 更新 libpldroid_ffmpegbridge.so
* 更新 Stream 设置接口：`setStream(stream)`
* 添加 Camera 切换接口：`switchCamera`
* 修复 Android L crash 问题
* 添加 Camera 切换状态：`STATE.CAMERA_SWITCHED`
* 添加 Torch 是否支持状态：`STATE.TORCH_INFO`
* 更新状态回调接口：`onStateChanged(state, extra)`
* 修复特殊操作的概率性 crash 问题
* 修复部分机型 `turnLightOn` 及 `turnLightOff` 接口无效问题
* 修复部分机型点击 Home 按键 crash 问题
* 修复部分机型因 `PREVIEW_SIZE_LEVEL` 导致 crash 问题
* 添加 Camera 切换操作演示代码
* 更新 Torch 组件显示逻辑
* 1.1.0 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.1.0.md))
* 发布 pldroid-camera-streaming-1.1.0.jar
* 更新 libpldroid_ffmpegbridge.so
* 优化 ffmpegbridge 模块，降低 libpldroid_ffmpegbridge.so 文件大小
* 添加纯音频推流支持：添加纯音频推流 `CameraStreamingManager(Context ctx)` 构造函数
* 纯音频推流支持后台运行
* 添加 preview size 设定接口：`setCameraPrvSizeLevel` 及 `setCameraPrvSizeRatio`
* 添加 torch 操作接口： `turnLightOn` 及 `turnLightOff`
* 添加控制连续自动对焦的接口：`setContinuousFocusModeEnabled`
* 废弃 `setCameraPreviewSize` 接口
* 修复部分机型因 preivew size 不支持而导致的 crash 问题
* 添加 `AudioStreamingActivity` 及 `StreamingBaseActivity`，用来演示纯音频推流
* 添加 torch 操作演示代码
* 1.0.2 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.0.2.md))
* 发布 pldroid-camera-streaming-1.0.2.jar
* 修复无 `StreamingStateListener` 情况下的 Crash 问题
* 修复正常启动后无 READY 消息返回问题
* 更新 `Stream` 定义，并与服务端保持一致
* 增加相机正常启动后即开始推流功能
* 1.0.1 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.0.1.md))
* 发布 pldroid-camera-streaming-1.0.1.jar
* 更新 `Stream` 类结构
* 更新 `Stream` 的构造方式
* 1.0.0 ([Release Notes __](https://github.com/pili-engineering/PLDroidCameraStreaming/blob/master/ReleaseNotes/release-notes-1.0.0.md))
* 发布 PLDroidCameraStreaming v1.0.0
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,252 |
概述 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 推流端 >iOS 推流端 SDK >概述
# 概述
最近更新时间: 2024-05-31 16:58:46
# 1 概述
PLMediaStreamingKit 是一个适用于 iOS 的 RTMP 直播推流 SDK，可高度定制化和二次开发。SDK 提供 RTMP
推流的全套解决方案，包括采集，处理（美颜，水印等），编码，封包，发送。特色是支持 H.264 硬编码，以及支持 AAC-LC
硬编码；同时，还根据移动网络环境的多变性，实现了一套可供开发者灵活选择的编码参数集合。
## 1.1 SDK 下载地址
[PLMediaStreamingKit __](https://github.com/pili-
engineering/PLMediaStreamingKit)
## 1.2 功能以及版本
功能 | 描述 | 版本
---|---|---
支持硬件编码 | 更低的 CPU 占用及发热量 | v1.0.0(+)
支持 ARM7, ARM64 指令集 | 为最新设备优化 | v1.0.0(+)
提供音视频配置分离 | 配置解耦 | v1.0.0(+)
支持推流时码率变更 | 更方便定制流畅度/清晰度策略 | v1.0.0(+)
支持弱网丢帧策略 | 不必担心累计延时，保障实时性 | v1.0.0(+)
支持模拟器运行 | 不影响模拟器快速调试 | v1.0.0(+)
支持 RTMP 协议直播推流 | 保证秒级实时性 | v1.0.0(+)
支持后台音频推流 | 轻松实现边推流边聊天等操作 | v1.0.0(+)
提供多码率可选 | 更自由的配置 | v1.1.2(+)
提供 H.264 视频编码 | 多种 profile level 可设定 | v1.1.2(+)
支持多分辨率编码 | 更可控的清晰度 | v1.1.2(+)
提供 AAC 音频编码 | 当前采用 AAC-LC | v1.1.2(+)
提供 HeaderDoc 文档 | 开发中使用 Quick Help 及时阅读文档 | v1.1.3(+)
支持美颜滤镜 | 轻松实现更美真人秀 | v1.7.0(+)
支持水印功能 | 彰显自身特色 | v1.7.0(+)
提供内置音效及音频文件播放功能 | 轻松实现各种音效 | v2.1.0(+)
支持返听功能 | 唱歌更易把握节奏 | v2.1.0(+)
支持截屏功能 | 轻松分享美好瞬间 | v2.1.2(+)
支持 iOS 10 ReplayKit 录屏 | 方便分享游戏过程 | v2.1.4(+)
支持苹果 ATS 安全标准 | 安全性更高 | v2.1.6(+)
支持后台推图片功能 | 观看体验更佳 | v2.2.1(+)
支持 QUIC 推流功能 | 弱网推流更流畅 | v2.3.0(+)
支持 SEI 功能 | 推流内容更丰富 | v2.3.5(+)
支持 HEVC 编码推流 | 提升视频质量 | v3.1.0(+)
支持动态设置 fps | 更多的推流质量选择 | v3.1.1(+)
# 2 阅读对象
本文档为技术文档，需要阅读者：
* 具有基本的 iOS 开发能力
* 准备接入七牛云直播
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 推流端 >iOS 推流端 SDK >概述
# 概述
最近更新时间: 2024-05-31 16:58:46
# 1 概述
PLMediaStreamingKit 是一个适用于 iOS 的 RTMP 直播推流 SDK，可高度定制化和二次开发。SDK 提供 RTMP
推流的全套解决方案，包括采集，处理（美颜，水印等），编码，封包，发送。特色是支持 H.264 硬编码，以及支持 AAC-LC
硬编码；同时，还根据移动网络环境的多变性，实现了一套可供开发者灵活选择的编码参数集合。
## 1.1 SDK 下载地址
[PLMediaStreamingKit __](https://github.com/pili-
engineering/PLMediaStreamingKit)
## 1.2 功能以及版本
功能 | 描述 | 版本
---|---|---
支持硬件编码 | 更低的 CPU 占用及发热量 | v1.0.0(+)
支持 ARM7, ARM64 指令集 | 为最新设备优化 | v1.0.0(+)
提供音视频配置分离 | 配置解耦 | v1.0.0(+)
支持推流时码率变更 | 更方便定制流畅度/清晰度策略 | v1.0.0(+)
支持弱网丢帧策略 | 不必担心累计延时，保障实时性 | v1.0.0(+)
支持模拟器运行 | 不影响模拟器快速调试 | v1.0.0(+)
支持 RTMP 协议直播推流 | 保证秒级实时性 | v1.0.0(+)
支持后台音频推流 | 轻松实现边推流边聊天等操作 | v1.0.0(+)
提供多码率可选 | 更自由的配置 | v1.1.2(+)
提供 H.264 视频编码 | 多种 profile level 可设定 | v1.1.2(+)
支持多分辨率编码 | 更可控的清晰度 | v1.1.2(+)
提供 AAC 音频编码 | 当前采用 AAC-LC | v1.1.2(+)
提供 HeaderDoc 文档 | 开发中使用 Quick Help 及时阅读文档 | v1.1.3(+)
支持美颜滤镜 | 轻松实现更美真人秀 | v1.7.0(+)
支持水印功能 | 彰显自身特色 | v1.7.0(+)
提供内置音效及音频文件播放功能 | 轻松实现各种音效 | v2.1.0(+)
支持返听功能 | 唱歌更易把握节奏 | v2.1.0(+)
支持截屏功能 | 轻松分享美好瞬间 | v2.1.2(+)
支持 iOS 10 ReplayKit 录屏 | 方便分享游戏过程 | v2.1.4(+)
支持苹果 ATS 安全标准 | 安全性更高 | v2.1.6(+)
支持后台推图片功能 | 观看体验更佳 | v2.2.1(+)
支持 QUIC 推流功能 | 弱网推流更流畅 | v2.3.0(+)
支持 SEI 功能 | 推流内容更丰富 | v2.3.5(+)
支持 HEVC 编码推流 | 提升视频质量 | v3.1.0(+)
支持动态设置 fps | 更多的推流质量选择 | v3.1.1(+)
# 2 阅读对象
本文档为技术文档，需要阅读者：
* 具有基本的 iOS 开发能力
* 准备接入七牛云直播
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,297 |
开发准备 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 推流端 >iOS 推流端 SDK >开发准备
# 开发准备
最近更新时间: 2023-08-17 14:14:50
# 1 设备以及系统
* 设备要求：iPhone 5 及以上
* 系统要求：iOS 8 及以上
# 2 前置条件
* 已注册七牛账号
* 通过 [email protected] 申请并已开通直播权限
## 3.3 版本升级
* **从 v3.0.7 开始，HappyDNS 版本更新至 v1.0.0**
* **从 v3.0.0 版本开始，七牛直播推流 SDK 需要先获取授权才能使用。授权分为试用版和正式版，可通过 400-808-9176 转 2 号线联系七牛商务咨询，或者[通过工单 __](https://support.qiniu.com/?ref=developer.qiniu.com)联系七牛的技术支持。**
* **v3.0.0 之前的版本不受影响，请继续放心使用。**
* **老客户升级 v3.0.0 版本之前，请先联系七牛获取相应授权，以免发生鉴权不通过的现象。**
* **基于 114 dns 解析的不确定性，使用该解析可能会导致解析的网络 ip 无法做到最大的优化策略，进而出现推流质量不佳的现象。因此建议使用非 114 dns 解析**
* **目前还不支持使用 srt 协议 HEVC 编码推流**
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 推流端 >iOS 推流端 SDK >开发准备
# 开发准备
最近更新时间: 2023-08-17 14:14:50
# 1 设备以及系统
* 设备要求：iPhone 5 及以上
* 系统要求：iOS 8 及以上
# 2 前置条件
* 已注册七牛账号
* 通过 [email protected] 申请并已开通直播权限
## 3.3 版本升级
* **从 v3.0.7 开始，HappyDNS 版本更新至 v1.0.0**
* **从 v3.0.0 版本开始，七牛直播推流 SDK 需要先获取授权才能使用。授权分为试用版和正式版，可通过 400-808-9176 转 2 号线联系七牛商务咨询，或者[通过工单 __](https://support.qiniu.com/?ref=developer.qiniu.com)联系七牛的技术支持。**
* **v3.0.0 之前的版本不受影响，请继续放心使用。**
* **老客户升级 v3.0.0 版本之前，请先联系七牛获取相应授权，以免发生鉴权不通过的现象。**
* **基于 114 dns 解析的不确定性，使用该解析可能会导致解析的网络 ip 无法做到最大的优化策略，进而出现推流质量不佳的现象。因此建议使用非 114 dns 解析**
* **目前还不支持使用 srt 协议 HEVC 编码推流**
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,301 |
快速开始 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 推流端 >iOS 推流端 SDK >快速开始
# 快速开始
最近更新时间: 2018-01-18 13:08:15
# 1 开发环境配置
* Xcode 开发工具。App Store [下载地址](https://itunes.apple.com/us/app/xcode/id497799835?ls=1&mt=12)
* 安装 CocoaPods。了解 CocoaPods 使用方法。[官方网站](https://cocoapods.org)
# 2 导入 SDK
## 2.1 使用 CocoaPods 导入
推荐使用 CocoaPods 的方式导入，步骤如下：
* 在工作目录中创建名称为 Podfile 的文件
* 在 Podfile 中添加如下一行
pod 'PLMediaStreamingKit'
* 在终端中运行
$ pod install
到此，你已完成了 PLMediaStreamingKit 的添加。
此外，如果你希望将 PLMediaStreamingKit 从旧版本升级到新版本，可以在终端中运行
$ pod update
## 2.2 手动导入
我们建议使用 CocoaPods 导入，如果由于特殊原因需要手动导入，可以按照如下步骤进行：
* 将 Pod/Library 目录下的 PLMediaStreamingKit.framework 和 HappyDNS.framework 加入到工程中；
* 在对应的 Target 的 Embedded Binaries 设置中加入 PLMediaStreamingKit.framework 和 HappyDNS.framework；
* 在工程对应 TARGET 中，右侧 Tab 选择 "Build Phases"，在 "Link Binary With Libraries" 中加入 UIKit、AVFoundation、CoreGraphics、CFNetwork、CoreMedia、AudioToolbox 这些 framework，并加入 libc++.tdb、libz.tdb 及 libresolv.tbd；
* 在工程对应 TARGET 中，右侧 Tab 选择 "Build Settings"，在 "Other Linker Flags" 中加入 "-ObjC" 选项；
# 3 初始化推流逻辑
## 3.1 添加引用并初始化 SDK 使用环境
在 `AppDelegate.m` 中添加引用
#import <PLMediaStreamingKit/PLMediaStreamingKit.h>
并在 `- (BOOL)application:(UIApplication *)application
didFinishLaunchingWithOptions:(NSDictionary *)launchOptions` 中添加如下代码:
[PLStreamingEnv initEnv];
然后在 `ViewController.m` 中添加引用
#import <PLMediaStreamingKit/PLMediaStreamingKit.h>
## 3.2 添加 session 属性
添加 session 属性在 `ViewController.m`
@property (nonatomic, strong) PLMediaStreamingSession *session;
# 4 创建流对象
## 4.1 创建视频和音频的采集和编码配置对象
当前使用默认配置，之后可以深入研究按照自己的需求作更改
PLVideoCaptureConfiguration *videoCaptureConfiguration = [PLVideoCaptureConfiguration defaultConfiguration];
PLAudioCaptureConfiguration *audioCaptureConfiguration = [PLAudioCaptureConfiguration defaultConfiguration];
PLVideoStreamingConfiguration *videoStreamingConfiguration = [PLVideoStreamingConfiguration defaultConfiguration];
PLAudioStreamingConfiguration *audioStreamingConfiguration = [PLAudioStreamingConfiguration defaultConfiguration];
## 4.2 创建推流 session 对象
self.session = [[PLMediaStreamingSession alloc] initWithVideoCaptureConfiguration:videoCaptureConfiguration audioCaptureConfiguration:audioCaptureConfiguration videoStreamingConfiguration:videoStreamingConfiguration audioStreamingConfiguration:audioStreamingConfiguration stream:nil];
# 5 预览摄像头拍摄效果
将预览视图添加为当前视图的子视图
[self.view addSubview:self.session.previewView];
# 6 添加推流操作
取一个最简单的场景，就是点击一个按钮，然后触发发起直播的操作。
## 6.1 添加触发按钮
我们在 `view` 上添加一个按钮吧。 我们在 `- (void)viewDidLoad` 方法最后添加如下代码
UIButton *button = [UIButton buttonWithType:UIButtonTypeSystem];
[button setTitle:@"start" forState:UIControlStateNormal];
button.frame = CGRectMake(0, 0, 100, 44);
button.center = CGPointMake(CGRectGetMidX([UIScreen mainScreen].bounds), CGRectGetHeight([UIScreen mainScreen].bounds) - 80);
[button addTarget:self action:@selector(actionButtonPressed:) forControlEvents:UIControlEventTouchUpInside];
[self.view addSubview:button];
## 6.2 创建推流地址
在实际开发过程中，为了您的 App 有更好的用户体验，建议提前从服务器端获取推流地址
NSURL *pushURL = [NSURL URLWithString:@"your push url"];
## 6.3 实现按钮动作
- (void)actionButtonPressed:(id)sender {
[self.session startStreamingWithPushURL:pushURL feedback:^(PLStreamStartStateFeedback feedback) {
if (feedback == PLStreamStartStateSuccess) {
NSLog(@"Streaming started.");
}
else {
NSLog(@"Oops.");
}
}];
}
## 6.4 完成首次推流操作
Done，没有额外的代码了，现在可以开始一次推流了。 如果运行后，点击按钮提示 `Oops.`，就要检查一下你之前创建 `PLStream` 对象时填写的
`StreamJson` 是否有漏填或者填错的内容。
# 7 查看推流内容
## 7.1 登录 pili.qiniu.com 查看内容
* 登录 [pili.qiniu.com](https://pili.qiniu.com)
* 登录 `streamJson` 中使用的 hub
* 查看 `stream` 属性
* 点击属性中的播放 URL 后的箭头，即可查看内容。
# 8 DEMO下载
* [点击下载](https://github.com/pili-engineering/PLMediaStreamingKit/tree/master/Example)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 推流端 >iOS 推流端 SDK >快速开始
# 快速开始
最近更新时间: 2018-01-18 13:08:15
# 1 开发环境配置
* Xcode 开发工具。App Store [下载地址](https://itunes.apple.com/us/app/xcode/id497799835?ls=1&mt=12)
* 安装 CocoaPods。了解 CocoaPods 使用方法。[官方网站](https://cocoapods.org)
# 2 导入 SDK
## 2.1 使用 CocoaPods 导入
推荐使用 CocoaPods 的方式导入，步骤如下：
* 在工作目录中创建名称为 Podfile 的文件
* 在 Podfile 中添加如下一行
pod 'PLMediaStreamingKit'
* 在终端中运行
$ pod install
到此，你已完成了 PLMediaStreamingKit 的添加。
此外，如果你希望将 PLMediaStreamingKit 从旧版本升级到新版本，可以在终端中运行
$ pod update
## 2.2 手动导入
我们建议使用 CocoaPods 导入，如果由于特殊原因需要手动导入，可以按照如下步骤进行：
* 将 Pod/Library 目录下的 PLMediaStreamingKit.framework 和 HappyDNS.framework 加入到工程中；
* 在对应的 Target 的 Embedded Binaries 设置中加入 PLMediaStreamingKit.framework 和 HappyDNS.framework；
* 在工程对应 TARGET 中，右侧 Tab 选择 "Build Phases"，在 "Link Binary With Libraries" 中加入 UIKit、AVFoundation、CoreGraphics、CFNetwork、CoreMedia、AudioToolbox 这些 framework，并加入 libc++.tdb、libz.tdb 及 libresolv.tbd；
* 在工程对应 TARGET 中，右侧 Tab 选择 "Build Settings"，在 "Other Linker Flags" 中加入 "-ObjC" 选项；
# 3 初始化推流逻辑
## 3.1 添加引用并初始化 SDK 使用环境
在 `AppDelegate.m` 中添加引用
#import <PLMediaStreamingKit/PLMediaStreamingKit.h>
并在 `- (BOOL)application:(UIApplication *)application
didFinishLaunchingWithOptions:(NSDictionary *)launchOptions` 中添加如下代码:
[PLStreamingEnv initEnv];
然后在 `ViewController.m` 中添加引用
#import <PLMediaStreamingKit/PLMediaStreamingKit.h>
## 3.2 添加 session 属性
添加 session 属性在 `ViewController.m`
@property (nonatomic, strong) PLMediaStreamingSession *session;
# 4 创建流对象
## 4.1 创建视频和音频的采集和编码配置对象
当前使用默认配置，之后可以深入研究按照自己的需求作更改
PLVideoCaptureConfiguration *videoCaptureConfiguration = [PLVideoCaptureConfiguration defaultConfiguration];
PLAudioCaptureConfiguration *audioCaptureConfiguration = [PLAudioCaptureConfiguration defaultConfiguration];
PLVideoStreamingConfiguration *videoStreamingConfiguration = [PLVideoStreamingConfiguration defaultConfiguration];
PLAudioStreamingConfiguration *audioStreamingConfiguration = [PLAudioStreamingConfiguration defaultConfiguration];
## 4.2 创建推流 session 对象
self.session = [[PLMediaStreamingSession alloc] initWithVideoCaptureConfiguration:videoCaptureConfiguration audioCaptureConfiguration:audioCaptureConfiguration videoStreamingConfiguration:videoStreamingConfiguration audioStreamingConfiguration:audioStreamingConfiguration stream:nil];
# 5 预览摄像头拍摄效果
将预览视图添加为当前视图的子视图
[self.view addSubview:self.session.previewView];
# 6 添加推流操作
取一个最简单的场景，就是点击一个按钮，然后触发发起直播的操作。
## 6.1 添加触发按钮
我们在 `view` 上添加一个按钮吧。 我们在 `- (void)viewDidLoad` 方法最后添加如下代码
UIButton *button = [UIButton buttonWithType:UIButtonTypeSystem];
[button setTitle:@"start" forState:UIControlStateNormal];
button.frame = CGRectMake(0, 0, 100, 44);
button.center = CGPointMake(CGRectGetMidX([UIScreen mainScreen].bounds), CGRectGetHeight([UIScreen mainScreen].bounds) - 80);
[button addTarget:self action:@selector(actionButtonPressed:) forControlEvents:UIControlEventTouchUpInside];
[self.view addSubview:button];
## 6.2 创建推流地址
在实际开发过程中，为了您的 App 有更好的用户体验，建议提前从服务器端获取推流地址
NSURL *pushURL = [NSURL URLWithString:@"your push url"];
## 6.3 实现按钮动作
- (void)actionButtonPressed:(id)sender {
[self.session startStreamingWithPushURL:pushURL feedback:^(PLStreamStartStateFeedback feedback) {
if (feedback == PLStreamStartStateSuccess) {
NSLog(@"Streaming started.");
}
else {
NSLog(@"Oops.");
}
}];
}
## 6.4 完成首次推流操作
Done，没有额外的代码了，现在可以开始一次推流了。 如果运行后，点击按钮提示 `Oops.`，就要检查一下你之前创建 `PLStream` 对象时填写的
`StreamJson` 是否有漏填或者填错的内容。
# 7 查看推流内容
## 7.1 登录 pili.qiniu.com 查看内容
* 登录 [pili.qiniu.com](https://pili.qiniu.com)
* 登录 `streamJson` 中使用的 hub
* 查看 `stream` 属性
* 点击属性中的播放 URL 后的箭头，即可查看内容。
# 8 DEMO下载
* [点击下载](https://github.com/pili-engineering/PLMediaStreamingKit/tree/master/Example)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,303 |
功能使用 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 推流端 >iOS 推流端 SDK >功能使用
# 功能使用
最近更新时间: 2023-08-17 14:40:28
当你要深入理解 SDK 的一些参数及有定制化需求时，可以从高级功能部分中查询阅读，以下小节无前后依赖。
# 1 音视频采集和编码配置
`PLMediaStreamingKit` 中通过不同的 configuration 设置不同的采集或编码配置信息，对应的有：
* `PLVideoCaptureConfiguration` 视频采集配置
* `PLAudioCaptureConfiguration` 音频采集配置
* `PLVideoStreamingConfiguration` 视频编码配置
* `PLAudioStreamingConfiguration` 音频编码配置
可以通过如下途径来设置 configuration：
* 在 `PLMediaStreamingSession` init 时传递对应的 configuration
* 在推流前、推流中、推流结束后调用 `- (void)reloadVideoStreamingConfiguration:(PLVideoStreamingConfiguration *)videoStreamingConfiguration;` 重置视频编码配置
* 对于视频采集配置，可以直接设置 PLMediaStreamingSession 相关的属性；
需要注意的是，通过 reload 方法重置 configuration 时，需要确保传递的 configuration 与当前 session
已经持有的不是一个对象。
## 1.1 视频采集参数
1.自定义视频采集参数
当前的 `PLVideoCaptureConfiguration` 中可自行设定的参数有
* videoFrameRate
* 即 FPS，每一秒所包含的视频帧数
* sessionPreset
* 即采集时的画幅分辨率大小
* previewMirrorFrontFacing
* 是否在使用前置摄像头采集的时候镜像预览画面
* previewMirrorRearFacing
* 是否在使用后置摄像头采集的时候镜像预览画面
* streamMirrorFrontFacing
* 是否在使用前置摄像头采集的时候镜像编码画面
* streamMirrorRearFacing
* 是否在使用后置摄像头采集的时候镜像编码画面
* position
* 开启 PLMediaStreamingSession 的时候默认使用前置还是后置摄像头
* videoOrientation
* 开启 PLMediaStreamingSession 的时候默认使用哪个旋转方向
需要注意的是指定分辨率的 `sessionPreset` 例如 `AVCaptureSessionPreset1920x1080`
并非所有机型的所有摄像头均支持，在设置相应的采集分辨率之前请务必保证做过充分的机型适配测试，避免在某些机型使用该机型摄像头不支持的
`sessionPreset`。另外，如果使用只指定采集质量的 `sessionPreset`，例如
`AVCaptureSessionPresetMedium`，那系统会根据当前摄像头的支持情况使用相应质量等级的分辨率进行采集。
## 1.2 音频采集参数
#### 自定义音频采集参数
当前的 `PLAudioCaptureConfiguration` 中可自行设定的参数有
* channelsPerFrame
* 采集时的声道数，默认为 1，并非所有采集设备都支持多声道数据的采集，可以通过检查 [AVAudioSession sharedInstance].maximumInputNumberOfChannels 得到当前采集设备支持的最大声道数。
* acousticEchoCancellationEnable
* 回声消除开关，默认为 NO。普通直播用到回声消除的场景不多，当用户开启返听功能，并且使用外放时，可打开这个开关，防止产生尖锐的啸叫声。
## 1.3 视频编码参数
当不确定视频编码具体的参数该如何设定时，你可以选择 SDK 内置的几种视频编码质量。
### Quality 的对比
Quality | VideoSize | FPS | ProfileLevel | Video BitRate(Kbps)
---|---|---|---|---
kPLVideoStreamingQualityLow1 | 272x480 | 24 | Baseline AutoLevel | 128
kPLVideoStreamingQualityLow2 | 272x480 | 24 | Baseline AutoLevel | 256
kPLVideoStreamingQualityLow3 | 272x480 | 24 | Baseline AutoLevel | 512
kPLVideoStreamingQualityMedium1 | 368x640 | 24 | High AutoLevel | 512
kPLVideoStreamingQualityMedium2 | 368x640 | 24 | High AutoLevel | 768
kPLVideoStreamingQualityMedium3 | 368x640 | 24 | High AutoLevel | 1024
kPLVideoStreamingQualityHigh1 | 720x1280 | 24 | High AutoLevel | 1024
kPLVideoStreamingQualityHigh2 | 720x1280 | 24 | High AutoLevel | 1280
kPLVideoStreamingQualityHigh3 | 720x1280 | 24 | High AutoLevel | 1536
### 自定义编码参数
当前的 `PLVideoStreamingConfiguration` 中可自行设定的参数有
* videoProfileLevel
* H.264 编码时对应的 profile level 影响编码压缩算法的复杂度和编码耗能。设置的越高压缩率越高，算法复杂度越高，相应的可能带来发热量更大的情况
* videoSize
* 编码的分辨率，对于采集到的图像，编码前会按照这个分辨率来做拉伸或者裁剪
* expectedSourceVideoFrameRate
* 预期视频的编码帧率，这个数值对编码器的来说并不是直接限定了 fps, 而是给编码器一个预期的视频帧率，最终编码的视频帧率，是由实际输入的数据决定的
* videoMaxKeyframeInterval
* 两个关键帧的帧间隔，一般设置为 FPS 的三倍
* averageVideoBitRate
* 平均的编码码率，设定后编码时的码率并不会是恒定不变，静物较低，动态物体会相应升高
* videoEncoderType
* H.264 编码器类型，默认采用 `PLH264EncoderType_AVFoundation` 编码方式，在 iOS 8 及以上的系统可采用 `PLH264EncoderType_VideoToolbox`，编码效率更高
* videoCodecType
* 视频编码所采用的编码器类型，默认使用 PLCodecType_H264 编码方式
`PLMediaStreamingKit` 为了防止编码参数设定失败而导致编码失败，出现推流无视频的情况，依据 videoProfileLevel
限定了其他参数的范围，该限定范围针对 Quality 生成的配置同样有效。参见以下表格：
ProfileLevel | Max VideoSize | Max FPS | Max Video BitRate(Mbps)
---|---|---|---
Baseline 30 | (720, 480) | 30 | 10
Baseline 31 | (1280, 720) | 30 | 14
Baseline 41 | (1920, 1080) | 30 | 50
Main 30 | (720, 480) | 30 | 10
Main 31 | (1280, 720) | 30 | 14
Main 32 | (1280, 1024) | 30 | 20
Main 41 | (1920, 1080) | 30 | 50
High 40 | (1920, 1080) | 30 | 25
High 41 | (1920, 1080) | 30 | 62.5
### 码率、fps、分辨对清晰度及流畅度的影响
对于码率（BitRate）、FPS（frame per
second）、分辨率（VideoSize）三者的关系，有必要在这里做一些说明，以便你根据自己产品的需要可以有的放矢的调节各个参数。
一个视频流个人的感受一般来说会有卡顿、模糊等消极的情况，虽然我们都不愿意接受消极情况的出现，但是在 UGC 甚至 PGC
的直播场景中，都不可避免的要面对。因为直播推流实时性很强烈，所以为了保证这一实时性，在网络带宽不足或者上行速度不佳的情况下，都需要做出选择。
要么选择更好的流程度但牺牲清晰度（模糊），要么选择更好的清晰度但牺牲流畅度（卡顿），这一层的选择大多由产品决定。
一般来说，当选定了一个分辨率后，推流过程中就不会对分辨率做变更，但可以对码率和 FPS 做出调节，从而达到上述两种情况的选择。
效果 | 码率 | FPS
---|---|---
流畅度 | 负相关 | 正相关
清晰度 | 正相关 | 负相关
通过这个关联，我们就可以容易的知道该如何从技术层面做出调整。在追求更好的流畅度时，我们可以适当降低码率，如果 FPS 已经较高（如 30）时，可以维持
FPS 不变更，如果此时因为码率太低而画面无法接受，可以再适当调低 FPS；在追求更清晰的画质时，可以提高码率，FPS 调节至 24
左右人眼大多还会识别为流畅，如果可以接受有轻微卡顿，那么可以将 FPS 设置的更低，比如 20 甚至 15。
总之，这三者之间一起构建其了画面清晰和视频流畅的感觉，但最终参数是否能满意需要自己不断调整和调优，从而满足产品层面的需求。
## 1.4 音频编码参数
相比于视频繁杂的参数，当前 `PLAudioStreamingConfiguration`
可配置的参数较为简单，目前提供音频码率和编码器的配置，音频编码可选择 AAC-LC 或者 HE-AAC。
各 Quality 的对比：
Quality | Audio BitRate(Kbps)
---|---
kPLAudioStreamingQualityHigh1 | 64
kPLAudioStreamingQualityHigh2 | 96
kPLAudioStreamingQualityHigh3 | 128
## 1.5 切换视频配置
为了满足推流中因网络变更，网络拥塞等情况下对码率、FPS 等参数的调节，`PLMediaStreamingSession`
提供了重置编码参数的方法，因为在重置编码器时会重新发送编码参数信息，可能触发播放器重置解码器或者清除缓存的操作（依据播放器自身行为而定），所以推流中切换编码参数时，观看短可能出现短暂（但视觉可感知）的卡顿。因此建议不要频繁的切换编码参数，避免因此带来的播放端体验问题。
* 在推流前、推流中、推流结束后调用 `- (void)reloadVideoStreamingConfiguration:(PLVideoStreamingConfiguration *)videoStreamingConfiguration;` 来重置 configuration
需要注意的是，通过 reload 方法重置 configuration 时，需要确保传递的 configuration 与当前 session
已经持有的不是一个对象。
## 1.6 建议编码参数
提示：以下为建议值，可根据产品需求自行更改调节。
UGC 场景，因为主播方所在的网络环境参差不齐，所以不易将码率设置的过高，此处我们给出建议设定
* WiFi: video Medium2 或者自定义编码参数时设定码率为 600~800Kbps
* 3G/4G: video Medium1 或者自定义编码参数时设定码率为 400~600Kbps
PGC 场景，因为主播方所在网络一般都会有较高的要求，并且主播网络质量大多可以保障带宽充足，此处我们给出建议设定
* WiFi: video High1 或者自定义编码参数时设定码率为 1000~1200Kbps
* 3G/4G: video Medium2 或者自定义编码参数时设定码率为 600~800Kbps
对于 PGC 中的 3G/4G 场景，假定 PGC 时会配备较好的外置热点保证上行带宽充足。
## 1.7 如何只推音频
当你只需要推送音频时，并不需要额外的增加代码，只需要在创建 `PLMediaStreamingSession` 时，只传入
`PLAudioStreamingConfiguration` 和 `PLAudioCaptureConfiguration` 对象即可，这样
`PLMediaStreamingSession` 就不会在内部创建视频采集和编码的相关内容，推流时也只会发音频配置信息和音频数据。
## 1.8 返听
`返听`又被称之为`耳返`，指声音通过主播的麦克风被录入之后，立即从主播的耳机中播出来。返听功能如果搭配音效功能一起使用，可以让主播听到经音效处理后（如加入混响效果）的自己的声音，会有一种独特感觉。
返听功能可通过 `PLMediaStreamingSession` 的 `playback`
属性进行开启或关闭。注意，只有在推流进行时，返听功能才会起作用。因为只有开始推流之后，SDK 才会打开麦克风并开始录音。
此外，建议通过业务逻辑禁止主播在没有插上耳机的情况下使用返听功能。虽然 SDK
允许用户即便没有插入耳机却照样可以开启返听，但那并不意味着我们建议你这么做。因为在 iPhone 没有接入耳机的时候开启返听，iPhone
的麦克风录入的声音会从 iPhone 的扬声器中立即播放出来，从而再次被麦克风录入，如此反复几秒后将变成尖锐的电流音。想象一下你在 KTV
把话筒凑到音响附近后听到的令人不快的刺耳声音吧。因此，我们强烈建议开发者在业务逻辑层进行判定，当主播开启返听功能时，如果拔掉耳机, 请将
`playback` 属性设为 `NO` 以关闭返听功能。
## 1.9 音效
SDK 内置的音效模块会对主播通过麦克风录入的声音进行处理，从而让人听起来有不一样的感觉。例如加入 “回声”
音效后，主播的声音听起来就好像置身于空旷的讲堂一般；加入 “混响” 音效后，主播的声音听起来则更浑厚有力。
音效会影响`返听`功能，经过音效处理后的声音将被主播自己的耳机播放，音响产生的效果也会被推流出去，从而被观众听到。
SDK 的音效功能是对 iOS 的 Audio Unit 进行的封装，使开发者可以抽身于 Audio Unit 复杂的 API
泥潭。音效的添加、修改、删除都可以通过操作下面这个属性进行：
@property (nonatomic, strong) NSArray<PLAudioEffectConfiguration *> *audioEffectConfigurations;
这是一个由 `PLAudioEffectConfiguration` 对象构成的数组，每一个 `PLAudioEffectConfiguration`
对象对应一种音效。如果你需要同时开启多个音效，只需像如下示例把它们全部放在一个数组中即可：
mediaStreamingSession.audioEffectConfigurations = @[effect0, effect1, effect2, ...];
如果你想删除某个音效，只需要重新构造一个数组，令它唯独不包含那个你想要删除的音效,然后再重新赋值该属性即可。如果你想关闭音效功能，只需要设置一个空数组，或设置
nil 即可。注意，对音效的操作是立即生效的，不需要重启推流。
构成数组的元素必须是 `PLAudioEffectConfiguration` 对象或它的子类的对象。SDK
提供了众多的配置对象供你选择,这些配置对象全部都是 `PLAudioEffectConfiguration` 的子类对象。每一种配置对象往往对应一种
`kAudioUnitType_Effect` 类型的 Audio Unit。如果你熟悉 Audio Unit，你会发现每一种
`kAudioUnitType_Effect` 的子类型，SDK 中都有一种配置类与之对应。
例如，sub type 为 `kAudioUnitSubType_Reverb2` 的 Audio Unit 在 SDK 中对应的配置类为
`PLAudioEffectReverb2Configuration`。而 Reverb2 的所有可使用的属性都可以在
`PLAudioEffectReverb2Configuration` 的成员变量中找到。你可以通过
id effect = [PLAudioEffectReverb2Configuration defaultConfiguration];
来构造一个所有成员变量都取默认值的配置对象。然后，通过类似
...
effect.gain = 0.8;
effect.decayTimeAt0Hz = 1.2;
...
来设置构造好的配置对象的属性。
至此，你应该已经明白了如何构造任何你想要的音效配置了。
* 首先,你需要查找 Apple 的 Audio Unit 的 API 文档,在所有 type 为
kAudioUnitType_Effect 的 Audio Unit 中挑选一个 sub type，作为你想要的音效，然后根据 sub type 的名字找到
SDK 中对应的配置类。例如，在之前的例子中，sub type 为 kAudioUnitSubType_Reverb2，因此配置类的名字为
PLAudioEffectReverb2Configuration。
* 之后调用 [PLAudioEffectXXXConfiguration defaultConfiguration] 来
构造一个全部属性为默认值的配置对象。
* 调整属性的值，来得到你想要的音效效果。
* 重复之前的步骤，直到构造出所有你需要的音效配置对象，并全部装入一个
数组。
* 通过设置 mediaStreamingSession.audioEffectConfigurations =
@[…]; 来让你之前准备的音效配置生效。
除了与 Audio Unit
一一对应的音效配置类，我们还提供了预设的音效类，PLAudioEffectModeConfiguration。你可以通过如下三个方法获取三种预设混响音效配置
[PLAudioEffectModeConfiguration reverbLowLevelModeConfiguration];
[PLAudioEffectModeConfiguration reverbMediumLevelModeConfiguration];
[PLAudioEffectModeConfiguration reverbHeightLevelModeConfiguration];
mediaStreamingSession.audioEffectConfigurations 这个数组里的音效配置对象是有顺序的，这个顺序最终将和
Audio Unit 在 AUGraph 中的顺序保持一致。如果你不了解 Audio Unit 在 AUGraph
中的顺序对最终产生的音效有什么影响，其实也无妨，实际上你随意地将音频对象排列最终产生的效果用肉耳听起来差别也不大（若你有更高的追求，那么你需要理解这个顺序的意义）。
## 1.10 混音
当前版本的 SDK
允许主播在推流的同时，播放本地音频文件。主播麦克风录入的声音，在经过音效处理(如果有)后，会与音频文件的内容混合，然后推流出去让观众听到。同时，如果主播开启了返听功能，亦可以从耳机听到音频文件播放出的声音。
场景举例：直播中，主播唱歌，通过播放音频文件来获得伴奏。结合返听功能，主播可以从耳机听到伴奏音乐以及自己的唱出的歌声。同时观众最终听到的也是混合了伴奏的主播的歌声。
要开启音频文件播放功能,首先需要构造播放器实例,通过如下方法构造
PLAudioPlayer *player = [mediaStreamingSession audioPlayerWithFilePath:@"audio file path"];
之后，所有与音频文件播放相关的功能就都基于 `player` 进行了。
当你播放完音频文件之后，且不打算再使用该功能时，需要释放掉 player，可通过调用
[mediaStreamingSession closeCurrentAudio];
来释放之前获取的播放器实例。
**注意：播放器使用完必须关闭，否则它将一直占用着资源（例如音频文件的句柄）。**
每当音频文件播放完毕，会回调如下方法询问你是否把该音频文件重新播放一遍
- (BOOL)didAudioFilePlayingFinishedAndShouldAudioPlayerPlayAgain:(PLAudioPlayer *)audioPlayer
该方法可以让你知道音频文件什么时候播放完毕，同时通过返回一个 BOOL 值，来控制播放器的行为。例如，如果你想做单曲循环效果，可以如此实现该方法
- (BOOL)didAudioFilePlayingFinishedAndShouldAudioPlayerPlayAgain:(PLAudioPlayer *)audioPlayer {
return YES;
}
如果你想实现顺序播放效果，可以如此实现该方法
- (BOOL)didAudioFilePlayingFinishedAndShouldAudioPlayerPlayAgain:(PLAudioPlayer *)audioPlayer {
audioPlayer.audioFilePath = @"/path/to/next/audio/file/name.mp3";
return YES;
}
## 1.11 SRT 协议
SDK 默认采用 rtmp 协议推流，如果你想实现 SRT 协议推流，仅需两步即可开启 SRT 协议推流，其他步骤无需改变
* 开启 SRT 协议支持：
@property (nonatomic, assign) PLProtocolModel protocolModel
* 获取符合标准的 SRT 推流地址：
SRT 协议推流地址需符合官方标准，详情可参考 [access-control
__](https://github.com/Haivision/srt/blob/master/docs/features/access-
control.md#general-syntax)，示例如下：
srt://pili-publish.qnsdk.com?streamid=#!::h=sdk-live/xxx,m=publish
其中，h 对应您七牛云直播空间下的 _空间名/streamID_
# 2 DNS 优化
在大陆一些地区或特别的运营商线路，存在较为普遍的 DNS 劫持问题，而这对于依赖 DNS 解析 rtmp 流地址的
`PLMediaStreamingKit` 来说是很糟糕的情况，为了解决这一问题，我们引入了 `HappyDNS` 这个库，以便可以实现
httpDNS，localDNS 等方式解决这类问题。
## 2.1 HappyDNS
你可以[点击这里 __](https://github.com/qiniu/happy-dns-objc)跳转到`HappyDNS` 的 GitHub
主页，在那里查看更详细的介绍和使用。
默认情况下，你所创建的 `PLMediaStreamingSession` 对象，内部持有一个 `HappyDNS` 对应的 manager
对象，来负责处理 DNS 解析。
如果你期望按照不同的规则来做 DNS 解析，那么你可以在创建 `PLMediaStreamingSession` 前，创建好自己的
`QNDnsManager` 对象，我们在 `PLMediaStreamingSession` 中提供了一个 init 方法满足这类需求，你可以传递自己的
`QNDnsManager` 对象给 `PLMediaStreamingSession`，从而定制化 DNS 解析。
# 3 流状态获取
在 `PLMediaStreamingKit` 中，通过反馈 `PLMediaStreamingSession`
的状态来反馈流的状态。我们定义了几种状态，确保 `PLMediaStreamingSession` 对象在有限的几个状态间切换，并可以较好的反应流的状态。
状态名 | 含义
---|---
PLStreamStateUnknow | 初始化时指定的状态，不会有任何状态会跳转到这一状态
PLStreamStateConnecting | RTMP 流链接中的状态
PLStreamStateConnected | RTMP 已连接成功时的状态
PLStreamStateDisconnecting | RTMP 正常断开时，正在断开的状态
PLStreamStateDisconnected | RTMP 正常断开时，已断开的状态
PLStreamStateAutoReconnecting | 正在等待自动重连状态
PLStreamStateError | 因非正常原因导致 RTMP 流断开，如包发送失败、流校验失败等
## 3.1 state 状态回调
state 状态对应的 Delegate 回调方法是
- (void)mediaStreamingSession:(PLMediaStreamingSession *)session streamStateDidChange:(PLStreamState)state;
只有在正常连接，正常断开的情况下跳转的状态才会触发这一回调。所谓正常连接是指通过调用 `-startStreamingWithFeedback:`
方法使得流连接的各种状态，而所谓正常断开是指调用 `-stopStreaming` 方法使得流断开的各种状态。所以只有以下四种状态会触发这一回调方法。
* PLStreamStateConnecting
* PLStreamStateConnected
* PLStreamStateDisconnecting
* PLStreamStateDisconnected
## 3.2 error 状态回调
error 状态对应的 Delegate 回调方法是
- (void)mediaStreamingSession:(PLMediaStreamingSession *)session didDisconnectWithError:(NSError *)error;
除了调用 `-stopStreaming` 之外的所有导致流断开的情况，都被归属于非正常断开的情况，此时就会触发该回调。对于错误的处理，我们不建议触发了一次
error 后就停掉，最好可以在此时尝试有限次数的重连，详见重连小节。
## 3.3 status 状态回调
除了 state 作为流本身状态的切换，我们还提供了流实时情况的反馈接口
- (void)mediaStreamingSession:(PLMediaStreamingSession *)session streamStatusDidUpdate:(PLStreamStatus *)status;
默认情况下，该回调每隔 3s 调用一次，每次包含了这 3s 内音视频的 fps 和总共的码率（注意单位是 kbps）。你可以通过
`PLMediaStreamingSession` 的 statusUpdateInterval 属性来读取或更改这个回调的间隔。
## 3.4 产品层面的反馈
status 的状态回调可以很好的反应发送情况，及网络是否流畅，是否拥塞。所以此处可以作为产品层面对弱网情况决策的一个入口。
一般的，当 status.videoFPS 比预设的 FPS 明显小时（小于等于
20%），并且维持几秒都是如此，那么就可以判定为当前主播所在的网络为弱网环境，可以给主播视觉上的提示，或者主动降低编码配置，甚至直接断掉主播的流，这些都由具体的产品需求而定，而此处只是给出一个入口的提示和建议。
# 4 网络异常处理
直播中，网络异常的情况比我们能意料到的可能会多不少，常见的情况一般有
* 网络环境切换，比如 3G/4G 与 Wi-Fi 环境切换
* 网络不可达，网络断开属于这一类
* 带宽不足，可能触发发送失败
* 上行链路不佳，直接影响流发送速度
作为开发者我们不能乐观的认为只要是 Wi-Fi 网就是好的，因为即便是 Wi-Fi
也有可能因为运营商上行限制，共享网络带宽等因素导致以上网络异常情况的出现。
为何在直播中要面对这么多的网络异常情况，而在其他上传/下载中很少遇到的，这是因为直播对实时性的要求使得它不得面对这一情况，即无论网络是否抖动，是否能一直良好，直播都要尽可能是可持续，可观看的状态。
## 4.1 重连
`PLMediaStreamingSession` 内置了自动重连功能，但默认处于关闭状态。之所以默认关闭，一方面是考虑到 App
的业务逻辑场景多样而负责，对于直播重连的次数、时机、间隔都会有不同的需求，此时让开发者自己来决定是否重连，以及尝试重连的次数会更加合理；另一方面是兼容旧版本业务层面可能已实现的自动重连逻辑。
如果你想直接使用内置的自动重连功能，可通过将 `PLMediaStreamingSession` 的 `autoReconnectEnable` 属性设置为
`YES` 来开启，并需要注意如下几点：
* 自动重连次数上限目前设定为 3 次，重连的等待时间会由首次的 0~2s 之间逐步递增到第三次的 4~6s 之间
* 等待重连期间，`streamState` 处于 `PLStreamStateAutoReconnecting` 状态，业务层可根据该状态来更新用户界面
* 网络异常的 error Delegate 回调只有在达到最大重连次数后还未连接成功时才会被触发
若你想自己实现自动重连逻辑，可以利用以下网络异常所触发的 error Delegate 回调接口来添加相应的逻辑：
- (void)mediaStreamingSession:(PLMediaStreamingSession *)session didDisconnectWithError:(NSError *)error;
你可以在这个方法内通过重新调用 `-startStreamingWithFeedback:`
方法来尝试重连。此处建议不要立即重连，而是采用重连间隔加倍的方式，比如共尝试 3 次重连，第一次等待 0.5s, 第二次等待 1s, 第三次等待
2s，这样的方式主要考虑到弱网时网络带宽的缓解需要时间，而加倍重连可以更容易在网络恢复的时候连接，而非在网络已经拥塞时还不断做无用功的重连。
`PLMediaStreamingSession` 内置了网络切换监测功能，但默认处于关闭状态。开启后，网络在 WWAN(3G/4G) 和 Wi-Fi
之间相互切换时，我们提供了一个回调 `connectionChangeActionCallback` 属性，它的函数签名如下
typedef BOOL(^ConnectionChangeActionCallback)(PLNetworkStateTransition transition);
该回调函数传入参数为当前网络的切换状态 `PLNetworkStateTransition`。
返回值为布尔值，YES表示在某种切换状态下允许推流自动重启，NO则代表该状态下不应自动重启。例如在
`PLNetworkStateTransitionWWANToWiFi` 状态，即网络从 3G/4G 切换到 Wi-Fi
后，基于节省流量等需求考虑，你可能需要进行一次快速的重连，使得数据可以通过 Wi-Fi 网络发送，此时返回 `YES` 即可。反之，如果推流过程中 Wi-
Fi 断掉切换到 3G/4G，此时在未征得用户同意使用移动流量推流时，可返回 `NO` 不自动重启推流。以下为参考逻辑
session.connectionChangeActionCallback = ^(PLNetworkStateTransition transition) {
switch (transition) {
case PLNetworkStateTransitionWWANToWiFi:
return YES;
case PLNetworkStateTransitionWiFiToWWAN:
return NO;
default:
break;
}
return NO;
};
如果该属性未被初始化赋值，则 SDK 内部出于节省用户移动网络流量的目的，会默认在 Wi-Fi 切换到 3G/4G
时断开推流。此时，你可以自行监听网络状态，调用 `-restartStreamingWithFeedback:` 方法来快速重连。
## 4.2 弱网优化
移动直播过程中存在着各种各样的网络挑战。由于无线网络相对于有线网络，可靠性较低，会经常遇到信号覆盖不佳导致的高丢包、高延时等问题，特别是在用网高峰期，由于带宽有限，网络拥塞的情况时有发生。自
[v2.1.3 __](https://github.com/pili-
engineering/PLMediaStreamingKit/releases/tag/v2.1.3)起，`PLMediaStreamingKit`
内置了一套弱网优化方案，可以满足以下两个诉求：
* 能动态地适应网络质量，即在质量不佳的网络下，能够自动下调视频编码的输出码率和帧率，而当网络质量恢复稳定时，输出码率和帧率也应得到相应回升，并能在调节过程中使得码率与帧率变化相对平稳。
* 在直播端网络质量稳定时，确保编码器输出的码率和帧率恒定在一个期望的最高值，以提供良好的清晰度和流畅度。
这套弱网优化方案包含两个工作模块：
* 自适应码率模块，能够在期望码率与设定的最低码率间做出调节，适应网络抖动引发的数据带宽变化。
* 动态帧率模块，能够在期望帧率与一个最低帧率间做出调节，动态调整输出的视频数据量。
这两个模块可并行工作，可以单独开启或关闭，开发者可根据自己的业务场景来决定该方案的应用形态。一般情况下，如果开发者想使用该解决方案，建议将两个调节模块都开启，可达到我们测试的最佳效果。利用码率与帧率调整相互配合作用，一方面有效控制网络波动情况下的音视频数据发送量，缓解网络拥塞，同时又能给播放端带来流畅的观看体验；另一方面在网络质量恢复时能够确保音视频的码率帧率是以设定的最优质量配置进行推流，并且能使不同码率帧率配置切换时以一种更为平滑的方式进行，不会给观看端带来画质波动的突兀感。
自适应码率调节可以通过 `PLMediaStreamingSession` 的如下接口开启:
- (void)enableAdaptiveBitrateControlWithMinVideoBitRate:(NSUInteger)minVideoBitRate;
其关闭接口为:
- (void)disableAdaptiveBitrateControl;
开启该机制时，需设置允许向下调节的最低码率（注意其单位为 bps，如设置最低为 200 Kbps，应传入参数值为
200*1024），以便使自动调整后的码率不会低于该范围。该机制根据网络吞吐量及 TCP
发送时间来调节推流的码率，在网络带宽变小导致发送缓冲区数据持续增长时，SDK
内部将适当降低推流码率，若情况得不到改善，则会重复该过程直至平均码率降至用户设置的最低值；反之，当一段时间内网络带宽充裕，SDK
将适当增加推流码率，直至达到预设的推流码率。
动态帧率的开关为 `PLMediaStreamingSession` 的 `dynamicFrameEnable`
属性，开启后，自动调整的最大帧率不会超过预设在 `videoStreamingConfiguration` 配置中的
`expectedSourceVideoFrameRate`，最低不会小于 10 FPS。
默认情况下，这两个模块处于关闭状态，是为了兼容旧版本中开发者可能已自行实现的弱网调节机制。若开发者想使用我们的内置方案，请确保您自定义的机制已被关闭。
# 5 水印和美颜
## 5.1 水印
`PLMediaStreamingKit`
支持内置水印功能，你可以根据自己的需要添加水印或移除水印，并且能够自由设置水印的大小和位置。需要注意的是水印功能对预览和直播流均生效。
添加水印
-(void)setWaterMarkWithImage:(UIImage *)wateMarkImage position:(CGPoint)position;
该方法将为直播流添加一个水印，水印的大小由 `wateMarkImage` 的大小决定，位置由 position
决定，需要注意的是这些值都是以采集数据的像素点为单位的。例如我们使用 `AVCaptureSessionPreset1280x720` 进行采集，同时
`wateMarkImage.size` 为 `(100, 100)` 对应的 `origin` 为 `(200, 300)`，那么水印的位置将在大小为
`1280x720` 的采集画幅中位于 `(200, 300)` 的位置，大小为 `(100, 100)`。
移除水印
-(void)clearWaterMark;
该方法用于移除已添加的水印
## 5.2 美颜
‘PLMediaStreamingSession’
支持内置美颜功能，你可以根据自己的需要选择开关美颜功能，并且能够自由调节包括美颜，美白，红润等在内的参数。需要注意的是水印功能对预览和直播流均生效。
按照默认参数开启或关闭美颜
-(void)setBeautifyModeOn:(BOOL)beautifyModeOn;
设置美颜程度，范围为 0 ~ 1
-(void)setBeautify:(CGFloat)beautify;
设置美白程度，范围为 0 ~ 1
-(void)setWhiten:(CGFloat)whiten;
设置红润程度，范围为 0 ~ 1
-(void)setRedden:(CGFloat)redden;
# 6 录屏推流
`PLStreamingKit` 支持 iOS 10 新增的录屏推流 ([`ReplayKit Live`
__](https://developer.apple.com/reference/replaykit)) 功能，开发者可通过构建[App
Extension __](https://developer.apple.com/app-extensions)来调用推流 API
实现实时游戏直播等功能。需要注意的是，实时直播需要游戏或 App 本身实现对`ReplayKit` 的支持。
## 6.1 创建 Broadcast Upload Extension
在原有直播 App 中添加一个类型为 `Broadcast Upload Extension` 的新 Target，如图所示：
Xcode 会额外自动创建一个类型为 `Broadcast UI Extension` 的 Target，用于显示调用 `Broadcast Upload
Extension` 的用户界面。
## 6.2 添加推流管理类
创建推流 API 调用管理类，添加头文件引用：
#import <PLMediaStreamingKit/PLStreamingKit.h>
头文件参考
#import <Foundation/Foundation.h>
#import <PLMediaStreamingKit/PLStreamingKit.h>
@interface BroadcastManager : NSObject
@property (nonatomic, strong) PLStreamingSession *session;
+ (instancetype)sharedBroadcastManager;
- (PLStreamState)streamState;
- (void)pushVideoSampleBuffer:(CMSampleBufferRef)sampleBuffer;
- (void)pushAudioSampleBuffer:(CMSampleBufferRef)sampleBuffer withChannelID:(const NSString *)channelID;
@end
类实现参考
@interface BroadcastManager ()<PLStreamingSessionDelegate>
@end
@implementation BroadcastManager
static BroadcastManager *_instance;
- (instancetype)init
{
if (self = [super init]) {
[PLStreamingEnv initEnv];
PLVideoStreamingConfiguration *videoConfiguration = [[PLVideoStreamingConfiguration alloc] initWithVideoSize:CGSizeMake(1280, 720) expectedSourceVideoFrameRate:24 videoMaxKeyframeInterval:24*3 averageVideoBitRate:1000*1024 videoProfileLevel:AVVideoProfileLevelH264High41];
PLAudioStreamingConfiguration *audioConfiguration = [PLAudioStreamingConfiguration defaultConfiguration];
audioConfiguration.inputAudioChannelDescriptions = @[kPLAudioChannelApp, kPLAudioChannelMic];
self.session = [[PLStreamingSession alloc] initWithVideoStreamingConfiguration:videoConfiguration
audioStreamingConfiguration:audioConfiguration
stream:nil];
self.session.delegate = self;
#warning 以下 pushURL 需替换为一个真实的流地址
NSString *pushURL = nil;
dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(0.5 * NSEC_PER_SEC)), dispatch_get_main_queue(), ^{
[self.session startWithPushURL:[NSURL URLWithString:pushURL] feedback:^(PLStreamStartStateFeedback feedback) {
if (PLStreamStartStateSuccess == feedback) {
NSLog(@"connect success");
} else {
NSLog(@"connect failed");
}
}];
});
}
return self;
}
+ (void)initialize
{
_instance = [[BroadcastManager alloc] init];
}
- (PLStreamState)streamState
{
return self.session.streamState;
}
- (void)pushVideoSampleBuffer:(CMSampleBufferRef)sampleBuffer
{
[self.session pushVideoSampleBuffer:sampleBuffer];
}
- (void)pushAudioSampleBuffer:(CMSampleBufferRef)sampleBuffer withChannelID:(const NSString *)channelID
{
[self.session pushAudioSampleBuffer:sampleBuffer withChannelID:channelID completion:nil];
}
+ (instancetype)sharedBroadcastManager
{
return _instance;
}
// 实现其他必要的协议方法
- (void)streamingSession:(PLStreamingSession *)session didDisconnectWithError:(NSError *)error
{
NSLog(@"error : %@", error);
}
- (void)streamingSession:(PLStreamingSession *)session streamStatusDidUpdate:(PLStreamStatus *)status
{
NSLog(@"%@", status);
}
@end
注意 `PLAudioStreamingConfiguration` 实例生成时必需注册音频流来源
audioConfiguration.inputAudioChannelDescriptions = @[kPLAudioChannelApp, kPLAudioChannelMic];
其中 `kPLAudioChannelApp` 对应于 `RPSampleBufferTypeAudioApp`，是 ReplayKit Live 回调的
app 音频数据，`kPLAudioChannelMic` 对应于 `RPSampleBufferTypeAudioMic`，是 ReplayKit
Live 回调的 mic 音频数据。之所以需要显示声明，是为了在 PLStreamingKit 在音频编码前将两路音频流进行混音。
在自动生成的 `SampleHandler.m` 中实现 `RPBroadcastSampleHandler` 协议部分方法如下：
- (void)processSampleBuffer:(CMSampleBufferRef)sampleBuffer withType:(RPSampleBufferType)sampleBufferType {
if ([BroadcastManager sharedBroadcastManager].streamState == PLStreamStateConnected) {
switch (sampleBufferType) {
case RPSampleBufferTypeVideo:
// Handle video sample buffer
[[BroadcastManager sharedBroadcastManager] pushVideoSampleBuffer:sampleBuffer];
break;
case RPSampleBufferTypeAudioApp:
// Handle audio sample buffer for app audio
[[BroadcastManager sharedBroadcastManager] pushAudioSampleBuffer:sampleBuffer withChannelID:kPLAudioChannelApp];
break;
case RPSampleBufferTypeAudioMic:
// Handle audio sample buffer for mic audio
[[BroadcastManager sharedBroadcastManager] pushAudioSampleBuffer:sampleBuffer withChannelID:kPLAudioChannelMic];
break;
default:
break;
}
}
}
## 6.3 一些注意点
如果你使用 CocoaPods 管理依赖库，可能会在编译 broadcast extension target 时遇到 link error，此时请检查
Podfile 里是否为 broadcast extension target 添加相应的依赖；或者可检查以下工程设置是否更改：
# 7 后台推图片
App
一旦切到后台，摄像头的采集功能会被系统暂停掉，观众会看到主播的画面会卡住，此时如果能推送一张图片告诉观众主播进入后台了，将带来更好的观看体验。具体实现方法如下：开发者需要自行监听
App 进入后台/前台的通知，当App 进入后台时，使用 PLMediaStreamingSession 的如下接口
- (void)setPushImage:(nullable UIImage *)image;
设置一张推流图片，PLMediaStreamingSession 会持续为您推送该图片，当 App 返回前台不再需要推送图片时，重新调用以上接口并传入
nil 即可。
# 8 QUIC 推流
QUIC 是基于 UDP 开发的可靠传输协议，在弱网下拥有更好的推流效果，相比于 TCP 拥有更低的延迟，可抵抗更高的丢包率。可通过下面接口开启/关闭
QUIC 推流：
@property (nonatomic, assign, getter=isQuicEnable) BOOL quicEnable;
# 9 HEVC 编码推流
通过 PLVideoStreamingConfigutaion 初始化方法，设置 videoCodecType 视频编码类型为
PLVideoCodecType_HEVC，便可以使用 HEVC 编码推流。具体初始化方法如下：
- (instancetype)initWithVideoSize:(CGSize)videoSize
expectedSourceVideoFrameRate:(NSUInteger)expectedSourceVideoFrameRate
videoMaxKeyframeInterval:(NSUInteger)videoMaxKeyframeInterval
averageVideoBitRate:(NSUInteger)averageVideoBitRate
videoCodecType:(PLVideoCodecType)videoCodecType;
开始推流时，我们会收到使用的编码器类型回调。
由于 HEVC 编码仅支持 iPhone7 及以上设备和 iOS11及以上系统，如果不支持上述条件会回退到 H264 编码推流。
- (void)streamingSession:(PLStreamingSession *)session videoCodecDidChange:(PLVideoCodecType)codecType;
推流过程中，如果连续 3*fps 编码失败，会回调错误码 PLStreamErrorEncoderEncodeFailed，并停止推流 ：
- (void)mediaStreamingSession:(PLMediaStreamingSession *)session didDisconnectWithError:(NSError *)error;
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 推流端 >iOS 推流端 SDK >功能使用
# 功能使用
最近更新时间: 2023-08-17 14:40:28
当你要深入理解 SDK 的一些参数及有定制化需求时，可以从高级功能部分中查询阅读，以下小节无前后依赖。
# 1 音视频采集和编码配置
`PLMediaStreamingKit` 中通过不同的 configuration 设置不同的采集或编码配置信息，对应的有：
* `PLVideoCaptureConfiguration` 视频采集配置
* `PLAudioCaptureConfiguration` 音频采集配置
* `PLVideoStreamingConfiguration` 视频编码配置
* `PLAudioStreamingConfiguration` 音频编码配置
可以通过如下途径来设置 configuration：
* 在 `PLMediaStreamingSession` init 时传递对应的 configuration
* 在推流前、推流中、推流结束后调用 `- (void)reloadVideoStreamingConfiguration:(PLVideoStreamingConfiguration *)videoStreamingConfiguration;` 重置视频编码配置
* 对于视频采集配置，可以直接设置 PLMediaStreamingSession 相关的属性；
需要注意的是，通过 reload 方法重置 configuration 时，需要确保传递的 configuration 与当前 session
已经持有的不是一个对象。
## 1.1 视频采集参数
1.自定义视频采集参数
当前的 `PLVideoCaptureConfiguration` 中可自行设定的参数有
* videoFrameRate
* 即 FPS，每一秒所包含的视频帧数
* sessionPreset
* 即采集时的画幅分辨率大小
* previewMirrorFrontFacing
* 是否在使用前置摄像头采集的时候镜像预览画面
* previewMirrorRearFacing
* 是否在使用后置摄像头采集的时候镜像预览画面
* streamMirrorFrontFacing
* 是否在使用前置摄像头采集的时候镜像编码画面
* streamMirrorRearFacing
* 是否在使用后置摄像头采集的时候镜像编码画面
* position
* 开启 PLMediaStreamingSession 的时候默认使用前置还是后置摄像头
* videoOrientation
* 开启 PLMediaStreamingSession 的时候默认使用哪个旋转方向
需要注意的是指定分辨率的 `sessionPreset` 例如 `AVCaptureSessionPreset1920x1080`
并非所有机型的所有摄像头均支持，在设置相应的采集分辨率之前请务必保证做过充分的机型适配测试，避免在某些机型使用该机型摄像头不支持的
`sessionPreset`。另外，如果使用只指定采集质量的 `sessionPreset`，例如
`AVCaptureSessionPresetMedium`，那系统会根据当前摄像头的支持情况使用相应质量等级的分辨率进行采集。
## 1.2 音频采集参数
#### 自定义音频采集参数
当前的 `PLAudioCaptureConfiguration` 中可自行设定的参数有
* channelsPerFrame
* 采集时的声道数，默认为 1，并非所有采集设备都支持多声道数据的采集，可以通过检查 [AVAudioSession sharedInstance].maximumInputNumberOfChannels 得到当前采集设备支持的最大声道数。
* acousticEchoCancellationEnable
* 回声消除开关，默认为 NO。普通直播用到回声消除的场景不多，当用户开启返听功能，并且使用外放时，可打开这个开关，防止产生尖锐的啸叫声。
## 1.3 视频编码参数
当不确定视频编码具体的参数该如何设定时，你可以选择 SDK 内置的几种视频编码质量。
### Quality 的对比
Quality | VideoSize | FPS | ProfileLevel | Video BitRate(Kbps)
---|---|---|---|---
kPLVideoStreamingQualityLow1 | 272x480 | 24 | Baseline AutoLevel | 128
kPLVideoStreamingQualityLow2 | 272x480 | 24 | Baseline AutoLevel | 256
kPLVideoStreamingQualityLow3 | 272x480 | 24 | Baseline AutoLevel | 512
kPLVideoStreamingQualityMedium1 | 368x640 | 24 | High AutoLevel | 512
kPLVideoStreamingQualityMedium2 | 368x640 | 24 | High AutoLevel | 768
kPLVideoStreamingQualityMedium3 | 368x640 | 24 | High AutoLevel | 1024
kPLVideoStreamingQualityHigh1 | 720x1280 | 24 | High AutoLevel | 1024
kPLVideoStreamingQualityHigh2 | 720x1280 | 24 | High AutoLevel | 1280
kPLVideoStreamingQualityHigh3 | 720x1280 | 24 | High AutoLevel | 1536
### 自定义编码参数
当前的 `PLVideoStreamingConfiguration` 中可自行设定的参数有
* videoProfileLevel
* H.264 编码时对应的 profile level 影响编码压缩算法的复杂度和编码耗能。设置的越高压缩率越高，算法复杂度越高，相应的可能带来发热量更大的情况
* videoSize
* 编码的分辨率，对于采集到的图像，编码前会按照这个分辨率来做拉伸或者裁剪
* expectedSourceVideoFrameRate
* 预期视频的编码帧率，这个数值对编码器的来说并不是直接限定了 fps, 而是给编码器一个预期的视频帧率，最终编码的视频帧率，是由实际输入的数据决定的
* videoMaxKeyframeInterval
* 两个关键帧的帧间隔，一般设置为 FPS 的三倍
* averageVideoBitRate
* 平均的编码码率，设定后编码时的码率并不会是恒定不变，静物较低，动态物体会相应升高
* videoEncoderType
* H.264 编码器类型，默认采用 `PLH264EncoderType_AVFoundation` 编码方式，在 iOS 8 及以上的系统可采用 `PLH264EncoderType_VideoToolbox`，编码效率更高
* videoCodecType
* 视频编码所采用的编码器类型，默认使用 PLCodecType_H264 编码方式
`PLMediaStreamingKit` 为了防止编码参数设定失败而导致编码失败，出现推流无视频的情况，依据 videoProfileLevel
限定了其他参数的范围，该限定范围针对 Quality 生成的配置同样有效。参见以下表格：
ProfileLevel | Max VideoSize | Max FPS | Max Video BitRate(Mbps)
---|---|---|---
Baseline 30 | (720, 480) | 30 | 10
Baseline 31 | (1280, 720) | 30 | 14
Baseline 41 | (1920, 1080) | 30 | 50
Main 30 | (720, 480) | 30 | 10
Main 31 | (1280, 720) | 30 | 14
Main 32 | (1280, 1024) | 30 | 20
Main 41 | (1920, 1080) | 30 | 50
High 40 | (1920, 1080) | 30 | 25
High 41 | (1920, 1080) | 30 | 62.5
### 码率、fps、分辨对清晰度及流畅度的影响
对于码率（BitRate）、FPS（frame per
second）、分辨率（VideoSize）三者的关系，有必要在这里做一些说明，以便你根据自己产品的需要可以有的放矢的调节各个参数。
一个视频流个人的感受一般来说会有卡顿、模糊等消极的情况，虽然我们都不愿意接受消极情况的出现，但是在 UGC 甚至 PGC
的直播场景中，都不可避免的要面对。因为直播推流实时性很强烈，所以为了保证这一实时性，在网络带宽不足或者上行速度不佳的情况下，都需要做出选择。
要么选择更好的流程度但牺牲清晰度（模糊），要么选择更好的清晰度但牺牲流畅度（卡顿），这一层的选择大多由产品决定。
一般来说，当选定了一个分辨率后，推流过程中就不会对分辨率做变更，但可以对码率和 FPS 做出调节，从而达到上述两种情况的选择。
效果 | 码率 | FPS
---|---|---
流畅度 | 负相关 | 正相关
清晰度 | 正相关 | 负相关
通过这个关联，我们就可以容易的知道该如何从技术层面做出调整。在追求更好的流畅度时，我们可以适当降低码率，如果 FPS 已经较高（如 30）时，可以维持
FPS 不变更，如果此时因为码率太低而画面无法接受，可以再适当调低 FPS；在追求更清晰的画质时，可以提高码率，FPS 调节至 24
左右人眼大多还会识别为流畅，如果可以接受有轻微卡顿，那么可以将 FPS 设置的更低，比如 20 甚至 15。
总之，这三者之间一起构建其了画面清晰和视频流畅的感觉，但最终参数是否能满意需要自己不断调整和调优，从而满足产品层面的需求。
## 1.4 音频编码参数
相比于视频繁杂的参数，当前 `PLAudioStreamingConfiguration`
可配置的参数较为简单，目前提供音频码率和编码器的配置，音频编码可选择 AAC-LC 或者 HE-AAC。
各 Quality 的对比：
Quality | Audio BitRate(Kbps)
---|---
kPLAudioStreamingQualityHigh1 | 64
kPLAudioStreamingQualityHigh2 | 96
kPLAudioStreamingQualityHigh3 | 128
## 1.5 切换视频配置
为了满足推流中因网络变更，网络拥塞等情况下对码率、FPS 等参数的调节，`PLMediaStreamingSession`
提供了重置编码参数的方法，因为在重置编码器时会重新发送编码参数信息，可能触发播放器重置解码器或者清除缓存的操作（依据播放器自身行为而定），所以推流中切换编码参数时，观看短可能出现短暂（但视觉可感知）的卡顿。因此建议不要频繁的切换编码参数，避免因此带来的播放端体验问题。
* 在推流前、推流中、推流结束后调用 `- (void)reloadVideoStreamingConfiguration:(PLVideoStreamingConfiguration *)videoStreamingConfiguration;` 来重置 configuration
需要注意的是，通过 reload 方法重置 configuration 时，需要确保传递的 configuration 与当前 session
已经持有的不是一个对象。
## 1.6 建议编码参数
提示：以下为建议值，可根据产品需求自行更改调节。
UGC 场景，因为主播方所在的网络环境参差不齐，所以不易将码率设置的过高，此处我们给出建议设定
* WiFi: video Medium2 或者自定义编码参数时设定码率为 600~800Kbps
* 3G/4G: video Medium1 或者自定义编码参数时设定码率为 400~600Kbps
PGC 场景，因为主播方所在网络一般都会有较高的要求，并且主播网络质量大多可以保障带宽充足，此处我们给出建议设定
* WiFi: video High1 或者自定义编码参数时设定码率为 1000~1200Kbps
* 3G/4G: video Medium2 或者自定义编码参数时设定码率为 600~800Kbps
对于 PGC 中的 3G/4G 场景，假定 PGC 时会配备较好的外置热点保证上行带宽充足。
## 1.7 如何只推音频
当你只需要推送音频时，并不需要额外的增加代码，只需要在创建 `PLMediaStreamingSession` 时，只传入
`PLAudioStreamingConfiguration` 和 `PLAudioCaptureConfiguration` 对象即可，这样
`PLMediaStreamingSession` 就不会在内部创建视频采集和编码的相关内容，推流时也只会发音频配置信息和音频数据。
## 1.8 返听
`返听`又被称之为`耳返`，指声音通过主播的麦克风被录入之后，立即从主播的耳机中播出来。返听功能如果搭配音效功能一起使用，可以让主播听到经音效处理后（如加入混响效果）的自己的声音，会有一种独特感觉。
返听功能可通过 `PLMediaStreamingSession` 的 `playback`
属性进行开启或关闭。注意，只有在推流进行时，返听功能才会起作用。因为只有开始推流之后，SDK 才会打开麦克风并开始录音。
此外，建议通过业务逻辑禁止主播在没有插上耳机的情况下使用返听功能。虽然 SDK
允许用户即便没有插入耳机却照样可以开启返听，但那并不意味着我们建议你这么做。因为在 iPhone 没有接入耳机的时候开启返听，iPhone
的麦克风录入的声音会从 iPhone 的扬声器中立即播放出来，从而再次被麦克风录入，如此反复几秒后将变成尖锐的电流音。想象一下你在 KTV
把话筒凑到音响附近后听到的令人不快的刺耳声音吧。因此，我们强烈建议开发者在业务逻辑层进行判定，当主播开启返听功能时，如果拔掉耳机, 请将
`playback` 属性设为 `NO` 以关闭返听功能。
## 1.9 音效
SDK 内置的音效模块会对主播通过麦克风录入的声音进行处理，从而让人听起来有不一样的感觉。例如加入 “回声”
音效后，主播的声音听起来就好像置身于空旷的讲堂一般；加入 “混响” 音效后，主播的声音听起来则更浑厚有力。
音效会影响`返听`功能，经过音效处理后的声音将被主播自己的耳机播放，音响产生的效果也会被推流出去，从而被观众听到。
SDK 的音效功能是对 iOS 的 Audio Unit 进行的封装，使开发者可以抽身于 Audio Unit 复杂的 API
泥潭。音效的添加、修改、删除都可以通过操作下面这个属性进行：
@property (nonatomic, strong) NSArray<PLAudioEffectConfiguration *> *audioEffectConfigurations;
这是一个由 `PLAudioEffectConfiguration` 对象构成的数组，每一个 `PLAudioEffectConfiguration`
对象对应一种音效。如果你需要同时开启多个音效，只需像如下示例把它们全部放在一个数组中即可：
mediaStreamingSession.audioEffectConfigurations = @[effect0, effect1, effect2, ...];
如果你想删除某个音效，只需要重新构造一个数组，令它唯独不包含那个你想要删除的音效,然后再重新赋值该属性即可。如果你想关闭音效功能，只需要设置一个空数组，或设置
nil 即可。注意，对音效的操作是立即生效的，不需要重启推流。
构成数组的元素必须是 `PLAudioEffectConfiguration` 对象或它的子类的对象。SDK
提供了众多的配置对象供你选择,这些配置对象全部都是 `PLAudioEffectConfiguration` 的子类对象。每一种配置对象往往对应一种
`kAudioUnitType_Effect` 类型的 Audio Unit。如果你熟悉 Audio Unit，你会发现每一种
`kAudioUnitType_Effect` 的子类型，SDK 中都有一种配置类与之对应。
例如，sub type 为 `kAudioUnitSubType_Reverb2` 的 Audio Unit 在 SDK 中对应的配置类为
`PLAudioEffectReverb2Configuration`。而 Reverb2 的所有可使用的属性都可以在
`PLAudioEffectReverb2Configuration` 的成员变量中找到。你可以通过
id effect = [PLAudioEffectReverb2Configuration defaultConfiguration];
来构造一个所有成员变量都取默认值的配置对象。然后，通过类似
...
effect.gain = 0.8;
effect.decayTimeAt0Hz = 1.2;
...
来设置构造好的配置对象的属性。
至此，你应该已经明白了如何构造任何你想要的音效配置了。
* 首先,你需要查找 Apple 的 Audio Unit 的 API 文档,在所有 type 为
kAudioUnitType_Effect 的 Audio Unit 中挑选一个 sub type，作为你想要的音效，然后根据 sub type 的名字找到
SDK 中对应的配置类。例如，在之前的例子中，sub type 为 kAudioUnitSubType_Reverb2，因此配置类的名字为
PLAudioEffectReverb2Configuration。
* 之后调用 [PLAudioEffectXXXConfiguration defaultConfiguration] 来
构造一个全部属性为默认值的配置对象。
* 调整属性的值，来得到你想要的音效效果。
* 重复之前的步骤，直到构造出所有你需要的音效配置对象，并全部装入一个
数组。
* 通过设置 mediaStreamingSession.audioEffectConfigurations =
@[…]; 来让你之前准备的音效配置生效。
除了与 Audio Unit
一一对应的音效配置类，我们还提供了预设的音效类，PLAudioEffectModeConfiguration。你可以通过如下三个方法获取三种预设混响音效配置
[PLAudioEffectModeConfiguration reverbLowLevelModeConfiguration];
[PLAudioEffectModeConfiguration reverbMediumLevelModeConfiguration];
[PLAudioEffectModeConfiguration reverbHeightLevelModeConfiguration];
mediaStreamingSession.audioEffectConfigurations 这个数组里的音效配置对象是有顺序的，这个顺序最终将和
Audio Unit 在 AUGraph 中的顺序保持一致。如果你不了解 Audio Unit 在 AUGraph
中的顺序对最终产生的音效有什么影响，其实也无妨，实际上你随意地将音频对象排列最终产生的效果用肉耳听起来差别也不大（若你有更高的追求，那么你需要理解这个顺序的意义）。
## 1.10 混音
当前版本的 SDK
允许主播在推流的同时，播放本地音频文件。主播麦克风录入的声音，在经过音效处理(如果有)后，会与音频文件的内容混合，然后推流出去让观众听到。同时，如果主播开启了返听功能，亦可以从耳机听到音频文件播放出的声音。
场景举例：直播中，主播唱歌，通过播放音频文件来获得伴奏。结合返听功能，主播可以从耳机听到伴奏音乐以及自己的唱出的歌声。同时观众最终听到的也是混合了伴奏的主播的歌声。
要开启音频文件播放功能,首先需要构造播放器实例,通过如下方法构造
PLAudioPlayer *player = [mediaStreamingSession audioPlayerWithFilePath:@"audio file path"];
之后，所有与音频文件播放相关的功能就都基于 `player` 进行了。
当你播放完音频文件之后，且不打算再使用该功能时，需要释放掉 player，可通过调用
[mediaStreamingSession closeCurrentAudio];
来释放之前获取的播放器实例。
**注意：播放器使用完必须关闭，否则它将一直占用着资源（例如音频文件的句柄）。**
每当音频文件播放完毕，会回调如下方法询问你是否把该音频文件重新播放一遍
- (BOOL)didAudioFilePlayingFinishedAndShouldAudioPlayerPlayAgain:(PLAudioPlayer *)audioPlayer
该方法可以让你知道音频文件什么时候播放完毕，同时通过返回一个 BOOL 值，来控制播放器的行为。例如，如果你想做单曲循环效果，可以如此实现该方法
- (BOOL)didAudioFilePlayingFinishedAndShouldAudioPlayerPlayAgain:(PLAudioPlayer *)audioPlayer {
return YES;
}
如果你想实现顺序播放效果，可以如此实现该方法
- (BOOL)didAudioFilePlayingFinishedAndShouldAudioPlayerPlayAgain:(PLAudioPlayer *)audioPlayer {
audioPlayer.audioFilePath = @"/path/to/next/audio/file/name.mp3";
return YES;
}
## 1.11 SRT 协议
SDK 默认采用 rtmp 协议推流，如果你想实现 SRT 协议推流，仅需两步即可开启 SRT 协议推流，其他步骤无需改变
* 开启 SRT 协议支持：
@property (nonatomic, assign) PLProtocolModel protocolModel
* 获取符合标准的 SRT 推流地址：
SRT 协议推流地址需符合官方标准，详情可参考 [access-control
__](https://github.com/Haivision/srt/blob/master/docs/features/access-
control.md#general-syntax)，示例如下：
srt://pili-publish.qnsdk.com?streamid=#!::h=sdk-live/xxx,m=publish
其中，h 对应您七牛云直播空间下的 _空间名/streamID_
# 2 DNS 优化
在大陆一些地区或特别的运营商线路，存在较为普遍的 DNS 劫持问题，而这对于依赖 DNS 解析 rtmp 流地址的
`PLMediaStreamingKit` 来说是很糟糕的情况，为了解决这一问题，我们引入了 `HappyDNS` 这个库，以便可以实现
httpDNS，localDNS 等方式解决这类问题。
## 2.1 HappyDNS
你可以[点击这里 __](https://github.com/qiniu/happy-dns-objc)跳转到`HappyDNS` 的 GitHub
主页，在那里查看更详细的介绍和使用。
默认情况下，你所创建的 `PLMediaStreamingSession` 对象，内部持有一个 `HappyDNS` 对应的 manager
对象，来负责处理 DNS 解析。
如果你期望按照不同的规则来做 DNS 解析，那么你可以在创建 `PLMediaStreamingSession` 前，创建好自己的
`QNDnsManager` 对象，我们在 `PLMediaStreamingSession` 中提供了一个 init 方法满足这类需求，你可以传递自己的
`QNDnsManager` 对象给 `PLMediaStreamingSession`，从而定制化 DNS 解析。
# 3 流状态获取
在 `PLMediaStreamingKit` 中，通过反馈 `PLMediaStreamingSession`
的状态来反馈流的状态。我们定义了几种状态，确保 `PLMediaStreamingSession` 对象在有限的几个状态间切换，并可以较好的反应流的状态。
状态名 | 含义
---|---
PLStreamStateUnknow | 初始化时指定的状态，不会有任何状态会跳转到这一状态
PLStreamStateConnecting | RTMP 流链接中的状态
PLStreamStateConnected | RTMP 已连接成功时的状态
PLStreamStateDisconnecting | RTMP 正常断开时，正在断开的状态
PLStreamStateDisconnected | RTMP 正常断开时，已断开的状态
PLStreamStateAutoReconnecting | 正在等待自动重连状态
PLStreamStateError | 因非正常原因导致 RTMP 流断开，如包发送失败、流校验失败等
## 3.1 state 状态回调
state 状态对应的 Delegate 回调方法是
- (void)mediaStreamingSession:(PLMediaStreamingSession *)session streamStateDidChange:(PLStreamState)state;
只有在正常连接，正常断开的情况下跳转的状态才会触发这一回调。所谓正常连接是指通过调用 `-startStreamingWithFeedback:`
方法使得流连接的各种状态，而所谓正常断开是指调用 `-stopStreaming` 方法使得流断开的各种状态。所以只有以下四种状态会触发这一回调方法。
* PLStreamStateConnecting
* PLStreamStateConnected
* PLStreamStateDisconnecting
* PLStreamStateDisconnected
## 3.2 error 状态回调
error 状态对应的 Delegate 回调方法是
- (void)mediaStreamingSession:(PLMediaStreamingSession *)session didDisconnectWithError:(NSError *)error;
除了调用 `-stopStreaming` 之外的所有导致流断开的情况，都被归属于非正常断开的情况，此时就会触发该回调。对于错误的处理，我们不建议触发了一次
error 后就停掉，最好可以在此时尝试有限次数的重连，详见重连小节。
## 3.3 status 状态回调
除了 state 作为流本身状态的切换，我们还提供了流实时情况的反馈接口
- (void)mediaStreamingSession:(PLMediaStreamingSession *)session streamStatusDidUpdate:(PLStreamStatus *)status;
默认情况下，该回调每隔 3s 调用一次，每次包含了这 3s 内音视频的 fps 和总共的码率（注意单位是 kbps）。你可以通过
`PLMediaStreamingSession` 的 statusUpdateInterval 属性来读取或更改这个回调的间隔。
## 3.4 产品层面的反馈
status 的状态回调可以很好的反应发送情况，及网络是否流畅，是否拥塞。所以此处可以作为产品层面对弱网情况决策的一个入口。
一般的，当 status.videoFPS 比预设的 FPS 明显小时（小于等于
20%），并且维持几秒都是如此，那么就可以判定为当前主播所在的网络为弱网环境，可以给主播视觉上的提示，或者主动降低编码配置，甚至直接断掉主播的流，这些都由具体的产品需求而定，而此处只是给出一个入口的提示和建议。
# 4 网络异常处理
直播中，网络异常的情况比我们能意料到的可能会多不少，常见的情况一般有
* 网络环境切换，比如 3G/4G 与 Wi-Fi 环境切换
* 网络不可达，网络断开属于这一类
* 带宽不足，可能触发发送失败
* 上行链路不佳，直接影响流发送速度
作为开发者我们不能乐观的认为只要是 Wi-Fi 网就是好的，因为即便是 Wi-Fi
也有可能因为运营商上行限制，共享网络带宽等因素导致以上网络异常情况的出现。
为何在直播中要面对这么多的网络异常情况，而在其他上传/下载中很少遇到的，这是因为直播对实时性的要求使得它不得面对这一情况，即无论网络是否抖动，是否能一直良好，直播都要尽可能是可持续，可观看的状态。
## 4.1 重连
`PLMediaStreamingSession` 内置了自动重连功能，但默认处于关闭状态。之所以默认关闭，一方面是考虑到 App
的业务逻辑场景多样而负责，对于直播重连的次数、时机、间隔都会有不同的需求，此时让开发者自己来决定是否重连，以及尝试重连的次数会更加合理；另一方面是兼容旧版本业务层面可能已实现的自动重连逻辑。
如果你想直接使用内置的自动重连功能，可通过将 `PLMediaStreamingSession` 的 `autoReconnectEnable` 属性设置为
`YES` 来开启，并需要注意如下几点：
* 自动重连次数上限目前设定为 3 次，重连的等待时间会由首次的 0~2s 之间逐步递增到第三次的 4~6s 之间
* 等待重连期间，`streamState` 处于 `PLStreamStateAutoReconnecting` 状态，业务层可根据该状态来更新用户界面
* 网络异常的 error Delegate 回调只有在达到最大重连次数后还未连接成功时才会被触发
若你想自己实现自动重连逻辑，可以利用以下网络异常所触发的 error Delegate 回调接口来添加相应的逻辑：
- (void)mediaStreamingSession:(PLMediaStreamingSession *)session didDisconnectWithError:(NSError *)error;
你可以在这个方法内通过重新调用 `-startStreamingWithFeedback:`
方法来尝试重连。此处建议不要立即重连，而是采用重连间隔加倍的方式，比如共尝试 3 次重连，第一次等待 0.5s, 第二次等待 1s, 第三次等待
2s，这样的方式主要考虑到弱网时网络带宽的缓解需要时间，而加倍重连可以更容易在网络恢复的时候连接，而非在网络已经拥塞时还不断做无用功的重连。
`PLMediaStreamingSession` 内置了网络切换监测功能，但默认处于关闭状态。开启后，网络在 WWAN(3G/4G) 和 Wi-Fi
之间相互切换时，我们提供了一个回调 `connectionChangeActionCallback` 属性，它的函数签名如下
typedef BOOL(^ConnectionChangeActionCallback)(PLNetworkStateTransition transition);
该回调函数传入参数为当前网络的切换状态 `PLNetworkStateTransition`。
返回值为布尔值，YES表示在某种切换状态下允许推流自动重启，NO则代表该状态下不应自动重启。例如在
`PLNetworkStateTransitionWWANToWiFi` 状态，即网络从 3G/4G 切换到 Wi-Fi
后，基于节省流量等需求考虑，你可能需要进行一次快速的重连，使得数据可以通过 Wi-Fi 网络发送，此时返回 `YES` 即可。反之，如果推流过程中 Wi-
Fi 断掉切换到 3G/4G，此时在未征得用户同意使用移动流量推流时，可返回 `NO` 不自动重启推流。以下为参考逻辑
session.connectionChangeActionCallback = ^(PLNetworkStateTransition transition) {
switch (transition) {
case PLNetworkStateTransitionWWANToWiFi:
return YES;
case PLNetworkStateTransitionWiFiToWWAN:
return NO;
default:
break;
}
return NO;
};
如果该属性未被初始化赋值，则 SDK 内部出于节省用户移动网络流量的目的，会默认在 Wi-Fi 切换到 3G/4G
时断开推流。此时，你可以自行监听网络状态，调用 `-restartStreamingWithFeedback:` 方法来快速重连。
## 4.2 弱网优化
移动直播过程中存在着各种各样的网络挑战。由于无线网络相对于有线网络，可靠性较低，会经常遇到信号覆盖不佳导致的高丢包、高延时等问题，特别是在用网高峰期，由于带宽有限，网络拥塞的情况时有发生。自
[v2.1.3 __](https://github.com/pili-
engineering/PLMediaStreamingKit/releases/tag/v2.1.3)起，`PLMediaStreamingKit`
内置了一套弱网优化方案，可以满足以下两个诉求：
* 能动态地适应网络质量，即在质量不佳的网络下，能够自动下调视频编码的输出码率和帧率，而当网络质量恢复稳定时，输出码率和帧率也应得到相应回升，并能在调节过程中使得码率与帧率变化相对平稳。
* 在直播端网络质量稳定时，确保编码器输出的码率和帧率恒定在一个期望的最高值，以提供良好的清晰度和流畅度。
这套弱网优化方案包含两个工作模块：
* 自适应码率模块，能够在期望码率与设定的最低码率间做出调节，适应网络抖动引发的数据带宽变化。
* 动态帧率模块，能够在期望帧率与一个最低帧率间做出调节，动态调整输出的视频数据量。
这两个模块可并行工作，可以单独开启或关闭，开发者可根据自己的业务场景来决定该方案的应用形态。一般情况下，如果开发者想使用该解决方案，建议将两个调节模块都开启，可达到我们测试的最佳效果。利用码率与帧率调整相互配合作用，一方面有效控制网络波动情况下的音视频数据发送量，缓解网络拥塞，同时又能给播放端带来流畅的观看体验；另一方面在网络质量恢复时能够确保音视频的码率帧率是以设定的最优质量配置进行推流，并且能使不同码率帧率配置切换时以一种更为平滑的方式进行，不会给观看端带来画质波动的突兀感。
自适应码率调节可以通过 `PLMediaStreamingSession` 的如下接口开启:
- (void)enableAdaptiveBitrateControlWithMinVideoBitRate:(NSUInteger)minVideoBitRate;
其关闭接口为:
- (void)disableAdaptiveBitrateControl;
开启该机制时，需设置允许向下调节的最低码率（注意其单位为 bps，如设置最低为 200 Kbps，应传入参数值为
200*1024），以便使自动调整后的码率不会低于该范围。该机制根据网络吞吐量及 TCP
发送时间来调节推流的码率，在网络带宽变小导致发送缓冲区数据持续增长时，SDK
内部将适当降低推流码率，若情况得不到改善，则会重复该过程直至平均码率降至用户设置的最低值；反之，当一段时间内网络带宽充裕，SDK
将适当增加推流码率，直至达到预设的推流码率。
动态帧率的开关为 `PLMediaStreamingSession` 的 `dynamicFrameEnable`
属性，开启后，自动调整的最大帧率不会超过预设在 `videoStreamingConfiguration` 配置中的
`expectedSourceVideoFrameRate`，最低不会小于 10 FPS。
默认情况下，这两个模块处于关闭状态，是为了兼容旧版本中开发者可能已自行实现的弱网调节机制。若开发者想使用我们的内置方案，请确保您自定义的机制已被关闭。
# 5 水印和美颜
## 5.1 水印
`PLMediaStreamingKit`
支持内置水印功能，你可以根据自己的需要添加水印或移除水印，并且能够自由设置水印的大小和位置。需要注意的是水印功能对预览和直播流均生效。
添加水印
-(void)setWaterMarkWithImage:(UIImage *)wateMarkImage position:(CGPoint)position;
该方法将为直播流添加一个水印，水印的大小由 `wateMarkImage` 的大小决定，位置由 position
决定，需要注意的是这些值都是以采集数据的像素点为单位的。例如我们使用 `AVCaptureSessionPreset1280x720` 进行采集，同时
`wateMarkImage.size` 为 `(100, 100)` 对应的 `origin` 为 `(200, 300)`，那么水印的位置将在大小为
`1280x720` 的采集画幅中位于 `(200, 300)` 的位置，大小为 `(100, 100)`。
移除水印
-(void)clearWaterMark;
该方法用于移除已添加的水印
## 5.2 美颜
‘PLMediaStreamingSession’
支持内置美颜功能，你可以根据自己的需要选择开关美颜功能，并且能够自由调节包括美颜，美白，红润等在内的参数。需要注意的是水印功能对预览和直播流均生效。
按照默认参数开启或关闭美颜
-(void)setBeautifyModeOn:(BOOL)beautifyModeOn;
设置美颜程度，范围为 0 ~ 1
-(void)setBeautify:(CGFloat)beautify;
设置美白程度，范围为 0 ~ 1
-(void)setWhiten:(CGFloat)whiten;
设置红润程度，范围为 0 ~ 1
-(void)setRedden:(CGFloat)redden;
# 6 录屏推流
`PLStreamingKit` 支持 iOS 10 新增的录屏推流 ([`ReplayKit Live`
__](https://developer.apple.com/reference/replaykit)) 功能，开发者可通过构建[App
Extension __](https://developer.apple.com/app-extensions)来调用推流 API
实现实时游戏直播等功能。需要注意的是，实时直播需要游戏或 App 本身实现对`ReplayKit` 的支持。
## 6.1 创建 Broadcast Upload Extension
在原有直播 App 中添加一个类型为 `Broadcast Upload Extension` 的新 Target，如图所示：
Xcode 会额外自动创建一个类型为 `Broadcast UI Extension` 的 Target，用于显示调用 `Broadcast Upload
Extension` 的用户界面。
## 6.2 添加推流管理类
创建推流 API 调用管理类，添加头文件引用：
#import <PLMediaStreamingKit/PLStreamingKit.h>
头文件参考
#import <Foundation/Foundation.h>
#import <PLMediaStreamingKit/PLStreamingKit.h>
@interface BroadcastManager : NSObject
@property (nonatomic, strong) PLStreamingSession *session;
+ (instancetype)sharedBroadcastManager;
- (PLStreamState)streamState;
- (void)pushVideoSampleBuffer:(CMSampleBufferRef)sampleBuffer;
- (void)pushAudioSampleBuffer:(CMSampleBufferRef)sampleBuffer withChannelID:(const NSString *)channelID;
@end
类实现参考
@interface BroadcastManager ()<PLStreamingSessionDelegate>
@end
@implementation BroadcastManager
static BroadcastManager *_instance;
- (instancetype)init
{
if (self = [super init]) {
[PLStreamingEnv initEnv];
PLVideoStreamingConfiguration *videoConfiguration = [[PLVideoStreamingConfiguration alloc] initWithVideoSize:CGSizeMake(1280, 720) expectedSourceVideoFrameRate:24 videoMaxKeyframeInterval:24*3 averageVideoBitRate:1000*1024 videoProfileLevel:AVVideoProfileLevelH264High41];
PLAudioStreamingConfiguration *audioConfiguration = [PLAudioStreamingConfiguration defaultConfiguration];
audioConfiguration.inputAudioChannelDescriptions = @[kPLAudioChannelApp, kPLAudioChannelMic];
self.session = [[PLStreamingSession alloc] initWithVideoStreamingConfiguration:videoConfiguration
audioStreamingConfiguration:audioConfiguration
stream:nil];
self.session.delegate = self;
#warning 以下 pushURL 需替换为一个真实的流地址
NSString *pushURL = nil;
dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(0.5 * NSEC_PER_SEC)), dispatch_get_main_queue(), ^{
[self.session startWithPushURL:[NSURL URLWithString:pushURL] feedback:^(PLStreamStartStateFeedback feedback) {
if (PLStreamStartStateSuccess == feedback) {
NSLog(@"connect success");
} else {
NSLog(@"connect failed");
}
}];
});
}
return self;
}
+ (void)initialize
{
_instance = [[BroadcastManager alloc] init];
}
- (PLStreamState)streamState
{
return self.session.streamState;
}
- (void)pushVideoSampleBuffer:(CMSampleBufferRef)sampleBuffer
{
[self.session pushVideoSampleBuffer:sampleBuffer];
}
- (void)pushAudioSampleBuffer:(CMSampleBufferRef)sampleBuffer withChannelID:(const NSString *)channelID
{
[self.session pushAudioSampleBuffer:sampleBuffer withChannelID:channelID completion:nil];
}
+ (instancetype)sharedBroadcastManager
{
return _instance;
}
// 实现其他必要的协议方法
- (void)streamingSession:(PLStreamingSession *)session didDisconnectWithError:(NSError *)error
{
NSLog(@"error : %@", error);
}
- (void)streamingSession:(PLStreamingSession *)session streamStatusDidUpdate:(PLStreamStatus *)status
{
NSLog(@"%@", status);
}
@end
注意 `PLAudioStreamingConfiguration` 实例生成时必需注册音频流来源
audioConfiguration.inputAudioChannelDescriptions = @[kPLAudioChannelApp, kPLAudioChannelMic];
其中 `kPLAudioChannelApp` 对应于 `RPSampleBufferTypeAudioApp`，是 ReplayKit Live 回调的
app 音频数据，`kPLAudioChannelMic` 对应于 `RPSampleBufferTypeAudioMic`，是 ReplayKit
Live 回调的 mic 音频数据。之所以需要显示声明，是为了在 PLStreamingKit 在音频编码前将两路音频流进行混音。
在自动生成的 `SampleHandler.m` 中实现 `RPBroadcastSampleHandler` 协议部分方法如下：
- (void)processSampleBuffer:(CMSampleBufferRef)sampleBuffer withType:(RPSampleBufferType)sampleBufferType {
if ([BroadcastManager sharedBroadcastManager].streamState == PLStreamStateConnected) {
switch (sampleBufferType) {
case RPSampleBufferTypeVideo:
// Handle video sample buffer
[[BroadcastManager sharedBroadcastManager] pushVideoSampleBuffer:sampleBuffer];
break;
case RPSampleBufferTypeAudioApp:
// Handle audio sample buffer for app audio
[[BroadcastManager sharedBroadcastManager] pushAudioSampleBuffer:sampleBuffer withChannelID:kPLAudioChannelApp];
break;
case RPSampleBufferTypeAudioMic:
// Handle audio sample buffer for mic audio
[[BroadcastManager sharedBroadcastManager] pushAudioSampleBuffer:sampleBuffer withChannelID:kPLAudioChannelMic];
break;
default:
break;
}
}
}
## 6.3 一些注意点
如果你使用 CocoaPods 管理依赖库，可能会在编译 broadcast extension target 时遇到 link error，此时请检查
Podfile 里是否为 broadcast extension target 添加相应的依赖；或者可检查以下工程设置是否更改：
# 7 后台推图片
App
一旦切到后台，摄像头的采集功能会被系统暂停掉，观众会看到主播的画面会卡住，此时如果能推送一张图片告诉观众主播进入后台了，将带来更好的观看体验。具体实现方法如下：开发者需要自行监听
App 进入后台/前台的通知，当App 进入后台时，使用 PLMediaStreamingSession 的如下接口
- (void)setPushImage:(nullable UIImage *)image;
设置一张推流图片，PLMediaStreamingSession 会持续为您推送该图片，当 App 返回前台不再需要推送图片时，重新调用以上接口并传入
nil 即可。
# 8 QUIC 推流
QUIC 是基于 UDP 开发的可靠传输协议，在弱网下拥有更好的推流效果，相比于 TCP 拥有更低的延迟，可抵抗更高的丢包率。可通过下面接口开启/关闭
QUIC 推流：
@property (nonatomic, assign, getter=isQuicEnable) BOOL quicEnable;
# 9 HEVC 编码推流
通过 PLVideoStreamingConfigutaion 初始化方法，设置 videoCodecType 视频编码类型为
PLVideoCodecType_HEVC，便可以使用 HEVC 编码推流。具体初始化方法如下：
- (instancetype)initWithVideoSize:(CGSize)videoSize
expectedSourceVideoFrameRate:(NSUInteger)expectedSourceVideoFrameRate
videoMaxKeyframeInterval:(NSUInteger)videoMaxKeyframeInterval
averageVideoBitRate:(NSUInteger)averageVideoBitRate
videoCodecType:(PLVideoCodecType)videoCodecType;
开始推流时，我们会收到使用的编码器类型回调。
由于 HEVC 编码仅支持 iPhone7 及以上设备和 iOS11及以上系统，如果不支持上述条件会回退到 H264 编码推流。
- (void)streamingSession:(PLStreamingSession *)session videoCodecDidChange:(PLVideoCodecType)codecType;
推流过程中，如果连续 3*fps 编码失败，会回调错误码 PLStreamErrorEncoderEncodeFailed，并停止推流 ：
- (void)mediaStreamingSession:(PLMediaStreamingSession *)session didDisconnectWithError:(NSError *)error;
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,309 |
知识补充与建议 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 推流端 >iOS 推流端 SDK >知识补充与建议
# 知识补充与建议
最近更新时间: 2017-06-29 16:06:57
# 1 编码相关参数说明
## 1.1 码率、fps、分辨率对清晰度及流畅度的影响
对于码率（BitRate）、FPS（video frame per
second）、分辨率（VideoSize）三者的关系，有必要在这里做一些说明，以便你根据自己产品的需要可以有的放矢的调节各个参数。
一个视频流个人的感受一般来说会有卡顿、模糊等消极的情况，虽然我们都不愿意接受消极情况的出现，但是在 UGC 甚至 PGC
的直播场景中，都不可避免的要面对。因为直播推流实时性很强烈，所以为了保证这一实时性，在网络带宽不足或者上行速度不佳的情况下，都需要做出选择。
要么选择更好的流程度但牺牲清晰度（模糊），要么选择更好的清晰度但牺牲流畅度（卡顿），这一层的选择大多由产品决定。
一般来说，当选定了一个分辨率后，推流过程中就不会对分辨率做变更，但可以对码率和 FPS 做出调节，从而达到上述两种情况的选择。
效果 | 码率 | FPS
---|---|---
流畅度 | 负相关 | 正相关
清晰度 | 正相关 | 负相关
通过这个关联，我们就可以容易的知道该如何从技术层面做出调整。在追求更好的流畅度时，我们可以适当降低码率，如果 FPS 已经较高（如 30）时，可以维持
FPS 不变更，如果此时因为码率太低而画面无法接受，可以再适当调低 FPS；在追求更清晰的画质时，可以提高码率，FPS 调节至 24
左右人眼大多还会识别为流畅，如果可以接受有轻微卡顿，那么可以将 FPS 设置的更低，比如 20 甚至 15。
总之，这三者之间一起构建其了画面清晰和视频流畅的感觉，但最终参数是否能满意需要自己不断调整和调优，从而满足产品层面的需求。
# 2 丢帧策略
这一章节，我们谈谈丢帧策略，这关乎最终的直播观看体验，这里我们主要说明为何需要它，以及它带来的利弊。
## 2.1 丢帧策略的必要性
我想可能没有人会喜欢在直播中出现丢帧，但是为何我们一定要实现并提供它呢？这是我们在最初提供出丢帧策略时也在反复考虑和一再讨论过的一个问题。
原因很简单，为了保证直播的实时性。
直播作为有别于录播的富媒体传播手段，它的第一要素就是实时，没有了实时，直播的价值就会荡然无存。保证实时性就需要确保录制端的数据尽可能少的累积，尽可能快的发送，但如果没有丢帧策略，在弱网环境下，就会因为待发送数据的不断堆积而产生累计延时，最终带来延时越来越大的情况。作为推流的发起端和推送端，推流
SDK
要考虑的还不单单是实时性这一点，因为移动设备的内存有限，而视频数据对内存的占用较大，所以在推流时还要确保不会因为待发送数据堆积过多而带来内存吃紧，触发
crash 等严重问题。所以我们需要也一定要在推流端提供丢帧策略。
丢帧的方式可以有很多种，其中有些较为粗暴，会触发各类问题，比如花屏，爆音，音画不同步等问题，在反复尝试和验证了各类的丢帧策略后，我们最终选定了优先保证音频传输且不触发花屏、爆音、音画不同步问题的技术方案。这一方案可以保证在带宽不足或上行速度不佳时，优先丢弃视频帧，保证音频的持续传输，在观看端至多出现画面跳帧的情况，但声音会是连续的片段，体验上不会认为是推流端断网，确保直播的继续进行。
## 2.2 利弊
丢帧策略固然保证了直播的实时性和推流端相对的稳定性，但是它的弊端也是显然的，就是会带来观看端体验的不佳。
面对并接受这一弊端是必要，这样才可以做出更好的产品决策，我们建议从产品层面至少需要考虑两点
* 在主播弱网情况下，观看端体验要保证流畅度优先还是清晰度优先
* 在主播弱网情况下，尽可能让主播自己知晓自己网络不佳这一事实
对于流畅度和清晰度的问题，可以参考上述1.1小节。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 推流端 >iOS 推流端 SDK >知识补充与建议
# 知识补充与建议
最近更新时间: 2017-06-29 16:06:57
# 1 编码相关参数说明
## 1.1 码率、fps、分辨率对清晰度及流畅度的影响
对于码率（BitRate）、FPS（video frame per
second）、分辨率（VideoSize）三者的关系，有必要在这里做一些说明，以便你根据自己产品的需要可以有的放矢的调节各个参数。
一个视频流个人的感受一般来说会有卡顿、模糊等消极的情况，虽然我们都不愿意接受消极情况的出现，但是在 UGC 甚至 PGC
的直播场景中，都不可避免的要面对。因为直播推流实时性很强烈，所以为了保证这一实时性，在网络带宽不足或者上行速度不佳的情况下，都需要做出选择。
要么选择更好的流程度但牺牲清晰度（模糊），要么选择更好的清晰度但牺牲流畅度（卡顿），这一层的选择大多由产品决定。
一般来说，当选定了一个分辨率后，推流过程中就不会对分辨率做变更，但可以对码率和 FPS 做出调节，从而达到上述两种情况的选择。
效果 | 码率 | FPS
---|---|---
流畅度 | 负相关 | 正相关
清晰度 | 正相关 | 负相关
通过这个关联，我们就可以容易的知道该如何从技术层面做出调整。在追求更好的流畅度时，我们可以适当降低码率，如果 FPS 已经较高（如 30）时，可以维持
FPS 不变更，如果此时因为码率太低而画面无法接受，可以再适当调低 FPS；在追求更清晰的画质时，可以提高码率，FPS 调节至 24
左右人眼大多还会识别为流畅，如果可以接受有轻微卡顿，那么可以将 FPS 设置的更低，比如 20 甚至 15。
总之，这三者之间一起构建其了画面清晰和视频流畅的感觉，但最终参数是否能满意需要自己不断调整和调优，从而满足产品层面的需求。
# 2 丢帧策略
这一章节，我们谈谈丢帧策略，这关乎最终的直播观看体验，这里我们主要说明为何需要它，以及它带来的利弊。
## 2.1 丢帧策略的必要性
我想可能没有人会喜欢在直播中出现丢帧，但是为何我们一定要实现并提供它呢？这是我们在最初提供出丢帧策略时也在反复考虑和一再讨论过的一个问题。
原因很简单，为了保证直播的实时性。
直播作为有别于录播的富媒体传播手段，它的第一要素就是实时，没有了实时，直播的价值就会荡然无存。保证实时性就需要确保录制端的数据尽可能少的累积，尽可能快的发送，但如果没有丢帧策略，在弱网环境下，就会因为待发送数据的不断堆积而产生累计延时，最终带来延时越来越大的情况。作为推流的发起端和推送端，推流
SDK
要考虑的还不单单是实时性这一点，因为移动设备的内存有限，而视频数据对内存的占用较大，所以在推流时还要确保不会因为待发送数据堆积过多而带来内存吃紧，触发
crash 等严重问题。所以我们需要也一定要在推流端提供丢帧策略。
丢帧的方式可以有很多种，其中有些较为粗暴，会触发各类问题，比如花屏，爆音，音画不同步等问题，在反复尝试和验证了各类的丢帧策略后，我们最终选定了优先保证音频传输且不触发花屏、爆音、音画不同步问题的技术方案。这一方案可以保证在带宽不足或上行速度不佳时，优先丢弃视频帧，保证音频的持续传输，在观看端至多出现画面跳帧的情况，但声音会是连续的片段，体验上不会认为是推流端断网，确保直播的继续进行。
## 2.2 利弊
丢帧策略固然保证了直播的实时性和推流端相对的稳定性，但是它的弊端也是显然的，就是会带来观看端体验的不佳。
面对并接受这一弊端是必要，这样才可以做出更好的产品决策，我们建议从产品层面至少需要考虑两点
* 在主播弱网情况下，观看端体验要保证流畅度优先还是清晰度优先
* 在主播弱网情况下，尽可能让主播自己知晓自己网络不佳这一事实
对于流畅度和清晰度的问题，可以参考上述1.1小节。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,348 |
历史记录 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 推流端 >iOS 推流端 SDK >历史记录
# 历史记录
最近更新时间: 2024-05-31 16:58:53
* 3.1.1 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-3.1.1.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-3.1.1.md))
* 功能
* 支持推流过程中修改 fps
* 缺陷
* 修复 iOS 17.4.1 SRT 无法推流
* 修复 HEVC 编码，HLS 拉流异常
* 修复其它已知问题
* 3.1.0 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-3.1.0.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-3.1.0.md))
* 功能
* 支持 HEVC 编码推流
* 支持发送 HEVC SEI 信息
* 缺陷
* 修复 iOS16 不能图片推流的问题
* 3.0.8 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-3.0.8.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-3.0.8.md))
* 功能
* 支持进程内动态替换 userUID
* 支持编码时设置图像填充模式
* 优化 HappyDNS 内置解析 ip
* 缺陷
* 解决连续频繁切换摄像头卡主线程的问题
* 解决蓝牙耳机听歌切推流音乐会短暂外放的问题
* 解决停止推流服务端未收到正常断开指令的问题
* 解决找不到 compare 方法导致出现闪退的问题
* 解决鉴权时间在本地记录转换格式的问题
* 3.0.7 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-3.0.7.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-3.0.7.md))
* 功能
* 更新 HappyDNS 版本至 1.0.0
* 图片推流模式下支持添加贴纸、水印
* 优化鉴权服务请求处理
* 3.0.6 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-3.0.6.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-3.0.6.md))
* 缺陷
* iOS 15 硬编码视频 pts 统计有误
* 3.0.5 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-3.0.5.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-3.0.5.md))
* 功能
* 支持 srt 协议推流
* 缺陷
* 修复混音素材无法切换
* 3.0.4 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-3.0.4.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-3.0.4.md))
* 缺陷
* 视频卡顿
* 扩展录屏混音异常
* 扩展录屏偶现视频无法推流
* 3.0.3 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-3.0.3.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-3.0.3.md))
* 功能
* 支持获取麦克风数据 asbd 信息
* 支持重新加载音频推流编码配置信息
* 流信息回调新增音视频码率信息
* 缺陷
* 修复摄像头未授权情况下设置动态码率 crash 的问题
* 修复快速多次 start 后立即 stop 视频仍在发布的问题
* 解决 reloadConfiguration 更改编码帧率无效的问题
* 解决连接蓝牙耳机后采集实际输入源是设备麦克风的问题
* 修复音频采集配置 44100 长时间推流拉流端音画不同步的问题
* 修复使用带声音的三方键盘及蓝牙耳机同时连接电脑手机 message 线程偶现 crash 的问题
* 3.0.2 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-3.0.2.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-3.0.2.md))
* 缺陷
* 修复 Xcode 12 版本编译报错的问题
* 3.0.1 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-3.0.1.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-3.0.1.md))
* 优化
* SEI 数据 payload size 支持大于 255 字节
* 缺陷
* 修复扩展录屏配置 kPLAudioChannelApp + kPLAudioChannelMic 在 iOS 13.1.1 上推流频繁断流的问题
* 3.0.0 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-3.0.0.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-3.0.0.md))
* 功能
* 新增包名鉴权功能
* 缺陷
* 修复 App 调试时音频数据数组越界的问题
* 修复 broadcast 下扩展录屏配置 kPLAudioChannelApp + kPLAudioChannelMic 组合存在内存泄漏的问题
* 优化开启动态帧率/码率时退前后台的反应时长
* 3.0.0 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-3.0.0.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-3.0.0.md))
* 功能
* 新增包名鉴权功能
* 缺陷
* 修复 App 调试时音频数据数组越界的问题
* 修复 broadcast 下扩展录屏配置 kPLAudioChannelApp + kPLAudioChannelMic 组合存在内存泄漏的问题
* 优化开启动态帧率/码率时退前后台的反应时长
* 2.3.5 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-2.3.5.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-2.3.5.md))
* 功能
* 支持混音支持麦克风音量调整
* 支持推流插入 SEI 功能
* 支持推流采集视频数据回调添加视频时间戳
* 2.3.4 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-2.3.4.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-2.3.4.md))
* 功能
* 支持在竖屏尺寸采集状态下推横屏尺寸的 buffer
* 支持视频帧 BGRA32、NV12 的旋转、裁剪及缩放
* 支持蓝牙耳机的音频采集
* 缺陷
* 修复 videoToolBox 编码时，进入后台 setPushImage 后黑屏的问题
* 修复 replaykit 录屏推流 AVFoundation 编码时，播放端画面大概率黑屏的问题
* 修复推流过程中音频被电话中断后无法恢复的问题
* 解决不在主线程访问 UI 的告警问题
* 2.3.3 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-2.3.3.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-2.3.3.md))
* 功能
* 支持 bitcode
* 优化
* 优化相机的对焦效果和曝光效果
* 优化 pod install 或 update 时进度缓慢的问题
* 缺陷
* 修复特殊场景下 Wi-Fi 和 4G 之间频繁切换偶现的预览画面卡住的问题
* 修复开始推流后 0.2 秒内音频爆音的问题
* 2.3.2 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-2.3.2.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-2.3.2.md))
* 功能
* 重构了音频采集模块，包含音频数据采集、背景音乐播放、混音、音效、返听。重构后，插入耳机与否，背景音乐的声音都会从扬声器/耳机发出。
* 支持在推流过程中往视频画面上添加多个静态图片和文字
* 2.3.1 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-2.3.1.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-2.3.1.md))
* 功能
* 添加 URL 签名超时推流失败回调
* 支持 SDK 真机和模拟器版本共存
* 缺陷
* 修复非 1935 端口的地址不能推流问题
* 2.3.0 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-2.3.0.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-2.3.0.md))
* 功能
* 支持 QUIC 推流功能
* 缺陷
* 修复某些机型在特定配置下推流画面不完整的问题
* 修复切换摄像头瞬间画面出现镜像的问题
* 2.2.5 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-2.2.5.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-2.2.5.md))
* 缺陷
* 修复偶现进入后台时崩溃的问题
* 修复偶现内存泄漏的问题
* 2.2.4 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-2.2.4.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-2.2.4.md))
* 缺陷
* 修复 iOS 11 设备上预览启动慢的问题
* 修复 iPhone X 设备上出现的 crash 问题
* 2.2.3 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-2.2.3.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-2.2.3.md))
* 缺陷
* 修复频繁设置 pushImage 内存未释放的问题
* 修复在 iOS 8.1 设备上预览画面卡住的问题
* 修复 VideoToolbox 编码方式下特定分辨率裁剪未居中的问题
* 修复推流超过 4.5 小时掉线的问题
* 修复 Xcode 9 下编译报错的问题
* 2.2.1 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-2.2.1.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-2.2.1.md))
* 功能
* 支持后台推静态图的功能
* 缺陷
* 修复 iOS 8.1 使用 VideoToolbox 编码失败的问题
* 修复 iOS 9 及以上系统当 App 进入 Inactive 状态时推流画面卡住的问题
* 2.2.0 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-2.2.0.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-2.2.0.md))
* 功能
* 音频采集支持回声消除功能
* 支持 HE-AAC 音频编码
* 缺陷
* 修复推流可能出现的内存泄露问题
* 修复横屏推流镜像功能失效的问题
* 修复特殊场景下偶现的崩溃
* 2.1.6 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-2.1.6.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-2.1.6.md))
* 功能
* 支持苹果 ATS 安全标准
* PLMediaStreamingSession 增加外部传入 QNDnsManager 的接口
* 缺陷
* 修复设置音效后内存泄漏的问题
* 修复设置推流镜像时预览画面会闪一下的问题
* 其它
* 废弃 PLCameraStreamingSession，请使用 PLMediaStreamingSession
* 2.1.5 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-2.1.5.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-2.1.5.md))
* 缺陷
* 修复推流预览在 app 退至后台一段时间后再返回前台时，有概率会卡住问题
* 修复开启 VideoToolbox 编码时，退至后台再返回前台时，编码数据无法输出问题
* 2.1.4 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-2.1.4.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-2.1.4.md))
* 功能
* 增加对 iOS 10 ReplayKit 录屏推流的支持
* 增加 VideoToolbox 视频硬件编码功能
* 增加人工报障和自动报障功能
* 缺陷
* 修复 iPhone 6s 及以上机型在 iOS 10 上的电流音问题
* 修复 iPhone 6 及以上机型在 iOS 10 上同时开启自动对焦和手动对焦功能时，手动对焦失效问题
* 优化
* 优化 RGB 转 YUV 的效率，去除对 libyuv 库的依赖
* 2.1.3 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-2.1.3.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-2.1.3.md))
* 缺陷
* 解决 iPhone 4s 及以下会 crash 的问题
* 2.1.2 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-2.1.2.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-2.1.2.md))
* 功能
* 增加截屏功能
* 增加自动网络检测功能
* 增加自适应码率功能
* 增加动态帧率功能
* 缺陷
* 修复音频未授权时 crash 的问题
* 修复所有已知 crash
* 修复前置摄像头无法缩放的问题
* 优化
* 优化不开美颜和水印时的性能
* 2.1.1 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-2.1.1.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-2.1.1.md))
* 缺陷
* 修复与 PLPlayerKit v2.2.3 符号冲突的问题
* 2.1.0 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-2.1.0.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-2.1.0.md))
* 功能
* 新增返听功能
* 新增内置音效功能，支持十余种音效与数十个参数自由调节
* 新增内置音频文件播放及混音推流功能
* 新增外部视频图像处理本地预览功能
* 缺陷
* 修复分享到微博和 qq 空间时可能出现的卡 UI 的问题
* 修复在流未连接的状态调用 restart 方法会出现只有视频没有声音的问题
* 修复初始化时自动对焦不生效的问题
* 修复一些偶发的 crash 问题
* 2.0.0 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-2.0.0.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-2.0.0.md))
* 功能
* 提供 PLCameraStreamingKit 和 PLStreamingKit 两个层次的 API
* 支持直接传入 stream URL 进行推流
* 提供推流节点调度功能
* 支持音频数据回调及处理功能
* 缺陷
* 修复orientation 在切换摄像头之后不起作用的问题
* 修复初始化之后 inputGain 获取到的值始终为 0 的问题
* 修复多种原因导致的死锁问题
* 修复弱网推流可能出现的内存泄露问题
* 修复特殊机器状态可能出现的 crash 问题
* 优化
* 优化对设备采样率的适配，推流过程中设备采样率变更将不再重新开始推流
* 1.8.1 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.8.1.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.8.1.md))
* 功能
* 更新依赖的 PLStreamingKit 到 1.2.5
* 新增自动重连功能，默认关闭
* 新增模拟器编译支持
* 水印和美颜功能调整为支持 iPhone 5、iPad 3、iPod touch 4 及以上设备
* 缺陷
* 修复已知场景可能存在的没有声音的问题
* 修复填充模式改变可能导致 preview 的 frame 发生改变的问题
* 修复触摸屏幕对焦无效的问题
* 修复无法正确设置采集相机位置的问题
* 修复 capture session 设置不正确可能导致 crash 的问题
* 修复偶尔出现的画面卡住无法正常推流的问题
* 1.8.0 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.8.0.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.8.0.md))
* 功能
* 更新依赖的 PLStreamingKit 到 1.2.4
* 新增内置美颜功能，美颜效果可调节
* 新增单独调节前后置摄像头预览及推流是否镜像的接口
* 新增动态帧率功能，通过降低采集帧率来适配弱网环境
* 缺陷
* 修复音视频时间戳偶尔出现的非单调递增的缺陷
* 修复特殊机型可能出现的没有声音的问题
* 优化
* 优化水印性能，降低 CPU 和内存消耗
* 1.7.2 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.7.2.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.7.2.md))
* 功能
* 更新依赖的 PLStreamingKit 到 1.2.2
* 新增回调队列配置功能
* 新增默认摄像头位置配置项
* 新增录制音量调节选项（由于系统原因，仅对除 iPhone 6s 系列以外的机型生效）
* 支持初始化的时候传入 stream 为 nil
* 支持快速重连操作，方便 4G 推流时切换 WIFI 场景快速切换网络
* 缺陷
* 修复特殊场景可能出现的电流音问题
* 修复特殊场景可能出现的没有声音的问题
* 修复后台推流时被音频打断结束之后无法正常恢复推流的问题
* 1.7.1 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.7.1.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.7.1.md))
* 缺陷
* 修复切换前置摄像头之后无法缩放的问题
* 修复不添加水印无法正常推流的问题
* 1.7.0 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.7.0.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.7.0.md))
* 功能
* 新增后台推流功能（仅音频，因 iOS 隐私限制不允许后台访问摄像头）
* 新增水印功能
* 新增可选定制美颜功能（需联系工作人员）
* 缺陷
* 修复特定机型上的电流音等杂音问题
* 版本
* 更新依赖 PLStreamingKit 的版本到 `v1.2.0`
* 其他
* 部分接口重命名
* 1.6.3 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.6.2.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.6.2.md))
* 更新依赖 PLStreamingKit 的版本到 `v1.1.6`
* 更新 Demo 适应 PLStreamingKit `v1.1.6` 接口变更
* 1.6.2 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.6.2.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.6.2.md))
* 更新依赖 PLStreamingKit 的版本到 `v1.1.5`
* 支持 Zoom 操作
* 1.6.1 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.6.1.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.6.1.md))
* 更新依赖 PLStreamingKit 的版本到 `v1.1.3`
* 修复调用 `- (void)reloadVideoConfiguraiton` 方法，fps 变更失败的问题
* 1.6.0 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.6.0.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.6.0.md))
* 更新依赖 PLStreamingKit 的版本到 `v1.1.2`
* 添加 `PLStreamStatus` 回调，便于客户端监控推流状态
* 修复采集源 fps 变更失败的问题
* 1.5.2 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.5.2.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.5.2.md))
* 更新依赖 PLStreamingKit 的版本到 `v1.0.3`
* 1.5.1 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.5.1.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.5.1.md))
* 更新依赖 PLStreamingKit 的版本到 `v1.0.2`
* 更改音频数据源采集部分，转换为单声道
* 1.5.0 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.5.0.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.5.0.md))
* 编码推流改为依赖 `PLStreamingKit`
* 去除 `PLAudioStreamingSession` 类, 建议单纯推音频的 App 直接接入 `PLStreamingKit`
* 摄像头及音频采集部分开源
* 底层添加了 HappyDNS, 解决部分地区 DNS 感染严重导致推流失败问题
* 优化 TCP 层发包，极大程度解决了网络正常但推流中经常断开的问题
* 1.4.16 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.4.16.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.4.16.md))
* 解决 destroy 方法可能卡死线程的问题
* 1.4.15 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.4.15.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.4.15.md))
* 修复类库 .a 未更新问题
* 1.4.14 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.4.14.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.4.14.md))
* 解决视频质量切换时导致 crash 的问题
* 解决推流时触发的只有音频无视频问题
* 解决音频采样导致的电流声
* 解决潜在内存问题，整体提升稳定性
* 视频编码统一 profileLevel 为 baseline31
* 限定最高支持分辨率到 720p
* 1.4.13 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.4.13.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.4.13.md))
* 更新 mute 行为，mute 后不会中断发包
* 更新音频设备采样率获取途径
* 更新底层库，避免冲突
* 1.4.12 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.4.12.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.4.12.md))
* 添加 `smoothAutoFocusEnabled` 参数，确保拍摄时对焦的平滑过渡
* 修复无网络环境或其他情况触发断流时引起的 crash
* 修复频繁切换摄像头时引起的 crash
* 修复内存 leak
* 1.4.11 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.4.11.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.4.11.md))
* 修复 iPhone 6s 系列机型直播无声音问题
* 1.4.10 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.4.10.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.4.10.md))
* 修复错误重连或者主动重连时导致 UI 卡顿的问题
* 1.4.9 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.4.9.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.4.9.md))
* 尝试修复 iPhone 6s 音频获取不到权限的问题
* 优化丢包策略，兼顾高延时和低带宽的情况
* 更新 demo 为全异步请求
* 1.4.8 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.4.8.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.4.8.md))
* 尝试修复 iPhone 6s 音频获取不到权限的问题
* 修复弱网环境触发的内存和 CPU 占用升高的问题
* 1.4.7 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.4.7.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.4.7.md))
* 尝试修复音频获取不到权限的问题
* 添加关闭 SDK 渲染 preview 的接口
* 1.4.6 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.4.6.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.4.6.md))
* 修复弱网环境下切换 VideoQuality 可能触发的 crash 问题
* 添加 `PLAudioComponentFailedToCreateNotification` 通知，在音频资源被占用时，创建音频结构失败会发送这个通知
* 1.4.5 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.4.5.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.4.5.md))
* 添加自行绘制 CMSampleBufferRef 的支持
* 1.4.4 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.4.4.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.4.4.md))
* 为 PLCameraStreamingSession 多个属性添加 kvo 支持
* 由时间计数改为包数计数
* 针对弱网坏境更改丢帧策略，确保不会出现花屏和声音抖动，取而代之会出现间断的无数据，但是可以保证画面和声音的流畅
* 发送队列的默认上下阈值更改为 0.3 和 0.7
* 1.4.3 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.4.3.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.4.3.md))
* 优化网络层调用，添加 `Disconnecting` 流状态
* 抽离可导致推流中断的错误
* 添加错误回调，同时将错误信息返回，便于 debug 及异常处理
* 修复 `destroy` 调用导致的崩溃问题
* 支持 iOS 9 的 bitcode
* 1.4.2 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.4.2.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.4.2.md))
* 添加 SendingBuffer 支持
* 修复 iPhone 6s 下崩溃的问题
* 1.4.1 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.4.1.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.4.1.md))
* 添加可以获取视频源数据的回调方法，便于开发者做滤镜等处理
* 对自定义分辨率做了内部修正，保证宽高均为 16 倍数
* 1.4.0 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.4.0.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.4.0.md))
* 添加音频推流的 `PLAudioStreamingSession`, 纯音频推流合并到 `PLCameraStreamingKit`
* 添加后台推流支持，暂且只在纯音频推流中有效
* 1.3.2 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.3.2.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.3.2.md))
* 修复直播被电话 / 闹钟中断后后续直播无声音的问题
* 更改音频采集类型: RecordAndPlay -> Record
* 添加对蓝牙音频设备的支持
* 1.3.1 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.3.1.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.3.1.md))
* 修复调用 destroy 方法后，重新创建 session 进入后台触发的 crash 问题
* 去除无用依赖, SDK 大小由 17 MB 降低为 4.7 MB
* 1.3.0 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.3.0.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.3.0.md))
* 添加带宽质量检测机制，推流过程中可无缝切换音视频 Quality，实现码率及帧率的动态调节
* 添加发送队列的配置及状态回调
* 更新 Example 来简单说明如何使用发送队列和 Quality 组合推流策略
* 1.2.8 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.2.8.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.2.8.md))
* 更新编码配置，分离音视频编码配置，便于提供更灵活的配置方案
* 去除 SIGPIPE 断点
* 修复 URL 错误时导致的崩溃
* 修复创建 Session 后设置 Stream 推流失败的问题
* 1.2.7 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.2.7.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.2.7.md))
* 修复断网后停止流时导致的 UI 卡死
* 修复停止推流时概率出现的 crash 问题
* 添加 `- (void)destroy` 方法到 `PLCameraStreamingSession`
* 暂且去除 iOS 8 编码，待进一步优化后再做开放
* 修复反复进出持有 streamingSession 的 viewController 出现 IO 错误或者 crash 的问题
* 1.2.6 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.2.6.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.2.6.md))
* 修复 iOS 8 以下推流时，编码导致的崩溃问题
* 1.2.5 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.2.5.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.2.5.md))
* 更新了 Quality 配置
* 1.2.4 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.2.4.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.2.4.md))
* 添加全新的 iOS 8 硬编码器，减少编码延时
* 1.2.3 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.2.3.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.2.3.md))
* 更新了 `PLStream` 类结构
* 添加新的 session 创建接口
* 移除 publishHost，`PLStream` 对象支持自动生成推流地址，请搭配服务端 SDK 至少 1.2.0 或以上版本使用
* 1.2.2 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.2.2.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.2.2.md))
* 更新麦克风资源调用方式，添加进入后台后自动停用麦克风功能
* 1.2.1 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.2.1.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.2.1.md))
* 修复初次授权摄像头后预览界面为黑屏的问题
* 1.2.0 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.2.0.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.2.0.md))
* 添加了 `PLStream` 类，支持 `Coding` 协议便于打包存储
* 更新 `StreamingSession` 创建方法，借助传递 `PLStream` 对象再无需推流时等待服务端生成推流地址
* 完善 HeaderDoc 文档
* 1.1.8 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.1.8.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.1.8.md))
* 添加摄像头开启和关闭的操作，便于开发者控制 AVCaptureSession
* 1.1.7 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.1.7.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.1.7.md))
* 添加推流质量字段，方便开发者指定推流质量
* 移除原配置中的网络选项
* 默认情况下关闭了 PLLog
* 添加摄像头开始运行的通知
* 添加麦克风开始运行的通知
* 1.1.6 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.1.6.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.1.6.md))
* 尝试修复音频变声问题
* 1.1.5 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.1.5.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.1.5.md))
* 修复了重连后无法播放的问题
* 1.1.4 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.1.4.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.1.4.md))
* 更新了码率和采样率。现在统一使用 128Kbps 和 44100KHZ，用以解决噪音的问题
* 更新了网络 socket。对 socket 在调试情况下出现的 SIGPIPE 进行了处理，不会再出现
* 更新了网络状态的返回情况。当不是主动调用 close 接口导致的断开都将以 error 状态通知 delegate
* 1.1.3 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.1.3.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.1.3.md))
* 更新了获取视频截图的方法
* 添加 HeaderDoc 格式注释文档
* 1.1.2 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.1.2.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.1.2.md))
* 添加自定视频大小的编码配置
* 添加进入后台后自动停止推流的支持
* 添加保持常亮的开关
* 添加获取当前录制截屏的功能
* 修复进入后台导致崩溃的问题
* 修复切换前置摄像头失效的问题
* 添加 Release Notes 说明每个版本变动
* 添加 API Diffs 说明具体修改细节
* 1.1.1
* 修复 release 版本无法推流的 bug
* 内存优化，比 1.1.0 减少 6% 左右内存消耗
* 1.1.0
* 重构接口
* 优化编码参数
* 提供不同网络和分辨率下的多种配置可选
* 添加消息通知，便于监听
* 兼顾 arc 及非 arc 的工程
* 1.0.0
* 发布 CocoaPods 版本
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 推流端 >iOS 推流端 SDK >历史记录
# 历史记录
最近更新时间: 2024-05-31 16:58:53
* 3.1.1 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-3.1.1.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-3.1.1.md))
* 功能
* 支持推流过程中修改 fps
* 缺陷
* 修复 iOS 17.4.1 SRT 无法推流
* 修复 HEVC 编码，HLS 拉流异常
* 修复其它已知问题
* 3.1.0 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-3.1.0.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-3.1.0.md))
* 功能
* 支持 HEVC 编码推流
* 支持发送 HEVC SEI 信息
* 缺陷
* 修复 iOS16 不能图片推流的问题
* 3.0.8 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-3.0.8.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-3.0.8.md))
* 功能
* 支持进程内动态替换 userUID
* 支持编码时设置图像填充模式
* 优化 HappyDNS 内置解析 ip
* 缺陷
* 解决连续频繁切换摄像头卡主线程的问题
* 解决蓝牙耳机听歌切推流音乐会短暂外放的问题
* 解决停止推流服务端未收到正常断开指令的问题
* 解决找不到 compare 方法导致出现闪退的问题
* 解决鉴权时间在本地记录转换格式的问题
* 3.0.7 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-3.0.7.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-3.0.7.md))
* 功能
* 更新 HappyDNS 版本至 1.0.0
* 图片推流模式下支持添加贴纸、水印
* 优化鉴权服务请求处理
* 3.0.6 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-3.0.6.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-3.0.6.md))
* 缺陷
* iOS 15 硬编码视频 pts 统计有误
* 3.0.5 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-3.0.5.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-3.0.5.md))
* 功能
* 支持 srt 协议推流
* 缺陷
* 修复混音素材无法切换
* 3.0.4 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-3.0.4.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-3.0.4.md))
* 缺陷
* 视频卡顿
* 扩展录屏混音异常
* 扩展录屏偶现视频无法推流
* 3.0.3 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-3.0.3.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-3.0.3.md))
* 功能
* 支持获取麦克风数据 asbd 信息
* 支持重新加载音频推流编码配置信息
* 流信息回调新增音视频码率信息
* 缺陷
* 修复摄像头未授权情况下设置动态码率 crash 的问题
* 修复快速多次 start 后立即 stop 视频仍在发布的问题
* 解决 reloadConfiguration 更改编码帧率无效的问题
* 解决连接蓝牙耳机后采集实际输入源是设备麦克风的问题
* 修复音频采集配置 44100 长时间推流拉流端音画不同步的问题
* 修复使用带声音的三方键盘及蓝牙耳机同时连接电脑手机 message 线程偶现 crash 的问题
* 3.0.2 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-3.0.2.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-3.0.2.md))
* 缺陷
* 修复 Xcode 12 版本编译报错的问题
* 3.0.1 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-3.0.1.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-3.0.1.md))
* 优化
* SEI 数据 payload size 支持大于 255 字节
* 缺陷
* 修复扩展录屏配置 kPLAudioChannelApp + kPLAudioChannelMic 在 iOS 13.1.1 上推流频繁断流的问题
* 3.0.0 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-3.0.0.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-3.0.0.md))
* 功能
* 新增包名鉴权功能
* 缺陷
* 修复 App 调试时音频数据数组越界的问题
* 修复 broadcast 下扩展录屏配置 kPLAudioChannelApp + kPLAudioChannelMic 组合存在内存泄漏的问题
* 优化开启动态帧率/码率时退前后台的反应时长
* 3.0.0 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-3.0.0.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-3.0.0.md))
* 功能
* 新增包名鉴权功能
* 缺陷
* 修复 App 调试时音频数据数组越界的问题
* 修复 broadcast 下扩展录屏配置 kPLAudioChannelApp + kPLAudioChannelMic 组合存在内存泄漏的问题
* 优化开启动态帧率/码率时退前后台的反应时长
* 2.3.5 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-2.3.5.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-2.3.5.md))
* 功能
* 支持混音支持麦克风音量调整
* 支持推流插入 SEI 功能
* 支持推流采集视频数据回调添加视频时间戳
* 2.3.4 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-2.3.4.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-2.3.4.md))
* 功能
* 支持在竖屏尺寸采集状态下推横屏尺寸的 buffer
* 支持视频帧 BGRA32、NV12 的旋转、裁剪及缩放
* 支持蓝牙耳机的音频采集
* 缺陷
* 修复 videoToolBox 编码时，进入后台 setPushImage 后黑屏的问题
* 修复 replaykit 录屏推流 AVFoundation 编码时，播放端画面大概率黑屏的问题
* 修复推流过程中音频被电话中断后无法恢复的问题
* 解决不在主线程访问 UI 的告警问题
* 2.3.3 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-2.3.3.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-2.3.3.md))
* 功能
* 支持 bitcode
* 优化
* 优化相机的对焦效果和曝光效果
* 优化 pod install 或 update 时进度缓慢的问题
* 缺陷
* 修复特殊场景下 Wi-Fi 和 4G 之间频繁切换偶现的预览画面卡住的问题
* 修复开始推流后 0.2 秒内音频爆音的问题
* 2.3.2 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-2.3.2.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-2.3.2.md))
* 功能
* 重构了音频采集模块，包含音频数据采集、背景音乐播放、混音、音效、返听。重构后，插入耳机与否，背景音乐的声音都会从扬声器/耳机发出。
* 支持在推流过程中往视频画面上添加多个静态图片和文字
* 2.3.1 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-2.3.1.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-2.3.1.md))
* 功能
* 添加 URL 签名超时推流失败回调
* 支持 SDK 真机和模拟器版本共存
* 缺陷
* 修复非 1935 端口的地址不能推流问题
* 2.3.0 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-2.3.0.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-2.3.0.md))
* 功能
* 支持 QUIC 推流功能
* 缺陷
* 修复某些机型在特定配置下推流画面不完整的问题
* 修复切换摄像头瞬间画面出现镜像的问题
* 2.2.5 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-2.2.5.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-2.2.5.md))
* 缺陷
* 修复偶现进入后台时崩溃的问题
* 修复偶现内存泄漏的问题
* 2.2.4 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-2.2.4.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-2.2.4.md))
* 缺陷
* 修复 iOS 11 设备上预览启动慢的问题
* 修复 iPhone X 设备上出现的 crash 问题
* 2.2.3 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-2.2.3.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-2.2.3.md))
* 缺陷
* 修复频繁设置 pushImage 内存未释放的问题
* 修复在 iOS 8.1 设备上预览画面卡住的问题
* 修复 VideoToolbox 编码方式下特定分辨率裁剪未居中的问题
* 修复推流超过 4.5 小时掉线的问题
* 修复 Xcode 9 下编译报错的问题
* 2.2.1 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-2.2.1.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-2.2.1.md))
* 功能
* 支持后台推静态图的功能
* 缺陷
* 修复 iOS 8.1 使用 VideoToolbox 编码失败的问题
* 修复 iOS 9 及以上系统当 App 进入 Inactive 状态时推流画面卡住的问题
* 2.2.0 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-2.2.0.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-2.2.0.md))
* 功能
* 音频采集支持回声消除功能
* 支持 HE-AAC 音频编码
* 缺陷
* 修复推流可能出现的内存泄露问题
* 修复横屏推流镜像功能失效的问题
* 修复特殊场景下偶现的崩溃
* 2.1.6 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-2.1.6.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-2.1.6.md))
* 功能
* 支持苹果 ATS 安全标准
* PLMediaStreamingSession 增加外部传入 QNDnsManager 的接口
* 缺陷
* 修复设置音效后内存泄漏的问题
* 修复设置推流镜像时预览画面会闪一下的问题
* 其它
* 废弃 PLCameraStreamingSession，请使用 PLMediaStreamingSession
* 2.1.5 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-2.1.5.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-2.1.5.md))
* 缺陷
* 修复推流预览在 app 退至后台一段时间后再返回前台时，有概率会卡住问题
* 修复开启 VideoToolbox 编码时，退至后台再返回前台时，编码数据无法输出问题
* 2.1.4 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-2.1.4.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-2.1.4.md))
* 功能
* 增加对 iOS 10 ReplayKit 录屏推流的支持
* 增加 VideoToolbox 视频硬件编码功能
* 增加人工报障和自动报障功能
* 缺陷
* 修复 iPhone 6s 及以上机型在 iOS 10 上的电流音问题
* 修复 iPhone 6 及以上机型在 iOS 10 上同时开启自动对焦和手动对焦功能时，手动对焦失效问题
* 优化
* 优化 RGB 转 YUV 的效率，去除对 libyuv 库的依赖
* 2.1.3 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-2.1.3.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-2.1.3.md))
* 缺陷
* 解决 iPhone 4s 及以下会 crash 的问题
* 2.1.2 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-2.1.2.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-2.1.2.md))
* 功能
* 增加截屏功能
* 增加自动网络检测功能
* 增加自适应码率功能
* 增加动态帧率功能
* 缺陷
* 修复音频未授权时 crash 的问题
* 修复所有已知 crash
* 修复前置摄像头无法缩放的问题
* 优化
* 优化不开美颜和水印时的性能
* 2.1.1 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-2.1.1.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-2.1.1.md))
* 缺陷
* 修复与 PLPlayerKit v2.2.3 符号冲突的问题
* 2.1.0 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-2.1.0.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-2.1.0.md))
* 功能
* 新增返听功能
* 新增内置音效功能，支持十余种音效与数十个参数自由调节
* 新增内置音频文件播放及混音推流功能
* 新增外部视频图像处理本地预览功能
* 缺陷
* 修复分享到微博和 qq 空间时可能出现的卡 UI 的问题
* 修复在流未连接的状态调用 restart 方法会出现只有视频没有声音的问题
* 修复初始化时自动对焦不生效的问题
* 修复一些偶发的 crash 问题
* 2.0.0 ([Release Notes __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/ReleaseNotes/release-notes-2.0.0.md)&& [API Diffs __](https://github.com/pili-engineering/PLMediaStreamingKit/blob/master/APIDiffs/api-diffs-2.0.0.md))
* 功能
* 提供 PLCameraStreamingKit 和 PLStreamingKit 两个层次的 API
* 支持直接传入 stream URL 进行推流
* 提供推流节点调度功能
* 支持音频数据回调及处理功能
* 缺陷
* 修复orientation 在切换摄像头之后不起作用的问题
* 修复初始化之后 inputGain 获取到的值始终为 0 的问题
* 修复多种原因导致的死锁问题
* 修复弱网推流可能出现的内存泄露问题
* 修复特殊机器状态可能出现的 crash 问题
* 优化
* 优化对设备采样率的适配，推流过程中设备采样率变更将不再重新开始推流
* 1.8.1 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.8.1.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.8.1.md))
* 功能
* 更新依赖的 PLStreamingKit 到 1.2.5
* 新增自动重连功能，默认关闭
* 新增模拟器编译支持
* 水印和美颜功能调整为支持 iPhone 5、iPad 3、iPod touch 4 及以上设备
* 缺陷
* 修复已知场景可能存在的没有声音的问题
* 修复填充模式改变可能导致 preview 的 frame 发生改变的问题
* 修复触摸屏幕对焦无效的问题
* 修复无法正确设置采集相机位置的问题
* 修复 capture session 设置不正确可能导致 crash 的问题
* 修复偶尔出现的画面卡住无法正常推流的问题
* 1.8.0 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.8.0.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.8.0.md))
* 功能
* 更新依赖的 PLStreamingKit 到 1.2.4
* 新增内置美颜功能，美颜效果可调节
* 新增单独调节前后置摄像头预览及推流是否镜像的接口
* 新增动态帧率功能，通过降低采集帧率来适配弱网环境
* 缺陷
* 修复音视频时间戳偶尔出现的非单调递增的缺陷
* 修复特殊机型可能出现的没有声音的问题
* 优化
* 优化水印性能，降低 CPU 和内存消耗
* 1.7.2 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.7.2.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.7.2.md))
* 功能
* 更新依赖的 PLStreamingKit 到 1.2.2
* 新增回调队列配置功能
* 新增默认摄像头位置配置项
* 新增录制音量调节选项（由于系统原因，仅对除 iPhone 6s 系列以外的机型生效）
* 支持初始化的时候传入 stream 为 nil
* 支持快速重连操作，方便 4G 推流时切换 WIFI 场景快速切换网络
* 缺陷
* 修复特殊场景可能出现的电流音问题
* 修复特殊场景可能出现的没有声音的问题
* 修复后台推流时被音频打断结束之后无法正常恢复推流的问题
* 1.7.1 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.7.1.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.7.1.md))
* 缺陷
* 修复切换前置摄像头之后无法缩放的问题
* 修复不添加水印无法正常推流的问题
* 1.7.0 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.7.0.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.7.0.md))
* 功能
* 新增后台推流功能（仅音频，因 iOS 隐私限制不允许后台访问摄像头）
* 新增水印功能
* 新增可选定制美颜功能（需联系工作人员）
* 缺陷
* 修复特定机型上的电流音等杂音问题
* 版本
* 更新依赖 PLStreamingKit 的版本到 `v1.2.0`
* 其他
* 部分接口重命名
* 1.6.3 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.6.2.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.6.2.md))
* 更新依赖 PLStreamingKit 的版本到 `v1.1.6`
* 更新 Demo 适应 PLStreamingKit `v1.1.6` 接口变更
* 1.6.2 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.6.2.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.6.2.md))
* 更新依赖 PLStreamingKit 的版本到 `v1.1.5`
* 支持 Zoom 操作
* 1.6.1 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.6.1.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.6.1.md))
* 更新依赖 PLStreamingKit 的版本到 `v1.1.3`
* 修复调用 `- (void)reloadVideoConfiguraiton` 方法，fps 变更失败的问题
* 1.6.0 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.6.0.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.6.0.md))
* 更新依赖 PLStreamingKit 的版本到 `v1.1.2`
* 添加 `PLStreamStatus` 回调，便于客户端监控推流状态
* 修复采集源 fps 变更失败的问题
* 1.5.2 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.5.2.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.5.2.md))
* 更新依赖 PLStreamingKit 的版本到 `v1.0.3`
* 1.5.1 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.5.1.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.5.1.md))
* 更新依赖 PLStreamingKit 的版本到 `v1.0.2`
* 更改音频数据源采集部分，转换为单声道
* 1.5.0 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.5.0.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.5.0.md))
* 编码推流改为依赖 `PLStreamingKit`
* 去除 `PLAudioStreamingSession` 类, 建议单纯推音频的 App 直接接入 `PLStreamingKit`
* 摄像头及音频采集部分开源
* 底层添加了 HappyDNS, 解决部分地区 DNS 感染严重导致推流失败问题
* 优化 TCP 层发包，极大程度解决了网络正常但推流中经常断开的问题
* 1.4.16 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.4.16.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.4.16.md))
* 解决 destroy 方法可能卡死线程的问题
* 1.4.15 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.4.15.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.4.15.md))
* 修复类库 .a 未更新问题
* 1.4.14 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.4.14.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.4.14.md))
* 解决视频质量切换时导致 crash 的问题
* 解决推流时触发的只有音频无视频问题
* 解决音频采样导致的电流声
* 解决潜在内存问题，整体提升稳定性
* 视频编码统一 profileLevel 为 baseline31
* 限定最高支持分辨率到 720p
* 1.4.13 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.4.13.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.4.13.md))
* 更新 mute 行为，mute 后不会中断发包
* 更新音频设备采样率获取途径
* 更新底层库，避免冲突
* 1.4.12 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.4.12.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.4.12.md))
* 添加 `smoothAutoFocusEnabled` 参数，确保拍摄时对焦的平滑过渡
* 修复无网络环境或其他情况触发断流时引起的 crash
* 修复频繁切换摄像头时引起的 crash
* 修复内存 leak
* 1.4.11 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.4.11.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.4.11.md))
* 修复 iPhone 6s 系列机型直播无声音问题
* 1.4.10 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.4.10.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.4.10.md))
* 修复错误重连或者主动重连时导致 UI 卡顿的问题
* 1.4.9 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.4.9.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.4.9.md))
* 尝试修复 iPhone 6s 音频获取不到权限的问题
* 优化丢包策略，兼顾高延时和低带宽的情况
* 更新 demo 为全异步请求
* 1.4.8 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.4.8.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.4.8.md))
* 尝试修复 iPhone 6s 音频获取不到权限的问题
* 修复弱网环境触发的内存和 CPU 占用升高的问题
* 1.4.7 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.4.7.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.4.7.md))
* 尝试修复音频获取不到权限的问题
* 添加关闭 SDK 渲染 preview 的接口
* 1.4.6 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.4.6.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.4.6.md))
* 修复弱网环境下切换 VideoQuality 可能触发的 crash 问题
* 添加 `PLAudioComponentFailedToCreateNotification` 通知，在音频资源被占用时，创建音频结构失败会发送这个通知
* 1.4.5 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.4.5.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.4.5.md))
* 添加自行绘制 CMSampleBufferRef 的支持
* 1.4.4 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.4.4.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.4.4.md))
* 为 PLCameraStreamingSession 多个属性添加 kvo 支持
* 由时间计数改为包数计数
* 针对弱网坏境更改丢帧策略，确保不会出现花屏和声音抖动，取而代之会出现间断的无数据，但是可以保证画面和声音的流畅
* 发送队列的默认上下阈值更改为 0.3 和 0.7
* 1.4.3 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.4.3.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.4.3.md))
* 优化网络层调用，添加 `Disconnecting` 流状态
* 抽离可导致推流中断的错误
* 添加错误回调，同时将错误信息返回，便于 debug 及异常处理
* 修复 `destroy` 调用导致的崩溃问题
* 支持 iOS 9 的 bitcode
* 1.4.2 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.4.2.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.4.2.md))
* 添加 SendingBuffer 支持
* 修复 iPhone 6s 下崩溃的问题
* 1.4.1 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.4.1.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.4.1.md))
* 添加可以获取视频源数据的回调方法，便于开发者做滤镜等处理
* 对自定义分辨率做了内部修正，保证宽高均为 16 倍数
* 1.4.0 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.4.0.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.4.0.md))
* 添加音频推流的 `PLAudioStreamingSession`, 纯音频推流合并到 `PLCameraStreamingKit`
* 添加后台推流支持，暂且只在纯音频推流中有效
* 1.3.2 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.3.2.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.3.2.md))
* 修复直播被电话 / 闹钟中断后后续直播无声音的问题
* 更改音频采集类型: RecordAndPlay -> Record
* 添加对蓝牙音频设备的支持
* 1.3.1 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.3.1.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.3.1.md))
* 修复调用 destroy 方法后，重新创建 session 进入后台触发的 crash 问题
* 去除无用依赖, SDK 大小由 17 MB 降低为 4.7 MB
* 1.3.0 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.3.0.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.3.0.md))
* 添加带宽质量检测机制，推流过程中可无缝切换音视频 Quality，实现码率及帧率的动态调节
* 添加发送队列的配置及状态回调
* 更新 Example 来简单说明如何使用发送队列和 Quality 组合推流策略
* 1.2.8 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.2.8.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.2.8.md))
* 更新编码配置，分离音视频编码配置，便于提供更灵活的配置方案
* 去除 SIGPIPE 断点
* 修复 URL 错误时导致的崩溃
* 修复创建 Session 后设置 Stream 推流失败的问题
* 1.2.7 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.2.7.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.2.7.md))
* 修复断网后停止流时导致的 UI 卡死
* 修复停止推流时概率出现的 crash 问题
* 添加 `- (void)destroy` 方法到 `PLCameraStreamingSession`
* 暂且去除 iOS 8 编码，待进一步优化后再做开放
* 修复反复进出持有 streamingSession 的 viewController 出现 IO 错误或者 crash 的问题
* 1.2.6 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.2.6.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.2.6.md))
* 修复 iOS 8 以下推流时，编码导致的崩溃问题
* 1.2.5 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.2.5.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.2.5.md))
* 更新了 Quality 配置
* 1.2.4 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.2.4.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.2.4.md))
* 添加全新的 iOS 8 硬编码器，减少编码延时
* 1.2.3 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.2.3.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.2.3.md))
* 更新了 `PLStream` 类结构
* 添加新的 session 创建接口
* 移除 publishHost，`PLStream` 对象支持自动生成推流地址，请搭配服务端 SDK 至少 1.2.0 或以上版本使用
* 1.2.2 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.2.2.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.2.2.md))
* 更新麦克风资源调用方式，添加进入后台后自动停用麦克风功能
* 1.2.1 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.2.1.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.2.1.md))
* 修复初次授权摄像头后预览界面为黑屏的问题
* 1.2.0 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.2.0.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.2.0.md))
* 添加了 `PLStream` 类，支持 `Coding` 协议便于打包存储
* 更新 `StreamingSession` 创建方法，借助传递 `PLStream` 对象再无需推流时等待服务端生成推流地址
* 完善 HeaderDoc 文档
* 1.1.8 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.1.8.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.1.8.md))
* 添加摄像头开启和关闭的操作，便于开发者控制 AVCaptureSession
* 1.1.7 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.1.7.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.1.7.md))
* 添加推流质量字段，方便开发者指定推流质量
* 移除原配置中的网络选项
* 默认情况下关闭了 PLLog
* 添加摄像头开始运行的通知
* 添加麦克风开始运行的通知
* 1.1.6 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.1.6.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.1.6.md))
* 尝试修复音频变声问题
* 1.1.5 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.1.5.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.1.5.md))
* 修复了重连后无法播放的问题
* 1.1.4 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.1.4.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.1.4.md))
* 更新了码率和采样率。现在统一使用 128Kbps 和 44100KHZ，用以解决噪音的问题
* 更新了网络 socket。对 socket 在调试情况下出现的 SIGPIPE 进行了处理，不会再出现
* 更新了网络状态的返回情况。当不是主动调用 close 接口导致的断开都将以 error 状态通知 delegate
* 1.1.3 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.1.3.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.1.3.md))
* 更新了获取视频截图的方法
* 添加 HeaderDoc 格式注释文档
* 1.1.2 ([Release Notes __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/ReleaseNotes/release-notes-1.1.2.md)&& [API Diffs __](https://github.com/pili-engineering/PLCameraStreamingKit/blob/master/APIDiffs/api-diffs-1.1.2.md))
* 添加自定视频大小的编码配置
* 添加进入后台后自动停止推流的支持
* 添加保持常亮的开关
* 添加获取当前录制截屏的功能
* 修复进入后台导致崩溃的问题
* 修复切换前置摄像头失效的问题
* 添加 Release Notes 说明每个版本变动
* 添加 API Diffs 说明具体修改细节
* 1.1.1
* 修复 release 版本无法推流的 bug
* 内存优化，比 1.1.0 减少 6% 左右内存消耗
* 1.1.0
* 重构接口
* 优化编码参数
* 提供不同网络和分辨率下的多种配置可选
* 添加消息通知，便于监听
* 兼顾 arc 及非 arc 的工程
* 1.0.0
* 发布 CocoaPods 版本
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,351 |
QPlayer2产品简介 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >QPlayer2产品简介
# QPlayer2产品简介
最近更新时间: 2024-08-08 17:43:39
# QPlayer2
> **说明：**
> SDK名称：QPlayer2 播放器SDK
> 开发者：上海七牛信息技术有限公司
> 播放器 SDK 合规使用说明请参考[七牛 SDK 合规使用说明
> __](https://developer.qiniu.com/pili/12616/sdk-compliance-
> instructions)；隐私政策说明请参考[七牛 SDK 隐私策略
> __](https://developer.qiniu.com/pili/8027/sdk-privacy-policy)
QPlayer2
是一款面向未来的跨平台播放器SDK,除了基本的播放能力外，还引入目前最前沿的技术能力，同时在用户的接入上，提供了扩展插件，让客户能更便捷的实现播放器上层的相关业务逻辑。
SDK包含两个部分：qplayer2-core提供核心播放能力，qplayer2-ext（目前仅android端支持）提供上层业务扩展能力。
QPlayer2-Android:<https://github.com/pili-
engineering/QPlayer2-Android>[__](https://github.com/pili-
engineering/QPlayer2-Android)
QPlayer2-IOS:<https://github.com/pili-
engineering/QPlayer2-IOS>[__](https://github.com/pili-
engineering/QPlayer2-IOS)
QPlayer2-Windows:<https://github.com/pili-
engineering/QPlayer2-Windows>[__](https://github.com/pili-
engineering/QPlayer2-Windows)
QPlayer2-Harmony:<https://github.com/pili-engineering/QPlayer2-HarmonyOS-
NEXT>[__](https://github.com/pili-engineering/QPlayer2-HarmonyOS-NEXT)
QPlayer2-MacOS:敬请期待
QPlayer2-Linux:敬请期待
## SDK下载
QPlayer2-Android下载：[QPlayer2-Android v1.4.3 __](https://github.com/pili-
engineering/QPlayer2-Android/releases/tag/v1.4.3)
QPlayer2-IOS下载：[QPlayer2-IOS v1.4.3 __](https://github.com/pili-
engineering/QPlayer2-IOS/releases/tag/v1.4.3)
QPlayer2-Harmony下载：[QPlayer2-Harmony v1.5.0-preview4
__](https://github.com/pili-engineering/QPlayer2-HarmonyOS-
NEXT/releases/tag/v1.5.0-preview4)
QPlayer2-Windows下载：[QPlayer2-Windows v1.4.1 __](https://github.com/pili-
engineering/QPlayer2-Windows/releases/tag/v1.4.1)
## qplayer2-core 功能列表
### 媒体资源组成形式
一个媒体资源支持多url，比如一个音频url和一个视频url组成一个媒体资源,提升拉流速度和解封装速度
### 播放协议及封装
目前支持的如下，如有其他需求可以联系技术支持或者提交github需求issue。
* 协议：http/https/rtmp/srt
* 封装格式:flv/m3u8/mp4/flac/wav(PCM_S24LE)
### 解码方式
* 软解
* 硬解
* 自动：自动选择合适的解码方式
* 混解(Android端)
### 色盲模式
在业务场景中更好的服务视觉有障碍的客户
### 倍速
改变视频播放的速度，且变速不变调
### 清晰度切换
通用清晰度切换方案，无缝切换，即使媒体资源gop不对齐
### SEEK
支持精准/关键帧 seek 两种方式
### 指定起播位置
从指定位置开始播放
### 起播方式
* 起播播放
* 起播暂停 ：起播后首帧渲染出来就停止画面
### 预加载
提前加载点播视频，获得更好的首帧体验
### SEI数据回调
将sei数据上抛到上层供业务层使用，所有解码方式都支持
### 纯音频播放/纯视频播放
播放只有单音频流或者只有单视频流的视频
### VR视频
支持Equirect-Angular类型的vr视频播放
## qplayer2-ext 功能列表(目前仅Android支持)
### 场景切换定制
当一个播放器有直播点播场景时，且2个场景的业务逻辑完全不同时，通过场景定制，能更丝滑的在2套逻辑中切换
### 播放面板定制
统一控制面板的显示隐藏，不同的视频场景中 可快速切换面板
### 播放器上层浮窗定制
拥有统一的浮窗展示隐藏动画和布局规范，更快的实现各类弹窗
### 播放器上层手势
支持多种手势判定回调，上层只需关心业务逻辑
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >QPlayer2产品简介
# QPlayer2产品简介
最近更新时间: 2024-08-08 17:43:39
# QPlayer2
> **说明：**
> SDK名称：QPlayer2 播放器SDK
> 开发者：上海七牛信息技术有限公司
> 播放器 SDK 合规使用说明请参考[七牛 SDK 合规使用说明
> __](https://developer.qiniu.com/pili/12616/sdk-compliance-
> instructions)；隐私政策说明请参考[七牛 SDK 隐私策略
> __](https://developer.qiniu.com/pili/8027/sdk-privacy-policy)
QPlayer2
是一款面向未来的跨平台播放器SDK,除了基本的播放能力外，还引入目前最前沿的技术能力，同时在用户的接入上，提供了扩展插件，让客户能更便捷的实现播放器上层的相关业务逻辑。
SDK包含两个部分：qplayer2-core提供核心播放能力，qplayer2-ext（目前仅android端支持）提供上层业务扩展能力。
QPlayer2-Android:<https://github.com/pili-
engineering/QPlayer2-Android>[__](https://github.com/pili-
engineering/QPlayer2-Android)
QPlayer2-IOS:<https://github.com/pili-
engineering/QPlayer2-IOS>[__](https://github.com/pili-
engineering/QPlayer2-IOS)
QPlayer2-Windows:<https://github.com/pili-
engineering/QPlayer2-Windows>[__](https://github.com/pili-
engineering/QPlayer2-Windows)
QPlayer2-Harmony:<https://github.com/pili-engineering/QPlayer2-HarmonyOS-
NEXT>[__](https://github.com/pili-engineering/QPlayer2-HarmonyOS-NEXT)
QPlayer2-MacOS:敬请期待
QPlayer2-Linux:敬请期待
## SDK下载
QPlayer2-Android下载：[QPlayer2-Android v1.4.3 __](https://github.com/pili-
engineering/QPlayer2-Android/releases/tag/v1.4.3)
QPlayer2-IOS下载：[QPlayer2-IOS v1.4.3 __](https://github.com/pili-
engineering/QPlayer2-IOS/releases/tag/v1.4.3)
QPlayer2-Harmony下载：[QPlayer2-Harmony v1.5.0-preview4
__](https://github.com/pili-engineering/QPlayer2-HarmonyOS-
NEXT/releases/tag/v1.5.0-preview4)
QPlayer2-Windows下载：[QPlayer2-Windows v1.4.1 __](https://github.com/pili-
engineering/QPlayer2-Windows/releases/tag/v1.4.1)
## qplayer2-core 功能列表
### 媒体资源组成形式
一个媒体资源支持多url，比如一个音频url和一个视频url组成一个媒体资源,提升拉流速度和解封装速度
### 播放协议及封装
目前支持的如下，如有其他需求可以联系技术支持或者提交github需求issue。
* 协议：http/https/rtmp/srt
* 封装格式:flv/m3u8/mp4/flac/wav(PCM_S24LE)
### 解码方式
* 软解
* 硬解
* 自动：自动选择合适的解码方式
* 混解(Android端)
### 色盲模式
在业务场景中更好的服务视觉有障碍的客户
### 倍速
改变视频播放的速度，且变速不变调
### 清晰度切换
通用清晰度切换方案，无缝切换，即使媒体资源gop不对齐
### SEEK
支持精准/关键帧 seek 两种方式
### 指定起播位置
从指定位置开始播放
### 起播方式
* 起播播放
* 起播暂停 ：起播后首帧渲染出来就停止画面
### 预加载
提前加载点播视频，获得更好的首帧体验
### SEI数据回调
将sei数据上抛到上层供业务层使用，所有解码方式都支持
### 纯音频播放/纯视频播放
播放只有单音频流或者只有单视频流的视频
### VR视频
支持Equirect-Angular类型的vr视频播放
## qplayer2-ext 功能列表(目前仅Android支持)
### 场景切换定制
当一个播放器有直播点播场景时，且2个场景的业务逻辑完全不同时，通过场景定制，能更丝滑的在2套逻辑中切换
### 播放面板定制
统一控制面板的显示隐藏，不同的视频场景中 可快速切换面板
### 播放器上层浮窗定制
拥有统一的浮窗展示隐藏动画和布局规范，更快的实现各类弹窗
### 播放器上层手势
支持多种手势判定回调，上层只需关心业务逻辑
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,377 |
QPlayer2 鉴权相关 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >QPlayer2 鉴权相关
# QPlayer2 鉴权相关
最近更新时间: 2022-09-27 16:01:43
# 鉴权
权限 | 说明 | 鉴权失败结果
---|---|---
Base | 基础播放能力 | 播放器进入error状态
VR | 播放VR视频 | 播放vr视频，起播后播放器进入error状态
SEI | SEI数据回调 | 开启sei 回调，且视频有sei数据。能正常播放视频，SEI数据不回调，同时抛出鉴权失败错误码
SRT | srt协议视频 | 播放srt链接 播放器进入error状态
BLIND | 色盲滤镜 | 开启色盲滤镜，视频正常播放，滤镜不生效。
如需使用该套sdk到其他工程中，请联系我们的技术支持开通帐号和权限。
# 鉴权的执行逻辑
* 每一次播放会鉴权一次，可能走本地鉴权也可能走服务端鉴权
* 鉴权时机 鉴权是个异步过程，不会阻止视频播放的流程，所有有可能存在视频已经播放起来之后，才拿到鉴权结果，那么如果结果是失败时，则播放器会跳转到错误状态。
* 鉴权的结果有3种
* 鉴权成功：有权限执行本次播放
* 鉴权失败：没有权限本次播放或视频正常播放但是某些功能不生效
* 鉴权错误 在鉴权过程中，由于过程中出现异常情况导致无法判定到底是成功还是失败，则不会阻止本次播放的进行。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >QPlayer2 鉴权相关
# QPlayer2 鉴权相关
最近更新时间: 2022-09-27 16:01:43
# 鉴权
权限 | 说明 | 鉴权失败结果
---|---|---
Base | 基础播放能力 | 播放器进入error状态
VR | 播放VR视频 | 播放vr视频，起播后播放器进入error状态
SEI | SEI数据回调 | 开启sei 回调，且视频有sei数据。能正常播放视频，SEI数据不回调，同时抛出鉴权失败错误码
SRT | srt协议视频 | 播放srt链接 播放器进入error状态
BLIND | 色盲滤镜 | 开启色盲滤镜，视频正常播放，滤镜不生效。
如需使用该套sdk到其他工程中，请联系我们的技术支持开通帐号和权限。
# 鉴权的执行逻辑
* 每一次播放会鉴权一次，可能走本地鉴权也可能走服务端鉴权
* 鉴权时机 鉴权是个异步过程，不会阻止视频播放的流程，所有有可能存在视频已经播放起来之后，才拿到鉴权结果，那么如果结果是失败时，则播放器会跳转到错误状态。
* 鉴权的结果有3种
* 鉴权成功：有权限执行本次播放
* 鉴权失败：没有权限本次播放或视频正常播放但是某些功能不生效
* 鉴权错误 在鉴权过程中，由于过程中出现异常情况导致无法判定到底是成功还是失败，则不会阻止本次播放的进行。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,382 |
QPlayer2 Harmony 端 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >QPlayer2 Harmony 端
# QPlayer2 Harmony 端
最近更新时间: 2024-06-11 17:46:29
QPlayer2 Harmony 端文档包含如下几个部分
集成准备：主要介绍将QPlayer2引入到工程中的一些配置
基于qplayer2-core的QPlayer2接入指南：如果仅仅使用qplayer2-core开发，则参考这个文档。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >QPlayer2 Harmony 端
# QPlayer2 Harmony 端
最近更新时间: 2024-06-11 17:46:29
QPlayer2 Harmony 端文档包含如下几个部分
集成准备：主要介绍将QPlayer2引入到工程中的一些配置
基于qplayer2-core的QPlayer2接入指南：如果仅仅使用qplayer2-core开发，则参考这个文档。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,384 |
集成准备 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2 Harmony
端](https://developer.qiniu.com/pili/sdk/12702/qplayer2-harmony) > 集成准备
# 集成准备
最近更新时间: 2024-07-31 11:50:02
# 集成准备
本文为您介绍 harmony qplayer2 SDK 的集成准备的环境要求和具体操作步骤。
系统版本为 NEXT.0.0.26 的 harmony-next 手机
## 环境要求
类别 | 说明
---|---
系统版本 | 版本为 NEXT.0.0.26 的 harmony-next 手机
IDE 版本 | DevEco Studio NEXT Developer Beta1 version 5.0.3.403
## 权限要求
{
"name": "ohos.permission.INTERNET"
},
{
"name": "ohos.permission.GET_NETWORK_INFO"
},
{
"name": "ohos.permission.KEEP_BACKGROUND_RUNNING"
}
## 获取 QPlayer2 License
联系技术支持获取
## 添加 QPlayer2 依赖
### 1.进入 [鸿蒙仓库 __](https://github.com/pili-engineering/QPlayer2-HarmonyOS-
NEXT)查看最新QPlayer2的版本
### 2.使用下面的命令下载安装 QPlayer2
ohpm install @qiniu/qplayer2-core
### 3\. 打开项目的 oh-package.json5 文件，查看 QPlayer2 的引用
"dependencies": {
"@qiniu/qplayer2-core" : '^1.5.0-preview4' //版本号
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2 Harmony
端](https://developer.qiniu.com/pili/sdk/12702/qplayer2-harmony) > 集成准备
# 集成准备
最近更新时间: 2024-07-31 11:50:02
# 集成准备
本文为您介绍 harmony qplayer2 SDK 的集成准备的环境要求和具体操作步骤。
系统版本为 NEXT.0.0.26 的 harmony-next 手机
## 环境要求
类别 | 说明
---|---
系统版本 | 版本为 NEXT.0.0.26 的 harmony-next 手机
IDE 版本 | DevEco Studio NEXT Developer Beta1 version 5.0.3.403
## 权限要求
{
"name": "ohos.permission.INTERNET"
},
{
"name": "ohos.permission.GET_NETWORK_INFO"
},
{
"name": "ohos.permission.KEEP_BACKGROUND_RUNNING"
}
## 获取 QPlayer2 License
联系技术支持获取
## 添加 QPlayer2 依赖
### 1.进入 [鸿蒙仓库 __](https://github.com/pili-engineering/QPlayer2-HarmonyOS-
NEXT)查看最新QPlayer2的版本
### 2.使用下面的命令下载安装 QPlayer2
ohpm install @qiniu/qplayer2-core
### 3\. 打开项目的 oh-package.json5 文件，查看 QPlayer2 的引用
"dependencies": {
"@qiniu/qplayer2-core" : '^1.5.0-preview4' //版本号
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,385 |
基于 Core 的 QPlayer2 接入指南 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2 Harmony
端](https://developer.qiniu.com/pili/sdk/12702/qplayer2-harmony) > 基于 Core 的
QPlayer2 接入指南
# 基于 Core 的 QPlayer2 接入指南
最近更新时间: 2024-06-11 17:46:45
如果业务场景中没有复杂的场景切换，也不想用播放面板定制、播放器上层浮窗定制、播放器上层手势逻辑则可以只用qplayer2-core，接入成本低，学习门槛低。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2 Harmony
端](https://developer.qiniu.com/pili/sdk/12702/qplayer2-harmony) > 基于 Core 的
QPlayer2 接入指南
# 基于 Core 的 QPlayer2 接入指南
最近更新时间: 2024-06-11 17:46:45
如果业务场景中没有复杂的场景切换，也不想用播放面板定制、播放器上层浮窗定制、播放器上层手势逻辑则可以只用qplayer2-core，接入成本低，学习门槛低。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,387 |
快速开始 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2 Harmony
端](https://developer.qiniu.com/pili/sdk/12702/qplayer2-harmony) > [基于 Core 的
QPlayer2 接入指南](https://developer.qiniu.com/pili/sdk/12704/based-on-
qplayer2-access-guide-to-the-core-harmony) > 快速开始
# 快速开始
最近更新时间: 2024-07-31 11:50:08
## 快速开始
### 基于 qplayer2-core 的播放器使用
#### 导入头文件
import { QPlayerContextFactory, QIPlayerContext, QLogLevel,QMediaModel,QSurfaceRenderView} from '@qiniu/qplayer2-core/qplayer2-core'
#### 初始化
@State mPlayerContext : QIPlayerContext = QPlayerContextFactory.createPlayerContext(
QLogLevel.LOG_INFO,
(AppStorage.get("context") as Context).filesDir,
bundleManager.getBundleInfoForSelfSync(bundleManager.BundleFlag.GET_BUNDLE_INFO_DEFAULT).versionName,
"")
this.mPlayerContext.init(AppStorage.get('context') as Context , getContext(this) as common.UIAbilityContext)
#### 设置显示视图
一个 QSurfaceRenderView 对应一个 mPlayerContext , 如果一个 mPlayerContext 对应多个
QSurfaceRenderView 无法保证预期效果
QSurfaceRenderView({ mQPlayerContext: this.mPlayerContext, mXComponentId: this.mXComponentId })
.width('100%')
.height('100%')
#### 播放
let builder : QMediaModelBuilder = new QMediaModelBuilder()
builder.addStreamElement("",QPlayerUrlType.QAUDIO_AND_VIDEO,1080,"http://demo-videos.qnsdk.com/qiniu-2023-1080p.mp4",true,"","")
let model : QMediaModel = builder.build(false)
this.mPlayerContext.get_control_handler().playMediaModel(model,0)
#### 销毁
this.mPlayerContext.get_control_handler().release()
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2 Harmony
端](https://developer.qiniu.com/pili/sdk/12702/qplayer2-harmony) > [基于 Core 的
QPlayer2 接入指南](https://developer.qiniu.com/pili/sdk/12704/based-on-
qplayer2-access-guide-to-the-core-harmony) > 快速开始
# 快速开始
最近更新时间: 2024-07-31 11:50:08
## 快速开始
### 基于 qplayer2-core 的播放器使用
#### 导入头文件
import { QPlayerContextFactory, QIPlayerContext, QLogLevel,QMediaModel,QSurfaceRenderView} from '@qiniu/qplayer2-core/qplayer2-core'
#### 初始化
@State mPlayerContext : QIPlayerContext = QPlayerContextFactory.createPlayerContext(
QLogLevel.LOG_INFO,
(AppStorage.get("context") as Context).filesDir,
bundleManager.getBundleInfoForSelfSync(bundleManager.BundleFlag.GET_BUNDLE_INFO_DEFAULT).versionName,
"")
this.mPlayerContext.init(AppStorage.get('context') as Context , getContext(this) as common.UIAbilityContext)
#### 设置显示视图
一个 QSurfaceRenderView 对应一个 mPlayerContext , 如果一个 mPlayerContext 对应多个
QSurfaceRenderView 无法保证预期效果
QSurfaceRenderView({ mQPlayerContext: this.mPlayerContext, mXComponentId: this.mXComponentId })
.width('100%')
.height('100%')
#### 播放
let builder : QMediaModelBuilder = new QMediaModelBuilder()
builder.addStreamElement("",QPlayerUrlType.QAUDIO_AND_VIDEO,1080,"http://demo-videos.qnsdk.com/qiniu-2023-1080p.mp4",true,"","")
let model : QMediaModel = builder.build(false)
this.mPlayerContext.get_control_handler().playMediaModel(model,0)
#### 销毁
this.mPlayerContext.get_control_handler().release()
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,388 |
基础能力使用 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2 Harmony
端](https://developer.qiniu.com/pili/sdk/12702/qplayer2-harmony) > [基于 Core 的
QPlayer2 接入指南](https://developer.qiniu.com/pili/sdk/12704/based-on-
qplayer2-access-guide-to-the-core-harmony) > 基础能力使用
# 基础能力使用
最近更新时间: 2024-07-31 11:50:12
# 基础能力使用
在 [快速开始 __](https://developer.qiniu.io/pili/12705/qplayer2-core-harmony-quick-
start)中，我们完成了qplayer2播放器的创建\播放\销毁，本文介绍如何使用qplayer2的播放能力
# 播放
## 创建播放数据
let builder : QMediaModelBuilder = new QMediaModelBuilder()
builder.addStreamElement("",QPlayerUrlType.QAUDIO_AND_VIDEO,1080,"http://demo-videos.qnsdk.com/qiniu-2023-1080p.mp4",true,"","")
let model : QMediaModel = builder.build(false)
addStreamElements 属性说明
属性名 | 属性说明
---|---
userType | 用户自定义Type，目前预留，可以填空字符串
url | 资源地址
urlType | 媒体的资源属性 只包含视频/只包含音频/同时有视频音频
quality | 清晰度
isSelected | 是否起播时播放该流
backupUrl | 备用地址
referer | http/https 协议的地址 支持该属性
## 视频URL类型枚举
export enum QPlayerUrlType {
QAUDIO_AND_VIDEO = 0, //音视频
QAUDIO = 1, //纯音频
QVIDEO = 2, //纯视频
NONE = 3, //无
}
## 播放媒体资源
/*** 播放音视频资源
* @param model 音视频资源
*/
this.mPlayerContext.get_control_handler().playMediaModel(model,0)
## 播放错误监听
当视频起播时，如果遇到网络等问题原因，导致没有和服务器建立链接，那么会导致视频播放失败，总共会有3次重试机会，3次都失败的情况下会回调onOpenFailed方法。
当视频已经起播后，在中途遇到网络等问题原因，进入buffer,
那么内核会一直重试，直到再次连接上服务端继续播放，或者用户通过接口停止播放该视频，在重试的过程中 onReconnectStart /
onReconnectEnd
会被回调，那么可以监控回调的次数来做业务层的结束播放的策略，当然在正常播放的情况下，这两个方法也是会被回调的，所以最好结合buffer的回调数据一起使用。
private mMediaNetworkListener : QIPlayerMediaNetworkListener = {
/***
开始重连
@param context 当前的播放器
@param userType 重连url流的userType
@param urlType 重连url流的urlType
@param url 重连的url
@param retryTime 已重试的次数
*/
onReconnectStart:(context : QIPlayerContext , userType: string , urlType: QPlayerUrlType , url: string , retryTime: number ) => {
},
/***
重连结束
@param context 当前的播放器
@param userType 重连url流的userType
@param urlType 重连url流的urlType
@param url 重连的url
@param retryTime 已重试的次数
@param error 错误码
*/
onReconnectEnd:(context : QIPlayerContext , userType: string , urlType: QPlayerUrlType , url: string , retryTime: number , error: QPlayerOpenError ) => {
},
/***
打开失败
@param context 当前的播放器
@param userType 重连url流的userType
@param urlType 重连url流的urlType
@param url 重连的url
@param error 错误码
*/
onOpenFailed:(context : QIPlayerContext , userType: string , urlType: QPlayerUrlType , url: string , error: QPlayerOpenError ) => {
}
}
//添加监听
this.mPlayerContext.get_control_handler().addPlayerMediaNetworkListener(this.mMediaNetworkListener)
//移除监听
this.mPlayerContext.get_control_handler().removePlayerMediaNetworkListener(this.mMediaNetworkListener)
//移除全部监听
this.mPlayerContext.get_control_handler().removeAllPlayerMediaNetworkListener()
## 播放错误码枚举
export enum QPlayerOpenError{
UNKNOW = 10000,
NONE = 0,
IOERROR = -5,
INTERRUPT = -1414092869,
URL_INVALID = -875574520,
FORMAT_INVALID = -1094995529
}
## 暂停播放
this.mPlayerContext.get_control_handler().pauseRender()
## 恢复播放
this.mPlayerContext.get_control_handler().resumeRender()
## 停止当前视频播放
this.mPlayerContext.get_control_handler().stop()
# 鉴权
鉴权功能介绍见 [鉴权相关文档 __](https://developer.qiniu.io/pili/12223/qplayer2-core-
authentication-related)
## 鉴权监听
private mAuthenticationListener : QIPlayerAuthenticationListener = {
/**
@brief 鉴权失败回调
@param context 当前播放器
@param error 失败错误码
*/
onAuthenticationFailed:(context: QIPlayerContext, error:QPlayerAuthenticationErrorType)=>{
this.addToastView(`鉴权失败：${error.valueOf()}`)
},
/**
@brief 鉴权成功回调
@param context 当前播放器
*/
onAuthenticationSuccess:(context: QIPlayerContext)=>{
this.addToastView("鉴权成功")
}
}
//添加监听
this.mPlayerContext.get_control_handler().addPlayerAuthenticationListener(this.mAuthenticationListener)
//移除监听
this.mPlayerContext.get_control_handler().removePlayerAuthenticationListener(this.mAuthenticationListener)
//移除全部监听
this.mPlayerContext.get_control_handler().removeAllPlayerAuthenticationListener()
## 鉴权错误码枚举
/**
鉴权不通过错误码
*/
export enum QPlayerAuthenticationErrorType {
NONE, //鉴权出错
NO_BASE_AUTH, //缺少基础功能权限
NO_VR_AUTH, //缺少VR功能权限
NO_BLIND_AUTH, //缺少色盲功能权限
NO_SEI_AUTH, //缺少SEI功能权限
NO_SRT_AUTH, //缺少SRT功能权限
NO_APM_AUTH //缺少APM功能权限
};
# 视频解码方式
目前支持的解码方式有:软解、硬解、自动，一般情况下，使用自动，内核会根据手机的硬件情况，要播放的视频资源编码格式等信息，挑选合适的解码方式进行解码，各个解码方式的优劣情况如下
软解: 解码较慢，但是兼容性好，适用于所有手机
硬解：解码性能高，但是有一定兼容性，比如某些视频资源的编码格式，硬解芯片不支持。并且相对于软解，首帧的速度慢。
## 设置优先选择哪种解码方式
设置完成后下一次播放生效.
最终的解码方式可能不是设置的，在设置的解码方式不能正确解码时，内核会进行降级，选择其他能正确解码的方式
this.mPlayerContext.get_control_handler().setDecoderType(QPlayerDecoderPriority.AUTO)
# 优先选择的解码方式枚举
该枚举主要用于设置解码方式
typedef NS_ENUM(NSInteger, QPlayerDecoder) {
export enum QPlayerDecoderPriority {
AUTO = 0, //自动
HARDWARE_PRIORITY = 1, //硬解优先
SOFT_PRIORITY = 2, //软解优先
}
};
## 播放器视频解码监听相关
private mDecoderTypeListener : QIPlayerVideoDecodeListener = {
/**
当前视频用的是哪种解码方式
@param context 当前的播放器
@param type 解码方式
*/
onVideoDecodeByType:(context : QIPlayerContext , type: QPlayerDecoderType) =>{
}
/**
* 通知当前视频解码失败，
* @param retry 底层是重试
*/
onDecodeFailed:(context : QIPlayerContext , retry: boolean) => {
}
/**
如果当前视频编码 所在设备或者sdk不支持 则回调该方法
@param context 当前的播放器
@param codecId 视频的编码id
*/
onNotSupportCodecFormat:(context : QIPlayerContext , codec: number) => {
}
}
//添加监听
this.mPlayerContext.get_control_handler().addPlayerVideoDecodeTypeListener(this.mDecoderTypeListener)
//移除监听
this.mPlayerContext.get_control_handler().removePlayeVideoDecodeTypeListener(this.mDecoderTypeListener)
//移除所有监听
this.mPlayerContext.get_control_handler().removeAllPlayerVideoDecodeTypeListener()
## 解码方式枚举
该枚举主要用于监听返回的解码方式
export enum QPlayerDecoderType{
NONE = 0, //无
SOFTWARE = 1, //软解
HARDWARE = 30, //硬解
}
# 切换视频进度
参数为要定位的position 单位毫秒
this.mPlayerContext.get_control_handler().seek(1000)
# 设置起播方式
下一次播放生效
this.mPlayerContext.get_control_handler().setSeekMode(QPlayerSeek.NORMAL)
## seek方式枚举
export enum QPlayerSeek {
NORMAL = 0, //关键帧
ACCURATE = 1, //精准
}
## seek 状态监听
一般情况下
seek都会成功，如果网络差的情况下，会无限loading（除非调用stop才会停止），直到seek到指定的位置为止。但是如果视频源本身是格式不正确的，比如pts错乱等问题，才会导致seek失败，所以在seek失败回调中，做好提示工作就好，不要尝试再次seek
private mSeekListener : QIPlayerSeekListener = {
/**
seek成功回调
@param context 当前的播放器
*/
onSeekSuccess:(context : QIPlayerContext) => {
},
/**
seek失败回调
@param context 当前的播放器
*/
onSeekFailed:(context : QIPlayerContext) => {
}
}
//添加监听
this.mPlayerContext.get_control_handler().addPlayerSeekListener(this.mSeekListener)
//移除监听
this.mPlayerContext.get_control_handler().removePlayerSeekListener(this.mSeekListener)
//移除全部监听
this.mPlayerContext.get_control_handler().removeAllPlayerSeekListener()
## 获取当前播放状态
this.mPlayerContext.get_control_handler().currentPlayerState
## 获取视频时长
this.mPlayerContext.get_control_handler().duration
## 获取当前进度
this.mPlayerContext.get_control_handler().currentPosition
## 获取当前下载速度
this.mPlayerContext.get_control_handler().downloadSpeed
## 获取当前缓冲进度
this.mPlayerContext.get_control_handler().bufferPostion
## 播放器状态
在整个播放器实例生命周期中，播放会在不同的状态中切换，用户可以通过监听播放器状态，实现上层业务逻辑，
比如在视频播放完时，展示其他视频的推荐页，那么只需监听播放器状态回调，待回调的状态是COMPLETED，则展示推荐页
### 播放器状态枚举
export enum QPlayerState {
NONE = 0, //初始状态 0
INIT = 1, //播放器开始创建各种对象 没有对应的state 创建完对象就上报这个状态 1
PREPARE = 2, //开始拉视频数据解码变换等，重新换地址后，都走这个状态 2
PLAYING = 4, //播放中 4
PAUSED_RENDER = 6, //暂停渲染 6
COMPLETED = 7, //播放完成 7
SEEKING = 8, //SEEK 8
STOPPED = 9, //停止当前播放的视频 9
MISTAKE = 10, //播放出错 是否需要分 可恢复 和 不可恢复 10
END = 11, //播放器释放各种对象完成 11
MEDIA_ITEM_PREPARE = 12, //开始拉视频数据解码变换等，重新换地址后，都走这个状态 针对Media Item的play 方式 12
RELEASE = 13 //播放器结束，且释放各类资源 13
}
### 播放器状态变更监听相关
private mStateChangeListener : QIPlayerStateChangeListener ={
/**
状态变更回调
@param context 当前的播放器
@param state 播放器状态
*/
onStateChange:(context : QIPlayerContext ,state: QPlayerState)=>{
}
}
//添加监听
this.mPlayerContext.get_control_handler().addPlayerStateListener(this.mStateChangeListener)
//移除监听
this.mPlayerContext.get_control_handler().removePlayerStateListener(this.mStateChangeListener)
//移除全部监听
this.mPlayerContext.get_control_handler().removeAllPlayerStateListener()
# 播放速度
播放速度的调整范围建议在0.25-2.0之间，这样会有一个比较好的效果
## 设置播放速度
参数为倍速值
this.mPlayerContext.get_control_handler().setSpeed(0.5)
## 获取当前播放速度
this.mPlayerContext.get_control_handler().playerSpeed
## 速度变更监听相关
private mPlaySpeed : QIPlayerSpeedListener = {
/**
倍速改变回调
@param context 当前的播放器
@param speed 改变后的倍速
*/
onSpeedChanged:(context : QIPlayerContext, speed:number)=>{
}
}
//添加监听
this.mPlayerContext.get_control_handler().addPlayerSpeedChangeListener(this.mPlaySpeed)
//移除监听
this.mPlayerContext.get_control_handler().removePlayeSpeedChangeListener(this.mPlaySpeed)
//移除所有监听
this.mPlayerContext.get_control_handler().removeAllPlayerSpeedChangeListener()
# 清晰度
QPlayer2提供的清晰度能力是无缝切换清晰度方案，在切换过程中，画面是连续的画面，不会出现类似跳帧的情况。
使用无缝切换清晰度功能，必须在mediaModel中配置多路清晰度，如果使用非immediately方式(即异步方式)时，同时只能有一次切换会话存在，会话结束后，才能切下一次
## 切换视频清晰度
//使用该方法时，mediaModel中需要存在多个StreamElement
/**
切换清晰度
@param userType 切换清晰度的url流的userType
@param urlType 切换清晰度的url流的 urlType
@param quality 要切到哪路清晰度
@param immediately true 立即切换 用于直播流，false 无缝切换，切换过程是一个异步过程，用于点播流
@return true 调用成功， false 调用失败
*/
this.mPlayerContext.get_control_handler().switchQuality("",QPlayerUrlType.QAUDIO_AND_VIDEO,1080,false)
## 获取当前的清晰度
//使用该方法时，mediaModel中需要存在多个StreamElement，返回清晰度数值标记
/**
获取指定 userType urlType 的清晰度
@param userType 切换清晰度的url流的userType
@param urlType 切换清晰度的url流的 urlType
@return true 调用成功， false 调用失败
*/
this.mPlayerContext.get_control_handler().getCurrentQuality("",QPlayerUrlType.QAUDIO_AND_VIDEO)
## 获取当前正在切换的清晰度
/**
获取指定 userType urlType 流正在切换的清晰度（非immediately方式）
@param userType 切换清晰度的url流的userType
@param urlType 切换清晰度的url流的 urlType
@return true 调用成功， false 调用失败
*/
this.mPlayerContext.get_control_handler().getSwitchingQuality("",QPlayerUrlType.QAUDIO_AND_VIDEO)
## 播放器清晰度相关监听
private mQualityListener: QIPlayerQualityListener = {
/**
开始清晰度切换
@param context 当前的播放器
@param usertype 开始切换清晰度的url流的userType
@param urlType 开始切换清晰度的url流的
@param oldQuality 切换前的清晰度
@param newQuality 要切到哪路清晰度
*/
onQualitySwitchStart:(context : QIPlayerContext , usertype: string , urlType: QPlayerUrlType , oldQuality: number , newQuality: number ) =>{
}
/**
清晰度切换完成
@param context 当前的播放器
@param usertype 开始切换清晰度的url流的userType
@param urlType 开始切换清晰度的url流的
@param oldQuality 切换前的清晰度
@param newQuality 要切到哪路清晰度
*/
onQualitySwitchComplete:(context : QIPlayerContext , usertype: string , urlType: QPlayerUrlType , oldQuality: number , newQuality: number ) =>{
}
/**
清晰度切换取消
@param context 当前的播放器
@param usertype 开始切换清晰度的url流的userType
@param urlType 开始切换清晰度的url流的
@param oldQuality 切换前的清晰度
@param newQuality 要切到哪路清晰度
*/
onQualitySwitchCanceled:(context : QIPlayerContext , usertype: string , urlType: QPlayerUrlType , oldQuality: number , newQuality: number ) =>{
}
/**
清晰度切换失败
@param context 当前的播放器
@param usertype 开始切换清晰度的url流的userType
@param urlType 开始切换清晰度的url流的
@param oldQuality 切换前的清晰度
@param newQuality 要切到哪路清晰度
*/
onQualitySwitchFailed:(context : QIPlayerContext , usertype: string , urlType: QPlayerUrlType , oldQuality: number , newQuality: number ) =>{
}
/**
目前仅支持同时有一个清晰度切换，如果前一个还未切换完，再次发起切换 会回调这个函数
@param context 当前的播放器
@param usertype 开始切换清晰度的url流的userType
@param urlType 开始切换清晰度的url流的
*/
onQualitySwitchRetryLater:(context : QIPlayerContext , usertype: string , urlType: QPlayerUrlType ) =>{
}
}
//添加监听
this.mPlayerContext.get_control_handler().addPlayerQualityListener(this.mQualityListener)
//移除监听
this.mPlayerContext.get_control_handler().removePlayerQualityListener(this.mQualityListener)
//移除所有监听
this.mPlayerContext.get_control_handler().removeAllPlayerQualityListener()
## 直播支持多路清晰度切换
无缝切换清晰度方案需要配置以下三个条件
1. 首先切换的模式要选择立即切换即：immediately=true
2. 服务端配置PTS透传，
3. 对应的清晰度要做主动转码设置
如果无法满足以上3个条件，那么建议用最基础的能力来实现清晰度切换，即每个清晰度都是一个media
model，切换时，调用playMediaModel来播放新的清晰度流。
# 视频宽高改变监听
在视频首帧渲染时，会调用该回调，告诉上层当前的视频宽高是多少，如果在这个这个视频播放的生命周期中，宽高改变，那么还会再次调用该回调.
private mVideoFrameSizeChangedListener : QIPlayerVideoFrameSizeChangeListener ={
/**
推流端视频长宽变化回调
@param context 当前的播放器
@param width 视频宽度
@param height 视频高度
*/
onVideoFrameSizeChanged:(context : QIPlayerContext, width: number, height:number ) =>{
}
}
//添加监听
this.mPlayerContext.get_control_handler().addPlayerVideoFrameSizeChangeListener(this.mVideoFrameSizeChangedListener)
//移除监听
this.mPlayerContext.get_control_handler().removePlayerVideoFrameSizeChangeListener(this.mVideoFrameSizeChangedListener)
//移除所有监听
this.mPlayerContext.get_control_handler().removeAllPlayerVideoFrameSizeChangeListener()
# 播放进度监听
只有在点播的时候 duration 和 progress 才有意义，直播的话这两个值没有参考意义
private mProgressListener : QIPlayerProgressListener = {
/***
进度变更回调
@param context 当前的播放器
@param progress 当前进度 单位毫秒
@param duration 当前视频总时长 单位毫秒
*/
onProgressChanged:(context:QIPlayerContext, progress:number, duration:number) => {
}
}
//添加监听
this.mPlayerContext.get_control_handler().addPlayerProgressChangeListener(this.mProgressListener)
//移除监听
this.mPlayerContext.get_control_handler().removePlayerProgressChangeListener(this.mProgressListener)
//移除全部监听
this.mPlayerContext.get_control_handler().removeAllPlayerProgressChangeListener()
# 实时帧率
## 获取当前fps
this.mPlayerContext.get_control_handler().fps
## 实时帧率监听
private mFPSListener : QIPlayerFPSListener = {
/**
@brief fps 改变的回调
@param context 当前的播放器
@param fps 帧率
*/
onFPSChanged:(context:QIPlayerContext, FPS:number)=>{
}
}
//添加监听
this.mPlayerContext.get_control_handler().addPlayerFPSChangeListener(this.mFPSListener)
//移除监听
this.mPlayerContext.get_control_handler().removePlayerFPSChangeListener(this.mFPSListener)
//移除全部监听
this.mPlayerContext.get_control_handler().removeAllPlayerFPSChangeListener()
# 像素格式或者音频sample格式不支持的监听
private mFormatListener : QIPlayerFormatListener = {
/**
@brief 当前有format 不支持，所以视频没法播放
@param context 当前的播放器
*/
onFormatNotSupport:(context:QIPlayerContext)=>{
}
}
//添加监听
this.mPlayerContext.get_control_handler().addPlayerFormatListener(this.mFormatListener)
//移除监听
this.mPlayerContext.get_control_handler().removePlayerFormatListener(this.mFormatListener)
//移除全部监听
this.mPlayerContext.get_control_handler().removeAllPlayerFormatListener()
# 缓冲拉流监听
private mDownloadListener : QIPlayerDownloadListener = {
/**
@brief 拉流速率改变
@param context 当前的播放器
@param downloadSpeed 速度 单位: b/s (比特每秒)
@param bufferPos 缓冲的进度
*/
onDownloadChanged:(context:QIPlayerContext, speed:number, bufferPos:number)=>{
}
}
//添加监听
this.mPlayerContext.get_control_handler().addPlayerDownloadChangeListener(this.mDownloadListener)
//移除监听
this.mPlayerContext.get_control_handler().removePlayerDownloadChangeListener(this.mDownloadListener)
//移除全部监听
this.mPlayerContext.get_control_handler().removeAllPlayerDownloadChangeListener()
## 播放器操作不允许执行监听
在某些状态下，一些操作将不被执行，通过该监听回调上来通知
private mCommandNotAllowListener : QIPlayerCommandNotAllowListener = {
/**
@brief 操作不被允许回调
@param context 操作异常的播放器
@param commandName 操作名称
@param state 操作被检测时播放器的状态
*/
onCommandNotAllow:(context:QIPlayerContext, commandName:string, state:QPlayerState)=>{}
}
//添加监听
this.mPlayerContext.get_control_handler().addPlayerCommandNotAllowListener(this.mCommandNotAllowListener)
//移除监听
this.mPlayerContext.get_control_handler().removePlayerCommandNotAllowListener(this.mCommandNotAllowListener)
//移除全部监听
this.mPlayerContext.get_control_handler().removeAllPlayerCommandNotAllowListener()
## buffering 监听
private mBufferingListener : QIPlayerBufferingListener = {
/**
@brief 开始buffering
@param context 当前播放器
*/
onBufferingStart:(context:QIPlayerContext)=>{
},
/**
@brief 结束buffering
@param context 当前播放器
*/
onBufferingEnd:(context: QIPlayerContext)=>{}
}
//添加监听
this.mPlayerContext.get_control_handler().addPlayerBufferingChangeListener(this.mBufferingListener)
//移除监听
this.mPlayerContext.get_control_handler().removePlayerBufferingChangeListener(this.mBufferingListener)
//移除全部监听
this.mPlayerContext.get_control_handler().removeAllPlayerBufferingChangeListener()
# 截图
调用截图接口，就会回调截图时的video画面，并以jpeg的格式返回
/**
截图
*/
this.mPlayerContext.get_control_handler().shootVideo()
## 截图图片类型枚举
/**
截图图片类型
*/
export enum QPlayerShootVideoType {
NONE = 0,
JPEG //jpeg格式
};
## 截图相关监听
private mShootVideoListener : QIPlayerShootVideoListener = {
/**
截图成功回调
@param context 当前的播放器
@param imageData 图片的 NSData 数据
@param width 图片的宽
@param height 图片的高
@param type 图片类型
*/
onShootSuccessful:(context : QIPlayerContext, imageData:Uint8Array, width:number, height:number, type: QPlayerShootVideoType) =>{
}
/**
截图失败回调
@param context 当前的播放器
*/
onShootFailed:(context : QIPlayerContext) =>{
}
}
//添加监听
this.mPlayerContext.get_control_handler().addPlayerShootVideoListener(this.mShootVideoListener)
//移除监听
this.mPlayerContext.get_control_handler().removePlayerShootVideoListener(this.mShootVideoListener)
//移除所有监听
this.mPlayerContext.get_control_handler().removeAllPlayerShootVideoListener()
# 码率
## 获取当前码率
this.mPlayerContext.get_control_handler().biteRate
## 实时码率监听
private mBiteRateListener : QIPlayerBiteRateListener = {
/**
@brief 码率变换回调
@param context 当前播放器
@param bitrate 比特率， 单位：bps
*/
onBiteRateChanged:(context:QIPlayerContext, bitrate:number)=>{}
}
//添加监听
this.mPlayerContext.get_control_handler().addPlayerBiteRateChangeListener(this.mBiteRateListener)
//移除监听
this.mPlayerContext.get_control_handler().removePlayerBiteRateChangeListener(this.mBiteRateListener)
//移除全部监听
this.mPlayerContext.get_control_handler().removeAllPlayerBiteRateChangeListener()
# SEI 数据回调
用户自定义数据可以带在H264或者H265的编码帧里，用于实现一些基于时间轴的业务场景。
开启该功能后，如果视频资源内带有SEI数据 会通过监听接口抛给业务层。
该功能需要单独开通，具体可以联系技术支持咨询。
## 开启 SEI
this.mPlayerContext.get_control_handler().setSEIEnable(true)
## SEI 数据监听
private mSEIListener: QIPlayerSEIDataListener = {
/**
SEI 数据回调，且回调时机为SEI数据所在帧的时间
@param context 当前的播放器
@param data SEI 数据
*/
onSEIData:(context:QIPlayerContext, data:Uint8Array)=>{
}
}
//添加监听
this.mPlayerContext.get_control_handler().addPlayerSEIDataListener(this.mSEIListener)
//移除监听
this.mPlayerContext.get_control_handler().removePlayerSEIDataListener(this.mSEIListener)
//移除所有监听
this.mPlayerContext.get_control_handler().removeAllPlayerSEIDataListener()
# 渲染相关监听
private mRenderListener : QIPlayerRenderListener = {
/**
首帧耗时回调
@param context 当前的播放器
@param elapsedTime 从play 开始到首帧渲染出来的总耗时 单位毫秒
*/
onFirstFrameRendered:(context : QIPlayerContext, elapsedTime:number) => {
}
}
//添加监听
this.mPlayerContext.get_render_handler().addPlayerRenderListener(this.mRenderListener)
//移除监听
this.mPlayerContext.get_control_handler().removePlayerRenderListener(this.mRenderListener)
//移除全部监听
this.mPlayerContext.get_control_handler().removeAllPlayerRenderListener()
# 设置视频渲染比例
this.mPlayerContext.get_render_handler().setRenderRatio(QRenderRatio.AUTO)
## 视频比例枚举
export enum QRenderRatio {
AUTO = 1,
FULL_SCREEN, //铺满
STRETCH, //拉伸
Ratio_16_9, //16:9
Ratio_4_3, //4:3
}
# 设置色觉优化
this.mPlayerContext.get_render_handler().setBlindType(QBlindType.NONE)
## 色觉优化枚举
export enum QBlindType {
NONE = 0, //无
RED = 1, //红色盲
GREEN = 2, //绿色盲
BLUE = 3, //蓝色盲
}
# 后台播放
后台播放除了 QPlayer2 设置以外，还需要申请鸿蒙的长时任务和音频后台播放。同时还在 module.json 中需要申请后台播放权限
## 设置是否支持后台播放
/**
*设置是否后台播放
* @param enable yes后台播放，no后台播放暂停
*/
this.mPlayerContext.get_control_handler().setBackgroundPlayEnable(true)
### 鸿蒙长时任务和音频后台播放
async createSession() {
let type: AVSessionManager.AVSessionType = 'audio';
let session = await AVSessionManager.createAVSession(this.context,'SESSION_NAME', type);
// 激活接口要在元数据、控制命令注册完成之后再执行
await session.activate();
console.info(`session create done : sessionId : ${session.sessionId}`);
}
onBackground() {
// Ability has back to background
hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onBackground');
this.createSession()
let wantAgentInfo : wantAgent.WantAgentInfo = {
wants: [
{
bundleName: "com.qiniu.qplayer2demo",
abilityName: "EntryAbility"
}
],
// 点击通知后，动作类型
operationType: wantAgent.OperationType.START_ABILITY,
requestCode: 0,
// 点击通知后，动作执行属性
wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
};
wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj : WantAgent) => {
hilog.info(0x0000, 'testTag', '%{public}s', 'getWantAgent');
backgroundTaskManager.startBackgroundRunning(this.context,
backgroundTaskManager.BackgroundMode.AUDIO_PLAYBACK, wantAgentObj).then(() => {
console.info("Operation startBackgroundRunning succeeded");
}).catch((err: BusinessError) => {
console.error("Operation startBackgroundRunning failed Cause: " + err);
});
});
}
## 后台播放权限申请
{
"name": "ohos.permission.KEEP_BACKGROUND_RUNNING"
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2 Harmony
端](https://developer.qiniu.com/pili/sdk/12702/qplayer2-harmony) > [基于 Core 的
QPlayer2 接入指南](https://developer.qiniu.com/pili/sdk/12704/based-on-
qplayer2-access-guide-to-the-core-harmony) > 基础能力使用
# 基础能力使用
最近更新时间: 2024-07-31 11:50:12
# 基础能力使用
在 [快速开始 __](https://developer.qiniu.io/pili/12705/qplayer2-core-harmony-quick-
start)中，我们完成了qplayer2播放器的创建\播放\销毁，本文介绍如何使用qplayer2的播放能力
# 播放
## 创建播放数据
let builder : QMediaModelBuilder = new QMediaModelBuilder()
builder.addStreamElement("",QPlayerUrlType.QAUDIO_AND_VIDEO,1080,"http://demo-videos.qnsdk.com/qiniu-2023-1080p.mp4",true,"","")
let model : QMediaModel = builder.build(false)
addStreamElements 属性说明
属性名 | 属性说明
---|---
userType | 用户自定义Type，目前预留，可以填空字符串
url | 资源地址
urlType | 媒体的资源属性 只包含视频/只包含音频/同时有视频音频
quality | 清晰度
isSelected | 是否起播时播放该流
backupUrl | 备用地址
referer | http/https 协议的地址 支持该属性
## 视频URL类型枚举
export enum QPlayerUrlType {
QAUDIO_AND_VIDEO = 0, //音视频
QAUDIO = 1, //纯音频
QVIDEO = 2, //纯视频
NONE = 3, //无
}
## 播放媒体资源
/*** 播放音视频资源
* @param model 音视频资源
*/
this.mPlayerContext.get_control_handler().playMediaModel(model,0)
## 播放错误监听
当视频起播时，如果遇到网络等问题原因，导致没有和服务器建立链接，那么会导致视频播放失败，总共会有3次重试机会，3次都失败的情况下会回调onOpenFailed方法。
当视频已经起播后，在中途遇到网络等问题原因，进入buffer,
那么内核会一直重试，直到再次连接上服务端继续播放，或者用户通过接口停止播放该视频，在重试的过程中 onReconnectStart /
onReconnectEnd
会被回调，那么可以监控回调的次数来做业务层的结束播放的策略，当然在正常播放的情况下，这两个方法也是会被回调的，所以最好结合buffer的回调数据一起使用。
private mMediaNetworkListener : QIPlayerMediaNetworkListener = {
/***
开始重连
@param context 当前的播放器
@param userType 重连url流的userType
@param urlType 重连url流的urlType
@param url 重连的url
@param retryTime 已重试的次数
*/
onReconnectStart:(context : QIPlayerContext , userType: string , urlType: QPlayerUrlType , url: string , retryTime: number ) => {
},
/***
重连结束
@param context 当前的播放器
@param userType 重连url流的userType
@param urlType 重连url流的urlType
@param url 重连的url
@param retryTime 已重试的次数
@param error 错误码
*/
onReconnectEnd:(context : QIPlayerContext , userType: string , urlType: QPlayerUrlType , url: string , retryTime: number , error: QPlayerOpenError ) => {
},
/***
打开失败
@param context 当前的播放器
@param userType 重连url流的userType
@param urlType 重连url流的urlType
@param url 重连的url
@param error 错误码
*/
onOpenFailed:(context : QIPlayerContext , userType: string , urlType: QPlayerUrlType , url: string , error: QPlayerOpenError ) => {
}
}
//添加监听
this.mPlayerContext.get_control_handler().addPlayerMediaNetworkListener(this.mMediaNetworkListener)
//移除监听
this.mPlayerContext.get_control_handler().removePlayerMediaNetworkListener(this.mMediaNetworkListener)
//移除全部监听
this.mPlayerContext.get_control_handler().removeAllPlayerMediaNetworkListener()
## 播放错误码枚举
export enum QPlayerOpenError{
UNKNOW = 10000,
NONE = 0,
IOERROR = -5,
INTERRUPT = -1414092869,
URL_INVALID = -875574520,
FORMAT_INVALID = -1094995529
}
## 暂停播放
this.mPlayerContext.get_control_handler().pauseRender()
## 恢复播放
this.mPlayerContext.get_control_handler().resumeRender()
## 停止当前视频播放
this.mPlayerContext.get_control_handler().stop()
# 鉴权
鉴权功能介绍见 [鉴权相关文档 __](https://developer.qiniu.io/pili/12223/qplayer2-core-
authentication-related)
## 鉴权监听
private mAuthenticationListener : QIPlayerAuthenticationListener = {
/**
@brief 鉴权失败回调
@param context 当前播放器
@param error 失败错误码
*/
onAuthenticationFailed:(context: QIPlayerContext, error:QPlayerAuthenticationErrorType)=>{
this.addToastView(`鉴权失败：${error.valueOf()}`)
},
/**
@brief 鉴权成功回调
@param context 当前播放器
*/
onAuthenticationSuccess:(context: QIPlayerContext)=>{
this.addToastView("鉴权成功")
}
}
//添加监听
this.mPlayerContext.get_control_handler().addPlayerAuthenticationListener(this.mAuthenticationListener)
//移除监听
this.mPlayerContext.get_control_handler().removePlayerAuthenticationListener(this.mAuthenticationListener)
//移除全部监听
this.mPlayerContext.get_control_handler().removeAllPlayerAuthenticationListener()
## 鉴权错误码枚举
/**
鉴权不通过错误码
*/
export enum QPlayerAuthenticationErrorType {
NONE, //鉴权出错
NO_BASE_AUTH, //缺少基础功能权限
NO_VR_AUTH, //缺少VR功能权限
NO_BLIND_AUTH, //缺少色盲功能权限
NO_SEI_AUTH, //缺少SEI功能权限
NO_SRT_AUTH, //缺少SRT功能权限
NO_APM_AUTH //缺少APM功能权限
};
# 视频解码方式
目前支持的解码方式有:软解、硬解、自动，一般情况下，使用自动，内核会根据手机的硬件情况，要播放的视频资源编码格式等信息，挑选合适的解码方式进行解码，各个解码方式的优劣情况如下
软解: 解码较慢，但是兼容性好，适用于所有手机
硬解：解码性能高，但是有一定兼容性，比如某些视频资源的编码格式，硬解芯片不支持。并且相对于软解，首帧的速度慢。
## 设置优先选择哪种解码方式
设置完成后下一次播放生效.
最终的解码方式可能不是设置的，在设置的解码方式不能正确解码时，内核会进行降级，选择其他能正确解码的方式
this.mPlayerContext.get_control_handler().setDecoderType(QPlayerDecoderPriority.AUTO)
# 优先选择的解码方式枚举
该枚举主要用于设置解码方式
typedef NS_ENUM(NSInteger, QPlayerDecoder) {
export enum QPlayerDecoderPriority {
AUTO = 0, //自动
HARDWARE_PRIORITY = 1, //硬解优先
SOFT_PRIORITY = 2, //软解优先
}
};
## 播放器视频解码监听相关
private mDecoderTypeListener : QIPlayerVideoDecodeListener = {
/**
当前视频用的是哪种解码方式
@param context 当前的播放器
@param type 解码方式
*/
onVideoDecodeByType:(context : QIPlayerContext , type: QPlayerDecoderType) =>{
}
/**
* 通知当前视频解码失败，
* @param retry 底层是重试
*/
onDecodeFailed:(context : QIPlayerContext , retry: boolean) => {
}
/**
如果当前视频编码 所在设备或者sdk不支持 则回调该方法
@param context 当前的播放器
@param codecId 视频的编码id
*/
onNotSupportCodecFormat:(context : QIPlayerContext , codec: number) => {
}
}
//添加监听
this.mPlayerContext.get_control_handler().addPlayerVideoDecodeTypeListener(this.mDecoderTypeListener)
//移除监听
this.mPlayerContext.get_control_handler().removePlayeVideoDecodeTypeListener(this.mDecoderTypeListener)
//移除所有监听
this.mPlayerContext.get_control_handler().removeAllPlayerVideoDecodeTypeListener()
## 解码方式枚举
该枚举主要用于监听返回的解码方式
export enum QPlayerDecoderType{
NONE = 0, //无
SOFTWARE = 1, //软解
HARDWARE = 30, //硬解
}
# 切换视频进度
参数为要定位的position 单位毫秒
this.mPlayerContext.get_control_handler().seek(1000)
# 设置起播方式
下一次播放生效
this.mPlayerContext.get_control_handler().setSeekMode(QPlayerSeek.NORMAL)
## seek方式枚举
export enum QPlayerSeek {
NORMAL = 0, //关键帧
ACCURATE = 1, //精准
}
## seek 状态监听
一般情况下
seek都会成功，如果网络差的情况下，会无限loading（除非调用stop才会停止），直到seek到指定的位置为止。但是如果视频源本身是格式不正确的，比如pts错乱等问题，才会导致seek失败，所以在seek失败回调中，做好提示工作就好，不要尝试再次seek
private mSeekListener : QIPlayerSeekListener = {
/**
seek成功回调
@param context 当前的播放器
*/
onSeekSuccess:(context : QIPlayerContext) => {
},
/**
seek失败回调
@param context 当前的播放器
*/
onSeekFailed:(context : QIPlayerContext) => {
}
}
//添加监听
this.mPlayerContext.get_control_handler().addPlayerSeekListener(this.mSeekListener)
//移除监听
this.mPlayerContext.get_control_handler().removePlayerSeekListener(this.mSeekListener)
//移除全部监听
this.mPlayerContext.get_control_handler().removeAllPlayerSeekListener()
## 获取当前播放状态
this.mPlayerContext.get_control_handler().currentPlayerState
## 获取视频时长
this.mPlayerContext.get_control_handler().duration
## 获取当前进度
this.mPlayerContext.get_control_handler().currentPosition
## 获取当前下载速度
this.mPlayerContext.get_control_handler().downloadSpeed
## 获取当前缓冲进度
this.mPlayerContext.get_control_handler().bufferPostion
## 播放器状态
在整个播放器实例生命周期中，播放会在不同的状态中切换，用户可以通过监听播放器状态，实现上层业务逻辑，
比如在视频播放完时，展示其他视频的推荐页，那么只需监听播放器状态回调，待回调的状态是COMPLETED，则展示推荐页
### 播放器状态枚举
export enum QPlayerState {
NONE = 0, //初始状态 0
INIT = 1, //播放器开始创建各种对象 没有对应的state 创建完对象就上报这个状态 1
PREPARE = 2, //开始拉视频数据解码变换等，重新换地址后，都走这个状态 2
PLAYING = 4, //播放中 4
PAUSED_RENDER = 6, //暂停渲染 6
COMPLETED = 7, //播放完成 7
SEEKING = 8, //SEEK 8
STOPPED = 9, //停止当前播放的视频 9
MISTAKE = 10, //播放出错 是否需要分 可恢复 和 不可恢复 10
END = 11, //播放器释放各种对象完成 11
MEDIA_ITEM_PREPARE = 12, //开始拉视频数据解码变换等，重新换地址后，都走这个状态 针对Media Item的play 方式 12
RELEASE = 13 //播放器结束，且释放各类资源 13
}
### 播放器状态变更监听相关
private mStateChangeListener : QIPlayerStateChangeListener ={
/**
状态变更回调
@param context 当前的播放器
@param state 播放器状态
*/
onStateChange:(context : QIPlayerContext ,state: QPlayerState)=>{
}
}
//添加监听
this.mPlayerContext.get_control_handler().addPlayerStateListener(this.mStateChangeListener)
//移除监听
this.mPlayerContext.get_control_handler().removePlayerStateListener(this.mStateChangeListener)
//移除全部监听
this.mPlayerContext.get_control_handler().removeAllPlayerStateListener()
# 播放速度
播放速度的调整范围建议在0.25-2.0之间，这样会有一个比较好的效果
## 设置播放速度
参数为倍速值
this.mPlayerContext.get_control_handler().setSpeed(0.5)
## 获取当前播放速度
this.mPlayerContext.get_control_handler().playerSpeed
## 速度变更监听相关
private mPlaySpeed : QIPlayerSpeedListener = {
/**
倍速改变回调
@param context 当前的播放器
@param speed 改变后的倍速
*/
onSpeedChanged:(context : QIPlayerContext, speed:number)=>{
}
}
//添加监听
this.mPlayerContext.get_control_handler().addPlayerSpeedChangeListener(this.mPlaySpeed)
//移除监听
this.mPlayerContext.get_control_handler().removePlayeSpeedChangeListener(this.mPlaySpeed)
//移除所有监听
this.mPlayerContext.get_control_handler().removeAllPlayerSpeedChangeListener()
# 清晰度
QPlayer2提供的清晰度能力是无缝切换清晰度方案，在切换过程中，画面是连续的画面，不会出现类似跳帧的情况。
使用无缝切换清晰度功能，必须在mediaModel中配置多路清晰度，如果使用非immediately方式(即异步方式)时，同时只能有一次切换会话存在，会话结束后，才能切下一次
## 切换视频清晰度
//使用该方法时，mediaModel中需要存在多个StreamElement
/**
切换清晰度
@param userType 切换清晰度的url流的userType
@param urlType 切换清晰度的url流的 urlType
@param quality 要切到哪路清晰度
@param immediately true 立即切换 用于直播流，false 无缝切换，切换过程是一个异步过程，用于点播流
@return true 调用成功， false 调用失败
*/
this.mPlayerContext.get_control_handler().switchQuality("",QPlayerUrlType.QAUDIO_AND_VIDEO,1080,false)
## 获取当前的清晰度
//使用该方法时，mediaModel中需要存在多个StreamElement，返回清晰度数值标记
/**
获取指定 userType urlType 的清晰度
@param userType 切换清晰度的url流的userType
@param urlType 切换清晰度的url流的 urlType
@return true 调用成功， false 调用失败
*/
this.mPlayerContext.get_control_handler().getCurrentQuality("",QPlayerUrlType.QAUDIO_AND_VIDEO)
## 获取当前正在切换的清晰度
/**
获取指定 userType urlType 流正在切换的清晰度（非immediately方式）
@param userType 切换清晰度的url流的userType
@param urlType 切换清晰度的url流的 urlType
@return true 调用成功， false 调用失败
*/
this.mPlayerContext.get_control_handler().getSwitchingQuality("",QPlayerUrlType.QAUDIO_AND_VIDEO)
## 播放器清晰度相关监听
private mQualityListener: QIPlayerQualityListener = {
/**
开始清晰度切换
@param context 当前的播放器
@param usertype 开始切换清晰度的url流的userType
@param urlType 开始切换清晰度的url流的
@param oldQuality 切换前的清晰度
@param newQuality 要切到哪路清晰度
*/
onQualitySwitchStart:(context : QIPlayerContext , usertype: string , urlType: QPlayerUrlType , oldQuality: number , newQuality: number ) =>{
}
/**
清晰度切换完成
@param context 当前的播放器
@param usertype 开始切换清晰度的url流的userType
@param urlType 开始切换清晰度的url流的
@param oldQuality 切换前的清晰度
@param newQuality 要切到哪路清晰度
*/
onQualitySwitchComplete:(context : QIPlayerContext , usertype: string , urlType: QPlayerUrlType , oldQuality: number , newQuality: number ) =>{
}
/**
清晰度切换取消
@param context 当前的播放器
@param usertype 开始切换清晰度的url流的userType
@param urlType 开始切换清晰度的url流的
@param oldQuality 切换前的清晰度
@param newQuality 要切到哪路清晰度
*/
onQualitySwitchCanceled:(context : QIPlayerContext , usertype: string , urlType: QPlayerUrlType , oldQuality: number , newQuality: number ) =>{
}
/**
清晰度切换失败
@param context 当前的播放器
@param usertype 开始切换清晰度的url流的userType
@param urlType 开始切换清晰度的url流的
@param oldQuality 切换前的清晰度
@param newQuality 要切到哪路清晰度
*/
onQualitySwitchFailed:(context : QIPlayerContext , usertype: string , urlType: QPlayerUrlType , oldQuality: number , newQuality: number ) =>{
}
/**
目前仅支持同时有一个清晰度切换，如果前一个还未切换完，再次发起切换 会回调这个函数
@param context 当前的播放器
@param usertype 开始切换清晰度的url流的userType
@param urlType 开始切换清晰度的url流的
*/
onQualitySwitchRetryLater:(context : QIPlayerContext , usertype: string , urlType: QPlayerUrlType ) =>{
}
}
//添加监听
this.mPlayerContext.get_control_handler().addPlayerQualityListener(this.mQualityListener)
//移除监听
this.mPlayerContext.get_control_handler().removePlayerQualityListener(this.mQualityListener)
//移除所有监听
this.mPlayerContext.get_control_handler().removeAllPlayerQualityListener()
## 直播支持多路清晰度切换
无缝切换清晰度方案需要配置以下三个条件
1. 首先切换的模式要选择立即切换即：immediately=true
2. 服务端配置PTS透传，
3. 对应的清晰度要做主动转码设置
如果无法满足以上3个条件，那么建议用最基础的能力来实现清晰度切换，即每个清晰度都是一个media
model，切换时，调用playMediaModel来播放新的清晰度流。
# 视频宽高改变监听
在视频首帧渲染时，会调用该回调，告诉上层当前的视频宽高是多少，如果在这个这个视频播放的生命周期中，宽高改变，那么还会再次调用该回调.
private mVideoFrameSizeChangedListener : QIPlayerVideoFrameSizeChangeListener ={
/**
推流端视频长宽变化回调
@param context 当前的播放器
@param width 视频宽度
@param height 视频高度
*/
onVideoFrameSizeChanged:(context : QIPlayerContext, width: number, height:number ) =>{
}
}
//添加监听
this.mPlayerContext.get_control_handler().addPlayerVideoFrameSizeChangeListener(this.mVideoFrameSizeChangedListener)
//移除监听
this.mPlayerContext.get_control_handler().removePlayerVideoFrameSizeChangeListener(this.mVideoFrameSizeChangedListener)
//移除所有监听
this.mPlayerContext.get_control_handler().removeAllPlayerVideoFrameSizeChangeListener()
# 播放进度监听
只有在点播的时候 duration 和 progress 才有意义，直播的话这两个值没有参考意义
private mProgressListener : QIPlayerProgressListener = {
/***
进度变更回调
@param context 当前的播放器
@param progress 当前进度 单位毫秒
@param duration 当前视频总时长 单位毫秒
*/
onProgressChanged:(context:QIPlayerContext, progress:number, duration:number) => {
}
}
//添加监听
this.mPlayerContext.get_control_handler().addPlayerProgressChangeListener(this.mProgressListener)
//移除监听
this.mPlayerContext.get_control_handler().removePlayerProgressChangeListener(this.mProgressListener)
//移除全部监听
this.mPlayerContext.get_control_handler().removeAllPlayerProgressChangeListener()
# 实时帧率
## 获取当前fps
this.mPlayerContext.get_control_handler().fps
## 实时帧率监听
private mFPSListener : QIPlayerFPSListener = {
/**
@brief fps 改变的回调
@param context 当前的播放器
@param fps 帧率
*/
onFPSChanged:(context:QIPlayerContext, FPS:number)=>{
}
}
//添加监听
this.mPlayerContext.get_control_handler().addPlayerFPSChangeListener(this.mFPSListener)
//移除监听
this.mPlayerContext.get_control_handler().removePlayerFPSChangeListener(this.mFPSListener)
//移除全部监听
this.mPlayerContext.get_control_handler().removeAllPlayerFPSChangeListener()
# 像素格式或者音频sample格式不支持的监听
private mFormatListener : QIPlayerFormatListener = {
/**
@brief 当前有format 不支持，所以视频没法播放
@param context 当前的播放器
*/
onFormatNotSupport:(context:QIPlayerContext)=>{
}
}
//添加监听
this.mPlayerContext.get_control_handler().addPlayerFormatListener(this.mFormatListener)
//移除监听
this.mPlayerContext.get_control_handler().removePlayerFormatListener(this.mFormatListener)
//移除全部监听
this.mPlayerContext.get_control_handler().removeAllPlayerFormatListener()
# 缓冲拉流监听
private mDownloadListener : QIPlayerDownloadListener = {
/**
@brief 拉流速率改变
@param context 当前的播放器
@param downloadSpeed 速度 单位: b/s (比特每秒)
@param bufferPos 缓冲的进度
*/
onDownloadChanged:(context:QIPlayerContext, speed:number, bufferPos:number)=>{
}
}
//添加监听
this.mPlayerContext.get_control_handler().addPlayerDownloadChangeListener(this.mDownloadListener)
//移除监听
this.mPlayerContext.get_control_handler().removePlayerDownloadChangeListener(this.mDownloadListener)
//移除全部监听
this.mPlayerContext.get_control_handler().removeAllPlayerDownloadChangeListener()
## 播放器操作不允许执行监听
在某些状态下，一些操作将不被执行，通过该监听回调上来通知
private mCommandNotAllowListener : QIPlayerCommandNotAllowListener = {
/**
@brief 操作不被允许回调
@param context 操作异常的播放器
@param commandName 操作名称
@param state 操作被检测时播放器的状态
*/
onCommandNotAllow:(context:QIPlayerContext, commandName:string, state:QPlayerState)=>{}
}
//添加监听
this.mPlayerContext.get_control_handler().addPlayerCommandNotAllowListener(this.mCommandNotAllowListener)
//移除监听
this.mPlayerContext.get_control_handler().removePlayerCommandNotAllowListener(this.mCommandNotAllowListener)
//移除全部监听
this.mPlayerContext.get_control_handler().removeAllPlayerCommandNotAllowListener()
## buffering 监听
private mBufferingListener : QIPlayerBufferingListener = {
/**
@brief 开始buffering
@param context 当前播放器
*/
onBufferingStart:(context:QIPlayerContext)=>{
},
/**
@brief 结束buffering
@param context 当前播放器
*/
onBufferingEnd:(context: QIPlayerContext)=>{}
}
//添加监听
this.mPlayerContext.get_control_handler().addPlayerBufferingChangeListener(this.mBufferingListener)
//移除监听
this.mPlayerContext.get_control_handler().removePlayerBufferingChangeListener(this.mBufferingListener)
//移除全部监听
this.mPlayerContext.get_control_handler().removeAllPlayerBufferingChangeListener()
# 截图
调用截图接口，就会回调截图时的video画面，并以jpeg的格式返回
/**
截图
*/
this.mPlayerContext.get_control_handler().shootVideo()
## 截图图片类型枚举
/**
截图图片类型
*/
export enum QPlayerShootVideoType {
NONE = 0,
JPEG //jpeg格式
};
## 截图相关监听
private mShootVideoListener : QIPlayerShootVideoListener = {
/**
截图成功回调
@param context 当前的播放器
@param imageData 图片的 NSData 数据
@param width 图片的宽
@param height 图片的高
@param type 图片类型
*/
onShootSuccessful:(context : QIPlayerContext, imageData:Uint8Array, width:number, height:number, type: QPlayerShootVideoType) =>{
}
/**
截图失败回调
@param context 当前的播放器
*/
onShootFailed:(context : QIPlayerContext) =>{
}
}
//添加监听
this.mPlayerContext.get_control_handler().addPlayerShootVideoListener(this.mShootVideoListener)
//移除监听
this.mPlayerContext.get_control_handler().removePlayerShootVideoListener(this.mShootVideoListener)
//移除所有监听
this.mPlayerContext.get_control_handler().removeAllPlayerShootVideoListener()
# 码率
## 获取当前码率
this.mPlayerContext.get_control_handler().biteRate
## 实时码率监听
private mBiteRateListener : QIPlayerBiteRateListener = {
/**
@brief 码率变换回调
@param context 当前播放器
@param bitrate 比特率， 单位：bps
*/
onBiteRateChanged:(context:QIPlayerContext, bitrate:number)=>{}
}
//添加监听
this.mPlayerContext.get_control_handler().addPlayerBiteRateChangeListener(this.mBiteRateListener)
//移除监听
this.mPlayerContext.get_control_handler().removePlayerBiteRateChangeListener(this.mBiteRateListener)
//移除全部监听
this.mPlayerContext.get_control_handler().removeAllPlayerBiteRateChangeListener()
# SEI 数据回调
用户自定义数据可以带在H264或者H265的编码帧里，用于实现一些基于时间轴的业务场景。
开启该功能后，如果视频资源内带有SEI数据 会通过监听接口抛给业务层。
该功能需要单独开通，具体可以联系技术支持咨询。
## 开启 SEI
this.mPlayerContext.get_control_handler().setSEIEnable(true)
## SEI 数据监听
private mSEIListener: QIPlayerSEIDataListener = {
/**
SEI 数据回调，且回调时机为SEI数据所在帧的时间
@param context 当前的播放器
@param data SEI 数据
*/
onSEIData:(context:QIPlayerContext, data:Uint8Array)=>{
}
}
//添加监听
this.mPlayerContext.get_control_handler().addPlayerSEIDataListener(this.mSEIListener)
//移除监听
this.mPlayerContext.get_control_handler().removePlayerSEIDataListener(this.mSEIListener)
//移除所有监听
this.mPlayerContext.get_control_handler().removeAllPlayerSEIDataListener()
# 渲染相关监听
private mRenderListener : QIPlayerRenderListener = {
/**
首帧耗时回调
@param context 当前的播放器
@param elapsedTime 从play 开始到首帧渲染出来的总耗时 单位毫秒
*/
onFirstFrameRendered:(context : QIPlayerContext, elapsedTime:number) => {
}
}
//添加监听
this.mPlayerContext.get_render_handler().addPlayerRenderListener(this.mRenderListener)
//移除监听
this.mPlayerContext.get_control_handler().removePlayerRenderListener(this.mRenderListener)
//移除全部监听
this.mPlayerContext.get_control_handler().removeAllPlayerRenderListener()
# 设置视频渲染比例
this.mPlayerContext.get_render_handler().setRenderRatio(QRenderRatio.AUTO)
## 视频比例枚举
export enum QRenderRatio {
AUTO = 1,
FULL_SCREEN, //铺满
STRETCH, //拉伸
Ratio_16_9, //16:9
Ratio_4_3, //4:3
}
# 设置色觉优化
this.mPlayerContext.get_render_handler().setBlindType(QBlindType.NONE)
## 色觉优化枚举
export enum QBlindType {
NONE = 0, //无
RED = 1, //红色盲
GREEN = 2, //绿色盲
BLUE = 3, //蓝色盲
}
# 后台播放
后台播放除了 QPlayer2 设置以外，还需要申请鸿蒙的长时任务和音频后台播放。同时还在 module.json 中需要申请后台播放权限
## 设置是否支持后台播放
/**
*设置是否后台播放
* @param enable yes后台播放，no后台播放暂停
*/
this.mPlayerContext.get_control_handler().setBackgroundPlayEnable(true)
### 鸿蒙长时任务和音频后台播放
async createSession() {
let type: AVSessionManager.AVSessionType = 'audio';
let session = await AVSessionManager.createAVSession(this.context,'SESSION_NAME', type);
// 激活接口要在元数据、控制命令注册完成之后再执行
await session.activate();
console.info(`session create done : sessionId : ${session.sessionId}`);
}
onBackground() {
// Ability has back to background
hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onBackground');
this.createSession()
let wantAgentInfo : wantAgent.WantAgentInfo = {
wants: [
{
bundleName: "com.qiniu.qplayer2demo",
abilityName: "EntryAbility"
}
],
// 点击通知后，动作类型
operationType: wantAgent.OperationType.START_ABILITY,
requestCode: 0,
// 点击通知后，动作执行属性
wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
};
wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj : WantAgent) => {
hilog.info(0x0000, 'testTag', '%{public}s', 'getWantAgent');
backgroundTaskManager.startBackgroundRunning(this.context,
backgroundTaskManager.BackgroundMode.AUDIO_PLAYBACK, wantAgentObj).then(() => {
console.info("Operation startBackgroundRunning succeeded");
}).catch((err: BusinessError) => {
console.error("Operation startBackgroundRunning failed Cause: " + err);
});
});
}
## 后台播放权限申请
{
"name": "ohos.permission.KEEP_BACKGROUND_RUNNING"
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,391 |
QPlayer2 Windows端 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >QPlayer2 Windows端
# QPlayer2 Windows端
最近更新时间: 2024-03-12 11:20:51
QPlayer2 Windows端文档包含如下几个部分
* 集成准备：主要介绍将 QPlayer2 引入到工程中的一些配置
* 基于 qplayer2-core 的 QPlayer2 接入指南：如果仅仅使用 qplayer2-core 开发，则参考这个文档。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >QPlayer2 Windows端
# QPlayer2 Windows端
最近更新时间: 2024-03-12 11:20:51
QPlayer2 Windows端文档包含如下几个部分
* 集成准备：主要介绍将 QPlayer2 引入到工程中的一些配置
* 基于 qplayer2-core 的 QPlayer2 接入指南：如果仅仅使用 qplayer2-core 开发，则参考这个文档。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,424 |
基础准备 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2
Windows端](https://developer.qiniu.com/pili/sdk/12642/qplayer2-windows) > 基础准备
# 基础准备
最近更新时间: 2024-03-12 11:20:59
## 集成准备
本文为您介绍 Windows qplayer2 SDK 的集成准备的环境要求和具体操作步骤。
### 环境要求
类别 | 说明
---|---
系统版本 | win7 SP1 以上
渲染环境 | D3D11
C++ | C++ 14 及以上
visual studio | 建议使用 visual studio 2022 及以上
## 获取 QPlayer2 License
联系技术支持获取
## 添加 QPlayer2 依赖
### 1.进入 [QPlayer2 Windows 仓库 __](https://github.com/pili-
engineering/QPlayer2-Windows)查看最新 QPlayer2 的版本
### 2.配置依赖关系，引入 QPlayer2
将 qplayer2demo\dependency\qplayer-core 目录中对应平台的 qplayer2-core.lib
拷贝到您项目的目标目录，并在项目配置中配置相关路径
### 3.配置头文件
将 qplayer2demo\dependency\qplayer-core 目录中对应平台的头文件拷贝到您项目的目标目录，并在项目配置中配置相关路径
### 4.配置 manifest
将 qplayer2demo\dependency\qplayer-core 目录中对应平台的 manifest 拷贝到您项目的 exe
所在同级目录，并在项目配置中配置相关依赖
### 5.配置 dll
将 qplayer2demo\dependency\qplayer-core 目录中对应平台的 dll 拷贝到您项目的 exe 所在同级目录
## D3D11 相关问题
1.通常情况下系统自带 D3D11，如果缺少 D3D11 相关报错，可通过下面链接下载安装
下载链接：[https://www.microsoft.com/zh-cn/download/details.aspx?id=35
__](http://www.microsoft.com/zh-cn/download/details.aspx?id=35)
下载完成后，双击启动，一直点击下一步，待安装完成后即可
2.如遇到 D3D11 相关报错，可按照下面的方法尝试解决
（1）右键桌面 -> 显示设置
（2）搜索 “添加可选功能”
（3）点击 “添加功能”
（4）安装 “图形工具”
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2
Windows端](https://developer.qiniu.com/pili/sdk/12642/qplayer2-windows) > 基础准备
# 基础准备
最近更新时间: 2024-03-12 11:20:59
## 集成准备
本文为您介绍 Windows qplayer2 SDK 的集成准备的环境要求和具体操作步骤。
### 环境要求
类别 | 说明
---|---
系统版本 | win7 SP1 以上
渲染环境 | D3D11
C++ | C++ 14 及以上
visual studio | 建议使用 visual studio 2022 及以上
## 获取 QPlayer2 License
联系技术支持获取
## 添加 QPlayer2 依赖
### 1.进入 [QPlayer2 Windows 仓库 __](https://github.com/pili-
engineering/QPlayer2-Windows)查看最新 QPlayer2 的版本
### 2.配置依赖关系，引入 QPlayer2
将 qplayer2demo\dependency\qplayer-core 目录中对应平台的 qplayer2-core.lib
拷贝到您项目的目标目录，并在项目配置中配置相关路径
### 3.配置头文件
将 qplayer2demo\dependency\qplayer-core 目录中对应平台的头文件拷贝到您项目的目标目录，并在项目配置中配置相关路径
### 4.配置 manifest
将 qplayer2demo\dependency\qplayer-core 目录中对应平台的 manifest 拷贝到您项目的 exe
所在同级目录，并在项目配置中配置相关依赖
### 5.配置 dll
将 qplayer2demo\dependency\qplayer-core 目录中对应平台的 dll 拷贝到您项目的 exe 所在同级目录
## D3D11 相关问题
1.通常情况下系统自带 D3D11，如果缺少 D3D11 相关报错，可通过下面链接下载安装
下载链接：[https://www.microsoft.com/zh-cn/download/details.aspx?id=35
__](http://www.microsoft.com/zh-cn/download/details.aspx?id=35)
下载完成后，双击启动，一直点击下一步，待安装完成后即可
2.如遇到 D3D11 相关报错，可按照下面的方法尝试解决
（1）右键桌面 -> 显示设置
（2）搜索 “添加可选功能”
（3）点击 “添加功能”
（4）安装 “图形工具”
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,425 |
基于 Core 的 QPlayer2 接入指南 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2
Windows端](https://developer.qiniu.com/pili/sdk/12642/qplayer2-windows) > 基于
Core 的 QPlayer2 接入指南
# 基于 Core 的 QPlayer2 接入指南
最近更新时间: 2024-03-12 11:21:07
如果业务场景中没有复杂的场景切换，也不想用播放面板定制、播放器上层浮窗定制、播放器上层手势逻辑则可以只用
qplayer2-core，接入成本低，学习门槛低。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2
Windows端](https://developer.qiniu.com/pili/sdk/12642/qplayer2-windows) > 基于
Core 的 QPlayer2 接入指南
# 基于 Core 的 QPlayer2 接入指南
最近更新时间: 2024-03-12 11:21:07
如果业务场景中没有复杂的场景切换，也不想用播放面板定制、播放器上层浮窗定制、播放器上层手势逻辑则可以只用
qplayer2-core，接入成本低，学习门槛低。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,428 |
快速开始 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2
Windows端](https://developer.qiniu.com/pili/sdk/12642/qplayer2-windows) > [基于
Core 的 QPlayer2 接入指南](https://developer.qiniu.com/pili/sdk/12644/based-on-
qplayer2-windows-access-guide-to-the-core) > 快速开始
# 快速开始
最近更新时间: 2024-03-12 11:21:16
## 快速开始
基于 qplayer2-core 的播放器使用
### 导入头文件
#include <QMediaModel.h>
#include <QIPlayerContext.h>
#include <QIPlayerControlHandler.h>
#include <QIPlayerRenderHandler.h>
### 初始化
建议将播放器创建方法放置在主窗口的构造函数中
bundle id 和 author id 都用于 QPlayer2 鉴权，任选其一即可。若两个同时填写，则其中一个鉴权通过即认定为鉴权通过。
权限说明见 [QPlayer2 鉴权相关 __](https://developer.qiniu.com/pili/12223/qplayer2-core-
authentication-related)
mpPlayerContext = QIPlayerContext::create();
mpPlayerContext->init(QLogLevel::LOG_VERBOSE, std::filesystem::current_path().string(), "您的 bundle id", "1.4.0", "您的 author id", mHwnd);
### 设置渲染窗口句柄
初始化后设置渲染窗口句柄，建议放在主窗口的构造函数中。mpVideoRenderWindow 可替换为您创建并注册的渲染窗口
mpPlayerContext->get_render_hander()->set_window_hwnd(mpVideoRenderWindow->get_hwnd());
mpVideoRenderWindow 的相关代码
构造函数
VideoRenderWindow::VideoRenderWindow(HWND parent_hwnd, HINSTANCE hinstance)
:mHwnd(nullptr)
{
HINSTANCE hInst = (HINSTANCE)GetWindowLongPtr(parent_hwnd, GWLP_HINSTANCE);
//视频显示窗口
WNDCLASSEXW wcex;
wcex.cbSize = sizeof(WNDCLASSEX);
wcex.style = CS_HREDRAW | CS_VREDRAW;
wcex.lpfnWndProc = render_window_proc;
wcex.cbClsExtra = 0;
wcex.cbWndExtra = 0;
wcex.hInstance = hInst;
wcex.hIcon = NULL;
wcex.hCursor = LoadCursor(nullptr, IDC_ARROW);
wcex.hbrBackground = (HBRUSH)(COLOR_WINDOW + 1);
wcex.lpszMenuName = NULL;
wcex.lpszClassName = TEXT(L"QRenderView");
wcex.hIconSm = NULL;
if (!RegisterClassExW(&wcex)) {
throw "render view create failed!";
}
mHwnd = CreateWindowW(wcex.lpszClassName, TEXT(L"QRenderView"), WS_CHILD | WS_VISIBLE | WS_CLIPSIBLINGS | WS_CLIPCHILDREN,
10, 10, 80, 20, parent_hwnd, NULL, hInst, NULL);
if (mHwnd == nullptr)
{
throw "render view create failed!";
}
}
返回句柄
HWND VideoRenderWindow::get_hwnd()
{
return mHwnd;
}
### 配置播放器事件循环
LRESULT CALLBACK PlayerWindow::main_player_window_proc(HWND hwnd, UINT message, WPARAM w_param, LPARAM l_param) {
PlayerWindow* pplayer_window = (PlayerWindow*)GetWindowLongPtr(hwnd, GWLP_USERDATA);
if (pplayer_window != nullptr) {
if (mpPlayerContext != nullptr) {
pplayer_window->mpPlayerContext->on_receive_message(hwnd, message, w_param, l_param);
return 0;
}
}
}
### 创建播放数据模型
要在播放前完成播放数据模型的构建。
add_stream_element 可调用多次，但默认播放的元素只能有一个，即第五个参数 is_default 只能有一个元素设置为 true，其他应为
false
QMedia::QMediaModelBuilder* pmodel_builder = new QMedia::QMediaModelBuilder;
pmodel_builder->add_stream_element("", QMedia::QUrlType::QAUDIO_AND_VIDEO, 1080, "http://demo-videos.qnsdk.com/qiniu-2023-1080p.mp4", true, "", "", QMedia::QVideoRenderType::PLANE, "", "", QMedia::QUrlMethod::NORMAL);
model = pmodel_builder->build(false, false);
### 播放
mpPlayerWindow->get_control_handler()->play_media_model(model, 0);
### 停止播放
mpPlayerWindow->get_control_handler()->stop();
### 释放
delete 播放器 context 之前，应先调用 stop 方法，再调用 release 方法，最后再 delete context。避免内存泄漏问题
mpPlayerWindow->get_context()->release();
delete mpPlayerWindow;
mpPlayerWindow = nullptr;
mpPlayerWindow 的析构函数
if (mpPlayerContext != nullptr)
{
delete mpPlayerContext;
mpPlayerContext = nullptr;
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2
Windows端](https://developer.qiniu.com/pili/sdk/12642/qplayer2-windows) > [基于
Core 的 QPlayer2 接入指南](https://developer.qiniu.com/pili/sdk/12644/based-on-
qplayer2-windows-access-guide-to-the-core) > 快速开始
# 快速开始
最近更新时间: 2024-03-12 11:21:16
## 快速开始
基于 qplayer2-core 的播放器使用
### 导入头文件
#include <QMediaModel.h>
#include <QIPlayerContext.h>
#include <QIPlayerControlHandler.h>
#include <QIPlayerRenderHandler.h>
### 初始化
建议将播放器创建方法放置在主窗口的构造函数中
bundle id 和 author id 都用于 QPlayer2 鉴权，任选其一即可。若两个同时填写，则其中一个鉴权通过即认定为鉴权通过。
权限说明见 [QPlayer2 鉴权相关 __](https://developer.qiniu.com/pili/12223/qplayer2-core-
authentication-related)
mpPlayerContext = QIPlayerContext::create();
mpPlayerContext->init(QLogLevel::LOG_VERBOSE, std::filesystem::current_path().string(), "您的 bundle id", "1.4.0", "您的 author id", mHwnd);
### 设置渲染窗口句柄
初始化后设置渲染窗口句柄，建议放在主窗口的构造函数中。mpVideoRenderWindow 可替换为您创建并注册的渲染窗口
mpPlayerContext->get_render_hander()->set_window_hwnd(mpVideoRenderWindow->get_hwnd());
mpVideoRenderWindow 的相关代码
构造函数
VideoRenderWindow::VideoRenderWindow(HWND parent_hwnd, HINSTANCE hinstance)
:mHwnd(nullptr)
{
HINSTANCE hInst = (HINSTANCE)GetWindowLongPtr(parent_hwnd, GWLP_HINSTANCE);
//视频显示窗口
WNDCLASSEXW wcex;
wcex.cbSize = sizeof(WNDCLASSEX);
wcex.style = CS_HREDRAW | CS_VREDRAW;
wcex.lpfnWndProc = render_window_proc;
wcex.cbClsExtra = 0;
wcex.cbWndExtra = 0;
wcex.hInstance = hInst;
wcex.hIcon = NULL;
wcex.hCursor = LoadCursor(nullptr, IDC_ARROW);
wcex.hbrBackground = (HBRUSH)(COLOR_WINDOW + 1);
wcex.lpszMenuName = NULL;
wcex.lpszClassName = TEXT(L"QRenderView");
wcex.hIconSm = NULL;
if (!RegisterClassExW(&wcex)) {
throw "render view create failed!";
}
mHwnd = CreateWindowW(wcex.lpszClassName, TEXT(L"QRenderView"), WS_CHILD | WS_VISIBLE | WS_CLIPSIBLINGS | WS_CLIPCHILDREN,
10, 10, 80, 20, parent_hwnd, NULL, hInst, NULL);
if (mHwnd == nullptr)
{
throw "render view create failed!";
}
}
返回句柄
HWND VideoRenderWindow::get_hwnd()
{
return mHwnd;
}
### 配置播放器事件循环
LRESULT CALLBACK PlayerWindow::main_player_window_proc(HWND hwnd, UINT message, WPARAM w_param, LPARAM l_param) {
PlayerWindow* pplayer_window = (PlayerWindow*)GetWindowLongPtr(hwnd, GWLP_USERDATA);
if (pplayer_window != nullptr) {
if (mpPlayerContext != nullptr) {
pplayer_window->mpPlayerContext->on_receive_message(hwnd, message, w_param, l_param);
return 0;
}
}
}
### 创建播放数据模型
要在播放前完成播放数据模型的构建。
add_stream_element 可调用多次，但默认播放的元素只能有一个，即第五个参数 is_default 只能有一个元素设置为 true，其他应为
false
QMedia::QMediaModelBuilder* pmodel_builder = new QMedia::QMediaModelBuilder;
pmodel_builder->add_stream_element("", QMedia::QUrlType::QAUDIO_AND_VIDEO, 1080, "http://demo-videos.qnsdk.com/qiniu-2023-1080p.mp4", true, "", "", QMedia::QVideoRenderType::PLANE, "", "", QMedia::QUrlMethod::NORMAL);
model = pmodel_builder->build(false, false);
### 播放
mpPlayerWindow->get_control_handler()->play_media_model(model, 0);
### 停止播放
mpPlayerWindow->get_control_handler()->stop();
### 释放
delete 播放器 context 之前，应先调用 stop 方法，再调用 release 方法，最后再 delete context。避免内存泄漏问题
mpPlayerWindow->get_context()->release();
delete mpPlayerWindow;
mpPlayerWindow = nullptr;
mpPlayerWindow 的析构函数
if (mpPlayerContext != nullptr)
{
delete mpPlayerContext;
mpPlayerContext = nullptr;
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,429 |
基础能力使用 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2
Windows端](https://developer.qiniu.com/pili/sdk/12642/qplayer2-windows) > [基于
Core 的 QPlayer2 接入指南](https://developer.qiniu.com/pili/sdk/12644/based-on-
qplayer2-windows-access-guide-to-the-core) > 基础能力使用
# 基础能力使用
最近更新时间: 2024-03-26 15:00:25
在 [快速开始 __](http://developer.qiniu.io/pili/12645/qplayer2-core-windows-quick-
start)中，我们完成了qplayer2播放器的创建\播放\销毁，本文介绍如何使用qplayer2的播放能力
## 播放
### 创建播放数据
QMedia::QMediaModelBuilder* pmodel_builder = new QMedia::QMediaModelBuilder;
//添加播放地址
pmodel_builder->add_stream_element(user_type, url_type, quality, url, is_selected, referer, back_up_url, render_type);
//添加字幕地址
pmodel_builder->add_subtitle_element(subtitle_name, subtitle_url,subtitle_is_selected);
//创建 QMediaModel
//is_live 是否是直播。true 直播,false 点播
//reconstruct_time_line 是否重构时间轴，true 重构，false 不重构
QMedia::QMediaModel* pmodel = pmodel_builder->build(is_live, reconstruct_time_line);
add_stream_element 属性说明
属性名 | 属性说明
---|---
userType | 用户自定义Type，目前预留，可以填空字符串
url | 资源地址
urlType | 媒体的资源属性 只包含视频/只包含音频/同时有视频音频
quality | 清晰度
isSelected | 是否起播时播放该流
backupUrl | 备用地址
referer | http/https 协议的地址 支持该属性
renderType | 视频的渲染类型
hlsDrmKey | 私有DRM解密的key，用在私有hls加密视频播放的场景中
mp4DrmKey | mp4 drm 的解密 key 用于 CENC-AES-CTR 加密的视频播放场景中
mp4QNDrmComKey | mp4 七牛私有 drm 的解密 comkey 用于七牛私有 mp4 加密的视频播放场景中
mp4QNDrmFileKey | mp4 七牛私有 drm 的解密 filekey 用于七牛私有 mp4 加密的视频播放场景中
## MP4 加密
目前 QPlayer2 支持七牛私有加密以及显式的 CENC-AES-CTR 加密，暂不支持隐式加密。CENC-AES-CTR 的初始化向量(IV)
由加密工具随机生成并存储在加密后的 MP4 文件中，QPlayer2 读取 MP4 文件的 IV 和QMediaModel 存储的 mp4DrmKey
进行解密。
### 播放 mp4 加密视频
QMedia::QMediaModelBuilder* pmodel_builder = new QMedia::QMediaModelBuilder;
//添加 CENC-AES-CTR 加密视频播放地址
pmodel_builder->add_stream_element_mp4_drm(user_type, url_type, quality, url, is_selected, referer, back_up_url，mp4_drm_key, render_type);
//添加 hls 加密视频播放地址
pmodel_builder->add_stream_element_hls_drm(user_type, url_type, quality, url, is_selected, referer, back_up_url，hls_drm, render_type);
//添加七牛私有 MP4 加密视频播放地址
pmodel_builder->add_stream_element_qn_mp4_drm(user_type, url_type, quality, url, is_selected, referer, back_up_url，mp4_qn_drm_com_key，mp4_qn_drm_file_key, render_type);
//添加字幕地址
pmodel_builder->add_subtitle_element(subtitle_name, subtitle_url,subtitle_is_selected);
//创建 QMediaModel
//is_live 是否是直播。true 直播,false 点播
//reconstruct_time_line 是否重构时间轴，true 重构，false 不重构
QMedia::QMediaModel* pmodel = pmodel_builder->build(is_live, reconstruct_time_line);
## 对 MP4 文件进行 CENC-AES-CTR 加密
可以选择 ffmpeg 对一个 MP4 进行加密。加密命令如下：
ffmpeg -i test2.mp4 -vcodec copy -acodec copy -encryption_scheme cenc-aes-ctr -encryption_key c7e16c4403654b85847037383f0c2db3 -encryption_kid a7e61c373e219033c21091fa607bf3b8 encrypted_IV_test.mp4
命令说明
test2.mp4 为输入文件
encrypted_IV_test.mp4 为输出文件
-vcodec copy 和 -acodec copy ：指定视频流和音频流的编码方式为原始流的拷贝，即不进行重新编码，保持与原始文件相同的编码格式。
-encryption_scheme cenc-aes-ctr ：设置加密方案为 CENC-AES-CTR，即采用 CTR 模式进行加密。
-encryption_key c7e16c4403654b85847037383f0c2db3 指定加密所使用的密钥，即解密所使用的 key。这里的c7e16c4403654b85847037383f0c2db3 是一个示例密钥，您可以替换为您自己的密钥，格式要求为：16字节的16进制数据。
-encryption_kid a7e61c373e219033c21091fa607bf3b8：指定加密所使用的密钥标识符（KID）。这里的 a7e61c373e219033c21091fa607bf3b8 是一个示例 KID，您可以替换为您自己的密钥标识符, 格式要求为：16字节的16进制数据。
加密后可通过ffplay 4.4 版本进行播放验证，播放正常即可。命令如下：
ffplay encrypted_IV_test.mp4 -decryption_key c7e16c4403654b85847037383f0c2db3
### 视频URL类型枚举
enum class QUrlType : uint32_t {
QAUDIO_AND_VIDEO = 0,
//仅包含音频
QAUDIO = 1,
//仅包含视频
QVIDEO = 2,
//无
NONE = 3
};
### 播放媒体资源
/// <summary>
/// 播放音视频资源
/// </summary>
/// <param name="pmedia_model"> 音视频资源 </param>
/// <param name="start_pos"> 起播时间戳 毫秒 </param>
/// <returns> true: 调用成功 false: 调用失败 </returns>
mpPlayerWindow->get_control_handler()->play_media_model(pmodel, 0);
### 播放错误监听
添加监听前实现接口 QIPlayerMediaNetworkListener
。当视频起播时，如果遇到网络等问题原因，导致没有和服务器建立链接，那么会导致视频播放失败，总共会有3次重试机会，3次都失败的情况下会回调onOpenFailed方法。
当视频已经起播后，在中途遇到网络等问题原因，进入buffer,
那么内核会一直重试，直到再次连接上服务端继续播放，或者用户通过接口停止播放该视频，在重试的过程中 onReconnectStart /
onReconnectEnd
会被回调，那么可以监控回调的次数来做业务层的结束播放的策略，当然在正常播放的情况下，这两个方法也是会被回调的，所以最好结合buffer的回调数据一起使用。
/// <summary>
/// 开始重连
/// </summary>
/// <param name="user_type"> 重连 url 的 userType </param>
/// <param name="url_type">重连 url 的 urlType </param>
/// <param name="url"> 重连的 url </param>
/// <param name="retry_time"> 重连 url 的次数 </param>
void on_reconnect_start(const std::string & user_type, QMedia::QUrlType url_type, const std::string & url, int retry_time) override;
/// <summary>
/// 重连结束
/// </summary>
/// <param name="user_type"> 重连 url 的 userType </param>
/// <param name="url_type"> 重连 url 的 urlType </param>
/// <param name="url"> 重连的 url </param>
/// <param name="retry_time"></param>
/// <param name="error"> 重连 url 的次数 </param>
void on_reconnect_end(const std::string & user_type, QMedia::QUrlType url_type, const std::string & url, int retry_time, QMedia::QOpenError error) override;
/// <summary>
/// 打开失败
/// </summary>
/// <param name="user_type"> 打开失败 url 的 userType </param>
/// <param name="url_type"> 打开失败 url 的 urlType </param>
/// <param name="url"> 打开失败的 url </param>
/// <param name="error"> 打开失败 url 的 错误码 </param>
void on_open_failed(const std::string & user_type, QMedia::QUrlType url_type, const std::string & url, QMedia::QOpenError error) override;
void on_reconnect_start(const std::string &user_type, QMedia::QUrlType url_type, const std::string& url, int retry_time){
}
void on_reconnect_end(const std::string &user_type, QMedia::QUrlType url_type, const std::string& url, int retry_time, QMedia::QOpenError error) {
}
void on_open_failed(const std::string &user_type, QMedia::QUrlType url_type, const std::string& url, QMedia::QOpenError error){
}
//添加监听
mpPlayerWindow->get_control_handler()->add_player_media_network_listener(this);
//移除监听
mpPlayerWindow->get_control_handler()->remove_player_media_network_listener(this);
//移除所有监听
mpPlayerWindow->get_control_handler()->remove_all_player_media_network_listeners();
### 播放错误码枚举
enum class QPLAYER_API QOpenError : int64_t {
UNKNOW = 10000,
NONE = 0,
IOERROR = -5,
INTERRUPT = -1414092869,
URL_INVALID = -875574520,
FORMAT_INVALID = -1094995529
};
### 暂停播放
/// <summary>
/// 暂停渲染
/// </summary>
/// <returns> true: 调用成功 false: 调用失败 </returns>
mpPlayerWindow->get_control_handler()->pause_render();
### 恢复播放
/// <summary>
/// 在暂停渲染状态下 恢复渲染
/// </summary>
/// <returns> true: 调用成功 false: 调用失败 </returns>
mpPlayerWindow->get_control_handler()->resume_render();
### 停止当前视频播放
/// <summary>
/// 停止当前视频播放
/// </summary>
/// <returns> true: 调用成功 false: 调用失败 </returns>
mpPlayerWindow->get_control_handler()->stop();
## 鉴权
鉴权功能介绍见[鉴权相关文档 __](http://developer.qiniu.io/pili/12223/qplayer2-core-
authentication-related)
### 强制网络鉴权
调用该接口时，会强制进行网络鉴权
/// <summary>
/// 下一次鉴权强制通过网络鉴权
/// </summary>
/// <returns> true: 调用成功 false: 调用失败 </returns>
mpPlayerWindow->get_control_handler()->force_authentication_from_network();
### 鉴权监听
添加监听前实现接口 QIPlayerAuthenticationListener 协议。
/// <summary>
/// 鉴权失败
/// </summary>
/// <param name="error"> 鉴权失败错误码 </param>
void on_authentication_failed(QMedia::QAuthenticationErrorType error) override;
/// <summary>
/// 鉴权成功
/// </summary>
void on_authentication_success() override;
void on_authentication_failed(QMedia::QAuthenticationErrorType error){
}
void on_authentication_success(){
}
//添加监听
mpPlayerWindow->get_control_handler()->add_player_authentication_listener(this);
//移除监听
mpPlayerWindow->get_control_handler()->remove_player_authentication_listener(this);
//移除所有监听
mpPlayerWindow->get_control_handler()->remove_all_player_authentication_listeners();
### 鉴权错误码枚举
enum class QPLAYER_API QAuthenticationErrorType : uint32_t {
NONE = 0, //鉴权出错
NO_BASE_AUTH = 1, //缺少基础功能权限
NO_VR_AUTH = 2, //缺少 VR 功能权限
NO_BLIND_AUTH = 3, //缺少色盲功能权限
NO_SEI_AUTH = 4, //缺少 SEI 功能权限
NO_SRT_AUTH = 5 //缺少 SRT 功能权限
};
## 切换视频进度
参数为要定位的position 单位毫秒
/// <summary>
/// seek
/// </summary>
/// <param name="position"> seek 的位置 单位 ms </param>
/// <returns></returns>
mpPlayerWindow->get_control_handler()->seek(100);
### 切换视频进度结果监听
添加监听前实现接口 QIPlayerSeekListener
/// <summary>
/// seek 成功回调
/// </summary>
void on_seek_success() override;
/// <summary>
/// seek 失败回调
/// </summary>
void on_seek_failed() override;
void on_seek_success() {
}
void on_seek_failed() {
}
//添加监听
mpPlayerWindow->get_control_handler()->add_player_seek_listener(this);
//移除监听
mpPlayerWindow->get_control_handler()->remove_player_seek_listener(this);
//移除所有监听
mpPlayerWindow->get_control_handler()->remove_all_player_seek_listeners();
## 视频解码方式
目前支持的解码方式有:软解、硬解、自动，一般情况下，使用自动，内核会根据手机的硬件情况，要播放的视频资源编码格式等信息，挑选合适的解码方式进行解码，各个解码方式的优劣情况如下
软解: 解码较慢，但是兼容性好，适用于所有手机
硬解：解码性能高，但是有一定兼容性，比如某些视频资源的编码格式，硬解芯片不支持。并且相对于软解，首帧的速度慢。
### 设置优先选择哪种解码方式
设置完成后下一次播放生效.
最终的解码方式可能不是设置的，在设置的解码方式不能正确解码时，内核会进行降级，选择其他能正确解码的方式
/// <summary>
/// 设置解码方式
/// </summary>
/// <param name="type"> 解码方式 </param>
/// <returns> true: 调用成功 false: 调用失败 </returns>
mpPlayerWindow->get_control_handler()->set_decode_type(QMedia::QPlayerSetting::QPlayerDecoder::QPLAYER_DECODER_SETTING_AUTO);
### 优先选择的解码方式枚举
该枚举主要用于设置解码方式
enum class QPLAYER_API QPlayerDecoder : uint16_t
{
//自动选择
QPLAYER_DECODER_SETTING_AUTO = 0,
//硬解优先
QPLAYER_DECODER_SETTING_HARDWARE_PRIORITY = 1,
//软解优先
QPLAYER_DECODER_SETTING_SOFT_PRIORITY = 2,
};
### 播放器视频解码监听相关
添加监听前实现接口 QIPlayerVideoDecodeListender 协议。
/// <summary>
/// 播放器解码类型回调
/// </summary>
/// <param name="type"> 解码类型 </param>
void on_video_decode_by_type(QMedia::QDecoderType type) override;
/// <summary>
/// 解码失败回调
/// </summary>
/// <param name="retry"> 是否降级重试成功 true 是 false 否 </param>
void on_decode_failed(bool retry) override;
/// <summary>
/// 如果当前视频解码所在设备或者 sdk 不支持，则回调该函数
/// </summary>
/// <param name="codec_id"> 视频解码的 id </param>
void on_not_support_codec_format(int codec_id) override;
void on_video_decode_by_type(QMedia::QDecoderType type) {
}
void on_decode_failed(bool retry) {
}
void on_not_support_codec_format(int codec_id) {
}
//添加监听
mpPlayerWindow->get_control_handler()->add_player_video_decode_type_listener(this);
//移除监听
mpPlayerWindow->get_control_handler()->remove_player_video_decode_type_listener(this);
//移除所有监听
mpPlayerWindow->get_control_handler()->remove_all_player_video_decode_type_listeners();
### 解码方式枚举
该枚举主要用于监听返回的解码方式
enum class QPLAYER_API QDecoderType : uint32_t {
NONE = 0,
SOFTWARE = 1,
HARDWARE = 31
};
## 设置起播方式
下一次播放生效
/// <summary>
/// 设置起播方式
/// </summary>
/// <param name="action"> 起播方式 </param>
/// <returns> true: 调用成功 false: 调用失败 </returns>
mpPlayerWindow->get_control_handler()->set_start_action(QMedia::QPlayerSetting::QPlayerStart::QPLAYER_START_SETTING_PLAYING);
### 起播方式枚举
enum class QPlayerStart : uint16_t {
//起播播放
QPLAYER_START_SETTING_PLAYING = 0,
//起播暂停在首帧
QPLAYER_START_SETTING_PAUSE = 1,
};
## 设置 seek 方式
下一次播放生效
/// <summary>
/// 设置seek方式
/// </summary>
/// <param name="mode"> seek方式 </param>
/// <returns> true: 调用成功 false: 调用失败 </returns>
mpPlayerWindow->get_control_handler()->set_seek_mode(QMedia::QPlayerSetting::QPlayerSeek::QPLAYER_SEEK_SETTING_NORMAL);
### seek方式枚举
enum class QPlayerSeek : uint16_t {
//关键帧seek，每次seek 都seek到离目标位置向前的最近的一个关键帧，耗时少
QPLAYER_SEEK_SETTING_NORMAL = 0,
//精准seek，耗时比关键帧seek多，且耗时和视频的gop间隔的大小成正比
QPLAYER_SEEK_SETTING_ACCURATE = 1
};
## 播放器状态
在整个播放器实例生命周期中，播放会在不同的状态中切换，用户可以通过监听播放器状态，实现上层业务逻辑，
比如在视频播放完时，展示其他视频的推荐页，那么只需监听播放器状态回调，待回调的状态是COMPLETED，则展示推荐页
### 播放器状态枚举
enum class QPLAYER_API QPlayerState : uint32_t {
NONE = 0,//初始状态
INIT = 1,//播放器开始创建各种对象 没有对应的state 创建完对象就上报这个状态
PREPARE = 2,//开始拉视频数据解码变换等，重新换地址后，都走这个状态
PLAYING = 4,//播放中
PAUSED_RENDER = 6,//用户暂停
COMPLETED = 7,//播放完成
SEEKING = 8, //SEEK
STOPPED = 9,//播放器停止中
MISTAKE = 10,//播放出错（是否需要分 可恢复 和 不可恢复 ）
END = 11,//播放器释放各种对象完成
MEDIA_ITEM_PREPARE = 12, //开始拉视频数据解码变换等，重新换地址后，都走这个状态 针对Media Item的play 方式
RELEASE = 13 //播放器结束，且释放各类资源
};
### 播放器状态变更监听相关
添加监听前需要签订QIPlayerStateChangeListener协议。
/// <summary>
/// 当前的播放状态发生改变时回调
/// </summary>
/// <param name="state"> 当前的播放状态 </param>
void on_state_changed(QMedia::QPlayerState state) override;
void on_state_changed(QMedia::QPlayerState state) {
}
//添加监听
mpPlayerWindow->get_control_handler()->add_player_state_change_listener(this);
//移除监听
mpPlayerWindow->get_control_handler()->remove_player_state_change_listener(this);
//移除所有监听
mpPlayerWindow->get_control_handler()->remove_all_player_state_change_listeners();
## 播放速度
播放速度的调整范围建议在0.25-2.0之间，这样会有一个比较好的效果
### 设置播放速度
参数为倍速值
/// <summary>
/// 设置播放速度
/// </summary>
/// <param name="speed"> 需要设置的倍速 </param>
/// <returns> true: 调用成功 false: 调用失败 </returns>
mpPlayerWindow->get_control_handler()->set_speed(0.5);
### 速度变更监听相关
添加监听前实现接口 QIPlayerSpeedListener
/// <summary>
/// 播放速度改变回调
/// </summary>
/// <param name="speed"> 当前的播放速度 </param>
void on_speed_changed(float speed) override;
void on_speed_changed(float speed) {
}
//添加监听
mpPlayerWindow->get_control_handler()->add_player_speed_change_listener(this);
//移除监听
mpPlayerWindow->get_control_handler()->remove_player_speed_change_listener(this);
//移除所有监听
mpPlayerWindow->get_control_handler()->remove_all_player_speed_change_listeners();
## 清晰度
QPlayer2 提供的清晰度能力是无缝切换清晰度方案，在切换过程中，画面是连续的画面，不会出现类似跳帧的情况。
使用无缝切换清晰度功能，必须在 mediaModel 中配置多路清晰度，如果使用非 immediately
方式(即异步方式)时，同时只能有一次切换会话存在，会话结束后，才能切下一次
### 切换视频清晰度
/// <summary>
/// 切换清晰度,针对一个视频由多路url流组成的情况下，可以按找流来进行清晰度切换，
/// 比如一个视频由2路url组成，一路视频，一路音频，那么可以只切换音频路的url达到音频的清晰度切换，也可以
/// 只切换视频路的url达到视频的清晰度切换。
/// </summary>
/// <param name="user_type"> 要切换的url流的userType </param>
/// <param name="url_type"> 要切换的url流的urlType </param>
/// <param name="quality_index"> 要切换到哪一路清晰度 </param>
/// <param name="immediately"> true: 立即切换，直播情况下
mpPlayerWindow->get_control_handler()->switch_quality(pinner_ele->get_user_type(), pinner_ele->get_url_type(), 1080, true);
### 播放器清晰度相关监听
添加监听前实现接口 QIPlayerQualityListener
/// <summary>
/// 开始切换清晰度
/// </summary>
/// <param name="user_type"> 切换清晰度的 URL 的 userType </param>
/// <param name="url_type"> 切换清晰度的 URL 的 urlType </param>
/// <param name="old_quality"> 切换清晰度前的清晰度 </param>
/// <param name="new_quality"> 切换清晰度后的清晰度 </param>
void on_quality_switch_start(const std::string & user_type, QMedia::QUrlType url_type, int old_quality, int new_quality) override;
/// <summary>
/// 清晰度切换完成
/// </summary>
/// <param name="user_type"> 切换清晰度的 URL 的 userType </param>
/// <param name="url_type"> 切换清晰度的 URL 的 urlType </param>
/// <param name="old_quality"> 切换清晰度前的清晰度 </param>
/// <param name="new_quality"> 切换清晰度后的清晰度 </param>
void on_quality_switch_complete(const std::string & user_type, QMedia::QUrlType url_type, int old_quality, int new_quality) override;
/// <summary>
/// 清晰度切换取消
/// </summary>
/// <param name="user_type"> 切换清晰度的 URL 的 userType </param>
/// <param name="url_type"> 切换清晰度的 URL 的 urlType </param>
/// <param name="old_quality"> 切换清晰度前的清晰度 </param>
/// <param name="new_quality"> 切换清晰度后的清晰度 </param>
void on_quality_switch_canceled(const std::string & user_type, QMedia::QUrlType url_type, int old_quality, int new_quality) override;
/// <summary>
/// 清晰度切换失败
/// </summary>
/// <param name="user_type"> 切换清晰度的 URL 的 userType </param>
/// <param name="url_type"> 切换清晰度的 URL 的 urlType </param>
/// <param name="old_quality"> 切换清晰度前的清晰度 </param>
/// <param name="new_quality"> 切换清晰度后的清晰度 </param>
void on_quality_switch_failed(const std::string & user_type, QMedia::QUrlType url_type, int old_quality, int new_quality) override;
/// <summary>
/// 目前仅支持同时有一个清晰度切换事件，如果前一个切换还未完成，再次切换清晰度，则会回调该函数
/// </summary>
/// <param name="user_type"> 切换清晰度的 URL 的 userType </param>
/// <param name="url_type"> 切换清晰度的 URL 的 urlType </param>
void on_quality_switch_retry_later(const std::string & user_type, QMedia::QUrlType url_type) override;
void on_quality_switch_start(const std::string & user_type, QMedia::QUrlType url_type, int old_quality, int new_quality) {
}
void on_quality_switch_complete(const std::string & user_type, QMedia::QUrlType url_type, int old_quality, int new_quality) {
}
void on_quality_switch_canceled(const std::string & user_type, QMedia::QUrlType url_type, int old_quality, int new_quality) {
}
void on_quality_switch_failed(const std::string & user_type, QMedia::QUrlType url_type, int old_quality, int new_quality) {
}
void on_quality_switch_retry_later(const std::string & user_type, QMedia::QUrlType url_type) {
}
//添加监听
mpPlayerWindow->get_control_handler()->add_player_quality_listener(this);
//移除监听
mpPlayerWindow->get_control_handler()->remove_player_quality_listener(this);
//移除所有监听
mpPlayerWindow->get_control_handler()->remove_all_player_quality_listeners();
### 直播支持多路清晰度切换
无缝切换清晰度方案需要配置以下三个条件
1. 首先切换的模式要选择立即切换即：immediately=true
2. 服务端配置PTS透传，
3. 对应的清晰度要做主动转码设置
如果无法满足以上3个条件，那么建议用最基础的能力来实现清晰度切换，即每个清晰度都是一个media
model，切换时，调用playMediaModel来播放新的清晰度流。
## 视频宽高改变监听
在视频首帧渲染时，会调用该回调，告诉上层当前的视频宽高是多少，如果在这个这个视频播放的生命周期中，宽高改变，那么还会再次调用该回调.
添加监听前实现接口 QIPlayerVideoFrameSizeChangeListener。
/// <summary>
/// 推流端视频长宽变化回调
/// </summary>
/// <param name="width"> 宽度 </param>
/// <param name="height"> 高度 </param>
void on_video_frame_size_changed(int width, int height) override;
void on_video_frame_size_changed(int width, int height){
}
//添加监听
mpPlayerWindow->get_control_handler()->add_player_video_frame_size_change_listener(this);
//移除监听
mpPlayerWindow->get_control_handler()->remove_player_video_frame_size_change_listener(this);
//移除所有监听
mpPlayerWindow->get_control_handler()->remove_all_player_video_frame_size_change_listeners();
## 播放进度监听
添加监听前实现接口 QIPlayerProgressListener
只有在点播的时候 duration 和 progress 才有意义，直播的话这两个值没有参考意义
/// <summary>
/// 进度变更回调
/// </summary>
/// <param name="progress"> 当前进度 单位：毫秒 </param>
/// <param name="duration"> 当前视频总时长 单位： 毫秒 </param>
void on_progress_changed(int64_t progress, int64_t duration) override;
void on_progress_changed(int64_t progress, int64_t duration) {
}
//添加监听
mpPlayerWindow->get_control_handler()->add_player_progress_change_listener(this);
//移除监听
mpPlayerWindow->get_control_handler()->remove_player_progress_change_listener(this);
//移除所有监听
mpPlayerWindow->get_control_handler()->remove_all_player_progress_change_listeners();
## 实时帧率
### 实时帧率监听
添加监听前实现接口 QIPlayerFPSListener
/// <summary>
/// fps 改变回调
/// </summary>
/// <param name="fps"> fps 帧率 </param>
void on_fps_changed(long fps) override;
void on_fps_changed(long fps) {
}
//添加监听
mpPlayerWindow->get_control_handler()->add_player_fps_change_listener(this);
//移除监听
mpPlayerWindow->get_control_handler()->remove_player_fps_change_listener(this);
//移除所有监听
mpPlayerWindow->get_control_handler()->remove_all_player_fps_change_listeners();
## 像素格式或者音频sample格式不支持的监听
添加监听前实现接口 QIPlayerFormatListener
/// <summary>
/// 当前有 format 不支持，视频无法播放
/// </summary>
void on_format_not_support() override;
void on_format_not_support() {
}
//添加监听
mpPlayerWindow->get_control_handler()->add_player_format_listener(this);
//移除监听
mpPlayerWindow->get_control_handler()->remove_player_format_listener(this);
//移除所有监听
mpPlayerWindow->get_control_handler()->remove_all_player_format_listeners();
## 缓冲拉流监听
添加监听前实现接口 QIPlayerDownloadListener
/// <summary>
/// 下载数据变化回调
/// </summary>
/// <param name="download_speed"> 下载速度 </param>
/// <param name="buffer_pos"> 缓冲进度 </param>
void on_download_changed(int64_t download_speed, int64_t buffer_pos) override;
void on_download_changed(int64_t download_speed, int64_t buffer_pos){
}
//添加监听
mpPlayerWindow->get_control_handler()->add_player_download_change_listener(this);
//移除监听
mpPlayerWindow->get_control_handler()->remove_player_download_change_listener(this);
//移除所有监听
mpPlayerWindow->get_control_handler()->remove_all_player_download_change_listeners();
## 播放器操作不允许执行监听
添加监听前实现接口 QIPlayerCommandNotAllowListener 。在某些状态下，一些操作将不被执行，通过该监听回调上来通知
/// <summary>
/// 操作不被允许的回调
/// </summary>
/// <param name="command_name"> 操作名称 </param>
/// <param name="state"> 操作被检测时播放器的状态 </param>
void on_command_not_allow(const std::string& command_name, QMedia::QPlayerState state) override;
void on_command_not_allow(const std::string& command_name, QMedia::QPlayerState state){
}
//添加监听
mpPlayerWindow->get_control_handler()->add_player_command_not_allow_listener(this);
//移除监听
mpPlayerWindow->get_control_handler()->remove_player_command_not_allow_listener(this);
//移除所有监听
mpPlayerWindow->get_control_handler()->remove_all_player_command_not_allow_listeners();
## buffering 监听
添加监听前实现接口 QIPlayerBufferingListener
/// <summary>
/// buffering 开始通知
/// </summary>
void on_buffering_start() override;
/// <summary>
/// buffering 结束通知
/// </summary>
void on_buffering_end() override;
void on_buffering_start(){
}
void on_buffering_end(){
}
//添加监听
mpPlayerWindow->get_control_handler()->add_player_buffering_change_listener(this);
//移除监听
mpPlayerWindow->get_control_handler()->remove_player_buffering_change_listener(this);
//移除所有监听
mpPlayerWindow->get_control_handler()->remove_all_player_buffering_change_listeners();
## 静音播放
控制播放器静音，且该静音非系统的声音设置，仅仅只是把播放器设置为静音
### 设置静音播放
mpPlayerWindow->get_control_handler()->set_mute(false);
### 静音播放相关监听
添加监听前实现接口 QIPlayerAudioListener
/// <summary>
/// 静音状态改变回调
/// </summary>
/// <param name="is_mute"> 是否静音 true 静音 false 非静音 </param>
void on_mute_changed(bool is_mute) override;
void on_mute_changed(bool is_mute){
}
//添加监听
mpPlayerWindow->get_control_handler()->add_player_audio_listener(this);
//移除监听
mpPlayerWindow->get_control_handler()->remove_player_audio_listener(this);
//移除所有监听
mpPlayerWindow->get_control_handler()->remove_all_player_audio_listeners();
## 截图
调用截图接口，就会回调截图时的video画面，并以jpeg的格式返回
mpPlayerWindow->get_control_handler()->shoot_video();
### 截图图片类型枚举
enum class QPLAYER_API QShootVideoType : uint32_t {
NONE = 0,
JEPG = 1
};
### 截图相关监听
添加监听前实现接口 QIPlayerShootVideoListener
/// <summary>
/// 截图成功回调
/// </summary>
/// <param name="image_data"> 图片数据 </param>
/// <param name="size"> 图片数据的长度 </param>
/// <param name="width"> 图片的宽度 </param>
/// <param name="height"> 图片的高度 </param>
/// <param name="type"> 图片类型 </param>
void on_shoot_video_success(const std::unique_ptr<uint8_t[]>& image_data, uint64_t size, int width, int height, QMedia::QShootVideoType type) override;
/// <summary>
/// 截图失败回调
/// </summary>
void on_shoot_video_failed() override;
void on_shoot_video_success(const std::unique_ptr<uint8_t[]>& image_data, uint64_t size, int width, int height, QMedia::QShootVideoType type){
}
void on_shoot_video_failed(){
}
//添加监听
mpPlayerWindow->get_control_handler()->add_player_shoot_video_listener(this);
//移除监听
mpPlayerWindow->get_control_handler()->remove_player_shoot_video_listener(this);
//移除所有监听
mpPlayerWindow->get_control_handler()->remove_all_player_shoot_video_listeners();
## 码率
### 实时码率监听
添加监听前实现接口 QIPlayerBiteRateListener
/// <summary>
/// 码率变化回调
/// </summary>
/// <param name="bit_rate"> 码率 单位：bps </param>
void on_bite_rate_changed(int bit_rate) override;
void on_bite_rate_changed(int bit_rate) {
}
//添加监听
mpPlayerWindow->get_control_handler()->add_player_bite_rate_listener(this);
//移除监听
mpPlayerWindow->get_control_handler()->remove_player_bite_rate_listener(this);
//移除所有监听
mpPlayerWindow->get_control_handler()->remove_all_player_bite_rate_listeners();
## SEI 数据回调
用户自定义数据可以带在H264或者H265的编码帧里，用于实现一些基于时间轴的业务场景。
开启该功能后，如果视频资源内带有SEI数据 会通过监听接口抛给业务层。
该功能需要单独开通，具体可以联系技术支持咨询。
### 开启 SEI
mpPlayerWindow->get_control_handler()->set_sei_enable(true);
### SEI 数据监听
添加监听前实现接口 QIPlayerSEIDataListener
/// <summary>
/// SEI 数据回调，且回调时机为 SEI 数据所在帧的时间
/// </summary>
/// <param name="data"> SEI 数据 </param>
/// <param name="size"> SEI 数据的长度 </param>
void on_sei_data(const std::unique_ptr<uint8_t[]>& data, uint64_t size) override;
void on_sei_data(const std::unique_ptr<uint8_t[]>& data, uint64_t size){
}
//添加监听
mpPlayerWindow->get_control_handler()->add_player_sei_data_listener(this);
//移除监听
mpPlayerWindow->get_control_handler()->remove_player_sei_data_listener(this);
//移除所有监听
mpPlayerWindow->get_control_handler()->remove_all_player_sei_data_listeners();
## 渲染相关监听
添加监听前实现接口 QIPlayerRenderListener
/// <summary>
/// 首帧耗时回调
/// </summary>
/// <param name="elapsed_time"> 从 play_media_model 开始到首帧渲染出来的总耗时 单位：毫秒 </param>
void on_first_frame_rendered(int64_t elapsed_time) override;
void on_first_frame_rendered(int64_t elapsed_time){
}
//添加监听
mpPlayerWindow->get_render_handler()->add_render_listener(this);
//移除监听
mpPlayerWindow->get_render_handler()->remove_render_listener(this);
//移除所有监听
mpPlayerWindow->get_render_handler()->remove_all_render_listeners();
## 视频数据上抛相关监听
添加监听前实现接口 QIPlayerVideoDataListener
/// 视频数据上抛回调
/// </summary>
/// <param name="width"> 视频宽度 </param>
/// <param name="height"> 视频高度 </param>
/// <param name="video_type"> 视频类型 </param>
/// <param name="buffer"> 视频数据 </param>
/// <param name="size"> 视频数据长度 </param>
void on_video_data(int width, int height, QMedia::QVideoType video_type, const std::unique_ptr<uint8_t[]>& buffer, uint64_t size) override;
void on_video_data(int width, int height, QMedia::QVideoType video_type, const std::unique_ptr<uint8_t[]>& buffer, uint64_t size){
}
//添加监听
mpPlayerWindow->get_render_handler()->add_player_video_data_listener(this);
//移除监听
mpPlayerWindow->get_render_handler()->remove_player_video_data_listener(this);
//移除所有监听
mpPlayerWindow->get_render_handler()->remove_all_player_video_data_listeners();
## 音频数据上抛相关监听
添加监听前实现接口 QIPlayerAudioDataListener
/// 音频数据回调
/// </summary>
/// <param name="sample_rate"> 采样率 </param>
/// <param name="format"> 格式 </param>
/// <param name="channel_num"> 通道数 </param>
/// <param name="channel_layout"> 声道 </param>
/// <param name="audio_data"> 音频数据 </param>
/// <param name="size">数据大小</param>
void on_audio_data(int sample_rate, QMedia::QSampleFormat format, int channel_num, QMedia::QChannelLayout channel_layout, const std::unique_ptr<uint8_t[]>& audio_data, uint64_t size) override;
void on_audio_data(int sample_rate, QMedia::QSampleFormat format, int channel_num, QMedia::QChannelLayout channel_layout, const std::unique_ptr<uint8_t[]>& audio_data, uint64_t size){
}
//添加监听
mpPlayerWindow->get_render_handler()->add_player_audio_data_listener(this);
//移除监听
mpPlayerWindow->get_render_handler()->remove_player_audio_data_listener(this);
//移除所有监听
mpPlayerWindow->get_render_handler()->remove_all_player_audio_data_listeners();
## 设置视频渲染比例
mpPlayerWindow->get_render_handler()->set_render_ratio(QMedia::QPlayerSetting::QPlayerRenderRatio::QPLAYER_RATIO_SETTING_AUTO);
### 视频比例枚举
enum class QPlayerRenderRatio : uint16_t {
//自动
QPLAYER_RATIO_SETTING_AUTO = 1,
//拉升
QPLAYER_RATIO_SETTING_STRETCH = 2,
//铺满
QPLAYER_RATIO_SETTING_FULL_SCREEN = 3,
//16:9
QPLAYER_RATIO_SETTING_16_9 = 4,
//4:3
QPLAYER_RATIO_SETTING_4_3 = 5
};
## 设置色觉优化
mpPlayerWindow->get_render_handler()->set_blind_type(QMedia::QPlayerSetting::QPlayerBlind::QPLAYER_BLIND_SETTING_NONE);
### 色觉优化枚举
enum class QPlayerBlind : uint16_t {
//无
QPLAYER_BLIND_SETTING_NONE = 0,
//红色盲
QPLAYER_BLIND_SETTING_RED = 1,
//绿色盲
QPLAYER_BLIND_SETTING_GREEN = 2,
//蓝色盲
QPLAYER_BLIND_SETTING_BLUE = 3
};
## 字幕
### 字幕数据设置
//添加字幕地址
pmodel_builder->add_subtitle_element(subtitle_name, subtitle_url,subtitle_is_selected);
### 设置是否开启字幕
mpPlayerWindow->get_control_handler()->set_subtitle_enable(false);
### 设置字幕名称
mpPlayerWindow->get_control_handler()->set_subtitle("English");
### 字幕监听
添加监听前实现接口 QIPlayerSubtitleListener
/// <summary>
/// 字幕文本回调
/// </summary>
/// <param name="text"> 当前字幕的文本 </param>
void on_subtitle_text_changed(const std::string & text) override;
/// <summary>
/// 字幕切换回调
/// </summary>
/// <param name="name"> 当前的字幕名称 </param>
void on_subtitle_name_changed(const std::string & name) override;
/// <summary>
/// 字幕开启状态改变回调
/// </summary>
/// <param name="enable"> 当前字幕是否开启 true 开启 false 关闭 </param>
void on_subtitle_enable(bool enable) override;
/// <summary>
/// 字幕加载结果回调
/// </summary>
/// <param name="name"> 字幕名称 </param>
/// <param name="result"> 字幕加载结果 true 成功 false 失败 </param>
void on_subtitle_loaded(const std::string & name, bool result) override;
/// <summary>
/// 字幕解码结果回调
/// </summary>
/// <param name="name"> 字幕名称 </param>
/// <param name="result"> 字幕解码结果 true 成功 false 失败 </param>
void on_subtitle_decoded(const std::string & name, bool result) override;
void on_subtitle_text_changed(const std::string & text) {
}
void on_subtitle_name_changed(const std::string & name) {
}
void on_subtitle_enable(bool enable) {
}
void on_subtitle_loaded(const std::string & name, bool result) {
}
void on_subtitle_decoded(const std::string & name, bool result) {
}
//添加监听
mpPlayerWindow->get_control_handler()->add_player_subtitle_listener(this);
//移除监听
mpPlayerWindow->get_control_handler()->remove_player_subtitle_listener(this);
//移除所有监听
mpPlayerWindow->get_control_handler()->remove_all_player_subtitle_listeners();
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2
Windows端](https://developer.qiniu.com/pili/sdk/12642/qplayer2-windows) > [基于
Core 的 QPlayer2 接入指南](https://developer.qiniu.com/pili/sdk/12644/based-on-
qplayer2-windows-access-guide-to-the-core) > 基础能力使用
# 基础能力使用
最近更新时间: 2024-03-26 15:00:25
在 [快速开始 __](http://developer.qiniu.io/pili/12645/qplayer2-core-windows-quick-
start)中，我们完成了qplayer2播放器的创建\播放\销毁，本文介绍如何使用qplayer2的播放能力
## 播放
### 创建播放数据
QMedia::QMediaModelBuilder* pmodel_builder = new QMedia::QMediaModelBuilder;
//添加播放地址
pmodel_builder->add_stream_element(user_type, url_type, quality, url, is_selected, referer, back_up_url, render_type);
//添加字幕地址
pmodel_builder->add_subtitle_element(subtitle_name, subtitle_url,subtitle_is_selected);
//创建 QMediaModel
//is_live 是否是直播。true 直播,false 点播
//reconstruct_time_line 是否重构时间轴，true 重构，false 不重构
QMedia::QMediaModel* pmodel = pmodel_builder->build(is_live, reconstruct_time_line);
add_stream_element 属性说明
属性名 | 属性说明
---|---
userType | 用户自定义Type，目前预留，可以填空字符串
url | 资源地址
urlType | 媒体的资源属性 只包含视频/只包含音频/同时有视频音频
quality | 清晰度
isSelected | 是否起播时播放该流
backupUrl | 备用地址
referer | http/https 协议的地址 支持该属性
renderType | 视频的渲染类型
hlsDrmKey | 私有DRM解密的key，用在私有hls加密视频播放的场景中
mp4DrmKey | mp4 drm 的解密 key 用于 CENC-AES-CTR 加密的视频播放场景中
mp4QNDrmComKey | mp4 七牛私有 drm 的解密 comkey 用于七牛私有 mp4 加密的视频播放场景中
mp4QNDrmFileKey | mp4 七牛私有 drm 的解密 filekey 用于七牛私有 mp4 加密的视频播放场景中
## MP4 加密
目前 QPlayer2 支持七牛私有加密以及显式的 CENC-AES-CTR 加密，暂不支持隐式加密。CENC-AES-CTR 的初始化向量(IV)
由加密工具随机生成并存储在加密后的 MP4 文件中，QPlayer2 读取 MP4 文件的 IV 和QMediaModel 存储的 mp4DrmKey
进行解密。
### 播放 mp4 加密视频
QMedia::QMediaModelBuilder* pmodel_builder = new QMedia::QMediaModelBuilder;
//添加 CENC-AES-CTR 加密视频播放地址
pmodel_builder->add_stream_element_mp4_drm(user_type, url_type, quality, url, is_selected, referer, back_up_url，mp4_drm_key, render_type);
//添加 hls 加密视频播放地址
pmodel_builder->add_stream_element_hls_drm(user_type, url_type, quality, url, is_selected, referer, back_up_url，hls_drm, render_type);
//添加七牛私有 MP4 加密视频播放地址
pmodel_builder->add_stream_element_qn_mp4_drm(user_type, url_type, quality, url, is_selected, referer, back_up_url，mp4_qn_drm_com_key，mp4_qn_drm_file_key, render_type);
//添加字幕地址
pmodel_builder->add_subtitle_element(subtitle_name, subtitle_url,subtitle_is_selected);
//创建 QMediaModel
//is_live 是否是直播。true 直播,false 点播
//reconstruct_time_line 是否重构时间轴，true 重构，false 不重构
QMedia::QMediaModel* pmodel = pmodel_builder->build(is_live, reconstruct_time_line);
## 对 MP4 文件进行 CENC-AES-CTR 加密
可以选择 ffmpeg 对一个 MP4 进行加密。加密命令如下：
ffmpeg -i test2.mp4 -vcodec copy -acodec copy -encryption_scheme cenc-aes-ctr -encryption_key c7e16c4403654b85847037383f0c2db3 -encryption_kid a7e61c373e219033c21091fa607bf3b8 encrypted_IV_test.mp4
命令说明
test2.mp4 为输入文件
encrypted_IV_test.mp4 为输出文件
-vcodec copy 和 -acodec copy ：指定视频流和音频流的编码方式为原始流的拷贝，即不进行重新编码，保持与原始文件相同的编码格式。
-encryption_scheme cenc-aes-ctr ：设置加密方案为 CENC-AES-CTR，即采用 CTR 模式进行加密。
-encryption_key c7e16c4403654b85847037383f0c2db3 指定加密所使用的密钥，即解密所使用的 key。这里的c7e16c4403654b85847037383f0c2db3 是一个示例密钥，您可以替换为您自己的密钥，格式要求为：16字节的16进制数据。
-encryption_kid a7e61c373e219033c21091fa607bf3b8：指定加密所使用的密钥标识符（KID）。这里的 a7e61c373e219033c21091fa607bf3b8 是一个示例 KID，您可以替换为您自己的密钥标识符, 格式要求为：16字节的16进制数据。
加密后可通过ffplay 4.4 版本进行播放验证，播放正常即可。命令如下：
ffplay encrypted_IV_test.mp4 -decryption_key c7e16c4403654b85847037383f0c2db3
### 视频URL类型枚举
enum class QUrlType : uint32_t {
QAUDIO_AND_VIDEO = 0,
//仅包含音频
QAUDIO = 1,
//仅包含视频
QVIDEO = 2,
//无
NONE = 3
};
### 播放媒体资源
/// <summary>
/// 播放音视频资源
/// </summary>
/// <param name="pmedia_model"> 音视频资源 </param>
/// <param name="start_pos"> 起播时间戳 毫秒 </param>
/// <returns> true: 调用成功 false: 调用失败 </returns>
mpPlayerWindow->get_control_handler()->play_media_model(pmodel, 0);
### 播放错误监听
添加监听前实现接口 QIPlayerMediaNetworkListener
。当视频起播时，如果遇到网络等问题原因，导致没有和服务器建立链接，那么会导致视频播放失败，总共会有3次重试机会，3次都失败的情况下会回调onOpenFailed方法。
当视频已经起播后，在中途遇到网络等问题原因，进入buffer,
那么内核会一直重试，直到再次连接上服务端继续播放，或者用户通过接口停止播放该视频，在重试的过程中 onReconnectStart /
onReconnectEnd
会被回调，那么可以监控回调的次数来做业务层的结束播放的策略，当然在正常播放的情况下，这两个方法也是会被回调的，所以最好结合buffer的回调数据一起使用。
/// <summary>
/// 开始重连
/// </summary>
/// <param name="user_type"> 重连 url 的 userType </param>
/// <param name="url_type">重连 url 的 urlType </param>
/// <param name="url"> 重连的 url </param>
/// <param name="retry_time"> 重连 url 的次数 </param>
void on_reconnect_start(const std::string & user_type, QMedia::QUrlType url_type, const std::string & url, int retry_time) override;
/// <summary>
/// 重连结束
/// </summary>
/// <param name="user_type"> 重连 url 的 userType </param>
/// <param name="url_type"> 重连 url 的 urlType </param>
/// <param name="url"> 重连的 url </param>
/// <param name="retry_time"></param>
/// <param name="error"> 重连 url 的次数 </param>
void on_reconnect_end(const std::string & user_type, QMedia::QUrlType url_type, const std::string & url, int retry_time, QMedia::QOpenError error) override;
/// <summary>
/// 打开失败
/// </summary>
/// <param name="user_type"> 打开失败 url 的 userType </param>
/// <param name="url_type"> 打开失败 url 的 urlType </param>
/// <param name="url"> 打开失败的 url </param>
/// <param name="error"> 打开失败 url 的 错误码 </param>
void on_open_failed(const std::string & user_type, QMedia::QUrlType url_type, const std::string & url, QMedia::QOpenError error) override;
void on_reconnect_start(const std::string &user_type, QMedia::QUrlType url_type, const std::string& url, int retry_time){
}
void on_reconnect_end(const std::string &user_type, QMedia::QUrlType url_type, const std::string& url, int retry_time, QMedia::QOpenError error) {
}
void on_open_failed(const std::string &user_type, QMedia::QUrlType url_type, const std::string& url, QMedia::QOpenError error){
}
//添加监听
mpPlayerWindow->get_control_handler()->add_player_media_network_listener(this);
//移除监听
mpPlayerWindow->get_control_handler()->remove_player_media_network_listener(this);
//移除所有监听
mpPlayerWindow->get_control_handler()->remove_all_player_media_network_listeners();
### 播放错误码枚举
enum class QPLAYER_API QOpenError : int64_t {
UNKNOW = 10000,
NONE = 0,
IOERROR = -5,
INTERRUPT = -1414092869,
URL_INVALID = -875574520,
FORMAT_INVALID = -1094995529
};
### 暂停播放
/// <summary>
/// 暂停渲染
/// </summary>
/// <returns> true: 调用成功 false: 调用失败 </returns>
mpPlayerWindow->get_control_handler()->pause_render();
### 恢复播放
/// <summary>
/// 在暂停渲染状态下 恢复渲染
/// </summary>
/// <returns> true: 调用成功 false: 调用失败 </returns>
mpPlayerWindow->get_control_handler()->resume_render();
### 停止当前视频播放
/// <summary>
/// 停止当前视频播放
/// </summary>
/// <returns> true: 调用成功 false: 调用失败 </returns>
mpPlayerWindow->get_control_handler()->stop();
## 鉴权
鉴权功能介绍见[鉴权相关文档 __](http://developer.qiniu.io/pili/12223/qplayer2-core-
authentication-related)
### 强制网络鉴权
调用该接口时，会强制进行网络鉴权
/// <summary>
/// 下一次鉴权强制通过网络鉴权
/// </summary>
/// <returns> true: 调用成功 false: 调用失败 </returns>
mpPlayerWindow->get_control_handler()->force_authentication_from_network();
### 鉴权监听
添加监听前实现接口 QIPlayerAuthenticationListener 协议。
/// <summary>
/// 鉴权失败
/// </summary>
/// <param name="error"> 鉴权失败错误码 </param>
void on_authentication_failed(QMedia::QAuthenticationErrorType error) override;
/// <summary>
/// 鉴权成功
/// </summary>
void on_authentication_success() override;
void on_authentication_failed(QMedia::QAuthenticationErrorType error){
}
void on_authentication_success(){
}
//添加监听
mpPlayerWindow->get_control_handler()->add_player_authentication_listener(this);
//移除监听
mpPlayerWindow->get_control_handler()->remove_player_authentication_listener(this);
//移除所有监听
mpPlayerWindow->get_control_handler()->remove_all_player_authentication_listeners();
### 鉴权错误码枚举
enum class QPLAYER_API QAuthenticationErrorType : uint32_t {
NONE = 0, //鉴权出错
NO_BASE_AUTH = 1, //缺少基础功能权限
NO_VR_AUTH = 2, //缺少 VR 功能权限
NO_BLIND_AUTH = 3, //缺少色盲功能权限
NO_SEI_AUTH = 4, //缺少 SEI 功能权限
NO_SRT_AUTH = 5 //缺少 SRT 功能权限
};
## 切换视频进度
参数为要定位的position 单位毫秒
/// <summary>
/// seek
/// </summary>
/// <param name="position"> seek 的位置 单位 ms </param>
/// <returns></returns>
mpPlayerWindow->get_control_handler()->seek(100);
### 切换视频进度结果监听
添加监听前实现接口 QIPlayerSeekListener
/// <summary>
/// seek 成功回调
/// </summary>
void on_seek_success() override;
/// <summary>
/// seek 失败回调
/// </summary>
void on_seek_failed() override;
void on_seek_success() {
}
void on_seek_failed() {
}
//添加监听
mpPlayerWindow->get_control_handler()->add_player_seek_listener(this);
//移除监听
mpPlayerWindow->get_control_handler()->remove_player_seek_listener(this);
//移除所有监听
mpPlayerWindow->get_control_handler()->remove_all_player_seek_listeners();
## 视频解码方式
目前支持的解码方式有:软解、硬解、自动，一般情况下，使用自动，内核会根据手机的硬件情况，要播放的视频资源编码格式等信息，挑选合适的解码方式进行解码，各个解码方式的优劣情况如下
软解: 解码较慢，但是兼容性好，适用于所有手机
硬解：解码性能高，但是有一定兼容性，比如某些视频资源的编码格式，硬解芯片不支持。并且相对于软解，首帧的速度慢。
### 设置优先选择哪种解码方式
设置完成后下一次播放生效.
最终的解码方式可能不是设置的，在设置的解码方式不能正确解码时，内核会进行降级，选择其他能正确解码的方式
/// <summary>
/// 设置解码方式
/// </summary>
/// <param name="type"> 解码方式 </param>
/// <returns> true: 调用成功 false: 调用失败 </returns>
mpPlayerWindow->get_control_handler()->set_decode_type(QMedia::QPlayerSetting::QPlayerDecoder::QPLAYER_DECODER_SETTING_AUTO);
### 优先选择的解码方式枚举
该枚举主要用于设置解码方式
enum class QPLAYER_API QPlayerDecoder : uint16_t
{
//自动选择
QPLAYER_DECODER_SETTING_AUTO = 0,
//硬解优先
QPLAYER_DECODER_SETTING_HARDWARE_PRIORITY = 1,
//软解优先
QPLAYER_DECODER_SETTING_SOFT_PRIORITY = 2,
};
### 播放器视频解码监听相关
添加监听前实现接口 QIPlayerVideoDecodeListender 协议。
/// <summary>
/// 播放器解码类型回调
/// </summary>
/// <param name="type"> 解码类型 </param>
void on_video_decode_by_type(QMedia::QDecoderType type) override;
/// <summary>
/// 解码失败回调
/// </summary>
/// <param name="retry"> 是否降级重试成功 true 是 false 否 </param>
void on_decode_failed(bool retry) override;
/// <summary>
/// 如果当前视频解码所在设备或者 sdk 不支持，则回调该函数
/// </summary>
/// <param name="codec_id"> 视频解码的 id </param>
void on_not_support_codec_format(int codec_id) override;
void on_video_decode_by_type(QMedia::QDecoderType type) {
}
void on_decode_failed(bool retry) {
}
void on_not_support_codec_format(int codec_id) {
}
//添加监听
mpPlayerWindow->get_control_handler()->add_player_video_decode_type_listener(this);
//移除监听
mpPlayerWindow->get_control_handler()->remove_player_video_decode_type_listener(this);
//移除所有监听
mpPlayerWindow->get_control_handler()->remove_all_player_video_decode_type_listeners();
### 解码方式枚举
该枚举主要用于监听返回的解码方式
enum class QPLAYER_API QDecoderType : uint32_t {
NONE = 0,
SOFTWARE = 1,
HARDWARE = 31
};
## 设置起播方式
下一次播放生效
/// <summary>
/// 设置起播方式
/// </summary>
/// <param name="action"> 起播方式 </param>
/// <returns> true: 调用成功 false: 调用失败 </returns>
mpPlayerWindow->get_control_handler()->set_start_action(QMedia::QPlayerSetting::QPlayerStart::QPLAYER_START_SETTING_PLAYING);
### 起播方式枚举
enum class QPlayerStart : uint16_t {
//起播播放
QPLAYER_START_SETTING_PLAYING = 0,
//起播暂停在首帧
QPLAYER_START_SETTING_PAUSE = 1,
};
## 设置 seek 方式
下一次播放生效
/// <summary>
/// 设置seek方式
/// </summary>
/// <param name="mode"> seek方式 </param>
/// <returns> true: 调用成功 false: 调用失败 </returns>
mpPlayerWindow->get_control_handler()->set_seek_mode(QMedia::QPlayerSetting::QPlayerSeek::QPLAYER_SEEK_SETTING_NORMAL);
### seek方式枚举
enum class QPlayerSeek : uint16_t {
//关键帧seek，每次seek 都seek到离目标位置向前的最近的一个关键帧，耗时少
QPLAYER_SEEK_SETTING_NORMAL = 0,
//精准seek，耗时比关键帧seek多，且耗时和视频的gop间隔的大小成正比
QPLAYER_SEEK_SETTING_ACCURATE = 1
};
## 播放器状态
在整个播放器实例生命周期中，播放会在不同的状态中切换，用户可以通过监听播放器状态，实现上层业务逻辑，
比如在视频播放完时，展示其他视频的推荐页，那么只需监听播放器状态回调，待回调的状态是COMPLETED，则展示推荐页
### 播放器状态枚举
enum class QPLAYER_API QPlayerState : uint32_t {
NONE = 0,//初始状态
INIT = 1,//播放器开始创建各种对象 没有对应的state 创建完对象就上报这个状态
PREPARE = 2,//开始拉视频数据解码变换等，重新换地址后，都走这个状态
PLAYING = 4,//播放中
PAUSED_RENDER = 6,//用户暂停
COMPLETED = 7,//播放完成
SEEKING = 8, //SEEK
STOPPED = 9,//播放器停止中
MISTAKE = 10,//播放出错（是否需要分 可恢复 和 不可恢复 ）
END = 11,//播放器释放各种对象完成
MEDIA_ITEM_PREPARE = 12, //开始拉视频数据解码变换等，重新换地址后，都走这个状态 针对Media Item的play 方式
RELEASE = 13 //播放器结束，且释放各类资源
};
### 播放器状态变更监听相关
添加监听前需要签订QIPlayerStateChangeListener协议。
/// <summary>
/// 当前的播放状态发生改变时回调
/// </summary>
/// <param name="state"> 当前的播放状态 </param>
void on_state_changed(QMedia::QPlayerState state) override;
void on_state_changed(QMedia::QPlayerState state) {
}
//添加监听
mpPlayerWindow->get_control_handler()->add_player_state_change_listener(this);
//移除监听
mpPlayerWindow->get_control_handler()->remove_player_state_change_listener(this);
//移除所有监听
mpPlayerWindow->get_control_handler()->remove_all_player_state_change_listeners();
## 播放速度
播放速度的调整范围建议在0.25-2.0之间，这样会有一个比较好的效果
### 设置播放速度
参数为倍速值
/// <summary>
/// 设置播放速度
/// </summary>
/// <param name="speed"> 需要设置的倍速 </param>
/// <returns> true: 调用成功 false: 调用失败 </returns>
mpPlayerWindow->get_control_handler()->set_speed(0.5);
### 速度变更监听相关
添加监听前实现接口 QIPlayerSpeedListener
/// <summary>
/// 播放速度改变回调
/// </summary>
/// <param name="speed"> 当前的播放速度 </param>
void on_speed_changed(float speed) override;
void on_speed_changed(float speed) {
}
//添加监听
mpPlayerWindow->get_control_handler()->add_player_speed_change_listener(this);
//移除监听
mpPlayerWindow->get_control_handler()->remove_player_speed_change_listener(this);
//移除所有监听
mpPlayerWindow->get_control_handler()->remove_all_player_speed_change_listeners();
## 清晰度
QPlayer2 提供的清晰度能力是无缝切换清晰度方案，在切换过程中，画面是连续的画面，不会出现类似跳帧的情况。
使用无缝切换清晰度功能，必须在 mediaModel 中配置多路清晰度，如果使用非 immediately
方式(即异步方式)时，同时只能有一次切换会话存在，会话结束后，才能切下一次
### 切换视频清晰度
/// <summary>
/// 切换清晰度,针对一个视频由多路url流组成的情况下，可以按找流来进行清晰度切换，
/// 比如一个视频由2路url组成，一路视频，一路音频，那么可以只切换音频路的url达到音频的清晰度切换，也可以
/// 只切换视频路的url达到视频的清晰度切换。
/// </summary>
/// <param name="user_type"> 要切换的url流的userType </param>
/// <param name="url_type"> 要切换的url流的urlType </param>
/// <param name="quality_index"> 要切换到哪一路清晰度 </param>
/// <param name="immediately"> true: 立即切换，直播情况下
mpPlayerWindow->get_control_handler()->switch_quality(pinner_ele->get_user_type(), pinner_ele->get_url_type(), 1080, true);
### 播放器清晰度相关监听
添加监听前实现接口 QIPlayerQualityListener
/// <summary>
/// 开始切换清晰度
/// </summary>
/// <param name="user_type"> 切换清晰度的 URL 的 userType </param>
/// <param name="url_type"> 切换清晰度的 URL 的 urlType </param>
/// <param name="old_quality"> 切换清晰度前的清晰度 </param>
/// <param name="new_quality"> 切换清晰度后的清晰度 </param>
void on_quality_switch_start(const std::string & user_type, QMedia::QUrlType url_type, int old_quality, int new_quality) override;
/// <summary>
/// 清晰度切换完成
/// </summary>
/// <param name="user_type"> 切换清晰度的 URL 的 userType </param>
/// <param name="url_type"> 切换清晰度的 URL 的 urlType </param>
/// <param name="old_quality"> 切换清晰度前的清晰度 </param>
/// <param name="new_quality"> 切换清晰度后的清晰度 </param>
void on_quality_switch_complete(const std::string & user_type, QMedia::QUrlType url_type, int old_quality, int new_quality) override;
/// <summary>
/// 清晰度切换取消
/// </summary>
/// <param name="user_type"> 切换清晰度的 URL 的 userType </param>
/// <param name="url_type"> 切换清晰度的 URL 的 urlType </param>
/// <param name="old_quality"> 切换清晰度前的清晰度 </param>
/// <param name="new_quality"> 切换清晰度后的清晰度 </param>
void on_quality_switch_canceled(const std::string & user_type, QMedia::QUrlType url_type, int old_quality, int new_quality) override;
/// <summary>
/// 清晰度切换失败
/// </summary>
/// <param name="user_type"> 切换清晰度的 URL 的 userType </param>
/// <param name="url_type"> 切换清晰度的 URL 的 urlType </param>
/// <param name="old_quality"> 切换清晰度前的清晰度 </param>
/// <param name="new_quality"> 切换清晰度后的清晰度 </param>
void on_quality_switch_failed(const std::string & user_type, QMedia::QUrlType url_type, int old_quality, int new_quality) override;
/// <summary>
/// 目前仅支持同时有一个清晰度切换事件，如果前一个切换还未完成，再次切换清晰度，则会回调该函数
/// </summary>
/// <param name="user_type"> 切换清晰度的 URL 的 userType </param>
/// <param name="url_type"> 切换清晰度的 URL 的 urlType </param>
void on_quality_switch_retry_later(const std::string & user_type, QMedia::QUrlType url_type) override;
void on_quality_switch_start(const std::string & user_type, QMedia::QUrlType url_type, int old_quality, int new_quality) {
}
void on_quality_switch_complete(const std::string & user_type, QMedia::QUrlType url_type, int old_quality, int new_quality) {
}
void on_quality_switch_canceled(const std::string & user_type, QMedia::QUrlType url_type, int old_quality, int new_quality) {
}
void on_quality_switch_failed(const std::string & user_type, QMedia::QUrlType url_type, int old_quality, int new_quality) {
}
void on_quality_switch_retry_later(const std::string & user_type, QMedia::QUrlType url_type) {
}
//添加监听
mpPlayerWindow->get_control_handler()->add_player_quality_listener(this);
//移除监听
mpPlayerWindow->get_control_handler()->remove_player_quality_listener(this);
//移除所有监听
mpPlayerWindow->get_control_handler()->remove_all_player_quality_listeners();
### 直播支持多路清晰度切换
无缝切换清晰度方案需要配置以下三个条件
1. 首先切换的模式要选择立即切换即：immediately=true
2. 服务端配置PTS透传，
3. 对应的清晰度要做主动转码设置
如果无法满足以上3个条件，那么建议用最基础的能力来实现清晰度切换，即每个清晰度都是一个media
model，切换时，调用playMediaModel来播放新的清晰度流。
## 视频宽高改变监听
在视频首帧渲染时，会调用该回调，告诉上层当前的视频宽高是多少，如果在这个这个视频播放的生命周期中，宽高改变，那么还会再次调用该回调.
添加监听前实现接口 QIPlayerVideoFrameSizeChangeListener。
/// <summary>
/// 推流端视频长宽变化回调
/// </summary>
/// <param name="width"> 宽度 </param>
/// <param name="height"> 高度 </param>
void on_video_frame_size_changed(int width, int height) override;
void on_video_frame_size_changed(int width, int height){
}
//添加监听
mpPlayerWindow->get_control_handler()->add_player_video_frame_size_change_listener(this);
//移除监听
mpPlayerWindow->get_control_handler()->remove_player_video_frame_size_change_listener(this);
//移除所有监听
mpPlayerWindow->get_control_handler()->remove_all_player_video_frame_size_change_listeners();
## 播放进度监听
添加监听前实现接口 QIPlayerProgressListener
只有在点播的时候 duration 和 progress 才有意义，直播的话这两个值没有参考意义
/// <summary>
/// 进度变更回调
/// </summary>
/// <param name="progress"> 当前进度 单位：毫秒 </param>
/// <param name="duration"> 当前视频总时长 单位： 毫秒 </param>
void on_progress_changed(int64_t progress, int64_t duration) override;
void on_progress_changed(int64_t progress, int64_t duration) {
}
//添加监听
mpPlayerWindow->get_control_handler()->add_player_progress_change_listener(this);
//移除监听
mpPlayerWindow->get_control_handler()->remove_player_progress_change_listener(this);
//移除所有监听
mpPlayerWindow->get_control_handler()->remove_all_player_progress_change_listeners();
## 实时帧率
### 实时帧率监听
添加监听前实现接口 QIPlayerFPSListener
/// <summary>
/// fps 改变回调
/// </summary>
/// <param name="fps"> fps 帧率 </param>
void on_fps_changed(long fps) override;
void on_fps_changed(long fps) {
}
//添加监听
mpPlayerWindow->get_control_handler()->add_player_fps_change_listener(this);
//移除监听
mpPlayerWindow->get_control_handler()->remove_player_fps_change_listener(this);
//移除所有监听
mpPlayerWindow->get_control_handler()->remove_all_player_fps_change_listeners();
## 像素格式或者音频sample格式不支持的监听
添加监听前实现接口 QIPlayerFormatListener
/// <summary>
/// 当前有 format 不支持，视频无法播放
/// </summary>
void on_format_not_support() override;
void on_format_not_support() {
}
//添加监听
mpPlayerWindow->get_control_handler()->add_player_format_listener(this);
//移除监听
mpPlayerWindow->get_control_handler()->remove_player_format_listener(this);
//移除所有监听
mpPlayerWindow->get_control_handler()->remove_all_player_format_listeners();
## 缓冲拉流监听
添加监听前实现接口 QIPlayerDownloadListener
/// <summary>
/// 下载数据变化回调
/// </summary>
/// <param name="download_speed"> 下载速度 </param>
/// <param name="buffer_pos"> 缓冲进度 </param>
void on_download_changed(int64_t download_speed, int64_t buffer_pos) override;
void on_download_changed(int64_t download_speed, int64_t buffer_pos){
}
//添加监听
mpPlayerWindow->get_control_handler()->add_player_download_change_listener(this);
//移除监听
mpPlayerWindow->get_control_handler()->remove_player_download_change_listener(this);
//移除所有监听
mpPlayerWindow->get_control_handler()->remove_all_player_download_change_listeners();
## 播放器操作不允许执行监听
添加监听前实现接口 QIPlayerCommandNotAllowListener 。在某些状态下，一些操作将不被执行，通过该监听回调上来通知
/// <summary>
/// 操作不被允许的回调
/// </summary>
/// <param name="command_name"> 操作名称 </param>
/// <param name="state"> 操作被检测时播放器的状态 </param>
void on_command_not_allow(const std::string& command_name, QMedia::QPlayerState state) override;
void on_command_not_allow(const std::string& command_name, QMedia::QPlayerState state){
}
//添加监听
mpPlayerWindow->get_control_handler()->add_player_command_not_allow_listener(this);
//移除监听
mpPlayerWindow->get_control_handler()->remove_player_command_not_allow_listener(this);
//移除所有监听
mpPlayerWindow->get_control_handler()->remove_all_player_command_not_allow_listeners();
## buffering 监听
添加监听前实现接口 QIPlayerBufferingListener
/// <summary>
/// buffering 开始通知
/// </summary>
void on_buffering_start() override;
/// <summary>
/// buffering 结束通知
/// </summary>
void on_buffering_end() override;
void on_buffering_start(){
}
void on_buffering_end(){
}
//添加监听
mpPlayerWindow->get_control_handler()->add_player_buffering_change_listener(this);
//移除监听
mpPlayerWindow->get_control_handler()->remove_player_buffering_change_listener(this);
//移除所有监听
mpPlayerWindow->get_control_handler()->remove_all_player_buffering_change_listeners();
## 静音播放
控制播放器静音，且该静音非系统的声音设置，仅仅只是把播放器设置为静音
### 设置静音播放
mpPlayerWindow->get_control_handler()->set_mute(false);
### 静音播放相关监听
添加监听前实现接口 QIPlayerAudioListener
/// <summary>
/// 静音状态改变回调
/// </summary>
/// <param name="is_mute"> 是否静音 true 静音 false 非静音 </param>
void on_mute_changed(bool is_mute) override;
void on_mute_changed(bool is_mute){
}
//添加监听
mpPlayerWindow->get_control_handler()->add_player_audio_listener(this);
//移除监听
mpPlayerWindow->get_control_handler()->remove_player_audio_listener(this);
//移除所有监听
mpPlayerWindow->get_control_handler()->remove_all_player_audio_listeners();
## 截图
调用截图接口，就会回调截图时的video画面，并以jpeg的格式返回
mpPlayerWindow->get_control_handler()->shoot_video();
### 截图图片类型枚举
enum class QPLAYER_API QShootVideoType : uint32_t {
NONE = 0,
JEPG = 1
};
### 截图相关监听
添加监听前实现接口 QIPlayerShootVideoListener
/// <summary>
/// 截图成功回调
/// </summary>
/// <param name="image_data"> 图片数据 </param>
/// <param name="size"> 图片数据的长度 </param>
/// <param name="width"> 图片的宽度 </param>
/// <param name="height"> 图片的高度 </param>
/// <param name="type"> 图片类型 </param>
void on_shoot_video_success(const std::unique_ptr<uint8_t[]>& image_data, uint64_t size, int width, int height, QMedia::QShootVideoType type) override;
/// <summary>
/// 截图失败回调
/// </summary>
void on_shoot_video_failed() override;
void on_shoot_video_success(const std::unique_ptr<uint8_t[]>& image_data, uint64_t size, int width, int height, QMedia::QShootVideoType type){
}
void on_shoot_video_failed(){
}
//添加监听
mpPlayerWindow->get_control_handler()->add_player_shoot_video_listener(this);
//移除监听
mpPlayerWindow->get_control_handler()->remove_player_shoot_video_listener(this);
//移除所有监听
mpPlayerWindow->get_control_handler()->remove_all_player_shoot_video_listeners();
## 码率
### 实时码率监听
添加监听前实现接口 QIPlayerBiteRateListener
/// <summary>
/// 码率变化回调
/// </summary>
/// <param name="bit_rate"> 码率 单位：bps </param>
void on_bite_rate_changed(int bit_rate) override;
void on_bite_rate_changed(int bit_rate) {
}
//添加监听
mpPlayerWindow->get_control_handler()->add_player_bite_rate_listener(this);
//移除监听
mpPlayerWindow->get_control_handler()->remove_player_bite_rate_listener(this);
//移除所有监听
mpPlayerWindow->get_control_handler()->remove_all_player_bite_rate_listeners();
## SEI 数据回调
用户自定义数据可以带在H264或者H265的编码帧里，用于实现一些基于时间轴的业务场景。
开启该功能后，如果视频资源内带有SEI数据 会通过监听接口抛给业务层。
该功能需要单独开通，具体可以联系技术支持咨询。
### 开启 SEI
mpPlayerWindow->get_control_handler()->set_sei_enable(true);
### SEI 数据监听
添加监听前实现接口 QIPlayerSEIDataListener
/// <summary>
/// SEI 数据回调，且回调时机为 SEI 数据所在帧的时间
/// </summary>
/// <param name="data"> SEI 数据 </param>
/// <param name="size"> SEI 数据的长度 </param>
void on_sei_data(const std::unique_ptr<uint8_t[]>& data, uint64_t size) override;
void on_sei_data(const std::unique_ptr<uint8_t[]>& data, uint64_t size){
}
//添加监听
mpPlayerWindow->get_control_handler()->add_player_sei_data_listener(this);
//移除监听
mpPlayerWindow->get_control_handler()->remove_player_sei_data_listener(this);
//移除所有监听
mpPlayerWindow->get_control_handler()->remove_all_player_sei_data_listeners();
## 渲染相关监听
添加监听前实现接口 QIPlayerRenderListener
/// <summary>
/// 首帧耗时回调
/// </summary>
/// <param name="elapsed_time"> 从 play_media_model 开始到首帧渲染出来的总耗时 单位：毫秒 </param>
void on_first_frame_rendered(int64_t elapsed_time) override;
void on_first_frame_rendered(int64_t elapsed_time){
}
//添加监听
mpPlayerWindow->get_render_handler()->add_render_listener(this);
//移除监听
mpPlayerWindow->get_render_handler()->remove_render_listener(this);
//移除所有监听
mpPlayerWindow->get_render_handler()->remove_all_render_listeners();
## 视频数据上抛相关监听
添加监听前实现接口 QIPlayerVideoDataListener
/// 视频数据上抛回调
/// </summary>
/// <param name="width"> 视频宽度 </param>
/// <param name="height"> 视频高度 </param>
/// <param name="video_type"> 视频类型 </param>
/// <param name="buffer"> 视频数据 </param>
/// <param name="size"> 视频数据长度 </param>
void on_video_data(int width, int height, QMedia::QVideoType video_type, const std::unique_ptr<uint8_t[]>& buffer, uint64_t size) override;
void on_video_data(int width, int height, QMedia::QVideoType video_type, const std::unique_ptr<uint8_t[]>& buffer, uint64_t size){
}
//添加监听
mpPlayerWindow->get_render_handler()->add_player_video_data_listener(this);
//移除监听
mpPlayerWindow->get_render_handler()->remove_player_video_data_listener(this);
//移除所有监听
mpPlayerWindow->get_render_handler()->remove_all_player_video_data_listeners();
## 音频数据上抛相关监听
添加监听前实现接口 QIPlayerAudioDataListener
/// 音频数据回调
/// </summary>
/// <param name="sample_rate"> 采样率 </param>
/// <param name="format"> 格式 </param>
/// <param name="channel_num"> 通道数 </param>
/// <param name="channel_layout"> 声道 </param>
/// <param name="audio_data"> 音频数据 </param>
/// <param name="size">数据大小</param>
void on_audio_data(int sample_rate, QMedia::QSampleFormat format, int channel_num, QMedia::QChannelLayout channel_layout, const std::unique_ptr<uint8_t[]>& audio_data, uint64_t size) override;
void on_audio_data(int sample_rate, QMedia::QSampleFormat format, int channel_num, QMedia::QChannelLayout channel_layout, const std::unique_ptr<uint8_t[]>& audio_data, uint64_t size){
}
//添加监听
mpPlayerWindow->get_render_handler()->add_player_audio_data_listener(this);
//移除监听
mpPlayerWindow->get_render_handler()->remove_player_audio_data_listener(this);
//移除所有监听
mpPlayerWindow->get_render_handler()->remove_all_player_audio_data_listeners();
## 设置视频渲染比例
mpPlayerWindow->get_render_handler()->set_render_ratio(QMedia::QPlayerSetting::QPlayerRenderRatio::QPLAYER_RATIO_SETTING_AUTO);
### 视频比例枚举
enum class QPlayerRenderRatio : uint16_t {
//自动
QPLAYER_RATIO_SETTING_AUTO = 1,
//拉升
QPLAYER_RATIO_SETTING_STRETCH = 2,
//铺满
QPLAYER_RATIO_SETTING_FULL_SCREEN = 3,
//16:9
QPLAYER_RATIO_SETTING_16_9 = 4,
//4:3
QPLAYER_RATIO_SETTING_4_3 = 5
};
## 设置色觉优化
mpPlayerWindow->get_render_handler()->set_blind_type(QMedia::QPlayerSetting::QPlayerBlind::QPLAYER_BLIND_SETTING_NONE);
### 色觉优化枚举
enum class QPlayerBlind : uint16_t {
//无
QPLAYER_BLIND_SETTING_NONE = 0,
//红色盲
QPLAYER_BLIND_SETTING_RED = 1,
//绿色盲
QPLAYER_BLIND_SETTING_GREEN = 2,
//蓝色盲
QPLAYER_BLIND_SETTING_BLUE = 3
};
## 字幕
### 字幕数据设置
//添加字幕地址
pmodel_builder->add_subtitle_element(subtitle_name, subtitle_url,subtitle_is_selected);
### 设置是否开启字幕
mpPlayerWindow->get_control_handler()->set_subtitle_enable(false);
### 设置字幕名称
mpPlayerWindow->get_control_handler()->set_subtitle("English");
### 字幕监听
添加监听前实现接口 QIPlayerSubtitleListener
/// <summary>
/// 字幕文本回调
/// </summary>
/// <param name="text"> 当前字幕的文本 </param>
void on_subtitle_text_changed(const std::string & text) override;
/// <summary>
/// 字幕切换回调
/// </summary>
/// <param name="name"> 当前的字幕名称 </param>
void on_subtitle_name_changed(const std::string & name) override;
/// <summary>
/// 字幕开启状态改变回调
/// </summary>
/// <param name="enable"> 当前字幕是否开启 true 开启 false 关闭 </param>
void on_subtitle_enable(bool enable) override;
/// <summary>
/// 字幕加载结果回调
/// </summary>
/// <param name="name"> 字幕名称 </param>
/// <param name="result"> 字幕加载结果 true 成功 false 失败 </param>
void on_subtitle_loaded(const std::string & name, bool result) override;
/// <summary>
/// 字幕解码结果回调
/// </summary>
/// <param name="name"> 字幕名称 </param>
/// <param name="result"> 字幕解码结果 true 成功 false 失败 </param>
void on_subtitle_decoded(const std::string & name, bool result) override;
void on_subtitle_text_changed(const std::string & text) {
}
void on_subtitle_name_changed(const std::string & name) {
}
void on_subtitle_enable(bool enable) {
}
void on_subtitle_loaded(const std::string & name, bool result) {
}
void on_subtitle_decoded(const std::string & name, bool result) {
}
//添加监听
mpPlayerWindow->get_control_handler()->add_player_subtitle_listener(this);
//移除监听
mpPlayerWindow->get_control_handler()->remove_player_subtitle_listener(this);
//移除所有监听
mpPlayerWindow->get_control_handler()->remove_all_player_subtitle_listeners();
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,435 |
QPlayer2 iOS端 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >QPlayer2 iOS端
# QPlayer2 iOS端
最近更新时间: 2022-09-27 15:57:48
QPlayer2 iOS端文档包含如下几个部分
* 集成准备：主要介绍将QPlayer2引入到工程中的一些配置
* 基于qplayer2-core的QPlayer2接入指南：如果仅仅使用qplayer2-core开发，则参考这个文档。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >QPlayer2 iOS端
# QPlayer2 iOS端
最近更新时间: 2022-09-27 15:57:48
QPlayer2 iOS端文档包含如下几个部分
* 集成准备：主要介绍将QPlayer2引入到工程中的一些配置
* 基于qplayer2-core的QPlayer2接入指南：如果仅仅使用qplayer2-core开发，则参考这个文档。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,476 |
集成准备 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2
iOS端](https://developer.qiniu.com/pili/sdk/12225/qplayer2-ios-side) > 集成准备
# 集成准备
最近更新时间: 2023-12-08 18:35:58
# 集成准备
本文为您介绍 iOS qplayer2 SDK 的集成准备的环境要求和具体操作步骤。
## 环境要求
类别 | 说明
---|---
系统版本 | iOS 10.0 及 以上版本的iOS设备
## 获取 QPlayer2 License
联系技术支持获取
## 添加 QPlayer2 依赖
### 1.进入[https://github.com/pili-engineering/QPlayer2-IOS.git
__](https://github.com/pili-engineering/QPlayer2-IOS)查看最新QPlayer2的版本
### 2.配置 podfile 文件，引入 qplayer2-core
pod 'qplayer2-core', '1.0.2'
#### 如需要真机 ＋ 虚拟机可以改用如下配置：
pod "qplayer2-core", :podspec => 'https://raw.githubusercontent.com/pili-engineering/QPlayer2-IOS/main/qplayer2-core-Universal.podspec'
### 3.关闭Bitcode
### 4.取消勾选 Metal 中 API Validation
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2
iOS端](https://developer.qiniu.com/pili/sdk/12225/qplayer2-ios-side) > 集成准备
# 集成准备
最近更新时间: 2023-12-08 18:35:58
# 集成准备
本文为您介绍 iOS qplayer2 SDK 的集成准备的环境要求和具体操作步骤。
## 环境要求
类别 | 说明
---|---
系统版本 | iOS 10.0 及 以上版本的iOS设备
## 获取 QPlayer2 License
联系技术支持获取
## 添加 QPlayer2 依赖
### 1.进入[https://github.com/pili-engineering/QPlayer2-IOS.git
__](https://github.com/pili-engineering/QPlayer2-IOS)查看最新QPlayer2的版本
### 2.配置 podfile 文件，引入 qplayer2-core
pod 'qplayer2-core', '1.0.2'
#### 如需要真机 ＋ 虚拟机可以改用如下配置：
pod "qplayer2-core", :podspec => 'https://raw.githubusercontent.com/pili-engineering/QPlayer2-IOS/main/qplayer2-core-Universal.podspec'
### 3.关闭Bitcode
### 4.取消勾选 Metal 中 API Validation
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,477 |
基于 Core 的 QPlayer2 接入指南 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2
iOS端](https://developer.qiniu.com/pili/sdk/12225/qplayer2-ios-side) > 基于 Core
的 QPlayer2 接入指南
# 基于 Core 的 QPlayer2 接入指南
最近更新时间: 2022-09-27 16:38:38
如果业务场景中没有复杂的场景切换，也不想用播放面板定制、播放器上层浮窗定制、播放器上层手势逻辑则可以只用qplayer2-core，接入成本低，学习门槛低。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2
iOS端](https://developer.qiniu.com/pili/sdk/12225/qplayer2-ios-side) > 基于 Core
的 QPlayer2 接入指南
# 基于 Core 的 QPlayer2 接入指南
最近更新时间: 2022-09-27 16:38:38
如果业务场景中没有复杂的场景切换，也不想用播放面板定制、播放器上层浮窗定制、播放器上层手势逻辑则可以只用qplayer2-core，接入成本低，学习门槛低。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,480 |
快速开始 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2
iOS端](https://developer.qiniu.com/pili/sdk/12225/qplayer2-ios-side) > [基于 Core
的 QPlayer2 接入指南](https://developer.qiniu.com/pili/sdk/12227/based-on-
qplayer2-qplayer2-access-guide-to-the-core) > 快速开始
# 快速开始
最近更新时间: 2022-12-12 16:48:55
## 快速开始
### 基于 qplayer2-core 的播放器使用
#### 导入头文件
#import <qplayer2_core/qplayer2_core.h>
### 方法一：
#### 初始化
NSString *documentsDir = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) lastObject];
self.playerContext = [[QPlayerContext alloc]initPlayerAPPVersion:nil localStorageDir:documentsDir logLevel:LOG_VERBOSE];
#### 设置显示视图
_myRenderView = [[RenderView alloc]initWithFrame:CGRectMake(0, _topSpace, PLAYER_PORTRAIT_WIDTH, PLAYER_PORTRAIT_HEIGHT)];
[_myRenderView attachPlayerContext:self.playerContext];
[self.view addSubview:_myRenderView];
#### 播放
//参数为该视频师傅是直播，YES为是直播，NO为不是直播
QMediaModelBuilder *modleBuilder = [[QMediaModelBuilder alloc] initWithIsLive:NO];
[modleBuilder addStreamElementWithUserType:@"" //预留字段，可以为空
urlType:QURL_TYPE_QAUDIO_AND_VIDEO //资源的类型，这里的url对应的资源是音视频
url:@"http://demo-videos.qnsdk.com/qiniu-1080p.mp4" //播放地址
quality:1080 //清晰度数值标记为1080
isSelected:YES //是否是默认元素，默认元素是指，起播的时候默认会播放这个元素
backupUrl:@"" //备用地址
referer:@"" //http/https 协议的地址 支持该属性
renderType:QPLAYER_RENDER_TYPE_PLANE]; //视频类型
QMediaModel *model = [modleBuilder build];
[self.playerContext.controlHandler playMediaModel:model startPos:0];
#### 销毁
[self.playerContext.controlHandler playerRelease];
self.playerContext = nil;
### 方法二：
#### 初始化
NSString *documentsDir = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) lastObject];
self.playerContext = [[QPlayerView alloc]initWithFrame:CGRectMake(0, 100, 100, 100) APPVersion:@"" localStorageDir:documentsDir logLevel:LOG_VERBOSE];
[self.view addSubview:self.playerContext];
#### 播放
//参数为该视频师傅是直播，YES为是直播，NO为不是直播
QMediaModelBuilder *modleBuilder = [[QMediaModelBuilder alloc] initWithIsLive:NO];
[modleBuilder addStreamElementWithUserType:@"" //预留字段，可以为空
urlType:QURL_TYPE_QAUDIO_AND_VIDEO //资源的类型，这里的url对应的资源是音视频
url:@"http://demo-videos.qnsdk.com/qiniu-1080p.mp4" //播放地址
quality:1080 //清晰度数值标记为1080
isSelected:YES //是否是默认元素，默认元素是指，起播的时候默认会播放这个元素
backupUrl:@"" //备用地址
referer:@"" //http/https 协议的地址 支持该属性
renderType:QPLAYER_RENDER_TYPE_PLANE]; //视频类型
QMediaModel *model = [modleBuilder build];
[self.playerContext.controlHandler playMediaModel:model startPos:0];
#### 销毁
[self.playerContext.controlHandler playerRelease];
self.playerContext = nil;
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2
iOS端](https://developer.qiniu.com/pili/sdk/12225/qplayer2-ios-side) > [基于 Core
的 QPlayer2 接入指南](https://developer.qiniu.com/pili/sdk/12227/based-on-
qplayer2-qplayer2-access-guide-to-the-core) > 快速开始
# 快速开始
最近更新时间: 2022-12-12 16:48:55
## 快速开始
### 基于 qplayer2-core 的播放器使用
#### 导入头文件
#import <qplayer2_core/qplayer2_core.h>
### 方法一：
#### 初始化
NSString *documentsDir = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) lastObject];
self.playerContext = [[QPlayerContext alloc]initPlayerAPPVersion:nil localStorageDir:documentsDir logLevel:LOG_VERBOSE];
#### 设置显示视图
_myRenderView = [[RenderView alloc]initWithFrame:CGRectMake(0, _topSpace, PLAYER_PORTRAIT_WIDTH, PLAYER_PORTRAIT_HEIGHT)];
[_myRenderView attachPlayerContext:self.playerContext];
[self.view addSubview:_myRenderView];
#### 播放
//参数为该视频师傅是直播，YES为是直播，NO为不是直播
QMediaModelBuilder *modleBuilder = [[QMediaModelBuilder alloc] initWithIsLive:NO];
[modleBuilder addStreamElementWithUserType:@"" //预留字段，可以为空
urlType:QURL_TYPE_QAUDIO_AND_VIDEO //资源的类型，这里的url对应的资源是音视频
url:@"http://demo-videos.qnsdk.com/qiniu-1080p.mp4" //播放地址
quality:1080 //清晰度数值标记为1080
isSelected:YES //是否是默认元素，默认元素是指，起播的时候默认会播放这个元素
backupUrl:@"" //备用地址
referer:@"" //http/https 协议的地址 支持该属性
renderType:QPLAYER_RENDER_TYPE_PLANE]; //视频类型
QMediaModel *model = [modleBuilder build];
[self.playerContext.controlHandler playMediaModel:model startPos:0];
#### 销毁
[self.playerContext.controlHandler playerRelease];
self.playerContext = nil;
### 方法二：
#### 初始化
NSString *documentsDir = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) lastObject];
self.playerContext = [[QPlayerView alloc]initWithFrame:CGRectMake(0, 100, 100, 100) APPVersion:@"" localStorageDir:documentsDir logLevel:LOG_VERBOSE];
[self.view addSubview:self.playerContext];
#### 播放
//参数为该视频师傅是直播，YES为是直播，NO为不是直播
QMediaModelBuilder *modleBuilder = [[QMediaModelBuilder alloc] initWithIsLive:NO];
[modleBuilder addStreamElementWithUserType:@"" //预留字段，可以为空
urlType:QURL_TYPE_QAUDIO_AND_VIDEO //资源的类型，这里的url对应的资源是音视频
url:@"http://demo-videos.qnsdk.com/qiniu-1080p.mp4" //播放地址
quality:1080 //清晰度数值标记为1080
isSelected:YES //是否是默认元素，默认元素是指，起播的时候默认会播放这个元素
backupUrl:@"" //备用地址
referer:@"" //http/https 协议的地址 支持该属性
renderType:QPLAYER_RENDER_TYPE_PLANE]; //视频类型
QMediaModel *model = [modleBuilder build];
[self.playerContext.controlHandler playMediaModel:model startPos:0];
#### 销毁
[self.playerContext.controlHandler playerRelease];
self.playerContext = nil;
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,481 |
基础能力使用 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2
iOS端](https://developer.qiniu.com/pili/sdk/12225/qplayer2-ios-side) > [基于 Core
的 QPlayer2 接入指南](https://developer.qiniu.com/pili/sdk/12227/based-on-
qplayer2-qplayer2-access-guide-to-the-core) > 基础能力使用
# 基础能力使用
最近更新时间: 2024-05-28 10:49:55
在 [快速开始](https://developer.qiniu.com/pili/sdk/12222/qplayer2-core-basic-
ability-to-use) 中，我们完成了qplayer2播放器的创建\播放\销毁，本文介绍如何使用qplayer2的播放能力
# 播放
## 创建播放数据
QMediaModelBuilder *modleBuilder = [[QMediaModelBuilder alloc] initWithIsLive:NO];
[modleBuilder addStreamElementWithUserType:@"" //预留字段，可以为空
urlType:QURL_TYPE_QAUDIO_AND_VIDEO //资源的类型，这里的url对应的资源是音视频
url:@"http://demo-videos.qnsdk.com/qiniu-1080p.mp4" //播放地址
quality:1080 //清晰度数值标记为1080
isSelected:YES //是否是默认元素，默认元素是指，起播的时候默认会播放这个元素
backupUrl:@"" //备用地址
referer:@"" //http/https 协议的地址 支持该属性
renderType:QPLAYER_RENDER_TYPE_PLANE]; //视频类型
QMediaModel *model = [modleBuilder build];
addStreamElements 属性说明
属性名 | 属性说明
---|---
userType | 用户自定义Type，目前预留，可以填空字符串
url | 资源地址
urlType | 媒体的资源属性 只包含视频/只包含音频/同时有视频音频
quality | 清晰度
isSelected | 是否起播时播放该流
backupUrl | 备用地址
referer | http/https 协议的地址 支持该属性
renderType | 视频的渲染类型
hlsDrmKey | 私有DRM解密的key，用在私有hls加密视频播放的场景中
mp4DrmKey | mp4 drm 的解密 key 用于 CENC-AES-CTR 加密的视频播放场景中
mp4QNDrmComKey | mp4 七牛私有 drm 的解密 comkey 用于七牛私有 mp4 加密的视频播放场景中
mp4QNDrmFileKey | mp4 七牛私有 drm 的解密 filekey 用于七牛私有 mp4 加密的视频播放场景中
## MP4 加密
目前 QPlayer2 支持七牛私有加密以及显式的 CENC-AES-CTR 加密，暂不支持隐式加密。CENC-AES-CTR 的初始化向量(IV)
由加密工具随机生成并存储在加密后的 MP4 文件中，QPlayer2 读取 MP4 文件的 IV 和QmediaModel 存储的 mp4DrmKey
进行解密。
### 对 MP4 文件进行七牛私有加密方式播放
QMediaModelBuilder *modleBuilder = [[QMediaModelBuilder alloc] initWithIsLive:NO];
[modleBuilder addStreamElementWithUserType:@"" //预留字段，可以为空
urlType:QURL_TYPE_QAUDIO_AND_VIDEO //资源的类型，这里的url对应的资源是音视频
url:@"https://kodo.koafun.com/drm-16884581530881688458153078-new.mp4" //播放地址
quality:1080 //清晰度数值标记为1080
isSelected:YES //是否是默认元素，默认元素是指，起播的时候默认会播放这个元素
backupUrl:@"" //备用地址
referer:@"" //http/https 协议的地址 支持该属性
renderType:QPLAYER_RENDER_TYPE_PLANE //视频类型
mp4QNDrmComKey:@"comnew", //mp4QNDrmComKey 七牛私有解密使用的秘钥
mp4QNDrmFileKey:@"filenew"]; //mp4QNDrmFileKey 七牛私有解密使用的秘钥
QMediaModel *model = [modleBuilder build];
[self.playerContext.controlHandler playMediaModel:model startPos:0];
### 对 MP4 文件进行 CENC-AES-CTR 加密
可以选择 ffmpeg 对一个 MP4 进行加密。加密命令如下：
ffmpeg -i test2.mp4 -vcodec copy -acodec copy -encryption_scheme cenc-aes-ctr -encryption_key c7e16c4403654b85847037383f0c2db3 -encryption_kid a7e61c373e219033c21091fa607bf3b8 encrypted_IV_test.mp4
命令说明
test2.mp4 为输入文件
encrypted_IV_test.mp4 为输出文件
-vcodec copy 和 -acodec copy ：指定视频流和音频流的编码方式为原始流的拷贝，即不进行重新编码，保持与原始文件相同的编码格式。
-encryption_scheme cenc-aes-ctr ：设置加密方案为 CENC-AES-CTR，即采用 CTR 模式进行加密。
-encryption_key c7e16c4403654b85847037383f0c2db3 指定加密所使用的密钥，即解密所使用的 key。这里的c7e16c4403654b85847037383f0c2db3 是一个示例密钥，您可以替换为您自己的密钥，格式要求为：16字节的16进制数据。
-encryption_kid a7e61c373e219033c21091fa607bf3b8：指定加密所使用的密钥标识符（KID）。这里的 a7e61c373e219033c21091fa607bf3b8 是一个示例 KID，您可以替换为您自己的密钥标识符, 格式要求为：16字节的16进制数据。
加密后可通过ffplay 4.4 版本进行播放验证，播放正常即可。命令如下：
ffplay encrypted_IV_test.mp4 -decryption_key c7e16c4403654b85847037383f0c2db3
### QPlayer2 对加密后 MP4 文件进行播放
QMediaModelBuilder *modleBuilder = [[QMediaModelBuilder alloc] initWithIsLive:NO];
[modleBuilder addStreamElementWithUserType:@"" //预留字段，可以为空
urlType:QURL_TYPE_QAUDIO_AND_VIDEO //资源的类型，这里的url对应的资源是音视频
url:@"https://sdk-release.qnsdk.com/CENC_AES-CTR.mp4" //播放地址
quality:1080 //清晰度数值标记为1080
isSelected:YES //是否是默认元素，默认元素是指，起播的时候默认会播放这个元素
backupUrl:@"" //备用地址
referer:@"" //http/https 协议的地址 支持该属性
renderType:QPLAYER_RENDER_TYPE_PLANE //视频类型
mp4DrmKey:@"c7e16c4403654b85847037383f0c2db3"]; //mp4 解密使用的秘钥
QMediaModel *model = [modleBuilder build];
[self.playerContext.controlHandler playMediaModel:model startPos:0];
## 视频URL类型枚举
typedef NS_ENUM(NSInteger, QPlayerURLType){
QURL_TYPE_QAUDIO_AND_VIDEO = 0, //音频和视频
QURL_TYPE_QAUDIO, //仅音频
QURL_TYPE_QVIDEO, //仅视频
QURL_TYPE_NONE, //无
};
## 播放媒体资源
/*** 播放音视频资源
* @param pmediaModel 音视频资源
* @param startPos 起播时间戳 毫秒
*/
[self.playerContext.controlHandler playMediaModel:model startPos:0];
## 播放错误监听
添加监听前需要签订QIPlayerMediaNetworkListener协议。当视频起播时，如果遇到网络等问题原因，导致没有和服务器建立链接，那么会导致视频播放失败，总共会有3次重试机会，3次都失败的情况下会回调onOpenFailed方法。
当视频已经起播后，在中途遇到网络等问题原因，进入buffer,
那么内核会一直重试，直到再次连接上服务端继续播放，或者用户通过接口停止播放该视频，在重试的过程中 onReconnectStart /
onReconnectEnd
会被回调，那么可以监控回调的次数来做业务层的结束播放的策略，当然在正常播放的情况下，这两个方法也是会被回调的，所以最好结合buffer的回调数据一起使用。
/***
开始重连
@param context 当前的播放器
@param userType 重连url流的userType
@param urlType 重连url流的urlType
@param url 重连的url
@param retryTime 已重试的次数
*/
-(void)onReconnectStart:(QPlayerContext *)context userType:(NSString *)userType urlType:(QPlayerURLType)urlType url:(NSString *)url retryTime:(NSInteger)retryTime{
}
/***
重连结束
@param context 当前的播放器
@param userType 重连url流的userType
@param urlType 重连url流的urlType
@param url 重连的url
@param retryTime 已重试的次数
@param error 错误码
*/
-(void)onReconnectEnd:(QPlayerContext *)context userType:(NSString *)userType urlType:(QPlayerURLType)urlType url:(NSString *)url retryTime:(NSInteger)retryTime error:(QPlayerOpenError)error{
}
/***
打开失败
@param context 当前的播放器
@param userType 重连url流的userType
@param urlType 重连url流的urlType
@param url 重连的url
@param error 错误码
*/
-(void)onOpenFailed:(QPlayerContext *)context userType:(NSString *)userType urlType:(QPlayerURLType)urlType url:(NSString *)url error:(QPlayerOpenError)error{
}
//添加监听
[self.playerContext.controlHandler addPlayerMediaNetworkListener:self];
//移除监听
[self.playerContext.controlHandler removePlayerMediaNetworkListener:self];
//移除全部监听
[self.playerContext.controlHandler removeAllPlayerMediaNetworkListener];
## 播放错误码枚举
typedef NS_ENUM(NSInteger, QPlayerOpenError) {
QPLAYER_OPEN_ERROR_UNKOWN = 10000,
QPLAYER_OPEN_ERROR_NONE = 0,
QPLAYER_OPEN_ERROR_IOERROR = -5,
QPLAYER_OPEN_ERROR_INTERRUPT = -1414092869,
QPLAYER_OPEN_ERROR_URL_INVALID = -875574520,
QPLAYER_OPEN_ERROR_FORMAT_INVALID = -1094995529
};
## 暂停播放
[self.playerContext.controlHandler pauseRender];
## 恢复播放
[self.playerContext.controlHandler resumeRender];
## 停止当前视频播放
[self.playerContext.controlHandler stop];
# 鉴权
鉴权功能介绍见[鉴权相关文档 __](https://developer.qiniu.io/pili/12223/qplayer2-core-
authentication-related)
## 强制网络鉴权
调用该接口时，会强制进行网络鉴权
[self.playerContext.controlHandler forceAuthenticationFromNetwork];
## 鉴权监听
添加监听前需要签订QIPlayerAuthenticationListener协议。
/**
@brief 鉴权失败回调
@param context 当前播放器
@param error 失败错误码
*/
-(void)onAuthenticationFailed:(QPlayerContext*)context error:(QPlayerAuthenticationErrorType)error{
}
/**
@brief 鉴权成功回调
@param context 当前播放器
*/
@optional
-(void)onAuthenticationSuccess:(QPlayerContext*)context{
}
//添加监听
[self.playerContext.renderHandler addPlayerAuthenticationListener:self];
//移除监听
[self.playerContext.renderHandler removePlayerAuthenticationListener:self];
//移除所有监听
[self.playerContext.renderHandler removeAllPlayerAuthenticationListener];
## 鉴权错误码枚举
typedef NS_ENUM(NSInteger, QPlayerAuthenticationErrorType) {
QPLAYER_AUTHENTICATION_ERROR_TYPE_AET_NONE, //鉴权出错
QPLAYER_AUTHENTICATION_ERROR_TYPE_AET_NO_BASE_AUTH, //缺少基础功能权限
QPLAYER_AUTHENTICATION_ERROR_TYPE_AET_NO_VR_AUTH, //缺少VR功能权限
QPLAYER_AUTHENTICATION_ERROR_TYPE_AET_NO_BLIND_AUTH, //缺少色盲功能权限
QPLAYER_AUTHENTICATION_ERROR_TYPE_AET_NO_SEI_AUTH, //缺少SEI功能权限
QPLAYER_AUTHENTICATION_ERROR_TYPE_AET_NO_SRT_AUTH //缺少SRT功能权限
};
# 预加载
播放预加载实例用于点播（一般用在短视频场景中），不能用在直播上，播放预加载实例能提升首帧的速度。
预加载的加载时机策略由业务层自行实
## 预加载的简单使用
//创建预加载实例,一般是提前创建,model为预加载的资源，startPos为预加载开始时间
QMediaItemContext *item = [[QMediaItemContext alloc]initItemComtextWithMediaModel:model startPos:0 storageDir:documentsDir logLevel:LOG_VERBOSE];
//开始预加载
[item.controlHandler start];
//播放预加载资源
[self.playerContext.controlHandler playMediaItem:item];
//停止预加载实例
[item.controlHandler stop];
## 预加载实例状态枚举
typedef NS_ENUM(NSInteger, QMediaItemState) {
QMEDIAITEM_STATE_NONE = 100, //初始状态
QMEDIAITEM_STATE_PREPARE, //开始加载前，准备工作状态
QMEDIAITEM_STATE_LOADING, //开始加载
QMEDIAITEM_STATE_PAUSED, //暂停加载
QMEDIAITEM_STATE_STOPED, //停止加载, 无法恢复
QMEDIAITEM_STATE_ERROR, //加载出错
QMEDIAITEM_STATE_PREPARE_USE, //准备使用播放
QMEDIAITEM_STATE_USED, //已经使用
QMEDIAITEM_STATE_DISCARD, //废弃
};
## 预加载实例状态监听
/**
* 状态变更监听
* @param context 当前预加载上下文
* @param state 改变后的状态
*/
-(void)onStateChanged:(QMediaItemContext *)context state:(QMediaItemState)state{
}
//添加监听
[item.controlHandler addMediaItemStateChangeListener:self];
//移除监听
[item.controlHandler removeMediaItemStateChangeListener:self];
//移除所有监听
[item.controlHandler removeAllMediaItemStateChangeListener];
## 预加载状态异常的监听
/**
* 播放器操作（eg.playMediaModel/seek 等操作）由于状态问题导致的失败
* @param context 当前预加载上下文
* @param commandName 操作名称
* @param state 异常发生时的的状态
*/
-(void)onCommandNotAllow:(QMediaItemContext *)context commandName:(NSString *)commandName state:(QMediaItemState)state{
}
//添加监听
[item.controlHandler addMediaItemCommandNotAllowListener:self];
//移除监听
[item.controlHandler removeMediaItemCommandNotAllowListener:self];
//移除所有监听
[item.controlHandler removeAllMediaItemCommandNotAllowListener];
# 切换视频进度
参数为要定位的position 单位毫秒
[self.playerContext.controlHandler seek:2000];
# 视频解码方式
目前支持的解码方式有:软解、硬解、自动，一般情况下，使用自动，内核会根据手机的硬件情况，要播放的视频资源编码格式等信息，挑选合适的解码方式进行解码，各个解码方式的优劣情况如下
软解: 解码较慢，但是兼容性好，适用于所有手机
硬解：解码性能高，但是有一定兼容性，比如某些视频资源的编码格式，硬解芯片不支持。并且相对于软解，首帧的速度慢。
## 设置优先选择哪种解码方式
设置完成后下一次播放生效.
最终的解码方式可能不是设置的，在设置的解码方式不能正确解码时，内核会进行降级，选择其他能正确解码的方式
[self.playerContext.controlHandler setDecoderType: QPLAYER_DECODER_SETTING_AUTO];
## 优先选择的解码方式枚举
该枚举主要用于设置解码方式
typedef NS_ENUM(NSInteger, QPlayerDecoder) {
QPLAYER_DECODER_SETTING_AUTO = 0, //自动选择
QPLAYER_DECODER_SETTING_HARDWARE_PRIORITY, //硬解优先
QPLAYER_DECODER_SETTING_SOFT_PRIORITY, //软解优先
};
## 播放器视频解码监听相关
添加监听前需要签订QIPlayerVideoDecodeListener协议。
/**
当前视频用的是哪种解码方式
@param context 当前的播放器
@param type 解码方式
*/
-(void)onVideoDecodeByType:(QPlayerContext *)context Type:(QPlayerDecoderType)type{
}
/**
* 通知当前视频解码失败，
* @param retry 底层是重试
*/
-(void) onDecodeFailed:(QPlayerContext *)context retry:(BOOL)retry{
}
/**
如果当前视频编码 所在设备或者sdk不支持 则回调该方法
@param context 当前的播放器
@param codecId 视频的编码id
*/
-(void)notSupportCodecFormat:(QPlayerContext *)context codec:(NSInteger)codecId{
}
//添加监听
[self.playerContext.controlHandler addPlayerVideoDecodeTypeListener:self];
//移除监听
[self.playerContext.controlHandler removePlayeVideoDecodeTypeListener:self];
//移除所有监听
[self.playerContext.controlHandler removeAllPlayerVideoDecodeTypeListener];
## 解码方式枚举
该枚举主要用于监听返回的解码方式
typedef NS_ENUM(NSInteger, QPlayerDecoderType) {
QPLAYER_DECODER_TYPE_NONE = 0, //无
QPLAYER_DECODER_TYPE_SOFTWARE, //软解
QPLAYER_DECODER_TYPE_HARDWARE, //硬解
};
# 设置起播方式
下一次播放生效
[self.playerContext.controlHandler setStartAction:QPLAYER_START_SETTING_PLAYING];
## 起播方式枚举
typedef NS_ENUM(NSInteger, QPlayerStart){
QPLAYER_START_SETTING_PLAYING = 0, //起播播放
QPLAYER_START_SETTING_PAUSE, //起播暂停在首帧
};
# 设置 seek 方式
下一次播放生效
[self.playerContext.controlHandler setSeekMode:QPLAYER_SEEK_SETTING_NORMAL];
## seek方式枚举
typedef NS_ENUM(NSInteger, QPlayerSeek) {
QPLAYER_SEEK_SETTING_NORMAL = 0, //关键帧seek，每次seek 都seek到离目标位置向前的最近的一个关键帧，耗时少
QPLAYER_SEEK_SETTING_ACCURATE, //精准seek，耗时比关键帧seek多，且耗时和视频的gop间隔的大小成正比
};
## seek 状态监听
一般情况下
seek都会成功，如果网络差的情况下，会无限loading（除非调用stop才会停止），直到seek到指定的位置为止。但是如果视频源本身是格式不正确的，比如pts错乱等问题，才会导致seek失败，所以在seek失败回调中，做好提示工作就好，不要尝试再次seek
/**
seek成功回调
@param context 当前的播放器
*/
-(void)onSeekSuccess:(QPlayerContext *)context{
}
/**
seek失败回调
@param context 当前的播放器
*/
-(void)onSeekFailed:(QPlayerContext *)context{
}
//添加监听
[self.playerContext.controlHandler addPlayerSeekListener:self];
//移除监听
[self.playerContext.controlHandler removePlayerSeekListener:self];
//移除所有监听
[self.playerContext.controlHandler removeAllPlayerSeekListener];
# 获取当前播放状态
self.playerContext.controlHandler.currentPlayerState
# 获取视频时长
self.playerContext.controlHandler.duration
# 获取当前进度
self.playerContext.controlHandler.currentPosition
# 获取当前下载速度
self.playerContext.controlHandler.downloadSpeed
# 获取当前缓冲进度
self.playerContext.controlHandler.bufferPostion
# 播放器状态
在整个播放器实例生命周期中，播放会在不同的状态中切换，用户可以通过监听播放器状态，实现上层业务逻辑，
比如在视频播放完时，展示其他视频的推荐页，那么只需监听播放器状态回调，待回调的状态是COMPLETED，则展示推荐页
## 播放器状态枚举
typedef NS_ENUM(NSInteger, QPlayerState){
QPLAYER_STATE_NONE = 0, //初始状态
QPLAYER_STATE_INIT = 1, //播放器开始创建各种对象 没有对应的state 创建完对象就上报这个状态
QPLAYER_STATE_PREPARE = 2, //开始拉视频数据解码变换等，重新换地址后，都走这个状态
QPLAYER_STATE_PLAYING = 4, //播放中
QPLAYER_STATE_PAUSED_RENDER = 6, //用户暂停
QPLAYER_STATE_COMPLETED = 7, //播放完成
QPLAYER_STATE_SEEKING = 8, //SEEK
QPLAYER_STATE_STOPPED = 9, //停止当前播放的视频
QPLAYER_STATE_ERROR = 10, //播放出错（是否需要分 可恢复 和 不可恢复 ）
QPLAYER_STATE_END = 11, //播放器释放各种对象完成
QPLAYER_STATE_MEDIA_ITEM_PREPARE = 12, //开始拉视频数据解码变换等，重新换地址后，都走这个状态 针对Media Item的play 方式
QPLAYER_STATE_RELEASE = 13, //播放器结束，且释放各类资源
};
## 播放器状态变更监听相关
添加监听前需要签订QIPlayerStateChangeListener协议。
/**
状态变更回调
@param context 当前的播放器
@param state 播放器状态
*/
-(void)onStateChange:(QPlayerContext *)context state:(QPlayerState)state{
}
//添加监听
[self.playerContext.controlHandler addPlayerStateListener:self];
//移除监听
[self.playerContext.controlHandler removePlayerStateListener:self];
//移除所有监听
[self.playerContext.controlHandler removeAllPlayerStateListener];
# 日志等级
设置日志等级，日志等级越高，输出的日志内容越全面
## 设置日志等级
[self.mPlayerView.controlHandler setLogLevel:LOG_INFO];
## 日志等级枚举
typedef NS_ENUM(NSInteger, QLogLevel){
LOG_QUIT = 0,
LOG_ERROR = 1,
LOG_WARNING = 2,
LOG_DEBUG = 3,
LOG_INFO = 4,
LOG_VERBOSE = 5
};
# 播放速度
播放速度的调整范围建议在0.25-2.0之间，这样会有一个比较好的效果
## 设置播放速度
参数为倍速值
[self.playerContext.controlHandler setSpeed:1.0];
## 获取当前播放速度
self.playerContext.controlHandler.playerSpeed
## 速度变更监听相关
添加监听前需要签订QIPlayerSpeedListener协议。
/**
倍速改变回调
@param context 当前的播放器
@param speed 改变后的倍速
*/
-(void)onSpeedChanged:(QPlayerContext *)context speed:(float)speed{
}
//添加监听
[self.playerContext.controlHandler addPlayerSpeedChangeListener:self];
//移除监听
[self.playerContext.controlHandler removePlayeSpeedChangeListener:self];
//移除所有监听
[self.playerContext.controlHandler removeAllPlayerSpeedChangeListener];
# 清晰度
QPlayer2提供的清晰度能力是无缝切换清晰度方案，在切换过程中，画面是连续的画面，不会出现类似跳帧的情况。
使用无缝切换清晰度功能，必须在mediaModel中配置多路清晰度，如果使用非immediately方式(即异步方式)时，同时只能有一次切换会话存在，会话结束后，才能切下一次
## 切换视频清晰度
//使用该方法时，mediaModel中需要存在多个StreamElement
/**
切换清晰度
@param userType 切换清晰度的url流的userType
@param urlType 切换清晰度的url流的 urlType
@param quality 要切到哪路清晰度
@param immediately true 立即切换 用于直播流，false 无缝切换，切换过程是一个异步过程，用于点播流
@return true 调用成功， false 调用失败
*/
[self.playerContext.controlHandler switchQuality:"" urlType:QURL_TYPE_QAUDIO_AND_VIDEO quality:1080 immediately:false];
## 获取当前的清晰度
//使用该方法时，mediaModel中需要存在多个StreamElement，返回清晰度数值标记
/**
获取指定 userType urlType 的清晰度
@param userType 切换清晰度的url流的userType
@param urlType 切换清晰度的url流的 urlType
@return true 调用成功， false 调用失败
*/
[self.playerContext.controlHandler getCurrentQuality:@"" urlType: QURL_TYPE_QAUDIO_AND_VIDEO ];
## 获取当前正在切换的清晰度
/**
获取指定 userType urlType 流正在切换的清晰度（非immediately方式）
@param userType 切换清晰度的url流的userType
@param urlType 切换清晰度的url流的 urlType
@return true 调用成功， false 调用失败
*/
[self.playerContext.controlHandler getSwitchingQuality:@"" urlType: QURL_TYPE_QAUDIO_AND_VIDEO ];
## 播放器清晰度相关监听
添加监听前需要签订QIPlayerQualityListener协议。
/**
开始清晰度切换
@param context 当前的播放器
@param userType 开始切换清晰度的url流的userType
@param urlType 开始切换清晰度的url流的
@param oldQuality 切换前的清晰度
@param newQuality 要切到哪路清晰度
*/
-(void)onQualitySwitchStart:(QPlayerContext *)context usertype:(NSString *)usertype urlType:(QPlayerURLType)urlType oldQuality:(NSInteger)oldQuality newQuality:(NSInteger)newQuality{
}
/**
清晰度切换完成
@param context 当前的播放器
@param userType 开始切换清晰度的url流的userType
@param urlType 开始切换清晰度的url流的
@param oldQuality 切换前的清晰度
@param newQuality 要切到哪路清晰度
*/
-(void)onQualitySwitchComplete:(QPlayerContext *)context usertype:(NSString *)usertype urlType:(QPlayerURLType)urlType oldQuality:(NSInteger)oldQuality newQuality:(NSInteger)newQuality{
}
/**
清晰度切换取消
@param context 当前的播放器
@param userType 开始切换清晰度的url流的userType
@param urlType 开始切换清晰度的url流的
@param oldQuality 切换前的清晰度
@param newQuality 要切到哪路清晰度
*/
-(void)onQualitySwitchCanceled:(QPlayerContext *)context usertype:(NSString *)usertype urlType:(QPlayerURLType)urlType oldQuality:(NSInteger)oldQuality newQuality:(NSInteger)newQuality{
}
/**
清晰度切换失败
@param context 当前的播放器
@param userType 开始切换清晰度的url流的userType
@param urlType 开始切换清晰度的url流的
@param oldQuality 切换前的清晰度
@param newQuality 要切到哪路清晰度
*/
-(void)onQualitySwitchFailed:(QPlayerContext *)context usertype:(NSString *)usertype urlType:(QPlayerURLType)urlType oldQuality:(NSInteger)oldQuality newQuality:(NSInteger)newQuality{
}
/**
目前仅支持同时有一个清晰度切换，如果前一个还未切换完，再次发起切换 会回调这个函数
@param context 当前的播放器
@param userType 开始切换清晰度的url流的userType
@param urlType 开始切换清晰度的url流的
@param newQuality 要切到哪路清晰度
*/
-(void)onQualitySwitchRetryLater:(QPlayerContext *)context usertype:(NSString *)usertype urlType:(QPlayerURLType)urlType{
}
//添加监听
[self.playerContext.controlHandler addPlayerQualityListener:self];
//移除监听
[self.playerContext.controlHandler removePlayerQualityListener:self];
//移除所有监听
[self.playerContext.controlHandler removeAllPlayerQualityListener];
## 直播支持多路清晰度切换
无缝切换清晰度方案需要配置以下三个条件
1. 首先切换的模式要选择立即切换即：immediately=true
2. 服务端配置PTS透传，
3. 对应的清晰度要做主动转码设置
如果无法满足以上3个条件，那么建议用最基础的能力来实现清晰度切换，即每个清晰度都是一个media
model，切换时，调用playMediaModel来播放新的清晰度流。
# 视频宽高改变监听
在视频首帧渲染时，会调用该回调，告诉上层当前的视频宽高是多少，如果在这个这个视频播放的生命周期中，宽高改变，那么还会再次调用该回调.
添加监听前需要签订QIPlayerVideoFrameSizeChangeListener协议。
/**
推流端视频长宽变化回调
@param context 当前的播放器
@param width 视频宽度
@param height 视频高度
*/
-(void)onVideoFrameSizeChanged:(QPlayerContext *)context width:(int)width height:(int)height{
}
//添加监听
[self.playerContext.controlHandler addPlayerVideoFrameSizeChangeListener:self];
//移除监听
[self.playerContext.controlHandler removePlayerVideoFrameSizeChangeListener:self];
//移除所有监听
[self.playerContext.controlHandler removeAllPlayerVideoFrameSizeChangeListener];
# 播放进度监听
添加监听前需要签订QIPlayerProgressListener协议。
只有在点播的时候 duration 和 progress 才有意义，直播的话这两个值没有参考意义
/***
进度变更回调
@param context 当前的播放器
@param progress 当前进度 单位毫秒
@param duration 当前视频总时长 单位毫秒
*/
-(void)onProgressChanged:(QPlayerContext *)context progress:(NSInteger)progress duration:(NSInteger)duration{
}
//添加监听
[self.playerContext.controlHandler addPlayerProgressChangeListener:self];
//移除监听
[self.playerContext.controlHandler removePlayerProgressChangeListener:self];
//移除所有监听
[self.playerContext.controlHandler removeAllPlayerProgressChangeListener];
# 实时帧率
## 获取当前fps
self.playerContext.controlHandler.fps
## 实时帧率监听
添加监听前需要签订QIPlayerFPSListener协议。
/**
@brief fps 改变的回调
@param context 当前的播放器
@param fps 帧率
*/
-(void)onFPSChanged:(QPlayerContext *)context FPS:(NSInteger)fps{
}
//添加监听
[self.playerContext.controlHandler addPlayerFPSChangeListener:self];
//移除监听
[self.playerContext.controlHandler removePlayerFPSChangeListener:self];
//移除所有监听
[self.playerContext.controlHandler removeAllPlayerFPSChangeListener];
# 像素格式或者音频sample格式不支持的监听
添加监听前需要签订QIPlayerFormatListener协议。
/**
@brief 当前有format 不支持，所以视频没法播放
@param context 当前的播放器
*/
-(void)onFormatNotSupport:(QPlayerContext*)context{
}
//添加监听
[self.playerContext.controlHandler addPlayerFormatListener:self];
//移除监听
[self.playerContext.controlHandler removePlayerFormatListener:self];
//移除所有监听
[self.playerContext.controlHandler removeAllPlayerFormatListener];
# 缓冲拉流监听
添加监听前需要签订QIPlayerDownloadListener协议。
/**
@brief 拉流速率改变
@param context 当前的播放器
@param downloadSpeed 速度 单位: b/s (比特每秒)
@param bufferPos 缓冲的进度
*/
-(void)onDownloadChanged:(QPlayerContext *)context speed:(NSInteger)downloadSpeed bufferPos:(NSInteger)bufferPos{
}
//添加监听
[self.playerContext.controlHandler addPlayerDownloadChangeListener:self];
//移除监听
[self.playerContext.controlHandler removePlayerDownloadChangeListener:self];
//移除所有监听
[self.playerContext.controlHandler removeAllPlayerDownloadChangeListener];
# 播放器操作不允许执行监听
添加监听前需要签订QIPlayerCommandNotAllowListener协议。在某些状态下，一些操作将不被执行，通过该监听回调上来通知
/**
@brief 操作不被允许回调
@param context 操作异常的播放器
@param commandName 操作名称
@param state 操作被检测时播放器的状态
*/
-(void)onCommandNotAllow:(QPlayerContext *)context commandName:(NSString *)commandName state:(QPlayerState) state{
}
//添加监听
[self.playerContext.controlHandler addPlayerCommandNotAllowListener:self];
//移除监听
[self.playerContext.controlHandler removePlayerCommandNotAllowListener:self];
//移除所有监听
[self.playerContext.controlHandler removeAllPlayerCommandNotAllowListener];
# buffering 监听
添加监听前需要签订QIPlayerBufferingListener协议。
/**
@brief 开始buffering
@param context 当前播放器
*/
-(void)onBufferingStart:(QPlayerContext *)context{
}
/**
@brief 结束buffering
@param context 当前播放器
*/
-(void)onBufferingEnd:(QPlayerContext *)context{
}
//添加监听
[self.playerContext.controlHandler addPlayerBufferingChangeListener:self];
//移除监听
[self.playerContext.controlHandler removePlayerBufferingChangeListener:self];
//移除所有监听
[self.playerContext.controlHandler removeAllPlayerBufferingChangeListener];
# 静音播放
控制播放器静音，且该静音非系统的声音设置，仅仅只是把播放器设置为静音
## 获取是否静音播放状态
self.playerContext.controlHandler.isMute;
## 设置静音播放
/**
* 设置静音状态
* @param isMute true 静音播放 false 非静音播放。默认为非静音播放
*/
[self.player.controlHandler setMute:YES];
## 静音播放相关监听
添加监听前需要签订QIPlayerAudioListener协议。
/**
静音播放状态发生变化
@param context 当前的播放器
@param isMute 是否静音播放
*/
-(void)onMuteChanged:(QPlayerContext *)context isMute:(BOOL)isMute{
}
//添加监听
[self.playerContext.controlHandler addPlayerAudioListener:self];
//移除监听
[self.playerContext.controlHandler removePlayerAudioListener:self];
//移除所有监听
[self.playerContext.controlHandler removeAllPlayerAudioListener];
# 截图
调用截图接口，就会回调截图时的video画面，并以jpeg的格式返回
/**
截图
*/
[self.playerContext.controlHandler shootVideo];
## 截图图片类型枚举
typedef NS_ENUM(NSInteger, QPlayerShootVideoType) {
QPLAYER_SHOOT_VIDEO_NONE = 0,
QPLAYER_SHOOT_VIDEO_JPEG //jpeg格式
};
## 截图相关监听
添加监听前需要签订QIPlayerShootVideoListener协议。
/**
截图成功回调
@param context 当前的播放器
@param imageData 图片的 NSData 数据
@param width 图片的宽
@param height 图片的高
@param type 图片类型
*/
-(void)onShootSuccessful:(QPlayerContext *)context imageData:(NSData *)imageData width:(int)width height:(int)height type:(QPlayerShootVideoType)type{
}
/**
截图失败回调
@param context 当前的播放器
*/
-(void)onShootFailed:(QPlayerContext *)context{
}
//添加监听
[self.playerContext.controlHandler addPlayerShootVideoListener:self];
//移除监听
[self.playerContext.controlHandler removePlayerShootVideoListener:self];
//移除所有监听
[self.playerContext.controlHandler removeAllPlayerShootVideoListener];
# 码率
## 获取当前码率
self.playerContext.controlHandler.biteRate
## 实时码率监听
添加监听前需要签订QIPlayerBiteRateListener协议。
/**
@brief 码率变换回调
@param context 当前播放器
@param bitrate 比特率， 单位：bps
*/
-(void)onBiteRateChanged:(QPlayerContext *)context bitrate:(NSInteger)bitrate{
}
//添加监听
[self.playerContext.controlHandler addPlayerBiteRateChangeListener:self];
//移除监听
[self.playerContext.controlHandler removePlayerBiteRateChangeListener:self];
//移除所有监听
[self.playerContext.controlHandler removeAllPlayerBiteRateChangeListener];
# SEI 数据回调
用户自定义数据可以带在H264或者H265的编码帧里，用于实现一些基于时间轴的业务场景。
开启该功能后，如果视频资源内带有SEI数据 会通过监听接口抛给业务层。
该功能需要单独开通，具体可以联系技术支持咨询。
## 开启 SEI
[self.playerContext.controlHandler setSEIEnable:YES];
## SEI 数据监听
添加监听前需要签订QIPlayerSEIDataListener协议。
/**
SEI 数据回调，且回调时机为SEI数据所在帧的时间
@param context 当前的播放器
@param data SEI 数据
*/
-(void)onSEIData:(QPlayerContext *)context data:(NSData *)data{
}
//添加监听
[self.playerContext.controlHandler addPlayerSEIDataListener:self];
//移除监听
[self.playerContext.controlHandler removePlayerSEIDataListener:self];
//移除所有监听
[self.playerContext.controlHandler removeAllPlayerSEIDataListener];
# 视频数据上抛相关监听
添加监听前需要签订QIPlayerVideoDataListener协议。
/**
视频数据回调
@param context 当前的播放器
@param sampleRate 采样率
@param format
@param channelNum 通道数
@param channelLayout
@param context 音频数据
*/
-(void)onVideoData:(QPlayerContext *)context width:(int)width height:(int)height videoType:(QVideoType)videoType buffer:(NSData *)buffer{
}
//添加监听
[self.playerContext.controlHandler addPlayerVideoDataListener:self];
//移除监听
[self.playerContext.controlHandler removePlayerVideoDataListener:self];
//移除所有监听
[self.playerContext.controlHandler removeAllPlayerVideooDataListener];
# 音频数据上抛相关监听
添加监听前实现接口 QIPlayerAudioDataListener
/**
音频数据回调
@param context 当前的播放器
@param sampleRate 采样率
@param format
@param channelNum 通道数
@param channelLayout
@param context 音频数据
*/
-(void)onAudioData:(QPlayerContext *)context sampleRate:(int)sampleRate format:(QSampleFormat)format channelNum:(int)channelNum channelLayout:(QChannelLayout)channelLayout data:(NSData *)data{
}
//添加监听
[self.playerContext.controlHandler addPlayerAudioDataListener:self];
//移除监听
[self.playerContext.controlHandler removePlayerAudioDataListener:self];
//移除所有监听
[self.playerContext.controlHandler removeAllPlayerAudioDataListener];
# 渲染相关监听
添加监听前需要签订QIPlayerRenderListener协议。
/**
首帧耗时回调
@param context 当前的播放器
@param elapsedTime 从play 开始到首帧渲染出来的总耗时 单位毫秒
*/
-(void)onFirstFrameRendered:(QPlayerContext *)context elapsedTime:(NSInteger)elapsedTime{
}
//添加监听
[self.playerContext.renderHandler addPlayerRenderListener:self];
//移除监听
[self.playerContext.renderHandler removePlayerRenderListener:self];
//移除所有监听
[self.playerContext.renderHandler removeAllPlayerRenderListener];
# 设置视频渲染比例
[self.playerContext.renderHandler setRenderRatio:QPLAYER_RATIO_SETTING_AUTO];
## 视频比例枚举
typedef NS_ENUM(NSInteger, QPlayerRenderRatio) {
QPLAYER_RATIO_SETTING_AUTO = 1, //自动
QPLAYER_RATIO_SETTING_STRETCH, //拉伸
QPLAYER_RATIO_SETTING_FULL_SCREEN, //铺满
QPLAYER_RATIO_SETTING_16_9, //16:9
QPLAYER_RATIO_SETTING_4_3, //4:3
};
# 设置色觉优化
[self.playerContext.renderHandler setBlindType:QPLAYER_BLIND_SETTING_NONE];
## 色觉优化枚举
typedef NS_ENUM(NSInteger, QPlayerBlind) {
QPLAYER_BLIND_SETTING_NONE=0, //无
QPLAYER_BLIND_SETTING_RED, //红色盲
QPLAYER_BLIND_SETTING_GREEN, //绿色盲
QPLAYER_BLIND_SETTING_BLUE, //蓝色盲
};
# VR视频播放
在播放VR视频时，需要在mediaModel中配置vr视频的资源
并且将streamElement的QPlayerRenderType设置为QPLAYER_RENDER_TYPE_PANORAMA_EQUIRECT_ANGULAR
然后通过设置vr视频视角改变视频朝向
该功能需要单独开通，具体可以联系技术支持咨询。
/***
* 设置VR视频的旋转角度
* @param rotateX 横向角度 （360度制）
* @param rotateY 纵向角度 （360度制）
* @return true 设置成功 false 设置失败
*/
[self.playerContext.renderHandler setPanoramaViewRotate:rotateX rotateY:rotateY];
## 视频类型枚举
typedef NS_ENUM(NSInteger, QPlayerRenderType){
QPLAYER_RENDER_TYPE_PLANE = 0, //普通视频
QPLAYER_RENDER_TYPE_PANORAMA_EQUIRECT_ANGULAR = 1, //ANGULAR类 VR视频
};
# 后台播放
## 设置是否支持后台播放
/**
*设置是否后台播放
* @param enable yes后台播放，no后台播放暂停
*/
[self.playerContext.controlHandler setBackgroundPlayEnable:YES];
## 获取当前是否支持后台播放
/**
获取当前是否支持后台播放
@return true: 支持后台播放 false: 支持后台播放
*/
[self.playerContext.controlHandler getBackgroundPlayEnable];
# 字幕
## 字幕数据设置
[modelBuilder addSubtitleElement:subDic[@"name"] url:subDic[@"url"] isDefault:[subDic[@"isSelected"]intValue]==0?NO:YES];
QMediaModel *model = [modleBuilder build];
## 设置是否开启字幕
/**
*设置是否开启字幕
* @param enable yes开启，no关闭
*/
[self.playerContext.controlHandler setSubtitleEnable:YES];
## 设置字幕名称
/**
*设置字幕
* @param name 设置为名称为 name 的字幕。
*/
[self.playerContext.controlHandler setSubtitle:@"中文"];
## 字幕监听
添加监听前需要签订QIPlayerSubtitleListener协议。
/**
字幕文本更改监听
@param context 当前的播放器
@param text 字幕文本
*/
-(void)onSubtitleTextChange:(QPlayerContext *)context text:(NSString*)text;
/**
字幕名称更改监听
@param context 当前的播放器
@param name 字幕名称 key
*/
-(void)onSubtitleNameChange:(QPlayerContext *)context name:(NSString *)name;
/**
字幕状态监听
@param context 当前的播放器
@param enable yes当前字幕状态关开启，no当前字幕状态关闭
*/
-(void)onSubtitleEnable:(QPlayerContext *)context enable:(BOOL)enable;
/**
字幕加载状态监听
@param context 当前的播放器
@param name 字幕名称
@param result yes 加载成功，no 加载失败
*/
-(void)onSubtitleLoaded:(QPlayerContext *)context name:(NSString*)name result:(BOOL)result;
/**
字幕解码状态监听
@param context 当前的播放器
@param name 字幕名称
@param result yes 加载成功，no 加载失败
*/
-(void)onSubtitleDecoded:(QPlayerContext *)context name:(NSString*)name result:(BOOL)result;
//添加监听
[self.playerContext.controlHandler addPlayerSubtitleListener:self];
//移除监听
[self.playerContext.controlHandler removePlayerSubtitleListener:self];
//移除所有监听
[self.playerContext.controlHandler removeAllPlayerSubtitleListener];
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2
iOS端](https://developer.qiniu.com/pili/sdk/12225/qplayer2-ios-side) > [基于 Core
的 QPlayer2 接入指南](https://developer.qiniu.com/pili/sdk/12227/based-on-
qplayer2-qplayer2-access-guide-to-the-core) > 基础能力使用
# 基础能力使用
最近更新时间: 2024-05-28 10:49:55
在 [快速开始](https://developer.qiniu.com/pili/sdk/12222/qplayer2-core-basic-
ability-to-use) 中，我们完成了qplayer2播放器的创建\播放\销毁，本文介绍如何使用qplayer2的播放能力
# 播放
## 创建播放数据
QMediaModelBuilder *modleBuilder = [[QMediaModelBuilder alloc] initWithIsLive:NO];
[modleBuilder addStreamElementWithUserType:@"" //预留字段，可以为空
urlType:QURL_TYPE_QAUDIO_AND_VIDEO //资源的类型，这里的url对应的资源是音视频
url:@"http://demo-videos.qnsdk.com/qiniu-1080p.mp4" //播放地址
quality:1080 //清晰度数值标记为1080
isSelected:YES //是否是默认元素，默认元素是指，起播的时候默认会播放这个元素
backupUrl:@"" //备用地址
referer:@"" //http/https 协议的地址 支持该属性
renderType:QPLAYER_RENDER_TYPE_PLANE]; //视频类型
QMediaModel *model = [modleBuilder build];
addStreamElements 属性说明
属性名 | 属性说明
---|---
userType | 用户自定义Type，目前预留，可以填空字符串
url | 资源地址
urlType | 媒体的资源属性 只包含视频/只包含音频/同时有视频音频
quality | 清晰度
isSelected | 是否起播时播放该流
backupUrl | 备用地址
referer | http/https 协议的地址 支持该属性
renderType | 视频的渲染类型
hlsDrmKey | 私有DRM解密的key，用在私有hls加密视频播放的场景中
mp4DrmKey | mp4 drm 的解密 key 用于 CENC-AES-CTR 加密的视频播放场景中
mp4QNDrmComKey | mp4 七牛私有 drm 的解密 comkey 用于七牛私有 mp4 加密的视频播放场景中
mp4QNDrmFileKey | mp4 七牛私有 drm 的解密 filekey 用于七牛私有 mp4 加密的视频播放场景中
## MP4 加密
目前 QPlayer2 支持七牛私有加密以及显式的 CENC-AES-CTR 加密，暂不支持隐式加密。CENC-AES-CTR 的初始化向量(IV)
由加密工具随机生成并存储在加密后的 MP4 文件中，QPlayer2 读取 MP4 文件的 IV 和QmediaModel 存储的 mp4DrmKey
进行解密。
### 对 MP4 文件进行七牛私有加密方式播放
QMediaModelBuilder *modleBuilder = [[QMediaModelBuilder alloc] initWithIsLive:NO];
[modleBuilder addStreamElementWithUserType:@"" //预留字段，可以为空
urlType:QURL_TYPE_QAUDIO_AND_VIDEO //资源的类型，这里的url对应的资源是音视频
url:@"https://kodo.koafun.com/drm-16884581530881688458153078-new.mp4" //播放地址
quality:1080 //清晰度数值标记为1080
isSelected:YES //是否是默认元素，默认元素是指，起播的时候默认会播放这个元素
backupUrl:@"" //备用地址
referer:@"" //http/https 协议的地址 支持该属性
renderType:QPLAYER_RENDER_TYPE_PLANE //视频类型
mp4QNDrmComKey:@"comnew", //mp4QNDrmComKey 七牛私有解密使用的秘钥
mp4QNDrmFileKey:@"filenew"]; //mp4QNDrmFileKey 七牛私有解密使用的秘钥
QMediaModel *model = [modleBuilder build];
[self.playerContext.controlHandler playMediaModel:model startPos:0];
### 对 MP4 文件进行 CENC-AES-CTR 加密
可以选择 ffmpeg 对一个 MP4 进行加密。加密命令如下：
ffmpeg -i test2.mp4 -vcodec copy -acodec copy -encryption_scheme cenc-aes-ctr -encryption_key c7e16c4403654b85847037383f0c2db3 -encryption_kid a7e61c373e219033c21091fa607bf3b8 encrypted_IV_test.mp4
命令说明
test2.mp4 为输入文件
encrypted_IV_test.mp4 为输出文件
-vcodec copy 和 -acodec copy ：指定视频流和音频流的编码方式为原始流的拷贝，即不进行重新编码，保持与原始文件相同的编码格式。
-encryption_scheme cenc-aes-ctr ：设置加密方案为 CENC-AES-CTR，即采用 CTR 模式进行加密。
-encryption_key c7e16c4403654b85847037383f0c2db3 指定加密所使用的密钥，即解密所使用的 key。这里的c7e16c4403654b85847037383f0c2db3 是一个示例密钥，您可以替换为您自己的密钥，格式要求为：16字节的16进制数据。
-encryption_kid a7e61c373e219033c21091fa607bf3b8：指定加密所使用的密钥标识符（KID）。这里的 a7e61c373e219033c21091fa607bf3b8 是一个示例 KID，您可以替换为您自己的密钥标识符, 格式要求为：16字节的16进制数据。
加密后可通过ffplay 4.4 版本进行播放验证，播放正常即可。命令如下：
ffplay encrypted_IV_test.mp4 -decryption_key c7e16c4403654b85847037383f0c2db3
### QPlayer2 对加密后 MP4 文件进行播放
QMediaModelBuilder *modleBuilder = [[QMediaModelBuilder alloc] initWithIsLive:NO];
[modleBuilder addStreamElementWithUserType:@"" //预留字段，可以为空
urlType:QURL_TYPE_QAUDIO_AND_VIDEO //资源的类型，这里的url对应的资源是音视频
url:@"https://sdk-release.qnsdk.com/CENC_AES-CTR.mp4" //播放地址
quality:1080 //清晰度数值标记为1080
isSelected:YES //是否是默认元素，默认元素是指，起播的时候默认会播放这个元素
backupUrl:@"" //备用地址
referer:@"" //http/https 协议的地址 支持该属性
renderType:QPLAYER_RENDER_TYPE_PLANE //视频类型
mp4DrmKey:@"c7e16c4403654b85847037383f0c2db3"]; //mp4 解密使用的秘钥
QMediaModel *model = [modleBuilder build];
[self.playerContext.controlHandler playMediaModel:model startPos:0];
## 视频URL类型枚举
typedef NS_ENUM(NSInteger, QPlayerURLType){
QURL_TYPE_QAUDIO_AND_VIDEO = 0, //音频和视频
QURL_TYPE_QAUDIO, //仅音频
QURL_TYPE_QVIDEO, //仅视频
QURL_TYPE_NONE, //无
};
## 播放媒体资源
/*** 播放音视频资源
* @param pmediaModel 音视频资源
* @param startPos 起播时间戳 毫秒
*/
[self.playerContext.controlHandler playMediaModel:model startPos:0];
## 播放错误监听
添加监听前需要签订QIPlayerMediaNetworkListener协议。当视频起播时，如果遇到网络等问题原因，导致没有和服务器建立链接，那么会导致视频播放失败，总共会有3次重试机会，3次都失败的情况下会回调onOpenFailed方法。
当视频已经起播后，在中途遇到网络等问题原因，进入buffer,
那么内核会一直重试，直到再次连接上服务端继续播放，或者用户通过接口停止播放该视频，在重试的过程中 onReconnectStart /
onReconnectEnd
会被回调，那么可以监控回调的次数来做业务层的结束播放的策略，当然在正常播放的情况下，这两个方法也是会被回调的，所以最好结合buffer的回调数据一起使用。
/***
开始重连
@param context 当前的播放器
@param userType 重连url流的userType
@param urlType 重连url流的urlType
@param url 重连的url
@param retryTime 已重试的次数
*/
-(void)onReconnectStart:(QPlayerContext *)context userType:(NSString *)userType urlType:(QPlayerURLType)urlType url:(NSString *)url retryTime:(NSInteger)retryTime{
}
/***
重连结束
@param context 当前的播放器
@param userType 重连url流的userType
@param urlType 重连url流的urlType
@param url 重连的url
@param retryTime 已重试的次数
@param error 错误码
*/
-(void)onReconnectEnd:(QPlayerContext *)context userType:(NSString *)userType urlType:(QPlayerURLType)urlType url:(NSString *)url retryTime:(NSInteger)retryTime error:(QPlayerOpenError)error{
}
/***
打开失败
@param context 当前的播放器
@param userType 重连url流的userType
@param urlType 重连url流的urlType
@param url 重连的url
@param error 错误码
*/
-(void)onOpenFailed:(QPlayerContext *)context userType:(NSString *)userType urlType:(QPlayerURLType)urlType url:(NSString *)url error:(QPlayerOpenError)error{
}
//添加监听
[self.playerContext.controlHandler addPlayerMediaNetworkListener:self];
//移除监听
[self.playerContext.controlHandler removePlayerMediaNetworkListener:self];
//移除全部监听
[self.playerContext.controlHandler removeAllPlayerMediaNetworkListener];
## 播放错误码枚举
typedef NS_ENUM(NSInteger, QPlayerOpenError) {
QPLAYER_OPEN_ERROR_UNKOWN = 10000,
QPLAYER_OPEN_ERROR_NONE = 0,
QPLAYER_OPEN_ERROR_IOERROR = -5,
QPLAYER_OPEN_ERROR_INTERRUPT = -1414092869,
QPLAYER_OPEN_ERROR_URL_INVALID = -875574520,
QPLAYER_OPEN_ERROR_FORMAT_INVALID = -1094995529
};
## 暂停播放
[self.playerContext.controlHandler pauseRender];
## 恢复播放
[self.playerContext.controlHandler resumeRender];
## 停止当前视频播放
[self.playerContext.controlHandler stop];
# 鉴权
鉴权功能介绍见[鉴权相关文档 __](https://developer.qiniu.io/pili/12223/qplayer2-core-
authentication-related)
## 强制网络鉴权
调用该接口时，会强制进行网络鉴权
[self.playerContext.controlHandler forceAuthenticationFromNetwork];
## 鉴权监听
添加监听前需要签订QIPlayerAuthenticationListener协议。
/**
@brief 鉴权失败回调
@param context 当前播放器
@param error 失败错误码
*/
-(void)onAuthenticationFailed:(QPlayerContext*)context error:(QPlayerAuthenticationErrorType)error{
}
/**
@brief 鉴权成功回调
@param context 当前播放器
*/
@optional
-(void)onAuthenticationSuccess:(QPlayerContext*)context{
}
//添加监听
[self.playerContext.renderHandler addPlayerAuthenticationListener:self];
//移除监听
[self.playerContext.renderHandler removePlayerAuthenticationListener:self];
//移除所有监听
[self.playerContext.renderHandler removeAllPlayerAuthenticationListener];
## 鉴权错误码枚举
typedef NS_ENUM(NSInteger, QPlayerAuthenticationErrorType) {
QPLAYER_AUTHENTICATION_ERROR_TYPE_AET_NONE, //鉴权出错
QPLAYER_AUTHENTICATION_ERROR_TYPE_AET_NO_BASE_AUTH, //缺少基础功能权限
QPLAYER_AUTHENTICATION_ERROR_TYPE_AET_NO_VR_AUTH, //缺少VR功能权限
QPLAYER_AUTHENTICATION_ERROR_TYPE_AET_NO_BLIND_AUTH, //缺少色盲功能权限
QPLAYER_AUTHENTICATION_ERROR_TYPE_AET_NO_SEI_AUTH, //缺少SEI功能权限
QPLAYER_AUTHENTICATION_ERROR_TYPE_AET_NO_SRT_AUTH //缺少SRT功能权限
};
# 预加载
播放预加载实例用于点播（一般用在短视频场景中），不能用在直播上，播放预加载实例能提升首帧的速度。
预加载的加载时机策略由业务层自行实
## 预加载的简单使用
//创建预加载实例,一般是提前创建,model为预加载的资源，startPos为预加载开始时间
QMediaItemContext *item = [[QMediaItemContext alloc]initItemComtextWithMediaModel:model startPos:0 storageDir:documentsDir logLevel:LOG_VERBOSE];
//开始预加载
[item.controlHandler start];
//播放预加载资源
[self.playerContext.controlHandler playMediaItem:item];
//停止预加载实例
[item.controlHandler stop];
## 预加载实例状态枚举
typedef NS_ENUM(NSInteger, QMediaItemState) {
QMEDIAITEM_STATE_NONE = 100, //初始状态
QMEDIAITEM_STATE_PREPARE, //开始加载前，准备工作状态
QMEDIAITEM_STATE_LOADING, //开始加载
QMEDIAITEM_STATE_PAUSED, //暂停加载
QMEDIAITEM_STATE_STOPED, //停止加载, 无法恢复
QMEDIAITEM_STATE_ERROR, //加载出错
QMEDIAITEM_STATE_PREPARE_USE, //准备使用播放
QMEDIAITEM_STATE_USED, //已经使用
QMEDIAITEM_STATE_DISCARD, //废弃
};
## 预加载实例状态监听
/**
* 状态变更监听
* @param context 当前预加载上下文
* @param state 改变后的状态
*/
-(void)onStateChanged:(QMediaItemContext *)context state:(QMediaItemState)state{
}
//添加监听
[item.controlHandler addMediaItemStateChangeListener:self];
//移除监听
[item.controlHandler removeMediaItemStateChangeListener:self];
//移除所有监听
[item.controlHandler removeAllMediaItemStateChangeListener];
## 预加载状态异常的监听
/**
* 播放器操作（eg.playMediaModel/seek 等操作）由于状态问题导致的失败
* @param context 当前预加载上下文
* @param commandName 操作名称
* @param state 异常发生时的的状态
*/
-(void)onCommandNotAllow:(QMediaItemContext *)context commandName:(NSString *)commandName state:(QMediaItemState)state{
}
//添加监听
[item.controlHandler addMediaItemCommandNotAllowListener:self];
//移除监听
[item.controlHandler removeMediaItemCommandNotAllowListener:self];
//移除所有监听
[item.controlHandler removeAllMediaItemCommandNotAllowListener];
# 切换视频进度
参数为要定位的position 单位毫秒
[self.playerContext.controlHandler seek:2000];
# 视频解码方式
目前支持的解码方式有:软解、硬解、自动，一般情况下，使用自动，内核会根据手机的硬件情况，要播放的视频资源编码格式等信息，挑选合适的解码方式进行解码，各个解码方式的优劣情况如下
软解: 解码较慢，但是兼容性好，适用于所有手机
硬解：解码性能高，但是有一定兼容性，比如某些视频资源的编码格式，硬解芯片不支持。并且相对于软解，首帧的速度慢。
## 设置优先选择哪种解码方式
设置完成后下一次播放生效.
最终的解码方式可能不是设置的，在设置的解码方式不能正确解码时，内核会进行降级，选择其他能正确解码的方式
[self.playerContext.controlHandler setDecoderType: QPLAYER_DECODER_SETTING_AUTO];
## 优先选择的解码方式枚举
该枚举主要用于设置解码方式
typedef NS_ENUM(NSInteger, QPlayerDecoder) {
QPLAYER_DECODER_SETTING_AUTO = 0, //自动选择
QPLAYER_DECODER_SETTING_HARDWARE_PRIORITY, //硬解优先
QPLAYER_DECODER_SETTING_SOFT_PRIORITY, //软解优先
};
## 播放器视频解码监听相关
添加监听前需要签订QIPlayerVideoDecodeListener协议。
/**
当前视频用的是哪种解码方式
@param context 当前的播放器
@param type 解码方式
*/
-(void)onVideoDecodeByType:(QPlayerContext *)context Type:(QPlayerDecoderType)type{
}
/**
* 通知当前视频解码失败，
* @param retry 底层是重试
*/
-(void) onDecodeFailed:(QPlayerContext *)context retry:(BOOL)retry{
}
/**
如果当前视频编码 所在设备或者sdk不支持 则回调该方法
@param context 当前的播放器
@param codecId 视频的编码id
*/
-(void)notSupportCodecFormat:(QPlayerContext *)context codec:(NSInteger)codecId{
}
//添加监听
[self.playerContext.controlHandler addPlayerVideoDecodeTypeListener:self];
//移除监听
[self.playerContext.controlHandler removePlayeVideoDecodeTypeListener:self];
//移除所有监听
[self.playerContext.controlHandler removeAllPlayerVideoDecodeTypeListener];
## 解码方式枚举
该枚举主要用于监听返回的解码方式
typedef NS_ENUM(NSInteger, QPlayerDecoderType) {
QPLAYER_DECODER_TYPE_NONE = 0, //无
QPLAYER_DECODER_TYPE_SOFTWARE, //软解
QPLAYER_DECODER_TYPE_HARDWARE, //硬解
};
# 设置起播方式
下一次播放生效
[self.playerContext.controlHandler setStartAction:QPLAYER_START_SETTING_PLAYING];
## 起播方式枚举
typedef NS_ENUM(NSInteger, QPlayerStart){
QPLAYER_START_SETTING_PLAYING = 0, //起播播放
QPLAYER_START_SETTING_PAUSE, //起播暂停在首帧
};
# 设置 seek 方式
下一次播放生效
[self.playerContext.controlHandler setSeekMode:QPLAYER_SEEK_SETTING_NORMAL];
## seek方式枚举
typedef NS_ENUM(NSInteger, QPlayerSeek) {
QPLAYER_SEEK_SETTING_NORMAL = 0, //关键帧seek，每次seek 都seek到离目标位置向前的最近的一个关键帧，耗时少
QPLAYER_SEEK_SETTING_ACCURATE, //精准seek，耗时比关键帧seek多，且耗时和视频的gop间隔的大小成正比
};
## seek 状态监听
一般情况下
seek都会成功，如果网络差的情况下，会无限loading（除非调用stop才会停止），直到seek到指定的位置为止。但是如果视频源本身是格式不正确的，比如pts错乱等问题，才会导致seek失败，所以在seek失败回调中，做好提示工作就好，不要尝试再次seek
/**
seek成功回调
@param context 当前的播放器
*/
-(void)onSeekSuccess:(QPlayerContext *)context{
}
/**
seek失败回调
@param context 当前的播放器
*/
-(void)onSeekFailed:(QPlayerContext *)context{
}
//添加监听
[self.playerContext.controlHandler addPlayerSeekListener:self];
//移除监听
[self.playerContext.controlHandler removePlayerSeekListener:self];
//移除所有监听
[self.playerContext.controlHandler removeAllPlayerSeekListener];
# 获取当前播放状态
self.playerContext.controlHandler.currentPlayerState
# 获取视频时长
self.playerContext.controlHandler.duration
# 获取当前进度
self.playerContext.controlHandler.currentPosition
# 获取当前下载速度
self.playerContext.controlHandler.downloadSpeed
# 获取当前缓冲进度
self.playerContext.controlHandler.bufferPostion
# 播放器状态
在整个播放器实例生命周期中，播放会在不同的状态中切换，用户可以通过监听播放器状态，实现上层业务逻辑，
比如在视频播放完时，展示其他视频的推荐页，那么只需监听播放器状态回调，待回调的状态是COMPLETED，则展示推荐页
## 播放器状态枚举
typedef NS_ENUM(NSInteger, QPlayerState){
QPLAYER_STATE_NONE = 0, //初始状态
QPLAYER_STATE_INIT = 1, //播放器开始创建各种对象 没有对应的state 创建完对象就上报这个状态
QPLAYER_STATE_PREPARE = 2, //开始拉视频数据解码变换等，重新换地址后，都走这个状态
QPLAYER_STATE_PLAYING = 4, //播放中
QPLAYER_STATE_PAUSED_RENDER = 6, //用户暂停
QPLAYER_STATE_COMPLETED = 7, //播放完成
QPLAYER_STATE_SEEKING = 8, //SEEK
QPLAYER_STATE_STOPPED = 9, //停止当前播放的视频
QPLAYER_STATE_ERROR = 10, //播放出错（是否需要分 可恢复 和 不可恢复 ）
QPLAYER_STATE_END = 11, //播放器释放各种对象完成
QPLAYER_STATE_MEDIA_ITEM_PREPARE = 12, //开始拉视频数据解码变换等，重新换地址后，都走这个状态 针对Media Item的play 方式
QPLAYER_STATE_RELEASE = 13, //播放器结束，且释放各类资源
};
## 播放器状态变更监听相关
添加监听前需要签订QIPlayerStateChangeListener协议。
/**
状态变更回调
@param context 当前的播放器
@param state 播放器状态
*/
-(void)onStateChange:(QPlayerContext *)context state:(QPlayerState)state{
}
//添加监听
[self.playerContext.controlHandler addPlayerStateListener:self];
//移除监听
[self.playerContext.controlHandler removePlayerStateListener:self];
//移除所有监听
[self.playerContext.controlHandler removeAllPlayerStateListener];
# 日志等级
设置日志等级，日志等级越高，输出的日志内容越全面
## 设置日志等级
[self.mPlayerView.controlHandler setLogLevel:LOG_INFO];
## 日志等级枚举
typedef NS_ENUM(NSInteger, QLogLevel){
LOG_QUIT = 0,
LOG_ERROR = 1,
LOG_WARNING = 2,
LOG_DEBUG = 3,
LOG_INFO = 4,
LOG_VERBOSE = 5
};
# 播放速度
播放速度的调整范围建议在0.25-2.0之间，这样会有一个比较好的效果
## 设置播放速度
参数为倍速值
[self.playerContext.controlHandler setSpeed:1.0];
## 获取当前播放速度
self.playerContext.controlHandler.playerSpeed
## 速度变更监听相关
添加监听前需要签订QIPlayerSpeedListener协议。
/**
倍速改变回调
@param context 当前的播放器
@param speed 改变后的倍速
*/
-(void)onSpeedChanged:(QPlayerContext *)context speed:(float)speed{
}
//添加监听
[self.playerContext.controlHandler addPlayerSpeedChangeListener:self];
//移除监听
[self.playerContext.controlHandler removePlayeSpeedChangeListener:self];
//移除所有监听
[self.playerContext.controlHandler removeAllPlayerSpeedChangeListener];
# 清晰度
QPlayer2提供的清晰度能力是无缝切换清晰度方案，在切换过程中，画面是连续的画面，不会出现类似跳帧的情况。
使用无缝切换清晰度功能，必须在mediaModel中配置多路清晰度，如果使用非immediately方式(即异步方式)时，同时只能有一次切换会话存在，会话结束后，才能切下一次
## 切换视频清晰度
//使用该方法时，mediaModel中需要存在多个StreamElement
/**
切换清晰度
@param userType 切换清晰度的url流的userType
@param urlType 切换清晰度的url流的 urlType
@param quality 要切到哪路清晰度
@param immediately true 立即切换 用于直播流，false 无缝切换，切换过程是一个异步过程，用于点播流
@return true 调用成功， false 调用失败
*/
[self.playerContext.controlHandler switchQuality:"" urlType:QURL_TYPE_QAUDIO_AND_VIDEO quality:1080 immediately:false];
## 获取当前的清晰度
//使用该方法时，mediaModel中需要存在多个StreamElement，返回清晰度数值标记
/**
获取指定 userType urlType 的清晰度
@param userType 切换清晰度的url流的userType
@param urlType 切换清晰度的url流的 urlType
@return true 调用成功， false 调用失败
*/
[self.playerContext.controlHandler getCurrentQuality:@"" urlType: QURL_TYPE_QAUDIO_AND_VIDEO ];
## 获取当前正在切换的清晰度
/**
获取指定 userType urlType 流正在切换的清晰度（非immediately方式）
@param userType 切换清晰度的url流的userType
@param urlType 切换清晰度的url流的 urlType
@return true 调用成功， false 调用失败
*/
[self.playerContext.controlHandler getSwitchingQuality:@"" urlType: QURL_TYPE_QAUDIO_AND_VIDEO ];
## 播放器清晰度相关监听
添加监听前需要签订QIPlayerQualityListener协议。
/**
开始清晰度切换
@param context 当前的播放器
@param userType 开始切换清晰度的url流的userType
@param urlType 开始切换清晰度的url流的
@param oldQuality 切换前的清晰度
@param newQuality 要切到哪路清晰度
*/
-(void)onQualitySwitchStart:(QPlayerContext *)context usertype:(NSString *)usertype urlType:(QPlayerURLType)urlType oldQuality:(NSInteger)oldQuality newQuality:(NSInteger)newQuality{
}
/**
清晰度切换完成
@param context 当前的播放器
@param userType 开始切换清晰度的url流的userType
@param urlType 开始切换清晰度的url流的
@param oldQuality 切换前的清晰度
@param newQuality 要切到哪路清晰度
*/
-(void)onQualitySwitchComplete:(QPlayerContext *)context usertype:(NSString *)usertype urlType:(QPlayerURLType)urlType oldQuality:(NSInteger)oldQuality newQuality:(NSInteger)newQuality{
}
/**
清晰度切换取消
@param context 当前的播放器
@param userType 开始切换清晰度的url流的userType
@param urlType 开始切换清晰度的url流的
@param oldQuality 切换前的清晰度
@param newQuality 要切到哪路清晰度
*/
-(void)onQualitySwitchCanceled:(QPlayerContext *)context usertype:(NSString *)usertype urlType:(QPlayerURLType)urlType oldQuality:(NSInteger)oldQuality newQuality:(NSInteger)newQuality{
}
/**
清晰度切换失败
@param context 当前的播放器
@param userType 开始切换清晰度的url流的userType
@param urlType 开始切换清晰度的url流的
@param oldQuality 切换前的清晰度
@param newQuality 要切到哪路清晰度
*/
-(void)onQualitySwitchFailed:(QPlayerContext *)context usertype:(NSString *)usertype urlType:(QPlayerURLType)urlType oldQuality:(NSInteger)oldQuality newQuality:(NSInteger)newQuality{
}
/**
目前仅支持同时有一个清晰度切换，如果前一个还未切换完，再次发起切换 会回调这个函数
@param context 当前的播放器
@param userType 开始切换清晰度的url流的userType
@param urlType 开始切换清晰度的url流的
@param newQuality 要切到哪路清晰度
*/
-(void)onQualitySwitchRetryLater:(QPlayerContext *)context usertype:(NSString *)usertype urlType:(QPlayerURLType)urlType{
}
//添加监听
[self.playerContext.controlHandler addPlayerQualityListener:self];
//移除监听
[self.playerContext.controlHandler removePlayerQualityListener:self];
//移除所有监听
[self.playerContext.controlHandler removeAllPlayerQualityListener];
## 直播支持多路清晰度切换
无缝切换清晰度方案需要配置以下三个条件
1. 首先切换的模式要选择立即切换即：immediately=true
2. 服务端配置PTS透传，
3. 对应的清晰度要做主动转码设置
如果无法满足以上3个条件，那么建议用最基础的能力来实现清晰度切换，即每个清晰度都是一个media
model，切换时，调用playMediaModel来播放新的清晰度流。
# 视频宽高改变监听
在视频首帧渲染时，会调用该回调，告诉上层当前的视频宽高是多少，如果在这个这个视频播放的生命周期中，宽高改变，那么还会再次调用该回调.
添加监听前需要签订QIPlayerVideoFrameSizeChangeListener协议。
/**
推流端视频长宽变化回调
@param context 当前的播放器
@param width 视频宽度
@param height 视频高度
*/
-(void)onVideoFrameSizeChanged:(QPlayerContext *)context width:(int)width height:(int)height{
}
//添加监听
[self.playerContext.controlHandler addPlayerVideoFrameSizeChangeListener:self];
//移除监听
[self.playerContext.controlHandler removePlayerVideoFrameSizeChangeListener:self];
//移除所有监听
[self.playerContext.controlHandler removeAllPlayerVideoFrameSizeChangeListener];
# 播放进度监听
添加监听前需要签订QIPlayerProgressListener协议。
只有在点播的时候 duration 和 progress 才有意义，直播的话这两个值没有参考意义
/***
进度变更回调
@param context 当前的播放器
@param progress 当前进度 单位毫秒
@param duration 当前视频总时长 单位毫秒
*/
-(void)onProgressChanged:(QPlayerContext *)context progress:(NSInteger)progress duration:(NSInteger)duration{
}
//添加监听
[self.playerContext.controlHandler addPlayerProgressChangeListener:self];
//移除监听
[self.playerContext.controlHandler removePlayerProgressChangeListener:self];
//移除所有监听
[self.playerContext.controlHandler removeAllPlayerProgressChangeListener];
# 实时帧率
## 获取当前fps
self.playerContext.controlHandler.fps
## 实时帧率监听
添加监听前需要签订QIPlayerFPSListener协议。
/**
@brief fps 改变的回调
@param context 当前的播放器
@param fps 帧率
*/
-(void)onFPSChanged:(QPlayerContext *)context FPS:(NSInteger)fps{
}
//添加监听
[self.playerContext.controlHandler addPlayerFPSChangeListener:self];
//移除监听
[self.playerContext.controlHandler removePlayerFPSChangeListener:self];
//移除所有监听
[self.playerContext.controlHandler removeAllPlayerFPSChangeListener];
# 像素格式或者音频sample格式不支持的监听
添加监听前需要签订QIPlayerFormatListener协议。
/**
@brief 当前有format 不支持，所以视频没法播放
@param context 当前的播放器
*/
-(void)onFormatNotSupport:(QPlayerContext*)context{
}
//添加监听
[self.playerContext.controlHandler addPlayerFormatListener:self];
//移除监听
[self.playerContext.controlHandler removePlayerFormatListener:self];
//移除所有监听
[self.playerContext.controlHandler removeAllPlayerFormatListener];
# 缓冲拉流监听
添加监听前需要签订QIPlayerDownloadListener协议。
/**
@brief 拉流速率改变
@param context 当前的播放器
@param downloadSpeed 速度 单位: b/s (比特每秒)
@param bufferPos 缓冲的进度
*/
-(void)onDownloadChanged:(QPlayerContext *)context speed:(NSInteger)downloadSpeed bufferPos:(NSInteger)bufferPos{
}
//添加监听
[self.playerContext.controlHandler addPlayerDownloadChangeListener:self];
//移除监听
[self.playerContext.controlHandler removePlayerDownloadChangeListener:self];
//移除所有监听
[self.playerContext.controlHandler removeAllPlayerDownloadChangeListener];
# 播放器操作不允许执行监听
添加监听前需要签订QIPlayerCommandNotAllowListener协议。在某些状态下，一些操作将不被执行，通过该监听回调上来通知
/**
@brief 操作不被允许回调
@param context 操作异常的播放器
@param commandName 操作名称
@param state 操作被检测时播放器的状态
*/
-(void)onCommandNotAllow:(QPlayerContext *)context commandName:(NSString *)commandName state:(QPlayerState) state{
}
//添加监听
[self.playerContext.controlHandler addPlayerCommandNotAllowListener:self];
//移除监听
[self.playerContext.controlHandler removePlayerCommandNotAllowListener:self];
//移除所有监听
[self.playerContext.controlHandler removeAllPlayerCommandNotAllowListener];
# buffering 监听
添加监听前需要签订QIPlayerBufferingListener协议。
/**
@brief 开始buffering
@param context 当前播放器
*/
-(void)onBufferingStart:(QPlayerContext *)context{
}
/**
@brief 结束buffering
@param context 当前播放器
*/
-(void)onBufferingEnd:(QPlayerContext *)context{
}
//添加监听
[self.playerContext.controlHandler addPlayerBufferingChangeListener:self];
//移除监听
[self.playerContext.controlHandler removePlayerBufferingChangeListener:self];
//移除所有监听
[self.playerContext.controlHandler removeAllPlayerBufferingChangeListener];
# 静音播放
控制播放器静音，且该静音非系统的声音设置，仅仅只是把播放器设置为静音
## 获取是否静音播放状态
self.playerContext.controlHandler.isMute;
## 设置静音播放
/**
* 设置静音状态
* @param isMute true 静音播放 false 非静音播放。默认为非静音播放
*/
[self.player.controlHandler setMute:YES];
## 静音播放相关监听
添加监听前需要签订QIPlayerAudioListener协议。
/**
静音播放状态发生变化
@param context 当前的播放器
@param isMute 是否静音播放
*/
-(void)onMuteChanged:(QPlayerContext *)context isMute:(BOOL)isMute{
}
//添加监听
[self.playerContext.controlHandler addPlayerAudioListener:self];
//移除监听
[self.playerContext.controlHandler removePlayerAudioListener:self];
//移除所有监听
[self.playerContext.controlHandler removeAllPlayerAudioListener];
# 截图
调用截图接口，就会回调截图时的video画面，并以jpeg的格式返回
/**
截图
*/
[self.playerContext.controlHandler shootVideo];
## 截图图片类型枚举
typedef NS_ENUM(NSInteger, QPlayerShootVideoType) {
QPLAYER_SHOOT_VIDEO_NONE = 0,
QPLAYER_SHOOT_VIDEO_JPEG //jpeg格式
};
## 截图相关监听
添加监听前需要签订QIPlayerShootVideoListener协议。
/**
截图成功回调
@param context 当前的播放器
@param imageData 图片的 NSData 数据
@param width 图片的宽
@param height 图片的高
@param type 图片类型
*/
-(void)onShootSuccessful:(QPlayerContext *)context imageData:(NSData *)imageData width:(int)width height:(int)height type:(QPlayerShootVideoType)type{
}
/**
截图失败回调
@param context 当前的播放器
*/
-(void)onShootFailed:(QPlayerContext *)context{
}
//添加监听
[self.playerContext.controlHandler addPlayerShootVideoListener:self];
//移除监听
[self.playerContext.controlHandler removePlayerShootVideoListener:self];
//移除所有监听
[self.playerContext.controlHandler removeAllPlayerShootVideoListener];
# 码率
## 获取当前码率
self.playerContext.controlHandler.biteRate
## 实时码率监听
添加监听前需要签订QIPlayerBiteRateListener协议。
/**
@brief 码率变换回调
@param context 当前播放器
@param bitrate 比特率， 单位：bps
*/
-(void)onBiteRateChanged:(QPlayerContext *)context bitrate:(NSInteger)bitrate{
}
//添加监听
[self.playerContext.controlHandler addPlayerBiteRateChangeListener:self];
//移除监听
[self.playerContext.controlHandler removePlayerBiteRateChangeListener:self];
//移除所有监听
[self.playerContext.controlHandler removeAllPlayerBiteRateChangeListener];
# SEI 数据回调
用户自定义数据可以带在H264或者H265的编码帧里，用于实现一些基于时间轴的业务场景。
开启该功能后，如果视频资源内带有SEI数据 会通过监听接口抛给业务层。
该功能需要单独开通，具体可以联系技术支持咨询。
## 开启 SEI
[self.playerContext.controlHandler setSEIEnable:YES];
## SEI 数据监听
添加监听前需要签订QIPlayerSEIDataListener协议。
/**
SEI 数据回调，且回调时机为SEI数据所在帧的时间
@param context 当前的播放器
@param data SEI 数据
*/
-(void)onSEIData:(QPlayerContext *)context data:(NSData *)data{
}
//添加监听
[self.playerContext.controlHandler addPlayerSEIDataListener:self];
//移除监听
[self.playerContext.controlHandler removePlayerSEIDataListener:self];
//移除所有监听
[self.playerContext.controlHandler removeAllPlayerSEIDataListener];
# 视频数据上抛相关监听
添加监听前需要签订QIPlayerVideoDataListener协议。
/**
视频数据回调
@param context 当前的播放器
@param sampleRate 采样率
@param format
@param channelNum 通道数
@param channelLayout
@param context 音频数据
*/
-(void)onVideoData:(QPlayerContext *)context width:(int)width height:(int)height videoType:(QVideoType)videoType buffer:(NSData *)buffer{
}
//添加监听
[self.playerContext.controlHandler addPlayerVideoDataListener:self];
//移除监听
[self.playerContext.controlHandler removePlayerVideoDataListener:self];
//移除所有监听
[self.playerContext.controlHandler removeAllPlayerVideooDataListener];
# 音频数据上抛相关监听
添加监听前实现接口 QIPlayerAudioDataListener
/**
音频数据回调
@param context 当前的播放器
@param sampleRate 采样率
@param format
@param channelNum 通道数
@param channelLayout
@param context 音频数据
*/
-(void)onAudioData:(QPlayerContext *)context sampleRate:(int)sampleRate format:(QSampleFormat)format channelNum:(int)channelNum channelLayout:(QChannelLayout)channelLayout data:(NSData *)data{
}
//添加监听
[self.playerContext.controlHandler addPlayerAudioDataListener:self];
//移除监听
[self.playerContext.controlHandler removePlayerAudioDataListener:self];
//移除所有监听
[self.playerContext.controlHandler removeAllPlayerAudioDataListener];
# 渲染相关监听
添加监听前需要签订QIPlayerRenderListener协议。
/**
首帧耗时回调
@param context 当前的播放器
@param elapsedTime 从play 开始到首帧渲染出来的总耗时 单位毫秒
*/
-(void)onFirstFrameRendered:(QPlayerContext *)context elapsedTime:(NSInteger)elapsedTime{
}
//添加监听
[self.playerContext.renderHandler addPlayerRenderListener:self];
//移除监听
[self.playerContext.renderHandler removePlayerRenderListener:self];
//移除所有监听
[self.playerContext.renderHandler removeAllPlayerRenderListener];
# 设置视频渲染比例
[self.playerContext.renderHandler setRenderRatio:QPLAYER_RATIO_SETTING_AUTO];
## 视频比例枚举
typedef NS_ENUM(NSInteger, QPlayerRenderRatio) {
QPLAYER_RATIO_SETTING_AUTO = 1, //自动
QPLAYER_RATIO_SETTING_STRETCH, //拉伸
QPLAYER_RATIO_SETTING_FULL_SCREEN, //铺满
QPLAYER_RATIO_SETTING_16_9, //16:9
QPLAYER_RATIO_SETTING_4_3, //4:3
};
# 设置色觉优化
[self.playerContext.renderHandler setBlindType:QPLAYER_BLIND_SETTING_NONE];
## 色觉优化枚举
typedef NS_ENUM(NSInteger, QPlayerBlind) {
QPLAYER_BLIND_SETTING_NONE=0, //无
QPLAYER_BLIND_SETTING_RED, //红色盲
QPLAYER_BLIND_SETTING_GREEN, //绿色盲
QPLAYER_BLIND_SETTING_BLUE, //蓝色盲
};
# VR视频播放
在播放VR视频时，需要在mediaModel中配置vr视频的资源
并且将streamElement的QPlayerRenderType设置为QPLAYER_RENDER_TYPE_PANORAMA_EQUIRECT_ANGULAR
然后通过设置vr视频视角改变视频朝向
该功能需要单独开通，具体可以联系技术支持咨询。
/***
* 设置VR视频的旋转角度
* @param rotateX 横向角度 （360度制）
* @param rotateY 纵向角度 （360度制）
* @return true 设置成功 false 设置失败
*/
[self.playerContext.renderHandler setPanoramaViewRotate:rotateX rotateY:rotateY];
## 视频类型枚举
typedef NS_ENUM(NSInteger, QPlayerRenderType){
QPLAYER_RENDER_TYPE_PLANE = 0, //普通视频
QPLAYER_RENDER_TYPE_PANORAMA_EQUIRECT_ANGULAR = 1, //ANGULAR类 VR视频
};
# 后台播放
## 设置是否支持后台播放
/**
*设置是否后台播放
* @param enable yes后台播放，no后台播放暂停
*/
[self.playerContext.controlHandler setBackgroundPlayEnable:YES];
## 获取当前是否支持后台播放
/**
获取当前是否支持后台播放
@return true: 支持后台播放 false: 支持后台播放
*/
[self.playerContext.controlHandler getBackgroundPlayEnable];
# 字幕
## 字幕数据设置
[modelBuilder addSubtitleElement:subDic[@"name"] url:subDic[@"url"] isDefault:[subDic[@"isSelected"]intValue]==0?NO:YES];
QMediaModel *model = [modleBuilder build];
## 设置是否开启字幕
/**
*设置是否开启字幕
* @param enable yes开启，no关闭
*/
[self.playerContext.controlHandler setSubtitleEnable:YES];
## 设置字幕名称
/**
*设置字幕
* @param name 设置为名称为 name 的字幕。
*/
[self.playerContext.controlHandler setSubtitle:@"中文"];
## 字幕监听
添加监听前需要签订QIPlayerSubtitleListener协议。
/**
字幕文本更改监听
@param context 当前的播放器
@param text 字幕文本
*/
-(void)onSubtitleTextChange:(QPlayerContext *)context text:(NSString*)text;
/**
字幕名称更改监听
@param context 当前的播放器
@param name 字幕名称 key
*/
-(void)onSubtitleNameChange:(QPlayerContext *)context name:(NSString *)name;
/**
字幕状态监听
@param context 当前的播放器
@param enable yes当前字幕状态关开启，no当前字幕状态关闭
*/
-(void)onSubtitleEnable:(QPlayerContext *)context enable:(BOOL)enable;
/**
字幕加载状态监听
@param context 当前的播放器
@param name 字幕名称
@param result yes 加载成功，no 加载失败
*/
-(void)onSubtitleLoaded:(QPlayerContext *)context name:(NSString*)name result:(BOOL)result;
/**
字幕解码状态监听
@param context 当前的播放器
@param name 字幕名称
@param result yes 加载成功，no 加载失败
*/
-(void)onSubtitleDecoded:(QPlayerContext *)context name:(NSString*)name result:(BOOL)result;
//添加监听
[self.playerContext.controlHandler addPlayerSubtitleListener:self];
//移除监听
[self.playerContext.controlHandler removePlayerSubtitleListener:self];
//移除所有监听
[self.playerContext.controlHandler removeAllPlayerSubtitleListener];
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,486 |
QPlayer2 Android端 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >QPlayer2 Android端
# QPlayer2 Android端
最近更新时间: 2022-09-27 15:58:34
QPlayer2 Android端文档包含如下几个部分
* 集成准备：主要介绍将QPlayer2引入到工程中的一些配置
* 基于qplayer2-core的Qplayer2接入指南：如果仅仅使用qplayer2-core开发，则参考这个文档。
* 基于ext扩展插件的Qplayer2接入指南： 如果同时要使用qplayer2-ext 和 qplayer2-core 则参考这个文档。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >QPlayer2 Android端
# QPlayer2 Android端
最近更新时间: 2022-09-27 15:58:34
QPlayer2 Android端文档包含如下几个部分
* 集成准备：主要介绍将QPlayer2引入到工程中的一些配置
* 基于qplayer2-core的Qplayer2接入指南：如果仅仅使用qplayer2-core开发，则参考这个文档。
* 基于ext扩展插件的Qplayer2接入指南： 如果同时要使用qplayer2-ext 和 qplayer2-core 则参考这个文档。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,534 |
集成准备 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2
Android端](https://developer.qiniu.com/pili/sdk/12214/qplayer2-android) > 集成准备
# 集成准备
最近更新时间: 2022-09-27 15:58:44
## 集成准备
### 获取QPlayer2的licence
联系技术支持获取
### 添加 maven 仓库
确保 project 根目录下的 build.gradle 文件中的 repositories添加了`mavenCentral()`
### 添加 QPlayer2 依赖
1.进入<https://github.com/pili-engineering/QPlayer2-Android>[
__](https://github.com/pili-engineering/QPlayer2-Android)查看最新QPlayer2的版本
2.引入qplayer2-core和qplayer2-ext(可选)
3.如果引入了qplayer2-ext 需要再引入
`implementation "io.reactivex.rxjava3:rxjava:3.1.3"`
`implementation 'io.reactivex.rxjava3:rxandroid:3.0.0'`
### 添加权限声明
在 AndroidManifest.xml 文件中声明 SDK 需要的权限。
`<uses-permission android:name="android.permission.INTERNET" />`
`<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />`
### 添加混淆规则
* qplayer2-core
`-keep class com.qiniu.qmedia.** {*;} `
* qplayer2-ext
`-keep class com.qiniu.qplayer2ext.** {*;} `
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2
Android端](https://developer.qiniu.com/pili/sdk/12214/qplayer2-android) > 集成准备
# 集成准备
最近更新时间: 2022-09-27 15:58:44
## 集成准备
### 获取QPlayer2的licence
联系技术支持获取
### 添加 maven 仓库
确保 project 根目录下的 build.gradle 文件中的 repositories添加了`mavenCentral()`
### 添加 QPlayer2 依赖
1.进入<https://github.com/pili-engineering/QPlayer2-Android>[
__](https://github.com/pili-engineering/QPlayer2-Android)查看最新QPlayer2的版本
2.引入qplayer2-core和qplayer2-ext(可选)
3.如果引入了qplayer2-ext 需要再引入
`implementation "io.reactivex.rxjava3:rxjava:3.1.3"`
`implementation 'io.reactivex.rxjava3:rxandroid:3.0.0'`
### 添加权限声明
在 AndroidManifest.xml 文件中声明 SDK 需要的权限。
`<uses-permission android:name="android.permission.INTERNET" />`
`<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />`
### 添加混淆规则
* qplayer2-core
`-keep class com.qiniu.qmedia.** {*;} `
* qplayer2-ext
`-keep class com.qiniu.qplayer2ext.** {*;} `
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,535 |
基于Core的Qplayer2接入指南 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2
Android端](https://developer.qiniu.com/pili/sdk/12214/qplayer2-android) >
基于Core的Qplayer2接入指南
# 基于Core的Qplayer2接入指南
最近更新时间: 2022-09-27 15:58:53
如果业务场景中没有复杂的场景切换，也不想用播放面板定制、播放器上层浮窗定制、播放器上层手势逻辑则可以只用qplayer2-core，接入成本低，学习门槛低。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2
Android端](https://developer.qiniu.com/pili/sdk/12214/qplayer2-android) >
基于Core的Qplayer2接入指南
# 基于Core的Qplayer2接入指南
最近更新时间: 2022-09-27 15:58:53
如果业务场景中没有复杂的场景切换，也不想用播放面板定制、播放器上层浮窗定制、播放器上层手势逻辑则可以只用qplayer2-core，接入成本低，学习门槛低。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,538 |
快速开始 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2
Android端](https://developer.qiniu.com/pili/sdk/12214/qplayer2-android) >
[基于Core的Qplayer2接入指南](https://developer.qiniu.com/pili/sdk/12215/based-on-the-
access-of-qplayer2-core) > 快速开始
# 快速开始
最近更新时间: 2024-05-28 11:12:22
## 快速开始
### 基于qplayer2-core的播放器使用
#### 初始化
在对应布局文件xml中加入播放器控件
<com.qiniu.qmedia.ui.QSurfacePlayerView
android:id="@+id/player_view"
android:layout_width="match_parent"
android:layout_height="match_parent">
</com.qiniu.qmedia.ui.QSurfacePlayerView>
初始化播放器代码建议放在Activity的`onCreate`中或者是Fragment的`onCreate`中
mQSurfacePlayerView = findViewById(R.id.player_view)
mQSurfacePlayerView.playerControlHandler.init(this)
mQSurfacePlayerView.playerControlHandler.setDecodeType(QPlayerSetting.QPlayerDecoder.QPLAYER_DECODER_SETTING_AUTO)
mQSurfacePlayerView.playerControlHandler.setDecodeType(QPlayerSetting.QPlayerDecoder.QPLAYER_DECODER_SETTING_AUTO)
mQSurfacePlayerView.playerControlHandler.setSeekMode(QPlayerSetting.QPlayerSeek.QPLAYER_SEEK_SETTING_NORMAL)
mQSurfacePlayerView.playerControlHandler.setStartAction(QPlayerSetting.QPlayerStart.QPLAYER_START_SETTING_PLAYING)
mQSurfacePlayerView.playerControlHandler.setSpeed(1.0)
#### 播放
builder = QMediaModelBuilder()
url = "http://demo-videos.qnsdk.com/movies/qiniu.mp4"
builder.addStreamElement("", QURLType.QAUDIO_AND_VIDEO, 0, url, true)
var mediaModel = builder.build(false))
mQSurfacePlayerView.playerControlHandler.playMediaModel(mediaModel, 0)
#### 销毁
销毁代码建议放在Activity的`onDestroy`中或者Fragment的`onDestroy`中
mQSurfacePlayerView.playerControlHandler.release()
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2
Android端](https://developer.qiniu.com/pili/sdk/12214/qplayer2-android) >
[基于Core的Qplayer2接入指南](https://developer.qiniu.com/pili/sdk/12215/based-on-the-
access-of-qplayer2-core) > 快速开始
# 快速开始
最近更新时间: 2024-05-28 11:12:22
## 快速开始
### 基于qplayer2-core的播放器使用
#### 初始化
在对应布局文件xml中加入播放器控件
<com.qiniu.qmedia.ui.QSurfacePlayerView
android:id="@+id/player_view"
android:layout_width="match_parent"
android:layout_height="match_parent">
</com.qiniu.qmedia.ui.QSurfacePlayerView>
初始化播放器代码建议放在Activity的`onCreate`中或者是Fragment的`onCreate`中
mQSurfacePlayerView = findViewById(R.id.player_view)
mQSurfacePlayerView.playerControlHandler.init(this)
mQSurfacePlayerView.playerControlHandler.setDecodeType(QPlayerSetting.QPlayerDecoder.QPLAYER_DECODER_SETTING_AUTO)
mQSurfacePlayerView.playerControlHandler.setDecodeType(QPlayerSetting.QPlayerDecoder.QPLAYER_DECODER_SETTING_AUTO)
mQSurfacePlayerView.playerControlHandler.setSeekMode(QPlayerSetting.QPlayerSeek.QPLAYER_SEEK_SETTING_NORMAL)
mQSurfacePlayerView.playerControlHandler.setStartAction(QPlayerSetting.QPlayerStart.QPLAYER_START_SETTING_PLAYING)
mQSurfacePlayerView.playerControlHandler.setSpeed(1.0)
#### 播放
builder = QMediaModelBuilder()
url = "http://demo-videos.qnsdk.com/movies/qiniu.mp4"
builder.addStreamElement("", QURLType.QAUDIO_AND_VIDEO, 0, url, true)
var mediaModel = builder.build(false))
mQSurfacePlayerView.playerControlHandler.playMediaModel(mediaModel, 0)
#### 销毁
销毁代码建议放在Activity的`onDestroy`中或者Fragment的`onDestroy`中
mQSurfacePlayerView.playerControlHandler.release()
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,539 |
基础能力使用 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2
Android端](https://developer.qiniu.com/pili/sdk/12214/qplayer2-android) >
[基于Core的Qplayer2接入指南](https://developer.qiniu.com/pili/sdk/12215/based-on-the-
access-of-qplayer2-core) > 基础能力使用
# 基础能力使用
最近更新时间: 2024-05-28 11:12:15
在[快速开始 __](http://)中，我们完成了qplayer2播放器的创建\播放\销毁，本文介绍如何使用qplayer2的播放能力
# 播放
## 创建播放数据
以下配置的mediaModel是一个有2个清晰度的播放数据，包含2个清晰度1080 和 720
，同时包含2个srt字幕文件，起播的时候会自动播放1080P的链接和加载中文的字幕
//创建MediaModel的构造器
builder = QMediaModelBuilder()
//配置视频元素
builder.addStreamElement(
"", //userType 预留字段可以填空
QURLType.QAUDIO_AND_VIDEO, //资源的类型，指该元素是包含音频还是视频还是都包含
1080, //清晰度数值标记
"http://demo-videos.qnsdk.com/qiniu-1080p.mp4", //视频的地址
true //是否是默认元素，默认元素是指，起播的时候默认会播放这个元素
)
builder.addStreamElement(
"", //userType 预留字段可以填空
QURLType.QAUDIO_AND_VIDEO, //资源的类型，指该元素是包含音频还是视频还是都包含
720, //清晰度数值标记
"http://demo-videos.qnsdk.com/qiniu-720p.mp4", //视频的地址
false //是否是默认元素，默认元素是指，起播的时候默认会播放这个元素
)
builder.addSubtitleElement("中文", //字幕名称（唯一的key）
"http://demo-videos.qnsdk.com/qiniu-2023-chinese.srt", //srt字幕地址
true) //是否是默认字幕 默认元素是指，起播的时候默认加载这个字幕
builder.addSubtitleElement("英文",
"http://demo-videos.qnsdk.com/qiniu-2023-english.srt",
false)
val mediaModel = builder.build(false) //此处的参数指代该资源是否是一个直播资源，是直播的话就是true,不是直播就是false
以下配置的mediaModel是一个音频和视频分成2路url的的播放数据 ，起播的时候会同时播放这两个元素
builder = QMediaModelBuilder()
builder.addStreamElement(
"", //userType 预留字段可以填空
QURLType.QAUDIO, //资源的类型，这里的url对应的资源只有音频所以这里用QAUDIO
100, //清晰度数值标记为100
"http://demo-videos.qnsdk.com/only-audio.m4s", //资源地址
true //是否是默认元素，默认元素是指，起播的时候默认会播放这个元素
)
builder.addStreamElement(
"", //userType 预留字段可以填空
QURLType.QVIDEO, //资源的类型，这里的url对应的资源只有视频所以这里用QVIDEO
1080, //清晰度数值标记为1080
"http://demo-videos.qnsdk.com/only-video-1080p-60fps.m4s", //资源地址
true //是否是默认元素，此处也是默认播放，所以也是true
)
val mediaModel = builder.build(false) //此处的参数指代该资源是否是一个直播资源，是直播的话就是true,不是直播就是false
addStreamElement方法的所有参数
参数名 | 参数含义
---|---
userType | 用户自定义Type，目前预留，可以填空字符串
urlType | 媒体的资源属性 只包含视频/只包含音频/同时有视频音频
quality | 清晰度
url | 资源地址
isSelected | 是否起播时播放该流
backupUrl | 备用地址
referer | http/https 协议的地址 支持该属性 用于防盗链referer参数
videoRenderType | 视频的渲染类型，默认是QVideoRenderType.PLANE, 如果是VR视频此处为QVideoRenderType.PANORAMA_EQUIRECT_ANGULAR
hlsDrmKey | 私有DRM解密的key，用在私有hls加密视频播放的场景中
mp4DrmKey | mp4 drm 的解密 key 用于 CENC-AES-CTR 加密的视频播放场景中
mp4QNDrmComKey | mp4 七牛私有 drm 的解密 comkey 用于七牛私有 mp4 加密的视频播放场景中
mp4QNDrmFileKey | mp4 七牛私有 drm 的解密 filekey 用于七牛私有 mp4 加密的视频播放场景中
## MP4 加密
目前 QPlayer2 仅支持显式的 CENC-AES-CTR 加密，暂不支持隐式加密。CENC-AES-CTR 的初始化向量(IV)
由加密工具随机生成并存储在加密后的 MP4 文件中，QPlayer2 读取 MP4 文件的 IV 和QmediaModel 存储的 mp4DrmKey
进行解密。
### 配置DRM加密视频
//七牛私有HLS解密密钥
builder = QMediaModelBuilder()
url = "http://80rjmu.com1.z0.glb.clouddn.com/ncyY3ioGAakS-Lg252IscrXNxyo=/Fgny-rvibYqoFP-lPkI53JfmoIx5"
builder.addStreamElement("", QURLType.QAUDIO_AND_VIDEO, 0, url, true, "", "", QVideoRenderType.PLANE, "testtesttesttest")
mVideoList.add(Pair(url, builder.build(false)))
//公有MP4解密密钥
builder = QMediaModelBuilder()
url = "https://sdk-release.qnsdk.com/CENC_AES-CTR.mp4"
builder.addStreamElement("", QURLType.QAUDIO_AND_VIDEO, 0, url, true, "", "", QVideoRenderType.PLANE, "", "c7e16c4403654b85847037383f0c2db3")
mVideoList.add(Pair(url, builder.build(false)))
//私有MP4解密密钥
builder = QMediaModelBuilder()
url = "https://kodo.koafun.com/drm-16884581530881688458153078-new.mp4"
builder.addStreamElement("", QURLType.QAUDIO_AND_VIDEO, 0, url, true, "", "", QVideoRenderType.PLANE, "", "", "comnew", "filenew")
mVideoList.add(Pair(url, builder.build(false)))
### 对 MP4 文件进行 CENC-AES-CTR 加密
可以选择 ffmpeg 对一个 MP4 进行加密。加密命令如下：
ffmpeg -i test2.mp4 -vcodec copy -acodec copy -encryption_scheme cenc-aes-ctr -encryption_key c7e16c4403654b85847037383f0c2db3 -encryption_kid a7e61c373e219033c21091fa607bf3b8 encrypted_IV_test.mp4
命令说明
test2.mp4 为输入文件
encrypted_IV_test.mp4 为输出文件
-vcodec copy 和 -acodec copy ：指定视频流和音频流的编码方式为原始流的拷贝，即不进行重新编码，保持与原始文件相同的编码格式。
-encryption_scheme cenc-aes-ctr ：设置加密方案为 CENC-AES-CTR，即采用 CTR 模式进行加密。
-encryption_key c7e16c4403654b85847037383f0c2db3 指定加密所使用的密钥，即解密所使用的 key。这里的c7e16c4403654b85847037383f0c2db3 是一个示例密钥，您可以替换为您自己的密钥，格式要求为：16字节的16进制数据。
-encryption_kid a7e61c373e219033c21091fa607bf3b8：指定加密所使用的密钥标识符（KID）。这里的 a7e61c373e219033c21091fa607bf3b8 是一个示例 KID，您可以替换为您自己的密钥标识符, 格式要求为：16字节的16进制数据。
加密后可通过ffplay 4.4 版本进行播放验证，播放正常即可。命令如下：
ffplay encrypted_IV_test.mp4 -decryption_key c7e16c4403654b85847037383f0c2db3
### QPlayer2 对加密后 MP4 文件进行播放
builder = QMediaModelBuilder()
//配置视频元素
builder.addStreamElement(
"", //userType 预留字段可以填空
QURLType.QAUDIO_AND_VIDEO, //资源的类型，指该元素是包含音频还是视频还是都包含
1080, //清晰度数值标记
"https://sdk-release.qnsdk.com/CENC_AES-CTR.mp", //视频的地址
true //是否是默认元素，默认元素是指，起播的时候默认会播放这个元素
"c7e16c4403654b85847037383f0c2db3" //mp4 解密使用的秘钥
)
val mediaModel = builder.build(false) //此处的参数指代该资源是否是一个直播资源，是直播的话就是true,不是直播就是false //预留字段，可以为
## 视频URL类型枚举
QAUDIO_AND_VIDEO(0), //包含视频和音频
QAUDIO(1), //仅包含音频
QVIDEO(2), //仅包含视频
NONE(5); //无
## 播放媒体资源
上一步中我们创建了一些mediaModel，接下来我们将播放他们
mQPlayerView.playerControlHandler.playMediaModel(
mediaModel, //要播放的媒体资源
0 //起播的位置，如果是直播这里必须为0，不然有不可预见的问题发生
)
## 播放错误监听
当视频起播时，如果遇到网络等问题原因，导致没有和服务器建立链接，那么会导致视频播放失败，总共会有3次重试机会，3次都失败的情况下会回调onOpenFailed方法
当视频已经起播后，在中途遇到网络等问题原因，进入buffer,
那么内核会一直重试，直到再次连接上服务端继续播放，或者用户通过接口停止播放该视频，在重试的过程中
onReconnectStart/onReconnectEnd会被回调，那么可以监控回调的次数来做业务层的结束播放的策略，当然在正常播放的情况下，这两个方法也是会被回调的，所以
最好结合buffer的回调数据一起使用。
val listener = object: QIPlayerMediaNetworkListener {
/***
* 开始重连
*
* @param userType 重连stream element的userType
* @param urlType 重连stream element的urlType
* @param url 重连的url
* @param retryTime 已重试的次数
*/
override fun onReconnectStart(userType: String, urlType: QURLType, url: String, retryTime: Int) {
}
/***
* 重连结束
*
* @param userType 重连stream element的userType
* @param urlType 重连stream element的urlType
* @param url 重连的url
* @param retryTime 已重试的次数
* @param error 错误码
*/
override fun onReconnectEnd(userType: String, urlType: QURLType, url: String, retryTime: Int, error: OpenError) {
}
/***
* 打开失败
*
* @param userType 重连stream element的userType
* @param urlType 重连stream element的urlType
* @param url 重连的url
* @param error 错误码
*/
override fun onOpenFailed(userType: String, urlType: QURLType, url: String, error: OpenError) {
//当非用户中断时，才展示错误面板
if (error != QIPlayerMediaNetworkListener.OpenError.INTERRUPT) {
//展示错误面板
}
}
}
//添加监听
mQPlayerView.playerControlHandler.addPlayerMediaNetworkListener(listener)
//移除监听
mQPlayerView.playerControlHandler.removePlayerMediaNetworkListener(listener)
//移除所有监听
mQPlayerView.playerControlHandler.removeAllPlayerMediaNetworkListener()
## 播放错误码枚举
UNKOWN(10000),
NONE(0),
IOERROR(-5),
INTERRUPT(-1414092869),
URL_INVALID(-875574520),
FORMAT_INVALID(-1094995529);
# SRT字幕
要使用SRT字幕需要满足四个条件
1. 视频源配置了字幕（配置方式参阅播放条目）
2. 字幕功能开启`mQPlayerView.playerControlHandler.setSubtitleEnable(true)`
3. 有生效的字幕（以下方式二选一）
* 在视频源配置了`isDefault=True`的字幕启动播放
* 通过接口设置生效字幕 `mQPlayerView.playerControlHandler..setSubtitle(subtitleName)`
4. 通过字幕回调监听，每当时间轴触发了新的字幕条目，则该监听会回调，并将最新的一条字幕文案传递给监听接口，用户可以以自己的展示方式来展示这条字幕条目
## 字幕回调监听
val listener = object: QIPlayerSubtitleListener {
//text:最新的字幕条目
override fun on_subtitle_text_change(text: String) {
//更新字幕文案展示
}
//name:字幕的名称
override fun on_subtitle_name_change(name: String) {
//字幕变更回调
}
override fun on_subtitle_close() {
//字幕能力关闭
}
//name:字幕的名称
//result:加载的结果
override fun on_subtitle_loaded(name: String, result: Boolean) {
//字幕加载结束
}
//name:字幕的名称
//result:解析的结果
override fun on_subtitle_decoded(name: String, result: Boolean) {
//字幕解析结束
}
}
//添加监听
mQPlayerView.playerControlHandler.addPlayerSubtitleListener(listener)
//移除监听
mQPlayerView.playerControlHandler.removePlayerSubtitleListener(listener)
//移除所有监听
mQPlayerView.playerControlHandler.removeAllPlayerSubtitleListeners()
# 预加载
播放预加载实例用于点播（一般用在短视频场景中），不能用在直播上，播放预加载实例能提升首帧的速度。
预加载的加载时机策略由业务层自行实现
## 预加载的简单使用
//创建预加载实例,一般是提前创建
mediaItem = QMediaItemContext(mediaModel, logLevel, localStorageDir, startPos)
//开始预加载
mediaItem.playMediaControlHandler.start()
//在需要播放时调用播放预加载实例接口
mQPlayerView.playerControlHandler.playMediaItem(mediaItem)
//播放完成后
停止预加载实例
mediaItem.playMediaControlHandler.stop()
## 预加载实例状态枚举
NONE(100) //初始状态
PREPARE(101) //开始加载前，准备工作状态
LOADING(102) //开始加载
PAUSED(103) //暂停加载
STOPED(104) //停止加载, 无法恢复
ERROR(105) //加载出错
PREPARE_USE(106) //准备使用播放
USED(107) //已经使用
DISCARD(108) //废弃
## 预加载实例状态监听
val listener = object: QIMediaItemStateChangeListener {
//状态变更回调时回调，返回变更后的状态
override fun onStateChanged(state: QMediaItemState) {
}
}
//添加监听
mediaItem.playMediaControlHandler.addMediaItemStateChangeListener(listener)
//移除监听
mediaItem.playMediaControlHandler.removeMediaItemStateChangeListener(listener)
//移除所有监听
mediaItem.playMediaControlHandler.removeAllPlayMediaStateChangeListener()
## 预加载的状态枚举
NONE(100),//初始状态
PREPARE(101),
LOADING(102),
PAUSED(103),
STOPED(104),
ERROR(105),
PREPARE_USE(106),
USED(107),
DISCARD(108);
# 设置日志等级
mQPlayerView.playerControlHandler.setLogLevel(QLogLevel.LOG_INFO)
# 暂停播放
mQPlayerView.playerControlHandler.pauseRender()
# 恢复播放
mQPlayerView.playerControlHandler.resumeRender()
# 停止当前视频播放
mQPlayerView.playerControlHandler.stop()
# 鉴权
鉴权功能介绍见鉴权[相关文档 __](https://developer.qiniu.io/pili/12223/qplayer2-core-
authentication-related)
## 强制网络鉴权
调用该接口时，会强制进行网络鉴权
mQPlayerView.playerControlHandler.forceAuthenticationFromNetwork()
## 鉴权监听
val listener = object: QIPlayerAuthenticationListener {
/**
* 鉴权失败回调，同时，会停止当前的视频播放，且状态切换成 @see[QPlayerState.ERROR]
*/
fun on_authentication_failed(error_type: QAuthenticationErrorType) {
}
/**
* 鉴权成功回调
*/
fun on_authentication_success() {
}
}
//添加监听
mQPlayerView.playerControlHandler.addPlayerAuthenticationListener(listener)
//移除监听
mQPlayerView.playerControlHandler.removePlayerAuthenticationListener(listener)
//移除所有监听
mQPlayerView.playerControlHandler.removeAllPlayerAuthentications()
## 鉴权错误码枚举
NONE(0), //鉴权出错
NO_BASE_AUTH(1), //缺少基础功能权限
NO_VR_AUTH(2), //缺少VR功能权限
NO_BLIND_AUTH(3),//缺少色盲功能权限
NO_SEI_AUTH(4), //缺少SEI功能权限
NO_SRT_AUTH(5); //缺少SRT功能权限
# 切换视频进度
mQPlayerView.playerControlHandler.seek(2000) //参数为要定位的position 单位毫秒
## Seek监听
一般情况下
Seek都会成功，如果网络差的情况下，会无限loading（除非调用stop才会停止），直到seek到指定的位置为止。但是如果视频源本身是格式不正确的，比如pts错乱等问题，才会导致seek失败，所以在seek失败回调中，做好提示工作就好，不要尝试再次seek
val listener = object: QIPlayerSeekListener {
/*seek失败回调*/
override fun onSeekFailed() {
}
/*seek成功回调*/
override fun onSeekSuccess() {
}
}
//添加监听
mQPlayerView.playerControlHandler.addPlayerSeekListener(listener)
//移除监听
mQPlayerView.playerControlHandler.removePlayerSeekListener(listener)
//移除所有监听
mQPlayerView.playerControlHandler.removeAllPlayerSeekListener()
# 视频解码方式
目前支持的解码方式有:软解、硬解、混解、自动，一般情况下，使用自动，内核会根据手机的硬件情况，要播放的视频资源编码格式等信息，挑选
合适的解码方式进行解码，各个解码方式的优劣情况如下
软解: 解码较慢，但是兼容性好，适用于所有手机
硬解：解码性能高，但是有一定兼容性，比如某些视频资源的编码格式，硬解芯片不支持。并且相对于软解，首帧的速度慢。
混解：通过软解和硬解相结合的方式，提升首帧速度，加快了解码性能，但是在能耗上略有劣势。
## 设置优先选择哪种解码方式
//下一次播放生效
//最终的解码方式可能不是设置的，在设置的解码方式不能正确解码时，内核会进行降级，选择其他能正确解码的方式
mQPlayerView.playerControlHandler.setDecodeType(QPlayerSetting.QPlayerDecoder.QPLAYER_DECODER_SETTING_AUTO)
## 优先选择的解码方式枚举
//自动选择
QPLAYER_DECODER_SETTING_AUTO(0),
//硬解优先
QPLAYER_DECODER_SETTING_HARDWARE_PRIORITY(1),
//软解优先
QPLAYER_DECODER_SETTING_SOFT_PRIORITY(2),
//混解优先
QPLAYER_DECODER_SETTING_FIRST_FRAME_ACCEL_PRIORITY(3),
## 播放器视频解码监听相关
val listener = object: QIPlayerVideoDecodeListener {
//setDecodeType 设置了优先使用哪种解码方式，经过内核处理后，该回调将正真的视频解码方式返回
override fun onVideoDecodeByType(type: QPlayerDecodeType) {
}
// 如果当前视频编码 所在设备或者sdk不支持 则回调该方法
// codecId 视频的编码id
override fun notSupportCodecFormat(codecId: Int) {
}
/**
* 通知当前视频解码失败，
* @param retry 底层是否重试
*/
override fun onDecodeFailed(retry: Boolean) {
}
}
//添加监听
mQPlayerView.playerControlHandler.addPlayerVideoDecodeTypeListener(listener)
//移除监听
mQPlayerView.playerControlHandler.removePlayerVideoDecodeTypeListener(listener)
//移除所有播放器视频解码监听
mQPlayerView.playerControlHandler.removeAllPlayerVideoDecodeTypeListener()
## 解码方式枚举
NONE(0),
//软解
SOFTWARE(1),
//surface 硬解
HARDWARE_SURFACE(10),
//buffer 硬解
HARDWARE_BUFFER(11),
//混解
FIRST_FRAME_ACCEL(2);
# 设置起播方式
//下一次播放生效
mQPlayerView.playerControlHandler.setStartAction(QPlayerSetting.QPlayerStart.QPLAYER_START_SETTING_PLAYING)
## 解码方式枚举
//起播播放
QPLAYER_START_SETTING_PLAYING(0),
//起播暂停在首帧
QPLAYER_START_SETTING_PAUSE(1),
# 设置seek方式
//下一次seek即生效
mQPlayerView.playerControlHandler.setSeekMode(QPlayerSetting.QPlayerSeek.QPLAYER_SEEK_SETTING_NORMAL)
## seek方式枚举
//关键帧seek，每次seek 都seek到离目标位置向前的最近的一个关键帧，耗时少
QPLAYER_SEEK_SETTING_NORMAL(0),
//精准seek，耗时比关键帧seek多，且耗时和视频的gop间隔的大小成正比
QPLAYER_SEEK_SETTING_ACCURATE(1),
# 获取当前播放状态
mQPlayerView.playerControlHandler.currentPlayerState
# 获取当前进度
mQPlayerView.playerControlHandler.currentPosition
# 获取视频时长
mQPlayerView.playerControlHandler.duration
# 获取当前下载速度
mQPlayerView.playerControlHandler.downloadSpeed
# 获取当前缓冲进度
mQPlayerView.playerControlHandler.bufferPositon
# 播放器状态
在整个播放器实例生命周期中，播放会在不同的状态中切换，用户可以通过监听播放器状态，实现上层业务逻辑，
比如在视频播放完时，展示其他视频的推荐页，那么只需监听播放器状态回调，待回调的状态是COMPLETED，则展示推荐页
## 播放器状态枚举
NONE(0),//初始状态
INIT(1),//播放器开始创建各种对象
PREPARE(2),//开始播放一个新视频的时候先进入这个状态，进行一些准备工作
PLAYING(4),//播放中
PAUSED_RENDER(6),//暂停
COMPLETED(7),//播放完成
SEEKING(8), //SEEK
STOPPED(9),//播放停止
ERROR(10),//播放出错
END(11),//播放器释放各种对象完成
MEDIA_ITEM_PREPARE(12), //预加载的Prepare状态，开始播放一个新视频的时候先进入这个状态，进行一些准备工作
RELEASE(13); //播放器结束，且释放各类资源
## 播放器状态变更监听相关
val listener = object: QIPlayerStateChangeListener {
//状态变更回调时回调，返回变更后的状态
override fun onStateChanged(state: QPlayerState) {
}
}
//添加监听
mQPlayerView.playerControlHandler.addPlayerStateChangeListener(listener)
//移除监听
mQPlayerView.playerControlHandler.removePlayerStateChangeListener(listener)
//移除所有监听
mQPlayerView.playerControlHandler.removeAllPlayerStateChangeListener()
# 播放速度
播放速度的调整范围建议在0.25-2.0之间，这样会有一个比较好的效果
## 设置播放速度
//即时播放生效
mQPlayerView.playerControlHandler.setSpeed(1.25f) //参数为倍速值
## 获取当前速度
mQPlayerView.playerControlHandler.speed
## 速度变更监听相关
val listener = object: QIPlayerSpeedListener {
//播放倍速变更回调
override fun onSpeedChanged(speed: Float) {
}
}
//添加监听
mQPlayerView.playerControlHandler.addPlayerSpeedChangeListener(listener)
//移除监听
mQPlayerView.playerControlHandler.removePlayerSpeedChangeListener(listener)
//移除所有监听
mQPlayerView.playerControlHandler.removeAllPlayerSpeedChangeListener()
# 清晰度
QPlayer2提供的清晰度能力是无缝切换清晰度方案，在切换过程中，画面是连续的画面，不会出现类似跳帧的情况。
使用无缝切换清晰度功能，必须在mediaModel中配置多路清晰度，如果使用非immediately方式(即异步方式)时，同时只能有一次切换会话存在，会话结束后，才能切下一次
## 切换视频清晰度
//使用该方法时，mediaModel中需要存在多个StreamElement
mQPlayerView.playerControlHandler.switchQuality(
"", //要切换的StreamElement的userType
QURLType.QAUDIO_AND_VIDEO, //要切换的StreamElement的urltype
1080, //要切换的StreamElement的清晰度数值标记
false //是否immediately方式，true:立即切换过程中会出现卡一下，一般用于直播，false:非立即切换下，切换过程无缝切换，只能用于点播。
)
## 获取当前的清晰度
//使用该方法时，mediaModel中需要存在多个StreamElement，返回清晰度数值标记
mQPlayerView.playerControlHandler.getCurrentQuality(
"", //要查询的StreamElement的userType
QURLType.QAUDIO_AND_VIDEO //要查询的StreamElement的urltype
)
## 获取当前正在切换的清晰度
//获取指定 userType urlType 流正在切换的清晰度（非immediately方式）
mQPlayerView.playerControlHandler.getSwitchingQuality(
"", //要查询的StreamElement的userType
QURLType.QAUDIO_AND_VIDEO //要查询的StreamElement的urltype
)
## 播放器清晰度相关监听
val listener = object: QIPlayerQualityListener {
/**
* 开始清晰度切换
* @param userType 开始切换清晰度的stream element的userType
* @param urlType 开始切换清晰度的stream element的 urlType @see[QURLType]
* @param newQuality 要切到哪路清晰度
* @param oldQuality 切换前的清晰度
*/
override fun onQualitySwitchStart(userType: String, urlType: QURLType, newQuality: Int, oldQuality: Int) {
}
/**
* 清晰度切换完成
* @param userType 开始切换清晰度的stream element的userType
* @param urlType 开始切换清晰度的stream element的urlType @see[QURLType]
* @param newQuality 要切到哪路清晰度
* @param oldQuality 切换前的清晰度
*/
override fun onQualitySwitchComplete(userType: String, urlType: QURLType, newQuality: Int, oldQuality: Int) {
}
/**
* 清晰度切换取消
* @param userType 开始切换清晰度的stream element的userType
* @param urlType 开始切换清晰度的stream element的 urlType @see[QURLType]
* @param newQuality 要切到哪路清晰度
* @param oldQuality 切换前的清晰度
*/
override fun onQualitySwitchCanceled(userType: String, urlType: QURLType, newQuality: Int, oldQuality: Int) {
}
/**
* 清晰度切换失败
* @param userType 开始切换清晰度的url流的userType
* @param urlType 开始切换清晰度的url流的 urlType @see[QURLType]
* @param newQuality 要切到哪路清晰度
* @param oldQuality 切换前的清晰度
*/
override fun onQualitySwitchFailed(userType: String, urlType: QURLType, newQuality: Int, oldQuality: Int) {
}
/**
* 目前仅支持同时有一个清晰度切换，如果前一个还未切换完，再次发起切换 会回调这个函数
* @param userType 开始切换清晰度的url流的userType
* @param urlType 开始切换清晰度的url流的 urlType @see[QURLType]
* @param newQuality 要切到哪路清晰度
* **/
override fun onQualitySwitchRetryLater(userType: String, urlType: QURLType, newQuality: Int) {
}
}
//添加监听
mQPlayerView.playerControlHandler.addPlayerQualityListener(listener)
//移除监听
mQPlayerView.playerControlHandler.removePlayerQualityListener(listener)
//移除所有监听
mQPlayerView.playerControlHandler.removeAllPlayerQualityListener()
## 直播支持多路清晰度切换
无缝切换清晰度方案需要配置以下三个条件
1. 首先切换的模式要选择立即切换即：immediately=true
2. 服务端配置PTS透传，
3. 对应的清晰度要做主动转码设置
如果无法满足以上3个条件，那么建议用最基础的能力来实现清晰度切换，即每个清晰度都是一个media
model，切换时，调用playMediaModel来播放新的清晰度流。
# 播放进度监听
只有在点播的时候 duration 和 progress 才有意义，直播的话这两个值没有参考意义
val listener = object: QIPlayerProgressListener {
/**
* 进度变更回调
* @param duration 总时长 单位毫秒
* @param progress 当前进度 单位毫秒
*/
override fun onProgressChanged(duration: Long, progress: Long) {
}
}
//添加监听
mQPlayerView.playerControlHandler.addPlayerProgressChangeListener(listener)
//移除监听
mQPlayerView.playerControlHandler.removePlayerProgressChangeListener(listener)
//移除所有监听
mQPlayerView.playerControlHandler.removeAllPlayerProgressChangeListener()
# 实时帧率
## 获取当前fps
mQPlayerView.playerControlHandler.fps
## 实时帧率监听
val listener = object: QIPlayerFPSListener {
/**
* fps 改变的回调
* @param fps 帧率
*/
override fun onFPSChanged(fps: Int) {
}
}
//添加监听
mQPlayerView.playerControlHandler.addPlayerFPSChangeListener(listener)
//移除监听
mQPlayerView.playerControlHandler.removePlayerFPSChangeListener(listener)
//移除所有监听
mQPlayerView.playerControlHandler.removeAllPlayerFPSChangeListener()
# 像素格式或者音频sample格式不支持的监听
val listener = object: QIPlayerFormatListener {
/**
* 当前有format 不支持，所以视频没法播放
*/
override fun onFormatNotSupport() {
}
}
//添加监听
mQPlayerView.playerControlHandler.addPlayerFormatListener(listener)
//移除监听
mQPlayerView.playerControlHandler.removePlayerFormatListener(listener)
//移除所有监听
mQPlayerView.playerControlHandler.removeAllPlayerFormatListeners()
# 缓冲拉流监听
val listener = object: QIPlayerDownloadListener {
/**
* 拉流速率改变
* @param speed 单位 b/s（比特每秒）
* @param bufferProgress 缓冲的进度
*/
override onDownloadChanged(speed: Long, bufferProgress: Long) {
}
}
//添加监听
mQPlayerView.playerControlHandler.addPlayerDownloadChangeListener(listener)
//移除监听
mQPlayerView.playerControlHandler.removePlayerDownloadChangeListener(listener)
//移除所有监听
mQPlayerView.playerControlHandler.removeAllPlayerDownloadChangeListener()
# 播放器操作不允许执行监听
在某些状态下，一些操作将不被执行，通过该监听回调上来通知
val listener = object: QIPlayerCommandNotAllowListener {
/**
* 操作不被允许
* @param commandName 操作名称
* @param state 操作被检测时播放器的状态
*/
override fun onCommandNotAllow(commandName: String, state: QPlayerState) {
}
}
//添加监听
mQPlayerView.playerControlHandler.addPlayerCommandNotAllowListener(listener)
//移除监听
mQPlayerView.playerControlHandler.removePlayerCommandNotAllowListener(listener)
//移除所有监听
mQPlayerView.playerControlHandler.removeAllPlayerCommandNotAllowListener()
# buffering 监听
val listener = object: QIPlayerBufferingListener {
/**
* 开始buffering
*/
override fun onBufferingStart() {
//展示buffering UI
}
/**
* 结束buffering
*/
override fun onBufferingEnd() {
//隐藏buffering UI
}
}
//添加监听
mQPlayerView.playerControlHandler.addPlayerBufferingChangeListener(listener)
//移除监听
mQPlayerView.playerControlHandler.removePlayerBufferingChangeListener(listener)
//移除所有监听
mQPlayerView.playerControlHandler.removeAllPlayerBufferingChangeListener()
# 码率
## 获取当前码率
mQPlayerView.playerControlHandler.biteRate
## 实时码率监听
val listener = object: QIPlayerBiteRateListener {
/**
* 码率变换回调
* @param biteRate 比特率， 单位：bps
*/
override fun onBiteRateChanged(biteRate: Long) {
}
}
//添加监听
mQPlayerView.playerControlHandler.addPlayerBiteRateChangeListener(listener)
//移除监听
mQPlayerView.playerControlHandler.removePlayerBiteRateChangeListener(listener)
//移除所有监听
mQPlayerView.playerControlHandler.removeAllPlayerBiteRateChangeListener()
# SEI 数据回调
用户自定义数据可以带在H264或者H265的编码帧里，用于实现一些基于时间轴的业务场景。
开启该功能后，如果视频资源内带有SEI数据 会通过监听接口抛给业务层。
该功能需要单独开通，具体可以联系技术支持咨询。
## 开启 SEI
mQPlayerView.playerControlHandler.setSEIEnable(true)
## SEI 数据监听
val listener = object: QIPlayerSEIDataListener {
/**
* SEI 数据回调，且回调时机为SEI数据所在帧的时间
* @param data SEI 数据
*/
override fun onSEIData(data: ByteArray) {
}
}
//添加监听
mQPlayerView.playerControlHandler.addPlayerSEIDataListener(listener)
//移除监听
mQPlayerView.playerControlHandler.removePlayerSEIDataListener(listener)
//移除所有监听
mQPlayerView.playerControlHandler.removeAllPlayerSEIDataListeners()
# 音频数据上抛相关监听
## 开启音频数据监听
mQPlayerView.playerControlHandler.setAudioDataCallbackEnable(true)
## 音频数据监听
val listener = object: QIPlayerAudioDataListener {
/**
* 音频数据回调
* @param sampleRate 采样率
* @param format 音频位宽
* @param channelNum 声道数
* @param channelLayout 声道布局
* @param data 音频数据
*/
override fun onAudioData(sampleRate: Int, format: QSampleFormat, channelNum: Int, channelLayout:QChannelLayout, data: ByteArray){
}
}
//添加监听
mQPlayerView.playerControlHandler.addPlayerAudioDataListener(listener)
//移除监听
mQPlayerView.playerControlHandler.removePlayerAudioDataListener(listener)
//移除所有监听
mQPlayerView.playerControlHandler.removeAllPlayerAudioDataListeners()
# 视频数据上抛相关监听
## 开启视频数据监听
mQPlayerView.playerControlHandler.setVideoDataCallbackEnable(true)
## 音频数据监听
val listener = object: QIPlayerVideoDataListener {
/***
* 视频数据回调
* @param width 视频宽度
* @param height 视频高度
* @param type 视频数据类型
* @param data 视频数据
*/
override fun onVideoData(width: Int, height: Int, type: QVideoDataType, data: ByteArray) {
}
}
//添加监听
mQPlayerView.playerControlHandler.addPlayerVideoDataListener(listener)
//移除监听
mQPlayerView.playerControlHandler.removePlayerVideoDataListener(listener)
//移除所有监听
mQPlayerView.playerControlHandler.removeAllPlayerVideoDataListeners()
# 渲染相关监听
val listener = object: QIPlayerRenderListener {
//首帧耗时回调 从play 开始到首帧渲染出来的总耗时 单位毫秒
override fun onFirstFrameRendered(elapsedTime: Long) {
}
}
//添加监听
mQPlayerView.playerRenderHandler.addPlayerRenderListener(listener)
//移除监听
mQPlayerView.playerRenderHandler.removePlayerRenderListener(listener)
//移除所有监听
mQPlayerView.playerRenderHandler.removeAllPlayerRenderListener()
# 设置视频渲染比例
mQPlayerView.playerRenderHandler.setRenderRatio(QPlayerSetting.QPlayerRenderRatio.QPLAYER_RATIO_SETTING_AUTO)
## 视频比例枚举
//自动
QPLAYER_RATIO_SETTING_AUTO(1),
//拉升
QPLAYER_RATIO_SETTING_STRETCH(2),
//铺满
QPLAYER_RATIO_SETTING_FULL_SCREEN(3),
//16:9
QPLAYER_RATIO_SETTING_16_9(4),
//4:3
QPLAYER_RATIO_SETTING_4_3(5),
# 设置色觉优化
mQPlayerView.playerControlHandler.setBlindType(QPlayerSetting.QPlayerBlind.QPLAYER_BLIND_SETTING_NONE)
## 色觉优化枚举
//无
QPLAYER_BLIND_SETTING_NONE(0),
//红色盲
QPLAYER_BLIND_SETTING_RED(1),
//绿色盲
QPLAYER_BLIND_SETTING_GREEN(2),
//蓝色盲
QPLAYER_BLIND_SETTING_BLUE(3),
# VR视频播放
在播放VR视频时，需要在mediaModel中配置vr视频的资源
并且将streamElement的videoRenderType设置为QVideoRenderType.PANORAMA_EQUIRECT_ANGULAR
然后通过设置vr视频视角改变视频朝向
该功能需要单独开通，具体可以联系技术支持咨询。
/***
* 设置VR视频的旋转角度
* @param rotateX 横向角度 （360度制）
* @param rotateY 纵向角度 （360度制）
* @return true 设置成功 false 设置失败
*/
mQPlayerView.playerRenderHandler.setPanoramaViewRotate(mCurrentRotationY, -mCurrentRotationX)
## 视频类型枚举
NONE(-1),
//普通视频
PLANE(0),
//ANGULAR类 VR视频
PANORAMA_EQUIRECT_ANGULAR(1),
# 截图
调用截图接口，就会回调截图时的video画面，并以jpeg的格式返回
mQPlayerView.playerControlHandler.shootVideo()
## 截图监听
val listener = object: QIPlayerShootVideoListener {
/**
* 截图成功
*/
override fun onShootSuccessful(
image: ByteArray, //图片的二进制数组
width: Int, //图片的宽
height: Int, //图片的高
type: QIPlayerShootVideoListener.ShootVideoType //图片的类型（jpeg）
) {
//保存截图
//展示截图
}
/**
* 截图失败回调
*/
override fun onShootFailed() {
}
}
//添加监听
mQPlayerView.playerControlHandler.addPlayerShootVideoListener(listener)
//移除监听
mQPlayerView.playerControlHandler.removePlayerShootVideoListener(listener)
//移除所有监听
mQPlayerView.playerControlHandler.removeAllPlayerShootVideoListeners()
# 静音
控制播放器静音，且该静音非系统的声音设置，仅仅只是把播放器设置为静音
/**
@param isMute true: 静音 false：非静音
*/
mQPlayerView.playerControlHandler.setMute(true)
## 静音监听
val listener = object: QIPlayerAudioListener {
//静音改变回调
override fun onMuteChanged(is_mute: Boolean) {
}
}
//添加监听
mQPlayerView.playerControlHandler.addPlayerAudioListener(listener)
//移除监听
mQPlayerView.playerControlHandler.removePlayerAudioListener(listener)
//移除所有监听
mQPlayerView.playerControlHandler.removeAllPlayerAudioListener()
# 视频宽高改变监听
在视频首帧渲染时，会调用该回调，告诉上层当前的视频宽高是多少，如果在这个这个视频播放的生命周期中，宽高改变，那么还会再次调用该回调
val listener = object: QIPlayerVideoFrameSizeChangeListener {
//宽：width 高：height
onVideoFrameSizeChanged(width: Int, height: Int) {
}
}
//添加监听
mQPlayerView.playerControlHandler.addPlayerVideoFrameSizeChangeListener(listener)
//移除监听
mQPlayerView.playerControlHandler.removePlayerVideoFrameSizeChangeListener(listener)
//移除所有监听
mQPlayerView.playerControlHandler.removeAllPlayerVideoFrameSizeChangeListener()
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2
Android端](https://developer.qiniu.com/pili/sdk/12214/qplayer2-android) >
[基于Core的Qplayer2接入指南](https://developer.qiniu.com/pili/sdk/12215/based-on-the-
access-of-qplayer2-core) > 基础能力使用
# 基础能力使用
最近更新时间: 2024-05-28 11:12:15
在[快速开始 __](http://)中，我们完成了qplayer2播放器的创建\播放\销毁，本文介绍如何使用qplayer2的播放能力
# 播放
## 创建播放数据
以下配置的mediaModel是一个有2个清晰度的播放数据，包含2个清晰度1080 和 720
，同时包含2个srt字幕文件，起播的时候会自动播放1080P的链接和加载中文的字幕
//创建MediaModel的构造器
builder = QMediaModelBuilder()
//配置视频元素
builder.addStreamElement(
"", //userType 预留字段可以填空
QURLType.QAUDIO_AND_VIDEO, //资源的类型，指该元素是包含音频还是视频还是都包含
1080, //清晰度数值标记
"http://demo-videos.qnsdk.com/qiniu-1080p.mp4", //视频的地址
true //是否是默认元素，默认元素是指，起播的时候默认会播放这个元素
)
builder.addStreamElement(
"", //userType 预留字段可以填空
QURLType.QAUDIO_AND_VIDEO, //资源的类型，指该元素是包含音频还是视频还是都包含
720, //清晰度数值标记
"http://demo-videos.qnsdk.com/qiniu-720p.mp4", //视频的地址
false //是否是默认元素，默认元素是指，起播的时候默认会播放这个元素
)
builder.addSubtitleElement("中文", //字幕名称（唯一的key）
"http://demo-videos.qnsdk.com/qiniu-2023-chinese.srt", //srt字幕地址
true) //是否是默认字幕 默认元素是指，起播的时候默认加载这个字幕
builder.addSubtitleElement("英文",
"http://demo-videos.qnsdk.com/qiniu-2023-english.srt",
false)
val mediaModel = builder.build(false) //此处的参数指代该资源是否是一个直播资源，是直播的话就是true,不是直播就是false
以下配置的mediaModel是一个音频和视频分成2路url的的播放数据 ，起播的时候会同时播放这两个元素
builder = QMediaModelBuilder()
builder.addStreamElement(
"", //userType 预留字段可以填空
QURLType.QAUDIO, //资源的类型，这里的url对应的资源只有音频所以这里用QAUDIO
100, //清晰度数值标记为100
"http://demo-videos.qnsdk.com/only-audio.m4s", //资源地址
true //是否是默认元素，默认元素是指，起播的时候默认会播放这个元素
)
builder.addStreamElement(
"", //userType 预留字段可以填空
QURLType.QVIDEO, //资源的类型，这里的url对应的资源只有视频所以这里用QVIDEO
1080, //清晰度数值标记为1080
"http://demo-videos.qnsdk.com/only-video-1080p-60fps.m4s", //资源地址
true //是否是默认元素，此处也是默认播放，所以也是true
)
val mediaModel = builder.build(false) //此处的参数指代该资源是否是一个直播资源，是直播的话就是true,不是直播就是false
addStreamElement方法的所有参数
参数名 | 参数含义
---|---
userType | 用户自定义Type，目前预留，可以填空字符串
urlType | 媒体的资源属性 只包含视频/只包含音频/同时有视频音频
quality | 清晰度
url | 资源地址
isSelected | 是否起播时播放该流
backupUrl | 备用地址
referer | http/https 协议的地址 支持该属性 用于防盗链referer参数
videoRenderType | 视频的渲染类型，默认是QVideoRenderType.PLANE, 如果是VR视频此处为QVideoRenderType.PANORAMA_EQUIRECT_ANGULAR
hlsDrmKey | 私有DRM解密的key，用在私有hls加密视频播放的场景中
mp4DrmKey | mp4 drm 的解密 key 用于 CENC-AES-CTR 加密的视频播放场景中
mp4QNDrmComKey | mp4 七牛私有 drm 的解密 comkey 用于七牛私有 mp4 加密的视频播放场景中
mp4QNDrmFileKey | mp4 七牛私有 drm 的解密 filekey 用于七牛私有 mp4 加密的视频播放场景中
## MP4 加密
目前 QPlayer2 仅支持显式的 CENC-AES-CTR 加密，暂不支持隐式加密。CENC-AES-CTR 的初始化向量(IV)
由加密工具随机生成并存储在加密后的 MP4 文件中，QPlayer2 读取 MP4 文件的 IV 和QmediaModel 存储的 mp4DrmKey
进行解密。
### 配置DRM加密视频
//七牛私有HLS解密密钥
builder = QMediaModelBuilder()
url = "http://80rjmu.com1.z0.glb.clouddn.com/ncyY3ioGAakS-Lg252IscrXNxyo=/Fgny-rvibYqoFP-lPkI53JfmoIx5"
builder.addStreamElement("", QURLType.QAUDIO_AND_VIDEO, 0, url, true, "", "", QVideoRenderType.PLANE, "testtesttesttest")
mVideoList.add(Pair(url, builder.build(false)))
//公有MP4解密密钥
builder = QMediaModelBuilder()
url = "https://sdk-release.qnsdk.com/CENC_AES-CTR.mp4"
builder.addStreamElement("", QURLType.QAUDIO_AND_VIDEO, 0, url, true, "", "", QVideoRenderType.PLANE, "", "c7e16c4403654b85847037383f0c2db3")
mVideoList.add(Pair(url, builder.build(false)))
//私有MP4解密密钥
builder = QMediaModelBuilder()
url = "https://kodo.koafun.com/drm-16884581530881688458153078-new.mp4"
builder.addStreamElement("", QURLType.QAUDIO_AND_VIDEO, 0, url, true, "", "", QVideoRenderType.PLANE, "", "", "comnew", "filenew")
mVideoList.add(Pair(url, builder.build(false)))
### 对 MP4 文件进行 CENC-AES-CTR 加密
可以选择 ffmpeg 对一个 MP4 进行加密。加密命令如下：
ffmpeg -i test2.mp4 -vcodec copy -acodec copy -encryption_scheme cenc-aes-ctr -encryption_key c7e16c4403654b85847037383f0c2db3 -encryption_kid a7e61c373e219033c21091fa607bf3b8 encrypted_IV_test.mp4
命令说明
test2.mp4 为输入文件
encrypted_IV_test.mp4 为输出文件
-vcodec copy 和 -acodec copy ：指定视频流和音频流的编码方式为原始流的拷贝，即不进行重新编码，保持与原始文件相同的编码格式。
-encryption_scheme cenc-aes-ctr ：设置加密方案为 CENC-AES-CTR，即采用 CTR 模式进行加密。
-encryption_key c7e16c4403654b85847037383f0c2db3 指定加密所使用的密钥，即解密所使用的 key。这里的c7e16c4403654b85847037383f0c2db3 是一个示例密钥，您可以替换为您自己的密钥，格式要求为：16字节的16进制数据。
-encryption_kid a7e61c373e219033c21091fa607bf3b8：指定加密所使用的密钥标识符（KID）。这里的 a7e61c373e219033c21091fa607bf3b8 是一个示例 KID，您可以替换为您自己的密钥标识符, 格式要求为：16字节的16进制数据。
加密后可通过ffplay 4.4 版本进行播放验证，播放正常即可。命令如下：
ffplay encrypted_IV_test.mp4 -decryption_key c7e16c4403654b85847037383f0c2db3
### QPlayer2 对加密后 MP4 文件进行播放
builder = QMediaModelBuilder()
//配置视频元素
builder.addStreamElement(
"", //userType 预留字段可以填空
QURLType.QAUDIO_AND_VIDEO, //资源的类型，指该元素是包含音频还是视频还是都包含
1080, //清晰度数值标记
"https://sdk-release.qnsdk.com/CENC_AES-CTR.mp", //视频的地址
true //是否是默认元素，默认元素是指，起播的时候默认会播放这个元素
"c7e16c4403654b85847037383f0c2db3" //mp4 解密使用的秘钥
)
val mediaModel = builder.build(false) //此处的参数指代该资源是否是一个直播资源，是直播的话就是true,不是直播就是false //预留字段，可以为
## 视频URL类型枚举
QAUDIO_AND_VIDEO(0), //包含视频和音频
QAUDIO(1), //仅包含音频
QVIDEO(2), //仅包含视频
NONE(5); //无
## 播放媒体资源
上一步中我们创建了一些mediaModel，接下来我们将播放他们
mQPlayerView.playerControlHandler.playMediaModel(
mediaModel, //要播放的媒体资源
0 //起播的位置，如果是直播这里必须为0，不然有不可预见的问题发生
)
## 播放错误监听
当视频起播时，如果遇到网络等问题原因，导致没有和服务器建立链接，那么会导致视频播放失败，总共会有3次重试机会，3次都失败的情况下会回调onOpenFailed方法
当视频已经起播后，在中途遇到网络等问题原因，进入buffer,
那么内核会一直重试，直到再次连接上服务端继续播放，或者用户通过接口停止播放该视频，在重试的过程中
onReconnectStart/onReconnectEnd会被回调，那么可以监控回调的次数来做业务层的结束播放的策略，当然在正常播放的情况下，这两个方法也是会被回调的，所以
最好结合buffer的回调数据一起使用。
val listener = object: QIPlayerMediaNetworkListener {
/***
* 开始重连
*
* @param userType 重连stream element的userType
* @param urlType 重连stream element的urlType
* @param url 重连的url
* @param retryTime 已重试的次数
*/
override fun onReconnectStart(userType: String, urlType: QURLType, url: String, retryTime: Int) {
}
/***
* 重连结束
*
* @param userType 重连stream element的userType
* @param urlType 重连stream element的urlType
* @param url 重连的url
* @param retryTime 已重试的次数
* @param error 错误码
*/
override fun onReconnectEnd(userType: String, urlType: QURLType, url: String, retryTime: Int, error: OpenError) {
}
/***
* 打开失败
*
* @param userType 重连stream element的userType
* @param urlType 重连stream element的urlType
* @param url 重连的url
* @param error 错误码
*/
override fun onOpenFailed(userType: String, urlType: QURLType, url: String, error: OpenError) {
//当非用户中断时，才展示错误面板
if (error != QIPlayerMediaNetworkListener.OpenError.INTERRUPT) {
//展示错误面板
}
}
}
//添加监听
mQPlayerView.playerControlHandler.addPlayerMediaNetworkListener(listener)
//移除监听
mQPlayerView.playerControlHandler.removePlayerMediaNetworkListener(listener)
//移除所有监听
mQPlayerView.playerControlHandler.removeAllPlayerMediaNetworkListener()
## 播放错误码枚举
UNKOWN(10000),
NONE(0),
IOERROR(-5),
INTERRUPT(-1414092869),
URL_INVALID(-875574520),
FORMAT_INVALID(-1094995529);
# SRT字幕
要使用SRT字幕需要满足四个条件
1. 视频源配置了字幕（配置方式参阅播放条目）
2. 字幕功能开启`mQPlayerView.playerControlHandler.setSubtitleEnable(true)`
3. 有生效的字幕（以下方式二选一）
* 在视频源配置了`isDefault=True`的字幕启动播放
* 通过接口设置生效字幕 `mQPlayerView.playerControlHandler..setSubtitle(subtitleName)`
4. 通过字幕回调监听，每当时间轴触发了新的字幕条目，则该监听会回调，并将最新的一条字幕文案传递给监听接口，用户可以以自己的展示方式来展示这条字幕条目
## 字幕回调监听
val listener = object: QIPlayerSubtitleListener {
//text:最新的字幕条目
override fun on_subtitle_text_change(text: String) {
//更新字幕文案展示
}
//name:字幕的名称
override fun on_subtitle_name_change(name: String) {
//字幕变更回调
}
override fun on_subtitle_close() {
//字幕能力关闭
}
//name:字幕的名称
//result:加载的结果
override fun on_subtitle_loaded(name: String, result: Boolean) {
//字幕加载结束
}
//name:字幕的名称
//result:解析的结果
override fun on_subtitle_decoded(name: String, result: Boolean) {
//字幕解析结束
}
}
//添加监听
mQPlayerView.playerControlHandler.addPlayerSubtitleListener(listener)
//移除监听
mQPlayerView.playerControlHandler.removePlayerSubtitleListener(listener)
//移除所有监听
mQPlayerView.playerControlHandler.removeAllPlayerSubtitleListeners()
# 预加载
播放预加载实例用于点播（一般用在短视频场景中），不能用在直播上，播放预加载实例能提升首帧的速度。
预加载的加载时机策略由业务层自行实现
## 预加载的简单使用
//创建预加载实例,一般是提前创建
mediaItem = QMediaItemContext(mediaModel, logLevel, localStorageDir, startPos)
//开始预加载
mediaItem.playMediaControlHandler.start()
//在需要播放时调用播放预加载实例接口
mQPlayerView.playerControlHandler.playMediaItem(mediaItem)
//播放完成后
停止预加载实例
mediaItem.playMediaControlHandler.stop()
## 预加载实例状态枚举
NONE(100) //初始状态
PREPARE(101) //开始加载前，准备工作状态
LOADING(102) //开始加载
PAUSED(103) //暂停加载
STOPED(104) //停止加载, 无法恢复
ERROR(105) //加载出错
PREPARE_USE(106) //准备使用播放
USED(107) //已经使用
DISCARD(108) //废弃
## 预加载实例状态监听
val listener = object: QIMediaItemStateChangeListener {
//状态变更回调时回调，返回变更后的状态
override fun onStateChanged(state: QMediaItemState) {
}
}
//添加监听
mediaItem.playMediaControlHandler.addMediaItemStateChangeListener(listener)
//移除监听
mediaItem.playMediaControlHandler.removeMediaItemStateChangeListener(listener)
//移除所有监听
mediaItem.playMediaControlHandler.removeAllPlayMediaStateChangeListener()
## 预加载的状态枚举
NONE(100),//初始状态
PREPARE(101),
LOADING(102),
PAUSED(103),
STOPED(104),
ERROR(105),
PREPARE_USE(106),
USED(107),
DISCARD(108);
# 设置日志等级
mQPlayerView.playerControlHandler.setLogLevel(QLogLevel.LOG_INFO)
# 暂停播放
mQPlayerView.playerControlHandler.pauseRender()
# 恢复播放
mQPlayerView.playerControlHandler.resumeRender()
# 停止当前视频播放
mQPlayerView.playerControlHandler.stop()
# 鉴权
鉴权功能介绍见鉴权[相关文档 __](https://developer.qiniu.io/pili/12223/qplayer2-core-
authentication-related)
## 强制网络鉴权
调用该接口时，会强制进行网络鉴权
mQPlayerView.playerControlHandler.forceAuthenticationFromNetwork()
## 鉴权监听
val listener = object: QIPlayerAuthenticationListener {
/**
* 鉴权失败回调，同时，会停止当前的视频播放，且状态切换成 @see[QPlayerState.ERROR]
*/
fun on_authentication_failed(error_type: QAuthenticationErrorType) {
}
/**
* 鉴权成功回调
*/
fun on_authentication_success() {
}
}
//添加监听
mQPlayerView.playerControlHandler.addPlayerAuthenticationListener(listener)
//移除监听
mQPlayerView.playerControlHandler.removePlayerAuthenticationListener(listener)
//移除所有监听
mQPlayerView.playerControlHandler.removeAllPlayerAuthentications()
## 鉴权错误码枚举
NONE(0), //鉴权出错
NO_BASE_AUTH(1), //缺少基础功能权限
NO_VR_AUTH(2), //缺少VR功能权限
NO_BLIND_AUTH(3),//缺少色盲功能权限
NO_SEI_AUTH(4), //缺少SEI功能权限
NO_SRT_AUTH(5); //缺少SRT功能权限
# 切换视频进度
mQPlayerView.playerControlHandler.seek(2000) //参数为要定位的position 单位毫秒
## Seek监听
一般情况下
Seek都会成功，如果网络差的情况下，会无限loading（除非调用stop才会停止），直到seek到指定的位置为止。但是如果视频源本身是格式不正确的，比如pts错乱等问题，才会导致seek失败，所以在seek失败回调中，做好提示工作就好，不要尝试再次seek
val listener = object: QIPlayerSeekListener {
/*seek失败回调*/
override fun onSeekFailed() {
}
/*seek成功回调*/
override fun onSeekSuccess() {
}
}
//添加监听
mQPlayerView.playerControlHandler.addPlayerSeekListener(listener)
//移除监听
mQPlayerView.playerControlHandler.removePlayerSeekListener(listener)
//移除所有监听
mQPlayerView.playerControlHandler.removeAllPlayerSeekListener()
# 视频解码方式
目前支持的解码方式有:软解、硬解、混解、自动，一般情况下，使用自动，内核会根据手机的硬件情况，要播放的视频资源编码格式等信息，挑选
合适的解码方式进行解码，各个解码方式的优劣情况如下
软解: 解码较慢，但是兼容性好，适用于所有手机
硬解：解码性能高，但是有一定兼容性，比如某些视频资源的编码格式，硬解芯片不支持。并且相对于软解，首帧的速度慢。
混解：通过软解和硬解相结合的方式，提升首帧速度，加快了解码性能，但是在能耗上略有劣势。
## 设置优先选择哪种解码方式
//下一次播放生效
//最终的解码方式可能不是设置的，在设置的解码方式不能正确解码时，内核会进行降级，选择其他能正确解码的方式
mQPlayerView.playerControlHandler.setDecodeType(QPlayerSetting.QPlayerDecoder.QPLAYER_DECODER_SETTING_AUTO)
## 优先选择的解码方式枚举
//自动选择
QPLAYER_DECODER_SETTING_AUTO(0),
//硬解优先
QPLAYER_DECODER_SETTING_HARDWARE_PRIORITY(1),
//软解优先
QPLAYER_DECODER_SETTING_SOFT_PRIORITY(2),
//混解优先
QPLAYER_DECODER_SETTING_FIRST_FRAME_ACCEL_PRIORITY(3),
## 播放器视频解码监听相关
val listener = object: QIPlayerVideoDecodeListener {
//setDecodeType 设置了优先使用哪种解码方式，经过内核处理后，该回调将正真的视频解码方式返回
override fun onVideoDecodeByType(type: QPlayerDecodeType) {
}
// 如果当前视频编码 所在设备或者sdk不支持 则回调该方法
// codecId 视频的编码id
override fun notSupportCodecFormat(codecId: Int) {
}
/**
* 通知当前视频解码失败，
* @param retry 底层是否重试
*/
override fun onDecodeFailed(retry: Boolean) {
}
}
//添加监听
mQPlayerView.playerControlHandler.addPlayerVideoDecodeTypeListener(listener)
//移除监听
mQPlayerView.playerControlHandler.removePlayerVideoDecodeTypeListener(listener)
//移除所有播放器视频解码监听
mQPlayerView.playerControlHandler.removeAllPlayerVideoDecodeTypeListener()
## 解码方式枚举
NONE(0),
//软解
SOFTWARE(1),
//surface 硬解
HARDWARE_SURFACE(10),
//buffer 硬解
HARDWARE_BUFFER(11),
//混解
FIRST_FRAME_ACCEL(2);
# 设置起播方式
//下一次播放生效
mQPlayerView.playerControlHandler.setStartAction(QPlayerSetting.QPlayerStart.QPLAYER_START_SETTING_PLAYING)
## 解码方式枚举
//起播播放
QPLAYER_START_SETTING_PLAYING(0),
//起播暂停在首帧
QPLAYER_START_SETTING_PAUSE(1),
# 设置seek方式
//下一次seek即生效
mQPlayerView.playerControlHandler.setSeekMode(QPlayerSetting.QPlayerSeek.QPLAYER_SEEK_SETTING_NORMAL)
## seek方式枚举
//关键帧seek，每次seek 都seek到离目标位置向前的最近的一个关键帧，耗时少
QPLAYER_SEEK_SETTING_NORMAL(0),
//精准seek，耗时比关键帧seek多，且耗时和视频的gop间隔的大小成正比
QPLAYER_SEEK_SETTING_ACCURATE(1),
# 获取当前播放状态
mQPlayerView.playerControlHandler.currentPlayerState
# 获取当前进度
mQPlayerView.playerControlHandler.currentPosition
# 获取视频时长
mQPlayerView.playerControlHandler.duration
# 获取当前下载速度
mQPlayerView.playerControlHandler.downloadSpeed
# 获取当前缓冲进度
mQPlayerView.playerControlHandler.bufferPositon
# 播放器状态
在整个播放器实例生命周期中，播放会在不同的状态中切换，用户可以通过监听播放器状态，实现上层业务逻辑，
比如在视频播放完时，展示其他视频的推荐页，那么只需监听播放器状态回调，待回调的状态是COMPLETED，则展示推荐页
## 播放器状态枚举
NONE(0),//初始状态
INIT(1),//播放器开始创建各种对象
PREPARE(2),//开始播放一个新视频的时候先进入这个状态，进行一些准备工作
PLAYING(4),//播放中
PAUSED_RENDER(6),//暂停
COMPLETED(7),//播放完成
SEEKING(8), //SEEK
STOPPED(9),//播放停止
ERROR(10),//播放出错
END(11),//播放器释放各种对象完成
MEDIA_ITEM_PREPARE(12), //预加载的Prepare状态，开始播放一个新视频的时候先进入这个状态，进行一些准备工作
RELEASE(13); //播放器结束，且释放各类资源
## 播放器状态变更监听相关
val listener = object: QIPlayerStateChangeListener {
//状态变更回调时回调，返回变更后的状态
override fun onStateChanged(state: QPlayerState) {
}
}
//添加监听
mQPlayerView.playerControlHandler.addPlayerStateChangeListener(listener)
//移除监听
mQPlayerView.playerControlHandler.removePlayerStateChangeListener(listener)
//移除所有监听
mQPlayerView.playerControlHandler.removeAllPlayerStateChangeListener()
# 播放速度
播放速度的调整范围建议在0.25-2.0之间，这样会有一个比较好的效果
## 设置播放速度
//即时播放生效
mQPlayerView.playerControlHandler.setSpeed(1.25f) //参数为倍速值
## 获取当前速度
mQPlayerView.playerControlHandler.speed
## 速度变更监听相关
val listener = object: QIPlayerSpeedListener {
//播放倍速变更回调
override fun onSpeedChanged(speed: Float) {
}
}
//添加监听
mQPlayerView.playerControlHandler.addPlayerSpeedChangeListener(listener)
//移除监听
mQPlayerView.playerControlHandler.removePlayerSpeedChangeListener(listener)
//移除所有监听
mQPlayerView.playerControlHandler.removeAllPlayerSpeedChangeListener()
# 清晰度
QPlayer2提供的清晰度能力是无缝切换清晰度方案，在切换过程中，画面是连续的画面，不会出现类似跳帧的情况。
使用无缝切换清晰度功能，必须在mediaModel中配置多路清晰度，如果使用非immediately方式(即异步方式)时，同时只能有一次切换会话存在，会话结束后，才能切下一次
## 切换视频清晰度
//使用该方法时，mediaModel中需要存在多个StreamElement
mQPlayerView.playerControlHandler.switchQuality(
"", //要切换的StreamElement的userType
QURLType.QAUDIO_AND_VIDEO, //要切换的StreamElement的urltype
1080, //要切换的StreamElement的清晰度数值标记
false //是否immediately方式，true:立即切换过程中会出现卡一下，一般用于直播，false:非立即切换下，切换过程无缝切换，只能用于点播。
)
## 获取当前的清晰度
//使用该方法时，mediaModel中需要存在多个StreamElement，返回清晰度数值标记
mQPlayerView.playerControlHandler.getCurrentQuality(
"", //要查询的StreamElement的userType
QURLType.QAUDIO_AND_VIDEO //要查询的StreamElement的urltype
)
## 获取当前正在切换的清晰度
//获取指定 userType urlType 流正在切换的清晰度（非immediately方式）
mQPlayerView.playerControlHandler.getSwitchingQuality(
"", //要查询的StreamElement的userType
QURLType.QAUDIO_AND_VIDEO //要查询的StreamElement的urltype
)
## 播放器清晰度相关监听
val listener = object: QIPlayerQualityListener {
/**
* 开始清晰度切换
* @param userType 开始切换清晰度的stream element的userType
* @param urlType 开始切换清晰度的stream element的 urlType @see[QURLType]
* @param newQuality 要切到哪路清晰度
* @param oldQuality 切换前的清晰度
*/
override fun onQualitySwitchStart(userType: String, urlType: QURLType, newQuality: Int, oldQuality: Int) {
}
/**
* 清晰度切换完成
* @param userType 开始切换清晰度的stream element的userType
* @param urlType 开始切换清晰度的stream element的urlType @see[QURLType]
* @param newQuality 要切到哪路清晰度
* @param oldQuality 切换前的清晰度
*/
override fun onQualitySwitchComplete(userType: String, urlType: QURLType, newQuality: Int, oldQuality: Int) {
}
/**
* 清晰度切换取消
* @param userType 开始切换清晰度的stream element的userType
* @param urlType 开始切换清晰度的stream element的 urlType @see[QURLType]
* @param newQuality 要切到哪路清晰度
* @param oldQuality 切换前的清晰度
*/
override fun onQualitySwitchCanceled(userType: String, urlType: QURLType, newQuality: Int, oldQuality: Int) {
}
/**
* 清晰度切换失败
* @param userType 开始切换清晰度的url流的userType
* @param urlType 开始切换清晰度的url流的 urlType @see[QURLType]
* @param newQuality 要切到哪路清晰度
* @param oldQuality 切换前的清晰度
*/
override fun onQualitySwitchFailed(userType: String, urlType: QURLType, newQuality: Int, oldQuality: Int) {
}
/**
* 目前仅支持同时有一个清晰度切换，如果前一个还未切换完，再次发起切换 会回调这个函数
* @param userType 开始切换清晰度的url流的userType
* @param urlType 开始切换清晰度的url流的 urlType @see[QURLType]
* @param newQuality 要切到哪路清晰度
* **/
override fun onQualitySwitchRetryLater(userType: String, urlType: QURLType, newQuality: Int) {
}
}
//添加监听
mQPlayerView.playerControlHandler.addPlayerQualityListener(listener)
//移除监听
mQPlayerView.playerControlHandler.removePlayerQualityListener(listener)
//移除所有监听
mQPlayerView.playerControlHandler.removeAllPlayerQualityListener()
## 直播支持多路清晰度切换
无缝切换清晰度方案需要配置以下三个条件
1. 首先切换的模式要选择立即切换即：immediately=true
2. 服务端配置PTS透传，
3. 对应的清晰度要做主动转码设置
如果无法满足以上3个条件，那么建议用最基础的能力来实现清晰度切换，即每个清晰度都是一个media
model，切换时，调用playMediaModel来播放新的清晰度流。
# 播放进度监听
只有在点播的时候 duration 和 progress 才有意义，直播的话这两个值没有参考意义
val listener = object: QIPlayerProgressListener {
/**
* 进度变更回调
* @param duration 总时长 单位毫秒
* @param progress 当前进度 单位毫秒
*/
override fun onProgressChanged(duration: Long, progress: Long) {
}
}
//添加监听
mQPlayerView.playerControlHandler.addPlayerProgressChangeListener(listener)
//移除监听
mQPlayerView.playerControlHandler.removePlayerProgressChangeListener(listener)
//移除所有监听
mQPlayerView.playerControlHandler.removeAllPlayerProgressChangeListener()
# 实时帧率
## 获取当前fps
mQPlayerView.playerControlHandler.fps
## 实时帧率监听
val listener = object: QIPlayerFPSListener {
/**
* fps 改变的回调
* @param fps 帧率
*/
override fun onFPSChanged(fps: Int) {
}
}
//添加监听
mQPlayerView.playerControlHandler.addPlayerFPSChangeListener(listener)
//移除监听
mQPlayerView.playerControlHandler.removePlayerFPSChangeListener(listener)
//移除所有监听
mQPlayerView.playerControlHandler.removeAllPlayerFPSChangeListener()
# 像素格式或者音频sample格式不支持的监听
val listener = object: QIPlayerFormatListener {
/**
* 当前有format 不支持，所以视频没法播放
*/
override fun onFormatNotSupport() {
}
}
//添加监听
mQPlayerView.playerControlHandler.addPlayerFormatListener(listener)
//移除监听
mQPlayerView.playerControlHandler.removePlayerFormatListener(listener)
//移除所有监听
mQPlayerView.playerControlHandler.removeAllPlayerFormatListeners()
# 缓冲拉流监听
val listener = object: QIPlayerDownloadListener {
/**
* 拉流速率改变
* @param speed 单位 b/s（比特每秒）
* @param bufferProgress 缓冲的进度
*/
override onDownloadChanged(speed: Long, bufferProgress: Long) {
}
}
//添加监听
mQPlayerView.playerControlHandler.addPlayerDownloadChangeListener(listener)
//移除监听
mQPlayerView.playerControlHandler.removePlayerDownloadChangeListener(listener)
//移除所有监听
mQPlayerView.playerControlHandler.removeAllPlayerDownloadChangeListener()
# 播放器操作不允许执行监听
在某些状态下，一些操作将不被执行，通过该监听回调上来通知
val listener = object: QIPlayerCommandNotAllowListener {
/**
* 操作不被允许
* @param commandName 操作名称
* @param state 操作被检测时播放器的状态
*/
override fun onCommandNotAllow(commandName: String, state: QPlayerState) {
}
}
//添加监听
mQPlayerView.playerControlHandler.addPlayerCommandNotAllowListener(listener)
//移除监听
mQPlayerView.playerControlHandler.removePlayerCommandNotAllowListener(listener)
//移除所有监听
mQPlayerView.playerControlHandler.removeAllPlayerCommandNotAllowListener()
# buffering 监听
val listener = object: QIPlayerBufferingListener {
/**
* 开始buffering
*/
override fun onBufferingStart() {
//展示buffering UI
}
/**
* 结束buffering
*/
override fun onBufferingEnd() {
//隐藏buffering UI
}
}
//添加监听
mQPlayerView.playerControlHandler.addPlayerBufferingChangeListener(listener)
//移除监听
mQPlayerView.playerControlHandler.removePlayerBufferingChangeListener(listener)
//移除所有监听
mQPlayerView.playerControlHandler.removeAllPlayerBufferingChangeListener()
# 码率
## 获取当前码率
mQPlayerView.playerControlHandler.biteRate
## 实时码率监听
val listener = object: QIPlayerBiteRateListener {
/**
* 码率变换回调
* @param biteRate 比特率， 单位：bps
*/
override fun onBiteRateChanged(biteRate: Long) {
}
}
//添加监听
mQPlayerView.playerControlHandler.addPlayerBiteRateChangeListener(listener)
//移除监听
mQPlayerView.playerControlHandler.removePlayerBiteRateChangeListener(listener)
//移除所有监听
mQPlayerView.playerControlHandler.removeAllPlayerBiteRateChangeListener()
# SEI 数据回调
用户自定义数据可以带在H264或者H265的编码帧里，用于实现一些基于时间轴的业务场景。
开启该功能后，如果视频资源内带有SEI数据 会通过监听接口抛给业务层。
该功能需要单独开通，具体可以联系技术支持咨询。
## 开启 SEI
mQPlayerView.playerControlHandler.setSEIEnable(true)
## SEI 数据监听
val listener = object: QIPlayerSEIDataListener {
/**
* SEI 数据回调，且回调时机为SEI数据所在帧的时间
* @param data SEI 数据
*/
override fun onSEIData(data: ByteArray) {
}
}
//添加监听
mQPlayerView.playerControlHandler.addPlayerSEIDataListener(listener)
//移除监听
mQPlayerView.playerControlHandler.removePlayerSEIDataListener(listener)
//移除所有监听
mQPlayerView.playerControlHandler.removeAllPlayerSEIDataListeners()
# 音频数据上抛相关监听
## 开启音频数据监听
mQPlayerView.playerControlHandler.setAudioDataCallbackEnable(true)
## 音频数据监听
val listener = object: QIPlayerAudioDataListener {
/**
* 音频数据回调
* @param sampleRate 采样率
* @param format 音频位宽
* @param channelNum 声道数
* @param channelLayout 声道布局
* @param data 音频数据
*/
override fun onAudioData(sampleRate: Int, format: QSampleFormat, channelNum: Int, channelLayout:QChannelLayout, data: ByteArray){
}
}
//添加监听
mQPlayerView.playerControlHandler.addPlayerAudioDataListener(listener)
//移除监听
mQPlayerView.playerControlHandler.removePlayerAudioDataListener(listener)
//移除所有监听
mQPlayerView.playerControlHandler.removeAllPlayerAudioDataListeners()
# 视频数据上抛相关监听
## 开启视频数据监听
mQPlayerView.playerControlHandler.setVideoDataCallbackEnable(true)
## 音频数据监听
val listener = object: QIPlayerVideoDataListener {
/***
* 视频数据回调
* @param width 视频宽度
* @param height 视频高度
* @param type 视频数据类型
* @param data 视频数据
*/
override fun onVideoData(width: Int, height: Int, type: QVideoDataType, data: ByteArray) {
}
}
//添加监听
mQPlayerView.playerControlHandler.addPlayerVideoDataListener(listener)
//移除监听
mQPlayerView.playerControlHandler.removePlayerVideoDataListener(listener)
//移除所有监听
mQPlayerView.playerControlHandler.removeAllPlayerVideoDataListeners()
# 渲染相关监听
val listener = object: QIPlayerRenderListener {
//首帧耗时回调 从play 开始到首帧渲染出来的总耗时 单位毫秒
override fun onFirstFrameRendered(elapsedTime: Long) {
}
}
//添加监听
mQPlayerView.playerRenderHandler.addPlayerRenderListener(listener)
//移除监听
mQPlayerView.playerRenderHandler.removePlayerRenderListener(listener)
//移除所有监听
mQPlayerView.playerRenderHandler.removeAllPlayerRenderListener()
# 设置视频渲染比例
mQPlayerView.playerRenderHandler.setRenderRatio(QPlayerSetting.QPlayerRenderRatio.QPLAYER_RATIO_SETTING_AUTO)
## 视频比例枚举
//自动
QPLAYER_RATIO_SETTING_AUTO(1),
//拉升
QPLAYER_RATIO_SETTING_STRETCH(2),
//铺满
QPLAYER_RATIO_SETTING_FULL_SCREEN(3),
//16:9
QPLAYER_RATIO_SETTING_16_9(4),
//4:3
QPLAYER_RATIO_SETTING_4_3(5),
# 设置色觉优化
mQPlayerView.playerControlHandler.setBlindType(QPlayerSetting.QPlayerBlind.QPLAYER_BLIND_SETTING_NONE)
## 色觉优化枚举
//无
QPLAYER_BLIND_SETTING_NONE(0),
//红色盲
QPLAYER_BLIND_SETTING_RED(1),
//绿色盲
QPLAYER_BLIND_SETTING_GREEN(2),
//蓝色盲
QPLAYER_BLIND_SETTING_BLUE(3),
# VR视频播放
在播放VR视频时，需要在mediaModel中配置vr视频的资源
并且将streamElement的videoRenderType设置为QVideoRenderType.PANORAMA_EQUIRECT_ANGULAR
然后通过设置vr视频视角改变视频朝向
该功能需要单独开通，具体可以联系技术支持咨询。
/***
* 设置VR视频的旋转角度
* @param rotateX 横向角度 （360度制）
* @param rotateY 纵向角度 （360度制）
* @return true 设置成功 false 设置失败
*/
mQPlayerView.playerRenderHandler.setPanoramaViewRotate(mCurrentRotationY, -mCurrentRotationX)
## 视频类型枚举
NONE(-1),
//普通视频
PLANE(0),
//ANGULAR类 VR视频
PANORAMA_EQUIRECT_ANGULAR(1),
# 截图
调用截图接口，就会回调截图时的video画面，并以jpeg的格式返回
mQPlayerView.playerControlHandler.shootVideo()
## 截图监听
val listener = object: QIPlayerShootVideoListener {
/**
* 截图成功
*/
override fun onShootSuccessful(
image: ByteArray, //图片的二进制数组
width: Int, //图片的宽
height: Int, //图片的高
type: QIPlayerShootVideoListener.ShootVideoType //图片的类型（jpeg）
) {
//保存截图
//展示截图
}
/**
* 截图失败回调
*/
override fun onShootFailed() {
}
}
//添加监听
mQPlayerView.playerControlHandler.addPlayerShootVideoListener(listener)
//移除监听
mQPlayerView.playerControlHandler.removePlayerShootVideoListener(listener)
//移除所有监听
mQPlayerView.playerControlHandler.removeAllPlayerShootVideoListeners()
# 静音
控制播放器静音，且该静音非系统的声音设置，仅仅只是把播放器设置为静音
/**
@param isMute true: 静音 false：非静音
*/
mQPlayerView.playerControlHandler.setMute(true)
## 静音监听
val listener = object: QIPlayerAudioListener {
//静音改变回调
override fun onMuteChanged(is_mute: Boolean) {
}
}
//添加监听
mQPlayerView.playerControlHandler.addPlayerAudioListener(listener)
//移除监听
mQPlayerView.playerControlHandler.removePlayerAudioListener(listener)
//移除所有监听
mQPlayerView.playerControlHandler.removeAllPlayerAudioListener()
# 视频宽高改变监听
在视频首帧渲染时，会调用该回调，告诉上层当前的视频宽高是多少，如果在这个这个视频播放的生命周期中，宽高改变，那么还会再次调用该回调
val listener = object: QIPlayerVideoFrameSizeChangeListener {
//宽：width 高：height
onVideoFrameSizeChanged(width: Int, height: Int) {
}
}
//添加监听
mQPlayerView.playerControlHandler.addPlayerVideoFrameSizeChangeListener(listener)
//移除监听
mQPlayerView.playerControlHandler.removePlayerVideoFrameSizeChangeListener(listener)
//移除所有监听
mQPlayerView.playerControlHandler.removeAllPlayerVideoFrameSizeChangeListener()
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,542 |
基于Ext的QPlayer2接入指南 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2
Android端](https://developer.qiniu.com/pili/sdk/12214/qplayer2-android) >
基于Ext的QPlayer2接入指南
# 基于Ext的QPlayer2接入指南
最近更新时间: 2022-09-27 16:00:45
基于ext接入QPlayer2,需要依赖2个包 qplayer2-ext 和 qplayer2-core，如何引入到工程里请查阅 [集成准备
__](http://)
使用ext插件前，先要学习[基于qplayer2-core的Qplayer2接入指南 __](http://)。
基于ext接入QPlayer2 有一定的学习门槛，后续的代码一定要按照整体框架规则来写，便于后期维护。
如果掌握了ext的框架使用，就可以专注在业务层面，无需过多考虑非业务层的代码。
对外的demo中的长视频页就是通过ext开发的,本系列指南也将用demo中的长视频来讲解。
# qplayer2-ext 能力介绍
能力 | 亮点 | 备注
---|---|---
场景切换定制 | 当一个播放器有直播点播场景时，且2个场景的业务逻辑完全不同时，通过场景定制，能更丝滑的在2套逻辑中切换 |
播放面板定制 | 统一控制面板的显示隐藏，不同的视频场景中 可快速切换面板 |
播放器上层浮窗定制 | 拥有统一的浮窗展示隐藏动画和布局规范，更快的实现各类弹窗 |
播放器上层手势 | 支持多种手势判定回调，上层只需关心业务逻辑 |
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2
Android端](https://developer.qiniu.com/pili/sdk/12214/qplayer2-android) >
基于Ext的QPlayer2接入指南
# 基于Ext的QPlayer2接入指南
最近更新时间: 2022-09-27 16:00:45
基于ext接入QPlayer2,需要依赖2个包 qplayer2-ext 和 qplayer2-core，如何引入到工程里请查阅 [集成准备
__](http://)
使用ext插件前，先要学习[基于qplayer2-core的Qplayer2接入指南 __](http://)。
基于ext接入QPlayer2 有一定的学习门槛，后续的代码一定要按照整体框架规则来写，便于后期维护。
如果掌握了ext的框架使用，就可以专注在业务层面，无需过多考虑非业务层的代码。
对外的demo中的长视频页就是通过ext开发的,本系列指南也将用demo中的长视频来讲解。
# qplayer2-ext 能力介绍
能力 | 亮点 | 备注
---|---|---
场景切换定制 | 当一个播放器有直播点播场景时，且2个场景的业务逻辑完全不同时，通过场景定制，能更丝滑的在2套逻辑中切换 |
播放面板定制 | 统一控制面板的显示隐藏，不同的视频场景中 可快速切换面板 |
播放器上层浮窗定制 | 拥有统一的浮窗展示隐藏动画和布局规范，更快的实现各类弹窗 |
播放器上层手势 | 支持多种手势判定回调，上层只需关心业务逻辑 |
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,584 |
通过Ext播放视频 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2
Android端](https://developer.qiniu.com/pili/sdk/12214/qplayer2-android) >
[基于Ext的QPlayer2接入指南](https://developer.qiniu.com/pili/sdk/12224/based-on-the-
ext-qplayer2-access-guide) > 通过Ext播放视频
# 通过Ext播放视频
最近更新时间: 2022-09-27 16:00:52
# 通过Ext播放视频
本文讲解demo长视频通过ext将视频播放起来的技术细节。
## 创建数据集
ext中的数据集`CommonPlayerDataSource`是对MediaModel的封装，为了更好的实现业务层的切集逻辑，抽象出来2个对象视频`CommonVideoParams`和播放元素`CommonPlayableParams`，他们是一对多的关系，比如有个场景是一个视频有前贴广告和后贴广告，那么这个视频`CommonVideoParams`就对应3个播放元素`CommonPlayableParams`。
同时，视频`CommonVideoParams`和播放元素`CommonPlayableParams`支持扩展，用户可以继承这两个类，扩展属于自己的业务属性，比如在里视频参数中加上视频标题、
发布者名字等。
##### 继承播放元素参数，此处参数和基类一致
class LongPlayableParams(
mediaModel: QMediaModel, //媒体数据
controlPanelType: String, //该播放元素对应的面板类型
displayOrientation: DisplayOrientation, //视频是竖屏视频还是横屏视频，根据宽高比判定
environmentType: String, //播放元素对应的播放环境(业务逻辑)
startPos: Long //起播位置
): CommonPlayableParams(mediaModel, controlPanelType, displayOrientation, environmentType, startPos) {
}
##### 继承视频参数，此处多了个参数title
class LongVideoParams(
val title: String, //视频标题
id: Long //视频ID，用户设置 需要唯一
): CommonVideoParams(id) {
}
##### 通过一个工厂类来创建`CommonPlayerDataSource`包含一个视频，有多个分辨率
object LongPlayerDataSourceFactory {
fun create(): CommonPlayerDataSource<LongPlayableParams, LongVideoParams> {
val dataSourceBuilder =
CommonPlayerDataSource.DataSourceBuilder<LongPlayableParams, LongVideoParams>()
var videoParams: LongVideoParams
var builder = QMediaModelBuilder()
var url = ""
var name = ""
builder = QMediaModelBuilder()
builder.addElement(
"",
QURLType.QAUDIO_AND_VIDEO,
1080,
"http://demo-videos.qnsdk.com/qiniu-1080p.mp4",
true)
builder.addElement(
"", QURLType.QAUDIO_AND_VIDEO, 720,
"http://demo-videos.qnsdk.com/qiniu-720p.mp4", false
)
builder.addElement(
"", QURLType.QAUDIO_AND_VIDEO, 480,
"http://demo-videos.qnsdk.com/qiniu-480p.mp4", false
)
builder.addElement(
"", QURLType.QAUDIO_AND_VIDEO, 360,
"http://demo-videos.qnsdk.com/qiniu-360p.mp4", false
)
builder.addElement(
"", QURLType.QAUDIO_AND_VIDEO, 240,
"http://demo-videos.qnsdk.com/qiniu-240p.mp4", false
)
name = "1-点播-http-mp4-30fps-多清晰度"
videoParams = LongVideoParams(name, name.hashCode().toLong())
dataSourceBuilder.addVideo(
videoParams,
arrayListOf(
LongPlayableParams(
builder.build(false),
LongControlPanelType.Normal.type,
DisplayOrientation.LANDSCAPE,
LongEnviromentType.LONG.type,
PlayerSettingRespostory.startPosition,
)
)
)
return dataSourceBuilder.build()
}
}
## 初始化播放器
创建完成后，初始化播放器，初始化代码放在onCreate中
//创建数据集
mPlayerDataSource = LongPlayerDataSourceFactory.create()
val config = CommonPlayerConfig.Builder<Any,
Any, LongPlayableParams, LongVideoParams>()
//添加播放环境(后面会介绍)
.addEnviroment(LongEnviromentType.LONG.type, LongPlayerEnviroment())
//设置数据集
.setPlayerDataSource(mPlayerDataSource)
//设置Context
.setContext(this)
//设置视频渲染View的容器
.setRootUIContanier(this, findViewById(R.id.video_container_FL))
//使用surfaceView渲染视频
.enableScreenRender(CommonPlayerConfig.ScreenRenderType.SURFACE_VIEW)
.build()
//创建播放器
mCommonPlayer = CommonPlayer(config)
//播放第一个视频
mPlayerDataSource.getVideoParamsList()[0]?.also {
mCommonPlayer.playerVideoSwitcher.switchVideo(it.id)
}
## 播放第一个视频
//播放第一个视频
mPlayerDataSource.getVideoParamsList()[0]?.also {
mCommonPlayer.playerVideoSwitcher.switchVideo(it.id)
}
## 销毁播放器
当页面退出时，释放播放器
mCommonPlayer.release()
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2
Android端](https://developer.qiniu.com/pili/sdk/12214/qplayer2-android) >
[基于Ext的QPlayer2接入指南](https://developer.qiniu.com/pili/sdk/12224/based-on-the-
ext-qplayer2-access-guide) > 通过Ext播放视频
# 通过Ext播放视频
最近更新时间: 2022-09-27 16:00:52
# 通过Ext播放视频
本文讲解demo长视频通过ext将视频播放起来的技术细节。
## 创建数据集
ext中的数据集`CommonPlayerDataSource`是对MediaModel的封装，为了更好的实现业务层的切集逻辑，抽象出来2个对象视频`CommonVideoParams`和播放元素`CommonPlayableParams`，他们是一对多的关系，比如有个场景是一个视频有前贴广告和后贴广告，那么这个视频`CommonVideoParams`就对应3个播放元素`CommonPlayableParams`。
同时，视频`CommonVideoParams`和播放元素`CommonPlayableParams`支持扩展，用户可以继承这两个类，扩展属于自己的业务属性，比如在里视频参数中加上视频标题、
发布者名字等。
##### 继承播放元素参数，此处参数和基类一致
class LongPlayableParams(
mediaModel: QMediaModel, //媒体数据
controlPanelType: String, //该播放元素对应的面板类型
displayOrientation: DisplayOrientation, //视频是竖屏视频还是横屏视频，根据宽高比判定
environmentType: String, //播放元素对应的播放环境(业务逻辑)
startPos: Long //起播位置
): CommonPlayableParams(mediaModel, controlPanelType, displayOrientation, environmentType, startPos) {
}
##### 继承视频参数，此处多了个参数title
class LongVideoParams(
val title: String, //视频标题
id: Long //视频ID，用户设置 需要唯一
): CommonVideoParams(id) {
}
##### 通过一个工厂类来创建`CommonPlayerDataSource`包含一个视频，有多个分辨率
object LongPlayerDataSourceFactory {
fun create(): CommonPlayerDataSource<LongPlayableParams, LongVideoParams> {
val dataSourceBuilder =
CommonPlayerDataSource.DataSourceBuilder<LongPlayableParams, LongVideoParams>()
var videoParams: LongVideoParams
var builder = QMediaModelBuilder()
var url = ""
var name = ""
builder = QMediaModelBuilder()
builder.addElement(
"",
QURLType.QAUDIO_AND_VIDEO,
1080,
"http://demo-videos.qnsdk.com/qiniu-1080p.mp4",
true)
builder.addElement(
"", QURLType.QAUDIO_AND_VIDEO, 720,
"http://demo-videos.qnsdk.com/qiniu-720p.mp4", false
)
builder.addElement(
"", QURLType.QAUDIO_AND_VIDEO, 480,
"http://demo-videos.qnsdk.com/qiniu-480p.mp4", false
)
builder.addElement(
"", QURLType.QAUDIO_AND_VIDEO, 360,
"http://demo-videos.qnsdk.com/qiniu-360p.mp4", false
)
builder.addElement(
"", QURLType.QAUDIO_AND_VIDEO, 240,
"http://demo-videos.qnsdk.com/qiniu-240p.mp4", false
)
name = "1-点播-http-mp4-30fps-多清晰度"
videoParams = LongVideoParams(name, name.hashCode().toLong())
dataSourceBuilder.addVideo(
videoParams,
arrayListOf(
LongPlayableParams(
builder.build(false),
LongControlPanelType.Normal.type,
DisplayOrientation.LANDSCAPE,
LongEnviromentType.LONG.type,
PlayerSettingRespostory.startPosition,
)
)
)
return dataSourceBuilder.build()
}
}
## 初始化播放器
创建完成后，初始化播放器，初始化代码放在onCreate中
//创建数据集
mPlayerDataSource = LongPlayerDataSourceFactory.create()
val config = CommonPlayerConfig.Builder<Any,
Any, LongPlayableParams, LongVideoParams>()
//添加播放环境(后面会介绍)
.addEnviroment(LongEnviromentType.LONG.type, LongPlayerEnviroment())
//设置数据集
.setPlayerDataSource(mPlayerDataSource)
//设置Context
.setContext(this)
//设置视频渲染View的容器
.setRootUIContanier(this, findViewById(R.id.video_container_FL))
//使用surfaceView渲染视频
.enableScreenRender(CommonPlayerConfig.ScreenRenderType.SURFACE_VIEW)
.build()
//创建播放器
mCommonPlayer = CommonPlayer(config)
//播放第一个视频
mPlayerDataSource.getVideoParamsList()[0]?.also {
mCommonPlayer.playerVideoSwitcher.switchVideo(it.id)
}
## 播放第一个视频
//播放第一个视频
mPlayerDataSource.getVideoParamsList()[0]?.also {
mCommonPlayer.playerVideoSwitcher.switchVideo(it.id)
}
## 销毁播放器
当页面退出时，释放播放器
mCommonPlayer.release()
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,586 |
通过Ext 为视频区域添加面板 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2
Android端](https://developer.qiniu.com/pili/sdk/12214/qplayer2-android) >
[基于Ext的QPlayer2接入指南](https://developer.qiniu.com/pili/sdk/12224/based-on-the-
ext-qplayer2-access-guide) > 通过Ext 为视频区域添加面板
# 通过Ext 为视频区域添加面板
最近更新时间: 2022-09-27 16:00:59
# 通过Ext 为视频区域添加面板
视频区域的面板通常作为操作面板出现，比如暂停/播放，进度条，选集等操作控件都会展示在面板上。在通常视频播放场景中，视频在半屏播放和全屏播放时，面板的样式是不一样的，并且面板在视频播放但没有操作输入时，在一段时间内会自动隐藏，直到用户触碰视频区域，面板才会再次显示，下面我们针对面板的这些特性，讲讲Ext中面板的使用。
## 布局一个半屏场景下的横屏视频面板
### 暂停播放按钮
这里的暂停播放按钮是一个图片，所以会这里是用`AppCompatImageView`，所有面板上的控件都是继承自`IControlWidget`,
class CommonPlayerPausePlayWidget : AppCompatImageView, View.OnClickListener,
IControlWidget<LongLogicProvider, LongPlayableParams, LongVideoParams> {
//播放核心类，一切的播放器操作都是通过这个对象
private lateinit var mPlayerCore: CommonPlayerCore<LongLogicProvider, LongPlayableParams, LongVideoParams>
//播放器状态变更回调
private val mPlayerStateChangeListener = object : QIPlayerStateChangeListener {
override fun onStateChanged(state: QPlayerState) {
//播放器状态变更时，变更UI
updateIcon(state)
}
}
constructor(context: Context) : super(context) {
}
constructor(context: Context, attrs: AttributeSet?) : super(context, attrs) {
}
constructor(context: Context, attrs: AttributeSet?, defStyleAttr: Int) : super(
context,
attrs,
defStyleAttr
) {
}
private fun updateIcon(state: QPlayerState) {
//播放状态时，按钮展示暂停
if (state == QPlayerState.PLAYING) {
setImageResource(R.drawable.qmedia_player_pause_vector)
}//非播放状态时，按钮展示播放
else if (state == QPlayerState.PAUSED_RENDER ||
state == QPlayerState.PREPARE ||
state == QPlayerState.INIT ||
state == QPlayerState.NONE
) {
setImageResource(R.drawable.qmedia_player_play_vector)
} //结束状态时，按钮展示重播
else if( state == QPlayerState.COMPLETED) {
setImageResource(R.drawable.qmedia_ic_player_replay_vector)
}
}
override fun onClick(v: View?) {
//根据当前播放状态 处理点击时的行为
val playerState = mPlayerCore.mPlayerContext.getPlayerControlHandler().currentPlayerState
if (playerState == QPlayerState.PLAYING) {
mPlayerCore.mPlayerContext.getPlayerControlHandler().pauseRender()
} else if (playerState == QPlayerState.COMPLETED){
//根据切集控制器重播当前视频
mPlayerCore.mCommonPlayerVideoSwitcher.replayCurrentVideo()
} else {
mPlayerCore.mPlayerContext.getPlayerControlHandler().resumeRender()
}
}
//控件激活(显示)时，绑定事件，并且更新icon
override fun onWidgetActive() {
setOnClickListener(this)
updateIcon(
mPlayerCore.mPlayerContext.getPlayerControlHandler().currentPlayerState)
mPlayerCore.mPlayerContext.getPlayerControlHandler()
.addPlayerStateChangeListener(mPlayerStateChangeListener)
}
//控件不活跃时(隐藏)时，解绑事件，
override fun onWidgetInactive() {
setOnClickListener(null)
mPlayerCore.mPlayerContext.getPlayerControlHandler()
.removePlayerStateChangeListener(mPlayerStateChangeListener)
}
//当播控件初始化时会回调这个方法，在此方法中保存好playerCore 方便后续使用
override fun bindPlayerCore(playerCore: CommonPlayerCore<LongLogicProvider, LongPlayableParams, LongVideoParams>) {
mPlayerCore = playerCore
}
}
### 面板布局
其他控件的实现请参阅demo中长视频的源码实现，这里不一一举例。实现完所有的控件后，我们通过xml来进行布局，布局形式和一般的布局一样，只是用的控件都是我们自己实现的。
<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout
xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto"
android:layout_width="match_parent"
android:layout_height="match_parent">
<com.qiniu.qplayer2.ui.widget.commonplayer.controlwidget.CommonPlayerDownloadTextWidget
android:id="@+id/download_speed_TV"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
app:layout_constraintTop_toTopOf="parent"
app:layout_constraintStart_toStartOf="parent"/>
<com.qiniu.qplayer2.ui.widget.commonplayer.controlwidget.CommonPlayerBiteRateTextWidget
android:id="@+id/biterate_TV"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
app:layout_constraintTop_toTopOf="@+id/download_speed_TV"
app:layout_constraintBottom_toBottomOf="@+id/download_speed_TV"
app:layout_constraintLeft_toRightOf="@+id/download_speed_TV"
android:layout_marginLeft="4dp"/>
<com.qiniu.qplayer2.ui.widget.commonplayer.controlwidget.CommonPlayerFPSTextWidget
android:id="@+id/fps_TV"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
app:layout_constraintTop_toTopOf="@+id/download_speed_TV"
app:layout_constraintBottom_toBottomOf="@+id/download_speed_TV"
app:layout_constraintLeft_toRightOf="@+id/biterate_TV"
android:layout_marginLeft="4dp"/>
<com.qiniu.qplayer2.ui.widget.commonplayer.controlwidget.CommonPlayerPausePlayWidget
android:id="@+id/pause_play_Btn"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
app:layout_constraintBottom_toBottomOf="parent"
app:layout_constraintStart_toStartOf="parent"
android:layout_marginStart="4dp"/>
<com.qiniu.qplayer2.ui.widget.commonplayer.controlwidget.CommonPlayerSeekWidget
android:id="@+id/seek_bar"
android:layout_width="0dp"
android:layout_height="wrap_content"
android:layout_centerVertical="true"
android:minHeight="2dp"
android:maxHeight="4dp"
android:max="1000"
android:thumbOffset="10dp"
app:layout_constraintBottom_toBottomOf="@+id/pause_play_Btn"
app:layout_constraintTop_toTopOf="@+id/pause_play_Btn"
app:layout_constraintStart_toEndOf="@+id/pause_play_Btn"
app:layout_constraintEnd_toStartOf="@+id/progress_TV"/>
<com.qiniu.qplayer2.ui.widget.commonplayer.controlwidget.CommonPlayerProgressTextWidget
android:id="@+id/progress_TV"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_gravity="center"
android:gravity="center"
android:textColor="#FFFFFF"
android:textSize="10sp"
android:textStyle="bold"
app:layout_constraintBottom_toBottomOf="@+id/fullscreen_IV"
app:layout_constraintTop_toTopOf="@+id/fullscreen_IV"
app:layout_constraintRight_toLeftOf="@+id/fullscreen_IV"
android:layout_marginStart="2dp"
android:layout_marginEnd="2dp"/>
<com.qiniu.qplayer2.ui.widget.commonplayer.controlwidget.CommonPlayerFullScreenWidget
android:id="@+id/fullscreen_IV"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:padding="3dp"
app:layout_constraintBottom_toBottomOf="parent"
app:layout_constraintEnd_toEndOf="parent"
app:srcCompat="@drawable/qmedia_ic_player_fullscreen_vector"
android:layout_marginEnd="4dp"/>
</androidx.constraintlayout.widget.ConstraintLayout>
### 将面板布局文件和播放元素绑定
在播放元素切换的时候，基于一些业务场景，可能会出现不同的播放元素需要有不同的面板，所以在这里一般一个播放元素，会对应2个播放面板，一个半屏面板，一个全屏面板。
面板的配置也在config中，此处`DisplayOrientation`是指代视频的宽高比类型，`ScreenType`是指代手机的屏幕方向。
val config = CommonPlayerConfig.Builder<Any,
LongLogicProvider, LongPlayableParams, LongVideoParams>()
.addControlPanel(
ControlPanelConfig(
//面板类型名称-用户自定，用来和播放元素绑定
LongControlPanelType.Normal.type,
arrayListOf(
//一个面板布局的配置
ControlPanelConfigElement(
//布局文件
R.layout.control_panel_halfscreen_landscape_normal,
//对应的屏幕类型(半屏/全屏(横屏全屏/竖屏全屏)/反向全屏(横屏全屏/竖屏全屏))
arrayListOf(ScreenType.HALF_SCREEN),
//对应横屏的视频 还是竖屏的视频
DisplayOrientation.LANDSCAPE)
)
)
)
在`LongPlayableParams`有2个参数一个是`displayOrientation: DisplayOrientation`
和`controlPanelType:
String`通过这两个参数播放元素就和面版绑定了，然后再根据手机的屏幕方向展示对应的面板`ControlPanelConfigElement`
### 半屏全屏面板切换
首先我们为视频元素再创建个横屏视频的全屏面板。
<?xml version="1.0" encoding="utf-8"?>
<com.qiniu.qplayer2.ui.widget.commonplayer.controlwidget.CommonPlayerInsetControllerWidget
xmlns:android="http://schemas.android.com/apk/res/android"
android:layout_width="match_parent"
android:layout_height="match_parent"
xmlns:app="http://schemas.android.com/apk/res-auto"
xmlns:tools="http://schemas.android.com/tools"
app:topBackground="@mipmap/common_player_control_panel_shape_shadow_top"
app:topBackgroundHeight="140dp"
app:bottomBackground="@mipmap/common_player_control_panel_shape_shadow_bottom"
app:bottomBackgroundHeight="150dp"
app:contentLeftPadding="16dp"
tools:ignore="VectorDrawableCompat">
<com.qiniu.qplayer2.ui.widget.commonplayer.controlwidget.CommonPlayerBackWidget
android:id="@+id/back_IV"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
app:layout_constraintTop_toTopOf="parent"
app:layout_constraintStart_toStartOf="parent"
android:layout_marginStart="12dp"
android:layout_marginTop="12dp"
app:srcCompat="@drawable/qmedia_ic_player_back_vector"/>
<com.qiniu.qplayer2.ui.widget.commonplayer.controlwidget.CommonPlayerDownloadTextWidget
android:id="@+id/download_speed_TV"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
app:layout_constraintTop_toTopOf="@+id/back_IV"
app:layout_constraintBottom_toBottomOf="@+id/back_IV"
app:layout_constraintLeft_toRightOf="@+id/back_IV"
android:layout_marginStart="10dp"
android:paddingStart="11dp"
android:paddingLeft="11dp"
android:paddingEnd="11dp"
android:paddingRight="11dp"
android:gravity="center"
android:singleLine="true"
android:focusable="false"
android:textColor="@color/white"
android:fontFamily="sans-serif-medium"
android:textSize="14sp"/>
<com.qiniu.qplayer2.ui.widget.commonplayer.controlwidget.CommonPlayerBiteRateTextWidget
android:id="@+id/biterate_TV"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
app:layout_constraintTop_toTopOf="@+id/download_speed_TV"
app:layout_constraintBottom_toBottomOf="@+id/download_speed_TV"
app:layout_constraintLeft_toRightOf="@+id/download_speed_TV"
android:layout_marginStart="10dp"
android:paddingStart="11dp"
android:paddingLeft="11dp"
android:paddingEnd="11dp"
android:paddingRight="11dp"
android:gravity="center"
android:singleLine="true"
android:focusable="false"
android:textColor="@color/white"
android:fontFamily="sans-serif-medium"
android:textSize="14sp"/>
<com.qiniu.qplayer2.ui.widget.commonplayer.controlwidget.CommonPlayerFPSTextWidget
android:id="@+id/fps_TV"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
app:layout_constraintTop_toTopOf="@+id/download_speed_TV"
app:layout_constraintBottom_toBottomOf="@+id/download_speed_TV"
app:layout_constraintLeft_toRightOf="@+id/biterate_TV"
android:layout_marginStart="10dp"
android:paddingStart="11dp"
android:paddingLeft="11dp"
android:paddingEnd="11dp"
android:paddingRight="11dp"
android:gravity="center"
android:singleLine="true"
android:focusable="false"
android:textColor="@color/white"
android:fontFamily="sans-serif-medium"
android:textSize="14sp"/>
<com.qiniu.qplayer2.ui.widget.commonplayer.controlwidget.CommonPlayerMoreSettingWidget
android:id="@+id/setting_IV"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
app:layout_constraintTop_toTopOf="parent"
app:layout_constraintEnd_toEndOf="parent"
android:layout_marginTop="12dp"
android:layout_marginEnd="12dp"
android:paddingStart="11dp"
android:paddingLeft="11dp"
android:paddingEnd="11dp"
android:paddingRight="11dp"/>
<com.qiniu.qplayer2.ui.widget.commonplayer.controlwidget.CommonPlayerProgressTextWidget
android:id="@+id/progress_TV"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_gravity="center"
android:gravity="center"
android:textColor="#FFFFFF"
android:textSize="10sp"
android:textStyle="bold"
app:layout_constraintBottom_toTopOf="@+id/pause_play_Btn"
app:layout_constraintStart_toStartOf="parent"
android:layout_marginStart="12dp"
android:layout_marginBottom="8dp"/>
<com.qiniu.qplayer2.ui.widget.commonplayer.controlwidget.CommonPlayerSeekWidget
android:id="@+id/seek_bar"
android:layout_width="0dp"
android:layout_height="wrap_content"
android:layout_centerVertical="true"
android:minHeight="2dp"
android:maxHeight="4dp"
android:max="1000"
android:thumbOffset="10dp"
app:layout_constraintBottom_toBottomOf="@+id/progress_TV"
app:layout_constraintTop_toTopOf="@+id/progress_TV"
app:layout_constraintStart_toEndOf="@+id/progress_TV"
app:layout_constraintEnd_toEndOf="parent"
android:layout_marginEnd="4dp"/>
<com.qiniu.qplayer2.ui.widget.commonplayer.controlwidget.CommonPlayerPausePlayWidget
android:id="@+id/pause_play_Btn"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
app:layout_constraintBottom_toBottomOf="parent"
app:layout_constraintStart_toStartOf="parent"
android:layout_marginStart="12dp"
android:layout_marginEnd="2dp"
android:layout_marginBottom="12dp"/>
<com.qiniu.qplayer2.ui.widget.commonplayer.controlwidget.CommonPlayerSelectVideoWidget
android:id="@+id/select_video_TV"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
app:layout_constraintEnd_toStartOf="@+id/select_speed_TV"
app:layout_constraintTop_toTopOf="@+id/pause_play_Btn"
app:layout_constraintBottom_toBottomOf="@+id/pause_play_Btn"
android:layout_marginEnd="10dp"
android:paddingStart="11dp"
android:paddingLeft="11dp"
android:paddingEnd="11dp"
android:paddingRight="11dp"
android:gravity="center"
android:singleLine="true"
android:focusable="false"
android:textColor="@color/white"
android:fontFamily="sans-serif-medium"
android:textSize="14sp"/>
<com.qiniu.qplayer2.ui.widget.commonplayer.controlwidget.CommonPlayerSelectSpeedWidget
android:id="@+id/select_speed_TV"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
app:layout_constraintEnd_toStartOf="@+id/select_quality_TV"
app:layout_constraintTop_toTopOf="@+id/pause_play_Btn"
app:layout_constraintBottom_toBottomOf="@+id/pause_play_Btn"
android:layout_marginEnd="10dp"
android:paddingStart="11dp"
android:paddingLeft="11dp"
android:paddingEnd="11dp"
android:paddingRight="11dp"
android:gravity="center"
android:singleLine="true"
android:focusable="false"
android:textColor="@color/white"
android:fontFamily="sans-serif-medium"
android:textSize="14sp"
/>
<com.qiniu.qplayer2.ui.widget.commonplayer.controlwidget.CommonPlayerSelectQualityWidget
android:id="@+id/select_quality_TV"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
app:layout_constraintEnd_toEndOf="parent"
app:layout_constraintTop_toTopOf="@+id/pause_play_Btn"
app:layout_constraintBottom_toBottomOf="@+id/pause_play_Btn"
android:layout_marginEnd="10dp"
android:paddingStart="11dp"
android:paddingLeft="11dp"
android:paddingEnd="11dp"
android:paddingRight="11dp"
android:gravity="center"
android:singleLine="true"
android:focusable="false"
android:textColor="@color/white"
android:fontFamily="sans-serif-medium"
android:textSize="14sp"/>
</com.qiniu.qplayer2.ui.widget.commonplayer.controlwidget.CommonPlayerInsetControllerWidget>
在config中将其配置成横屏视频的全屏面板
val config = CommonPlayerConfig.Builder<Any,
LongLogicProvider, LongPlayableParams, LongVideoParams>()
.addControlPanel(
ControlPanelConfig(
LongControlPanelType.Normal.type,
arrayListOf(
ControlPanelConfigElement(
R.layout.control_panel_halfscreen_landscape_normal,
arrayListOf(ScreenType.HALF_SCREEN),
DisplayOrientation.LANDSCAPE),
ControlPanelConfigElement(
R.layout.control_panel_fullscreen_landscape_normal,
arrayListOf(ScreenType.FULL_SCREEN, ScreenType.REVERSE_FULL_SCREEN),
DisplayOrientation.LANDSCAPE)
)
)
)
因为半屏转全屏，除了面板会变化，横屏视频全屏时，`activity`的`requestedOrientation`也需要修改成`SCREEN_ORIENTATION_LANDSCAPE`，那么这里的逻辑在EXT中已经实现，但是对于`activity`和window上的属性，比如statusbar的改变，还有视频view的容器，因为每个应用自己的规则，需要用户继承`ICommonPlayerScreenChangedListener`自行实现
以下是长视频demo中的实现，当切换全屏时，需要把视频view的容器宽高设置成`MATCH_PARENT`，同时把statusbar设置成透明，还有针对刘海屏的处理
class LongCommonPlayerScreenChangedListener(
private val mActivity: ComponentActivity,
private val mVideoContainer: ViewGroup
) : ICommonPlayerScreenChangedListener {
override fun onScreenTypeChanged(screenType: ScreenType) {
if (screenType == ScreenType.HALF_SCREEN) {
if (Build.VERSION.SDK_INT < Build.VERSION_CODES.R) {
mActivity.window.clearFlags(WindowManager.LayoutParams.FLAG_FULLSCREEN)
} else {
mActivity.window.insetsController?.show(WindowInsetsCompat.Type.statusBars())
}
mVideoContainer.layoutParams.height = DpUtils.dpToPx(200)
mVideoContainer.layoutParams.width = ViewGroup.LayoutParams.MATCH_PARENT
fitSystemWindow(false)
NotchCompat.blockDisplayCutout(mActivity.window)
mVideoContainer.requestLayout()
restoreVideoContainer()
if (NotchCompat.hasDisplayCutout(mActivity.window)) {
if (Build.VERSION.SDK_INT < Build.VERSION_CODES.P && !RomUtils.isSamsungRom()) { //samsuang with cutout device excluded
setStatusBarColor(Color.BLACK)
}
}
} else {
if (Build.VERSION.SDK_INT < Build.VERSION_CODES.R) {
mActivity.window.setFlags(
WindowManager.LayoutParams.FLAG_FULLSCREEN,
WindowManager.LayoutParams.FLAG_FULLSCREEN
)
} else {
mActivity.window.insetsController?.hide(WindowInsetsCompat.Type.statusBars())
}
mVideoContainer.layoutParams.height = ViewGroup.LayoutParams.MATCH_PARENT
mVideoContainer.layoutParams.width = ViewGroup.LayoutParams.MATCH_PARENT
fitSystemWindow(false)
NotchCompat.immersiveDisplayCutout(mActivity.window)
mVideoContainer.requestLayout()
changeVideoContainerToTop()
if (NotchCompat.hasDisplayCutout(mActivity.window) && !RomUtils.isSamsungRom()) {
setStatusBarColor(Color.TRANSPARENT)
}
}
}
private fun changeVideoContainerToTop() {
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP) {
ViewCompat.setElevation(mVideoContainer, 100f)
} else {
mVideoContainer.bringToFront()
}
}
private fun restoreVideoContainer() {
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP) {
ViewCompat.setElevation(mVideoContainer, 0f)
} else {
val parent = mVideoContainer.parent
if (parent is ViewGroup) {
val mOldVideoPageIndex = 0
if (parent.indexOfChild(mVideoContainer) != mOldVideoPageIndex) {
parent.removeView(mVideoContainer)
parent.addView(mVideoContainer, mOldVideoPageIndex)
}
}
}
}
private fun setStatusBarColor(color: Int) {
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP) {
mActivity.window.statusBarColor = color
}
}
private fun fitSystemWindow(landscape: Boolean) {
var rootView: View? = mVideoContainer
while (rootView != null && rootView.id != android.R.id.content) {
if (rootView is ViewGroup) {
rootView.clipToPadding = !landscape
rootView.clipChildren = !landscape
}
rootView = rootView.parent as View
}
}
}
定义完后将它设置到config中
val config = CommonPlayerConfig.Builder<Any,
LongLogicProvider, LongPlayableParams, LongVideoParams>()
.setCommonPlayerScreenChangedListener(LongCommonPlayerScreenChangedListener(this, findViewById(R.id.video_container_FL)))
然后通过全屏按钮进行处理，以下就是半屏面板上的全屏按钮控件的实现
class CommonPlayerFullScreenWidget: AppCompatImageView, View.OnClickListener,
IControlWidget<LongLogicProvider, LongPlayableParams, LongVideoParams> {
private lateinit var mPlayerCore: CommonPlayerCore<LongLogicProvider, LongPlayableParams, LongVideoParams>
constructor(context: Context) : super(context) {
init(context, null)
}
constructor(context: Context, attrs: AttributeSet?) : super(context, attrs) {
init(context, attrs)
}
constructor(context: Context, attrs: AttributeSet?, defStyleAttr: Int) : super(
context,
attrs,
defStyleAttr
) {
init(context, attrs)
}
private fun init(context: Context, attrs: AttributeSet?) {
contentDescription = "bbplayer_halfscreen_expand"
}
override fun onClick(v: View?) {
//点击操作切换成全屏
mPlayerCore.getCommonPlayerScreenHandler()?.switchScreenType(ScreenType.FULL_SCREEN)
}
override fun onWidgetActive() {
setOnClickListener(this)
}
override fun onWidgetInactive() {
setOnClickListener(null)
}
override fun bindPlayerCore(playerCore: CommonPlayerCore<LongLogicProvider, LongPlayableParams, LongVideoParams>) {
mPlayerCore = playerCore
}
}
### 关于DisplayOrientation和ScreenType的逻辑补充
DisplayOrientation参数的影响
* LANDSCAPE：ScreenType切换成FULL_SCREEN时，activity的requestedOrientation会切换成SCREEN_ORIENTATION_LANDSCAPE
* VERTICAL：ScreenType切换成FULL_SCREEN时，activity的requestedOrientation会切换成SCREEN_ORIENTATION_PORTRAIT
所以横屏视频和竖屏视频在配置`LongPlayableParams`时，不一定横屏视频一定是DisplayOrientation.LANDSCAPE
竖屏视频是 DisplayOrientation.VERTICAL，主要是看业务需求上是否要转屏，然后根据业务需求来配置。
### 关于面板的自动隐藏逻辑
因为自动隐藏逻辑可能每个app都有自己的实现，所以隐藏逻辑有业务方自行实现，demo中有一个简单的实现可以参考
com.qiniu.qplayer2.ui.page.longvideo.service.controlpanelcontainervisible.PlayerControlPanelContainerVisibleService
可以在看完[通过Ext为播放器添加业务逻辑 __](http://)后再来读该类的源码
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2
Android端](https://developer.qiniu.com/pili/sdk/12214/qplayer2-android) >
[基于Ext的QPlayer2接入指南](https://developer.qiniu.com/pili/sdk/12224/based-on-the-
ext-qplayer2-access-guide) > 通过Ext 为视频区域添加面板
# 通过Ext 为视频区域添加面板
最近更新时间: 2022-09-27 16:00:59
# 通过Ext 为视频区域添加面板
视频区域的面板通常作为操作面板出现，比如暂停/播放，进度条，选集等操作控件都会展示在面板上。在通常视频播放场景中，视频在半屏播放和全屏播放时，面板的样式是不一样的，并且面板在视频播放但没有操作输入时，在一段时间内会自动隐藏，直到用户触碰视频区域，面板才会再次显示，下面我们针对面板的这些特性，讲讲Ext中面板的使用。
## 布局一个半屏场景下的横屏视频面板
### 暂停播放按钮
这里的暂停播放按钮是一个图片，所以会这里是用`AppCompatImageView`，所有面板上的控件都是继承自`IControlWidget`,
class CommonPlayerPausePlayWidget : AppCompatImageView, View.OnClickListener,
IControlWidget<LongLogicProvider, LongPlayableParams, LongVideoParams> {
//播放核心类，一切的播放器操作都是通过这个对象
private lateinit var mPlayerCore: CommonPlayerCore<LongLogicProvider, LongPlayableParams, LongVideoParams>
//播放器状态变更回调
private val mPlayerStateChangeListener = object : QIPlayerStateChangeListener {
override fun onStateChanged(state: QPlayerState) {
//播放器状态变更时，变更UI
updateIcon(state)
}
}
constructor(context: Context) : super(context) {
}
constructor(context: Context, attrs: AttributeSet?) : super(context, attrs) {
}
constructor(context: Context, attrs: AttributeSet?, defStyleAttr: Int) : super(
context,
attrs,
defStyleAttr
) {
}
private fun updateIcon(state: QPlayerState) {
//播放状态时，按钮展示暂停
if (state == QPlayerState.PLAYING) {
setImageResource(R.drawable.qmedia_player_pause_vector)
}//非播放状态时，按钮展示播放
else if (state == QPlayerState.PAUSED_RENDER ||
state == QPlayerState.PREPARE ||
state == QPlayerState.INIT ||
state == QPlayerState.NONE
) {
setImageResource(R.drawable.qmedia_player_play_vector)
} //结束状态时，按钮展示重播
else if( state == QPlayerState.COMPLETED) {
setImageResource(R.drawable.qmedia_ic_player_replay_vector)
}
}
override fun onClick(v: View?) {
//根据当前播放状态 处理点击时的行为
val playerState = mPlayerCore.mPlayerContext.getPlayerControlHandler().currentPlayerState
if (playerState == QPlayerState.PLAYING) {
mPlayerCore.mPlayerContext.getPlayerControlHandler().pauseRender()
} else if (playerState == QPlayerState.COMPLETED){
//根据切集控制器重播当前视频
mPlayerCore.mCommonPlayerVideoSwitcher.replayCurrentVideo()
} else {
mPlayerCore.mPlayerContext.getPlayerControlHandler().resumeRender()
}
}
//控件激活(显示)时，绑定事件，并且更新icon
override fun onWidgetActive() {
setOnClickListener(this)
updateIcon(
mPlayerCore.mPlayerContext.getPlayerControlHandler().currentPlayerState)
mPlayerCore.mPlayerContext.getPlayerControlHandler()
.addPlayerStateChangeListener(mPlayerStateChangeListener)
}
//控件不活跃时(隐藏)时，解绑事件，
override fun onWidgetInactive() {
setOnClickListener(null)
mPlayerCore.mPlayerContext.getPlayerControlHandler()
.removePlayerStateChangeListener(mPlayerStateChangeListener)
}
//当播控件初始化时会回调这个方法，在此方法中保存好playerCore 方便后续使用
override fun bindPlayerCore(playerCore: CommonPlayerCore<LongLogicProvider, LongPlayableParams, LongVideoParams>) {
mPlayerCore = playerCore
}
}
### 面板布局
其他控件的实现请参阅demo中长视频的源码实现，这里不一一举例。实现完所有的控件后，我们通过xml来进行布局，布局形式和一般的布局一样，只是用的控件都是我们自己实现的。
<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout
xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto"
android:layout_width="match_parent"
android:layout_height="match_parent">
<com.qiniu.qplayer2.ui.widget.commonplayer.controlwidget.CommonPlayerDownloadTextWidget
android:id="@+id/download_speed_TV"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
app:layout_constraintTop_toTopOf="parent"
app:layout_constraintStart_toStartOf="parent"/>
<com.qiniu.qplayer2.ui.widget.commonplayer.controlwidget.CommonPlayerBiteRateTextWidget
android:id="@+id/biterate_TV"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
app:layout_constraintTop_toTopOf="@+id/download_speed_TV"
app:layout_constraintBottom_toBottomOf="@+id/download_speed_TV"
app:layout_constraintLeft_toRightOf="@+id/download_speed_TV"
android:layout_marginLeft="4dp"/>
<com.qiniu.qplayer2.ui.widget.commonplayer.controlwidget.CommonPlayerFPSTextWidget
android:id="@+id/fps_TV"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
app:layout_constraintTop_toTopOf="@+id/download_speed_TV"
app:layout_constraintBottom_toBottomOf="@+id/download_speed_TV"
app:layout_constraintLeft_toRightOf="@+id/biterate_TV"
android:layout_marginLeft="4dp"/>
<com.qiniu.qplayer2.ui.widget.commonplayer.controlwidget.CommonPlayerPausePlayWidget
android:id="@+id/pause_play_Btn"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
app:layout_constraintBottom_toBottomOf="parent"
app:layout_constraintStart_toStartOf="parent"
android:layout_marginStart="4dp"/>
<com.qiniu.qplayer2.ui.widget.commonplayer.controlwidget.CommonPlayerSeekWidget
android:id="@+id/seek_bar"
android:layout_width="0dp"
android:layout_height="wrap_content"
android:layout_centerVertical="true"
android:minHeight="2dp"
android:maxHeight="4dp"
android:max="1000"
android:thumbOffset="10dp"
app:layout_constraintBottom_toBottomOf="@+id/pause_play_Btn"
app:layout_constraintTop_toTopOf="@+id/pause_play_Btn"
app:layout_constraintStart_toEndOf="@+id/pause_play_Btn"
app:layout_constraintEnd_toStartOf="@+id/progress_TV"/>
<com.qiniu.qplayer2.ui.widget.commonplayer.controlwidget.CommonPlayerProgressTextWidget
android:id="@+id/progress_TV"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_gravity="center"
android:gravity="center"
android:textColor="#FFFFFF"
android:textSize="10sp"
android:textStyle="bold"
app:layout_constraintBottom_toBottomOf="@+id/fullscreen_IV"
app:layout_constraintTop_toTopOf="@+id/fullscreen_IV"
app:layout_constraintRight_toLeftOf="@+id/fullscreen_IV"
android:layout_marginStart="2dp"
android:layout_marginEnd="2dp"/>
<com.qiniu.qplayer2.ui.widget.commonplayer.controlwidget.CommonPlayerFullScreenWidget
android:id="@+id/fullscreen_IV"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:padding="3dp"
app:layout_constraintBottom_toBottomOf="parent"
app:layout_constraintEnd_toEndOf="parent"
app:srcCompat="@drawable/qmedia_ic_player_fullscreen_vector"
android:layout_marginEnd="4dp"/>
</androidx.constraintlayout.widget.ConstraintLayout>
### 将面板布局文件和播放元素绑定
在播放元素切换的时候，基于一些业务场景，可能会出现不同的播放元素需要有不同的面板，所以在这里一般一个播放元素，会对应2个播放面板，一个半屏面板，一个全屏面板。
面板的配置也在config中，此处`DisplayOrientation`是指代视频的宽高比类型，`ScreenType`是指代手机的屏幕方向。
val config = CommonPlayerConfig.Builder<Any,
LongLogicProvider, LongPlayableParams, LongVideoParams>()
.addControlPanel(
ControlPanelConfig(
//面板类型名称-用户自定，用来和播放元素绑定
LongControlPanelType.Normal.type,
arrayListOf(
//一个面板布局的配置
ControlPanelConfigElement(
//布局文件
R.layout.control_panel_halfscreen_landscape_normal,
//对应的屏幕类型(半屏/全屏(横屏全屏/竖屏全屏)/反向全屏(横屏全屏/竖屏全屏))
arrayListOf(ScreenType.HALF_SCREEN),
//对应横屏的视频 还是竖屏的视频
DisplayOrientation.LANDSCAPE)
)
)
)
在`LongPlayableParams`有2个参数一个是`displayOrientation: DisplayOrientation`
和`controlPanelType:
String`通过这两个参数播放元素就和面版绑定了，然后再根据手机的屏幕方向展示对应的面板`ControlPanelConfigElement`
### 半屏全屏面板切换
首先我们为视频元素再创建个横屏视频的全屏面板。
<?xml version="1.0" encoding="utf-8"?>
<com.qiniu.qplayer2.ui.widget.commonplayer.controlwidget.CommonPlayerInsetControllerWidget
xmlns:android="http://schemas.android.com/apk/res/android"
android:layout_width="match_parent"
android:layout_height="match_parent"
xmlns:app="http://schemas.android.com/apk/res-auto"
xmlns:tools="http://schemas.android.com/tools"
app:topBackground="@mipmap/common_player_control_panel_shape_shadow_top"
app:topBackgroundHeight="140dp"
app:bottomBackground="@mipmap/common_player_control_panel_shape_shadow_bottom"
app:bottomBackgroundHeight="150dp"
app:contentLeftPadding="16dp"
tools:ignore="VectorDrawableCompat">
<com.qiniu.qplayer2.ui.widget.commonplayer.controlwidget.CommonPlayerBackWidget
android:id="@+id/back_IV"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
app:layout_constraintTop_toTopOf="parent"
app:layout_constraintStart_toStartOf="parent"
android:layout_marginStart="12dp"
android:layout_marginTop="12dp"
app:srcCompat="@drawable/qmedia_ic_player_back_vector"/>
<com.qiniu.qplayer2.ui.widget.commonplayer.controlwidget.CommonPlayerDownloadTextWidget
android:id="@+id/download_speed_TV"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
app:layout_constraintTop_toTopOf="@+id/back_IV"
app:layout_constraintBottom_toBottomOf="@+id/back_IV"
app:layout_constraintLeft_toRightOf="@+id/back_IV"
android:layout_marginStart="10dp"
android:paddingStart="11dp"
android:paddingLeft="11dp"
android:paddingEnd="11dp"
android:paddingRight="11dp"
android:gravity="center"
android:singleLine="true"
android:focusable="false"
android:textColor="@color/white"
android:fontFamily="sans-serif-medium"
android:textSize="14sp"/>
<com.qiniu.qplayer2.ui.widget.commonplayer.controlwidget.CommonPlayerBiteRateTextWidget
android:id="@+id/biterate_TV"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
app:layout_constraintTop_toTopOf="@+id/download_speed_TV"
app:layout_constraintBottom_toBottomOf="@+id/download_speed_TV"
app:layout_constraintLeft_toRightOf="@+id/download_speed_TV"
android:layout_marginStart="10dp"
android:paddingStart="11dp"
android:paddingLeft="11dp"
android:paddingEnd="11dp"
android:paddingRight="11dp"
android:gravity="center"
android:singleLine="true"
android:focusable="false"
android:textColor="@color/white"
android:fontFamily="sans-serif-medium"
android:textSize="14sp"/>
<com.qiniu.qplayer2.ui.widget.commonplayer.controlwidget.CommonPlayerFPSTextWidget
android:id="@+id/fps_TV"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
app:layout_constraintTop_toTopOf="@+id/download_speed_TV"
app:layout_constraintBottom_toBottomOf="@+id/download_speed_TV"
app:layout_constraintLeft_toRightOf="@+id/biterate_TV"
android:layout_marginStart="10dp"
android:paddingStart="11dp"
android:paddingLeft="11dp"
android:paddingEnd="11dp"
android:paddingRight="11dp"
android:gravity="center"
android:singleLine="true"
android:focusable="false"
android:textColor="@color/white"
android:fontFamily="sans-serif-medium"
android:textSize="14sp"/>
<com.qiniu.qplayer2.ui.widget.commonplayer.controlwidget.CommonPlayerMoreSettingWidget
android:id="@+id/setting_IV"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
app:layout_constraintTop_toTopOf="parent"
app:layout_constraintEnd_toEndOf="parent"
android:layout_marginTop="12dp"
android:layout_marginEnd="12dp"
android:paddingStart="11dp"
android:paddingLeft="11dp"
android:paddingEnd="11dp"
android:paddingRight="11dp"/>
<com.qiniu.qplayer2.ui.widget.commonplayer.controlwidget.CommonPlayerProgressTextWidget
android:id="@+id/progress_TV"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_gravity="center"
android:gravity="center"
android:textColor="#FFFFFF"
android:textSize="10sp"
android:textStyle="bold"
app:layout_constraintBottom_toTopOf="@+id/pause_play_Btn"
app:layout_constraintStart_toStartOf="parent"
android:layout_marginStart="12dp"
android:layout_marginBottom="8dp"/>
<com.qiniu.qplayer2.ui.widget.commonplayer.controlwidget.CommonPlayerSeekWidget
android:id="@+id/seek_bar"
android:layout_width="0dp"
android:layout_height="wrap_content"
android:layout_centerVertical="true"
android:minHeight="2dp"
android:maxHeight="4dp"
android:max="1000"
android:thumbOffset="10dp"
app:layout_constraintBottom_toBottomOf="@+id/progress_TV"
app:layout_constraintTop_toTopOf="@+id/progress_TV"
app:layout_constraintStart_toEndOf="@+id/progress_TV"
app:layout_constraintEnd_toEndOf="parent"
android:layout_marginEnd="4dp"/>
<com.qiniu.qplayer2.ui.widget.commonplayer.controlwidget.CommonPlayerPausePlayWidget
android:id="@+id/pause_play_Btn"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
app:layout_constraintBottom_toBottomOf="parent"
app:layout_constraintStart_toStartOf="parent"
android:layout_marginStart="12dp"
android:layout_marginEnd="2dp"
android:layout_marginBottom="12dp"/>
<com.qiniu.qplayer2.ui.widget.commonplayer.controlwidget.CommonPlayerSelectVideoWidget
android:id="@+id/select_video_TV"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
app:layout_constraintEnd_toStartOf="@+id/select_speed_TV"
app:layout_constraintTop_toTopOf="@+id/pause_play_Btn"
app:layout_constraintBottom_toBottomOf="@+id/pause_play_Btn"
android:layout_marginEnd="10dp"
android:paddingStart="11dp"
android:paddingLeft="11dp"
android:paddingEnd="11dp"
android:paddingRight="11dp"
android:gravity="center"
android:singleLine="true"
android:focusable="false"
android:textColor="@color/white"
android:fontFamily="sans-serif-medium"
android:textSize="14sp"/>
<com.qiniu.qplayer2.ui.widget.commonplayer.controlwidget.CommonPlayerSelectSpeedWidget
android:id="@+id/select_speed_TV"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
app:layout_constraintEnd_toStartOf="@+id/select_quality_TV"
app:layout_constraintTop_toTopOf="@+id/pause_play_Btn"
app:layout_constraintBottom_toBottomOf="@+id/pause_play_Btn"
android:layout_marginEnd="10dp"
android:paddingStart="11dp"
android:paddingLeft="11dp"
android:paddingEnd="11dp"
android:paddingRight="11dp"
android:gravity="center"
android:singleLine="true"
android:focusable="false"
android:textColor="@color/white"
android:fontFamily="sans-serif-medium"
android:textSize="14sp"
/>
<com.qiniu.qplayer2.ui.widget.commonplayer.controlwidget.CommonPlayerSelectQualityWidget
android:id="@+id/select_quality_TV"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
app:layout_constraintEnd_toEndOf="parent"
app:layout_constraintTop_toTopOf="@+id/pause_play_Btn"
app:layout_constraintBottom_toBottomOf="@+id/pause_play_Btn"
android:layout_marginEnd="10dp"
android:paddingStart="11dp"
android:paddingLeft="11dp"
android:paddingEnd="11dp"
android:paddingRight="11dp"
android:gravity="center"
android:singleLine="true"
android:focusable="false"
android:textColor="@color/white"
android:fontFamily="sans-serif-medium"
android:textSize="14sp"/>
</com.qiniu.qplayer2.ui.widget.commonplayer.controlwidget.CommonPlayerInsetControllerWidget>
在config中将其配置成横屏视频的全屏面板
val config = CommonPlayerConfig.Builder<Any,
LongLogicProvider, LongPlayableParams, LongVideoParams>()
.addControlPanel(
ControlPanelConfig(
LongControlPanelType.Normal.type,
arrayListOf(
ControlPanelConfigElement(
R.layout.control_panel_halfscreen_landscape_normal,
arrayListOf(ScreenType.HALF_SCREEN),
DisplayOrientation.LANDSCAPE),
ControlPanelConfigElement(
R.layout.control_panel_fullscreen_landscape_normal,
arrayListOf(ScreenType.FULL_SCREEN, ScreenType.REVERSE_FULL_SCREEN),
DisplayOrientation.LANDSCAPE)
)
)
)
因为半屏转全屏，除了面板会变化，横屏视频全屏时，`activity`的`requestedOrientation`也需要修改成`SCREEN_ORIENTATION_LANDSCAPE`，那么这里的逻辑在EXT中已经实现，但是对于`activity`和window上的属性，比如statusbar的改变，还有视频view的容器，因为每个应用自己的规则，需要用户继承`ICommonPlayerScreenChangedListener`自行实现
以下是长视频demo中的实现，当切换全屏时，需要把视频view的容器宽高设置成`MATCH_PARENT`，同时把statusbar设置成透明，还有针对刘海屏的处理
class LongCommonPlayerScreenChangedListener(
private val mActivity: ComponentActivity,
private val mVideoContainer: ViewGroup
) : ICommonPlayerScreenChangedListener {
override fun onScreenTypeChanged(screenType: ScreenType) {
if (screenType == ScreenType.HALF_SCREEN) {
if (Build.VERSION.SDK_INT < Build.VERSION_CODES.R) {
mActivity.window.clearFlags(WindowManager.LayoutParams.FLAG_FULLSCREEN)
} else {
mActivity.window.insetsController?.show(WindowInsetsCompat.Type.statusBars())
}
mVideoContainer.layoutParams.height = DpUtils.dpToPx(200)
mVideoContainer.layoutParams.width = ViewGroup.LayoutParams.MATCH_PARENT
fitSystemWindow(false)
NotchCompat.blockDisplayCutout(mActivity.window)
mVideoContainer.requestLayout()
restoreVideoContainer()
if (NotchCompat.hasDisplayCutout(mActivity.window)) {
if (Build.VERSION.SDK_INT < Build.VERSION_CODES.P && !RomUtils.isSamsungRom()) { //samsuang with cutout device excluded
setStatusBarColor(Color.BLACK)
}
}
} else {
if (Build.VERSION.SDK_INT < Build.VERSION_CODES.R) {
mActivity.window.setFlags(
WindowManager.LayoutParams.FLAG_FULLSCREEN,
WindowManager.LayoutParams.FLAG_FULLSCREEN
)
} else {
mActivity.window.insetsController?.hide(WindowInsetsCompat.Type.statusBars())
}
mVideoContainer.layoutParams.height = ViewGroup.LayoutParams.MATCH_PARENT
mVideoContainer.layoutParams.width = ViewGroup.LayoutParams.MATCH_PARENT
fitSystemWindow(false)
NotchCompat.immersiveDisplayCutout(mActivity.window)
mVideoContainer.requestLayout()
changeVideoContainerToTop()
if (NotchCompat.hasDisplayCutout(mActivity.window) && !RomUtils.isSamsungRom()) {
setStatusBarColor(Color.TRANSPARENT)
}
}
}
private fun changeVideoContainerToTop() {
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP) {
ViewCompat.setElevation(mVideoContainer, 100f)
} else {
mVideoContainer.bringToFront()
}
}
private fun restoreVideoContainer() {
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP) {
ViewCompat.setElevation(mVideoContainer, 0f)
} else {
val parent = mVideoContainer.parent
if (parent is ViewGroup) {
val mOldVideoPageIndex = 0
if (parent.indexOfChild(mVideoContainer) != mOldVideoPageIndex) {
parent.removeView(mVideoContainer)
parent.addView(mVideoContainer, mOldVideoPageIndex)
}
}
}
}
private fun setStatusBarColor(color: Int) {
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP) {
mActivity.window.statusBarColor = color
}
}
private fun fitSystemWindow(landscape: Boolean) {
var rootView: View? = mVideoContainer
while (rootView != null && rootView.id != android.R.id.content) {
if (rootView is ViewGroup) {
rootView.clipToPadding = !landscape
rootView.clipChildren = !landscape
}
rootView = rootView.parent as View
}
}
}
定义完后将它设置到config中
val config = CommonPlayerConfig.Builder<Any,
LongLogicProvider, LongPlayableParams, LongVideoParams>()
.setCommonPlayerScreenChangedListener(LongCommonPlayerScreenChangedListener(this, findViewById(R.id.video_container_FL)))
然后通过全屏按钮进行处理，以下就是半屏面板上的全屏按钮控件的实现
class CommonPlayerFullScreenWidget: AppCompatImageView, View.OnClickListener,
IControlWidget<LongLogicProvider, LongPlayableParams, LongVideoParams> {
private lateinit var mPlayerCore: CommonPlayerCore<LongLogicProvider, LongPlayableParams, LongVideoParams>
constructor(context: Context) : super(context) {
init(context, null)
}
constructor(context: Context, attrs: AttributeSet?) : super(context, attrs) {
init(context, attrs)
}
constructor(context: Context, attrs: AttributeSet?, defStyleAttr: Int) : super(
context,
attrs,
defStyleAttr
) {
init(context, attrs)
}
private fun init(context: Context, attrs: AttributeSet?) {
contentDescription = "bbplayer_halfscreen_expand"
}
override fun onClick(v: View?) {
//点击操作切换成全屏
mPlayerCore.getCommonPlayerScreenHandler()?.switchScreenType(ScreenType.FULL_SCREEN)
}
override fun onWidgetActive() {
setOnClickListener(this)
}
override fun onWidgetInactive() {
setOnClickListener(null)
}
override fun bindPlayerCore(playerCore: CommonPlayerCore<LongLogicProvider, LongPlayableParams, LongVideoParams>) {
mPlayerCore = playerCore
}
}
### 关于DisplayOrientation和ScreenType的逻辑补充
DisplayOrientation参数的影响
* LANDSCAPE：ScreenType切换成FULL_SCREEN时，activity的requestedOrientation会切换成SCREEN_ORIENTATION_LANDSCAPE
* VERTICAL：ScreenType切换成FULL_SCREEN时，activity的requestedOrientation会切换成SCREEN_ORIENTATION_PORTRAIT
所以横屏视频和竖屏视频在配置`LongPlayableParams`时，不一定横屏视频一定是DisplayOrientation.LANDSCAPE
竖屏视频是 DisplayOrientation.VERTICAL，主要是看业务需求上是否要转屏，然后根据业务需求来配置。
### 关于面板的自动隐藏逻辑
因为自动隐藏逻辑可能每个app都有自己的实现，所以隐藏逻辑有业务方自行实现，demo中有一个简单的实现可以参考
com.qiniu.qplayer2.ui.page.longvideo.service.controlpanelcontainervisible.PlayerControlPanelContainerVisibleService
可以在看完[通过Ext为播放器添加业务逻辑 __](http://)后再来读该类的源码
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,593 |
通过Ext为播放器添加业务逻辑 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2
Android端](https://developer.qiniu.com/pili/sdk/12214/qplayer2-android) >
[基于Ext的QPlayer2接入指南](https://developer.qiniu.com/pili/sdk/12224/based-on-the-
ext-qplayer2-access-guide) > 通过Ext为播放器添加业务逻辑
# 通过Ext为播放器添加业务逻辑
最近更新时间: 2022-09-27 16:01:07
# 通过Ext为播放器添加业务逻辑
当我们的业务逻辑需要获取播放器的某些信息或者要对播放器做某些操作时，我们不得不持有播放器的实例，但是当业务规模不断扩大，就会导致播放器实例还有播放器相关的一些监听得不到很好的管理，最终导致内存泄漏，管理混乱的问题，通过Ext来实现和播放器相关的逻辑，能很好的解决这个问题。
## 播放环境PlayerEnvironment和逻辑服务Service
播放环境即是一个媒体资源播放时的逻辑服务集合，逻辑服务Service是逻辑的最小单元，一种类型的视频对应一种播放环境，一种环境可以有多个逻辑服务Service，不同的播放环境可以复用同一种逻辑服务Service，这样就完美的做到的逻辑服务的复用。
### 定义一个PlayerToastService
所有的Service都是继承自`IPlayerService`接口
该Service的作用是对于播放器抛上来的一些信息进行toast展示，PlayerToast是Ext框架的一部分，用来在视频区域展示toast，在后续文档中会详细介绍。
class PlayerToastService
: IPlayerService<LongLogicProvider, LongPlayableParams, LongVideoParams>, IPlayerToastService,
QIPlayerQualityListener, QIPlayerVideoDecodeListener,
QIPlayerCommandNotAllowListener, QIPlayerFormatListener, QIPlayerSEIDataListener, QIPlayerAuthenticationListener {
//mPlayerCore 为播放器的核心对象，一切的播放器核心的交互都依靠他
private lateinit var mPlayerCore: CommonPlayerCore<LongLogicProvider, LongPlayableParams, LongVideoParams>
//服务启动时回调
override fun onStart() {
//绑定清晰度监听
mPlayerCore.mPlayerContext.getPlayerControlHandler().addPlayerQualityListener(this)
//绑定解码方式监听
mPlayerCore.mPlayerContext.getPlayerControlHandler().addPlayerVideoDecodeTypeListener(this)
//绑定操作不被允许监听
mPlayerCore.mPlayerContext.getPlayerControlHandler().addPlayerCommandNotAllowListener(this)
//绑定格式不支持监听
mPlayerCore.mPlayerContext.getPlayerControlHandler().addPlayerFormatListener(this)
//绑定SEI回调监听
mPlayerCore.mPlayerContext.getPlayerControlHandler().addPlayerSEIDataListener(this)
//绑定鉴权回调监听
mPlayerCore.mPlayerContext.getPlayerControlHandler().addPlayerAuthenticationListener(this)
}
//服务结束时回调
override fun onStop() {
//移除所有监听
mPlayerCore.mPlayerContext.getPlayerControlHandler().removePlayerQualityListener(this)
mPlayerCore.mPlayerContext.getPlayerControlHandler().removePlayerVideoDecodeTypeListener(this)
mPlayerCore.mPlayerContext.getPlayerControlHandler().removePlayerCommandNotAllowListener(this)
mPlayerCore.mPlayerContext.getPlayerControlHandler().removePlayerFormatListener(this)
mPlayerCore.mPlayerContext.getPlayerControlHandler().removePlayerSEIDataListener(this)
mPlayerCore.mPlayerContext.getPlayerControlHandler().removePlayerAuthenticationListener(this)
}
//Service启动前都会调用该方法，在此方法中保存playerCore
override fun bindPlayerCore(playerCore: CommonPlayerCore<LongLogicProvider, LongPlayableParams, LongVideoParams>) {
mPlayerCore = playerCore
}
override fun onQualitySwitchStart(
userType: String,
urlType: QURLType,
newQuality: Int,
oldQuality: Int
) {
val toast = PlayerToast.Builder()
.toastItemType(PlayerToastConfig.TYPE_NORMAL)
.location(PlayerToastConfig.LOCAT_LEFT_SIDE)
.setExtraString(PlayerToastConfig.EXTRA_TITLE, "清晰度开始切换至$newQuality,请稍候...")
.duration(PlayerToastConfig.DURATION_3)
.build()
mPlayerCore.playerToastContainer?.showToast(toast)
}
override fun onQualitySwitchComplete(
userType: String,
urlType: QURLType,
newQuality: Int,
oldQuality: Int
) {
val toast = PlayerToast.Builder()
.toastItemType(PlayerToastConfig.TYPE_NORMAL)
.location(PlayerToastConfig.LOCAT_LEFT_SIDE)
.setExtraString(PlayerToastConfig.EXTRA_TITLE, "清晰度已成功切换至【$newQuality】")
.duration(PlayerToastConfig.DURATION_3)
.build()
mPlayerCore.playerToastContainer?.showToast(toast)
}
override fun onQualitySwitchCanceled(
userType: String,
urlType: QURLType,
newQuality: Int,
oldQuality: Int
) {
val toast = PlayerToast.Builder()
.toastItemType(PlayerToastConfig.TYPE_NORMAL)
.location(PlayerToastConfig.LOCAT_LEFT_SIDE)
.setExtraString(PlayerToastConfig.EXTRA_TITLE, "清晰度【$newQuality】切换取消")
.duration(PlayerToastConfig.DURATION_3)
.build()
mPlayerCore.playerToastContainer?.showToast(toast)
}
override fun onQualitySwitchFailed(
userType: String,
urlType: QURLType,
newQuality: Int,
oldQuality: Int
) {
val toast = PlayerToast.Builder()
.toastItemType(PlayerToastConfig.TYPE_NORMAL)
.location(PlayerToastConfig.LOCAT_LEFT_SIDE)
.setExtraString(PlayerToastConfig.EXTRA_TITLE, "清晰度切换至【$newQuality】失败")
.duration(PlayerToastConfig.DURATION_3)
.build()
mPlayerCore.playerToastContainer?.showToast(toast)
}
override fun onQualitySwitchRetryLater(userType: String, urlType: QURLType, newQuality: Int) {
val toast = PlayerToast.Builder()
.toastItemType(PlayerToastConfig.TYPE_NORMAL)
.location(PlayerToastConfig.LOCAT_LEFT_SIDE)
.setExtraString(PlayerToastConfig.EXTRA_TITLE, "正在切换中请稍后再试")
.duration(PlayerToastConfig.DURATION_3)
.build()
mPlayerCore.playerToastContainer?.showToast(toast)
}
override fun onVideoDecodeByType(type: QPlayerDecodeType) {
val type = when(type) {
QPlayerDecodeType.NONE -> "无"
QPlayerDecodeType.FIRST_FRAME_ACCEL -> "混解"
QPlayerDecodeType.HARDWARE_BUFFER -> "buffer硬解"
QPlayerDecodeType.HARDWARE_SURFACE -> "surface硬解"
QPlayerDecodeType.SOFTWARE -> "软解"
else -> "无"
}
val toast = PlayerToast.Builder()
.toastItemType(PlayerToastConfig.TYPE_NORMAL)
.location(PlayerToastConfig.LOCAT_LEFT_SIDE)
.setExtraString(PlayerToastConfig.EXTRA_TITLE, "解码器类型：$type")
.duration(PlayerToastConfig.DURATION_3)
.build()
mPlayerCore.playerToastContainer?.showToast(toast)
}
override fun notSupportCodecFormat(codecId: Int) {
val toast = PlayerToast.Builder()
.toastItemType(PlayerToastConfig.TYPE_NORMAL)
.location(PlayerToastConfig.LOCAT_LEFT_SIDE)
.setExtraString(PlayerToastConfig.EXTRA_TITLE, "不支持的编码类型：$codecId")
.duration(PlayerToastConfig.DURATION_3)
.build()
mPlayerCore.playerToastContainer?.showToast(toast)
}
override fun onCommandNotAllow(commandName: String, state: QPlayerState) {
val toast = PlayerToast.Builder()
.toastItemType(PlayerToastConfig.TYPE_NORMAL)
.location(PlayerToastConfig.LOCAT_LEFT_SIDE)
.setExtraString(PlayerToastConfig.EXTRA_TITLE, "not allow $commandName 状态:$state")
.duration(PlayerToastConfig.DURATION_3)
.build()
mPlayerCore.playerToastContainer?.showToast(toast)
}
override fun onFormatNotSupport() {
val toast = PlayerToast.Builder()
.toastItemType(PlayerToastConfig.TYPE_NORMAL)
.location(PlayerToastConfig.LOCAT_LEFT_SIDE)
.setExtraString(PlayerToastConfig.EXTRA_TITLE, "流中有播放器不支持的像素格式或音频sample格式")
.duration(PlayerToastConfig.DURATION_3)
.build()
mPlayerCore.playerToastContainer?.showToast(toast)
}
override fun onSEIData(data: ByteArray) {
val toast = PlayerToast.Builder()
.toastItemType(PlayerToastConfig.TYPE_NORMAL)
.location(PlayerToastConfig.LOCAT_LEFT_SIDE)
.setExtraString(PlayerToastConfig.EXTRA_TITLE, "SEI DATA:${data.decodeToString()}")
.duration(PlayerToastConfig.DURATION_3)
.build()
Log.i("PlayerToastService", "SEI DATA:${data}")
mPlayerCore.playerToastContainer?.showToast(toast)
}
override fun on_authentication_failed(error_type: QAuthenticationErrorType) {
val toast = PlayerToast.Builder()
.toastItemType(PlayerToastConfig.TYPE_NORMAL)
.location(PlayerToastConfig.LOCAT_LEFT_SIDE)
.setExtraString(PlayerToastConfig.EXTRA_TITLE, "Qplayer2鉴权失败-${error_type}")
.duration(PlayerToastConfig.DURATION_3)
.build()
Log.e("PlayerToastService", "Qplayer2鉴权失败-${error_type}")
mPlayerCore.playerToastContainer?.showToast(toast)
}
override fun on_authentication_success() {
val toast = PlayerToast.Builder()
.toastItemType(PlayerToastConfig.TYPE_NORMAL)
.location(PlayerToastConfig.LOCAT_LEFT_SIDE)
.setExtraString(PlayerToastConfig.EXTRA_TITLE, "Qplayer2鉴权成功")
.duration(PlayerToastConfig.DURATION_3)
.build()
Log.e("PlayerToastService", "Qplayer2鉴权成功")
mPlayerCore.playerToastContainer?.showToast(toast)
}
}
### 定义 ServiceOwner
除了Service，还要实现一个`PlayerToastServiceOwner`,他是类似一个创建销毁的管理器，所有的ServiceOwner都可以按照以下模板实现，且都是继承自`IPlayerServiceOwner`
class PlayerToastServiceOwner :
IPlayerServiceOwner<LongLogicProvider, LongPlayableParams, LongVideoParams> {
//该serivce的名字，用户自行定义，用于和Enviroment绑定
override val name: String
get() = ServiceOwnerType.PLAYER_TOAST_SERVICE.type
private val mPlayerToastServiceClient: PlayerServiceManager.Client<PlayerToastService, LongLogicProvider, LongPlayableParams, LongVideoParams> =
PlayerServiceManager.Client()
override fun start(serviceManager: IPlayerServiceManager<LongLogicProvider, LongPlayableParams, LongVideoParams>) {
serviceManager.bindService(
PlayerServiceManager.ServiceDescriptor.obtain(
PlayerToastService::class.java
), mPlayerToastServiceClient
)
}
override fun stop(serviceManager: IPlayerServiceManager<LongLogicProvider, LongPlayableParams, LongVideoParams>) {
serviceManager.unbindService(
PlayerServiceManager.ServiceDescriptor.obtain(
PlayerToastService::class.java
), mPlayerToastServiceClient
)
}
override fun <T> service(): T {
return mPlayerToastServiceClient.service as T
}
### 定义Enviroment
Service定义完后，可以定义我们的Enviroment，然后合我们的Serivice绑定，所有的Enviroment都是继承自`ICommonPlayerEnvironment`
class LongPlayerEnviroment :
ICommonPlayerEnvironment<LongLogicProvider, LongPlayableParams, LongVideoParams> {
private lateinit var mPlayerCore: CommonPlayerCore<LongLogicProvider, LongPlayableParams, LongVideoParams>
//环境的名称，用户自行定义，用户和LongPlayableParams进行绑定
override val name: String
get() = LongEnviromentType.LONG.type
//该环境所有的Service集合
override val serviceTypes: Set<String> =
setOf(
ServiceOwnerType.PLAYER_TOAST_SERVICE.type
)
//播放事件回调 ，此处绑定的是播放元素起播前的回调，在起播前动态设置起播的位置
private val mVideoPlayEventListener = object : ICommonPlayerVideoSwitcher.ICommonVideoPlayEventListener<LongPlayableParams, LongVideoParams> {
override fun onPlayableParamsWillChange(oldPlayableParams: LongPlayableParams?,
oldVideoParams: LongVideoParams?,
newPlayableParams: LongPlayableParams,
newVideoParams: LongVideoParams,
switchVideoParams: Bundle?) {
newPlayableParams.startPos = PlayerSettingRespostory.startPosition
}
}
//环境启动
override fun start() {
//绑定播放事件回调
mPlayerCore.mCommonPlayerVideoSwitcher.addVideoPlayEventListener(mVideoPlayEventListener)
}
//环境停止
override fun stop() {
//解除播放事件回调
mPlayerCore.mCommonPlayerVideoSwitcher.removeVideoPlayEventListener(mVideoPlayEventListener)
}
//用户自定义鉴权，返回true说明可以播放，返回false 则无法播放
override fun authentication(
playableParams: LongPlayableParams,
videoParams: LongVideoParams?
): Boolean {
return true
}
//启动之前回调，保存playerCore
override fun bindPlayerCore(playerCore: CommonPlayerCore<LongLogicProvider, LongPlayableParams, LongVideoParams>) {
mPlayerCore = playerCore
}
}
### 将Enviroment和LongPlayableParams绑定
在`CommonPlayableParams`中有个参数是`environmentType`，将其设置为`LongPlayerEnviroment.name`，那么当该播放元素播放时，LongPlayerEnviroment内的所有Service就会启动
### 将Enviroment配置进播放器
同样通过config来进行配置
val config = CommonPlayerConfig.Builder<Any,
LongLogicProvider, LongPlayableParams, LongVideoParams>()
.addEnviroment(LongEnviromentType.LONG.type,
LongPlayerEnviroment())
至此 我们的业务逻辑添加完成。
### 如何Service外部调用Service的方法
我们现在的业务逻辑都是在Service中去实现，某些情况下，我们在其他地方需要修改Service的一些配置 我们该怎么做呢
我们以demo中的`PlayerControlPanelContainerVisibleService`为例，这个Serice的作用是控制面板的展示隐藏时机，当用户5秒内不操作面板，则面板在5秒后隐藏，如果用户点击视频则展示面板，但是当用户在拖动进度条时，我们就要禁用这个自动隐藏的逻辑。所以需要一个开关控制是否自动隐藏逻辑生效，然后由进度条控件来动态设置这个开关。
首先我们定一个接口，用来给到外部使用
interface IPlayerControlPanelContainerVisibleService {
fun setAutoHideEnable(enable: Boolean)
}
并且在`PlayerControlPanelContainerVisibleService`去实现这个接口
override fun setAutoHideEnable(enable: Boolean) {
mIsAutoHideEnable = enable
if (!mIsAutoHideEnable) {
HandlerThreads.remove(HandlerThreads.THREAD_UI, mHideRunnable)
}
}
之后我们就能在进度条控件`CommonPlayerSeekWidget`中去调用这个接口了
override fun onStartTrackingTouch(seekBar: SeekBar?) {
//获取对应的service
val service = mPlayerCore.getPlayerEnviromentServiceManager().getPlayerService<IPlayerControlPanelContainerVisibleService>(
ServiceOwnerType.PLAYER_CONTROL_PANEL_CONTATINER_VISIBLE_SERVICE.type
)
//调用接口
service?.setAutoHideEnable(false)
mIsTrackingTouch = true
}
### 有多个Enviroment时，他们在切换时，Service的启动和停止是怎么调用的
假设有2个Enviroment
* AEnviroment：Service1， Service2， Service3， Service4
* BEnviroment：Service2， Service3， Service4， Service5
那么当AEnviroment切换成BEnviroment时，Service1会回调stop方法，Service5会回调start方法，Service2，
Service3， Service4 不会回调任何生命周期的方法
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2
Android端](https://developer.qiniu.com/pili/sdk/12214/qplayer2-android) >
[基于Ext的QPlayer2接入指南](https://developer.qiniu.com/pili/sdk/12224/based-on-the-
ext-qplayer2-access-guide) > 通过Ext为播放器添加业务逻辑
# 通过Ext为播放器添加业务逻辑
最近更新时间: 2022-09-27 16:01:07
# 通过Ext为播放器添加业务逻辑
当我们的业务逻辑需要获取播放器的某些信息或者要对播放器做某些操作时，我们不得不持有播放器的实例，但是当业务规模不断扩大，就会导致播放器实例还有播放器相关的一些监听得不到很好的管理，最终导致内存泄漏，管理混乱的问题，通过Ext来实现和播放器相关的逻辑，能很好的解决这个问题。
## 播放环境PlayerEnvironment和逻辑服务Service
播放环境即是一个媒体资源播放时的逻辑服务集合，逻辑服务Service是逻辑的最小单元，一种类型的视频对应一种播放环境，一种环境可以有多个逻辑服务Service，不同的播放环境可以复用同一种逻辑服务Service，这样就完美的做到的逻辑服务的复用。
### 定义一个PlayerToastService
所有的Service都是继承自`IPlayerService`接口
该Service的作用是对于播放器抛上来的一些信息进行toast展示，PlayerToast是Ext框架的一部分，用来在视频区域展示toast，在后续文档中会详细介绍。
class PlayerToastService
: IPlayerService<LongLogicProvider, LongPlayableParams, LongVideoParams>, IPlayerToastService,
QIPlayerQualityListener, QIPlayerVideoDecodeListener,
QIPlayerCommandNotAllowListener, QIPlayerFormatListener, QIPlayerSEIDataListener, QIPlayerAuthenticationListener {
//mPlayerCore 为播放器的核心对象，一切的播放器核心的交互都依靠他
private lateinit var mPlayerCore: CommonPlayerCore<LongLogicProvider, LongPlayableParams, LongVideoParams>
//服务启动时回调
override fun onStart() {
//绑定清晰度监听
mPlayerCore.mPlayerContext.getPlayerControlHandler().addPlayerQualityListener(this)
//绑定解码方式监听
mPlayerCore.mPlayerContext.getPlayerControlHandler().addPlayerVideoDecodeTypeListener(this)
//绑定操作不被允许监听
mPlayerCore.mPlayerContext.getPlayerControlHandler().addPlayerCommandNotAllowListener(this)
//绑定格式不支持监听
mPlayerCore.mPlayerContext.getPlayerControlHandler().addPlayerFormatListener(this)
//绑定SEI回调监听
mPlayerCore.mPlayerContext.getPlayerControlHandler().addPlayerSEIDataListener(this)
//绑定鉴权回调监听
mPlayerCore.mPlayerContext.getPlayerControlHandler().addPlayerAuthenticationListener(this)
}
//服务结束时回调
override fun onStop() {
//移除所有监听
mPlayerCore.mPlayerContext.getPlayerControlHandler().removePlayerQualityListener(this)
mPlayerCore.mPlayerContext.getPlayerControlHandler().removePlayerVideoDecodeTypeListener(this)
mPlayerCore.mPlayerContext.getPlayerControlHandler().removePlayerCommandNotAllowListener(this)
mPlayerCore.mPlayerContext.getPlayerControlHandler().removePlayerFormatListener(this)
mPlayerCore.mPlayerContext.getPlayerControlHandler().removePlayerSEIDataListener(this)
mPlayerCore.mPlayerContext.getPlayerControlHandler().removePlayerAuthenticationListener(this)
}
//Service启动前都会调用该方法，在此方法中保存playerCore
override fun bindPlayerCore(playerCore: CommonPlayerCore<LongLogicProvider, LongPlayableParams, LongVideoParams>) {
mPlayerCore = playerCore
}
override fun onQualitySwitchStart(
userType: String,
urlType: QURLType,
newQuality: Int,
oldQuality: Int
) {
val toast = PlayerToast.Builder()
.toastItemType(PlayerToastConfig.TYPE_NORMAL)
.location(PlayerToastConfig.LOCAT_LEFT_SIDE)
.setExtraString(PlayerToastConfig.EXTRA_TITLE, "清晰度开始切换至$newQuality,请稍候...")
.duration(PlayerToastConfig.DURATION_3)
.build()
mPlayerCore.playerToastContainer?.showToast(toast)
}
override fun onQualitySwitchComplete(
userType: String,
urlType: QURLType,
newQuality: Int,
oldQuality: Int
) {
val toast = PlayerToast.Builder()
.toastItemType(PlayerToastConfig.TYPE_NORMAL)
.location(PlayerToastConfig.LOCAT_LEFT_SIDE)
.setExtraString(PlayerToastConfig.EXTRA_TITLE, "清晰度已成功切换至【$newQuality】")
.duration(PlayerToastConfig.DURATION_3)
.build()
mPlayerCore.playerToastContainer?.showToast(toast)
}
override fun onQualitySwitchCanceled(
userType: String,
urlType: QURLType,
newQuality: Int,
oldQuality: Int
) {
val toast = PlayerToast.Builder()
.toastItemType(PlayerToastConfig.TYPE_NORMAL)
.location(PlayerToastConfig.LOCAT_LEFT_SIDE)
.setExtraString(PlayerToastConfig.EXTRA_TITLE, "清晰度【$newQuality】切换取消")
.duration(PlayerToastConfig.DURATION_3)
.build()
mPlayerCore.playerToastContainer?.showToast(toast)
}
override fun onQualitySwitchFailed(
userType: String,
urlType: QURLType,
newQuality: Int,
oldQuality: Int
) {
val toast = PlayerToast.Builder()
.toastItemType(PlayerToastConfig.TYPE_NORMAL)
.location(PlayerToastConfig.LOCAT_LEFT_SIDE)
.setExtraString(PlayerToastConfig.EXTRA_TITLE, "清晰度切换至【$newQuality】失败")
.duration(PlayerToastConfig.DURATION_3)
.build()
mPlayerCore.playerToastContainer?.showToast(toast)
}
override fun onQualitySwitchRetryLater(userType: String, urlType: QURLType, newQuality: Int) {
val toast = PlayerToast.Builder()
.toastItemType(PlayerToastConfig.TYPE_NORMAL)
.location(PlayerToastConfig.LOCAT_LEFT_SIDE)
.setExtraString(PlayerToastConfig.EXTRA_TITLE, "正在切换中请稍后再试")
.duration(PlayerToastConfig.DURATION_3)
.build()
mPlayerCore.playerToastContainer?.showToast(toast)
}
override fun onVideoDecodeByType(type: QPlayerDecodeType) {
val type = when(type) {
QPlayerDecodeType.NONE -> "无"
QPlayerDecodeType.FIRST_FRAME_ACCEL -> "混解"
QPlayerDecodeType.HARDWARE_BUFFER -> "buffer硬解"
QPlayerDecodeType.HARDWARE_SURFACE -> "surface硬解"
QPlayerDecodeType.SOFTWARE -> "软解"
else -> "无"
}
val toast = PlayerToast.Builder()
.toastItemType(PlayerToastConfig.TYPE_NORMAL)
.location(PlayerToastConfig.LOCAT_LEFT_SIDE)
.setExtraString(PlayerToastConfig.EXTRA_TITLE, "解码器类型：$type")
.duration(PlayerToastConfig.DURATION_3)
.build()
mPlayerCore.playerToastContainer?.showToast(toast)
}
override fun notSupportCodecFormat(codecId: Int) {
val toast = PlayerToast.Builder()
.toastItemType(PlayerToastConfig.TYPE_NORMAL)
.location(PlayerToastConfig.LOCAT_LEFT_SIDE)
.setExtraString(PlayerToastConfig.EXTRA_TITLE, "不支持的编码类型：$codecId")
.duration(PlayerToastConfig.DURATION_3)
.build()
mPlayerCore.playerToastContainer?.showToast(toast)
}
override fun onCommandNotAllow(commandName: String, state: QPlayerState) {
val toast = PlayerToast.Builder()
.toastItemType(PlayerToastConfig.TYPE_NORMAL)
.location(PlayerToastConfig.LOCAT_LEFT_SIDE)
.setExtraString(PlayerToastConfig.EXTRA_TITLE, "not allow $commandName 状态:$state")
.duration(PlayerToastConfig.DURATION_3)
.build()
mPlayerCore.playerToastContainer?.showToast(toast)
}
override fun onFormatNotSupport() {
val toast = PlayerToast.Builder()
.toastItemType(PlayerToastConfig.TYPE_NORMAL)
.location(PlayerToastConfig.LOCAT_LEFT_SIDE)
.setExtraString(PlayerToastConfig.EXTRA_TITLE, "流中有播放器不支持的像素格式或音频sample格式")
.duration(PlayerToastConfig.DURATION_3)
.build()
mPlayerCore.playerToastContainer?.showToast(toast)
}
override fun onSEIData(data: ByteArray) {
val toast = PlayerToast.Builder()
.toastItemType(PlayerToastConfig.TYPE_NORMAL)
.location(PlayerToastConfig.LOCAT_LEFT_SIDE)
.setExtraString(PlayerToastConfig.EXTRA_TITLE, "SEI DATA:${data.decodeToString()}")
.duration(PlayerToastConfig.DURATION_3)
.build()
Log.i("PlayerToastService", "SEI DATA:${data}")
mPlayerCore.playerToastContainer?.showToast(toast)
}
override fun on_authentication_failed(error_type: QAuthenticationErrorType) {
val toast = PlayerToast.Builder()
.toastItemType(PlayerToastConfig.TYPE_NORMAL)
.location(PlayerToastConfig.LOCAT_LEFT_SIDE)
.setExtraString(PlayerToastConfig.EXTRA_TITLE, "Qplayer2鉴权失败-${error_type}")
.duration(PlayerToastConfig.DURATION_3)
.build()
Log.e("PlayerToastService", "Qplayer2鉴权失败-${error_type}")
mPlayerCore.playerToastContainer?.showToast(toast)
}
override fun on_authentication_success() {
val toast = PlayerToast.Builder()
.toastItemType(PlayerToastConfig.TYPE_NORMAL)
.location(PlayerToastConfig.LOCAT_LEFT_SIDE)
.setExtraString(PlayerToastConfig.EXTRA_TITLE, "Qplayer2鉴权成功")
.duration(PlayerToastConfig.DURATION_3)
.build()
Log.e("PlayerToastService", "Qplayer2鉴权成功")
mPlayerCore.playerToastContainer?.showToast(toast)
}
}
### 定义 ServiceOwner
除了Service，还要实现一个`PlayerToastServiceOwner`,他是类似一个创建销毁的管理器，所有的ServiceOwner都可以按照以下模板实现，且都是继承自`IPlayerServiceOwner`
class PlayerToastServiceOwner :
IPlayerServiceOwner<LongLogicProvider, LongPlayableParams, LongVideoParams> {
//该serivce的名字，用户自行定义，用于和Enviroment绑定
override val name: String
get() = ServiceOwnerType.PLAYER_TOAST_SERVICE.type
private val mPlayerToastServiceClient: PlayerServiceManager.Client<PlayerToastService, LongLogicProvider, LongPlayableParams, LongVideoParams> =
PlayerServiceManager.Client()
override fun start(serviceManager: IPlayerServiceManager<LongLogicProvider, LongPlayableParams, LongVideoParams>) {
serviceManager.bindService(
PlayerServiceManager.ServiceDescriptor.obtain(
PlayerToastService::class.java
), mPlayerToastServiceClient
)
}
override fun stop(serviceManager: IPlayerServiceManager<LongLogicProvider, LongPlayableParams, LongVideoParams>) {
serviceManager.unbindService(
PlayerServiceManager.ServiceDescriptor.obtain(
PlayerToastService::class.java
), mPlayerToastServiceClient
)
}
override fun <T> service(): T {
return mPlayerToastServiceClient.service as T
}
### 定义Enviroment
Service定义完后，可以定义我们的Enviroment，然后合我们的Serivice绑定，所有的Enviroment都是继承自`ICommonPlayerEnvironment`
class LongPlayerEnviroment :
ICommonPlayerEnvironment<LongLogicProvider, LongPlayableParams, LongVideoParams> {
private lateinit var mPlayerCore: CommonPlayerCore<LongLogicProvider, LongPlayableParams, LongVideoParams>
//环境的名称，用户自行定义，用户和LongPlayableParams进行绑定
override val name: String
get() = LongEnviromentType.LONG.type
//该环境所有的Service集合
override val serviceTypes: Set<String> =
setOf(
ServiceOwnerType.PLAYER_TOAST_SERVICE.type
)
//播放事件回调 ，此处绑定的是播放元素起播前的回调，在起播前动态设置起播的位置
private val mVideoPlayEventListener = object : ICommonPlayerVideoSwitcher.ICommonVideoPlayEventListener<LongPlayableParams, LongVideoParams> {
override fun onPlayableParamsWillChange(oldPlayableParams: LongPlayableParams?,
oldVideoParams: LongVideoParams?,
newPlayableParams: LongPlayableParams,
newVideoParams: LongVideoParams,
switchVideoParams: Bundle?) {
newPlayableParams.startPos = PlayerSettingRespostory.startPosition
}
}
//环境启动
override fun start() {
//绑定播放事件回调
mPlayerCore.mCommonPlayerVideoSwitcher.addVideoPlayEventListener(mVideoPlayEventListener)
}
//环境停止
override fun stop() {
//解除播放事件回调
mPlayerCore.mCommonPlayerVideoSwitcher.removeVideoPlayEventListener(mVideoPlayEventListener)
}
//用户自定义鉴权，返回true说明可以播放，返回false 则无法播放
override fun authentication(
playableParams: LongPlayableParams,
videoParams: LongVideoParams?
): Boolean {
return true
}
//启动之前回调，保存playerCore
override fun bindPlayerCore(playerCore: CommonPlayerCore<LongLogicProvider, LongPlayableParams, LongVideoParams>) {
mPlayerCore = playerCore
}
}
### 将Enviroment和LongPlayableParams绑定
在`CommonPlayableParams`中有个参数是`environmentType`，将其设置为`LongPlayerEnviroment.name`，那么当该播放元素播放时，LongPlayerEnviroment内的所有Service就会启动
### 将Enviroment配置进播放器
同样通过config来进行配置
val config = CommonPlayerConfig.Builder<Any,
LongLogicProvider, LongPlayableParams, LongVideoParams>()
.addEnviroment(LongEnviromentType.LONG.type,
LongPlayerEnviroment())
至此 我们的业务逻辑添加完成。
### 如何Service外部调用Service的方法
我们现在的业务逻辑都是在Service中去实现，某些情况下，我们在其他地方需要修改Service的一些配置 我们该怎么做呢
我们以demo中的`PlayerControlPanelContainerVisibleService`为例，这个Serice的作用是控制面板的展示隐藏时机，当用户5秒内不操作面板，则面板在5秒后隐藏，如果用户点击视频则展示面板，但是当用户在拖动进度条时，我们就要禁用这个自动隐藏的逻辑。所以需要一个开关控制是否自动隐藏逻辑生效，然后由进度条控件来动态设置这个开关。
首先我们定一个接口，用来给到外部使用
interface IPlayerControlPanelContainerVisibleService {
fun setAutoHideEnable(enable: Boolean)
}
并且在`PlayerControlPanelContainerVisibleService`去实现这个接口
override fun setAutoHideEnable(enable: Boolean) {
mIsAutoHideEnable = enable
if (!mIsAutoHideEnable) {
HandlerThreads.remove(HandlerThreads.THREAD_UI, mHideRunnable)
}
}
之后我们就能在进度条控件`CommonPlayerSeekWidget`中去调用这个接口了
override fun onStartTrackingTouch(seekBar: SeekBar?) {
//获取对应的service
val service = mPlayerCore.getPlayerEnviromentServiceManager().getPlayerService<IPlayerControlPanelContainerVisibleService>(
ServiceOwnerType.PLAYER_CONTROL_PANEL_CONTATINER_VISIBLE_SERVICE.type
)
//调用接口
service?.setAutoHideEnable(false)
mIsTrackingTouch = true
}
### 有多个Enviroment时，他们在切换时，Service的启动和停止是怎么调用的
假设有2个Enviroment
* AEnviroment：Service1， Service2， Service3， Service4
* BEnviroment：Service2， Service3， Service4， Service5
那么当AEnviroment切换成BEnviroment时，Service1会回调stop方法，Service5会回调start方法，Service2，
Service3， Service4 不会回调任何生命周期的方法
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,635 |
通过Ext为播放器添加浮窗 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2
Android端](https://developer.qiniu.com/pili/sdk/12214/qplayer2-android) >
[基于Ext的QPlayer2接入指南](https://developer.qiniu.com/pili/sdk/12224/based-on-the-
ext-qplayer2-access-guide) > 通过Ext为播放器添加浮窗
# 通过Ext为播放器添加浮窗
最近更新时间: 2022-09-27 16:01:14
# 通过Ext为播放器添加浮窗
在播放器场景中，播放器上层的浮窗承载了绝大多数播放器的业务逻辑：选集、倍速、清晰度等等，如何处理浮窗的样式，动画，层级，需要有一个统一的架构来处理，Ext中的浮窗部分完美的统一了这些。
## 定义一个浮窗
所有浮窗都继承`BaseFunctionWidget`
class BufferingFunctionWidget(context: Context):
BaseFunctionWidget<LongLogicProvider, LongPlayableParams, LongVideoParams>(context)
{
//播放器核心对象
private lateinit var mPlayerCore: CommonPlayerCore<LongLogicProvider, LongPlayableParams, LongVideoParams>
override val tag: String
get() = "BufferingFunctionWidget"
//配置浮窗
override val functionWidgetConfig: FunctionWidgetConfig
get() {
val builder = FunctionWidgetConfig.Builder()
builder.persistent(true)
builder.dismissWhenVideoCompleted(true)
builder.dismissWhenVideoChange(false)
builder.dismissWhenScreenTypeChange(false)
builder.dismissWhenActivityStop(false)
builder.launchType(FunctionWidgetConfig.LaunchType.Normal)
return builder.build()
}
//浮窗显示时回调
override fun onWidgetShow() {
}
//浮窗隐藏时回调
override fun onWidgetDismiss() {
}
//创建时回调，在这里提供layout创建
override fun createContentView(context: Context): View {
return LayoutInflater.from(mContext).inflate(R.layout.function_buffering, null)
}
//销毁时回调
override fun onRelease() {
}
//用户外部通知的回调
override fun onConfigurationChanged(configuration: Configuration) {
}
//创建后回调，记得保存playerCore
override fun bindPlayerCore(playerCore: CommonPlayerCore<LongLogicProvider, LongPlayableParams, LongVideoParams>) {
mPlayerCore = playerCore
}
其中关于浮窗的配置
//配置构造器
val builder = FunctionWidgetConfig.Builder()
/**
* 当浮窗隐藏时，是否浮窗需要被销毁
* @param p true，无需销毁 false 需要销毁
*/
builder.persistent(true)
/**
* 当浮窗显示时，是否禁用屏幕旋转
* @param disable true，禁用屏幕旋转 false 不禁用屏幕旋转
*/
builder.changeOrientationDisableWhenShow(false)
/**
* 当 CommonVideoParams 切换时，是否浮窗需要被移除
* @param remove ture 需要移除 false 无需移除
*/
builder.removeWhenVideoChange(false)
/**
* 当CommonVideoParams播放完时，是否浮窗需要隐藏
* @param dismiss ture 需要隐藏 false 无需隐藏
*/
builder.dismissWhenVideoCompleted(true)
/**
* 当 CommonVideoParams 切换时，是否浮窗需要隐藏
* @param dismiss ture 需要隐藏 false 无需隐藏
*/
builder.dismissWhenVideoChange(false)
/**
* 当 @see[ScreenType] 改变时，是否浮窗需要隐藏
* @param dismiss ture 需要隐藏 false 无需隐藏
*/
builder.dismissWhenScreenTypeChange(false)
/**
* 当Activity stop时，是否浮窗需要隐藏
* @param dismiss ture 需要隐藏 false 无需隐藏
*/
builder.dismissWhenActivityStop(false)
/**
* 启动类型
* Singleton：显示时其他浮层会隐藏
* Normal: 普通
*/
builder.launchType(FunctionWidgetConfig.LaunchType.Normal)
/**
* 构造完成
*/
builder.build()
## 显示一个浮窗
完整代码请查阅com.qiniu.qplayer2.ui.page.longvideo.service.buffering.PlayerBufferingService
//浮窗的布局约束
val layoutParams = FunctionWidgetLayoutParams(ViewGroup.LayoutParams.WRAP_CONTENT, ViewGroup.LayoutParams.WRAP_CONTENT)
//对齐类型，总共有5个位置，上下左右中
layoutParams.layoutType = FunctionWidgetLayoutParams.LayoutAlignType.CENTER
//展示的层级，总共有4个层级，从下至上分别为EMBEDDED_VIEW/NORMAL/POPUP_WINDOW/DIALOG
layoutParams.functionType = FunctionWidgetLayoutParams.FunctionType.EMBEDDED_VIEW
//显示时的动画资源，如果不配置则用默认的，如果配置了NO_ANIMATION那么就没有动画，
layoutParams.enterAnim = FunctionWidgetLayoutParams.NO_ANIMATION
//隐藏时的动画资源，如果不配置则用默认的，如果配置了NO_ANIMATION那么就没有动画
layoutParams.exitAnim = FunctionWidgetLayoutParams.NO_ANIMATION
//点击非此widget区域，是否隐藏该widget
layoutParams.touchOutsideDismiss(false)
//展示widiget 并获得该widiget的token，通过token可以做一些其他操作
mBufferingToken = mPlayerCore.playerFunctionWidgetContainer?.showWidget(BufferingFunctionWidget::class.java, layoutParams)
## 如何在外部操作widget
可以针对某个widget实现一个继承自`Configuration`接口的类
/**
* 浮窗配置
* 如果某个浮窗需要配置，则继承该接口
*/
interface Configuration {
fun different(other: Configuration): Boolean
}
然后通过
`mPlayerCore.playerFunctionWidgetContainer?showWidget`方法将`Configuration`的派生类对象传递进去，如果Configuration的different方法返回true,那么就会触发onConfigurationChanged方法，在此方法中做对应的逻辑操作即可。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2
Android端](https://developer.qiniu.com/pili/sdk/12214/qplayer2-android) >
[基于Ext的QPlayer2接入指南](https://developer.qiniu.com/pili/sdk/12224/based-on-the-
ext-qplayer2-access-guide) > 通过Ext为播放器添加浮窗
# 通过Ext为播放器添加浮窗
最近更新时间: 2022-09-27 16:01:14
# 通过Ext为播放器添加浮窗
在播放器场景中，播放器上层的浮窗承载了绝大多数播放器的业务逻辑：选集、倍速、清晰度等等，如何处理浮窗的样式，动画，层级，需要有一个统一的架构来处理，Ext中的浮窗部分完美的统一了这些。
## 定义一个浮窗
所有浮窗都继承`BaseFunctionWidget`
class BufferingFunctionWidget(context: Context):
BaseFunctionWidget<LongLogicProvider, LongPlayableParams, LongVideoParams>(context)
{
//播放器核心对象
private lateinit var mPlayerCore: CommonPlayerCore<LongLogicProvider, LongPlayableParams, LongVideoParams>
override val tag: String
get() = "BufferingFunctionWidget"
//配置浮窗
override val functionWidgetConfig: FunctionWidgetConfig
get() {
val builder = FunctionWidgetConfig.Builder()
builder.persistent(true)
builder.dismissWhenVideoCompleted(true)
builder.dismissWhenVideoChange(false)
builder.dismissWhenScreenTypeChange(false)
builder.dismissWhenActivityStop(false)
builder.launchType(FunctionWidgetConfig.LaunchType.Normal)
return builder.build()
}
//浮窗显示时回调
override fun onWidgetShow() {
}
//浮窗隐藏时回调
override fun onWidgetDismiss() {
}
//创建时回调，在这里提供layout创建
override fun createContentView(context: Context): View {
return LayoutInflater.from(mContext).inflate(R.layout.function_buffering, null)
}
//销毁时回调
override fun onRelease() {
}
//用户外部通知的回调
override fun onConfigurationChanged(configuration: Configuration) {
}
//创建后回调，记得保存playerCore
override fun bindPlayerCore(playerCore: CommonPlayerCore<LongLogicProvider, LongPlayableParams, LongVideoParams>) {
mPlayerCore = playerCore
}
其中关于浮窗的配置
//配置构造器
val builder = FunctionWidgetConfig.Builder()
/**
* 当浮窗隐藏时，是否浮窗需要被销毁
* @param p true，无需销毁 false 需要销毁
*/
builder.persistent(true)
/**
* 当浮窗显示时，是否禁用屏幕旋转
* @param disable true，禁用屏幕旋转 false 不禁用屏幕旋转
*/
builder.changeOrientationDisableWhenShow(false)
/**
* 当 CommonVideoParams 切换时，是否浮窗需要被移除
* @param remove ture 需要移除 false 无需移除
*/
builder.removeWhenVideoChange(false)
/**
* 当CommonVideoParams播放完时，是否浮窗需要隐藏
* @param dismiss ture 需要隐藏 false 无需隐藏
*/
builder.dismissWhenVideoCompleted(true)
/**
* 当 CommonVideoParams 切换时，是否浮窗需要隐藏
* @param dismiss ture 需要隐藏 false 无需隐藏
*/
builder.dismissWhenVideoChange(false)
/**
* 当 @see[ScreenType] 改变时，是否浮窗需要隐藏
* @param dismiss ture 需要隐藏 false 无需隐藏
*/
builder.dismissWhenScreenTypeChange(false)
/**
* 当Activity stop时，是否浮窗需要隐藏
* @param dismiss ture 需要隐藏 false 无需隐藏
*/
builder.dismissWhenActivityStop(false)
/**
* 启动类型
* Singleton：显示时其他浮层会隐藏
* Normal: 普通
*/
builder.launchType(FunctionWidgetConfig.LaunchType.Normal)
/**
* 构造完成
*/
builder.build()
## 显示一个浮窗
完整代码请查阅com.qiniu.qplayer2.ui.page.longvideo.service.buffering.PlayerBufferingService
//浮窗的布局约束
val layoutParams = FunctionWidgetLayoutParams(ViewGroup.LayoutParams.WRAP_CONTENT, ViewGroup.LayoutParams.WRAP_CONTENT)
//对齐类型，总共有5个位置，上下左右中
layoutParams.layoutType = FunctionWidgetLayoutParams.LayoutAlignType.CENTER
//展示的层级，总共有4个层级，从下至上分别为EMBEDDED_VIEW/NORMAL/POPUP_WINDOW/DIALOG
layoutParams.functionType = FunctionWidgetLayoutParams.FunctionType.EMBEDDED_VIEW
//显示时的动画资源，如果不配置则用默认的，如果配置了NO_ANIMATION那么就没有动画，
layoutParams.enterAnim = FunctionWidgetLayoutParams.NO_ANIMATION
//隐藏时的动画资源，如果不配置则用默认的，如果配置了NO_ANIMATION那么就没有动画
layoutParams.exitAnim = FunctionWidgetLayoutParams.NO_ANIMATION
//点击非此widget区域，是否隐藏该widget
layoutParams.touchOutsideDismiss(false)
//展示widiget 并获得该widiget的token，通过token可以做一些其他操作
mBufferingToken = mPlayerCore.playerFunctionWidgetContainer?.showWidget(BufferingFunctionWidget::class.java, layoutParams)
## 如何在外部操作widget
可以针对某个widget实现一个继承自`Configuration`接口的类
/**
* 浮窗配置
* 如果某个浮窗需要配置，则继承该接口
*/
interface Configuration {
fun different(other: Configuration): Boolean
}
然后通过
`mPlayerCore.playerFunctionWidgetContainer?showWidget`方法将`Configuration`的派生类对象传递进去，如果Configuration的different方法返回true,那么就会触发onConfigurationChanged方法，在此方法中做对应的逻辑操作即可。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,656 |
通过Ext展示Toast | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2
Android端](https://developer.qiniu.com/pili/sdk/12214/qplayer2-android) >
[基于Ext的QPlayer2接入指南](https://developer.qiniu.com/pili/sdk/12224/based-on-the-
ext-qplayer2-access-guide) > 通过Ext展示Toast
# 通过Ext展示Toast
最近更新时间: 2022-09-27 16:01:21
# 通过Ext展示Toast
在Ext中，有属于播放器专属的Toast样式，它显示的位置在渲染画面的区域内，并支持纯文案\带超链接\特殊样式等不同形式的Toast,以下只展示最简单的使用，更多使用请查看API文档。
## 构建Toast
val toast = PlayerToast.Builder()
//toast类型为普通(即纯文本类型)
.toastItemType(PlayerToastConfig.TYPE_NORMAL)
//位置在左边
.location(PlayerToastConfig.LOCAT_LEFT_SIDE)
//设置文案
.setExtraString(PlayerToastConfig.EXTRA_TITLE, "清晰度开始切换至$newQuality,请稍候...")
//展示时长
.duration(PlayerToastConfig.DURATION_3)
//构建
.build()
## 显示Toast
mPlayerCore.playerToastContainer?.showToast(toast)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2
Android端](https://developer.qiniu.com/pili/sdk/12214/qplayer2-android) >
[基于Ext的QPlayer2接入指南](https://developer.qiniu.com/pili/sdk/12224/based-on-the-
ext-qplayer2-access-guide) > 通过Ext展示Toast
# 通过Ext展示Toast
最近更新时间: 2022-09-27 16:01:21
# 通过Ext展示Toast
在Ext中，有属于播放器专属的Toast样式，它显示的位置在渲染画面的区域内，并支持纯文案\带超链接\特殊样式等不同形式的Toast,以下只展示最简单的使用，更多使用请查看API文档。
## 构建Toast
val toast = PlayerToast.Builder()
//toast类型为普通(即纯文本类型)
.toastItemType(PlayerToastConfig.TYPE_NORMAL)
//位置在左边
.location(PlayerToastConfig.LOCAT_LEFT_SIDE)
//设置文案
.setExtraString(PlayerToastConfig.EXTRA_TITLE, "清晰度开始切换至$newQuality,请稍候...")
//展示时长
.duration(PlayerToastConfig.DURATION_3)
//构建
.build()
## 显示Toast
mPlayerCore.playerToastContainer?.showToast(toast)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,664 |
通过Ext进行手势处理 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2
Android端](https://developer.qiniu.com/pili/sdk/12214/qplayer2-android) >
[基于Ext的QPlayer2接入指南](https://developer.qiniu.com/pili/sdk/12224/based-on-the-
ext-qplayer2-access-guide) > 通过Ext进行手势处理
# 通过Ext进行手势处理
最近更新时间: 2022-09-27 16:01:28
# 通过Ext进行手势处理
Ext手势处理提供了多种手势回调，通过对象`mPlayerCore.playerGestureLayer`来添加手势回调。
* 单击事件
`fun addOnSingleTapListener( listener: OnSingleTapListener, priority: Int
= PriorityGestureProcessor.PRIORITY_NORMAL )`
* 单指双击
`fun addOnDoubleTapListener(listener: OnDoubleTapListener, priority: Int =
PriorityGestureProcessor.PRIORITY_NORMAL)`
* 两指双击
`fun addOnTwoFingerDoubleTapListener(listener: OnTwoFingerDoubleTapListener,
priority: Int = PriorityGestureProcessor.PRIORITY_NORMAL)`
* 缩放
`fun setResizableGestureListener(listener: OnResizableGestureListener?)`
* 水平滑动
`fun setHorizontalScrollListener(listener: HorizontalScrollListener?)`
* 右边竖直滑动
`fun setVerticalScrollRightListener(listener: VerticalScrollRightListener?)`
* 左边竖直滑动
`fun setVerticalScrollLeftListener(listener: VerticalScrollLeftListener?)`
* 长按
`fun addOnLongPressListener(listener: OnLongPressListener, priority: Int =
PriorityGestureProcessor.PRIORITY_NORMAL)`
* 自定义
`fun setOnTouchListener(listener: OnTouchListener?)`
在播放器销毁前，记得调用`remove`方法移除添加的`listener`。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2
Android端](https://developer.qiniu.com/pili/sdk/12214/qplayer2-android) >
[基于Ext的QPlayer2接入指南](https://developer.qiniu.com/pili/sdk/12224/based-on-the-
ext-qplayer2-access-guide) > 通过Ext进行手势处理
# 通过Ext进行手势处理
最近更新时间: 2022-09-27 16:01:28
# 通过Ext进行手势处理
Ext手势处理提供了多种手势回调，通过对象`mPlayerCore.playerGestureLayer`来添加手势回调。
* 单击事件
`fun addOnSingleTapListener( listener: OnSingleTapListener, priority: Int
= PriorityGestureProcessor.PRIORITY_NORMAL )`
* 单指双击
`fun addOnDoubleTapListener(listener: OnDoubleTapListener, priority: Int =
PriorityGestureProcessor.PRIORITY_NORMAL)`
* 两指双击
`fun addOnTwoFingerDoubleTapListener(listener: OnTwoFingerDoubleTapListener,
priority: Int = PriorityGestureProcessor.PRIORITY_NORMAL)`
* 缩放
`fun setResizableGestureListener(listener: OnResizableGestureListener?)`
* 水平滑动
`fun setHorizontalScrollListener(listener: HorizontalScrollListener?)`
* 右边竖直滑动
`fun setVerticalScrollRightListener(listener: VerticalScrollRightListener?)`
* 左边竖直滑动
`fun setVerticalScrollLeftListener(listener: VerticalScrollLeftListener?)`
* 长按
`fun addOnLongPressListener(listener: OnLongPressListener, priority: Int =
PriorityGestureProcessor.PRIORITY_NORMAL)`
* 自定义
`fun setOnTouchListener(listener: OnTouchListener?)`
在播放器销毁前，记得调用`remove`方法移除添加的`listener`。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,666 |
通过Ext进行选集控制 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2
Android端](https://developer.qiniu.com/pili/sdk/12214/qplayer2-android) >
[基于Ext的QPlayer2接入指南](https://developer.qiniu.com/pili/sdk/12224/based-on-the-
ext-qplayer2-access-guide) > 通过Ext进行选集控制
# 通过Ext进行选集控制
最近更新时间: 2022-09-27 16:01:36
# 通过Ext进行选集控制
在点播场景中，我们经常会遇到一个播放页里有一个系列的剧集，比如电视剧场景下，我们要在播放上切换到上一集，切换到下一集，或者是切换到某一集，在Ext很好的做到了这一切，根据前面的介绍，我们已经构建了CommonPlayerDataSource，那么选集控制就是利用这个数据源来实现的
当你在Ext架构内，你肯定能获取到PlayerCore 通过PlayerCore 我们就能拿到选集控制器，通过他我们就能很好来实现切集
mPlayerCore.mCommonPlayerVideoSwitcher
具体接口请参见API文档,包路径如下
com.qiniu.qplayer2ext.commonplayer.controller.CommonPlayerVideoSwitcher
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 播放端 >[QPlayer2
Android端](https://developer.qiniu.com/pili/sdk/12214/qplayer2-android) >
[基于Ext的QPlayer2接入指南](https://developer.qiniu.com/pili/sdk/12224/based-on-the-
ext-qplayer2-access-guide) > 通过Ext进行选集控制
# 通过Ext进行选集控制
最近更新时间: 2022-09-27 16:01:36
# 通过Ext进行选集控制
在点播场景中，我们经常会遇到一个播放页里有一个系列的剧集，比如电视剧场景下，我们要在播放上切换到上一集，切换到下一集，或者是切换到某一集，在Ext很好的做到了这一切，根据前面的介绍，我们已经构建了CommonPlayerDataSource，那么选集控制就是利用这个数据源来实现的
当你在Ext架构内，你肯定能获取到PlayerCore 通过PlayerCore 我们就能拿到选集控制器，通过他我们就能很好来实现切集
mPlayerCore.mCommonPlayerVideoSwitcher
具体接口请参见API文档,包路径如下
com.qiniu.qplayer2ext.commonplayer.controller.CommonPlayerVideoSwitcher
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,669 |
短视频解决方案说明 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 短视频 >短视频解决方案说明
# 短视频解决方案说明
最近更新时间: 2021-11-15 11:29:49
# 1、产品简介
七牛短视频解决方案是基于快速上传、转码、鉴黄、存储、分发等强大云端能力，集成拍摄、美颜、特效、滤镜、编辑、合成、本地压缩、上传、播放等客户端组件的一站式短视频解决方案。
# 2、产品架构
## 2.1 模块说明
1. 短视频 SDK
负责采集数据、媒体内容的处理、媒体文件的剪辑拼接以及上传到云端。
2. 播放器 SDK
负责拉取并播放视频文件。
3. 业务服务器
客户集成七牛云的储存服务端 SDK 后，具备创建和获取上传地址和播放地址的能力。
4. CDN 分发网络
负责流媒体的分发和查询。
5. 数据处理服务
支持鉴黄、转码、服务端水印、落存储。
# 3、短视频 SDK
## 3.1 产品架构图
**通过上述架构图可以看出，七牛的短视频 SDK 设计有两个重要的特点：**
1.组件化设计，方便客户像乐高积木一样组织自己的短视频 SDK，比如加入美颜滤镜技术。
2.在数据流动的 pipeline 里面，每个节点支持丰富的数据和状态回调。用户可以根据这些回调结合自己的业务做出更好玩的产品。
## 3.2 特点简介
**功能完善、性能优越**
* 客户端功能丰富：采集、处理、编码、封包、上传每一个过程都有丰富的功能，方便开发者在各种场景下都可以用七牛 SDK 做出优质的产品。
* 包体小，效率高：包体大小和 视频合成性能是开发者最关心的指标，我们在这些方面做了精心的优化
**设计灵活、生态丰富**
* 客户端接口灵活简单，便于自定义开发：除了提供丰富视的频处理功能，我们还考虑到开发者对接口使用方式的千差万别。所以在设计接口的时就做充分的考虑，尽量满足开发者各种使用姿势。
* 让专业的人做专业的事，发展客户端生态：集成各种三方美颜、滤镜、面部特效、AR特效，满足不同场景下的各种客户需求。
## 3.3 核心功能列表以及说明
功能 | 说明
---|---
实时美颜 | 提供七牛自带美颜方案，可以调节美颜的三个关键参数：美白、磨皮、粉嫩度
实时滤镜 | 提供七牛自带滤镜方案，可以选择几十款有趣的滤镜。
人脸特效 / 贴纸 | 该功能是面部识别技术的基础上发展而来。首先需要识别出人脸的关键点，然后根据面部特征来加上贴纸或者开启瘦脸、大眼的效果。
第三方美颜、滤镜接口 | 使用场景：客户有自研的美颜算法或者有更专业的美颜需求时，要求关闭默认美颜嵌入三方的美颜模块。
多段录制 | 使用场景：当用户需要拍摄多个场景的视频，并且需要把这些视频整合到一起。
回删视频 | 该功能主要是配合多段录制功能使用，在录制过程中有不满意或者错误的视频片段时可以用该功能删除。
客户端水印 | 可以为自己制作的短视频加上象印的 logo，以方便保证品牌露出
视频剪辑 | 客户在录制视频的时候会有冗余的片段，该功能可以满足客户删除冗余片段的需求。
关键帧预览 | 提供关键帧预览功能有助于用户能方便、精确的剪辑视频。
截取封面 | 用户可以通过该功能获取视频中的某些画面帧来作为短视频的封面。
音频混合 | 用户可以通过该功能在录制完短视频之后加入背景音乐，并且和视频原声进行混合。
截取音频片段 | 用户录制了一段视频后需要混入背景音乐，而音乐素材有较长的前奏用户希望直接混入高潮片段，这种场景下就需要截取音频片段功能。
画面剪裁 | 假设客户录制的内容源是 16：9 的，而希望上传 1：1 的方形视频，可以调用该功能来达到效果。
本地转码 | 客户从相册中导入一段视频，但是视频的尺寸非常大上传时间非常长。这时候可以启用被动转码功能，将视频转成小尺寸后再上传。
上传云端 | 默认集成了上传七牛云存储的上传 SDK，方便用户使用
断点续传 | 如果客户在上次文件时断网，不需要整个文件重新上传可以从断点继续上传。
## 3.4 基础功能列表
功能
---
摄像头采集
麦克风采集
静音功能
闪光灯开关
自定义分辨率
自定义视频帧率
自定义视频码率
支持 1：1 方正录制
手动对焦
自动对焦
曝光调节
调节原声/背景声音量
H.264 硬编
ACC 硬编
输出 mp4 文件
armeabi armv7, arm64, x86
## 3.5 关键指标
### 3.5.1 集成后包体增量
* iOS: App 的增量 100KB 以内
* Android: 2.2 MB
### 3.5.2 短视频 SDK 性能测试报告 （均值）
* 分辨率：480P 预设码率：800Kbps 美颜滤镜：全开 录制时长：10s
* CPU 10%
* Memory 66 MB
* 合成效率：6s
* 分辨率：720P 预设码率：800Kbps 美颜滤镜：全开 录制时长：10s
* CPU 11%
* Memory 68 MB
* 合成效率：7s
* 分辨率：1080P 预设码率：800Kbps 美颜滤镜：全开 录制时长：10s
* CPU 12%
* Memory 90 MB
* 合成效率：10s
## 3.6 开发文档
### 3.6.1 短视频 SDK 开发文档
* iOS：https://developer.qiniu.com/pili/sdk/3733/short-video-ios-sdk
* Android：https://developer.qiniu.com/pili/sdk/3734/short-video-android-sdk
# 4、播放器 SDK
## 4.1 特点简介
**功能丰富、包体轻盈**
* 提供特色功能：H.265 软硬解支持，播放变速不变调，无卡顿滑屏切换、倍数播放、丰富的数据统计、边下边播、本地缓存。
* 包体轻盈、性能出色：基本不依赖于各种三方库，包体极致轻盈。且无论针对软硬解码，还是 H.264 还是 H.265 解码效果都由于其他播放器。
**毫秒级首开、全平台支持**
* 首开作为核心指标精心优化，正常网络环境下 100 ms 以内即可以开播。
* 七牛视频播放器是一款原创的媒体播放器。底层是用汇 编，C，C++开发的跨平台播放引擎。在平台层进行包装，并提供接口给客户使用。
## 4.2 核心功能列表以及说明
功能 | 说明
---|---
支持倍数播放 | 0.1x，0.5x，1x，2x，最高可达 32 倍速度播放。
支持变速不变调功能 | 使用场景：直播时由于网络抖动可能导致大量的媒体数据积累在缓存当中，这时播放器开启追帧会导致音视频的加速播放。变速不变调功能会通过改变音频的频谱如：将几个帧的音频合成一个中间值作为一帧来播放，这样播放速度不用加快而用户听起来的音调也差不多。
毫秒级别首开 | 本播放器优化视频的解析速度，
支持 DRM 数字版权保护 | 数字版权保护是指：七牛的服务端可以给短视频加密，而播放器需要支持对加密后的音视频文件进行对应的解密。
支持 H.265 播放 | H.265 编码的视频可以节省大量的传输带宽和存储空间，七牛播放器可以支持高效的 H.265 解码。
提供丰富的播放状态回调 | 播放器 SDK 会将视频播放过程中的状态实时回调给用户，比如首帧渲染、buffering 等相关状态。客户可以更加这些状态来调整应用的业务逻辑。
提供播放音视频数据回调 | 客户可以在播放的时候
提供播放数据统计接口 | 播放数据统计接口可以首开、卡顿、帧率、码率等
支持设置封面 | 可以支持给音视频内容加上封面
支持边下边播 | 该功能主要是指：在播放过程中会先预加载一些音视频内容，这样处理可以在网络条件好的情况下多缓存一些内容，在网络变差的情况下有更多的时间加载内容。
支持播放缓存 | 播放缓存主要是让用户不用每次打开同一个视频都要去网络上读取数据，可以帮用户节省时间和流量。
支持软硬解自动切换 | 七牛播放器同时支持软解码和硬解码，且在硬解码失败后可以动态的切换到软解码。这样即可以享受硬解的低性能开销，有课保证不受硬解失败的影响。
提供接口获取 | metadata 信息 该功能可以用来获取音视频相关信息也可以用来诊断某些流的问题，比如一些设备信息和网络信息都可以放在 metadata 里面。当该用户上传的流或者视频出问题的时候，可以精确的提出这些信息用于诊断问题。
## 4.3 基础功能列表
功能
---
支持音量设置
支持后台播放
支持画面镜像翻转
支持画面旋转
支持设置画面预览模式
支持 DNS 解析优化
支持后台播放
支持带 IP 地址的播放 URL
支持 HTTPS 协议
支持自动重连
支持 armeabi，armv7, arm64, x86
## 4.4 关键指标
### 4.4.1 集成后包体增量
iOS: 4MB
Android：2.3 MB
### 4.4.2 首屏秒开速度
网络正常的条件下 100ms 以内
### 4.4.3 性能测试（均值）
* 720P 软解
* CPU 12%
* Memory 60 MB
* 720P 硬解
* CPU 5.5%
* Memory 51 MB
* 1080P 软解
* CPU 18%
* Memory 74 MB
* 1080P 硬解
* CPU 6.3%
* Memory 52 MB
## 4.4 开发文档
* iOS：https://developer.qiniu.com/pili/sdk/1211/ios-playback-end-the-sdk
* Android：https://developer.qiniu.com/pili/sdk/1210/the-android-client-sdk
# 5、短视频落存储
## 5.1 基本结构
**七牛云存储服务**
七牛云存储服务是以键值对方式提供非结构化资源存储服务。向业务服务器提供资源管理服务，向客户端提供资源上传和下载服务。
**业务服务器**
业务服务器需要开发者自行管理和维护，并且至少提供如下几个基本功能：
生成各种安全凭证（参考安全机制），安全凭证的创建不能在客户端进行，否则会产生极大的安全风险。
使用关系型数据库（例如MySQL）管理用户帐号信息。最终用户信息的管理并非云存储服务的功能范畴。云存储服务只管理企业账号。
使用数据库管理资源元数据和资源之间的关联关系。
响应客户端的业务请求，执行业务流程并返回执行结果。
**客户端**
客户端通常同时是资源的生产方和消费方。客户端在展示内容时，通常需要先从业务服务器获取资源的元信息，并得到必要的下载凭证，然后使用下载凭证从七牛云存储服务获取待展示的资源内容，从而实现一个完整的内容展示过程。
## 5.2 业务流程
**上传**
客户端在上传资源到七牛云存储之前要先从业务服务器获取一个有效的上传凭证，因此需要先后和两个服务端打交道。
如果有设置回调，则上传完成时七牛云存储会自动发起回调到指定的业务服务器。
**下载**
公开资源不需要对应的下载凭证，客户端可以直接从七牛云存储下载对应资源。私有资源需要对应的下载凭证，因此必须先和业务服务器打交道。
按照实际的使用场景，客户端对于内容的展示非常类似一个动态网页的生成过程，因此无论该页面内容是公开还是私有，均需要从业务服务器获取展示该页面的动态布局信息。所以通常显示过程也是需要先后和业务服务器及七牛云存储服务打交道。
**资源管理**
为了防止安全漏洞，资源管理操作应该只在业务服务器端进行。如果允许客户端进行资源管理，即使将管理凭证的生成动作放到业务服务器端进行，仍然很容易被第三方截获请求全文，从而导致重放攻击的风险。
## 5.3 开发文档
API Reference https://developer.qiniu.com/kodo/api/1731/api-overview
产品手册 https://developer.qiniu.com/kodo/manual/1277/product-introduction
# 6、短视频数据处理
## 6.1 简介
七牛数据处理平台针对海量数据，提供零运维、高可用、高性能的数据处理服务，日处理数近百亿次。除了提供基础数据处理，还基于容器技术打造了易扩展、易部署、高自由度的自定义数据处理接入平台，与七牛数据处理服务无缝兼容使用。
**官方数据处理服务**
提供图片裁剪、缩放、格式转化、水印、原图保护和防盗链，以及音视频转码、切片和拼接等基础的数据处理服务，服务内容还在不断丰富中。
**自定义数据处理平台**
允许用户构建、上传自定义的私有数据处理服务，支持管道处理、持久化、预处理操作等所有特性。
**第三方数据处理市场**
作为一个开放的应用平台，欢迎各种图片、音视频、以及其他数据处理的第三方应用提供方接入，为七牛存储中的海量数据，提供增值的数据处理服务。
## 6.2 音视频相关处理服务
音视频数据处理：https://developer.qiniu.com/dora/manual/3685/directions-for-use-av
鉴黄鉴恐：https://developer.qiniu.com/dora/manual/1295/image-as-a-yellow-services-
stage
# 7、短视频融合 CDN
## 7.1 简介
融合 CDN 是在传统 CDN 基础上实现的对数据网络加速进一步优化的融合管理服务。除了服务于音视频点播、文件、应用与 Web
加速，以及各类增值场景外，七牛融合 CDN 还通过全方位的 CDN
质量监控，以及智能易用的加速节点调度等功能，保障用户服务的连续性，提供稳定快速的网络访问质量。
**无盲区**
成熟的多 CDN 融合管控方案，精选主流 CDN 厂商优质节点，与七牛云自有高质量节点相结合，全面覆盖各地区各运营商网络，真正做到无盲区。
**智能调度**
基于七牛云自有 IP 库，结合全网宕机与性能监控研发的智能融合调度系统，支持 DNS、HTTPDNS、IP302 调度方式，能有效防止访问劫持，实现
100% 实时调度精准可控。
**立体品控**
基于权威 APM 厂商覆盖性能监控，七牛自研全网实时可用性监控，SDK 日志上报实时访问性能监控，打造七牛融合 CDN 立体品控体系。
**降低回源**
自建 BGP 网络中间源，消除跨运营商网络回源慢甚至不可达等问题，保护源站带宽不受边缘节点请求波动影响，节省回源成本。
##7.2 音视频相关处理服务
产品文档：https://developer.qiniu.com/fusion/manual/3824/product-overview-fusion
API Reference：https://developer.qiniu.com/fusion/api/1230/traffic-bandwidth
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 短视频 >短视频解决方案说明
# 短视频解决方案说明
最近更新时间: 2021-11-15 11:29:49
# 1、产品简介
七牛短视频解决方案是基于快速上传、转码、鉴黄、存储、分发等强大云端能力，集成拍摄、美颜、特效、滤镜、编辑、合成、本地压缩、上传、播放等客户端组件的一站式短视频解决方案。
# 2、产品架构
## 2.1 模块说明
1. 短视频 SDK
负责采集数据、媒体内容的处理、媒体文件的剪辑拼接以及上传到云端。
2. 播放器 SDK
负责拉取并播放视频文件。
3. 业务服务器
客户集成七牛云的储存服务端 SDK 后，具备创建和获取上传地址和播放地址的能力。
4. CDN 分发网络
负责流媒体的分发和查询。
5. 数据处理服务
支持鉴黄、转码、服务端水印、落存储。
# 3、短视频 SDK
## 3.1 产品架构图
**通过上述架构图可以看出，七牛的短视频 SDK 设计有两个重要的特点：**
1.组件化设计，方便客户像乐高积木一样组织自己的短视频 SDK，比如加入美颜滤镜技术。
2.在数据流动的 pipeline 里面，每个节点支持丰富的数据和状态回调。用户可以根据这些回调结合自己的业务做出更好玩的产品。
## 3.2 特点简介
**功能完善、性能优越**
* 客户端功能丰富：采集、处理、编码、封包、上传每一个过程都有丰富的功能，方便开发者在各种场景下都可以用七牛 SDK 做出优质的产品。
* 包体小，效率高：包体大小和 视频合成性能是开发者最关心的指标，我们在这些方面做了精心的优化
**设计灵活、生态丰富**
* 客户端接口灵活简单，便于自定义开发：除了提供丰富视的频处理功能，我们还考虑到开发者对接口使用方式的千差万别。所以在设计接口的时就做充分的考虑，尽量满足开发者各种使用姿势。
* 让专业的人做专业的事，发展客户端生态：集成各种三方美颜、滤镜、面部特效、AR特效，满足不同场景下的各种客户需求。
## 3.3 核心功能列表以及说明
功能 | 说明
---|---
实时美颜 | 提供七牛自带美颜方案，可以调节美颜的三个关键参数：美白、磨皮、粉嫩度
实时滤镜 | 提供七牛自带滤镜方案，可以选择几十款有趣的滤镜。
人脸特效 / 贴纸 | 该功能是面部识别技术的基础上发展而来。首先需要识别出人脸的关键点，然后根据面部特征来加上贴纸或者开启瘦脸、大眼的效果。
第三方美颜、滤镜接口 | 使用场景：客户有自研的美颜算法或者有更专业的美颜需求时，要求关闭默认美颜嵌入三方的美颜模块。
多段录制 | 使用场景：当用户需要拍摄多个场景的视频，并且需要把这些视频整合到一起。
回删视频 | 该功能主要是配合多段录制功能使用，在录制过程中有不满意或者错误的视频片段时可以用该功能删除。
客户端水印 | 可以为自己制作的短视频加上象印的 logo，以方便保证品牌露出
视频剪辑 | 客户在录制视频的时候会有冗余的片段，该功能可以满足客户删除冗余片段的需求。
关键帧预览 | 提供关键帧预览功能有助于用户能方便、精确的剪辑视频。
截取封面 | 用户可以通过该功能获取视频中的某些画面帧来作为短视频的封面。
音频混合 | 用户可以通过该功能在录制完短视频之后加入背景音乐，并且和视频原声进行混合。
截取音频片段 | 用户录制了一段视频后需要混入背景音乐，而音乐素材有较长的前奏用户希望直接混入高潮片段，这种场景下就需要截取音频片段功能。
画面剪裁 | 假设客户录制的内容源是 16：9 的，而希望上传 1：1 的方形视频，可以调用该功能来达到效果。
本地转码 | 客户从相册中导入一段视频，但是视频的尺寸非常大上传时间非常长。这时候可以启用被动转码功能，将视频转成小尺寸后再上传。
上传云端 | 默认集成了上传七牛云存储的上传 SDK，方便用户使用
断点续传 | 如果客户在上次文件时断网，不需要整个文件重新上传可以从断点继续上传。
## 3.4 基础功能列表
功能
---
摄像头采集
麦克风采集
静音功能
闪光灯开关
自定义分辨率
自定义视频帧率
自定义视频码率
支持 1：1 方正录制
手动对焦
自动对焦
曝光调节
调节原声/背景声音量
H.264 硬编
ACC 硬编
输出 mp4 文件
armeabi armv7, arm64, x86
## 3.5 关键指标
### 3.5.1 集成后包体增量
* iOS: App 的增量 100KB 以内
* Android: 2.2 MB
### 3.5.2 短视频 SDK 性能测试报告 （均值）
* 分辨率：480P 预设码率：800Kbps 美颜滤镜：全开 录制时长：10s
* CPU 10%
* Memory 66 MB
* 合成效率：6s
* 分辨率：720P 预设码率：800Kbps 美颜滤镜：全开 录制时长：10s
* CPU 11%
* Memory 68 MB
* 合成效率：7s
* 分辨率：1080P 预设码率：800Kbps 美颜滤镜：全开 录制时长：10s
* CPU 12%
* Memory 90 MB
* 合成效率：10s
## 3.6 开发文档
### 3.6.1 短视频 SDK 开发文档
* iOS：https://developer.qiniu.com/pili/sdk/3733/short-video-ios-sdk
* Android：https://developer.qiniu.com/pili/sdk/3734/short-video-android-sdk
# 4、播放器 SDK
## 4.1 特点简介
**功能丰富、包体轻盈**
* 提供特色功能：H.265 软硬解支持，播放变速不变调，无卡顿滑屏切换、倍数播放、丰富的数据统计、边下边播、本地缓存。
* 包体轻盈、性能出色：基本不依赖于各种三方库，包体极致轻盈。且无论针对软硬解码，还是 H.264 还是 H.265 解码效果都由于其他播放器。
**毫秒级首开、全平台支持**
* 首开作为核心指标精心优化，正常网络环境下 100 ms 以内即可以开播。
* 七牛视频播放器是一款原创的媒体播放器。底层是用汇 编，C，C++开发的跨平台播放引擎。在平台层进行包装，并提供接口给客户使用。
## 4.2 核心功能列表以及说明
功能 | 说明
---|---
支持倍数播放 | 0.1x，0.5x，1x，2x，最高可达 32 倍速度播放。
支持变速不变调功能 | 使用场景：直播时由于网络抖动可能导致大量的媒体数据积累在缓存当中，这时播放器开启追帧会导致音视频的加速播放。变速不变调功能会通过改变音频的频谱如：将几个帧的音频合成一个中间值作为一帧来播放，这样播放速度不用加快而用户听起来的音调也差不多。
毫秒级别首开 | 本播放器优化视频的解析速度，
支持 DRM 数字版权保护 | 数字版权保护是指：七牛的服务端可以给短视频加密，而播放器需要支持对加密后的音视频文件进行对应的解密。
支持 H.265 播放 | H.265 编码的视频可以节省大量的传输带宽和存储空间，七牛播放器可以支持高效的 H.265 解码。
提供丰富的播放状态回调 | 播放器 SDK 会将视频播放过程中的状态实时回调给用户，比如首帧渲染、buffering 等相关状态。客户可以更加这些状态来调整应用的业务逻辑。
提供播放音视频数据回调 | 客户可以在播放的时候
提供播放数据统计接口 | 播放数据统计接口可以首开、卡顿、帧率、码率等
支持设置封面 | 可以支持给音视频内容加上封面
支持边下边播 | 该功能主要是指：在播放过程中会先预加载一些音视频内容，这样处理可以在网络条件好的情况下多缓存一些内容，在网络变差的情况下有更多的时间加载内容。
支持播放缓存 | 播放缓存主要是让用户不用每次打开同一个视频都要去网络上读取数据，可以帮用户节省时间和流量。
支持软硬解自动切换 | 七牛播放器同时支持软解码和硬解码，且在硬解码失败后可以动态的切换到软解码。这样即可以享受硬解的低性能开销，有课保证不受硬解失败的影响。
提供接口获取 | metadata 信息 该功能可以用来获取音视频相关信息也可以用来诊断某些流的问题，比如一些设备信息和网络信息都可以放在 metadata 里面。当该用户上传的流或者视频出问题的时候，可以精确的提出这些信息用于诊断问题。
## 4.3 基础功能列表
功能
---
支持音量设置
支持后台播放
支持画面镜像翻转
支持画面旋转
支持设置画面预览模式
支持 DNS 解析优化
支持后台播放
支持带 IP 地址的播放 URL
支持 HTTPS 协议
支持自动重连
支持 armeabi，armv7, arm64, x86
## 4.4 关键指标
### 4.4.1 集成后包体增量
iOS: 4MB
Android：2.3 MB
### 4.4.2 首屏秒开速度
网络正常的条件下 100ms 以内
### 4.4.3 性能测试（均值）
* 720P 软解
* CPU 12%
* Memory 60 MB
* 720P 硬解
* CPU 5.5%
* Memory 51 MB
* 1080P 软解
* CPU 18%
* Memory 74 MB
* 1080P 硬解
* CPU 6.3%
* Memory 52 MB
## 4.4 开发文档
* iOS：https://developer.qiniu.com/pili/sdk/1211/ios-playback-end-the-sdk
* Android：https://developer.qiniu.com/pili/sdk/1210/the-android-client-sdk
# 5、短视频落存储
## 5.1 基本结构
**七牛云存储服务**
七牛云存储服务是以键值对方式提供非结构化资源存储服务。向业务服务器提供资源管理服务，向客户端提供资源上传和下载服务。
**业务服务器**
业务服务器需要开发者自行管理和维护，并且至少提供如下几个基本功能：
生成各种安全凭证（参考安全机制），安全凭证的创建不能在客户端进行，否则会产生极大的安全风险。
使用关系型数据库（例如MySQL）管理用户帐号信息。最终用户信息的管理并非云存储服务的功能范畴。云存储服务只管理企业账号。
使用数据库管理资源元数据和资源之间的关联关系。
响应客户端的业务请求，执行业务流程并返回执行结果。
**客户端**
客户端通常同时是资源的生产方和消费方。客户端在展示内容时，通常需要先从业务服务器获取资源的元信息，并得到必要的下载凭证，然后使用下载凭证从七牛云存储服务获取待展示的资源内容，从而实现一个完整的内容展示过程。
## 5.2 业务流程
**上传**
客户端在上传资源到七牛云存储之前要先从业务服务器获取一个有效的上传凭证，因此需要先后和两个服务端打交道。
如果有设置回调，则上传完成时七牛云存储会自动发起回调到指定的业务服务器。
**下载**
公开资源不需要对应的下载凭证，客户端可以直接从七牛云存储下载对应资源。私有资源需要对应的下载凭证，因此必须先和业务服务器打交道。
按照实际的使用场景，客户端对于内容的展示非常类似一个动态网页的生成过程，因此无论该页面内容是公开还是私有，均需要从业务服务器获取展示该页面的动态布局信息。所以通常显示过程也是需要先后和业务服务器及七牛云存储服务打交道。
**资源管理**
为了防止安全漏洞，资源管理操作应该只在业务服务器端进行。如果允许客户端进行资源管理，即使将管理凭证的生成动作放到业务服务器端进行，仍然很容易被第三方截获请求全文，从而导致重放攻击的风险。
## 5.3 开发文档
API Reference https://developer.qiniu.com/kodo/api/1731/api-overview
产品手册 https://developer.qiniu.com/kodo/manual/1277/product-introduction
# 6、短视频数据处理
## 6.1 简介
七牛数据处理平台针对海量数据，提供零运维、高可用、高性能的数据处理服务，日处理数近百亿次。除了提供基础数据处理，还基于容器技术打造了易扩展、易部署、高自由度的自定义数据处理接入平台，与七牛数据处理服务无缝兼容使用。
**官方数据处理服务**
提供图片裁剪、缩放、格式转化、水印、原图保护和防盗链，以及音视频转码、切片和拼接等基础的数据处理服务，服务内容还在不断丰富中。
**自定义数据处理平台**
允许用户构建、上传自定义的私有数据处理服务，支持管道处理、持久化、预处理操作等所有特性。
**第三方数据处理市场**
作为一个开放的应用平台，欢迎各种图片、音视频、以及其他数据处理的第三方应用提供方接入，为七牛存储中的海量数据，提供增值的数据处理服务。
## 6.2 音视频相关处理服务
音视频数据处理：https://developer.qiniu.com/dora/manual/3685/directions-for-use-av
鉴黄鉴恐：https://developer.qiniu.com/dora/manual/1295/image-as-a-yellow-services-
stage
# 7、短视频融合 CDN
## 7.1 简介
融合 CDN 是在传统 CDN 基础上实现的对数据网络加速进一步优化的融合管理服务。除了服务于音视频点播、文件、应用与 Web
加速，以及各类增值场景外，七牛融合 CDN 还通过全方位的 CDN
质量监控，以及智能易用的加速节点调度等功能，保障用户服务的连续性，提供稳定快速的网络访问质量。
**无盲区**
成熟的多 CDN 融合管控方案，精选主流 CDN 厂商优质节点，与七牛云自有高质量节点相结合，全面覆盖各地区各运营商网络，真正做到无盲区。
**智能调度**
基于七牛云自有 IP 库，结合全网宕机与性能监控研发的智能融合调度系统，支持 DNS、HTTPDNS、IP302 调度方式，能有效防止访问劫持，实现
100% 实时调度精准可控。
**立体品控**
基于权威 APM 厂商覆盖性能监控，七牛自研全网实时可用性监控，SDK 日志上报实时访问性能监控，打造七牛融合 CDN 立体品控体系。
**降低回源**
自建 BGP 网络中间源，消除跨运营商网络回源慢甚至不可达等问题，保护源站带宽不受边缘节点请求波动影响，节省回源成本。
##7.2 音视频相关处理服务
产品文档：https://developer.qiniu.com/fusion/manual/3824/product-overview-fusion
API Reference：https://developer.qiniu.com/fusion/api/1230/traffic-bandwidth
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,671 |
短视频 SDK 功能列表 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 短视频 >短视频 SDK 功能列表
# 短视频 SDK 功能列表
最近更新时间: 2022-06-27 14:21:23
# 产品简介
七牛短视频 SDK，方便开发者快速实现短视频拍摄、剪辑、编辑、合成、分发功能。我们提供 80+ 功能供开发使用，申请 **0 元体验** 可 [点击此处
__](https://qmall.qiniu.com/template/MTE1)获得产品试用权限。
# 多版本功能分布
短视频SDK主要区分精简版、基础版、进阶版、专业版 4 个版本，不同版本的功能区别见如下表格
功能 | 子功能 | 精简版
(Smart) | 基础版
(Basic) | 进阶版
(Advanced) | 专业版
(Pro)
---|---|---|---|---|---
**交互界面** | **提供了一套完整的UI交互源码，可复用或自定义** | ✓ | ✓ | ✓ | ✓
**拍摄设置** | **摄像头采集** | ✓ | ✓ | ✓ | ✓
| **麦克风采集** | ✓ | ✓ | ✓ | ✓
| **视频采集参数定义**
_支持最高 1080P 拍摄，支持自定义视频采集源、采集画面的分辨率、采集画面的长宽比等参数_ | ✓ | ✓ | ✓ | ✓
| **音频采集参数定义**
_支持自定义音频采集源、音频格式、音频声道、音频采样率等参数_ | ✓ | ✓ | ✓ | ✓
| **视频编码参数定义**
_支持自定义编码视频的码率、帧率、分辨率、H.264 编码方式等参数_ | ✓ | ✓ | ✓ | ✓
| **音频编码参数定义**
_支持自定义编码音频的码率、采样率、声道数、AAC 编码方式等参数_ | ✓ | ✓ | ✓ | ✓
| **拍摄时长设置**
_支持设置实际拍摄过程中的最大、最小拍摄时长_ | ✓ | ✓ | ✓ | ✓
| **前后台切换**
_根据监听到 Application 的前后台状态自动停止和开始录制视频，默认从后台进入前台自动开始录制_ | ✓ | ✓ | ✓ | ✓
| **摄像头切换**
_支持切换前后摄像头进行拍摄_ | ✓ | ✓ | ✓ | ✓
| **闪光灯设置**
_支持开关闪光灯用于拍摄时的补光_ | ✓ | ✓ | ✓ | ✓
| **画面镜像**
_支持设置是否镜像预览画面和编码画面_ | ✓ | ✓ | ✓ | ✓
| **画面对焦**
_支持手动对焦和自动对焦_ | ✓ | ✓ | ✓ | ✓
| **焦距调节**
_支持手动调节画面焦距进行放大、缩小_ | ✓ | ✓ | ✓ | ✓
| **曝光调节**
_支持调整曝光度参数_ | ✓ | ✓ | ✓ | ✓
**拍摄模式** | **横屏拍摄**
_支持根据设备的方向自动确定竖屏、横屏拍摄_ | ✓ | ✓ | ✓ | ✓
| **分段拍摄**
_支持拍摄过程中实现连续多次拍摄、断点续拍、回删_ | ✓ | ✓ | ✓ | ✓
| **静音拍摄**
_支持静音拍摄_ | ✓ | ✓ | ✓ | ✓
| **音频录制**
_支持纯音频录制_ | ✓ | ✓ | ✓ | ✓
| **屏幕录制**
_支持对整个屏幕区域进行录制，实现整体的录制效果_ | ✓ | ✓ | ✓ | ✓
| **变速拍摄**
_支持设置拍摄时的快/慢速率（默认正常速率，只支持 2 的次方倍数，如 0.25 倍、0.5 倍，1 倍，2 倍，4 倍等等）_ | ✗ | ✓ | ✓ | ✓
| **分屏拍摄（合拍）**
_可以导入视频进行合拍，生成双画面视频_ | ✗ | ✗ | ✓ | ✓
**实时处理** | **实时截图**
_支持拍摄时实时截图拍照保存到本地_ | ✓ | ✓ | ✓ | ✓
| **实时预览**
_支持实时本地预览_ | ✓ | ✓ | ✓ | ✓
| **实时水印**
_支持拍摄时添加静态水印，支持设置水印位置、大小、透明度，设置作用时间范围_ | ✗ | ✓ | ✓ | ✓
| **实时美颜**
支持拍摄时启用美颜功能，支持设置美颜、美白、红润3种效果并调节强度 | ✓ | ✓ | ✓ | ✓
| **背景音乐**
_支持拍摄前选择本地文件作为背景音乐_ | ✗ | ✓ | ✓ | ✓
**基础编辑** | **视频导入**
_支持本地视频快速导入后编辑_ | ✓ | ✓ | ✓ | ✓
| **编辑预览**
_支持编辑时实时预览本地效果_ | ✓ | ✓ | ✓ | ✓
| **时长剪裁**
_支持时长裁剪，按照给定的时间范围生成一个 mp4 文件_ | ✓ | ✓ | ✓ | ✓
| **本地转码**
_支持按照给定的码率、帧率等参数，生成一个 mp4 文件_ | ✓ | ✓ | ✓ | ✓
| **视频旋转**
_支持按照给定的目标旋转角度，生成一个 mp4 文件_ | ✗ | ✓ | ✓ | ✓
| **画面剪裁**
_支持画面裁剪，按照视频画面大小（自定义比例、自定义区域）精确裁剪视频生成一个mp4文件_ | ✗ | ✗ | ✓ | ✓
**特效编辑** | **视频旋转特效**
_支持设置视频左右上下旋转，实时预览旋转效果_ | ✗ | ✓ | ✓ | ✓
| **单音频混音**
_支持给视频文件添加单音频，实现混音效果_ | ✗ | ✓ | ✓ | ✓
| **滤镜特效**
_支持给视频文件添加滤镜效果，默认支持 33 种滤镜效果_ | ✗ | ✓
提供 10 种滤镜效果 | ✓
提供 33 种滤镜效果 | ✓
提供 33 种滤镜效果
| **涂鸦特效**
_支持画笔尺寸和颜色调整，支持设置特效显示的时间范围_ | ✗ | ✓ | ✓ | ✓
| **字幕特效**
_支持给视频文件添加文字特效，支持设置文字内容，字体大小，字体颜色，透明度，旋转，位置等，支持设置特效显示的时间范围_ | ✗ | ✓ | ✓ | ✓
| **水印特效**
_支持给视频文件添加静态、动态水印，并且能够自由设置水印的大小、位置、透明度、旋转角度，支持设置特效显示的时间范围，可以自定义素材或使用供应商提供的收费素材_ | ✗ | ✓ | ✓ | ✓
| **贴纸特效**
_支持给视频文件添加静态贴纸，并且能够自由设置贴纸大小、位置、旋转角度，支持设置特效显示的时间范围，可以自定义素材或使用供应商提供的收费素材_ | ✗ | ✓ | ✓ | ✓
| **时间特效**
_支持对视频文件进行整体变速、分段变速（变速只支持 2 的次方倍数，如 0.25 倍、0.5 倍、1 倍、2倍、4 倍等）_ | ✗ | ✓ | ✓ | ✓
| **时光倒流**
_支持 1 种倒放操作（即时光倒流特效）_ | ✗ | ✗ | ✓ | ✓
| **音乐唱片**
_支持音频录制的过程中，增加图片旋转效果，输出为 mp4 文件_ | ✗ | ✗ | ✓ | ✓
| **多音频混音**
_支持给视频文件添加多个背景音乐，支持调整视频原声、背景音乐音量，支持设置多个背景音乐有效时间区域，支持自己录音或者选用本地音乐_ | ✗ | ✗ | ✗ | ✓
| **MV 特效**
_支持给视频文件添加 MV 效果，默认提供 4 种 MV 特效，客户可根据要求自行创作 MV 效果_ | ✗ | ✗ | ✗ | ✓
**多素材编排** | **视频拼接**
_支持设置多个视频按照前后顺序导入拼接生成一个 mp4 文件_ | ✗ | ✗ | ✓ | ✓
| **GIF 动画**
_支持基于多个图片或视频直接导出 GIF 动图_ | ✗ | ✗ | ✓ | ✓
| **图片拼接**
_支持设置多个图片按照前后顺序导入拼接生成一个 mp4 文件，支持设置图片之间的转场动画，例如：淡入淡出、闪黑、闪白、圆形、飞入和擦除_ | ✗ | ✗ | ✓ | ✓
| **基础转场**
_支持在视频图片片段之间，增加淡入淡出效果_ | ✗ | ✗ | ✓ | ✓
| **过场字幕**
_支持在视频之间增加转场字幕，支持定义转场字幕的背景色、持续时间、支持文字和图片特效，支持旋转、放大、位置移动、淡入淡出 4 种效果_ | ✗ | ✗ | ✓ | ✓
| **视频合成**
_支持设置多个视频合并为一个视频，支持设置每一个视频在画面中的位置、大小、开始播放时间等。该功能与上方视频拼接不同，视频拼接只允许设置参与拼接的多个视频的播放顺序_ | ✗ | ✗ | ✗ | ✓
| **图片 & GIF 图 & 视频混拼**
_支持设置多个视频和图片按照前后顺序导入拼接生成一个 mp4 文件_ | ✗ | ✗ | ✗ | ✓
**其他功能** | **草稿箱**
_支持将当前录制的片段与设置项存入草稿箱_ | ✓ | ✓ | ✓ | ✓
| **接口扩展**
_扩展接口支持对接第三方美颜特效等增值能力_ | ✓ | ✓ | ✓ | ✓
| **外部裸数据导入**
_支持外部音视频裸数据导入，生成 mp4 文件_ | ✗ | ✗ | ✗ | ✓
| **View 录制**
_支持 View 录制_ | ✗ | ✗ | ✗ | ✓
**视频播放** | **播放器 SDK** | ✓ | ✓ | ✓ | ✓
**上传分发** | **视频上传** | ✓ | ✓ | ✓ | ✓
| **断点续传** | ✓ | ✓ | ✓ | ✓
| **上传加速** | ✓ | ✓ | ✓ | ✓
增值能力方面，需要单独选购，在视频拍摄或视频编辑阶段增加，4个版本都支持相关开放接口。
**功能**
---
**高级美颜**
_拍摄设置大眼、瘦脸、V脸、下巴调整、短脸、小鼻效果，并支持调节强度_
**人脸贴纸**
_支持人脸识别，进行人脸 2D、3D 贴纸操作_
**手势识别**
_可以对拍摄的人物的特定手势进行识别，配合其他特效_
**AR 特效**
_支持拍摄时设置 AR 特效_
**变声**
_拍摄时对录制的人音进行变声（如萝莉、大叔）_
**类抖音特效**
_滤镜效果，支持抖动、幻觉、灵魂出窍等数种抖音特效_
**背景抠图**
_将画面中的绿色元素(比如纯绿背景)抠除，替换成其他的元素，比如动态背景/ PPT 等_
资费注意事项：
七牛短视频 SDK区分精简版、基础版、进阶版、专业版 4
个版本，不同版本对应不同的价格策略，获取更多商务优惠信息可直接与您对应的客户经理联系，原有预充值优惠策略不再提供，预充值款项可继续正常消耗七牛相关产品服务，但不提供退款服务
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 短视频 >短视频 SDK 功能列表
# 短视频 SDK 功能列表
最近更新时间: 2022-06-27 14:21:23
# 产品简介
七牛短视频 SDK，方便开发者快速实现短视频拍摄、剪辑、编辑、合成、分发功能。我们提供 80+ 功能供开发使用，申请 **0 元体验** 可 [点击此处
__](https://qmall.qiniu.com/template/MTE1)获得产品试用权限。
# 多版本功能分布
短视频SDK主要区分精简版、基础版、进阶版、专业版 4 个版本，不同版本的功能区别见如下表格
功能 | 子功能 | 精简版
(Smart) | 基础版
(Basic) | 进阶版
(Advanced) | 专业版
(Pro)
---|---|---|---|---|---
**交互界面** | **提供了一套完整的UI交互源码，可复用或自定义** | ✓ | ✓ | ✓ | ✓
**拍摄设置** | **摄像头采集** | ✓ | ✓ | ✓ | ✓
| **麦克风采集** | ✓ | ✓ | ✓ | ✓
| **视频采集参数定义**
_支持最高 1080P 拍摄，支持自定义视频采集源、采集画面的分辨率、采集画面的长宽比等参数_ | ✓ | ✓ | ✓ | ✓
| **音频采集参数定义**
_支持自定义音频采集源、音频格式、音频声道、音频采样率等参数_ | ✓ | ✓ | ✓ | ✓
| **视频编码参数定义**
_支持自定义编码视频的码率、帧率、分辨率、H.264 编码方式等参数_ | ✓ | ✓ | ✓ | ✓
| **音频编码参数定义**
_支持自定义编码音频的码率、采样率、声道数、AAC 编码方式等参数_ | ✓ | ✓ | ✓ | ✓
| **拍摄时长设置**
_支持设置实际拍摄过程中的最大、最小拍摄时长_ | ✓ | ✓ | ✓ | ✓
| **前后台切换**
_根据监听到 Application 的前后台状态自动停止和开始录制视频，默认从后台进入前台自动开始录制_ | ✓ | ✓ | ✓ | ✓
| **摄像头切换**
_支持切换前后摄像头进行拍摄_ | ✓ | ✓ | ✓ | ✓
| **闪光灯设置**
_支持开关闪光灯用于拍摄时的补光_ | ✓ | ✓ | ✓ | ✓
| **画面镜像**
_支持设置是否镜像预览画面和编码画面_ | ✓ | ✓ | ✓ | ✓
| **画面对焦**
_支持手动对焦和自动对焦_ | ✓ | ✓ | ✓ | ✓
| **焦距调节**
_支持手动调节画面焦距进行放大、缩小_ | ✓ | ✓ | ✓ | ✓
| **曝光调节**
_支持调整曝光度参数_ | ✓ | ✓ | ✓ | ✓
**拍摄模式** | **横屏拍摄**
_支持根据设备的方向自动确定竖屏、横屏拍摄_ | ✓ | ✓ | ✓ | ✓
| **分段拍摄**
_支持拍摄过程中实现连续多次拍摄、断点续拍、回删_ | ✓ | ✓ | ✓ | ✓
| **静音拍摄**
_支持静音拍摄_ | ✓ | ✓ | ✓ | ✓
| **音频录制**
_支持纯音频录制_ | ✓ | ✓ | ✓ | ✓
| **屏幕录制**
_支持对整个屏幕区域进行录制，实现整体的录制效果_ | ✓ | ✓ | ✓ | ✓
| **变速拍摄**
_支持设置拍摄时的快/慢速率（默认正常速率，只支持 2 的次方倍数，如 0.25 倍、0.5 倍，1 倍，2 倍，4 倍等等）_ | ✗ | ✓ | ✓ | ✓
| **分屏拍摄（合拍）**
_可以导入视频进行合拍，生成双画面视频_ | ✗ | ✗ | ✓ | ✓
**实时处理** | **实时截图**
_支持拍摄时实时截图拍照保存到本地_ | ✓ | ✓ | ✓ | ✓
| **实时预览**
_支持实时本地预览_ | ✓ | ✓ | ✓ | ✓
| **实时水印**
_支持拍摄时添加静态水印，支持设置水印位置、大小、透明度，设置作用时间范围_ | ✗ | ✓ | ✓ | ✓
| **实时美颜**
支持拍摄时启用美颜功能，支持设置美颜、美白、红润3种效果并调节强度 | ✓ | ✓ | ✓ | ✓
| **背景音乐**
_支持拍摄前选择本地文件作为背景音乐_ | ✗ | ✓ | ✓ | ✓
**基础编辑** | **视频导入**
_支持本地视频快速导入后编辑_ | ✓ | ✓ | ✓ | ✓
| **编辑预览**
_支持编辑时实时预览本地效果_ | ✓ | ✓ | ✓ | ✓
| **时长剪裁**
_支持时长裁剪，按照给定的时间范围生成一个 mp4 文件_ | ✓ | ✓ | ✓ | ✓
| **本地转码**
_支持按照给定的码率、帧率等参数，生成一个 mp4 文件_ | ✓ | ✓ | ✓ | ✓
| **视频旋转**
_支持按照给定的目标旋转角度，生成一个 mp4 文件_ | ✗ | ✓ | ✓ | ✓
| **画面剪裁**
_支持画面裁剪，按照视频画面大小（自定义比例、自定义区域）精确裁剪视频生成一个mp4文件_ | ✗ | ✗ | ✓ | ✓
**特效编辑** | **视频旋转特效**
_支持设置视频左右上下旋转，实时预览旋转效果_ | ✗ | ✓ | ✓ | ✓
| **单音频混音**
_支持给视频文件添加单音频，实现混音效果_ | ✗ | ✓ | ✓ | ✓
| **滤镜特效**
_支持给视频文件添加滤镜效果，默认支持 33 种滤镜效果_ | ✗ | ✓
提供 10 种滤镜效果 | ✓
提供 33 种滤镜效果 | ✓
提供 33 种滤镜效果
| **涂鸦特效**
_支持画笔尺寸和颜色调整，支持设置特效显示的时间范围_ | ✗ | ✓ | ✓ | ✓
| **字幕特效**
_支持给视频文件添加文字特效，支持设置文字内容，字体大小，字体颜色，透明度，旋转，位置等，支持设置特效显示的时间范围_ | ✗ | ✓ | ✓ | ✓
| **水印特效**
_支持给视频文件添加静态、动态水印，并且能够自由设置水印的大小、位置、透明度、旋转角度，支持设置特效显示的时间范围，可以自定义素材或使用供应商提供的收费素材_ | ✗ | ✓ | ✓ | ✓
| **贴纸特效**
_支持给视频文件添加静态贴纸，并且能够自由设置贴纸大小、位置、旋转角度，支持设置特效显示的时间范围，可以自定义素材或使用供应商提供的收费素材_ | ✗ | ✓ | ✓ | ✓
| **时间特效**
_支持对视频文件进行整体变速、分段变速（变速只支持 2 的次方倍数，如 0.25 倍、0.5 倍、1 倍、2倍、4 倍等）_ | ✗ | ✓ | ✓ | ✓
| **时光倒流**
_支持 1 种倒放操作（即时光倒流特效）_ | ✗ | ✗ | ✓ | ✓
| **音乐唱片**
_支持音频录制的过程中，增加图片旋转效果，输出为 mp4 文件_ | ✗ | ✗ | ✓ | ✓
| **多音频混音**
_支持给视频文件添加多个背景音乐，支持调整视频原声、背景音乐音量，支持设置多个背景音乐有效时间区域，支持自己录音或者选用本地音乐_ | ✗ | ✗ | ✗ | ✓
| **MV 特效**
_支持给视频文件添加 MV 效果，默认提供 4 种 MV 特效，客户可根据要求自行创作 MV 效果_ | ✗ | ✗ | ✗ | ✓
**多素材编排** | **视频拼接**
_支持设置多个视频按照前后顺序导入拼接生成一个 mp4 文件_ | ✗ | ✗ | ✓ | ✓
| **GIF 动画**
_支持基于多个图片或视频直接导出 GIF 动图_ | ✗ | ✗ | ✓ | ✓
| **图片拼接**
_支持设置多个图片按照前后顺序导入拼接生成一个 mp4 文件，支持设置图片之间的转场动画，例如：淡入淡出、闪黑、闪白、圆形、飞入和擦除_ | ✗ | ✗ | ✓ | ✓
| **基础转场**
_支持在视频图片片段之间，增加淡入淡出效果_ | ✗ | ✗ | ✓ | ✓
| **过场字幕**
_支持在视频之间增加转场字幕，支持定义转场字幕的背景色、持续时间、支持文字和图片特效，支持旋转、放大、位置移动、淡入淡出 4 种效果_ | ✗ | ✗ | ✓ | ✓
| **视频合成**
_支持设置多个视频合并为一个视频，支持设置每一个视频在画面中的位置、大小、开始播放时间等。该功能与上方视频拼接不同，视频拼接只允许设置参与拼接的多个视频的播放顺序_ | ✗ | ✗ | ✗ | ✓
| **图片 & GIF 图 & 视频混拼**
_支持设置多个视频和图片按照前后顺序导入拼接生成一个 mp4 文件_ | ✗ | ✗ | ✗ | ✓
**其他功能** | **草稿箱**
_支持将当前录制的片段与设置项存入草稿箱_ | ✓ | ✓ | ✓ | ✓
| **接口扩展**
_扩展接口支持对接第三方美颜特效等增值能力_ | ✓ | ✓ | ✓ | ✓
| **外部裸数据导入**
_支持外部音视频裸数据导入，生成 mp4 文件_ | ✗ | ✗ | ✗ | ✓
| **View 录制**
_支持 View 录制_ | ✗ | ✗ | ✗ | ✓
**视频播放** | **播放器 SDK** | ✓ | ✓ | ✓ | ✓
**上传分发** | **视频上传** | ✓ | ✓ | ✓ | ✓
| **断点续传** | ✓ | ✓ | ✓ | ✓
| **上传加速** | ✓ | ✓ | ✓ | ✓
增值能力方面，需要单独选购，在视频拍摄或视频编辑阶段增加，4个版本都支持相关开放接口。
**功能**
---
**高级美颜**
_拍摄设置大眼、瘦脸、V脸、下巴调整、短脸、小鼻效果，并支持调节强度_
**人脸贴纸**
_支持人脸识别，进行人脸 2D、3D 贴纸操作_
**手势识别**
_可以对拍摄的人物的特定手势进行识别，配合其他特效_
**AR 特效**
_支持拍摄时设置 AR 特效_
**变声**
_拍摄时对录制的人音进行变声（如萝莉、大叔）_
**类抖音特效**
_滤镜效果，支持抖动、幻觉、灵魂出窍等数种抖音特效_
**背景抠图**
_将画面中的绿色元素(比如纯绿背景)抠除，替换成其他的元素，比如动态背景/ PPT 等_
资费注意事项：
七牛短视频 SDK区分精简版、基础版、进阶版、专业版 4
个版本，不同版本对应不同的价格策略，获取更多商务优惠信息可直接与您对应的客户经理联系，原有预充值优惠策略不再提供，预充值款项可继续正常消耗七牛相关产品服务，但不提供退款服务
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,682 |
短视频 SDK 下载体验 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 短视频 >短视频 SDK 下载体验
# 短视频 SDK 下载体验
最近更新时间: 2024-06-21 10:24:13
> **说明：**
> SDK 名称：短视频 SDK
> 开发者：上海七牛信息技术有限公司
> 短视频 SDK 合规使用说明请参考[七牛 SDK 合规使用说明
> __](https://developer.qiniu.com/pili/12616/sdk-compliance-
> instructions)；隐私政策说明请参考[七牛 SDK 隐私策略
> __](https://developer.qiniu.com/pili/8027/sdk-privacy-policy)
# SDK 下载
| 精简版 | 基础版 | 进阶版 | 专业版
---|---|---|---|---
Android 短视频 SDK | [qnsv-android-v3.5.0-release-smart.zip __](https://sdk-release.qiniushawn.top/qnsv-android-v3.5.0-release_smart.zip)| [qnsv-android-v3.5.0-release-basic.zip __](https://sdk-release.qiniushawn.top/qnsv-android-v3.5.0-release_basic.zip)| [qnsv-android-v3.5.0-release-advanced.zip __](https://sdk-release.qiniushawn.top/qnsv-android-v3.5.0-release_advanced.zip)| [qnsv-android-v3.5.0-release-pro.zip __](https://sdk-release.qiniushawn.top/qnsv-android-v3.5.0-release_professional.zip)
iOS 短视频 SDK | [qnsv-ios-v3.2.3-release-smart.zip __](https://sdk-release.qiniushawn.top/qnsv-ios-v3.2.3-release-smart.zip)| [qnsv-ios-v3.2.3-release-basic.zip __](https://sdk-release.qiniushawn.top/qnsv-ios-v3.2.3-release-basic.zip)| [qnsv-ios-v3.2.3-release-advanced.zip __](https://sdk-release.qiniushawn.top/qnsv-ios-v3.2.3-release-advanced.zip)| [qnsv-ios-v3.2.3-release-pro.zip __](https://sdk-release.qiniushawn.top/qnsv-ios-v3.2.3-release-pro.zip)
# Github 地址
* Android 短视频 SDK: <https://github.com/pili-engineering/PLDroidShortVideo>[__](https://github.com/pili-engineering/PLDroidShortVideo)
* iOS 短视频 SDK: <https://github.com/pili-engineering/PLShortVideoKit>[__](https://github.com/pili-engineering/PLShortVideoKit)
# Demo本地下载
* Android 短视频 Demo：<http://fir.qiniuapi.com/plsvaui>[ __](http://fir.qiniuapi.com/plsvaui)
* iOS 短视频 Demo：<https://testflight.apple.com/join/A7BUwhD2>[ __](https://testflight.apple.com/join/A7BUwhD2)
# Demo扫码下载
Android Demo下载：（若使用微信扫码失败，可使用安卓手机自带浏览器、QQ、支付宝尝试扫码）
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 短视频 >短视频 SDK 下载体验
# 短视频 SDK 下载体验
最近更新时间: 2024-06-21 10:24:13
> **说明：**
> SDK 名称：短视频 SDK
> 开发者：上海七牛信息技术有限公司
> 短视频 SDK 合规使用说明请参考[七牛 SDK 合规使用说明
> __](https://developer.qiniu.com/pili/12616/sdk-compliance-
> instructions)；隐私政策说明请参考[七牛 SDK 隐私策略
> __](https://developer.qiniu.com/pili/8027/sdk-privacy-policy)
# SDK 下载
| 精简版 | 基础版 | 进阶版 | 专业版
---|---|---|---|---
Android 短视频 SDK | [qnsv-android-v3.5.0-release-smart.zip __](https://sdk-release.qiniushawn.top/qnsv-android-v3.5.0-release_smart.zip)| [qnsv-android-v3.5.0-release-basic.zip __](https://sdk-release.qiniushawn.top/qnsv-android-v3.5.0-release_basic.zip)| [qnsv-android-v3.5.0-release-advanced.zip __](https://sdk-release.qiniushawn.top/qnsv-android-v3.5.0-release_advanced.zip)| [qnsv-android-v3.5.0-release-pro.zip __](https://sdk-release.qiniushawn.top/qnsv-android-v3.5.0-release_professional.zip)
iOS 短视频 SDK | [qnsv-ios-v3.2.3-release-smart.zip __](https://sdk-release.qiniushawn.top/qnsv-ios-v3.2.3-release-smart.zip)| [qnsv-ios-v3.2.3-release-basic.zip __](https://sdk-release.qiniushawn.top/qnsv-ios-v3.2.3-release-basic.zip)| [qnsv-ios-v3.2.3-release-advanced.zip __](https://sdk-release.qiniushawn.top/qnsv-ios-v3.2.3-release-advanced.zip)| [qnsv-ios-v3.2.3-release-pro.zip __](https://sdk-release.qiniushawn.top/qnsv-ios-v3.2.3-release-pro.zip)
# Github 地址
* Android 短视频 SDK: <https://github.com/pili-engineering/PLDroidShortVideo>[__](https://github.com/pili-engineering/PLDroidShortVideo)
* iOS 短视频 SDK: <https://github.com/pili-engineering/PLShortVideoKit>[__](https://github.com/pili-engineering/PLShortVideoKit)
# Demo本地下载
* Android 短视频 Demo：<http://fir.qiniuapi.com/plsvaui>[ __](http://fir.qiniuapi.com/plsvaui)
* iOS 短视频 Demo：<https://testflight.apple.com/join/A7BUwhD2>[ __](https://testflight.apple.com/join/A7BUwhD2)
# Demo扫码下载
Android Demo下载：（若使用微信扫码失败，可使用安卓手机自带浏览器、QQ、支付宝尝试扫码）
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,691 |
短视频 SDK 接入指南 | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 短视频 >短视频 SDK 接入指南
# 短视频 SDK 接入指南
最近更新时间: 2021-11-18 09:07:03
# 1\. 注册账号
七牛云官网，前往[注册页面 __](https://portal.qiniu.com/signup)
# 2\. 选购授权
登录七牛云管理控制台之后，前往[短视频SDK授权管理页面
__](https://portal.qiniu.com/sdk/licenses)。点击购买授权按钮，进行下单。
请注意，试用可以直接0元购买试用版，试用版授权包含短视频SDK的全部功能。试用版只允许购买一次。
# 3\. 完成支付
下单完成后，进入到[订单列表页面 __](https://portal.qiniu.com/financial/orders)，进行支付。
# 4\. 查看授权
支付完成后，可以到[短视频SDK授权管理页面 __](https://portal.qiniu.com/sdk/licenses)，查看已购买的授权。
# 5\. 创建应用
购买授权成功后，可以到[短视频SDK应用管理页面 __](https://portal.qiniu.com/sdk/apps)，点击创建应用按钮，创建应用。
创建应用时请注意绑定已经购买的授权，绑定授权后，应用就可使用授权所对应的短视频SDK版本了。
# 6\. 编辑应用
创建好的应用也可以编辑，主要用于更改应用名，换绑别的授权等功能。但应用包名不可以更改。
# 7\. 使用帮助
若您需要测试，您可以下载短视频 [SDK __](https://developer.qiniu.com/pili/sdk/3734/short-
video-android-sdk)和[Demo __](https://developer.qiniu.com/pili/sdk/3920/short-
video-demo-download)试用，详细的功能可查阅[短视频白皮书
__](https://developer.qiniu.com/pili/sdk/3919/a-short-video-the-white-paper)。
# 8\. 联系方式
若您的需求比较紧急，可直接拨打七牛云售前咨询电话 400-808-9176 转 1
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 短视频 >短视频 SDK 接入指南
# 短视频 SDK 接入指南
最近更新时间: 2021-11-18 09:07:03
# 1\. 注册账号
七牛云官网，前往[注册页面 __](https://portal.qiniu.com/signup)
# 2\. 选购授权
登录七牛云管理控制台之后，前往[短视频SDK授权管理页面
__](https://portal.qiniu.com/sdk/licenses)。点击购买授权按钮，进行下单。
请注意，试用可以直接0元购买试用版，试用版授权包含短视频SDK的全部功能。试用版只允许购买一次。
# 3\. 完成支付
下单完成后，进入到[订单列表页面 __](https://portal.qiniu.com/financial/orders)，进行支付。
# 4\. 查看授权
支付完成后，可以到[短视频SDK授权管理页面 __](https://portal.qiniu.com/sdk/licenses)，查看已购买的授权。
# 5\. 创建应用
购买授权成功后，可以到[短视频SDK应用管理页面 __](https://portal.qiniu.com/sdk/apps)，点击创建应用按钮，创建应用。
创建应用时请注意绑定已经购买的授权，绑定授权后，应用就可使用授权所对应的短视频SDK版本了。
# 6\. 编辑应用
创建好的应用也可以编辑，主要用于更改应用名，换绑别的授权等功能。但应用包名不可以更改。
# 7\. 使用帮助
若您需要测试，您可以下载短视频 [SDK __](https://developer.qiniu.com/pili/sdk/3734/short-
video-android-sdk)和[Demo __](https://developer.qiniu.com/pili/sdk/3920/short-
video-demo-download)试用，详细的功能可查阅[短视频白皮书
__](https://developer.qiniu.com/pili/sdk/3919/a-short-video-the-white-paper)。
# 8\. 联系方式
若您的需求比较紧急，可直接拨打七牛云售前咨询电话 400-808-9176 转 1
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,693 |
iOS 短视频 SDK | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 短视频 >iOS 短视频 SDK
# iOS 短视频 SDK
最近更新时间: 2021-07-05 19:02:15
# 1 概述
PLShortVideoKit 是七牛推出的一款适用于 iOS 平台的短视频
SDK，提供了包括美颜、滤镜、水印、断点录制、分段回删、视频编辑、混音特效、MV 特效、本地/云端存储在内的多种功能，支持高度定制以及二次开发。
## 1.1 下载地址
* [iOS Demo 以及 SDK 下载地址 __](https://github.com/pili-engineering/PLShortVideoKit)
# 2\. 功能列表
短视频 SDK 主要区分精简版、基础版、进阶版、专业版 4 个版本，不同版本的功能[请参考
__](https://developer.qiniu.com/pili/sdk/3731/short-video)
# 3 阅读对象
本文档为技术文档，需要阅读者：
* 具有基本的 iOS 开发能力
* 准备接入七牛云存储
# 4 总体设计
## 4.1 基本规则
为了方便理解和使用，对于 SDK 的接口设计，我们遵循了如下的原则：
* 每一个接口类，均以 `PLS` 开头
* 简单的配置，通过 `NSDictionary` 来设置
* 复杂的配置类，以 `PLSXXXConfiguration` 命名
* 所有的回调代理，以 `PLSXXXXDelegate` 命名
## 4.2 核心接口
核心的接口类说明如下：
接口类名 | 功能 | 备注
---|---|---
PLShortVideoRecorder | 负责视频的拍摄 | 音视频采集、美颜、编码、封包等
PLShortVideoEditor | 负责视频内容的编辑 | 添加滤镜、水印、文字特效等
PLSAVAssetExportSession | 负责视频的拼接、导出 | 视频导出等
PLShortVideoTranscoder | 负责视频的转码 | 视频转码，获取视频信息等
PLShortVideoUploader | 负责视频的上传 | 视频文件的上传
PLSTransitionMaker | 负责文字动画生成视频文件 | 文字转 mp4
PLSMultiVideoMixer | 负责将多个视频文件合并 | 多视频合并
PLSVideoMixRecorder | 负责素材视频合拍 | 视频编辑
PLSImageVideoComposer | 负责图片、GIF 图和视频混排 | 视频编辑
## 4.3 视频拍摄接口类
拍摄功能相关的类说明如下：
接口名 | 功能 | 备注
---|---|---
PLShortVideoRecorder | 视频拍摄的核心接口 | 核心接口
PLSVideoConfiguration | 配置摄像头参数 | 预览分辨率，前后摄像头等
PLSAudioConfiguration | 配置麦克风参数 | 通道，采样率等
PLSFilter | 内置滤镜对象 | 滤镜名称，缩略图等
PLShortVideoRecorderDelegate | 视频拍摄回调 | 包括原始数据回调及拍摄回调等
## 4.4 视频编辑接口类
### 4.4.1 视频内容编辑接口类
视频编辑功能相关的类说明如下：
接口名 | 功能 | 备注
---|---|---
PLShortVideoEditor | 视频编辑的核心接口 | 核心接口
PLSEditSettings | 配置视频编辑参数 | 源文件、音效、水印设置等
PLSAVAssetExportSession | 导出视频接口 | 根据设置的相应参数导出视频
PLSGifComposer | 制作 GIF 图接口 | 根据视频帧／图片数组合成 GIF图
PLSMovieComposer | 多个视频拼接接口 | 将多个视频拼接为1个视频
PLSReverserEffect | 时光倒流特效接口 | 将视频倒序
### 4.4.2 视频转码接口类
接口名 | 功能 | 备注
---|---|---
PLSAVAssetExportSession | 视频导出的核心接口 | 核心接口
PLShortVideoTranscoder | 视频转码的核心接口 | 核心接口
## 4.5 视频上传接口类
视频上传功能相关的类说明如下：
接口名 | 功能 | 备注
---|---|---
PLShortVideoUploader | 视频上传的核心接口 | 核心接口
PLSUploaderConfiguration | 配置上传参数 | 上传视频空间 token 等
PLShortVideoUploaderDelegate | 上传进度及结果回调 | 回调上传进度及结果
# 5 开发准备
## 5.1 设备以及系统要求
* 设备要求：iPhone 5 及以上
* 系统要求：iOS 8 及以上
## 5.2 开发环境配置
* Xcode 开发工具。App Store [下载地址 __](https://itunes.apple.com/us/app/xcode/id497799835?ls=1&mt=12)
* 安装 CocoaPods。[了解 CocoaPods 使用方法 __](https://cocoapods.org/)
## 5.3 导入 SDK
[CocoaPods __](https://cocoapods.org/)是针对 Objective-C 的依赖管理工具，它能够将使用类似
PLShortVideoKit 的第三方库的安装过程变得非常简单和自动化，你能够用下面的命令来安装它：
$ sudo gem install cocoapods
### 5.3.1 Podfile
为了使用 CoacoaPods 集成 PLShortVideoKit 到你的 Xcode 工程当中，你需要编写你的 `Podfile`
#### 专业版安装
如果你购买的是七牛专业版本的短视频 SDK，请按如下方式填写Podfile：
target 'TargetName' do
pod 'PLShortVideoKit'
end
#### 进阶版安装
如果你购买的是七牛进阶版本的短视频 SDK，请按如下方式填写Podfile：
target 'TargetName' do
pod 'PLShortVideoKit', :podspec => 'https://raw.githubusercontent.com/pili-engineering/PLShortVideoKit/master/PLShortVideoKit-Advanced.podspec'
end
#### 基础版安装
如果你购买的是七牛基础版本的短视频 SDK，请按如下方式填写Podfile：
target 'TargetName' do
pod 'PLShortVideoKit', :podspec => 'https://raw.githubusercontent.com/pili-engineering/PLShortVideoKit/master/PLShortVideoKit-Basic.podspec'
end
#### 精简版安装
如果你购买的是七牛精简版本的短视频 SDK，请按如下方式填写Podfile：
target 'TargetName' do
pod 'PLShortVideoKit', :podspec => 'https://raw.githubusercontent.com/pili-engineering/PLShortVideoKit/master/PLShortVideoKit-Smart.podspec'
end
### 5.3.2 运行 pod
Podfile填写完成后，运行如下命令安装SDK：
$ pod install
**注意：在使用了七牛的推流或连麦 SDK 的工程中，集成该短视频 SDK 会出现美颜库导致的符号冲突问题 duplicate symbol
_OBJC_CLASS_
MuseProcessor，原因是两个SDK都引入了基础美颜库libMuseProcessor。解决方法是在引入短视频SDK时使用PLShortVideoKit/ex-
libMuseProcessor的subspec，替代PLShortVideoKit，以基础版为例：**
target 'TargetName' do
pod 'PLShortVideoKit/ex-libMuseProcessor', :podspec => 'https://raw.githubusercontent.com/pili-engineering/PLShortVideoKit/master/PLShortVideoKit-Basic.podspec'
end
## 5.4 添加权限说明
我们需要在 Info.plist 文件中添加相应权限的说明，否则程序在 iOS 10 系统上会出现崩溃。需要添加如下权限：
* 麦克风权限：Privacy - Microphone Usage Description 是否允许 App 使用麦克风
* 相机权限： Privacy - Camera Usage Description 是否允许 App 使用相机
* 相册权限： Privacy - Photo Library Usage Description 是否允许 App 访问媒体资料库
# 6 快速开始
## 6.1 视频拍摄
### 6.1.1 创建音视频的采集和编码配置对象
当前使用默认配置，之后可以深入研究按照自己的需求作更改
PLSVideoConfiguration *videoConfiguration = [PLSVideoConfiguration defaultConfiguration];
PLSAudioConfiguration *audioConfiguration = [PLSAudioConfiguration defaultConfiguration];
### 6.1.2 创建拍摄 recorder 对象
self.shortVideoRecorder = [[PLShortVideoRecorder alloc] initWithVideoConfiguration:videoConfiguration audioConfiguration:audioConfiguration];
### 6.1.3 添加摄像头预览视图
将预览视图添加为当前视图的子视图
[self.view addSubview:self.shortVideoRecorder.previewView];
### 6.1.4 开始采集
在开始录制前需要开启采集，开启采集后才能看到摄像头预览
[self.shortVideoRecorder startCaptureSession];
### 6.1.5 设置拍摄时长
设置实际拍摄过程中的最大拍摄时长，最小拍摄时长
// 单位为秒
self.shortVideoRecorder.maxDuration = 60.0f;
self.shortVideoRecorder.minDuration = 2.0f;
### 6.1.6 横屏拍摄
设置是否根据设备的方向自动确定竖屏、横屏拍摄
// 默认为 NO，不启用自动确定
self.shortVideoRecorder.adaptationRecording = YES;
**注意：当 adaptationRecording 为 YES 时，可通过 deviceOrientationBlock 的回调，来获取设备方向**
### 6.1.7 倍速拍摄
设置拍摄的快／慢速率，支持5种拍摄速率
PLSVideoRecoderRateTopSlow、PLSVideoRecoderRateSlow、PLSVideoRecoderRateNormal、PLSVideoRecoderRateFast、PLSVideoRecoderRateTopFast
// 默认为 PLSVideoRecoderRateNormal
self.shortVideoRecorder.recoderRate = PLSVideoRecoderRateNormal;
**注意：录制的原始视频速率为Normal，调用PLSAVAssetExportSession合成后的视频才有倍速效果**
### 6.1.8 背景音乐
设置拍摄时的背景音乐
[self.shortVideoRecorder mixAudio:audioURL];
在退出当前拍摄页面进入下一页面前，需要执行下面的代码段对拍摄的视频进行处理
[self.shortVideoRecorder mixWithMusicVolume:0.3 videoVolume:0.8 completionHandler:^(AVMutableComposition * _Nullable composition, AVAudioMix * _Nullable audioMix, NSError * _Nullable error) {
}];
**注意：需在completionHandler中使用AVAssetExportSession对原视频进行处理，否则无效，[点击此处查看示例代码
__](https://github.com/pili-
engineering/PLShortVideoKit/blob/master/Example/PLShortVideoKitDemo/RecordViewController.m)**
### 6.1.9 视频草稿
加载视频草稿，即拍摄了一段视频保存到了草稿箱，在下次拍摄时，可以从草稿箱读取视频继续拍摄或编辑。
[self.shortVideoRecorder insertVideo:draftVideoURL];
### 6.1.10 截图
在预览时，可以截取预览时的图像。
[self.shortVideoRecorder getScreenShotWithCompletionHandler:^(UIImage * _Nullable image) {
}
### 6.1.11 开始拍摄
* 录制的视频的存放地址由 SDK 内部自动生成
[self.shortVideoRecorder startRecording];
* customFileURL 录制的视频的存放地址，该参数可以在外部设置，录制的视频会保存到该位置
[self.shortVideoRecorder startRecording:customFileURL];
### 6.1.12 停止拍摄
[self.shortVideoRecorder stopRecording];
### 6.1.12 停止采集
[self.shortVideoRecorder stopCaptureSession];
## 6.2 编辑预览
编辑类 `PLShortVideoEditor` 支持渲染音视频、水印、滤镜、背景音乐、MV 特效等功能。
### 6.2.1 视频数据回调
通过 `PLShortVideoEditor` 的 Delegate 回调方法来处理播放时的视频数据，可以动态改变滤镜效果，pixelBuffer 格式为
kCVPixelFormatType_32BGRA
- (CVPixelBufferRef)shortVideoEditor:(PLShortVideoEditor *)editor didGetOriginPixelBuffer:(CVPixelBufferRef)pixelBuffer;
### 6.2.2 水印
可以根据需要添加水印或移除水印，并且能够自由设置水印的大小和位置。
* 添加静态水印
- (void)setWaterMarkWithImage:(UIImage *)waterMarkImage position:(CGPoint)position size:(CGSize)size waterMarkType:(PLSWaterMarkType)type alpha:(CGFloat)alpha rotateDegree:(CGFloat)degree;
* 添加 GIF 水印
- (void)setGifWaterMarkWithData:(NSData *)gifData position:(CGPoint)position size:(CGSize)size alpha:(CGFloat)alpha rotateDegree:(CGFloat)degree;
* 移除水印
- (void)clearWaterMark;
该方法用于移除已添加的水印
### 6.2.3 滤镜
* 添加、移除滤镜。
/**
* @param colorImagePath 当前使用的滤镜的颜色表图的路径
* 当 colorImagePath 为 nil 时，表示移除滤镜。
*/
- (void)addFilter:(NSString *)colorImagePath;
### 6.2.4 背景音乐
* 添加背景音乐
/**
* @param musicURL 当前使用的背景音乐的地址
* @param timeRange 当前使用的背景音乐的有效时间区域(start, duration)。
* 如果想使用整段音乐，可以将其设置为 kCMTimeRangeZero
* 或者 (kCMTimeZero, duration)。
* @param volume 当前使用的背景音乐的音量
*/
- (void)addMusic:(NSURL *)musicURL timeRange:(CMTimeRange)timeRange volume:(NSNumber *)volume;
* 更新背景音乐
/**
* @param timeRange 使用 kCMTimeRangeZero 时，表示不更新背景音乐的播放时间区域
* @param volume 使用 nil 时，表示不更新背景音乐的音量
* 只更新 timeRange 时，[xxxObj updateMusic:timeRange volume:nil]
* 只更新 volume 时，[xxxObj updateMusic:kCMTimeRangeZero volume:volume]
*/
- (void)updateMusic:(CMTimeRange)timeRange volume:(NSNumber *)volume;
### 6.2.5 MV 特效
* 添加、移除 MV 特效。
/**
* @param colorURL 彩色层视频的地址
* @param alphaURL 被彩色层当作透明层的视频的地址
* 目前支持添加一层 MV 图层。当 colorURL = nil 和 alphaURL = nil 时，表示移除 MV 图层。
*/
- (void)addMVLayerWithColor:(NSURL *)colorURL alpha:(NSURL *)alphaURL;
### 6.2.6 时光倒流特效
`PLSReverserEffect` 支持时光倒流特效。
* 初始化 PLSReverserEffect 时光倒流对象
- (instancetype)initWithAsset:(AVAsset *)asset;
* 执行时光倒流
- (void)startReversing;
* 取消时光倒流
- (void)cancelReversing;
* 时光倒流完成的 Block
@property (copy, nonatomic) void(^completionBlock)(NSURL *url);
* 时光倒流失败的 Block
@property (copy, nonatomic) void(^failureBlock)(NSError *error);
* 时光倒流进度的 Block
可在该 Block 中刷新时光倒流进度条 UI。
@property (copy, nonatomic) void(^processingBlock)(float progress);
### 6.2.6 倍速特效
`PLShortVideoAsset` 支持倍速特效。
### 6.2.7 视频旋转
调用编辑类 `PLShortVideoEditor`的如下接口，可在编辑时预览旋转效果
- (PLSPreviewOrientation)rotateVideoLayer;
- (void)resetVideoLayerOrientation;
### 6.2.8 文字特效、视频贴纸、视频涂鸦
`PLSStickerView` 支持文字特效、视频贴纸、视频涂鸦效果。
_注意：涂鸦由于从 v1.11.0 版本起更新了使用方法，需要用户在 App 层自行实现涂鸦绘画的功能，最后将生成的 image 同文字、贴纸特效一样，传入
sdk 配置即可。具体实现，可参考我们 demo 的涂鸦功能实现_
## 6.3 视频合成
`PLSAVAssetExportSession` 支持视频合成功能。
### 6.3.1 初始化视频合成对象
self.exportSession = [[PLSAVAssetExportSession alloc] initWithAsset:asset];
### 6.3.2 设置视频合成参数
所有的合成参数都放在 PLSAVAssetExportSession 的 outputSettings 中，下面将分为五步讲述 outputSettings
的参数设置：
// ============ step 1: 初始化导出参数 ==============
// 总的导出参数字典对象
self.outputSettings = [[NSMutableDictionary alloc] init];
// 原视频参数字典对象
self.movieSettings = [[NSMutableDictionary alloc] init];
// 水印参数数组对象
self.watermarkSettingsArray = [[NSMutableArray alloc] init];
// 贴纸参数数组对象
self.stickerSettingsArray = [[NSMutableArray alloc] init];
// 混音参数数组对象
self.audioSettingsArray = [[NSMutableArray alloc] init];
// 将各个参数应用到总的导出参数中
self.outputSettings[PLSMovieSettingsKey] = self.movieSettings;
self.outputSettings[PLSWatermarkSettingsKey] = self.watermarkSettingsArray;
self.outputSettings[PLSStickerSettingsKey] = self.stickerSettingsArray;
self.outputSettings[PLSAudioSettingsKey] = self.audioSettingsArray;
#### 6.3.2.1 视频基本信息设置
PLSMovieSettingsKey 是视频合成必须要有的参数，里面存放的是原视频的基本信息：
// ============ step 2: 设置视频的基本信息，必须设置 ==============
AVAsset *asset = [AVAsset assetWithURL:url];
self.movieSettings[PLSURLKey] = url;
self.movieSettings[PLSAssetKey] = asset;
// 设置视频的时间段，可以通过 PLSStartTimeKey 和 PLSDurationKey 对视频进行剪切
self.movieSettings[PLSStartTimeKey] = [NSNumber numberWithFloat:0.f];
self.movieSettings[PLSDurationKey] = [NSNumber numberWithFloat:CMTimeGetSeconds(asset.duration)];
// 设置原视频的音量值，比如添加了背景音乐，不再需要原视频音频，可以设置为 0 来去掉原视频音频。有效范围 0 ~ 1
self.movieSettings[PLSVolumeKey] = [NSNumber numberWithFloat:1.0f];
#### 6.3.2.2 水印设置
`PLSAVAssetExportSession`
支持视频合成时添加水印功能，你可以根据自己的需要添加水印或移除水印，并且能够自由设置水印的大小、位置、水印透明度和水印作用的时间段，支持设置多个水印分别作用于不同时间段。
视频合成时水印设置：
// ============ step 3: 设置水印信息，如果不需要水印可以不设置 ==============
// 可以设置多个水印，如果不同水印的作用时间出现了重合，则同一时刻只有一个水印会被显示
int waterwarkCount = n;
for (int i = 0; i < waterwarkCount; i ++) {
NSMutableDictionary *watermarkDic = [[NSMutableDictionary alloc] init];
// 设置水印图片
watermarkDic[PLSURLKey] = [NSURL fileURLWithPath:@"url path"];
// 设置水印的宽高，如果不设置，默认为水印图片的宽高
watermarkDic[PLSSizeKey] = [NSValue valueWithCGSize:CGSizeMake(width, height)];
// 设置水印的左上角位置
watermarkDic[PLSPointKey] = [NSValue valueWithCGPoint:CGPointMake(x, y)];
// 设置水印的开始时间
watermarkDic[PLSStartTimeKey] = [NSNumber numberWithFloat:startTimeInVideo];
// 设置水印的显示时长
watermarkDic[PLSDurationKey] = [NSNumber numberWithFloat:waterMarkShowDuration];
// 设置水印的 alpha，如果不设置，默认为 1
watermarkDic[PLSAlphaKey] = [NSNumber numberWithFloat:watermarkAlpha];
// 设置水印的类型: PLSWaterMarkTypeStatic 对应静态水印，PLSWaterMarkTypeGif 对应 GIF 动态水印
watermarkDic[PLSTypeKey] = [NSNumber numberWithInteger:PLSWaterMarkType];
// 设置水印的旋转角度，如果有角度，会绕着水印中心点旋转
watermarkDic[PLSRotationKey] = [NSNumber numberWithFloat:watermarkRotate];
[self.watermarkSettingsArray addObject:watermarkDic];
}
#### 6.3.2.3 多重音乐
`PLSAVAssetExportSession` 支持视频合成时添加多个音乐做混音，并支持截取音乐中的片段加入到源视频素材中。
视频合成时设置多重混音：
// ============ step 4: 设置多音频混音信息，如果不需要混音处理可以不设置 ==============
// 设置混音的个数
// audioCount = 0 ~ n;
for (int i = 0; i < audioCount; i++) {
NSMutableDictionary *audioDic = [[NSMutableDictionary alloc] init];
// 设置音频的地址
audioDic[PLSURLKey] = [NSURL fileURLWithPath:@"audio path"];
// 设置音频的起始时间和音频的使用时长 PLSStartTimeKey 和 PLSDurationKey 决定音频的使用时间段，即就是对音频进行选取
audioDic[PLSStartTimeKey] = [NSNumber numberWithFloat:audioStartTime];
audioDic[PLSDurationKey] = [NSNumber numberWithFloat:audioDuration];
// 设置音频的音量 0 ~ 1
audioDic[PLSVolumeKey] = [NSNumber numberWithFloat:audioVolume];
// 设置音频在混音中的开始播放时间 和 时长，PLSLocationStartTimeKey 和 PLSLocationDurationKey 一起决定了音频的作用时间段
audioDic[PLSLocationStartTimeKey] = [NSNumber numberWithFloat:locationStartTime];
audioDic[PLSLocationDurationKey] = [NSNumber numberWithFloat:locationDuration];
[self.audioSettingsArray addObject:audioDic];
}
#### 6.3.2.4 设置贴纸
PLSAVAssetExportSession 支持设置多个贴纸，支持静态贴纸和 GIF
动态贴纸，支持设置每个贴纸的作用时间段，下面以代码的形式讲述静态贴纸 和 GIF 动态贴纸的设置方式:
// ============ step 5: 设置贴纸信息，如果不需要贴纸可以不设置 ==============
for (int i = 0; i < [self.timelineView getAllAddedItems].count; i++) {
PLSTimeLineItem *item = [self.timelineView getAllAddedItems][i];
NSMutableDictionary *stickerSettings = [[NSMutableDictionary alloc] init];
PLSStickerView *stickerView = (PLSStickerView *)item.target;
CGAffineTransform transform = stickerView.transform;
CGFloat widthScale = sqrt(transform.a * transform.a + transform.c * transform.c);
CGFloat heightScale = sqrt(transform.b * transform.b + transform.d * transform.d);
CGSize viewSize = CGSizeMake(stickerView.bounds.size.width * widthScale, stickerView.bounds.size.height * heightScale);
CGPoint viewCenter = CGPointMake(stickerView.frame.origin.x + stickerView.frame.size.width / 2, stickerView.frame.origin.y + stickerView.frame.size.height / 2);
CGPoint viewPoint = CGPointMake(viewCenter.x - viewSize.width / 2, viewCenter.y - viewSize.height / 2);
stickerSettings[PLSSizeKey] = [NSValue valueWithCGSize:viewSize];
stickerSettings[PLSPointKey] = [NSValue valueWithCGPoint:viewPoint];
CGFloat rotation = atan2f(transform.b, transform.a);
rotation = rotation * (180 / M_PI);
// 设置贴纸的旋转角度
stickerSettings[PLSRotationKey] = [NSNumber numberWithFloat:rotation];
// 设置贴纸的开始作用时间
stickerSettings[PLSStartTimeKey] = [NSNumber numberWithFloat:item.startTime];
// 设置贴纸的作用时长
stickerSettings[PLSDurationKey] = [NSNumber numberWithFloat:(item.endTime - item.startTime)];
// 设置贴纸预览的时候，预览背景 view 的宽高 和 视频最终导出时的视频宽高，SDK 内部需要这两个参数来计算贴纸在视频中的位置和大小
stickerSettings[PLSVideoPreviewSizeKey] = [NSValue valueWithCGSize:self.stickerOverlayView.frame.size];
stickerSettings[PLSVideoOutputSizeKey] = [NSValue valueWithCGSize:self.videoSize];
if (StickerType_GIFAnimation == stickerView.type) {
// 如果贴纸是 GIF 类型，PLSStickerKey 的 value 必须是下列三种中的某一种:
int type = arc4random() % 3;
if (0 == type) {
// value = GIF URL
stickerSettings[PLSStickerKey] = stickerView.stickerURL;
} else if (1 == type) {
// value = GIF path
stickerSettings[PLSStickerKey] = stickerView.stickerURL.path;
} else if (2 == type) {
// value = GIF data
stickerSettings[PLSStickerKey] = [NSData dataWithContentsOfFile:stickerView.stickerURL.path];
}
} else {
#if 0
// v2.0.0 及之前的版本添加静态贴纸的方式, 传入的是 stickerView。如果传入的是 stickerView，添加了滤镜或者特效，这些效果会作用到贴纸上。如果不希望贴纸被滤镜和特效作用，则需要使用新的添加贴纸的方式
stickerView.hidden = NO;
stickerSettings[PLSStickerKey] = stickerView;
#else
// ===== 新的静态贴纸添加方式，v2.1.0 之后生效，建议所有用户换成新的添加贴纸方式 ======
if (StickerType_Sticker == stickerView.type) {
int type = arc4random() % 4;
if (0 == type) {
// value = image URL
stickerSettings[PLSStickerKey] = stickerView.stickerURL;
} else if (1 == type) {
// value = image path
stickerSettings[PLSStickerKey] = stickerView.stickerURL.path;
} else if (2 == type) {
// value = image data
// 如果贴纸含 alpha 通道，使用 UIImageJPEGRepresentation(stickerView.image, 1) 得到的是没有 alpha 的图片，建议使用 UIImagePNGRepresentation(stickerView.image) 来获取 data
stickerSettings[PLSStickerKey] = UIImagePNGRepresentation(stickerView.image);
} else {
// value = image
stickerSettings[PLSStickerKey] = stickerView.image;
}
} else if (StickerType_SubTitle == stickerView.type) {
// 文字贴纸
stickerView.hidden = NO;
stickerSettings[PLSStickerKey] = [self convertViewToImage:stickerView];
}
#endif
}
[self.stickerSettingsArray addObject:stickerSettings];
}
#### 注意，贴纸在编辑时候的预览是由上层做的，七牛短视频 SDK 并不提供贴纸编辑时候的预览。开发者可以参考七牛短视频
PLShortVideoKitDemo [EditViewController.m __](https://github.com/pili-
engineering/PLShortVideoKit/blob/master/Example/PLShortVideoKitDemo/EditViewController.m)中贴纸编辑预览实现方式
#### 6.3.2.5 设置合成参数
self.exportSession.outputSettings = outputSettings;
### 6.3.3 启动视频合成
[self.exportSession exportAsynchronously];
### 6.3.4 合成回调
通过反馈 `PLSAVAssetExportSession ` 的 Delegate 或 Block 回调来反馈合成的状态。
* 输出合成视频文件的视频数据，用来做滤镜处理
- (CVPixelBufferRef __nonnull)assetExportSession:(PLSAVAssetExportSession *__nonnull)assetExportSession didOutputPixelBuffer:(CVPixelBufferRef __nonnull)pixelBuffer;
* 输出合成视频文件的进度的 Block 回调，progress从 0 到 1
@property (copy, nonatomic) void(^ _Nullable processingBlock)(float progress);
* 合成视频完成的 Block 回调
@property (copy, nonatomic) void(^ _Nullable completionBlock)(NSURL * _Nullable url);
* 合成视频失败的 Block 回调
@property (copy, nonatomic) void(^ _Nullable failureBlock)(NSError* _Nullable error);
## 6.4 视频转码
`PLShortVideoTranscoder` 支持视频本地转码和视频裁剪，减少视频体积。
### 6.4.1 初始化转码对象
self.shortVideoTranscoder = [[PLShortVideoTranscoder alloc] initWithURL:self.url];
* 转码时旋转视频画面，支持正立、左旋、倒立、右旋。
self.shortVideoTranscoder.rotateOrientation = self.rotateOrientation;
### 6.4.2 启动转码
[self.shortVideoTranscoder startTranscoding];
### 6.4.3 取消转码
[self.shortVideoTranscoder cancelTranscoding];
### 6.4.4 转码回调
* 转码完成的 Block 回调
@property (copy, nonatomic) void(^completionBlock)(NSURL *url);
* 转码失败的 Block 回调
@property (copy, nonatomic) void(^failureBlock)(NSError* error);
* 反馈转码进度的 Block
@property (copy, nonatomic) void(^processingBlock)(float progress);
## 6.5 视频帧／图片生成 GIF 动图
从 v1.3.0 开始，`PLSGifComposer` 支持选取视频帧／图片数组生成 GIF 动图。该功能使得 SDK 可以满足自主设计 GIF
的应用场景，需要使用该功能时，通过以下接口
- (instancetype)initWithImagesArray:(NSArray *)imagesArray;
来初始化 `PLSGifComposer` 对象，并为参数 `composerArray` 传入视频帧／图片数组即可。
### 6.5.1 设置 GIF 帧间隔
// Gif 动图每帧间隔设置，默认 0.1f
@property (assign, nonatomic) CGFloat interval;
### 6.5.2 生成 GIF 图
通过以下接口
- (void)composeGif;
### 6.5.3 取消生成 GIF 图
- (void)cancelComposeGif;
来生成 GIF 图，合成结果的回调见 `completionBlock`、`failureBlock`。
### 6.5.4 展示 GIF 图
通过以下接口
- (void)loadGifWithFrame:(CGRect)frame superView:(UIView *)superView repeatCount:(NSInteger)repeatCount;
来展示 GIF 图，传入要展示的 GIF 图的 frame，`superView` 要加载的父视图以及 `repeatCount` 重复次数。
## 6.6 多个视频拼接
从 v1.4.0 开始，`PLSMovieComposer` 支持拼接多个视频为1个视频。
### 6.6.1 初始化视频拼接对象
初始化视频拼接对象的方式有以下2种
self.movieComposer = [[PLSMovieComposer alloc] initWithUrls:self.urls];
self.movieComposer = [[PLSMovieComposer alloc] initWithAssets:self.assets];
设置拼接后的视频的分辨率
self.movieComposer.videoSize = CGSizeMake(480, 854);
### 6.6.2 设置视频拼接的 Block 回调
拼接成功的 Block 回调
[self.movieComposer setCompletionBlock:^(NSURL *url) {
NSLog(@"movieComposer ur: %@", url);
}];
拼接失败的 Block 回调
[self.movieComposer setFailureBlock:^(NSError *error) {
NSLog(@"movieComposer failed");
}];
拼接进度的 Block 回调
[self.movieComposer setProcessingBlock:^(float progress){
NSLog(@"movieComposer progress: %f", progress);
}];
### 6.6.3 启动视频拼接
[self.movieComposer startComposing];
### 6.6.4 停止视频拼接
在拼接视频过程中，若想停止该操作，可调用如下方法
[self.movieComposer stopComposing];
## 6.7 图片合成视频
`PLSImageToMovieComposer ` 支持多张图片合成视频。
## 6.8 多视频合并
`PLSMultiVideoMixer` 支持将多个视频合并为一个视频。支持设置每一个视频的位置、大小、开始播放时间等。
### 6.8.1 初始化多视频合并对象
PLSMultiVideoMixer *multiVideoMixer = [[PLSMultiVideoMixer alloc] init];
multiVideoMixer.videoSize = CGSizeMake{720, 640};
### 6.8.2 添加视频对象
PLSMixMediaItem *mediaItem1 = [[PLSMixMediaItem alloc] init];
mediaItem1.mediaURL = [NSURL fileURLWithPath:@"a video file path"];
mediaItem1.VideoFrame = CGRectMake{0, 0, 360, 640};
PLSMixMediaItem *mediaItem2 = [[PLSMixMediaItem alloc] init];
mediaItem2.mediaURL = [NSURL fileURLWithPath:@"a video file path"];
mediaItem2.VideoFrame = CGRectMake{360, 0, 360, 640};
[multiVideoMixer addMedia:mediaItem1];
[multiVideoMixer addMedia:mediaItem2];
### 6.8.3 视频合并实时效果预览
`PLSMultiVideoMixer` 添加视频对象之后，可以获取 AVPlayerItem 实例，使用 AVPlayer播放预览
AVPlayerItem *playerItem = [multiVideoMixer getPlayerItem];
### 6.8.4 导出合并视频
[multiVideoMixer startExport];
### 6.8.5 导出视频的block回调
导出合并视频成功的 block 回调
[mulitVideoMixer setCompletionBlock:^(NSURL * _Nonnull url) {
}];
导出合并视频失败的 block 回调
[mulitVideoMixer setFailureBlock:^(NSError * _Nonnull error) {
}];
导出合并视频进度的 block 回调
[mulitVideoMixer setProcessingBlock:^(float progress) {
}];
## 6.9 素材视频合拍
`PLSVideoMixRecorder`
支持和一个素材视频合拍为一个视频。相机采集视频和素材视频在合并视频中的位置可以自由定义，支持素材音频和麦克风采集音频混音。该类的接口和
`PLShortVideoRecorder` 的接口很相似，可以参考 `PLShortVideoRecorder` 来使用素材视频合并。
### 6.9.1 创建合拍音视频的采集和编码配置对象
当前使用默认配置，之后可以深入研究按照自己的需求作更改
PLSVideoMixConfiguration *videoConfiguration = [PLSVideoMixConfiguration defaultConfiguration];
PLSAudioMixConfiguration *audioConfiguration = [PLSAudioMixConfiguration defaultConfiguration];
### 6.9.2 创建拍摄 recorder 对象
PLSVideoMixRecorder *videoMixRecorder = [[PLSVideoMixRecorder alloc] initWithVideoConfiguration:videoConfiguration audioConfiguration:audioConfiguration];
videoMixRecorder.mergeVideoURL = [NSURL fileURLWithPath:@"a file path"];
### 6.9.3 添加合拍视频数据预览视图
[self.view addSubview: videoMixRecorder.previewView];
### 6.9.4 打开合拍视频预览
[videoMixRecorder startCaptureSession];
### 6.9.5 开始拍摄
合拍开始后，如果素材视频有音频流，将会进行素材音频的播放。素材音频的播放会影响到麦克风的音频采集，虽然麦克风采集可以选择回音消除，但是效果肯定比不上戴耳机好，建议如果要进行音频合并，带上耳机进行合拍
[videoMixRecorder startRecording];
或者使用
[videoMixRecorder startRecording:customFileURL];
### 6.9.6 停止合拍
[videoMixRecorder stopRecording];
### 6.9.7 停止预览
[self.shortVideoRecorder stopCaptureSession];
## 6.10 视频上传
`PLShortVideoUploader` 支持视频上传到云端，接口灵活。
### 6.10.1 配置上传参数
客户端在上传前，需要先从服务端获取上传凭证，即 token
PLSUploaderConfiguration * uploadConfig = [[PLSUploaderConfiguration alloc] initWithToken:kUploadToken videoKey:key https:YES recorder:nil];
### 6.10.2 创建上传对象
self.shortVideoUploader = [[PLShortVideoUploader alloc] initWithConfiguration:uploadConfig];
### 6.10.3 上传视频
[self.shortVideoUploader uploadVideoFile:filePath];
### 6.10.4 取消上传
[self.shortVideoUploader cancelUploadVidoFile];
### 6.10.5 上传回调
通过 `PLShortVideoUploader` 的 Delegate 回调方法来反馈视频上传的状态。
* 上传进度回调
- (void)shortVideoUploader:(PLShortVideoUploader * _Nonnull)uploader uploadKey:(NSString * _Nullable)uploadKey uploadPercent:(float)uploadPercent;
* 上传结果回调
- (void)shortVideoUploader:(PLShortVideoUploader * _Nonnull)uploader completeInfo:(PLSUploaderResponseInfo * _Nonnull)info uploadKey:(NSString * _Nonnull)uploadKey resp:(NSDictionary * _Nullable)resp;
## 6.11 图片、GIF 图和视频混排
`PLSImageVideoComposer` 支持多个图片、GIF 图和视频进行混排，并支持设置转场动画、图片生成视频时长、添加背景音乐等功能
### 6.11.1 创建混排对象
很多参数都有默认值，这里为了演示，对多数参数进行了自定义值设置
self.imageVideoComposer = [[PLSImageVideoComposer alloc] init];
self.imageVideoComposer.videoFramerate = 30;
self.imageVideoComposer.videoSize = CGSizeMake(544, 960);
self.imageVideoComposer.bitrate = 1500 * 1000;
self.imageVideoComposer.disableTransition = NO;
### 6.11.2 设置混排的图片、GIF 图和视频资源
NSMutableArray *mediaItems = [[NSMutableArray alloc] init];
PLSComposeMediaItem *imageMedia = [[PLSComposeMediaItem alloc] init];
imageMedia.mediaType = PLSMediaTypeAudio;
imageMedia.image = [UIImage imageNamed:@"A Image Name"];
imageMedia.imageDuration = 3.0;
PLSComposeMediaItem *gifMedia = [[PLSComposeMediaItem alloc] init];
gifMedia.mediaType = PLSMediaTypeGIF;
gifMedia.gifImageData = [[NSFileManager defaultManager] contentsAtPath:@"A GIF PATH"];
gifMedia.loopCount = 2;
PLSComposeMediaItem *videoMedia = [[PLSComposeMediaItem alloc] init];
videoMedia.mediaType = PLSMediaTypeVideo;
videoMedia.url = [NSURL fileURLWithPath:@"A Video Path"];
...
[mediaItems addObject: imageMedia];
[mediaItems addObject: gifMedia];
[mediaItems addObject: videoMedia];
self.imageVideoComposer.mediaArrays = mediaItems;
### 6.11.3 设置各个回调 block
[self.imageVideoComposer setProcessingBlock:^(float progress) {
NSLog(@"process = %f", progress);
}];
[self.imageVideoComposer setCompletionBlock:^(NSURL * _Nonnull url) {
NSLog(@"completion");
}];
[self.imageVideoComposer setFailureBlock:^(NSError * _Nonnull error) {
NSLog(@"failure");
}];
### 6.11.4 导出混排的视频
[self.imageVideoComposer startComposing];
启动导出混排视频之后，导出的进度等信息通过上一节设置的 block 返回
### 6.11.5 取消导出混排的视频
[self.imageVideoComposer stopComposing];
# 7 功能使用
当你要深入理解 SDK 的一些参数及有定制化需求时，可以从高级功能部分中查询阅读，以下小节无前后依赖。
## 7.1 音视频采集和编码配置
`PLShortVideoRecorder` 中通过不同的 configuration 设置不同的采集或编码配置信息，对应的有：
* `PLSVideoConfiguration` 视频采集、编码配置
* `PLSAudioConfiguration` 音频采集、编码配置
可以通过如下途径来设置 configuration：
* 在 `PLShortVideoRecorder` init 时传递对应的 configuration
* 在拍摄前、拍摄结束后调用下面的方法重置视频采集、编码配置
`- (void)reloadvideoConfiguration:(PLSVideoConfiguration
*__nonnull)videoConfiguration;`
* 对于视频采集配置，可以直接设置 PLShortVideoRecorder 相关的属性；
需要注意的是，通过 reload 方法重置 configuration 时，需要确保传递的 configuration 与当前 session
已经持有的不是一个对象。
### 7.1.1 视频采集参数
当前的 `PLSVideoConfiguration` 中可自行设定的参数有
* videoFrameRate
* 即 FPS，每一秒所包含的视频帧数
* sessionPreset
* 即采集时的画幅分辨率大小
* previewMirrorFrontFacing
* 是否在使用前置摄像头采集的时候镜像预览画面
* previewMirrorRearFacing
* 是否在使用后置摄像头采集的时候镜像预览画面
* streamMirrorFrontFacing
* 是否在使用前置摄像头采集的时候镜像编码画面
* streamMirrorRearFacing
* 是否在使用后置摄像头采集的时候镜像编码画面
* position
* 开启 PLShortVideoSession 的时候默认使用前置还是后置摄像头
* videoOrientation
* 开启 PLShortVideoSession 的时候默认使用哪个旋转方向
需要注意的是指定分辨率的 `sessionPreset` 例如 `AVCaptureSessionPreset1920x1080`
并非所有机型的所有摄像头均支持，在设置相应的采集分辨率之前请务必保证做过充分的机型适配测试，避免在某些机型使用该机型摄像头不支持的
`sessionPreset`。另外，如果使用只指定采集质量的 `sessionPreset`，例如
`AVCaptureSessionPresetMedium`，那系统会根据当前摄像头的支持情况使用相应质量等级的分辨率进行采集。
### 7.1.2 音频采集参数
当前的 `PLSAudioConfiguration` 中可自行设定的参数有
* numberOfChannels
* 采集时的声道数，默认为 1，并非所有采集设备都支持多声道数据的采集，可以通过检查 [AVAudioSession sharedInstance].maximumInputNumberOfChannels 得到当前采集设备支持的最大声道数。
### 7.1.3 视频编码参数
当前的 `PLSVideoConfiguration` 中可自行设定的参数有
* videoProfileLevel
* H.264 编码时对应的 profile level 影响编码压缩算法的复杂度和编码耗能。设置的越高压缩率越高，算法复杂度越高，相应的可能带来发热量更大的情况。如果对于视频编码有额外的需求并且知晓该参数带来的影响可以自行更改。默认情况下使用 AVVideoProfileLevelH264HighAutoLevel。
* videoSize
* 编码的分辨率，对于采集到的图像，编码前会按照这个分辨率来做拉伸或者裁剪
* expectedSourceVideoFrameRate
* 预期视频的编码帧率，这个数值对编码器的来说并不是直接限定了 fps, 而是给编码器一个预期的视频帧率，最终编码的视频帧率，是由实际输入的数据决定的
* videoMaxKeyframeInterval
* 两个关键帧的帧间隔，一般设置为 FPS 的三倍
* averageVideoBitRate
* 平均的编码码率，设定后编码时的码率并不会是恒定不变，静物较低，动态物体会相应升高
### 7.1.4 音频编码参数
相比于视频繁杂的参数，当前 `PLSAudioConfiguration` 可配置的参数较为简单，目前提供音频码率和编码器的配置，音频编码默认为 AAC-
LC。
各 Quality 的对比：
Quality | Audio BitRate(Kbps)
---|---
QualityHigh1 | 64
QualityHigh2 | 96
QualityHigh3 | 128
### 7.1.5 切换视频配置
为了满足拍摄过程中，拍摄不同分辨率的视频等情况下对码率、FPS 等参数的调节，`PLShortVideoSession` 提供了重置采集、编码参数的方法。
* 在拍摄前、拍摄结束后调用下面的方法来重置 configuration
`- (void)reloadvideoConfiguration:(PLSVideoConfiguration
*__nonnull)videoConfiguration;`
需要注意的是，通过 reload 方法重置 configuration 时，需要确保传递的 configuration 与当前 session
已经持有的不是一个对象。
## 7.2 视频拍摄状态回调
在 `PLShortVideoKit` 中，通过反馈 `PLShortVideoRecorder` 的 Delegate 回调方法来反馈拍摄的状态。
* 获取到摄像头原数据时的回调, 便于开发者做滤镜等处理，需要注意的是这个回调在 camera 数据的输出线程，请不要做过于耗时的操作，否则可能会导致帧率下降
- (CVPixelBufferRef __nonnull)shortVideoRecorder:(PLShortVideoRecorder *__nonnull)recorder cameraSourceDidGetPixelBuffer:(CVPixelBufferRef __nonnull)pixelBuffer;
* 开始录制一段视频时
- (void)shortVideoRecorder:(PLShortVideoRecorder *__nonnull)recorder didStartRecordingToOutputFileAtURL:(NSURL *__nonnull)fileURL;
* 正在录制的过程中。在完成该段视频录制前会一直回调，可用来更新所有视频段加起来的总时长 totalDuration UI。
- (void)shortVideoRecorder:(PLShortVideoRecorder *__nonnull)recorder didRecordingToOutputFileAtURL:(NSURL *__nonnull)fileURL fileDuration:(CGFloat)fileDuration totalDuration:(CGFloat)totalDuration;
* 删除了某一段视频
- (void)shortVideoRecorder:(PLShortVideoRecorder *__nonnull)recorder didDeleteFileAtURL:(NSURL *__nonnull)fileURL fileDuration:(CGFloat)fileDuration totalDuration:(CGFloat)totalDuration;
* 完成一段视频的录制时
- (void)shortVideoRecorder:(PLShortVideoRecorder *__nonnull)recorder didFinishRecordingToOutputFileAtURL:(NSURL *__nonnull)fileURL fileDuration:(CGFloat)fileDuration totalDuration:(CGFloat)totalDuration;
* 在达到指定的视频录制时间 maxDuration 后，如果再调用 `[PLShortVideoRecorder startRecording]`，那么会立即执行该回调。该回调功能是用于页面跳转
- (void)shortVideoRecorder:(PLShortVideoRecorder *__nonnull)recorder didFinishRecordingMaxDuration:(CGFloat)maxDuration;
## 7.3 水印、美颜和内置滤镜
### 7.3.1 水印
`PLShortVideoRecorder` 支持内置水印功能，你可以根据自己的需要添加水印或移除水印，并且能够自由设置水印的大小和位置。
* 拍摄时添加水印
-(void)setWaterMarkWithImage:(UIImage *__nonnull)waterMarkImage position:(CGPoint)position;
该方法将为视频拍摄时添加一个水印，水印的大小由 `waterMarkImage` 的大小决定，位置由 position
决定，需要注意的是这些值都是以采集数据的像素点为单位的。例如我们使用 `AVCaptureSessionPreset1280x720` 进行采集，同时
`wateMarkImage.size` 为 `(100, 100)` 对应的 `origin` 为 `(200, 300)`，那么水印的位置将在大小为
`1280x720` 的采集画幅中位于 `(200, 300)` 的位置，大小为 `(100, 100)`。
* 移除水印
-(void)clearWaterMark;
该方法用于移除已添加的水印
### 7.3.2 美颜
‘PLShortVideoRecorder’ 支持内置美颜功能，你可以根据自己的需要选择开关美颜功能，并且能够自由调节包括美颜，美白，红润等在内的参数。
* 按照默认参数开启或关闭美颜
-(void)setBeautifyModeOn:(BOOL)beautifyModeOn;
* 设置美颜程度，范围为 0 ~ 1
-(void)setBeautify:(CGFloat)beautify;
* 设置美白程度，范围为 0 ~ 1
-(void)setWhiten:(CGFloat)whiten;
* 设置红润程度，范围为 0 ~ 1
-(void)setRedden:(CGFloat)redden;
### 7.3.3 录制时内置滤镜
‘PLShortVideoRecorder’ 支持录制时启用内置滤镜功能，能够自由调节多种滤镜效果。
按照默认参数开启或关闭录制时内置滤镜，选择需要的滤镜效果。
@property (strong, nonatomic) PLSFilter *currentFilter;
@property (assign, nonatomic) NSInteger filterIndex;
## 7.4 外部导入音视频数据
从 v1.2.0 开始，`PLShortVideoRecorder` 支持外部导入音视频数据存成 mp4。该功能使得 SDK 可以满足更多的应用场景，如在
App 的视图和摄像头数据之间切换等。需要使用该功能时，通过以下接口
- (nonnull instancetype)initWithVideoConfiguration:(PLSVideoConfiguration *__nonnull)videoConfiguration
audioConfiguration:(PLSAudioConfiguration *__nonnull)audioConfiguration
captureEnabled:(BOOL)captureEnabled;
来初始化 `PLShortVideoRecorder` 对象，并为参数 `captureEnabled` 传入 NO 即可。
### 7.4.1 导入音频数据
通过以下接口
- (void)writeSampleBuffer:(CMSampleBufferRef _Nonnull)sampleBuffer;
来导入音频数据。注意，如果初始化 `PLShortVideoRecorder` 时参数 `captureEnabled` 为 YES 时，将使用 SDK
内部采集的音频数据，该接口将不起作用。
### 7.4.2 导入视频数据
通过以下接口
- (void)writePixelBuffer:(CVPixelBufferRef _Nonnull)pixelBuffer timeStamp:(CMTime)timeStamp;
来导入视频数据。注意，如果初始化 `PLShortVideoRecorder` 时参数 `captureEnabled` 为 YES 时，将使用 SDK
内部采集的视频数据，该接口将不起作用。另外，导入视频数据的频率应该与 `PLSVideoConfiguration` 中设置帧率一致，否则将出现音画不同步。
### 7.4.3 录制 App 视图
开发者可以通过定时（比如每隔 50ms）给 App 中的 `UIView` 截图，并将其生成 `CVPixelBufferRef`
后通过上述导入视频数据接口导入到 SDK 中存成 mp4 文件，如果上述的 `UIView` 是 `UIApplication` 的
`keyWindow`，其效果便相当于给 App 录屏了。将 `UIView` 截图并生成 `CVPixelBufferRef` 可参考如下方法：
- (CVPixelBufferRef)createCVPixelBufferWithView:(UIView *)view {
UIGraphicsBeginImageContextWithOptions(view.bounds.size, view.opaque, 0.0);
[view drawViewHierarchyInRect:view.bounds afterScreenUpdates:NO];
UIImage *image = UIGraphicsGetImageFromCurrentImageContext();
UIGraphicsEndImageContext();
NSDictionary *options = [NSDictionary dictionaryWithObjectsAndKeys:
[NSNumber numberWithBool:YES], kCVPixelBufferCGImageCompatibilityKey,
[NSNumber numberWithBool:YES], kCVPixelBufferCGBitmapContextCompatibilityKey,
@{}, kCVPixelBufferIOSurfacePropertiesKey,
nil];
CVPixelBufferRef pxbuffer = NULL;
CGFloat frameWidth = CGImageGetWidth([image CGImage]);
CGFloat frameHeight = CGImageGetHeight([image CGImage]);
CVReturn status = CVPixelBufferCreate(kCFAllocatorDefault,
frameWidth,
frameHeight,
kCVPixelFormatType_32BGRA,
(__bridge CFDictionaryRef) options,
&pxbuffer);
if (status != kCVReturnSuccess) {
return NULL;
}
CVPixelBufferLockBaseAddress(pxbuffer, 0);
void *pxdata = CVPixelBufferGetBaseAddress(pxbuffer);
CGColorSpaceRef rgbColorSpace = CGColorSpaceCreateDeviceRGB();
CGContextRef context = CGBitmapContextCreate(pxdata,
frameWidth,
frameHeight,
8,
CVPixelBufferGetBytesPerRow(pxbuffer),
rgbColorSpace,
kCGBitmapByteOrder32Little | kCGImageAlphaPremultipliedFirst);
CGContextConcatCTM(context, CGAffineTransformIdentity);
CGContextDrawImage(context, CGRectMake(0,
0,
frameWidth,
frameHeight),
[image CGImage]);
CGColorSpaceRelease(rgbColorSpace);
CGContextRelease(context);
CVPixelBufferUnlockBaseAddress(pxbuffer, 0);
return pxbuffer;
}
## 7.5 文字动画导出为视频文件
从 1.10.0 开始，`PLSTransitionMaker` 用于将 文字动画 和 图片动画
转换为视频文件。支持文字内容、文字字体、文字位置编辑以及图片动画的编辑，`PLSTextSetting` 为文字编辑对象、`PLSImageSetting`
为图片编辑对象。`PLSPositionTransition`、
`PLSRotateTransition`、`PLSScaleTransition`、`PLSFadeTranstion` 分别为 SDK
提供的四种动画特效：位置特效、旋转特效、缩放特效和隐藏/显示特效，通过四种特效的组合，能满足绝大多数的开发者需求
### 7.5.1 文字对象添加
开发者可以通过
- (NSInteger)addText:(PLSTextSetting *)textSetting;
- (void)updateTextWithResourceID:(NSInteger)resourceID newTextSetting:(PLSTextSetting *)textSetting;
添加文字对象或者更新文字对象，addText 返回添加的文字对象 ID，更新的时候，传入要更新文字对象 ID 和新的文字对象
### 7.5.2 图片对象添加
开发者可以通过
- (NSInteger)addImage:(PLSImageSetting *)imageSetting;
- (void)updateImageWithResourceID:(NSInteger)resourceID newImageSetting:(PLSImageSetting *)imageSetting;
添加图片对象或者更新图片对象，addImage 返回添加的图片对象 ID，更新的时候，传入要更新图片对象 ID 和新的文字对象
### 7.5.3 文字或图片动画添加
开发者可以通过
- (void)addTransition:(PLSTransition *)transition resourceID:(NSInteger)resourceID;
来文字和图片的动画效果
### 7.5.4 动画效果预览
‘PLSTransitionMaker’ 内部根据开发者设置的文字、图片、动画，实时生成视频预览效果，开发者可以通过
- (void)play;
- (void)transitionMakerPreviewEnd:(PLSTransitionMaker *)transitionMaker;
来预览和接收预览结束的回调
### 7.5.5 导出为视频文件
开发者可以通过
- (void)startMaking;
来启动导出视频文件
### 7.5.6 导出视频文件回调
开发者可以通过
- (void)transitionMaker:(PLSTransitionMaker *)transitionMaker exportMediaSucceed:(NSURL *)outURL;
- (void)transitionMaker:(PLSTransitionMaker *)transitionMaker exportMediaFailed:(NSError *)error;
来接收导出视频文件成功和失败的回调
# 8 历史记录
* 3.2.5
* 修复鉴权异常 crash
* 修复 PLShortVideoEditor 添加 bgm，loop 为 no 时 bgm 超过设定 duration 不停止
* 修复 PLSAVAssetExportSession 设置音频码率无效
* 3.2.4
* 更新上传库 Qiniu v8.2.0
* 修复超高清视频色差
* 修复旋转预览显示异常
* 3.2.3
* 修复鉴权偶现 crash 的问题
* 修复同时 pod 导入百度地图 SDK 内置美颜会 crash 的问题
* 3.2.2
* 修复后置切前置第一帧画面镜像的问题
* 修复转码有色差的问题
* 修复横屏拍摄时内存泄漏的问题
* 3.2.1
* 修复一些音轨不正常的视频导出失败的问题
* 修复无法打开闪光灯的问题
* 修复 4k 编辑 crash 的问题
* 支持单独开关音频、视频采集
* 3.2.0
* 修复录制音画不同步问题
* 修复导出时偶现崩溃
* 修正导出视频的方向
* 新增录制时蓝牙耳机的支持
* 新增 11 种视频转场效果
* 新增导出视频时支持设置 gop size
* 升级上传 SDK
* 3.1.1
* 修复 iOS 13.0 下，图片合成视频无转场动画的问题
* 修复某些机型下，导出视频产生内存溢出的问题
* 修复首次更新至 v3.1.0 偶现运行拍摄或编辑发生 crash 的问题
* 修复 PLSImageVideoComposer 设置视频 timeRange 后合成首帧错误的问题
* 新增对拍摄、编辑和转码的 H265 编码支持
* 3.1.0
* 新增可设置 PLSImageVideoComposer 无转场动画
* 新增设置使用 PLSComposeMediaItem 为视频时，可自定义视频的取用范围
* 3.0.0
* 修复合拍分多段录制后，视频声音断断续续的问题
* 修复部分图片和视频混排添加转场动画合成偶现失败的问题
* 修复 PLSImageToMovieComposer 设置转场时间没有效果的问题
* 2.2.0
* 支持合拍分层
* 修复视频编辑添加背景音乐或者多重混音后，不暂停状态下 seek 播放卡死的问题
* 2.1.0
* 支持 GIF 动态贴纸功能
* 支持设置静态贴纸不被滤镜效果渲染
* 优化合拍内存使用量
* 修复 PLSGifComposer 获取视频图片，当获取图片数量是 1 的时候获取失败的问题
* 修复使用 swift 调用 PLSComposeItem，PLSComposeItem init 方法不执行的问题
* 修复视频录制，在启用根据设备方向自动调整横竖屏录制时，横屏模式下录制偶现生成的视频文件是竖屏的问题
* 修复对时长较长的视频进行转码失败的问题
* 2.0.0
* 视频编辑 PLShortVideoEditor 在暂停的时候改变 fillMode，支持即时效果刷新
* 视频拍摄 PLShortVideoRecorder 添加新的相机切换接口，支持设置相机切换完成回调
* 优化视频编辑 PLShortVideoEditor 对 1080P 及以上视频进行编辑, 在 iOS 12 系统上内存占用较大的问题
* 修复视频拍摄 PLShortVideoRecorder 添加背景音乐的时候，自适应横屏拍摄失效的问题
* 修复视频编辑 PLShortVideoEditor 原视频设置为非循环播放，背景音乐仍然循环播放的问题
* 修复视频编辑 PLShortVideoEditor 使用 initWithPlayerItem: 方法初始化 crash 的问题
* 修复视频编辑 PLShortVideoEditor 的 timeRange 设置为 kCMTimeRangeZero 时，设置背景音乐不生效的问题
* 修复视频导出 AVAssetExportSession 不设置 PLSAudioSettingsKey，音量设置无效的问题
* 修复视频导出 AVAssetExportSession 添加 MV 的时候，存在内存泄漏的问题
* 修复视频导出 AVAssetExportSession 完成进度回调可能会从 99% 到 0 的问题
* 1.16.1
* SDK 去掉对 i386 模拟器的支持
* 添加 SDK 授权状态查询接口
* 修复时光倒流特效处理声道数大于 2 的视频导出失败的问题
* 修复视频编辑添加 MV 特效，预览的时候 MV 滞后视频播放 1s 左右问题
* 修复对无音频通道的视频添加 MV 特效，AVAssetExportSession 导出时 crash 的问题
* 修复 AVAssetExportSession 导出视频通道比音频通道时长短的视频时结尾处出现黑帧的问题
* 修复 AVAssetExportSession 添加贴纸起始时间是 0 的时候，第一帧视频没有贴纸效果的问题
* 修复 PLShortVideoRecorder 截帧小概率 crash 的问题
* 1.16.0
* 添加图片、GIF 图和视频混排功能
* 视频导出类 PLSAVAssetExportSession 支持设置导出视频的音频码率和声道数
* 视频切割类 PLSRangeMovieExport 支持设置导出视频的码率、宽高以及视频的填充模式
* 视频录制时音频编码采样率支持 16000Hz
* 多个视频文件拼接增加视频优先（PLSComposerPriorityTypeVideo）和音频优先（PLSComposerPriorityTypeAudio）模式
* 修复视频录制当设置背景音乐起始位置不是 0 的时候，删除已经录制的片段导致背景音乐起始位置变为 0 的问题
* 修复视频录制当设置的录制视频宽高之比和采集视频的宽高之比不相等时，录制视频画面剪裁位置不对的问题
* 修复视频导出类 PLSAVAssetExportSession 导出视频可能会丢失最开始几帧视频的问题
* 修复 1080P 的视频在 iPhone 5 上执行时光倒流失败的问题
* 修复 PLSEditPlayer 播放部分视频结束的时候播放画面黑屏的问题
* 1.15.0
* 支持 GIF 水印
* 支持设置水印作用时间段、水印透明度和水印旋转角度
* 视频录制类 PLShortVideoRecorder 支持 AVCaptureSession 属性
* 视频导出类 PLSAVAssetExportSession 支持设置导出视频帧率
* 优化贴纸显示和隐藏动画时长的问题
* 修复视频导出类 PLSAVAssetExportSession 导出非 16 整数倍分辨率时，生成的视频有黑边的问题
* 修复素材合拍内存泄漏的问题
* 修复 GIF 制作类 PLSGifComposer 在 iOS 10 及以上版本生成的 GIF 图片循环次数始终是 1 次的问题
* 修复视频导出类 PLSAVAssetExportSession 当同时设置视频旋转和添加 MV 时，导出的视频 MV 显示位置错乱的问题
* 1.14.0
* 增加时光倒流特效是否移除音频接口
* 增加设置水印大小接口
* 多个视频拼接，支持音视频同步优先模式和播放流畅优先模式
* 支持 MV 特效选择 MV 素材时间段
* 支持 MV 特效循环添加
* MV 特效支持 MV 素材帧率和被编辑视频帧率不相等的场景
* 优化图片转视频当图片数量过多造成内存溢出的问题
* 优化 1080P 视频时光倒流特效内存溢出的问题
* 修复使用七牛上传 SDK Qiniu v7.2.4 及以上版本导致短视频上传崩溃的问题
* 修复 PLSAVAssetExportSession 的音频参数使用 NSDictionary 崩溃的问题
* 1.13.1
* 优化拍摄页面使用 UIImagePickerController 打开系统相机之后再返回拍摄页面导致预览画面不能铺满屏幕的问题
* 优化首次启动短视频录制出现的已录制视频时长回调顺序不对的问题
* 优化短视频编辑 PLShortVideoEditor 更新背景音乐的 timeRange 之后，首次播放时背景音乐起始部分重复播放的问题
* 修复 Swift 开发环境下调用视频拍摄接口时，实现正在录制中的回调 shortVideoRecorder: didRecordingToOutputFileAtURL: fileDuration: totalDuration: 导致 Crash 的问题
* 1.13.0
* 支持设置视频转码帧率
* 支持视频转码时裁剪视频像素区域
* 优化素材视频合拍音频数据回调格式，由 CMSampleBufferRef 修改为 AudioBufferlist
* 优化图片转视频模块生成的视频时长不精准的问题
* 优化 pod install 或 update PLShortVideoKit 时进度缓慢的问题
* 修复 PLSEditPlayer 在 iOS 9.0 以下无法播放的问题
* 修复 PLSMovieComposer 拼接 16 个以上视频失败的问题
* 修复 SDK 无法处理 5.1 声道的视频的问题
* 修复素材合拍，素材视频没有音频轨道时合拍失败的问题
* 1.11.1
* 优化视频拍摄效果，手动对焦的同时自动调整曝光位置
* 优化对 4K 视频的处理
* 优化短视频录制时 App 从后台回到前台自动开启录制的问题
* 优化 PLSEditPlayer seek 逻辑，能达到帧级别的 seek
* 优化 PLSEditPlayer 频繁添加背景音乐逻辑
* 优化对某些特殊视频进行编辑，首帧解码失败导致播放画面黑屏的问题
* 修复对某些特殊视频进行剪裁崩溃的问题
* 修复从手机系统相册导入视频进行编辑，部分视频方向不正确的问题
* 修复 PLSGLProgram 类名重复的问题
* 修复 PLShortVideoEditor 添加多音效首次预览的时候，播放时间点不对的问题
* 修复素材合拍 App 从后台回到前台无法继续录制的问题
* 修复 PLSAssetExportSession 在没有设置 PLSAudioSettingsKey 时视频剪裁不生效的问题
* 1.11.0
* 支持摄像头与素材视频合拍功能
* 支持多个视频进行任意布局的拼图合并
* 支持对图片、GIF 进行录制
* 支持图片旋转动画录制
* 支持视频录制阶段从指定位置播放背景音乐
* 支持视频编辑阶段按指定时间段预览添加的贴图、文字、涂鸦
* 支持视频编辑阶段添加多个背景音效功能
* 支持视频编辑阶段背景音乐循环播放和仅播放一次
* 支持视频转码自定义码率
* 支持视频转码自定义输出视频地址
* 支持视频导出自定义码率
* 支持视频导出自定义输出视频地址
* 修复视频录制阶段开启横竖屏检测后横屏拍摄出现的首帧画面闪烁的问题
* 修复视频编辑阶段裁剪背景音乐后若背景音乐总时长为0时导致程序出现死循环的问题
* 修复视频编辑阶段裁剪背景音乐后循环播放到第二次时背景音乐停止播放的问题
* 修复视频编辑阶段截取视频再执行倍速效果后视频后半部分没有倍速效果的问题
* 修复少数机型上 GIF 制作失败的问题
* 修复多个视频拼接导出偶现失败的问题
* 修复视频切割导出偶现失败的问题
* 修复 H.265 视频转码之后首帧黑屏的问题
* 1.10.0
* 支持文字动画转换为视频文件
* 支持多个视频同时进行切割编辑
* 对能直接 H.265 硬解码的机型支持导入 H.265 格式视频文件进行转码
* 支持在视频任意位置插入文字转场视频编辑
* 支持 PLSUploaderConfiguration 上传 params 设置
* 支持倍速录制视频时以对应的倍速播放背景音乐
* 优化 PLSEditPlayer 在暂停的时候 seek 时预览画面刷新逻辑
* 修复录制时播放背景音乐，并在录制结束后再次合成背景音乐导致有两重背景音乐声音的问题
* 修复多张图片合成视频时设置图片持续时间导致的最后一张图片没有被合入视频的问题
* 更新人脸贴纸库解决了使用人脸贴纸库后反复进出录制页面导致的崩溃问题
* 1.9.0
* 支持抖音特效
* 支持拍摄时截取图片
* 支持编辑类 PLShortVideoEditor 和视频导出类 PLSAVAssetExportSession 回调出视频的时间戳
* 修复快速开始和停止视频录制导致偶现文件写入报错的问题
* 修复编辑时添加背景音乐导致视频没有从剪切的起始位置处播放的问题
* 修复编辑类 PLShortVideoEditor 的回调不执行的问题
* 修复 1:1 比例的视频添加涂鸦、文字、图片后导出的视频出现倒立的问题
* 修复添加 MV 特效导出视频后原视频和背景音乐的音量大小不生效的问题
* 修复添加 MV 特效后只能固定输出某个视频分辨率的问题。
* 修复同时快速切换摄像头和滤镜偶现的 Crash 问题
* 修复在拒绝麦克风权限情形下添加背景音乐录制视频后进入编辑时 Crash 的问题
* 修复在拒绝相机权限情形下录制结束后进入编辑时 Crash 的问题
* 修复在拒绝相机和麦克风权限情形下视频录制结束后进行视频导出操作没有回调 Error 信息的问题
* 修复倍速拍摄后在编辑时不同倍速视频段衔接处会出现视频帧闪烁的问题
* 1.8.0
* 支持视频拍摄时自定义视频存放地址
* 支持转码时旋转视频
* 支持日志系统
* 修复 MV 特效在某种特定情形下预览不生效的问题
* 优化图片合成视频的效果
* 修复横屏拍摄时前几帧画面偏暗的问题
* 1.7.0
* 支持文字特效
* 支持视频涂鸦
* 支持视频贴纸
* 支持图片合成视频
* 支持视频草稿
* 支持拍摄时录制背景音乐
* 支持编辑时旋转视频
* 支持编辑时使用视频首帧作为滤镜封面图
* 修复编辑时音乐时长小于视频时长时音乐不随视频循环播放的问题
* 1.6.0
* 支持配音功能
* 支持编辑时对视频进行变速处理
* 支持 AR 特效拍摄
* 支持摄像头对焦位置的回调
* 修复横竖屏自动切换的拍摄模式下设备方向检测不精准的问题
* 修复视频拍摄时使用前置 AVCaptureSessionPreset1920x1080 预览黑屏的问题
* 修复频繁切换 1:1 与全屏录制模型出现的预览黑屏问题
* 修复录屏偶现 Crash 的问题
* 修复视频转码偶现 Crash 的问题
* 修复多个视频拼接使用视频拼接模块后生成的视频体积变大的问题
* 修复背景音乐与视频时长相同时导出的视频无声音的问题
* 修复 iPhone 5 设备上将视频转码成 1080P 后快速执行视频导出偶现 Crash 的问题
* 1.5.0
* 支持 MV 特效
* 支持时光倒流特效
* 更新视频文件的存储目录
* 1.4.1
* 修复 iOS 11 系统上添加滤镜导致预览卡住的问题
* 修复拍摄时对焦动画引发的内存泄漏问题
* 更新上传依赖库 Qiniu 去适配 iOS 11 系统
* 1.4.0
* 支持倍速拍摄
* 支持多视频拼接
* 增加取消 GIF 合成接口
* 1.3.0
* 支持横屏拍摄
* 支持合成 GIF 动图
* 修复录制时频繁切换滤镜导致预览卡住的问题
* 修复快速执行开始和停止录制导致的 crash 问题
* 1.2.1
* 修复首次安装后第一次录制无法预览和采集的问题
* 修复被裁减的视频执行静音导出后起始时间内未静音的问题
* 更新滤镜封面图
* 1.2.0
* 支持录屏
* 支持手动对焦动画
* 修复偶现视频合成失败问题
* 修复剪辑的视频导出后时长少零点几秒的问题
* 1.1.1
* 支持视频转码修正视频方向
* 修复无音频轨视频合成失败问题
* 1.1.0
* 支持视频转码
* 支持断点续传
* 支持裁剪背景音乐
* 1.0.4
* 支持录制时启用内置滤镜
* 优化 mp4 文件大小
* 支持视频上传到云端
* 1.0.3
* 支持背景音乐
* 1.0.2
* 选取相册中的单个视频并编辑
* 优化 1:1 录制，捕捉摄像头的中心画面
* 1.0.1
* 优化水印效果
* 修复音频采集回调中的数据类型
* 修复 iOS 8.1 上拍摄视频时预览视图卡住的问题
* 1.0.0
* 支持 H.264、AAC 硬编码
* 支持断点拍摄
* 支持回删视频
* 支持视频水印
* 内置实时美颜
* 内置几十种专业级滤镜
* 支持第三方美颜和滤镜
* 支持自定义录制时长
* 支持分辨率码率配置
* 支持 1:1 录制
# 9 FAQ
### 9.1 SDK 是否收费，哪里可以下载 ？
本短视频 SDK 需授权方可使用，可通过 400-808-9176 转 2 号线联系七牛商务咨询，或者 [通过工单
__](https://support.qiniu.com/?ref=developer.qiniu.com)联系七牛的技术支持。
### 9.2 我可以体验下 demo 吗 ？
可以，请到 App Store 搜索：`PLShortVideo`
### 9.3 是否支持人脸特效、动态贴纸等 ？
支持，该功能属于高级收费功能，需要联系商务获取资源
### 9.4 是否支持抖音特效？
支持，该功能属于高级收费功能，需要联系商务获取 appkey 和资源文件。具体使用可参看 [demo
__](https://github.com/pili-engineering/PLShortVideoKit)
### 9.5 是否支持视频播放 ？
生成和上传的 mp4 文件，可以用系统的播放器播放，如果需要更高级的播放功能，推荐使用七牛的 [PLPlayerKit
__](https://github.com/pili-engineering/PLPlayerKit)播放 SDK
### 9.6 导出的视频支持哪些格式 ？
支持 mp4 和 mov 格式。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 短视频 >iOS 短视频 SDK
# iOS 短视频 SDK
最近更新时间: 2021-07-05 19:02:15
# 1 概述
PLShortVideoKit 是七牛推出的一款适用于 iOS 平台的短视频
SDK，提供了包括美颜、滤镜、水印、断点录制、分段回删、视频编辑、混音特效、MV 特效、本地/云端存储在内的多种功能，支持高度定制以及二次开发。
## 1.1 下载地址
* [iOS Demo 以及 SDK 下载地址 __](https://github.com/pili-engineering/PLShortVideoKit)
# 2\. 功能列表
短视频 SDK 主要区分精简版、基础版、进阶版、专业版 4 个版本，不同版本的功能[请参考
__](https://developer.qiniu.com/pili/sdk/3731/short-video)
# 3 阅读对象
本文档为技术文档，需要阅读者：
* 具有基本的 iOS 开发能力
* 准备接入七牛云存储
# 4 总体设计
## 4.1 基本规则
为了方便理解和使用，对于 SDK 的接口设计，我们遵循了如下的原则：
* 每一个接口类，均以 `PLS` 开头
* 简单的配置，通过 `NSDictionary` 来设置
* 复杂的配置类，以 `PLSXXXConfiguration` 命名
* 所有的回调代理，以 `PLSXXXXDelegate` 命名
## 4.2 核心接口
核心的接口类说明如下：
接口类名 | 功能 | 备注
---|---|---
PLShortVideoRecorder | 负责视频的拍摄 | 音视频采集、美颜、编码、封包等
PLShortVideoEditor | 负责视频内容的编辑 | 添加滤镜、水印、文字特效等
PLSAVAssetExportSession | 负责视频的拼接、导出 | 视频导出等
PLShortVideoTranscoder | 负责视频的转码 | 视频转码，获取视频信息等
PLShortVideoUploader | 负责视频的上传 | 视频文件的上传
PLSTransitionMaker | 负责文字动画生成视频文件 | 文字转 mp4
PLSMultiVideoMixer | 负责将多个视频文件合并 | 多视频合并
PLSVideoMixRecorder | 负责素材视频合拍 | 视频编辑
PLSImageVideoComposer | 负责图片、GIF 图和视频混排 | 视频编辑
## 4.3 视频拍摄接口类
拍摄功能相关的类说明如下：
接口名 | 功能 | 备注
---|---|---
PLShortVideoRecorder | 视频拍摄的核心接口 | 核心接口
PLSVideoConfiguration | 配置摄像头参数 | 预览分辨率，前后摄像头等
PLSAudioConfiguration | 配置麦克风参数 | 通道，采样率等
PLSFilter | 内置滤镜对象 | 滤镜名称，缩略图等
PLShortVideoRecorderDelegate | 视频拍摄回调 | 包括原始数据回调及拍摄回调等
## 4.4 视频编辑接口类
### 4.4.1 视频内容编辑接口类
视频编辑功能相关的类说明如下：
接口名 | 功能 | 备注
---|---|---
PLShortVideoEditor | 视频编辑的核心接口 | 核心接口
PLSEditSettings | 配置视频编辑参数 | 源文件、音效、水印设置等
PLSAVAssetExportSession | 导出视频接口 | 根据设置的相应参数导出视频
PLSGifComposer | 制作 GIF 图接口 | 根据视频帧／图片数组合成 GIF图
PLSMovieComposer | 多个视频拼接接口 | 将多个视频拼接为1个视频
PLSReverserEffect | 时光倒流特效接口 | 将视频倒序
### 4.4.2 视频转码接口类
接口名 | 功能 | 备注
---|---|---
PLSAVAssetExportSession | 视频导出的核心接口 | 核心接口
PLShortVideoTranscoder | 视频转码的核心接口 | 核心接口
## 4.5 视频上传接口类
视频上传功能相关的类说明如下：
接口名 | 功能 | 备注
---|---|---
PLShortVideoUploader | 视频上传的核心接口 | 核心接口
PLSUploaderConfiguration | 配置上传参数 | 上传视频空间 token 等
PLShortVideoUploaderDelegate | 上传进度及结果回调 | 回调上传进度及结果
# 5 开发准备
## 5.1 设备以及系统要求
* 设备要求：iPhone 5 及以上
* 系统要求：iOS 8 及以上
## 5.2 开发环境配置
* Xcode 开发工具。App Store [下载地址 __](https://itunes.apple.com/us/app/xcode/id497799835?ls=1&mt=12)
* 安装 CocoaPods。[了解 CocoaPods 使用方法 __](https://cocoapods.org/)
## 5.3 导入 SDK
[CocoaPods __](https://cocoapods.org/)是针对 Objective-C 的依赖管理工具，它能够将使用类似
PLShortVideoKit 的第三方库的安装过程变得非常简单和自动化，你能够用下面的命令来安装它：
$ sudo gem install cocoapods
### 5.3.1 Podfile
为了使用 CoacoaPods 集成 PLShortVideoKit 到你的 Xcode 工程当中，你需要编写你的 `Podfile`
#### 专业版安装
如果你购买的是七牛专业版本的短视频 SDK，请按如下方式填写Podfile：
target 'TargetName' do
pod 'PLShortVideoKit'
end
#### 进阶版安装
如果你购买的是七牛进阶版本的短视频 SDK，请按如下方式填写Podfile：
target 'TargetName' do
pod 'PLShortVideoKit', :podspec => 'https://raw.githubusercontent.com/pili-engineering/PLShortVideoKit/master/PLShortVideoKit-Advanced.podspec'
end
#### 基础版安装
如果你购买的是七牛基础版本的短视频 SDK，请按如下方式填写Podfile：
target 'TargetName' do
pod 'PLShortVideoKit', :podspec => 'https://raw.githubusercontent.com/pili-engineering/PLShortVideoKit/master/PLShortVideoKit-Basic.podspec'
end
#### 精简版安装
如果你购买的是七牛精简版本的短视频 SDK，请按如下方式填写Podfile：
target 'TargetName' do
pod 'PLShortVideoKit', :podspec => 'https://raw.githubusercontent.com/pili-engineering/PLShortVideoKit/master/PLShortVideoKit-Smart.podspec'
end
### 5.3.2 运行 pod
Podfile填写完成后，运行如下命令安装SDK：
$ pod install
**注意：在使用了七牛的推流或连麦 SDK 的工程中，集成该短视频 SDK 会出现美颜库导致的符号冲突问题 duplicate symbol
_OBJC_CLASS_
MuseProcessor，原因是两个SDK都引入了基础美颜库libMuseProcessor。解决方法是在引入短视频SDK时使用PLShortVideoKit/ex-
libMuseProcessor的subspec，替代PLShortVideoKit，以基础版为例：**
target 'TargetName' do
pod 'PLShortVideoKit/ex-libMuseProcessor', :podspec => 'https://raw.githubusercontent.com/pili-engineering/PLShortVideoKit/master/PLShortVideoKit-Basic.podspec'
end
## 5.4 添加权限说明
我们需要在 Info.plist 文件中添加相应权限的说明，否则程序在 iOS 10 系统上会出现崩溃。需要添加如下权限：
* 麦克风权限：Privacy - Microphone Usage Description 是否允许 App 使用麦克风
* 相机权限： Privacy - Camera Usage Description 是否允许 App 使用相机
* 相册权限： Privacy - Photo Library Usage Description 是否允许 App 访问媒体资料库
# 6 快速开始
## 6.1 视频拍摄
### 6.1.1 创建音视频的采集和编码配置对象
当前使用默认配置，之后可以深入研究按照自己的需求作更改
PLSVideoConfiguration *videoConfiguration = [PLSVideoConfiguration defaultConfiguration];
PLSAudioConfiguration *audioConfiguration = [PLSAudioConfiguration defaultConfiguration];
### 6.1.2 创建拍摄 recorder 对象
self.shortVideoRecorder = [[PLShortVideoRecorder alloc] initWithVideoConfiguration:videoConfiguration audioConfiguration:audioConfiguration];
### 6.1.3 添加摄像头预览视图
将预览视图添加为当前视图的子视图
[self.view addSubview:self.shortVideoRecorder.previewView];
### 6.1.4 开始采集
在开始录制前需要开启采集，开启采集后才能看到摄像头预览
[self.shortVideoRecorder startCaptureSession];
### 6.1.5 设置拍摄时长
设置实际拍摄过程中的最大拍摄时长，最小拍摄时长
// 单位为秒
self.shortVideoRecorder.maxDuration = 60.0f;
self.shortVideoRecorder.minDuration = 2.0f;
### 6.1.6 横屏拍摄
设置是否根据设备的方向自动确定竖屏、横屏拍摄
// 默认为 NO，不启用自动确定
self.shortVideoRecorder.adaptationRecording = YES;
**注意：当 adaptationRecording 为 YES 时，可通过 deviceOrientationBlock 的回调，来获取设备方向**
### 6.1.7 倍速拍摄
设置拍摄的快／慢速率，支持5种拍摄速率
PLSVideoRecoderRateTopSlow、PLSVideoRecoderRateSlow、PLSVideoRecoderRateNormal、PLSVideoRecoderRateFast、PLSVideoRecoderRateTopFast
// 默认为 PLSVideoRecoderRateNormal
self.shortVideoRecorder.recoderRate = PLSVideoRecoderRateNormal;
**注意：录制的原始视频速率为Normal，调用PLSAVAssetExportSession合成后的视频才有倍速效果**
### 6.1.8 背景音乐
设置拍摄时的背景音乐
[self.shortVideoRecorder mixAudio:audioURL];
在退出当前拍摄页面进入下一页面前，需要执行下面的代码段对拍摄的视频进行处理
[self.shortVideoRecorder mixWithMusicVolume:0.3 videoVolume:0.8 completionHandler:^(AVMutableComposition * _Nullable composition, AVAudioMix * _Nullable audioMix, NSError * _Nullable error) {
}];
**注意：需在completionHandler中使用AVAssetExportSession对原视频进行处理，否则无效，[点击此处查看示例代码
__](https://github.com/pili-
engineering/PLShortVideoKit/blob/master/Example/PLShortVideoKitDemo/RecordViewController.m)**
### 6.1.9 视频草稿
加载视频草稿，即拍摄了一段视频保存到了草稿箱，在下次拍摄时，可以从草稿箱读取视频继续拍摄或编辑。
[self.shortVideoRecorder insertVideo:draftVideoURL];
### 6.1.10 截图
在预览时，可以截取预览时的图像。
[self.shortVideoRecorder getScreenShotWithCompletionHandler:^(UIImage * _Nullable image) {
}
### 6.1.11 开始拍摄
* 录制的视频的存放地址由 SDK 内部自动生成
[self.shortVideoRecorder startRecording];
* customFileURL 录制的视频的存放地址，该参数可以在外部设置，录制的视频会保存到该位置
[self.shortVideoRecorder startRecording:customFileURL];
### 6.1.12 停止拍摄
[self.shortVideoRecorder stopRecording];
### 6.1.12 停止采集
[self.shortVideoRecorder stopCaptureSession];
## 6.2 编辑预览
编辑类 `PLShortVideoEditor` 支持渲染音视频、水印、滤镜、背景音乐、MV 特效等功能。
### 6.2.1 视频数据回调
通过 `PLShortVideoEditor` 的 Delegate 回调方法来处理播放时的视频数据，可以动态改变滤镜效果，pixelBuffer 格式为
kCVPixelFormatType_32BGRA
- (CVPixelBufferRef)shortVideoEditor:(PLShortVideoEditor *)editor didGetOriginPixelBuffer:(CVPixelBufferRef)pixelBuffer;
### 6.2.2 水印
可以根据需要添加水印或移除水印，并且能够自由设置水印的大小和位置。
* 添加静态水印
- (void)setWaterMarkWithImage:(UIImage *)waterMarkImage position:(CGPoint)position size:(CGSize)size waterMarkType:(PLSWaterMarkType)type alpha:(CGFloat)alpha rotateDegree:(CGFloat)degree;
* 添加 GIF 水印
- (void)setGifWaterMarkWithData:(NSData *)gifData position:(CGPoint)position size:(CGSize)size alpha:(CGFloat)alpha rotateDegree:(CGFloat)degree;
* 移除水印
- (void)clearWaterMark;
该方法用于移除已添加的水印
### 6.2.3 滤镜
* 添加、移除滤镜。
/**
* @param colorImagePath 当前使用的滤镜的颜色表图的路径
* 当 colorImagePath 为 nil 时，表示移除滤镜。
*/
- (void)addFilter:(NSString *)colorImagePath;
### 6.2.4 背景音乐
* 添加背景音乐
/**
* @param musicURL 当前使用的背景音乐的地址
* @param timeRange 当前使用的背景音乐的有效时间区域(start, duration)。
* 如果想使用整段音乐，可以将其设置为 kCMTimeRangeZero
* 或者 (kCMTimeZero, duration)。
* @param volume 当前使用的背景音乐的音量
*/
- (void)addMusic:(NSURL *)musicURL timeRange:(CMTimeRange)timeRange volume:(NSNumber *)volume;
* 更新背景音乐
/**
* @param timeRange 使用 kCMTimeRangeZero 时，表示不更新背景音乐的播放时间区域
* @param volume 使用 nil 时，表示不更新背景音乐的音量
* 只更新 timeRange 时，[xxxObj updateMusic:timeRange volume:nil]
* 只更新 volume 时，[xxxObj updateMusic:kCMTimeRangeZero volume:volume]
*/
- (void)updateMusic:(CMTimeRange)timeRange volume:(NSNumber *)volume;
### 6.2.5 MV 特效
* 添加、移除 MV 特效。
/**
* @param colorURL 彩色层视频的地址
* @param alphaURL 被彩色层当作透明层的视频的地址
* 目前支持添加一层 MV 图层。当 colorURL = nil 和 alphaURL = nil 时，表示移除 MV 图层。
*/
- (void)addMVLayerWithColor:(NSURL *)colorURL alpha:(NSURL *)alphaURL;
### 6.2.6 时光倒流特效
`PLSReverserEffect` 支持时光倒流特效。
* 初始化 PLSReverserEffect 时光倒流对象
- (instancetype)initWithAsset:(AVAsset *)asset;
* 执行时光倒流
- (void)startReversing;
* 取消时光倒流
- (void)cancelReversing;
* 时光倒流完成的 Block
@property (copy, nonatomic) void(^completionBlock)(NSURL *url);
* 时光倒流失败的 Block
@property (copy, nonatomic) void(^failureBlock)(NSError *error);
* 时光倒流进度的 Block
可在该 Block 中刷新时光倒流进度条 UI。
@property (copy, nonatomic) void(^processingBlock)(float progress);
### 6.2.6 倍速特效
`PLShortVideoAsset` 支持倍速特效。
### 6.2.7 视频旋转
调用编辑类 `PLShortVideoEditor`的如下接口，可在编辑时预览旋转效果
- (PLSPreviewOrientation)rotateVideoLayer;
- (void)resetVideoLayerOrientation;
### 6.2.8 文字特效、视频贴纸、视频涂鸦
`PLSStickerView` 支持文字特效、视频贴纸、视频涂鸦效果。
_注意：涂鸦由于从 v1.11.0 版本起更新了使用方法，需要用户在 App 层自行实现涂鸦绘画的功能，最后将生成的 image 同文字、贴纸特效一样，传入
sdk 配置即可。具体实现，可参考我们 demo 的涂鸦功能实现_
## 6.3 视频合成
`PLSAVAssetExportSession` 支持视频合成功能。
### 6.3.1 初始化视频合成对象
self.exportSession = [[PLSAVAssetExportSession alloc] initWithAsset:asset];
### 6.3.2 设置视频合成参数
所有的合成参数都放在 PLSAVAssetExportSession 的 outputSettings 中，下面将分为五步讲述 outputSettings
的参数设置：
// ============ step 1: 初始化导出参数 ==============
// 总的导出参数字典对象
self.outputSettings = [[NSMutableDictionary alloc] init];
// 原视频参数字典对象
self.movieSettings = [[NSMutableDictionary alloc] init];
// 水印参数数组对象
self.watermarkSettingsArray = [[NSMutableArray alloc] init];
// 贴纸参数数组对象
self.stickerSettingsArray = [[NSMutableArray alloc] init];
// 混音参数数组对象
self.audioSettingsArray = [[NSMutableArray alloc] init];
// 将各个参数应用到总的导出参数中
self.outputSettings[PLSMovieSettingsKey] = self.movieSettings;
self.outputSettings[PLSWatermarkSettingsKey] = self.watermarkSettingsArray;
self.outputSettings[PLSStickerSettingsKey] = self.stickerSettingsArray;
self.outputSettings[PLSAudioSettingsKey] = self.audioSettingsArray;
#### 6.3.2.1 视频基本信息设置
PLSMovieSettingsKey 是视频合成必须要有的参数，里面存放的是原视频的基本信息：
// ============ step 2: 设置视频的基本信息，必须设置 ==============
AVAsset *asset = [AVAsset assetWithURL:url];
self.movieSettings[PLSURLKey] = url;
self.movieSettings[PLSAssetKey] = asset;
// 设置视频的时间段，可以通过 PLSStartTimeKey 和 PLSDurationKey 对视频进行剪切
self.movieSettings[PLSStartTimeKey] = [NSNumber numberWithFloat:0.f];
self.movieSettings[PLSDurationKey] = [NSNumber numberWithFloat:CMTimeGetSeconds(asset.duration)];
// 设置原视频的音量值，比如添加了背景音乐，不再需要原视频音频，可以设置为 0 来去掉原视频音频。有效范围 0 ~ 1
self.movieSettings[PLSVolumeKey] = [NSNumber numberWithFloat:1.0f];
#### 6.3.2.2 水印设置
`PLSAVAssetExportSession`
支持视频合成时添加水印功能，你可以根据自己的需要添加水印或移除水印，并且能够自由设置水印的大小、位置、水印透明度和水印作用的时间段，支持设置多个水印分别作用于不同时间段。
视频合成时水印设置：
// ============ step 3: 设置水印信息，如果不需要水印可以不设置 ==============
// 可以设置多个水印，如果不同水印的作用时间出现了重合，则同一时刻只有一个水印会被显示
int waterwarkCount = n;
for (int i = 0; i < waterwarkCount; i ++) {
NSMutableDictionary *watermarkDic = [[NSMutableDictionary alloc] init];
// 设置水印图片
watermarkDic[PLSURLKey] = [NSURL fileURLWithPath:@"url path"];
// 设置水印的宽高，如果不设置，默认为水印图片的宽高
watermarkDic[PLSSizeKey] = [NSValue valueWithCGSize:CGSizeMake(width, height)];
// 设置水印的左上角位置
watermarkDic[PLSPointKey] = [NSValue valueWithCGPoint:CGPointMake(x, y)];
// 设置水印的开始时间
watermarkDic[PLSStartTimeKey] = [NSNumber numberWithFloat:startTimeInVideo];
// 设置水印的显示时长
watermarkDic[PLSDurationKey] = [NSNumber numberWithFloat:waterMarkShowDuration];
// 设置水印的 alpha，如果不设置，默认为 1
watermarkDic[PLSAlphaKey] = [NSNumber numberWithFloat:watermarkAlpha];
// 设置水印的类型: PLSWaterMarkTypeStatic 对应静态水印，PLSWaterMarkTypeGif 对应 GIF 动态水印
watermarkDic[PLSTypeKey] = [NSNumber numberWithInteger:PLSWaterMarkType];
// 设置水印的旋转角度，如果有角度，会绕着水印中心点旋转
watermarkDic[PLSRotationKey] = [NSNumber numberWithFloat:watermarkRotate];
[self.watermarkSettingsArray addObject:watermarkDic];
}
#### 6.3.2.3 多重音乐
`PLSAVAssetExportSession` 支持视频合成时添加多个音乐做混音，并支持截取音乐中的片段加入到源视频素材中。
视频合成时设置多重混音：
// ============ step 4: 设置多音频混音信息，如果不需要混音处理可以不设置 ==============
// 设置混音的个数
// audioCount = 0 ~ n;
for (int i = 0; i < audioCount; i++) {
NSMutableDictionary *audioDic = [[NSMutableDictionary alloc] init];
// 设置音频的地址
audioDic[PLSURLKey] = [NSURL fileURLWithPath:@"audio path"];
// 设置音频的起始时间和音频的使用时长 PLSStartTimeKey 和 PLSDurationKey 决定音频的使用时间段，即就是对音频进行选取
audioDic[PLSStartTimeKey] = [NSNumber numberWithFloat:audioStartTime];
audioDic[PLSDurationKey] = [NSNumber numberWithFloat:audioDuration];
// 设置音频的音量 0 ~ 1
audioDic[PLSVolumeKey] = [NSNumber numberWithFloat:audioVolume];
// 设置音频在混音中的开始播放时间 和 时长，PLSLocationStartTimeKey 和 PLSLocationDurationKey 一起决定了音频的作用时间段
audioDic[PLSLocationStartTimeKey] = [NSNumber numberWithFloat:locationStartTime];
audioDic[PLSLocationDurationKey] = [NSNumber numberWithFloat:locationDuration];
[self.audioSettingsArray addObject:audioDic];
}
#### 6.3.2.4 设置贴纸
PLSAVAssetExportSession 支持设置多个贴纸，支持静态贴纸和 GIF
动态贴纸，支持设置每个贴纸的作用时间段，下面以代码的形式讲述静态贴纸 和 GIF 动态贴纸的设置方式:
// ============ step 5: 设置贴纸信息，如果不需要贴纸可以不设置 ==============
for (int i = 0; i < [self.timelineView getAllAddedItems].count; i++) {
PLSTimeLineItem *item = [self.timelineView getAllAddedItems][i];
NSMutableDictionary *stickerSettings = [[NSMutableDictionary alloc] init];
PLSStickerView *stickerView = (PLSStickerView *)item.target;
CGAffineTransform transform = stickerView.transform;
CGFloat widthScale = sqrt(transform.a * transform.a + transform.c * transform.c);
CGFloat heightScale = sqrt(transform.b * transform.b + transform.d * transform.d);
CGSize viewSize = CGSizeMake(stickerView.bounds.size.width * widthScale, stickerView.bounds.size.height * heightScale);
CGPoint viewCenter = CGPointMake(stickerView.frame.origin.x + stickerView.frame.size.width / 2, stickerView.frame.origin.y + stickerView.frame.size.height / 2);
CGPoint viewPoint = CGPointMake(viewCenter.x - viewSize.width / 2, viewCenter.y - viewSize.height / 2);
stickerSettings[PLSSizeKey] = [NSValue valueWithCGSize:viewSize];
stickerSettings[PLSPointKey] = [NSValue valueWithCGPoint:viewPoint];
CGFloat rotation = atan2f(transform.b, transform.a);
rotation = rotation * (180 / M_PI);
// 设置贴纸的旋转角度
stickerSettings[PLSRotationKey] = [NSNumber numberWithFloat:rotation];
// 设置贴纸的开始作用时间
stickerSettings[PLSStartTimeKey] = [NSNumber numberWithFloat:item.startTime];
// 设置贴纸的作用时长
stickerSettings[PLSDurationKey] = [NSNumber numberWithFloat:(item.endTime - item.startTime)];
// 设置贴纸预览的时候，预览背景 view 的宽高 和 视频最终导出时的视频宽高，SDK 内部需要这两个参数来计算贴纸在视频中的位置和大小
stickerSettings[PLSVideoPreviewSizeKey] = [NSValue valueWithCGSize:self.stickerOverlayView.frame.size];
stickerSettings[PLSVideoOutputSizeKey] = [NSValue valueWithCGSize:self.videoSize];
if (StickerType_GIFAnimation == stickerView.type) {
// 如果贴纸是 GIF 类型，PLSStickerKey 的 value 必须是下列三种中的某一种:
int type = arc4random() % 3;
if (0 == type) {
// value = GIF URL
stickerSettings[PLSStickerKey] = stickerView.stickerURL;
} else if (1 == type) {
// value = GIF path
stickerSettings[PLSStickerKey] = stickerView.stickerURL.path;
} else if (2 == type) {
// value = GIF data
stickerSettings[PLSStickerKey] = [NSData dataWithContentsOfFile:stickerView.stickerURL.path];
}
} else {
#if 0
// v2.0.0 及之前的版本添加静态贴纸的方式, 传入的是 stickerView。如果传入的是 stickerView，添加了滤镜或者特效，这些效果会作用到贴纸上。如果不希望贴纸被滤镜和特效作用，则需要使用新的添加贴纸的方式
stickerView.hidden = NO;
stickerSettings[PLSStickerKey] = stickerView;
#else
// ===== 新的静态贴纸添加方式，v2.1.0 之后生效，建议所有用户换成新的添加贴纸方式 ======
if (StickerType_Sticker == stickerView.type) {
int type = arc4random() % 4;
if (0 == type) {
// value = image URL
stickerSettings[PLSStickerKey] = stickerView.stickerURL;
} else if (1 == type) {
// value = image path
stickerSettings[PLSStickerKey] = stickerView.stickerURL.path;
} else if (2 == type) {
// value = image data
// 如果贴纸含 alpha 通道，使用 UIImageJPEGRepresentation(stickerView.image, 1) 得到的是没有 alpha 的图片，建议使用 UIImagePNGRepresentation(stickerView.image) 来获取 data
stickerSettings[PLSStickerKey] = UIImagePNGRepresentation(stickerView.image);
} else {
// value = image
stickerSettings[PLSStickerKey] = stickerView.image;
}
} else if (StickerType_SubTitle == stickerView.type) {
// 文字贴纸
stickerView.hidden = NO;
stickerSettings[PLSStickerKey] = [self convertViewToImage:stickerView];
}
#endif
}
[self.stickerSettingsArray addObject:stickerSettings];
}
#### 注意，贴纸在编辑时候的预览是由上层做的，七牛短视频 SDK 并不提供贴纸编辑时候的预览。开发者可以参考七牛短视频
PLShortVideoKitDemo [EditViewController.m __](https://github.com/pili-
engineering/PLShortVideoKit/blob/master/Example/PLShortVideoKitDemo/EditViewController.m)中贴纸编辑预览实现方式
#### 6.3.2.5 设置合成参数
self.exportSession.outputSettings = outputSettings;
### 6.3.3 启动视频合成
[self.exportSession exportAsynchronously];
### 6.3.4 合成回调
通过反馈 `PLSAVAssetExportSession ` 的 Delegate 或 Block 回调来反馈合成的状态。
* 输出合成视频文件的视频数据，用来做滤镜处理
- (CVPixelBufferRef __nonnull)assetExportSession:(PLSAVAssetExportSession *__nonnull)assetExportSession didOutputPixelBuffer:(CVPixelBufferRef __nonnull)pixelBuffer;
* 输出合成视频文件的进度的 Block 回调，progress从 0 到 1
@property (copy, nonatomic) void(^ _Nullable processingBlock)(float progress);
* 合成视频完成的 Block 回调
@property (copy, nonatomic) void(^ _Nullable completionBlock)(NSURL * _Nullable url);
* 合成视频失败的 Block 回调
@property (copy, nonatomic) void(^ _Nullable failureBlock)(NSError* _Nullable error);
## 6.4 视频转码
`PLShortVideoTranscoder` 支持视频本地转码和视频裁剪，减少视频体积。
### 6.4.1 初始化转码对象
self.shortVideoTranscoder = [[PLShortVideoTranscoder alloc] initWithURL:self.url];
* 转码时旋转视频画面，支持正立、左旋、倒立、右旋。
self.shortVideoTranscoder.rotateOrientation = self.rotateOrientation;
### 6.4.2 启动转码
[self.shortVideoTranscoder startTranscoding];
### 6.4.3 取消转码
[self.shortVideoTranscoder cancelTranscoding];
### 6.4.4 转码回调
* 转码完成的 Block 回调
@property (copy, nonatomic) void(^completionBlock)(NSURL *url);
* 转码失败的 Block 回调
@property (copy, nonatomic) void(^failureBlock)(NSError* error);
* 反馈转码进度的 Block
@property (copy, nonatomic) void(^processingBlock)(float progress);
## 6.5 视频帧／图片生成 GIF 动图
从 v1.3.0 开始，`PLSGifComposer` 支持选取视频帧／图片数组生成 GIF 动图。该功能使得 SDK 可以满足自主设计 GIF
的应用场景，需要使用该功能时，通过以下接口
- (instancetype)initWithImagesArray:(NSArray *)imagesArray;
来初始化 `PLSGifComposer` 对象，并为参数 `composerArray` 传入视频帧／图片数组即可。
### 6.5.1 设置 GIF 帧间隔
// Gif 动图每帧间隔设置，默认 0.1f
@property (assign, nonatomic) CGFloat interval;
### 6.5.2 生成 GIF 图
通过以下接口
- (void)composeGif;
### 6.5.3 取消生成 GIF 图
- (void)cancelComposeGif;
来生成 GIF 图，合成结果的回调见 `completionBlock`、`failureBlock`。
### 6.5.4 展示 GIF 图
通过以下接口
- (void)loadGifWithFrame:(CGRect)frame superView:(UIView *)superView repeatCount:(NSInteger)repeatCount;
来展示 GIF 图，传入要展示的 GIF 图的 frame，`superView` 要加载的父视图以及 `repeatCount` 重复次数。
## 6.6 多个视频拼接
从 v1.4.0 开始，`PLSMovieComposer` 支持拼接多个视频为1个视频。
### 6.6.1 初始化视频拼接对象
初始化视频拼接对象的方式有以下2种
self.movieComposer = [[PLSMovieComposer alloc] initWithUrls:self.urls];
self.movieComposer = [[PLSMovieComposer alloc] initWithAssets:self.assets];
设置拼接后的视频的分辨率
self.movieComposer.videoSize = CGSizeMake(480, 854);
### 6.6.2 设置视频拼接的 Block 回调
拼接成功的 Block 回调
[self.movieComposer setCompletionBlock:^(NSURL *url) {
NSLog(@"movieComposer ur: %@", url);
}];
拼接失败的 Block 回调
[self.movieComposer setFailureBlock:^(NSError *error) {
NSLog(@"movieComposer failed");
}];
拼接进度的 Block 回调
[self.movieComposer setProcessingBlock:^(float progress){
NSLog(@"movieComposer progress: %f", progress);
}];
### 6.6.3 启动视频拼接
[self.movieComposer startComposing];
### 6.6.4 停止视频拼接
在拼接视频过程中，若想停止该操作，可调用如下方法
[self.movieComposer stopComposing];
## 6.7 图片合成视频
`PLSImageToMovieComposer ` 支持多张图片合成视频。
## 6.8 多视频合并
`PLSMultiVideoMixer` 支持将多个视频合并为一个视频。支持设置每一个视频的位置、大小、开始播放时间等。
### 6.8.1 初始化多视频合并对象
PLSMultiVideoMixer *multiVideoMixer = [[PLSMultiVideoMixer alloc] init];
multiVideoMixer.videoSize = CGSizeMake{720, 640};
### 6.8.2 添加视频对象
PLSMixMediaItem *mediaItem1 = [[PLSMixMediaItem alloc] init];
mediaItem1.mediaURL = [NSURL fileURLWithPath:@"a video file path"];
mediaItem1.VideoFrame = CGRectMake{0, 0, 360, 640};
PLSMixMediaItem *mediaItem2 = [[PLSMixMediaItem alloc] init];
mediaItem2.mediaURL = [NSURL fileURLWithPath:@"a video file path"];
mediaItem2.VideoFrame = CGRectMake{360, 0, 360, 640};
[multiVideoMixer addMedia:mediaItem1];
[multiVideoMixer addMedia:mediaItem2];
### 6.8.3 视频合并实时效果预览
`PLSMultiVideoMixer` 添加视频对象之后，可以获取 AVPlayerItem 实例，使用 AVPlayer播放预览
AVPlayerItem *playerItem = [multiVideoMixer getPlayerItem];
### 6.8.4 导出合并视频
[multiVideoMixer startExport];
### 6.8.5 导出视频的block回调
导出合并视频成功的 block 回调
[mulitVideoMixer setCompletionBlock:^(NSURL * _Nonnull url) {
}];
导出合并视频失败的 block 回调
[mulitVideoMixer setFailureBlock:^(NSError * _Nonnull error) {
}];
导出合并视频进度的 block 回调
[mulitVideoMixer setProcessingBlock:^(float progress) {
}];
## 6.9 素材视频合拍
`PLSVideoMixRecorder`
支持和一个素材视频合拍为一个视频。相机采集视频和素材视频在合并视频中的位置可以自由定义，支持素材音频和麦克风采集音频混音。该类的接口和
`PLShortVideoRecorder` 的接口很相似，可以参考 `PLShortVideoRecorder` 来使用素材视频合并。
### 6.9.1 创建合拍音视频的采集和编码配置对象
当前使用默认配置，之后可以深入研究按照自己的需求作更改
PLSVideoMixConfiguration *videoConfiguration = [PLSVideoMixConfiguration defaultConfiguration];
PLSAudioMixConfiguration *audioConfiguration = [PLSAudioMixConfiguration defaultConfiguration];
### 6.9.2 创建拍摄 recorder 对象
PLSVideoMixRecorder *videoMixRecorder = [[PLSVideoMixRecorder alloc] initWithVideoConfiguration:videoConfiguration audioConfiguration:audioConfiguration];
videoMixRecorder.mergeVideoURL = [NSURL fileURLWithPath:@"a file path"];
### 6.9.3 添加合拍视频数据预览视图
[self.view addSubview: videoMixRecorder.previewView];
### 6.9.4 打开合拍视频预览
[videoMixRecorder startCaptureSession];
### 6.9.5 开始拍摄
合拍开始后，如果素材视频有音频流，将会进行素材音频的播放。素材音频的播放会影响到麦克风的音频采集，虽然麦克风采集可以选择回音消除，但是效果肯定比不上戴耳机好，建议如果要进行音频合并，带上耳机进行合拍
[videoMixRecorder startRecording];
或者使用
[videoMixRecorder startRecording:customFileURL];
### 6.9.6 停止合拍
[videoMixRecorder stopRecording];
### 6.9.7 停止预览
[self.shortVideoRecorder stopCaptureSession];
## 6.10 视频上传
`PLShortVideoUploader` 支持视频上传到云端，接口灵活。
### 6.10.1 配置上传参数
客户端在上传前，需要先从服务端获取上传凭证，即 token
PLSUploaderConfiguration * uploadConfig = [[PLSUploaderConfiguration alloc] initWithToken:kUploadToken videoKey:key https:YES recorder:nil];
### 6.10.2 创建上传对象
self.shortVideoUploader = [[PLShortVideoUploader alloc] initWithConfiguration:uploadConfig];
### 6.10.3 上传视频
[self.shortVideoUploader uploadVideoFile:filePath];
### 6.10.4 取消上传
[self.shortVideoUploader cancelUploadVidoFile];
### 6.10.5 上传回调
通过 `PLShortVideoUploader` 的 Delegate 回调方法来反馈视频上传的状态。
* 上传进度回调
- (void)shortVideoUploader:(PLShortVideoUploader * _Nonnull)uploader uploadKey:(NSString * _Nullable)uploadKey uploadPercent:(float)uploadPercent;
* 上传结果回调
- (void)shortVideoUploader:(PLShortVideoUploader * _Nonnull)uploader completeInfo:(PLSUploaderResponseInfo * _Nonnull)info uploadKey:(NSString * _Nonnull)uploadKey resp:(NSDictionary * _Nullable)resp;
## 6.11 图片、GIF 图和视频混排
`PLSImageVideoComposer` 支持多个图片、GIF 图和视频进行混排，并支持设置转场动画、图片生成视频时长、添加背景音乐等功能
### 6.11.1 创建混排对象
很多参数都有默认值，这里为了演示，对多数参数进行了自定义值设置
self.imageVideoComposer = [[PLSImageVideoComposer alloc] init];
self.imageVideoComposer.videoFramerate = 30;
self.imageVideoComposer.videoSize = CGSizeMake(544, 960);
self.imageVideoComposer.bitrate = 1500 * 1000;
self.imageVideoComposer.disableTransition = NO;
### 6.11.2 设置混排的图片、GIF 图和视频资源
NSMutableArray *mediaItems = [[NSMutableArray alloc] init];
PLSComposeMediaItem *imageMedia = [[PLSComposeMediaItem alloc] init];
imageMedia.mediaType = PLSMediaTypeAudio;
imageMedia.image = [UIImage imageNamed:@"A Image Name"];
imageMedia.imageDuration = 3.0;
PLSComposeMediaItem *gifMedia = [[PLSComposeMediaItem alloc] init];
gifMedia.mediaType = PLSMediaTypeGIF;
gifMedia.gifImageData = [[NSFileManager defaultManager] contentsAtPath:@"A GIF PATH"];
gifMedia.loopCount = 2;
PLSComposeMediaItem *videoMedia = [[PLSComposeMediaItem alloc] init];
videoMedia.mediaType = PLSMediaTypeVideo;
videoMedia.url = [NSURL fileURLWithPath:@"A Video Path"];
...
[mediaItems addObject: imageMedia];
[mediaItems addObject: gifMedia];
[mediaItems addObject: videoMedia];
self.imageVideoComposer.mediaArrays = mediaItems;
### 6.11.3 设置各个回调 block
[self.imageVideoComposer setProcessingBlock:^(float progress) {
NSLog(@"process = %f", progress);
}];
[self.imageVideoComposer setCompletionBlock:^(NSURL * _Nonnull url) {
NSLog(@"completion");
}];
[self.imageVideoComposer setFailureBlock:^(NSError * _Nonnull error) {
NSLog(@"failure");
}];
### 6.11.4 导出混排的视频
[self.imageVideoComposer startComposing];
启动导出混排视频之后，导出的进度等信息通过上一节设置的 block 返回
### 6.11.5 取消导出混排的视频
[self.imageVideoComposer stopComposing];
# 7 功能使用
当你要深入理解 SDK 的一些参数及有定制化需求时，可以从高级功能部分中查询阅读，以下小节无前后依赖。
## 7.1 音视频采集和编码配置
`PLShortVideoRecorder` 中通过不同的 configuration 设置不同的采集或编码配置信息，对应的有：
* `PLSVideoConfiguration` 视频采集、编码配置
* `PLSAudioConfiguration` 音频采集、编码配置
可以通过如下途径来设置 configuration：
* 在 `PLShortVideoRecorder` init 时传递对应的 configuration
* 在拍摄前、拍摄结束后调用下面的方法重置视频采集、编码配置
`- (void)reloadvideoConfiguration:(PLSVideoConfiguration
*__nonnull)videoConfiguration;`
* 对于视频采集配置，可以直接设置 PLShortVideoRecorder 相关的属性；
需要注意的是，通过 reload 方法重置 configuration 时，需要确保传递的 configuration 与当前 session
已经持有的不是一个对象。
### 7.1.1 视频采集参数
当前的 `PLSVideoConfiguration` 中可自行设定的参数有
* videoFrameRate
* 即 FPS，每一秒所包含的视频帧数
* sessionPreset
* 即采集时的画幅分辨率大小
* previewMirrorFrontFacing
* 是否在使用前置摄像头采集的时候镜像预览画面
* previewMirrorRearFacing
* 是否在使用后置摄像头采集的时候镜像预览画面
* streamMirrorFrontFacing
* 是否在使用前置摄像头采集的时候镜像编码画面
* streamMirrorRearFacing
* 是否在使用后置摄像头采集的时候镜像编码画面
* position
* 开启 PLShortVideoSession 的时候默认使用前置还是后置摄像头
* videoOrientation
* 开启 PLShortVideoSession 的时候默认使用哪个旋转方向
需要注意的是指定分辨率的 `sessionPreset` 例如 `AVCaptureSessionPreset1920x1080`
并非所有机型的所有摄像头均支持，在设置相应的采集分辨率之前请务必保证做过充分的机型适配测试，避免在某些机型使用该机型摄像头不支持的
`sessionPreset`。另外，如果使用只指定采集质量的 `sessionPreset`，例如
`AVCaptureSessionPresetMedium`，那系统会根据当前摄像头的支持情况使用相应质量等级的分辨率进行采集。
### 7.1.2 音频采集参数
当前的 `PLSAudioConfiguration` 中可自行设定的参数有
* numberOfChannels
* 采集时的声道数，默认为 1，并非所有采集设备都支持多声道数据的采集，可以通过检查 [AVAudioSession sharedInstance].maximumInputNumberOfChannels 得到当前采集设备支持的最大声道数。
### 7.1.3 视频编码参数
当前的 `PLSVideoConfiguration` 中可自行设定的参数有
* videoProfileLevel
* H.264 编码时对应的 profile level 影响编码压缩算法的复杂度和编码耗能。设置的越高压缩率越高，算法复杂度越高，相应的可能带来发热量更大的情况。如果对于视频编码有额外的需求并且知晓该参数带来的影响可以自行更改。默认情况下使用 AVVideoProfileLevelH264HighAutoLevel。
* videoSize
* 编码的分辨率，对于采集到的图像，编码前会按照这个分辨率来做拉伸或者裁剪
* expectedSourceVideoFrameRate
* 预期视频的编码帧率，这个数值对编码器的来说并不是直接限定了 fps, 而是给编码器一个预期的视频帧率，最终编码的视频帧率，是由实际输入的数据决定的
* videoMaxKeyframeInterval
* 两个关键帧的帧间隔，一般设置为 FPS 的三倍
* averageVideoBitRate
* 平均的编码码率，设定后编码时的码率并不会是恒定不变，静物较低，动态物体会相应升高
### 7.1.4 音频编码参数
相比于视频繁杂的参数，当前 `PLSAudioConfiguration` 可配置的参数较为简单，目前提供音频码率和编码器的配置，音频编码默认为 AAC-
LC。
各 Quality 的对比：
Quality | Audio BitRate(Kbps)
---|---
QualityHigh1 | 64
QualityHigh2 | 96
QualityHigh3 | 128
### 7.1.5 切换视频配置
为了满足拍摄过程中，拍摄不同分辨率的视频等情况下对码率、FPS 等参数的调节，`PLShortVideoSession` 提供了重置采集、编码参数的方法。
* 在拍摄前、拍摄结束后调用下面的方法来重置 configuration
`- (void)reloadvideoConfiguration:(PLSVideoConfiguration
*__nonnull)videoConfiguration;`
需要注意的是，通过 reload 方法重置 configuration 时，需要确保传递的 configuration 与当前 session
已经持有的不是一个对象。
## 7.2 视频拍摄状态回调
在 `PLShortVideoKit` 中，通过反馈 `PLShortVideoRecorder` 的 Delegate 回调方法来反馈拍摄的状态。
* 获取到摄像头原数据时的回调, 便于开发者做滤镜等处理，需要注意的是这个回调在 camera 数据的输出线程，请不要做过于耗时的操作，否则可能会导致帧率下降
- (CVPixelBufferRef __nonnull)shortVideoRecorder:(PLShortVideoRecorder *__nonnull)recorder cameraSourceDidGetPixelBuffer:(CVPixelBufferRef __nonnull)pixelBuffer;
* 开始录制一段视频时
- (void)shortVideoRecorder:(PLShortVideoRecorder *__nonnull)recorder didStartRecordingToOutputFileAtURL:(NSURL *__nonnull)fileURL;
* 正在录制的过程中。在完成该段视频录制前会一直回调，可用来更新所有视频段加起来的总时长 totalDuration UI。
- (void)shortVideoRecorder:(PLShortVideoRecorder *__nonnull)recorder didRecordingToOutputFileAtURL:(NSURL *__nonnull)fileURL fileDuration:(CGFloat)fileDuration totalDuration:(CGFloat)totalDuration;
* 删除了某一段视频
- (void)shortVideoRecorder:(PLShortVideoRecorder *__nonnull)recorder didDeleteFileAtURL:(NSURL *__nonnull)fileURL fileDuration:(CGFloat)fileDuration totalDuration:(CGFloat)totalDuration;
* 完成一段视频的录制时
- (void)shortVideoRecorder:(PLShortVideoRecorder *__nonnull)recorder didFinishRecordingToOutputFileAtURL:(NSURL *__nonnull)fileURL fileDuration:(CGFloat)fileDuration totalDuration:(CGFloat)totalDuration;
* 在达到指定的视频录制时间 maxDuration 后，如果再调用 `[PLShortVideoRecorder startRecording]`，那么会立即执行该回调。该回调功能是用于页面跳转
- (void)shortVideoRecorder:(PLShortVideoRecorder *__nonnull)recorder didFinishRecordingMaxDuration:(CGFloat)maxDuration;
## 7.3 水印、美颜和内置滤镜
### 7.3.1 水印
`PLShortVideoRecorder` 支持内置水印功能，你可以根据自己的需要添加水印或移除水印，并且能够自由设置水印的大小和位置。
* 拍摄时添加水印
-(void)setWaterMarkWithImage:(UIImage *__nonnull)waterMarkImage position:(CGPoint)position;
该方法将为视频拍摄时添加一个水印，水印的大小由 `waterMarkImage` 的大小决定，位置由 position
决定，需要注意的是这些值都是以采集数据的像素点为单位的。例如我们使用 `AVCaptureSessionPreset1280x720` 进行采集，同时
`wateMarkImage.size` 为 `(100, 100)` 对应的 `origin` 为 `(200, 300)`，那么水印的位置将在大小为
`1280x720` 的采集画幅中位于 `(200, 300)` 的位置，大小为 `(100, 100)`。
* 移除水印
-(void)clearWaterMark;
该方法用于移除已添加的水印
### 7.3.2 美颜
‘PLShortVideoRecorder’ 支持内置美颜功能，你可以根据自己的需要选择开关美颜功能，并且能够自由调节包括美颜，美白，红润等在内的参数。
* 按照默认参数开启或关闭美颜
-(void)setBeautifyModeOn:(BOOL)beautifyModeOn;
* 设置美颜程度，范围为 0 ~ 1
-(void)setBeautify:(CGFloat)beautify;
* 设置美白程度，范围为 0 ~ 1
-(void)setWhiten:(CGFloat)whiten;
* 设置红润程度，范围为 0 ~ 1
-(void)setRedden:(CGFloat)redden;
### 7.3.3 录制时内置滤镜
‘PLShortVideoRecorder’ 支持录制时启用内置滤镜功能，能够自由调节多种滤镜效果。
按照默认参数开启或关闭录制时内置滤镜，选择需要的滤镜效果。
@property (strong, nonatomic) PLSFilter *currentFilter;
@property (assign, nonatomic) NSInteger filterIndex;
## 7.4 外部导入音视频数据
从 v1.2.0 开始，`PLShortVideoRecorder` 支持外部导入音视频数据存成 mp4。该功能使得 SDK 可以满足更多的应用场景，如在
App 的视图和摄像头数据之间切换等。需要使用该功能时，通过以下接口
- (nonnull instancetype)initWithVideoConfiguration:(PLSVideoConfiguration *__nonnull)videoConfiguration
audioConfiguration:(PLSAudioConfiguration *__nonnull)audioConfiguration
captureEnabled:(BOOL)captureEnabled;
来初始化 `PLShortVideoRecorder` 对象，并为参数 `captureEnabled` 传入 NO 即可。
### 7.4.1 导入音频数据
通过以下接口
- (void)writeSampleBuffer:(CMSampleBufferRef _Nonnull)sampleBuffer;
来导入音频数据。注意，如果初始化 `PLShortVideoRecorder` 时参数 `captureEnabled` 为 YES 时，将使用 SDK
内部采集的音频数据，该接口将不起作用。
### 7.4.2 导入视频数据
通过以下接口
- (void)writePixelBuffer:(CVPixelBufferRef _Nonnull)pixelBuffer timeStamp:(CMTime)timeStamp;
来导入视频数据。注意，如果初始化 `PLShortVideoRecorder` 时参数 `captureEnabled` 为 YES 时，将使用 SDK
内部采集的视频数据，该接口将不起作用。另外，导入视频数据的频率应该与 `PLSVideoConfiguration` 中设置帧率一致，否则将出现音画不同步。
### 7.4.3 录制 App 视图
开发者可以通过定时（比如每隔 50ms）给 App 中的 `UIView` 截图，并将其生成 `CVPixelBufferRef`
后通过上述导入视频数据接口导入到 SDK 中存成 mp4 文件，如果上述的 `UIView` 是 `UIApplication` 的
`keyWindow`，其效果便相当于给 App 录屏了。将 `UIView` 截图并生成 `CVPixelBufferRef` 可参考如下方法：
- (CVPixelBufferRef)createCVPixelBufferWithView:(UIView *)view {
UIGraphicsBeginImageContextWithOptions(view.bounds.size, view.opaque, 0.0);
[view drawViewHierarchyInRect:view.bounds afterScreenUpdates:NO];
UIImage *image = UIGraphicsGetImageFromCurrentImageContext();
UIGraphicsEndImageContext();
NSDictionary *options = [NSDictionary dictionaryWithObjectsAndKeys:
[NSNumber numberWithBool:YES], kCVPixelBufferCGImageCompatibilityKey,
[NSNumber numberWithBool:YES], kCVPixelBufferCGBitmapContextCompatibilityKey,
@{}, kCVPixelBufferIOSurfacePropertiesKey,
nil];
CVPixelBufferRef pxbuffer = NULL;
CGFloat frameWidth = CGImageGetWidth([image CGImage]);
CGFloat frameHeight = CGImageGetHeight([image CGImage]);
CVReturn status = CVPixelBufferCreate(kCFAllocatorDefault,
frameWidth,
frameHeight,
kCVPixelFormatType_32BGRA,
(__bridge CFDictionaryRef) options,
&pxbuffer);
if (status != kCVReturnSuccess) {
return NULL;
}
CVPixelBufferLockBaseAddress(pxbuffer, 0);
void *pxdata = CVPixelBufferGetBaseAddress(pxbuffer);
CGColorSpaceRef rgbColorSpace = CGColorSpaceCreateDeviceRGB();
CGContextRef context = CGBitmapContextCreate(pxdata,
frameWidth,
frameHeight,
8,
CVPixelBufferGetBytesPerRow(pxbuffer),
rgbColorSpace,
kCGBitmapByteOrder32Little | kCGImageAlphaPremultipliedFirst);
CGContextConcatCTM(context, CGAffineTransformIdentity);
CGContextDrawImage(context, CGRectMake(0,
0,
frameWidth,
frameHeight),
[image CGImage]);
CGColorSpaceRelease(rgbColorSpace);
CGContextRelease(context);
CVPixelBufferUnlockBaseAddress(pxbuffer, 0);
return pxbuffer;
}
## 7.5 文字动画导出为视频文件
从 1.10.0 开始，`PLSTransitionMaker` 用于将 文字动画 和 图片动画
转换为视频文件。支持文字内容、文字字体、文字位置编辑以及图片动画的编辑，`PLSTextSetting` 为文字编辑对象、`PLSImageSetting`
为图片编辑对象。`PLSPositionTransition`、
`PLSRotateTransition`、`PLSScaleTransition`、`PLSFadeTranstion` 分别为 SDK
提供的四种动画特效：位置特效、旋转特效、缩放特效和隐藏/显示特效，通过四种特效的组合，能满足绝大多数的开发者需求
### 7.5.1 文字对象添加
开发者可以通过
- (NSInteger)addText:(PLSTextSetting *)textSetting;
- (void)updateTextWithResourceID:(NSInteger)resourceID newTextSetting:(PLSTextSetting *)textSetting;
添加文字对象或者更新文字对象，addText 返回添加的文字对象 ID，更新的时候，传入要更新文字对象 ID 和新的文字对象
### 7.5.2 图片对象添加
开发者可以通过
- (NSInteger)addImage:(PLSImageSetting *)imageSetting;
- (void)updateImageWithResourceID:(NSInteger)resourceID newImageSetting:(PLSImageSetting *)imageSetting;
添加图片对象或者更新图片对象，addImage 返回添加的图片对象 ID，更新的时候，传入要更新图片对象 ID 和新的文字对象
### 7.5.3 文字或图片动画添加
开发者可以通过
- (void)addTransition:(PLSTransition *)transition resourceID:(NSInteger)resourceID;
来文字和图片的动画效果
### 7.5.4 动画效果预览
‘PLSTransitionMaker’ 内部根据开发者设置的文字、图片、动画，实时生成视频预览效果，开发者可以通过
- (void)play;
- (void)transitionMakerPreviewEnd:(PLSTransitionMaker *)transitionMaker;
来预览和接收预览结束的回调
### 7.5.5 导出为视频文件
开发者可以通过
- (void)startMaking;
来启动导出视频文件
### 7.5.6 导出视频文件回调
开发者可以通过
- (void)transitionMaker:(PLSTransitionMaker *)transitionMaker exportMediaSucceed:(NSURL *)outURL;
- (void)transitionMaker:(PLSTransitionMaker *)transitionMaker exportMediaFailed:(NSError *)error;
来接收导出视频文件成功和失败的回调
# 8 历史记录
* 3.2.5
* 修复鉴权异常 crash
* 修复 PLShortVideoEditor 添加 bgm，loop 为 no 时 bgm 超过设定 duration 不停止
* 修复 PLSAVAssetExportSession 设置音频码率无效
* 3.2.4
* 更新上传库 Qiniu v8.2.0
* 修复超高清视频色差
* 修复旋转预览显示异常
* 3.2.3
* 修复鉴权偶现 crash 的问题
* 修复同时 pod 导入百度地图 SDK 内置美颜会 crash 的问题
* 3.2.2
* 修复后置切前置第一帧画面镜像的问题
* 修复转码有色差的问题
* 修复横屏拍摄时内存泄漏的问题
* 3.2.1
* 修复一些音轨不正常的视频导出失败的问题
* 修复无法打开闪光灯的问题
* 修复 4k 编辑 crash 的问题
* 支持单独开关音频、视频采集
* 3.2.0
* 修复录制音画不同步问题
* 修复导出时偶现崩溃
* 修正导出视频的方向
* 新增录制时蓝牙耳机的支持
* 新增 11 种视频转场效果
* 新增导出视频时支持设置 gop size
* 升级上传 SDK
* 3.1.1
* 修复 iOS 13.0 下，图片合成视频无转场动画的问题
* 修复某些机型下，导出视频产生内存溢出的问题
* 修复首次更新至 v3.1.0 偶现运行拍摄或编辑发生 crash 的问题
* 修复 PLSImageVideoComposer 设置视频 timeRange 后合成首帧错误的问题
* 新增对拍摄、编辑和转码的 H265 编码支持
* 3.1.0
* 新增可设置 PLSImageVideoComposer 无转场动画
* 新增设置使用 PLSComposeMediaItem 为视频时，可自定义视频的取用范围
* 3.0.0
* 修复合拍分多段录制后，视频声音断断续续的问题
* 修复部分图片和视频混排添加转场动画合成偶现失败的问题
* 修复 PLSImageToMovieComposer 设置转场时间没有效果的问题
* 2.2.0
* 支持合拍分层
* 修复视频编辑添加背景音乐或者多重混音后，不暂停状态下 seek 播放卡死的问题
* 2.1.0
* 支持 GIF 动态贴纸功能
* 支持设置静态贴纸不被滤镜效果渲染
* 优化合拍内存使用量
* 修复 PLSGifComposer 获取视频图片，当获取图片数量是 1 的时候获取失败的问题
* 修复使用 swift 调用 PLSComposeItem，PLSComposeItem init 方法不执行的问题
* 修复视频录制，在启用根据设备方向自动调整横竖屏录制时，横屏模式下录制偶现生成的视频文件是竖屏的问题
* 修复对时长较长的视频进行转码失败的问题
* 2.0.0
* 视频编辑 PLShortVideoEditor 在暂停的时候改变 fillMode，支持即时效果刷新
* 视频拍摄 PLShortVideoRecorder 添加新的相机切换接口，支持设置相机切换完成回调
* 优化视频编辑 PLShortVideoEditor 对 1080P 及以上视频进行编辑, 在 iOS 12 系统上内存占用较大的问题
* 修复视频拍摄 PLShortVideoRecorder 添加背景音乐的时候，自适应横屏拍摄失效的问题
* 修复视频编辑 PLShortVideoEditor 原视频设置为非循环播放，背景音乐仍然循环播放的问题
* 修复视频编辑 PLShortVideoEditor 使用 initWithPlayerItem: 方法初始化 crash 的问题
* 修复视频编辑 PLShortVideoEditor 的 timeRange 设置为 kCMTimeRangeZero 时，设置背景音乐不生效的问题
* 修复视频导出 AVAssetExportSession 不设置 PLSAudioSettingsKey，音量设置无效的问题
* 修复视频导出 AVAssetExportSession 添加 MV 的时候，存在内存泄漏的问题
* 修复视频导出 AVAssetExportSession 完成进度回调可能会从 99% 到 0 的问题
* 1.16.1
* SDK 去掉对 i386 模拟器的支持
* 添加 SDK 授权状态查询接口
* 修复时光倒流特效处理声道数大于 2 的视频导出失败的问题
* 修复视频编辑添加 MV 特效，预览的时候 MV 滞后视频播放 1s 左右问题
* 修复对无音频通道的视频添加 MV 特效，AVAssetExportSession 导出时 crash 的问题
* 修复 AVAssetExportSession 导出视频通道比音频通道时长短的视频时结尾处出现黑帧的问题
* 修复 AVAssetExportSession 添加贴纸起始时间是 0 的时候，第一帧视频没有贴纸效果的问题
* 修复 PLShortVideoRecorder 截帧小概率 crash 的问题
* 1.16.0
* 添加图片、GIF 图和视频混排功能
* 视频导出类 PLSAVAssetExportSession 支持设置导出视频的音频码率和声道数
* 视频切割类 PLSRangeMovieExport 支持设置导出视频的码率、宽高以及视频的填充模式
* 视频录制时音频编码采样率支持 16000Hz
* 多个视频文件拼接增加视频优先（PLSComposerPriorityTypeVideo）和音频优先（PLSComposerPriorityTypeAudio）模式
* 修复视频录制当设置背景音乐起始位置不是 0 的时候，删除已经录制的片段导致背景音乐起始位置变为 0 的问题
* 修复视频录制当设置的录制视频宽高之比和采集视频的宽高之比不相等时，录制视频画面剪裁位置不对的问题
* 修复视频导出类 PLSAVAssetExportSession 导出视频可能会丢失最开始几帧视频的问题
* 修复 1080P 的视频在 iPhone 5 上执行时光倒流失败的问题
* 修复 PLSEditPlayer 播放部分视频结束的时候播放画面黑屏的问题
* 1.15.0
* 支持 GIF 水印
* 支持设置水印作用时间段、水印透明度和水印旋转角度
* 视频录制类 PLShortVideoRecorder 支持 AVCaptureSession 属性
* 视频导出类 PLSAVAssetExportSession 支持设置导出视频帧率
* 优化贴纸显示和隐藏动画时长的问题
* 修复视频导出类 PLSAVAssetExportSession 导出非 16 整数倍分辨率时，生成的视频有黑边的问题
* 修复素材合拍内存泄漏的问题
* 修复 GIF 制作类 PLSGifComposer 在 iOS 10 及以上版本生成的 GIF 图片循环次数始终是 1 次的问题
* 修复视频导出类 PLSAVAssetExportSession 当同时设置视频旋转和添加 MV 时，导出的视频 MV 显示位置错乱的问题
* 1.14.0
* 增加时光倒流特效是否移除音频接口
* 增加设置水印大小接口
* 多个视频拼接，支持音视频同步优先模式和播放流畅优先模式
* 支持 MV 特效选择 MV 素材时间段
* 支持 MV 特效循环添加
* MV 特效支持 MV 素材帧率和被编辑视频帧率不相等的场景
* 优化图片转视频当图片数量过多造成内存溢出的问题
* 优化 1080P 视频时光倒流特效内存溢出的问题
* 修复使用七牛上传 SDK Qiniu v7.2.4 及以上版本导致短视频上传崩溃的问题
* 修复 PLSAVAssetExportSession 的音频参数使用 NSDictionary 崩溃的问题
* 1.13.1
* 优化拍摄页面使用 UIImagePickerController 打开系统相机之后再返回拍摄页面导致预览画面不能铺满屏幕的问题
* 优化首次启动短视频录制出现的已录制视频时长回调顺序不对的问题
* 优化短视频编辑 PLShortVideoEditor 更新背景音乐的 timeRange 之后，首次播放时背景音乐起始部分重复播放的问题
* 修复 Swift 开发环境下调用视频拍摄接口时，实现正在录制中的回调 shortVideoRecorder: didRecordingToOutputFileAtURL: fileDuration: totalDuration: 导致 Crash 的问题
* 1.13.0
* 支持设置视频转码帧率
* 支持视频转码时裁剪视频像素区域
* 优化素材视频合拍音频数据回调格式，由 CMSampleBufferRef 修改为 AudioBufferlist
* 优化图片转视频模块生成的视频时长不精准的问题
* 优化 pod install 或 update PLShortVideoKit 时进度缓慢的问题
* 修复 PLSEditPlayer 在 iOS 9.0 以下无法播放的问题
* 修复 PLSMovieComposer 拼接 16 个以上视频失败的问题
* 修复 SDK 无法处理 5.1 声道的视频的问题
* 修复素材合拍，素材视频没有音频轨道时合拍失败的问题
* 1.11.1
* 优化视频拍摄效果，手动对焦的同时自动调整曝光位置
* 优化对 4K 视频的处理
* 优化短视频录制时 App 从后台回到前台自动开启录制的问题
* 优化 PLSEditPlayer seek 逻辑，能达到帧级别的 seek
* 优化 PLSEditPlayer 频繁添加背景音乐逻辑
* 优化对某些特殊视频进行编辑，首帧解码失败导致播放画面黑屏的问题
* 修复对某些特殊视频进行剪裁崩溃的问题
* 修复从手机系统相册导入视频进行编辑，部分视频方向不正确的问题
* 修复 PLSGLProgram 类名重复的问题
* 修复 PLShortVideoEditor 添加多音效首次预览的时候，播放时间点不对的问题
* 修复素材合拍 App 从后台回到前台无法继续录制的问题
* 修复 PLSAssetExportSession 在没有设置 PLSAudioSettingsKey 时视频剪裁不生效的问题
* 1.11.0
* 支持摄像头与素材视频合拍功能
* 支持多个视频进行任意布局的拼图合并
* 支持对图片、GIF 进行录制
* 支持图片旋转动画录制
* 支持视频录制阶段从指定位置播放背景音乐
* 支持视频编辑阶段按指定时间段预览添加的贴图、文字、涂鸦
* 支持视频编辑阶段添加多个背景音效功能
* 支持视频编辑阶段背景音乐循环播放和仅播放一次
* 支持视频转码自定义码率
* 支持视频转码自定义输出视频地址
* 支持视频导出自定义码率
* 支持视频导出自定义输出视频地址
* 修复视频录制阶段开启横竖屏检测后横屏拍摄出现的首帧画面闪烁的问题
* 修复视频编辑阶段裁剪背景音乐后若背景音乐总时长为0时导致程序出现死循环的问题
* 修复视频编辑阶段裁剪背景音乐后循环播放到第二次时背景音乐停止播放的问题
* 修复视频编辑阶段截取视频再执行倍速效果后视频后半部分没有倍速效果的问题
* 修复少数机型上 GIF 制作失败的问题
* 修复多个视频拼接导出偶现失败的问题
* 修复视频切割导出偶现失败的问题
* 修复 H.265 视频转码之后首帧黑屏的问题
* 1.10.0
* 支持文字动画转换为视频文件
* 支持多个视频同时进行切割编辑
* 对能直接 H.265 硬解码的机型支持导入 H.265 格式视频文件进行转码
* 支持在视频任意位置插入文字转场视频编辑
* 支持 PLSUploaderConfiguration 上传 params 设置
* 支持倍速录制视频时以对应的倍速播放背景音乐
* 优化 PLSEditPlayer 在暂停的时候 seek 时预览画面刷新逻辑
* 修复录制时播放背景音乐，并在录制结束后再次合成背景音乐导致有两重背景音乐声音的问题
* 修复多张图片合成视频时设置图片持续时间导致的最后一张图片没有被合入视频的问题
* 更新人脸贴纸库解决了使用人脸贴纸库后反复进出录制页面导致的崩溃问题
* 1.9.0
* 支持抖音特效
* 支持拍摄时截取图片
* 支持编辑类 PLShortVideoEditor 和视频导出类 PLSAVAssetExportSession 回调出视频的时间戳
* 修复快速开始和停止视频录制导致偶现文件写入报错的问题
* 修复编辑时添加背景音乐导致视频没有从剪切的起始位置处播放的问题
* 修复编辑类 PLShortVideoEditor 的回调不执行的问题
* 修复 1:1 比例的视频添加涂鸦、文字、图片后导出的视频出现倒立的问题
* 修复添加 MV 特效导出视频后原视频和背景音乐的音量大小不生效的问题
* 修复添加 MV 特效后只能固定输出某个视频分辨率的问题。
* 修复同时快速切换摄像头和滤镜偶现的 Crash 问题
* 修复在拒绝麦克风权限情形下添加背景音乐录制视频后进入编辑时 Crash 的问题
* 修复在拒绝相机权限情形下录制结束后进入编辑时 Crash 的问题
* 修复在拒绝相机和麦克风权限情形下视频录制结束后进行视频导出操作没有回调 Error 信息的问题
* 修复倍速拍摄后在编辑时不同倍速视频段衔接处会出现视频帧闪烁的问题
* 1.8.0
* 支持视频拍摄时自定义视频存放地址
* 支持转码时旋转视频
* 支持日志系统
* 修复 MV 特效在某种特定情形下预览不生效的问题
* 优化图片合成视频的效果
* 修复横屏拍摄时前几帧画面偏暗的问题
* 1.7.0
* 支持文字特效
* 支持视频涂鸦
* 支持视频贴纸
* 支持图片合成视频
* 支持视频草稿
* 支持拍摄时录制背景音乐
* 支持编辑时旋转视频
* 支持编辑时使用视频首帧作为滤镜封面图
* 修复编辑时音乐时长小于视频时长时音乐不随视频循环播放的问题
* 1.6.0
* 支持配音功能
* 支持编辑时对视频进行变速处理
* 支持 AR 特效拍摄
* 支持摄像头对焦位置的回调
* 修复横竖屏自动切换的拍摄模式下设备方向检测不精准的问题
* 修复视频拍摄时使用前置 AVCaptureSessionPreset1920x1080 预览黑屏的问题
* 修复频繁切换 1:1 与全屏录制模型出现的预览黑屏问题
* 修复录屏偶现 Crash 的问题
* 修复视频转码偶现 Crash 的问题
* 修复多个视频拼接使用视频拼接模块后生成的视频体积变大的问题
* 修复背景音乐与视频时长相同时导出的视频无声音的问题
* 修复 iPhone 5 设备上将视频转码成 1080P 后快速执行视频导出偶现 Crash 的问题
* 1.5.0
* 支持 MV 特效
* 支持时光倒流特效
* 更新视频文件的存储目录
* 1.4.1
* 修复 iOS 11 系统上添加滤镜导致预览卡住的问题
* 修复拍摄时对焦动画引发的内存泄漏问题
* 更新上传依赖库 Qiniu 去适配 iOS 11 系统
* 1.4.0
* 支持倍速拍摄
* 支持多视频拼接
* 增加取消 GIF 合成接口
* 1.3.0
* 支持横屏拍摄
* 支持合成 GIF 动图
* 修复录制时频繁切换滤镜导致预览卡住的问题
* 修复快速执行开始和停止录制导致的 crash 问题
* 1.2.1
* 修复首次安装后第一次录制无法预览和采集的问题
* 修复被裁减的视频执行静音导出后起始时间内未静音的问题
* 更新滤镜封面图
* 1.2.0
* 支持录屏
* 支持手动对焦动画
* 修复偶现视频合成失败问题
* 修复剪辑的视频导出后时长少零点几秒的问题
* 1.1.1
* 支持视频转码修正视频方向
* 修复无音频轨视频合成失败问题
* 1.1.0
* 支持视频转码
* 支持断点续传
* 支持裁剪背景音乐
* 1.0.4
* 支持录制时启用内置滤镜
* 优化 mp4 文件大小
* 支持视频上传到云端
* 1.0.3
* 支持背景音乐
* 1.0.2
* 选取相册中的单个视频并编辑
* 优化 1:1 录制，捕捉摄像头的中心画面
* 1.0.1
* 优化水印效果
* 修复音频采集回调中的数据类型
* 修复 iOS 8.1 上拍摄视频时预览视图卡住的问题
* 1.0.0
* 支持 H.264、AAC 硬编码
* 支持断点拍摄
* 支持回删视频
* 支持视频水印
* 内置实时美颜
* 内置几十种专业级滤镜
* 支持第三方美颜和滤镜
* 支持自定义录制时长
* 支持分辨率码率配置
* 支持 1:1 录制
# 9 FAQ
### 9.1 SDK 是否收费，哪里可以下载 ？
本短视频 SDK 需授权方可使用，可通过 400-808-9176 转 2 号线联系七牛商务咨询，或者 [通过工单
__](https://support.qiniu.com/?ref=developer.qiniu.com)联系七牛的技术支持。
### 9.2 我可以体验下 demo 吗 ？
可以，请到 App Store 搜索：`PLShortVideo`
### 9.3 是否支持人脸特效、动态贴纸等 ？
支持，该功能属于高级收费功能，需要联系商务获取资源
### 9.4 是否支持抖音特效？
支持，该功能属于高级收费功能，需要联系商务获取 appkey 和资源文件。具体使用可参看 [demo
__](https://github.com/pili-engineering/PLShortVideoKit)
### 9.5 是否支持视频播放 ？
生成和上传的 mp4 文件，可以用系统的播放器播放，如果需要更高级的播放功能，推荐使用七牛的 [PLPlayerKit
__](https://github.com/pili-engineering/PLPlayerKit)播放 SDK
### 9.6 导出的视频支持哪些格式 ？
支持 mp4 和 mov 格式。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,696 |
服务端 API | 直播云 | [直播云](https://developer.qiniu.com/pili) > SDK 下载 > 短视频 >服务端 API
# 服务端 API
最近更新时间: 2017-07-26 10:54:01
## 1、短视频落存储
* 产品手册：<https://developer.qiniu.com/kodo/manual/1277/product-introduction>
* API Reference：<https://developer.qiniu.com/kodo/api/1731/api-overview>
* 服务端 SDK 下载：<https://developer.qiniu.com/kodo/sdk/1239/java>
## 2、短视频数据处理
* 产品手册：<https://developer.qiniu.com/dora/manual/3674/kodo-product-introduction>
* 音视频数据处理：<https://developer.qiniu.com/dora/manual/3685/directions-for-use-av>
* 鉴黄鉴恐：<https://developer.qiniu.com/dora/manual/1295/image-as-a-yellow-services-stage>
## 3、短视频融合 CDN
* 产品文档：<https://developer.qiniu.com/fusion/manual/3824/product-overview-fusion>
* API Reference：<https://developer.qiniu.com/fusion/api/1230/traffic-bandwidth>
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > SDK 下载 > 短视频 >服务端 API
# 服务端 API
最近更新时间: 2017-07-26 10:54:01
## 1、短视频落存储
* 产品手册：<https://developer.qiniu.com/kodo/manual/1277/product-introduction>
* API Reference：<https://developer.qiniu.com/kodo/api/1731/api-overview>
* 服务端 SDK 下载：<https://developer.qiniu.com/kodo/sdk/1239/java>
## 2、短视频数据处理
* 产品手册：<https://developer.qiniu.com/dora/manual/3674/kodo-product-introduction>
* 音视频数据处理：<https://developer.qiniu.com/dora/manual/3685/directions-for-use-av>
* 鉴黄鉴恐：<https://developer.qiniu.com/dora/manual/1295/image-as-a-yellow-services-stage>
## 3、短视频融合 CDN
* 产品文档：<https://developer.qiniu.com/fusion/manual/3824/product-overview-fusion>
* API Reference：<https://developer.qiniu.com/fusion/api/1230/traffic-bandwidth>
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,763 |
OBS如何推不含B帧的直播流 | 直播云 | [直播云](https://developer.qiniu.com/pili) > 最佳实践 > OBS如何推不含B帧的直播流
# OBS如何推不含B帧的直播流
最近更新时间: 2021-10-29 14:46:56
# 关于B帧
低延时直播对编码有一定限制，要求直播流中不包含 B 帧，用户可以通过调整推流端软件（如 OBS）的视频编码参数来去除 B
帧。本文介绍如何设置OBS，来实现推不含B帧的直播流
# OBS推不含B帧的直播流
第一步：进入OBS页面，点击设置，进入OBS设置页面
第二步：进入输出设置，输出模式选择高级，根据下图配置OBS的输出配置
第三步：进入推流设置，服务选择自定义，将七牛云的推流地址复制粘贴到服务器和串流密钥上，点击确定
第四步：点击开始推流，即可推不含B帧的直播流到七牛云直播服务上。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > 最佳实践 > OBS如何推不含B帧的直播流
# OBS如何推不含B帧的直播流
最近更新时间: 2021-10-29 14:46:56
# 关于B帧
低延时直播对编码有一定限制，要求直播流中不包含 B 帧，用户可以通过调整推流端软件（如 OBS）的视频编码参数来去除 B
帧。本文介绍如何设置OBS，来实现推不含B帧的直播流
# OBS推不含B帧的直播流
第一步：进入OBS页面，点击设置，进入OBS设置页面
第二步：进入输出设置，输出模式选择高级，根据下图配置OBS的输出配置
第三步：进入推流设置，服务选择自定义，将七牛云的推流地址复制粘贴到服务器和串流密钥上，点击确定
第四步：点击开始推流，即可推不含B帧的直播流到七牛云直播服务上。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,765 |
直播录制国家相关规定 | 直播云 | [直播云](https://developer.qiniu.com/pili) > 服务协议 > 直播录制国家相关规定
# 直播录制国家相关规定
最近更新时间: 2021-11-26 14:53:19
# 依据《网络表演经营活动管理办法》规定
第十三条
网络表演经营单位应当建立内部巡查监督管理制度，对网络表演进行实时监管。网络表演经营单位应当记录全部网络表演视频资料并妥善保存，**资料保存时间不得少于60日**
，并在有关部门依法查询时予以提供。
网络表演经营单位向公众提供的非实时的网络表演音视频（包括用户上传的），应当严格实行先自审后上线。
法律法规详细信息查看：[文化部关于印发《网络表演经营活动管理办法》的通知（国务院公报2017年第21号）
__](http://www.gov.cn/gongbao/content/2017/content_5213209.htm)
# 依据《网络交易监督管理办法》规定
第二十条
通过网络社交、网络直播等网络服务开展网络交易活动的网络交易经营者，应当以显著方式展示商品或者服务及其实际经营主体、售后服务等信息，或者上述信息的链接标识。
**网络直播服务提供者对网络交易活动的直播视频保存时间自直播结束之日起不少于三年** 。
法律法规详细信息查看：[《网络交易监督管理办法》（2021年3月15日国家市场监督管理总局令第37号公布）
__](http://gkml.samr.gov.cn/nsjg/fgs/202103/t20210315_326936.html)
依据上诉办法规定，在七牛云使用直播服务时，直播录制至少保存 60 天，电商直播客户存储周期必须选择保存 1095 天（3年）
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > 服务协议 > 直播录制国家相关规定
# 直播录制国家相关规定
最近更新时间: 2021-11-26 14:53:19
# 依据《网络表演经营活动管理办法》规定
第十三条
网络表演经营单位应当建立内部巡查监督管理制度，对网络表演进行实时监管。网络表演经营单位应当记录全部网络表演视频资料并妥善保存，**资料保存时间不得少于60日**
，并在有关部门依法查询时予以提供。
网络表演经营单位向公众提供的非实时的网络表演音视频（包括用户上传的），应当严格实行先自审后上线。
法律法规详细信息查看：[文化部关于印发《网络表演经营活动管理办法》的通知（国务院公报2017年第21号）
__](http://www.gov.cn/gongbao/content/2017/content_5213209.htm)
# 依据《网络交易监督管理办法》规定
第二十条
通过网络社交、网络直播等网络服务开展网络交易活动的网络交易经营者，应当以显著方式展示商品或者服务及其实际经营主体、售后服务等信息，或者上述信息的链接标识。
**网络直播服务提供者对网络交易活动的直播视频保存时间自直播结束之日起不少于三年** 。
法律法规详细信息查看：[《网络交易监督管理办法》（2021年3月15日国家市场监督管理总局令第37号公布）
__](http://gkml.samr.gov.cn/nsjg/fgs/202103/t20210315_326936.html)
依据上诉办法规定，在七牛云使用直播服务时，直播录制至少保存 60 天，电商直播客户存储周期必须选择保存 1095 天（3年）
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,767 |
关于直播推流鉴权SignStr | 直播云 | [直播云](https://developer.qiniu.com/pili) > 术语表 > 关于直播推流鉴权SignStr
# 关于直播推流鉴权SignStr
最近更新时间: 2021-10-29 15:35:44
# 直播推流鉴权SignStr
**SignStr** 是直播推流鉴权使用的被编码签名的原始字符串， 用来生成鉴权的Token，推流使用到**SignStr**
的鉴权有[限时鉴权](https://developer.qiniu.com/pili/api/6678/push-the-current-
authentication), [限时鉴权sk](https://developer.qiniu.com/pili/api/6678/push-the-
current-authentication),
[动态鉴权](https://developer.qiniu.com/pili/api/6678/push-the-current-
authentication)。
* SignStr - 通常取推流地址的path加上SignQuery
* SignQuery - 是推流地址query参数token之前的query参数
示例：
推流地址为： rtmp://<RTMPPublishDomain>/<Hub>/<streamTitle>?e=<ExpireAt>&token=<Token>
<SignQuery> = "?e=<ExpireAt>"
<SignStr> = "/<Hub>/<streamTitle>?e=<ExpireAt>"
推流地址为: rtmp://<IP>/Hub/<streamTitle>?e=<ExpireAt>&domain=<RTMPPublishDOmain>&token=<Token>
<SignQuery> = "?e=<ExpireAt>&domain=<RTMPPublishDOmain>"
<SignStr> = "/Hub/<streamTitle>?e=<ExpireAt>&domain=<RTMPPublishDOmain>"
推流地址为: rtmp://<IP>/Hub/<streamTitle>?e=<ExpireAt>&token=<Token>&domain=<RTMPPublishDOmain>
<SignQuery> = "?e=<ExpireAt>"
<SignStr> = "/Hub/<streamTitle>?e=<ExpireAt>"
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[直播云](https://developer.qiniu.com/pili) > 术语表 > 关于直播推流鉴权SignStr
# 关于直播推流鉴权SignStr
最近更新时间: 2021-10-29 15:35:44
# 直播推流鉴权SignStr
**SignStr** 是直播推流鉴权使用的被编码签名的原始字符串， 用来生成鉴权的Token，推流使用到**SignStr**
的鉴权有[限时鉴权](https://developer.qiniu.com/pili/api/6678/push-the-current-
authentication), [限时鉴权sk](https://developer.qiniu.com/pili/api/6678/push-the-
current-authentication),
[动态鉴权](https://developer.qiniu.com/pili/api/6678/push-the-current-
authentication)。
* SignStr - 通常取推流地址的path加上SignQuery
* SignQuery - 是推流地址query参数token之前的query参数
示例：
推流地址为： rtmp://<RTMPPublishDomain>/<Hub>/<streamTitle>?e=<ExpireAt>&token=<Token>
<SignQuery> = "?e=<ExpireAt>"
<SignStr> = "/<Hub>/<streamTitle>?e=<ExpireAt>"
推流地址为: rtmp://<IP>/Hub/<streamTitle>?e=<ExpireAt>&domain=<RTMPPublishDOmain>&token=<Token>
<SignQuery> = "?e=<ExpireAt>&domain=<RTMPPublishDOmain>"
<SignStr> = "/Hub/<streamTitle>?e=<ExpireAt>&domain=<RTMPPublishDOmain>"
推流地址为: rtmp://<IP>/Hub/<streamTitle>?e=<ExpireAt>&token=<Token>&domain=<RTMPPublishDOmain>
<SignQuery> = "?e=<ExpireAt>"
<SignStr> = "/Hub/<streamTitle>?e=<ExpireAt>"
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,769 |
实时音视频 | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > 产品简介 > 产品概述
# 产品概述
最近更新时间: 2024-06-21 10:32:36
七牛实时音视频(QRTC)，是基于七牛在直播产品上的积累，结合连麦
SDK、自研实时互动流媒体网络，以及强大的云端能力，为客户提供跨平台、高品质的一站式实时互动直播解决方案。基于七牛云
QRTC，零基础搭建音视频平台，快速支持一对一视频通话、多人会议、连麦直播、语音互动等多种业务场景。
> 目前，QRTC 有新旧两套版本并行：
>
> * 新版本：4.x 及之后的版本
> * 旧版本：3.x 及之前的版本
>
其中，新版本是基于旧版本进行了接口重构的版本，新版本接口结构更清晰，接入更简单。若无特殊需求，我们建议您使用新版本 SDK 进行接入，对于正在使用旧版
SDK 的开发者，可以参考各端的迁移指南，进行版本迁移。 当前文档站为
[新版本的开发文档](https://developer.qiniu.com/rtc/8802/pd-
overview)。本文将为您提供目录索引，以便您能更好更快的了解实时音视频产品的接入方式。 若有需要，您仍可查看 [3.x
及之前版本的开发文档](https://doc.qnsdk.com/rtn) 注意：5.x 版本是基于 4.x 版本开发的重构版本，SDK 使用了统一的
C++ RTC 内核, 保证了 QRTC 在各个端上处理逻辑的一致性，同时接口和 4.x 完全兼容。若您使用的是 4.x 的版本，可直接进行升级；若您使用的
3.x 及之前的版本，可参考各端的迁移指南，进行版本迁移。
# 从 3.x 向 4.x 版本迁移
[Android 迁移指南](https://developer.qiniu.com/rtc/9394/migration-guide-android) | [iOS 迁移指南](https://developer.qiniu.com/rtc/9538/migration-guide-iOS) | [Web 迁移指南](https://developer.qiniu.com/rtc/9531/migration-guide-web) | [Windows 迁移指南](https://developer.qiniu.com/rtc/9605/migration-guide-window) | [WXApp 迁移指南](https://developer.qiniu.com/rtc/11145/migration-guide-wxapp)
---|---|---|---|---
# 产品说明
产品简介 | 产品动态 | 购买指南
---|---|---
[产品概述](https://developer.qiniu.com/rtc/8802/pd-overview) | [Android 更新日志](https://developer.qiniu.io/rtc/9399/update-log-android) | [价格说明](https://developer.qiniu.com/rtc/8804/pd-price)
[接入流程](https://developer.qiniu.com/rtc/10155/process) | [iOS 更新日志](https://developer.qiniu.io/rtc/9672/update-log-iOS) |
[核心功能](https://developer.qiniu.com/rtc/8803/pd-function) | [Web 更新日志](https://developer.qiniu.io/rtc/9677/update-log-for-web) |
[应用场景](https://developer.qiniu.com/rtc/10077/app-scenarios) | [Windows 更新日志](https://developer.qiniu.io/rtc/9673/update-log-windows) |
| [WXapp 更新日志](https://developer.qiniu.com/rtc/11151/update-log-for-wxapp) |
| [Uniapp 更新日志](https://developer.qiniu.com/rtc/11850/update-log-for-uniapp) |
| [Linux 更新日志](https://developer.qiniu.com/rtc/11852/linux-update-the-solstice) |
# 快速入门
控制台 | Android | iOS | Web | Windows | WXApp | Uniapp | Linux
---|---|---|---|---|---|---|---
[控制台说明](https://developer.qiniu.com/rtc/10069/the-console-shows) | [SDK 概览](https://developer.qiniu.com/rtc/8764/an-overview-of-the-android-sdk) | [SDK 概览](https://developer.qiniu.com/rtc/8830/an-overview-of-the-ios-sdk) | [SDK 概览](https://developer.qiniu.com/rtc/9478/an-overview-of-the-web-sd) | [SDK 概览](https://developer.qiniu.com/rtc/9536/windows-overview-of-the-sdk) | [SDK 概览](https://developer.qiniu.com/rtc/11118/an-overview-of-the-wxapp-sd) | [SDK 概览](https://developer.qiniu.com/rtc/11847/an-overview-of-the-uniapp-sdk) | [SDK 概览](https://developer.qiniu.com/rtc/11364/sdk-overview-linux)
[管理实时音视频](https://developer.qiniu.com/rtc/9858/applist) | [开发准备](https://developer.qiniu.com/rtc/8765/prepare-android-development) | [开发准备](https://developer.qiniu.com/rtc/8831/prepare-ios-development) | [开发准备](https://developer.qiniu.com/rtc/9476/prepare-web-development) | [开发准备](https://developer.qiniu.com/rtc/9537/windows-preparation) | [开发准备](https://developer.qiniu.com/rtc/11119/prepare-wxapp-development) | [开发准备](https://developer.qiniu.com/rtc/11848/prepare-uniapp-development) | [开发准备](https://developer.qiniu.com/rtc/11365/preparation-linux)
| [快速开始](https://developer.qiniu.com/rtc/8766/quick-start-android) | [快速开始](https://developer.qiniu.com/rtc/9255/quick-start-iOS) | [快速开始](https://developer.qiniu.com/rtc/9477/quick-start-websit) | [快速开始](https://developer.qiniu.com/rtc/9543/windows-rtc-quick-start) | [快速开始](https://developer.qiniu.com/rtc/11120/quick-start-wxapp) | [快速开始](https://developer.qiniu.com/rtc/11849/quick-start-uniapp) | [快速开始](https://developer.qiniu.com/rtc/11366/quick-start-linux)
| | | [浏览器兼容性说明](https://developer.qiniu.com/rtc/10493/browser-support) | | |
# 使用指南
Android | iOS | Web | Windows | 服务端 | WXApp | Uniapp | Linux
---|---|---|---|---|---|---|---
[初始化](https://developer.qiniu.com/rtc/8727/initialization-android) | [初始化](https://developer.qiniu.com/rtc/9257/user-guidance-iOS) | [初始化](https://developer.qiniu.com/rtc/9386/user-guidance-web) | [初始化](https://developer.qiniu.com/rtc/9545/user-guidance-windows) | [服务端说明](https://developer.qiniu.com/rtc/8805/server-overview) | [初始化](https://developer.qiniu.com/rtc/11146/user-guidance-wxapp) | [初始化](https://developer.qiniu.com/rtc/11837/initialization-uniapp) | [初始化](https://developer.qiniu.com/rtc/11368/initialization-linux)
[音视频采集](https://developer.qiniu.com/rtc/8767/audio-and-video-collection-android) | [音视频采集](https://developer.qiniu.com/rtc/9258/audio-and-video-collection-iOS) | [音视频采集](https://developer.qiniu.com/rtc/9387/audio-and-video-collection-web) | [音视频采集](https://developer.qiniu.com/rtc/9546/audio-and-video-collection-windows) | [服务端 SDK](https://developer.qiniu.com/rtc/8812/serversdk) | [房间管理](https://developer.qiniu.com/rtc/11147/room-management-wxapp) | [音视频采集](https://developer.qiniu.com/rtc/11838/audio-and-video-collection-uniapp) | [音视频采集](https://developer.qiniu.com/rtc/11371/media-capture-linux)
[房间管理](https://developer.qiniu.com/rtc/8768/room-management-android) | [房间管理](https://developer.qiniu.com/rtc/9261/room-management-iOS) | [房间管理](https://developer.qiniu.com/rtc/9465/room-management-web) | [房间管理](https://developer.qiniu.com/rtc/9547/room-management-windows) | [roomToken](https://developer.qiniu.com/rtc/8813/roomToken) | [发布和订阅](https://developer.qiniu.com/rtc/11148/publish-and-subscribe-wxapp) | [房间管理](https://developer.qiniu.com/rtc/11841/room-management-uniapp) | [房间管理](https://developer.qiniu.com/rtc/11373/room-management-linux)
[发布和订阅](https://developer.qiniu.com/rtc/8769/publish-and-subscribe-android) | [发布和订阅](https://developer.qiniu.com/rtc/9260/publish-and-subscribe-iOS) | [发布和订阅](https://developer.qiniu.com/rtc/9467/publish-and-subscribe-website) | [发布和订阅](https://developer.qiniu.com/rtc/9548/publish-and-subscribe-windows) | [应用管理](https://developer.qiniu.com/rtc/8814/api-app) | [CDN 转推](https://developer.qiniu.com/rtc/11149/turn-the-cdn-push-wxapp) | [发布和订阅](https://developer.qiniu.com/rtc/11843/publish-and-subscribe-uniapp) | [发布和订阅](https://developer.qiniu.com/rtc/11372/publish-subscribe-linux)
[CDN 转推](https://developer.qiniu.com/rtc/8770/turn-the-cdn-push-android) | [CDN 转推](https://developer.qiniu.com/rtc/9262/turn-the-cdn-push-iOS) | [CDN 转推](https://developer.qiniu.com/rtc/9468/turn-the-cdn-push-web) | [CDN 转推](https://developer.qiniu.com/rtc/9549/turn-the-cdn-push-windows) | [房间管理](https://developer.qiniu.com/rtc/8815/api-room) | [错误码](https://developer.qiniu.com/rtc/11150/error_code_wxapp) | [CDN 转推](https://developer.qiniu.com/rtc/11842/turn-the-cdn-push-uniapp) | [CDN 转推](https://developer.qiniu.com/rtc/11374/solution-streaming-linux)
[背景音乐混音](https://developer.qiniu.com/rtc/8771/background-music-mix-android) | [背景音乐混音](https://developer.qiniu.com/rtc/9256/%E8%83%8C%E6%99%AF%E9%9F%B3%E4%B9%90%E6%B7%B7%E9%9F%B3%20-%20iOS) | [背景音乐混音](https://developer.qiniu.com/rtc/9470/background-music-mix-web) | [背景音乐混音](https://developer.qiniu.com/rtc/development_guidelines/11177/background-music-mix-windows) | [RTC-Pub](https://developer.qiniu.com/rtc/8816/RTC-Pub) | | [视频大小流](https://developer.qiniu.com/rtc/11844/video-size-flow-uniapp) | [视频大小流](https://developer.qiniu.com/rtc/11370/multi-stream-linux)
[多音效混音](https://developer.qiniu.com/rtc/11965/android_audio_effect_mixing) | [多音效混音](https://developer.qiniu.com/rtc/11979/iOS-audio-effect-mixer) | [视频大小流（旧版）](https://developer.qiniu.com/rtc/9472/video-size-flow-web) | [视频大小流](https://developer.qiniu.com/rtc/9550/video-size-flow-windows) | [合流转推](https://developer.qiniu.com/rtc/8817/api-mergePublish) | | [通话质量统计](https://developer.qiniu.com/rtc/11845/quality-statistics-uniapp) | [通话质量统计](https://developer.qiniu.com/rtc/11375/statistics-linux)
[视频大小流](https://developer.qiniu.com/rtc/8772/video-size-flow-android) | [视频大小流](https://developer.qiniu.com/rtc/9259/multi-stream-iOS) | [通话质量统计](https://developer.qiniu.com/rtc/10233/web-call-quality-statistics) | [通话质量统计](https://developer.qiniu.com/rtc/development_guidelines/11178/call-quality-statistics-windows) | [旁路直播](https://developer.qiniu.com/rtc/8818/api-rtmp) | | | [错误码](https://developer.qiniu.com/rtc/11369/error-code-linux)
[通话质量统计](https://developer.qiniu.com/rtc/9860/quality-statistics-android) | [通话质量统计](https://developer.qiniu.com/rtc/10085/quality-statistics-iOS) | [错误码](https://developer.qiniu.com/rtc/10483/web-error-code) | [错误码](https://developer.qiniu.com/rtc/11350/error-code-windows) | [录制存储](https://developer.qiniu.com/rtc/8819/api-record) | |
[错误码](https://developer.qiniu.com/rtc/9904/rtc-error-code-android) | [错误码](https://developer.qiniu.com/rtc/10084/rtc-error-code-iOS) | [设备管理](https://developer.qiniu.com/rtc/10720/device_management) | | | | |
| | [屏幕共享](https://developer.qiniu.com/rtc/10785/web-screen-sharing) | | | | |
| | [跨房媒体转发](https://developer.qiniu.com/rtc/11359/media-relay-web) | | | | |
| | [视频大小流（新版）](https://developer.qiniu.com/rtc/10566/video-size-flow-web-new) | | | | |
| | [最佳实践](https://developer.qiniu.com/rtc/10266/we-best-practices) | | | | |
| | [浏览器兼容性检测](https://developer.qiniu.com/rtc/10232/check-system-requirements) | | | | |
| | [Electron 环境下使用](https://developer.qiniu.com/rtc/11182/electron) | | | | |
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > 产品简介 > 产品概述
# 产品概述
最近更新时间: 2024-06-21 10:32:36
七牛实时音视频(QRTC)，是基于七牛在直播产品上的积累，结合连麦
SDK、自研实时互动流媒体网络，以及强大的云端能力，为客户提供跨平台、高品质的一站式实时互动直播解决方案。基于七牛云
QRTC，零基础搭建音视频平台，快速支持一对一视频通话、多人会议、连麦直播、语音互动等多种业务场景。
> 目前，QRTC 有新旧两套版本并行：
>
> * 新版本：4.x 及之后的版本
> * 旧版本：3.x 及之前的版本
>
其中，新版本是基于旧版本进行了接口重构的版本，新版本接口结构更清晰，接入更简单。若无特殊需求，我们建议您使用新版本 SDK 进行接入，对于正在使用旧版
SDK 的开发者，可以参考各端的迁移指南，进行版本迁移。 当前文档站为
[新版本的开发文档](https://developer.qiniu.com/rtc/8802/pd-
overview)。本文将为您提供目录索引，以便您能更好更快的了解实时音视频产品的接入方式。 若有需要，您仍可查看 [3.x
及之前版本的开发文档](https://doc.qnsdk.com/rtn) 注意：5.x 版本是基于 4.x 版本开发的重构版本，SDK 使用了统一的
C++ RTC 内核, 保证了 QRTC 在各个端上处理逻辑的一致性，同时接口和 4.x 完全兼容。若您使用的是 4.x 的版本，可直接进行升级；若您使用的
3.x 及之前的版本，可参考各端的迁移指南，进行版本迁移。
# 从 3.x 向 4.x 版本迁移
[Android 迁移指南](https://developer.qiniu.com/rtc/9394/migration-guide-android) | [iOS 迁移指南](https://developer.qiniu.com/rtc/9538/migration-guide-iOS) | [Web 迁移指南](https://developer.qiniu.com/rtc/9531/migration-guide-web) | [Windows 迁移指南](https://developer.qiniu.com/rtc/9605/migration-guide-window) | [WXApp 迁移指南](https://developer.qiniu.com/rtc/11145/migration-guide-wxapp)
---|---|---|---|---
# 产品说明
产品简介 | 产品动态 | 购买指南
---|---|---
[产品概述](https://developer.qiniu.com/rtc/8802/pd-overview) | [Android 更新日志](https://developer.qiniu.io/rtc/9399/update-log-android) | [价格说明](https://developer.qiniu.com/rtc/8804/pd-price)
[接入流程](https://developer.qiniu.com/rtc/10155/process) | [iOS 更新日志](https://developer.qiniu.io/rtc/9672/update-log-iOS) |
[核心功能](https://developer.qiniu.com/rtc/8803/pd-function) | [Web 更新日志](https://developer.qiniu.io/rtc/9677/update-log-for-web) |
[应用场景](https://developer.qiniu.com/rtc/10077/app-scenarios) | [Windows 更新日志](https://developer.qiniu.io/rtc/9673/update-log-windows) |
| [WXapp 更新日志](https://developer.qiniu.com/rtc/11151/update-log-for-wxapp) |
| [Uniapp 更新日志](https://developer.qiniu.com/rtc/11850/update-log-for-uniapp) |
| [Linux 更新日志](https://developer.qiniu.com/rtc/11852/linux-update-the-solstice) |
# 快速入门
控制台 | Android | iOS | Web | Windows | WXApp | Uniapp | Linux
---|---|---|---|---|---|---|---
[控制台说明](https://developer.qiniu.com/rtc/10069/the-console-shows) | [SDK 概览](https://developer.qiniu.com/rtc/8764/an-overview-of-the-android-sdk) | [SDK 概览](https://developer.qiniu.com/rtc/8830/an-overview-of-the-ios-sdk) | [SDK 概览](https://developer.qiniu.com/rtc/9478/an-overview-of-the-web-sd) | [SDK 概览](https://developer.qiniu.com/rtc/9536/windows-overview-of-the-sdk) | [SDK 概览](https://developer.qiniu.com/rtc/11118/an-overview-of-the-wxapp-sd) | [SDK 概览](https://developer.qiniu.com/rtc/11847/an-overview-of-the-uniapp-sdk) | [SDK 概览](https://developer.qiniu.com/rtc/11364/sdk-overview-linux)
[管理实时音视频](https://developer.qiniu.com/rtc/9858/applist) | [开发准备](https://developer.qiniu.com/rtc/8765/prepare-android-development) | [开发准备](https://developer.qiniu.com/rtc/8831/prepare-ios-development) | [开发准备](https://developer.qiniu.com/rtc/9476/prepare-web-development) | [开发准备](https://developer.qiniu.com/rtc/9537/windows-preparation) | [开发准备](https://developer.qiniu.com/rtc/11119/prepare-wxapp-development) | [开发准备](https://developer.qiniu.com/rtc/11848/prepare-uniapp-development) | [开发准备](https://developer.qiniu.com/rtc/11365/preparation-linux)
| [快速开始](https://developer.qiniu.com/rtc/8766/quick-start-android) | [快速开始](https://developer.qiniu.com/rtc/9255/quick-start-iOS) | [快速开始](https://developer.qiniu.com/rtc/9477/quick-start-websit) | [快速开始](https://developer.qiniu.com/rtc/9543/windows-rtc-quick-start) | [快速开始](https://developer.qiniu.com/rtc/11120/quick-start-wxapp) | [快速开始](https://developer.qiniu.com/rtc/11849/quick-start-uniapp) | [快速开始](https://developer.qiniu.com/rtc/11366/quick-start-linux)
| | | [浏览器兼容性说明](https://developer.qiniu.com/rtc/10493/browser-support) | | |
# 使用指南
Android | iOS | Web | Windows | 服务端 | WXApp | Uniapp | Linux
---|---|---|---|---|---|---|---
[初始化](https://developer.qiniu.com/rtc/8727/initialization-android) | [初始化](https://developer.qiniu.com/rtc/9257/user-guidance-iOS) | [初始化](https://developer.qiniu.com/rtc/9386/user-guidance-web) | [初始化](https://developer.qiniu.com/rtc/9545/user-guidance-windows) | [服务端说明](https://developer.qiniu.com/rtc/8805/server-overview) | [初始化](https://developer.qiniu.com/rtc/11146/user-guidance-wxapp) | [初始化](https://developer.qiniu.com/rtc/11837/initialization-uniapp) | [初始化](https://developer.qiniu.com/rtc/11368/initialization-linux)
[音视频采集](https://developer.qiniu.com/rtc/8767/audio-and-video-collection-android) | [音视频采集](https://developer.qiniu.com/rtc/9258/audio-and-video-collection-iOS) | [音视频采集](https://developer.qiniu.com/rtc/9387/audio-and-video-collection-web) | [音视频采集](https://developer.qiniu.com/rtc/9546/audio-and-video-collection-windows) | [服务端 SDK](https://developer.qiniu.com/rtc/8812/serversdk) | [房间管理](https://developer.qiniu.com/rtc/11147/room-management-wxapp) | [音视频采集](https://developer.qiniu.com/rtc/11838/audio-and-video-collection-uniapp) | [音视频采集](https://developer.qiniu.com/rtc/11371/media-capture-linux)
[房间管理](https://developer.qiniu.com/rtc/8768/room-management-android) | [房间管理](https://developer.qiniu.com/rtc/9261/room-management-iOS) | [房间管理](https://developer.qiniu.com/rtc/9465/room-management-web) | [房间管理](https://developer.qiniu.com/rtc/9547/room-management-windows) | [roomToken](https://developer.qiniu.com/rtc/8813/roomToken) | [发布和订阅](https://developer.qiniu.com/rtc/11148/publish-and-subscribe-wxapp) | [房间管理](https://developer.qiniu.com/rtc/11841/room-management-uniapp) | [房间管理](https://developer.qiniu.com/rtc/11373/room-management-linux)
[发布和订阅](https://developer.qiniu.com/rtc/8769/publish-and-subscribe-android) | [发布和订阅](https://developer.qiniu.com/rtc/9260/publish-and-subscribe-iOS) | [发布和订阅](https://developer.qiniu.com/rtc/9467/publish-and-subscribe-website) | [发布和订阅](https://developer.qiniu.com/rtc/9548/publish-and-subscribe-windows) | [应用管理](https://developer.qiniu.com/rtc/8814/api-app) | [CDN 转推](https://developer.qiniu.com/rtc/11149/turn-the-cdn-push-wxapp) | [发布和订阅](https://developer.qiniu.com/rtc/11843/publish-and-subscribe-uniapp) | [发布和订阅](https://developer.qiniu.com/rtc/11372/publish-subscribe-linux)
[CDN 转推](https://developer.qiniu.com/rtc/8770/turn-the-cdn-push-android) | [CDN 转推](https://developer.qiniu.com/rtc/9262/turn-the-cdn-push-iOS) | [CDN 转推](https://developer.qiniu.com/rtc/9468/turn-the-cdn-push-web) | [CDN 转推](https://developer.qiniu.com/rtc/9549/turn-the-cdn-push-windows) | [房间管理](https://developer.qiniu.com/rtc/8815/api-room) | [错误码](https://developer.qiniu.com/rtc/11150/error_code_wxapp) | [CDN 转推](https://developer.qiniu.com/rtc/11842/turn-the-cdn-push-uniapp) | [CDN 转推](https://developer.qiniu.com/rtc/11374/solution-streaming-linux)
[背景音乐混音](https://developer.qiniu.com/rtc/8771/background-music-mix-android) | [背景音乐混音](https://developer.qiniu.com/rtc/9256/%E8%83%8C%E6%99%AF%E9%9F%B3%E4%B9%90%E6%B7%B7%E9%9F%B3%20-%20iOS) | [背景音乐混音](https://developer.qiniu.com/rtc/9470/background-music-mix-web) | [背景音乐混音](https://developer.qiniu.com/rtc/development_guidelines/11177/background-music-mix-windows) | [RTC-Pub](https://developer.qiniu.com/rtc/8816/RTC-Pub) | | [视频大小流](https://developer.qiniu.com/rtc/11844/video-size-flow-uniapp) | [视频大小流](https://developer.qiniu.com/rtc/11370/multi-stream-linux)
[多音效混音](https://developer.qiniu.com/rtc/11965/android_audio_effect_mixing) | [多音效混音](https://developer.qiniu.com/rtc/11979/iOS-audio-effect-mixer) | [视频大小流（旧版）](https://developer.qiniu.com/rtc/9472/video-size-flow-web) | [视频大小流](https://developer.qiniu.com/rtc/9550/video-size-flow-windows) | [合流转推](https://developer.qiniu.com/rtc/8817/api-mergePublish) | | [通话质量统计](https://developer.qiniu.com/rtc/11845/quality-statistics-uniapp) | [通话质量统计](https://developer.qiniu.com/rtc/11375/statistics-linux)
[视频大小流](https://developer.qiniu.com/rtc/8772/video-size-flow-android) | [视频大小流](https://developer.qiniu.com/rtc/9259/multi-stream-iOS) | [通话质量统计](https://developer.qiniu.com/rtc/10233/web-call-quality-statistics) | [通话质量统计](https://developer.qiniu.com/rtc/development_guidelines/11178/call-quality-statistics-windows) | [旁路直播](https://developer.qiniu.com/rtc/8818/api-rtmp) | | | [错误码](https://developer.qiniu.com/rtc/11369/error-code-linux)
[通话质量统计](https://developer.qiniu.com/rtc/9860/quality-statistics-android) | [通话质量统计](https://developer.qiniu.com/rtc/10085/quality-statistics-iOS) | [错误码](https://developer.qiniu.com/rtc/10483/web-error-code) | [错误码](https://developer.qiniu.com/rtc/11350/error-code-windows) | [录制存储](https://developer.qiniu.com/rtc/8819/api-record) | |
[错误码](https://developer.qiniu.com/rtc/9904/rtc-error-code-android) | [错误码](https://developer.qiniu.com/rtc/10084/rtc-error-code-iOS) | [设备管理](https://developer.qiniu.com/rtc/10720/device_management) | | | | |
| | [屏幕共享](https://developer.qiniu.com/rtc/10785/web-screen-sharing) | | | | |
| | [跨房媒体转发](https://developer.qiniu.com/rtc/11359/media-relay-web) | | | | |
| | [视频大小流（新版）](https://developer.qiniu.com/rtc/10566/video-size-flow-web-new) | | | | |
| | [最佳实践](https://developer.qiniu.com/rtc/10266/we-best-practices) | | | | |
| | [浏览器兼容性检测](https://developer.qiniu.com/rtc/10232/check-system-requirements) | | | | |
| | [Electron 环境下使用](https://developer.qiniu.com/rtc/11182/electron) | | | | |
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,771 |
Linux 更新日志 | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > 产品动态 > Linux 更新日志
# Linux 更新日志
最近更新时间: 2022-07-13 23:51:15
本文提供 QNRTC Linux SDK 5.x 以上版本的发布说明。
* **5.1.0**
* 支持多重混音功能
* **5.0.2**
* 支持 arm_linux_gnueabihf
* **5.0.1**
* 自定义视频 Track 支持 H264 数据推送
* **5.0.0**
* 基本的音视频通话功能
* 内置音视频采集功能
* 支持静音功能
* 支持视频参数配置
* 支持网络自动重连
* 支持丰富的消息回调
* 支持纯音频互动
* 支持获取通话质量统计信息（帧率、码率、丢包率等）
* 支持导入外部 PCM 音频数据
* 支持导入外部 RAW 视频数据
* 支持大小流
* 支持单路转推
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > 产品动态 > Linux 更新日志
# Linux 更新日志
最近更新时间: 2022-07-13 23:51:15
本文提供 QNRTC Linux SDK 5.x 以上版本的发布说明。
* **5.1.0**
* 支持多重混音功能
* **5.0.2**
* 支持 arm_linux_gnueabihf
* **5.0.1**
* 自定义视频 Track 支持 H264 数据推送
* **5.0.0**
* 基本的音视频通话功能
* 内置音视频采集功能
* 支持静音功能
* 支持视频参数配置
* 支持网络自动重连
* 支持丰富的消息回调
* 支持纯音频互动
* 支持获取通话质量统计信息（帧率、码率、丢包率等）
* 支持导入外部 PCM 音频数据
* 支持导入外部 RAW 视频数据
* 支持大小流
* 支持单路转推
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,777 |
Android 更新日志 | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > 产品动态 > Android 更新日志
# Android 更新日志
最近更新时间: 2024-08-23 18:05:45
本文提供 QNRTC Android SDK 4.x 以上版本的发布说明。
> * 若您想要查看 4.x 版本之前的发布说明，可查看 [3.x
> 及之前版本的更新日志](https://doc.qnsdk.com/rtn/android/docs/release_notes)
> * 若您正在使用 3.x 或者更低版本的 SDK，并且想要升级至最新版本，则可参考 [4.x
> 版本迁移指南](https://developer.qiniu.com/rtc/development_guidelines/9394/migration-
> guide-android) 进行版本升级。
>
> * 注意：5.x 及之后版本是基于 4.x 版本开发的重构版本，SDK 使用了统一的 C++ RTC 内核, 保证了 QRTC
> 在各个端上处理逻辑的一致性，同时接口和 4.x 完全兼容。若您使用的是 4.x 的版本，可直接进行升级；若您使用的 3.x
> 及之前的版本，可参考各端的迁移指南，进行版本迁移。
>
* [**6.4.0**](https://github.com/pili-engineering/QNRTC-Android/tree/v6.4.0)
* 发布 qndroid-rtc-6.4.0.jar
* 更新 libqndroid_rtc.so
* 支持内置媒体播放器
* 修复远端音频回调数据异常的问题
* [**6.3.0**](https://github.com/pili-engineering/QNRTC-Android/tree/v6.3.0)
* 发布 qndroid-rtc-6.3.0.jar
* 更新 libqndroid_rtc.so
* 支持视频上下行分段 FEC 功能
* [**6.2.0**](https://github.com/pili-engineering/QNRTC-Android/tree/v6.2.0)
* 发布 qndroid-rtc-6.2.0.jar
* 更新 libqndroid_rtc.so
* 支持音视频本地录制功能
* 修复使用非法图片进行图片推流崩溃的问题
* [**6.1.0**](https://github.com/pili-engineering/QNRTC-Android/tree/v6.1.0)
* 发布 qndroid-rtc-6.1.0.jar
* 更新 libqndroid_rtc.so
* 优化弱网下的音频连麦体验
* 修复特定场景下偶现的崩溃问题
* 修复订阅统计信息失效的问题
* [**6.0.0**](https://github.com/pili-engineering/QNRTC-Android/tree/v6.0.0)
* 发布 qndroid-rtc-6.0.0.jar
* 更新 libqndroid_rtc.so
* 新增 RTMP 直推功能
* 新增音频自定义加解密功能
* 修复特定场景下麦克风开始采集崩溃的问题
* 修复日志持久化偶现崩溃的问题
* 修复特定并发场景下偶现的崩溃问题
* [**5.2.7**](https://github.com/pili-engineering/QNRTC-Android/tree/v5.2.7)
* 发布 qndroid-rtc-5.2.7.jar
* 更新 libqndroid_rtc.so
* 新增麦克风采集控制接口
* 修复水印拉伸变形的问题
* 修复音频场景表现非预期的问题
* 修复低延迟耳返存在的兼容性问题
* 修复弱网场景偶现的阻塞问题
* 优化拥塞算法提高带宽利用率
* 优化连麦初始接入时的音频表现
* [**5.2.6**](https://github.com/pili-engineering/QNRTC-Android/tree/v5.2.6)
* 发布 qndroid-rtc-5.2.6.jar
* 更新 libqndroid_rtc.so
* 新增语音激励功能
* 新增 QNCustomAudioTrack 的混音功能
* 新增 QNAudioFilter 类用于自定义音频处理
* 优化个别设备上的返听延时
* [**5.2.5**](https://github.com/pili-engineering/QNRTC-Android/tree/v5.2.5)
* 发布 qndroid-rtc-5.2.5.jar
* 更新 libqndroid_rtc.so
* 新增 libqnquic.so
* 新增 libqcrash.so
* 新增对 quic 协议信令交互的支持
* 新增崩溃搜集模块
* 新增图片推流场景下的错误回调
* 新增支持 QNRTCSetting.setCustomSharedLibraryDir 接口设置未创建的路径
* 修复日志本地存储场景下偶现的崩溃问题
* 修复个别场景下已知的低概率崩溃问题
* [**5.2.4**](https://github.com/pili-engineering/QNRTC-Android/tree/v5.2.4)
* 发布 qndroid-rtc-5.2.4.jar
* 更新 libqndroid_rtc.so
* 支持设置房间重连的超时时间
* 对于转推任务异常断开的情况，在 QNLiveStreamingListener.onError() 中新增 ERROR_LIVE_STREAMING_CLOSED 错误码
* 提供视频编码参数的预设值接口
* 对 QNLocalVideoTrackStats 新增发布的宽高等统计信息
* 修复在模拟器上运行崩溃的问题
* 修复 Track 在销毁后再发布崩溃的问题
* 修复使用 QNAudioMusicMixer.start() 接口无法开始混音的问题
* 修复同时订阅同一个 Track 概率发生错误的问题
* 优化在弱网传输时的重传和接收 buffer 策略，降低卡顿率
* 优化在佩戴耳机场景下的音频处理流程，提升耳机场景的体验
* [**5.2.3**](https://github.com/pili-engineering/QNRTC-Android/tree/v5.2.3)
* 发布 qndroid-rtc-5.2.3.jar
* 更新 libqndroid_rtc.so
* 支持同时发布多个 QNLocalAudioTrack
* 支持新的日志上报功能
* 支持设置视频在弱网下的降级模式
* 支持设置自定义的 so 加载路径
* 修复在某些 vivo 手机上，使用蓝牙耳机崩溃的问题
* 修复使用 QNDroidRTC 上线谷歌商店有安全警告的问题
* 修复在某些定制的 Android 设备上，加房抛出 10054 的问题
* 修复对 QNRemoteVideoTrack 设置 QNVideoFrameListener 后，必需调用 play 接口才有回调的问题
* 优化在低带宽，高丢包场景下的媒体传输质量
* 优化视频软编码的效率和质量
* 优化在音乐场景下的声音质量
* [**5.2.2**](https://github.com/pili-engineering/QNRTC-Android/tree/v5.2.2)
* 发布 qndroid-rtc-5.2.2.jar
* 更新 libqndroid_rtc.so
* 修复在 armv7 架构手机上使用软件 AEC 时崩溃的问题
* 修复在重连失败再次加入房间后，离开房间会崩溃的问题
* 修复在观众角色时，无法回调本地网络质量信息的问题
* 修复采集分辨率和编码分辨率不一致，导致画面被裁剪的问题
* 优化在 RTT 一定波动网络环境下视频卡顿的现象
* [**5.2.1**](https://github.com/pili-engineering/QNRTC-Android/tree/v5.2.1)
* 发布 qndroid-rtc-5.2.1.jar
* 更新 libqndroid_rtc.so
* 支持动态修改本地视频 Track 的编码参数
* 修复在 API 31 及以上版本 SDK 需要 BLUETOOTH 权限才能进行蓝牙连麦的问题
* 修复本地 Track 的 mute 状态在重连过程中有可能失效的问题
* 修复使用在线资源进行混音时进行 seek 导致概率奔溃的问题
* [**5.2.0**](https://github.com/pili-engineering/QNRTC-Android/tree/v5.2.0)
* 发布 qndroid-rtc-5.2.0.jar
* 更新 libqndroid_rtc.so
* 优化弱网下视频质量调整策略，平衡清晰度和流畅性
* 支持音乐，音效通过 RTC 进行本地播放
* 支持外部音源 (PCM) 混音
* 支持设置拉伸模式进行视频渲染
* 修复稳定性崩溃问题
* 修复展讯平台硬编码无法使用的问题
* [**5.1.3**](https://github.com/pili-engineering/QNRTC-Android/tree/v5.1.3)
* 发布 qndroid-rtc-5.1.3.jar
* 更新 libqndroid_rtc.so
* 升级音频回声处理算法, 优化回声处理的兼容性和稳定性
* 新增音频场景化配置功能
* 修复 init/deinit 过程中概率崩溃的问题
* 修复硬解码概率崩溃的问题
* [**5.1.2**](https://github.com/pili-engineering/QNRTC-Android/tree/v5.1.2)
* 发布 qndroid-rtc-5.1.2.jar
* 更新 libqndroid_rtc.so
* 优化蓝牙场景的使用体验
* 修复远端用户离开房间概率崩溃的问题
* 修复断网重连时没有回调单路转推 QNLiveStreamingListener.onStopped() 状态的问题
* [**5.1.1**](https://github.com/pili-engineering/QNRTC-Android/tree/v5.1.1)
* 发布 qndroid-rtc-5.1.1.jar
* 更新 libqndroid_rtc.so
* 支持创建纯音频合流转推任务
* 修复 QNRemoteVideoTrackStats，QNRemoteAudioTrackStats 中 uplinkRTT，uplinkLostRate 值错误的问题
* 修复在 Android 4.4 上无法使用的问题
* 视频默认使用软件编码
* 取消对接口 QNTranscodingLiveStreamingConfig.setHoldLastFrame() 的支持
* [**5.1.0**](https://github.com/pili-engineering/QNRTC-Android/tree/v5.1.0)
* 发布 qndroid-rtc-5.1.0.jar
* 更新 libqndroid_rtc.so
* 新增多重混音功能，支持同时混音背景音乐和音效
* 修复 userData 异常的问题
* [**5.0.1**](https://github.com/pili-engineering/QNRTC-Android/tree/v5.0.1)
* 发布 qndroid-rtc-5.0.1.jar
* 更新 libqndroid_rtc.so
* 升级自研音频回声消除算法
* [**5.0.0**](https://github.com/pili-engineering/QNRTC-Android/tree/v5.0.0)
* 发布 qndroid-rtc-5.0.0.jar
* 更新 libqndroid_rtc.so
* 新增 SDK 内部音视频弱网优化
* [**4.0.3**](https://github.com/pili-engineering/QNRTC-Android/tree/v4.0.3)
* 发布 qndroid-rtc-4.0.3.jar
* 修复加房间前设置连麦角色失效的问题
* 优化蓝牙场景的使用体验
* [**4.0.2**](https://github.com/pili-engineering/QNRTC-Android/tree/v4.0.2)
* 发布 qndroid-rtc-4.0.2.jar
* 更新 libqndroid_rtc.so
* 升级自研音频回声消除算法
* 修复 HE-AAC 音频格式混音播放异常
* 修复无法创建纯音频合流转推任务的问题
* 修复个别场景下偶现的空指针问题
* 修复蓝牙耳机场景下的异常问题
* [**4.0.1**](https://github.com/pili-engineering/QNRTC-Android/tree/v4.0.1)
* 发布 qndroid-rtc-4.0.1.jar
* 新增场景和角色设置，详见 QNRTC.createClient, QNRTCClient.setClientRole
* 跨房媒体转发功能，详见 QNRTCClient.(start/update/stop)MediaRelay
* 麦克风被占用时提供检测方法或错误回调
* 修复断网时统计信息依然回调质量正常的问题
* [**4.0.0**](https://github.com/pili-engineering/QNRTC-Android/tree/v4.0.0)
* 发布 qndroid-rtc-4.0.0.jar
* 新增核心类 `QNRTC` 和 `QNRTCClient`，移除 `QNRTCCEngine` 接口类
* 新增 `QNLocalTrack` 和 `QNRemoteTrack` 及其衍生的子类，对不同类型的音视频轨道做了区分，并提供了丰富的控制接口
* 优化事件监听逻辑，提供更丰富更具体的事件监听
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > 产品动态 > Android 更新日志
# Android 更新日志
最近更新时间: 2024-08-23 18:05:45
本文提供 QNRTC Android SDK 4.x 以上版本的发布说明。
> * 若您想要查看 4.x 版本之前的发布说明，可查看 [3.x
> 及之前版本的更新日志](https://doc.qnsdk.com/rtn/android/docs/release_notes)
> * 若您正在使用 3.x 或者更低版本的 SDK，并且想要升级至最新版本，则可参考 [4.x
> 版本迁移指南](https://developer.qiniu.com/rtc/development_guidelines/9394/migration-
> guide-android) 进行版本升级。
>
> * 注意：5.x 及之后版本是基于 4.x 版本开发的重构版本，SDK 使用了统一的 C++ RTC 内核, 保证了 QRTC
> 在各个端上处理逻辑的一致性，同时接口和 4.x 完全兼容。若您使用的是 4.x 的版本，可直接进行升级；若您使用的 3.x
> 及之前的版本，可参考各端的迁移指南，进行版本迁移。
>
* [**6.4.0**](https://github.com/pili-engineering/QNRTC-Android/tree/v6.4.0)
* 发布 qndroid-rtc-6.4.0.jar
* 更新 libqndroid_rtc.so
* 支持内置媒体播放器
* 修复远端音频回调数据异常的问题
* [**6.3.0**](https://github.com/pili-engineering/QNRTC-Android/tree/v6.3.0)
* 发布 qndroid-rtc-6.3.0.jar
* 更新 libqndroid_rtc.so
* 支持视频上下行分段 FEC 功能
* [**6.2.0**](https://github.com/pili-engineering/QNRTC-Android/tree/v6.2.0)
* 发布 qndroid-rtc-6.2.0.jar
* 更新 libqndroid_rtc.so
* 支持音视频本地录制功能
* 修复使用非法图片进行图片推流崩溃的问题
* [**6.1.0**](https://github.com/pili-engineering/QNRTC-Android/tree/v6.1.0)
* 发布 qndroid-rtc-6.1.0.jar
* 更新 libqndroid_rtc.so
* 优化弱网下的音频连麦体验
* 修复特定场景下偶现的崩溃问题
* 修复订阅统计信息失效的问题
* [**6.0.0**](https://github.com/pili-engineering/QNRTC-Android/tree/v6.0.0)
* 发布 qndroid-rtc-6.0.0.jar
* 更新 libqndroid_rtc.so
* 新增 RTMP 直推功能
* 新增音频自定义加解密功能
* 修复特定场景下麦克风开始采集崩溃的问题
* 修复日志持久化偶现崩溃的问题
* 修复特定并发场景下偶现的崩溃问题
* [**5.2.7**](https://github.com/pili-engineering/QNRTC-Android/tree/v5.2.7)
* 发布 qndroid-rtc-5.2.7.jar
* 更新 libqndroid_rtc.so
* 新增麦克风采集控制接口
* 修复水印拉伸变形的问题
* 修复音频场景表现非预期的问题
* 修复低延迟耳返存在的兼容性问题
* 修复弱网场景偶现的阻塞问题
* 优化拥塞算法提高带宽利用率
* 优化连麦初始接入时的音频表现
* [**5.2.6**](https://github.com/pili-engineering/QNRTC-Android/tree/v5.2.6)
* 发布 qndroid-rtc-5.2.6.jar
* 更新 libqndroid_rtc.so
* 新增语音激励功能
* 新增 QNCustomAudioTrack 的混音功能
* 新增 QNAudioFilter 类用于自定义音频处理
* 优化个别设备上的返听延时
* [**5.2.5**](https://github.com/pili-engineering/QNRTC-Android/tree/v5.2.5)
* 发布 qndroid-rtc-5.2.5.jar
* 更新 libqndroid_rtc.so
* 新增 libqnquic.so
* 新增 libqcrash.so
* 新增对 quic 协议信令交互的支持
* 新增崩溃搜集模块
* 新增图片推流场景下的错误回调
* 新增支持 QNRTCSetting.setCustomSharedLibraryDir 接口设置未创建的路径
* 修复日志本地存储场景下偶现的崩溃问题
* 修复个别场景下已知的低概率崩溃问题
* [**5.2.4**](https://github.com/pili-engineering/QNRTC-Android/tree/v5.2.4)
* 发布 qndroid-rtc-5.2.4.jar
* 更新 libqndroid_rtc.so
* 支持设置房间重连的超时时间
* 对于转推任务异常断开的情况，在 QNLiveStreamingListener.onError() 中新增 ERROR_LIVE_STREAMING_CLOSED 错误码
* 提供视频编码参数的预设值接口
* 对 QNLocalVideoTrackStats 新增发布的宽高等统计信息
* 修复在模拟器上运行崩溃的问题
* 修复 Track 在销毁后再发布崩溃的问题
* 修复使用 QNAudioMusicMixer.start() 接口无法开始混音的问题
* 修复同时订阅同一个 Track 概率发生错误的问题
* 优化在弱网传输时的重传和接收 buffer 策略，降低卡顿率
* 优化在佩戴耳机场景下的音频处理流程，提升耳机场景的体验
* [**5.2.3**](https://github.com/pili-engineering/QNRTC-Android/tree/v5.2.3)
* 发布 qndroid-rtc-5.2.3.jar
* 更新 libqndroid_rtc.so
* 支持同时发布多个 QNLocalAudioTrack
* 支持新的日志上报功能
* 支持设置视频在弱网下的降级模式
* 支持设置自定义的 so 加载路径
* 修复在某些 vivo 手机上，使用蓝牙耳机崩溃的问题
* 修复使用 QNDroidRTC 上线谷歌商店有安全警告的问题
* 修复在某些定制的 Android 设备上，加房抛出 10054 的问题
* 修复对 QNRemoteVideoTrack 设置 QNVideoFrameListener 后，必需调用 play 接口才有回调的问题
* 优化在低带宽，高丢包场景下的媒体传输质量
* 优化视频软编码的效率和质量
* 优化在音乐场景下的声音质量
* [**5.2.2**](https://github.com/pili-engineering/QNRTC-Android/tree/v5.2.2)
* 发布 qndroid-rtc-5.2.2.jar
* 更新 libqndroid_rtc.so
* 修复在 armv7 架构手机上使用软件 AEC 时崩溃的问题
* 修复在重连失败再次加入房间后，离开房间会崩溃的问题
* 修复在观众角色时，无法回调本地网络质量信息的问题
* 修复采集分辨率和编码分辨率不一致，导致画面被裁剪的问题
* 优化在 RTT 一定波动网络环境下视频卡顿的现象
* [**5.2.1**](https://github.com/pili-engineering/QNRTC-Android/tree/v5.2.1)
* 发布 qndroid-rtc-5.2.1.jar
* 更新 libqndroid_rtc.so
* 支持动态修改本地视频 Track 的编码参数
* 修复在 API 31 及以上版本 SDK 需要 BLUETOOTH 权限才能进行蓝牙连麦的问题
* 修复本地 Track 的 mute 状态在重连过程中有可能失效的问题
* 修复使用在线资源进行混音时进行 seek 导致概率奔溃的问题
* [**5.2.0**](https://github.com/pili-engineering/QNRTC-Android/tree/v5.2.0)
* 发布 qndroid-rtc-5.2.0.jar
* 更新 libqndroid_rtc.so
* 优化弱网下视频质量调整策略，平衡清晰度和流畅性
* 支持音乐，音效通过 RTC 进行本地播放
* 支持外部音源 (PCM) 混音
* 支持设置拉伸模式进行视频渲染
* 修复稳定性崩溃问题
* 修复展讯平台硬编码无法使用的问题
* [**5.1.3**](https://github.com/pili-engineering/QNRTC-Android/tree/v5.1.3)
* 发布 qndroid-rtc-5.1.3.jar
* 更新 libqndroid_rtc.so
* 升级音频回声处理算法, 优化回声处理的兼容性和稳定性
* 新增音频场景化配置功能
* 修复 init/deinit 过程中概率崩溃的问题
* 修复硬解码概率崩溃的问题
* [**5.1.2**](https://github.com/pili-engineering/QNRTC-Android/tree/v5.1.2)
* 发布 qndroid-rtc-5.1.2.jar
* 更新 libqndroid_rtc.so
* 优化蓝牙场景的使用体验
* 修复远端用户离开房间概率崩溃的问题
* 修复断网重连时没有回调单路转推 QNLiveStreamingListener.onStopped() 状态的问题
* [**5.1.1**](https://github.com/pili-engineering/QNRTC-Android/tree/v5.1.1)
* 发布 qndroid-rtc-5.1.1.jar
* 更新 libqndroid_rtc.so
* 支持创建纯音频合流转推任务
* 修复 QNRemoteVideoTrackStats，QNRemoteAudioTrackStats 中 uplinkRTT，uplinkLostRate 值错误的问题
* 修复在 Android 4.4 上无法使用的问题
* 视频默认使用软件编码
* 取消对接口 QNTranscodingLiveStreamingConfig.setHoldLastFrame() 的支持
* [**5.1.0**](https://github.com/pili-engineering/QNRTC-Android/tree/v5.1.0)
* 发布 qndroid-rtc-5.1.0.jar
* 更新 libqndroid_rtc.so
* 新增多重混音功能，支持同时混音背景音乐和音效
* 修复 userData 异常的问题
* [**5.0.1**](https://github.com/pili-engineering/QNRTC-Android/tree/v5.0.1)
* 发布 qndroid-rtc-5.0.1.jar
* 更新 libqndroid_rtc.so
* 升级自研音频回声消除算法
* [**5.0.0**](https://github.com/pili-engineering/QNRTC-Android/tree/v5.0.0)
* 发布 qndroid-rtc-5.0.0.jar
* 更新 libqndroid_rtc.so
* 新增 SDK 内部音视频弱网优化
* [**4.0.3**](https://github.com/pili-engineering/QNRTC-Android/tree/v4.0.3)
* 发布 qndroid-rtc-4.0.3.jar
* 修复加房间前设置连麦角色失效的问题
* 优化蓝牙场景的使用体验
* [**4.0.2**](https://github.com/pili-engineering/QNRTC-Android/tree/v4.0.2)
* 发布 qndroid-rtc-4.0.2.jar
* 更新 libqndroid_rtc.so
* 升级自研音频回声消除算法
* 修复 HE-AAC 音频格式混音播放异常
* 修复无法创建纯音频合流转推任务的问题
* 修复个别场景下偶现的空指针问题
* 修复蓝牙耳机场景下的异常问题
* [**4.0.1**](https://github.com/pili-engineering/QNRTC-Android/tree/v4.0.1)
* 发布 qndroid-rtc-4.0.1.jar
* 新增场景和角色设置，详见 QNRTC.createClient, QNRTCClient.setClientRole
* 跨房媒体转发功能，详见 QNRTCClient.(start/update/stop)MediaRelay
* 麦克风被占用时提供检测方法或错误回调
* 修复断网时统计信息依然回调质量正常的问题
* [**4.0.0**](https://github.com/pili-engineering/QNRTC-Android/tree/v4.0.0)
* 发布 qndroid-rtc-4.0.0.jar
* 新增核心类 `QNRTC` 和 `QNRTCClient`，移除 `QNRTCCEngine` 接口类
* 新增 `QNLocalTrack` 和 `QNRemoteTrack` 及其衍生的子类，对不同类型的音视频轨道做了区分，并提供了丰富的控制接口
* 优化事件监听逻辑，提供更丰富更具体的事件监听
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,778 |
iOS 更新日志 | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > 产品动态 > iOS 更新日志
# iOS 更新日志
最近更新时间: 2024-08-16 17:43:08
本文提供 QNRTC iOS SDK 4.x 以上版本的发布说明。
> * 若您想要查看 3.x 版本之前的发布说明，可查看 [3.x
> 及之前版本的更新日志](https://doc.qnsdk.com/rtn/ios/docs/release_notes)
> * 若您正在使用 3.x 或者更低版本的 SDK，想要升级至 5.x，则可参考 [5.x
> 版本迁移指南](https://developer.qiniu.com/rtc/development_guidelines/11949/migration-
> guide-iOS-v5)。
>
> * 注意：5.x 版本是基于 4.x 版本开发的重构版本，SDK 使用了统一的 C++ RTC 内核, 保证了 QRTC
> 在各个端上处理逻辑的一致性，同时接口和 4.x 基本兼容。若您使用的是 4.x 的版本，可根接口 5.x 版本迁移指南进行升级；若您使用的 3.x
> 及之前的版本，可参考各端的迁移指南，进行版本迁移。
>
# 6.4.0
* 支持内置多媒体播放器
* 视频硬编支持低延时编码，优化延时和弱网QoE体验
# 6.3.0
* 支持视频上下行分段 FEC 功能
* 优化音视频本地录制功能
# 6.2.0
* 支持音视频本地录制
# 6.1.0
* SDK 稳定性优化
* 音频弱网 QoS 优化
* 修复蓝牙耳机插拔扬声器播放的问题
* 修复其它已知问题
# 6.0.0
* 新增 QNRTCKit 直播推流
* 支持音频扩展加解密
* 修复异步调用混音接口偶现奔溃的问题
* 修复远端 mute 偶现奔溃的问题
* 修复日志持久化偶现奔溃的问题
# 5.2.7
* 支持麦克风启动开关及错误回调
* 支持更多外部音频格式导入
* 优化拥塞算法提高带宽利用率
* 优化 OC 代码线程使用安全
* 修复销毁 RTCClient 偶现奔溃的问题
* 修复混音 destroy track 偶现奔溃的问题
* 修复通话模式蓝牙断开再连接切换到媒体模式非预期的问题
* 修复订阅远端画面本地渲染不清晰的问题
# 5.2.6
* CustomAudioTrack 支持混音功能
* 新增加 AudioFilter 模块
* 支持软件回音消除
* 外部导入音频支持多种格式
* 支持语音激励
* 支持 pc 重连超时、mcu 获取超时时间
* 修复已知 crash 问题
# 5.2.5
* 支持信令 quic
* 支持 mcu 备用域名设置
* 支持软件编码
* 修复多个线上偶现 crash
# 5.2.4
* 支持设置房间重连超时时间
* 支持视频编码参数的预设配置接口
* 支持软件编码
* 支持视频降级默认值自动区分场景
* 支持本地及远端视频 stats 回调宽高信息
* 优化在弱网传输时的重传和接收 buffer 策略，降低卡顿率
* 优化平台层断线重连的反应时间
* 转推异常断开时回调新增错误码 QNRTCErrorLiveStreamingClosedError
* 修复订阅相同 Track 多次导致订阅失败的问题
* 修复销毁 Track 后再发布会 crash 的问题
* 修复取消发布后仍回调 stats 的问题
* 修复偶现远端离开房间本地 crash 的问题
* 修复日志文件 Tag 非法及 Size 过小的 crash 问题
* 修复连麦时订阅还未成功便立即取消订阅发生 crash 的问题
# 5.2.3
* 支持发布多音频 Track
* 支持音频场景化配置
* 支持日志文件上传
* 支持设置视频在弱网下的降级模式
* 支持切换摄像头结果回调
* 支持摄像头采集运行过程中发生错误回调
* 提升抗丢包抗抖动能力
* 优化本地渲染 CPU 占用
* 优化包体大小
* 修复加房间成功后立即离开概率性奔溃的问题
* 修复获取 remoteUserList 的音频 track 数组错误的问题
* 修复 iOS 16.4.1 推流画面模糊的问题
* 修复 iOS 13.x 上 Metal 本地预览黑屏的问题
* 修复 iOS 15.5 音频打断奔溃的问题
# 5.2.2
* 修复在重连失败再次加入房间后，离开房间会崩溃的问题
* 修复采集分辨率和编码分辨率不一致，导致画面被裁剪的问题
* 优化在 RTT 一定波动网络环境下视频卡顿的现象
# 5.2.1
* 支持动态修改本地视频 Track 的编码参数
* 修复本地 Track 的 mute 状态在重连过程中有可能失效的问题
* 修复使用在线资源进行混音时 seek 操作导致概率奔溃的问题
* 修复断线重连失败偶现奔溃的问题
# 5.2.0
* 支持推流固定分辨率
* 支持通话模式开关
* 支持音乐、音效通过 RTC 进行本地播放
* 支持外部音源 (PCM) 混音
* 优化弱网下视频质量调整策略，平衡清晰度和流畅性
* 修复不实现摄像头采集代理本地内置美颜不生效的问题
* 修复加房间 userData 传 NSNull 会奔溃的问题
* 修复 iOS 16 以上开启摄像头采集线程卡顿、回声消除失效的问题
* 修复稳定性崩溃问题
# 5.1.1
* 支持创建纯音频合流转推任务
* 去除合流转推对 isHoldLastFrame 的支持
* 缩小 FFmpeg 的包体大小，改为静态库由 QNRTCKit.framework 内部链路
* 修复远端音视频传输统计数据中 uplinkRTT 以及 uplinkLostRate 值错误的问题
* 修复本地质量等级变更回调 didNetworkQualityNotified 未触发的问题
* 修复跨房信息配置初始化方法 initWithToken 设置 token 无效的问题
# 5.1.0
* 新增多重混音功能，支持同时混音背景音乐和音效
# 5.0.0
* 发布 QNRTCKit.framework
* 发布 FFmpeg.framework
* 删除 HappyDNS.framework
# 4.0.4
* 升级 DNS 解析依赖库 HappyDNS 版本为 1.0
# 4.0.3
* 新增本地音频 track 获取音量接口
* 修复 iOS 15.4 视频帧率不稳定问题
* 修复配置跨房连麦信息后 crash 问题
# 4.0.2
* 新增远端音频获取音量接口
# 4.0.1
* 新增使用场景 `QNClientMode` 和用户角色 `QNClientRole`
* 新增跨房媒体转发功能
# 4.0.0
* 发布 QNRTCKit.framework v4.0.0
* 新增核心类 `QNRTC` 和 `QNRTCClient`，移除 `QNRTCCEngine` 接口类
* 新增 `QNLocalTrack` 和 `QNRemoteTrack` 及其衍生的子类，对不同类型的音视频轨道做了区分，并提供了丰富的控制接口
* 优化事件监听逻辑，提供更丰富更具体的事件监听
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > 产品动态 > iOS 更新日志
# iOS 更新日志
最近更新时间: 2024-08-16 17:43:08
本文提供 QNRTC iOS SDK 4.x 以上版本的发布说明。
> * 若您想要查看 3.x 版本之前的发布说明，可查看 [3.x
> 及之前版本的更新日志](https://doc.qnsdk.com/rtn/ios/docs/release_notes)
> * 若您正在使用 3.x 或者更低版本的 SDK，想要升级至 5.x，则可参考 [5.x
> 版本迁移指南](https://developer.qiniu.com/rtc/development_guidelines/11949/migration-
> guide-iOS-v5)。
>
> * 注意：5.x 版本是基于 4.x 版本开发的重构版本，SDK 使用了统一的 C++ RTC 内核, 保证了 QRTC
> 在各个端上处理逻辑的一致性，同时接口和 4.x 基本兼容。若您使用的是 4.x 的版本，可根接口 5.x 版本迁移指南进行升级；若您使用的 3.x
> 及之前的版本，可参考各端的迁移指南，进行版本迁移。
>
# 6.4.0
* 支持内置多媒体播放器
* 视频硬编支持低延时编码，优化延时和弱网QoE体验
# 6.3.0
* 支持视频上下行分段 FEC 功能
* 优化音视频本地录制功能
# 6.2.0
* 支持音视频本地录制
# 6.1.0
* SDK 稳定性优化
* 音频弱网 QoS 优化
* 修复蓝牙耳机插拔扬声器播放的问题
* 修复其它已知问题
# 6.0.0
* 新增 QNRTCKit 直播推流
* 支持音频扩展加解密
* 修复异步调用混音接口偶现奔溃的问题
* 修复远端 mute 偶现奔溃的问题
* 修复日志持久化偶现奔溃的问题
# 5.2.7
* 支持麦克风启动开关及错误回调
* 支持更多外部音频格式导入
* 优化拥塞算法提高带宽利用率
* 优化 OC 代码线程使用安全
* 修复销毁 RTCClient 偶现奔溃的问题
* 修复混音 destroy track 偶现奔溃的问题
* 修复通话模式蓝牙断开再连接切换到媒体模式非预期的问题
* 修复订阅远端画面本地渲染不清晰的问题
# 5.2.6
* CustomAudioTrack 支持混音功能
* 新增加 AudioFilter 模块
* 支持软件回音消除
* 外部导入音频支持多种格式
* 支持语音激励
* 支持 pc 重连超时、mcu 获取超时时间
* 修复已知 crash 问题
# 5.2.5
* 支持信令 quic
* 支持 mcu 备用域名设置
* 支持软件编码
* 修复多个线上偶现 crash
# 5.2.4
* 支持设置房间重连超时时间
* 支持视频编码参数的预设配置接口
* 支持软件编码
* 支持视频降级默认值自动区分场景
* 支持本地及远端视频 stats 回调宽高信息
* 优化在弱网传输时的重传和接收 buffer 策略，降低卡顿率
* 优化平台层断线重连的反应时间
* 转推异常断开时回调新增错误码 QNRTCErrorLiveStreamingClosedError
* 修复订阅相同 Track 多次导致订阅失败的问题
* 修复销毁 Track 后再发布会 crash 的问题
* 修复取消发布后仍回调 stats 的问题
* 修复偶现远端离开房间本地 crash 的问题
* 修复日志文件 Tag 非法及 Size 过小的 crash 问题
* 修复连麦时订阅还未成功便立即取消订阅发生 crash 的问题
# 5.2.3
* 支持发布多音频 Track
* 支持音频场景化配置
* 支持日志文件上传
* 支持设置视频在弱网下的降级模式
* 支持切换摄像头结果回调
* 支持摄像头采集运行过程中发生错误回调
* 提升抗丢包抗抖动能力
* 优化本地渲染 CPU 占用
* 优化包体大小
* 修复加房间成功后立即离开概率性奔溃的问题
* 修复获取 remoteUserList 的音频 track 数组错误的问题
* 修复 iOS 16.4.1 推流画面模糊的问题
* 修复 iOS 13.x 上 Metal 本地预览黑屏的问题
* 修复 iOS 15.5 音频打断奔溃的问题
# 5.2.2
* 修复在重连失败再次加入房间后，离开房间会崩溃的问题
* 修复采集分辨率和编码分辨率不一致，导致画面被裁剪的问题
* 优化在 RTT 一定波动网络环境下视频卡顿的现象
# 5.2.1
* 支持动态修改本地视频 Track 的编码参数
* 修复本地 Track 的 mute 状态在重连过程中有可能失效的问题
* 修复使用在线资源进行混音时 seek 操作导致概率奔溃的问题
* 修复断线重连失败偶现奔溃的问题
# 5.2.0
* 支持推流固定分辨率
* 支持通话模式开关
* 支持音乐、音效通过 RTC 进行本地播放
* 支持外部音源 (PCM) 混音
* 优化弱网下视频质量调整策略，平衡清晰度和流畅性
* 修复不实现摄像头采集代理本地内置美颜不生效的问题
* 修复加房间 userData 传 NSNull 会奔溃的问题
* 修复 iOS 16 以上开启摄像头采集线程卡顿、回声消除失效的问题
* 修复稳定性崩溃问题
# 5.1.1
* 支持创建纯音频合流转推任务
* 去除合流转推对 isHoldLastFrame 的支持
* 缩小 FFmpeg 的包体大小，改为静态库由 QNRTCKit.framework 内部链路
* 修复远端音视频传输统计数据中 uplinkRTT 以及 uplinkLostRate 值错误的问题
* 修复本地质量等级变更回调 didNetworkQualityNotified 未触发的问题
* 修复跨房信息配置初始化方法 initWithToken 设置 token 无效的问题
# 5.1.0
* 新增多重混音功能，支持同时混音背景音乐和音效
# 5.0.0
* 发布 QNRTCKit.framework
* 发布 FFmpeg.framework
* 删除 HappyDNS.framework
# 4.0.4
* 升级 DNS 解析依赖库 HappyDNS 版本为 1.0
# 4.0.3
* 新增本地音频 track 获取音量接口
* 修复 iOS 15.4 视频帧率不稳定问题
* 修复配置跨房连麦信息后 crash 问题
# 4.0.2
* 新增远端音频获取音量接口
# 4.0.1
* 新增使用场景 `QNClientMode` 和用户角色 `QNClientRole`
* 新增跨房媒体转发功能
# 4.0.0
* 发布 QNRTCKit.framework v4.0.0
* 新增核心类 `QNRTC` 和 `QNRTCClient`，移除 `QNRTCCEngine` 接口类
* 新增 `QNLocalTrack` 和 `QNRemoteTrack` 及其衍生的子类，对不同类型的音视频轨道做了区分，并提供了丰富的控制接口
* 优化事件监听逻辑，提供更丰富更具体的事件监听
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,791 |
Web 更新日志 | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > 产品动态 > Web 更新日志
# Web 更新日志
最近更新时间: 2024-01-29 14:36:22
本文提供 QNRTC Web SDK 4.x 以上版本的发布说明。
> * 若您想要查看 4.x 版本之前的发布说明，可查看 [2.x
> 及之前版本](https://doc.qnsdk.com/rtn/web/docs/sdk_overview.html)
> * 若您正在使用 2.x 或者更低版本的 SDK，并且想要升级至最新版本，则可参考 [4.x
> 版本迁移指南](https://developer.qiniu.com/rtc/development_guidelines/9531/migration-
> guide-web) 进行版本升级。
>
* [4.3.0](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.3.0)
* 移除 QNAudioMixer 类
* MicophoneTrack 移除 createAudoMusicMixer 与 createAudioEffectMixer 方法
* 解决 iOS safari 混音模块无法使用的问题
* 解决部分机型离开房间音频资源未正确释放的问题
* LocalAudioTrack 添加 addAudioFilter 与 removeAudioFilter 方法
* QNRTC 添加 createAudoMusicMixer 与 createAudioEffectMixer 方法
* [4.2.1](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.2.1)
* 新增本地录制功能
* 新增音视频创建预设值
* 新增本地日志上传
* QNClient 事件添加类型定义
* [4.2.0](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.2.0)
* 新增多重混音模块
* 日志打点内容调整
* 质量统计算法调整
* 屏幕共享卡顿调优
* 修复偶现无法停止采集的问题
* 修复 Safari 订阅远端音频轨声音异常
* 修复 WebRTC 重连后 trackID 未及时更新
* [4.1.9](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.1.9)
* 修复远端音频无法设置音量问题
* 修复远端音频订阅问题
* [4.1.8](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.1.8)
* 改善弱网下音频通话质量
* [4.1.7](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.1.7)
* 混音新增 setMixingVolume 接口
* 修复混音设置播放音量造成远端无法听到声音的问题
* 修复部分 ios safari 浏览器无法播放发布的本地音乐的问题
* [4.1.6](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.1.6)
* 新增部分日志打点
* 修复 Firefox 大小流兼容性问题
* 修复部分移动端浏览器 audiobuffer 回调无响应问题
* [4.1.5](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.1.5)
* 调整声明文件部分类型描述
* 修复部分事件报错问题
* [4.1.4](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.1.4)
* 房间名与房间用户 ID 最低长度限制调整为 1 位
* [4.1.3](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.1.3)
* 修复 iOS 上使用合流/单路转推时播放画面旋转问题
* [4.1.2](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.1.2)
* 修复日志上传偶现 http 400 错误
* 修复日志错误误报上传问题
* 调整重连失败错误码
* [4.1.1](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.1.1)
* 修复断网重连失败后再次进房特定状态未清空的问题
* 修复偶现蓝牙耳机断开导致没有声音的问题
* [4.1.0](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.1.0)
* 新增跨房媒体转发功能
* 兼容服务端 delete room 接口
* [4.0.9](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.0.9)
* 增加新版本大小流
* 支持 Electron 环境
* [4.0.8](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.0.8)
* 修复 Firefox 中创建 canvas track 失败的问题
* [4.0.7](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.0.7)
* 增加新版本大小流
* 增加设置音频输出设备
* 增加自定义视频和 canvas track 的初始传输模式设置
* 修复外部设备移除后销毁 track 报错的问题
* 修复离开房间后特定状态未清空的问题
* [4.0.6](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.0.6)
* 修复与小程序端互通时听不到声音的问题
* 修复更新合流 pending 的问题
* 修复 play 方法老版本兼容问题
* [4.0.5](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.0.5)
* 增加视频活动检测功能
* 增加单路转推添加 sei 信息功能
* 远端 track ended 时日志优化
* [4.0.4](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.0.4)
* 修复 user-publish 事件 userID 异常的问题
* 修复 QNVideoConfig 类型不准确的问题
* 修复特定设备 sdp 数据异常问题
* 修复远端 track mute 后本地状态未更新的的问题
* 信令新增备用域名
* 新增检测音频轨道是否活跃事件
* track 对象添加获取原生 mediaStreamTrack 的方法
* [4.0.3](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.0.3)
* 修复页面切入后台单路转推中断的问题
* 修复获取远端用户发布 tracks 数据异常的问题
* 修复偶现蓝牙耳机导致无声音问题
* 修复特定设备 sdp 数据异常问题
* 优化了部分手机浏览器的兼容性
* track ended 时自动取消发布
* 仅在播放 CameraTrack 时默认开启镜像模式
* [4.0.2](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.0.2)
* 修复特定条件下大小流设置失败的问题
* 增加 QNCanvasVideoTrack
* 增加视频流播放镜像配置
* [4.0.1](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.0.1)
* 修复特定机型可用性检测兼容问题
* 修复合流背景设置失败问题
* 修复偶现播放失败问题
* 修复外部导入 track 报错
* 修复牛会议进入直播页面导致 admin 用户被踢出
* 支持设置混音音频的本地播放音量
* 增加默认合流支持
* 增加系统声音 tag 设置
* 统一错误码
* [4.0.0](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.0.0)
* 新增核心类 `QNRTC` 和 `QNRTCClient`，移除 `TrackModeSession` 类
* 新增 `QNLocalTrack` 和 `QNRemoteTrack` 及其衍生的子类，对不同类型的音视频轨道做了区分，并提供了丰富的控制接口
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > 产品动态 > Web 更新日志
# Web 更新日志
最近更新时间: 2024-01-29 14:36:22
本文提供 QNRTC Web SDK 4.x 以上版本的发布说明。
> * 若您想要查看 4.x 版本之前的发布说明，可查看 [2.x
> 及之前版本](https://doc.qnsdk.com/rtn/web/docs/sdk_overview.html)
> * 若您正在使用 2.x 或者更低版本的 SDK，并且想要升级至最新版本，则可参考 [4.x
> 版本迁移指南](https://developer.qiniu.com/rtc/development_guidelines/9531/migration-
> guide-web) 进行版本升级。
>
* [4.3.0](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.3.0)
* 移除 QNAudioMixer 类
* MicophoneTrack 移除 createAudoMusicMixer 与 createAudioEffectMixer 方法
* 解决 iOS safari 混音模块无法使用的问题
* 解决部分机型离开房间音频资源未正确释放的问题
* LocalAudioTrack 添加 addAudioFilter 与 removeAudioFilter 方法
* QNRTC 添加 createAudoMusicMixer 与 createAudioEffectMixer 方法
* [4.2.1](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.2.1)
* 新增本地录制功能
* 新增音视频创建预设值
* 新增本地日志上传
* QNClient 事件添加类型定义
* [4.2.0](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.2.0)
* 新增多重混音模块
* 日志打点内容调整
* 质量统计算法调整
* 屏幕共享卡顿调优
* 修复偶现无法停止采集的问题
* 修复 Safari 订阅远端音频轨声音异常
* 修复 WebRTC 重连后 trackID 未及时更新
* [4.1.9](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.1.9)
* 修复远端音频无法设置音量问题
* 修复远端音频订阅问题
* [4.1.8](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.1.8)
* 改善弱网下音频通话质量
* [4.1.7](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.1.7)
* 混音新增 setMixingVolume 接口
* 修复混音设置播放音量造成远端无法听到声音的问题
* 修复部分 ios safari 浏览器无法播放发布的本地音乐的问题
* [4.1.6](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.1.6)
* 新增部分日志打点
* 修复 Firefox 大小流兼容性问题
* 修复部分移动端浏览器 audiobuffer 回调无响应问题
* [4.1.5](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.1.5)
* 调整声明文件部分类型描述
* 修复部分事件报错问题
* [4.1.4](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.1.4)
* 房间名与房间用户 ID 最低长度限制调整为 1 位
* [4.1.3](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.1.3)
* 修复 iOS 上使用合流/单路转推时播放画面旋转问题
* [4.1.2](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.1.2)
* 修复日志上传偶现 http 400 错误
* 修复日志错误误报上传问题
* 调整重连失败错误码
* [4.1.1](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.1.1)
* 修复断网重连失败后再次进房特定状态未清空的问题
* 修复偶现蓝牙耳机断开导致没有声音的问题
* [4.1.0](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.1.0)
* 新增跨房媒体转发功能
* 兼容服务端 delete room 接口
* [4.0.9](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.0.9)
* 增加新版本大小流
* 支持 Electron 环境
* [4.0.8](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.0.8)
* 修复 Firefox 中创建 canvas track 失败的问题
* [4.0.7](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.0.7)
* 增加新版本大小流
* 增加设置音频输出设备
* 增加自定义视频和 canvas track 的初始传输模式设置
* 修复外部设备移除后销毁 track 报错的问题
* 修复离开房间后特定状态未清空的问题
* [4.0.6](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.0.6)
* 修复与小程序端互通时听不到声音的问题
* 修复更新合流 pending 的问题
* 修复 play 方法老版本兼容问题
* [4.0.5](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.0.5)
* 增加视频活动检测功能
* 增加单路转推添加 sei 信息功能
* 远端 track ended 时日志优化
* [4.0.4](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.0.4)
* 修复 user-publish 事件 userID 异常的问题
* 修复 QNVideoConfig 类型不准确的问题
* 修复特定设备 sdp 数据异常问题
* 修复远端 track mute 后本地状态未更新的的问题
* 信令新增备用域名
* 新增检测音频轨道是否活跃事件
* track 对象添加获取原生 mediaStreamTrack 的方法
* [4.0.3](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.0.3)
* 修复页面切入后台单路转推中断的问题
* 修复获取远端用户发布 tracks 数据异常的问题
* 修复偶现蓝牙耳机导致无声音问题
* 修复特定设备 sdp 数据异常问题
* 优化了部分手机浏览器的兼容性
* track ended 时自动取消发布
* 仅在播放 CameraTrack 时默认开启镜像模式
* [4.0.2](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.0.2)
* 修复特定条件下大小流设置失败的问题
* 增加 QNCanvasVideoTrack
* 增加视频流播放镜像配置
* [4.0.1](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.0.1)
* 修复特定机型可用性检测兼容问题
* 修复合流背景设置失败问题
* 修复偶现播放失败问题
* 修复外部导入 track 报错
* 修复牛会议进入直播页面导致 admin 用户被踢出
* 支持设置混音音频的本地播放音量
* 增加默认合流支持
* 增加系统声音 tag 设置
* 统一错误码
* [4.0.0](https://github.com/pili-engineering/QNRTC-Web/releases/tag/v4.0.0)
* 新增核心类 `QNRTC` 和 `QNRTCClient`，移除 `TrackModeSession` 类
* 新增 `QNLocalTrack` 和 `QNRemoteTrack` 及其衍生的子类，对不同类型的音视频轨道做了区分，并提供了丰富的控制接口
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,798 |
Windows 更新日志 | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > 产品动态 > Windows 更新日志
# Windows 更新日志
最近更新时间: 2022-03-24 16:39:34
本文提供 QNRTC Windows SDK 5.x 以上版本的发布说明。
> * 若您想要查看 5.x 版本之前的发布说明，可查看 [3.x
> 及之前版本的更新日志](https://doc.qnsdk.com/rtn/windows/docs/release_notes)
> * 若您正在使用 3.x 或者更低版本的 SDK，并且想要升级至最新版本，则可参考 [5.x
> 版本迁移指南](https://developer.qiniu.com/rtc/development_guidelines/9605/migration-
> guide-window) 进行版本升级。
>
* **5.0.0**
* 新增核心接口类 `QNRTC` 和 `QNRTCClient`，移除 `QNRTCClientInterface`、`QNRTCInterface`、`QNTrackInterface` 接口类
* 新增 `QNLocalTrack` 和 `QNRemoteTrack` 及其衍生的子类，对不同类型的音视频轨道做了区分，并提供了丰富的控制接口
* 优化事件监听逻辑，提供更丰富更具体的事件监听
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > 产品动态 > Windows 更新日志
# Windows 更新日志
最近更新时间: 2022-03-24 16:39:34
本文提供 QNRTC Windows SDK 5.x 以上版本的发布说明。
> * 若您想要查看 5.x 版本之前的发布说明，可查看 [3.x
> 及之前版本的更新日志](https://doc.qnsdk.com/rtn/windows/docs/release_notes)
> * 若您正在使用 3.x 或者更低版本的 SDK，并且想要升级至最新版本，则可参考 [5.x
> 版本迁移指南](https://developer.qiniu.com/rtc/development_guidelines/9605/migration-
> guide-window) 进行版本升级。
>
* **5.0.0**
* 新增核心接口类 `QNRTC` 和 `QNRTCClient`，移除 `QNRTCClientInterface`、`QNRTCInterface`、`QNTrackInterface` 接口类
* 新增 `QNLocalTrack` 和 `QNRemoteTrack` 及其衍生的子类，对不同类型的音视频轨道做了区分，并提供了丰富的控制接口
* 优化事件监听逻辑，提供更丰富更具体的事件监听
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,805 |
WXApp 更新日志 | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > 产品动态 > WXApp 更新日志
# WXApp 更新日志
最近更新时间: 2022-08-22 19:28:43
本文提供 QNRTC WXApp SDK 4.x 以上版本的发布说明。
> * 若您想要查看 4.x 版本之前的开发文档，可查看 [1.x
> 及之前版本](https://doc.qnsdk.com/rtn/wxapp/docs/overview)
> * 若您正在使用 1.x 版本的 SDK，并且想要升级至最新版本，则可参考 [4.x
> 版本迁移指南](https://developer.qiniu.com/rtc/11145/migration-guide-wxapp) 进行版本升级。
>
* [4.0.6](https://github.com/pili-engineering/QNRTC-WxApp/tree/v4.0.6/Release)
* 优化上报日志逻辑及内容
* 修复 `QNPublishStatus.COMPLETED` 字段错误
* 修复离开房间后部分资源未释放问题
* 修复 SDK 偶现无法侦测到断网状态的问题
* [4.0.4](https://github.com/pili-engineering/QNRTC-WxApp/tree/v4.0.4/Release)
* 兼容 `wepy` 框架
* 添加类型文件
* [4.0.2](https://github.com/pili-engineering/QNRTC-WxApp/tree/v4.0.2/Release)
* 新增 `live-player` 与 `live-pusher` 日志上报接口
* 兼容 `UniApp` 小程序
* [4.0.1](https://github.com/pili-engineering/QNRTC-WxApp/tree/v4.0.1/Release)
* 新增核心类 `QNRTC` 和 `QNRTCClient`，移除 `RoomSession` 类
* 新增 `QNLocalTrack` 和 `QNRemoteTrack` 类
* 优化事件监听逻辑
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > 产品动态 > WXApp 更新日志
# WXApp 更新日志
最近更新时间: 2022-08-22 19:28:43
本文提供 QNRTC WXApp SDK 4.x 以上版本的发布说明。
> * 若您想要查看 4.x 版本之前的开发文档，可查看 [1.x
> 及之前版本](https://doc.qnsdk.com/rtn/wxapp/docs/overview)
> * 若您正在使用 1.x 版本的 SDK，并且想要升级至最新版本，则可参考 [4.x
> 版本迁移指南](https://developer.qiniu.com/rtc/11145/migration-guide-wxapp) 进行版本升级。
>
* [4.0.6](https://github.com/pili-engineering/QNRTC-WxApp/tree/v4.0.6/Release)
* 优化上报日志逻辑及内容
* 修复 `QNPublishStatus.COMPLETED` 字段错误
* 修复离开房间后部分资源未释放问题
* 修复 SDK 偶现无法侦测到断网状态的问题
* [4.0.4](https://github.com/pili-engineering/QNRTC-WxApp/tree/v4.0.4/Release)
* 兼容 `wepy` 框架
* 添加类型文件
* [4.0.2](https://github.com/pili-engineering/QNRTC-WxApp/tree/v4.0.2/Release)
* 新增 `live-player` 与 `live-pusher` 日志上报接口
* 兼容 `UniApp` 小程序
* [4.0.1](https://github.com/pili-engineering/QNRTC-WxApp/tree/v4.0.1/Release)
* 新增核心类 `QNRTC` 和 `QNRTCClient`，移除 `RoomSession` 类
* 新增 `QNLocalTrack` 和 `QNRemoteTrack` 类
* 优化事件监听逻辑
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,807 |
Uniapp 更新日志 | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > 产品动态 > Uniapp 更新日志
# Uniapp 更新日志
最近更新时间: 2023-12-18 15:14:18
本文提供 QNRTC Uniapp SDK 版本的发布说明。
* [5.2.7](https://github.com/pili-engineering/QNRTC-Uniapp/tree/v5.2.7/lib)
* 更新 iOS/Android 底层库
* 升级自研音频回声消除算法
* 新增 SDK 内部音视频弱网优化
* 新增多重混音功能，支持同时混音背景音乐和音效
* 新增音频场景化配置功能
* 升级音频回声处理算法, 优化回声处理的兼容性和稳定性
* 支持设置房间重连的超时时间
* 支持跨房连麦
* [1.1.1](https://github.com/pili-engineering/QNRTC-Uniapp/tree/v1.1.1/lib)
* 修复 ios 打包问题
* [1.1.0](https://github.com/pili-engineering/QNRTC-Uniapp/tree/v1.1.0/lib)
* 新增日志打点
* 修复 Android 切换扬声器路由无效问题
* 新增截图功能
* [1.0.7](https://github.com/pili-engineering/QNRTC-Uniapp/tree/v1.0.7/lib)
* QNRemoteAudioTrack 新增 getRemoteVolume 方法
* 修复 iOS 组件无法自适应宽高的问题
* ios component 去除 reset 方法
* [1.0.5](https://github.com/pili-engineering/QNRTC-Uniapp/tree/v1.0.5/lib)
* 新增 d.ts 代码提示功能
* ios component 新增 reset 方法
* [1.0.1](https://github.com/pili-engineering/QNRTC-Uniapp/tree/v1.0.1/lib)
* 新增混音功能及相关事件
* 修复部分事件返回数据为空的问题
* [1.0.0](https://github.com/pili-engineering/QNRTC-Uniapp/tree/v1.0.0/lib)
* 发布 QNRTC Uniapp SDK
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > 产品动态 > Uniapp 更新日志
# Uniapp 更新日志
最近更新时间: 2023-12-18 15:14:18
本文提供 QNRTC Uniapp SDK 版本的发布说明。
* [5.2.7](https://github.com/pili-engineering/QNRTC-Uniapp/tree/v5.2.7/lib)
* 更新 iOS/Android 底层库
* 升级自研音频回声消除算法
* 新增 SDK 内部音视频弱网优化
* 新增多重混音功能，支持同时混音背景音乐和音效
* 新增音频场景化配置功能
* 升级音频回声处理算法, 优化回声处理的兼容性和稳定性
* 支持设置房间重连的超时时间
* 支持跨房连麦
* [1.1.1](https://github.com/pili-engineering/QNRTC-Uniapp/tree/v1.1.1/lib)
* 修复 ios 打包问题
* [1.1.0](https://github.com/pili-engineering/QNRTC-Uniapp/tree/v1.1.0/lib)
* 新增日志打点
* 修复 Android 切换扬声器路由无效问题
* 新增截图功能
* [1.0.7](https://github.com/pili-engineering/QNRTC-Uniapp/tree/v1.0.7/lib)
* QNRemoteAudioTrack 新增 getRemoteVolume 方法
* 修复 iOS 组件无法自适应宽高的问题
* ios component 去除 reset 方法
* [1.0.5](https://github.com/pili-engineering/QNRTC-Uniapp/tree/v1.0.5/lib)
* 新增 d.ts 代码提示功能
* ios component 新增 reset 方法
* [1.0.1](https://github.com/pili-engineering/QNRTC-Uniapp/tree/v1.0.1/lib)
* 新增混音功能及相关事件
* 修复部分事件返回数据为空的问题
* [1.0.0](https://github.com/pili-engineering/QNRTC-Uniapp/tree/v1.0.0/lib)
* 发布 QNRTC Uniapp SDK
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,809 |
产品概述 | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > 产品简介 > 产品概述
# 产品概述
最近更新时间: 2024-06-21 10:32:36
七牛实时音视频(QRTC)，是基于七牛在直播产品上的积累，结合连麦
SDK、自研实时互动流媒体网络，以及强大的云端能力，为客户提供跨平台、高品质的一站式实时互动直播解决方案。基于七牛云
QRTC，零基础搭建音视频平台，快速支持一对一视频通话、多人会议、连麦直播、语音互动等多种业务场景。
> 目前，QRTC 有新旧两套版本并行：
>
> * 新版本：4.x 及之后的版本
> * 旧版本：3.x 及之前的版本
>
其中，新版本是基于旧版本进行了接口重构的版本，新版本接口结构更清晰，接入更简单。若无特殊需求，我们建议您使用新版本 SDK 进行接入，对于正在使用旧版
SDK 的开发者，可以参考各端的迁移指南，进行版本迁移。 当前文档站为
[新版本的开发文档](https://developer.qiniu.com/rtc/8802/pd-
overview)。本文将为您提供目录索引，以便您能更好更快的了解实时音视频产品的接入方式。 若有需要，您仍可查看 [3.x
及之前版本的开发文档](https://doc.qnsdk.com/rtn) 注意：5.x 版本是基于 4.x 版本开发的重构版本，SDK 使用了统一的
C++ RTC 内核, 保证了 QRTC 在各个端上处理逻辑的一致性，同时接口和 4.x 完全兼容。若您使用的是 4.x 的版本，可直接进行升级；若您使用的
3.x 及之前的版本，可参考各端的迁移指南，进行版本迁移。
# 从 3.x 向 4.x 版本迁移
[Android 迁移指南](https://developer.qiniu.com/rtc/9394/migration-guide-android) | [iOS 迁移指南](https://developer.qiniu.com/rtc/9538/migration-guide-iOS) | [Web 迁移指南](https://developer.qiniu.com/rtc/9531/migration-guide-web) | [Windows 迁移指南](https://developer.qiniu.com/rtc/9605/migration-guide-window) | [WXApp 迁移指南](https://developer.qiniu.com/rtc/11145/migration-guide-wxapp)
---|---|---|---|---
# 产品说明
产品简介 | 产品动态 | 购买指南
---|---|---
[产品概述](https://developer.qiniu.com/rtc/8802/pd-overview) | [Android 更新日志](https://developer.qiniu.io/rtc/9399/update-log-android) | [价格说明](https://developer.qiniu.com/rtc/8804/pd-price)
[接入流程](https://developer.qiniu.com/rtc/10155/process) | [iOS 更新日志](https://developer.qiniu.io/rtc/9672/update-log-iOS) |
[核心功能](https://developer.qiniu.com/rtc/8803/pd-function) | [Web 更新日志](https://developer.qiniu.io/rtc/9677/update-log-for-web) |
[应用场景](https://developer.qiniu.com/rtc/10077/app-scenarios) | [Windows 更新日志](https://developer.qiniu.io/rtc/9673/update-log-windows) |
| [WXapp 更新日志](https://developer.qiniu.com/rtc/11151/update-log-for-wxapp) |
| [Uniapp 更新日志](https://developer.qiniu.com/rtc/11850/update-log-for-uniapp) |
| [Linux 更新日志](https://developer.qiniu.com/rtc/11852/linux-update-the-solstice) |
# 快速入门
控制台 | Android | iOS | Web | Windows | WXApp | Uniapp | Linux
---|---|---|---|---|---|---|---
[控制台说明](https://developer.qiniu.com/rtc/10069/the-console-shows) | [SDK 概览](https://developer.qiniu.com/rtc/8764/an-overview-of-the-android-sdk) | [SDK 概览](https://developer.qiniu.com/rtc/8830/an-overview-of-the-ios-sdk) | [SDK 概览](https://developer.qiniu.com/rtc/9478/an-overview-of-the-web-sd) | [SDK 概览](https://developer.qiniu.com/rtc/9536/windows-overview-of-the-sdk) | [SDK 概览](https://developer.qiniu.com/rtc/11118/an-overview-of-the-wxapp-sd) | [SDK 概览](https://developer.qiniu.com/rtc/11847/an-overview-of-the-uniapp-sdk) | [SDK 概览](https://developer.qiniu.com/rtc/11364/sdk-overview-linux)
[管理实时音视频](https://developer.qiniu.com/rtc/9858/applist) | [开发准备](https://developer.qiniu.com/rtc/8765/prepare-android-development) | [开发准备](https://developer.qiniu.com/rtc/8831/prepare-ios-development) | [开发准备](https://developer.qiniu.com/rtc/9476/prepare-web-development) | [开发准备](https://developer.qiniu.com/rtc/9537/windows-preparation) | [开发准备](https://developer.qiniu.com/rtc/11119/prepare-wxapp-development) | [开发准备](https://developer.qiniu.com/rtc/11848/prepare-uniapp-development) | [开发准备](https://developer.qiniu.com/rtc/11365/preparation-linux)
| [快速开始](https://developer.qiniu.com/rtc/8766/quick-start-android) | [快速开始](https://developer.qiniu.com/rtc/9255/quick-start-iOS) | [快速开始](https://developer.qiniu.com/rtc/9477/quick-start-websit) | [快速开始](https://developer.qiniu.com/rtc/9543/windows-rtc-quick-start) | [快速开始](https://developer.qiniu.com/rtc/11120/quick-start-wxapp) | [快速开始](https://developer.qiniu.com/rtc/11849/quick-start-uniapp) | [快速开始](https://developer.qiniu.com/rtc/11366/quick-start-linux)
| | | [浏览器兼容性说明](https://developer.qiniu.com/rtc/10493/browser-support) | | |
# 使用指南
Android | iOS | Web | Windows | 服务端 | WXApp | Uniapp | Linux
---|---|---|---|---|---|---|---
[初始化](https://developer.qiniu.com/rtc/8727/initialization-android) | [初始化](https://developer.qiniu.com/rtc/9257/user-guidance-iOS) | [初始化](https://developer.qiniu.com/rtc/9386/user-guidance-web) | [初始化](https://developer.qiniu.com/rtc/9545/user-guidance-windows) | [服务端说明](https://developer.qiniu.com/rtc/8805/server-overview) | [初始化](https://developer.qiniu.com/rtc/11146/user-guidance-wxapp) | [初始化](https://developer.qiniu.com/rtc/11837/initialization-uniapp) | [初始化](https://developer.qiniu.com/rtc/11368/initialization-linux)
[音视频采集](https://developer.qiniu.com/rtc/8767/audio-and-video-collection-android) | [音视频采集](https://developer.qiniu.com/rtc/9258/audio-and-video-collection-iOS) | [音视频采集](https://developer.qiniu.com/rtc/9387/audio-and-video-collection-web) | [音视频采集](https://developer.qiniu.com/rtc/9546/audio-and-video-collection-windows) | [服务端 SDK](https://developer.qiniu.com/rtc/8812/serversdk) | [房间管理](https://developer.qiniu.com/rtc/11147/room-management-wxapp) | [音视频采集](https://developer.qiniu.com/rtc/11838/audio-and-video-collection-uniapp) | [音视频采集](https://developer.qiniu.com/rtc/11371/media-capture-linux)
[房间管理](https://developer.qiniu.com/rtc/8768/room-management-android) | [房间管理](https://developer.qiniu.com/rtc/9261/room-management-iOS) | [房间管理](https://developer.qiniu.com/rtc/9465/room-management-web) | [房间管理](https://developer.qiniu.com/rtc/9547/room-management-windows) | [roomToken](https://developer.qiniu.com/rtc/8813/roomToken) | [发布和订阅](https://developer.qiniu.com/rtc/11148/publish-and-subscribe-wxapp) | [房间管理](https://developer.qiniu.com/rtc/11841/room-management-uniapp) | [房间管理](https://developer.qiniu.com/rtc/11373/room-management-linux)
[发布和订阅](https://developer.qiniu.com/rtc/8769/publish-and-subscribe-android) | [发布和订阅](https://developer.qiniu.com/rtc/9260/publish-and-subscribe-iOS) | [发布和订阅](https://developer.qiniu.com/rtc/9467/publish-and-subscribe-website) | [发布和订阅](https://developer.qiniu.com/rtc/9548/publish-and-subscribe-windows) | [应用管理](https://developer.qiniu.com/rtc/8814/api-app) | [CDN 转推](https://developer.qiniu.com/rtc/11149/turn-the-cdn-push-wxapp) | [发布和订阅](https://developer.qiniu.com/rtc/11843/publish-and-subscribe-uniapp) | [发布和订阅](https://developer.qiniu.com/rtc/11372/publish-subscribe-linux)
[CDN 转推](https://developer.qiniu.com/rtc/8770/turn-the-cdn-push-android) | [CDN 转推](https://developer.qiniu.com/rtc/9262/turn-the-cdn-push-iOS) | [CDN 转推](https://developer.qiniu.com/rtc/9468/turn-the-cdn-push-web) | [CDN 转推](https://developer.qiniu.com/rtc/9549/turn-the-cdn-push-windows) | [房间管理](https://developer.qiniu.com/rtc/8815/api-room) | [错误码](https://developer.qiniu.com/rtc/11150/error_code_wxapp) | [CDN 转推](https://developer.qiniu.com/rtc/11842/turn-the-cdn-push-uniapp) | [CDN 转推](https://developer.qiniu.com/rtc/11374/solution-streaming-linux)
[背景音乐混音](https://developer.qiniu.com/rtc/8771/background-music-mix-android) | [背景音乐混音](https://developer.qiniu.com/rtc/9256/%E8%83%8C%E6%99%AF%E9%9F%B3%E4%B9%90%E6%B7%B7%E9%9F%B3%20-%20iOS) | [背景音乐混音](https://developer.qiniu.com/rtc/9470/background-music-mix-web) | [背景音乐混音](https://developer.qiniu.com/rtc/development_guidelines/11177/background-music-mix-windows) | [RTC-Pub](https://developer.qiniu.com/rtc/8816/RTC-Pub) | | [视频大小流](https://developer.qiniu.com/rtc/11844/video-size-flow-uniapp) | [视频大小流](https://developer.qiniu.com/rtc/11370/multi-stream-linux)
[多音效混音](https://developer.qiniu.com/rtc/11965/android_audio_effect_mixing) | [多音效混音](https://developer.qiniu.com/rtc/11979/iOS-audio-effect-mixer) | [视频大小流（旧版）](https://developer.qiniu.com/rtc/9472/video-size-flow-web) | [视频大小流](https://developer.qiniu.com/rtc/9550/video-size-flow-windows) | [合流转推](https://developer.qiniu.com/rtc/8817/api-mergePublish) | | [通话质量统计](https://developer.qiniu.com/rtc/11845/quality-statistics-uniapp) | [通话质量统计](https://developer.qiniu.com/rtc/11375/statistics-linux)
[视频大小流](https://developer.qiniu.com/rtc/8772/video-size-flow-android) | [视频大小流](https://developer.qiniu.com/rtc/9259/multi-stream-iOS) | [通话质量统计](https://developer.qiniu.com/rtc/10233/web-call-quality-statistics) | [通话质量统计](https://developer.qiniu.com/rtc/development_guidelines/11178/call-quality-statistics-windows) | [旁路直播](https://developer.qiniu.com/rtc/8818/api-rtmp) | | | [错误码](https://developer.qiniu.com/rtc/11369/error-code-linux)
[通话质量统计](https://developer.qiniu.com/rtc/9860/quality-statistics-android) | [通话质量统计](https://developer.qiniu.com/rtc/10085/quality-statistics-iOS) | [错误码](https://developer.qiniu.com/rtc/10483/web-error-code) | [错误码](https://developer.qiniu.com/rtc/11350/error-code-windows) | [录制存储](https://developer.qiniu.com/rtc/8819/api-record) | |
[错误码](https://developer.qiniu.com/rtc/9904/rtc-error-code-android) | [错误码](https://developer.qiniu.com/rtc/10084/rtc-error-code-iOS) | [设备管理](https://developer.qiniu.com/rtc/10720/device_management) | | | | |
| | [屏幕共享](https://developer.qiniu.com/rtc/10785/web-screen-sharing) | | | | |
| | [跨房媒体转发](https://developer.qiniu.com/rtc/11359/media-relay-web) | | | | |
| | [视频大小流（新版）](https://developer.qiniu.com/rtc/10566/video-size-flow-web-new) | | | | |
| | [最佳实践](https://developer.qiniu.com/rtc/10266/we-best-practices) | | | | |
| | [浏览器兼容性检测](https://developer.qiniu.com/rtc/10232/check-system-requirements) | | | | |
| | [Electron 环境下使用](https://developer.qiniu.com/rtc/11182/electron) | | | | |
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > 产品简介 > 产品概述
# 产品概述
最近更新时间: 2024-06-21 10:32:36
七牛实时音视频(QRTC)，是基于七牛在直播产品上的积累，结合连麦
SDK、自研实时互动流媒体网络，以及强大的云端能力，为客户提供跨平台、高品质的一站式实时互动直播解决方案。基于七牛云
QRTC，零基础搭建音视频平台，快速支持一对一视频通话、多人会议、连麦直播、语音互动等多种业务场景。
> 目前，QRTC 有新旧两套版本并行：
>
> * 新版本：4.x 及之后的版本
> * 旧版本：3.x 及之前的版本
>
其中，新版本是基于旧版本进行了接口重构的版本，新版本接口结构更清晰，接入更简单。若无特殊需求，我们建议您使用新版本 SDK 进行接入，对于正在使用旧版
SDK 的开发者，可以参考各端的迁移指南，进行版本迁移。 当前文档站为
[新版本的开发文档](https://developer.qiniu.com/rtc/8802/pd-
overview)。本文将为您提供目录索引，以便您能更好更快的了解实时音视频产品的接入方式。 若有需要，您仍可查看 [3.x
及之前版本的开发文档](https://doc.qnsdk.com/rtn) 注意：5.x 版本是基于 4.x 版本开发的重构版本，SDK 使用了统一的
C++ RTC 内核, 保证了 QRTC 在各个端上处理逻辑的一致性，同时接口和 4.x 完全兼容。若您使用的是 4.x 的版本，可直接进行升级；若您使用的
3.x 及之前的版本，可参考各端的迁移指南，进行版本迁移。
# 从 3.x 向 4.x 版本迁移
[Android 迁移指南](https://developer.qiniu.com/rtc/9394/migration-guide-android) | [iOS 迁移指南](https://developer.qiniu.com/rtc/9538/migration-guide-iOS) | [Web 迁移指南](https://developer.qiniu.com/rtc/9531/migration-guide-web) | [Windows 迁移指南](https://developer.qiniu.com/rtc/9605/migration-guide-window) | [WXApp 迁移指南](https://developer.qiniu.com/rtc/11145/migration-guide-wxapp)
---|---|---|---|---
# 产品说明
产品简介 | 产品动态 | 购买指南
---|---|---
[产品概述](https://developer.qiniu.com/rtc/8802/pd-overview) | [Android 更新日志](https://developer.qiniu.io/rtc/9399/update-log-android) | [价格说明](https://developer.qiniu.com/rtc/8804/pd-price)
[接入流程](https://developer.qiniu.com/rtc/10155/process) | [iOS 更新日志](https://developer.qiniu.io/rtc/9672/update-log-iOS) |
[核心功能](https://developer.qiniu.com/rtc/8803/pd-function) | [Web 更新日志](https://developer.qiniu.io/rtc/9677/update-log-for-web) |
[应用场景](https://developer.qiniu.com/rtc/10077/app-scenarios) | [Windows 更新日志](https://developer.qiniu.io/rtc/9673/update-log-windows) |
| [WXapp 更新日志](https://developer.qiniu.com/rtc/11151/update-log-for-wxapp) |
| [Uniapp 更新日志](https://developer.qiniu.com/rtc/11850/update-log-for-uniapp) |
| [Linux 更新日志](https://developer.qiniu.com/rtc/11852/linux-update-the-solstice) |
# 快速入门
控制台 | Android | iOS | Web | Windows | WXApp | Uniapp | Linux
---|---|---|---|---|---|---|---
[控制台说明](https://developer.qiniu.com/rtc/10069/the-console-shows) | [SDK 概览](https://developer.qiniu.com/rtc/8764/an-overview-of-the-android-sdk) | [SDK 概览](https://developer.qiniu.com/rtc/8830/an-overview-of-the-ios-sdk) | [SDK 概览](https://developer.qiniu.com/rtc/9478/an-overview-of-the-web-sd) | [SDK 概览](https://developer.qiniu.com/rtc/9536/windows-overview-of-the-sdk) | [SDK 概览](https://developer.qiniu.com/rtc/11118/an-overview-of-the-wxapp-sd) | [SDK 概览](https://developer.qiniu.com/rtc/11847/an-overview-of-the-uniapp-sdk) | [SDK 概览](https://developer.qiniu.com/rtc/11364/sdk-overview-linux)
[管理实时音视频](https://developer.qiniu.com/rtc/9858/applist) | [开发准备](https://developer.qiniu.com/rtc/8765/prepare-android-development) | [开发准备](https://developer.qiniu.com/rtc/8831/prepare-ios-development) | [开发准备](https://developer.qiniu.com/rtc/9476/prepare-web-development) | [开发准备](https://developer.qiniu.com/rtc/9537/windows-preparation) | [开发准备](https://developer.qiniu.com/rtc/11119/prepare-wxapp-development) | [开发准备](https://developer.qiniu.com/rtc/11848/prepare-uniapp-development) | [开发准备](https://developer.qiniu.com/rtc/11365/preparation-linux)
| [快速开始](https://developer.qiniu.com/rtc/8766/quick-start-android) | [快速开始](https://developer.qiniu.com/rtc/9255/quick-start-iOS) | [快速开始](https://developer.qiniu.com/rtc/9477/quick-start-websit) | [快速开始](https://developer.qiniu.com/rtc/9543/windows-rtc-quick-start) | [快速开始](https://developer.qiniu.com/rtc/11120/quick-start-wxapp) | [快速开始](https://developer.qiniu.com/rtc/11849/quick-start-uniapp) | [快速开始](https://developer.qiniu.com/rtc/11366/quick-start-linux)
| | | [浏览器兼容性说明](https://developer.qiniu.com/rtc/10493/browser-support) | | |
# 使用指南
Android | iOS | Web | Windows | 服务端 | WXApp | Uniapp | Linux
---|---|---|---|---|---|---|---
[初始化](https://developer.qiniu.com/rtc/8727/initialization-android) | [初始化](https://developer.qiniu.com/rtc/9257/user-guidance-iOS) | [初始化](https://developer.qiniu.com/rtc/9386/user-guidance-web) | [初始化](https://developer.qiniu.com/rtc/9545/user-guidance-windows) | [服务端说明](https://developer.qiniu.com/rtc/8805/server-overview) | [初始化](https://developer.qiniu.com/rtc/11146/user-guidance-wxapp) | [初始化](https://developer.qiniu.com/rtc/11837/initialization-uniapp) | [初始化](https://developer.qiniu.com/rtc/11368/initialization-linux)
[音视频采集](https://developer.qiniu.com/rtc/8767/audio-and-video-collection-android) | [音视频采集](https://developer.qiniu.com/rtc/9258/audio-and-video-collection-iOS) | [音视频采集](https://developer.qiniu.com/rtc/9387/audio-and-video-collection-web) | [音视频采集](https://developer.qiniu.com/rtc/9546/audio-and-video-collection-windows) | [服务端 SDK](https://developer.qiniu.com/rtc/8812/serversdk) | [房间管理](https://developer.qiniu.com/rtc/11147/room-management-wxapp) | [音视频采集](https://developer.qiniu.com/rtc/11838/audio-and-video-collection-uniapp) | [音视频采集](https://developer.qiniu.com/rtc/11371/media-capture-linux)
[房间管理](https://developer.qiniu.com/rtc/8768/room-management-android) | [房间管理](https://developer.qiniu.com/rtc/9261/room-management-iOS) | [房间管理](https://developer.qiniu.com/rtc/9465/room-management-web) | [房间管理](https://developer.qiniu.com/rtc/9547/room-management-windows) | [roomToken](https://developer.qiniu.com/rtc/8813/roomToken) | [发布和订阅](https://developer.qiniu.com/rtc/11148/publish-and-subscribe-wxapp) | [房间管理](https://developer.qiniu.com/rtc/11841/room-management-uniapp) | [房间管理](https://developer.qiniu.com/rtc/11373/room-management-linux)
[发布和订阅](https://developer.qiniu.com/rtc/8769/publish-and-subscribe-android) | [发布和订阅](https://developer.qiniu.com/rtc/9260/publish-and-subscribe-iOS) | [发布和订阅](https://developer.qiniu.com/rtc/9467/publish-and-subscribe-website) | [发布和订阅](https://developer.qiniu.com/rtc/9548/publish-and-subscribe-windows) | [应用管理](https://developer.qiniu.com/rtc/8814/api-app) | [CDN 转推](https://developer.qiniu.com/rtc/11149/turn-the-cdn-push-wxapp) | [发布和订阅](https://developer.qiniu.com/rtc/11843/publish-and-subscribe-uniapp) | [发布和订阅](https://developer.qiniu.com/rtc/11372/publish-subscribe-linux)
[CDN 转推](https://developer.qiniu.com/rtc/8770/turn-the-cdn-push-android) | [CDN 转推](https://developer.qiniu.com/rtc/9262/turn-the-cdn-push-iOS) | [CDN 转推](https://developer.qiniu.com/rtc/9468/turn-the-cdn-push-web) | [CDN 转推](https://developer.qiniu.com/rtc/9549/turn-the-cdn-push-windows) | [房间管理](https://developer.qiniu.com/rtc/8815/api-room) | [错误码](https://developer.qiniu.com/rtc/11150/error_code_wxapp) | [CDN 转推](https://developer.qiniu.com/rtc/11842/turn-the-cdn-push-uniapp) | [CDN 转推](https://developer.qiniu.com/rtc/11374/solution-streaming-linux)
[背景音乐混音](https://developer.qiniu.com/rtc/8771/background-music-mix-android) | [背景音乐混音](https://developer.qiniu.com/rtc/9256/%E8%83%8C%E6%99%AF%E9%9F%B3%E4%B9%90%E6%B7%B7%E9%9F%B3%20-%20iOS) | [背景音乐混音](https://developer.qiniu.com/rtc/9470/background-music-mix-web) | [背景音乐混音](https://developer.qiniu.com/rtc/development_guidelines/11177/background-music-mix-windows) | [RTC-Pub](https://developer.qiniu.com/rtc/8816/RTC-Pub) | | [视频大小流](https://developer.qiniu.com/rtc/11844/video-size-flow-uniapp) | [视频大小流](https://developer.qiniu.com/rtc/11370/multi-stream-linux)
[多音效混音](https://developer.qiniu.com/rtc/11965/android_audio_effect_mixing) | [多音效混音](https://developer.qiniu.com/rtc/11979/iOS-audio-effect-mixer) | [视频大小流（旧版）](https://developer.qiniu.com/rtc/9472/video-size-flow-web) | [视频大小流](https://developer.qiniu.com/rtc/9550/video-size-flow-windows) | [合流转推](https://developer.qiniu.com/rtc/8817/api-mergePublish) | | [通话质量统计](https://developer.qiniu.com/rtc/11845/quality-statistics-uniapp) | [通话质量统计](https://developer.qiniu.com/rtc/11375/statistics-linux)
[视频大小流](https://developer.qiniu.com/rtc/8772/video-size-flow-android) | [视频大小流](https://developer.qiniu.com/rtc/9259/multi-stream-iOS) | [通话质量统计](https://developer.qiniu.com/rtc/10233/web-call-quality-statistics) | [通话质量统计](https://developer.qiniu.com/rtc/development_guidelines/11178/call-quality-statistics-windows) | [旁路直播](https://developer.qiniu.com/rtc/8818/api-rtmp) | | | [错误码](https://developer.qiniu.com/rtc/11369/error-code-linux)
[通话质量统计](https://developer.qiniu.com/rtc/9860/quality-statistics-android) | [通话质量统计](https://developer.qiniu.com/rtc/10085/quality-statistics-iOS) | [错误码](https://developer.qiniu.com/rtc/10483/web-error-code) | [错误码](https://developer.qiniu.com/rtc/11350/error-code-windows) | [录制存储](https://developer.qiniu.com/rtc/8819/api-record) | |
[错误码](https://developer.qiniu.com/rtc/9904/rtc-error-code-android) | [错误码](https://developer.qiniu.com/rtc/10084/rtc-error-code-iOS) | [设备管理](https://developer.qiniu.com/rtc/10720/device_management) | | | | |
| | [屏幕共享](https://developer.qiniu.com/rtc/10785/web-screen-sharing) | | | | |
| | [跨房媒体转发](https://developer.qiniu.com/rtc/11359/media-relay-web) | | | | |
| | [视频大小流（新版）](https://developer.qiniu.com/rtc/10566/video-size-flow-web-new) | | | | |
| | [最佳实践](https://developer.qiniu.com/rtc/10266/we-best-practices) | | | | |
| | [浏览器兼容性检测](https://developer.qiniu.com/rtc/10232/check-system-requirements) | | | | |
| | [Electron 环境下使用](https://developer.qiniu.com/rtc/11182/electron) | | | | |
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,812 |
接入流程 | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > 产品简介 > 接入流程
# 接入流程
最近更新时间: 2021-11-12 16:03:20
本文内容与[控制台说明 __](https://developer.qiniu.com/rtc/10069/the-console-
shows)相同，控制台的使用是接入实时音视频产品的第一步。
为方便开发者使用，我们将七牛实时互动产品系列中三项产品（实时音视频、互动白板、即时通讯）的控制台合为一处。
若需获取另外两项产品的接入文档，请点击访问 [互动白板接入文档
__](https://developer.qiniu.com/whiteboard)或[即时通讯接入文档
__](https://developer.qiniu.com/IM)
**[控制台 __](https://portal.qiniu.com/rtn/app)为开发者提供了如下功能：**
1.应用管理（应用列表、新建应用、编辑应用、删除应用等）
2.管理实时音视频，包括房间管理、合流配置、活跃房间等
3.管理互动白板，管理互动白板的功能配置等。
4.管理即时通讯，管理即时通讯的基础配置、套餐容量、高级功能等。
5.用量统计，查看实时音视频使用时长、互动白板使用时长、即时通讯日活情况等。
**为更好的使用实时音视频产品，请先了解如下的基本接入流程：**
# 1.官网注册
通过 [注册页面 __](https://portal.qiniu.com/signup)进行账号注册。
# 2.登录并实名认证
[登录 __](https://sso.qiniu.com/)到管理控制台，并完成[实名认证
__](https://portal.qiniu.com/identity/choice)
# 3.创建应用
前往 [实时音视频 __](https://portal.qiniu.com/rtn/app)产品管理控制台创建应用
# 4.管理应用
前往[应用列表
__](https://portal.qiniu.com/rtn/app)，点击查看详情，进入应用的管理界面，分别管理实时音视频、互动白板、即时通讯等服务的配置
# 5.集成开发
可以参考快速入门、使用指南 和 API文档 等内容进行[集成开发 __](https://developer.qiniu.com/rtc)。
# 6.查看用量
前往[用量统计 __](https://portal.qiniu.com/rtn/statistics/rtc)页面可查看每日实际用量。
# 7.获取支持
若有商务方面的问题，可联系与您对接的商务经理，或联系 400-808-9176 转 1 获取商务支持。
若在集成开发过程中，需要技术支持，可通过工单系统[提交工单
__](https://support.qiniu.com/tickets/new/?space=%E5%AE%9E%E6%97%B6%E9%9F%B3%E8%A7%86%E9%A2%91%E4%BA%91)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > 产品简介 > 接入流程
# 接入流程
最近更新时间: 2021-11-12 16:03:20
本文内容与[控制台说明 __](https://developer.qiniu.com/rtc/10069/the-console-
shows)相同，控制台的使用是接入实时音视频产品的第一步。
为方便开发者使用，我们将七牛实时互动产品系列中三项产品（实时音视频、互动白板、即时通讯）的控制台合为一处。
若需获取另外两项产品的接入文档，请点击访问 [互动白板接入文档
__](https://developer.qiniu.com/whiteboard)或[即时通讯接入文档
__](https://developer.qiniu.com/IM)
**[控制台 __](https://portal.qiniu.com/rtn/app)为开发者提供了如下功能：**
1.应用管理（应用列表、新建应用、编辑应用、删除应用等）
2.管理实时音视频，包括房间管理、合流配置、活跃房间等
3.管理互动白板，管理互动白板的功能配置等。
4.管理即时通讯，管理即时通讯的基础配置、套餐容量、高级功能等。
5.用量统计，查看实时音视频使用时长、互动白板使用时长、即时通讯日活情况等。
**为更好的使用实时音视频产品，请先了解如下的基本接入流程：**
# 1.官网注册
通过 [注册页面 __](https://portal.qiniu.com/signup)进行账号注册。
# 2.登录并实名认证
[登录 __](https://sso.qiniu.com/)到管理控制台，并完成[实名认证
__](https://portal.qiniu.com/identity/choice)
# 3.创建应用
前往 [实时音视频 __](https://portal.qiniu.com/rtn/app)产品管理控制台创建应用
# 4.管理应用
前往[应用列表
__](https://portal.qiniu.com/rtn/app)，点击查看详情，进入应用的管理界面，分别管理实时音视频、互动白板、即时通讯等服务的配置
# 5.集成开发
可以参考快速入门、使用指南 和 API文档 等内容进行[集成开发 __](https://developer.qiniu.com/rtc)。
# 6.查看用量
前往[用量统计 __](https://portal.qiniu.com/rtn/statistics/rtc)页面可查看每日实际用量。
# 7.获取支持
若有商务方面的问题，可联系与您对接的商务经理，或联系 400-808-9176 转 1 获取商务支持。
若在集成开发过程中，需要技术支持，可通过工单系统[提交工单
__](https://support.qiniu.com/tickets/new/?space=%E5%AE%9E%E6%97%B6%E9%9F%B3%E8%A7%86%E9%A2%91%E4%BA%91)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,818 |
核心功能 | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > 产品简介 > 核心功能
# 核心功能
最近更新时间: 2021-11-12 16:16:43
本文将着重说明一些核心功能和基础概念，以帮助开发者更好的理解实时音视频产品
# 产品架构图
# 客户端功能
主要负责客户端的音视频采集、渲染、滤镜处理、编解码、传输等工作，客户可以快速集成到自己 App 中，让自己的应用具备音视频通话的能力。 支持
Android、iOS、Web ，集成 SDK 就可实现音视频的采集、编解码、渲染播放等工作，方便客户植入互动音视频服务
不在需要开发复杂的音视频底层逻辑，只需要调用七牛 SDK 的接口即可以快速完成开发； 包含直播丰富的扩展功能，例如：美颜、滤镜、面部特效。 此外，客户端
SDK 有丰富的扩展性、兼容性和自定义开发能力。客户不仅可以使用七牛免费提供的美颜和滤镜，也可以通过扩展功能，选择接入市面任何一家美颜、滤镜、面部特效的
SDK 供应商。
功能名称 | 说明
---|---
音视频采集 | 涉及音视频采集过程中的各种操作及设置
房间管理 | 涉及房间的创建到销毁，全生命周期的管理
发布和订阅 | 涉及发布流和订阅流等常见媒体流操作
CDN 转推 | 涉及单路转推和合流转推的使用方法，用于将媒体流转推至cdn，进行旁路直播
背景音乐混音 | 涉及如何添加和移除背景音乐等操作，常用于娱乐类场景中
视频大小流 | 涉及音视频多码率的操作，常用于带宽紧张的场景中
# 服务端功能
服务端主要提供房间管理、状态回调等基本的业务功能，另外还提供鉴黄鉴暴、质量分析等配套功能 只需要集成对应语言的服务端 SDK
即可以管理实时音视频互动房间、调用配套数据处理服务、向客户端通知音视频流和数据处理的状态。业务服务器主要负责信令交互、音视频传输、代理加速等工作，保证音视频互动延时低，可用性高。
功能 | 说明
---|---
roomToken | 在进入一个实时音视频房间之前，您需要通过自己七牛云账户的 AK/SK 签算出一个 roomToken。
应用管理 | 创建应用、获取应用信息、删除应用、更新应用信息。
房间管理 | 踢人、获取活跃房间、获取房间活跃用户 。
RTC-Pub | 可称为“在线媒体流接入”功能，可将允许将视频文件转推到RTC连麦房间内，供房间内的其他用户订阅。
单路转推 | 直接将房间中某路媒体流转推到CDN。
合流转推 | 设置合流的宽高、帧率、码率等信息，支持纯音频合流。
旁路直播 | 使用单路转推或合流转推后，可在直播云查看旁路直播情况。
录制存储 | 使用单路转推或合流转推后，可对旁路直播的媒体流内容进行录制存储。
内容审核 | 使用单路转推或合流转推后，可对旁路直播的媒体流内容进行鉴黄鉴暴恐，可参考[内容审核 __](https://www.qiniu.com/products/censor)产品
质量监控 | 结合七牛大数据产品，提供多维度的质量数据监控和分析，可参考 [机器数据分析平台 __](https://www.qiniu.com/products/pandora)产品
# 实时互动网络
七牛基于直播云布局的全球丰富节点，推出了低延时互通的实时互动网络（包括丰富的云端配套功能），这是一种新型的专为实时传输而设计的网络架构，基于 UDP 协议。
通过在互联网上不同地区的数据中心放置软件组网单元，相互连接互相调度，在现有的公共互联网基础上构建一层新的虚拟网络。
七牛实时互动网络能够实时根据各节点的连接和传输状况、
负载状况以及到用户的距离和响应时间，自动分配最优、最通畅的传输路径，达到实时传输需要的质量保障级别。能应互联网实时传输的需求，尤其是在互联网信号不稳定，传输效率不佳的情况下，保证稳定传输及低延时。此外，七牛音视频团队基于对国内外各类营运商的了解，构建了一套非常稳定高效的调度机制，为整个实时互动流媒体网络找到最合适媒体。
以下介绍一些实时音视频中常用到的基本概念
# 应用
**应用** 是您在七牛云实时音视频应用中的一个业务上的划分方式，以**应用 ID(AppID)** 作为唯一的标识符。**一个 APP
或者项目使用一个应用** ，同一个 APP 的不同平台（iOS、Android、Windows、Web）可共享一个应用，无需重复创建。
您可以通过[七牛控制台](https://portal.qiniu.com/rtn/app)来进行**应用的创建和编辑**
。如果您还没有注册七牛开发者平台，具体流程请参考[七牛实时音视频云接入指南](https://doc.qnsdk.com/rtn/docs/rtn_startup)。
> * 不同应用之间的数据不互通，房间也无法连通。
> * 一个应用对应一个唯一的 AppID，AppID 可用于后续的排障以及 RoomToken 的签算等工作。
>
# 房间
**房间** 是对音视频对话空间的抽象，用于隔离不同的通话过程，保障数据的安全及独立。同一房间内的用户可以互相接收对方的音视频数据。以 `RoomName`
为标识，需满足 `^[a-zA-Z0-9_-]{3,64}$` 的规格。**加入房间需要携带RoomToken**。
> * 当用户加入的房间不存在时，七牛后台服务会自动创建对应的房间。
> * 若房间内的所有用户都已离开，那么房间维持空状态 10s 后将会自动关闭。
> * 若房间为服务端创建，且创建后无用户进入，那么房间维持空状态 30s 后将会自动关闭。
> * 若房间内的用户由于断网等原因，30s 未向七牛后台服务通信，则该用户将被视为退出房间。
>
# UserID
**UserID** 是实时音视频通话房间内用户的唯一标识。
> * UserID 支持字母、数字、中划线、下划线，区分大小写。
> * 同一房间内 UserID
> 唯一，若有重复，则根据[七牛控制台上应用](https://portal.qiniu.com/rtn/app)对自动踢人配置，做相应的处理。
>
# RoomToken
**RoomToken** 是加入房间需要携带的凭证信息，是基于 AppID、RoomName、UserID
以及过期时间等信息按照一定规则生成的，其具体的签算方式可参考 [RoomToken
签发服务](https://developer.qiniu.com/rtc/development_guidelines/8813/roomToken)。
# Track
**Track** 代表音视频通话过程中的**一条音频轨** 或者**一条视频轨** ，是音视频通话的最小单位。
> * 一个用户可以创建多条音视频的 Track，如摄像头视频 Track、录屏视频 Track 和麦克风音频 Track 等
> * 音频 Track 仅支持创建一路，重复创建将创建失败
>
# 发布
**发布** 是指将创建好的音视频 Track 对应的音视频数据推送到七牛实时音视频服务的操作，执行发布操作后，远端用户可以选择性的进行订阅观看。
> 不同于 CDN 推流，此处的发布指的是房间内的音视频数据推送，将不会产生 rtmp 的直播观看地址
# 订阅
**订阅** 是指向七牛实时音视频服务请求拉取远端发布的音视频数据的操作。订阅后，本地即可实时的接收远端发布的音视频数据。
> 不同于 rtmp 拉流观看，此处的订阅指的是房间内的音视频数据接收，是基于实时性更好的 RTP 协议进行传输的
# CDN 推流
## 单路转推
**单路转推** 是指将客户端推送的一路音频 Track 和一路视频 Track 在服务端直接进行协议转换，再经由 CDN
分发的场景。由于不涉及服务端转码合流的操作，因此仅会产生单路转推场景的费用，费用相关可参考[单路转推费用文档](https://developer.qiniu.com/rtc/product_introduction/8804/pd-
price#4)。更详细的说明可参考使用指南相关文档。
> 单路转推最多仅支持一路音频和一路视频的 CDN 分发，无法进行多路画面和多路音频的合流操作
## 合流转推
**合流转推** 是指将房间内的多路音频进行混音，多路视频进行合流，再以 rtmp 推流的形式经由 CDN
分发的场景。该场景涉及到服务端的合流操作，将会产生合流相关的费用，费用相关可参考[合流转推费用文档](https://developer.qiniu.com/rtc/product_introduction/8804/pd-
price#5)。更详细的说明可参考使用指南相关文档。
# 大小流
**大小流** 是指用户发布视频 Track 时，基于该 Track 推送多路不同分辨率的视频码流，订阅端用户可以根据自己的需求选择订阅该 Track
的其中一路视频流。例如本地网络较差时，可选择订阅低分辨率的流；网络较好时，则可以选择订阅高分辨率的流。更详细的说明可参考使用指南相关文档。
> 订阅时指定的 profile 仅为预期设置，实际订阅是否成功，以 Track 相关回调通知的实际结果为准。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > 产品简介 > 核心功能
# 核心功能
最近更新时间: 2021-11-12 16:16:43
本文将着重说明一些核心功能和基础概念，以帮助开发者更好的理解实时音视频产品
# 产品架构图
# 客户端功能
主要负责客户端的音视频采集、渲染、滤镜处理、编解码、传输等工作，客户可以快速集成到自己 App 中，让自己的应用具备音视频通话的能力。 支持
Android、iOS、Web ，集成 SDK 就可实现音视频的采集、编解码、渲染播放等工作，方便客户植入互动音视频服务
不在需要开发复杂的音视频底层逻辑，只需要调用七牛 SDK 的接口即可以快速完成开发； 包含直播丰富的扩展功能，例如：美颜、滤镜、面部特效。 此外，客户端
SDK 有丰富的扩展性、兼容性和自定义开发能力。客户不仅可以使用七牛免费提供的美颜和滤镜，也可以通过扩展功能，选择接入市面任何一家美颜、滤镜、面部特效的
SDK 供应商。
功能名称 | 说明
---|---
音视频采集 | 涉及音视频采集过程中的各种操作及设置
房间管理 | 涉及房间的创建到销毁，全生命周期的管理
发布和订阅 | 涉及发布流和订阅流等常见媒体流操作
CDN 转推 | 涉及单路转推和合流转推的使用方法，用于将媒体流转推至cdn，进行旁路直播
背景音乐混音 | 涉及如何添加和移除背景音乐等操作，常用于娱乐类场景中
视频大小流 | 涉及音视频多码率的操作，常用于带宽紧张的场景中
# 服务端功能
服务端主要提供房间管理、状态回调等基本的业务功能，另外还提供鉴黄鉴暴、质量分析等配套功能 只需要集成对应语言的服务端 SDK
即可以管理实时音视频互动房间、调用配套数据处理服务、向客户端通知音视频流和数据处理的状态。业务服务器主要负责信令交互、音视频传输、代理加速等工作，保证音视频互动延时低，可用性高。
功能 | 说明
---|---
roomToken | 在进入一个实时音视频房间之前，您需要通过自己七牛云账户的 AK/SK 签算出一个 roomToken。
应用管理 | 创建应用、获取应用信息、删除应用、更新应用信息。
房间管理 | 踢人、获取活跃房间、获取房间活跃用户 。
RTC-Pub | 可称为“在线媒体流接入”功能，可将允许将视频文件转推到RTC连麦房间内，供房间内的其他用户订阅。
单路转推 | 直接将房间中某路媒体流转推到CDN。
合流转推 | 设置合流的宽高、帧率、码率等信息，支持纯音频合流。
旁路直播 | 使用单路转推或合流转推后，可在直播云查看旁路直播情况。
录制存储 | 使用单路转推或合流转推后，可对旁路直播的媒体流内容进行录制存储。
内容审核 | 使用单路转推或合流转推后，可对旁路直播的媒体流内容进行鉴黄鉴暴恐，可参考[内容审核 __](https://www.qiniu.com/products/censor)产品
质量监控 | 结合七牛大数据产品，提供多维度的质量数据监控和分析，可参考 [机器数据分析平台 __](https://www.qiniu.com/products/pandora)产品
# 实时互动网络
七牛基于直播云布局的全球丰富节点，推出了低延时互通的实时互动网络（包括丰富的云端配套功能），这是一种新型的专为实时传输而设计的网络架构，基于 UDP 协议。
通过在互联网上不同地区的数据中心放置软件组网单元，相互连接互相调度，在现有的公共互联网基础上构建一层新的虚拟网络。
七牛实时互动网络能够实时根据各节点的连接和传输状况、
负载状况以及到用户的距离和响应时间，自动分配最优、最通畅的传输路径，达到实时传输需要的质量保障级别。能应互联网实时传输的需求，尤其是在互联网信号不稳定，传输效率不佳的情况下，保证稳定传输及低延时。此外，七牛音视频团队基于对国内外各类营运商的了解，构建了一套非常稳定高效的调度机制，为整个实时互动流媒体网络找到最合适媒体。
以下介绍一些实时音视频中常用到的基本概念
# 应用
**应用** 是您在七牛云实时音视频应用中的一个业务上的划分方式，以**应用 ID(AppID)** 作为唯一的标识符。**一个 APP
或者项目使用一个应用** ，同一个 APP 的不同平台（iOS、Android、Windows、Web）可共享一个应用，无需重复创建。
您可以通过[七牛控制台](https://portal.qiniu.com/rtn/app)来进行**应用的创建和编辑**
。如果您还没有注册七牛开发者平台，具体流程请参考[七牛实时音视频云接入指南](https://doc.qnsdk.com/rtn/docs/rtn_startup)。
> * 不同应用之间的数据不互通，房间也无法连通。
> * 一个应用对应一个唯一的 AppID，AppID 可用于后续的排障以及 RoomToken 的签算等工作。
>
# 房间
**房间** 是对音视频对话空间的抽象，用于隔离不同的通话过程，保障数据的安全及独立。同一房间内的用户可以互相接收对方的音视频数据。以 `RoomName`
为标识，需满足 `^[a-zA-Z0-9_-]{3,64}$` 的规格。**加入房间需要携带RoomToken**。
> * 当用户加入的房间不存在时，七牛后台服务会自动创建对应的房间。
> * 若房间内的所有用户都已离开，那么房间维持空状态 10s 后将会自动关闭。
> * 若房间为服务端创建，且创建后无用户进入，那么房间维持空状态 30s 后将会自动关闭。
> * 若房间内的用户由于断网等原因，30s 未向七牛后台服务通信，则该用户将被视为退出房间。
>
# UserID
**UserID** 是实时音视频通话房间内用户的唯一标识。
> * UserID 支持字母、数字、中划线、下划线，区分大小写。
> * 同一房间内 UserID
> 唯一，若有重复，则根据[七牛控制台上应用](https://portal.qiniu.com/rtn/app)对自动踢人配置，做相应的处理。
>
# RoomToken
**RoomToken** 是加入房间需要携带的凭证信息，是基于 AppID、RoomName、UserID
以及过期时间等信息按照一定规则生成的，其具体的签算方式可参考 [RoomToken
签发服务](https://developer.qiniu.com/rtc/development_guidelines/8813/roomToken)。
# Track
**Track** 代表音视频通话过程中的**一条音频轨** 或者**一条视频轨** ，是音视频通话的最小单位。
> * 一个用户可以创建多条音视频的 Track，如摄像头视频 Track、录屏视频 Track 和麦克风音频 Track 等
> * 音频 Track 仅支持创建一路，重复创建将创建失败
>
# 发布
**发布** 是指将创建好的音视频 Track 对应的音视频数据推送到七牛实时音视频服务的操作，执行发布操作后，远端用户可以选择性的进行订阅观看。
> 不同于 CDN 推流，此处的发布指的是房间内的音视频数据推送，将不会产生 rtmp 的直播观看地址
# 订阅
**订阅** 是指向七牛实时音视频服务请求拉取远端发布的音视频数据的操作。订阅后，本地即可实时的接收远端发布的音视频数据。
> 不同于 rtmp 拉流观看，此处的订阅指的是房间内的音视频数据接收，是基于实时性更好的 RTP 协议进行传输的
# CDN 推流
## 单路转推
**单路转推** 是指将客户端推送的一路音频 Track 和一路视频 Track 在服务端直接进行协议转换，再经由 CDN
分发的场景。由于不涉及服务端转码合流的操作，因此仅会产生单路转推场景的费用，费用相关可参考[单路转推费用文档](https://developer.qiniu.com/rtc/product_introduction/8804/pd-
price#4)。更详细的说明可参考使用指南相关文档。
> 单路转推最多仅支持一路音频和一路视频的 CDN 分发，无法进行多路画面和多路音频的合流操作
## 合流转推
**合流转推** 是指将房间内的多路音频进行混音，多路视频进行合流，再以 rtmp 推流的形式经由 CDN
分发的场景。该场景涉及到服务端的合流操作，将会产生合流相关的费用，费用相关可参考[合流转推费用文档](https://developer.qiniu.com/rtc/product_introduction/8804/pd-
price#5)。更详细的说明可参考使用指南相关文档。
# 大小流
**大小流** 是指用户发布视频 Track 时，基于该 Track 推送多路不同分辨率的视频码流，订阅端用户可以根据自己的需求选择订阅该 Track
的其中一路视频流。例如本地网络较差时，可选择订阅低分辨率的流；网络较好时，则可以选择订阅高分辨率的流。更详细的说明可参考使用指南相关文档。
> 订阅时指定的 profile 仅为预期设置，实际订阅是否成功，以 Track 相关回调通知的实际结果为准。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,822 |
应用场景 | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > 产品简介 > 应用场景
# 应用场景
最近更新时间: 2021-11-05 17:01:08
目前实时音视频及相关产品服务，可以应用在很多实时互动场景领域，例如
1.社交娱乐
2.在线教育
3.视频会议
4.电商直播
5.在线客服
6.远程医疗
# 1.社交娱乐
支持QQ、微信、陌陌等社交应用的一对一视频互动及主播之间一起直播，带来比传统单向直播不一样的体验。
自带美颜滤镜，第三方美颜贴纸、人脸识别，让直播过程更有趣。 48KHz采样率、全频带编解码以及对音乐场景的特殊优化保证观众可以听到最优质的声音。
# 2.在线教育
自定义的布局功能允许开发者按照自己的业务需求调整老师和连麦学生的显示位置。
旁路直播功能加上七牛云的直播功能，实现观众人数无上限，让更多学生享受在线教育的便利。
搭配使用聊天室功能，文字、语音、图片、视频包括自定义消息等，更多的互动方式有效提升课堂氛围。
服务端录制对接点播平台，支持课程录制以及在线回放，让优质资源服务更多学生。
# 3.视频会议
小范围实时音视频互动，提供多种视频连麦布局模板，更提供自定义布局方式，保证会议发言者互相之间的实时性，提升普通观众的观看体验。
提供七牛云自有直播分发服务，可实现 HLS、RTMP、HTTP 等多种直播分发形式，支持更多人通过拉取直播流收看会议内容，适合大型的企业在线会议。
支持动态邀人，踢人、禁音，禁视会议权限分级控制。 客户可以利用七牛的实时音视频互动技术轻松做出一款类似 WebEx 的应用。
# 4.电商直播
提供连麦，转码、封装、超低延时等功能，都能通过七牛云快速搭建业务，节约研发成本和开发周期，快速上线
# 5.在线客服
线上开展音视频对话，对客户的资信情况进行审核，为金融科技企业促成在线签约，视频开户验证。
提供云端存储空间及海量数据的处理能力，提供的高可用的技术和高稳定的平台。
# 6.远程医疗
支持远程多方视频会诊，突破医疗资源的地域限制，以及系统平台限制，提高医患时间地域灵活性，降低诊断成本。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > 产品简介 > 应用场景
# 应用场景
最近更新时间: 2021-11-05 17:01:08
目前实时音视频及相关产品服务，可以应用在很多实时互动场景领域，例如
1.社交娱乐
2.在线教育
3.视频会议
4.电商直播
5.在线客服
6.远程医疗
# 1.社交娱乐
支持QQ、微信、陌陌等社交应用的一对一视频互动及主播之间一起直播，带来比传统单向直播不一样的体验。
自带美颜滤镜，第三方美颜贴纸、人脸识别，让直播过程更有趣。 48KHz采样率、全频带编解码以及对音乐场景的特殊优化保证观众可以听到最优质的声音。
# 2.在线教育
自定义的布局功能允许开发者按照自己的业务需求调整老师和连麦学生的显示位置。
旁路直播功能加上七牛云的直播功能，实现观众人数无上限，让更多学生享受在线教育的便利。
搭配使用聊天室功能，文字、语音、图片、视频包括自定义消息等，更多的互动方式有效提升课堂氛围。
服务端录制对接点播平台，支持课程录制以及在线回放，让优质资源服务更多学生。
# 3.视频会议
小范围实时音视频互动，提供多种视频连麦布局模板，更提供自定义布局方式，保证会议发言者互相之间的实时性，提升普通观众的观看体验。
提供七牛云自有直播分发服务，可实现 HLS、RTMP、HTTP 等多种直播分发形式，支持更多人通过拉取直播流收看会议内容，适合大型的企业在线会议。
支持动态邀人，踢人、禁音，禁视会议权限分级控制。 客户可以利用七牛的实时音视频互动技术轻松做出一款类似 WebEx 的应用。
# 4.电商直播
提供连麦，转码、封装、超低延时等功能，都能通过七牛云快速搭建业务，节约研发成本和开发周期，快速上线
# 5.在线客服
线上开展音视频对话，对客户的资信情况进行审核，为金融科技企业促成在线签约，视频开户验证。
提供云端存储空间及海量数据的处理能力，提供的高可用的技术和高稳定的平台。
# 6.远程医疗
支持远程多方视频会诊，突破医疗资源的地域限制，以及系统平台限制，提高医患时间地域灵活性，降低诊断成本。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,830 |
价格说明 | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > 产品简介 > 价格说明
# 价格说明
最近更新时间: 2021-11-22 10:38:54
# 计费项目
在使用实时音视频及其关联服务，实现业务需求的过程中，可能涉及的计费项目如下表所示
计费项目 | 说明
---|---
实时音视频连麦费用 | 使用实时音视频进行语音或视频连麦时，产生的费用。上行推流不收费、下行拉流则按照集合分辨率（连麦者所拉几路流的分辨率之和）划分档位计费。 若拉流皆为音频则计为音频档，不拉流则不收费。具体价格见下文。
实时音视频转推费用 | 七牛实时音视频云支持单路转推和合流转推两种模式，单路转推主要应用在单个主播直播的场景，合流转推主要应用在需要将多人画面拼合的场景中。 以主播连麦 PK 的场景为例，由于主播有时是在单人直播，有时是在与其他主播连麦 PK，所以可以在单路转推和合流转推这两种模式上进行平滑切换，从而提高观众的观看体验，并且降低直播费用。具体价格见下文。
直播上行费用 | 该项也常被称为“旁路直播”费用。实时音视频通过单路转推或合流转推后，使用 rtmp 协议将音视频流推向直播云的动作称为旁路直播。 对于实时音视频的每一个连麦房间，使用七牛云默认的旁路直播域名，可免除一路旁路直播（即一路直播上行）的费用，但若一个连麦房间，同时向直播云上行推多路流，则会涉及到一部分直播上行费用。 详情可参考七牛[直播云价格页面 __](https://www.qiniu.com/prices/pili)
直播下行费用 | 该项也常被称为“CDN分发”或“VDN分发”费用。目前常见于“连麦+直播”的场景中。连麦用户的画面，通过实时音视频转推服务和旁路直播服务，成为可供直播间的观众拉取的直播流。观众拉取直播流的过程，便伴随着直播下行服务。详情可参考七牛[直播云价格页面 __](https://www.qiniu.com/prices/pili)
直播实时转码费用 | 在直播间的观众观看直播时，通常会允许选择清晰度，这时就用到了直播实时转码服务，详情可参考七牛[直播云价格页面 __](https://www.qiniu.com/prices/pili)
直播内容审核费用 | 对直播内容进行鉴黄鉴暴，会用到该服务，详情可参考七牛[直播云价格页面 __](https://www.qiniu.com/prices/pili)
直播内容录制存储费用 | 将直播内容录制并存储到七牛云，会涉及该项服务，详情可参考七牛[存储产品价格页面 __](https://www.qiniu.com/prices/kodo)
视频特效 SDK 费用 | 该项是指七牛提供的美颜、滤镜、美妆、贴纸等视频特效功能的费用。详情可咨询您的七牛商务对接人，或向您的视频特效方案供应商获取。
即时通讯产品费用 | 该项是指直播间使用的 IM 聊天等功能的费用。详情可咨询您的七牛商务对接人，或向您的 IM 方案供应商获取。
互动白板产品费用 | 该项是指直播间使用互动白板服务时的费用。详情可咨询您的七牛商务对接人，或向您的互动白板方案供应商获取。
# 每月免费额度
开通七牛云实时音视频服务的标准用户，每月可享受 20000 分钟
的实时音视频连麦免费使用时长。每月计费时，会先抵扣免费额度，超出部分再按照价格详情付费结算。
这20000分钟免费额度被分配在了实时音视频连麦费用的四个子计费项，分别是：
* 实时音视频连麦 纯音频 5000分钟
* 实时音视频连麦 标清 5000分钟
* 实时音视频连麦 高清 5000分钟
* 实时音视频连麦 超清 5000分钟
# 实时音视频连麦费用
计费项 | 订阅集合分辨率 | 价格（元/千分钟）
---|---|---
实时音视频连麦纯音频 | 0 | 5
实时音视频连麦标清 | 0 < r ≤ 360P（640x360=230400） | 14
实时音视频连麦高清 | 360P（640x360=230400）＜ r ≤720P(1280x720=921600) | 28
实时音视频连麦超清 | r > 720P(1280x720=921600) | 105
# 单路转推费用
计费项 | 订阅集合分辨率 | 价格（元/千分钟）
---|---|---
实时音视频单路转推纯音频 | 0 | 3
实时音视频单路转推标清 | 0 < r ≤ 360P（640x360=230400） | 3
实时音视频单路转推高清 | 360P（640x360=230400）＜ r ≤720P(1280x720=921600) | 3
实时音视频单路转推超清 | r > 720P(1280x720=921600) | 3
# 合流转推费用
计费项 | 订阅集合分辨率 | 价格（元/千分钟）
---|---|---
实时音视频合流转推纯音频 | 0 | 8
实时音视频合流转推标清 | 0 < r ≤ 360P（640x360=230400） | 45
实时音视频合流转推高清 | 360P（640x360=230400）＜ r ≤720P(1280x720=921600) | 100
实时音视频合流转推超清 | r > 720P(1280x720=921600) | 300
# 什么是集合分辨率
集合分辨率，是指拉流端订阅的所有音视频媒体流的分辨率之和。
假设一个连麦房间中，有 A、B、C、D 四人视频通话了100分钟：
用户 A 发布的推流分辨率（高x宽）为：1280x720
用户 B 发布的推流分辨率（高x宽）为：640x360
用户 C 发布的推流分辨率（高x宽）为：640x360
用户 D 发布的纯音频，对应推流分辨率为：0
在连麦的情况中：
* 对于用户 A，作为拉流端订阅 B、C、D 的流，所以 A 的集合分辨率为 640x360+640x360+0=460800，参考连麦费用表为高清。
* 对于用户 B，作为拉流端订阅 A、C、D 的流，所以 B 的集合分辨率为 1280x720+640x360+0=1152000，参考连麦费用表为超清。
* 对于用户 C，作为拉流端订阅 A、B、D 的流，所以 C 的集合分辨率为 1280x720+640x360+0=1152000，参考连麦费用表为超清。
* 对于用户 D，作为拉流端订阅 A、B、C 的流，所以 D 的集合分辨率为 1280x720+640x360+640x360=1382400，参考连麦费用表为超清。
那么本次连麦，费用为 （28+105+105+105)x100/1000=34.3 元
在单路转推的情况中，负责执行单路转推任务的服务器，可以视为一个拉流端：
* 对于单路转推服务器，单路转推 A 用户的流时，订阅的集合分辨率为 1280x720=921600，参考单路转推费用表为于高清。
* 对于单路转推服务器，单路转推 B 用户的流时，订阅的集合分辨率为 640x360=230400，参考单路转推费用表为标清。
* 对于单路转推服务器，单路转推 C 用户的流时，订阅的集合分辨率为 640x360=230400，参考单路转推费用表为标清。
* 对于单路转推服务器，单路转推 D 用户的流时，订阅的集合分辨率为 0，参考单路转推费用表为纯音频。
在合流转推的情况中，负责执行合流转推任务的服务器，可以视为一个拉流端：
* 对于合流转推服务器，假设合流转推 C 的流，订阅的集合分辨率为 640x360=230400，参考合流转推费用表，属于标清，45元/千分钟。所以若只转推一路流，建议使用单路转推功能。
* 对于合流转推服务器，假设合流转推 C、D 的流，订阅的集合分辨率为 640x360+0=230400，参考合流转推费用表，属于标清，45元/千分钟。
* 对于合流转推服务器，假设合流转推 A、B、C、D 的流，订阅的集合分辨率为 1280x720+640x360+640x360+0=1382400，属于超清。如下图
合流转推的其他举例同上，不再赘述。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > 产品简介 > 价格说明
# 价格说明
最近更新时间: 2021-11-22 10:38:54
# 计费项目
在使用实时音视频及其关联服务，实现业务需求的过程中，可能涉及的计费项目如下表所示
计费项目 | 说明
---|---
实时音视频连麦费用 | 使用实时音视频进行语音或视频连麦时，产生的费用。上行推流不收费、下行拉流则按照集合分辨率（连麦者所拉几路流的分辨率之和）划分档位计费。 若拉流皆为音频则计为音频档，不拉流则不收费。具体价格见下文。
实时音视频转推费用 | 七牛实时音视频云支持单路转推和合流转推两种模式，单路转推主要应用在单个主播直播的场景，合流转推主要应用在需要将多人画面拼合的场景中。 以主播连麦 PK 的场景为例，由于主播有时是在单人直播，有时是在与其他主播连麦 PK，所以可以在单路转推和合流转推这两种模式上进行平滑切换，从而提高观众的观看体验，并且降低直播费用。具体价格见下文。
直播上行费用 | 该项也常被称为“旁路直播”费用。实时音视频通过单路转推或合流转推后，使用 rtmp 协议将音视频流推向直播云的动作称为旁路直播。 对于实时音视频的每一个连麦房间，使用七牛云默认的旁路直播域名，可免除一路旁路直播（即一路直播上行）的费用，但若一个连麦房间，同时向直播云上行推多路流，则会涉及到一部分直播上行费用。 详情可参考七牛[直播云价格页面 __](https://www.qiniu.com/prices/pili)
直播下行费用 | 该项也常被称为“CDN分发”或“VDN分发”费用。目前常见于“连麦+直播”的场景中。连麦用户的画面，通过实时音视频转推服务和旁路直播服务，成为可供直播间的观众拉取的直播流。观众拉取直播流的过程，便伴随着直播下行服务。详情可参考七牛[直播云价格页面 __](https://www.qiniu.com/prices/pili)
直播实时转码费用 | 在直播间的观众观看直播时，通常会允许选择清晰度，这时就用到了直播实时转码服务，详情可参考七牛[直播云价格页面 __](https://www.qiniu.com/prices/pili)
直播内容审核费用 | 对直播内容进行鉴黄鉴暴，会用到该服务，详情可参考七牛[直播云价格页面 __](https://www.qiniu.com/prices/pili)
直播内容录制存储费用 | 将直播内容录制并存储到七牛云，会涉及该项服务，详情可参考七牛[存储产品价格页面 __](https://www.qiniu.com/prices/kodo)
视频特效 SDK 费用 | 该项是指七牛提供的美颜、滤镜、美妆、贴纸等视频特效功能的费用。详情可咨询您的七牛商务对接人，或向您的视频特效方案供应商获取。
即时通讯产品费用 | 该项是指直播间使用的 IM 聊天等功能的费用。详情可咨询您的七牛商务对接人，或向您的 IM 方案供应商获取。
互动白板产品费用 | 该项是指直播间使用互动白板服务时的费用。详情可咨询您的七牛商务对接人，或向您的互动白板方案供应商获取。
# 每月免费额度
开通七牛云实时音视频服务的标准用户，每月可享受 20000 分钟
的实时音视频连麦免费使用时长。每月计费时，会先抵扣免费额度，超出部分再按照价格详情付费结算。
这20000分钟免费额度被分配在了实时音视频连麦费用的四个子计费项，分别是：
* 实时音视频连麦 纯音频 5000分钟
* 实时音视频连麦 标清 5000分钟
* 实时音视频连麦 高清 5000分钟
* 实时音视频连麦 超清 5000分钟
# 实时音视频连麦费用
计费项 | 订阅集合分辨率 | 价格（元/千分钟）
---|---|---
实时音视频连麦纯音频 | 0 | 5
实时音视频连麦标清 | 0 < r ≤ 360P（640x360=230400） | 14
实时音视频连麦高清 | 360P（640x360=230400）＜ r ≤720P(1280x720=921600) | 28
实时音视频连麦超清 | r > 720P(1280x720=921600) | 105
# 单路转推费用
计费项 | 订阅集合分辨率 | 价格（元/千分钟）
---|---|---
实时音视频单路转推纯音频 | 0 | 3
实时音视频单路转推标清 | 0 < r ≤ 360P（640x360=230400） | 3
实时音视频单路转推高清 | 360P（640x360=230400）＜ r ≤720P(1280x720=921600) | 3
实时音视频单路转推超清 | r > 720P(1280x720=921600) | 3
# 合流转推费用
计费项 | 订阅集合分辨率 | 价格（元/千分钟）
---|---|---
实时音视频合流转推纯音频 | 0 | 8
实时音视频合流转推标清 | 0 < r ≤ 360P（640x360=230400） | 45
实时音视频合流转推高清 | 360P（640x360=230400）＜ r ≤720P(1280x720=921600) | 100
实时音视频合流转推超清 | r > 720P(1280x720=921600) | 300
# 什么是集合分辨率
集合分辨率，是指拉流端订阅的所有音视频媒体流的分辨率之和。
假设一个连麦房间中，有 A、B、C、D 四人视频通话了100分钟：
用户 A 发布的推流分辨率（高x宽）为：1280x720
用户 B 发布的推流分辨率（高x宽）为：640x360
用户 C 发布的推流分辨率（高x宽）为：640x360
用户 D 发布的纯音频，对应推流分辨率为：0
在连麦的情况中：
* 对于用户 A，作为拉流端订阅 B、C、D 的流，所以 A 的集合分辨率为 640x360+640x360+0=460800，参考连麦费用表为高清。
* 对于用户 B，作为拉流端订阅 A、C、D 的流，所以 B 的集合分辨率为 1280x720+640x360+0=1152000，参考连麦费用表为超清。
* 对于用户 C，作为拉流端订阅 A、B、D 的流，所以 C 的集合分辨率为 1280x720+640x360+0=1152000，参考连麦费用表为超清。
* 对于用户 D，作为拉流端订阅 A、B、C 的流，所以 D 的集合分辨率为 1280x720+640x360+640x360=1382400，参考连麦费用表为超清。
那么本次连麦，费用为 （28+105+105+105)x100/1000=34.3 元
在单路转推的情况中，负责执行单路转推任务的服务器，可以视为一个拉流端：
* 对于单路转推服务器，单路转推 A 用户的流时，订阅的集合分辨率为 1280x720=921600，参考单路转推费用表为于高清。
* 对于单路转推服务器，单路转推 B 用户的流时，订阅的集合分辨率为 640x360=230400，参考单路转推费用表为标清。
* 对于单路转推服务器，单路转推 C 用户的流时，订阅的集合分辨率为 640x360=230400，参考单路转推费用表为标清。
* 对于单路转推服务器，单路转推 D 用户的流时，订阅的集合分辨率为 0，参考单路转推费用表为纯音频。
在合流转推的情况中，负责执行合流转推任务的服务器，可以视为一个拉流端：
* 对于合流转推服务器，假设合流转推 C 的流，订阅的集合分辨率为 640x360=230400，参考合流转推费用表，属于标清，45元/千分钟。所以若只转推一路流，建议使用单路转推功能。
* 对于合流转推服务器，假设合流转推 C、D 的流，订阅的集合分辨率为 640x360+0=230400，参考合流转推费用表，属于标清，45元/千分钟。
* 对于合流转推服务器，假设合流转推 A、B、C、D 的流，订阅的集合分辨率为 1280x720+640x360+640x360+0=1382400，属于超清。如下图
合流转推的其他举例同上，不再赘述。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,833 |
控制台说明 | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > 快速入门 > 控制台 >控制台说明
# 控制台说明
最近更新时间: 2021-11-03 17:19:03
为方便开发者使用，我们将七牛实时互动产品系列中三项产品（实时音视频、互动白板、即时通讯）的控制台合为一处。
若需获取另外两项产品的接入文档，请点击访问 [互动白板接入文档
__](https://developer.qiniu.com/whiteboard)或[即时通讯接入文档
__](https://developer.qiniu.com/IM)
**[控制台 __](https://portal.qiniu.com/rtn/app)为开发者提供了如下功能：**
1.应用管理（应用列表、新建应用、编辑应用、删除应用等）
2.管理实时音视频，包括房间管理、合流配置、活跃房间等
3.管理互动白板，管理互动白板的功能配置等。
4.管理即时通讯，管理即时通讯的基础配置、套餐容量、高级功能等。
5.用量统计，查看实时音视频使用时长、互动白板使用时长、即时通讯日活情况等。
**为更好的使用实时音视频产品，请先了解如下的基本接入流程：**
# 1.官网注册
通过 [注册页面 __](https://portal.qiniu.com/signup)进行账号注册。
# 2.登录并实名认证
[登录 __](https://sso.qiniu.com/)到管理控制台，并完成[实名认证
__](https://portal.qiniu.com/identity/choice)
# 3.创建应用
前往 [实时音视频 __](https://portal.qiniu.com/rtn/app)产品管理控制台创建应用
# 4.管理应用
前往[应用列表
__](https://portal.qiniu.com/rtn/app)，点击查看详情，进入应用的管理界面，分别管理实时音视频、互动白板、即时通讯等服务的配置
# 5.集成开发
可以参考快速入门、使用指南 和 API文档 等内容进行[集成开发 __](https://developer.qiniu.com/rtc)。
# 6.查看用量
前往[用量统计 __](https://portal.qiniu.com/rtn/statistics/rtc)页面可查看每日实际用量。
# 7.获取支持
若有商务方面的问题，可联系与您对接的商务经理，或联系 400-808-9176 转 1 获取商务支持。
若在集成开发过程中，需要技术支持，可通过工单系统[提交工单
__](https://support.qiniu.com/tickets/new/?space=%E5%AE%9E%E6%97%B6%E9%9F%B3%E8%A7%86%E9%A2%91%E4%BA%91)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > 快速入门 > 控制台 >控制台说明
# 控制台说明
最近更新时间: 2021-11-03 17:19:03
为方便开发者使用，我们将七牛实时互动产品系列中三项产品（实时音视频、互动白板、即时通讯）的控制台合为一处。
若需获取另外两项产品的接入文档，请点击访问 [互动白板接入文档
__](https://developer.qiniu.com/whiteboard)或[即时通讯接入文档
__](https://developer.qiniu.com/IM)
**[控制台 __](https://portal.qiniu.com/rtn/app)为开发者提供了如下功能：**
1.应用管理（应用列表、新建应用、编辑应用、删除应用等）
2.管理实时音视频，包括房间管理、合流配置、活跃房间等
3.管理互动白板，管理互动白板的功能配置等。
4.管理即时通讯，管理即时通讯的基础配置、套餐容量、高级功能等。
5.用量统计，查看实时音视频使用时长、互动白板使用时长、即时通讯日活情况等。
**为更好的使用实时音视频产品，请先了解如下的基本接入流程：**
# 1.官网注册
通过 [注册页面 __](https://portal.qiniu.com/signup)进行账号注册。
# 2.登录并实名认证
[登录 __](https://sso.qiniu.com/)到管理控制台，并完成[实名认证
__](https://portal.qiniu.com/identity/choice)
# 3.创建应用
前往 [实时音视频 __](https://portal.qiniu.com/rtn/app)产品管理控制台创建应用
# 4.管理应用
前往[应用列表
__](https://portal.qiniu.com/rtn/app)，点击查看详情，进入应用的管理界面，分别管理实时音视频、互动白板、即时通讯等服务的配置
# 5.集成开发
可以参考快速入门、使用指南 和 API文档 等内容进行[集成开发 __](https://developer.qiniu.com/rtc)。
# 6.查看用量
前往[用量统计 __](https://portal.qiniu.com/rtn/statistics/rtc)页面可查看每日实际用量。
# 7.获取支持
若有商务方面的问题，可联系与您对接的商务经理，或联系 400-808-9176 转 1 获取商务支持。
若在集成开发过程中，需要技术支持，可通过工单系统[提交工单
__](https://support.qiniu.com/tickets/new/?space=%E5%AE%9E%E6%97%B6%E9%9F%B3%E8%A7%86%E9%A2%91%E4%BA%91)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,840 |
管理实时音视频 | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > 快速入门 > 控制台 >管理实时音视频
# 管理实时音视频
最近更新时间: 2021-11-05 16:12:50
实时音视频的应用管理，控制台包括如下几项：
1.应用配置
2.合流配置
3.活跃房间管理
4.roomToken
# 1.应用配置
如上图所示，应用配置以及合流配置主要由以下两表格进行说明
项 | 说明
---|---
应用ID | 创建应用后由系统自动分配的唯一标识
关联的直播空间 | 绑定直播空间，才可以使用旁路直播、直播实时录制、直播内容审核、直播实时转码等服务
房间最大人数 | 单个连麦房间允许的最大同时在线人数，超出人数后，新的用户将无法加入房间。若想设置无人数上限，可将数值设置成例如10000000000
备注信息 | 用于区别不同的应用
禁止自动踢人 | 默认允许同一个身份用户重复加入房间，旧连接将被关闭；如果打开此开关，则不允许重复加入房间，新连接将被拒绝
创建时间 | 应用的创建时间
更新时间 | 配置的更新时间
# 2.合流配置
项 | 连麦合流转推rtmp，具体使用方法可参考服务端功能[合流转推 __](https://developer.qiniu.com/rtc/8817/api-mergePublish)
---|---
是否启用 | 是否启用合流转推服务
只合成音频 | 是否只进行音频合流
画面填充方式 | 有三种方式可供选择：充满容器（画面可能会有部分被裁剪）适应于容器（画面不会被裁剪，但可能会出现黑边）拉伸填充容器（画面不会被裁剪，但可能被拉伸变形）
合流输出尺寸 | 设置输出视频的宽和高所包含的像素数
合流输出帧率 | 设置输出视频的帧率，范围在5~60帧
合流输出码率 | 设置输出视频的的平均码率、最大码率、最小码率
StreamTitle | 转推至七牛直播空间的流名，支持魔法变量以灵活区分不同的连麦房间，魔法变量以 $(XX) 表示。目前魔法变量有四个：$(app): 表示连麦应用的 ID$(hub): 表示连麦应用关联的直播空间名称$(roomName): 表示连麦房间号$(timestamp): 表示时间戳例如：$(app)_$(roomName) 表示 "应用 ID_房间号“
# 3.活跃房间管理
从活跃房间列表中，可查看每个房间中的用户，而且可执行踢出房间的操作。如下图所示
# 4.roomToken
roomToken的使用可以参考服务端使用文档 **[roomToken
__](https://developer.qiniu.com/rtc/8813/roomToken)**
也可以通过控制台中的“生成roomToken”功能，生成指定房间的roomToken，如下图所示
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > 快速入门 > 控制台 >管理实时音视频
# 管理实时音视频
最近更新时间: 2021-11-05 16:12:50
实时音视频的应用管理，控制台包括如下几项：
1.应用配置
2.合流配置
3.活跃房间管理
4.roomToken
# 1.应用配置
如上图所示，应用配置以及合流配置主要由以下两表格进行说明
项 | 说明
---|---
应用ID | 创建应用后由系统自动分配的唯一标识
关联的直播空间 | 绑定直播空间，才可以使用旁路直播、直播实时录制、直播内容审核、直播实时转码等服务
房间最大人数 | 单个连麦房间允许的最大同时在线人数，超出人数后，新的用户将无法加入房间。若想设置无人数上限，可将数值设置成例如10000000000
备注信息 | 用于区别不同的应用
禁止自动踢人 | 默认允许同一个身份用户重复加入房间，旧连接将被关闭；如果打开此开关，则不允许重复加入房间，新连接将被拒绝
创建时间 | 应用的创建时间
更新时间 | 配置的更新时间
# 2.合流配置
项 | 连麦合流转推rtmp，具体使用方法可参考服务端功能[合流转推 __](https://developer.qiniu.com/rtc/8817/api-mergePublish)
---|---
是否启用 | 是否启用合流转推服务
只合成音频 | 是否只进行音频合流
画面填充方式 | 有三种方式可供选择：充满容器（画面可能会有部分被裁剪）适应于容器（画面不会被裁剪，但可能会出现黑边）拉伸填充容器（画面不会被裁剪，但可能被拉伸变形）
合流输出尺寸 | 设置输出视频的宽和高所包含的像素数
合流输出帧率 | 设置输出视频的帧率，范围在5~60帧
合流输出码率 | 设置输出视频的的平均码率、最大码率、最小码率
StreamTitle | 转推至七牛直播空间的流名，支持魔法变量以灵活区分不同的连麦房间，魔法变量以 $(XX) 表示。目前魔法变量有四个：$(app): 表示连麦应用的 ID$(hub): 表示连麦应用关联的直播空间名称$(roomName): 表示连麦房间号$(timestamp): 表示时间戳例如：$(app)_$(roomName) 表示 "应用 ID_房间号“
# 3.活跃房间管理
从活跃房间列表中，可查看每个房间中的用户，而且可执行踢出房间的操作。如下图所示
# 4.roomToken
roomToken的使用可以参考服务端使用文档 **[roomToken
__](https://developer.qiniu.com/rtc/8813/roomToken)**
也可以通过控制台中的“生成roomToken”功能，生成指定房间的roomToken，如下图所示
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,844 |
基本概念 | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > 快速入门 > 基本概念
# 基本概念
最近更新时间: 2021-11-05 18:22:17
本文旨在介绍实时音视频过程中涉及到的一些基本概念。
######
# 应用
**应用** 是您在七牛云实时音视频应用中的一个业务上的划分方式，以**应用 ID(AppID)** 作为唯一的标识符。**一个 APP
或者项目使用一个应用** ，同一个 APP 的不同平台（iOS、Android、Windows、Web）可共享一个应用，无需重复创建。
您可以通过[七牛控制台](https://portal.qiniu.com/rtn/app)来进行**应用的创建和编辑**
。如果您还没有注册七牛开发者平台，具体流程请参考[七牛实时音视频云接入指南](https://doc.qnsdk.com/rtn/docs/rtn_startup)。
> * 不同应用之间的数据不互通，房间也无法连通。
> * 一个应用对应一个唯一的 AppID，AppID 可用于后续的排障以及 RoomToken 的签算等工作。
>
######
# 房间
**房间** 是对音视频对话空间的抽象，用于隔离不同的通话过程，保障数据的安全及独立。同一房间内的用户可以互相接收对方的音视频数据。以 `RoomName`
为标识，需满足 `^[a-zA-Z0-9_-]{3,64}$` 的规格。**加入房间需要携带RoomToken**。
> * 当用户加入的房间不存在时，七牛后台服务会自动创建对应的房间。
> * 若房间内的所有用户都已离开，那么房间维持空状态 10s 后将会自动关闭。
> * 若房间为服务端创建，且创建后无用户进入，那么房间维持空状态 30s 后将会自动关闭。
> * 若房间内的用户由于断网等原因，30s 未向七牛后台服务通信，则该用户将被视为退出房间。
>
######
# UserID
**UserID** 是实时音视频通话房间内用户的唯一标识。
> * UserID 支持字母、数字、中划线、下划线，区分大小写。
> * 同一房间内 UserID
> 唯一，若有重复，则根据[七牛控制台上应用](https://portal.qiniu.com/rtn/app)对自动踢人配置，做相应的处理。
>
######
# RoomToken
**RoomToken** 是加入房间需要携带的凭证信息，是基于 AppID、RoomName、UserID
以及过期时间等信息按照一定规则生成的，其具体的签算方式可参考 [RoomToken
签发服务](https://developer.qiniu.com/rtc/development_guidelines/8813/roomToken)。
######
# Track
**Track** 代表音视频通话过程中的**一条音频轨** 或者**一条视频轨** ，是音视频通话的最小单位。
> * 一个用户可以创建多条音视频的 Track，如摄像头视频 Track、录屏视频 Track 和麦克风音频 Track 等
> * 音频 Track 仅支持创建一路，重复创建将创建失败
>
######
# 发布
**发布** 是指将创建好的音视频 Track 对应的音视频数据推送到七牛实时音视频服务的操作，执行发布操作后，远端用户可以选择性的进行订阅观看。
> 不同于 CDN 推流，此处的发布指的是房间内的音视频数据推送，将不会产生 rtmp 的直播观看地址
######
# 订阅
**订阅** 是指向七牛实时音视频服务请求拉取远端发布的音视频数据的操作。订阅后，本地即可实时的接收远端发布的音视频数据。
> 不同于 rtmp 拉流观看，此处的订阅指的是房间内的音视频数据接收，是基于实时性更好的 RTP 协议进行传输的
######
# CDN 推流
######
## 单路转推
**单路转推** 是指将客户端推送的一路音频 Track 和一路视频 Track 在服务端直接进行协议转换，再经由 CDN
分发的场景。由于不涉及服务端转码合流的操作，因此仅会产生单路转推场景的费用，费用相关可参考[单路转推费用文档](https://developer.qiniu.com/rtc/product_introduction/8804/pd-
price#4)。更详细的说明可参考使用指南相关文档。
> 单路转推最多仅支持一路音频和一路视频的 CDN 分发，无法进行多路画面和多路音频的合流操作
######
## 合流转推
**合流转推** 是指将房间内的多路音频进行混音，多路视频进行合流，再以 rtmp 推流的形式经由 CDN
分发的场景。该场景涉及到服务端的合流操作，将会产生合流相关的费用，费用相关可参考[合流转推费用文档](https://developer.qiniu.com/rtc/product_introduction/8804/pd-
price#5)。更详细的说明可参考使用指南相关文档。
######
# 大小流
**大小流** 是指用户发布视频 Track 时，基于该 Track 推送多路不同分辨率的视频码流，订阅端用户可以根据自己的需求选择订阅该 Track
的其中一路视频流。例如本地网络较差时，可选择订阅低分辨率的流；网络较好时，则可以选择订阅高分辨率的流。更详细的说明可参考使用指南相关文档。
> 订阅时指定的 profile 仅为预期设置，实际订阅是否成功，以 Track 相关回调通知的实际结果为准。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > 快速入门 > 基本概念
# 基本概念
最近更新时间: 2021-11-05 18:22:17
本文旨在介绍实时音视频过程中涉及到的一些基本概念。
######
# 应用
**应用** 是您在七牛云实时音视频应用中的一个业务上的划分方式，以**应用 ID(AppID)** 作为唯一的标识符。**一个 APP
或者项目使用一个应用** ，同一个 APP 的不同平台（iOS、Android、Windows、Web）可共享一个应用，无需重复创建。
您可以通过[七牛控制台](https://portal.qiniu.com/rtn/app)来进行**应用的创建和编辑**
。如果您还没有注册七牛开发者平台，具体流程请参考[七牛实时音视频云接入指南](https://doc.qnsdk.com/rtn/docs/rtn_startup)。
> * 不同应用之间的数据不互通，房间也无法连通。
> * 一个应用对应一个唯一的 AppID，AppID 可用于后续的排障以及 RoomToken 的签算等工作。
>
######
# 房间
**房间** 是对音视频对话空间的抽象，用于隔离不同的通话过程，保障数据的安全及独立。同一房间内的用户可以互相接收对方的音视频数据。以 `RoomName`
为标识，需满足 `^[a-zA-Z0-9_-]{3,64}$` 的规格。**加入房间需要携带RoomToken**。
> * 当用户加入的房间不存在时，七牛后台服务会自动创建对应的房间。
> * 若房间内的所有用户都已离开，那么房间维持空状态 10s 后将会自动关闭。
> * 若房间为服务端创建，且创建后无用户进入，那么房间维持空状态 30s 后将会自动关闭。
> * 若房间内的用户由于断网等原因，30s 未向七牛后台服务通信，则该用户将被视为退出房间。
>
######
# UserID
**UserID** 是实时音视频通话房间内用户的唯一标识。
> * UserID 支持字母、数字、中划线、下划线，区分大小写。
> * 同一房间内 UserID
> 唯一，若有重复，则根据[七牛控制台上应用](https://portal.qiniu.com/rtn/app)对自动踢人配置，做相应的处理。
>
######
# RoomToken
**RoomToken** 是加入房间需要携带的凭证信息，是基于 AppID、RoomName、UserID
以及过期时间等信息按照一定规则生成的，其具体的签算方式可参考 [RoomToken
签发服务](https://developer.qiniu.com/rtc/development_guidelines/8813/roomToken)。
######
# Track
**Track** 代表音视频通话过程中的**一条音频轨** 或者**一条视频轨** ，是音视频通话的最小单位。
> * 一个用户可以创建多条音视频的 Track，如摄像头视频 Track、录屏视频 Track 和麦克风音频 Track 等
> * 音频 Track 仅支持创建一路，重复创建将创建失败
>
######
# 发布
**发布** 是指将创建好的音视频 Track 对应的音视频数据推送到七牛实时音视频服务的操作，执行发布操作后，远端用户可以选择性的进行订阅观看。
> 不同于 CDN 推流，此处的发布指的是房间内的音视频数据推送，将不会产生 rtmp 的直播观看地址
######
# 订阅
**订阅** 是指向七牛实时音视频服务请求拉取远端发布的音视频数据的操作。订阅后，本地即可实时的接收远端发布的音视频数据。
> 不同于 rtmp 拉流观看，此处的订阅指的是房间内的音视频数据接收，是基于实时性更好的 RTP 协议进行传输的
######
# CDN 推流
######
## 单路转推
**单路转推** 是指将客户端推送的一路音频 Track 和一路视频 Track 在服务端直接进行协议转换，再经由 CDN
分发的场景。由于不涉及服务端转码合流的操作，因此仅会产生单路转推场景的费用，费用相关可参考[单路转推费用文档](https://developer.qiniu.com/rtc/product_introduction/8804/pd-
price#4)。更详细的说明可参考使用指南相关文档。
> 单路转推最多仅支持一路音频和一路视频的 CDN 分发，无法进行多路画面和多路音频的合流操作
######
## 合流转推
**合流转推** 是指将房间内的多路音频进行混音，多路视频进行合流，再以 rtmp 推流的形式经由 CDN
分发的场景。该场景涉及到服务端的合流操作，将会产生合流相关的费用，费用相关可参考[合流转推费用文档](https://developer.qiniu.com/rtc/product_introduction/8804/pd-
price#5)。更详细的说明可参考使用指南相关文档。
######
# 大小流
**大小流** 是指用户发布视频 Track 时，基于该 Track 推送多路不同分辨率的视频码流，订阅端用户可以根据自己的需求选择订阅该 Track
的其中一路视频流。例如本地网络较差时，可选择订阅低分辨率的流；网络较好时，则可以选择订阅高分辨率的流。更详细的说明可参考使用指南相关文档。
> 订阅时指定的 profile 仅为预期设置，实际订阅是否成功，以 Track 相关回调通知的实际结果为准。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,847 |
SDK 概览 | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > 快速入门 > Android >SDK 概览
# SDK 概览
最近更新时间: 2024-08-23 18:05:58
> 本文档适用于 QNDroidRTC 4.x 及以上版本的 SDK，并不向下兼容。
>
> * [3.x 及之前版本的相关文档](https://doc.qnsdk.com/rtn/android/)
> * [4.x
> 版本迁移指南](https://developer.qiniu.com/rtc/development_guidelines/9394/migration-
> guide-android)
>
QNDroidRTC 是七牛推出的一款适用于 Android 平台的音视频通话
SDK，提供了包括美颜、滤镜、音视频通话等多种功能，提供灵活的接口，支持高度定制以及二次开发，您可以很方便地在 Android
平台上开发出一款基于实时音视频的应用。其中包括但不限于以下场景：
* 在线教育
* 在线直播互动连麦
* 视频会议
* 一对一社交
* 狼人杀等依赖实时音视频通话的游戏
* 在线客服
* 在线抓娃娃
# 下载地址
* [Android API Demo:](https://github.com/pili-engineering/QNRTC-Android/tree/master/QNRTC-API-Examples) 最详细接口使用 Demo，提供了音视频通话、纯音频通话、CDN 转推、音频混音等不同场景的实现示例，便于您理解各个场景的实现方式。
* [Android 体验 Demo:](https://github.com/pili-engineering/QNRTC-Android/tree/master/QNDroidRTCDemo) 会议场景 Demo，包含视频会议、音频会议、屏幕共享、大小窗口切换、CDN 转推等一系列功能场景。您可以在理解了音视频通话的主要流程后，参考该 Demo 以扩展更多的高级功能。
# 功能列表
功能| 版本
---|---
支持内置媒体播放器| v6.4.0(+)
支持音视频本地录制功能| v6.2.0(+)
支持 CDN 直推功能| v6.0.0(+)
支持自定义音频处理功能| v5.2.6(+)
支持语音激励功能| v5.2.6(+)
支持 quic 协议的信令交互| v5.2.5(+)
支持设置房间重连的超时时间| v5.2.4(+)
提供视频编码参数的预设值接口| v5.2.4(+)
支持设置视频在弱网下的降级模式| v5.2.3(+)
支持设置自定义的 so 加载路径| v5.2.3(+)
支持新的日志上报功能| v5.2.3(+)
支持同时发布多个 QNLocalAudioTrack| v5.2.3(+)
支持动态修改本地视频 Track 的编码参数| v5.2.1(+)
支持设置拉伸模式进行视频渲染| v5.2.0(+)
支持音乐，音效通过 RTC 进行本地播放| v5.2.0(+)
支持外部音源 (PCM) 混音| v5.2.0(+)
新增音频场景化配置功能| v5.1.3(+)
支持创建纯音频合流转推任务| v5.1.1(+)
支持多重音效混音| v5.1.0(+)
支持日志上报| v3.1.0(+)
支持回调远端音频播放器数据| v3.1.0(+)
支持合流添加 SEI| v3.0.2(+)
支持合流保留最后一帧| v3.0.2(+)
支持切换图片连麦| v3.0.1(+)
支持单路转推添加 SEI| v3.0.1(+)
支持添加视频水印| v3.0.1(+)
新增音频数据自定义加解密接口| v3.0.0(+)
新增远端用户正在重连，重连成功回调| v3.0.0(+)
新增支持远端音频 Track 音量调节| v3.0.0(+)
新增通话模式配置接口| v2.5.0(+)
新增支持单路转推| v2.5.0(+)
新增支持单路视频时发送及订阅大小流| v2.5.0(+)
支持设置自定义 DNS 服务| v2.5.0(+)
新增通话模式配置接口| v2.5.0(+)
音频采集数据回调，新增采样率/声道参数| v2.5.0(+)
添加对端网络信息回调 onRemoteStatisticsUpdated()| v2.4.0(+)
添加本地统计回调字段，rtt，networkGrade| v2.4.0(+)
增加本地离开房间的回调| v2.4.0(+)
新增在线接口文档| v2.4.0(+)
支持合流背景图片设置| v2.3.1(+)
支持音频低采样率配置| v2.3.1(+)
支持音频软件 AEC 配置| v2.3.1(+)
支持音频双声道| v2.3.0(+)
支持音量大小回调| v2.3.0(+)
支持自定义消息| v2.3.0(+)
支持在线背景音乐混音功能| v2.3.0(+)
支持导入多种音频格式| v2.3.0(+)
支持背景音乐混音功能、返听功能| v2.2.0(+)
支持蓝牙耳机通话| v2.1.0(+)
支持单用户多路流的场景| v2.0.0(+)
支持回调摄像头 YUV 数据功能| v1.2.0(+)
支持外部导入音视频数据功能| v1.1.0(+)
支持大小窗口切换功能| v1.1.0(+)
支持屏幕录制功能| v1.0.0(+)
支持合流参数配置| v0.2.0(+)
支持编码镜像功能| v0.2.0(+)
支持回调本地/远端视频数据| v0.2.0(+)
支持回调本地/远端音频数据| v0.2.0(+)
支持获取连麦房间统计信息（帧率、码率等）| v0.1.0(+)
支持视频的大小窗口切换| v0.1.0(+)
支持纯音频互动| v0.1.0(+)
支持丰富的消息回调| v0.1.0(+)
支持自动重连| v0.1.0(+)
支持视频尺寸配置| v0.1.0(+)
支持视频码率的配置| v0.1.0(+)
支持帧率配置| v0.1.0(+)
支持静音功能| v0.1.0(+)
支持踢人功能| v0.1.0(+)
支持三方美颜、滤镜、面部特效| v0.1.0(+)
内置美颜功能| v0.1.0(+)
支持内置音视频采集，带闪光灯、摄像头切换、自动/手动对焦等常见功能| v0.1.0(+)
基本的音视频通话功能| v0.1.0(+)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > 快速入门 > Android >SDK 概览
# SDK 概览
最近更新时间: 2024-08-23 18:05:58
> 本文档适用于 QNDroidRTC 4.x 及以上版本的 SDK，并不向下兼容。
>
> * [3.x 及之前版本的相关文档](https://doc.qnsdk.com/rtn/android/)
> * [4.x
> 版本迁移指南](https://developer.qiniu.com/rtc/development_guidelines/9394/migration-
> guide-android)
>
QNDroidRTC 是七牛推出的一款适用于 Android 平台的音视频通话
SDK，提供了包括美颜、滤镜、音视频通话等多种功能，提供灵活的接口，支持高度定制以及二次开发，您可以很方便地在 Android
平台上开发出一款基于实时音视频的应用。其中包括但不限于以下场景：
* 在线教育
* 在线直播互动连麦
* 视频会议
* 一对一社交
* 狼人杀等依赖实时音视频通话的游戏
* 在线客服
* 在线抓娃娃
# 下载地址
* [Android API Demo:](https://github.com/pili-engineering/QNRTC-Android/tree/master/QNRTC-API-Examples) 最详细接口使用 Demo，提供了音视频通话、纯音频通话、CDN 转推、音频混音等不同场景的实现示例，便于您理解各个场景的实现方式。
* [Android 体验 Demo:](https://github.com/pili-engineering/QNRTC-Android/tree/master/QNDroidRTCDemo) 会议场景 Demo，包含视频会议、音频会议、屏幕共享、大小窗口切换、CDN 转推等一系列功能场景。您可以在理解了音视频通话的主要流程后，参考该 Demo 以扩展更多的高级功能。
# 功能列表
功能| 版本
---|---
支持内置媒体播放器| v6.4.0(+)
支持音视频本地录制功能| v6.2.0(+)
支持 CDN 直推功能| v6.0.0(+)
支持自定义音频处理功能| v5.2.6(+)
支持语音激励功能| v5.2.6(+)
支持 quic 协议的信令交互| v5.2.5(+)
支持设置房间重连的超时时间| v5.2.4(+)
提供视频编码参数的预设值接口| v5.2.4(+)
支持设置视频在弱网下的降级模式| v5.2.3(+)
支持设置自定义的 so 加载路径| v5.2.3(+)
支持新的日志上报功能| v5.2.3(+)
支持同时发布多个 QNLocalAudioTrack| v5.2.3(+)
支持动态修改本地视频 Track 的编码参数| v5.2.1(+)
支持设置拉伸模式进行视频渲染| v5.2.0(+)
支持音乐，音效通过 RTC 进行本地播放| v5.2.0(+)
支持外部音源 (PCM) 混音| v5.2.0(+)
新增音频场景化配置功能| v5.1.3(+)
支持创建纯音频合流转推任务| v5.1.1(+)
支持多重音效混音| v5.1.0(+)
支持日志上报| v3.1.0(+)
支持回调远端音频播放器数据| v3.1.0(+)
支持合流添加 SEI| v3.0.2(+)
支持合流保留最后一帧| v3.0.2(+)
支持切换图片连麦| v3.0.1(+)
支持单路转推添加 SEI| v3.0.1(+)
支持添加视频水印| v3.0.1(+)
新增音频数据自定义加解密接口| v3.0.0(+)
新增远端用户正在重连，重连成功回调| v3.0.0(+)
新增支持远端音频 Track 音量调节| v3.0.0(+)
新增通话模式配置接口| v2.5.0(+)
新增支持单路转推| v2.5.0(+)
新增支持单路视频时发送及订阅大小流| v2.5.0(+)
支持设置自定义 DNS 服务| v2.5.0(+)
新增通话模式配置接口| v2.5.0(+)
音频采集数据回调，新增采样率/声道参数| v2.5.0(+)
添加对端网络信息回调 onRemoteStatisticsUpdated()| v2.4.0(+)
添加本地统计回调字段，rtt，networkGrade| v2.4.0(+)
增加本地离开房间的回调| v2.4.0(+)
新增在线接口文档| v2.4.0(+)
支持合流背景图片设置| v2.3.1(+)
支持音频低采样率配置| v2.3.1(+)
支持音频软件 AEC 配置| v2.3.1(+)
支持音频双声道| v2.3.0(+)
支持音量大小回调| v2.3.0(+)
支持自定义消息| v2.3.0(+)
支持在线背景音乐混音功能| v2.3.0(+)
支持导入多种音频格式| v2.3.0(+)
支持背景音乐混音功能、返听功能| v2.2.0(+)
支持蓝牙耳机通话| v2.1.0(+)
支持单用户多路流的场景| v2.0.0(+)
支持回调摄像头 YUV 数据功能| v1.2.0(+)
支持外部导入音视频数据功能| v1.1.0(+)
支持大小窗口切换功能| v1.1.0(+)
支持屏幕录制功能| v1.0.0(+)
支持合流参数配置| v0.2.0(+)
支持编码镜像功能| v0.2.0(+)
支持回调本地/远端视频数据| v0.2.0(+)
支持回调本地/远端音频数据| v0.2.0(+)
支持获取连麦房间统计信息（帧率、码率等）| v0.1.0(+)
支持视频的大小窗口切换| v0.1.0(+)
支持纯音频互动| v0.1.0(+)
支持丰富的消息回调| v0.1.0(+)
支持自动重连| v0.1.0(+)
支持视频尺寸配置| v0.1.0(+)
支持视频码率的配置| v0.1.0(+)
支持帧率配置| v0.1.0(+)
支持静音功能| v0.1.0(+)
支持踢人功能| v0.1.0(+)
支持三方美颜、滤镜、面部特效| v0.1.0(+)
内置美颜功能| v0.1.0(+)
支持内置音视频采集，带闪光灯、摄像头切换、自动/手动对焦等常见功能| v0.1.0(+)
基本的音视频通话功能| v0.1.0(+)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,852 |
开发准备 | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > 快速入门 > Android >开发准备
# 开发准备
最近更新时间: 2024-08-23 18:06:05
本文主要介绍开发前的准备工作，包括开发环境的要求、SDK 的导入等。
# 前提条件
* Android Studio 开发工具，官方[下载地址](http://developer.android.com/intl/zh-cn/sdk/index.html)
* 有效的[开发者平台账号](https://developer.qiniu.io/rtc/9849/console)
# 设备及系统要求
* 系统要求：Android 4.3 (API 18) 及以上
* Java 版本: Java 8+
# 下载并导入实时音视频 SDK
SDK 可通过[公有 repo](https://github.com/pili-engineering/QNRTC-Android) 下载获取。
Repo 中主要包含 demo 示例代码、SDK jar 包，以及 SDK 依赖的动态库文件。 其中，releases 目录下是需要拷贝到您的
Android 工程的所有文件，以目前主流的 armeabi-v7a 架构为例，具体如下：
文件名称| 功能| 大小| 备注
---|---|---|---
qndroid-rtc-x.y.z.jar| SDK 库| 785 KB| 必须依赖
libqndroid_rtc.so| 连麦| 9.33 MB| 必须依赖
libqnquic.so| 信令协议| 2.2M| 建议依赖
libqcrash.so| 崩溃搜集| 49.8 KB| 建议依赖
libqndroid_beauty.so| 美颜| 442 KB| 不用自带美颜，可以不依赖
libqndroid_amix.so| 混音| 335 KB| 不用混音功能，可以不依赖
> 将 RTC SDK 集成到 App 后，App 的增量大小如下 (包含默认美颜包):
>
> * armeabi-v7a : 5.4 MB
> * arm64-v8a : 6.1 MB
> * x86 : 6.1 MB
>
* 将 qndroid-rtc-x.y.z.jar 包拷贝到您的工程的 libs 目录下，最新版本可查看[版本更新日志](https://developer.qiniu.com/rtc/product_dynamic/9399/update-log-android)获取。
* 将动态库拷贝到您的工程对应的目录下，例如：armeabi-v7a 目录下的 so 则拷贝到工程的 jniLibs/armeabi-v7a 目录下
具体可以参考 SDK 包含的 demo 工程，集成后的工程示例如下：
# 修改 build.gradle
打开工程目录下的 build.gradle，确保已经**添加了如下 sdk 的库依赖** ，如下所示：
dependencies {
implementation files('libs/qndroid-rtc-x.y.z.jar')
}
**添加对 Java8 语言功能的支持：**
android {
...
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
}
**关于 dns 解析库的依赖，根据您使用版本的不同，需要依赖的具体版本信息如下：**
* 如果您使用的版本是 v5.0.1+，则不再需要依赖 dns 解析库。
* 如果您使用的版本是 v4.0.2，则需要依赖 1.0.0 版本 dns 解析库
* 如果您使用的版本是 v2.5.0+ 以及 v5.0.0，则需要依赖 0.2.17 版本 dns 解析库
依赖示例如下：
dependencies {
implementation 'com.qiniu:happy-dns:1.0.0'
}
# 添加混淆
如果工程中添加了混淆，则七牛的包也需要添加混淆规则。
**若您使用 v5.2.4 之前的版本** ，则混淆规则如下：
-keep class org.webrtc.** {*;}
-dontwarn org.webrtc.**
-keep class com.qiniu.droid.rtc.**{*;}
-keep interface com.qiniu.droid.rtc.**{*;}
**若您使用 v5.2.4 的版本** ，则混淆规则如下：
-keep class org.qnwebrtc.** {*;}
-dontwarn org.qnwebrtc.**
-keep class com.qiniu.droid.rtc.**{*;}
-keep interface com.qiniu.droid.rtc.**{*;}
**若您使用的是 v5.2.5 及之后的版本** ，则混淆规则如下：
-keep class org.qnwebrtc.** {*;}
-dontwarn org.qnwebrtc.**
-keep class com.qiniu.droid.rtc.**{*;}
-keep class com.qiniu.droid.qcrash.**{*;}
-keep interface com.qiniu.droid.rtc.**{*;}
# 添加相关权限
在工程的 AndroidManifest.xml 中增加如下 `uses-permission` 声明：
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.BLUETOOTH" />
<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
如果您的应用适配了 API 31 及以上的版本, 为了在通话过程中使用蓝牙耳机设备, 请以以下方式适配：
<uses-permission android:name="android.permission.BLUETOOTH"
android:maxSdkVersion="30" />
<uses-permission android:name="android.permission.BLUETOOTH_CONNECT" />
从 Android 6.0 (API 23)
开始，用户需要在应用运行时授予权限，而不是在应用安装时授予，同时权限分为正常权限和危险权限两种类型。在实时音视频 SDK
中，用户需要在进入音视频通话前选择一个适当的时机动态申请 `CAMERA`、`RECORD_AUDIO`、`BLUETOOTH_CONNECT`
权限，关于权限申请，具体可参考 [Android
官方文档](https://developer.android.com/training/permissions/requesting?hl=zh-cn)。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > 快速入门 > Android >开发准备
# 开发准备
最近更新时间: 2024-08-23 18:06:05
本文主要介绍开发前的准备工作，包括开发环境的要求、SDK 的导入等。
# 前提条件
* Android Studio 开发工具，官方[下载地址](http://developer.android.com/intl/zh-cn/sdk/index.html)
* 有效的[开发者平台账号](https://developer.qiniu.io/rtc/9849/console)
# 设备及系统要求
* 系统要求：Android 4.3 (API 18) 及以上
* Java 版本: Java 8+
# 下载并导入实时音视频 SDK
SDK 可通过[公有 repo](https://github.com/pili-engineering/QNRTC-Android) 下载获取。
Repo 中主要包含 demo 示例代码、SDK jar 包，以及 SDK 依赖的动态库文件。 其中，releases 目录下是需要拷贝到您的
Android 工程的所有文件，以目前主流的 armeabi-v7a 架构为例，具体如下：
文件名称| 功能| 大小| 备注
---|---|---|---
qndroid-rtc-x.y.z.jar| SDK 库| 785 KB| 必须依赖
libqndroid_rtc.so| 连麦| 9.33 MB| 必须依赖
libqnquic.so| 信令协议| 2.2M| 建议依赖
libqcrash.so| 崩溃搜集| 49.8 KB| 建议依赖
libqndroid_beauty.so| 美颜| 442 KB| 不用自带美颜，可以不依赖
libqndroid_amix.so| 混音| 335 KB| 不用混音功能，可以不依赖
> 将 RTC SDK 集成到 App 后，App 的增量大小如下 (包含默认美颜包):
>
> * armeabi-v7a : 5.4 MB
> * arm64-v8a : 6.1 MB
> * x86 : 6.1 MB
>
* 将 qndroid-rtc-x.y.z.jar 包拷贝到您的工程的 libs 目录下，最新版本可查看[版本更新日志](https://developer.qiniu.com/rtc/product_dynamic/9399/update-log-android)获取。
* 将动态库拷贝到您的工程对应的目录下，例如：armeabi-v7a 目录下的 so 则拷贝到工程的 jniLibs/armeabi-v7a 目录下
具体可以参考 SDK 包含的 demo 工程，集成后的工程示例如下：
# 修改 build.gradle
打开工程目录下的 build.gradle，确保已经**添加了如下 sdk 的库依赖** ，如下所示：
dependencies {
implementation files('libs/qndroid-rtc-x.y.z.jar')
}
**添加对 Java8 语言功能的支持：**
android {
...
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
}
**关于 dns 解析库的依赖，根据您使用版本的不同，需要依赖的具体版本信息如下：**
* 如果您使用的版本是 v5.0.1+，则不再需要依赖 dns 解析库。
* 如果您使用的版本是 v4.0.2，则需要依赖 1.0.0 版本 dns 解析库
* 如果您使用的版本是 v2.5.0+ 以及 v5.0.0，则需要依赖 0.2.17 版本 dns 解析库
依赖示例如下：
dependencies {
implementation 'com.qiniu:happy-dns:1.0.0'
}
# 添加混淆
如果工程中添加了混淆，则七牛的包也需要添加混淆规则。
**若您使用 v5.2.4 之前的版本** ，则混淆规则如下：
-keep class org.webrtc.** {*;}
-dontwarn org.webrtc.**
-keep class com.qiniu.droid.rtc.**{*;}
-keep interface com.qiniu.droid.rtc.**{*;}
**若您使用 v5.2.4 的版本** ，则混淆规则如下：
-keep class org.qnwebrtc.** {*;}
-dontwarn org.qnwebrtc.**
-keep class com.qiniu.droid.rtc.**{*;}
-keep interface com.qiniu.droid.rtc.**{*;}
**若您使用的是 v5.2.5 及之后的版本** ，则混淆规则如下：
-keep class org.qnwebrtc.** {*;}
-dontwarn org.qnwebrtc.**
-keep class com.qiniu.droid.rtc.**{*;}
-keep class com.qiniu.droid.qcrash.**{*;}
-keep interface com.qiniu.droid.rtc.**{*;}
# 添加相关权限
在工程的 AndroidManifest.xml 中增加如下 `uses-permission` 声明：
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.BLUETOOTH" />
<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
如果您的应用适配了 API 31 及以上的版本, 为了在通话过程中使用蓝牙耳机设备, 请以以下方式适配：
<uses-permission android:name="android.permission.BLUETOOTH"
android:maxSdkVersion="30" />
<uses-permission android:name="android.permission.BLUETOOTH_CONNECT" />
从 Android 6.0 (API 23)
开始，用户需要在应用运行时授予权限，而不是在应用安装时授予，同时权限分为正常权限和危险权限两种类型。在实时音视频 SDK
中，用户需要在进入音视频通话前选择一个适当的时机动态申请 `CAMERA`、`RECORD_AUDIO`、`BLUETOOTH_CONNECT`
权限，关于权限申请，具体可参考 [Android
官方文档](https://developer.android.com/training/permissions/requesting?hl=zh-cn)。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,859 |
实现视频通话 | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > 快速入门 > Android >实现视频通话
# 实现视频通话
最近更新时间: 2024-07-15 14:41:05
本文将介绍如何快速实现一个基本的实时音视频应用。该应用会展示 SDK 基本的连麦功能，包括 **加入房间** ，**采集** ，**发布** ，**订阅**
等过程。
> * 若您的开发环境还没有搭建完成，SDK
> 还未导入，请先参考[开发准备](https://developer.qiniu.com/rtc/quick_start/8765/prepare-
> android-development)文档进行 SDK 的导入等工作。
> * 若您对实时音视频的**发布、订阅**
> 等基本流程还不熟悉，请先参考[基本概念](https://developer.qiniu.com/rtc/quick_start/9909/the-
> rtc-basic-concept)对实时音视频通话过程中的相关概念略作了解。
>
# 初始化
首先，在进行 SDK 接口调用之前，需要在 Activity 生命周期中的 onCreate() 中进行初始化操作：
QNRTC.init(context, new QNRTCEventListener());
# 添加视频渲染控件
用户需要在布局文件中期望的位置添加两个
[QNSurfaceView](https://developer.qiniu.com/rtc/api/8690/QNSurfaceView)
分别用来做本地视频画面预览窗口和远端视频画面渲染窗口。
示例代码如下：
<com.qiniu.droid.rtc.QNSurfaceView
android:id="@+id/local_surface_view"
android:layout_width="match_parent"
android:layout_height="match_parent" />
<com.qiniu.droid.rtc.QNSurfaceView
android:id="@+id/remote_surface_view"
android:layout_width="150dp"
android:layout_height="150dp" />
mLocalWindow = findViewById(R.id.local_surface_view);
mRemoteWindow = findViewById(R.id.remote_surface_view);
# 创建音视频通话核心类
本操作推荐在 Activity 生命周期中的 onCreate() 中完成
QNRTCClient mClient = QNRTC.createClient(new QNClientEventListener());
其中，[QNClientEventListener](https://developer.qiniu.com/rtc/api/8643/QNClientEventListener)
为音视频通话过程中必须的事件监听回调。
# 创建音视频采集 Track
[Track](https://developer.qiniu.com/rtc/quick_start/9909/the-rtc-basic-
concept#track) 代表了音视频通话过程中的一路音频或者一路视频，本文仅介绍一路音视频连麦的场景，创建方式如下：
QNCameraVideoTrack mCameraVideoTrack = QNRTC.createCameraVideoTrack();
QNMicrophoneAudioTrack mMicrophoneAudioTrack = QNRTC.createMicrophoneAudioTrack();
创建好本地视频 [Track](https://developer.qiniu.com/rtc/quick_start/9909/the-rtc-
basic-concept#track) 后即可设置渲染窗口，代码如下：
mCameraVideoTrack.play(mLocalWindow);
> **注意** ：创建 Track 需要 App 获取 `CAMERA`、`RECORD_AUDIO`
> 等采集相关的权限，请确保您的应用已经获取该权限，否则数据采集将会失败。权限申请可参考 [QNRTC-API-
> Examples](https://github.com/pili-engineering/QNRTC-
> Android/blob/master/QNRTC-API-
> Examples/app/src/main/java/com/qiniu/droid/rtc/api/examples/utils/PermissionChecker.java)
为了更好的控制采集的流程，可以在生命周期函数中添加如下调用：
@Override
protected void onResume() {
super.onResume();
// 开始视频采集
if (mCameraVideoTrack != null) {
mCameraVideoTrack.startCapture();
}
}
@Override
protected void onPause() {
super.onPause();
// 停止视频采集
if (mCameraTrack != null) {
mCameraTrack.stopCapture();
}
}
# 加入房间
完成初始化和本地音视频 Track 的创建后，您就可以调用
[QNRTCClient.join](https://developer.qiniu.com/rtc/api/8684/QNRTCClient#join%5B1/2%5D)
接口加入房间了。
> 加入房间需要携带相应的
> [RoomToken](https://developer.qiniu.com/rtc/quick_start/9909/the-rtc-basic-
> concept#room_token)：
>
> 1. [RoomToken](https://developer.qiniu.com/rtc/quick_start/9909/the-rtc-
> basic-concept#room_token) 建议通过您的服务端生成，签算方式可参考 [RoomToken
> 签发服务](https://developer.qiniu.com/rtc/development_guidelines/8813/roomToken)。
> 2.
> 若您的服务端还没有实现相关代码，可参考[管理实时音视频](https://developer.qiniu.com/rtc/9858/applist#4)文档在
> [portal](https://portal.qiniu.com/rtn/app) 上生成临时的 token，需要注意 **UserID 不可重复**
> 。
>
[RoomToken](https://developer.qiniu.com/rtc/quick_start/9909/the-rtc-basic-
concept#room_token) 准备好后，即可通过如下代码加入房间：
mClient.join(token);
加入房间成功后会触发
[QNClientEventListener.onConnectionStateChanged](https://developer.qiniu.com/rtc/api/8643/QNClientEventListener#onConnectionStateChanged)
回调 QNConnectionState.CONNECTED 状态。此时，即可通过发布、订阅等操作来实现音视频的推送和接收。
在进入音视频通话房间之后，用户可以根据业务场景的需求在适当的时间调用离开房间的接口退出连麦，详情请见[房间管理](https://developer.qiniu.com/rtc/development_guidelines/8768/room-
management-android)。
> **注意** ：加入、离开房间代表一次音视频通话的开始和结束，一次会话仅需调用一次加入、离开的操作即可，无需重复调用。
# 发布本地音视频 Track
成功加入房间后，即可在
[QNClientEventListener.onConnectionStateChanged](https://developer.qiniu.com/rtc/api/8643/QNClientEventListener#onConnectionStateChanged)
回调中调用以下代码进行本地 Track 的发布：
@Override
public void onConnectionStateChanged(QNConnectionState state, @Nullable QNConnectionDisconnectedInfo info) {
if (state == QNConnectionState.CONNECTED) {
mClient.publish(new QNPublishResultCallback() {
@Override
public void onPublished() {
// Track 发布成功时回调
}
@Override
public void onError(int errorCode, String errorMessage) {
// Track 发布失败时回调
}
}, mCameraVideoTrack, mMicrophoneAudioTrack);
}
}
发布成功后，本地会收到
[QNPublishResultCallback.onPublished](https://developer.qiniu.com/rtc/api/8673/QNPublishResultCallback#onPublished)
回调。远端用户会收到
[QNClientEventListener.onUserPublished](https://developer.qiniu.com/rtc/api/8643/QNClientEventListener#onUserPublished)
回调。
取消发布可以通过调用
[QNRTCClient.unpublish](https://developer.qiniu.com/rtc/api/8684/QNRTCClient#unpublish%5B1/2%5D)
方法实现。取消发布后，本地音视频数据将停止发送，但仍可以接收远端的音视频数据。更多内容可参考[发布和订阅](https://developer.qiniu.com/rtc/development_guidelines/8769/publish-
and-subscribe-android)。
# 订阅远端音视频 Track
当远端成功发布音视频数据后，SDK 默认会进行自动订阅，订阅成功后将会收到
[QNClientEventListener.onSubscribed](https://developer.qiniu.com/rtc/api/8643/QNClientEventListener#onSubscribed)
的回调，在此回调内可设置 [Track](https://developer.qiniu.com/rtc/quick_start/9909/the-rtc-
basic-concept#track) 的渲染窗口：
@Override
public void onSubscribed(String remoteUserID, List<QNRemoteAudioTrack> remoteAudioTracks, List<QNRemoteVideoTrack> remoteVideoTracks) {
for(QNRemoteVideoTrack track : remoteVideoTracks) {
track.play(remoteWindow);
}
}
在成功订阅之后，用户可以根据业务场景的需求在适当的时间调用取消订阅的接口取消订阅相应的
Track，详情请见[发布与订阅](https://developer.qiniu.com/rtc/development_guidelines/8769/publish-
and-subscribe-android)
# 离开房间
当音视频通话结束，调用以下代码离开房间：
mClient.leave()
离开房间成功后会触发
[QNClientEventListener.onConnectionStateChanged](https://developer.qiniu.com/rtc/api/8643/QNClientEventListener#onConnectionStateChanged)
回调 `QNConnectionState.DISCONNECTED` 状态，对应
[QNConnectionDisconnectedInfo.Reason](https://developer.qiniu.com/rtc/api/8644/QNConnectionDisconnectedInfo#Reason)
为 `LEAVE`。
> **注意** ：离开房间代表本次音视频通话的结束，离开后将无法发布本地音视频，也无法订阅远端音视频。
# 销毁
在整个 Activity 销毁时，用户需要调用以下代码对资源进行释放，一般此操作建议在 Activity 生命周期的 `onDestroy()`
中进行，示例代码如下：
@Override
protected void onDestroy() {
super.onDestroy();
QNRTC.deinit();
}
# 示例代码
按照上述流程即可实现一个基本的实时音视频通话应用，完整的示例代码可参考 [QNRTC-API-
Examples](https://github.com/pili-engineering/QNRTC-Android/blob/master/QNRTC-
API-
Examples/app/src/main/java/com/qiniu/droid/rtc/api/examples/activity/CameraMicrophoneActivity.java)。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > 快速入门 > Android >实现视频通话
# 实现视频通话
最近更新时间: 2024-07-15 14:41:05
本文将介绍如何快速实现一个基本的实时音视频应用。该应用会展示 SDK 基本的连麦功能，包括 **加入房间** ，**采集** ，**发布** ，**订阅**
等过程。
> * 若您的开发环境还没有搭建完成，SDK
> 还未导入，请先参考[开发准备](https://developer.qiniu.com/rtc/quick_start/8765/prepare-
> android-development)文档进行 SDK 的导入等工作。
> * 若您对实时音视频的**发布、订阅**
> 等基本流程还不熟悉，请先参考[基本概念](https://developer.qiniu.com/rtc/quick_start/9909/the-
> rtc-basic-concept)对实时音视频通话过程中的相关概念略作了解。
>
# 初始化
首先，在进行 SDK 接口调用之前，需要在 Activity 生命周期中的 onCreate() 中进行初始化操作：
QNRTC.init(context, new QNRTCEventListener());
# 添加视频渲染控件
用户需要在布局文件中期望的位置添加两个
[QNSurfaceView](https://developer.qiniu.com/rtc/api/8690/QNSurfaceView)
分别用来做本地视频画面预览窗口和远端视频画面渲染窗口。
示例代码如下：
<com.qiniu.droid.rtc.QNSurfaceView
android:id="@+id/local_surface_view"
android:layout_width="match_parent"
android:layout_height="match_parent" />
<com.qiniu.droid.rtc.QNSurfaceView
android:id="@+id/remote_surface_view"
android:layout_width="150dp"
android:layout_height="150dp" />
mLocalWindow = findViewById(R.id.local_surface_view);
mRemoteWindow = findViewById(R.id.remote_surface_view);
# 创建音视频通话核心类
本操作推荐在 Activity 生命周期中的 onCreate() 中完成
QNRTCClient mClient = QNRTC.createClient(new QNClientEventListener());
其中，[QNClientEventListener](https://developer.qiniu.com/rtc/api/8643/QNClientEventListener)
为音视频通话过程中必须的事件监听回调。
# 创建音视频采集 Track
[Track](https://developer.qiniu.com/rtc/quick_start/9909/the-rtc-basic-
concept#track) 代表了音视频通话过程中的一路音频或者一路视频，本文仅介绍一路音视频连麦的场景，创建方式如下：
QNCameraVideoTrack mCameraVideoTrack = QNRTC.createCameraVideoTrack();
QNMicrophoneAudioTrack mMicrophoneAudioTrack = QNRTC.createMicrophoneAudioTrack();
创建好本地视频 [Track](https://developer.qiniu.com/rtc/quick_start/9909/the-rtc-
basic-concept#track) 后即可设置渲染窗口，代码如下：
mCameraVideoTrack.play(mLocalWindow);
> **注意** ：创建 Track 需要 App 获取 `CAMERA`、`RECORD_AUDIO`
> 等采集相关的权限，请确保您的应用已经获取该权限，否则数据采集将会失败。权限申请可参考 [QNRTC-API-
> Examples](https://github.com/pili-engineering/QNRTC-
> Android/blob/master/QNRTC-API-
> Examples/app/src/main/java/com/qiniu/droid/rtc/api/examples/utils/PermissionChecker.java)
为了更好的控制采集的流程，可以在生命周期函数中添加如下调用：
@Override
protected void onResume() {
super.onResume();
// 开始视频采集
if (mCameraVideoTrack != null) {
mCameraVideoTrack.startCapture();
}
}
@Override
protected void onPause() {
super.onPause();
// 停止视频采集
if (mCameraTrack != null) {
mCameraTrack.stopCapture();
}
}
# 加入房间
完成初始化和本地音视频 Track 的创建后，您就可以调用
[QNRTCClient.join](https://developer.qiniu.com/rtc/api/8684/QNRTCClient#join%5B1/2%5D)
接口加入房间了。
> 加入房间需要携带相应的
> [RoomToken](https://developer.qiniu.com/rtc/quick_start/9909/the-rtc-basic-
> concept#room_token)：
>
> 1. [RoomToken](https://developer.qiniu.com/rtc/quick_start/9909/the-rtc-
> basic-concept#room_token) 建议通过您的服务端生成，签算方式可参考 [RoomToken
> 签发服务](https://developer.qiniu.com/rtc/development_guidelines/8813/roomToken)。
> 2.
> 若您的服务端还没有实现相关代码，可参考[管理实时音视频](https://developer.qiniu.com/rtc/9858/applist#4)文档在
> [portal](https://portal.qiniu.com/rtn/app) 上生成临时的 token，需要注意 **UserID 不可重复**
> 。
>
[RoomToken](https://developer.qiniu.com/rtc/quick_start/9909/the-rtc-basic-
concept#room_token) 准备好后，即可通过如下代码加入房间：
mClient.join(token);
加入房间成功后会触发
[QNClientEventListener.onConnectionStateChanged](https://developer.qiniu.com/rtc/api/8643/QNClientEventListener#onConnectionStateChanged)
回调 QNConnectionState.CONNECTED 状态。此时，即可通过发布、订阅等操作来实现音视频的推送和接收。
在进入音视频通话房间之后，用户可以根据业务场景的需求在适当的时间调用离开房间的接口退出连麦，详情请见[房间管理](https://developer.qiniu.com/rtc/development_guidelines/8768/room-
management-android)。
> **注意** ：加入、离开房间代表一次音视频通话的开始和结束，一次会话仅需调用一次加入、离开的操作即可，无需重复调用。
# 发布本地音视频 Track
成功加入房间后，即可在
[QNClientEventListener.onConnectionStateChanged](https://developer.qiniu.com/rtc/api/8643/QNClientEventListener#onConnectionStateChanged)
回调中调用以下代码进行本地 Track 的发布：
@Override
public void onConnectionStateChanged(QNConnectionState state, @Nullable QNConnectionDisconnectedInfo info) {
if (state == QNConnectionState.CONNECTED) {
mClient.publish(new QNPublishResultCallback() {
@Override
public void onPublished() {
// Track 发布成功时回调
}
@Override
public void onError(int errorCode, String errorMessage) {
// Track 发布失败时回调
}
}, mCameraVideoTrack, mMicrophoneAudioTrack);
}
}
发布成功后，本地会收到
[QNPublishResultCallback.onPublished](https://developer.qiniu.com/rtc/api/8673/QNPublishResultCallback#onPublished)
回调。远端用户会收到
[QNClientEventListener.onUserPublished](https://developer.qiniu.com/rtc/api/8643/QNClientEventListener#onUserPublished)
回调。
取消发布可以通过调用
[QNRTCClient.unpublish](https://developer.qiniu.com/rtc/api/8684/QNRTCClient#unpublish%5B1/2%5D)
方法实现。取消发布后，本地音视频数据将停止发送，但仍可以接收远端的音视频数据。更多内容可参考[发布和订阅](https://developer.qiniu.com/rtc/development_guidelines/8769/publish-
and-subscribe-android)。
# 订阅远端音视频 Track
当远端成功发布音视频数据后，SDK 默认会进行自动订阅，订阅成功后将会收到
[QNClientEventListener.onSubscribed](https://developer.qiniu.com/rtc/api/8643/QNClientEventListener#onSubscribed)
的回调，在此回调内可设置 [Track](https://developer.qiniu.com/rtc/quick_start/9909/the-rtc-
basic-concept#track) 的渲染窗口：
@Override
public void onSubscribed(String remoteUserID, List<QNRemoteAudioTrack> remoteAudioTracks, List<QNRemoteVideoTrack> remoteVideoTracks) {
for(QNRemoteVideoTrack track : remoteVideoTracks) {
track.play(remoteWindow);
}
}
在成功订阅之后，用户可以根据业务场景的需求在适当的时间调用取消订阅的接口取消订阅相应的
Track，详情请见[发布与订阅](https://developer.qiniu.com/rtc/development_guidelines/8769/publish-
and-subscribe-android)
# 离开房间
当音视频通话结束，调用以下代码离开房间：
mClient.leave()
离开房间成功后会触发
[QNClientEventListener.onConnectionStateChanged](https://developer.qiniu.com/rtc/api/8643/QNClientEventListener#onConnectionStateChanged)
回调 `QNConnectionState.DISCONNECTED` 状态，对应
[QNConnectionDisconnectedInfo.Reason](https://developer.qiniu.com/rtc/api/8644/QNConnectionDisconnectedInfo#Reason)
为 `LEAVE`。
> **注意** ：离开房间代表本次音视频通话的结束，离开后将无法发布本地音视频，也无法订阅远端音视频。
# 销毁
在整个 Activity 销毁时，用户需要调用以下代码对资源进行释放，一般此操作建议在 Activity 生命周期的 `onDestroy()`
中进行，示例代码如下：
@Override
protected void onDestroy() {
super.onDestroy();
QNRTC.deinit();
}
# 示例代码
按照上述流程即可实现一个基本的实时音视频通话应用，完整的示例代码可参考 [QNRTC-API-
Examples](https://github.com/pili-engineering/QNRTC-Android/blob/master/QNRTC-
API-
Examples/app/src/main/java/com/qiniu/droid/rtc/api/examples/activity/CameraMicrophoneActivity.java)。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,866 |
SDK 概览 | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > 快速入门 > iOS >SDK 概览
# SDK 概览
最近更新时间: 2024-05-31 16:03:27
> 本文档适用于 QNRTCKit 5.x 及以上版本的 SDK，并不向下兼容。
>
> * [3.x 及之前版本的相关文档](https://doc.qnsdk.com/rtn/ios)
> * [5.x
> 版本迁移指南](https://developer.qiniu.com/rtc/development_guidelines/11949/migration-
> guide-iOS-v5)
>
QNRTCKit 是七牛推出的一款适用于 iOS 平台的音视频通话
SDK，提供了包括美颜、滤镜、水印、音视频通话等多种功能，提供灵活的接口，支持高度定制以及二次开发，您可以很方便地在 iOS
平台上开发出一款基于实时音视频的应用。其中包括但不限于以下场景：
* 在线教育
* 在线直播互动连麦
* 视频会议
* 一对一社交
* 狼人杀等依赖实时音视频通话的游戏
* 在线客服
* 在线抓娃娃
# 下载地址
* [iOS API Demo：](https://github.com/pili-engineering/QNRTC-iOS/tree/master/QNRTC-API-Examples)最详细接口使用 Demo，提供了音视频通话、纯音频通话、CDN 转推、音频混音等不同场景的实现示例，便于您理解各个场景的实现方式
* [iOS 1v1 Demo：](https://github.com/pili-engineering/QNRTC-SampleCode-Video-Basic/tree/master/One-On-One-Video/One-On-One-Video-iOS)最简单的 SDK 接口使用 Demo，便于您理解音视频通话的核心流程以及核心接口的使用方式。
* [iOS 体验 Demo：](https://github.com/pili-engineering/QNRTC-iOS/tree/master/QNRTCKitDemo)会议场景 Demo，包含视频会议、音频会议、屏幕共享、大小窗口切换、CDN 转推等一系列功能场景。您可以在理解了音视频通话的主要流程后，参考该 Demo 以扩展更多的高级功能。
# 功能列表
功能| 版本
---|---
支持音视频本地录制| v6.2.0(+)
SDK 稳定性优化| v6.1.0(+)
音频弱网 QoS 优化| v6.1.0(+)
支持直推 CDN| v6.0.0(+)
支持更多外部音频格式导入| v5.2.7(+)
支持麦克风启动开关及错误回调| v5.2.7(+)
CustomAudioTrack 支持混音功能| v5.2.6(+)
支持 pc 重连超时、mcu 获取超时时间| v5.2.6(+)
支持语音激励| v5.2.6(+)
支持软件回音消除| v5.2.6(+)
支持信令 quic| v5.2.5(+)
支持 mcu 备用域名设置| v5.2.5(+)
支持软件编码| v5.2.5(+)
支持编码预设配置| v5.2.4(+)
支持重连超时配置| v5.2.4(+)
支持视频降级默认值区分场景| v5.2.4(+)
支持本地和远端视频 stats 回调宽高信息| v5.2.4(+)
支持切换摄像头结果回调| v5.2.3(+)
支持摄像头采集运行过程中发生错误回调| v5.2.3(+)
支持设置视频在弱网下的降级模式| v5.2.3(+)
支持日志文件上传| v5.2.3(+)
支持音频场景配置| v5.2.3(+)
支持发布多音频 Track| v5.2.3(+)
支持动态修改编码配置| v5.2.1(+)
支持通话模式开关| v5.2.0(+)
支持推流固定分辨率| v5.2.0(+)
支持音乐、音效及音源 RTC 本地播放| v5.2.0(+)
支持多 PCM 混音| v5.2.0(+)
支持多重音效混音| v5.1.0(+)
支持获取本地或远端音频数据音量等级| v4.0.3(+)
支持跨房间场景用户角色| v4.0.1(+)
支持跨房间媒体转发| v4.0.1(+)
支持合流 SEI| v3.0.2(+)
支持延迟停止单路转推| v3.0.1(+)
支持延迟停止合流| v3.0.1(+)
支持视频 SEI| v3.0.1(+)
支持麦克风音量调节| v3.0.1(+)
支持摄像头 Track 发送图片| v3.0.1(+)
支持编码数据加密传输| v3.0.0(+)
支持编码自定义拓展数据传输| v3.0.0(+)
支持远端音频播放音量调节| v3.0.0(+)
支持大小流传输| v2.5.0(+)
支持单路转推| v2.5.0(+)
支持配置 RTC 与其他音频同时播放| v2.3.1(+)
支持双声道音频| v2.3.0(+)
支持音量大小回调| v2.3.0(+)
支持自定义消息| v2.3.0(+)
支持背景音乐混音功能| v2.2.0(+)
支持使用 TCP 传输媒体流| v2.2.0(+)
支持本地/远端画面截帧| v2.1.0(+)
支持使用蓝牙耳机通话| v2.1.0(+)
支持扬声器/听筒切换| v2.1.0(+)
支持音视频分别发布| v2.0.0(+)
支持发布多路视频| v2.0.0(+)
支持外部导入数据（可用于录屏）| v1.0.0(+)
支持回调本地音频数据| v0.2.0(+)
支持回调远端音频数据| v0.2.0(+)
支持回调远端视频数据| v0.2.0(+)
支持编码镜像| v0.2.0(+)
支持合流参数配置| v0.2.0(+)
支持后台连麦| v0.1.0(+)
支持纯音频连麦| v0.1.0(+)
支持硬件编码| v0.1.0(+)
支持码率上下限配置| v0.1.0(+)
支持多分辨率编码| v0.1.0(+)
支持回调本地视频数据| v0.1.0(+)
支持实时美颜滤镜| v0.1.0(+)
支持第三方美颜滤镜| v0.1.0(+)
支持水印功能| v0.1.0(+)
支持踢人功能| v0.1.0(+)
支持静音功能| v0.1.0(+)
支持自动/手动对焦| v0.1.0(+)
支持实时状态回调| v0.1.0(+)
支持回调连麦房间统计信息| v0.1.0(+)
支持丰富的连麦消息回调| v0.1.0(+)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > 快速入门 > iOS >SDK 概览
# SDK 概览
最近更新时间: 2024-05-31 16:03:27
> 本文档适用于 QNRTCKit 5.x 及以上版本的 SDK，并不向下兼容。
>
> * [3.x 及之前版本的相关文档](https://doc.qnsdk.com/rtn/ios)
> * [5.x
> 版本迁移指南](https://developer.qiniu.com/rtc/development_guidelines/11949/migration-
> guide-iOS-v5)
>
QNRTCKit 是七牛推出的一款适用于 iOS 平台的音视频通话
SDK，提供了包括美颜、滤镜、水印、音视频通话等多种功能，提供灵活的接口，支持高度定制以及二次开发，您可以很方便地在 iOS
平台上开发出一款基于实时音视频的应用。其中包括但不限于以下场景：
* 在线教育
* 在线直播互动连麦
* 视频会议
* 一对一社交
* 狼人杀等依赖实时音视频通话的游戏
* 在线客服
* 在线抓娃娃
# 下载地址
* [iOS API Demo：](https://github.com/pili-engineering/QNRTC-iOS/tree/master/QNRTC-API-Examples)最详细接口使用 Demo，提供了音视频通话、纯音频通话、CDN 转推、音频混音等不同场景的实现示例，便于您理解各个场景的实现方式
* [iOS 1v1 Demo：](https://github.com/pili-engineering/QNRTC-SampleCode-Video-Basic/tree/master/One-On-One-Video/One-On-One-Video-iOS)最简单的 SDK 接口使用 Demo，便于您理解音视频通话的核心流程以及核心接口的使用方式。
* [iOS 体验 Demo：](https://github.com/pili-engineering/QNRTC-iOS/tree/master/QNRTCKitDemo)会议场景 Demo，包含视频会议、音频会议、屏幕共享、大小窗口切换、CDN 转推等一系列功能场景。您可以在理解了音视频通话的主要流程后，参考该 Demo 以扩展更多的高级功能。
# 功能列表
功能| 版本
---|---
支持音视频本地录制| v6.2.0(+)
SDK 稳定性优化| v6.1.0(+)
音频弱网 QoS 优化| v6.1.0(+)
支持直推 CDN| v6.0.0(+)
支持更多外部音频格式导入| v5.2.7(+)
支持麦克风启动开关及错误回调| v5.2.7(+)
CustomAudioTrack 支持混音功能| v5.2.6(+)
支持 pc 重连超时、mcu 获取超时时间| v5.2.6(+)
支持语音激励| v5.2.6(+)
支持软件回音消除| v5.2.6(+)
支持信令 quic| v5.2.5(+)
支持 mcu 备用域名设置| v5.2.5(+)
支持软件编码| v5.2.5(+)
支持编码预设配置| v5.2.4(+)
支持重连超时配置| v5.2.4(+)
支持视频降级默认值区分场景| v5.2.4(+)
支持本地和远端视频 stats 回调宽高信息| v5.2.4(+)
支持切换摄像头结果回调| v5.2.3(+)
支持摄像头采集运行过程中发生错误回调| v5.2.3(+)
支持设置视频在弱网下的降级模式| v5.2.3(+)
支持日志文件上传| v5.2.3(+)
支持音频场景配置| v5.2.3(+)
支持发布多音频 Track| v5.2.3(+)
支持动态修改编码配置| v5.2.1(+)
支持通话模式开关| v5.2.0(+)
支持推流固定分辨率| v5.2.0(+)
支持音乐、音效及音源 RTC 本地播放| v5.2.0(+)
支持多 PCM 混音| v5.2.0(+)
支持多重音效混音| v5.1.0(+)
支持获取本地或远端音频数据音量等级| v4.0.3(+)
支持跨房间场景用户角色| v4.0.1(+)
支持跨房间媒体转发| v4.0.1(+)
支持合流 SEI| v3.0.2(+)
支持延迟停止单路转推| v3.0.1(+)
支持延迟停止合流| v3.0.1(+)
支持视频 SEI| v3.0.1(+)
支持麦克风音量调节| v3.0.1(+)
支持摄像头 Track 发送图片| v3.0.1(+)
支持编码数据加密传输| v3.0.0(+)
支持编码自定义拓展数据传输| v3.0.0(+)
支持远端音频播放音量调节| v3.0.0(+)
支持大小流传输| v2.5.0(+)
支持单路转推| v2.5.0(+)
支持配置 RTC 与其他音频同时播放| v2.3.1(+)
支持双声道音频| v2.3.0(+)
支持音量大小回调| v2.3.0(+)
支持自定义消息| v2.3.0(+)
支持背景音乐混音功能| v2.2.0(+)
支持使用 TCP 传输媒体流| v2.2.0(+)
支持本地/远端画面截帧| v2.1.0(+)
支持使用蓝牙耳机通话| v2.1.0(+)
支持扬声器/听筒切换| v2.1.0(+)
支持音视频分别发布| v2.0.0(+)
支持发布多路视频| v2.0.0(+)
支持外部导入数据（可用于录屏）| v1.0.0(+)
支持回调本地音频数据| v0.2.0(+)
支持回调远端音频数据| v0.2.0(+)
支持回调远端视频数据| v0.2.0(+)
支持编码镜像| v0.2.0(+)
支持合流参数配置| v0.2.0(+)
支持后台连麦| v0.1.0(+)
支持纯音频连麦| v0.1.0(+)
支持硬件编码| v0.1.0(+)
支持码率上下限配置| v0.1.0(+)
支持多分辨率编码| v0.1.0(+)
支持回调本地视频数据| v0.1.0(+)
支持实时美颜滤镜| v0.1.0(+)
支持第三方美颜滤镜| v0.1.0(+)
支持水印功能| v0.1.0(+)
支持踢人功能| v0.1.0(+)
支持静音功能| v0.1.0(+)
支持自动/手动对焦| v0.1.0(+)
支持实时状态回调| v0.1.0(+)
支持回调连麦房间统计信息| v0.1.0(+)
支持丰富的连麦消息回调| v0.1.0(+)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 4,876 |
Subsets and Splits