CAYIN SDK v2.0

CAYIN SDK v2.0

CAYINデジタルサイネージシステムは、HTTPベースのAPIを使用して独自の管理ツールを作成できる強力なソフトウェア開発キット（SDK）を提供しています。 これを大きく4つに分けて解説します：

CAYIN SDKの有効化／無効化

Files & Folders

CMSの管理画面にログインし、システム > サービス > SDK設定のページに移動してください。
CAYIN SDKには3つのモードがあります：

  1. SDKを無効にする
  2. 認証キーを使用せずにSDKを有効化する(authentication key)
  3. SDKを有効化し、認証キーを使用する
    • 手動で認証キーを入力
    • ランダムを選択し、システムからランダムに鍵が生成されます。 (キーは保存してお使いください）
注意事項

認証キーは、4～64文字の英数字で構成されます
ページのトップへ戻る

CAYIN SDKの使用方法

SMPやCMSの内部ウェブサーバにHTTP GET/POSTリクエストを送信して、SDKを利用します。 リクエストは、ほとんどのプログラミング言語で書くことができます。 まずテストしたい場合は、ブラウザを開いてアドレスバー（Address bar）にコマンドを入力し、HTTP GETリクエストを送るのが最も簡単な方法です。
以下はコマンドフォーマットの例です：

http://<ip>/cysdk/?cmd1=value1&cmd2=value2

または

http://<ip>/cysdk/?cmd1=attribute1:value1;attribute2:value2

注意事項

上記のipは、SMPまたはCMSのIPアドレス（またはドメイン名）を指します。

APIインターフェース：

  • HTTP GET、POSTの両メソッドに対応しています
  • コマンドは複数の属性を含むことができます
  • 属性はセミコロン ‘;’ で区切ってください。
  • コロン ‘:’ で属性名と属性値を区切ります。
  • 各コマンドは ‘&’ で区切ってください
  • コマンドが最初に実行される

例：CySDKのコマンドで画面解像度を設定する場合

http://<ip>/cysdk/?k=0000&dpyOutput=mode:distinct;rotate:left
&dpy1Setting=output:HDMI1;size:1920x1080@60&dpy2Setting=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

コマンド実行結果

機能1～8：

SMP/CMSは、クライアントまたは呼び出し元のプログラムに対しHTTPステータスコードを返します。

  • 成功：ステータスコード200の空白ページが送られます
  • 失敗：ステータスコード500が送られます（内部サーバーエラー）
注意事項

HTTPステータスコードの詳細については、Wikiページをご参照ください：https://en.wikipedia.org/wiki/List_of_HTTP_status_codes

機能9〜28：

コマンドのレスポンスはすべてjson形式でHTTP Bodyに格納され、jsonリポジトリを使ってデコードしたり、実行結果をさらに処理したりするのに利用できます。


ページのトップへ戻る

CAYIN SDKの機能

CAYIN SDK では、以下の機能を制御することができます：

  1. セキュリティ認証（認証キー）

    2. 実行コード 属性 数値 說明
    k   アルファベットと数字
    • キー：4〜64アルファベット、数字
    • 管理画面：システム->サービス->SDK ->認証

    例

    CAYIN SDKのコマンドの実行をキーで保護する。
    http://<ip>/cysdk/?k=0123456789abcdef&play=skin:skin-1
    CAYIN SDKのコマンドをキーなしで実行できるようにする。
    http://<ip>/cysdk/?play=skin:skin-1

  2. システム制御（SMP、CMS）

    3. 実行コード 属性 数値 說明
    sysRestart   0, 1
    		 0: 動作なし
    1: プレイヤー/サーバーを再起動する

    例

    システムの再起動
    http://<ip>/cysdk/?sysRestart=1

  3. ディスプレイの設定（SMPのみ）

    4. 実行コード 属性 数値 說明
    dpyOutput mode single, clone, extended, distinct
    		  
    model1
    model2
    model3
    model4    		 1x1, 2x2, 2x1, 1x2, 3x1, 1x3, 4x1, 1x4 SMP-2100/2200/2300
    エクステンドモード：1x2, 2x1
    セパレートモード：1x1
    SMP-2210/2310
    エクステンドモード：1x3, 3x1, 1x2, 2x1
    セパレートモード：1x1, 2x1, 1x2
    SMP-8000/8000QD
    エクステンドモード：2x2, 1x4, 4x1, 1x3, 3x1, 1x2, 2x1
    セパレートモード： x1, 2x1, 1x2, 3x1, 1x3

    dpy1

    dpy2    		 output Auto, VGA, DVI, HDMI1, HDMI2, DP1, DP2, DP3, DP4

    ディスプレイ出力の設定

    VGA, DVI, HDMI (SMP-6000)
    HDMI1 and HDMI2 (SMP-2100, SMP-2200系列, SMP-2300系列)
    DP1 ~ DP4 (SMP-8000系列)
    size WxH[i][@R] 画面解像度、更新頻度の設定
    W：幅
    H：高さ
    i：インターレース（オプション）
    @R：更新頻度（オプション）
    例：1920x1080@auto
    rotate 0, 1, 2 画面を回転させる：
    0: 回転なし（水平）
    1: 時計回りに90度回転（垂直）
    2: 反時計回りに90度回転（垂直）
    dpyPwSave  

    on

    off    		 画面のオン／オフを設定する
    on: 画面をオンにする
    off: 画面をオフにする

    例

    ディスプレイをコピーモードにし、ディスプレイ1をHDMIから画面解像度1920x1080iで出力するように設定する

    http://<ip>/cysdk/?dpyOutput=mode:clone&dpy1=output:HDMI;size:1920x1080i@60;rotate:0

  4. オーディオ/ビデオ入力の設定（SMPのみ）

    5. 実行コード 属性 数値 說明
    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

    例

    Video-inソースを内蔵AVキャプチャカードに設定、NTSCフォーマット。

    http://<ip>/cysdk/?videoIn=src:internal;std:NTSC;bri:50;con:50;sat:50;overScan:0

  5. サウンド設定（SMPのみ）

    6. 実行コード 属性 数値 說明
    sndOutput   analog
    digital    		 analog: Stereo out (phone jack或RCA)
    digital: HDMIデジタルオーディオ
    sound   0 – 100 アナログ出力(analog output)のみ適用

    例

    音声出力をアナログ出力に変更する
    http://<ip>/cysdk/?sndOutput=analog

  6. 時間設定（SMP、CMS）

    7. 実行コード 属性 数値 說明
    timeSetting date YYYYMMDDhhmmss,
    YYYYMMDD,
    hhmmss    		 例:
    日付の設定：20150209
    時間の設定：101530
    日時の設定：20150209101530
    timezone 都市名または地域名 有効な都市名については、付録をご参照ください

    例

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

  7. 再生制御（SMPのみ適用）

    8. 実行コード 属性 数値 說明
    play skin [Skin Name] スキン（Skin）名
    program [Program Name] プログラム（Program)名
    playlist [Playlist Name] プレイリスト名
    centralctl 1 セントラルスケジュール
    display 1, 2 画面1、画面2のどちらで再生するかを選択
    pbVo1Play
    pbVo2Play    		 src file://file
    mms://url
    http://url
    rtb://ip:port
    rtp://ip:port
    src://local-all
    src://video-in
    src://central-schedule    		  
    ratio auto (デフォルト), 4:3, 16:9  
    mute 0, 1  
    random 0, 1  
    display 1, 2 画面1または画面2にゾーンを設定する
    pbIm1Play
    pbIm2Play    		 src file://file
    src://local-all
    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にゾーンを設定する
    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 800  
    fcolor [font color] デフォルトのテキストカラー： 0xFFFFFF
    例： x118A3F
    • 最初の“11”は赤を意味する
    • 中段の “8A”は緑を意味する
    • 最後の“3F”は青を意味する
    数値はすべて16進数値
    bcolor [background color] デフォルトの背景色：0x000000
    例：0x118A3F
    • 最初の“11”は赤を意味する
    • 中段の“8A”は緑を意味する
    • 最後の“3F”は青を意味する
    数値はすべて16進数値
    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にゾーンを設定する
    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
    550x320
    760x500
    1000x650    		 天気
    fcolor [foreground color] 天気
    デフォルトのテキストカラー： 0xFFFFFF
    例： x118A3F
    • 最初の“11”は赤を意味する
    • 中段の “8A”は緑を意味する
    • 最後の“3F”は青を意味する
    数値はすべて16進数値
    bcolor [background color] 天気
    デフォルトの背景色：0x000000
    例：0x118A3F
    • 最初の“11”は赤を意味する
    • 中段の“8A”は緑を意味する
    • 最後の“3F”は青を意味する
    数値はすべて16進数値
    effect 0, 1 天気
    units 0, 1 天気
    0: 摂氏 (℃)、1: 華氏 (℉)
    pause 0-9 天気
    icons 0, 1 天気
    display 1, 2 画面1または画面2にゾーンを設定する
    pbAttr scrollbar auto, hide  
    hwaccel 0, 1 0: Opengl、1: Vaapi/Vdpau
    autoUpdate 1-999
    disable    		 HTMLファイル/リモートURLの時間間隔を確認する

    例

    プレーヤーをスキンskin-1に変更する
    http://<ip>/cysdk/?play=skin:skin-1;display:1
    指定されたフォルダのメディアフォルダ(Media Folder)内にある指定されたファイルを再生するように画像ゾーン1を設定する
    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

  8. RTB設定（CMSのみ適用）

    9. 実行コード 属性 数値 說明
    rtb channel 1, 2 入力ポート
    active enable
    disable    		  
    port UDP port number 8100, 8102, ..., 8226
    input composite
    s-video    		  
    std NTSC, PAL  
    bri 0,1…,100  
    con 0,1…,100  
    sat 0,1…,100  
    format mpeg2, mpeg4  
    bit 256k, 512k, 1M, 2M, 3M,  4M, 5M  
    bocast 1/enable
    0/disable    		 1：有効化
    0：閉じる
    mtcast ip, disable Multicast
    uncast ip, enable, disable Unicast

    例

    チャンネル1をMPEG-4@512kbpsの出力周波数として、192.168.1.2へのライブビデオとオーディオのユニキャスト配信に有効化する。
    http://<ip>/cysdk/?rtb=channel:1;active:enable;input:composite;format:mpeg4;bit:512k;uncast:192.168.1.2

  9. ログイン/ログアウトコマンド（CMSのみ）

    10. 指令 認証
    (非必須)    		 属性 数値 說明
    login k=your_authencation_key user [User name] 特定のユーザーでログインする
    pass [Password]
    結果 Body 說明

    {
    "result":"0",
    "session":"1038858172"
    }

    		結果:
    0：成功
    その他：失敗

    例

    http://CMS_IP/cysdk/?k=UXWdFUURPmLbF&login=user:administrator;pass:admin


    指令 認証
    (非必須)    		 属性 数値 說明
    logout k=your_authencation_key session [Session id] Logout
    結果 Body 說明

    N/A

    		  

    例

    http://CMS_IP/cysdk/?k=UXWdFUURPmLbF &logout=session:session-id

    注意事項

    ログイン（login）コマンドでセッションID（session id）を取得し、その後のSDKコマンド（第10～28項）で使用します。

  10. SMPリストの読み込み（CMSのみ適用）

    11. 指令 認証
    (非必須)    		 属性 数値 說明
    query k=your_authencation_key get smplist CMSサーバーに接続されているSMPプレーヤーのリストを読み込む
    結果 Body 說明
    {
    "result":"string",
    "client":[
    {
    "hostname":"string",
    "model":"string",
    "version":"string",
    "IP":"string",
    "mac":"string",
    "group":"string",
    "cms":"string",
    "connect":"string"
    },
    {client2….}, {client3….}
    ]
    }
    		 結果:
    0：成功
    その他：失敗

    例

    検索 http://CMS_IP/cysdk/?k=UXWdFUURPmLbF&session=session_id&query=get:smplist;
    レスポンス {
    "Result":"0",
    "client":[
    {
    "hostname":"1F-001",
    "model":"SMP-2100",
    "version":"2.1",
    "group":"groupA",
    "connect":"1",
    "IP":"10.0.0.10",
    "mac":"00:30:18:CD:10:01",
    "cms":"hostname"
    },
    {
    "hostname":"1F-002",
    "model":"SMP-2100",
    "version":"2.1",
    "group":"groupA",
    "connect":"1",
    "IP":"10.0.0.11",
    "mac":"00:30:18:CD:10:02",
    "cms":"hostname"
    },
    {client3….},
    {client4…},
    {client5…}
    ]
    }

  11. CMS/SMPのログファイルを読み込む（CMSのみ適用）

    12. 指令 認証
    (非必須)    		 属性 数値 說明
    query k=your_authencation_key get log  
    target mac_address

    SMPまたはCMSのMACアドレス
    retrivefrom YYYYMMDDhhmmss 例：日付20170629120000からのログファイル（非必須）
    結果 Body 說明

    {
    "result":"string",
    "logs":[
    {
    "time":"string",
    "type":"string",
    "category":"string",
    "msg":"string",
    }
    {log2….}, {log3….}
    ]
    }

    		 結果:
    0：成功
    その他：失敗

    例

    検索 http://CMS_IP/cysdk/?k=UXWdFUURPmLbF&session=session_id&query=get:log;
    target:4C02890A25C7;retrivefrom:20170629120000
    レスポンス {
    "Result":"0",
    "logs":[
    {
    "time":"Mon Jun 26 15:33:44 2017",
    "type":"INFORMATION",
    "category":"SYSTEM",
    "msg":"[SMP-2100]: SYSTEM: System start up."
    },
    {log2….}, { log3….}
    ]
    }

  12. SMPハードディスクの状態（CPU使用率など）を読み取る（CMSのみ適用）

    13. 指令 認証
    (非必須)    		 属性 数値 說明
    query k=your_authencation_key get hwinfo  
    target mac_address SMPまたはCMSのMACアドレス
    結果 Body 說明
    {
    "result":"string",
    "client":{
    "cpu":{"usage": "string", "temp": INT, "fan": INT},
    "mem":{"total": "string", "used": "string", "usage": "string"},
    "disk":{
    "system":["string", "string", "string"],
    "resource":["string", "string", "string"],
    "media":["string", "string", "string"],
    "external": ["string", "string", "string"]
    },
    "sys":{"temp":INT, "fan":INT}
    }
    }
    		 結果:
    0：成功
    その他：失敗

    例

    検索 http://CMS_IP/cysdk/?k=UXWdFUURPmLbF&session=session_id&query=get:hwinfo;
    target:4C02890A25C7
    レスポンス {
    "result":"0",
    "client":{
    "cpu":{"usage":"0.7%", "temp":-1, "fan":-1},
    "mem":{"total": "3.72GB", "used":"768.14MB", "usage":"20.2%"},
    "disk":{
    "drive":["26.42GB", "522.99MB", "1.9%"],
    "system":["1.91GB", "318.22MB", "16.3%"],
    "resource":["3.81GB", "160.85MB", "4.1%"],
    "media":["20.70GB", "43.92MB","0.2%"],
    "external": ["20.70GB", "43.92MB","0.2%"]
    },
    "sys":{"temp":-1, "fan":-1}
    }
    }

  13. CMS/SMPのパッチ情報を読み込む（CMSのみ）

    14. 指令 認証
    (非必須)    		 属性 数値 說明
    query k=your_authencation_key get patchlist  
    target mac_address SMP或CMS的MAC位址
    結果 Body 說明

    {
    "result":"string",
    "patch": [
    "patch1",
    "patch2",
    "patch3"
    ]
    }

    		 結果:
    0：成功
    その他：失敗

    例

    検索 http://CMS_IP/cysdk/?k=UXWdFUURPmLbF&session=session_id&query=get:patchlist;
    target:4C02890A25C7
    レスポンス {
    "Result":"0",
    "patch":[
    "P17684: Fix a problem causing player not booting due to log locked by system"
    ]
    }

  14. SMPへパッチ情報をアップロード(CMSのみ)

    15. 指令 認証
    (非必須)    		 属性 数値 說明
    action k=your_authencation_key do upPatch  
    target mac_address SMPまたはCMSのMACアドレス
    group 群組名 特定のプレイヤーグループへのパッチファイルのアップロード
    file smb, http, or ftp URL パッチファイルのURL
    結果 Body 說明

    {
    "result":"string",
    "detail": [
    { "hostname":"string",
    "IP":"string",
    "mac":"string",
    "result":"string"},
    {…}
    ]
    }

    		 結果:
    0：成功
    その他：失敗
    注意事項

    1つのコマンドでtargetとgroupの属性両方を使用することはできません。

    例

    検索 http://CMS_IP/cysdk/?k=UXWdFUURPmLbF&session=session_id&action=do:upPatch;
    target:4C02890A25C7;file:smb://account:password@172.16.0.7/temp/P17699.psu

  15. SMPグループの変更（CMSのみ適用）

    16. 指令 認証
    (非必須)    		 属性 数値 說明
    action k=your_authencation_key do chGroup  
    target mac_address SMPのMACアドレス
    toGroup 群組名 変更したい対象グループ
    結果 Body 說明

    {
    "result":"string",
    }

    		 結果:
    0：成功
    その他：失敗

    例

    検索 http://CMS_IP/cysdk/?k=UXWdFUURPmLbF&session=session_id&action=do:chGroup;
    target:4C02890A25C7;toGroup:mygroup

  16. 緊急時のスケジュールと開始グループの変更（CMSのみ適用）

    17. 指令 認証
    (非必須)    		 属性 数値 說明
    emergency k=your_authencation_key skin スキン名  
    program プログラム名  
    playlist プレイリスト名  
    playback all, 1, 2, 3, 4 再生ID
    all：全ての再生 (デフォルト)
    1：再生1
    2：再生2
    3：再生3
    group グループ名  
    trigger 0, 1 0：閉じる
    1：有効化
    結果 Body 說明

    {
    "result":"0",
    "cms":[
    {
    "hostname":"string",
    "IP":"string",
    "mac":"string",
    "result":"0"
    },
    {cms-2},
    {cms-3},
    ]
    }

    		 結果:
    0：成功
    その他：失敗
    注意事項

    スキン(Skin)、プログラム(Program)、プレイリスト(Playlist)の各属性を同時に使用することはできません。

    例

    検索 http://CMS_IP/cysdk/?k=UXWdFUURPmLbF&session=session_id&emergency=skin:skin1;
    playback:all;group:groupA;trigger:1
    レスポンス {"result":"0",
    "cms":[
    {"hostname":"CMS-40-Hub","IP":"172.16.100.250","mac":"00:90:0B:26:CD:3A",
    "result":"0"},
    {"hostname":"CMS-40-Backup","IP":"172.16.12.59","mac":"00:90:0B:27:CC:FC",
    "result":"0"},
    {"hostname":"CMS-40-site2","IP":"172.16.100.251","mac":"00:0C:29:0F:AA:E2",
    "result":"0"},
    {"hostname":"CMS-40-site1","IP":"172.16.12.186","mac":"00:0C:29:03:1E:4F",
    "result":"0"}
    ]
    }
    注意事項

    回答には、マスターサーバー、ステーションサーバー、バックアップサーバーの全結果が含まれます。

  17. グループリストを読みとる（CMSのみ適用）

    18. 指令 認証
    (非必須)    		 属性 数値 說明
    query k=your_authencation_key get grouplist CMSサーバーの全グループリストを取得する
    結果 Body 說明

    {
    "result":"0",
    "group": [{
    "name": "string",
    "folder": "string",
    "child": [{
    "name": "string",
    "folder": "string",
    "child": [{
    "name": "string",
    "folder": "string",
    }]
    }]
    },
    {next group}
    ]
    }

    		 結果:
    0：成功
    その他：失敗

    例

    検索 http://CMS_IP/cysdk/?k=UXWdFUURPmLbF&session=session_id&query=get:grouplist
    レスポンス {
    "result": "0",
    "group": [{
    "name": "A_layer1",
    "folder": "folder_1",
    "child": [{
    "name": "A_layer2",
    "folder": "folder_2",
    "child": [{
    "name": "A_layer3",
    "folder": "folder_3",
    }]
    }]
    }, {
    "name": "B_layer1",
    "folder": "folder_4",
    }]
    }

  18. グループ属性の変更（CMSのみ適用）

    19. 指令 認証
    (非必須)    		 属性 数値 說明
    action k=your_authencation_key do modgroup  
    group グループ名 変更したいグループ
    newgroup 新しいグループ名 グループ名を変更する
    parent 親グループ名 このグループの親グループ名を変更する
    top 1 グループをトップ（親グループなし）に変更する
    結果 Body 說明

    {
    "result":"string"
    }

    		 結果:
    0：成功
    その他：失敗

    例

    検索 http://CMS_IP/cysdk/?k=UXWdFUURPmLbF&session=session_id&action=do:modgroup;
    group:group_a;newgroup:group_c
    レスポンス {
    "result": "0",
    }
    注意事項

    プロパティTopはプロパティparentと共有できません。

  19. スキンスケジュールの取得（CMSのみ適用）

    20. 特定のグループの現在のスキンスケジュールを取得

    指令 認証
    (非必須)    		 属性 数値 說明
    action k=your_authencation_key get skinlist  
    group グループ名 検索を実行したいグループ
    結果 Body 說明

    {
    "result":"0",
    "skin": [
    {"name": "string",
    "group": "string",
    "currentSchedule":"sting"}
    ]
    }

    		 結果:
    0：成功
    その他：失敗

    例

    検索 http://CMS_IP/cysdk/?k=UXWdFUURPmLbF&session=session_id&query=get:skinlist;
    group:my_group
    レスポンス {
    "result": "0",
    "skin": [
    {"name":"skin1", "group": "A_layer3", "currentSchedule":"0"},
    {"name":"skin2", "group": "A_layer3", "currentSchedule":"0"},
    {"name":"skin4", "group": "A_layer2", "currentSchedule":"0"},
    {"name":"skin5", "group": "A_layer1", "currentSchedule":"1"},
    ]
    }

  20. プライマリーCMSの設定（CMSのみ適用）

    21. CMSをプライマリーサーバーとして設定し、関連オプションを設定。

    指令 認証
    (非必須)    		 属性 数値 說明
    redundancy k=your_authencation_key mode 1  
    mCode 認証コード マスターサーバーとバックアップサーバーの間の認証コード。
    port ポート番号  
    backupIP バックアップサーバーのIP  
    reverseSync 0, 1 0: 逆同期をオフにする
    1: 逆同期を有効にする
    結果 Body 說明

    {
    "result":"0",
    "mode":"1"
    }

    		 結果:
    0：成功
    その他：失敗

    例

    検索 http://CMS_IP/cysdk/?k=UXWdFUURPmLbF&session=session_id&&redundancy=mode:1;
    mCode:1234567890;port:40001;backupIP:IP;reverseSync:0
    レスポンス {
    "result":"0",
    "mode":"1"
    }

  21. バックアップCMSの設定（CMSのみの適用）

    22. CMSをバックアップサーバーとして設定し、関連オプションを設定します。

    指令 認証
    (非必須)    		 属性 数値 說明
    redundancy k=your_authencation_key mode 2  
    bCode 認証コード マスターサーバーとバックアップサーバーの間の認証コード。
    connectIp IPアドレス マスターサーバーのIPアドレス
    updateFirst 0, 1 1：今すぐ同期
    freqType 0 数分おきにマスターサーバーと同期する
    period 分間
    結果 Body 說明
    {
    "result":"0",
    "mode":"2"
    }
    		 結果:
    0：成功
    その他：失敗

    例

    検索 http://CMS_IP/cysdk/?k=UXWdFUURPmLbF&session=session_id&redundancy=mode:2;
    bCode:1234567890;connectIp:192.168.1.8;updateFirst:1;freqType:0;period:5
    レスポンス {
    "result":"0",
    "mode":"2"
    }

  22. CMSの冗長化設定を読み込む（CMSのみ適応）

    23. 指令 認証
    (非必須)    		 属性 数値 說明
    query k=your_authencation_key get redundancy  
    結果 Body 說明
    {
    "result":"0",
    "self": {
    "hostname": "string",
    "mac": "string",
    "IP": "string",
    "mode": "string"
    },
    "another": {
    "status": "string",
    "hostname": "string",
    "mac": "string",
    "IP": "string",
    "mode": "string"
    }
    }
    		 結果:
    0：成功
    その他：失敗

    例

    検索 http://CMS_IP/cysdk/?k=UXWdFUURPmLbF&session=session_id&query=get:redundancy
    レスポンス {
    "result":"0",
    "self": {
    "hostname": "cms-main",
    "mac": "00:0C:29:0F:AA:E2",
    "IP": "172.16.12.59",
    "mode": "1"
    },
    "another": {
    "status": "1",
    "hostname": "cms-backup",
    "mac": "00:0C:29:0F:AA:E2",
    "IP": "172.16.12.59",
    "mode": "2"
    }
    }

  23. CMSの緊急予約状況を読む（CMSのみ適応）

    24. 指令 認証
    (非必須)    		 属性 数値 說明
    query k=your_authencation_key get emergency  
    結果 Body 說明
    {
    "result":"0",
    "group": [{
    "name": "string",
    "trigger": "string",
    "playback": [
    {
    "enable": "string",
    "type": "string",
    "name": "string",
    "playbackOutput": "string"
    }
    ]
    }
    ]
    }
    		 結果:
    0：成功
    その他：失敗

    例

    検索 http://CMS_IP/cysdk/?k=UXWdFUURPmLbF&session=session_id&query=get:emergency
    レスポンス {
    "result":"0",
    "group": [{
    "name": "aaaaa",
    "trigger": "1",
    "playback": [
    {"enable": "1", "type": "skin", "name": "Basic-2", "playbackOutput": "1"},
    {"enable": "1", "type": "skin", "name": "Basic-3" , "playbackOutput": "2"},
    {"enable": "0", "type": "playlist", "name": "playlist1", "playbackOutput": "3"},
    {"enable": "0", "type": "program", "name": "program1", "playbackOutput": "4"}
    ]
    }
    ]
    }

  24. ステーションサーバーの緊急時スケジュールを手動で設定する（CMSの場合のみ適応）

    25. 指令 認証
    (非必須)    		 属性 数値 說明
    query k=your_authencation_key trigger 0, 1 0：閉じる
    1：有効化
    group グループ名  
    playback 1, 2, 3, 4  
    skin スキン名  
    program プログラム名  
    playlist プレイリスト名  
    manually 0, 1 0：マスターサーバーによる制御
    1：ステーションサーバーによる手動トリガー
    結果 Body 說明
    {
    "result":"0",
    "cms":[
    {"hostname":"string","IP":"string","mac":"string","result":"0"}
    ]
    }
    		 結果:
    0：成功
    その他：失敗
    注意事項

    スキン(Skin)、プログラム(Program)、プレイリスト(Playlist)の各属性を同時に使用することはできません。

    例

    検索 http://CMS_IP/cysdk/?k=UXWdFUURPmLbF&session=session_id&emergency=trigger:1;
    group:SMP-8000;playback:1;skin:Basic-2;manually:1
    レスポンス {
    "result":"0",
    "cms":[
    {"hostname":"station_cms","IP":"172.16.100.250","mac":"00:90:0B:26:CD:3A","result":"0"}
    ]
    }

  25. ユーザーアカウントの追加とアクセス権の設定（CMSのみ適応）

    26. 指令 認証
    (非必須)    		 属性 数値 說明
    action k=your_authencation_key do addacc  
    acc ユーザー名 ユーザー名
    pass パスワード アカウントのパスワード
    group グループ名 グループ名は複数指定可能であり、各グループ名は","で区切られる。
    r_group アクセス権用16進コード (Hex code) 下表をご覧ください。 ビットを使用するか、複数の属性を選択する。(例：0x01011)
    r_lib
    r_sch
    r_mbyftp
    r_emergsch
    結果 Body 說明
    {
    "result":"0"
    }
    		 結果:
    0：成功
    その他：失敗

    例

    検索 http://CMS_IP/cysdk/?k=UXWdFUURPmLbF&session=session_id&action=do:addacc;
    acc:user_a;pass:12345;group:aaaaa,bbbbb,ccccc;r_group:0x11;r_lib:0x111111;
    r_sch:0x1111111;r_mbyftp:0x1;r_emergsch:0x1
    レスポンス {
    "result":"0"
    }

    アカウントのアクセス権の属性コードを追加

    属性 機能 コード
    r_group アクセス-フォルダ 0x01
    アクセス-グループ 0x10
    r_lib リソースライブラリ-ファイル 0x000001
    リソースライブラリ - フォント 0x000010
    リソースライブラリ - 時計 0x000100
    リソースライブラリ - スキン 0x001000
    リソースライブラリ - プログラム 0x010000
    リソースライブラリ - プレイリスト 0x100000
    r_sch スケジュール - 再生 0x00000001
    スケジュール - 映像 0x00000010
    スケジュール - 画像スライド 0x00000100
    スケジュール - テロップ 0x00001000
    スケジュール - HTML 0x00010000
    スケジュール - 音量 0x00100000
    スケジュール - スキン 0x01000000
    スケジュール - プレイリスト 0x10000000
    r_mbyftp メディアフォルダへのFTPアクセス 0x1
    r_emergsch 緊急時のスケジュールを有効にする 0x1

  26. アカウント削除（CMSのみ適応）

    27. 指令 認証
    (非必須)    		 属性 数値 說明
    action k=your_authencation_key do rmacc  
    acc ユーザー名  
    結果 Body 說明
    {
    "result":"0"
    }
    		 結果:
    0：成功
    その他：失敗

    例

    検索 http://CMS_IP/cysdk/?k=UXWdFUURPmLbF&session=session_id&action=do:rmacc;
    acc:user_a
    レスポンス {
    "result":"0"
    }

  27. アカウント属性の変更（CMSのみ適用）

    28. 指令 認証
    (非必須)    		 属性 数値 說明
    action k=your_authencation_key do modacc  
    acc ユーザー名  
    pass パスワード アカウントのパスワード
    newacc ユーザー名 ユーザー名を変更する
    newpass パスワード パスワードの変更
    r_group グループ名 グループ名は複数指定可能であり、各グループ名は","で区切られる。
    r_lib アクセス権用16進コード (Hex code) アクセス権を変更。 ビットを使用するか、複数の属性を選択する。(例：0x01011)
    r_sch
    r_mbyftp
    r_emergsch
    結果 Body 說明
    {
    "result":"0"
    }
    		 結果:
    0：成功
    その他：失敗

    例

    検索 http://CMS_IP/cysdk/?k=UXWdFUURPmLbF&session=session_id&action=do:modacc;
    acc:user_a;pass:12345;newacc:user_b;newpass:67890;group:aaaaa,bbbbb,ccccc;
    r_group:0x11;r_lib:0x111111;r_sch:0x1111111
    レスポンス {
    "result":"0"
    }

  28. スキンレイアウトの読み込み（CMSのみ適応）

    29. 指令 認証
    (非必須)    		 属性 数値 說明
    query k=your_authencation_key get skin  
    skin 面板名  
    group 群組名  
    結果 Body 說明
    {
    "result":"0"
    "skin":[ {
    "name":"string",
    "layout":[
    {
    "w":INT,"h":INT,
    "zones": INT,
    "zone":[
    {"type":"string","loc":{"x":INT,"y":INT,"w":INT,
    "h":INT,"z":INT}},
    {"type":"string","loc":{"x":INT,"y":INT,"w":INT,
    "h":INT,"z":INT}}
    ]
    }
    ]
    }]
    }

    結果:
    0：成功
    その他：失敗


    name: スキン名
    w: スキン幅
    h: スキンの高さ
    zones: ゾーン数
    zone: ゾーン情報
    type: メディアタイプ
    loc: ゾーンの座標と寸法

    例

    検索 http://CMS_IP/cysdk/?k=UXWdFUURPmLbF&session=session_id&query=get:skin;
    skin:Skin-1;group:group_a
    レスポンス {
    "result":"0"
    "skin":[ {
    "name":"Skin18",
    "layout":[
    {
    "w":1920,"h":1080,
    "zones": 3,
    "zone":[
    {"type":"video","loc":{"x":67,"y":62,"w":609,"h":385,"z":1}},
    {"type":"image","loc":{"x":1037,"y":44,"w":677,"h":484,"z":7}},
    {"type":"html","loc":{"x":2,"y":514,"w":842,"h":492,"z":7}}
    ]
    }
    ]
    }]
    }

  29. Wifi configuration (SMPのみ適応):

    30. 実行コード 属性 数値 說明
    scan_ssid   0, 1 0: 無効にする(一般のWiFiに接続)
    1: 有効にする(SSIDステルスのWiFiに接続)

    例

    http://<ip>/cysdk/?scan_ssid=0
    http://<ip>/cysdk/?scan_ssid=1

  30. すべてのCMSシステムに対して、一括で緊急スケジューリングを有効または無効にする。.

    31. http://<ip>/cysdk/?emAction=trigger_all
    http://<ip>/cysdk/?emAction=stop_all
    http://<ip>/cysdk/?emAction=trigger&group={group's name}
    http://<ip>/cysdk/?emAction=stop&group={group's name}

  31. COMポートを制御してコマンドを送信する（SMP専用）

    32. 実行コード 属性 数値 說明
    send_cs dev com1
    com2    		 Web UIで設定したcom1またはcom2にコマンドを送信
    cmd 0, 1, 2… 0: コマンド1
    1: コマンド2
    2: コマンド3

    例

    COMポート1でコマンド1を実行
    http://<ip>/cysdk/cysdk.cgi?exe=send_cs&dev=com1&cmd=0

