Cisco TelePresence MX700 および MX800 API (CE8.0) リファレンスガイド

(1)

コラボレーションエンドポイントソフトウェア 8.0 2015 年 11 月

Application Programmer Interface （ API ）

リファレンスガイド

(2)

このマニュアルの内容

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

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

URL：http://www.cisco.com/go/mx-docs

(3)

第 1 章

はじめに

(4)

このマニュアルについて

このマニュアルは、コラボレーションエンドポイントソフトウェアの Application Programmer Interface（API）の概要を紹介するもので、次の製品のコマンドラインコマンドのリファレンスガイドとして役立ちます。

• Cisco TelePresence MX700 および MX800

ユーザドキュメンテーションのダウンロード

ユーザドキュメンテーションはシスコの Web サイトからダウンロードできます：http://www.cisco.com/go/mx-docs シスコの Web サイトにあるドキュメンテーションの検索ガイドラインについては、付録の「シスコ Web サイト内のユーザドキュメンテーション」を参照してください。

(5)

新機能および改善点

製品

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 はサポートされません。

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

Multistream 機能により、ビデオシステムは同時にさまざまな解像度で複数のビデオストリームを送受信できます。ビデオシステムは、利用可能なすべての画面に適合するようにローカルでレイアウトを構成します。

参加者が多い会議では、この機能によってレイアウト制御に関するユーザエクスペリエンスが向上します。複数画面システム

では、Multistream 対応の会議への参加時に画面すべてを利用

できます。また、コンテンツを表示および共有する際のレイアウトが、すべてのシステムで改善されています。

Multistream は、このリリースではデフォルトでオフになっています。エクスペリエンスを最適化するため、Cisco UCM 11.0.0 以降および最新バージョンの TelePresence Server と TelePresence Conductor の利用が推奨されます。

マイク LED の動作

マイクとタッチ 10 の LED の動作が変更されました。次のシナ

このバージョンの新機能

ここでは、シスココラボレーションエンドポイントソフトウェアバージョン 8.0（CE8.0）で TC7.3 以降に追加または変更されたシステム設定、および新しい機能の概要について説明します。

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

詳細については、ソフトウェアのリリースノートを参照してください。

 http://www.cisco.com/c/en/us/support/

collaborationendpoints/telepresence-mx-series/

tsd-productssupport-series-home.html

アップグレードする際は、事前に CE8.0 のアップグレード要件を考慮することが重要です。要件を考慮せずに CE8.0 にアップグレードすると、導入が機能されずにダウングレードが必要になる場合もあります。

(6)

• Web インターフェイスで VU メーターをアクティブ化して音量レベルをテストしている間。

色の意味（緑色がアクティブ、赤色がミュート）には変更がありません。

解像度の変更

コラボレーションエンドポイントソフトウェアは、16:9 または 16:10 の解像度に対応したディスプレイのみをサポートします。

ローカルおよびコール中の両方で、WUXGA（1920 X 1200）解像度のプレゼンテーション共有が可能です。

リモートモニタリング

ビデオシステムにリモートモニタリングオプションキーがインストールされている場合、セキュリティ強化のため、ビデオシステム

の Web インターフェイスからはローカルおよび遠端ビデオストリームのスナップショットのみを作成できます。

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

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

削除された機能

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

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

• TC コンソールを使用したカスタムビデオレイアウトおよびビデオ構成はサポートされません。

• MediaNet はサポートされなくなりました。

(7)

CE8.0 での xConfiguration の変更

新しい構成

Conference MultiStream Mode Proximity Mode

Proximity Services CallControl

Proximity Services ContentShare FromClients Proximity Services ContentShare ToClients Video DefaultMainSource

削除された設定

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

Audio Input HDMI [n] VideoAssociation MuteOnInactiveVideo Logging Mode HDMI [n] VideoAssociation VideoInputSource Audio Microphones Mute Enabled

Cameras Camera [n] DHCP Cameras Camera [n] Flip Cameras Camera [n] IrSensor

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

FacilityService *

H323 Profile [1] Gatekeeper Discovery H323 Profile [1] PortAllocation Audio Input

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 Profile [1] Line

(8)

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 MenuLanguage

Time OlsonZone

UserInterface OSD EncryptionIndicator UserInterface OSD LanguageSelection UserInterface OSD LoginRequired 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 Connector [n] SignalType

Video Layout DisableDisconnectedLocalOutputs Video Layout LocalLayoutFamily

Video Layout PresentationDefault View Video Layout RemoteLayoutFamily Video Layout ScaleToFrame

Video Layout ScaleToFrameThreshold Video Layout Scaling

Video OSD EncryptionIndicator Video OSD LanguageSelection

