Project

pili

0.02
No commit activity in last 3 years
No release in over 3 years
pilipili-engineering/pili-sdk-rubyHomepageDocumentationSource CodeBug TrackerWiki
Pili Streaming Cloud server-side library for Ruby.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
34,571
Stars
23
Forks
10
Watchers
18
 Releases
Current version
1.5.5
Total releases
15
First release
2015-04-23
Latest release
2016-09-14
 Issues
Open Issues
1
Closed Issues
5
Total Issues
6
Issue Closure Rate
83%
 Pull Requests
Open Pull Requests
0
Closed Pull Requests
3
Merged Pull Requests
28
Pull Request Acceptance Rate
90%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2016-07-16
Reverse Dependencies
0

 Dependencies

Development

bundler
~> 1.7
rake
~> 10.0

Runtime

httparty
~> 0.13.3
 Project Readme

Pili Streaming Cloud server-side library for Ruby

Features

  • URL
    • RTMP推流地址: rtmp_publish_url(domain, hub, stream_title, mac, expire_after_seconds)
    • RTMP直播地址: rtmp_play_url(domain, hub, stream_title)
    • HLS直播地址: hls_play_url(domain, hub, stream_title)
    • HDL直播地址: hdl_play_url(domain, hub, stream_title)
    • 直播封面地址: snapshot_play_url(domain, hub, stream_title)
  • Hub
    • 创建流: hub.create(stream_title)
    • 获得流: hub.stream(stream_title)
    • 列出流: hub.list(...)
    • 列出正在直播的流: hub.list_live(...)
    • 批量查询直播信息: hub.batch_query_live_status(stream_titles)
  • Stream
    • 流信息: stream.info()
    • 无限期禁用流: stream.disable()
    • 禁用流: stream.disable_till(timestamp)
    • 启用流: stream.enable()
    • 查询直播状态: stream.live_status()
    • 保存直播回放: stream.saveas(...)
    • 保存直播截图: stream.snapshot(...)
    • 更改流的实时转码规格: stream.update_converts(profiles)
    • 查询直播历史: stream.history_activity(...)

Contents

  • Installation
  • Usage
    • Configuration
    • URL
      • Generate RTMP publish URL
      • Generate RTMP play URL
      • Generate HLS play URL
      • Generate HDL play URL
      • Generate Snapshot play URL
    • Hub
      • Instantiate a Pili Hub object
      • Create a new Stream
      • Get a Stream
      • List Streams
      • List live Streams
      • Batch query live status
    • Stream
      • Get Stream info
      • Disable a Stream
      • Disable a Stream with timestamp
      • Enable a Stream
      • Get Stream live status
      • Save Stream live playback
      • Save Stream snapshot
      • Update converts
      • Get Stream history activity

Installation

Add this line to your application's Gemfile:

gem 'piliv2'

And then execute:

$ bundle

Or install it yourself as:

$ gem install piliv2

Usage

Configuration

require "piliv2"

access_key = "<QINIU ACCESS KEY>" # 替换成自己 Qiniu 账号的 AccessKey.
secret_key = "<QINIU SECRET KEY>" # 替换成自己 Qiniu 账号的 SecretKey.
hub_name   = "<PILI HUB NAME>"    # Hub 必须事先存在.

mac = Pili::Mac.new(access_key, secret_key)
client = Pili::Client.new(mac)
hub = client.hub(hub_name)

URL

Generate RTMP publish URL

url = Pili.rtmp_publish_url("publish-rtmp.test.com", "PiliSDKTest", "streamtitle", mac, 60)
puts(url)
# rtmp://publish-rtmp.test.com/PiliSDKTest/streamtitle?e=1463023142&token=7O7hf7Ld1RrC_fpZdFvU8aCgOPuhw2K4eapYOdII:-5IVlpFNNGJHwv-2qKwVIakC0ME=

Generate RTMP play URL

url = Pili.rtmp_play_url("live-rtmp.test.com", "PiliSDKTest", "streamtitle")
puts(url)
# rtmp://live-rtmp.test.com/PiliSDKTest/streamtitle

Generate HLS play URL

url = Pili.hls_play_url("live-hls.test.com", "PiliSDKTest", "streamtitle")
puts(url)
# http://live-hls.test.com/PiliSDKTest/streamtitle.m3u8

Generate HDL play URL

