Application Programmer Interface API - Cisco...このガイドは、TC ソフトウェアの...

D15316.02SX20 Codec API リファレンスガイド CE8.0、2016 年 2 月。 Copyright © 2016 Cisco Systems, Inc. All rights reserved. 1

Cisco TelePresence SX20 Codec API リファレンスガイド

ソフトウェアバージョン CE8.0 2016 年 2 月

Application Programmer Interface（API）リファレンスガイド

Cisco TelePresence SX20 Codec



TA - ToC - 非表示のテキストアンカー

目次

はじめに .................................................................................3

このガイドについて ...................................................................4ユーザドキュメンテーションのダウンロード ............................4

このバージョンの新機能 ............................................................5新機能および改善点 ..............................................................5CE8.[0] での xConfiguration の変更 ...................................... 7CE8.[0] での xCommand の変更 .........................................12CE8.[0] での xStatus の変更 ...............................................15

API について .........................................................................18

API の基礎 .............................................................................19API への接続 .......................................................................19[パスワード（Password）] ......................................................19RS-232/シリアル接続 .........................................................19Telnet ..................................................................................20SSH ....................................................................................20HTTP/HTTPS ......................................................................20

API 出力 .................................................................................21出力モード...........................................................................21

コマンドラインの使用法 .........................................................22API コマンド ........................................................................22その他のコマンド .................................................................22コマンドラインショートカット ...............................................23検索 ....................................................................................23値のタイプおよびフォーマット ..............................................23

コマンド..................................................................................24

コンフィギュレーション ............................................................24

ステータス ..............................................................................24

イベント ..................................................................................25

フィードバックメカニズム .......................................................26フィードバック式 ...................................................................26端末接続 .............................................................................27

HTTP の使用 ..........................................................................28ステータスと設定の取得 .......................................................28コマンドと設定の送信 ..........................................................28HTTP POST を使用する方法 ...............................................28

HTTP 経由でのコーデックからのフィードバック ......................29フィードバックの登録 ............................................................29terminal モードから XML への変換 ......................................30

ベストプラクティス .................................................................. 31

xConfiguration コマンド ........................................................32

xCommand コマンド .............................................................82

xStatus コマンド .................................................................120

付録 ...................................................................................164

起動スクリプトについて ........................................................165

SystemTools コマンド ..........................................................166

接続解除の原因タイプについて ............................................168

シスコ Web サイト内のユーザドキュメンテーション .............169

このガイドの内容上部メニューバーと目次のエントリはすべてハイパーリンクになっており、クリックしてトピックに移動できます。

ユーザマニュアルの更新バージョンがないか、定期的に Web サイトにアクセスして確認することを推奨します。

参照先：http://www.cisco.com/go/sx-docs

http://www.cisco.com/go/sx-docs



第 1 章

はじめに



このガイドについてこのガイドは、TC ソフトウェアの Application Programmer Interface（API）の概要を示すとともに、以下の製品のコマン

ドラインコマンドのリファレンスガイドとして機能します。

• Cisco TelePresence SX20 Codec

ユーザドキュメンテーションのダウンロードユーザマニュアルはシスコの Web サイトからダウンロードできます。http://www.cisco.com/go/sx-docs にアクセスしてください。

シスコの Web サイトでのマニュアルの検索方法に関するガイドラインについては、付録の「Cisco Web サイト上のユーザマニュアル」を参照してください。




新機能および改善点

製品

CE8.0 は次の製品をサポートしています。

• MX200 G2• MX300 G2• MX700• MX800• SX10 Quick Set• SX20 Quick Set• SX80

EX シリーズ、C シリーズ、および Profile シリーズの Cisco TelePresence 製品は CE ソフトウェアでサポートされません。これらの製品については、ソフトウェアバージョン TC7.3 以前を使用してください。

ユーザインターフェイス

CE ソフトウェアが稼働する製品では、次のユーザインターフェイスを使用する必要があります。

• タッチ 10 コントローラ（すべての製品で利用可能）。• TRC6 リモートコントロール（SX10 および SX20. で利

用可能）。

タッチ 8 コントローラおよびリモートコントロール TRC5 はサポートされていません。

SX20 には、TRC6 リモコンの導入に伴って新しいオンスクリーン表示が追加されました。現在、SX20 用のオンスクリーン表示は SX10 に合わせてあります。

Touch 8 コントローラまたは TRC5 リモコンを使用した SX20 を CE8.0 にアップグレードすると、TC7.3 以前にダウングレードするように通知されます。

API の変更点

API コマンドの数が削減されました。完全に削除されたコマンドと、基盤となるアーキテクチャの変更に対応するために構文が変更されたコマンドがあります。

考慮すべき重要な点として、新しい API に対応するために、API を使用している現在の統合の再プログラミングが必要になる可能性があります。

変更のリストと新しいコマンドのリストをこの章に収録しています。

コンテンツシェアリングのための Intelligent Proximity

Cisco Proximity を使用すれば、デバイス（スマートフォン、タブレット、またはラップトップ）が範囲内に入ったときに自動的にビデオシステムとペアリングすることができます。この機能は、デフォルトで無効になっています。

Cisco Proximity には、クライアントとのコンテンツシェアリング、クライアントからのコンテンツシェアリング、および基本コール制御の 3 つのサービスがあります。これらのサービスは、デフォルトでは無効になっています。

スマートフォンとタブレット（Android と iOS）またはラップトップ（Windows と OS X）用の Cisco Proximity クライアントは、http://proximity.cisco.com 。からダウンロードできます。スマートフォンおよびタブレット向けのクライアントは、Google Play（Android）および Apple App Store（iOS）からも入手可能です。

Multistream

マルチストリーム機能を使用すれば、ビデオシステムで解像度が異なる複数のビデオストリームを同時に送受信することができます。ビデオシステムは、使用可能なすべての画面により適合するようにレイアウトをローカルで編成します。

複数の参加者との会議では、この機能によって、レイアウト制御に関するユーザエクスペリエンスが向上します。マルチスクリーンシステムは、マルチストリーム対応会議に参加しているときにすべての画面を利用できます。また、すべてのシステムにコンテンツを提供して共有できるようにレイアウトが改善されます。

このリリースでは、マルチストリームがデフォルトでオフになっています。最適なエクスペリエンスを提供するために、Cisco UCM 11.0.0 以降と、TelePresence Server および TelePresenceConductor の最新バージョンをお勧めします。

このバージョンの新機能ここでは、シスココラボレーションエンドポイントソフトウェアバージョン 8.[0]（CE8.[0]）で追加または変更されたシステム設定と新機能および改善点を、TC7.3 と比較して説明します。

CE ソフトウェアは TC7 に基づいているため、構造と主要な機能は TC ソフトウェアと同じです。

詳細については、ソフトウェアリリースノートを参照することを推奨します。

http://www.cisco.com/c/en/us/support/collaboration-endpoints/telepresence-quick-set-series/tsd-products-support-series-home.html

アップグレードする前に CE8.0 のアップグレード要件を十分考慮することが重要です。そうしなければ、CE8.0 にアップグレードしても正しく機能せず、ダウングレードする必要が生じます。

http://www.cisco.com/c/en/us/support/collaboration-endpoints/telepresence-quick-set-series/products-release-notes-list.htmlhttp://www.cisco.com/c/en/us/support/collaboration-endpoints/telepresence-quick-set-series/products-release-notes-list.htmlhttp://www.cisco.com/c/en/us/support/collaboration-endpoints/telepresence-quick-set-series/products-release-notes-list.html



PIN コードによる保護

承認されていないユーザがビデオシステムの設定を変更できないようにするため、画面の [詳細設定（Advanced Settings）] メニューを PIN コードで保護できます。

