nimeet 文档中心
English

Unreal Engine(Blueprint) API 参考

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

由公开 SDK 接口定义生成

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

接口概览

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

核对项数量
接口 / 类90
方法458
方法重载458
属性435
枚举103
错误码常量6

可用性

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

加入频道核心链路

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

步骤接口方法重载数
加入频道__unattributed__JoinChannel1
离开频道__unattributed__LeaveChannel1
开启视频与预览IRtcEngineEnableVideo1
创建 / 初始化IRtcEngineInitialize1
订阅远端媒体IRtcEngineMuteRemoteAudioStream1
续期 TokenIRtcEngineRenewToken1
频道场景IRtcEngineSetChannelProfile1
角色切换IRtcEngineSetClientRole1
本地画面IRtcEngineSetupLocalVideo1

最小可运行链路的参数

参数类型可选可变参数
tokenconst FString&否否
channelIdconst FString&否否
uidint64否否
contextconst FRtcEngineContext&否否
uidint64否否
mutebool否否
tokenconst FString&否否
profileECHANNEL_PROFILE_TYPE否否
optionsFClientRoleOptions否否
clientroletypeECLIENT_ROLE_TYPE是否
canvasconst FVideoCanvas&否否

接口索引

接口方法属性事件
__unattributed__1600
FAdvancedAudioOptions010
FAdvancedConfigInfo010
FAgoraMediaSource080
FAgoraRhythmPlayerConfig020
FAudioRecordingConfiguration060
FAudioVolumeInfo040
FBeautyOptions050
FCacheStatistics030
FCameraCapturerConfiguration060
FChannelMediaInfo030
FChannelMediaOptions0290
FChannelMediaRelayConfiguration030
FClientRoleOptions010
FCodecCapInfo030
FCodecCapLevels020
FColorEnhanceOptions020
FContentInspectConfig040
FContentInspectModule020
FDataStreamConfig020
FDeviceInfo010
FDirectCdnStreamingStats050
FEchoTestConfiguration060
FEncryptionConfig040
FExtensionContext040
FFocalLengthInfo020
FImageTrackOptions020
FLastmileProbeConfig040
FLastmileProbeOneWayResult030
FLastmileProbeResult040
FLeaveChannelOptions030
FLiveStreamAdvancedFeature020
FLiveTranscoding0230
FLocalAccessPointConfiguration070
FLocalAudioStats080
FLocalTranscoderConfiguration030
FLocalVideoStats0220
FLogConfig030
FLogUploadServerInfo040
FPlayerPlaybackStats040
FPlayerStreamInfo0130
FPlayerUpdatedInfo060
FRectangle040
FRemoteAudioStats0160
FRemoteVideoStats0160
FRtcEngineContext080
FRtcImage070
FRtcStats0240
FScreenAudioParameters030
FScreenCaptureConfiguration060
FScreenCaptureParameters0100
FScreenCaptureParameters2040
FScreenCaptureSourceInfo0110
FScreenVideoParameters040
FSegmentationProperty020
FSimulcastStreamConfig030
FSrcInfo020
FThumbImageBuffer040
FTranscodingUser080
FTranscodingVideoStream0110
FUABT_AdvanceOptions030
FUABT_FaceShapeAreaOptions020
FUABT_FaceShapeBeautyOptions020
FUABT_FilterEffectOptions110
FUABT_LowlightEnhanceOptions020
FUABT_RtcConnection020
FUABT_SnapshotConfig020
FUABT_VideoDenoiserOptions020
FUABT_VideoDimensions020
FUABT_VideoEncoderConfiguration090
FUplinkNetworkInfo010
FUserInfo020
FVideoCanvas1100
FVideoFormat030
FVideoLayout080
FVideoRenderingTracingInfo070
FVideoSubscriptionOptions020
FVirtualBackgroundSource040
FWatermarkOptions050
FWatermarkRatio030
IAudioDeviceCollection900
IAudioDeviceManager2400
IMediaPlayer3400
IMediaPlayerSourceObserver1100
IRtcEngine22400
IRtcEngineEventHandler8300
IRtcEngineEx4400
IScreenCaptureSourceList300
IVideoDeviceCollection400
IVideoDeviceManager400

全部接口

__unattributed__ 16 方法 / 0 属性
typescript
AddBlueprintCallbackExecutor(Executor: UAgoraBPuIRtcEngineEventHandlerCBExecutor*): void
AddBlueprintCallbackExecutorEx(Executor: UAgoraBPuIRtcEngineEventHandlerExCBExecutor*): void
ClearAllEventHandlerCBExecutors(): void
FollowSystemLoopbackDevice(enable: bool): int
GetAgoraAudioDeviceManager(): UAgoraBPuAudioDeviceManager*
GetAgoraVideoDeviceManager(): UAgoraBPuVideoDeviceManager*
GetEventHandler(HandlerType: EAgoraBPuEventHandlerType&, EventHandler: UAgoraBPuIRtcEngineEventHandler*&, EventHandlerEx: UAgoraBPuIRtcEngineEventHandlerEx*&): void
GetLoopbackDevice(deviceId: FString&): int
GetMediaPlayerSourceObserver(): UAgoraBPuIMediaPlayerSourceObserver*
GetPlaybackDeviceVolume(volume: int&): int
JoinChannel(token: const FString&, channelId: const FString&, uid: int64): int
LeaveChannel(): int
SetAudioProfile(profile?: EAUDIO_PROFILE_TYPE): int
SetLocalAccessPoint(config: const FLocalAccessPointConfiguration&): int
SetLoopbackDevice(deviceId: const FString&): int
SetRouteInCommunicationMode(route: int): int

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

方法参数返回值错误
AddBlueprintCallbackExecutorExecutor: UAgoraBPuIRtcEngineEventHandlerCBExecutor*void错误码索引
AddBlueprintCallbackExecutorExExecutor: UAgoraBPuIRtcEngineEventHandlerExCBExecutor*void错误码索引
ClearAllEventHandlerCBExecutors—void错误码索引
FollowSystemLoopbackDeviceenable: boolint错误码索引
GetAgoraAudioDeviceManager—UAgoraBPuAudioDeviceManager*错误码索引
GetAgoraVideoDeviceManager—UAgoraBPuVideoDeviceManager*错误码索引
GetEventHandlerHandlerType: EAgoraBPuEventHandlerType&, EventHandler: UAgoraBPuIRtcEngineEventHandler*&, EventHandlerEx: UAgoraBPuIRtcEngineEventHandlerEx*&void错误码索引
GetLoopbackDevicedeviceId: FString&int错误码索引
GetMediaPlayerSourceObserver—UAgoraBPuIMediaPlayerSourceObserver*错误码索引
GetPlaybackDeviceVolumevolume: int&int错误码索引
JoinChanneltoken: const FString&, channelId: const FString&, uid: int64int错误码索引
LeaveChannel—int错误码索引
SetAudioProfileprofile?: EAUDIO_PROFILE_TYPEint错误码索引
SetLocalAccessPointconfig: const FLocalAccessPointConfiguration&int错误码索引
SetLoopbackDevicedeviceId: const FString&int错误码索引
SetRouteInCommunicationModeroute: intint错误码索引
FAdvancedAudioOptions 0 方法 / 1 属性
属性类型只读
audioProcessingChannelsunknown否
FAdvancedConfigInfo 0 方法 / 1 属性
属性类型只读
logUploadServerunknown否
FAgoraMediaSource 0 方法 / 8 属性
属性类型只读
urlunknown否
uriunknown否
startPosunknown否
autoPlayunknown否
enableCacheunknown否
enableMultiAudioTrackunknown否
isAgoraSourceunknown否
isLiveSourceunknown否
FAgoraRhythmPlayerConfig 0 方法 / 2 属性
属性类型只读
beatsPerMeasureunknown否
beatsPerMinuteunknown否
FAudioRecordingConfiguration 0 方法 / 6 属性
属性类型只读
filePathunknown否
encodeunknown否
sampleRateunknown否
fileRecordingTypeunknown否
qualityunknown否
recordingChannelunknown否
FAudioVolumeInfo 0 方法 / 4 属性
属性类型只读
uidunknown否
volumeunknown否
vadunknown否
voicePitchunknown否
FBeautyOptions 0 方法 / 5 属性
属性类型只读
lighteningContrastLevelunknown否
lighteningLevelunknown否
smoothnessLevelunknown否
rednessLevelunknown否
sharpnessLevelunknown否
FCacheStatistics 0 方法 / 3 属性
属性类型只读
fileSizeunknown否
cacheSizeunknown否
downloadSizeunknown否
FCameraCapturerConfiguration 0 方法 / 6 属性
属性类型只读
cameraDirectionunknown否
cameraIdunknown否
cameraFocalLengthTypeunknown否
formatunknown否
deviceIdunknown否
followEncodeDimensionRatiounknown否
FChannelMediaInfo 0 方法 / 3 属性
属性类型只读
channelNameunknown否
tokenunknown否
uidunknown否
FChannelMediaOptions 0 方法 / 29 属性
属性类型只读
publishCameraTrackunknown否
publishSecondaryCameraTrackunknown否
publishMicrophoneTrackunknown否
publishThirdCameraTrackunknown否
publishFourthCameraTrackunknown否
publishScreenTrackunknown否
publishScreenCaptureVideounknown否
publishScreenCaptureAudiounknown否
publishSecondaryScreenTrackunknown否
publishThirdScreenTrackunknown否
publishFourthScreenTrackunknown否
publishTranscodedVideoTrackunknown否
publishMixedAudioTrackunknown否
publishEncodedVideoTrackunknown否
publishMediaPlayerAudioTrackunknown否
publishMediaPlayerVideoTrackunknown否
autoSubscribeAudiounknown否
autoSubscribeVideounknown否
enableAudioRecordingOrPlayoutunknown否
publishMediaPlayerIdunknown否
clientRoleTypeunknown否
audienceLatencyLevelunknown否
defaultVideoStreamTypeunknown否
channelProfileunknown否
audioDelayMsunknown否
tokenunknown否
publishRhythmPlayerTrackunknown否
isInteractiveAudienceunknown否
isAudioFilterableunknown否
FChannelMediaRelayConfiguration 0 方法 / 3 属性
属性类型只读
srcInfounknown否
destInfosunknown否
destCountunknown否
FClientRoleOptions 0 方法 / 1 属性
属性类型只读
audienceLatencyLevelunknown否
FCodecCapInfo 0 方法 / 3 属性
属性类型只读
codecTypeunknown否
codecCapMaskunknown否
codecLevelsunknown否
FCodecCapLevels 0 方法 / 2 属性
属性类型只读
hwDecodingLevelunknown否
swDecodingLevelunknown否
FColorEnhanceOptions 0 方法 / 2 属性
属性类型只读
strengthLevelunknown否
skinProtectLevelunknown否
FContentInspectConfig 0 方法 / 4 属性
属性类型只读
extraInfounknown否
serverConfigunknown否
modulesunknown否
moduleCountunknown否
FContentInspectModule 0 方法 / 2 属性
属性类型只读
typeunknown否
intervalunknown否
FDataStreamConfig 0 方法 / 2 属性
属性类型只读
syncWithAudiounknown否
orderedunknown否
FDeviceInfo 0 方法 / 1 属性
属性类型只读
isLowLatencyAudioSupportedunknown否
FDirectCdnStreamingStats 0 方法 / 5 属性
属性类型只读
videoWidthunknown否
videoHeightunknown否
fpsunknown否
videoBitrateunknown否
audioBitrateunknown否
FEchoTestConfiguration 0 方法 / 6 属性
属性类型只读
viewunknown否
enableAudiounknown否
enableVideounknown否
tokenunknown否
channelIdunknown否
intervalInSecondsunknown否
FEncryptionConfig 0 方法 / 4 属性
属性类型只读
encryptionModeunknown否
encryptionKeyunknown否
encryptionKdfSaltunknown否
datastreamEncryptionEnabledunknown否
FExtensionContext 0 方法 / 4 属性
属性类型只读
isValidunknown否
uidunknown否
providerNameunknown否
extensionNameunknown否
FFocalLengthInfo 0 方法 / 2 属性
属性类型只读
cameraDirectionunknown否
focalLengthTypeunknown否
FImageTrackOptions 0 方法 / 2 属性
属性类型只读
imageUrlunknown否
fpsunknown否
FLastmileProbeConfig 0 方法 / 4 属性
属性类型只读
probeUplinkunknown否
probeDownlinkunknown否
expectedUplinkBitrateunknown否
expectedDownlinkBitrateunknown否
FLastmileProbeOneWayResult 0 方法 / 3 属性
属性类型只读
packetLossRateunknown否
jitterunknown否
availableBandwidthunknown否
FLastmileProbeResult 0 方法 / 4 属性
属性类型只读
stateunknown否
uplinkReportunknown否
downlinkReportunknown否
rttunknown否
FLeaveChannelOptions 0 方法 / 3 属性
属性类型只读
stopAudioMixingunknown否
stopAllEffectunknown否
stopMicrophoneRecordingunknown否
FLiveStreamAdvancedFeature 0 方法 / 2 属性
属性类型只读
featureNameunknown否
openedunknown否
FLiveTranscoding 0 方法 / 23 属性
属性类型只读
widthunknown否
heightunknown否
videoBitrateunknown否
videoFrameRateunknown否
lowLatencyunknown否
videoGopunknown否
videoCodecProfileunknown否
videoCodecTypeunknown否
transcodingUsersunknown否
transcodingExtraInfounknown否
backgroundColorunknown否
userCountunknown否
metadataunknown否
watermarkunknown否
backgroundImageunknown否
audioSampleRateunknown否
audioBitrateunknown否
audioChannelsunknown否
audioCodecProfileunknown否
watermarkCountunknown否
backgroundImageCountunknown否
advancedFeaturesunknown否
advancedFeatureCountunknown否
FLocalAccessPointConfiguration 0 方法 / 7 属性
属性类型只读
ipListunknown否
ipListSizeunknown否
domainListunknown否
domainListSizeunknown否
verifyDomainNameunknown否
modeunknown否
advancedConfigunknown否
FLocalAudioStats 0 方法 / 8 属性
属性类型只读
numChannelsunknown否
sentSampleRateunknown否
sentBitrateunknown否
txPacketLossRateunknown否
internalCodecunknown否
audioDeviceDelayunknown否
earMonitorDelayunknown否
aecEstimatedDelayunknown否
FLocalTranscoderConfiguration 0 方法 / 3 属性
属性类型只读
streamCountunknown否
videoInputStreamsunknown否
videoOutputConfigurationunknown否
FLocalVideoStats 0 方法 / 22 属性
属性类型只读
uidunknown否
sentBitrateunknown否
sentFrameRateunknown否
captureFrameRateunknown否
captureFrameWidthunknown否
captureFrameHeightunknown否
regulatedCaptureFrameRateunknown否
regulatedCaptureFrameWidthunknown否
regulatedCaptureFrameHeightunknown否
encoderOutputFrameRateunknown否
rendererOutputFrameRateunknown否
targetBitrateunknown否
targetFrameRateunknown否
qualityAdaptIndicationunknown否
encodedBitrateint否
encodedFrameHeightunknown否
encodedFrameWidthunknown否
encodedFrameCountunknown否
codecTypeunknown否
txPacketLossRateunknown否
captureBrightnessLevelunknown否
hwEncoderAcceleratingunknown否
FLogConfig 0 方法 / 3 属性
属性类型只读
filePathunknown否
fileSizeInKBunknown否
levelunknown否
FLogUploadServerInfo 0 方法 / 4 属性
属性类型只读
serverDomainunknown否
serverPathunknown否
serverPortunknown否
serverHttpsunknown否
FPlayerPlaybackStats 0 方法 / 4 属性
属性类型只读
videoFpsunknown否
videoBitrateInKbpsunknown否
audioBitrateInKbpsunknown否
totalBitrateInKbpsunknown否
FPlayerStreamInfo 0 方法 / 13 属性
属性类型只读
streamIndexunknown否
streamTypeunknown否
codecNameunknown否
languageunknown否
videoFrameRateunknown否
videoBitRateunknown否
videoWidthunknown否
videoHeightunknown否
videoRotationunknown否
audioSampleRateunknown否
audioChannelsunknown否
audioBitsPerSampleunknown否
durationunknown否
FPlayerUpdatedInfo 0 方法 / 6 属性
属性类型只读
deviceIdunknown否
videoHeightunknown否
videoWidthunknown否
audioSampleRateunknown否
audioChannelsunknown否
audioBitsPerSampleunknown否
FRectangle 0 方法 / 4 属性
属性类型只读
xunknown否
yunknown否
widthunknown否
heightunknown否
FRemoteAudioStats 0 方法 / 16 属性
属性类型只读
uidunknown否
qualityunknown否
networkTransportDelayunknown否
jitterBufferDelayunknown否
audioLossRateunknown否
numChannelsunknown否
receivedSampleRateunknown否
receivedBitrateunknown否
totalFrozenTimeunknown否
frozenRateunknown否
totalActiveTimeunknown否
publishDurationunknown否
qoeQualityunknown否
qualityChangedReasonunknown否
mosValueunknown否
e2eDelayunknown否
FRemoteVideoStats 0 方法 / 16 属性
属性类型只读
uidunknown否
delayunknown否
e2eDelayunknown否
widthunknown否
heightunknown否
receivedBitrateunknown否
decoderOutputFrameRateunknown否
rendererOutputFrameRateunknown否
frameLossRateunknown否
packetLossRateunknown否
rxStreamTypeunknown否
totalFrozenTimeunknown否
frozenRateunknown否
totalActiveTimeunknown否
publishDurationunknown否
avSyncTimeMsunknown否
FRtcEngineContext 0 方法 / 8 属性
属性类型只读
eventHandlerunknown否
appIdunknown否
channelProfileunknown否
audioScenariounknown否
areaCodeunknown否
logConfigunknown否
domainLimitunknown否
autoRegisterAgoraExtensionsunknown否
FRtcImage 0 方法 / 7 属性
属性类型只读
urlunknown否
xunknown否
yunknown否
widthunknown否
heightunknown否
zOrderunknown否
alphaunknown否
FRtcStats 0 方法 / 24 属性
属性类型只读
durationunknown否
txBytesunknown否
rxBytesunknown否
txAudioBytesunknown否
txVideoBytesunknown否
rxAudioBytesunknown否
rxVideoBytesunknown否
txKBitRateunknown否
rxKBitRateunknown否
rxAudioKBitRateunknown否
txAudioKBitRateunknown否
rxVideoKBitRateunknown否
txVideoKBitRateunknown否
lastmileDelayunknown否
txPacketLossRateunknown否
rxPacketLossRateunknown否
userCountunknown否
cpuAppUsageunknown否
cpuTotalUsageunknown否
connectTimeMsunknown否
gatewayRttunknown否
memoryAppUsageRatiounknown否
memoryTotalUsageRatiounknown否
memoryAppUsageInKbytesunknown否
FScreenAudioParameters 0 方法 / 3 属性
属性类型只读
sampleRateunknown否
channelsunknown否
captureSignalVolumeunknown否
FScreenCaptureConfiguration 0 方法 / 6 属性
属性类型只读
isCaptureWindowunknown否
displayIdunknown否
screenRectunknown否
windowIdunknown否
paramsunknown否
regionRectunknown否
FScreenCaptureParameters 0 方法 / 10 属性
属性类型只读
dimensionsunknown否
frameRateunknown否
bitrateunknown否
captureMouseCursorunknown否
windowFocusunknown否
excludeWindowListunknown否
enableHighLightunknown否
highLightColorunknown否
highLightWidthunknown否
excludeWindowCountunknown否
FScreenCaptureParameters2 0 方法 / 4 属性
属性类型只读
captureAudiounknown否
audioParamsunknown否
captureVideounknown否
videoParamsunknown否
FScreenCaptureSourceInfo 0 方法 / 11 属性
属性类型只读
typeunknown否
sourceIdunknown否
sourceNameunknown否
thumbImageunknown否
iconImageunknown否
processPathunknown否
sourceTitleunknown否
primaryMonitorunknown否
positionunknown否
minimizeWindowunknown否
sourceDisplayIdunknown否
FScreenVideoParameters 0 方法 / 4 属性
属性类型只读
dimensionsunknown否
frameRateunknown否
bitrateunknown否
contentHintunknown否
FSegmentationProperty 0 方法 / 2 属性
属性类型只读
modelTypeunknown否
greenCapacityunknown否
FSimulcastStreamConfig 0 方法 / 3 属性
属性类型只读
dimensionsunknown否
kBitrateunknown否
framerateunknown否
FSrcInfo 0 方法 / 2 属性
属性类型只读
bitrateInKbpsunknown否
nameunknown否
FThumbImageBuffer 0 方法 / 4 属性
属性类型只读
bufferi否
lengthunknown否
widthunknown否
heightunknown否
FTranscodingUser 0 方法 / 8 属性
属性类型只读
uidunknown否
xunknown否
yunknown否
widthunknown否
heightunknown否
zOrderunknown否
alphaunknown否
audioChannelunknown否
FTranscodingVideoStream 0 方法 / 11 属性
属性类型只读
sourceTypeunknown否
remoteUserUidunknown否
imageUrlunknown否
mediaPlayerIdunknown否
xunknown否
yunknown否
widthunknown否
heightunknown否
zOrderunknown否
alphaunknown否
mirrorunknown否
FUABT_AdvanceOptions 0 方法 / 3 属性
属性类型只读
encodingPreferenceunknown否
compressionPreferenceunknown否
encodeAlphaunknown否
FUABT_FaceShapeAreaOptions 0 方法 / 2 属性
属性类型只读
shapeAreaunknown否
shapeIntensityunknown否
FUABT_FaceShapeBeautyOptions 0 方法 / 2 属性
属性类型只读
shapeStyleunknown否
styleIntensityunknown否
FUABT_FilterEffectOptions 1 方法 / 1 属性
typescript
path(): unknown

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