Video OSD LoginRequired

Video Output Connector [n] Location HorizontalOffset Video Output Connector [n] Location VerticalOffset Video Output Connector [n] RGBQuantizationRange Video PIP *

Video Wallpaper

変更された設定

Cameras SpeakerTrack TrackingMode 旧：<Default/Fast>

デフォルト値：Default 新：<Auto/Conservative>

デフォルト値：Auto

Cameras SpeakerTrack Whiteboard Mode 旧：必要なユーザロール：ADMIN 新：必要なユーザロール：USER NetworkServices HTTP Mode

旧：<Off/On>

デフォルト値：On

新：<Off/HTTP+HTTPS/HTTPS>

デフォルト値：HTTP+HTTPS Phonebook Server [n] Type

旧：<VCS/TMS/Callway/CUCM>

デフォルト値：TMS 新：<Off/VCS/TMS/CUCM>

デフォルト値：Off Provisioning Mode

旧：<Off/TMS/VCS/Callway/CUCM/Auto/Edge>

新：<Off/TMS/VCS/CUCM/Auto/Edge>

Standby BootAction

旧：<None/Preset1/Preset2/Preset3/Preset4/Preset5/Preset6/Preset7/Preset8/Preset9/

Preset10/Preset11/Preset12/Preset13/Preset14/Preset15/RestoreCameraPosition/

DefaultCameraPosition>

新：<None/RestoreCameraPosition/DefaultCameraPosition>

(9)

Standby WakeupAction

旧：<None/Preset1/Preset2/Preset3/Preset4/Preset5/Preset6/Preset7/Preset8/Preset9/

Preset10/Preset11/Preset12/Preset13/Preset14/Preset15/RestoreCameraPosition/

DefaultCameraPosition>

新：<None/RestoreCameraPosition/DefaultCameraPosition>

タイムゾーン

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

Video Input Connector [n] InputSourceType

旧：<other/camera/PC/DVD/document_camera/whiteboard>

新：<other/camera/PC/mediaplayer/document_camera/whiteboard>

Video Input Connector [n] PresentationSelection 旧：<Manual/Automatic/OnConnect>

新：<Manual/OnConnect>

Video Output Connector [n] MonitorRole

旧：<Auto/First/Second/PresentationOnly/Third>

新：<Auto/First/Second/PresentationOnly/Third/Recorder>

Video Output Connector [n] Resolution

旧：<Auto/1280_720_50/1280_720_60/1920_1080_50/1920_1080_60>

新：<Auto/1280_720_50/1280_720_60/1920_1080_50/1920_1080_60/1920_1200_50/1 920_1200_60>

名前が変更されたコンフィギュレーション 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 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

(10)

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 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

(11)

CE8.0 での xCommand の変更

新しいコマンド

Camera Preset ActivateDefaultPosition Camera Preset Show

Cameras SpeakerTrack Diagnostics Start Cameras SpeakerTrack Diagnostics Stop Proximity Services Activate

Proximity Services Deactivate SystemUnit OptionKey Remove SystemUnit OptionKey RemoveAll

UserManagement User Passphrase Change UserManagement User Passphrase Set

削除されたコマンド

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

Audio Sound Play Audio Sound Stop Audio VuMeter * Camera PanTiltReset

Camera PositionActivateFromPreset Camera PositionSet

Camera Preset Snapshot * Camera ReconfigureCameraChain CamCtrlPip

Experimental *

Logging ExtendedLogging * Message Echo

Message FarendMessage Peripherals ManualUpgrade 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 Add

Video Layout Assign Video Layout AssignCall Video Layout AssignLocalOutput Video Layout AssignPresentation Video Layout Frame *

Video Layout List Video Layout LoadDb

Video Layout PreviewFilmstrip Set Video Layout Remove

Video Layout RemoveAll

(12)

Video Layout UnassignCall Video Layout UnassignLocalOutput Video Layout UnassignPresentation 変更されたコマンド

Call Accept 削除：CallType コールの切断

旧：CallId (r): <0 – 65534>

新：CallId: <0 – 65534>

保留

旧：CallId (r): <0 – 65534>

新：CallId: <0 – 65534>

Camera PositionReset

新：Axis: <All/Focus/PanTilt/Zoom>

Camera Preset Edit

新：DefaultPosition: <False/True>

Camera Preset List 新：CameraId: <1 – 7>

削除：PresetId Camera Preset Store

Cameras SpeakerTrack Whiteboard ActivatePosition 旧：必要なユーザロール：ADMIN

新：必要なユーザロール：USER 旧：WhiteboardId: <0 – 65534>

新：WhiteboardId: <1 – 8>