解像度の変更

コラボレーションエンドポイントソフトウェアでは、解像度 16:9 に対応しているディスプレイだけがサポートされています。

リモートモニタリング

セキュリティを強化するために、リモートモニタリングオプションキーがビデオシステムにインストールされている場合、ビデオシステムの Web インターフェイスからローカルおよび遠端ビデオストリームのスナップショットを取得する操作だけが可能です。

オプションキーを追加してビデオシステムを再起動すると、リモートモニタリングが有効になります。

ビデオシステムのユーザには警告メッセージもインジケータも送信されません。システム管理者がカメラや画面を監視および制御する場合があることを、ユーザに適切な方法で通知してください。

削除された機能

• MultiWay はサポートされなくなりました。代わりに、CUCM アドホック会議またはホスト型会議が使用できます。

• Cisco CTMS はサポートされなくなりました。（Cisco TelePresence Server、Cisco TelePresence MCU、または Cisco TelePresence Conductor を使用する）他のマルチポイント会議ソリューションを代わりに使用できます。

• MediaNet のサポートは廃止されました。



CE8.[0] での xConfiguration の変更

新しい構成

Conference MultiStream Mode

Proximity Mode

Proximity Services CallControl

Proximity Services ContentShare FromClients

Proximity Services ContentShare ToClients

削除された設定

* は、で始まるすべての設定が削除されることを意味します。

Audio Input HDMI [1] Mode

Audio Microphones Mute Enabled

Audio Volume

Cameras Camera [n] DHCP

Cameras Camera [n] Flip

Cameras Camera [n] MotorMoveDetection

Cameras PowerLine Frequency

Conference [1] ActiveControl Mode

Conference [1] CallProtocolIPStack

Conference [1] FarEndControl SignalCapability

Conference [1] IncomingMultisiteCall Mode

Conference [1] MicUnmuteOnDisconnect Mode

Conference [1] Multipoint Mode

Conference [1] Presentation *

Conference [1] VideoBandwidth *

Experimental *

FacilityService *

H323 Profile [1] Gatekeeper Discovery

H323 Profile [1] PortAllocation

Logging Mode

Network [1] DHCP RequestTFTPServerAddress

Network [1] TrafficControl Mode

NetworkServices CTMS Encryption

NetworkServices CTMS Mode

NetworkServices HTTPS Mode

NetworkServices HTTPS OCSP *

NetworkServices HTTPS VerifyClientCertificate

NetworkServices HTTPS VerifyServerCertificate

NetworkServices Medianet Metadata

NetworkServices MultiWay *

NetworkServices SSH AllowPublicKey

NetworkServices XMLAPI Mode

Peripherals Pairing *

RTP *

Security *

SIP ANAT

SIP AuthenticateTransferror

SIP OCSP *

SIP PreferredIPMedia

SIP PreferredIPSignaling

SIP プロファイルの [1] 行

SIP Profile [1] Mailbox

SIP Profile [1] Outbound

SIP Profile [1] Proxy [n] Discovery

SIP Profile [1] TlsVerify



SIP Profile [1] Turn BandwidthProbe

SIP Profile [1] Turn DiscoverMode

SIP Profile [1] Turn DropRflx

SIP Profile [1] Type

SystemUnit CallLogging Mode

SystemUnit MenuLanguageTime OlsonZone

UserInterface OSD EncryptionIndicator

UserInterface OSD InputMethod Cyrillic

UserInterface OSD InputMethod InputLanguage

UserInterface TouchPanel DefaultPanel

UserInterface UserPreferences

UserInterface Wallpaper

Video AllowWebSnapshots

Video Input Connector [n] DviType

Video Input Connector [n] OptimalDefinition *

Video Input Connector [n] RGBQuantizationRange

Video Input Source [n] Connector

Video Layout DisableDisconnectedLocalOutputs

Video Layout LocalLayoutFamily

Video Layout PresentationDefault View

Video Layout RemoteLayoutFamily

Video Layout ScaleToFrame

Video Layout ScaleToFrameThreshold

Video Layout Scaling

Video OSD AutoSelectPresentationSource

Video OSD CallSettingsSelection

Video OSD LanguageSelection

Video OSD LoginRequired

Video OSD MenuStartupMode

Video OSD MissedCallsNotification

Video OSD Mode

Video OSD MyContactsExpanded

Video OSD TodaysBookings

Video OSD VirtualKeyboard

Video OSD WallPaperSelection

Video Output Connector [n] Location HorizontalOffset

Video Output Connector [n] Location VerticalOffset

Video Output Connector [n] RGBQuantizationRange

Video PIP *

Video Selfview

Video SelfviewPosition

変更された設定

NetworkServices HTTP Mode 旧：

デフォルト値：On新：

デフォルト値：HTTP+HTTPS

Phonebook Server[n] Type旧：

デフォルト値：TMS新：

デフォルト値：Off

Provisioning Mode旧：新：



Standby BootAction旧：新：

Standby WakeupAction旧：新：

タイムゾーン変更：タイムゾーンのリストが更新されています。値スペースの情報は、tz データベース（別名：IANA タイムゾーンデータベース）から取得しています。

Video Input Connector [n] InputSourceType旧：新：

Video Input Connector [n] PresentationSelection旧：新：

Video Output Connector [n] Resolution旧：新：

名前が変更された設定

Audio SoundsAndAlerts KeyTones Mode変更後：UserInterface KeyTones Mode

Cameras Camera [n] Backlight変更後の名前：Cameras Camera [n] Backlight DefaultMode

Cameras Camera [n] Brightness Level変更後の名前：Cameras Camera [n] Brightness DefaultLevel

Conference [1] AutoAnswer Delay変更後の名前：Conference AutoAnswer Delay

Conference [1] AutoAnswer Mode変更後の名前：Conference AutoAnswer Mode

Conference [1] AutoAnswer Mute変更後：Conference AutoAnswer Mute

Conference [1] DefaultCall Protocol変更後：Conference DefaultCall Protocol

Conference [1] DefaultCall Rate変更後の名前：Conference DefaultCall Rate

Conference [1] DoNotDisturb DefaultTimeout変更後：Conference DoNotDisturb DefaultTimeout

Conference [1] Encryption Mode変更後：Conference Encryption Mode

Conference [1] FarEndControl Mode変更後の名前：Conference FarEndControl Mode

Conference [1] MaxReceiveCallRate変更後の名前：Conference MaxReceiveCallRate

Conference [1] MaxTotalReceiveCallRate変更後の名前：Conference MaxTotalReceiveCallRate

Conference [1] MaxTotalTransmitCallRate変更後の名前：Conference MaxTotalTransmitCallRate

Conference [1] MaxTransmitCallRate変更後：Conference MaxTransmitCallRate

H323 Profile [1] Authentication LoginName変更後：H323 Authentication LoginName

H323 Profile [1] Authentication Mode変更後：H323 Authentication Mode

H323 Profile [1] Authentication Password変更後：H323 Authentication Password

H323 Profile [1] CallSetup Mode変更後：H323 CallSetup Mode



H323 Profile [1] Encryption KeySize変更後：H323 Encryption KeySize

H323 Profile [1] Gatekeeper Address変更後：H323 Gatekeeper Address

H323 Profile [1] H323Alias E164変更後：H323 H323Alias E164

H323 Profile [1] H323Alias ID新しい名前：H323 H323Alias ID

NetworkServices NTP Address変更後の名前：NetworkServices NTP Server [n] Address

SIP Profile [1] Authentication [1] LoginName変更後の名前：SIP Authentication UserName

SIP Profile [1] Authentication [1] Password変更後の名前：SIP Authentication Password

SIP Profile [1] DefaultTransport変更後の名前：SIP DefaultTransport

