LYCAM+ 直播服务端JAVA SDK

该 SDK 适用于 JAVA 1.6 及其以上版本 ，基于LYCAM+官方直播API构建 。 若您的服务端是一个基于 JAVA 编写的网络程序，使用此 SDK ，能让您以非常便捷地方式接入我们的服务 ，同时也使得您的服务端更加轻盈 。

安装

基于 maven 构建

在项目根目录 pom.xml 文件中添加：

<dependency>
  <groupId>tv.lycam</groupId>
  <artifactId>lycamplus-java-sdk</artifactId>
  <version>1.0.0</version>
</dependency>

基于 gradle 构建

在项目根目录 build.gradle 文件中添加：

compile group:'tv.lycam', name:'lycamplus-java-sdk', version: '1.0.0'

或者

compile 'tv.lycam:lycamplus-java-sdk:1.0.0'

使用

配置参数 并创建 SDK 实例

设置全局参数 ，包括必须的 appKey ，appSecret 和 masterSecret ，配置参数将会延至所有空间 。

String appKey       =  <您申请到的 AppKey>

String appSecret    =  <您申请到的 AppSecret>

String masterSecret =  <您申请到的 masterSecret>

创建 SDK 实例 。

LycamPlus lycamPlus = new LycamPlus(appKey, appSecret, masterSercet);

User 对象

获取 User 对象并进行操作

userInstance = lycamPlus.getUserInstance();

1. 创建用户

创建用户到 LYCAM+ 系统中 ，以便用户操作 API 接口鉴权使用 。

...

UserRequestModel userRequestModel = new UserRequestModel();

userRequestModel.setUsername("lycam-test4");

userRequestModel.setPassword('123456789l');

...

UserResponseModel responseModel = userInstance.create(userRequestModel);

...

请求参数

请求参数传递 UserRequestModel 类型。 UserRequestModel 类型包含以下字段 ：

返回数据

接口返回 UserResponseModel 类型，UserResponseModel标识返回详细数据。UserResponseModel 类型包含以下字段：

2. 用户token获取

用户访问 LYCAM+ 资源操作接口（比如：推流）时需要用户鉴权，我们使用token进行验证 。

...

String uuid = "f6524e90-e055-11e6-9b86-4d1c174d4365";

long expires = 38000;

TokenResponseModel tokenResponseModel = userInstance.assume(uuid, expires);

...

请求参数

请求参数传递两个参数： string 和 long 类型。 string 类型用于标识用户的唯一ID， long 类型标识 token 过期的时间（单位：秒）。

返回数据

接口返回 TokenResponseModel 类型 ， TokenResponseModel 标识返回详细数据。TokenResponseModel 类型包含以下字段：

Stream 对象

获取 Stream 对象并进行操作

...

streamInstance = lycamPlus.getStreamInstance();

...

1. 创建视频流

在 LYCAM+ 后台系统中创建一条视频流 。 用于返回给终端用户或实现您自己的业务 。

...

StreamRequestModel requestModel = new StreamRequestModel();

requestModel.setTitle("java test");

requestModel.setUser("f6524e90-e055-11e6-9b86-4d1c174d4365");

...

StreamResponseModel responseModel = streamInstance.create(requestModel);

...

请求参数

请求参数传递 StreamRequestModel 类型。 StreamRequestModel 类型包含以下字段：

返回数据

接口返回 StreamResponseModel 类型，StreamResponseModel 标识返回详细数据。StreamResponseModel 类型包含以下字段：

2. 更新指定ID视频流

在 LYCAM+ 后台系统中更新指定 ID 视频流信息 。

...

String streamID = "775009d0-e06d-11e6-ba8a-a3de0ac619fb";

StreamRequestModel requestModel = new StreamRequestModel();

requestModel.setStartLat(90);

requestModel.setStartLon(90);

requestModel.setEndLat(180);

requestModel.setEndLon(220);

requestModel.setDescription("no description");

...

StreamResponseModel responseModel = streamInstance.update(streamID, requestModel);

...

请求参数

