Package dev.lavalink.youtube.clients

Class Tv

java.lang.Object

dev.lavalink.youtube.clients.skeleton.NonMusicClient

dev.lavalink.youtube.clients.skeleton.StreamingNonMusicClient

dev.lavalink.youtube.clients.Tv

All Implemented Interfaces:

Client

public class Tv
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 ClientOptions	options

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

DEFAULT_SIGNATURE_KEY

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

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
Tv()
Tv(@NotNull ClientOptions options)

Method Summary

Modifier and Type	Method	Description
boolean	canHandleRequest(@NotNull String identifier)	Returns a boolean determining whether this client can be used to handle requests for the given identifier.
protected @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()
com.sedmelluq.discord.lavaplayer.track.AudioItem	loadMix(@NotNull YoutubeAudioSourceManager source, @NotNull com.sedmelluq.discord.lavaplayer.tools.io.HttpInterface httpInterface, @NotNull String mixId, @Nullable String selectedVideoId)	Loads a mix playlist.
com.sedmelluq.discord.lavaplayer.track.AudioItem	loadPlaylist(@NotNull YoutubeAudioSourceManager source, @NotNull com.sedmelluq.discord.lavaplayer.tools.io.HttpInterface httpInterface, @NotNull String playlistId, @Nullable String selectedVideoId)	Loads a playlist.
com.sedmelluq.discord.lavaplayer.track.AudioItem	loadSearch(@NotNull YoutubeAudioSourceManager source, @NotNull com.sedmelluq.discord.lavaplayer.tools.io.HttpInterface httpInterface, @NotNull String searchQuery)	Loads search results for a query.
com.sedmelluq.discord.lavaplayer.track.AudioItem	loadVideo(@NotNull YoutubeAudioSourceManager source, @NotNull com.sedmelluq.discord.lavaplayer.tools.io.HttpInterface httpInterface, @NotNull String videoId)	Loads a single video.
boolean	supportsOAuth()

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

extractFormat, loadFormats

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

extractAudioTrack, extractMixPlaylistData, extractPlaylistContinuationToken, extractPlaylistContinuationVideos, extractPlaylistError, extractPlaylistName, extractPlaylistTracks, extractPlaylistVideoList, extractSearchResults, loadJsonResponse, loadMixResult, loadPlaylistResult, loadSearchMusic, loadSearchResults, loadTrackInfoFromInnertube, loadTrackInfoFromInnertube, 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, transformPlaybackUri

Field Details

BASE_CONFIG

public static ClientConfig BASE_CONFIG

options

protected ClientOptions options

Constructor Details

Tv

public Tv()

Tv

public Tv(@NotNull
 @NotNull ClientOptions options)

Method Details

getBaseClientConfig

@NotNull
protected @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.

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.

getOptions

@NotNull
public @NotNull ClientOptions getOptions()

canHandleRequest

public boolean canHandleRequest(@NotNull
 @NotNull String identifier)

Description copied from interface: Client

Returns a boolean determining whether this client can be used to handle requests for the given identifier.

Specified by:

canHandleRequest in interface Client

Overrides:

canHandleRequest in class NonMusicClient

Parameters:

identifier - The resource identifier. Could be an arbitrary string or a URL.

Returns:

True, if this client can handle the request.

supportsOAuth

public boolean supportsOAuth()

Returns:

True, if this client supports account linking via OAuth (i.e. TV)

getIdentifier

@NotNull
public @NotNull String getIdentifier()

Returns:

The unique identifier for this client.

loadPlaylist

public com.sedmelluq.discord.lavaplayer.track.AudioItem loadPlaylist(@NotNull
 @NotNull YoutubeAudioSourceManager source,
 @NotNull
 @NotNull com.sedmelluq.discord.lavaplayer.tools.io.HttpInterface httpInterface,
 @NotNull
 @NotNull String playlistId,
 @Nullable
 @Nullable String selectedVideoId)

Description copied from interface: Client

Loads a playlist.

Specified by:

loadPlaylist in interface Client

Overrides:

loadPlaylist in class NonMusicClient

Parameters:

source - The source manager responsible for this client.

httpInterface - The interface to use for requests.

playlistId - The ID of the playlist.

Returns:

An AudioItem.

loadVideo

public com.sedmelluq.discord.lavaplayer.track.AudioItem loadVideo(@NotNull
 @NotNull YoutubeAudioSourceManager source,
 @NotNull
 @NotNull com.sedmelluq.discord.lavaplayer.tools.io.HttpInterface httpInterface,
 @NotNull
 @NotNull String videoId)
                                                           throws CannotBeLoaded,
IOException

Description copied from interface: Client

Loads a single video.

Specified by:

loadVideo in interface Client

Overrides:

loadVideo in class NonMusicClient

Parameters:

source - The source manager responsible for this client.

httpInterface - The interface to use for requests.

videoId - The ID of the video to load.

Returns:

An AudioItem.

Throws:

CannotBeLoaded - If a video doesn't exist etc.

IOException

loadMix

public com.sedmelluq.discord.lavaplayer.track.AudioItem loadMix(@NotNull
 @NotNull YoutubeAudioSourceManager source,
 @NotNull
 @NotNull com.sedmelluq.discord.lavaplayer.tools.io.HttpInterface httpInterface,
 @NotNull
 @NotNull String mixId,
 @Nullable
 @Nullable String selectedVideoId)

Description copied from interface: Client

Loads a mix playlist.

Specified by:

loadMix in interface Client

Overrides:

loadMix in class NonMusicClient

Parameters:

source - The source manager responsible for this client.

httpInterface - The interface to use for requests.

mixId - The ID of the mix.

Returns:

An AudioItem.

loadSearch

public com.sedmelluq.discord.lavaplayer.track.AudioItem loadSearch(@NotNull
 @NotNull YoutubeAudioSourceManager source,
 @NotNull
 @NotNull com.sedmelluq.discord.lavaplayer.tools.io.HttpInterface httpInterface,
 @NotNull
 @NotNull String searchQuery)

Description copied from interface: Client

Loads search results for a query.

Specified by:

loadSearch in interface Client

Overrides:

loadSearch in class NonMusicClient

Parameters:

source - The source manager responsible for this client.

httpInterface - The interface to use for requests.

searchQuery - The search query.

Returns:

An AudioItem.