Cisco Systems OL-20949-01 Interaction Rules with Legacy RTP URI Streams, RTP Streaming Schema

Page 44

Chapter 4 Component APIs

RTP Streaming API

Interaction Rules with Legacy RTP URI Streams

The RTP Streaming API allows a full-duplex stream (mode=sendReceive) to be setup as a single stream request which simplifies the usage of the API. However, in some cases, this creates some interoperability issues with the legacy RTP URIs because the legacy RTP URIs send and receive streams separately. The interaction rules between legacy RTP URI streams and the new RTP Streaming API are as follows:

•If an RTP Stop URI is invoked, and an RTP Streaming API stream is currently streaming in that same direction, then the entire RTP Streaming API stream is stopped.

For example, if a full-duplex stream is setup through the RTP Streaming API (mode=sendReceive) and then an RTPTx:Stop URI is invoked, the stream will be stopped in both the send and receive directions (and the onStopped event handler will be called, if present).

•If the stopMedia request (from the RTP Streaming API) does not specify a stream ID, then the request will stop all services RTP streams, in any direction (send or receive) and of any type (multicast and unicast). This allows applications using the RTP Streaming API to stop media streams which may have been started by the legacy RTP URIs or by other applications for which a stream ID is not known.

RTP Streaming Schema

Note The port number parameter of the startMedia request is optional and if it is not specified, the phone selects an available port and returns it in the startMediaResponse object. The port parameter, if specified, must be an even number in the range of 20480-32768.

<?xml version="1.0" encoding="UTF-8"?>

<!-- edited with XML Spy v4.4 U (http://www.xmlspy.com) by Cisco Systems, Inc. (Cisco Systems, Inc.) -->

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">

<xs:element name="startMedia">

<xs:complexType>

<xs:all>

<xs:element name="mediaStream" type="mediaStream"/>

</xs:all>

</xs:complexType>

</xs:element>

<xs:element name="stopMedia"> <xs:complexType>

<xs:all>

<xs:element name="mediaStream"> <xs:complexType>

<xs:attribute name="id" type="xs:string" use="optional"/>

</xs:complexType>

</xs:element>

</xs:all>

</xs:complexType>

</xs:element>

<xs:element name="startMediaResponse">

<xs:complexType>

<xs:all>

<xs:element name="mediaStream" type="mediaStream"/>

 

 

 

</xs:all>

 

 

 

</xs:complexType>

 

 

 

</xs:element>

 

 

 

<xs:element name="notifyMediaEvent">

 

 

 

Cisco Unified IP Phone Services Application Development Notes

 

 

 

 

4-2

 

OL-20949-01

 

 

 

 

Page 43 Page 45
Image 44
Page 43 Page 45
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 AudienceViii OrganizationChapter Description Cisco Unified Communications Manager Administration Related DocumentationCisco Unified IP Phone 7900 Series Cisco Unified Communications Manager Business EditionConvention Indication Cisco Product Security OverviewDocument Conventions 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 DescriptionCiscoIPPhoneResponse CiscoIPPhoneErrorCustom Softkeys XML Considerations SoftKeyItem NameDisplayed sofkey label/NameCharacter Name Escape Sequence Mandatory Escape SequencesXML Encoding Attributes Application Event HandlersSupported Unsupported Attribute Description Event Handler Schema RTP Streaming API Component APIsApplication Management 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 6941URI Format Device Control URIsKey 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 Interaction with Call Streaming Multimedia URIsRTP Streaming RTPRx URI FormatsRTPTx Interaction with Incoming Calls PlayVibrate Telephony URIs DialEditDial SendDigitsError and Response Condition Status DataNotify Application Management URIsInit Called from SoftKey, with credentials, with data Application Called from SoftKey, no credentials, no dataAppactionpriorityidleTimerapplicationId Error and Response Http Server Requests Http Post Http Requests and Header SettingsHttp Client Requests Http GET 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-LanguageCiscoIPPhoneDisplay Identifying the Capabilities of IP Phone ClientsCiscoIPPhoneModelName Accept Header CiscoIPPhoneSDKVersionAccessing IP Phone Information Html URL XML URLOL-20949-01 XML Parsing Errors Troubleshooting Cisco Unified IP Phone Service ApplicationsTroubleshooting Tips 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-410-5 Determining Problems With the InterfaceProcedure 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