SIP Profile [1] DisplayName変更後の名前：SIP DisplayName

SIP Profile [1] Ice DefaultCandidate変更後の名前：SIP Ice DefaultCandidate

SIP Profile [1] Ice Mode変更後の名前：SIP Ice Mode

SIP Profile [1] Proxy [n] Address変更後：SIP Proxy [n] Address

SIP Profile [1] Turn Password変更後の名前：SIP Turn Password

SIP Profile [1] Turn Server変更後の名前：SIP Turn Server

SIP Profile [1] Turn UserName変更後の名前：SIP Turn UserName

SIP Profile [1] URI

変更後の名前：SIP URI

SystemUnit ContactInfo Type変更後：UserInterface ContactInfo Type

Video CamCtrlPip CallSetup Duration変更後の名前：Video Selfview OnCall Duration

Video CamCtrlPip CallSetup Mode変更後：Video Selfview OnCall Mode

Video DefaultPresentationSource変更後の名前：Video Presentation DefaultSource

Video Input Source [n] CameraControl CameraId変更後：Video Input Connector [n] CameraControl CameraId

Video Input Source [n] CameraControl Mode変更後：Video Input Connector [n] CameraControl Mode

Video Input Source [n] Name変更後：Video Input Connector [n] Name

Video Input Source [n] PresentationSelection変更後：Video Input Connector [n] PresentationSelection

Video Input Source [n] Quality変更後：Video Input Connector [n] Quality

Video Input Source [n] Type変更後：Video Input Connector [n] InputSourceType

Video Input Source [n] Visibility変更後：Video Input Connector [n] Visibility

Video MainVideoSource変更後：Video DefaultMainSource

Video OSD Output変更後：UserInterface OSD Output

Video Output HDMI [n] CEC Mode変更後：Video Output Connector [n] CEC Mode

Video Output HDMI [n] MonitorRole変更後：Video Output Connector [n] MonitorRole



Video Output HDMI [n] OverscanLevel変更後：Video Output Connector [n] OverscanLevel

Video Output HDMI [n] Resolution変更後：Video Output Connector [n] Resolution

Video SelfviewDefault FullscreenMode変更後：Video Selfview Default FullscreenMode

Video SelfviewDefault Mode変更後の名前：Video Selfview Default Mode

Video SelfviewDefault OnMonitorRole変更後：Video Selfview Default OnMonitorRole

Video SelfviewDefault PIPPosition変更後：Video Selfview Default PIPPosition



CE8.[0] での xCommand の変更

新しいコマンド

Camera Preset ActivateDefaultPosition

Camera Preset Show

Proximity Services Activate

Proximity Services Deactivate

SystemUnit OptionKey Remove

SystemUnit OptionKey RemoveAll

UserManagement User Passphrase Change

UserManagement User Passphrase Set

削除されたコマンド

xCommand * は、xCommand で始まるすべてのコンフィギュレーションが削除されたことを意味します。

Audio Sound Play

Audio Sound Stop

Audio VuMeter *

Camera PanTiltReset

Camera PositionActivateFromPreset

Camera PositionSet

Camera Preset Snapshot *

CamCtrlPip

Experimental *

FacilityService Dial

FarEndControl Preset Store

Key *

Logging ExtendedLogging *

Message Echo

Message FarendMessage

Presentation Byod *

Provisioning CUCM CAPF OperationStart

Provisioning CUCM ExtensionMobility *

Provisioning CUCM ITL Show

Security FIPSMode Activate

SystemUnit AdminPassword Set

SystemUnit ConfigurationProfile *

UserInterface OSD Close

UserInterface ScreenShot *

Video AutoPresentationStart *

Video Layout SetPresentationView

Video OSD Close

変更されたコマンド

Call Accept削除：CallType

コールの切断旧：CallId (r): 新：CallId:

保留旧：CallId (r): 新：CallId:

Camera PositionReset新：Axis:

Camera Preset Edit新：DefaultPosition:



Camera Preset List新：CameraId: 新：DefaultPosition: 削除：PresetId

Camera Preset Store新：DefaultPosition:

HttpFeedback Deregister旧：必要なユーザロール：ADMIN新：必要なユーザロール：USER

HttpFeedback Register旧：必要なユーザロール：ADMIN新：必要なユーザロール：USER

Peripherals List旧：タイプ：新：タイプ：

Presentation Stop新：PresentationSource:

UserInterface Message Alert Clear旧：必要なユーザロール：ADMIN新：必要なユーザロール：USER

UserInterface Message Prompt Clear旧：必要なユーザロール：ADMIN新：必要なユーザロール：USER

UserInterface Message TextLine Clear旧：必要なユーザロール：ADMIN新：必要なユーザロール：USER

UserManagement User Passphrase Set新：YourPassphrase:

名前が変更されたコマンドまたは置き換えられたコマンド

ブート変更後：SystemUnit Boot

Call DisconnectAll 統合先：Call Disconnect

Call HoldAll統合先：Call Hold

Conference ActiveSpeaker Reset 変更後：Conference SpeakerLock Release

Conference ActiveSpeaker Set 変更後：Conference SpeakerLock Set

DTMFSend 変更後：Call DTMFSend

FarEndControl Camera Move変更後：Call FarEndControl Camera Move

FarEndControl Camera Stop変更後：Call FarEndControl Camera Stop

FarEndControl Preset Activate変更後：Call FarEndControl RoomPreset Activate

FarEndControl Source Select変更後：Call FarEndControl Source Select

Message *変更後：UserInterface Message *

Preset *変更後：RoomPreset *

SystemUnit DateTime Get変更後：Time DateTime Get

SystemUnit DateTime Set 変更後：Time DateTime Set旧：Year: 新：年：

xCommand SystemUnit Diagnostics Run 変更後：xCommand Diagnostics Run

xCommand Video Presentation Set変更後：xCommand Video PresentationPIP Set



xCommand Video PictureLayoutSet変更後：xCommand Video Layout LayoutFamily Set

xCommand Video PIP ActiveSpeaker Set 変更後：xCommand Video ActiveSpeakerPIP Set

xCommand Video PIP Presentation Set 変更後：xCommand Video PresentationPIP Set



CE8.[0] での xStatus の変更

新しいステータス

Call [n] HoldReason

Conference Call [n] Capabilities FarendMessage Mode

Conference Call [n] Capabilities IxChannel Status

H323 Mode Reason

Proximity Services Availability

Standby State

SIP Mailbox URI

SystemUnit Software OptionKeys RemoteMonitoring

UserInterface ContactInfo ContactMethod [n] Number

UserInterface ContactInfo Name

削除されたステータス

xStatus * は、xStatus で始まるすべてのコンフィギュレーションが削除されたことを意味します。

Call [n] CallPriority

Call [n] ModifyState

Call [n] SecurityStatus

CallDiagnostics [n] *（旧：Diagnostics Call [n] *）

Cameras Camera [n] DownloadProgress（旧：Camera [n] DownloadProgress）

Cameras Camera [n] HardwareID（旧：Camera [n] HardwareID）

Cameras Camera [n] IpAddress（旧：Camera [n] IpAddress）

Cameras Camera [n] Position *（旧：Camera [n] Position *）

Cameras Camera [n] UpgradeStatus（旧：Camera [n] UpgradeStatus）

Conference Call [n] Appearance（旧：Conference Site [n] Appearance）

Conference Call [n] AttendedTransfer（旧：Conference Site [n] AttendedTransfer）

Conference Call [n] CalText（旧：Conference Site [n] CalText）

Conference Call [n] Preserved（旧：Conference Site [n] Preserved）

Conference Call [n] SecurityStatus（旧：Conference Site [n] SecurityStatus）

