Options
All
  • Public
  • Public/Protected
  • All
Menu

agora-react-uikit

Index

Variables

GridVideo

GridVideo: React.FC = ...

LocalUserContext

LocalUserContext: React.FC<LocalUserContextInterface> = ...

MaxUidContext

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

MinUidContext

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

PinnedVideo

PinnedVideo: React.FC = ...

PropsContext

PropsContext: Context<PropsInterface> = ...

RtcConfigure

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

RtcContext

RtcContext: Context<RtcContextInterface> = ...

TracksConfigure

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

default

default: React.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

  • callEnd: Element
  • mic: Element
  • micOff: Element
  • remoteSwap: Element
  • videocam: Element
  • videocamOff: Element

Functions

Const BtnTemplate

  • BtnTemplate(props: BtnTemplateInterface): Element

EndCall

  • EndCall(): Element

LocalAudioMute

  • LocalAudioMute(): Element

LocalControls

  • LocalControls(): Element

LocalVideoMute

  • LocalVideoMute(): Element

Const MaxVideoView

  • MaxVideoView(props: { style?: CSSProperties; user: UIKitUser }): Element
  • Parameters

    • props: { style?: CSSProperties; user: UIKitUser }
      • Optional style?: CSSProperties
      • user: UIKitUser

    Returns Element

Const MinVideoView

  • MinVideoView(props: { user: UIKitUser }): Element
  • Parameters

    • props: { user: UIKitUser }
      • user: UIKitUser

    Returns Element

RemoteAudioMute

  • RemoteAudioMute(props: { UIKitUser: UIKitUser }): null | Element

RemoteVideoMute

  • RemoteVideoMute(props: { UIKitUser: UIKitUser }): null | Element

SwapUser

  • SwapUser(props: { UIKitUser: UIKitUser }): Element

Const VideoPlaceholder

Generated using TypeDoc