nimeet 文档中心
English

Unreal Engine(C++) API 参考

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

由公开 SDK 接口定义生成

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

接口概览

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

核对项数量
接口 / 类140
方法603
方法重载629
属性611
枚举145
错误码常量46

可用性

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

加入频道核心链路

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

步骤接口方法重载数
订阅远端媒体IBaseSpatialAudioEnginemuteRemoteAudioStream1
创建 / 初始化ILocalSpatialAudioEngineinitialize1
续期 TokenIMusicContentCenterrenewToken1
开启视频与预览IRtcEngineenableVideo1
加入频道IRtcEnginejoinChannel2
离开频道IRtcEngineleaveChannel2
频道场景IRtcEnginesetChannelProfile1
角色切换IRtcEnginesetClientRole2
本地画面IRtcEnginesetupLocalVideo1

最小可运行链路的参数

参数类型可选可变参数
uiduid_t否否
mutebool否否
configconst LocalSpatialAudioConfig&否否
tokenconst char*否否
tokenconst char*否否
channelIdconst char*否否
infoconst char*否否
uiduid_t否否
tokenconst char*否否
channelIdconst char*否否
uiduid_t否否
optionsconst ChannelMediaOptions&否否
optionsconst LeaveChannelOptions&否否
profileCHANNEL_PROFILE_TYPE否否
roleCLIENT_ROLE_TYPE否否
roleCLIENT_ROLE_TYPE否否
optionsconst ClientRoleOptions&否否
canvasconst VideoCanvas&否否

接口索引

接口方法属性事件
__unattributed__1400
AdvancedAudioOptions010
AdvancedConfigInfo010
AdvanceOptions030
AgoraRhythmPlayerConfig020
AudioEncodedFrameObserverConfig020
AudioFrame080
AudioParams040
AudioPcmFrame070
AudioRecordingConfiguration060
AudioSpectrumData020
AudioTrackConfig020
AudioVolumeInfo040
BeautyOptions050
CacheStatistics030
CameraCapturerConfiguration060
ChannelMediaInfo030
ChannelMediaOptions0330
ChannelMediaRelayConfiguration030
ClientRoleOptions010
ClimaxSegment020
CodecCapInfo030
CodecCapLevels020
ColorEnhanceOptions020
ContentInspectConfig040
ContentInspectModule020
DataStreamConfig020
DeviceInfo010
DirectCdnStreamingMediaOptions050
DirectCdnStreamingStats050
EchoTestConfiguration060
EncodedAudioFrameInfo050
EncodedVideoFrameInfo0110
EncryptionConfig040
ExtensionContext040
ExternalVideoFrame0220
FaceShapeAreaOptions020
FaceShapeBeautyOptions020
FilterEffectOptions110
FocalLengthInfo020
IAgoraParameter100
IAudioDeviceCollection900
IAudioDeviceManager2700
IAudioEncodedFrameObserver300
IAudioFrameObserverBase900
IAudioPcmFrameSink100
IAudioSpectrumObserver200
IBaseSpatialAudioEngine1200
IDirectCdnStreamingEventHandler200
ILocalSpatialAudioEngine400
ImageTrackOptions020
IMediaEngine1000
IMediaPlayer4100
IMediaPlayerCacheManager1100
IMediaPlayerCustomDataProvider200
IMediaPlayerSourceObserver1100
IMediaRecorder300
IMediaRecorderObserver200
IMetadataObserver300
IMusicContentCenter1700
IMusicContentCenterEventHandler500
IMusicPlayer200
IPacketObserver400
IRtcEngine25600
IRtcEngineEventHandler8300
IRtcEngineEx4400
IScreenCaptureSourceList300
IVideoDeviceCollection400
IVideoDeviceManager600
IVideoEncodedFrameObserver100
IVideoFrameObserver900
LastmileProbeConfig040
LastmileProbeOneWayResult030
LastmileProbeResult040
LeaveChannelOptions030
LiveStreamAdvancedFeature020
LiveTranscoding0230
LocalAccessPointConfiguration070
LocalAudioMixerConfiguration030
LocalAudioStats080
LocalSpatialAudioConfig010
LocalTranscoderConfiguration030
LocalVideoStats0220
LogConfig030
LogUploadServerInfo040
LowlightEnhanceOptions020
MediaRecorderConfiguration0110
MediaSource090
Metadata050
MixedAudioStream040
Music0120
MusicCacheInfo020
MusicChartCollection020
MusicChartInfo020
MusicCollection050
MusicContentCenterConfiguration050
Packet020
PlayerPlaybackStats040
PlayerStreamInfo0130
PlayerUpdatedInfo060
RecorderInfo030
RecorderStreamInfo030
Rectangle040
RemoteAudioStats0160
RemoteVideoStats0160
RemoteVoicePositionInfo020
RtcConnection020
RtcEngineContext090
RtcImage070
RtcStats0240
ScreenAudioParameters030
ScreenCaptureConfiguration060
ScreenCaptureParameters0100
ScreenCaptureParameters2040
ScreenCaptureSourceInfo0110
ScreenVideoParameters040
SegmentationProperty020
SimulcastStreamConfig030
SnapshotConfig020
SpatialAudioParams080
SpatialAudioZone090
SrcInfo020
ThumbImageBuffer040
TranscodingUser080
TranscodingVideoStream0110
UplinkNetworkInfo010
UserAudioSpectrumInfo020
UserInfo020
VideoCanvas170
VideoDenoiserOptions020
VideoDimensions020
VideoEncoderConfiguration090
VideoFormat030
VideoFrame0220
VideoLayout080
VideoRenderingTracingInfo070
VideoSubscriptionOptions020
VirtualBackgroundSource040
WatermarkOptions050
WatermarkRatio030

全部接口

__unattributed__ 14 方法 / 0 属性
typescript
destroyMediaRecorder(mediaRecorder: agora_refptr): int
get(index: int): MusicChartInfo*
getCount(): int
getCount(): int
getMusic(index: int32_t): Music*
getPage(): int
getPageSize(): int
getPlaybackDeviceInfo(null: char deviceId[MAX_DEVICE_ID_LENGTH], null: char deviceName[MAX_DEVICE_ID_LENGTH], null: char deviceTypeName[MAX_DEVICE_ID_LENGTH]): int
getPlaybackDeviceVolume(volume: int*): int
getRecordingDeviceInfo(null: char deviceId[MAX_DEVICE_ID_LENGTH], null: char deviceName[MAX_DEVICE_ID_LENGTH], null: char deviceTypeName[MAX_DEVICE_ID_LENGTH]): int
getTotal(): int
onPlaybackAudioFrameBeforeMixing(channelId: const char*, uid: rtc::uid_t, audioFrame: AudioFrame&): bool
setExternalMediaProjection(mediaProjection: void*): int
setLocalAccessPoint(config: const LocalAccessPointConfiguration&): int
startAudioRecording(filePath: const char*, quality: AUDIO_RECORDING_QUALITY_TYPE): int
startAudioRecording(filePath: const char*, sampleRate: int, quality: AUDIO_RECORDING_QUALITY_TYPE): int

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

方法参数返回值错误
destroyMediaRecordermediaRecorder: agora_refptrint错误码索引
getindex: intMusicChartInfo*错误码索引
getCount—int错误码索引
getMusicindex: int32_tMusic*错误码索引
getPage—int错误码索引
getPageSize—int错误码索引
getPlaybackDeviceInfonull: char deviceId[MAX_DEVICE_ID_LENGTH], null: char deviceName[MAX_DEVICE_ID_LENGTH], null: char deviceTypeName[MAX_DEVICE_ID_LENGTH]int错误码索引
getPlaybackDeviceVolumevolume: int*int错误码索引
getRecordingDeviceInfonull: char deviceId[MAX_DEVICE_ID_LENGTH], null: char deviceName[MAX_DEVICE_ID_LENGTH], null: char deviceTypeName[MAX_DEVICE_ID_LENGTH]int错误码索引
getTotal—int错误码索引
onPlaybackAudioFrameBeforeMixingchannelId: const char*, uid: rtc::uid_t, audioFrame: AudioFrame&bool错误码索引
setExternalMediaProjectionmediaProjection: void*int错误码索引
setLocalAccessPointconfig: const LocalAccessPointConfiguration&int错误码索引
startAudioRecordingfilePath: const char*, quality: AUDIO_RECORDING_QUALITY_TYPEint错误码索引
AdvancedAudioOptions 0 方法 / 1 属性
属性类型只读
audioProcessingChannelsAUDIO_PROCESSING_CHANNELS否
AdvancedConfigInfo 0 方法 / 1 属性
属性类型只读
logUploadServerLogUploadServerInfo否
AdvanceOptions 0 方法 / 3 属性
属性类型只读
encodingPreferenceENCODING_PREFERENCE否
compressionPreferenceCOMPRESSION_PREFERENCE否
encodeAlphabool否
AgoraRhythmPlayerConfig 0 方法 / 2 属性
属性类型只读
beatsPerMeasureint否
beatsPerMinuteint否
AudioEncodedFrameObserverConfig 0 方法 / 2 属性
属性类型只读
postionTypeAUDIO_ENCODED_FRAME_OBSERVER_POSITION否
encodingTypeAUDIO_ENCODING_TYPE否
AudioFrame 0 方法 / 8 属性
属性类型只读
typeAUDIO_FRAME_TYPE否
samplesPerChannelint否
bytesPerSampleagora::rtc::BYTES_PER_SAMPLE否
channelsint否
samplesPerSecint否
buffervoid*否
renderTimeMsint64_t否
avsync_typeint否
AudioParams 0 方法 / 4 属性
属性类型只读
sample_rateint否
channelsint否
modertc::RAW_AUDIO_FRAME_OP_MODE_TYPE否
samples_per_callint否
AudioPcmFrame 0 方法 / 7 属性
属性类型只读
OPTIONAL_ENUM_SIZE_Tunknown否
capture_timestampuint32_t否
samples_per_channel_size_t否
sample_rate_hz_int否
num_channels_size_t否
bytes_per_samplertc::BYTES_PER_SAMPLE否
data_int16_t否
AudioRecordingConfiguration 0 方法 / 6 属性
属性类型只读
filePathchar*否
encodebool否
sampleRateint否
fileRecordingTypeAUDIO_FILE_RECORDING_TYPE否
qualityAUDIO_RECORDING_QUALITY_TYPE否
recordingChannelint否
AudioSpectrumData 0 方法 / 2 属性
属性类型只读
audioSpectrumDataunknown否
dataLengthint否
AudioTrackConfig 0 方法 / 2 属性
属性类型只读
enableLocalPlaybackbool否
enableAudioProcessingbool否
AudioVolumeInfo 0 方法 / 4 属性
属性类型只读
uiduid_t否
volumeunsigned int否
vadunsigned int否
voicePitchdouble否
BeautyOptions 0 方法 / 5 属性
属性类型只读
lighteningContrastLevelLIGHTENING_CONTRAST_LEVEL否
lighteningLevelfloat否
smoothnessLevelfloat否
rednessLevelfloat否
sharpnessLevelfloat否
CacheStatistics 0 方法 / 3 属性
属性类型只读
fileSizeint64_t否
cacheSizeint64_t否
downloadSizeint64_t否
CameraCapturerConfiguration 0 方法 / 6 属性
属性类型只读
cameraDirectionunknown否
cameraIdunknown否
cameraFocalLengthTypeOptional否
formatVideoFormat否
deviceIdunknown否
followEncodeDimensionRatiounknown否
ChannelMediaInfo 0 方法 / 3 属性
属性类型只读
channelNamechar*否
tokenchar*否
uiduid_t否
ChannelMediaOptions 0 方法 / 33 属性
属性类型只读
publishCameraTrackOptional否
publishSecondaryCameraTrackOptional否
publishMicrophoneTrackOptional否
publishThirdCameraTrackOptional否
publishFourthCameraTrackOptional否
publishScreenTrackunknown否
publishScreenCaptureVideounknown否
publishScreenCaptureAudioOptional否
publishSecondaryScreenTrackOptional否
publishThirdScreenTrackOptional否
publishFourthScreenTrackOptional否
publishTranscodedVideoTrackOptional否
publishMixedAudioTrackOptional否
publishCustomAudioTrackunknown否
publishCustomAudioTrackIdOptional否
publishCustomVideoTrackOptional否
publishEncodedVideoTrackOptional否
publishMediaPlayerAudioTrackOptional否
publishMediaPlayerVideoTrackOptional否
autoSubscribeAudioOptional否
autoSubscribeVideoOptional否
enableAudioRecordingOrPlayoutOptional否
publishMediaPlayerIdOptional否
clientRoleTypeOptional否
audienceLatencyLevelOptional否
defaultVideoStreamTypeOptional否
channelProfileOptional否
audioDelayMsunknown否
tokenOptional否
publishRhythmPlayerTrackOptional否
isInteractiveAudienceOptional否
customVideoTrackIdOptional否
isAudioFilterableOptional否
ChannelMediaRelayConfiguration 0 方法 / 3 属性
属性类型只读
srcInfoChannelMediaInfo*否
destInfosChannelMediaInfo*否
destCountint否
ClientRoleOptions 0 方法 / 1 属性
属性类型只读
audienceLatencyLevelAUDIENCE_LATENCY_LEVEL_TYPE否
ClimaxSegment 0 方法 / 2 属性
属性类型只读
startTimeMsint32_t否
endTimeMsint32_t否
CodecCapInfo 0 方法 / 3 属性
属性类型只读
codecTypeVIDEO_CODEC_TYPE否
codecCapMaskint否
codecLevelsCodecCapLevels否
CodecCapLevels 0 方法 / 2 属性
属性类型只读
hwDecodingLevelVIDEO_CODEC_CAPABILITY_LEVEL否
swDecodingLevelVIDEO_CODEC_CAPABILITY_LEVEL否
ColorEnhanceOptions 0 方法 / 2 属性
属性类型只读
strengthLevelfloat否
skinProtectLevelfloat否
ContentInspectConfig 0 方法 / 4 属性
属性类型只读
extraInfochar*否
serverConfigchar*否
modulesContentInspectModule否
moduleCountint否
ContentInspectModule 0 方法 / 2 属性
属性类型只读
typeCONTENT_INSPECT_TYPE否
intervalunsigned int否
DataStreamConfig 0 方法 / 2 属性
属性类型只读
syncWithAudiobool否
orderedbool否
DeviceInfo 0 方法 / 1 属性
属性类型只读
isLowLatencyAudioSupportedbool否
DirectCdnStreamingMediaOptions 0 方法 / 5 属性
属性类型只读
publishCameraTrackOptional否
publishMicrophoneTrackOptional否
publishCustomAudioTrackOptional否
publishCustomVideoTrackOptional否
customVideoTrackIdOptional否
DirectCdnStreamingStats 0 方法 / 5 属性
属性类型只读
videoWidthint否
videoHeightint否
fpsint否
videoBitrateint否
audioBitrateint否
EchoTestConfiguration 0 方法 / 6 属性
属性类型只读
viewview_t否
enableAudiobool否
enableVideobool否
tokenchar*否
channelIdchar*否
intervalInSecondsint否
EncodedAudioFrameInfo 0 方法 / 5 属性
属性类型只读
codecAUDIO_CODEC_TYPE否
sampleRateHzint否
samplesPerChannelint否
numberOfChannelsint否
advancedSettingsEncodedAudioFrameAdvancedSettings否
EncodedVideoFrameInfo 0 方法 / 11 属性
属性类型只读
codecTypeunknown否
widthunknown否
heightunknown否
framesPerSecondunknown否
frameTypeunknown否
rotationunknown否
trackIdunknown否
captureTimeMsunknown否
decodeTimeMsunknown否
uidunknown否
streamTypeunknown否
EncryptionConfig 0 方法 / 4 属性
属性类型只读
encryptionModeENCRYPTION_MODE否
encryptionKeychar*否
encryptionKdfSaltuint8_t否
datastreamEncryptionEnabledbool否
ExtensionContext 0 方法 / 4 属性
属性类型只读
isValidbool否
uiduid_t否
providerNameunknown否
extensionNameunknown否
ExternalVideoFrame 0 方法 / 22 属性
属性类型只读
typeVIDEO_BUFFER_TYPE否
formatVIDEO_PIXEL_FORMAT否
buffervoid*否
strideint否
heightint否
eglContextvoid*否
eglTypeEGL_CONTEXT_TYPE否
textureIdint否
metadataBufferuint8_t*否
metadataSizeint否
d3d11Texture2dunknown否
alphaBufferuint8_t*否
fillAlphaBufferbool否
alphaStitchModeALPHA_STITCH_MODE否
textureSliceIndexint否
cropLeftint否
cropTopint否
cropRightint否
cropBottomint否
rotationint否
timestamplong long否
colorSpaceColorSpace否
FaceShapeAreaOptions 0 方法 / 2 属性
属性类型只读
shapeAreaFACE_SHAPE_AREA否
shapeIntensityint否
FaceShapeBeautyOptions 0 方法 / 2 属性
属性类型只读
shapeStyleFACE_SHAPE_BEAUTY_STYLE否
styleIntensityint否
FilterEffectOptions 1 方法 / 1 属性
typescript
path(): unknown

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

方法参数返回值错误
path—unknown错误码索引
属性类型只读
strengthfloat否
FocalLengthInfo 0 方法 / 2 属性
属性类型只读
cameraDirectionint否
focalLengthTypeCAMERA_FOCAL_LENGTH_TYPE否
IAgoraParameter 1 方法 / 0 属性
typescript
setParameters(parameters: const char*): int

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

方法参数返回值错误
setParametersparameters: const char*int错误码索引
IAudioDeviceCollection 9 方法 / 0 属性
typescript
getApplicationVolume(volume: int&): int
getCount(): int
getDefaultDevice(null: char deviceName[MAX_DEVICE_ID_LENGTH], null: char deviceId[MAX_DEVICE_ID_LENGTH]): int
getDefaultDevice(null: char deviceName[MAX_DEVICE_ID_LENGTH], null: char deviceTypeName[MAX_DEVICE_ID_LENGTH], null: char deviceId[MAX_DEVICE_ID_LENGTH]): int
getDevice(index: int, null: char deviceName[MAX_DEVICE_ID_LENGTH], null: char deviceId[MAX_DEVICE_ID_LENGTH]): int
getDevice(index: int, null: char deviceName[MAX_DEVICE_ID_LENGTH], null: char deviceTypeName[MAX_DEVICE_ID_LENGTH], null: char deviceId[MAX_DEVICE_ID_LENGTH]): int
isApplicationMute(mute: bool&): int
release(): void
setApplicationMute(mute: bool): int
setApplicationVolume(volume: int): int
setDevice(null: const char deviceId[MAX_DEVICE_ID_LENGTH]): int

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

方法参数返回值错误
getApplicationVolumevolume: int&int错误码索引
getCount—int错误码索引
getDefaultDevicenull: char deviceName[MAX_DEVICE_ID_LENGTH], null: char deviceId[MAX_DEVICE_ID_LENGTH]int错误码索引
getDeviceindex: int, null: char deviceName[MAX_DEVICE_ID_LENGTH], null: char deviceId[MAX_DEVICE_ID_LENGTH]int错误码索引
isApplicationMutemute: bool&int错误码索引
release—void错误码索引
setApplicationMutemute: boolint错误码索引
setApplicationVolumevolume: intint错误码索引
setDevicenull: const char deviceId[MAX_DEVICE_ID_LENGTH]int错误码索引
IAudioDeviceManager 27 方法 / 0 属性
typescript
enumeratePlaybackDevices(): IAudioDeviceCollection*
enumerateRecordingDevices(): IAudioDeviceCollection*
followSystemLoopbackDevice(enable: bool): int
followSystemPlaybackDevice(enable: bool): int
followSystemRecordingDevice(enable: bool): int
getLoopbackDevice(null: char deviceId[MAX_DEVICE_ID_LENGTH]): int
getPlaybackDevice(null: char deviceId[MAX_DEVICE_ID_LENGTH]): int
getPlaybackDeviceInfo(null: char deviceId[MAX_DEVICE_ID_LENGTH], null: char deviceName[MAX_DEVICE_ID_LENGTH]): int
getPlaybackDeviceMute(mute: bool*): int
getRecordingDevice(null: char deviceId[MAX_DEVICE_ID_LENGTH]): int
getRecordingDeviceInfo(null: char deviceId[MAX_DEVICE_ID_LENGTH], null: char deviceName[MAX_DEVICE_ID_LENGTH]): int
getRecordingDeviceMute(mute: bool*): int
getRecordingDeviceVolume(volume: int*): int
release(): void
setLoopbackDevice(null: const char deviceId[MAX_DEVICE_ID_LENGTH]): int
setPlaybackDevice(null: const char deviceId[MAX_DEVICE_ID_LENGTH]): int
setPlaybackDeviceMute(mute: bool): int
setPlaybackDeviceVolume(volume: int): int
setRecordingDevice(null: const char deviceId[MAX_DEVICE_ID_LENGTH]): int
setRecordingDeviceMute(mute: bool): int
setRecordingDeviceVolume(volume: int): int
startAudioDeviceLoopbackTest(indicationInterval: int): int
startPlaybackDeviceTest(testAudioFilePath: const char*): int
startRecordingDeviceTest(indicationInterval: int): int
stopAudioDeviceLoopbackTest(): int
stopPlaybackDeviceTest(): int
stopRecordingDeviceTest(): int

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

方法参数返回值错误
enumeratePlaybackDevices—IAudioDeviceCollection*错误码索引
enumerateRecordingDevices—IAudioDeviceCollection*错误码索引
followSystemLoopbackDeviceenable: boolint错误码索引
followSystemPlaybackDeviceenable: boolint错误码索引
followSystemRecordingDeviceenable: boolint错误码索引
getLoopbackDevicenull: char deviceId[MAX_DEVICE_ID_LENGTH]int错误码索引
getPlaybackDevicenull: char deviceId[MAX_DEVICE_ID_LENGTH]int错误码索引
getPlaybackDeviceInfonull: char deviceId[MAX_DEVICE_ID_LENGTH], null: char deviceName[MAX_DEVICE_ID_LENGTH]int错误码索引
getPlaybackDeviceMutemute: bool*int错误码索引
getRecordingDevicenull: char deviceId[MAX_DEVICE_ID_LENGTH]int错误码索引
getRecordingDeviceInfonull: char deviceId[MAX_DEVICE_ID_LENGTH], null: char deviceName[MAX_DEVICE_ID_LENGTH]int错误码索引
getRecordingDeviceMutemute: bool*int错误码索引
getRecordingDeviceVolumevolume: int*int错误码索引
release—void错误码索引
setLoopbackDevicenull: const char deviceId[MAX_DEVICE_ID_LENGTH]int错误码索引
setPlaybackDevicenull: const char deviceId[MAX_DEVICE_ID_LENGTH]int错误码索引
setPlaybackDeviceMutemute: boolint错误码索引
setPlaybackDeviceVolumevolume: intint错误码索引
setRecordingDevicenull: const char deviceId[MAX_DEVICE_ID_LENGTH]int错误码索引
setRecordingDeviceMutemute: boolint错误码索引
setRecordingDeviceVolumevolume: intint错误码索引
startAudioDeviceLoopbackTestindicationInterval: intint错误码索引
startPlaybackDeviceTesttestAudioFilePath: const char*int错误码索引
startRecordingDeviceTestindicationInterval: intint错误码索引
stopAudioDeviceLoopbackTest—int错误码索引
stopPlaybackDeviceTest—int错误码索引
stopRecordingDeviceTest—int错误码索引
IAudioEncodedFrameObserver 3 方法 / 0 属性
typescript
onMixedAudioEncodedFrame(frameBuffer: const uint8_t*, length: int, audioEncodedFrameInfo: const EncodedAudioFrameInfo&): void
onPlaybackAudioEncodedFrame(frameBuffer: const uint8_t*, length: int, audioEncodedFrameInfo: const EncodedAudioFrameInfo&): void
onRecordAudioEncodedFrame(frameBuffer: const uint8_t*, length: int, audioEncodedFrameInfo: const EncodedAudioFrameInfo&): void

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

方法参数返回值错误
onMixedAudioEncodedFrameframeBuffer: const uint8_t*, length: int, audioEncodedFrameInfo: const EncodedAudioFrameInfo&void错误码索引
onPlaybackAudioEncodedFrameframeBuffer: const uint8_t*, length: int, audioEncodedFrameInfo: const EncodedAudioFrameInfo&void错误码索引
onRecordAudioEncodedFrameframeBuffer: const uint8_t*, length: int, audioEncodedFrameInfo: const EncodedAudioFrameInfo&void错误码索引
IAudioFrameObserverBase 9 方法 / 0 属性
typescript
getEarMonitoringAudioParams(): AudioParams
getMixedAudioParams(): AudioParams
getObservedAudioFramePosition(): int
getPlaybackAudioParams(): AudioParams
getRecordAudioParams(): AudioParams
onEarMonitoringAudioFrame(audioFrame: AudioFrame&): bool
onMixedAudioFrame(channelId: const char*, audioFrame: AudioFrame&): bool
onPlaybackAudioFrame(channelId: const char*, audioFrame: AudioFrame&): bool
onRecordAudioFrame(channelId: const char*, audioFrame: AudioFrame&): bool

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

方法参数返回值错误
getEarMonitoringAudioParams—AudioParams错误码索引
getMixedAudioParams—AudioParams错误码索引
getObservedAudioFramePosition—int错误码索引
getPlaybackAudioParams—AudioParams错误码索引
getRecordAudioParams—AudioParams错误码索引
onEarMonitoringAudioFrameaudioFrame: AudioFrame&bool错误码索引
onMixedAudioFramechannelId: const char*, audioFrame: AudioFrame&bool错误码索引
onPlaybackAudioFramechannelId: const char*, audioFrame: AudioFrame&bool错误码索引
onRecordAudioFramechannelId: const char*, audioFrame: AudioFrame&bool错误码索引
IAudioPcmFrameSink 1 方法 / 0 属性
typescript
onFrame(frame: agora::media::base::AudioPcmFrame*): void

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

方法参数返回值错误
onFrameframe: agora::media::base::AudioPcmFrame*void错误码索引
IAudioSpectrumObserver 2 方法 / 0 属性
typescript
onLocalAudioSpectrum(data: const AudioSpectrumData&): bool
onRemoteAudioSpectrum(spectrums: const UserAudioSpectrumInfo*, spectrumNumber: unsigned int): bool

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

方法参数返回值错误
onLocalAudioSpectrumdata: const AudioSpectrumData&bool错误码索引
onRemoteAudioSpectrumspectrums: const UserAudioSpectrumInfo*, spectrumNumber: unsigned intbool错误码索引
IBaseSpatialAudioEngine 12 方法 / 0 属性
typescript
muteAllRemoteAudioStreams(mute: bool): int
muteLocalAudioStream(mute: bool): int
muteRemoteAudioStream(uid: uid_t, mute: bool): int
release(): void
setAudioRecvRange(range: float): int
setDistanceUnit(unit: float): int
setMaxAudioRecvCount(maxCount: int): int
setPlayerAttenuation(playerId: int, attenuation: double, forceSet: bool): int
setRemoteAudioAttenuation(uid: uid_t, attenuation: double, forceSet: bool): int
setZones(zones: const SpatialAudioZone*, zoneCount: unsigned int): int
updatePlayerPositionInfo(playerId: int, positionInfo: const RemoteVoicePositionInfo&): int
updateSelfPosition(null: float position[3], null: float axisForward[3], null: float axisRight[3], null: float axisUp[3]): int

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

方法参数返回值错误
muteAllRemoteAudioStreamsmute: boolint错误码索引
muteLocalAudioStreammute: boolint错误码索引
muteRemoteAudioStreamuid: uid_t, mute: boolint错误码索引
release—void错误码索引
setAudioRecvRangerange: floatint错误码索引
setDistanceUnitunit: floatint错误码索引
setMaxAudioRecvCountmaxCount: intint错误码索引
setPlayerAttenuationplayerId: int, attenuation: double, forceSet: boolint错误码索引
setRemoteAudioAttenuationuid: uid_t, attenuation: double, forceSet: boolint错误码索引
setZoneszones: const SpatialAudioZone*, zoneCount: unsigned intint错误码索引
updatePlayerPositionInfoplayerId: int, positionInfo: const RemoteVoicePositionInfo&int错误码索引
updateSelfPositionnull: float position[3], null: float axisForward[3], null: float axisRight[3], null: float axisUp[3]int错误码索引
IDirectCdnStreamingEventHandler 2 方法 / 0 属性
typescript
onDirectCdnStreamingStateChanged(state: DIRECT_CDN_STREAMING_STATE, reason: DIRECT_CDN_STREAMING_REASON, message: const char*): void
onDirectCdnStreamingStats(stats: const DirectCdnStreamStats&): void

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