Conference Call [n] UnattendedTransfer（旧：Conference Site [n] UnattendedTransfer）

Conference Line [n] Appearance [n] *

Conference LoudestSite

Conference Presentation LastLocalSource

Conference Presentation LocalSendingMode

Conference Presentation LocalSource

Conference Presentation Protocol

Conference Presentation Resolution *

Conference SelectedCallProtocol

Conference Site [n] ConferenceExtended

Diagnostics LastRun (was SystemUnit Diagnostics LastRun)

Experimental *

H320 *

ICE *

Logging *

MediaChannels Call [n] *

Network [n] IPv4 DHCP *

Network [n] IPv4 DNS *

Network [n] MTU

Peripherals ConnectProgress [n] *

Peripherals ControllableDevice [n] *

Provisioning CUCM *

Provisioning NextRetry

Provisioning Reason

Provisioning Server

Provisioning Software PreviousUpgrade *



Provisioning Software UpgradeStatus SecondsUntilUpgrade

RoomPreset [n] * (was Preset [n] *)

Security Audit Server Port

SystemUnit Hardware BootSoftware

SystemUnit Hardware MainBoard *

SystemUnit Hardware Module CompatibilityLevel

SystemUnit Hardware Module Identifier

SystemUnit Hardware MonitoringSoftware

SystemUnit Hardware TemperatureThreshold

SystemUnit Hardware UDI

SystemUnit MenuLogo

SystemUnit Software Application

SystemUnit State Subsystem Application

SystemUnit State System

Time ZoneOlson

Video Input LastConnectedSource

Video Layout *

変更されたステータス

Call [n] Protocol旧：String新：

Conference Multipoint Mode旧：新：

Diagnostics Message [n] Type新：TemperatureCheck、AudioInternalSpeakerDisabled、および ContactInfoMismatch が値スペースに追加されました

H323 Mode Status

旧：String 新：

Peripherals ConnectedDevice [n] Status旧：新：

Peripherals ConnectedDevice [n] Type旧：新：

Peripherals ConnectedDevice [n] UpgradeStatus旧：新：

Provisioning Status旧：新：

SystemUnit Software OptionKeys MultiSite旧：String新：

SystemUnit Software OptionKeys PremiumResolution旧：String新：

名前が変更されたステータス

xStatus * は、xStatus で始まるすべてのコンフィギュレーションが削除されたことを意味します。

Camera [n] * 変更後：Cameras Camera [n] *

Conference ActiveSpeaker Manual SiteId変更後：Conference SpeakerLock CallId

Conference ActiveSpeaker Mode変更後：Conference SpeakerLock Mode



Conference ActiveSpeaker SiteId変更後：Conference ActiveSpeaker CallId

Conference Presentation Instance[n] LocalSendingMode変更後：Conference Presentation LocalInstance[n] SendingMode

Conference Presentation Instance[n] LocalSource変更後：Conference Presentation LocalInstance[n] Source

Conference Presentation SiteId変更後：Conference Presentation CallId

Conference Site [n] * 変更後：Conference Call [n] *

Conference Site [n] Hold変更後：Conference Call [n] Capabilities Hold

NetworkServices NTP Address 変更後：NetworkServices NTP Server [n] Address

SIP Profile [n] * 変更後：SIP *

SIP Profile [n] DirectoryURI Alias [n] URI 変更後：SIP AlternateURI Alias [n] URI

SIP Profile [n] DirectoryURI Primary URI 変更後：SIP AlternateURI Primary URI

SystemUnit ContactInfo 変更後の名前：UserInterface ContactInfo ContactMethod [n] Number

SystemUnit ContactName 変更後の名前：UserInterface ContactInfo Name

SystemUnit Diagnostics Message [n] * 変更後：Diagnostics Message [n] *

SystemUnit Software MaxAudioCalls 変更後：Capabilities Conference MaxAudioCalls

SystemUnit Software MaxVideoCalls 変更後：Capabilities Conference MaxVideoCalls

SystemUnit State MaxNumberOfActiveCalls 変更後：Capabilities Conference MaxActiveCalls

SystemUnit State MaxNumberOfCalls 変更後：Capabilities Conference MaxCalls

Video Input Source [n] Resolution FormatStatus 変更後：Video Input Source [n] FormatStatus

Video Input Source [n] Resolution FormatType 変更後：Video Input Source [n] FormatType

Video PIP ActiveSpeaker Position 変更後：Video ActiveSpeaker PIPPosition

Video PIP Presentation Position 変更後：Video Presentation PIPPosition



第 2 章

API について



API の基礎この章では、コーデック API でサポートされているメカニズムの概要を説明します。

API へのアクセス方法、コマンドラインの使用方法、および API の各部分の用途について説明します。コーデックで利用可能なフィードバック機能の使用方法については、この章を参照してください。

API は次の 4 つの主要グループで構成されます。

• コマンド • コンフィギュレーション（Configurations） • ステータス • イベント

これら 4 つのグループは階層構造になっているため、関連機能を簡単に見つけることができます。すべてのコマンド、設定、およびステータスを以降の章に収録しています。

API への接続コーデック API にアクセスするには、いくつかの方法があります。どの方法でアクセスする場合でも、API の構造は変わりません。用途に最も適した接続方法を選択してください。開始する前に、この項を読み各種アクセス方法を確認してください。一部の方法では、有効にする前に設定を変更する必要があります。

次の設定は、パスワードを除き Web インターフェイスの [システム設定（System configuration）] メニューまたはコマンドラインインターフェイスから設定できます。例はすべて、コマンドラインインターフェイスのものです。

[パスワード（Password）]ビデオシステムは完全な資格情報を持つデフォルトのユーザアカウントに提供されます。ユーザ名は admin です。最初はデ

フォルトユーザのパスワードは設定されていません。

システム設定へのアクセスを制限するために、admin ユーザにパスワードを設定する必要があります。また、同様のクレデンシャルを持つ他のユーザのパスワードを設定する必要もあります。

パスワードはコーデックの Web インターフェイスで設定できます。Web ブラウザを開き、ビデオシステムの IP アドレスをアドレスバーに入力してログインします。右上隅のユーザ名をクリックし、ドロップダウンメニューから [パスワードの変更

（Change password）] を選択します。

RS-232/シリアル接続この接続は、IP アドレス、DNS、またはネットワークがない状態で使用できるため、インテグレータがシスコの製品への接続に最もよく使用する接続方式の 1 つです。

コーデックの設定

シリアル接続では、ボーレートとログインの要/不要の 2 つの設定を変更できます。これらの設定を有効にするには、コーデックをリブートする必要があります。

xConfiguration SerialPort BaudRate:

xConfiguration SerialPort LoginRequired:

接続

SX20 コーデックの場合は、USB ポートに接続するために USB/RS-232 アダプタが必要です。

（注）

• セキュリティ上の理由から、パスワードプロンプトはデフォルトでオンになっていますが、必要に応じてオフにできます。

• デフォルトボーレートは 38400 に設定されます。これは、コーデックが大量のフィードバックを返す可能性があるためです。9600 ボーを使用した場合は、統合が低速化する可能性があります。したがって、この速度以上の接続を維持することをお勧めします。

• 初期ブートシーケンスで、コーデックは、設定されたアプリケーションボーレートに関係なく、38400 のボーレートを使用します。



TelnetTelnet は、TCP/IP におけるシリアルプロトコルと見なすことができます。Telnet はデフォルトで無効になっています。Telnet を使用してコーデックに接続する前に、Telnet を有効にする必要があります。


Telnet サービスを有効にするには、コーデックで次の設定項目を設定します。この設定を変更する場合、デバイスを再起動する必要はありませんが、変更が反映されるまでに時間がかかることがあります。

