Interface RtcContextInterface

Interface for the RtcContext

Hierarchy

  • RtcContextInterface

Properties

channelJoined client dispatch isScreensharing localAudioTrack localUid localVideoTrack mediaStore toggleScreensharing

Properties

channelJoined

channelJoined: boolean

Is the UIKit in a channel

client

client: IAgoraRTCClient

The client object used by the web SDK

dispatch

dispatch: DispatchType

React dispatch to update values in the reducer

isScreensharing

isScreensharing: boolean

localAudioTrack

localAudioTrack: null | ILocalAudioTrack

The local user's audio track

localUid

localUid: MutableRefObject<undefined | UID>

The local UID returned by the SDK when using local uid as 0.

localVideoTrack

localVideoTrack: null | ILocalVideoTrack

The local user's video track

mediaStore

mediaStore: mediaStore

An object containing a key value store of tracks mapped to users UIDs

toggleScreensharing

toggleScreensharing: (() => Promise<void>)

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc