Cisco Systems OL-20949-01 manual CiscoIPPhoneImageFile, Example, Resolution1, Model

Page 27

Chapter 3 CiscoIPPhone XML Objects

XML Object Definitions

Example

The following XML code defines a CiscoIPPhoneImage object that displays the sequence of pixels shown in Figure 3-3as a graphic positioned at the center of the phone display:

<CiscoIPPhoneImage>

<Title/>

<LocationX>-1</LocationX>

<LocationY>-1</LocationY>

<Width>4</Width>

<Height>1</Height>

<Depth>2</Depth>

<Data>2D</Data>

<Prompt/>

</CiscoIPPhoneImage>

The graphic display comprises a contiguous stream of hexadecimal digits, with no spaces or other separators. If the number of pixels to be displayed does not represent an even multiple of four, pad the end of the pixel data with blank (zero value) pixels, so the data is packed correctly. The phone ignores the padded data.

Tip Before displaying a graphic image on a Cisco Unified IP Phone, the software clears the pane dedicated to services. If a service has text or other information that must be preserved (including the title area), the information must get redrawn as part of the graphic. If the title is to be hidden, the graphic must be large enough to cover it.

CiscoIPPhoneImageFile

The latest generation of Cisco Unified IP Phones have higher-resolution displays with more color depth. The Cisco Unified IP Phone 7970G, for example, has a display area of 298x168 pixels available to the Services pane and renders images in 12-bit color.

To support these more advanced displays, a new XML object allows the use of color PNG images in addition to the grayscale CiscoIPPhoneImage objects. The CiscoIPPhoneImageFile object behaves like the CiscoIPPhoneImage object, except for the image data. Instead of using the <Data> tag to embed the image data, the <URL> tag points to the PNG image file.

The web server must deliver the PNG image to the phone with an appropriate MIME Content-Type header, such as image/png, so the phone recognizes the content as a compressed, binary PNG image. The PNG image can be either palettized or RGB, and the maximum image size and color depth are model dependent (see Table 3-2).

Table 3-2

Cisco Unified IP Phones Display Image Sizes and Color Depths

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Resolution1

Color/Grayscale

 

 

 

 

 

 

Model

 

(width x height)

/Monochrome

Color Depth (bits)

 

 

 

 

 

 

 

 

 

 

Cisco Unified IP Phones 7905G, 7906G,

N/A

Grayscale

1

 

 

 

 

 

7911G, 7912G2, 7931G

 

 

 

 

 

 

 

 

Cisco Unified IP Phone 7920

128 x 59

Grayscale

1

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Cisco Unified IP Phone 7921G, 7925G

176 x 140

Color

16

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Cisco Unified IP Phones 7940G/60G

133 x 65

Grayscale

2

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Cisco Unified IP Phones 7941G, 7941G-GE,

298 x 144

Grayscale

4

 

 

 

 

 

7942G, 7961G, 7961G-GE, 7962G

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Cisco Unified IP Phone Services Application Development Notes

 

 

 

 

 

 

 

OL-20949-01

 

 

 

 

 

 

3-9

 

 

 

 

 

 

 

 

 

