nimeet 文档中心
English

Unity(C#) API 参考

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

由公开 SDK 接口定义生成

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

接口概览

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

核对项数量
接口 / 类140
方法588
方法重载617
属性637
枚举148
错误码常量48

可用性

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

加入频道核心链路

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

步骤接口方法重载数
订阅远端媒体IBaseSpatialAudioEngineMuteRemoteAudioStream1
创建 / 初始化ILocalSpatialAudioEngineInitialize1
续期 TokenIMusicContentCenterRenewToken1
开启视频与预览IRtcEngineEnableVideo1
加入频道IRtcEngineJoinChannel2
离开频道IRtcEngineLeaveChannel2
频道场景IRtcEngineSetChannelProfile1
角色切换IRtcEngineSetClientRole2
本地画面IRtcEngineSetupLocalVideo1

最小可运行链路的参数

参数类型可选可变参数
uiduint否否
mutebool否否
tokenstring否否
tokenstring否否
channelIdstring否否
infostring是否
uiduint是否
tokenstring否否
channelIdstring否否
uiduint否否
optionsChannelMediaOptions否否
optionsLeaveChannelOptions否否
profileCHANNEL_PROFILE_TYPE否否
roleCLIENT_ROLE_TYPE否否
roleCLIENT_ROLE_TYPE否否
optionsClientRoleOptions否否
canvasVideoCanvas否否

接口索引

接口方法属性事件
AdvancedAudioOptions010
AdvancedConfigInfo010
AdvanceOptions030
AgoraRhythmPlayerConfig020
AudioEncodedFrameObserverConfig020
AudioFileRecordingConfig060
AudioFrame080
AudioParams040
AudioPcmFrame060
AudioSpectrumData020
AudioTrackConfig020
AudioVolumeInfo040
BeautyOptions050
CacheStatistics030
CameraCapturerConfiguration060
ChannelMediaInfo030
ChannelMediaOptions0360
ChannelMediaRelayConfiguration030
ClientRoleOptions010
ClimaxSegment020
CodecCapInfo030
CodecCapLevels020
ColorEnhanceOptions020
ContentInspectConfig040
ContentInspectModule030
DataStreamConfig020
DeviceInfo020
DeviceInfoMobile010
EchoTestConfiguration060
EncodedAudioFrameInfo060
EncodedVideoFrameInfo090
EncryptionConfig040
ExtensionContext040
ExternalVideoFrame0220
FaceShapeAreaOptions020
FaceShapeBeautyOptions020
FilterEffectOptions110
FocalLengthInfo020
IAgoraParameter100
IAudioDeviceManager2800
IAudioEncodedFrameObserver300
IAudioFrameObserver100
IAudioFrameObserverBase400
IAudioPcmFrameSink100
IAudioSpectrumObserver200
IBaseSpatialAudioEngine1000
ILocalSpatialAudioEngine600
ImageTrackOptions020
IMediaEngine1500
IMediaPlayer4000
IMediaPlayerCacheManager1200
IMediaPlayerCustomDataProvider200
IMediaPlayerSourceObserver1100
IMediaRecorder300
IMediaRecorderObserver200
IMetadataObserver200
IMusicContentCenter1600
IMusicContentCenterEventHandler500
IMusicPlayer200
IRtcEngine26600
IRtcEngineEventHandler8700
IRtcEngineEx4700
IVideoDeviceManager500
IVideoEffectObject900
IVideoEncodedFrameObserver100
IVideoFrameObserver300
LastmileProbeConfig040
LastmileProbeOneWayResult030
LastmileProbeResult040
LeaveChannelOptions030
LiveStreamAdvancedFeature020
LiveTranscoding0230
LocalAccessPointConfiguration070
LocalAudioMixerConfiguration030
LocalAudioStats080
LocalSpatialAudioConfig010
LocalTranscoderConfiguration030
LocalVideoStats0220
LogConfig030
LogUploadServerInfo040
LowlightEnhanceOptions020
MediaRecorderConfiguration0110
MediaSource090
Metadata050
MultipathStats080
Music0120
MusicCacheInfo020
MusicChartInfo020
MusicCollection050
MusicContentCenterConfiguration040
PathStats030
PlayerPlaybackStats040
PlayerStreamInfo0130
PlayerUpdatedInfo060
RecorderInfo030
RecorderStreamInfo030
Rectangle040
RemoteAudioStats0160
RemoteVideoStats0170
RemoteVoicePositionInfo020
RtcConnection020
RtcEngineContext090
RtcImage070
RtcStats0240
ScreenAudioParameters030
ScreenCaptureConfiguration060
ScreenCaptureParameters0100
ScreenCaptureParameters2040
ScreenCaptureSourceInfo0100
ScreenVideoParameters040
SegmentationProperty030
SimulcastStreamConfig030
SnapshotConfig020
SpatialAudioParams080
SpatialAudioZone090
SrcInfo020
ThumbImageBuffer040
TranscodingUser080
TranscodingVideoStream0110
UplinkNetworkInfo010
UserAudioSpectrumInfo020
UserInfo020
VideoCanvas0120
VideoDenoiserOptions020
VideoDimensions020
VideoEncoderConfiguration090
VideoFormat030
VideoFrame0220
VideoFrameBufferConfig030
VideoLayout080
VideoRenderingTracingInfo070
VideoSubscriptionOptions020
VideoSurface300
VirtualBackgroundSource040
WatermarkBuffer050
WatermarkConfig070
WatermarkLiteral040
WatermarkOptions060
WatermarkRatio030
WatermarkTimestamp040

全部接口

AdvancedAudioOptions 0 方法 / 1 属性
属性类型只读
audioProcessingChannelsOptional否
AdvancedConfigInfo 0 方法 / 1 属性
属性类型只读
logUploadServerunknown否
AdvanceOptions 0 方法 / 3 属性
属性类型只读
encodingPreferenceENCODING_PREFERENCE否
compressionPreferenceCOMPRESSION_PREFERENCE否
encodeAlphabool否
AgoraRhythmPlayerConfig 0 方法 / 2 属性
属性类型只读
beatsPerMeasureint否
beatsPerMinuteint否
AudioEncodedFrameObserverConfig 0 方法 / 2 属性
属性类型只读
postionTypeAUDIO_ENCODED_FRAME_OBSERVER_POSITION否
encodingTypeAUDIO_ENCODING_TYPE否
AudioFileRecordingConfig 0 方法 / 6 属性
属性类型只读
filePathstring否
encodebool否
sampleRateint否
fileRecordingTypeAUDIO_FILE_RECORDING_TYPE否
qualityAUDIO_RECORDING_QUALITY_TYPE否
recordingChannelint否
AudioFrame 0 方法 / 8 属性
属性类型只读
typeAUDIO_FRAME_TYPE否
samplesPerChannelint否
bytesPerSampleBYTES_PER_SAMPLE否
channelsint否
samplesPerSecint否
RawBufferbyte[]否
renderTimeMslong否
avsync_typeint否
AudioParams 0 方法 / 4 属性
属性类型只读
sample_rateint否
channelsint否
modeRAW_AUDIO_FRAME_OP_MODE_TYPE否
samples_per_callint否
AudioPcmFrame 0 方法 / 6 属性
属性类型只读
capture_timestampUInt32否
samples_per_channel_UInt64否
sample_rate_hz_int否
num_channels_UInt64否
bytes_per_sampleBYTES_PER_SAMPLE否
data_Int16[]否
AudioSpectrumData 0 方法 / 2 属性
属性类型只读
audioSpectrumDatafloat[]否
dataLengthint否
AudioTrackConfig 0 方法 / 2 属性
属性类型只读
enableLocalPlaybackbool否
enableAudioProcessingbool否
AudioVolumeInfo 0 方法 / 4 属性
属性类型只读
uiduint否
volumeuint否
vaduint否
voicePitchdouble否
BeautyOptions 0 方法 / 5 属性
属性类型只读
lighteningContrastLevelLIGHTENING_CONTRAST_LEVEL否
lighteningLevelfloat否
smoothnessLevelfloat否
rednessLevelfloat否
sharpnessLevelfloat否
CacheStatistics 0 方法 / 3 属性
属性类型只读
fileSizeInt64否
cacheSizeInt64否
downloadSizeInt64否
CameraCapturerConfiguration 0 方法 / 6 属性
属性类型只读
cameraDirectionOptional否
cameraIdOptional否
cameraFocalLengthTypeOptional否
formatVideoFormat否
deviceIdOptional否
followEncodeDimensionRatioOptional否
ChannelMediaInfo 0 方法 / 3 属性
属性类型只读
channelNamestring否
tokenstring否
uiduint否
ChannelMediaOptions 0 方法 / 36 属性
属性类型只读
publishCameraTrackOptional否
publishSecondaryCameraTrackOptional否
publishMicrophoneTrackOptional否
publishThirdCameraTrackOptional否
publishFourthCameraTrackOptional否
publishScreenTrackOptional否
publishScreenCaptureVideoOptional否
publishScreenCaptureAudioOptional否
publishSecondaryScreenTrackOptional否
publishThirdScreenTrackOptional否
publishFourthScreenTrackOptional否
publishTranscodedVideoTrackOptional否
publishMixedAudioTrackunknown否
publishLipSyncTrackOptional否
publishCustomAudioTrackOptional否
publishCustomAudioTrackIdOptional否
publishCustomVideoTrackOptional否
publishEncodedVideoTrackOptional否
publishMediaPlayerAudioTrackOptional否
publishMediaPlayerVideoTrackOptional否
autoSubscribeAudioOptional否
autoSubscribeVideoOptional否
enableAudioRecordingOrPlayoutOptional否
publishMediaPlayerIdOptional否
clientRoleTypeOptional否
audienceLatencyLevelOptional否
defaultVideoStreamTypeOptional否
channelProfileOptional否
audioDelayMsunknown否
tokenOptional否
publishRhythmPlayerTrackOptional否
isInteractiveAudienceOptional否
customVideoTrackIdOptional否
isAudioFilterableOptional否
enableMultipathOptional否
preferMultipathTypeOptional否
ChannelMediaRelayConfiguration 0 方法 / 3 属性
属性类型只读
srcInfoChannelMediaInfo否
destInfosChannelMediaInfo[]否
destCountint否
ClientRoleOptions 0 方法 / 1 属性
属性类型只读
audienceLatencyLevelAUDIENCE_LATENCY_LEVEL_TYPE否
ClimaxSegment 0 方法 / 2 属性
属性类型只读
startTimeMsint否
endTimeMsint否
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 属性
属性类型只读
extraInfostring否
serverConfigstring否
modulesContentInspectModule[]否
moduleCountint否
ContentInspectModule 0 方法 / 3 属性
属性类型只读
typeCONTENT_INSPECT_TYPE否
intervaluint否
positionVIDEO_MODULE_POSITION否
DataStreamConfig 0 方法 / 2 属性
属性类型只读
syncWithAudiobool否
orderedbool否
DeviceInfo 0 方法 / 2 属性
属性类型只读
deviceIdstring否
deviceNamestring否
DeviceInfoMobile 0 方法 / 1 属性
属性类型只读
isLowLatencyAudioSupportedbool否
EchoTestConfiguration 0 方法 / 6 属性
属性类型只读
viewview_t否
enableAudiobool否
enableVideobool否
tokenstring否
channelIdstring否
intervalInSecondsint否
EncodedAudioFrameInfo 0 方法 / 6 属性
属性类型只读
codecAUDIO_CODEC_TYPE否
sampleRateHzint否
samplesPerChannelint否
numberOfChannelsint否
advancedSettingsEncodedAudioFrameAdvancedSettings否
captureTimeMsint64_t否
EncodedVideoFrameInfo 0 方法 / 9 属性
属性类型只读
codecTypeVIDEO_CODEC_TYPE否
widthint否
heightint否
framesPerSecondint否
frameTypeVIDEO_FRAME_TYPE_NATIVE否
rotationVIDEO_ORIENTATION否
trackIdint否
captureTimeMsint64_t否
streamTypeVIDEO_STREAM_TYPE否
EncryptionConfig 0 方法 / 4 属性
属性类型只读
encryptionModeENCRYPTION_MODE否
encryptionKeystring否
encryptionKdfSaltbyte[]否
datastreamEncryptionEnabledbool否
ExtensionContext 0 方法 / 4 属性
属性类型只读
isValidbool否
uiduint否
providerNamestring否
extensionNamestring否
ExternalVideoFrame 0 方法 / 22 属性
属性类型只读
typeVIDEO_BUFFER_TYPE否
formatVIDEO_PIXEL_FORMAT否
bufferbyte[]否
strideint否
heightint否
eglContextbyte[]否
eglTypeEGL_CONTEXT_TYPE否
textureIdint否
metadataBufferbyte[]否
metadataSizeint否
d3d11Texture2dIntPtr否
alphaBufferbyte[]否
fillAlphaBufferbool否
alphaStitchModeALPHA_STITCH_MODE否
textureSliceIndexint否
cropLeftint否
cropTopint否
cropRightint否
cropBottomint否
rotationint否
timestamplong否
colorSpaceColorSpace否
FaceShapeAreaOptions 0 方法 / 2 属性
属性类型只读
shapeAreaunknown否
shapeIntensityunknown否
FaceShapeBeautyOptions 0 方法 / 2 属性
属性类型只读
shapeStyleFACE_SHAPE_BEAUTY_STYLE否
styleIntensityint否
FilterEffectOptions 1 方法 / 1 属性
typescript
path(): unknown

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

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

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

方法参数返回值错误
SetParametersparameters: stringint错误码索引
IAudioDeviceManager 28 方法 / 0 属性
typescript
EnumeratePlaybackDevices(): DeviceInfo[]
EnumerateRecordingDevices(): DeviceInfo[]
FollowSystemLoopbackDevice(enable: bool): int
FollowSystemPlaybackDevice(enable: bool): int
FollowSystemRecordingDevice(enable: bool): int
GetLoopbackDevice(deviceId: string): int
GetPlaybackDefaultDevice(deviceId: string, deviceName: string): int
GetPlaybackDefaultDevice(deviceId: string, deviceTypeName: string, deviceName: string): int
GetPlaybackDevice(deviceId: string): int
GetPlaybackDeviceInfo(deviceId: string, deviceName: string): int
GetPlaybackDeviceInfo(deviceId: string, deviceName: string, deviceTypeName: string): int
GetPlaybackDeviceVolume(): int
GetRecordingDefaultDevice(deviceId: string, deviceName: string): int
GetRecordingDefaultDevice(deviceId: string, deviceTypeName: string, deviceName: string): int
GetRecordingDevice(deviceId: string): int
GetRecordingDeviceInfo(deviceId: string, deviceName: string): int
GetRecordingDeviceInfo(deviceId: string, deviceName: string, deviceTypeName: string): int
GetRecordingDeviceMute(): bool
GetRecordingDeviceVolume(): int
SetLoopbackDevice(deviceId: string): int
SetPlaybackDevice(deviceId: string): int
SetPlaybackDeviceMute(mute: bool): int
SetPlaybackDeviceVolume(volume: int): int
SetRecordingDevice(deviceId: string): int
SetRecordingDeviceMute(mute: bool): int
SetRecordingDeviceVolume(volume: int): int
StartAudioDeviceLoopbackTest(indicationInterval: int): int
StartPlaybackDeviceTest(testAudioFilePath: string): int
StartRecordingDeviceTest(indicationInterval: int): int
StopAudioDeviceLoopbackTest(): int
StopPlaybackDeviceTest(): int
StopRecordingDeviceTest(): int

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

方法参数返回值错误
EnumeratePlaybackDevices—DeviceInfo[]错误码索引
EnumerateRecordingDevices—DeviceInfo[]错误码索引
FollowSystemLoopbackDeviceenable: boolint错误码索引
FollowSystemPlaybackDeviceenable: boolint错误码索引
FollowSystemRecordingDeviceenable: boolint错误码索引
GetLoopbackDevicedeviceId: stringint错误码索引
GetPlaybackDefaultDevicedeviceId: string, deviceName: stringint错误码索引
GetPlaybackDevicedeviceId: stringint错误码索引
GetPlaybackDeviceInfodeviceId: string, deviceName: stringint错误码索引
GetPlaybackDeviceVolume—int错误码索引
GetRecordingDefaultDevicedeviceId: string, deviceName: stringint错误码索引
GetRecordingDevicedeviceId: stringint错误码索引
GetRecordingDeviceInfodeviceId: string, deviceName: stringint错误码索引
GetRecordingDeviceMute—bool错误码索引
GetRecordingDeviceVolume—int错误码索引
SetLoopbackDevicedeviceId: stringint错误码索引
SetPlaybackDevicedeviceId: stringint错误码索引
SetPlaybackDeviceMutemute: boolint错误码索引
SetPlaybackDeviceVolumevolume: intint错误码索引
SetRecordingDevicedeviceId: stringint错误码索引
SetRecordingDeviceMutemute: boolint错误码索引
SetRecordingDeviceVolumevolume: intint错误码索引
StartAudioDeviceLoopbackTestindicationInterval: intint错误码索引
StartPlaybackDeviceTesttestAudioFilePath: stringint错误码索引
StartRecordingDeviceTestindicationInterval: intint错误码索引
StopAudioDeviceLoopbackTest—int错误码索引
StopPlaybackDeviceTest—int错误码索引
StopRecordingDeviceTest—int错误码索引
IAudioEncodedFrameObserver 3 方法 / 0 属性
typescript
OnMixedAudioEncodedFrame(frameBufferPtr: IntPtr, length: int, audioEncodedFrameInfo: EncodedAudioFrameInfo): void
OnPlaybackAudioEncodedFrame(frameBufferPtr: IntPtr, length: int, audioEncodedFrameInfo: EncodedAudioFrameInfo): void
OnRecordAudioEncodedFrame(frameBufferPtr: IntPtr, length: int, audioEncodedFrameInfo: EncodedAudioFrameInfo): void

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

方法参数返回值错误
OnMixedAudioEncodedFrameframeBufferPtr: IntPtr, length: int, audioEncodedFrameInfo: EncodedAudioFrameInfovoid错误码索引
OnPlaybackAudioEncodedFrameframeBufferPtr: IntPtr, length: int, audioEncodedFrameInfo: EncodedAudioFrameInfovoid错误码索引
OnRecordAudioEncodedFrameframeBufferPtr: IntPtr, length: int, audioEncodedFrameInfo: EncodedAudioFrameInfovoid错误码索引
IAudioFrameObserver 1 方法 / 0 属性
typescript
OnPlaybackAudioFrameBeforeMixing(channel_id: string, uid: uint, audio_frame: AudioFrame): bool

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

方法参数返回值错误
OnPlaybackAudioFrameBeforeMixingchannel_id: string, uid: uint, audio_frame: AudioFramebool错误码索引
IAudioFrameObserverBase 4 方法 / 0 属性
typescript
OnEarMonitoringAudioFrame(audioFrame: AudioFrame): bool
OnMixedAudioFrame(channelId: string, audio_frame: AudioFrame): bool
OnPlaybackAudioFrame(channelId: string, audio_frame: AudioFrame): bool
OnRecordAudioFrame(channelId: string, audioFrame: AudioFrame): bool

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

方法参数返回值错误
OnEarMonitoringAudioFrameaudioFrame: AudioFramebool错误码索引
OnMixedAudioFramechannelId: string, audio_frame: AudioFramebool错误码索引
OnPlaybackAudioFramechannelId: string, audio_frame: AudioFramebool错误码索引
OnRecordAudioFramechannelId: string, audioFrame: AudioFramebool错误码索引
IAudioPcmFrameSink 1 方法 / 0 属性
typescript
OnFrame(frame: AudioPcmFrame): bool

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

方法参数返回值错误
OnFrameframe: AudioPcmFramebool错误码索引
IAudioSpectrumObserver 2 方法 / 0 属性
typescript
OnLocalAudioSpectrum(data: AudioSpectrumData): bool
OnRemoteAudioSpectrum(spectrums: UserAudioSpectrumInfo[], spectrumNumber: uint): bool

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

方法参数返回值错误
OnLocalAudioSpectrumdata: AudioSpectrumDatabool错误码索引
OnRemoteAudioSpectrumspectrums: UserAudioSpectrumInfo[], spectrumNumber: uintbool错误码索引
IBaseSpatialAudioEngine 10 方法 / 0 属性
typescript
MuteAllRemoteAudioStreams(mute: bool): int
MuteLocalAudioStream(mute: bool): int
MuteRemoteAudioStream(uid: uint, mute: bool): int
SetAudioRecvRange(range: float): int
SetDistanceUnit(unit: float): int
SetMaxAudioRecvCount(maxCount: int): int
SetPlayerAttenuation(playerId: int, attenuation: double, forceSet: bool): int
SetZones(zones: SpatialAudioZone[], zoneCount: uint): int
UpdatePlayerPositionInfo(playerId: int, positionInfo: RemoteVoicePositionInfo): int
UpdateSelfPosition(position: float[], axisForward: float[], axisRight: float[], axisUp: float[]): int

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

方法参数返回值错误
MuteAllRemoteAudioStreamsmute: boolint错误码索引
MuteLocalAudioStreammute: boolint错误码索引
MuteRemoteAudioStreamuid: uint, mute: boolint错误码索引
SetAudioRecvRangerange: floatint错误码索引
SetDistanceUnitunit: floatint错误码索引
SetMaxAudioRecvCountmaxCount: intint错误码索引
SetPlayerAttenuationplayerId: int, attenuation: double, forceSet: boolint错误码索引
SetZoneszones: SpatialAudioZone[], zoneCount: uintint错误码索引
UpdatePlayerPositionInfoplayerId: int, positionInfo: RemoteVoicePositionInfoint错误码索引
UpdateSelfPositionposition: float[], axisForward: float[], axisRight: float[], axisUp: float[]int错误码索引
ILocalSpatialAudioEngine 6 方法 / 0 属性
typescript
ClearRemotePositions(): int
Dispose(): void
Initialize(): int
RemoveRemotePosition(uid: uint): int
SetRemoteAudioAttenuation(uid: uint, attenuation: double, forceSet: bool): int
UpdateRemotePosition(uid: uint, posInfo: RemoteVoicePositionInfo): int

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

方法参数返回值错误
ClearRemotePositions—int错误码索引
Dispose—void错误码索引
Initialize—int错误码索引
RemoveRemotePositionuid: uintint错误码索引
SetRemoteAudioAttenuationuid: uint, attenuation: double, forceSet: boolint错误码索引
UpdateRemotePositionuid: uint, posInfo: RemoteVoicePositionInfoint错误码索引
ImageTrackOptions 0 方法 / 2 属性
属性类型只读
imageUrlstring否
fpsint否
IMediaEngine 15 方法 / 0 属性
typescript
CreateCustomAudioTrack(trackType: AUDIO_TRACK_TYPE, config: AudioTrackConfig): uint
DestroyCustomAudioTrack(trackId: uint): int
PullAudioFrame(frame: AudioFrame): int
PushAudioFrame(frame: AudioFrame, trackId?: uint): int
PushVideoFrame(frame: ExternalVideoFrame, videoTrackId?: uint): int
RegisterAudioFrameObserver(audioFrameObserver: IAudioFrameObserver, position: AUDIO_FRAME_POSITION, mode?: OBSERVER_MODE): int
RegisterFaceInfoObserver(observer: IFaceInfoObserver): int
RegisterVideoEncodedFrameObserver(videoEncodedImageReceiver: IVideoEncodedFrameObserver, mode?: OBSERVER_MODE): int
RegisterVideoFrameObserver(videoFrameObserver: IVideoFrameObserver, formatPreference: VIDEO_OBSERVER_FRAME_TYPE, position: VIDEO_OBSERVER_POSITION, mode?: OBSERVER_MODE): int
SetExternalAudioSink(enabled: bool, sampleRate: int, channels: int): int
SetExternalAudioSource(enabled: bool, sampleRate: int, channels: int, localPlayback?: bool, publish?: bool): int
SetExternalVideoSource(enabled: bool, useTexture: bool, sourceType: EXTERNAL_VIDEO_SOURCE_TYPE, encodedVideoOption: SenderOptions): int
UnregisterFaceInfoObserver(): int
UnregisterVideoEncodedFrameObserver(): int
UnregisterVideoFrameObserver(): int

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

方法参数返回值错误
CreateCustomAudioTracktrackType: AUDIO_TRACK_TYPE, config: AudioTrackConfiguint错误码索引
DestroyCustomAudioTracktrackId: uintint错误码索引
PullAudioFrameframe: AudioFrameint错误码索引
PushAudioFrameframe: AudioFrame, trackId?: uintint错误码索引
PushVideoFrameframe: ExternalVideoFrame, videoTrackId?: uintint错误码索引
RegisterAudioFrameObserveraudioFrameObserver: IAudioFrameObserver, position: AUDIO_FRAME_POSITION, mode?: OBSERVER_MODEint错误码索引
RegisterFaceInfoObserverobserver: IFaceInfoObserverint错误码索引
RegisterVideoEncodedFrameObservervideoEncodedImageReceiver: IVideoEncodedFrameObserver, mode?: OBSERVER_MODEint错误码索引
RegisterVideoFrameObservervideoFrameObserver: IVideoFrameObserver, formatPreference: VIDEO_OBSERVER_FRAME_TYPE, position: VIDEO_OBSERVER_POSITION, mode?: OBSERVER_MODEint错误码索引
SetExternalAudioSinkenabled: bool, sampleRate: int, channels: intint错误码索引
SetExternalAudioSourceenabled: bool, sampleRate: int, channels: int, localPlayback?: bool, publish?: boolint错误码索引
SetExternalVideoSourceenabled: bool, useTexture: bool, sourceType: EXTERNAL_VIDEO_SOURCE_TYPE, encodedVideoOption: SenderOptionsint错误码索引
UnregisterFaceInfoObserver—int错误码索引
UnregisterVideoEncodedFrameObserver—int错误码索引
UnregisterVideoFrameObserver—int错误码索引
IMediaPlayer 40 方法 / 0 属性
typescript
AdjustPlayoutVolume(volume: int): int
AdjustPublishSignalVolume(volume: int): int
Dispose(): void
GetAudioBufferDelay(): int
GetDuration(duration: Int64): int
GetId(): int
GetMute(muted: bool): int
GetPlayPosition(pos: Int64): int
GetPlaySrc(): string
GetPlayoutVolume(volume: int): int
GetPublishSignalVolume(volume: int): int
GetState(): MEDIA_PLAYER_STATE
GetStreamCount(count: Int64): int
GetStreamInfo(index: Int64, info: PlayerStreamInfo): int
InitEventHandler(engineEventHandler: IMediaPlayerSourceObserver): int
Mute(muted: bool): int
Open(url: string, startPos: Int64): int
OpenWithMediaSource(source: MediaSource): int
Pause(): int
Play(): int
PlayPreloadedSrc(src: string): int
PreloadSrc(src: string, startPos: Int64): int
RegisterAudioFrameObserver(observer: IAudioPcmFrameSink): int
RegisterAudioFrameObserver(observer: IAudioPcmFrameSink, mode: RAW_AUDIO_FRAME_OP_MODE_TYPE): int
Resume(): int
Seek(newPos: Int64): int
SelectAudioTrack(index: int): int
SelectMultiAudioTrack(playoutTrackIndex: int, publishTrackIndex: int): int
SetAudioDualMonoMode(mode: AUDIO_DUAL_MONO_MODE): int
SetAudioPitch(pitch: int): int
SetLoopCount(loopCount: int): int
SetPlaybackSpeed(speed: int): int
SetPlayerOption(key: string, value: int): int
SetRenderMode(renderMode: RENDER_MODE_TYPE): int
SetSpatialAudioParams(spatial_audio_params: SpatialAudioParams): int
SetView(): int
Stop(): int
SwitchSrc(src: string, syncPts?: bool): int
UnloadSrc(src: string): int
UnregisterAudioFrameObserver(): int
setPlayerOption(key: string, value: string): int

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

方法参数返回值错误
AdjustPlayoutVolumevolume: intint错误码索引
AdjustPublishSignalVolumevolume: intint错误码索引
Dispose—void错误码索引
GetAudioBufferDelay—int错误码索引
GetDurationduration: Int64int错误码索引
GetId—int错误码索引
GetMutemuted: boolint错误码索引
GetPlayPositionpos: Int64int错误码索引
GetPlaySrc—string错误码索引
GetPlayoutVolumevolume: intint错误码索引
GetPublishSignalVolumevolume: intint错误码索引
GetState—MEDIA_PLAYER_STATE错误码索引
GetStreamCountcount: Int64int错误码索引
GetStreamInfoindex: Int64, info: PlayerStreamInfoint错误码索引
InitEventHandlerengineEventHandler: IMediaPlayerSourceObserverint错误码索引
Mutemuted: boolint错误码索引
Openurl: string, startPos: Int64int错误码索引
OpenWithMediaSourcesource: MediaSourceint错误码索引
Pause—int错误码索引
Play—int错误码索引
PlayPreloadedSrcsrc: stringint错误码索引
PreloadSrcsrc: string, startPos: Int64int错误码索引
RegisterAudioFrameObserverobserver: IAudioPcmFrameSinkint错误码索引
Resume—int错误码索引
SeeknewPos: Int64int错误码索引
SelectAudioTrackindex: intint错误码索引
SelectMultiAudioTrackplayoutTrackIndex: int, publishTrackIndex: intint错误码索引
SetAudioDualMonoModemode: AUDIO_DUAL_MONO_MODEint错误码索引
SetAudioPitchpitch: intint错误码索引
SetLoopCountloopCount: intint错误码索引
SetPlaybackSpeedspeed: intint错误码索引
SetPlayerOptionkey: string, value: intint错误码索引
SetRenderModerenderMode: RENDER_MODE_TYPEint错误码索引
SetSpatialAudioParamsspatial_audio_params: SpatialAudioParamsint错误码索引
SetView—int错误码索引
Stop—int错误码索引
SwitchSrcsrc: string, syncPts?: boolint错误码索引
UnloadSrcsrc: stringint错误码索引
UnregisterAudioFrameObserver—int错误码索引
setPlayerOptionkey: string, value: stringint错误码索引
IMediaPlayerCacheManager 12 方法 / 0 属性
typescript
EnableAutoRemoveCache(enable: bool): int
GetCacheDir(path: string, length: int): int
GetCacheFileCount(): int
GetMaxCacheFileCount(): int
GetMaxCacheFileSize(): Int64
GetMediaPlayerCacheManager(): IMediaPlayerCacheManager
RemoveAllCaches(): int
RemoveCacheByUri(uri: string): int
RemoveOldCache(): int
SetCacheDir(path: string): int
SetMaxCacheFileCount(count: int): int
SetMaxCacheFileSize(cacheSize: Int64): int

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

方法参数返回值错误
EnableAutoRemoveCacheenable: boolint错误码索引
GetCacheDirpath: string, length: intint错误码索引
GetCacheFileCount—int错误码索引
GetMaxCacheFileCount—int错误码索引
GetMaxCacheFileSize—Int64错误码索引
GetMediaPlayerCacheManager—IMediaPlayerCacheManager错误码索引
RemoveAllCaches—int错误码索引
RemoveCacheByUriuri: stringint错误码索引
RemoveOldCache—int错误码索引
SetCacheDirpath: stringint错误码索引
SetMaxCacheFileCountcount: intint错误码索引
SetMaxCacheFileSizecacheSize: Int64int错误码索引
IMediaPlayerCustomDataProvider 2 方法 / 0 属性
typescript
OnReadData(bufferPtr: IntPtr, bufferSize: int): int
OnSeek(offset: Int64, whence: int): Int64

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

方法参数返回值错误
OnReadDatabufferPtr: IntPtr, bufferSize: intint错误码索引
OnSeekoffset: Int64, whence: intInt64错误码索引
IMediaPlayerSourceObserver 11 方法 / 0 属性
typescript
OnMetaData(data: byte[], length: int): void
OnPlayBufferUpdated(playCachedBuffer: Int64): void
OnPlayerCacheStats(stats: CacheStatistics): void
OnPlayerEvent(eventCode: MEDIA_PLAYER_EVENT, elapsedTime: Int64, message: string): void
OnPlayerInfoUpdated(info: PlayerUpdatedInfo): void
OnPlayerPlaybackStats(stats: PlayerPlaybackStats): void
OnPlayerSourceStateChanged(state: MEDIA_PLAYER_STATE, reason: MEDIA_PLAYER_REASON): void
OnPlayerSrcInfoChanged(from: SrcInfo, to: SrcInfo): void
OnPositionChanged(positionMs: long, timestampMs: long): void
OnPreloadEvent(src: string, null: PLAYER_PRELOAD_EVENT): void
onAudioVolumeIndication(volume: int): void

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

方法参数返回值错误
OnMetaDatadata: byte[], length: intvoid错误码索引
OnPlayBufferUpdatedplayCachedBuffer: Int64void错误码索引
OnPlayerCacheStatsstats: CacheStatisticsvoid错误码索引
OnPlayerEventeventCode: MEDIA_PLAYER_EVENT, elapsedTime: Int64, message: stringvoid错误码索引
OnPlayerInfoUpdatedinfo: PlayerUpdatedInfovoid错误码索引
OnPlayerPlaybackStatsstats: PlayerPlaybackStatsvoid错误码索引
OnPlayerSourceStateChangedstate: MEDIA_PLAYER_STATE, reason: MEDIA_PLAYER_REASONvoid错误码索引
OnPlayerSrcInfoChangedfrom: SrcInfo, to: SrcInfovoid错误码索引
OnPositionChangedpositionMs: long, timestampMs: longvoid错误码索引
OnPreloadEventsrc: string, null: PLAYER_PRELOAD_EVENTvoid错误码索引
onAudioVolumeIndicationvolume: intvoid错误码索引
IMediaRecorder 3 方法 / 0 属性
typescript
SetMediaRecorderObserver(callback: IMediaRecorderObserver): int
StartRecording(config: MediaRecorderConfiguration): int
StopRecording(): int

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

方法参数返回值错误
SetMediaRecorderObservercallback: IMediaRecorderObserverint错误码索引
StartRecordingconfig: MediaRecorderConfigurationint错误码索引
StopRecording—int错误码索引
IMediaRecorderObserver 2 方法 / 0 属性
typescript
OnRecorderInfoUpdated(channelId: string, uid: uint, info: RecorderInfo): void
OnRecorderStateChanged(channelId: string, uid: uint, state: RecorderState, reason: RecorderReasonCode): void

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

方法参数返回值错误
OnRecorderInfoUpdatedchannelId: string, uid: uint, info: RecorderInfovoid错误码索引
OnRecorderStateChangedchannelId: string, uid: uint, state: RecorderState, reason: RecorderReasonCodevoid错误码索引
IMetadataObserver 2 方法 / 0 属性
typescript
OnMetadataReceived(metadata: Metadata): void
OnReadyToSendMetadata(metadata: Metadata, source_type: VIDEO_SOURCE_TYPE): bool

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

方法参数返回值错误
OnMetadataReceivedmetadata: Metadatavoid错误码索引
OnReadyToSendMetadatametadata: Metadata, source_type: VIDEO_SOURCE_TYPEbool错误码索引
IMusicContentCenter 16 方法 / 0 属性
typescript
CreateMusicPlayer(): IMusicPlayer
DestroyMusicPlayer(music_player: IMusicPlayer): int
GetCaches(cacheInfo: MusicCacheInfo[], cacheInfoSize: Int32): int
GetInternalSongCode(songCode: Int64, jsonOption: string, internalSongCode: Int64): int
GetLyric(requestId: string, songCode: Int64, LyricType?: int): int
GetMusicCharts(requestId: string): int
GetMusicCollectionByMusicChartId(requestId: string, musicChartType: int, page: int, pageSize: int, jsonOption?: string): int
GetSongSimpleInfo(requestId: string, songCode: Int64): int
Initialize(configuration: MusicContentCenterConfiguration): int
IsPreloaded(songCode: Int64): int
Preload(songCode: Int64, jsonOption?: string): int
Preload(requestId: string, songCode: Int64): int
RegisterEventHandler(eventHandler: IMusicContentCenterEventHandler): int
RemoveCache(songCode: Int64): int
RenewToken(token: string): int
SearchMusic(requestId: string, keyWord: string, page: int, pageSize: int, jsonOption?: string): int
UnregisterEventHandler(): int

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

方法参数返回值错误
CreateMusicPlayer—IMusicPlayer错误码索引
DestroyMusicPlayermusic_player: IMusicPlayerint错误码索引
GetCachescacheInfo: MusicCacheInfo[], cacheInfoSize: Int32int错误码索引
GetInternalSongCodesongCode: Int64, jsonOption: string, internalSongCode: Int64int错误码索引
GetLyricrequestId: string, songCode: Int64, LyricType?: intint错误码索引
GetMusicChartsrequestId: stringint错误码索引
GetMusicCollectionByMusicChartIdrequestId: string, musicChartType: int, page: int, pageSize: int, jsonOption?: stringint错误码索引
GetSongSimpleInforequestId: string, songCode: Int64int错误码索引
Initializeconfiguration: MusicContentCenterConfigurationint错误码索引
IsPreloadedsongCode: Int64int错误码索引
PreloadsongCode: Int64, jsonOption?: stringint错误码索引
RegisterEventHandlereventHandler: IMusicContentCenterEventHandlerint错误码索引
RemoveCachesongCode: Int64int错误码索引
RenewTokentoken: stringint错误码索引
SearchMusicrequestId: string, keyWord: string, page: int, pageSize: int, jsonOption?: stringint错误码索引
UnregisterEventHandler—int错误码索引
IMusicContentCenterEventHandler 5 方法 / 0 属性
typescript
OnLyricResult(requestId: string, songCode: long, lyricUrl: string, reason: MusicContentCenterStateReason): void
OnMusicChartsResult(requestId: string, result: MusicChartInfo[], reason: MusicContentCenterStateReason): void
OnMusicCollectionResult(requestId: string, result: MusicCollection, reason: MusicContentCenterStateReason): void
OnPreLoadEvent(requestId: string, songCode: long, percent: int, lyricUrl: string, state: PreloadState, reason: MusicContentCenterStateReason): void
OnSongSimpleInfoResult(requestId: string, songCode: long, simpleInfo: string, reason: MusicContentCenterStateReason): void

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

方法参数返回值错误
OnLyricResultrequestId: string, songCode: long, lyricUrl: string, reason: MusicContentCenterStateReasonvoid错误码索引
OnMusicChartsResultrequestId: string, result: MusicChartInfo[], reason: MusicContentCenterStateReasonvoid错误码索引
OnMusicCollectionResultrequestId: string, result: MusicCollection, reason: MusicContentCenterStateReasonvoid错误码索引
OnPreLoadEventrequestId: string, songCode: long, percent: int, lyricUrl: string, state: PreloadState, reason: MusicContentCenterStateReasonvoid错误码索引
OnSongSimpleInfoResultrequestId: string, songCode: long, simpleInfo: string, reason: MusicContentCenterStateReasonvoid错误码索引
IMusicPlayer 2 方法 / 0 属性
typescript
Open(songCode: Int64, startPos: Int64): int
SetPlayMode(mode: MusicPlayMode): int

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

方法参数返回值错误
OpensongCode: Int64, startPos: Int64int错误码索引
SetPlayModemode: MusicPlayModeint错误码索引
IRtcEngine 266 方法 / 0 属性
typescript
AddVideoWatermark(watermark: RtcImage): int
AddVideoWatermark(watermarkUrl: string, options: WatermarkOptions): int
AddVideoWatermark(configs: WatermarkConfig): int
AdjustAudioMixingPlayoutVolume(volume: int): int
AdjustAudioMixingPublishVolume(volume: int): int
AdjustAudioMixingVolume(volume: int): int
AdjustCustomAudioPlayoutVolume(trackId: uint, volume: int): int
AdjustCustomAudioPublishVolume(trackId: uint, volume: int): int
AdjustLoopbackSignalVolume(volume: int): int
AdjustPlaybackSignalVolume(volume: int): int
AdjustRecordingSignalVolume(volume: int): int
AdjustUserPlaybackSignalVolume(uid: uint, volume: int): int
ClearVideoWatermarks(): int
Complain(callId: string, description: string): int
ConfigRhythmPlayer(config: AgoraRhythmPlayerConfig): int
CreateAgoraRtcEngine(): IRtcEngine
CreateCustomVideoTrack(): video_track_id_t
CreateDataStream(streamId: int, reliable: bool, ordered: bool): int
CreateDataStream(streamId: int, config: DataStreamConfig): int
CreateMediaPlayer(): IMediaPlayer
CreateMediaRecorder(info: RecorderStreamInfo): IMediaRecorder
CreateVideoEffectObject(bundlePath: string, type?: MEDIA_SOURCE_TYPE): IVideoEffectObject
DestroyCustomVideoTrack(video_track_id: video_track_id_t): int
DestroyMediaPlayer(mediaPlayer: IMediaPlayer): int
DestroyMediaRecorder(mediaRecorder: IMediaRecorder): int
DestroyVideoEffectObject(videoEffectObject: IVideoEffectObject): int
DisableAudio(): int
DisableAudioSpectrumMonitor(): int
DisableVideo(): int
Dispose(sync?: bool): void
EnableAudio(): int
EnableAudioSpectrumMonitor(intervalInMS?: int): int
EnableAudioVolumeIndication(interval: int, smooth: int, reportVad: bool): int
EnableCameraCenterStage(enabled: bool): int
EnableContentInspect(enabled: bool, config: ContentInspectConfig): int
EnableCustomAudioLocalPlayback(trackId: uint, enabled: bool): int
EnableDualStreamMode(enabled: bool): int
EnableDualStreamMode(enabled: bool, streamConfig: SimulcastStreamConfig): int
EnableEncryption(enabled: bool, config: EncryptionConfig): int
EnableExtension(provider: string, extension: string, enable?: bool, type?: 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?: string): int
EnableMultiCamera(enabled: bool, config: CameraCapturerConfiguration): int
EnableSoundPositionIndication(enabled: bool): int
EnableSpatialAudio(enabled: bool): int
EnableVideo(): int
EnableVideoImageSource(enable: bool, options: ImageTrackOptions): int
EnableVirtualBackground(enabled: bool, backgroundSource: VirtualBackgroundSource, segproperty: SegmentationProperty, type?: MEDIA_SOURCE_TYPE): int
EnableVoiceAITuner(enabled: bool, type: VOICE_AI_TUNER_TYPE): int
EnableWebSdkInteroperability(enabled: bool): int
GetAudioDeviceInfo(deviceInfo: DeviceInfoMobile): int
GetAudioDeviceManager(): IAudioDeviceManager
GetAudioMixingCurrentPosition(): int
GetAudioMixingDuration(): int
GetAudioMixingPlayoutVolume(): int
GetAudioMixingPublishVolume(): int
GetAudioTrackCount(): int
GetCallId(callId: string): int
GetCameraMaxZoomFactor(): float
GetConnectionState(): CONNECTION_STATE_TYPE
GetCurrentMonotonicTimeInMs(): long
GetEffectCurrentPosition(soundId: int): int
GetEffectDuration(filePath: string): int
GetEffectsVolume(): int
GetErrorDescription(code: int): string
GetExtensionProperty(provider: string, extension: string, key: string, value: string, buf_len: int, type?: MEDIA_SOURCE_TYPE): int
GetFaceShapeAreaOptions(shapeArea: FACE_SHAPE_AREA, options: FaceShapeAreaOptions, type?: MEDIA_SOURCE_TYPE): int
GetFaceShapeBeautyOptions(options: FaceShapeBeautyOptions, type?: MEDIA_SOURCE_TYPE): int
GetLocalSpatialAudioEngine(): ILocalSpatialAudioEngine
GetMusicContentCenter(): IMusicContentCenter
GetNativeHandler(nativeHandler: IntPtr): int
GetNetworkType(): int
GetNtpWallTimeInMs(): UInt64
GetScreenCaptureSources(thumbSize: SIZE, iconSize: SIZE, includeScreen: bool): ScreenCaptureSourceInfo[]
GetUserInfoByUid(uid: uint, userInfo: UserInfo): int
GetUserInfoByUserAccount(userAccount: string, userInfo: UserInfo): int
GetVersion(build: int): string
GetVideoDeviceManager(): IVideoDeviceManager
GetVolumeOfEffect(soundId: int): int
InitEventHandler(engineEventHandler: IRtcEngineEventHandler): int
Initialize(context: 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: string, channelId: string, info?: string, uid?: uint): int
JoinChannel(token: string, channelId: string, uid: uint, options: ChannelMediaOptions): int
JoinChannelWithUserAccount(token: string, channelId: string, userAccount: string): int
JoinChannelWithUserAccount(token: string, channelId: string, userAccount: string, options: ChannelMediaOptions): int
LeaveChannel(): int
LeaveChannel(options: LeaveChannelOptions): int
LoadExtensionProvider(path: string, 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: uint, mute: bool): int
MuteRemoteVideoStream(uid: uint, 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: string, loopCount: int, pitch: double, pan: double, gain: int, publish?: bool, startPos?: int): int
PreloadChannel(token: string, channelId: string, uid: uint): int
PreloadChannelWithUserAccount(token: unknown, channelId: unknown, userAccount: unknown): unknown
PreloadEffect(soundId: int, filePath: string, startPos?: int): int
QueryCameraFocalLengthCapability(focalLengthInfos: FocalLengthInfo[], size: int): int
QueryCodecCapability(codecInfo: CodecCapInfo[], size: int): int
QueryDeviceScore(): int
QueryScreenCaptureCapability(): int
Rate(callId: string, rating: int, description: string): int
RegisterAudioEncodedFrameObserver(config: AudioEncodedFrameObserverConfig, observer: IAudioEncodedFrameObserver): int
RegisterAudioSpectrumObserver(observer: IAudioSpectrumObserver): int
RegisterExtension(provider: string, extension: string, type?: MEDIA_SOURCE_TYPE): int
RegisterLocalUserAccount(appId: string, userAccount: string): int
RegisterMediaMetadataObserver(observer: IMetadataObserver, type: METADATA_TYPE): int
RemoveVideoWatermark(id: string): int
RenewToken(token: string): int
ResumeAllChannelMediaRelay(): int
ResumeAllEffects(): int
ResumeAudioMixing(): int
ResumeEffect(soundId: int): int
SelectAudioTrack(index: int): int
SendCustomReportMessage(id: string, category: string, null: string, label: string, value: int): int
SendMetadata(metadata: Metadata, source_type: VIDEO_SOURCE_TYPE): int
SendStreamMessage(streamId: int, data: byte[], length: uint): int
SetAINSMode(enabled: bool, mode: AUDIO_AINS_MODE): int
SetAVSyncSource(channelId: string, uid: uint): int
SetAdvancedAudioOptions(options: AdvancedAudioOptions): int
SetAudioEffectParameters(preset: AUDIO_EFFECT_PRESET, param1: int, param2: int): int
SetAudioEffectPreset(preset: AUDIO_EFFECT_PRESET): int
SetAudioMixingDualMonoMode(mode: AUDIO_MIXING_DUAL_MONO_MODE): int
SetAudioMixingPitch(pitch: int): int
SetAudioMixingPlaybackSpeed(speed: int): int
SetAudioMixingPosition(pos: int): 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: BeautyOptions, type?: MEDIA_SOURCE_TYPE): int
SetCameraAutoExposureFaceModeEnabled(enabled: bool): int
SetCameraAutoFocusFaceModeEnabled(enabled: bool): int
SetCameraCapturerConfiguration(config: 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: ClientRoleOptions): int
SetCloudProxy(proxyType: CLOUD_PROXY_TYPE): int
SetColorEnhanceOptions(enabled: bool, options: ColorEnhanceOptions, type?: MEDIA_SOURCE_TYPE): int
SetDefaultAudioRouteToSpeakerphone(defaultToSpeaker: bool): int
SetDualStreamMode(mode: SIMULCAST_STREAM_MODE): int
SetDualStreamMode(mode: SIMULCAST_STREAM_MODE, streamConfig: 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: string, extension: string, key: string, value: string, type?: MEDIA_SOURCE_TYPE): int
SetExtensionProviderProperty(provider: string, key: string, value: string): int
SetExternalMediaProjection(mediaProjection: IntPtr): int
SetExternalRemoteEglContext(eglContext: IntPtr): int
SetFaceShapeAreaOptions(options: FaceShapeAreaOptions, type?: MEDIA_SOURCE_TYPE): int
SetFaceShapeBeautyOptions(enabled: bool, options: FaceShapeBeautyOptions, type?: MEDIA_SOURCE_TYPE): int
SetFilterEffectOptions(enabled: bool, options: FilterEffectOptions, type?: MEDIA_SOURCE_TYPE): int
SetHeadphoneEQParameters(lowGain: int, highGain: int): int
SetHeadphoneEQPreset(preset: HEADPHONE_EQUALIZER_PRESET): int
SetInEarMonitoringVolume(volume: int): int
SetLocalAccessPoint(config: LocalAccessPointConfiguration): int
SetLocalRenderMode(renderMode: RENDER_MODE_TYPE): int
SetLocalRenderMode(renderMode: RENDER_MODE_TYPE, mirrorMode: VIDEO_MIRROR_MODE_TYPE): int
SetLocalRenderTargetFps(sourceType: VIDEO_SOURCE_TYPE, targetFps: int): int
SetLocalVideoDataSourcePosition(position: VIDEO_MODULE_POSITION): 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: string): int
SetLogFileSize(fileSizeInKBytes: uint): int
SetLogFilter(filter: uint): int
SetLogLevel(level: LOG_LEVEL): int
SetLowlightEnhanceOptions(enabled: bool, options: LowlightEnhanceOptions, type?: MEDIA_SOURCE_TYPE): int
SetMaxMetadataSize(size: int): int
SetMixedAudioFrameParameters(sampleRate: int, channel: int, samplesPerCall: int): int
SetParameters(key: string, value: object): int
SetPlaybackAudioFrameBeforeMixingParameters(sampleRate: int, channel: int): int
SetPlaybackAudioFrameBeforeMixingParameters(sampleRate: int, channel: int, samplesPerCall: 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(uid: uint, renderMode: RENDER_MODE_TYPE, mirrorMode: VIDEO_MIRROR_MODE_TYPE): int
SetRemoteRenderTargetFps(targetFps: int): int
SetRemoteSubscribeFallbackOption(option: STREAM_FALLBACK_OPTIONS): int
SetRemoteUserSpatialAudioParams(uid: uint, param: SpatialAudioParams): int
SetRemoteVideoStreamType(uid: uint, streamType: VIDEO_STREAM_TYPE): int
SetRemoteVideoSubscriptionOptions(uid: uint, options: VideoSubscriptionOptions): int
SetRemoteVoicePosition(uid: uint, pan: double, gain: double): int
SetRouteInCommunicationMode(route: int): int
SetScreenCaptureContentHint(contentHint: VIDEO_CONTENT_HINT): int
SetScreenCaptureScenario(screenScenario: SCREEN_SCENARIO_TYPE): int
SetSubscribeAudioAllowlist(uidList: uint[], uidNumber: int): int
SetSubscribeAudioBlocklist(uidList: uint[], uidNumber: int): int
SetSubscribeVideoAllowlist(uidList: uint[], uidNumber: int): int
SetSubscribeVideoBlocklist(uidList: uint[], uidNumber: int): int
SetVideoDenoiserOptions(enabled: bool, options: VideoDenoiserOptions, type?: MEDIA_SOURCE_TYPE): int
SetVideoEncoderConfiguration(config: 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: VideoCanvas): int
SetupRemoteVideo(canvas: VideoCanvas): int
StartAudioMixing(filePath: string, loopback: bool, cycle: int): int
StartAudioMixing(filePath: string, loopback: bool, cycle: int, startPos: int): int
StartAudioRecording(filePath: string, quality: AUDIO_RECORDING_QUALITY_TYPE): int
StartAudioRecording(filePath: string, sampleRate: int, quality: AUDIO_RECORDING_QUALITY_TYPE): int
StartAudioRecording(config: AudioRecordingConfiguration): int
StartCameraCapture(sourceType: VIDEO_SOURCE_TYPE, config: CameraCapturerConfiguration): int
StartEchoTest(config: EchoTestConfiguration): int
StartLastmileProbeTest(config: LastmileProbeConfig): int
StartLocalAudioMixer(config: LocalAudioMixerConfiguration): int
StartLocalVideoTranscoder(config: LocalTranscoderConfiguration): int
StartMediaRenderingTracing(): int
StartOrUpdateChannelMediaRelay(configuration: ChannelMediaRelayConfiguration): int
StartPreview(): int
StartPreview(sourceType: VIDEO_SOURCE_TYPE): int
StartRhythmPlayer(sound1: string, sound2: string, config: AgoraRhythmPlayerConfig): int
StartRtmpStreamWithTranscoding(url: string, transcoding: LiveTranscoding): int
StartRtmpStreamWithoutTranscoding(url: string): int
StartScreenCapture(captureParams: ScreenCaptureParameters2): int
StartScreenCapture(sourceType: VIDEO_SOURCE_TYPE, config: ScreenCaptureConfiguration): int
StartScreenCaptureByDisplayId(displayId: uint, regionRect: Rectangle, captureParams: ScreenCaptureParameters): int
StartScreenCaptureByScreenRect(screenRect: Rectangle, regionRect: Rectangle, captureParams: ScreenCaptureParameters): int
StartScreenCaptureByWindowId(windowId: long, regionRect: Rectangle, captureParams: ScreenCaptureParameters): int
StopAllEffects(): int
StopAudioMixing(): int
StopAudioRecording(): int
StopCameraCapture(sourceType: VIDEO_SOURCE_TYPE): int
StopChannelMediaRelay(): 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: string): int
StopScreenCapture(): int
StopScreenCapture(sourceType: VIDEO_SOURCE_TYPE): int
SwitchCamera(): int
TakeSnapshot(uid: uint, filePath: string): int
TakeSnapshot(uid: uint, config: SnapshotConfig): int
UnRegisterAudioEncodedFrameObserver(): int
UnRegisterAudioFrameObserver(): int
UnloadAllEffects(): int
UnloadEffect(soundId: int): int
UnregisterAudioSpectrumObserver(): int
UnregisterMediaMetadataObserver(): int
UpdateChannelMediaOptions(options: ChannelMediaOptions): int
UpdateLocalAudioMixerConfiguration(config: LocalAudioMixerConfiguration): int
UpdateLocalTranscoderConfiguration(config: LocalTranscoderConfiguration): int
UpdatePreloadChannelToken(token: string): int
UpdateRtmpTranscoding(transcoding: LiveTranscoding): int
UpdateScreenCapture(captureParams: ScreenCaptureParameters2): int
UpdateScreenCaptureParameters(captureParams: ScreenCaptureParameters): int
UpdateScreenCaptureRegion(regionRect: Rectangle): int

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

