drgreen/android_frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

am 46524f83: Merge "docs: add package description for RTP" into honeycomb-mr1

Browse Source 
* commit '46524f83a55731cd96c9df8a87be6dacb1db1a37':
  docs: add package description for RTP
This commit is contained in:
Scott Main
2011-05-05 18:00:57 -07:00
committed by Android Git Automerger
parent 7bf1c661f1 46524f83a5
commit a7a9c4cbbc
1 changed files with 28 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
voip/java/android/net/rtp/package.html Normal file
View File

@ -0,0 +1,28 @@
<html>
<body>
<p>Provides APIs for RTP (Real-time Transport Protocol), allowing applications to manage on-demand
or interactive data streaming. In particular, apps that provide VOIP, push-to-talk, conferencing,
and audio streaming can use these APIs to initiate sessions and transmit or receive data streams
over any available network.</p>
<p>To support audio conferencing and similar usages, you need to instantiate two classes as
endpoints for the stream:</p>
<ul>
<li>{@link android.net.rtp.AudioStream} specifies a remote endpoint and consists of network mapping
and a configured {@link android.net.rtp.AudioCodec}.</li>
<li>{@link android.net.rtp.AudioGroup} represents the local endpoint for one or more {@link
android.net.rtp.AudioStream}s. The {@link android.net.rtp.AudioGroup} mixes all the {@link
android.net.rtp.AudioStream}s and optionally interacts with the device speaker and the microphone at
the same time.</li>
</ul>
<p>The simplest usage involves a single remote endpoint and local endpoint. For more complex usages,
refer to the limitations described for {@link android.net.rtp.AudioGroup}.</p>
<p class="note"><strong>Note:</strong> To use the RTP APIs, you must request the {@link
android.Manifest.permission#INTERNET} and {@link
android.Manifest.permission#RECORD_AUDIO} permissions in your manifest file.</p>
</body>
</html>