xConfiguration NetworkServices Telnet Mode: On

SSHSSH は安全な TCP/IP 接続であり、コーデックではデフォル

トで有効になっています。これは無効にすることができます。SSH を介して API にアクセスするには、PuTTY などの SSH クライアントが必要です。

HTTP/HTTPSHTTP/HTTPS はコネクションレス型プロトコルなので、永続的な接続は確立されません。HTTP 経由で API と通信するには、さまざまな方法があります。


HTTP および HTTPS サービスをイネーブルまたはディセーブルにするには、コーデックで次の設定を行います。これらの設定を変更したら、デバイスをリブートする必要があります。

xConfiguration NetworkServices HTTP Mode:

xConfiguration NetworkServices HTTPS Mode:

接続中（Connecting）

お使いの Web ブラウザでコーデックの IP アドレスまたはホスト名を入力することによって、API を検査することができます。Web インターフェイスで、メニューセクションの [システム設定（System Configuration）] > [API] > [XML API] で API マニュアルを参照できます。HTTP POST メソッドおよび GET メソッドは、コマンドを実行してコーデックからのフィードバックを取得する際に使用します。これについては、このドキュメントの「「HTTP の使用」、28 ページ」で説明します。



例：terminal モードでの Layout コマンド

xCommand Video Layout AssignCall CallId: 2 LayoutId: 1

API 出力xPreferences は RS-232、Telnet、SSH セッションの設定を行

うために使用されます。

出力モード• Terminal：回線ベースの制御システムで使用するための回

線ベース出力• XML：XML を認識する制御システムで使用するための XML

出力 • JSON：JSOM フォーマットは、Web ベースシステムとの

統合時に役立ちます。

デフォルトの出力モードは terminal です。これを変更するには、各セッションの設定を個別に定義する必要があります。このガイドの例は terminal モードの例です。

出力モードを XML に設定するには、次のコマンドを実行します。xPreferences outputmode xml

terminal モードに戻すには、次のコマンドを実行します。xPreferences outputmode terminal

例：XML モードでの Layout コマンド

21



コマンドラインの使用法

ヘルプ

サポートされているすべてのトップレベルコマンドのリストを取得するには、RS-232、Telnet、または SSH（例 1）を使用して TelePresence System に接続した後で、? または help を入力します。

Bye

bye コマンドを入力すると、コマンドラインインターフェイスが閉じます。

例 1：

? - User Commands -

help xcommand xconfiguration xevent xfeedback xgetxml xdocument xpreferences xtransaction xstatus bye echo log systemtools OK

API コマンド

xConfiguration

コンフィギュレーションは、システム名やネットワーク設定などのシステム設定です。これらの設定は次回起動する際にも維持されます。「コンフィギュレーション」、24 ページを参照してください。

xCommand

コマンドは、コーデックに、番号のダイヤリングや電話帳の検索などのアクションの実行を指示します。「コマンド」、24 ページを参照してください。

xStatus

ステータスには、接続されたコール数、ゲートキーパー登録のステータス、接続された入力ソース数と出力ソース数といったコーデックの現在の状態が含まれます。「ステータス」、24 ページを参照してください。

xFeedback

Feedback コマンドは、設定およびステータスの階層のどの部分をモニタするか指定するために使用されます。フィードバックは、指定された RS 232、Telnet、SSH セッションだけに対して実行されます。複数のセッションでコーデックに接続している場合は、セッションごとにフィードバックを個別に定義する必要があります。

「フィードバックメカニズム」、26 ページを参照してください。

xPreferences

xPreferences コマンドは RS-232、Telnet、SSH セッションの設定を行うために使用されます。「API 出力」、21 ページを参照してください。

Echo

エコーが On に設定されている場合、テキストをコマンドラインインターフェイスに入力するとキー入力が表示されます。

エコーが Off に設定されている場合、テキストをコマンドラインインターフェイスに入力する際にユーザ入力は表示されません。

xEvent

xEvent コマンドは、フィードバックに使用できるイベントに関する情報を返します。「イベント」、25 ページを参照し

てください。

xGetxml

xGetxml 要求は、要求に付加されるロケーションパラメータに基づいて XML ドキュメントを返します。式と一致する要素

（またはドキュメント全体）が返されます。「フィードバックメカニズム」、26 ページを参照してください。

その他のコマンド

systemtools

systemtools コマンドは、管理制御および診断のためのコマンドラインツールのセットです。これらのコマンドは、シスコテクニカルサポートと連携して高度なトラブルシューティングを行うときに使用できます。systemtools はプログラミング API の一部ではありません。「SystemTools コマンド」、166 ページを参照してください。

Log

log コマンドは、詳細なログを有効にするために使用します。システムのデバッグ目的でのみ使用します。



コマンドラインショートカット時間を節約するショートカットがいくつかあります。これらのショートカットは、クライアントでサポートされている場合に利用できます。

• タブを使用したコマンドと引数の入力。• 上向き矢印キーと下向き矢印キーを使用したコマンド履歴

の移動。• ：行の先頭へジャンプします。• ：行の末尾へジャンプします。• ：コマンド履歴のインクリメンタル検索。• ：現在の行の内容を消去します。

検索// を使用すると、ステータスまたはコンフィギュレーション階層内のあらゆる場所の要素を検索できます（例 1）。

複数の // を組み合わせることもできます（例 2）。

注：検索のショートカットは、API を調べる場合には適切に動作しますが、アプリケーションでは使用しないでください。新しいファームウェアリリースにアップグレードする際には、コマンドが曖昧にならないようにするため、常にパス全体を使用することを推奨します。

例 1：OUT および HDMI で始まる単語を含むすべての設定をリストする

xconfiguration //out//hdmi*c xConfiguration Audio Output HDMI 1 Level: 0*c xConfiguration Audio Output HDMI 1 Mode: On*c xConfiguration Audio Output HDMI 2 Level: 0*c xConfiguration Audio Output HDMI 2 Mode: Off** end

例 2：接続されているすべての入力ソースと出力ソースの解像度の幅を取得する

xStatus //vid//res//wid*s Video Input Source 1 Resolution Width: 1920*s Video Input Source 2 Resolution Width: 0*s Video Input Source 3 Resolution Width: 0*s Video Input Source 4 Resolution Width: 0*s Video Output Connector 1 Resolution Width: 1920*s Video Output Connector 2 Resolution Width: 1280*s Video Output Connector 3 Resolution Width: 1280** end

値のタイプおよびフォーマットシステムは、次の値のタイプをサポートします。

• 整数値：整数値入力の有効な範囲を定義します、x = min 値、y = max 値。

• リテラル値：特定の設定の有効な値を定義します。

• 文字列値：この設定の有効な入力は、最短長が x 文字、最大長が y 文字の文字列であることを定義します。文字列にはさらに

フォーマットと長さを指定する規則を定義できます。

スペースを含む入力値は引用符で囲む必要があります。

設定とコマンドでは、スペースを含む値はすべて引用符で囲む必要があります。スペースのない値を引用符で囲む必要はありません。

例：正：xCommand dial number: “my number contains spaces”正：xCommand dial number: 12345誤：xCommand dial number: my number contains spaces

大文字と小文字の区別

すべてのコマンドでは大文字と小文字は区別されません。次に示すコマンドはすべて有効です。

XCOMMAND DIAL NUMBER: [email protected] dial number: [email protected] Dial Number: [email protected]



コマンドコマンドは、コーデックに、番号のダイヤリングや電話帳の検索などのアクションの実行を指示します。すべてのコマンドは

プレフィックス xCommand で始まり、その後にコマンドパスが続きます。

コマンドラインに xCommand ? と入力すると、トップレベルのコマンドがすべてリストされます。

