基于云会议室预约一个直播的基础上，修改所预约直播的信息。同时支持多分辨率（清晰度）直播。
默认接口请求频率限制：20 次/秒。
REST URL
POST https://sdk.xylink.com/api/rest/external/{version}/liveVideo5/update?enterpriseId=XXX&signature=XXX&meetingRoomNumber=xxx&liveId=xxx
参数 | 参数类型 | 参数位置 | 必须 | 默认值 | 说明 | 初始平台 |
version | String | Query | 是 | 无 | 传v1即可 | 6.0不支持该接口 |
enterpriseId | String | Query | 是 | 无 | 企业ID，通过管理平台-云视讯API获得 | |
signature | String | Query | 是 | 签名鉴权2.0：否 | API签名，参考 | |
meetingRoomNumber | String | Query | 是 | 无 | 云会议室号 | 3.9 (2022-1121版本） 5.2 (2022-1220版本） |
password | String | Body | 否 | 无 | 云会议室密码 | 3.9 (2022-1121版本） 5.2 (2022-1220版本） |
title | String | Body | 是 | 无 | 直播标题（长度不超过32个字符） | 3.9 (2022-1121版本） 5.2 (2022-1220版本） |
detail | String | Body | 否 | 无 | 直播详情 （可选，长度不超过128个字符） | 3.9 (2022-1121版本） 5.2 (2022-1220版本） |
location | String | Body | 否 | 无 | 直播地点 （可选，长度不超过64个字符） | 3.9 (2022-1121版本） 5.2 (2022-1220版本） |
nemoNumber | String | Body | 否 | 无 | 直播设备号 | 3.9 (2022-1121版本） 5.2 (2022-1220版本） |
autoRecording | boolean | Body | 否 | false | 是否自动录制，只有设置为true，autoPublishRecording才可以设置为true | 3.9 (2022-1121版本） 5.2 (2022-1220版本） |
autoPublishRecording | boolean | Body | 否 | false | 是否自动发布录制，只有设置为true，才能获取直播的回放列表 | 3.9 (2022-1121版本） 5.2 (2022-1220版本） |
thirdpartyPushURL | String | Body | 否 | 无 | 第三方推流地址 | 3.9 (2022-1121版本） 5.2 (2022-1220版本） |
liveViewerInvited | Object | Body | 否 | 无 | 邀请观看人,目前只支持硬件终端 | 3.9 (2022-1121版本） 5.2 (2022-1220版本） |
defaultLiveResolutionType | String | Body | 否 | DEFAULT | 直播分辨率 SUPER_HIGH_DEFINATION：1080p DEFAULT ：720p NORMAL：480p | 3.9 (2022-1121版本） 5.2 (2022-1220版本） |
extras | String (json) | Body | 否 | 无 | 直播附加配置 | 3.9 (2022-1121版本） 5.2 (2022-1220版本） |
└ layout | -- | Body | 否 | 无 | 直播布局配置 | 3.9 (2022-1121版本） 5.2 (2022-1220版本） |
└ screen | String | Body | 否 | 无 | 横竖屏类型，可选值"landscape"（横屏），"portrait"（竖屏） | 3.9 (2022-1121版本） 5.2 (2022-1220版本） |
└ people | -- | Body | 否 | 无 | 只有people情况下的布局配置 | 3.9 (2022-1121版本） 5.2 (2022-1220版本） |
└ maxCells | Integer | Body | 否 | 无 | 最大窗口数量，实际参会人数超过maxCells时，只显示maxCells个人 | 3.9 (2022-1121版本） 5.2 (2022-1220版本） |
└ view | String | Body | 否 | 无 | 布局类型，可选值： "asymOverlap"（非对称叠加）, "asymTiling"（非对称平铺）, "symTiling"（对称平铺）,"POP"（画外画） | 3.9 (2022-1121版本） 5.2 (2022-1220版本） |
└ mode | String | Body | 否 | 无 | 布局模式："auto"（自动布局：主会场优先） | 3.9 (2022-1121版本） 5.2 (2022-1220版本） |
└ content | -- | Body | 否 | 无 | 只有content情况下的布局配置 | 3.9 (2022-1121版本） 5.2 (2022-1220版本） |
└ maxCells | Integer | Body | 否 | 无 | 最大窗口数量，实际参会人数超过maxCells时，只显示maxCells个人 | 3.9 (2022-1121版本） 5.2 (2022-1220版本） |
└ view | String | Body | 否 | 无 | 布局类型，可选值： "asymOverlap"（非对称叠加）, "asymTiling"（非对称平铺）, "symTiling"（对称平铺）,"POP"（画外画） | 3.9 (2022-1121版本） 5.2 (2022-1220版本） |
└ mode | String | Body | 否 | 无 | 布局模式："auto"（自动布局：主会场优先） | 3.9 (2022-1121版本） 5.2 (2022-1220版本） |
└ prefer | boolean | Body | 否 | 无 | 指示是否content（第一分屏）幕显示，可选值：true（#1分屏）, false（#2分屏） | 3.9 (2022-1121版本） 5.2 (2022-1220版本） |
└smart | boolean | Body | 否 | 无 | content是否自动切换到第二分屏。 true：自动切换； false：不自动切换 | 3.9 (2022-1121版本） 5.2 (2022-1220版本） |
└smartWaitTime | Integer | Body | 否 | 无 | smart为true时，屏幕无变化情况持续samrtWaitTime秒后自动切换到#2分屏，单位：秒 | 3.9 (2022-1121版本） 5.2 (2022-1220版本） |
└ OSD | -- | Body | 否 | 无 | 叠加在视频上的附属信息 | 3.9 (2022-1121版本） 5.2 (2022-1220版本） |
└ nameplate | -- | Body | 否 | 无 | 叠加终端名称 | 3.9 (2022-1121版本） 5.2 (2022-1220版本） |
└ enabled | boolean | Body | 否 | 无 | 是否启动功能，可选值：true（叠加）, false（不叠加) | 3.9 (2022-1121版本） 5.2 (2022-1220版本） |
布局详情可以参考画面布局
请求消息体示例（Json）
{
"title": "直播测试",
"startTime": 16262628222,
"endTime": 16262629222,
"detail": "xxxxxx",
"location": "https://www.xylink.com",
"nemoNumber": "xxxxxx",
"password": "xxxxxx",
"autoRecording": false,
"autoPublishRecording": false,
"thirdpartyPushURL": "xxxxxx",
"liveViewerInvited": {
"devices": ["xxxx", "xxxxx"]
},
"defaultLiveResolutionType": "DEFAULT",
"extras": "{\"layout\":{\"screen\":\"landscape\",\"people\":{\"view\":\"symTiling\",\"mode\":\"auto\"},\"content\":{\"view\":\"symTiling\",\"mode\":\"auto\",\"prefer\":false}},\"OSD\":{\"nameplate\":{\"enabled\":true}}}"
}返回结果示例：
{
"liveId": "xxxxxx",
"enterpriseId": "xxxxxx",
"meetingRoomNumber": "xxxxxx",
"nemoNumber": "",
"status": "WAIT",
"title": "研发测试",
"startTime": xxxxxx,
"endTime": xxxxxx,
"detail": "研发测试",
"autoRecording": true,
"autoPublishRecording": true,
"location": "null",
"viewUrl": "https://sdk.xylink.com/xxxxxx/xxx/xxxxxx",
"thirdpartyPushURL": "null",
"defaultLiveResolutionType": "DEFAULT",
"liveLayoutConfig": "{\"layout\":{\"screen\":\"landscape\",\"people\":{\"view\":\"symTiling\",\"mode\":\"auto\"},\"content\":{\"view\":\"symTiling\",\"mode\":\"auto\",\"prefer\":false}},\"OSD\":{\"nameplate\":{\"enabled\":true}}}",
"liveViewerInvited": null,
"extras": "{\"layout\":{\"screen\":\"landscape\",\"people\":{\"view\":\"symTiling\",\"mode\":\"auto\"},\"content\":{\"view\":\"symTiling\",\"mode\":\"auto\",\"prefer\":false}},\"OSD\":{\"nameplate\":{\"enabled\":true}}}",
"pullUrls": [
{
"resolutionType":"SUPER_HIGH_DEFINATION",
"videoRtmp":"xxxxxx",
"videoFlv":"xxxxxx",
"videoM3u8":"xxxxxx",
"defaultResolution": true
}
],
"pushUrl": "xxxxxx"
}返回参数说明:
参数 | 说明 |
liveId | 直播 Id |
enterpriseId | 企业 Id |
meetingRoomNumber | 云会议号 |
status | 直播状态(WAIT，LIVING，PAUSE，END) |
title | 直播标题 |
startTime | 直播开始时间 |
endTime | 直播结束时间 |
detail | 直播详情 |
autoRecording | 是否自动录制 |
autoPublishRecording | 是否自动发布录制 |
location | 直播地点 |
viewUrl | 直播观看地址 |
thirdpartyPushURL | 第三方推流地址 |
liveViewerInvited | 邀请观看人 |
defaultLiveResolutionType | 直播分辨率 |
screen | 横竖屏直播 |
maxCells | 最大窗口数 |
view | 直播布局类型 |
mode | 直播布局模式 |
prefer | 指示是否 content（第一分屏）幕显示 |
nameplate>enabled | 是否叠加终端名称 |
liveLayoutConfig | 直播布局配置 |
extra | 直播附加配置 |
pullUrls | 多清晰度拉流地址列表 |
└resolutionType | 直播清晰度 |
└videoRtmp | 直播拉流地址(rtmp格式) |
└videoFlv | 直播拉流地址(flv格式) |
└videoM3u8 | 直播拉流地址(m3u8格式) |
└defaultResolution | 是否是默认的清晰度 |
pushUrl | 直播推流地址 |
请求失败结果示例
{
"developerMessage": "ErrorStatus: SDK_INVALID_APPKEY No app found for extId: ",
"userMessage": "sdk.invalid.key",
"errorCode": 60001,
"moreInfo": "http://www.com.ainemo.com/errors/60001"
}以下仅列出该接口业务逻辑错误码，其他错误码见小鱼RESTAPI错误码
错误码 | 描述 |
60014 | 无效的时间(开始时间 or 结束时间) |
60016 | 小鱼号不在企业中（nemoNumber） |
60022 | 无效的title |
60023 | 无效的detail |
60024 | 无效的location |
60027 | 无效的会议室号格式 |
60047 | 该企业没有直播资源 |
60048 | 该企业不允许创建直播 |
60052 | 无效参数，没有请求体 |
60054 | 直播邀请人参数不能含空元素 |
60055 | 无效的清晰度参数 |
80003 | 云会议室密码无效 |