簡介

本文目的是介紹設備內短音頻的管理和使用方法，與短音頻有關的事件使用。最后介紹使用HTTP API觸發(fā)短音頻本地播放的實例。

適用設備

SIP2703x等型號V6以上固件版本

 

1  前言

短音頻(audio clips)是存儲在設備內部的音頻文件（MP3/WAV格式），可以通過Manager應用程序，網(wǎng)頁(HTTP)等方式上傳到設備，通過事件觸發(fā)。觸發(fā)后在本地揚聲器播放，也可以向網(wǎng)絡廣播音頻流。

觸發(fā)事件包括：

• HTTP命令

• SIP會話接通

• SIP會話中的dtmf鍵值（RFC2833,SIPINFO）

• GPIO(通用輸入輸出口)

短音頻經(jīng)常用在重復性的音頻告警，警示，提示應用。

本文目的是介紹設備內短音頻的使用和管理的方法，與短音頻有關的事件使用。最后介紹使用HTTP API觸發(fā)短音頻本地播放的實例。

相關文檔

《使用Manager應用程序發(fā)現(xiàn)和配置設備參數(shù)》

《使用SIP呼叫和DTMF觸發(fā)短音頻文件播放》

《使用設備的GPIO觸發(fā)短音頻文件播放》

 

2 名詞

HTTP:超文本傳輸協(xié)議，瀏覽器使用此協(xié)議訪問web服務。

SIP（Session initialization Protocol）:會話初始協(xié)議，用于創(chuàng)建，修改和結束會話。

DTMF:傳統(tǒng)電話的雙音頻信號，在本文中指在SIP會話中發(fā)出的按鍵信息,使用SIPINFO/RFC2833協(xié)議。

GPIO:通用輸入輸出，通常指模塊上的引腳或設備上的輸入/輸出端點。

CLIP：短音頻，指存儲在設備內部的音頻文件，推薦使用mp3格式。

x-lite：一種軟電話軟件。

minisipserver：一種sip服務器軟件(https://www.myvoipapp.com)

Manager：我司開發(fā)的windows設備發(fā)現(xiàn)和配置應用程序(m.dislect.com)

chrome：谷歌瀏覽器。

 

3 短音頻

設備可以存儲多個短音頻（存儲數(shù)量由內部存儲容量決定，從幾MByte~幾百Mbyte不等，由設備型號決定）

 部分設備（例如SIP2xxx型號）內所能存儲的短音頻文件數(shù)量是需要設置的，受存儲容量限制，調整文件數(shù)量同時會改變短音頻的最大文件長度。

警告：調整文件數(shù)量會格式化內部存儲器，會導致所有的短音頻損壞，需要重新上傳。

以下操作使用chrome瀏覽器訪問設備web服務。在這之前，請先設置好設備的IP地址，以使設備可以正常網(wǎng)絡通訊。請參考《使用Manager應用程序發(fā)現(xiàn)和配置設備參數(shù)》了解相關操作。

 

3.1  設置短音頻數(shù)量

在chrome地址欄輸入設備ip地址，打開“more/Audio Clip”頁。

修改Max capacities為所需的數(shù)量，點擊“Set”完成設置。

 

        

提示： 建議使用mp3文件，對于128kbps比特流的mp3文件，1Mbyte大約能播放1分鐘。如果是64kbps文件，大概能播放2分鐘。使用者需要根據(jù)自己的需求調整文件數(shù)量和大小。

注：有些設備的存儲容量比較大，則不需要設置此項。

 

3.2上傳

將音頻文件上傳到設備。

在audio clip頁面，點擊add clip按鈕，在彈出的文件打開對話框選擇音頻文件，支持mp3和wav文件（建議使用mp3文件）

上傳后的短音頻，系統(tǒng)自動給一個從1開始的ID號，后續(xù)使用短音頻，使用此ID。

 

 

提示 如果上次的文件超過max size，文件被截斷，超過部分不會保存。 wav文件僅支持單/雙聲道，pcm編碼，16bits數(shù)據(jù)的文件類型。

        

 

3.3更新

用新的短音頻文件覆蓋原來的文件。

在3.2小節(jié)界面，點擊clip條目后面的更新按鈕，在彈出的文件打開對話框選擇新的音頻文件。

 

3.4刪除

刪除不需要的短音頻文件

在3.2小節(jié)界面，點擊clip條目后面的刪除按鈕，進行刪除。

 

3.5測試

測試設備內的短音頻是否可正常使用，通過下載到電腦和設備播放的方式測試。

3.5.1在電腦上播放

在3.2小節(jié)界面，點擊clip條目前面的，瀏覽器下載音頻文件并在電腦端播放。

3.5.2在設備端播放

在3.2小節(jié)界面，點擊clip條目后面的，可將鏈接地址復制到粘貼板。然后打開瀏覽器新頁面，在地址欄選擇粘貼，將剛才的鏈接地址輸入到地址欄，Enter確認。正常設備回應{“result”:200}并在設備端播放音頻文件。如果回應不是200，可能設備正在忙，無法播放短音頻。

如下圖示例：

 

 

4 事件

事件通常與短音頻關聯(lián)，當事件發(fā)生后，就會播放指定的短音頻。

 

4.1設備支持的事件

類別	值	active	說明
dtmf	dtmf值串	clip play and hang up	[注1]
		clip play and talk	[注2]
status change	Answer	clip play and hang up	[注3]
		clip play and talk	[注4]
http request		clip play	播放clip[注5]
		clip stop	停止clip
gpio		clip play/stop	[注6]

注1：會話接通后，遠端向設備發(fā)送dtmf串值。設備收到指定的dtmf串后，播放指定的clip，播放結束后掛機。

注2：觸發(fā)事件后播放clip，播放結束后繼續(xù)通話。

注3：Answer事件為會話接通事件，會話接通后立即觸發(fā)。文件播放結束后自動掛機。

注4：會話接通后立即觸發(fā)事件，播放結束會繼續(xù)通話。

注5：http request僅生成一個http請求鏈接，需要在瀏覽器使用這個鏈接才能觸發(fā)事件。

注6：gpio對應模塊的C1/C2引腳，需要通過Manager配置，詳細請參考相關文檔說明。

4.2事件動作參數(shù)

參數(shù)	說明
clip	與事件相關的短音頻的ID號
volume	本地播放音量，0~100
repeat	重復播放次數(shù)
then session over	播放clip時，發(fā)生觸發(fā)條件變?yōu)闊o效，如何影響播放。continue繼續(xù)播放。stop立即結束播放。 對于dtmf和answer，會話結束表示觸發(fā)條件無效。 對于IN類型， IN輸入變?yōu)闊o效狀態(tài)表示觸發(fā)條件無效。

 

