メインコンテンツまでスキップ
バージョン: v2 Next 🚧

クラス: AudioService

定義: plugins/music/src/AudioService.ts:53

音楽再生のエントリポイント。this.services.audio で参照できます。

const { tracks } = await this.services.audio.play({
  channel: member.voice.channel,
  query: "https://example.com/song.opus",
  requestedBy: member.id,
});

拡張​

コンストラクター​

コンストラクター​

new AudioService(): AudioService;

戻り値​

AudioService

継承元​

Service.constructor

プロパティ​

container​

readonly container: Container;

定義: src/component/Component.ts:30

フレームワーク共有サービスを持つコンテナ。

継承元​

Service.container

location​

readonly location: string | null;

定義: src/component/Component.ts:39

自動探索されたファイルの絶対パス。明示登録の場合は null。

継承元​

Service.location

logger​

readonly logger: Logger;

定義: src/component/Component.ts:36

このコンポーネント用の子ロガー({ store, component } が付与済み)。

継承元​

Service.logger

name​

readonly name: string;

定義: src/component/Component.ts:27

ストア内で一意なコンポーネント名。

継承元​

Service.name

store​

readonly store: ComponentStore<Component>;

定義: src/component/Component.ts:33

このコンポーネントが属するストア。

継承元​

Service.store

アクセッサー​

client​

署名を取得する​

get client(): Client;

定義: src/component/Component.ts:42

フレームワーククライアント。

戻り値​

Client

継承元​

Service.client

queues​

署名を取得する​

get queues(): readonly GuildQueue[];

定義: plugins/music/src/AudioService.ts:62

稼働中のすべてのキュー。

戻り値​

readonly GuildQueue[]

services​

署名を取得する​

get services(): Services;

定義: src/component/Component.ts:50

ロード済みサービスへのアクセス(services/ から自動収束)。 import せずに this.services.<名前> で参照できます。

戻り値​

Services

継承元​

Service.services

メソッド​

ensureQueue()​

ensureQueue(guildId): GuildQueue;

定義: plugins/music/src/AudioService.ts:67

ギルドのキューを取得し、なければ作成します(接続はしません)。

パラメータ​

guildId​

string

戻り値​

GuildQueue

leave()​

leave(guildId): boolean;

定義: plugins/music/src/AudioService.ts:135

ギルドの再生を停止して切断します。

パラメータ​

guildId​

string

戻り値​

boolean

onLoad()?​

optional onLoad(): unknown;

定義: src/component/Component.ts:55

初期化後・ストア追加前に呼ばれます。

戻り値​

unknown

継承元​

Service.onLoad

onUnload()​

onUnload(): void;

定義: plugins/music/src/AudioService.ts:143

クライアント終了時、すべてのギルドから切断します。

戻り値​

void

上書き​

Service.onUnload

play()​

play(options): Promise<PlayResult>;

定義: plugins/music/src/AudioService.ts:103

クエリを解決してキューへ追加し、必要なら接続・再生を開始します。

パラメータ​

options​

PlayOptions

戻り値​

Promise<PlayResult>

Throws​

NoResultError 再生可能な音源が見つからなかった場合。

queue()​

queue(guildId): GuildQueue | null;

定義: plugins/music/src/AudioService.ts:57

ギルドの既存キューを返します。未接続なら null。

パラメータ​

guildId​

string

戻り値​

GuildQueue | null

resolve()​

resolve(query, requestedBy?): Promise<Track[]>;

定義: plugins/music/src/AudioService.ts:94

クエリを解決してトラックを返します(キューには追加しません)。 検索結果の選択 UI を自作したい場合に使います。

パラメータ​

query​

string

requestedBy?​

string | null

戻り値​

Promise<Track[]>

define()​

static define(options?): (_target, context) => void;

定義: src/service/Service.ts:47

サービスのメタデータを宣言します。省略可能です。

パラメータ​

options?​

ServiceOptions = {}

戻り値​

(_target, context) => void

継承元​

Service.define