CloudStorage
云端录制文件上传到云存储的参数(对象存储cos)
被如下接口引用:CreateCloudRecording。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Vendor | Integer | 是 | 腾讯云对象存储COS以及第三方云存储账号信息 0:腾讯云对象存储 COS 1:AWS 【注意】目前第三方云存储仅支持AWS,更多第三方云存储陆续支持中 示例值:0 示例值:0 |
Region | String | 是 | 腾讯云对象存储的[地域信息](https://cloud.tencent.com/document/product/436/6224#.E5.9C.B0.E5.9F.9F)。 示例值:cn-shanghai-1 AWS S3[地域信息](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-regions) 示例值:ap-shanghai(cos, 具体参考云存储厂商支持的地域) 示例值:ap-nanjing |
Bucket | String | 是 | 云存储桶名称。 示例值:recording-1304123456 |
AccessKey | String | 是 | 云存储的access_key账号信息。 若存储至腾讯云对象存储COS,请前往https://console.cloud.tencent.com/cam/capi 查看或创建,对应链接中密钥字段的SecretId值。 示例值:test-accesskey |
SecretKey | String | 是 | 云存储的secret_key账号信息。 若存储至腾讯云对象存储COS,请前往https://console.cloud.tencent.com/cam/capi 查看或创建,对应链接中密钥字段的SecretKey值。 示例值:test-secretkey |
FileNamePrefix | Array of String | 否 | 云存储bucket 的指定位置,由字符串数组组成。合法的字符串范围az,AZ,0~9,'_'和'-',举个例子,录制文件xxx.m3u8在 ["prefix1", "prefix2"]作用下,会变成prefix1/prefix2/TaskId/xxx.m3u8。 示例值:["prefix1", "prefix2"] |
Device
查询用户设备的授权绑定情况
被如下接口引用:GetDevices。
名称 | 类型 | 描述 |
---|---|---|
DeviceId | String | 设备ID 示例值:"dev1" |
DeviceName | String | 设备名称 示例值:"devname" |
LicenseCount | Integer | 已经绑定license数量 示例值:2 |
RemainDay | Integer | 剩余天数:天 示例值:30 |
ExpireTime | String | 过期时间:s 示例值:167840945 |
Duration | String | 服务时长:s 示例值:86400 |
LicenseIds | Array of String | 已经绑定licenseId列表 示例值:["341c4a1d-3852-4eeb-bbdd-7e216f5c7345"] |
MonthlyRemainTime | Integer | 每月license的限定时长 示例值:66000 |
LimitedTime | Integer | 月封顶时长(分钟) 示例值:60000 |
DeviceInfo
设备信息
被如下接口引用:DescribeDeviceList。
名称 | 类型 | 描述 |
---|---|---|
DeviceId | String | 设备ID 示例值:“dev1” |
DeviceName | String | 设备名称 示例值:"test device" |
DeviceStatus | String | 设备状态,offline为离线,ready为在线准备,connected为会话中 示例值:offline |
DeviceType | String | 设备类型,field为现场设备(受控方),remote为远端设备(操控方) 示例值:"field" |
ModifyTime | Timestamp ISO8601 | 设备信息最近修改时间 示例值:2022-03-21T08:00:00+08:00 |
LastReportTime | Timestamp ISO8601 | 设备状态最近更新时间 示例值:2022-03-21T09:00:00+08:00 |
ProjectId | String | 设备所属项目Id 示例值:m82k54bp7n9rjhai |
License
按授权查看的license列表
被如下接口引用:GetLicenses。
名称 | 类型 | 描述 |
---|---|---|
Count | Integer | 该类型的license个数 示例值:3 |
Status | Integer | license状态:0:未绑定;1:已绑定;2:已停服;3:已退费 示例值:1 |
ExpireTime | String | 到期时间戳:s 示例值:1678503945 |
Duration | String | 服务时长:s 示例值:86400 |
RemainDay | Integer | 剩余天数:天 示例值:30 |
LicenseIds | Array of String | 该类型的licenseId列表 示例值:[ "478c67c3-19a1-4e5d-ae11-ad68883793ec", "6d05a06f-db82-4f61-8dd2-996c3378ec26" ] |
MultiNet
多网的网卡状态信息
被如下接口引用:DescribeDeviceSessionDetails。
名称 | 类型 | 描述 |
---|---|---|
NetId | Integer | 网卡序号 示例值:0 |
NetIp | String | 网卡IP 示例值:"10.211.65.6" |
Rtt | Array of Integer | 时延,单位ms 示例值:[10,20,30,20,10] |
Lost | Array of Integer | 丢包率,单位% 示例值:[10,20,30,20,10] |
SendBps | Array of Integer | 发送bps,单位kbps 示例值:[10,20,30,20,10] |
RecvBps | Array of Integer | 接收bps,单位kbps 示例值:[10,20,30,20,10] |
PolicyInfo
权限信息
被如下接口引用:DescribePolicy。
名称 | 类型 | 描述 |
---|---|---|
RemoteDeviceId | String | 远端设备ID 示例值:"test1" |
FieldDeviceIds | Array of String | 关联的现场设备ID 示例值:["dev1","dev2"] |
ModifyTime | Timestamp ISO8601 | 最近添加时间 示例值:2022-03-22T08:00:00+08:00 |
ProjectInfo
项目信息
被如下接口引用:DescribeProjectList。
名称 | 类型 | 描述 |
---|---|---|
ProjectId | String | 项目ID 示例值:f3glr49rc96pralw |
ProjectName | String | 项目名称 示例值:project1 |
ProjectDescription | String | 项目描述 示例值:project1 description |
PolicyMode | String | 项目权限模式,black为黑名单,white为白名单 示例值:black |
ModifyTime | Timestamp ISO8601 | 项目信息修改时间 示例值:2022-03-25T09:12:11+08:00 |
PublishParams
转推参数,一个任务最多支持10个推流URL。
被如下接口引用:StartPublishLiveStream。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
PublishUrl | String | 是 | 腾讯云直播推流地址url 示例值:rtmp://live-push-test.tencentcs.com/live/test2?txSecret=abcd1234567890&txTime=679C9784 |
IsTencentUrl | Integer | 是 | 是否是腾讯云CDN,0为转推非腾讯云CDN,1为转推腾讯CDN,不携带该参数默认为1。 示例值:1 |
RecentSessionInfo
最新会话信息
被如下接口引用:DescribeRecentSessionList。
名称 | 类型 | 描述 |
---|---|---|
SessionId | String | 会话ID 示例值:0a6b3e53-9307-4358-a5b6-76e3e4d027da-0 |
RemoteDeviceId | String | 远端设备ID 示例值:ctrl1 |
FieldDeviceId | String | 现场设备ID 示例值:dev1 |
Resolution | String | 分辨率 示例值:1920*1080 |
StartTime | Integer | 会话开始时间 示例值:1650000000 |
LatestUpdateTime | Integer | 最后更新时间 示例值:1650000060 |
SessionDeviceDetail
会话数据详单(按设备区分)
被如下接口引用:DescribeDeviceSessionDetails。
名称 | 类型 | 描述 |
---|---|---|
DeviceType | String | 设备类型:field或remote 示例值:remote |
StartTime | Integer | 起始点位时间,单位:秒 示例值:1650000000 |
EndTime | Integer | 结束点位时间,单位:秒 示例值:1650000100 |
SessionId | String | 会话ID 示例值:0a6b3e53-9307-4358-a5b6-76e3e4d027da-1 |
Rate | Array of Integer | 码率,单位:kbps 示例值:[10,20,30] |
Fps | Array of Integer | 帧率 示例值:[10,20,30] |
Lost | Array of Float | 丢包率,单位:% 示例值:[10,20,30] |
NetworkLatency | Array of Integer | 网络时延,单位:ms 示例值:[10,20,30] |
VideoLatency | Array of Integer | 视频时延,单位:ms 示例值:[10,20,30] |
CpuUsed | Array of Float | CPU使用率,单位:% 示例值:[10,20,30] |
MemUsed | Array of Float | 内存使用率,单位:% 示例值:[10,20,30] |
TimeOffset | Array of Integer | 时间偏移量,单位:秒 示例值:[0,2,4,6,8,10] |
ProjectId | String | 项目ID 示例值:m82k5408n675phvb |
DeviceId | String | 设备ID 示例值:dev1 |
Ver | String | sdk版本 示例值:1.4.7 |
SdkMode | String | 模式(p2p/server) 示例值:server |
DecodeCost | Array of Integer | 解码耗时,单位:ms 示例值:[20,20,30] |
K100 | Array of Float | 卡顿k100 示例值:[20.12,20.25,30.16] |
K150 | Array of Float | 卡顿k150 示例值:[20.12,20.25,30.16] |
NACK | Array of Integer | nack请求数 示例值:[0,0,0] |
BitRateEstimate | Array of Integer | 服务端调控码率,单位:kbps 示例值:3000 |
Width | Integer | 宽度 示例值:1280 |
Height | Integer | 高度 示例值:720 |
EncodeCost | Array of Integer | 编码耗时,单位:ms 示例值:[20.12,20.25,30.16] |
CaptureCost | Array of Integer | 采集耗时,单位:ms 示例值:[20.12,20.25,30.16] |
RenderCost | Array of Integer | 渲染耗时,单位:ms 示例值:[20,20,30] |
ConfigWidth | Integer | 配置宽度 示例值:1280 |
ConfigHeight | Integer | 配置高度 示例值:720 |
FrameDelta | Array of Integer | 平均帧间隔 示例值:[20.12,20.25,30.16] |
MaxFrameDelta | Array of Integer | 最大帧间隔 示例值:[20.12,20.25,30.16] |
TotalBitrateEstimate | Array of Integer | 总码率评估,单位:kbps 示例值:[20.12,20.25,30.16] |
Lag100Duration | Array of Integer | 帧间隔大于100ms的卡顿时长 示例值:[20.12,20.25,30.16] |
Lag150Duration | Array of Integer | 帧间隔大于150ms的卡顿时长 示例值:[20.12,20.25,30.16] |
MultiMode | Integer | 是否开启多网:0 单网,1 多网 示例值:0 |
MultiNet | Array of MultiNet | 多网卡信息 示例值:[{"NetId": 0, "NetIp": "192.168.12.4","Rtt": [132,126],"Lost": [0,0],"SendBps": [300,847],"RecvBps": [202,75]},{"NetId": 1,"NetIp": "192.168.21.2", "Rtt": [0,0],"Lost": [0,1],"SendBps": [7,2],"RecvBps": [0,10]}] |
SessionInfo
会话信息
被如下接口引用:DescribeDeviceSessionList。
名称 | 类型 | 描述 |
---|---|---|
SessionId | String | 会话ID 示例值:6c03e6d8-cac1-44bd-3c17-90148b37d1a8-0 |
RemoteDeviceId | String | 远端设备ID 示例值:ctrl1 |
FieldDeviceId | String | 现场设备ID 示例值:dev1 |
Resolution | String | 分辨率 示例值:1920*1080 |
StartTime | Integer | 会话开始时间 示例值:1650000000 |
EndTime | Integer | 会话结束时间 示例值:1650000060 |
Quality | String | 通话质量:good|normal|bad,对应优良差 示例值:good |
SessionIntervalStatistic
单位时间间隔的会话统计数据
被如下接口引用:DescribeSessionStatisticsByInterval。
名称 | 类型 | 描述 |
---|---|---|
ActiveFieldDeviceNum | Integer | 活跃现场设备数 示例值:10 |
ActiveRemoteDeviceNum | Integer | 活跃远端设备数 示例值:20 |
SessionNum | Integer | 会话数量 示例值:50 |
TotalDuration | Integer | 会话时长,单位:分钟 示例值:30 |
StartTime | Integer | 时间戳,单位:秒 示例值:1650000000 |
EndTime | Integer | 时间戳,单位:秒 示例值:1650000000 |
NotBadSessionRatio | Integer | 优良会话占比,单位:% 示例值:30 |
VideoList
原视频流参数列表
被如下接口引用:StartPublishLiveStream。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ProjectId | String | 是 | 项目id 示例值:m82k5408n123phvb |
DeviceId | String | 是 | 设备id 示例值:trro_dev |
VideoStreamId | Integer | 是 | 流id 示例值:0 |
Width | Integer | 是 | 子画面在输出时的宽度,单位为像素值,不填默认为0。 示例值:1280 |
Height | Integer | 是 | 子画面在输出时的高度,单位为像素值,不填默认为0。 示例值:720 |
VideoParams
转推视频参数
被如下接口引用:StartPublishLiveStream。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Width | Integer | 是 | 输出流宽,音视频输出时必填。取值范围[0,1920],单位为像素值。 示例值:1280 |
Height | Integer | 是 | 输出流高,音视频输出时必填。取值范围[0,1080],单位为像素值。 示例值:720 |
Fps | Integer | 是 | 输出流帧率,音视频输出时必填。取值范围[1,60],表示混流的输出帧率可选范围为1到60fps。 示例值:15 |
BitRate | Integer | 是 | 输出流码率,音视频输出时必填。取值范围[1,10000],单位为kbps。 示例值:1500 |
Gop | Integer | 是 | 输出流gop,音视频输出时必填。取值范围[1,5],单位为秒。 示例值:2 |
VideoList | Array of VideoList | 是 | 转推视频流列表 示例值:[{ "VideoStreamId": 0,"Width": 1920,"Height": 1080,"DeviceId": "geek_gw_2","ProjectId": "m82k5408n123phvb"}] |