fix: docstrings

This commit is contained in:
ThetaDev 2023-03-20 23:58:03 +01:00
parent f5c33ac0ac
commit d8435560b5
3 changed files with 14 additions and 7 deletions

View File

@ -324,8 +324,9 @@ public final class YoutubeDashManifestCreatorsUtils {
return "dub"; return "dub";
case DESCRIPTIVE: case DESCRIPTIVE:
return "description"; return "description";
default:
return "alternate";
} }
return "alternate";
} }
return "main"; return "main";
} }

View File

@ -500,6 +500,12 @@ public final class AudioStream extends Stream {
return audioLocale; return audioLocale;
} }
/**
* Get the {@link AudioTrackType} of the stream, which is {@code null} if the track type
* is not known.
*
* @return the {@link AudioTrackType} of the stream or {@code null}
*/
@Nullable @Nullable
public AudioTrackType getAudioTrackType() { public AudioTrackType getAudioTrackType() {
return audioTrackType; return audioTrackType;

View File

@ -6,12 +6,12 @@ package org.schabi.newpipe.extractor.stream;
*/ */
public enum AudioTrackType { public enum AudioTrackType {
/** /**
* The original audio track of the video * An original audio track of the video.
*/ */
ORIGINAL, ORIGINAL,
/** /**
* Audio track with the original voices replaced, typically in a different language * An audio track with the original voices replaced, typically in a different language.
* *
* @see <a href="https://en.wikipedia.org/wiki/Dubbing"> * @see <a href="https://en.wikipedia.org/wiki/Dubbing">
* https://en.wikipedia.org/wiki/Dubbing</a> * https://en.wikipedia.org/wiki/Dubbing</a>
@ -19,11 +19,11 @@ public enum AudioTrackType {
DUBBED, DUBBED,
/** /**
* Descriptive audio * A descriptive audio track.
* <p> * <p>
* A descriptive audio is an audio in which descriptions of visual elements of a video are * A descriptive audio track is an audio track in which descriptions of visual elements of
* added in the original audio, with the goal to make a video more accessible to blind and * a video are added to the original audio, with the goal to make a video more accessible to
* visually impaired people. * blind and visually impaired people.
* </p> * </p>
* *
* @see <a href="https://en.wikipedia.org/wiki/Audio_description"> * @see <a href="https://en.wikipedia.org/wiki/Audio_description">