创建赛事
更新时间:2024-03-22
接口说明
本接口用来创建一场赛事。
备注:
(1)使用赛事贴片功能时,需要传入样式id,支持的样式参考实体说明中的贴片介绍;
(2)图片url可提供自定义的公网图片url;
(3)创建赛事需要设定开始时间和结束时间,设备会在指定时间自动开启和关闭;赛事时间不能少于5分钟;
(4)设置比分、计时器、图片、文本时请按需要放置的位置指定槽位index,与样式示例图片上的槽位index对应;
(5)可设置各比分槽位的比分初始值,如果未设置,默认从0开始;
(6)支持多机位。部分从设备处理错误不会影响方法报错,处理错误信息会通过secondaryDevicesErrInfoList返回;
(7)直播和录制的规格不支持自选,默认为1080p。
请求
请求路径
Path | Method | 说明 |
---|---|---|
/v1/event | POST | 创建一场赛事 |
请求参数
无
请求头
无其他特殊头域
请求体
参数 | 类型 | 描述 | 是否必须 |
---|---|---|---|
deviceId | String | 设备id | Y |
secondaryDeviceIdList | List<String> | 当为空时,表示不设置从机位;不为空时,开启多机位,列表表示设置的从机位的设备ID列表。当从设备是三方设备(设备没有注册到IBS),固定传递“device-thirdParty”作为设备ID。 例:["device-thirdParty", "device-2389ddfsf32"] 表示从设备1是三方设备,从设备2是已注册设备。 |
N |
name | String | 赛事name | Y |
sportType | String | 赛事类型 | Y |
description | String | 赛事描述 | N |
startTime | Long | 赛事开始时间,秒级时间戳 | Y |
endTime | Long | 赛事结束时间,秒级时间戳 | Y |
media | Object | 媒体信息 | Y |
callbackUrl | String | 事件回调url | N |
graphics | Object | 贴片配置 | N |
+patternId | String | 贴片样式模板id | N |
+team | Object | 队伍信息 | N |
+scoreboard | List | 比分板 | N |
+clock | List | 计时器 | N |
+text | List | 文本配置 | N |
+image | List | 图片水印配置 | N |
响应
响应头域
除公共头域外,无其他特殊头域
响应体
参数 | 类型 | 描述 | 备注 |
---|---|---|---|
Event | Object | 赛事信息 | |
+id | String | 赛事ID | |
+ ..... | ..... | 更多详见Event实体信息 | |
errorMessage | String | 错误信息 | |
secondaryDevicesErrInfoList | List | 多机位错误信息 | 存在多机位时,且处理错误时返回 |
+deviceId | String | 多机位设备ID | |
+errorMessage | string | 该设备处理中产生的报错信息 |
示例
-
请求示例
POST /v1/event HTTP/1.1 host: {host} content-type: application/json authorization: {authorization} { "deviceId":"device-aaaaaa1", "secondaryDeviceIDList":["device-thirdParty", "device_bbbb1"], "name":"三亚沙滩排球\"甘伯杯\"2023年预选赛", "sportType":"volleyball", "startTime":1667890800, "endTime":1667898000, "media":{ "forwardUrl":[ "rtmp://xxxx/xxxx/xxxxxxxx" ] }, "graphics":{ "patternId":"pattern-1", "team":{ "homeTeam":{ "name":"非凡排球", "boxColor":"#FF0000" }, "awayTeam":{ "name":"沙排联盟", "boxColor":"#FFFF00" } }, "scoreboard":[ { "index":1, "homeTeamScore":2, "awayTeamScore":4 }, { "index":2, "homeTeamScore":5, "awayTeamScore":10 } ], "text":[ { "index":1, "content":"三亚沙滩排球\"甘伯杯\"2023年预选赛" } ], "image":[ { "index":1, "imageUrl":"http://xxx.1.jpg" }, { "index":2, "imageUrl":"http://xxx.2.jpg" }, { "index":3, "imageUrl":"http://xxx.3.jpg" } ], "clock":[ { "index":1, "reverse":0 } ], "penalty":[ { "index":1, "homeTeamPenalty":[1,0,1], "awayTeamPenalty":[1,0,1,1] } ] } }
-
响应示例
HTTP/1.1 200 OK x-bce-request-id: 8dbde9a9-34e8-4071-afa0-b6d4c4e974b2 Date: Tue, 08 Now 2022 15:00:00 GMT Content-Type: application/json;charset=UTF-8 { "event": { "id":"event-aaaaaa1", "userId":"xxx", "deviceId":"device-aaaaaa1", "secondaryDeviceIDList":["device-thirdParty", "device_bbbb1"], "name":"三亚沙滩排球\"甘伯杯\"2023年预选赛", "state":"notStarted", "sportType":"volleyball", "startTime":1667890800, "endTime":1667898000, "media":{ "liveStream":[ "1080p" ], "recording":[ "1080p" ], "mediaState":"liveStreamUnready", "forwardUrl":[ "rtmp://xxxx/xxxx/xxxxxxxx" ] }, "graphics":{ "patternId":"pattern-1", "team":{ "homeTeam":{ "name":"非凡排球", "boxColor":"#FF0000" }, "awayTeam":{ "name":"沙排联盟", "boxColor":"#FFFF00" } }, "scoreboard":[ { "index":1, "homeTeamScore":2, "awayTeamScore":4 }, { "index":2, "homeTeamScore":5, "awayTeamScore":10 } ], "text":[ { "index":1, "content":"三亚沙滩排球\"甘伯杯\"2023年预选赛" } ], "image":[ { "index":1, "imageUrl":"http://xxx.1.jpg" }, { "index":2, "imageUrl":"http://xxx.2.jpg" }, { "index":3, "imageUrl":"http://xxx.3.jpg" } ] } }, "errorMessage":"xxxxxxxx", "secondaryDevicesErrInfoList":[ { "deviceId":"device-bbbb1", "errorMessage":"device create event err" } ] }