Agora React Native UI KIT

Agora React Native UI KIT

  • Docs
  • API Reference
  • GitHub

›Classes

Introduction

  • Globals
  • Globals

External Modules

  • AgoraView.native
  • RtcEngine.native
  • index
  • types

Classes

  • AgoraView
  • RtcEngine

Enums

  • AgoraViewMode
  • AudioChannelStereo
  • AudioCodecProfile
  • AudioSampleRate
  • VideoCodecProfile

Interfaces

  • AgoraUserInfo
  • AgoraViewProps
  • AudioFrameOption
  • AudioMixingOption
  • AudioRecordingOption
  • BackgroundImage
  • BeautyOption
  • CameraCapturerConfiguration
  • ChannelMediaConfiguration
  • ChannelMediaInfo
  • Color
  • DataStreamOption
  • DefaultVideoStreamOption
  • ImageOption
  • InjectStreamOption
  • LastmileProbeConfig
  • LiveTranscodingOption
  • MixedAudioFrameOption
  • Option
  • PlayEffectOption
  • PositionOption
  • PublishStreamOption
  • PublisherConfig
  • RemoveInjectStreamOption
  • RemovePublishStreamOption
  • Size
  • TranscodingUser
  • VideoEncoderConfig
  • VideoOption
  • VideoStreamOption
  • VoiceDecorator

AgoraView

rn-agora-docs › "AgoraView.native" › AgoraView

AgoraView is the render layer for rendering video stream

This class is used to rendering native sdk stream

props AgoraViewProps

descrption AgoraViewProps has four properties.

property mode: AgoraViewMode, this property will setup video render mode. You could see more details

property showLocalVideo: boolean, this property will render local video, NOTICE: IF YOU SET showLocalVideo YOU CANNOT SET remoteUid

property remoteUid: number, this property will render video with remote uid, NOTICE: IF YOU SET remoteUid YOU CANNOT SET showLocalVideo

property zOrderMediaOverlay: boolean, this property will working for android side and it likes zIndex behaviour on web side.

noinheritdoc

Hierarchy

  • any

    ↳ AgoraView

Index

Methods

  • getHTMLProps
  • render

Methods

Private getHTMLProps

▸ getHTMLProps(): AgoraViewProps

Defined in AgoraView.native.tsx:50

getHTMLProps

get agora view props

Returns: AgoraViewProps


render

▸ render(): JSX.Element

Defined in AgoraView.native.tsx:39

render

It would render view for VideoStream

Returns: JSX.Element

← VoiceDecoratorRtcEngine →
  • Hierarchy
  • Index
    • Methods
  • Methods
    • Private getHTMLProps
    • render
Agora React Native UI KIT
Docs
Getting Started (or other categories)Guides (or other categories)API Reference (or other categories)
Community
User ShowcaseStack OverflowProject ChatTwitter
More
BlogGitHubStar