.VIMEO

Steuert eingebettete Vimeo-Videos (RAGAI.VIMEO).

Hintergrund

Wie bei RAGAI.YOUTUBE wird der Player-Handle (this.vimeo) erst durch das Event RAGAI.VIMEO.playerready gesetzt - Methodenaufrufe vor diesem Zeitpunkt (kein Vimeo-Player im Bot vorhanden bzw. noch nicht bereit) schlagen fehl.

Methoden

.play()

Startet die Wiedergabe des Vimeo-Videos.

Rückgabewert: Promise<void>

.pause()

Pausiert die Wiedergabe des Vimeo-Videos.

Rückgabewert: Promise<void>

.currentPlayPosition()

Gibt die aktuelle Abspielposition des Vimeo-Videos zurück.

Rückgabewert: Promise<number>

Die aktuelle Position in Sekunden.

.seekTo(hours, minutes?, seconds?)

Springt zu einer bestimmten Position im Vimeo-Video.

Parameter	Typ	Beschreibung
hours	number | z.input<typeof vimeoSeekToSchema>	Stunden, oder ein Objekt gemäß vimeoSeekToSchema.
minutes	number	Minuten.
seconds	number	Sekunden.

Objekt-Form (validiert über vimeoSeekToSchema):

Feld	Typ	Pflicht	Beschreibung
hours	number	– (Standard: 0)	Stunden.
minutes	number	– (Standard: 0)	Minuten.
seconds	number	– (Standard: 0)	Sekunden.

Rückgabewert: Promise<void>

.setVolume(percentageVolume)

Setzt die Lautstärke des Vimeo-Videos.

Parameter	Typ	Beschreibung
percentageVolume	number | z.input<typeof vimeoVolumeSchema>	Lautstärke in Prozent (0-100), oder ein Objekt gemäß vimeoVolumeSchema.

Objekt-Form (validiert über vimeoVolumeSchema):

Feld	Typ	Pflicht	Beschreibung
volume	number	✔	Lautstärke in Prozent (0-100).

Rückgabewert: Promise<number>

Die tatsächlich gesetzte Lautstärke.

.setLoop(value)

Aktiviert oder deaktiviert die Endlosschleife des Vimeo-Videos.

Parameter	Typ	Beschreibung
value	boolean	true aktiviert die Endlosschleife.

Rückgabewert: Promise<boolean>

Der gesetzte Loop-Status.

.setPlaybackRate(playbackRate)

Setzt die Wiedergabegeschwindigkeit des Vimeo-Videos.

Parameter	Typ	Beschreibung
playbackRate	number | z.input<typeof vimeoRateSchema>	Wiedergabegeschwindigkeit (1 = normal), oder ein Objekt gemäß vimeoRateSchema.

Objekt-Form (validiert über vimeoRateSchema):

Feld	Typ	Pflicht	Beschreibung
rate	number	✔	Wiedergabegeschwindigkeit (1 = normal).

Rückgabewert: Promise<void>

.getColors()

Gibt die aktuellen Farbeinstellungen des Vimeo-Players zurück.

Rückgabewert: Promise<[]>

Die aktuellen Farben.

.setColors(colors)

Setzt die Farbeinstellungen des Vimeo-Players.

Parameter	Typ	Beschreibung
colors	[]	Die zu setzenden Farben.

Rückgabewert: Promise<[]>

Die gesetzten Farben.

.loadVideo(id?, url?, object?)

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

Parameter	Typ	Beschreibung
id	number	Numerische Vimeo-Video-ID.
url	string	URL des Vimeo-Videos (Alternative zu id).
object	object	Weitere Player-Optionen.

Rückgabewert: Promise<string | number | object>

Das Ergebnis des Ladevorgangs.