ページのトップへ戻る

付録A：タイムゾーンを設定した都市一覧

(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+06:30) Myanmar
(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


ページのトップへ戻る

付録B：SDKリザルトコード（Result Code）

-1 : タイムアウト。 タイムアウトのプリセット値は30秒です。
 0 : 成功。
 1 : アカウントとパスワードが正しいことを確認します。
 2 : ログアウトできません。
 3 : このセッションは無効です。
 4 : アクションコマンドのキー値が無効です。
 5 : queryコマンドの属性キーワードが無効です。
 6 : queryコマンドのget属性値が無効です。
 7 : CMSListを取得できませんでした。
 8 : SMPListを取得できませんでした。
 9 : SMPまたはCMSのターゲットが接続されていません。
10 : SMPまたはCMSのターゲットが見つかりませんでした。
11 : SMPのHWInfoを取得できませんでした。
12 : SMPまたはCMSのPatchListが取得できません。
13 : SMPまたはCMSのログファイルが利用できません。(ログファイルが空白の場合に発生します）。
14 : 現在、同じターゲットのログファイルを他の人が読んでいます。
15 : アクションコマンドの属性キーワードが無効です。
16 : アクションコマンドの属性doの値が無効です。
17 : SMPグループを変更できません。
18 : パッチファイルを入力してください。
19 : このパッチファイルをダウンロードすることができません。
20 : このパッチファイルのフォーマットはサポートされていません。 正しいサブファイル名は.psuです。
21 : このグループは無効です。
22 : ターゲットとグループを同時に入力することはできません。
23 : ターゲットまたはグループを入力してください。
24 : 修正ファイルをアップロードしているので、しばらくお待ちください。
25 : 修正ファイルをアップロードできませんでした。
26 : queryコマンドの属性キーワードが無効です。
27 : Emergency コマンドの play 属性値が無効です。
28 : Emergencyコマンドのグループ属性値が無効であるか、アカウントがグループを管理できません。
29 : 選択できるリソースは1つだけです。
30 : 選択されたリソースは無効です。
31 : EmergencyコマンドのTrigger属性が無効です。
32 : お客様のアカウントでは、緊急時のスケジュールにアクセスできません。
33 : 非常時のスケジュールを起動できません。
34 : 通知を送信できません。
35 : このグループは無効です。
36 : グループの下にサブグループが存在するため、グループをトップレベルに移動することができません。
37 : グループ名はすでに存在し、同じ名前を追加/変更することはできません。
38 : グループ名が無効です。 名前には、アルファベット（a〜zまたはA〜Z）、数字（0〜9）、アンダースコア（_）、ハイフン（-）を含める必要があります。
39 : 親グループ名が無効であるか、存在しません。
40 : このグループは無効です。
41 : 新しいアカウント名が無効です。 名前には、アルファベット（a~z）、数字（0-9）、アンダースコア（_）を含める必要があります。
42 : このアカウントはすでに存在しています。
43 : パスワードが無効です。
44 : 一部のグループが無効です。
45 : アカウントが無効です。
46 : アカウントを編集できません。
47 : アカウント名が無効であるか、存在しません。
48 : アカウントのパスワードが無効です。
49 : アカウント名が無効です。
50 : この新しいアカウントはすでに存在しています。
51 : 新しいパスワードが無効です。
52 : 一部のグループが無効です。
53 : グループが存在しないか、無効です。
54 : このグループにスキンは存在しません。

ページのトップへ戻る