Skip to main content

.YOUTUBE

Steuert eingebettete YouTube-Videos (RAGAI.YOUTUBE).

Hintergrund

this.youtube (der eigentliche Player-Handle) wird nicht von dieser Klasse selbst erzeugt, sondern erst gesetzt, sobald das Event RAGAI.YOUTUBE.playerready vom einbettenden YouTube-Player-Skript ausgelöst wird. Ruft man eine Methode dieser Klasse auf, bevor ein YouTube-Player im Bot vorhanden ist und bereit gemeldet hat, schlägt der Aufruf fehl (this.youtube ist dann undefined).

Methoden

.play()

Startet die Wiedergabe des YouTube-Videos.

Rückgabewert: Promise<void>

.pause()

Pausiert die Wiedergabe des YouTube-Videos.

Rückgabewert: Promise<void>

.stop()

Stoppt die Wiedergabe des YouTube-Videos.

Rückgabewert: Promise<void>

.mute()

Schaltet den Ton des YouTube-Videos stumm.

Rückgabewert: Promise<void>

.unmute()

Schaltet den Ton des YouTube-Videos wieder ein.

Rückgabewert: Promise<void>

.setPlaybackRate(rate)

Setzt die Wiedergabegeschwindigkeit des YouTube-Videos.

ParameterTypBeschreibung
ratenumber | z.input<typeof youtubeRateSchema>Wiedergabegeschwindigkeit (1 = normal), oder ein Objekt gemäß youtubeRateSchema.

Objekt-Form (validiert über youtubeRateSchema):

FeldTypPflichtBeschreibung
ratenumberWiedergabegeschwindigkeit (1 = normal).

Rückgabewert: Promise<void>

.setVolume(volume)

Setzt die Lautstärke des YouTube-Videos.

ParameterTypBeschreibung
volumenumber | z.input<typeof youtubeVolumeSchema>Lautstärke in Prozent (0-100), oder ein Objekt gemäß youtubeVolumeSchema.

Objekt-Form (validiert über youtubeVolumeSchema):

FeldTypPflichtBeschreibung
volumenumberLautstärke in Prozent (0-100).

Rückgabewert: Promise<void>

.seekTo(hours, minutes?, seconds?, allowSeekAhead?)

Springt zu einer bestimmten Position im YouTube-Video.

ParameterTypBeschreibung
hoursnumber | z.input<typeof youtubeSeekToSchema>Stunden, oder ein Objekt gemäß youtubeSeekToSchema.
minutesnumberMinuten.
secondsnumberSekunden.
allowSeekAheadbooleantrue, um auch in noch nicht geladene Bereiche springen zu können.

Objekt-Form (validiert über youtubeSeekToSchema):

FeldTypPflichtBeschreibung
hoursnumber– (Standard: 0)Stunden.
minutesnumber– (Standard: 0)Minuten.
secondsnumber– (Standard: 0)Sekunden.

Rückgabewert: Promise<void>

.loadVideo(videoId, startSeconds?, endSeconds?)

Lädt ein anderes YouTube-Video in den Player.

ParameterTypBeschreibung
videoIdstring | z.input<typeof youtubeLoadVideoSchema>Die YouTube-Video-ID, oder ein Objekt gemäß youtubeLoadVideoSchema.
startSecondsnumberStartzeitpunkt in Sekunden.
endSecondsnumberEndzeitpunkt in Sekunden.

Objekt-Form (validiert über youtubeLoadVideoSchema):

FeldTypPflichtBeschreibung
videoIdstringDie YouTube-Video-ID.

Rückgabewert: Promise<void>