方法参数返回值错误
AddVideoWatermarkwatermark: RtcImageint错误码索引
AdjustAudioMixingPlayoutVolumevolume: intint错误码索引
AdjustAudioMixingPublishVolumevolume: intint错误码索引
AdjustAudioMixingVolumevolume: intint错误码索引
AdjustCustomAudioPlayoutVolumetrackId: uint, volume: intint错误码索引
AdjustCustomAudioPublishVolumetrackId: uint, volume: intint错误码索引
AdjustLoopbackSignalVolumevolume: intint错误码索引
AdjustPlaybackSignalVolumevolume: intint错误码索引
AdjustRecordingSignalVolumevolume: intint错误码索引
AdjustUserPlaybackSignalVolumeuid: uint, volume: intint错误码索引
ClearVideoWatermarks—int错误码索引
ComplaincallId: string, description: stringint错误码索引
ConfigRhythmPlayerconfig: AgoraRhythmPlayerConfigint错误码索引
CreateAgoraRtcEngine—IRtcEngine错误码索引
CreateCustomVideoTrack—video_track_id_t错误码索引
CreateDataStreamstreamId: int, reliable: bool, ordered: boolint错误码索引
CreateMediaPlayer—IMediaPlayer错误码索引
CreateMediaRecorderinfo: RecorderStreamInfoIMediaRecorder错误码索引
CreateVideoEffectObjectbundlePath: string, type?: MEDIA_SOURCE_TYPEIVideoEffectObject错误码索引
DestroyCustomVideoTrackvideo_track_id: video_track_id_tint错误码索引
DestroyMediaPlayermediaPlayer: IMediaPlayerint错误码索引
DestroyMediaRecordermediaRecorder: IMediaRecorderint错误码索引
DestroyVideoEffectObjectvideoEffectObject: IVideoEffectObjectint错误码索引
DisableAudio—int错误码索引
DisableAudioSpectrumMonitor—int错误码索引
DisableVideo—int错误码索引
Disposesync?: boolvoid错误码索引
EnableAudio—int错误码索引
EnableAudioSpectrumMonitorintervalInMS?: intint错误码索引
EnableAudioVolumeIndicationinterval: int, smooth: int, reportVad: boolint错误码索引
EnableCameraCenterStageenabled: boolint错误码索引
EnableContentInspectenabled: bool, config: ContentInspectConfigint错误码索引
EnableCustomAudioLocalPlaybacktrackId: uint, enabled: boolint错误码索引
EnableDualStreamModeenabled: boolint错误码索引
EnableEncryptionenabled: bool, config: EncryptionConfigint错误码索引
EnableExtensionprovider: string, extension: string, enable?: bool, type?: MEDIA_SOURCE_TYPEint错误码索引
EnableFaceDetectionenabled: boolint错误码索引
EnableInEarMonitoringenabled: bool, includeAudioFilters: intint错误码索引
EnableInstantMediaRendering—int错误码索引
EnableLocalAudioenabled: boolint错误码索引
EnableLocalVideoenabled: boolint错误码索引
EnableLoopbackRecordingenabled: bool, deviceName?: stringint错误码索引
EnableMultiCameraenabled: bool, config: CameraCapturerConfigurationint错误码索引
EnableSoundPositionIndicationenabled: boolint错误码索引
EnableSpatialAudioenabled: boolint错误码索引
EnableVideo—int错误码索引
EnableVideoImageSourceenable: bool, options: ImageTrackOptionsint错误码索引
EnableVirtualBackgroundenabled: bool, backgroundSource: VirtualBackgroundSource, segproperty: SegmentationProperty, type?: MEDIA_SOURCE_TYPEint错误码索引
EnableVoiceAITunerenabled: bool, type: VOICE_AI_TUNER_TYPEint错误码索引
EnableWebSdkInteroperabilityenabled: boolint错误码索引
GetAudioDeviceInfodeviceInfo: DeviceInfoMobileint错误码索引
GetAudioDeviceManager—IAudioDeviceManager错误码索引
GetAudioMixingCurrentPosition—int错误码索引
GetAudioMixingDuration—int错误码索引
GetAudioMixingPlayoutVolume—int错误码索引
GetAudioMixingPublishVolume—int错误码索引
GetAudioTrackCount—int错误码索引
GetCallIdcallId: stringint错误码索引
GetCameraMaxZoomFactor—float错误码索引
GetConnectionState—CONNECTION_STATE_TYPE错误码索引
GetCurrentMonotonicTimeInMs—long错误码索引
GetEffectCurrentPositionsoundId: intint错误码索引
GetEffectDurationfilePath: stringint错误码索引
GetEffectsVolume—int错误码索引
GetErrorDescriptioncode: intstring错误码索引
GetExtensionPropertyprovider: string, extension: string, key: string, value: string, buf_len: int, type?: MEDIA_SOURCE_TYPEint错误码索引
GetFaceShapeAreaOptionsshapeArea: FACE_SHAPE_AREA, options: FaceShapeAreaOptions, type?: MEDIA_SOURCE_TYPEint错误码索引
GetFaceShapeBeautyOptionsoptions: FaceShapeBeautyOptions, type?: MEDIA_SOURCE_TYPEint错误码索引
GetLocalSpatialAudioEngine—ILocalSpatialAudioEngine错误码索引
GetMusicContentCenter—IMusicContentCenter错误码索引
GetNativeHandlernativeHandler: IntPtrint错误码索引
GetNetworkType—int错误码索引
GetNtpWallTimeInMs—UInt64错误码索引
GetScreenCaptureSourcesthumbSize: SIZE, iconSize: SIZE, includeScreen: boolScreenCaptureSourceInfo[]错误码索引
GetUserInfoByUiduid: uint, userInfo: UserInfoint错误码索引
GetUserInfoByUserAccountuserAccount: string, userInfo: UserInfoint错误码索引
GetVersionbuild: intstring错误码索引
GetVideoDeviceManager—IVideoDeviceManager错误码索引
GetVolumeOfEffectsoundId: intint错误码索引
InitEventHandlerengineEventHandler: IRtcEngineEventHandlerint错误码索引
Initializecontext: RtcEngineContextint错误码索引
IsCameraAutoExposureFaceModeSupported—bool错误码索引
IsCameraAutoFocusFaceModeSupported—bool错误码索引
IsCameraCenterStageSupported—bool错误码索引
IsCameraExposurePositionSupported—bool错误码索引
IsCameraExposureSupported—bool错误码索引
IsCameraFaceDetectSupported—bool错误码索引
IsCameraFocusSupported—bool错误码索引
IsCameraTorchSupported—bool错误码索引
IsCameraZoomSupported—bool错误码索引
IsFeatureAvailableOnDevicetype: FeatureTypebool错误码索引
IsSpeakerphoneEnabled—bool错误码索引
JoinChanneltoken: string, channelId: string, info?: string, uid?: uintint错误码索引
JoinChannelWithUserAccounttoken: string, channelId: string, userAccount: stringint错误码索引
LeaveChannel—int错误码索引
LoadExtensionProviderpath: string, unload_after_use?: boolint错误码索引
MuteAllRemoteAudioStreamsmute: boolint错误码索引
MuteAllRemoteVideoStreamsmute: boolint错误码索引
MuteLocalAudioStreammute: boolint错误码索引
MuteLocalVideoStreammute: boolint错误码索引
MuteRecordingSignalmute: boolint错误码索引
MuteRemoteAudioStreamuid: uint, mute: boolint错误码索引
MuteRemoteVideoStreamuid: uint, mute: boolint错误码索引
PauseAllChannelMediaRelay—int错误码索引
PauseAllEffects—int错误码索引
PauseAudioMixing—int错误码索引
PauseEffectsoundId: intint错误码索引
PlayAllEffectsloopCount: int, pitch: double, pan: double, gain: int, publish?: boolint错误码索引
PlayEffectsoundId: int, filePath: string, loopCount: int, pitch: double, pan: double, gain: int, publish?: bool, startPos?: intint错误码索引
PreloadChanneltoken: string, channelId: string, uid: uintint错误码索引
PreloadChannelWithUserAccounttoken: unknown, channelId: unknown, userAccount: unknownunknown错误码索引
PreloadEffectsoundId: int, filePath: string, startPos?: intint错误码索引
QueryCameraFocalLengthCapabilityfocalLengthInfos: FocalLengthInfo[], size: intint错误码索引
QueryCodecCapabilitycodecInfo: CodecCapInfo[], size: intint错误码索引
QueryDeviceScore—int错误码索引
QueryScreenCaptureCapability—int错误码索引
RatecallId: string, rating: int, description: stringint错误码索引
RegisterAudioEncodedFrameObserverconfig: AudioEncodedFrameObserverConfig, observer: IAudioEncodedFrameObserverint错误码索引
RegisterAudioSpectrumObserverobserver: IAudioSpectrumObserverint错误码索引
RegisterExtensionprovider: string, extension: string, type?: MEDIA_SOURCE_TYPEint错误码索引
RegisterLocalUserAccountappId: string, userAccount: stringint错误码索引
RegisterMediaMetadataObserverobserver: IMetadataObserver, type: METADATA_TYPEint错误码索引
RemoveVideoWatermarkid: stringint错误码索引
RenewTokentoken: stringint错误码索引
ResumeAllChannelMediaRelay—int错误码索引
ResumeAllEffects—int错误码索引
ResumeAudioMixing—int错误码索引
ResumeEffectsoundId: intint错误码索引
SelectAudioTrackindex: intint错误码索引
SendCustomReportMessageid: string, category: string, null: string, label: string, value: intint错误码索引
SendMetadatametadata: Metadata, source_type: VIDEO_SOURCE_TYPEint错误码索引
SendStreamMessagestreamId: int, data: byte[], length: uintint错误码索引
SetAINSModeenabled: bool, mode: AUDIO_AINS_MODEint错误码索引
SetAVSyncSourcechannelId: string, uid: uintint错误码索引
SetAdvancedAudioOptionsoptions: AdvancedAudioOptionsint错误码索引
SetAudioEffectParameterspreset: AUDIO_EFFECT_PRESET, param1: int, param2: intint错误码索引
SetAudioEffectPresetpreset: AUDIO_EFFECT_PRESETint错误码索引
SetAudioMixingDualMonoModemode: AUDIO_MIXING_DUAL_MONO_MODEint错误码索引
SetAudioMixingPitchpitch: intint错误码索引
SetAudioMixingPlaybackSpeedspeed: intint错误码索引
SetAudioMixingPositionpos: intint错误码索引
SetAudioProfileprofile: AUDIO_PROFILE_TYPE, scenario: AUDIO_SCENARIO_TYPEint错误码索引
SetAudioScenarioscenario: AUDIO_SCENARIO_TYPEint错误码索引
SetAudioSessionOperationRestrictionrestriction: AUDIO_SESSION_OPERATION_RESTRICTIONint错误码索引
SetBeautyEffectOptionsenabled: bool, options: BeautyOptions, type?: MEDIA_SOURCE_TYPEint错误码索引
SetCameraAutoExposureFaceModeEnabledenabled: boolint错误码索引
SetCameraAutoFocusFaceModeEnabledenabled: boolint错误码索引
SetCameraCapturerConfigurationconfig: CameraCapturerConfigurationint错误码索引
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: ColorEnhanceOptions, type?: MEDIA_SOURCE_TYPEint错误码索引
SetDefaultAudioRouteToSpeakerphonedefaultToSpeaker: boolint错误码索引
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: string, extension: string, key: string, value: string, type?: MEDIA_SOURCE_TYPEint错误码索引
SetExtensionProviderPropertyprovider: string, key: string, value: stringint错误码索引
SetExternalMediaProjectionmediaProjection: IntPtrint错误码索引
SetExternalRemoteEglContexteglContext: IntPtrint错误码索引
SetFaceShapeAreaOptionsoptions: FaceShapeAreaOptions, type?: MEDIA_SOURCE_TYPEint错误码索引
SetFaceShapeBeautyOptionsenabled: bool, options: FaceShapeBeautyOptions, type?: MEDIA_SOURCE_TYPEint错误码索引
SetFilterEffectOptionsenabled: bool, options: FilterEffectOptions, type?: MEDIA_SOURCE_TYPEint错误码索引
SetHeadphoneEQParameterslowGain: int, highGain: intint错误码索引
SetHeadphoneEQPresetpreset: HEADPHONE_EQUALIZER_PRESETint错误码索引
SetInEarMonitoringVolumevolume: intint错误码索引
SetLocalAccessPointconfig: LocalAccessPointConfigurationint错误码索引
SetLocalRenderModerenderMode: RENDER_MODE_TYPEint错误码索引
SetLocalRenderTargetFpssourceType: VIDEO_SOURCE_TYPE, targetFps: intint错误码索引
SetLocalVideoDataSourcePositionposition: VIDEO_MODULE_POSITIONint错误码索引
SetLocalVideoMirrorModemirrorMode: VIDEO_MIRROR_MODE_TYPEint错误码索引
SetLocalVoiceEqualizationbandFrequency: AUDIO_EQUALIZATION_BAND_FREQUENCY, bandGain: intint错误码索引
SetLocalVoiceFormantformantRatio: doubleint错误码索引
SetLocalVoicePitchpitch: doubleint错误码索引
SetLocalVoiceReverbreverbKey: AUDIO_REVERB_TYPE, value: intint错误码索引
SetLogFilefilePath: stringint错误码索引
SetLogFileSizefileSizeInKBytes: uintint错误码索引
SetLogFilterfilter: uintint错误码索引
SetLogLevellevel: LOG_LEVELint错误码索引
SetLowlightEnhanceOptionsenabled: bool, options: LowlightEnhanceOptions, type?: MEDIA_SOURCE_TYPEint错误码索引
SetMaxMetadataSizesize: intint错误码索引
SetMixedAudioFrameParameterssampleRate: int, channel: int, samplesPerCall: intint错误码索引
SetParameterskey: string, value: objectint错误码索引
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错误码索引
SetRemoteRenderModeuid: uint, renderMode: RENDER_MODE_TYPE, mirrorMode: VIDEO_MIRROR_MODE_TYPEint错误码索引
SetRemoteRenderTargetFpstargetFps: intint错误码索引
SetRemoteSubscribeFallbackOptionoption: STREAM_FALLBACK_OPTIONSint错误码索引
SetRemoteUserSpatialAudioParamsuid: uint, param: SpatialAudioParamsint错误码索引
SetRemoteVideoStreamTypeuid: uint, streamType: VIDEO_STREAM_TYPEint错误码索引
SetRemoteVideoSubscriptionOptionsuid: uint, options: VideoSubscriptionOptionsint错误码索引
SetRemoteVoicePositionuid: uint, pan: double, gain: doubleint错误码索引
SetRouteInCommunicationModeroute: intint错误码索引
SetScreenCaptureContentHintcontentHint: VIDEO_CONTENT_HINTint错误码索引
SetScreenCaptureScenarioscreenScenario: SCREEN_SCENARIO_TYPEint错误码索引
SetSubscribeAudioAllowlistuidList: uint[], uidNumber: intint错误码索引
SetSubscribeAudioBlocklistuidList: uint[], uidNumber: intint错误码索引
SetSubscribeVideoAllowlistuidList: uint[], uidNumber: intint错误码索引
SetSubscribeVideoBlocklistuidList: uint[], uidNumber: intint错误码索引
SetVideoDenoiserOptionsenabled: bool, options: VideoDenoiserOptions, type?: MEDIA_SOURCE_TYPEint错误码索引
SetVideoEncoderConfigurationconfig: VideoEncoderConfigurationint错误码索引
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: VideoCanvasint错误码索引
SetupRemoteVideocanvas: VideoCanvasint错误码索引
StartAudioMixingfilePath: string, loopback: bool, cycle: intint错误码索引
StartAudioRecordingfilePath: string, quality: AUDIO_RECORDING_QUALITY_TYPEint错误码索引
StartCameraCapturesourceType: VIDEO_SOURCE_TYPE, config: CameraCapturerConfigurationint错误码索引
StartEchoTestconfig: EchoTestConfigurationint错误码索引
StartLastmileProbeTestconfig: LastmileProbeConfigint错误码索引
StartLocalAudioMixerconfig: LocalAudioMixerConfigurationint错误码索引
StartLocalVideoTranscoderconfig: LocalTranscoderConfigurationint错误码索引
StartMediaRenderingTracing—int错误码索引
StartOrUpdateChannelMediaRelayconfiguration: ChannelMediaRelayConfigurationint错误码索引
StartPreview—int错误码索引
StartRhythmPlayersound1: string, sound2: string, config: AgoraRhythmPlayerConfigint错误码索引
StartRtmpStreamWithTranscodingurl: string, transcoding: LiveTranscodingint错误码索引
StartRtmpStreamWithoutTranscodingurl: stringint错误码索引
StartScreenCapturecaptureParams: ScreenCaptureParameters2int错误码索引
StartScreenCaptureByDisplayIddisplayId: uint, regionRect: Rectangle, captureParams: ScreenCaptureParametersint错误码索引
StartScreenCaptureByScreenRectscreenRect: Rectangle, regionRect: Rectangle, captureParams: ScreenCaptureParametersint错误码索引
StartScreenCaptureByWindowIdwindowId: long, regionRect: Rectangle, captureParams: ScreenCaptureParametersint错误码索引
StopAllEffects—int错误码索引
StopAudioMixing—int错误码索引
StopAudioRecording—int错误码索引
StopCameraCapturesourceType: VIDEO_SOURCE_TYPEint错误码索引
StopChannelMediaRelay—int错误码索引
StopEchoTest—int错误码索引
StopEffectsoundId: intint错误码索引
StopLastmileProbeTest—int错误码索引
StopLocalAudioMixer—int错误码索引
StopLocalVideoTranscoder—int错误码索引
StopPreview—int错误码索引
StopRhythmPlayer—int错误码索引
StopRtmpStreamurl: stringint错误码索引
StopScreenCapture—int错误码索引
SwitchCamera—int错误码索引
TakeSnapshotuid: uint, filePath: stringint错误码索引
UnRegisterAudioEncodedFrameObserver—int错误码索引
UnRegisterAudioFrameObserver—int错误码索引
UnloadAllEffects—int错误码索引
UnloadEffectsoundId: intint错误码索引
UnregisterAudioSpectrumObserver—int错误码索引
UnregisterMediaMetadataObserver—int错误码索引
UpdateChannelMediaOptionsoptions: ChannelMediaOptionsint错误码索引
UpdateLocalAudioMixerConfigurationconfig: LocalAudioMixerConfigurationint错误码索引
UpdateLocalTranscoderConfigurationconfig: LocalTranscoderConfigurationint错误码索引
UpdatePreloadChannelTokentoken: stringint错误码索引
UpdateRtmpTranscodingtranscoding: LiveTranscodingint错误码索引
UpdateScreenCapturecaptureParams: ScreenCaptureParameters2int错误码索引
UpdateScreenCaptureParameterscaptureParams: ScreenCaptureParametersint错误码索引
UpdateScreenCaptureRegionregionRect: Rectangleint错误码索引
IRtcEngineEventHandler 87 方法 / 0 属性
typescript
OnActiveSpeaker(connection: RtcConnection, uid: uint): void
OnAudioDeviceStateChanged(deviceId: string, deviceType: MEDIA_DEVICE_TYPE, deviceState: MEDIA_DEVICE_STATE_TYPE): void
OnAudioDeviceVolumeChanged(deviceType: MEDIA_DEVICE_TYPE, volume: int, muted: bool): void
OnAudioEffectFinished(soundId: int): void
OnAudioMixingFinished(): void
OnAudioMixingPositionChanged(position: long): void
OnAudioMixingStateChanged(state: AUDIO_MIXING_STATE_TYPE, reason: AUDIO_MIXING_REASON_TYPE): void
OnAudioPublishStateChanged(channel: string, oldState: STREAM_PUBLISH_STATE, newState: STREAM_PUBLISH_STATE, elapseSinceLastState: int): void
OnAudioQuality(connection: RtcConnection, remoteUid: uint, quality: int, delay: UInt16, lost: UInt16): void
OnAudioRoutingChanged(routing: int): void
OnAudioSubscribeStateChanged(channel: string, uid: uint, oldState: STREAM_SUBSCRIBE_STATE, newState: STREAM_SUBSCRIBE_STATE, elapseSinceLastState: int): void
OnAudioVolumeIndication(connection: RtcConnection, speakers: AudioVolumeInfo[], speakerNumber: uint, totalVolume: int): void
OnCameraExposureAreaChanged(x: int, y: int, width: int, height: int): void
OnCameraFocusAreaChanged(x: int, y: int, width: int, height: int): void
OnCameraReady(): void
OnChannelMediaRelayStateChanged(state: int, code: int): void
OnClientRoleChangeFailed(connection: RtcConnection, reason: CLIENT_ROLE_CHANGE_FAILED_REASON, currentRole: CLIENT_ROLE_TYPE): void
OnClientRoleChanged(connection: RtcConnection, oldRole: CLIENT_ROLE_TYPE, newRole: CLIENT_ROLE_TYPE, newRoleOptions: ClientRoleOptions): void
OnConnectionBanned(connection: RtcConnection): void
OnConnectionInterrupted(connection: RtcConnection): void
OnConnectionLost(connection: RtcConnection): void
OnConnectionStateChanged(connection: RtcConnection, state: CONNECTION_STATE_TYPE, reason: CONNECTION_CHANGED_REASON_TYPE): void
OnEncryptionError(connection: RtcConnection, errorType: ENCRYPTION_ERROR_TYPE): void
OnError(err: int, msg: string): void
OnExtensionErrorWithContext(context: ExtensionContext, error: int, message: string): void
OnExtensionEventWithContext(context: ExtensionContext, key: string, value: string): void
OnExtensionStartedWithContext(context: unknown): unknown
OnExtensionStoppedWithContext(context: ExtensionContext): void
OnFacePositionChanged(imageWidth: int, imageHeight: int, vecRectangle: Rectangle, vecDistance: int[], numFaces: int): void
OnFirstLocalAudioFramePublished(connection: RtcConnection, elapsed: int): void
OnFirstLocalVideoFrame(source: VIDEO_SOURCE_TYPE, width: int, height: int, elapsed: int): void
OnFirstLocalVideoFramePublished(connection: RtcConnection, elapsed: int): void
OnFirstRemoteAudioDecoded(connection: RtcConnection, uid: uint, elapsed: int): void
OnFirstRemoteAudioFrame(connection: RtcConnection, userId: uint, elapsed: int): void
OnFirstRemoteVideoDecoded(connection: RtcConnection, remoteUid: uint, width: int, height: int, elapsed: int): void
OnFirstRemoteVideoFrame(connection: RtcConnection, remoteUid: uint, width: int, height: int, elapsed: int): void
OnJoinChannelSuccess(connection: RtcConnection, elapsed: int): void
OnLastmileProbeResult(result: LastmileProbeResult): void
OnLastmileQuality(quality: int): void
OnLeaveChannel(connection: RtcConnection, stats: RtcStats): void
OnLocalAudioStateChanged(connection: RtcConnection, state: LOCAL_AUDIO_STREAM_STATE, reason: LOCAL_AUDIO_STREAM_REASON): void
OnLocalAudioStats(connection: RtcConnection, stats: LocalAudioStats): void
OnLocalUserRegistered(uid: uint, userAccount: string): void
OnLocalVideoEvent(source: VideoSourceType, event: LocalVideoEventType): void
OnLocalVideoStateChanged(source: VIDEO_SOURCE_TYPE, state: LOCAL_VIDEO_STREAM_STATE, reason: LOCAL_VIDEO_STREAM_REASON): void
OnLocalVideoStats(connection: RtcConnection, stats: LocalVideoStats): void
OnLocalVideoTranscoderError(stream: TranscodingVideoStream, error: VIDEO_TRANSCODER_ERROR): void
OnMultipathStats(connection: RtcConnection, stats: MultipathStats): void
OnNetworkQuality(connection: RtcConnection, remoteUid: uint, txQuality: int, rxQuality: int): void
OnNetworkTypeChanged(connection: RtcConnection, type: NETWORK_TYPE): void
OnPermissionError(permissionType: PERMISSION_TYPE): void
OnPermissionGranted(permissionType: PermissionType): void
OnProxyConnected(channel: string, uid: uint, proxyType: PROXY_TYPE, localProxyIp: string, elapsed: int): void
OnRejoinChannelSuccess(connection: RtcConnection, elapsed: int): void
OnRemoteAudioStateChanged(connection: RtcConnection, remoteUid: uint, state: REMOTE_AUDIO_STATE, reason: REMOTE_AUDIO_STATE_REASON, elapsed: int): void
OnRemoteAudioStats(connection: RtcConnection, stats: RemoteAudioStats): void
OnRemoteAudioTransportStats(connection: RtcConnection, remoteUid: uint, delay: UInt16, lost: UInt16, rxKBitRate: UInt16): void
OnRemoteSubscribeFallbackToAudioOnly(uid: uint, isFallbackOrRecover: bool): void
OnRemoteVideoStateChanged(connection: RtcConnection, remoteUid: uint, state: REMOTE_VIDEO_STATE, reason: REMOTE_VIDEO_STATE_REASON, elapsed: int): void
OnRemoteVideoStats(connection: RtcConnection, stats: RemoteVideoStats): void
OnRemoteVideoTransportStats(connection: RtcConnection, remoteUid: uint, delay: UInt16, lost: UInt16, rxKBitRate: UInt16): void
OnRenewTokenResult(connection: RtcConnection, token: string, code: RENEW_TOKEN_ERROR_CODE): void
OnRequestToken(connection: RtcConnection): void
OnRhythmPlayerStateChanged(state: RHYTHM_PLAYER_STATE_TYPE, reason: RHYTHM_PLAYER_REASON): void
OnRtcStats(connection: RtcConnection, stats: RtcStats): void
OnRtmpStreamingEvent(url: string, eventCode: RTMP_STREAMING_EVENT): void
OnRtmpStreamingStateChanged(url: string, state: RTMP_STREAM_PUBLISH_STATE, reason: RTMP_STREAM_PUBLISH_REASON): void
OnSnapshotTaken(connection: RtcConnection, uid: uint, filePath: string, width: int, height: int, errCode: int): void
OnStreamMessage(connection: RtcConnection, remoteUid: uint, streamId: int, data: byte[], length: ulong, sentTs: ulong): void
OnStreamMessageError(connection: RtcConnection, remoteUid: uint, streamId: int, code: int, missed: int, cached: int): void
OnTokenPrivilegeWillExpire(connection: RtcConnection, token: string): void
OnTranscodedStreamLayoutInfo(connection: RtcConnection, uid: uint, width: int, height: int, layoutCount: int, layoutlist: VideoLayout[]): void
OnTranscodingUpdated(): void
OnUplinkNetworkInfoUpdated(info: UplinkNetworkInfo): void
OnUserEnableLocalVideo(connection: RtcConnection, remoteUid: uint, enabled: bool): void
OnUserEnableVideo(connection: RtcConnection, remoteUid: uint, enabled: bool): void
OnUserInfoUpdated(uid: uint, info: UserInfo): void
OnUserJoined(connection: RtcConnection, remoteUid: uint, elapsed: int): void
OnUserMuteAudio(connection: RtcConnection, remoteUid: uint, muted: bool): void
OnUserMuteVideo(connection: RtcConnection, remoteUid: uint, muted: bool): void
OnUserOffline(connection: RtcConnection, remoteUid: uint, reason: USER_OFFLINE_REASON_TYPE): void
OnVideoDeviceStateChanged(deviceId: string, deviceType: int, deviceState: int): void
OnVideoPublishStateChanged(source: VIDEO_SOURCE_TYPE, channel: string, oldState: STREAM_PUBLISH_STATE, newState: STREAM_PUBLISH_STATE, elapseSinceLastState: int): void
OnVideoRenderingTracingResult(connection: RtcConnection, uid: uint, currentEvent: MEDIA_TRACE_EVENT, tracingInfo: VideoRenderingTracingInfo): void
OnVideoSizeChanged(connection: RtcConnection, sourceType: VIDEO_SOURCE_TYPE, uid: uint, width: int, height: int, rotation: int): void
OnVideoStopped(): void
OnVideoSubscribeStateChanged(channel: string, uid: uint, oldState: STREAM_SUBSCRIBE_STATE, newState: STREAM_SUBSCRIBE_STATE, elapseSinceLastState: int): void

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