すべてのコマンドとそのパラメータのリストを表示するには、コマンドラインに xCommand ?? と入力します。

コマンド引数はキーと値のペアです。

xCommand の発行時には、コマンドは 1 つの引数と 1 つの必須パラメータで構成されます。このガイドでは、すべての xCommand のコマンド使用法を、必須パラメータおよびオプションパラメータを含めて説明しています。オプションパラメータはカッコで囲まれています。

例：xCommand Dial Number: 123

• xCommand はコマンドプレフィックスです。実行するコマンドは Dial です。

• 上記の例には 1 つの引数（Number: 123）が含まれています。Number はキーであり、123 はその値です。キー/値のペアは「:」で区切られています。

コンフィギュレーション設定は、起動後にも維持されるシステム設定です。コマンドと同様に、設定は階層構造で編成されています。

コマンドラインに xConfiguration ? と入力すると、最上位レベルの設定がすべてリストされます。

xConfiguration ?? と入力すると、すべての設定とその値スペースがリストされます。

xConfiguration と入力すると、すべての設定とその現在の値がリストされます。一部の設定だけをリストするには、xConfiguration とその後に設定パスの 1 つまたは複数の部分を入力します。

例：Set the H323 Alias ID

次のように入力します。xConfiguration H323 Profile 1 H323Alias ID: “[email protected]”

例：H323 エイリアス ID を取得する

次のように入力します。xConfiguration H323 Profile 1 H323Alias ID

結果：*c xConfiguration H323 Profile 1 H323Alias ID: “[email protected]”**end

ステータスステータスには、接続されたコール数、ゲートキーパー登録のステータス、接続された入力ソース数と出力ソース数といったコーデックの現在の状態が含まれます。

コマンドラインに xStatus ? と入力すると、トップレベルのステータスがすべてリストされます。

xStatus と入力すると、すべてのステータスとその現在の値がリストされます。

一部のステータスだけをリストするには、xstatus とその後にステータスパスの該当する部分（アドレス表現）を入力します。

xStatus



例 1：Outgoing Call Indication

Outgoing Call Indication は、発信コールのダイヤル時に報告されるイベントです。コールに割り当てられた CallId が返されます。

*e OutgoingCallIndication CallId: x** end

例 2：Call Disconnect

Call Disconnect は、コールの接続解除時に報告されるイベントです。接続解除されたコールの CallId と、コールの接続解除理由が返されます。

*e CallDisconnect CallId: x CauseValue: 0 CauseString: “” CauseType: LocalDisconnect OrigCallDirection: “outgoing”** end

例 3：Call Successful

Call Succesful は、コールが正常に接続したとき、つまりすべてのチャネルが確立されたときに報告されるイベントです。

*e CallSuccessful CallId: 132 Protocol: “h223” Direction: “outgoing” CallRate: 768 RemoteURI: “h223:[email protected]” EncryptionIn: “Off” EncryptionOut: “Off”** end

例 4：FECC Action request

FECC Action request は、遠端から FECC コマンドが送信されるときに報告されるイベントです。

*e FeccActionInd Id: 132 Req: 1 Pan: 1 PanRight: 1 Tilt: 0 TiltUp: 0 Zoom: 0 ZoomIn: 0 Focus: 0 FocusIn: 0 Timeout: 300 VideoSrc: 0 m: 0** end

例 5：TString message received

TString message received は、遠端から TString メッセージが送信されたときに報告されるイベントです。

*e TString CallId: 132 Message: “ee”** end

例 6：SString message received

SString message received は、遠端から SString メッセージが送信されたときに報告されるイベントです。

*e SString String: “ee” Id: 132** end

イベントイベントは、フィードバックに使用可能なイベントに関する情報を返します。この概要では、API で使用できるイベントのい

くつかの例を示します。

サポートされるイベントのタイプの概要を取得するには、xEvent の後に ?、??、または help を入力します。

• xEvent ? トップレベルのイベントをリストします。• xEvent ?? 使用可能なすべてのイベントをリストします。• xEvent help トップレベルのイベントをリストします。

イベントの結果は、コーデックの状態によって異なります。



例 1：Microphones Mute ステータス

端末での照会xStatus Audio Microphones Mute*s Audio Microphones Mute: Off** end

同等のフィードバック式 xFeedback register /Status/Audio/Microphones/Mute

例 2：すべてのビデオ入力コネクタの名前。

端末での照会xConfiguration Video Input Connector Name*c xConfiguration Video Input Connector 1 Name: “NameA”*c xConfiguration Video Input Connector 2 Name: “NameB”*c xConfiguration Video Input Connector 3 Name: “NameC”*c xConfiguration Video Input Connector 4 Name: “NameD”*c xConfiguration Video Input Connector 5 Name: “NameE”** end

同等のフィードバック式 xFeedback register /Configuration/Video/Input/Connector/Name

例 3：ビデオ入力コネクタ 3 の名前。

端末での照会xConfiguration Video Input Connector 3 Name *c xConfiguration Video Input Connector 3 Name: “NameC”** end

同等のフィードバック式 xFeedback register /Configuration/Video/Input/Connector[@item=’3’]/Name

フィードバックメカニズムアプリケーションとコーデックの間で状態を確実に同期できるソリューションを開発するには、コーデックの状態変更を報告するための通知システムをセットアップする必要があります。

API では次の通知がサポートされています。

• 設定変更 • ステータス変更 • イベント通知

ユーザがコーデックに対して通知の送信を明示的に指示していない場合、これらの通知は送信されません。ユーザはアプリケーションに必要なすべてのフィードバックを登録する必要があります。このためには、フィードバック式を登録します。

フィードバック式を登録する方法は、使用している接続方式に応じて異なります。

HTTP を使用している場合のフィードバック処理方法は、ここで説明する方法とは若干異なります。詳細については、「HTTP 経由でのコーデックからのフィードバック」、 29 ページを参照してください。

フィードバック式フィードバックの登録時に使用する式は、XPath 言語のバリエーションです。この言語は、XML ドキュメントからノードを選択する方法を記述します。CE ソフトウェアには 3 つの主な

フィードバックドキュメントがあります。

フィードバック登録の構文は次のとおりです。 xFeedback register

xFeedback register /Status を発行してすべてのステータスフィードバックを登録することは絶対に行わないでください。

すべての設定変更を登録するには、xFeedback register /Configuration を使用する方法が安全です。これは、設定変更はそれほど頻繁に発生しないためです。

いくつかの例から、この情報を使用してフィードバック式を作成する方法を把握できます。式を検証する適切な方法として、

ブラウザで http:///getxml?location=path にアクセスするか、または端末から xgetxml を実行し、出力が、フィードバック対象のノードと一致していることを確認する方法があります。

警告：コーデックは、特にコールの接続時と接続解除時などに大量のフィードバックを生成することがあります。したがって、必要なフィードバックだけを登録してください。

xFeedback register /Status を発行してすべてのステータスフィードバックを登録することは絶対に行わないでください。このようにすると、制御アプリケーションに処理できない大量のデータが渡され、これが原因で動作が遅くなったり、予期しない動作が発生したりします。

マニュアル API コマンドパス

ステータス xStatus /Status

設定（Configuration）

xConfiguration /Configuration

イベント xEvent /Event



端末接続

フィードバック登録の管理

フィードバック式を登録、リスト、および登録解除するには、xFeedback コマンドとその対応するサブコマンドを使用します。

登録された式は、現在アクティブな接続でのみ有効です。2 つの Telnet セッションを開き、1 つのセッションでフィードバックを取得するために登録した場合、もう 1 つのセッションではフィードバックを受信しません。つまり、セッションとの接続を解除する場合には、再接続後にすべての式を再度登録する必要があります。

