nimeet Docs
中文

Unreal Blueprint SDK API Reference

Complete Unreal Blueprint public surface generated from the public SDK interface definition: classes, interfaces, enums, events, error identifiers and capability scope.

Generated from the public SDK interface definitions

Version v1.1.0 · Updated 2026-10-26 · revision 1

Interface overview

This page lists the public API of Unreal Engine(Blueprint): classes, methods, overloads, properties, events and error codes. The interface definition matches the SDK package version.

Checklist itemCount
Interface / class90
Method458
Method overloads458
Property435
Enums103
error-code constants6

Availability

This platform's SDK: Generally available. The interface definition matches the SDK package version; runtime capability follows the published SDK package.

Join channel flow

Arranged in the typical call order of join / leave / publish / subscribe; the parameter table is expanded under “Parameters of the minimal runnable flow”.

StepInterfaceMethodOverload count
Join a channel__unattributed__JoinChannel1
Leave a channel__unattributed__LeaveChannel1
enable video and previewIRtcEngineEnableVideo1
Create / initializeIRtcEngineInitialize1
subscribe to remote mediaIRtcEngineMuteRemoteAudioStream1
Renew the TokenIRtcEngineRenewToken1
Channel scenariosIRtcEngineSetChannelProfile1
role switchingIRtcEngineSetClientRole1
local videoIRtcEngineSetupLocalVideo1

parameters for the minimal runnable flow

ParametersTypeOptionalVariadic parameters
tokenconst FString&NoNo
channelIdconst FString&NoNo
uidint64NoNo
contextconst FRtcEngineContext&NoNo
uidint64NoNo
muteboolNoNo
tokenconst FString&NoNo
profileECHANNEL_PROFILE_TYPENoNo
optionsFClientRoleOptionsNoNo
clientroletypeECLIENT_ROLE_TYPEisNo
canvasconst FVideoCanvas&NoNo

Endpoint index

InterfaceMethodPropertyEvents
__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

all endpoints

__unattributed__ 16 method / 0 Property
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

Method detail: 16 / 16 (parameters, returns, errors)