4.3向設備添加事件

在瀏覽器的Events頁面，點擊“Add event”

 

 

彈出編輯窗口，編輯event的各項參數(shù)，如下圖。

 

 

添加動作完成后，需要點擊save按鈕保存才是生效。

 

5 示例

5.1通過HTTP API觸發(fā)短音頻

此示例以SIP2703V+SIP2703Demo板為例，演示如何通過HTTP API觸發(fā)短音頻在本地播放。

5.1.1 準備

系統(tǒng)圖

 

材料

·SIP2703V模塊

·SIP2703DEMO板

·喇叭（4~8歐姆）

·測試用計算機

·網(wǎng)線

·DC12~24@1A電源，用于Demo板供電。

準備

SIP2703V模塊接到DEMO板上，給DEMO板通電，

用網(wǎng)線連接計算機與DEMO板

參考《使用Manager應用程序發(fā)現(xiàn)和配置設備參數(shù)》使用Manager工具發(fā)現(xiàn)和配置SIP2703V的網(wǎng)絡參數(shù)，使SIP2703V可被訪問（通常使用控制臺的“ping ip地址”命令測試）。

此例中，

計算機的IP地址為192.168.3.199/255.255.255.0

SIP2703V IP地址為192.168.3.11/255.255.255.0

DEMO板有2 x 15W功放輸出，可直接驅動4歐姆揚聲器。

 

5.1.2 上傳短音頻

參考第三節(jié)，將一個或數(shù)個短音頻，通過瀏覽器上傳到設備。

打開瀏覽器，在地址欄輸入192.168.3.11，瀏覽器彈出登錄窗口，輸入設備的賬號密碼（默認空密碼，直接點“Sign in”登錄）

 

        

 

登錄成功后，進入More/AudioClip頁面，這里先設置短音頻的存儲模式，將Max capacity 設置為12，表示最多存放12組短音頻。Max size是只讀項，顯示1024K，表示最大的短音頻是1024K字節(jié)。

 

 

注意：在后續(xù)的上傳文件中，注意文件長度不要超過1024K，否則將會被截斷。

接下來點擊Add clip按鈕，在彈出的打開文件窗口選擇需要上傳的音頻文件（mp3/wav文件）上傳短音頻。如果上傳成功，顯示information窗口

 

 

5.1.3 測試

點擊clip列表的圖標，瀏覽器生成一個鏈接并復制到粘貼板。內容

http://192.168.3.11/clip/clip.cgi?action=play&id=1&volume=90&repeat=1

打開瀏覽器新頁面，地址欄為輸入焦點，ctrl+v，將鏈接粘貼到新的頁面，回車執(zhí)行。

 如果SIP2703V設置賬號保護，會彈出窗口

 

 

需要在此輸入設備的賬號信息，點擊登錄。

則在揚聲器播放剛才上傳的音樂文件。

 

5.2會話中，通過dtmf觸發(fā)播放短音頻

5.2.1準備工作

需要被測試的網(wǎng)絡音頻設備和一臺windows操作系統(tǒng)計算機，一臺網(wǎng)絡交換機，網(wǎng)線若干。

準備好后，設備上電，接入計算機網(wǎng)絡，確保計算機與設備處于同一局域網(wǎng)。

啟動計算機的命令窗口（WIN+R彈出的窗口輸入cmd），