Cameras SpeakerTrack Whiteboard AlignPosition 旧：必要なユーザロール：ADMIN

新：必要なユーザロール：USER

旧：Distance: <3000 - 15000>

新：Distance: <300 - 1500>

Cameras SpeakerTrack Whiteboard SetDistance 旧：必要なユーザロール：ADMIN

Cameras SpeakerTrack Whiteboard StorePosition 旧：必要なユーザロール：ADMIN

HttpFeedback Deregister

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

旧：必要なユーザロール：ADMIN 新：必要なユーザロール：USER Peripherals List

旧：Type: <All/BluetoothHeadset/ControlSystem/ISDNLink/Other/TouchPanel>

新：Type: <All/ControlSystem/ISDNLink/Other/TouchPanel>

Presentation Stop

新：PresentationSource: <1 – 4>

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

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

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

(13)

UserManagement User Passphrase Set 新：YourPassphrase: <S: 0, 255>

名前が変更されたか、または置き換えられたコマンドブート

新しい名前：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 *

旧：Year: <2008..2037>

新：Year: <2015..2037>

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

(14)

CE8.0 での xStatus の変更

新しいステータス

Audio Output LocalOutput [n] VolumeControlled 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 <path> * は、xStatus <path> で始まるすべての設定が削除されたことを意味します。

Audio Module [n] * 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）

Cameras SpeakerTrack Whiteboard [n] *

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（旧 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

(15)

Provisioning Server

Provisioning Software PreviousUpgrade *

Provisioning Software UpgradeStatus SecondsUntilUpgrade RoomPreset [n] *（旧 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 UserInterface OSD Mode UserInterface OSD Output Video Input LastConnectedSource Video Layout *

変更されたステータス Call [n] Protocol

旧：文字列

新：<H320/H323/SIP>

新：TemperatureCheck、AudioInternalSpeakerDisabled、および ContactInfoMismatch を値スペースに追加

H323 Mode Status 旧：文字列

新：<Enabled/Disabled>

Peripherals ConnectedDevice [n] Status 旧：<Connected/ResponseTimedOut>

新：<Connected/ResponseTimedOut/Unpairing/LostConnection>

Peripherals ConnectedDevice [n] Type

旧：<BluetoothHeadset/Byod/Camera/ControlSystem/ISDNLink/Other/SpeakerTrack Byod/

TouchPanel>

新：<Byod/Camera/ControlSystem/ISDNLink/Other/SpeakerTrack Byod/TouchPanel>

Peripherals ConnectedDevice [n] UpgradeStatus 旧：<Downloading/Failed/Installing/None/Succeeded>

新：<Downloading/Failed/Installing/InstallationReady/None/Succeeded/Rebooting/Retrying/

Aborted/Paused>

Provisioning Status

旧：<AuthenticationFailed/ConfigError/Failed/Idle/NeedConfig/Provisioned>

新：<AuthenticationFailed/ConfigErro/Failed/Idle/NeedConfig/Provisioning/Provisioned>

SystemUnit Software OptionKeys Encryption 旧：文字列

新：<False/True>

SystemUnit Software OptionKeys MultiSite 旧：文字列

新：<False/True>

SystemUnit Software OptionKeys PremiumResolution 旧：文字列

新：<False/True>

(16)

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

(17)

第 2 章

API について

(18)

API の基礎

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

API へのアクセス方法、コマンドラインの使用方法、および API の各用途を確認できます。コーデックで利用できるフィードバック機能の使用方法についても説明します。

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

• コマンド

• コンフィギュレーション

• ステータス

• イベント

これら 4 つのグループは階層構造になっているため、関連機能を簡単に見つけることができます。すべてのコマンド、コンフィギュレーション、およびステータスの一覧は以降の章で確認できます。

API への接続

コーデック API にアクセスするには、いくつかの方法があります。どの方法を選択しても、API の構造は変わりません。お使いのアプリケーションに最適な接続方法を選択してください。接続方法によっては、有効化する前に他の設定も変更する必要があります。開始前に、この項で各方法について確認してください。

次の設定（パスワードを除く）は、Web インターフェイスの System configuration メニューまたはコマンドラインインターフェイスから設定できます。以下の例はすべてコマンドラインインターフェイス向けです。

パスワード

ビデオシステムは完全な資格情報を持つデフォルトのユーザアカウントに提供されます。ユーザ名は admin です。初期状態では、

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

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

コーデックの Web インターフェイスでパスワードを設定できます。

Web ブラウザを開き、アドレスバーにビデオシステムの IP アドレスを入力してログインします。右上隅のユーザ名をクリックし、ドロップダウンメニューで Change password を選択します。