MethodParametersReturnsErrors
AddBlueprintCallbackExecutorExecutor: UAgoraBPuIRtcEngineEventHandlerCBExecutor*voidError code index
AddBlueprintCallbackExecutorExExecutor: UAgoraBPuIRtcEngineEventHandlerExCBExecutor*voidError code index
ClearAllEventHandlerCBExecutors—voidError code index
FollowSystemLoopbackDeviceenable: boolintError code index
GetAgoraAudioDeviceManager—UAgoraBPuAudioDeviceManager*Error code index
GetAgoraVideoDeviceManager—UAgoraBPuVideoDeviceManager*Error code index
GetEventHandlerHandlerType: EAgoraBPuEventHandlerType&, EventHandler: UAgoraBPuIRtcEngineEventHandler*&, EventHandlerEx: UAgoraBPuIRtcEngineEventHandlerEx*&voidError code index
GetLoopbackDevicedeviceId: FString&intError code index
GetMediaPlayerSourceObserver—UAgoraBPuIMediaPlayerSourceObserver*Error code index
GetPlaybackDeviceVolumevolume: int&intError code index
JoinChanneltoken: const FString&, channelId: const FString&, uid: int64intError code index
LeaveChannel—intError code index
SetAudioProfileprofile?: EAUDIO_PROFILE_TYPEintError code index
SetLocalAccessPointconfig: const FLocalAccessPointConfiguration&intError code index
SetLoopbackDevicedeviceId: const FString&intError code index
SetRouteInCommunicationModeroute: intintError code index
FAdvancedAudioOptions 0 method / 1 Property
PropertyTyperead-only
audioProcessingChannelsunknownNo
FAdvancedConfigInfo 0 method / 1 Property
PropertyTyperead-only
logUploadServerunknownNo
FAgoraMediaSource 0 method / 8 Property
PropertyTyperead-only
urlunknownNo
uriunknownNo
startPosunknownNo
autoPlayunknownNo
enableCacheunknownNo
enableMultiAudioTrackunknownNo
isAgoraSourceunknownNo
isLiveSourceunknownNo
FAgoraRhythmPlayerConfig 0 method / 2 Property
PropertyTyperead-only
beatsPerMeasureunknownNo
beatsPerMinuteunknownNo
FAudioRecordingConfiguration 0 method / 6 Property
PropertyTyperead-only
filePathunknownNo
encodeunknownNo
sampleRateunknownNo
fileRecordingTypeunknownNo
qualityunknownNo
recordingChannelunknownNo
FAudioVolumeInfo 0 method / 4 Property
PropertyTyperead-only
uidunknownNo
volumeunknownNo
vadunknownNo
voicePitchunknownNo
FBeautyOptions 0 method / 5 Property
PropertyTyperead-only
lighteningContrastLevelunknownNo
lighteningLevelunknownNo
smoothnessLevelunknownNo
rednessLevelunknownNo
sharpnessLevelunknownNo
FCacheStatistics 0 method / 3 Property
PropertyTyperead-only
fileSizeunknownNo
cacheSizeunknownNo
downloadSizeunknownNo
FCameraCapturerConfiguration 0 method / 6 Property
PropertyTyperead-only
cameraDirectionunknownNo
cameraIdunknownNo
cameraFocalLengthTypeunknownNo
formatunknownNo
deviceIdunknownNo
followEncodeDimensionRatiounknownNo
FChannelMediaInfo 0 method / 3 Property
PropertyTyperead-only
channelNameunknownNo
tokenunknownNo
uidunknownNo
FChannelMediaOptions 0 method / 29 Property
PropertyTyperead-only
publishCameraTrackunknownNo
publishSecondaryCameraTrackunknownNo
publishMicrophoneTrackunknownNo
publishThirdCameraTrackunknownNo
publishFourthCameraTrackunknownNo
publishScreenTrackunknownNo
publishScreenCaptureVideounknownNo
publishScreenCaptureAudiounknownNo
publishSecondaryScreenTrackunknownNo
publishThirdScreenTrackunknownNo
publishFourthScreenTrackunknownNo
publishTranscodedVideoTrackunknownNo
publishMixedAudioTrackunknownNo
publishEncodedVideoTrackunknownNo
publishMediaPlayerAudioTrackunknownNo
publishMediaPlayerVideoTrackunknownNo
autoSubscribeAudiounknownNo
autoSubscribeVideounknownNo
enableAudioRecordingOrPlayoutunknownNo
publishMediaPlayerIdunknownNo
clientRoleTypeunknownNo
audienceLatencyLevelunknownNo
defaultVideoStreamTypeunknownNo
channelProfileunknownNo
audioDelayMsunknownNo
tokenunknownNo
publishRhythmPlayerTrackunknownNo
isInteractiveAudienceunknownNo
isAudioFilterableunknownNo
FChannelMediaRelayConfiguration 0 method / 3 Property
PropertyTyperead-only
srcInfounknownNo
destInfosunknownNo
destCountunknownNo
FClientRoleOptions 0 method / 1 Property
PropertyTyperead-only
audienceLatencyLevelunknownNo
FCodecCapInfo 0 method / 3 Property
PropertyTyperead-only
codecTypeunknownNo
codecCapMaskunknownNo
codecLevelsunknownNo
FCodecCapLevels 0 method / 2 Property
PropertyTyperead-only
hwDecodingLevelunknownNo
swDecodingLevelunknownNo
FColorEnhanceOptions 0 method / 2 Property
PropertyTyperead-only
strengthLevelunknownNo
skinProtectLevelunknownNo
FContentInspectConfig 0 method / 4 Property
PropertyTyperead-only
extraInfounknownNo
serverConfigunknownNo
modulesunknownNo
moduleCountunknownNo
FContentInspectModule 0 method / 2 Property
PropertyTyperead-only
typeunknownNo
intervalunknownNo
FDataStreamConfig 0 method / 2 Property
PropertyTyperead-only
syncWithAudiounknownNo
orderedunknownNo
FDeviceInfo 0 method / 1 Property
PropertyTyperead-only
isLowLatencyAudioSupportedunknownNo
FDirectCdnStreamingStats 0 method / 5 Property
PropertyTyperead-only
videoWidthunknownNo
videoHeightunknownNo
fpsunknownNo
videoBitrateunknownNo
audioBitrateunknownNo
FEchoTestConfiguration 0 method / 6 Property
PropertyTyperead-only
viewunknownNo
enableAudiounknownNo
enableVideounknownNo
tokenunknownNo
channelIdunknownNo
intervalInSecondsunknownNo
FEncryptionConfig 0 method / 4 Property
PropertyTyperead-only
encryptionModeunknownNo
encryptionKeyunknownNo
encryptionKdfSaltunknownNo
datastreamEncryptionEnabledunknownNo
FExtensionContext 0 method / 4 Property
PropertyTyperead-only
isValidunknownNo
uidunknownNo
providerNameunknownNo
extensionNameunknownNo
FFocalLengthInfo 0 method / 2 Property
PropertyTyperead-only
cameraDirectionunknownNo
focalLengthTypeunknownNo
FImageTrackOptions 0 method / 2 Property
PropertyTyperead-only
imageUrlunknownNo
fpsunknownNo
FLastmileProbeConfig 0 method / 4 Property
PropertyTyperead-only
probeUplinkunknownNo
probeDownlinkunknownNo
expectedUplinkBitrateunknownNo
expectedDownlinkBitrateunknownNo
FLastmileProbeOneWayResult 0 method / 3 Property
PropertyTyperead-only
packetLossRateunknownNo
jitterunknownNo
availableBandwidthunknownNo
FLastmileProbeResult 0 method / 4 Property
PropertyTyperead-only
stateunknownNo
uplinkReportunknownNo
downlinkReportunknownNo
rttunknownNo
FLeaveChannelOptions 0 method / 3 Property
PropertyTyperead-only
stopAudioMixingunknownNo
stopAllEffectunknownNo
stopMicrophoneRecordingunknownNo
FLiveStreamAdvancedFeature 0 method / 2 Property
PropertyTyperead-only
featureNameunknownNo
openedunknownNo
FLiveTranscoding 0 method / 23 Property
PropertyTyperead-only
widthunknownNo
heightunknownNo
videoBitrateunknownNo
videoFrameRateunknownNo
lowLatencyunknownNo
videoGopunknownNo
videoCodecProfileunknownNo
videoCodecTypeunknownNo
transcodingUsersunknownNo
transcodingExtraInfounknownNo
backgroundColorunknownNo
userCountunknownNo
metadataunknownNo
watermarkunknownNo
backgroundImageunknownNo
audioSampleRateunknownNo
audioBitrateunknownNo
audioChannelsunknownNo
audioCodecProfileunknownNo
watermarkCountunknownNo
backgroundImageCountunknownNo
advancedFeaturesunknownNo
advancedFeatureCountunknownNo
FLocalAccessPointConfiguration 0 method / 7 Property
PropertyTyperead-only
ipListunknownNo
ipListSizeunknownNo
domainListunknownNo
domainListSizeunknownNo
verifyDomainNameunknownNo
modeunknownNo
advancedConfigunknownNo
FLocalAudioStats 0 method / 8 Property
PropertyTyperead-only
numChannelsunknownNo
sentSampleRateunknownNo
sentBitrateunknownNo
txPacketLossRateunknownNo
internalCodecunknownNo
audioDeviceDelayunknownNo
earMonitorDelayunknownNo
aecEstimatedDelayunknownNo
FLocalTranscoderConfiguration 0 method / 3 Property
PropertyTyperead-only
streamCountunknownNo
videoInputStreamsunknownNo
videoOutputConfigurationunknownNo
FLocalVideoStats 0 method / 22 Property
PropertyTyperead-only
uidunknownNo
sentBitrateunknownNo
sentFrameRateunknownNo
captureFrameRateunknownNo
captureFrameWidthunknownNo
captureFrameHeightunknownNo
regulatedCaptureFrameRateunknownNo
regulatedCaptureFrameWidthunknownNo
regulatedCaptureFrameHeightunknownNo
encoderOutputFrameRateunknownNo
rendererOutputFrameRateunknownNo
targetBitrateunknownNo
targetFrameRateunknownNo
qualityAdaptIndicationunknownNo
encodedBitrateintNo
encodedFrameHeightunknownNo
encodedFrameWidthunknownNo
encodedFrameCountunknownNo
codecTypeunknownNo
txPacketLossRateunknownNo
captureBrightnessLevelunknownNo
hwEncoderAcceleratingunknownNo
FLogConfig 0 method / 3 Property
PropertyTyperead-only
filePathunknownNo
fileSizeInKBunknownNo
levelunknownNo
FLogUploadServerInfo 0 method / 4 Property
PropertyTyperead-only
serverDomainunknownNo
serverPathunknownNo
serverPortunknownNo
serverHttpsunknownNo
FPlayerPlaybackStats 0 method / 4 Property
PropertyTyperead-only
videoFpsunknownNo
videoBitrateInKbpsunknownNo
audioBitrateInKbpsunknownNo
totalBitrateInKbpsunknownNo
FPlayerStreamInfo 0 method / 13 Property
PropertyTyperead-only
streamIndexunknownNo
streamTypeunknownNo
codecNameunknownNo
languageunknownNo
videoFrameRateunknownNo
videoBitRateunknownNo
videoWidthunknownNo
videoHeightunknownNo
videoRotationunknownNo
audioSampleRateunknownNo
audioChannelsunknownNo
audioBitsPerSampleunknownNo
durationunknownNo
FPlayerUpdatedInfo 0 method / 6 Property
PropertyTyperead-only
deviceIdunknownNo
videoHeightunknownNo
videoWidthunknownNo
audioSampleRateunknownNo
audioChannelsunknownNo
audioBitsPerSampleunknownNo
FRectangle 0 method / 4 Property
PropertyTyperead-only
xunknownNo
yunknownNo
widthunknownNo
heightunknownNo
FRemoteAudioStats 0 method / 16 Property
PropertyTyperead-only
uidunknownNo
qualityunknownNo
networkTransportDelayunknownNo
jitterBufferDelayunknownNo
audioLossRateunknownNo
numChannelsunknownNo
receivedSampleRateunknownNo
receivedBitrateunknownNo
totalFrozenTimeunknownNo
frozenRateunknownNo
totalActiveTimeunknownNo
publishDurationunknownNo
qoeQualityunknownNo
qualityChangedReasonunknownNo
mosValueunknownNo
e2eDelayunknownNo
FRemoteVideoStats 0 method / 16 Property
PropertyTyperead-only
uidunknownNo
delayunknownNo
e2eDelayunknownNo
widthunknownNo
heightunknownNo
receivedBitrateunknownNo
decoderOutputFrameRateunknownNo
rendererOutputFrameRateunknownNo
frameLossRateunknownNo
packetLossRateunknownNo
rxStreamTypeunknownNo
totalFrozenTimeunknownNo
frozenRateunknownNo
totalActiveTimeunknownNo
publishDurationunknownNo
avSyncTimeMsunknownNo
FRtcEngineContext 0 method / 8 Property
PropertyTyperead-only
eventHandlerunknownNo
appIdunknownNo
channelProfileunknownNo
audioScenariounknownNo
areaCodeunknownNo
logConfigunknownNo
domainLimitunknownNo
autoRegisterAgoraExtensionsunknownNo
FRtcImage 0 method / 7 Property
PropertyTyperead-only
urlunknownNo
xunknownNo
yunknownNo
widthunknownNo
heightunknownNo
zOrderunknownNo
alphaunknownNo
FRtcStats 0 method / 24 Property
PropertyTyperead-only
durationunknownNo
txBytesunknownNo
rxBytesunknownNo
txAudioBytesunknownNo
txVideoBytesunknownNo
rxAudioBytesunknownNo
rxVideoBytesunknownNo
txKBitRateunknownNo
rxKBitRateunknownNo
rxAudioKBitRateunknownNo
txAudioKBitRateunknownNo
rxVideoKBitRateunknownNo
txVideoKBitRateunknownNo
lastmileDelayunknownNo
txPacketLossRateunknownNo
rxPacketLossRateunknownNo
userCountunknownNo
cpuAppUsageunknownNo
cpuTotalUsageunknownNo
connectTimeMsunknownNo
gatewayRttunknownNo
memoryAppUsageRatiounknownNo
memoryTotalUsageRatiounknownNo
memoryAppUsageInKbytesunknownNo
FScreenAudioParameters 0 method / 3 Property
PropertyTyperead-only
sampleRateunknownNo
channelsunknownNo
captureSignalVolumeunknownNo
FScreenCaptureConfiguration 0 method / 6 Property
PropertyTyperead-only
isCaptureWindowunknownNo
displayIdunknownNo
screenRectunknownNo
windowIdunknownNo
paramsunknownNo
regionRectunknownNo
FScreenCaptureParameters 0 method / 10 Property
PropertyTyperead-only
dimensionsunknownNo
frameRateunknownNo
bitrateunknownNo
captureMouseCursorunknownNo
windowFocusunknownNo
excludeWindowListunknownNo
enableHighLightunknownNo
highLightColorunknownNo
highLightWidthunknownNo
excludeWindowCountunknownNo
FScreenCaptureParameters2 0 method / 4 Property
PropertyTyperead-only
captureAudiounknownNo
audioParamsunknownNo
captureVideounknownNo
videoParamsunknownNo
FScreenCaptureSourceInfo 0 method / 11 Property
PropertyTyperead-only
typeunknownNo
sourceIdunknownNo
sourceNameunknownNo
thumbImageunknownNo
iconImageunknownNo
processPathunknownNo
sourceTitleunknownNo
primaryMonitorunknownNo
positionunknownNo
minimizeWindowunknownNo
sourceDisplayIdunknownNo
FScreenVideoParameters 0 method / 4 Property
PropertyTyperead-only
dimensionsunknownNo
frameRateunknownNo
bitrateunknownNo
contentHintunknownNo
FSegmentationProperty 0 method / 2 Property
PropertyTyperead-only
modelTypeunknownNo
greenCapacityunknownNo
FSimulcastStreamConfig 0 method / 3 Property
PropertyTyperead-only
dimensionsunknownNo
kBitrateunknownNo
framerateunknownNo
FSrcInfo 0 method / 2 Property
PropertyTyperead-only
bitrateInKbpsunknownNo
nameunknownNo
FThumbImageBuffer 0 method / 4 Property
PropertyTyperead-only
bufferiNo
lengthunknownNo
widthunknownNo
heightunknownNo
FTranscodingUser 0 method / 8 Property
PropertyTyperead-only
uidunknownNo
xunknownNo
yunknownNo
widthunknownNo
heightunknownNo
zOrderunknownNo
alphaunknownNo
audioChannelunknownNo
FTranscodingVideoStream 0 method / 11 Property
PropertyTyperead-only
sourceTypeunknownNo
remoteUserUidunknownNo
imageUrlunknownNo
mediaPlayerIdunknownNo
xunknownNo
yunknownNo
widthunknownNo
heightunknownNo
zOrderunknownNo
alphaunknownNo
mirrorunknownNo
FUABT_AdvanceOptions 0 method / 3 Property
PropertyTyperead-only
encodingPreferenceunknownNo
compressionPreferenceunknownNo
encodeAlphaunknownNo
FUABT_FaceShapeAreaOptions 0 method / 2 Property
PropertyTyperead-only
shapeAreaunknownNo
shapeIntensityunknownNo
FUABT_FaceShapeBeautyOptions 0 method / 2 Property
PropertyTyperead-only
shapeStyleunknownNo
styleIntensityunknownNo
FUABT_FilterEffectOptions 1 method / 1 Property
typescript
path(): unknown