Page 26 Page 28
Image 27
Page 26 Page 28
Contents Text Part Number OL-20949-01 Americas HeadquartersCopyright 2004-2009 Cisco Systems, Inc. All rights reserved Iii N T E N T SDisplay Init Benefits Audience PrefaceOverview Revision HistoryOrganization Chapter DescriptionViii Cisco Unified Communications Manager Business Edition Cisco Unified Communications Manager AdministrationRelated Documentation Cisco Unified IP Phone 7900 SeriesCisco Product Security Overview Document ConventionsConvention Indication Page Xii 1shows a sample text menu OverviewGraphic Menu on a Cisco Unified IP Phone Sample Page OL-20949-01 New Information for Cisco Unified Communications Manager New and Changed InformationOL-20949-01 Understanding Object Behavior CiscoIPPhone XML Objects1shows the supported XML objects for this release CiscoIPPhoneMenu XML Object DefinitionsDefinition CiscoIPPhoneTextSample User Input Display CiscoIPPhoneInputInputFlag Description CiscoIPPhoneDirectoryCustom Directories CiscoIPPhoneImagePacked Pixel Translation Example Model Resolution1CiscoIPPhoneImageFile ExampleCisco Unified IP Phone 7970G Image File Display MonochromeCiscoIPPhoneGraphicFileMenu CiscoIPPhoneGraphicMenu5shows the display of the CiscoIPPhoneGraphicFileMenu CiscoIPPhoneIconMenu6shows an IconMenu on a Cisco Unified IP Phone CiscoIPPhoneStatus CiscoIPPhoneIconFileMenuCiscoIPPhoneStatus Dynamic Sizing of the Application Status Window7962G, 7965G 7970G/7971G-GE, 7975G, IP Communicator Phone Models Area Width Area Height 7940G, 7960G7962G, 7965G Phone Models WxH No Timer WxH 7940G, 7960GCiscoIPPhoneStatusFile Text Area SizeBehavior Description CiscoIPPhoneExecuteCiscoIPPhoneError Custom SoftkeysCiscoIPPhoneResponse SoftKeyItem NameDisplayed sofkey label/Name XML ConsiderationsMandatory Escape Sequences XML EncodingCharacter Name Escape Sequence Application Event Handlers Supported UnsupportedAttributes Attribute Description Event Handler Schema Component APIs Application Management APIRTP Streaming API Interaction Rules with Legacy RTP URI Streams RTP Streaming SchemaXscomplexType Xsall Error Schema Stop Media Errors and ResponsesExamples Start MediaApplicable Condition Methods Http Result Code Type Data 7905G 7911G 7921G 7940G 7971G-GE 6941 Internal URI FeaturesSupported URIs by Phone Model 7942G, 7962G 7906G 7945G, 7965G 7970G 6921Device Control URIs KeyURI Format KeyDirectories Description and Alternatives Phone Unsupported ModelsURI DisplaySoftKey XML Displayable Object URIsQueryStringParam Select Exit Update Submit Search Cancel Next DialInternal URI Features XML Displayable Object URIs Multimedia URIs RTP StreamingInteraction with Call Streaming URI Formats RTPRxRTPTx Play VibrateInteraction with Incoming Calls Dial Telephony URIsSendDigits EditDialCondition Status Data Error and ResponseApplication Management URIs InitNotify Called from SoftKey, with credentials, with data Called from SoftKey, no credentials, no data ApplicationAppactionpriorityidleTimerapplicationId Error and Response Http Requests and Header Settings Http Client Requests Http GETHttp Server Requests Http Post See the Http Refresh Setting section on page 6-3section Http Header SettingsRefresh Display Sample Http Refresh SettingMime Type and Other Http Headers Content Expiration Header SettingSet-Cookie Header Setting Accept-Language Http Encoding Header SettingIdentifying the Capabilities of IP Phone Clients CiscoIPPhoneModelNameCiscoIPPhoneDisplay CiscoIPPhoneSDKVersion Accept HeaderHtml URL XML URL Accessing IP Phone InformationOL-20949-01 Troubleshooting Cisco Unified IP Phone Service Applications Troubleshooting TipsXML Parsing Errors Error Messages SDK Components Cisco IP Phone Services Software Development Kit SDKOL-20949-01 \CiscoIpServices\Tools Sample Services RequirementsOL-20949-01 Accessing Phone Service Administration IP Phone Service Administration SubscriptionField Description Adding a Phone ServiceField Description Service Parameter Information Defining IP Phone Service ParametersUser Service Subscription 10-1 DeviceListX ReportPerformance and Scalability BenefitsRestrictions Integration Considerations and InteroperabilityPrerequisites Related Features and TechnologiesSecurity Supported Platforms10-4 Troubleshooting DeviceListX ReportsError Codes Field Name DescriptionDetermining Problems With the Interface Procedure10-5 10-6 Object Definition CiscoIPPhone XML Object Quick ReferenceAppendix a CiscoIPPhone XML Object Quick Reference IndexA unique index from 0 to 9/Index OL-20949-01 Updated XML Parser and Schema Enforcement Cisco Unified IP Phone Services XML Schema FileCiscoIPPhone.xsd Xsdelement name=Name minOccurs=0 xsdsimpleType Xsdrestriction XsdsimpleType XsdsimpleType xsdrestriction base=xsdstring XsdcomplexType name=CiscoIPPhoneSoftKeyType xsdsequence Xsdelement name=Title minOccurs=0 xsdsimpleType Xsdrestriction XsdsimpleType Xsdattribute XsdcomplexType Xsdelement name=CiscoIPPhoneDirectory xsdcomplexType Xsdelement name=CiscoIPPhoneImageFile xsdcomplexType Xsdelement name=CiscoIPPhoneIconMenu xsdcomplexType Xsdelement name=CiscoIPPhoneGraphicFileMenu xsdcomplexType Xsdsequence Xsdelement name=Text minOccurs=0 xsdsimpleType Xsdsequence XsdcomplexType Xsdelement IN-1 NumericsIN-2 Html URLIN-3 IN-4 XML URL
Top Page Image Contents