方法参数返回值错误
onDirectCdnStreamingStateChangedstate: DIRECT_CDN_STREAMING_STATE, reason: DIRECT_CDN_STREAMING_REASON, message: const char*void错误码索引
onDirectCdnStreamingStatsstats: const DirectCdnStreamStats&void错误码索引
ILocalSpatialAudioEngine 4 方法 / 0 属性
typescript
clearRemotePositions(): int
initialize(config: const LocalSpatialAudioConfig&): int
removeRemotePosition(uid: uid_t): int
updateRemotePosition(uid: uid_t, posInfo: const RemoteVoicePositionInfo&): int

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

方法参数返回值错误
clearRemotePositions—int错误码索引
initializeconfig: const LocalSpatialAudioConfig&int错误码索引
removeRemotePositionuid: uid_tint错误码索引
updateRemotePositionuid: uid_t, posInfo: const RemoteVoicePositionInfo&int错误码索引
ImageTrackOptions 0 方法 / 2 属性
属性类型只读
imageUrlchar*否
fpsint否
IMediaEngine 10 方法 / 0 属性
typescript
createCustomAudioTrack(trackType: rtc::AUDIO_TRACK_TYPE, config: const rtc::AudioTrackConfig&): rtc::track_id_t
destroyCustomAudioTrack(trackId: rtc::track_id_t): int
pullAudioFrame(frame: IAudioFrameObserver::AudioFrame*): int
pushAudioFrame(frame: IAudioFrameObserver::AudioFrame*, trackId?: rtc::track_id_t): int
pushVideoFrame(frame: base::ExternalVideoFrame*, videoTrackId?: unsigned int): int
registerAudioFrameObserver(observer: IAudioFrameObserver*): int
registerVideoEncodedFrameObserver(observer: IVideoEncodedFrameObserver*): int
registerVideoFrameObserver(observer: IVideoFrameObserver*): int
setExternalAudioSource(enabled: bool, sampleRate: int, channels: int, localPlayback?: bool, publish?: bool): int
setExternalVideoSource(enabled: bool, useTexture: bool, sourceType?: EXTERNAL_VIDEO_SOURCE_TYPE, encodedVideoOption?: rtc::SenderOptions): int

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

方法参数返回值错误
createCustomAudioTracktrackType: rtc::AUDIO_TRACK_TYPE, config: const rtc::AudioTrackConfig&rtc::track_id_t错误码索引
destroyCustomAudioTracktrackId: rtc::track_id_tint错误码索引
pullAudioFrameframe: IAudioFrameObserver::AudioFrame*int错误码索引
pushAudioFrameframe: IAudioFrameObserver::AudioFrame*, trackId?: rtc::track_id_tint错误码索引
pushVideoFrameframe: base::ExternalVideoFrame*, videoTrackId?: unsigned intint错误码索引
registerAudioFrameObserverobserver: IAudioFrameObserver*int错误码索引
registerVideoEncodedFrameObserverobserver: IVideoEncodedFrameObserver*int错误码索引
registerVideoFrameObserverobserver: IVideoFrameObserver*int错误码索引
setExternalAudioSourceenabled: bool, sampleRate: int, channels: int, localPlayback?: bool, publish?: boolint错误码索引
setExternalVideoSourceenabled: bool, useTexture: bool, sourceType?: EXTERNAL_VIDEO_SOURCE_TYPE, encodedVideoOption?: rtc::SenderOptionsint错误码索引
IMediaPlayer 41 方法 / 0 属性
typescript
adjustPlayoutVolume(volume: int): int
adjustPublishSignalVolume(volume: int): int
getDuration(duration: int64_t&): int
getMediaPlayerCacheManager(): AGORA_API agora::rtc::IMediaPlayerCacheManager*AGORA_CALL
getMediaPlayerId(): int
getMute(mute: bool&): int
getPlayPosition(pos: int64_t&): int
getPlaySrc(): char*
getPlayoutVolume(volume: int&): int
getPublishSignalVolume(volume: int&): int
getState(): media::base::MEDIA_PLAYER_STATE
getStreamCount(count: int64_t&): int
getStreamInfo(index: int64_t, info: media::base::PlayerStreamInfo*): int
mute(muted: bool): int
open(url: const char*, startPos: int64_t): int
openWithMediaSource(source: const media::base::MediaSource&): int
pause(): int
play(): int
playPreloadedSrc(src: const char*): int
preloadSrc(src: const char*, startPos: int64_t): int
registerAudioFrameObserver(observer: media::IAudioPcmFrameSink*): int
registerAudioFrameObserver(observer: media::IAudioPcmFrameSink*, mode: RAW_AUDIO_FRAME_OP_MODE_TYPE): int
registerPlayerSourceObserver(observer: IMediaPlayerSourceObserver*): int
registerVideoFrameObserver(observer: media::base::IVideoFrameObserver*): int
resume(): int
seek(newPos: int64_t): int
selectAudioTrack(index: int): int
selectMultiAudioTrack(playoutTrackIndex: int, publishTrackIndex: int): int
setAudioDualMonoMode(mode: agora::media::base::AUDIO_DUAL_MONO_MODE): int
setAudioPitch(pitch: int): int
setLoopCount(loopCount: int): int
setPlaybackSpeed(speed: int): int
setPlayerOption(key: const char*, value: int64_t): int
setPlayerOption(key: const char*, value: const char*): int
setRenderMode(renderMode: media::base::RENDER_MODE_TYPE): int
setSpatialAudioParams(params: const SpatialAudioParams&): int
setView(view: media::base::view_t): int
stop(): int
switchSrc(src: const char*, syncPts: bool): int
unloadSrc(src: const char*): int
unregisterAudioFrameObserver(observer: media::IAudioPcmFrameSink*): int
unregisterPlayerSourceObserver(observer: IMediaPlayerSourceObserver*): int
unregisterVideoFrameObserver(observer: agora::media::base::IVideoFrameObserver*): int

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

方法参数返回值错误
adjustPlayoutVolumevolume: intint错误码索引
adjustPublishSignalVolumevolume: intint错误码索引
getDurationduration: int64_t&int错误码索引
getMediaPlayerCacheManager—AGORA_API agora::rtc::IMediaPlayerCacheManager*AGORA_CALL错误码索引
getMediaPlayerId—int错误码索引
getMutemute: bool&int错误码索引
getPlayPositionpos: int64_t&int错误码索引
getPlaySrc—char*错误码索引
getPlayoutVolumevolume: int&int错误码索引
getPublishSignalVolumevolume: int&int错误码索引
getState—media::base::MEDIA_PLAYER_STATE错误码索引
getStreamCountcount: int64_t&int错误码索引
getStreamInfoindex: int64_t, info: media::base::PlayerStreamInfo*int错误码索引
mutemuted: boolint错误码索引
openurl: const char*, startPos: int64_tint错误码索引
openWithMediaSourcesource: const media::base::MediaSource&int错误码索引
pause—int错误码索引
play—int错误码索引
playPreloadedSrcsrc: const char*int错误码索引
preloadSrcsrc: const char*, startPos: int64_tint错误码索引
registerAudioFrameObserverobserver: media::IAudioPcmFrameSink*int错误码索引
registerPlayerSourceObserverobserver: IMediaPlayerSourceObserver*int错误码索引
registerVideoFrameObserverobserver: media::base::IVideoFrameObserver*int错误码索引
resume—int错误码索引
seeknewPos: int64_tint错误码索引
selectAudioTrackindex: intint错误码索引
selectMultiAudioTrackplayoutTrackIndex: int, publishTrackIndex: intint错误码索引
setAudioDualMonoModemode: agora::media::base::AUDIO_DUAL_MONO_MODEint错误码索引
setAudioPitchpitch: intint错误码索引
setLoopCountloopCount: intint错误码索引
setPlaybackSpeedspeed: intint错误码索引
setPlayerOptionkey: const char*, value: int64_tint错误码索引
setRenderModerenderMode: media::base::RENDER_MODE_TYPEint错误码索引
setSpatialAudioParamsparams: const SpatialAudioParams&int错误码索引
setViewview: media::base::view_tint错误码索引
stop—int错误码索引
switchSrcsrc: const char*, syncPts: boolint错误码索引
unloadSrcsrc: const char*int错误码索引
unregisterAudioFrameObserverobserver: media::IAudioPcmFrameSink*int错误码索引
unregisterPlayerSourceObserverobserver: IMediaPlayerSourceObserver*int错误码索引
unregisterVideoFrameObserverobserver: agora::media::base::IVideoFrameObserver*int错误码索引
IMediaPlayerCacheManager 11 方法 / 0 属性
typescript
enableAutoRemoveCache(enable: bool): int
getCacheDir(path: char*, length: int): int
getCacheFileCount(): int
getMaxCacheFileCount(): int
getMaxCacheFileSize(): int64_t
removeAllCaches(): int
removeCacheByUri(uri: const char*): int
removeOldCache(): int
setCacheDir(path: const char*): int
setMaxCacheFileCount(count: int): int
setMaxCacheFileSize(cacheSize: int64_t): int

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

方法参数返回值错误
enableAutoRemoveCacheenable: boolint错误码索引
getCacheDirpath: char*, length: intint错误码索引
getCacheFileCount—int错误码索引
getMaxCacheFileCount—int错误码索引
getMaxCacheFileSize—int64_t错误码索引
removeAllCaches—int错误码索引
removeCacheByUriuri: const char*int错误码索引
removeOldCache—int错误码索引
setCacheDirpath: const char*int错误码索引
setMaxCacheFileCountcount: intint错误码索引
setMaxCacheFileSizecacheSize: int64_tint错误码索引
IMediaPlayerCustomDataProvider 2 方法 / 0 属性
typescript
onReadData(buffer: unsigned char*, bufferSize: int): int
onSeek(offset: int64_t, whence: int): int64_t

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

方法参数返回值错误
onReadDatabuffer: unsigned char*, bufferSize: intint错误码索引
onSeekoffset: int64_t, whence: intint64_t错误码索引
IMediaPlayerSourceObserver 11 方法 / 0 属性
typescript
onAudioVolumeIndication(volume: int): void
onMetaData(data: const void*, length: int): void
onPlayBufferUpdated(playCachedBuffer: int64_t): void
onPlayerCacheStats(stats: const media::base::CacheStatistics&): void
onPlayerEvent(eventCode: media::base::MEDIA_PLAYER_EVENT, elapsedTime: int64_t, message: const char*): void
onPlayerInfoUpdated(info: const media::base::PlayerUpdatedInfo&): void
onPlayerPlaybackStats(stats: const media::base::PlayerPlaybackStats&): void
onPlayerSourceStateChanged(state: media::base::MEDIA_PLAYER_STATE, reason: media::base::MEDIA_PLAYER_REASON): void
onPlayerSrcInfoChanged(from: const media::base::SrcInfo&, to: const media::base::SrcInfo&): void
onPositionChanged(positionMs: int64_t, timestampMs: int64_t): void
onPreloadEvent(src: const char*, event: media::base::PLAYER_PRELOAD_EVENT): void

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

方法参数返回值错误
onAudioVolumeIndicationvolume: intvoid错误码索引
onMetaDatadata: const void*, length: intvoid错误码索引
onPlayBufferUpdatedplayCachedBuffer: int64_tvoid错误码索引
onPlayerCacheStatsstats: const media::base::CacheStatistics&void错误码索引
onPlayerEventeventCode: media::base::MEDIA_PLAYER_EVENT, elapsedTime: int64_t, message: const char*void错误码索引
onPlayerInfoUpdatedinfo: const media::base::PlayerUpdatedInfo&void错误码索引
onPlayerPlaybackStatsstats: const media::base::PlayerPlaybackStats&void错误码索引
onPlayerSourceStateChangedstate: media::base::MEDIA_PLAYER_STATE, reason: media::base::MEDIA_PLAYER_REASONvoid错误码索引
onPlayerSrcInfoChangedfrom: const media::base::SrcInfo&, to: const media::base::SrcInfo&void错误码索引
onPositionChangedpositionMs: int64_t, timestampMs: int64_tvoid错误码索引
onPreloadEventsrc: const char*, event: media::base::PLAYER_PRELOAD_EVENTvoid错误码索引
IMediaRecorder 3 方法 / 0 属性
typescript
setMediaRecorderObserver(callback: media::IMediaRecorderObserver*): int
startRecording(config: const media::MediaRecorderConfiguration&): int
stopRecording(): int

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

方法参数返回值错误
setMediaRecorderObservercallback: media::IMediaRecorderObserver*int错误码索引
startRecordingconfig: const media::MediaRecorderConfiguration&int错误码索引
stopRecording—int错误码索引
IMediaRecorderObserver 2 方法 / 0 属性
typescript
onRecorderInfoUpdated(channelId: const char*, uid: rtc::uid_t, info: const RecorderInfo&): void
onRecorderStateChanged(channelId: const char*, uid: rtc::uid_t, state: RecorderState, reason: RecorderReasonCode): void

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

方法参数返回值错误
onRecorderInfoUpdatedchannelId: const char*, uid: rtc::uid_t, info: const RecorderInfo&void错误码索引
onRecorderStateChangedchannelId: const char*, uid: rtc::uid_t, state: RecorderState, reason: RecorderReasonCodevoid错误码索引
IMetadataObserver 3 方法 / 0 属性
typescript
getMaxMetadataSize(): int
onMetadataReceived(metadata: const Metadata&): void
onReadyToSendMetadata(metadata: Metadata&, source_type: VIDEO_SOURCE_TYPE): bool

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

方法参数返回值错误
getMaxMetadataSize—int错误码索引
onMetadataReceivedmetadata: const Metadata&void错误码索引
onReadyToSendMetadatametadata: Metadata&, source_type: VIDEO_SOURCE_TYPEbool错误码索引
IMusicContentCenter 17 方法 / 0 属性
typescript
createMusicPlayer(): agora_refptr
destroyMusicPlayer(music_player: agora_refptr): int
getCaches(cacheInfo: MusicCacheInfo*, cacheInfoSize: int32_t*): int
getInternalSongCode(songCode: int64_t, jsonOption: const char*, internalSongCode: int64_t&): int
getLyric(requestId: agora::util::AString&, songCode: int64_t, LyricType?: int32_t): int
getMusicCharts(requestId: agora::util::AString&): int
getMusicCollectionWithMusicChartId(requestId: unknown, musicChartId: unknown, page: unknown, pageSize: unknown, jsonOption: unknown, Key: unknown, pitchType: unknown, needHighPart: unknown): unknown
getSongSimpleInfo(requestId: agora::util::AString&, songCode: int64_t): int
initialize(configuration: const MusicContentCenterConfiguration&): int
isPreloaded(songCode: int64_t): int
preload(songCode: int64_t, jsonOption?: const char*): int
preload(requestId: agora::util::AString&, songCode: int64_t): int
registerEventHandler(eventHandler: IMusicContentCenterEventHandler*): int
release(): void
removeCache(songCode: int64_t): int
renewToken(token: const char*): int
searchMusic(requestId: agora::util::AString&, keyWord: const char*, page: int32_t, pageSize: int32_t, jsonOption?: const char*): int
unregisterEventHandler(): int

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

方法参数返回值错误
createMusicPlayer—agora_refptr错误码索引
destroyMusicPlayermusic_player: agora_refptrint错误码索引
getCachescacheInfo: MusicCacheInfo*, cacheInfoSize: int32_t*int错误码索引
getInternalSongCodesongCode: int64_t, jsonOption: const char*, internalSongCode: int64_t&int错误码索引
getLyricrequestId: agora::util::AString&, songCode: int64_t, LyricType?: int32_tint错误码索引
getMusicChartsrequestId: agora::util::AString&int错误码索引
getMusicCollectionWithMusicChartIdrequestId: unknown, musicChartId: unknown, page: unknown, pageSize: unknown, jsonOption: unknown, Key: unknown, pitchType: unknown, needHighPart: unknownunknown错误码索引
getSongSimpleInforequestId: agora::util::AString&, songCode: int64_tint错误码索引
initializeconfiguration: const MusicContentCenterConfiguration&int错误码索引
isPreloadedsongCode: int64_tint错误码索引
preloadsongCode: int64_t, jsonOption?: const char*int错误码索引
registerEventHandlereventHandler: IMusicContentCenterEventHandler*int错误码索引
release—void错误码索引
removeCachesongCode: int64_tint错误码索引
renewTokentoken: const char*int错误码索引
searchMusicrequestId: agora::util::AString&, keyWord: const char*, page: int32_t, pageSize: int32_t, jsonOption?: const char*int错误码索引
unregisterEventHandler—int错误码索引
IMusicContentCenterEventHandler 5 方法 / 0 属性
typescript
onLyricResult(requestId: const char*, songCode: int64_t, lyricUrl: const char*, reason: MusicContentCenterStateReason): void
onMusicChartsResult(requestId: const char*, result: agora_refptr, reason: MusicContentCenterStateReason): void
onMusicCollectionResult(requestId: const char*, result: agora_refptr, reason: MusicContentCenterStateReason): void
onPreLoadEvent(requestId: const char*, songCode: int64_t, percent: int, lyricUrl: const char*, state: PreloadState, reason: MusicContentCenterStateReason): void
onSongSimpleInfoResult(requestId: const char*, songCode: int64_t, simpleInfo: const char*, reason: MusicContentCenterStateReason): void

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

方法参数返回值错误
onLyricResultrequestId: const char*, songCode: int64_t, lyricUrl: const char*, reason: MusicContentCenterStateReasonvoid错误码索引
onMusicChartsResultrequestId: const char*, result: agora_refptr, reason: MusicContentCenterStateReasonvoid错误码索引
onMusicCollectionResultrequestId: const char*, result: agora_refptr, reason: MusicContentCenterStateReasonvoid错误码索引
onPreLoadEventrequestId: const char*, songCode: int64_t, percent: int, lyricUrl: const char*, state: PreloadState, reason: MusicContentCenterStateReasonvoid错误码索引
onSongSimpleInfoResultrequestId: const char*, songCode: int64_t, simpleInfo: const char*, reason: MusicContentCenterStateReasonvoid错误码索引
IMusicPlayer 2 方法 / 0 属性
typescript
open(songCode: int64_t, startPos?: int64_t): int
setPlayMode(mode: MusicPlayMode): int

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

方法参数返回值错误
opensongCode: int64_t, startPos?: int64_tint错误码索引
setPlayModemode: MusicPlayModeint错误码索引
IPacketObserver 4 方法 / 0 属性
typescript
onReceiveAudioPacket(packet: Packet&): bool
onReceiveVideoPacket(packet: Packet&): bool
onSendAudioPacket(packet: Packet&): bool
onSendVideoPacket(packet: Packet&): bool

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

方法参数返回值错误
onReceiveAudioPacketpacket: Packet&bool错误码索引
onReceiveVideoPacketpacket: Packet&bool错误码索引
onSendAudioPacketpacket: Packet&bool错误码索引
onSendVideoPacketpacket: Packet&bool错误码索引
IRtcEngine 256 方法 / 0 属性
typescript
Get(): AgoraUERtcEngine*
Release(sync?: bool): void
addVideoWatermark(watermark: const RtcImage&): int
addVideoWatermark(watermarkUrl: const char*, options: const WatermarkOptions&): int
adjustAudioMixingPlayoutVolume(volume: int): int
adjustAudioMixingPublishVolume(volume: int): int
adjustAudioMixingVolume(volume: int): int
adjustCustomAudioPlayoutVolume(trackId: track_id_t, volume: int): int
adjustCustomAudioPublishVolume(trackId: track_id_t, volume: int): int
adjustLoopbackSignalVolume(volume: int): int
adjustPlaybackSignalVolume(volume: int): int
adjustRecordingSignalVolume(volume: int): int
adjustUserPlaybackSignalVolume(uid: unsigned int, volume: int): int
clearVideoWatermarks(): int
complain(callId: const char*, description: const char*): int
configRhythmPlayer(config: const AgoraRhythmPlayerConfig&): int
createCustomVideoTrack(): video_track_id_t
createDataStream(streamId: int*, reliable: bool, ordered: bool): int
createDataStream(streamId: int*, config: DataStreamConfig&): int
createMediaPlayer(): agora_refptr
createMediaRecorder(info: const RecorderStreamInfo&): agora_refptr
destroyCustomVideoTrack(video_track_id: video_track_id_t): int
destroyMediaPlayer(media_player: agora_refptr): int
disableAudio(): int
disableAudioSpectrumMonitor(): int
disableVideo(): int
enableAudio(): int
enableAudioSpectrumMonitor(intervalInMS?: int): int
enableAudioVolumeIndication(interval: int, smooth: int, reportVad: bool): int
enableCameraCenterStage(enabled: bool): int
enableContentInspect(enabled: bool, config: const media::ContentInspectConfig&): int
enableCustomAudioLocalPlayback(trackId: track_id_t, enabled: bool): int
enableDualStreamMode(enabled: bool): int
enableDualStreamMode(enabled: bool, streamConfig: const SimulcastStreamConfig&): int
enableEncryption(enabled: bool, config: const EncryptionConfig&): int
enableExtension(provider: const char*, extension: const char*, enable?: bool, type?: agora::media::MEDIA_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 char*): int
enableMultiCamera(enabled: unknown, config: unknown): unknown
enableSoundPositionIndication(enabled: bool): int
enableSpatialAudio(enabled: bool): int
enableVideo(): int
enableVideoImageSource(enable: bool, options: const ImageTrackOptions&): int
enableVirtualBackground(enabled: bool, backgroundSource: VirtualBackgroundSource, segproperty: SegmentationProperty, type?: agora::media::MEDIA_SOURCE_TYPE): int
enableVoiceAITuner(enabled: bool, type: VOICE_AI_TUNER_TYPE): int
enableWebSdkInteroperability(enabled: bool): int
getAudioDeviceInfo(deviceInfo: DeviceInfo&): int
getAudioMixingCurrentPosition(): int
getAudioMixingDuration(): int
getAudioMixingPlayoutVolume(): int
getAudioMixingPublishVolume(): int
getAudioTrackCount(): int
getCallId(callId: agora::util::AString&): int
getCameraMaxZoomFactor(): float
getConnectionState(): CONNECTION_STATE_TYPE
getCurrentMonotonicTimeInMs(): int64_t
getEffectCurrentPosition(soundId: int): int
getEffectDuration(filePath: const char*): int
getEffectsVolume(): int
getErrorDescription(code: int): char*
getExtensionProperty(provider: const char*, extension: const char*, key: const char*, value: char*, buf_len: int, type?: agora::media::MEDIA_SOURCE_TYPE): int
getFaceShapeAreaOptions(shapeArea: agora::rtc::FaceShapeAreaOptions::FACE_SHAPE_AREA, options: FaceShapeAreaOptions&, type?: agora::media::MEDIA_SOURCE_TYPE): int
getFaceShapeBeautyOptions(options: FaceShapeBeautyOptions&, type?: agora::media::MEDIA_SOURCE_TYPE): int
getNetworkType(): int
getNtpWallTimeInMs(): uint64_t
getScreenCaptureSources(thumbSize: const SIZE&, iconSize: const SIZE&, includeScreen: const bool): IScreenCaptureSourceList*
getUserInfoByUid(uid: uid_t, userInfo: rtc::UserInfo*, channelId?: const char*, localUserAccount?: const char*): int
getUserInfoByUserAccount(userAccount: const char*, userInfo: rtc::UserInfo*, channelId?: const char*, localUserAccount?: const char*): int
getVersion(build: int*): char*
getVolumeOfEffect(soundId: int): int
initialize(context: const RtcEngineContext&): int
isCameraAutoExposureFaceModeSupported(): bool
isCameraAutoFocusFaceModeSupported(): bool
isCameraCenterStageSupported(): bool
isCameraExposurePositionSupported(): bool
isCameraExposureSupported(): bool
isCameraFaceDetectSupported(): bool
isCameraFocusSupported(): bool
isCameraTorchSupported(): bool
isCameraZoomSupported(): bool
isFeatureAvailableOnDevice(type: FeatureType): bool
isSpeakerphoneEnabled(): bool
joinChannel(token: const char*, channelId: const char*, info: const char*, uid: uid_t): int
joinChannel(token: const char*, channelId: const char*, uid: uid_t, options: const ChannelMediaOptions&): int
joinChannelWithUserAccount(token: const char*, channelId: const char*, userAccount: const char*): int
joinChannelWithUserAccount(token: const char*, channelId: const char*, userAccount: const char*, options: const ChannelMediaOptions&): int
leaveChannel(): int
leaveChannel(options: const LeaveChannelOptions&): int
loadExtensionProvider(path: const char*, 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: uid_t, mute: bool): int
muteRemoteVideoStream(userId: uid_t, mute: bool): int
pauseAllChannelMediaRelay(): int
pauseAllEffects(): int
pauseAudioMixing(): int
pauseEffect(soundId: int): int
playAllEffects(loopCount: int, pitch: double, pan: double, gain: int, publish?: bool): int
playEffect(soundId: int, filePath: const char*, loopCount: int, pitch: double, pan: double, gain: int, publish: bool, startPos: int): int
preloadChannel(token: const char*, channelId: const char*, uid: uid_t): int
preloadChannelWithUserAccount(token: const char*, channelId: const char*, userAccount: const char*): int
preloadEffect(soundId: int, filePath: const char*, startPos?: int): int
queryCameraFocalLengthCapability(focalLengthInfos: agora::rtc::FocalLengthInfo*, size: int&): int
queryCodecCapability(codecInfo: CodecCapInfo*, size: int&): int
queryDeviceScore(): int
queryInterface(iid: INTERFACE_ID_TYPE, inter: void**): int
queryScreenCaptureCapability(): unknown
rate(callId: const char*, rating: int, description: const char*): int
registerAudioEncodedFrameObserver(config: const AudioEncodedFrameObserverConfig&, observer: IAudioEncodedFrameObserver*): int
registerAudioSpectrumObserver(observer: agora::media::IAudioSpectrumObserver*): int
registerExtension(provider: const char*, extension: const char*, type?: agora::media::MEDIA_SOURCE_TYPE): int
registerLocalUserAccount(appId: const char*, userAccount: const char*): int
registerMediaMetadataObserver(observer: IMetadataObserver*, type: IMetadataObserver::METADATA_TYPE): int
registerPacketObserver(observer: IPacketObserver*): int
renewToken(token: const char*): int
resumeAllChannelMediaRelay(): int
resumeAllEffects(): int
resumeAudioMixing(): int
resumeEffect(soundId: int): int
selectAudioTrack(index: int): int
sendCustomReportMessage(id: const char*, category: const char*, event: const char*, label: const char*, value: int): int
sendStreamMessage(streamId: int, data: const char*, length: size_t): int
setAINSMode(enabled: bool, mode: AUDIO_AINS_MODE): int
setAVSyncSource(channelId: const char*, uid: uid_t): int
setAdvancedAudioOptions(options: media::base::AdvancedAudioOptions&): int
setAudioEffectParameters(preset: AUDIO_EFFECT_PRESET, param1: int, param2: int): int
setAudioEffectPreset(preset: AUDIO_EFFECT_PRESET): int
setAudioMixingDualMonoMode(mode: media::AUDIO_MIXING_DUAL_MONO_MODE): int
setAudioMixingPitch(pitch: int): int
setAudioMixingPlaybackSpeed(speed: int): int
setAudioMixingPosition(null: int pos /*in ms*/): int
setAudioProfile(profile: AUDIO_PROFILE_TYPE, scenario: AUDIO_SCENARIO_TYPE): int
setAudioProfile(profile: AUDIO_PROFILE_TYPE): int
setAudioScenario(scenario: AUDIO_SCENARIO_TYPE): int
setAudioSessionOperationRestriction(restriction: AUDIO_SESSION_OPERATION_RESTRICTION): int
setBeautyEffectOptions(enabled: bool, options: const BeautyOptions&, type?: agora::media::MEDIA_SOURCE_TYPE): int
setCameraAutoExposureFaceModeEnabled(enabled: bool): int
setCameraAutoFocusFaceModeEnabled(enabled: bool): int
setCameraCapturerConfiguration(config: const CameraCapturerConfiguration&): int
setCameraDeviceOrientation(type: VIDEO_SOURCE_TYPE, orientation: VIDEO_ORIENTATION): int
setCameraExposureFactor(factor: float): int
setCameraExposurePosition(positionXinView: float, positionYinView: float): int
setCameraFocusPositionInPreview(positionX: float, positionY: float): int
setCameraStabilizationMode(mode: CAMERA_STABILIZATION_MODE): int
setCameraTorchOn(isOn: bool): int
setCameraZoomFactor(factor: float): int
setChannelProfile(profile: CHANNEL_PROFILE_TYPE): int
setClientRole(role: CLIENT_ROLE_TYPE): int
setClientRole(role: CLIENT_ROLE_TYPE, options: const ClientRoleOptions&): int
setCloudProxy(proxyType: CLOUD_PROXY_TYPE): int
setColorEnhanceOptions(enabled: bool, options: const ColorEnhanceOptions&, type?: agora::media::MEDIA_SOURCE_TYPE): int
setDefaultAudioRouteToSpeakerphone(defaultToSpeaker: bool): int
setDirectCdnStreamingAudioConfiguration(profile: AUDIO_PROFILE_TYPE): int
setDirectCdnStreamingVideoConfiguration(config: const VideoEncoderConfiguration&): int
setDualStreamMode(mode: SIMULCAST_STREAM_MODE): int
setDualStreamMode(mode: SIMULCAST_STREAM_MODE, streamConfig: const SimulcastStreamConfig&): int
setEarMonitoringAudioFrameParameters(sampleRate: int, channel: int, mode: RAW_AUDIO_FRAME_OP_MODE_TYPE, samplesPerCall: int): int
setEffectPosition(soundId: int, pos: int): int
setEffectsVolume(volume: int): int
setEnableSpeakerphone(speakerOn: bool): int
setExtensionProperty(provider: const char*, extension: const char*, key: const char*, value: const char*, type?: agora::media::MEDIA_SOURCE_TYPE): int
setExtensionProviderProperty(provider: const char*, key: const char*, value: const char*): int
setExternalAudioSink(enabled: bool, sampleRate: int, channels: int): int
setExternalRemoteEglContext(eglContext: void*): int
setFaceShapeAreaOptions(options: const FaceShapeAreaOptions&, type?: agora::media::MEDIA_SOURCE_TYPE): int
setFaceShapeBeautyOptions(enabled: bool, options: const FaceShapeBeautyOptions&, type?: agora::media::MEDIA_SOURCE_TYPE): int
setFilterEffectOptions(enabled: bool, options: const FilterEffectOptions&, type?: agora::media::MEDIA_SOURCE_TYPE): int
setHeadphoneEQParameters(lowGain: int, highGain: int): int
setHeadphoneEQPreset(preset: HEADPHONE_EQUALIZER_PRESET): int
setInEarMonitoringVolume(volume: int): int
setLocalRenderMode(renderMode: media::base::RENDER_MODE_TYPE): int
setLocalRenderMode(renderMode: media::base::RENDER_MODE_TYPE, mirrorMode: VIDEO_MIRROR_MODE_TYPE): int
setLocalRenderTargetFps(sourceType: VIDEO_SOURCE_TYPE, targetFps: int): int
setLocalVideoMirrorMode(mirrorMode: VIDEO_MIRROR_MODE_TYPE): int
setLocalVoiceEqualization(bandFrequency: AUDIO_EQUALIZATION_BAND_FREQUENCY, bandGain: int): int
setLocalVoiceFormant(formantRatio: double): int
setLocalVoicePitch(pitch: double): int
setLocalVoiceReverb(reverbKey: AUDIO_REVERB_TYPE, value: int): int
setLogFile(filePath: const char*): int
setLogFileSize(fileSizeInKBytes: unsigned int): int
setLogFilter(filter: unsigned int): int
setLogLevel(level: commons::LOG_LEVEL): int
setLowlightEnhanceOptions(enabled: bool, options: const LowlightEnhanceOptions&, type?: agora::media::MEDIA_SOURCE_TYPE): int
setMixedAudioFrameParameters(sampleRate: int, channel: int, samplesPerCall: int): int
setParameters(parameters: const char*): int
setPlaybackAudioFrameBeforeMixingParameters(sampleRate: int, channel: int): int
setPlaybackAudioFrameParameters(sampleRate: int, channel: int, mode: RAW_AUDIO_FRAME_OP_MODE_TYPE, samplesPerCall: int): int
setRecordingAudioFrameParameters(sampleRate: int, channel: int, mode: RAW_AUDIO_FRAME_OP_MODE_TYPE, samplesPerCall: int): int
setRemoteDefaultVideoStreamType(streamType: VIDEO_STREAM_TYPE): int
setRemoteRenderMode(userId: uid_t, renderMode: RENDER_MODE_TYPE, mirrorMode: VIDEO_MIRROR_MODE_TYPE): int
setRemoteRenderTargetFps(targetFps: int): int
setRemoteSubscribeFallbackOption(option: STREAM_FALLBACK_OPTIONS): int
setRemoteUserSpatialAudioParams(uid: uid_t, params: const agora::SpatialAudioParams&): int
setRemoteVideoStreamType(uid: uid_t, streamType: VIDEO_STREAM_TYPE): int
setRemoteVideoSubscriptionOptions(uid: uid_t, options: const VideoSubscriptionOptions&): int
setRemoteVoicePosition(uid: uid_t, pan: double, gain: double): int
setRouteInCommunicationMode(route: int): int
setScreenCaptureContentHint(contentHint: VIDEO_CONTENT_HINT): int
setScreenCaptureScenario(screenScenario: SCREEN_SCENARIO_TYPE): int
setSubscribeAudioAllowlist(uidList: uid_t*, uidNumber: int): int
setSubscribeAudioBlocklist(uidList: uid_t*, uidNumber: int): int
setSubscribeVideoAllowlist(uidList: uid_t*, uidNumber: int): int
setSubscribeVideoBlocklist(uidList: uid_t*, uidNumber: int): int
setVideoDenoiserOptions(enabled: bool, options: const VideoDenoiserOptions&, type?: agora::media::MEDIA_SOURCE_TYPE): int
setVideoEncoderConfiguration(config: const VideoEncoderConfiguration&): int
setVideoScenario(scenarioType: VIDEO_APPLICATION_SCENARIO_TYPE): int
setVoiceBeautifierParameters(preset: VOICE_BEAUTIFIER_PRESET, param1: int, param2: int): int
setVoiceBeautifierPreset(preset: VOICE_BEAUTIFIER_PRESET): int
setVoiceConversionPreset(preset: VOICE_CONVERSION_PRESET): int
setVolumeOfEffect(soundId: int, volume: int): int
setupLocalVideo(canvas: const VideoCanvas&): int
setupRemoteVideo(canvas: const VideoCanvas&): int
startAudioMixing(filePath: const char*, loopback: bool, cycle: int): int
startAudioMixing(filePath: const char*, loopback: bool, cycle: int, startPos: int): int
startAudioRecording(config: const AudioFileRecordingConfig&): int
startCameraCapture(sourceType: VIDEO_SOURCE_TYPE, config: const CameraCapturerConfiguration&): int
startDirectCdnStreaming(eventHandler: IDirectCdnStreamingEventHandler*, publishUrl: const char*, options: const DirectCdnStreamingMediaOptions&): int
startEchoTest(config: const EchoTestConfiguration&): int
startLastmileProbeTest(config: const LastmileProbeConfig&): int
startLocalAudioMixer(config: const LocalAudioMixerConfiguration&): int
startLocalVideoTranscoder(config: const LocalTranscoderConfiguration&): int
startMediaRenderingTracing(): int
startOrUpdateChannelMediaRelay(configuration: const ChannelMediaRelayConfiguration&): int
startPreview(): int
startPreview(sourceType: VIDEO_SOURCE_TYPE): int
startRhythmPlayer(sound1: const char*, sound2: const char*, config: const AgoraRhythmPlayerConfig&): int
startRtmpStreamWithTranscoding(url: const char*, transcoding: const LiveTranscoding&): int
startRtmpStreamWithoutTranscoding(url: const char*): int
startScreenCapture(captureParams: unknown): unknown
startScreenCapture(sourceType: VIDEO_SOURCE_TYPE, config: const ScreenCaptureConfiguration&): int
startScreenCaptureByDisplayId(displayId: int64_t, regionRect: const Rectangle&, captureParams: const ScreenCaptureParameters&): int
startScreenCaptureByScreenRect(screenRect: const Rectangle&, regionRect: const Rectangle&, captureParams: const ScreenCaptureParameters&): int
startScreenCaptureByWindowId(windowId: int64_t, regionRect: const Rectangle&, captureParams: const ScreenCaptureParameters&): int
stopAllEffects(): int
stopAudioMixing(): int
stopAudioRecording(): int
stopCameraCapture(sourceType: VIDEO_SOURCE_TYPE): int
stopChannelMediaRelay(): int
stopDirectCdnStreaming(): int
stopEchoTest(): int
stopEffect(soundId: int): int
stopLastmileProbeTest(): int
stopLocalAudioMixer(): int
stopLocalVideoTranscoder(): int
stopPreview(): int
stopPreview(sourceType: VIDEO_SOURCE_TYPE): int
stopRhythmPlayer(): int
stopRtmpStream(url: const char*): int
stopScreenCapture(): unknown
stopScreenCapture(sourceType: VIDEO_SOURCE_TYPE): int
switchCamera(): int
takeSnapshot(uid: uid_t, filePath: const char*): int
takeSnapshot(uid: uid_t, config: const media::SnapshotConfig&): int
unloadAllEffects(): int
unloadEffect(soundId: int): int
unregisterAudioSpectrumObserver(observer: agora::media::IAudioSpectrumObserver*): int
unregisterMediaMetadataObserver(observer: IMetadataObserver*, type: IMetadataObserver::METADATA_TYPE): int
updateChannelMediaOptions(options: const ChannelMediaOptions&): int
updateLocalAudioMixerConfiguration(config: const LocalAudioMixerConfiguration&): int
updateLocalTranscoderConfiguration(config: const LocalTranscoderConfiguration&): int
updatePreloadChannelToken(token: const char*): int
updateRtmpTranscoding(transcoding: const LiveTranscoding&): int
updateScreenCapture(captureParams: const ScreenCaptureParameters2&): int
updateScreenCaptureParameters(captureParams: const ScreenCaptureParameters&): int
updateScreenCaptureRegion(regionRect: const Rectangle&): int

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

方法参数返回值错误
Get—AgoraUERtcEngine*错误码索引
Releasesync?: boolvoid错误码索引
addVideoWatermarkwatermark: const RtcImage&int错误码索引
adjustAudioMixingPlayoutVolumevolume: intint错误码索引
adjustAudioMixingPublishVolumevolume: intint错误码索引
adjustAudioMixingVolumevolume: intint错误码索引
adjustCustomAudioPlayoutVolumetrackId: track_id_t, volume: intint错误码索引
adjustCustomAudioPublishVolumetrackId: track_id_t, volume: intint错误码索引
adjustLoopbackSignalVolumevolume: intint错误码索引
adjustPlaybackSignalVolumevolume: intint错误码索引
adjustRecordingSignalVolumevolume: intint错误码索引
adjustUserPlaybackSignalVolumeuid: unsigned int, volume: intint错误码索引
clearVideoWatermarks—int错误码索引
complaincallId: const char*, description: const char*int错误码索引
configRhythmPlayerconfig: const AgoraRhythmPlayerConfig&int错误码索引
createCustomVideoTrack—video_track_id_t错误码索引
createDataStreamstreamId: int*, reliable: bool, ordered: boolint错误码索引
createMediaPlayer—agora_refptr错误码索引
createMediaRecorderinfo: const RecorderStreamInfo&agora_refptr错误码索引
destroyCustomVideoTrackvideo_track_id: video_track_id_tint错误码索引
destroyMediaPlayermedia_player: agora_refptrint错误码索引
disableAudio—int错误码索引
disableAudioSpectrumMonitor—int错误码索引
disableVideo—int错误码索引
enableAudio—int错误码索引
enableAudioSpectrumMonitorintervalInMS?: intint错误码索引
enableAudioVolumeIndicationinterval: int, smooth: int, reportVad: boolint错误码索引
enableCameraCenterStageenabled: boolint错误码索引
enableContentInspectenabled: bool, config: const media::ContentInspectConfig&int错误码索引
enableCustomAudioLocalPlaybacktrackId: track_id_t, enabled: boolint错误码索引
enableDualStreamModeenabled: boolint错误码索引
enableEncryptionenabled: bool, config: const EncryptionConfig&int错误码索引
enableExtensionprovider: const char*, extension: const char*, enable?: bool, type?: agora::media::MEDIA_SOURCE_TYPEint错误码索引
enableFaceDetectionenabled: boolint错误码索引
enableInEarMonitoringenabled: bool, includeAudioFilters: intint错误码索引
enableInstantMediaRendering—int错误码索引
enableLocalAudioenabled: boolint错误码索引
enableLocalVideoenabled: boolint错误码索引
enableLoopbackRecordingenabled: bool, deviceName?: const char*int错误码索引
enableMultiCameraenabled: unknown, config: unknownunknown错误码索引
enableSoundPositionIndicationenabled: boolint错误码索引
enableSpatialAudioenabled: boolint错误码索引
enableVideo—int错误码索引
enableVideoImageSourceenable: bool, options: const ImageTrackOptions&int错误码索引
enableVirtualBackgroundenabled: bool, backgroundSource: VirtualBackgroundSource, segproperty: SegmentationProperty, type?: agora::media::MEDIA_SOURCE_TYPEint错误码索引
enableVoiceAITunerenabled: bool, type: VOICE_AI_TUNER_TYPEint错误码索引
enableWebSdkInteroperabilityenabled: boolint错误码索引
getAudioDeviceInfodeviceInfo: DeviceInfo&int错误码索引
getAudioMixingCurrentPosition—int错误码索引
getAudioMixingDuration—int错误码索引
getAudioMixingPlayoutVolume—int错误码索引
getAudioMixingPublishVolume—int错误码索引
getAudioTrackCount—int错误码索引
getCallIdcallId: agora::util::AString&int错误码索引
getCameraMaxZoomFactor—float错误码索引
getConnectionState—CONNECTION_STATE_TYPE错误码索引
getCurrentMonotonicTimeInMs—int64_t错误码索引
getEffectCurrentPositionsoundId: intint错误码索引
getEffectDurationfilePath: const char*int错误码索引
getEffectsVolume—int错误码索引
getErrorDescriptioncode: intchar*错误码索引
getExtensionPropertyprovider: const char*, extension: const char*, key: const char*, value: char*, buf_len: int, type?: agora::media::MEDIA_SOURCE_TYPEint错误码索引
getFaceShapeAreaOptionsshapeArea: agora::rtc::FaceShapeAreaOptions::FACE_SHAPE_AREA, options: FaceShapeAreaOptions&, type?: agora::media::MEDIA_SOURCE_TYPEint错误码索引
getFaceShapeBeautyOptionsoptions: FaceShapeBeautyOptions&, type?: agora::media::MEDIA_SOURCE_TYPEint错误码索引
getNetworkType—int错误码索引
getNtpWallTimeInMs—uint64_t错误码索引
getScreenCaptureSourcesthumbSize: const SIZE&, iconSize: const SIZE&, includeScreen: const boolIScreenCaptureSourceList*错误码索引
getUserInfoByUiduid: uid_t, userInfo: rtc::UserInfo*, channelId?: const char*, localUserAccount?: const char*int错误码索引
getUserInfoByUserAccountuserAccount: const char*, userInfo: rtc::UserInfo*, channelId?: const char*, localUserAccount?: const char*int错误码索引
getVersionbuild: int*char*错误码索引
getVolumeOfEffectsoundId: intint错误码索引
initializecontext: const RtcEngineContext&int错误码索引
isCameraAutoExposureFaceModeSupported—bool错误码索引
isCameraAutoFocusFaceModeSupported—bool错误码索引
isCameraCenterStageSupported—bool错误码索引
isCameraExposurePositionSupported—bool错误码索引
isCameraExposureSupported—bool错误码索引
isCameraFaceDetectSupported—bool错误码索引
isCameraFocusSupported—bool错误码索引
isCameraTorchSupported—bool错误码索引
isCameraZoomSupported—bool错误码索引
isFeatureAvailableOnDevicetype: FeatureTypebool错误码索引
isSpeakerphoneEnabled—bool错误码索引
joinChanneltoken: const char*, channelId: const char*, info: const char*, uid: uid_tint错误码索引
joinChannelWithUserAccounttoken: const char*, channelId: const char*, userAccount: const char*int错误码索引
leaveChannel—int错误码索引
loadExtensionProviderpath: const char*, unload_after_use?: boolint错误码索引
muteAllRemoteAudioStreamsmute: boolint错误码索引
muteAllRemoteVideoStreamsmute: boolint错误码索引
muteLocalAudioStreammute: boolint错误码索引
muteLocalVideoStreammute: boolint错误码索引
muteRecordingSignalmute: boolint错误码索引
muteRemoteAudioStreamuid: uid_t, mute: boolint错误码索引
muteRemoteVideoStreamuserId: uid_t, mute: boolint错误码索引
pauseAllChannelMediaRelay—int错误码索引
pauseAllEffects—int错误码索引
pauseAudioMixing—int错误码索引
pauseEffectsoundId: intint错误码索引
playAllEffectsloopCount: int, pitch: double, pan: double, gain: int, publish?: boolint错误码索引
playEffectsoundId: int, filePath: const char*, loopCount: int, pitch: double, pan: double, gain: int, publish: bool, startPos: intint错误码索引
preloadChanneltoken: const char*, channelId: const char*, uid: uid_tint错误码索引
preloadChannelWithUserAccounttoken: const char*, channelId: const char*, userAccount: const char*int错误码索引
preloadEffectsoundId: int, filePath: const char*, startPos?: intint错误码索引
queryCameraFocalLengthCapabilityfocalLengthInfos: agora::rtc::FocalLengthInfo*, size: int&int错误码索引
queryCodecCapabilitycodecInfo: CodecCapInfo*, size: int&int错误码索引
queryDeviceScore—int错误码索引
queryInterfaceiid: INTERFACE_ID_TYPE, inter: void**int错误码索引
queryScreenCaptureCapability—unknown错误码索引
ratecallId: const char*, rating: int, description: const char*int错误码索引
registerAudioEncodedFrameObserverconfig: const AudioEncodedFrameObserverConfig&, observer: IAudioEncodedFrameObserver*int错误码索引
registerAudioSpectrumObserverobserver: agora::media::IAudioSpectrumObserver*int错误码索引
registerExtensionprovider: const char*, extension: const char*, type?: agora::media::MEDIA_SOURCE_TYPEint错误码索引
registerLocalUserAccountappId: const char*, userAccount: const char*int错误码索引
registerMediaMetadataObserverobserver: IMetadataObserver*, type: IMetadataObserver::METADATA_TYPEint错误码索引
registerPacketObserverobserver: IPacketObserver*int错误码索引
renewTokentoken: const char*int错误码索引
resumeAllChannelMediaRelay—int错误码索引
resumeAllEffects—int错误码索引
resumeAudioMixing—int错误码索引
resumeEffectsoundId: intint错误码索引
selectAudioTrackindex: intint错误码索引
sendCustomReportMessageid: const char*, category: const char*, event: const char*, label: const char*, value: intint错误码索引
sendStreamMessagestreamId: int, data: const char*, length: size_tint错误码索引
setAINSModeenabled: bool, mode: AUDIO_AINS_MODEint错误码索引
setAVSyncSourcechannelId: const char*, uid: uid_tint错误码索引
setAdvancedAudioOptionsoptions: media::base::AdvancedAudioOptions&int错误码索引
setAudioEffectParameterspreset: AUDIO_EFFECT_PRESET, param1: int, param2: intint错误码索引
setAudioEffectPresetpreset: AUDIO_EFFECT_PRESETint错误码索引
setAudioMixingDualMonoModemode: media::AUDIO_MIXING_DUAL_MONO_MODEint错误码索引
setAudioMixingPitchpitch: intint错误码索引
setAudioMixingPlaybackSpeedspeed: intint错误码索引
setAudioMixingPositionnull: int pos /*in ms*/int错误码索引
setAudioProfileprofile: AUDIO_PROFILE_TYPE, scenario: AUDIO_SCENARIO_TYPEint错误码索引
setAudioScenarioscenario: AUDIO_SCENARIO_TYPEint错误码索引
setAudioSessionOperationRestrictionrestriction: AUDIO_SESSION_OPERATION_RESTRICTIONint错误码索引
setBeautyEffectOptionsenabled: bool, options: const BeautyOptions&, type?: agora::media::MEDIA_SOURCE_TYPEint错误码索引
setCameraAutoExposureFaceModeEnabledenabled: boolint错误码索引
setCameraAutoFocusFaceModeEnabledenabled: boolint错误码索引
setCameraCapturerConfigurationconfig: const CameraCapturerConfiguration&int错误码索引
setCameraDeviceOrientationtype: VIDEO_SOURCE_TYPE, orientation: VIDEO_ORIENTATIONint错误码索引
setCameraExposureFactorfactor: floatint错误码索引
setCameraExposurePositionpositionXinView: float, positionYinView: floatint错误码索引
setCameraFocusPositionInPreviewpositionX: float, positionY: floatint错误码索引
setCameraStabilizationModemode: CAMERA_STABILIZATION_MODEint错误码索引
setCameraTorchOnisOn: boolint错误码索引
setCameraZoomFactorfactor: floatint错误码索引
setChannelProfileprofile: CHANNEL_PROFILE_TYPEint错误码索引
setClientRolerole: CLIENT_ROLE_TYPEint错误码索引
setCloudProxyproxyType: CLOUD_PROXY_TYPEint错误码索引
setColorEnhanceOptionsenabled: bool, options: const ColorEnhanceOptions&, type?: agora::media::MEDIA_SOURCE_TYPEint错误码索引
setDefaultAudioRouteToSpeakerphonedefaultToSpeaker: boolint错误码索引
setDirectCdnStreamingAudioConfigurationprofile: AUDIO_PROFILE_TYPEint错误码索引
setDirectCdnStreamingVideoConfigurationconfig: const VideoEncoderConfiguration&int错误码索引
setDualStreamModemode: SIMULCAST_STREAM_MODEint错误码索引
setEarMonitoringAudioFrameParameterssampleRate: int, channel: int, mode: RAW_AUDIO_FRAME_OP_MODE_TYPE, samplesPerCall: intint错误码索引
setEffectPositionsoundId: int, pos: intint错误码索引
setEffectsVolumevolume: intint错误码索引
setEnableSpeakerphonespeakerOn: boolint错误码索引
setExtensionPropertyprovider: const char*, extension: const char*, key: const char*, value: const char*, type?: agora::media::MEDIA_SOURCE_TYPEint错误码索引
setExtensionProviderPropertyprovider: const char*, key: const char*, value: const char*int错误码索引
setExternalAudioSinkenabled: bool, sampleRate: int, channels: intint错误码索引
setExternalRemoteEglContexteglContext: void*int错误码索引
setFaceShapeAreaOptionsoptions: const FaceShapeAreaOptions&, type?: agora::media::MEDIA_SOURCE_TYPEint错误码索引
setFaceShapeBeautyOptionsenabled: bool, options: const FaceShapeBeautyOptions&, type?: agora::media::MEDIA_SOURCE_TYPEint错误码索引
setFilterEffectOptionsenabled: bool, options: const FilterEffectOptions&, type?: agora::media::MEDIA_SOURCE_TYPEint错误码索引
setHeadphoneEQParameterslowGain: int, highGain: intint错误码索引
setHeadphoneEQPresetpreset: HEADPHONE_EQUALIZER_PRESETint错误码索引
setInEarMonitoringVolumevolume: intint错误码索引
setLocalRenderModerenderMode: media::base::RENDER_MODE_TYPEint错误码索引
setLocalRenderTargetFpssourceType: VIDEO_SOURCE_TYPE, targetFps: intint错误码索引
setLocalVideoMirrorModemirrorMode: VIDEO_MIRROR_MODE_TYPEint错误码索引
setLocalVoiceEqualizationbandFrequency: AUDIO_EQUALIZATION_BAND_FREQUENCY, bandGain: intint错误码索引
setLocalVoiceFormantformantRatio: doubleint错误码索引
setLocalVoicePitchpitch: doubleint错误码索引
setLocalVoiceReverbreverbKey: AUDIO_REVERB_TYPE, value: intint错误码索引
setLogFilefilePath: const char*int错误码索引
setLogFileSizefileSizeInKBytes: unsigned intint错误码索引
setLogFilterfilter: unsigned intint错误码索引
setLogLevellevel: commons::LOG_LEVELint错误码索引
setLowlightEnhanceOptionsenabled: bool, options: const LowlightEnhanceOptions&, type?: agora::media::MEDIA_SOURCE_TYPEint错误码索引
setMixedAudioFrameParameterssampleRate: int, channel: int, samplesPerCall: intint错误码索引
setParametersparameters: const char*int错误码索引
setPlaybackAudioFrameBeforeMixingParameterssampleRate: int, channel: intint错误码索引
setPlaybackAudioFrameParameterssampleRate: int, channel: int, mode: RAW_AUDIO_FRAME_OP_MODE_TYPE, samplesPerCall: intint错误码索引
setRecordingAudioFrameParameterssampleRate: int, channel: int, mode: RAW_AUDIO_FRAME_OP_MODE_TYPE, samplesPerCall: intint错误码索引
setRemoteDefaultVideoStreamTypestreamType: VIDEO_STREAM_TYPEint错误码索引
setRemoteRenderModeuserId: uid_t, renderMode: RENDER_MODE_TYPE, mirrorMode: VIDEO_MIRROR_MODE_TYPEint错误码索引
setRemoteRenderTargetFpstargetFps: intint错误码索引
setRemoteSubscribeFallbackOptionoption: STREAM_FALLBACK_OPTIONSint错误码索引
setRemoteUserSpatialAudioParamsuid: uid_t, params: const agora::SpatialAudioParams&int错误码索引
setRemoteVideoStreamTypeuid: uid_t, streamType: VIDEO_STREAM_TYPEint错误码索引
setRemoteVideoSubscriptionOptionsuid: uid_t, options: const VideoSubscriptionOptions&int错误码索引
setRemoteVoicePositionuid: uid_t, pan: double, gain: doubleint错误码索引
setRouteInCommunicationModeroute: intint错误码索引
setScreenCaptureContentHintcontentHint: VIDEO_CONTENT_HINTint错误码索引
setScreenCaptureScenarioscreenScenario: SCREEN_SCENARIO_TYPEint错误码索引
setSubscribeAudioAllowlistuidList: uid_t*, uidNumber: intint错误码索引
setSubscribeAudioBlocklistuidList: uid_t*, uidNumber: intint错误码索引
setSubscribeVideoAllowlistuidList: uid_t*, uidNumber: intint错误码索引
setSubscribeVideoBlocklistuidList: uid_t*, uidNumber: intint错误码索引
setVideoDenoiserOptionsenabled: bool, options: const VideoDenoiserOptions&, type?: agora::media::MEDIA_SOURCE_TYPEint错误码索引
setVideoEncoderConfigurationconfig: const VideoEncoderConfiguration&int错误码索引
setVideoScenarioscenarioType: VIDEO_APPLICATION_SCENARIO_TYPEint错误码索引
setVoiceBeautifierParameterspreset: VOICE_BEAUTIFIER_PRESET, param1: int, param2: intint错误码索引
setVoiceBeautifierPresetpreset: VOICE_BEAUTIFIER_PRESETint错误码索引
setVoiceConversionPresetpreset: VOICE_CONVERSION_PRESETint错误码索引
setVolumeOfEffectsoundId: int, volume: intint错误码索引
setupLocalVideocanvas: const VideoCanvas&int错误码索引
setupRemoteVideocanvas: const VideoCanvas&int错误码索引
startAudioMixingfilePath: const char*, loopback: bool, cycle: intint错误码索引
startAudioRecordingconfig: const AudioFileRecordingConfig&int错误码索引
startCameraCapturesourceType: VIDEO_SOURCE_TYPE, config: const CameraCapturerConfiguration&int错误码索引
startDirectCdnStreamingeventHandler: IDirectCdnStreamingEventHandler*, publishUrl: const char*, options: const DirectCdnStreamingMediaOptions&int错误码索引
startEchoTestconfig: const EchoTestConfiguration&int错误码索引
startLastmileProbeTestconfig: const LastmileProbeConfig&int错误码索引
startLocalAudioMixerconfig: const LocalAudioMixerConfiguration&int错误码索引
startLocalVideoTranscoderconfig: const LocalTranscoderConfiguration&int错误码索引
startMediaRenderingTracing—int错误码索引
startOrUpdateChannelMediaRelayconfiguration: const ChannelMediaRelayConfiguration&int错误码索引
startPreview—int错误码索引
startRhythmPlayersound1: const char*, sound2: const char*, config: const AgoraRhythmPlayerConfig&int错误码索引
startRtmpStreamWithTranscodingurl: const char*, transcoding: const LiveTranscoding&int错误码索引
startRtmpStreamWithoutTranscodingurl: const char*int错误码索引
startScreenCapturecaptureParams: unknownunknown错误码索引
startScreenCaptureByDisplayIddisplayId: int64_t, regionRect: const Rectangle&, captureParams: const ScreenCaptureParameters&int错误码索引
startScreenCaptureByScreenRectscreenRect: const Rectangle&, regionRect: const Rectangle&, captureParams: const ScreenCaptureParameters&int错误码索引
startScreenCaptureByWindowIdwindowId: int64_t, regionRect: const Rectangle&, captureParams: const ScreenCaptureParameters&int错误码索引
stopAllEffects—int错误码索引
stopAudioMixing—int错误码索引
stopAudioRecording—int错误码索引
stopCameraCapturesourceType: VIDEO_SOURCE_TYPEint错误码索引
stopChannelMediaRelay—int错误码索引
stopDirectCdnStreaming—int错误码索引
stopEchoTest—int错误码索引
stopEffectsoundId: intint错误码索引
stopLastmileProbeTest—int错误码索引
stopLocalAudioMixer—int错误码索引
stopLocalVideoTranscoder—int错误码索引
stopPreview—int错误码索引
stopRhythmPlayer—int错误码索引
stopRtmpStreamurl: const char*int错误码索引
stopScreenCapture—unknown错误码索引
switchCamera—int错误码索引
takeSnapshotuid: uid_t, filePath: const char*int错误码索引
unloadAllEffects—int错误码索引
unloadEffectsoundId: intint错误码索引
unregisterAudioSpectrumObserverobserver: agora::media::IAudioSpectrumObserver*int错误码索引
unregisterMediaMetadataObserverobserver: IMetadataObserver*, type: IMetadataObserver::METADATA_TYPEint错误码索引
updateChannelMediaOptionsoptions: const ChannelMediaOptions&int错误码索引
updateLocalAudioMixerConfigurationconfig: const LocalAudioMixerConfiguration&int错误码索引
updateLocalTranscoderConfigurationconfig: const LocalTranscoderConfiguration&int错误码索引
updatePreloadChannelTokentoken: const char*int错误码索引
updateRtmpTranscodingtranscoding: const LiveTranscoding&int错误码索引
updateScreenCapturecaptureParams: const ScreenCaptureParameters2&int错误码索引
updateScreenCaptureParameterscaptureParams: const ScreenCaptureParameters&int错误码索引
updateScreenCaptureRegionregionRect: const Rectangle&int错误码索引
IRtcEngineEventHandler 83 方法 / 0 属性
typescript
onActiveSpeaker(userId: uid_t): void
onAudioDeviceStateChanged(deviceId: const char*, deviceType: int, deviceState: int): void
onAudioDeviceVolumeChanged(deviceType: MEDIA_DEVICE_TYPE, volume: int, muted: bool): void
onAudioEffectFinished(soundId: int): void
onAudioMixingFinished(): void
onAudioMixingPositionChanged(position: int64_t): void
onAudioMixingStateChanged(state: AUDIO_MIXING_STATE_TYPE, reason: AUDIO_MIXING_REASON_TYPE): void
onAudioPublishStateChanged(channel: const char*, oldState: STREAM_PUBLISH_STATE, newState: STREAM_PUBLISH_STATE, elapseSinceLastState: int): void
onAudioQuality(uid: uid_t, quality: int, delay: unsigned short, lost: unsigned short): void
onAudioRoutingChanged(routing: int): void
onAudioSubscribeStateChanged(channel: const char*, uid: uid_t, oldState: STREAM_SUBSCRIBE_STATE, newState: STREAM_SUBSCRIBE_STATE, elapseSinceLastState: int): void
onAudioVolumeIndication(speakers: const AudioVolumeInfo*, speakerNumber: unsigned int, totalVolume: int): void
onCameraExposureAreaChanged(x: int, y: int, width: int, height: int): void
onCameraFocusAreaChanged(x: int, y: int, width: int, height: int): void
onCameraReady(): void
onChannelMediaRelayStateChanged(state: CHANNEL_MEDIA_RELAY_STATE, code: CHANNEL_MEDIA_RELAY_ERROR): void
onClientRoleChangeFailed(reason: CLIENT_ROLE_CHANGE_FAILED_REASON, currentRole: CLIENT_ROLE_TYPE): void
onClientRoleChanged(oldRole: CLIENT_ROLE_TYPE, newRole: CLIENT_ROLE_TYPE, newRoleOptions: const ClientRoleOptions&): void
onConnectionBanned(): void
onConnectionInterrupted(): void
onConnectionLost(): void
onConnectionStateChanged(state: CONNECTION_STATE_TYPE, reason: CONNECTION_CHANGED_REASON_TYPE): void
onEncryptionError(errorType: ENCRYPTION_ERROR_TYPE): void
onError(err: int, msg: const char*): void
onExtensionErrorWithContext(context: const ExtensionContext&, error: int, message: const char*): void
onExtensionEventWithContext(context: const ExtensionContext&, key: const char*, value: const char*): void
onExtensionStartedWithContext(context: const ExtensionContext&): void
onExtensionStoppedWithContext(context: const ExtensionContext&): void
onFacePositionChanged(imageWidth: int, imageHeight: int, vecRectangle: const Rectangle*, vecDistance: const int*, numFaces: int): void
onFirstLocalAudioFramePublished(elapsed: int): void
onFirstLocalVideoFrame(source: VIDEO_SOURCE_TYPE, width: int, height: int, elapsed: int): void
onFirstLocalVideoFramePublished(source: VIDEO_SOURCE_TYPE, elapsed: int): void
onFirstRemoteAudioDecoded(uid: uid_t, elapsed: int): void
onFirstRemoteAudioFrame(uid: uid_t, elapsed: int): void
onFirstRemoteVideoDecoded(uid: uid_t, width: int, height: int, elapsed: int): void
onFirstRemoteVideoFrame(userId: uid_t, width: int, height: int, elapsed: int): void
onJoinChannelSuccess(channel: const char*, uid: uid_t, elapsed: int): void
onLastmileProbeResult(result: const LastmileProbeResult&): void
onLastmileQuality(quality: int): void
onLeaveChannel(stats: const RtcStats&): void
onLocalAudioStateChanged(state: LOCAL_AUDIO_STREAM_STATE, reason: LOCAL_AUDIO_STREAM_REASON): void
onLocalAudioStats(stats: const LocalAudioStats&): void
onLocalUserRegistered(uid: uid_t, userAccount: const char*): void
onLocalVideoStateChanged(source: VIDEO_SOURCE_TYPE, state: LOCAL_VIDEO_STREAM_STATE, reason: LOCAL_VIDEO_STREAM_REASON): void
onLocalVideoStats(source: VIDEO_SOURCE_TYPE, stats: const LocalVideoStats&): void
onLocalVideoTranscoderError(stream: const TranscodingVideoStream&, error: VIDEO_TRANSCODER_ERROR): void
onNetworkQuality(uid: uid_t, txQuality: int, rxQuality: int): void
onNetworkTypeChanged(type: NETWORK_TYPE): void
onPermissionError(permissionType: PERMISSION_TYPE): void
onProxyConnected(channel: const char*, uid: uid_t, proxyType: PROXY_TYPE, localProxyIp: const char*, elapsed: int): void
onRejoinChannelSuccess(channel: const char*, uid: uid_t, elapsed: int): void
onRemoteAudioStateChanged(uid: uid_t, state: REMOTE_AUDIO_STATE, reason: REMOTE_AUDIO_STATE_REASON, elapsed: int): void
onRemoteAudioStats(stats: const RemoteAudioStats&): void
onRemoteAudioTransportStats(uid: uid_t, delay: unsigned short, lost: unsigned short, rxKBitRate: unsigned short): void
onRemoteSubscribeFallbackToAudioOnly(uid: uid_t, isFallbackOrRecover: bool): void
onRemoteVideoStateChanged(uid: uid_t, state: REMOTE_VIDEO_STATE, reason: REMOTE_VIDEO_STATE_REASON, elapsed: int): void
onRemoteVideoStats(stats: const RemoteVideoStats&): void
onRemoteVideoTransportStats(uid: uid_t, delay: unsigned short, lost: unsigned short, rxKBitRate: unsigned short): void
onRequestToken(): void
onRhythmPlayerStateChanged(state: RHYTHM_PLAYER_STATE_TYPE, reason: RHYTHM_PLAYER_REASON): void
onRtcStats(stats: const RtcStats&): void
onRtmpStreamingEvent(url: const char*, eventCode: RTMP_STREAMING_EVENT): void
onRtmpStreamingStateChanged(url: const char*, state: RTMP_STREAM_PUBLISH_STATE, reason: RTMP_STREAM_PUBLISH_REASON): void
onSnapshotTaken(uid: uid_t, filePath: const char*, width: int, height: int, errCode: int): void
onStreamMessage(userId: uid_t, streamId: int, data: const char*, length: size_t, sentTs: uint64_t): void
onStreamMessageError(userId: uid_t, streamId: int, code: int, missed: int, cached: int): void
onTokenPrivilegeWillExpire(token: const char*): void
onTranscodedStreamLayoutInfo(uid: uid_t, width: int, height: int, layoutCount: int, layoutlist: const VideoLayout*): void
onTranscodingUpdated(): void
onUplinkNetworkInfoUpdated(info: const UplinkNetworkInfo&): void
onUserEnableLocalVideo(uid: uid_t, enabled: bool): void
onUserEnableVideo(uid: uid_t, enabled: bool): void
onUserInfoUpdated(uid: uid_t, info: const UserInfo&): void
onUserJoined(uid: uid_t, elapsed: int): void
onUserMuteAudio(uid: uid_t, muted: bool): void
onUserMuteVideo(uid: uid_t, muted: bool): void
onUserOffline(uid: uid_t, reason: USER_OFFLINE_REASON_TYPE): void
onVideoDeviceStateChanged(deviceId: const char*, deviceType: int, deviceState: int): void
onVideoPublishStateChanged(source: VIDEO_SOURCE_TYPE, channel: const char*, oldState: STREAM_PUBLISH_STATE, newState: STREAM_PUBLISH_STATE, elapseSinceLastState: int): void
onVideoRenderingTracingResult(uid: uid_t, currentEvent: MEDIA_TRACE_EVENT, tracingInfo: VideoRenderingTracingInfo): void
onVideoSizeChanged(sourceType: VIDEO_SOURCE_TYPE, uid: uid_t, width: int, height: int, rotation: int): void
onVideoStopped(): void
onVideoSubscribeStateChanged(channel: const char*, uid: uid_t, oldState: STREAM_SUBSCRIBE_STATE, newState: STREAM_SUBSCRIBE_STATE, elapseSinceLastState: int): void

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

方法参数返回值错误
onActiveSpeakeruserId: uid_tvoid错误码索引
onAudioDeviceStateChangeddeviceId: const char*, deviceType: int, deviceState: intvoid错误码索引
onAudioDeviceVolumeChangeddeviceType: MEDIA_DEVICE_TYPE, volume: int, muted: boolvoid错误码索引
onAudioEffectFinishedsoundId: intvoid错误码索引
onAudioMixingFinished—void错误码索引
onAudioMixingPositionChangedposition: int64_tvoid错误码索引
onAudioMixingStateChangedstate: AUDIO_MIXING_STATE_TYPE, reason: AUDIO_MIXING_REASON_TYPEvoid错误码索引
onAudioPublishStateChangedchannel: const char*, oldState: STREAM_PUBLISH_STATE, newState: STREAM_PUBLISH_STATE, elapseSinceLastState: intvoid错误码索引
onAudioQualityuid: uid_t, quality: int, delay: unsigned short, lost: unsigned shortvoid错误码索引
onAudioRoutingChangedrouting: intvoid错误码索引
onAudioSubscribeStateChangedchannel: const char*, uid: uid_t, oldState: STREAM_SUBSCRIBE_STATE, newState: STREAM_SUBSCRIBE_STATE, elapseSinceLastState: intvoid错误码索引
onAudioVolumeIndicationspeakers: const AudioVolumeInfo*, speakerNumber: unsigned int, totalVolume: intvoid错误码索引
onCameraExposureAreaChangedx: int, y: int, width: int, height: intvoid错误码索引
onCameraFocusAreaChangedx: int, y: int, width: int, height: intvoid错误码索引
onCameraReady—void错误码索引
onChannelMediaRelayStateChangedstate: CHANNEL_MEDIA_RELAY_STATE, code: CHANNEL_MEDIA_RELAY_ERRORvoid错误码索引
onClientRoleChangeFailedreason: CLIENT_ROLE_CHANGE_FAILED_REASON, currentRole: CLIENT_ROLE_TYPEvoid错误码索引
onClientRoleChangedoldRole: CLIENT_ROLE_TYPE, newRole: CLIENT_ROLE_TYPE, newRoleOptions: const ClientRoleOptions&void错误码索引
onConnectionBanned—void错误码索引
onConnectionInterrupted—void错误码索引
onConnectionLost—void错误码索引
onConnectionStateChangedstate: CONNECTION_STATE_TYPE, reason: CONNECTION_CHANGED_REASON_TYPEvoid错误码索引
onEncryptionErrorerrorType: ENCRYPTION_ERROR_TYPEvoid错误码索引
onErrorerr: int, msg: const char*void错误码索引
onExtensionErrorWithContextcontext: const ExtensionContext&, error: int, message: const char*void错误码索引
onExtensionEventWithContextcontext: const ExtensionContext&, key: const char*, value: const char*void错误码索引
onExtensionStartedWithContextcontext: const ExtensionContext&void错误码索引
onExtensionStoppedWithContextcontext: const ExtensionContext&void错误码索引
onFacePositionChangedimageWidth: int, imageHeight: int, vecRectangle: const Rectangle*, vecDistance: const int*, numFaces: intvoid错误码索引
onFirstLocalAudioFramePublishedelapsed: intvoid错误码索引
onFirstLocalVideoFramesource: VIDEO_SOURCE_TYPE, width: int, height: int, elapsed: intvoid错误码索引
onFirstLocalVideoFramePublishedsource: VIDEO_SOURCE_TYPE, elapsed: intvoid错误码索引
onFirstRemoteAudioDecodeduid: uid_t, elapsed: intvoid错误码索引
onFirstRemoteAudioFrameuid: uid_t, elapsed: intvoid错误码索引
onFirstRemoteVideoDecodeduid: uid_t, width: int, height: int, elapsed: intvoid错误码索引
onFirstRemoteVideoFrameuserId: uid_t, width: int, height: int, elapsed: intvoid错误码索引
onJoinChannelSuccesschannel: const char*, uid: uid_t, elapsed: intvoid错误码索引
onLastmileProbeResultresult: const LastmileProbeResult&void错误码索引
onLastmileQualityquality: intvoid错误码索引
onLeaveChannelstats: const RtcStats&void错误码索引
onLocalAudioStateChangedstate: LOCAL_AUDIO_STREAM_STATE, reason: LOCAL_AUDIO_STREAM_REASONvoid错误码索引
onLocalAudioStatsstats: const LocalAudioStats&void错误码索引
onLocalUserRegistereduid: uid_t, userAccount: const char*void错误码索引
onLocalVideoStateChangedsource: VIDEO_SOURCE_TYPE, state: LOCAL_VIDEO_STREAM_STATE, reason: LOCAL_VIDEO_STREAM_REASONvoid错误码索引
onLocalVideoStatssource: VIDEO_SOURCE_TYPE, stats: const LocalVideoStats&void错误码索引
onLocalVideoTranscoderErrorstream: const TranscodingVideoStream&, error: VIDEO_TRANSCODER_ERRORvoid错误码索引
onNetworkQualityuid: uid_t, txQuality: int, rxQuality: intvoid错误码索引
onNetworkTypeChangedtype: NETWORK_TYPEvoid错误码索引
onPermissionErrorpermissionType: PERMISSION_TYPEvoid错误码索引
onProxyConnectedchannel: const char*, uid: uid_t, proxyType: PROXY_TYPE, localProxyIp: const char*, elapsed: intvoid错误码索引
onRejoinChannelSuccesschannel: const char*, uid: uid_t, elapsed: intvoid错误码索引
onRemoteAudioStateChangeduid: uid_t, state: REMOTE_AUDIO_STATE, reason: REMOTE_AUDIO_STATE_REASON, elapsed: intvoid错误码索引
onRemoteAudioStatsstats: const RemoteAudioStats&void错误码索引
onRemoteAudioTransportStatsuid: uid_t, delay: unsigned short, lost: unsigned short, rxKBitRate: unsigned shortvoid错误码索引
onRemoteSubscribeFallbackToAudioOnlyuid: uid_t, isFallbackOrRecover: boolvoid错误码索引
onRemoteVideoStateChangeduid: uid_t, state: REMOTE_VIDEO_STATE, reason: REMOTE_VIDEO_STATE_REASON, elapsed: intvoid错误码索引
onRemoteVideoStatsstats: const RemoteVideoStats&void错误码索引
onRemoteVideoTransportStatsuid: uid_t, delay: unsigned short, lost: unsigned short, rxKBitRate: unsigned shortvoid错误码索引
onRequestToken—void错误码索引
onRhythmPlayerStateChangedstate: RHYTHM_PLAYER_STATE_TYPE, reason: RHYTHM_PLAYER_REASONvoid错误码索引
onRtcStatsstats: const RtcStats&void错误码索引
onRtmpStreamingEventurl: const char*, eventCode: RTMP_STREAMING_EVENTvoid错误码索引
onRtmpStreamingStateChangedurl: const char*, state: RTMP_STREAM_PUBLISH_STATE, reason: RTMP_STREAM_PUBLISH_REASONvoid错误码索引
onSnapshotTakenuid: uid_t, filePath: const char*, width: int, height: int, errCode: intvoid错误码索引
onStreamMessageuserId: uid_t, streamId: int, data: const char*, length: size_t, sentTs: uint64_tvoid错误码索引
onStreamMessageErroruserId: uid_t, streamId: int, code: int, missed: int, cached: intvoid错误码索引
onTokenPrivilegeWillExpiretoken: const char*void错误码索引
onTranscodedStreamLayoutInfouid: uid_t, width: int, height: int, layoutCount: int, layoutlist: const VideoLayout*void错误码索引
onTranscodingUpdated—void错误码索引
onUplinkNetworkInfoUpdatedinfo: const UplinkNetworkInfo&void错误码索引
onUserEnableLocalVideouid: uid_t, enabled: boolvoid错误码索引
onUserEnableVideouid: uid_t, enabled: boolvoid错误码索引
onUserInfoUpdateduid: uid_t, info: const UserInfo&void错误码索引
onUserJoineduid: uid_t, elapsed: intvoid错误码索引
onUserMuteAudiouid: uid_t, muted: boolvoid错误码索引
onUserMuteVideouid: uid_t, muted: boolvoid错误码索引
onUserOfflineuid: uid_t, reason: USER_OFFLINE_REASON_TYPEvoid错误码索引
onVideoDeviceStateChangeddeviceId: const char*, deviceType: int, deviceState: intvoid错误码索引
onVideoPublishStateChangedsource: VIDEO_SOURCE_TYPE, channel: const char*, oldState: STREAM_PUBLISH_STATE, newState: STREAM_PUBLISH_STATE, elapseSinceLastState: intvoid错误码索引
onVideoRenderingTracingResultuid: uid_t, currentEvent: MEDIA_TRACE_EVENT, tracingInfo: VideoRenderingTracingInfovoid错误码索引
onVideoSizeChangedsourceType: VIDEO_SOURCE_TYPE, uid: uid_t, width: int, height: int, rotation: intvoid错误码索引
onVideoStopped—void错误码索引
onVideoSubscribeStateChangedchannel: const char*, uid: uid_t, oldState: STREAM_SUBSCRIBE_STATE, newState: STREAM_SUBSCRIBE_STATE, elapseSinceLastState: intvoid错误码索引
IRtcEngineEx 44 方法 / 0 属性
typescript
addVideoWatermarkEx(watermarkUrl: const char*, options: const WatermarkOptions&, connection: const RtcConnection&): int
adjustUserPlaybackSignalVolumeEx(uid: unsigned int, volume: int, connection: const RtcConnection&): int
clearVideoWatermarkEx(connection: const RtcConnection&): int
createDataStreamEx(streamId: int*, reliable: bool, ordered: bool, connection: const RtcConnection&): int
createDataStreamEx(streamId: int*, config: DataStreamConfig&, connection: const RtcConnection&): int
enableAudioVolumeIndicationEx(interval: int, smooth: int, reportVad: bool, connection: const RtcConnection&): int
enableContentInspectEx(enabled: bool, config: const media::ContentInspectConfig&, connection: const RtcConnection&): int
enableDualStreamModeEx(enabled: bool, streamConfig: const SimulcastStreamConfig&, connection: const RtcConnection&): int
enableEncryptionEx(connection: const RtcConnection&, enabled: bool, config: const EncryptionConfig&): int
enableLoopbackRecordingEx(connection: const RtcConnection&, enabled: bool, deviceName?: const char*): int
getCallIdEx(callId: agora::util::AString&, connection: const RtcConnection&): int
getConnectionStateEx(connection: const RtcConnection&): CONNECTION_STATE_TYPE
joinChannelEx(token: const char*, connection: const RtcConnection&, options: const ChannelMediaOptions&, eventHandler: IRtcEngineEventHandler*): int
joinChannelWithUserAccountEx(token: const char*, channelId: const char*, userAccount: const char*, options: const ChannelMediaOptions&, eventHandler: IRtcEngineEventHandler*): int
leaveChannelEx(connection: const RtcConnection&): int
leaveChannelEx(connection: const RtcConnection&, options: const LeaveChannelOptions&): int
muteAllRemoteAudioStreamsEx(mute: bool, connection: const RtcConnection&): int
muteAllRemoteVideoStreamsEx(mute: bool, connection: const RtcConnection&): int
muteLocalAudioStreamEx(mute: bool, connection: const RtcConnection&): int
muteLocalVideoStreamEx(mute: bool, connection: const RtcConnection&): int
muteRemoteAudioStreamEx(uid: uid_t, mute: bool, connection: const RtcConnection&): int
muteRemoteVideoStreamEx(uid: uid_t, mute: bool, connection: const RtcConnection&): int
pauseAllChannelMediaRelayEx(connection: const RtcConnection&): int
resumeAllChannelMediaRelayEx(connection: const RtcConnection&): int
sendCustomReportMessageEx(id: const char*, category: const char*, event: const char*, label: const char*, value: int, connection: const RtcConnection&): int
sendStreamMessageEx(streamId: int, data: const char*, length: size_t, connection: const RtcConnection&): int
setDualStreamModeEx(mode: SIMULCAST_STREAM_MODE, streamConfig: const SimulcastStreamConfig&, connection: const RtcConnection&): int
setRemoteRenderModeEx(uid: uid_t, renderMode: media::base::RENDER_MODE_TYPE, mirrorMode: VIDEO_MIRROR_MODE_TYPE, connection: const RtcConnection&): int
setRemoteVideoStreamTypeEx(uid: uid_t, streamType: VIDEO_STREAM_TYPE, connection: const RtcConnection&): int
setRemoteVideoSubscriptionOptionsEx(uid: uid_t, options: const VideoSubscriptionOptions&, connection: const RtcConnection&): int
setRemoteVoicePositionEx(uid: uid_t, pan: double, gain: double, connection: const RtcConnection&): int
setSubscribeAudioAllowlistEx(uidList: uid_t*, uidNumber: int, connection: const RtcConnection&): int
setSubscribeAudioBlocklistEx(uidList: uid_t*, uidNumber: int, connection: const RtcConnection&): int
setSubscribeVideoAllowlistEx(uidList: uid_t*, uidNumber: int, connection: const RtcConnection&): int
setSubscribeVideoBlocklistEx(uidList: uid_t*, uidNumber: int, connection: const RtcConnection&): int
setVideoEncoderConfigurationEx(config: const VideoEncoderConfiguration&, connection: const RtcConnection&): int
setupRemoteVideoEx(canvas: const VideoCanvas&, connection: const RtcConnection&): int
startMediaRenderingTracingEx(connection: const RtcConnection&): int
startOrUpdateChannelMediaRelayEx(configuration: const ChannelMediaRelayConfiguration&, connection: const RtcConnection&): int
startRtmpStreamWithTranscodingEx(url: const char*, transcoding: const LiveTranscoding&, connection: const RtcConnection&): int
startRtmpStreamWithoutTranscodingEx(url: const char*, connection: const RtcConnection&): int
stopChannelMediaRelayEx(connection: const RtcConnection&): int
stopRtmpStreamEx(url: const char*, connection: const RtcConnection&): int
takeSnapshotEx(connection: const RtcConnection&, uid: uid_t, filePath: const char*): int
takeSnapshotEx(connection: const RtcConnection&, uid: uid_t, config: const media::SnapshotConfig&): int
updateChannelMediaOptionsEx(options: const ChannelMediaOptions&, connection: const RtcConnection&): int
updateRtmpTranscodingEx(transcoding: const LiveTranscoding&, connection: const RtcConnection&): int

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

