nimeet 文档中心
English

Flutter API 参考

构建时从公开 SDK 接口定义生成:接口、方法重载、属性、事件、枚举与错误码。

由公开 SDK 接口定义生成

版本 v1.1.0 · 更新于 2026-10-26 · 修订 1

接口概览

本页列出 Flutter 端公开 API 的类、方法、重载、属性、事件与错误码,接口定义与 SDK 包版本一致。

核对项数量
接口 / 类150
方法618
方法重载618
属性666
枚举150
错误码常量48

可用性

该端 SDK:正式可用。接口定义与 SDK 包版本一致;运行时的能力边界以实际发布的 SDK 包为准。

加入频道核心链路

按 join / leave / publish / subscribe 的典型调用顺序整理;参数表在“最小可运行链路”一节展开。

步骤接口方法重载数
订阅远端媒体BaseSpatialAudioEnginemuteRemoteAudioStream1
创建 / 初始化LocalSpatialAudioEngineinitialize1
续期 TokenMusicContentCenterrenewToken1
开启视频与预览RtcEngineenableVideo1
加入频道RtcEnginejoinChannel1
离开频道RtcEngineleaveChannel1
频道场景RtcEnginesetChannelProfile1
角色切换RtcEnginesetClientRole1
本地画面RtcEnginesetupLocalVideo1

最小可运行链路的参数

参数类型可选可变参数
muteint uid,required bool否否
tokenString否否
optionsString token,required String channelId,required int uid,required ChannelMediaOptions否否
optionsLeaveChannelOptions?是否
profileChannelProfileType否否
optionsClientRoleType role,ClientRoleOptions?是否
canvasVideoCanvas否否

接口索引

接口方法属性事件
AdvancedAudioOptions010
AdvancedConfigInfo010
AdvanceOptions030
AgoraPipContentViewLayout040
AgoraPipController1000
AgoraPipOptions0170
AgoraPipStateChangedObserver100
AgoraPipVideoStream020
AgoraRhythmPlayerConfig020
AgoraRtcException020
AgoraVideoView020
AudioDeviceInfo030
AudioDeviceManager3000
AudioEncodedFrameObserver300
AudioEncodedFrameObserverConfig020
AudioFrame080
AudioFrameObserver100
AudioFrameObserverBase400
AudioParams040
AudioPcmFrame060
AudioPcmFrameSink100
AudioRecordingConfiguration060
AudioSpectrumData020
AudioSpectrumObserver200
AudioTrackConfig020
AudioVolumeInfo040
BaseSpatialAudioEngine1100
BeautyOptions050
CacheStatistics030
CameraCapturerConfiguration060
ChannelMediaInfo030
ChannelMediaOptions0360
ChannelMediaRelayConfiguration030
ClientRoleOptions010
ClimaxSegment020
CodecCapInfo030
CodecCapLevels020
ColorEnhanceOptions020
ContentInspectConfig040
ContentInspectModule030
DataStreamConfig020
DeviceInfo010
EchoTestConfiguration060
EncodedAudioFrameInfo060
EncodedVideoFrameInfo090
EncryptionConfig040
ExtensionContext040
ExternalVideoFrame0230
FaceShapeAreaOptions020
FaceShapeBeautyOptions020
FilterEffectOptions110
FocalLengthInfo020
ImageTrackOptions020
LastmileProbeConfig040
LastmileProbeOneWayResult030
LastmileProbeResult040
LeaveChannelOptions030
LiveStreamAdvancedFeature020
LiveTranscoding0230
LocalAccessPointConfiguration070
LocalAudioMixerConfiguration030
LocalAudioStats080
LocalSpatialAudioEngine500
LocalTranscoderConfiguration030
LocalVideoStats0220
LogConfig030
LogUploadServerInfo040
LowlightEnhanceOptions020
MediaEngine1600
MediaPlayer4200
MediaPlayerCacheManager1200
MediaPlayerController100
MediaPlayerSourceObserver1100
MediaPlayerVideoFrameObserver100
MediaRecorder300
MediaRecorderConfiguration0110
MediaRecorderObserver200
MediaSource080
Metadata050
MetadataObserver100
MultipathStats080
Music0120
MusicCacheInfo020
MusicChartCollection200
MusicChartInfo020
MusicCollection500
MusicContentCenter1700
MusicContentCenterConfiguration040
MusicContentCenterEventHandler500
MusicPlayer200
PathStats030
PlayerPlaybackStats040
PlayerStreamInfo0130
PlayerUpdatedInfo060
RecorderInfo030
RecorderStreamInfo030
Rectangle040
RemoteAudioStats0160
RemoteVideoStats0170
RemoteVoicePositionInfo010
RtcConnection020
RtcEngine27200
RtcEngineContext070
RtcEngineEventHandler8700
RtcEngineEx4900
RtcEngineExt100
RtcImage070
RtcStats0240
ScreenAudioParameters030
ScreenCaptureConfiguration060
ScreenCaptureParameters0100
ScreenCaptureParameters2040
ScreenCaptureSourceInfo0110
ScreenVideoParameters040
SDKBuildInfo020
SegmentationProperty030
SimulcastStreamConfig030
SnapshotConfig020
SpatialAudioParams080
SpatialAudioZone090
SrcInfo020
ThumbImageBuffer040
TranscodingUser080
TranscodingVideoStream0110
UplinkNetworkInfo010
UserAudioSpectrumInfo020
UserInfo020
VideoCanvas0120
VideoDenoiserOptions020
VideoDeviceInfo020
VideoDeviceManager600
VideoDimensions020
VideoEffectObject900
VideoEncodedFrameObserver100
VideoEncoderConfiguration090
VideoFormat030
VideoFrame0200
VideoFrameObserver300
VideoLayout080
VideoRenderingTracingInfo070
VideoSubscriptionOptions020
VideoViewController150
VideoViewControllerBase050
VirtualBackgroundSource040
WatermarkBuffer050
WatermarkConfig070
WatermarkLiteral040
WatermarkOptions060
WatermarkRatio030
WatermarkTimestamp040

全部接口

AdvancedAudioOptions 0 方法 / 1 属性
属性类型只读
audioProcessingChannelsAudioProcessingChannels?否
AdvancedConfigInfo 0 方法 / 1 属性
属性类型只读
logUploadServerLogUploadServerInfo?否
AdvanceOptions 0 方法 / 3 属性
属性类型只读
encodingPreferenceEncodingPreference?否
compressionPreferenceCompressionPreference?否
encodeAlphabool?否
AgoraPipContentViewLayout 0 方法 / 4 属性
属性类型只读
paddingint?否
spacingint?否
rowint?否
columnint?否
AgoraPipController 10 方法 / 0 属性
typescript
dispose(): Future
isPipActivated(): Future
pipDispose(): Future
pipIsAutoEnterSupported(): Future
pipIsSupported(): Future
pipSetup(options: AgoraPipOptions): Future
pipStart(): Future
pipStop(): Future
registerPipStateChangedObserver(observer: AgoraPipStateChangedObserver): Future
unregisterPipStateChangedObserver(): Future

方法明细:10 / 10(参数、返回值、错误码)

方法参数返回值错误
dispose—Future错误码索引
isPipActivated—Future错误码索引
pipDispose—Future错误码索引
pipIsAutoEnterSupported—Future错误码索引
pipIsSupported—Future错误码索引
pipSetupoptions: AgoraPipOptionsFuture错误码索引
pipStart—Future错误码索引
pipStop—Future错误码索引
registerPipStateChangedObserverobserver: AgoraPipStateChangedObserverFuture错误码索引
unregisterPipStateChangedObserver—Future错误码索引
AgoraPipOptions 0 方法 / 17 属性
属性类型只读
autoEnterEnabledbool?否
aspectRatioXint?否
aspectRatioYint?否
sourceRectHintLeftint?否
sourceRectHintTopint?否
sourceRectHintRightint?否
sourceRectHintBottomint?否
seamlessResizeEnabledbool?否
useExternalStateMonitorbool?否
externalStateMonitorIntervalint?否
sourceContentViewint?否
contentViewint?否
videoStreamsList ?否
contentViewLayoutAgoraPipContentViewLayout?否
preferredContentWidthint?否
preferredContentHeightint?否
controlStyleint?否
AgoraPipStateChangedObserver 1 方法 / 0 属性
typescript
onPipStateChanged(state: AgoraPipState, error?: String?): void

方法明细:1 / 1(参数、返回值、错误码)

方法参数返回值错误
onPipStateChangedstate: AgoraPipState, error?: String?void错误码索引
AgoraPipVideoStream 0 方法 / 2 属性
属性类型只读
connectionRtcConnection否
canvasVideoCanvas否
AgoraRhythmPlayerConfig 0 方法 / 2 属性
属性类型只读
beatsPerMeasureint?否
beatsPerMinuteint?否
AgoraRtcException 0 方法 / 2 属性
属性类型只读
codeint否
messageString?否
AgoraVideoView 0 方法 / 2 属性
属性类型只读
keyunknown否
controllerVideoViewControllerBase否
AudioDeviceInfo 0 方法 / 3 属性
属性类型只读
deviceIdString?否
deviceNameString?否
deviceTypeNameString?否
AudioDeviceManager 30 方法 / 0 属性
typescript
enumeratePlaybackDevices(): List
enumerateRecordingDevices(): List
followSystemLoopbackDevice(enable: bool): Future
followSystemPlaybackDevice(enable: bool): Future
followSystemRecordingDevice(enable: bool): Future
getLoopbackDevice(): Future
getPlaybackDefaultDevice(): Future
getPlaybackDevice(): Future
getPlaybackDeviceInfo(): Future
getPlaybackDeviceMute(): Future
getPlaybackDeviceVolume(): Future
getRecordingDefaultDevice(): Future
getRecordingDevice(): Future
getRecordingDeviceInfo(): Future
getRecordingDeviceMute(): Future
getRecordingDeviceVolume(): Future
release(): Future
setLoopbackDevice(deviceId: String): Future
setPlaybackDevice(deviceId: String): Future
setPlaybackDeviceMute(mute: bool): Future
setPlaybackDeviceVolume(volume: int): Future
setRecordingDevice(deviceId: String): Future
setRecordingDeviceMute(mute: bool): Future
setRecordingDeviceVolume(volume: int): Future
startAudioDeviceLoopbackTest(indicationInterval: int): Future
startPlaybackDeviceTest(testAudioFilePath: String): Future
startRecordingDeviceTest(indicationInterval: int): Future
stopAudioDeviceLoopbackTest(): Future
stopPlaybackDeviceTest(): Future
stopRecordingDeviceTest(): Future

方法明细:30 / 30(参数、返回值、错误码)

方法参数返回值错误
enumeratePlaybackDevices—List错误码索引
enumerateRecordingDevices—List错误码索引
followSystemLoopbackDeviceenable: boolFuture错误码索引
followSystemPlaybackDeviceenable: boolFuture错误码索引
followSystemRecordingDeviceenable: boolFuture错误码索引
getLoopbackDevice—Future错误码索引
getPlaybackDefaultDevice—Future错误码索引
getPlaybackDevice—Future错误码索引
getPlaybackDeviceInfo—Future错误码索引
getPlaybackDeviceMute—Future错误码索引
getPlaybackDeviceVolume—Future错误码索引
getRecordingDefaultDevice—Future错误码索引
getRecordingDevice—Future错误码索引
getRecordingDeviceInfo—Future错误码索引
getRecordingDeviceMute—Future错误码索引
getRecordingDeviceVolume—Future错误码索引
release—Future错误码索引
setLoopbackDevicedeviceId: StringFuture错误码索引
setPlaybackDevicedeviceId: StringFuture错误码索引
setPlaybackDeviceMutemute: boolFuture错误码索引
setPlaybackDeviceVolumevolume: intFuture错误码索引
setRecordingDevicedeviceId: StringFuture错误码索引
setRecordingDeviceMutemute: boolFuture错误码索引
setRecordingDeviceVolumevolume: intFuture错误码索引
startAudioDeviceLoopbackTestindicationInterval: intFuture错误码索引
startPlaybackDeviceTesttestAudioFilePath: StringFuture错误码索引
startRecordingDeviceTestindicationInterval: intFuture错误码索引
stopAudioDeviceLoopbackTest—Future错误码索引
stopPlaybackDeviceTest—Future错误码索引
stopRecordingDeviceTest—Future错误码索引
AudioEncodedFrameObserver 3 方法 / 0 属性
typescript
onMixedAudioEncodedFrame(frameBuffer: Uint8List, length: int, audioEncodedFrameInfo: EncodedAudioFrameInfo): void
onPlaybackAudioEncodedFrame(frameBuffer: Uint8List, length: int, audioEncodedFrameInfo: EncodedAudioFrameInfo): void
onRecordAudioEncodedFrame(frameBuffer: Uint8List, length: int, audioEncodedFrameInfo: EncodedAudioFrameInfo): void

方法明细:3 / 3(参数、返回值、错误码)

方法参数返回值错误
onMixedAudioEncodedFrameframeBuffer: Uint8List, length: int, audioEncodedFrameInfo: EncodedAudioFrameInfovoid错误码索引
onPlaybackAudioEncodedFrameframeBuffer: Uint8List, length: int, audioEncodedFrameInfo: EncodedAudioFrameInfovoid错误码索引
onRecordAudioEncodedFrameframeBuffer: Uint8List, length: int, audioEncodedFrameInfo: EncodedAudioFrameInfovoid错误码索引
AudioEncodedFrameObserverConfig 0 方法 / 2 属性
属性类型只读
postionTypeAudioEncodedFrameObserverPosition?否
encodingTypeAudioEncodingType?否
AudioFrame 0 方法 / 8 属性
属性类型只读
typeunknown否
samplesPerChannelunknown否
bytesPerSampleunknown否
channelsunknown否
samplesPerSecunknown否
bufferunknown否
renderTimeMsunknown否
avsyncTypeunknown否
AudioFrameObserver 1 方法 / 0 属性
typescript
onPlaybackAudioFrameBeforeMixing(channelId: String, uid: int, audioFrame: AudioFrame): void

方法明细:1 / 1(参数、返回值、错误码)

方法参数返回值错误
onPlaybackAudioFrameBeforeMixingchannelId: String, uid: int, audioFrame: AudioFramevoid错误码索引
AudioFrameObserverBase 4 方法 / 0 属性
typescript
onEarMonitoringAudioFrame(audioFrame: AudioFrame): void
onMixedAudioFrame(channelId: String, audioFrame: AudioFrame): void
onPlaybackAudioFrame(channelId: String, audioFrame: AudioFrame): void
onRecordAudioFrame(channelId: String, audioFrame: AudioFrame): void

方法明细:4 / 4(参数、返回值、错误码)

方法参数返回值错误
onEarMonitoringAudioFrameaudioFrame: AudioFramevoid错误码索引
onMixedAudioFramechannelId: String, audioFrame: AudioFramevoid错误码索引
onPlaybackAudioFramechannelId: String, audioFrame: AudioFramevoid错误码索引
onRecordAudioFramechannelId: String, audioFrame: AudioFramevoid错误码索引
AudioParams 0 方法 / 4 属性
属性类型只读
sampleRateint?否
channelsint?否
modeRawAudioFrameOpModeType?否
samplesPerCallint?否
AudioPcmFrame 0 方法 / 6 属性
属性类型只读
captureTimestampint?否
samplesPerChannelint?否
sampleRateHzint?否
numChannelsint?否
bytesPerSampleBytesPerSample?否
dataList ?否
AudioPcmFrameSink 1 方法 / 0 属性
typescript
onFrame(frame: AudioPcmFrame): void

方法明细:1 / 1(参数、返回值、错误码)

方法参数返回值错误
onFrameframe: AudioPcmFramevoid错误码索引
AudioRecordingConfiguration 0 方法 / 6 属性
属性类型只读
filePathString?否
encodebool?否
sampleRateint?否
fileRecordingTypeAudioFileRecordingType?否
qualityAudioRecordingQualityType?否
recordingChannelint?否
AudioSpectrumData 0 方法 / 2 属性
属性类型只读
audioSpectrumDataList ?否
dataLengthint?否
AudioSpectrumObserver 2 方法 / 0 属性
typescript
onLocalAudioSpectrum(data: AudioSpectrumData): void
onRemoteAudioSpectrum(spectrums: List, spectrumNumber: int): void

方法明细:2 / 2(参数、返回值、错误码)

方法参数返回值错误
onLocalAudioSpectrumdata: AudioSpectrumDatavoid错误码索引
onRemoteAudioSpectrumspectrums: List, spectrumNumber: intvoid错误码索引
AudioTrackConfig 0 方法 / 2 属性
属性类型只读
enableLocalPlaybackbool?否
enableAudioProcessingbool?否
AudioVolumeInfo 0 方法 / 4 属性
属性类型只读
uidint?否
volumeint?否
vadint?否
voicePitchdouble?否
BaseSpatialAudioEngine 11 方法 / 0 属性
typescript
muteAllRemoteAudioStreams(mute: bool): Future
muteLocalAudioStream(mute: bool): Future
muteRemoteAudioStream(mute: int uid,required bool): Future
release(): unknown
setAudioRecvRange(range: double): Future
setDistanceUnit(unit: double): Future
setMaxAudioRecvCount(maxCount: int): Future
setPlayerAttenuation(forceSet: int playerId,required double attenuation,required bool): Future
setZones(zoneCount: SpatialAudioZone zones,required int): Future
updatePlayerPositionInfo(positionInfo: int playerId,required RemoteVoicePositionInfo): Future
updateSelfPosition(axisUp: List position,required List axisForward,required List axisRight,required List): Future

方法明细:11 / 11(参数、返回值、错误码)

方法参数返回值错误
muteAllRemoteAudioStreamsmute: boolFuture错误码索引
muteLocalAudioStreammute: boolFuture错误码索引
muteRemoteAudioStreammute: int uid,required boolFuture错误码索引
release—unknown错误码索引
setAudioRecvRangerange: doubleFuture错误码索引
setDistanceUnitunit: doubleFuture错误码索引
setMaxAudioRecvCountmaxCount: intFuture错误码索引
setPlayerAttenuationforceSet: int playerId,required double attenuation,required boolFuture错误码索引
setZoneszoneCount: SpatialAudioZone zones,required intFuture错误码索引
updatePlayerPositionInfopositionInfo: int playerId,required RemoteVoicePositionInfoFuture错误码索引
updateSelfPositionaxisUp: List position,required List axisForward,required List axisRight,required ListFuture错误码索引
BeautyOptions 0 方法 / 5 属性
属性类型只读
lighteningContrastLevelLighteningContrastLevel?否
lighteningLeveldouble?否
smoothnessLeveldouble?否
rednessLeveldouble?否
sharpnessLeveldouble?否
CacheStatistics 0 方法 / 3 属性
属性类型只读
fileSizeint?否
cacheSizeint?否
downloadSizeint?否
CameraCapturerConfiguration 0 方法 / 6 属性
属性类型只读
cameraDirectionCameraDirection?否
cameraIdString?否
cameraFocalLengthTypeCameraFocalLengthType?否
formatVideoFormat?否
deviceIdString?否
followEncodeDimensionRatiobool?否
ChannelMediaInfo 0 方法 / 3 属性
属性类型只读
channelNameString?否
tokenString?否
uidint?否
ChannelMediaOptions 0 方法 / 36 属性
属性类型只读
publishCameraTrackbool?否
publishSecondaryCameraTrackbool?否
publishMicrophoneTrackbool?否
publishThirdCameraTrackbool?否
publishFourthCameraTrackbool?否
publishScreenTrackbool?否
publishScreenCaptureVideobool?否
publishScreenCaptureAudiobool?否
publishSecondaryScreenTrackbool?否
publishThirdScreenTrackbool?否
publishFourthScreenTrackbool?否
publishTranscodedVideoTrackbool?否
publishMixedAudioTrackbool?否
publishLipSyncTrackunknown否
publishCustomAudioTrackbool?否
publishCustomAudioTrackIdint?否
publishCustomVideoTrackbool?否
publishEncodedVideoTrackbool?否
publishMediaPlayerAudioTrackbool?否
publishMediaPlayerVideoTrackbool?否
autoSubscribeAudiobool?否
autoSubscribeVideobool?否
enableAudioRecordingOrPlayoutbool?否
publishMediaPlayerIdint?否
clientRoleTypeClientRoleType?否
audienceLatencyLevelAudienceLatencyLevelType?否
defaultVideoStreamTypeVideoStreamType?否
channelProfileChannelProfileType?否
audioDelayMsint?否
tokenString?否
publishRhythmPlayerTrackbool?否
isInteractiveAudiencebool?否
customVideoTrackIdint?否
isAudioFilterablebool?否
enableMultipathbool?否
preferMultipathTypeMultipathType?否
ChannelMediaRelayConfiguration 0 方法 / 3 属性
属性类型只读
srcInfoChannelMediaInfo?否
destInfosList ?否
destCountint?否
ClientRoleOptions 0 方法 / 1 属性
属性类型只读
audienceLatencyLevelAudienceLatencyLevelType?否
ClimaxSegment 0 方法 / 2 属性
属性类型只读
startTimeMsint?否
endTimeMsint?否
CodecCapInfo 0 方法 / 3 属性
属性类型只读
codecTypeVideoCodecType?否
codecCapMaskint?否
codecLevelsCodecCapLevels?否
CodecCapLevels 0 方法 / 2 属性
属性类型只读
hwDecodingLevelVideoCodecCapabilityLevel?否
swDecodingLevelVideoCodecCapabilityLevel?否
ColorEnhanceOptions 0 方法 / 2 属性
属性类型只读
strengthLeveldouble?否
skinProtectLeveldouble?否
ContentInspectConfig 0 方法 / 4 属性
属性类型只读
extraInfoString?否
serverConfigString?否
modulesList ?否
moduleCountint?否
ContentInspectModule 0 方法 / 3 属性
属性类型只读
typeContentInspectType?否
intervalint?否
positionVideoModulePosition?否
DataStreamConfig 0 方法 / 2 属性
属性类型只读
syncWithAudiobool?否
orderedbool?否
DeviceInfo 0 方法 / 1 属性
属性类型只读
isLowLatencyAudioSupportedbool?否
EchoTestConfiguration 0 方法 / 6 属性
属性类型只读
viewint?否
enableAudiobool?否
enableVideobool?否
tokenString?否
channelIdString?否
intervalInSecondsint?否
EncodedAudioFrameInfo 0 方法 / 6 属性
属性类型只读
codecAudioCodecType?否
sampleRateHzint?否
samplesPerChannelint?否
numberOfChannelsint?否
advancedSettingsEncodedAudioFrameAdvancedSettings?否
captureTimeMsint?否
EncodedVideoFrameInfo 0 方法 / 9 属性
属性类型只读
codecTypeVideoCodecType?否
widthint?否
heightint?否
framesPerSecondint?否
frameTypeVideoFrameType?否
rotationVideoOrientation?否
trackIdint?否
captureTimeMsint?否
streamTypeVideoStreamType?否
EncryptionConfig 0 方法 / 4 属性
属性类型只读
encryptionModeEncryptionMode?否
encryptionKeyString?否
encryptionKdfSaltUint8List?否
datastreamEncryptionEnabledbool?否
ExtensionContext 0 方法 / 4 属性
属性类型只读
isValidbool?否
uidint?否
providerNameString?否
extensionNameString?否
ExternalVideoFrame 0 方法 / 23 属性
属性类型只读
typeVideoBufferType?否
formatVideoPixelFormat?否
bufferUint8List?否
strideint?否
heightint?否
eglContextunknown否
eglTypeEglContextType?否
textureIdint?否
matrixList ?否
metadataBufferUint8List?否
metadataSizeint?否
d3d11Texture2dint?否
alphaBufferUint8List?否
fillAlphaBufferbool?否
alphaStitchModeAlphaStitchMode?否
textureSliceIndexint?否
cropLeftint?否
cropTopint?否
cropRightint?否
cropBottomint?否
rotationint?否
timestampint?否
colorSpaceColorSpace?否
FaceShapeAreaOptions 0 方法 / 2 属性
属性类型只读
shapeAreaunknown否
shapeIntensityunknown否
FaceShapeBeautyOptions 0 方法 / 2 属性
属性类型只读
shapeStyleFaceShapeBeautyStyle?否
styleIntensityint?否
FilterEffectOptions 1 方法 / 1 属性
typescript
path(): unknown

