# pili-sdk-java

**Repository Path**: flyingkeke/pili-sdk-java

## Basic Information

- **Project Name**: pili-sdk-java
- **Description**: 七牛云 sdk
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2018-02-28
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

#七牛云 sdk 搬运

# Pili Streaming Cloud Server-Side Library For JAVA

## Features

- URL
	- [x] RTMP推流地址: client.RTMPPublishURL(domain, hub, streamKey, expireAfterDays)
	- [x] RTMP直播地址: RTMPPlayURL(domain, hub, streamKey)
	- [x] HLS直播地址: HLSPlayURL(domain, hub, streamKey)
	- [x] HDL直播地址: HDLPlayURL(domain, hub, streamKey)
	- [x] 直播封面地址: SnapshotPlayURL(domain, hub, streamKey)
- Hub
	- [x] 创建流: hub.create(streamKey)
	- [x] 查询流: hub.get(streamKey)
	- [x] 列出流: hub.list(prefix, limit, marker)
	- [x] 列出正在直播的流: hub.listLive(prefix, limit, marker)
	- [x] 批量查询直播实时信息: hub.batchLiveStatus(streamTitles)
- Stream
	- [x] 流信息: stream.info()
	- [x] 禁用流: stream.disable() / stream.disable(disabledTill)
	- [x] 解禁流: stream.enable()
 	- [x] 查询直播状态: stream.liveStatus()
	- [x] 保存直播回放: stream.save(key, start, end) / stream.save(saveOptions)
	- [x] 保存直播截图: stream.snapshot(snapshotOptions) zzz
	- [x] 更改流的实时转码规格: stream.updateConverts(profiles)
	- [x] 查询直播历史: stream.historyRecord(start, end)

## Contents

