Options
All
  • Public
  • Public/Protected
  • All
Menu

agora-react-uikit

Index

Type aliases

CallbacksInterface

Callbacks exposed by the UIKit

messageObject

messageType

messageType: "UserData" | "MuteRequest"

muteRequest

muteRequest: { device: mutingDevice; isForceful: boolean; messageType: "MuteRequest"; mute: boolean; rtcId: UID }

Type declaration

  • device: mutingDevice
  • isForceful: boolean
  • messageType: "MuteRequest"
  • mute: boolean
  • rtcId: UID

rtmCallbacks

rtmCallbacks: { channel?: Partial<RtmChannelEvents>; client?: Partial<RtmClientEvents> }

Callbacks to pass to RTM events

Type declaration

userData

userData: { agora: { rtc: string; rtm: string }; messageType: "UserData"; role: clientRoleRaw; rtcId: UID; rtmId: string; uikit: { framework: string; platform: string; version: string }; username?: string }

Type declaration

  • agora: { rtc: string; rtm: string }
    • rtc: string
    • rtm: string
  • messageType: "UserData"
  • role: clientRoleRaw
  • rtcId: UID
  • rtmId: string
  • uikit: { framework: string; platform: string; version: string }
    • framework: string
    • platform: string
    • version: string
  • Optional username?: string

Properties

muteAudio

muteAudio: (user: LocalUIKitUser, dispatch: DispatchType, localAudioTrack: ILocalAudioTrack) => Promise<void>

Type declaration

muteVideo

muteVideo: (user: LocalUIKitUser, dispatch: DispatchType, localVideoTrack: ILocalVideoTrack) => Promise<void>

Type declaration

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.

RtcConsumer

RtcConsumer: Consumer<RtcContextInterface> = RtcContext.Consumer

RtcContext

RtcContext: Context<RtcContextInterface> = ...

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

RtcProvider

RtcProvider: Provider<RtcContextInterface> = RtcContext.Provider

RtmConsumer

RtmConsumer: Consumer<rtmContext> = RtmContext.Consumer

RtmContext

RtmContext: Context<rtmContext> = ...

Context to access RTM data. It's setup by RtmConfigure.

RtmProvider

RtmProvider: Provider<rtmContext> = RtmContext.Provider

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

RemoteMutePopUp

RemoteVideoMute

Const RtmConfigure

  • React component that contains the RTM logic. It manages the usernames, remote mute requests and provides data to the children components by wrapping them with context providers.

    Parameters

    • props: any

    Returns Element

SwapUser

Const VideoPlaceholder

Const VideocallUI

Const createRawMessage

  • createRawMessage(msg: any): Uint8Array
  • Create an RTM raw message from any serilizable JS Object, decode using the parsePayload function

    Parameters

    • msg: any

      message object

    Returns Uint8Array

    Uint8Array

Const parsePayload

Generated using TypeDoc