方法参数返回值错误
addVideoWatermarkExwatermarkUrl: const char*, options: const WatermarkOptions&, connection: const RtcConnection&int错误码索引
adjustUserPlaybackSignalVolumeExuid: unsigned int, volume: int, connection: const RtcConnection&int错误码索引
clearVideoWatermarkExconnection: const RtcConnection&int错误码索引
createDataStreamExstreamId: int*, reliable: bool, ordered: bool, connection: const RtcConnection&int错误码索引
enableAudioVolumeIndicationExinterval: int, smooth: int, reportVad: bool, connection: const RtcConnection&int错误码索引
enableContentInspectExenabled: bool, config: const media::ContentInspectConfig&, connection: const RtcConnection&int错误码索引
enableDualStreamModeExenabled: bool, streamConfig: const SimulcastStreamConfig&, connection: const RtcConnection&int错误码索引
enableEncryptionExconnection: const RtcConnection&, enabled: bool, config: const EncryptionConfig&int错误码索引
enableLoopbackRecordingExconnection: const RtcConnection&, enabled: bool, deviceName?: const char*int错误码索引
getCallIdExcallId: agora::util::AString&, connection: const RtcConnection&int错误码索引
getConnectionStateExconnection: const RtcConnection&CONNECTION_STATE_TYPE错误码索引
joinChannelExtoken: const char*, connection: const RtcConnection&, options: const ChannelMediaOptions&, eventHandler: IRtcEngineEventHandler*int错误码索引
joinChannelWithUserAccountExtoken: const char*, channelId: const char*, userAccount: const char*, options: const ChannelMediaOptions&, eventHandler: IRtcEngineEventHandler*int错误码索引
leaveChannelExconnection: const RtcConnection&int错误码索引
muteAllRemoteAudioStreamsExmute: bool, connection: const RtcConnection&int错误码索引
muteAllRemoteVideoStreamsExmute: bool, connection: const RtcConnection&int错误码索引
muteLocalAudioStreamExmute: bool, connection: const RtcConnection&int错误码索引
muteLocalVideoStreamExmute: bool, connection: const RtcConnection&int错误码索引
muteRemoteAudioStreamExuid: uid_t, mute: bool, connection: const RtcConnection&int错误码索引
muteRemoteVideoStreamExuid: uid_t, mute: bool, connection: const RtcConnection&int错误码索引
pauseAllChannelMediaRelayExconnection: const RtcConnection&int错误码索引
resumeAllChannelMediaRelayExconnection: const RtcConnection&int错误码索引
sendCustomReportMessageExid: const char*, category: const char*, event: const char*, label: const char*, value: int, connection: const RtcConnection&int错误码索引
sendStreamMessageExstreamId: int, data: const char*, length: size_t, connection: const RtcConnection&int错误码索引
setDualStreamModeExmode: SIMULCAST_STREAM_MODE, streamConfig: const SimulcastStreamConfig&, connection: const RtcConnection&int错误码索引
setRemoteRenderModeExuid: uid_t, renderMode: media::base::RENDER_MODE_TYPE, mirrorMode: VIDEO_MIRROR_MODE_TYPE, connection: const RtcConnection&int错误码索引
setRemoteVideoStreamTypeExuid: uid_t, streamType: VIDEO_STREAM_TYPE, connection: const RtcConnection&int错误码索引
setRemoteVideoSubscriptionOptionsExuid: uid_t, options: const VideoSubscriptionOptions&, connection: const RtcConnection&int错误码索引
setRemoteVoicePositionExuid: uid_t, pan: double, gain: double, connection: const RtcConnection&int错误码索引
setSubscribeAudioAllowlistExuidList: uid_t*, uidNumber: int, connection: const RtcConnection&int错误码索引
setSubscribeAudioBlocklistExuidList: uid_t*, uidNumber: int, connection: const RtcConnection&int错误码索引
setSubscribeVideoAllowlistExuidList: uid_t*, uidNumber: int, connection: const RtcConnection&int错误码索引
setSubscribeVideoBlocklistExuidList: uid_t*, uidNumber: int, connection: const RtcConnection&int错误码索引
setVideoEncoderConfigurationExconfig: const VideoEncoderConfiguration&, connection: const RtcConnection&int错误码索引
setupRemoteVideoExcanvas: const VideoCanvas&, connection: const RtcConnection&int错误码索引
startMediaRenderingTracingExconnection: const RtcConnection&int错误码索引
startOrUpdateChannelMediaRelayExconfiguration: const ChannelMediaRelayConfiguration&, connection: const RtcConnection&int错误码索引
startRtmpStreamWithTranscodingExurl: const char*, transcoding: const LiveTranscoding&, connection: const RtcConnection&int错误码索引
startRtmpStreamWithoutTranscodingExurl: const char*, connection: const RtcConnection&int错误码索引
stopChannelMediaRelayExconnection: const RtcConnection&int错误码索引
stopRtmpStreamExurl: const char*, connection: const RtcConnection&int错误码索引
takeSnapshotExconnection: const RtcConnection&, uid: uid_t, filePath: const char*int错误码索引
updateChannelMediaOptionsExoptions: const ChannelMediaOptions&, connection: const RtcConnection&int错误码索引
updateRtmpTranscodingExtranscoding: const LiveTranscoding&, connection: const RtcConnection&int错误码索引
IScreenCaptureSourceList 3 方法 / 0 属性
typescript
getCount(): unsigned int
getSourceInfo(index: unsigned int): ScreenCaptureSourceInfo
release(): void

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

方法参数返回值错误
getCount—unsigned int错误码索引
getSourceInfoindex: unsigned intScreenCaptureSourceInfo错误码索引
release—void错误码索引
IVideoDeviceCollection 4 方法 / 0 属性
typescript
getCount(): int
getDevice(index: int, null: char deviceName[MAX_DEVICE_ID_LENGTH], null: char deviceId[MAX_DEVICE_ID_LENGTH]): int
release(): void
setDevice(null: const char deviceId[MAX_DEVICE_ID_LENGTH]): int

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

方法参数返回值错误
getCount—int错误码索引
getDeviceindex: int, null: char deviceName[MAX_DEVICE_ID_LENGTH], null: char deviceId[MAX_DEVICE_ID_LENGTH]int错误码索引
release—void错误码索引
setDevicenull: const char deviceId[MAX_DEVICE_ID_LENGTH]int错误码索引
IVideoDeviceManager 6 方法 / 0 属性
typescript
enumerateVideoDevices(): IVideoDeviceCollection*
getCapability(deviceIdUTF8: const char*, deviceCapabilityNumber: const uint32_t, capability: VideoFormat&): int
getDevice(null: char deviceIdUTF8[MAX_DEVICE_ID_LENGTH]): int
numberOfCapabilities(deviceIdUTF8: const char*): int
release(): void
setDevice(null: const char deviceId[MAX_DEVICE_ID_LENGTH]): int

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

方法参数返回值错误
enumerateVideoDevices—IVideoDeviceCollection*错误码索引
getCapabilitydeviceIdUTF8: const char*, deviceCapabilityNumber: const uint32_t, capability: VideoFormat&int错误码索引
getDevicenull: char deviceIdUTF8[MAX_DEVICE_ID_LENGTH]int错误码索引
numberOfCapabilitiesdeviceIdUTF8: const char*int错误码索引
release—void错误码索引
setDevicenull: const char deviceId[MAX_DEVICE_ID_LENGTH]int错误码索引
IVideoEncodedFrameObserver 1 方法 / 0 属性
typescript
onEncodedVideoFrameReceived(uid: rtc::uid_t, imageBuffer: const uint8_t*, length: size_t, videoEncodedFrameInfo: const rtc::EncodedVideoFrameInfo&): bool

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

方法参数返回值错误
onEncodedVideoFrameReceiveduid: rtc::uid_t, imageBuffer: const uint8_t*, length: size_t, videoEncodedFrameInfo: const rtc::EncodedVideoFrameInfo&bool错误码索引
IVideoFrameObserver 9 方法 / 0 属性
typescript
getMirrorApplied(): bool
getObservedFramePosition(): uint32_t
getRotationApplied(): bool
getVideoFormatPreference(): VIDEO_PIXEL_FORMAT
getVideoFrameProcessMode(): VIDEO_FRAME_PROCESS_MODE
onCaptureVideoFrame(sourceType: agora::rtc::VIDEO_SOURCE_TYPE, videoFrame: VideoFrame&): bool
onFrame(frame: const VideoFrame*): void
onPreEncodeVideoFrame(sourceType: agora::rtc::VIDEO_SOURCE_TYPE, videoFrame: VideoFrame&): bool
onRenderVideoFrame(channelId: const char*, remoteUid: rtc::uid_t, videoFrame: VideoFrame&): bool

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

方法参数返回值错误
getMirrorApplied—bool错误码索引
getObservedFramePosition—uint32_t错误码索引
getRotationApplied—bool错误码索引
getVideoFormatPreference—VIDEO_PIXEL_FORMAT错误码索引
getVideoFrameProcessMode—VIDEO_FRAME_PROCESS_MODE错误码索引
onCaptureVideoFramesourceType: agora::rtc::VIDEO_SOURCE_TYPE, videoFrame: VideoFrame&bool错误码索引
onFrameframe: const VideoFrame*void错误码索引
onPreEncodeVideoFramesourceType: agora::rtc::VIDEO_SOURCE_TYPE, videoFrame: VideoFrame&bool错误码索引
onRenderVideoFramechannelId: const char*, remoteUid: rtc::uid_t, videoFrame: VideoFrame&bool错误码索引
LastmileProbeConfig 0 方法 / 4 属性
属性类型只读
probeUplinkbool否
probeDownlinkbool否
expectedUplinkBitrateunsigned int否
expectedDownlinkBitrateunsigned int否
LastmileProbeOneWayResult 0 方法 / 3 属性
属性类型只读
packetLossRateunsigned int否
jitterunsigned int否
availableBandwidthunsigned int否
LastmileProbeResult 0 方法 / 4 属性
属性类型只读
stateLASTMILE_PROBE_RESULT_STATE否
uplinkReportLastmileProbeOneWayResult否
downlinkReportLastmileProbeOneWayResult否
rttunsigned int否
LeaveChannelOptions 0 方法 / 3 属性
属性类型只读
stopAudioMixingbool否
stopAllEffectbool否
stopMicrophoneRecordingbool否
LiveStreamAdvancedFeature 0 方法 / 2 属性
属性类型只读
featureNamechar*否
openedbool否
LiveTranscoding 0 方法 / 23 属性
属性类型只读
widthint否
heightint否
videoBitrateint否
videoFrameRateunknown否
lowLatencybool否
videoGopint否
videoCodecProfileVIDEO_CODEC_PROFILE_TYPE否
videoCodecTypeVIDEO_CODEC_TYPE_FOR_STREAM否
transcodingUsersTranscodingUser*否
transcodingExtraInfochar*否
backgroundColorunsigned int否
userCountunsigned int否
metadatachar*否
watermarkRtcImage*否
backgroundImageRtcImage*否
audioSampleRateAUDIO_SAMPLE_RATE_TYPE否
audioBitrateint否
audioChannelsint否
audioCodecProfileAUDIO_CODEC_PROFILE_TYPE否
watermarkCountunsigned int否
backgroundImageCountunsigned int否
advancedFeaturesLiveStreamAdvancedFeature*否
advancedFeatureCountunsigned int否
LocalAccessPointConfiguration 0 方法 / 7 属性
属性类型只读
ipListchar**否
ipListSizeint否
domainListchar**否
domainListSizeint否
verifyDomainNamechar*否
modeLOCAL_PROXY_MODE否
advancedConfigAdvancedConfigInfo否
LocalAudioMixerConfiguration 0 方法 / 3 属性
属性类型只读
streamCountunsigned int否
audioInputStreamsMixedAudioStream*否
syncWithLocalMicbool否
LocalAudioStats 0 方法 / 8 属性
属性类型只读
numChannelsint否
sentSampleRateint否
sentBitrateint否
txPacketLossRateunsigned short否
internalCodecint否
audioDeviceDelayint否
earMonitorDelayint否
aecEstimatedDelayint否
LocalSpatialAudioConfig 0 方法 / 1 属性
属性类型只读
rtcEngineagora::rtc::IRtcEngine*否
LocalTranscoderConfiguration 0 方法 / 3 属性
属性类型只读
streamCountunsigned int否
videoInputStreamsTranscodingVideoStream*否
videoOutputConfigurationVideoEncoderConfiguration否
LocalVideoStats 0 方法 / 22 属性
属性类型只读
uiduid_t否
sentBitrateint否
sentFrameRateint否
captureFrameRateint否
captureFrameWidthint否
captureFrameHeightint否
regulatedCaptureFrameRateint否
regulatedCaptureFrameWidthint否
regulatedCaptureFrameHeightint否
encoderOutputFrameRateint否
rendererOutputFrameRateint否
targetBitrateint否
targetFrameRateint否
qualityAdaptIndicationQUALITY_ADAPT_INDICATION否
encodedBitrateint否
encodedFrameHeightint否
encodedFrameWidthint否
encodedFrameCountint否
codecTypeVIDEO_CODEC_TYPE否
txPacketLossRateunsigned short否
captureBrightnessLevelCAPTURE_BRIGHTNESS_LEVEL_TYPE否
hwEncoderAcceleratingint否
LogConfig 0 方法 / 3 属性
属性类型只读
filePathchar*否
fileSizeInKBuint32_t否
levelLOG_LEVEL否
LogUploadServerInfo 0 方法 / 4 属性
属性类型只读
serverDomainchar*否
serverPathchar*否
serverPortint否
serverHttpsbool否
LowlightEnhanceOptions 0 方法 / 2 属性
属性类型只读
levelLOW_LIGHT_ENHANCE_LEVEL否
modeLOW_LIGHT_ENHANCE_MODE否
MediaRecorderConfiguration 0 方法 / 11 属性
属性类型只读
storagePathchar*否
containerFormatMediaRecorderContainerFormat否
streamTypeMediaRecorderStreamType否
maxDurationMsint否
recorderInfoUpdateIntervalint否
widthint否
heightint否
fpsint否
sample_rateint否
channel_numint否
videoSourceTypeagora::rtc::VIDEO_SOURCE_TYPE否
MediaSource 0 方法 / 9 属性
属性类型只读
urlchar*否
urichar*否
startPosint64_t否
autoPlaybool否
enableCachebool否
enableMultiAudioTrackbool否
isAgoraSourceOptional否
isLiveSourceOptional否
providerIMediaPlayerCustomDataProvider*否
Metadata 0 方法 / 5 属性
属性类型只读
channelIdchar*否
uidunsigned int否
sizeunsigned int否
bufferunknown否
timeStampMslong long否
MixedAudioStream 0 方法 / 4 属性
属性类型只读
sourceTypeAUDIO_SOURCE_TYPE否
remoteUserUiduid_t否
channelIdchar*否
trackIdtrack_id_t否
Music 0 方法 / 12 属性
属性类型只读
songCodeint64_t否
namechar*否
singerchar*否
posterchar*否
releaseTimechar*否
typeint32_t否
pitchTypeint32_t否
durationSint32_t否
lyricListint32_t*否
climaxSegmentListClimaxSegment*否
lyricCountint32_t否
climaxSegmentCountint32_t否
MusicCacheInfo 0 方法 / 2 属性
属性类型只读
songCodeint64_t否
statusMUSIC_CACHE_STATUS_TYPE否
MusicChartCollection 0 方法 / 2 属性
属性类型只读
getCountunknown否
getunknown否
MusicChartInfo 0 方法 / 2 属性
属性类型只读
chartNameunknown否
idunknown否
MusicCollection 0 方法 / 5 属性
属性类型只读
getCountunknown否
getTotalunknown否
getPageunknown否
getPageSizeunknown否
getMusicunknown否
MusicContentCenterConfiguration 0 方法 / 5 属性
属性类型只读
appIdunknown否
tokenunknown否
mccUidint64_t否
eventHandlerIMusicContentCenterEventHandler*否
maxCacheSizeint32_t否
Packet 0 方法 / 2 属性
属性类型只读
bufferunsigned char*否
sizeunsigned int否
PlayerPlaybackStats 0 方法 / 4 属性
属性类型只读
videoFpsint否
videoBitrateInKbpsint否
audioBitrateInKbpsint否
totalBitrateInKbpsint否
PlayerStreamInfo 0 方法 / 13 属性
属性类型只读
streamIndexint否
streamTypeMEDIA_STREAM_TYPE否
codecNamechar否
languagechar否
videoFrameRateint否
videoBitRateint否
videoWidthint否
videoHeightint否
videoRotationint否
audioSampleRateint否
audioChannelsint否
audioBitsPerSampleint否
durationint64_t否
PlayerUpdatedInfo 0 方法 / 6 属性
属性类型只读
deviceIdchar*否
videoHeightint否
videoWidthint否
audioSampleRateint否
audioChannelsint否
audioBitsPerSampleint否
RecorderInfo 0 方法 / 3 属性
属性类型只读
fileNamechar*否
durationMsunsigned int否
fileSizeunsigned int否
RecorderStreamInfo 0 方法 / 3 属性
属性类型只读
channelIdchar*否
uiduid_t否
typeRecorderStreamType否
Rectangle 0 方法 / 4 属性
属性类型只读
xint否
yint否
widthint否
heightint否
RemoteAudioStats 0 方法 / 16 属性
属性类型只读
uiduid_t否
qualityint否
networkTransportDelayint否
jitterBufferDelayint否
audioLossRateint否
numChannelsint否
receivedSampleRateint否
receivedBitrateint否
totalFrozenTimeint否
frozenRateint否
totalActiveTimeint否
publishDurationint否
qoeQualityint否
qualityChangedReasonint否
mosValueint否
e2eDelayint否
RemoteVideoStats 0 方法 / 16 属性
属性类型只读
uiduid_t否
delayint否
e2eDelayint否
widthint否
heightint否
receivedBitrateint否
decoderOutputFrameRateint否
rendererOutputFrameRateint否
frameLossRateint否
packetLossRateint否
rxStreamTypeVIDEO_STREAM_TYPE否
totalFrozenTimeint否
frozenRateint否
totalActiveTimeint否
publishDurationint否
avSyncTimeMsint否
RemoteVoicePositionInfo 0 方法 / 2 属性
属性类型只读
positionfloat否
forwardfloat否
RtcConnection 0 方法 / 2 属性
属性类型只读
channelIdchar*否
localUiduid_t否
RtcEngineContext 0 方法 / 9 属性
属性类型只读
eventHandlerIRtcEngineEventHandler*否
appIdchar*否
contextvoid*否
channelProfileCHANNEL_PROFILE_TYPE否
audioScenarioAUDIO_SCENARIO_TYPE否
areaCodeunsigned int否
logConfigcommons::LogConfig否
domainLimitbool否
autoRegisterAgoraExtensionsbool否
RtcImage 0 方法 / 7 属性
属性类型只读
urlchar*否
xint否
yint否
widthint否
heightint否
zOrderint否
alphadouble否
RtcStats 0 方法 / 24 属性
属性类型只读
durationunsigned int否
txBytesunsigned int否
rxBytesunsigned int否
txAudioBytesunsigned int否
txVideoBytesunsigned int否
rxAudioBytesunsigned int否
rxVideoBytesunsigned int否
txKBitRateunsigned short否
rxKBitRateunsigned short否
rxAudioKBitRateunsigned short否
txAudioKBitRateunsigned short否
rxVideoKBitRateunsigned short否
txVideoKBitRateunsigned short否
lastmileDelayunsigned short否
txPacketLossRateint否
rxPacketLossRateint否
userCountunsigned int否
cpuAppUsagedouble否
cpuTotalUsagedouble否
connectTimeMsint否
gatewayRttint否
memoryAppUsageRatiodouble否
memoryTotalUsageRatiodouble否
memoryAppUsageInKbytesint否
ScreenAudioParameters 0 方法 / 3 属性
属性类型只读
sampleRateint否
channelsint否
captureSignalVolumeint否
ScreenCaptureConfiguration 0 方法 / 6 属性
属性类型只读
isCaptureWindowbool否
displayIdint64_t否
screenRectRectangle否
windowIdint64_t否
paramsScreenCaptureParameters否
regionRectRectangle否
ScreenCaptureParameters 0 方法 / 10 属性
属性类型只读
dimensionsVideoDimensions否
frameRateint否
bitrateint否
captureMouseCursorbool否
windowFocusbool否
excludeWindowListunknown否
enableHighLightbool否
highLightColorunsigned int否
highLightWidthint否
excludeWindowCountint否
ScreenCaptureParameters2 0 方法 / 4 属性
属性类型只读
captureAudiobool否
audioParamsScreenAudioParameters否
captureVideobool否
videoParamsScreenVideoParameters否
ScreenCaptureSourceInfo 0 方法 / 11 属性
属性类型只读
typeScreenCaptureSourceType否
sourceIdint64_t否
sourceNamechar*否
thumbImageThumbImageBuffer否
iconImageThumbImageBuffer否
processPathchar*否
sourceTitlechar*否
primaryMonitorbool否
positionRectangle否
minimizeWindowunknown否
sourceDisplayIdint64_t否
ScreenVideoParameters 0 方法 / 4 属性
属性类型只读
dimensionsVideoDimensions否
frameRateint否
bitrateint否
contentHintVIDEO_CONTENT_HINT否
SegmentationProperty 0 方法 / 2 属性
属性类型只读
modelTypeSEG_MODEL_TYPE否
greenCapacityfloat否
SimulcastStreamConfig 0 方法 / 3 属性
属性类型只读
dimensionsVideoDimensions否
kBitrateint否
framerateint否
SnapshotConfig 0 方法 / 2 属性
属性类型只读
filePathchar*否
positionmedia::base::VIDEO_MODULE_POSITION否
SpatialAudioParams 0 方法 / 8 属性
属性类型只读
speaker_azimuthOptional否
speaker_elevationOptional否
speaker_distanceOptional否
speaker_orientationOptional否
enable_blurOptional否
enable_air_absorbOptional否
speaker_attenuationOptional否
enable_dopplerOptional否
SpatialAudioZone 0 方法 / 9 属性
属性类型只读
zoneSetIdint否
positionfloat否
forwardfloat否
rightfloat否
upfloat否
forwardLengthfloat否
rightLengthfloat否
upLengthfloat否
audioAttenuationfloat否
SrcInfo 0 方法 / 2 属性
属性类型只读
bitrateInKbpsint否
namechar*否
ThumbImageBuffer 0 方法 / 4 属性
属性类型只读
bufferchar*否
lengthunsigned int否
widthunsigned int否
heightunsigned int否
TranscodingUser 0 方法 / 8 属性
属性类型只读
uidunknown否
xunknown否
yunknown否
widthunknown否
heightunknown否
zOrderunknown否
alphaunknown否
audioChannelunknown否
TranscodingVideoStream 0 方法 / 11 属性
属性类型只读
sourceTypeVIDEO_SOURCE_TYPE否
remoteUserUiduid_t否
imageUrlchar*否
mediaPlayerIdint否
xint否
yint否
widthint否
heightint否
zOrderint否
alphadouble否
mirrorbool否
UplinkNetworkInfo 0 方法 / 1 属性
属性类型只读
video_encoder_target_bitrate_bpsint否
UserAudioSpectrumInfo 0 方法 / 2 属性
属性类型只读
uidagora::rtc::uid_t否
spectrumDatastruct AudioSpectrumData否
UserInfo 0 方法 / 2 属性
属性类型只读
uiduid_t否
userAccountchar否
VideoCanvas 1 方法 / 7 属性
typescript
view(): unknown

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

方法参数返回值错误
view—unknown错误码索引
属性类型只读
uiduid_t否
subviewUiduid_t否
sourceTypeVIDEO_SOURCE_TYPE否
mediaPlayerIdint否
backgroundColoruint32_t否
enableAlphaMaskbool否
positionmedia::base::VIDEO_MODULE_POSITION否
VideoDenoiserOptions 0 方法 / 2 属性
属性类型只读
levelVIDEO_DENOISER_LEVEL否
modeVIDEO_DENOISER_MODE否
VideoDimensions 0 方法 / 2 属性
属性类型只读
widthint否
heightint否
VideoEncoderConfiguration 0 方法 / 9 属性
属性类型只读
dimensionsVideoDimensions否
codecTypeVIDEO_CODEC_TYPE否
frameRateint否
bitrateint否
minBitrateint否
orientationModeORIENTATION_MODE否
degradationPreferenceDEGRADATION_PREFERENCE否
mirrorModeVIDEO_MIRROR_MODE_TYPE否
advanceOptionsAdvanceOptions否
VideoFormat 0 方法 / 3 属性
属性类型只读
widthint否
heightint否
fpsint否
VideoFrame 0 方法 / 22 属性
属性类型只读
typeVIDEO_PIXEL_FORMAT否
widthint否
heightint否
yStrideint否
uStrideint否
vStrideint否
yBufferuint8_t*否
uBufferuint8_t*否
vBufferuint8_t*否
rotationint否
renderTimeMsint64_t否
avsync_typeint否
metadata_bufferuint8_t*否
metadata_sizeint否
sharedContextvoid*否
textureIdint否
d3d11Texture2dvoid*否
matrixfloat否
colorSpaceColorSpace否
alphaBufferuint8_t*否
alphaStitchModeALPHA_STITCH_MODE否
metaInfoIVideoFrameMetaInfo*否
VideoLayout 0 方法 / 8 属性
属性类型只读
channelIdchar*否
uidrtc::uid_t否
strUiduser_id_t否
xuint32_t否
yuint32_t否
widthuint32_t否
heightuint32_t否
videoStateuint32_t否
VideoRenderingTracingInfo 0 方法 / 7 属性
属性类型只读
elapsedTimeint否
start2JoinChannelint否
join2JoinSuccessint否
joinSuccess2RemoteJoinedint否
remoteJoined2SetViewint否
remoteJoined2UnmuteVideoint否
remoteJoined2PacketReceivedint否
VideoSubscriptionOptions 0 方法 / 2 属性
属性类型只读
typeOptional否
encodedFrameOnlyOptional否
VirtualBackgroundSource 0 方法 / 4 属性
属性类型只读
background_source_typeBACKGROUND_SOURCE_TYPE否
colorunsigned int否
sourcechar*否
blur_degreeBACKGROUND_BLUR_DEGREE否
WatermarkOptions 0 方法 / 5 属性
属性类型只读
visibleInPreviewbool否
positionInLandscapeModeRectangle否
positionInPortraitModeRectangle否
watermarkRatioWatermarkRatio否
modeWATERMARK_FIT_MODE否
WatermarkRatio 0 方法 / 3 属性
属性类型只读
xRatiofloat否
yRatiofloat否
widthRatiofloat否

枚举

