Search
Preparing search index...
The search index is not available
如视 Live SDK
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
如视 Live SDK
RTCProtocol
Module RTCProtocol
Index
Enumerations
RTCJoined
Info
Code
Enum
RTCType
Classes
RTCExample
VRWeb
ViewRTC
Interfaces
Get
Voice
Sign
Return
Type
RTCJoined
Info
RTCProtocol
VRWeb
ViewRTCOptions
Type aliases
Get
Voice
Sign
RTCAction
React
Callback
RTCEvent
Type
User
Volume
Type aliases
Get
Voice
Sign
Get
Voice
Sign
:
(
{ voiceId, userId, roomId }
:
{
roomId
:
string
|
number
;
userId
:
string
;
voiceId
:
string
}
)
=>
Promise
<
GetVoiceSignReturnType
>
Type declaration
(
{ voiceId, userId, roomId }
:
{
roomId
:
string
|
number
;
userId
:
string
;
voiceId
:
string
}
)
:
Promise
<
GetVoiceSignReturnType
>
Parameters
{ voiceId, userId, roomId }:
{
roomId
:
string
|
number
;
userId
:
string
;
voiceId
:
string
}
room
Id
:
string
|
number
user
Id
:
string
voice
Id
:
string
Returns
Promise
<
GetVoiceSignReturnType
>
RTCAction
React
Callback
RTCAction
React
Callback
:
Pick
<
RTCProtocol
,
"join"
|
"quit"
|
"shock"
|
"toggleMicro"
|
"detectMicro"
>
RTCEvent
Type
RTCEvent
Type
:
{
error
:
any
;
joinWillStart
:
any
;
joined
:
any
;
userVolumes
:
any
;
weakNetwork
:
any
}
RTC 异步事件类型。
Type declaration
error
:
function
error
(
error
:
Error
|
RTCJoinedInfo
)
:
void
错误\异常
Parameters
error:
Error
|
RTCJoinedInfo
Returns
void
join
Will
Start
:
function
join
Will
Start
(
)
:
void
即将加入房间。
Returns
void
joined
:
function
joined
(
)
:
void
成功加入语音房间。
Returns
void
user
Volumes
:
function
user
Volumes
(
userVolumes
:
UserVolume
[]
)
:
void
每个用户的音量。
Parameters
userVolumes:
UserVolume
[]
Returns
void
weak
Network
:
function
weak
Network
(
)
:
void
弱网提醒事件。
Returns
void
User
Volume
User
Volume
:
{
audioVolume
:
number
;
userId
:
string
}
用户的音量信息。
Type declaration
audio
Volume
:
number
user
Id
:
string
Modules
RTCProtocol
live
shared-
utils
RTCJoined
Info
Code
Enum
RTCType
RTCExample
VRWeb
ViewRTC
Get
Voice
Sign
Return
Type
RTCJoined
Info
RTCProtocol
VRWeb
ViewRTCOptions
Get
Voice
Sign
RTCAction
React
Callback
RTCEvent
Type
User
Volume
RTC 异步事件类型。