Preparing search index...
The search index is not available
agora-react-uikit
agora-react-uikit
<internal>
ClientRole
Type alias ClientRole
Client
Role
:
"audience"
|
"host"
The user role in a live broadcast channel.
"host"
: Host. A host can both publish tracks and subscribe to tracks.
"audience"
: Audience. An audience can only subscribe to tracks.
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
Modules
agora-
react-
uikit
<internal>
Audience
Latency
Level
Type
Channel
Media
Relay
Error
Channel
Media
Relay
Event
Channel
Media
Relay
State
Connection
Change
Reason
Connection
Disconnected
Reason
Connection
State
Inject
Stream
Event
Status
Inject
Stream
Event
Status
Local
Invitation
Failure
Reason
Local
Invitation
State
Peer
Online
State
Remote
Invitation
Failure
Reason
Remote
Invitation
State
Remote
Stream
Fallback
Type
Remote
Stream
Type
client
Role
Raw
remote
Track
State
ONLINE_
STATUS
Component
Local
Invitation
Remote
Invitation
Rtm
Channel
Rtm
Client
Abort
Signal
Abort
Signal
Event
Map
Add
Event
Listener
Options
AgoraRTCStats
Array
Buffer
View
Attributes
Map
Audio
Buffer
Audio
Buffer
Options
Beauty
Effect
Options
Blob
Blob
Property
Bag
Btn
Template
Interface
CSSProperties
Call
Site
Channel
Attribute
Options
Channel
Attribute
Properties
Channel
Attributes
Channel
Media
Relay
Info
Channel
Member
Count
Result
Client
Role
Options
Component
Lifecycle
Constrain
Boolean
Parameters
ConstrainDOMString
Parameters
Constrain
Double
Range
ConstrainULong
Range
Consumer
Props
Context
Deprecated
Lifecycle
Double
Range
Element
Error
Info
Event
Custom
Report
Params
Event
Listener
Event
Listener
Object
Event
Listener
Options
Exotic
Component
Function
Component
IAgoraRTCClient
IAgoraRTCRemote
User
ICamera
Video
Track
IChannel
Media
Relay
Configuration
ILocal
Audio
Track
ILocal
Track
ILocal
Video
Track
IMicrophone
Audio
Track
IRemote
Audio
Track
IRemote
Track
IRemote
Video
Track
ITrack
Icons
Interface
Image
Data
Image
Data
Settings
Inject
Stream
Config
Iterable
Iterator
Iterator
Return
Result
Iterator
Yield
Result
Live
Streaming
Transcoding
Config
Live
Streaming
Transcoding
Image
Live
Streaming
Transcoding
User
Local
Audio
Track
Stats
Local
Invitation
Events
LocalUIKit
User
Local
User
Context
Interface
Local
Video
Track
Stats
Low
Stream
Parameter
Media
Operation
Progress
Media
Stream
Track
Media
Stream
Track
Event
Map
Media
Track
Capabilities
Media
Track
Constraint
Set
Media
Track
Constraints
Media
Track
Settings
Media
Transfer
Handler
Mutable
Ref
Object
Network
Quality
New
Lifecycle
Object
Obsolete
Properties
Peer
Message
Send
Result
Peers
Online
Status
Map
Peers
Online
Status
Result
Promise
Like
Properties
Provider
Exotic
Component
Provider
Props
Queuing
Strategy
Queuing
Strategy
Size
React
Element
React
Portal
Readable
Byte
Stream
Controller
Readable
Stream
Readable
StreamBYOBReader
Readable
StreamBYOBRequest
Readable
Stream
Default
Controller
Readable
Stream
Default
Reader
Readable
Stream
Generic
Reader
Readable
Stream
Get
Reader
Options
Readable
Stream
Read
Done
Result
Readable
Stream
Read
Value
Result
Readable
Writable
Pair
Received
Message
Properties
Remote
Audio
Track
Stats
Remote
Invitation
Events
RemoteUIKit
User
Remote
Video
Track
Stats
Rtc
Context
Interface
Rtc
Events
Interface
Rtm
Channel
Events
Rtm
Client
Events
Rtm
Config
Rtm
File
Message
Rtm
Image
Message
Rtm
Raw
Message
Rtm
Text
Message
Send
Message
Options
Standard
Longhand
Properties
Standard
Properties
Standard
Shorthand
Properties
Stream
Pipe
Options
Svg
Properties
Tracks
Context
Interface
UIKit
Events
Interface
ULong
Range
Underlying
Byte
Source
Underlying
Default
Source
Underlying
Sink
Underlying
Sink
Abort
Callback
Underlying
Sink
Close
Callback
Underlying
Sink
Start
Callback
Underlying
Sink
Write
Callback
Underlying
Source
Underlying
Source
Cancel
Callback
Underlying
Source
Pull
Callback
Underlying
Source
Start
Callback
Validator
Vendor
Longhand
Properties
Vendor
Properties
Vendor
Shorthand
Properties
Video
Encoder
Configuration
Video
Player
Config
Visible
Hidden
Result
Visible
Result
Inner
Writable
Stream
Writable
Stream
Default
Controller
Writable
Stream
Default
Writer
local
Btn
Styles
Interface
local
Media
media
remote
Btn
Styles
Interface
rtm
Context
Absolute
Size
Accent
Color
Align
Content
Align
Items
Align
Self
Align
Tracks
Alignment
Baseline
Animateable
Feature
Animation
Animation
Delay
Animation
Direction
Animation
Duration
Animation
Fill
Mode
Animation
Iteration
Count
Animation
Name
Animation
Play
State
Animation
Timing
Function
Appearance
Array
Buffer
Like
Aspect
Ratio
Attachment
Azimuth
Backdrop
Filter
Backface
Visibility
Background
Background
Attachment
Background
Blend
Mode
Background
Clip
Background
Color
Background
Image
Background
Origin
Background
Position
Background
PositionX
Background
PositionY
Background
Repeat
Background
Size
Baseline
Shift
Bg
Position
Bg
Size
Blend
Mode
Blob
Part
Block
Overflow
Block
Size
Border
Border
Block
Border
Block
Color
Border
Block
End
Border
Block
End
Color
Border
Block
End
Style
Border
Block
End
Width
Border
Block
Start
Border
Block
Start
Color
Border
Block
Start
Style
Border
Block
Start
Width
Border
Block
Style
Border
Block
Width
Border
Bottom
Border
Bottom
Color
Border
Bottom
Left
Radius
Border
Bottom
Right
Radius
Border
Bottom
Style
Border
Bottom
Width
Border
Collapse
Border
Color
Border
End
End
Radius
Border
End
Start
Radius
Border
Image
Border
Image
Outset
Border
Image
Repeat
Border
Image
Slice
Border
Image
Source
Border
Image
Width
Border
Inline
Border
Inline
Color
Border
Inline
End
Border
Inline
End
Color
Border
Inline
End
Style
Border
Inline
End
Width
Border
Inline
Start
Border
Inline
Start
Color
Border
Inline
Start
Style
Border
Inline
Start
Width
Border
Inline
Style
Border
Inline
Width
Border
Left
Border
Left
Color
Border
Left
Style
Border
Left
Width
Border
Radius
Border
Right
Border
Right
Color
Border
Right
Style
Border
Right
Width
Border
Spacing
Border
Start
End
Radius
Border
Start
Start
Radius
Border
Style
Border
Top
Border
Top
Color
Border
Top
Left
Radius
Border
Top
Right
Radius
Border
Top
Style
Border
Top
Width
Border
Width
Bottom
Box
Box
Align
Box
Decoration
Break
Box
Direction
Box
Flex
Box
Flex
Group
Box
Lines
Box
Ordinal
Group
Box
Orient
Box
Pack
Box
Shadow
Box
Sizing
Break
After
Break
Before
Break
Inside
Buffer
Source
Caption
Side
Caret
Color
Check
Visible
Result
Clear
Client
Role
Clip
Clip
Path
Clip
Rule
Color
Color
Color
Adjust
Color
Interpolation
Color
Rendering
Color
Scheme
Column
Count
Column
Fill
Column
Gap
Column
Rule
Column
Rule
Color
Column
Rule
Style
Column
Rule
Width
Column
Span
Column
Width
Columns
Compat
Auto
Composite
Style
Compositing
Operator
Connection
State
Constrain
Boolean
ConstrainDOMString
Constrain
Double
ConstrainULong
Consumer
Contain
Content
Content
Distribution
Content
List
Content
Position
Content
Visibility
Counter
Increment
Counter
Reset
Counter
Set
Cubic
Bezier
Timing
Function
Cursor
Dasharray
Deprecated
System
Color
Direction
Dispatch
Dispatch
Type
Display
Display
Inside
Display
Internal
Display
Legacy
Display
Outside
Dominant
Baseline
Easing
Function
East
Asian
Variant
Values
Empty
Cells
Encryption
Mode
Ending
Type
Event
Listener
Or
Event
Listener
Object
Fill
Fill
Opacity
Fill
Rule
Filter
Final
Bg
Layer
Flex
Flex
Basis
Flex
Direction
Flex
Flow
Flex
Grow
Flex
Shrink
Flex
Wrap
Float
Flood
Color
Flood
Opacity
Font
Font
Family
Font
Feature
Settings
Font
Kerning
Font
Language
Override
Font
Optical
Sizing
Font
Size
Font
Size
Adjust
Font
Smooth
Font
Stretch
Font
Stretch
Absolute
Font
Style
Font
Synthesis
Font
Variant
Font
Variant
Alternates
Font
Variant
Caps
Font
Variant
East
Asian
Font
Variant
Ligatures
Font
Variant
Numeric
Font
Variant
Position
Font
Variation
Settings
Font
Weight
Font
Weight
Absolute
Forced
Color
Adjust
Gap
Generic
Family
Geometry
Box
Globals
Glyph
Orientation
Vertical
Grid
Grid
Area
Grid
Auto
Columns
Grid
Auto
Flow
Grid
Auto
Rows
Grid
Column
Grid
Column
End
Grid
Column
Gap
Grid
Column
Start
Grid
Gap
Grid
Line
Grid
Row
Grid
Row
End
Grid
Row
Gap
Grid
Row
Start
Grid
Template
Grid
Template
Areas
Grid
Template
Columns
Grid
Template
Rows
Hanging
Punctuation
Height
Hyphens
Image
Orientation
Image
Rendering
Image
Resolution
Ime
Mode
Initial
Letter
Inline
Size
Inset
Inset
Block
Inset
Block
End
Inset
Block
Start
Inset
Inline
Inset
Inline
End
Inset
Inline
Start
Isolation
Iterator
Result
JSXElement
Constructor
Justify
Content
Justify
Items
Justify
Self
Justify
Tracks
Key
Left
Letter
Spacing
Lighting
Color
Line
Break
Line
Clamp
Line
Height
Line
Height
Step
Line
Style
Line
Width
List
Style
List
Style
Image
List
Style
Position
List
Style
Type
Margin
Margin
Block
Margin
Block
End
Margin
Block
Start
Margin
Bottom
Margin
Inline
Margin
Inline
End
Margin
Inline
Start
Margin
Left
Margin
Right
Margin
Top
Marker
Marker
End
Marker
Mid
Marker
Start
Mask
Mask
Border
Mask
Border
Mode
Mask
Border
Outset
Mask
Border
Repeat
Mask
Border
Slice
Mask
Border
Source
Mask
Border
Width
Mask
Clip
Mask
Composite
Mask
Image
Mask
Layer
Mask
Mode
Mask
Origin
Mask
Position
Mask
Repeat
Mask
Size
Mask
Type
Masking
Mode
Math
Style
Max
Block
Size
Max
Height
Max
Inline
Size
Max
Lines
Max
Width
Media
Stream
Track
State
Min
Block
Size
Min
Height
Min
Inline
Size
Min
Width
Mix
Blend
Mode
Moz
Appearance
Moz
Binding
Moz
Border
Bottom
Colors
Moz
Border
Left
Colors
Moz
Border
Right
Colors
Moz
Border
Top
Colors
Moz
Context
Properties
Moz
Float
Edge
Moz
Force
Broken
Image
Icon
Moz
Image
Region
Moz
Orient
Moz
Outline
Radius
Moz
Outline
Radius
Bottomleft
Moz
Outline
Radius
Bottomright
Moz
Outline
Radius
Topleft
Moz
Outline
Radius
Topright
Moz
Stack
Sizing
Moz
Text
Blink
Moz
User
Focus
Moz
User
Input
Moz
User
Modify
Moz
Window
Dragging
Moz
Window
Shadow
Ms
Accelerator
Ms
Block
Progression
Ms
Content
Zoom
Chaining
Ms
Content
Zoom
Limit
Ms
Content
Zoom
Limit
Max
Ms
Content
Zoom
Limit
Min
Ms
Content
Zoom
Snap
Ms
Content
Zoom
Snap
Points
Ms
Content
Zoom
Snap
Type
Ms
Content
Zooming
Ms
Filter
Ms
Flow
From
Ms
Flow
Into
Ms
Grid
Columns
Ms
Grid
Rows
Ms
High
Contrast
Adjust
Ms
Hyphenate
Limit
Chars
Ms
Hyphenate
Limit
Lines
Ms
Hyphenate
Limit
Zone
Ms
Ime
Align
Ms
Overflow
Style
Ms
Scroll
Chaining
Ms
Scroll
Limit
Ms
Scroll
LimitXMax
Ms
Scroll
LimitXMin
Ms
Scroll
LimitYMax
Ms
Scroll
LimitYMin
Ms
Scroll
Rails
Ms
Scroll
Snap
PointsX
Ms
Scroll
Snap
PointsY
Ms
Scroll
Snap
Type
Ms
Scroll
SnapX
Ms
Scroll
SnapY
Ms
Scroll
Translation
Ms
Scrollbar3dlight
Color
Ms
Scrollbar
Arrow
Color
Ms
Scrollbar
Base
Color
Ms
Scrollbar
Darkshadow
Color
Ms
Scrollbar
Face
Color
Ms
Scrollbar
Highlight
Color
Ms
Scrollbar
Shadow
Color
Ms
Scrollbar
Track
Color
Ms
Text
Autospace
Ms
Touch
Select
Ms
User
Select
Ms
Wrap
Flow
Ms
Wrap
Margin
Ms
Wrap
Through
Named
Color
Object
Fit
Object
Position
Offset
Offset
Anchor
Offset
Distance
Offset
Path
Offset
Rotate
Opacity
Order
Orphans
Outline
Outline
Color
Outline
Offset
Outline
Style
Outline
Width
Overflow
Overflow
Anchor
Overflow
Block
Overflow
Clip
Box
Overflow
Clip
Margin
Overflow
Inline
Overflow
Wrap
OverflowX
OverflowY
Overscroll
Behavior
Overscroll
Behavior
Block
Overscroll
Behavior
Inline
Overscroll
BehaviorX
Overscroll
BehaviorY
Padding
Padding
Block
Padding
Block
End
Padding
Block
Start
Padding
Bottom
Padding
Inline
Padding
Inline
End
Padding
Inline
Start
Padding
Left
Padding
Right
Padding
Top
Page
Break
After
Page
Break
Before
Page
Break
Inside
Paint
Paint
Order
Parameters
Partial
Perspective
Perspective
Origin
Pick
Place
Content
Place
Items
Place
Self
Pointer
Events
Position
Position
Predefined
Color
Space
Property
Key
Props
With
Children
Provider
Quote
Quotes
React
Fragment
React
Instance
React
Node
Readable
Stream
Controller
Readable
Stream
Read
Result
Readable
Stream
Reader
Readonly
Repeat
Style
Resize
Right
Rotate
Row
Gap
Rtm
Message
Ruby
Align
Ruby
Merge
Ruby
Position
Scale
Scroll
Behavior
Scroll
Margin
Scroll
Margin
Block
Scroll
Margin
Block
End
Scroll
Margin
Block
Start
Scroll
Margin
Bottom
Scroll
Margin
Inline
Scroll
Margin
Inline
End
Scroll
Margin
Inline
Start
Scroll
Margin
Left
Scroll
Margin
Right
Scroll
Margin
Top
Scroll
Padding
Scroll
Padding
Block
Scroll
Padding
Block
End
Scroll
Padding
Block
Start
Scroll
Padding
Bottom
Scroll
Padding
Inline
Scroll
Padding
Inline
End
Scroll
Padding
Inline
Start
Scroll
Padding
Left
Scroll
Padding
Right
Scroll
Padding
Top
Scroll
Snap
Align
Scroll
Snap
Coordinate
Scroll
Snap
Destination
Scroll
Snap
PointsX
Scroll
Snap
PointsY
Scroll
Snap
Stop
Scroll
Snap
Type
Scroll
Snap
TypeX
Scroll
Snap
TypeY
Scrollbar
Color
Scrollbar
Gutter
Scrollbar
Width
Self
Position
Set
State
Action
Shape
Image
Threshold
Shape
Margin
Shape
Outside
Shape
Rendering
Single
Animation
Single
Animation
Direction
Single
Animation
Fill
Mode
Single
Transition
Step
Timing
Function
Stop
Color
Stop
Opacity
Stroke
Stroke
Dasharray
Stroke
Dashoffset
Stroke
Linecap
Stroke
Linejoin
Stroke
Miterlimit
Stroke
Opacity
Stroke
Width
Tab
Size
Table
Layout
Text
Align
Text
Align
Last
Text
Anchor
Text
Combine
Upright
Text
Decoration
Text
Decoration
Color
Text
Decoration
Line
Text
Decoration
Skip
Text
Decoration
Skip
Ink
Text
Decoration
Style
Text
Decoration
Thickness
Text
Emphasis
Text
Emphasis
Color
Text
Emphasis
Position
Text
Emphasis
Style
Text
Indent
Text
Justify
Text
Orientation
Text
Overflow
Text
Rendering
Text
Shadow
Text
Size
Adjust
Text
Transform
Text
Underline
Offset
Text
Underline
Position
Top
Touch
Action
Track
Breadth
Transform
Transform
Box
Transform
Origin
Transform
Style
Transition
Transition
Delay
Transition
Duration
Transition
Property
Transition
Timing
Function
Translate
UID
UIKit
User
Unicode
Bidi
User
Select
Validation
Map
Validator
Vector
Effect
Vertical
Align
Visibility
Visual
Box
Weak
Validation
Map
Webkit
Appearance
Webkit
Border
Before
Webkit
Border
Before
Color
Webkit
Border
Before
Style
Webkit
Border
Before
Width
Webkit
Box
Reflect
Webkit
Line
Clamp
Webkit
Mask
Webkit
Mask
Attachment
Webkit
Mask
Clip
Webkit
Mask
Composite
Webkit
Mask
Image
Webkit
Mask
Origin
Webkit
Mask
Position
Webkit
Mask
PositionX
Webkit
Mask
PositionY
Webkit
Mask
Repeat
Webkit
Mask
RepeatX
Webkit
Mask
RepeatY
Webkit
Mask
Size
Webkit
Overflow
Scrolling
Webkit
Tap
Highlight
Color
Webkit
Text
Fill
Color
Webkit
Text
Stroke
Webkit
Text
Stroke
Color
Webkit
Text
Stroke
Width
Webkit
Touch
Callout
Webkit
User
Modify
White
Space
Widows
Width
Will
Change
Word
Break
Word
Spacing
Word
Wrap
Writing
Mode
ZIndex
Zoom
generic
Action
media
Store
role
Abort
Signal
Audio
Buffer
Blob
Image
Data
Media
Stream
Track
Readable
Byte
Stream
Controller
Readable
Stream
Readable
StreamBYOBReader
Readable
StreamBYOBRequest
Readable
Stream
Default
Controller
Readable
Stream
Default
Reader
Writable
Stream
Writable
Stream
Default
Controller
Writable
Stream
Default
Writer
Object
Generated using
TypeDoc
The user role in a live broadcast channel.
"host": Host. A host can both publish tracks and subscribe to tracks."audience": Audience. An audience can only subscribe to tracks.