Overview
The PlaylistExtractor class extracts information about playlists and video collections from streaming services. It extends ListExtractor<StreamInfoItem> and provides methods to retrieve playlist metadata, uploader information, and paginated stream items.
Package: org.schabi.newpipe.extractor.playlist
Extends: ListExtractor<StreamInfoItem>
Constructor
The streaming service this extractor belongs to
The list link handler containing URL information for this playlist
getId()
public String getId() throws ParsingException
getName()
public abstract String getName() throws ParsingException
getUrl()
public String getUrl() throws ParsingException
getOriginalUrl()
public String getOriginalUrl() throws ParsingException
getBaseUrl()
public String getBaseUrl() throws ParsingException
fetchPage()
public void fetchPage() throws IOException, ExtractionException
getService()
public StreamingService getService()
The associated streaming service
getServiceId()
public int getServiceId()
getInitialPage()
public abstract InfoItemsPage<StreamInfoItem> getInitialPage() throws IOException, ExtractionException
return
InfoItemsPage<StreamInfoItem>
Page object containing initial stream items and next page reference
getPage()
public abstract InfoItemsPage<StreamInfoItem> getPage(Page page) throws IOException, ExtractionException
The page reference obtained from a previous page’s getNextPage() method
return
InfoItemsPage<StreamInfoItem>
Page object containing stream items and next page reference
getDescription()
public abstract Description getDescription() throws ParsingException
The playlist description object
getThumbnails()
public List<Image> getThumbnails() throws ParsingException
List of thumbnail images, or empty list if unavailable
getBanners()
public List<Image> getBanners() throws ParsingException
List of banner images, or empty list if unavailable
getStreamCount()
public abstract long getStreamCount() throws ParsingException
Total stream count, or -1 if unavailable
getPlaylistType()
public PlaylistInfo.PlaylistType getPlaylistType() throws ParsingException
return
PlaylistInfo.PlaylistType
The playlist type enum value (defaults to NORMAL)
getUploaderName()
public abstract String getUploaderName() throws ParsingException
getUploaderUrl()
public abstract String getUploaderUrl() throws ParsingException
getUploaderAvatars()
public abstract List<Image> getUploaderAvatars() throws ParsingException
List of uploader avatar images
isUploaderVerified()
public abstract boolean isUploaderVerified() throws ParsingException
true if verified, false otherwise
Sub-Channel Methods
getSubChannelName()
public String getSubChannelName() throws ParsingException
Sub-channel name, or empty string if not applicable
getSubChannelUrl()
public String getSubChannelUrl() throws ParsingException
Sub-channel URL, or empty string if not applicable
getSubChannelAvatars()
public List<Image> getSubChannelAvatars() throws ParsingException
List of sub-channel avatars, or empty list if not applicable
Localization Methods
forceLocalization()
public void forceLocalization(Localization localization)
forceContentCountry()
public void forceContentCountry(ContentCountry contentCountry)
The content country to use
Usage Example
StreamingService service = NewPipe.getService("YouTube");
PlaylistExtractor extractor = service.getPlaylistExtractor("https://youtube.com/playlist?list=PLxxxxxx");
// Fetch the page first
extractor.fetchPage();
// Get playlist information
String name = extractor.getName();
Description description = extractor.getDescription();
long streamCount = extractor.getStreamCount();
// Get uploader info
String uploaderName = extractor.getUploaderName();
boolean verified = extractor.isUploaderVerified();
// Get first page of items
InfoItemsPage<StreamInfoItem> initialPage = extractor.getInitialPage();
List<StreamInfoItem> items = initialPage.getItems();
// Paginate through all items
Page nextPage = initialPage.getNextPage();
while (nextPage != null) {
InfoItemsPage<StreamInfoItem> page = extractor.getPage(nextPage);
items.addAll(page.getItems());
nextPage = page.getNextPage();
}
InfoItemsPage Object
The InfoItemsPage returned by getInitialPage() and getPage() contains:
The list of stream items on this page
Reference to the next page, or null if this is the last page
Any errors that occurred during extraction of this page
Notes
- Always call
fetchPage() before accessing any playlist data
- Use pagination methods to retrieve all playlist items efficiently
- The
getStreamCount() method may return -1 if the service doesn’t provide the total count
- Some services may not support all features (e.g., sub-channels, banners)