diff options
| author | Scott Main <smain@google.com> | 2011-05-05 18:02:47 -0700 |
|---|---|---|
| committer | Android Git Automerger <android-git-automerger@android.com> | 2011-05-05 18:02:47 -0700 |
| commit | f37799a62848cdb5c7b69695d527c6c52c97f07d (patch) | |
| tree | 91d40ec89d6f86a690e5b8d2982a99a2920044e7 /java | |
| parent | 4b9a71a1de7f8fcdbdfd767cfa76be392bd8b760 (diff) | |
| parent | abed3b90dfe961d276cbedda60f4d1a92d81d2b9 (diff) | |
| download | android_frameworks_opt_net_voip-f37799a62848cdb5c7b69695d527c6c52c97f07d.tar.gz android_frameworks_opt_net_voip-f37799a62848cdb5c7b69695d527c6c52c97f07d.tar.bz2 android_frameworks_opt_net_voip-f37799a62848cdb5c7b69695d527c6c52c97f07d.zip | |
am a7a9c4cb: am 46524f83: Merge "docs: add package description for RTP" into honeycomb-mr1
* commit 'a7a9c4cbbc2315a59ad27b43c83c66e272dcc2f2':
docs: add package description for RTP
Diffstat (limited to 'java')
| -rw-r--r-- | java/android/net/rtp/package.html | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/java/android/net/rtp/package.html b/java/android/net/rtp/package.html new file mode 100644 index 0000000..4506b09 --- /dev/null +++ b/java/android/net/rtp/package.html @@ -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>
\ No newline at end of file |