VideoHandle
What a Video's ref holds, for seeking, playing, pausing and entering full screen or picture in picture from code.
Usage
Seek a lesson video back to the beginning.
This type is used by videoRef
// 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>
);
}Type declaration
export type VideoHandle = NativeViewHandle<VideoMethods>;Members 16
| Name | Type | Required | Description |
|---|---|---|---|
idreadonly | string | Yes | — |
parentreadonly | ElementHandle | Yes | — |
childrenreadonly | ElementHandle[] | Yes | — |
focus | () => void | Yes | — |
blur | () => void | Yes | — |
setProperty | <K extends keyof ElementProperties>(key: K, value: ElementProperties[K] | null) => void | Yes | Sets a native prop on the view now, until its binding writes it again. |
addEventListener | (type: string, fn: (e: KuitoNativeEvent) => void, options?: boolean | { capture?: boolean; once?: boolean; signal?: AbortSignal;}) => void | Yes | — |
removeEventListener | (type: string, fn: (e: KuitoNativeEvent) => void, options?: boolean | { capture?: boolean;}) => void | Yes | — |
dispatchEvent | (event: { type: string; bubbles?: boolean; cancelable?: boolean;}) => boolean | Yes | Sends an event through the tree, capture to bubble, as a native one travels:
a KuitoCustomEvent, or any object with a type. False when a listener
called preventDefault() on a cancelable event. |
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 | — |
focus — method signatures
Signatures
(): voidParameters
No parameters.
Returns
void
blur — method signatures
Signatures
(): voidParameters
No parameters.
Returns
void
setProperty — method signatures
Signatures
<K extends keyof ElementProperties>(key: K, value: ElementProperties[K] | null): voidType parameters
| Name | Constraint | Default |
|---|---|---|
K | keyof ElementProperties | — |
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
key | K | Yes | — |
value | ElementProperties[K] | Yes | — |
Returns
void
addEventListener — method signatures
Signatures
(type: string, fn: (e: KuitoNativeEvent) => void, options?: boolean | { capture?: boolean; once?: boolean; signal?: AbortSignal; }): voidParameters
| Name | Type | Required | Description |
|---|---|---|---|
type | string | Yes | — |
fn | (e: KuitoNativeEvent) => void | Yes | — |
options | boolean | { capture?: boolean; once?: boolean; signal?: AbortSignal;} | No | — |
Returns
void
removeEventListener — method signatures
Signatures
(type: string, fn: (e: KuitoNativeEvent) => void, options?: boolean | { capture?: boolean; }): voidParameters
| Name | Type | Required | Description |
|---|---|---|---|
type | string | Yes | — |
fn | (e: KuitoNativeEvent) => void | Yes | — |
options | boolean | { capture?: boolean;} | No | — |
Returns
void
dispatchEvent — method signatures
Signatures
(event: { type: string; bubbles?: boolean; cancelable?: boolean; }): booleanParameters
| Name | Type | Required | Description |
|---|---|---|---|
event | { type: string; bubbles?: boolean; cancelable?: boolean;} | Yes | — |
Returns
boolean
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.