Function FlexibleVideo

FlexibleVideo - Video grid layout with screen sharing and annotation support

FlexibleVideo is a specialized React Native component for displaying video streams in a flexible grid layout. It extends FlexibleGrid with additional support for screen sharing overlays and real-time annotation capabilities.

Key Features:

  • Dynamic video grid with custom rows/columns
  • Aspect ratio preservation for video streams
  • Screen sharing overlay (Screenboard) support
  • Real-time screen annotation capabilities
  • Custom cell dimensions and background colors
  • Efficient video stream rendering

UI Customization: This component can be replaced via uiOverrides.flexibleVideoComponent to provide a completely custom video grid implementation.

Component

Example

// Basic usage - 2x2 video grid
import React from 'react';
import { FlexibleVideo, VideoCard } from 'mediasfu-reactnative-expo';

function VideoGrid() {
  const participants = [p1, p2, p3, p4];
  
  const videoComponents = participants.map((p, idx) => (
    <VideoCard
      key={idx}
      name={p.name}
      participant={p}
      videoStream={p.stream}
      parameters={sessionParams}
    />
  ));

  return (
    <FlexibleVideo
      customWidth={400}
      customHeight={300}
      rows={2}
      columns={2}
      componentsToRender={videoComponents}
      showAspect={true}
      backgroundColor="#000"
    />
  );
}

Example

// With screen sharing annotation
<FlexibleVideo
  customWidth={800}
  customHeight={600}
  rows={1}
  columns={1}
  componentsToRender={[screenShareVideo]}
  showAspect={true}
  backgroundColor="#1a1a2e"
  Screenboard={<ScreenboardComponent />}
  annotateScreenStream={true}
  localStreamScreen={localScreenStream}
/>

Example

// Using uiOverrides for complete video grid replacement
import { MyCustomVideoGrid } from './MyCustomVideoGrid';

const sessionConfig = {
  credentials: { apiKey: 'your-api-key' },
  uiOverrides: {
    flexibleVideoComponent: {
      component: MyCustomVideoGrid,
      injectedProps: {
        layout: 'spotlight',
        transition: 'smooth',
      },
    },
  },
};

// MyCustomVideoGrid.tsx
export const MyCustomVideoGrid = (props: FlexibleVideoOptions & { layout: string; transition: string }) => {
  return (
    <View style={{ flex: 1 }}>
      {props.layout === 'spotlight' ? (
        <View style={{ flex: 1 }}>{props.componentsToRender[0]}</View>
      ) : (
        props.componentsToRender.map((component, idx) => (
          <View key={idx} style={{ width: props.customWidth, height: props.customHeight }}>
            {component}
          </View>
        ))
      )}
      {props.Screenboard}
    </View>
  );
};

Properties

propTypes? contextTypes? defaultProps? displayName?

Properties

OptionalpropTypes

propTypes?: WeakValidationMap<FlexibleVideoOptions>

Used to declare the types of the props accepted by the component. These types will be checked during rendering and in development only.

We recommend using TypeScript instead of checking prop types at runtime.

See

React Docs

OptionalcontextTypes

contextTypes?: ValidationMap<any>

Deprecated

Lets you specify which legacy context is consumed by this component.

See

Legacy React Docs

OptionaldefaultProps

defaultProps?: Partial<FlexibleVideoOptions>

Used to define default values for the props accepted by the component.

See

React Docs

Example

type Props = { name?: string }

const MyComponent: FC<Props> = (props) => {
  return <div>{props.name}</div>
}

MyComponent.defaultProps = {
  name: 'John Doe'
}

Deprecated

Use values for destructuring assignments instead.

OptionaldisplayName

displayName?: string

Used in debugging messages. You might want to set it explicitly if you want to display a different name for debugging purposes.

See

Legacy React Docs

Example


const MyComponent: FC = () => {
  return <div>Hello!</div>
}

MyComponent.displayName = 'MyAwesomeComponent'

Settings

Member Visibility

On This Page

Properties