RS-232/シリアル接続

この接続には IP アドレス、DNS、およびネットワークが不要なため、インテグレータ向けの当社製品で最もよく使用される方法の 1 つです。

コーデック設定

シリアル接続で変更可能な設定は、ボーレートおよびログインが必要かどうかの 2 つです。

xConfiguration SerialPort BaudRate:

<9600/19200/38400/57600/115200>

xConfiguration SerialPort LoginRequired: <Off/On>

接続中

注：

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

• デフォルトのボーレートはに設定されています。コーデックは多くのフィードバックを提供する場合があります。したがって、接続はこの速度に維持することをお勧めします。

(19)

Telnet

Telnet は、TCP/IP 分野のシリアルプロトコルと同等と見なすことができます。Telnet はデフォルトでディセーブルになっています。

Telnet を使ってコーデックに接続するには、イネーブルにする必要があります。

Telnet サービスをイネーブルにするには、コーデックで次の設定を行います。この設定変更ではデバイスを再起動する必要はありませんが、変更が反映されるまでに時間がかかる場合もあります。

xConfiguration NetworkServices Telnet Mode: On

SSH

SSH はセキュアな TCP/IP 接続であり、コーデックではデフォルトでイネーブルになっています。これはディセーブルすることもできます。SSH を介して API にアクセスするには、PuTTY などの SSH クライアントが必要です。

HTTP/HTTPS

HTTP/HTTPS はコネクションレス型プロトコルなので、永続的な接続は確立されません。HTTP を介して API と通信するには、いくつかの方法があります。

HTTP および HTTPS サービスをイネーブルまたはディセーブルにするには、コーデックで次の設定を行います。

xConfiguration NetworkServices HTTP Mode:

xConfiguration NetworkServices HTTPS Mode:

接続中

API は、お使いの Web ブラウザでコーデックの IP アドレスまたはホスト名を入力することで確認できま

す。Web インターフェイスでは、メニューセクションの

System Configuration > API > XML API で API ドキュメントを参照できます。HTTP POST および GET メソッドを使用してコマンドを実行し、コーデックからフィードバックを取得します。詳しくは、このマニュアルの「HTTP の使用」、27 ページで説明します。

(20)

例：端末モードでの Layout コマンド

xCommand Video Layout AssignCall CallId: 2 LayoutId: 1

API 出力

xPreferences は、RS-232、Telnet、および SSH セッションの優先順位を設定するために使用します。

出力モード

• 端末：回線ベースの制御システムで使用するための回線ベース出力。

• XML：XML を理解する制御システムで使用するための XML 出力。

• JSON：JSON 形式は Web ベースのシステムと統合する際に便利です。

デフォルトの出力モードは端末です。これを変更するには、各セッションの優先順位を個別に定義する必要があります。このマニュアル内の例は端末モードです。

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

xPreferences outputmode xml

端末モードに戻すには、次のコマンドを発行します。

xPreferences outputmode terminal

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

<Video>

</AssignCall>

</Layout>

</Video>

</Command>

(21)

コマンドラインの使用

ヘルプ

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

Bye

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

例 1：

? - User Commands -

help

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

OK

API コマンド

xConfiguration

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

xCommand

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

xStatus

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

xFeedback

フィードバックコマンドは、コンフィギュレーションおよびステータス階層の監視対象部分を指定するために使用します。フィードバッ

xPreferences

xPreferences コマンドは、RS-232、Telnet、および SSH セッションの優先順位を設定するために使用します。「API 出力」、20 ページを参照してください。

Echo <on/off>

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

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

xEvent

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

xGetxml

xGetxml 要求は、要求に関連付けられたロケーションパラメータに基づいて XML ドキュメントを返します。表現と一致する要素（またはドキュメント全体）が返されます。

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

その他のコマンド

Systemtools

systemtools コマンドは、管理制御および診断に使用される一連のコマンドラインツールです。シスコのテクニカルサポートと併せて、高度なトラブルシューティングに使用できます。systemtools はプログラミング API には属しません。「SystemTools コマン

ド」、178 ページを参照してください。

Log

log コマンドは詳細ログをイネーブルにするために使用します。これは、システムをデバッグする目的でのみ使用されます。

(22)

コマンドラインのショートカット

クライアントでサポートされている場合は、次のように時間を節約するいくつかのショートカットを使用できます。

• タブ補完でコマンドおよび引数を入力する。

• 上下の矢印キーでコマンド履歴を操作する。

• Ctrl+a：コマンドラインの先頭に移動する。

• Ctrl+e：コマンドラインの末尾に移動する。

• Ctrl+r：コマンド履歴をインクリメンタル検索する。

