Package dev.lavalink.youtube.clients

Class Web

java.lang.Object

dev.lavalink.youtube.clients.skeleton.NonMusicClient

dev.lavalink.youtube.clients.skeleton.StreamingNonMusicClient

dev.lavalink.youtube.clients.Web

All Implemented Interfaces:

Client

Direct Known Subclasses:

WebEmbedded

public class Web
extends StreamingNonMusicClient

Nested Class Summary

Nested classes/interfaces inherited from interface dev.lavalink.youtube.clients.skeleton.Client

Client.PlayabilityStatus

Field Summary

Fields

Modifier and Type	Field	Description
static ClientConfig	BASE_CONFIG
protected static Pattern	CONFIG_REGEX
protected long	lastConfigUpdate
protected ClientOptions	options
protected String	poToken

Fields inherited from class dev.lavalink.youtube.clients.skeleton.StreamingNonMusicClient

DEFAULT_SIGNATURE_KEY

Fields inherited from class dev.lavalink.youtube.clients.skeleton.NonMusicClient

DEFAULT_EMBED_URL, MOBILE_PLAYER_PARAMS, playlistPageCount, WEB_PLAYER_PARAMS

Fields inherited from interface dev.lavalink.youtube.clients.skeleton.Client

API_BASE_URL, BROWSE_URL, MUSIC_API_BASE_URL, MUSIC_SEARCH_PARAMS, MUSIC_SEARCH_URL, NEXT_URL, OAUTH_CLIENT_ATTRIBUTE, PLAYER_URL, SEARCH_PARAMS, SEARCH_URL, WATCH_URL

Constructor Summary

Constructors

Constructor	Description
Web()
Web(@NotNull ClientOptions options)

Method Summary

Modifier and Type	Method	Description
protected @NotNull com.sedmelluq.discord.lavaplayer.tools.JsonBrowser	extractMixPlaylistData(@NotNull com.sedmelluq.discord.lavaplayer.tools.JsonBrowser json)
protected @Nullable String	extractPlaylistContinuationToken(@NotNull com.sedmelluq.discord.lavaplayer.tools.JsonBrowser videoList)
protected @NotNull com.sedmelluq.discord.lavaplayer.tools.JsonBrowser	extractPlaylistContinuationVideos(@NotNull com.sedmelluq.discord.lavaplayer.tools.JsonBrowser continuationJson)
protected String	extractPlaylistName(@NotNull com.sedmelluq.discord.lavaplayer.tools.JsonBrowser json)
protected void	extractPlaylistTracks(@NotNull com.sedmelluq.discord.lavaplayer.tools.JsonBrowser json, @NotNull List<com.sedmelluq.discord.lavaplayer.track.AudioTrack> tracks, @NotNull YoutubeAudioSourceManager source)
protected @NotNull com.sedmelluq.discord.lavaplayer.tools.JsonBrowser	extractPlaylistVideoList(@NotNull com.sedmelluq.discord.lavaplayer.tools.JsonBrowser json)
protected @NotNull List<com.sedmelluq.discord.lavaplayer.track.AudioTrack>	extractSearchResults(@NotNull YoutubeAudioSourceManager source, @NotNull com.sedmelluq.discord.lavaplayer.tools.JsonBrowser json)
protected void	fetchClientConfig(@NotNull com.sedmelluq.discord.lavaplayer.tools.io.HttpInterface httpInterface)
@NotNull ClientConfig	getBaseClientConfig(@NotNull com.sedmelluq.discord.lavaplayer.tools.io.HttpInterface httpInterface)	Retrieves a base client config payload to be used for requests.
@NotNull String	getIdentifier()
@NotNull ClientOptions	getOptions()
@NotNull String	getPlayerParams()
@Nullable String	getPoToken()
void	preparePlayback(@NotNull YoutubeAudioSourceManager source, @NotNull com.sedmelluq.discord.lavaplayer.tools.io.HttpInterface httpInterface, @NotNull String videoId)
boolean	supportsSabrPlayback()

Methods inherited from class dev.lavalink.youtube.clients.skeleton.StreamingNonMusicClient

extractFormat, extractFormat, getSabrClientInfo, loadFormats, preferSabrPlayback

Methods inherited from class dev.lavalink.youtube.clients.skeleton.NonMusicClient

canHandleRequest, extractAudioTrack, extractElementTrack, extractLockupTrack, extractPlaylistError, fetchEncryptedHostFlags, fetchEncryptedHostFlags, loadJsonResponse, loadMix, loadMixResult, loadPlaylist, loadPlaylistResult, loadSearch, loadSearchMusic, loadSearchResults, loadTrackInfoFromInnertube, loadTrackInfoFromInnertube, loadVideo, setPlaylistPageCount

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.lavalink.youtube.clients.skeleton.Client

