Search
Preparing search index...
The search index is not available
Edu Store Typescript API Reference for Web
Options
All
Public
Public/Protected
All
Inherited
Menu
Edu Store Typescript API Reference for Web
"agora-rte-sdk/src/core/rtc/adapter/base"
RtcAdapterBase
Class RtcAdapterBase
Hierarchy
AGEventEmitter
RtcAdapterBase
RtcAdapterElectron
RtcAdapterWeb
Index
Constructors
constructor
Methods
add
Audio
Raw
Data
Observer
add
Camera
Processors
add
Microphone
Processors
add
Preview
Camera
Processors
add
Preview
Microphone
Processors
adjust
Loopback
Signal
Volume
create
Rtc
Channel
destroy
emit
enable
Local
Audio
enable
Local
Video
enable
Loopback
Recording
enable
Preview
Local
Audio
enable
Preview
Local
Video
get
Audio
Device
Manager
get
Current
Frame
Data
get
Diaplay
Devices
get
Video
Device
Manager
get
Window
Devices
has
Screen
Share
Permission
is
Screen
Device
Enumerate
Supported
off
on
on
Autoplay
Failed
on
Local
Audio
Playback
Test
Volume
Changed
on
Local
Audio
Track
State
Changed
on
Local
Audio
Volume
on
Local
Loopback
Device
State
Changed
on
Local
Screen
Share
Track
State
Changed
on
Local
Video
Track
State
Changed
once
remove
All
Event
Listeners
remove
Audio
Raw
Data
Observer
remove
Camera
Processors
remove
Microphone
Processors
remove
Preview
Camera
Processors
remove
Preview
Microphone
Processors
set
Audio
Playback
Device
set
Audio
Raw
Data
Config
set
Audio
Recording
Device
set
Beauty
Effect
Options
set
Video
Camera
Device
setup
Local
Video
setup
Preview
Local
Video
setup
Remote
Video
start
Audio
Playback
Device
Test
start
Audio
Recording
Device
Test
start
Screen
Capture
stop
Audio
Playback
Device
Test
stop
Audio
Recording
Device
Test
stop
Screen
Capture
take
Snapshot
get
Rtc
Version
Constructors
constructor
new
Rtc
Adapter
Base
(
)
:
RtcAdapterBase
Returns
RtcAdapterBase
Methods
Abstract
add
Audio
Raw
Data
Observer
add
Audio
Raw
Data
Observer
(
observer
:
AgoraRteAudioRawDataObserver
, position
:
AgoraRteAudioRawDataPosition
)
:
number
Parameters
observer:
AgoraRteAudioRawDataObserver
position:
AgoraRteAudioRawDataPosition
Returns
number
Abstract
add
Camera
Processors
add
Camera
Processors
(
processor
:
IBaseProcessor
[]
)
:
number
Parameters
processor:
IBaseProcessor
[]
Returns
number
Abstract
add
Microphone
Processors
add
Microphone
Processors
(
processor
:
IBaseProcessor
[]
)
:
number
Parameters
processor:
IBaseProcessor
[]
Returns
number
Abstract
add
Preview
Camera
Processors
add
Preview
Camera
Processors
(
processor
:
IBaseProcessor
[]
)
:
number
Parameters
processor:
IBaseProcessor
[]
Returns
number
Abstract
add
Preview
Microphone
Processors
add
Preview
Microphone
Processors
(
processor
:
IBaseProcessor
[]
)
:
number
Parameters
processor:
IBaseProcessor
[]
Returns
number
Abstract
adjust
Loopback
Signal
Volume
adjust
Loopback
Signal
Volume
(
volume
:
number
, connType
?:
AGRtcConnectionType
)
:
number
Parameters
volume:
number
Optional
connType:
AGRtcConnectionType
Returns
number
Abstract
create
Rtc
Channel
create
Rtc
Channel
(
channelName
:
string
, base
:
RtcAdapterBase
)
:
RtcChannelAdapterBase
Parameters
channelName:
string
base:
RtcAdapterBase
Returns
RtcChannelAdapterBase
Abstract
destroy
destroy
(
)
:
number
Returns
number
emit
emit
(
evt
:
string
,
...
args
:
any
[]
)
:
RtcAdapterBase
Parameters
evt:
string
Rest
...
args:
any
[]
Returns
RtcAdapterBase
Abstract
enable
Local
Audio
enable
Local
Audio
(
enable
:
boolean
)
:
number
Parameters
enable:
boolean
Returns
number
Abstract
enable
Local
Video
enable
Local
Video
(
enable
:
boolean
)
:
number
Parameters
enable:
boolean
Returns
number
Abstract
enable
Loopback
Recording
enable
Loopback
Recording
(
enable
:
boolean
, device
?:
string
, connType
?:
AGRtcConnectionType
)
:
number
Parameters
enable:
boolean
Optional
device:
string
Optional
connType:
AGRtcConnectionType
Returns
number
Abstract
enable
Preview
Local
Audio
enable
Preview
Local
Audio
(
enable
:
boolean
)
:
number
Parameters
enable:
boolean
Returns
number
Abstract
enable
Preview
Local
Video
enable
Preview
Local
Video
(
enable
:
boolean
)
:
number
Parameters
enable:
boolean
Returns
number
Abstract
get
Audio
Device
Manager
get
Audio
Device
Manager
(
)
:
RtcAudioDeviceManagerBase
Returns
RtcAudioDeviceManagerBase
Abstract
get
Current
Frame
Data
get
Current
Frame
Data
(
channelName
:
string
, streamUuid
:
string
, isLocal
:
boolean
)
:
ImageData
Parameters
channelName:
string
streamUuid:
string
isLocal:
boolean
Returns
ImageData
Abstract
get
Diaplay
Devices
get
Diaplay
Devices
(
)
:
Promise
<
AGScreenShareDevice
[]
>
Returns
Promise
<
AGScreenShareDevice
[]
>
Abstract
get
Video
Device
Manager
get
Video
Device
Manager
(
)
:
RtcVideoDeviceManagerBase
Returns
RtcVideoDeviceManagerBase
Abstract
get
Window
Devices
get
Window
Devices
(
)
:
Promise
<
AGScreenShareDevice
[]
>
Returns
Promise
<
AGScreenShareDevice
[]
>
Abstract
has
Screen
Share
Permission
has
Screen
Share
Permission
(
)
:
boolean
Returns
boolean
Abstract
is
Screen
Device
Enumerate
Supported
is
Screen
Device
Enumerate
Supported
(
)
:
boolean
Returns
boolean
off
off
(
evt
:
string
, cb
:
CallableFunction
)
:
RtcAdapterBase
Parameters
evt:
string
cb:
CallableFunction
Returns
RtcAdapterBase
on
on
(
evt
:
string
, cb
:
CallableFunction
)
:
RtcAdapterBase
Parameters
evt:
string
cb:
CallableFunction
Returns
RtcAdapterBase
Abstract
on
Autoplay
Failed
on
Autoplay
Failed
(
cb
:
(
)
=>
void
)
:
number
Parameters
cb:
(
)
=>
void
(
)
:
void
Returns
void
Returns
number
Abstract
on
Local
Audio
Playback
Test
Volume
Changed
on
Local
Audio
Playback
Test
Volume
Changed
(
cb
:
LocalAudioPlaybackVolumeIndicatorEvent
)
:
number
Parameters
cb:
LocalAudioPlaybackVolumeIndicatorEvent
Returns
number
Abstract
on
Local
Audio
Track
State
Changed
on
Local
Audio
Track
State
Changed
(
cb
:
LocalAudioTrackStateEvent
)
:
number
Parameters
cb:
LocalAudioTrackStateEvent
Returns
number
Abstract
on
Local
Audio
Volume
on
Local
Audio
Volume
(
cb
:
(
volume
:
number
)
=>
void
)
:
number
Parameters
cb:
(
volume
:
number
)
=>
void
(
volume
:
number
)
:
void
Parameters
volume:
number
Returns
void
Returns
number
Abstract
on
Local
Loopback
Device
State
Changed
on
Local
Loopback
Device
State
Changed
(
cb
:
LocalLoopbackDeviceStateEvent
)
:
number
Parameters
cb:
LocalLoopbackDeviceStateEvent
Returns
number
Abstract
on
Local
Screen
Share
Track
State
Changed
on
Local
Screen
Share
Track
State
Changed
(
cb
:
LocalVideoTrackStateEvent
)
:
number
Parameters
cb:
LocalVideoTrackStateEvent
Returns
number
Abstract
on
Local
Video
Track
State
Changed
on
Local
Video
Track
State
Changed
(
cb
:
LocalVideoTrackStateEvent
)
:
number
Parameters
cb:
LocalVideoTrackStateEvent
Returns
number
once
once
(
evt
:
string
, cb
:
CallableFunction
)
:
RtcAdapterBase
Parameters
evt:
string
cb:
CallableFunction
Returns
RtcAdapterBase
remove
All
Event
Listeners
remove
All
Event
Listeners
(
)
:
void
Returns
void
Abstract
remove
Audio
Raw
Data
Observer
remove
Audio
Raw
Data
Observer
(
observer
:
AgoraRteAudioRawDataObserver
, position
:
AgoraRteAudioRawDataPosition
)
:
number
Parameters
observer:
AgoraRteAudioRawDataObserver
position:
AgoraRteAudioRawDataPosition
Returns
number
Abstract
remove
Camera
Processors
remove
Camera
Processors
(
)
:
number
Returns
number
Abstract
remove
Microphone
Processors
remove
Microphone
Processors
(
)
:
number
Returns
number
Abstract
remove
Preview
Camera
Processors
remove
Preview
Camera
Processors
(
)
:
number
Returns
number
Abstract
remove
Preview
Microphone
Processors
remove
Preview
Microphone
Processors
(
)
:
number
Returns
number
Abstract
set
Audio
Playback
Device
set
Audio
Playback
Device
(
deviceId
:
string
)
:
number
Parameters
deviceId:
string
Returns
number
Abstract
set
Audio
Raw
Data
Config
set
Audio
Raw
Data
Config
(
config
:
AgoraRteAudioRawDataConfig
, position
:
AgoraRteAudioRawDataPosition
)
:
number
Parameters
config:
AgoraRteAudioRawDataConfig
position:
AgoraRteAudioRawDataPosition
Returns
number
Abstract
set
Audio
Recording
Device
set
Audio
Recording
Device
(
deviceId
:
string
)
:
number
Parameters
deviceId:
string
Returns
number
Abstract
set
Beauty
Effect
Options
set
Beauty
Effect
Options
(
enable
:
boolean
, options
:
AGBeautyEffect
)
:
number
Parameters
enable:
boolean
options:
AGBeautyEffect
Returns
number
Abstract
set
Video
Camera
Device
set
Video
Camera
Device
(
deviceId
:
string
)
:
number
Parameters
deviceId:
string
Returns
number
Abstract
setup
Local
Video
setup
Local
Video
(
canvas
:
AgoraRtcVideoCanvas
, videoSourceType
:
AgoraRteVideoSourceType
)
:
number
Parameters
canvas:
AgoraRtcVideoCanvas
videoSourceType:
AgoraRteVideoSourceType
Returns
number
Abstract
setup
Preview
Local
Video
setup
Preview
Local
Video
(
canvas
:
AgoraRtcVideoCanvas
)
:
number
Parameters
canvas:
AgoraRtcVideoCanvas
Returns
number
Abstract
setup
Remote
Video
setup
Remote
Video
(
canvas
:
AgoraRtcVideoCanvas
)
:
number
Parameters
canvas:
AgoraRtcVideoCanvas
Returns
number
Abstract
start
Audio
Playback
Device
Test
start
Audio
Playback
Device
Test
(
url
:
string
)
:
number
Parameters
url:
string
Returns
number
Abstract
start
Audio
Recording
Device
Test
start
Audio
Recording
Device
Test
(
indicateInterval
:
number
)
:
number
Parameters
indicateInterval:
number
Returns
number
Abstract
start
Screen
Capture
start
Screen
Capture
(
params
?:
{
audioDeviceName
?:
string
;
id
?:
string
;
type
?:
AGScreenShareType
;
withAudio
?:
boolean
}
)
:
number
Parameters
Optional
params:
{
audioDeviceName
?:
string
;
id
?:
string
;
type
?:
AGScreenShareType
;
withAudio
?:
boolean
}
Optional
audio
Device
Name
?:
string
Optional
id
?:
string
Optional
type
?:
AGScreenShareType
Optional
with
Audio
?:
boolean
Returns
number
Abstract
stop
Audio
Playback
Device
Test
stop
Audio
Playback
Device
Test
(
)
:
number
Returns
number
Abstract
stop
Audio
Recording
Device
Test
stop
Audio
Recording
Device
Test
(
)
:
number
Returns
number
Abstract
stop
Screen
Capture
stop
Screen
Capture
(
)
:
number
Returns
number
Abstract
take
Snapshot
take
Snapshot
(
channelName
:
string
, streamUuid
:
number
, filePath
:
string
)
:
Promise
<
void
|
AGSnapshotInfo
>
Parameters
channelName:
string
streamUuid:
number
filePath:
string
Returns
Promise
<
void
|
AGSnapshotInfo
>
Static
get
Rtc
Version
get
Rtc
Version
(
)
:
string
Returns
string
Exports
"agora-
edu-
core/src/configs/index"
"agora-
edu-
core/src/event-
center"
"agora-
edu-
core/src/index"
"agora-
edu-
core/src/log-
reporter"
"agora-
edu-
core/src/services/api"
"agora-
edu-
core/src/services/error"
"agora-
edu-
core/src/services/report-
v2"
"agora-
edu-
core/src/stores/domain/common/base"
"agora-
edu-
core/src/stores/domain/common/cloud-
drive/index"
"agora-
edu-
core/src/stores/domain/common/cloud-
drive/struct"
"agora-
edu-
core/src/stores/domain/common/cloud-
drive/type"
"agora-
edu-
core/src/stores/domain/common/cloud-
drive/utils"
"agora-
edu-
core/src/stores/domain/common/connection"
"agora-
edu-
core/src/stores/domain/common/group/index"
"agora-
edu-
core/src/stores/domain/common/group/type"
"agora-
edu-
core/src/stores/domain/common/hand-
up/index"
"agora-
edu-
core/src/stores/domain/common/hand-
up/type"
"agora-
edu-
core/src/stores/domain/common/index"
"agora-
edu-
core/src/stores/domain/common/media/index"
"agora-
edu-
core/src/stores/domain/common/media/type"
"agora-
edu-
core/src/stores/domain/common/message/index"
"agora-
edu-
core/src/stores/domain/common/message/struct"
"agora-
edu-
core/src/stores/domain/common/message/type"
"agora-
edu-
core/src/stores/domain/common/recording/index"
"agora-
edu-
core/src/stores/domain/common/recording/type"
"agora-
edu-
core/src/stores/domain/common/report/index"
"agora-
edu-
core/src/stores/domain/common/room/command-
handler"
"agora-
edu-
core/src/stores/domain/common/room/index"
"agora-
edu-
core/src/stores/domain/common/room/type"
"agora-
edu-
core/src/stores/domain/common/statistics/index"
"agora-
edu-
core/src/stores/domain/common/stream/index"
"agora-
edu-
core/src/stores/domain/common/stream/struct"
"agora-
edu-
core/src/stores/domain/common/user/index"
"agora-
edu-
core/src/stores/domain/common/user/struct"
"agora-
edu-
core/src/stores/domain/common/user/type"
"agora-
edu-
core/src/stores/domain/common/widget/controller"
"agora-
edu-
core/src/stores/domain/common/widget/helper"
"agora-
edu-
core/src/stores/domain/common/widget/index"
"agora-
edu-
core/src/stores/domain/common/widget/struct"
"agora-
edu-
core/src/stores/domain/common/widget/type"
"agora-
edu-
core/src/stores/domain/index"
"agora-
edu-
core/src/stores/domain/interactive/index"
"agora-
edu-
core/src/stores/domain/lecture/index"
"agora-
edu-
core/src/stores/domain/one-
on-
one/index"
"agora-
edu-
core/src/stores/index"
"agora-
edu-
core/src/type"
"agora-
edu-
core/src/utils/batch"
"agora-
edu-
core/src/utils/collection"
"agora-
edu-
core/src/utils/error"
"agora-
edu-
core/src/utils/index"
"agora-
rte-
sdk/src/configs/index"
"agora-
rte-
sdk/src/core/decorator/bound/index"
"agora-
rte-
sdk/src/core/decorator/index"
"agora-
rte-
sdk/src/core/decorator/lodash/index"
"agora-
rte-
sdk/src/core/decorator/log/handler"
"agora-
rte-
sdk/src/core/decorator/log/index"
"agora-
rte-
sdk/src/core/decorator/log/log-
serializer"
"agora-
rte-
sdk/src/core/decorator/log/logger"
"agora-
rte-
sdk/src/core/decorator/proxy"
"agora-
rte-
sdk/src/core/decorator/type"
"agora-
rte-
sdk/src/core/engine/index"
"agora-
rte-
sdk/src/core/log-
upload/handler"
"agora-
rte-
sdk/src/core/log-
upload/scheduler"
"agora-
rte-
sdk/src/core/log-
upload/type"
"agora-
rte-
sdk/src/core/logger/constants"
"agora-
rte-
sdk/src/core/logger/hijack"
"agora-
rte-
sdk/src/core/logger/index"
"agora-
rte-
sdk/src/core/logger/logger-
impl"
"agora-
rte-
sdk/src/core/logger/manager-
impl"
"agora-
rte-
sdk/src/core/logger/type"
"agora-
rte-
sdk/src/core/media-
player/index"
"agora-
rte-
sdk/src/core/media-
player/stream-
media-
player"
"agora-
rte-
sdk/src/core/media-
player/type"
"agora-
rte-
sdk/src/core/media/control"
"agora-
rte-
sdk/src/core/media/loopback"
"agora-
rte-
sdk/src/core/media/player"
"agora-
rte-
sdk/src/core/media/track"
"agora-
rte-
sdk/src/core/media/type"
"agora-
rte-
sdk/src/core/processor/message-
handler"
"agora-
rte-
sdk/src/core/processor/sequence-
msg/data"
"agora-
rte-
sdk/src/core/processor/sequence-
msg/message-
parser"
"agora-
rte-
sdk/src/core/processor/sequence-
msg/synchronizer"
"agora-
rte-
sdk/src/core/processor/struct"
"agora-
rte-
sdk/src/core/processor/type"
"agora-
rte-
sdk/src/core/rtc/adapter/base"
"agora-
rte-
sdk/src/core/rtc/adapter/electron/device"
"agora-
rte-
sdk/src/core/rtc/adapter/electron/index"
"agora-
rte-
sdk/src/core/rtc/adapter/electron/stats"
"agora-
rte-
sdk/src/core/rtc/adapter/electron/thread"
"agora-
rte-
sdk/src/core/rtc/adapter/index"
"agora-
rte-
sdk/src/core/rtc/adapter/web/client"
"agora-
rte-
sdk/src/core/rtc/adapter/web/device"
"agora-
rte-
sdk/src/core/rtc/adapter/web/dispatcher"
"agora-
rte-
sdk/src/core/rtc/adapter/web/index"
"agora-
rte-
sdk/src/core/rtc/adapter/web/player"
"agora-
rte-
sdk/src/core/rtc/adapter/web/stats"
"agora-
rte-
sdk/src/core/rtc/adapter/web/thread"
"agora-
rte-
sdk/src/core/rtc/canvas"
"agora-
rte-
sdk/src/core/rtc/channel"
"agora-
rte-
sdk/src/core/rtc/index"
"agora-
rte-
sdk/src/core/rtc/type"
"agora-
rte-
sdk/src/core/rtm/index"
"agora-
rte-
sdk/src/core/rtm/type"
"agora-
rte-
sdk/src/core/schedule/index"
"agora-
rte-
sdk/src/core/schedule/scheduler"
"agora-
rte-
sdk/src/core/schedule/task"
"agora-
rte-
sdk/src/core/services/api"
"agora-
rte-
sdk/src/core/services/base"
"agora-
rte-
sdk/src/core/services/domain-
region-
map"
"agora-
rte-
sdk/src/core/services/fallback-
request-
handler"
"agora-
rte-
sdk/src/core/services/report"
"agora-
rte-
sdk/src/core/upload/index"
"agora-
rte-
sdk/src/core/upload/scheduler"
"agora-
rte-
sdk/src/core/upload/type"
"agora-
rte-
sdk/src/core/utils/electron-
log-
file"
"agora-
rte-
sdk/src/core/utils/error"
"agora-
rte-
sdk/src/core/utils/events"
"agora-
rte-
sdk/src/core/utils/file-
reader"
"agora-
rte-
sdk/src/core/utils/http-
client"
"agora-
rte-
sdk/src/core/utils/interceptor"
"agora-
rte-
sdk/src/core/utils/networkutils"
"agora-
rte-
sdk/src/core/utils/race-
condition"
"agora-
rte-
sdk/src/core/utils/thread"
"agora-
rte-
sdk/src/core/utils/types"
"agora-
rte-
sdk/src/core/utils/utils"
"agora-
rte-
sdk/src/core/worker/constants"
"agora-
rte-
sdk/src/core/worker/handler/binary"
"agora-
rte-
sdk/src/core/worker/handler/db"
"agora-
rte-
sdk/src/core/worker/handler/log"
"agora-
rte-
sdk/src/core/worker/handler/reply"
"agora-
rte-
sdk/src/core/worker/index"
"agora-
rte-
sdk/src/core/worker/interactor"
"agora-
rte-
sdk/src/core/worker/mutex"
"agora-
rte-
sdk/src/core/worker/type"
"agora-
rte-
sdk/src/core/worker/worker-
entry"
"agora-
rte-
sdk/src/core/worker/worker-
factory"
"agora-
rte-
sdk/src/core/worker/worker-
installer"
"agora-
rte-
sdk/src/index"
"agora-
rte-
sdk/src/scene/index"
"agora-
rte-
sdk/src/scene/state-
sync"
"agora-
rte-
sdk/src/type"
"agora-
rte-
sdk/src/user/index"
Rtc
Adapter
Base
constructor
add
Audio
Raw
Data
Observer
add
Camera
Processors
add
Microphone
Processors
add
Preview
Camera
Processors
add
Preview
Microphone
Processors
adjust
Loopback
Signal
Volume
create
Rtc
Channel
destroy
emit
enable
Local
Audio
enable
Local
Video
enable
Loopback
Recording
enable
Preview
Local
Audio
enable
Preview
Local
Video
get
Audio
Device
Manager
get
Current
Frame
Data
get
Diaplay
Devices
get
Video
Device
Manager
get
Window
Devices
has
Screen
Share
Permission
is
Screen
Device
Enumerate
Supported
off
on
on
Autoplay
Failed
on
Local
Audio
Playback
Test
Volume
Changed
on
Local
Audio
Track
State
Changed
on
Local
Audio
Volume
on
Local
Loopback
Device
State
Changed
on
Local
Screen
Share
Track
State
Changed
on
Local
Video
Track
State
Changed
once
remove
All
Event
Listeners
remove
Audio
Raw
Data
Observer
remove
Camera
Processors
remove
Microphone
Processors
remove
Preview
Camera
Processors
remove
Preview
Microphone
Processors
set
Audio
Playback
Device
set
Audio
Raw
Data
Config
set
Audio
Recording
Device
set
Beauty
Effect
Options
set
Video
Camera
Device
setup
Local
Video
setup
Preview
Local
Video
setup
Remote
Video
start
Audio
Playback
Device
Test
start
Audio
Recording
Device
Test
start
Screen
Capture
stop
Audio
Playback
Device
Test
stop
Audio
Recording
Device
Test
stop
Screen
Capture
take
Snapshot
get
Rtc
Version