CAYIN SDK v1.0

鎧應數位看板系統提供強大的軟體開發套件(SDK)，讓您能藉由HTTP為基礎的API，創造自己的管理工具。以下分為四主要部分說明：

• 啟用／停用CAYIN SDK
• CAYIN SDK的使用方式
• CAYIN SDK的功能
• 附錄：時區設定的城市清單

啟用／停用CAYIN SDK

登入CMS的管理畫面，然後前往“系統 > 服務 > SDK設定”頁。
CAYIN SDK提供三種模式：

1. 停用SDK
2. 啟用SDK但不使用認證金鑰(authentication key)
3. 啟用SDK並使用認證金鑰
   • 手動設定(預設：0000)
   • 系統隨機產生

注意
認證金鑰為4至64個英文字母與數字組成

回到頂端

CAYIN SDK的使用方式

SDK的使用方式為寄一個HTTP GET或POST要求至SMP或CMS的內部網頁伺服器。您可以使用幾乎任一種現代程式語言來撰寫程式寄送要求。若您希望先測試一下，最簡單的測試方式是開啟一個瀏覽器，然後在地址欄（Address bar）輸入該指令，來寄送一個HTTP GET要求。
以下為指令格式的範例：
http://ip/cysdk/?cmd1=value1&cmd2=value2

注意
上述“ip”是指SMP或CMS的IP位址(或網域名稱)。

API介面：

• 支援HTTP GET與POST兩種方法
• 一個指令可以包含多組屬性
• 以分號 ‘;’ 做分隔不同屬性
• 以冒號 ‘:’ 分隔不同屬性的數值
• 以“&”符號分隔不同指令
• 指令先進先執行

範例：以CySDK 指令設定螢幕解析度

http://ip/cysdk/?k=0000&dpyOutout=mode:distinct;rotate:left
&dpy1=output:HDMI1;size:1920x1080@60&dpy2=output:auto;size:1024x768

• 認證: k=0000 （若您選擇不啟動認證功能，則可以忽略此部分。）
• 指令 1: dpyOutput=mode:distinct;rotate:left
  • 屬性 1: mode:distinct
  • 屬性 2: rotate:left
• 指令 2: dpy1=output:HDMI1;size:1920x1080@60
  • 屬性 1: output:HDMI1
  • 屬性 2: size:1920x1080@60
• 指令 3: dpy2=output:auto;size:1024x768
  • 屬性 1: output:auto
  • 屬性 2: size:1024x768

指令執行結果

SMP/CMS會回傳HTTP狀態碼給用戶端或呼叫的程式。

• 成功：傳回狀態碼200 的空白網頁
• 失敗：傳回狀態碼500 (內部伺服器錯誤)

注意
更多關於HTTP狀態碼的相關資訊，請參閱Wiki網頁:http://en.wikipedia.org/wiki/List_of_HTTP_status_codes

回到頂端

CAYIN SDK的功能

CAYIN SDK能讓你操控下列功能：

1. 安全認證 (認證金鑰):

   執行碼	屬性	數值	敘述
   k		英文字母與數字	金鑰: 4 - 64 個英文字母與數字 管理介面: 系統->服務->SDK ->認證

2. 系統控制 (SMP與CMS):

   執行碼	屬性	數值	敘述
   sysRestart		0, 1	0: 無動作 1: 重新啟動播放器／伺服器

3. 顯示設定 (僅適用SMP):

   執行碼	屬性	數值	敘述
   dpyOutput	mode	single, clone, extended, distinct
   	pos	1, 2	顯示位置: 1: 上–下 2: 左–右 *僅供“延伸模式”使用
   dpy1 dpy2	output	Auto, VGA, DVI, HDMI	設定顯示輸出
   	size	WxH[i][@R]	設定螢幕解析度與更新頻率 W: 寬度 H: 高度 i: 交錯式掃描Interlace (選用) @R: 更新頻率 (選用) 例如: 1920x1080@auto
   	rotate	0, 1, 2	旋轉螢幕: 0: 沒有旋轉 (橫式) 1: 90度順時鐘旋轉 (垂直) 2: 90度逆時鐘旋轉 (垂直)
   dpyPwSave		on off	設定螢幕開關 on: 開啟螢幕 off: 關閉螢幕

4. 影音輸入設定 (僅適用SMP):

   執行碼	屬性	數值	敘述
   videoIn	src	internal, 1, 2	internal: 內建影像擷取卡 1, 2: 外接USB UVC設備
   	std	NTSC, PAL	影音標準
   	bri	0, 1, …, 100	亮度
   	con	0, 1, …, 100	對比
   	sat	0, 1, …, 100	飽和度Saturation
   	overScan	0, 1, …, 100	過度掃描Over scan

5. 聲音設定 (僅適用SMP):
   

   執行碼	屬性	數值	敘述
   sndOutput		analog digital	analog: Stereo out (phone jack或RCA) digital: HDMI數位音訊
   sound		0 – 100	僅適用類比輸出(analog output)

