Package dev.lavalink.youtube.clients

Class Music

java.lang.Object

dev.lavalink.youtube.clients.skeleton.NonMusicClient

dev.lavalink.youtube.clients.skeleton.StreamingNonMusicClient

dev.lavalink.youtube.clients.skeleton.MusicClient

dev.lavalink.youtube.clients.Music

All Implemented Interfaces:

Client

public class Music
extends MusicClient

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

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

Method Summary

Modifier and Type	Method	Description
@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	supportsFormatLoading()
boolean	supportsSabrPlayback()

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

canHandleRequest, extractSearchResultTrackJson, extractSearchResultTracks, getMusicSearchResult, loadMix, loadPlaylist, loadSearch, loadSearchMusic, loadVideo, setPlaylistPageCount

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

extractAudioTrack, extractElementTrack, extractLockupTrack, extractMixPlaylistData, extractPlaylistContinuationToken, extractPlaylistContinuationVideos, extractPlaylistError, extractPlaylistName, extractPlaylistTracks, extractPlaylistVideoList, extractSearchResults, fetchEncryptedHostFlags, fetchEncryptedHostFlags, loadJsonResponse, loadMixResult, loadPlaylistResult, loadSearchResults, loadTrackInfoFromInnertube, loadTrackInfoFromInnertube

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, supportsOAuth, transformPlaybackUri, transformPlaybackUri

Field Details

BASE_CONFIG

public static ClientConfig BASE_CONFIG

options

protected ClientOptions options

Constructor Details

Music

public Music()

Music

public Music(@NotNull
 @NotNull ClientOptions options)

Method Details

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 MusicClient

Parameters:

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

Returns:

A client configuration.

supportsFormatLoading

public boolean supportsFormatLoading()

Specified by:

supportsFormatLoading in interface Client

Overrides:

supportsFormatLoading in class MusicClient

Returns:

True, if this client can be used for loading playback URLs.

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

getPoToken

@Nullable
public @Nullable String getPoToken()

supportsSabrPlayback

public boolean supportsSabrPlayback()

Returns:

true only when this client expects SABR formats.

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()

getIdentifier

@NotNull
public @NotNull String getIdentifier()

Returns:

The unique identifier for this client.