org.schabi.newpipe.extractor.stream

Interface StreamInfoItemExtractor

All Superinterfaces:

InfoItemExtractor

All Known Implementing Classes:

BandcampDiscographStreamInfoItemExtractor, BandcampPlaylistStreamInfoItemExtractor, BandcampRadioInfoItemExtractor, BandcampSearchStreamInfoItemExtractor, BandcampStreamInfoItemExtractor, MediaCCCLiveStreamKioskExtractor, MediaCCCRecentKioskExtractor, MediaCCCStreamInfoItemExtractor, PeertubeSepiaStreamInfoItemExtractor, PeertubeStreamInfoItemExtractor, SoundcloudStreamInfoItemExtractor, YoutubeFeedInfoItemExtractor, YoutubeStreamInfoItemExtractor

public interface StreamInfoItemExtractor
extends InfoItemExtractor

Method Summary

Modifier and Type	Method and Description
long	getDuration() Get the stream duration in seconds
default String	getShortDescription() Get the video's short description.
StreamType	getStreamType() Get the stream type
String	getTextualUploadDate() The original textual date provided by the service.
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()
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 interface org.schabi.newpipe.extractor.InfoItemExtractor

getName, getThumbnailUrl, getUrl

Method Detail

getStreamType

StreamType getStreamType()
                  throws ParsingException

Get the stream type

Returns:

the stream type

Throws:

ParsingException - thrown if there is an error in the extraction

isAd

boolean isAd()
      throws ParsingException

Check if the stream is an ad.

Returns:

true if the stream is an ad.

Throws:

ParsingException - thrown if there is an error in the extraction

getDuration

long getDuration()
          throws ParsingException

Get the stream duration in seconds

Returns:

the stream duration in seconds

Throws:

ParsingException - thrown if there is an error in the extraction

getViewCount

long getViewCount()
           throws ParsingException

Parses the number of views

Returns:

the number of views or -1 for live streams

Throws:

ParsingException - thrown if there is an error in the extraction

getUploaderName

String getUploaderName()
                throws ParsingException

Get the uploader name

Returns:

the uploader name

Throws:

ParsingException - if parsing fails

getUploaderUrl

String getUploaderUrl()
               throws ParsingException

Throws:

ParsingException

getUploaderAvatarUrl

@Nullable
String getUploaderAvatarUrl()
                               throws ParsingException

Get the uploader's avatar

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

boolean isUploaderVerified()
                    throws ParsingException

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

Returns:

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

Throws:

ParsingException

getTextualUploadDate

@Nullable
String getTextualUploadDate()
                               throws ParsingException

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

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:

getUploadDate()

getUploadDate

@Nullable
DateWrapper getUploadDate()
                             throws ParsingException

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.

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:

getTextualUploadDate()

getShortDescription

@Nullable
default String getShortDescription()
                                      throws ParsingException

Get the video's short description.

Returns:

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

Throws:

ParsingException - if there is an error in the extraction