• Ctrl+w：現在のコマンドラインを削除する。

検索

// を使用すると、ステータスまたはコンフィギュレーション階層内のあらゆる場所の要素を検索できます（例 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 Output Connector 1 Resolution Width: 1920

** end

値のタイプおよびフォーマット

システムは、次の値のタイプをサポートします。

• 整数値：<x..y>

整数入力の有効範囲を定義します。x = 最小値、y = 最大値。

• リテラル値：<X/Y/../Z>

特定の設定で使用可能な値を定義します。

• 文字列値：<S: x, y>

この設定の有効な入力が、最小 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] xcommand dial number: [email protected] xCommand Dial Number: [email protected]

(23)

コマンド

コマンドは、番号のダイヤルや電話帳の検索などのアクションの実行をコーデックに指示します。すべてのコマンドはプレフィクス xCommand で始まり、その後にコマンドパスが続きます。

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

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

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

xCommand を発行する場合、コマンドは 1 つの引数と 1 つの必須パラメータで構成されます。このマニュアルでは、必須パラメータとオプションパラメータの両方を使って、すべての xCommand のコマンド使用法について説明します。オプションパラメータはカッコ内に示します。

例：xCommand Dial Number: 123

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

• 例には、Number: 123 という引数が 1 つ含まれています。

Number はキーで、123 がその値です。キーと値のペアは「:」

で区切ります。

コンフィギュレーション

コンフィギュレーションは、起動後も維持されるシステム設定です。

コマンドと同様に、コンフィギュレーションも階層内で構造化されています。

コマンドラインで xConfiguration ? を入力すると、すべてのトップレベルコンフィギュレーションが表示されます。

xConfiguration ?? を入力すると、すべてのコンフィギュレーションとそれぞれの値スペースが表示されます。

xConfiguration を入力すると、すべてのコンフィギュレーションとそれぞれの現在の値が表示されます。一部のコンフィギュレーションのみを表示するには、xConfiguration に続けてコンフィギュレーションパスの部分を 1 つ以上入力します。

例：H323 エイリアス 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 <address expression>

(24)

例 1：発信コールインジケータ

発信コールインジケータは、発信コールのダイヤル時に報告されるイベントです。コールに割り当てられた CallId を返します。

*e OutgoingCallIndication CallId: x

** end

例 2：コール接続解除

コール接続解除は、コールが切断されたときに報告されるイベントです。切断されたコールの CallId と切断の理由を返します。

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

** end 例 3：コール成功

コール成功は、コールが正常に接続された場合、つまりすべてのチャネルが有効で、かつそれらが確立された場合に報告されるイベントです。

*e CallSuccessful CallId: 132 Protocol: “h223”

Direction: “outgoing” CallRate: 768 RemoteURI:

“h223:[email protected]” EncryptionIn:

“Off” EncryptionOut: “Off”

** end

例 4：FECC アクション要求

FECC アクション要求は、遠端から 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 メッセージ

受信した TString メッセージは、遠端から TString メッセージが送信された場合に報告されるイベントです。

*e TString CallId: 132 Message: “ee”

** end

例 6：受信した SString メッセージ

受信した SString メッセージは、遠端から SString メッセージが送信された場合に報告されるイベントです。

*e SString String: “ee” Id: 132

** end

イベント

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

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

• xEvent ? トップレベルイベントを表示します。

• xEvent ?? 使用可能なすべてのイベントを表示します。

• xEvent help トップレベルイベントを表示します。

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

(25)

例 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”

“NameB”

“NameC”

“NameD”

“NameE”

** end

同等のフィードバック表現

xFeedback register /Configuration/Video/Input/

Connector/Name

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

端末クエリ

xConfiguration Video Input Connector 3 Name

“NameC”

** end

フィードバックメカニズム

同期されたアプリケーションとコーデック間の状態を確実に維持できるソリューションを構築するには、コーデックの状態の変更を報告するように通知システムを設定する必要があります。

API は次に関する通知をサポートします。

• 設定変更

• ステータス変更

• イベント通知

これらの通知の送信は、コーデックに対してユーザが明示的に指示しない限り実行されません。ユーザはアプリケーションに必要なすべてのフィードバックに登録する必要があります。これは、フィードバック表現を登録することで実行されます。フィードバック表現を登録する方法は、使用する接続方法によって異なります。

HTTP を使用している場合、フィードバックの処理方法がここで示す方法とは若干異なります。詳細については、

「HTTP を介したコーデックからのフィードバック」、28 ページを参照してください。

フィードバック表現

フィードバックの登録時に使用する表現は、XPath 言語のバリアントです。この言語は XML ドキュメントからノードを選択する方法を

