HTML5微信網(wǎng)頁(yè)調(diào)用監(jiān)控直播代碼接口文檔v4.0.171116
更新說(shuō)明
調(diào)用示例
//將以下代碼嵌入到需要調(diào)用視頻的HTML頁(yè)面 <script src="js/jquery.min.js?v=3.1.0" type="text/javascript" charset="utf-8"></script> <script src="js/jq.getVideo.min.js?v=4.0.171116" type="text/javascript" charset="utf-8"></script> <!--視頻直播容器--> <div id="yst-video-box" class="video-box"></div> <script type='text/javascript'> +(function($) { $('#yst-video-box').getVideo({ //調(diào)用參數(shù):按需增加,可以為空或使用默認(rèn)值,可以通過(guò)URL,JSON傳參 user: 'demo', //默認(rèn)用戶名 dev: 'ads-xxxxx' //攝像頭序列號(hào)或者對(duì)應(yīng)的ID值 }); })(jQuery); </script>
參數(shù)說(shuō)明
參數(shù)獲取優(yōu)先級(jí):登錄時(shí)的參數(shù) > post參數(shù) > url傳參 > data屬性 > js傳參 > js缺省值。所有參數(shù)均可省略,省略時(shí)將按優(yōu)先級(jí)順序獲取,直至缺省值;
//post獲取參數(shù) geturl: '', //get/post提交的url,為空則從url/data/js獲取視頻參數(shù) getdata: {}, //get/post提交的參數(shù)(json串) //視頻參數(shù) code: 0, //視頻傳輸協(xié)議:0=監(jiān)控私有協(xié)議,1=直播rtmp協(xié)議,2=直播hls協(xié)議 ip: 'xxx.com', //默認(rèn)服務(wù)器,可以是域名或IP地址 port: '', //默認(rèn)端口號(hào),為空則根據(jù)傳輸協(xié)議自動(dòng)采用默認(rèn)的端口號(hào) user: '', //默認(rèn)用戶名,rtmp=livestreamname(自定義的實(shí)例名) password: '', //默認(rèn)密碼,rtmp=liveapp(默認(rèn)live) dev: '', //設(shè)備ID(值為數(shù)字時(shí))/設(shè)備sn(值為字符串時(shí)),空或0表示獲取第1臺(tái)設(shè)備, src: '', //視頻播放地址,如果有定義則直接調(diào)用src而忽略ip,user等參數(shù) autostart: true, //當(dāng)用戶登錄后所有設(shè)備自動(dòng)開(kāi)啟切片,優(yōu)化HLS播放體驗(yàn),flash方式時(shí)忽略此參數(shù) //播放器參數(shù) player: 0, //播放器:默認(rèn)自動(dòng)適應(yīng),1=flash播放(PC),2=html5播放(移動(dòng)端 ) swfPath: 'js/', //播放器路徑,player=1時(shí)(flash播放時(shí))調(diào)用 res: 1, //分辨率:默認(rèn)1=輔碼流,0=主碼流,僅針對(duì)flash播放有效 ratio: '0', //視頻高/寬比例:小數(shù)0.75或9/16,空或0時(shí)不指定比例,占滿整個(gè)播放容器 auto: 1, //是否自動(dòng)播放 //delay: 2000, //延時(shí)播放時(shí)間,待生成切片文件/或廣告后再播放 //duration: 0, //連續(xù)播放時(shí)間限制,達(dá)到指定的時(shí)間后切斷視頻源,0表示不限制,暫未限制 //其它參數(shù) control: 0, //是否顯示視頻控制按鈕 list: 1, //是否顯示播放列表,當(dāng)前登錄賬號(hào)下有多個(gè)可用視頻且為HTML5播放時(shí)顯示 tips: 0, //是否開(kāi)啟提示 logs: 0 //是否開(kāi)啟日志
url傳參
示例1: http://xxx.com?user=demo&dev=48
示例1直接通過(guò)瀏覽器傳遞監(jiān)控直播視頻的參數(shù)(不推薦);
data屬性傳參
通過(guò)播放容器的data-xxx屬性傳參給js
<div id="video1" class="video-box" data-ip="xxx.com" data-user="demo" ></div>
js傳參
$('#video1').getVideo({ ip: 'xxx.com', //默認(rèn)服務(wù)器地址 user: 'demo', //默認(rèn)用戶名 password: '', //默認(rèn)密碼 dev: 'sn01', //設(shè)備號(hào)/實(shí)例名,空或0表示獲取第1臺(tái)設(shè)備 });
json返回參數(shù)
通過(guò)json獲取視頻參數(shù)(傳入了geturl的參數(shù)),jsonp服務(wù)器端實(shí)例:
<?php $callback = $_REQUEST['callback']; $vid = $_REQUEST['vid']; //自定義視頻參數(shù)數(shù)組項(xiàng),可從服務(wù)器數(shù)據(jù)庫(kù)獲取 $data_array = array( array( 'vid' => '4', 'ip' => 'xxx.cn', 'user' => 'demo1', 'password' => '123456', ), array( 'vid' => '5', 'ip' => 'xxx.com', 'user' => 'demo2', 'password' => '', ), array( 'vid' => '6', 'ip' => 'xxx.com', 'user' => 'demo3', ) ); //查詢匹配的數(shù)組 foreach ($data_array as $data) { if ($vid==$data['vid']){ $output=$data; break; } } //輸出JSON if ($callback) { header('Content-Type: text/javascript'); echo $callback . '(' . json_encode($output) . ');'; } else { header('Content-Type: application/x-json'); echo json_encode($output); //{"ip":"xxx.com","port":"2005","user":"demo","password":"","dev":""} } ?>
本文檔為監(jiān)控視頻的調(diào)用接口說(shuō)明,適用于微信監(jiān)控直播調(diào)用、HTML5網(wǎng)頁(yè)監(jiān)控直播調(diào)用,使用本文檔前請(qǐng)確定有使用我司的服務(wù),包括租用平臺(tái)服務(wù)或購(gòu)買過(guò)服務(wù)器軟件。