方法参数返回值错误
path—unknown错误码索引
属性类型只读
strengthunknown否
FUABT_LowlightEnhanceOptions 0 方法 / 2 属性
属性类型只读
levelunknown否
modeunknown否
FUABT_RtcConnection 0 方法 / 2 属性
属性类型只读
channelIdunknown否
localUidunknown否
FUABT_SnapshotConfig 0 方法 / 2 属性
属性类型只读
filePathunknown否
positionunknown否
FUABT_VideoDenoiserOptions 0 方法 / 2 属性
属性类型只读
levelunknown否
modeunknown否
FUABT_VideoDimensions 0 方法 / 2 属性
属性类型只读
widthunknown否
heightunknown否
FUABT_VideoEncoderConfiguration 0 方法 / 9 属性
属性类型只读
dimensionsunknown否
codecTypeunknown否
frameRateunknown否
bitrateunknown否
minBitrateunknown否
orientationModeunknown否
degradationPreferenceunknown否
mirrorModeunknown否
advanceOptionsunknown否
FUplinkNetworkInfo 0 方法 / 1 属性
属性类型只读
video_encoder_target_bitrate_bpsunknown否
FUserInfo 0 方法 / 2 属性
属性类型只读
uidunknown否
userAccountunknown否
FVideoCanvas 1 方法 / 10 属性
typescript
view(): unknown

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

方法参数返回值错误
view—unknown错误码索引
属性类型只读
uidunknown否
subviewUidunknown否
renderModeunknown否
mirrorModeunknown否
sourceTypeunknown否
setupModeunknown否
cropAreaunknown否
backgroundColorunknown否
enableAlphaMaskunknown否
positionunknown否
FVideoFormat 0 方法 / 3 属性
属性类型只读
widthunknown否
heightunknown否
fpsunknown否
FVideoLayout 0 方法 / 8 属性
属性类型只读
channelIdunknown否
uidunknown否
strUidunknown否
xunknown否
yunknown否
widthunknown否
heightunknown否
videoStateunknown否
FVideoRenderingTracingInfo 0 方法 / 7 属性
属性类型只读
elapsedTimeunknown否
start2JoinChannelunknown否
join2JoinSuccessunknown否
joinSuccess2RemoteJoinedunknown否
remoteJoined2SetViewunknown否
remoteJoined2UnmuteVideounknown否
remoteJoined2PacketReceivedunknown否
FVideoSubscriptionOptions 0 方法 / 2 属性
属性类型只读
typeunknown否
encodedFrameOnlyunknown否
FVirtualBackgroundSource 0 方法 / 4 属性
属性类型只读
background_source_typeunknown否
colorunknown否
sourceunknown否
blur_degreeunknown否
FWatermarkOptions 0 方法 / 5 属性
属性类型只读
visibleInPreviewunknown否
positionInLandscapeModeunknown否
positionInPortraitModeunknown否
watermarkRatiounknown否
modeunknown否
FWatermarkRatio 0 方法 / 3 属性
属性类型只读
xRatiounknown否
yRatiounknown否
widthRatiounknown否
IAudioDeviceCollection 9 方法 / 0 属性
typescript
GetApplicationVolume(volume: int&): int
GetCount(): int
GetDefaultDevice(deviceName: FString&, deviceId: FString&): int
GetDevice(index: int, deviceName: FString&, deviceId: FString&): int
IsApplicationMute(mute: bool): int
Release(): void
SetApplicationMute(mute: bool): int
SetApplicationVolume(volume: int): int
SetDevice(deviceId: const FString&): int

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

方法参数返回值错误
GetApplicationVolumevolume: int&int错误码索引
GetCount—int错误码索引
GetDefaultDevicedeviceName: FString&, deviceId: FString&int错误码索引
GetDeviceindex: int, deviceName: FString&, deviceId: FString&int错误码索引
IsApplicationMutemute: boolint错误码索引
Release—void错误码索引
SetApplicationMutemute: boolint错误码索引
SetApplicationVolumevolume: intint错误码索引
SetDevicedeviceId: const FString&int错误码索引
IAudioDeviceManager 24 方法 / 0 属性
typescript
EnumeratePlaybackDevices(): UAudioDeviceCollection*
EnumerateRecordingDevices(): UAudioDeviceCollection*
FollowSystemPlaybackDevice(enable: bool): int
FollowSystemRecordingDevice(enable: bool): int
GetPlaybackDevice(deviceId: FString&): int
GetPlaybackDeviceInfo(deviceId: FString&, deviceName: FString&, deviceTypeName: FString&): int
GetPlaybackDeviceMute(mute: bool&): int
GetRecordingDevice(deviceId: FString&): int
GetRecordingDeviceInfo(deviceId: FString&, deviceName: FString&, deviceTypeName: FString&): int
GetRecordingDeviceMute(mute: bool&): int
GetRecordingDeviceVolume(volume: int&): int
Release(): void
SetPlaybackDevice(deviceId: const FString&): int
SetPlaybackDeviceMute(mute: bool): int
SetPlaybackDeviceVolume(volume: int): int
SetRecordingDevice(deviceId: const FString&): int
SetRecordingDeviceMute(mute: bool): int
SetRecordingDeviceVolume(volume: int): int
StartAudioDeviceLoopbackTest(indicationInterval: int): int
StartPlaybackDeviceTest(testAudioFilePath: const FString&): int
StartRecordingDeviceTest(indicationInterval: int): int
StopAudioDeviceLoopbackTest(): int
StopPlaybackDeviceTest(): int
StopRecordingDeviceTest(): int

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

方法参数返回值错误
EnumeratePlaybackDevices—UAudioDeviceCollection*错误码索引
EnumerateRecordingDevices—UAudioDeviceCollection*错误码索引
FollowSystemPlaybackDeviceenable: boolint错误码索引
FollowSystemRecordingDeviceenable: boolint错误码索引
GetPlaybackDevicedeviceId: FString&int错误码索引
GetPlaybackDeviceInfodeviceId: FString&, deviceName: FString&, deviceTypeName: FString&int错误码索引
GetPlaybackDeviceMutemute: bool&int错误码索引
GetRecordingDevicedeviceId: FString&int错误码索引
GetRecordingDeviceInfodeviceId: FString&, deviceName: FString&, deviceTypeName: FString&int错误码索引
GetRecordingDeviceMutemute: bool&int错误码索引
GetRecordingDeviceVolumevolume: int&int错误码索引
Release—void错误码索引
SetPlaybackDevicedeviceId: const FString&int错误码索引
SetPlaybackDeviceMutemute: boolint错误码索引
SetPlaybackDeviceVolumevolume: intint错误码索引
SetRecordingDevicedeviceId: const FString&int错误码索引
SetRecordingDeviceMutemute: boolint错误码索引
SetRecordingDeviceVolumevolume: intint错误码索引
StartAudioDeviceLoopbackTestindicationInterval: intint错误码索引
StartPlaybackDeviceTesttestAudioFilePath: const FString&int错误码索引
StartRecordingDeviceTestindicationInterval: intint错误码索引
StopAudioDeviceLoopbackTest—int错误码索引
StopPlaybackDeviceTest—int错误码索引
StopRecordingDeviceTest—int错误码索引
IMediaPlayer 34 方法 / 0 属性
typescript
AdjustPlayoutVolume(volume: int): int
AdjustPublishSignalVolume(volume: int): int
GetDuration(duration: int64&): int
GetMediaPlayerId(): int
GetMute(muted: bool&): int
GetPlayPosition(pos: int64&): int
GetPlaySrc(): FString
GetPlayoutVolume(volume: int&): int
GetPublishSignalVolume(volume: int&): int
GetState(): EMEDIA_PLAYER_STATE
GetStreamCount(count: int64&): int
GetStreamInfo(index: int64, info: FPlayerStreamInfo&): int
Mute(muted: bool): int
Open(url: const FString&, startPos: int64): int
OpenWithMediaSource(source: const FAgoraMediaSource&): int
Pause(): int
Play(): int
PlayPreloadedSrc(src: const FString&): int
PreloadSrc(src: const FString&, startPos: int64): int
Resume(): int
Seek(newPos: int64): int
SelectAudioTrack(index: int): int
SelectMultiAudioTrack(playoutTrackIndex: int, publishTrackIndex: int): int
SetAudioDualMonoMode(mode: EAUDIO_DUAL_MONO_MODE): int
SetAudioPitch(pitch: int): int
SetLoopCount(loopCount: int): int
SetPlaybackSpeed(speed: int): int
SetPlayerOptionWithInt(key: const FString&, value: int): int
SetPlayerOptionWithString(key: const FString&, value: const FString&): int
SetRenderMode(renderMode: ERENDER_MODE_TYPE): int
SetView(view: int64): int
Stop(): int
SwitchSrc(src: const FString&, syncPts?: bool): int
UnloadSrc(src: const FString&): int

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

方法参数返回值错误
AdjustPlayoutVolumevolume: intint错误码索引
AdjustPublishSignalVolumevolume: intint错误码索引
GetDurationduration: int64&int错误码索引
GetMediaPlayerId—int错误码索引
GetMutemuted: bool&int错误码索引
GetPlayPositionpos: int64&int错误码索引
GetPlaySrc—FString错误码索引
GetPlayoutVolumevolume: int&int错误码索引
GetPublishSignalVolumevolume: int&int错误码索引
GetState—EMEDIA_PLAYER_STATE错误码索引
GetStreamCountcount: int64&int错误码索引
GetStreamInfoindex: int64, info: FPlayerStreamInfo&int错误码索引
Mutemuted: boolint错误码索引
Openurl: const FString&, startPos: int64int错误码索引
OpenWithMediaSourcesource: const FAgoraMediaSource&int错误码索引
Pause—int错误码索引
Play—int错误码索引
PlayPreloadedSrcsrc: const FString&int错误码索引
PreloadSrcsrc: const FString&, startPos: int64int错误码索引
Resume—int错误码索引
SeeknewPos: int64int错误码索引
SelectAudioTrackindex: intint错误码索引
SelectMultiAudioTrackplayoutTrackIndex: int, publishTrackIndex: intint错误码索引
SetAudioDualMonoModemode: EAUDIO_DUAL_MONO_MODEint错误码索引
SetAudioPitchpitch: intint错误码索引
SetLoopCountloopCount: intint错误码索引
SetPlaybackSpeedspeed: intint错误码索引
SetPlayerOptionWithIntkey: const FString&, value: intint错误码索引
SetPlayerOptionWithStringkey: const FString&, value: const FString&int错误码索引
SetRenderModerenderMode: ERENDER_MODE_TYPEint错误码索引
SetViewview: int64int错误码索引
Stop—int错误码索引
SwitchSrcsrc: const FString&, syncPts?: boolint错误码索引
UnloadSrcsrc: const FString&int错误码索引
IMediaPlayerSourceObserver 11 方法 / 0 属性
typescript
OnAudioVolumeIndication(volume: int): void
OnMetaData(Data: const FString&): void
OnPlayBufferUpdated(playCachedBuffer: int64): void
OnPlayerCacheStats(stats: const FCacheStatistics&): void
OnPlayerEvent(eventCode: EMEDIA_PLAYER_EVENT, elapsedTime: int64, message: const FString&): void
OnPlayerInfoUpdated(info: const FPlayerUpdatedInfo&): void
OnPlayerPlaybackStats(stats: const FPlayerPlaybackStats&): void
OnPlayerSourceStateChanged(state: EMEDIA_PLAYER_STATE, ec: FENUMWRAP_MEDIA_PLAYER_REASON): void
OnPlayerSrcInfoChanged(from: const FSrcInfo&, to: const FSrcInfo&): void
OnPositionChanged(position_ms: int64, timestampMs: int64): void
OnPreloadEvent(src: const FString&, event: EPLAYER_PRELOAD_EVENT): void

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