説明します。CE ソフトウェアには 3 つの主要なフィードバックドキュメントが含まれています。

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

xFeedback register <path>

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

設定変更は頻度が高くない可能性があるため、

xFeedback register /Configuration

を使用してすべての設定変更に登録すると安全です。

いくつかの例を見ると、この情報がフィードバック表現の構築にどのように使用されるのかが分かります。表現を確認する場合、ブラウザで http://<ip-address>/getxml?location=path にアクセスするか、端末から

xgetxml <path>

を実行して、フィードバックが必要なノードに出力が一致することを確認する方法を推奨します。

警告：コーデックは、特にコールが接続および接続解除されたときに多くのフィードバックを提供する場合があります。したがって、必要なフィードバックのみに登録してください。

xFeedback register /Status を発行してすべてのステータスフィードバックに登録することは避けてください。すべてに登録すると、制御アプリケーションが過剰な量のデータを処理することになり、速度の低下や予期しない動作を引き起こす可能性があります。

マニュアル API コマンドパスステータス xStatus /Status

設定 xConfiguration /Configuration

イベント xEvent /Event

(26)

端末接続

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

フィードバック表現を登録、表示、および登録解除するには、コマンド xFeedback および対応するサブコマンドを使用します。

登録した表現は、現在アクティブな接続でのみ有効です。2 つの Telnet セッションを開いて、一方のセッションのフィードバックを取得する登録を行った場合、もう一方のセッションのフィードバックは受信しません。これは、セッションから接続解除すると、再接続後にすべての表現を再登録する必要があることも意味します。

最大 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

(27)

HTTP の使用

コーデックは、HTTP および HTTPS を介したコマンドおよびコンフィギュレーションの送信をサポートします。この方法でコンフィギュレーションとステータスを取得することもできます。このインターフェイスでは、コマンドラインと同じ API が XML 形式で提供されます。

URL チートシート

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

方法 URL 説明

GET http://<ip-address>/status.xml ステータスドキュメント全体

GET http://<ip-address>/configuration.xml コンフィギュレーションドキュメント全体

GET http://<ip-address>/command.xml コマンドドキュメント全体

GET http://<ip-address>/valuespace.xml 値スペースドキュメント全体

GET http://<ip-address>/getxml?location=<path> パスに基づいたドキュメントの取得

POST http://<ip-address>/putxml HTTP 本文のコンフィギュレーションとコマンド

GET、POST http://<ip-address>/formputxml?xmldoc=<xml> コンフィギュレーションとコマンド www-urlencoded

ステータスおよびコンフィギュレーションの取得

例 1：コーデックのすべてのステータスエントリを取得する。

http://<ip-address>/getxml?location=/Status 例 2：コーデックの音声ステータスのみを取得する。

http://<ip-address>/getxml?location=/Status/Audio 例 3：コーデックのすべてのコンフィギュレーションを取得する。

http://<ip-address>/getxml?location=/

Configuration

例 4：コーデックのすべてのビデオコンフィギュレーションを取得する。

http://<ip-address>/getxml?location=/

Configuration/Video

コマンドおよびコンフィギュレーションの送信

HTTP GET の使用

コマンドまたはコンフィギュレーションをコーデックに送信する場

合は、HTTP GET を使用できます。これにより、ブラウザを使って簡

単にコマンドをテストできます。

例 1：カメラ位置を設定する。

http://<ip-address>/formputxml?xmldoc=

例 2：システム名を変更する。

http://<ip-address>/formputxml?xmldoc=

<Name>newName</Name></SystemUnit></Configuration>

HTTP POST の使用

コンフィギュレーションとコマンドをコーデックに送信する場合は、

HTTP ヘッダーの Content-Type を text/xml に設定してください

（Content-Type: text/xml）。POST の本文には XML コンテンツを含める必要があります。

例 1：システム名を変更する。

要求

POST /putxml HTTP/1.1 Content-Type:text/xml Connection: close

<Name>newName</Name>

</SystemUnit>

</Configuration>

例 2：カメラ位置を設定する。

要求

POST /putxml HTTP/1.1 Content-Type:text/xml Connection: close

</PositionSet>

</Camera>

</Command>

応答

HTTP/1.1 200 OK Date: <date>

Server: WSGIServer/0.1 Python/2.5.4 Cache-Control: no-cache

Content-Type:text/xml

(28)

HTTP を介したコーデックからのフィードバック

コーデックからの通知を取得するには、HTTP のフィードバック表現を登録する必要があります。登録すると、コーデックは HTTP POST を使用して、指定された IP アドレスにフィードバックメッセージを送信します。したがって、アプリケーションがコーデックから更新を受信できるように、HTTP サーバを稼働させておく必要があります。