最大 38 個の式を登録できます。

フィードバック出力

フィードバック出力は、xConfiguration コマンドおよび xStatus コマンドを使用してシステムに対して照会を行う場合と同じです。例えば、コマンドラインで xStatus Standby Active コマンドを発行した場合の結果は次のようになります。

*s Standby Active: On** end

ステータス変更のフィードバックに登録した場合、システムがスタンバイモードに移行した時にユーザが受け取るフィードバックは完全に同一なものになります。

*s Standby Active: On** end

つまり、デバイスに対してプログラミングする場合、扱う必要があるフォーマットは 1 つだけです。

例：フィードバック登録の管理

A：フィードバック式を登録する。

入力： xFeedback register /Status/Audio結果： ** end

OK

入力： xFeedback register /Event/CallDisconnect結果： ** end

OK

入力： xFeedback register /Configuration/Video/ MainVideoSource

結果： ** end OK

B：現在登録されている式をリストする。

入力： xFeedback list結果： /Configuration/Video/MainVideoSource

/Event/CallDisconnect /Status/Audio ** end OK

C：フィードバック式を登録解除する。

入力： xFeedback deregister /Event/CallDisconnect結果： ** end

OK

入力： xFeedback deregister /Status/Audio結果： ** end

OK

D：新しいフィードバック式をリストする。

入力： xFeedback list結果： /Configuration/Video/MainVideoSource

** end OK



HTTP の使用コーデックでは、HTTP および HTTPS 経由でのコマンドと設定の送信がサポートされています。設定とステータスをこの方法で取得することもできます。このインターフェイスでは、コマンドラインと同じ API が公開されますが、この API は XML 形式です。

URL チートシート

次の表に、HTTP 経由で API にアクセスする際に使用する主要な URL を示します。

方法 URL 説明

GET http:///status.xml 完全なステータスドキュメント

GET http:///configuration.xml 完全な設定ドキュメント

GET http:///command.xml 完全なコマンドドキュメント

GET http:///valuespace.xml 完全な値スペースドキュメント

GET http:///getxml?location= パスに基づいてドキュメントを取得します

POST http:///putxml HTTP 本体に含まれる設定とコマンド

ステータスと設定の取得

例 1：コーデックのすべてのステータスエントリを取得する。http:///getxml?location=/Status

例 2：コーデックのオーディオステータスだけを取得する。http:///getxml?location=/Status/Audio

例 3：コーデックのすべての設定を取得する。http:///getxml?location=/Configuration

例 4：コーデックのすべてのビデオの設定を取得する。http:///getxml?location=/Configuration/Video

コマンドと設定の送信

HTTP POST を使用する方法設定とコマンドをコーデックに送信する際には、HTTP ヘッダーの Content-Type が text/xml に設定されていること

（Content-Type: text/xml）が重要です。POST の本体には XML コンテンツが含まれている必要があります。

例 1：システム名の変更。

要求POST /putxml HTTP/1.1Content-Type: text/xml

newName

例 2：カメラの位置設定。

要求POST /putxml HTTP/1.1Content-Type: text/xml

1 200 200

応答HTTP/1.1 200 OKContent-Type: text/xmlContent-Length: 91



HTTP 経由でのコーデックからのフィードバックコーデックから通知を受信するには、HTTP フィードバック式を登録する必要があります。このように登録すると、コーデックは ServerUrl に指定された URL に、HTTP POST を使用してフィードバックメッセージを送信します。つまり、アプリケーションがコーデックからアップデートを受信するためには、HTTP サーバが稼働している必要があります。

フィードバックの登録登録コマンドは xCommand HttpFeedback Register です。ここではこのコマンドの構文と引数について説明します。

HttpFeedback Register の構文：

xCommand HttpFeedback Register FeedbackSlot: ServerUrl(r): Expression: Expression: Expression: Expression: Expression: Expression: Expression: Expression: Expression: Expression: Expression: Expression: Expression: Expression: Expression:

HttpFeedback Register の引数：

FeedbackSlot：コーデックは、HTTP フィードバックを要求するサーバの最大 4 つのスロットを登録できます。そのいずれかに登録することを設定します。

注：Cisco TelePresence Management Suite（TMS）を使用する環境では FeedbackSlot 3 を使用しないようにしてください。これは、TMS では、この式を登録する際に FeedbackSlot 3 が使用されるためです。

ServerUrl：コーデックが HTTP フィードバックメッセージを送信する送信先 URL。

Expression 1 ～ 15：フィードバックを受信する式を登録します。式の形式の詳細については、「フィードバックメカニズム」、26 ページを参照してください。

例：設定変更、接続解除イベント、およびコールステータス変更のフィードバックの登録

1 http://127.0.0.1/ myhttppostscripturl /Configuration /Event/ CallDisconnect /Status/Call

フィードバック出力

登録されている HTTP サーバにコーデックが変更を通知する場合、本体にはポーリング時と同じ XML が含まれます。ただし、若干異なる点が 1 つあります。root-node には、Identification

ノードと、通知の送信元コーデックを指定する子が含まれています。つまり、1 つの HTTP サーバ URI で複数のコーデックを処理できます。

例：音量が変更された場合。

integrator 00:00:de:ad:be:ef 192.168.1.100 Cisco Codec Cisco Codec C90 TC6.0.0.199465 101401-5 [08] PH0000000 60



terminal モードから XML への変換

コマンドの変換

XML コマンドの構造は terminal コマンドの構造と同じですが、階層を表現するために親子関係を使用します。次の例で、この構造を示します。

例 1：コールをセットアップする。

TerminalxCommand Dial Number: “12345” Protocol: H323

XML

12345 H323

例 2：コールにビデオレイアウトを割り当てる。

TerminalxCommand Video Layout AssignCall CallId: 2 LayoutId: 1

XML

2 1

設定の変換

xConfiguration から XML への変換はコマンドと似ていますが、設定では、配列の索引を指定する特殊属性項目 ”NN” が追加され

ています。

例：ビデオ入力コネクタ 2 の入力ソースタイプを設定する。

TerminalxConfiguration Video Input Connector 2 InputSourceType: camera

XML

camera



ベストプラクティスCisco SX シリーズ API のプログラミングでのベストプラクティスの一部について説明します。

リモートコントロールエミュレーションを回避するxCommand UserInterface OSD Key Click コマンドと xCommand UserInterface OSD Key Press コマンドを使用しないことを強く推奨します。これらのコマンドは API で使用できますが、ダイレクトコマンドを使用することを推奨します。これにより、統合での後方互換性が確保されます。オンスクリーンディスプレイではなくコーデックに対してプログラミングします。

コマンドを省略せずに使用するプログラミングでは常に完全なコマンドを使用してください。たとえば xconf vid ではなく xConfiguration Video を常に使用します。ショートカットはコマンドラインから API 内を検索する際に使用できますが、プログラミングには使用できません。これは、API にコマンドが追加された場合にコードが曖昧になる可能性があるためです。

不要なフィードバックを登録しない登録しているフィードバックの数が多すぎると、制御アプリケーションで輻輳が発生する可能性があります。現在のバージョンではフィードバックの量が適切であるように見えても、今後のリリースでフィードバックの量が増加することがあります。



第 3 章

xConfiguration コマンド



[音声（Audio）] 設定： ............................................................................................................................... 36xConfiguration Audio DefaultVolume ...........................................................................................................36

xConfiguration Audio SoundsAndAlerts RingTone .......................................................................................36

xConfiguration Audio SoundsAndAlerts RingVolume ...................................................................................36

xConfiguration Audio Input Line [1] VideoAssociation MuteOnInactiveVideo ...............................................36

xConfiguration Audio Input Line [1] VideoAssociation VideoInputSource ....................................................37