方法参数返回值错误
OnActiveSpeakerconnection: RtcConnection, uid: uintvoid错误码索引
OnAudioDeviceStateChangeddeviceId: string, deviceType: MEDIA_DEVICE_TYPE, deviceState: MEDIA_DEVICE_STATE_TYPEvoid错误码索引
OnAudioDeviceVolumeChangeddeviceType: MEDIA_DEVICE_TYPE, volume: int, muted: boolvoid错误码索引
OnAudioEffectFinishedsoundId: intvoid错误码索引
OnAudioMixingFinished—void错误码索引
OnAudioMixingPositionChangedposition: longvoid错误码索引
OnAudioMixingStateChangedstate: AUDIO_MIXING_STATE_TYPE, reason: AUDIO_MIXING_REASON_TYPEvoid错误码索引
OnAudioPublishStateChangedchannel: string, oldState: STREAM_PUBLISH_STATE, newState: STREAM_PUBLISH_STATE, elapseSinceLastState: intvoid错误码索引
OnAudioQualityconnection: RtcConnection, remoteUid: uint, quality: int, delay: UInt16, lost: UInt16void错误码索引
OnAudioRoutingChangedrouting: intvoid错误码索引
OnAudioSubscribeStateChangedchannel: string, uid: uint, oldState: STREAM_SUBSCRIBE_STATE, newState: STREAM_SUBSCRIBE_STATE, elapseSinceLastState: intvoid错误码索引
OnAudioVolumeIndicationconnection: RtcConnection, speakers: AudioVolumeInfo[], speakerNumber: uint, totalVolume: intvoid错误码索引
OnCameraExposureAreaChangedx: int, y: int, width: int, height: intvoid错误码索引
OnCameraFocusAreaChangedx: int, y: int, width: int, height: intvoid错误码索引
OnCameraReady—void错误码索引
OnChannelMediaRelayStateChangedstate: int, code: intvoid错误码索引
OnClientRoleChangeFailedconnection: RtcConnection, reason: CLIENT_ROLE_CHANGE_FAILED_REASON, currentRole: CLIENT_ROLE_TYPEvoid错误码索引
OnClientRoleChangedconnection: RtcConnection, oldRole: CLIENT_ROLE_TYPE, newRole: CLIENT_ROLE_TYPE, newRoleOptions: ClientRoleOptionsvoid错误码索引
OnConnectionBannedconnection: RtcConnectionvoid错误码索引
OnConnectionInterruptedconnection: RtcConnectionvoid错误码索引
OnConnectionLostconnection: RtcConnectionvoid错误码索引
OnConnectionStateChangedconnection: RtcConnection, state: CONNECTION_STATE_TYPE, reason: CONNECTION_CHANGED_REASON_TYPEvoid错误码索引
OnEncryptionErrorconnection: RtcConnection, errorType: ENCRYPTION_ERROR_TYPEvoid错误码索引
OnErrorerr: int, msg: stringvoid错误码索引
OnExtensionErrorWithContextcontext: ExtensionContext, error: int, message: stringvoid错误码索引
OnExtensionEventWithContextcontext: ExtensionContext, key: string, value: stringvoid错误码索引
OnExtensionStartedWithContextcontext: unknownunknown错误码索引
OnExtensionStoppedWithContextcontext: ExtensionContextvoid错误码索引
OnFacePositionChangedimageWidth: int, imageHeight: int, vecRectangle: Rectangle, vecDistance: int[], numFaces: intvoid错误码索引
OnFirstLocalAudioFramePublishedconnection: RtcConnection, elapsed: intvoid错误码索引
OnFirstLocalVideoFramesource: VIDEO_SOURCE_TYPE, width: int, height: int, elapsed: intvoid错误码索引
OnFirstLocalVideoFramePublishedconnection: RtcConnection, elapsed: intvoid错误码索引
OnFirstRemoteAudioDecodedconnection: RtcConnection, uid: uint, elapsed: intvoid错误码索引
OnFirstRemoteAudioFrameconnection: RtcConnection, userId: uint, elapsed: intvoid错误码索引
OnFirstRemoteVideoDecodedconnection: RtcConnection, remoteUid: uint, width: int, height: int, elapsed: intvoid错误码索引
OnFirstRemoteVideoFrameconnection: RtcConnection, remoteUid: uint, width: int, height: int, elapsed: intvoid错误码索引
OnJoinChannelSuccessconnection: RtcConnection, elapsed: intvoid错误码索引
OnLastmileProbeResultresult: LastmileProbeResultvoid错误码索引
OnLastmileQualityquality: intvoid错误码索引
OnLeaveChannelconnection: RtcConnection, stats: RtcStatsvoid错误码索引
OnLocalAudioStateChangedconnection: RtcConnection, state: LOCAL_AUDIO_STREAM_STATE, reason: LOCAL_AUDIO_STREAM_REASONvoid错误码索引
OnLocalAudioStatsconnection: RtcConnection, stats: LocalAudioStatsvoid错误码索引
OnLocalUserRegistereduid: uint, userAccount: stringvoid错误码索引
OnLocalVideoEventsource: VideoSourceType, event: LocalVideoEventTypevoid错误码索引
OnLocalVideoStateChangedsource: VIDEO_SOURCE_TYPE, state: LOCAL_VIDEO_STREAM_STATE, reason: LOCAL_VIDEO_STREAM_REASONvoid错误码索引
OnLocalVideoStatsconnection: RtcConnection, stats: LocalVideoStatsvoid错误码索引
OnLocalVideoTranscoderErrorstream: TranscodingVideoStream, error: VIDEO_TRANSCODER_ERRORvoid错误码索引
OnMultipathStatsconnection: RtcConnection, stats: MultipathStatsvoid错误码索引
OnNetworkQualityconnection: RtcConnection, remoteUid: uint, txQuality: int, rxQuality: intvoid错误码索引
OnNetworkTypeChangedconnection: RtcConnection, type: NETWORK_TYPEvoid错误码索引
OnPermissionErrorpermissionType: PERMISSION_TYPEvoid错误码索引
OnPermissionGrantedpermissionType: PermissionTypevoid错误码索引
OnProxyConnectedchannel: string, uid: uint, proxyType: PROXY_TYPE, localProxyIp: string, elapsed: intvoid错误码索引
OnRejoinChannelSuccessconnection: RtcConnection, elapsed: intvoid错误码索引
OnRemoteAudioStateChangedconnection: RtcConnection, remoteUid: uint, state: REMOTE_AUDIO_STATE, reason: REMOTE_AUDIO_STATE_REASON, elapsed: intvoid错误码索引
OnRemoteAudioStatsconnection: RtcConnection, stats: RemoteAudioStatsvoid错误码索引
OnRemoteAudioTransportStatsconnection: RtcConnection, remoteUid: uint, delay: UInt16, lost: UInt16, rxKBitRate: UInt16void错误码索引
OnRemoteSubscribeFallbackToAudioOnlyuid: uint, isFallbackOrRecover: boolvoid错误码索引
OnRemoteVideoStateChangedconnection: RtcConnection, remoteUid: uint, state: REMOTE_VIDEO_STATE, reason: REMOTE_VIDEO_STATE_REASON, elapsed: intvoid错误码索引
OnRemoteVideoStatsconnection: RtcConnection, stats: RemoteVideoStatsvoid错误码索引
OnRemoteVideoTransportStatsconnection: RtcConnection, remoteUid: uint, delay: UInt16, lost: UInt16, rxKBitRate: UInt16void错误码索引
OnRenewTokenResultconnection: RtcConnection, token: string, code: RENEW_TOKEN_ERROR_CODEvoid错误码索引
OnRequestTokenconnection: RtcConnectionvoid错误码索引
OnRhythmPlayerStateChangedstate: RHYTHM_PLAYER_STATE_TYPE, reason: RHYTHM_PLAYER_REASONvoid错误码索引
OnRtcStatsconnection: RtcConnection, stats: RtcStatsvoid错误码索引
OnRtmpStreamingEventurl: string, eventCode: RTMP_STREAMING_EVENTvoid错误码索引
OnRtmpStreamingStateChangedurl: string, state: RTMP_STREAM_PUBLISH_STATE, reason: RTMP_STREAM_PUBLISH_REASONvoid错误码索引
OnSnapshotTakenconnection: RtcConnection, uid: uint, filePath: string, width: int, height: int, errCode: intvoid错误码索引
OnStreamMessageconnection: RtcConnection, remoteUid: uint, streamId: int, data: byte[], length: ulong, sentTs: ulongvoid错误码索引
OnStreamMessageErrorconnection: RtcConnection, remoteUid: uint, streamId: int, code: int, missed: int, cached: intvoid错误码索引
OnTokenPrivilegeWillExpireconnection: RtcConnection, token: stringvoid错误码索引
OnTranscodedStreamLayoutInfoconnection: RtcConnection, uid: uint, width: int, height: int, layoutCount: int, layoutlist: VideoLayout[]void错误码索引
OnTranscodingUpdated—void错误码索引
OnUplinkNetworkInfoUpdatedinfo: UplinkNetworkInfovoid错误码索引
OnUserEnableLocalVideoconnection: RtcConnection, remoteUid: uint, enabled: boolvoid错误码索引
OnUserEnableVideoconnection: RtcConnection, remoteUid: uint, enabled: boolvoid错误码索引
OnUserInfoUpdateduid: uint, info: UserInfovoid错误码索引
OnUserJoinedconnection: RtcConnection, remoteUid: uint, elapsed: intvoid错误码索引
OnUserMuteAudioconnection: RtcConnection, remoteUid: uint, muted: boolvoid错误码索引
OnUserMuteVideoconnection: RtcConnection, remoteUid: uint, muted: boolvoid错误码索引
OnUserOfflineconnection: RtcConnection, remoteUid: uint, reason: USER_OFFLINE_REASON_TYPEvoid错误码索引
OnVideoDeviceStateChangeddeviceId: string, deviceType: int, deviceState: intvoid错误码索引
OnVideoPublishStateChangedsource: VIDEO_SOURCE_TYPE, channel: string, oldState: STREAM_PUBLISH_STATE, newState: STREAM_PUBLISH_STATE, elapseSinceLastState: intvoid错误码索引
OnVideoRenderingTracingResultconnection: RtcConnection, uid: uint, currentEvent: MEDIA_TRACE_EVENT, tracingInfo: VideoRenderingTracingInfovoid错误码索引
OnVideoSizeChangedconnection: RtcConnection, sourceType: VIDEO_SOURCE_TYPE, uid: uint, width: int, height: int, rotation: intvoid错误码索引
OnVideoStopped—void错误码索引
OnVideoSubscribeStateChangedchannel: string, uid: uint, oldState: STREAM_SUBSCRIBE_STATE, newState: STREAM_SUBSCRIBE_STATE, elapseSinceLastState: intvoid错误码索引
IRtcEngineEx 47 方法 / 0 属性
typescript
AddVideoWatermarkEx(watermarkUrl: string, options: WatermarkOptions, connection: RtcConnection): int
AdjustUserPlaybackSignalVolumeEx(uid: uint, volume: int, connection: RtcConnection): int
ClearVideoWatermarkEx(connection: RtcConnection): int
CreateAgoraRtcEngineEx(): IRtcEngineEx
CreateDataStreamEx(streamId: int, reliable: bool, ordered: bool, connection: RtcConnection): int
CreateDataStreamEx(streamId: int, config: DataStreamConfig, connection: RtcConnection): int
EnableAudioVolumeIndicationEx(interval: int, smooth: int, reportVad: bool, connection: RtcConnection): int
EnableContentInspectEx(enabled: bool, config: ContentInspectConfig, connection: RtcConnection): int
EnableDualStreamModeEx(enabled: bool, streamConfig: SimulcastStreamConfig, connection: RtcConnection): int
EnableEncryptionEx(connection: RtcConnection, enabled: bool, config: EncryptionConfig): int
EnableLoopbackRecordingEx(connection: RtcConnection, enabled: bool, deviceName: string): int
GetCallIdEx(callId: string, connection: RtcConnection): int
GetConnectionStateEx(connection: RtcConnection): CONNECTION_STATE_TYPE
JoinChannelEx(token: string, connection: RtcConnection, options: ChannelMediaOptions): int
LeaveChannelEx(connection: RtcConnection): int
LeaveChannelEx(connection: RtcConnection, options: LeaveChannelOptions): int
MuteAllRemoteAudioStreamsEx(mute: bool, connection: RtcConnection): int
MuteAllRemoteVideoStreamsEx(mute: bool, connection: RtcConnection): int
MuteLocalAudioStreamEx(mute: bool, connection: RtcConnection): int
MuteLocalVideoStreamEx(mute: bool, connection: RtcConnection): int
MuteRemoteAudioStreamEx(uid: uint, mute: bool, connection: RtcConnection): int
MuteRemoteVideoStreamEx(uid: uint, mute: bool, connection: RtcConnection): int
PauseAllChannelMediaRelayEx(connection: RtcConnection): int
PlayEffectEx(connection: RtcConnection, soundId: int, filePath: string, loopCount: int, pitch: double, pan: double, gain: int, publish?: bool, startPos?: int): int
PreloadEffectEx(connection: RtcConnection, soundId: int, filePath: string, startPos?: int): int
RemoveVideoWatermarkEx(id: string, connection: RtcConnection): int
ResumeAllChannelMediaRelayEx(connection: RtcConnection): int
SendCustomReportMessageEx(id: string, category: string, null: string, label: string, value: int, connection: RtcConnection): int
SendStreamMessageEx(streamId: int, data: byte[], length: uint, connection: RtcConnection): int
SetDualStreamModeEx(mode: SIMULCAST_STREAM_MODE, streamConfig: SimulcastStreamConfig, connection: RtcConnection): int
SetRemoteRenderModeEx(uid: uint, renderMode: RENDER_MODE_TYPE, mirrorMode: VIDEO_MIRROR_MODE_TYPE, connection: RtcConnection): int
SetRemoteVideoStreamTypeEx(uid: uint, streamType: VIDEO_STREAM_TYPE, connection: RtcConnection): int
SetRemoteVideoSubscriptionOptionsEx(uid: uint, options: VideoSubscriptionOptions, connection: RtcConnection): int
SetRemoteVoicePositionEx(uid: uint, pan: double, gain: double, connection: RtcConnection): int
SetSubscribeAudioAllowlistEx(uidList: unknown, uidNumber: unknown, connection: unknown): unknown
SetSubscribeAudioBlocklistEx(uidList: uint[], uidNumber: int, connection: RtcConnection): int
SetSubscribeVideoAllowlistEx(uidList: uint[], uidNumber: int, connection: RtcConnection): int
SetSubscribeVideoBlocklistEx(uidList: uint[], uidNumber: int, connection: RtcConnection): int
SetVideoEncoderConfigurationEx(config: VideoEncoderConfiguration, connection: RtcConnection): int
SetupRemoteVideoEx(canvas: VideoCanvas, connection: RtcConnection): int
StartMediaRenderingTracingEx(connection: RtcConnection): int
StartOrUpdateChannelMediaRelayEx(configuration: ChannelMediaRelayConfiguration, connection: RtcConnection): int
StartRtmpStreamWithTranscodingEx(url: string, transcoding: LiveTranscoding, connection: RtcConnection): int
StartRtmpStreamWithoutTranscodingEx(url: string, connection: RtcConnection): int
StopChannelMediaRelayEx(connection: RtcConnection): int
StopRtmpStreamEx(url: string, connection: RtcConnection): int
TakeSnapshotEx(connection: RtcConnection, uid: uint, filePath: string): int
TakeSnapshotEx(connection: RtcConnection, uid: uint, config: SnapshotConfig): int
UpdateChannelMediaOptionsEx(options: ChannelMediaOptions, connection: RtcConnection): int
UpdateRtmpTranscodingEx(transcoding: LiveTranscoding, connection: RtcConnection): int

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