フィードバックの登録

登録用のコマンドは

xCommand HttpFeedback Register

です。

このコマンドの構文と引数については、この項で説明します。

HttpFeedback Register の構文：

xCommand HttpFeedback Register FeedbackSlot: <1..4>

ServerUrl(r): <S: 1, 2048>

Expression: <S: 1, 255>

HttpFeedback Register の引数：

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

注：Cisco TelePresence Management Suite（TMS）が使用されている環境では FeedbackSlot 3 の使用は避けてください。この feedbackslot は、TMS が表現を登録する際に使用します。

ServerUrl：コーデックによる HTTP フィードバックメッセージの送信先 URL。

Expression 1 〜 15：受信するフィードバックの対象となる表現を登録します。表現のフォーマットに関する詳細は、「フィードバックメカニズム」、25 ページを参照してください。

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

<ServerUrl>http://127.0.0.1/

myhttppostscripturl</ServerUrl>

<Expression item=”1”>/Configuration</

Expression>

<Expression item=”2”>/Event/

CallDisconnect</Expression>

<Expression item=”3”>/Status/Call</

Expression>

</Register>

</HttpFeedback>

</Command>

フィードバックの出力

登録された HTTP サーバにコーデックが変更について通知する際、

その本文にはポーリング時と同じ XML が含まれます。ただし、わずかな違いが 1 つあります。ルートノードに、通知の発信元コーデックを指定する子を持つ Identification ノードが含まれています。これ

は、1 つの HTTP サーバ URI で複数のコーデックを処理できること

を意味します。

例：変更された音量。

<Configuration xmlns=”http://www.company.com/XML/

CUIL/2.0”>

<SystemName>integrator</SystemName>

<ProductType>Cisco Codec</ProductType>

<ProductID>Cisco Codec C90</ProductID>

</Identification>

</Audio>

</Configuration>

(29)

端末モードから XML への変換

コマンドの変換

XML コマンドは端末コマンドと同じ構造を維持しますが、階層の説明に親子関係を使用します。次の例でこの構造を確認できます。

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

Terminal

xCommand Dial Number: “12345” Protocol: H323 XML

</Dial>

</Command>

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

Terminal

xCommand Video Layout AssignCall CallId: 2 LayoutId: 1

XML

<Video>

</AssignCall>

</Layout>

</Video>

</Command>

コンフィギュレーションの変換

xConfiguration から XML への変換はコマンドの場合と似ていますが、配列のインデックスを指定する特別な属性 item=”NN” が追加されます。

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

Terminal

xConfiguration Video Input Connector 2 InputSourceType: camera

XML

<Video>

<Input>

<InputSourceType>camera</InputSourceType>

</Connector>

</Input>

</Video>

</Configuration>

(30)

注意事項

Cisco MX シリーズ API をプログラミングする際のベストプラクティスを次に示します。

完全なコマンドを使用する

プログラミングする際は常に完全なコマンドを使用する必要があります。つまり、xconf vid ではなく、xConfiguration Video を必ず使用します。ショートカットは、コマンドラインでの API の検索に使用できますが、プログラミング用ではありません。これは、他のコマンドが API に追加された場合に、コードがあいまいになる可能性があるからです。

不要なフィードバックを登録しない

登録されたフィードバックが多すぎると、制御アプリケーションに輻輳が発生する場合があります。現在のバージョンではフィードバックの量に問題がないようでも、今後のリリースで量が増える可能性があります。

(31)

第 3 章

xConfiguration コマンド

(32)

音声設定：... 36 xConfiguration Audio DefaultVolume ...36 xConfiguration Audio SoundsAndAlerts RingTone ...36 xConfiguration Audio SoundsAndAlerts RingVolume ...36 xConfiguration Audio Input HDMI [n] Level ...36 xConfiguration Audio Input HDMI [1..3] Mode ...37 xConfiguration Audio Input Line [1..4] Equalizer ID ...37 xConfiguration Audio Input Line [1..4] Equalizer Mode ...37 xConfiguration Audio Input Line [1..4] VideoAssociation MuteOnInactiveVideo ...37 xConfiguration Audio Input Line [1..4] VideoAssociation VideoInputSource ... 38 xConfiguration Audio Input Line [1..4] Channel ... 38 xConfiguration Audio Input Line [1..4] Level ... 38 xConfiguration Audio Input Line [1..4] Mode ... 38 xConfiguration Audio Input Microphone [1..8] EchoControl Mode ... 39 xConfiguration Audio Input Microphone [1..8] EchoControl NoiseReduction ... 39 xConfiguration Audio Input Microphone [1..8] EchoControl Dereverberation... 39 xConfiguration Audio Input Microphone [1..8] Equalizer ID ... 39 xConfiguration Audio Input Microphone [1..8] Equalizer Mode ... 40 xConfiguration Audio Input Microphone [1..8] VideoAssociation MuteOnInactiveVideo ... 40 xConfiguration Audio Input Microphone [1..8] VideoAssociation VideoInputSource ... 40 xConfiguration Audio Input Microphone [1..8] Level ... 40 xConfiguration Audio Input Microphone [1..8] Mode ...41 xConfiguration Audio Input Microphone [1..8] Type ...41