方法参数返回值错误
OnAudioVolumeIndicationvolume: intvoid错误码索引
OnMetaDataData: const FString&void错误码索引
OnPlayBufferUpdatedplayCachedBuffer: int64void错误码索引
OnPlayerCacheStatsstats: const FCacheStatistics&void错误码索引
OnPlayerEventeventCode: EMEDIA_PLAYER_EVENT, elapsedTime: int64, message: const FString&void错误码索引
OnPlayerInfoUpdatedinfo: const FPlayerUpdatedInfo&void错误码索引
OnPlayerPlaybackStatsstats: const FPlayerPlaybackStats&void错误码索引
OnPlayerSourceStateChangedstate: EMEDIA_PLAYER_STATE, ec: FENUMWRAP_MEDIA_PLAYER_REASONvoid错误码索引
OnPlayerSrcInfoChangedfrom: const FSrcInfo&, to: const FSrcInfo&void错误码索引
OnPositionChangedposition_ms: int64, timestampMs: int64void错误码索引
OnPreloadEventsrc: const FString&, event: EPLAYER_PRELOAD_EVENTvoid错误码索引
IRtcEngine 224 方法 / 0 属性
typescript
AddVideoWatermark(watermarkUrl: const FString&, options: const FWatermarkOptions&): int
AdjustAudioMixingPlayoutVolume(volume: int): int
AdjustAudioMixingPublishVolume(volume: int): int
AdjustAudioMixingVolume(volume: int): int
AdjustLoopbackSignalVolume(volume: int): int
AdjustPlaybackSignalVolume(volume: int): int
AdjustRecordingSignalVolume(volume: int): int
AdjustUserPlaybackSignalVolume(uid: int64, volume: int): int
ClearVideoWatermarks(): int
Complain(callId: const FString&, description: const FString&): int
ConfigRhythmPlayer(config: const FAgoraRhythmPlayerConfig&): int
CreateDataStream(streamId: int&, config: const FDataStreamConfig&): int
DisableAudio(): int
DisableVideo(): int
EnableAudio(): int
EnableAudioVolumeIndication(interval: int, smooth: int, reportVad: bool): int
EnableCameraCenterStage(enabled: bool): int
EnableContentInspect(enabled: bool, config: const FContentInspectConfig&): int
EnableDualStreamMode(enabled: bool, streamConfig: const FSimulcastStreamConfig&): int
EnableEncryption(enabled: bool, config: const FEncryptionConfig&): int
EnableExtension(provider: const FString&, extension: const FString&, enable?: bool, type?: EMEDIA_SOURCE_TYPE): int
EnableFaceDetection(enabled: bool): int
EnableInEarMonitoring(enabled: bool, includeAudioFilters: int): int
EnableInstantMediaRendering(): int
EnableLocalAudio(enabled: bool): int
EnableLocalVideo(enabled: bool): int
EnableLoopbackRecording(enabled: bool, deviceName: const FString&): int
EnableMultiCamera(enabled: bool, config: const FCameraCapturerConfiguration&): int
EnableSoundPositionIndication(enabled: bool): int
EnableVideo(): int
EnableVideoImageSource(enable: bool, options: const FImageTrackOptions&): int
EnableVirtualBackground(enabled: bool, backgroundSource: FVirtualBackgroundSource, segproperty: FSegmentationProperty, type: EMEDIA_SOURCE_TYPE): int
EnableVoiceAITuner(enabled: bool, type: EVOICE_AI_TUNER_TYPE): int
EnableWebSdkInteroperability(enabled: bool): int
GetAgoraMediaPlayer(): UAgoraBPuMediaPlayer*
GetAgoraRtcEngine(): UAgoraBPuRtcEngine*
GetAudioDeviceInfo(deviceInfo: FDeviceInfo&): int
GetAudioMixingCurrentPosition(): int
GetAudioMixingDuration(): int
GetAudioMixingPlayoutVolume(): int
GetAudioMixingPublishVolume(): int
GetAudioTrackCount(): int
GetCallId(callId: FString&): int
GetCameraMaxZoomFactor(): float
GetConnectionState(): ECONNECTION_STATE_TYPE
GetEffectCurrentPosition(soundId: int): int
GetEffectDuration(filePath: const FString&): int
GetEffectsVolume(): int
GetErrorDescription(code: int): FString
GetExtensionProperty(provider: const FString&, extension: const FString&, ExtensionInfo: const FExtensionInfo&, key: const FString&, value: FString&): int
GetFaceShapeAreaOptions(shapeArea: EUABT_FACE_SHAPE_AREA, options: FUABT_FaceShapeAreaOptions&, type?: EUABT_MEDIA_SOURCE_TYPE): int
GetFaceShapeBeautyOptions(options: FUABT_FaceShapeBeautyOptions&, type?: EUABT_MEDIA_SOURCE_TYPE): int
GetNetworkType(): int
GetNtpWallTimeInMs(): FString
GetScreenCaptureSources(thumbSize: const FSIZE&, iconSize: const FSIZE&, includeScreen: bool): UIScreenCaptureSourceList*
GetUserInfoByUid(uid: int64, userInfo: FUserInfo&): int
GetUserInfoByUserAccount(userAccount: const FString&, userInfo: FUserInfo&): int
GetVersion(): FString
GetVolumeOfEffect(soundId: int): int
Initialize(context: const FRtcEngineContext&): int
IsCameraAutoExposureFaceModeSupported(): bool
IsCameraAutoFocusFaceModeSupported(): bool
IsCameraCenterStageSupported(): bool
IsCameraExposurePositionSupported(): bool
IsCameraExposureSupported(): bool
IsCameraFaceDetectSupported(): bool
IsCameraFocusSupported(): bool
IsCameraTorchSupported(): bool
IsCameraZoomSupported(): bool
IsFeatureAvailableOnDevice(type: EFeatureType): bool
IsSpeakerphoneEnabled(): bool
JoinChannelWithOptions(token: const FString&, channelId: const FString&, uid: int64, options: const FChannelMediaOptions&): int
JoinChannelWithUserAccount(token: const FString&, channelId: const FString&, userAccount: const FString&, options: const FChannelMediaOptions&): int
LeaveChannelWithOptions(options: const FLeaveChannelOptions&): int
LoadExtensionProvider(path: const FString&, unload_after_use: bool): int
MuteAllRemoteAudioStreams(mute: bool): int
MuteAllRemoteVideoStreams(mute: bool): int
MuteLocalAudioStream(mute: bool): int
MuteLocalVideoStream(mute: bool): int
MuteRecordingSignal(mute: bool): int
MuteRemoteAudioStream(uid: int64, mute: bool): int
MuteRemoteVideoStream(uid: int64, mute: bool): int
PauseAllChannelMediaRelay(): int
PauseAllEffects(): int
PauseAudioMixing(): int
PauseEffect(soundId: int): int
PlayAllEffects(loopCount: int, pitch: float, pan: float, gain: int, publish: bool): int
PlayEffect(soundId: int, filePath: const FString&, loopCount: int, pitch: float, pan: float, gain: int, publish: bool, startPos: int): int
PreloadChannel(token: const FString&, channelId: const FString&, uid: int64): int
PreloadChannelWithUserAccount(token: const FString&, channelId: const FString&, userAccount: const FString&): int
PreloadEffect(soundId: int, filePath: const FString&, startPos: int): int
QueryCameraFocalLengthCapability(focalLengthInfos: const TArray&): int
QueryCodecCapability(codecInfo: TArray&, QuerySize?: int): int
QueryDeviceScore(): int
QueryScreenCaptureCapability(): int
Rate(callId: const FString&, rating: int, description: const FString&): int
RegisterExtension(provider: const FString&, extension: const FString&, type: EMEDIA_SOURCE_TYPE): int
RegisterLocalUserAccount(appId: const FString&, userAccount: const FString&): int
Release(sync?: bool): void
RenewToken(token: const FString&): int
ResumeAllChannelMediaRelay(): int
ResumeAllEffects(): int
ResumeAudioMixing(): int
ResumeEffect(soundId: int): int
SelectAudioTrack(index: int): int
SendCustomReportMessage(id: const FString&, category: const FString&, event: const FString&, label: const FString&, value: int): int
SendStreamMessage(streamId: int, data: const FString&): int
SetAINSMode(enabled: bool, mode: EAUDIO_AINS_MODE): int
SetAVSyncSource(channelId: const FString&, uid: int64): int
SetAdvancedAudioOptions(options: const FAdvancedAudioOptions&): int
SetAudioEffectParameters(preset: FENUMWRAP_AUDIO_EFFECT_PRESET, param1: int, param2: int): int
SetAudioEffectPreset(preset: FENUMWRAP_AUDIO_EFFECT_PRESET): int
SetAudioMixingDualMonoMode(mode: EAUDIO_MIXING_DUAL_MONO_MODE): int
SetAudioMixingPitch(pitch: int): int
SetAudioMixingPlaybackSpeed(speed: int): int
SetAudioMixingPosition(pos: int): int
SetAudioProfileAndScenario(profile?: EAUDIO_PROFILE_TYPE, scenario?: EAUDIO_SCENARIO_TYPE): int
SetAudioScenario(scenario?: EAUDIO_SCENARIO_TYPE): int
SetAudioSessionOperationRestriction(restriction: EAUDIO_SESSION_OPERATION_RESTRICTION): int
SetBeautyEffectOptions(enabled: bool, options: const FBeautyOptions&, type: EMEDIA_SOURCE_TYPE): int
SetCameraAutoExposureFaceModeEnabled(enabled: bool): int
SetCameraAutoFocusFaceModeEnabled(enabled: bool): int
SetCameraCapturerConfiguration(config: const FCameraCapturerConfiguration&): int
SetCameraDeviceOrientation(type: EVIDEO_SOURCE_TYPE, orientation: FENUMWRAP_VIDEO_ORIENTATION): int
SetCameraExposureFactor(factor: float): int
SetCameraExposurePosition(positionXinView: float, positionYinView: float): int
SetCameraFocusPositionInPreview(positionX: float, positionY: float): int
SetCameraStabilizationMode(mode: FENUMWRAP_CAMERA_STABILIZATION_MODE): int
SetCameraTorchOn(isOn: bool): int
SetCameraZoomFactor(factor: float): int
SetChannelProfile(profile: ECHANNEL_PROFILE_TYPE): int
SetClientRole(options: FClientRoleOptions, clientroletype?: ECLIENT_ROLE_TYPE): int
SetCloudProxy(proxyType: ECLOUD_PROXY_TYPE): int
SetColorEnhanceOptions(enabled: bool, options: const FColorEnhanceOptions&, type: EMEDIA_SOURCE_TYPE): int
SetDefaultAudioRouteToSpeakerphone(defaultToSpeaker: bool): int
SetDualStreamMode(mode: FENUMWRAP_SIMULCAST_STREAM_MODE, streamConfig: const FSimulcastStreamConfig&): int
SetEffectPosition(soundId: int, pos: int): int
SetEffectsVolume(volume: int): int
SetEnableSpeakerphone(speakerOn: bool): int
SetExtensionProperty(provider: const FString&, extension: const FString&, key: const FString&, value: const FString&, type?: EMEDIA_SOURCE_TYPE): int
SetExtensionProviderProperty(provider: const FString&, key: const FString&, value: const FString&): int
SetFaceShapeAreaOptions(options: const FUABT_FaceShapeAreaOptions&, type?: EUABT_MEDIA_SOURCE_TYPE): int
SetFaceShapeBeautyOptions(enabled: bool, options: const FUABT_FaceShapeBeautyOptions&, type?: EUABT_MEDIA_SOURCE_TYPE): int
SetFilterEffectOptions(enabled: bool, options: const FUABT_FilterEffectOptions&, type?: EUABT_MEDIA_SOURCE_TYPE): int
SetHeadphoneEQParameters(lowGain: int, highGain: int): int
SetHeadphoneEQPreset(preset: FENUMWRAP_HEADPHONE_EQUALIZER_PRESET): int
SetInEarMonitoringVolume(volume: int): int
SetLocalRenderMode(renderMode: ERENDER_MODE_TYPE, mirrorMode?: EVIDEO_MIRROR_MODE_TYPE): int
SetLocalRenderTargetFps(sourceType: EUABT_VIDEO_SOURCE_TYPE, targetFps: int): int
SetLocalVideoMirrorMode(mirrorMode: EVIDEO_MIRROR_MODE_TYPE): int
SetLocalVoiceEqualization(bandFrequency: EAUDIO_EQUALIZATION_BAND_FREQUENCY, bandGain: int): int
SetLocalVoiceFormant(formantRatio?: const FString&): int
SetLocalVoicePitch(pitch: float): int
SetLocalVoiceReverb(reverbKey: EAUDIO_REVERB_TYPE, value: int): int
SetLogFile(filePath: const FString&): int
SetLogFileSize(fileSizeInKBytes: int): int
SetLogFilter(filter: int): int
SetLogLevel(level: ELOG_LEVEL): int
SetLowlightEnhanceOptions(enabled: bool, options: const FUABT_LowlightEnhanceOptions&, type: EUABT_MEDIA_SOURCE_TYPE): int
SetParameters(parameters: const FString&): int
SetRemoteDefaultVideoStreamType(streamType: EVIDEO_STREAM_TYPE): int
SetRemoteRenderMode(uid: int64, renderMode: ERENDER_MODE_TYPE, mirrorMode: EVIDEO_MIRROR_MODE_TYPE): int
SetRemoteRenderTargetFps(targetFps: int): int
SetRemoteSubscribeFallbackOption(option: ESTREAM_FALLBACK_OPTIONS): int
SetRemoteVideoStreamType(uid: int64, streamType: EVIDEO_STREAM_TYPE): int
SetRemoteVoicePosition(uid: int64, pan: float, gain: float): int
SetScreenCaptureContentHint(contentHint: EVIDEO_CONTENT_HINT): int
SetScreenCaptureScenario(screenScenario: ESCREEN_SCENARIO_TYPE): int
SetSubscribeAudioAllowlist(uidList: TArray, uidNumber: int): int
SetSubscribeAudioBlocklist(uidList: TArray, uidNumber: int): int
SetSubscribeVideoAllowlist(uidList: TArray, uidNumber: int): int
SetSubscribeVideoBlocklist(uidList: TArray, uidNumber: int): int
SetVideoDenoiserOptions(enabled: bool, options: const FUABT_VideoDenoiserOptions&, type: EUABT_MEDIA_SOURCE_TYPE): int
SetVideoEncoderConfiguration(config: const FVideoEncoderConfiguration&): int
SetVideoScenario(scenarioType: EVIDEO_APPLICATION_SCENARIO_TYPE): int
SetVoiceBeautifierParameters(preset: FENUMWRAP_VOICE_BEAUTIFIER_PRESET, param1: int, param2: int): int
SetVoiceBeautifierPreset(preset: FENUMWRAP_VOICE_BEAUTIFIER_PRESET): int
SetVoiceConversionPreset(preset: FENUMWRAP_VOICE_CONVERSION_PRESET): int
SetVolumeOfEffect(soundId: int, volume: int): int
SetupLocalVideo(canvas: const FVideoCanvas&): int
SetupRemoteVideo(canvas: const FVideoCanvas&): int
StartAudioMixing(filePath: const FString&, loopback: bool, cycle: int, startPos?: int): int
StartAudioRecording(config: const FAudioRecordingConfiguration&): int
StartCameraCapture(sourceType: EVIDEO_SOURCE_TYPE, config: const FCameraCapturerConfiguration&): int
StartEchoTest(config: const FEchoTestConfiguration&): int
StartLastmileProbeTest(config: const FLastmileProbeConfig&): int
StartLocalVideoTranscoder(config: const FLocalTranscoderConfiguration&): int
StartMediaRenderingTracing(): int
StartOrUpdateChannelMediaRelay(configuration: const FChannelMediaRelayConfiguration&): int
StartPreview(sourceType?: EVIDEO_SOURCE_TYPE): int
StartRhythmPlayer(sound1: const FString&, sound2: const FString&, config: const FAgoraRhythmPlayerConfig&): int
StartRtmpStreamWithTranscoding(url: const FString&, transcoding: const FLiveTranscoding&): int
StartRtmpStreamWithoutTranscoding(url: const FString&): int
StartScreenCapture(captureParams: const FScreenCaptureParameters2&): int
StartScreenCaptureByDisplayId(displayId: int64, regionRect: const FRectangle&, captureParams: const FScreenCaptureParameters&): int
StartScreenCaptureByScreenRect(screenRect: const FRectangle&, regionRect: const FRectangle&, captureParams: const FScreenCaptureParameters&): int
StartScreenCaptureBySourceType(sourceType: EVIDEO_SOURCE_TYPE, config: const FScreenCaptureConfiguration&): int
StartScreenCaptureByWindowId(windowId: int64, regionRect: const FRectangle&, captureParams: const FScreenCaptureParameters&): int
StopAllEffects(): int
StopAudioMixing(): int
StopAudioRecording(): int
StopCameraCapture(sourceType: EVIDEO_SOURCE_TYPE): int
StopChannelMediaRelay(): int
StopEchoTest(): int
StopEffect(soundId: int): int
StopLastmileProbeTest(): int
StopLocalVideoTranscoder(): int
StopPreview(sourceType?: EVIDEO_SOURCE_TYPE): int
StopRhythmPlayer(): int
StopRtmpStream(url: const FString&): int
StopScreenCapture(): int
StopScreenCaptureBySourceType(sourceType: EVIDEO_SOURCE_TYPE): int
SwitchCamera(): int
TakeSnapshot(uid: int64, filePath: const FString&): int
TakeSnapshotWithConfig(uid: int64, config: const FUABT_SnapshotConfig&): int
UnloadAllEffects(): int
UnloadEffect(soundId: int): int
UpdateChannelMediaOptions(options: const FChannelMediaOptions&): int
UpdateLocalTranscoderConfiguration(config: const FLocalTranscoderConfiguration&): int
UpdatePreloadChannelToken(token: const FString&): int
UpdateRtmpTranscoding(transcoding: const FLiveTranscoding&): int
UpdateScreenCapture(captureParams: const FScreenCaptureParameters2&): int
UpdateScreenCaptureParameters(captureParams: const FScreenCaptureParameters&): int
UpdateScreenCaptureRegion(regionRect: const FRectangle&): int

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

方法参数返回值错误
AddVideoWatermarkwatermarkUrl: const FString&, options: const FWatermarkOptions&int错误码索引
AdjustAudioMixingPlayoutVolumevolume: intint错误码索引
AdjustAudioMixingPublishVolumevolume: intint错误码索引
AdjustAudioMixingVolumevolume: intint错误码索引
AdjustLoopbackSignalVolumevolume: intint错误码索引
AdjustPlaybackSignalVolumevolume: intint错误码索引
AdjustRecordingSignalVolumevolume: intint错误码索引
AdjustUserPlaybackSignalVolumeuid: int64, volume: intint错误码索引
ClearVideoWatermarks—int错误码索引
ComplaincallId: const FString&, description: const FString&int错误码索引
ConfigRhythmPlayerconfig: const FAgoraRhythmPlayerConfig&int错误码索引
CreateDataStreamstreamId: int&, config: const FDataStreamConfig&int错误码索引
DisableAudio—int错误码索引
DisableVideo—int错误码索引
EnableAudio—int错误码索引
EnableAudioVolumeIndicationinterval: int, smooth: int, reportVad: boolint错误码索引
EnableCameraCenterStageenabled: boolint错误码索引
EnableContentInspectenabled: bool, config: const FContentInspectConfig&int错误码索引
EnableDualStreamModeenabled: bool, streamConfig: const FSimulcastStreamConfig&int错误码索引
EnableEncryptionenabled: bool, config: const FEncryptionConfig&int错误码索引
EnableExtensionprovider: const FString&, extension: const FString&, enable?: bool, type?: EMEDIA_SOURCE_TYPEint错误码索引
EnableFaceDetectionenabled: boolint错误码索引
EnableInEarMonitoringenabled: bool, includeAudioFilters: intint错误码索引
EnableInstantMediaRendering—int错误码索引
EnableLocalAudioenabled: boolint错误码索引
EnableLocalVideoenabled: boolint错误码索引
EnableLoopbackRecordingenabled: bool, deviceName: const FString&int错误码索引
EnableMultiCameraenabled: bool, config: const FCameraCapturerConfiguration&int错误码索引
EnableSoundPositionIndicationenabled: boolint错误码索引
EnableVideo—int错误码索引
EnableVideoImageSourceenable: bool, options: const FImageTrackOptions&int错误码索引
EnableVirtualBackgroundenabled: bool, backgroundSource: FVirtualBackgroundSource, segproperty: FSegmentationProperty, type: EMEDIA_SOURCE_TYPEint错误码索引
EnableVoiceAITunerenabled: bool, type: EVOICE_AI_TUNER_TYPEint错误码索引
EnableWebSdkInteroperabilityenabled: boolint错误码索引
GetAgoraMediaPlayer—UAgoraBPuMediaPlayer*错误码索引
GetAgoraRtcEngine—UAgoraBPuRtcEngine*错误码索引
GetAudioDeviceInfodeviceInfo: FDeviceInfo&int错误码索引
GetAudioMixingCurrentPosition—int错误码索引
GetAudioMixingDuration—int错误码索引
GetAudioMixingPlayoutVolume—int错误码索引
GetAudioMixingPublishVolume—int错误码索引
GetAudioTrackCount—int错误码索引
GetCallIdcallId: FString&int错误码索引
GetCameraMaxZoomFactor—float错误码索引
GetConnectionState—ECONNECTION_STATE_TYPE错误码索引
GetEffectCurrentPositionsoundId: intint错误码索引
GetEffectDurationfilePath: const FString&int错误码索引
GetEffectsVolume—int错误码索引
GetErrorDescriptioncode: intFString错误码索引
GetExtensionPropertyprovider: const FString&, extension: const FString&, ExtensionInfo: const FExtensionInfo&, key: const FString&, value: FString&int错误码索引
GetFaceShapeAreaOptionsshapeArea: EUABT_FACE_SHAPE_AREA, options: FUABT_FaceShapeAreaOptions&, type?: EUABT_MEDIA_SOURCE_TYPEint错误码索引
GetFaceShapeBeautyOptionsoptions: FUABT_FaceShapeBeautyOptions&, type?: EUABT_MEDIA_SOURCE_TYPEint错误码索引
GetNetworkType—int错误码索引
GetNtpWallTimeInMs—FString错误码索引
GetScreenCaptureSourcesthumbSize: const FSIZE&, iconSize: const FSIZE&, includeScreen: boolUIScreenCaptureSourceList*错误码索引
GetUserInfoByUiduid: int64, userInfo: FUserInfo&int错误码索引
GetUserInfoByUserAccountuserAccount: const FString&, userInfo: FUserInfo&int错误码索引
GetVersion—FString错误码索引
GetVolumeOfEffectsoundId: intint错误码索引
Initializecontext: const FRtcEngineContext&int错误码索引
IsCameraAutoExposureFaceModeSupported—bool错误码索引
IsCameraAutoFocusFaceModeSupported—bool错误码索引
IsCameraCenterStageSupported—bool错误码索引
IsCameraExposurePositionSupported—bool错误码索引
IsCameraExposureSupported—bool错误码索引
IsCameraFaceDetectSupported—bool错误码索引
IsCameraFocusSupported—bool错误码索引
IsCameraTorchSupported—bool错误码索引
IsCameraZoomSupported—bool错误码索引
IsFeatureAvailableOnDevicetype: EFeatureTypebool错误码索引
IsSpeakerphoneEnabled—bool错误码索引
JoinChannelWithOptionstoken: const FString&, channelId: const FString&, uid: int64, options: const FChannelMediaOptions&int错误码索引
JoinChannelWithUserAccounttoken: const FString&, channelId: const FString&, userAccount: const FString&, options: const FChannelMediaOptions&int错误码索引
LeaveChannelWithOptionsoptions: const FLeaveChannelOptions&int错误码索引
LoadExtensionProviderpath: const FString&, unload_after_use: boolint错误码索引
MuteAllRemoteAudioStreamsmute: boolint错误码索引
MuteAllRemoteVideoStreamsmute: boolint错误码索引
MuteLocalAudioStreammute: boolint错误码索引
MuteLocalVideoStreammute: boolint错误码索引
MuteRecordingSignalmute: boolint错误码索引
MuteRemoteAudioStreamuid: int64, mute: boolint错误码索引
MuteRemoteVideoStreamuid: int64, mute: boolint错误码索引
PauseAllChannelMediaRelay—int错误码索引
PauseAllEffects—int错误码索引
PauseAudioMixing—int错误码索引
PauseEffectsoundId: intint错误码索引
PlayAllEffectsloopCount: int, pitch: float, pan: float, gain: int, publish: boolint错误码索引
PlayEffectsoundId: int, filePath: const FString&, loopCount: int, pitch: float, pan: float, gain: int, publish: bool, startPos: intint错误码索引
PreloadChanneltoken: const FString&, channelId: const FString&, uid: int64int错误码索引
PreloadChannelWithUserAccounttoken: const FString&, channelId: const FString&, userAccount: const FString&int错误码索引
PreloadEffectsoundId: int, filePath: const FString&, startPos: intint错误码索引
QueryCameraFocalLengthCapabilityfocalLengthInfos: const TArray&int错误码索引
QueryCodecCapabilitycodecInfo: TArray&, QuerySize?: intint错误码索引
QueryDeviceScore—int错误码索引
QueryScreenCaptureCapability—int错误码索引
RatecallId: const FString&, rating: int, description: const FString&int错误码索引
RegisterExtensionprovider: const FString&, extension: const FString&, type: EMEDIA_SOURCE_TYPEint错误码索引
RegisterLocalUserAccountappId: const FString&, userAccount: const FString&int错误码索引
Releasesync?: boolvoid错误码索引
RenewTokentoken: const FString&int错误码索引
ResumeAllChannelMediaRelay—int错误码索引
ResumeAllEffects—int错误码索引
ResumeAudioMixing—int错误码索引
ResumeEffectsoundId: intint错误码索引
SelectAudioTrackindex: intint错误码索引
SendCustomReportMessageid: const FString&, category: const FString&, event: const FString&, label: const FString&, value: intint错误码索引
SendStreamMessagestreamId: int, data: const FString&int错误码索引
SetAINSModeenabled: bool, mode: EAUDIO_AINS_MODEint错误码索引
SetAVSyncSourcechannelId: const FString&, uid: int64int错误码索引
SetAdvancedAudioOptionsoptions: const FAdvancedAudioOptions&int错误码索引
SetAudioEffectParameterspreset: FENUMWRAP_AUDIO_EFFECT_PRESET, param1: int, param2: intint错误码索引
SetAudioEffectPresetpreset: FENUMWRAP_AUDIO_EFFECT_PRESETint错误码索引
SetAudioMixingDualMonoModemode: EAUDIO_MIXING_DUAL_MONO_MODEint错误码索引
SetAudioMixingPitchpitch: intint错误码索引
SetAudioMixingPlaybackSpeedspeed: intint错误码索引
SetAudioMixingPositionpos: intint错误码索引
SetAudioProfileAndScenarioprofile?: EAUDIO_PROFILE_TYPE, scenario?: EAUDIO_SCENARIO_TYPEint错误码索引
SetAudioScenarioscenario?: EAUDIO_SCENARIO_TYPEint错误码索引
SetAudioSessionOperationRestrictionrestriction: EAUDIO_SESSION_OPERATION_RESTRICTIONint错误码索引
SetBeautyEffectOptionsenabled: bool, options: const FBeautyOptions&, type: EMEDIA_SOURCE_TYPEint错误码索引
SetCameraAutoExposureFaceModeEnabledenabled: boolint错误码索引
SetCameraAutoFocusFaceModeEnabledenabled: boolint错误码索引
SetCameraCapturerConfigurationconfig: const FCameraCapturerConfiguration&int错误码索引
SetCameraDeviceOrientationtype: EVIDEO_SOURCE_TYPE, orientation: FENUMWRAP_VIDEO_ORIENTATIONint错误码索引
SetCameraExposureFactorfactor: floatint错误码索引
SetCameraExposurePositionpositionXinView: float, positionYinView: floatint错误码索引
SetCameraFocusPositionInPreviewpositionX: float, positionY: floatint错误码索引
SetCameraStabilizationModemode: FENUMWRAP_CAMERA_STABILIZATION_MODEint错误码索引
SetCameraTorchOnisOn: boolint错误码索引
SetCameraZoomFactorfactor: floatint错误码索引
SetChannelProfileprofile: ECHANNEL_PROFILE_TYPEint错误码索引
SetClientRoleoptions: FClientRoleOptions, clientroletype?: ECLIENT_ROLE_TYPEint错误码索引
SetCloudProxyproxyType: ECLOUD_PROXY_TYPEint错误码索引
SetColorEnhanceOptionsenabled: bool, options: const FColorEnhanceOptions&, type: EMEDIA_SOURCE_TYPEint错误码索引
SetDefaultAudioRouteToSpeakerphonedefaultToSpeaker: boolint错误码索引
SetDualStreamModemode: FENUMWRAP_SIMULCAST_STREAM_MODE, streamConfig: const FSimulcastStreamConfig&int错误码索引
SetEffectPositionsoundId: int, pos: intint错误码索引
SetEffectsVolumevolume: intint错误码索引
SetEnableSpeakerphonespeakerOn: boolint错误码索引
SetExtensionPropertyprovider: const FString&, extension: const FString&, key: const FString&, value: const FString&, type?: EMEDIA_SOURCE_TYPEint错误码索引
SetExtensionProviderPropertyprovider: const FString&, key: const FString&, value: const FString&int错误码索引
SetFaceShapeAreaOptionsoptions: const FUABT_FaceShapeAreaOptions&, type?: EUABT_MEDIA_SOURCE_TYPEint错误码索引
SetFaceShapeBeautyOptionsenabled: bool, options: const FUABT_FaceShapeBeautyOptions&, type?: EUABT_MEDIA_SOURCE_TYPEint错误码索引
SetFilterEffectOptionsenabled: bool, options: const FUABT_FilterEffectOptions&, type?: EUABT_MEDIA_SOURCE_TYPEint错误码索引
SetHeadphoneEQParameterslowGain: int, highGain: intint错误码索引
SetHeadphoneEQPresetpreset: FENUMWRAP_HEADPHONE_EQUALIZER_PRESETint错误码索引
SetInEarMonitoringVolumevolume: intint错误码索引
SetLocalRenderModerenderMode: ERENDER_MODE_TYPE, mirrorMode?: EVIDEO_MIRROR_MODE_TYPEint错误码索引
SetLocalRenderTargetFpssourceType: EUABT_VIDEO_SOURCE_TYPE, targetFps: intint错误码索引
SetLocalVideoMirrorModemirrorMode: EVIDEO_MIRROR_MODE_TYPEint错误码索引
SetLocalVoiceEqualizationbandFrequency: EAUDIO_EQUALIZATION_BAND_FREQUENCY, bandGain: intint错误码索引
SetLocalVoiceFormantformantRatio?: const FString&int错误码索引
SetLocalVoicePitchpitch: floatint错误码索引
SetLocalVoiceReverbreverbKey: EAUDIO_REVERB_TYPE, value: intint错误码索引
SetLogFilefilePath: const FString&int错误码索引
SetLogFileSizefileSizeInKBytes: intint错误码索引
SetLogFilterfilter: intint错误码索引
SetLogLevellevel: ELOG_LEVELint错误码索引
SetLowlightEnhanceOptionsenabled: bool, options: const FUABT_LowlightEnhanceOptions&, type: EUABT_MEDIA_SOURCE_TYPEint错误码索引
SetParametersparameters: const FString&int错误码索引
SetRemoteDefaultVideoStreamTypestreamType: EVIDEO_STREAM_TYPEint错误码索引
SetRemoteRenderModeuid: int64, renderMode: ERENDER_MODE_TYPE, mirrorMode: EVIDEO_MIRROR_MODE_TYPEint错误码索引
SetRemoteRenderTargetFpstargetFps: intint错误码索引
SetRemoteSubscribeFallbackOptionoption: ESTREAM_FALLBACK_OPTIONSint错误码索引
SetRemoteVideoStreamTypeuid: int64, streamType: EVIDEO_STREAM_TYPEint错误码索引
SetRemoteVoicePositionuid: int64, pan: float, gain: floatint错误码索引
SetScreenCaptureContentHintcontentHint: EVIDEO_CONTENT_HINTint错误码索引
SetScreenCaptureScenarioscreenScenario: ESCREEN_SCENARIO_TYPEint错误码索引
SetSubscribeAudioAllowlistuidList: TArray, uidNumber: intint错误码索引
SetSubscribeAudioBlocklistuidList: TArray, uidNumber: intint错误码索引
SetSubscribeVideoAllowlistuidList: TArray, uidNumber: intint错误码索引
SetSubscribeVideoBlocklistuidList: TArray, uidNumber: intint错误码索引
SetVideoDenoiserOptionsenabled: bool, options: const FUABT_VideoDenoiserOptions&, type: EUABT_MEDIA_SOURCE_TYPEint错误码索引
SetVideoEncoderConfigurationconfig: const FVideoEncoderConfiguration&int错误码索引
SetVideoScenarioscenarioType: EVIDEO_APPLICATION_SCENARIO_TYPEint错误码索引
SetVoiceBeautifierParameterspreset: FENUMWRAP_VOICE_BEAUTIFIER_PRESET, param1: int, param2: intint错误码索引
SetVoiceBeautifierPresetpreset: FENUMWRAP_VOICE_BEAUTIFIER_PRESETint错误码索引
SetVoiceConversionPresetpreset: FENUMWRAP_VOICE_CONVERSION_PRESETint错误码索引
SetVolumeOfEffectsoundId: int, volume: intint错误码索引
SetupLocalVideocanvas: const FVideoCanvas&int错误码索引
SetupRemoteVideocanvas: const FVideoCanvas&int错误码索引
StartAudioMixingfilePath: const FString&, loopback: bool, cycle: int, startPos?: intint错误码索引
StartAudioRecordingconfig: const FAudioRecordingConfiguration&int错误码索引
StartCameraCapturesourceType: EVIDEO_SOURCE_TYPE, config: const FCameraCapturerConfiguration&int错误码索引
StartEchoTestconfig: const FEchoTestConfiguration&int错误码索引
StartLastmileProbeTestconfig: const FLastmileProbeConfig&int错误码索引
StartLocalVideoTranscoderconfig: const FLocalTranscoderConfiguration&int错误码索引
StartMediaRenderingTracing—int错误码索引
StartOrUpdateChannelMediaRelayconfiguration: const FChannelMediaRelayConfiguration&int错误码索引
StartPreviewsourceType?: EVIDEO_SOURCE_TYPEint错误码索引
StartRhythmPlayersound1: const FString&, sound2: const FString&, config: const FAgoraRhythmPlayerConfig&int错误码索引
StartRtmpStreamWithTranscodingurl: const FString&, transcoding: const FLiveTranscoding&int错误码索引
StartRtmpStreamWithoutTranscodingurl: const FString&int错误码索引
StartScreenCapturecaptureParams: const FScreenCaptureParameters2&int错误码索引
StartScreenCaptureByDisplayIddisplayId: int64, regionRect: const FRectangle&, captureParams: const FScreenCaptureParameters&int错误码索引
StartScreenCaptureByScreenRectscreenRect: const FRectangle&, regionRect: const FRectangle&, captureParams: const FScreenCaptureParameters&int错误码索引
StartScreenCaptureBySourceTypesourceType: EVIDEO_SOURCE_TYPE, config: const FScreenCaptureConfiguration&int错误码索引
StartScreenCaptureByWindowIdwindowId: int64, regionRect: const FRectangle&, captureParams: const FScreenCaptureParameters&int错误码索引
StopAllEffects—int错误码索引
StopAudioMixing—int错误码索引
StopAudioRecording—int错误码索引
StopCameraCapturesourceType: EVIDEO_SOURCE_TYPEint错误码索引
StopChannelMediaRelay—int错误码索引
StopEchoTest—int错误码索引
StopEffectsoundId: intint错误码索引
StopLastmileProbeTest—int错误码索引
StopLocalVideoTranscoder—int错误码索引
StopPreviewsourceType?: EVIDEO_SOURCE_TYPEint错误码索引
StopRhythmPlayer—int错误码索引
StopRtmpStreamurl: const FString&int错误码索引
StopScreenCapture—int错误码索引
StopScreenCaptureBySourceTypesourceType: EVIDEO_SOURCE_TYPEint错误码索引
SwitchCamera—int错误码索引
TakeSnapshotuid: int64, filePath: const FString&int错误码索引
TakeSnapshotWithConfiguid: int64, config: const FUABT_SnapshotConfig&int错误码索引
UnloadAllEffects—int错误码索引
UnloadEffectsoundId: intint错误码索引
UpdateChannelMediaOptionsoptions: const FChannelMediaOptions&int错误码索引
UpdateLocalTranscoderConfigurationconfig: const FLocalTranscoderConfiguration&int错误码索引
UpdatePreloadChannelTokentoken: const FString&int错误码索引
UpdateRtmpTranscodingtranscoding: const FLiveTranscoding&int错误码索引
UpdateScreenCapturecaptureParams: const FScreenCaptureParameters2&int错误码索引
UpdateScreenCaptureParameterscaptureParams: const FScreenCaptureParameters&int错误码索引
UpdateScreenCaptureRegionregionRect: const FRectangle&int错误码索引
IRtcEngineEventHandler 83 方法 / 0 属性
typescript
OnActiveSpeaker(uid: int64): void
OnAudioDeviceStateChanged(deviceId: const FString&, deviceType: int, deviceState: int): void
OnAudioDeviceVolumeChanged(deviceType: FENUMWRAP_MEDIA_DEVICE_TYPE, volume: int, muted: bool): void
OnAudioEffectFinished(soundId: int): void
OnAudioMixingFinished(): void
OnAudioMixingPositionChanged(position: int64): void
OnAudioMixingStateChanged(state: FENUMWRAP_AUDIO_MIXING_STATE_TYPE, reason: FENUMWRAP_AUDIO_MIXING_REASON_TYPE): void
OnAudioPublishStateChanged(channel: const FString&, oldState: ESTREAM_PUBLISH_STATE, newState: ESTREAM_PUBLISH_STATE, elapseSinceLastState: int): void
OnAudioQuality(uid: int64, quality: int, delay: int, lost: int): void
OnAudioRoutingChanged(routing: int): void
OnAudioSubscribeStateChanged(channel: const FString&, uid: int64, oldState: ESTREAM_SUBSCRIBE_STATE, newState: ESTREAM_SUBSCRIBE_STATE, elapseSinceLastState: int): void
OnAudioVolumeIndication(speakers: const TArray&, 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: int, code: int): void
OnClientRoleChangeFailed(reason: ECLIENT_ROLE_CHANGE_FAILED_REASON, currentRole: ECLIENT_ROLE_TYPE): void
OnClientRoleChanged(oldRole: ECLIENT_ROLE_TYPE, newRole: ECLIENT_ROLE_TYPE, newRoleOptions: const FClientRoleOptions&): void
OnConnectionBanned(): void
OnConnectionInterrupted(): void
OnConnectionLost(): void
OnConnectionStateChanged(state: ECONNECTION_STATE_TYPE, reason: ECONNECTION_CHANGED_REASON_TYPE): void
OnEncryptionError(errorType: EENCRYPTION_ERROR_TYPE): void
OnError(error: int, msg: const FString&): void
OnExtensionErrorWithContext(context: const FExtensionContext&, error: int, message: const FString&): void
OnExtensionEventWithContext(context: const FExtensionContext&, key: const FString&, value: const FString&): void
OnExtensionStartedWithContext(context: const FExtensionContext&): void
OnExtensionStoppedWithContext(context: const FExtensionContext&): void
OnFacePositionChanged(imageWidth: int, imageHeight: int, vecRectangle: const TArray&, vecDistance: const TArray&, numFaces: int): void
OnFirstLocalAudioFramePublished(elapsed: int): void
OnFirstLocalVideoFrame(source: EVIDEO_SOURCE_TYPE, width: int, height: int, elapsed: int): void
OnFirstLocalVideoFramePublished(source: EVIDEO_SOURCE_TYPE, elapsed: int): void
OnFirstRemoteAudioDecoded(uid: int64, elapsed: int): void
OnFirstRemoteAudioFrame(uid: int64, elapsed: int): void
OnFirstRemoteVideoDecoded(uid: int64, width: int, height: int, elapsed: int): void
OnFirstRemoteVideoFrame(uid: int64, width: int, height: int, elapsed: int): void
OnJoinChannelSuccess(Channel: const FString&, Uid: int64, Elapsed: int): void
OnLastmileProbeResult(result: const FLastmileProbeResult&): void
OnLastmileQuality(quality: int): void
OnLeaveChannel(stats: const FRtcStats&): void
OnLocalAudioStateChanged(state: ELOCAL_AUDIO_STREAM_STATE, reason: ELOCAL_AUDIO_STREAM_REASON): void
OnLocalAudioStats(stats: const FLocalAudioStats&): void
OnLocalUserRegistered(uid: int64, userAccount: const FString&): void
OnLocalVideoStateChanged(source: EVIDEO_SOURCE_TYPE, state: ELOCAL_VIDEO_STREAM_STATE, reason: ELOCAL_VIDEO_STREAM_REASON): void
OnLocalVideoStats(source: EVIDEO_SOURCE_TYPE, stats: const FLocalVideoStats&): void
OnLocalVideoTranscoderError(stream: const FTranscodingVideoStream&, error: EVIDEO_TRANSCODER_ERROR): void
OnNetworkQuality(uid: int64, txQuality: int, rxQuality: int): void
OnNetworkTypeChanged(type: FENUMWRAP_NETWORK_TYPE): void
OnPermissionError(permissionType: EPERMISSION_TYPE): void
OnProxyConnected(channel: const FString&, uid: int64, proxyType: EPROXY_TYPE, localProxyIp: const FString&, elapsed: int): void
OnRejoinChannelSuccess(channel: const FString&, uid: int64, elapsed: int): void
OnRemoteAudioStateChanged(uid: int64, state: EREMOTE_AUDIO_STATE, reason: EREMOTE_AUDIO_STATE_REASON, elapsed: int): void
OnRemoteAudioStats(stats: const FRemoteAudioStats&): void
OnRemoteAudioTransportStats(uid: int64, delay: int, lost: int, rxKBitRate: int): void
OnRemoteSubscribeFallbackToAudioOnly(uid: int64, isFallbackOrRecover: bool): void
OnRemoteVideoStateChanged(uid: int64, state: EREMOTE_VIDEO_STATE, reason: EREMOTE_VIDEO_STATE_REASON, elapsed: int): void
OnRemoteVideoStats(stats: const FRemoteVideoStats&): void
OnRemoteVideoTransportStats(uid: int64, delay: int, lost: int, rxKBitRate: int): void
OnRequestToken(): void
OnRhythmPlayerStateChanged(state: FENUMWRAP_RHYTHM_PLAYER_STATE_TYPE, reason: FENUMWRAP_RHYTHM_PLAYER_REASON): void
OnRtcStats(stats: const FRtcStats&): void
OnRtmpStreamingEvent(url: const FString&, eventCode: ERTMP_STREAMING_EVENT): void
OnRtmpStreamingStateChanged(url: const FString&, state: ERTMP_STREAM_PUBLISH_STATE, reason: ERTMP_STREAM_PUBLISH_REASON): void
OnSnapshotTaken(uid: int64, filePath: const FString&, width: int, height: int, errCode: int): void
OnStreamMessage(uid: int64, streamId: int, data: const FString&, length: int, sentTs: int64): void
OnStreamMessageError(uid: int64, streamId: int, code: int, missed: int, cached: int): void
OnTokenPrivilegeWillExpire(token: const FString&): void
OnTranscodedStreamLayoutInfo(uid: int64, width: int, height: int, layoutCount: int, layoutlist: const TArray&): void
OnTranscodingUpdated(): void
OnUplinkNetworkInfoUpdated(info: const FUplinkNetworkInfo&): void
OnUserEnableLocalVideo(uid: int64, enabled: bool): void
OnUserEnableVideo(uid: int64, enabled: bool): void
OnUserInfoUpdated(uid: int64, info: const FUserInfo&): void
OnUserJoined(uid: int64, elapsed: int): void
OnUserMuteAudio(uid: int64, muted: bool): void
OnUserMuteVideo(uid: int64, muted: bool): void
OnUserOffline(uid: int64, reason: EUSER_OFFLINE_REASON_TYPE): void
OnVideoDeviceStateChanged(deviceId: const FString&, deviceType: int, deviceState: int): void
OnVideoPublishStateChanged(source: EVIDEO_SOURCE_TYPE, channel: const FString&, oldState: ESTREAM_PUBLISH_STATE, newState: ESTREAM_PUBLISH_STATE, elapseSinceLastState: int): void
OnVideoRenderingTracingResult(uid: int64, currentEvent: EMEDIA_TRACE_EVENT, tracingInfo: const FVideoRenderingTracingInfo&): void
OnVideoSizeChanged(sourceType: EVIDEO_SOURCE_TYPE, uid: int64, width: int, height: int, rotation: int): void
OnVideoStopped(): void
OnVideoSubscribeStateChanged(channel: const FString&, uid: int64, oldState: ESTREAM_SUBSCRIBE_STATE, newState: ESTREAM_SUBSCRIBE_STATE, elapseSinceLastState: int): void

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