Method detail: 1 / 1 (parameters, returns, errors)

MethodParametersReturnsErrors
path—unknownError code index
PropertyTyperead-only
strengthunknownNo
FUABT_LowlightEnhanceOptions 0 method / 2 Property
PropertyTyperead-only
levelunknownNo
modeunknownNo
FUABT_RtcConnection 0 method / 2 Property
PropertyTyperead-only
channelIdunknownNo
localUidunknownNo
FUABT_SnapshotConfig 0 method / 2 Property
PropertyTyperead-only
filePathunknownNo
positionunknownNo
FUABT_VideoDenoiserOptions 0 method / 2 Property
PropertyTyperead-only
levelunknownNo
modeunknownNo
FUABT_VideoDimensions 0 method / 2 Property
PropertyTyperead-only
widthunknownNo
heightunknownNo
FUABT_VideoEncoderConfiguration 0 method / 9 Property
PropertyTyperead-only
dimensionsunknownNo
codecTypeunknownNo
frameRateunknownNo
bitrateunknownNo
minBitrateunknownNo
orientationModeunknownNo
degradationPreferenceunknownNo
mirrorModeunknownNo
advanceOptionsunknownNo
FUplinkNetworkInfo 0 method / 1 Property
PropertyTyperead-only
video_encoder_target_bitrate_bpsunknownNo
FUserInfo 0 method / 2 Property
PropertyTyperead-only
uidunknownNo
userAccountunknownNo
FVideoCanvas 1 method / 10 Property
typescript
view(): unknown

Method detail: 1 / 1 (parameters, returns, errors)

MethodParametersReturnsErrors
view—unknownError code index
PropertyTyperead-only
uidunknownNo
subviewUidunknownNo
renderModeunknownNo
mirrorModeunknownNo
sourceTypeunknownNo
setupModeunknownNo
cropAreaunknownNo
backgroundColorunknownNo
enableAlphaMaskunknownNo
positionunknownNo
FVideoFormat 0 method / 3 Property
PropertyTyperead-only
widthunknownNo
heightunknownNo
fpsunknownNo
FVideoLayout 0 method / 8 Property
PropertyTyperead-only
channelIdunknownNo
uidunknownNo
strUidunknownNo
xunknownNo
yunknownNo
widthunknownNo
heightunknownNo
videoStateunknownNo
FVideoRenderingTracingInfo 0 method / 7 Property
PropertyTyperead-only
elapsedTimeunknownNo
start2JoinChannelunknownNo
join2JoinSuccessunknownNo
joinSuccess2RemoteJoinedunknownNo
remoteJoined2SetViewunknownNo
remoteJoined2UnmuteVideounknownNo
remoteJoined2PacketReceivedunknownNo
FVideoSubscriptionOptions 0 method / 2 Property
PropertyTyperead-only
typeunknownNo
encodedFrameOnlyunknownNo
FVirtualBackgroundSource 0 method / 4 Property
PropertyTyperead-only
background_source_typeunknownNo
colorunknownNo
sourceunknownNo
blur_degreeunknownNo
FWatermarkOptions 0 method / 5 Property
PropertyTyperead-only
visibleInPreviewunknownNo
positionInLandscapeModeunknownNo
positionInPortraitModeunknownNo
watermarkRatiounknownNo
modeunknownNo
FWatermarkRatio 0 method / 3 Property
PropertyTyperead-only
xRatiounknownNo
yRatiounknownNo
widthRatiounknownNo
IAudioDeviceCollection 9 method / 0 Property
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

Method detail: 9 / 9 (parameters, returns, errors)

MethodParametersReturnsErrors
GetApplicationVolumevolume: int&intError code index
GetCount—intError code index
GetDefaultDevicedeviceName: FString&, deviceId: FString&intError code index
GetDeviceindex: int, deviceName: FString&, deviceId: FString&intError code index
IsApplicationMutemute: boolintError code index
Release—voidError code index
SetApplicationMutemute: boolintError code index
SetApplicationVolumevolume: intintError code index
SetDevicedeviceId: const FString&intError code index
IAudioDeviceManager 24 method / 0 Property
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

Method detail: 24 / 24 (parameters, returns, errors)

MethodParametersReturnsErrors
EnumeratePlaybackDevices—UAudioDeviceCollection*Error code index
EnumerateRecordingDevices—UAudioDeviceCollection*Error code index
FollowSystemPlaybackDeviceenable: boolintError code index
FollowSystemRecordingDeviceenable: boolintError code index
GetPlaybackDevicedeviceId: FString&intError code index
GetPlaybackDeviceInfodeviceId: FString&, deviceName: FString&, deviceTypeName: FString&intError code index
GetPlaybackDeviceMutemute: bool&intError code index
GetRecordingDevicedeviceId: FString&intError code index
GetRecordingDeviceInfodeviceId: FString&, deviceName: FString&, deviceTypeName: FString&intError code index
GetRecordingDeviceMutemute: bool&intError code index
GetRecordingDeviceVolumevolume: int&intError code index
Release—voidError code index
SetPlaybackDevicedeviceId: const FString&intError code index
SetPlaybackDeviceMutemute: boolintError code index
SetPlaybackDeviceVolumevolume: intintError code index
SetRecordingDevicedeviceId: const FString&intError code index
SetRecordingDeviceMutemute: boolintError code index
SetRecordingDeviceVolumevolume: intintError code index
StartAudioDeviceLoopbackTestindicationInterval: intintError code index
StartPlaybackDeviceTesttestAudioFilePath: const FString&intError code index
StartRecordingDeviceTestindicationInterval: intintError code index
StopAudioDeviceLoopbackTest—intError code index
StopPlaybackDeviceTest—intError code index
StopRecordingDeviceTest—intError code index
IMediaPlayer 34 method / 0 Property
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

Method detail: 34 / 34 (parameters, returns, errors)

MethodParametersReturnsErrors
AdjustPlayoutVolumevolume: intintError code index
AdjustPublishSignalVolumevolume: intintError code index
GetDurationduration: int64&intError code index
GetMediaPlayerId—intError code index
GetMutemuted: bool&intError code index
GetPlayPositionpos: int64&intError code index
GetPlaySrc—FStringError code index
GetPlayoutVolumevolume: int&intError code index
GetPublishSignalVolumevolume: int&intError code index
GetState—EMEDIA_PLAYER_STATEError code index
GetStreamCountcount: int64&intError code index
GetStreamInfoindex: int64, info: FPlayerStreamInfo&intError code index
Mutemuted: boolintError code index
Openurl: const FString&, startPos: int64intError code index
OpenWithMediaSourcesource: const FAgoraMediaSource&intError code index
Pause—intError code index
Play—intError code index
PlayPreloadedSrcsrc: const FString&intError code index
PreloadSrcsrc: const FString&, startPos: int64intError code index
Resume—intError code index
SeeknewPos: int64intError code index
SelectAudioTrackindex: intintError code index
SelectMultiAudioTrackplayoutTrackIndex: int, publishTrackIndex: intintError code index
SetAudioDualMonoModemode: EAUDIO_DUAL_MONO_MODEintError code index
SetAudioPitchpitch: intintError code index
SetLoopCountloopCount: intintError code index
SetPlaybackSpeedspeed: intintError code index
SetPlayerOptionWithIntkey: const FString&, value: intintError code index
SetPlayerOptionWithStringkey: const FString&, value: const FString&intError code index
SetRenderModerenderMode: ERENDER_MODE_TYPEintError code index
SetViewview: int64intError code index
Stop—intError code index
SwitchSrcsrc: const FString&, syncPts?: boolintError code index
UnloadSrcsrc: const FString&intError code index
IMediaPlayerSourceObserver 11 method / 0 Property
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

Method detail: 11 / 11 (parameters, returns, errors)

MethodParametersReturnsErrors
OnAudioVolumeIndicationvolume: intvoidError code index
OnMetaDataData: const FString&voidError code index
OnPlayBufferUpdatedplayCachedBuffer: int64voidError code index
OnPlayerCacheStatsstats: const FCacheStatistics&voidError code index
OnPlayerEventeventCode: EMEDIA_PLAYER_EVENT, elapsedTime: int64, message: const FString&voidError code index
OnPlayerInfoUpdatedinfo: const FPlayerUpdatedInfo&voidError code index
OnPlayerPlaybackStatsstats: const FPlayerPlaybackStats&voidError code index
OnPlayerSourceStateChangedstate: EMEDIA_PLAYER_STATE, ec: FENUMWRAP_MEDIA_PLAYER_REASONvoidError code index
OnPlayerSrcInfoChangedfrom: const FSrcInfo&, to: const FSrcInfo&voidError code index
OnPositionChangedposition_ms: int64, timestampMs: int64voidError code index
OnPreloadEventsrc: const FString&, event: EPLAYER_PRELOAD_EVENTvoidError code index
IRtcEngine 224 method / 0 Property
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

Method detail: 224 / 224 (parameters, returns, errors)

MethodParametersReturnsErrors
AddVideoWatermarkwatermarkUrl: const FString&, options: const FWatermarkOptions&intError code index
AdjustAudioMixingPlayoutVolumevolume: intintError code index
AdjustAudioMixingPublishVolumevolume: intintError code index
AdjustAudioMixingVolumevolume: intintError code index
AdjustLoopbackSignalVolumevolume: intintError code index
AdjustPlaybackSignalVolumevolume: intintError code index
AdjustRecordingSignalVolumevolume: intintError code index
AdjustUserPlaybackSignalVolumeuid: int64, volume: intintError code index
ClearVideoWatermarks—intError code index
ComplaincallId: const FString&, description: const FString&intError code index
ConfigRhythmPlayerconfig: const FAgoraRhythmPlayerConfig&intError code index
CreateDataStreamstreamId: int&, config: const FDataStreamConfig&intError code index
DisableAudio—intError code index
DisableVideo—intError code index
EnableAudio—intError code index
EnableAudioVolumeIndicationinterval: int, smooth: int, reportVad: boolintError code index
EnableCameraCenterStageenabled: boolintError code index
EnableContentInspectenabled: bool, config: const FContentInspectConfig&intError code index
EnableDualStreamModeenabled: bool, streamConfig: const FSimulcastStreamConfig&intError code index
EnableEncryptionenabled: bool, config: const FEncryptionConfig&intError code index
EnableExtensionprovider: const FString&, extension: const FString&, enable?: bool, type?: EMEDIA_SOURCE_TYPEintError code index
EnableFaceDetectionenabled: boolintError code index
EnableInEarMonitoringenabled: bool, includeAudioFilters: intintError code index
EnableInstantMediaRendering—intError code index
EnableLocalAudioenabled: boolintError code index
EnableLocalVideoenabled: boolintError code index
EnableLoopbackRecordingenabled: bool, deviceName: const FString&intError code index
EnableMultiCameraenabled: bool, config: const FCameraCapturerConfiguration&intError code index
EnableSoundPositionIndicationenabled: boolintError code index
EnableVideo—intError code index
EnableVideoImageSourceenable: bool, options: const FImageTrackOptions&intError code index
EnableVirtualBackgroundenabled: bool, backgroundSource: FVirtualBackgroundSource, segproperty: FSegmentationProperty, type: EMEDIA_SOURCE_TYPEintError code index
EnableVoiceAITunerenabled: bool, type: EVOICE_AI_TUNER_TYPEintError code index
EnableWebSdkInteroperabilityenabled: boolintError code index
GetAgoraMediaPlayer—UAgoraBPuMediaPlayer*Error code index
GetAgoraRtcEngine—UAgoraBPuRtcEngine*Error code index
GetAudioDeviceInfodeviceInfo: FDeviceInfo&intError code index
GetAudioMixingCurrentPosition—intError code index
GetAudioMixingDuration—intError code index
GetAudioMixingPlayoutVolume—intError code index
GetAudioMixingPublishVolume—intError code index
GetAudioTrackCount—intError code index
GetCallIdcallId: FString&intError code index
GetCameraMaxZoomFactor—floatError code index
GetConnectionState—ECONNECTION_STATE_TYPEError code index
GetEffectCurrentPositionsoundId: intintError code index
GetEffectDurationfilePath: const FString&intError code index
GetEffectsVolume—intError code index
GetErrorDescriptioncode: intFStringError code index
GetExtensionPropertyprovider: const FString&, extension: const FString&, ExtensionInfo: const FExtensionInfo&, key: const FString&, value: FString&intError code index
GetFaceShapeAreaOptionsshapeArea: EUABT_FACE_SHAPE_AREA, options: FUABT_FaceShapeAreaOptions&, type?: EUABT_MEDIA_SOURCE_TYPEintError code index
GetFaceShapeBeautyOptionsoptions: FUABT_FaceShapeBeautyOptions&, type?: EUABT_MEDIA_SOURCE_TYPEintError code index
GetNetworkType—intError code index
GetNtpWallTimeInMs—FStringError code index
GetScreenCaptureSourcesthumbSize: const FSIZE&, iconSize: const FSIZE&, includeScreen: boolUIScreenCaptureSourceList*Error code index
GetUserInfoByUiduid: int64, userInfo: FUserInfo&intError code index
GetUserInfoByUserAccountuserAccount: const FString&, userInfo: FUserInfo&intError code index
GetVersion—FStringError code index
GetVolumeOfEffectsoundId: intintError code index
Initializecontext: const FRtcEngineContext&intError code index
IsCameraAutoExposureFaceModeSupported—boolError code index
IsCameraAutoFocusFaceModeSupported—boolError code index
IsCameraCenterStageSupported—boolError code index
IsCameraExposurePositionSupported—boolError code index
IsCameraExposureSupported—boolError code index
IsCameraFaceDetectSupported—boolError code index
IsCameraFocusSupported—boolError code index
IsCameraTorchSupported—boolError code index
IsCameraZoomSupported—boolError code index
IsFeatureAvailableOnDevicetype: EFeatureTypeboolError code index
IsSpeakerphoneEnabled—boolError code index
JoinChannelWithOptionstoken: const FString&, channelId: const FString&, uid: int64, options: const FChannelMediaOptions&intError code index
JoinChannelWithUserAccounttoken: const FString&, channelId: const FString&, userAccount: const FString&, options: const FChannelMediaOptions&intError code index
LeaveChannelWithOptionsoptions: const FLeaveChannelOptions&intError code index
LoadExtensionProviderpath: const FString&, unload_after_use: boolintError code index
MuteAllRemoteAudioStreamsmute: boolintError code index
MuteAllRemoteVideoStreamsmute: boolintError code index
MuteLocalAudioStreammute: boolintError code index
MuteLocalVideoStreammute: boolintError code index
MuteRecordingSignalmute: boolintError code index
MuteRemoteAudioStreamuid: int64, mute: boolintError code index
MuteRemoteVideoStreamuid: int64, mute: boolintError code index
PauseAllChannelMediaRelay—intError code index
PauseAllEffects—intError code index
PauseAudioMixing—intError code index
PauseEffectsoundId: intintError code index
PlayAllEffectsloopCount: int, pitch: float, pan: float, gain: int, publish: boolintError code index
PlayEffectsoundId: int, filePath: const FString&, loopCount: int, pitch: float, pan: float, gain: int, publish: bool, startPos: intintError code index
PreloadChanneltoken: const FString&, channelId: const FString&, uid: int64intError code index
PreloadChannelWithUserAccounttoken: const FString&, channelId: const FString&, userAccount: const FString&intError code index
PreloadEffectsoundId: int, filePath: const FString&, startPos: intintError code index
QueryCameraFocalLengthCapabilityfocalLengthInfos: const TArray&intError code index
QueryCodecCapabilitycodecInfo: TArray&, QuerySize?: intintError code index
QueryDeviceScore—intError code index
QueryScreenCaptureCapability—intError code index
RatecallId: const FString&, rating: int, description: const FString&intError code index
RegisterExtensionprovider: const FString&, extension: const FString&, type: EMEDIA_SOURCE_TYPEintError code index
RegisterLocalUserAccountappId: const FString&, userAccount: const FString&intError code index
Releasesync?: boolvoidError code index
RenewTokentoken: const FString&intError code index
ResumeAllChannelMediaRelay—intError code index
ResumeAllEffects—intError code index
ResumeAudioMixing—intError code index
ResumeEffectsoundId: intintError code index
SelectAudioTrackindex: intintError code index
SendCustomReportMessageid: const FString&, category: const FString&, event: const FString&, label: const FString&, value: intintError code index
SendStreamMessagestreamId: int, data: const FString&intError code index
SetAINSModeenabled: bool, mode: EAUDIO_AINS_MODEintError code index
SetAVSyncSourcechannelId: const FString&, uid: int64intError code index
SetAdvancedAudioOptionsoptions: const FAdvancedAudioOptions&intError code index
SetAudioEffectParameterspreset: FENUMWRAP_AUDIO_EFFECT_PRESET, param1: int, param2: intintError code index
SetAudioEffectPresetpreset: FENUMWRAP_AUDIO_EFFECT_PRESETintError code index
SetAudioMixingDualMonoModemode: EAUDIO_MIXING_DUAL_MONO_MODEintError code index
SetAudioMixingPitchpitch: intintError code index
SetAudioMixingPlaybackSpeedspeed: intintError code index
SetAudioMixingPositionpos: intintError code index
SetAudioProfileAndScenarioprofile?: EAUDIO_PROFILE_TYPE, scenario?: EAUDIO_SCENARIO_TYPEintError code index
SetAudioScenarioscenario?: EAUDIO_SCENARIO_TYPEintError code index
SetAudioSessionOperationRestrictionrestriction: EAUDIO_SESSION_OPERATION_RESTRICTIONintError code index
SetBeautyEffectOptionsenabled: bool, options: const FBeautyOptions&, type: EMEDIA_SOURCE_TYPEintError code index
SetCameraAutoExposureFaceModeEnabledenabled: boolintError code index
SetCameraAutoFocusFaceModeEnabledenabled: boolintError code index
SetCameraCapturerConfigurationconfig: const FCameraCapturerConfiguration&intError code index
SetCameraDeviceOrientationtype: EVIDEO_SOURCE_TYPE, orientation: FENUMWRAP_VIDEO_ORIENTATIONintError code index
SetCameraExposureFactorfactor: floatintError code index
SetCameraExposurePositionpositionXinView: float, positionYinView: floatintError code index
SetCameraFocusPositionInPreviewpositionX: float, positionY: floatintError code index
SetCameraStabilizationModemode: FENUMWRAP_CAMERA_STABILIZATION_MODEintError code index
SetCameraTorchOnisOn: boolintError code index
SetCameraZoomFactorfactor: floatintError code index
SetChannelProfileprofile: ECHANNEL_PROFILE_TYPEintError code index
SetClientRoleoptions: FClientRoleOptions, clientroletype?: ECLIENT_ROLE_TYPEintError code index
SetCloudProxyproxyType: ECLOUD_PROXY_TYPEintError code index
SetColorEnhanceOptionsenabled: bool, options: const FColorEnhanceOptions&, type: EMEDIA_SOURCE_TYPEintError code index
SetDefaultAudioRouteToSpeakerphonedefaultToSpeaker: boolintError code index
SetDualStreamModemode: FENUMWRAP_SIMULCAST_STREAM_MODE, streamConfig: const FSimulcastStreamConfig&intError code index
SetEffectPositionsoundId: int, pos: intintError code index
SetEffectsVolumevolume: intintError code index
SetEnableSpeakerphonespeakerOn: boolintError code index
SetExtensionPropertyprovider: const FString&, extension: const FString&, key: const FString&, value: const FString&, type?: EMEDIA_SOURCE_TYPEintError code index
SetExtensionProviderPropertyprovider: const FString&, key: const FString&, value: const FString&intError code index
SetFaceShapeAreaOptionsoptions: const FUABT_FaceShapeAreaOptions&, type?: EUABT_MEDIA_SOURCE_TYPEintError code index
SetFaceShapeBeautyOptionsenabled: bool, options: const FUABT_FaceShapeBeautyOptions&, type?: EUABT_MEDIA_SOURCE_TYPEintError code index
SetFilterEffectOptionsenabled: bool, options: const FUABT_FilterEffectOptions&, type?: EUABT_MEDIA_SOURCE_TYPEintError code index
SetHeadphoneEQParameterslowGain: int, highGain: intintError code index
SetHeadphoneEQPresetpreset: FENUMWRAP_HEADPHONE_EQUALIZER_PRESETintError code index
SetInEarMonitoringVolumevolume: intintError code index
SetLocalRenderModerenderMode: ERENDER_MODE_TYPE, mirrorMode?: EVIDEO_MIRROR_MODE_TYPEintError code index
SetLocalRenderTargetFpssourceType: EUABT_VIDEO_SOURCE_TYPE, targetFps: intintError code index
SetLocalVideoMirrorModemirrorMode: EVIDEO_MIRROR_MODE_TYPEintError code index
SetLocalVoiceEqualizationbandFrequency: EAUDIO_EQUALIZATION_BAND_FREQUENCY, bandGain: intintError code index
SetLocalVoiceFormantformantRatio?: const FString&intError code index
SetLocalVoicePitchpitch: floatintError code index
SetLocalVoiceReverbreverbKey: EAUDIO_REVERB_TYPE, value: intintError code index
SetLogFilefilePath: const FString&intError code index
SetLogFileSizefileSizeInKBytes: intintError code index
SetLogFilterfilter: intintError code index
SetLogLevellevel: ELOG_LEVELintError code index
SetLowlightEnhanceOptionsenabled: bool, options: const FUABT_LowlightEnhanceOptions&, type: EUABT_MEDIA_SOURCE_TYPEintError code index
SetParametersparameters: const FString&intError code index
SetRemoteDefaultVideoStreamTypestreamType: EVIDEO_STREAM_TYPEintError code index
SetRemoteRenderModeuid: int64, renderMode: ERENDER_MODE_TYPE, mirrorMode: EVIDEO_MIRROR_MODE_TYPEintError code index
SetRemoteRenderTargetFpstargetFps: intintError code index
SetRemoteSubscribeFallbackOptionoption: ESTREAM_FALLBACK_OPTIONSintError code index
SetRemoteVideoStreamTypeuid: int64, streamType: EVIDEO_STREAM_TYPEintError code index
SetRemoteVoicePositionuid: int64, pan: float, gain: floatintError code index
SetScreenCaptureContentHintcontentHint: EVIDEO_CONTENT_HINTintError code index
SetScreenCaptureScenarioscreenScenario: ESCREEN_SCENARIO_TYPEintError code index
SetSubscribeAudioAllowlistuidList: TArray, uidNumber: intintError code index
SetSubscribeAudioBlocklistuidList: TArray, uidNumber: intintError code index
SetSubscribeVideoAllowlistuidList: TArray, uidNumber: intintError code index
SetSubscribeVideoBlocklistuidList: TArray, uidNumber: intintError code index
SetVideoDenoiserOptionsenabled: bool, options: const FUABT_VideoDenoiserOptions&, type: EUABT_MEDIA_SOURCE_TYPEintError code index
SetVideoEncoderConfigurationconfig: const FVideoEncoderConfiguration&intError code index
SetVideoScenarioscenarioType: EVIDEO_APPLICATION_SCENARIO_TYPEintError code index
SetVoiceBeautifierParameterspreset: FENUMWRAP_VOICE_BEAUTIFIER_PRESET, param1: int, param2: intintError code index
SetVoiceBeautifierPresetpreset: FENUMWRAP_VOICE_BEAUTIFIER_PRESETintError code index
SetVoiceConversionPresetpreset: FENUMWRAP_VOICE_CONVERSION_PRESETintError code index
SetVolumeOfEffectsoundId: int, volume: intintError code index
SetupLocalVideocanvas: const FVideoCanvas&intError code index
SetupRemoteVideocanvas: const FVideoCanvas&intError code index
StartAudioMixingfilePath: const FString&, loopback: bool, cycle: int, startPos?: intintError code index
StartAudioRecordingconfig: const FAudioRecordingConfiguration&intError code index
StartCameraCapturesourceType: EVIDEO_SOURCE_TYPE, config: const FCameraCapturerConfiguration&intError code index
StartEchoTestconfig: const FEchoTestConfiguration&intError code index
StartLastmileProbeTestconfig: const FLastmileProbeConfig&intError code index
StartLocalVideoTranscoderconfig: const FLocalTranscoderConfiguration&intError code index
StartMediaRenderingTracing—intError code index
StartOrUpdateChannelMediaRelayconfiguration: const FChannelMediaRelayConfiguration&intError code index
StartPreviewsourceType?: EVIDEO_SOURCE_TYPEintError code index
StartRhythmPlayersound1: const FString&, sound2: const FString&, config: const FAgoraRhythmPlayerConfig&intError code index
StartRtmpStreamWithTranscodingurl: const FString&, transcoding: const FLiveTranscoding&intError code index
StartRtmpStreamWithoutTranscodingurl: const FString&intError code index
StartScreenCapturecaptureParams: const FScreenCaptureParameters2&intError code index
StartScreenCaptureByDisplayIddisplayId: int64, regionRect: const FRectangle&, captureParams: const FScreenCaptureParameters&intError code index
StartScreenCaptureByScreenRectscreenRect: const FRectangle&, regionRect: const FRectangle&, captureParams: const FScreenCaptureParameters&intError code index
StartScreenCaptureBySourceTypesourceType: EVIDEO_SOURCE_TYPE, config: const FScreenCaptureConfiguration&intError code index
StartScreenCaptureByWindowIdwindowId: int64, regionRect: const FRectangle&, captureParams: const FScreenCaptureParameters&intError code index
StopAllEffects—intError code index
StopAudioMixing—intError code index
StopAudioRecording—intError code index
StopCameraCapturesourceType: EVIDEO_SOURCE_TYPEintError code index
StopChannelMediaRelay—intError code index
StopEchoTest—intError code index
StopEffectsoundId: intintError code index
StopLastmileProbeTest—intError code index
StopLocalVideoTranscoder—intError code index
StopPreviewsourceType?: EVIDEO_SOURCE_TYPEintError code index
StopRhythmPlayer—intError code index
StopRtmpStreamurl: const FString&intError code index
StopScreenCapture—intError code index
StopScreenCaptureBySourceTypesourceType: EVIDEO_SOURCE_TYPEintError code index
SwitchCamera—intError code index
TakeSnapshotuid: int64, filePath: const FString&intError code index
TakeSnapshotWithConfiguid: int64, config: const FUABT_SnapshotConfig&intError code index
UnloadAllEffects—intError code index
UnloadEffectsoundId: intintError code index
UpdateChannelMediaOptionsoptions: const FChannelMediaOptions&intError code index
UpdateLocalTranscoderConfigurationconfig: const FLocalTranscoderConfiguration&intError code index
UpdatePreloadChannelTokentoken: const FString&intError code index
UpdateRtmpTranscodingtranscoding: const FLiveTranscoding&intError code index
UpdateScreenCapturecaptureParams: const FScreenCaptureParameters2&intError code index
UpdateScreenCaptureParameterscaptureParams: const FScreenCaptureParameters&intError code index
UpdateScreenCaptureRegionregionRect: const FRectangle&intError code index
IRtcEngineEventHandler 83 method / 0 Property
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

Method detail: 83 / 83 (parameters, returns, errors)

MethodParametersReturnsErrors
OnActiveSpeakeruid: int64voidError code index
OnAudioDeviceStateChangeddeviceId: const FString&, deviceType: int, deviceState: intvoidError code index
OnAudioDeviceVolumeChangeddeviceType: FENUMWRAP_MEDIA_DEVICE_TYPE, volume: int, muted: boolvoidError code index
OnAudioEffectFinishedsoundId: intvoidError code index
OnAudioMixingFinished—voidError code index
OnAudioMixingPositionChangedposition: int64voidError code index
OnAudioMixingStateChangedstate: FENUMWRAP_AUDIO_MIXING_STATE_TYPE, reason: FENUMWRAP_AUDIO_MIXING_REASON_TYPEvoidError code index
OnAudioPublishStateChangedchannel: const FString&, oldState: ESTREAM_PUBLISH_STATE, newState: ESTREAM_PUBLISH_STATE, elapseSinceLastState: intvoidError code index
OnAudioQualityuid: int64, quality: int, delay: int, lost: intvoidError code index
OnAudioRoutingChangedrouting: intvoidError code index
OnAudioSubscribeStateChangedchannel: const FString&, uid: int64, oldState: ESTREAM_SUBSCRIBE_STATE, newState: ESTREAM_SUBSCRIBE_STATE, elapseSinceLastState: intvoidError code index
OnAudioVolumeIndicationspeakers: const TArray&, totalVolume: intvoidError code index
OnCameraExposureAreaChangedx: int, y: int, width: int, height: intvoidError code index
OnCameraFocusAreaChangedx: int, y: int, width: int, height: intvoidError code index
OnCameraReady—voidError code index
OnChannelMediaRelayStateChangedstate: int, code: intvoidError code index
OnClientRoleChangeFailedreason: ECLIENT_ROLE_CHANGE_FAILED_REASON, currentRole: ECLIENT_ROLE_TYPEvoidError code index
OnClientRoleChangedoldRole: ECLIENT_ROLE_TYPE, newRole: ECLIENT_ROLE_TYPE, newRoleOptions: const FClientRoleOptions&voidError code index
OnConnectionBanned—voidError code index
OnConnectionInterrupted—voidError code index
OnConnectionLost—voidError code index
OnConnectionStateChangedstate: ECONNECTION_STATE_TYPE, reason: ECONNECTION_CHANGED_REASON_TYPEvoidError code index
OnEncryptionErrorerrorType: EENCRYPTION_ERROR_TYPEvoidError code index
OnErrorerror: int, msg: const FString&voidError code index
OnExtensionErrorWithContextcontext: const FExtensionContext&, error: int, message: const FString&voidError code index
OnExtensionEventWithContextcontext: const FExtensionContext&, key: const FString&, value: const FString&voidError code index
OnExtensionStartedWithContextcontext: const FExtensionContext&voidError code index
OnExtensionStoppedWithContextcontext: const FExtensionContext&voidError code index
OnFacePositionChangedimageWidth: int, imageHeight: int, vecRectangle: const TArray&, vecDistance: const TArray&, numFaces: intvoidError code index
OnFirstLocalAudioFramePublishedelapsed: intvoidError code index
OnFirstLocalVideoFramesource: EVIDEO_SOURCE_TYPE, width: int, height: int, elapsed: intvoidError code index
OnFirstLocalVideoFramePublishedsource: EVIDEO_SOURCE_TYPE, elapsed: intvoidError code index
OnFirstRemoteAudioDecodeduid: int64, elapsed: intvoidError code index
OnFirstRemoteAudioFrameuid: int64, elapsed: intvoidError code index
OnFirstRemoteVideoDecodeduid: int64, width: int, height: int, elapsed: intvoidError code index
OnFirstRemoteVideoFrameuid: int64, width: int, height: int, elapsed: intvoidError code index
OnJoinChannelSuccessChannel: const FString&, Uid: int64, Elapsed: intvoidError code index
OnLastmileProbeResultresult: const FLastmileProbeResult&voidError code index
OnLastmileQualityquality: intvoidError code index
OnLeaveChannelstats: const FRtcStats&voidError code index
OnLocalAudioStateChangedstate: ELOCAL_AUDIO_STREAM_STATE, reason: ELOCAL_AUDIO_STREAM_REASONvoidError code index
OnLocalAudioStatsstats: const FLocalAudioStats&voidError code index
OnLocalUserRegistereduid: int64, userAccount: const FString&voidError code index
OnLocalVideoStateChangedsource: EVIDEO_SOURCE_TYPE, state: ELOCAL_VIDEO_STREAM_STATE, reason: ELOCAL_VIDEO_STREAM_REASONvoidError code index
OnLocalVideoStatssource: EVIDEO_SOURCE_TYPE, stats: const FLocalVideoStats&voidError code index
OnLocalVideoTranscoderErrorstream: const FTranscodingVideoStream&, error: EVIDEO_TRANSCODER_ERRORvoidError code index
OnNetworkQualityuid: int64, txQuality: int, rxQuality: intvoidError code index
OnNetworkTypeChangedtype: FENUMWRAP_NETWORK_TYPEvoidError code index
OnPermissionErrorpermissionType: EPERMISSION_TYPEvoidError code index
OnProxyConnectedchannel: const FString&, uid: int64, proxyType: EPROXY_TYPE, localProxyIp: const FString&, elapsed: intvoidError code index
OnRejoinChannelSuccesschannel: const FString&, uid: int64, elapsed: intvoidError code index
OnRemoteAudioStateChangeduid: int64, state: EREMOTE_AUDIO_STATE, reason: EREMOTE_AUDIO_STATE_REASON, elapsed: intvoidError code index
OnRemoteAudioStatsstats: const FRemoteAudioStats&voidError code index
OnRemoteAudioTransportStatsuid: int64, delay: int, lost: int, rxKBitRate: intvoidError code index
OnRemoteSubscribeFallbackToAudioOnlyuid: int64, isFallbackOrRecover: boolvoidError code index
OnRemoteVideoStateChangeduid: int64, state: EREMOTE_VIDEO_STATE, reason: EREMOTE_VIDEO_STATE_REASON, elapsed: intvoidError code index
OnRemoteVideoStatsstats: const FRemoteVideoStats&voidError code index
OnRemoteVideoTransportStatsuid: int64, delay: int, lost: int, rxKBitRate: intvoidError code index
OnRequestToken—voidError code index
OnRhythmPlayerStateChangedstate: FENUMWRAP_RHYTHM_PLAYER_STATE_TYPE, reason: FENUMWRAP_RHYTHM_PLAYER_REASONvoidError code index
OnRtcStatsstats: const FRtcStats&voidError code index
OnRtmpStreamingEventurl: const FString&, eventCode: ERTMP_STREAMING_EVENTvoidError code index
OnRtmpStreamingStateChangedurl: const FString&, state: ERTMP_STREAM_PUBLISH_STATE, reason: ERTMP_STREAM_PUBLISH_REASONvoidError code index
OnSnapshotTakenuid: int64, filePath: const FString&, width: int, height: int, errCode: intvoidError code index
OnStreamMessageuid: int64, streamId: int, data: const FString&, length: int, sentTs: int64voidError code index
OnStreamMessageErroruid: int64, streamId: int, code: int, missed: int, cached: intvoidError code index
OnTokenPrivilegeWillExpiretoken: const FString&voidError code index
OnTranscodedStreamLayoutInfouid: int64, width: int, height: int, layoutCount: int, layoutlist: const TArray&voidError code index
OnTranscodingUpdated—voidError code index
OnUplinkNetworkInfoUpdatedinfo: const FUplinkNetworkInfo&voidError code index
OnUserEnableLocalVideouid: int64, enabled: boolvoidError code index
OnUserEnableVideouid: int64, enabled: boolvoidError code index
OnUserInfoUpdateduid: int64, info: const FUserInfo&voidError code index
OnUserJoineduid: int64, elapsed: intvoidError code index
OnUserMuteAudiouid: int64, muted: boolvoidError code index
OnUserMuteVideouid: int64, muted: boolvoidError code index
OnUserOfflineuid: int64, reason: EUSER_OFFLINE_REASON_TYPEvoidError code index
OnVideoDeviceStateChangeddeviceId: const FString&, deviceType: int, deviceState: intvoidError code index
OnVideoPublishStateChangedsource: EVIDEO_SOURCE_TYPE, channel: const FString&, oldState: ESTREAM_PUBLISH_STATE, newState: ESTREAM_PUBLISH_STATE, elapseSinceLastState: intvoidError code index
OnVideoRenderingTracingResultuid: int64, currentEvent: EMEDIA_TRACE_EVENT, tracingInfo: const FVideoRenderingTracingInfo&voidError code index
OnVideoSizeChangedsourceType: EVIDEO_SOURCE_TYPE, uid: int64, width: int, height: int, rotation: intvoidError code index
OnVideoStopped—voidError code index
OnVideoSubscribeStateChangedchannel: const FString&, uid: int64, oldState: ESTREAM_SUBSCRIBE_STATE, newState: ESTREAM_SUBSCRIBE_STATE, elapseSinceLastState: intvoidError code index
IRtcEngineEx 44 method / 0 Property
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

Method detail: 44 / 44 (parameters, returns, errors)

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

Method detail: 3 / 3 (parameters, returns, errors)

MethodParametersReturnsErrors
GetCount—intError code index
GetSourceInfoindex: intFScreenCaptureSourceInfoError code index
Release—voidError code index
IVideoDeviceCollection 4 method / 0 Property
typescript
GetCount(): int
GetDevice(index: int, deviceName: FString&, deviceId: FString&): int
Release(): void
SetDevice(deviceIdUTF8: FString&): int

Method detail: 4 / 4 (parameters, returns, errors)

MethodParametersReturnsErrors
GetCount—intError code index
GetDeviceindex: int, deviceName: FString&, deviceId: FString&intError code index
Release—voidError code index
SetDevicedeviceIdUTF8: FString&intError code index
IVideoDeviceManager 4 method / 0 Property
typescript
EnumerateVideoDevices(): UVideoDeviceCollection*
GetCapability(deviceIdUTF8: const FString&, deviceCapabilityNumber: int, capability: FVideoFormat&): int
NumberOfCapabilities(deviceIdUTF8: const FString&): int
Release(): void

Method detail: 4 / 4 (parameters, returns, errors)

MethodParametersReturnsErrors
EnumerateVideoDevices—UVideoDeviceCollection*Error code index
GetCapabilitydeviceIdUTF8: const FString&, deviceCapabilityNumber: int, capability: FVideoFormat&intError code index
NumberOfCapabilitiesdeviceIdUTF8: const FString&intError code index
Release—voidError code index

