Commit 78cdd086 by olly Committed by Oliver Woodman

Add some missing @param Javadoc to extensions

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=164105607
parent 147d5bb3
...@@ -37,6 +37,8 @@ public final class FfmpegLibrary { ...@@ -37,6 +37,8 @@ public final class FfmpegLibrary {
* Override the names of the FFmpeg native libraries. If an application wishes to call this * Override the names of the FFmpeg native libraries. If an application wishes to call this
* method, it must do so before calling any other method defined by this class, and before * method, it must do so before calling any other method defined by this class, and before
* instantiating a {@link FfmpegAudioRenderer} instance. * instantiating a {@link FfmpegAudioRenderer} instance.
*
* @param libraries The names of the FFmpeg native libraries.
*/ */
public static void setLibraries(String... libraries) { public static void setLibraries(String... libraries) {
LOADER.setLibraries(libraries); LOADER.setLibraries(libraries);
...@@ -58,6 +60,8 @@ public final class FfmpegLibrary { ...@@ -58,6 +60,8 @@ public final class FfmpegLibrary {
/** /**
* Returns whether the underlying library supports the specified MIME type. * Returns whether the underlying library supports the specified MIME type.
*
* @param mimeType The MIME type to check.
*/ */
public static boolean supportsFormat(String mimeType) { public static boolean supportsFormat(String mimeType) {
if (!isAvailable()) { if (!isAvailable()) {
......
...@@ -35,6 +35,8 @@ public final class FlacLibrary { ...@@ -35,6 +35,8 @@ public final class FlacLibrary {
* Override the names of the Flac native libraries. If an application wishes to call this method, * Override the names of the Flac native libraries. If an application wishes to call this method,
* it must do so before calling any other method defined by this class, and before instantiating * it must do so before calling any other method defined by this class, and before instantiating
* any {@link LibflacAudioRenderer} and {@link FlacExtractor} instances. * any {@link LibflacAudioRenderer} and {@link FlacExtractor} instances.
*
* @param libraries The names of the Flac native libraries.
*/ */
public static void setLibraries(String... libraries) { public static void setLibraries(String... libraries) {
LOADER.setLibraries(libraries); LOADER.setLibraries(libraries);
......
...@@ -61,6 +61,11 @@ public final class GvrAudioProcessor implements AudioProcessor { ...@@ -61,6 +61,11 @@ public final class GvrAudioProcessor implements AudioProcessor {
/** /**
* Updates the listener head orientation. May be called on any thread. See * Updates the listener head orientation. May be called on any thread. See
* {@code GvrAudioSurround.updateNativeOrientation}. * {@code GvrAudioSurround.updateNativeOrientation}.
*
* @param w The w component of the quaternion.
* @param x The x component of the quaternion.
* @param y The y component of the quaternion.
* @param z The z component of the quaternion.
*/ */
public synchronized void updateOrientation(float w, float x, float y, float z) { public synchronized void updateOrientation(float w, float x, float y, float z) {
this.w = w; this.w = w;
......
...@@ -50,6 +50,8 @@ public final class ImaAdsMediaSource implements MediaSource { ...@@ -50,6 +50,8 @@ public final class ImaAdsMediaSource implements MediaSource {
* Called if there was an error loading ads. The media source will load the content without ads * Called if there was an error loading ads. The media source will load the content without ads
* if ads can't be loaded, so listen for this event if you need to implement additional handling * if ads can't be loaded, so listen for this event if you need to implement additional handling
* (for example, stopping the player). * (for example, stopping the player).
*
* @param error The error.
*/ */
void onAdLoadError(IOException error); void onAdLoadError(IOException error);
......
...@@ -54,6 +54,13 @@ public final class LibopusAudioRenderer extends SimpleDecoderAudioRenderer { ...@@ -54,6 +54,13 @@ public final class LibopusAudioRenderer extends SimpleDecoderAudioRenderer {
* @param eventHandler A handler to use when delivering events to {@code eventListener}. May be * @param eventHandler A handler to use when delivering events to {@code eventListener}. May be
* null if delivery of events is not required. * null if delivery of events is not required.
* @param eventListener A listener of events. May be null if delivery of events is not required. * @param eventListener A listener of events. May be null if delivery of events is not required.
* @param drmSessionManager For use with encrypted media. May be null if support for encrypted
* media is not required.
* @param playClearSamplesWithoutKeys Encrypted media may contain clear (un-encrypted) regions.
* For example a media file may start with a short clear region so as to allow playback to
* begin in parallel with key acquisition. This parameter specifies whether the renderer is
* permitted to play clear regions of encrypted media files before {@code drmSessionManager}
* has obtained the keys necessary to decrypt encrypted regions of the media.
* @param audioProcessors Optional {@link AudioProcessor}s that will process audio before output. * @param audioProcessors Optional {@link AudioProcessor}s that will process audio before output.
*/ */
public LibopusAudioRenderer(Handler eventHandler, AudioRendererEventListener eventListener, public LibopusAudioRenderer(Handler eventHandler, AudioRendererEventListener eventListener,
......
...@@ -35,6 +35,8 @@ public final class OpusLibrary { ...@@ -35,6 +35,8 @@ public final class OpusLibrary {
* Override the names of the Opus native libraries. If an application wishes to call this method, * Override the names of the Opus native libraries. If an application wishes to call this method,
* it must do so before calling any other method defined by this class, and before instantiating a * it must do so before calling any other method defined by this class, and before instantiating a
* {@link LibopusAudioRenderer} instance. * {@link LibopusAudioRenderer} instance.
*
* @param libraries The names of the Opus native libraries.
*/ */
public static void setLibraries(String... libraries) { public static void setLibraries(String... libraries) {
LOADER.setLibraries(libraries); LOADER.setLibraries(libraries);
......
...@@ -35,6 +35,8 @@ public final class VpxLibrary { ...@@ -35,6 +35,8 @@ public final class VpxLibrary {
* Override the names of the Vpx native libraries. If an application wishes to call this method, * Override the names of the Vpx native libraries. If an application wishes to call this method,
* it must do so before calling any other method defined by this class, and before instantiating a * it must do so before calling any other method defined by this class, and before instantiating a
* {@link LibvpxVideoRenderer} instance. * {@link LibvpxVideoRenderer} instance.
*
* @param libraries The names of the Vpx native libraries.
*/ */
public static void setLibraries(String... libraries) { public static void setLibraries(String... libraries) {
LOADER.setLibraries(libraries); LOADER.setLibraries(libraries);
......
...@@ -22,6 +22,8 @@ public interface VpxOutputBufferRenderer { ...@@ -22,6 +22,8 @@ public interface VpxOutputBufferRenderer {
/** /**
* Sets the output buffer to be rendered. The renderer is responsible for releasing the buffer. * Sets the output buffer to be rendered. The renderer is responsible for releasing the buffer.
*
* @param outputBuffer The output buffer to be rendered.
*/ */
void setOutputBuffer(VpxOutputBuffer outputBuffer); void setOutputBuffer(VpxOutputBuffer outputBuffer);
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or sign in to comment