Flutter API 参考
构建时从公开 SDK 接口定义生成:接口、方法重载、属性、事件、枚举与错误码。
接口概览
本页列出 Flutter 端公开 API 的类、方法、重载、属性、事件与错误码,接口定义与 SDK 包版本一致。
| 核对项 | 数量 |
|---|---|
| 接口 / 类 | 150 |
| 方法 | 618 |
| 方法重载 | 618 |
| 属性 | 666 |
| 枚举 | 150 |
| 错误码常量 | 48 |
可用性
该端 SDK:正式可用。接口定义与 SDK 包版本一致;运行时的能力边界以实际发布的 SDK 包为准。
加入频道核心链路
按 join / leave / publish / subscribe 的典型调用顺序整理;参数表在“最小可运行链路”一节展开。
| 步骤 | 接口 | 方法 | 重载数 |
|---|---|---|---|
| 订阅远端媒体 | BaseSpatialAudioEngine | muteRemoteAudioStream | 1 |
| 创建 / 初始化 | LocalSpatialAudioEngine | initialize | 1 |
| 续期 Token | MusicContentCenter | renewToken | 1 |
| 开启视频与预览 | RtcEngine | enableVideo | 1 |
| 加入频道 | RtcEngine | joinChannel | 1 |
| 离开频道 | RtcEngine | leaveChannel | 1 |
| 频道场景 | RtcEngine | setChannelProfile | 1 |
| 角色切换 | RtcEngine | setClientRole | 1 |
| 本地画面 | RtcEngine | setupLocalVideo | 1 |
最小可运行链路的参数
| 参数 | 类型 | 可选 | 可变参数 |
|---|---|---|---|
mute | int uid,required bool | 否 | 否 |
token | String | 否 | 否 |
options | String token,required String channelId,required int uid,required ChannelMediaOptions | 否 | 否 |
options | LeaveChannelOptions? | 是 | 否 |
profile | ChannelProfileType | 否 | 否 |
options | ClientRoleType role,ClientRoleOptions? | 是 | 否 |
canvas | VideoCanvas | 否 | 否 |
接口索引
全部接口
AdvancedAudioOptions 0 方法 / 1 属性
| 属性 | 类型 | 只读 |
|---|---|---|
audioProcessingChannels | AudioProcessingChannels? | 否 |
AdvancedConfigInfo 0 方法 / 1 属性
| 属性 | 类型 | 只读 |
|---|---|---|
logUploadServer | LogUploadServerInfo? | 否 |
AdvanceOptions 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
encodingPreference | EncodingPreference? | 否 |
compressionPreference | CompressionPreference? | 否 |
encodeAlpha | bool? | 否 |
AgoraPipContentViewLayout 0 方法 / 4 属性
| 属性 | 类型 | 只读 |
|---|---|---|
padding | int? | 否 |
spacing | int? | 否 |
row | int? | 否 |
column | int? | 否 |
AgoraPipController 10 方法 / 0 属性
dispose(): Future
isPipActivated(): Future
pipDispose(): Future
pipIsAutoEnterSupported(): Future
pipIsSupported(): Future
pipSetup(options: AgoraPipOptions): Future
pipStart(): Future
pipStop(): Future
registerPipStateChangedObserver(observer: AgoraPipStateChangedObserver): Future
unregisterPipStateChangedObserver(): Future方法明细:10 / 10(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
dispose | — | Future | 错误码索引 |
isPipActivated | — | Future | 错误码索引 |
pipDispose | — | Future | 错误码索引 |
pipIsAutoEnterSupported | — | Future | 错误码索引 |
pipIsSupported | — | Future | 错误码索引 |
pipSetup | options: AgoraPipOptions | Future | 错误码索引 |
pipStart | — | Future | 错误码索引 |
pipStop | — | Future | 错误码索引 |
registerPipStateChangedObserver | observer: AgoraPipStateChangedObserver | Future | 错误码索引 |
unregisterPipStateChangedObserver | — | Future | 错误码索引 |
AgoraPipOptions 0 方法 / 17 属性
| 属性 | 类型 | 只读 |
|---|---|---|
autoEnterEnabled | bool? | 否 |
aspectRatioX | int? | 否 |
aspectRatioY | int? | 否 |
sourceRectHintLeft | int? | 否 |
sourceRectHintTop | int? | 否 |
sourceRectHintRight | int? | 否 |
sourceRectHintBottom | int? | 否 |
seamlessResizeEnabled | bool? | 否 |
useExternalStateMonitor | bool? | 否 |
externalStateMonitorInterval | int? | 否 |
sourceContentView | int? | 否 |
contentView | int? | 否 |
videoStreams | List ? | 否 |
contentViewLayout | AgoraPipContentViewLayout? | 否 |
preferredContentWidth | int? | 否 |
preferredContentHeight | int? | 否 |
controlStyle | int? | 否 |
AgoraPipStateChangedObserver 1 方法 / 0 属性
onPipStateChanged(state: AgoraPipState, error?: String?): void方法明细:1 / 1(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
onPipStateChanged | state: AgoraPipState, error?: String? | void | 错误码索引 |
AgoraPipVideoStream 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
connection | RtcConnection | 否 |
canvas | VideoCanvas | 否 |
AgoraRhythmPlayerConfig 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
beatsPerMeasure | int? | 否 |
beatsPerMinute | int? | 否 |
AgoraRtcException 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
code | int | 否 |
message | String? | 否 |
AgoraVideoView 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
key | unknown | 否 |
controller | VideoViewControllerBase | 否 |
AudioDeviceInfo 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
deviceId | String? | 否 |
deviceName | String? | 否 |
deviceTypeName | String? | 否 |
AudioDeviceManager 30 方法 / 0 属性
enumeratePlaybackDevices(): List
enumerateRecordingDevices(): List
followSystemLoopbackDevice(enable: bool): Future
followSystemPlaybackDevice(enable: bool): Future
followSystemRecordingDevice(enable: bool): Future
getLoopbackDevice(): Future
getPlaybackDefaultDevice(): Future
getPlaybackDevice(): Future
getPlaybackDeviceInfo(): Future
getPlaybackDeviceMute(): Future
getPlaybackDeviceVolume(): Future
getRecordingDefaultDevice(): Future
getRecordingDevice(): Future
getRecordingDeviceInfo(): Future
getRecordingDeviceMute(): Future
getRecordingDeviceVolume(): Future
release(): Future
setLoopbackDevice(deviceId: String): Future
setPlaybackDevice(deviceId: String): Future
setPlaybackDeviceMute(mute: bool): Future
setPlaybackDeviceVolume(volume: int): Future
setRecordingDevice(deviceId: String): Future
setRecordingDeviceMute(mute: bool): Future
setRecordingDeviceVolume(volume: int): Future
startAudioDeviceLoopbackTest(indicationInterval: int): Future
startPlaybackDeviceTest(testAudioFilePath: String): Future
startRecordingDeviceTest(indicationInterval: int): Future
stopAudioDeviceLoopbackTest(): Future
stopPlaybackDeviceTest(): Future
stopRecordingDeviceTest(): Future方法明细:30 / 30(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
enumeratePlaybackDevices | — | List | 错误码索引 |
enumerateRecordingDevices | — | List | 错误码索引 |
followSystemLoopbackDevice | enable: bool | Future | 错误码索引 |
followSystemPlaybackDevice | enable: bool | Future | 错误码索引 |
followSystemRecordingDevice | enable: bool | Future | 错误码索引 |
getLoopbackDevice | — | Future | 错误码索引 |
getPlaybackDefaultDevice | — | Future | 错误码索引 |
getPlaybackDevice | — | Future | 错误码索引 |
getPlaybackDeviceInfo | — | Future | 错误码索引 |
getPlaybackDeviceMute | — | Future | 错误码索引 |
getPlaybackDeviceVolume | — | Future | 错误码索引 |
getRecordingDefaultDevice | — | Future | 错误码索引 |
getRecordingDevice | — | Future | 错误码索引 |
getRecordingDeviceInfo | — | Future | 错误码索引 |
getRecordingDeviceMute | — | Future | 错误码索引 |
getRecordingDeviceVolume | — | Future | 错误码索引 |
release | — | Future | 错误码索引 |
setLoopbackDevice | deviceId: String | Future | 错误码索引 |
setPlaybackDevice | deviceId: String | Future | 错误码索引 |
setPlaybackDeviceMute | mute: bool | Future | 错误码索引 |
setPlaybackDeviceVolume | volume: int | Future | 错误码索引 |
setRecordingDevice | deviceId: String | Future | 错误码索引 |
setRecordingDeviceMute | mute: bool | Future | 错误码索引 |
setRecordingDeviceVolume | volume: int | Future | 错误码索引 |
startAudioDeviceLoopbackTest | indicationInterval: int | Future | 错误码索引 |
startPlaybackDeviceTest | testAudioFilePath: String | Future | 错误码索引 |
startRecordingDeviceTest | indicationInterval: int | Future | 错误码索引 |
stopAudioDeviceLoopbackTest | — | Future | 错误码索引 |
stopPlaybackDeviceTest | — | Future | 错误码索引 |
stopRecordingDeviceTest | — | Future | 错误码索引 |
AudioEncodedFrameObserver 3 方法 / 0 属性
onMixedAudioEncodedFrame(frameBuffer: Uint8List, length: int, audioEncodedFrameInfo: EncodedAudioFrameInfo): void
onPlaybackAudioEncodedFrame(frameBuffer: Uint8List, length: int, audioEncodedFrameInfo: EncodedAudioFrameInfo): void
onRecordAudioEncodedFrame(frameBuffer: Uint8List, length: int, audioEncodedFrameInfo: EncodedAudioFrameInfo): void方法明细:3 / 3(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
onMixedAudioEncodedFrame | frameBuffer: Uint8List, length: int, audioEncodedFrameInfo: EncodedAudioFrameInfo | void | 错误码索引 |
onPlaybackAudioEncodedFrame | frameBuffer: Uint8List, length: int, audioEncodedFrameInfo: EncodedAudioFrameInfo | void | 错误码索引 |
onRecordAudioEncodedFrame | frameBuffer: Uint8List, length: int, audioEncodedFrameInfo: EncodedAudioFrameInfo | void | 错误码索引 |
AudioEncodedFrameObserverConfig 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
postionType | AudioEncodedFrameObserverPosition? | 否 |
encodingType | AudioEncodingType? | 否 |
AudioFrame 0 方法 / 8 属性
| 属性 | 类型 | 只读 |
|---|---|---|
type | unknown | 否 |
samplesPerChannel | unknown | 否 |
bytesPerSample | unknown | 否 |
channels | unknown | 否 |
samplesPerSec | unknown | 否 |
buffer | unknown | 否 |
renderTimeMs | unknown | 否 |
avsyncType | unknown | 否 |
AudioFrameObserver 1 方法 / 0 属性
onPlaybackAudioFrameBeforeMixing(channelId: String, uid: int, audioFrame: AudioFrame): void方法明细:1 / 1(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
onPlaybackAudioFrameBeforeMixing | channelId: String, uid: int, audioFrame: AudioFrame | void | 错误码索引 |
AudioFrameObserverBase 4 方法 / 0 属性
onEarMonitoringAudioFrame(audioFrame: AudioFrame): void
onMixedAudioFrame(channelId: String, audioFrame: AudioFrame): void
onPlaybackAudioFrame(channelId: String, audioFrame: AudioFrame): void
onRecordAudioFrame(channelId: String, audioFrame: AudioFrame): void方法明细:4 / 4(参数、返回值、错误码)
AudioParams 0 方法 / 4 属性
| 属性 | 类型 | 只读 |
|---|---|---|
sampleRate | int? | 否 |
channels | int? | 否 |
mode | RawAudioFrameOpModeType? | 否 |
samplesPerCall | int? | 否 |
AudioPcmFrame 0 方法 / 6 属性
| 属性 | 类型 | 只读 |
|---|---|---|
captureTimestamp | int? | 否 |
samplesPerChannel | int? | 否 |
sampleRateHz | int? | 否 |
numChannels | int? | 否 |
bytesPerSample | BytesPerSample? | 否 |
data | List ? | 否 |
AudioPcmFrameSink 1 方法 / 0 属性
onFrame(frame: AudioPcmFrame): void方法明细:1 / 1(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
onFrame | frame: AudioPcmFrame | void | 错误码索引 |
AudioRecordingConfiguration 0 方法 / 6 属性
| 属性 | 类型 | 只读 |
|---|---|---|
filePath | String? | 否 |
encode | bool? | 否 |
sampleRate | int? | 否 |
fileRecordingType | AudioFileRecordingType? | 否 |
quality | AudioRecordingQualityType? | 否 |
recordingChannel | int? | 否 |
AudioSpectrumData 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
audioSpectrumData | List ? | 否 |
dataLength | int? | 否 |
AudioSpectrumObserver 2 方法 / 0 属性
onLocalAudioSpectrum(data: AudioSpectrumData): void
onRemoteAudioSpectrum(spectrums: List, spectrumNumber: int): void方法明细:2 / 2(参数、返回值、错误码)
AudioTrackConfig 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
enableLocalPlayback | bool? | 否 |
enableAudioProcessing | bool? | 否 |
AudioVolumeInfo 0 方法 / 4 属性
| 属性 | 类型 | 只读 |
|---|---|---|
uid | int? | 否 |
volume | int? | 否 |
vad | int? | 否 |
voicePitch | double? | 否 |
BaseSpatialAudioEngine 11 方法 / 0 属性
muteAllRemoteAudioStreams(mute: bool): Future
muteLocalAudioStream(mute: bool): Future
muteRemoteAudioStream(mute: int uid,required bool): Future
release(): unknown
setAudioRecvRange(range: double): Future
setDistanceUnit(unit: double): Future
setMaxAudioRecvCount(maxCount: int): Future
setPlayerAttenuation(forceSet: int playerId,required double attenuation,required bool): Future
setZones(zoneCount: SpatialAudioZone zones,required int): Future
updatePlayerPositionInfo(positionInfo: int playerId,required RemoteVoicePositionInfo): Future
updateSelfPosition(axisUp: List position,required List axisForward,required List axisRight,required List): Future方法明细:11 / 11(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
muteAllRemoteAudioStreams | mute: bool | Future | 错误码索引 |
muteLocalAudioStream | mute: bool | Future | 错误码索引 |
muteRemoteAudioStream | mute: int uid,required bool | Future | 错误码索引 |
release | — | unknown | 错误码索引 |
setAudioRecvRange | range: double | Future | 错误码索引 |
setDistanceUnit | unit: double | Future | 错误码索引 |
setMaxAudioRecvCount | maxCount: int | Future | 错误码索引 |
setPlayerAttenuation | forceSet: int playerId,required double attenuation,required bool | Future | 错误码索引 |
setZones | zoneCount: SpatialAudioZone zones,required int | Future | 错误码索引 |
updatePlayerPositionInfo | positionInfo: int playerId,required RemoteVoicePositionInfo | Future | 错误码索引 |
updateSelfPosition | axisUp: List position,required List axisForward,required List axisRight,required List | Future | 错误码索引 |
BeautyOptions 0 方法 / 5 属性
| 属性 | 类型 | 只读 |
|---|---|---|
lighteningContrastLevel | LighteningContrastLevel? | 否 |
lighteningLevel | double? | 否 |
smoothnessLevel | double? | 否 |
rednessLevel | double? | 否 |
sharpnessLevel | double? | 否 |
CacheStatistics 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
fileSize | int? | 否 |
cacheSize | int? | 否 |
downloadSize | int? | 否 |
CameraCapturerConfiguration 0 方法 / 6 属性
| 属性 | 类型 | 只读 |
|---|---|---|
cameraDirection | CameraDirection? | 否 |
cameraId | String? | 否 |
cameraFocalLengthType | CameraFocalLengthType? | 否 |
format | VideoFormat? | 否 |
deviceId | String? | 否 |
followEncodeDimensionRatio | bool? | 否 |
ChannelMediaInfo 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
channelName | String? | 否 |
token | String? | 否 |
uid | int? | 否 |
ChannelMediaOptions 0 方法 / 36 属性
| 属性 | 类型 | 只读 |
|---|---|---|
publishCameraTrack | bool? | 否 |
publishSecondaryCameraTrack | bool? | 否 |
publishMicrophoneTrack | bool? | 否 |
publishThirdCameraTrack | bool? | 否 |
publishFourthCameraTrack | bool? | 否 |
publishScreenTrack | bool? | 否 |
publishScreenCaptureVideo | bool? | 否 |
publishScreenCaptureAudio | bool? | 否 |
publishSecondaryScreenTrack | bool? | 否 |
publishThirdScreenTrack | bool? | 否 |
publishFourthScreenTrack | bool? | 否 |
publishTranscodedVideoTrack | bool? | 否 |
publishMixedAudioTrack | bool? | 否 |
publishLipSyncTrack | unknown | 否 |
publishCustomAudioTrack | bool? | 否 |
publishCustomAudioTrackId | int? | 否 |
publishCustomVideoTrack | bool? | 否 |
publishEncodedVideoTrack | bool? | 否 |
publishMediaPlayerAudioTrack | bool? | 否 |
publishMediaPlayerVideoTrack | bool? | 否 |
autoSubscribeAudio | bool? | 否 |
autoSubscribeVideo | bool? | 否 |
enableAudioRecordingOrPlayout | bool? | 否 |
publishMediaPlayerId | int? | 否 |
clientRoleType | ClientRoleType? | 否 |
audienceLatencyLevel | AudienceLatencyLevelType? | 否 |
defaultVideoStreamType | VideoStreamType? | 否 |
channelProfile | ChannelProfileType? | 否 |
audioDelayMs | int? | 否 |
token | String? | 否 |
publishRhythmPlayerTrack | bool? | 否 |
isInteractiveAudience | bool? | 否 |
customVideoTrackId | int? | 否 |
isAudioFilterable | bool? | 否 |
enableMultipath | bool? | 否 |
preferMultipathType | MultipathType? | 否 |
ChannelMediaRelayConfiguration 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
srcInfo | ChannelMediaInfo? | 否 |
destInfos | List ? | 否 |
destCount | int? | 否 |
ClientRoleOptions 0 方法 / 1 属性
| 属性 | 类型 | 只读 |
|---|---|---|
audienceLatencyLevel | AudienceLatencyLevelType? | 否 |
ClimaxSegment 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
startTimeMs | int? | 否 |
endTimeMs | int? | 否 |
CodecCapInfo 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
codecType | VideoCodecType? | 否 |
codecCapMask | int? | 否 |
codecLevels | CodecCapLevels? | 否 |
CodecCapLevels 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
hwDecodingLevel | VideoCodecCapabilityLevel? | 否 |
swDecodingLevel | VideoCodecCapabilityLevel? | 否 |
ColorEnhanceOptions 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
strengthLevel | double? | 否 |
skinProtectLevel | double? | 否 |
ContentInspectConfig 0 方法 / 4 属性
| 属性 | 类型 | 只读 |
|---|---|---|
extraInfo | String? | 否 |
serverConfig | String? | 否 |
modules | List ? | 否 |
moduleCount | int? | 否 |
ContentInspectModule 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
type | ContentInspectType? | 否 |
interval | int? | 否 |
position | VideoModulePosition? | 否 |
DataStreamConfig 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
syncWithAudio | bool? | 否 |
ordered | bool? | 否 |
DeviceInfo 0 方法 / 1 属性
| 属性 | 类型 | 只读 |
|---|---|---|
isLowLatencyAudioSupported | bool? | 否 |
EchoTestConfiguration 0 方法 / 6 属性
| 属性 | 类型 | 只读 |
|---|---|---|
view | int? | 否 |
enableAudio | bool? | 否 |
enableVideo | bool? | 否 |
token | String? | 否 |
channelId | String? | 否 |
intervalInSeconds | int? | 否 |
EncodedAudioFrameInfo 0 方法 / 6 属性
| 属性 | 类型 | 只读 |
|---|---|---|
codec | AudioCodecType? | 否 |
sampleRateHz | int? | 否 |
samplesPerChannel | int? | 否 |
numberOfChannels | int? | 否 |
advancedSettings | EncodedAudioFrameAdvancedSettings? | 否 |
captureTimeMs | int? | 否 |
EncodedVideoFrameInfo 0 方法 / 9 属性
| 属性 | 类型 | 只读 |
|---|---|---|
codecType | VideoCodecType? | 否 |
width | int? | 否 |
height | int? | 否 |
framesPerSecond | int? | 否 |
frameType | VideoFrameType? | 否 |
rotation | VideoOrientation? | 否 |
trackId | int? | 否 |
captureTimeMs | int? | 否 |
streamType | VideoStreamType? | 否 |
EncryptionConfig 0 方法 / 4 属性
| 属性 | 类型 | 只读 |
|---|---|---|
encryptionMode | EncryptionMode? | 否 |
encryptionKey | String? | 否 |
encryptionKdfSalt | Uint8List? | 否 |
datastreamEncryptionEnabled | bool? | 否 |
ExtensionContext 0 方法 / 4 属性
| 属性 | 类型 | 只读 |
|---|---|---|
isValid | bool? | 否 |
uid | int? | 否 |
providerName | String? | 否 |
extensionName | String? | 否 |
ExternalVideoFrame 0 方法 / 23 属性
| 属性 | 类型 | 只读 |
|---|---|---|
type | VideoBufferType? | 否 |
format | VideoPixelFormat? | 否 |
buffer | Uint8List? | 否 |
stride | int? | 否 |
height | int? | 否 |
eglContext | unknown | 否 |
eglType | EglContextType? | 否 |
textureId | int? | 否 |
matrix | List ? | 否 |
metadataBuffer | Uint8List? | 否 |
metadataSize | int? | 否 |
d3d11Texture2d | int? | 否 |
alphaBuffer | Uint8List? | 否 |
fillAlphaBuffer | bool? | 否 |
alphaStitchMode | AlphaStitchMode? | 否 |
textureSliceIndex | int? | 否 |
cropLeft | int? | 否 |
cropTop | int? | 否 |
cropRight | int? | 否 |
cropBottom | int? | 否 |
rotation | int? | 否 |
timestamp | int? | 否 |
colorSpace | ColorSpace? | 否 |
FaceShapeAreaOptions 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
shapeArea | unknown | 否 |
shapeIntensity | unknown | 否 |
FaceShapeBeautyOptions 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
shapeStyle | FaceShapeBeautyStyle? | 否 |
styleIntensity | int? | 否 |
FilterEffectOptions 1 方法 / 1 属性
path(): unknown方法明细:1 / 1(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
path | — | unknown | 错误码索引 |
| 属性 | 类型 | 只读 |
|---|---|---|
strength | unknown | 否 |
FocalLengthInfo 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
cameraDirection | int? | 否 |
focalLengthType | CameraFocalLengthType? | 否 |
ImageTrackOptions 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
imageUrl | String? | 否 |
fps | int? | 否 |
LastmileProbeConfig 0 方法 / 4 属性
| 属性 | 类型 | 只读 |
|---|---|---|
probeUplink | bool? | 否 |
probeDownlink | bool? | 否 |
expectedUplinkBitrate | int? | 否 |
expectedDownlinkBitrate | int? | 否 |
LastmileProbeOneWayResult 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
packetLossRate | int? | 否 |
jitter | int? | 否 |
availableBandwidth | int? | 否 |
LastmileProbeResult 0 方法 / 4 属性
| 属性 | 类型 | 只读 |
|---|---|---|
state | LastmileProbeResultState? | 否 |
uplinkReport | LastmileProbeOneWayResult? | 否 |
downlinkReport | LastmileProbeOneWayResult? | 否 |
rtt | int? | 否 |
LeaveChannelOptions 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
stopAudioMixing | bool? | 否 |
stopAllEffect | bool? | 否 |
stopMicrophoneRecording | bool? | 否 |
LiveStreamAdvancedFeature 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
featureName | String? | 否 |
opened | bool? | 否 |
LiveTranscoding 0 方法 / 23 属性
| 属性 | 类型 | 只读 |
|---|---|---|
width | int? | 否 |
height | int? | 否 |
videoBitrate | int? | 否 |
videoFramerate | int? | 否 |
lowLatency | bool? | 否 |
videoGop | int? | 否 |
videoCodecProfile | VideoCodecProfileType? | 否 |
videoCodecType | VideoCodecTypeForStream? | 否 |
transcodingUsers | List ? | 否 |
transcodingExtraInfo | String? | 否 |
backgroundColor | int? | 否 |
userCount | int? | 否 |
metadata | String? | 否 |
watermark | List ? | 否 |
backgroundImage | List ? | 否 |
audioSampleRate | AudioSampleRateType? | 否 |
audioBitrate | int? | 否 |
audioChannels | int? | 否 |
audioCodecProfile | AudioCodecProfileType? | 否 |
watermarkCount | int? | 否 |
backgroundImageCount | int? | 否 |
advancedFeatures | unknown | 否 |
advancedFeatureCount | int? | 否 |
LocalAccessPointConfiguration 0 方法 / 7 属性
| 属性 | 类型 | 只读 |
|---|---|---|
ipList | List ? | 否 |
ipListSize | int? | 否 |
domainList | List ? | 否 |
domainListSize | int? | 否 |
verifyDomainName | String? | 否 |
mode | LocalProxyMode? | 否 |
advancedConfig | AdvancedConfigInfo? | 否 |
LocalAudioMixerConfiguration 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
streamCount | int? | 否 |
audioInputStreams | List ? | 否 |
syncWithLocalMic | bool? | 否 |
LocalAudioStats 0 方法 / 8 属性
| 属性 | 类型 | 只读 |
|---|---|---|
numChannels | int? | 否 |
sentSampleRate | int? | 否 |
sentBitrate | int? | 否 |
txPacketLossRate | int? | 否 |
internalCodec | int? | 否 |
audioDeviceDelay | int? | 否 |
earMonitorDelay | int? | 否 |
aecEstimatedDelay | int? | 否 |
LocalSpatialAudioEngine 5 方法 / 0 属性
clearRemotePositions(): Future
initialize(): Future
removeRemotePosition(uid: int): Future
setRemoteAudioAttenuation(forceSet: int uid,required double attenuation,required bool): Future
updateRemotePosition(posInfo: int uid,required RemoteVoicePositionInfo): Future方法明细:5 / 5(参数、返回值、错误码)
LocalTranscoderConfiguration 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
streamCount | int? | 否 |
videoInputStreams | List ? | 否 |
videoOutputConfiguration | VideoEncoderConfiguration? | 否 |
LocalVideoStats 0 方法 / 22 属性
| 属性 | 类型 | 只读 |
|---|---|---|
uid | int? | 否 |
sentBitrate | int? | 否 |
sentFrameRate | int? | 否 |
captureFrameRate | int? | 否 |
captureFrameWidth | int? | 否 |
captureFrameHeight | int? | 否 |
regulatedCaptureFrameRate | int? | 否 |
regulatedCaptureFrameWidth | int? | 否 |
regulatedCaptureFrameHeight | int? | 否 |
encoderOutputFrameRate | int? | 否 |
rendererOutputFrameRate | int? | 否 |
targetBitrate | int? | 否 |
targetFrameRate | int? | 否 |
qualityAdaptIndication | QualityAdaptIndication? | 否 |
encodedBitrate | int? | 否 |
encodedFrameHeight | int? | 否 |
encodedFrameWidth | int? | 否 |
encodedFrameCount | int? | 否 |
codecType | VideoCodecType? | 否 |
txPacketLossRate | int? | 否 |
captureBrightnessLevel | CaptureBrightnessLevelType? | 否 |
hwEncoderAccelerating | int? | 否 |
LogConfig 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
filePath | String? | 否 |
fileSizeInKB | int? | 否 |
level | LogLevel? | 否 |
LogUploadServerInfo 0 方法 / 4 属性
| 属性 | 类型 | 只读 |
|---|---|---|
serverDomain | String? | 否 |
serverPath | String? | 否 |
serverPort | int? | 否 |
serverHttps | bool? | 否 |
LowlightEnhanceOptions 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
level | LowLightEnhanceLevel? | 否 |
mode | LowLightEnhanceMode? | 否 |
MediaEngine 16 方法 / 0 属性
createCustomAudioTrack(config: AudioTrackType trackType,required AudioTrackConfig): Future
destroyCustomAudioTrack(trackId: int): Future
pullAudioFrame(frame: AudioFrame): Future
pushAudioFrame(null: AudioFrame frame,int trackId = 0): Future
pushVideoFrame(null: ExternalVideoFrame frame,int videoTrackId = 0): Future
registerAudioFrameObserver(observer: AudioFrameObserver): void
registerFaceInfoObserver(observer: FaceInfoObserver): void
registerVideoEncodedFrameObserver(observer: VideoEncodedFrameObserver): void
registerVideoFrameObserver(observer: VideoFrameObserver): void
setExternalAudioSink(channels: bool enabled,required int sampleRate,required int): Future
setExternalAudioSource(true: bool enabled,required int sampleRate,required int channels,bool localPlayback = false,bool publish =): Future
setExternalVideoSource(null: bool enabled,required bool useTexture,ExternalVideoSourceType sourceType = ExternalVideoSourceType.videoFrame,SenderOptions encodedVideoOption = const SenderOptions()): Future
unregisterAudioFrameObserver(observer: AudioFrameObserver): void
unregisterFaceInfoObserver(observer: FaceInfoObserver): void
unregisterVideoEncodedFrameObserver(observer: VideoEncodedFrameObserver): void
unregisterVideoFrameObserver(observer: VideoFrameObserver): void方法明细:16 / 16(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
createCustomAudioTrack | config: AudioTrackType trackType,required AudioTrackConfig | Future | 错误码索引 |
destroyCustomAudioTrack | trackId: int | Future | 错误码索引 |
pullAudioFrame | frame: AudioFrame | Future | 错误码索引 |
pushAudioFrame | null: AudioFrame frame,int trackId = 0 | Future | 错误码索引 |
pushVideoFrame | null: ExternalVideoFrame frame,int videoTrackId = 0 | Future | 错误码索引 |
registerAudioFrameObserver | observer: AudioFrameObserver | void | 错误码索引 |
registerFaceInfoObserver | observer: FaceInfoObserver | void | 错误码索引 |
registerVideoEncodedFrameObserver | observer: VideoEncodedFrameObserver | void | 错误码索引 |
registerVideoFrameObserver | observer: VideoFrameObserver | void | 错误码索引 |
setExternalAudioSink | channels: bool enabled,required int sampleRate,required int | Future | 错误码索引 |
setExternalAudioSource | true: bool enabled,required int sampleRate,required int channels,bool localPlayback = false,bool publish = | Future | 错误码索引 |
setExternalVideoSource | null: bool enabled,required bool useTexture,ExternalVideoSourceType sourceType = ExternalVideoSourceType.videoFrame,SenderOptions encodedVideoOption = const SenderOptions() | Future | 错误码索引 |
unregisterAudioFrameObserver | observer: AudioFrameObserver | void | 错误码索引 |
unregisterFaceInfoObserver | observer: FaceInfoObserver | void | 错误码索引 |
unregisterVideoEncodedFrameObserver | observer: VideoEncodedFrameObserver | void | 错误码索引 |
unregisterVideoFrameObserver | observer: VideoFrameObserver | void | 错误码索引 |
MediaPlayer 42 方法 / 0 属性
adjustPlayoutVolume(volume: int): Future
adjustPublishSignalVolume(volume: int): Future
getAudioBufferDelay(): Future
getDuration(): Future
getMediaPlayerId(): int
getMute(): Future
getPlayPosition(): Future
getPlaySrc(): Future
getPlayoutVolume(): Future
getPublishSignalVolume(): Future
getState(): Future
getStreamCount(): Future
getStreamInfo(index: int): Future
mute(muted: bool): Future
open(startPos: String url,required int): Future
openWithMediaSource(source: MediaSource): Future
pause(): Future
play(): Future
playPreloadedSrc(src: String): Future
preloadSrc(startPos: String src,required int): Future
registerAudioFrameObserver(null: AudioPcmFrameSink observer,RawAudioFrameOpModeType mode = RawAudioFrameOpModeType.rawAudioFrameOpModeReadOnly): void
registerPlayerSourceObserver(observer: MediaPlayerSourceObserver): void
registerVideoFrameObserver(observer: MediaPlayerVideoFrameObserver): void
resume(): Future
seek(newPos: int): Future
selectAudioTrack(index: int): Future
selectMultiAudioTrack(publishTrackIndex: int playoutTrackIndex,required int): Future
setAudioDualMonoMode(mode: AudioDualMonoMode): Future
setAudioPitch(pitch: int): Future
setLoopCount(loopCount: int): Future
setPlaybackSpeed(speed: int): Future
setPlayerOptionInInt(value: String key,required int): Future
setPlayerOptionInString(value: String key,required String): Future
setRenderMode(renderMode: RenderModeType): Future
setSpatialAudioParams(params: SpatialAudioParams): Future
setView(view: int): Future
stop(): Future
switchSrc(true: String src,bool syncPts =): Future
unloadSrc(src: String): Future
unregisterAudioFrameObserver(observer: AudioPcmFrameSink): void
unregisterPlayerSourceObserver(observer: MediaPlayerSourceObserver): void
unregisterVideoFrameObserver(observer: MediaPlayerVideoFrameObserver): void方法明细:42 / 42(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
adjustPlayoutVolume | volume: int | Future | 错误码索引 |
adjustPublishSignalVolume | volume: int | Future | 错误码索引 |
getAudioBufferDelay | — | Future | 错误码索引 |
getDuration | — | Future | 错误码索引 |
getMediaPlayerId | — | int | 错误码索引 |
getMute | — | Future | 错误码索引 |
getPlayPosition | — | Future | 错误码索引 |
getPlaySrc | — | Future | 错误码索引 |
getPlayoutVolume | — | Future | 错误码索引 |
getPublishSignalVolume | — | Future | 错误码索引 |
getState | — | Future | 错误码索引 |
getStreamCount | — | Future | 错误码索引 |
getStreamInfo | index: int | Future | 错误码索引 |
mute | muted: bool | Future | 错误码索引 |
open | startPos: String url,required int | Future | 错误码索引 |
openWithMediaSource | source: MediaSource | Future | 错误码索引 |
pause | — | Future | 错误码索引 |
play | — | Future | 错误码索引 |
playPreloadedSrc | src: String | Future | 错误码索引 |
preloadSrc | startPos: String src,required int | Future | 错误码索引 |
registerAudioFrameObserver | null: AudioPcmFrameSink observer,RawAudioFrameOpModeType mode = RawAudioFrameOpModeType.rawAudioFrameOpModeReadOnly | void | 错误码索引 |
registerPlayerSourceObserver | observer: MediaPlayerSourceObserver | void | 错误码索引 |
registerVideoFrameObserver | observer: MediaPlayerVideoFrameObserver | void | 错误码索引 |
resume | — | Future | 错误码索引 |
seek | newPos: int | Future | 错误码索引 |
selectAudioTrack | index: int | Future | 错误码索引 |
selectMultiAudioTrack | publishTrackIndex: int playoutTrackIndex,required int | Future | 错误码索引 |
setAudioDualMonoMode | mode: AudioDualMonoMode | Future | 错误码索引 |
setAudioPitch | pitch: int | Future | 错误码索引 |
setLoopCount | loopCount: int | Future | 错误码索引 |
setPlaybackSpeed | speed: int | Future | 错误码索引 |
setPlayerOptionInInt | value: String key,required int | Future | 错误码索引 |
setPlayerOptionInString | value: String key,required String | Future | 错误码索引 |
setRenderMode | renderMode: RenderModeType | Future | 错误码索引 |
setSpatialAudioParams | params: SpatialAudioParams | Future | 错误码索引 |
setView | view: int | Future | 错误码索引 |
stop | — | Future | 错误码索引 |
switchSrc | true: String src,bool syncPts = | Future | 错误码索引 |
unloadSrc | src: String | Future | 错误码索引 |
unregisterAudioFrameObserver | observer: AudioPcmFrameSink | void | 错误码索引 |
unregisterPlayerSourceObserver | observer: MediaPlayerSourceObserver | void | 错误码索引 |
unregisterVideoFrameObserver | observer: MediaPlayerVideoFrameObserver | void | 错误码索引 |
MediaPlayerCacheManager 12 方法 / 0 属性
enableAutoRemoveCache(enable: bool): Future
getCacheDir(length: int): Future
getCacheFileCount(): Future
getMaxCacheFileCount(): Future
getMaxCacheFileSize(): Future
getMediaPlayerCacheManager(): MediaPlayerCacheManager
removeAllCaches(): Future
removeCacheByUri(uri: String): uture
removeOldCache(): Future
setCacheDir(path: String): Future
setMaxCacheFileCount(count: int): Future
setMaxCacheFileSize(cacheSize: int): Future方法明细:12 / 12(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
enableAutoRemoveCache | enable: bool | Future | 错误码索引 |
getCacheDir | length: int | Future | 错误码索引 |
getCacheFileCount | — | Future | 错误码索引 |
getMaxCacheFileCount | — | Future | 错误码索引 |
getMaxCacheFileSize | — | Future | 错误码索引 |
getMediaPlayerCacheManager | — | MediaPlayerCacheManager | 错误码索引 |
removeAllCaches | — | Future | 错误码索引 |
removeCacheByUri | uri: String | uture | 错误码索引 |
removeOldCache | — | Future | 错误码索引 |
setCacheDir | path: String | Future | 错误码索引 |
setMaxCacheFileCount | count: int | Future | 错误码索引 |
setMaxCacheFileSize | cacheSize: int | Future | 错误码索引 |
MediaPlayerController 1 方法 / 0 属性
initialize(): Future方法明细:1 / 1(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
initialize | — | Future | 错误码索引 |
MediaPlayerSourceObserver 11 方法 / 0 属性
onAudioVolumeIndication(volume: int): void
onMetaData(data: Uint8List, length: int): void
onPlayBufferUpdated(playCachedBuffer: int): void
onPlayerCacheStats(stats: CacheStatistics): void
onPlayerEvent(eventCode: MediaPlayerEvent, elapsedTime: int, message: String): void
onPlayerInfoUpdated(info: PlayerUpdatedInfo): void
onPlayerPlaybackStats(stats: PlayerPlaybackStats): void
onPlayerSourceStateChanged(state: MediaPlayerState, reason: MediaPlayerReason): void
onPlayerSrcInfoChanged(from: SrcInfo, to: SrcInfo): void
onPositionChanged(positionMs: int, timestampMs: int): void
onPreloadEvent(src: String, event: PlayerPreloadEvent): void方法明细:11 / 11(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
onAudioVolumeIndication | volume: int | void | 错误码索引 |
onMetaData | data: Uint8List, length: int | void | 错误码索引 |
onPlayBufferUpdated | playCachedBuffer: int | void | 错误码索引 |
onPlayerCacheStats | stats: CacheStatistics | void | 错误码索引 |
onPlayerEvent | eventCode: MediaPlayerEvent, elapsedTime: int, message: String | void | 错误码索引 |
onPlayerInfoUpdated | info: PlayerUpdatedInfo | void | 错误码索引 |
onPlayerPlaybackStats | stats: PlayerPlaybackStats | void | 错误码索引 |
onPlayerSourceStateChanged | state: MediaPlayerState, reason: MediaPlayerReason | void | 错误码索引 |
onPlayerSrcInfoChanged | from: SrcInfo, to: SrcInfo | void | 错误码索引 |
onPositionChanged | positionMs: int, timestampMs: int | void | 错误码索引 |
onPreloadEvent | src: String, event: PlayerPreloadEvent | void | 错误码索引 |
MediaPlayerVideoFrameObserver 1 方法 / 0 属性
onFrame(frame: VideoFrame): void方法明细:1 / 1(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
onFrame | frame: VideoFrame | void | 错误码索引 |
MediaRecorder 3 方法 / 0 属性
setMediaRecorderObserver(callback: RtcConnection connection,required MediaRecorderObserver): Future
startRecording(config: MediaRecorderConfiguration): Future
stopRecording(): Future方法明细:3 / 3(参数、返回值、错误码)
MediaRecorderConfiguration 0 方法 / 11 属性
| 属性 | 类型 | 只读 |
|---|---|---|
storagePath | String? | 否 |
containerFormat | MediaRecorderContainerFormat? | 否 |
streamType | MediaRecorderStreamType? | 否 |
maxDurationMs | int? | 否 |
recorderInfoUpdateInterval | int? | 否 |
width | int? | 否 |
height | int? | 否 |
fps | int? | 否 |
sampleRate | int? | 否 |
channelNum | int? | 否 |
videoSourceType | VideoSourceType? | 否 |
MediaRecorderObserver 2 方法 / 0 属性
onRecorderInfoUpdated(channelId: String, uid: int, info: RecorderInfo): void
onRecorderStateChanged(channelId: String, uid: int, state: RecorderState, reason: RecorderReasonCode): void方法明细:2 / 2(参数、返回值、错误码)
MediaSource 0 方法 / 8 属性
| 属性 | 类型 | 只读 |
|---|---|---|
url | String? | 否 |
uri | String? | 否 |
startPos | int? | 否 |
autoPlay | bool? | 否 |
enableCache | bool? | 否 |
enableMultiAudioTrack | unknown | 否 |
isAgoraSource | bool? | 否 |
isLiveSource | bool? | 否 |
Metadata 0 方法 / 5 属性
| 属性 | 类型 | 只读 |
|---|---|---|
channelId | String? | 否 |
uid | int? | 否 |
size | int? | 否 |
buffer | Uint8List? | 否 |
timeStampMs | int? | 否 |
MetadataObserver 1 方法 / 0 属性
onMetadataReceived(metadata: Metadata): void方法明细:1 / 1(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
onMetadataReceived | metadata: Metadata | void | 错误码索引 |
MultipathStats 0 方法 / 8 属性
| 属性 | 类型 | 只读 |
|---|---|---|
lanTxBytes | int? | 否 |
lanRxBytes | int? | 否 |
wifiTxBytes | int? | 否 |
wifiRxBytes | int? | 否 |
mobileTxBytes | int? | 否 |
mobileRxBytes | int? | 否 |
activePathNum | int? | 否 |
pathStats | List ? | 否 |
Music 0 方法 / 12 属性
| 属性 | 类型 | 只读 |
|---|---|---|
songCode | int? | 否 |
name | String? | 否 |
singer | String? | 否 |
poster | String? | 否 |
releaseTime | String? | 否 |
type | int? | 否 |
pitchType | int? | 否 |
durationS | int? | 否 |
lyricList | List ? | 否 |
climaxSegmentList | List ? | 否 |
lyricCount | int? | 否 |
climaxSegmentCount | int? | 否 |
MusicCacheInfo 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
songCode | int? | 否 |
status | MusicCacheStatusType? | 否 |
MusicChartCollection 2 方法 / 0 属性
get(index: int): Future
getCount(): Future方法明细:2 / 2(参数、返回值、错误码)
MusicChartInfo 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
chartName | String? | 否 |
id | int? | 否 |
MusicCollection 5 方法 / 0 属性
getCount(): int
getMusic(index: int): Music
getPage(): int
getPageSize(): int
getTotal(): int方法明细:5 / 5(参数、返回值、错误码)
MusicContentCenter 17 方法 / 0 属性
createMusicPlayer(): Future
destroyMusicPlayer(musicPlayer: MusicPlayer): Future
getCaches(cacheInfoSize: int): Future ->
getInternalSongCode(jsonOption: int songCode,required String): Future
getLyric(null: int songCode,int lyricType = 0): Future
getMusicCharts(): Future
getMusicCollectionByMusicChartId(jsonOption?: int musicChartId,required int page,required int pageSize,String?): Future
getSongSimpleInfo(songCode: int): Future
initialize(configuration: MusicContentCenterConfiguration): Future
isPreloaded(songCode: int): Future
preload(songCode: int): Future
registerEventHandler(eventHandler: MusicContentCenterEventHandler): void
release(): Future
removeCache(songCode: int): Future
renewToken(token: String): Future
searchMusic(jsonOption?: String keyWord,required int page,required int pageSize,String?): Future
unregisterEventHandler(): void方法明细:17 / 17(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
createMusicPlayer | — | Future | 错误码索引 |
destroyMusicPlayer | musicPlayer: MusicPlayer | Future | 错误码索引 |
getCaches | cacheInfoSize: int | Future -> | 错误码索引 |
getInternalSongCode | jsonOption: int songCode,required String | Future | 错误码索引 |
getLyric | null: int songCode,int lyricType = 0 | Future | 错误码索引 |
getMusicCharts | — | Future | 错误码索引 |
getMusicCollectionByMusicChartId | jsonOption?: int musicChartId,required int page,required int pageSize,String? | Future | 错误码索引 |
getSongSimpleInfo | songCode: int | Future | 错误码索引 |
initialize | configuration: MusicContentCenterConfiguration | Future | 错误码索引 |
isPreloaded | songCode: int | Future | 错误码索引 |
preload | songCode: int | Future | 错误码索引 |
registerEventHandler | eventHandler: MusicContentCenterEventHandler | void | 错误码索引 |
release | — | Future | 错误码索引 |
removeCache | songCode: int | Future | 错误码索引 |
renewToken | token: String | Future | 错误码索引 |
searchMusic | jsonOption?: String keyWord,required int page,required int pageSize,String? | Future | 错误码索引 |
unregisterEventHandler | — | void | 错误码索引 |
MusicContentCenterConfiguration 0 方法 / 4 属性
| 属性 | 类型 | 只读 |
|---|---|---|
appId | String? | 否 |
token | String? | 否 |
mccUid | int? | 否 |
maxCacheSize | int? | 否 |
MusicContentCenterEventHandler 5 方法 / 0 属性
onLyricResult(requestId: String, songCode: int, lyricUrl: String, reason: MusicContentCenterStateReason): void
onMusicChartsResult(requestId: String, result: List, reason: MusicContentCenterStateReason): void
onMusicCollectionResult(requestId: String, result: MusicCollection, reason: MusicContentCenterStateReason): void
onPreLoadEvent(requestId: String, songCode: int, percent: int, lyricUrl: String, state: PreloadState, reason: MusicContentCenterStateReason): void
onSongSimpleInfoResult(requestId: String, songCode: int, simpleInfo: String, reason: MusicContentCenterStateReason): void方法明细:5 / 5(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
onLyricResult | requestId: String, songCode: int, lyricUrl: String, reason: MusicContentCenterStateReason | void | 错误码索引 |
onMusicChartsResult | requestId: String, result: List, reason: MusicContentCenterStateReason | void | 错误码索引 |
onMusicCollectionResult | requestId: String, result: MusicCollection, reason: MusicContentCenterStateReason | void | 错误码索引 |
onPreLoadEvent | requestId: String, songCode: int, percent: int, lyricUrl: String, state: PreloadState, reason: MusicContentCenterStateReason | void | 错误码索引 |
onSongSimpleInfoResult | requestId: String, songCode: int, simpleInfo: String, reason: MusicContentCenterStateReason | void | 错误码索引 |
MusicPlayer 2 方法 / 0 属性
openWithSongCode(null: int songCode,int startPos = 0): Future
setPlayMode(mode: MusicPlayMode): Future方法明细:2 / 2(参数、返回值、错误码)
PathStats 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
type | MultipathType? | 否 |
txKBitRate | int? | 否 |
rxKBitRate | int? | 否 |
PlayerPlaybackStats 0 方法 / 4 属性
| 属性 | 类型 | 只读 |
|---|---|---|
videoFps | int? | 否 |
videoBitrateInKbps | int? | 否 |
audioBitrateInKbps | int? | 否 |
totalBitrateInKbps | int? | 否 |
PlayerStreamInfo 0 方法 / 13 属性
| 属性 | 类型 | 只读 |
|---|---|---|
streamIndex | int? | 否 |
streamType | MediaStreamType? | 否 |
codecName | String? | 否 |
language | String? | 否 |
videoFrameRate | int? | 否 |
videoBitRate | int? | 否 |
videoWidth | int? | 否 |
videoHeight | int? | 否 |
videoRotation | int? | 否 |
audioSampleRate | int? | 否 |
audioChannels | int? | 否 |
audioBitsPerSample | int? | 否 |
duration | int? | 否 |
PlayerUpdatedInfo 0 方法 / 6 属性
| 属性 | 类型 | 只读 |
|---|---|---|
deviceId | String? | 否 |
videoHeight | unknown | 否 |
videoWidth | unknown | 否 |
audioSampleRate | unknown | 否 |
audioChannels | unknown | 否 |
audioBitsPerSample | unknown | 否 |
RecorderInfo 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
fileName | unknown | 否 |
durationMs | unknown | 否 |
fileSize | unknown | 否 |
RecorderStreamInfo 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
channelId | String? | 否 |
uid | int? | 否 |
type | RecorderStreamType? | 否 |
Rectangle 0 方法 / 4 属性
| 属性 | 类型 | 只读 |
|---|---|---|
x | int? | 否 |
y | int? | 否 |
width | int? | 否 |
height | int? | 否 |
RemoteAudioStats 0 方法 / 16 属性
| 属性 | 类型 | 只读 |
|---|---|---|
uid | int? | 否 |
quality | int? | 否 |
networkTransportDelay | int? | 否 |
jitterBufferDelay | int? | 否 |
audioLossRate | int? | 否 |
numChannels | int? | 否 |
receivedSampleRate | int? | 否 |
receivedBitrate | int? | 否 |
totalFrozenTime | int? | 否 |
frozenRate | int? | 否 |
totalActiveTime | int? | 否 |
publishDuration | int? | 否 |
qoeQuality | int? | 否 |
qualityChangedReason | int? | 否 |
mosValue | int? | 否 |
e2eDelay | int? | 否 |
RemoteVideoStats 0 方法 / 17 属性
| 属性 | 类型 | 只读 |
|---|---|---|
uid | int? | 否 |
delay | int? | 否 |
e2eDelay | int? | 否 |
width | int? | 否 |
height | int? | 否 |
receivedBitrate | int? | 否 |
decoderOutputFrameRate | int? | 否 |
rendererOutputFrameRate | int? | 否 |
frameLossRate | int? | 否 |
packetLossRate | int? | 否 |
rxStreamType | VideoStreamType? | 否 |
totalFrozenTime | int? | 否 |
frozenRate | int? | 否 |
totalActiveTime | int? | 否 |
publishDuration | int? | 否 |
avSyncTimeMs | int? | 否 |
mosValue | int? | 否 |
RemoteVoicePositionInfo 0 方法 / 1 属性
| 属性 | 类型 | 只读 |
|---|---|---|
position | unknown | 否 |
RtcConnection 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
channelId | String? | 否 |
localUid | int? | 否 |
RtcEngine 272 方法 / 0 属性
addVideoWatermark(options: String watermarkUrl,required WatermarkOptions): Future
addVideoWatermarkWithConfig(configs: WatermarkConfig): Future
adjustAudioMixingPlayoutVolume(volume: int): Future
adjustAudioMixingPublishVolume(volume: int): Future
adjustAudioMixingVolume(volume: int): Future
adjustCustomAudioPlayoutVolume(volume: int trackId,required int): Future
adjustCustomAudioPublishVolume(volume: int trackId,required int): Future
adjustLoopbackSignalVolume(volume: int): Future
adjustPlaybackSignalVolume(volume: int): Future
adjustRecordingSignalVolume(volume: int): Future
adjustUserPlaybackSignalVolume(volume: int uid,required int): Future
clearVideoWatermarks(): Future
complain(description: String callId,required String): Future
configRhythmPlayer(config: AgoraRhythmPlayerConfig): Future
createAgoraRtcEngine(): RtcEngine
createCustomVideoTrack(): Future
createDataStream(config: DataStreamConfig): Future
createMediaPlayer(): Future
createMediaRecorder(info: RecorderStreamInfo): Future
createVideoEffectObject(null: String bundlePath,MediaSourceType type = MediaSourceType.primaryCameraSource): Future
destroyCustomVideoTrack(videoTrackId: int): Future
destroyMediaPlayer(mediaPlayer: MediaPlayer): Future
destroyMediaRecorder(mediaRecorder: MediaRecorder): Future
destroyVideoEffectObject(videoEffectObject: VideoEffectObject): Future
disableAudio(): Future
disableAudioSpectrumMonitor(): Future
disableVideo(): Future
enableAudio(): Future
enableAudioSpectrumMonitor(null: int intervalInMS = 100): Future
enableAudioVolumeIndication(reportVad: int interval,required int smooth,required bool): Future
enableCameraCenterStage(enabled: bool): Future
enableContentInspect(config: bool enabled,required ContentInspectConfig): Future
enableCustomAudioLocalPlayback(enabled: int trackId,required bool): Future
enableDualStreamMode(streamConfig?: bool enabled,SimulcastStreamConfig?): Future
enableEncryption(config: bool enabled,required EncryptionConfig): Future
enableExtension(null: String provider,required String extension,bool enable = true,MediaSourceType type = MediaSourceType.unknownMediaSource): Future
enableFaceDetection(enabled: bool): Future
enableInEarMonitoring(includeAudioFilters: bool enabled,required EarMonitoringFilterType): Future
enableInstantMediaRendering(): Future
enableLocalAudio(enabled: bool): Future
enableLocalVideo(enabled: bool): Future
enableLoopbackRecording(deviceName?: bool enabled,String?): Future
enableMultiCamera(config: bool enabled,required CameraCapturerConfiguration): Future
enableSoundPositionIndication(enabled: bool): Future
enableSpatialAudio(enabled: bool): Future
enableVideo(): Future
enableVideoImageSource(options: bool enable,required ImageTrackOptions): Future
enableVirtualBackground(null: bool enabled,required VirtualBackgroundSource backgroundSource,required SegmentationProperty segproperty,MediaSourceType type = MediaSourceType.primaryCameraSource): Future
enableVoiceAITuner(type: bool enabled,required VoiceAiTunerType): Future
enableWebSdkInteroperability(enabled: bool): Future
getAudioDeviceInfo(): Future
getAudioDeviceManager(): AudioDeviceManager
getAudioMixingCurrentPosition(): Future
getAudioMixingDuration(): Future
getAudioMixingPlayoutVolume(): Future
getAudioMixingPublishVolume(): Future
getAudioTrackCount(): Future
getCallId(): Future
getCameraMaxZoomFactor(): Future
getConnectionState(): Future
getCurrentMonotonicTimeInMs(): Future
getEffectCurrentPosition(soundId: int): Future
getEffectDuration(filePath: String): Future
getEffectsVolume(): Future
getErrorDescription(code: int): Future
getExtensionProperty(null: String provider,required String extension,required String key,required int bufLen,MediaSourceType type = MediaSourceType.unknownMediaSource): Future
getFaceShapeAreaOptions(null: FaceShapeArea shapeArea,MediaSourceType type = MediaSourceType.primaryCameraSource): Future
getFaceShapeBeautyOptions(null: MediaSourceType type = MediaSourceType.primaryCameraSource): Future
getLocalSpatialAudioEngine(): LocalSpatialAudioEngine
getMediaEngine(): MediaEngine
getMusicContentCenter(): MusicContentCenter
getNativeHandle(): Future
getNetworkType(): Future
getNtpWallTimeInMs(): Future
getScreenCaptureSources(includeScreen: Size thumbSize,required Size iconSize,required bool): Future ->
getUserInfoByUid(uid: int): Future
getUserInfoByUserAccount(userAccount: String): Future
getVersion(): Future
getVideoDeviceManager(): VideoDeviceManager
getVolumeOfEffect(soundId: int): Future
initialize(context: RtcEngineContext): Future
isCameraAutoExposureFaceModeSupported(): Future
isCameraAutoFocusFaceModeSupported(): Future
isCameraCenterStageSupported(): Future
isCameraExposurePositionSupported(): Future
isCameraExposureSupported(): Future
isCameraFaceDetectSupported(): Future
isCameraFocusSupported(): Future
isCameraTorchSupported(): Future
isCameraZoomSupported(): Future
isFeatureAvailableOnDevice(type: FeatureType): Future
isSpeakerphoneEnabled(): Future
joinChannel(options: String token,required String channelId,required int uid,required ChannelMediaOptions): Future
joinChannelWithUserAccount(options?: String token,required String channelId,required String userAccount,ChannelMediaOptions?): Future
joinChannelWithUserAccountEx(options: String token,required String channelId,required String userAccount,required ChannelMediaOptions): Future
leaveChannel(options?: LeaveChannelOptions?): Future
loadExtensionProvider(false: String path,bool unloadAfterUse =): Future
muteAllRemoteAudioStreams(mute: bool): Future
muteAllRemoteVideoStreams(mute: bool): Future
muteLocalAudioStream(mute: bool): Future
muteLocalVideoStream(mute: bool): Future
muteRecordingSignal(mute: bool): Future
muteRemoteAudioStream(mute: int uid,required bool): Future
muteRemoteVideoStream(mute: int uid,required bool): Future
pauseAllChannelMediaRelay(): Future
pauseAllEffects(): Future
pauseAudioMixing(): Future
pauseEffect(soundId: int): Future
playAllEffects(false: int loopCount,required double pitch,required double pan,required int gain,bool publish =): Future
playEffect(null: int soundId,required String filePath,required int loopCount,required double pitch,required double pan,required int gain,bool publish = false,int startPos = 0): Future
preloadChannel(uid: String token,required String channelId,required int): Future
preloadChannelWithUserAccount(userAccount: String token,required String channelId,required String): Future
preloadEffect(null: int soundId,required String filePath,int startPos = 0): Future
queryCameraFocalLengthCapability(): Future ->
queryCodecCapability(size: int): Future ->
queryDeviceScore(): Future
queryScreenCaptureCapability(): Future
rate(description: String callId,required int rating,required String): Future
registerAudioEncodedFrameObserver(observer: AudioEncodedFrameObserverConfig config,required AudioEncodedFrameObserver): void
registerAudioSpectrumObserver(observer: AudioSpectrumObserver): void
registerEventHandler(eventHandler: RtcEngineEventHandler): void
registerExtension(null: String provider,required String extension,MediaSourceType type = MediaSourceType.unknownMediaSource): Future
registerLocalUserAccount(userAccount: String appId,required String): Future
registerMediaMetadataObserver(type: MetadataObserver observer,required MetadataType): void
release(false: bool sync =): Future
removeVideoWatermark(id: String): Future
renewToken(token: String): Future
resumeAllChannelMediaRelay(): Future
resumeAllEffects(): Future
resumeAudioMixing(): Future
resumeEffect(soundId: int): Future
selectAudioTrack(index: int): Future
sendCustomReportMessage(value: String id,required String category,required String event,required String label,required int): Future
sendMetaData(sourceType: Metadata metadata,required VideoSourceType): Future
sendStreamMessage(length: int streamId,required Uint8List data,required int): Future
setAINSMode(mode: bool enabled,required AudioAinsMode): Future
setAVSyncSource(uid: String channelId,required int): Future
setAdvancedAudioOptions(options: AdvancedAudioOptions): Future
setAudioEffectParameters(param2: AudioEffectPreset preset,required int param1,required int): Future
setAudioEffectPreset(preset: AudioEffectPreset): Future
setAudioMixingDualMonoMode(mode: AudioMixingDualMonoMode): Future
setAudioMixingPitch(pitch: int): Future
setAudioMixingPlaybackSpeed(speed: int): Future
setAudioMixingPosition(pos: int): Future
setAudioProfile(null: AudioProfileType profile,AudioScenarioType scenario = AudioScenarioType.audioScenarioDefault): Future
setAudioScenario(scenario: AudioScenarioType): Future
setAudioSessionOperationRestriction(restriction: AudioSessionOperationRestriction): Future
setBeautyEffectOptions(null: bool enabled,required BeautyOptions options,MediaSourceType type = MediaSourceType.primaryCameraSource): Future
setCameraAutoExposureFaceModeEnabled(enabled: bool): Future
setCameraAutoFocusFaceModeEnabled(enabled: bool): Future
setCameraCapturerConfiguration(config: CameraCapturerConfiguration): Future
setCameraDeviceOrientation(orientation: VideoSourceType type,required VideoOrientation): Future
setCameraExposureFactor(factor: double): Future
setCameraExposurePosition(positionYinView: double positionXinView,required double): Future
setCameraFocusPositionInPreview(positionY: double positionX,required double): Future
setCameraStabilizationMode(mode: CameraStabilizationMode): Future
setCameraTorchOn(isOn: bool): Future
setCameraZoomFactor(factor: double): Future
setChannelProfile(profile: ChannelProfileType): Future
setClientRole(options?: ClientRoleType role,ClientRoleOptions?): Future
setCloudProxy(proxyType: CloudProxyType): Future
setColorEnhanceOptions(null: bool enabled,required ColorEnhanceOptions options,MediaSourceType type = MediaSourceType.primaryCameraSource): Future
setDefaultAudioRouteToSpeakerphone(defaultToSpeaker: bool): Future
setDualStreamMode(streamConfig?: SimulcastStreamMode mode,SimulcastStreamConfig?): Future
setEarMonitoringAudioFrameParameters(samplesPerCall: int sampleRate,required int channel,required RawAudioFrameOpModeType mode,required int): Future
setEffectPosition(pos: int soundId,required int): Future
setEffectsVolume(volume: int): Future
setEnableSpeakerphone(speakerOn: bool): Future
setExtensionProperty(null: String provider,required String extension,required String key,required String value,MediaSourceType type = MediaSourceType.unknownMediaSource): Future
setExtensionProviderProperty(value: String provider,required String key,required String): Future
setExternalMediaProjection(mediaProjection: int): Future
setExternalRemoteEglContext(eglContext: int): Future
setFaceShapeAreaOptions(null: FaceShapeAreaOptions options,MediaSourceType type = MediaSourceType.primaryCameraSource): Future
setFaceShapeBeautyOptions(null: bool enabled,required FaceShapeBeautyOptions options,MediaSourceType type = MediaSourceType.primaryCameraSource): Future
setFilterEffectOptions(null: bool enabled,required FilterEffectOptions options,MediaSourceType type = MediaSourceType.primaryCameraSource): Future
setHeadphoneEQParameters(highGain: int lowGain,required int): Future
setHeadphoneEQPreset(preset: HeadphoneEqualizerPreset): Future
setInEarMonitoringVolume(volume: int): Future
setLocalAccessPoint(config: LocalAccessPointConfiguration): Future
setLocalRenderMode(null: RenderModeType renderMode,VideoMirrorModeType mirrorMode = VideoMirrorModeType.videoMirrorModeAuto): Future
setLocalRenderTargetFps(targetFps: VideoSourceType sourceType,required int): Future
setLocalVideoMirrorMode(mirrorMode: VideoMirrorModeType): Future
setLocalVoiceEqualization(bandGain: AudioEqualizationBandFrequency bandFrequency,required int): Future
setLocalVoiceFormant(formantRatio: double): Future
setLocalVoicePitch(pitch: double): Future
setLocalVoiceReverb(value: AudioReverbType reverbKey,required int): Future
setLogFile(filePath: String): Future
setLogFileSize(fileSizeInKBytes: int): Future
setLogFilter(filter: LogFilterType): Future
setLogLevel(level: LogLevel): Future
setLowlightEnhanceOptions(null: bool enabled,required LowlightEnhanceOptions options,MediaSourceType type = MediaSourceType.primaryCameraSource): Future
setMaxMetadataSize(size: int): Future
setMixedAudioFrameParameters(samplesPerCall: int sampleRate,required int channel,required int): Future
setParameters(parameters: String): Future
setPlaybackAudioFrameBeforeMixingParameters(samplesPerCall: int sampleRate,required int channel {required int sampleRate,required int): Future
setPlaybackAudioFrameParameters(samplesPerCall: int sampleRate,required int channel,required RawAudioFrameOpModeType mode,required int): Future
setRecordingAudioFrameParameters(samplesPerCall: int sampleRate,required int channel,required RawAudioFrameOpModeType mode,required int): Future
setRemoteDefaultVideoStreamType(streamType: VideoStreamType): Future
setRemoteRenderMode(mirrorMode: int uid,required RenderModeType renderMode,required VideoMirrorModeType): Future
setRemoteRenderTargetFps(targetFps: int): Future
setRemoteSubscribeFallbackOption(option: StreamFallbackOptions): Future
setRemoteUserSpatialAudioParams(params: int uid,required SpatialAudioParams): Future
setRemoteVideoStreamType(streamType: int uid,required VideoStreamType): Future
setRemoteVideoSubscriptionOptions(options: int uid,required VideoSubscriptionOptions): Future
setRemoteVoicePosition(gain: int uid,required double pan,required double): Future
setRouteInCommunicationMode(route: int): Future
setScreenCaptureContentHint(contentHint: VideoContentHint): Future
setScreenCaptureScenario(screenScenario: ScreenScenarioType): Future
setSubscribeAudioAllowlist(uidNumber: List uidList,required int): Future
setSubscribeAudioBlocklist(uidNumber: List uidList,required int): Future
setSubscribeVideoAllowlist(uidNumber: List uidList,required int): Future
setSubscribeVideoBlocklist(uidNumber: List uidList,required int): Future
setVideoDenoiserOptions(null: bool enabled,required VideoDenoiserOptions options,MediaSourceType type = MediaSourceType.primaryCameraSource): Future
setVideoEncoderConfiguration(config: VideoEncoderConfiguration): Future
setVideoScenario(scenarioType: VideoApplicationScenarioType): Future
setVoiceBeautifierParameters(param2: VoiceBeautifierPreset preset,required int param1,required int): Future
setVoiceBeautifierPreset(preset: VoiceBeautifierPreset): Future
setVoiceConversionPreset(preset: VoiceConversionPreset): Future
setVolumeOfEffect(volume: int soundId,required int): Future
setupLocalVideo(canvas: VideoCanvas): Future
setupRemoteVideo(canvas: VideoCanvas): Future
startAudioMixing(null: String filePath,required bool loopback,required int cycle,int startPos = 0): Future
startAudioRecording(config: AudioRecordingConfiguration): Future
startCameraCapture(config: VideoSourceType sourceType,required CameraCapturerConfiguration): Future
startEchoTest(config: EchoTestConfiguration): Future
startLastmileProbeTest(config: LastmileProbeConfig): Future
startLocalAudioMixer(config: LocalAudioMixerConfiguration): Future
startLocalVideoTranscoder(config: LocalTranscoderConfiguration): Future
startMediaRenderingTracing(): Future
startOrUpdateChannelMediaRelay(configuration: ChannelMediaRelayConfiguration): Future
startPreview(null: VideoSourceType sourceType = VideoSourceType.videoSourceCameraPrimary): Future
startPreviewWithoutSourceType(): Future
startRhythmPlayer(config: String sound1,required String sound2,required AgoraRhythmPlayerConfig): Future
startRtmpStreamWithTranscoding(transcoding: String url,required LiveTranscoding): Future
startRtmpStreamWithoutTranscoding(url: String): Future
startScreenCapture(captureParams: ScreenCaptureParameters2): Future
startScreenCaptureByDisplayId(captureParams: int displayId,required Rectangle regionRect,required ScreenCaptureParameters): Future
startScreenCaptureByScreenRect(captureParams: Rectangle screenRect,required Rectangle regionRect,required ScreenCaptureParameters): Future
startScreenCaptureBySourceType(config: VideoSourceType sourceType,required ScreenCaptureConfiguration): Future
startScreenCaptureByWindowId(captureParams: int windowId,required Rectangle regionRect,required ScreenCaptureParameters): Future
stopAllEffects(): Future
stopAudioMixing(): Future
stopAudioRecording(): Future
stopCameraCapture(sourceType: VideoSourceType): Future
stopChannelMediaRelay(): Future
stopEchoTest(): Future
stopEffect(soundId: int): Future
stopLastmileProbeTest(): Future
stopLocalAudioMixer(): Future
stopLocalVideoTranscoder(): Future
stopPreview(null: VideoSourceType sourceType = VideoSourceType.videoSourceCameraPrimary): Future
stopRhythmPlayer(): Future
stopRtmpStream(url: String): Future
stopScreenCapture(): Future
stopScreenCaptureBySourceType(sourceType: VideoSourceType): Future
switchCamera(): Future
takeSnapshot(filePath: int uid,required String): Future
takeSnapshotWithConfig(config: int uid,required SnapshotConfig): Future
unloadAllEffects(): Future
unloadEffect(soundId: int): Future
unregisterAudioEncodedFrameObserver(observer: AudioEncodedFrameObserver): void
unregisterAudioSpectrumObserver(observer: AudioSpectrumObserver): void
unregisterEventHandler(eventHandler: RtcEngineEventHandler): void
unregisterMediaMetadataObserver(type: MetadataObserver observer,required MetadataType): void
updateChannelMediaOptions(options: ChannelMediaOptions): Future
updateLocalAudioMixerConfiguration(config: LocalAudioMixerConfiguration): Future
updateLocalTranscoderConfiguration(config: LocalTranscoderConfiguration): Future
updatePreloadChannelToken(token: String): Future
updateRtmpTranscoding(transcoding: LiveTranscoding): Future
updateScreenCapture(captureParams: ScreenCaptureParameters2): Future
updateScreenCaptureParameters(captureParams: ScreenCaptureParameters): Future
updateScreenCaptureRegion(regionRect: Rectangle): Future方法明细:272 / 272(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
addVideoWatermark | options: String watermarkUrl,required WatermarkOptions | Future | 错误码索引 |
addVideoWatermarkWithConfig | configs: WatermarkConfig | Future | 错误码索引 |
adjustAudioMixingPlayoutVolume | volume: int | Future | 错误码索引 |
adjustAudioMixingPublishVolume | volume: int | Future | 错误码索引 |
adjustAudioMixingVolume | volume: int | Future | 错误码索引 |
adjustCustomAudioPlayoutVolume | volume: int trackId,required int | Future | 错误码索引 |
adjustCustomAudioPublishVolume | volume: int trackId,required int | Future | 错误码索引 |
adjustLoopbackSignalVolume | volume: int | Future | 错误码索引 |
adjustPlaybackSignalVolume | volume: int | Future | 错误码索引 |
adjustRecordingSignalVolume | volume: int | Future | 错误码索引 |
adjustUserPlaybackSignalVolume | volume: int uid,required int | Future | 错误码索引 |
clearVideoWatermarks | — | Future | 错误码索引 |
complain | description: String callId,required String | Future | 错误码索引 |
configRhythmPlayer | config: AgoraRhythmPlayerConfig | Future | 错误码索引 |
createAgoraRtcEngine | — | RtcEngine | 错误码索引 |
createCustomVideoTrack | — | Future | 错误码索引 |
createDataStream | config: DataStreamConfig | Future | 错误码索引 |
createMediaPlayer | — | Future | 错误码索引 |
createMediaRecorder | info: RecorderStreamInfo | Future | 错误码索引 |
createVideoEffectObject | null: String bundlePath,MediaSourceType type = MediaSourceType.primaryCameraSource | Future | 错误码索引 |
destroyCustomVideoTrack | videoTrackId: int | Future | 错误码索引 |
destroyMediaPlayer | mediaPlayer: MediaPlayer | Future | 错误码索引 |
destroyMediaRecorder | mediaRecorder: MediaRecorder | Future | 错误码索引 |
destroyVideoEffectObject | videoEffectObject: VideoEffectObject | Future | 错误码索引 |
disableAudio | — | Future | 错误码索引 |
disableAudioSpectrumMonitor | — | Future | 错误码索引 |
disableVideo | — | Future | 错误码索引 |
enableAudio | — | Future | 错误码索引 |
enableAudioSpectrumMonitor | null: int intervalInMS = 100 | Future | 错误码索引 |
enableAudioVolumeIndication | reportVad: int interval,required int smooth,required bool | Future | 错误码索引 |
enableCameraCenterStage | enabled: bool | Future | 错误码索引 |
enableContentInspect | config: bool enabled,required ContentInspectConfig | Future | 错误码索引 |
enableCustomAudioLocalPlayback | enabled: int trackId,required bool | Future | 错误码索引 |
enableDualStreamMode | streamConfig?: bool enabled,SimulcastStreamConfig? | Future | 错误码索引 |
enableEncryption | config: bool enabled,required EncryptionConfig | Future | 错误码索引 |
enableExtension | null: String provider,required String extension,bool enable = true,MediaSourceType type = MediaSourceType.unknownMediaSource | Future | 错误码索引 |
enableFaceDetection | enabled: bool | Future | 错误码索引 |
enableInEarMonitoring | includeAudioFilters: bool enabled,required EarMonitoringFilterType | Future | 错误码索引 |
enableInstantMediaRendering | — | Future | 错误码索引 |
enableLocalAudio | enabled: bool | Future | 错误码索引 |
enableLocalVideo | enabled: bool | Future | 错误码索引 |
enableLoopbackRecording | deviceName?: bool enabled,String? | Future | 错误码索引 |
enableMultiCamera | config: bool enabled,required CameraCapturerConfiguration | Future | 错误码索引 |
enableSoundPositionIndication | enabled: bool | Future | 错误码索引 |
enableSpatialAudio | enabled: bool | Future | 错误码索引 |
enableVideo | — | Future | 错误码索引 |
enableVideoImageSource | options: bool enable,required ImageTrackOptions | Future | 错误码索引 |
enableVirtualBackground | null: bool enabled,required VirtualBackgroundSource backgroundSource,required SegmentationProperty segproperty,MediaSourceType type = MediaSourceType.primaryCameraSource | Future | 错误码索引 |
enableVoiceAITuner | type: bool enabled,required VoiceAiTunerType | Future | 错误码索引 |
enableWebSdkInteroperability | enabled: bool | Future | 错误码索引 |
getAudioDeviceInfo | — | Future | 错误码索引 |
getAudioDeviceManager | — | AudioDeviceManager | 错误码索引 |
getAudioMixingCurrentPosition | — | Future | 错误码索引 |
getAudioMixingDuration | — | Future | 错误码索引 |
getAudioMixingPlayoutVolume | — | Future | 错误码索引 |
getAudioMixingPublishVolume | — | Future | 错误码索引 |
getAudioTrackCount | — | Future | 错误码索引 |
getCallId | — | Future | 错误码索引 |
getCameraMaxZoomFactor | — | Future | 错误码索引 |
getConnectionState | — | Future | 错误码索引 |
getCurrentMonotonicTimeInMs | — | Future | 错误码索引 |
getEffectCurrentPosition | soundId: int | Future | 错误码索引 |
getEffectDuration | filePath: String | Future | 错误码索引 |
getEffectsVolume | — | Future | 错误码索引 |
getErrorDescription | code: int | Future | 错误码索引 |
getExtensionProperty | null: String provider,required String extension,required String key,required int bufLen,MediaSourceType type = MediaSourceType.unknownMediaSource | Future | 错误码索引 |
getFaceShapeAreaOptions | null: FaceShapeArea shapeArea,MediaSourceType type = MediaSourceType.primaryCameraSource | Future | 错误码索引 |
getFaceShapeBeautyOptions | null: MediaSourceType type = MediaSourceType.primaryCameraSource | Future | 错误码索引 |
getLocalSpatialAudioEngine | — | LocalSpatialAudioEngine | 错误码索引 |
getMediaEngine | — | MediaEngine | 错误码索引 |
getMusicContentCenter | — | MusicContentCenter | 错误码索引 |
getNativeHandle | — | Future | 错误码索引 |
getNetworkType | — | Future | 错误码索引 |
getNtpWallTimeInMs | — | Future | 错误码索引 |
getScreenCaptureSources | includeScreen: Size thumbSize,required Size iconSize,required bool | Future -> | 错误码索引 |
getUserInfoByUid | uid: int | Future | 错误码索引 |
getUserInfoByUserAccount | userAccount: String | Future | 错误码索引 |
getVersion | — | Future | 错误码索引 |
getVideoDeviceManager | — | VideoDeviceManager | 错误码索引 |
getVolumeOfEffect | soundId: int | Future | 错误码索引 |
initialize | context: RtcEngineContext | Future | 错误码索引 |
isCameraAutoExposureFaceModeSupported | — | Future | 错误码索引 |
isCameraAutoFocusFaceModeSupported | — | Future | 错误码索引 |
isCameraCenterStageSupported | — | Future | 错误码索引 |
isCameraExposurePositionSupported | — | Future | 错误码索引 |
isCameraExposureSupported | — | Future | 错误码索引 |
isCameraFaceDetectSupported | — | Future | 错误码索引 |
isCameraFocusSupported | — | Future | 错误码索引 |
isCameraTorchSupported | — | Future | 错误码索引 |
isCameraZoomSupported | — | Future | 错误码索引 |
isFeatureAvailableOnDevice | type: FeatureType | Future | 错误码索引 |
isSpeakerphoneEnabled | — | Future | 错误码索引 |
joinChannel | options: String token,required String channelId,required int uid,required ChannelMediaOptions | Future | 错误码索引 |
joinChannelWithUserAccount | options?: String token,required String channelId,required String userAccount,ChannelMediaOptions? | Future | 错误码索引 |
joinChannelWithUserAccountEx | options: String token,required String channelId,required String userAccount,required ChannelMediaOptions | Future | 错误码索引 |
leaveChannel | options?: LeaveChannelOptions? | Future | 错误码索引 |
loadExtensionProvider | false: String path,bool unloadAfterUse = | Future | 错误码索引 |
muteAllRemoteAudioStreams | mute: bool | Future | 错误码索引 |
muteAllRemoteVideoStreams | mute: bool | Future | 错误码索引 |
muteLocalAudioStream | mute: bool | Future | 错误码索引 |
muteLocalVideoStream | mute: bool | Future | 错误码索引 |
muteRecordingSignal | mute: bool | Future | 错误码索引 |
muteRemoteAudioStream | mute: int uid,required bool | Future | 错误码索引 |
muteRemoteVideoStream | mute: int uid,required bool | Future | 错误码索引 |
pauseAllChannelMediaRelay | — | Future | 错误码索引 |
pauseAllEffects | — | Future | 错误码索引 |
pauseAudioMixing | — | Future | 错误码索引 |
pauseEffect | soundId: int | Future | 错误码索引 |
playAllEffects | false: int loopCount,required double pitch,required double pan,required int gain,bool publish = | Future | 错误码索引 |
playEffect | null: int soundId,required String filePath,required int loopCount,required double pitch,required double pan,required int gain,bool publish = false,int startPos = 0 | Future | 错误码索引 |
preloadChannel | uid: String token,required String channelId,required int | Future | 错误码索引 |
preloadChannelWithUserAccount | userAccount: String token,required String channelId,required String | Future | 错误码索引 |
preloadEffect | null: int soundId,required String filePath,int startPos = 0 | Future | 错误码索引 |
queryCameraFocalLengthCapability | — | Future -> | 错误码索引 |
queryCodecCapability | size: int | Future -> | 错误码索引 |
queryDeviceScore | — | Future | 错误码索引 |
queryScreenCaptureCapability | — | Future | 错误码索引 |
rate | description: String callId,required int rating,required String | Future | 错误码索引 |
registerAudioEncodedFrameObserver | observer: AudioEncodedFrameObserverConfig config,required AudioEncodedFrameObserver | void | 错误码索引 |
registerAudioSpectrumObserver | observer: AudioSpectrumObserver | void | 错误码索引 |
registerEventHandler | eventHandler: RtcEngineEventHandler | void | 错误码索引 |
registerExtension | null: String provider,required String extension,MediaSourceType type = MediaSourceType.unknownMediaSource | Future | 错误码索引 |
registerLocalUserAccount | userAccount: String appId,required String | Future | 错误码索引 |
registerMediaMetadataObserver | type: MetadataObserver observer,required MetadataType | void | 错误码索引 |
release | false: bool sync = | Future | 错误码索引 |
removeVideoWatermark | id: String | Future | 错误码索引 |
renewToken | token: String | Future | 错误码索引 |
resumeAllChannelMediaRelay | — | Future | 错误码索引 |
resumeAllEffects | — | Future | 错误码索引 |
resumeAudioMixing | — | Future | 错误码索引 |
resumeEffect | soundId: int | Future | 错误码索引 |
selectAudioTrack | index: int | Future | 错误码索引 |
sendCustomReportMessage | value: String id,required String category,required String event,required String label,required int | Future | 错误码索引 |
sendMetaData | sourceType: Metadata metadata,required VideoSourceType | Future | 错误码索引 |
sendStreamMessage | length: int streamId,required Uint8List data,required int | Future | 错误码索引 |
setAINSMode | mode: bool enabled,required AudioAinsMode | Future | 错误码索引 |
setAVSyncSource | uid: String channelId,required int | Future | 错误码索引 |
setAdvancedAudioOptions | options: AdvancedAudioOptions | Future | 错误码索引 |
setAudioEffectParameters | param2: AudioEffectPreset preset,required int param1,required int | Future | 错误码索引 |
setAudioEffectPreset | preset: AudioEffectPreset | Future | 错误码索引 |
setAudioMixingDualMonoMode | mode: AudioMixingDualMonoMode | Future | 错误码索引 |
setAudioMixingPitch | pitch: int | Future | 错误码索引 |
setAudioMixingPlaybackSpeed | speed: int | Future | 错误码索引 |
setAudioMixingPosition | pos: int | Future | 错误码索引 |
setAudioProfile | null: AudioProfileType profile,AudioScenarioType scenario = AudioScenarioType.audioScenarioDefault | Future | 错误码索引 |
setAudioScenario | scenario: AudioScenarioType | Future | 错误码索引 |
setAudioSessionOperationRestriction | restriction: AudioSessionOperationRestriction | Future | 错误码索引 |
setBeautyEffectOptions | null: bool enabled,required BeautyOptions options,MediaSourceType type = MediaSourceType.primaryCameraSource | Future | 错误码索引 |
setCameraAutoExposureFaceModeEnabled | enabled: bool | Future | 错误码索引 |
setCameraAutoFocusFaceModeEnabled | enabled: bool | Future | 错误码索引 |
setCameraCapturerConfiguration | config: CameraCapturerConfiguration | Future | 错误码索引 |
setCameraDeviceOrientation | orientation: VideoSourceType type,required VideoOrientation | Future | 错误码索引 |
setCameraExposureFactor | factor: double | Future | 错误码索引 |
setCameraExposurePosition | positionYinView: double positionXinView,required double | Future | 错误码索引 |
setCameraFocusPositionInPreview | positionY: double positionX,required double | Future | 错误码索引 |
setCameraStabilizationMode | mode: CameraStabilizationMode | Future | 错误码索引 |
setCameraTorchOn | isOn: bool | Future | 错误码索引 |
setCameraZoomFactor | factor: double | Future | 错误码索引 |
setChannelProfile | profile: ChannelProfileType | Future | 错误码索引 |
setClientRole | options?: ClientRoleType role,ClientRoleOptions? | Future | 错误码索引 |
setCloudProxy | proxyType: CloudProxyType | Future | 错误码索引 |
setColorEnhanceOptions | null: bool enabled,required ColorEnhanceOptions options,MediaSourceType type = MediaSourceType.primaryCameraSource | Future | 错误码索引 |
setDefaultAudioRouteToSpeakerphone | defaultToSpeaker: bool | Future | 错误码索引 |
setDualStreamMode | streamConfig?: SimulcastStreamMode mode,SimulcastStreamConfig? | Future | 错误码索引 |
setEarMonitoringAudioFrameParameters | samplesPerCall: int sampleRate,required int channel,required RawAudioFrameOpModeType mode,required int | Future | 错误码索引 |
setEffectPosition | pos: int soundId,required int | Future | 错误码索引 |
setEffectsVolume | volume: int | Future | 错误码索引 |
setEnableSpeakerphone | speakerOn: bool | Future | 错误码索引 |
setExtensionProperty | null: String provider,required String extension,required String key,required String value,MediaSourceType type = MediaSourceType.unknownMediaSource | Future | 错误码索引 |
setExtensionProviderProperty | value: String provider,required String key,required String | Future | 错误码索引 |
setExternalMediaProjection | mediaProjection: int | Future | 错误码索引 |
setExternalRemoteEglContext | eglContext: int | Future | 错误码索引 |
setFaceShapeAreaOptions | null: FaceShapeAreaOptions options,MediaSourceType type = MediaSourceType.primaryCameraSource | Future | 错误码索引 |
setFaceShapeBeautyOptions | null: bool enabled,required FaceShapeBeautyOptions options,MediaSourceType type = MediaSourceType.primaryCameraSource | Future | 错误码索引 |
setFilterEffectOptions | null: bool enabled,required FilterEffectOptions options,MediaSourceType type = MediaSourceType.primaryCameraSource | Future | 错误码索引 |
setHeadphoneEQParameters | highGain: int lowGain,required int | Future | 错误码索引 |
setHeadphoneEQPreset | preset: HeadphoneEqualizerPreset | Future | 错误码索引 |
setInEarMonitoringVolume | volume: int | Future | 错误码索引 |
setLocalAccessPoint | config: LocalAccessPointConfiguration | Future | 错误码索引 |
setLocalRenderMode | null: RenderModeType renderMode,VideoMirrorModeType mirrorMode = VideoMirrorModeType.videoMirrorModeAuto | Future | 错误码索引 |
setLocalRenderTargetFps | targetFps: VideoSourceType sourceType,required int | Future | 错误码索引 |
setLocalVideoMirrorMode | mirrorMode: VideoMirrorModeType | Future | 错误码索引 |
setLocalVoiceEqualization | bandGain: AudioEqualizationBandFrequency bandFrequency,required int | Future | 错误码索引 |
setLocalVoiceFormant | formantRatio: double | Future | 错误码索引 |
setLocalVoicePitch | pitch: double | Future | 错误码索引 |
setLocalVoiceReverb | value: AudioReverbType reverbKey,required int | Future | 错误码索引 |
setLogFile | filePath: String | Future | 错误码索引 |
setLogFileSize | fileSizeInKBytes: int | Future | 错误码索引 |
setLogFilter | filter: LogFilterType | Future | 错误码索引 |
setLogLevel | level: LogLevel | Future | 错误码索引 |
setLowlightEnhanceOptions | null: bool enabled,required LowlightEnhanceOptions options,MediaSourceType type = MediaSourceType.primaryCameraSource | Future | 错误码索引 |
setMaxMetadataSize | size: int | Future | 错误码索引 |
setMixedAudioFrameParameters | samplesPerCall: int sampleRate,required int channel,required int | Future | 错误码索引 |
setParameters | parameters: String | Future | 错误码索引 |
setPlaybackAudioFrameBeforeMixingParameters | samplesPerCall: int sampleRate,required int channel {required int sampleRate,required int | Future | 错误码索引 |
setPlaybackAudioFrameParameters | samplesPerCall: int sampleRate,required int channel,required RawAudioFrameOpModeType mode,required int | Future | 错误码索引 |
setRecordingAudioFrameParameters | samplesPerCall: int sampleRate,required int channel,required RawAudioFrameOpModeType mode,required int | Future | 错误码索引 |
setRemoteDefaultVideoStreamType | streamType: VideoStreamType | Future | 错误码索引 |
setRemoteRenderMode | mirrorMode: int uid,required RenderModeType renderMode,required VideoMirrorModeType | Future | 错误码索引 |
setRemoteRenderTargetFps | targetFps: int | Future | 错误码索引 |
setRemoteSubscribeFallbackOption | option: StreamFallbackOptions | Future | 错误码索引 |
setRemoteUserSpatialAudioParams | params: int uid,required SpatialAudioParams | Future | 错误码索引 |
setRemoteVideoStreamType | streamType: int uid,required VideoStreamType | Future | 错误码索引 |
setRemoteVideoSubscriptionOptions | options: int uid,required VideoSubscriptionOptions | Future | 错误码索引 |
setRemoteVoicePosition | gain: int uid,required double pan,required double | Future | 错误码索引 |
setRouteInCommunicationMode | route: int | Future | 错误码索引 |
setScreenCaptureContentHint | contentHint: VideoContentHint | Future | 错误码索引 |
setScreenCaptureScenario | screenScenario: ScreenScenarioType | Future | 错误码索引 |
setSubscribeAudioAllowlist | uidNumber: List uidList,required int | Future | 错误码索引 |
setSubscribeAudioBlocklist | uidNumber: List uidList,required int | Future | 错误码索引 |
setSubscribeVideoAllowlist | uidNumber: List uidList,required int | Future | 错误码索引 |
setSubscribeVideoBlocklist | uidNumber: List uidList,required int | Future | 错误码索引 |
setVideoDenoiserOptions | null: bool enabled,required VideoDenoiserOptions options,MediaSourceType type = MediaSourceType.primaryCameraSource | Future | 错误码索引 |
setVideoEncoderConfiguration | config: VideoEncoderConfiguration | Future | 错误码索引 |
setVideoScenario | scenarioType: VideoApplicationScenarioType | Future | 错误码索引 |
setVoiceBeautifierParameters | param2: VoiceBeautifierPreset preset,required int param1,required int | Future | 错误码索引 |
setVoiceBeautifierPreset | preset: VoiceBeautifierPreset | Future | 错误码索引 |
setVoiceConversionPreset | preset: VoiceConversionPreset | Future | 错误码索引 |
setVolumeOfEffect | volume: int soundId,required int | Future | 错误码索引 |
setupLocalVideo | canvas: VideoCanvas | Future | 错误码索引 |
setupRemoteVideo | canvas: VideoCanvas | Future | 错误码索引 |
startAudioMixing | null: String filePath,required bool loopback,required int cycle,int startPos = 0 | Future | 错误码索引 |
startAudioRecording | config: AudioRecordingConfiguration | Future | 错误码索引 |
startCameraCapture | config: VideoSourceType sourceType,required CameraCapturerConfiguration | Future | 错误码索引 |
startEchoTest | config: EchoTestConfiguration | Future | 错误码索引 |
startLastmileProbeTest | config: LastmileProbeConfig | Future | 错误码索引 |
startLocalAudioMixer | config: LocalAudioMixerConfiguration | Future | 错误码索引 |
startLocalVideoTranscoder | config: LocalTranscoderConfiguration | Future | 错误码索引 |
startMediaRenderingTracing | — | Future | 错误码索引 |
startOrUpdateChannelMediaRelay | configuration: ChannelMediaRelayConfiguration | Future | 错误码索引 |
startPreview | null: VideoSourceType sourceType = VideoSourceType.videoSourceCameraPrimary | Future | 错误码索引 |
startPreviewWithoutSourceType | — | Future | 错误码索引 |
startRhythmPlayer | config: String sound1,required String sound2,required AgoraRhythmPlayerConfig | Future | 错误码索引 |
startRtmpStreamWithTranscoding | transcoding: String url,required LiveTranscoding | Future | 错误码索引 |
startRtmpStreamWithoutTranscoding | url: String | Future | 错误码索引 |
startScreenCapture | captureParams: ScreenCaptureParameters2 | Future | 错误码索引 |
startScreenCaptureByDisplayId | captureParams: int displayId,required Rectangle regionRect,required ScreenCaptureParameters | Future | 错误码索引 |
startScreenCaptureByScreenRect | captureParams: Rectangle screenRect,required Rectangle regionRect,required ScreenCaptureParameters | Future | 错误码索引 |
startScreenCaptureBySourceType | config: VideoSourceType sourceType,required ScreenCaptureConfiguration | Future | 错误码索引 |
startScreenCaptureByWindowId | captureParams: int windowId,required Rectangle regionRect,required ScreenCaptureParameters | Future | 错误码索引 |
stopAllEffects | — | Future | 错误码索引 |
stopAudioMixing | — | Future | 错误码索引 |
stopAudioRecording | — | Future | 错误码索引 |
stopCameraCapture | sourceType: VideoSourceType | Future | 错误码索引 |
stopChannelMediaRelay | — | Future | 错误码索引 |
stopEchoTest | — | Future | 错误码索引 |
stopEffect | soundId: int | Future | 错误码索引 |
stopLastmileProbeTest | — | Future | 错误码索引 |
stopLocalAudioMixer | — | Future | 错误码索引 |
stopLocalVideoTranscoder | — | Future | 错误码索引 |
stopPreview | null: VideoSourceType sourceType = VideoSourceType.videoSourceCameraPrimary | Future | 错误码索引 |
stopRhythmPlayer | — | Future | 错误码索引 |
stopRtmpStream | url: String | Future | 错误码索引 |
stopScreenCapture | — | Future | 错误码索引 |
stopScreenCaptureBySourceType | sourceType: VideoSourceType | Future | 错误码索引 |
switchCamera | — | Future | 错误码索引 |
takeSnapshot | filePath: int uid,required String | Future | 错误码索引 |
takeSnapshotWithConfig | config: int uid,required SnapshotConfig | Future | 错误码索引 |
unloadAllEffects | — | Future | 错误码索引 |
unloadEffect | soundId: int | Future | 错误码索引 |
unregisterAudioEncodedFrameObserver | observer: AudioEncodedFrameObserver | void | 错误码索引 |
unregisterAudioSpectrumObserver | observer: AudioSpectrumObserver | void | 错误码索引 |
unregisterEventHandler | eventHandler: RtcEngineEventHandler | void | 错误码索引 |
unregisterMediaMetadataObserver | type: MetadataObserver observer,required MetadataType | void | 错误码索引 |
updateChannelMediaOptions | options: ChannelMediaOptions | Future | 错误码索引 |
updateLocalAudioMixerConfiguration | config: LocalAudioMixerConfiguration | Future | 错误码索引 |
updateLocalTranscoderConfiguration | config: LocalTranscoderConfiguration | Future | 错误码索引 |
updatePreloadChannelToken | token: String | Future | 错误码索引 |
updateRtmpTranscoding | transcoding: LiveTranscoding | Future | 错误码索引 |
updateScreenCapture | captureParams: ScreenCaptureParameters2 | Future | 错误码索引 |
updateScreenCaptureParameters | captureParams: ScreenCaptureParameters | Future | 错误码索引 |
updateScreenCaptureRegion | regionRect: Rectangle | Future | 错误码索引 |
RtcEngineContext 0 方法 / 7 属性
| 属性 | 类型 | 只读 |
|---|---|---|
appId | String? | 否 |
channelProfile | ChannelProfileType? | 否 |
audioScenario | AudioScenarioType? | 否 |
areaCode | int? | 否 |
logConfig | LogConfig? | 否 |
domainLimit | bool? | 否 |
autoRegisterAgoraExtensions | bool? | 否 |
RtcEngineEventHandler 87 方法 / 0 属性
onActiveSpeaker(connection: RtcConnection, uid: int): void
onAudioDeviceStateChanged(deviceId: String, deviceType: MediaDeviceType, deviceState: MediaDeviceStateType): void
onAudioDeviceVolumeChanged(deviceType: MediaDeviceType, volume: int, muted: bool): void
onAudioEffectFinished(soundId: int): void
onAudioMixingFinished(): void
onAudioMixingPositionChanged(position: int): void
onAudioMixingStateChanged(state: AudioMixingStateType, reason: AudioMixingReasonType): void
onAudioPublishStateChanged(channel: String, oldState: StreamPublishState, newState: StreamPublishState, elapseSinceLastState: int): void
onAudioQuality(connection: RtcConnection, remoteUid: int, quality: QualityType, delay: int, lost: int): void
onAudioRoutingChanged(routing: int): void
onAudioSubscribeStateChanged(channel: String, uid: int, oldState: StreamSubscribeState, newState: StreamSubscribeState, elapseSinceLastState: int): void
onAudioVolumeIndication(connection: RtcConnection, speakers: List, speakerNumber: int, totalVolume: int): void
onCameraExposureAreaChanged(x: int, y: int, width: int, height: int): void
onCameraFocusAreaChanged(x: int, y: int, width: int, height: int): void
onCameraReady(): void
onChannelMediaRelayStateChanged(state: ChannelMediaRelayState, code: ChannelMediaRelayError): void
onClientRoleChangeFailed(connection: RtcConnection, reason: ClientRoleChangeFailedReason, currentRole: ClientRoleType): void
onClientRoleChanged(connection: RtcConnection, oldRole: ClientRoleType, newRole: ClientRoleType, newRoleOptions: ClientRoleOptions): void
onConnectionBanned(connection: RtcConnection): void
onConnectionInterrupted(connection: RtcConnection): void
onConnectionLost(connection: RtcConnection): void
onConnectionStateChanged(connection: RtcConnection, state: ConnectionStateType, reason: ConnectionChangedReasonType): void
onEncryptionError(connection: RtcConnection, errorType: EncryptionErrorType): void
onError(err: ErrorCodeType, msg: String): void
onExtensionErrorWithContext(context: ExtensionContext, error: int, message: String): void
onExtensionEventWithContext(context: ExtensionContext, key: String, value: String): void
onExtensionStartedWithContext(context: ExtensionContext): void
onExtensionStoppedWithContext(context: ExtensionContext): void
onFacePositionChanged(imageWidth: int, imageHeight: int, vecRectangle: Rectangle, vecDistance: int, numFaces: int): void
onFirstLocalAudioFramePublished(connection: RtcConnection, elapsed: int): void
onFirstLocalVideoFrame(source: VideoSourceType, width: int, height: int, elapsed: int): void
onFirstLocalVideoFramePublished(connection: RtcConnection, elapsed: int): void
onFirstRemoteAudioDecoded(connection: RtcConnection, uid: int, elapsed: int): void
onFirstRemoteAudioFrame(connection: RtcConnection, userId: int, elapsed: int): void
onFirstRemoteVideoDecoded(connection: RtcConnection, remoteUid: int, width: int, height: int, elapsed: int): void
onFirstRemoteVideoFrame(connection: RtcConnection, remoteUid: int, width: int, height: int, elapsed: int): void
onJoinChannelSuccess(connection: RtcConnection, elapsed: int): void
onLastmileProbeResult(result: LastmileProbeResult): void
onLastmileQuality(quality: QualityType): void
onLeaveChannel(connection: RtcConnection, stats: RtcStats): void
onLocalAudioStateChanged(connection: RtcConnection, state: LocalAudioStreamState, reason: LocalAudioStreamReason): void
onLocalAudioStats(connection: RtcConnection, stats: LocalAudioStats): void
onLocalUserRegistered(uid: int, userAccount: String): void
onLocalVideoEvent(source: VideoSourceType, event: LocalVideoEventType): void
onLocalVideoStateChanged(source: unknown, state: unknown, reason: unknown): unknown
onLocalVideoStats(connection: RtcConnection, stats: LocalVideoStats): void
onLocalVideoTranscoderError(stream: TranscodingVideoStream, error: VideoTranscoderError): void
onMultipathStats(connection: RtcConnection, stats: MultipathStats): void
onNetworkQuality(connection: RtcConnection, remoteUid: int, txQuality: QualityType, rxQuality: QualityType): void
onNetworkTypeChanged(connection: RtcConnection, type: NetworkType): void
onPermissionError(permissionType: PermissionType): void
onPermissionGranted(permissionType: PermissionType): void
onProxyConnected(channel: String, uid: int, proxyType: ProxyType, localProxyIp: String, elapsed: int): void
onRejoinChannelSuccess(connection: RtcConnection, elapsed: int): void
onRemoteAudioStateChanged(connection: RtcConnection, remoteUid: int, state: RemoteAudioState, reason: RemoteAudioStateReason, elapsed: int): void
onRemoteAudioStats(connection: RtcConnection, stats: RemoteAudioStats): void
onRemoteAudioTransportStats(connection: RtcConnection, remoteUid: int, delay: int, lost: int, rxKBitRate: int): void
onRemoteSubscribeFallbackToAudioOnly(uid: int, isFallbackOrRecover: bool): void
onRemoteVideoStateChanged(connection: RtcConnection, remoteUid: int, state: RemoteVideoState, reason: RemoteVideoStateReason, elapsed: int): void
onRemoteVideoStats(connection: RtcConnection, stats: RemoteVideoStats): void
onRemoteVideoTransportStats(connection: RtcConnection, remoteUid: int, delay: int, lost: int, rxKBitRate: int): void
onRenewTokenResult(connection: RtcConnection, token: String, code: RenewTokenErrorCode): void
onRequestToken(connection: RtcConnection): void
onRhythmPlayerStateChanged(state: RhythmPlayerStateType, reason: RhythmPlayerReason): void
onRtcStats(connection: RtcConnection, stats: RtcStats): void
onRtmpStreamingEvent(url: String, eventCode: RtmpStreamingEvent): void
onRtmpStreamingStateChanged(url: String, state: RtmpStreamPublishState, reason: RtmpStreamPublishReason): void
onSnapshotTaken(connection: RtcConnection, uid: int, filePath: String, width: int, height: int, errCode: int): void
onStreamMessage(connection: RtcConnection, remoteUid: int, streamId: int, data: Uint8List, length: int, sentTs: int): void
onStreamMessageError(connection: RtcConnection, remoteUid: int, streamId: int, code: ErrorCodeType, missed: int, cached: int): void
onTokenPrivilegeWillExpire(connection: RtcConnection, token: String): void
onTranscodedStreamLayoutInfo(connection: RtcConnection, uid: int, width: int, height: int, layoutCount: int, layoutlist: List): void
onTranscodingUpdated(): void
onUplinkNetworkInfoUpdated(info: UplinkNetworkInfo): void
onUserEnableLocalVideo(connection: RtcConnection, remoteUid: int, enabled: bool): void
onUserEnableVideo(connection: RtcConnection, remoteUid: int, enabled: bool): void
onUserInfoUpdated(uid: int, info: UserInfo): void
onUserJoined(connection: RtcConnection, remoteUid: int, elapsed: int): void
onUserMuteAudio(connection: RtcConnection, remoteUid: int, muted: bool): void
onUserMuteVideo(connection: RtcConnection, remoteUid: int, muted: bool): void
onUserOffline(connection: RtcConnection, remoteUid: int, reason: UserOfflineReasonType): void
onVideoDeviceStateChanged(deviceId: String, deviceType: MediaDeviceType, deviceState: MediaDeviceStateType): void
onVideoPublishStateChanged(source: VideoSourceType, channel: String, oldState: StreamPublishState, newState: StreamPublishState, elapseSinceLastState: int): void
onVideoRenderingTracingResult(connection: RtcConnection, uid: int, currentEvent: MediaTraceEvent, tracingInfo: VideoRenderingTracingInfo): void
onVideoSizeChanged(connection: RtcConnection, sourceType: VideoSourceType, uid: int, width: int, height: int, rotation: int): void
onVideoStopped(): void
onVideoSubscribeStateChanged(channel: String, uid: int, oldState: StreamSubscribeState, newState: StreamSubscribeState, elapseSinceLastState: int): void方法明细:87 / 87(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
onActiveSpeaker | connection: RtcConnection, uid: int | void | 错误码索引 |
onAudioDeviceStateChanged | deviceId: String, deviceType: MediaDeviceType, deviceState: MediaDeviceStateType | void | 错误码索引 |
onAudioDeviceVolumeChanged | deviceType: MediaDeviceType, volume: int, muted: bool | void | 错误码索引 |
onAudioEffectFinished | soundId: int | void | 错误码索引 |
onAudioMixingFinished | — | void | 错误码索引 |
onAudioMixingPositionChanged | position: int | void | 错误码索引 |
onAudioMixingStateChanged | state: AudioMixingStateType, reason: AudioMixingReasonType | void | 错误码索引 |
onAudioPublishStateChanged | channel: String, oldState: StreamPublishState, newState: StreamPublishState, elapseSinceLastState: int | void | 错误码索引 |
onAudioQuality | connection: RtcConnection, remoteUid: int, quality: QualityType, delay: int, lost: int | void | 错误码索引 |
onAudioRoutingChanged | routing: int | void | 错误码索引 |
onAudioSubscribeStateChanged | channel: String, uid: int, oldState: StreamSubscribeState, newState: StreamSubscribeState, elapseSinceLastState: int | void | 错误码索引 |
onAudioVolumeIndication | connection: RtcConnection, speakers: List, speakerNumber: int, totalVolume: int | void | 错误码索引 |
onCameraExposureAreaChanged | x: int, y: int, width: int, height: int | void | 错误码索引 |
onCameraFocusAreaChanged | x: int, y: int, width: int, height: int | void | 错误码索引 |
onCameraReady | — | void | 错误码索引 |
onChannelMediaRelayStateChanged | state: ChannelMediaRelayState, code: ChannelMediaRelayError | void | 错误码索引 |
onClientRoleChangeFailed | connection: RtcConnection, reason: ClientRoleChangeFailedReason, currentRole: ClientRoleType | void | 错误码索引 |
onClientRoleChanged | connection: RtcConnection, oldRole: ClientRoleType, newRole: ClientRoleType, newRoleOptions: ClientRoleOptions | void | 错误码索引 |
onConnectionBanned | connection: RtcConnection | void | 错误码索引 |
onConnectionInterrupted | connection: RtcConnection | void | 错误码索引 |
onConnectionLost | connection: RtcConnection | void | 错误码索引 |
onConnectionStateChanged | connection: RtcConnection, state: ConnectionStateType, reason: ConnectionChangedReasonType | void | 错误码索引 |
onEncryptionError | connection: RtcConnection, errorType: EncryptionErrorType | void | 错误码索引 |
onError | err: ErrorCodeType, msg: String | void | 错误码索引 |
onExtensionErrorWithContext | context: ExtensionContext, error: int, message: String | void | 错误码索引 |
onExtensionEventWithContext | context: ExtensionContext, key: String, value: String | void | 错误码索引 |
onExtensionStartedWithContext | context: ExtensionContext | void | 错误码索引 |
onExtensionStoppedWithContext | context: ExtensionContext | void | 错误码索引 |
onFacePositionChanged | imageWidth: int, imageHeight: int, vecRectangle: Rectangle, vecDistance: int, numFaces: int | void | 错误码索引 |
onFirstLocalAudioFramePublished | connection: RtcConnection, elapsed: int | void | 错误码索引 |
onFirstLocalVideoFrame | source: VideoSourceType, width: int, height: int, elapsed: int | void | 错误码索引 |
onFirstLocalVideoFramePublished | connection: RtcConnection, elapsed: int | void | 错误码索引 |
onFirstRemoteAudioDecoded | connection: RtcConnection, uid: int, elapsed: int | void | 错误码索引 |
onFirstRemoteAudioFrame | connection: RtcConnection, userId: int, elapsed: int | void | 错误码索引 |
onFirstRemoteVideoDecoded | connection: RtcConnection, remoteUid: int, width: int, height: int, elapsed: int | void | 错误码索引 |
onFirstRemoteVideoFrame | connection: RtcConnection, remoteUid: int, width: int, height: int, elapsed: int | void | 错误码索引 |
onJoinChannelSuccess | connection: RtcConnection, elapsed: int | void | 错误码索引 |
onLastmileProbeResult | result: LastmileProbeResult | void | 错误码索引 |
onLastmileQuality | quality: QualityType | void | 错误码索引 |
onLeaveChannel | connection: RtcConnection, stats: RtcStats | void | 错误码索引 |
onLocalAudioStateChanged | connection: RtcConnection, state: LocalAudioStreamState, reason: LocalAudioStreamReason | void | 错误码索引 |
onLocalAudioStats | connection: RtcConnection, stats: LocalAudioStats | void | 错误码索引 |
onLocalUserRegistered | uid: int, userAccount: String | void | 错误码索引 |
onLocalVideoEvent | source: VideoSourceType, event: LocalVideoEventType | void | 错误码索引 |
onLocalVideoStateChanged | source: unknown, state: unknown, reason: unknown | unknown | 错误码索引 |
onLocalVideoStats | connection: RtcConnection, stats: LocalVideoStats | void | 错误码索引 |
onLocalVideoTranscoderError | stream: TranscodingVideoStream, error: VideoTranscoderError | void | 错误码索引 |
onMultipathStats | connection: RtcConnection, stats: MultipathStats | void | 错误码索引 |
onNetworkQuality | connection: RtcConnection, remoteUid: int, txQuality: QualityType, rxQuality: QualityType | void | 错误码索引 |
onNetworkTypeChanged | connection: RtcConnection, type: NetworkType | void | 错误码索引 |
onPermissionError | permissionType: PermissionType | void | 错误码索引 |
onPermissionGranted | permissionType: PermissionType | void | 错误码索引 |
onProxyConnected | channel: String, uid: int, proxyType: ProxyType, localProxyIp: String, elapsed: int | void | 错误码索引 |
onRejoinChannelSuccess | connection: RtcConnection, elapsed: int | void | 错误码索引 |
onRemoteAudioStateChanged | connection: RtcConnection, remoteUid: int, state: RemoteAudioState, reason: RemoteAudioStateReason, elapsed: int | void | 错误码索引 |
onRemoteAudioStats | connection: RtcConnection, stats: RemoteAudioStats | void | 错误码索引 |
onRemoteAudioTransportStats | connection: RtcConnection, remoteUid: int, delay: int, lost: int, rxKBitRate: int | void | 错误码索引 |
onRemoteSubscribeFallbackToAudioOnly | uid: int, isFallbackOrRecover: bool | void | 错误码索引 |
onRemoteVideoStateChanged | connection: RtcConnection, remoteUid: int, state: RemoteVideoState, reason: RemoteVideoStateReason, elapsed: int | void | 错误码索引 |
onRemoteVideoStats | connection: RtcConnection, stats: RemoteVideoStats | void | 错误码索引 |
onRemoteVideoTransportStats | connection: RtcConnection, remoteUid: int, delay: int, lost: int, rxKBitRate: int | void | 错误码索引 |
onRenewTokenResult | connection: RtcConnection, token: String, code: RenewTokenErrorCode | void | 错误码索引 |
onRequestToken | connection: RtcConnection | void | 错误码索引 |
onRhythmPlayerStateChanged | state: RhythmPlayerStateType, reason: RhythmPlayerReason | void | 错误码索引 |
onRtcStats | connection: RtcConnection, stats: RtcStats | void | 错误码索引 |
onRtmpStreamingEvent | url: String, eventCode: RtmpStreamingEvent | void | 错误码索引 |
onRtmpStreamingStateChanged | url: String, state: RtmpStreamPublishState, reason: RtmpStreamPublishReason | void | 错误码索引 |
onSnapshotTaken | connection: RtcConnection, uid: int, filePath: String, width: int, height: int, errCode: int | void | 错误码索引 |
onStreamMessage | connection: RtcConnection, remoteUid: int, streamId: int, data: Uint8List, length: int, sentTs: int | void | 错误码索引 |
onStreamMessageError | connection: RtcConnection, remoteUid: int, streamId: int, code: ErrorCodeType, missed: int, cached: int | void | 错误码索引 |
onTokenPrivilegeWillExpire | connection: RtcConnection, token: String | void | 错误码索引 |
onTranscodedStreamLayoutInfo | connection: RtcConnection, uid: int, width: int, height: int, layoutCount: int, layoutlist: List | void | 错误码索引 |
onTranscodingUpdated | — | void | 错误码索引 |
onUplinkNetworkInfoUpdated | info: UplinkNetworkInfo | void | 错误码索引 |
onUserEnableLocalVideo | connection: RtcConnection, remoteUid: int, enabled: bool | void | 错误码索引 |
onUserEnableVideo | connection: RtcConnection, remoteUid: int, enabled: bool | void | 错误码索引 |
onUserInfoUpdated | uid: int, info: UserInfo | void | 错误码索引 |
onUserJoined | connection: RtcConnection, remoteUid: int, elapsed: int | void | 错误码索引 |
onUserMuteAudio | connection: RtcConnection, remoteUid: int, muted: bool | void | 错误码索引 |
onUserMuteVideo | connection: RtcConnection, remoteUid: int, muted: bool | void | 错误码索引 |
onUserOffline | connection: RtcConnection, remoteUid: int, reason: UserOfflineReasonType | void | 错误码索引 |
onVideoDeviceStateChanged | deviceId: String, deviceType: MediaDeviceType, deviceState: MediaDeviceStateType | void | 错误码索引 |
onVideoPublishStateChanged | source: VideoSourceType, channel: String, oldState: StreamPublishState, newState: StreamPublishState, elapseSinceLastState: int | void | 错误码索引 |
onVideoRenderingTracingResult | connection: RtcConnection, uid: int, currentEvent: MediaTraceEvent, tracingInfo: VideoRenderingTracingInfo | void | 错误码索引 |
onVideoSizeChanged | connection: RtcConnection, sourceType: VideoSourceType, uid: int, width: int, height: int, rotation: int | void | 错误码索引 |
onVideoStopped | — | void | 错误码索引 |
onVideoSubscribeStateChanged | channel: String, uid: int, oldState: StreamSubscribeState, newState: StreamSubscribeState, elapseSinceLastState: int | void | 错误码索引 |
RtcEngineEx 49 方法 / 0 属性
addVideoWatermarkEx(connection: String watermarkUrl,required WatermarkOptions options,required RtcConnection): Future
addVideoWatermarkWithConfigEx(connection: WatermarkConfig config,required RtcConnection): Future
adjustUserPlaybackSignalVolumeEx(connection: int uid,required int volume,required RtcConnection): Future
clearVideoWatermarkEx(connection: RtcConnection): Future
createAgoraRtcEngineEx(): RtcEngineEx
createDataStreamEx(connection: DataStreamConfig config,required RtcConnection): Future
enableAudioVolumeIndicationEx(connection: int interval,required int smooth,required bool reportVad,required RtcConnection): Future
enableContentInspectEx(connection: bool enabled,required ContentInspectConfig config,required RtcConnection): Future
enableDualStreamModeEx(connection: bool enabled,required SimulcastStreamConfig streamConfig,required RtcConnection): Future
enableEncryptionEx(config: RtcConnection connection,required bool enabled,required EncryptionConfig): Future
enableLoopbackRecordingEx(deviceName?: RtcConnection connection,required bool enabled,String?): Future
getCallIdEx(connection: RtcConnection): Future
getConnectionStateEx(connection: RtcConnection): Future
joinChannelEx(options: String token,required RtcConnection connection,required ChannelMediaOptions): Future
leaveChannelEx(options?: RtcConnection connection,LeaveChannelOptions?): Future
muteAllRemoteAudioStreamsEx(connection: bool mute,required RtcConnection): Future
muteAllRemoteVideoStreamsEx(connection: bool mute,required RtcConnection): Future
muteLocalAudioStreamEx(connection: bool mute,required RtcConnection): Future
muteLocalVideoStreamEx(connection: bool mute,required RtcConnection): Future
muteRemoteAudioStreamEx(connection: int uid,required bool mute,required RtcConnection): Future
muteRemoteVideoStreamEx(connection: int uid,required bool mute,required RtcConnection): Future
pauseAllChannelMediaRelayEx(connection: RtcConnection): Future
playEffectEx(null: RtcConnection connection,required int soundId,required String filePath,required int loopCount,required double pitch,required double pan,required int gain,bool publish = false,int startPos = 0): Future
preloadEffectEx(null: RtcConnection connection,required int soundId,required String filePath,int startPos = 0): Future
removeVideoWatermarkEx(connection: String id,required RtcConnection): Future
resumeAllChannelMediaRelayEx(connection: RtcConnection): Future
sendCustomReportMessageEx(connection: String id,required String category,required String event,required String label,required int value,required RtcConnection): Future
sendStreamMessageEx(connection: int streamId,required Uint8List data,required int length,required RtcConnection): Future
setDualStreamModeEx(connection: SimulcastStreamMode mode,required SimulcastStreamConfig streamConfig,required RtcConnection): Future
setRemoteRenderModeEx(connection: int uid,required RenderModeType renderMode,required VideoMirrorModeType mirrorMode,required RtcConnection): Future
setRemoteVideoStreamTypeEx(connection: int uid,required VideoStreamType streamType,required RtcConnection): Future
setRemoteVideoSubscriptionOptionsEx(connection: int uid,required VideoSubscriptionOptions options,required RtcConnection): Future
setRemoteVoicePositionEx(connection: int uid,required double pan,required double gain,required RtcConnection): Future
setSubscribeAudioAllowlistEx(connection: List uidList,required int uidNumber,required RtcConnection): Future
setSubscribeAudioBlocklistEx(connection: List uidList,required int uidNumber,required RtcConnection): Future
setSubscribeVideoAllowlistEx(connection: List uidList,required int uidNumber,required RtcConnection): Future
setSubscribeVideoBlocklistEx(connection: List uidList,required int uidNumber,required RtcConnection): Future
setVideoEncoderConfigurationEx(connection: VideoEncoderConfiguration config,required RtcConnection): Future
setupRemoteVideoEx(connection: VideoCanvas canvas,required RtcConnection): Future
startMediaRenderingTracingEx(connection: RtcConnection): Future
startOrUpdateChannelMediaRelayEx(connection: ChannelMediaRelayConfiguration configuration,required RtcConnection): Future
startRtmpStreamWithTranscodingEx(connection: String url,required LiveTranscoding transcoding,required RtcConnection): Future
startRtmpStreamWithoutTranscodingEx(connection: String url,required RtcConnection): Future
stopChannelMediaRelayEx(connection: RtcConnection): Future
stopRtmpStreamEx(connection: String url,required RtcConnection): Future
takeSnapshotEx(filePath: RtcConnection connection,required int uid,required String): Future
takeSnapshotWithConfigEx(config: RtcConnection connection,required int uid,required SnapshotConfig): Future
updateChannelMediaOptionsEx(connection: ChannelMediaOptions options,required RtcConnection): Future
updateRtmpTranscodingEx(connection: LiveTranscoding transcoding,required RtcConnection): Future方法明细:49 / 49(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
addVideoWatermarkEx | connection: String watermarkUrl,required WatermarkOptions options,required RtcConnection | Future | 错误码索引 |
addVideoWatermarkWithConfigEx | connection: WatermarkConfig config,required RtcConnection | Future | 错误码索引 |
adjustUserPlaybackSignalVolumeEx | connection: int uid,required int volume,required RtcConnection | Future | 错误码索引 |
clearVideoWatermarkEx | connection: RtcConnection | Future | 错误码索引 |
createAgoraRtcEngineEx | — | RtcEngineEx | 错误码索引 |
createDataStreamEx | connection: DataStreamConfig config,required RtcConnection | Future | 错误码索引 |
enableAudioVolumeIndicationEx | connection: int interval,required int smooth,required bool reportVad,required RtcConnection | Future | 错误码索引 |
enableContentInspectEx | connection: bool enabled,required ContentInspectConfig config,required RtcConnection | Future | 错误码索引 |
enableDualStreamModeEx | connection: bool enabled,required SimulcastStreamConfig streamConfig,required RtcConnection | Future | 错误码索引 |
enableEncryptionEx | config: RtcConnection connection,required bool enabled,required EncryptionConfig | Future | 错误码索引 |
enableLoopbackRecordingEx | deviceName?: RtcConnection connection,required bool enabled,String? | Future | 错误码索引 |
getCallIdEx | connection: RtcConnection | Future | 错误码索引 |
getConnectionStateEx | connection: RtcConnection | Future | 错误码索引 |
joinChannelEx | options: String token,required RtcConnection connection,required ChannelMediaOptions | Future | 错误码索引 |
leaveChannelEx | options?: RtcConnection connection,LeaveChannelOptions? | Future | 错误码索引 |
muteAllRemoteAudioStreamsEx | connection: bool mute,required RtcConnection | Future | 错误码索引 |
muteAllRemoteVideoStreamsEx | connection: bool mute,required RtcConnection | Future | 错误码索引 |
muteLocalAudioStreamEx | connection: bool mute,required RtcConnection | Future | 错误码索引 |
muteLocalVideoStreamEx | connection: bool mute,required RtcConnection | Future | 错误码索引 |
muteRemoteAudioStreamEx | connection: int uid,required bool mute,required RtcConnection | Future | 错误码索引 |
muteRemoteVideoStreamEx | connection: int uid,required bool mute,required RtcConnection | Future | 错误码索引 |
pauseAllChannelMediaRelayEx | connection: RtcConnection | Future | 错误码索引 |
playEffectEx | null: RtcConnection connection,required int soundId,required String filePath,required int loopCount,required double pitch,required double pan,required int gain,bool publish = false,int startPos = 0 | Future | 错误码索引 |
preloadEffectEx | null: RtcConnection connection,required int soundId,required String filePath,int startPos = 0 | Future | 错误码索引 |
removeVideoWatermarkEx | connection: String id,required RtcConnection | Future | 错误码索引 |
resumeAllChannelMediaRelayEx | connection: RtcConnection | Future | 错误码索引 |
sendCustomReportMessageEx | connection: String id,required String category,required String event,required String label,required int value,required RtcConnection | Future | 错误码索引 |
sendStreamMessageEx | connection: int streamId,required Uint8List data,required int length,required RtcConnection | Future | 错误码索引 |
setDualStreamModeEx | connection: SimulcastStreamMode mode,required SimulcastStreamConfig streamConfig,required RtcConnection | Future | 错误码索引 |
setRemoteRenderModeEx | connection: int uid,required RenderModeType renderMode,required VideoMirrorModeType mirrorMode,required RtcConnection | Future | 错误码索引 |
setRemoteVideoStreamTypeEx | connection: int uid,required VideoStreamType streamType,required RtcConnection | Future | 错误码索引 |
setRemoteVideoSubscriptionOptionsEx | connection: int uid,required VideoSubscriptionOptions options,required RtcConnection | Future | 错误码索引 |
setRemoteVoicePositionEx | connection: int uid,required double pan,required double gain,required RtcConnection | Future | 错误码索引 |
setSubscribeAudioAllowlistEx | connection: List uidList,required int uidNumber,required RtcConnection | Future | 错误码索引 |
setSubscribeAudioBlocklistEx | connection: List uidList,required int uidNumber,required RtcConnection | Future | 错误码索引 |
setSubscribeVideoAllowlistEx | connection: List uidList,required int uidNumber,required RtcConnection | Future | 错误码索引 |
setSubscribeVideoBlocklistEx | connection: List uidList,required int uidNumber,required RtcConnection | Future | 错误码索引 |
setVideoEncoderConfigurationEx | connection: VideoEncoderConfiguration config,required RtcConnection | Future | 错误码索引 |
setupRemoteVideoEx | connection: VideoCanvas canvas,required RtcConnection | Future | 错误码索引 |
startMediaRenderingTracingEx | connection: RtcConnection | Future | 错误码索引 |
startOrUpdateChannelMediaRelayEx | connection: ChannelMediaRelayConfiguration configuration,required RtcConnection | Future | 错误码索引 |
startRtmpStreamWithTranscodingEx | connection: String url,required LiveTranscoding transcoding,required RtcConnection | Future | 错误码索引 |
startRtmpStreamWithoutTranscodingEx | connection: String url,required RtcConnection | Future | 错误码索引 |
stopChannelMediaRelayEx | connection: RtcConnection | Future | 错误码索引 |
stopRtmpStreamEx | connection: String url,required RtcConnection | Future | 错误码索引 |
takeSnapshotEx | filePath: RtcConnection connection,required int uid,required String | Future | 错误码索引 |
takeSnapshotWithConfigEx | config: RtcConnection connection,required int uid,required SnapshotConfig | Future | 错误码索引 |
updateChannelMediaOptionsEx | connection: ChannelMediaOptions options,required RtcConnection | Future | 错误码索引 |
updateRtmpTranscodingEx | connection: LiveTranscoding transcoding,required RtcConnection | Future | 错误码索引 |
RtcEngineExt 1 方法 / 0 属性
getAssetAbsolutePath(assetPath: String): Future方法明细:1 / 1(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
getAssetAbsolutePath | assetPath: String | Future | 错误码索引 |
RtcImage 0 方法 / 7 属性
| 属性 | 类型 | 只读 |
|---|---|---|
url | String? | 否 |
x | int? | 否 |
y | int? | 否 |
width | int? | 否 |
height | int? | 否 |
zOrder | int? | 否 |
alpha | double? | 否 |
RtcStats 0 方法 / 24 属性
| 属性 | 类型 | 只读 |
|---|---|---|
duration | int? | 否 |
txBytes | int? | 否 |
rxBytes | int? | 否 |
txAudioBytes | int? | 否 |
txVideoBytes | int? | 否 |
rxAudioBytes | int? | 否 |
rxVideoBytes | int? | 否 |
txKBitRate | int? | 否 |
rxKBitRate | int? | 否 |
rxAudioKBitRate | int? | 否 |
txAudioKBitRate | int? | 否 |
rxVideoKBitRate | int? | 否 |
txVideoKBitRate | int? | 否 |
lastmileDelay | int? | 否 |
txPacketLossRate | int? | 否 |
rxPacketLossRate | int? | 否 |
userCount | int? | 否 |
cpuAppUsage | double? | 否 |
cpuTotalUsage | double? | 否 |
connectTimeMs | int? | 否 |
gatewayRtt | int? | 否 |
memoryAppUsageRatio | double? | 否 |
memoryTotalUsageRatio | double? | 否 |
memoryAppUsageInKbytes | int? | 否 |
ScreenAudioParameters 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
sampleRate | int? | 否 |
channels | int? | 否 |
captureSignalVolume | int? | 否 |
ScreenCaptureConfiguration 0 方法 / 6 属性
| 属性 | 类型 | 只读 |
|---|---|---|
isCaptureWindow | bool? | 否 |
displayId | int? | 否 |
screenRect | Rectangle? | 否 |
windowId | int? | 否 |
params | ScreenCaptureParameters? | 否 |
regionRect | Rectangle? | 否 |
ScreenCaptureParameters 0 方法 / 10 属性
| 属性 | 类型 | 只读 |
|---|---|---|
dimensions | VideoDimensions? | 否 |
frameRate | int? | 否 |
bitrate | int? | 否 |
captureMouseCursor | bool? | 否 |
windowFocus | bool? | 否 |
excludeWindowList | List ? | 否 |
enableHighLight | bool? | 否 |
highLightColor | int? | 否 |
highLightWidth | int? | 否 |
excludeWindowCount | int? | 否 |
ScreenCaptureParameters2 0 方法 / 4 属性
| 属性 | 类型 | 只读 |
|---|---|---|
captureAudio | bool? | 否 |
audioParams | ScreenAudioParameters? | 否 |
captureVideo | bool? | 否 |
videoParams | ScreenVideoParameters? | 否 |
ScreenCaptureSourceInfo 0 方法 / 11 属性
| 属性 | 类型 | 只读 |
|---|---|---|
type | ScreenCaptureSourceType? | 否 |
sourceId | int? | 否 |
sourceName | String? | 否 |
thumbImage | ThumbImageBuffer? | 否 |
iconImage | ThumbImageBuffer? | 否 |
processPath | String? | 否 |
sourceTitle | String? | 否 |
primaryMonitor | bool? | 否 |
position | Rectangle? | 否 |
minimizeWindow | bool? | 否 |
sourceDisplayId | int? | 否 |
ScreenVideoParameters 0 方法 / 4 属性
| 属性 | 类型 | 只读 |
|---|---|---|
dimensions | VideoDimensions? | 否 |
frameRate | int? | 否 |
bitrate | int? | 否 |
contentHint | VideoContentHint? | 否 |
SDKBuildInfo 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
build | int? | 否 |
version | String? | 否 |
SegmentationProperty 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
modelType | SegModelType? | 否 |
greenCapacity | double? | 否 |
screenColorType | ScreenColorType? | 否 |
SimulcastStreamConfig 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
dimensions | VideoDimensions? | 否 |
kBitrate | int? | 否 |
framerate | int? | 否 |
SnapshotConfig 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
filePath | String? | 否 |
position | VideoModulePosition? | 否 |
SpatialAudioParams 0 方法 / 8 属性
| 属性 | 类型 | 只读 |
|---|---|---|
speaker_azimuth | unknown | 否 |
speaker_elevation | unknown | 否 |
speaker_distance | unknown | 否 |
speaker_orientation | unknown | 否 |
enable_blur | unknown | 否 |
enable_air_absorb | unknown | 否 |
speaker_attenuation | unknown | 否 |
enable_doppler | unknown | 否 |
SpatialAudioZone 0 方法 / 9 属性
| 属性 | 类型 | 只读 |
|---|---|---|
zoneSetId | int? | 否 |
position | List ? | 否 |
forward | List ? | 否 |
right | List ? | 否 |
up | List ? | 否 |
forwardLength | double? | 否 |
rightLength | double? | 否 |
upLength | double? | 否 |
audioAttenuation | double? | 否 |
SrcInfo 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
bitrateInKbps | int? | 否 |
name | String? | 否 |
ThumbImageBuffer 0 方法 / 4 属性
| 属性 | 类型 | 只读 |
|---|---|---|
buffer | Uint8List? | 否 |
length | int? | 否 |
width | int? | 否 |
height | int? | 否 |
TranscodingUser 0 方法 / 8 属性
| 属性 | 类型 | 只读 |
|---|---|---|
uid | int? | 否 |
x | int? | 否 |
y | int? | 否 |
width | int? | 否 |
height | int? | 否 |
zOrder | int? | 否 |
alpha | double? | 否 |
audioChannel | int? | 否 |
TranscodingVideoStream 0 方法 / 11 属性
| 属性 | 类型 | 只读 |
|---|---|---|
sourceType | VideoSourceType? | 否 |
remoteUserUid | int? | 否 |
imageUrl | String? | 否 |
mediaPlayerId | int? | 否 |
x | int? | 否 |
y | int? | 否 |
width | int? | 否 |
height | int? | 否 |
zOrder | int? | 否 |
alpha | double? | 否 |
mirror | bool? | 否 |
UplinkNetworkInfo 0 方法 / 1 属性
| 属性 | 类型 | 只读 |
|---|---|---|
videoEncoderTargetBitrateBps | int? | 否 |
UserAudioSpectrumInfo 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
uid | int? | 否 |
spectrumData | AudioSpectrumData? | 否 |
UserInfo 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
uid | int? | 否 |
userAccount | String? | 否 |
VideoCanvas 0 方法 / 12 属性
| 属性 | 类型 | 只读 |
|---|---|---|
uid | int? | 否 |
subviewUid | int? | 否 |
view | int? | 否 |
renderMode | RenderModeType? | 否 |
mirrorMode | VideoMirrorModeType? | 否 |
sourceType | VideoSourceType? | 否 |
setupMode | VideoViewSetupMode? | 否 |
mediaPlayerId | int? | 否 |
cropArea | Rectangle? | 否 |
backgroundColor | int? | 否 |
enableAlphaMask | bool? | 否 |
position | VideoModulePosition? | 否 |
VideoDenoiserOptions 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
level | VideoDenoiserLevel? | 否 |
mode | VideoDenoiserMode? | 否 |
VideoDeviceInfo 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
deviceId | String? | 否 |
deviceName | String? | 否 |
VideoDeviceManager 6 方法 / 0 属性
enumerateVideoDevices(): List
getCapability(deviceCapabilityNumber: String deviceIdUTF8,required int): Future
getDevice(): Future
numberOfCapabilities(deviceIdUTF8: String): Future
release(): Future
setDevice(deviceIdUTF8: String): Future方法明细:6 / 6(参数、返回值、错误码)
VideoDimensions 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
width | int? | 否 |
height | int? | 否 |
VideoEffectObject 9 方法 / 0 属性
addOrUpdateVideoEffect(templateName: int nodeId,required String): Future
getVideoEffectBoolParam(key: String option,required String): Future
getVideoEffectFloatParam(key: String option,required String): Future
getVideoEffectIntParam(key: String option,required String): Future
performVideoEffectAction(actionId: int nodeId,required VideoEffectAction): Future
removeVideoEffect(nodeId: int): Future
setVideoEffectBoolParam(param: String option,required String key,required bool): Future
setVideoEffectFloatParam(param: String option,required String key,required double): Future
setVideoEffectIntParam(param: String option,required String key,required int): Future方法明细:9 / 9(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
addOrUpdateVideoEffect | templateName: int nodeId,required String | Future | 错误码索引 |
getVideoEffectBoolParam | key: String option,required String | Future | 错误码索引 |
getVideoEffectFloatParam | key: String option,required String | Future | 错误码索引 |
getVideoEffectIntParam | key: String option,required String | Future | 错误码索引 |
performVideoEffectAction | actionId: int nodeId,required VideoEffectAction | Future | 错误码索引 |
removeVideoEffect | nodeId: int | Future | 错误码索引 |
setVideoEffectBoolParam | param: String option,required String key,required bool | Future | 错误码索引 |
setVideoEffectFloatParam | param: String option,required String key,required double | Future | 错误码索引 |
setVideoEffectIntParam | param: String option,required String key,required int | Future | 错误码索引 |
VideoEncodedFrameObserver 1 方法 / 0 属性
onEncodedVideoFrameReceived(channelId: String, uid: int, imageBuffer: Uint8List, length: int, videoEncodedFrameInfo: EncodedVideoFrameInfo): void方法明细:1 / 1(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
onEncodedVideoFrameReceived | channelId: String, uid: int, imageBuffer: Uint8List, length: int, videoEncodedFrameInfo: EncodedVideoFrameInfo | void | 错误码索引 |
VideoEncoderConfiguration 0 方法 / 9 属性
| 属性 | 类型 | 只读 |
|---|---|---|
dimensions | VideoDimensions? | 否 |
codecType | VideoCodecType? | 否 |
frameRate | int? | 否 |
bitrate | int? | 否 |
minBitrate | int? | 否 |
orientationMode | OrientationMode? | 否 |
degradationPreference | DegradationPreference? | 否 |
mirrorMode | VideoMirrorModeType? | 否 |
advanceOptions | AdvanceOptions? | 否 |
VideoFormat 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
width | int? | 否 |
height | int? | 否 |
fps | int? | 否 |
VideoFrame 0 方法 / 20 属性
| 属性 | 类型 | 只读 |
|---|---|---|
type | VideoPixelFormat? | 否 |
width | int? | 否 |
height | int? | 否 |
yStride | int? | 否 |
uStride | int? | 否 |
vStride | int? | 否 |
yBuffer | Uint8List? | 否 |
uBuffer | Uint8List? | 否 |
vBuffer | Uint8List? | 否 |
rotation | int? | 否 |
renderTimeMs | int? | 否 |
avsyncType | int? | 否 |
metadataBuffer | Uint8List? | 否 |
metadataSize | int? | 否 |
textureId | int? | 否 |
matrix | List ? | 否 |
colorSpace | ColorSpace? | 否 |
alphaBuffer | Uint8List? | 否 |
alphaStitchMode | AlphaStitchMode? | 否 |
metaInfo | VideoFrameMetaInfo? | 否 |
VideoFrameObserver 3 方法 / 0 属性
onCaptureVideoFrame(sourceType: VideoSourceType, videoFrame: VideoFrame): void
onPreEncodeVideoFrame(videoFrame: VideoFrame): void
onRenderVideoFrame(channelId: String, remoteUid: int, videoFrame: VideoFrame): void方法明细:3 / 3(参数、返回值、错误码)
VideoLayout 0 方法 / 8 属性
| 属性 | 类型 | 只读 |
|---|---|---|
channelId | String? | 否 |
uid | int? | 否 |
strUid | String? | 否 |
x | int? | 否 |
y | int? | 否 |
width | int? | 否 |
height | int? | 否 |
videoState | int? | 否 |
VideoRenderingTracingInfo 0 方法 / 7 属性
| 属性 | 类型 | 只读 |
|---|---|---|
elapsedTime | int? | 否 |
start2JoinChannel | int? | 否 |
join2JoinSuccess | int? | 否 |
joinSuccess2RemoteJoined | int? | 否 |
remoteJoined2SetView | int? | 否 |
remoteJoined2UnmuteVideo | int? | 否 |
remoteJoined2PacketReceived | int? | 否 |
VideoSubscriptionOptions 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
type | VideoStreamType? | 否 |
encodedFrameOnly | bool? | 否 |
VideoViewController 1 方法 / 5 属性
VideoViewControllerConstructor(rtcEngine: unknown, canvas: unknown, useFlutterTexture: unknown, FlutterTexture: unknown, useAndroidSurfaceView: unknown): unknown方法明细:1 / 1(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
VideoViewControllerConstructor | rtcEngine: unknown, canvas: unknown, useFlutterTexture: unknown, FlutterTexture: unknown, useAndroidSurfaceView: unknown | unknown | 错误码索引 |
| 属性 | 类型 | 只读 |
|---|---|---|
rtcEngine | RtcEngine | 否 |
canvas | VideoCanvas | 否 |
connection | RtcConnection | 否 |
useFlutterTexture | bool | 否 |
useAndroidSurfaceView | bool | 否 |
VideoViewControllerBase 0 方法 / 5 属性
| 属性 | 类型 | 只读 |
|---|---|---|
rtcEngine | RtcEngine get | 否 |
canvas | VideoCanvas get | 否 |
connection | RtcConnection? get | 否 |
useFlutterTexture | bool get | 否 |
useAndroidSurfaceView | bool get | 否 |
VirtualBackgroundSource 0 方法 / 4 属性
| 属性 | 类型 | 只读 |
|---|---|---|
backgroundSourceType | BackgroundSourceType? | 否 |
color | int? | 否 |
source | String? | 否 |
blurDegree | BackgroundBlurDegree? | 否 |
WatermarkBuffer 0 方法 / 5 属性
| 属性 | 类型 | 只读 |
|---|---|---|
width | int? | 否 |
height | int? | 否 |
length | int? | 否 |
format | VideoPixelFormat? | 否 |
buffer | Uint8List? | 否 |
WatermarkConfig 0 方法 / 7 属性
| 属性 | 类型 | 只读 |
|---|---|---|
id | String? | 否 |
type | WatermarkSourceType? | 否 |
buffer | WatermarkBuffer? | 否 |
timestamp | WatermarkTimestamp? | 否 |
literal | WatermarkLiteral? | 否 |
imageUrl | String? | 否 |
options | WatermarkOptions? | 否 |
WatermarkLiteral 0 方法 / 4 属性
| 属性 | 类型 | 只读 |
|---|---|---|
fontSize | int? | 否 |
strokeWidth | int? | 否 |
wmLiteral | String? | 否 |
fontFilePath | String? | 否 |
WatermarkOptions 0 方法 / 6 属性
| 属性 | 类型 | 只读 |
|---|---|---|
visibleInPreview | bool? | 否 |
positionInLandscapeMode | Rectangle? | 否 |
positionInPortraitMode | Rectangle? | 否 |
watermarkRatio | WatermarkRatio? | 否 |
mode | WatermarkFitMode? | 否 |
zOrder | int? | 否 |
WatermarkRatio 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
xRatio | double? | 否 |
yRatio | double? | 否 |
widthRatio | double? | 否 |
WatermarkTimestamp 0 方法 / 4 属性
| 属性 | 类型 | 只读 |
|---|---|---|
fontSize | int? | 否 |
fontFilePath | String? | 否 |
strokeWidth | int? | 否 |
format | String? | 否 |
枚举
| 枚举 | 成员数 | 示例值 |
|---|---|---|
AgoraPipState | 3 | pipStateStarted = null |
AlphaStitchMode | 5 | noAlphaStitch = 0 |
AreaCode | 7 | areaCodeCn = null |
AudienceLatencyLevelType | 2 | audienceLatencyLevelLowLatency = 1 |
AudioAinsMode | 3 | ainsModeBalanced = 0 |
AudioCodecProfileType | 3 | audioCodecProfileLcAac = 0 |
AudioCodecType | 8 | audioCodecOpus = 1 |
AudioDualMonoMode | 4 | audioDualMonoStereo = 0 |
AudioEffectPreset | 19 | audioEffectOff = null |
AudioEncodedFrameObserverPosition | 3 | audioEncodedFrameObserverPositionRecord = 1 |
AudioEncodingType | 11 | audioEncodingTypeAac16000Low = 65793 |
AudioEqualizationBandFrequency | 10 | audioEqualizationBand31 = 0 |
AudioFileRecordingType | 3 | audioFileRecordingMic = 1 |
AudioFrameType | 1 | frameTypePcm16 = 0 |
AudioMixingDualMonoMode | 4 | audioMixingDualMonoAuto = 0 |
AudioMixingReasonType | 7 | audioMixingReasonOk = 0 |
AudioMixingStateType | 4 | audioMixingStatePlaying = 710 |
audioprocessingchannels | 2 | audioProcessingMono = 1 |
AudioProfileType | 8 | audioProfileDefault = 0 |
audiorecordingqualitytype | 4 | audioRecordingQualityLow = 0 |
AudioReverbType | 5 | audioReverbDryLevel = 0 |
AudioRoute | 12 | routeDefault = -1 |
AudioSampleRateType | 3 | audioSampleRate32000 = 32000 |
AudioScenarioType | 7 | audioScenarioDefault = 0 |
AudioSessionOperationRestriction | 5 | audioSessionOperationRestrictionNone = 0 |
AudioSourceType | 7 | audioSourceMicrophone = 0 |
AudioTrackType | 2 | audioTrackMixable = 0 |
backgroundblurdegree | 3 | blurDegreeLow = 1 |
backgroundSourceType | 5 | backgroundNone = 0 |
CameraDirection | 2 | cameraRear = 0 |
CameraFocalLengthType | 4 | cameraFocalLengthDefault = 0 |
CameraStabilizationMode | 5 | cameraStabilizationModeOff = -1 |
CaptureBrightnessLevelType | 4 | captureBrightnessLevelInvalid = -1 |
ChannelMediaRelayError | 12 | relayOk = 0 |
ChannelMediaRelayState | 4 | relayStateIdle = 0 |
ChannelProfileType | 4 | channelProfileCommunication = 0 |
ClientRoleChangeFailedReason | 4 | clientRoleChangeFailedTooManyBroadcasters = 1 |
ClientRoleType | 2 | clientRoleBroadcaster = 1 |
CloudProxyType | 3 | noneProxy = 0 |
CodecCapMask | 5 | codecCapMaskNone = 0 |
CompressionPreference | 3 | preferCompressionAuto = -1 |
ConnectionChangedReasonType | 21 | connectionChangedConnecting = 0 |
ConnectionStateType | 5 | connectionStateDisconnected = 1 |
ContentInspectType | 3 | contentInspectInvalid = 0 |
DegradationPreference | 5 | maintainAuto = -1 |
EarMonitoringFilterType | 4 | earMonitoringFilterNone = null |
EncodingPreference | 3 | preferAuto = -1 |
EncryptionErrorType | 5 | encryptionErrorInternalFailure = 0 |
EncryptionMode | 9 | aes128Xts = 1 |
ErrorCodeType | 48 | errOk = 0 |
ExperiencePoorReason | 5 | experienceReasonNone = 0 |
ExperienceQualityType | 2 | experienceQualityGood = 0 |
ExternalVideoSourceType | 2 | videoFrame = 0 |
FaceShapeArea | 30 | faceShapeAreaNone = -1 |
FaceShapeBeautyStyle | 3 | faceShapeBeautyStyleFemale = 0 |
FeatureType | 2 | videoVirtualBackground = 1 |
FrameRate | 7 | frameRateFps1 = 1 |
HeadphoneEqualizerPreset | 3 | headphoneEqualizerOff = null |
InterfaceIdType | 7 | agoraIidAudioDeviceManager = 1 |
LastmileProbeResultState | 3 | lastmileProbeResultComplete = 1 |
LighteningContrastLevel | 3 | lighteningContrastLow = 0 |
LocalAudioStreamReason | 11 | localAudioStreamReasonOk = 0 |
LocalAudioStreamState | 4 | localAudioStreamStateStopped = 0 |
LocalProxyMode | 2 | connectivityFirst = 0 |
LocalVideoEventType | 6 | localVideoEventTypeScreenCaptureWindowHidden = 1 |
LocalVideoStreamReason | 26 | localVideoStreamReasonOk = 0 |
LocalVideoStreamState | 4 | localVideoStreamStateStopped = 0 |
LogFilterType | 6 | logFilterOff = 0 |
LogLevel | 5 | logLevelNone = 0 |
LowLightEnhanceLevel | 2 | lowLightEnhanceLevelHighQuality = 0 |
LowLightEnhanceMode | 2 | LowLightEnhanceAuto = 0 |
MaxDeviceIdLengthType | 1 | maxDeviceIdLength = null |
MaxUserAccountLengthType | 1 | maxUserAccountLength = null |
MediaDeviceStateType | 6 | mediaDeviceStateIdle = 0 |
MediaDeviceType | 8 | unknownAudioDevice = -1 |
MediaPlayerEvent | 14 | playerEventSeekBegin = 0 |
MediaPlayerMetadataType | 2 | playerMetadataTypeUnknown = 0 |
MediaPlayerReason | 17 | playerReasonNone = 0 |
MediaPlayerState | 9 | playerStateIdle = 0 |
MediaRecorderContainerFormat | 1 | formatMp4 = 1 |
MediaRecorderStreamType | 3 | streamTypeAudio = 1 |
MediaSourceType | 7 | audioPlayoutSource = 0 |
MediaStreamType | 4 | streamTypeUnknown = 0 |
MediaTraceEvent | 2 | mediaTraceEventVideoRendered = 0 |
MetadataType | 2 | unknownMetadata = -1 |
MultipathMode | 1 | duplicate = 0 |
MultipathType | 4 | lan = 0 |
MusicCacheStatusType | 2 | musicCacheStatusTypeCached = 0 |
MusicContentCenterStateReason | 8 | kMusicContentCenterReasonOk = 0 |
MusicPlayMode | 3 | kMusicPlayModeOriginal = 0 |
NetworkType | 8 | networkTypeUnknown = -1 |
OrientationMode | 3 | orientationModeAdaptive = 0 |
PermissionType | 3 | recordAudio = 0 |
PlayerPreloadEvent | 3 | playerPreloadEventBegin = 0 |
PreloadState | 4 | kPreloadStateCompleted = 0 |
ProxyType | 5 | noneProxyType = 0 |
QualityAdaptIndication | 3 | adaptNone = 0 |
QualityType | 8 | qualityUnknown = 0 |
RawAudioFrameOpModeType | 2 | rawAudioFrameOpModeReadOnly = 0 |
RecorderReasonCode | 5 | recorderReasonNone = 0 |
RecorderState | 3 | recorderStateError = -1 |
RecorderStreamType | 2 | rtc = 0 |
RemoteAudioState | 5 | remoteAudioStateStopped = 0 |
RemoteAudioStateReason | 8 | remoteAudioReasonInternal = 0 |
RemoteVideoState | 5 | remoteVideoStateStopped = 0 |
RemoteVideoStateReason | 12 | remoteVideoStateReasonInternal = 0 |
RenderModeType | 3 | renderModeHidden = 1 |
RenewTokenErrorCode | 7 | renewTokenSuccess = 0 |
RhythmPlayerReason | 5 | rhythmPlayerReasonOk = 0 |
RhythmPlayerStateType | 5 | rhythmPlayerStateIdle = 810 |
RtmpStreamingEvent | 4 | rtmpStreamingEventFailedLoadImage = 1 |
RtmpStreamLifeCycleType | 2 | rtmpStreamLifeCycleBind2channel = null |
RtmpStreamPublishReason | 16 | rtmpStreamPublishReasonOk = 0 |
RtmpStreamPublishState | 6 | rtmpStreamPublishStateIdle = 0 |
ScreenCaptureFramerateCapability | 3 | screenCaptureFramerateCapability15Fps = 0 |
ScreenCaptureSourceType | 4 | screencapturesourcetypeUnknown = -1 |
ScreenColorType | 3 | screenColorAuto = 0 |
ScreenScenarioType | 4 | screenScenarioDocument = 1 |
SegModelType | 2 | segModelAi = 1 |
SimulcastStreamMode | 3 | autoSimulcastStream = -1 |
StreamFallbackOptions | 3 | streamFallbackOptionDisabled = 0 |
StreamPublishState | 4 | pubStateIdle = 0 |
StreamSubscribeState | 4 | subStateIdle = 0 |
UserOfflineReasonType | 3 | userOfflineQuit = 0 |
VideoApplicationScenarioType | 4 | applicationScenarioGeneral = 0 |
VideoBufferType | 3 | videoBufferRawData = 1 |
VideoCodecCapabilityLevel | 5 | codecCapabilityLevelUnspecified = -1 |
VideoCodecProfileType | 3 | videoCodecProfileBaseline = 66 |
VideoCodecType | 6 | videoCodecNone = 0 |
VideoCodecTypeForStream | 2 | videoCodecH264ForStream = 1 |
VideoContentHint | 3 | contentHintNone = null |
VideoDenoiserLevel | 2 | videoDenoiserLevelHighQuality = 0 |
VideoDenoiserMode | 2 | videoDenoiserAuto = 0 |
VideoEffectAction | 2 | save = 1 |
VideoEffectNodeId | 3 | beauty = 1 |
VideoFrameProcessMode | 2 | processModeReadOnly = null |
VideoFrameType | 6 | videoFrameTypeBlankFrame = 0 |
VideoMirrorModeType | 3 | videoMirrorModeAuto = 0 |
VideoModulePosition | 4 | positionPostCapturer = 1 |
VideoOrientation | 4 | videoOrientation0 = 0 |
VideoPixelFormat | 5 | videoPixelDefault = 0 |
VideoSourceType | 19 | videoSourceCameraPrimary = 0 |
VideoStreamType | 8 | videoStreamHigh = 0 |
VideoTranscoderError | 6 | vtErrVideoSourceNotReady = 1 |
VideoViewSetupMode | 3 | videoViewSetupReplace = 0 |
VoiceAiTunerType | 10 | voiceAiTunerMatureMale = 0 |
VoiceBeautifierPreset | 14 | voiceBeautifierOff = null |
VoiceConversionPreset | 5 | voiceConversionOff = null |
WatermarkFitMode | 2 | fitModeCoverPosition = 0 |
WatermarkSourceType | 4 | image = 0 |
AgoraPipState 3 个成员
| 成员 | 值 |
|---|---|
pipStateStarted | null |
pipStateStopped | null |
pipStateFailed | null |
AlphaStitchMode 5 个成员
| 成员 | 值 |
|---|---|
noAlphaStitch | 0 |
alphaStitchUp | 1 |
alphaStitchBelow | 2 |
alphaStitchLeft | 3 |
alphaStitchRight | 4 |
AreaCode 7 个成员
| 成员 | 值 |
|---|---|
areaCodeCn | null |
areaCodeNa | null |
areaCodeEu | null |
areaCodeAs | null |
areaCodeJp | null |
areaCodeIn | null |
areaCodeGlob | null |
AudienceLatencyLevelType 2 个成员
| 成员 | 值 |
|---|---|
audienceLatencyLevelLowLatency | 1 |
audienceLatencyLevelUltraLowLatency | 2 |
AudioAinsMode 3 个成员
| 成员 | 值 |
|---|---|
ainsModeBalanced | 0 |
ainsModeAggressive | 1 |
ainsModeUltralowlatency | 2 |
AudioCodecProfileType 3 个成员
| 成员 | 值 |
|---|---|
audioCodecProfileLcAac | 0 |
audioCodecProfileHeAac | 1 |
audioCodecProfileHeAacV2 | 2 |
AudioCodecType 8 个成员
| 成员 | 值 |
|---|---|
audioCodecOpus | 1 |
audioCodecPcma | 3 |
audioCodecPcmu | 4 |
audioCodecG722 | 5 |
audioCodecAaclc | 8 |
audioCodecHeaac | 9 |
audioCodecJc1 | 10 |
audioCodecHeaac2 | 11 |
AudioDualMonoMode 4 个成员
| 成员 | 值 |
|---|---|
audioDualMonoStereo | 0 |
audioDualMonoL | 1 |
audioDualMonoR | 2 |
audioDualMonoMix | 3 |
AudioEffectPreset 19 个成员
| 成员 | 值 |
|---|---|
audioEffectOff | null |
roomAcousticsVocalConcert | null |
roomAcousticsStudio | null |
roomAcousticsPhonograph | null |
roomAcousticsVirtualStereo | null |
roomAcousticsSpacial | null |
roomAcousticsEthereal | null |
roomAcousticsVirtualSurroundSound | null |
roomAcousticsChorus | null |
roomAcoustics3dVoice | null |
voiceChangerEffectUncle | null |
voiceChangerEffectOldman | null |
voiceChangerEffectBoy | null |
voiceChangerEffectSister | null |
voiceChangerEffectGirl | null |
voiceChangerEffectPigking | null |
voiceChangerEffectHulk | null |
styleTransformationPopular | null |
pitchCorrection | null |
AudioEncodedFrameObserverPosition 3 个成员
| 成员 | 值 |
|---|---|
audioEncodedFrameObserverPositionRecord | 1 |
audioEncodedFrameObserverPositionPlayback | 2 |
audioEncodedFrameObserverPositionMixed | 3 |
AudioEncodingType 11 个成员
| 成员 | 值 |
|---|---|
audioEncodingTypeAac16000Low | 65793 |
audioEncodingTypeAac16000Medium | 65794 |
audioEncodingTypeAac32000Low | 66049 |
audioEncodingTypeAac32000Medium | 66050 |
audioEncodingTypeAac32000High | 66051 |
audioEncodingTypeAac48000Medium | 66306 |
audioEncodingTypeAac48000High | 66307 |
audioEncodingTypeOpus16000Low | 131329 |
audioEncodingTypeOpus16000Medium | 131330 |
audioEncodingTypeOpus48000Medium | 131842 |
audioEncodingTypeOpus48000High | 131843 |
AudioEqualizationBandFrequency 10 个成员
| 成员 | 值 |
|---|---|
audioEqualizationBand31 | 0 |
audioEqualizationBand62 | 1 |
audioEqualizationBand125 | 2 |
audioEqualizationBand250 | 3 |
audioEqualizationBand500 | 4 |
audioEqualizationBand1k | 5 |
audioEqualizationBand2k | 6 |
audioEqualizationBand4k | 7 |
audioEqualizationBand8k | 8 |
audioEqualizationBand16k | 9 |
AudioFileRecordingType 3 个成员
| 成员 | 值 |
|---|---|
audioFileRecordingMic | 1 |
audioFileRecordingPlayback | 2 |
audioFileRecordingMixed | 3 |
AudioFrameType 1 个成员
| 成员 | 值 |
|---|---|
frameTypePcm16 | 0 |
AudioMixingDualMonoMode 4 个成员
| 成员 | 值 |
|---|---|
audioMixingDualMonoAuto | 0 |
audioMixingDualMonoL | 1 |
audioMixingDualMonoR | 2 |
audioMixingDualMonoMix | 3 |
AudioMixingReasonType 7 个成员
| 成员 | 值 |
|---|---|
audioMixingReasonOk | 0 |
audioMixingReasonCanNotOpen | 701 |
audioMixingReasonTooFrequentCall | 702 |
audioMixingReasonInterruptedEof | 703 |
audioMixingReasonOneLoopCompleted | 721 |
audioMixingReasonAllLoopsCompleted | 723 |
audioMixingReasonStoppedByUser | 724 |
AudioMixingStateType 4 个成员
| 成员 | 值 |
|---|---|
audioMixingStatePlaying | 710 |
audioMixingStatePaused | 711 |
audioMixingStateStopped | 713 |
audioMixingStateFailed | 714 |
audioprocessingchannels 2 个成员
| 成员 | 值 |
|---|---|
audioProcessingMono | 1 |
audioProcessingStereo | 2 |
AudioProfileType 8 个成员
| 成员 | 值 |
|---|---|
audioProfileDefault | 0 |
audioProfileSpeechStandard | 1 |
audioProfileMusicStandard | 2 |
audioProfileMusicStandardStereo | 3 |
audioProfileMusicHighQuality | 4 |
audioProfileMusicHighQualityStereo | 5 |
audioProfileIot | 6 |
audioProfileNum | null |
audiorecordingqualitytype 4 个成员
| 成员 | 值 |
|---|---|
audioRecordingQualityLow | 0 |
audioRecordingQualityMedium | 1 |
audioRecordingQualityHigh | 2 |
audioRecordingQualityUltraHigh | 3 |
AudioReverbType 5 个成员
| 成员 | 值 |
|---|---|
audioReverbDryLevel | 0 |
audioReverbWetLevel | 1 |
audioReverbRoomSize | 2 |
audioReverbWetDelay | 3 |
audioReverbStrength | 4 |
AudioRoute 12 个成员
| 成员 | 值 |
|---|---|
routeDefault | -1 |
routeHeadset | 0 |
routeEarpiece | 1 |
routeHeadsetnomic | 2 |
routeSpeakerphone | 3 |
routeLoudspeaker | 4 |
routeHeadsetbluetooth | 5 |
routeUsb | 6 |
routeHdmi | 7 |
routeDisplayport | 8 |
routeAirplay | 9 |
routeBluetoothSpeaker | 10 |
AudioSampleRateType 3 个成员
| 成员 | 值 |
|---|---|
audioSampleRate32000 | 32000 |
audioSampleRate44100 | 44100 |
audioSampleRate48000 | 48000 |
AudioScenarioType 7 个成员
| 成员 | 值 |
|---|---|
audioScenarioDefault | 0 |
audioScenarioGameStreaming | 3 |
audioScenarioChatroom | 5 |
audioScenarioChorus | 7 |
audioScenarioMeeting | 8 |
audioScenarioAiClient | 10 |
audioScenarioNum | null |
AudioSessionOperationRestriction 5 个成员
| 成员 | 值 |
|---|---|
audioSessionOperationRestrictionNone | 0 |
audioSessionOperationRestrictionSetCategory | 1 |
audioSessionOperationRestrictionConfigureSession | 2 |
audioSessionOperationRestrictionDeactivateSession | 4 |
audioSessionOperationRestrictionAll | 128 |
AudioSourceType 7 个成员
| 成员 | 值 |
|---|---|
audioSourceMicrophone | 0 |
audioSourceCustom | 1 |
audioSourceMediaPlayer | 2 |
audioSourceLoopbackRecording | 3 |
audioSourceRemoteUser | 5 |
audioSourceRemoteChannel | 6 |
audioSourceUnknown | 100 |
AudioTrackType 2 个成员
| 成员 | 值 |
|---|---|
audioTrackMixable | 0 |
audioTrackDirect | 1 |
backgroundblurdegree 3 个成员
| 成员 | 值 |
|---|---|
blurDegreeLow | 1 |
blurDegreeMedium | 2 |
blurDegreeHigh | 3 |
backgroundSourceType 5 个成员
| 成员 | 值 |
|---|---|
backgroundNone | 0 |
backgroundColor | 1 |
backgroundImg | 2 |
backgroundBlur | 3 |
backgroundVideo | 4 |
CameraDirection 2 个成员
| 成员 | 值 |
|---|---|
cameraRear | 0 |
cameraFront | 1 |
CameraFocalLengthType 4 个成员
| 成员 | 值 |
|---|---|
cameraFocalLengthDefault | 0 |
cameraFocalLengthWideAngle | 1 |
cameraFocalLengthUltraWide | 2 |
cameraFocalLengthTelephoto | 3 |
CameraStabilizationMode 5 个成员
| 成员 | 值 |
|---|---|
cameraStabilizationModeOff | -1 |
cameraStabilizationModeAuto | 0 |
cameraStabilizationModeLevel1 | 1 |
cameraStabilizationModeLevel2 | 2 |
cameraStabilizationModeLevel3 | 3 |
CaptureBrightnessLevelType 4 个成员
| 成员 | 值 |
|---|---|
captureBrightnessLevelInvalid | -1 |
captureBrightnessLevelNormal | 0 |
captureBrightnessLevelBright | 1 |
captureBrightnessLevelDark | 2 |
ChannelMediaRelayError 12 个成员
| 成员 | 值 |
|---|---|
relayOk | 0 |
relayErrorServerErrorResponse | 1 |
relayErrorServerNoResponse | 2 |
relayErrorNoResourceAvailable | 3 |
relayErrorFailedJoinSrc | 4 |
relayErrorFailedJoinDest | 5 |
relayErrorFailedPacketReceivedFromSrc | 6 |
relayErrorFailedPacketSentToDest | 7 |
relayErrorServerConnectionLost | 8 |
relayErrorInternalError | 9 |
relayErrorSrcTokenExpired | 10 |
relayErrorDestTokenExpired | 11 |
ChannelMediaRelayState 4 个成员
| 成员 | 值 |
|---|---|
relayStateIdle | 0 |
relayStateConnecting | 1 |
relayStateRunning | 2 |
relayStateFailure | 3 |
ChannelProfileType 4 个成员
| 成员 | 值 |
|---|---|
channelProfileCommunication | 0 |
channelProfileLiveBroadcasting | 1 |
channelProfileGame | 2 |
channelProfileCloudGaming | 3 |
ClientRoleChangeFailedReason 4 个成员
| 成员 | 值 |
|---|---|
clientRoleChangeFailedTooManyBroadcasters | 1 |
clientRoleChangeFailedNotAuthorized | 2 |
clientRoleChangeFailedRequestTimeOut | 3 |
clientRoleChangeFailedConnectionFailed | 4 |
ClientRoleType 2 个成员
| 成员 | 值 |
|---|---|
clientRoleBroadcaster | 1 |
clientRoleAudience | 2 |
CloudProxyType 3 个成员
| 成员 | 值 |
|---|---|
noneProxy | 0 |
udpProxy | 1 |
tcpProxy | 2 |
CodecCapMask 5 个成员
| 成员 | 值 |
|---|---|
codecCapMaskNone | 0 |
codecCapMaskHwDec | null |
codecCapMaskHwEnc | null |
codecCapMaskSwDec | null |
codecCapMaskSwEnc | null |
CompressionPreference 3 个成员
| 成员 | 值 |
|---|---|
preferCompressionAuto | -1 |
preferLowLatency | 0 |
preferQuality | 1 |
ConnectionChangedReasonType 21 个成员
| 成员 | 值 |
|---|---|
connectionChangedConnecting | 0 |
connectionChangedJoinSuccess | 1 |
connectionChangedInterrupted | 2 |
connectionChangedBannedByServer | 3 |
connectionChangedJoinFailed | 4 |
connectionChangedLeaveChannel | 5 |
connectionChangedInvalidAppId | 6 |
connectionChangedInvalidChannelName | 7 |
connectionChangedInvalidToken | 8 |
connectionChangedTokenExpired | 9 |
connectionChangedRejectedByServer | 10 |
connectionChangedSettingProxyServer | 11 |
connectionChangedRenewToken | 12 |
connectionChangedClientIpAddressChanged | 13 |
connectionChangedKeepAliveTimeout | 14 |
connectionChangedRejoinSuccess | 15 |
connectionChangedLost | 16 |
connectionChangedEchoTest | 17 |
connectionChangedClientIpAddressChangedByUser | 18 |
connectionChangedSameUidLogin | 19 |
connectionChangedTooManyBroadcasters | 20 |
ConnectionStateType 5 个成员
| 成员 | 值 |
|---|---|
connectionStateDisconnected | 1 |
connectionStateConnecting | 2 |
connectionStateConnected | 3 |
connectionStateReconnecting | 4 |
connectionStateFailed | 5 |
ContentInspectType 3 个成员
| 成员 | 值 |
|---|---|
contentInspectInvalid | 0 |
contentInspectSupervision | 2 |
contentInspectImageModeration | 3 |
DegradationPreference 5 个成员
| 成员 | 值 |
|---|---|
maintainAuto | -1 |
maintainQuality | 0 |
maintainFramerate | 1 |
maintainBalanced | 2 |
maintainResolution | 3 |
EarMonitoringFilterType 4 个成员
| 成员 | 值 |
|---|---|
earMonitoringFilterNone | null |
earMonitoringFilterBuiltInAudioFilters | null |
earMonitoringFilterNoiseSuppression | null |
earMonitoringFilterReusePostProcessingFilter | null |
EncodingPreference 3 个成员
| 成员 | 值 |
|---|---|
preferAuto | -1 |
preferSoftware | 0 |
preferHardware | 1 |
EncryptionErrorType 5 个成员
| 成员 | 值 |
|---|---|
encryptionErrorInternalFailure | 0 |
encryptionErrorDecryptionFailure | 1 |
encryptionErrorEncryptionFailure | 2 |
encryptionErrorDatastreamDecryptionFailure | 3 |
encryptionErrorDatastreamEncryptionFailure | 4 |
EncryptionMode 9 个成员
| 成员 | 值 |
|---|---|
aes128Xts | 1 |
aes128Ecb | 2 |
aes256Xts | 3 |
sm4128Ecb | 4 |
aes128Gcm | 5 |
aes256Gcm | 6 |
aes128Gcm2 | 7 |
aes256Gcm2 | 8 |
modeEnd | null |
ErrorCodeType 48 个成员
| 成员 | 值 |
|---|---|
errOk | 0 |
errFailed | 1 |
errInvalidArgument | 2 |
errNotReady | 3 |
RtcEngine | null |
errNotSupported | 4 |
errRefused | 5 |
errBufferTooSmall | 6 |
errNotInitialized | 7 |
errInvalidState | 8 |
errNoPermission | 9 |
errTimedout | 10 |
errJoinChannelRejected | 17 |
errLeaveChannelRejected | 18 |
errAlreadyInUse | 19 |
errAborted | 20 |
errInitNetEngine | 21 |
errResourceLimited | 22 |
errInvalidAppId | 101 |
errInvalidChannelName | 102 |
errNoServerResources | 103 |
errTokenExpired | 109 |
errInvalidToken | null |
errConnectionInterrupted | 111 |
errConnectionLost | 112 |
errNotInChannel | 113 |
errSizeTooLarge | 114 |
errBitrateLimit | 115 |
errTooManyDataStreams | 116 |
errStreamMessageTimeout | 117 |
errSetClientRoleNotAuthorized | 119 |
errDecryptionFailed | 120 |
errInvalidUserId | 121 |
errDatastreamDecryptionFailed | 122 |
errClientIsBannedByServer | 123 |
errEncryptedStreamNotAllowedPublish | 130 |
errInvalidUserAccount | 134 |
errPcmsendFormat | 200 |
errPcmsendBufferoverflow | 201 |
errLoadMediaEngine | 1001 |
errAdmGeneralError | 1005 |
errAdmInitPlayout | 1008 |
errAdmStartPlayout | 1009 |
errAdmStopPlayout | 1010 |
errAdmInitRecording | 1011 |
errAdmStartRecording | 1012 |
errAdmStopRecording | 1013 |
errVdmCameraNotAuthorized | 1501 |
ExperiencePoorReason 5 个成员
| 成员 | 值 |
|---|---|
experienceReasonNone | 0 |
remoteNetworkQualityPoor | 1 |
localNetworkQualityPoor | 2 |
wirelessSignalPoor | 4 |
wifiBluetoothCoexist | 8 |
ExperienceQualityType 2 个成员
| 成员 | 值 |
|---|---|
experienceQualityGood | 0 |
experienceQualityBad | 1 |
ExternalVideoSourceType 2 个成员
| 成员 | 值 |
|---|---|
videoFrame | 0 |
encodedVideoFrame | 1 |
FaceShapeArea 30 个成员
| 成员 | 值 |
|---|---|
faceShapeAreaNone | -1 |
faceShapeAreaHeadscale | 100 |
faceShapeAreaForehead | 101 |
faceShapeAreaFacecontour | 102 |
faceShapeAreaFacelength | 103 |
faceShapeAreaFacewidth | 104 |
faceShapeAreaCheekbone | 105 |
faceShapeAreaCheek | 106 |
faceShapeAreaMandible | 107 |
faceShapeAreaChin | 108 |
faceShapeAreaEyescale | 200 |
faceShapeAreaEyedistance | 201 |
faceShapeAreaEyeposition | 202 |
faceShapeAreaLowereyelid | 203 |
faceShapeAreaEyepupils | 204 |
faceShapeAreaEyeinnercorner | 205 |
faceShapeAreaEyeoutercorner | 206 |
faceShapeAreaNoselength | 300 |
faceShapeAreaNosewidth | 301 |
faceShapeAreaNosewing | 302 |
faceShapeAreaNoseroot | 303 |
faceShapeAreaNosebridge | 304 |
faceShapeAreaNosetip | 305 |
faceShapeAreaNosegeneral | 306 |
faceShapeAreaMouthscale | 400 |
faceShapeAreaMouthposition | 401 |
faceShapeAreaMouthsmile | 402 |
faceShapeAreaMouthlip | 403 |
faceShapeAreaEyebrowposition | 500 |
faceShapeAreaEyebrowthickness | 501 |
FaceShapeBeautyStyle 3 个成员
| 成员 | 值 |
|---|---|
faceShapeBeautyStyleFemale | 0 |
faceShapeBeautyStyleMale | 1 |
faceShapeBeautyStyleNatural | 2 |
FeatureType 2 个成员
| 成员 | 值 |
|---|---|
videoVirtualBackground | 1 |
videoBeautyEffect | 2 |
FrameRate 7 个成员
| 成员 | 值 |
|---|---|
frameRateFps1 | 1 |
frameRateFps7 | 7 |
frameRateFps10 | 10 |
frameRateFps15 | 15 |
frameRateFps24 | 24 |
frameRateFps30 | 30 |
frameRateFps60 | 60 |
HeadphoneEqualizerPreset 3 个成员
| 成员 | 值 |
|---|---|
headphoneEqualizerOff | null |
headphoneEqualizerOverear | null |
headphoneEqualizerInear | null |
InterfaceIdType 7 个成员
| 成员 | 值 |
|---|---|
agoraIidAudioDeviceManager | 1 |
agoraIidVideoDeviceManager | 2 |
agoraIidParameterEngine | 3 |
agoraIidMediaEngine | 4 |
agoraIidSignalingEngine | 8 |
agoraIidLocalSpatialAudio | 11 |
agoraIidMusicContentCenter | 15 |
LastmileProbeResultState 3 个成员
| 成员 | 值 |
|---|---|
lastmileProbeResultComplete | 1 |
lastmileProbeResultIncompleteNoBwe | 2 |
lastmileProbeResultUnavailable | 3 |
LighteningContrastLevel 3 个成员
| 成员 | 值 |
|---|---|
lighteningContrastLow | 0 |
lighteningContrastNormal | 1 |
lighteningContrastHigh | 2 |
LocalAudioStreamReason 11 个成员
| 成员 | 值 |
|---|---|
localAudioStreamReasonOk | 0 |
localAudioStreamReasonFailure | 1 |
localAudioStreamReasonDeviceNoPermission | 2 |
localAudioStreamReasonDeviceBusy | 3 |
localAudioStreamReasonRecordFailure | 4 |
localAudioStreamReasonEncodeFailure | 5 |
localAudioStreamReasonNoRecordingDevice | 6 |
localAudioStreamReasonNoPlayoutDevice | 7 |
localAudioStreamReasonInterrupted | 8 |
localAudioStreamReasonRecordInvalidId | 9 |
localAudioStreamReasonPlayoutInvalidId | 10 |
LocalAudioStreamState 4 个成员
| 成员 | 值 |
|---|---|
localAudioStreamStateStopped | 0 |
localAudioStreamStateRecording | 1 |
localAudioStreamStateEncoding | 2 |
localAudioStreamStateFailed | 3 |
LocalProxyMode 2 个成员
| 成员 | 值 |
|---|---|
connectivityFirst | 0 |
localOnly | 1 |
LocalVideoEventType 6 个成员
| 成员 | 值 |
|---|---|
localVideoEventTypeScreenCaptureWindowHidden | 1 |
localVideoEventTypeScreenCaptureWindowRecoverFromHidden | 2 |
localVideoEventTypeScreenCaptureStoppedByUser | 3 |
localVideoEventTypeScreenCaptureSystemInternalError | 4 |
localVideoEventTypeCameraFocalLengthApplied | 5 |
localVideoEventTypeCameraFocalLengthFallbackToDefault | 6 |
LocalVideoStreamReason 26 个成员
| 成员 | 值 |
|---|---|
localVideoStreamReasonOk | 0 |
localVideoStreamReasonFailure | 1 |
localVideoStreamReasonDeviceNoPermission | 2 |
localVideoStreamReasonDeviceBusy | 3 |
localVideoStreamReasonCaptureFailure | 4 |
localVideoStreamReasonCodecNotSupport | 5 |
localVideoStreamReasonCaptureInbackground | 6 |
localVideoStreamReasonCaptureMultipleForegroundApps | 7 |
localVideoStreamReasonDeviceNotFound | 8 |
localVideoStreamReasonDeviceDisconnected | 9 |
localVideoStreamReasonDeviceInvalidId | 10 |
localVideoStreamReasonScreenCaptureWindowMinimized | 11 |
localVideoStreamReasonScreenCaptureWindowClosed | 12 |
localVideoStreamReasonScreenCaptureWindowOccluded | 13 |
localVideoStreamReasonDeviceInterrupt | 14 |
localVideoStreamReasonDeviceFatalError | 15 |
localVideoStreamReasonScreenCaptureFailure | 21 |
localVideoStreamReasonScreenCaptureNoPermission | 22 |
localVideoStreamReasonScreenCaptureAutoFallback | 24 |
localVideoStreamReasonScreenCaptureWindowHidden | 25 |
localVideoStreamReasonScreenCaptureWindowRecoverFromHidden | 26 |
localVideoStreamReasonScreenCaptureWindowRecoverFromMinimized | 27 |
localVideoStreamReasonScreenCapturePaused | 28 |
localVideoStreamReasonScreenCaptureResumed | 29 |
localVideoStreamReasonScreenCaptureDisplayDisconnected | 30 |
localVideoStreamReasonDeviceSystemPressure | 101 |
LocalVideoStreamState 4 个成员
| 成员 | 值 |
|---|---|
localVideoStreamStateStopped | 0 |
localVideoStreamStateCapturing | 1 |
localVideoStreamStateEncoding | 2 |
localVideoStreamStateFailed | 3 |
LogFilterType 6 个成员
| 成员 | 值 |
|---|---|
logFilterOff | 0 |
logFilterDebug | 2063 |
logFilterInfo | 15 |
logFilterWarn | 14 |
logFilterError | 12 |
logFilterCritical | 8 |
LogLevel 5 个成员
| 成员 | 值 |
|---|---|
logLevelNone | 0 |
logLevelInfo | 1 |
logLevelWarn | 2 |
logLevelError | 4 |
logLevelFatal | 8 |
LowLightEnhanceLevel 2 个成员
| 成员 | 值 |
|---|---|
lowLightEnhanceLevelHighQuality | 0 |
lowLightEnhanceLevelFast | 1 |
LowLightEnhanceMode 2 个成员
| 成员 | 值 |
|---|---|
LowLightEnhanceAuto | 0 |
LowLightEnhanceManual | 1 |
MaxDeviceIdLengthType 1 个成员
| 成员 | 值 |
|---|---|
maxDeviceIdLength | null |
MaxUserAccountLengthType 1 个成员
| 成员 | 值 |
|---|---|
maxUserAccountLength | null |
MediaDeviceStateType 6 个成员
| 成员 | 值 |
|---|---|
mediaDeviceStateIdle | 0 |
mediaDeviceStateActive | 1 |
mediaDeviceStateDisabled | 2 |
mediaDeviceStatePluggedIn | 3 |
mediaDeviceStateNotPresent | 4 |
mediaDeviceStateUnplugged | 8 |
MediaDeviceType 8 个成员
| 成员 | 值 |
|---|---|
unknownAudioDevice | -1 |
audioPlayoutDevice | 0 |
audioRecordingDevice | 1 |
videoRenderDevice | 2 |
videoCaptureDevice | 3 |
audioApplicationPlayoutDevice | 4 |
audioVirtualPlayoutDevice | null |
audioVirtualRecordingDevice | null |
MediaPlayerEvent 14 个成员
| 成员 | 值 |
|---|---|
playerEventSeekBegin | 0 |
playerEventSeekComplete | 1 |
playerEventSeekError | 2 |
playerEventAudioTrackChanged | 5 |
playerEventBufferLow | 6 |
playerEventBufferRecover | 7 |
playerEventFreezeStart | 8 |
playerEventFreezeStop | 9 |
playerEventSwitchBegin | 10 |
playerEventSwitchComplete | 11 |
playerEventSwitchError | 12 |
playerEventFirstDisplayed | 13 |
playerEventReachCacheFileMaxCount | 14 |
playerEventReachCacheFileMaxSize | 15 |
MediaPlayerMetadataType 2 个成员
| 成员 | 值 |
|---|---|
playerMetadataTypeUnknown | 0 |
playerMetadataTypeSei | 1 |
MediaPlayerReason 17 个成员
| 成员 | 值 |
|---|---|
playerReasonNone | 0 |
playerReasonInvalidArguments | -1 |
playerReasonInternal | -2 |
playerReasonNoResource | -3 |
playerReasonInvalidMediaSource | -4 |
playerReasonUnknownStreamType | -5 |
playerReasonObjNotInitialized | -6 |
playerReasonCodecNotSupported | -7 |
playerReasonVideoRenderFailed | -8 |
playerReasonInvalidState | -9 |
playerReasonUrlNotFound | -10 |
playerReasonInvalidConnectionState | -11 |
playerReasonSrcBufferUnderflow | -12 |
playerReasonInterrupted | -13 |
playerReasonNotSupported | -14 |
playerReasonTokenExpired | -15 |
playerReasonUnknown | -17 |
MediaPlayerState 9 个成员
| 成员 | 值 |
|---|---|
playerStateIdle | 0 |
playerStateOpening | 1 |
playerStateOpenCompleted | 2 |
playerStatePlaying | 3 |
playerStatePaused | 4 |
playerStatePlaybackCompleted | 5 |
playerStatePlaybackAllLoopsCompleted | 6 |
playerStateStopped | 7 |
playerStateFailed | 100 |
MediaRecorderContainerFormat 1 个成员
| 成员 | 值 |
|---|---|
formatMp4 | 1 |
MediaRecorderStreamType 3 个成员
| 成员 | 值 |
|---|---|
streamTypeAudio | 1 |
streamTypeVideo | 2 |
streamTypeBoth | 3 |
MediaSourceType 7 个成员
| 成员 | 值 |
|---|---|
audioPlayoutSource | 0 |
audioRecordingSource | 1 |
primaryCameraSource | 2 |
secondaryCameraSource | 3 |
customVideoSource | 6 |
speechDrivenVideoSource | 13 |
unknownMediaSource | 100 |
MediaStreamType 4 个成员
| 成员 | 值 |
|---|---|
streamTypeUnknown | 0 |
streamTypeVideo | 1 |
streamTypeAudio | 2 |
streamTypeSubtitle | 3 |
MediaTraceEvent 2 个成员
| 成员 | 值 |
|---|---|
mediaTraceEventVideoRendered | 0 |
mediaTraceEventVideoDecoded | 1 |
MetadataType 2 个成员
| 成员 | 值 |
|---|---|
unknownMetadata | -1 |
videoMetadata | 0 |
MultipathMode 1 个成员
| 成员 | 值 |
|---|---|
duplicate | 0 |
MultipathType 4 个成员
| 成员 | 值 |
|---|---|
lan | 0 |
wifi | 1 |
mobile | 2 |
unknown | 99 |
MusicCacheStatusType 2 个成员
| 成员 | 值 |
|---|---|
musicCacheStatusTypeCached | 0 |
musicCacheStatusTypeCaching | 1 |
MusicContentCenterStateReason 8 个成员
| 成员 | 值 |
|---|---|
kMusicContentCenterReasonOk | 0 |
kMusicContentCenterReasonError | 1 |
kMusicContentCenterReasonGateway | 2 |
kMusicContentCenterReasonPermissionAndResource | 3 |
kMusicContentCenterReasonInternalDataParse | 4 |
kMusicContentCenterReasonMusicLoading | 5 |
kMusicContentCenterReasonMusicDecryption | 6 |
kMusicContentCenterReasonHttpInternalError | 7 |
MusicPlayMode 3 个成员
| 成员 | 值 |
|---|---|
kMusicPlayModeOriginal | 0 |
kMusicPlayModeAccompany | 1 |
kMusicPlayModeLeadSing | 2 |
NetworkType 8 个成员
| 成员 | 值 |
|---|---|
networkTypeUnknown | -1 |
networkTypeDisconnected | 0 |
networkTypeLan | 1 |
networkTypeWifi | 2 |
networkTypeMobile2g | 3 |
networkTypeMobile3g | 4 |
networkTypeMobile4g | 5 |
networkTypeMobile5g | 6 |
OrientationMode 3 个成员
| 成员 | 值 |
|---|---|
orientationModeAdaptive | 0 |
orientationModeFixedLandscape | 1 |
orientationModeFixedPortrait | 2 |
PermissionType 3 个成员
| 成员 | 值 |
|---|---|
recordAudio | 0 |
camera | 1 |
screenCapture | null |
PlayerPreloadEvent 3 个成员
| 成员 | 值 |
|---|---|
playerPreloadEventBegin | 0 |
playerPreloadEventComplete | 1 |
playerPreloadEventError | 2 |
PreloadState 4 个成员
| 成员 | 值 |
|---|---|
kPreloadStateCompleted | 0 |
kPreloadStateFailed | 1 |
kPreloadStatePreloading | 2 |
kPreloadStateRemoved | 3 |
ProxyType 5 个成员
| 成员 | 值 |
|---|---|
noneProxyType | 0 |
udpProxyType | 1 |
tcpProxyType | 2 |
localProxyType | 3 |
tcpProxyAutoFallbackType | 4 |
QualityAdaptIndication 3 个成员
| 成员 | 值 |
|---|---|
adaptNone | 0 |
adaptUpBandwidth | 1 |
adaptDownBandwidth | 2 |
QualityType 8 个成员
| 成员 | 值 |
|---|---|
qualityUnknown | 0 |
qualityExcellent | 1 |
qualityGood | 2 |
qualityPoor | 3 |
qualityBad | 4 |
qualityVbad | 5 |
qualityDown | 6 |
qualityDetecting | 8 |
RawAudioFrameOpModeType 2 个成员
| 成员 | 值 |
|---|---|
rawAudioFrameOpModeReadOnly | 0 |
rawAudioFrameOpModeReadWrite | 2 |
RecorderReasonCode 5 个成员
| 成员 | 值 |
|---|---|
recorderReasonNone | 0 |
recorderReasonWriteFailed | 1 |
recorderReasonNoStream | 2 |
recorderReasonOverMaxDuration | 3 |
recorderReasonConfigChanged | 4 |
RecorderState 3 个成员
| 成员 | 值 |
|---|---|
recorderStateError | -1 |
recorderStateStart | 2 |
recorderStateStop | 3 |
RecorderStreamType 2 个成员
| 成员 | 值 |
|---|---|
rtc | 0 |
preview | 1 |
RemoteAudioState 5 个成员
| 成员 | 值 |
|---|---|
remoteAudioStateStopped | 0 |
remoteAudioStateStarting | 1 |
remoteAudioStateDecoding | 2 |
remoteAudioStateFrozen | 3 |
remoteAudioStateFailed | 4 |
RemoteAudioStateReason 8 个成员
| 成员 | 值 |
|---|---|
remoteAudioReasonInternal | 0 |
remoteAudioReasonNetworkCongestion | 1 |
remoteAudioReasonNetworkRecovery | 2 |
remoteAudioReasonLocalMuted | 3 |
remoteAudioReasonLocalUnmuted | 4 |
remoteAudioReasonRemoteMuted | 5 |
remoteAudioReasonRemoteUnmuted | 6 |
remoteAudioReasonRemoteOffline | 7 |
RemoteVideoState 5 个成员
| 成员 | 值 |
|---|---|
remoteVideoStateStopped | 0 |
remoteVideoStateStarting | 1 |
remoteVideoStateDecoding | 2 |
remoteVideoStateFrozen | 3 |
remoteVideoStateFailed | 4 |
RemoteVideoStateReason 12 个成员
| 成员 | 值 |
|---|---|
remoteVideoStateReasonInternal | 0 |
remoteVideoStateReasonNetworkCongestion | 1 |
remoteVideoStateReasonNetworkRecovery | 2 |
remoteVideoStateReasonLocalMuted | 3 |
remoteVideoStateReasonLocalUnmuted | 4 |
remoteVideoStateReasonRemoteMuted | 5 |
remoteVideoStateReasonRemoteUnmuted | 6 |
remoteVideoStateReasonRemoteOffline | 7 |
remoteVideoStateReasonAudioFallback | 8 |
remoteVideoStateReasonAudioFallbackRecovery | 9 |
remoteVideoStateReasonSdkInBackground | 12 |
remoteVideoStateReasonCodecNotSupport | 13 |
RenderModeType 3 个成员
| 成员 | 值 |
|---|---|
renderModeHidden | 1 |
renderModeFit | 2 |
renderModeAdaptive | 3 |
RenewTokenErrorCode 7 个成员
| 成员 | 值 |
|---|---|
renewTokenSuccess | 0 |
renewTokenFailure | 1 |
renewTokenTokenExpired | 2 |
renewTokenInvalidToken | 3 |
renewTokenInvalidChannelName | 4 |
renewTokenInconsistentAppid | 5 |
renewTokenCanceledByNewRequest | 6 |
RhythmPlayerReason 5 个成员
| 成员 | 值 |
|---|---|
rhythmPlayerReasonOk | 0 |
rhythmPlayerReasonFailed | 1 |
rhythmPlayerReasonCanNotOpen | 801 |
rhythmPlayerReasonCanNotPlay | 802 |
rhythmPlayerReasonFileOverDurationLimit | 803 |
RhythmPlayerStateType 5 个成员
| 成员 | 值 |
|---|---|
rhythmPlayerStateIdle | 810 |
rhythmPlayerStateOpening | 811 |
rhythmPlayerStateDecoding | 812 |
rhythmPlayerStatePlaying | 813 |
rhythmPlayerStateFailed | 814 |
RtmpStreamingEvent 4 个成员
| 成员 | 值 |
|---|---|
rtmpStreamingEventFailedLoadImage | 1 |
rtmpStreamingEventUrlAlreadyInUse | 2 |
rtmpStreamingEventAdvancedFeatureNotSupport | 3 |
rtmpStreamingEventRequestTooOften | 4 |
RtmpStreamLifeCycleType 2 个成员
| 成员 | 值 |
|---|---|
rtmpStreamLifeCycleBind2channel | null |
rtmpStreamLifeCycleBind2owner | null |
RtmpStreamPublishReason 16 个成员
| 成员 | 值 |
|---|---|
rtmpStreamPublishReasonOk | 0 |
rtmpStreamPublishReasonInvalidArgument | 1 |
rtmpStreamPublishReasonEncryptedStreamNotAllowed | 2 |
rtmpStreamPublishReasonConnectionTimeout | 3 |
rtmpStreamPublishReasonInternalServerError | 4 |
rtmpStreamPublishReasonRtmpServerError | 5 |
rtmpStreamPublishReasonTooOften | 6 |
rtmpStreamPublishReasonReachLimit | 7 |
rtmpStreamPublishReasonNotAuthorized | 8 |
rtmpStreamPublishReasonStreamNotFound | 9 |
rtmpStreamPublishReasonFormatNotSupported | 10 |
rtmpStreamPublishReasonNotBroadcaster | 11 |
rtmpStreamPublishReasonTranscodingNoMixStream | 13 |
rtmpStreamPublishReasonNetDown | 14 |
rtmpStreamPublishReasonInvalidPrivilege | 16 |
rtmpStreamUnpublishReasonOk | 100 |
RtmpStreamPublishState 6 个成员
| 成员 | 值 |
|---|---|
rtmpStreamPublishStateIdle | 0 |
rtmpStreamPublishStateConnecting | 1 |
rtmpStreamPublishStateRunning | 2 |
rtmpStreamPublishStateRecovering | 3 |
rtmpStreamPublishStateFailure | 4 |
rtmpStreamPublishStateDisconnecting | 5 |
ScreenCaptureFramerateCapability 3 个成员
| 成员 | 值 |
|---|---|
screenCaptureFramerateCapability15Fps | 0 |
screenCaptureFramerateCapability30Fps | 1 |
screenCaptureFramerateCapability60Fps | 2 |
ScreenCaptureSourceType 4 个成员
| 成员 | 值 |
|---|---|
screencapturesourcetypeUnknown | -1 |
screencapturesourcetypeWindow | 0 |
screencapturesourcetypeScreen | 1 |
screencapturesourcetypeCustom | 2 |
ScreenColorType 3 个成员
| 成员 | 值 |
|---|---|
screenColorAuto | 0 |
screenColorGreen | 1 |
screenColorBlue | 2 |
ScreenScenarioType 4 个成员
| 成员 | 值 |
|---|---|
screenScenarioDocument | 1 |
screenScenarioGaming | 2 |
screenScenarioVideo | 3 |
screenScenarioRdc | 4 |
SegModelType 2 个成员
| 成员 | 值 |
|---|---|
segModelAi | 1 |
segModelGreen | 2 |
SimulcastStreamMode 3 个成员
| 成员 | 值 |
|---|---|
autoSimulcastStream | -1 |
disableSimulcastStream | 0 |
enableSimulcastStream | 1 |
StreamFallbackOptions 3 个成员
| 成员 | 值 |
|---|---|
streamFallbackOptionDisabled | 0 |
streamFallbackOptionVideoStreamLow | 1 |
streamFallbackOptionAudioOnly | 2 |
StreamPublishState 4 个成员
| 成员 | 值 |
|---|---|
pubStateIdle | 0 |
pubStateNoPublished | 1 |
pubStatePublishing | 2 |
pubStatePublished | 3 |
StreamSubscribeState 4 个成员
| 成员 | 值 |
|---|---|
subStateIdle | 0 |
subStateNoSubscribed | 1 |
subStateSubscribing | 2 |
subStateSubscribed | 3 |
UserOfflineReasonType 3 个成员
| 成员 | 值 |
|---|---|
userOfflineQuit | 0 |
userOfflineDropped | 1 |
userOfflineBecomeAudience | 2 |
VideoApplicationScenarioType 4 个成员
| 成员 | 值 |
|---|---|
applicationScenarioGeneral | 0 |
applicationScenarioMeeting | 1 |
applicationScenario1v1 | 2 |
applicationScenarioLiveshow | 3 |
VideoBufferType 3 个成员
| 成员 | 值 |
|---|---|
videoBufferRawData | 1 |
videoBufferArray | 2 |
videoBufferTexture | 3 |
VideoCodecCapabilityLevel 5 个成员
| 成员 | 值 |
|---|---|
codecCapabilityLevelUnspecified | -1 |
codecCapabilityLevelBasicSupport | 5 |
codecCapabilityLevel1080p30fps | 10 |
codecCapabilityLevel1080p60fps | 20 |
codecCapabilityLevel4k60fps | 30 |
VideoCodecProfileType 3 个成员
| 成员 | 值 |
|---|---|
videoCodecProfileBaseline | 66 |
videoCodecProfileMain | 77 |
videoCodecProfileHigh | 100 |
VideoCodecType 6 个成员
| 成员 | 值 |
|---|---|
videoCodecNone | 0 |
videoCodecVp8 | 1 |
videoCodecH264 | 2 |
videoCodecH265 | 3 |
videoCodecGeneric | 6 |
videoCodecGenericJpeg | 20 |
VideoCodecTypeForStream 2 个成员
| 成员 | 值 |
|---|---|
videoCodecH264ForStream | 1 |
videoCodecH265ForStream | 2 |
VideoContentHint 3 个成员
| 成员 | 值 |
|---|---|
contentHintNone | null |
contentHintMotion | null |
contentHintDetails | null |
VideoDenoiserLevel 2 个成员
| 成员 | 值 |
|---|---|
videoDenoiserLevelHighQuality | 0 |
videoDenoiserLevelFast | 1 |
VideoDenoiserMode 2 个成员
| 成员 | 值 |
|---|---|
videoDenoiserAuto | 0 |
videoDenoiserManual | 1 |
VideoEffectAction 2 个成员
| 成员 | 值 |
|---|---|
save | 1 |
reset | 2 |
VideoEffectNodeId 3 个成员
| 成员 | 值 |
|---|---|
beauty | 1 |
styleMakeup | 2 |
filter | 4 |
VideoFrameProcessMode 2 个成员
| 成员 | 值 |
|---|---|
processModeReadOnly | null |
processModeReadWrite | null |
VideoFrameType 6 个成员
| 成员 | 值 |
|---|---|
videoFrameTypeBlankFrame | 0 |
videoFrameTypeKeyFrame | 3 |
videoFrameTypeDeltaFrame | 4 |
videoFrameTypeBFrame | 5 |
videoFrameTypeDroppableFrame | 6 |
videoFrameTypeUnknow | null |
VideoMirrorModeType 3 个成员
| 成员 | 值 |
|---|---|
videoMirrorModeAuto | 0 |
videoMirrorModeEnabled | 1 |
videoMirrorModeDisabled | 2 |
VideoModulePosition 4 个成员
| 成员 | 值 |
|---|---|
positionPostCapturer | 1 |
positionPreRenderer | 2 |
positionPreEncoder | 4 |
positionPostCapturerOrigin | 8 |
VideoOrientation 4 个成员
| 成员 | 值 |
|---|---|
videoOrientation0 | 0 |
videoOrientation90 | 90 |
videoOrientation180 | 180 |
videoOrientation270 | 270 |
VideoPixelFormat 5 个成员
| 成员 | 值 |
|---|---|
videoPixelDefault | 0 |
videoPixelI420 | 1 |
videoPixelRgba | 4 |
videoPixelI422 | 16 |
videoTextureId3d11texture2d | 17 |
VideoSourceType 19 个成员
| 成员 | 值 |
|---|---|
videoSourceCameraPrimary | 0 |
videoSourceCamera | 0 |
videoSourceCameraSecondary | 1 |
videoSourceScreenPrimary | 2 |
videoSourceScreen | 2 |
videoSourceScreenSecondary | 3 |
videoSourceCustom | 4 |
videoSourceMediaPlayer | 5 |
videoSourceRtcImagePng | 6 |
videoSourceRtcImageJpeg | 7 |
videoSourceRtcImageGif | 8 |
videoSourceRemote | 9 |
videoSourceTranscoded | 10 |
videoSourceCameraThird | 11 |
videoSourceCameraFourth | 12 |
videoSourceScreenThird | 13 |
videoSourceScreenFourth | 14 |
videoSourceSpeechDriven | 15 |
videoSourceUnknown | 100 |
VideoStreamType 8 个成员
| 成员 | 值 |
|---|---|
videoStreamHigh | 0 |
videoStreamLow | 1 |
VIDEO_STREAM_LAYER_1 | 4 |
VIDEO_STREAM_LAYER_2 | 5 |
VIDEO_STREAM_LAYER_3 | 6 |
VIDEO_STREAM_LAYER_4 | 7 |
VIDEO_STREAM_LAYER_5 | 8 |
VIDEO_STREAM_LAYER_6 | 9 |
VideoTranscoderError 6 个成员
| 成员 | 值 |
|---|---|
vtErrVideoSourceNotReady | 1 |
vtErrInvalidVideoSourceType | 2 |
vtErrInvalidImagePath | 3 |
vtErrUnsupportImageFormat | 4 |
vtErrInvalidLayout | 5 |
vtErrInternal | 20 |
VideoViewSetupMode 3 个成员
| 成员 | 值 |
|---|---|
videoViewSetupReplace | 0 |
videoViewSetupAdd | 1 |
videoViewSetupRemove | 2 |
VoiceAiTunerType 10 个成员
| 成员 | 值 |
|---|---|
voiceAiTunerMatureMale | 0 |
voiceAiTunerFreshMale | 1 |
voiceAiTunerElegantFemale | 2 |
voiceAiTunerSweetFemale | 3 |
voiceAiTunerWarmMaleSinging | 4 |
voiceAiTunerGentleFemaleSinging | 5 |
voiceAiTunerHuskyMaleSinging | 6 |
voiceAiTunerWarmElegantFemaleSinging | 7 |
voiceAiTunerPowerfulMaleSinging | 8 |
voiceAiTunerDreamyFemaleSinging | 9 |
VoiceBeautifierPreset 14 个成员
| 成员 | 值 |
|---|---|
voiceBeautifierOff | null |
chatBeautifierMagnetic | null |
chatBeautifierFresh | null |
chatBeautifierVitality | null |
singingBeautifier | null |
timbreTransformationVigorous | null |
timbreTransformationDeep | null |
timbreTransformationMellow | null |
timbreTransformationFalsetto | null |
timbreTransformationFull | null |
timbreTransformationClear | null |
timbreTransformationResounding | null |
timbreTransformationRinging | null |
ultraHighQualityVoice | null |
VoiceConversionPreset 5 个成员
| 成员 | 值 |
|---|---|
voiceConversionOff | null |
voiceChangerNeutral | null |
voiceChangerSweet | null |
voiceChangerSolid | null |
voiceChangerBass | null |
WatermarkFitMode 2 个成员
| 成员 | 值 |
|---|---|
fitModeCoverPosition | 0 |
fitModeUseImageRatio | 1 |
WatermarkSourceType 4 个成员
| 成员 | 值 |
|---|---|
image | 0 |
buffer | 1 |
literal | 2 |
timestamps | 3 |
错误码常量
| 常量 | 值 |
|---|---|
RtcEngine | null |
errAborted | 20 |
errAdmGeneralError | 1005 |
errAdmInitPlayout | 1008 |
errAdmInitRecording | 1011 |
errAdmStartPlayout | 1009 |
errAdmStartRecording | 1012 |
errAdmStopPlayout | 1010 |
errAdmStopRecording | 1013 |
errAlreadyInUse | 19 |
errBitrateLimit | 115 |
errBufferTooSmall | 6 |
errClientIsBannedByServer | 123 |
errConnectionInterrupted | 111 |
errConnectionLost | 112 |
errDatastreamDecryptionFailed | 122 |
errDecryptionFailed | 120 |
errEncryptedStreamNotAllowedPublish | 130 |
errFailed | 1 |
errInitNetEngine | 21 |
errInvalidAppId | 101 |
errInvalidArgument | 2 |
errInvalidChannelName | 102 |
errInvalidState | 8 |
errInvalidToken | null |
errInvalidUserAccount | 134 |
errInvalidUserId | 121 |
errJoinChannelRejected | 17 |
errLeaveChannelRejected | 18 |
errLoadMediaEngine | 1001 |
errNoPermission | 9 |
errNoServerResources | 103 |
errNotInChannel | 113 |
errNotInitialized | 7 |
errNotReady | 3 |
errNotSupported | 4 |
errOk | 0 |
errPcmsendBufferoverflow | 201 |
errPcmsendFormat | 200 |
errRefused | 5 |
errResourceLimited | 22 |
errSetClientRoleNotAuthorized | 119 |
errSizeTooLarge | 114 |
errStreamMessageTimeout | 117 |
errTimedout | 10 |
errTokenExpired | 109 |
errTooManyDataStreams | 116 |
errVdmCameraNotAuthorized | 1501 |
已知限制
以下成员在当前版本暂不可用,调用时返回 -4(ERR_NOT_SUPPORTED)。接口定义中保留这些成员,便于跨端代码保持一致。
| 接口 | 成员 |
|---|---|
AgoraPipController | dispose |
AgoraPipController | isPipActivated |
AgoraPipController | pipDispose |
AgoraPipController | pipIsAutoEnterSupported |
AgoraPipController | pipIsSupported |
AgoraPipController | pipSetup |
AgoraPipController | pipStart |
AgoraPipController | pipStop |
AgoraPipController | registerPipStateChangedObserver |
AgoraPipController | unregisterPipStateChangedObserver |
BaseSpatialAudioEngine | muteAllRemoteAudioStreams |
BaseSpatialAudioEngine | muteLocalAudioStream |
BaseSpatialAudioEngine | muteRemoteAudioStream |
BaseSpatialAudioEngine | release |
BaseSpatialAudioEngine | setAudioRecvRange |
BaseSpatialAudioEngine | setDistanceUnit |
BaseSpatialAudioEngine | setMaxAudioRecvCount |
BaseSpatialAudioEngine | setPlayerAttenuation |
BaseSpatialAudioEngine | setZones |
BaseSpatialAudioEngine | updatePlayerPositionInfo |
BaseSpatialAudioEngine | updateSelfPosition |
FilterEffectOptions | path |
LocalSpatialAudioEngine | clearRemotePositions |
LocalSpatialAudioEngine | initialize |
LocalSpatialAudioEngine | removeRemotePosition |
LocalSpatialAudioEngine | setRemoteAudioAttenuation |
LocalSpatialAudioEngine | updateRemotePosition |
MediaEngine | createCustomAudioTrack |
MediaEngine | destroyCustomAudioTrack |
MediaEngine | pullAudioFrame |
MediaEngine | pushAudioFrame |
MediaEngine | pushVideoFrame |
MediaEngine | registerAudioFrameObserver |
MediaEngine | registerFaceInfoObserver |
MediaEngine | registerVideoEncodedFrameObserver |
MediaEngine | registerVideoFrameObserver |
MediaEngine | setExternalAudioSink |
MediaEngine | setExternalAudioSource |
MediaEngine | setExternalVideoSource |
MediaEngine | unregisterAudioFrameObserver |
MediaEngine | unregisterFaceInfoObserver |
MediaEngine | unregisterVideoEncodedFrameObserver |
MediaEngine | unregisterVideoFrameObserver |
MediaPlayerCacheManager | enableAutoRemoveCache |
MediaPlayerCacheManager | getCacheDir |
MediaPlayerCacheManager | getCacheFileCount |
MediaPlayerCacheManager | getMaxCacheFileCount |
MediaPlayerCacheManager | getMaxCacheFileSize |
MediaPlayerCacheManager | getMediaPlayerCacheManager |
MediaPlayerCacheManager | removeAllCaches |
MediaPlayerCacheManager | removeOldCache |
MediaPlayerCacheManager | setCacheDir |
MediaPlayerCacheManager | setMaxCacheFileCount |
MediaPlayerCacheManager | setMaxCacheFileSize |
MediaPlayerController | initialize |
MediaRecorder | setMediaRecorderObserver |
MediaRecorder | startRecording |
MediaRecorder | stopRecording |
MusicChartCollection | get |
MusicChartCollection | getCount |
MusicCollection | getCount |
MusicCollection | getMusic |
MusicCollection | getPage |
MusicCollection | getPageSize |
MusicCollection | getTotal |
MusicContentCenter | createMusicPlayer |
MusicContentCenter | destroyMusicPlayer |
MusicContentCenter | getInternalSongCode |
MusicContentCenter | getLyric |
MusicContentCenter | getMusicCharts |
MusicContentCenter | getMusicCollectionByMusicChartId |
MusicContentCenter | getSongSimpleInfo |
MusicContentCenter | initialize |
MusicContentCenter | isPreloaded |
MusicContentCenter | preload |
MusicContentCenter | registerEventHandler |
MusicContentCenter | release |
MusicContentCenter | removeCache |
MusicContentCenter | renewToken |
MusicContentCenter | searchMusic |
MusicContentCenter | unregisterEventHandler |
MusicPlayer | openWithSongCode |
MusicPlayer | setPlayMode |
RtcEngine | addVideoWatermark |
RtcEngine | addVideoWatermarkWithConfig |
RtcEngine | adjustCustomAudioPlayoutVolume |
RtcEngine | adjustCustomAudioPublishVolume |
RtcEngine | adjustLoopbackSignalVolume |
RtcEngine | clearVideoWatermarks |
RtcEngine | configRhythmPlayer |
RtcEngine | createCustomVideoTrack |
RtcEngine | createMediaRecorder |
RtcEngine | createVideoEffectObject |
RtcEngine | destroyCustomVideoTrack |
RtcEngine | destroyMediaRecorder |
RtcEngine | destroyVideoEffectObject |
RtcEngine | disableAudioSpectrumMonitor |
RtcEngine | enableAudioSpectrumMonitor |
RtcEngine | enableCameraCenterStage |
RtcEngine | enableContentInspect |
RtcEngine | enableCustomAudioLocalPlayback |
RtcEngine | enableDualStreamMode |
RtcEngine | enableEncryption |
RtcEngine | enableExtension |
RtcEngine | enableFaceDetection |
RtcEngine | enableLoopbackRecording |
RtcEngine | enableMultiCamera |
RtcEngine | enableSpatialAudio |
RtcEngine | enableVideoImageSource |
RtcEngine | enableVirtualBackground |
RtcEngine | enableVoiceAITuner |
RtcEngine | getExtensionProperty |
RtcEngine | getFaceShapeAreaOptions |
RtcEngine | getFaceShapeBeautyOptions |
RtcEngine | getNativeHandle |
RtcEngine | isCameraAutoExposureFaceModeSupported |
RtcEngine | isCameraCenterStageSupported |
RtcEngine | isCameraFaceDetectSupported |
RtcEngine | isFeatureAvailableOnDevice |
RtcEngine | isSpeakerphoneEnabled |
RtcEngine | joinChannelWithUserAccountEx |
RtcEngine | loadExtensionProvider |
RtcEngine | pauseAllChannelMediaRelay |
RtcEngine | playAllEffects |
RtcEngine | preloadChannelWithUserAccount |
RtcEngine | queryDeviceScore |
RtcEngine | queryScreenCaptureCapability |
RtcEngine | registerAudioEncodedFrameObserver |
RtcEngine | registerAudioSpectrumObserver |
RtcEngine | registerExtension |
RtcEngine | registerMediaMetadataObserver |
RtcEngine | removeVideoWatermark |
RtcEngine | resumeAllChannelMediaRelay |
RtcEngine | sendMetaData |
RtcEngine | setBeautyEffectOptions |
RtcEngine | setCameraAutoExposureFaceModeEnabled |
RtcEngine | setCameraCapturerConfiguration |
RtcEngine | setCameraDeviceOrientation |
RtcEngine | setCameraStabilizationMode |
RtcEngine | setColorEnhanceOptions |
RtcEngine | setDefaultAudioRouteToSpeakerphone |
RtcEngine | setEarMonitoringAudioFrameParameters |
RtcEngine | setEnableSpeakerphone |
RtcEngine | setExtensionProperty |
RtcEngine | setExtensionProviderProperty |
RtcEngine | setExternalMediaProjection |
RtcEngine | setExternalRemoteEglContext |
RtcEngine | setFaceShapeAreaOptions |
RtcEngine | setFaceShapeBeautyOptions |
RtcEngine | setFilterEffectOptions |
RtcEngine | setLogFile |
RtcEngine | setLogFileSize |
RtcEngine | setLowlightEnhanceOptions |
RtcEngine | setMixedAudioFrameParameters |
RtcEngine | setParameters |
RtcEngine | setPlaybackAudioFrameParameters |
RtcEngine | setRecordingAudioFrameParameters |
RtcEngine | setRemoteUserSpatialAudioParams |
RtcEngine | setRemoteVoicePosition |
RtcEngine | setRouteInCommunicationMode |
RtcEngine | setVideoDenoiserOptions |
RtcEngine | startAudioRecording |
RtcEngine | startCameraCapture |
RtcEngine | startEchoTest |
RtcEngine | startLastmileProbeTest |
RtcEngine | startLocalAudioMixer |
RtcEngine | startLocalVideoTranscoder |
RtcEngine | startMediaRenderingTracing |
RtcEngine | startOrUpdateChannelMediaRelay |
RtcEngine | startRhythmPlayer |
RtcEngine | startRtmpStreamWithTranscoding |
RtcEngine | startRtmpStreamWithoutTranscoding |
RtcEngine | stopAudioRecording |
RtcEngine | stopCameraCapture |
RtcEngine | stopChannelMediaRelay |
RtcEngine | stopEchoTest |
RtcEngine | stopLastmileProbeTest |
RtcEngine | stopLocalAudioMixer |
RtcEngine | stopLocalVideoTranscoder |
RtcEngine | stopRhythmPlayer |
RtcEngine | stopRtmpStream |
RtcEngine | takeSnapshot |
RtcEngine | takeSnapshotWithConfig |
RtcEngine | unloadAllEffects |
RtcEngine | unregisterAudioEncodedFrameObserver |
RtcEngine | unregisterAudioSpectrumObserver |
RtcEngine | unregisterMediaMetadataObserver |
RtcEngine | updateLocalAudioMixerConfiguration |
RtcEngine | updateLocalTranscoderConfiguration |
RtcEngine | updateRtmpTranscoding |
RtcEngineEx | addVideoWatermarkEx |
RtcEngineEx | addVideoWatermarkWithConfigEx |
RtcEngineEx | adjustUserPlaybackSignalVolumeEx |
RtcEngineEx | clearVideoWatermarkEx |
RtcEngineEx | createDataStreamEx |
RtcEngineEx | enableContentInspectEx |
RtcEngineEx | enableDualStreamModeEx |
RtcEngineEx | enableEncryptionEx |
RtcEngineEx | enableLoopbackRecordingEx |
RtcEngineEx | pauseAllChannelMediaRelayEx |
RtcEngineEx | playEffectEx |
RtcEngineEx | preloadEffectEx |
RtcEngineEx | removeVideoWatermarkEx |
RtcEngineEx | resumeAllChannelMediaRelayEx |
RtcEngineEx | sendCustomReportMessageEx |
RtcEngineEx | setDualStreamModeEx |
RtcEngineEx | setRemoteRenderModeEx |
RtcEngineEx | setRemoteVideoStreamTypeEx |
RtcEngineEx | setRemoteVideoSubscriptionOptionsEx |
RtcEngineEx | setRemoteVoicePositionEx |
RtcEngineEx | setSubscribeAudioAllowlistEx |
RtcEngineEx | setSubscribeAudioBlocklistEx |
RtcEngineEx | setSubscribeVideoAllowlistEx |
RtcEngineEx | setSubscribeVideoBlocklistEx |
RtcEngineEx | startMediaRenderingTracingEx |
RtcEngineEx | startOrUpdateChannelMediaRelayEx |
RtcEngineEx | startRtmpStreamWithTranscodingEx |
RtcEngineEx | startRtmpStreamWithoutTranscodingEx |
RtcEngineEx | stopChannelMediaRelayEx |
RtcEngineEx | stopRtmpStreamEx |
RtcEngineEx | takeSnapshotEx |
RtcEngineEx | takeSnapshotWithConfigEx |
RtcEngineEx | updateRtmpTranscodingEx |
RtcEngineExt | getAssetAbsolutePath |
VideoEffectObject | addOrUpdateVideoEffect |
VideoEffectObject | getVideoEffectBoolParam |
VideoEffectObject | getVideoEffectFloatParam |
VideoEffectObject | getVideoEffectIntParam |
VideoEffectObject | performVideoEffectAction |
VideoEffectObject | removeVideoEffect |
VideoEffectObject | setVideoEffectBoolParam |
VideoEffectObject | setVideoEffectFloatParam |
VideoEffectObject | setVideoEffectIntParam |