方法参数返回值错误
OnActiveSpeakeruid: int64void错误码索引
OnAudioDeviceStateChangeddeviceId: const FString&, deviceType: int, deviceState: intvoid错误码索引
OnAudioDeviceVolumeChangeddeviceType: FENUMWRAP_MEDIA_DEVICE_TYPE, volume: int, muted: boolvoid错误码索引
OnAudioEffectFinishedsoundId: intvoid错误码索引
OnAudioMixingFinished—void错误码索引
OnAudioMixingPositionChangedposition: int64void错误码索引
OnAudioMixingStateChangedstate: FENUMWRAP_AUDIO_MIXING_STATE_TYPE, reason: FENUMWRAP_AUDIO_MIXING_REASON_TYPEvoid错误码索引
OnAudioPublishStateChangedchannel: const FString&, oldState: ESTREAM_PUBLISH_STATE, newState: ESTREAM_PUBLISH_STATE, elapseSinceLastState: intvoid错误码索引
OnAudioQualityuid: int64, quality: int, delay: int, lost: intvoid错误码索引
OnAudioRoutingChangedrouting: intvoid错误码索引
OnAudioSubscribeStateChangedchannel: const FString&, uid: int64, oldState: ESTREAM_SUBSCRIBE_STATE, newState: ESTREAM_SUBSCRIBE_STATE, elapseSinceLastState: intvoid错误码索引
OnAudioVolumeIndicationspeakers: const TArray&, totalVolume: intvoid错误码索引
OnCameraExposureAreaChangedx: int, y: int, width: int, height: intvoid错误码索引
OnCameraFocusAreaChangedx: int, y: int, width: int, height: intvoid错误码索引
OnCameraReady—void错误码索引
OnChannelMediaRelayStateChangedstate: int, code: intvoid错误码索引
OnClientRoleChangeFailedreason: ECLIENT_ROLE_CHANGE_FAILED_REASON, currentRole: ECLIENT_ROLE_TYPEvoid错误码索引
OnClientRoleChangedoldRole: ECLIENT_ROLE_TYPE, newRole: ECLIENT_ROLE_TYPE, newRoleOptions: const FClientRoleOptions&void错误码索引
OnConnectionBanned—void错误码索引
OnConnectionInterrupted—void错误码索引
OnConnectionLost—void错误码索引
OnConnectionStateChangedstate: ECONNECTION_STATE_TYPE, reason: ECONNECTION_CHANGED_REASON_TYPEvoid错误码索引
OnEncryptionErrorerrorType: EENCRYPTION_ERROR_TYPEvoid错误码索引
OnErrorerror: int, msg: const FString&void错误码索引
OnExtensionErrorWithContextcontext: const FExtensionContext&, error: int, message: const FString&void错误码索引
OnExtensionEventWithContextcontext: const FExtensionContext&, key: const FString&, value: const FString&void错误码索引
OnExtensionStartedWithContextcontext: const FExtensionContext&void错误码索引
OnExtensionStoppedWithContextcontext: const FExtensionContext&void错误码索引
OnFacePositionChangedimageWidth: int, imageHeight: int, vecRectangle: const TArray&, vecDistance: const TArray&, numFaces: intvoid错误码索引
OnFirstLocalAudioFramePublishedelapsed: intvoid错误码索引
OnFirstLocalVideoFramesource: EVIDEO_SOURCE_TYPE, width: int, height: int, elapsed: intvoid错误码索引
OnFirstLocalVideoFramePublishedsource: EVIDEO_SOURCE_TYPE, elapsed: intvoid错误码索引
OnFirstRemoteAudioDecodeduid: int64, elapsed: intvoid错误码索引
OnFirstRemoteAudioFrameuid: int64, elapsed: intvoid错误码索引
OnFirstRemoteVideoDecodeduid: int64, width: int, height: int, elapsed: intvoid错误码索引
OnFirstRemoteVideoFrameuid: int64, width: int, height: int, elapsed: intvoid错误码索引
OnJoinChannelSuccessChannel: const FString&, Uid: int64, Elapsed: intvoid错误码索引
OnLastmileProbeResultresult: const FLastmileProbeResult&void错误码索引
OnLastmileQualityquality: intvoid错误码索引
OnLeaveChannelstats: const FRtcStats&void错误码索引
OnLocalAudioStateChangedstate: ELOCAL_AUDIO_STREAM_STATE, reason: ELOCAL_AUDIO_STREAM_REASONvoid错误码索引
OnLocalAudioStatsstats: const FLocalAudioStats&void错误码索引
OnLocalUserRegistereduid: int64, userAccount: const FString&void错误码索引
OnLocalVideoStateChangedsource: EVIDEO_SOURCE_TYPE, state: ELOCAL_VIDEO_STREAM_STATE, reason: ELOCAL_VIDEO_STREAM_REASONvoid错误码索引
OnLocalVideoStatssource: EVIDEO_SOURCE_TYPE, stats: const FLocalVideoStats&void错误码索引
OnLocalVideoTranscoderErrorstream: const FTranscodingVideoStream&, error: EVIDEO_TRANSCODER_ERRORvoid错误码索引
OnNetworkQualityuid: int64, txQuality: int, rxQuality: intvoid错误码索引
OnNetworkTypeChangedtype: FENUMWRAP_NETWORK_TYPEvoid错误码索引
OnPermissionErrorpermissionType: EPERMISSION_TYPEvoid错误码索引
OnProxyConnectedchannel: const FString&, uid: int64, proxyType: EPROXY_TYPE, localProxyIp: const FString&, elapsed: intvoid错误码索引
OnRejoinChannelSuccesschannel: const FString&, uid: int64, elapsed: intvoid错误码索引
OnRemoteAudioStateChangeduid: int64, state: EREMOTE_AUDIO_STATE, reason: EREMOTE_AUDIO_STATE_REASON, elapsed: intvoid错误码索引
OnRemoteAudioStatsstats: const FRemoteAudioStats&void错误码索引
OnRemoteAudioTransportStatsuid: int64, delay: int, lost: int, rxKBitRate: intvoid错误码索引
OnRemoteSubscribeFallbackToAudioOnlyuid: int64, isFallbackOrRecover: boolvoid错误码索引
OnRemoteVideoStateChangeduid: int64, state: EREMOTE_VIDEO_STATE, reason: EREMOTE_VIDEO_STATE_REASON, elapsed: intvoid错误码索引
OnRemoteVideoStatsstats: const FRemoteVideoStats&void错误码索引
OnRemoteVideoTransportStatsuid: int64, delay: int, lost: int, rxKBitRate: intvoid错误码索引
OnRequestToken—void错误码索引
OnRhythmPlayerStateChangedstate: FENUMWRAP_RHYTHM_PLAYER_STATE_TYPE, reason: FENUMWRAP_RHYTHM_PLAYER_REASONvoid错误码索引
OnRtcStatsstats: const FRtcStats&void错误码索引
OnRtmpStreamingEventurl: const FString&, eventCode: ERTMP_STREAMING_EVENTvoid错误码索引
OnRtmpStreamingStateChangedurl: const FString&, state: ERTMP_STREAM_PUBLISH_STATE, reason: ERTMP_STREAM_PUBLISH_REASONvoid错误码索引
OnSnapshotTakenuid: int64, filePath: const FString&, width: int, height: int, errCode: intvoid错误码索引
OnStreamMessageuid: int64, streamId: int, data: const FString&, length: int, sentTs: int64void错误码索引
OnStreamMessageErroruid: int64, streamId: int, code: int, missed: int, cached: intvoid错误码索引
OnTokenPrivilegeWillExpiretoken: const FString&void错误码索引
OnTranscodedStreamLayoutInfouid: int64, width: int, height: int, layoutCount: int, layoutlist: const TArray&void错误码索引
OnTranscodingUpdated—void错误码索引
OnUplinkNetworkInfoUpdatedinfo: const FUplinkNetworkInfo&void错误码索引
OnUserEnableLocalVideouid: int64, enabled: boolvoid错误码索引
OnUserEnableVideouid: int64, enabled: boolvoid错误码索引
OnUserInfoUpdateduid: int64, info: const FUserInfo&void错误码索引
OnUserJoineduid: int64, elapsed: intvoid错误码索引
OnUserMuteAudiouid: int64, muted: boolvoid错误码索引
OnUserMuteVideouid: int64, muted: boolvoid错误码索引
OnUserOfflineuid: int64, reason: EUSER_OFFLINE_REASON_TYPEvoid错误码索引
OnVideoDeviceStateChangeddeviceId: const FString&, deviceType: int, deviceState: intvoid错误码索引
OnVideoPublishStateChangedsource: EVIDEO_SOURCE_TYPE, channel: const FString&, oldState: ESTREAM_PUBLISH_STATE, newState: ESTREAM_PUBLISH_STATE, elapseSinceLastState: intvoid错误码索引
OnVideoRenderingTracingResultuid: int64, currentEvent: EMEDIA_TRACE_EVENT, tracingInfo: const FVideoRenderingTracingInfo&void错误码索引
OnVideoSizeChangedsourceType: EVIDEO_SOURCE_TYPE, uid: int64, width: int, height: int, rotation: intvoid错误码索引
OnVideoStopped—void错误码索引
OnVideoSubscribeStateChangedchannel: const FString&, uid: int64, oldState: ESTREAM_SUBSCRIBE_STATE, newState: ESTREAM_SUBSCRIBE_STATE, elapseSinceLastState: intvoid错误码索引
IRtcEngineEx 44 方法 / 0 属性
typescript
AddVideoWatermarkEx(watermarkUrl: const FString&, options: const FWatermarkOptions&, connection: const FRtcConnection&): int
AdjustUserPlaybackSignalVolumeEx(uid: int64, volume: int, connection: const FRtcConnection&): int
ClearVideoWatermarkEx(connection: const FRtcConnection&): int
CreateDataStreamEx(streamId: int&, config: const FDataStreamConfig&, connection: const FRtcConnection&): int
EnableAudioVolumeIndicationEx(interval: int, smooth: int, reportVad: bool, connection: const FRtcConnection&): int
EnableContentInspectEx(enabled: bool, config: const FContentInspectConfig&, connection: const FRtcConnection&): int
EnableDualStreamModeEx(enabled: bool, streamConfig: const FSimulcastStreamConfig&, connection: const FRtcConnection&): int
EnableEncryptionEx(connection: const FRtcConnection&, enabled: bool, config: const FEncryptionConfig&): int
EnableLoopbackRecordingEx(connection: const FRtcConnection&, enabled: bool, deviceName: const FString&): int
GetCallIdEx(callId: FString&, connection: const FRtcConnection&): int
GetConnectionStateEx(connection: const FRtcConnection&): ECONNECTION_STATE_TYPE
JoinChannelEx(token: const FString&, connection: const FRtcConnection&, options: const FChannelMediaOptions&): int
JoinChannelWithUserAccountEx(token: const FString&, channelId: const FString&, userAccount: const FString&, options: const FChannelMediaOptions&): int
LeaveChannelEx(connection: const FRtcConnection&, options: const FLeaveChannelOptions&): int
MuteAllRemoteAudioStreamsEx(mute: bool, connection: const FRtcConnection&): int
MuteAllRemoteVideoStreamsEx(mute: bool, connection: const FRtcConnection&): int
MuteLocalAudioStreamEx(mute: bool, connection: const FRtcConnection&): int
MuteLocalVideoStreamEx(mute: bool, connection: const FRtcConnection&): int
MuteRemoteAudioStreamEx(uid: int64, mute: bool, connection: const FRtcConnection&): int
MuteRemoteVideoStreamEx(uid: int64, mute: bool, connection: const FRtcConnection&): int
PauseAllChannelMediaRelayEx(connection: const FRtcConnection&): int
ResumeAllChannelMediaRelayEx(connection: const FRtcConnection&): int
SendCustomReportMessageEx(id: const FString&, category: const FString&, event: const FString&, label: const FString&, value: int, connection: const FRtcConnection&): int
SendStreamMessageEx(streamId: int, data: const FString&, connection: const FRtcConnection&): int
SetDualStreamModeEx(mode: FENUMWRAP_SIMULCAST_STREAM_MODE, streamConfig: const FSimulcastStreamConfig&, connection: const FRtcConnection&): int
SetRemoteRenderModeEx(uid: int64, renderMode: ERENDER_MODE_TYPE, mirrorMode: EVIDEO_MIRROR_MODE_TYPE, connection: const FRtcConnection&): int
SetRemoteVideoStreamTypeEx(uid: int64, streamType: EVIDEO_STREAM_TYPE, connection: const FRtcConnection&): int
SetRemoteVoicePositionEx(uid: int64, pan: float, gain: float, connection: const FRtcConnection&): int
SetSubscribeAudioAllowlistEx(uidList: TArray, uidNumber: int, connection: const FRtcConnection&): int
SetSubscribeAudioBlocklistEx(uidList: TArray, uidNumber: int, connection: const FRtcConnection&): int
SetSubscribeVideoAllowlistEx(uidList: TArray, uidNumber: int, connection: const FRtcConnection&): int
SetSubscribeVideoBlocklistEx(uidList: TArray, uidNumber: int, connection: const FRtcConnection&): int
SetVideoEncoderConfigurationEx(config: const FVideoEncoderConfiguration&, connection: const FRtcConnection&): int
SetupRemoteVideoEx(canvas: const FVideoCanvas&, connection: const FRtcConnection&): int
StartMediaRenderingTracingEx(connection: const FRtcConnection&): int
StartOrUpdateChannelMediaRelayEx(configuration: const FChannelMediaRelayConfiguration&, connection: const FRtcConnection&): int
StartRtmpStreamWithTranscodingEx(url: const FString&, transcoding: const FLiveTranscoding&, connection: const FRtcConnection&): int
StartRtmpStreamWithoutTranscodingEx(url: const FString&, connection: const FRtcConnection&): int
StopChannelMediaRelayEx(connection: const FRtcConnection&): int
StopRtmpStreamEx(url: const FString&, connection: const FRtcConnection&): int
TakeSnapshotEx(connection: const FRtcConnection&, uid: int64, filePath: const FString&): int
TakeSnapshotWithConfigEx(connection: const FUABT_RtcConnection&, uid: int64, config: const FUABT_SnapshotConfig&): int
UpdateChannelMediaOptionsEx(options: const FChannelMediaOptions&, connection: const FRtcConnection&): int
UpdateRtmpTranscodingEx(transcoding: const FLiveTranscoding&, connection: const FRtcConnection&): int

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

方法参数返回值错误
AddVideoWatermarkExwatermarkUrl: const FString&, options: const FWatermarkOptions&, connection: const FRtcConnection&int错误码索引
AdjustUserPlaybackSignalVolumeExuid: int64, volume: int, connection: const FRtcConnection&int错误码索引
ClearVideoWatermarkExconnection: const FRtcConnection&int错误码索引
CreateDataStreamExstreamId: int&, config: const FDataStreamConfig&, connection: const FRtcConnection&int错误码索引
EnableAudioVolumeIndicationExinterval: int, smooth: int, reportVad: bool, connection: const FRtcConnection&int错误码索引
EnableContentInspectExenabled: bool, config: const FContentInspectConfig&, connection: const FRtcConnection&int错误码索引
EnableDualStreamModeExenabled: bool, streamConfig: const FSimulcastStreamConfig&, connection: const FRtcConnection&int错误码索引
EnableEncryptionExconnection: const FRtcConnection&, enabled: bool, config: const FEncryptionConfig&int错误码索引
EnableLoopbackRecordingExconnection: const FRtcConnection&, enabled: bool, deviceName: const FString&int错误码索引
GetCallIdExcallId: FString&, connection: const FRtcConnection&int错误码索引
GetConnectionStateExconnection: const FRtcConnection&ECONNECTION_STATE_TYPE错误码索引
JoinChannelExtoken: const FString&, connection: const FRtcConnection&, options: const FChannelMediaOptions&int错误码索引
JoinChannelWithUserAccountExtoken: const FString&, channelId: const FString&, userAccount: const FString&, options: const FChannelMediaOptions&int错误码索引
LeaveChannelExconnection: const FRtcConnection&, options: const FLeaveChannelOptions&int错误码索引
MuteAllRemoteAudioStreamsExmute: bool, connection: const FRtcConnection&int错误码索引
MuteAllRemoteVideoStreamsExmute: bool, connection: const FRtcConnection&int错误码索引
MuteLocalAudioStreamExmute: bool, connection: const FRtcConnection&int错误码索引
MuteLocalVideoStreamExmute: bool, connection: const FRtcConnection&int错误码索引
MuteRemoteAudioStreamExuid: int64, mute: bool, connection: const FRtcConnection&int错误码索引
MuteRemoteVideoStreamExuid: int64, mute: bool, connection: const FRtcConnection&int错误码索引
PauseAllChannelMediaRelayExconnection: const FRtcConnection&int错误码索引
ResumeAllChannelMediaRelayExconnection: const FRtcConnection&int错误码索引
SendCustomReportMessageExid: const FString&, category: const FString&, event: const FString&, label: const FString&, value: int, connection: const FRtcConnection&int错误码索引
SendStreamMessageExstreamId: int, data: const FString&, connection: const FRtcConnection&int错误码索引
SetDualStreamModeExmode: FENUMWRAP_SIMULCAST_STREAM_MODE, streamConfig: const FSimulcastStreamConfig&, connection: const FRtcConnection&int错误码索引
SetRemoteRenderModeExuid: int64, renderMode: ERENDER_MODE_TYPE, mirrorMode: EVIDEO_MIRROR_MODE_TYPE, connection: const FRtcConnection&int错误码索引
SetRemoteVideoStreamTypeExuid: int64, streamType: EVIDEO_STREAM_TYPE, connection: const FRtcConnection&int错误码索引
SetRemoteVoicePositionExuid: int64, pan: float, gain: float, connection: const FRtcConnection&int错误码索引
SetSubscribeAudioAllowlistExuidList: TArray, uidNumber: int, connection: const FRtcConnection&int错误码索引
SetSubscribeAudioBlocklistExuidList: TArray, uidNumber: int, connection: const FRtcConnection&int错误码索引
SetSubscribeVideoAllowlistExuidList: TArray, uidNumber: int, connection: const FRtcConnection&int错误码索引
SetSubscribeVideoBlocklistExuidList: TArray, uidNumber: int, connection: const FRtcConnection&int错误码索引
SetVideoEncoderConfigurationExconfig: const FVideoEncoderConfiguration&, connection: const FRtcConnection&int错误码索引
SetupRemoteVideoExcanvas: const FVideoCanvas&, connection: const FRtcConnection&int错误码索引
StartMediaRenderingTracingExconnection: const FRtcConnection&int错误码索引
StartOrUpdateChannelMediaRelayExconfiguration: const FChannelMediaRelayConfiguration&, connection: const FRtcConnection&int错误码索引
StartRtmpStreamWithTranscodingExurl: const FString&, transcoding: const FLiveTranscoding&, connection: const FRtcConnection&int错误码索引
StartRtmpStreamWithoutTranscodingExurl: const FString&, connection: const FRtcConnection&int错误码索引
StopChannelMediaRelayExconnection: const FRtcConnection&int错误码索引
StopRtmpStreamExurl: const FString&, connection: const FRtcConnection&int错误码索引
TakeSnapshotExconnection: const FRtcConnection&, uid: int64, filePath: const FString&int错误码索引
TakeSnapshotWithConfigExconnection: const FUABT_RtcConnection&, uid: int64, config: const FUABT_SnapshotConfig&int错误码索引
UpdateChannelMediaOptionsExoptions: const FChannelMediaOptions&, connection: const FRtcConnection&int错误码索引
UpdateRtmpTranscodingExtranscoding: const FLiveTranscoding&, connection: const FRtcConnection&int错误码索引
IScreenCaptureSourceList 3 方法 / 0 属性
typescript
GetCount(): int
GetSourceInfo(index: int): FScreenCaptureSourceInfo
Release(): void

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

方法参数返回值错误
GetCount—int错误码索引
GetSourceInfoindex: intFScreenCaptureSourceInfo错误码索引
Release—void错误码索引
IVideoDeviceCollection 4 方法 / 0 属性
typescript
GetCount(): int
GetDevice(index: int, deviceName: FString&, deviceId: FString&): int
Release(): void
SetDevice(deviceIdUTF8: FString&): int

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

方法参数返回值错误
GetCount—int错误码索引
GetDeviceindex: int, deviceName: FString&, deviceId: FString&int错误码索引
Release—void错误码索引
SetDevicedeviceIdUTF8: FString&int错误码索引
IVideoDeviceManager 4 方法 / 0 属性
typescript
EnumerateVideoDevices(): UVideoDeviceCollection*
GetCapability(deviceIdUTF8: const FString&, deviceCapabilityNumber: int, capability: FVideoFormat&): int
NumberOfCapabilities(deviceIdUTF8: const FString&): int
Release(): void

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

方法参数返回值错误
EnumerateVideoDevices—UVideoDeviceCollection*错误码索引
GetCapabilitydeviceIdUTF8: const FString&, deviceCapabilityNumber: int, capability: FVideoFormat&int错误码索引
NumberOfCapabilitiesdeviceIdUTF8: const FString&int错误码索引
Release—void错误码索引

枚举