请求参数传递 string 类型 和 StreamRequestModel 类型。string 类型标识被更新的视频流 ID， StreamRequestModel 类型包含以下字段：

返回数据

接口返回 StreamResponseModel 类型，StreamResponseModel 标识返回详细数据。StreamResponseModel 类型包含以下字段：

3. 获取指定ID视频流信息

在 LYCAM+ 后台系统中获取指定 ID 的视频流 。 用于返回给终端用户或实现您自己的业务 。

...

String streamID = "775009d0-e06d-11e6-ba8a-a3de0ac619fb";

StreamResponseModel responseModel =  streamInstance.show(streamID);

...

请求参数

请求参数传递 string 类型 ， 用于标识视频流的ID。

返回字段

接口返回 StreamResponseModel 类型，StreamResponseModel 标识返回详细数据。StreamResponseModel 类型包含以下字段：

4. 获取视频流列表

获取 Lycam+ 后台系统中视频流列表 。用于返回给终端用户或实现您自己的业务 。

...

PageModel pageModel = new PageModel();

pageModel.setResultsPerPage(2);

pageModel.setPage(3);

pageModel.setOrder(Order.DESC);

...

StreamResponseListModel listModel = streamInstance.getList(pageModel);

...

请求参数

请求参数传递 PageModel 类型 。 PageModel 包含以下字段：

返回字段

接口返回 StreamResponseListModel 类型，StreamResponseListModel 标识返回详细数据。StreamResponseListModel 类型包含以下字段：

5. 获取指定时间前视频流列表

在 LYCAM+ 后台系统获取指定时间前的视频流列表 。 用于返回给终端用户或实现您自己的业务 。

...

PageModel pageModel = new PageModel();

pageModel.setResultsPerPage(2);

pageModel.setPage(2);

pageModel.setOrder(Order.DESC);

...

String tsStr = "2016-12-30 11:49:45";

Timestamp timestamp = Timestamp.valueOf(tsStr);


StreamResponseListModel listModel = streamInstance.getListSince(timestamp.getTime(), pageModel);

...

请求参数

请求参数传递 long 类型 和 PageModel 类型 。long 类型标识时间戳（单位：秒）， PageModel 类型包含以下字段：

返回字段

接口返回 StreamResponseListModel 类型，StreamResponseListModel 标识返回详细数据。StreamResponseListModel 类型包含以下字段：

6. 通过关键词搜索视频流

通过关键词在 LYCAM+ 后台系统获取视频流列表 。 用于返回给终端用户或实现您自己的业务 。

...

KeywordModel keywordModel = new KeywordModel();

keywordModel.setKeyword("test");

...

StreamSearchListModel listModel = streamInstance.getListByKeyword(keywordModel);

...

请求参数

请求参数传递 KeywordModel 类型 。 KeywordModel 包含以下字段：

返回字段

接口返回 StreamSearchListModel 类型，StreamSearchListModel 标识返回详细数据。StreamSearchListModel 类型包含以下字段：

7. 通过地理位置搜索视频流

通过地理位置在 LYCAM+ 后台系统获取视频流列表 。 用于返回给终端用户或实现您自己的业务 。

...

LocationModel locationModel = new LocationModel();

locationModel.setLat(90);

locationModel.setLon(90);

locationModel.setRadius(100);

...

StreamSearchListModel listModel = streamInstance.getListByLocation(locationModel);

...

请求参数

请求参数传递 LocationModel 类型 。LocationModel 包含以下字段：

返回字段

接口返回 StreamSearchListModel 类型，StreamSearchListModel 标识返回详细数据。StreamSearchListModel 类型包含以下字段：

8. 销毁指定ID视频流

销毁在 LYCAM+ 后台系统中指定ID的视频流 。

...

String streamID = "775009d0-e06d-11e6-ba8a-a3de0ac619fb";

SuccessModel successModel = streamInstance.delete(streamID);

...

请求参数

请求参数传递 string 类型 ， 用于标识视频流的ID。

返回字段

接口返回 SuccessModel 类型，SuccessModel 标识返回详细数据。SuccessModel 类型包含以下字段：