6. 時間設定 (SMP與CMS) :
   

   執行碼	屬性	數值	敘述
   timeSetting	date	YYYYMMDDhhmmss, YYYYMMDD, hhmmss	例如: 設定日期: 20150209 設定時間: 101530 設定日期與時間: 20150209101530
   	timezone	城市或地區名	有效的城市名稱請詳見附錄

7. 播放控制 (SMP):
   

   執行碼	屬性	數值	敘述
   play	skin	[Skin Name]	面板(Skin)名
   	program	[Program Name]	節目(Program)名
   	playlist	[Playlist Name]	播放清單名
   	centralctl	1	中央排程
   	display	1, 2	選擇於螢幕1或螢幕2播放 (僅適用SMP-6000 的分開模式)
   pbVo1Play pbVo2Play	src	file://file mms://url http://url rtb://[ip:]port rtp://ip:port src://local-all src://video-in src://usb-storage src://central-schedule
   	ratio	auto (預設), 4:3, 16:9
   	mute	0, 1
   	random	0, 1
   	display	1, 2	於螢幕1或螢幕2設定區塊 (僅適用SMP-6000 的分開模式)
   pbIm1Play pbIm2Play	src	file://file src://local-all src://usb-storage src://central-schedule
   	duration	1-999	每一張圖片顯示的時間長度
   	sequence	forward backward random	順序
   	scale_fit	0 1 (預設) 2	依顯示區塊縮放 0: 關閉功能 1: 依顯示區塊縮放(等比例) 2: 依顯示區塊縮放(不等比例)
   	transition_effect	0 1 2 3 4 … 255	0: 無效果(預設) 1: 向右擦去(舊名：從左至右) 2: 向左擦去(舊名：從右至左) 3: 向下擦去(舊名：從上至下) 4: 向上擦去(舊名：從下至上) … 255: 隨機 請參閱線上手冊查看過場效果的完整清單
   	display	1, 2	於螢幕1或螢幕2設定區塊 (僅適用SMP-6000 的分開模式)
   pbTk1Play pbTk2Play	src	text://file http://rss-feed rss://url src://file src://central-schedule
   	direction	1,2	1: 由左至右 2: 由右至左
   	font	[font name]
   	fsize	10 to 200
   	fcolor	[font color]	預設文字顏色: 0xFFFFFF 例如: 0x118A3F 前面“11”代表紅色的意思 中間“8A”代表綠色的意思 最後“3F”代表藍色的意思 所有數字使用十六進位值
   	bcolor	[background color]	預設的背景顏色: 0x000000 例如: 0x118A3F 前面“11”代表紅色的意思 中間“8A”代表綠色的意思 最後“3F”代表藍色的意思 所有數字使用十六進位值
   	seffect	1, 2, 3, 4	文字跑動效果 1: 靜止 2: 水平跑動 3: 由下往上 4: 由下往上＋水平跑動
   	speed	1, 2, 3, 4, 5, 6
   	pause	0, 0.5, 1, 1.5, 2, 2.5, 3	暫停
   	spacing	0, 0.25, 0.5, 1, 1.25, 1.5	行距
   	display	1, 2	於螢幕1或螢幕2設定區塊 (僅適用SMP-6000 的分開模式)
   pbHtm1Play pbHtm2Play pbHtm3Play	src	file://file http://url https://url twitter://user weather://id central-schedule
   	template	0, 1, … , 12	Twitter
   	title	[title]	Twitter
   	subject	[subject]	Twitter
   	size	250x75 285x170 550x230	天氣
   	fcolor	[foreground color]	天氣
   	bcolor	[background color]	天氣
   	effect	0, 1	天氣
   	units	0, 1	天氣
   	pause	0-9	天氣
   	icons	0, 1	天氣
   	display	1, 2	於螢幕1或螢幕2設定區塊 (僅適用SMP-6000 的分開模式)
   pbAttr	scrollbar	auto, hide
   	hwaccel	0, 1	0: 關, 1: 開
   	flashver	9, 11	Flash版本9或11
   	autoUpdate	1-999 disable

範例

1. 安全認證:
   用金鑰保護CAYIN SDK指令的執行
   http://<ip>/cysdk/?k=0123456789abcdef;play=skin:skin-1
   不用金鑰保護CAYIN SDK指令的執行
   http://<ip>/cysdk/?play=skin:skin-1
2. 系統控制:
   重新啟動系統
   http://<ip>/cysdk/?sysRestart=1
3. 顯示設定:
   設定顯示畫面為複製模式，顯示器1由HDMI輸出螢幕解析度為1920x1080i的訊號
   http://<ip>/cysdk/?dpyOutput=mode:clone&dpy1=output:HDMI;size:1920x1080i@60;rotate:0
