Skip to content

Commit 6703f82

Browse files
committed
update docs
1 parent 27a4030 commit 6703f82

File tree

2 files changed

+26
-6
lines changed

2 files changed

+26
-6
lines changed

VideoPlsInterfaceControllerSDK/VideoPlsInterfaceControllerSDK/VideoPlsInterfaceControllerSDK/VPInterfaceControllerConfig.h

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -50,13 +50,12 @@ typedef NS_ENUM(NSInteger, VPInterfaceControllerType) {
5050
/** 分层投放的参数通过extendDict字段传递
5151
* 所有参数采用key:array方式传递,key为分层的层级关键字,array里面为层级对应的具体值
5252
* 一些常见的参数,推荐使用下面的命名方式
53-
* 标题title,例如 邪恶力量 第九季 第五集,[dict setObject:@[@"邪恶力量 第九季 第五集"] forKey:@"title"];
54-
* 剧集,例如 邪恶力量第九季,[dict setObject:@[@"邪恶力量第九季"] forKey:@"episode"];
55-
* 剧集Id,例如 628916289,[dict setObject:@[@"628916289"] forKey:@"episodeId"];
56-
* 地区/区域,例如 美剧,[dict setObject:@[@"美剧"] forKey:@"area"];
57-
* 年份,例如 2019,[dict setObject:@[@"2019"] forKey:@"years"];
58-
* 类型,例如 科幻,武侠,[dict setObject:@[@"科幻", @"武侠"] forKey:@"episodeId"];
53+
* 标题(title),例如 邪恶力量 第九季 第五集,[dict setObject:@[@"邪恶力量 第九季 第五集"] forKey:@"title"];
54+
* 剧集(episode),例如 邪恶力量第九季,[dict setObject:@[@"邪恶力量第九季"] forKey:@"episode"];
5955
* 剧集Id,例如 628916289,[dict setObject:@[@"628916289"] forKey:@"episodeId"];
56+
* 地区/区域(area),例如 美剧,[dict setObject:@[@"美剧"] forKey:@"area"];
57+
* 年份(year),例如 2019,[dict setObject:@[@"2019"] forKey:@"years"];
58+
* 类型(type),例如 科幻,武侠,[dict setObject:@[@"科幻", @"武侠"] forKey:@"episodeId"];
6059
* 其他扩展字段也可以通过extendDict字段传递
6160
*/
6261
@property (nonatomic, copy) NSDictionary *extendDict;

docs/index.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,8 +94,29 @@ Photos.framework
9494
* episode 为剧集名称,例如 陈情令
9595
* title 为视频标题,例如 陈情令 第02集
9696
* types 为视频类型(点播or直播),默认为点播(注:`VPInterfaceControllerTypeVideoOS` 表示点播,`VPInterfaceControllerTypeLiveOS` 表示直播)
97+
* extendDict 分层投放的参数通过extendDict字段传递
9798

9899
注:identifier,episode,title为必填字段
100+
101+
分层投放的参数通过extendDict字段传递
102+
103+
所有参数采用key:array方式传递,key为分层的层级关键字,array里面为层级对应的具体值
104+
105+
一些常见的参数,推荐使用下面的命名方式
106+
107+
标题(title),例如 邪恶力量 第九季 第五集,[dict setObject:@[@"邪恶力量 第九季 第五集"] forKey:@"title"];
108+
109+
剧集(episode),例如 邪恶力量第九季,[dict setObject:@[@"邪恶力量第九季"] forKey:@"episode"];
110+
111+
剧集Id,例如 628916289,[dict setObject:@[@"628916289"] forKey:@"episodeId"];
112+
113+
地区/区域(area),例如 美剧,[dict setObject:@[@"美剧"] forKey:@"area"];
114+
115+
年份(year),例如 2019,[dict setObject:@[@"2019"] forKey:@"years"];
116+
117+
类型(type),例如 科幻,武侠,[dict setObject:@[@"科幻", @"武侠"] forKey:@"episodeId"];
118+
119+
其他扩展字段也可以通过extendDict字段传递
99120

100121
2. 利用生成的`config`初始化`InterfaceController``interfaceController.view`就是生成的互动层,将这个`view`添加到播放器层之上就可以了。根据接入的`SDK`的需求可能有一些特殊的接口,放在相应的文件中,如需要调用,将对应文件`import`就可以调用了,详细作用请看注释。
101122

0 commit comments

Comments
 (0)