xConfiguration Audio Output HDMI [1..2] Level ...41 xConfiguration Audio Output HDMI [1..2] Mode ...41 xConfiguration Audio Output Line [1..6] Channel ...42 xConfiguration Audio Output Line [1..6] Equalizer ID ...42 xConfiguration Audio Output Line [1..6] Equalizer Mode ...42 xConfiguration Audio Output Line [1..6] Level ...42 xConfiguration Audio Output Line [1..6] Mode ...43

カメラ設定： ... 43 xConfiguration Cameras Camera [1..7] AssignedSerialNumber ...43 xConfiguration Cameras Camera [1..7] Backlight DefaultMode ...44 xConfiguration Cameras Camera [1..7] Brightness Mode ...44 xConfiguration Cameras Camera [1..7] Brightness DefaultLevel ...44 xConfiguration Cameras Camera [1..7] Focus Mode ...44 xConfiguration Cameras Camera [1..7] Gamma Mode ...45 xConfiguration Cameras Camera [1..7] Gamma Level ...45 xConfiguration Cameras Camera [1..7] Mirror ...45 xConfiguration Cameras Camera [1..7] Whitebalance Mode...45 xConfiguration Cameras Camera [1..7] Whitebalance Level ...46 xConfiguration Cameras Preset TriggerAutofocus ...46 xConfiguration Cameras SpeakerTrack Mode ...46 xConfiguration Cameras SpeakerTrack TrackingMode ...46 xConfiguration Cameras SpeakerTrack ConnectorDetection Mode ...47

xConfiguration コマンドの説明

この章では、xConfiguration コマンドの完全なリストを示します。例では、デフォルト値または値の例のいずれかを示します。

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

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

Cisco TelePresence MX700 および MX800 API (CE8.0) リファレンス ガイド

Application Programmer Interface （ API ）

リファレンス ガイド

目次

このマニュアルの内容

第 1 章

はじめに

このマニュアルについて

ユーザ ドキュメンテーションのダウンロード

新機能および改善点

このバージョンの新機能

CE8.0 での xConfiguration の変更

CE8.0 での xCommand の変更

CE8.0 での xStatus の変更

第 2 章

API について

API の基礎

API への接続

パスワード

RS-232/シリアル接続

Telnet

xConfiguration NetworkServices Telnet Mode: On

SSH

HTTP/HTTPS

API 出力

出力モード

コマンド ラインの使用

? - User Commands -

help

API コマンド

その他のコマンド

コマンド ラインのショートカット

検索

値のタイプおよびフォーマット

xCommand dial number: “my number contains spaces”

xCommand dial number: 12345

xCommand dial number: my number contains spaces

コマンド

コンフィギュレーション

xConfiguration H323 Profile 1 H323Alias ID

*c xConfiguration H323 Profile 1 H323Alias ID:

“[email protected]”

**end

ステータス

イベント

フィードバック メカニズム

フィードバック表現

xFeedback register <path>

xFeedback register /Configuration

xgetxml <path>

端末接続

xStatus Standby Active

xFeedback register /Status/Audio

** end

xFeedback register /Event/CallDisconnect

** end

xFeedback register /Configuration/Video/

MainVideoSource

** end

xFeedback list

/Configuration/Video/MainVideoSource

xFeedback deregister /Event/

CallDisconnect

** end

xFeedback deregister /Status/Audio

** end

xFeedback list

/Configuration/Video/MainVideoSource

HTTP の使用

ステータスおよびコンフィギュレーションの取得

コマンドおよびコンフィギュレーションの送信

HTTP POST の使用

HTTP を介したコーデックからのフィードバック

フィードバックの登録

xCommand HttpFeedback Register

端末モードから XML への変換

注意事項

完全なコマンドを使用する

不要なフィードバックを登録しない

第 3 章

Cisco TelePresence MX700 および MX800 API (CE8.0) リファレンスガイド

リファレンスガイド

ユーザドキュメンテーションのダウンロード

コマンドラインの使用

コマンドラインのショートカット

フィードバックメカニズム