方法参数返回值错误
AddVideoWatermarkExwatermarkUrl: string, options: WatermarkOptions, connection: RtcConnectionint错误码索引
AdjustUserPlaybackSignalVolumeExuid: uint, volume: int, connection: RtcConnectionint错误码索引
ClearVideoWatermarkExconnection: RtcConnectionint错误码索引
CreateAgoraRtcEngineEx—IRtcEngineEx错误码索引
CreateDataStreamExstreamId: int, reliable: bool, ordered: bool, connection: RtcConnectionint错误码索引
EnableAudioVolumeIndicationExinterval: int, smooth: int, reportVad: bool, connection: RtcConnectionint错误码索引
EnableContentInspectExenabled: bool, config: ContentInspectConfig, connection: RtcConnectionint错误码索引
EnableDualStreamModeExenabled: bool, streamConfig: SimulcastStreamConfig, connection: RtcConnectionint错误码索引
EnableEncryptionExconnection: RtcConnection, enabled: bool, config: EncryptionConfigint错误码索引
EnableLoopbackRecordingExconnection: RtcConnection, enabled: bool, deviceName: stringint错误码索引
GetCallIdExcallId: string, connection: RtcConnectionint错误码索引
GetConnectionStateExconnection: RtcConnectionCONNECTION_STATE_TYPE错误码索引
JoinChannelExtoken: string, connection: RtcConnection, options: ChannelMediaOptionsint错误码索引
LeaveChannelExconnection: RtcConnectionint错误码索引
MuteAllRemoteAudioStreamsExmute: bool, connection: RtcConnectionint错误码索引
MuteAllRemoteVideoStreamsExmute: bool, connection: RtcConnectionint错误码索引
MuteLocalAudioStreamExmute: bool, connection: RtcConnectionint错误码索引
MuteLocalVideoStreamExmute: bool, connection: RtcConnectionint错误码索引
MuteRemoteAudioStreamExuid: uint, mute: bool, connection: RtcConnectionint错误码索引
MuteRemoteVideoStreamExuid: uint, mute: bool, connection: RtcConnectionint错误码索引
PauseAllChannelMediaRelayExconnection: RtcConnectionint错误码索引
PlayEffectExconnection: RtcConnection, soundId: int, filePath: string, loopCount: int, pitch: double, pan: double, gain: int, publish?: bool, startPos?: intint错误码索引
PreloadEffectExconnection: RtcConnection, soundId: int, filePath: string, startPos?: intint错误码索引
RemoveVideoWatermarkExid: string, connection: RtcConnectionint错误码索引
ResumeAllChannelMediaRelayExconnection: RtcConnectionint错误码索引
SendCustomReportMessageExid: string, category: string, null: string, label: string, value: int, connection: RtcConnectionint错误码索引
SendStreamMessageExstreamId: int, data: byte[], length: uint, connection: RtcConnectionint错误码索引
SetDualStreamModeExmode: SIMULCAST_STREAM_MODE, streamConfig: SimulcastStreamConfig, connection: RtcConnectionint错误码索引
SetRemoteRenderModeExuid: uint, renderMode: RENDER_MODE_TYPE, mirrorMode: VIDEO_MIRROR_MODE_TYPE, connection: RtcConnectionint错误码索引
SetRemoteVideoStreamTypeExuid: uint, streamType: VIDEO_STREAM_TYPE, connection: RtcConnectionint错误码索引
SetRemoteVideoSubscriptionOptionsExuid: uint, options: VideoSubscriptionOptions, connection: RtcConnectionint错误码索引
SetRemoteVoicePositionExuid: uint, pan: double, gain: double, connection: RtcConnectionint错误码索引
SetSubscribeAudioAllowlistExuidList: unknown, uidNumber: unknown, connection: unknownunknown错误码索引
SetSubscribeAudioBlocklistExuidList: uint[], uidNumber: int, connection: RtcConnectionint错误码索引
SetSubscribeVideoAllowlistExuidList: uint[], uidNumber: int, connection: RtcConnectionint错误码索引
SetSubscribeVideoBlocklistExuidList: uint[], uidNumber: int, connection: RtcConnectionint错误码索引
SetVideoEncoderConfigurationExconfig: VideoEncoderConfiguration, connection: RtcConnectionint错误码索引
SetupRemoteVideoExcanvas: VideoCanvas, connection: RtcConnectionint错误码索引
StartMediaRenderingTracingExconnection: RtcConnectionint错误码索引
StartOrUpdateChannelMediaRelayExconfiguration: ChannelMediaRelayConfiguration, connection: RtcConnectionint错误码索引
StartRtmpStreamWithTranscodingExurl: string, transcoding: LiveTranscoding, connection: RtcConnectionint错误码索引
StartRtmpStreamWithoutTranscodingExurl: string, connection: RtcConnectionint错误码索引
StopChannelMediaRelayExconnection: RtcConnectionint错误码索引
StopRtmpStreamExurl: string, connection: RtcConnectionint错误码索引
TakeSnapshotExconnection: RtcConnection, uid: uint, filePath: stringint错误码索引
UpdateChannelMediaOptionsExoptions: ChannelMediaOptions, connection: RtcConnectionint错误码索引
UpdateRtmpTranscodingExtranscoding: LiveTranscoding, connection: RtcConnectionint错误码索引
IVideoDeviceManager 5 方法 / 0 属性
typescript
EnumerateVideoDevices(): DeviceInfo[]
GetCapability(deviceIdUTF8: string, deviceCapabilityNumber: uint, capability: VideoFormat): int
GetDevice(deviceIdUTF8: string): int
NumberOfCapabilities(deviceIdUTF8: string): int
SetDevice(deviceIdUTF8: string): int

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

