pili 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb22831f58fe2ba275e403086a5d6f582db1b276
-  data.tar.gz: 666a132c978cca3be0e787d7e5ce71c408019d52
+  metadata.gz: 4c9ad3f0d7a527077a1be8337686196970d09b3c
+  data.tar.gz: fe80a2ee4d91cc42d3304f9cb3e9ad719f97a816
 SHA512:
-  metadata.gz: 2f502768f7388d7bff3fa9af451282fcdc3080266ca13581cb3c51e4c8592e71fde7bde1be864d081cb4038c235b82596ee4f339acc6b33a049124925be3f55d
-  data.tar.gz: 185233ddbda8853da59537e5ce5f87f720cc40e33b05c71ac1fa3cb713d3db4eca2ceaf970a4e6de02e87faba0483fe1f6823bed6fcfcc97098d88d35fb1f2b3
+  metadata.gz: 93e45a37baf9469419688a4a3d2271f146d0d80f1cb2820e8651938bf5db7720ff155ee5b7b2e7d706f86fc89317cd29f5b8f5759691287e8ad32de55023ab7e
+  data.tar.gz: 05c23c3493dc459abc033a8f8c1cf9f064591cd43d4b34c2da6388753c8a1cc338c5de50985c09bd2fe4ae28a254888240443bf79a17e38a9ad5ee9587de97aa

data/README.md

@@ -26,10 +26,11 @@
     - [Get stream segments](#get-stream-segments)
     - [Get stream status](#get-stream-status)
     - [Generate RTMP publish URL](#generate-rtmp-publish-url)
-    - [Generate RTMP live play URL](#generate-rtmp-live-play-urls)
-    - [Generate HLS live play URL](#generate-hls-live-play-url)
-    - [Generate HLS playback URL](#generate-hls-playback-url)
+    - [Generate RTMP live play URLs](#generate-rtmp-live-play-urls)
+    - [Generate HLS live play URLs](#generate-hls-live-play-urls)
+    - [Generate HLS playback URLs](#generate-hls-playback-urls)
     - [To JSON String](#to-json-string)
+    - [Save Stream as](#save-stream-as)
 - [History](#history)
 
 ## Installation
@@ -75,6 +76,8 @@ client = Pili::Client.new(ACCESS_KEY, SECRETE_KEY, HUB_NAME)
 # title: optional, default is auto-generated
 # publish_key: optional, a secret key for signing the <publishToken>
 # publish_security: optional, can be "dynamic" or "static", default is "dynamic"
+client.create_stream()
+# or
 client.create_stream(title: "title", publish_key: "publish_key", publish_security: "static")
 # return stream object...
 ```
@@ -116,9 +119,11 @@ stream.delete()
 #### Get stream segments
 
 ```ruby
-# start_second: integer, optional
-# end_second: integer, optional
-stream.segments(start_second, end_second)
+# start_time: optional, integer, in second, unix timestamp
+# end_time:   optional, integer, in second, unix timestamp
+stream.segments()
+# or
+stream.segments(start_time, end_time)
 
 # [
 #   {
@@ -153,13 +158,16 @@ stream.rtmp_publish_url()
 #### Generate RTMP live play URLs
 
 ```ruby
-stream.rtmp_live_urls()
+urls = stream.rtmp_live_urls()
 # return rtmp live play urls, eg.
 # {
 #   "ORIGIN" => "rtmp://test.qiniucdn.com/hubname/test",
 #   "240p" => "rtmp://test.qiniucdn.com/hubname/test@240p",
 #   ...
 # }
+
+# Get original RTMP live url
+original_url = urls['ORIGIN']
 ```
 
 #### Generate HLS live play URLs
@@ -172,18 +180,26 @@ stream.hls_live_urls()
 #   "240p" => "http://test.qiniucdn.com/hubname/test@240p.m3u8"
 #   ...
 # }
+
+# Get original HLS live url
+original_url = urls['ORIGIN']
 ```
 
 #### Generate HLS playback URLs
 
 ```ruby
-stream.hls_playback_urls(start_second, end_second)
+# start_time: optional, integer, in second, unix timestamp
+# end_time:   optional, integer, in second, unix timestamp
+stream.hls_playback_urls(start_time, end_time)
 # return hls playback urls, eg.
 # {
 #   "ORIGIN" => "http://test.qiniucdn.com/hubname/test.m3u8?start=1436843430&end=1436846938",
 #   "240p" => "http://test.qiniucdn.com/hubname/test@240p.m3u8?start=1436843430&end=1436846938"
 #   ...
 # }
+
+# Get original HLS playback url
+original_url = urls['ORIGIN']
 ```
 
 #### To JSON String
@@ -191,9 +207,35 @@ stream.hls_playback_urls(start_second, end_second)
 stream.to_json()
 ```
 
-## History
+#### Save Stream as
+```ruby
+# name       = "fileName" # required, string
+# format     = "mp4"      # required, string
+# start_time = 1439121809 # required, int64, in second, unix timestamp
+# end_time   = 1439125409 # required, int64, in second, unix timestamp
+# options = {
+#   :notify_url => "http://remote_callback_url"
+# } #optional
+
+stream.save_as(name, format, start_time, end_time, options)
 
-- 2.0.0
+# return a dictionary:
+# {
+#   "url": "<m3u8Url>",
+#   "targetUrl": "<TargetFileUrl>",
+#   "persistentId": <PersistentId>
+# }
+#
+# You can get saving state via Qiniu fop service using persistentId.
+# API: `curl -D GET http://api.qiniu.com/status/get/prefop?id=<PersistentId>`
+# Doc reference: `http://developer.qiniu.com/docs/v6/api/overview/fop/persistent-fop.html#pfop-status`
+```
+
+
+## History
+- 1.3.0
+  - Add stream saveas function
+- 1.2.0
   - Add Client, Stream class
 - 1.0.1
   - Add get stream status method.

data/lib/pili/stream.rb

@@ -137,5 +137,21 @@ module Pili
       }.to_json
     end
 
+
+    def save_as(name, format, start_time, end_time, options = {})
+      url = Config.api_base_url + "/streams/" + @id + "/saveas"
+
+      body = {}
+      body[:name]      = name
+      body[:start]     = start_time
+      body[:end]       = end_time
+      body[:format]    = format
+      body[:notifyUrl] = options[:notify_url]
+
+      body.delete_if { |k, v| v.nil? }
+
+      API.post(@client.access_key, @client.secret_key, url, body)
+    end
+
   end
 end

data/lib/pili/version.rb

@@ -1,3 +1,3 @@
 module Pili
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pili
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Miclle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-15 00:00:00.000000000 Z
+date: 2015-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler