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.
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 item | Count |
|---|---|
| Interface / class | 90 |
| Method | 458 |
| Method overloads | 458 |
| Property | 435 |
| Enums | 103 |
| error-code constants | 6 |
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”.
| Step | Interface | Method | Overload count |
|---|---|---|---|
| Join a channel | __unattributed__ | JoinChannel | 1 |
| Leave a channel | __unattributed__ | LeaveChannel | 1 |
| enable video and preview | IRtcEngine | EnableVideo | 1 |
| Create / initialize | IRtcEngine | Initialize | 1 |
| subscribe to remote media | IRtcEngine | MuteRemoteAudioStream | 1 |
| Renew the Token | IRtcEngine | RenewToken | 1 |
| Channel scenarios | IRtcEngine | SetChannelProfile | 1 |
| role switching | IRtcEngine | SetClientRole | 1 |
| local video | IRtcEngine | SetupLocalVideo | 1 |
parameters for the minimal runnable flow
| Parameters | Type | Optional | Variadic parameters |
|---|---|---|---|
token | const FString& | No | No |
channelId | const FString& | No | No |
uid | int64 | No | No |
context | const FRtcEngineContext& | No | No |
uid | int64 | No | No |
mute | bool | No | No |
token | const FString& | No | No |
profile | ECHANNEL_PROFILE_TYPE | No | No |
options | FClientRoleOptions | No | No |
clientroletype | ECLIENT_ROLE_TYPE | is | No |
canvas | const FVideoCanvas& | No | No |
Endpoint index
all endpoints
__unattributed__ 16 method / 0 Property
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): intMethod detail: 16 / 16 (parameters, returns, errors)
| Method | Parameters | Returns | Errors |
|---|---|---|---|
AddBlueprintCallbackExecutor | Executor: UAgoraBPuIRtcEngineEventHandlerCBExecutor* | void | Error code index |
AddBlueprintCallbackExecutorEx | Executor: UAgoraBPuIRtcEngineEventHandlerExCBExecutor* | void | Error code index |
ClearAllEventHandlerCBExecutors | — | void | Error code index |
FollowSystemLoopbackDevice | enable: bool | int | Error code index |
GetAgoraAudioDeviceManager | — | UAgoraBPuAudioDeviceManager* | Error code index |
GetAgoraVideoDeviceManager | — | UAgoraBPuVideoDeviceManager* | Error code index |
GetEventHandler | HandlerType: EAgoraBPuEventHandlerType&, EventHandler: UAgoraBPuIRtcEngineEventHandler*&, EventHandlerEx: UAgoraBPuIRtcEngineEventHandlerEx*& | void | Error code index |
GetLoopbackDevice | deviceId: FString& | int | Error code index |
GetMediaPlayerSourceObserver | — | UAgoraBPuIMediaPlayerSourceObserver* | Error code index |
GetPlaybackDeviceVolume | volume: int& | int | Error code index |
JoinChannel | token: const FString&, channelId: const FString&, uid: int64 | int | Error code index |
LeaveChannel | — | int | Error code index |
SetAudioProfile | profile?: EAUDIO_PROFILE_TYPE | int | Error code index |
SetLocalAccessPoint | config: const FLocalAccessPointConfiguration& | int | Error code index |
SetLoopbackDevice | deviceId: const FString& | int | Error code index |
SetRouteInCommunicationMode | route: int | int | Error code index |
FAdvancedAudioOptions 0 method / 1 Property
| Property | Type | read-only |
|---|---|---|
audioProcessingChannels | unknown | No |
FAdvancedConfigInfo 0 method / 1 Property
| Property | Type | read-only |
|---|---|---|
logUploadServer | unknown | No |
FAgoraMediaSource 0 method / 8 Property
| Property | Type | read-only |
|---|---|---|
url | unknown | No |
uri | unknown | No |
startPos | unknown | No |
autoPlay | unknown | No |
enableCache | unknown | No |
enableMultiAudioTrack | unknown | No |
isAgoraSource | unknown | No |
isLiveSource | unknown | No |
FAgoraRhythmPlayerConfig 0 method / 2 Property
| Property | Type | read-only |
|---|---|---|
beatsPerMeasure | unknown | No |
beatsPerMinute | unknown | No |
FAudioRecordingConfiguration 0 method / 6 Property
| Property | Type | read-only |
|---|---|---|
filePath | unknown | No |
encode | unknown | No |
sampleRate | unknown | No |
fileRecordingType | unknown | No |
quality | unknown | No |
recordingChannel | unknown | No |
FAudioVolumeInfo 0 method / 4 Property
| Property | Type | read-only |
|---|---|---|
uid | unknown | No |
volume | unknown | No |
vad | unknown | No |
voicePitch | unknown | No |
FBeautyOptions 0 method / 5 Property
| Property | Type | read-only |
|---|---|---|
lighteningContrastLevel | unknown | No |
lighteningLevel | unknown | No |
smoothnessLevel | unknown | No |
rednessLevel | unknown | No |
sharpnessLevel | unknown | No |
FCacheStatistics 0 method / 3 Property
| Property | Type | read-only |
|---|---|---|
fileSize | unknown | No |
cacheSize | unknown | No |
downloadSize | unknown | No |
FCameraCapturerConfiguration 0 method / 6 Property
| Property | Type | read-only |
|---|---|---|
cameraDirection | unknown | No |
cameraId | unknown | No |
cameraFocalLengthType | unknown | No |
format | unknown | No |
deviceId | unknown | No |
followEncodeDimensionRatio | unknown | No |
FChannelMediaInfo 0 method / 3 Property
| Property | Type | read-only |
|---|---|---|
channelName | unknown | No |
token | unknown | No |
uid | unknown | No |
FChannelMediaOptions 0 method / 29 Property
| Property | Type | read-only |
|---|---|---|
publishCameraTrack | unknown | No |
publishSecondaryCameraTrack | unknown | No |
publishMicrophoneTrack | unknown | No |
publishThirdCameraTrack | unknown | No |
publishFourthCameraTrack | unknown | No |
publishScreenTrack | unknown | No |
publishScreenCaptureVideo | unknown | No |
publishScreenCaptureAudio | unknown | No |
publishSecondaryScreenTrack | unknown | No |
publishThirdScreenTrack | unknown | No |
publishFourthScreenTrack | unknown | No |
publishTranscodedVideoTrack | unknown | No |
publishMixedAudioTrack | unknown | No |
publishEncodedVideoTrack | unknown | No |
publishMediaPlayerAudioTrack | unknown | No |
publishMediaPlayerVideoTrack | unknown | No |
autoSubscribeAudio | unknown | No |
autoSubscribeVideo | unknown | No |
enableAudioRecordingOrPlayout | unknown | No |
publishMediaPlayerId | unknown | No |
clientRoleType | unknown | No |
audienceLatencyLevel | unknown | No |
defaultVideoStreamType | unknown | No |
channelProfile | unknown | No |
audioDelayMs | unknown | No |
token | unknown | No |
publishRhythmPlayerTrack | unknown | No |
isInteractiveAudience | unknown | No |
isAudioFilterable | unknown | No |
FChannelMediaRelayConfiguration 0 method / 3 Property
| Property | Type | read-only |
|---|---|---|
srcInfo | unknown | No |
destInfos | unknown | No |
destCount | unknown | No |
FClientRoleOptions 0 method / 1 Property
| Property | Type | read-only |
|---|---|---|
audienceLatencyLevel | unknown | No |
FCodecCapInfo 0 method / 3 Property
| Property | Type | read-only |
|---|---|---|
codecType | unknown | No |
codecCapMask | unknown | No |
codecLevels | unknown | No |
FCodecCapLevels 0 method / 2 Property
| Property | Type | read-only |
|---|---|---|
hwDecodingLevel | unknown | No |
swDecodingLevel | unknown | No |
FColorEnhanceOptions 0 method / 2 Property
| Property | Type | read-only |
|---|---|---|
strengthLevel | unknown | No |
skinProtectLevel | unknown | No |
FContentInspectConfig 0 method / 4 Property
| Property | Type | read-only |
|---|---|---|
extraInfo | unknown | No |
serverConfig | unknown | No |
modules | unknown | No |
moduleCount | unknown | No |
FContentInspectModule 0 method / 2 Property
| Property | Type | read-only |
|---|---|---|
type | unknown | No |
interval | unknown | No |
FDataStreamConfig 0 method / 2 Property
| Property | Type | read-only |
|---|---|---|
syncWithAudio | unknown | No |
ordered | unknown | No |
FDeviceInfo 0 method / 1 Property
| Property | Type | read-only |
|---|---|---|
isLowLatencyAudioSupported | unknown | No |
FDirectCdnStreamingStats 0 method / 5 Property
| Property | Type | read-only |
|---|---|---|
videoWidth | unknown | No |
videoHeight | unknown | No |
fps | unknown | No |
videoBitrate | unknown | No |
audioBitrate | unknown | No |
FEchoTestConfiguration 0 method / 6 Property
| Property | Type | read-only |
|---|---|---|
view | unknown | No |
enableAudio | unknown | No |
enableVideo | unknown | No |
token | unknown | No |
channelId | unknown | No |
intervalInSeconds | unknown | No |
FEncryptionConfig 0 method / 4 Property
| Property | Type | read-only |
|---|---|---|
encryptionMode | unknown | No |
encryptionKey | unknown | No |
encryptionKdfSalt | unknown | No |
datastreamEncryptionEnabled | unknown | No |
FExtensionContext 0 method / 4 Property
| Property | Type | read-only |
|---|---|---|
isValid | unknown | No |
uid | unknown | No |
providerName | unknown | No |
extensionName | unknown | No |
FFocalLengthInfo 0 method / 2 Property
| Property | Type | read-only |
|---|---|---|
cameraDirection | unknown | No |
focalLengthType | unknown | No |
FImageTrackOptions 0 method / 2 Property
| Property | Type | read-only |
|---|---|---|
imageUrl | unknown | No |
fps | unknown | No |
FLastmileProbeConfig 0 method / 4 Property
| Property | Type | read-only |
|---|---|---|
probeUplink | unknown | No |
probeDownlink | unknown | No |
expectedUplinkBitrate | unknown | No |
expectedDownlinkBitrate | unknown | No |
FLastmileProbeOneWayResult 0 method / 3 Property
| Property | Type | read-only |
|---|---|---|
packetLossRate | unknown | No |
jitter | unknown | No |
availableBandwidth | unknown | No |
FLastmileProbeResult 0 method / 4 Property
| Property | Type | read-only |
|---|---|---|
state | unknown | No |
uplinkReport | unknown | No |
downlinkReport | unknown | No |
rtt | unknown | No |
FLeaveChannelOptions 0 method / 3 Property
| Property | Type | read-only |
|---|---|---|
stopAudioMixing | unknown | No |
stopAllEffect | unknown | No |
stopMicrophoneRecording | unknown | No |
FLiveStreamAdvancedFeature 0 method / 2 Property
| Property | Type | read-only |
|---|---|---|
featureName | unknown | No |
opened | unknown | No |
FLiveTranscoding 0 method / 23 Property
| Property | Type | read-only |
|---|---|---|
width | unknown | No |
height | unknown | No |
videoBitrate | unknown | No |
videoFrameRate | unknown | No |
lowLatency | unknown | No |
videoGop | unknown | No |
videoCodecProfile | unknown | No |
videoCodecType | unknown | No |
transcodingUsers | unknown | No |
transcodingExtraInfo | unknown | No |
backgroundColor | unknown | No |
userCount | unknown | No |
metadata | unknown | No |
watermark | unknown | No |
backgroundImage | unknown | No |
audioSampleRate | unknown | No |
audioBitrate | unknown | No |
audioChannels | unknown | No |
audioCodecProfile | unknown | No |
watermarkCount | unknown | No |
backgroundImageCount | unknown | No |
advancedFeatures | unknown | No |
advancedFeatureCount | unknown | No |
FLocalAccessPointConfiguration 0 method / 7 Property
| Property | Type | read-only |
|---|---|---|
ipList | unknown | No |
ipListSize | unknown | No |
domainList | unknown | No |
domainListSize | unknown | No |
verifyDomainName | unknown | No |
mode | unknown | No |
advancedConfig | unknown | No |
FLocalAudioStats 0 method / 8 Property
| Property | Type | read-only |
|---|---|---|
numChannels | unknown | No |
sentSampleRate | unknown | No |
sentBitrate | unknown | No |
txPacketLossRate | unknown | No |
internalCodec | unknown | No |
audioDeviceDelay | unknown | No |
earMonitorDelay | unknown | No |
aecEstimatedDelay | unknown | No |
FLocalTranscoderConfiguration 0 method / 3 Property
| Property | Type | read-only |
|---|---|---|
streamCount | unknown | No |
videoInputStreams | unknown | No |
videoOutputConfiguration | unknown | No |
FLocalVideoStats 0 method / 22 Property
| Property | Type | read-only |
|---|---|---|
uid | unknown | No |
sentBitrate | unknown | No |
sentFrameRate | unknown | No |
captureFrameRate | unknown | No |
captureFrameWidth | unknown | No |
captureFrameHeight | unknown | No |
regulatedCaptureFrameRate | unknown | No |
regulatedCaptureFrameWidth | unknown | No |
regulatedCaptureFrameHeight | unknown | No |
encoderOutputFrameRate | unknown | No |
rendererOutputFrameRate | unknown | No |
targetBitrate | unknown | No |
targetFrameRate | unknown | No |
qualityAdaptIndication | unknown | No |
encodedBitrate | int | No |
encodedFrameHeight | unknown | No |
encodedFrameWidth | unknown | No |
encodedFrameCount | unknown | No |
codecType | unknown | No |
txPacketLossRate | unknown | No |
captureBrightnessLevel | unknown | No |
hwEncoderAccelerating | unknown | No |
FLogConfig 0 method / 3 Property
| Property | Type | read-only |
|---|---|---|
filePath | unknown | No |
fileSizeInKB | unknown | No |
level | unknown | No |
FLogUploadServerInfo 0 method / 4 Property
| Property | Type | read-only |
|---|---|---|
serverDomain | unknown | No |
serverPath | unknown | No |
serverPort | unknown | No |
serverHttps | unknown | No |
FPlayerPlaybackStats 0 method / 4 Property
| Property | Type | read-only |
|---|---|---|
videoFps | unknown | No |
videoBitrateInKbps | unknown | No |
audioBitrateInKbps | unknown | No |
totalBitrateInKbps | unknown | No |
FPlayerStreamInfo 0 method / 13 Property
| Property | Type | read-only |
|---|---|---|
streamIndex | unknown | No |
streamType | unknown | No |
codecName | unknown | No |
language | unknown | No |
videoFrameRate | unknown | No |
videoBitRate | unknown | No |
videoWidth | unknown | No |
videoHeight | unknown | No |
videoRotation | unknown | No |
audioSampleRate | unknown | No |
audioChannels | unknown | No |
audioBitsPerSample | unknown | No |
duration | unknown | No |
FPlayerUpdatedInfo 0 method / 6 Property
| Property | Type | read-only |
|---|---|---|
deviceId | unknown | No |
videoHeight | unknown | No |
videoWidth | unknown | No |
audioSampleRate | unknown | No |
audioChannels | unknown | No |
audioBitsPerSample | unknown | No |
FRectangle 0 method / 4 Property
| Property | Type | read-only |
|---|---|---|
x | unknown | No |
y | unknown | No |
width | unknown | No |
height | unknown | No |
FRemoteAudioStats 0 method / 16 Property
| Property | Type | read-only |
|---|---|---|
uid | unknown | No |
quality | unknown | No |
networkTransportDelay | unknown | No |
jitterBufferDelay | unknown | No |
audioLossRate | unknown | No |
numChannels | unknown | No |
receivedSampleRate | unknown | No |
receivedBitrate | unknown | No |
totalFrozenTime | unknown | No |
frozenRate | unknown | No |
totalActiveTime | unknown | No |
publishDuration | unknown | No |
qoeQuality | unknown | No |
qualityChangedReason | unknown | No |
mosValue | unknown | No |
e2eDelay | unknown | No |
FRemoteVideoStats 0 method / 16 Property
| Property | Type | read-only |
|---|---|---|
uid | unknown | No |
delay | unknown | No |
e2eDelay | unknown | No |
width | unknown | No |
height | unknown | No |
receivedBitrate | unknown | No |
decoderOutputFrameRate | unknown | No |
rendererOutputFrameRate | unknown | No |
frameLossRate | unknown | No |
packetLossRate | unknown | No |
rxStreamType | unknown | No |
totalFrozenTime | unknown | No |
frozenRate | unknown | No |
totalActiveTime | unknown | No |
publishDuration | unknown | No |
avSyncTimeMs | unknown | No |
FRtcEngineContext 0 method / 8 Property
| Property | Type | read-only |
|---|---|---|
eventHandler | unknown | No |
appId | unknown | No |
channelProfile | unknown | No |
audioScenario | unknown | No |
areaCode | unknown | No |
logConfig | unknown | No |
domainLimit | unknown | No |
autoRegisterAgoraExtensions | unknown | No |
FRtcImage 0 method / 7 Property
| Property | Type | read-only |
|---|---|---|
url | unknown | No |
x | unknown | No |
y | unknown | No |
width | unknown | No |
height | unknown | No |
zOrder | unknown | No |
alpha | unknown | No |
FRtcStats 0 method / 24 Property
| Property | Type | read-only |
|---|---|---|
duration | unknown | No |
txBytes | unknown | No |
rxBytes | unknown | No |
txAudioBytes | unknown | No |
txVideoBytes | unknown | No |
rxAudioBytes | unknown | No |
rxVideoBytes | unknown | No |
txKBitRate | unknown | No |
rxKBitRate | unknown | No |
rxAudioKBitRate | unknown | No |
txAudioKBitRate | unknown | No |
rxVideoKBitRate | unknown | No |
txVideoKBitRate | unknown | No |
lastmileDelay | unknown | No |
txPacketLossRate | unknown | No |
rxPacketLossRate | unknown | No |
userCount | unknown | No |
cpuAppUsage | unknown | No |
cpuTotalUsage | unknown | No |
connectTimeMs | unknown | No |
gatewayRtt | unknown | No |
memoryAppUsageRatio | unknown | No |
memoryTotalUsageRatio | unknown | No |
memoryAppUsageInKbytes | unknown | No |
FScreenAudioParameters 0 method / 3 Property
| Property | Type | read-only |
|---|---|---|
sampleRate | unknown | No |
channels | unknown | No |
captureSignalVolume | unknown | No |
FScreenCaptureConfiguration 0 method / 6 Property
| Property | Type | read-only |
|---|---|---|
isCaptureWindow | unknown | No |
displayId | unknown | No |
screenRect | unknown | No |
windowId | unknown | No |
params | unknown | No |
regionRect | unknown | No |
FScreenCaptureParameters 0 method / 10 Property
| Property | Type | read-only |
|---|---|---|
dimensions | unknown | No |
frameRate | unknown | No |
bitrate | unknown | No |
captureMouseCursor | unknown | No |
windowFocus | unknown | No |
excludeWindowList | unknown | No |
enableHighLight | unknown | No |
highLightColor | unknown | No |
highLightWidth | unknown | No |
excludeWindowCount | unknown | No |
FScreenCaptureParameters2 0 method / 4 Property
| Property | Type | read-only |
|---|---|---|
captureAudio | unknown | No |
audioParams | unknown | No |
captureVideo | unknown | No |
videoParams | unknown | No |
FScreenCaptureSourceInfo 0 method / 11 Property
| Property | Type | read-only |
|---|---|---|
type | unknown | No |
sourceId | unknown | No |
sourceName | unknown | No |
thumbImage | unknown | No |
iconImage | unknown | No |
processPath | unknown | No |
sourceTitle | unknown | No |
primaryMonitor | unknown | No |
position | unknown | No |
minimizeWindow | unknown | No |
sourceDisplayId | unknown | No |
FScreenVideoParameters 0 method / 4 Property
| Property | Type | read-only |
|---|---|---|
dimensions | unknown | No |
frameRate | unknown | No |
bitrate | unknown | No |
contentHint | unknown | No |
FSegmentationProperty 0 method / 2 Property
| Property | Type | read-only |
|---|---|---|
modelType | unknown | No |
greenCapacity | unknown | No |
FSimulcastStreamConfig 0 method / 3 Property
| Property | Type | read-only |
|---|---|---|
dimensions | unknown | No |
kBitrate | unknown | No |
framerate | unknown | No |
FSrcInfo 0 method / 2 Property
| Property | Type | read-only |
|---|---|---|
bitrateInKbps | unknown | No |
name | unknown | No |
FThumbImageBuffer 0 method / 4 Property
| Property | Type | read-only |
|---|---|---|
buffer | i | No |
length | unknown | No |
width | unknown | No |
height | unknown | No |
FTranscodingUser 0 method / 8 Property
| Property | Type | read-only |
|---|---|---|
uid | unknown | No |
x | unknown | No |
y | unknown | No |
width | unknown | No |
height | unknown | No |
zOrder | unknown | No |
alpha | unknown | No |
audioChannel | unknown | No |
FTranscodingVideoStream 0 method / 11 Property
| Property | Type | read-only |
|---|---|---|
sourceType | unknown | No |
remoteUserUid | unknown | No |
imageUrl | unknown | No |
mediaPlayerId | unknown | No |
x | unknown | No |
y | unknown | No |
width | unknown | No |
height | unknown | No |
zOrder | unknown | No |
alpha | unknown | No |
mirror | unknown | No |
FUABT_AdvanceOptions 0 method / 3 Property
| Property | Type | read-only |
|---|---|---|
encodingPreference | unknown | No |
compressionPreference | unknown | No |
encodeAlpha | unknown | No |
FUABT_FaceShapeAreaOptions 0 method / 2 Property
| Property | Type | read-only |
|---|---|---|
shapeArea | unknown | No |
shapeIntensity | unknown | No |
FUABT_FaceShapeBeautyOptions 0 method / 2 Property
| Property | Type | read-only |
|---|---|---|
shapeStyle | unknown | No |
styleIntensity | unknown | No |
FUABT_FilterEffectOptions 1 method / 1 Property
path(): unknownMethod detail: 1 / 1 (parameters, returns, errors)
| Method | Parameters | Returns | Errors |
|---|---|---|---|
path | — | unknown | Error code index |
| Property | Type | read-only |
|---|---|---|
strength | unknown | No |
FUABT_LowlightEnhanceOptions 0 method / 2 Property
| Property | Type | read-only |
|---|---|---|
level | unknown | No |
mode | unknown | No |
FUABT_RtcConnection 0 method / 2 Property
| Property | Type | read-only |
|---|---|---|
channelId | unknown | No |
localUid | unknown | No |
FUABT_SnapshotConfig 0 method / 2 Property
| Property | Type | read-only |
|---|---|---|
filePath | unknown | No |
position | unknown | No |
FUABT_VideoDenoiserOptions 0 method / 2 Property
| Property | Type | read-only |
|---|---|---|
level | unknown | No |
mode | unknown | No |
FUABT_VideoDimensions 0 method / 2 Property
| Property | Type | read-only |
|---|---|---|
width | unknown | No |
height | unknown | No |
FUABT_VideoEncoderConfiguration 0 method / 9 Property
| Property | Type | read-only |
|---|---|---|
dimensions | unknown | No |
codecType | unknown | No |
frameRate | unknown | No |
bitrate | unknown | No |
minBitrate | unknown | No |
orientationMode | unknown | No |
degradationPreference | unknown | No |
mirrorMode | unknown | No |
advanceOptions | unknown | No |
FUplinkNetworkInfo 0 method / 1 Property
| Property | Type | read-only |
|---|---|---|
video_encoder_target_bitrate_bps | unknown | No |
FUserInfo 0 method / 2 Property
| Property | Type | read-only |
|---|---|---|
uid | unknown | No |
userAccount | unknown | No |
FVideoCanvas 1 method / 10 Property
view(): unknownMethod detail: 1 / 1 (parameters, returns, errors)
| Method | Parameters | Returns | Errors |
|---|---|---|---|
view | — | unknown | Error code index |
| Property | Type | read-only |
|---|---|---|
uid | unknown | No |
subviewUid | unknown | No |
renderMode | unknown | No |
mirrorMode | unknown | No |
sourceType | unknown | No |
setupMode | unknown | No |
cropArea | unknown | No |
backgroundColor | unknown | No |
enableAlphaMask | unknown | No |
position | unknown | No |
FVideoFormat 0 method / 3 Property
| Property | Type | read-only |
|---|---|---|
width | unknown | No |
height | unknown | No |
fps | unknown | No |
FVideoLayout 0 method / 8 Property
| Property | Type | read-only |
|---|---|---|
channelId | unknown | No |
uid | unknown | No |
strUid | unknown | No |
x | unknown | No |
y | unknown | No |
width | unknown | No |
height | unknown | No |
videoState | unknown | No |
FVideoRenderingTracingInfo 0 method / 7 Property
| Property | Type | read-only |
|---|---|---|
elapsedTime | unknown | No |
start2JoinChannel | unknown | No |
join2JoinSuccess | unknown | No |
joinSuccess2RemoteJoined | unknown | No |
remoteJoined2SetView | unknown | No |
remoteJoined2UnmuteVideo | unknown | No |
remoteJoined2PacketReceived | unknown | No |
FVideoSubscriptionOptions 0 method / 2 Property
| Property | Type | read-only |
|---|---|---|
type | unknown | No |
encodedFrameOnly | unknown | No |
FVirtualBackgroundSource 0 method / 4 Property
| Property | Type | read-only |
|---|---|---|
background_source_type | unknown | No |
color | unknown | No |
source | unknown | No |
blur_degree | unknown | No |
FWatermarkOptions 0 method / 5 Property
| Property | Type | read-only |
|---|---|---|
visibleInPreview | unknown | No |
positionInLandscapeMode | unknown | No |
positionInPortraitMode | unknown | No |
watermarkRatio | unknown | No |
mode | unknown | No |
FWatermarkRatio 0 method / 3 Property
| Property | Type | read-only |
|---|---|---|
xRatio | unknown | No |
yRatio | unknown | No |
widthRatio | unknown | No |
IAudioDeviceCollection 9 method / 0 Property
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&): intMethod detail: 9 / 9 (parameters, returns, errors)
| Method | Parameters | Returns | Errors |
|---|---|---|---|
GetApplicationVolume | volume: int& | int | Error code index |
GetCount | — | int | Error code index |
GetDefaultDevice | deviceName: FString&, deviceId: FString& | int | Error code index |
GetDevice | index: int, deviceName: FString&, deviceId: FString& | int | Error code index |
IsApplicationMute | mute: bool | int | Error code index |
Release | — | void | Error code index |
SetApplicationMute | mute: bool | int | Error code index |
SetApplicationVolume | volume: int | int | Error code index |
SetDevice | deviceId: const FString& | int | Error code index |
IAudioDeviceManager 24 method / 0 Property
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(): intMethod detail: 24 / 24 (parameters, returns, errors)
| Method | Parameters | Returns | Errors |
|---|---|---|---|
EnumeratePlaybackDevices | — | UAudioDeviceCollection* | Error code index |
EnumerateRecordingDevices | — | UAudioDeviceCollection* | Error code index |
FollowSystemPlaybackDevice | enable: bool | int | Error code index |
FollowSystemRecordingDevice | enable: bool | int | Error code index |
GetPlaybackDevice | deviceId: FString& | int | Error code index |
GetPlaybackDeviceInfo | deviceId: FString&, deviceName: FString&, deviceTypeName: FString& | int | Error code index |
GetPlaybackDeviceMute | mute: bool& | int | Error code index |
GetRecordingDevice | deviceId: FString& | int | Error code index |
GetRecordingDeviceInfo | deviceId: FString&, deviceName: FString&, deviceTypeName: FString& | int | Error code index |
GetRecordingDeviceMute | mute: bool& | int | Error code index |
GetRecordingDeviceVolume | volume: int& | int | Error code index |
Release | — | void | Error code index |
SetPlaybackDevice | deviceId: const FString& | int | Error code index |
SetPlaybackDeviceMute | mute: bool | int | Error code index |
SetPlaybackDeviceVolume | volume: int | int | Error code index |
SetRecordingDevice | deviceId: const FString& | int | Error code index |
SetRecordingDeviceMute | mute: bool | int | Error code index |
SetRecordingDeviceVolume | volume: int | int | Error code index |
StartAudioDeviceLoopbackTest | indicationInterval: int | int | Error code index |
StartPlaybackDeviceTest | testAudioFilePath: const FString& | int | Error code index |
StartRecordingDeviceTest | indicationInterval: int | int | Error code index |
StopAudioDeviceLoopbackTest | — | int | Error code index |
StopPlaybackDeviceTest | — | int | Error code index |
StopRecordingDeviceTest | — | int | Error code index |
IMediaPlayer 34 method / 0 Property
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&): intMethod detail: 34 / 34 (parameters, returns, errors)
| Method | Parameters | Returns | Errors |
|---|---|---|---|
AdjustPlayoutVolume | volume: int | int | Error code index |
AdjustPublishSignalVolume | volume: int | int | Error code index |
GetDuration | duration: int64& | int | Error code index |
GetMediaPlayerId | — | int | Error code index |
GetMute | muted: bool& | int | Error code index |
GetPlayPosition | pos: int64& | int | Error code index |
GetPlaySrc | — | FString | Error code index |
GetPlayoutVolume | volume: int& | int | Error code index |
GetPublishSignalVolume | volume: int& | int | Error code index |
GetState | — | EMEDIA_PLAYER_STATE | Error code index |
GetStreamCount | count: int64& | int | Error code index |
GetStreamInfo | index: int64, info: FPlayerStreamInfo& | int | Error code index |
Mute | muted: bool | int | Error code index |
Open | url: const FString&, startPos: int64 | int | Error code index |
OpenWithMediaSource | source: const FAgoraMediaSource& | int | Error code index |
Pause | — | int | Error code index |
Play | — | int | Error code index |
PlayPreloadedSrc | src: const FString& | int | Error code index |
PreloadSrc | src: const FString&, startPos: int64 | int | Error code index |
Resume | — | int | Error code index |
Seek | newPos: int64 | int | Error code index |
SelectAudioTrack | index: int | int | Error code index |
SelectMultiAudioTrack | playoutTrackIndex: int, publishTrackIndex: int | int | Error code index |
SetAudioDualMonoMode | mode: EAUDIO_DUAL_MONO_MODE | int | Error code index |
SetAudioPitch | pitch: int | int | Error code index |
SetLoopCount | loopCount: int | int | Error code index |
SetPlaybackSpeed | speed: int | int | Error code index |
SetPlayerOptionWithInt | key: const FString&, value: int | int | Error code index |
SetPlayerOptionWithString | key: const FString&, value: const FString& | int | Error code index |
SetRenderMode | renderMode: ERENDER_MODE_TYPE | int | Error code index |
SetView | view: int64 | int | Error code index |
Stop | — | int | Error code index |
SwitchSrc | src: const FString&, syncPts?: bool | int | Error code index |
UnloadSrc | src: const FString& | int | Error code index |
IMediaPlayerSourceObserver 11 method / 0 Property
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): voidMethod detail: 11 / 11 (parameters, returns, errors)
| Method | Parameters | Returns | Errors |
|---|---|---|---|
OnAudioVolumeIndication | volume: int | void | Error code index |
OnMetaData | Data: const FString& | void | Error code index |
OnPlayBufferUpdated | playCachedBuffer: int64 | void | Error code index |
OnPlayerCacheStats | stats: const FCacheStatistics& | void | Error code index |
OnPlayerEvent | eventCode: EMEDIA_PLAYER_EVENT, elapsedTime: int64, message: const FString& | void | Error code index |
OnPlayerInfoUpdated | info: const FPlayerUpdatedInfo& | void | Error code index |
OnPlayerPlaybackStats | stats: const FPlayerPlaybackStats& | void | Error code index |
OnPlayerSourceStateChanged | state: EMEDIA_PLAYER_STATE, ec: FENUMWRAP_MEDIA_PLAYER_REASON | void | Error code index |
OnPlayerSrcInfoChanged | from: const FSrcInfo&, to: const FSrcInfo& | void | Error code index |
OnPositionChanged | position_ms: int64, timestampMs: int64 | void | Error code index |
OnPreloadEvent | src: const FString&, event: EPLAYER_PRELOAD_EVENT | void | Error code index |
IRtcEngine 224 method / 0 Property
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&): intMethod detail: 224 / 224 (parameters, returns, errors)
| Method | Parameters | Returns | Errors |
|---|---|---|---|
AddVideoWatermark | watermarkUrl: const FString&, options: const FWatermarkOptions& | int | Error code index |
AdjustAudioMixingPlayoutVolume | volume: int | int | Error code index |
AdjustAudioMixingPublishVolume | volume: int | int | Error code index |
AdjustAudioMixingVolume | volume: int | int | Error code index |
AdjustLoopbackSignalVolume | volume: int | int | Error code index |
AdjustPlaybackSignalVolume | volume: int | int | Error code index |
AdjustRecordingSignalVolume | volume: int | int | Error code index |
AdjustUserPlaybackSignalVolume | uid: int64, volume: int | int | Error code index |
ClearVideoWatermarks | — | int | Error code index |
Complain | callId: const FString&, description: const FString& | int | Error code index |
ConfigRhythmPlayer | config: const FAgoraRhythmPlayerConfig& | int | Error code index |
CreateDataStream | streamId: int&, config: const FDataStreamConfig& | int | Error code index |
DisableAudio | — | int | Error code index |
DisableVideo | — | int | Error code index |
EnableAudio | — | int | Error code index |
EnableAudioVolumeIndication | interval: int, smooth: int, reportVad: bool | int | Error code index |
EnableCameraCenterStage | enabled: bool | int | Error code index |
EnableContentInspect | enabled: bool, config: const FContentInspectConfig& | int | Error code index |
EnableDualStreamMode | enabled: bool, streamConfig: const FSimulcastStreamConfig& | int | Error code index |
EnableEncryption | enabled: bool, config: const FEncryptionConfig& | int | Error code index |
EnableExtension | provider: const FString&, extension: const FString&, enable?: bool, type?: EMEDIA_SOURCE_TYPE | int | Error code index |
EnableFaceDetection | enabled: bool | int | Error code index |
EnableInEarMonitoring | enabled: bool, includeAudioFilters: int | int | Error code index |
EnableInstantMediaRendering | — | int | Error code index |
EnableLocalAudio | enabled: bool | int | Error code index |
EnableLocalVideo | enabled: bool | int | Error code index |
EnableLoopbackRecording | enabled: bool, deviceName: const FString& | int | Error code index |
EnableMultiCamera | enabled: bool, config: const FCameraCapturerConfiguration& | int | Error code index |
EnableSoundPositionIndication | enabled: bool | int | Error code index |
EnableVideo | — | int | Error code index |
EnableVideoImageSource | enable: bool, options: const FImageTrackOptions& | int | Error code index |
EnableVirtualBackground | enabled: bool, backgroundSource: FVirtualBackgroundSource, segproperty: FSegmentationProperty, type: EMEDIA_SOURCE_TYPE | int | Error code index |
EnableVoiceAITuner | enabled: bool, type: EVOICE_AI_TUNER_TYPE | int | Error code index |
EnableWebSdkInteroperability | enabled: bool | int | Error code index |
GetAgoraMediaPlayer | — | UAgoraBPuMediaPlayer* | Error code index |
GetAgoraRtcEngine | — | UAgoraBPuRtcEngine* | Error code index |
GetAudioDeviceInfo | deviceInfo: FDeviceInfo& | int | Error code index |
GetAudioMixingCurrentPosition | — | int | Error code index |
GetAudioMixingDuration | — | int | Error code index |
GetAudioMixingPlayoutVolume | — | int | Error code index |
GetAudioMixingPublishVolume | — | int | Error code index |
GetAudioTrackCount | — | int | Error code index |
GetCallId | callId: FString& | int | Error code index |
GetCameraMaxZoomFactor | — | float | Error code index |
GetConnectionState | — | ECONNECTION_STATE_TYPE | Error code index |
GetEffectCurrentPosition | soundId: int | int | Error code index |
GetEffectDuration | filePath: const FString& | int | Error code index |
GetEffectsVolume | — | int | Error code index |
GetErrorDescription | code: int | FString | Error code index |
GetExtensionProperty | provider: const FString&, extension: const FString&, ExtensionInfo: const FExtensionInfo&, key: const FString&, value: FString& | int | Error code index |
GetFaceShapeAreaOptions | shapeArea: EUABT_FACE_SHAPE_AREA, options: FUABT_FaceShapeAreaOptions&, type?: EUABT_MEDIA_SOURCE_TYPE | int | Error code index |
GetFaceShapeBeautyOptions | options: FUABT_FaceShapeBeautyOptions&, type?: EUABT_MEDIA_SOURCE_TYPE | int | Error code index |
GetNetworkType | — | int | Error code index |
GetNtpWallTimeInMs | — | FString | Error code index |
GetScreenCaptureSources | thumbSize: const FSIZE&, iconSize: const FSIZE&, includeScreen: bool | UIScreenCaptureSourceList* | Error code index |
GetUserInfoByUid | uid: int64, userInfo: FUserInfo& | int | Error code index |
GetUserInfoByUserAccount | userAccount: const FString&, userInfo: FUserInfo& | int | Error code index |
GetVersion | — | FString | Error code index |
GetVolumeOfEffect | soundId: int | int | Error code index |
Initialize | context: const FRtcEngineContext& | int | Error code index |
IsCameraAutoExposureFaceModeSupported | — | bool | Error code index |
IsCameraAutoFocusFaceModeSupported | — | bool | Error code index |
IsCameraCenterStageSupported | — | bool | Error code index |
IsCameraExposurePositionSupported | — | bool | Error code index |
IsCameraExposureSupported | — | bool | Error code index |
IsCameraFaceDetectSupported | — | bool | Error code index |
IsCameraFocusSupported | — | bool | Error code index |
IsCameraTorchSupported | — | bool | Error code index |
IsCameraZoomSupported | — | bool | Error code index |
IsFeatureAvailableOnDevice | type: EFeatureType | bool | Error code index |
IsSpeakerphoneEnabled | — | bool | Error code index |
JoinChannelWithOptions | token: const FString&, channelId: const FString&, uid: int64, options: const FChannelMediaOptions& | int | Error code index |
JoinChannelWithUserAccount | token: const FString&, channelId: const FString&, userAccount: const FString&, options: const FChannelMediaOptions& | int | Error code index |
LeaveChannelWithOptions | options: const FLeaveChannelOptions& | int | Error code index |
LoadExtensionProvider | path: const FString&, unload_after_use: bool | int | Error code index |
MuteAllRemoteAudioStreams | mute: bool | int | Error code index |
MuteAllRemoteVideoStreams | mute: bool | int | Error code index |
MuteLocalAudioStream | mute: bool | int | Error code index |
MuteLocalVideoStream | mute: bool | int | Error code index |
MuteRecordingSignal | mute: bool | int | Error code index |
MuteRemoteAudioStream | uid: int64, mute: bool | int | Error code index |
MuteRemoteVideoStream | uid: int64, mute: bool | int | Error code index |
PauseAllChannelMediaRelay | — | int | Error code index |
PauseAllEffects | — | int | Error code index |
PauseAudioMixing | — | int | Error code index |
PauseEffect | soundId: int | int | Error code index |
PlayAllEffects | loopCount: int, pitch: float, pan: float, gain: int, publish: bool | int | Error code index |
PlayEffect | soundId: int, filePath: const FString&, loopCount: int, pitch: float, pan: float, gain: int, publish: bool, startPos: int | int | Error code index |
PreloadChannel | token: const FString&, channelId: const FString&, uid: int64 | int | Error code index |
PreloadChannelWithUserAccount | token: const FString&, channelId: const FString&, userAccount: const FString& | int | Error code index |
PreloadEffect | soundId: int, filePath: const FString&, startPos: int | int | Error code index |
QueryCameraFocalLengthCapability | focalLengthInfos: const TArray& | int | Error code index |
QueryCodecCapability | codecInfo: TArray&, QuerySize?: int | int | Error code index |
QueryDeviceScore | — | int | Error code index |
QueryScreenCaptureCapability | — | int | Error code index |
Rate | callId: const FString&, rating: int, description: const FString& | int | Error code index |
RegisterExtension | provider: const FString&, extension: const FString&, type: EMEDIA_SOURCE_TYPE | int | Error code index |
RegisterLocalUserAccount | appId: const FString&, userAccount: const FString& | int | Error code index |
Release | sync?: bool | void | Error code index |
RenewToken | token: const FString& | int | Error code index |
ResumeAllChannelMediaRelay | — | int | Error code index |
ResumeAllEffects | — | int | Error code index |
ResumeAudioMixing | — | int | Error code index |
ResumeEffect | soundId: int | int | Error code index |
SelectAudioTrack | index: int | int | Error code index |
SendCustomReportMessage | id: const FString&, category: const FString&, event: const FString&, label: const FString&, value: int | int | Error code index |
SendStreamMessage | streamId: int, data: const FString& | int | Error code index |
SetAINSMode | enabled: bool, mode: EAUDIO_AINS_MODE | int | Error code index |
SetAVSyncSource | channelId: const FString&, uid: int64 | int | Error code index |
SetAdvancedAudioOptions | options: const FAdvancedAudioOptions& | int | Error code index |
SetAudioEffectParameters | preset: FENUMWRAP_AUDIO_EFFECT_PRESET, param1: int, param2: int | int | Error code index |
SetAudioEffectPreset | preset: FENUMWRAP_AUDIO_EFFECT_PRESET | int | Error code index |
SetAudioMixingDualMonoMode | mode: EAUDIO_MIXING_DUAL_MONO_MODE | int | Error code index |
SetAudioMixingPitch | pitch: int | int | Error code index |
SetAudioMixingPlaybackSpeed | speed: int | int | Error code index |
SetAudioMixingPosition | pos: int | int | Error code index |
SetAudioProfileAndScenario | profile?: EAUDIO_PROFILE_TYPE, scenario?: EAUDIO_SCENARIO_TYPE | int | Error code index |
SetAudioScenario | scenario?: EAUDIO_SCENARIO_TYPE | int | Error code index |
SetAudioSessionOperationRestriction | restriction: EAUDIO_SESSION_OPERATION_RESTRICTION | int | Error code index |
SetBeautyEffectOptions | enabled: bool, options: const FBeautyOptions&, type: EMEDIA_SOURCE_TYPE | int | Error code index |
SetCameraAutoExposureFaceModeEnabled | enabled: bool | int | Error code index |
SetCameraAutoFocusFaceModeEnabled | enabled: bool | int | Error code index |
SetCameraCapturerConfiguration | config: const FCameraCapturerConfiguration& | int | Error code index |
SetCameraDeviceOrientation | type: EVIDEO_SOURCE_TYPE, orientation: FENUMWRAP_VIDEO_ORIENTATION | int | Error code index |
SetCameraExposureFactor | factor: float | int | Error code index |
SetCameraExposurePosition | positionXinView: float, positionYinView: float | int | Error code index |
SetCameraFocusPositionInPreview | positionX: float, positionY: float | int | Error code index |
SetCameraStabilizationMode | mode: FENUMWRAP_CAMERA_STABILIZATION_MODE | int | Error code index |
SetCameraTorchOn | isOn: bool | int | Error code index |
SetCameraZoomFactor | factor: float | int | Error code index |
SetChannelProfile | profile: ECHANNEL_PROFILE_TYPE | int | Error code index |
SetClientRole | options: FClientRoleOptions, clientroletype?: ECLIENT_ROLE_TYPE | int | Error code index |
SetCloudProxy | proxyType: ECLOUD_PROXY_TYPE | int | Error code index |
SetColorEnhanceOptions | enabled: bool, options: const FColorEnhanceOptions&, type: EMEDIA_SOURCE_TYPE | int | Error code index |
SetDefaultAudioRouteToSpeakerphone | defaultToSpeaker: bool | int | Error code index |
SetDualStreamMode | mode: FENUMWRAP_SIMULCAST_STREAM_MODE, streamConfig: const FSimulcastStreamConfig& | int | Error code index |
SetEffectPosition | soundId: int, pos: int | int | Error code index |
SetEffectsVolume | volume: int | int | Error code index |
SetEnableSpeakerphone | speakerOn: bool | int | Error code index |
SetExtensionProperty | provider: const FString&, extension: const FString&, key: const FString&, value: const FString&, type?: EMEDIA_SOURCE_TYPE | int | Error code index |
SetExtensionProviderProperty | provider: const FString&, key: const FString&, value: const FString& | int | Error code index |
SetFaceShapeAreaOptions | options: const FUABT_FaceShapeAreaOptions&, type?: EUABT_MEDIA_SOURCE_TYPE | int | Error code index |
SetFaceShapeBeautyOptions | enabled: bool, options: const FUABT_FaceShapeBeautyOptions&, type?: EUABT_MEDIA_SOURCE_TYPE | int | Error code index |
SetFilterEffectOptions | enabled: bool, options: const FUABT_FilterEffectOptions&, type?: EUABT_MEDIA_SOURCE_TYPE | int | Error code index |
SetHeadphoneEQParameters | lowGain: int, highGain: int | int | Error code index |
SetHeadphoneEQPreset | preset: FENUMWRAP_HEADPHONE_EQUALIZER_PRESET | int | Error code index |
SetInEarMonitoringVolume | volume: int | int | Error code index |
SetLocalRenderMode | renderMode: ERENDER_MODE_TYPE, mirrorMode?: EVIDEO_MIRROR_MODE_TYPE | int | Error code index |
SetLocalRenderTargetFps | sourceType: EUABT_VIDEO_SOURCE_TYPE, targetFps: int | int | Error code index |
SetLocalVideoMirrorMode | mirrorMode: EVIDEO_MIRROR_MODE_TYPE | int | Error code index |
SetLocalVoiceEqualization | bandFrequency: EAUDIO_EQUALIZATION_BAND_FREQUENCY, bandGain: int | int | Error code index |
SetLocalVoiceFormant | formantRatio?: const FString& | int | Error code index |
SetLocalVoicePitch | pitch: float | int | Error code index |
SetLocalVoiceReverb | reverbKey: EAUDIO_REVERB_TYPE, value: int | int | Error code index |
SetLogFile | filePath: const FString& | int | Error code index |
SetLogFileSize | fileSizeInKBytes: int | int | Error code index |
SetLogFilter | filter: int | int | Error code index |
SetLogLevel | level: ELOG_LEVEL | int | Error code index |
SetLowlightEnhanceOptions | enabled: bool, options: const FUABT_LowlightEnhanceOptions&, type: EUABT_MEDIA_SOURCE_TYPE | int | Error code index |
SetParameters | parameters: const FString& | int | Error code index |
SetRemoteDefaultVideoStreamType | streamType: EVIDEO_STREAM_TYPE | int | Error code index |
SetRemoteRenderMode | uid: int64, renderMode: ERENDER_MODE_TYPE, mirrorMode: EVIDEO_MIRROR_MODE_TYPE | int | Error code index |
SetRemoteRenderTargetFps | targetFps: int | int | Error code index |
SetRemoteSubscribeFallbackOption | option: ESTREAM_FALLBACK_OPTIONS | int | Error code index |
SetRemoteVideoStreamType | uid: int64, streamType: EVIDEO_STREAM_TYPE | int | Error code index |
SetRemoteVoicePosition | uid: int64, pan: float, gain: float | int | Error code index |
SetScreenCaptureContentHint | contentHint: EVIDEO_CONTENT_HINT | int | Error code index |
SetScreenCaptureScenario | screenScenario: ESCREEN_SCENARIO_TYPE | int | Error code index |
SetSubscribeAudioAllowlist | uidList: TArray, uidNumber: int | int | Error code index |
SetSubscribeAudioBlocklist | uidList: TArray, uidNumber: int | int | Error code index |
SetSubscribeVideoAllowlist | uidList: TArray, uidNumber: int | int | Error code index |
SetSubscribeVideoBlocklist | uidList: TArray, uidNumber: int | int | Error code index |
SetVideoDenoiserOptions | enabled: bool, options: const FUABT_VideoDenoiserOptions&, type: EUABT_MEDIA_SOURCE_TYPE | int | Error code index |
SetVideoEncoderConfiguration | config: const FVideoEncoderConfiguration& | int | Error code index |
SetVideoScenario | scenarioType: EVIDEO_APPLICATION_SCENARIO_TYPE | int | Error code index |
SetVoiceBeautifierParameters | preset: FENUMWRAP_VOICE_BEAUTIFIER_PRESET, param1: int, param2: int | int | Error code index |
SetVoiceBeautifierPreset | preset: FENUMWRAP_VOICE_BEAUTIFIER_PRESET | int | Error code index |
SetVoiceConversionPreset | preset: FENUMWRAP_VOICE_CONVERSION_PRESET | int | Error code index |
SetVolumeOfEffect | soundId: int, volume: int | int | Error code index |
SetupLocalVideo | canvas: const FVideoCanvas& | int | Error code index |
SetupRemoteVideo | canvas: const FVideoCanvas& | int | Error code index |
StartAudioMixing | filePath: const FString&, loopback: bool, cycle: int, startPos?: int | int | Error code index |
StartAudioRecording | config: const FAudioRecordingConfiguration& | int | Error code index |
StartCameraCapture | sourceType: EVIDEO_SOURCE_TYPE, config: const FCameraCapturerConfiguration& | int | Error code index |
StartEchoTest | config: const FEchoTestConfiguration& | int | Error code index |
StartLastmileProbeTest | config: const FLastmileProbeConfig& | int | Error code index |
StartLocalVideoTranscoder | config: const FLocalTranscoderConfiguration& | int | Error code index |
StartMediaRenderingTracing | — | int | Error code index |
StartOrUpdateChannelMediaRelay | configuration: const FChannelMediaRelayConfiguration& | int | Error code index |
StartPreview | sourceType?: EVIDEO_SOURCE_TYPE | int | Error code index |
StartRhythmPlayer | sound1: const FString&, sound2: const FString&, config: const FAgoraRhythmPlayerConfig& | int | Error code index |
StartRtmpStreamWithTranscoding | url: const FString&, transcoding: const FLiveTranscoding& | int | Error code index |
StartRtmpStreamWithoutTranscoding | url: const FString& | int | Error code index |
StartScreenCapture | captureParams: const FScreenCaptureParameters2& | int | Error code index |
StartScreenCaptureByDisplayId | displayId: int64, regionRect: const FRectangle&, captureParams: const FScreenCaptureParameters& | int | Error code index |
StartScreenCaptureByScreenRect | screenRect: const FRectangle&, regionRect: const FRectangle&, captureParams: const FScreenCaptureParameters& | int | Error code index |
StartScreenCaptureBySourceType | sourceType: EVIDEO_SOURCE_TYPE, config: const FScreenCaptureConfiguration& | int | Error code index |
StartScreenCaptureByWindowId | windowId: int64, regionRect: const FRectangle&, captureParams: const FScreenCaptureParameters& | int | Error code index |
StopAllEffects | — | int | Error code index |
StopAudioMixing | — | int | Error code index |
StopAudioRecording | — | int | Error code index |
StopCameraCapture | sourceType: EVIDEO_SOURCE_TYPE | int | Error code index |
StopChannelMediaRelay | — | int | Error code index |
StopEchoTest | — | int | Error code index |
StopEffect | soundId: int | int | Error code index |
StopLastmileProbeTest | — | int | Error code index |
StopLocalVideoTranscoder | — | int | Error code index |
StopPreview | sourceType?: EVIDEO_SOURCE_TYPE | int | Error code index |
StopRhythmPlayer | — | int | Error code index |
StopRtmpStream | url: const FString& | int | Error code index |
StopScreenCapture | — | int | Error code index |
StopScreenCaptureBySourceType | sourceType: EVIDEO_SOURCE_TYPE | int | Error code index |
SwitchCamera | — | int | Error code index |
TakeSnapshot | uid: int64, filePath: const FString& | int | Error code index |
TakeSnapshotWithConfig | uid: int64, config: const FUABT_SnapshotConfig& | int | Error code index |
UnloadAllEffects | — | int | Error code index |
UnloadEffect | soundId: int | int | Error code index |
UpdateChannelMediaOptions | options: const FChannelMediaOptions& | int | Error code index |
UpdateLocalTranscoderConfiguration | config: const FLocalTranscoderConfiguration& | int | Error code index |
UpdatePreloadChannelToken | token: const FString& | int | Error code index |
UpdateRtmpTranscoding | transcoding: const FLiveTranscoding& | int | Error code index |
UpdateScreenCapture | captureParams: const FScreenCaptureParameters2& | int | Error code index |
UpdateScreenCaptureParameters | captureParams: const FScreenCaptureParameters& | int | Error code index |
UpdateScreenCaptureRegion | regionRect: const FRectangle& | int | Error code index |
IRtcEngineEventHandler 83 method / 0 Property
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): voidMethod detail: 83 / 83 (parameters, returns, errors)
| Method | Parameters | Returns | Errors |
|---|---|---|---|
OnActiveSpeaker | uid: int64 | void | Error code index |
OnAudioDeviceStateChanged | deviceId: const FString&, deviceType: int, deviceState: int | void | Error code index |
OnAudioDeviceVolumeChanged | deviceType: FENUMWRAP_MEDIA_DEVICE_TYPE, volume: int, muted: bool | void | Error code index |
OnAudioEffectFinished | soundId: int | void | Error code index |
OnAudioMixingFinished | — | void | Error code index |
OnAudioMixingPositionChanged | position: int64 | void | Error code index |
OnAudioMixingStateChanged | state: FENUMWRAP_AUDIO_MIXING_STATE_TYPE, reason: FENUMWRAP_AUDIO_MIXING_REASON_TYPE | void | Error code index |
OnAudioPublishStateChanged | channel: const FString&, oldState: ESTREAM_PUBLISH_STATE, newState: ESTREAM_PUBLISH_STATE, elapseSinceLastState: int | void | Error code index |
OnAudioQuality | uid: int64, quality: int, delay: int, lost: int | void | Error code index |
OnAudioRoutingChanged | routing: int | void | Error code index |
OnAudioSubscribeStateChanged | channel: const FString&, uid: int64, oldState: ESTREAM_SUBSCRIBE_STATE, newState: ESTREAM_SUBSCRIBE_STATE, elapseSinceLastState: int | void | Error code index |
OnAudioVolumeIndication | speakers: const TArray&, totalVolume: int | void | Error code index |
OnCameraExposureAreaChanged | x: int, y: int, width: int, height: int | void | Error code index |
OnCameraFocusAreaChanged | x: int, y: int, width: int, height: int | void | Error code index |
OnCameraReady | — | void | Error code index |
OnChannelMediaRelayStateChanged | state: int, code: int | void | Error code index |
OnClientRoleChangeFailed | reason: ECLIENT_ROLE_CHANGE_FAILED_REASON, currentRole: ECLIENT_ROLE_TYPE | void | Error code index |
OnClientRoleChanged | oldRole: ECLIENT_ROLE_TYPE, newRole: ECLIENT_ROLE_TYPE, newRoleOptions: const FClientRoleOptions& | void | Error code index |
OnConnectionBanned | — | void | Error code index |
OnConnectionInterrupted | — | void | Error code index |
OnConnectionLost | — | void | Error code index |
OnConnectionStateChanged | state: ECONNECTION_STATE_TYPE, reason: ECONNECTION_CHANGED_REASON_TYPE | void | Error code index |
OnEncryptionError | errorType: EENCRYPTION_ERROR_TYPE | void | Error code index |
OnError | error: int, msg: const FString& | void | Error code index |
OnExtensionErrorWithContext | context: const FExtensionContext&, error: int, message: const FString& | void | Error code index |
OnExtensionEventWithContext | context: const FExtensionContext&, key: const FString&, value: const FString& | void | Error code index |
OnExtensionStartedWithContext | context: const FExtensionContext& | void | Error code index |
OnExtensionStoppedWithContext | context: const FExtensionContext& | void | Error code index |
OnFacePositionChanged | imageWidth: int, imageHeight: int, vecRectangle: const TArray&, vecDistance: const TArray&, numFaces: int | void | Error code index |
OnFirstLocalAudioFramePublished | elapsed: int | void | Error code index |
OnFirstLocalVideoFrame | source: EVIDEO_SOURCE_TYPE, width: int, height: int, elapsed: int | void | Error code index |
OnFirstLocalVideoFramePublished | source: EVIDEO_SOURCE_TYPE, elapsed: int | void | Error code index |
OnFirstRemoteAudioDecoded | uid: int64, elapsed: int | void | Error code index |
OnFirstRemoteAudioFrame | uid: int64, elapsed: int | void | Error code index |
OnFirstRemoteVideoDecoded | uid: int64, width: int, height: int, elapsed: int | void | Error code index |
OnFirstRemoteVideoFrame | uid: int64, width: int, height: int, elapsed: int | void | Error code index |
OnJoinChannelSuccess | Channel: const FString&, Uid: int64, Elapsed: int | void | Error code index |
OnLastmileProbeResult | result: const FLastmileProbeResult& | void | Error code index |
OnLastmileQuality | quality: int | void | Error code index |
OnLeaveChannel | stats: const FRtcStats& | void | Error code index |
OnLocalAudioStateChanged | state: ELOCAL_AUDIO_STREAM_STATE, reason: ELOCAL_AUDIO_STREAM_REASON | void | Error code index |
OnLocalAudioStats | stats: const FLocalAudioStats& | void | Error code index |
OnLocalUserRegistered | uid: int64, userAccount: const FString& | void | Error code index |
OnLocalVideoStateChanged | source: EVIDEO_SOURCE_TYPE, state: ELOCAL_VIDEO_STREAM_STATE, reason: ELOCAL_VIDEO_STREAM_REASON | void | Error code index |
OnLocalVideoStats | source: EVIDEO_SOURCE_TYPE, stats: const FLocalVideoStats& | void | Error code index |
OnLocalVideoTranscoderError | stream: const FTranscodingVideoStream&, error: EVIDEO_TRANSCODER_ERROR | void | Error code index |
OnNetworkQuality | uid: int64, txQuality: int, rxQuality: int | void | Error code index |
OnNetworkTypeChanged | type: FENUMWRAP_NETWORK_TYPE | void | Error code index |
OnPermissionError | permissionType: EPERMISSION_TYPE | void | Error code index |
OnProxyConnected | channel: const FString&, uid: int64, proxyType: EPROXY_TYPE, localProxyIp: const FString&, elapsed: int | void | Error code index |
OnRejoinChannelSuccess | channel: const FString&, uid: int64, elapsed: int | void | Error code index |
OnRemoteAudioStateChanged | uid: int64, state: EREMOTE_AUDIO_STATE, reason: EREMOTE_AUDIO_STATE_REASON, elapsed: int | void | Error code index |
OnRemoteAudioStats | stats: const FRemoteAudioStats& | void | Error code index |
OnRemoteAudioTransportStats | uid: int64, delay: int, lost: int, rxKBitRate: int | void | Error code index |
OnRemoteSubscribeFallbackToAudioOnly | uid: int64, isFallbackOrRecover: bool | void | Error code index |
OnRemoteVideoStateChanged | uid: int64, state: EREMOTE_VIDEO_STATE, reason: EREMOTE_VIDEO_STATE_REASON, elapsed: int | void | Error code index |
OnRemoteVideoStats | stats: const FRemoteVideoStats& | void | Error code index |
OnRemoteVideoTransportStats | uid: int64, delay: int, lost: int, rxKBitRate: int | void | Error code index |
OnRequestToken | — | void | Error code index |
OnRhythmPlayerStateChanged | state: FENUMWRAP_RHYTHM_PLAYER_STATE_TYPE, reason: FENUMWRAP_RHYTHM_PLAYER_REASON | void | Error code index |
OnRtcStats | stats: const FRtcStats& | void | Error code index |
OnRtmpStreamingEvent | url: const FString&, eventCode: ERTMP_STREAMING_EVENT | void | Error code index |
OnRtmpStreamingStateChanged | url: const FString&, state: ERTMP_STREAM_PUBLISH_STATE, reason: ERTMP_STREAM_PUBLISH_REASON | void | Error code index |
OnSnapshotTaken | uid: int64, filePath: const FString&, width: int, height: int, errCode: int | void | Error code index |
OnStreamMessage | uid: int64, streamId: int, data: const FString&, length: int, sentTs: int64 | void | Error code index |
OnStreamMessageError | uid: int64, streamId: int, code: int, missed: int, cached: int | void | Error code index |
OnTokenPrivilegeWillExpire | token: const FString& | void | Error code index |
OnTranscodedStreamLayoutInfo | uid: int64, width: int, height: int, layoutCount: int, layoutlist: const TArray& | void | Error code index |
OnTranscodingUpdated | — | void | Error code index |
OnUplinkNetworkInfoUpdated | info: const FUplinkNetworkInfo& | void | Error code index |
OnUserEnableLocalVideo | uid: int64, enabled: bool | void | Error code index |
OnUserEnableVideo | uid: int64, enabled: bool | void | Error code index |
OnUserInfoUpdated | uid: int64, info: const FUserInfo& | void | Error code index |
OnUserJoined | uid: int64, elapsed: int | void | Error code index |
OnUserMuteAudio | uid: int64, muted: bool | void | Error code index |
OnUserMuteVideo | uid: int64, muted: bool | void | Error code index |
OnUserOffline | uid: int64, reason: EUSER_OFFLINE_REASON_TYPE | void | Error code index |
OnVideoDeviceStateChanged | deviceId: const FString&, deviceType: int, deviceState: int | void | Error code index |
OnVideoPublishStateChanged | source: EVIDEO_SOURCE_TYPE, channel: const FString&, oldState: ESTREAM_PUBLISH_STATE, newState: ESTREAM_PUBLISH_STATE, elapseSinceLastState: int | void | Error code index |
OnVideoRenderingTracingResult | uid: int64, currentEvent: EMEDIA_TRACE_EVENT, tracingInfo: const FVideoRenderingTracingInfo& | void | Error code index |
OnVideoSizeChanged | sourceType: EVIDEO_SOURCE_TYPE, uid: int64, width: int, height: int, rotation: int | void | Error code index |
OnVideoStopped | — | void | Error code index |
OnVideoSubscribeStateChanged | channel: const FString&, uid: int64, oldState: ESTREAM_SUBSCRIBE_STATE, newState: ESTREAM_SUBSCRIBE_STATE, elapseSinceLastState: int | void | Error code index |
IRtcEngineEx 44 method / 0 Property
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&): intMethod detail: 44 / 44 (parameters, returns, errors)
| Method | Parameters | Returns | Errors |
|---|---|---|---|
AddVideoWatermarkEx | watermarkUrl: const FString&, options: const FWatermarkOptions&, connection: const FRtcConnection& | int | Error code index |
AdjustUserPlaybackSignalVolumeEx | uid: int64, volume: int, connection: const FRtcConnection& | int | Error code index |
ClearVideoWatermarkEx | connection: const FRtcConnection& | int | Error code index |
CreateDataStreamEx | streamId: int&, config: const FDataStreamConfig&, connection: const FRtcConnection& | int | Error code index |
EnableAudioVolumeIndicationEx | interval: int, smooth: int, reportVad: bool, connection: const FRtcConnection& | int | Error code index |
EnableContentInspectEx | enabled: bool, config: const FContentInspectConfig&, connection: const FRtcConnection& | int | Error code index |
EnableDualStreamModeEx | enabled: bool, streamConfig: const FSimulcastStreamConfig&, connection: const FRtcConnection& | int | Error code index |
EnableEncryptionEx | connection: const FRtcConnection&, enabled: bool, config: const FEncryptionConfig& | int | Error code index |
EnableLoopbackRecordingEx | connection: const FRtcConnection&, enabled: bool, deviceName: const FString& | int | Error code index |
GetCallIdEx | callId: FString&, connection: const FRtcConnection& | int | Error code index |
GetConnectionStateEx | connection: const FRtcConnection& | ECONNECTION_STATE_TYPE | Error code index |
JoinChannelEx | token: const FString&, connection: const FRtcConnection&, options: const FChannelMediaOptions& | int | Error code index |
JoinChannelWithUserAccountEx | token: const FString&, channelId: const FString&, userAccount: const FString&, options: const FChannelMediaOptions& | int | Error code index |
LeaveChannelEx | connection: const FRtcConnection&, options: const FLeaveChannelOptions& | int | Error code index |
MuteAllRemoteAudioStreamsEx | mute: bool, connection: const FRtcConnection& | int | Error code index |
MuteAllRemoteVideoStreamsEx | mute: bool, connection: const FRtcConnection& | int | Error code index |
MuteLocalAudioStreamEx | mute: bool, connection: const FRtcConnection& | int | Error code index |
MuteLocalVideoStreamEx | mute: bool, connection: const FRtcConnection& | int | Error code index |
MuteRemoteAudioStreamEx | uid: int64, mute: bool, connection: const FRtcConnection& | int | Error code index |
MuteRemoteVideoStreamEx | uid: int64, mute: bool, connection: const FRtcConnection& | int | Error code index |
PauseAllChannelMediaRelayEx | connection: const FRtcConnection& | int | Error code index |
ResumeAllChannelMediaRelayEx | connection: const FRtcConnection& | int | Error code index |
SendCustomReportMessageEx | id: const FString&, category: const FString&, event: const FString&, label: const FString&, value: int, connection: const FRtcConnection& | int | Error code index |
SendStreamMessageEx | streamId: int, data: const FString&, connection: const FRtcConnection& | int | Error code index |
SetDualStreamModeEx | mode: FENUMWRAP_SIMULCAST_STREAM_MODE, streamConfig: const FSimulcastStreamConfig&, connection: const FRtcConnection& | int | Error code index |
SetRemoteRenderModeEx | uid: int64, renderMode: ERENDER_MODE_TYPE, mirrorMode: EVIDEO_MIRROR_MODE_TYPE, connection: const FRtcConnection& | int | Error code index |
SetRemoteVideoStreamTypeEx | uid: int64, streamType: EVIDEO_STREAM_TYPE, connection: const FRtcConnection& | int | Error code index |
SetRemoteVoicePositionEx | uid: int64, pan: float, gain: float, connection: const FRtcConnection& | int | Error code index |
SetSubscribeAudioAllowlistEx | uidList: TArray, uidNumber: int, connection: const FRtcConnection& | int | Error code index |
SetSubscribeAudioBlocklistEx | uidList: TArray, uidNumber: int, connection: const FRtcConnection& | int | Error code index |
SetSubscribeVideoAllowlistEx | uidList: TArray, uidNumber: int, connection: const FRtcConnection& | int | Error code index |
SetSubscribeVideoBlocklistEx | uidList: TArray, uidNumber: int, connection: const FRtcConnection& | int | Error code index |
SetVideoEncoderConfigurationEx | config: const FVideoEncoderConfiguration&, connection: const FRtcConnection& | int | Error code index |
SetupRemoteVideoEx | canvas: const FVideoCanvas&, connection: const FRtcConnection& | int | Error code index |
StartMediaRenderingTracingEx | connection: const FRtcConnection& | int | Error code index |
StartOrUpdateChannelMediaRelayEx | configuration: const FChannelMediaRelayConfiguration&, connection: const FRtcConnection& | int | Error code index |
StartRtmpStreamWithTranscodingEx | url: const FString&, transcoding: const FLiveTranscoding&, connection: const FRtcConnection& | int | Error code index |
StartRtmpStreamWithoutTranscodingEx | url: const FString&, connection: const FRtcConnection& | int | Error code index |
StopChannelMediaRelayEx | connection: const FRtcConnection& | int | Error code index |
StopRtmpStreamEx | url: const FString&, connection: const FRtcConnection& | int | Error code index |
TakeSnapshotEx | connection: const FRtcConnection&, uid: int64, filePath: const FString& | int | Error code index |
TakeSnapshotWithConfigEx | connection: const FUABT_RtcConnection&, uid: int64, config: const FUABT_SnapshotConfig& | int | Error code index |
UpdateChannelMediaOptionsEx | options: const FChannelMediaOptions&, connection: const FRtcConnection& | int | Error code index |
UpdateRtmpTranscodingEx | transcoding: const FLiveTranscoding&, connection: const FRtcConnection& | int | Error code index |
IScreenCaptureSourceList 3 method / 0 Property
GetCount(): int
GetSourceInfo(index: int): FScreenCaptureSourceInfo
Release(): voidMethod detail: 3 / 3 (parameters, returns, errors)
| Method | Parameters | Returns | Errors |
|---|---|---|---|
GetCount | — | int | Error code index |
GetSourceInfo | index: int | FScreenCaptureSourceInfo | Error code index |
Release | — | void | Error code index |
IVideoDeviceCollection 4 method / 0 Property
GetCount(): int
GetDevice(index: int, deviceName: FString&, deviceId: FString&): int
Release(): void
SetDevice(deviceIdUTF8: FString&): intMethod detail: 4 / 4 (parameters, returns, errors)
| Method | Parameters | Returns | Errors |
|---|---|---|---|
GetCount | — | int | Error code index |
GetDevice | index: int, deviceName: FString&, deviceId: FString& | int | Error code index |
Release | — | void | Error code index |
SetDevice | deviceIdUTF8: FString& | int | Error code index |
IVideoDeviceManager 4 method / 0 Property
EnumerateVideoDevices(): UVideoDeviceCollection*
GetCapability(deviceIdUTF8: const FString&, deviceCapabilityNumber: int, capability: FVideoFormat&): int
NumberOfCapabilities(deviceIdUTF8: const FString&): int
Release(): voidMethod detail: 4 / 4 (parameters, returns, errors)
| Method | Parameters | Returns | Errors |
|---|---|---|---|
EnumerateVideoDevices | — | UVideoDeviceCollection* | Error code index |
GetCapability | deviceIdUTF8: const FString&, deviceCapabilityNumber: int, capability: FVideoFormat& | int | Error code index |
NumberOfCapabilities | deviceIdUTF8: const FString& | int | Error code index |
Release | — | void | Error code index |
Enums
| Enums | Member count | Example value |
|---|---|---|
EAUDIENCE_LATENCY_LEVEL_TYPE | 2 | AUDIENCE_LATENCY_LEVEL_LOW_LATENCY = 1 |
EAUDIO_AINS_MODE | 3 | AINS_MODE_BALANCED = 0 |
EAUDIO_CODEC_PROFILE_TYPE | 3 | AUDIO_CODEC_PROFILE_LC_AAC = 0 |
EAUDIO_DUAL_MONO_MODE | 4 | AUDIO_DUAL_MONO_STEREO = 0 |
EAUDIO_ENCODED_FRAME_OBSERVER_POSITION | 3 | AUDIO_ENCODED_FRAME_OBSERVER_POSITION_RECORD = 1 |
EAUDIO_EQUALIZATION_BAND_FREQUENCY | 10 | AUDIO_EQUALIZATION_BAND_31 = 0 |
EAUDIO_FILE_RECORDING_TYPE | 3 | AUDIO_FILE_RECORDING_MIC = 1 |
EAUDIO_MIXING_DUAL_MONO_MODE | 4 | AUDIO_MIXING_DUAL_MONO_AUTO = 0 |
EAUDIO_PROFILE_TYPE | 8 | AUDIO_PROFILE_DEFAULT = 0 |
EAUDIO_RECORDING_QUALITY_TYPE | 4 | AUDIO_RECORDING_QUALITY_LOW = 0 |
EAUDIO_REVERB_TYPE | 5 | AUDIO_REVERB_DRY_LEVEL = 0 |
EAUDIO_SAMPLE_RATE_TYPE | 3 | AUDIO_SAMPLE_RATE_32000 = 32000 |
EAUDIO_SCENARIO_TYPE | 7 | AUDIO_SCENARIO_DEFAULT = 0 |
EAUDIO_SESSION_OPERATION_RESTRICTION | 5 | AUDIO_SESSION_OPERATION_RESTRICTION_NONE = null |
EBACKGROUND_BLUR_DEGREE | 3 | BLUR_DEGREE_LOW = 1 |
EBACKGROUND_SOURCE_TYPE | 4 | BACKGROUND_COLOR = 1 |
ECAMERA_DIRECTION | 2 | CAMERA_REAR = 0 |
ECAMERA_FOCAL_LENGTH_TYPE | 4 | CAMERA_FOCAL_LENGTH_DEFAULT = 0 |
ECHANNEL_PROFILE_TYPE | 4 | CHANNEL_PROFILE_COMMUNICATION = 0 |
ECLIENT_ROLE_CHANGE_FAILED_REASON | 4 | CLIENT_ROLE_CHANGE_FAILED_TOO_MANY_BROADCASTERS = 1 |
ECLIENT_ROLE_TYPE | 2 | CLIENT_ROLE_BROADCASTER = 1 |
ECLOUD_PROXY_TYPE | 3 | NONE_PROXY = 0 |
ECOMPRESSION_PREFERENCE | 3 | PREFER_COMPRESSION_AUTO = -1 |
ECONNECTION_CHANGED_REASON_TYPE | 21 | CONNECTION_CHANGED_CONNECTING = 0 |
ECONNECTION_STATE_TYPE | 5 | CONNECTION_STATE_DISCONNECTED = 1 |
ECONTENT_INSPECT_TYPE | 3 | CONTENT_INSPECT_INVALID = 0 |
EENCRYPTION_ERROR_TYPE | 5 | ENCRYPTION_ERROR_INTERNAL_FAILURE = 0 |
EENCRYPTION_MODE | 9 | AES_128_XTS = 1 |
EEXTERNAL_VIDEO_SOURCE_TYPE | 2 | VIDEO_FRAME = 0 |
EFeatureType | 2 | VIDEO_VIRTUAL_BACKGROUND = 1 |
ELASTMILE_PROBE_RESULT_STATE | 3 | LASTMILE_PROBE_RESULT_COMPLETE = 1 |
ELIGHTENING_CONTRAST_LEVEL | 3 | LIGHTENING_CONTRAST_LOW = 0 |
ELOCAL_AUDIO_STREAM_REASON | 11 | LOCAL_AUDIO_STREAM_REASON_OK = 0 |
ELOCAL_AUDIO_STREAM_STATE | 4 | LOCAL_AUDIO_STREAM_STATE_STOPPED = 0 |
ELOCAL_PROXY_MODE | 2 | ConnectivityFirst = 0 |
ELOCAL_VIDEO_STREAM_REASON | 26 | LOCAL_VIDEO_STREAM_REASON_OK = 0 |
ELOCAL_VIDEO_STREAM_STATE | 4 | LOCAL_VIDEO_STREAM_STATE_STOPPED = 0 |
ELOG_LEVEL | 5 | LOG_LEVEL_NONE = 0 |
ELOW_LIGHT_ENHANCE_MODE | 2 | LOW_LIGHT_ENHANCE_AUTO = 0 |
EMEDIA_DEVICE_STATE_TYPE | 6 | MEDIA_DEVICE_STATE_IDLE = 0 |
EMEDIA_PLAYER_EVENT | 14 | PLAYER_EVENT_SEEK_BEGIN = 0 |
EMEDIA_PLAYER_STATE | 9 | PLAYER_STATE_IDLE = 0 |
EMEDIA_STREAM_TYPE | 4 | STREAM_TYPE_UNKNOWN = 0 |
EMEDIA_TRACE_EVENT | 2 | MEDIA_TRACE_EVENT_VIDEO_RENDERED = 0 |
EPERMISSION_TYPE | 3 | RECORD_AUDIO = 0 |
EPLAYER_PRELOAD_EVENT | 3 | PLAYER_PRELOAD_EVENT_BEGIN = 0 |
EPROXY_TYPE | 5 | NONE_PROXY_TYPE = 0 |
EQUALITY_ADAPT_INDICATION | 3 | ADAPT_NONE = 0 |
EREMOTE_AUDIO_STATE | 5 | REMOTE_AUDIO_STATE_STOPPED = 0 |
EREMOTE_AUDIO_STATE_REASON | 8 | REMOTE_AUDIO_REASON_INTERNAL = 0 |
EREMOTE_VIDEO_STATE | 5 | REMOTE_VIDEO_STATE_STOPPED = 0 |
EREMOTE_VIDEO_STATE_REASON | 12 | REMOTE_VIDEO_STATE_REASON_INTERNAL = 0 |
ERENDER_MODE_TYPE | 3 | RENDER_MODE_HIDDEN = 1 |
ERTMP_STREAM_PUBLISH_REASON | 15 | RTMP_STREAM_PUBLISH_REASON_OK = 0 |
ERTMP_STREAM_PUBLISH_STATE | 6 | RTMP_STREAM_PUBLISH_STATE_IDLE = 0 |
ERTMP_STREAMING_EVENT | 4 | RTMP_STREAMING_EVENT_FAILED_LOAD_IMAGE = 1 |
ESCREEN_SCENARIO_TYPE | 4 | SCREEN_SCENARIO_DOCUMENT = 1 |
ESEG_MODEL_TYPE | 2 | SEG_MODEL_AI = 1 |
ESTREAM_FALLBACK_OPTIONS | 3 | STREAM_FALLBACK_OPTION_DISABLED = 0 |
ESTREAM_PUBLISH_STATE | 4 | PUB_STATE_IDLE = 0 |
ESTREAM_SUBSCRIBE_STATE | 4 | SUB_STATE_IDLE = 0 |
EUABT_AUDIO_SOURCE_TYPE | 7 | AUDIO_SOURCE_MICROPHONE = 0 |
EUABT_DEGRADATION_PREFERENCE | 5 | MAINTAIN_AUTO = -1 |
EUABT_FACE_SHAPE_AREA | 13 | FACE_SHAPE_AREA_NONE = -1 |
EUABT_FACE_SHAPE_BEAUTY_STYLE | 2 | FACE_SHAPE_BEAUTY_STYLE_FEMALE = 0 |
EUABT_LOW_LIGHT_ENHANCE_LEVEL | 2 | LOW_LIGHT_ENHANCE_LEVEL_HIGH_QUALITY = 0 |
EUABT_MEDIA_SOURCE_TYPE | 6 | AUDIO_PLAYOUT_SOURCE = 0 |
EUABT_ORIENTATION_MODE | 3 | ORIENTATION_MODE_ADAPTIVE = 0 |
EUABT_VIDEO_CODEC_TYPE | 6 | VIDEO_CODEC_NONE = 0 |
EUABT_VIDEO_DENOISER_LEVEL | 2 | VIDEO_DENOISER_LEVEL_HIGH_QUALITY = 0 |
EUABT_VIDEO_MIRROR_MODE_TYPE | 3 | VIDEO_MIRROR_MODE_AUTO = 0 |
EUABT_VIDEO_MODULE_POSITION | 4 | POSITION_POST_CAPTURER = 1 |
EUABT_VIDEO_SOURCE_TYPE | 18 | VIDEO_SOURCE_CAMERA_PRIMARY = 0 |
EUSER_OFFLINE_REASON_TYPE | 3 | USER_OFFLINE_QUIT = 0 |
EVIDEO_APPLICATION_SCENARIO_TYPE | 4 | APPLICATION_SCENARIO_GENERAL = 0 |
EVIDEO_CODEC_PROFILE_TYPE | 3 | VIDEO_CODEC_PROFILE_BASELINE = 66 |
EVIDEO_CODEC_TYPE_FOR_STREAM | 2 | VIDEO_CODEC_H264_FOR_STREAM = 1 |
EVIDEO_CONTENT_HINT | 3 | CONTENT_HINT_NONE = null |
EVIDEO_DENOISER_MODE | 2 | VIDEO_DENOISER_AUTO = 0 |
EVIDEO_STREAM_TYPE | 2 | VIDEO_STREAM_HIGH = 0 |
EVIDEO_TRANSCODER_ERROR | 6 | VT_ERR_VIDEO_SOURCE_NOT_READY = 1 |
EVIDEO_VIEW_SETUP_MODE | 3 | VIDEO_VIEW_SETUP_REPLACE = 0 |
EVOICE_AI_TUNER_TYPE | 10 | VOICE_AI_TUNER_MATURE_MALE = 0 |
EWATERMARK_FIT_MODE | 2 | FIT_MODE_COVER_POSITION = null |
FENUMWRAP_AREA_CODE | 7 | AREA_CODE_CN = null |
FENUMWRAP_AUDIO_EFFECT_PRESET | 21 | AUDIO_EFFECT_OFF = null |
FENUMWRAP_AUDIO_MIXING_REASON_TYPE | 7 | AUDIO_MIXING_REASON_OK = 0 |
FENUMWRAP_AUDIO_MIXING_STATE_TYPE | 4 | AUDIO_MIXING_STATE_PLAYING = 710 |
FENUMWRAP_CAMERA_STABILIZATION_MODE | 5 | CAMERA_STABILIZATION_MODE_OFF = -1 |
FENUMWRAP_CAPTURE_BRIGHTNESS_LEVEL_TYPE | 4 | CAPTURE_BRIGHTNESS_LEVEL_INVALID = -1 |
FENUMWRAP_ENCODING_PREFERENCE | 3 | PREFER_AUTO = -1 |
FENUMWRAP_HEADPHONE_EQUALIZER_PRESET | 3 | HEADPHONE_EQUALIZER_OFF = null |
FENUMWRAP_MEDIA_DEVICE_TYPE | 8 | UNKNOWN_AUDIO_DEVICE = -1 |
FENUMWRAP_MEDIA_PLAYER_REASON | 16 | PLAYER_REASON_NONE = 0 |
FENUMWRAP_NETWORK_TYPE | 8 | NETWORK_TYPE_UNKNOWN = -1 |
FENUMWRAP_RHYTHM_PLAYER_REASON | 5 | RHYTHM_PLAYER_REASON_OK = 0 |
FENUMWRAP_RHYTHM_PLAYER_STATE_TYPE | 5 | RHYTHM_PLAYER_STATE_IDLE = 810 |
FENUMWRAP_ScreenCaptureSourceType | 4 | ScreenCaptureSourceType_Unknown = -1 |
FENUMWRAP_SIMULCAST_STREAM_MODE | 3 | AUTO_SIMULCAST_STREAM = -1 |
FENUMWRAP_VIDEO_CODEC_CAPABILITY_LEVEL | 5 | CODEC_CAPABILITY_LEVEL_UNSPECIFIED = -1 |
FENUMWRAP_VIDEO_ORIENTATION | 4 | VIDEO_ORIENTATION_0 = 0 |
FENUMWRAP_VOICE_BEAUTIFIER_PRESET | 14 | VOICE_BEAUTIFIER_OFF = null |
FENUMWRAP_VOICE_CONVERSION_PRESET | 5 | VOICE_CONVERSION_OFF = null |
EAUDIENCE_LATENCY_LEVEL_TYPE 2 members
| Member | value |
|---|---|
AUDIENCE_LATENCY_LEVEL_LOW_LATENCY | 1 |
AUDIENCE_LATENCY_LEVEL_ULTRA_LOW_LATENCY | 2 |
EAUDIO_AINS_MODE 3 members
| Member | value |
|---|---|
AINS_MODE_BALANCED | 0 |
AINS_MODE_AGGRESSIVE | 1 |
AINS_MODE_ULTRALOWLATENCY | 2 |
EAUDIO_CODEC_PROFILE_TYPE 3 members
| Member | value |
|---|---|
AUDIO_CODEC_PROFILE_LC_AAC | 0 |
AUDIO_CODEC_PROFILE_HE_AAC | 1 |
HE_AAC_V2 | 2 |
EAUDIO_DUAL_MONO_MODE 4 members
| Member | value |
|---|---|
AUDIO_DUAL_MONO_STEREO | 0 |
AUDIO_DUAL_MONO_L | 1 |
AUDIO_DUAL_MONO_R | 2 |
AUDIO_DUAL_MONO_MIX | 3 |
EAUDIO_ENCODED_FRAME_OBSERVER_POSITION 3 members
| Member | value |
|---|---|
AUDIO_ENCODED_FRAME_OBSERVER_POSITION_RECORD | 1 |
AUDIO_ENCODED_FRAME_OBSERVER_POSITION_PLAYBACK | 2 |
AUDIO_ENCODED_FRAME_OBSERVER_POSITION_MIXED | 3 |
EAUDIO_EQUALIZATION_BAND_FREQUENCY 10 members
| Member | value |
|---|---|
AUDIO_EQUALIZATION_BAND_31 | 0 |
AUDIO_EQUALIZATION_BAND_62 | 1 |
AUDIO_EQUALIZATION_BAND_125 | 2 |
AUDIO_EQUALIZATION_BAND_250 | 3 |
AUDIO_EQUALIZATION_BAND_500 | 4 |
AUDIO_EQUALIZATION_BAND_1K | 5 |
AUDIO_EQUALIZATION_BAND_2K | 6 |
AUDIO_EQUALIZATION_BAND_4K | 7 |
AUDIO_EQUALIZATION_BAND_8K | 8 |
AUDIO_EQUALIZATION_BAND_16K | 9 |
EAUDIO_FILE_RECORDING_TYPE 3 members
| Member | value |
|---|---|
AUDIO_FILE_RECORDING_MIC | 1 |
AUDIO_FILE_RECORDING_PLAYBACK | 2 |
AUDIO_FILE_RECORDING_MIXED | 3 |
EAUDIO_MIXING_DUAL_MONO_MODE 4 members
| Member | value |
|---|---|
AUDIO_MIXING_DUAL_MONO_AUTO | 0 |
AUDIO_MIXING_DUAL_MONO_L | 1 |
AUDIO_MIXING_DUAL_MONO_R | 2 |
AUDIO_MIXING_DUAL_MONO_MIX | 3 |
EAUDIO_PROFILE_TYPE 8 members
| Member | value |
|---|---|
AUDIO_PROFILE_DEFAULT | 0 |
AUDIO_PROFILE_SPEECH_STANDARD | 1 |
AUDIO_PROFILE_MUSIC_STANDARD | 2 |
AUDIO_PROFILE_MUSIC_STANDARD_STEREO | 3 |
AUDIO_PROFILE_MUSIC_HIGH_QUALITY | 4 |
AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO | 5 |
AUDIO_PROFILE_IOT | 6 |
AUDIO_PROFILE_NUM | null |
EAUDIO_RECORDING_QUALITY_TYPE 4 members
| Member | value |
|---|---|
AUDIO_RECORDING_QUALITY_LOW | 0 |
AUDIO_RECORDING_QUALITY_MEDIUM | 1 |
AUDIO_RECORDING_QUALITY_HIGH | 2 |
AUDIO_RECORDING_QUALITY_ULTRA_HIGH | 3 |
EAUDIO_REVERB_TYPE 5 members
| Member | value |
|---|---|
AUDIO_REVERB_DRY_LEVEL | 0 |
AUDIO_REVERB_WET_LEVEL | 1 |
AUDIO_REVERB_ROOM_SIZE | 2 |
AUDIO_REVERB_WET_DELAY | 3 |
AUDIO_REVERB_STRENGTH | 4 |
EAUDIO_SAMPLE_RATE_TYPE 3 members
| Member | value |
|---|---|
AUDIO_SAMPLE_RATE_32000 | 32000 |
AUDIO_SAMPLE_RATE_44100 | 44100 |
AUDIO_SAMPLE_RATE_48000 | 48000 |
EAUDIO_SCENARIO_TYPE 7 members
| Member | value |
|---|---|
AUDIO_SCENARIO_DEFAULT | 0 |
AUDIO_SCENARIO_GAME_STREAMING | 3 |
AUDIO_SCENARIO_CHATROOM | 5 |
AUDIO_SCENARIO_CHORUS | 7 |
AUDIO_SCENARIO_MEETING | 8 |
AUDIO_SCENARIO_AI_CLIENT | 10 |
AUDIO_SCENARIO_NUM | null |
EAUDIO_SESSION_OPERATION_RESTRICTION 5 members
| Member | value |
|---|---|
AUDIO_SESSION_OPERATION_RESTRICTION_NONE | null |
AUDIO_SESSION_OPERATION_RESTRICTION_SET_CATEGORY | null |
AUDIO_SESSION_OPERATION_RESTRICTION_CONFIGURE_SESSION | null |
AUDIO_SESSION_OPERATION_RESTRICTION_DEACTIVATE_SESSION | null |
AUDIO_SESSION_OPERATION_RESTRICTION_ALL | null |
EBACKGROUND_BLUR_DEGREE 3 members
| Member | value |
|---|---|
BLUR_DEGREE_LOW | 1 |
BLUR_DEGREE_MEDIUM | 2 |
BLUR_DEGREE_HIGH | 3 |
EBACKGROUND_SOURCE_TYPE 4 members
| Member | value |
|---|---|
BACKGROUND_COLOR | 1 |
BACKGROUND_IMG | 2 |
BACKGROUND_BLUR | 3 |
BACKGROUND_VIDEO | 4 |
ECAMERA_DIRECTION 2 members
| Member | value |
|---|---|
CAMERA_REAR | 0 |
CAMERA_FRONT | 1 |
ECAMERA_FOCAL_LENGTH_TYPE 4 members
| Member | value |
|---|---|
CAMERA_FOCAL_LENGTH_DEFAULT | 0 |
CAMERA_FOCAL_LENGTH_WIDE_ANGLE | 1 |
CAMERA_FOCAL_LENGTH_ULTRA_WIDE | 2 |
CAMERA_FOCAL_LENGTH_TELEPHOTO | 3 |
ECHANNEL_PROFILE_TYPE 4 members
| Member | value |
|---|---|
CHANNEL_PROFILE_COMMUNICATION | 0 |
CHANNEL_PROFILE_LIVE_BROADCASTING | 1 |
CHANNEL_PROFILE_GAME | 2 |
CHANNEL_PROFILE_CLOUD_GAMING | 3 |
ECLIENT_ROLE_CHANGE_FAILED_REASON 4 members
| Member | value |
|---|---|
CLIENT_ROLE_CHANGE_FAILED_TOO_MANY_BROADCASTERS | 1 |
CLIENT_ROLE_CHANGE_FAILED_NOT_AUTHORIZED | 2 |
CLIENT_ROLE_CHANGE_FAILED_REQUEST_TIME_OUT | 3 |
CLIENT_ROLE_CHANGE_FAILED_CONNECTION_FAILED | 4 |
ECLIENT_ROLE_TYPE 2 members
| Member | value |
|---|---|
CLIENT_ROLE_BROADCASTER | 1 |
CLIENT_ROLE_AUDIENCE | 2 |
ECLOUD_PROXY_TYPE 3 members
| Member | value |
|---|---|
NONE_PROXY | 0 |
UDP_PROXY | 1 |
TCP_PROXY | 2 |
ECOMPRESSION_PREFERENCE 3 members
| Member | value |
|---|---|
PREFER_COMPRESSION_AUTO | -1 |
PREFER_LOW_LATENCY | 0 |
PREFER_QUALITY | 1 |
ECONNECTION_CHANGED_REASON_TYPE 21 members
| Member | value |
|---|---|
CONNECTION_CHANGED_CONNECTING | 0 |
CONNECTION_CHANGED_JOIN_SUCCESS | 1 |
CONNECTION_CHANGED_INTERRUPTED | 2 |
CONNECTION_CHANGED_BANNED_BY_SERVER | 3 |
CONNECTION_CHANGED_JOIN_FAILED | 4 |
CONNECTION_CHANGED_LEAVE_CHANNEL | 5 |
CONNECTION_CHANGED_INVALID_APP_ID | 6 |
CONNECTION_CHANGED_INVALID_CHANNEL_NAME | 7 |
CONNECTION_CHANGED_INVALID_TOKEN | 8 |
CONNECTION_CHANGED_TOKEN_EXPIRED | 9 |
CONNECTION_CHANGED_REJECTED_BY_SERVER | 10 |
CONNECTION_CHANGED_SETTING_PROXY_SERVER | 11 |
CONNECTION_CHANGED_RENEW_TOKEN | 12 |
CONNECTION_CHANGED_CLIENT_IP_ADDRESS_CHANGED | 13 |
CONNECTION_CHANGED_KEEP_ALIVE_TIMEOUT | 14 |
CONNECTION_CHANGED_REJOIN_SUCCESS | 15 |
CONNECTION_CHANGED_LOST | 16 |
CONNECTION_CHANGED_ECHO_TEST | 17 |
CONNECTION_CHANGED_CLIENT_IP_ADDRESS_CHANGED_BY_USER | 18 |
CONNECTION_CHANGED_SAME_UID_LOGIN | 19 |
CONNECTION_CHANGED_TOO_MANY_BROADCASTERS | 20 |
ECONNECTION_STATE_TYPE 5 members
| Member | value |
|---|---|
CONNECTION_STATE_DISCONNECTED | 1 |
CONNECTION_STATE_CONNECTING | 2 |
CONNECTION_STATE_CONNECTED | 3 |
CONNECTION_STATE_RECONNECTING | 4 |
CONNECTION_STATE_FAILED | 5 |
ECONTENT_INSPECT_TYPE 3 members
| Member | value |
|---|---|
CONTENT_INSPECT_INVALID | 0 |
CONTENT_INSPECT_SUPERVISION | 2 |
CONTENT_INSPECT_IMAGE_MODERATION | 3 |
EENCRYPTION_ERROR_TYPE 5 members
| Member | value |
|---|---|
ENCRYPTION_ERROR_INTERNAL_FAILURE | 0 |
ENCRYPTION_ERROR_DECRYPTION_FAILURE | 1 |
ENCRYPTION_ERROR_ENCRYPTION_FAILURE | 2 |
ENCRYPTION_ERROR_DATASTREAM_DECRYPTION_FAILURE | 3 |
ENCRYPTION_ERROR_DATASTREAM_ENCRYPTION_FAILURE | 4 |
EENCRYPTION_MODE 9 members
| Member | value |
|---|---|
AES_128_XTS | 1 |
AES_128_ECB | 2 |
AES_256_XTS | 3 |
SM4_128_ECB | 4 |
AES_128_GCM | 5 |
AES_256_GCM | 6 |
AES_128_GCM2 | 7 |
AES_256_GCM2 | 8 |
MODE_END | null |
EEXTERNAL_VIDEO_SOURCE_TYPE 2 members
| Member | value |
|---|---|
VIDEO_FRAME | 0 |
ENCODED_VIDEO_FRAME | 1 |
EFeatureType 2 members
| Member | value |
|---|---|
VIDEO_VIRTUAL_BACKGROUND | 1 |
VIDEO_BEAUTY_EFFECT | 2 |
ELASTMILE_PROBE_RESULT_STATE 3 members
| Member | value |
|---|---|
LASTMILE_PROBE_RESULT_COMPLETE | 1 |
LASTMILE_PROBE_RESULT_INCOMPLETE_NO_BWE | 2 |
LASTMILE_PROBE_RESULT_UNAVAILABLE | 3 |
ELIGHTENING_CONTRAST_LEVEL 3 members
| Member | value |
|---|---|
LIGHTENING_CONTRAST_LOW | 0 |
LIGHTENING_CONTRAST_NORMAL | 1 |
LIGHTENING_CONTRAST_HIGH | 2 |
ELOCAL_AUDIO_STREAM_REASON 11 members
| Member | value |
|---|---|
LOCAL_AUDIO_STREAM_REASON_OK | 0 |
LOCAL_AUDIO_STREAM_REASON_FAILURE | 1 |
LOCAL_AUDIO_STREAM_REASON_DEVICE_NO_PERMISSION | 2 |
LOCAL_AUDIO_STREAM_REASON_DEVICE_BUSY | 3 |
LOCAL_AUDIO_STREAM_REASON_RECORD_FAILURE | 4 |
LOCAL_AUDIO_STREAM_REASON_ENCODE_FAILURE | 5 |
LOCAL_AUDIO_STREAM_REASON_NO_RECORDING_DEVICE | 6 |
LOCAL_AUDIO_STREAM_REASON_NO_PLAYOUT_DEVICE | 7 |
LOCAL_AUDIO_STREAM_REASON_INTERRUPTED | 8 |
LOCAL_AUDIO_STREAM_REASON_RECORD_INVALID_ID | 9 |
LOCAL_AUDIO_STREAM_REASON_PLAYOUT_INVALID_ID | 10 |
ELOCAL_AUDIO_STREAM_STATE 4 members
| Member | value |
|---|---|
LOCAL_AUDIO_STREAM_STATE_STOPPED | 0 |
LOCAL_AUDIO_STREAM_STATE_RECORDING | 1 |
LOCAL_AUDIO_STREAM_STATE_ENCODING | 2 |
LOCAL_AUDIO_STREAM_STATE_FAILED | 3 |
ELOCAL_PROXY_MODE 2 members
| Member | value |
|---|---|
ConnectivityFirst | 0 |
LocalOnly | 1 |
ELOCAL_VIDEO_STREAM_REASON 26 members
| Member | value |
|---|---|
LOCAL_VIDEO_STREAM_REASON_OK | 0 |
LOCAL_VIDEO_STREAM_REASON_FAILURE | 1 |
LOCAL_VIDEO_STREAM_REASON_DEVICE_NO_PERMISSION | 2 |
LOCAL_VIDEO_STREAM_REASON_DEVICE_BUSY | 3 |
LOCAL_VIDEO_STREAM_REASON_CAPTURE_FAILURE | 4 |
LOCAL_VIDEO_STREAM_REASON_CODEC_NOT_SUPPORT | 5 |
LOCAL_VIDEO_STREAM_REASON_CAPTURE_INBACKGROUND | 6 |
LOCAL_VIDEO_STREAM_REASON_CAPTURE_MULTIPLE_FOREGROUND_APPS | 7 |
LOCAL_VIDEO_STREAM_REASON_DEVICE_NOT_FOUND | 8 |
LOCAL_VIDEO_STREAM_REASON_DEVICE_DISCONNECTED | 9 |
LOCAL_VIDEO_STREAM_REASON_DEVICE_INVALID_ID | 10 |
LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_MINIMIZED | 11 |
LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_CLOSED | 12 |
LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_OCCLUDED | 13 |
LOCAL_VIDEO_STREAM_REASON_DEVICE_INTERRUPT | 14 |
LOCAL_VIDEO_STREAM_REASON_DEVICE_FATAL_ERROR | 15 |
LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_FAILURE | 21 |
LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_NO_PERMISSION | 22 |
LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_AUTO_FALLBACK | 24 |
LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_HIDDEN | 25 |
LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_RECOVER_FROM_HIDDEN | 26 |
LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_RECOVER_FROM_MINIMIZED | 27 |
LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_PAUSED | 28 |
LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_RESUMED | 29 |
LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_DISPLAY_DISCONNECTED | 30 |
LOCAL_VIDEO_STREAM_REASON_DEVICE_SYSTEM_PRESSURE | 101 |
ELOCAL_VIDEO_STREAM_STATE 4 members
| Member | value |
|---|---|
LOCAL_VIDEO_STREAM_STATE_STOPPED | 0 |
LOCAL_VIDEO_STREAM_STATE_CAPTURING | 1 |
LOCAL_VIDEO_STREAM_STATE_ENCODING | 2 |
LOCAL_VIDEO_STREAM_STATE_FAILED | 3 |
ELOG_LEVEL 5 members
| Member | value |
|---|---|
LOG_LEVEL_NONE | 0 |
LOG_LEVEL_INFO | 1 |
LOG_LEVEL_WARN | 2 |
LOG_LEVEL_ERROR | 4 |
LOG_LEVEL_FATAL | 8 |
ELOW_LIGHT_ENHANCE_MODE 2 members
| Member | value |
|---|---|
LOW_LIGHT_ENHANCE_AUTO | 0 |
LOW_LIGHT_ENHANCE_MANUAL | 1 |
EMEDIA_DEVICE_STATE_TYPE 6 members
| Member | value |
|---|---|
MEDIA_DEVICE_STATE_IDLE | 0 |
MEDIA_DEVICE_STATE_ACTIVE | 1 |
MEDIA_DEVICE_STATE_DISABLED | 2 |
MEDIA_DEVICE_STATE_PLUGGED_IN | 3 |
MEDIA_DEVICE_STATE_NOT_PRESENT | 4 |
MEDIA_DEVICE_STATE_UNPLUGGED | 8 |
EMEDIA_PLAYER_EVENT 14 members
| Member | value |
|---|---|
PLAYER_EVENT_SEEK_BEGIN | 0 |
PLAYER_EVENT_SEEK_COMPLETE | 1 |
PLAYER_EVENT_SEEK_ERROR | 2 |
PLAYER_EVENT_AUDIO_TRACK_CHANGED | 5 |
PLAYER_EVENT_BUFFER_LOW | 6 |
PLAYER_EVENT_BUFFER_RECOVER | 7 |
PLAYER_EVENT_FREEZE_START | 8 |
PLAYER_EVENT_FREEZE_STOP | 9 |
PLAYER_EVENT_SWITCH_BEGIN | 10 |
PLAYER_EVENT_SWITCH_COMPLETE | 11 |
PLAYER_EVENT_SWITCH_ERROR | 12 |
PLAYER_EVENT_FIRST_DISPLAYED | 13 |
PLAYER_EVENT_REACH_CACHE_FILE_MAX_COUNT | 14 |
PLAYER_EVENT_REACH_CACHE_FILE_MAX_SIZE | 15 |
EMEDIA_PLAYER_STATE 9 members
| Member | value |
|---|---|
PLAYER_STATE_IDLE | 0 |
PLAYER_STATE_OPENING | 1 |
PLAYER_STATE_OPEN_COMPLETED | 2 |
PLAYER_STATE_PLAYING | 3 |
PLAYER_STATE_PAUSED | 4 |
PLAYER_STATE_PLAYBACK_COMPLETED | 5 |
PLAYER_STATE_PLAYBACK_ALL_LOOPS_COMPLETED | 6 |
PLAYER_STATE_STOPPED | 7 |
PLAYER_STATE_FAILED | 100 |
EMEDIA_STREAM_TYPE 4 members
| Member | value |
|---|---|
STREAM_TYPE_UNKNOWN | 0 |
STREAM_TYPE_VIDEO | 1 |
STREAM_TYPE_AUDIO | 2 |
STREAM_TYPE_SUBTITLE | 3 |
EMEDIA_TRACE_EVENT 2 members
| Member | value |
|---|---|
MEDIA_TRACE_EVENT_VIDEO_RENDERED | 0 |
MEDIA_TRACE_EVENT_VIDEO_DECODED | 1 |
EPERMISSION_TYPE 3 members
| Member | value |
|---|---|
RECORD_AUDIO | 0 |
CAMERA | 1 |
SCREEN_CAPTURE | null |
EPLAYER_PRELOAD_EVENT 3 members
| Member | value |
|---|---|
PLAYER_PRELOAD_EVENT_BEGIN | 0 |
PLAYER_PRELOAD_EVENT_COMPLETE | 1 |
PLAYER_PRELOAD_EVENT_ERROR | 2 |
EPROXY_TYPE 5 members
| Member | value |
|---|---|
NONE_PROXY_TYPE | 0 |
UDP_PROXY_TYPE | 1 |
TCP_PROXY_TYPE | 2 |
LOCAL_PROXY_TYPE | 3 |
TCP_PROXY_AUTO_FALLBACK_TYPE | 4 |
EQUALITY_ADAPT_INDICATION 3 members
| Member | value |
|---|---|
ADAPT_NONE | 0 |
ADAPT_UP_BANDWIDTH | 1 |
ADAPT_DOWN_BANDWIDTH | 2 |
EREMOTE_AUDIO_STATE 5 members
| Member | value |
|---|---|
REMOTE_AUDIO_STATE_STOPPED | 0 |
REMOTE_AUDIO_STATE_STARTING | 1 |
REMOTE_AUDIO_STATE_DECODING | 2 |
REMOTE_AUDIO_STATE_FROZEN | 3 |
REMOTE_AUDIO_STATE_FAILED | 4 |
EREMOTE_AUDIO_STATE_REASON 8 members
| Member | value |
|---|---|
REMOTE_AUDIO_REASON_INTERNAL | 0 |
REMOTE_AUDIO_REASON_NETWORK_CONGESTION | 1 |
REMOTE_AUDIO_REASON_NETWORK_RECOVERY | 2 |
REMOTE_AUDIO_REASON_LOCAL_MUTED | 3 |
REMOTE_AUDIO_REASON_LOCAL_UNMUTED | 4 |
REMOTE_AUDIO_REASON_REMOTE_MUTED | 5 |
REMOTE_AUDIO_REASON_REMOTE_UNMUTED | 6 |
REMOTE_AUDIO_REASON_REMOTE_OFFLINE | 7 |
EREMOTE_VIDEO_STATE 5 members
| Member | value |
|---|---|
REMOTE_VIDEO_STATE_STOPPED | 0 |
REMOTE_VIDEO_STATE_STARTING | 1 |
REMOTE_VIDEO_STATE_DECODING | 2 |
REMOTE_VIDEO_STATE_FROZEN | 3 |
REMOTE_VIDEO_STATE_FAILED | 4 |
EREMOTE_VIDEO_STATE_REASON 12 members
| Member | value |
|---|---|
REMOTE_VIDEO_STATE_REASON_INTERNAL | 0 |
REMOTE_VIDEO_STATE_REASON_NETWORK_CONGESTION | 1 |
REMOTE_VIDEO_STATE_REASON_NETWORK_RECOVERY | 2 |
REMOTE_VIDEO_STATE_REASON_LOCAL_MUTED | 3 |
REMOTE_VIDEO_STATE_REASON_LOCAL_UNMUTED | 4 |
REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED | 5 |
REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED | 6 |
REMOTE_VIDEO_STATE_REASON_REMOTE_OFFLINE | 7 |
REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK | 8 |
REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK_RECOVERY | 9 |
REMOTE_VIDEO_STATE_REASON_SDK_IN_BACKGROUND | 12 |
REMOTE_VIDEO_STATE_REASON_CODEC_NOT_SUPPORT | 13 |
ERENDER_MODE_TYPE 3 members
| Member | value |
|---|---|
RENDER_MODE_HIDDEN | 1 |
RENDER_MODE_FIT | 2 |
RENDER_MODE_ADAPTIVE | 3 |
ERTMP_STREAM_PUBLISH_REASON 15 members
| Member | value |
|---|---|
RTMP_STREAM_PUBLISH_REASON_OK | 0 |
RTMP_STREAM_PUBLISH_REASON_INVALID_ARGUMENT | 1 |
RTMP_STREAM_PUBLISH_REASON_ENCRYPTED_STREAM_NOT_ALLOWED | 2 |
RTMP_STREAM_PUBLISH_REASON_CONNECTION_TIMEOUT | 3 |
RTMP_STREAM_PUBLISH_REASON_INTERNAL_SERVER_ERROR | 4 |
RTMP_STREAM_PUBLISH_REASON_RTMP_SERVER_ERROR | 5 |
RTMP_STREAM_PUBLISH_REASON_TOO_OFTEN | 6 |
RTMP_STREAM_PUBLISH_REASON_REACH_LIMIT | 7 |
RTMP_STREAM_PUBLISH_REASON_NOT_AUTHORIZED | 8 |
RTMP_STREAM_PUBLISH_REASON_STREAM_NOT_FOUND | 9 |
RTMP_STREAM_PUBLISH_REASON_FORMAT_NOT_SUPPORTED | 10 |
RTMP_STREAM_PUBLISH_REASON_NOT_BROADCASTER | 11 |
RTMP_STREAM_PUBLISH_REASON_TRANSCODING_NO_MIX_STREAM | 13 |
RTMP_STREAM_PUBLISH_REASON_NET_DOWN | 14 |
RTMP_STREAM_PUBLISH_REASON_INVALID_PRIVILEGE | 16 |
ERTMP_STREAM_PUBLISH_STATE 6 members
| Member | value |
|---|---|
RTMP_STREAM_PUBLISH_STATE_IDLE | 0 |
RTMP_STREAM_PUBLISH_STATE_CONNECTING | 1 |
RTMP_STREAM_PUBLISH_STATE_RUNNING | 2 |
RTMP_STREAM_PUBLISH_STATE_RECOVERING | 3 |
RTMP_STREAM_PUBLISH_STATE_FAILURE | 4 |
RTMP_STREAM_PUBLISH_STATE_DISCONNECTING | 5 |
ERTMP_STREAMING_EVENT 4 members
| Member | value |
|---|---|
RTMP_STREAMING_EVENT_FAILED_LOAD_IMAGE | 1 |
RTMP_STREAMING_EVENT_URL_ALREADY_IN_USE | 2 |
RTMP_STREAMING_EVENT_ADVANCED_FEATURE_NOT_SUPPORT | 3 |
RTMP_STREAMING_EVENT_REQUEST_TOO_OFTEN | 4 |
ESCREEN_SCENARIO_TYPE 4 members
| Member | value |
|---|---|
SCREEN_SCENARIO_DOCUMENT | 1 |
SCREEN_SCENARIO_GAMING | 2 |
SCREEN_SCENARIO_VIDEO | 3 |
SCREEN_SCENARIO_RDC | 4 |
ESEG_MODEL_TYPE 2 members
| Member | value |
|---|---|
SEG_MODEL_AI | 1 |
SEG_MODEL_GREEN | 2 |
ESTREAM_FALLBACK_OPTIONS 3 members
| Member | value |
|---|---|
STREAM_FALLBACK_OPTION_DISABLED | 0 |
STREAM_FALLBACK_OPTION_VIDEO_STREAM_LOW | 1 |
STREAM_FALLBACK_OPTION_AUDIO_ONLY | 2 |
ESTREAM_PUBLISH_STATE 4 members
| Member | value |
|---|---|
PUB_STATE_IDLE | 0 |
PUB_STATE_NO_PUBLISHED | 1 |
PUB_STATE_PUBLISHING | 2 |
PUB_STATE_PUBLISHED | 3 |
ESTREAM_SUBSCRIBE_STATE 4 members
| Member | value |
|---|---|
SUB_STATE_IDLE | 0 |
SUB_STATE_NO_SUBSCRIBED | 1 |
SUB_STATE_SUBSCRIBING | 2 |
SUB_STATE_SUBSCRIBED | 3 |
EUABT_AUDIO_SOURCE_TYPE 7 members
| Member | value |
|---|---|
AUDIO_SOURCE_MICROPHONE | 0 |
AUDIO_SOURCE_CUSTOM | 1 |
AUDIO_SOURCE_MEDIA_PLAYER | 2 |
AUDIO_SOURCE_LOOPBACK_RECORDING | 3 |
AUDIO_SOURCE_REMOTE_USER | 5 |
AUDIO_SOURCE_REMOTE_CHANNEL | 6 |
AUDIO_SOURCE_UNKNOWN | 100 |
EUABT_DEGRADATION_PREFERENCE 5 members
| Member | value |
|---|---|
MAINTAIN_AUTO | -1 |
MAINTAIN_QUALITY | 0 |
MAINTAIN_FRAMERATE | 1 |
MAINTAIN_BALANCED | 2 |
MAINTAIN_RESOLUTION | 3 |
EUABT_FACE_SHAPE_AREA 13 members
| Member | value |
|---|---|
FACE_SHAPE_AREA_NONE | -1 |
FACE_SHAPE_AREA_HEADSCALE | 0 |
FACE_SHAPE_AREA_FOREHEAD | 1 |
FACE_SHAPE_AREA_FACECONTOUR | 2 |
FACE_SHAPE_AREA_FACELENGTH | 3 |
FACE_SHAPE_AREA_FACEWIDTH | 4 |
FACE_SHAPE_AREA_CHEEKBONE | 5 |
FACE_SHAPE_AREA_CHEEK | 6 |
FACE_SHAPE_AREA_CHIN | 7 |
FACE_SHAPE_AREA_EYESCALE | 8 |
FACE_SHAPE_AREA_NOSELENGTH | 9 |
FACE_SHAPE_AREA_NOSEWIDTH | 10 |
FACE_SHAPE_AREA_MOUTHSCALE | 11 |
EUABT_FACE_SHAPE_BEAUTY_STYLE 2 members
| Member | value |
|---|---|
FACE_SHAPE_BEAUTY_STYLE_FEMALE | 0 |
FACE_SHAPE_BEAUTY_STYLE_MALE | 1 |
EUABT_LOW_LIGHT_ENHANCE_LEVEL 2 members
| Member | value |
|---|---|
LOW_LIGHT_ENHANCE_LEVEL_HIGH_QUALITY | 0 |
LOW_LIGHT_ENHANCE_LEVEL_FAST | 1 |
EUABT_MEDIA_SOURCE_TYPE 6 members
| Member | value |
|---|---|
AUDIO_PLAYOUT_SOURCE | 0 |
AUDIO_RECORDING_SOURCE | 1 |
PRIMARY_CAMERA_SOURCE | 2 |
SECONDARY_CAMERA_SOURCE | 3 |
CUSTOM_VIDEO_SOURCE | 6 |
UNKNOWN_MEDIA_SOURCE | 100 |
EUABT_ORIENTATION_MODE 3 members
| Member | value |
|---|---|
ORIENTATION_MODE_ADAPTIVE | 0 |
ORIENTATION_MODE_FIXED_LANDSCAPE | 1 |
ORIENTATION_MODE_FIXED_PORTRAIT | 2 |
EUABT_VIDEO_CODEC_TYPE 6 members
| Member | value |
|---|---|
VIDEO_CODEC_NONE | 0 |
VIDEO_CODEC_VP8 | 1 |
VIDEO_CODEC_H264 | 2 |
VIDEO_CODEC_H265 | 3 |
VIDEO_CODEC_GENERIC | 6 |
VIDEO_CODEC_GENERIC_JPEG | 20 |
EUABT_VIDEO_DENOISER_LEVEL 2 members
| Member | value |
|---|---|
VIDEO_DENOISER_LEVEL_HIGH_QUALITY | 0 |
VIDEO_DENOISER_LEVEL_FAST | 1 |
EUABT_VIDEO_MIRROR_MODE_TYPE 3 members
| Member | value |
|---|---|
VIDEO_MIRROR_MODE_AUTO | 0 |
VIDEO_MIRROR_MODE_ENABLED | 1 |
VIDEO_MIRROR_MODE_DISABLED | 2 |
EUABT_VIDEO_MODULE_POSITION 4 members
| Member | value |
|---|---|
POSITION_POST_CAPTURER | 1 |
POSITION_PRE_RENDERER | 2 |
POSITION_PRE_ENCODER | 4 |
POSITION_POST_CAPTURER_ORIGIN | 8 |
EUABT_VIDEO_SOURCE_TYPE 18 members
| Member | value |
|---|---|
VIDEO_SOURCE_CAMERA_PRIMARY | 0 |
VIDEO_SOURCE_CAMERA | 0 |
VIDEO_SOURCE_CAMERA_SECONDARY | 1 |
VIDEO_SOURCE_SCREEN_PRIMARY | 2 |
VIDEO_SOURCE_SCREEN | 2 |
VIDEO_SOURCE_SCREEN_SECONDARY | 3 |
VIDEO_SOURCE_CUSTOM | 4 |
VIDEO_SOURCE_MEDIA_PLAYER | 5 |
VIDEO_SOURCE_RTC_IMAGE_PNG | 6 |
VIDEO_SOURCE_RTC_IMAGE_JPEG | 7 |
VIDEO_SOURCE_RTC_IMAGE_GIF | 8 |
VIDEO_SOURCE_REMOTE | 9 |
VIDEO_SOURCE_TRANSCODED | 10 |
VIDEO_SOURCE_CAMERA_THIRD | 11 |
VIDEO_SOURCE_CAMERA_FOURTH | 12 |
VIDEO_SOURCE_SCREEN_THIRD | 13 |
VIDEO_SOURCE_SCREEN_FOURTH | 14 |
VIDEO_SOURCE_UNKNOWN | 100 |
EUSER_OFFLINE_REASON_TYPE 3 members
| Member | value |
|---|---|
USER_OFFLINE_QUIT | 0 |
USER_OFFLINE_DROPPED | 1 |
USER_OFFLINE_BECOME_AUDIENCE | 2 |
EVIDEO_APPLICATION_SCENARIO_TYPE 4 members
| Member | value |
|---|---|
APPLICATION_SCENARIO_GENERAL | 0 |
APPLICATION_SCENARIO_MEETING | null |
APPLICATION_SCENARIO_1V1 | null |
APPLICATION_SCENARIO_LIVESHOW | null |
EVIDEO_CODEC_PROFILE_TYPE 3 members
| Member | value |
|---|---|
VIDEO_CODEC_PROFILE_BASELINE | 66 |
VIDEO_CODEC_PROFILE_MAIN | 77 |
VIDEO_CODEC_PROFILE_HIGH | 100 |
EVIDEO_CODEC_TYPE_FOR_STREAM 2 members
| Member | value |
|---|---|
VIDEO_CODEC_H264_FOR_STREAM | 1 |
VIDEO_CODEC_H265_FOR_STREAM | 2 |
EVIDEO_CONTENT_HINT 3 members
| Member | value |
|---|---|
CONTENT_HINT_NONE | null |
CONTENT_HINT_MOTION | null |
CONTENT_HINT_DETAILS | null |
EVIDEO_DENOISER_MODE 2 members
| Member | value |
|---|---|
VIDEO_DENOISER_AUTO | 0 |
VIDEO_DENOISER_MANUAL | 1 |
EVIDEO_STREAM_TYPE 2 members
| Member | value |
|---|---|
VIDEO_STREAM_HIGH | 0 |
VIDEO_STREAM_LOW | 1 |
EVIDEO_TRANSCODER_ERROR 6 members
| Member | value |
|---|---|
VT_ERR_VIDEO_SOURCE_NOT_READY | 1 |
VT_ERR_INVALID_VIDEO_SOURCE_TYPE | 2 |
VT_ERR_INVALID_IMAGE_PATH | 3 |
VT_ERR_UNSUPPORT_IMAGE_FORMAT | 4 |
VT_ERR_INVALID_LAYOUT | 5 |
VT_ERR_INTERNAL | 20 |
EVIDEO_VIEW_SETUP_MODE 3 members
| Member | value |
|---|---|
VIDEO_VIEW_SETUP_REPLACE | 0 |
VIDEO_VIEW_SETUP_ADD | 1 |
VIDEO_VIEW_SETUP_REMOVE | 2 |
EVOICE_AI_TUNER_TYPE 10 members
| Member | value |
|---|---|
VOICE_AI_TUNER_MATURE_MALE | 0 |
VOICE_AI_TUNER_FRESH_MALE | 1 |
VOICE_AI_TUNER_ELEGANT_FEMALE | 2 |
VOICE_AI_TUNER_SWEET_FEMALE | 3 |
VOICE_AI_TUNER_WARM_MALE_SINGING | 4 |
VOICE_AI_TUNER_GENTLE_FEMALE_SINGING | 5 |
VOICE_AI_TUNER_HUSKY_MALE_SINGING | 6 |
VOICE_AI_TUNER_WARM_ELEGANT_FEMALE_SINGING | 7 |
VOICE_AI_TUNER_POWERFUL_MALE_SINGING | 8 |
VOICE_AI_TUNER_DREAMY_FEMALE_SINGING | 9 |
EWATERMARK_FIT_MODE 2 members
| Member | value |
|---|---|
FIT_MODE_COVER_POSITION | null |
FIT_MODE_USE_IMAGE_RATIO | null |
FENUMWRAP_AREA_CODE 7 members
| Member | value |
|---|---|
AREA_CODE_CN | null |
AREA_CODE_NA | null |
AREA_CODE_EU | null |
AREA_CODE_AS | null |
AREA_CODE_JP | null |
AREA_CODE_IN | null |
AREA_CODE_GLOB | null |
FENUMWRAP_AUDIO_EFFECT_PRESET 21 members
| Member | value |
|---|---|
AUDIO_EFFECT_OFF | null |
ROOM_ACOUSTICS_KTV | null |
ROOM_ACOUSTICS_VOCAL_CONCERT | null |
ROOM_ACOUSTICS_STUDIO | null |
ROOM_ACOUSTICS_PHONOGRAPH | null |
ROOM_ACOUSTICS_VIRTUAL_STEREO | null |
ROOM_ACOUSTICS_SPACIAL | null |
ROOM_ACOUSTICS_ETHEREAL | null |
ROOM_ACOUSTICS_VIRTUAL_SURROUND_SOUND | null |
ROOM_ACOUSTICS_CHORUS | null |
ROOM_ACOUSTICS_3D_VOICE | null |
VOICE_CHANGER_EFFECT_UNCLE | null |
VOICE_CHANGER_EFFECT_OLDMAN | null |
VOICE_CHANGER_EFFECT_BOY | null |
VOICE_CHANGER_EFFECT_SISTER | null |
VOICE_CHANGER_EFFECT_GIRL | null |
VOICE_CHANGER_EFFECT_PIGKING | null |
VOICE_CHANGER_EFFECT_HULK | null |
STYLE_TRANSFORMATION_RNB | null |
STYLE_TRANSFORMATION_POPULAR | null |
PITCH_CORRECTION | null |
FENUMWRAP_AUDIO_MIXING_REASON_TYPE 7 members
| Member | value |
|---|---|
AUDIO_MIXING_REASON_OK | 0 |
AUDIO_MIXING_REASON_CAN_NOT_OPEN | 701 |
AUDIO_MIXING_REASON_TOO_FREQUENT_CALL | 702 |
AUDIO_MIXING_REASON_INTERRUPTED_EOF | 703 |
AUDIO_MIXING_REASON_ONE_LOOP_COMPLETED | 721 |
AUDIO_MIXING_REASON_ALL_LOOPS_COMPLETED | 723 |
AUDIO_MIXING_REASON_STOPPED_BY_USER | 724 |
FENUMWRAP_AUDIO_MIXING_STATE_TYPE 4 members
| Member | value |
|---|---|
AUDIO_MIXING_STATE_PLAYING | 710 |
AUDIO_MIXING_STATE_PAUSED | 711 |
AUDIO_MIXING_STATE_STOPPED | 713 |
AUDIO_MIXING_STATE_FAILED | 714 |
FENUMWRAP_CAMERA_STABILIZATION_MODE 5 members
| Member | value |
|---|---|
CAMERA_STABILIZATION_MODE_OFF | -1 |
CAMERA_STABILIZATION_MODE_AUTO | 0 |
CAMERA_STABILIZATION_MODE_LEVEL_1 | 1 |
CAMERA_STABILIZATION_MODE_LEVEL_2 | 2 |
CAMERA_STABILIZATION_MODE_LEVEL_3 | 3 |
FENUMWRAP_CAPTURE_BRIGHTNESS_LEVEL_TYPE 4 members
| Member | value |
|---|---|
CAPTURE_BRIGHTNESS_LEVEL_INVALID | -1 |
CAPTURE_BRIGHTNESS_LEVEL_NORMAL | 0 |
CAPTURE_BRIGHTNESS_LEVEL_BRIGHT | 1 |
CAPTURE_BRIGHTNESS_LEVEL_DARK | 2 |
FENUMWRAP_ENCODING_PREFERENCE 3 members
| Member | value |
|---|---|
PREFER_AUTO | -1 |
PREFER_SOFTWARE | 0 |
PREFER_HARDWARE | 1 |
FENUMWRAP_HEADPHONE_EQUALIZER_PRESET 3 members
| Member | value |
|---|---|
HEADPHONE_EQUALIZER_OFF | null |
HEADPHONE_EQUALIZER_OVEREAR | null |
HEADPHONE_EQUALIZER_INEAR | null |
FENUMWRAP_MEDIA_DEVICE_TYPE 8 members
| Member | value |
|---|---|
UNKNOWN_AUDIO_DEVICE | -1 |
AUDIO_PLAYOUT_DEVICE | 0 |
AUDIO_RECORDING_DEVICE | 1 |
VIDEO_RENDER_DEVICE | 2 |
VIDEO_CAPTURE_DEVICE | 3 |
AUDIO_APPLICATION_PLAYOUT_DEVICE | 4 |
AUDIO_VIRTUAL_PLAYOUT_DEVICE | null |
AUDIO_VIRTUAL_RECORDING_DEVICE | null |
FENUMWRAP_MEDIA_PLAYER_REASON 16 members
| Member | value |
|---|---|
PLAYER_REASON_NONE | 0 |
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
| Member | value |
|---|---|
NETWORK_TYPE_UNKNOWN | -1 |
NETWORK_TYPE_DISCONNECTED | 0 |
NETWORK_TYPE_LAN | 1 |
NETWORK_TYPE_WIFI | 2 |
NETWORK_TYPE_MOBILE_2G | 3 |
NETWORK_TYPE_MOBILE_3G | 4 |
NETWORK_TYPE_MOBILE_4G | 5 |
NETWORK_TYPE_MOBILE_5G | 6 |
FENUMWRAP_RHYTHM_PLAYER_REASON 5 members
| Member | value |
|---|---|
RHYTHM_PLAYER_REASON_OK | 0 |
RHYTHM_PLAYER_REASON_FAILED | 1 |
RHYTHM_PLAYER_REASON_CAN_NOT_OPEN | 801 |
RHYTHM_PLAYER_REASON_CAN_NOT_PLAY | 802 |
RHYTHM_PLAYER_REASON_FILE_OVER_DURATION_LIMIT | 803 |
FENUMWRAP_RHYTHM_PLAYER_STATE_TYPE 5 members
| Member | value |
|---|---|
RHYTHM_PLAYER_STATE_IDLE | 810 |
RHYTHM_PLAYER_STATE_OPENING | 811 |
RHYTHM_PLAYER_STATE_DECODING | 812 |
RHYTHM_PLAYER_STATE_PLAYING | 813 |
RHYTHM_PLAYER_STATE_FAILED | 814 |
FENUMWRAP_ScreenCaptureSourceType 4 members
| Member | value |
|---|---|
ScreenCaptureSourceType_Unknown | -1 |
ScreenCaptureSourceType_Window | 0 |
ScreenCaptureSourceType_Screen | 1 |
ScreenCaptureSourceType_Custom | 2 |
FENUMWRAP_SIMULCAST_STREAM_MODE 3 members
| Member | value |
|---|---|
AUTO_SIMULCAST_STREAM | -1 |
DISABLE_SIMULCAST_STREAM | 0 |
ENABLE_SIMULCAST_STREAM | 1 |
FENUMWRAP_VIDEO_CODEC_CAPABILITY_LEVEL 5 members
| Member | value |
|---|---|
CODEC_CAPABILITY_LEVEL_UNSPECIFIED | -1 |
CODEC_CAPABILITY_LEVEL_BASIC_SUPPORT | 5 |
CODEC_CAPABILITY_LEVEL_1080P30FPS | 10 |
CODEC_CAPABILITY_LEVEL_1080P60FPS | 20 |
CODEC_CAPABILITY_LEVEL_4K60FPS | 30 |
FENUMWRAP_VIDEO_ORIENTATION 4 members
| Member | value |
|---|---|
VIDEO_ORIENTATION_0 | 0 |
VIDEO_ORIENTATION_90 | 90 |
VIDEO_ORIENTATION_180 | 180 |
VIDEO_ORIENTATION_270 | 270 |
FENUMWRAP_VOICE_BEAUTIFIER_PRESET 14 members
| Member | value |
|---|---|
VOICE_BEAUTIFIER_OFF | null |
CHAT_BEAUTIFIER_MAGNETIC | null |
CHAT_BEAUTIFIER_FRESH | null |
CHAT_BEAUTIFIER_VITALITY | null |
SINGING_BEAUTIFIER | null |
TIMBRE_TRANSFORMATION_VIGOROUS | null |
TIMBRE_TRANSFORMATION_DEEP | null |
TIMBRE_TRANSFORMATION_MELLOW | null |
TIMBRE_TRANSFORMATION_FALSETTO | null |
TIMBRE_TRANSFORMATION_FULL | null |
TIMBRE_TRANSFORMATION_CLEAR | null |
TIMBRE_TRANSFORMATION_RESOUNDING | null |
TIMBRE_TRANSFORMATION_RINGING | null |
ULTRA_HIGH_QUALITY_VOICE | null |
FENUMWRAP_VOICE_CONVERSION_PRESET 5 members
| Member | value |
|---|---|
VOICE_CONVERSION_OFF | null |
VOICE_CHANGER_NEUTRAL | null |
VOICE_CHANGER_SWEET | null |
VOICE_CHANGER_SOLID | null |
VOICE_CHANGER_BASS | null |
error-code constants
| Constant | value |
|---|---|
VT_ERR_INTERNAL | 20 |
VT_ERR_INVALID_IMAGE_PATH | 3 |
VT_ERR_INVALID_LAYOUT | 5 |
VT_ERR_INVALID_VIDEO_SOURCE_TYPE | 2 |
VT_ERR_UNSUPPORT_IMAGE_FORMAT | 4 |
VT_ERR_VIDEO_SOURCE_NOT_READY | 1 |
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.
| Interface | Member |
|---|---|
FUABT_FilterEffectOptions | path |
FVideoCanvas | view |
IAudioDeviceCollection | GetApplicationVolume |
IAudioDeviceCollection | GetCount |
IAudioDeviceCollection | GetDefaultDevice |
IAudioDeviceCollection | GetDevice |
IAudioDeviceCollection | IsApplicationMute |
IAudioDeviceCollection | Release |
IAudioDeviceCollection | SetApplicationMute |
IAudioDeviceCollection | SetApplicationVolume |
IAudioDeviceCollection | SetDevice |
IAudioDeviceManager | EnumeratePlaybackDevices |
IAudioDeviceManager | EnumerateRecordingDevices |
IAudioDeviceManager | FollowSystemPlaybackDevice |
IAudioDeviceManager | FollowSystemRecordingDevice |
IAudioDeviceManager | GetPlaybackDevice |
IAudioDeviceManager | GetPlaybackDeviceInfo |
IAudioDeviceManager | GetPlaybackDeviceMute |
IAudioDeviceManager | GetRecordingDevice |
IAudioDeviceManager | GetRecordingDeviceInfo |
IAudioDeviceManager | GetRecordingDeviceMute |
IAudioDeviceManager | GetRecordingDeviceVolume |
IAudioDeviceManager | Release |
IAudioDeviceManager | SetPlaybackDevice |
IAudioDeviceManager | SetPlaybackDeviceMute |
IAudioDeviceManager | SetPlaybackDeviceVolume |
IAudioDeviceManager | SetRecordingDevice |
IAudioDeviceManager | SetRecordingDeviceMute |
IAudioDeviceManager | SetRecordingDeviceVolume |
IAudioDeviceManager | StartAudioDeviceLoopbackTest |
IAudioDeviceManager | StartPlaybackDeviceTest |
IAudioDeviceManager | StartRecordingDeviceTest |
IAudioDeviceManager | StopAudioDeviceLoopbackTest |
IAudioDeviceManager | StopPlaybackDeviceTest |
IAudioDeviceManager | StopRecordingDeviceTest |
IMediaPlayer | AdjustPlayoutVolume |
IMediaPlayer | AdjustPublishSignalVolume |
IMediaPlayer | GetDuration |
IMediaPlayer | GetMediaPlayerId |
IMediaPlayer | GetMute |
IMediaPlayer | GetPlayPosition |
IMediaPlayer | GetPlaySrc |
IMediaPlayer | GetPlayoutVolume |
IMediaPlayer | GetPublishSignalVolume |
IMediaPlayer | GetState |
IMediaPlayer | GetStreamCount |
IMediaPlayer | GetStreamInfo |
IMediaPlayer | Mute |
IMediaPlayer | Open |
IMediaPlayer | OpenWithMediaSource |
IMediaPlayer | Pause |
IMediaPlayer | Play |
IMediaPlayer | PlayPreloadedSrc |
IMediaPlayer | PreloadSrc |
IMediaPlayer | Resume |
IMediaPlayer | Seek |
IMediaPlayer | SelectAudioTrack |
IMediaPlayer | SelectMultiAudioTrack |
IMediaPlayer | SetAudioDualMonoMode |
IMediaPlayer | SetAudioPitch |
IMediaPlayer | SetLoopCount |
IMediaPlayer | SetPlaybackSpeed |
IMediaPlayer | SetPlayerOptionWithInt |
IMediaPlayer | SetPlayerOptionWithString |
IMediaPlayer | SetRenderMode |
IMediaPlayer | SetView |
IMediaPlayer | Stop |
IMediaPlayer | SwitchSrc |
IMediaPlayer | UnloadSrc |
IRtcEngine | AddVideoWatermark |
IRtcEngine | AdjustAudioMixingPlayoutVolume |
IRtcEngine | AdjustAudioMixingPublishVolume |
IRtcEngine | AdjustAudioMixingVolume |
IRtcEngine | AdjustLoopbackSignalVolume |
IRtcEngine | AdjustUserPlaybackSignalVolume |
IRtcEngine | ClearVideoWatermarks |
IRtcEngine | Complain |
IRtcEngine | ConfigRhythmPlayer |
IRtcEngine | CreateDataStream |
IRtcEngine | EnableContentInspect |
IRtcEngine | EnableEncryption |
IRtcEngine | EnableExtension |
IRtcEngine | EnableLoopbackRecording |
IRtcEngine | EnableMultiCamera |
IRtcEngine | EnableVideoImageSource |
IRtcEngine | EnableVoiceAITuner |
IRtcEngine | GetAgoraMediaPlayer |
IRtcEngine | GetAgoraRtcEngine |
IRtcEngine | GetAudioDeviceInfo |
IRtcEngine | GetAudioMixingCurrentPosition |
IRtcEngine | GetAudioMixingDuration |
IRtcEngine | GetAudioMixingPlayoutVolume |
IRtcEngine | GetAudioMixingPublishVolume |
IRtcEngine | GetAudioTrackCount |
IRtcEngine | GetCallId |
IRtcEngine | GetEffectCurrentPosition |
IRtcEngine | GetEffectDuration |
IRtcEngine | GetErrorDescription |
IRtcEngine | GetExtensionProperty |
IRtcEngine | GetFaceShapeAreaOptions |
IRtcEngine | GetFaceShapeBeautyOptions |
IRtcEngine | GetNtpWallTimeInMs |
IRtcEngine | GetScreenCaptureSources |
IRtcEngine | GetUserInfoByUid |
IRtcEngine | GetUserInfoByUserAccount |
IRtcEngine | GetVersion |
IRtcEngine | GetVolumeOfEffect |
IRtcEngine | JoinChannelWithOptions |
IRtcEngine | JoinChannelWithUserAccount |
IRtcEngine | LeaveChannelWithOptions |
IRtcEngine | LoadExtensionProvider |
IRtcEngine | MuteRemoteAudioStream |
IRtcEngine | MuteRemoteVideoStream |
IRtcEngine | PauseAllChannelMediaRelay |
IRtcEngine | PauseAllEffects |
IRtcEngine | PauseAudioMixing |
IRtcEngine | PauseEffect |
IRtcEngine | PlayAllEffects |
IRtcEngine | PlayEffect |
IRtcEngine | PreloadChannel |
IRtcEngine | PreloadChannelWithUserAccount |
IRtcEngine | PreloadEffect |
IRtcEngine | QueryCameraFocalLengthCapability |
IRtcEngine | QueryCodecCapability |
IRtcEngine | Rate |
IRtcEngine | RegisterExtension |
IRtcEngine | RegisterLocalUserAccount |
IRtcEngine | RenewToken |
IRtcEngine | ResumeAllChannelMediaRelay |
IRtcEngine | ResumeAllEffects |
IRtcEngine | ResumeAudioMixing |
IRtcEngine | ResumeEffect |
IRtcEngine | SelectAudioTrack |
IRtcEngine | SendCustomReportMessage |
IRtcEngine | SendStreamMessage |
IRtcEngine | SetAVSyncSource |
IRtcEngine | SetAdvancedAudioOptions |
IRtcEngine | SetAudioMixingDualMonoMode |
IRtcEngine | SetAudioMixingPitch |
IRtcEngine | SetAudioMixingPlaybackSpeed |
IRtcEngine | SetAudioMixingPosition |
IRtcEngine | SetCameraCapturerConfiguration |
IRtcEngine | SetEffectPosition |
IRtcEngine | SetExtensionProperty |
IRtcEngine | SetExtensionProviderProperty |
IRtcEngine | SetFaceShapeAreaOptions |
IRtcEngine | SetFaceShapeBeautyOptions |
IRtcEngine | SetFilterEffectOptions |
IRtcEngine | SetLocalVoiceFormant |
IRtcEngine | SetLogFile |
IRtcEngine | SetLogFileSize |
IRtcEngine | SetParameters |
IRtcEngine | SetSubscribeAudioAllowlist |
IRtcEngine | SetSubscribeAudioBlocklist |
IRtcEngine | SetSubscribeVideoAllowlist |
IRtcEngine | SetSubscribeVideoBlocklist |
IRtcEngine | SetVideoEncoderConfiguration |
IRtcEngine | SetVolumeOfEffect |
IRtcEngine | SetupLocalVideo |
IRtcEngine | SetupRemoteVideo |
IRtcEngine | StartAudioMixing |
IRtcEngine | StartAudioRecording |
IRtcEngine | StartEchoTest |
IRtcEngine | StartLastmileProbeTest |
IRtcEngine | StartLocalVideoTranscoder |
IRtcEngine | StartMediaRenderingTracing |
IRtcEngine | StartOrUpdateChannelMediaRelay |
IRtcEngine | StartPreview |
IRtcEngine | StartRhythmPlayer |
IRtcEngine | StartRtmpStreamWithTranscoding |
IRtcEngine | StartRtmpStreamWithoutTranscoding |
IRtcEngine | StartScreenCapture |
IRtcEngine | StartScreenCaptureByDisplayId |
IRtcEngine | StartScreenCaptureByScreenRect |
IRtcEngine | StartScreenCaptureBySourceType |
IRtcEngine | StartScreenCaptureByWindowId |
IRtcEngine | StopAllEffects |
IRtcEngine | StopAudioMixing |
IRtcEngine | StopAudioRecording |
IRtcEngine | StopChannelMediaRelay |
IRtcEngine | StopEchoTest |
IRtcEngine | StopEffect |
IRtcEngine | StopLastmileProbeTest |
IRtcEngine | StopLocalVideoTranscoder |
IRtcEngine | StopPreview |
IRtcEngine | StopRhythmPlayer |
IRtcEngine | StopRtmpStream |
IRtcEngine | StopScreenCapture |
IRtcEngine | StopScreenCaptureBySourceType |
IRtcEngine | TakeSnapshot |
IRtcEngine | TakeSnapshotWithConfig |
IRtcEngine | UnloadAllEffects |
IRtcEngine | UnloadEffect |
IRtcEngine | UpdateChannelMediaOptions |
IRtcEngine | UpdateLocalTranscoderConfiguration |
IRtcEngine | UpdatePreloadChannelToken |
IRtcEngine | UpdateRtmpTranscoding |
IRtcEngine | UpdateScreenCapture |
IRtcEngine | UpdateScreenCaptureParameters |
IRtcEngine | UpdateScreenCaptureRegion |
IRtcEngineEx | AddVideoWatermarkEx |
IRtcEngineEx | AdjustUserPlaybackSignalVolumeEx |
IRtcEngineEx | ClearVideoWatermarkEx |
IRtcEngineEx | CreateDataStreamEx |
IRtcEngineEx | EnableAudioVolumeIndicationEx |
IRtcEngineEx | EnableContentInspectEx |
IRtcEngineEx | EnableDualStreamModeEx |
IRtcEngineEx | EnableEncryptionEx |
IRtcEngineEx | EnableLoopbackRecordingEx |
IRtcEngineEx | GetCallIdEx |
IRtcEngineEx | GetConnectionStateEx |
IRtcEngineEx | JoinChannelEx |
IRtcEngineEx | JoinChannelWithUserAccountEx |
IRtcEngineEx | LeaveChannelEx |
IRtcEngineEx | MuteAllRemoteAudioStreamsEx |
IRtcEngineEx | MuteAllRemoteVideoStreamsEx |
IRtcEngineEx | MuteLocalAudioStreamEx |
IRtcEngineEx | MuteLocalVideoStreamEx |
IRtcEngineEx | MuteRemoteAudioStreamEx |
IRtcEngineEx | MuteRemoteVideoStreamEx |
IRtcEngineEx | PauseAllChannelMediaRelayEx |
IRtcEngineEx | ResumeAllChannelMediaRelayEx |
IRtcEngineEx | SendCustomReportMessageEx |
IRtcEngineEx | SendStreamMessageEx |
IRtcEngineEx | SetDualStreamModeEx |
IRtcEngineEx | SetRemoteRenderModeEx |
IRtcEngineEx | SetRemoteVideoStreamTypeEx |
IRtcEngineEx | SetRemoteVoicePositionEx |
IRtcEngineEx | SetSubscribeAudioAllowlistEx |
IRtcEngineEx | SetSubscribeAudioBlocklistEx |
IRtcEngineEx | SetSubscribeVideoAllowlistEx |
IRtcEngineEx | SetSubscribeVideoBlocklistEx |
IRtcEngineEx | SetVideoEncoderConfigurationEx |
IRtcEngineEx | SetupRemoteVideoEx |
IRtcEngineEx | StartMediaRenderingTracingEx |
IRtcEngineEx | StartOrUpdateChannelMediaRelayEx |
IRtcEngineEx | StartRtmpStreamWithTranscodingEx |
IRtcEngineEx | StartRtmpStreamWithoutTranscodingEx |
IRtcEngineEx | StopChannelMediaRelayEx |
IRtcEngineEx | StopRtmpStreamEx |
IRtcEngineEx | TakeSnapshotEx |
IRtcEngineEx | TakeSnapshotWithConfigEx |
IRtcEngineEx | UpdateChannelMediaOptionsEx |
IRtcEngineEx | UpdateRtmpTranscodingEx |
IScreenCaptureSourceList | GetCount |
IScreenCaptureSourceList | GetSourceInfo |
IScreenCaptureSourceList | Release |
IVideoDeviceCollection | GetCount |
IVideoDeviceCollection | GetDevice |
IVideoDeviceCollection | Release |
IVideoDeviceCollection | SetDevice |
IVideoDeviceManager | EnumerateVideoDevices |
IVideoDeviceManager | GetCapability |
IVideoDeviceManager | NumberOfCapabilities |
IVideoDeviceManager | Release |
__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 |