Skip to main content

React Native

The easiest way to view Vindral streams in React Native applications is to embed the hosted player with a WebView.

The example code below is simplified to focus on the relevant parts.

import React from "react";
import { View } from "react-native";
import { WebView } from "react-native-webview";

const App = () => {
return (
<View style={{ flex: 1 }}>
<WebView
source={{
uri: "https://embed.vindral.com/?channelId=vindral_demo1_ci_099ee1fa-80f3-455e-aa23-3d184e93e04f",
}}
allowsFullscreenVideo
mediaPlaybackRequiresUserAction={false}
/>
</View>
);
};

export default App;

Communication between React Native and WebView

The following is a demonstration of how to establish communication between the Vindral web SDK and native code. The example illustrates how to play and pause, as well as how to monitor certain events such as playback state, volume state, and errors.

For a comprehensive guide on the functions and events of the Web SDK, refer to the Web SDK documentation.

You can find a complete example project on GitHub.

import { StatusBar } from "expo-status-bar";
import { StyleSheet, View, Button } from "react-native";
import WebView, { WebViewMessageEvent } from "react-native-webview";
import React, { useRef } from "react";

interface Message {
type: "playback state" | "volume state" | "error";
}

interface PlaybackStateMessage extends Message {
type: "playback state";
state: "buffering" | "playing" | "paused";
}

interface VolumeStateMessage extends Message {
type: "volume state";
state: {
volume: number;
isMuted: boolean;
};
}

interface ErrorMessage extends Message {
type: "error";
error: {
code: string;
message: string;
isFatal: boolean;
};
}

const script = `
async function run() {
let loops = 0
while (!window.vindral) {
if (loops > 20) {
throw new Error("Could not find window.vindral")
}
await new Promise(r => setTimeout(r, 100))
loops++
}

window.vindral.on("playback state", (state) => window.ReactNativeWebView.postMessage(JSON.stringify({
type: "playback state",
state,
})))
window.vindral.on("volume state", (state) => window.ReactNativeWebView.postMessage(JSON.stringify({
type: "volume state",
state,
})))
window.vindral.on("error", (error) => window.ReactNativeWebView.postMessage(JSON.stringify({
type: "error",
error,
})))
}
run()

true; // note: this is required, or you'll sometimes get silent failures
`;

export default function App() {
const webViewRef = useRef<WebView>(null);

const onMessage = (event: WebViewMessageEvent) => {
const message = JSON.parse(event.nativeEvent.data);

switch (message.type) {
case "playback state": {
const playbackStateMessage = message as PlaybackStateMessage;
console.log("playback state", playbackStateMessage.state);
break;
}
case "volume state": {
const volumeStateMessage = message as VolumeStateMessage;
console.log("volume state", volumeStateMessage.state);
break;
}
case "error": {
const errorMessage = message as ErrorMessage;
console.error("error", errorMessage.error);
break;
}
default:
console.log("unknown message", message);
}
};

return (
<View style={styles.container}>
<StatusBar style="auto" />
<WebView
ref={webViewRef}
source={{
uri: "https://embed.vindral.com/?channelId=vindral_demo1_ci_099ee1fa-80f3-455e-aa23-3d184e93e04f",
}}
allowsFullscreenVideo
mediaPlaybackRequiresUserAction={false}
javaScriptEnabled
injectedJavaScript={script}
onMessage={onMessage}
/>
<View style={styles.controls}>
<Button
title="Play"
onPress={() =>
webViewRef.current?.injectJavaScript("window.vindral.play()")
}
/>
<Button
title="Pause"
onPress={() =>
webViewRef.current?.injectJavaScript("window.vindral.pause()")
}
/>
</View>
</View>
);
}

const styles = StyleSheet.create({
container: {
flex: 1,
},

controls: {
position: "absolute",
bottom: 0,
left: 0,
right: 0,
flexDirection: "row",
justifyContent: "center",
padding: 20,
gap: 20,
},
});