Skip to content

Latest commit

 

History

History
334 lines (261 loc) · 9.8 KB

README.md

File metadata and controls

334 lines (261 loc) · 9.8 KB

Pili Streaming Cloud server-side library for Python

Features

  • URL

    • RTMP推流地址: rtmp_publish_url(domain, hub, key, mac, expire_after_seconds)
    • RTMP直播地址: rtmp_play_url(domain, hub, key)
    • HLS直播地址: hls_play_url(domain, hub, key)
    • HDL直播地址: hdl_play_url(domain, hub, key)
    • 直播封面地址: snapshot_play_url(domain, hub, key)

  • Hub

    • 创建流: hub.create(key)
    • 获得流: hub.get(key)
    • 列出流: hub.list(prefix, limit, marker, liveonly)
    • 批量查询直播状态: hub.batch_live_status(streams)

  • Stream

    • 流信息: stream.refresh()
    • 禁用流: stream.disable(till)
    • 查询直播状态: stream.status()
    • 保存直播回放: stream.saveas(start, end, options)
    • 保存直播截图: stream.snapshot(options)
    • 更改流的实时转码规格: stream.update_converts(profiles)
    • 查询直播历史: stream.history(start, end)

  • Room

    • 创建房间: room.create_room(options)
    • 生成token: room.roomToken(options)
    • 删除房间: room.deleteRoom(roomName)
    • 踢除用户: room.kickUser(roomName, userId)
    • 查询房间: room.getRoom(roomName)
    • 查询在线用户: room.getUser(roomName)

Contents

Installation

before next step, install git.

# install latest version
$ pip install pili2

Usage

Configuration

import pili


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

mac = pili.Mac(AccessKey, SecretKey)
# ...

URL

Generate RTMP publish URL

print "RTMP publish URL:"
print pili.rtmp_publish_url("publish-rtmp.test.com", hub_name, "streamtitle", mac, 60)
# rtmp://publish-rtmp.test.com/PiliSDKTest/streamtitle?e=1488366903&token=Ge_kRfuV_4JW0hOCOnRq5_kD1sX53bKVht8FNdd3:TVrLvhQtDRmww5u1FV5AdwUDRD0=

Generate RTMP play URL

print "RTMP play URL:"
print pili.rtmp_play_url("live-rtmp.test.com", hub_name, "streamtitle")
# rtmp://live-rtmp.test.com/PiliSDKTest/streamtitle

Generate HLS play URL

print "HLS live URL:"
print pili.hls_play_url("live-hls.test.com", hub_name, "streamtitle")
# http://live-hls.test.com/PiliSDKTest/streamtitle.m3u8

Generate HDL play URL

print "HDL live URL:"
print pili.hdl_play_url("live-hdl.test.com", hub_name, "streamtitle")
# http://live-hdl.test.com/PiliSDKTest/streamtitle.flv

Generate Snapshot play URL

print "snapshot URL:"
print pili.snapshot_play_url("live-snapshot.test.com", hub_name, "streamtitle")
# http://live-snapshot.test.com/PiliSDKTest/streamtitle.jpg

Hub

Instantiate a Pili Hub object

mac = pili.Mac(AccessKey, SecretKey)
hub = Hub(mac, hub_name)

Create a new Stream

stream = hub.create(stream_title1)
print "create stream:"
print stream
# {"disabledTill": 0, "converts": [], "hub": "PiliSDKTest", "key": "stream29479963631_1"}

Get a Stream

print "get stream:"
stream = hub.get(stream_title1)
print stream
# {"disabledTill": 0, "converts": [], "hub": "PiliSDKTest", "key": "stream29479963631_1"}

List Streams

print "list streams:"
print hub.list(prefix=stream_pre, limit=2)
# {u'marker': u'2', u'items': [{u'key': u'stream23057608792_3'}, {u'key': u'stream23057608792_2'}]}

List live Streams

print "list live streams:"
print hub.list(liveonly=True)
# {u'marker': u'', u'items': [{u'key': u'test1'}]}

Batch query live status

print "batch query live streams:",
print hub.batch_live_status(["test1", "test2"])
# [{u'key': u'test1', u'clientIP': u'172.21.2.14:63672', u'startAt': 1488377320, u'bps': 662200, u'fps': {u'data': 0, u'audio': 47, u'video': 25}}]

Stream

Get Stream info

print "get stream info:"
stream = hub.get(stream_title1)
print stream.refresh()
# {"disabledTill": 0, "converts": [], "hub": "PiliSDKTest", "key": "stream23057608792_1"}

Disable a Stream

stream = hub.get(stream_title1)
print "before disable:", stream, stream.disabled()
stream.disable(int(time.time()) + 5)
print "after call disable:", stream.refresh(), stream.disabled()
time.sleep(5)
print "after sleep 5 seconds:", stream.refresh(), stream.disabled()

