pili 1.3.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9865e9866575afe5e7d4237d81e632fd7000a919
-  data.tar.gz: e9c96dd71f418ce1d5d5b4fc71610b00210a0833
+  metadata.gz: 23353fd81b87b9123d66b1ae43ff0bcab17a1394
+  data.tar.gz: 26c4b2efa6956cf2807c7980e41d109aca547a89
 SHA512:
-  metadata.gz: 53caacf8ab81601fe91c5e710b78e0da2757f362d75ab4c02296f4568b0ff12da9ef9b6da9b9301450bdead75c06ed13d4543fecdded02cded17227db36914d7
-  data.tar.gz: 99f70ed7c9180b8c3c38bd6dbf6ed1c2c747b803f9753f450dc3279bb322f6a65bd0129e20031c2be85b9233723d5be4097110e66ceea5307ba0dc86fae4b4ba
+  metadata.gz: 821ade8cbfb8aa4b98238d67d7dec341dded6825a6a522a46bb59032e93d64b7f07466eee0480477211fbfda1672daf50127d7c45114df5afe9bbfb3d40c703e
+  data.tar.gz: afb135beccd5561a2919d0da9887fffa9b7fe6eae1278d181f65ca55f97438c6ac1322a9c534411a265193b282a71b6fd3197892c197466d170dab6a75bf5ccf

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pili (0.0.1)
+    pili (1.5.0)
       httparty (~> 0.13.3)
 
 GEM
@@ -10,7 +10,7 @@ GEM
     httparty (0.13.3)
       json (~> 1.8)
       multi_xml (>= 0.5.2)
-    json (1.8.2)
+    json (1.8.3)
     multi_xml (0.5.5)
     rake (10.4.2)
 

data/README.md

@@ -1,36 +1,51 @@
-# Pili server-side library for Ruby
+# Pili Streaming Cloud server-side library for Ruby
 
 ## Features
 
