kuito.
Commencer

VideoRef

A Video's ref that also holds its state: signals for what the player is doing, and time and duration as motion values. Between the player's reports the UI thread moves time along at the player's rate, so a bound progress bar needs no onProgress. Called while a component sets up, which owns it, like ref(), and passed as the view's ref.

type

Utilisation

Seek a lesson video back to the beginning.

Ce type est utilisé par videoRef

tsx
// Seek a lesson video back to the beginning.
import { Button, Video, VStack, videoRef } from 'kuito';

export function Lesson() {
  const player = videoRef();
  return (
    <VStack flex={1}>
      <Video ref={player} src={{ uri: 'https://example.com/lesson.mp4' }} height={240} controls />
      <Button onPress={() => void player.current?.seek(0).catch(console.error)}>
        Restart lesson
      </Button>
    </VStack>
  );
}

Déclaration du type

ts
export type VideoRef = ElementRef<VideoHandle> & {
  readonly playing: ReadonlySignal<boolean>;
  readonly loaded: ReadonlySignal<boolean>;
  readonly buffering: ReadonlySignal<boolean>;
  readonly fullscreen: ReadonlySignal<boolean>;
  readonly pictureInPicture: ReadonlySignal<boolean>;
  readonly error: ReadonlySignal<string | null>;
  /** Seconds from the start. */
  readonly time: Motion<number>;
  /** Seconds; 0 until loaded, and for a live stream. */
  readonly duration: Motion<number>;
  /** Calls `listener` each time playback reaches the end. */
  watch(event: 'ended', listener: () => void): EventSubscription;
};

Membres 10

NomTypeRequisDescription
currentVideoHandleOui—
playinglecture seuleReadonlySignal<boolean>Oui—
loadedlecture seuleReadonlySignal<boolean>Oui—
bufferinglecture seuleReadonlySignal<boolean>Oui—
fullscreenlecture seuleReadonlySignal<boolean>Oui—
pictureInPicturelecture seuleReadonlySignal<boolean>Oui—
errorlecture seuleReadonlySignal<string>Oui—
timelecture seuleMotion<number>OuiSeconds from the start.
durationlecture seuleMotion<number>OuiSeconds; 0 until loaded, and for a live stream.
watch(event: "ended", listener: () => void) => EventSubscriptionOuiCalls listener each time playback reaches the end.
watch — signatures de méthode

Signatures

ts
(event: "ended", listener: () => void): EventSubscription

Paramètres

NomTypeRequisDescription
event"ended"Oui—
listener() => voidOui—

Retourne

EventSubscription

Généré depuis les déclarations TypeScript publiques : signatures, props et valeurs par défaut viennent de la source vérifiée, les descriptions de sa JSDoc. Aucune valeur par défaut n'est inventée.