方法参数返回值错误
EnumerateVideoDevices—DeviceInfo[]错误码索引
GetCapabilitydeviceIdUTF8: string, deviceCapabilityNumber: uint, capability: VideoFormatint错误码索引
GetDevicedeviceIdUTF8: stringint错误码索引
NumberOfCapabilitiesdeviceIdUTF8: stringint错误码索引
SetDevicedeviceIdUTF8: stringint错误码索引
IVideoEffectObject 9 方法 / 0 属性
typescript
AddOrUpdateVideoEffect(nodeId: uint, templateName: string): int
GetVideoEffectBoolParam(option: string, key: string): bool
GetVideoEffectFloatParam(option: string, key: string): float
GetVideoEffectIntParam(option: string, key: string): int
PerformVideoEffectAction(nodeId: uint, actionId: VIDEO_EFFECT_ACTION): int
RemoveVideoEffect(nodeId: uint): int
SetVideoEffectBoolParam(option: string, key: string, param: bool): int
SetVideoEffectFloatParam(option: string, key: string, param: float): int
SetVideoEffectIntParam(option: string, key: string, param: int): int

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

方法参数返回值错误
AddOrUpdateVideoEffectnodeId: uint, templateName: stringint错误码索引
GetVideoEffectBoolParamoption: string, key: stringbool错误码索引
GetVideoEffectFloatParamoption: string, key: stringfloat错误码索引
GetVideoEffectIntParamoption: string, key: stringint错误码索引
PerformVideoEffectActionnodeId: uint, actionId: VIDEO_EFFECT_ACTIONint错误码索引
RemoveVideoEffectnodeId: uintint错误码索引
SetVideoEffectBoolParamoption: string, key: string, param: boolint错误码索引
SetVideoEffectFloatParamoption: string, key: string, param: floatint错误码索引
SetVideoEffectIntParamoption: string, key: string, param: intint错误码索引
IVideoEncodedFrameObserver 1 方法 / 0 属性
typescript
OnEncodedVideoFrameReceived(channelId: string, uid: uint, imageBufferPtr: IntPtr, length: UInt64, videoEncodedFrameInfo: EncodedVideoFrameInfo): bool

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

方法参数返回值错误
OnEncodedVideoFrameReceivedchannelId: string, uid: uint, imageBufferPtr: IntPtr, length: UInt64, videoEncodedFrameInfo: EncodedVideoFrameInfobool错误码索引
IVideoFrameObserver 3 方法 / 0 属性
typescript
OnCaptureVideoFrame(sourceType: VIDEO_SOURCE_TYPE, videoFrame: VideoFrame): bool
OnPreEncodeVideoFrame(sourceType: VIDEO_SOURCE_TYPE, videoFrame: VideoFrame): bool
OnRenderVideoFrame(channelId: string, remoteUid: uint, videoFrame: VideoFrame): bool

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

方法参数返回值错误
OnCaptureVideoFramesourceType: VIDEO_SOURCE_TYPE, videoFrame: VideoFramebool错误码索引
OnPreEncodeVideoFramesourceType: VIDEO_SOURCE_TYPE, videoFrame: VideoFramebool错误码索引
OnRenderVideoFramechannelId: string, remoteUid: uint, videoFrame: VideoFramebool错误码索引
LastmileProbeConfig 0 方法 / 4 属性
属性类型只读
probeUplinkbool否
probeDownlinkbool否
expectedUplinkBitrateuint否
expectedDownlinkBitrateuint否
LastmileProbeOneWayResult 0 方法 / 3 属性
属性类型只读
packetLossRateuint否
jitteruint否
availableBandwidthuint否
LastmileProbeResult 0 方法 / 4 属性
属性类型只读
stateLASTMILE_PROBE_RESULT_STATE否
uplinkReportLastmileProbeOneWayResult否
downlinkReportLastmileProbeOneWayResult否
rttuint否
LeaveChannelOptions 0 方法 / 3 属性
属性类型只读
stopAudioMixingbool否
stopAllEffectbool否
stopMicrophoneRecordingbool否
LiveStreamAdvancedFeature 0 方法 / 2 属性
属性类型只读
featureNamestring否
openedbool否
LiveTranscoding 0 方法 / 23 属性
属性类型只读
widthint否
heightint否
videoBitrateint否
videoFramerateint否
lowLatencybool否
videoGopint否
videoCodecProfileVIDEO_CODEC_PROFILE_TYPE否
videoCodecTypeVIDEO_CODEC_TYPE_FOR_STREAM否
transcodingUsersTranscodingUser[]否
transcodingExtraInfostring否
backgroundColoruint否
userCountuint否
metadatastring否
watermarkRtcImage[]否
backgroundImageRtcImage[]否
audioSampleRateAUDIO_SAMPLE_RATE_TYPE否
audioBitrateint否
audioChannelsint否
audioCodecProfileAUDIO_CODEC_PROFILE_TYPE否
watermarkCountuint否
backgroundImageCountuint否
advancedFeaturesLiveStreamAdvancedFeature[]否
advancedFeatureCountuint否
LocalAccessPointConfiguration 0 方法 / 7 属性
属性类型只读
ipListstring[]否
ipListSizeint否
domainListstring[]否
domainListSizeint否
verifyDomainNamestring否
modeLOCAL_PROXY_MODE否
advancedConfigAdvancedConfigInfo否
LocalAudioMixerConfiguration 0 方法 / 3 属性
属性类型只读
streamCountuint否
audioInputStreamsMixedAudioStream[]否
syncWithLocalMicunknown否
LocalAudioStats 0 方法 / 8 属性
属性类型只读
numChannelsint否
sentSampleRateint否
sentBitrateunknown否
txPacketLossRateushort否
internalCodecint sentBitrate int否
audioDeviceDelayint否
earMonitorDelayunknown否
aecEstimatedDelayint audioPlayoutDelay int earMonitorDelay int否
LocalSpatialAudioConfig 0 方法 / 1 属性
属性类型只读
rtcEngineIRtcEngine否
LocalTranscoderConfiguration 0 方法 / 3 属性
属性类型只读
streamCountuint否
videoInputStreamsTranscodingVideoStream[]否
videoOutputConfigurationVideoEncoderConfiguration否
LocalVideoStats 0 方法 / 22 属性
属性类型只读
uiduint否
sentBitrateint否
sentFrameRateint否
captureFrameRateint否
captureFrameWidthint否
captureFrameHeightint否
regulatedCaptureFrameRateint否
regulatedCaptureFrameWidthint否
regulatedCaptureFrameHeightint否
encoderOutputFrameRateint否
rendererOutputFrameRateint否
targetBitrateint否
targetFrameRateint否
qualityAdaptIndicationQUALITY_ADAPT_INDICATION否
encodedBitrateint否
encodedFrameHeightint否
encodedFrameWidthint否
encodedFrameCountint否
codecTypeVIDEO_CODEC_TYPE否
txPacketLossRateushort否
captureBrightnessLevelCAPTURE_BRIGHTNESS_LEVEL_TYPE否
hwEncoderAcceleratingint否
LogConfig 0 方法 / 3 属性
属性类型只读
filePathstring否
fileSizeInKBuint否
levelLOG_LEVEL否
LogUploadServerInfo 0 方法 / 4 属性
属性类型只读
serverDomainunknown否
serverPathunknown否
serverPortunknown否
serverHttpsunknown否
LowlightEnhanceOptions 0 方法 / 2 属性
属性类型只读
levelLOW_LIGHT_ENHANCE_LEVEL否
modeLOW_LIGHT_ENHANCE_MODE否
MediaRecorderConfiguration 0 方法 / 11 属性
属性类型只读
storagePathstring否
containerFormatMediaRecorderContainerFormat否
streamTypeMediaRecorderStreamType否
maxDurationMsint否
recorderInfoUpdateIntervalint否
widthint否
heightint否
fpsint否
sample_rateint否
channel_numint否
videoSourceTypeVIDEO_SOURCE_TYPE否
MediaSource 0 方法 / 9 属性
属性类型只读
urlstring否
uristring否
startPosint64_t否
autoPlaybool否
enableCachebool否
enableMultiAudioTrackunknown否
isAgoraSourceOptional否
isLiveSourceOptional否
providerIMediaPlayerCustomDataProvider否
Metadata 0 方法 / 5 属性
属性类型只读
channelIdstring否
uiduint否
sizeuint否
bufferIntPtr否
timeStampMslong否
MultipathStats 0 方法 / 8 属性
属性类型只读
lanTxBytesuint否
lanRxBytesuint否
wifiTxBytesuint否
wifiRxBytesuint否
mobileTxBytesuint否
mobileRxBytesuint否
activePathNumint否
pathStatsPathStats[]否
Music 0 方法 / 12 属性
属性类型只读
songCodeInt64否
namestring否
singerstring否
posterstring否
releaseTimestring否
typeint否
pitchTypeint否
durationSint否
lyricListint[]否
climaxSegmentListClimaxSegment[]否
lyricCountint否
climaxSegmentCountint否
MusicCacheInfo 0 方法 / 2 属性
属性类型只读
songCodeInt64否
statusMUSIC_CACHE_STATUS_TYPE否
MusicChartInfo 0 方法 / 2 属性
属性类型只读
chartNamestring否
idint否
MusicCollection 0 方法 / 5 属性
属性类型只读
countint否
totalint否
pageint否
pageSizeint否
musicListunknown否
MusicContentCenterConfiguration 0 方法 / 4 属性
属性类型只读
appIdstring否
tokenstring否
mccUidUInt64否
maxCacheSizeUInt32否
PathStats 0 方法 / 3 属性
属性类型只读
typeMultipathType否
txKBitRateint否
rxKBitRateint否
PlayerPlaybackStats 0 方法 / 4 属性
属性类型只读
videoFpsint否
videoBitrateInKbpsint否
audioBitrateInKbpsint否
totalBitrateInKbpsint否
PlayerStreamInfo 0 方法 / 13 属性
属性类型只读
streamIndexint否
streamTypeMEDIA_STREAM_TYPE否
codecNamestring否
languagestring否
videoFrameRateint否
videoBitRateint否
videoWidthint否
videoHeightint否
videoRotationint否
audioSampleRateint否
audioChannelsint否
audioBitsPerSampleint否
durationint64_t否
PlayerUpdatedInfo 0 方法 / 6 属性
属性类型只读
deviceIdOptional否
videoHeightunknown否
videoWidthunknown否
audioSampleRateunknown否
audioChannelsunknown否
audioBitsPerSampleunknown否
RecorderInfo 0 方法 / 3 属性
属性类型只读
fileNamestring否
durationMsuint否
fileSizeuint否
RecorderStreamInfo 0 方法 / 3 属性
属性类型只读
channelIdstring否
uiduint否
typeRecorderStreamType否
Rectangle 0 方法 / 4 属性
属性类型只读
xint否
yint否
widthint否
heightint否
RemoteAudioStats 0 方法 / 16 属性
属性类型只读
uiduint否
qualityint否
networkTransportDelayint否
jitterBufferDelayint否
audioLossRateint否
numChannelsint否
receivedSampleRateint否
receivedBitrateint否
totalFrozenTimeint否
frozenRateint否
totalActiveTimeint否
publishDurationint否
qoeQualityint否
qualityChangedReasonint否
mosValueint否
e2eDelayint否
RemoteVideoStats 0 方法 / 17 属性
属性类型只读
uiduint否
delayint否
e2eDelayint否
widthint否
heightint否
receivedBitrateint否
decoderOutputFrameRateint否
rendererOutputFrameRateint否
frameLossRateint否
packetLossRateint否
rxStreamTypeVIDEO_STREAM_TYPE否
totalFrozenTimeint否
frozenRateint否
totalActiveTimeint否
publishDurationint否
avSyncTimeMsint否
mosValueint否
RemoteVoicePositionInfo 0 方法 / 2 属性
属性类型只读
positionfloat[]否
forwardfloat[]否
RtcConnection 0 方法 / 2 属性
属性类型只读
channelIdstring否
localUiduint否
RtcEngineContext 0 方法 / 9 属性
属性类型只读
eventHandlerunknown否
appIdstring否
contextUInt64否
channelProfileCHANNEL_PROFILE_TYPE否
audioScenarioAUDIO_SCENARIO_TYPE否
areaCodeAREA_CODE否
logConfigLogConfig否
domainLimitbool否
autoRegisterAgoraExtensionsbool否
RtcImage 0 方法 / 7 属性
属性类型只读
urlstring否
xint否
yint否
widthint否
heightint否
zOrderint否
alphadouble否
RtcStats 0 方法 / 24 属性
属性类型只读
durationuint否
txBytesuint否
rxBytesuint否
txAudioBytesuint否
txVideoBytesuint否
rxAudioBytesuint否
rxVideoBytesuint否
txKBitRateushort否
rxKBitRateushort否
rxAudioKBitRateushort否
txAudioKBitRateushort否
rxVideoKBitRateushort否
txVideoKBitRateushort否
lastmileDelayushort否
txPacketLossRateint否
rxPacketLossRateint否
userCountuint否
cpuAppUsagedouble否
cpuTotalUsagedouble否
connectTimeMsint否
gatewayRttint否
memoryAppUsageRatiodouble否
memoryTotalUsageRatiodouble否
memoryAppUsageInKbytesint否
ScreenAudioParameters 0 方法 / 3 属性
属性类型只读
sampleRateint否
channelsint否
captureSignalVolumeint否
ScreenCaptureConfiguration 0 方法 / 6 属性
属性类型只读
isCaptureWindowbool否
displayIdlong否
screenRectRectangle否
windowIdlong否
parametersunknown否
regionRectRectangle否
ScreenCaptureParameters 0 方法 / 10 属性
属性类型只读
dimensionsVideoDimensions否
frameRateint否
bitrateint否
captureMouseCursorbool否
windowFocusbool否
excludeWindowListview_t[]否
enableHighLightbool否
highLightColoruint否
highLightWidthint否
excludeWindowCountint否
ScreenCaptureParameters2 0 方法 / 4 属性
属性类型只读
captureAudiobool否
audioParamsScreenAudioParameters否
captureVideobool否
videoParamsScreenVideoParameters否
ScreenCaptureSourceInfo 0 方法 / 10 属性
属性类型只读
typeScreenCaptureSourceType否
sourceIdlong否
sourceNamestring否
thumbImageThumbImageBuffer否
iconImageThumbImageBuffer否
processPathstring否
sourceTitlestring否
primaryMonitorbool否
positionRectangle否
sourceDisplayIdlong否
ScreenVideoParameters 0 方法 / 4 属性
属性类型只读
dimensionsVideoDimensions否
frameRateint否
bitrateint否
contentHintVIDEO_CONTENT_HINT否
SegmentationProperty 0 方法 / 3 属性
属性类型只读
modelTypeSEG_MODEL_TYPE否
greenCapacityfloat否
screenColorTypeSCREEN_COLOR_TYPE否
SimulcastStreamConfig 0 方法 / 3 属性
属性类型只读
dimensionsVideoDimensions否
kBitrateint否
framerateint否
SnapshotConfig 0 方法 / 2 属性
属性类型只读
filePathstring否
positionVIDEO_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否
namestring否
ThumbImageBuffer 0 方法 / 4 属性
属性类型只读
bufferInt64否
lengthuint否
widthuint否
heightuint否
TranscodingUser 0 方法 / 8 属性
属性类型只读
uiduint否
xint否
yint否
widthint否
heightint否
zOrderint否
alphadouble否
audioChannelint否
TranscodingVideoStream 0 方法 / 11 属性
属性类型只读
sourceTypeVIDEO_SOURCE_TYPE否
remoteUserUiduint否
imageUrlstring否
mediaPlayerIdint否
xint否
yint否
widthint否
heightint否
zOrderint否
alphadouble否
mirrorbool否
UplinkNetworkInfo 0 方法 / 1 属性
属性类型只读
video_encoder_target_bitrate_bpsint否
UserAudioSpectrumInfo 0 方法 / 2 属性
属性类型只读
uiduint否
spectrumDataAudioSpectrumData否
UserInfo 0 方法 / 2 属性
属性类型只读
uiduint否
userAccountstring否
VideoCanvas 0 方法 / 12 属性
属性类型只读
uiduint否
subviewUiduint否
viewview_t否
renderModeRENDER_MODE_TYPE否
mirrorModeVIDEO_MIRROR_MODE_TYPE否
sourceTypeVIDEO_SOURCE_TYPE否
setupModeVIDEO_VIEW_SETUP_MODE否
mediaPlayerIdint否
cropAreaRectangle否
backgroundColoruint否
enableAlphaMaskbool否
positionVIDEO_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 属性
属性类型只读
widthunknown否
heightunknown否
fpsunknown否
VideoFrame 0 方法 / 22 属性
属性类型只读
typeVIDEO_PIXEL_FORMAT否
widthint否
heightint否
yStrideint否
uStrideint否
vStrideint否
yBufferbyte[]否
uBufferbyte[]否
vBufferbyte[]否
rotationint否
renderTimeMslong否
avsync_typeint否
metadata_bufferIntPtr否
metadata_sizeint否
sharedContextIntPtr否
textureIdint否
d3d11Texture2dIntPtr否
matrixfloat[]否
colorSpaceColorSpace否
alphaBufferbyte[]否
alphaStitchModeALPHA_STITCH_MODE否
metaInfoIVideoFrameMetaInfo否
VideoFrameBufferConfig 0 方法 / 3 属性
属性类型只读
typeVIDEO_SOURCE_TYPE否
iduint否
keystring否
VideoLayout 0 方法 / 8 属性
属性类型只读
channelIdstring否
uiduint否
strUidstring否
xuint否
yunknown否
widthuint y uint否
heightuint否
videoStateuint否
VideoRenderingTracingInfo 0 方法 / 7 属性
属性类型只读
elapsedTimeint否
start2JoinChannelint否
join2JoinSuccessint否
joinSuccess2RemoteJoinedint否
remoteJoined2SetViewint否
remoteJoined2UnmuteVideoint否
remoteJoined2PacketReceivedint否
VideoSubscriptionOptions 0 方法 / 2 属性
属性类型只读
typeOptional否
encodedFrameOnlyOptional否
VideoSurface 3 方法 / 0 属性
typescript
OnTextureSizeModify(): unknown
SetEnable(enable: bool): void
SetForUser(uid?: uint, channelId?: string, source_type?: VIDEO_SOURCE_TYPE): void

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

方法参数返回值错误
OnTextureSizeModify—unknown错误码索引
SetEnableenable: boolvoid错误码索引
SetForUseruid?: uint, channelId?: string, source_type?: VIDEO_SOURCE_TYPEvoid错误码索引
VirtualBackgroundSource 0 方法 / 4 属性
属性类型只读
background_source_typeBACKGROUND_SOURCE_TYPE否
coloruint否
sourcestring否
blur_degreeBACKGROUND_BLUR_DEGREE否
WatermarkBuffer 0 方法 / 5 属性
属性类型只读
widthint否
heightint否
lengthint否
formatVIDEO_PIXEL_FORMAT否
bufferIntPtr否
WatermarkConfig 0 方法 / 7 属性
属性类型只读
idstring否
typeWATERMARK_SOURCE_TYPE否
bufferWatermarkBuffer否
timestampWatermarkTimestamp否
literalWatermarkLiteral否
imageUrlstring否
optionsWatermarkOptions否
WatermarkLiteral 0 方法 / 4 属性
属性类型只读
fontSizeint否
strokeWidthint否
wmLiteralstring否
fontFilePathstring否
WatermarkOptions 0 方法 / 6 属性
属性类型只读
visibleInPreviewbool否
positionInLandscapeModeRectangle否
positionInPortraitModeRectangle否
watermarkRatioWatermarkRatio否
modeWATERMARK_FIT_MODE否
zOrderint否
WatermarkRatio 0 方法 / 3 属性
属性类型只读
xRatiofloat否
yRatiofloat否
widthRatiofloat否
WatermarkTimestamp 0 方法 / 4 属性
属性类型只读
fontSizeint否
fontFilePathstring否
strokeWidthint否
formatstring否

枚举

