YoutubeStreamExtractor (NewPipeExtractor v0.22.1)

java.lang.Object
- org.schabi.newpipe.extractor.Extractor
- - org.schabi.newpipe.extractor.stream.StreamExtractor
  - - org.schabi.newpipe.extractor.services.youtube.extractors.YoutubeStreamExtractor

public class YoutubeStreamExtractor
extends StreamExtractor

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class YoutubeStreamExtractor.DeobfuscateException
- Nested classes/interfaces inherited from class org.schabi.newpipe.extractor.stream.StreamExtractor
  StreamExtractor.Privacy

Nested Classes
Modifier and Type	Class and Description
`static class`	`YoutubeStreamExtractor.DeobfuscateException`

Field Summary
- Fields inherited from class org.schabi.newpipe.extractor.stream.StreamExtractor
  NO_AGE_LIMIT, UNKNOWN_SUBSCRIBER_COUNT

Constructor Summary

Constructors
Constructor and Description

YoutubeStreamExtractor(StreamingService service, LinkHandler linkHandler)

Constructors
Constructor and Description
`YoutubeStreamExtractor(StreamingService service, LinkHandler linkHandler)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`forceFetchAndroidClient(boolean forceFetchAndroidClientValue)` Enable or disable the fetch of the Android client for all stream types.
`static void`	`forceFetchIosClient(boolean forceFetchIosClientValue)` Enable or disable the fetch of the iOS client for all stream types.
`int`	`getAgeLimit()` Get the age limit.
`List<AudioStream>`	`getAudioStreams()` This should return a list of available `AudioStream`s.
`String`	`getCategory()` The name of the category of the stream.
`String`	`getDashMpdUrl()` Get the dash mpd url.
`Description`	`getDescription()` This is the stream description.
`String`	`getErrorMessage()` Should analyse the webpage's document and extracts any error message there might be.
`List<Frameset>`	`getFrames()` Should return a list of Frameset object that contains preview of stream frames
`String`	`getHlsUrl()` I am not sure if this is in use, and how this is used.
`Locale`	`getLanguageInfo()` The locale language of the stream.
`long`	`getLength()` This should return the length of a video in seconds.
`String`	`getLicence()` The name of the licence of the stream.
`long`	`getLikeCount()` The amount of likes a video/audio stream got.
`List<MetaInfo>`	`getMetaInfo()` Meta information about the stream.
`String`	`getName()` Get the name
`StreamExtractor.Privacy`	`getPrivacy()` The privacy of the stream (Eg.
`MultiInfoItemsCollector`	`getRelatedItems()` Should return a list of streams related to the current handled.
`List<StreamSegment>`	`getStreamSegments()` The list of stream segments by timestamps for the stream.
`StreamType`	`getStreamType()` Get the `StreamType`.
`List<SubtitlesStream>`	`getSubtitles(MediaFormat format)` This will return a list of available `SubtitlesStream`s given by a specific type.
`List<SubtitlesStream>`	`getSubtitlesDefault()` This will return a list of available `SubtitlesStream`s.
`List<String>`	`getTags()` The list of tags of the stream.
`String`	`getTextualUploadDate()` The original textual date provided by the service.
`String`	`getThumbnailUrl()` This will return the url to the thumbnail of the stream.
`long`	`getTimeStamp()` Attempts to parse (and return) the offset to start playing the video from.
`DateWrapper`	`getUploadDate()` A more general `Calendar` instance set to the date provided by the service. Implementations usually will just parse the date returned from the `StreamExtractor.getTextualUploadDate()`.
`String`	`getUploaderAvatarUrl()` The url to the image file/profile picture/avatar of the creator/uploader of the stream.
`String`	`getUploaderName()` The name of the creator/uploader of the stream.
`long`	`getUploaderSubscriberCount()` The subscriber count of the uploader.
`String`	`getUploaderUrl()` The Url to the page of the creator/uploader of the stream.
`List<VideoStream>`	`getVideoOnlyStreams()` This should return a list of available `VideoStream`s.
`List<VideoStream>`	`getVideoStreams()` This should return a list of available `VideoStream`s.
`long`	`getViewCount()` The count of how many people have watched the video/listened to the audio stream.
`boolean`	`isUploaderVerified()` Whether the uploader has been verified by the service's provider.
`void`	`onFetchPage(Downloader downloader)` Fetch the current page.
`static void`	`resetDeobfuscationCode()` Reset YouTube's deobfuscation code.

Methods inherited from class org.schabi.newpipe.extractor.stream.StreamExtractor
getDislikeCount, getHost, getRelatedStreams, getSubChannelAvatarUrl, getSubChannelName, getSubChannelUrl, getSupportInfo, getTimestampSeconds

Methods inherited from class org.schabi.newpipe.extractor.Extractor
assertPageFetched, fetchPage, forceContentCountry, forceLocalization, getBaseUrl, getDownloader, getExtractorContentCountry, getExtractorLocalization, getId, getLinkHandler, getOriginalUrl, getService, getServiceId, getTimeAgoParser, getUrl, isPageFetched

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - YoutubeStreamExtractor
```
public YoutubeStreamExtractor(StreamingService service,
                              LinkHandler linkHandler)
