ex
Fork of mbed-os-example-mbed5-blinky by
dumi_doc-master/doc/directives/VideoPlayer.md@44:c1d8923072ba, 2017-07-18 (annotated)
- Committer:
- TMBOY
- Date:
- Tue Jul 18 16:27:22 2017 +0800
- Revision:
- 44:c1d8923072ba
?
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| TMBOY | 44:c1d8923072ba | 1 | # VideoPlayer(非稳定版) |
| TMBOY | 44:c1d8923072ba | 2 | |
| TMBOY | 44:c1d8923072ba | 3 | ## Table of Contents |
| TMBOY | 44:c1d8923072ba | 4 | |
| TMBOY | 44:c1d8923072ba | 5 | ## VideoPlayer.Play指令 |
| TMBOY | 44:c1d8923072ba | 6 | 用户对音箱说“播放周杰伦的歌曲”、“播放郭德纲的相声”、"继续播放"、“下一首”、“上一首”、“下一个专辑”、“上一个专辑”都返回一个Play指令。 |
| TMBOY | 44:c1d8923072ba | 7 | ```json |
| TMBOY | 44:c1d8923072ba | 8 | { |
| TMBOY | 44:c1d8923072ba | 9 | "header": { |
| TMBOY | 44:c1d8923072ba | 10 | "namespace": "VideoPlayer", |
| TMBOY | 44:c1d8923072ba | 11 | "name": "Play", |
| TMBOY | 44:c1d8923072ba | 12 | }, |
| TMBOY | 44:c1d8923072ba | 13 | "payload": { |
| TMBOY | 44:c1d8923072ba | 14 | "tips": "为您播放如下电视剧", |
| TMBOY | 44:c1d8923072ba | 15 | "resource": { |
| TMBOY | 44:c1d8923072ba | 16 | "resource_id": "102_50451", |
| TMBOY | 44:c1d8923072ba | 17 | "resource_name": "欢乐颂", |
| TMBOY | 44:c1d8923072ba | 18 | "director": "孔笙", |
| TMBOY | 44:c1d8923072ba | 19 | "type": "都市,言情", |
| TMBOY | 44:c1d8923072ba | 20 | "category": "电视剧", |
| TMBOY | 44:c1d8923072ba | 21 | "actors": "刘涛,蒋欣,王子文,杨紫", |
| TMBOY | 44:c1d8923072ba | 22 | "era": "2016", |
| TMBOY | 44:c1d8923072ba | 23 | "season": "1", |
| TMBOY | 44:c1d8923072ba | 24 | "poster_url": "http://10.0.11.10/poster/15860.jpg", |
| TMBOY | 44:c1d8923072ba | 25 | "episode" : 14, |
| TMBOY | 44:c1d8923072ba | 26 | "item_id": "102_50452", |
| TMBOY | 44:c1d8923072ba | 27 | "token": "xxxx" |
| TMBOY | 44:c1d8923072ba | 28 | "description": "心怀梦想的大龄胡同公主樊胜美能", |
| TMBOY | 44:c1d8923072ba | 29 | } |
| TMBOY | 44:c1d8923072ba | 30 | } |
| TMBOY | 44:c1d8923072ba | 31 | } |
| TMBOY | 44:c1d8923072ba | 32 | ``` |
| TMBOY | 44:c1d8923072ba | 33 | 参数 | 描述 | 类型 | 必须 |
| TMBOY | 44:c1d8923072ba | 34 | ---- | --- | --- | --- |
| TMBOY | 44:c1d8923072ba | 35 | tips | 提示用户的信息, 可进行播放时的tips显示| string | 是 |
| TMBOY | 44:c1d8923072ba | 36 | resource | 视频对象,包括元数据和播放token | object | 是 |
| TMBOY | 44:c1d8923072ba | 37 | resource.resource_id | 视频唯一ID | string | 是 |
| TMBOY | 44:c1d8923072ba | 38 | resource.resource_name | 视频名称 | string | 是 |
| TMBOY | 44:c1d8923072ba | 39 | resource.director | 该视频导演 | string | 是 |
| TMBOY | 44:c1d8923072ba | 40 | resource.type | 视频二级分类(科幻/魔幻/言情/动作/武侠等) | string | 是 |
| TMBOY | 44:c1d8923072ba | 41 | resource.category | 视频类型(电影/电视剧/综艺/动漫/纪录片) | string | 是 |
| TMBOY | 44:c1d8923072ba | 42 | resource.era | 出品年代 | int | 否 |
| TMBOY | 44:c1d8923072ba | 43 | resource.season |第几季或者第几部 | string | 否 |
| TMBOY | 44:c1d8923072ba | 44 | resource.poster_url | 海报url地址 | string | 是 |
| TMBOY | 44:c1d8923072ba | 45 | resource.episode | 第几集 | int | 否 |
| TMBOY | 44:c1d8923072ba | 46 | resource.item_id | 电视剧某一集对应的id(不同合作方会不一样) | string | 否 |
| TMBOY | 44:c1d8923072ba | 47 | resource.token | 该视频对应的播放token(不同合作方不同) | string | 是 |
| TMBOY | 44:c1d8923072ba | 48 | resource.description | 该视频的剧情简介信息 | string | 否 |
| TMBOY | 44:c1d8923072ba | 49 | |
| TMBOY | 44:c1d8923072ba | 50 | |
| TMBOY | 44:c1d8923072ba | 51 | |
| TMBOY | 44:c1d8923072ba | 52 | ## PlaybackStarted事件 |
| TMBOY | 44:c1d8923072ba | 53 | 客户端开始播放的时候,需要上报此事件。 |
| TMBOY | 44:c1d8923072ba | 54 | ```json |
| TMBOY | 44:c1d8923072ba | 55 | "device_event":{ |
| TMBOY | 44:c1d8923072ba | 56 | "header": { |
| TMBOY | 44:c1d8923072ba | 57 | "namespace": "VideoPlayer", |
| TMBOY | 44:c1d8923072ba | 58 | "name": "PlaybackStarted", |
| TMBOY | 44:c1d8923072ba | 59 | "message_id": "message_id-1xxxx" |
| TMBOY | 44:c1d8923072ba | 60 | }, |
| TMBOY | 44:c1d8923072ba | 61 | "payload": { |
| TMBOY | 44:c1d8923072ba | 62 | "token": "156",//客户的资源播放标识 |
| TMBOY | 44:c1d8923072ba | 63 | "resource_id": "98fd71c1523", //云端返回的视频资源唯一id |
| TMBOY | 44:c1d8923072ba | 64 | "resource_name": "魔戒1",//资源的名称 |
| TMBOY | 44:c1d8923072ba | 65 | "category": "电影",// 资源的分类 |
| TMBOY | 44:c1d8923072ba | 66 | "episode" : 15,//如果是电视剧的话, 需要填写具体的集数 |
| TMBOY | 44:c1d8923072ba | 67 | "type": "[\"动作\", \"奇幻\", \"剧情\", \"冒险\"]",//资源所属的类型 |
| TMBOY | 44:c1d8923072ba | 68 | } |
| TMBOY | 44:c1d8923072ba | 69 | } |
| TMBOY | 44:c1d8923072ba | 70 | ``` |
| TMBOY | 44:c1d8923072ba | 71 | ## PlaybackStopped事件 |
| TMBOY | 44:c1d8923072ba | 72 | 用户说"停止播放"并执行了停止动作、或者退出了播放界面时 需要发送此事件. |
| TMBOY | 44:c1d8923072ba | 73 | ```json |
| TMBOY | 44:c1d8923072ba | 74 | "device_event":{ |
| TMBOY | 44:c1d8923072ba | 75 | "header": { |
| TMBOY | 44:c1d8923072ba | 76 | "namespace": "VideoPlayer", |
| TMBOY | 44:c1d8923072ba | 77 | "name": "PlaybackFinished", |
| TMBOY | 44:c1d8923072ba | 78 | "message_id": "message_id-1xxxx" |
| TMBOY | 44:c1d8923072ba | 79 | }, |
| TMBOY | 44:c1d8923072ba | 80 | "payload": { |
| TMBOY | 44:c1d8923072ba | 81 | "token": "156", |
| TMBOY | 44:c1d8923072ba | 82 | "resource_id": "98fd71c1523", |
| TMBOY | 44:c1d8923072ba | 83 | "name": "魔戒1", |
| TMBOY | 44:c1d8923072ba | 84 | "category": "电影", |
| TMBOY | 44:c1d8923072ba | 85 | "episode" : 15, |
| TMBOY | 44:c1d8923072ba | 86 | "type": "[\"动作\", \"奇幻\", \"剧情\", \"冒险\"]", |
| TMBOY | 44:c1d8923072ba | 87 | } |
| TMBOY | 44:c1d8923072ba | 88 | } |
| TMBOY | 44:c1d8923072ba | 89 | } |
| TMBOY | 44:c1d8923072ba | 90 | ``` |
| TMBOY | 44:c1d8923072ba | 91 | |
| TMBOY | 44:c1d8923072ba | 92 | ## 上报VideoPlayer状态(在请求中) |
| TMBOY | 44:c1d8923072ba | 93 | 当用户正在播放电视魔戒时,询问: "该电影的导演是谁?", 需要在请求中带上这些信息,协助后端进行正确的解析. |
| TMBOY | 44:c1d8923072ba | 94 | ```javascript |
| TMBOY | 44:c1d8923072ba | 95 | "device_status":{ |
| TMBOY | 44:c1d8923072ba | 96 | "VideoPlayer":{ |
| TMBOY | 44:c1d8923072ba | 97 | "token": "156",//客户的资源播放标识 |
| TMBOY | 44:c1d8923072ba | 98 | "resource_id": "98fd71c1523", //云端返回的视频资源唯一id |
| TMBOY | 44:c1d8923072ba | 99 | "resource_name": "魔戒1",//资源的名称 |
| TMBOY | 44:c1d8923072ba | 100 | "category": "电影",// 资源的分类 |
| TMBOY | 44:c1d8923072ba | 101 | "episode" : 15,//如果是电视剧的话, 需要填写具体的集数 |
| TMBOY | 44:c1d8923072ba | 102 | "type": "[\"动作\", \"奇幻\", \"剧情\", \"冒险\"]",//资源所属的类型 |
| TMBOY | 44:c1d8923072ba | 103 | }, |
| TMBOY | 44:c1d8923072ba | 104 | }, |
| TMBOY | 44:c1d8923072ba | 105 | ``` |
| TMBOY | 44:c1d8923072ba | 106 | |
| TMBOY | 44:c1d8923072ba | 107 | |
| TMBOY | 44:c1d8923072ba | 108 | ## FAQ |
| TMBOY | 44:c1d8923072ba | 109 | |
| TMBOY | 44:c1d8923072ba | 110 | |
| TMBOY | 44:c1d8923072ba | 111 | ## Changelog |
| TMBOY | 44:c1d8923072ba | 112 | * 2017-6-3 初稿。 |
