Minor changes to fix Javadoc.

- cache ref didn't work because it referred to a private variable
  (which isn't documented) from a public interface definition
  (which is). Meaning the Javadoc generator was trying to link
  to documentation that didn't exist.
This commit is contained in:
Oliver Woodman 2014-09-08 11:07:16 +01:00
parent cc04fd1e76
commit 98a7573812
2 changed files with 6 additions and 5 deletions

View File

@ -27,6 +27,7 @@ import android.media.AudioTimestamp;
import android.media.AudioTrack; import android.media.AudioTrack;
import android.media.MediaCodec; import android.media.MediaCodec;
import android.media.MediaFormat; import android.media.MediaFormat;
import android.media.audiofx.Virtualizer;
import android.os.ConditionVariable; import android.os.ConditionVariable;
import android.os.Handler; import android.os.Handler;
import android.util.Log; import android.util.Log;
@ -358,9 +359,9 @@ public class MediaCodecAudioTrackRenderer extends MediaCodecTrackRenderer {
* subsequently re-enabled. * subsequently re-enabled.
* <p> * <p>
* The default implementation is a no-op. One reason for overriding this method would be to * The default implementation is a no-op. One reason for overriding this method would be to
* instantiate and enable a {@link android.media.audiofx.Virtualizer} in order to spatialize the * instantiate and enable a {@link Virtualizer} in order to spatialize the audio channels. For
* audio channels. For this use case, any {@link android.media.audiofx.Virtualizer} instances * this use case, any {@link Virtualizer} instances should be released in {@link #onDisabled()}
* should be released in {@link #onDisabled()} (if not before). * (if not before).
* *
* @param audioSessionId The audio session id. * @param audioSessionId The audio session id.
*/ */

View File

@ -41,10 +41,10 @@ public final class CacheDataSource implements DataSource {
public interface EventListener { public interface EventListener {
/** /**
* Invoked when bytes have been read from {@link #cache} since the last invocation. * Invoked when bytes have been read from the cache.
* *
* @param cacheSizeBytes Current cache size in bytes. * @param cacheSizeBytes Current cache size in bytes.
* @param cachedBytesRead Total bytes read from {@link #cache} since last report. * @param cachedBytesRead Total bytes read from the cache since this method was last invoked.
*/ */
void onCachedBytesRead(long cacheSizeBytes, long cachedBytesRead); void onCachedBytesRead(long cacheSizeBytes, long cachedBytesRead);