枚举成员数示例值
ALPHA_STITCH_MODE5NO_ALPHA_STITCH = 0
AREA_CODE7AREA_CODE_CN = null
AUDIENCE_LATENCY_LEVEL_TYPE2AUDIENCE_LATENCY_LEVEL_LOW_LATENCY = 1
AUDIO_AINS_MODE3AINS_MODE_BALANCED = 0
AUDIO_CODEC_PROFILE_TYPE3AUDIO_CODEC_PROFILE_LC_AAC = 0
AUDIO_CODEC_TYPE8AUDIO_CODEC_OPUS = 1
AUDIO_DUAL_MONO_MODE4AUDIO_DUAL_MONO_STEREO = 0
AUDIO_EFFECT_PRESET21AUDIO_EFFECT_OFF = null
AUDIO_ENCODED_FRAME_OBSERVER_POSITION3AUDIO_ENCODED_FRAME_OBSERVER_POSITION_RECORD = 1
AUDIO_ENCODING_TYPE11AUDIO_ENCODING_TYPE_AAC_16000_LOW = null
AUDIO_EQUALIZATION_BAND_FREQUENCY10AUDIO_EQUALIZATION_BAND_31 = 0
AUDIO_FILE_RECORDING_TYPE3AUDIO_FILE_RECORDING_MIC = 1
AUDIO_FRAME_TYPE1FRAME_TYPE_PCM16 = 0
AUDIO_MIXING_DUAL_MONO_MODE4AUDIO_MIXING_DUAL_MONO_AUTO = 0
AUDIO_MIXING_REASON_TYPE7AUDIO_MIXING_REASON_OK = 0
AUDIO_MIXING_STATE_TYPE4AUDIO_MIXING_STATE_PLAYING = 710
AUDIO_PROCESSING_CHANNELS2AUDIO_PROCESSING_MONO = 1
AUDIO_PROFILE_TYPE8AUDIO_PROFILE_DEFAULT = 0
AUDIO_RECORDING_QUALITY_TYPE4AUDIO_RECORDING_QUALITY_LOW = 0
AUDIO_REVERB_PRESET9AUDIO_REVERB_OFF = null
AUDIO_REVERB_TYPE5AUDIO_REVERB_DRY_LEVEL = 0
AUDIO_SAMPLE_RATE_TYPE3AUDIO_SAMPLE_RATE_32000 = 32000
AUDIO_SCENARIO_TYPE7AUDIO_SCENARIO_DEFAULT = 0
AUDIO_SESSION_OPERATION_RESTRICTION5AUDIO_SESSION_OPERATION_RESTRICTION_NONE = null
AUDIO_SOURCE_TYPE7AUDIO_SOURCE_MICROPHONE = 0
AUDIO_TRACK_TYPE2AUDIO_TRACK_MIXABLE = 0
AudioRoute12ROUTE_DEFAULT = -1
BACKGROUND_BLUR_DEGREE3BLUR_DEGREE_LOW = 1
BACKGROUND_SOURCE_TYPE4BACKGROUND_COLOR = 1
CAMERA_DIRECTION2CAMERA_REAR = 0
CAMERA_FOCAL_LENGTH_TYPE4CAMERA_FOCAL_LENGTH_DEFAULT = 0
CAMERA_STABILIZATION_MODE5CAMERA_STABILIZATION_MODE_OFF = -1
CAPTURE_BRIGHTNESS_LEVEL_TYPE4CAPTURE_BRIGHTNESS_LEVEL_INVALID = -1
CHANNEL_MEDIA_RELAY_ERROR12RELAY_OK = 0
CHANNEL_MEDIA_RELAY_STATE4RELAY_STATE_IDLE = 0
CHANNEL_PROFILE_TYPE4CHANNEL_PROFILE_COMMUNICATION = 0
CLIENT_ROLE_CHANGE_FAILED_REASON4CLIENT_ROLE_CHANGE_FAILED_TOO_MANY_BROADCASTERS = 1
CLIENT_ROLE_TYPE2CLIENT_ROLE_BROADCASTER = 1
CLOUD_PROXY_TYPE3NONE_PROXY = 0
CODEC_CAP_MASK5CODEC_CAP_MASK_NONE = 0
COMPRESSION_PREFERENCE3PREFER_COMPRESSION_AUTO = -1
CONNECTION_CHANGED_REASON_TYPE21CONNECTION_CHANGED_CONNECTING = 0
CONNECTION_STATE_TYPE5CONNECTION_STATE_DISCONNECTED = 1
CONTENT_INSPECT_TYPE3CONTENT_INSPECT_INVALID = 0
DEGRADATION_PREFERENCE5MAINTAIN_AUTO = -1
DIRECT_CDN_STREAMING_REASON6DIRECT_CDN_STREAMING_REASON_OK = 0
DIRECT_CDN_STREAMING_STATE5DIRECT_CDN_STREAMING_STATE_IDLE = 0
EAR_MONITORING_FILTER_TYPE4EAR_MONITORING_FILTER_NONE = null
ENCODING_PREFERENCE3PREFER_AUTO = -1
ENCRYPTION_ERROR_TYPE5ENCRYPTION_ERROR_INTERNAL_FAILURE = 0
ENCRYPTION_MODE9AES_128_XTS = 1
ERROR_CODE_TYPE46ERR_OK = 0
EXPERIENCE_POOR_REASON5EXPERIENCE_REASON_NONE = 0
EXPERIENCE_QUALITY_TYPE2EXPERIENCE_QUALITY_GOOD = 0
EXTERNAL_VIDEO_SOURCE_TYPE2VIDEO_FRAME = 0
FACE_SHAPE_AREA13FACE_SHAPE_AREA_NONE = -1
FACE_SHAPE_BEAUTY_STYLE2FACE_SHAPE_BEAUTY_STYLE_FEMALE = 0
FeatureType2VIDEO_VIRTUAL_BACKGROUND = 1
FRAME_RATE7FRAME_RATE_FPS_1 = 1
HEADPHONE_EQUALIZER_PRESET3HEADPHONE_EQUALIZER_OFF = null
INTERFACE_ID_TYPE7AGORA_IID_AUDIO_DEVICE_MANAGER = 1
LASTMILE_PROBE_RESULT_STATE3LASTMILE_PROBE_RESULT_COMPLETE = 1
LIGHTENING_CONTRAST_LEVEL3LIGHTENING_CONTRAST_LOW = 0
LOCAL_AUDIO_STREAM_REASON11LOCAL_AUDIO_STREAM_REASON_OK = 0
LOCAL_AUDIO_STREAM_STATE4LOCAL_AUDIO_STREAM_STATE_STOPPED = 0
LOCAL_PROXY_MODE2ConnectivityFirst = 0
LOCAL_VIDEO_STREAM_REASON26LOCAL_VIDEO_STREAM_REASON_OK = 0
LOCAL_VIDEO_STREAM_STATE4LOCAL_VIDEO_STREAM_STATE_STOPPED = 0
LOG_FILTER_TYPE6LOG_FILTER_OFF = 0
LOG_LEVEL5LOG_LEVEL_NONE = 0
LOW_LIGHT_ENHANCE_LEVEL2LOW_LIGHT_ENHANCE_LEVEL_HIGH_QUALITY = 0
LOW_LIGHT_ENHANCE_MODE2LOW_LIGHT_ENHANCE_AUTO = 0
MAX_DEVICE_ID_LENGTH_TYPE1MAX_DEVICE_ID_LENGTH = null
MAX_USER_ACCOUNT_LENGTH_TYPE1MAX_USER_ACCOUNT_LENGTH = null
MEDIA_DEVICE_STATE_TYPE6MEDIA_DEVICE_STATE_IDLE = 0
MEDIA_DEVICE_TYPE8UNKNOWN_AUDIO_DEVICE = -1
MEDIA_PLAYER_EVENT14PLAYER_EVENT_SEEK_BEGIN = 0
MEDIA_PLAYER_METADATA_TYPE2PLAYER_METADATA_TYPE_UNKNOWN = 0
MEDIA_PLAYER_REASON16PLAYER_REASON_NONE = 0
MEDIA_PLAYER_STATE9PLAYER_STATE_IDLE = 0
MEDIA_SOURCE_TYPE6AUDIO_PLAYOUT_SOURCE = 0
MEDIA_STREAM_TYPE4STREAM_TYPE_UNKNOWN = 0
MEDIA_TRACE_EVENT2MEDIA_TRACE_EVENT_VIDEO_RENDERED = 0
MediaRecorderContainerFormat1FORMAT_MP4 = 1
MediaRecorderStreamType3STREAM_TYPE_AUDIO = null
METADATA_TYPE2UNKNOWN_METADATA = null
MUSIC_CACHE_STATUS_TYPE2MUSIC_CACHE_STATUS_TYPE_CACHED = 0
MusicContentCenterStateReason8kMusicContentCenterReasonOk = 0
MusicPlayMode3kMusicPlayModeOriginal = 0
NETWORK_TYPE8NETWORK_TYPE_UNKNOWN = -1
ORIENTATION_MODE3ORIENTATION_MODE_ADAPTIVE = 0
PERMISSION_TYPE3RECORD_AUDIO = 0
PLAYER_PRELOAD_EVENT3PLAYER_PRELOAD_EVENT_BEGIN = 0
PreloadState4kPreloadStateCompleted = 0
PROXY_TYPE5NONE_PROXY_TYPE = 0
QUALITY_ADAPT_INDICATION3ADAPT_NONE = 0
QUALITY_TYPE8QUALITY_UNKNOWN = 0
RAW_AUDIO_FRAME_OP_MODE_TYPE2RAW_AUDIO_FRAME_OP_MODE_READ_ONLY = 0
RecorderReasonCode5RECORDER_REASON_NONE = 0
RecorderState3RECORDER_STATE_ERROR = -1
RecorderStreamType2RTC = 0
REMOTE_AUDIO_STATE5REMOTE_AUDIO_STATE_STOPPED = 0
REMOTE_AUDIO_STATE_REASON8REMOTE_AUDIO_REASON_INTERNAL = 0
REMOTE_VIDEO_STATE5REMOTE_VIDEO_STATE_STOPPED = 0
REMOTE_VIDEO_STATE_REASON12REMOTE_VIDEO_STATE_REASON_INTERNAL = 0
RENDER_MODE_TYPE3RENDER_MODE_HIDDEN = 1
RHYTHM_PLAYER_REASON5RHYTHM_PLAYER_REASON_OK = 0
RHYTHM_PLAYER_STATE_TYPE5RHYTHM_PLAYER_STATE_IDLE = 810
RTMP_STREAM_LIFE_CYCLE_TYPE2RTMP_STREAM_LIFE_CYCLE_BIND2CHANNEL = null
RTMP_STREAM_PUBLISH_REASON15RTMP_STREAM_PUBLISH_REASON_OK = 0
RTMP_STREAM_PUBLISH_STATE6RTMP_STREAM_PUBLISH_STATE_IDLE = 0
RTMP_STREAMING_EVENT4RTMP_STREAMING_EVENT_FAILED_LOAD_IMAGE = 1
SCREEN_CAPTURE_FRAMERATE_CAPABILITY3SCREEN_CAPTURE_FRAMERATE_CAPABILITY_15_FPS = 0
SCREEN_SCENARIO_TYPE4SCREEN_SCENARIO_DOCUMENT = 1
ScreenCaptureSourceType4ScreenCaptureSourceType_Unknown = -1
SEG_MODEL_TYPE2SEG_MODEL_AI = 1
SIMULCAST_STREAM_MODE3AUTO_SIMULCAST_STREAM = -1
STREAM_FALLBACK_OPTIONS3STREAM_FALLBACK_OPTION_DISABLED = 0
STREAM_PUBLISH_STATE4PUB_STATE_IDLE = 0
STREAM_SUBSCRIBE_STATE4SUB_STATE_IDLE = 0
USER_OFFLINE_REASON_TYPE3USER_OFFLINE_QUIT = 0
VIDEO_APPLICATION_SCENARIO_TYPE4APPLICATION_SCENARIO_GENERAL = 0
VIDEO_BUFFER_TYPE3VIDEO_BUFFER_RAW_DATA = 1
VIDEO_CODEC_CAPABILITY_LEVEL5CODEC_CAPABILITY_LEVEL_UNSPECIFIED = -1
VIDEO_CODEC_PROFILE_TYPE3VIDEO_CODEC_PROFILE_BASELINE = 66
VIDEO_CODEC_TYPE6VIDEO_CODEC_NONE = 0
VIDEO_CODEC_TYPE_FOR_STREAM2VIDEO_CODEC_H264_FOR_STREAM = 1
VIDEO_CONTENT_HINT3CONTENT_HINT_NONE = null
VIDEO_DENOISER_LEVEL2VIDEO_DENOISER_LEVEL_HIGH_QUALITY = 0
VIDEO_DENOISER_MODE2VIDEO_DENOISER_AUTO = 0
VIDEO_FRAME_PROCESS_MODE2PROCESS_MODE_READ_ONLY = null
VIDEO_FRAME_TYPE6VIDEO_FRAME_TYPE_BLANK_FRAME = 0
VIDEO_MIRROR_MODE_TYPE3VIDEO_MIRROR_MODE_AUTO = 0
VIDEO_MODULE_POSITION4POSITION_POST_CAPTURER = 1
VIDEO_ORIENTATION4VIDEO_ORIENTATION_0 = 0
VIDEO_PIXEL_FORMAT5VIDEO_PIXEL_DEFAULT = 0
VIDEO_PROFILE_TYPE63VIDEO_PROFILE_LANDSCAPE_120P = 0
VIDEO_SOURCE_TYPE18VIDEO_SOURCE_CAMERA_PRIMARY = 0
VIDEO_STREAM_TYPE2VIDEO_STREAM_HIGH = 0
VIDEO_TRANSCODER_ERROR6VT_ERR_VIDEO_SOURCE_NOT_READY = 1
VIDEO_VIEW_SETUP_MODE3VIDEO_VIEW_SETUP_REPLACE = 0
VOICE_AI_TUNER_TYPE10VOICE_AI_TUNER_MATURE_MALE = 0
VOICE_BEAUTIFIER_PRESET14VOICE_BEAUTIFIER_OFF = null
VOICE_CONVERSION_PRESET5VOICE_CONVERSION_OFF = null
WATERMARK_FIT_MODE2FIT_MODE_COVER_POSITION = null
ALPHA_STITCH_MODE 5 个成员
成员值
NO_ALPHA_STITCH0
ALPHA_STITCH_UP1
ALPHA_STITCH_BELOW2
ALPHA_STITCH_LEFT3
ALPHA_STITCH_RIGHT4
AREA_CODE 7 个成员
成员值
AREA_CODE_CNnull
AREA_CODE_NAnull
AREA_CODE_EUnull
AREA_CODE_ASnull
AREA_CODE_JPnull
AREA_CODE_INnull
AREA_CODE_GLOBnull
AUDIENCE_LATENCY_LEVEL_TYPE 2 个成员
成员值
AUDIENCE_LATENCY_LEVEL_LOW_LATENCY1
AUDIENCE_LATENCY_LEVEL_ULTRA_LOW_LATENCY2
AUDIO_AINS_MODE 3 个成员
成员值
AINS_MODE_BALANCED0
AINS_MODE_AGGRESSIVE1
AINS_MODE_ULTRALOWLATENCY2
AUDIO_CODEC_PROFILE_TYPE 3 个成员
成员值
AUDIO_CODEC_PROFILE_LC_AAC0
AUDIO_CODEC_PROFILE_HE_AAC1
HE_AAC_V22
AUDIO_CODEC_TYPE 8 个成员
成员值
AUDIO_CODEC_OPUS1
AUDIO_CODEC_PCMA3
AUDIO_CODEC_PCMU4
AUDIO_CODEC_G7225
AUDIO_CODEC_AACLC8
AUDIO_CODEC_HEAAC9
AUDIO_CODEC_JC110
AUDIO_CODEC_HEAAC211
AUDIO_DUAL_MONO_MODE 4 个成员
成员值
AUDIO_DUAL_MONO_STEREO0
AUDIO_DUAL_MONO_L1
AUDIO_DUAL_MONO_R2
AUDIO_DUAL_MONO_MIX3
AUDIO_EFFECT_PRESET 21 个成员
成员值
AUDIO_EFFECT_OFFnull
ROOM_ACOUSTICS_KTVnull
ROOM_ACOUSTICS_VOCAL_CONCERTnull
ROOM_ACOUSTICS_STUDIOnull
ROOM_ACOUSTICS_PHONOGRAPHnull
ROOM_ACOUSTICS_VIRTUAL_STEREOnull
ROOM_ACOUSTICS_SPACIALnull
ROOM_ACOUSTICS_ETHEREALnull
ROOM_ACOUSTICS_VIRTUAL_SURROUND_SOUNDnull
ROOM_ACOUSTICS_CHORUSnull
ROOM_ACOUSTICS_3D_VOICEnull
VOICE_CHANGER_EFFECT_UNCLEnull
VOICE_CHANGER_EFFECT_OLDMANnull
VOICE_CHANGER_EFFECT_BOYnull
VOICE_CHANGER_EFFECT_SISTERnull
VOICE_CHANGER_EFFECT_GIRLnull
VOICE_CHANGER_EFFECT_PIGKINGnull
VOICE_CHANGER_EFFECT_HULKnull
STYLE_TRANSFORMATION_RNBnull
STYLE_TRANSFORMATION_POPULARnull
PITCH_CORRECTIONnull
AUDIO_ENCODED_FRAME_OBSERVER_POSITION 3 个成员
成员值
AUDIO_ENCODED_FRAME_OBSERVER_POSITION_RECORD1
AUDIO_ENCODED_FRAME_OBSERVER_POSITION_PLAYBACK2
AUDIO_ENCODED_FRAME_OBSERVER_POSITION_MIXED3
AUDIO_ENCODING_TYPE 11 个成员
成员值
AUDIO_ENCODING_TYPE_AAC_16000_LOWnull
AUDIO_ENCODING_TYPE_AAC_16000_MEDIUMnull
AUDIO_ENCODING_TYPE_AAC_32000_LOWnull
AUDIO_ENCODING_TYPE_AAC_32000_MEDIUMnull
AUDIO_ENCODING_TYPE_AAC_32000_HIGHnull
AUDIO_ENCODING_TYPE_AAC_48000_MEDIUMnull
AUDIO_ENCODING_TYPE_AAC_48000_HIGHnull
AUDIO_ENCODING_TYPE_OPUS_16000_LOWnull
AUDIO_ENCODING_TYPE_OPUS_16000_MEDIUMnull
AUDIO_ENCODING_TYPE_OPUS_48000_MEDIUMnull
AUDIO_ENCODING_TYPE_OPUS_48000_HIGHnull
AUDIO_EQUALIZATION_BAND_FREQUENCY 10 个成员
成员值
AUDIO_EQUALIZATION_BAND_310
AUDIO_EQUALIZATION_BAND_621
AUDIO_EQUALIZATION_BAND_1252
AUDIO_EQUALIZATION_BAND_2503
AUDIO_EQUALIZATION_BAND_5004
AUDIO_EQUALIZATION_BAND_1K5
AUDIO_EQUALIZATION_BAND_2K6
AUDIO_EQUALIZATION_BAND_4K7
AUDIO_EQUALIZATION_BAND_8K8
AUDIO_EQUALIZATION_BAND_16K9
AUDIO_FILE_RECORDING_TYPE 3 个成员
成员值
AUDIO_FILE_RECORDING_MIC1
AUDIO_FILE_RECORDING_PLAYBACK2
AUDIO_FILE_RECORDING_MIXED3
AUDIO_FRAME_TYPE 1 个成员
成员值
FRAME_TYPE_PCM160
AUDIO_MIXING_DUAL_MONO_MODE 4 个成员
成员值
AUDIO_MIXING_DUAL_MONO_AUTO0
AUDIO_MIXING_DUAL_MONO_L1
AUDIO_MIXING_DUAL_MONO_R2
AUDIO_MIXING_DUAL_MONO_MIX3
AUDIO_MIXING_REASON_TYPE 7 个成员
成员值
AUDIO_MIXING_REASON_OK0
AUDIO_MIXING_REASON_CAN_NOT_OPEN701
AUDIO_MIXING_REASON_TOO_FREQUENT_CALL702
AUDIO_MIXING_REASON_INTERRUPTED_EOF703
AUDIO_MIXING_REASON_ONE_LOOP_COMPLETED721
AUDIO_MIXING_REASON_ALL_LOOPS_COMPLETED723
AUDIO_MIXING_REASON_STOPPED_BY_USER724
AUDIO_MIXING_STATE_TYPE 4 个成员
成员值
AUDIO_MIXING_STATE_PLAYING710
AUDIO_MIXING_STATE_PAUSED711
AUDIO_MIXING_STATE_STOPPED713
AUDIO_MIXING_STATE_FAILED714
AUDIO_PROCESSING_CHANNELS 2 个成员
成员值
AUDIO_PROCESSING_MONO1
AUDIO_PROCESSING_STEREO2
AUDIO_PROFILE_TYPE 8 个成员
成员值
AUDIO_PROFILE_DEFAULT0
AUDIO_PROFILE_SPEECH_STANDARD1
AUDIO_PROFILE_MUSIC_STANDARD2
AUDIO_PROFILE_MUSIC_STANDARD_STEREO3
AUDIO_PROFILE_MUSIC_HIGH_QUALITY4
AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO5
AUDIO_PROFILE_IOT6
AUDIO_PROFILE_NUMnull
AUDIO_RECORDING_QUALITY_TYPE 4 个成员
成员值
AUDIO_RECORDING_QUALITY_LOW0
AUDIO_RECORDING_QUALITY_MEDIUM1
AUDIO_RECORDING_QUALITY_HIGH2
AUDIO_RECORDING_QUALITY_ULTRA_HIGH3
AUDIO_REVERB_PRESET 9 个成员
成员值
AUDIO_REVERB_OFFnull
AUDIO_REVERB_FX_KTVnull
AUDIO_REVERB_FX_VOCAL_CONCERTnull
AUDIO_REVERB_FX_UNCLEnull
AUDIO_REVERB_FX_SISTERnull
AUDIO_REVERB_FX_STUDIOnull
AUDIO_REVERB_FX_POPULARnull
AUDIO_REVERB_FX_RNBnull
AUDIO_REVERB_FX_PHONOGRAPHnull
AUDIO_REVERB_TYPE 5 个成员
成员值
AUDIO_REVERB_DRY_LEVEL0
AUDIO_REVERB_WET_LEVEL1
AUDIO_REVERB_ROOM_SIZE2
AUDIO_REVERB_WET_DELAY3
AUDIO_REVERB_STRENGTH4
AUDIO_SAMPLE_RATE_TYPE 3 个成员
成员值
AUDIO_SAMPLE_RATE_3200032000
AUDIO_SAMPLE_RATE_4410044100
AUDIO_SAMPLE_RATE_4800048000
AUDIO_SCENARIO_TYPE 7 个成员
成员值
AUDIO_SCENARIO_DEFAULT0
AUDIO_SCENARIO_GAME_STREAMING3
AUDIO_SCENARIO_CHATROOM5
AUDIO_SCENARIO_CHORUS7
AUDIO_SCENARIO_MEETING8
AUDIO_SCENARIO_AI_CLIENT10
AUDIO_SCENARIO_NUMnull
AUDIO_SESSION_OPERATION_RESTRICTION 5 个成员
成员值
AUDIO_SESSION_OPERATION_RESTRICTION_NONEnull
AUDIO_SESSION_OPERATION_RESTRICTION_SET_CATEGORYnull
AUDIO_SESSION_OPERATION_RESTRICTION_CONFIGURE_SESSIONnull
AUDIO_SESSION_OPERATION_RESTRICTION_DEACTIVATE_SESSIONnull
AUDIO_SESSION_OPERATION_RESTRICTION_ALLnull
AUDIO_SOURCE_TYPE 7 个成员
成员值
AUDIO_SOURCE_MICROPHONE0
AUDIO_SOURCE_CUSTOM1
AUDIO_SOURCE_MEDIA_PLAYER2
AUDIO_SOURCE_LOOPBACK_RECORDING3
AUDIO_SOURCE_REMOTE_USER5
AUDIO_SOURCE_REMOTE_CHANNEL6
AUDIO_SOURCE_UNKNOWN100
AUDIO_TRACK_TYPE 2 个成员
成员值
AUDIO_TRACK_MIXABLE0
AUDIO_TRACK_DIRECT1
AudioRoute 12 个成员
成员值
ROUTE_DEFAULT-1
ROUTE_HEADSET0
ROUTE_EARPIECE1
ROUTE_HEADSETNOMIC2
ROUTE_SPEAKERPHONE3
ROUTE_LOUDSPEAKER4
ROUTE_BLUETOOTH_DEVICE_HFP5
ROUTE_USB6
ROUTE_HDMI7
ROUTE_DISPLAYPORT8
ROUTE_AIRPLAY9
ROUTE_BLUETOOTH_DEVICE_A2DP10
BACKGROUND_BLUR_DEGREE 3 个成员
成员值
BLUR_DEGREE_LOW1
BLUR_DEGREE_MEDIUM2
BLUR_DEGREE_HIGH3
BACKGROUND_SOURCE_TYPE 4 个成员
成员值
BACKGROUND_COLOR1
BACKGROUND_IMG2
BACKGROUND_BLUR3
BACKGROUND_VIDEO4
CAMERA_DIRECTION 2 个成员
成员值
CAMERA_REAR0
CAMERA_FRONT1
CAMERA_FOCAL_LENGTH_TYPE 4 个成员
成员值
CAMERA_FOCAL_LENGTH_DEFAULT0
CAMERA_FOCAL_LENGTH_WIDE_ANGLE1
CAMERA_FOCAL_LENGTH_ULTRA_WIDE2
CAMERA_FOCAL_LENGTH_TELEPHOTO3
CAMERA_STABILIZATION_MODE 5 个成员
成员值
CAMERA_STABILIZATION_MODE_OFF-1
CAMERA_STABILIZATION_MODE_AUTO0
CAMERA_STABILIZATION_MODE_LEVEL_11
CAMERA_STABILIZATION_MODE_LEVEL_22
CAMERA_STABILIZATION_MODE_LEVEL_33
CAPTURE_BRIGHTNESS_LEVEL_TYPE 4 个成员
成员值
CAPTURE_BRIGHTNESS_LEVEL_INVALID-1
CAPTURE_BRIGHTNESS_LEVEL_NORMAL0
CAPTURE_BRIGHTNESS_LEVEL_BRIGHT1
CAPTURE_BRIGHTNESS_LEVEL_DARK2
CHANNEL_MEDIA_RELAY_ERROR 12 个成员
成员值
RELAY_OK0
RELAY_ERROR_SERVER_ERROR_RESPONSE1
RELAY_ERROR_SERVER_NO_RESPONSE2
RELAY_ERROR_NO_RESOURCE_AVAILABLE3
RELAY_ERROR_FAILED_JOIN_SRC4
RELAY_ERROR_FAILED_JOIN_DEST5
RELAY_ERROR_FAILED_PACKET_RECEIVED_FROM_SRC6
RELAY_ERROR_FAILED_PACKET_SENT_TO_DEST7
RELAY_ERROR_SERVER_CONNECTION_LOST8
RELAY_ERROR_INTERNAL_ERROR9
RELAY_ERROR_SRC_TOKEN_EXPIRED10
RELAY_ERROR_DEST_TOKEN_EXPIRED11
CHANNEL_MEDIA_RELAY_STATE 4 个成员
成员值
RELAY_STATE_IDLE0
RELAY_STATE_CONNECTING1
RELAY_STATE_RUNNING2
RELAY_STATE_FAILURE3
CHANNEL_PROFILE_TYPE 4 个成员
成员值
CHANNEL_PROFILE_COMMUNICATION0
CHANNEL_PROFILE_LIVE_BROADCASTING1
CHANNEL_PROFILE_GAME2
CHANNEL_PROFILE_CLOUD_GAMING3
CLIENT_ROLE_CHANGE_FAILED_REASON 4 个成员
成员值
CLIENT_ROLE_CHANGE_FAILED_TOO_MANY_BROADCASTERS1
CLIENT_ROLE_CHANGE_FAILED_NOT_AUTHORIZED2
CLIENT_ROLE_CHANGE_FAILED_REQUEST_TIME_OUT3
CLIENT_ROLE_CHANGE_FAILED_CONNECTION_FAILED4
CLIENT_ROLE_TYPE 2 个成员
成员值
CLIENT_ROLE_BROADCASTER1
CLIENT_ROLE_AUDIENCE2
CLOUD_PROXY_TYPE 3 个成员
成员值
NONE_PROXY0
UDP_PROXY1
TCP_PROXY2
CODEC_CAP_MASK 5 个成员
成员值
CODEC_CAP_MASK_NONE0
CODEC_CAP_MASK_HW_DECnull
CODEC_CAP_MASK_HW_ENCnull
CODEC_CAP_MASK_SW_DECnull
CODEC_CAP_MASK_SW_ENCnull
COMPRESSION_PREFERENCE 3 个成员
成员值
PREFER_COMPRESSION_AUTO-1
PREFER_LOW_LATENCY0
PREFER_QUALITY1
CONNECTION_CHANGED_REASON_TYPE 21 个成员
成员值
CONNECTION_CHANGED_CONNECTING0
CONNECTION_CHANGED_JOIN_SUCCESS1
CONNECTION_CHANGED_INTERRUPTED2
CONNECTION_CHANGED_BANNED_BY_SERVER3
CONNECTION_CHANGED_JOIN_FAILED4
CONNECTION_CHANGED_LEAVE_CHANNEL5
CONNECTION_CHANGED_INVALID_APP_ID6
CONNECTION_CHANGED_INVALID_CHANNEL_NAME7
CONNECTION_CHANGED_INVALID_TOKEN8
CONNECTION_CHANGED_TOKEN_EXPIRED9
CONNECTION_CHANGED_REJECTED_BY_SERVER10
CONNECTION_CHANGED_SETTING_PROXY_SERVER11
CONNECTION_CHANGED_RENEW_TOKEN12
CONNECTION_CHANGED_CLIENT_IP_ADDRESS_CHANGED13
CONNECTION_CHANGED_KEEP_ALIVE_TIMEOUT14
CONNECTION_CHANGED_REJOIN_SUCCESS15
CONNECTION_CHANGED_LOST16
CONNECTION_CHANGED_ECHO_TEST17
CONNECTION_CHANGED_CLIENT_IP_ADDRESS_CHANGED_BY_USER18
CONNECTION_CHANGED_SAME_UID_LOGIN19
CONNECTION_CHANGED_TOO_MANY_BROADCASTERS20
CONNECTION_STATE_TYPE 5 个成员
成员值
CONNECTION_STATE_DISCONNECTED1
CONNECTION_STATE_CONNECTING2
CONNECTION_STATE_CONNECTED3
CONNECTION_STATE_RECONNECTING4
CONNECTION_STATE_FAILED5
CONTENT_INSPECT_TYPE 3 个成员
成员值
CONTENT_INSPECT_INVALID0
CONTENT_INSPECT_SUPERVISION2
CONTENT_INSPECT_IMAGE_MODERATION3
DEGRADATION_PREFERENCE 5 个成员
成员值
MAINTAIN_AUTO-1
MAINTAIN_QUALITY0
MAINTAIN_FRAMERATE1
MAINTAIN_BALANCED2
MAINTAIN_RESOLUTION3
DIRECT_CDN_STREAMING_REASON 6 个成员
成员值
DIRECT_CDN_STREAMING_REASON_OK0
DIRECT_CDN_STREAMING_REASON_FAILED1
DIRECT_CDN_STREAMING_REASON_AUDIO_PUBLICATION2
DIRECT_CDN_STREAMING_REASON_VIDEO_PUBLICATION3
DIRECT_CDN_STREAMING_REASON_NET_CONNECT4
DIRECT_CDN_STREAMING_REASON_BAD_NAME5
DIRECT_CDN_STREAMING_STATE 5 个成员
成员值
DIRECT_CDN_STREAMING_STATE_IDLE0
DIRECT_CDN_STREAMING_STATE_RUNNING1
DIRECT_CDN_STREAMING_STATE_STOPPED2
DIRECT_CDN_STREAMING_STATE_FAILED3
DIRECT_CDN_STREAMING_STATE_RECOVERING4
EAR_MONITORING_FILTER_TYPE 4 个成员
成员值
EAR_MONITORING_FILTER_NONEnull
EAR_MONITORING_FILTER_BUILT_IN_AUDIO_FILTERSnull
EAR_MONITORING_FILTER_NOISE_SUPPRESSIONnull
EAR_MONITORING_FILTER_REUSE_POST_PROCESSING_FILTERnull
ENCODING_PREFERENCE 3 个成员
成员值
PREFER_AUTO-1
PREFER_SOFTWARE0
PREFER_HARDWARE1
ENCRYPTION_ERROR_TYPE 5 个成员
成员值
ENCRYPTION_ERROR_INTERNAL_FAILURE0
ENCRYPTION_ERROR_DECRYPTION_FAILURE1
ENCRYPTION_ERROR_ENCRYPTION_FAILURE2
ENCRYPTION_ERROR_DATASTREAM_DECRYPTION_FAILURE3
ENCRYPTION_ERROR_DATASTREAM_ENCRYPTION_FAILURE4
ENCRYPTION_MODE 9 个成员
成员值
AES_128_XTS1
AES_128_ECB2
AES_256_XTS3
SM4_128_ECB4
AES_128_GCM5
AES_256_GCM6
AES_128_GCM27
AES_256_GCM28
MODE_ENDnull
ERROR_CODE_TYPE 46 个成员
成员值
ERR_OK0
ERR_FAILED1
ERR_INVALID_ARGUMENT2
ERR_NOT_READY3
IRtcEnginenull
ERR_NOT_SUPPORTED4
ERR_REFUSED5
ERR_BUFFER_TOO_SMALL6
ERR_NOT_INITIALIZED7
ERR_INVALID_STATE8
ERR_NO_PERMISSION9
ERR_TIMEDOUT10
ERR_JOIN_CHANNEL_REJECTED17
ERR_LEAVE_CHANNEL_REJECTED18
ERR_ALREADY_IN_USE19
ERR_ABORTED20
ERR_INIT_NET_ENGINE21
ERR_RESOURCE_LIMITED22
ERR_INVALID_APP_ID101
ERR_INVALID_CHANNEL_NAME102
ERR_NO_SERVER_RESOURCES103
ERR_TOKEN_EXPIRED109
ERR_INVALID_TOKEN110
ERR_CONNECTION_INTERRUPTED111
ERR_CONNECTION_LOST112
ERR_NOT_IN_CHANNEL113
ERR_SIZE_TOO_LARGE114
ERR_BITRATE_LIMIT115
ERR_TOO_MANY_DATA_STREAMS116
ERR_STREAM_MESSAGE_TIMEOUT117
ERR_SET_CLIENT_ROLE_NOT_AUTHORIZED119
ERR_DECRYPTION_FAILED120
ERR_INVALID_USER_ID121
ERR_DATASTREAM_DECRYPTION_FAILED122
ERR_CLIENT_IS_BANNED_BY_SERVER123
ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISH130
ERR_INVALID_USER_ACCOUNT134
ERR_LOAD_MEDIA_ENGINE1001
ERR_ADM_GENERAL_ERROR1005
ERR_ADM_INIT_PLAYOUT1008
ERR_ADM_START_PLAYOUT1009
ERR_ADM_STOP_PLAYOUT1010
ERR_ADM_INIT_RECORDING1011
ERR_ADM_START_RECORDING1012
ERR_ADM_STOP_RECORDING1013
ERR_VDM_CAMERA_NOT_AUTHORIZED1501
EXPERIENCE_POOR_REASON 5 个成员
成员值
EXPERIENCE_REASON_NONE0
REMOTE_NETWORK_QUALITY_POOR1
LOCAL_NETWORK_QUALITY_POOR2
WIRELESS_SIGNAL_POOR4
WIFI_BLUETOOTH_COEXIST8
EXPERIENCE_QUALITY_TYPE 2 个成员
成员值
EXPERIENCE_QUALITY_GOOD0
EXPERIENCE_QUALITY_BAD1
EXTERNAL_VIDEO_SOURCE_TYPE 2 个成员
成员值
VIDEO_FRAME0
ENCODED_VIDEO_FRAME1
FACE_SHAPE_AREA 13 个成员
成员值
FACE_SHAPE_AREA_NONE-1
FACE_SHAPE_AREA_HEADSCALE0
FACE_SHAPE_AREA_FOREHEAD1
FACE_SHAPE_AREA_FACECONTOUR2
FACE_SHAPE_AREA_FACELENGTH3
FACE_SHAPE_AREA_FACEWIDTH4
FACE_SHAPE_AREA_CHEEKBONE5
FACE_SHAPE_AREA_CHEEK6
FACE_SHAPE_AREA_CHIN7
FACE_SHAPE_AREA_EYESCALE8
FACE_SHAPE_AREA_NOSELENGTH9
FACE_SHAPE_AREA_NOSEWIDTH10
FACE_SHAPE_AREA_MOUTHSCALE11
FACE_SHAPE_BEAUTY_STYLE 2 个成员
成员值
FACE_SHAPE_BEAUTY_STYLE_FEMALE0
FACE_SHAPE_BEAUTY_STYLE_MALE1
FeatureType 2 个成员
成员值
VIDEO_VIRTUAL_BACKGROUND1
VIDEO_BEAUTY_EFFECT2
FRAME_RATE 7 个成员
成员值
FRAME_RATE_FPS_11
FRAME_RATE_FPS_77
FRAME_RATE_FPS_1010
FRAME_RATE_FPS_1515
FRAME_RATE_FPS_2424
FRAME_RATE_FPS_3030
FRAME_RATE_FPS_6060
HEADPHONE_EQUALIZER_PRESET 3 个成员
成员值
HEADPHONE_EQUALIZER_OFFnull
HEADPHONE_EQUALIZER_OVEREARnull
HEADPHONE_EQUALIZER_INEARnull
INTERFACE_ID_TYPE 7 个成员
成员值
AGORA_IID_AUDIO_DEVICE_MANAGER1
AGORA_IID_VIDEO_DEVICE_MANAGER2
AGORA_IID_PARAMETER_ENGINE3
AGORA_IID_MEDIA_ENGINE4
AGORA_IID_SIGNALING_ENGINE8
AGORA_IID_LOCAL_SPATIAL_AUDIO11
AGORA_IID_MUSIC_CONTENT_CENTER15
LASTMILE_PROBE_RESULT_STATE 3 个成员
成员值
LASTMILE_PROBE_RESULT_COMPLETE1
LASTMILE_PROBE_RESULT_INCOMPLETE_NO_BWE2
LASTMILE_PROBE_RESULT_UNAVAILABLE3
LIGHTENING_CONTRAST_LEVEL 3 个成员
成员值
LIGHTENING_CONTRAST_LOW0
LIGHTENING_CONTRAST_NORMAL1
LIGHTENING_CONTRAST_HIGH2
LOCAL_AUDIO_STREAM_REASON 11 个成员
成员值
LOCAL_AUDIO_STREAM_REASON_OK0
LOCAL_AUDIO_STREAM_REASON_FAILURE1
LOCAL_AUDIO_STREAM_REASON_DEVICE_NO_PERMISSION2
LOCAL_AUDIO_STREAM_REASON_DEVICE_BUSY3
LOCAL_AUDIO_STREAM_REASON_RECORD_FAILURE4
LOCAL_AUDIO_STREAM_REASON_ENCODE_FAILURE5
LOCAL_AUDIO_STREAM_REASON_NO_RECORDING_DEVICE6
LOCAL_AUDIO_STREAM_REASON_NO_PLAYOUT_DEVICE7
LOCAL_AUDIO_STREAM_REASON_INTERRUPTED8
LOCAL_AUDIO_STREAM_REASON_RECORD_INVALID_ID9
LOCAL_AUDIO_STREAM_REASON_PLAYOUT_INVALID_ID10
LOCAL_AUDIO_STREAM_STATE 4 个成员
成员值
LOCAL_AUDIO_STREAM_STATE_STOPPED0
LOCAL_AUDIO_STREAM_STATE_RECORDING1
LOCAL_AUDIO_STREAM_STATE_ENCODING2
LOCAL_AUDIO_STREAM_STATE_FAILED3
LOCAL_PROXY_MODE 2 个成员
成员值
ConnectivityFirst0
LocalOnly1
LOCAL_VIDEO_STREAM_REASON 26 个成员
成员值
LOCAL_VIDEO_STREAM_REASON_OK0
LOCAL_VIDEO_STREAM_REASON_FAILURE1
LOCAL_VIDEO_STREAM_REASON_DEVICE_NO_PERMISSION2
LOCAL_VIDEO_STREAM_REASON_DEVICE_BUSY3
LOCAL_VIDEO_STREAM_REASON_CAPTURE_FAILURE4
LOCAL_VIDEO_STREAM_REASON_CODEC_NOT_SUPPORT5
LOCAL_VIDEO_STREAM_REASON_CAPTURE_INBACKGROUND6
LOCAL_VIDEO_STREAM_REASON_CAPTURE_MULTIPLE_FOREGROUND_APPS7
LOCAL_VIDEO_STREAM_REASON_DEVICE_NOT_FOUND8
LOCAL_VIDEO_STREAM_REASON_DEVICE_DISCONNECTED9
LOCAL_VIDEO_STREAM_REASON_DEVICE_INVALID_ID10
LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_MINIMIZED11
LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_CLOSED12
LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_OCCLUDED13
LOCAL_VIDEO_STREAM_REASON_DEVICE_INTERRUPT14
LOCAL_VIDEO_STREAM_REASON_DEVICE_FATAL_ERROR15
LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_FAILURE21
LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_NO_PERMISSION22
LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_AUTO_FALLBACK24
LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_HIDDEN25
LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_RECOVER_FROM_HIDDEN26
LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_RECOVER_FROM_MINIMIZED27
LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_PAUSED28
LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_RESUMED29
LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_DISPLAY_DISCONNECTED30
LOCAL_VIDEO_STREAM_REASON_DEVICE_SYSTEM_PRESSURE101
LOCAL_VIDEO_STREAM_STATE 4 个成员
成员值
LOCAL_VIDEO_STREAM_STATE_STOPPED0
LOCAL_VIDEO_STREAM_STATE_CAPTURING1
LOCAL_VIDEO_STREAM_STATE_ENCODING2
LOCAL_VIDEO_STREAM_STATE_FAILED3
LOG_FILTER_TYPE 6 个成员
成员值
LOG_FILTER_OFF0
LOG_FILTER_DEBUG2063
LOG_FILTER_INFO15
LOG_FILTER_WARN14
LOG_FILTER_ERROR12
LOG_FILTER_CRITICAL8
LOG_LEVEL 5 个成员
成员值
LOG_LEVEL_NONE0
LOG_LEVEL_INFO1
LOG_LEVEL_WARN2
LOG_LEVEL_ERROR4
LOG_LEVEL_FATAL8
LOW_LIGHT_ENHANCE_LEVEL 2 个成员
成员值
LOW_LIGHT_ENHANCE_LEVEL_HIGH_QUALITY0
LOW_LIGHT_ENHANCE_LEVEL_FAST1
LOW_LIGHT_ENHANCE_MODE 2 个成员
成员值
LOW_LIGHT_ENHANCE_AUTO0
LOW_LIGHT_ENHANCE_MANUAL1
MAX_DEVICE_ID_LENGTH_TYPE 1 个成员
成员值
MAX_DEVICE_ID_LENGTHnull
MAX_USER_ACCOUNT_LENGTH_TYPE 1 个成员
成员值
MAX_USER_ACCOUNT_LENGTHnull
MEDIA_DEVICE_STATE_TYPE 6 个成员
成员值
MEDIA_DEVICE_STATE_IDLE0
MEDIA_DEVICE_STATE_ACTIVE1
MEDIA_DEVICE_STATE_DISABLED2
MEDIA_DEVICE_STATE_PLUGGED_IN3
MEDIA_DEVICE_STATE_NOT_PRESENT4
MEDIA_DEVICE_STATE_UNPLUGGED8
MEDIA_DEVICE_TYPE 8 个成员
成员值
UNKNOWN_AUDIO_DEVICE-1
AUDIO_PLAYOUT_DEVICE0
AUDIO_RECORDING_DEVICE1
VIDEO_RENDER_DEVICE2
VIDEO_CAPTURE_DEVICE3
AUDIO_APPLICATION_PLAYOUT_DEVICE4
AUDIO_VIRTUAL_PLAYOUT_DEVICEnull
AUDIO_VIRTUAL_RECORDING_DEVICEnull
MEDIA_PLAYER_EVENT 14 个成员
成员值
PLAYER_EVENT_SEEK_BEGIN0
PLAYER_EVENT_SEEK_COMPLETE1
PLAYER_EVENT_SEEK_ERROR2
PLAYER_EVENT_AUDIO_TRACK_CHANGED5
PLAYER_EVENT_BUFFER_LOW6
PLAYER_EVENT_BUFFER_RECOVER7
PLAYER_EVENT_FREEZE_START8
PLAYER_EVENT_FREEZE_STOP9
PLAYER_EVENT_SWITCH_BEGIN10
PLAYER_EVENT_SWITCH_COMPLETE11
PLAYER_EVENT_SWITCH_ERROR12
PLAYER_EVENT_FIRST_DISPLAYED13
PLAYER_EVENT_REACH_CACHE_FILE_MAX_COUNT14
PLAYER_EVENT_REACH_CACHE_FILE_MAX_SIZE15
MEDIA_PLAYER_METADATA_TYPE 2 个成员
成员值
PLAYER_METADATA_TYPE_UNKNOWN0
PLAYER_METADATA_TYPE_SEI1
MEDIA_PLAYER_REASON 16 个成员
成员值
PLAYER_REASON_NONE0
PLAYER_REASON_INVALID_ARGUMENTS-1
PLAYER_REASON_INTERNAL-2
PLAYER_REASON_NO_RESOURCE-3
PLAYER_REASON_INVALID_MEDIA_SOURCE-4
PLAYER_REASON_UNKNOWN_STREAM_TYPE-5
PLAYER_REASON_OBJ_NOT_INITIALIZED-6
PLAYER_REASON_CODEC_NOT_SUPPORTED-7
PLAYER_REASON_VIDEO_RENDER_FAILED-8
PLAYER_REASON_INVALID_STATE-9
PLAYER_REASON_URL_NOT_FOUND-10
PLAYER_REASON_INVALID_CONNECTION_STATE-11
PLAYER_REASON_SRC_BUFFER_UNDERFLOW-12
PLAYER_REASON_INTERRUPTED-13
PLAYER_REASON_NOT_SUPPORTED-14
PLAYER_REASON_UNKNOWN-17
MEDIA_PLAYER_STATE 9 个成员
成员值
PLAYER_STATE_IDLE0
PLAYER_STATE_OPENING1
PLAYER_STATE_OPEN_COMPLETED2
PLAYER_STATE_PLAYING3
PLAYER_STATE_PAUSED4
PLAYER_STATE_PLAYBACK_COMPLETED5
PLAYER_STATE_PLAYBACK_ALL_LOOPS_COMPLETED6
PLAYER_STATE_STOPPED7
PLAYER_STATE_FAILED100
MEDIA_SOURCE_TYPE 6 个成员
成员值
AUDIO_PLAYOUT_SOURCE0
AUDIO_RECORDING_SOURCE1
PRIMARY_CAMERA_SOURCE2
SECONDARY_CAMERA_SOURCE3
CUSTOM_VIDEO_SOURCE6
UNKNOWN_MEDIA_SOURCE100
MEDIA_STREAM_TYPE 4 个成员
成员值
STREAM_TYPE_UNKNOWN0
STREAM_TYPE_VIDEO1
STREAM_TYPE_AUDIO2
STREAM_TYPE_SUBTITLE3
MEDIA_TRACE_EVENT 2 个成员
成员值
MEDIA_TRACE_EVENT_VIDEO_RENDERED0
MEDIA_TRACE_EVENT_VIDEO_DECODED1
MediaRecorderContainerFormat 1 个成员
成员值
FORMAT_MP41
MediaRecorderStreamType 3 个成员
成员值
STREAM_TYPE_AUDIOnull
STREAM_TYPE_VIDEOnull
STREAM_TYPE_BOTHnull
METADATA_TYPE 2 个成员
成员值
UNKNOWN_METADATAnull
VIDEO_METADATAnull
MUSIC_CACHE_STATUS_TYPE 2 个成员
成员值
MUSIC_CACHE_STATUS_TYPE_CACHED0
MUSIC_CACHE_STATUS_TYPE_CACHING1
MusicContentCenterStateReason 8 个成员
成员值
kMusicContentCenterReasonOk0
kMusicContentCenterReasonError1
kMusicContentCenterReasonGateway2
kMusicContentCenterReasonPermissionAndResource3
kMusicContentCenterReasonInternalDataParse4
kMusicContentCenterReasonMusicLoading5
kMusicContentCenterReasonMusicDecryption6
kMusicContentCenterReasonHttpInternalError7
MusicPlayMode 3 个成员
成员值
kMusicPlayModeOriginal0
kMusicPlayModeAccompany1
kMusicPlayModeLeadSing2
NETWORK_TYPE 8 个成员
成员值
NETWORK_TYPE_UNKNOWN-1
NETWORK_TYPE_DISCONNECTED0
NETWORK_TYPE_LAN1
NETWORK_TYPE_WIFI2
NETWORK_TYPE_MOBILE_2G3
NETWORK_TYPE_MOBILE_3G4
NETWORK_TYPE_MOBILE_4G5
NETWORK_TYPE_MOBILE_5G6
ORIENTATION_MODE 3 个成员
成员值
ORIENTATION_MODE_ADAPTIVE0
ORIENTATION_MODE_FIXED_LANDSCAPE1
ORIENTATION_MODE_FIXED_PORTRAIT2
PERMISSION_TYPE 3 个成员
成员值
RECORD_AUDIO0
CAMERA1
SCREEN_CAPTUREnull
PLAYER_PRELOAD_EVENT 3 个成员
成员值
PLAYER_PRELOAD_EVENT_BEGIN0
PLAYER_PRELOAD_EVENT_COMPLETE1
PLAYER_PRELOAD_EVENT_ERROR2
PreloadState 4 个成员
成员值
kPreloadStateCompleted0
kPreloadStateFailed1
kPreloadStatePreloading2
kPreloadStateRemoved3
PROXY_TYPE 5 个成员
成员值
NONE_PROXY_TYPE0
UDP_PROXY_TYPE1
TCP_PROXY_TYPE2
LOCAL_PROXY_TYPE3
TCP_PROXY_AUTO_FALLBACK_TYPE4
QUALITY_ADAPT_INDICATION 3 个成员
成员值
ADAPT_NONE0
ADAPT_UP_BANDWIDTH1
ADAPT_DOWN_BANDWIDTH2
QUALITY_TYPE 8 个成员
成员值
QUALITY_UNKNOWN0
QUALITY_EXCELLENT1
QUALITY_GOOD2
QUALITY_POOR3
QUALITY_BAD4
QUALITY_VBAD5
QUALITY_DOWN6
QUALITY_DETECTING8
RAW_AUDIO_FRAME_OP_MODE_TYPE 2 个成员
成员值
RAW_AUDIO_FRAME_OP_MODE_READ_ONLY0
RAW_AUDIO_FRAME_OP_MODE_READ_WRITE2
RecorderReasonCode 5 个成员
成员值
RECORDER_REASON_NONE0
RECORDER_ERROR_WRITE_FAILED1
RECORDER_ERROR_NO_STREAM2
RECORDER_ERROR_OVER_MAX_DURATION3
RECORDER_ERROR_CONFIG_CHANGED4
RecorderState 3 个成员
成员值
RECORDER_STATE_ERROR-1
RECORDER_STATE_START2
RECORDER_STATE_STOP3
RecorderStreamType 2 个成员
成员值
RTC0
PREVIEW1
REMOTE_AUDIO_STATE 5 个成员
成员值
REMOTE_AUDIO_STATE_STOPPED0
REMOTE_AUDIO_STATE_STARTING1
REMOTE_AUDIO_STATE_DECODING2
REMOTE_AUDIO_STATE_FROZEN3
REMOTE_AUDIO_STATE_FAILED4
REMOTE_AUDIO_STATE_REASON 8 个成员
成员值
REMOTE_AUDIO_REASON_INTERNAL0
REMOTE_AUDIO_REASON_NETWORK_CONGESTION1
REMOTE_AUDIO_REASON_NETWORK_RECOVERY2
REMOTE_AUDIO_REASON_LOCAL_MUTED3
REMOTE_AUDIO_REASON_LOCAL_UNMUTED4
REMOTE_AUDIO_REASON_REMOTE_MUTED5
REMOTE_AUDIO_REASON_REMOTE_UNMUTED6
REMOTE_AUDIO_REASON_REMOTE_OFFLINE7
REMOTE_VIDEO_STATE 5 个成员
成员值
REMOTE_VIDEO_STATE_STOPPED0
REMOTE_VIDEO_STATE_STARTING1
REMOTE_VIDEO_STATE_DECODING2
REMOTE_VIDEO_STATE_FROZEN3
REMOTE_VIDEO_STATE_FAILED4
REMOTE_VIDEO_STATE_REASON 12 个成员
成员值
REMOTE_VIDEO_STATE_REASON_INTERNAL0
REMOTE_VIDEO_STATE_REASON_NETWORK_CONGESTION1
REMOTE_VIDEO_STATE_REASON_NETWORK_RECOVERY2
REMOTE_VIDEO_STATE_REASON_LOCAL_MUTED3
REMOTE_VIDEO_STATE_REASON_LOCAL_UNMUTED4
REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED5
REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED6
REMOTE_VIDEO_STATE_REASON_REMOTE_OFFLINE7
REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK8
REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK_RECOVERY9
REMOTE_VIDEO_STATE_REASON_SDK_IN_BACKGROUND12
REMOTE_VIDEO_STATE_REASON_CODEC_NOT_SUPPORT13
RENDER_MODE_TYPE 3 个成员
成员值
RENDER_MODE_HIDDEN1
RENDER_MODE_FIT2
RENDER_MODE_ADAPTIVE3
RHYTHM_PLAYER_REASON 5 个成员
成员值
RHYTHM_PLAYER_REASON_OK0
RHYTHM_PLAYER_REASON_FAILED1
RHYTHM_PLAYER_REASON_CAN_NOT_OPEN801
RHYTHM_PLAYER_REASON_CAN_NOT_PLAY802
RHYTHM_PLAYER_REASON_FILE_OVER_DURATION_LIMIT803
RHYTHM_PLAYER_STATE_TYPE 5 个成员
成员值
RHYTHM_PLAYER_STATE_IDLE810
RHYTHM_PLAYER_STATE_OPENING811
RHYTHM_PLAYER_STATE_DECODING812
RHYTHM_PLAYER_STATE_PLAYING813
RHYTHM_PLAYER_STATE_FAILED814
RTMP_STREAM_LIFE_CYCLE_TYPE 2 个成员
成员值
RTMP_STREAM_LIFE_CYCLE_BIND2CHANNELnull
RTMP_STREAM_LIFE_CYCLE_BIND2OWNERnull
RTMP_STREAM_PUBLISH_REASON 15 个成员
成员值
RTMP_STREAM_PUBLISH_REASON_OK0
RTMP_STREAM_PUBLISH_REASON_INVALID_ARGUMENT1
RTMP_STREAM_PUBLISH_REASON_ENCRYPTED_STREAM_NOT_ALLOWED2
RTMP_STREAM_PUBLISH_REASON_CONNECTION_TIMEOUT3
RTMP_STREAM_PUBLISH_REASON_INTERNAL_SERVER_ERROR4
RTMP_STREAM_PUBLISH_REASON_RTMP_SERVER_ERROR5
RTMP_STREAM_PUBLISH_REASON_TOO_OFTEN6
RTMP_STREAM_PUBLISH_REASON_REACH_LIMIT7
RTMP_STREAM_PUBLISH_REASON_NOT_AUTHORIZED8
RTMP_STREAM_PUBLISH_REASON_STREAM_NOT_FOUND9
RTMP_STREAM_PUBLISH_REASON_FORMAT_NOT_SUPPORTED10
RTMP_STREAM_PUBLISH_REASON_NOT_BROADCASTER11
RTMP_STREAM_PUBLISH_REASON_TRANSCODING_NO_MIX_STREAM13
RTMP_STREAM_PUBLISH_REASON_NET_DOWN14
RTMP_STREAM_PUBLISH_REASON_INVALID_PRIVILEGE16
RTMP_STREAM_PUBLISH_STATE 6 个成员
成员值
RTMP_STREAM_PUBLISH_STATE_IDLE0
RTMP_STREAM_PUBLISH_STATE_CONNECTING1
RTMP_STREAM_PUBLISH_STATE_RUNNING2
RTMP_STREAM_PUBLISH_STATE_RECOVERING3
RTMP_STREAM_PUBLISH_STATE_FAILURE4
RTMP_STREAM_PUBLISH_STATE_DISCONNECTING5
RTMP_STREAMING_EVENT 4 个成员
成员值
RTMP_STREAMING_EVENT_FAILED_LOAD_IMAGE1
RTMP_STREAMING_EVENT_URL_ALREADY_IN_USE2
RTMP_STREAMING_EVENT_ADVANCED_FEATURE_NOT_SUPPORT3
RTMP_STREAMING_EVENT_REQUEST_TOO_OFTEN4
SCREEN_CAPTURE_FRAMERATE_CAPABILITY 3 个成员
成员值
SCREEN_CAPTURE_FRAMERATE_CAPABILITY_15_FPS0
SCREEN_CAPTURE_FRAMERATE_CAPABILITY_30_FPS1
SCREEN_CAPTURE_FRAMERATE_CAPABILITY_60_FPS2
SCREEN_SCENARIO_TYPE 4 个成员
成员值
SCREEN_SCENARIO_DOCUMENT1
SCREEN_SCENARIO_GAMING2
SCREEN_SCENARIO_VIDEO3
SCREEN_SCENARIO_RDC4
ScreenCaptureSourceType 4 个成员
成员值
ScreenCaptureSourceType_Unknown-1
ScreenCaptureSourceType_Window0
ScreenCaptureSourceType_Screen1
ScreenCaptureSourceType_Custom2
SEG_MODEL_TYPE 2 个成员
成员值
SEG_MODEL_AI1
SEG_MODEL_GREEN2
SIMULCAST_STREAM_MODE 3 个成员
成员值
AUTO_SIMULCAST_STREAM-1
DISABLE_SIMULCAST_STREAM0
ENABLE_SIMULCAST_STREAM1
STREAM_FALLBACK_OPTIONS 3 个成员
成员值
STREAM_FALLBACK_OPTION_DISABLED0
STREAM_FALLBACK_OPTION_VIDEO_STREAM_LOW1
STREAM_FALLBACK_OPTION_AUDIO_ONLY2
STREAM_PUBLISH_STATE 4 个成员
成员值
PUB_STATE_IDLE0
PUB_STATE_NO_PUBLISHED1
PUB_STATE_PUBLISHING2
PUB_STATE_PUBLISHED3
STREAM_SUBSCRIBE_STATE 4 个成员
成员值
SUB_STATE_IDLE0
SUB_STATE_NO_SUBSCRIBED1
SUB_STATE_SUBSCRIBING2
SUB_STATE_SUBSCRIBED3
USER_OFFLINE_REASON_TYPE 3 个成员
成员值
USER_OFFLINE_QUIT0
USER_OFFLINE_DROPPED1
USER_OFFLINE_BECOME_AUDIENCE2
VIDEO_APPLICATION_SCENARIO_TYPE 4 个成员
成员值
APPLICATION_SCENARIO_GENERAL0
APPLICATION_SCENARIO_MEETINGnull
APPLICATION_SCENARIO_1V1null
APPLICATION_SCENARIO_LIVESHOWnull
VIDEO_BUFFER_TYPE 3 个成员
成员值
VIDEO_BUFFER_RAW_DATA1
VIDEO_BUFFER_ARRAY2
VIDEO_BUFFER_TEXTURE3
VIDEO_CODEC_CAPABILITY_LEVEL 5 个成员
成员值
CODEC_CAPABILITY_LEVEL_UNSPECIFIED-1
CODEC_CAPABILITY_LEVEL_BASIC_SUPPORT5
CODEC_CAPABILITY_LEVEL_1080P30FPS10
CODEC_CAPABILITY_LEVEL_1080P60FPS20
CODEC_CAPABILITY_LEVEL_4K60FPS30
VIDEO_CODEC_PROFILE_TYPE 3 个成员
成员值
VIDEO_CODEC_PROFILE_BASELINE66
VIDEO_CODEC_PROFILE_MAIN77
VIDEO_CODEC_PROFILE_HIGH100
VIDEO_CODEC_TYPE 6 个成员
成员值
VIDEO_CODEC_NONE0
VIDEO_CODEC_VP81
VIDEO_CODEC_H2642
VIDEO_CODEC_H2653
VIDEO_CODEC_GENERIC6
VIDEO_CODEC_GENERIC_JPEG20
VIDEO_CODEC_TYPE_FOR_STREAM 2 个成员
成员值
VIDEO_CODEC_H264_FOR_STREAM1
VIDEO_CODEC_H265_FOR_STREAM2
VIDEO_CONTENT_HINT 3 个成员
成员值
CONTENT_HINT_NONEnull
CONTENT_HINT_MOTIONnull
CONTENT_HINT_DETAILSnull
VIDEO_DENOISER_LEVEL 2 个成员
成员值
VIDEO_DENOISER_LEVEL_HIGH_QUALITY0
VIDEO_DENOISER_LEVEL_FAST1
VIDEO_DENOISER_MODE 2 个成员
成员值
VIDEO_DENOISER_AUTO0
VIDEO_DENOISER_MANUAL1
VIDEO_FRAME_PROCESS_MODE 2 个成员
成员值
PROCESS_MODE_READ_ONLYnull
PROCESS_MODE_READ_WRITEnull
VIDEO_FRAME_TYPE 6 个成员
成员值
VIDEO_FRAME_TYPE_BLANK_FRAME0
VIDEO_FRAME_TYPE_KEY_FRAME3
VIDEO_FRAME_TYPE_DELTA_FRAME4
VIDEO_FRAME_TYPE_B_FRAME5
VIDEO_FRAME_TYPE_DROPPABLE_FRAME6
VIDEO_FRAME_TYPE_UNKNOWnull
VIDEO_MIRROR_MODE_TYPE 3 个成员
成员值
VIDEO_MIRROR_MODE_AUTO0
VIDEO_MIRROR_MODE_ENABLED1
VIDEO_MIRROR_MODE_DISABLED2
VIDEO_MODULE_POSITION 4 个成员
成员值
POSITION_POST_CAPTURER1
POSITION_PRE_RENDERER2
POSITION_PRE_ENCODER4
POSITION_POST_CAPTURER_ORIGIN8
VIDEO_ORIENTATION 4 个成员
成员值
VIDEO_ORIENTATION_00
VIDEO_ORIENTATION_9090
VIDEO_ORIENTATION_180180
VIDEO_ORIENTATION_270270
VIDEO_PIXEL_FORMAT 5 个成员
成员值
VIDEO_PIXEL_DEFAULT0
VIDEO_PIXEL_I4201
VIDEO_PIXEL_RGBA4
VIDEO_PIXEL_I42216
VIDEO_TEXTURE_ID3D11TEXTURE2D17
VIDEO_PROFILE_TYPE 63 个成员
成员值
VIDEO_PROFILE_LANDSCAPE_120P0
VIDEO_PROFILE_LANDSCAPE_120P_32
VIDEO_PROFILE_LANDSCAPE_180P10
VIDEO_PROFILE_LANDSCAPE_180P_312
VIDEO_PROFILE_LANDSCAPE_180P_413
VIDEO_PROFILE_LANDSCAPE_240P20
VIDEO_PROFILE_LANDSCAPE_240P_322
VIDEO_PROFILE_LANDSCAPE_240P_423
VIDEO_PROFILE_LANDSCAPE_360P30
VIDEO_PROFILE_LANDSCAPE_360P_332
VIDEO_PROFILE_LANDSCAPE_360P_433
VIDEO_PROFILE_LANDSCAPE_360P_635
VIDEO_PROFILE_LANDSCAPE_360P_736
VIDEO_PROFILE_LANDSCAPE_360P_837
VIDEO_PROFILE_LANDSCAPE_360P_938
VIDEO_PROFILE_LANDSCAPE_360P_1039
VIDEO_PROFILE_LANDSCAPE_360P_11100
VIDEO_PROFILE_LANDSCAPE_480P40
VIDEO_PROFILE_LANDSCAPE_480P_342
VIDEO_PROFILE_LANDSCAPE_480P_443
VIDEO_PROFILE_LANDSCAPE_480P_645
VIDEO_PROFILE_LANDSCAPE_480P_847
VIDEO_PROFILE_LANDSCAPE_480P_948
VIDEO_PROFILE_LANDSCAPE_480P_1049
VIDEO_PROFILE_LANDSCAPE_720P50
VIDEO_PROFILE_LANDSCAPE_720P_352
VIDEO_PROFILE_LANDSCAPE_720P_554
VIDEO_PROFILE_LANDSCAPE_720P_655
VIDEO_PROFILE_LANDSCAPE_1080P60
VIDEO_PROFILE_LANDSCAPE_1080P_362
VIDEO_PROFILE_LANDSCAPE_1080P_564
VIDEO_PROFILE_PORTRAIT_120P1000
VIDEO_PROFILE_PORTRAIT_120P_31002
VIDEO_PROFILE_PORTRAIT_180P1010
VIDEO_PROFILE_PORTRAIT_180P_31012
VIDEO_PROFILE_PORTRAIT_180P_41013
VIDEO_PROFILE_PORTRAIT_240P1020
VIDEO_PROFILE_PORTRAIT_240P_31022
VIDEO_PROFILE_PORTRAIT_240P_41023
VIDEO_PROFILE_PORTRAIT_360P1030
VIDEO_PROFILE_PORTRAIT_360P_31032
VIDEO_PROFILE_PORTRAIT_360P_41033
VIDEO_PROFILE_PORTRAIT_360P_61035
VIDEO_PROFILE_PORTRAIT_360P_71036
VIDEO_PROFILE_PORTRAIT_360P_81037
VIDEO_PROFILE_PORTRAIT_360P_91038
VIDEO_PROFILE_PORTRAIT_360P_101039
VIDEO_PROFILE_PORTRAIT_360P_111100
VIDEO_PROFILE_PORTRAIT_480P1040
VIDEO_PROFILE_PORTRAIT_480P_31042
VIDEO_PROFILE_PORTRAIT_480P_41043
VIDEO_PROFILE_PORTRAIT_480P_61045
VIDEO_PROFILE_PORTRAIT_480P_81047
VIDEO_PROFILE_PORTRAIT_480P_91048
VIDEO_PROFILE_PORTRAIT_480P_101049
VIDEO_PROFILE_PORTRAIT_720P1050
VIDEO_PROFILE_PORTRAIT_720P_31052
VIDEO_PROFILE_PORTRAIT_720P_51054
VIDEO_PROFILE_PORTRAIT_720P_61055
VIDEO_PROFILE_PORTRAIT_1080P1060
VIDEO_PROFILE_PORTRAIT_1080P_31062
VIDEO_PROFILE_PORTRAIT_1080P_51064
VIDEO_PROFILE_DEFAULTnull
VIDEO_SOURCE_TYPE 18 个成员
成员值
VIDEO_SOURCE_CAMERA_PRIMARY0
VIDEO_SOURCE_CAMERA0
VIDEO_SOURCE_CAMERA_SECONDARY1
VIDEO_SOURCE_SCREEN_PRIMARY2
VIDEO_SOURCE_SCREEN2
VIDEO_SOURCE_SCREEN_SECONDARY3
VIDEO_SOURCE_CUSTOM4
VIDEO_SOURCE_MEDIA_PLAYER5
VIDEO_SOURCE_RTC_IMAGE_PNG6
VIDEO_SOURCE_RTC_IMAGE_JPEG7
VIDEO_SOURCE_RTC_IMAGE_GIF8
VIDEO_SOURCE_REMOTE9
VIDEO_SOURCE_TRANSCODED10
VIDEO_SOURCE_CAMERA_THIRD11
VIDEO_SOURCE_CAMERA_FOURTH12
VIDEO_SOURCE_SCREEN_THIRD13
VIDEO_SOURCE_SCREEN_FOURTH14
VIDEO_SOURCE_UNKNOWN100
VIDEO_STREAM_TYPE 2 个成员
成员值
VIDEO_STREAM_HIGH0
VIDEO_STREAM_LOW1
VIDEO_TRANSCODER_ERROR 6 个成员
成员值
VT_ERR_VIDEO_SOURCE_NOT_READY1
VT_ERR_INVALID_VIDEO_SOURCE_TYPE2
VT_ERR_INVALID_IMAGE_PATH3
VT_ERR_UNSUPPORT_IMAGE_FORMAT4
VT_ERR_INVALID_LAYOUT5
VT_ERR_INTERNAL20
VIDEO_VIEW_SETUP_MODE 3 个成员
成员值
VIDEO_VIEW_SETUP_REPLACE0
VIDEO_VIEW_SETUP_ADD1
VIDEO_VIEW_SETUP_REMOVE2
VOICE_AI_TUNER_TYPE 10 个成员
成员值
VOICE_AI_TUNER_MATURE_MALE0
VOICE_AI_TUNER_FRESH_MALE1
VOICE_AI_TUNER_ELEGANT_FEMALE2
VOICE_AI_TUNER_SWEET_FEMALE3
VOICE_AI_TUNER_WARM_MALE_SINGING4
VOICE_AI_TUNER_GENTLE_FEMALE_SINGING5
VOICE_AI_TUNER_HUSKY_MALE_SINGING6
VOICE_AI_TUNER_WARM_ELEGANT_FEMALE_SINGING7
VOICE_AI_TUNER_POWERFUL_MALE_SINGING8
VOICE_AI_TUNER_DREAMY_FEMALE_SINGING9
VOICE_BEAUTIFIER_PRESET 14 个成员
成员值
VOICE_BEAUTIFIER_OFFnull
CHAT_BEAUTIFIER_MAGNETICnull
CHAT_BEAUTIFIER_FRESHnull
CHAT_BEAUTIFIER_VITALITYnull
SINGING_BEAUTIFIERnull
TIMBRE_TRANSFORMATION_VIGOROUSnull
TIMBRE_TRANSFORMATION_DEEPnull
TIMBRE_TRANSFORMATION_MELLOWnull
TIMBRE_TRANSFORMATION_FALSETTOnull
TIMBRE_TRANSFORMATION_FULLnull
TIMBRE_TRANSFORMATION_CLEARnull
TIMBRE_TRANSFORMATION_RESOUNDINGnull
TIMBRE_TRANSFORMATION_RINGINGnull
ULTRA_HIGH_QUALITY_VOICEnull
VOICE_CONVERSION_PRESET 5 个成员
成员值
VOICE_CONVERSION_OFFnull
VOICE_CHANGER_NEUTRALnull
VOICE_CHANGER_SWEETnull
VOICE_CHANGER_SOLIDnull
VOICE_CHANGER_BASSnull
WATERMARK_FIT_MODE 2 个成员
成员值
FIT_MODE_COVER_POSITIONnull
FIT_MODE_USE_IMAGE_RATIOnull

