If you look at the source code it only works for Android. Unfortunately, it is not clearly documented that this is the case. For iOS it builds, but returns "The video failed to load"
https://github.com/mendix/native-widgets/blob/main/packages/pluggableWidgets/video-player-native/src/VideoPlayer.tsx
Are there plans to extend this widget to work on iOS?