expo-libvlc-player 7.0.7 → 7.0.8

package/README.md

@@ -125,10 +125,10 @@ See the [Example App](example/App.tsx) for additional usage.
 | `play()`                                                         | Starts playback of the current player                                                                                                             | `Promise<void>` |
 | `pause()`                                                        | Pauses playback of the current player                                                                                                             | `Promise<void>` |
 | `stop()`                                                         | Stops playback of the current player                                                                                                              | `Promise<void>` |
-| `seek(value: number, type?: "time" \| "position")`               | Sets the time or position of the current player. Must be a number equal or greater than `0`, type defaults to `"time"`                            | `Promise<void>` |
-| `record(path?: string)`                                          | Starts or stops recording the current media. Must be a valid directory path string or `undefined` to stop recording                               | `Promise<void>` |
-| `snapshot(path: string)`                                         | Takes a snapshot of the current media. Must be a valid directory path string                                                                      | `Promise<void>` |
-| `postAction(action: number)`                                     | Posts an answer to a [`Dialog`](#dialog). Must be an integer of `1` or `2`                                                                        | `Promise<void>` |
+| `seek(value: number, type?: "time" \| "position")`               | Sets the time or position of the current player. Must be an integer equal or greater than `0`, type defaults to `"time"`                          | `Promise<void>` |
+| `record(path?: string)`                                          | Starts or stops recording the current media. Must be a valid directory path or `undefined` to stop recording                                      | `Promise<void>` |
+| `snapshot(path: string)`                                         | Takes a snapshot of the current media. Must be a valid directory path                                                                             | `Promise<void>` |
+| `postAction(action: 1 \| 2)`                                     | Posts an answer to a [`Dialog`](#dialog). Must be either `1` or `2`                                                                               | `Promise<void>` |
 | `postLogin(username: string, password: string, store?: boolean)` | Posts a username and password to a login [`Dialog`](#dialog). Username can't be empty, password can be empty and if `true`, store the credentials | `Promise<void>` |
 | `dismiss()`                                                      | Dismisses a [`Dialog`](#dialog)                                                                                                                   | `Promise<void>` |
 | `startPictureInPicture()`                                        | Enters Picture-in-Picture (PiP) mode. Config plugin has to be configured for Picture-in-Picture (PiP) to work                                     | `Promise<void>` |
@@ -145,7 +145,7 @@ The `LibVlcPlayerView` extends React Native `ViewProps` and implements the follo
 | `tracks`           | Sets the player audio, video and subtitle tracks. See [`Tracks`](#tracks) for more                                                | `undefined` |
 | `slaves`           | Sets the player audio and subtitle slaves. See [`Slave`](#slave) for more                                                         | `[]`        |
 | `scale`            | Sets the player scaling factor. Must be a float equal or greater than `0`                                                         | `0`         |
-| `aspectRatio`      | Sets the container aspect ratio. Must be a valid ratio string, number or `"auto"`                                                 | `undefined` |
+| `aspectRatio`      | Sets the container aspect ratio. Must be a valid ratio, float or `"auto"`                                                         | `undefined` |
 | `contentFit`       | Sets how the video should be scaled to fit in the container                                                                       | `"contain"` |
 | `rate`             | Sets the player rate. Must be a float equal or greater than `1`                                                                   | `1`         |
 | `time`             | Sets the initial player time. Must be an integer in milliseconds                                                                  | `0`         |
@@ -182,25 +182,33 @@ The `LibVlcPlayerView` extends React Native `ViewProps` and implements the follo
 #### `Error`
 
 ```ts
-type Error = { message: string };
+interface Error {
+  message: string;
+}
 ```
 
 #### `Time`
 
 ```ts
-type Time = { value: number };
+interface Time {
+  value: number;
+}
 ```
 
 #### `Position`
 
 ```ts
-type Position = { value: number };
+interface Position {
+  value: number;
+}
 ```
 
 #### `Snapshot`
 
 ```ts
-type Snapshot = { path: string };
+interface Snapshot {
+  path: string;
+}
 ```
 
 #### `Tracks`

package/build/LibVlcPlayer.types.d.ts

@@ -22,7 +22,7 @@ export interface LibVlcPlayerViewRef {
     /**
      * Sets the time or position of the current player
      *
-     * @param value - Must be a number equal or greater than `0`
+     * @param value - Must be an integer equal or greater than `0`
      * @param type - Defaults to `"time"`
      *
      * @returns A promise which resolves to `void`
@@ -31,7 +31,7 @@ export interface LibVlcPlayerViewRef {
     /**
      * Starts or stops recording the current media
      *
-     * @param path - Must be a valid directory path string or `undefined` to stop recording
+     * @param path - Must be a valid directory path or `undefined` to stop recording
      *
      * @returns A promise which resolves to `void`
      */
@@ -39,7 +39,7 @@ export interface LibVlcPlayerViewRef {
     /**
      * Takes a snapshot of the current media
      *
-     * @param path - Must be a valid directory path string
+     * @param path - Must be a valid directory path
      *
      * @returns A promise which resolves to `void`
      */
@@ -47,7 +47,7 @@ export interface LibVlcPlayerViewRef {
     /**
      * Posts an answer to a `Dialog`
      *
-     * @param action - Must be an integer of `1` or `2`
+     * @param action - Must be either `1` or `2`
      *
      * @returns A promise which resolves to `void`
      */
@@ -339,7 +339,7 @@ export interface LibVlcPlayerViewProps extends ViewProps {
      */
     scale?: number;
     /**
-     * Sets the container aspect ratio. Must be a valid ratio string or number
+     * Sets the container aspect ratio. Must be a valid ratio, float or `"auto"`
      *
      * @example "16:9"
      *

package/build/LibVlcPlayer.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"LibVlcPlayer.types.js","sourceRoot":"","sources":["../src/LibVlcPlayer.types.ts"],"names":[],"mappings":"","sourcesContent":["import type { ViewProps } from \"react-native\";\n\n// eslint-disable-next-line @typescript-eslint/no-empty-object-type, @typescript-eslint/consistent-type-definitions\nexport type LibVlcPlayerModuleEvents = {};\n\nexport interface LibVlcPlayerViewRef {\n  /**\n   * Starts playback of the current player\n   *\n   * @returns A promise which resolves to `void`\n   */\n  readonly play: () => Promise<void>;\n  /**\n   * Pauses playback of the current player\n   *\n   * @returns A promise which resolves to `void`\n   */\n  readonly pause: () => Promise<void>;\n  /**\n   * Stops playback of the current player\n   *\n   * @returns A promise which resolves to `void`\n   */\n  readonly stop: () => Promise<void>;\n  /**\n   * Sets the time or position of the current player\n   *\n   * @param value - Must be a number equal or greater than `0`\n   * @param type - Defaults to `\"time\"`\n   *\n   * @returns A promise which resolves to `void`\n   */\n  readonly seek: (value: number, type?: \"time\" | \"position\") => Promise<void>;\n  /**\n   * Starts or stops recording the current media\n   *\n   * @param path - Must be a valid directory path string or `undefined` to stop recording\n   *\n   * @returns A promise which resolves to `void`\n   */\n  readonly record: (path?: string) => Promise<void>;\n  /**\n   * Takes a snapshot of the current media\n   *\n   * @param path - Must be a valid directory path string\n   *\n   * @returns A promise which resolves to `void`\n   */\n  readonly snapshot: (path: string) => Promise<void>;\n  /**\n   * Posts an answer to a `Dialog`\n   *\n   * @param action - Must be an integer of `1` or `2`\n   *\n   * @returns A promise which resolves to `void`\n   */\n  readonly postAction: (action: 1 | 2) => Promise<void>;\n  /**\n   * Posts a username and password to a login `Dialog`\n   *\n   * @param username - Must be a valid username, can't be empty\n   * @param password - Must be a valid password, can be empty\n   * @param store - If `true`, store the credentials\n   *\n   * @returns A promise which resolves to `void`\n   */\n  readonly postLogin: (username: string, password: string, store?: boolean) => Promise<void>;\n  /**\n   * Dismisses a `Dialog`\n   *\n   * @returns A promise which resolves to `void`\n   */\n  readonly dismiss: () => Promise<void>;\n  /**\n   * Enters Picture-in-Picture (PiP) mode\n   *\n   * @note Config plugin has to be configured for Picture-in-Picture (PiP) to work\n   *\n   * @returns A promise which resolves to `void`\n   */\n  readonly startPictureInPicture: () => Promise<void>;\n  /**\n   * Exits Picture-in-Picture (PiP) mode\n   *\n   * @platform ios\n   *\n   * @returns A promise which resolves to `void`\n   */\n  readonly stopPictureInPicture: () => Promise<void>;\n}\n\nexport type LibVlcSource = string | number | null;\n\nexport type LibVlcSlaveSource = string | number;\n\nexport interface Tracks {\n  audio?: number;\n  video?: number;\n  subtitle?: number;\n}\n\nexport interface Slave {\n  source: LibVlcSlaveSource;\n  type: \"audio\" | \"subtitle\";\n  selected?: boolean;\n}\n\nexport type VideoAspectRatio = \"auto\" | (string & {}) | number;\n\nexport type VideoContentFit = \"contain\" | \"cover\" | \"fill\";\n\nexport type AudioMixingMode = \"mixWithOthers\" | \"duckOthers\" | \"auto\" | \"doNotMix\";\n\nexport interface NativeEventProps {\n  target: number;\n}\n\nexport interface NativeEvent<T> {\n  nativeEvent: T & NativeEventProps;\n}\n\nexport type LibVlcEvent<T> = Omit<T & NativeEventProps, \"target\">;\n\nexport interface Error {\n  message: string;\n}\n\nexport interface Time {\n  value: number;\n}\n\nexport interface Position {\n  value: number;\n}\n\nexport interface Snapshot {\n  path: string;\n}\n\nexport interface Dialog {\n  title: string;\n  text: string;\n  type: \"error\" | \"login\" | \"question\";\n  cancelText?: string;\n  action1Text?: string;\n  action2Text?: string;\n}\n\nexport interface Recording {\n  path: string | null;\n  isRecording: boolean;\n}\n\nexport interface Track {\n  id: number;\n  name: string;\n}\n\nexport interface MediaTracks {\n  audio: Track[];\n  video: Track[];\n  subtitle: Track[];\n}\n\nexport interface MediaInfo {\n  width: number;\n  height: number;\n  length: number;\n  seekable: boolean;\n}\n\n/**\n * @hidden\n */\ntype BufferingListener = () => void;\n\n/**\n * @hidden\n */\ntype PlayingListener = () => void;\n\n/**\n * @hidden\n */\ntype PausedListener = () => void;\n\n/**\n * @hidden\n */\ntype StoppedListener = () => void;\n\n/**\n * @hidden\n */\ntype EncounteredErrorListener = (event: NativeEvent<Error>) => void;\n\n/**\n * @hidden\n */\ntype TimeChangedListener = (event: NativeEvent<Time>) => void;\n\n/**\n * @hidden\n */\ntype PositionChangedListener = (event: NativeEvent<Position>) => void;\n\n/**\n * @hidden\n */\ntype ESAddedListener = (event: NativeEvent<MediaTracks>) => void;\n\n/**\n * @hidden\n */\ntype RecordChangedListener = (event: NativeEvent<Recording>) => void;\n\n/**\n * @hidden\n */\ntype SnapshotTakenListener = (event: NativeEvent<Snapshot>) => void;\n\n/**\n * @hidden\n */\ntype DialogDisplayListener = (event: NativeEvent<Dialog>) => void;\n\n/**\n * @hidden\n */\ntype FirstPlayListener = (event: NativeEvent<MediaInfo>) => void;\n\n/**\n * @hidden\n */\ntype ForegroundListener = () => void;\n\n/**\n * @hidden\n */\ntype BackgroundListener = () => void;\n\n/**\n * @hidden\n */\ntype PictureInPictureStartListener = () => void;\n\n/**\n * @hidden\n */\ntype PictureInPictureStopListener = () => void;\n\n/**\n * @hidden\n */\nexport interface LibVlcPlayerViewNativeProps extends ViewProps {\n  ref?: React.Ref<LibVlcPlayerViewRef>;\n  source?: LibVlcSource;\n  options?: string[];\n  tracks?: Tracks;\n  slaves?: Slave[];\n  scale?: number;\n  aspectRatio?: VideoAspectRatio;\n  contentFit?: VideoContentFit;\n  rate?: number;\n  time?: number;\n  volume?: number;\n  mute?: boolean;\n  audioMixingMode?: AudioMixingMode;\n  repeat?: boolean;\n  autoplay?: boolean;\n  pictureInPicture?: boolean;\n  onBuffering?: BufferingListener;\n  onPlaying?: PlayingListener;\n  onPaused?: PausedListener;\n  onStopped?: StoppedListener;\n  onEncounteredError?: EncounteredErrorListener;\n  onDialogDisplay?: DialogDisplayListener;\n  onTimeChanged?: TimeChangedListener;\n  onPositionChanged?: PositionChangedListener;\n  onESAdded?: ESAddedListener;\n  onRecordChanged?: RecordChangedListener;\n  onSnapshotTaken?: SnapshotTakenListener;\n  onFirstPlay?: FirstPlayListener;\n  onForeground?: ForegroundListener;\n  onBackground?: BackgroundListener;\n  onPictureInPictureStart?: PictureInPictureStartListener;\n  onPictureInPictureStop?: PictureInPictureStopListener;\n}\n\nexport interface LibVlcPlayerViewProps extends ViewProps {\n  /**\n   * Allows getting a ref to the component instance.\n   *\n   * Once the component unmounts, React will set `ref.current` to `null`\n   *\n   * @see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs}\n   */\n  ref: React.RefObject<LibVlcPlayerViewRef | null>;\n  /**\n   * Sets the source of the media to be played. Set to `null` to release the player\n   *\n   * @example\n   *\n   * ```tsx\n   * const BIG_BUCK_BUNNY =\n   *   \"https://download.blender.org/peach/bigbuckbunny_movies/big_buck_bunny_720p_h264.mov\";\n   *\n   * <LibVlcPlayerView source={BIG_BUCK_BUNNY} />\n   * ```\n   */\n  source: LibVlcSource;\n  /**\n   * Sets the options to initialize the media with\n   *\n   * @see {@link https://wiki.videolan.org/VLC_command-line_help/ VideoLAN Wiki}\n   *\n   * @example\n   *\n   * ```tsx\n   * const options = [\"--network-caching=1000\"];\n   *\n   * <LibVlcPlayerView\n   *   source={BIG_BUCK_BUNNY}\n   *   options={options}\n   * />\n   * ```\n   *\n   * @default []\n   */\n  options?: string[];\n  /**\n   * Sets the player audio, video and subtitle tracks\n   *\n   * @example\n   *\n   * ```tsx\n   * const tracks = {\n   *   audio: -1,\n   *   video: 1,\n   *   subtitle: 1,\n   * };\n   *\n   * <LibVlcPlayerView\n   *   source={BIG_BUCK_BUNNY}\n   *   tracks={tracks}\n   * />\n   * ```\n   *\n   * @default undefined\n   */\n  tracks?: Tracks;\n  /**\n   * Sets the player audio and subtitle slaves\n   *\n   * @example\n   *\n   * ```tsx\n   * const slaves = [\n   *   {\n   *     source: \"file://path/to/subtitle.srt\",\n   *     type: \"subtitle\",\n   *     selected: true,\n   *   },\n   * ];\n   *\n   * <LibVlcPlayerView\n   *   source={BIG_BUCK_BUNNY}\n   *   slaves={slaves}\n   * />\n   * ```\n   *\n   * @default []\n   */\n  slaves?: Slave[];\n  /**\n   * Sets the player scaling factor. Must be a float equal or greater than `0`\n   *\n   * @default 0\n   */\n  scale?: number;\n  /**\n   * Sets the container aspect ratio. Must be a valid ratio string or number\n   *\n   * @example \"16:9\"\n   *\n   * @default undefined\n   */\n  aspectRatio?: VideoAspectRatio;\n  /**\n   * Sets how the video should be scaled to fit in the container\n   *\n   * @example \"cover\"\n   *\n   * @default \"contain\"\n   */\n  contentFit?: VideoContentFit;\n  /**\n   * Sets the player rate. Must be a float equal or greater than `1`\n   *\n   * @default 1\n   */\n  rate?: number;\n  /**\n   * Sets the initial player time. Must be an integer in milliseconds\n   *\n   * @default 0\n   */\n  time?: number;\n  /**\n   * Sets the player volume. Must be an integer between `0` and `100`\n   *\n   * @default 100\n   */\n  volume?: number;\n  /**\n   * Sets the player volume to `0` when `true`. Previous value is set when `false`\n   *\n   * @default false\n   */\n  mute?: boolean;\n  /**\n   * Determines how the player will interact with other audio playing in the system\n   *\n   * @example \"doNotMix\"\n   *\n   * @default \"auto\"\n   */\n  audioMixingMode?: AudioMixingMode;\n  /**\n   * Determines whether the media should repeat once ended\n   *\n   * @default false\n   */\n  repeat?: boolean;\n  /**\n   * Determines whether the media should autoplay once created\n   *\n   * @default true\n   */\n  autoplay?: boolean;\n  /**\n   * Determines whether the player should allow Picture-in-Picture (PiP) mode\n   *\n   * @default false\n   */\n  pictureInPicture?: boolean;\n  /**\n   * Called after the `Buffering` player event\n   */\n  onBuffering?: () => void;\n  /**\n   * Called after the `Playing` player event\n   */\n  onPlaying?: () => void;\n  /**\n   * Called after the `Paused` player event\n   */\n  onPaused?: () => void;\n  /**\n   * Called after the `Stopped` player event\n   */\n  onStopped?: () => void;\n  /**\n   * Called after the `EncounteredError` player event\n   */\n  onEncounteredError?: (event: Error) => void;\n  /**\n   * Called after a `Dialog` needs to be displayed\n   */\n  onDialogDisplay?: (event: Dialog) => void;\n  /**\n   * Called after the `TimeChanged` player event\n   */\n  onTimeChanged?: (event: Time) => void;\n  /**\n   * Called after the `PositionChanged` player event\n   */\n  onPositionChanged?: (event: Position) => void;\n  /**\n   * Called after the `ESAdded` player event\n   */\n  onESAdded?: (event: MediaTracks) => void;\n  /**\n   * Called after the `RecordChanged` player event\n   */\n  onRecordChanged?: (event: Recording) => void;\n  /**\n   * Called after a media snapshot is taken\n   */\n  onSnapshotTaken?: (event: Snapshot) => void;\n  /**\n   * Called after the player first playing event\n   */\n  onFirstPlay?: (event: MediaInfo) => void;\n  /**\n   * Called after the player enters the foreground\n   */\n  onForeground?: () => void;\n  /**\n   * Called after the player enters the background\n   */\n  onBackground?: () => void;\n  /**\n   * Called after the player enters Picture-in-Picture (PiP) mode\n   */\n  onPictureInPictureStart?: () => void;\n  /**\n   * Called after the player exits Picture-in-Picture (PiP) mode\n   */\n  onPictureInPictureStop?: () => void;\n}\n"]}
+{"version":3,"file":"LibVlcPlayer.types.js","sourceRoot":"","sources":["../src/LibVlcPlayer.types.ts"],"names":[],"mappings":"","sourcesContent":["import type { ViewProps } from \"react-native\";\n\n// eslint-disable-next-line @typescript-eslint/no-empty-object-type, @typescript-eslint/consistent-type-definitions\nexport type LibVlcPlayerModuleEvents = {};\n\nexport interface LibVlcPlayerViewRef {\n  /**\n   * Starts playback of the current player\n   *\n   * @returns A promise which resolves to `void`\n   */\n  readonly play: () => Promise<void>;\n  /**\n   * Pauses playback of the current player\n   *\n   * @returns A promise which resolves to `void`\n   */\n  readonly pause: () => Promise<void>;\n  /**\n   * Stops playback of the current player\n   *\n   * @returns A promise which resolves to `void`\n   */\n  readonly stop: () => Promise<void>;\n  /**\n   * Sets the time or position of the current player\n   *\n   * @param value - Must be an integer equal or greater than `0`\n   * @param type - Defaults to `\"time\"`\n   *\n   * @returns A promise which resolves to `void`\n   */\n  readonly seek: (value: number, type?: \"time\" | \"position\") => Promise<void>;\n  /**\n   * Starts or stops recording the current media\n   *\n   * @param path - Must be a valid directory path or `undefined` to stop recording\n   *\n   * @returns A promise which resolves to `void`\n   */\n  readonly record: (path?: string) => Promise<void>;\n  /**\n   * Takes a snapshot of the current media\n   *\n   * @param path - Must be a valid directory path\n   *\n   * @returns A promise which resolves to `void`\n   */\n  readonly snapshot: (path: string) => Promise<void>;\n  /**\n   * Posts an answer to a `Dialog`\n   *\n   * @param action - Must be either `1` or `2`\n   *\n   * @returns A promise which resolves to `void`\n   */\n  readonly postAction: (action: 1 | 2) => Promise<void>;\n  /**\n   * Posts a username and password to a login `Dialog`\n   *\n   * @param username - Must be a valid username, can't be empty\n   * @param password - Must be a valid password, can be empty\n   * @param store - If `true`, store the credentials\n   *\n   * @returns A promise which resolves to `void`\n   */\n  readonly postLogin: (username: string, password: string, store?: boolean) => Promise<void>;\n  /**\n   * Dismisses a `Dialog`\n   *\n   * @returns A promise which resolves to `void`\n   */\n  readonly dismiss: () => Promise<void>;\n  /**\n   * Enters Picture-in-Picture (PiP) mode\n   *\n   * @note Config plugin has to be configured for Picture-in-Picture (PiP) to work\n   *\n   * @returns A promise which resolves to `void`\n   */\n  readonly startPictureInPicture: () => Promise<void>;\n  /**\n   * Exits Picture-in-Picture (PiP) mode\n   *\n   * @platform ios\n   *\n   * @returns A promise which resolves to `void`\n   */\n  readonly stopPictureInPicture: () => Promise<void>;\n}\n\nexport type LibVlcSource = string | number | null;\n\nexport type LibVlcSlaveSource = string | number;\n\nexport interface Tracks {\n  audio?: number;\n  video?: number;\n  subtitle?: number;\n}\n\nexport interface Slave {\n  source: LibVlcSlaveSource;\n  type: \"audio\" | \"subtitle\";\n  selected?: boolean;\n}\n\nexport type VideoAspectRatio = \"auto\" | (string & {}) | number;\n\nexport type VideoContentFit = \"contain\" | \"cover\" | \"fill\";\n\nexport type AudioMixingMode = \"mixWithOthers\" | \"duckOthers\" | \"auto\" | \"doNotMix\";\n\nexport interface NativeEventProps {\n  target: number;\n}\n\nexport interface NativeEvent<T> {\n  nativeEvent: T & NativeEventProps;\n}\n\nexport type LibVlcEvent<T> = Omit<T & NativeEventProps, \"target\">;\n\nexport interface Error {\n  message: string;\n}\n\nexport interface Time {\n  value: number;\n}\n\nexport interface Position {\n  value: number;\n}\n\nexport interface Snapshot {\n  path: string;\n}\n\nexport interface Dialog {\n  title: string;\n  text: string;\n  type: \"error\" | \"login\" | \"question\";\n  cancelText?: string;\n  action1Text?: string;\n  action2Text?: string;\n}\n\nexport interface Recording {\n  path: string | null;\n  isRecording: boolean;\n}\n\nexport interface Track {\n  id: number;\n  name: string;\n}\n\nexport interface MediaTracks {\n  audio: Track[];\n  video: Track[];\n  subtitle: Track[];\n}\n\nexport interface MediaInfo {\n  width: number;\n  height: number;\n  length: number;\n  seekable: boolean;\n}\n\n/**\n * @hidden\n */\ntype BufferingListener = () => void;\n\n/**\n * @hidden\n */\ntype PlayingListener = () => void;\n\n/**\n * @hidden\n */\ntype PausedListener = () => void;\n\n/**\n * @hidden\n */\ntype StoppedListener = () => void;\n\n/**\n * @hidden\n */\ntype EncounteredErrorListener = (event: NativeEvent<Error>) => void;\n\n/**\n * @hidden\n */\ntype TimeChangedListener = (event: NativeEvent<Time>) => void;\n\n/**\n * @hidden\n */\ntype PositionChangedListener = (event: NativeEvent<Position>) => void;\n\n/**\n * @hidden\n */\ntype ESAddedListener = (event: NativeEvent<MediaTracks>) => void;\n\n/**\n * @hidden\n */\ntype RecordChangedListener = (event: NativeEvent<Recording>) => void;\n\n/**\n * @hidden\n */\ntype SnapshotTakenListener = (event: NativeEvent<Snapshot>) => void;\n\n/**\n * @hidden\n */\ntype DialogDisplayListener = (event: NativeEvent<Dialog>) => void;\n\n/**\n * @hidden\n */\ntype FirstPlayListener = (event: NativeEvent<MediaInfo>) => void;\n\n/**\n * @hidden\n */\ntype ForegroundListener = () => void;\n\n/**\n * @hidden\n */\ntype BackgroundListener = () => void;\n\n/**\n * @hidden\n */\ntype PictureInPictureStartListener = () => void;\n\n/**\n * @hidden\n */\ntype PictureInPictureStopListener = () => void;\n\n/**\n * @hidden\n */\nexport interface LibVlcPlayerViewNativeProps extends ViewProps {\n  ref?: React.Ref<LibVlcPlayerViewRef>;\n  source?: LibVlcSource;\n  options?: string[];\n  tracks?: Tracks;\n  slaves?: Slave[];\n  scale?: number;\n  aspectRatio?: VideoAspectRatio;\n  contentFit?: VideoContentFit;\n  rate?: number;\n  time?: number;\n  volume?: number;\n  mute?: boolean;\n  audioMixingMode?: AudioMixingMode;\n  repeat?: boolean;\n  autoplay?: boolean;\n  pictureInPicture?: boolean;\n  onBuffering?: BufferingListener;\n  onPlaying?: PlayingListener;\n  onPaused?: PausedListener;\n  onStopped?: StoppedListener;\n  onEncounteredError?: EncounteredErrorListener;\n  onDialogDisplay?: DialogDisplayListener;\n  onTimeChanged?: TimeChangedListener;\n  onPositionChanged?: PositionChangedListener;\n  onESAdded?: ESAddedListener;\n  onRecordChanged?: RecordChangedListener;\n  onSnapshotTaken?: SnapshotTakenListener;\n  onFirstPlay?: FirstPlayListener;\n  onForeground?: ForegroundListener;\n  onBackground?: BackgroundListener;\n  onPictureInPictureStart?: PictureInPictureStartListener;\n  onPictureInPictureStop?: PictureInPictureStopListener;\n}\n\nexport interface LibVlcPlayerViewProps extends ViewProps {\n  /**\n   * Allows getting a ref to the component instance.\n   *\n   * Once the component unmounts, React will set `ref.current` to `null`\n   *\n   * @see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs}\n   */\n  ref: React.RefObject<LibVlcPlayerViewRef | null>;\n  /**\n   * Sets the source of the media to be played. Set to `null` to release the player\n   *\n   * @example\n   *\n   * ```tsx\n   * const BIG_BUCK_BUNNY =\n   *   \"https://download.blender.org/peach/bigbuckbunny_movies/big_buck_bunny_720p_h264.mov\";\n   *\n   * <LibVlcPlayerView source={BIG_BUCK_BUNNY} />\n   * ```\n   */\n  source: LibVlcSource;\n  /**\n   * Sets the options to initialize the media with\n   *\n   * @see {@link https://wiki.videolan.org/VLC_command-line_help/ VideoLAN Wiki}\n   *\n   * @example\n   *\n   * ```tsx\n   * const options = [\"--network-caching=1000\"];\n   *\n   * <LibVlcPlayerView\n   *   source={BIG_BUCK_BUNNY}\n   *   options={options}\n   * />\n   * ```\n   *\n   * @default []\n   */\n  options?: string[];\n  /**\n   * Sets the player audio, video and subtitle tracks\n   *\n   * @example\n   *\n   * ```tsx\n   * const tracks = {\n   *   audio: -1,\n   *   video: 1,\n   *   subtitle: 1,\n   * };\n   *\n   * <LibVlcPlayerView\n   *   source={BIG_BUCK_BUNNY}\n   *   tracks={tracks}\n   * />\n   * ```\n   *\n   * @default undefined\n   */\n  tracks?: Tracks;\n  /**\n   * Sets the player audio and subtitle slaves\n   *\n   * @example\n   *\n   * ```tsx\n   * const slaves = [\n   *   {\n   *     source: \"file://path/to/subtitle.srt\",\n   *     type: \"subtitle\",\n   *     selected: true,\n   *   },\n   * ];\n   *\n   * <LibVlcPlayerView\n   *   source={BIG_BUCK_BUNNY}\n   *   slaves={slaves}\n   * />\n   * ```\n   *\n   * @default []\n   */\n  slaves?: Slave[];\n  /**\n   * Sets the player scaling factor. Must be a float equal or greater than `0`\n   *\n   * @default 0\n   */\n  scale?: number;\n  /**\n   * Sets the container aspect ratio. Must be a valid ratio, float or `\"auto\"`\n   *\n   * @example \"16:9\"\n   *\n   * @default undefined\n   */\n  aspectRatio?: VideoAspectRatio;\n  /**\n   * Sets how the video should be scaled to fit in the container\n   *\n   * @example \"cover\"\n   *\n   * @default \"contain\"\n   */\n  contentFit?: VideoContentFit;\n  /**\n   * Sets the player rate. Must be a float equal or greater than `1`\n   *\n   * @default 1\n   */\n  rate?: number;\n  /**\n   * Sets the initial player time. Must be an integer in milliseconds\n   *\n   * @default 0\n   */\n  time?: number;\n  /**\n   * Sets the player volume. Must be an integer between `0` and `100`\n   *\n   * @default 100\n   */\n  volume?: number;\n  /**\n   * Sets the player volume to `0` when `true`. Previous value is set when `false`\n   *\n   * @default false\n   */\n  mute?: boolean;\n  /**\n   * Determines how the player will interact with other audio playing in the system\n   *\n   * @example \"doNotMix\"\n   *\n   * @default \"auto\"\n   */\n  audioMixingMode?: AudioMixingMode;\n  /**\n   * Determines whether the media should repeat once ended\n   *\n   * @default false\n   */\n  repeat?: boolean;\n  /**\n   * Determines whether the media should autoplay once created\n   *\n   * @default true\n   */\n  autoplay?: boolean;\n  /**\n   * Determines whether the player should allow Picture-in-Picture (PiP) mode\n   *\n   * @default false\n   */\n  pictureInPicture?: boolean;\n  /**\n   * Called after the `Buffering` player event\n   */\n  onBuffering?: () => void;\n  /**\n   * Called after the `Playing` player event\n   */\n  onPlaying?: () => void;\n  /**\n   * Called after the `Paused` player event\n   */\n  onPaused?: () => void;\n  /**\n   * Called after the `Stopped` player event\n   */\n  onStopped?: () => void;\n  /**\n   * Called after the `EncounteredError` player event\n   */\n  onEncounteredError?: (event: Error) => void;\n  /**\n   * Called after a `Dialog` needs to be displayed\n   */\n  onDialogDisplay?: (event: Dialog) => void;\n  /**\n   * Called after the `TimeChanged` player event\n   */\n  onTimeChanged?: (event: Time) => void;\n  /**\n   * Called after the `PositionChanged` player event\n   */\n  onPositionChanged?: (event: Position) => void;\n  /**\n   * Called after the `ESAdded` player event\n   */\n  onESAdded?: (event: MediaTracks) => void;\n  /**\n   * Called after the `RecordChanged` player event\n   */\n  onRecordChanged?: (event: Recording) => void;\n  /**\n   * Called after a media snapshot is taken\n   */\n  onSnapshotTaken?: (event: Snapshot) => void;\n  /**\n   * Called after the player first playing event\n   */\n  onFirstPlay?: (event: MediaInfo) => void;\n  /**\n   * Called after the player enters the foreground\n   */\n  onForeground?: () => void;\n  /**\n   * Called after the player enters the background\n   */\n  onBackground?: () => void;\n  /**\n   * Called after the player enters Picture-in-Picture (PiP) mode\n   */\n  onPictureInPictureStart?: () => void;\n  /**\n   * Called after the player exits Picture-in-Picture (PiP) mode\n   */\n  onPictureInPictureStop?: () => void;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expo-libvlc-player",
-  "version": "7.0.7",
+  "version": "7.0.8",
   "description": "LibVLC Player for Expo",
   "main": "build/index.js",
   "types": "build/index.d.ts",

package/src/LibVlcPlayer.types.ts

@@ -25,7 +25,7 @@ export interface LibVlcPlayerViewRef {
   /**
    * Sets the time or position of the current player
    *
-   * @param value - Must be a number equal or greater than `0`
+   * @param value - Must be an integer equal or greater than `0`
    * @param type - Defaults to `"time"`
    *
    * @returns A promise which resolves to `void`
@@ -34,7 +34,7 @@ export interface LibVlcPlayerViewRef {
   /**
    * Starts or stops recording the current media
    *
-   * @param path - Must be a valid directory path string or `undefined` to stop recording
+   * @param path - Must be a valid directory path or `undefined` to stop recording
    *
    * @returns A promise which resolves to `void`
    */
@@ -42,7 +42,7 @@ export interface LibVlcPlayerViewRef {
   /**
    * Takes a snapshot of the current media
    *
-   * @param path - Must be a valid directory path string
+   * @param path - Must be a valid directory path
    *
    * @returns A promise which resolves to `void`
    */
@@ -50,7 +50,7 @@ export interface LibVlcPlayerViewRef {
   /**
    * Posts an answer to a `Dialog`
    *
-   * @param action - Must be an integer of `1` or `2`
+   * @param action - Must be either `1` or `2`
    *
    * @returns A promise which resolves to `void`
    */
@@ -379,7 +379,7 @@ export interface LibVlcPlayerViewProps extends ViewProps {
    */
   scale?: number;
   /**
-   * Sets the container aspect ratio. Must be a valid ratio string or number
+   * Sets the container aspect ratio. Must be a valid ratio, float or `"auto"`
    *
    * @example "16:9"
    *