# before disable: {"disabledTill": 0, "converts": [], "hub": "PiliSDKTest", "key": "stream23126041129_1"} False
# after call disable: {"disabledTill": 1488378022, "converts": [], "hub": "PiliSDKTest", "key": "stream23126041129_1"} True
# after sleep 5 seconds: {"disabledTill": 1488378022, "converts": [], "hub": "PiliSDKTest", "key": "stream23126041129_1"} False

Get Stream live status

stream = hub.get("test1")
print "query stream live status:"
print stream.status()
# {u'clientIP': u'172.21.2.14:60209', u'startAt': 1488359924, u'bps': 672712, u'fps': {u'data': 0, u'audio': 47, u'video': 25}}

Save Stream live playback

now = int(time.time())
print "save stream playback:"
print stream.saveas(start_second=now-300, fname="test1.m3u8")
# {u'fname': u'test1.m3u8'}

Save Stream snapshot

print "save stream snapshot:"
print stream.snapshot(fname="test1.jpg")
# {u'fname': u'test1.jpg'}

Update Stream Converts

stream = hub.get(stream_title1)
print "before update converts:", stream.refresh()
stream.update_converts(["480p", "720p"])

print "after update converts:", stream.refresh()
# before update converts: {"disabledTill": 0, "converts": [], "hub": "PiliSDKTest", "key": "stream24038673998_1"}
# after update converts: {"disabledTill": 0, "converts": ["480p", "720p"], "hub": "PiliSDKTest", "key": "stream24038673998_1"}

Get Stream history activity

now = int(time.time())
print "get publish history
print stream.history(start_second=now-86400)
# [{u'start': 1488359927, u'end': 1488367483}, {u'start': 1488348110, u'end': 1488358759}, {u'start': 1488338678, u'end': 1488340383}, {u'start': 1488333270, u'end': 1488337953}, {u'start': 1488282646, u'end': 1488288321}]

Room

Instantiate a Pili Room

mac = pili.Mac(AccessKey, SecretKey)
room = RoomClient(mac)

Create Room

resp = room.create_room('admin_user', 'roomname')
print(resp.status_code)
print(resp.headers)
print(resp.text)
#200
#{'Content-Length': '24', 'X-Whom': 'bc196', 'Vary': 'Accept-Encoding', 'Server': 'nginx/1.8.0', 'X-Log': 'PILI-RTC:1', 'Connection': 'keep-alive', 'X-Reqid': 'bccmalhRqam8WsO_', 'Date': 'Thu, 29 Mar 2018 08:54:01 GMT', 'Content-Type': 'application/json'}
#{"room_name":"roomname"}

Create Token

print(room.roomToken('roomname', 'admin_user', 'admin', 3600))

Delete Room

resp = room.deleteRoom('roomname')
print(resp.status_code)
print(resp.headers)
print(resp.text)
#200
#{'Content-Length': '2', 'X-Whom': 'bc197', 'Vary': 'Accept-Encoding', 'Server': 'nginx/1.8.0', 'X-Log': 'PILI-RTC:1', 'Connection': 'keep-alive', 'X-Reqid': 'GRkeCnQZB6q8WkvM', 'Date': 'Thu, 29 Mar 2018 08:55:35 GMT', 'Content-Type': 'application/json'}
#{}

Kick User

resp = room.kickUser('roomname', 'admin_user')
print(resp.status_code)
print(resp.headers)
print(resp.text)
#200
#{'Content-Length': '33', 'Server': 'nginx/1.8.0', 'X-Log': 'PILI-RTC:169/500', 'Connection': 'keep-alive', 'X-Reqid': 'DT87e9Y39qq8WrN7, DT87e9Y39qq8WrN7', 'Date': 'Thu, 29 Mar 2018 08:59:34 GMT', 'Content-Type': 'application/json'}
#{}

Query Room

resp = room.getRoom('roomname')
print(resp.status_code)
print(resp.headers)
print(resp.text)
#200
#{'Content-Length': '73', 'X-Whom': 'bc197', 'Vary': 'Accept-Encoding', 'Server': 'nginx/1.8.0', 'X-Log': 'PILI-RTC:213', 'Connection': 'keep-alive', 'X-Reqid': 'GRkeCnQZRqu8Wp3R, GRkeCnQZRqu8Wp3R', 'Date': 'Thu, 29 Mar 2018 09:00:55 GMT', 'Content-Type': 'application/json'}
#{"owner_id":"admin","room_name":"roomname","room_status":0,"user_max":10}

Query User

resp = room.getUser('roomname')
print(resp.status_code)
print(resp.headers)
print(resp.text)
#200
#{'Content-Length': '19', 'X-Whom': 'bc197', 'Vary': 'Accept-Encoding', 'Server': 'nginx/1.8.0', 'X-Log': 'PILI-RTC:197', 'Connection': 'keep-alive', 'X-Reqid': 'bccmalhRdqu8WnnH, bccmalhRdqu8WnnH', 'Date': 'Thu, 29 Mar 2018 09:01:43 GMT', 'Content-Type': 'application/json'}
#{"active_users":[]}