错误码常量

常量值
ERR_ABORTED20
ERR_ADM_GENERAL_ERROR1005
ERR_ADM_INIT_PLAYOUT1008
ERR_ADM_INIT_RECORDING1011
ERR_ADM_START_PLAYOUT1009
ERR_ADM_START_RECORDING1012
ERR_ADM_STOP_PLAYOUT1010
ERR_ADM_STOP_RECORDING1013
ERR_ALREADY_IN_USE19
ERR_BITRATE_LIMIT115
ERR_BUFFER_TOO_SMALL6
ERR_CLIENT_IS_BANNED_BY_SERVER123
ERR_CONNECTION_INTERRUPTED111
ERR_CONNECTION_LOST112
ERR_DATASTREAM_DECRYPTION_FAILED122
ERR_DECRYPTION_FAILED120
ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISH130
ERR_FAILED1
ERR_INIT_NET_ENGINE21
ERR_INVALID_APP_ID101
ERR_INVALID_ARGUMENT2
ERR_INVALID_CHANNEL_NAME102
ERR_INVALID_STATE8
ERR_INVALID_TOKEN110
ERR_INVALID_USER_ACCOUNT134
ERR_INVALID_USER_ID121
ERR_JOIN_CHANNEL_REJECTED17
ERR_LEAVE_CHANNEL_REJECTED18
ERR_LOAD_MEDIA_ENGINE1001
ERR_NOT_INITIALIZED7
ERR_NOT_IN_CHANNEL113
ERR_NOT_READY3
ERR_NOT_SUPPORTED4
ERR_NO_PERMISSION9
ERR_NO_SERVER_RESOURCES103
ERR_OK0
ERR_REFUSED5
ERR_RESOURCE_LIMITED22
ERR_SET_CLIENT_ROLE_NOT_AUTHORIZED119
ERR_SIZE_TOO_LARGE114
ERR_STREAM_MESSAGE_TIMEOUT117
ERR_TIMEDOUT10
ERR_TOKEN_EXPIRED109
ERR_TOO_MANY_DATA_STREAMS116
ERR_VDM_CAMERA_NOT_AUTHORIZED1501
IRtcEnginenull