Enums

EnumsMember countExample value
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 members
Membervalue
AUDIENCE_LATENCY_LEVEL_LOW_LATENCY1
AUDIENCE_LATENCY_LEVEL_ULTRA_LOW_LATENCY2
EAUDIO_AINS_MODE 3 members
Membervalue
AINS_MODE_BALANCED0
AINS_MODE_AGGRESSIVE1
AINS_MODE_ULTRALOWLATENCY2
EAUDIO_CODEC_PROFILE_TYPE 3 members
Membervalue
AUDIO_CODEC_PROFILE_LC_AAC0
AUDIO_CODEC_PROFILE_HE_AAC1
HE_AAC_V22
EAUDIO_DUAL_MONO_MODE 4 members
Membervalue
AUDIO_DUAL_MONO_STEREO0
AUDIO_DUAL_MONO_L1
AUDIO_DUAL_MONO_R2
AUDIO_DUAL_MONO_MIX3
EAUDIO_ENCODED_FRAME_OBSERVER_POSITION 3 members
Membervalue
AUDIO_ENCODED_FRAME_OBSERVER_POSITION_RECORD1
AUDIO_ENCODED_FRAME_OBSERVER_POSITION_PLAYBACK2
AUDIO_ENCODED_FRAME_OBSERVER_POSITION_MIXED3
EAUDIO_EQUALIZATION_BAND_FREQUENCY 10 members
Membervalue
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 members
Membervalue
AUDIO_FILE_RECORDING_MIC1
AUDIO_FILE_RECORDING_PLAYBACK2
AUDIO_FILE_RECORDING_MIXED3
EAUDIO_MIXING_DUAL_MONO_MODE 4 members
Membervalue
AUDIO_MIXING_DUAL_MONO_AUTO0
AUDIO_MIXING_DUAL_MONO_L1
AUDIO_MIXING_DUAL_MONO_R2
AUDIO_MIXING_DUAL_MONO_MIX3
EAUDIO_PROFILE_TYPE 8 members
Membervalue
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 members
Membervalue
AUDIO_RECORDING_QUALITY_LOW0
AUDIO_RECORDING_QUALITY_MEDIUM1
AUDIO_RECORDING_QUALITY_HIGH2
AUDIO_RECORDING_QUALITY_ULTRA_HIGH3
EAUDIO_REVERB_TYPE 5 members
Membervalue
AUDIO_REVERB_DRY_LEVEL0
AUDIO_REVERB_WET_LEVEL1
AUDIO_REVERB_ROOM_SIZE2
AUDIO_REVERB_WET_DELAY3
AUDIO_REVERB_STRENGTH4
EAUDIO_SAMPLE_RATE_TYPE 3 members
Membervalue
AUDIO_SAMPLE_RATE_3200032000
AUDIO_SAMPLE_RATE_4410044100
AUDIO_SAMPLE_RATE_4800048000
EAUDIO_SCENARIO_TYPE 7 members
Membervalue
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 members
Membervalue
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 members
Membervalue
BLUR_DEGREE_LOW1
BLUR_DEGREE_MEDIUM2
BLUR_DEGREE_HIGH3
EBACKGROUND_SOURCE_TYPE 4 members
Membervalue
BACKGROUND_COLOR1
BACKGROUND_IMG2
BACKGROUND_BLUR3
BACKGROUND_VIDEO4
ECAMERA_DIRECTION 2 members
Membervalue
CAMERA_REAR0
CAMERA_FRONT1
ECAMERA_FOCAL_LENGTH_TYPE 4 members
Membervalue
CAMERA_FOCAL_LENGTH_DEFAULT0
CAMERA_FOCAL_LENGTH_WIDE_ANGLE1
CAMERA_FOCAL_LENGTH_ULTRA_WIDE2
CAMERA_FOCAL_LENGTH_TELEPHOTO3
ECHANNEL_PROFILE_TYPE 4 members
Membervalue
CHANNEL_PROFILE_COMMUNICATION0
CHANNEL_PROFILE_LIVE_BROADCASTING1
CHANNEL_PROFILE_GAME2
CHANNEL_PROFILE_CLOUD_GAMING3
ECLIENT_ROLE_CHANGE_FAILED_REASON 4 members
Membervalue
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 members
Membervalue
CLIENT_ROLE_BROADCASTER1
CLIENT_ROLE_AUDIENCE2
ECLOUD_PROXY_TYPE 3 members
Membervalue
NONE_PROXY0
UDP_PROXY1
TCP_PROXY2
ECOMPRESSION_PREFERENCE 3 members
Membervalue
PREFER_COMPRESSION_AUTO-1
PREFER_LOW_LATENCY0
PREFER_QUALITY1
ECONNECTION_CHANGED_REASON_TYPE 21 members
Membervalue
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 members
Membervalue
CONNECTION_STATE_DISCONNECTED1
CONNECTION_STATE_CONNECTING2
CONNECTION_STATE_CONNECTED3
CONNECTION_STATE_RECONNECTING4
CONNECTION_STATE_FAILED5
ECONTENT_INSPECT_TYPE 3 members
Membervalue
CONTENT_INSPECT_INVALID0
CONTENT_INSPECT_SUPERVISION2
CONTENT_INSPECT_IMAGE_MODERATION3
EENCRYPTION_ERROR_TYPE 5 members
Membervalue
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 members
Membervalue
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 members
Membervalue
VIDEO_FRAME0
ENCODED_VIDEO_FRAME1
EFeatureType 2 members
Membervalue
VIDEO_VIRTUAL_BACKGROUND1
VIDEO_BEAUTY_EFFECT2
ELASTMILE_PROBE_RESULT_STATE 3 members
Membervalue
LASTMILE_PROBE_RESULT_COMPLETE1
LASTMILE_PROBE_RESULT_INCOMPLETE_NO_BWE2
LASTMILE_PROBE_RESULT_UNAVAILABLE3
ELIGHTENING_CONTRAST_LEVEL 3 members
Membervalue
LIGHTENING_CONTRAST_LOW0
LIGHTENING_CONTRAST_NORMAL1
LIGHTENING_CONTRAST_HIGH2
ELOCAL_AUDIO_STREAM_REASON 11 members
Membervalue
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 members
Membervalue
LOCAL_AUDIO_STREAM_STATE_STOPPED0
LOCAL_AUDIO_STREAM_STATE_RECORDING1
LOCAL_AUDIO_STREAM_STATE_ENCODING2
LOCAL_AUDIO_STREAM_STATE_FAILED3
ELOCAL_PROXY_MODE 2 members
Membervalue
ConnectivityFirst0
LocalOnly1
ELOCAL_VIDEO_STREAM_REASON 26 members
Membervalue
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 members
Membervalue
LOCAL_VIDEO_STREAM_STATE_STOPPED0
LOCAL_VIDEO_STREAM_STATE_CAPTURING1
LOCAL_VIDEO_STREAM_STATE_ENCODING2
LOCAL_VIDEO_STREAM_STATE_FAILED3
ELOG_LEVEL 5 members
Membervalue
LOG_LEVEL_NONE0
LOG_LEVEL_INFO1
LOG_LEVEL_WARN2
LOG_LEVEL_ERROR4
LOG_LEVEL_FATAL8
ELOW_LIGHT_ENHANCE_MODE 2 members
Membervalue
LOW_LIGHT_ENHANCE_AUTO0
LOW_LIGHT_ENHANCE_MANUAL1
EMEDIA_DEVICE_STATE_TYPE 6 members
Membervalue
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 members
Membervalue
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 members
Membervalue
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 members
Membervalue
STREAM_TYPE_UNKNOWN0
STREAM_TYPE_VIDEO1
STREAM_TYPE_AUDIO2
STREAM_TYPE_SUBTITLE3
EMEDIA_TRACE_EVENT 2 members
Membervalue
MEDIA_TRACE_EVENT_VIDEO_RENDERED0
MEDIA_TRACE_EVENT_VIDEO_DECODED1
EPERMISSION_TYPE 3 members
Membervalue
RECORD_AUDIO0
CAMERA1
SCREEN_CAPTUREnull
EPLAYER_PRELOAD_EVENT 3 members
Membervalue
PLAYER_PRELOAD_EVENT_BEGIN0
PLAYER_PRELOAD_EVENT_COMPLETE1
PLAYER_PRELOAD_EVENT_ERROR2
EPROXY_TYPE 5 members
Membervalue
NONE_PROXY_TYPE0
UDP_PROXY_TYPE1
TCP_PROXY_TYPE2
LOCAL_PROXY_TYPE3
TCP_PROXY_AUTO_FALLBACK_TYPE4
EQUALITY_ADAPT_INDICATION 3 members
Membervalue
ADAPT_NONE0
ADAPT_UP_BANDWIDTH1
ADAPT_DOWN_BANDWIDTH2
EREMOTE_AUDIO_STATE 5 members
Membervalue
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 members
Membervalue
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 members
Membervalue
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 members
Membervalue
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 members
Membervalue
RENDER_MODE_HIDDEN1
RENDER_MODE_FIT2
RENDER_MODE_ADAPTIVE3
ERTMP_STREAM_PUBLISH_REASON 15 members
Membervalue
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 members
Membervalue
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 members
Membervalue
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 members
Membervalue
SCREEN_SCENARIO_DOCUMENT1
SCREEN_SCENARIO_GAMING2
SCREEN_SCENARIO_VIDEO3
SCREEN_SCENARIO_RDC4
ESEG_MODEL_TYPE 2 members
Membervalue
SEG_MODEL_AI1
SEG_MODEL_GREEN2
ESTREAM_FALLBACK_OPTIONS 3 members
Membervalue
STREAM_FALLBACK_OPTION_DISABLED0
STREAM_FALLBACK_OPTION_VIDEO_STREAM_LOW1
STREAM_FALLBACK_OPTION_AUDIO_ONLY2
ESTREAM_PUBLISH_STATE 4 members
Membervalue
PUB_STATE_IDLE0
PUB_STATE_NO_PUBLISHED1
PUB_STATE_PUBLISHING2
PUB_STATE_PUBLISHED3
ESTREAM_SUBSCRIBE_STATE 4 members
Membervalue
SUB_STATE_IDLE0
SUB_STATE_NO_SUBSCRIBED1
SUB_STATE_SUBSCRIBING2
SUB_STATE_SUBSCRIBED3
EUABT_AUDIO_SOURCE_TYPE 7 members
Membervalue
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 members
Membervalue
MAINTAIN_AUTO-1
MAINTAIN_QUALITY0
MAINTAIN_FRAMERATE1
MAINTAIN_BALANCED2
MAINTAIN_RESOLUTION3
EUABT_FACE_SHAPE_AREA 13 members
Membervalue
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 members
Membervalue
FACE_SHAPE_BEAUTY_STYLE_FEMALE0
FACE_SHAPE_BEAUTY_STYLE_MALE1
EUABT_LOW_LIGHT_ENHANCE_LEVEL 2 members
Membervalue
LOW_LIGHT_ENHANCE_LEVEL_HIGH_QUALITY0
LOW_LIGHT_ENHANCE_LEVEL_FAST1
EUABT_MEDIA_SOURCE_TYPE 6 members
Membervalue
AUDIO_PLAYOUT_SOURCE0
AUDIO_RECORDING_SOURCE1
PRIMARY_CAMERA_SOURCE2
SECONDARY_CAMERA_SOURCE3
CUSTOM_VIDEO_SOURCE6
UNKNOWN_MEDIA_SOURCE100
EUABT_ORIENTATION_MODE 3 members
Membervalue
ORIENTATION_MODE_ADAPTIVE0
ORIENTATION_MODE_FIXED_LANDSCAPE1
ORIENTATION_MODE_FIXED_PORTRAIT2
EUABT_VIDEO_CODEC_TYPE 6 members
Membervalue
VIDEO_CODEC_NONE0
VIDEO_CODEC_VP81
VIDEO_CODEC_H2642
VIDEO_CODEC_H2653
VIDEO_CODEC_GENERIC6
VIDEO_CODEC_GENERIC_JPEG20
EUABT_VIDEO_DENOISER_LEVEL 2 members
Membervalue
VIDEO_DENOISER_LEVEL_HIGH_QUALITY0
VIDEO_DENOISER_LEVEL_FAST1
EUABT_VIDEO_MIRROR_MODE_TYPE 3 members
Membervalue
VIDEO_MIRROR_MODE_AUTO0
VIDEO_MIRROR_MODE_ENABLED1
VIDEO_MIRROR_MODE_DISABLED2
EUABT_VIDEO_MODULE_POSITION 4 members
Membervalue
POSITION_POST_CAPTURER1
POSITION_PRE_RENDERER2
POSITION_PRE_ENCODER4
POSITION_POST_CAPTURER_ORIGIN8
EUABT_VIDEO_SOURCE_TYPE 18 members
Membervalue
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 members
Membervalue
USER_OFFLINE_QUIT0
USER_OFFLINE_DROPPED1
USER_OFFLINE_BECOME_AUDIENCE2
EVIDEO_APPLICATION_SCENARIO_TYPE 4 members
Membervalue
APPLICATION_SCENARIO_GENERAL0
APPLICATION_SCENARIO_MEETINGnull
APPLICATION_SCENARIO_1V1null
APPLICATION_SCENARIO_LIVESHOWnull
EVIDEO_CODEC_PROFILE_TYPE 3 members
Membervalue
VIDEO_CODEC_PROFILE_BASELINE66
VIDEO_CODEC_PROFILE_MAIN77
VIDEO_CODEC_PROFILE_HIGH100
EVIDEO_CODEC_TYPE_FOR_STREAM 2 members
Membervalue
VIDEO_CODEC_H264_FOR_STREAM1
VIDEO_CODEC_H265_FOR_STREAM2
EVIDEO_CONTENT_HINT 3 members
Membervalue
CONTENT_HINT_NONEnull
CONTENT_HINT_MOTIONnull
CONTENT_HINT_DETAILSnull
EVIDEO_DENOISER_MODE 2 members
Membervalue
VIDEO_DENOISER_AUTO0
VIDEO_DENOISER_MANUAL1
EVIDEO_STREAM_TYPE 2 members
Membervalue
VIDEO_STREAM_HIGH0
VIDEO_STREAM_LOW1
EVIDEO_TRANSCODER_ERROR 6 members
Membervalue
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 members
Membervalue
VIDEO_VIEW_SETUP_REPLACE0
VIDEO_VIEW_SETUP_ADD1
VIDEO_VIEW_SETUP_REMOVE2
EVOICE_AI_TUNER_TYPE 10 members
Membervalue
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 members
Membervalue
FIT_MODE_COVER_POSITIONnull
FIT_MODE_USE_IMAGE_RATIOnull
FENUMWRAP_AREA_CODE 7 members
Membervalue
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 members
Membervalue
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 members
Membervalue
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 members
Membervalue
AUDIO_MIXING_STATE_PLAYING710
AUDIO_MIXING_STATE_PAUSED711
AUDIO_MIXING_STATE_STOPPED713
AUDIO_MIXING_STATE_FAILED714
FENUMWRAP_CAMERA_STABILIZATION_MODE 5 members
Membervalue
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 members
Membervalue
CAPTURE_BRIGHTNESS_LEVEL_INVALID-1
CAPTURE_BRIGHTNESS_LEVEL_NORMAL0
CAPTURE_BRIGHTNESS_LEVEL_BRIGHT1
CAPTURE_BRIGHTNESS_LEVEL_DARK2
FENUMWRAP_ENCODING_PREFERENCE 3 members
Membervalue
PREFER_AUTO-1
PREFER_SOFTWARE0
PREFER_HARDWARE1
FENUMWRAP_HEADPHONE_EQUALIZER_PRESET 3 members
Membervalue
HEADPHONE_EQUALIZER_OFFnull
HEADPHONE_EQUALIZER_OVEREARnull
HEADPHONE_EQUALIZER_INEARnull
FENUMWRAP_MEDIA_DEVICE_TYPE 8 members
Membervalue
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 members
Membervalue
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 members
Membervalue
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 members
Membervalue
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 members
Membervalue
RHYTHM_PLAYER_STATE_IDLE810
RHYTHM_PLAYER_STATE_OPENING811
RHYTHM_PLAYER_STATE_DECODING812
RHYTHM_PLAYER_STATE_PLAYING813
RHYTHM_PLAYER_STATE_FAILED814
FENUMWRAP_ScreenCaptureSourceType 4 members
Membervalue
ScreenCaptureSourceType_Unknown-1
ScreenCaptureSourceType_Window0
ScreenCaptureSourceType_Screen1
ScreenCaptureSourceType_Custom2
FENUMWRAP_SIMULCAST_STREAM_MODE 3 members
Membervalue
AUTO_SIMULCAST_STREAM-1
DISABLE_SIMULCAST_STREAM0
ENABLE_SIMULCAST_STREAM1
FENUMWRAP_VIDEO_CODEC_CAPABILITY_LEVEL 5 members
Membervalue
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 members
Membervalue
VIDEO_ORIENTATION_00
VIDEO_ORIENTATION_9090
VIDEO_ORIENTATION_180180
VIDEO_ORIENTATION_270270
FENUMWRAP_VOICE_BEAUTIFIER_PRESET 14 members
Membervalue
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 members
Membervalue
VOICE_CONVERSION_OFFnull
VOICE_CHANGER_NEUTRALnull
VOICE_CHANGER_SWEETnull
VOICE_CHANGER_SOLIDnull
VOICE_CHANGER_BASSnull

error-code constants

Constantvalue
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

Known limitations

The following members are not available in the current version and return -4 (ERR_NOT_SUPPORTED). They remain in the interface definition so cross-platform code stays consistent.

InterfaceMember
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

Generated by the documentation build pipeline · 2026-10-31 01:24:02 UTC · Documentation center v1.1.0.

Content follows the public API definitions.

ni-meet is a self-hosted RTC PaaS with a LiveKit-based media plane (Apache-2.0) and an Agora-compatible API.