广东电信IPTV内容管理系统与外部接口说明.doc

《广东电信IPTV内容管理系统与外部接口说明.doc》由会员分享，可在线阅读，更多相关《广东电信IPTV内容管理系统与外部接口说明.doc（17页珍藏版）》请在三一办公上搜索。

1、IPTV内容管理系统与EPG、Vnet、外部CMS接口说明1 名词解释n VNET：负责产品或服务管理，对内容进行资费的管理n 内容编排管理系统（Content management systemCMS）：负责将保存在服务器中数据进行分类整理，为实现节目的导航做准备；同时为了在EPG上展现给最终用户提供最终服务, 将需要单独定价的节目或者频道和Vnet系统定义的服务绑定n EPG系统：负责向最终用户的展现，并实现节目的导航,引导用户完成认证授权,计费等操作n 服务: 在CMS系统中, 侧重于节目分类编排, 主要面向频道,栏目或者节目, 在Vnet系统中侧重于计费,主要面向产品和资费, 服务是沟

2、通两个系统的桥梁, 是提供给Vnet系统可以作为最小单位进行计费的一个实体.Vnet系统中可以对这个服务定义多个资费, 变成了多个产品。2 内容管理系统与VNET系统的接口内容管理系统与VNET系统的接口主要是服务创建和产品变更通知的同步接口2.1 服务创建(从vnet把产品服务信息传递到CMS中)接口名：RegisterServiceIF接口方式：webservice接受方：CMS 发送方：Vnet输入参数Request：属性名称属性描述属性格式SPCodeSP编号String 类型, 64位ServiceCode服务编码String 类型, 64位ServiceName服务名称String

3、 类型,256位ServiceDescription服务描述String 类型,256位ServiceBeginTime服务开始时间(yyyyMMddHHmmss)IntServiceEndTime服务结束时间(yyyyMMddHHmmss)IntStatus状态：1-正常，2-暂停，3-停止intDetailParams扩展信息，用XML形式描述，如“游戏”String 类型, 1024位输出参数RegisterServiceResponse：属性名称属性描述属性格式DetailParams扩展信息，用XML形式描述，如“游戏”String 类型, 1024位ReturnCode消息代码，0

4、成功，1失败intMessage返回消息String 类型,256位3 内容管理系统与外部CMS系统的接口在流媒体管理系统中，内容管理系统负责片库管理、频道编排和内容发布，定义了EPG的频道组织和内容展现方式，而EPG系统负责导航信息的展现。3.1 XML实体说明3.1.1 概述XML实体关系为: 实体说明n CMS : 是所有实体的根, 没有具体含义n Epg: 表示用户看到STB页面集合, 是频道,节目的集合n Channel : 频道, 对应影片的分类编排, 可以嵌套n Program : 点播节目n Property : 对应点播节目的属性n Tv : 网上电视n Service :

5、服务, 用于和外部OSS(Vnet)系统做计费帐务的实体n Arrange : 编排实体, 表示频道和Program/tv 的对应关系n Request : 表示命令请求n Response : 表示应答3.1.2 CMS 实体n 说明n XML 示例 n 属性说明无3.1.3 EPG实体n 说明n XML 示例 n 属性说明属性名称数据类型可选说明Id唯一标识String(32)否全局是唯一nameEPG名称String(64)否status状态String(10)否在下面中选择: active，inactive action动作String(10)否表示对这个实体的操作,有new, del

6、ete, update3.1.4 Channel实体n 说明 定义频道n XML 示例 n 属性说明属性名称数据类型可选说明epgId归属的EPG标识String(32)否应用EPG实体的标识parentID上层频道标识String(32)否对于一级频道, 为0,对于二级频道,这个字段引用一级频道的标识Id频道标识String(32)否唯一标识name频道名称String(64)否status状态String(10).否在下面中选择: active，inactive order显示顺序integer否从1开始, 值越小越在前面显示comment描述信息String(256)是logo对应的lo

7、go 标识String(1024)是对应Logo的图片URLaction对实体的操作类型String(10)否表示对这个实体的操作,有new, delete（删除本身节点）, update3.1.5 Program/Property实体n 说明用于描述点播类的实体, 包括影视, 连续剧。 Program实体表示了基本的属性, 对于一些可选的属性, 统一使用property Element 来表示。n XML 示例cms xmlns:xsi=http:/www.w3.org/2001/XMLSchema-instance xsi:noNamespaceSchemaLocation=ABPerte

8、r520n 属性说明属性名称数据类型可选说明contentId节目标识String(32)否全局唯一的, 对于连续剧,单集的ContentID是相同的name节目名称String(128)否search_name快速查询名称String(64)否startTime开始日期String(14)否“YYYYMMDDHH24MISS”endTime结束日期String(14)否“YYYYMMDDHH24MISS”spIdSP标识String(64)否cpIdCP标识String(64)是url播放文件URLString(1024)否ServiceCode服务标识String(64)否授权时使用typ

9、e分类String(64)是分类信息描述: 动作片,爱情片, 。push是否推送CDNInt是0不推送； 1推送episodeIndex剧集第几集Int是连续剧才又有效episodeNum总的剧集数目Int是连续剧才又有效actor男演员String(1024)是多个使用;分隔actress女演员String(1024)是多个使用;分隔director导演String(1024)是多个使用;分隔producer出品人String(1024)是多个使用;分隔poster海报String(1024)是图片URL, 多个使用;分隔summary剧情String(1024)是country地区Stri

10、ng(64)是language对白语言String(64)是caption字幕语言String(64)是awards奖项String(1024)是多个使用;分隔rating级别分类String(10)是R00,R12,R15,R18,R20length播放时长Int是分preview预览URLString(1024)是一个URLstar星级Int是1-5分ScreenFormat屏幕类型String(64)是16:9 4:3audioType声音类型String(64)是bitrate码流Int是kbpsScreen_rate分辩率String(64)是Encoder编码方式String(64

11、)是status状态String(10)否在下面中选择: active，inactive action 对实体的操作类型String(10)否表示对这个实体的操作,有new, delete, update3.1.6 Tv/TvSchedule实体 n 说明n XML 示例 n 属性说明属性名称数据类型可选说明channelSeq频道号String(32)否和Channel实体标识没有关系channelName频道名称String(64)否spIdSP标识String(64)否startTime每天开始时间String(6)否格式为: “hh24miss”endTime每天结束时间String(

12、6)否格式为: “hh24miss”ServiceCode服务标识String(64)否授权时使用bitrate码流Int是kbpsrating级别分类String(64)是限制级, 。poster海报String(1024)是图片URL, 多个使用;分隔language对白语言String(64)是country地区String(64)是Encoder编码方式String(64)是logo对应的logo URLString(1024)是对应Logo的图片URLcomment描述信息String(1024)是IP组播IPString(32)否Port组播端口Int否contentId节目标识S

13、tring(32)否全局唯一的,和点播类节目不重复contentName节目名称String(64)否节目的名称summary剧情String(1024)是rating级别分类String(10)是R00,R12,R15,R18,R20Duration播放时长Int是以秒为单位start_Date开始播放日期String(8)否格式为: yyyymmddstart_Time播放时间String(6)否格式为: hh24misschannelURL频道地址String(64)是更加厂家对直播实现机制定义，可选status状态String(10)否在下面中选择: active，inactive a

14、ction 对实体的操作类型String(10)否表示对这个实体的操作,有new, delete, update3.1.7 Arranget实体 n 说明用于描述频道和节目的编排关系, 一个节目可以被编排到多个频道中。Element的值,定义了节目的标识。n XML 示例cms xmlns:xsi=http:/www.w3.org/2001/XMLSchema-instance xsi:noNamespaceSchemaLocation= n 属性说明属性名称数据类型可选说明Id唯一标识String(1024)否ChannelId对应的频道标识String(32)否对Channel实体的引用c

15、hannelSeq频道标识String(32)是定义Channel实体里的频道contentId节目标识String(32)是定义Channel实体里的节目action 对实体的操作类型String(10)否表示对这个实体的操作,有new(增加), delete, 3.1.8 Service实体 n 说明在CMS系统中, 侧重于节目分类编排, 主要面向频道,栏目或者节目, 在Vnet系统中侧重于计费,主要面向产品和资费, 服务是沟通两个系统的桥梁, 是提供给Vnet系统可以作为最小单位进行计费的一个实体.Vnet系统中可以对这个服务定义多个资费, 变成了多个产品。Element的值,定义了频道

16、的标识。n XML 示例cms xmlns:xsi=http:/www.w3.org/2001/XMLSchema-instance xsi:noNamespaceSchemaLocation= n 属性说明属性名称数据类型可选说明Id唯一标识String(64)否name服务的名称String(1024)否对资费的描述channelSeq频道标识String(32)是定义Channel实体里的频道contentId节目标识String(32)是定义Channel实体里的节目action 对实体的操作类型String(64)否表示对这个实体的操作,有new, delete,update3.1.

17、9 Request实体 n 说明命令实体, n XML 示例cms xmlns:xsi=http:/www.w3.org/2001/XMLSchema-instance xsi:noNamespaceSchemaLocation= n 属性说明属性名称数据类型可选说明issueDateTime命令发布时间String(14)否格式为: yyyymmddhh24misssequence命令序列号String(64)否（完整的文件名）3.1.10 Response实体 n 说明描述应答实体。n XML 示例cms xmlns:xsi=http:/www.w3.org/2001/XMLSchema-

18、instance xsi:noNamespaceSchemaLocation= 未知错误 n 属性说明属性名称数据类型可选说明sequence命令序列号String(64)否（完整的文件名）cmsCode子CMS标识String(2)否全局唯一startTime命令发布时间String(14)否格式为: yyyymmddhh24missendTime命令执行时间String(14)否格式为: yyyymmddhh24missresultCode执行返回值Int否0：成功1：接口解析失败，包括文件不完整，XML格式不正确，通过ErrorMsg进行具体描述2：实体信息不一致，包括EPG/CHANN