xConfiguration Audio Input Microphone [1..2] EchoControl Mode ...............................................................37

xConfiguration Audio Input Microphone [1..2] EchoControl NoiseReduction ...............................................37

xConfiguration Audio Input Microphone [1..2] EchoControl Dereverberation ...............................................37

xConfiguration Audio Input Microphone [1..2] Level ....................................................................................38

xConfiguration Audio Input Microphone [1..2] Mode ...................................................................................38

カメラ設定： ........................................................................................................................................... 38xConfiguration Cameras Camera [1] Backlight DefaultMode .......................................................................38

xConfiguration Cameras Camera [1] Brightness Mode ................................................................................38

xConfiguration Cameras Camera [1] Brightness DefaultLevel .....................................................................39

xConfiguration Cameras Camera [1] Focus Mode .......................................................................................39

xConfiguration Cameras Camera [1] Gamma Mode ....................................................................................39

xConfiguration Cameras Camera [1] Gamma Level .....................................................................................39

xConfiguration Cameras Camera [1] Mirror .................................................................................................40

xConfiguration Cameras Camera [1] Whitebalance Mode ...........................................................................40

xConfiguration Cameras Camera [1] Whitebalance Level ............................................................................40

xConfiguration Cameras Preset TriggerAutofocus .......................................................................................40

会議設定：............................................................................................................................................... 41xConfiguration Conference AutoAnswer Mode ...........................................................................................41

xConfiguration Conference AutoAnswer Mute ............................................................................................41

xConfiguration Conference AutoAnswer Delay ...........................................................................................41

xConfiguration Conference DefaultCall Protocol .........................................................................................41

xConfiguration Conference DefaultCall Rate ...............................................................................................42

xConfiguration Conference DoNotDisturb DefaultTimeout ..........................................................................42

xConfiguration Conference Encryption Mode ..............................................................................................42

xConfiguration Conference FarEndControl Mode ........................................................................................42

xConfiguration Conference MaxReceiveCallRate ........................................................................................43

xConfiguration Conference MaxTransmitCallRate .......................................................................................43

xConfiguration Conference MaxTotalReceiveCallRate .................................................................................43

xConfiguration Conference MaxTotalTransmitCallRate ................................................................................43

xConfiguration Conference MultiStream Mode ............................................................................................44

H323 設定： ............................................................................................................................................ 44xConfiguration H323 Authentication Mode ..................................................................................................44

xConfiguration H323 Authentication LoginName .........................................................................................44

xConfiguration H323 Authentication Password ...........................................................................................45

xConfiguration H323 CallSetup Mode .........................................................................................................45

xConfiguration H323 Encryption KeySize ....................................................................................................45

xConfiguration H323 Gatekeeper Address ..................................................................................................45

xConfiguration H323 H323Alias E164 .........................................................................................................46

xConfiguration H323 H323Alias ID ..............................................................................................................46

xConfiguration H323 NAT Mode .................................................................................................................46

xConfiguration H323 NAT Address .............................................................................................................47

xConfiguration コマンドの説明この章にはすべての xConfiguration コマンドが収録されています。例では、デフォルト値または値の例のいずれかを示します。

定期的にシスコの Web サイトにアクセスして、マニュアルの最新版をチェックすることをお勧めします。参照先：http://www.cisco.com/go/sx-docs




ネットワーク設定： ................................................................................................................................... 47xConfiguration Network [1] DNS Domain Name ..........................................................................................47

xConfiguration Network [1] DNS Server [1..3] Address ...............................................................................47

xConfiguration Network [1] IEEE8021X Mode .............................................................................................48

xConfiguration Network [1] IEEE8021X TlsVerify .........................................................................................48

xConfiguration Network [1] IEEE8021X UseClientCertificate .......................................................................48

xConfiguration Network [1] IEEE8021X Identity ...........................................................................................48

xConfiguration Network [1] IEEE8021X Password .......................................................................................49

xConfiguration Network [1] IEEE8021X AnonymousIdentity ........................................................................49

xConfiguration Network [1] IEEE8021X Eap Md5 ........................................................................................49

xConfiguration Network [1] IEEE8021X Eap Ttls ..........................................................................................49

xConfiguration Network [1] IEEE8021X Eap Tls ...........................................................................................50

xConfiguration Network [1] IEEE8021X Eap Peap .......................................................................................50

xConfiguration Network [1] IPStack .............................................................................................................50

xConfiguration Network [1] IPv4 Assignment ..............................................................................................50

xConfiguration Network [1] IPv4 Address ....................................................................................................51

xConfiguration Network [1] IPv4 Gateway ...................................................................................................51

xConfiguration Network [1] IPv4 SubnetMask .............................................................................................51

xConfiguration Network [1] IPv6 Assignment ..............................................................................................51

xConfiguration Network [1] IPv6 Address ....................................................................................................52

xConfiguration Network [1] IPv6 Gateway ...................................................................................................52

xConfiguration Network [1] IPv6 DHCPOptions ...........................................................................................52

xConfiguration Network [1] MTU .................................................................................................................52

xConfiguration Network [1] QoS Mode ........................................................................................................53

xConfiguration Network [1] QoS Diffserv Audio ...........................................................................................53

xConfiguration Network [1] QoS Diffserv Video ...........................................................................................53

xConfiguration Network [1] QoS Diffserv Data .............................................................................................53

xConfiguration Network [1] QoS Diffserv Signalling .....................................................................................54

xConfiguration Network [1] QoS Diffserv ICMPv6 .......................................................................................54

xConfiguration Network [1] QoS Diffserv NTP .............................................................................................54

xConfiguration Network [1] RemoteAccess Allow .......................................................................................54

xConfiguration Network [1] Speed ..............................................................................................................55

xConfiguration Network [1] VLAN Voice Mode ............................................................................................55

xConfiguration Network [1] VLAN Voice VlanId ...........................................................................................55

NetworkServices 設定： .......................................................................................................................... 56xConfiguration NetworkServices CDP Mode ...............................................................................................56

xConfiguration NetworkServices H323 Mode .............................................................................................56

xConfiguration NetworkServices HTTP Mode .............................................................................................56

xConfiguration NetworkServices NTP Mode ...............................................................................................56

xConfiguration NetworkServices NTP Server [1..3] Address .......................................................................57

xConfiguration NetworkServices SIP Mode .................................................................................................57

xConfiguration NetworkServices SNMP Mode ............................................................................................57

xConfiguration NetworkServices SNMP Host [1..3] Address .......................................................................57

xConfiguration NetworkServices SNMP CommunityName ..........................................................................58

xConfiguration NetworkServices SNMP SystemContact .............................................................................58

xConfiguration NetworkServices SNMP SystemLocation ............................................................................58

xConfiguration NetworkServices SSH Mode ...............................................................................................58

xConfiguration NetworkServices Telnet Mode .............................................................................................59

xConfiguration NetworkServices WelcomeText ...........................................................................................59

周辺機器（Peripherals）設定： .................................................................................................................. 59xConfiguration Peripherals Profile TouchPanels ..........................................................................................59

Phonebook 設定： ................................................................................................................................... 60xConfiguration Phonebook Server [1] ID .....................................................................................................60

xConfiguration Phonebook Server [1] Type .................................................................................................60

xConfiguration Phonebook Server [1] URL ..................................................................................................60

プロビジョニング設定： ............................................................................................................................ 61xConfiguration Provisioning Connectivity .....................................................................................................61

xConfiguration Provisioning Mode ........................................................................................................

Application Programmer Interface API - Cisco...このガイドは、TC ソフトウェアの...

Documents

Transcript of Application Programmer Interface API - Cisco...このガイドは、TC ソフトウェアの...