TIF: make the documentation consistent. (1f81b104) · Commits · e / os / android_frameworks_base

media/java/android/media/tv/TvInputManager.java

+4 −4

Original line number	Diff line number	Diff line
		@@ -942,7 +942,7 @@ public final class TvInputManager {
		}

		/**
		* Set this as main session. See {@link TvView#setMainTvView} for about meaning of "main".
		* Sets this as main session. See {@link TvView#setMainTvView} for about meaning of "main".
		* @hide
		*/
		public void setMainSession() {
		@@ -1071,7 +1071,7 @@ public final class TvInputManager {
		}

		/**
		* Select a track.
		* Selects a track.
		*
		* @param track The track to be selected.
		* @see #getTracks()
		@@ -1092,7 +1092,7 @@ public final class TvInputManager {
		}

		/**
		* Unselect a track.
		* Unselects a track.
		*
		* @param track The track to be selected.
		* @see #getTracks()
		@@ -1139,7 +1139,7 @@ public final class TvInputManager {
		}

		/**
		* Call {@link TvInputService.Session#appPrivateCommand(String, Bundle)
		* Calls {@link TvInputService.Session#appPrivateCommand(String, Bundle)
		* TvInputService.Session.appPrivateCommand()} on the current TvView.
		*
		* @param action Name of the command to be performed. This <em>must</em> be a scoped name,

media/java/android/media/tv/TvTrackInfo.java

+13 −12

Original line number	Diff line number	Diff line
		@@ -85,7 +85,7 @@ public final class TvTrackInfo implements Parcelable {
		}

		/**
		* Returns the audio channel count. Valid for {@link #TYPE_AUDIO} tracks only.
		* Returns the audio channel count. Valid only for {@link #TYPE_AUDIO} tracks.
		*/
		public final int getAudioChannelCount() {
		if (mType != TYPE_AUDIO) {
		@@ -95,7 +95,7 @@ public final class TvTrackInfo implements Parcelable {
		}

		/**
		* Returns the audio sample rate, in the unit of Hz. Valid for {@link #TYPE_AUDIO} tracks only.
		* Returns the audio sample rate, in the unit of Hz. Valid only for {@link #TYPE_AUDIO} tracks.
		*/
		public final int getAudioSampleRate() {
		if (mType != TYPE_AUDIO) {
		@@ -105,8 +105,8 @@ public final class TvTrackInfo implements Parcelable {
		}

		/**
		* Returns the width of the video, in the unit of pixels. Valid for {@link #TYPE_VIDEO} tracks
		* only.
		* Returns the width of the video, in the unit of pixels. Valid only for {@link #TYPE_VIDEO}
		* tracks.
		*/
		public final int getVideoWidth() {
		if (mType != TYPE_VIDEO) {
		@@ -116,8 +116,8 @@ public final class TvTrackInfo implements Parcelable {
		}

		/**
		* Returns the height of the video, in the unit of pixels. Valid for {@link #TYPE_VIDEO} tracks
		* only.
		* Returns the height of the video, in the unit of pixels. Valid only for {@link #TYPE_VIDEO}
		* tracks.
		*/
		public final int getVideoHeight() {
		if (mType != TYPE_VIDEO) {
		@@ -206,7 +206,7 @@ public final class TvTrackInfo implements Parcelable {
		}

		/**
		* Sets the audio channel count. Valid for {@link #TYPE_AUDIO} tracks only.
		* Sets the audio channel count. Valid only for {@link #TYPE_AUDIO} tracks.
		*
		* @param audioChannelCount The audio channel count.
		*/
		@@ -219,7 +219,8 @@ public final class TvTrackInfo implements Parcelable {
		}

		/**
		* Sets the audio sample rate, in the unit of Hz. Valid for {@link #TYPE_AUDIO} tracks only.
		* Sets the audio sample rate, in the unit of Hz. Valid only for {@link #TYPE_AUDIO}
		* tracks.
		*
		* @param audioSampleRate The audio sample rate.
		*/
		@@ -232,8 +233,8 @@ public final class TvTrackInfo implements Parcelable {
		}

		/**
		* Sets the width of the video, in the unit of pixels. Valid for {@link #TYPE_VIDEO} tracks
		* only.
		* Sets the width of the video, in the unit of pixels. Valid only for {@link #TYPE_VIDEO}
		* tracks.
		*
		* @param videoWidth The width of the video.
		*/
		@@ -246,8 +247,8 @@ public final class TvTrackInfo implements Parcelable {
		}

		/**
		* Sets the height of the video, in the unit of pixels. Valid for {@link #TYPE_VIDEO} tracks
		* only.
		* Sets the height of the video, in the unit of pixels. Valid only for {@link #TYPE_VIDEO}
		* tracks.
		*
		* @param videoHeight The height of the video.
		*/

media/java/android/media/tv/TvView.java

+10 −10

Original line number	Diff line number	Diff line
		@@ -162,7 +162,7 @@ public class TvView extends ViewGroup {
		}

		/**
		* Set this as main TvView.
		* Sets this as main TvView.
		* <p>
		* Main TvView is the TvView which user is watching and interacting mainly. It is used for
		* determining internal behavior of hardware TV input devices. For example, this influences
		@@ -203,7 +203,7 @@ public class TvView extends ViewGroup {
		/**
		* Tunes to a given channel.
		*
		* @param inputId The id of TV input which will play the given channel.
		* @param inputId The ID of TV input which will play the given channel.
		* @param channelUri The URI of a channel.
		*/
		public void tune(String inputId, Uri channelUri) {
		@@ -213,7 +213,7 @@ public class TvView extends ViewGroup {
		/**
		* Tunes to a given channel.
		*
		* @param inputId The id of TV input which will play the given channel.
		* @param inputId The ID of TV input which will play the given channel.
		* @param channelUri The URI of a channel.
		* @param params Extra parameters which might be handled with the tune event.
		* @hide
		@@ -293,7 +293,7 @@ public class TvView extends ViewGroup {
		}

		/**
		* Select a track.
		* Selects a track.
		* <p>
		* If it is called multiple times on the same type of track (ie. Video, Audio, Text), the track
		* selected in previous will be unselected. Note that this method does not take any effect
		@@ -310,7 +310,7 @@ public class TvView extends ViewGroup {
		}

		/**
		* Unselect a track.
		* Unselects a track.
		* <p>
		* Note that this method does not take any effect unless the current TvView is tuned.
		*
		@@ -346,7 +346,7 @@ public class TvView extends ViewGroup {
		}

		/**
		* Call {@link TvInputService.Session#appPrivateCommand(String, Bundle)
		* Calls {@link TvInputService.Session#appPrivateCommand(String, Bundle)
		* TvInputService.Session.appPrivateCommand()} on the current TvView.
		*
		* @param action Name of the command to be performed. This <em>must</em> be a scoped name, i.e.
		@@ -385,8 +385,8 @@ public class TvView extends ViewGroup {
		}

		/**
		* Called when an unhandled input event was also not handled by the user provided callback. This
		* is the last chance to handle the unhandled input event in the TvView.
		* Called when an unhandled input event also has not been handled by the user provided
		* callback. This is the last chance to handle the unhandled input event in the TvView.
		*
		* @param event The input event.
		* @return If you handled the event, return {@code true}. If you want to allow the event to be
		@@ -397,9 +397,9 @@ public class TvView extends ViewGroup {
		}

		/**
		* Registers a callback to be invoked when an input event was not handled by the bound TV input.
		* Registers a callback to be invoked when an input event is not handled by the bound TV input.
		*
		* @param listener The callback to invoke when the unhandled input event was received.
		* @param listener The callback to be invoked when the unhandled input event is received.
		*/
		public void setOnUnhandledInputEventListener(OnUnhandledInputEventListener listener) {
		mOnUnhandledInputEventListener = listener;