` |\n| `postLogin()` | username: string — Can't be empty
password?: string — Can be empty
store?: boolean — Whether to store the credentials
| Posts a username and password to a login dialog | `Promise` |\n| `dismiss()` | | Dismisses the current dialog | `Promise` |\n| `startPictureInPicture()` | | Enters Picture-in-Picture (PiP) mode. Config plugin has to be configured for PiP to work | `Promise` |\n| `stopPictureInPicture()` | | Exits Picture-in-Picture (PiP) mode on iOS | `Promise` |\n\n### View props\n\nThe `LibVlcPlayerView` extends React Native `ViewProps` and implements the following props:\n\n| Prop | Description | Default |\n| ------------------ | --------------------------------------------------------------------------------------------------------------------------------- | ----------- |\n| `source` | Sets the source of the media to be played, or `null` to release the player. See [`LibVlcSource`](#libvlcsource) for more | |\n| `options` | Sets the options to initialize the media with. See the [VideoLAN Wiki](https://wiki.videolan.org/VLC_command-line_help/) for more | `[]` |\n| `slaves` | Sets the player audio and subtitle slaves. See [`Slave`](#slave) for more | `[]` |\n| `tracks` | Sets the player audio, video, and subtitle track indexes. See [`Tracks`](#tracks) for more | `undefined` |\n| `delays` | Sets the player audio and subtitle delay values in microseconds. See [`Delays`](#delays) for more | `undefined` |\n| `scale` | Sets the player scaling factor | `0` |\n| `aspectRatio` | Sets the container aspect ratio. When set to auto, a fallback ratio is required | `undefined` |\n| `fallbackRatio` | Sets the fallback aspect ratio | `undefined` |\n| `contentFit` | Sets how the video should be scaled to fit in the container | `\"contain\"` |\n| `rate` | Sets the player playback rate | `1` |\n| `time` | Sets the initial player time in milliseconds. Must be `0` or greater | `0` |\n| `volume` | Sets the player volume. Must be between `0` and `100` | `100` |\n| `mute` | Sets the player volume to `0` when `true` and restores previous volume when `false` | `false` |\n| `audioMixingMode` | Determines how the player will interact with other audio in the system | `\"auto\"` |\n| `repeat` | Determines whether the media should repeat once ended | `false` |\n| `autoplay` | Determines whether the media should autoplay once created | `true` |\n| `pictureInPicture` | Determines whether the player should allow Picture-in-Picture (PiP) mode | `false` |\n\n#### Callback props\n\n| Prop | Description | Payload |\n| ------------------------- | ------------------------------------------------------------ | ----------------------------- |\n| `onBuffering` | Called after the `Buffering` player event | [`Buffering`](#buffering) |\n| `onPlaying` | Called after the `Playing` player event | |\n| `onPaused` | Called after the `Paused` player event | |\n| `onStopped` | Called after the `Stopped` player event | |\n| `onEncounteredError` | Called after the `EncounteredError` player event | [`Error`](#error) |\n| `onDialogDisplay` | Called after a dialog needs to be displayed | [`Dialog`](#dialog) |\n| `onTimeChanged` | Called after the `TimeChanged` player event | [`Time`](#time) |\n| `onPositionChanged` | Called after the `PositionChanged` player event | [`Position`](#position) |\n| `onESAdded` | Called after the `ESAdded` player event | [`MediaTracks`](#mediatracks) |\n| `onRecordChanged` | Called after the `RecordChanged` player event | [`Recording`](#recording) |\n| `onSnapshotTaken` | Called after a media snapshot is taken | [`Snapshot`](#snapshot) |\n| `onFirstPlay` | Called after the player first playing event | [`MediaInfo`](#mediainfo) |\n| `onForeground` | Called after the player enters the foreground | |\n| `onBackground` | Called after the player enters the background | |\n| `onPictureInPictureStart` | Called after the player enters Picture-in-Picture (PiP) mode | |\n| `onPictureInPictureStop` | Called after the player exits Picture-in-Picture (PiP) mode | |\n\n### Module types\n\n#### `LibVlcSource`\n\n```ts\ntype LibVlcSource = string | number | null;\n```\n\n#### `Slave`\n\n```ts\ninterface Slave {\n source: string | number;\n type: \"audio\" | \"subtitle\";\n selected?: boolean;\n}\n```\n\n#### `Tracks`\n\n```ts\ninterface Tracks {\n audio?: number;\n video?: number;\n subtitle?: number;\n}\n```\n\n#### `Delays`\n\n```ts\ninterface Delays {\n audio?: number;\n subtitle?: number;\n}\n```\n\n#### `Buffering`\n\n```ts\ninterface Buffering {\n value: number;\n}\n```\n\n#### `Error`\n\n```ts\ninterface Error {\n message: string;\n}\n```\n\n#### `Dialog`\n\n```ts\ninterface Dialog {\n title: string;\n text: string;\n type: \"error\" | \"login\" | \"question\";\n cancelText: string | null;\n action1Text: string | null;\n action2Text: string | null;\n}\n```\n\n#### `Time`\n\n```ts\ninterface Time {\n value: number;\n}\n```\n\n#### `Position`\n\n```ts\ninterface Position {\n value: number;\n}\n```\n\n#### `MediaTrack`\n\n```ts\ninterface MediaTrack {\n id: number;\n name: string;\n}\n```\n\n#### `MediaTracks`\n\n```ts\ninterface MediaTracks {\n audio: MediaTrack[];\n video: MediaTrack[];\n subtitle: MediaTrack[];\n}\n```\n\n#### `Recording`\n\n```ts\ninterface Recording {\n path: string | null;\n isRecording: boolean;\n}\n```\n\n#### `Snapshot`\n\n```ts\ninterface Snapshot {\n path: string;\n}\n```\n\n#### `Video`\n\n```ts\ninterface Video {\n width: number;\n height: number;\n frameRate: number;\n bitrate: number;\n}\n```\n\n#### `Media`\n\n```ts\ninterface Media {\n length: number;\n seekable: boolean;\n}\n```\n\n#### `Metadata`\n\n```ts\ninterface Metadata {\n title: string | null;\n artist: string | null;\n album: string | null;\n artworkURL: string | null;\n}\n```\n\n#### `MediaInfo`\n\n```ts\ninterface MediaInfo {\n video: Video;\n media: Media;\n metadata: Metadata;\n}\n```\n\n## Known issues\n\n#### Black screen\n\nOn Android, the `libvlcjni` player detaches from the View after switching screens.\n\nThe current workaround attaches the View back to the player but causes a brief black screen.\n\nhttps://code.videolan.org/videolan/vlc-android/-/issues/1495\n\n#### Local network\n\nOn iOS, the `VLCKit` player interacts with the local network to discover media servers by default.\n\nA custom message can be provided for the `NSLocalNetworkUsageDescription` key in the Info.plist file.\n\nhttps://code.videolan.org/videolan/vlc-ios/-/issues/893\n\n## Contributing\n\nContributions are always welcome. Please raise any issues or fix them by creating a pull request.\n\n## Development\n\nInstall [Ktlint](https://github.com/ktlint/ktlint) and [SwiftFormat](https://github.com/nicklockwood/swiftformat) for linting native code:\n\n```sh\nbrew install ktlint swiftformat\n```\n\nLibVLC might not render properly on emulators or simulators. Please test on a real device.\n\n## Disclaimer\n\nThis project is not affiliated with, endorsed by, or officially supported by VideoLAN. The VLC icon is trademark of VideoLAN and is used here solely to indicate compatibility with the following LibVLC bindings:\n\n- `libvlcjni` for Android / Android TV\n- `VLCKit` for iOS / Apple TV\n\nFor official VLC products and support, please visit [videolan.org](https://www.videolan.org/).\n\n## Credits\n\nThis library is inspired by existing projects such as [react-native-vlc-media-player](https://github.com/razorRun/react-native-vlc-media-player) and [expo-video](https://docs.expo.dev/versions/latest/sdk/video/).\n\n## License\n\nMade available under the MIT license, as found in the [LICENSE](LICENSE) file.\n","readmeFilename":"README.md"}![\"VLC](\"example/assets/vlc.png\")
\n![\"npm](\"https://img.shields.io/npm/v/expo-libvlc-player\")
![\"Example](\"example/assets/player.png\")
\n