Options
All
  • Public
  • Public/Protected
  • All
Menu

agora-react-uikit

Index

Variables

GridVideo

GridVideo: FC = ...

React Component to render the user videos in a grid

LocalUserContext

LocalUserContext: FC<LocalUserContextInterface> = ...

React context that exposes the LocalUIKitUser data object

MaxUidContext

MaxUidContext: Context<UIKitUser[]> = ...

React context to expose user array displayed in the maximised view

MinUidContext

MinUidContext: Context<UIKitUser[]> = ...

React context to expose user array displayed in the minimized view

PinnedVideo

PinnedVideo: FC = ...

React Component to render the user videos in the pinned/spotlight layout

PropsContext

PropsContext: Context<PropsInterface> = ...

React Context to manage the user props

RtcConfigure

RtcConfigure: FC<Partial<RtcPropsInterface>> = ...

React component that contains the RTC logic. It manages the user state and provides it the children components by wrapping them with context providers.

RtcContext

RtcContext: Context<RtcContextInterface> = ...

Context to access local/remote tracks, client, dispatch and localuid. It's setup by RtcConfigure.

TracksConfigure

TracksConfigure: FC<Partial<RtcPropsInterface>> = ...

React component that create local camera and microphone tracks and assigns them to the child components

default

default: FC<PropsInterface> = ...

High level component to render the UI Kit

param props

PropsInterface

icons

icons: { callEnd: Element; mic: Element; micOff: Element; remoteSwap: Element; videocam: Element; videocamOff: Element } = ...

Type declaration

Functions

Const BtnTemplate

EndCall

LocalAudioMute

LocalControls

LocalVideoMute

Const MaxVideoView

Const MinVideoView

RemoteAudioMute

RemoteVideoMute

SwapUser

Const VideoPlaceholder

Const VideocallUI

Generated using TypeDoc