FloatingParticipantView

FloatingParticipantView displays the local video stream of the local participant. It is a floating view that can be dragged in the call area.

Floating Participant View Camera Enabled

Floating Participant View Camera Disabled

When the video is muted, the video muted icon is shown in a disabled background.

General Usage

In order to use the FloatingParticipantView as a standalone component, you should use the following code:

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

const App = () => {
  const { useLocalParticipant } = useCallStateHooks();
  const localParticipant = useLocalParticipant();
  return <FloatingParticipantView participant={localParticipant} />;
};

Props

alignment

Determines where the floating participant video will be placed initially.

TypeDefault value
top-left |top-right|bottom-left|bottom-righttop-right

participant

The participant to be rendered in the FloatingParticipantView.

onPressHandler

Handler used to handle actions on click of the participant view in FloatingParticipantView.

Type
() => void | undefined

style

This prop is used to override the root container style of the component.

videoZOrder

The zOrder for the video that will be displayed.

TypeDefault Value
number0

objectFit

Represents how the video view fits within the parent view.

TypeDefault Value
'contain' | 'cover' |undefinedcover

ParticipantLabel

Component to customize the Label of the participant.

TypeDefault Value
ComponentType| undefinedParticipantLabel

ParticipantReaction

Component to customize the component that displays the reaction of the participant.

TypeDefault Value
ComponentType| undefinedParticipantReaction

ParticipantNetworkQualityIndicator

Component to customize the network quality indicator of the participant.

TypeDefault Value
ComponentType| undefinedParticipantNetworkQualityIndicator

ParticipantVideoFallback

Component to customize the video fallback of the participant, when the video is disabled.

TypeDefault Value
ComponentType| undefinedParticipantVideoFallback

ParticipantView

Prop to customize the ParticipantView component entirely.

TypeDefault Value
ComponentType| undefinedParticipantView

VideoRenderer

Component to customize the video component of the participant. It is also responsible to display the ParticipantVideoFallback.

TypeDefault Value
ComponentType| undefinedVideoRenderer

© Getstream.io, Inc. All Rights Reserved.