```
- Method Detail
  - getName
```
@Nonnull
public String getName()
                        throws ParsingException
```
    Description copied from class: Extractor
    
    Get the name
    
    Specified by:
    
    getName in class Extractor
    
    Returns:
    
    the name
    
    Throws:
    
    ParsingException - if the name cannot be extracted
  - getTextualUploadDate
```
@Nullable
public String getTextualUploadDate()
                                      throws ParsingException
```
    Description copied from class: StreamExtractor
    
    The original textual date provided by the service. Should be used as a fallback if StreamExtractor.getUploadDate() isn't provided by the service, or it fails for some reason.
    If the stream is a live stream, null should be returned.
    
    Overrides:
    
    getTextualUploadDate in class StreamExtractor
    
    Returns:
    
    The original textual date provided by the service, or null.
    
    Throws:
    
    ParsingException - if there is an error in the extraction
    
    See Also:
    
    StreamExtractor.getUploadDate()
  - getUploadDate
```
public DateWrapper getUploadDate()
                          throws ParsingException
```
    Description copied from class: StreamExtractor
    
    A more general Calendar instance set to the date provided by the service.
    Implementations usually will just parse the date returned from the StreamExtractor.getTextualUploadDate().
    If the stream is a live stream, null should be returned.
    
    Overrides:
    
    getUploadDate in class StreamExtractor
    
    Returns:
    
    The date this item was uploaded, or null.
    
    Throws:
    
    ParsingException - if there is an error in the extraction or the extracted date couldn't be parsed.
    
    See Also:
    
    StreamExtractor.getTextualUploadDate()
  - getThumbnailUrl
```
@Nonnull
public String getThumbnailUrl()
                                throws ParsingException
```
    Description copied from class: StreamExtractor
    
    This will return the url to the thumbnail of the stream. Try to return the medium resolution here.
    
    Specified by:
    
    getThumbnailUrl in class StreamExtractor
    
    Returns:
    
    The url of the thumbnail.
    
    Throws:
    
    ParsingException
  - getDescription
```
@Nonnull
public Description getDescription()
                                    throws ParsingException
```
    Description copied from class: StreamExtractor
    
    This is the stream description.
    
    Overrides:
    
    getDescription in class StreamExtractor
    
    Returns:
    
    The description of the stream/video or Description.EMPTY_DESCRIPTION if the description is empty.
    
    Throws:
    
    ParsingException
  - getAgeLimit
```
public int getAgeLimit()
                throws ParsingException
