AgoraViewProps

rn-agora-docs › "types" › AgoraViewProps

An AgoraViewProps object is passed into every AgoraView as props to render video streams.

Hierarchy

• any

  ↳ AgoraViewProps

Indexable

• [ key: string]: any

ListItem Key. Look here for more info.

Index

Properties

• mode
• remoteUid
• showLocalVideo
• zOrderMediaOverlay

Properties

mode

• mode: number

Defined in types.ts:338

• 1: RENDER_MODE_HIDDEN (Uniformly scale the video until it fills the visible boundaries. One dimension of the video may have clipped contents).
• 2: RENDER_MODE_FIT (Uniformly scale the video until one of its dimension fits the boundary. Areas that are not filled due to the disparity in the aspect ratio are filled with black). Look at AgoraViewMode for more info.

---

remoteUid

• remoteUid: number

Defined in types.ts:342

uid of the remote user

---

showLocalVideo

• showLocalVideo: boolean

Defined in types.ts:340

True if the View has to display Local Video. Defaults to false

---

zOrderMediaOverlay

• zOrderMediaOverlay: boolean

Defined in types.ts:344

Set to True to overlay an AgoraView on top of another