Cisco Systems OL-20949-01 manual RTPRx, URI Formats

Page 58

Chapter 5 Internal URI Features

Multimedia URIs

The user has no explicit mechanism for terminating the Rx URI stream independent of the call. Thus, if the Rx stream is not terminated automatically, it would continue to play. For example, a user is listening to Internet radio feed and gets an incoming call. The user answers the call, which either closes or minimizes the Internet radio XSI application. Otherwise, the user has no intuitive way to stop the music stream.

•New Rx URI stream requests received during an active call will be accepted (whisper), but the volume parameter of the URI will be ignored.

If the Rx URI request was done via push, then the associated application is responsible for using push Priority attributes and for stopping and starting the stream.

If the user initiates the Rx URI via an application, then the user likely is not concerned about having the audio mixed with the current call. However, they should also be presented with an option to stop the application, when needed.

•For the Rx URI, the Mute indicator light is only lit when both these conditions are met:

–There are no active transmit streams from either a call or an XML services stream, and

–There is at least one active receive stream

For example, if an active call is ended or put on hold while a Rx URI stream is active, the Mute indicator will light.

•If a Rx or Tx URI request is received and there is already an active XML services stream in that direction, then a response with errorNo=1 Tx/Rx is already active will be returned. The previous stream must be terminated (either by the user or by an RTP Stop URI) before a new stream can be started.

This response provides visibility to the application if the phone is currently busy. It then allows the application to decide whether or not to terminate the existing stream and start a new one, rather than being controlled by the phone firmware.

RTPRx

The RTPRx URI instructs the phone to receive a Unicast RTP stream or to stop receiving Unicast or Multicast RTP streams.

URI Formats

RTPRx:i:p:v

RTPRx:Stop

Where

i = the IP Address from which the stream is coming.

p = the UDP port on which to receive the RTP stream. Ensure that this is an even port number within the decimal range of 20480 to 32768. If no port is specified, the phone chooses a port and returns it when initiated by a push request.

Stop = the parameter that will stop any active RTP stream from being received on channel one

v = the optional volume setting that controls the volume of stream playout. The supplied value is a percentage of the maximum volume level of the device and must be in the range 0-100. The phone converts the specified percentage into the closest device-supported volume level setting and uses it. After the initial volume level gets set and the stream starts, you can manually change the volume level as needed. If the optional volume parameter does not get included, the current volume setting on the phone gets used as the default.

 

Cisco Unified IP Phone Services Application Development Notes

5-10

OL-20949-01

Page 57 Page 59
Image 58
Page 57 Page 59
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 Revision History PrefaceOverview AudienceChapter Description OrganizationViii Cisco Unified IP Phone 7900 Series Cisco Unified Communications Manager AdministrationRelated Documentation Cisco Unified Communications Manager Business EditionDocument Conventions Cisco Product Security OverviewConvention 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 Example Resolution1CiscoIPPhoneImageFile 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 CommunicatorText Area Size Phone Models WxH No Timer WxH 7940G, 7960GCiscoIPPhoneStatusFile 7962G, 7965GCiscoIPPhoneExecute Behavior DescriptionCustom Softkeys CiscoIPPhoneErrorCiscoIPPhoneResponse XML Considerations SoftKeyItem NameDisplayed sofkey label/NameXML Encoding Mandatory Escape SequencesCharacter Name Escape Sequence Supported Unsupported Application Event HandlersAttributes Attribute Description Event Handler Schema Application Management API Component APIsRTP Streaming API RTP Streaming Schema Interaction Rules with Legacy RTP URI StreamsXscomplexType Xsall Error Schema Start Media Errors and ResponsesExamples Stop MediaApplicable Condition Methods Http Result Code Type Data 7942G, 7962G 7906G 7945G, 7965G 7970G 6921 Internal URI FeaturesSupported URIs by Phone Model 7905G 7911G 7921G 7940G 7971G-GE 6941Key Device Control URIsURI Format KeyDirectories Phone Unsupported Models Description and AlternativesDisplay URIXML Displayable Object URIs SoftKey Select Exit Update Submit Search Cancel Next Dial QueryStringParamInternal URI Features XML Displayable Object URIs RTP Streaming Multimedia URIsInteraction with Call Streaming RTPRx URI FormatsRTPTx Vibrate PlayInteraction with Incoming Calls Telephony URIs DialEditDial SendDigitsError and Response Condition Status DataInit Application Management URIsNotify Called from SoftKey, with credentials, with data Application Called from SoftKey, no credentials, no dataAppactionpriorityidleTimerapplicationId Error and Response Http Client Requests Http GET Http Requests and Header SettingsHttp 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-LanguageCiscoIPPhoneModelName Identifying the Capabilities of IP Phone ClientsCiscoIPPhoneDisplay Accept Header CiscoIPPhoneSDKVersionAccessing IP Phone Information Html URL XML URLOL-20949-01 Troubleshooting Tips Troubleshooting Cisco Unified IP Phone Service ApplicationsXML 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-1Integration Considerations and Interoperability BenefitsRestrictions Performance and ScalabilitySupported Platforms Related Features and TechnologiesSecurity PrerequisitesField Name Description Troubleshooting DeviceListX ReportsError Codes 10-4Procedure Determining Problems With the Interface10-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
Top Page Image Contents