VideoMethods
What a ref to a Video calls. Each resolves once the player has done it.
Usage
Display a video with native controls.
This type is used by Video
// Display a video with native controls.
import { Video } from 'kuito';
<Video src={{ uri: 'https://example.com/waves.mp4' }} height={320} muted loop objectFit="cover" />;Type declaration
export type VideoMethods = {
/** Seconds from the start; exact, not the nearest key frame. */
seek(seconds: number): Promise<void>;
play(): Promise<void>;
pause(): Promise<void>;
enterFullscreen(): Promise<void>;
exitFullscreen(): Promise<void>;
/** iOS only: rejects with `ERR_UNSUPPORTED` on Android (docs/video.md). */
startPictureInPicture(): Promise<void>;
stopPictureInPicture(): Promise<void>;
};Members 7
| Name | Type | Required | Description |
|---|---|---|---|
seek | (seconds: number) => Promise<void> | Yes | Seconds from the start; exact, not the nearest key frame. |
play | () => Promise<void> | Yes | — |
pause | () => Promise<void> | Yes | — |
enterFullscreen | () => Promise<void> | Yes | — |
exitFullscreen | () => Promise<void> | Yes | — |
startPictureInPicture | () => Promise<void> | Yes | iOS only: rejects with ERR_UNSUPPORTED on Android (docs/video.md). |
stopPictureInPicture | () => Promise<void> | Yes | — |
seek — method signatures
Signatures
(seconds: number): Promise<void>Parameters
| Name | Type | Required | Description |
|---|---|---|---|
seconds | number | Yes | — |
Returns
Promise<void>
play — method signatures
Signatures
(): Promise<void>Parameters
No parameters.
Returns
Promise<void>
pause — method signatures
Signatures
(): Promise<void>Parameters
No parameters.
Returns
Promise<void>
enterFullscreen — method signatures
Signatures
(): Promise<void>Parameters
No parameters.
Returns
Promise<void>
exitFullscreen — method signatures
Signatures
(): Promise<void>Parameters
No parameters.
Returns
Promise<void>
startPictureInPicture — method signatures
Signatures
(): Promise<void>Parameters
No parameters.
Returns
Promise<void>
stopPictureInPicture — method signatures
Signatures
(): Promise<void>Parameters
No parameters.
Returns
Promise<void>
Generated from the public TypeScript declarations: signatures, props and defaults come from the checked source, descriptions from its JSDoc. No defaults are invented.