19、EL/PROGRAM/TV实体等信息与子CMS内部信息不一致， 如删除一个在子CMS不存在的CHANNEL，或者增加一个在子CMS已存在的PROGRMA3：子CMS系统内部错误，一般该错误由子系统自身错误引起，如数据库连接不成功。该错误属于可恢复的错误。99：其它错误ErrorMsg错误描述String(1024)是错误的具体描述n3.2 文件接口通讯方式3.2.1 系统通讯模式考虑到系统中传输的数据量比较大, 通过实时接口发送数据的时候, 可能因为数据量的问题, 造成通讯错误, 或者不能实时处理的问题, 在中心CMS和子CMS系统中间, 主要通过文件方式进行耦合。 在中心CMS系统内部因为有

20、新的节目上线, 编排发生变化或者其他原因, 要求和子CMS系统做数据同步的时候, 中心CMS系统生成命令文件, 这个文件中包含命令和对应的实体信息。子CMS系统会定时(或被通知)去获取命令文件, 执行命令, 生成应答文件, 同样中心CMS系统通过解析子CMS系统返回的应答文件, 就可以知道子CMS系统对命令执行情况。在支持文件方式的同时, 也提供实时的接口。主要使用下面两种模式:n 纯文件模式处理流程 1) 中心CMS生成命令文件2) 子CMS系统定向查询FTPServer, 根据最后处理的文件序列号, 获取到命令文件;在子CMS系统内部处理命令文件;3) 子CMS系统对命令文件执行完毕后,根

21、据对命令文件的执行情况, 生成应答文件，为了避免命令文件处理中出现“跳跃”的情况，规定上一个命令文件执行结束之前，不启动后续命令文件的执行;当前一个命令文件处理失败，后续命令可以继续执行，当所有命令文件执行完毕以后，子CMS向中心CMS上报命令执行情况。4) 中心CMS定时查询应答文件, 更新命令执行情况列表;5) 如果中心CMS发现子CMS命令执行出现错误，则重传命令文件触发子CMS再次执行6) 如出现子CMS三次执行都不成功，则中心CMS触发相应告警机制。n 文件扩展模式处理流程 1) 中心CMS生成命令文件2) 中心CMS系统通知子CMS系统, 要求子CMS到FTP上获取命令文件.3)

22、子CMS根据根据最后处理的文件序列号, 获取到命令文件;在子CMS系统内部处理执行命令文件，为了避免命令文件处理中出现“跳跃”的情况，规定上一个命令文件执行结束之前，不启动后续命令文件的执行;当前一个命令文件处理失败，后续命令可以继续执行，当所有命令文件执行完毕以后，子CMS向中心CMS上报命令执行情况。4) 中心CMS定时查询应答文件, 更新命令执行情况列表;5) 如果中心CMS发现子CMS命令执行出现错误，则重传命令文件触发子CMS再次执行6) 如出现子CMS三次执行都不成功，则中心CMS触发相应告警机制。两种模式的基本处理流程是类似的, 在文件扩展模式下, 对系统的时效性更好。 3.2.

23、2 命令或者应答文件规范命令或者应答都会作为文件保存在FTP空间上, CMS系统获取和做解析。文件名称规范:命令文件: request_yyyymmdd_seq.xml应答文件: response_yyyymmdd_seq_cmsCode.xml说明: 1) 根据request/response这两个文件名前缀, 可以区分命令文件和应答文件;2) yyyymmdd 为北京时间的年月日子串, seq 为一个递增的序列号, 命令文件和应答文件根据Seq可以做匹配, 一个seq对应一个命令;3) cmsCode 是预定义的子CMS的标识, 用于标识应答文件是那一个子CMS发出的。4) 命令文件和应答

24、文件保存在相同的磁盘下面, 中心CMS, 子CMS都可以通过FTP, 或者NFS的方式, 访问和存取这个磁盘下面的文件;5) 考虑到系统直接通过文件做耦合, 为了避免中心CMS生成命令文件还没有完成的情况, 子CMS已经开始读取这个文件, 造成错误, 使用改名机制。在文件还没有写完之前, 负责写文件的系统可以在文件名之前增加一个前缀(tmp_), 在文件中的数据写完后, 再修改名称,符合上文的定义。3.2.3 命令文件, 应答文件内容格式n 命令文件格式命令文件内容示例: Request 实体 +Channel实体 ,Program实体 , Tv实体, Service实体, 或者Arrange实体n 应答文件格式 应答文件内容示例:Response实体3.2.4 通知接口定义接口名：notifyCMS接口方式：webservice接受方：子CMS 发送方：中心CMS输入参数Request：属性名称属性描述属性格式TaskSequence完整文件名String 类型, 64位输出参数Response：属性名称属性描述属性格式Code消息代码，0接受成功，1失败intMessage返回消息String 类型,256位3.2.5 全量文件中心CMS系统会定时产生一个全量文件, 一个文件中完整描述了所有信息。全量文件的命名规范为:cms_data_yyyymmdd.xml