方法明细:1 / 1(参数、返回值、错误码)

方法参数返回值错误
path—unknown错误码索引
属性类型只读
strengthunknown否
FocalLengthInfo 0 方法 / 2 属性
属性类型只读
cameraDirectionint?否
focalLengthTypeCameraFocalLengthType?否
ImageTrackOptions 0 方法 / 2 属性
属性类型只读
imageUrlString?否
fpsint?否
LastmileProbeConfig 0 方法 / 4 属性
属性类型只读
probeUplinkbool?否
probeDownlinkbool?否
expectedUplinkBitrateint?否
expectedDownlinkBitrateint?否
LastmileProbeOneWayResult 0 方法 / 3 属性
属性类型只读
packetLossRateint?否
jitterint?否
availableBandwidthint?否
LastmileProbeResult 0 方法 / 4 属性
属性类型只读
stateLastmileProbeResultState?否
uplinkReportLastmileProbeOneWayResult?否
downlinkReportLastmileProbeOneWayResult?否
rttint?否
LeaveChannelOptions 0 方法 / 3 属性
属性类型只读
stopAudioMixingbool?否
stopAllEffectbool?否
stopMicrophoneRecordingbool?否
LiveStreamAdvancedFeature 0 方法 / 2 属性
属性类型只读
featureNameString?否
openedbool?否
LiveTranscoding 0 方法 / 23 属性
属性类型只读
widthint?否
heightint?否
videoBitrateint?否
videoFramerateint?否
lowLatencybool?否
videoGopint?否
videoCodecProfileVideoCodecProfileType?否
videoCodecTypeVideoCodecTypeForStream?否
transcodingUsersList ?否
transcodingExtraInfoString?否
backgroundColorint?否
userCountint?否
metadataString?否
watermarkList ?否
backgroundImageList ?否
audioSampleRateAudioSampleRateType?否
audioBitrateint?否
audioChannelsint?否
audioCodecProfileAudioCodecProfileType?否
watermarkCountint?否
backgroundImageCountint?否
advancedFeaturesunknown否
advancedFeatureCountint?否
LocalAccessPointConfiguration 0 方法 / 7 属性
属性类型只读
ipListList ?否
ipListSizeint?否
domainListList ?否
domainListSizeint?否
verifyDomainNameString?否
modeLocalProxyMode?否
advancedConfigAdvancedConfigInfo?否
LocalAudioMixerConfiguration 0 方法 / 3 属性
属性类型只读
streamCountint?否
audioInputStreamsList ?否
syncWithLocalMicbool?否
LocalAudioStats 0 方法 / 8 属性
属性类型只读
numChannelsint?否
sentSampleRateint?否
sentBitrateint?否
txPacketLossRateint?否
internalCodecint?否
audioDeviceDelayint?否
earMonitorDelayint?否
aecEstimatedDelayint?否
LocalSpatialAudioEngine 5 方法 / 0 属性
typescript
clearRemotePositions(): Future
initialize(): Future
removeRemotePosition(uid: int): Future
setRemoteAudioAttenuation(forceSet: int uid,required double attenuation,required bool): Future
updateRemotePosition(posInfo: int uid,required RemoteVoicePositionInfo): Future

方法明细:5 / 5(参数、返回值、错误码)

方法参数返回值错误
clearRemotePositions—Future错误码索引
initialize—Future错误码索引
removeRemotePositionuid: intFuture错误码索引
setRemoteAudioAttenuationforceSet: int uid,required double attenuation,required boolFuture错误码索引
updateRemotePositionposInfo: int uid,required RemoteVoicePositionInfoFuture错误码索引
LocalTranscoderConfiguration 0 方法 / 3 属性
属性类型只读
streamCountint?否
videoInputStreamsList ?否
videoOutputConfigurationVideoEncoderConfiguration?否
LocalVideoStats 0 方法 / 22 属性
属性类型只读
uidint?否
sentBitrateint?否
sentFrameRateint?否
captureFrameRateint?否
captureFrameWidthint?否
captureFrameHeightint?否
regulatedCaptureFrameRateint?否
regulatedCaptureFrameWidthint?否
regulatedCaptureFrameHeightint?否
encoderOutputFrameRateint?否
rendererOutputFrameRateint?否
targetBitrateint?否
targetFrameRateint?否
qualityAdaptIndicationQualityAdaptIndication?否
encodedBitrateint?否
encodedFrameHeightint?否
encodedFrameWidthint?否
encodedFrameCountint?否
codecTypeVideoCodecType?否
txPacketLossRateint?否
captureBrightnessLevelCaptureBrightnessLevelType?否
hwEncoderAcceleratingint?否
LogConfig 0 方法 / 3 属性
属性类型只读
filePathString?否
fileSizeInKBint?否
levelLogLevel?否
LogUploadServerInfo 0 方法 / 4 属性
属性类型只读
serverDomainString?否
serverPathString?否
serverPortint?否
serverHttpsbool?否
LowlightEnhanceOptions 0 方法 / 2 属性
属性类型只读
levelLowLightEnhanceLevel?否
modeLowLightEnhanceMode?否
MediaEngine 16 方法 / 0 属性
typescript
createCustomAudioTrack(config: AudioTrackType trackType,required AudioTrackConfig): Future
destroyCustomAudioTrack(trackId: int): Future
pullAudioFrame(frame: AudioFrame): Future
pushAudioFrame(null: AudioFrame frame,int trackId = 0): Future
pushVideoFrame(null: ExternalVideoFrame frame,int videoTrackId = 0): Future
registerAudioFrameObserver(observer: AudioFrameObserver): void
registerFaceInfoObserver(observer: FaceInfoObserver): void
registerVideoEncodedFrameObserver(observer: VideoEncodedFrameObserver): void
registerVideoFrameObserver(observer: VideoFrameObserver): void
setExternalAudioSink(channels: bool enabled,required int sampleRate,required int): Future
setExternalAudioSource(true: bool enabled,required int sampleRate,required int channels,bool localPlayback = false,bool publish =): Future
setExternalVideoSource(null: bool enabled,required bool useTexture,ExternalVideoSourceType sourceType = ExternalVideoSourceType.videoFrame,SenderOptions encodedVideoOption = const SenderOptions()): Future
unregisterAudioFrameObserver(observer: AudioFrameObserver): void
unregisterFaceInfoObserver(observer: FaceInfoObserver): void
unregisterVideoEncodedFrameObserver(observer: VideoEncodedFrameObserver): void
unregisterVideoFrameObserver(observer: VideoFrameObserver): void

方法明细:16 / 16(参数、返回值、错误码)

方法参数返回值错误
createCustomAudioTrackconfig: AudioTrackType trackType,required AudioTrackConfigFuture错误码索引
destroyCustomAudioTracktrackId: intFuture错误码索引
pullAudioFrameframe: AudioFrameFuture错误码索引
pushAudioFramenull: AudioFrame frame,int trackId = 0Future错误码索引
pushVideoFramenull: ExternalVideoFrame frame,int videoTrackId = 0Future错误码索引
registerAudioFrameObserverobserver: AudioFrameObservervoid错误码索引
registerFaceInfoObserverobserver: FaceInfoObservervoid错误码索引
registerVideoEncodedFrameObserverobserver: VideoEncodedFrameObservervoid错误码索引
registerVideoFrameObserverobserver: VideoFrameObservervoid错误码索引
setExternalAudioSinkchannels: bool enabled,required int sampleRate,required intFuture错误码索引
setExternalAudioSourcetrue: bool enabled,required int sampleRate,required int channels,bool localPlayback = false,bool publish =Future错误码索引
setExternalVideoSourcenull: bool enabled,required bool useTexture,ExternalVideoSourceType sourceType = ExternalVideoSourceType.videoFrame,SenderOptions encodedVideoOption = const SenderOptions()Future错误码索引
unregisterAudioFrameObserverobserver: AudioFrameObservervoid错误码索引
unregisterFaceInfoObserverobserver: FaceInfoObservervoid错误码索引
unregisterVideoEncodedFrameObserverobserver: VideoEncodedFrameObservervoid错误码索引
unregisterVideoFrameObserverobserver: VideoFrameObservervoid错误码索引
MediaPlayer 42 方法 / 0 属性
typescript
adjustPlayoutVolume(volume: int): Future
adjustPublishSignalVolume(volume: int): Future
getAudioBufferDelay(): Future
getDuration(): Future
getMediaPlayerId(): int
getMute(): Future
getPlayPosition(): Future
getPlaySrc(): Future
getPlayoutVolume(): Future
getPublishSignalVolume(): Future
getState(): Future
getStreamCount(): Future
getStreamInfo(index: int): Future
mute(muted: bool): Future
open(startPos: String url,required int): Future
openWithMediaSource(source: MediaSource): Future
pause(): Future
play(): Future
playPreloadedSrc(src: String): Future
preloadSrc(startPos: String src,required int): Future
registerAudioFrameObserver(null: AudioPcmFrameSink observer,RawAudioFrameOpModeType mode = RawAudioFrameOpModeType.rawAudioFrameOpModeReadOnly): void
registerPlayerSourceObserver(observer: MediaPlayerSourceObserver): void
registerVideoFrameObserver(observer: MediaPlayerVideoFrameObserver): void
resume(): Future
seek(newPos: int): Future
selectAudioTrack(index: int): Future
selectMultiAudioTrack(publishTrackIndex: int playoutTrackIndex,required int): Future
setAudioDualMonoMode(mode: AudioDualMonoMode): Future
setAudioPitch(pitch: int): Future
setLoopCount(loopCount: int): Future
setPlaybackSpeed(speed: int): Future
setPlayerOptionInInt(value: String key,required int): Future
setPlayerOptionInString(value: String key,required String): Future
setRenderMode(renderMode: RenderModeType): Future
setSpatialAudioParams(params: SpatialAudioParams): Future
setView(view: int): Future
stop(): Future
switchSrc(true: String src,bool syncPts =): Future
unloadSrc(src: String): Future
unregisterAudioFrameObserver(observer: AudioPcmFrameSink): void
unregisterPlayerSourceObserver(observer: MediaPlayerSourceObserver): void
unregisterVideoFrameObserver(observer: MediaPlayerVideoFrameObserver): void

方法明细:42 / 42(参数、返回值、错误码)

方法参数返回值错误
adjustPlayoutVolumevolume: intFuture错误码索引
adjustPublishSignalVolumevolume: intFuture错误码索引
getAudioBufferDelay—Future错误码索引
getDuration—Future错误码索引
getMediaPlayerId—int错误码索引
getMute—Future错误码索引
getPlayPosition—Future错误码索引
getPlaySrc—Future错误码索引
getPlayoutVolume—Future错误码索引
getPublishSignalVolume—Future错误码索引
getState—Future错误码索引
getStreamCount—Future错误码索引
getStreamInfoindex: intFuture错误码索引
mutemuted: boolFuture错误码索引
openstartPos: String url,required intFuture错误码索引
openWithMediaSourcesource: MediaSourceFuture错误码索引
pause—Future错误码索引
play—Future错误码索引
playPreloadedSrcsrc: StringFuture错误码索引
preloadSrcstartPos: String src,required intFuture错误码索引
registerAudioFrameObservernull: AudioPcmFrameSink observer,RawAudioFrameOpModeType mode = RawAudioFrameOpModeType.rawAudioFrameOpModeReadOnlyvoid错误码索引
registerPlayerSourceObserverobserver: MediaPlayerSourceObservervoid错误码索引
registerVideoFrameObserverobserver: MediaPlayerVideoFrameObservervoid错误码索引
resume—Future错误码索引
seeknewPos: intFuture错误码索引
selectAudioTrackindex: intFuture错误码索引
selectMultiAudioTrackpublishTrackIndex: int playoutTrackIndex,required intFuture错误码索引
setAudioDualMonoModemode: AudioDualMonoModeFuture错误码索引
setAudioPitchpitch: intFuture错误码索引
setLoopCountloopCount: intFuture错误码索引
setPlaybackSpeedspeed: intFuture错误码索引
setPlayerOptionInIntvalue: String key,required intFuture错误码索引
setPlayerOptionInStringvalue: String key,required StringFuture错误码索引
setRenderModerenderMode: RenderModeTypeFuture错误码索引
setSpatialAudioParamsparams: SpatialAudioParamsFuture错误码索引
setViewview: intFuture错误码索引
stop—Future错误码索引
switchSrctrue: String src,bool syncPts =Future错误码索引
unloadSrcsrc: StringFuture错误码索引
unregisterAudioFrameObserverobserver: AudioPcmFrameSinkvoid错误码索引
unregisterPlayerSourceObserverobserver: MediaPlayerSourceObservervoid错误码索引
unregisterVideoFrameObserverobserver: MediaPlayerVideoFrameObservervoid错误码索引
MediaPlayerCacheManager 12 方法 / 0 属性
typescript
enableAutoRemoveCache(enable: bool): Future
getCacheDir(length: int): Future
getCacheFileCount(): Future
getMaxCacheFileCount(): Future
getMaxCacheFileSize(): Future
getMediaPlayerCacheManager(): MediaPlayerCacheManager
removeAllCaches(): Future
removeCacheByUri(uri: String): uture
removeOldCache(): Future
setCacheDir(path: String): Future
setMaxCacheFileCount(count: int): Future
setMaxCacheFileSize(cacheSize: int): Future

方法明细:12 / 12(参数、返回值、错误码)

方法参数返回值错误
enableAutoRemoveCacheenable: boolFuture错误码索引
getCacheDirlength: intFuture错误码索引
getCacheFileCount—Future错误码索引
getMaxCacheFileCount—Future错误码索引
getMaxCacheFileSize—Future错误码索引
getMediaPlayerCacheManager—MediaPlayerCacheManager错误码索引
removeAllCaches—Future错误码索引
removeCacheByUriuri: Stringuture错误码索引
removeOldCache—Future错误码索引
setCacheDirpath: StringFuture错误码索引
setMaxCacheFileCountcount: intFuture错误码索引
setMaxCacheFileSizecacheSize: intFuture错误码索引
MediaPlayerController 1 方法 / 0 属性
typescript
initialize(): Future

方法明细:1 / 1(参数、返回值、错误码)

方法参数返回值错误
initialize—Future错误码索引
MediaPlayerSourceObserver 11 方法 / 0 属性
typescript
onAudioVolumeIndication(volume: int): void
onMetaData(data: Uint8List, length: int): void
onPlayBufferUpdated(playCachedBuffer: int): void
onPlayerCacheStats(stats: CacheStatistics): void
onPlayerEvent(eventCode: MediaPlayerEvent, elapsedTime: int, message: String): void
onPlayerInfoUpdated(info: PlayerUpdatedInfo): void
onPlayerPlaybackStats(stats: PlayerPlaybackStats): void
onPlayerSourceStateChanged(state: MediaPlayerState, reason: MediaPlayerReason): void
onPlayerSrcInfoChanged(from: SrcInfo, to: SrcInfo): void
onPositionChanged(positionMs: int, timestampMs: int): void
onPreloadEvent(src: String, event: PlayerPreloadEvent): void

方法明细:11 / 11(参数、返回值、错误码)

方法参数返回值错误
onAudioVolumeIndicationvolume: intvoid错误码索引
onMetaDatadata: Uint8List, length: intvoid错误码索引
onPlayBufferUpdatedplayCachedBuffer: intvoid错误码索引
onPlayerCacheStatsstats: CacheStatisticsvoid错误码索引
onPlayerEventeventCode: MediaPlayerEvent, elapsedTime: int, message: Stringvoid错误码索引
onPlayerInfoUpdatedinfo: PlayerUpdatedInfovoid错误码索引
onPlayerPlaybackStatsstats: PlayerPlaybackStatsvoid错误码索引
onPlayerSourceStateChangedstate: MediaPlayerState, reason: MediaPlayerReasonvoid错误码索引
onPlayerSrcInfoChangedfrom: SrcInfo, to: SrcInfovoid错误码索引
onPositionChangedpositionMs: int, timestampMs: intvoid错误码索引
onPreloadEventsrc: String, event: PlayerPreloadEventvoid错误码索引
MediaPlayerVideoFrameObserver 1 方法 / 0 属性
typescript
onFrame(frame: VideoFrame): void

方法明细:1 / 1(参数、返回值、错误码)

方法参数返回值错误
onFrameframe: VideoFramevoid错误码索引
MediaRecorder 3 方法 / 0 属性
typescript
setMediaRecorderObserver(callback: RtcConnection connection,required MediaRecorderObserver): Future
startRecording(config: MediaRecorderConfiguration): Future
stopRecording(): Future

方法明细:3 / 3(参数、返回值、错误码)

方法参数返回值错误
setMediaRecorderObservercallback: RtcConnection connection,required MediaRecorderObserverFuture错误码索引
startRecordingconfig: MediaRecorderConfigurationFuture错误码索引
stopRecording—Future错误码索引
MediaRecorderConfiguration 0 方法 / 11 属性
属性类型只读
storagePathString?否
containerFormatMediaRecorderContainerFormat?否
streamTypeMediaRecorderStreamType?否
maxDurationMsint?否
recorderInfoUpdateIntervalint?否
widthint?否
heightint?否
fpsint?否
sampleRateint?否
channelNumint?否
videoSourceTypeVideoSourceType?否
MediaRecorderObserver 2 方法 / 0 属性
typescript
onRecorderInfoUpdated(channelId: String, uid: int, info: RecorderInfo): void
onRecorderStateChanged(channelId: String, uid: int, state: RecorderState, reason: RecorderReasonCode): void

方法明细:2 / 2(参数、返回值、错误码)

方法参数返回值错误
onRecorderInfoUpdatedchannelId: String, uid: int, info: RecorderInfovoid错误码索引
onRecorderStateChangedchannelId: String, uid: int, state: RecorderState, reason: RecorderReasonCodevoid错误码索引
MediaSource 0 方法 / 8 属性
属性类型只读
urlString?否
uriString?否
startPosint?否
autoPlaybool?否
enableCachebool?否
enableMultiAudioTrackunknown否
isAgoraSourcebool?否
isLiveSourcebool?否
Metadata 0 方法 / 5 属性
属性类型只读
channelIdString?否
uidint?否
sizeint?否
bufferUint8List?否
timeStampMsint?否
MetadataObserver 1 方法 / 0 属性
typescript
onMetadataReceived(metadata: Metadata): void

方法明细:1 / 1(参数、返回值、错误码)

方法参数返回值错误
onMetadataReceivedmetadata: Metadatavoid错误码索引
MultipathStats 0 方法 / 8 属性
属性类型只读
lanTxBytesint?否
lanRxBytesint?否
wifiTxBytesint?否
wifiRxBytesint?否
mobileTxBytesint?否
mobileRxBytesint?否
activePathNumint?否
pathStatsList ?否
Music 0 方法 / 12 属性
属性类型只读
songCodeint?否
nameString?否
singerString?否
posterString?否
releaseTimeString?否
typeint?否
pitchTypeint?否
durationSint?否
lyricListList ?否
climaxSegmentListList ?否
lyricCountint?否
climaxSegmentCountint?否
MusicCacheInfo 0 方法 / 2 属性
属性类型只读
songCodeint?否
statusMusicCacheStatusType?否
MusicChartCollection 2 方法 / 0 属性
typescript
get(index: int): Future
getCount(): Future

方法明细:2 / 2(参数、返回值、错误码)

方法参数返回值错误
getindex: intFuture错误码索引
getCount—Future错误码索引
MusicChartInfo 0 方法 / 2 属性
属性类型只读
chartNameString?否
idint?否
MusicCollection 5 方法 / 0 属性
typescript
getCount(): int
getMusic(index: int): Music
getPage(): int
getPageSize(): int
getTotal(): int

方法明细:5 / 5(参数、返回值、错误码)

方法参数返回值错误
getCount—int错误码索引
getMusicindex: intMusic错误码索引
getPage—int错误码索引
getPageSize—int错误码索引
getTotal—int错误码索引
MusicContentCenter 17 方法 / 0 属性
typescript
createMusicPlayer(): Future
destroyMusicPlayer(musicPlayer: MusicPlayer): Future
getCaches(cacheInfoSize: int): Future ->
getInternalSongCode(jsonOption: int songCode,required String): Future
getLyric(null: int songCode,int lyricType = 0): Future
getMusicCharts(): Future
getMusicCollectionByMusicChartId(jsonOption?: int musicChartId,required int page,required int pageSize,String?): Future
getSongSimpleInfo(songCode: int): Future
initialize(configuration: MusicContentCenterConfiguration): Future
isPreloaded(songCode: int): Future
preload(songCode: int): Future
registerEventHandler(eventHandler: MusicContentCenterEventHandler): void
release(): Future
removeCache(songCode: int): Future
renewToken(token: String): Future
searchMusic(jsonOption?: String keyWord,required int page,required int pageSize,String?): Future
unregisterEventHandler(): void

方法明细:17 / 17(参数、返回值、错误码)

方法参数返回值错误
createMusicPlayer—Future错误码索引
destroyMusicPlayermusicPlayer: MusicPlayerFuture错误码索引
getCachescacheInfoSize: intFuture ->错误码索引
getInternalSongCodejsonOption: int songCode,required StringFuture错误码索引
getLyricnull: int songCode,int lyricType = 0Future错误码索引
getMusicCharts—Future错误码索引
getMusicCollectionByMusicChartIdjsonOption?: int musicChartId,required int page,required int pageSize,String?Future错误码索引
getSongSimpleInfosongCode: intFuture错误码索引
initializeconfiguration: MusicContentCenterConfigurationFuture错误码索引
isPreloadedsongCode: intFuture错误码索引
preloadsongCode: intFuture错误码索引
registerEventHandlereventHandler: MusicContentCenterEventHandlervoid错误码索引
release—Future错误码索引
removeCachesongCode: intFuture错误码索引
renewTokentoken: StringFuture错误码索引
searchMusicjsonOption?: String keyWord,required int page,required int pageSize,String?Future错误码索引
unregisterEventHandler—void错误码索引
MusicContentCenterConfiguration 0 方法 / 4 属性
属性类型只读
appIdString?否
tokenString?否
mccUidint?否
maxCacheSizeint?否
MusicContentCenterEventHandler 5 方法 / 0 属性
typescript
onLyricResult(requestId: String, songCode: int, lyricUrl: String, reason: MusicContentCenterStateReason): void
onMusicChartsResult(requestId: String, result: List, reason: MusicContentCenterStateReason): void
onMusicCollectionResult(requestId: String, result: MusicCollection, reason: MusicContentCenterStateReason): void
onPreLoadEvent(requestId: String, songCode: int, percent: int, lyricUrl: String, state: PreloadState, reason: MusicContentCenterStateReason): void
onSongSimpleInfoResult(requestId: String, songCode: int, simpleInfo: String, reason: MusicContentCenterStateReason): void

方法明细:5 / 5(参数、返回值、错误码)

