From de9acb76d9ea398d0ba4c5e62df554f5696eaa99 Mon Sep 17 00:00:00 2001 From: Scott Main Date: Thu, 5 May 2011 16:17:40 -0700 Subject: docs: add package description for RTP Change-Id: I02c181a48101be288fb4aabf497f573f00038f90 --- voip/java/android/net/rtp/package.html | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 voip/java/android/net/rtp/package.html (limited to 'voip/java') 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 @@ + + +

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.

+ +

To support audio conferencing and similar usages, you need to instantiate two classes as +endpoints for the stream:

+ +

{@link android.net.rtp.AudioStream} specifies a remote endpoint and consists of network mapping +and a configured {@link android.net.rtp.AudioCodec}.
{@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.

+ +

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}.

+ +

Note: 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.

+ + \ No newline at end of file -- cgit v1.1