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/web/thread"
AgoraRteSubscribeThread
Class AgoraRteSubscribeThread
Hierarchy
AgoraRteThread
AgoraRteSubscribeThread
Index
Constructors
constructor
Properties
_canvas
Map
_mute
Map
_volume
Map
runnable
Accessors
canvas
mute
stream
Uuid
track
Methods
emit
is
Track
Subscribed
off
on
on
Execution
once
play
prepare
Pcm
Callback
remove
All
Event
Listeners
run
set
Audio
Frame
Callback
set
Audio
Playback
Device
stop
stop
Audio
Frame
Callback
Constructors
constructor
new
Agora
Rte
Subscribe
Thread
(
client
:
IAgoraRTCClient
, user
:
IAgoraRTCRemoteUser
, __namedParameters
:
{
audioPlaybackDeviceId
?:
string
;
canvasMap
?:
Map
<
string
,
AgoraRtcVideoCanvas
>
;
channelName
:
string
;
mediaType
:
"audio"
|
"video"
;
muteMap
:
Map
<
string
,
boolean
>
;
volumeMap
:
Map
<
string
,
number
>
}
, rawDataDispatcher
:
AGAudioRawDataDispatcher
)
:
AgoraRteSubscribeThread
Parameters
client:
IAgoraRTCClient
user:
IAgoraRTCRemoteUser
__namedParameters:
{
audioPlaybackDeviceId
?:
string
;
canvasMap
?:
Map
<
string
,
AgoraRtcVideoCanvas
>
;
channelName
:
string
;
mediaType
:
"audio"
|
"video"
;
muteMap
:
Map
<
string
,
boolean
>
;
volumeMap
:
Map
<
string
,
number
>
}
Optional
audio
Playback
Device
Id
?:
string
Optional
canvas
Map
?:
Map
<
string
,
AgoraRtcVideoCanvas
>
channel
Name
:
string
media
Type
:
"audio"
|
"video"
mute
Map
:
Map
<
string
,
boolean
>
volume
Map
:
Map
<
string
,
number
>
rawDataDispatcher:
AGAudioRawDataDispatcher
Returns
AgoraRteSubscribeThread
Properties
Optional
Readonly
_canvas
Map
_canvas
Map
?:
Map
<
string
,
AgoraRtcVideoCanvas
>
Readonly
_mute
Map
_mute
Map
:
Map
<
string
,
boolean
>
Readonly
_volume
Map
_volume
Map
:
Map
<
string
,
number
>
runnable
runnable
:
boolean
Accessors
canvas
get
canvas
(
)
:
undefined
|
AgoraRtcVideoCanvas
Returns
undefined
|
AgoraRtcVideoCanvas
mute
get
mute
(
)
:
boolean
Returns
boolean
stream
Uuid
get
streamUuid
(
)
:
string
Returns
string
track
get
track
(
)
:
undefined
|
IRemoteAudioTrack
|
IRemoteVideoTrack
Returns
undefined
|
IRemoteAudioTrack
|
IRemoteVideoTrack
Methods
emit
emit
(
evt
:
string
,
...
args
:
any
[]
)
:
AgoraRteSubscribeThread
Parameters
evt:
string
Rest
...
args:
any
[]
Returns
AgoraRteSubscribeThread
is
Track
Subscribed
is
Track
Subscribed
(
)
:
boolean
Returns
boolean
off
off
(
evt
:
string
, cb
:
CallableFunction
)
:
AgoraRteSubscribeThread
Parameters
evt:
string
cb:
CallableFunction
Returns
AgoraRteSubscribeThread
on
on
(
evt
:
string
, cb
:
CallableFunction
)
:
AgoraRteSubscribeThread
Parameters
evt:
string
cb:
CallableFunction
Returns
AgoraRteSubscribeThread
on
Execution
on
Execution
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
once
once
(
evt
:
string
, cb
:
CallableFunction
)
:
AgoraRteSubscribeThread
Parameters
evt:
string
cb:
CallableFunction
Returns
AgoraRteSubscribeThread
play
play
(
)
:
void
Returns
void
prepare
Pcm
Callback
prepare
Pcm
Callback
(
)
:
void
Returns
void
remove
All
Event
Listeners
remove
All
Event
Listeners
(
)
:
void
Returns
void
run
run
(
)
:
void
Returns
void
set
Audio
Frame
Callback
set
Audio
Frame
Callback
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
set
Audio
Playback
Device
set
Audio
Playback
Device
(
deviceId
:
string
)
:
void
Parameters
deviceId:
string
Returns
void
stop
stop
(
)
:
void
Returns
void
stop
Audio
Frame
Callback
stop
Audio
Frame
Callback
(
)
:
void
Returns
void
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
Subscribe
Thread
constructor
_canvas
Map
_mute
Map
_volume
Map
runnable
canvas
mute
stream
Uuid
track
emit
is
Track
Subscribed
off
on
on
Execution
once
play
prepare
Pcm
Callback
remove
All
Event
Listeners
run
set
Audio
Frame
Callback
set
Audio
Playback
Device
stop
stop
Audio
Frame
Callback