Cisco Systems OL-20949-01 manual Play, Vibrate, Interaction with Incoming Calls

Page 60

Chapter 5 Internal URI Features

Multimedia URIs

Play

The Play URI downloads an audio file from the TFTP server and plays through the phone speaker. This same mechanism also plays ring files, and the format of the files is the same. You could use the Play URI to play files that are in the Ringlist.xml or those that are not. If the phone is equipped with an MWI light, it will be flashing while the audio file is playing, providing a visual alert as well.

Note The Play URI is a synchronous request. If the request is pushed to the phone via HTTP, the HTTP response (CiscoIPPhoneResponse object) is not returned until after the playback has completed.

Interaction with Incoming Calls

The Play URI and incoming calls (ringing) have equal priority access to the DSP ringer resources resulting in the following interactions:

•If a Play URI is currently playing, an incoming call (ringing) will not preempt the Play URI; the Play URI will finish playing first.

•If the phone is ringing and a Play URI request is sent to the phone, the execution of the Play URI defers until the phone stops ringing (the DSP ringer resource becomes available) and then the Play URI will play.

URI Format

Play:f

Where

f = the filename of a raw audio file in the TFTP path (such as Play:Classic2.raw).

The audio files for the rings must meet the following requirements for proper playback on Cisco Unified IP Phones:

•Raw PCM (no header)

•8000 samples per second

•8 bits per sample

•uLaw compression

•Maximum ring size—16080 samples

•Minimum ring size—240 samples

•Number of samples in the ring is evenly divisible by 240.

•Ring starts and ends at the zero crossing.

To create PCM files for custom phone rings, you can use any standard audio editing packages that support these file format requirements.

Vibrate

The Vibrate URI is available on the Cisco Unified IP Phones 7920G, 7921G, and 7925G wireless phone models, and it enables third-party applications to invoke the phone’s vibration capabilities for silent alerts, similar to the way in which the Play URI plays audible alerts. If the Vibrate parameters are not specified or if the device is unable to support custom Vibrate sequences, the device will execute its default vibrate sequence.

	Cisco Unified IP Phone Services Application Development Notes
5-12	OL-20949-01

Image 60

Contents Americas Headquarters Text Part Number OL-20949-01Copyright 2004-2009 Cisco Systems, Inc. All rights reserved N T E N T S IiiDisplay Init Benefits Preface OverviewRevision History AudienceOrganization Chapter DescriptionViii Cisco Unified Communications Manager Administration Related DocumentationCisco Unified IP Phone 7900 Series Cisco Unified Communications Manager Business EditionCisco Product Security Overview Document ConventionsConvention Indication Page Xii Overview 1shows a sample text menuGraphic Menu on a Cisco Unified IP Phone Sample Page OL-20949-01 New and Changed Information New Information for Cisco Unified Communications ManagerOL-20949-01 CiscoIPPhone XML Objects Understanding Object Behavior1shows the supported XML objects for this release XML Object Definitions CiscoIPPhoneMenuCiscoIPPhoneText DefinitionCiscoIPPhoneInput Sample User Input DisplayCiscoIPPhoneDirectory InputFlag DescriptionCiscoIPPhoneImage Custom DirectoriesPacked Pixel Translation Example Resolution1 CiscoIPPhoneImageFileExample ModelMonochrome Cisco Unified IP Phone 7970G Image File DisplayCiscoIPPhoneGraphicMenu CiscoIPPhoneGraphicFileMenuCiscoIPPhoneIconMenu 5shows the display of the CiscoIPPhoneGraphicFileMenu6shows an IconMenu on a Cisco Unified IP Phone CiscoIPPhoneIconFileMenu CiscoIPPhoneStatusDynamic Sizing of the Application Status Window CiscoIPPhoneStatusPhone Models Area Width Area Height 7940G, 7960G 7962G, 7965G 7970G/7971G-GE, 7975G, IP CommunicatorPhone Models WxH No Timer WxH 7940G, 7960G CiscoIPPhoneStatusFileText Area Size 7962G, 7965GCiscoIPPhoneExecute Behavior DescriptionCiscoIPPhoneError Custom SoftkeysCiscoIPPhoneResponse XML Considerations SoftKeyItem NameDisplayed sofkey label/NameMandatory Escape Sequences XML EncodingCharacter Name Escape Sequence Application Event Handlers Supported UnsupportedAttributes Attribute Description Event Handler Schema Component APIs Application Management APIRTP Streaming API RTP Streaming Schema Interaction Rules with Legacy RTP URI StreamsXscomplexType Xsall Error Schema Errors and Responses ExamplesStart Media Stop MediaApplicable Condition Methods Http Result Code Type Data Internal URI Features Supported URIs by Phone Model7942G, 7962G 7906G 7945G, 7965G 7970G 6921 7905G 7911G 7921G 7940G 7971G-GE 6941Device Control URIs KeyURI Format KeyDirectories Phone Unsupported Models Description and AlternativesDisplay URIXML Displayable Object URIs SoftKeySelect Exit Update Submit Search Cancel Next Dial QueryStringParamInternal URI Features XML Displayable Object URIs Multimedia URIs RTP StreamingInteraction with Call Streaming RTPRx URI FormatsRTPTx Play VibrateInteraction with Incoming Calls Telephony URIs DialEditDial SendDigitsError and Response Condition Status DataApplication Management URIs InitNotify Called from SoftKey, with credentials, with data Application Called from SoftKey, no credentials, no dataAppactionpriorityidleTimerapplicationId Error and Response Http Requests and Header Settings Http Client Requests Http GETHttp Server Requests Http Post Http Header Settings See the Http Refresh Setting section on page 6-3sectionHttp Refresh Setting Refresh Display SampleContent Expiration Header Setting Mime Type and Other Http HeadersSet-Cookie Header Setting Http Encoding Header Setting Accept-LanguageIdentifying the Capabilities of IP Phone Clients CiscoIPPhoneModelNameCiscoIPPhoneDisplay Accept Header CiscoIPPhoneSDKVersionAccessing IP Phone Information Html URL XML URLOL-20949-01 Troubleshooting Cisco Unified IP Phone Service Applications Troubleshooting TipsXML Parsing Errors Error Messages Cisco IP Phone Services Software Development Kit SDK SDK ComponentsOL-20949-01 Sample Services Requirements \CiscoIpServices\ToolsOL-20949-01 IP Phone Service Administration Subscription Accessing Phone Service AdministrationAdding a Phone Service Field DescriptionDefining IP Phone Service Parameters Field Description Service Parameter InformationUser Service Subscription DeviceListX Report 10-1Benefits RestrictionsIntegration Considerations and Interoperability Performance and ScalabilityRelated Features and Technologies SecuritySupported Platforms PrerequisitesTroubleshooting DeviceListX Reports Error CodesField Name Description 10-4Determining Problems With the Interface Procedure10-5 10-6 CiscoIPPhone XML Object Quick Reference Object DefinitionAppendix a CiscoIPPhone XML Object Quick Reference IndexA unique index from 0 to 9/Index OL-20949-01 Cisco Unified IP Phone Services XML Schema File Updated XML Parser and Schema EnforcementCiscoIPPhone.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 Numerics IN-1Html URL IN-2IN-3 XML URL IN-4