- [Installation]()
- [Usage](#usage)
    - [Configuration]()
	- [URL](#url)
		- [Generate RTMP publish URL](#generate-rtmp-publish-url)
		- [Generate RTMP play URL](#generate-rtmp-play-url)
		- [Generate HLS play URL](#generate-hls-play-url)
		- [Generate HDL play URL](#generate-hdl-play-url)
		- [Generate Snapshot play URL](#generate-snapshot-play-url)
	- [Hub](#hub)
		- [Instantiate a Pili Hub object](#instantiate-a-pili-hub-object)
		- [Create a new Stream](#create-a-new-stream)
		- [Get a Stream](#get-a-stream)
		- [List Streams](#list-streams)
		- [List live Streams](#list-live-streams)
		- [Batch get streams' live status](#batch-live-status)
	- [Stream](#stream)
		- [Get Stream info](#get-stream-info)
		- [Disable a Stream](#disable-a-stream)
		- [Enable a Stream](#enable-a-stream)
		- [Get Stream live status](#get-stream-live-status)
		- [Get Stream history record](#get-stream-history-record)
		- [Save Stream live playback](#save-stream-live-playback)
		- [Snapshot Stream](#snapshot-stream)
		- [Update converts](#update-converts)

## Java version

The project is built with java 1.7.

## Compile JAR

Firstly, make sure you have [gradle](http://gradle.org/gradle-download/) on your machine.

Then all you have to do is just 

```
gradle build
```

## Dependencies

`okhttp`, `okio`, `Gson`

## Install via gradle

```
compile 'com.qiniu.pili:pili-sdk-java:2.1.0'
```

## Usage

### Init

```java
Client cli = new Client(accessKey,secretKey);
```

### URL

#### Generate RTMP publish URL

```java
String url = cli.RTMPPublishURL("publish-rtmp.test.com", "PiliSDKTest", "streamkey", 60);
/*
rtmp://publish-rtmp.test.com/PiliSDKTest/streamkey?e=1463023142&token=7O7hf7Ld1RrC_fpZdFvU8aCgOPuhw2K4eapYOdII:-5IVlpFNNGJHwv-2qKwVIakC0ME=
*/
```

#### Generate RTMP play URL

```java
String url = cli.RTMPPlayURL("live-rtmp.test.com", "PiliSDKTest", "streamkey");
/*
rtmp://live-rtmp.test.com/PiliSDKTest/streamkey
*/
```

#### Generate HLS play URL

```java
url = cli.HLSPlayURL("live-hls.test.com", "PiliSDKTest", "streamkey");
/*
http://live-hls.test.com/PiliSDKTest/streamkey.m3u8
*/
```

#### Generate HDL play URL

```java
url = cli.HDLPlayURL("live-hdl.test.com", "PiliSDKTest", "streamkey");
/*
http://live-hdl.test.com/PiliSDKTest/streamkey.flv
*/
```

#### Generate Snapshot play URL

```java
url = cli.SnapshotPlayURL("live-snapshot.test.com", "PiliSDKTest", "streamkey");
/*
http://live-snapshot.test.com/PiliSDKTest/streamkey.jpg
*/
```

### Hub

#### Instantiate a Pili Hub object

```java
public static void main(String args[]) { 
	Client cli = new Client(accessKey, secretKey);
	Hub hub = cli.newHub("PiliSDKTest");
	// ...
}
```

#### Create a new Stream

```java
Stream stream = hub.create("streamkey")
System.out.println(stream.toJson());
/*
{"Hub":"PiliSDKTest","Key":"streamkey","DisabledTill":0}
*/
```

#### Get a Stream

```java
Stream stream = hub.get("streamkey")
System.out.println(stream.toJson())
/*
{"Hub":"PiliSDKTest","Key":"streamkey","DisabledTill":0}
*/
```

#### List Streams

```java
Hub.ListRet listRet = hub.list("str", 10, "")
/*
keys=[streamkey] marker=
*/
```

#### List live Streams

```java
Hub.ListRet listRet = hub.listLive("str", 10, "")
/*
keys=[] marker=
*/
```

#### Batch live status

```java
Hub.BatchLiveStatus[] statuses = hub.batchLiveStatus(new String[]{"strm1","strm2"});
```

### Stream

#### Get stream info

Get the latest stream info
```java
Stream stream = hub.get("streamkey")
stream.disable()
// will get the latest info from server
stream = stream.info()
```

#### Disable a Stream

```java
Stream stream = hub.get("streamkey")
stream.disable()
stream = hub.get("streamkey")
/*
before disable: {"Hub":"PiliSDKTest","Key":"streamkey","DisabledTill":0}
after disable: {"Hub":"PiliSDKTest","Key":"streamkey","DisabledTill":-1}
*/

stream.disable(1488540526L);
stream.info();
/*
after disable: {"Hub":"PiliSDKTest","Key":"streamkey","DisabledTill":1488540526}
*/
```


#### Enable a Stream

```java
Stream stream = hub.get("streamkey")
stream.enable()
stream = hub.get("streamkey")
/*
before disable: {"Hub":"PiliSDKTest","Key":"streamkey","DisabledTill":-1}
after disable: {"Hub":"PiliSDKTest","Key":"streamkey","DisabledTill":0}
*/
```

#### Get Stream live status

```java
Stream.LiveStatus status = stream.liveStatus();
/*
{"startAt":1463022236,"clientIP":"222.73.202.226","bps":248,"fps":{"audio":45,"vedio":28,"data":0}}
*/
```

#### Get Stream history record

```java
Stream.Record[] records = stream.historyRecord(0, 0)
/*
[{1463022236,1463022518}]
*/
```

#### Save Stream live playback

```java
String fname = stream.save(0, 0)
/*
recordings/z1.hub1.strm1/0_1488529267.m3u8
*/
```

#### Snapshot Stream

```java
Stream.SnapshotOptions opts = new Stream.SnapshotOptions();
opts.fname = "test";
stream.snapshot(opts);
```
#### Update converts

```java
String[] profiles = {"480p", "720p"};
stream.updateConverts(profiles);
```
=======
# pili-sdk-java