方法参数返回值错误
onLyricResultrequestId: String, songCode: int, lyricUrl: String, reason: MusicContentCenterStateReasonvoid错误码索引
onMusicChartsResultrequestId: String, result: List, reason: MusicContentCenterStateReasonvoid错误码索引
onMusicCollectionResultrequestId: String, result: MusicCollection, reason: MusicContentCenterStateReasonvoid错误码索引
onPreLoadEventrequestId: String, songCode: int, percent: int, lyricUrl: String, state: PreloadState, reason: MusicContentCenterStateReasonvoid错误码索引
onSongSimpleInfoResultrequestId: String, songCode: int, simpleInfo: String, reason: MusicContentCenterStateReasonvoid错误码索引
MusicPlayer 2 方法 / 0 属性
typescript
openWithSongCode(null: int songCode,int startPos = 0): Future
setPlayMode(mode: MusicPlayMode): Future

方法明细:2 / 2(参数、返回值、错误码)

方法参数返回值错误
openWithSongCodenull: int songCode,int startPos = 0Future错误码索引
setPlayModemode: MusicPlayModeFuture错误码索引
PathStats 0 方法 / 3 属性
属性类型只读
typeMultipathType?否
txKBitRateint?否
rxKBitRateint?否
PlayerPlaybackStats 0 方法 / 4 属性
属性类型只读
videoFpsint?否
videoBitrateInKbpsint?否
audioBitrateInKbpsint?否
totalBitrateInKbpsint?否
PlayerStreamInfo 0 方法 / 13 属性
属性类型只读
streamIndexint?否
streamTypeMediaStreamType?否
codecNameString?否
languageString?否
videoFrameRateint?否
videoBitRateint?否
videoWidthint?否
videoHeightint?否
videoRotationint?否
audioSampleRateint?否
audioChannelsint?否
audioBitsPerSampleint?否
durationint?否
PlayerUpdatedInfo 0 方法 / 6 属性
属性类型只读
deviceIdString?否
videoHeightunknown否
videoWidthunknown否
audioSampleRateunknown否
audioChannelsunknown否
audioBitsPerSampleunknown否
RecorderInfo 0 方法 / 3 属性
属性类型只读
fileNameunknown否
durationMsunknown否
fileSizeunknown否
RecorderStreamInfo 0 方法 / 3 属性
属性类型只读
channelIdString?否
uidint?否
typeRecorderStreamType?否
Rectangle 0 方法 / 4 属性
属性类型只读
xint?否
yint?否
widthint?否
heightint?否
RemoteAudioStats 0 方法 / 16 属性
属性类型只读
uidint?否
qualityint?否
networkTransportDelayint?否
jitterBufferDelayint?否
audioLossRateint?否
numChannelsint?否
receivedSampleRateint?否
receivedBitrateint?否
totalFrozenTimeint?否
frozenRateint?否
totalActiveTimeint?否
publishDurationint?否
qoeQualityint?否
qualityChangedReasonint?否
mosValueint?否
e2eDelayint?否
RemoteVideoStats 0 方法 / 17 属性
属性类型只读
uidint?否
delayint?否
e2eDelayint?否
widthint?否
heightint?否
receivedBitrateint?否
decoderOutputFrameRateint?否
rendererOutputFrameRateint?否
frameLossRateint?否
packetLossRateint?否
rxStreamTypeVideoStreamType?否
totalFrozenTimeint?否
frozenRateint?否
totalActiveTimeint?否
publishDurationint?否
avSyncTimeMsint?否
mosValueint?否
RemoteVoicePositionInfo 0 方法 / 1 属性
属性类型只读
positionunknown否
RtcConnection 0 方法 / 2 属性
属性类型只读
channelIdString?否
localUidint?否
RtcEngine 272 方法 / 0 属性
typescript
addVideoWatermark(options: String watermarkUrl,required WatermarkOptions): Future
addVideoWatermarkWithConfig(configs: WatermarkConfig): Future
adjustAudioMixingPlayoutVolume(volume: int): Future
adjustAudioMixingPublishVolume(volume: int): Future
adjustAudioMixingVolume(volume: int): Future
adjustCustomAudioPlayoutVolume(volume: int trackId,required int): Future
adjustCustomAudioPublishVolume(volume: int trackId,required int): Future
adjustLoopbackSignalVolume(volume: int): Future
adjustPlaybackSignalVolume(volume: int): Future
adjustRecordingSignalVolume(volume: int): Future
adjustUserPlaybackSignalVolume(volume: int uid,required int): Future
clearVideoWatermarks(): Future
complain(description: String callId,required String): Future
configRhythmPlayer(config: AgoraRhythmPlayerConfig): Future
createAgoraRtcEngine(): RtcEngine
createCustomVideoTrack(): Future
createDataStream(config: DataStreamConfig): Future
createMediaPlayer(): Future
createMediaRecorder(info: RecorderStreamInfo): Future
createVideoEffectObject(null: String bundlePath,MediaSourceType type = MediaSourceType.primaryCameraSource): Future
destroyCustomVideoTrack(videoTrackId: int): Future
destroyMediaPlayer(mediaPlayer: MediaPlayer): Future
destroyMediaRecorder(mediaRecorder: MediaRecorder): Future
destroyVideoEffectObject(videoEffectObject: VideoEffectObject): Future
disableAudio(): Future
disableAudioSpectrumMonitor(): Future
disableVideo(): Future
enableAudio(): Future
enableAudioSpectrumMonitor(null: int intervalInMS = 100): Future
enableAudioVolumeIndication(reportVad: int interval,required int smooth,required bool): Future
enableCameraCenterStage(enabled: bool): Future
enableContentInspect(config: bool enabled,required ContentInspectConfig): Future
enableCustomAudioLocalPlayback(enabled: int trackId,required bool): Future
enableDualStreamMode(streamConfig?: bool enabled,SimulcastStreamConfig?): Future
enableEncryption(config: bool enabled,required EncryptionConfig): Future
enableExtension(null: String provider,required String extension,bool enable = true,MediaSourceType type = MediaSourceType.unknownMediaSource): Future
enableFaceDetection(enabled: bool): Future
enableInEarMonitoring(includeAudioFilters: bool enabled,required EarMonitoringFilterType): Future
enableInstantMediaRendering(): Future
enableLocalAudio(enabled: bool): Future
enableLocalVideo(enabled: bool): Future
enableLoopbackRecording(deviceName?: bool enabled,String?): Future
enableMultiCamera(config: bool enabled,required CameraCapturerConfiguration): Future
enableSoundPositionIndication(enabled: bool): Future
enableSpatialAudio(enabled: bool): Future
enableVideo(): Future
enableVideoImageSource(options: bool enable,required ImageTrackOptions): Future
enableVirtualBackground(null: bool enabled,required VirtualBackgroundSource backgroundSource,required SegmentationProperty segproperty,MediaSourceType type = MediaSourceType.primaryCameraSource): Future
enableVoiceAITuner(type: bool enabled,required VoiceAiTunerType): Future
enableWebSdkInteroperability(enabled: bool): Future
getAudioDeviceInfo(): Future
getAudioDeviceManager(): AudioDeviceManager
getAudioMixingCurrentPosition(): Future
getAudioMixingDuration(): Future
getAudioMixingPlayoutVolume(): Future
getAudioMixingPublishVolume(): Future
getAudioTrackCount(): Future
getCallId(): Future
getCameraMaxZoomFactor(): Future
getConnectionState(): Future
getCurrentMonotonicTimeInMs(): Future
getEffectCurrentPosition(soundId: int): Future
getEffectDuration(filePath: String): Future
getEffectsVolume(): Future
getErrorDescription(code: int): Future
getExtensionProperty(null: String provider,required String extension,required String key,required int bufLen,MediaSourceType type = MediaSourceType.unknownMediaSource): Future
getFaceShapeAreaOptions(null: FaceShapeArea shapeArea,MediaSourceType type = MediaSourceType.primaryCameraSource): Future
getFaceShapeBeautyOptions(null: MediaSourceType type = MediaSourceType.primaryCameraSource): Future
getLocalSpatialAudioEngine(): LocalSpatialAudioEngine
getMediaEngine(): MediaEngine
getMusicContentCenter(): MusicContentCenter
getNativeHandle(): Future
getNetworkType(): Future
getNtpWallTimeInMs(): Future
getScreenCaptureSources(includeScreen: Size thumbSize,required Size iconSize,required bool): Future ->
getUserInfoByUid(uid: int): Future
getUserInfoByUserAccount(userAccount: String): Future
getVersion(): Future
getVideoDeviceManager(): VideoDeviceManager
getVolumeOfEffect(soundId: int): Future
initialize(context: RtcEngineContext): Future
isCameraAutoExposureFaceModeSupported(): Future
isCameraAutoFocusFaceModeSupported(): Future
isCameraCenterStageSupported(): Future
isCameraExposurePositionSupported(): Future
isCameraExposureSupported(): Future
isCameraFaceDetectSupported(): Future
isCameraFocusSupported(): Future
isCameraTorchSupported(): Future
isCameraZoomSupported(): Future
isFeatureAvailableOnDevice(type: FeatureType): Future
isSpeakerphoneEnabled(): Future
joinChannel(options: String token,required String channelId,required int uid,required ChannelMediaOptions): Future
joinChannelWithUserAccount(options?: String token,required String channelId,required String userAccount,ChannelMediaOptions?): Future
joinChannelWithUserAccountEx(options: String token,required String channelId,required String userAccount,required ChannelMediaOptions): Future
leaveChannel(options?: LeaveChannelOptions?): Future
loadExtensionProvider(false: String path,bool unloadAfterUse =): Future
muteAllRemoteAudioStreams(mute: bool): Future
muteAllRemoteVideoStreams(mute: bool): Future
muteLocalAudioStream(mute: bool): Future
muteLocalVideoStream(mute: bool): Future
muteRecordingSignal(mute: bool): Future
muteRemoteAudioStream(mute: int uid,required bool): Future
muteRemoteVideoStream(mute: int uid,required bool): Future
pauseAllChannelMediaRelay(): Future
pauseAllEffects(): Future
pauseAudioMixing(): Future
pauseEffect(soundId: int): Future
playAllEffects(false: int loopCount,required double pitch,required double pan,required int gain,bool publish =): Future
playEffect(null: int soundId,required String filePath,required int loopCount,required double pitch,required double pan,required int gain,bool publish = false,int startPos = 0): Future
preloadChannel(uid: String token,required String channelId,required int): Future
preloadChannelWithUserAccount(userAccount: String token,required String channelId,required String): Future
preloadEffect(null: int soundId,required String filePath,int startPos = 0): Future
queryCameraFocalLengthCapability(): Future ->
queryCodecCapability(size: int): Future ->
queryDeviceScore(): Future
queryScreenCaptureCapability(): Future
rate(description: String callId,required int rating,required String): Future
registerAudioEncodedFrameObserver(observer: AudioEncodedFrameObserverConfig config,required AudioEncodedFrameObserver): void
registerAudioSpectrumObserver(observer: AudioSpectrumObserver): void
registerEventHandler(eventHandler: RtcEngineEventHandler): void
registerExtension(null: String provider,required String extension,MediaSourceType type = MediaSourceType.unknownMediaSource): Future
registerLocalUserAccount(userAccount: String appId,required String): Future
registerMediaMetadataObserver(type: MetadataObserver observer,required MetadataType): void
release(false: bool sync =): Future
removeVideoWatermark(id: String): Future
renewToken(token: String): Future
resumeAllChannelMediaRelay(): Future
resumeAllEffects(): Future
resumeAudioMixing(): Future
resumeEffect(soundId: int): Future
selectAudioTrack(index: int): Future
sendCustomReportMessage(value: String id,required String category,required String event,required String label,required int): Future
sendMetaData(sourceType: Metadata metadata,required VideoSourceType): Future
sendStreamMessage(length: int streamId,required Uint8List data,required int): Future
setAINSMode(mode: bool enabled,required AudioAinsMode): Future
setAVSyncSource(uid: String channelId,required int): Future
setAdvancedAudioOptions(options: AdvancedAudioOptions): Future
setAudioEffectParameters(param2: AudioEffectPreset preset,required int param1,required int): Future
setAudioEffectPreset(preset: AudioEffectPreset): Future
setAudioMixingDualMonoMode(mode: AudioMixingDualMonoMode): Future
setAudioMixingPitch(pitch: int): Future
setAudioMixingPlaybackSpeed(speed: int): Future
setAudioMixingPosition(pos: int): Future
setAudioProfile(null: AudioProfileType profile,AudioScenarioType scenario = AudioScenarioType.audioScenarioDefault): Future
setAudioScenario(scenario: AudioScenarioType): Future
setAudioSessionOperationRestriction(restriction: AudioSessionOperationRestriction): Future
setBeautyEffectOptions(null: bool enabled,required BeautyOptions options,MediaSourceType type = MediaSourceType.primaryCameraSource): Future
setCameraAutoExposureFaceModeEnabled(enabled: bool): Future
setCameraAutoFocusFaceModeEnabled(enabled: bool): Future
setCameraCapturerConfiguration(config: CameraCapturerConfiguration): Future
setCameraDeviceOrientation(orientation: VideoSourceType type,required VideoOrientation): Future
setCameraExposureFactor(factor: double): Future
setCameraExposurePosition(positionYinView: double positionXinView,required double): Future
setCameraFocusPositionInPreview(positionY: double positionX,required double): Future
setCameraStabilizationMode(mode: CameraStabilizationMode): Future
setCameraTorchOn(isOn: bool): Future
setCameraZoomFactor(factor: double): Future
setChannelProfile(profile: ChannelProfileType): Future
setClientRole(options?: ClientRoleType role,ClientRoleOptions?): Future
setCloudProxy(proxyType: CloudProxyType): Future
setColorEnhanceOptions(null: bool enabled,required ColorEnhanceOptions options,MediaSourceType type = MediaSourceType.primaryCameraSource): Future
setDefaultAudioRouteToSpeakerphone(defaultToSpeaker: bool): Future
setDualStreamMode(streamConfig?: SimulcastStreamMode mode,SimulcastStreamConfig?): Future
setEarMonitoringAudioFrameParameters(samplesPerCall: int sampleRate,required int channel,required RawAudioFrameOpModeType mode,required int): Future
setEffectPosition(pos: int soundId,required int): Future
setEffectsVolume(volume: int): Future
setEnableSpeakerphone(speakerOn: bool): Future
setExtensionProperty(null: String provider,required String extension,required String key,required String value,MediaSourceType type = MediaSourceType.unknownMediaSource): Future
setExtensionProviderProperty(value: String provider,required String key,required String): Future
setExternalMediaProjection(mediaProjection: int): Future
setExternalRemoteEglContext(eglContext: int): Future
setFaceShapeAreaOptions(null: FaceShapeAreaOptions options,MediaSourceType type = MediaSourceType.primaryCameraSource): Future
setFaceShapeBeautyOptions(null: bool enabled,required FaceShapeBeautyOptions options,MediaSourceType type = MediaSourceType.primaryCameraSource): Future
setFilterEffectOptions(null: bool enabled,required FilterEffectOptions options,MediaSourceType type = MediaSourceType.primaryCameraSource): Future
setHeadphoneEQParameters(highGain: int lowGain,required int): Future
setHeadphoneEQPreset(preset: HeadphoneEqualizerPreset): Future
setInEarMonitoringVolume(volume: int): Future
setLocalAccessPoint(config: LocalAccessPointConfiguration): Future
setLocalRenderMode(null: RenderModeType renderMode,VideoMirrorModeType mirrorMode = VideoMirrorModeType.videoMirrorModeAuto): Future
setLocalRenderTargetFps(targetFps: VideoSourceType sourceType,required int): Future
setLocalVideoMirrorMode(mirrorMode: VideoMirrorModeType): Future
setLocalVoiceEqualization(bandGain: AudioEqualizationBandFrequency bandFrequency,required int): Future
setLocalVoiceFormant(formantRatio: double): Future
setLocalVoicePitch(pitch: double): Future
setLocalVoiceReverb(value: AudioReverbType reverbKey,required int): Future
setLogFile(filePath: String): Future
setLogFileSize(fileSizeInKBytes: int): Future
setLogFilter(filter: LogFilterType): Future
setLogLevel(level: LogLevel): Future
setLowlightEnhanceOptions(null: bool enabled,required LowlightEnhanceOptions options,MediaSourceType type = MediaSourceType.primaryCameraSource): Future
setMaxMetadataSize(size: int): Future
setMixedAudioFrameParameters(samplesPerCall: int sampleRate,required int channel,required int): Future
setParameters(parameters: String): Future
setPlaybackAudioFrameBeforeMixingParameters(samplesPerCall: int sampleRate,required int channel {required int sampleRate,required int): Future
setPlaybackAudioFrameParameters(samplesPerCall: int sampleRate,required int channel,required RawAudioFrameOpModeType mode,required int): Future
setRecordingAudioFrameParameters(samplesPerCall: int sampleRate,required int channel,required RawAudioFrameOpModeType mode,required int): Future
setRemoteDefaultVideoStreamType(streamType: VideoStreamType): Future
setRemoteRenderMode(mirrorMode: int uid,required RenderModeType renderMode,required VideoMirrorModeType): Future
setRemoteRenderTargetFps(targetFps: int): Future
setRemoteSubscribeFallbackOption(option: StreamFallbackOptions): Future
setRemoteUserSpatialAudioParams(params: int uid,required SpatialAudioParams): Future
setRemoteVideoStreamType(streamType: int uid,required VideoStreamType): Future
setRemoteVideoSubscriptionOptions(options: int uid,required VideoSubscriptionOptions): Future
setRemoteVoicePosition(gain: int uid,required double pan,required double): Future
setRouteInCommunicationMode(route: int): Future
setScreenCaptureContentHint(contentHint: VideoContentHint): Future
setScreenCaptureScenario(screenScenario: ScreenScenarioType): Future
setSubscribeAudioAllowlist(uidNumber: List uidList,required int): Future
setSubscribeAudioBlocklist(uidNumber: List uidList,required int): Future
setSubscribeVideoAllowlist(uidNumber: List uidList,required int): Future
setSubscribeVideoBlocklist(uidNumber: List uidList,required int): Future
setVideoDenoiserOptions(null: bool enabled,required VideoDenoiserOptions options,MediaSourceType type = MediaSourceType.primaryCameraSource): Future
setVideoEncoderConfiguration(config: VideoEncoderConfiguration): Future
setVideoScenario(scenarioType: VideoApplicationScenarioType): Future
setVoiceBeautifierParameters(param2: VoiceBeautifierPreset preset,required int param1,required int): Future
setVoiceBeautifierPreset(preset: VoiceBeautifierPreset): Future
setVoiceConversionPreset(preset: VoiceConversionPreset): Future
setVolumeOfEffect(volume: int soundId,required int): Future
setupLocalVideo(canvas: VideoCanvas): Future
setupRemoteVideo(canvas: VideoCanvas): Future
startAudioMixing(null: String filePath,required bool loopback,required int cycle,int startPos = 0): Future
startAudioRecording(config: AudioRecordingConfiguration): Future
startCameraCapture(config: VideoSourceType sourceType,required CameraCapturerConfiguration): Future
startEchoTest(config: EchoTestConfiguration): Future
startLastmileProbeTest(config: LastmileProbeConfig): Future
startLocalAudioMixer(config: LocalAudioMixerConfiguration): Future
startLocalVideoTranscoder(config: LocalTranscoderConfiguration): Future
startMediaRenderingTracing(): Future
startOrUpdateChannelMediaRelay(configuration: ChannelMediaRelayConfiguration): Future
startPreview(null: VideoSourceType sourceType = VideoSourceType.videoSourceCameraPrimary): Future
startPreviewWithoutSourceType(): Future
startRhythmPlayer(config: String sound1,required String sound2,required AgoraRhythmPlayerConfig): Future
startRtmpStreamWithTranscoding(transcoding: String url,required LiveTranscoding): Future
startRtmpStreamWithoutTranscoding(url: String): Future
startScreenCapture(captureParams: ScreenCaptureParameters2): Future
startScreenCaptureByDisplayId(captureParams: int displayId,required Rectangle regionRect,required ScreenCaptureParameters): Future
startScreenCaptureByScreenRect(captureParams: Rectangle screenRect,required Rectangle regionRect,required ScreenCaptureParameters): Future
startScreenCaptureBySourceType(config: VideoSourceType sourceType,required ScreenCaptureConfiguration): Future
startScreenCaptureByWindowId(captureParams: int windowId,required Rectangle regionRect,required ScreenCaptureParameters): Future
stopAllEffects(): Future
stopAudioMixing(): Future
stopAudioRecording(): Future
stopCameraCapture(sourceType: VideoSourceType): Future
stopChannelMediaRelay(): Future
stopEchoTest(): Future
stopEffect(soundId: int): Future
stopLastmileProbeTest(): Future
stopLocalAudioMixer(): Future
stopLocalVideoTranscoder(): Future
stopPreview(null: VideoSourceType sourceType = VideoSourceType.videoSourceCameraPrimary): Future
stopRhythmPlayer(): Future
stopRtmpStream(url: String): Future
stopScreenCapture(): Future
stopScreenCaptureBySourceType(sourceType: VideoSourceType): Future
switchCamera(): Future
takeSnapshot(filePath: int uid,required String): Future
takeSnapshotWithConfig(config: int uid,required SnapshotConfig): Future
unloadAllEffects(): Future
unloadEffect(soundId: int): Future
unregisterAudioEncodedFrameObserver(observer: AudioEncodedFrameObserver): void
unregisterAudioSpectrumObserver(observer: AudioSpectrumObserver): void
unregisterEventHandler(eventHandler: RtcEngineEventHandler): void
unregisterMediaMetadataObserver(type: MetadataObserver observer,required MetadataType): void
updateChannelMediaOptions(options: ChannelMediaOptions): Future
updateLocalAudioMixerConfiguration(config: LocalAudioMixerConfiguration): Future
updateLocalTranscoderConfiguration(config: LocalTranscoderConfiguration): Future
updatePreloadChannelToken(token: String): Future
updateRtmpTranscoding(transcoding: LiveTranscoding): Future
updateScreenCapture(captureParams: ScreenCaptureParameters2): Future
updateScreenCaptureParameters(captureParams: ScreenCaptureParameters): Future
updateScreenCaptureRegion(regionRect: Rectangle): Future

方法明细:272 / 272(参数、返回值、错误码)

方法参数返回值错误
addVideoWatermarkoptions: String watermarkUrl,required WatermarkOptionsFuture错误码索引
addVideoWatermarkWithConfigconfigs: WatermarkConfigFuture错误码索引
adjustAudioMixingPlayoutVolumevolume: intFuture错误码索引
adjustAudioMixingPublishVolumevolume: intFuture错误码索引
adjustAudioMixingVolumevolume: intFuture错误码索引
adjustCustomAudioPlayoutVolumevolume: int trackId,required intFuture错误码索引
adjustCustomAudioPublishVolumevolume: int trackId,required intFuture错误码索引
adjustLoopbackSignalVolumevolume: intFuture错误码索引
adjustPlaybackSignalVolumevolume: intFuture错误码索引
adjustRecordingSignalVolumevolume: intFuture错误码索引
adjustUserPlaybackSignalVolumevolume: int uid,required intFuture错误码索引
clearVideoWatermarks—Future错误码索引
complaindescription: String callId,required StringFuture错误码索引
configRhythmPlayerconfig: AgoraRhythmPlayerConfigFuture错误码索引
createAgoraRtcEngine—RtcEngine错误码索引
createCustomVideoTrack—Future错误码索引
createDataStreamconfig: DataStreamConfigFuture错误码索引
createMediaPlayer—Future错误码索引
createMediaRecorderinfo: RecorderStreamInfoFuture错误码索引
createVideoEffectObjectnull: String bundlePath,MediaSourceType type = MediaSourceType.primaryCameraSourceFuture错误码索引
destroyCustomVideoTrackvideoTrackId: intFuture错误码索引
destroyMediaPlayermediaPlayer: MediaPlayerFuture错误码索引
destroyMediaRecordermediaRecorder: MediaRecorderFuture错误码索引
destroyVideoEffectObjectvideoEffectObject: VideoEffectObjectFuture错误码索引
disableAudio—Future错误码索引
disableAudioSpectrumMonitor—Future错误码索引
disableVideo—Future错误码索引
enableAudio—Future错误码索引
enableAudioSpectrumMonitornull: int intervalInMS = 100Future错误码索引
enableAudioVolumeIndicationreportVad: int interval,required int smooth,required boolFuture错误码索引
enableCameraCenterStageenabled: boolFuture错误码索引
enableContentInspectconfig: bool enabled,required ContentInspectConfigFuture错误码索引
enableCustomAudioLocalPlaybackenabled: int trackId,required boolFuture错误码索引
enableDualStreamModestreamConfig?: bool enabled,SimulcastStreamConfig?Future错误码索引
enableEncryptionconfig: bool enabled,required EncryptionConfigFuture错误码索引
enableExtensionnull: String provider,required String extension,bool enable = true,MediaSourceType type = MediaSourceType.unknownMediaSourceFuture错误码索引
enableFaceDetectionenabled: boolFuture错误码索引
enableInEarMonitoringincludeAudioFilters: bool enabled,required EarMonitoringFilterTypeFuture错误码索引
enableInstantMediaRendering—Future错误码索引
enableLocalAudioenabled: boolFuture错误码索引
enableLocalVideoenabled: boolFuture错误码索引
enableLoopbackRecordingdeviceName?: bool enabled,String?Future错误码索引
enableMultiCameraconfig: bool enabled,required CameraCapturerConfigurationFuture错误码索引
enableSoundPositionIndicationenabled: boolFuture错误码索引
enableSpatialAudioenabled: boolFuture错误码索引
enableVideo—Future错误码索引
enableVideoImageSourceoptions: bool enable,required ImageTrackOptionsFuture错误码索引
enableVirtualBackgroundnull: bool enabled,required VirtualBackgroundSource backgroundSource,required SegmentationProperty segproperty,MediaSourceType type = MediaSourceType.primaryCameraSourceFuture错误码索引
enableVoiceAITunertype: bool enabled,required VoiceAiTunerTypeFuture错误码索引
enableWebSdkInteroperabilityenabled: boolFuture错误码索引
getAudioDeviceInfo—Future错误码索引
getAudioDeviceManager—AudioDeviceManager错误码索引
getAudioMixingCurrentPosition—Future错误码索引
getAudioMixingDuration—Future错误码索引
getAudioMixingPlayoutVolume—Future错误码索引
getAudioMixingPublishVolume—Future错误码索引
getAudioTrackCount—Future错误码索引
getCallId—Future错误码索引
getCameraMaxZoomFactor—Future错误码索引
getConnectionState—Future错误码索引
getCurrentMonotonicTimeInMs—Future错误码索引
getEffectCurrentPositionsoundId: intFuture错误码索引
getEffectDurationfilePath: StringFuture错误码索引
getEffectsVolume—Future错误码索引
getErrorDescriptioncode: intFuture错误码索引
getExtensionPropertynull: String provider,required String extension,required String key,required int bufLen,MediaSourceType type = MediaSourceType.unknownMediaSourceFuture错误码索引
getFaceShapeAreaOptionsnull: FaceShapeArea shapeArea,MediaSourceType type = MediaSourceType.primaryCameraSourceFuture错误码索引
getFaceShapeBeautyOptionsnull: MediaSourceType type = MediaSourceType.primaryCameraSourceFuture错误码索引
getLocalSpatialAudioEngine—LocalSpatialAudioEngine错误码索引
getMediaEngine—MediaEngine错误码索引
getMusicContentCenter—MusicContentCenter错误码索引
getNativeHandle—Future错误码索引
getNetworkType—Future错误码索引
getNtpWallTimeInMs—Future错误码索引
getScreenCaptureSourcesincludeScreen: Size thumbSize,required Size iconSize,required boolFuture ->错误码索引
getUserInfoByUiduid: intFuture错误码索引
getUserInfoByUserAccountuserAccount: StringFuture错误码索引
getVersion—Future错误码索引
getVideoDeviceManager—VideoDeviceManager错误码索引
getVolumeOfEffectsoundId: intFuture错误码索引
initializecontext: RtcEngineContextFuture错误码索引
isCameraAutoExposureFaceModeSupported—Future错误码索引
isCameraAutoFocusFaceModeSupported—Future错误码索引
isCameraCenterStageSupported—Future错误码索引
isCameraExposurePositionSupported—Future错误码索引
isCameraExposureSupported—Future错误码索引
isCameraFaceDetectSupported—Future错误码索引
isCameraFocusSupported—Future错误码索引
isCameraTorchSupported—Future错误码索引
isCameraZoomSupported—Future错误码索引
isFeatureAvailableOnDevicetype: FeatureTypeFuture错误码索引
isSpeakerphoneEnabled—Future错误码索引
joinChanneloptions: String token,required String channelId,required int uid,required ChannelMediaOptionsFuture错误码索引
joinChannelWithUserAccountoptions?: String token,required String channelId,required String userAccount,ChannelMediaOptions?Future错误码索引
joinChannelWithUserAccountExoptions: String token,required String channelId,required String userAccount,required ChannelMediaOptionsFuture错误码索引
leaveChanneloptions?: LeaveChannelOptions?Future错误码索引
loadExtensionProviderfalse: String path,bool unloadAfterUse =Future错误码索引
muteAllRemoteAudioStreamsmute: boolFuture错误码索引
muteAllRemoteVideoStreamsmute: boolFuture错误码索引
muteLocalAudioStreammute: boolFuture错误码索引
muteLocalVideoStreammute: boolFuture错误码索引
muteRecordingSignalmute: boolFuture错误码索引
muteRemoteAudioStreammute: int uid,required boolFuture错误码索引
muteRemoteVideoStreammute: int uid,required boolFuture错误码索引
pauseAllChannelMediaRelay—Future错误码索引
pauseAllEffects—Future错误码索引
pauseAudioMixing—Future错误码索引
pauseEffectsoundId: intFuture错误码索引
playAllEffectsfalse: int loopCount,required double pitch,required double pan,required int gain,bool publish =Future错误码索引
playEffectnull: int soundId,required String filePath,required int loopCount,required double pitch,required double pan,required int gain,bool publish = false,int startPos = 0Future错误码索引
preloadChanneluid: String token,required String channelId,required intFuture错误码索引
preloadChannelWithUserAccountuserAccount: String token,required String channelId,required StringFuture错误码索引
preloadEffectnull: int soundId,required String filePath,int startPos = 0Future错误码索引
queryCameraFocalLengthCapability—Future ->错误码索引
queryCodecCapabilitysize: intFuture ->错误码索引
queryDeviceScore—Future错误码索引
queryScreenCaptureCapability—Future错误码索引
ratedescription: String callId,required int rating,required StringFuture错误码索引
registerAudioEncodedFrameObserverobserver: AudioEncodedFrameObserverConfig config,required AudioEncodedFrameObservervoid错误码索引
registerAudioSpectrumObserverobserver: AudioSpectrumObservervoid错误码索引
registerEventHandlereventHandler: RtcEngineEventHandlervoid错误码索引
registerExtensionnull: String provider,required String extension,MediaSourceType type = MediaSourceType.unknownMediaSourceFuture错误码索引
registerLocalUserAccountuserAccount: String appId,required StringFuture错误码索引
registerMediaMetadataObservertype: MetadataObserver observer,required MetadataTypevoid错误码索引
releasefalse: bool sync =Future错误码索引
removeVideoWatermarkid: StringFuture错误码索引
renewTokentoken: StringFuture错误码索引
resumeAllChannelMediaRelay—Future错误码索引
resumeAllEffects—Future错误码索引
resumeAudioMixing—Future错误码索引
resumeEffectsoundId: intFuture错误码索引
selectAudioTrackindex: intFuture错误码索引
sendCustomReportMessagevalue: String id,required String category,required String event,required String label,required intFuture错误码索引
sendMetaDatasourceType: Metadata metadata,required VideoSourceTypeFuture错误码索引
sendStreamMessagelength: int streamId,required Uint8List data,required intFuture错误码索引
setAINSModemode: bool enabled,required AudioAinsModeFuture错误码索引
setAVSyncSourceuid: String channelId,required intFuture错误码索引
setAdvancedAudioOptionsoptions: AdvancedAudioOptionsFuture错误码索引
setAudioEffectParametersparam2: AudioEffectPreset preset,required int param1,required intFuture错误码索引
setAudioEffectPresetpreset: AudioEffectPresetFuture错误码索引
setAudioMixingDualMonoModemode: AudioMixingDualMonoModeFuture错误码索引
setAudioMixingPitchpitch: intFuture错误码索引
setAudioMixingPlaybackSpeedspeed: intFuture错误码索引
setAudioMixingPositionpos: intFuture错误码索引
setAudioProfilenull: AudioProfileType profile,AudioScenarioType scenario = AudioScenarioType.audioScenarioDefaultFuture错误码索引
setAudioScenarioscenario: AudioScenarioTypeFuture错误码索引
setAudioSessionOperationRestrictionrestriction: AudioSessionOperationRestrictionFuture错误码索引
setBeautyEffectOptionsnull: bool enabled,required BeautyOptions options,MediaSourceType type = MediaSourceType.primaryCameraSourceFuture错误码索引
setCameraAutoExposureFaceModeEnabledenabled: boolFuture错误码索引
setCameraAutoFocusFaceModeEnabledenabled: boolFuture错误码索引
setCameraCapturerConfigurationconfig: CameraCapturerConfigurationFuture错误码索引
setCameraDeviceOrientationorientation: VideoSourceType type,required VideoOrientationFuture错误码索引
setCameraExposureFactorfactor: doubleFuture错误码索引
setCameraExposurePositionpositionYinView: double positionXinView,required doubleFuture错误码索引
setCameraFocusPositionInPreviewpositionY: double positionX,required doubleFuture错误码索引
setCameraStabilizationModemode: CameraStabilizationModeFuture错误码索引
setCameraTorchOnisOn: boolFuture错误码索引
setCameraZoomFactorfactor: doubleFuture错误码索引
setChannelProfileprofile: ChannelProfileTypeFuture错误码索引
setClientRoleoptions?: ClientRoleType role,ClientRoleOptions?Future错误码索引
setCloudProxyproxyType: CloudProxyTypeFuture错误码索引
setColorEnhanceOptionsnull: bool enabled,required ColorEnhanceOptions options,MediaSourceType type = MediaSourceType.primaryCameraSourceFuture错误码索引
setDefaultAudioRouteToSpeakerphonedefaultToSpeaker: boolFuture错误码索引
setDualStreamModestreamConfig?: SimulcastStreamMode mode,SimulcastStreamConfig?Future错误码索引
setEarMonitoringAudioFrameParameterssamplesPerCall: int sampleRate,required int channel,required RawAudioFrameOpModeType mode,required intFuture错误码索引
setEffectPositionpos: int soundId,required intFuture错误码索引
setEffectsVolumevolume: intFuture错误码索引
setEnableSpeakerphonespeakerOn: boolFuture错误码索引
setExtensionPropertynull: String provider,required String extension,required String key,required String value,MediaSourceType type = MediaSourceType.unknownMediaSourceFuture错误码索引
setExtensionProviderPropertyvalue: String provider,required String key,required StringFuture错误码索引
setExternalMediaProjectionmediaProjection: intFuture错误码索引
setExternalRemoteEglContexteglContext: intFuture错误码索引
setFaceShapeAreaOptionsnull: FaceShapeAreaOptions options,MediaSourceType type = MediaSourceType.primaryCameraSourceFuture错误码索引
setFaceShapeBeautyOptionsnull: bool enabled,required FaceShapeBeautyOptions options,MediaSourceType type = MediaSourceType.primaryCameraSourceFuture错误码索引
setFilterEffectOptionsnull: bool enabled,required FilterEffectOptions options,MediaSourceType type = MediaSourceType.primaryCameraSourceFuture错误码索引
setHeadphoneEQParametershighGain: int lowGain,required intFuture错误码索引
setHeadphoneEQPresetpreset: HeadphoneEqualizerPresetFuture错误码索引
setInEarMonitoringVolumevolume: intFuture错误码索引
setLocalAccessPointconfig: LocalAccessPointConfigurationFuture错误码索引
setLocalRenderModenull: RenderModeType renderMode,VideoMirrorModeType mirrorMode = VideoMirrorModeType.videoMirrorModeAutoFuture错误码索引
setLocalRenderTargetFpstargetFps: VideoSourceType sourceType,required intFuture错误码索引
setLocalVideoMirrorModemirrorMode: VideoMirrorModeTypeFuture错误码索引
setLocalVoiceEqualizationbandGain: AudioEqualizationBandFrequency bandFrequency,required intFuture错误码索引
setLocalVoiceFormantformantRatio: doubleFuture错误码索引
setLocalVoicePitchpitch: doubleFuture错误码索引
setLocalVoiceReverbvalue: AudioReverbType reverbKey,required intFuture错误码索引
setLogFilefilePath: StringFuture错误码索引
setLogFileSizefileSizeInKBytes: intFuture错误码索引
setLogFilterfilter: LogFilterTypeFuture错误码索引
setLogLevellevel: LogLevelFuture错误码索引
setLowlightEnhanceOptionsnull: bool enabled,required LowlightEnhanceOptions options,MediaSourceType type = MediaSourceType.primaryCameraSourceFuture错误码索引
setMaxMetadataSizesize: intFuture错误码索引
setMixedAudioFrameParameterssamplesPerCall: int sampleRate,required int channel,required intFuture错误码索引
setParametersparameters: StringFuture错误码索引
setPlaybackAudioFrameBeforeMixingParameterssamplesPerCall: int sampleRate,required int channel {required int sampleRate,required intFuture错误码索引
setPlaybackAudioFrameParameterssamplesPerCall: int sampleRate,required int channel,required RawAudioFrameOpModeType mode,required intFuture错误码索引
setRecordingAudioFrameParameterssamplesPerCall: int sampleRate,required int channel,required RawAudioFrameOpModeType mode,required intFuture错误码索引
setRemoteDefaultVideoStreamTypestreamType: VideoStreamTypeFuture错误码索引
setRemoteRenderModemirrorMode: int uid,required RenderModeType renderMode,required VideoMirrorModeTypeFuture错误码索引
setRemoteRenderTargetFpstargetFps: intFuture错误码索引
setRemoteSubscribeFallbackOptionoption: StreamFallbackOptionsFuture错误码索引
setRemoteUserSpatialAudioParamsparams: int uid,required SpatialAudioParamsFuture错误码索引
setRemoteVideoStreamTypestreamType: int uid,required VideoStreamTypeFuture错误码索引
setRemoteVideoSubscriptionOptionsoptions: int uid,required VideoSubscriptionOptionsFuture错误码索引
setRemoteVoicePositiongain: int uid,required double pan,required doubleFuture错误码索引
setRouteInCommunicationModeroute: intFuture错误码索引
setScreenCaptureContentHintcontentHint: VideoContentHintFuture错误码索引
setScreenCaptureScenarioscreenScenario: ScreenScenarioTypeFuture错误码索引
setSubscribeAudioAllowlistuidNumber: List uidList,required intFuture错误码索引
setSubscribeAudioBlocklistuidNumber: List uidList,required intFuture错误码索引
setSubscribeVideoAllowlistuidNumber: List uidList,required intFuture错误码索引
setSubscribeVideoBlocklistuidNumber: List uidList,required intFuture错误码索引
setVideoDenoiserOptionsnull: bool enabled,required VideoDenoiserOptions options,MediaSourceType type = MediaSourceType.primaryCameraSourceFuture错误码索引
setVideoEncoderConfigurationconfig: VideoEncoderConfigurationFuture错误码索引
setVideoScenarioscenarioType: VideoApplicationScenarioTypeFuture错误码索引
setVoiceBeautifierParametersparam2: VoiceBeautifierPreset preset,required int param1,required intFuture错误码索引
setVoiceBeautifierPresetpreset: VoiceBeautifierPresetFuture错误码索引
setVoiceConversionPresetpreset: VoiceConversionPresetFuture错误码索引
setVolumeOfEffectvolume: int soundId,required intFuture错误码索引
setupLocalVideocanvas: VideoCanvasFuture错误码索引
setupRemoteVideocanvas: VideoCanvasFuture错误码索引
startAudioMixingnull: String filePath,required bool loopback,required int cycle,int startPos = 0Future错误码索引
startAudioRecordingconfig: AudioRecordingConfigurationFuture错误码索引
startCameraCaptureconfig: VideoSourceType sourceType,required CameraCapturerConfigurationFuture错误码索引
startEchoTestconfig: EchoTestConfigurationFuture错误码索引
startLastmileProbeTestconfig: LastmileProbeConfigFuture错误码索引
startLocalAudioMixerconfig: LocalAudioMixerConfigurationFuture错误码索引
startLocalVideoTranscoderconfig: LocalTranscoderConfigurationFuture错误码索引
startMediaRenderingTracing—Future错误码索引
startOrUpdateChannelMediaRelayconfiguration: ChannelMediaRelayConfigurationFuture错误码索引
startPreviewnull: VideoSourceType sourceType = VideoSourceType.videoSourceCameraPrimaryFuture错误码索引
startPreviewWithoutSourceType—Future错误码索引
startRhythmPlayerconfig: String sound1,required String sound2,required AgoraRhythmPlayerConfigFuture错误码索引
startRtmpStreamWithTranscodingtranscoding: String url,required LiveTranscodingFuture错误码索引
startRtmpStreamWithoutTranscodingurl: StringFuture错误码索引
startScreenCapturecaptureParams: ScreenCaptureParameters2Future错误码索引
startScreenCaptureByDisplayIdcaptureParams: int displayId,required Rectangle regionRect,required ScreenCaptureParametersFuture错误码索引
startScreenCaptureByScreenRectcaptureParams: Rectangle screenRect,required Rectangle regionRect,required ScreenCaptureParametersFuture错误码索引
startScreenCaptureBySourceTypeconfig: VideoSourceType sourceType,required ScreenCaptureConfigurationFuture错误码索引
startScreenCaptureByWindowIdcaptureParams: int windowId,required Rectangle regionRect,required ScreenCaptureParametersFuture错误码索引
stopAllEffects—Future错误码索引
stopAudioMixing—Future错误码索引
stopAudioRecording—Future错误码索引
stopCameraCapturesourceType: VideoSourceTypeFuture错误码索引
stopChannelMediaRelay—Future错误码索引
stopEchoTest—Future错误码索引
stopEffectsoundId: intFuture错误码索引
stopLastmileProbeTest—Future错误码索引
stopLocalAudioMixer—Future错误码索引
stopLocalVideoTranscoder—Future错误码索引
stopPreviewnull: VideoSourceType sourceType = VideoSourceType.videoSourceCameraPrimaryFuture错误码索引
stopRhythmPlayer—Future错误码索引
stopRtmpStreamurl: StringFuture错误码索引
stopScreenCapture—Future错误码索引
stopScreenCaptureBySourceTypesourceType: VideoSourceTypeFuture错误码索引
switchCamera—Future错误码索引
takeSnapshotfilePath: int uid,required StringFuture错误码索引
takeSnapshotWithConfigconfig: int uid,required SnapshotConfigFuture错误码索引
unloadAllEffects—Future错误码索引
unloadEffectsoundId: intFuture错误码索引
unregisterAudioEncodedFrameObserverobserver: AudioEncodedFrameObservervoid错误码索引
unregisterAudioSpectrumObserverobserver: AudioSpectrumObservervoid错误码索引
unregisterEventHandlereventHandler: RtcEngineEventHandlervoid错误码索引
unregisterMediaMetadataObservertype: MetadataObserver observer,required MetadataTypevoid错误码索引
updateChannelMediaOptionsoptions: ChannelMediaOptionsFuture错误码索引
updateLocalAudioMixerConfigurationconfig: LocalAudioMixerConfigurationFuture错误码索引
updateLocalTranscoderConfigurationconfig: LocalTranscoderConfigurationFuture错误码索引
updatePreloadChannelTokentoken: StringFuture错误码索引
updateRtmpTranscodingtranscoding: LiveTranscodingFuture错误码索引
updateScreenCapturecaptureParams: ScreenCaptureParameters2Future错误码索引
updateScreenCaptureParameterscaptureParams: ScreenCaptureParametersFuture错误码索引
updateScreenCaptureRegionregionRect: RectangleFuture错误码索引
RtcEngineContext 0 方法 / 7 属性
属性类型只读
appIdString?否
channelProfileChannelProfileType?否
audioScenarioAudioScenarioType?否
areaCodeint?否
logConfigLogConfig?否
domainLimitbool?否
autoRegisterAgoraExtensionsbool?否
RtcEngineEventHandler 87 方法 / 0 属性
typescript
onActiveSpeaker(connection: RtcConnection, uid: int): void
onAudioDeviceStateChanged(deviceId: String, deviceType: MediaDeviceType, deviceState: MediaDeviceStateType): void
onAudioDeviceVolumeChanged(deviceType: MediaDeviceType, volume: int, muted: bool): void
onAudioEffectFinished(soundId: int): void
onAudioMixingFinished(): void
onAudioMixingPositionChanged(position: int): void
onAudioMixingStateChanged(state: AudioMixingStateType, reason: AudioMixingReasonType): void
onAudioPublishStateChanged(channel: String, oldState: StreamPublishState, newState: StreamPublishState, elapseSinceLastState: int): void
onAudioQuality(connection: RtcConnection, remoteUid: int, quality: QualityType, delay: int, lost: int): void
onAudioRoutingChanged(routing: int): void
onAudioSubscribeStateChanged(channel: String, uid: int, oldState: StreamSubscribeState, newState: StreamSubscribeState, elapseSinceLastState: int): void
onAudioVolumeIndication(connection: RtcConnection, speakers: List, speakerNumber: int, totalVolume: int): void
onCameraExposureAreaChanged(x: int, y: int, width: int, height: int): void
onCameraFocusAreaChanged(x: int, y: int, width: int, height: int): void
onCameraReady(): void
onChannelMediaRelayStateChanged(state: ChannelMediaRelayState, code: ChannelMediaRelayError): void
onClientRoleChangeFailed(connection: RtcConnection, reason: ClientRoleChangeFailedReason, currentRole: ClientRoleType): void
onClientRoleChanged(connection: RtcConnection, oldRole: ClientRoleType, newRole: ClientRoleType, newRoleOptions: ClientRoleOptions): void
onConnectionBanned(connection: RtcConnection): void
onConnectionInterrupted(connection: RtcConnection): void
onConnectionLost(connection: RtcConnection): void
onConnectionStateChanged(connection: RtcConnection, state: ConnectionStateType, reason: ConnectionChangedReasonType): void
onEncryptionError(connection: RtcConnection, errorType: EncryptionErrorType): void
onError(err: ErrorCodeType, msg: String): void
onExtensionErrorWithContext(context: ExtensionContext, error: int, message: String): void
onExtensionEventWithContext(context: ExtensionContext, key: String, value: String): void
onExtensionStartedWithContext(context: ExtensionContext): void
onExtensionStoppedWithContext(context: ExtensionContext): void
onFacePositionChanged(imageWidth: int, imageHeight: int, vecRectangle: Rectangle, vecDistance: int, numFaces: int): void
onFirstLocalAudioFramePublished(connection: RtcConnection, elapsed: int): void
onFirstLocalVideoFrame(source: VideoSourceType, width: int, height: int, elapsed: int): void
onFirstLocalVideoFramePublished(connection: RtcConnection, elapsed: int): void
onFirstRemoteAudioDecoded(connection: RtcConnection, uid: int, elapsed: int): void
onFirstRemoteAudioFrame(connection: RtcConnection, userId: int, elapsed: int): void
onFirstRemoteVideoDecoded(connection: RtcConnection, remoteUid: int, width: int, height: int, elapsed: int): void
onFirstRemoteVideoFrame(connection: RtcConnection, remoteUid: int, width: int, height: int, elapsed: int): void
onJoinChannelSuccess(connection: RtcConnection, elapsed: int): void
onLastmileProbeResult(result: LastmileProbeResult): void
onLastmileQuality(quality: QualityType): void
onLeaveChannel(connection: RtcConnection, stats: RtcStats): void
onLocalAudioStateChanged(connection: RtcConnection, state: LocalAudioStreamState, reason: LocalAudioStreamReason): void
onLocalAudioStats(connection: RtcConnection, stats: LocalAudioStats): void
onLocalUserRegistered(uid: int, userAccount: String): void
onLocalVideoEvent(source: VideoSourceType, event: LocalVideoEventType): void
onLocalVideoStateChanged(source: unknown, state: unknown, reason: unknown): unknown
onLocalVideoStats(connection: RtcConnection, stats: LocalVideoStats): void
onLocalVideoTranscoderError(stream: TranscodingVideoStream, error: VideoTranscoderError): void
onMultipathStats(connection: RtcConnection, stats: MultipathStats): void
onNetworkQuality(connection: RtcConnection, remoteUid: int, txQuality: QualityType, rxQuality: QualityType): void
onNetworkTypeChanged(connection: RtcConnection, type: NetworkType): void
onPermissionError(permissionType: PermissionType): void
onPermissionGranted(permissionType: PermissionType): void
onProxyConnected(channel: String, uid: int, proxyType: ProxyType, localProxyIp: String, elapsed: int): void
onRejoinChannelSuccess(connection: RtcConnection, elapsed: int): void
onRemoteAudioStateChanged(connection: RtcConnection, remoteUid: int, state: RemoteAudioState, reason: RemoteAudioStateReason, elapsed: int): void
onRemoteAudioStats(connection: RtcConnection, stats: RemoteAudioStats): void
onRemoteAudioTransportStats(connection: RtcConnection, remoteUid: int, delay: int, lost: int, rxKBitRate: int): void
onRemoteSubscribeFallbackToAudioOnly(uid: int, isFallbackOrRecover: bool): void
onRemoteVideoStateChanged(connection: RtcConnection, remoteUid: int, state: RemoteVideoState, reason: RemoteVideoStateReason, elapsed: int): void
onRemoteVideoStats(connection: RtcConnection, stats: RemoteVideoStats): void
onRemoteVideoTransportStats(connection: RtcConnection, remoteUid: int, delay: int, lost: int, rxKBitRate: int): void
onRenewTokenResult(connection: RtcConnection, token: String, code: RenewTokenErrorCode): void
onRequestToken(connection: RtcConnection): void
onRhythmPlayerStateChanged(state: RhythmPlayerStateType, reason: RhythmPlayerReason): void
onRtcStats(connection: RtcConnection, stats: RtcStats): void
onRtmpStreamingEvent(url: String, eventCode: RtmpStreamingEvent): void
onRtmpStreamingStateChanged(url: String, state: RtmpStreamPublishState, reason: RtmpStreamPublishReason): void
onSnapshotTaken(connection: RtcConnection, uid: int, filePath: String, width: int, height: int, errCode: int): void
onStreamMessage(connection: RtcConnection, remoteUid: int, streamId: int, data: Uint8List, length: int, sentTs: int): void
onStreamMessageError(connection: RtcConnection, remoteUid: int, streamId: int, code: ErrorCodeType, missed: int, cached: int): void
onTokenPrivilegeWillExpire(connection: RtcConnection, token: String): void
onTranscodedStreamLayoutInfo(connection: RtcConnection, uid: int, width: int, height: int, layoutCount: int, layoutlist: List): void
onTranscodingUpdated(): void
onUplinkNetworkInfoUpdated(info: UplinkNetworkInfo): void
onUserEnableLocalVideo(connection: RtcConnection, remoteUid: int, enabled: bool): void
onUserEnableVideo(connection: RtcConnection, remoteUid: int, enabled: bool): void
onUserInfoUpdated(uid: int, info: UserInfo): void
onUserJoined(connection: RtcConnection, remoteUid: int, elapsed: int): void
onUserMuteAudio(connection: RtcConnection, remoteUid: int, muted: bool): void
onUserMuteVideo(connection: RtcConnection, remoteUid: int, muted: bool): void
onUserOffline(connection: RtcConnection, remoteUid: int, reason: UserOfflineReasonType): void
onVideoDeviceStateChanged(deviceId: String, deviceType: MediaDeviceType, deviceState: MediaDeviceStateType): void
onVideoPublishStateChanged(source: VideoSourceType, channel: String, oldState: StreamPublishState, newState: StreamPublishState, elapseSinceLastState: int): void
onVideoRenderingTracingResult(connection: RtcConnection, uid: int, currentEvent: MediaTraceEvent, tracingInfo: VideoRenderingTracingInfo): void
onVideoSizeChanged(connection: RtcConnection, sourceType: VideoSourceType, uid: int, width: int, height: int, rotation: int): void
onVideoStopped(): void
onVideoSubscribeStateChanged(channel: String, uid: int, oldState: StreamSubscribeState, newState: StreamSubscribeState, elapseSinceLastState: int): void

方法明细:87 / 87(参数、返回值、错误码)

方法参数返回值错误
onActiveSpeakerconnection: RtcConnection, uid: intvoid错误码索引
onAudioDeviceStateChangeddeviceId: String, deviceType: MediaDeviceType, deviceState: MediaDeviceStateTypevoid错误码索引
onAudioDeviceVolumeChangeddeviceType: MediaDeviceType, volume: int, muted: boolvoid错误码索引
onAudioEffectFinishedsoundId: intvoid错误码索引
onAudioMixingFinished—void错误码索引
onAudioMixingPositionChangedposition: intvoid错误码索引
onAudioMixingStateChangedstate: AudioMixingStateType, reason: AudioMixingReasonTypevoid错误码索引
onAudioPublishStateChangedchannel: String, oldState: StreamPublishState, newState: StreamPublishState, elapseSinceLastState: intvoid错误码索引
onAudioQualityconnection: RtcConnection, remoteUid: int, quality: QualityType, delay: int, lost: intvoid错误码索引
onAudioRoutingChangedrouting: intvoid错误码索引
onAudioSubscribeStateChangedchannel: String, uid: int, oldState: StreamSubscribeState, newState: StreamSubscribeState, elapseSinceLastState: intvoid错误码索引
onAudioVolumeIndicationconnection: RtcConnection, speakers: List, speakerNumber: int, totalVolume: intvoid错误码索引
onCameraExposureAreaChangedx: int, y: int, width: int, height: intvoid错误码索引
onCameraFocusAreaChangedx: int, y: int, width: int, height: intvoid错误码索引
onCameraReady—void错误码索引
onChannelMediaRelayStateChangedstate: ChannelMediaRelayState, code: ChannelMediaRelayErrorvoid错误码索引
onClientRoleChangeFailedconnection: RtcConnection, reason: ClientRoleChangeFailedReason, currentRole: ClientRoleTypevoid错误码索引
onClientRoleChangedconnection: RtcConnection, oldRole: ClientRoleType, newRole: ClientRoleType, newRoleOptions: ClientRoleOptionsvoid错误码索引
onConnectionBannedconnection: RtcConnectionvoid错误码索引
onConnectionInterruptedconnection: RtcConnectionvoid错误码索引
onConnectionLostconnection: RtcConnectionvoid错误码索引
onConnectionStateChangedconnection: RtcConnection, state: ConnectionStateType, reason: ConnectionChangedReasonTypevoid错误码索引
onEncryptionErrorconnection: RtcConnection, errorType: EncryptionErrorTypevoid错误码索引
onErrorerr: ErrorCodeType, msg: Stringvoid错误码索引
onExtensionErrorWithContextcontext: ExtensionContext, error: int, message: Stringvoid错误码索引
onExtensionEventWithContextcontext: ExtensionContext, key: String, value: Stringvoid错误码索引
onExtensionStartedWithContextcontext: ExtensionContextvoid错误码索引
onExtensionStoppedWithContextcontext: ExtensionContextvoid错误码索引
onFacePositionChangedimageWidth: int, imageHeight: int, vecRectangle: Rectangle, vecDistance: int, numFaces: intvoid错误码索引
onFirstLocalAudioFramePublishedconnection: RtcConnection, elapsed: intvoid错误码索引
onFirstLocalVideoFramesource: VideoSourceType, width: int, height: int, elapsed: intvoid错误码索引
onFirstLocalVideoFramePublishedconnection: RtcConnection, elapsed: intvoid错误码索引
onFirstRemoteAudioDecodedconnection: RtcConnection, uid: int, elapsed: intvoid错误码索引
onFirstRemoteAudioFrameconnection: RtcConnection, userId: int, elapsed: intvoid错误码索引
onFirstRemoteVideoDecodedconnection: RtcConnection, remoteUid: int, width: int, height: int, elapsed: intvoid错误码索引
onFirstRemoteVideoFrameconnection: RtcConnection, remoteUid: int, width: int, height: int, elapsed: intvoid错误码索引
onJoinChannelSuccessconnection: RtcConnection, elapsed: intvoid错误码索引
onLastmileProbeResultresult: LastmileProbeResultvoid错误码索引
onLastmileQualityquality: QualityTypevoid错误码索引
onLeaveChannelconnection: RtcConnection, stats: RtcStatsvoid错误码索引
onLocalAudioStateChangedconnection: RtcConnection, state: LocalAudioStreamState, reason: LocalAudioStreamReasonvoid错误码索引
onLocalAudioStatsconnection: RtcConnection, stats: LocalAudioStatsvoid错误码索引
onLocalUserRegistereduid: int, userAccount: Stringvoid错误码索引
onLocalVideoEventsource: VideoSourceType, event: LocalVideoEventTypevoid错误码索引
onLocalVideoStateChangedsource: unknown, state: unknown, reason: unknownunknown错误码索引
onLocalVideoStatsconnection: RtcConnection, stats: LocalVideoStatsvoid错误码索引
onLocalVideoTranscoderErrorstream: TranscodingVideoStream, error: VideoTranscoderErrorvoid错误码索引
onMultipathStatsconnection: RtcConnection, stats: MultipathStatsvoid错误码索引
onNetworkQualityconnection: RtcConnection, remoteUid: int, txQuality: QualityType, rxQuality: QualityTypevoid错误码索引
onNetworkTypeChangedconnection: RtcConnection, type: NetworkTypevoid错误码索引
onPermissionErrorpermissionType: PermissionTypevoid错误码索引
onPermissionGrantedpermissionType: PermissionTypevoid错误码索引
onProxyConnectedchannel: String, uid: int, proxyType: ProxyType, localProxyIp: String, elapsed: intvoid错误码索引
onRejoinChannelSuccessconnection: RtcConnection, elapsed: intvoid错误码索引
onRemoteAudioStateChangedconnection: RtcConnection, remoteUid: int, state: RemoteAudioState, reason: RemoteAudioStateReason, elapsed: intvoid错误码索引
onRemoteAudioStatsconnection: RtcConnection, stats: RemoteAudioStatsvoid错误码索引
onRemoteAudioTransportStatsconnection: RtcConnection, remoteUid: int, delay: int, lost: int, rxKBitRate: intvoid错误码索引
onRemoteSubscribeFallbackToAudioOnlyuid: int, isFallbackOrRecover: boolvoid错误码索引
onRemoteVideoStateChangedconnection: RtcConnection, remoteUid: int, state: RemoteVideoState, reason: RemoteVideoStateReason, elapsed: intvoid错误码索引
onRemoteVideoStatsconnection: RtcConnection, stats: RemoteVideoStatsvoid错误码索引
onRemoteVideoTransportStatsconnection: RtcConnection, remoteUid: int, delay: int, lost: int, rxKBitRate: intvoid错误码索引
onRenewTokenResultconnection: RtcConnection, token: String, code: RenewTokenErrorCodevoid错误码索引
onRequestTokenconnection: RtcConnectionvoid错误码索引
onRhythmPlayerStateChangedstate: RhythmPlayerStateType, reason: RhythmPlayerReasonvoid错误码索引
onRtcStatsconnection: RtcConnection, stats: RtcStatsvoid错误码索引
onRtmpStreamingEventurl: String, eventCode: RtmpStreamingEventvoid错误码索引
onRtmpStreamingStateChangedurl: String, state: RtmpStreamPublishState, reason: RtmpStreamPublishReasonvoid错误码索引
onSnapshotTakenconnection: RtcConnection, uid: int, filePath: String, width: int, height: int, errCode: intvoid错误码索引
onStreamMessageconnection: RtcConnection, remoteUid: int, streamId: int, data: Uint8List, length: int, sentTs: intvoid错误码索引
onStreamMessageErrorconnection: RtcConnection, remoteUid: int, streamId: int, code: ErrorCodeType, missed: int, cached: intvoid错误码索引
onTokenPrivilegeWillExpireconnection: RtcConnection, token: Stringvoid错误码索引
onTranscodedStreamLayoutInfoconnection: RtcConnection, uid: int, width: int, height: int, layoutCount: int, layoutlist: Listvoid错误码索引
onTranscodingUpdated—void错误码索引
onUplinkNetworkInfoUpdatedinfo: UplinkNetworkInfovoid错误码索引
onUserEnableLocalVideoconnection: RtcConnection, remoteUid: int, enabled: boolvoid错误码索引
onUserEnableVideoconnection: RtcConnection, remoteUid: int, enabled: boolvoid错误码索引
onUserInfoUpdateduid: int, info: UserInfovoid错误码索引
onUserJoinedconnection: RtcConnection, remoteUid: int, elapsed: intvoid错误码索引
onUserMuteAudioconnection: RtcConnection, remoteUid: int, muted: boolvoid错误码索引
onUserMuteVideoconnection: RtcConnection, remoteUid: int, muted: boolvoid错误码索引
onUserOfflineconnection: RtcConnection, remoteUid: int, reason: UserOfflineReasonTypevoid错误码索引
onVideoDeviceStateChangeddeviceId: String, deviceType: MediaDeviceType, deviceState: MediaDeviceStateTypevoid错误码索引
onVideoPublishStateChangedsource: VideoSourceType, channel: String, oldState: StreamPublishState, newState: StreamPublishState, elapseSinceLastState: intvoid错误码索引
onVideoRenderingTracingResultconnection: RtcConnection, uid: int, currentEvent: MediaTraceEvent, tracingInfo: VideoRenderingTracingInfovoid错误码索引
onVideoSizeChangedconnection: RtcConnection, sourceType: VideoSourceType, uid: int, width: int, height: int, rotation: intvoid错误码索引
onVideoStopped—void错误码索引
onVideoSubscribeStateChangedchannel: String, uid: int, oldState: StreamSubscribeState, newState: StreamSubscribeState, elapseSinceLastState: intvoid错误码索引
RtcEngineEx 49 方法 / 0 属性
typescript
addVideoWatermarkEx(connection: String watermarkUrl,required WatermarkOptions options,required RtcConnection): Future
addVideoWatermarkWithConfigEx(connection: WatermarkConfig config,required RtcConnection): Future
adjustUserPlaybackSignalVolumeEx(connection: int uid,required int volume,required RtcConnection): Future
clearVideoWatermarkEx(connection: RtcConnection): Future
createAgoraRtcEngineEx(): RtcEngineEx
createDataStreamEx(connection: DataStreamConfig config,required RtcConnection): Future
enableAudioVolumeIndicationEx(connection: int interval,required int smooth,required bool reportVad,required RtcConnection): Future
enableContentInspectEx(connection: bool enabled,required ContentInspectConfig config,required RtcConnection): Future
enableDualStreamModeEx(connection: bool enabled,required SimulcastStreamConfig streamConfig,required RtcConnection): Future
enableEncryptionEx(config: RtcConnection connection,required bool enabled,required EncryptionConfig): Future
enableLoopbackRecordingEx(deviceName?: RtcConnection connection,required bool enabled,String?): Future
getCallIdEx(connection: RtcConnection): Future
getConnectionStateEx(connection: RtcConnection): Future
joinChannelEx(options: String token,required RtcConnection connection,required ChannelMediaOptions): Future
leaveChannelEx(options?: RtcConnection connection,LeaveChannelOptions?): Future
muteAllRemoteAudioStreamsEx(connection: bool mute,required RtcConnection): Future
muteAllRemoteVideoStreamsEx(connection: bool mute,required RtcConnection): Future
muteLocalAudioStreamEx(connection: bool mute,required RtcConnection): Future
muteLocalVideoStreamEx(connection: bool mute,required RtcConnection): Future
muteRemoteAudioStreamEx(connection: int uid,required bool mute,required RtcConnection): Future
muteRemoteVideoStreamEx(connection: int uid,required bool mute,required RtcConnection): Future
pauseAllChannelMediaRelayEx(connection: RtcConnection): Future
playEffectEx(null: RtcConnection connection,required int soundId,required String filePath,required int loopCount,required double pitch,required double pan,required int gain,bool publish = false,int startPos = 0): Future
preloadEffectEx(null: RtcConnection connection,required int soundId,required String filePath,int startPos = 0): Future
removeVideoWatermarkEx(connection: String id,required RtcConnection): Future
resumeAllChannelMediaRelayEx(connection: RtcConnection): Future
sendCustomReportMessageEx(connection: String id,required String category,required String event,required String label,required int value,required RtcConnection): Future
sendStreamMessageEx(connection: int streamId,required Uint8List data,required int length,required RtcConnection): Future
setDualStreamModeEx(connection: SimulcastStreamMode mode,required SimulcastStreamConfig streamConfig,required RtcConnection): Future
setRemoteRenderModeEx(connection: int uid,required RenderModeType renderMode,required VideoMirrorModeType mirrorMode,required RtcConnection): Future
setRemoteVideoStreamTypeEx(connection: int uid,required VideoStreamType streamType,required RtcConnection): Future
setRemoteVideoSubscriptionOptionsEx(connection: int uid,required VideoSubscriptionOptions options,required RtcConnection): Future
setRemoteVoicePositionEx(connection: int uid,required double pan,required double gain,required RtcConnection): Future
setSubscribeAudioAllowlistEx(connection: List uidList,required int uidNumber,required RtcConnection): Future
setSubscribeAudioBlocklistEx(connection: List uidList,required int uidNumber,required RtcConnection): Future
setSubscribeVideoAllowlistEx(connection: List uidList,required int uidNumber,required RtcConnection): Future
setSubscribeVideoBlocklistEx(connection: List uidList,required int uidNumber,required RtcConnection): Future
setVideoEncoderConfigurationEx(connection: VideoEncoderConfiguration config,required RtcConnection): Future
setupRemoteVideoEx(connection: VideoCanvas canvas,required RtcConnection): Future
startMediaRenderingTracingEx(connection: RtcConnection): Future
startOrUpdateChannelMediaRelayEx(connection: ChannelMediaRelayConfiguration configuration,required RtcConnection): Future
startRtmpStreamWithTranscodingEx(connection: String url,required LiveTranscoding transcoding,required RtcConnection): Future
startRtmpStreamWithoutTranscodingEx(connection: String url,required RtcConnection): Future
stopChannelMediaRelayEx(connection: RtcConnection): Future
stopRtmpStreamEx(connection: String url,required RtcConnection): Future
takeSnapshotEx(filePath: RtcConnection connection,required int uid,required String): Future
takeSnapshotWithConfigEx(config: RtcConnection connection,required int uid,required SnapshotConfig): Future
updateChannelMediaOptionsEx(connection: ChannelMediaOptions options,required RtcConnection): Future
updateRtmpTranscodingEx(connection: LiveTranscoding transcoding,required RtcConnection): Future

方法明细:49 / 49(参数、返回值、错误码)

方法参数返回值错误
addVideoWatermarkExconnection: String watermarkUrl,required WatermarkOptions options,required RtcConnectionFuture错误码索引
addVideoWatermarkWithConfigExconnection: WatermarkConfig config,required RtcConnectionFuture错误码索引
adjustUserPlaybackSignalVolumeExconnection: int uid,required int volume,required RtcConnectionFuture错误码索引
clearVideoWatermarkExconnection: RtcConnectionFuture错误码索引
createAgoraRtcEngineEx—RtcEngineEx错误码索引
createDataStreamExconnection: DataStreamConfig config,required RtcConnectionFuture错误码索引
enableAudioVolumeIndicationExconnection: int interval,required int smooth,required bool reportVad,required RtcConnectionFuture错误码索引
enableContentInspectExconnection: bool enabled,required ContentInspectConfig config,required RtcConnectionFuture错误码索引
enableDualStreamModeExconnection: bool enabled,required SimulcastStreamConfig streamConfig,required RtcConnectionFuture错误码索引
enableEncryptionExconfig: RtcConnection connection,required bool enabled,required EncryptionConfigFuture错误码索引
enableLoopbackRecordingExdeviceName?: RtcConnection connection,required bool enabled,String?Future错误码索引
getCallIdExconnection: RtcConnectionFuture错误码索引
getConnectionStateExconnection: RtcConnectionFuture错误码索引
joinChannelExoptions: String token,required RtcConnection connection,required ChannelMediaOptionsFuture错误码索引
leaveChannelExoptions?: RtcConnection connection,LeaveChannelOptions?Future错误码索引
muteAllRemoteAudioStreamsExconnection: bool mute,required RtcConnectionFuture错误码索引
muteAllRemoteVideoStreamsExconnection: bool mute,required RtcConnectionFuture错误码索引
muteLocalAudioStreamExconnection: bool mute,required RtcConnectionFuture错误码索引
muteLocalVideoStreamExconnection: bool mute,required RtcConnectionFuture错误码索引
muteRemoteAudioStreamExconnection: int uid,required bool mute,required RtcConnectionFuture错误码索引
muteRemoteVideoStreamExconnection: int uid,required bool mute,required RtcConnectionFuture错误码索引
pauseAllChannelMediaRelayExconnection: RtcConnectionFuture错误码索引
playEffectExnull: RtcConnection connection,required int soundId,required String filePath,required int loopCount,required double pitch,required double pan,required int gain,bool publish = false,int startPos = 0Future错误码索引
preloadEffectExnull: RtcConnection connection,required int soundId,required String filePath,int startPos = 0Future错误码索引
removeVideoWatermarkExconnection: String id,required RtcConnectionFuture错误码索引
resumeAllChannelMediaRelayExconnection: RtcConnectionFuture错误码索引
sendCustomReportMessageExconnection: String id,required String category,required String event,required String label,required int value,required RtcConnectionFuture错误码索引
sendStreamMessageExconnection: int streamId,required Uint8List data,required int length,required RtcConnectionFuture错误码索引
setDualStreamModeExconnection: SimulcastStreamMode mode,required SimulcastStreamConfig streamConfig,required RtcConnectionFuture错误码索引
setRemoteRenderModeExconnection: int uid,required RenderModeType renderMode,required VideoMirrorModeType mirrorMode,required RtcConnectionFuture错误码索引
setRemoteVideoStreamTypeExconnection: int uid,required VideoStreamType streamType,required RtcConnectionFuture错误码索引
setRemoteVideoSubscriptionOptionsExconnection: int uid,required VideoSubscriptionOptions options,required RtcConnectionFuture错误码索引
setRemoteVoicePositionExconnection: int uid,required double pan,required double gain,required RtcConnectionFuture错误码索引
setSubscribeAudioAllowlistExconnection: List uidList,required int uidNumber,required RtcConnectionFuture错误码索引
setSubscribeAudioBlocklistExconnection: List uidList,required int uidNumber,required RtcConnectionFuture错误码索引
setSubscribeVideoAllowlistExconnection: List uidList,required int uidNumber,required RtcConnectionFuture错误码索引
setSubscribeVideoBlocklistExconnection: List uidList,required int uidNumber,required RtcConnectionFuture错误码索引
setVideoEncoderConfigurationExconnection: VideoEncoderConfiguration config,required RtcConnectionFuture错误码索引
setupRemoteVideoExconnection: VideoCanvas canvas,required RtcConnectionFuture错误码索引
startMediaRenderingTracingExconnection: RtcConnectionFuture错误码索引
startOrUpdateChannelMediaRelayExconnection: ChannelMediaRelayConfiguration configuration,required RtcConnectionFuture错误码索引
startRtmpStreamWithTranscodingExconnection: String url,required LiveTranscoding transcoding,required RtcConnectionFuture错误码索引
startRtmpStreamWithoutTranscodingExconnection: String url,required RtcConnectionFuture错误码索引
stopChannelMediaRelayExconnection: RtcConnectionFuture错误码索引
stopRtmpStreamExconnection: String url,required RtcConnectionFuture错误码索引
takeSnapshotExfilePath: RtcConnection connection,required int uid,required StringFuture错误码索引
takeSnapshotWithConfigExconfig: RtcConnection connection,required int uid,required SnapshotConfigFuture错误码索引
updateChannelMediaOptionsExconnection: ChannelMediaOptions options,required RtcConnectionFuture错误码索引
updateRtmpTranscodingExconnection: LiveTranscoding transcoding,required RtcConnectionFuture错误码索引
RtcEngineExt 1 方法 / 0 属性
typescript
getAssetAbsolutePath(assetPath: String): Future

方法明细:1 / 1(参数、返回值、错误码)

方法参数返回值错误
getAssetAbsolutePathassetPath: StringFuture错误码索引
RtcImage 0 方法 / 7 属性
属性类型只读
urlString?否
xint?否
yint?否
widthint?否
heightint?否
zOrderint?否
alphadouble?否
RtcStats 0 方法 / 24 属性
属性类型只读
durationint?否
txBytesint?否
rxBytesint?否
txAudioBytesint?否
txVideoBytesint?否
rxAudioBytesint?否
rxVideoBytesint?否
txKBitRateint?否
rxKBitRateint?否
rxAudioKBitRateint?否
txAudioKBitRateint?否
rxVideoKBitRateint?否
txVideoKBitRateint?否
lastmileDelayint?否
txPacketLossRateint?否
rxPacketLossRateint?否
userCountint?否
cpuAppUsagedouble?否
cpuTotalUsagedouble?否
connectTimeMsint?否
gatewayRttint?否
memoryAppUsageRatiodouble?否
memoryTotalUsageRatiodouble?否
memoryAppUsageInKbytesint?否
ScreenAudioParameters 0 方法 / 3 属性
属性类型只读
sampleRateint?否
channelsint?否
captureSignalVolumeint?否
ScreenCaptureConfiguration 0 方法 / 6 属性
属性类型只读
isCaptureWindowbool?否
displayIdint?否
screenRectRectangle?否
windowIdint?否
paramsScreenCaptureParameters?否
regionRectRectangle?否
ScreenCaptureParameters 0 方法 / 10 属性
属性类型只读
dimensionsVideoDimensions?否
frameRateint?否
bitrateint?否
captureMouseCursorbool?否
windowFocusbool?否
excludeWindowListList ?否
enableHighLightbool?否
highLightColorint?否
highLightWidthint?否
excludeWindowCountint?否
ScreenCaptureParameters2 0 方法 / 4 属性
属性类型只读
captureAudiobool?否
audioParamsScreenAudioParameters?否
captureVideobool?否
videoParamsScreenVideoParameters?否
ScreenCaptureSourceInfo 0 方法 / 11 属性
属性类型只读
typeScreenCaptureSourceType?否
sourceIdint?否
sourceNameString?否
thumbImageThumbImageBuffer?否
iconImageThumbImageBuffer?否
processPathString?否
sourceTitleString?否
primaryMonitorbool?否
positionRectangle?否
minimizeWindowbool?否
sourceDisplayIdint?否
ScreenVideoParameters 0 方法 / 4 属性
属性类型只读
dimensionsVideoDimensions?否
frameRateint?否
bitrateint?否
contentHintVideoContentHint?否
SDKBuildInfo 0 方法 / 2 属性
属性类型只读
buildint?否
versionString?否
SegmentationProperty 0 方法 / 3 属性
属性类型只读
modelTypeSegModelType?否
greenCapacitydouble?否
screenColorTypeScreenColorType?否
SimulcastStreamConfig 0 方法 / 3 属性
属性类型只读
dimensionsVideoDimensions?否
kBitrateint?否
framerateint?否
SnapshotConfig 0 方法 / 2 属性
属性类型只读
filePathString?否
positionVideoModulePosition?否
SpatialAudioParams 0 方法 / 8 属性
属性类型只读
speaker_azimuthunknown否
speaker_elevationunknown否
speaker_distanceunknown否
speaker_orientationunknown否
enable_blurunknown否
enable_air_absorbunknown否
speaker_attenuationunknown否
enable_dopplerunknown否
SpatialAudioZone 0 方法 / 9 属性
属性类型只读
zoneSetIdint?否
positionList ?否
forwardList ?否
rightList ?否
upList ?否
forwardLengthdouble?否
rightLengthdouble?否
upLengthdouble?否
audioAttenuationdouble?否
SrcInfo 0 方法 / 2 属性
属性类型只读
bitrateInKbpsint?否
nameString?否
ThumbImageBuffer 0 方法 / 4 属性
属性类型只读
bufferUint8List?否
lengthint?否
widthint?否
heightint?否
TranscodingUser 0 方法 / 8 属性
属性类型只读
uidint?否
xint?否
yint?否
widthint?否
heightint?否
zOrderint?否
alphadouble?否
audioChannelint?否
TranscodingVideoStream 0 方法 / 11 属性
属性类型只读
sourceTypeVideoSourceType?否
remoteUserUidint?否
imageUrlString?否
mediaPlayerIdint?否
xint?否
yint?否
widthint?否
heightint?否
zOrderint?否
alphadouble?否
mirrorbool?否
UplinkNetworkInfo 0 方法 / 1 属性
属性类型只读
videoEncoderTargetBitrateBpsint?否
UserAudioSpectrumInfo 0 方法 / 2 属性
属性类型只读
uidint?否
spectrumDataAudioSpectrumData?否
UserInfo 0 方法 / 2 属性
属性类型只读
uidint?否
userAccountString?否
VideoCanvas 0 方法 / 12 属性
属性类型只读
uidint?否
subviewUidint?否
viewint?否
renderModeRenderModeType?否
mirrorModeVideoMirrorModeType?否
sourceTypeVideoSourceType?否
setupModeVideoViewSetupMode?否
mediaPlayerIdint?否
cropAreaRectangle?否
backgroundColorint?否
enableAlphaMaskbool?否
positionVideoModulePosition?否
VideoDenoiserOptions 0 方法 / 2 属性
属性类型只读
levelVideoDenoiserLevel?否
modeVideoDenoiserMode?否
VideoDeviceInfo 0 方法 / 2 属性
属性类型只读
deviceIdString?否
deviceNameString?否
VideoDeviceManager 6 方法 / 0 属性
typescript
enumerateVideoDevices(): List
getCapability(deviceCapabilityNumber: String deviceIdUTF8,required int): Future
getDevice(): Future
numberOfCapabilities(deviceIdUTF8: String): Future
release(): Future
setDevice(deviceIdUTF8: String): Future

方法明细:6 / 6(参数、返回值、错误码)

方法参数返回值错误
enumerateVideoDevices—List错误码索引
getCapabilitydeviceCapabilityNumber: String deviceIdUTF8,required intFuture错误码索引
getDevice—Future错误码索引
numberOfCapabilitiesdeviceIdUTF8: StringFuture错误码索引
release—Future错误码索引
setDevicedeviceIdUTF8: StringFuture错误码索引
VideoDimensions 0 方法 / 2 属性
属性类型只读
widthint?否
heightint?否
VideoEffectObject 9 方法 / 0 属性
typescript
addOrUpdateVideoEffect(templateName: int nodeId,required String): Future
getVideoEffectBoolParam(key: String option,required String): Future
getVideoEffectFloatParam(key: String option,required String): Future
getVideoEffectIntParam(key: String option,required String): Future
performVideoEffectAction(actionId: int nodeId,required VideoEffectAction): Future
removeVideoEffect(nodeId: int): Future
setVideoEffectBoolParam(param: String option,required String key,required bool): Future
setVideoEffectFloatParam(param: String option,required String key,required double): Future
setVideoEffectIntParam(param: String option,required String key,required int): Future

方法明细:9 / 9(参数、返回值、错误码)

方法参数返回值错误
addOrUpdateVideoEffecttemplateName: int nodeId,required StringFuture错误码索引
getVideoEffectBoolParamkey: String option,required StringFuture错误码索引
getVideoEffectFloatParamkey: String option,required StringFuture错误码索引
getVideoEffectIntParamkey: String option,required StringFuture错误码索引
performVideoEffectActionactionId: int nodeId,required VideoEffectActionFuture错误码索引
removeVideoEffectnodeId: intFuture错误码索引
setVideoEffectBoolParamparam: String option,required String key,required boolFuture错误码索引
setVideoEffectFloatParamparam: String option,required String key,required doubleFuture错误码索引
setVideoEffectIntParamparam: String option,required String key,required intFuture错误码索引
VideoEncodedFrameObserver 1 方法 / 0 属性
typescript
onEncodedVideoFrameReceived(channelId: String, uid: int, imageBuffer: Uint8List, length: int, videoEncodedFrameInfo: EncodedVideoFrameInfo): void

方法明细:1 / 1(参数、返回值、错误码)

方法参数返回值错误
onEncodedVideoFrameReceivedchannelId: String, uid: int, imageBuffer: Uint8List, length: int, videoEncodedFrameInfo: EncodedVideoFrameInfovoid错误码索引
VideoEncoderConfiguration 0 方法 / 9 属性
属性类型只读
dimensionsVideoDimensions?否
codecTypeVideoCodecType?否
frameRateint?否
bitrateint?否
minBitrateint?否
orientationModeOrientationMode?否
degradationPreferenceDegradationPreference?否
mirrorModeVideoMirrorModeType?否
advanceOptionsAdvanceOptions?否
VideoFormat 0 方法 / 3 属性
属性类型只读
widthint?否
heightint?否
fpsint?否
VideoFrame 0 方法 / 20 属性
属性类型只读
typeVideoPixelFormat?否
widthint?否
heightint?否
yStrideint?否
uStrideint?否
vStrideint?否
yBufferUint8List?否
uBufferUint8List?否
vBufferUint8List?否
rotationint?否
renderTimeMsint?否
avsyncTypeint?否
metadataBufferUint8List?否
metadataSizeint?否
textureIdint?否
matrixList ?否
colorSpaceColorSpace?否
alphaBufferUint8List?否
alphaStitchModeAlphaStitchMode?否
metaInfoVideoFrameMetaInfo?否
VideoFrameObserver 3 方法 / 0 属性
typescript
onCaptureVideoFrame(sourceType: VideoSourceType, videoFrame: VideoFrame): void
onPreEncodeVideoFrame(videoFrame: VideoFrame): void
onRenderVideoFrame(channelId: String, remoteUid: int, videoFrame: VideoFrame): void

方法明细:3 / 3(参数、返回值、错误码)

方法参数返回值错误
onCaptureVideoFramesourceType: VideoSourceType, videoFrame: VideoFramevoid错误码索引
onPreEncodeVideoFramevideoFrame: VideoFramevoid错误码索引
onRenderVideoFramechannelId: String, remoteUid: int, videoFrame: VideoFramevoid错误码索引
VideoLayout 0 方法 / 8 属性
属性类型只读
channelIdString?否
uidint?否
strUidString?否
xint?否
yint?否
widthint?否
heightint?否
videoStateint?否
VideoRenderingTracingInfo 0 方法 / 7 属性
属性类型只读
elapsedTimeint?否
start2JoinChannelint?否
join2JoinSuccessint?否
joinSuccess2RemoteJoinedint?否
remoteJoined2SetViewint?否
remoteJoined2UnmuteVideoint?否
remoteJoined2PacketReceivedint?否
VideoSubscriptionOptions 0 方法 / 2 属性
属性类型只读
typeVideoStreamType?否
encodedFrameOnlybool?否
VideoViewController 1 方法 / 5 属性
typescript
VideoViewControllerConstructor(rtcEngine: unknown, canvas: unknown, useFlutterTexture: unknown, FlutterTexture: unknown, useAndroidSurfaceView: unknown): unknown

方法明细:1 / 1(参数、返回值、错误码)

方法参数返回值错误
VideoViewControllerConstructorrtcEngine: unknown, canvas: unknown, useFlutterTexture: unknown, FlutterTexture: unknown, useAndroidSurfaceView: unknownunknown错误码索引
属性类型只读
rtcEngineRtcEngine否
canvasVideoCanvas否
connectionRtcConnection否
useFlutterTexturebool否
useAndroidSurfaceViewbool否
VideoViewControllerBase 0 方法 / 5 属性
属性类型只读
rtcEngineRtcEngine get否
canvasVideoCanvas get否
connectionRtcConnection? get否
useFlutterTexturebool get否
useAndroidSurfaceViewbool get否
VirtualBackgroundSource 0 方法 / 4 属性
属性类型只读
backgroundSourceTypeBackgroundSourceType?否
colorint?否
sourceString?否
blurDegreeBackgroundBlurDegree?否
WatermarkBuffer 0 方法 / 5 属性
属性类型只读
widthint?否
heightint?否
lengthint?否
formatVideoPixelFormat?否
bufferUint8List?否
WatermarkConfig 0 方法 / 7 属性
属性类型只读
idString?否
typeWatermarkSourceType?否
bufferWatermarkBuffer?否
timestampWatermarkTimestamp?否
literalWatermarkLiteral?否
imageUrlString?否
optionsWatermarkOptions?否
WatermarkLiteral 0 方法 / 4 属性
属性类型只读
fontSizeint?否
strokeWidthint?否
wmLiteralString?否
fontFilePathString?否
WatermarkOptions 0 方法 / 6 属性
属性类型只读
visibleInPreviewbool?否
positionInLandscapeModeRectangle?否
positionInPortraitModeRectangle?否
watermarkRatioWatermarkRatio?否
modeWatermarkFitMode?否
zOrderint?否
WatermarkRatio 0 方法 / 3 属性
属性类型只读
xRatiodouble?否
yRatiodouble?否
widthRatiodouble?否
WatermarkTimestamp 0 方法 / 4 属性
属性类型只读
fontSizeint?否
fontFilePathString?否
strokeWidthint?否
formatString?否

枚举

枚举成员数示例值
AgoraPipState3pipStateStarted = null
AlphaStitchMode5noAlphaStitch = 0
AreaCode7areaCodeCn = null
AudienceLatencyLevelType2audienceLatencyLevelLowLatency = 1
AudioAinsMode3ainsModeBalanced = 0
AudioCodecProfileType3audioCodecProfileLcAac = 0
AudioCodecType8audioCodecOpus = 1
AudioDualMonoMode4audioDualMonoStereo = 0
AudioEffectPreset19audioEffectOff = null
AudioEncodedFrameObserverPosition3audioEncodedFrameObserverPositionRecord = 1
AudioEncodingType11audioEncodingTypeAac16000Low = 65793
AudioEqualizationBandFrequency10audioEqualizationBand31 = 0
AudioFileRecordingType3audioFileRecordingMic = 1
AudioFrameType1frameTypePcm16 = 0
AudioMixingDualMonoMode4audioMixingDualMonoAuto = 0
AudioMixingReasonType7audioMixingReasonOk = 0
AudioMixingStateType4audioMixingStatePlaying = 710
audioprocessingchannels2audioProcessingMono = 1
AudioProfileType8audioProfileDefault = 0
audiorecordingqualitytype4audioRecordingQualityLow = 0
AudioReverbType5audioReverbDryLevel = 0
AudioRoute12routeDefault = -1
AudioSampleRateType3audioSampleRate32000 = 32000
AudioScenarioType7audioScenarioDefault = 0
AudioSessionOperationRestriction5audioSessionOperationRestrictionNone = 0
AudioSourceType7audioSourceMicrophone = 0
AudioTrackType2audioTrackMixable = 0
backgroundblurdegree3blurDegreeLow = 1
backgroundSourceType5backgroundNone = 0
CameraDirection2cameraRear = 0
CameraFocalLengthType4cameraFocalLengthDefault = 0
CameraStabilizationMode5cameraStabilizationModeOff = -1
CaptureBrightnessLevelType4captureBrightnessLevelInvalid = -1
ChannelMediaRelayError12relayOk = 0
ChannelMediaRelayState4relayStateIdle = 0
ChannelProfileType4channelProfileCommunication = 0
ClientRoleChangeFailedReason4clientRoleChangeFailedTooManyBroadcasters = 1
ClientRoleType2clientRoleBroadcaster = 1
CloudProxyType3noneProxy = 0
CodecCapMask5codecCapMaskNone = 0
CompressionPreference3preferCompressionAuto = -1
ConnectionChangedReasonType21connectionChangedConnecting = 0
ConnectionStateType5connectionStateDisconnected = 1
ContentInspectType3contentInspectInvalid = 0
DegradationPreference5maintainAuto = -1
EarMonitoringFilterType4earMonitoringFilterNone = null
EncodingPreference3preferAuto = -1
EncryptionErrorType5encryptionErrorInternalFailure = 0
EncryptionMode9aes128Xts = 1
ErrorCodeType48errOk = 0
ExperiencePoorReason5experienceReasonNone = 0
ExperienceQualityType2experienceQualityGood = 0
ExternalVideoSourceType2videoFrame = 0
FaceShapeArea30faceShapeAreaNone = -1
FaceShapeBeautyStyle3faceShapeBeautyStyleFemale = 0
FeatureType2videoVirtualBackground = 1
FrameRate7frameRateFps1 = 1
HeadphoneEqualizerPreset3headphoneEqualizerOff = null
InterfaceIdType7agoraIidAudioDeviceManager = 1
LastmileProbeResultState3lastmileProbeResultComplete = 1
LighteningContrastLevel3lighteningContrastLow = 0
LocalAudioStreamReason11localAudioStreamReasonOk = 0
LocalAudioStreamState4localAudioStreamStateStopped = 0
LocalProxyMode2connectivityFirst = 0
LocalVideoEventType6localVideoEventTypeScreenCaptureWindowHidden = 1
LocalVideoStreamReason26localVideoStreamReasonOk = 0
LocalVideoStreamState4localVideoStreamStateStopped = 0
LogFilterType6logFilterOff = 0
LogLevel5logLevelNone = 0
LowLightEnhanceLevel2lowLightEnhanceLevelHighQuality = 0
LowLightEnhanceMode2LowLightEnhanceAuto = 0
MaxDeviceIdLengthType1maxDeviceIdLength = null
MaxUserAccountLengthType1maxUserAccountLength = null
MediaDeviceStateType6mediaDeviceStateIdle = 0
MediaDeviceType8unknownAudioDevice = -1
MediaPlayerEvent14playerEventSeekBegin = 0
MediaPlayerMetadataType2playerMetadataTypeUnknown = 0
MediaPlayerReason17playerReasonNone = 0
MediaPlayerState9playerStateIdle = 0
MediaRecorderContainerFormat1formatMp4 = 1
MediaRecorderStreamType3streamTypeAudio = 1
MediaSourceType7audioPlayoutSource = 0
MediaStreamType4streamTypeUnknown = 0
MediaTraceEvent2mediaTraceEventVideoRendered = 0
MetadataType2unknownMetadata = -1
MultipathMode1duplicate = 0
MultipathType4lan = 0
MusicCacheStatusType2musicCacheStatusTypeCached = 0
MusicContentCenterStateReason8kMusicContentCenterReasonOk = 0
MusicPlayMode3kMusicPlayModeOriginal = 0
NetworkType8networkTypeUnknown = -1
OrientationMode3orientationModeAdaptive = 0
PermissionType3recordAudio = 0
PlayerPreloadEvent3playerPreloadEventBegin = 0
PreloadState4kPreloadStateCompleted = 0
ProxyType5noneProxyType = 0
QualityAdaptIndication3adaptNone = 0
QualityType8qualityUnknown = 0
RawAudioFrameOpModeType2rawAudioFrameOpModeReadOnly = 0
RecorderReasonCode5recorderReasonNone = 0
RecorderState3recorderStateError = -1
RecorderStreamType2rtc = 0
RemoteAudioState5remoteAudioStateStopped = 0
RemoteAudioStateReason8remoteAudioReasonInternal = 0
RemoteVideoState5remoteVideoStateStopped = 0
RemoteVideoStateReason12remoteVideoStateReasonInternal = 0
RenderModeType3renderModeHidden = 1
RenewTokenErrorCode7renewTokenSuccess = 0
RhythmPlayerReason5rhythmPlayerReasonOk = 0
RhythmPlayerStateType5rhythmPlayerStateIdle = 810
RtmpStreamingEvent4rtmpStreamingEventFailedLoadImage = 1
RtmpStreamLifeCycleType2rtmpStreamLifeCycleBind2channel = null
RtmpStreamPublishReason16rtmpStreamPublishReasonOk = 0
RtmpStreamPublishState6rtmpStreamPublishStateIdle = 0
ScreenCaptureFramerateCapability3screenCaptureFramerateCapability15Fps = 0
ScreenCaptureSourceType4screencapturesourcetypeUnknown = -1
ScreenColorType3screenColorAuto = 0
ScreenScenarioType4screenScenarioDocument = 1
SegModelType2segModelAi = 1
SimulcastStreamMode3autoSimulcastStream = -1
StreamFallbackOptions3streamFallbackOptionDisabled = 0
StreamPublishState4pubStateIdle = 0
StreamSubscribeState4subStateIdle = 0
UserOfflineReasonType3userOfflineQuit = 0
VideoApplicationScenarioType4applicationScenarioGeneral = 0
VideoBufferType3videoBufferRawData = 1
VideoCodecCapabilityLevel5codecCapabilityLevelUnspecified = -1
VideoCodecProfileType3videoCodecProfileBaseline = 66
VideoCodecType6videoCodecNone = 0
VideoCodecTypeForStream2videoCodecH264ForStream = 1
VideoContentHint3contentHintNone = null
VideoDenoiserLevel2videoDenoiserLevelHighQuality = 0
VideoDenoiserMode2videoDenoiserAuto = 0
VideoEffectAction2save = 1
VideoEffectNodeId3beauty = 1
VideoFrameProcessMode2processModeReadOnly = null
VideoFrameType6videoFrameTypeBlankFrame = 0
VideoMirrorModeType3videoMirrorModeAuto = 0
VideoModulePosition4positionPostCapturer = 1
VideoOrientation4videoOrientation0 = 0
VideoPixelFormat5videoPixelDefault = 0
VideoSourceType19videoSourceCameraPrimary = 0
VideoStreamType8videoStreamHigh = 0
VideoTranscoderError6vtErrVideoSourceNotReady = 1
VideoViewSetupMode3videoViewSetupReplace = 0
VoiceAiTunerType10voiceAiTunerMatureMale = 0
VoiceBeautifierPreset14voiceBeautifierOff = null
VoiceConversionPreset5voiceConversionOff = null
WatermarkFitMode2fitModeCoverPosition = 0
WatermarkSourceType4image = 0
AgoraPipState 3 个成员
成员值
pipStateStartednull
pipStateStoppednull
pipStateFailednull
AlphaStitchMode 5 个成员
成员值
noAlphaStitch0
alphaStitchUp1
alphaStitchBelow2
alphaStitchLeft3
alphaStitchRight4
AreaCode 7 个成员
成员值
areaCodeCnnull
areaCodeNanull
areaCodeEunull
areaCodeAsnull
areaCodeJpnull
areaCodeInnull
areaCodeGlobnull
AudienceLatencyLevelType 2 个成员
成员值
audienceLatencyLevelLowLatency1
audienceLatencyLevelUltraLowLatency2
AudioAinsMode 3 个成员
成员值
ainsModeBalanced0
ainsModeAggressive1
ainsModeUltralowlatency2
AudioCodecProfileType 3 个成员
成员值
audioCodecProfileLcAac0
audioCodecProfileHeAac1
audioCodecProfileHeAacV22
AudioCodecType 8 个成员
成员值
audioCodecOpus1
audioCodecPcma3
audioCodecPcmu4
audioCodecG7225
audioCodecAaclc8
audioCodecHeaac9
audioCodecJc110
audioCodecHeaac211
AudioDualMonoMode 4 个成员
成员值
audioDualMonoStereo0
audioDualMonoL1
audioDualMonoR2
audioDualMonoMix3
AudioEffectPreset 19 个成员
成员值
audioEffectOffnull
roomAcousticsVocalConcertnull
roomAcousticsStudionull
roomAcousticsPhonographnull
roomAcousticsVirtualStereonull
roomAcousticsSpacialnull
roomAcousticsEtherealnull
roomAcousticsVirtualSurroundSoundnull
roomAcousticsChorusnull
roomAcoustics3dVoicenull
voiceChangerEffectUnclenull
voiceChangerEffectOldmannull
voiceChangerEffectBoynull
voiceChangerEffectSisternull
voiceChangerEffectGirlnull
voiceChangerEffectPigkingnull
voiceChangerEffectHulknull
styleTransformationPopularnull
pitchCorrectionnull
AudioEncodedFrameObserverPosition 3 个成员
成员值
audioEncodedFrameObserverPositionRecord1
audioEncodedFrameObserverPositionPlayback2
audioEncodedFrameObserverPositionMixed3
AudioEncodingType 11 个成员
成员值
audioEncodingTypeAac16000Low65793
audioEncodingTypeAac16000Medium65794
audioEncodingTypeAac32000Low66049
audioEncodingTypeAac32000Medium66050
audioEncodingTypeAac32000High66051
audioEncodingTypeAac48000Medium66306
audioEncodingTypeAac48000High66307
audioEncodingTypeOpus16000Low131329
audioEncodingTypeOpus16000Medium131330
audioEncodingTypeOpus48000Medium131842
audioEncodingTypeOpus48000High131843
AudioEqualizationBandFrequency 10 个成员
成员值
audioEqualizationBand310
audioEqualizationBand621
audioEqualizationBand1252
audioEqualizationBand2503
audioEqualizationBand5004
audioEqualizationBand1k5
audioEqualizationBand2k6
audioEqualizationBand4k7
audioEqualizationBand8k8
audioEqualizationBand16k9
AudioFileRecordingType 3 个成员
成员值
audioFileRecordingMic1
audioFileRecordingPlayback2
audioFileRecordingMixed3
AudioFrameType 1 个成员
成员值
frameTypePcm160
AudioMixingDualMonoMode 4 个成员
成员值
audioMixingDualMonoAuto0
audioMixingDualMonoL1
audioMixingDualMonoR2
audioMixingDualMonoMix3
AudioMixingReasonType 7 个成员
成员值
audioMixingReasonOk0
audioMixingReasonCanNotOpen701
audioMixingReasonTooFrequentCall702
audioMixingReasonInterruptedEof703
audioMixingReasonOneLoopCompleted721
audioMixingReasonAllLoopsCompleted723
audioMixingReasonStoppedByUser724
AudioMixingStateType 4 个成员
成员值
audioMixingStatePlaying710
audioMixingStatePaused711
audioMixingStateStopped713
audioMixingStateFailed714
audioprocessingchannels 2 个成员
成员值
audioProcessingMono1
audioProcessingStereo2
AudioProfileType 8 个成员
成员值
audioProfileDefault0
audioProfileSpeechStandard1
audioProfileMusicStandard2
audioProfileMusicStandardStereo3
audioProfileMusicHighQuality4
audioProfileMusicHighQualityStereo5
audioProfileIot6
audioProfileNumnull
audiorecordingqualitytype 4 个成员
成员值
audioRecordingQualityLow0
audioRecordingQualityMedium1
audioRecordingQualityHigh2
audioRecordingQualityUltraHigh3
AudioReverbType 5 个成员
成员值
audioReverbDryLevel0
audioReverbWetLevel1
audioReverbRoomSize2
audioReverbWetDelay3
audioReverbStrength4
AudioRoute 12 个成员
成员值
routeDefault-1
routeHeadset0
routeEarpiece1
routeHeadsetnomic2
routeSpeakerphone3
routeLoudspeaker4
routeHeadsetbluetooth5
routeUsb6
routeHdmi7
routeDisplayport8
routeAirplay9
routeBluetoothSpeaker10
AudioSampleRateType 3 个成员
成员值
audioSampleRate3200032000
audioSampleRate4410044100
audioSampleRate4800048000
AudioScenarioType 7 个成员
成员值
audioScenarioDefault0
audioScenarioGameStreaming3
audioScenarioChatroom5
audioScenarioChorus7
audioScenarioMeeting8
audioScenarioAiClient10
audioScenarioNumnull
AudioSessionOperationRestriction 5 个成员
成员值
audioSessionOperationRestrictionNone0
audioSessionOperationRestrictionSetCategory1
audioSessionOperationRestrictionConfigureSession2
audioSessionOperationRestrictionDeactivateSession4
audioSessionOperationRestrictionAll128
AudioSourceType 7 个成员
成员值
audioSourceMicrophone0
audioSourceCustom1
audioSourceMediaPlayer2
audioSourceLoopbackRecording3
audioSourceRemoteUser5
audioSourceRemoteChannel6
audioSourceUnknown100
AudioTrackType 2 个成员
成员值
audioTrackMixable0
audioTrackDirect1
backgroundblurdegree 3 个成员
成员值
blurDegreeLow1
blurDegreeMedium2
blurDegreeHigh3
backgroundSourceType 5 个成员
成员值
backgroundNone0
backgroundColor1
backgroundImg2
backgroundBlur3
backgroundVideo4
CameraDirection 2 个成员
成员值
cameraRear0
cameraFront1
CameraFocalLengthType 4 个成员
成员值
cameraFocalLengthDefault0
cameraFocalLengthWideAngle1
cameraFocalLengthUltraWide2
cameraFocalLengthTelephoto3
CameraStabilizationMode 5 个成员
成员值
cameraStabilizationModeOff-1
cameraStabilizationModeAuto0
cameraStabilizationModeLevel11
cameraStabilizationModeLevel22
cameraStabilizationModeLevel33
CaptureBrightnessLevelType 4 个成员
成员值
captureBrightnessLevelInvalid-1
captureBrightnessLevelNormal0
captureBrightnessLevelBright1
captureBrightnessLevelDark2
ChannelMediaRelayError 12 个成员
成员值
relayOk0
relayErrorServerErrorResponse1
relayErrorServerNoResponse2
relayErrorNoResourceAvailable3
relayErrorFailedJoinSrc4
relayErrorFailedJoinDest5
relayErrorFailedPacketReceivedFromSrc6
relayErrorFailedPacketSentToDest7
relayErrorServerConnectionLost8
relayErrorInternalError9
relayErrorSrcTokenExpired10
relayErrorDestTokenExpired11
ChannelMediaRelayState 4 个成员
成员值
relayStateIdle0
relayStateConnecting1
relayStateRunning2
relayStateFailure3
ChannelProfileType 4 个成员
成员值
channelProfileCommunication0
channelProfileLiveBroadcasting1
channelProfileGame2
channelProfileCloudGaming3
ClientRoleChangeFailedReason 4 个成员
成员值
clientRoleChangeFailedTooManyBroadcasters1
clientRoleChangeFailedNotAuthorized2
clientRoleChangeFailedRequestTimeOut3
clientRoleChangeFailedConnectionFailed4
ClientRoleType 2 个成员
成员值
clientRoleBroadcaster1
clientRoleAudience2
CloudProxyType 3 个成员
成员值
noneProxy0
udpProxy1
tcpProxy2
CodecCapMask 5 个成员
成员值
codecCapMaskNone0
codecCapMaskHwDecnull
codecCapMaskHwEncnull
codecCapMaskSwDecnull
codecCapMaskSwEncnull
CompressionPreference 3 个成员
成员值
preferCompressionAuto-1
preferLowLatency0
preferQuality1
ConnectionChangedReasonType 21 个成员
成员值
connectionChangedConnecting0
connectionChangedJoinSuccess1
connectionChangedInterrupted2
connectionChangedBannedByServer3
connectionChangedJoinFailed4
connectionChangedLeaveChannel5
connectionChangedInvalidAppId6
connectionChangedInvalidChannelName7
connectionChangedInvalidToken8
connectionChangedTokenExpired9
connectionChangedRejectedByServer10
connectionChangedSettingProxyServer11
connectionChangedRenewToken12
connectionChangedClientIpAddressChanged13
connectionChangedKeepAliveTimeout14
connectionChangedRejoinSuccess15
connectionChangedLost16
connectionChangedEchoTest17
connectionChangedClientIpAddressChangedByUser18
connectionChangedSameUidLogin19
connectionChangedTooManyBroadcasters20
ConnectionStateType 5 个成员
成员值
connectionStateDisconnected1
connectionStateConnecting2
connectionStateConnected3
connectionStateReconnecting4
connectionStateFailed5
ContentInspectType 3 个成员
成员值
contentInspectInvalid0
contentInspectSupervision2
contentInspectImageModeration3
DegradationPreference 5 个成员
成员值
maintainAuto-1
maintainQuality0
maintainFramerate1
maintainBalanced2
maintainResolution3
EarMonitoringFilterType 4 个成员
成员值
earMonitoringFilterNonenull
earMonitoringFilterBuiltInAudioFiltersnull
earMonitoringFilterNoiseSuppressionnull
earMonitoringFilterReusePostProcessingFilternull
EncodingPreference 3 个成员
成员值
preferAuto-1
preferSoftware0
preferHardware1
EncryptionErrorType 5 个成员
成员值
encryptionErrorInternalFailure0
encryptionErrorDecryptionFailure1
encryptionErrorEncryptionFailure2
encryptionErrorDatastreamDecryptionFailure3
encryptionErrorDatastreamEncryptionFailure4
EncryptionMode 9 个成员
成员值
aes128Xts1
aes128Ecb2
aes256Xts3
sm4128Ecb4
aes128Gcm5
aes256Gcm6
aes128Gcm27
aes256Gcm28
modeEndnull
ErrorCodeType 48 个成员
成员值
errOk0
errFailed1
errInvalidArgument2
errNotReady3
RtcEnginenull
errNotSupported4
errRefused5
errBufferTooSmall6
errNotInitialized7
errInvalidState8
errNoPermission9
errTimedout10
errJoinChannelRejected17
errLeaveChannelRejected18
errAlreadyInUse19
errAborted20
errInitNetEngine21
errResourceLimited22
errInvalidAppId101
errInvalidChannelName102
errNoServerResources103
errTokenExpired109
errInvalidTokennull
errConnectionInterrupted111
errConnectionLost112
errNotInChannel113
errSizeTooLarge114
errBitrateLimit115
errTooManyDataStreams116
errStreamMessageTimeout117
errSetClientRoleNotAuthorized119
errDecryptionFailed120
errInvalidUserId121
errDatastreamDecryptionFailed122
errClientIsBannedByServer123
errEncryptedStreamNotAllowedPublish130
errInvalidUserAccount134
errPcmsendFormat200
errPcmsendBufferoverflow201
errLoadMediaEngine1001
errAdmGeneralError1005
errAdmInitPlayout1008
errAdmStartPlayout1009
errAdmStopPlayout1010
errAdmInitRecording1011
errAdmStartRecording1012
errAdmStopRecording1013
errVdmCameraNotAuthorized1501
ExperiencePoorReason 5 个成员
成员值
experienceReasonNone0
remoteNetworkQualityPoor1
localNetworkQualityPoor2
wirelessSignalPoor4
wifiBluetoothCoexist8
ExperienceQualityType 2 个成员
成员值
experienceQualityGood0
experienceQualityBad1
ExternalVideoSourceType 2 个成员
成员值
videoFrame0
encodedVideoFrame1
FaceShapeArea 30 个成员
成员值
faceShapeAreaNone-1
faceShapeAreaHeadscale100
faceShapeAreaForehead101
faceShapeAreaFacecontour102
faceShapeAreaFacelength103
faceShapeAreaFacewidth104
faceShapeAreaCheekbone105
faceShapeAreaCheek106
faceShapeAreaMandible107
faceShapeAreaChin108
faceShapeAreaEyescale200
faceShapeAreaEyedistance201
faceShapeAreaEyeposition202
faceShapeAreaLowereyelid203
faceShapeAreaEyepupils204
faceShapeAreaEyeinnercorner205
faceShapeAreaEyeoutercorner206
faceShapeAreaNoselength300
faceShapeAreaNosewidth301
faceShapeAreaNosewing302
faceShapeAreaNoseroot303
faceShapeAreaNosebridge304
faceShapeAreaNosetip305
faceShapeAreaNosegeneral306
faceShapeAreaMouthscale400
faceShapeAreaMouthposition401
faceShapeAreaMouthsmile402
faceShapeAreaMouthlip403
faceShapeAreaEyebrowposition500
faceShapeAreaEyebrowthickness501
FaceShapeBeautyStyle 3 个成员
成员值
faceShapeBeautyStyleFemale0
faceShapeBeautyStyleMale1
faceShapeBeautyStyleNatural2
FeatureType 2 个成员
成员值
videoVirtualBackground1
videoBeautyEffect2
FrameRate 7 个成员
成员值
frameRateFps11
frameRateFps77
frameRateFps1010
frameRateFps1515
frameRateFps2424
frameRateFps3030
frameRateFps6060
HeadphoneEqualizerPreset 3 个成员
成员值
headphoneEqualizerOffnull
headphoneEqualizerOverearnull
headphoneEqualizerInearnull
InterfaceIdType 7 个成员
成员值
agoraIidAudioDeviceManager1
agoraIidVideoDeviceManager2
agoraIidParameterEngine3
agoraIidMediaEngine4
agoraIidSignalingEngine8
agoraIidLocalSpatialAudio11
agoraIidMusicContentCenter15
LastmileProbeResultState 3 个成员
成员值
lastmileProbeResultComplete1
lastmileProbeResultIncompleteNoBwe2
lastmileProbeResultUnavailable3
LighteningContrastLevel 3 个成员
成员值
lighteningContrastLow0
lighteningContrastNormal1
lighteningContrastHigh2
LocalAudioStreamReason 11 个成员
成员值
localAudioStreamReasonOk0
localAudioStreamReasonFailure1
localAudioStreamReasonDeviceNoPermission2
localAudioStreamReasonDeviceBusy3
localAudioStreamReasonRecordFailure4
localAudioStreamReasonEncodeFailure5
localAudioStreamReasonNoRecordingDevice6
localAudioStreamReasonNoPlayoutDevice7
localAudioStreamReasonInterrupted8
localAudioStreamReasonRecordInvalidId9
localAudioStreamReasonPlayoutInvalidId10
LocalAudioStreamState 4 个成员
成员值
localAudioStreamStateStopped0
localAudioStreamStateRecording1
localAudioStreamStateEncoding2
localAudioStreamStateFailed3
LocalProxyMode 2 个成员
成员值
connectivityFirst0
localOnly1
LocalVideoEventType 6 个成员
成员值
localVideoEventTypeScreenCaptureWindowHidden1
localVideoEventTypeScreenCaptureWindowRecoverFromHidden2
localVideoEventTypeScreenCaptureStoppedByUser3
localVideoEventTypeScreenCaptureSystemInternalError4
localVideoEventTypeCameraFocalLengthApplied5
localVideoEventTypeCameraFocalLengthFallbackToDefault6
LocalVideoStreamReason 26 个成员
成员值
localVideoStreamReasonOk0
localVideoStreamReasonFailure1
localVideoStreamReasonDeviceNoPermission2
localVideoStreamReasonDeviceBusy3
localVideoStreamReasonCaptureFailure4
localVideoStreamReasonCodecNotSupport5
localVideoStreamReasonCaptureInbackground6
localVideoStreamReasonCaptureMultipleForegroundApps7
localVideoStreamReasonDeviceNotFound8
localVideoStreamReasonDeviceDisconnected9
localVideoStreamReasonDeviceInvalidId10
localVideoStreamReasonScreenCaptureWindowMinimized11
localVideoStreamReasonScreenCaptureWindowClosed12
localVideoStreamReasonScreenCaptureWindowOccluded13
localVideoStreamReasonDeviceInterrupt14
localVideoStreamReasonDeviceFatalError15
localVideoStreamReasonScreenCaptureFailure21
localVideoStreamReasonScreenCaptureNoPermission22
localVideoStreamReasonScreenCaptureAutoFallback24
localVideoStreamReasonScreenCaptureWindowHidden25
localVideoStreamReasonScreenCaptureWindowRecoverFromHidden26
localVideoStreamReasonScreenCaptureWindowRecoverFromMinimized27
localVideoStreamReasonScreenCapturePaused28
localVideoStreamReasonScreenCaptureResumed29
localVideoStreamReasonScreenCaptureDisplayDisconnected30
localVideoStreamReasonDeviceSystemPressure101
LocalVideoStreamState 4 个成员
成员值
localVideoStreamStateStopped0
localVideoStreamStateCapturing1
localVideoStreamStateEncoding2
localVideoStreamStateFailed3
LogFilterType 6 个成员
成员值
logFilterOff0
logFilterDebug2063
logFilterInfo15
logFilterWarn14
logFilterError12
logFilterCritical8
LogLevel 5 个成员
成员值
logLevelNone0
logLevelInfo1
logLevelWarn2
logLevelError4
logLevelFatal8
LowLightEnhanceLevel 2 个成员
成员值
lowLightEnhanceLevelHighQuality0
lowLightEnhanceLevelFast1
LowLightEnhanceMode 2 个成员
成员值
LowLightEnhanceAuto0
LowLightEnhanceManual1
MaxDeviceIdLengthType 1 个成员
成员值
maxDeviceIdLengthnull
MaxUserAccountLengthType 1 个成员
成员值
maxUserAccountLengthnull
MediaDeviceStateType 6 个成员
成员值
mediaDeviceStateIdle0
mediaDeviceStateActive1
mediaDeviceStateDisabled2
mediaDeviceStatePluggedIn3
mediaDeviceStateNotPresent4
mediaDeviceStateUnplugged8
MediaDeviceType 8 个成员
成员值
unknownAudioDevice-1
audioPlayoutDevice0
audioRecordingDevice1
videoRenderDevice2
videoCaptureDevice3
audioApplicationPlayoutDevice4
audioVirtualPlayoutDevicenull
audioVirtualRecordingDevicenull
MediaPlayerEvent 14 个成员
成员值
playerEventSeekBegin0
playerEventSeekComplete1
playerEventSeekError2
playerEventAudioTrackChanged5
playerEventBufferLow6
playerEventBufferRecover7
playerEventFreezeStart8
playerEventFreezeStop9
playerEventSwitchBegin10
playerEventSwitchComplete11
playerEventSwitchError12
playerEventFirstDisplayed13
playerEventReachCacheFileMaxCount14
playerEventReachCacheFileMaxSize15
MediaPlayerMetadataType 2 个成员
成员值
playerMetadataTypeUnknown0
playerMetadataTypeSei1
MediaPlayerReason 17 个成员
成员值
playerReasonNone0
playerReasonInvalidArguments-1
playerReasonInternal-2
playerReasonNoResource-3
playerReasonInvalidMediaSource-4
playerReasonUnknownStreamType-5
playerReasonObjNotInitialized-6
playerReasonCodecNotSupported-7
playerReasonVideoRenderFailed-8
playerReasonInvalidState-9
playerReasonUrlNotFound-10
playerReasonInvalidConnectionState-11
playerReasonSrcBufferUnderflow-12
playerReasonInterrupted-13
playerReasonNotSupported-14
playerReasonTokenExpired-15
playerReasonUnknown-17
MediaPlayerState 9 个成员
成员值
playerStateIdle0
playerStateOpening1
playerStateOpenCompleted2
playerStatePlaying3
playerStatePaused4
playerStatePlaybackCompleted5
playerStatePlaybackAllLoopsCompleted6
playerStateStopped7
playerStateFailed100
MediaRecorderContainerFormat 1 个成员
成员值
formatMp41
MediaRecorderStreamType 3 个成员
成员值
streamTypeAudio1
streamTypeVideo2
streamTypeBoth3
MediaSourceType 7 个成员
成员值
audioPlayoutSource0
audioRecordingSource1
primaryCameraSource2
secondaryCameraSource3
customVideoSource6
speechDrivenVideoSource13
unknownMediaSource100
MediaStreamType 4 个成员
成员值
streamTypeUnknown0
streamTypeVideo1
streamTypeAudio2
streamTypeSubtitle3
MediaTraceEvent 2 个成员
成员值
mediaTraceEventVideoRendered0
mediaTraceEventVideoDecoded1
MetadataType 2 个成员
成员值
unknownMetadata-1
videoMetadata0
MultipathMode 1 个成员
成员值
duplicate0
MultipathType 4 个成员
成员值
lan0
wifi1
mobile2
unknown99
MusicCacheStatusType 2 个成员
成员值
musicCacheStatusTypeCached0
musicCacheStatusTypeCaching1
MusicContentCenterStateReason 8 个成员
成员值
kMusicContentCenterReasonOk0
kMusicContentCenterReasonError1
kMusicContentCenterReasonGateway2
kMusicContentCenterReasonPermissionAndResource3
kMusicContentCenterReasonInternalDataParse4
kMusicContentCenterReasonMusicLoading5
kMusicContentCenterReasonMusicDecryption6
kMusicContentCenterReasonHttpInternalError7
MusicPlayMode 3 个成员
成员值
kMusicPlayModeOriginal0
kMusicPlayModeAccompany1
kMusicPlayModeLeadSing2
NetworkType 8 个成员
成员值
networkTypeUnknown-1
networkTypeDisconnected0
networkTypeLan1
networkTypeWifi2
networkTypeMobile2g3
networkTypeMobile3g4
networkTypeMobile4g5
networkTypeMobile5g6
OrientationMode 3 个成员
成员值
orientationModeAdaptive0
orientationModeFixedLandscape1
orientationModeFixedPortrait2
PermissionType 3 个成员
成员值
recordAudio0
camera1
screenCapturenull
PlayerPreloadEvent 3 个成员
成员值
playerPreloadEventBegin0
playerPreloadEventComplete1
playerPreloadEventError2
PreloadState 4 个成员
成员值
kPreloadStateCompleted0
kPreloadStateFailed1
kPreloadStatePreloading2
kPreloadStateRemoved3
ProxyType 5 个成员
成员值
noneProxyType0
udpProxyType1
tcpProxyType2
localProxyType3
tcpProxyAutoFallbackType4
QualityAdaptIndication 3 个成员
成员值
adaptNone0
adaptUpBandwidth1
adaptDownBandwidth2
QualityType 8 个成员
成员值
qualityUnknown0
qualityExcellent1
qualityGood2
qualityPoor3
qualityBad4
qualityVbad5
qualityDown6
qualityDetecting8
RawAudioFrameOpModeType 2 个成员
成员值
rawAudioFrameOpModeReadOnly0
rawAudioFrameOpModeReadWrite2
RecorderReasonCode 5 个成员
成员值
recorderReasonNone0
recorderReasonWriteFailed1
recorderReasonNoStream2
recorderReasonOverMaxDuration3
recorderReasonConfigChanged4
RecorderState 3 个成员
成员值
recorderStateError-1
recorderStateStart2
recorderStateStop3
RecorderStreamType 2 个成员
成员值
rtc0
preview1
RemoteAudioState 5 个成员
成员值
remoteAudioStateStopped0
remoteAudioStateStarting1
remoteAudioStateDecoding2
remoteAudioStateFrozen3
remoteAudioStateFailed4
RemoteAudioStateReason 8 个成员
成员值
remoteAudioReasonInternal0
remoteAudioReasonNetworkCongestion1
remoteAudioReasonNetworkRecovery2
remoteAudioReasonLocalMuted3
remoteAudioReasonLocalUnmuted4
remoteAudioReasonRemoteMuted5
remoteAudioReasonRemoteUnmuted6
remoteAudioReasonRemoteOffline7
RemoteVideoState 5 个成员
成员值
remoteVideoStateStopped0
remoteVideoStateStarting1
remoteVideoStateDecoding2
remoteVideoStateFrozen3
remoteVideoStateFailed4
RemoteVideoStateReason 12 个成员
成员值
remoteVideoStateReasonInternal0
remoteVideoStateReasonNetworkCongestion1
remoteVideoStateReasonNetworkRecovery2
remoteVideoStateReasonLocalMuted3
remoteVideoStateReasonLocalUnmuted4
remoteVideoStateReasonRemoteMuted5
remoteVideoStateReasonRemoteUnmuted6
remoteVideoStateReasonRemoteOffline7
remoteVideoStateReasonAudioFallback8
remoteVideoStateReasonAudioFallbackRecovery9
remoteVideoStateReasonSdkInBackground12
remoteVideoStateReasonCodecNotSupport13
RenderModeType 3 个成员
成员值
renderModeHidden1
renderModeFit2
renderModeAdaptive3
RenewTokenErrorCode 7 个成员
成员值
renewTokenSuccess0
renewTokenFailure1
renewTokenTokenExpired2
renewTokenInvalidToken3
renewTokenInvalidChannelName4
renewTokenInconsistentAppid5
renewTokenCanceledByNewRequest6
RhythmPlayerReason 5 个成员
成员值
rhythmPlayerReasonOk0
rhythmPlayerReasonFailed1
rhythmPlayerReasonCanNotOpen801
rhythmPlayerReasonCanNotPlay802
rhythmPlayerReasonFileOverDurationLimit803
RhythmPlayerStateType 5 个成员
成员值
rhythmPlayerStateIdle810
rhythmPlayerStateOpening811
rhythmPlayerStateDecoding812
rhythmPlayerStatePlaying813
rhythmPlayerStateFailed814
RtmpStreamingEvent 4 个成员
成员值
rtmpStreamingEventFailedLoadImage1
rtmpStreamingEventUrlAlreadyInUse2
rtmpStreamingEventAdvancedFeatureNotSupport3
rtmpStreamingEventRequestTooOften4
RtmpStreamLifeCycleType 2 个成员
成员值
rtmpStreamLifeCycleBind2channelnull
rtmpStreamLifeCycleBind2ownernull
RtmpStreamPublishReason 16 个成员
成员值
rtmpStreamPublishReasonOk0
rtmpStreamPublishReasonInvalidArgument1
rtmpStreamPublishReasonEncryptedStreamNotAllowed2
rtmpStreamPublishReasonConnectionTimeout3
rtmpStreamPublishReasonInternalServerError4
rtmpStreamPublishReasonRtmpServerError5
rtmpStreamPublishReasonTooOften6
rtmpStreamPublishReasonReachLimit7
rtmpStreamPublishReasonNotAuthorized8
rtmpStreamPublishReasonStreamNotFound9
rtmpStreamPublishReasonFormatNotSupported10
rtmpStreamPublishReasonNotBroadcaster11
rtmpStreamPublishReasonTranscodingNoMixStream13
rtmpStreamPublishReasonNetDown14
rtmpStreamPublishReasonInvalidPrivilege16
rtmpStreamUnpublishReasonOk100
RtmpStreamPublishState 6 个成员
成员值
rtmpStreamPublishStateIdle0
rtmpStreamPublishStateConnecting1
rtmpStreamPublishStateRunning2
rtmpStreamPublishStateRecovering3
rtmpStreamPublishStateFailure4
rtmpStreamPublishStateDisconnecting5
ScreenCaptureFramerateCapability 3 个成员
成员值
screenCaptureFramerateCapability15Fps0
screenCaptureFramerateCapability30Fps1
screenCaptureFramerateCapability60Fps2
ScreenCaptureSourceType 4 个成员
成员值
screencapturesourcetypeUnknown-1
screencapturesourcetypeWindow0
screencapturesourcetypeScreen1
screencapturesourcetypeCustom2
ScreenColorType 3 个成员
成员值
screenColorAuto0
screenColorGreen1
screenColorBlue2
ScreenScenarioType 4 个成员
成员值
screenScenarioDocument1
screenScenarioGaming2
screenScenarioVideo3
screenScenarioRdc4
SegModelType 2 个成员
成员值
segModelAi1
segModelGreen2
SimulcastStreamMode 3 个成员
成员值
autoSimulcastStream-1
disableSimulcastStream0
enableSimulcastStream1
StreamFallbackOptions 3 个成员
成员值
streamFallbackOptionDisabled0
streamFallbackOptionVideoStreamLow1
streamFallbackOptionAudioOnly2
StreamPublishState 4 个成员
成员值
pubStateIdle0
pubStateNoPublished1
pubStatePublishing2
pubStatePublished3
StreamSubscribeState 4 个成员
成员值
subStateIdle0
subStateNoSubscribed1
subStateSubscribing2
subStateSubscribed3
UserOfflineReasonType 3 个成员
成员值
userOfflineQuit0
userOfflineDropped1
userOfflineBecomeAudience2
VideoApplicationScenarioType 4 个成员
成员值
applicationScenarioGeneral0
applicationScenarioMeeting1
applicationScenario1v12
applicationScenarioLiveshow3
VideoBufferType 3 个成员
成员值
videoBufferRawData1
videoBufferArray2
videoBufferTexture3
VideoCodecCapabilityLevel 5 个成员
成员值
codecCapabilityLevelUnspecified-1
codecCapabilityLevelBasicSupport5
codecCapabilityLevel1080p30fps10
codecCapabilityLevel1080p60fps20
codecCapabilityLevel4k60fps30
VideoCodecProfileType 3 个成员
成员值
videoCodecProfileBaseline66
videoCodecProfileMain77
videoCodecProfileHigh100
VideoCodecType 6 个成员
成员值
videoCodecNone0
videoCodecVp81
videoCodecH2642
videoCodecH2653
videoCodecGeneric6
videoCodecGenericJpeg20
VideoCodecTypeForStream 2 个成员
成员值
videoCodecH264ForStream1
videoCodecH265ForStream2
VideoContentHint 3 个成员
成员值
contentHintNonenull
contentHintMotionnull
contentHintDetailsnull
VideoDenoiserLevel 2 个成员
成员值
videoDenoiserLevelHighQuality0
videoDenoiserLevelFast1
VideoDenoiserMode 2 个成员
成员值
videoDenoiserAuto0
videoDenoiserManual1
VideoEffectAction 2 个成员
成员值
save1
reset2
VideoEffectNodeId 3 个成员
成员值
beauty1
styleMakeup2
filter4
VideoFrameProcessMode 2 个成员
成员值
processModeReadOnlynull
processModeReadWritenull
VideoFrameType 6 个成员
成员值
videoFrameTypeBlankFrame0
videoFrameTypeKeyFrame3
videoFrameTypeDeltaFrame4
videoFrameTypeBFrame5
videoFrameTypeDroppableFrame6
videoFrameTypeUnknownull
VideoMirrorModeType 3 个成员
成员值
videoMirrorModeAuto0
videoMirrorModeEnabled1
videoMirrorModeDisabled2
VideoModulePosition 4 个成员
成员值
positionPostCapturer1
positionPreRenderer2
positionPreEncoder4
positionPostCapturerOrigin8
VideoOrientation 4 个成员
成员值
videoOrientation00
videoOrientation9090
videoOrientation180180
videoOrientation270270
VideoPixelFormat 5 个成员
成员值
videoPixelDefault0
videoPixelI4201
videoPixelRgba4
videoPixelI42216
videoTextureId3d11texture2d17
VideoSourceType 19 个成员
成员值
videoSourceCameraPrimary0
videoSourceCamera0
videoSourceCameraSecondary1
videoSourceScreenPrimary2
videoSourceScreen2
videoSourceScreenSecondary3
videoSourceCustom4
videoSourceMediaPlayer5
videoSourceRtcImagePng6
videoSourceRtcImageJpeg7
videoSourceRtcImageGif8
videoSourceRemote9
videoSourceTranscoded10
videoSourceCameraThird11
videoSourceCameraFourth12
videoSourceScreenThird13
videoSourceScreenFourth14
videoSourceSpeechDriven15
videoSourceUnknown100
VideoStreamType 8 个成员
成员值
videoStreamHigh0
videoStreamLow1
VIDEO_STREAM_LAYER_14
VIDEO_STREAM_LAYER_25
VIDEO_STREAM_LAYER_36
VIDEO_STREAM_LAYER_47
VIDEO_STREAM_LAYER_58
VIDEO_STREAM_LAYER_69
VideoTranscoderError 6 个成员
成员值
vtErrVideoSourceNotReady1
vtErrInvalidVideoSourceType2
vtErrInvalidImagePath3
vtErrUnsupportImageFormat4
vtErrInvalidLayout5
vtErrInternal20
VideoViewSetupMode 3 个成员
成员值
videoViewSetupReplace0
videoViewSetupAdd1
videoViewSetupRemove2
VoiceAiTunerType 10 个成员
成员值
voiceAiTunerMatureMale0
voiceAiTunerFreshMale1
voiceAiTunerElegantFemale2
voiceAiTunerSweetFemale3
voiceAiTunerWarmMaleSinging4
voiceAiTunerGentleFemaleSinging5
voiceAiTunerHuskyMaleSinging6
voiceAiTunerWarmElegantFemaleSinging7
voiceAiTunerPowerfulMaleSinging8
voiceAiTunerDreamyFemaleSinging9
VoiceBeautifierPreset 14 个成员
成员值
voiceBeautifierOffnull
chatBeautifierMagneticnull
chatBeautifierFreshnull
chatBeautifierVitalitynull
singingBeautifiernull
timbreTransformationVigorousnull
timbreTransformationDeepnull
timbreTransformationMellownull
timbreTransformationFalsettonull
timbreTransformationFullnull
timbreTransformationClearnull
timbreTransformationResoundingnull
timbreTransformationRingingnull
ultraHighQualityVoicenull
VoiceConversionPreset 5 个成员
成员值
voiceConversionOffnull
voiceChangerNeutralnull
voiceChangerSweetnull
voiceChangerSolidnull
voiceChangerBassnull
WatermarkFitMode 2 个成员
成员值
fitModeCoverPosition0
fitModeUseImageRatio1
WatermarkSourceType 4 个成员
成员值
image0
buffer1
literal2
timestamps3

错误码常量

常量值
RtcEnginenull
errAborted20
errAdmGeneralError1005
errAdmInitPlayout1008
errAdmInitRecording1011
errAdmStartPlayout1009
errAdmStartRecording1012
errAdmStopPlayout1010
errAdmStopRecording1013
errAlreadyInUse19
errBitrateLimit115
errBufferTooSmall6
errClientIsBannedByServer123
errConnectionInterrupted111
errConnectionLost112
errDatastreamDecryptionFailed122
errDecryptionFailed120
errEncryptedStreamNotAllowedPublish130
errFailed1
errInitNetEngine21
errInvalidAppId101
errInvalidArgument2
errInvalidChannelName102
errInvalidState8
errInvalidTokennull
errInvalidUserAccount134
errInvalidUserId121
errJoinChannelRejected17
errLeaveChannelRejected18
errLoadMediaEngine1001
errNoPermission9
errNoServerResources103
errNotInChannel113
errNotInitialized7
errNotReady3
errNotSupported4
errOk0
errPcmsendBufferoverflow201
errPcmsendFormat200
errRefused5
errResourceLimited22
errSetClientRoleNotAuthorized119
errSizeTooLarge114
errStreamMessageTimeout117
errTimedout10
errTokenExpired109
errTooManyDataStreams116
errVdmCameraNotAuthorized1501

已知限制

以下成员在当前版本暂不可用,调用时返回 -4(ERR_NOT_SUPPORTED)。接口定义中保留这些成员,便于跨端代码保持一致。

接口成员
AgoraPipControllerdispose
AgoraPipControllerisPipActivated
AgoraPipControllerpipDispose
AgoraPipControllerpipIsAutoEnterSupported
AgoraPipControllerpipIsSupported
AgoraPipControllerpipSetup
AgoraPipControllerpipStart
AgoraPipControllerpipStop
AgoraPipControllerregisterPipStateChangedObserver
AgoraPipControllerunregisterPipStateChangedObserver
BaseSpatialAudioEnginemuteAllRemoteAudioStreams
BaseSpatialAudioEnginemuteLocalAudioStream
BaseSpatialAudioEnginemuteRemoteAudioStream
BaseSpatialAudioEnginerelease
BaseSpatialAudioEnginesetAudioRecvRange
BaseSpatialAudioEnginesetDistanceUnit
BaseSpatialAudioEnginesetMaxAudioRecvCount
BaseSpatialAudioEnginesetPlayerAttenuation
BaseSpatialAudioEnginesetZones
BaseSpatialAudioEngineupdatePlayerPositionInfo
BaseSpatialAudioEngineupdateSelfPosition
FilterEffectOptionspath
LocalSpatialAudioEngineclearRemotePositions
LocalSpatialAudioEngineinitialize
LocalSpatialAudioEngineremoveRemotePosition
LocalSpatialAudioEnginesetRemoteAudioAttenuation
LocalSpatialAudioEngineupdateRemotePosition
MediaEnginecreateCustomAudioTrack
MediaEnginedestroyCustomAudioTrack
MediaEnginepullAudioFrame
MediaEnginepushAudioFrame
MediaEnginepushVideoFrame
MediaEngineregisterAudioFrameObserver
MediaEngineregisterFaceInfoObserver
MediaEngineregisterVideoEncodedFrameObserver
MediaEngineregisterVideoFrameObserver
MediaEnginesetExternalAudioSink
MediaEnginesetExternalAudioSource
MediaEnginesetExternalVideoSource
MediaEngineunregisterAudioFrameObserver
MediaEngineunregisterFaceInfoObserver
MediaEngineunregisterVideoEncodedFrameObserver
MediaEngineunregisterVideoFrameObserver
MediaPlayerCacheManagerenableAutoRemoveCache
MediaPlayerCacheManagergetCacheDir
MediaPlayerCacheManagergetCacheFileCount
MediaPlayerCacheManagergetMaxCacheFileCount
MediaPlayerCacheManagergetMaxCacheFileSize
MediaPlayerCacheManagergetMediaPlayerCacheManager
MediaPlayerCacheManagerremoveAllCaches
MediaPlayerCacheManagerremoveOldCache
MediaPlayerCacheManagersetCacheDir
MediaPlayerCacheManagersetMaxCacheFileCount
MediaPlayerCacheManagersetMaxCacheFileSize
MediaPlayerControllerinitialize
MediaRecordersetMediaRecorderObserver
MediaRecorderstartRecording
MediaRecorderstopRecording
MusicChartCollectionget
MusicChartCollectiongetCount
MusicCollectiongetCount
MusicCollectiongetMusic
MusicCollectiongetPage
MusicCollectiongetPageSize
MusicCollectiongetTotal
MusicContentCentercreateMusicPlayer
MusicContentCenterdestroyMusicPlayer
MusicContentCentergetInternalSongCode
MusicContentCentergetLyric
MusicContentCentergetMusicCharts
MusicContentCentergetMusicCollectionByMusicChartId
MusicContentCentergetSongSimpleInfo
MusicContentCenterinitialize
MusicContentCenterisPreloaded
MusicContentCenterpreload
MusicContentCenterregisterEventHandler
MusicContentCenterrelease
MusicContentCenterremoveCache
MusicContentCenterrenewToken
MusicContentCentersearchMusic
MusicContentCenterunregisterEventHandler
MusicPlayeropenWithSongCode
MusicPlayersetPlayMode
RtcEngineaddVideoWatermark
RtcEngineaddVideoWatermarkWithConfig
RtcEngineadjustCustomAudioPlayoutVolume
RtcEngineadjustCustomAudioPublishVolume
RtcEngineadjustLoopbackSignalVolume
RtcEngineclearVideoWatermarks
RtcEngineconfigRhythmPlayer
RtcEnginecreateCustomVideoTrack
RtcEnginecreateMediaRecorder
RtcEnginecreateVideoEffectObject
RtcEnginedestroyCustomVideoTrack
RtcEnginedestroyMediaRecorder
RtcEnginedestroyVideoEffectObject
RtcEnginedisableAudioSpectrumMonitor
RtcEngineenableAudioSpectrumMonitor
RtcEngineenableCameraCenterStage
RtcEngineenableContentInspect
RtcEngineenableCustomAudioLocalPlayback
RtcEngineenableDualStreamMode
RtcEngineenableEncryption
RtcEngineenableExtension
RtcEngineenableFaceDetection
RtcEngineenableLoopbackRecording
RtcEngineenableMultiCamera
RtcEngineenableSpatialAudio
RtcEngineenableVideoImageSource
RtcEngineenableVirtualBackground
RtcEngineenableVoiceAITuner
RtcEnginegetExtensionProperty
RtcEnginegetFaceShapeAreaOptions
RtcEnginegetFaceShapeBeautyOptions
RtcEnginegetNativeHandle
RtcEngineisCameraAutoExposureFaceModeSupported
RtcEngineisCameraCenterStageSupported
RtcEngineisCameraFaceDetectSupported
RtcEngineisFeatureAvailableOnDevice
RtcEngineisSpeakerphoneEnabled
RtcEnginejoinChannelWithUserAccountEx
RtcEngineloadExtensionProvider
RtcEnginepauseAllChannelMediaRelay
RtcEngineplayAllEffects
RtcEnginepreloadChannelWithUserAccount
RtcEnginequeryDeviceScore
RtcEnginequeryScreenCaptureCapability
RtcEngineregisterAudioEncodedFrameObserver
RtcEngineregisterAudioSpectrumObserver
RtcEngineregisterExtension
RtcEngineregisterMediaMetadataObserver
RtcEngineremoveVideoWatermark
RtcEngineresumeAllChannelMediaRelay
RtcEnginesendMetaData
RtcEnginesetBeautyEffectOptions
RtcEnginesetCameraAutoExposureFaceModeEnabled
RtcEnginesetCameraCapturerConfiguration
RtcEnginesetCameraDeviceOrientation
RtcEnginesetCameraStabilizationMode
RtcEnginesetColorEnhanceOptions
RtcEnginesetDefaultAudioRouteToSpeakerphone
RtcEnginesetEarMonitoringAudioFrameParameters
RtcEnginesetEnableSpeakerphone
RtcEnginesetExtensionProperty
RtcEnginesetExtensionProviderProperty
RtcEnginesetExternalMediaProjection
RtcEnginesetExternalRemoteEglContext
RtcEnginesetFaceShapeAreaOptions
RtcEnginesetFaceShapeBeautyOptions
RtcEnginesetFilterEffectOptions
RtcEnginesetLogFile
RtcEnginesetLogFileSize
RtcEnginesetLowlightEnhanceOptions
RtcEnginesetMixedAudioFrameParameters
RtcEnginesetParameters
RtcEnginesetPlaybackAudioFrameParameters
RtcEnginesetRecordingAudioFrameParameters
RtcEnginesetRemoteUserSpatialAudioParams
RtcEnginesetRemoteVoicePosition
RtcEnginesetRouteInCommunicationMode
RtcEnginesetVideoDenoiserOptions
RtcEnginestartAudioRecording
RtcEnginestartCameraCapture
RtcEnginestartEchoTest
RtcEnginestartLastmileProbeTest
RtcEnginestartLocalAudioMixer
RtcEnginestartLocalVideoTranscoder
RtcEnginestartMediaRenderingTracing
RtcEnginestartOrUpdateChannelMediaRelay
RtcEnginestartRhythmPlayer
RtcEnginestartRtmpStreamWithTranscoding
RtcEnginestartRtmpStreamWithoutTranscoding
RtcEnginestopAudioRecording
RtcEnginestopCameraCapture
RtcEnginestopChannelMediaRelay
RtcEnginestopEchoTest
RtcEnginestopLastmileProbeTest
RtcEnginestopLocalAudioMixer
RtcEnginestopLocalVideoTranscoder
RtcEnginestopRhythmPlayer
RtcEnginestopRtmpStream
RtcEnginetakeSnapshot
RtcEnginetakeSnapshotWithConfig
RtcEngineunloadAllEffects
RtcEngineunregisterAudioEncodedFrameObserver
RtcEngineunregisterAudioSpectrumObserver
RtcEngineunregisterMediaMetadataObserver
RtcEngineupdateLocalAudioMixerConfiguration
RtcEngineupdateLocalTranscoderConfiguration
RtcEngineupdateRtmpTranscoding
RtcEngineExaddVideoWatermarkEx
RtcEngineExaddVideoWatermarkWithConfigEx
RtcEngineExadjustUserPlaybackSignalVolumeEx
RtcEngineExclearVideoWatermarkEx
RtcEngineExcreateDataStreamEx
RtcEngineExenableContentInspectEx
RtcEngineExenableDualStreamModeEx
RtcEngineExenableEncryptionEx
RtcEngineExenableLoopbackRecordingEx
RtcEngineExpauseAllChannelMediaRelayEx
RtcEngineExplayEffectEx
RtcEngineExpreloadEffectEx
RtcEngineExremoveVideoWatermarkEx
RtcEngineExresumeAllChannelMediaRelayEx
RtcEngineExsendCustomReportMessageEx
RtcEngineExsetDualStreamModeEx
RtcEngineExsetRemoteRenderModeEx
RtcEngineExsetRemoteVideoStreamTypeEx
RtcEngineExsetRemoteVideoSubscriptionOptionsEx
RtcEngineExsetRemoteVoicePositionEx
RtcEngineExsetSubscribeAudioAllowlistEx
RtcEngineExsetSubscribeAudioBlocklistEx
RtcEngineExsetSubscribeVideoAllowlistEx
RtcEngineExsetSubscribeVideoBlocklistEx
RtcEngineExstartMediaRenderingTracingEx
RtcEngineExstartOrUpdateChannelMediaRelayEx
RtcEngineExstartRtmpStreamWithTranscodingEx
RtcEngineExstartRtmpStreamWithoutTranscodingEx
RtcEngineExstopChannelMediaRelayEx
RtcEngineExstopRtmpStreamEx
RtcEngineExtakeSnapshotEx
RtcEngineExtakeSnapshotWithConfigEx
RtcEngineExupdateRtmpTranscodingEx
RtcEngineExtgetAssetAbsolutePath
VideoEffectObjectaddOrUpdateVideoEffect
VideoEffectObjectgetVideoEffectBoolParam
VideoEffectObjectgetVideoEffectFloatParam
VideoEffectObjectgetVideoEffectIntParam
VideoEffectObjectperformVideoEffectAction
VideoEffectObjectremoveVideoEffect
VideoEffectObjectsetVideoEffectBoolParam
VideoEffectObjectsetVideoEffectFloatParam
VideoEffectObjectsetVideoEffectIntParam

本页由文档构建流水线生成 · 2026-10-31 01:24:02 UTC · 文档中心 v1.1.0.

内容依据公开 API 定义.

ni-meet 是自建 RTC PaaS,媒体面基于 LiveKit(Apache-2.0),并与声网 API 兼容。