Readme
// install latest version
npm install pili --save
var Pili = require('pili');
var ACCESS_KEY = 'QiniuAccessKey';
var SECRET_KEY = 'QiniuSecretKey';
var HUB = 'PiliHubName'; // The Hub must be exists before use
// Change API host as necessary
//
// pili.qiniuapi.com as default
// pili-lte.qiniuapi.com is the latest RC version
//
// Pili.config.API_HOST = 'pili.qiniuapi.com'; // default
var credentials = new Pili.Credentials(ACCESS_KEY, SECRET_KEY);
var hub = new Pili.Hub(credentials, HUB);
var options = {
title : null, // optional, auto-generated as default
publishKey : null, // optional, auto-generated as default
publishSecurity : "static" // optional, can be "dynamic" or "static", "dynamic" as default
};
hub.createStream(options, function(err, stream) {
if (!err) {
console.log(stream);
// Log stream
// {
// "id":"z1.coding.35d7zfabe3bv5723280200c5",
// "createdAt":"2015-08-22T03:43:55.247Z",
// "updatedAt":"2015-08-22T03:43:55.247Z",
// "title":"35d7zfabe3bv5723280200c5",
// "hub":"coding",
// "publishKey":"f054e65199703b14",
// "publishSecurity":"static",
// "disabled":false,
// "profiles":null,
// "hosts":
// {
// "publish":
// {
// "rtmp":"scv02k.publish.z1.pili.qiniup.com"
// },
// "live":
// {
// "http":"scv02k.live1-http.z1.pili.qiniucdn.com",
// "rtmp":"scv02k.live1-rtmp.z1.pili.qiniucdn.com"
// },
// "playback":
// {
// "http":"scv02k.playback1.z1.pili.qiniucdn.com"
// }
// }
// }
} else {
// Log error
console.log(err + 'error code: ' + err.errorCode + 'http code: ' err.httpCode);
}
});
var streamId = 'z1.coding.35d7zfabe3bv5723280200c5'; // required
hub.getStream(streamId, function(err, stream) {
if (!err) {
console.log(stream);
// Log stream
// {
// "id":"z1.coding.35d7zfabe3bv5723280200c5",
// "createdAt":"2015-08-22T03:43:55.247Z",
// "updatedAt":"2015-08-22T03:43:55.247Z",
// "title":"35d7zfabe3bv5723280200c5",
// "hub":"coding",
// "publishKey":"f054e65199703b14",
// "publishSecurity":"static",
// "disabled":false,
// "profiles":null,
// "hosts":
// {
// "publish":
// {
// "rtmp":"scv02k.publish.z1.pili.qiniup.com"
// },
// "live":
// {
// "http":"scv02k.live1-http.z1.pili.qiniucdn.com",
// "rtmp":"scv02k.live1-rtmp.z1.pili.qiniucdn.com"
// },
// "playback":
// {
// "http":"scv02k.playback1.z1.pili.qiniucdn.com"
// }
// }
// }
}
});
var options = {
marker : null, // optional
limit : null, // optional
title : null // optional
};
hub.listStreams(options, function(err, marker, streams) {
streams.forEach(function(stream) {
console.log(stream);
// Log stream
// {
// "id":"z1.coding.35d7zfabe3bv5723280200c5",
// "createdAt":"2015-08-22T03:43:55.247Z",
// "updatedAt":"2015-08-22T03:43:55.247Z",
// "title":"35d7zfabe3bv5723280200c5",
// "hub":"coding",
// "publishKey":"f054e65199703b14",
// "publishSecurity":"dynamic",
// "disabled":false,
// "profiles":null,
// "hosts":
// {
// "publish":
// {
// "rtmp":"scv02k.publish.z1.pili.qiniup.com"
// },
// "live":
// {
// "http":"scv02k.live1-http.z1.pili.qiniucdn.com",
// "rtmp":"scv02k.live1-rtmp.z1.pili.qiniucdn.com"
// },
// "playback":
// {
// "http":"scv02k.playback1.z1.pili.qiniucdn.com"
// }
// }
// }
});
});
var result = stream.toJSONString();
console.log(result);
// {"id":"z1.coding.55d7f30ce3ba5723280000c5","createdAt":"2015-08-22T03:57:00.064Z","updatedAt":"2015-08-22T03:57:00.064Z","title":"55d7f30ce3ba5723280000c5","hub":"coding","publishKey":"131be2572c682413","publishSecurity":"dynamic","disabled":false,"profiles":null,"hosts":{"publish":{"rtmp":"scv02k.publish.z1.pili.qiniup.com"},"live":{"http":"scv02k.live1-http.z1.pili.qiniucdn.com","rtmp":"scv02k.live1-rtmp.z1.pili.qiniucdn.com"},"playback":{"http":"scv02k.playback1.z1.pili.qiniucdn.com"}}}
var options = {
publishKey : 'new_secret_words', // optional
publishSecrity : 'static', // optional, can be "dynamic" or "static"
disabled : false // optional, can be "true" of "false"
};
stream.update(options, function(err, stream) {
console.log(stream);
// Log stream
// {
// "id":"z1.coding.35d7zfabe3bv5723280200c5",
// "createdAt":"2015-08-22T03:43:55.247Z",
// "updatedAt":"2015-08-22T03:43:55.247Z",
// "title":"35d7zfabe3bv5723280200c5",
// "hub":"coding",
// "publishKey":"new_secret_words",
// "publishSecurity":"static",
// "disabled":false,
// "profiles":null,
// "hosts":
// {
// "publish":
// {
// "rtmp":"scv02k.publish.z1.pili.qiniup.com"
// },
// "live":
// {
// "http":"scv02k.live1-http.z1.pili.qiniucdn.com",
// "rtmp":"scv02k.live1-rtmp.z1.pili.qiniucdn.com"
// },
// "playback":
// {
// "http":"scv02k.playback1.z1.pili.qiniucdn.com"
// }
// }
// }
});
stream.disable(function(err, stream) {
console.log(stream.disabled);
// true
});
stream.enable(function(err, stream) {
console.log(stream.disabled);
// false
});
stream.status(function(err, status) {
if (!err) {
console.log(status);
// Log stream status
// {
// "addr": "222.73.202.226:2572",
// "startFrom": "2015-09-10T05:58:10.289+08:00",
// "status": "connected",
// "bytesPerSecond": 16870.200000000001,
// "framesPerSecond": {
// "audio": 42.200000000000003,
// "video": 14.733333333333333,
// "data": 0.066666666666666666
// }
// }
}
});
var publishUrl = stream.rtmpPublishUrl();
console.log(publishUrl);
// rtmp://scv02k.publish.z1.pili.qiniup.com/coding/55d7f934e3ba5723280000cb?key=new_secret_words
var urls = stream.rtmpLiveUrls();
console.log(urls);
// {
// 'ORIGIN': 'rtmp://scv02k.live1-rtmp.z1.pili.qiniucdn.com/coding/55d7f934e3ba5723280000cb'
// }
var urls = stream.hlsLiveUrls();
console.log(urls);
// {
// 'ORIGIN': 'http://scv02k.live1-http.z1.pili.qiniucdn.com/coding/55d7f934e3ba5723280000cb.m3u8'
// }
var urls = stream.httpFlvLiveUrls();
console.log(urls);
// {
// 'ORIGIN': 'http://scv02k.live1-http.z1.pili.qiniucdn.com/coding/55d7f934e3ba5723280000cb.flv'
// }
var options = {
startTime : null, // optional, in second, unix timestamp
endTime : null, // optional, in second, unix timestamp
limit : null // optional
};
stream.segments(options, function(err, segments) {
if (!err) {
console.log(segments);
// Log stream segments
// [
// {
// "start": 1440196065,
// "end": 1440196124
// },
// {
// "start": 1440198072,
// "end": 1440198092
// },
// ...
// ]
}
});
var start = 1440196065; // required, in second, unix timestamp
var end = 1440196105; // required, in second, unix timestamp
var urls = stream.hlsPlaybackUrls(start, end);
console.log(urls);
// {
// ORIGIN: 'http://scv02k.playback1.z1.pili.qiniucdn.com/coding/55d7fa0ee3ba5723280000cc.m3u8?start=1440196065&end=1440196105'
// }
var name = 'videoName.mp4'; // required
var start = 1440196065; // required, in second, unix timestamp
var end = 1440196105; // required, in second, unix timestamp
var format = 'mp4'; // optional
var options = {
notifyUrl : null, // optional
pipeline : null // optional
};
stream.saveAs(name, format, start, end, options, function(err, responseData) {
console.log(responseData);
// Log responseData
// {
// "url": "http://scv02k.media1.z1.pili.qiniucdn.com/recordings/z1.coding.55d7faf0e3ba5723280000cd/videoName.m3u8",
// "targetUrl": "http://scv02k.vod1.z1.pili.qiniucdn.com/recordings/z1.coding.55d7faf0e3ba5723280000cd/videoName.mp4",
// "persistentId": "z1.55d7a6e77823de5a49a8899b"
// }
});
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
var name = 'imageName.jpg'; // required
var format = 'jpg'; // required
var options = {
time : 1440196100, // optional, default as now, in second, unix timestamp
notifyUrl : null // optional
};
stream.snapshot(name, format, options, function(err, responseData) {
console.log(responseData);
// Log responseData
// {
// "targetUrl": "http://scv02k.static1.z1.pili.qiniucdn.com/snapshots/z1.coding.55d7faf0e3ba5723280000cd/imageName.jpg",
// "persistentId": "z1.55d7a6e77823de5a49a8899a"
// }
});
hub.deleteStream(streamId, function(err, data) {
console.log(data);
// null
});
Stream's hostsstartFrom in Stream statusClient to HubCredentialsdisabled field in StreamgetStreamStatus function in ClientFAQs
Pili Streaming Cloud Server-Side Library For NodeJS
The npm package pili receives a total of 9 weekly downloads. As such, pili popularity was classified as not popular.
We found that pili demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Socket CEO Feross Aboukhadijeh joins a16z partners to discuss how modern, sophisticated supply chain attacks require AI-driven defenses and explore the challenges and solutions in leveraging AI for threat detection early in the development life cycle.
Security News
NIST's new AI Risk Management Framework aims to enhance the security and reliability of generative AI systems and address the unique challenges of malicious AI exploits.
Security News
This episode of the Risky Biz podcast discusses how the rise of small open source packages and the shift towards individual maintainers makes the ecosystem more vulnerable to supply chain attacks.