buildAudioTrack, findSelectedTrack, getPlayabilityStatus, getUnplayableReason, isEmbedded, requirePlayerScript, supportsFormatLoading, supportsOAuth, transformPlaybackUri, transformPlaybackUri

Field Details

CONFIG_REGEX

protected static Pattern CONFIG_REGEX

BASE_CONFIG

public static ClientConfig BASE_CONFIG

lastConfigUpdate

protected volatile long lastConfigUpdate

options

protected ClientOptions options

poToken

protected volatile String poToken

Constructor Details

Web

public Web()

Web

public Web(@NotNull
 @NotNull ClientOptions options)

Method Details

fetchClientConfig

protected void fetchClientConfig(@NotNull
 @NotNull com.sedmelluq.discord.lavaplayer.tools.io.HttpInterface httpInterface)

getBaseClientConfig

@NotNull
public @NotNull ClientConfig getBaseClientConfig(@NotNull
 @NotNull com.sedmelluq.discord.lavaplayer.tools.io.HttpInterface httpInterface)

Description copied from class: NonMusicClient

Retrieves a base client config payload to be used for requests.

Specified by:

getBaseClientConfig in class NonMusicClient

Parameters:

httpInterface - The HTTP interface to use for fetching a config, if applicable.

Returns:

A client configuration.

supportsSabrPlayback

public boolean supportsSabrPlayback()

Returns:

true only when this client expects SABR formats.

preparePlayback

public void preparePlayback(@NotNull
 @NotNull YoutubeAudioSourceManager source,
 @NotNull
 @NotNull com.sedmelluq.discord.lavaplayer.tools.io.HttpInterface httpInterface,
 @NotNull
 @NotNull String videoId)
                     throws IOException

Throws:

IOException

extractSearchResults

@NotNull
protected @NotNull List<com.sedmelluq.discord.lavaplayer.track.AudioTrack> extractSearchResults(@NotNull
 @NotNull YoutubeAudioSourceManager source,
 @NotNull
 @NotNull com.sedmelluq.discord.lavaplayer.tools.JsonBrowser json)

Overrides:

extractSearchResults in class NonMusicClient

extractMixPlaylistData

@NotNull
protected @NotNull com.sedmelluq.discord.lavaplayer.tools.JsonBrowser extractMixPlaylistData(@NotNull
 @NotNull com.sedmelluq.discord.lavaplayer.tools.JsonBrowser json)

Overrides:

extractMixPlaylistData in class NonMusicClient

extractPlaylistName

protected String extractPlaylistName(@NotNull
 @NotNull com.sedmelluq.discord.lavaplayer.tools.JsonBrowser json)

Overrides:

extractPlaylistName in class NonMusicClient

extractPlaylistVideoList

@NotNull
protected @NotNull com.sedmelluq.discord.lavaplayer.tools.JsonBrowser extractPlaylistVideoList(@NotNull
 @NotNull com.sedmelluq.discord.lavaplayer.tools.JsonBrowser json)

Overrides:

extractPlaylistVideoList in class NonMusicClient

extractPlaylistContinuationToken

@Nullable
protected @Nullable String extractPlaylistContinuationToken(@NotNull
 @NotNull com.sedmelluq.discord.lavaplayer.tools.JsonBrowser videoList)

Overrides:

extractPlaylistContinuationToken in class NonMusicClient

extractPlaylistContinuationVideos

@NotNull
protected @NotNull com.sedmelluq.discord.lavaplayer.tools.JsonBrowser extractPlaylistContinuationVideos(@NotNull
 @NotNull com.sedmelluq.discord.lavaplayer.tools.JsonBrowser continuationJson)

Overrides:

extractPlaylistContinuationVideos in class NonMusicClient

extractPlaylistTracks

protected void extractPlaylistTracks(@NotNull
 @NotNull com.sedmelluq.discord.lavaplayer.tools.JsonBrowser json,
 @NotNull
 @NotNull List<com.sedmelluq.discord.lavaplayer.track.AudioTrack> tracks,
 @NotNull
 @NotNull YoutubeAudioSourceManager source)

Overrides:

extractPlaylistTracks in class NonMusicClient

getPlayerParams

@NotNull
public @NotNull String getPlayerParams()

Returns:

The parameters to use for playback. May be null, which will avoid populating the "params" field in payloads.

getPoToken

@Nullable
public @Nullable String getPoToken()

getOptions

@NotNull
public @NotNull ClientOptions getOptions()

getIdentifier

@NotNull
public @NotNull String getIdentifier()

Returns:

The unique identifier for this client.