枚举成员数示例值
EAUDIENCE_LATENCY_LEVEL_TYPE2AUDIENCE_LATENCY_LEVEL_LOW_LATENCY = 1
EAUDIO_AINS_MODE3AINS_MODE_BALANCED = 0
EAUDIO_CODEC_PROFILE_TYPE3AUDIO_CODEC_PROFILE_LC_AAC = 0
EAUDIO_DUAL_MONO_MODE4AUDIO_DUAL_MONO_STEREO = 0
EAUDIO_ENCODED_FRAME_OBSERVER_POSITION3AUDIO_ENCODED_FRAME_OBSERVER_POSITION_RECORD = 1
EAUDIO_EQUALIZATION_BAND_FREQUENCY10AUDIO_EQUALIZATION_BAND_31 = 0
EAUDIO_FILE_RECORDING_TYPE3AUDIO_FILE_RECORDING_MIC = 1
EAUDIO_MIXING_DUAL_MONO_MODE4AUDIO_MIXING_DUAL_MONO_AUTO = 0
EAUDIO_PROFILE_TYPE8AUDIO_PROFILE_DEFAULT = 0
EAUDIO_RECORDING_QUALITY_TYPE4AUDIO_RECORDING_QUALITY_LOW = 0
EAUDIO_REVERB_TYPE5AUDIO_REVERB_DRY_LEVEL = 0
EAUDIO_SAMPLE_RATE_TYPE3AUDIO_SAMPLE_RATE_32000 = 32000
EAUDIO_SCENARIO_TYPE7AUDIO_SCENARIO_DEFAULT = 0
EAUDIO_SESSION_OPERATION_RESTRICTION5AUDIO_SESSION_OPERATION_RESTRICTION_NONE = null
EBACKGROUND_BLUR_DEGREE3BLUR_DEGREE_LOW = 1
EBACKGROUND_SOURCE_TYPE4BACKGROUND_COLOR = 1
ECAMERA_DIRECTION2CAMERA_REAR = 0
ECAMERA_FOCAL_LENGTH_TYPE4CAMERA_FOCAL_LENGTH_DEFAULT = 0
ECHANNEL_PROFILE_TYPE4CHANNEL_PROFILE_COMMUNICATION = 0
ECLIENT_ROLE_CHANGE_FAILED_REASON4CLIENT_ROLE_CHANGE_FAILED_TOO_MANY_BROADCASTERS = 1
ECLIENT_ROLE_TYPE2CLIENT_ROLE_BROADCASTER = 1
ECLOUD_PROXY_TYPE3NONE_PROXY = 0
ECOMPRESSION_PREFERENCE3PREFER_COMPRESSION_AUTO = -1
ECONNECTION_CHANGED_REASON_TYPE21CONNECTION_CHANGED_CONNECTING = 0
ECONNECTION_STATE_TYPE5CONNECTION_STATE_DISCONNECTED = 1
ECONTENT_INSPECT_TYPE3CONTENT_INSPECT_INVALID = 0
EENCRYPTION_ERROR_TYPE5ENCRYPTION_ERROR_INTERNAL_FAILURE = 0
EENCRYPTION_MODE9AES_128_XTS = 1
EEXTERNAL_VIDEO_SOURCE_TYPE2VIDEO_FRAME = 0
EFeatureType2VIDEO_VIRTUAL_BACKGROUND = 1
ELASTMILE_PROBE_RESULT_STATE3LASTMILE_PROBE_RESULT_COMPLETE = 1
ELIGHTENING_CONTRAST_LEVEL3LIGHTENING_CONTRAST_LOW = 0
ELOCAL_AUDIO_STREAM_REASON11LOCAL_AUDIO_STREAM_REASON_OK = 0
ELOCAL_AUDIO_STREAM_STATE4LOCAL_AUDIO_STREAM_STATE_STOPPED = 0
ELOCAL_PROXY_MODE2ConnectivityFirst = 0
ELOCAL_VIDEO_STREAM_REASON26LOCAL_VIDEO_STREAM_REASON_OK = 0
ELOCAL_VIDEO_STREAM_STATE4LOCAL_VIDEO_STREAM_STATE_STOPPED = 0
ELOG_LEVEL5LOG_LEVEL_NONE = 0
ELOW_LIGHT_ENHANCE_MODE2LOW_LIGHT_ENHANCE_AUTO = 0
EMEDIA_DEVICE_STATE_TYPE6MEDIA_DEVICE_STATE_IDLE = 0
EMEDIA_PLAYER_EVENT14PLAYER_EVENT_SEEK_BEGIN = 0
EMEDIA_PLAYER_STATE9PLAYER_STATE_IDLE = 0
EMEDIA_STREAM_TYPE4STREAM_TYPE_UNKNOWN = 0
EMEDIA_TRACE_EVENT2MEDIA_TRACE_EVENT_VIDEO_RENDERED = 0
EPERMISSION_TYPE3RECORD_AUDIO = 0
EPLAYER_PRELOAD_EVENT3PLAYER_PRELOAD_EVENT_BEGIN = 0
EPROXY_TYPE5NONE_PROXY_TYPE = 0
EQUALITY_ADAPT_INDICATION3ADAPT_NONE = 0
EREMOTE_AUDIO_STATE5REMOTE_AUDIO_STATE_STOPPED = 0
EREMOTE_AUDIO_STATE_REASON8REMOTE_AUDIO_REASON_INTERNAL = 0
EREMOTE_VIDEO_STATE5REMOTE_VIDEO_STATE_STOPPED = 0
EREMOTE_VIDEO_STATE_REASON12REMOTE_VIDEO_STATE_REASON_INTERNAL = 0
ERENDER_MODE_TYPE3RENDER_MODE_HIDDEN = 1
ERTMP_STREAM_PUBLISH_REASON15RTMP_STREAM_PUBLISH_REASON_OK = 0
ERTMP_STREAM_PUBLISH_STATE6RTMP_STREAM_PUBLISH_STATE_IDLE = 0
ERTMP_STREAMING_EVENT4RTMP_STREAMING_EVENT_FAILED_LOAD_IMAGE = 1
ESCREEN_SCENARIO_TYPE4SCREEN_SCENARIO_DOCUMENT = 1
ESEG_MODEL_TYPE2SEG_MODEL_AI = 1
ESTREAM_FALLBACK_OPTIONS3STREAM_FALLBACK_OPTION_DISABLED = 0
ESTREAM_PUBLISH_STATE4PUB_STATE_IDLE = 0
ESTREAM_SUBSCRIBE_STATE4SUB_STATE_IDLE = 0
EUABT_AUDIO_SOURCE_TYPE7AUDIO_SOURCE_MICROPHONE = 0
EUABT_DEGRADATION_PREFERENCE5MAINTAIN_AUTO = -1
EUABT_FACE_SHAPE_AREA13FACE_SHAPE_AREA_NONE = -1
EUABT_FACE_SHAPE_BEAUTY_STYLE2FACE_SHAPE_BEAUTY_STYLE_FEMALE = 0
EUABT_LOW_LIGHT_ENHANCE_LEVEL2LOW_LIGHT_ENHANCE_LEVEL_HIGH_QUALITY = 0
EUABT_MEDIA_SOURCE_TYPE6AUDIO_PLAYOUT_SOURCE = 0
EUABT_ORIENTATION_MODE3ORIENTATION_MODE_ADAPTIVE = 0
EUABT_VIDEO_CODEC_TYPE6VIDEO_CODEC_NONE = 0
EUABT_VIDEO_DENOISER_LEVEL2VIDEO_DENOISER_LEVEL_HIGH_QUALITY = 0
EUABT_VIDEO_MIRROR_MODE_TYPE3VIDEO_MIRROR_MODE_AUTO = 0
EUABT_VIDEO_MODULE_POSITION4POSITION_POST_CAPTURER = 1
EUABT_VIDEO_SOURCE_TYPE18VIDEO_SOURCE_CAMERA_PRIMARY = 0
EUSER_OFFLINE_REASON_TYPE3USER_OFFLINE_QUIT = 0
EVIDEO_APPLICATION_SCENARIO_TYPE4APPLICATION_SCENARIO_GENERAL = 0
EVIDEO_CODEC_PROFILE_TYPE3VIDEO_CODEC_PROFILE_BASELINE = 66
EVIDEO_CODEC_TYPE_FOR_STREAM2VIDEO_CODEC_H264_FOR_STREAM = 1
EVIDEO_CONTENT_HINT3CONTENT_HINT_NONE = null
EVIDEO_DENOISER_MODE2VIDEO_DENOISER_AUTO = 0
EVIDEO_STREAM_TYPE2VIDEO_STREAM_HIGH = 0
EVIDEO_TRANSCODER_ERROR6VT_ERR_VIDEO_SOURCE_NOT_READY = 1
EVIDEO_VIEW_SETUP_MODE3VIDEO_VIEW_SETUP_REPLACE = 0
EVOICE_AI_TUNER_TYPE10VOICE_AI_TUNER_MATURE_MALE = 0
EWATERMARK_FIT_MODE2FIT_MODE_COVER_POSITION = null
FENUMWRAP_AREA_CODE7AREA_CODE_CN = null
FENUMWRAP_AUDIO_EFFECT_PRESET21AUDIO_EFFECT_OFF = null
FENUMWRAP_AUDIO_MIXING_REASON_TYPE7AUDIO_MIXING_REASON_OK = 0
FENUMWRAP_AUDIO_MIXING_STATE_TYPE4AUDIO_MIXING_STATE_PLAYING = 710
FENUMWRAP_CAMERA_STABILIZATION_MODE5CAMERA_STABILIZATION_MODE_OFF = -1
FENUMWRAP_CAPTURE_BRIGHTNESS_LEVEL_TYPE4CAPTURE_BRIGHTNESS_LEVEL_INVALID = -1
FENUMWRAP_ENCODING_PREFERENCE3PREFER_AUTO = -1
FENUMWRAP_HEADPHONE_EQUALIZER_PRESET3HEADPHONE_EQUALIZER_OFF = null
FENUMWRAP_MEDIA_DEVICE_TYPE8UNKNOWN_AUDIO_DEVICE = -1
FENUMWRAP_MEDIA_PLAYER_REASON16PLAYER_REASON_NONE = 0
FENUMWRAP_NETWORK_TYPE8NETWORK_TYPE_UNKNOWN = -1
FENUMWRAP_RHYTHM_PLAYER_REASON5RHYTHM_PLAYER_REASON_OK = 0
FENUMWRAP_RHYTHM_PLAYER_STATE_TYPE5RHYTHM_PLAYER_STATE_IDLE = 810
FENUMWRAP_ScreenCaptureSourceType4ScreenCaptureSourceType_Unknown = -1
FENUMWRAP_SIMULCAST_STREAM_MODE3AUTO_SIMULCAST_STREAM = -1
FENUMWRAP_VIDEO_CODEC_CAPABILITY_LEVEL5CODEC_CAPABILITY_LEVEL_UNSPECIFIED = -1
FENUMWRAP_VIDEO_ORIENTATION4VIDEO_ORIENTATION_0 = 0
FENUMWRAP_VOICE_BEAUTIFIER_PRESET14VOICE_BEAUTIFIER_OFF = null
FENUMWRAP_VOICE_CONVERSION_PRESET5VOICE_CONVERSION_OFF = null
EAUDIENCE_LATENCY_LEVEL_TYPE 2 个成员
成员值
AUDIENCE_LATENCY_LEVEL_LOW_LATENCY1
AUDIENCE_LATENCY_LEVEL_ULTRA_LOW_LATENCY2
EAUDIO_AINS_MODE 3 个成员
成员值
AINS_MODE_BALANCED0
AINS_MODE_AGGRESSIVE1
AINS_MODE_ULTRALOWLATENCY2
EAUDIO_CODEC_PROFILE_TYPE 3 个成员
成员值
AUDIO_CODEC_PROFILE_LC_AAC0
AUDIO_CODEC_PROFILE_HE_AAC1
HE_AAC_V22
EAUDIO_DUAL_MONO_MODE 4 个成员
成员值
AUDIO_DUAL_MONO_STEREO0
AUDIO_DUAL_MONO_L1
AUDIO_DUAL_MONO_R2
AUDIO_DUAL_MONO_MIX3
EAUDIO_ENCODED_FRAME_OBSERVER_POSITION 3 个成员
成员值
AUDIO_ENCODED_FRAME_OBSERVER_POSITION_RECORD1
AUDIO_ENCODED_FRAME_OBSERVER_POSITION_PLAYBACK2
AUDIO_ENCODED_FRAME_OBSERVER_POSITION_MIXED3
EAUDIO_EQUALIZATION_BAND_FREQUENCY 10 个成员
成员值
AUDIO_EQUALIZATION_BAND_310
AUDIO_EQUALIZATION_BAND_621
AUDIO_EQUALIZATION_BAND_1252
AUDIO_EQUALIZATION_BAND_2503
AUDIO_EQUALIZATION_BAND_5004
AUDIO_EQUALIZATION_BAND_1K5
AUDIO_EQUALIZATION_BAND_2K6
AUDIO_EQUALIZATION_BAND_4K7
AUDIO_EQUALIZATION_BAND_8K8
AUDIO_EQUALIZATION_BAND_16K9
EAUDIO_FILE_RECORDING_TYPE 3 个成员
成员值
AUDIO_FILE_RECORDING_MIC1
AUDIO_FILE_RECORDING_PLAYBACK2
AUDIO_FILE_RECORDING_MIXED3
EAUDIO_MIXING_DUAL_MONO_MODE 4 个成员
成员值
AUDIO_MIXING_DUAL_MONO_AUTO0
AUDIO_MIXING_DUAL_MONO_L1
AUDIO_MIXING_DUAL_MONO_R2
AUDIO_MIXING_DUAL_MONO_MIX3
EAUDIO_PROFILE_TYPE 8 个成员
成员值
AUDIO_PROFILE_DEFAULT0
AUDIO_PROFILE_SPEECH_STANDARD1
AUDIO_PROFILE_MUSIC_STANDARD2
AUDIO_PROFILE_MUSIC_STANDARD_STEREO3
AUDIO_PROFILE_MUSIC_HIGH_QUALITY4
AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO5
AUDIO_PROFILE_IOT6
AUDIO_PROFILE_NUMnull
EAUDIO_RECORDING_QUALITY_TYPE 4 个成员
成员值
AUDIO_RECORDING_QUALITY_LOW0
AUDIO_RECORDING_QUALITY_MEDIUM1
AUDIO_RECORDING_QUALITY_HIGH2
AUDIO_RECORDING_QUALITY_ULTRA_HIGH3
EAUDIO_REVERB_TYPE 5 个成员
成员值
AUDIO_REVERB_DRY_LEVEL0
AUDIO_REVERB_WET_LEVEL1
AUDIO_REVERB_ROOM_SIZE2
AUDIO_REVERB_WET_DELAY3
AUDIO_REVERB_STRENGTH4
EAUDIO_SAMPLE_RATE_TYPE 3 个成员
成员值
AUDIO_SAMPLE_RATE_3200032000
AUDIO_SAMPLE_RATE_4410044100
AUDIO_SAMPLE_RATE_4800048000
EAUDIO_SCENARIO_TYPE 7 个成员
成员值
AUDIO_SCENARIO_DEFAULT0
AUDIO_SCENARIO_GAME_STREAMING3
AUDIO_SCENARIO_CHATROOM5
AUDIO_SCENARIO_CHORUS7
AUDIO_SCENARIO_MEETING8
AUDIO_SCENARIO_AI_CLIENT10
AUDIO_SCENARIO_NUMnull
EAUDIO_SESSION_OPERATION_RESTRICTION 5 个成员
成员值
AUDIO_SESSION_OPERATION_RESTRICTION_NONEnull
AUDIO_SESSION_OPERATION_RESTRICTION_SET_CATEGORYnull
AUDIO_SESSION_OPERATION_RESTRICTION_CONFIGURE_SESSIONnull
AUDIO_SESSION_OPERATION_RESTRICTION_DEACTIVATE_SESSIONnull
AUDIO_SESSION_OPERATION_RESTRICTION_ALLnull
EBACKGROUND_BLUR_DEGREE 3 个成员
成员值
BLUR_DEGREE_LOW1
BLUR_DEGREE_MEDIUM2
BLUR_DEGREE_HIGH3
EBACKGROUND_SOURCE_TYPE 4 个成员
成员值
BACKGROUND_COLOR1
BACKGROUND_IMG2
BACKGROUND_BLUR3
BACKGROUND_VIDEO4
ECAMERA_DIRECTION 2 个成员
成员值
CAMERA_REAR0
CAMERA_FRONT1
ECAMERA_FOCAL_LENGTH_TYPE 4 个成员
成员值
CAMERA_FOCAL_LENGTH_DEFAULT0
CAMERA_FOCAL_LENGTH_WIDE_ANGLE1
CAMERA_FOCAL_LENGTH_ULTRA_WIDE2
CAMERA_FOCAL_LENGTH_TELEPHOTO3
ECHANNEL_PROFILE_TYPE 4 个成员
成员值
CHANNEL_PROFILE_COMMUNICATION0
CHANNEL_PROFILE_LIVE_BROADCASTING1
CHANNEL_PROFILE_GAME2
CHANNEL_PROFILE_CLOUD_GAMING3
ECLIENT_ROLE_CHANGE_FAILED_REASON 4 个成员
成员值
CLIENT_ROLE_CHANGE_FAILED_TOO_MANY_BROADCASTERS1
CLIENT_ROLE_CHANGE_FAILED_NOT_AUTHORIZED2
CLIENT_ROLE_CHANGE_FAILED_REQUEST_TIME_OUT3
CLIENT_ROLE_CHANGE_FAILED_CONNECTION_FAILED4
ECLIENT_ROLE_TYPE 2 个成员
成员值
CLIENT_ROLE_BROADCASTER1
CLIENT_ROLE_AUDIENCE2
ECLOUD_PROXY_TYPE 3 个成员
成员值
NONE_PROXY0
UDP_PROXY1
TCP_PROXY2
ECOMPRESSION_PREFERENCE 3 个成员
成员值
PREFER_COMPRESSION_AUTO-1
PREFER_LOW_LATENCY0
PREFER_QUALITY1
ECONNECTION_CHANGED_REASON_TYPE 21 个成员
成员值
CONNECTION_CHANGED_CONNECTING0
CONNECTION_CHANGED_JOIN_SUCCESS1
CONNECTION_CHANGED_INTERRUPTED2
CONNECTION_CHANGED_BANNED_BY_SERVER3
CONNECTION_CHANGED_JOIN_FAILED4
CONNECTION_CHANGED_LEAVE_CHANNEL5
CONNECTION_CHANGED_INVALID_APP_ID6
CONNECTION_CHANGED_INVALID_CHANNEL_NAME7
CONNECTION_CHANGED_INVALID_TOKEN8
CONNECTION_CHANGED_TOKEN_EXPIRED9
CONNECTION_CHANGED_REJECTED_BY_SERVER10
CONNECTION_CHANGED_SETTING_PROXY_SERVER11
CONNECTION_CHANGED_RENEW_TOKEN12
CONNECTION_CHANGED_CLIENT_IP_ADDRESS_CHANGED13
CONNECTION_CHANGED_KEEP_ALIVE_TIMEOUT14
CONNECTION_CHANGED_REJOIN_SUCCESS15
CONNECTION_CHANGED_LOST16
CONNECTION_CHANGED_ECHO_TEST17
CONNECTION_CHANGED_CLIENT_IP_ADDRESS_CHANGED_BY_USER18
CONNECTION_CHANGED_SAME_UID_LOGIN19
CONNECTION_CHANGED_TOO_MANY_BROADCASTERS20
ECONNECTION_STATE_TYPE 5 个成员
成员值
CONNECTION_STATE_DISCONNECTED1
CONNECTION_STATE_CONNECTING2
CONNECTION_STATE_CONNECTED3
CONNECTION_STATE_RECONNECTING4
CONNECTION_STATE_FAILED5
ECONTENT_INSPECT_TYPE 3 个成员
成员值
CONTENT_INSPECT_INVALID0
CONTENT_INSPECT_SUPERVISION2
CONTENT_INSPECT_IMAGE_MODERATION3
EENCRYPTION_ERROR_TYPE 5 个成员
成员值
ENCRYPTION_ERROR_INTERNAL_FAILURE0
ENCRYPTION_ERROR_DECRYPTION_FAILURE1
ENCRYPTION_ERROR_ENCRYPTION_FAILURE2
ENCRYPTION_ERROR_DATASTREAM_DECRYPTION_FAILURE3
ENCRYPTION_ERROR_DATASTREAM_ENCRYPTION_FAILURE4
EENCRYPTION_MODE 9 个成员
成员值
AES_128_XTS1
AES_128_ECB2
AES_256_XTS3
SM4_128_ECB4
AES_128_GCM5
AES_256_GCM6
AES_128_GCM27
AES_256_GCM28
MODE_ENDnull
EEXTERNAL_VIDEO_SOURCE_TYPE 2 个成员
成员值
VIDEO_FRAME0
ENCODED_VIDEO_FRAME1
EFeatureType 2 个成员
成员值
VIDEO_VIRTUAL_BACKGROUND1
VIDEO_BEAUTY_EFFECT2
ELASTMILE_PROBE_RESULT_STATE 3 个成员
成员值
LASTMILE_PROBE_RESULT_COMPLETE1
LASTMILE_PROBE_RESULT_INCOMPLETE_NO_BWE2
LASTMILE_PROBE_RESULT_UNAVAILABLE3
ELIGHTENING_CONTRAST_LEVEL 3 个成员
成员值
LIGHTENING_CONTRAST_LOW0
LIGHTENING_CONTRAST_NORMAL1
LIGHTENING_CONTRAST_HIGH2
ELOCAL_AUDIO_STREAM_REASON 11 个成员
成员值
LOCAL_AUDIO_STREAM_REASON_OK0
LOCAL_AUDIO_STREAM_REASON_FAILURE1
LOCAL_AUDIO_STREAM_REASON_DEVICE_NO_PERMISSION2
LOCAL_AUDIO_STREAM_REASON_DEVICE_BUSY3
LOCAL_AUDIO_STREAM_REASON_RECORD_FAILURE4
LOCAL_AUDIO_STREAM_REASON_ENCODE_FAILURE5
LOCAL_AUDIO_STREAM_REASON_NO_RECORDING_DEVICE6
LOCAL_AUDIO_STREAM_REASON_NO_PLAYOUT_DEVICE7
LOCAL_AUDIO_STREAM_REASON_INTERRUPTED8
LOCAL_AUDIO_STREAM_REASON_RECORD_INVALID_ID9
LOCAL_AUDIO_STREAM_REASON_PLAYOUT_INVALID_ID10
ELOCAL_AUDIO_STREAM_STATE 4 个成员
成员值
LOCAL_AUDIO_STREAM_STATE_STOPPED0
LOCAL_AUDIO_STREAM_STATE_RECORDING1
LOCAL_AUDIO_STREAM_STATE_ENCODING2
LOCAL_AUDIO_STREAM_STATE_FAILED3
ELOCAL_PROXY_MODE 2 个成员
成员值
ConnectivityFirst0
LocalOnly1
ELOCAL_VIDEO_STREAM_REASON 26 个成员
成员值
LOCAL_VIDEO_STREAM_REASON_OK0
LOCAL_VIDEO_STREAM_REASON_FAILURE1
LOCAL_VIDEO_STREAM_REASON_DEVICE_NO_PERMISSION2
LOCAL_VIDEO_STREAM_REASON_DEVICE_BUSY3
LOCAL_VIDEO_STREAM_REASON_CAPTURE_FAILURE4
LOCAL_VIDEO_STREAM_REASON_CODEC_NOT_SUPPORT5
LOCAL_VIDEO_STREAM_REASON_CAPTURE_INBACKGROUND6
LOCAL_VIDEO_STREAM_REASON_CAPTURE_MULTIPLE_FOREGROUND_APPS7
LOCAL_VIDEO_STREAM_REASON_DEVICE_NOT_FOUND8
LOCAL_VIDEO_STREAM_REASON_DEVICE_DISCONNECTED9
LOCAL_VIDEO_STREAM_REASON_DEVICE_INVALID_ID10
LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_MINIMIZED11
LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_CLOSED12
LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_OCCLUDED13
LOCAL_VIDEO_STREAM_REASON_DEVICE_INTERRUPT14
LOCAL_VIDEO_STREAM_REASON_DEVICE_FATAL_ERROR15
LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_FAILURE21
LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_NO_PERMISSION22
LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_AUTO_FALLBACK24
LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_HIDDEN25
LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_RECOVER_FROM_HIDDEN26
LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_RECOVER_FROM_MINIMIZED27
LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_PAUSED28
LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_RESUMED29
LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_DISPLAY_DISCONNECTED30
LOCAL_VIDEO_STREAM_REASON_DEVICE_SYSTEM_PRESSURE101
ELOCAL_VIDEO_STREAM_STATE 4 个成员
成员值
LOCAL_VIDEO_STREAM_STATE_STOPPED0
LOCAL_VIDEO_STREAM_STATE_CAPTURING1
LOCAL_VIDEO_STREAM_STATE_ENCODING2
LOCAL_VIDEO_STREAM_STATE_FAILED3
ELOG_LEVEL 5 个成员
成员值
LOG_LEVEL_NONE0
LOG_LEVEL_INFO1
LOG_LEVEL_WARN2
LOG_LEVEL_ERROR4
LOG_LEVEL_FATAL8
ELOW_LIGHT_ENHANCE_MODE 2 个成员
成员值
LOW_LIGHT_ENHANCE_AUTO0
LOW_LIGHT_ENHANCE_MANUAL1
EMEDIA_DEVICE_STATE_TYPE 6 个成员
成员值
MEDIA_DEVICE_STATE_IDLE0
MEDIA_DEVICE_STATE_ACTIVE1
MEDIA_DEVICE_STATE_DISABLED2
MEDIA_DEVICE_STATE_PLUGGED_IN3
MEDIA_DEVICE_STATE_NOT_PRESENT4
MEDIA_DEVICE_STATE_UNPLUGGED8
EMEDIA_PLAYER_EVENT 14 个成员
成员值
PLAYER_EVENT_SEEK_BEGIN0
PLAYER_EVENT_SEEK_COMPLETE1
PLAYER_EVENT_SEEK_ERROR2
PLAYER_EVENT_AUDIO_TRACK_CHANGED5
PLAYER_EVENT_BUFFER_LOW6
PLAYER_EVENT_BUFFER_RECOVER7
PLAYER_EVENT_FREEZE_START8
PLAYER_EVENT_FREEZE_STOP9
PLAYER_EVENT_SWITCH_BEGIN10
PLAYER_EVENT_SWITCH_COMPLETE11
PLAYER_EVENT_SWITCH_ERROR12
PLAYER_EVENT_FIRST_DISPLAYED13
PLAYER_EVENT_REACH_CACHE_FILE_MAX_COUNT14
PLAYER_EVENT_REACH_CACHE_FILE_MAX_SIZE15
EMEDIA_PLAYER_STATE 9 个成员
成员值
PLAYER_STATE_IDLE0
PLAYER_STATE_OPENING1
PLAYER_STATE_OPEN_COMPLETED2
PLAYER_STATE_PLAYING3
PLAYER_STATE_PAUSED4
PLAYER_STATE_PLAYBACK_COMPLETED5
PLAYER_STATE_PLAYBACK_ALL_LOOPS_COMPLETED6
PLAYER_STATE_STOPPED7
PLAYER_STATE_FAILED100
EMEDIA_STREAM_TYPE 4 个成员
成员值
STREAM_TYPE_UNKNOWN0
STREAM_TYPE_VIDEO1
STREAM_TYPE_AUDIO2
STREAM_TYPE_SUBTITLE3
EMEDIA_TRACE_EVENT 2 个成员
成员值
MEDIA_TRACE_EVENT_VIDEO_RENDERED0
MEDIA_TRACE_EVENT_VIDEO_DECODED1
EPERMISSION_TYPE 3 个成员
成员值
RECORD_AUDIO0
CAMERA1
SCREEN_CAPTUREnull
EPLAYER_PRELOAD_EVENT 3 个成员
成员值
PLAYER_PRELOAD_EVENT_BEGIN0
PLAYER_PRELOAD_EVENT_COMPLETE1
PLAYER_PRELOAD_EVENT_ERROR2
EPROXY_TYPE 5 个成员
成员值
NONE_PROXY_TYPE0
UDP_PROXY_TYPE1
TCP_PROXY_TYPE2
LOCAL_PROXY_TYPE3
TCP_PROXY_AUTO_FALLBACK_TYPE4
EQUALITY_ADAPT_INDICATION 3 个成员
成员值
ADAPT_NONE0
ADAPT_UP_BANDWIDTH1
ADAPT_DOWN_BANDWIDTH2
EREMOTE_AUDIO_STATE 5 个成员
成员值
REMOTE_AUDIO_STATE_STOPPED0
REMOTE_AUDIO_STATE_STARTING1
REMOTE_AUDIO_STATE_DECODING2
REMOTE_AUDIO_STATE_FROZEN3
REMOTE_AUDIO_STATE_FAILED4
EREMOTE_AUDIO_STATE_REASON 8 个成员
成员值
REMOTE_AUDIO_REASON_INTERNAL0
REMOTE_AUDIO_REASON_NETWORK_CONGESTION1
REMOTE_AUDIO_REASON_NETWORK_RECOVERY2
REMOTE_AUDIO_REASON_LOCAL_MUTED3
REMOTE_AUDIO_REASON_LOCAL_UNMUTED4
REMOTE_AUDIO_REASON_REMOTE_MUTED5
REMOTE_AUDIO_REASON_REMOTE_UNMUTED6
REMOTE_AUDIO_REASON_REMOTE_OFFLINE7
EREMOTE_VIDEO_STATE 5 个成员
成员值
REMOTE_VIDEO_STATE_STOPPED0
REMOTE_VIDEO_STATE_STARTING1
REMOTE_VIDEO_STATE_DECODING2
REMOTE_VIDEO_STATE_FROZEN3
REMOTE_VIDEO_STATE_FAILED4
EREMOTE_VIDEO_STATE_REASON 12 个成员
成员值
REMOTE_VIDEO_STATE_REASON_INTERNAL0
REMOTE_VIDEO_STATE_REASON_NETWORK_CONGESTION1
REMOTE_VIDEO_STATE_REASON_NETWORK_RECOVERY2
REMOTE_VIDEO_STATE_REASON_LOCAL_MUTED3
REMOTE_VIDEO_STATE_REASON_LOCAL_UNMUTED4
REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED5
REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED6
REMOTE_VIDEO_STATE_REASON_REMOTE_OFFLINE7
REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK8
REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK_RECOVERY9
REMOTE_VIDEO_STATE_REASON_SDK_IN_BACKGROUND12
REMOTE_VIDEO_STATE_REASON_CODEC_NOT_SUPPORT13
ERENDER_MODE_TYPE 3 个成员
成员值
RENDER_MODE_HIDDEN1
RENDER_MODE_FIT2
RENDER_MODE_ADAPTIVE3
ERTMP_STREAM_PUBLISH_REASON 15 个成员
成员值
RTMP_STREAM_PUBLISH_REASON_OK0
RTMP_STREAM_PUBLISH_REASON_INVALID_ARGUMENT1
RTMP_STREAM_PUBLISH_REASON_ENCRYPTED_STREAM_NOT_ALLOWED2
RTMP_STREAM_PUBLISH_REASON_CONNECTION_TIMEOUT3
RTMP_STREAM_PUBLISH_REASON_INTERNAL_SERVER_ERROR4
RTMP_STREAM_PUBLISH_REASON_RTMP_SERVER_ERROR5
RTMP_STREAM_PUBLISH_REASON_TOO_OFTEN6
RTMP_STREAM_PUBLISH_REASON_REACH_LIMIT7
RTMP_STREAM_PUBLISH_REASON_NOT_AUTHORIZED8
RTMP_STREAM_PUBLISH_REASON_STREAM_NOT_FOUND9
RTMP_STREAM_PUBLISH_REASON_FORMAT_NOT_SUPPORTED10
RTMP_STREAM_PUBLISH_REASON_NOT_BROADCASTER11
RTMP_STREAM_PUBLISH_REASON_TRANSCODING_NO_MIX_STREAM13
RTMP_STREAM_PUBLISH_REASON_NET_DOWN14
RTMP_STREAM_PUBLISH_REASON_INVALID_PRIVILEGE16
ERTMP_STREAM_PUBLISH_STATE 6 个成员
成员值
RTMP_STREAM_PUBLISH_STATE_IDLE0
RTMP_STREAM_PUBLISH_STATE_CONNECTING1
RTMP_STREAM_PUBLISH_STATE_RUNNING2
RTMP_STREAM_PUBLISH_STATE_RECOVERING3
RTMP_STREAM_PUBLISH_STATE_FAILURE4
RTMP_STREAM_PUBLISH_STATE_DISCONNECTING5
ERTMP_STREAMING_EVENT 4 个成员
成员值
RTMP_STREAMING_EVENT_FAILED_LOAD_IMAGE1
RTMP_STREAMING_EVENT_URL_ALREADY_IN_USE2
RTMP_STREAMING_EVENT_ADVANCED_FEATURE_NOT_SUPPORT3
RTMP_STREAMING_EVENT_REQUEST_TOO_OFTEN4
ESCREEN_SCENARIO_TYPE 4 个成员
成员值
SCREEN_SCENARIO_DOCUMENT1
SCREEN_SCENARIO_GAMING2
SCREEN_SCENARIO_VIDEO3
SCREEN_SCENARIO_RDC4
ESEG_MODEL_TYPE 2 个成员
成员值
SEG_MODEL_AI1
SEG_MODEL_GREEN2
ESTREAM_FALLBACK_OPTIONS 3 个成员
成员值
STREAM_FALLBACK_OPTION_DISABLED0
STREAM_FALLBACK_OPTION_VIDEO_STREAM_LOW1
STREAM_FALLBACK_OPTION_AUDIO_ONLY2
ESTREAM_PUBLISH_STATE 4 个成员
成员值
PUB_STATE_IDLE0
PUB_STATE_NO_PUBLISHED1
PUB_STATE_PUBLISHING2
PUB_STATE_PUBLISHED3
ESTREAM_SUBSCRIBE_STATE 4 个成员
成员值
SUB_STATE_IDLE0
SUB_STATE_NO_SUBSCRIBED1
SUB_STATE_SUBSCRIBING2
SUB_STATE_SUBSCRIBED3
EUABT_AUDIO_SOURCE_TYPE 7 个成员
成员值
AUDIO_SOURCE_MICROPHONE0
AUDIO_SOURCE_CUSTOM1
AUDIO_SOURCE_MEDIA_PLAYER2
AUDIO_SOURCE_LOOPBACK_RECORDING3
AUDIO_SOURCE_REMOTE_USER5
AUDIO_SOURCE_REMOTE_CHANNEL6
AUDIO_SOURCE_UNKNOWN100
EUABT_DEGRADATION_PREFERENCE 5 个成员
成员值
MAINTAIN_AUTO-1
MAINTAIN_QUALITY0
MAINTAIN_FRAMERATE1
MAINTAIN_BALANCED2
MAINTAIN_RESOLUTION3
EUABT_FACE_SHAPE_AREA 13 个成员
成员值
FACE_SHAPE_AREA_NONE-1
FACE_SHAPE_AREA_HEADSCALE0
FACE_SHAPE_AREA_FOREHEAD1
FACE_SHAPE_AREA_FACECONTOUR2
FACE_SHAPE_AREA_FACELENGTH3
FACE_SHAPE_AREA_FACEWIDTH4
FACE_SHAPE_AREA_CHEEKBONE5
FACE_SHAPE_AREA_CHEEK6
FACE_SHAPE_AREA_CHIN7
FACE_SHAPE_AREA_EYESCALE8
FACE_SHAPE_AREA_NOSELENGTH9
FACE_SHAPE_AREA_NOSEWIDTH10
FACE_SHAPE_AREA_MOUTHSCALE11
EUABT_FACE_SHAPE_BEAUTY_STYLE 2 个成员
成员值
FACE_SHAPE_BEAUTY_STYLE_FEMALE0
FACE_SHAPE_BEAUTY_STYLE_MALE1
EUABT_LOW_LIGHT_ENHANCE_LEVEL 2 个成员
成员值
LOW_LIGHT_ENHANCE_LEVEL_HIGH_QUALITY0
LOW_LIGHT_ENHANCE_LEVEL_FAST1
EUABT_MEDIA_SOURCE_TYPE 6 个成员
成员值
AUDIO_PLAYOUT_SOURCE0
AUDIO_RECORDING_SOURCE1
PRIMARY_CAMERA_SOURCE2
SECONDARY_CAMERA_SOURCE3
CUSTOM_VIDEO_SOURCE6
UNKNOWN_MEDIA_SOURCE100
EUABT_ORIENTATION_MODE 3 个成员
成员值
ORIENTATION_MODE_ADAPTIVE0
ORIENTATION_MODE_FIXED_LANDSCAPE1
ORIENTATION_MODE_FIXED_PORTRAIT2
EUABT_VIDEO_CODEC_TYPE 6 个成员
成员值
VIDEO_CODEC_NONE0
VIDEO_CODEC_VP81
VIDEO_CODEC_H2642
VIDEO_CODEC_H2653
VIDEO_CODEC_GENERIC6
VIDEO_CODEC_GENERIC_JPEG20
EUABT_VIDEO_DENOISER_LEVEL 2 个成员
成员值
VIDEO_DENOISER_LEVEL_HIGH_QUALITY0
VIDEO_DENOISER_LEVEL_FAST1
EUABT_VIDEO_MIRROR_MODE_TYPE 3 个成员
成员值
VIDEO_MIRROR_MODE_AUTO0
VIDEO_MIRROR_MODE_ENABLED1
VIDEO_MIRROR_MODE_DISABLED2
EUABT_VIDEO_MODULE_POSITION 4 个成员
成员值
POSITION_POST_CAPTURER1
POSITION_PRE_RENDERER2
POSITION_PRE_ENCODER4
POSITION_POST_CAPTURER_ORIGIN8
EUABT_VIDEO_SOURCE_TYPE 18 个成员
成员值
VIDEO_SOURCE_CAMERA_PRIMARY0
VIDEO_SOURCE_CAMERA0
VIDEO_SOURCE_CAMERA_SECONDARY1
VIDEO_SOURCE_SCREEN_PRIMARY2
VIDEO_SOURCE_SCREEN2
VIDEO_SOURCE_SCREEN_SECONDARY3
VIDEO_SOURCE_CUSTOM4
VIDEO_SOURCE_MEDIA_PLAYER5
VIDEO_SOURCE_RTC_IMAGE_PNG6
VIDEO_SOURCE_RTC_IMAGE_JPEG7
VIDEO_SOURCE_RTC_IMAGE_GIF8
VIDEO_SOURCE_REMOTE9
VIDEO_SOURCE_TRANSCODED10
VIDEO_SOURCE_CAMERA_THIRD11
VIDEO_SOURCE_CAMERA_FOURTH12
VIDEO_SOURCE_SCREEN_THIRD13
VIDEO_SOURCE_SCREEN_FOURTH14
VIDEO_SOURCE_UNKNOWN100
EUSER_OFFLINE_REASON_TYPE 3 个成员
成员值
USER_OFFLINE_QUIT0
USER_OFFLINE_DROPPED1
USER_OFFLINE_BECOME_AUDIENCE2
EVIDEO_APPLICATION_SCENARIO_TYPE 4 个成员
成员值
APPLICATION_SCENARIO_GENERAL0
APPLICATION_SCENARIO_MEETINGnull
APPLICATION_SCENARIO_1V1null
APPLICATION_SCENARIO_LIVESHOWnull
EVIDEO_CODEC_PROFILE_TYPE 3 个成员
成员值
VIDEO_CODEC_PROFILE_BASELINE66
VIDEO_CODEC_PROFILE_MAIN77
VIDEO_CODEC_PROFILE_HIGH100
EVIDEO_CODEC_TYPE_FOR_STREAM 2 个成员
成员值
VIDEO_CODEC_H264_FOR_STREAM1
VIDEO_CODEC_H265_FOR_STREAM2
EVIDEO_CONTENT_HINT 3 个成员
成员值
CONTENT_HINT_NONEnull
CONTENT_HINT_MOTIONnull
CONTENT_HINT_DETAILSnull
EVIDEO_DENOISER_MODE 2 个成员
成员值
VIDEO_DENOISER_AUTO0
VIDEO_DENOISER_MANUAL1
EVIDEO_STREAM_TYPE 2 个成员
成员值
VIDEO_STREAM_HIGH0
VIDEO_STREAM_LOW1
EVIDEO_TRANSCODER_ERROR 6 个成员
成员值
VT_ERR_VIDEO_SOURCE_NOT_READY1
VT_ERR_INVALID_VIDEO_SOURCE_TYPE2
VT_ERR_INVALID_IMAGE_PATH3
VT_ERR_UNSUPPORT_IMAGE_FORMAT4
VT_ERR_INVALID_LAYOUT5
VT_ERR_INTERNAL20
EVIDEO_VIEW_SETUP_MODE 3 个成员
成员值
VIDEO_VIEW_SETUP_REPLACE0
VIDEO_VIEW_SETUP_ADD1
VIDEO_VIEW_SETUP_REMOVE2
EVOICE_AI_TUNER_TYPE 10 个成员
成员值
VOICE_AI_TUNER_MATURE_MALE0
VOICE_AI_TUNER_FRESH_MALE1
VOICE_AI_TUNER_ELEGANT_FEMALE2
VOICE_AI_TUNER_SWEET_FEMALE3
VOICE_AI_TUNER_WARM_MALE_SINGING4
VOICE_AI_TUNER_GENTLE_FEMALE_SINGING5
VOICE_AI_TUNER_HUSKY_MALE_SINGING6
VOICE_AI_TUNER_WARM_ELEGANT_FEMALE_SINGING7
VOICE_AI_TUNER_POWERFUL_MALE_SINGING8
VOICE_AI_TUNER_DREAMY_FEMALE_SINGING9
EWATERMARK_FIT_MODE 2 个成员
成员值
FIT_MODE_COVER_POSITIONnull
FIT_MODE_USE_IMAGE_RATIOnull
FENUMWRAP_AREA_CODE 7 个成员
成员值
AREA_CODE_CNnull
AREA_CODE_NAnull
AREA_CODE_EUnull
AREA_CODE_ASnull
AREA_CODE_JPnull
AREA_CODE_INnull
AREA_CODE_GLOBnull
FENUMWRAP_AUDIO_EFFECT_PRESET 21 个成员
成员值
AUDIO_EFFECT_OFFnull
ROOM_ACOUSTICS_KTVnull
ROOM_ACOUSTICS_VOCAL_CONCERTnull
ROOM_ACOUSTICS_STUDIOnull
ROOM_ACOUSTICS_PHONOGRAPHnull
ROOM_ACOUSTICS_VIRTUAL_STEREOnull
ROOM_ACOUSTICS_SPACIALnull
ROOM_ACOUSTICS_ETHEREALnull
ROOM_ACOUSTICS_VIRTUAL_SURROUND_SOUNDnull
ROOM_ACOUSTICS_CHORUSnull
ROOM_ACOUSTICS_3D_VOICEnull
VOICE_CHANGER_EFFECT_UNCLEnull
VOICE_CHANGER_EFFECT_OLDMANnull
VOICE_CHANGER_EFFECT_BOYnull
VOICE_CHANGER_EFFECT_SISTERnull
VOICE_CHANGER_EFFECT_GIRLnull
VOICE_CHANGER_EFFECT_PIGKINGnull
VOICE_CHANGER_EFFECT_HULKnull
STYLE_TRANSFORMATION_RNBnull
STYLE_TRANSFORMATION_POPULARnull
PITCH_CORRECTIONnull
FENUMWRAP_AUDIO_MIXING_REASON_TYPE 7 个成员
成员值
AUDIO_MIXING_REASON_OK0
AUDIO_MIXING_REASON_CAN_NOT_OPEN701
AUDIO_MIXING_REASON_TOO_FREQUENT_CALL702
AUDIO_MIXING_REASON_INTERRUPTED_EOF703
AUDIO_MIXING_REASON_ONE_LOOP_COMPLETED721
AUDIO_MIXING_REASON_ALL_LOOPS_COMPLETED723
AUDIO_MIXING_REASON_STOPPED_BY_USER724
FENUMWRAP_AUDIO_MIXING_STATE_TYPE 4 个成员
成员值
AUDIO_MIXING_STATE_PLAYING710
AUDIO_MIXING_STATE_PAUSED711
AUDIO_MIXING_STATE_STOPPED713
AUDIO_MIXING_STATE_FAILED714
FENUMWRAP_CAMERA_STABILIZATION_MODE 5 个成员
成员值
CAMERA_STABILIZATION_MODE_OFF-1
CAMERA_STABILIZATION_MODE_AUTO0
CAMERA_STABILIZATION_MODE_LEVEL_11
CAMERA_STABILIZATION_MODE_LEVEL_22
CAMERA_STABILIZATION_MODE_LEVEL_33
FENUMWRAP_CAPTURE_BRIGHTNESS_LEVEL_TYPE 4 个成员
成员值
CAPTURE_BRIGHTNESS_LEVEL_INVALID-1
CAPTURE_BRIGHTNESS_LEVEL_NORMAL0
CAPTURE_BRIGHTNESS_LEVEL_BRIGHT1
CAPTURE_BRIGHTNESS_LEVEL_DARK2
FENUMWRAP_ENCODING_PREFERENCE 3 个成员
成员值
PREFER_AUTO-1
PREFER_SOFTWARE0
PREFER_HARDWARE1
FENUMWRAP_HEADPHONE_EQUALIZER_PRESET 3 个成员
成员值
HEADPHONE_EQUALIZER_OFFnull
HEADPHONE_EQUALIZER_OVEREARnull
HEADPHONE_EQUALIZER_INEARnull
FENUMWRAP_MEDIA_DEVICE_TYPE 8 个成员
成员值
UNKNOWN_AUDIO_DEVICE-1
AUDIO_PLAYOUT_DEVICE0
AUDIO_RECORDING_DEVICE1
VIDEO_RENDER_DEVICE2
VIDEO_CAPTURE_DEVICE3
AUDIO_APPLICATION_PLAYOUT_DEVICE4
AUDIO_VIRTUAL_PLAYOUT_DEVICEnull
AUDIO_VIRTUAL_RECORDING_DEVICEnull
FENUMWRAP_MEDIA_PLAYER_REASON 16 个成员
成员值
PLAYER_REASON_NONE0
PLAYER_REASON_INVALID_ARGUMENTS-1
PLAYER_REASON_INTERNAL-2
PLAYER_REASON_NO_RESOURCE-3
PLAYER_REASON_INVALID_MEDIA_SOURCE-4
PLAYER_REASON_UNKNOWN_STREAM_TYPE-5
PLAYER_REASON_OBJ_NOT_INITIALIZED-6
PLAYER_REASON_CODEC_NOT_SUPPORTED-7
PLAYER_REASON_VIDEO_RENDER_FAILED-8
PLAYER_REASON_INVALID_STATE-9
PLAYER_REASON_URL_NOT_FOUND-10
PLAYER_REASON_INVALID_CONNECTION_STATE-11
PLAYER_REASON_SRC_BUFFER_UNDERFLOW-12
PLAYER_REASON_INTERRUPTED-13
PLAYER_REASON_NOT_SUPPORTED-14
PLAYER_REASON_UNKNOWN-17
FENUMWRAP_NETWORK_TYPE 8 个成员
成员值
NETWORK_TYPE_UNKNOWN-1
NETWORK_TYPE_DISCONNECTED0
NETWORK_TYPE_LAN1
NETWORK_TYPE_WIFI2
NETWORK_TYPE_MOBILE_2G3
NETWORK_TYPE_MOBILE_3G4
NETWORK_TYPE_MOBILE_4G5
NETWORK_TYPE_MOBILE_5G6
FENUMWRAP_RHYTHM_PLAYER_REASON 5 个成员
成员值
RHYTHM_PLAYER_REASON_OK0
RHYTHM_PLAYER_REASON_FAILED1
RHYTHM_PLAYER_REASON_CAN_NOT_OPEN801
RHYTHM_PLAYER_REASON_CAN_NOT_PLAY802
RHYTHM_PLAYER_REASON_FILE_OVER_DURATION_LIMIT803
FENUMWRAP_RHYTHM_PLAYER_STATE_TYPE 5 个成员
成员值
RHYTHM_PLAYER_STATE_IDLE810
RHYTHM_PLAYER_STATE_OPENING811
RHYTHM_PLAYER_STATE_DECODING812
RHYTHM_PLAYER_STATE_PLAYING813
RHYTHM_PLAYER_STATE_FAILED814
FENUMWRAP_ScreenCaptureSourceType 4 个成员
成员值
ScreenCaptureSourceType_Unknown-1
ScreenCaptureSourceType_Window0
ScreenCaptureSourceType_Screen1
ScreenCaptureSourceType_Custom2
FENUMWRAP_SIMULCAST_STREAM_MODE 3 个成员
成员值
AUTO_SIMULCAST_STREAM-1
DISABLE_SIMULCAST_STREAM0
ENABLE_SIMULCAST_STREAM1
FENUMWRAP_VIDEO_CODEC_CAPABILITY_LEVEL 5 个成员
成员值
CODEC_CAPABILITY_LEVEL_UNSPECIFIED-1
CODEC_CAPABILITY_LEVEL_BASIC_SUPPORT5
CODEC_CAPABILITY_LEVEL_1080P30FPS10
CODEC_CAPABILITY_LEVEL_1080P60FPS20
CODEC_CAPABILITY_LEVEL_4K60FPS30
FENUMWRAP_VIDEO_ORIENTATION 4 个成员
成员值
VIDEO_ORIENTATION_00
VIDEO_ORIENTATION_9090
VIDEO_ORIENTATION_180180
VIDEO_ORIENTATION_270270
FENUMWRAP_VOICE_BEAUTIFIER_PRESET 14 个成员
成员值
VOICE_BEAUTIFIER_OFFnull
CHAT_BEAUTIFIER_MAGNETICnull
CHAT_BEAUTIFIER_FRESHnull
CHAT_BEAUTIFIER_VITALITYnull
SINGING_BEAUTIFIERnull
TIMBRE_TRANSFORMATION_VIGOROUSnull
TIMBRE_TRANSFORMATION_DEEPnull
TIMBRE_TRANSFORMATION_MELLOWnull
TIMBRE_TRANSFORMATION_FALSETTOnull
TIMBRE_TRANSFORMATION_FULLnull
TIMBRE_TRANSFORMATION_CLEARnull
TIMBRE_TRANSFORMATION_RESOUNDINGnull
TIMBRE_TRANSFORMATION_RINGINGnull
ULTRA_HIGH_QUALITY_VOICEnull
FENUMWRAP_VOICE_CONVERSION_PRESET 5 个成员
成员值
VOICE_CONVERSION_OFFnull
VOICE_CHANGER_NEUTRALnull
VOICE_CHANGER_SWEETnull
VOICE_CHANGER_SOLIDnull
VOICE_CHANGER_BASSnull