```
    Description copied from class: StreamExtractor
    
    Get the age limit.
    
    Overrides:
    
    getAgeLimit in class StreamExtractor
    
    Returns:
    
    The age which limits the content or 0 if there is no limit
    
    Throws:
    
    ParsingException - if an error occurs while parsing
  - getLength
```
public long getLength()
               throws ParsingException
```
    Description copied from class: StreamExtractor
    
    This should return the length of a video in seconds.
    
    Overrides:
    
    getLength in class StreamExtractor
    
    Returns:
    
    The length of the stream in seconds or 0 when it has no length (e.g. a livestream).
    
    Throws:
    
    ParsingException
  - getTimeStamp
```
public long getTimeStamp()
                  throws ParsingException
```
    Attempts to parse (and return) the offset to start playing the video from.
    
    Overrides:
    
    getTimeStamp in class StreamExtractor
    
    Returns:
    
    the offset (in seconds), or 0 if no timestamp is found.
    
    Throws:
    
    ParsingException
  - getViewCount
```
public long getViewCount()
                  throws ParsingException
```
    Description copied from class: StreamExtractor
    
    The count of how many people have watched the video/listened to the audio stream. If the current stream has no view count or its not available simply return -1
    
    Overrides:
    
    getViewCount in class StreamExtractor
    
    Returns:
    
    amount of views or -1 if not available.
    
    Throws:
    
    ParsingException
  - getLikeCount
```
public long getLikeCount()
                  throws ParsingException
```
    Description copied from class: StreamExtractor
    
    The amount of likes a video/audio stream got. If the current stream has no likes or its not available simply return -1
    
    Overrides:
    
    getLikeCount in class StreamExtractor
    
    Returns:
    
    the amount of likes the stream got or -1 if not available.
    
    Throws:
    
    ParsingException
  - getUploaderUrl
```
@Nonnull
public String getUploaderUrl()
                               throws ParsingException
```
    Description copied from class: StreamExtractor
    
    The Url to the page of the creator/uploader of the stream. This must not be a homepage, but the page offered by the service the extractor handles. This url will be handled by the ChannelExtractor, so be sure to implement that one before you return a value here, otherwise NewPipe will crash if one selects this url.
    
    Specified by:
    
    getUploaderUrl in class StreamExtractor
    
    Returns:
    
    the url to the page of the creator/uploader of the stream or an empty string
    
    Throws:
    
    ParsingException
  - getUploaderName
```
@Nonnull
public String getUploaderName()
                                throws ParsingException
```
    Description copied from class: StreamExtractor
    
    The name of the creator/uploader of the stream. If the name is not available you can simply return an empty string.
    
    Specified by:
    
    getUploaderName in class StreamExtractor
    
    Returns:
    
    the name of the creator/uploader of the stream or an empty tring
    
    Throws:
    
    ParsingException
  - isUploaderVerified
```
public boolean isUploaderVerified()
                           throws ParsingException
```
    Description copied from class: StreamExtractor
    
    Whether the uploader has been verified by the service's provider. If there is no verification implemented, return false.
    
    Overrides:
    
    isUploaderVerified in class StreamExtractor
    
    Returns:
    
    whether the uploader has been verified by the service's provider
    
    Throws:
    
    ParsingException
  - getUploaderAvatarUrl
```
@Nonnull
public String getUploaderAvatarUrl()
                                     throws ParsingException
```
    Description copied from class: StreamExtractor
    
    The url to the image file/profile picture/avatar of the creator/uploader of the stream. If the url is not available you can return an empty String.
    
    Overrides:
    
    getUploaderAvatarUrl in class StreamExtractor
    
    Returns:
    
    The url of the image file of the uploader or an empty String
    
    Throws:
    
    ParsingException
  - getUploaderSubscriberCount
```
public long getUploaderSubscriberCount()
                                throws ParsingException
