diff options
| author | Scott Main <smain@google.com> | 2011-05-05 16:17:40 -0700 |
|---|---|---|
| committer | Scott Main <smain@google.com> | 2011-05-05 17:32:01 -0700 |
| commit | de9acb76d9ea398d0ba4c5e62df554f5696eaa99 (patch) | |
| tree | 9b669165941376a5c7fc9c6e9c8fc4cc7100f7ba /voip/java | |
| parent | 0369cf98743e72d052eb5542125f58d1ad2f7f61 (diff) | |
| download | frameworks_base-de9acb76d9ea398d0ba4c5e62df554f5696eaa99.zip frameworks_base-de9acb76d9ea398d0ba4c5e62df554f5696eaa99.tar.gz frameworks_base-de9acb76d9ea398d0ba4c5e62df554f5696eaa99.tar.bz2 | |
docs: add package description for RTP
Change-Id: I02c181a48101be288fb4aabf497f573f00038f90
Diffstat (limited to 'voip/java')
| -rw-r--r-- | voip/java/android/net/rtp/package.html | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/voip/java/android/net/rtp/package.html b/voip/java/android/net/rtp/package.html new file mode 100644 index 0000000..4506b09 --- /dev/null +++ b/voip/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 |