已知限制

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

接口成员
FilterEffectOptionspath
IAgoraParametersetParameters
IAudioDeviceCollectiongetApplicationVolume
IAudioDeviceCollectiongetCount
IAudioDeviceCollectionisApplicationMute
IAudioDeviceCollectionrelease
IAudioDeviceCollectionsetApplicationMute
IAudioDeviceCollectionsetApplicationVolume
IAudioDeviceManagerenumeratePlaybackDevices
IAudioDeviceManagerenumerateRecordingDevices
IAudioDeviceManagerfollowSystemLoopbackDevice
IAudioDeviceManagerfollowSystemPlaybackDevice
IAudioDeviceManagerfollowSystemRecordingDevice
IAudioDeviceManagergetPlaybackDeviceMute
IAudioDeviceManagergetRecordingDeviceMute
IAudioDeviceManagergetRecordingDeviceVolume
IAudioDeviceManagerrelease
IAudioDeviceManagersetPlaybackDeviceMute
IAudioDeviceManagersetPlaybackDeviceVolume
IAudioDeviceManagersetRecordingDeviceMute
IAudioDeviceManagersetRecordingDeviceVolume
IAudioDeviceManagerstartAudioDeviceLoopbackTest
IAudioDeviceManagerstartPlaybackDeviceTest
IAudioDeviceManagerstartRecordingDeviceTest
IAudioDeviceManagerstopAudioDeviceLoopbackTest
IAudioDeviceManagerstopPlaybackDeviceTest
IAudioDeviceManagerstopRecordingDeviceTest
IAudioFrameObserverBasegetEarMonitoringAudioParams
IAudioFrameObserverBasegetMixedAudioParams
IAudioFrameObserverBasegetObservedAudioFramePosition
IAudioFrameObserverBasegetPlaybackAudioParams
IAudioFrameObserverBasegetRecordAudioParams
IAudioFrameObserverBaseonEarMonitoringAudioFrame
IAudioFrameObserverBaseonMixedAudioFrame
IAudioFrameObserverBaseonPlaybackAudioFrame
IAudioFrameObserverBaseonRecordAudioFrame
IBaseSpatialAudioEnginemuteAllRemoteAudioStreams
IBaseSpatialAudioEnginemuteLocalAudioStream
IBaseSpatialAudioEnginemuteRemoteAudioStream
IBaseSpatialAudioEnginerelease
IBaseSpatialAudioEnginesetAudioRecvRange
IBaseSpatialAudioEnginesetDistanceUnit
IBaseSpatialAudioEnginesetMaxAudioRecvCount
IBaseSpatialAudioEnginesetPlayerAttenuation
IBaseSpatialAudioEnginesetRemoteAudioAttenuation
IBaseSpatialAudioEnginesetZones
IBaseSpatialAudioEngineupdatePlayerPositionInfo
ILocalSpatialAudioEngineclearRemotePositions
ILocalSpatialAudioEngineinitialize
ILocalSpatialAudioEngineremoveRemotePosition
ILocalSpatialAudioEngineupdateRemotePosition
IMediaEnginecreateCustomAudioTrack
IMediaEnginedestroyCustomAudioTrack
IMediaEnginepushVideoFrame
IMediaEngineregisterAudioFrameObserver
IMediaEngineregisterVideoEncodedFrameObserver
IMediaEngineregisterVideoFrameObserver
IMediaEnginesetExternalAudioSource
IMediaEnginesetExternalVideoSource
IMediaPlayeradjustPlayoutVolume
IMediaPlayeradjustPublishSignalVolume
IMediaPlayergetDuration
IMediaPlayergetMediaPlayerId
IMediaPlayergetMute
IMediaPlayergetPlayPosition
IMediaPlayergetPlaySrc
IMediaPlayergetPlayoutVolume
IMediaPlayergetPublishSignalVolume
IMediaPlayergetState
IMediaPlayergetStreamCount
IMediaPlayergetStreamInfo
IMediaPlayermute
IMediaPlayeropen
IMediaPlayeropenWithMediaSource
IMediaPlayerpause
IMediaPlayerplay
IMediaPlayerplayPreloadedSrc
IMediaPlayerpreloadSrc
IMediaPlayerregisterAudioFrameObserver
IMediaPlayerregisterPlayerSourceObserver
IMediaPlayerregisterVideoFrameObserver
IMediaPlayerresume
IMediaPlayerseek
IMediaPlayerselectAudioTrack
IMediaPlayerselectMultiAudioTrack
IMediaPlayersetAudioDualMonoMode
IMediaPlayersetAudioPitch
IMediaPlayersetLoopCount
IMediaPlayersetPlaybackSpeed
IMediaPlayersetPlayerOption
IMediaPlayersetRenderMode
IMediaPlayersetSpatialAudioParams
IMediaPlayersetView
IMediaPlayerstop
IMediaPlayerswitchSrc
IMediaPlayerunloadSrc
IMediaPlayerunregisterAudioFrameObserver
IMediaPlayerunregisterPlayerSourceObserver
IMediaPlayerunregisterVideoFrameObserver
IMediaPlayerCacheManagerenableAutoRemoveCache
IMediaPlayerCacheManagergetCacheDir
IMediaPlayerCacheManagergetCacheFileCount
IMediaPlayerCacheManagergetMaxCacheFileCount
IMediaPlayerCacheManagergetMaxCacheFileSize
IMediaPlayerCacheManagerremoveAllCaches
IMediaPlayerCacheManagerremoveCacheByUri
IMediaPlayerCacheManagerremoveOldCache
IMediaPlayerCacheManagersetCacheDir
IMediaPlayerCacheManagersetMaxCacheFileCount
IMediaPlayerCacheManagersetMaxCacheFileSize
IMediaRecordersetMediaRecorderObserver
IMediaRecorderstartRecording
IMediaRecorderstopRecording
IMusicContentCentercreateMusicPlayer
IMusicContentCenterdestroyMusicPlayer
IMusicContentCentergetCaches
IMusicContentCentergetInternalSongCode
IMusicContentCentergetLyric
IMusicContentCentergetMusicCharts
IMusicContentCentergetMusicCollectionWithMusicChartId
IMusicContentCentergetSongSimpleInfo
IMusicContentCenterinitialize
IMusicContentCenterisPreloaded
IMusicContentCenterpreload
IMusicContentCenterregisterEventHandler
IMusicContentCenterrelease
IMusicContentCenterremoveCache
IMusicContentCenterrenewToken
IMusicContentCentersearchMusic
IMusicContentCenterunregisterEventHandler
IMusicPlayeropen
IMusicPlayersetPlayMode
IRtcEngineGet
IRtcEngineRelease
IRtcEngineaddVideoWatermark
IRtcEngineadjustCustomAudioPlayoutVolume
IRtcEngineadjustCustomAudioPublishVolume
IRtcEngineadjustLoopbackSignalVolume
IRtcEngineclearVideoWatermarks
IRtcEngineconfigRhythmPlayer
IRtcEnginecreateCustomVideoTrack
IRtcEnginecreateDataStream
IRtcEnginecreateMediaPlayer
IRtcEnginecreateMediaRecorder
IRtcEnginedestroyCustomVideoTrack
IRtcEnginedestroyMediaPlayer
IRtcEnginedisableAudio
IRtcEnginedisableAudioSpectrumMonitor
IRtcEnginedisableVideo
IRtcEngineenableAudioSpectrumMonitor
IRtcEngineenableCameraCenterStage
IRtcEngineenableContentInspect
IRtcEngineenableCustomAudioLocalPlayback
IRtcEngineenableEncryption
IRtcEngineenableExtension
IRtcEngineenableLocalAudio
IRtcEngineenableLocalVideo
IRtcEngineenableLoopbackRecording
IRtcEngineenableMultiCamera
IRtcEngineenableSpatialAudio
IRtcEngineenableVoiceAITuner
IRtcEnginegetCallId
IRtcEnginegetExtensionProperty
IRtcEnginegetFaceShapeAreaOptions
IRtcEnginegetFaceShapeBeautyOptions
IRtcEnginegetScreenCaptureSources
IRtcEngineloadExtensionProvider
IRtcEnginepauseAllChannelMediaRelay
IRtcEnginequeryCameraFocalLengthCapability
IRtcEnginequeryCodecCapability
IRtcEnginequeryInterface
IRtcEnginequeryScreenCaptureCapability
IRtcEngineregisterAudioEncodedFrameObserver
IRtcEngineregisterAudioSpectrumObserver
IRtcEngineregisterExtension
IRtcEngineregisterMediaMetadataObserver
IRtcEngineregisterPacketObserver
IRtcEngineresumeAllChannelMediaRelay
IRtcEnginesetAdvancedAudioOptions
IRtcEnginesetAudioSessionOperationRestriction
IRtcEnginesetCameraDeviceOrientation
IRtcEnginesetCloudProxy
IRtcEnginesetDirectCdnStreamingAudioConfiguration
IRtcEnginesetDirectCdnStreamingVideoConfiguration
IRtcEnginesetDualStreamMode
IRtcEnginesetEarMonitoringAudioFrameParameters
IRtcEnginesetExtensionProperty
IRtcEnginesetExtensionProviderProperty
IRtcEnginesetExternalAudioSink
IRtcEnginesetExternalRemoteEglContext
IRtcEnginesetFaceShapeAreaOptions
IRtcEnginesetFaceShapeBeautyOptions
IRtcEnginesetFilterEffectOptions
IRtcEnginesetLocalRenderMode
IRtcEnginesetLocalRenderTargetFps
IRtcEnginesetLocalVideoMirrorMode
IRtcEnginesetLogFile
IRtcEnginesetLogFileSize
IRtcEnginesetLogFilter
IRtcEnginesetLogLevel
IRtcEnginesetMixedAudioFrameParameters
IRtcEnginesetParameters
IRtcEnginesetPlaybackAudioFrameBeforeMixingParameters
IRtcEnginesetPlaybackAudioFrameParameters
IRtcEnginesetRecordingAudioFrameParameters
IRtcEnginesetRemoteDefaultVideoStreamType
IRtcEnginesetRemoteRenderMode
IRtcEnginesetRemoteRenderTargetFps
IRtcEnginesetRemoteSubscribeFallbackOption
IRtcEnginesetRemoteUserSpatialAudioParams
IRtcEnginesetRemoteVideoStreamType
IRtcEnginesetRemoteVideoSubscriptionOptions
IRtcEnginesetRemoteVoicePosition
IRtcEnginesetRouteInCommunicationMode
IRtcEnginesetSubscribeAudioAllowlist
IRtcEnginesetSubscribeAudioBlocklist
IRtcEnginesetSubscribeVideoAllowlist
IRtcEnginesetSubscribeVideoBlocklist
IRtcEnginesetupLocalVideo
IRtcEnginesetupRemoteVideo
IRtcEnginestartAudioRecording
IRtcEnginestartDirectCdnStreaming
IRtcEnginestartEchoTest
IRtcEnginestartLastmileProbeTest
IRtcEnginestartLocalAudioMixer
IRtcEnginestartLocalVideoTranscoder
IRtcEnginestartMediaRenderingTracing
IRtcEnginestartOrUpdateChannelMediaRelay
IRtcEnginestartRhythmPlayer
IRtcEnginestartRtmpStreamWithTranscoding
IRtcEnginestartRtmpStreamWithoutTranscoding
IRtcEnginestartScreenCapture
IRtcEnginestopAudioRecording
IRtcEnginestopChannelMediaRelay
IRtcEnginestopDirectCdnStreaming
IRtcEnginestopEchoTest
IRtcEnginestopLastmileProbeTest
IRtcEnginestopLocalAudioMixer
IRtcEnginestopLocalVideoTranscoder
IRtcEnginestopRhythmPlayer
IRtcEnginestopRtmpStream
IRtcEngineunregisterAudioSpectrumObserver
IRtcEngineunregisterMediaMetadataObserver
IRtcEngineupdateChannelMediaOptions
IRtcEngineupdateLocalAudioMixerConfiguration
IRtcEngineupdateLocalTranscoderConfiguration
IRtcEngineupdateRtmpTranscoding
IRtcEngineupdateScreenCapture
IRtcEngineExaddVideoWatermarkEx
IRtcEngineExadjustUserPlaybackSignalVolumeEx
IRtcEngineExclearVideoWatermarkEx
IRtcEngineExcreateDataStreamEx
IRtcEngineExenableAudioVolumeIndicationEx
IRtcEngineExenableContentInspectEx
IRtcEngineExenableDualStreamModeEx
IRtcEngineExenableEncryptionEx
IRtcEngineExenableLoopbackRecordingEx
IRtcEngineExgetCallIdEx
IRtcEngineExgetConnectionStateEx
IRtcEngineExjoinChannelEx
IRtcEngineExjoinChannelWithUserAccountEx
IRtcEngineExleaveChannelEx
IRtcEngineExmuteAllRemoteAudioStreamsEx
IRtcEngineExmuteAllRemoteVideoStreamsEx
IRtcEngineExmuteLocalAudioStreamEx
IRtcEngineExmuteLocalVideoStreamEx
IRtcEngineExmuteRemoteAudioStreamEx
IRtcEngineExmuteRemoteVideoStreamEx
IRtcEngineExpauseAllChannelMediaRelayEx
IRtcEngineExresumeAllChannelMediaRelayEx
IRtcEngineExsendCustomReportMessageEx
IRtcEngineExsendStreamMessageEx
IRtcEngineExsetDualStreamModeEx
IRtcEngineExsetRemoteRenderModeEx
IRtcEngineExsetRemoteVideoStreamTypeEx
IRtcEngineExsetRemoteVideoSubscriptionOptionsEx
IRtcEngineExsetRemoteVoicePositionEx
IRtcEngineExsetSubscribeAudioAllowlistEx
IRtcEngineExsetSubscribeAudioBlocklistEx
IRtcEngineExsetSubscribeVideoAllowlistEx
IRtcEngineExsetSubscribeVideoBlocklistEx
IRtcEngineExsetVideoEncoderConfigurationEx
IRtcEngineExsetupRemoteVideoEx
IRtcEngineExstartMediaRenderingTracingEx
IRtcEngineExstartOrUpdateChannelMediaRelayEx
IRtcEngineExstartRtmpStreamWithTranscodingEx
IRtcEngineExstartRtmpStreamWithoutTranscodingEx
IRtcEngineExstopChannelMediaRelayEx
IRtcEngineExstopRtmpStreamEx
IRtcEngineExtakeSnapshotEx
IRtcEngineExupdateChannelMediaOptionsEx
IRtcEngineExupdateRtmpTranscodingEx
IScreenCaptureSourceListgetCount
IScreenCaptureSourceListgetSourceInfo
IScreenCaptureSourceListrelease
IVideoDeviceCollectiongetCount
IVideoDeviceCollectionrelease
IVideoDeviceManagerenumerateVideoDevices
IVideoDeviceManagergetCapability
IVideoDeviceManagernumberOfCapabilities
IVideoDeviceManagerrelease
VideoCanvasview
__unattributed__destroyMediaRecorder
__unattributed__get
__unattributed__getCount
__unattributed__getMusic
__unattributed__getPage
__unattributed__getPageSize
__unattributed__getPlaybackDeviceVolume
__unattributed__getTotal
__unattributed__onPlaybackAudioFrameBeforeMixing
__unattributed__setExternalMediaProjection
__unattributed__setLocalAccessPoint
__unattributed__startAudioRecording

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

内容依据公开 API 定义.

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