在命令提示符窗口輸入“ipconfig /all”

 

 

找到計算機使用的IPv4地址和子網(wǎng)掩碼（上圖的192.168.3.199和255.255.255.0）

在計算機上運行Manager，發(fā)現(xiàn)設備。

 

        

雙擊設備條目，在彈出的窗口進入基本參數(shù)（base parameter）頁修改設備的IP地址和子網(wǎng)掩碼，分配一個未被使用的IP地址。并使之與計算機同一網(wǎng)絡（這里修改為192.168.3.21/255.255.255.0）。如果設備有密碼保護，在修改參數(shù)時需要提供賬號密碼（默認為admin:1234或空賬號密碼）

留意http port參數(shù)，默認80。如果不是80，在后續(xù)使用瀏覽器訪問設備時需要額外提供端口號（假設端口號為8080，則瀏覽器的地址是“http://192.168.3.21:8080”）。

 

        

 

        

在命令提示符窗口輸入“ping 192.168.3.21”，測試ping命令。

        

        

收到回應幀表示測試通過。

 

5.2.2添加短音頻

打開瀏覽器，這里使用chrome，在地址欄輸入192.168.3.21，出現(xiàn)web登錄窗口

 

 

輸入賬號密碼登錄web服務。（如果是空密碼，直接點擊sign in按鈕）

進入web服務后，切換到More/Audio Clip頁面。

點擊Add clip按鈕上傳短音頻。下圖為上傳短音頻后的截圖。

 

 

5.2.3添加事件

在web服務器進入More/Events頁面，通過“Add event”按鈕打開添加事件窗口，填入事件參數(shù)，如下圖。

 

 

點擊“Confirm”保存，退出編輯后，點擊“Save”保存事件。然后點擊Log out，使設備應用新的事件設定。

上圖編輯的事件，在sip會話接通后，使用鍵盤依次輸入123，觸發(fā)設備播放bbg30.mp3文件，音量=85，播放1次結束。文件播放結束后繼續(xù)通話。如果在播放文件時，掛機，則設備繼續(xù)播放文件，播放完后自動掛機。

 

5.2.4設置設備sip賬號

在web頁面中，進入Sip Setting/Account 頁面，填入sip服務器和賬號信息。

 

 

選中“Use sip server”

User account：1001

password：2345

server address：192.168.3.199（在測試計算機上運行minisipserver，故填測試計算機ip地址）

server port：5060 （sip默認端口）

接著進入“sip setting/intercom”頁面，設置會話codec，選中所有的編碼格式如下圖。

將auto answer time設置為3秒，（自動接通延時）

 

 

5.2.5啟動和配置sip server

在計算機上運行minisipserver

點擊工具欄按鈕”Local users”，彈出窗口點擊“Add，添加用戶窗口添加用戶。

user name:1001

user password:2345

(user name 和user password 需要與5.1.4小節(jié)的User account和password相同。)

 

 

用同樣的方法，添加一個賬號用于x-lite軟電話。

user name:1010

user password:2345

5.2.6運行x-lite軟電話

運行x-lite，點擊抬頭的，進入SIP account settings…對話框，添加賬號信息。

 

 

在賬號對話框輸入賬號：1010，密碼2345，點擊應用，退出設置。

如果設置都正確，可以在minisipserver的對話框看到1001和1010都登錄到sip服務器了。

如下圖所示，

 

 

賬號前面的頭像變成藍色，表示成功登錄，我們可以進行下一步測試。

 

5.2.7測試

a，在x-lite上，依次點擊1001，點擊呼叫設備。

b，會話接通后，依次點擊x-lite鍵盤1，2，3鍵，設備就會播放bbg30.mp3，

c，設備會將當前播放的音頻，送回x-lite進行播放。

d，音頻結束后繼續(xù)通話。

e，你還可以再次輸入123，設備會再次播放一次bbg30.mp3。

f，掛機，結束測試。

 

5.3 接通會話立即觸發(fā)短音頻

5.3.1 準備工作

參考5.1.1準備工作和5.1.2添加短音頻

5.3.2 添加事件

在web服務器進入More/Events頁面，通過“Add event”按鈕打開添加事件窗口，填入事件參數(shù)，如下圖。

        

 

點擊“Confirm”保存，退出編輯后，點擊“Save”保存事件。然后點擊Log out，使設備應用新的事件設定。

上圖編輯的事件，在sip會話接通后，立即觸發(fā)設備播放bbg30.mp3文件，音量=85，播放1次結束。如果在播放文件時，掛機，則設備立即停止播放，并掛機。

 

5.3.3 設備參數(shù)及SIP環(huán)境配置

參考5.1.4，5.1.5，5.1.6小節(jié)

 

5.3.4 測試

a，在x-lite上，依次點擊1001，點擊呼叫設備。

b，會話接通后，設備就會播放bbg30.mp3，

c，設備會將當前播放的音頻，送回x-lite進行播放。

d，x-lite掛機，設備停止播放。

e，結束測試。

 

文檔下載：設備內的短音頻及其應用