```
    Description copied from class: StreamExtractor
    
    The subscriber count of the uploader. If the subscriber count is not implemented, or is unavailable, return -1.
    
    Overrides:
    
    getUploaderSubscriberCount in class StreamExtractor
    
    Returns:
    
    the subscriber count of the uploader or -1L if not available
    
    Throws:
    
    ParsingException
  - getDashMpdUrl
```
@Nonnull
public String getDashMpdUrl()
                              throws ParsingException
```
    Description copied from class: StreamExtractor
    
    Get the dash mpd url. If you don't know what a dash MPD is you can read about it here.
    
    Overrides:
    
    getDashMpdUrl in class StreamExtractor
    
    Returns:
    
    the url as a string or an empty string or an empty string if not available
    
    Throws:
    
    ParsingException - if an error occurs while reading
  - getHlsUrl
```
@Nonnull
public String getHlsUrl()
                          throws ParsingException
```
    Description copied from class: StreamExtractor
    
    I am not sure if this is in use, and how this is used. However the frontend is missing support for HLS streams. Prove me if I am wrong. Please open an issue, or fix this description if you know whats up with this.
    
    Overrides:
    
    getHlsUrl in class StreamExtractor
    
    Returns:
    
    The Url to the hls stream or an empty string if not available.
    
    Throws:
    
    ParsingException
  - getAudioStreams
```
public List<AudioStream> getAudioStreams()
                                  throws ExtractionException
```
    Description copied from class: StreamExtractor
    
    This should return a list of available AudioStreams. You can also return null or an empty list, however be aware that if you don't return anything in getVideoStreams(), getVideoOnlyStreams() and getDashMpdUrl() either the Collector will handle this as a failed extraction procedure.
    
    Specified by:
    
    getAudioStreams in class StreamExtractor
    
    Returns:
    
    a list of audio only streams in the format of AudioStream
    
    Throws:
    
    ExtractionException
  - getVideoStreams
```
public List<VideoStream> getVideoStreams()
                                  throws ExtractionException
```
    Description copied from class: StreamExtractor
    
    This should return a list of available VideoStreams. Be aware this is the list of video streams which do contain an audio stream. You can also return null or an empty list, however be aware that if you don't return anything in getAudioStreams(), getVideoOnlyStreams() and getDashMpdUrl() either the Collector will handle this as a failed extraction procedure.
    
    Specified by:
    
    getVideoStreams in class StreamExtractor
    
    Returns:
    
    a list of combined video and streams in the format of AudioStream
    
    Throws:
    
    ExtractionException
  - getVideoOnlyStreams
```
public List<VideoStream> getVideoOnlyStreams()
                                      throws ExtractionException
```
    Description copied from class: StreamExtractor
    
    This should return a list of available VideoStreams. Be aware this is the list of video streams which do NOT contain an audio stream. You can also return null or an empty list, however be aware that if you don't return anything in getAudioStreams(), getVideoStreams() and getDashMpdUrl() either the Collector will handle this as a failed extraction procedure.
    
    Specified by:
    
    getVideoOnlyStreams in class StreamExtractor
    
    Returns:
    
    a list of video and streams in the format of AudioStream
    
    Throws:
    
    ExtractionException
  - getSubtitlesDefault
```
@Nonnull
public List<SubtitlesStream> getSubtitlesDefault()
                                                   throws ParsingException
```
    Description copied from class: StreamExtractor
    
    This will return a list of available SubtitlesStreams. If no subtitles are available an empty list can be returned.
    
    Overrides:
    
    getSubtitlesDefault in class StreamExtractor
    
    Returns:
    
    a list of available subtitles or an empty list
    
    Throws:
    
    ParsingException
  - getSubtitles
```
@Nonnull
public List<SubtitlesStream> getSubtitles(MediaFormat format)
                                            throws ParsingException
