expo-video
Version:
A cross-platform, performant video component for React Native and Expo with Web support
17 lines • 1.31 kB
TypeScript
import type { VideoSource, VideoPlayer, PlayerBuilderOptions } from './VideoPlayer.types';
/**
* Creates a direct instance of `VideoPlayer` that doesn't release automatically.
*
* > **info** For most use cases you should use the [`useVideoPlayer`](#usevideoplayer) hook instead. See the [Using the VideoPlayer Directly](#using-the-videoplayer-directly) section for more details.
* @param source - A video source that is used to initialize the player.
* @param playerBuilderOptions - Options to apply to the Android player builder before the native constructor is invoked.
*/
export declare function createVideoPlayer(source: VideoSource, playerBuilderOptions?: PlayerBuilderOptions): VideoPlayer;
/**
* Creates a `VideoPlayer`, which will be automatically cleaned up when the component is unmounted.
* @param source - A video source that is used to initialize the player.
* @param setup - A function that allows setting up the player. It will run after the player is created.
* @param playerBuilderOptions - Options to apply to the Android player builder before the native constructor is invoked.
*/
export declare function useVideoPlayer(source: VideoSource, setup?: (player: VideoPlayer) => void, playerBuilderOptions?: PlayerBuilderOptions): VideoPlayer;
//# sourceMappingURL=VideoPlayer.d.ts.map