-- [x] Stream operations (Create, Delete, Update, Get)
-- [x] Get Streams list
-- [x] Get Stream status
-- [x] Get Stream segments
-- [x] Generate RTMP publish URL
-- [x] Generate RTMP / HLS live play URL
-- [x] Generate HLS playback URL
-
-## Content
+- Stream Create,Get,List
+  - [x] hub.create_stream()
+  - [x] hub.get_stream()
+  - [x] hub.list_streams()
+- Stream operations else
+  - [x] stream.to_json()
+  - [x] stream.update()
+  - [x] stream.disable()
+  - [x] stream.enable()
+  - [x] stream.status()
+  - [x] stream.rtmp_publish_url()
+  - [x] stream.rtmp_live_urls()
+  - [x] stream.hls_live_urls()
+  - [x] stream.http_flv_live_urls()
+  - [x] stream.segments()
+  - [x] stream.hls_playback_urls()
+  - [x] stream.save_as()
+  - [x] stream.snapshot()
+  - [x] stream.delete()
+
+## Contents
 
 - [Installation](#installation)
 - [Usage](#usage)
   - [Configuration](#configuration)
-  - [Client](#client)
-    - [Create a Pili client](#create-a-pili-client)
-    - [Create a stream](#create-a-stream)
-    - [Get a stream](#get-a-stream)
-    - [List streams](#list-streams)
+  - [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)
   - [Stream](#stream)
-    - [Update a stream](#update-a-stream)
-    - [Delete a stream](#delete-a-stream)
-    - [Get stream segments](#get-stream-segments)
-    - [Get stream status](#get-stream-status)
+    - [To JSON String](#to-json-string)
+    - [Update a Stream](#update-a-stream)
+    - [Disable a Stream](#disable-a-stream)
+    - [Enable a Stream](#enable-a-stream)
     - [Generate RTMP publish URL](#generate-rtmp-publish-url)
     - [Generate RTMP live play URLs](#generate-rtmp-live-play-urls)
     - [Generate HLS live play URLs](#generate-hls-live-play-urls)
+    - [Generate HTTP-FLV live play URLs](#generate-http-flv-live-play-urls)
+    - [Get Stream segments](#get-stream-segments)
     - [Generate HLS playback URLs](#generate-hls-playback-urls)
-    - [To JSON String](#to-json-string)
-    - [Save Stream as](#save-stream-as)
+    - [Save Stream as a file](#save-stream-as-a-file)
+    - [Snapshot Stream](#snapshot-stream)
+    - [Delete a stream](#delete-a-stream)
 - [History](#history)
 
 ## Installation
@@ -55,191 +70,467 @@ Or install it yourself as:
 ```ruby
 require 'pili'
 
-ACCESS_KEY = 'qiniu_access_key'
-SECRETE_KEY = 'qiniu_secret_key'
+ACCESS_KEY  = 'Qiniu_AccessKey'
+SECRETE_KEY = 'Qiniu_SecretKey'
+
+HUB_NAME    = 'Pili_Hub_Name' # The Hub must be exists before use
 
-HUB_NAME = 'hub_name'
+# Change API host as necessary
+# pili.qiniuapi.com as deafult
+# pili-lte.qiniuapi.com is the latest RC version
+Pili::Config.init api_host: 'pili-lte.qiniuapi.com'
 ```
 
-### Client
 
-#### Create a Pili client
+## Hub
 
+### Instantiate a Pili Hub object
 ```ruby
-client = Pili::Client.new(ACCESS_KEY, SECRETE_KEY, HUB_NAME)
-# return client object...
+credentials = Pili::Credentials.new(ACCESS_KEY, SECRETE_KEY)
+hub = Pili::Hub.new(credentials, HUB_NAME)
+puts "Hub initialize =>\n#{hub.inspect}\n\n"
 ```
 
-#### Create a stream
+
+### Create a new Stream
 
 ```ruby
-# 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...
+begin
+  title            = nil # optional, auto-generated as default
+  publish_key      = nil # optional, auto-generated as default
+  publish_security = nil # optional, can be "dynamic" or "static", "dynamic" as default
+
+  # stream = hub.create_stream()
+  # or
+  stream = hub.create_stream(title: title, publish_key: publish_key, publish_security: publish_security)
+
+  puts "Hub create_stream() =>\n#{stream.inspect}\n\n"
+rescue Exception => e
+  puts "Hub create_stream() failed. Caught exception:\n#{e.http_body}\n\n"
+end
+
+##<Pili::Stream:0x007fdf9413ab98
+#  @credentials=#<Pili::Credentials:0x007fdf939392c8 @access_key="0QxleRjH-IGYystrYdeY5w6KdkSdJVa5SaBUbJkY", @secret_key="Vg3u2240H6JL78sfjsgLohGLjk_jO5e0cdief0g3">,
+#  @id="z1.hub1.55d886b5e3ba571322003121",
+#  @title="55d886b5e3ba571322003121",
+#  @hub="hub1",
+#  @publish_key="0e18061751841053",
+#  @publish_security="dynamic",
+#  @disabled=false,
+#  @hosts={
+#    "publish"=>{
+#      "rtmp"=>"eksg7h.publish.z1.pili.qiniup.com"
+#    },
+#    "live"=>{
+#      "http"=>"eksg7h.live1-http.z1.pili.qiniucdn.com",
+#      "rtmp"=>"eksg7h.live1-rtmp.z1.pili.qiniucdn.com"
+#    },
+#    "playback"=>{
+#      "http"=>"eksg7h.playback1.z1.pili.qiniucdn.com"
+#    }
+#  },
+#  @created_at="2015-08-22T14:27:01.62Z",
+#  @updated_at="2015-08-22T14:27:01.62Z"
+#>
 ```
 
-#### Get a stream
+
+### Get a Stream
 
 ```ruby
-# stream_id: string, required
-client.get_stream(stream_id)
-# return stream object...
+begin
+  stream = hub.get_stream(stream.id)
+  puts "Hub get_stream() =>\n#{stream.inspect}\n\n"
+rescue Exception => e
+  puts "Hub get_stream() failed. Caught exception:\n#{e.http_body}\n\n"
+end
+
+##<Pili::Stream:0x007fdf6413ab67
+#  @credentials=#<Pili::Credentials:0x007fdf939c2238 @access_key="0QxleRjH-IGYystrYdeY5w6KdkSdJVa5SaBUbJkY", @secret_key="Vg3u2240H6JL78sfjsgLohGLjk_jO5e0cdief0g3">,
+#  @id="z1.hub1.55d886b5e3ba571322003121",
+#  @title="55d886b5e3ba571322003121",
+#  @hub="hub1",
+#  @publish_key="0e18061751841053",
+#  @publish_security="dynamic",
+#  @disabled=false,
+#  @hosts={
+#    "publish"=>{
+#      "rtmp"=>"eksg7h.publish.z1.pili.qiniup.com"
+#    },
+#    "live"=>{
+#      "http"=>"eksg7h.live1-http.z1.pili.qiniucdn.com",
+#      "rtmp"=>"eksg7h.live1-rtmp.z1.pili.qiniucdn.com"
+#    },
+#    "playback"=>{
+#      "http"=>"eksg7h.playback1.z1.pili.qiniucdn.com"
+#    }
+#  },
+#  @created_at="2015-08-22T14:27:01.62Z",
+#  @updated_at="2015-08-22T14:27:01.62Z"
+#>
 ```
 
-#### List streams
+
+### List Streams
 
 ```ruby
-# marker: string, optional
-# limit: integer, optional
-client.list_streams(marker: "marker", limit: 1000)
+begin
+  marker = nil # optional
+  limit  = nil # optional
+  title  = nil # optional
+  streams = hub.list_streams(marker: marker, limit: limit, title: title)
+  puts "Hub list_streams() =>\n#{streams.inspect}\n\n"
+rescue Exception => e
+  puts "Hub list_streams() failed. Caught exception:\n#{e.http_body}\n\n"
+end
+
+#[
+#  #<Pili::Stream:0x007fdf94108f58>,
+#  #<Pili::Stream:0x007fdf94108f30>,
+#  #<Pili::Stream:0x007fdf94108f08>,
+#  #<Pili::Stream:0x007fdf94108ee0>,
+#  #<Pili::Stream:0x007fdf94108eb8>,
+#  #<Pili::Stream:0x007fdf94108e90>,
+#  #<Pili::Stream:0x007fdf94108e68>,
+#  #<Pili::Stream:0x007fdf94108e40>,
+#  #<Pili::Stream:0x007fdf94108e18>,
+#  #<Pili::Stream:0x007fdf94108df0>
+#]
 ```
 
-### Stream
 
-#### Update a stream
+## Stream
+
+### To JSON String
 
 ```ruby
-# publish_key: optional, a secret key for signing the <publishToken>
-# publish_security: optional, can be "dynamic" or "static", default is "dynamic"
-# disabled: optional, can be true or false
-stream.update(publish_key: "new_key", publish_security: "dynamic", disabled: true)
-# return updated stream object...
+json_string = stream.to_json()
+puts "Stream stream.to_json() =>\n#{json_string}\n\n"
+
+#'{
+#  "id":"z1.hub1.55d886b5e3ba571322003121",
+#  "title":"55d886b5e3ba571322003121",
+#  "hub":"hub1",
+#  "publish_key":"0e18061751841053",
+#  "publish_security":"dynamic",
+#  "disabled":false,
+#  "hosts":{
+#    "publish":{
+#      "rtmp":"eksg7h.publish.z1.pili.qiniup.com"
+#    },
+#    "live":{
+#      "http":"eksg7h.live1-http.z1.pili.qiniucdn.com",
+#      "rtmp":"eksg7h.live1-rtmp.z1.pili.qiniucdn.com"
+#    },
+#    "playback":{
+#      "http":"eksg7h.playback1.z1.pili.qiniucdn.com"
+#    }
+#  },
+#  "created_at":"2015-08-22T10:27:01.62-04:00",
+#  "updated_at":"2015-08-22T10:27:01.62-04:00"
+#}'
 ```
 
-#### Delete a stream
+### Update a Stream
 
 ```ruby
-stream.delete()
+begin
+  stream.publish_key      = "new_secret_words" # optional
+  stream.publish_security = "static"           # optional, can be "dynamic" or "static", "dynamic" as default
+  stream.disabled         = nil                # optional, can be true or false
+  stream = stream.update()
+  puts "Stream update() =>\n#{stream.inspect}\n\n"
+rescue Exception => e
+  puts "Stream update() failed. Caught exception:\n#{e.http_body}\n\n"
+end
+
+##<Pili::Stream:0x007fdf6413ab67
+#  @credentials=#<Pili::Credentials:0x007fdf939c2238 @access_key="0QxleRjH-IGYystrYdeY5w6KdkSdJVa5SaBUbJkY", @secret_key="Vg3u2240H6JL78sfjsgLohGLjk_jO5e0cdief0g3">,
+#  @id="z1.hub1.55d886b5e3ba571322003121",
+#  @title="55d886b5e3ba571322003121",
+#  @hub="hub1",
+#  @publish_key="new_secret_words",
+#  @publish_security="static",
+#  @disabled=false,
+#  @hosts={
+#    "publish"=>{
+#      "rtmp"=>"eksg7h.publish.z1.pili.qiniup.com"
+#    },
+#    "live"=>{
+#      "http"=>"eksg7h.live1-http.z1.pili.qiniucdn.com",
+#      "rtmp"=>"eksg7h.live1-rtmp.z1.pili.qiniucdn.com"
+#    },
+#    "playback"=>{
+#      "http"=>"eksg7h.playback1.z1.pili.qiniucdn.com"
+#    }
+#  },
+#  @created_at="2015-08-22T14:27:01.62Z",
+#  @updated_at="2015-08-22T14:27:01.62Z"
+#>
 ```
 
-#### Get stream segments
+### Disable a Stream
 
 ```ruby
-# 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)
+begin
+  stream = stream.disable()
+  puts "Stream disable() =>\n#{stream.inspect}\n\n"
+rescue Exception => e
+  puts "Stream disable() failed. Caught exception:\n#{e.http_body}\n\n"
+end
+
+##<Pili::Stream:0x007fdf6413ab67
+#  @credentials=#<Pili::Credentials:0x007fdf939c2238 @access_key="0QxleRjH-IGYystrYdeY5w6KdkSdJVa5SaBUbJkY", @secret_key="Vg3u2240H6JL78sfjsgLohGLjk_jO5e0cdief0g3">,
+#  @id="z1.hub_name.55d886b5e3ba571322003121",
+#  @title="55d886b5e3ba571322003121",
+#  @hub="hub1",
+#  @publish_key="new_secret_words",
+#  @publish_security="static",
+#  @disabled=true,
+#  @hosts={
+#    "publish"=>{
+#      "rtmp"=>"eksg7h.publish.z1.pili.qiniup.com"
+#    },
+#    "live"=>{
+#      "http"=>"eksg7h.live1-http.z1.pili.qiniucdn.com",
+#      "rtmp"=>"eksg7h.live1-rtmp.z1.pili.qiniucdn.com"
+#    },
+#    "playback"=>{
+#      "http"=>"eksg7h.playback1.z1.pili.qiniucdn.com"
+#    }
+#  },
+#  @created_at="2015-08-22T14:27:01.62Z",
+#  @updated_at="2015-08-22T14:27:01.62Z"
+#>
+```
 
-# [
-#   {
-#     "start": <StartSecond>,
-#     "end": <EndSecond>
-#   },
-#   {
-#     "start": <StartSecond>,
-#     "end": <EndSecond>
-#   },
-#   ...
-# ]
+
+### Enable a Stream
+
+```ruby
+begin
+  stream = stream.enable()
+  puts "Stream enable() =>\n#{stream.inspect}\n\n"
+rescue Exception => e
+  puts "Stream enable() failed. Caught exception:\n#{e.http_body}\n\n"
+end
+
+##<Pili::Stream:0x007fdf6413ab67
+#  @credentials=#<Pili::Credentials:0x007fdf939c2238 @access_key="0QxleRjH-IGYystrYdeY5w6KdkSdJVa5SaBUbJkY", @secret_key="Vg3u2240H6JL78sfjsgLohGLjk_jO5e0cdief0g3">,
+#  @id="z1.hub1.55d886b5e3ba571322003121",
+#  @title="55d886b5e3ba571322003121",
+#  @hub="hub1",
+#  @publish_key="new_secret_words",
+#  @publish_security="static",
+#  @disabled=false,
+#  @hosts={
+#    "publish"=>{
+#      "rtmp"=>"eksg7h.publish.z1.pili.qiniup.com"
+#    },
+#    "live"=>{
+#      "http"=>"eksg7h.live1-http.z1.pili.qiniucdn.com",
+#      "rtmp"=>"eksg7h.live1-rtmp.z1.pili.qiniucdn.com"
+#    },
+#    "playback"=>{
+#      "http"=>"eksg7h.playback1.z1.pili.qiniucdn.com"
+#    }
+#  },
+#  @created_at="2015-08-22T14:27:01.62Z",
+#  @updated_at="2015-08-22T14:27:01.62Z"
+#>
 ```
 
-#### Get stream status
+
+# Get Stream status
 
 ```ruby
-stream.status()
-# {
-#   "addr": "106.187.43.211:51393",
-#   "status": "disconnected"
-# }
+begin
+  status_info = stream.status()
+  puts "Stream status() =>\n#{status_info.inspect}\n\n"
+rescue Exception => e
+  puts "Stream status() failed. Caught exception:\n#{e.http_body}\n\n"
+end
+
+#{
+#  "addr"=>"222.73.202.226:2572",
+#  "status"=>"connected",
+#  "bytesPerSecond"=>16870.200000000001,
+#  "framesPerSecond"=>{
+#    "audio"=>42.200000000000003,
+#    "video"=>14.733333333333333,
+#    "data"=>0.066666666666666666
+#  }
+#}
 ```
 
-#### Generate RTMP publish URL
+
+### Generate RTMP publish URL
 
 ```ruby
-stream.rtmp_publish_url()
-# return a rtmp publish url, eg. "rtmp://test.qiniucdn.com/hubname/test?key=publish_test_key"
+publish_url = stream.rtmp_publish_url()
+puts "Stream rtmp_publish_url() =>\n#publish_url}\n\n"
+
+# "rtmp://eksg7h.publish.z1.pili.qiniup.com/hub1/55d886b5e3ba571322003121?nonce=1440256178&token=ikRpJBxr4qkfRJkAz4dtiaWITAQ="
 ```
 
-#### Generate RTMP live play URLs
+
+### Generate RTMP live play URLs
 
 ```ruby
 urls = stream.rtmp_live_urls()
-# return rtmp live play urls, eg.
+puts "Stream rtmp_live_urls() =>\n#{urls.inspect}\n\n"
+
 # {
-#   "ORIGIN" => "rtmp://test.qiniucdn.com/hubname/test",
-#   "240p" => "rtmp://test.qiniucdn.com/hubname/test@240p",
-#   ...
+#   "ORIGIN"=>"rtmp://eksg7h.live1-rtmp.z1.pili.qiniucdn.com/hub_name/55d886b5e3ba571322003121"
 # }
-
-# Get original RTMP live url
-original_url = urls['ORIGIN']
 ```
 
-#### Generate HLS live play URLs
+
+### Generate HLS live play URLs
 
 ```ruby
-stream.hls_live_urls()
-# return hls live play urls, eg.
+urls = stream.hls_live_urls()
+puts "Stream hls_live_urls() =>\n#{urls.inspect}\n\n"
+
 # {
-#   "ORIGIN" => "http://test.qiniucdn.com/hubname/test.m3u8",
-#   "240p" => "http://test.qiniucdn.com/hubname/test@240p.m3u8"
-#   ...
+#   "ORIGIN"=>"http://eksg7h.live1-http.z1.pili.qiniucdn.com/hub1/55d886b5e3ba571322003121.m3u8"
 # }
-
-# Get original HLS live url
-original_url = urls['ORIGIN']
 ```
 
-#### Generate HLS playback URLs
+
+### Generate HTTP-FLV live play URLs
 
 ```ruby
-# 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.
+urls = stream.http_flv_live_urls()
+puts "Stream http_flv_live_urls() =>\n#{urls.inspect}\n\n"
+
 # {
-#   "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"
-#   ...
+#   "ORIGIN"=>"http://eksg7h.live1-http.z1.pili.qiniucdn.com/hub1/55d886b5e3ba571322003121.flv"
 # }
+```
 
-# Get original HLS playback url
-original_url = urls['ORIGIN']
+
+### Get Stream segments
+
+```ruby
+begin
+  start_time = nil  # optional, integer, in second, unix timestamp
+  end_time   = nil  # optional, integer, in second, unix timestamp
+  limit      = nil  # optional, uint
+
+  segments = stream.segments(start_time: start_time, end_time: end_time, limit: limit)
+
+  puts "Stream segments() =>\n#{segments.inspect}\n\n"
+rescue Exception => e
+  puts "Stream segments() failed. Caught exception:\n#{e.http_body}\n\n"
+end
+
+# {
+#   "segments":[
+#     {
+#       "start":1440256809,
+#       "end":1440256842
+#     },
+#     {
+#       "start":1440256842,
+#       "end":1440256852
+#     }
+#   ]
+# }
 ```
 
-#### To JSON String
+
+### Generate HLS playback URLs
+
 ```ruby
-stream.to_json()
+start_time = 1440196065 # required, integer, in second, unix timestamp
+end_time   = 1440196105 # required, integer, in second, unix timestamp
+urls = stream.hls_playback_urls(start_time, end_time)
+puts "Stream hls_playback_urls() =>\n#{urls.inspect}\n\n"
+# {
+#   "ORIGIN"=>"http://eksg7h.playback1.z1.pili.qiniucdn.com/hub1/55d886b5e3ba571322003121.m3u8?start=1440196065&end=1440196105"
+# }
 ```
 
-#### Save Stream as
+
+### Save Stream as a file
+
 ```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
+begin
+  name       = "videoName.mp4" # required, string
+  format     = "mp4"           # required, string
+  start_time = 1440067100      # required, int64, in second, unix timestamp
+  end_time   = 1440068104      # required, int64, in second, unix timestamp
+  notify_url = nil             # optional
+  result = stream.save_as(name, format, start_time, end_time, notify_url)
+  puts "Stream save_as() =>\n#{result.inspect}\n\n"
+rescue Exception => e
+  puts "Stream save_as() failed. Caught exception:\n#{e.http_body}\n\n"
+end
 
-stream.save_as(name, format, start_time, end_time, options)
+# {
+#   "url"=>"http://eksg7h.vod1.z1.pili.qiniucdn.com/recordings/z1.hub1.55d886b5e3ba571322003121/videoName.m3u8",
+#   "targetUrl"=>"http://eksg7h.vod1.z1.pili.qiniucdn.com/recordings/z1.hub1.55d886b5e3ba571322003121/videoName.mp4",
+#   "persistentId"=>"z1.55d894f77823de5a49b52a16"
+# }
+```
+
+While invoking `saveAs()` and `snapshot()`, you can get processing 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>  
+
+
+### Snapshot Stream
+
+```ruby
+begin
+  name       = "imageName.jpg"  # required, string
+  format     = "jpg"            # required, string
+  options = {
+    :time       => 1440067100,  # optional, int64, in second, unix timestamp
+    :notify_url => nil          # optional
+  }
+  result = stream.snapshot(name, format, options)
+  puts "Stream snapshot() =>\n#{result.inspect}\n\n"
+rescue Exception => e
+  puts "Stream snapshot() failed. Caught exception:\n#{e.http_body}\n\n"
+end
 
-# return a dictionary:
 # {
-#   "url": "<m3u8Url>",
-#   "targetUrl": "<TargetFileUrl>",
-#   "persistentId": <PersistentId>
+#   "targetUrl"=>"http://eksg7h.static1.z1.pili.qiniucdn.com/snapshots/z1.hub1.55d886b5e3ba571322003121/imageName.jpg",
+#   "persistentId"=>"z1.55d8948f7823de5a49b52561"
 # }
-#
-# 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`
+```
+
+
+### Delete a Stream
+
+```ruby
+begin
+  result = stream.delete()
+  puts "Stream delete() =>\n#{result.inspect}\n\n"
+rescue Exception => e
+  puts "Stream delete() failed. Caught exception:\n#{e.http_body}\n\n"
+end
+
+# nil
 ```
 
 
 ## History
+
+- 1.5.0
+  - Add stream.http_flv_live_urls()
+  - Add stream.disable()
+  - Add stream.enable()
+  - Add stream.snapshot()
 - 1.3.0
-  - Add stream saveas function
+  - Add stream.saveas()
 - 1.2.0
   - Add Client, Stream class
 - 1.0.1
-  - Add get stream status method.
-  - Update update_stream method.
+  - Add stream.status()
+  - Update stream.update()
 - 1.0.0
   - Update README create stream example code.
 - 0.1.3
@@ -252,4 +543,4 @@ stream.save_as(name, format, start_time, end_time, options)
 - 0.0.1
   - Init SDK
   - Add Stream API
-  - Add publish and play policy
+  - Add publish and play policy