org.schabi.newpipe.extractor.services.youtube.extractors

Class YoutubeStreamInfoItemExtractor

java.lang.Object

org.schabi.newpipe.extractor.services.youtube.extractors.YoutubeStreamInfoItemExtractor

All Implemented Interfaces:

InfoItemExtractor, StreamInfoItemExtractor

public class YoutubeStreamInfoItemExtractor
extends Object
implements StreamInfoItemExtractor

Constructor Summary

Constructors

Constructor and Description
YoutubeStreamInfoItemExtractor(com.grack.nanojson.JsonObject videoInfoItem, TimeAgoParser timeAgoParser) Creates an extractor of StreamInfoItems from a YouTube page.

Method Summary

Modifier and Type	Method and Description
long	getDuration() Get the stream duration in seconds
String	getName()
String	getShortDescription() Get the video's short description.
StreamType	getStreamType() Get the stream type
String	getTextualUploadDate() The original textual date provided by the service.
String	getThumbnailUrl()
DateWrapper	getUploadDate() Extracts the upload date and time of this item and parses it.
String	getUploaderAvatarUrl() Get the uploader's avatar
String	getUploaderName() Get the uploader name
String	getUploaderUrl()
String	getUrl()
long	getViewCount() Parses the number of views
boolean	isAd() Check if the stream is an ad.
boolean	isUploaderVerified() Whether the uploader has been verified by the service's provider.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

YoutubeStreamInfoItemExtractor

public YoutubeStreamInfoItemExtractor(com.grack.nanojson.JsonObject videoInfoItem,
                                      @Nullable
                                      TimeAgoParser timeAgoParser)

Creates an extractor of StreamInfoItems from a YouTube page.

Parameters:

videoInfoItem - The JSON page element

timeAgoParser - A parser of the textual dates or null.

Method Detail

getStreamType

public StreamType getStreamType()

Description copied from interface: StreamInfoItemExtractor

Get the stream type

Specified by:

getStreamType in interface StreamInfoItemExtractor

Returns:

the stream type

isAd

public boolean isAd()
             throws ParsingException

Description copied from interface: StreamInfoItemExtractor

Check if the stream is an ad.

Specified by:

isAd in interface StreamInfoItemExtractor

Returns:

true if the stream is an ad.

Throws:

ParsingException - thrown if there is an error in the extraction

getUrl

public String getUrl()
              throws ParsingException

Specified by:

getUrl in interface InfoItemExtractor

Throws:

ParsingException

getName

public String getName()
               throws ParsingException

Specified by:

getName in interface InfoItemExtractor

Throws:

ParsingException

getDuration

public long getDuration()
                 throws ParsingException

Description copied from interface: StreamInfoItemExtractor

Get the stream duration in seconds

Specified by:

getDuration in interface StreamInfoItemExtractor

Returns:

the stream duration in seconds

Throws:

ParsingException - thrown if there is an error in the extraction

getUploaderName

public String getUploaderName()
                       throws ParsingException

Description copied from interface: StreamInfoItemExtractor

Get the uploader name

Specified by:

getUploaderName in interface StreamInfoItemExtractor

Returns:

the uploader name

Throws:

ParsingException - if parsing fails

getUploaderUrl

public String getUploaderUrl()
                      throws ParsingException

Specified by:

getUploaderUrl in interface StreamInfoItemExtractor

Throws:

ParsingException

getUploaderAvatarUrl

@Nullable
public String getUploaderAvatarUrl()
                                      throws ParsingException

Description copied from interface: StreamInfoItemExtractor

Get the uploader's avatar

Specified by:

getUploaderAvatarUrl in interface StreamInfoItemExtractor

Returns:

The uploader's avatar url or null if not provided by the service.

Throws:

ParsingException - if there is an error in the extraction

isUploaderVerified

public boolean isUploaderVerified()
                           throws ParsingException

Description copied from interface: StreamInfoItemExtractor

Whether the uploader has been verified by the service's provider. If there is no verification implemented, return false.

Specified by:

isUploaderVerified in interface StreamInfoItemExtractor

Returns:

whether the uploader has been verified by the service's provider

Throws:

ParsingException

getTextualUploadDate

@Nullable
public String getTextualUploadDate()
                                      throws ParsingException

Description copied from interface: StreamInfoItemExtractor

The original textual date provided by the service. Should be used as a fallback if StreamInfoItemExtractor.getUploadDate() isn't provided by the service, or it fails for some reason.

Specified by:

getTextualUploadDate in interface StreamInfoItemExtractor

Returns:

The original textual date provided by the service or null if not provided.

Throws:

ParsingException - if there is an error in the extraction

See Also:

StreamInfoItemExtractor.getUploadDate()

getUploadDate

@Nullable
public DateWrapper getUploadDate()
                                    throws ParsingException

Description copied from interface: StreamInfoItemExtractor

Extracts the upload date and time of this item and parses it.

If the service doesn't provide an exact time, an approximation can be returned.
If the service doesn't provide any date at all, then null should be returned.

Specified by:

getUploadDate in interface StreamInfoItemExtractor

Returns:

The date and time (can be approximated) 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:

StreamInfoItemExtractor.getTextualUploadDate()

getViewCount

public long getViewCount()
                  throws ParsingException

Description copied from interface: StreamInfoItemExtractor

Parses the number of views

Specified by:

getViewCount in interface StreamInfoItemExtractor

Returns:

the number of views or -1 for live streams

Throws:

ParsingException - thrown if there is an error in the extraction

getThumbnailUrl

public String getThumbnailUrl()
                       throws ParsingException

Specified by:

getThumbnailUrl in interface InfoItemExtractor

Throws:

ParsingException

getShortDescription

@Nullable
public String getShortDescription()
                                     throws ParsingException

Description copied from interface: StreamInfoItemExtractor

Get the video's short description.

Specified by:

getShortDescription in interface StreamInfoItemExtractor

Returns:

The video's short description or null if not provided by the service.

Throws:

ParsingException - if there is an error in the extraction