url = Pili.hdl_play_url("live-hdl.test.com", "PiliSDKTest", "streamtitle")
puts(url)
# http://live-hdl.test.com/PiliSDKTest/streamtitle.flv

Generate Snapshot play URL

url = Pili.snapshot_play_url("live-snapshot.test.com", "PiliSDKTest", "streamtitle")
puts(url)
# http://live-snapshot.test.com/PiliSDKTest/streamtitle.jpg

Hub

Instantiate a Pili Hub object

mac = Pili::Mac.new(access_key, secret_key)
client = Pili::Client.new(mac)
hub = client.hub("PiliSDKTest")

Create a new Stream

stream = hub.create("streamtitle")
puts(stream.info.to_json)
# {"hub":"PiliSDKTest","key":"streamtitle","disabled":false}

Get a Stream

stream = hub.stream("streamtitle")
puts(stream.info.to_json)
# {"hub":"PiliSDKTest","key":"streamtitle","disabled":false}

List Streams

titles, marker = hub.list(:prefix=>"str", :limit=>10)
puts titles.to_s, marker
# [<titles...>], <marker>

List live Streams

titles, marker = hub.list_live(:prefix=>"str", :limit=>10)
puts titles.to_s, marker
# [<titles...>], <marker>

Batch query live status

live_statuses = hub.batch_query_live_status(["stream1", "stream2"])
puts live_statuses
# {"startAt"=>1488798455, "clientIP"=>"119.130.107.231:35018", "bps"=>921960, "fps"=>{"audio"=>44, "video"=>29, "data"=>0}, "key"=>"stream1"}
# {"startAt"=>1488798287, "clientIP"=>"119.130.107.231:55924", "bps"=>867328, "fps"=>{"audio"=>42, "video"=>9, "data"=>0}, "key"=>"stream2"}

Stream

Get Stream info

stream = hub.stream(title)
puts(stream.info.to_json)
# {"hub": "PiliSDKTest", "key": "streamtitle", "disabled": false}

Disable a Stream

stream = hub.stream("streamtitle")
puts("before disable: #{stream.info.to_json}")

stream.disable()

stream = hub.stream("streamtitle")
puts("after disable: #{stream.info.to_json}")
# before disable: {"hub":"PiliSDKTest","key":"streamtitle","disabled":false}
# after disable: {"hub":"PiliSDKTest","key":"streamtitle","disabled":true}

Disable a Stream with timestamp

stream = hub.stream("streamtitle")
puts("before disable: #{stream.info.to_json}")

stream.disable_till(Time.now.to_i + 10)

puts("after disable: #{stream.info.to_json}")

sleep(10)

puts("after 10 seconds: #{stream.info.to_json}")

# before disable: {"hub":"PiliSDKTest","key":"streamtitle","disabled":false}
# after disable: {"hub":"PiliSDKTest","key":"streamtitle","disabled":true}
# before 10 seconds: {"hub":"PiliSDKTest","key":"streamtitle","disabled":false}

Enable a Stream

stream = hub.stream("streamtitle")
puts("before enable: #{stream.info.to_json}")

stream.enable()

stream = hub.get("streamtitle")
puts("after enable: #{stream.info.to_json}")
# before disable: {"hub":"PiliSDKTest","key":"streamtitle","disabled":true}
# after disable: {"hub":"PiliSDKTest","key":"streamtitle","disabled":false}

Get Stream live status

status = stream.live_status()
puts(status.to_json)
# {"startAt":1463022236,"clientIP":"222.73.202.226","bps":248,"fps":{"audio":45,"vedio":28,"data":0}}

Save Stream live playback

fname, persistentID = stream.saveas(:format => "mp4")
puts(fname, persistentID)
# recordings/z1.PiliSDKTest.streamtitle/1463156847_1463157463.mp4
# z1.58bd753a8a3c0c3794a1d6ff

Save Stream snapshot

fname = stream.snapshot()
puts(fname)
# stream-title-4532162526321415963.jpg

Update converts

stream = hub.stream("streamtitle")
puts stream.info.to_json
stream.update_converts(["720p", "480p"])
puts stream.info.to_json
# {"hub":"PiliSDKTest","key":"streamtitle","disabled":false,"converts":[]}
# {"hub":"PiliSDKTest","key":"streamtitle","disabled":false,"converts":["720p","480p"]}

Get Stream history activity

activity = stream.history_activity()
puts(activity.to_json)
# [{"start":1463022236,"end":1463022518}]