枚举成员数示例值
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 = 65793
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_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 = 0
AUDIO_SOURCE_TYPE7AUDIO_SOURCE_MICROPHONE = 0
AUDIO_TRACK_TYPE2AUDIO_TRACK_MIXABLE = 0
AudioRoute12ROUTE_DEFAULT = -1
BACKGROUND_BLUR_DEGREE3BLUR_DEGREE_LOW = 1
BACKGROUND_SOURCE_TYPE5BACKGROUND_NONE = 0
BITRATE2STANDARD_BITRATE = 0
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
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_TYPE48ERR_OK = 0
EXPERIENCE_POOR_REASON5EXPERIENCE_REASON_NONE = 0
EXPERIENCE_QUALITY_TYPE2EXPERIENCE_QUALITY_GOOD = 0
EXTERNAL_VIDEO_SOURCE_TYPE2VIDEO_FRAME = 0
FACE_SHAPE_AREA30FACE_SHAPE_AREA_NONE = -1
FACE_SHAPE_BEAUTY_STYLE3FACE_SHAPE_BEAUTY_STYLE_FEMALE = 0
FeatureType2VIDEO_VIRTUAL_BACKGROUND = 1
FRAME_RATE7FRAME_RATE_FPS_1 = 1
HEADPHONE_EQUALIZER_PRESET3HEADPHONE_EQUALIZER_OFF = null
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_MODE2kConnectivityFirst = 0
LOCAL_VIDEO_EVENT_TYPE4LOCAL_VIDEO_EVENT_TYPE_SCREEN_CAPTURE_WINDOW_HIDDEN = 1
LOCAL_VIDEO_STREAM_REASON27LOCAL_VIDEO_STREAM_REASON_OK = 0
LOCAL_VIDEO_STREAM_STATE4LOCAL_VIDEO_STREAM_STATE_STOPPED = 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_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_REASON17PLAYER_REASON_NONE = 0
MEDIA_PLAYER_STATE9PLAYER_STATE_IDLE = 0
MEDIA_SOURCE_TYPE7AUDIO_PLAYOUT_SOURCE = 0
MEDIA_STREAM_TYPE4STREAM_TYPE_UNKNOWN = 0
MEDIA_TRACE_EVENT2MEDIA_TRACE_EVENT_VIDEO_RENDERED = 0
MediaRecorderContainerFormat1FORMAT_MP4 = 1
MediaRecorderStreamType3STREAM_TYPE_AUDIO = 1
METADATA_TYPE2UNKNOWN_METADATA = -1
MultipathMode1Duplicate = 0
MultipathType4LAN = 0
MUSIC_CACHE_STATUS_TYPE2MUSIC_CACHE_STATUS_TYPE_CACHED = 0
MusicContentCenterStateReason8kMusicContentCenterReasonOk = 0
MusicPlayMode3kMusicPlayModeOriginal = 0
NETWORK_TYPE8NETWORK_TYPE_UNKNOWN = -1
OBSERVER_MODE2RAW_DATA = null
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
RENEW_TOKEN_ERROR_CODE7RENEW_TOKEN_SUCCESS = 0
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_REASON16RTMP_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_COLOR_TYPE3SCREEN_COLOR_AUTO = 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_EFFECT_ACTION2SAVE = 1
VIDEO_EFFECT_NODE_ID3BEAUTY = 1
VIDEO_FRAME_TYPE6VIDEO_FRAME_TYPE_BLANK_FRAME = 0
VIDEO_MIRROR_MODE_TYPE3VIDEO_MIRROR_MODE_AUTO = 0
VIDEO_MODULE_POSITION4POSITION_POST_CAPTURER = 1
VIDEO_OBSERVER_FRAME_TYPE4FRAME_TYPE_DEFAULT = null
VIDEO_ORIENTATION4VIDEO_ORIENTATION_0 = 0
VIDEO_PIXEL_FORMAT5VIDEO_PIXEL_DEFAULT = 0
VIDEO_SOURCE_TYPE19VIDEO_SOURCE_CAMERA_PRIMARY = 0
VIDEO_STREAM_TYPE8VIDEO_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 = 0
WATERMARK_SOURCE_TYPE4IMAGE = 0
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
AUDIO_CODEC_PROFILE_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_LOW65793
AUDIO_ENCODING_TYPE_AAC_16000_MEDIUM65794
AUDIO_ENCODING_TYPE_AAC_32000_LOW66049
AUDIO_ENCODING_TYPE_AAC_32000_MEDIUM66050
AUDIO_ENCODING_TYPE_AAC_32000_HIGH66051
AUDIO_ENCODING_TYPE_AAC_48000_MEDIUM66306
AUDIO_ENCODING_TYPE_AAC_48000_HIGH66307
AUDIO_ENCODING_TYPE_OPUS_16000_LOW131329
AUDIO_ENCODING_TYPE_OPUS_16000_MEDIUM131330
AUDIO_ENCODING_TYPE_OPUS_48000_MEDIUM131842
AUDIO_ENCODING_TYPE_OPUS_48000_HIGH131843
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_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_NONE0
AUDIO_SESSION_OPERATION_RESTRICTION_SET_CATEGORY1
AUDIO_SESSION_OPERATION_RESTRICTION_CONFIGURE_SESSION2
AUDIO_SESSION_OPERATION_RESTRICTION_DEACTIVATE_SESSION4
AUDIO_SESSION_OPERATION_RESTRICTION_ALL128
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 5 个成员
成员值
BACKGROUND_NONE0
BACKGROUND_COLOR1
BACKGROUND_IMG2
BACKGROUND_BLUR3
BACKGROUND_VIDEO4
BITRATE 2 个成员
成员值
STANDARD_BITRATE0
COMPATIBLE_BITRATE-1
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
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 48 个成员
成员值
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_TOKENnull
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_PCMSEND_FORMAT200
ERR_PCMSEND_BUFFEROVERFLOW201
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 30 个成员
成员值
FACE_SHAPE_AREA_NONE-1
FACE_SHAPE_AREA_HEADSCALE100
FACE_SHAPE_AREA_FOREHEAD101
FACE_SHAPE_AREA_FACECONTOUR102
FACE_SHAPE_AREA_FACELENGTH103
FACE_SHAPE_AREA_FACEWIDTH104
FACE_SHAPE_AREA_CHEEKBONE105
FACE_SHAPE_AREA_CHEEK106
FACE_SHAPE_AREA_MANDIBLE107
FACE_SHAPE_AREA_CHIN108
FACE_SHAPE_AREA_EYESCALE200
FACE_SHAPE_AREA_EYEDISTANCE201
FACE_SHAPE_AREA_EYEPOSITION202
FACE_SHAPE_AREA_LOWEREYELID203
FACE_SHAPE_AREA_EYEPUPILS204
FACE_SHAPE_AREA_EYEINNERCORNER205
FACE_SHAPE_AREA_EYEOUTERCORNER206
FACE_SHAPE_AREA_NOSELENGTH300
FACE_SHAPE_AREA_NOSEWIDTH301
FACE_SHAPE_AREA_NOSEWING302
FACE_SHAPE_AREA_NOSEROOT303
FACE_SHAPE_AREA_NOSEBRIDGE304
FACE_SHAPE_AREA_NOSETIP305
FACE_SHAPE_AREA_NOSEGENERAL306
FACE_SHAPE_AREA_MOUTHSCALE400
FACE_SHAPE_AREA_MOUTHPOSITION401
FACE_SHAPE_AREA_MOUTHSMILE402
FACE_SHAPE_AREA_MOUTHLIP403
FACE_SHAPE_AREA_EYEBROWPOSITION500
FACE_SHAPE_AREA_EYEBROWTHICKNESS501
FACE_SHAPE_BEAUTY_STYLE 3 个成员
成员值
FACE_SHAPE_BEAUTY_STYLE_FEMALE0
FACE_SHAPE_BEAUTY_STYLE_MALE1
FACE_SHAPE_BEAUTY_STYLE_NATURAL2
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
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 个成员
成员值
kConnectivityFirst0
kLocalOnly1
LOCAL_VIDEO_EVENT_TYPE 4 个成员
成员值
LOCAL_VIDEO_EVENT_TYPE_SCREEN_CAPTURE_WINDOW_HIDDEN1
LOCAL_VIDEO_EVENT_TYPE_SCREEN_CAPTURE_WINDOW_RECOVER_FROM_HIDDEN2
LOCAL_VIDEO_EVENT_TYPE_SCREEN_CAPTURE_STOPPED_BY_USER3
LOCAL_VIDEO_EVENT_TYPE_SCREEN_CAPTURE_SYSTEM_INTERNAL_ERROR4
LOCAL_VIDEO_STREAM_REASON 27 个成员
成员值
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_SCREEN_CAPTURE_EXCLUDE_WINDOW_FAILED34
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_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_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 17 个成员
成员值
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_TOKEN_EXPIRED-15
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 7 个成员
成员值
AUDIO_PLAYOUT_SOURCE0
AUDIO_RECORDING_SOURCE1
PRIMARY_CAMERA_SOURCE2
SECONDARY_CAMERA_SOURCE3
CUSTOM_VIDEO_SOURCE6
SPEECH_DRIVEN_VIDEO_SOURCE13
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_AUDIO1
STREAM_TYPE_VIDEO2
STREAM_TYPE_BOTH3
METADATA_TYPE 2 个成员
成员值
UNKNOWN_METADATA-1
VIDEO_METADATA0
MultipathMode 1 个成员
成员值
Duplicate0
MultipathType 4 个成员
成员值
LAN0
WIFI1
Mobile2
Unknown99
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
OBSERVER_MODE 2 个成员
成员值
RAW_DATAnull
INTPTRnull
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_REASON_WRITE_FAILED1
RECORDER_REASON_NO_STREAM2
RECORDER_REASON_OVER_MAX_DURATION3
RECORDER_REASON_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
RENEW_TOKEN_ERROR_CODE 7 个成员
成员值
RENEW_TOKEN_SUCCESS0
RENEW_TOKEN_FAILURE1
RENEW_TOKEN_TOKEN_EXPIRED2
RENEW_TOKEN_INVALID_TOKEN3
RENEW_TOKEN_INVALID_CHANNEL_NAME4
RENEW_TOKEN_INCONSISTENT_APPID5
RENEW_TOKEN_CANCELED_BY_NEW_REQUEST6
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 16 个成员
成员值
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_UNPUBLISH_REASON_OK100
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_COLOR_TYPE 3 个成员
成员值
SCREEN_COLOR_AUTO0
SCREEN_COLOR_GREEN1
SCREEN_COLOR_BLUE2
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_MEETING1
APPLICATION_SCENARIO_1V12
APPLICATION_SCENARIO_LIVESHOW3
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_EFFECT_ACTION 2 个成员
成员值
SAVE1
RESET2
VIDEO_EFFECT_NODE_ID 3 个成员
成员值
BEAUTY1
STYLE_MAKEUP2
FILTER4
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_OBSERVER_FRAME_TYPE 4 个成员
成员值
FRAME_TYPE_DEFAULTnull
FRAME_TYPE_YUV420null
FRAME_TYPE_YUV422null
FRAME_TYPE_RGBAnull
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_SOURCE_TYPE 19 个成员
成员值
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_SPEECH_DRIVEN15
VIDEO_SOURCE_UNKNOWN100
VIDEO_STREAM_TYPE 8 个成员
成员值
VIDEO_STREAM_HIGH0
VIDEO_STREAM_LOW1
VIDEO_STREAM_LAYER_14
VIDEO_STREAM_LAYER_25
VIDEO_STREAM_LAYER_36
VIDEO_STREAM_LAYER_47
VIDEO_STREAM_LAYER_58
VIDEO_STREAM_LAYER_69
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_POSITION0
FIT_MODE_USE_IMAGE_RATIO1
WATERMARK_SOURCE_TYPE 4 个成员
成员值
IMAGE0
BUFFER1
LITERAL2
TIMESTAMPS3

错误码常量

常量值
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_TOKENnull
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_PCMSEND_BUFFEROVERFLOW201
ERR_PCMSEND_FORMAT200
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
IAudioFrameObserverOnPlaybackAudioFrameBeforeMixing
IAudioFrameObserverBaseOnEarMonitoringAudioFrame
IAudioFrameObserverBaseOnMixedAudioFrame
IAudioFrameObserverBaseOnPlaybackAudioFrame
IAudioFrameObserverBaseOnRecordAudioFrame
IAudioSpectrumObserverOnLocalAudioSpectrum
IAudioSpectrumObserverOnRemoteAudioSpectrum
IMediaPlayerCustomDataProviderOnReadData
IMediaPlayerCustomDataProviderOnSeek
IMediaRecorderSetMediaRecorderObserver
IMediaRecorderStartRecording
IMediaRecorderStopRecording
IMetadataObserverOnReadyToSendMetadata
IMusicContentCenterCreateMusicPlayer
IMusicContentCenterDestroyMusicPlayer
IMusicContentCenterGetCaches
IMusicContentCenterGetInternalSongCode
IMusicContentCenterGetLyric
IMusicContentCenterGetMusicCharts
IMusicContentCenterGetMusicCollectionByMusicChartId
IMusicContentCenterGetSongSimpleInfo
IMusicContentCenterInitialize
IMusicContentCenterIsPreloaded
IMusicContentCenterPreload
IMusicContentCenterRegisterEventHandler
IMusicContentCenterRemoveCache
IMusicContentCenterRenewToken
IMusicContentCenterSearchMusic
IMusicContentCenterUnregisterEventHandler
IMusicPlayerOpen
IMusicPlayerSetPlayMode
IRtcEngineAdjustCustomAudioPlayoutVolume
IRtcEngineAdjustCustomAudioPublishVolume
IRtcEngineConfigRhythmPlayer
IRtcEngineCreateAgoraRtcEngine
IRtcEngineCreateMediaRecorder
IRtcEngineDestroyMediaRecorder
IRtcEngineEnableContentInspect
IRtcEngineEnableCustomAudioLocalPlayback
IRtcEngineEnableEncryption
IRtcEngineEnableExtension
IRtcEngineEnableFaceDetection
IRtcEngineEnableLoopbackRecording
IRtcEngineGetCallId
IRtcEngineGetExtensionProperty
IRtcEngineGetFaceShapeAreaOptions
IRtcEngineGetFaceShapeBeautyOptions
IRtcEngineGetMusicContentCenter
IRtcEngineGetNativeHandler
IRtcEngineIsFeatureAvailableOnDevice
IRtcEngineLoadExtensionProvider
IRtcEnginePauseAllChannelMediaRelay
IRtcEngineQueryCameraFocalLengthCapability
IRtcEngineRegisterExtension
IRtcEngineResumeAllChannelMediaRelay
IRtcEngineSendMetadata
IRtcEngineSetAdvancedAudioOptions
IRtcEngineSetAudioSessionOperationRestriction
IRtcEngineSetDefaultAudioRouteToSpeakerphone
IRtcEngineSetExtensionProperty
IRtcEngineSetExtensionProviderProperty
IRtcEngineSetExternalMediaProjection
IRtcEngineSetExternalRemoteEglContext
IRtcEngineSetFaceShapeAreaOptions
IRtcEngineSetFaceShapeBeautyOptions
IRtcEngineSetLocalAccessPoint
IRtcEngineSetLocalRenderTargetFps
IRtcEngineSetLocalVideoDataSourcePosition
IRtcEngineSetLowlightEnhanceOptions
IRtcEngineSetMaxMetadataSize
IRtcEngineSetRemoteRenderTargetFps
IRtcEngineSetRemoteSubscribeFallbackOption
IRtcEngineSetRemoteUserSpatialAudioParams
IRtcEngineSetRemoteVideoSubscriptionOptions
IRtcEngineSetRouteInCommunicationMode
IRtcEngineSetVideoDenoiserOptions
IRtcEngineStartLocalAudioMixer
IRtcEngineStartLocalVideoTranscoder
IRtcEngineStartOrUpdateChannelMediaRelay
IRtcEngineStartRhythmPlayer
IRtcEngineStartRtmpStreamWithTranscoding
IRtcEngineStartRtmpStreamWithoutTranscoding
IRtcEngineStartScreenCaptureByDisplayId
IRtcEngineStartScreenCaptureByScreenRect
IRtcEngineStartScreenCaptureByWindowId
IRtcEngineStopChannelMediaRelay
IRtcEngineStopLocalAudioMixer
IRtcEngineStopLocalVideoTranscoder
IRtcEngineStopRhythmPlayer
IRtcEngineStopRtmpStream
IRtcEngineUnRegisterAudioFrameObserver
IRtcEngineUpdateChannelMediaOptions
IRtcEngineUpdateLocalAudioMixerConfiguration
IRtcEngineUpdateLocalTranscoderConfiguration
IRtcEngineUpdatePreloadChannelToken
IRtcEngineUpdateRtmpTranscoding
IRtcEngineUpdateScreenCapture
IRtcEngineEventHandlerOnExtensionStartedWithContext
IRtcEngineExAddVideoWatermarkEx
IRtcEngineExAdjustUserPlaybackSignalVolumeEx
IRtcEngineExClearVideoWatermarkEx
IRtcEngineExCreateAgoraRtcEngineEx
IRtcEngineExCreateDataStreamEx
IRtcEngineExEnableAudioVolumeIndicationEx
IRtcEngineExEnableContentInspectEx
IRtcEngineExEnableDualStreamModeEx
IRtcEngineExEnableEncryptionEx
IRtcEngineExEnableLoopbackRecordingEx
IRtcEngineExGetCallIdEx
IRtcEngineExGetConnectionStateEx
IRtcEngineExJoinChannelEx
IRtcEngineExLeaveChannelEx
IRtcEngineExMuteAllRemoteAudioStreamsEx
IRtcEngineExMuteAllRemoteVideoStreamsEx
IRtcEngineExMuteLocalAudioStreamEx
IRtcEngineExMuteLocalVideoStreamEx
IRtcEngineExMuteRemoteAudioStreamEx
IRtcEngineExMuteRemoteVideoStreamEx
IRtcEngineExPauseAllChannelMediaRelayEx
IRtcEngineExPlayEffectEx
IRtcEngineExPreloadEffectEx
IRtcEngineExRemoveVideoWatermarkEx
IRtcEngineExResumeAllChannelMediaRelayEx
IRtcEngineExSendStreamMessageEx
IRtcEngineExSetDualStreamModeEx
IRtcEngineExSetRemoteRenderModeEx
IRtcEngineExSetRemoteVideoStreamTypeEx
IRtcEngineExSetRemoteVideoSubscriptionOptionsEx
IRtcEngineExSetRemoteVoicePositionEx
IRtcEngineExSetSubscribeAudioAllowlistEx
IRtcEngineExSetSubscribeAudioBlocklistEx
IRtcEngineExSetSubscribeVideoAllowlistEx
IRtcEngineExSetSubscribeVideoBlocklistEx
IRtcEngineExSetVideoEncoderConfigurationEx
IRtcEngineExSetupRemoteVideoEx
IRtcEngineExStartMediaRenderingTracingEx
IRtcEngineExStartOrUpdateChannelMediaRelayEx
IRtcEngineExStartRtmpStreamWithTranscodingEx
IRtcEngineExStartRtmpStreamWithoutTranscodingEx
IRtcEngineExStopChannelMediaRelayEx
IRtcEngineExStopRtmpStreamEx
IRtcEngineExTakeSnapshotEx
IRtcEngineExUpdateChannelMediaOptionsEx
IRtcEngineExUpdateRtmpTranscodingEx
IVideoDeviceManagerGetCapability
IVideoDeviceManagerNumberOfCapabilities
IVideoEncodedFrameObserverOnEncodedVideoFrameReceived
IVideoFrameObserverOnCaptureVideoFrame
IVideoFrameObserverOnPreEncodeVideoFrame
IVideoFrameObserverOnRenderVideoFrame
VideoSurfaceOnTextureSizeModify
VideoSurfaceSetEnable
VideoSurfaceSetForUser

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

内容依据公开 API 定义.

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