```
    Description copied from class: StreamExtractor
    
    This will return a list of available SubtitlesStreams given by a specific type. If no subtitles in that specific format are available an empty list can be returned.
    
    Overrides:
    
    getSubtitles in class StreamExtractor
    
    Parameters:
    
    format - the media format by which the subtitles should be filtered
    
    Returns:
    
    a list of available subtitles or an empty list
    
    Throws:
    
    ParsingException
  - getStreamType
```
public StreamType getStreamType()
```
    Description copied from class: StreamExtractor
    
    Get the StreamType.
    
    Specified by:
    
    getStreamType in class StreamExtractor
    
    Returns:
    
    the type of the stream
  - getRelatedItems
```
@Nullable
public MultiInfoItemsCollector getRelatedItems()
                                                  throws ExtractionException
```
    Description copied from class: StreamExtractor
    
    Should return a list of streams related to the current handled. Many services show suggested streams. If you don't like suggested streams you should implement them anyway since they can be disabled by the user later in the frontend. The first related stream might be what was previously known as a next stream. If related streams aren't available simply return null.
    
    Overrides:
    
    getRelatedItems in class StreamExtractor
    
    Returns:
    
    a list of InfoItems showing the related videos/streams
    
    Throws:
    
    ExtractionException
  - getErrorMessage
```
public String getErrorMessage()
```
    Should analyse the webpage's document and extracts any error message there might be.
    
    Overrides:
    
    getErrorMessage in class StreamExtractor
    
    Returns:
    
    Error message; null if there is no error message.
  - onFetchPage
```
public void onFetchPage(@Nonnull
                        Downloader downloader)
                 throws IOException,
                        ExtractionException
```
    Description copied from class: Extractor
    
    Fetch the current page.
    
    Specified by:
    
    onFetchPage in class Extractor
    
    Parameters:
    
    downloader - the downloader to use
    
    Throws:
    
    IOException - if the page can not be loaded
    
    ExtractionException - if the pages content is not understood
  - getFrames
```
@Nonnull
public List<Frameset> getFrames()
                                  throws ExtractionException
```
    Description copied from class: StreamExtractor
    
    Should return a list of Frameset object that contains preview of stream frames
    
    Overrides:
    
    getFrames in class StreamExtractor
    
    Returns:
    
    list of preview frames or empty list if frames preview is not supported or not found for specified stream
    
    Throws:
    
    ExtractionException
  - getPrivacy
```
@Nonnull
public StreamExtractor.Privacy getPrivacy()
```
    Description copied from class: StreamExtractor
    
    The privacy of the stream (Eg. Public, Private, Unlisted…).
    
    Overrides:
    
    getPrivacy in class StreamExtractor
    
    Returns:
    
    the privacy of the stream.
  - getCategory
```
@Nonnull
public String getCategory()
```
    Description copied from class: StreamExtractor
    
    The name of the category of the stream. If the category is not available you can simply return an empty string.
    
    Overrides:
    
    getCategory in class StreamExtractor
    
    Returns:
    
    the category of the stream or an empty string.
  - getLicence
```
@Nonnull
public String getLicence()
                           throws ParsingException
```
    Description copied from class: StreamExtractor
    
    The name of the licence of the stream. If the licence is not available you can simply return an empty string.
    
    Overrides:
    
    getLicence in class StreamExtractor
    
    Returns:
    
    the licence of the stream or an empty String.
    
    Throws:
    
    ParsingException
  - getLanguageInfo
```
public Locale getLanguageInfo()
```
    Description copied from class: StreamExtractor
    
    The locale language of the stream. If the language is not available you can simply return null. If the language is provided by a language code, you can return new Locale(language_code);
    
    Overrides:
    
    getLanguageInfo in class StreamExtractor
    
    Returns:
    
    the locale language of the stream or null.
  - getTags
```
@Nonnull
public List<String> getTags()
```
    Description copied from class: StreamExtractor
    
    The list of tags of the stream. If the tag list is not available you can simply return an empty list.
    
    Overrides:
    
    getTags in class StreamExtractor
    
    Returns:
    
    the list of tags of the stream or Collections.emptyList().
  - getStreamSegments
```
@Nonnull
public List<StreamSegment> getStreamSegments()
                                               throws ParsingException
