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/services/api"
AgoraRteService
Class AgoraRteService
Hierarchy
ApiBase
AgoraRteService
Index
Constructors
constructor
Properties
fallback
Request
Handler
headers
host
logger
path
Prefix
domain
Holder
Methods
delete
Batch
User
Properties
delete
Room
Properties
delete
Stream
delete
User
Properties
entry
Room
fetch
publish
Stream
To
Cdn
send
Custom
Channel
Message
send
Custom
Peer
Message
send
Room
Chat
Message
sync
Peer
Sequence
sync
Sequence
update
Batch
User
Properties
update
Device
State
update
Online
State
update
Room
Properties
update
User
Properties
upsert
Stream
upsert
Stream
Batch
Constructors
constructor
new
Agora
Rte
Service
(
)
:
AgoraRteService
Returns
AgoraRteService
Properties
fallback
Request
Handler
fallback
Request
Handler
:
FallbackRequestHandler
Optional
headers
headers
?:
Record
<
string
,
unknown
>
Optional
host
host
?:
string
logger
logger
:
"agora-rte-sdk/src/core/logger/type"
.
Logger
Optional
path
Prefix
path
Prefix
?:
string
Static
domain
Holder
domain
Holder
:
DomainHolder
Methods
delete
Batch
User
Properties
delete
Batch
User
Properties
(
__namedParameters
:
{
data
:
{
cause
?:
any
;
properties
:
string
[]
;
userUuid
:
string
}
[]
;
roomUuid
:
string
}
)
:
Promise
<
any
>
Parameters
__namedParameters:
{
data
:
{
cause
?:
any
;
properties
:
string
[]
;
userUuid
:
string
}
[]
;
roomUuid
:
string
}
data
:
{
cause
?:
any
;
properties
:
string
[]
;
userUuid
:
string
}
[]
room
Uuid
:
string
Returns
Promise
<
any
>
delete
Room
Properties
delete
Room
Properties
(
__namedParameters
:
{
cause
?:
unknown
;
properties
:
string
[]
;
roomUuid
:
string
}
)
:
Promise
<
any
>
Parameters
__namedParameters:
{
cause
?:
unknown
;
properties
:
string
[]
;
roomUuid
:
string
}
Optional
cause
?:
unknown
properties
:
string
[]
room
Uuid
:
string
Returns
Promise
<
any
>
delete
Stream
delete
Stream
(
roomUuid
:
string
, userUuid
:
string
, streamUuid
:
string
)
:
Promise
<
any
>
Parameters
roomUuid:
string
userUuid:
string
streamUuid:
string
Returns
Promise
<
any
>
delete
User
Properties
delete
User
Properties
(
__namedParameters
:
{
cause
?:
any
;
properties
:
string
[]
;
roomUuid
:
string
;
userUuid
:
string
}
)
:
Promise
<
any
>
Parameters
__namedParameters:
{
cause
?:
any
;
properties
:
string
[]
;
roomUuid
:
string
;
userUuid
:
string
}
Optional
cause
?:
any
properties
:
string
[]
room
Uuid
:
string
user
Uuid
:
string
Returns
Promise
<
any
>
entry
Room
entry
Room
(
params
:
EntryRequestParams
)
:
Promise
<
any
>
Parameters
params:
EntryRequestParams
Returns
Promise
<
any
>
fetch
fetch
(
params
:
AgoraFetchParams
)
:
Promise
<
any
>
Parameters
params:
AgoraFetchParams
Returns
Promise
<
any
>
publish
Stream
To
Cdn
publish
Stream
To
Cdn
(
roomUuid
:
string
, userUuid
:
string
, streamUuid
:
string
, params
:
PublishCdnParams
)
:
Promise
<
any
>
Parameters
roomUuid:
string
userUuid:
string
streamUuid:
string
params:
PublishCdnParams
Returns
Promise
<
any
>
send
Custom
Channel
Message
send
Custom
Channel
Message
(
roomUuid
:
string
, payload
:
{
cmd
:
string
;
data
:
any
}
, sync
?:
boolean
)
:
Promise
<
any
>
Parameters
roomUuid:
string
payload:
{
cmd
:
string
;
data
:
any
}
cmd
:
string
data
:
any
Optional
sync:
boolean
Returns
Promise
<
any
>
send
Custom
Peer
Message
send
Custom
Peer
Message
(
roomUuid
:
string
, payload
:
{
cmd
:
string
;
data
:
any
}
, toUserUuid
:
string
, waitForAck
?:
boolean
)
:
Promise
<
any
>
Parameters
roomUuid:
string
payload:
{
cmd
:
string
;
data
:
any
}
cmd
:
string
data
:
any
toUserUuid:
string
Optional
waitForAck:
boolean
Returns
Promise
<
any
>
send
Room
Chat
Message
send
Room
Chat
Message
(
message
:
string
, roomUuid
:
string
)
:
Promise
<
any
>
Parameters
message:
string
roomUuid:
string
Returns
Promise
<
any
>
sync
Peer
Sequence
sync
Peer
Sequence
(
roomUuid
:
string
, userUuid
:
string
, seqId
:
number
, count
:
number
)
:
Promise
<
any
>
Parameters
roomUuid:
string
userUuid:
string
seqId:
number
count:
number
Returns
Promise
<
any
>
sync
Sequence
sync
Sequence
(
roomUuid
:
string
, seqId
:
number
, count
:
number
)
:
Promise
<
any
>
Parameters
roomUuid:
string
seqId:
number
count:
number
Returns
Promise
<
any
>
update
Batch
User
Properties
update
Batch
User
Properties
(
__namedParameters
:
{
data
:
{
cause
?:
any
;
properties
:
unknown
;
userUuid
:
string
}
[]
;
roomUuid
:
string
}
)
:
Promise
<
any
>
Parameters
__namedParameters:
{
data
:
{
cause
?:
any
;
properties
:
unknown
;
userUuid
:
string
}
[]
;
roomUuid
:
string
}
data
:
{
cause
?:
any
;
properties
:
unknown
;
userUuid
:
string
}
[]
room
Uuid
:
string
Returns
Promise
<
any
>
update
Device
State
update
Device
State
(
roomUuid
:
string
, userUuid
:
string
, streamUuid
:
string
, __namedParameters
:
{
audioSourceState
?:
AgoraRteMediaSourceState
;
videoSourceState
?:
AgoraRteMediaSourceState
}
)
:
Promise
<
any
>
Parameters
roomUuid:
string
userUuid:
string
streamUuid:
string
__namedParameters:
{
audioSourceState
?:
AgoraRteMediaSourceState
;
videoSourceState
?:
AgoraRteMediaSourceState
}
Optional
audio
Source
State
?:
AgoraRteMediaSourceState
Optional
video
Source
State
?:
AgoraRteMediaSourceState
Returns
Promise
<
any
>
update
Online
State
update
Online
State
(
__namedParameters
:
{
roomUuid
:
string
;
userUuid
:
string
}
)
:
Promise
<
any
>
Parameters
__namedParameters:
{
roomUuid
:
string
;
userUuid
:
string
}
room
Uuid
:
string
user
Uuid
:
string
Returns
Promise
<
any
>
update
Room
Properties
update
Room
Properties
(
__namedParameters
:
{
cause
?:
unknown
;
properties
:
unknown
;
roomUuid
:
string
}
)
:
Promise
<
any
>
Parameters
__namedParameters:
{
cause
?:
unknown
;
properties
:
unknown
;
roomUuid
:
string
}
Optional
cause
?:
unknown
properties
:
unknown
room
Uuid
:
string
Returns
Promise
<
any
>
update
User
Properties
update
User
Properties
(
__namedParameters
:
{
cause
?:
any
;
properties
:
unknown
;
roomUuid
:
string
;
userUuid
:
string
}
)
:
Promise
<
any
>
Parameters
__namedParameters:
{
cause
?:
any
;
properties
:
unknown
;
roomUuid
:
string
;
userUuid
:
string
}
Optional
cause
?:
any
properties
:
unknown
room
Uuid
:
string
user
Uuid
:
string
Returns
Promise
<
any
>
upsert
Stream
upsert
Stream
(
roomUuid
:
string
, userUuid
:
string
, streamUuid
:
string
, __namedParameters
:
{
audioSourceType
?:
AgoraRteAudioSourceType
;
publishAudio
?:
AgoraRteMediaPublishState
;
publishVideo
?:
AgoraRteMediaPublishState
;
videoSourceType
?:
AgoraRteVideoSourceType
}
)
:
Promise
<
any
>
Parameters
roomUuid:
string
userUuid:
string
streamUuid:
string
__namedParameters:
{
audioSourceType
?:
AgoraRteAudioSourceType
;
publishAudio
?:
AgoraRteMediaPublishState
;
publishVideo
?:
AgoraRteMediaPublishState
;
videoSourceType
?:
AgoraRteVideoSourceType
}
Optional
audio
Source
Type
?:
AgoraRteAudioSourceType
Optional
publish
Audio
?:
AgoraRteMediaPublishState
Optional
publish
Video
?:
AgoraRteMediaPublishState
Optional
video
Source
Type
?:
AgoraRteVideoSourceType
Returns
Promise
<
any
>
upsert
Stream
Batch
upsert
Stream
Batch
(
roomUuid
:
string
, streams
:
{
audioSourceType
?:
AgoraRteAudioSourceType
;
audioState
?:
AgoraRteMediaPublishState
;
streamUuid
:
string
;
userUuid
:
string
;
videoSourceType
?:
AgoraRteVideoSourceType
;
videoState
?:
AgoraRteMediaPublishState
}
[]
)
:
Promise
<
any
>
Parameters
roomUuid:
string
streams:
{
audioSourceType
?:
AgoraRteAudioSourceType
;
audioState
?:
AgoraRteMediaPublishState
;
streamUuid
:
string
;
userUuid
:
string
;
videoSourceType
?:
AgoraRteVideoSourceType
;
videoState
?:
AgoraRteMediaPublishState
}
[]
Returns
Promise
<
any
>
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"
Agora
Rte
Service
constructor
fallback
Request
Handler
headers
host
logger
path
Prefix
domain
Holder
delete
Batch
User
Properties
delete
Room
Properties
delete
Stream
delete
User
Properties
entry
Room
fetch
publish
Stream
To
Cdn
send
Custom
Channel
Message
send
Custom
Peer
Message
send
Room
Chat
Message
sync
Peer
Sequence
sync
Sequence
update
Batch
User
Properties
update
Device
State
update
Online
State
update
Room
Properties
update
User
Properties
upsert
Stream
upsert
Stream
Batch