4. 影音輸入設定:
   設定 Video-in訊號源為內部影音擷取卡，NTSC格式
   http://<ip>/cysdk/?videoIn=src:internal;std:NTSC;bri:50;con:50;sat:50;overScan:0
5. 聲音設定:
   改變聲音輸出為類比輸出
   http://<ip>/cysdk/?sndOutput=analog
6. 多媒體播放:
   將播放器改為播放面板 “skin-1”
   http://<ip>/cysdk/?play=skin:skin-1;display:1
   設定圖片區塊1播放存放於多媒體檔案夾(Media Folder)裡，指定資料夾裡的指定檔案
   http://<ip>/cysdk/?pbIm1Play=src:file://file1.jpg;src:file://folder/;duration:1
   設定文字跑馬燈區塊1播放RSS
   http://<ip>/cysdk/?pbTk1Play=rss://url;seffect:1
   設定HTML區塊1播放多媒體檔案夾(Media Folder)裡的一個檔案
   http://<ip>/cysdk/?pbHtm1Play=src:file://file1.html
   將Adobe Flash播放器的版本改為9
   http://<ip>/cysdk/?pbAttr=flashver:9

回到頂端

附錄：時區設定的城市清單

(GMT-12:00)	Eniwetok, Kwajalein
(GMT-11:00)	MidwayIsland, Samoa
(GMT-10:00)	Hawaii
(GMT-09:00)	Alaska
(GMT-08:00)	Pacific Time (US & Canada); Tijuana
(GMT-07:00)	Arizona
(GMT-07:00)	Mountain Time (US & Canada)
(GMT-06:00)	Central Time (US & Canada)
(GMT-06:00)	Mexico City, Tegucigalpa
(GMT-06:00)	Saskatchewan
(GMT-05:00)	Bogota, Lima, Quito
(GMT-05:00)	Eastern Time (US & Canada)
(GMT-05:00)	Indiana (East)
(GMT-04:00)	Atlantic Time (Canada)
(GMT-04:00)	Caracas, La Paz
(GMT-04:00)	Santiago
(GMT-03:30)	Newfoundland
(GMT-03:00)	Brasilia
(GMT-03:00)	Buenos Aires, Georgetown
(GMT-02:00)	Mid-Atlantic
(GMT-01:00)	Azores, Cape Verde Is.
(GMT)	Casablanca, Monrovia
(GMT)	Greenwich Mean Time: Dublin, Edinburgh, Lisbon, London
(GMT+01:00)	Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna
(GMT+01:00)	Belgrade, Bratislava, Budapest, Ljubljana, Prague
(GMT+01:00)	Brussels, Copenhagen, Madrid, Paris, Vilnius
(GMT+01:00)	Sarajevo, Skopje, Sofija, Warsaw, Zagreb
(GMT+02:00)	Athens, Istanbul, Minsk
(GMT+02:00)	Bucharest
(GMT+02:00)	Cairo
(GMT+02:00)	Harare, Pretoria
(GMT+02:00)	Helsinki, Riga, Tallinn
(GMT+02:00)	Israel
(GMT+03:00)	Baghdad, Kuwait, Riyadh
(GMT+03:00)	Moscow, St. Petersburg, Volgograd
(GMT+03:00)	Nairobi
(GMT+03:30)	Tehran
(GMT+04:00)	Abu Dhabi, Muscat
(GMT+04:00)	Baku, Tbilisi
(GMT+04:30)	Kabul
(GMT+05:00)	Eekaterinburg
(GMT+05:00)	Islamabad, Karachi, Tashkent
(GMT+05:30)	Bombay, Calcutta, Madras, New Delhi
(GMT+06:00)	Almaty, Dhaka
(GMT+06:00)	Colombo
(GMT+07:00)	Bangkok, Hanoi, Jakarta
(GMT+08:00)	Beijing, Chongqing, Hong Kong, Urumqi
(GMT+08:00)	Perth
(GMT+08:00)	Singapore
(GMT+08:00)	Taipei
(GMT+09:00)	Osaka, Sapporo, Tokyo
(GMT+09:00)	Seoul
(GMT+09:00)	Yakutsk
(GMT+09:30)	Adelaide
(GMT+09:30)	Darwin
(GMT+10:00)	Brisbane
(GMT+10:00)	Canberra, Melbourne, Sydney
(GMT+10:00)	Guam, Port Moresby
(GMT+10:00)	Hobart
(GMT+10:00)	Vladivostok
(GMT+11:00)	Magadan, Solomon Is., New Caledonia
(GMT+12:00)	Auckland, Wellington
(GMT+12:00)	Fiji, Kamchatka, Marshall Is.

範例:

http://<ip>/cysdk/?timeSetting=timezone:Eastern Time
http://<ip>/cysdk/?timeSetting=timezone:London
http://<ip>/cysdk/?timeSetting=timezone:Taipei

回到頂端