```
    Description copied from class: StreamExtractor
    
    The list of stream segments by timestamps for the stream. If the segment list is not available you can simply return an empty list.
    
    Overrides:
    
    getStreamSegments in class StreamExtractor
    
    Returns:
    
    The list of segments of the stream or an empty list.
    
    Throws:
    
    ParsingException
  - getMetaInfo
```
@Nonnull
public List<MetaInfo> getMetaInfo()
                                    throws ParsingException
```
    Description copied from class: StreamExtractor
    
    Meta information about the stream.
    This can be information about the stream creator (e.g. if the creator is a public broadcaster) or further information on the topic (e.g. hints that the video might contain conspiracy theories or contains information about a current health situation like the Covid-19 pandemic).
    The meta information often contains links to external sources like Wikipedia or the WHO.
    
    Overrides:
    
    getMetaInfo in class StreamExtractor
    
    Returns:
    
    The meta info of the stream or an empty list if not provided.
    
    Throws:
    
    ParsingException
  - resetDeobfuscationCode
```
public static void resetDeobfuscationCode()
```
    Reset YouTube's deobfuscation code.
    This is needed for mocks in YouTube stream tests, because when they are ran, the signatureTimestamp is known (the sts string) so a different body than the body present in the mocks is send by the extractor instance. As a result, running all YouTube stream tests with the MockDownloader (like the CI does) will fail if this method is not called before fetching the page of a test.
  - forceFetchAndroidClient
```
public static void forceFetchAndroidClient(boolean forceFetchAndroidClientValue)
```
    Enable or disable the fetch of the Android client for all stream types.
    By default, the fetch of the Android client will be made only on videos, in order to reduce data usage, because available streams of the Android client will be almost equal to the ones available on the WEB client: you can get exclusively a 48kbps audio stream and a 3GPP very low stream (which is, most of times, a 144p8 stream).
    
    Parameters:
    
    forceFetchAndroidClientValue - whether to always fetch the Android client and not only for videos
  - forceFetchIosClient
```
public static void forceFetchIosClient(boolean forceFetchIosClientValue)
```
    Enable or disable the fetch of the iOS client for all stream types.
    By default, the fetch of the iOS client will be made only on livestreams, in order to get an HLS manifest with separated audio and video which has also an higher replay time (up to one hour, depending of the content instead of 30 seconds with non-iOS clients).
    
    Enabling this option will allow you to get an HLS manifest also for regular videos, which contains resolutions up to 1080p60.
    
    Parameters:
    
    forceFetchIosClientValue - whether to always fetch the iOS client and not only for livestreams

Class YoutubeStreamExtractor

Nested Class Summary

Nested classes/interfaces inherited from class org.schabi.newpipe.extractor.stream.StreamExtractor

Field Summary

Fields inherited from class org.schabi.newpipe.extractor.stream.StreamExtractor

Constructor Summary

Method Summary

Methods inherited from class org.schabi.newpipe.extractor.stream.StreamExtractor

Methods inherited from class org.schabi.newpipe.extractor.Extractor

Methods inherited from class java.lang.Object

Constructor Detail

YoutubeStreamExtractor

Method Detail

getName

getTextualUploadDate

getUploadDate

getThumbnailUrl

getDescription

getAgeLimit

getLength

getTimeStamp

getViewCount

getLikeCount

getUploaderUrl

getUploaderName

isUploaderVerified

getUploaderAvatarUrl

getUploaderSubscriberCount

getDashMpdUrl

getHlsUrl

getAudioStreams

getVideoStreams

getVideoOnlyStreams

getSubtitlesDefault

getSubtitles

getStreamType

getRelatedItems

getErrorMessage

onFetchPage

getFrames

getPrivacy

getCategory

getLicence

getLanguageInfo

getTags

getStreamSegments

getMetaInfo

resetDeobfuscationCode

forceFetchAndroidClient

forceFetchIosClient