Skip to content
Platform docs
Auth, users, webhooks & more
Info:
This is beta documentation for Stream Video React Native SDK v2. For the latest stable version, see the latest version (v1).

LivestreamPlayer

Play WebRTC livestreams with call ID and type. Uses ViewerLivestream internally.

Preview of the LivestreamPlayer component.

General usage

Show LivestreamPlayer UI:

import {
  StreamVideo,
  LivestreamPlayer,
} from '@stream-io/video-react-native-sdk';

const LivestreamScreen() {
  return (
    <StreamVideo client={client}>
      <LivestreamPlayer callType="livestream" callId={callId} />
    </StreamVideo>
  );
}

Props

callType

The call type. Usually livestream.

callId

The call ID.

ViewerLivestream

Component to override the ViewerLivestream component that is used under the hood.

Type Default Value
ComponentType| undefined ViewerLivestream

joinBehavior

Determines when the viewer joins the call. Can have one of these two values: "asap" (by default) or "live".