错误码常量

常量值
VT_ERR_INTERNAL20
VT_ERR_INVALID_IMAGE_PATH3
VT_ERR_INVALID_LAYOUT5
VT_ERR_INVALID_VIDEO_SOURCE_TYPE2
VT_ERR_UNSUPPORT_IMAGE_FORMAT4
VT_ERR_VIDEO_SOURCE_NOT_READY1

已知限制

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

接口成员
FUABT_FilterEffectOptionspath
FVideoCanvasview
IAudioDeviceCollectionGetApplicationVolume
IAudioDeviceCollectionGetCount
IAudioDeviceCollectionGetDefaultDevice
IAudioDeviceCollectionGetDevice
IAudioDeviceCollectionIsApplicationMute
IAudioDeviceCollectionRelease
IAudioDeviceCollectionSetApplicationMute
IAudioDeviceCollectionSetApplicationVolume
IAudioDeviceCollectionSetDevice
IAudioDeviceManagerEnumeratePlaybackDevices
IAudioDeviceManagerEnumerateRecordingDevices
IAudioDeviceManagerFollowSystemPlaybackDevice
IAudioDeviceManagerFollowSystemRecordingDevice
IAudioDeviceManagerGetPlaybackDevice
IAudioDeviceManagerGetPlaybackDeviceInfo
IAudioDeviceManagerGetPlaybackDeviceMute
IAudioDeviceManagerGetRecordingDevice
IAudioDeviceManagerGetRecordingDeviceInfo
IAudioDeviceManagerGetRecordingDeviceMute
IAudioDeviceManagerGetRecordingDeviceVolume
IAudioDeviceManagerRelease
IAudioDeviceManagerSetPlaybackDevice
IAudioDeviceManagerSetPlaybackDeviceMute
IAudioDeviceManagerSetPlaybackDeviceVolume
IAudioDeviceManagerSetRecordingDevice
IAudioDeviceManagerSetRecordingDeviceMute
IAudioDeviceManagerSetRecordingDeviceVolume
IAudioDeviceManagerStartAudioDeviceLoopbackTest
IAudioDeviceManagerStartPlaybackDeviceTest
IAudioDeviceManagerStartRecordingDeviceTest
IAudioDeviceManagerStopAudioDeviceLoopbackTest
IAudioDeviceManagerStopPlaybackDeviceTest
IAudioDeviceManagerStopRecordingDeviceTest
IMediaPlayerAdjustPlayoutVolume
IMediaPlayerAdjustPublishSignalVolume
IMediaPlayerGetDuration
IMediaPlayerGetMediaPlayerId
IMediaPlayerGetMute
IMediaPlayerGetPlayPosition
IMediaPlayerGetPlaySrc
IMediaPlayerGetPlayoutVolume
IMediaPlayerGetPublishSignalVolume
IMediaPlayerGetState
IMediaPlayerGetStreamCount
IMediaPlayerGetStreamInfo
IMediaPlayerMute
IMediaPlayerOpen
IMediaPlayerOpenWithMediaSource
IMediaPlayerPause
IMediaPlayerPlay
IMediaPlayerPlayPreloadedSrc
IMediaPlayerPreloadSrc
IMediaPlayerResume
IMediaPlayerSeek
IMediaPlayerSelectAudioTrack
IMediaPlayerSelectMultiAudioTrack
IMediaPlayerSetAudioDualMonoMode
IMediaPlayerSetAudioPitch
IMediaPlayerSetLoopCount
IMediaPlayerSetPlaybackSpeed
IMediaPlayerSetPlayerOptionWithInt
IMediaPlayerSetPlayerOptionWithString
IMediaPlayerSetRenderMode
IMediaPlayerSetView
IMediaPlayerStop
IMediaPlayerSwitchSrc
IMediaPlayerUnloadSrc
IRtcEngineAddVideoWatermark
IRtcEngineAdjustAudioMixingPlayoutVolume
IRtcEngineAdjustAudioMixingPublishVolume
IRtcEngineAdjustAudioMixingVolume
IRtcEngineAdjustLoopbackSignalVolume
IRtcEngineAdjustUserPlaybackSignalVolume
IRtcEngineClearVideoWatermarks
IRtcEngineComplain
IRtcEngineConfigRhythmPlayer
IRtcEngineCreateDataStream
IRtcEngineEnableContentInspect
IRtcEngineEnableEncryption
IRtcEngineEnableExtension
IRtcEngineEnableLoopbackRecording
IRtcEngineEnableMultiCamera
IRtcEngineEnableVideoImageSource
IRtcEngineEnableVoiceAITuner
IRtcEngineGetAgoraMediaPlayer
IRtcEngineGetAgoraRtcEngine
IRtcEngineGetAudioDeviceInfo
IRtcEngineGetAudioMixingCurrentPosition
IRtcEngineGetAudioMixingDuration
IRtcEngineGetAudioMixingPlayoutVolume
IRtcEngineGetAudioMixingPublishVolume
IRtcEngineGetAudioTrackCount
IRtcEngineGetCallId
IRtcEngineGetEffectCurrentPosition
IRtcEngineGetEffectDuration
IRtcEngineGetErrorDescription
IRtcEngineGetExtensionProperty
IRtcEngineGetFaceShapeAreaOptions
IRtcEngineGetFaceShapeBeautyOptions
IRtcEngineGetNtpWallTimeInMs
IRtcEngineGetScreenCaptureSources
IRtcEngineGetUserInfoByUid
IRtcEngineGetUserInfoByUserAccount
IRtcEngineGetVersion
IRtcEngineGetVolumeOfEffect
IRtcEngineJoinChannelWithOptions
IRtcEngineJoinChannelWithUserAccount
IRtcEngineLeaveChannelWithOptions
IRtcEngineLoadExtensionProvider
IRtcEngineMuteRemoteAudioStream
IRtcEngineMuteRemoteVideoStream
IRtcEnginePauseAllChannelMediaRelay
IRtcEnginePauseAllEffects
IRtcEnginePauseAudioMixing
IRtcEnginePauseEffect
IRtcEnginePlayAllEffects
IRtcEnginePlayEffect
IRtcEnginePreloadChannel
IRtcEnginePreloadChannelWithUserAccount
IRtcEnginePreloadEffect
IRtcEngineQueryCameraFocalLengthCapability
IRtcEngineQueryCodecCapability
IRtcEngineRate
IRtcEngineRegisterExtension
IRtcEngineRegisterLocalUserAccount
IRtcEngineRenewToken
IRtcEngineResumeAllChannelMediaRelay
IRtcEngineResumeAllEffects
IRtcEngineResumeAudioMixing
IRtcEngineResumeEffect
IRtcEngineSelectAudioTrack
IRtcEngineSendCustomReportMessage
IRtcEngineSendStreamMessage
IRtcEngineSetAVSyncSource
IRtcEngineSetAdvancedAudioOptions
IRtcEngineSetAudioMixingDualMonoMode
IRtcEngineSetAudioMixingPitch
IRtcEngineSetAudioMixingPlaybackSpeed
IRtcEngineSetAudioMixingPosition
IRtcEngineSetCameraCapturerConfiguration
IRtcEngineSetEffectPosition
IRtcEngineSetExtensionProperty
IRtcEngineSetExtensionProviderProperty
IRtcEngineSetFaceShapeAreaOptions
IRtcEngineSetFaceShapeBeautyOptions
IRtcEngineSetFilterEffectOptions
IRtcEngineSetLocalVoiceFormant
IRtcEngineSetLogFile
IRtcEngineSetLogFileSize
IRtcEngineSetParameters
IRtcEngineSetSubscribeAudioAllowlist
IRtcEngineSetSubscribeAudioBlocklist
IRtcEngineSetSubscribeVideoAllowlist
IRtcEngineSetSubscribeVideoBlocklist
IRtcEngineSetVideoEncoderConfiguration
IRtcEngineSetVolumeOfEffect
IRtcEngineSetupLocalVideo
IRtcEngineSetupRemoteVideo
IRtcEngineStartAudioMixing
IRtcEngineStartAudioRecording
IRtcEngineStartEchoTest
IRtcEngineStartLastmileProbeTest
IRtcEngineStartLocalVideoTranscoder
IRtcEngineStartMediaRenderingTracing
IRtcEngineStartOrUpdateChannelMediaRelay
IRtcEngineStartPreview
IRtcEngineStartRhythmPlayer
IRtcEngineStartRtmpStreamWithTranscoding
IRtcEngineStartRtmpStreamWithoutTranscoding
IRtcEngineStartScreenCapture
IRtcEngineStartScreenCaptureByDisplayId
IRtcEngineStartScreenCaptureByScreenRect
IRtcEngineStartScreenCaptureBySourceType
IRtcEngineStartScreenCaptureByWindowId
IRtcEngineStopAllEffects
IRtcEngineStopAudioMixing
IRtcEngineStopAudioRecording
IRtcEngineStopChannelMediaRelay
IRtcEngineStopEchoTest
IRtcEngineStopEffect
IRtcEngineStopLastmileProbeTest
IRtcEngineStopLocalVideoTranscoder
IRtcEngineStopPreview
IRtcEngineStopRhythmPlayer
IRtcEngineStopRtmpStream
IRtcEngineStopScreenCapture
IRtcEngineStopScreenCaptureBySourceType
IRtcEngineTakeSnapshot
IRtcEngineTakeSnapshotWithConfig
IRtcEngineUnloadAllEffects
IRtcEngineUnloadEffect
IRtcEngineUpdateChannelMediaOptions
IRtcEngineUpdateLocalTranscoderConfiguration
IRtcEngineUpdatePreloadChannelToken
IRtcEngineUpdateRtmpTranscoding
IRtcEngineUpdateScreenCapture
IRtcEngineUpdateScreenCaptureParameters
IRtcEngineUpdateScreenCaptureRegion
IRtcEngineExAddVideoWatermarkEx
IRtcEngineExAdjustUserPlaybackSignalVolumeEx
IRtcEngineExClearVideoWatermarkEx
IRtcEngineExCreateDataStreamEx
IRtcEngineExEnableAudioVolumeIndicationEx
IRtcEngineExEnableContentInspectEx
IRtcEngineExEnableDualStreamModeEx
IRtcEngineExEnableEncryptionEx
IRtcEngineExEnableLoopbackRecordingEx
IRtcEngineExGetCallIdEx
IRtcEngineExGetConnectionStateEx
IRtcEngineExJoinChannelEx
IRtcEngineExJoinChannelWithUserAccountEx
IRtcEngineExLeaveChannelEx
IRtcEngineExMuteAllRemoteAudioStreamsEx
IRtcEngineExMuteAllRemoteVideoStreamsEx
IRtcEngineExMuteLocalAudioStreamEx
IRtcEngineExMuteLocalVideoStreamEx
IRtcEngineExMuteRemoteAudioStreamEx
IRtcEngineExMuteRemoteVideoStreamEx
IRtcEngineExPauseAllChannelMediaRelayEx
IRtcEngineExResumeAllChannelMediaRelayEx
IRtcEngineExSendCustomReportMessageEx
IRtcEngineExSendStreamMessageEx
IRtcEngineExSetDualStreamModeEx
IRtcEngineExSetRemoteRenderModeEx
IRtcEngineExSetRemoteVideoStreamTypeEx
IRtcEngineExSetRemoteVoicePositionEx
IRtcEngineExSetSubscribeAudioAllowlistEx
IRtcEngineExSetSubscribeAudioBlocklistEx
IRtcEngineExSetSubscribeVideoAllowlistEx
IRtcEngineExSetSubscribeVideoBlocklistEx
IRtcEngineExSetVideoEncoderConfigurationEx
IRtcEngineExSetupRemoteVideoEx
IRtcEngineExStartMediaRenderingTracingEx
IRtcEngineExStartOrUpdateChannelMediaRelayEx
IRtcEngineExStartRtmpStreamWithTranscodingEx
IRtcEngineExStartRtmpStreamWithoutTranscodingEx
IRtcEngineExStopChannelMediaRelayEx
IRtcEngineExStopRtmpStreamEx
IRtcEngineExTakeSnapshotEx
IRtcEngineExTakeSnapshotWithConfigEx
IRtcEngineExUpdateChannelMediaOptionsEx
IRtcEngineExUpdateRtmpTranscodingEx
IScreenCaptureSourceListGetCount
IScreenCaptureSourceListGetSourceInfo
IScreenCaptureSourceListRelease
IVideoDeviceCollectionGetCount
IVideoDeviceCollectionGetDevice
IVideoDeviceCollectionRelease
IVideoDeviceCollectionSetDevice
IVideoDeviceManagerEnumerateVideoDevices
IVideoDeviceManagerGetCapability
IVideoDeviceManagerNumberOfCapabilities
IVideoDeviceManagerRelease
__unattributed__AddBlueprintCallbackExecutor
__unattributed__AddBlueprintCallbackExecutorEx
__unattributed__ClearAllEventHandlerCBExecutors
__unattributed__FollowSystemLoopbackDevice
__unattributed__GetAgoraAudioDeviceManager
__unattributed__GetAgoraVideoDeviceManager
__unattributed__GetEventHandler
__unattributed__GetLoopbackDevice
__unattributed__GetMediaPlayerSourceObserver
__unattributed__GetPlaybackDeviceVolume
__unattributed__JoinChannel
__unattributed__LeaveChannel
__unattributed__SetAudioProfile
__unattributed__SetLocalAccessPoint
__unattributed__SetLoopbackDevice
__unattributed__SetRouteInCommunicationMode

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

内容依据公开 API 定义.

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