跳至主要内容
版本:v1.3.2

Player

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new Player(lavashark, options)

創建一個 Player 實例

Parameters

NameTypeDescription
lavasharkLavaSharkLavaShark 實例
optionsPlayerOptionsPlayer 選項

Defined in

lib/Player.ts:88

Properties

current

current: null | Track

Defined in

lib/Player.ts:50


filters

Readonly filters: Filters

Defined in

lib/Player.ts:40


guildId

Readonly guildId: string

Defined in

lib/Player.ts:38


moving

moving: boolean

Defined in

lib/Player.ts:64


node

node: null | Node

Defined in

lib/Player.ts:36


paused

paused: boolean

Defined in

lib/Player.ts:59


playing

playing: boolean

Defined in

lib/Player.ts:58


position

position: number

Defined in

lib/Player.ts:55


queue

queue: Queue

Defined in

lib/Player.ts:51


repeatMode

repeatMode: RepeatMode

Defined in

lib/Player.ts:53


selfDeaf

Optional selfDeaf: boolean

Defined in

lib/Player.ts:47


selfMute

Optional selfMute: boolean

Defined in

lib/Player.ts:48


state

state: ConnectionState

Defined in

lib/Player.ts:61


textChannelId

Optional textChannelId: null | string

Defined in

lib/Player.ts:45


voiceChannelId

voiceChannelId: string

Defined in

lib/Player.ts:44


voiceState

voiceState: VoiceState

Defined in

lib/Player.ts:62

Accessors

exactPosition

get exactPosition(): number

根據上次 playerUpdate 數據包獲取準確的 track 位置

Returns

number

Defined in

lib/Player.ts:127


queueDuration

get queueDuration(): number

獲取隊列的持續時間,以毫秒為單位

Deprecated

  • Use queue.duration instead

Returns

number

Defined in

lib/Player.ts:142


volume

get volume(): number

獲取播放器的音量

Returns

number

Defined in

lib/Player.ts:149

Methods

addTracks

addTracks(tracks, requester): void

將一個或多個歌曲添加到隊列

Parameters

NameTypeDescription
tracksdefault | Track | (default | Track)[]要添加到隊列的歌曲
requesterUser歌曲的請求者,discord 的 User 類型

Returns

void

Defined in

lib/Player.ts:169


connect

connect(): Promise<void>

連接到語音頻道

Returns

Promise<void>

Defined in

lib/Player.ts:188


destroy

destroy(): Promise<void>

摧毀 Player

Returns

Promise<void>

Defined in

lib/Player.ts:239


disconnect

disconnect(): void

與語音通道斷開連接

Returns

void

Defined in

lib/Player.ts:218


moveNode

moveNode(node): Promise<void>

Parameters

NameTypeDescription
nodeNode將 Player 移動到的目標節點

Returns

Promise<void>

Defined in

lib/Player.ts:258


pause

pause(state?): Promise<boolean>

暫停或取消暫停 Player

Parameters

NameTypeDefault valueDescription
state?booleantrue是暫停還是取消暫停 Player

Returns

Promise<boolean>

Defined in

lib/Player.ts:358


ping

ping(): Promise<number>

獲取 Lavalink 客戶端與節點之間的延遲

Returns

Promise<number>

  • 以毫秒為單位

Defined in

lib/Player.ts:297


play

play(options?): Promise<void>

播放曲目

Parameters

NameTypeDescription
options?PlayOptionsPlay options

Returns

Promise<void>

Defined in

lib/Player.ts:319


resume

resume(): Promise<boolean>

恢復播放

Returns

Promise<boolean>

Defined in

lib/Player.ts:379


seek

seek(position): Promise<void>

在音軌中跳轉到特定位置

Parameters

NameTypeDescription
positionnumberThe position to seek, in milliseconds

Returns

Promise<void>

Defined in

lib/Player.ts:415


sendVoiceUpdate

sendVoiceUpdate(): Promise<void>

Returns

Promise<void>

Defined in

lib/Player.ts:512


setRepeatMode

setRepeatMode(mode): void

為這個隊列設置重複模式

Parameters

NameTypeDescription
modeRepeatModeThe repeat mode to apply

Returns

void

Defined in

lib/Player.ts:435


setSelfDeaf

setSelfDeaf(state): void

設置機器人的自身拒聽狀態

Parameters

NameTypeDescription
statebooleanWhether to self deaf or not

Returns

void

Defined in

lib/Player.ts:477


setSelfMute

setSelfMute(state): void

設置機器人的自身靜音狀態

Parameters

NameTypeDescription
statebooleanWhether to self mute or not

Returns

void

Defined in

lib/Player.ts:490


setVoiceChannel

setVoiceChannel(channelId): void

設置 Player 的語音頻道

Parameters

NameTypeDescription
channelIdstringThe voice channel id

Returns

void

Defined in

lib/Player.ts:503


skip

skip(amount?): Promise<boolean>

跳過正在播放的歌曲

Parameters

NameTypeDescription
amount?numberThe amount of tracks to skip

Returns

Promise<boolean>

Defined in

lib/Player.ts:387


update

update(state): void

Parameters

NameType
statePlayerState

Returns

void

Defined in

lib/Player.ts:535


checkOptions

Static checkOptions(options): void

Parameters

NameType
optionsPlayerOptions

Returns

void

Defined in

lib/Player.ts:66