React Native API 参考
构建时从公开 SDK 接口定义生成:接口、方法重载、属性、事件、枚举与错误码。
接口概览
本页列出 React Native 端公开 API 的类、方法、重载、属性、事件与错误码,接口定义与 SDK 包版本一致。
| 核对项 | 数量 |
|---|---|
| 接口 / 类 | 141 |
| 方法 | 577 |
| 方法重载 | 577 |
| 属性 | 618 |
| 枚举 | 148 |
| 错误码常量 | 48 |
可用性
该端 SDK:正式可用。接口定义与 SDK 包版本一致;运行时的能力边界以实际发布的 SDK 包为准。
加入频道核心链路
按 join / leave / publish / subscribe 的典型调用顺序整理;参数表在“最小可运行链路”一节展开。
| 步骤 | 接口 | 方法 | 重载数 |
|---|---|---|---|
| 订阅远端媒体 | IBaseSpatialAudioEngine | muteRemoteAudioStream | 1 |
| 创建 / 初始化 | ILocalSpatialAudioEngine | initialize | 1 |
| 续期 Token | IMusicContentCenter | renewToken | 1 |
| 开启视频与预览 | IRtcEngine | enableVideo | 1 |
| 加入频道 | IRtcEngine | joinChannel | 1 |
| 离开频道 | IRtcEngine | leaveChannel | 1 |
| 频道场景 | IRtcEngine | setChannelProfile | 1 |
| 角色切换 | IRtcEngine | setClientRole | 1 |
最小可运行链路的参数
| 参数 | 类型 | 可选 | 可变参数 |
|---|---|---|---|
uid | number | 否 | 否 |
mute | boolean | 否 | 否 |
token | string | 否 | 否 |
token | string | 否 | 否 |
channelId | string | 否 | 否 |
uid | number | 否 | 否 |
options | ChannelMediaOptions | 否 | 否 |
options | LeaveChannelOptions | 是 | 否 |
profile | ChannelProfileType | 否 | 否 |
role | ClientRoleType | 否 | 否 |
options | ClientRoleOptions | 是 | 否 |
接口索引
全部接口
AdvancedAudioOptions 0 方法 / 1 属性
| 属性 | 类型 | 只读 |
|---|---|---|
audioProcessingChannels | unknown | 否 |
AdvancedConfigInfo 0 方法 / 1 属性
| 属性 | 类型 | 只读 |
|---|---|---|
logUploadServer | unknown | 否 |
AdvanceOptions 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
encodingPreference | unknown | 否 |
compressionPreference | unknown | 否 |
encodeAlpha | unknown | 否 |
AgoraPip 10 方法 / 0 属性
isPipActivated(): boolean
pipDispose(): void
pipIsAutoEnterSupported(): boolean
pipIsSupported(): boolean
pipSetup(options: AgoraPipOptions): boolean
pipStart(): boolean
pipStop(): void
registerPipStateChangedObserver(observer: AgoraPipStateChangedObserver): void
release(): void
unregisterPipStateChangedObserver(observer: AgoraPipStateChangedObserver): void方法明细:10 / 10(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
isPipActivated | — | boolean | 错误码索引 |
pipDispose | — | void | 错误码索引 |
pipIsAutoEnterSupported | — | boolean | 错误码索引 |
pipIsSupported | — | boolean | 错误码索引 |
pipSetup | options: AgoraPipOptions | boolean | 错误码索引 |
pipStart | — | boolean | 错误码索引 |
pipStop | — | void | 错误码索引 |
registerPipStateChangedObserver | observer: AgoraPipStateChangedObserver | void | 错误码索引 |
release | — | void | 错误码索引 |
unregisterPipStateChangedObserver | observer: AgoraPipStateChangedObserver | void | 错误码索引 |
AgoraPipContentViewLayout 0 方法 / 4 属性
| 属性 | 类型 | 只读 |
|---|---|---|
padding | unknown | 否 |
spacing | unknown | 否 |
row | unknown | 否 |
column | unknown | 否 |
AgoraPipOptions 0 方法 / 17 属性
| 属性 | 类型 | 只读 |
|---|---|---|
autoEnterEnabled | unknown | 否 |
aspectRatioX | unknown | 否 |
aspectRatioY | unknown | 否 |
sourceRectHintLeft | unknown | 否 |
sourceRectHintTop | unknown | 否 |
sourceRectHintRight | unknown | 否 |
sourceRectHintBottom | unknown | 否 |
seamlessResizeEnabled | unknown | 否 |
useExternalStateMonitor | unknown | 否 |
externalStateMonitorInterval | unknown | 否 |
videoStreams | unknown | 否 |
contentViewLayout | unknown | 否 |
sourceContentView | unknown | 否 |
contentView | unknown | 否 |
preferredContentWidth | unknown | 否 |
preferredContentHeight | unknown | 否 |
controlStyle | unknown | 否 |
AgoraPipStateChangedObserver 1 方法 / 0 属性
onPipStateChanged(state: AgoraPipState, error: string | null): void方法明细:1 / 1(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
onPipStateChanged | state: AgoraPipState, error: string | null | void | 错误码索引 |
AgoraRhythmPlayerConfig 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
beatsPerMeasure | unknown | 否 |
beatsPerMinute | unknown | 否 |
AudioDeviceInfo 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
deviceId | unknown | 否 |
deviceName | unknown | 否 |
deviceTypeName | unknown | 否 |
AudioEncodedFrameObserverConfig 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
postionType | unknown | 否 |
encodingType | unknown | 否 |
AudioFrame 0 方法 / 8 属性
| 属性 | 类型 | 只读 |
|---|---|---|
type | avsync_ | 否 |
samplesPerChannel | unknown | 否 |
bytesPerSample | unknown | 否 |
channels | unknown | 否 |
samplesPerSec | unknown | 否 |
buffer | unknown | 否 |
renderTimeMs | unknown | 否 |
avsync_type | unknown | 否 |
AudioParams 0 方法 / 4 属性
| 属性 | 类型 | 只读 |
|---|---|---|
sample_rate | unknown | 否 |
channels | unknown | 否 |
mode | unknown | 否 |
samples_per_call | unknown | 否 |
AudioPcmFrame 0 方法 / 6 属性
| 属性 | 类型 | 只读 |
|---|---|---|
capture_timestamp | unknown | 否 |
samples_per_channel_ | unknown | 否 |
sample_rate_hz_ | unknown | 否 |
num_channels_ | unknown | 否 |
bytes_per_sample | unknown | 否 |
data_ | unknown | 否 |
AudioRecordingConfiguration 0 方法 / 6 属性
| 属性 | 类型 | 只读 |
|---|---|---|
filePath | unknown | 否 |
encode | unknown | 否 |
sampleRate | unknown | 否 |
fileRecordingType | unknown | 否 |
quality | unknown | 否 |
recordingChannel | unknown | 否 |
AudioSpectrumData 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
audioSpectrumData | unknown | 否 |
dataLength | unknown | 否 |
AudioTrackConfig 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
enableLocalPlayback | unknown | 否 |
enableAudioProcessing | unknown | 否 |
AudioVolumeInfo 0 方法 / 4 属性
| 属性 | 类型 | 只读 |
|---|---|---|
uid | unknown | 否 |
volume | unknown | 否 |
vad | unknown | 否 |
voicePitch | unknown | 否 |
BeautyOptions 0 方法 / 5 属性
| 属性 | 类型 | 只读 |
|---|---|---|
lighteningContrastLevel | unknown | 否 |
lighteningLevel | unknown | 否 |
smoothnessLevel | unknown | 否 |
rednessLevel | unknown | 否 |
sharpnessLevel | unknown | 否 |
CacheStatistics 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
fileSize | unknown | 否 |
cacheSize | unknown | 否 |
downloadSize | unknown | 否 |
CameraCapturerConfiguration 0 方法 / 5 属性
| 属性 | 类型 | 只读 |
|---|---|---|
cameraDirection | unknown | 否 |
cameraId | unknown | 否 |
cameraFocalLengthType | unknown | 否 |
format | unknown | 否 |
followEncodeDimensionRatio | unknown | 否 |
ChannelMediaInfo 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
channelName | unknown | 否 |
token | unknown | 否 |
uid | unknown | 否 |
ChannelMediaOptions 0 方法 / 33 属性
| 属性 | 类型 | 只读 |
|---|---|---|
publishCameraTrack | unknown | 否 |
publishSecondaryCameraTrack | unknown | 否 |
publishMicrophoneTrack | unknown | 否 |
publishThirdCameraTrack | unknown | 否 |
publishFourthCameraTrack | unknown | 否 |
publishScreenCaptureVideo | unknown | 否 |
publishScreenCaptureAudio | unknown | 否 |
publishSecondaryScreenTrack | unknown | 否 |
publishTranscodedVideoTrack | unknown | 否 |
publishMixedAudioTrack | unknown | 否 |
publishLipSyncTrack | unknown | 否 |
publishCustomAudioTrack | unknown | 否 |
publishCustomAudioTrackId | unknown | 否 |
publishCustomVideoTrack | unknown | 否 |
publishEncodedVideoTrack | unknown | 否 |
publishMediaPlayerAudioTrack | unknown | 否 |
publishMediaPlayerVideoTrack | unknown | 否 |
autoSubscribeAudio | unknown | 否 |
autoSubscribeVideo | unknown | 否 |
enableAudioRecordingOrPlayout | unknown | 否 |
publishMediaPlayerId | unknown | 否 |
clientRoleType | unknown | 否 |
audienceLatencyLevel | unknown | 否 |
defaultVideoStreamType | unknown | 否 |
channelProfile | unknown | 否 |
audioDelayMs | unknown | 否 |
token | unknown | 否 |
publishRhythmPlayerTrack | unknown | 否 |
isInteractiveAudience | unknown | 否 |
customVideoTrackId | unknown | 否 |
isAudioFilterable | unknown | 否 |
enableMultipath | unknown | 否 |
preferMultipathType | unknown | 否 |
ChannelMediaRelayConfiguration 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
srcInfo | unknown | 否 |
destInfos | unknown | 否 |
destCount | unknown | 否 |
ClientRoleOptions 0 方法 / 1 属性
| 属性 | 类型 | 只读 |
|---|---|---|
audienceLatencyLevel | unknown | 否 |
ClimaxSegment 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
startTimeMs | unknown | 否 |
endTimeMs | unknown | 否 |
CodecCapInfo 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
codecType | unknown | 否 |
codecCapMask | unknown | 否 |
CodecCapLevels 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
hwDecodingLevel | unknown | 否 |
swDecodingLevel | unknown | 否 |
ColorEnhanceOptions 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
strengthLevel | unknown | 否 |
skinProtectLevel | unknown | 否 |
ContentInspectConfig 0 方法 / 4 属性
| 属性 | 类型 | 只读 |
|---|---|---|
extraInfo | unknown | 否 |
serverConfig | unknown | 否 |
modules | unknown | 否 |
moduleCount | unknown | 否 |
ContentInspectModule 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
type | unknown | 否 |
interval | unknown | 否 |
position | unknown | 否 |
DataStreamConfig 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
syncWithAudio | unknown | 否 |
ordered | unknown | 否 |
DeviceInfo 0 方法 / 1 属性
| 属性 | 类型 | 只读 |
|---|---|---|
isLowLatencyAudioSupported | unknown | 否 |
EchoTestConfiguration 0 方法 / 6 属性
| 属性 | 类型 | 只读 |
|---|---|---|
view | unknown | 否 |
enableAudio | unknown | 否 |
enableVideo | unknown | 否 |
token | unknown | 否 |
channelId | unknown | 否 |
intervalInSeconds | unknown | 否 |
EncodedAudioFrameInfo 0 方法 / 6 属性
| 属性 | 类型 | 只读 |
|---|---|---|
codec | unknown | 否 |
sampleRateHz | unknown | 否 |
samplesPerChannel | unknown | 否 |
numberOfChannels | unknown | 否 |
advancedSettings | unknown | 否 |
captureTimeMs | unknown | 否 |
EncodedVideoFrameInfo 0 方法 / 9 属性
| 属性 | 类型 | 只读 |
|---|---|---|
codecType | unknown | 否 |
width | unknown | 否 |
height | unknown | 否 |
framesPerSecond | unknown | 否 |
frameType | unknown | 否 |
rotation | unknown | 否 |
trackId | unknown | 否 |
captureTimeMs | unknown | 否 |
streamType | unknown | 否 |
EncryptionConfig 0 方法 / 4 属性
| 属性 | 类型 | 只读 |
|---|---|---|
encryptionMode | unknown | 否 |
encryptionKey | unknown | 否 |
encryptionKdfSalt | unknown | 否 |
datastreamEncryptionEnabled | unknown | 否 |
ExtensionContext 0 方法 / 4 属性
| 属性 | 类型 | 只读 |
|---|---|---|
isValid | unknown | 否 |
uid | unknown | 否 |
providerName | unknown | 否 |
extensionName | unknown | 否 |
ExternalVideoFrame 0 方法 / 21 属性
| 属性 | 类型 | 只读 |
|---|---|---|
type | unknown | 否 |
format | unknown | 否 |
buffer | unknown | 否 |
stride | unknown | 否 |
height | unknown | 否 |
eglContext | unknown | 否 |
eglType | unknown | 否 |
textureId | unknown | 否 |
matrix | unknown | 否 |
metadataBuffer | unknown | 否 |
metadataSize | unknown | 否 |
alphaBuffer | unknown | 否 |
fillAlphaBuffer | unknown | 否 |
alphaStitchMode | unknown | 否 |
cropLeft | unknown | 否 |
cropTop | unknown | 否 |
cropRight | unknown | 否 |
cropBottom | unknown | 否 |
rotation | unknown | 否 |
timestamp | unknown | 否 |
colorSpace | unknown | 否 |
FaceShapeAreaOptions 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
shapeArea | unknown | 否 |
shapeIntensity | unknown | 否 |
FaceShapeBeautyOptions 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
shapeStyle | unknown | 否 |
styleIntensity | unknown | 否 |
FilterEffectOptions 1 方法 / 1 属性
path(): unknown方法明细:1 / 1(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
path | — | unknown | 错误码索引 |
| 属性 | 类型 | 只读 |
|---|---|---|
strength | unknown | 否 |
FocalLengthInfo 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
cameraDirection | unknown | 否 |
focalLengthType | unknown | 否 |
IAudioDeviceManager 2 方法 / 0 属性
startPlaybackDeviceTest(testAudioFilePath: string): number
stopPlaybackDeviceTest(): number方法明细:2 / 2(参数、返回值、错误码)
IAudioEncodedFrameObserver 3 方法 / 0 属性
onMixedAudioEncodedFrame(frameBuffer: Uint8Array, length: number, audioEncodedFrameInfo: EncodedAudioFrameInfo): void
onPlaybackAudioEncodedFrame(frameBuffer: Uint8Array, length: number, audioEncodedFrameInfo: EncodedAudioFrameInfo): void
onRecordAudioEncodedFrame(frameBuffer: Uint8Array, length: number, audioEncodedFrameInfo: EncodedAudioFrameInfo): void方法明细:3 / 3(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
onMixedAudioEncodedFrame | frameBuffer: Uint8Array, length: number, audioEncodedFrameInfo: EncodedAudioFrameInfo | void | 错误码索引 |
onPlaybackAudioEncodedFrame | frameBuffer: Uint8Array, length: number, audioEncodedFrameInfo: EncodedAudioFrameInfo | void | 错误码索引 |
onRecordAudioEncodedFrame | frameBuffer: Uint8Array, length: number, audioEncodedFrameInfo: EncodedAudioFrameInfo | void | 错误码索引 |
IAudioFrameObserver 1 方法 / 0 属性
onPlaybackAudioFrameBeforeMixing(channelId: string, uid: number, audioFrame: AudioFrame): void方法明细:1 / 1(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
onPlaybackAudioFrameBeforeMixing | channelId: string, uid: number, audioFrame: AudioFrame | void | 错误码索引 |
IAudioFrameObserverBase 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(参数、返回值、错误码)
IAudioPcmFrameSink 1 方法 / 0 属性
onFrame(frame: AudioPcmFrame): void方法明细:1 / 1(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
onFrame | frame: AudioPcmFrame | void | 错误码索引 |
IAudioSpectrumObserver 2 方法 / 0 属性
onLocalAudioSpectrum(data: AudioSpectrumData): void
onRemoteAudioSpectrum(spectrums: UserAudioSpectrumInfo[], spectrumNumber: number): void方法明细:2 / 2(参数、返回值、错误码)
IBaseSpatialAudioEngine 11 方法 / 0 属性
muteAllRemoteAudioStreams(mute: boolean): number
muteLocalAudioStream(mute: boolean): number
muteRemoteAudioStream(uid: number, mute: boolean): number
release(): void
setAudioRecvRange(range: number): number
setDistanceUnit(unit: number): number
setMaxAudioRecvCount(maxCount: number): number
setPlayerAttenuation(playerId: number, attenuation: number, forceSet: boolean): number
setZones(zones: SpatialAudioZone, zoneCount: number): number
updatePlayerPositionInfo(playerId: number, positionInfo: RemoteVoicePositionInfo): number
updateSelfPosition(position: number[], axisForward: number[], axisRight: number[], axisUp: number[]): number方法明细:11 / 11(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
muteAllRemoteAudioStreams | mute: boolean | number | 错误码索引 |
muteLocalAudioStream | mute: boolean | number | 错误码索引 |
muteRemoteAudioStream | uid: number, mute: boolean | number | 错误码索引 |
release | — | void | 错误码索引 |
setAudioRecvRange | range: number | number | 错误码索引 |
setDistanceUnit | unit: number | number | 错误码索引 |
setMaxAudioRecvCount | maxCount: number | number | 错误码索引 |
setPlayerAttenuation | playerId: number, attenuation: number, forceSet: boolean | number | 错误码索引 |
setZones | zones: SpatialAudioZone, zoneCount: number | number | 错误码索引 |
updatePlayerPositionInfo | playerId: number, positionInfo: RemoteVoicePositionInfo | number | 错误码索引 |
updateSelfPosition | position: number[], axisForward: number[], axisRight: number[], axisUp: number[] | number | 错误码索引 |
ILocalSpatialAudioEngine 5 方法 / 0 属性
clearRemotePositions(): number
initialize(): number
removeRemotePosition(uid: number): number
setRemoteAudioAttenuation(uid: number, attenuation: number, forceSet: boolean): number
updateRemotePosition(uid: number, posInfo: RemoteVoicePositionInfo): number方法明细:5 / 5(参数、返回值、错误码)
ImageTrackOptions 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
imageUrl | unknown | 否 |
fps | unknown | 否 |
IMediaEngine 19 方法 / 0 属性
addListener(eventType: EventType, listener: IMediaEngineEvent[EventType]): void
createCustomAudioTrack(trackType: AudioTrackType, config: AudioTrackConfig): number
destroyCustomAudioTrack(trackId: number): number
pullAudioFrame(): AudioFrame
pushAudioFrame(frame: AudioFrame, trackId?: number): number
pushVideoFrame(frame: ExternalVideoFrame, videoTrackId?: number): number
registerAudioFrameObserver(observer: IAudioFrameObserver): number
registerFaceInfoObserver(observer: IFaceInfoObserver): number
registerVideoEncodedFrameObserver(observer: IVideoEncodedFrameObserver): number
registerVideoFrameObserver(observer: IVideoFrameObserver): number
removeAllListeners(eventType?: EventType): void
removeListener(eventType: EventType, listener: IMediaEngineEvent[EventType]): void
setExternalAudioSink(enabled: boolean, sampleRate: number, channels: number): number
setExternalAudioSource(enabled: boolean, sampleRate: number, channels: number, localPlayback?: boolean, publish?: boolean): number
setExternalVideoSource(enabled: boolean, useTexture: boolean, sourceType?: ExternalVideoSourceType, encodedVideoOption?: SenderOptions): number
unregisterAudioFrameObserver(observer: IAudioFrameObserver): number
unregisterFaceInfoObserver(observer: IFaceInfoObserver): number
unregisterVideoEncodedFrameObserver(observer: IVideoEncodedFrameObserver): number
unregisterVideoFrameObserver(observer: IVideoFrameObserver): number方法明细:19 / 19(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
addListener | eventType: EventType, listener: IMediaEngineEvent[EventType] | void | 错误码索引 |
createCustomAudioTrack | trackType: AudioTrackType, config: AudioTrackConfig | number | 错误码索引 |
destroyCustomAudioTrack | trackId: number | number | 错误码索引 |
pullAudioFrame | — | AudioFrame | 错误码索引 |
pushAudioFrame | frame: AudioFrame, trackId?: number | number | 错误码索引 |
pushVideoFrame | frame: ExternalVideoFrame, videoTrackId?: number | number | 错误码索引 |
registerAudioFrameObserver | observer: IAudioFrameObserver | number | 错误码索引 |
registerFaceInfoObserver | observer: IFaceInfoObserver | number | 错误码索引 |
registerVideoEncodedFrameObserver | observer: IVideoEncodedFrameObserver | number | 错误码索引 |
registerVideoFrameObserver | observer: IVideoFrameObserver | number | 错误码索引 |
removeAllListeners | eventType?: EventType | void | 错误码索引 |
removeListener | eventType: EventType, listener: IMediaEngineEvent[EventType] | void | 错误码索引 |
setExternalAudioSink | enabled: boolean, sampleRate: number, channels: number | number | 错误码索引 |
setExternalAudioSource | enabled: boolean, sampleRate: number, channels: number, localPlayback?: boolean, publish?: boolean | number | 错误码索引 |
setExternalVideoSource | enabled: boolean, useTexture: boolean, sourceType?: ExternalVideoSourceType, encodedVideoOption?: SenderOptions | number | 错误码索引 |
unregisterAudioFrameObserver | observer: IAudioFrameObserver | number | 错误码索引 |
unregisterFaceInfoObserver | observer: IFaceInfoObserver | number | 错误码索引 |
unregisterVideoEncodedFrameObserver | observer: IVideoEncodedFrameObserver | number | 错误码索引 |
unregisterVideoFrameObserver | observer: IVideoFrameObserver | number | 错误码索引 |
IMediaPlayer 45 方法 / 0 属性
addListener(eventType: EventType, listener: IMediaPlayerEvent[EventType]): void
adjustPlayoutVolume(volume: number): number
adjustPublishSignalVolume(volume: number): number
getAudioBufferDelay(): number
getDuration(): number
getMediaPlayerId(): number
getMute(): boolean
getPlayPosition(): number
getPlaySrc(): string
getPlayoutVolume(): number
getPublishSignalVolume(): number
getState(): MediaPlayerState
getStreamCount(): number
getStreamInfo(index: number): PlayerStreamInfo
mute(muted: boolean): number
open(url: string, startPos: number): number
openWithMediaSource(source: MediaSource): number
pause(): number
play(): number
playPreloadedSrc(src: string): number
preloadSrc(src: string, startPos: number): number
registerAudioFrameObserver(observer: IAudioPcmFrameSink, mode?: RawAudioFrameOpModeType): number
registerPlayerSourceObserver(observer: IMediaPlayerSourceObserver): number
registerVideoFrameObserver(observer: IMediaPlayerVideoFrameObserver): number
removeAllListeners(eventType?: EventType): void
removeListener(eventType: EventType, listener: IMediaPlayerEvent[EventType]): void
resume(): number
seek(newPos: number): number
selectAudioTrack(index: number): number
selectMultiAudioTrack(playoutTrackIndex: number, publishTrackIndex: number): number
setAudioDualMonoMode(mode: AudioDualMonoMode): number
setAudioPitch(pitch: number): number
setLoopCount(loopCount: number): number
setPlaybackSpeed(speed: number): number
setPlayerOptionInInt(key: string, value: number): number
setPlayerOptionInString(key: string, value: string): number
setRenderMode(renderMode: RenderModeType): number
setSpatialAudioParams(params: SpatialAudioParams): number
setView(view: any): number
stop(): number
switchSrc(src: string, syncPts?: boolean): number
unloadSrc(src: string): number
unregisterAudioFrameObserver(observer: IAudioPcmFrameSink): number
unregisterPlayerSourceObserver(observer: IMediaPlayerSourceObserver): number
unregisterVideoFrameObserver(observer: IMediaPlayerVideoFrameObserver): number方法明细:45 / 45(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
addListener | eventType: EventType, listener: IMediaPlayerEvent[EventType] | void | 错误码索引 |
adjustPlayoutVolume | volume: number | number | 错误码索引 |
adjustPublishSignalVolume | volume: number | number | 错误码索引 |
getAudioBufferDelay | — | number | 错误码索引 |
getDuration | — | number | 错误码索引 |
getMediaPlayerId | — | number | 错误码索引 |
getMute | — | boolean | 错误码索引 |
getPlayPosition | — | number | 错误码索引 |
getPlaySrc | — | string | 错误码索引 |
getPlayoutVolume | — | number | 错误码索引 |
getPublishSignalVolume | — | number | 错误码索引 |
getState | — | MediaPlayerState | 错误码索引 |
getStreamCount | — | number | 错误码索引 |
getStreamInfo | index: number | PlayerStreamInfo | 错误码索引 |
mute | muted: boolean | number | 错误码索引 |
open | url: string, startPos: number | number | 错误码索引 |
openWithMediaSource | source: MediaSource | number | 错误码索引 |
pause | — | number | 错误码索引 |
play | — | number | 错误码索引 |
playPreloadedSrc | src: string | number | 错误码索引 |
preloadSrc | src: string, startPos: number | number | 错误码索引 |
registerAudioFrameObserver | observer: IAudioPcmFrameSink, mode?: RawAudioFrameOpModeType | number | 错误码索引 |
registerPlayerSourceObserver | observer: IMediaPlayerSourceObserver | number | 错误码索引 |
registerVideoFrameObserver | observer: IMediaPlayerVideoFrameObserver | number | 错误码索引 |
removeAllListeners | eventType?: EventType | void | 错误码索引 |
removeListener | eventType: EventType, listener: IMediaPlayerEvent[EventType] | void | 错误码索引 |
resume | — | number | 错误码索引 |
seek | newPos: number | number | 错误码索引 |
selectAudioTrack | index: number | number | 错误码索引 |
selectMultiAudioTrack | playoutTrackIndex: number, publishTrackIndex: number | number | 错误码索引 |
setAudioDualMonoMode | mode: AudioDualMonoMode | number | 错误码索引 |
setAudioPitch | pitch: number | number | 错误码索引 |
setLoopCount | loopCount: number | number | 错误码索引 |
setPlaybackSpeed | speed: number | number | 错误码索引 |
setPlayerOptionInInt | key: string, value: number | number | 错误码索引 |
setPlayerOptionInString | key: string, value: string | number | 错误码索引 |
setRenderMode | renderMode: RenderModeType | number | 错误码索引 |
setSpatialAudioParams | params: SpatialAudioParams | number | 错误码索引 |
setView | view: any | number | 错误码索引 |
stop | — | number | 错误码索引 |
switchSrc | src: string, syncPts?: boolean | number | 错误码索引 |
unloadSrc | src: string | number | 错误码索引 |
unregisterAudioFrameObserver | observer: IAudioPcmFrameSink | number | 错误码索引 |
unregisterPlayerSourceObserver | observer: IMediaPlayerSourceObserver | number | 错误码索引 |
unregisterVideoFrameObserver | observer: IMediaPlayerVideoFrameObserver | number | 错误码索引 |
IMediaPlayerCacheManager 12 方法 / 0 属性
enableAutoRemoveCache(enable: boolean): number
getCacheDir(length: number): string
getCacheFileCount(): number
getMaxCacheFileCount(): number
getMaxCacheFileSize(): number
getMediaPlayerCacheManager(): IMediaPlayerCacheManager
removeAllCaches(): number
removeCacheByUri(uri: string): number
removeOldCache(): number
setCacheDir(path: string): number
setMaxCacheFileCount(count: number): number
setMaxCacheFileSize(cacheSize: number): number方法明细:12 / 12(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
enableAutoRemoveCache | enable: boolean | number | 错误码索引 |
getCacheDir | length: number | string | 错误码索引 |
getCacheFileCount | — | number | 错误码索引 |
getMaxCacheFileCount | — | number | 错误码索引 |
getMaxCacheFileSize | — | number | 错误码索引 |
getMediaPlayerCacheManager | — | IMediaPlayerCacheManager | 错误码索引 |
removeAllCaches | — | number | 错误码索引 |
removeCacheByUri | uri: string | number | 错误码索引 |
removeOldCache | — | number | 错误码索引 |
setCacheDir | path: string | number | 错误码索引 |
setMaxCacheFileCount | count: number | number | 错误码索引 |
setMaxCacheFileSize | cacheSize: number | number | 错误码索引 |
IMediaPlayerSourceObserver 11 方法 / 0 属性
onAudioVolumeIndication(volume: number): void
onMetaData(data: Uint8Array, length: number): void
onPlayBufferUpdated(playCachedBuffer: number): void
onPlayerCacheStats(stats: CacheStatistics): void
onPlayerEvent(eventCode: MediaPlayerEvent, elapsedTime: number, 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: number, timestampMs: number): void
onPreloadEvent(src: string, event: PlayerPreloadEvent): void方法明细:11 / 11(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
onAudioVolumeIndication | volume: number | void | 错误码索引 |
onMetaData | data: Uint8Array, length: number | void | 错误码索引 |
onPlayBufferUpdated | playCachedBuffer: number | void | 错误码索引 |
onPlayerCacheStats | stats: CacheStatistics | void | 错误码索引 |
onPlayerEvent | eventCode: MediaPlayerEvent, elapsedTime: number, 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: number, timestampMs: number | void | 错误码索引 |
onPreloadEvent | src: string, event: PlayerPreloadEvent | void | 错误码索引 |
IMediaPlayerVideoFrameObserver 1 方法 / 0 属性
onFrame(frame: VideoFrame): void方法明细:1 / 1(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
onFrame | frame: VideoFrame | void | 错误码索引 |
IMediaRecorder 6 方法 / 0 属性
addListener(eventType: EventType, listener: IMediaRecorderEvent[EventType]): void
removeAllListeners(eventType?: EventType): void
removeListener(eventType: EventType, listener: IMediaRecorderEvent[EventType]): void
setMediaRecorderObserver(callback: IMediaRecorderObserver): number
startRecording(config: MediaRecorderConfiguration): number
stopRecording(): number方法明细:6 / 6(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
addListener | eventType: EventType, listener: IMediaRecorderEvent[EventType] | void | 错误码索引 |
removeAllListeners | eventType?: EventType | void | 错误码索引 |
removeListener | eventType: EventType, listener: IMediaRecorderEvent[EventType] | void | 错误码索引 |
setMediaRecorderObserver | callback: IMediaRecorderObserver | number | 错误码索引 |
startRecording | config: MediaRecorderConfiguration | number | 错误码索引 |
stopRecording | — | number | 错误码索引 |
IMediaRecorderObserver 2 方法 / 0 属性
onRecorderInfoUpdated(channelId: string, uid: number, info: RecorderInfo): void
onRecorderStateChanged(channelId: string, uid: number, state: RecorderState, reason: RecorderReasonCode): void方法明细:2 / 2(参数、返回值、错误码)
IMetadataObserver 1 方法 / 0 属性
onMetadataReceived(metadata: Metadata): void方法明细:1 / 1(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
onMetadataReceived | metadata: Metadata | void | 错误码索引 |
IMusicContentCenter 17 方法 / 0 属性
Preload(songCode: number): string
createMusicPlayer(): IMusicPlayer
destroyMusicPlayer(musicPlayer: IMusicPlayer): number
getCaches(): { cacheInfo: MusicCacheInfo[]; cacheInfoSize: number }
getInternalSongCode(songCode: number, jsonOption: string): number
getLyric(songCode: number, lyricType?: number): string
getMusicCharts(): string
getMusicCollectionByMusicChartId(musicChartId: number, page: number, pageSize: number, jsonOption?: string): string
getSongSimpleInfo(songCode: number): string
initialize(configuration: MusicContentCenterConfiguration): number
isPreloaded(songCode: number): number
registerEventHandler(eventHandler: IMusicContentCenterEventHandler): number
release(): void
removeCache(songCode: number): number
renewToken(token: string): number
searchMusic(requestId: string, keyWord: string, page: number, pageSize: number, jsonOption?: string): number
unregisterEventHandler(): number方法明细:17 / 17(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
Preload | songCode: number | string | 错误码索引 |
createMusicPlayer | — | IMusicPlayer | 错误码索引 |
destroyMusicPlayer | musicPlayer: IMusicPlayer | number | 错误码索引 |
getCaches | — | { cacheInfo: MusicCacheInfo[]; cacheInfoSize: number } | 错误码索引 |
getInternalSongCode | songCode: number, jsonOption: string | number | 错误码索引 |
getLyric | songCode: number, lyricType?: number | string | 错误码索引 |
getMusicCharts | — | string | 错误码索引 |
getMusicCollectionByMusicChartId | musicChartId: number, page: number, pageSize: number, jsonOption?: string | string | 错误码索引 |
getSongSimpleInfo | songCode: number | string | 错误码索引 |
initialize | configuration: MusicContentCenterConfiguration | number | 错误码索引 |
isPreloaded | songCode: number | number | 错误码索引 |
registerEventHandler | eventHandler: IMusicContentCenterEventHandler | number | 错误码索引 |
release | — | void | 错误码索引 |
removeCache | songCode: number | number | 错误码索引 |
renewToken | token: string | number | 错误码索引 |
searchMusic | requestId: string, keyWord: string, page: number, pageSize: number, jsonOption?: string | number | 错误码索引 |
unregisterEventHandler | — | number | 错误码索引 |
IMusicContentCenterEventHandler 5 方法 / 0 属性
onLyricResult(requestId: string, songCode: number, lyricUrl: string, reason: MusicContentCenterStateReason): void
onMusicChartsResult(requestId: string, result: MusicChartInfo[], reason: MusicContentCenterStateReason): void
onMusicCollectionResult(requestId: string, result: MusicCollection, reason: MusicContentCenterStateReason): void
onPreLoadEvent(requestId: string, songCode: number, percent: number, lyricUrl: string, status: PreloadState, reason: MusicContentCenterStateReason): void
onSongSimpleInfoResult(requestId: string, songCode: number, simpleInfo: string, reason: MusicContentCenterStateReason): void方法明细:5 / 5(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
onLyricResult | requestId: string, songCode: number, lyricUrl: string, reason: MusicContentCenterStateReason | void | 错误码索引 |
onMusicChartsResult | requestId: string, result: MusicChartInfo[], reason: MusicContentCenterStateReason | void | 错误码索引 |
onMusicCollectionResult | requestId: string, result: MusicCollection, reason: MusicContentCenterStateReason | void | 错误码索引 |
onPreLoadEvent | requestId: string, songCode: number, percent: number, lyricUrl: string, status: PreloadState, reason: MusicContentCenterStateReason | void | 错误码索引 |
onSongSimpleInfoResult | requestId: string, songCode: number, simpleInfo: string, reason: MusicContentCenterStateReason | void | 错误码索引 |
IMusicPlayer 2 方法 / 0 属性
openWithSongCode(songCode: number, startPos?: number): number
setPlayMode(mode: MusicPlayMode): number方法明细:2 / 2(参数、返回值、错误码)
IRtcEngine 265 方法 / 0 属性
addListener(eventType: EventType, listener: IRtcEngineEvent[EventType]): void
addVideoWatermark(watermarkUrl: string, options: WatermarkOptions): number
addVideoWatermarkWithConfig(configs: WatermarkConfig): number
adjustAudioMixingPlayoutVolume(volume: number): number
adjustAudioMixingPublishVolume(volume: number): number
adjustAudioMixingVolume(volume: number): number
adjustCustomAudioPlayoutVolume(trackId: number, volume: number): number
adjustCustomAudioPublishVolume(trackId: number, volume: number): number
adjustPlaybackSignalVolume(volume: number): number
adjustRecordingSignalVolume(volume: number): number
adjustUserPlaybackSignalVolume(uid: number, volume: number): number
clearVideoWatermarks(): number
complain(callId: string, description: string): number
configRhythmPlayer(config: AgoraRhythmPlayerConfig): number
createAgoraRtcEngine(): IRtcEngine
createCustomVideoTrack(): number
createDataStream(config: DataStreamConfig): number
createMediaPlayer(): IMediaPlayer
createMediaRecorder(info: RecorderStreamInfo): IMediaRecorder
createVideoEffectObject(bundlePath: string, type?: MediaSourceType): IVideoEffectObject
destroyCustomVideoTrack(videoTrackId: number): number
destroyMediaPlayer(mediaPlayer: IMediaPlayer): number
destroyMediaRecorder(mediaRecorder: IMediaRecorder): number
destroyVideoEffectObject(videoEffectObject: IVideoEffectObject): number
disableAudio(): number
disableAudioSpectrumMonitor(): number
disableVideo(): number
enableAudio(): number
enableAudioSpectrumMonitor(intervalInMS?: number): number
enableAudioVolumeIndication(interval: number, smooth: number, reportVad: boolean): number
enableCameraCenterStage(enabled: boolean): number
enableContentInspect(enabled: boolean, config: ContentInspectConfig): number
enableCustomAudioLocalPlayback(trackId: number, enabled: boolean): number
enableDualStreamMode(enabled: boolean, streamConfig?: SimulcastStreamConfig): number
enableEncryption(enabled: boolean, config: EncryptionConfig): number
enableExtension(provider: string, extension: string, enable?: boolean, type?: MediaSourceType): number
enableFaceDetection(enabled: boolean): number
enableInEarMonitoring(enabled: boolean, includeAudioFilters: EarMonitoringFilterType): number
enableInstantMediaRendering(): number
enableLocalAudio(enabled: boolean): number
enableLocalVideo(enabled: boolean): number
enableMultiCamera(enabled: boolean, config: CameraCapturerConfiguration): number
enableSoundPositionIndication(enabled: boolean): number
enableSpatialAudio(enabled: boolean): number
enableVideo(): number
enableVideoImageSource(enable: boolean, options: ImageTrackOptions): number
enableVirtualBackground(enabled: boolean, backgroundSource: VirtualBackgroundSource, segproperty: SegmentationProperty, type?: MediaSourceType): number
enableVoiceAITuner(enabled: boolean, type: VoiceAiTunerType): number
enableWebSdkInteroperability(enabled: boolean): number
getAudioDeviceInfo(): DeviceInfo
getAudioDeviceManager(): IAudioDeviceManager
getAudioMixingCurrentPosition(): number
getAudioMixingDuration(): number
getAudioMixingPlayoutVolume(): number
getAudioMixingPublishVolume(): number
getAudioTrackCount(): number
getCallId(): string
getCameraMaxZoomFactor(): number
getConnectionState(): ConnectionStateType
getCurrentMonotonicTimeInMs(): number
getEffectCurrentPosition(soundId: number): number
getEffectDuration(filePath: string): number
getEffectsVolume(): number
getErrorDescription(code: number): string
getExtensionProperty(provider: string, extension: string, key: string, bufLen: number, type?: MediaSourceType): string
getFaceShapeAreaOptions(shapeArea: FaceShapeArea, type?: MediaSourceType): FaceShapeAreaOptions
getFaceShapeBeautyOptions(type?: MediaSourceType): FaceShapeBeautyOptions
getLocalSpatialAudioEngine(): ILocalSpatialAudioEngine
getMediaEngine(): IMediaEngine
getMusicContentCenter(): IMusicContentCenter
getNativeHandle(): number
getNetworkType(): number
getNtpWallTimeInMs(): number
getUserInfoByUid(uid: number): UserInfo
getUserInfoByUserAccount(userAccount: string): UserInfo
getVersion(): SDKBuildInfo
getVideoDeviceManager(): IVideoDeviceManager
getVolumeOfEffect(soundId: number): number
initialize(context: RtcEngineContext): number
isCameraAutoExposureFaceModeSupported(): boolean
isCameraAutoFocusFaceModeSupported(): boolean
isCameraCenterStageSupported(): boolean
isCameraExposurePositionSupported(): boolean
isCameraExposureSupported(): boolean
isCameraFaceDetectSupported(): boolean
isCameraFocusSupported(): boolean
isCameraTorchSupported(): boolean
isCameraZoomSupported(): boolean
isFeatureAvailableOnDevice(type: FeatureType): boolean
isSpeakerphoneEnabled(): boolean
joinChannel(token: string, channelId: string, uid: number, options: ChannelMediaOptions): number
joinChannelWithUserAccount(token: string, channelId: string, userAccount: string, options?: ChannelMediaOptions): number
joinChannelWithUserAccountEx(token: string, channelId: string, userAccount: string, options: ChannelMediaOptions): number
leaveChannel(options?: LeaveChannelOptions): number
loadExtensionProvider(path: string, unloadAfterUse?: boolean): number
muteAllRemoteAudioStreams(mute: boolean): number
muteAllRemoteVideoStreams(mute: boolean): number
muteLocalAudioStream(mute: boolean): number
muteLocalVideoStream(mute: boolean): number
muteRecordingSignal(mute: boolean): number
muteRemoteAudioStream(uid: number, mute: boolean): number
muteRemoteVideoStream(uid: number, mute: boolean): number
pauseAllChannelMediaRelay(): number
pauseAllEffects(): number
pauseAudioMixing(): number
pauseEffect(soundId: number): number
playAllEffects(loopCount: number, pitch: number, pan: number, gain: number, publish?: boolean): number
playEffect(soundId: number, filePath: string, loopCount: number, pitch: number, pan: number, gain: number, publish?: boolean, startPos?: number): number
preloadChannel(token: string, channelId: string, uid: number): number
preloadChannelWithUserAccount(token: string, channelId: string, userAccount: string): number
preloadEffect(soundId: number, filePath: string, startPos?: number): number
queryCameraFocalLengthCapability(): { focalLengthInfos: FocalLengthInfo[]; size: number; }
queryCodecCapability(): { codecInfo: CodecCapInfo[]; size: number }
queryDeviceScore(): number
queryScreenCaptureCapability(): number
rate(callId: string, rating: number, description: string): number
registerAudioEncodedFrameObserver(config: AudioEncodedFrameObserverConfig, observer: IAudioEncodedFrameObserver): number
registerAudioSpectrumObserver(observer: IAudioSpectrumObserver): number
registerEventHandler(eventHandler: IRtcEngineEventHandler): boolean
registerExtension(provider: string, extension: string, type?: MediaSourceType): number
registerLocalUserAccount(appId: string, userAccount: string): number
registerMediaMetadataObserver(observer: IMetadataObserver, type: MetadataType): number
release(sync?: boolean): void
removeAllListeners(eventType?: EventType): void
removeListener(eventType: EventType, listener: IRtcEngineEvent[EventType]): void
removeVideoWatermark(id: string): number
renewToken(token: string): number
resumeAllChannelMediaRelay(): number
resumeAllEffects(): number
resumeAudioMixing(): number
resumeEffect(soundId: number): number
selectAudioTrack(index: number): number
sendCustomReportMessage(id: string, category: string, event: string, label: string, value: number): number
sendMetaData(metadata: Metadata, sourceType: VideoSourceType): number
sendStreamMessage(streamId: number, data: Uint8Array, length: number): number
setAINSMode(enabled: boolean, mode: AudioAinsMode): number
setAVSyncSource(channelId: string, uid: number): number
setAdvancedAudioOptions(options: AdvancedAudioOptions): number
setAudioEffectParameters(preset: AudioEffectPreset, param1: number, param2: number): number
setAudioEffectPreset(preset: AudioEffectPreset): number
setAudioMixingDualMonoMode(mode: AudioMixingDualMonoMode): number
setAudioMixingPitch(pitch: number): number
setAudioMixingPlaybackSpeed(speed: number): number
setAudioMixingPosition(pos: number): number
setAudioProfile(profile: AudioProfileType, scenario?: AudioScenarioType): number
setAudioScenario(scenario: AudioScenarioType): number
setAudioSessionOperationRestriction(restriction: AudioSessionOperationRestriction): number
setBeautyEffectOptions(enabled: boolean, options: BeautyOptions, type?: MediaSourceType): number
setCameraAutoExposureFaceModeEnabled(enabled: boolean): number
setCameraAutoFocusFaceModeEnabled(enabled: boolean): number
setCameraCapturerConfiguration(config: CameraCapturerConfiguration): number
setCameraDeviceOrientation(type: VideoSourceType, orientation: VideoOrientation): number
setCameraExposureFactor(factor: number): number
setCameraExposurePosition(positionXinView: number, positionYinView: number): number
setCameraFocusPositionInPreview(positionX: number, positionY: number): number
setCameraStabilizationMode(mode: CameraStabilizationMode): number
setCameraTorchOn(isOn: boolean): number
setCameraZoomFactor(factor: number): number
setChannelProfile(profile: ChannelProfileType): number
setClientRole(role: ClientRoleType, options?: ClientRoleOptions): number
setCloudProxy(proxyType: CloudProxyType): number
setColorEnhanceOptions(enabled: boolean, options: ColorEnhanceOptions, type?: MediaSourceType): number
setDefaultAudioRouteToSpeakerphone(defaultToSpeaker: boolean): number
setDualStreamMode(mode: SimulcastStreamMode, streamConfig?: SimulcastStreamConfig): number
setEarMonitoringAudioFrameParameters(sampleRate: number, channel: number, mode: RawAudioFrameOpModeType, samplesPerCall: number): number
setEffectPosition(soundId: number, pos: number): number
setEffectsVolume(volume: number): number
setEnableSpeakerphone(speakerOn: boolean): number
setExtensionProperty(provider: string, extension: string, key: string, value: string, type?: MediaSourceType): number
setExtensionProviderProperty(provider: string, key: string, value: string): number
setExternalMediaProjection(mediaProjection: any): number
setExternalRemoteEglContext(eglContext: any): number
setFaceShapeAreaOptions(options: FaceShapeAreaOptions, type?: MediaSourceType): number
setFaceShapeBeautyOptions(enabled: boolean, options: FaceShapeBeautyOptions, type?: MediaSourceType): number
setFilterEffectOptions(enabled: boolean, options: FilterEffectOptions, type?: MediaSourceType): number
setHeadphoneEQParameters(lowGain: number, highGain: number): number
setHeadphoneEQPreset(preset: HeadphoneEqualizerPreset): number
setInEarMonitoringVolume(volume: number): number
setLocalAccessPoint(config: LocalAccessPointConfiguration): number
setLocalRenderMode(renderMode: RenderModeType, mirrorMode?: VideoMirrorModeType): number
setLocalRenderTargetFps(sourceType: VideoSourceType, targetFps: number): number
setLocalVideoMirrorMode(mirrorMode: VideoMirrorModeType): number
setLocalVoiceEqualization(bandFrequency: AudioEqualizationBandFrequency, bandGain: number): number
setLocalVoiceFormant(formantRatio: number): number
setLocalVoicePitch(pitch: number): number
setLocalVoiceReverb(reverbKey: AudioReverbType, value: number): number
setLogFile(filePath: string): number
setLogFileSize(fileSizeInKBytes: number): number
setLogFilter(filter: LogFilterType): number
setLogLevel(level: LogLevel): number
setLowlightEnhanceOptions(enabled: boolean, options: LowlightEnhanceOptions, type?: MediaSourceType): number
setMaxMetadataSize(size: number): number
setMixedAudioFrameParameters(sampleRate: number, channel: number, samplesPerCall: number): number
setParameters(parameters: string): number
setPlaybackAudioFrameBeforeMixingParameters(sampleRate: number, channel: number samplesPerCall: number): number
setPlaybackAudioFrameParameters(sampleRate: number, channel: number, mode: RawAudioFrameOpModeType, samplesPerCall: number): number
setRecordingAudioFrameParameters(sampleRate: number, channel: number, mode: RawAudioFrameOpModeType, samplesPerCall: number): number
setRemoteDefaultVideoStreamType(streamType: VideoStreamType): number
setRemoteRenderMode(uid: number, renderMode: RenderModeType, mirrorMode: VideoMirrorModeType): number
setRemoteRenderTargetFps(targetFps: number): number
setRemoteSubscribeFallbackOption(option: StreamFallbackOptions): number
setRemoteUserSpatialAudioParams(uid: number, params: SpatialAudioParams): number
setRemoteVideoStreamType(uid: number, streamType: VideoStreamType): number
setRemoteVideoSubscriptionOptions(uid: number, options: VideoSubscriptionOptions): number
setRemoteVoicePosition(uid: number, pan: number, gain: number): number
setRouteInCommunicationMode(route: number): number
setScreenCaptureContentHint(contentHint: VideoContentHint): number
setScreenCaptureScenario(screenScenario: ScreenScenarioType): number
setSubscribeAudioAllowlist(uidList: number[], uidNumber: number): number
setSubscribeAudioBlocklist(uidList: number[], uidNumber: number): number
setSubscribeVideoAllowlist(uidList: number[], uidNumber: number): number
setSubscribeVideoBlocklist(uidList: number[], uidNumber: number): number
setVideoDenoiserOptions(enabled: boolean, options: VideoDenoiserOptions, type?: MediaSourceType): number
setVideoEncoderConfiguration(config: VideoEncoderConfiguration): number
setVideoScenario(scenarioType: VideoApplicationScenarioType): number
setVoiceBeautifierParameters(preset: VoiceBeautifierPreset, param1: number, param2: number): number
setVoiceBeautifierPreset(preset: VoiceBeautifierPreset): number
setVoiceConversionPreset(preset: VoiceConversionPreset): number
setVolumeOfEffect(soundId: number, volume: number): number
startAudioMixing(filePath: string, loopback: boolean, cycle: number, startPos?: number): number
startAudioRecording(config: AudioRecordingConfiguration): number
startCameraCapture(sourceType: VideoSourceType, config: CameraCapturerConfiguration): number
startEchoTest(config: EchoTestConfiguration): number
startLastmileProbeTest(config: LastmileProbeConfig): number
startLocalAudioMixer(config: LocalAudioMixerConfiguration): number
startLocalVideoTranscoder(config: LocalTranscoderConfiguration): number
startMediaRenderingTracing(): number
startOrUpdateChannelMediaRelay(configuration: ChannelMediaRelayConfiguration): number
startPreview(sourceType?: VideoSourceType): number
startPreviewWithoutSourceType(): number
startRhythmPlayer(sound1: string, sound2: string, config: AgoraRhythmPlayerConfig): number
startRtmpStreamWithTranscoding(url: string, transcoding: LiveTranscoding): number
startRtmpStreamWithoutTranscoding(url: string): number
startScreenCapture(captureParams: ScreenCaptureParameters2): number
stopAllEffects(): number
stopAudioMixing(): number
stopAudioRecording(): number
stopCameraCapture(sourceType: VideoSourceType): number
stopChannelMediaRelay(): number
stopEchoTest(): number
stopEffect(soundId: number): number
stopLastmileProbeTest(): number
stopLocalAudioMixer(): number
stopLocalVideoTranscoder(): number
stopPreview(sourceType?: VideoSourceType): number
stopRhythmPlayer(): number
stopRtmpStream(url: string): number
stopScreenCapture(): number
switchCamera(): number
takeSnapshot(uid: number, filePath: string): number
takeSnapshotWithConfig(uid: number, config: SnapshotConfig): number
unloadAllEffects(): number
unloadEffect(soundId: number): number
unregisterAudioEncodedFrameObserver(observer: IAudioEncodedFrameObserver): number
unregisterAudioSpectrumObserver(observer: IAudioSpectrumObserver): number
unregisterEventHandler(eventHandler: IRtcEngineEventHandler): boolean
unregisterMediaMetadataObserver(observer: IMetadataObserver, type: MetadataType): number
updateChannelMediaOptions(options: ChannelMediaOptions): number
updateLocalAudioMixerConfiguration(config: LocalAudioMixerConfiguration): number
updateLocalTranscoderConfiguration(config: LocalTranscoderConfiguration): number
updatePreloadChannelToken(token: string): number
updateRtmpTranscoding(transcoding: LiveTranscoding): number
updateScreenCapture(captureParams: ScreenCaptureParameters2): number
updateScreenCaptureParameters(captureParams: ScreenCaptureParameters): number
updateScreenCaptureRegion(regionRect: Rectangle): number方法明细:265 / 265(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
addListener | eventType: EventType, listener: IRtcEngineEvent[EventType] | void | 错误码索引 |
addVideoWatermark | watermarkUrl: string, options: WatermarkOptions | number | 错误码索引 |
addVideoWatermarkWithConfig | configs: WatermarkConfig | number | 错误码索引 |
adjustAudioMixingPlayoutVolume | volume: number | number | 错误码索引 |
adjustAudioMixingPublishVolume | volume: number | number | 错误码索引 |
adjustAudioMixingVolume | volume: number | number | 错误码索引 |
adjustCustomAudioPlayoutVolume | trackId: number, volume: number | number | 错误码索引 |
adjustCustomAudioPublishVolume | trackId: number, volume: number | number | 错误码索引 |
adjustPlaybackSignalVolume | volume: number | number | 错误码索引 |
adjustRecordingSignalVolume | volume: number | number | 错误码索引 |
adjustUserPlaybackSignalVolume | uid: number, volume: number | number | 错误码索引 |
clearVideoWatermarks | — | number | 错误码索引 |
complain | callId: string, description: string | number | 错误码索引 |
configRhythmPlayer | config: AgoraRhythmPlayerConfig | number | 错误码索引 |
createAgoraRtcEngine | — | IRtcEngine | 错误码索引 |
createCustomVideoTrack | — | number | 错误码索引 |
createDataStream | config: DataStreamConfig | number | 错误码索引 |
createMediaPlayer | — | IMediaPlayer | 错误码索引 |
createMediaRecorder | info: RecorderStreamInfo | IMediaRecorder | 错误码索引 |
createVideoEffectObject | bundlePath: string, type?: MediaSourceType | IVideoEffectObject | 错误码索引 |
destroyCustomVideoTrack | videoTrackId: number | number | 错误码索引 |
destroyMediaPlayer | mediaPlayer: IMediaPlayer | number | 错误码索引 |
destroyMediaRecorder | mediaRecorder: IMediaRecorder | number | 错误码索引 |
destroyVideoEffectObject | videoEffectObject: IVideoEffectObject | number | 错误码索引 |
disableAudio | — | number | 错误码索引 |
disableAudioSpectrumMonitor | — | number | 错误码索引 |
disableVideo | — | number | 错误码索引 |
enableAudio | — | number | 错误码索引 |
enableAudioSpectrumMonitor | intervalInMS?: number | number | 错误码索引 |
enableAudioVolumeIndication | interval: number, smooth: number, reportVad: boolean | number | 错误码索引 |
enableCameraCenterStage | enabled: boolean | number | 错误码索引 |
enableContentInspect | enabled: boolean, config: ContentInspectConfig | number | 错误码索引 |
enableCustomAudioLocalPlayback | trackId: number, enabled: boolean | number | 错误码索引 |
enableDualStreamMode | enabled: boolean, streamConfig?: SimulcastStreamConfig | number | 错误码索引 |
enableEncryption | enabled: boolean, config: EncryptionConfig | number | 错误码索引 |
enableExtension | provider: string, extension: string, enable?: boolean, type?: MediaSourceType | number | 错误码索引 |
enableFaceDetection | enabled: boolean | number | 错误码索引 |
enableInEarMonitoring | enabled: boolean, includeAudioFilters: EarMonitoringFilterType | number | 错误码索引 |
enableInstantMediaRendering | — | number | 错误码索引 |
enableLocalAudio | enabled: boolean | number | 错误码索引 |
enableLocalVideo | enabled: boolean | number | 错误码索引 |
enableMultiCamera | enabled: boolean, config: CameraCapturerConfiguration | number | 错误码索引 |
enableSoundPositionIndication | enabled: boolean | number | 错误码索引 |
enableSpatialAudio | enabled: boolean | number | 错误码索引 |
enableVideo | — | number | 错误码索引 |
enableVideoImageSource | enable: boolean, options: ImageTrackOptions | number | 错误码索引 |
enableVirtualBackground | enabled: boolean, backgroundSource: VirtualBackgroundSource, segproperty: SegmentationProperty, type?: MediaSourceType | number | 错误码索引 |
enableVoiceAITuner | enabled: boolean, type: VoiceAiTunerType | number | 错误码索引 |
enableWebSdkInteroperability | enabled: boolean | number | 错误码索引 |
getAudioDeviceInfo | — | DeviceInfo | 错误码索引 |
getAudioDeviceManager | — | IAudioDeviceManager | 错误码索引 |
getAudioMixingCurrentPosition | — | number | 错误码索引 |
getAudioMixingDuration | — | number | 错误码索引 |
getAudioMixingPlayoutVolume | — | number | 错误码索引 |
getAudioMixingPublishVolume | — | number | 错误码索引 |
getAudioTrackCount | — | number | 错误码索引 |
getCallId | — | string | 错误码索引 |
getCameraMaxZoomFactor | — | number | 错误码索引 |
getConnectionState | — | ConnectionStateType | 错误码索引 |
getCurrentMonotonicTimeInMs | — | number | 错误码索引 |
getEffectCurrentPosition | soundId: number | number | 错误码索引 |
getEffectDuration | filePath: string | number | 错误码索引 |
getEffectsVolume | — | number | 错误码索引 |
getErrorDescription | code: number | string | 错误码索引 |
getExtensionProperty | provider: string, extension: string, key: string, bufLen: number, type?: MediaSourceType | string | 错误码索引 |
getFaceShapeAreaOptions | shapeArea: FaceShapeArea, type?: MediaSourceType | FaceShapeAreaOptions | 错误码索引 |
getFaceShapeBeautyOptions | type?: MediaSourceType | FaceShapeBeautyOptions | 错误码索引 |
getLocalSpatialAudioEngine | — | ILocalSpatialAudioEngine | 错误码索引 |
getMediaEngine | — | IMediaEngine | 错误码索引 |
getMusicContentCenter | — | IMusicContentCenter | 错误码索引 |
getNativeHandle | — | number | 错误码索引 |
getNetworkType | — | number | 错误码索引 |
getNtpWallTimeInMs | — | number | 错误码索引 |
getUserInfoByUid | uid: number | UserInfo | 错误码索引 |
getUserInfoByUserAccount | userAccount: string | UserInfo | 错误码索引 |
getVersion | — | SDKBuildInfo | 错误码索引 |
getVideoDeviceManager | — | IVideoDeviceManager | 错误码索引 |
getVolumeOfEffect | soundId: number | number | 错误码索引 |
initialize | context: RtcEngineContext | number | 错误码索引 |
isCameraAutoExposureFaceModeSupported | — | boolean | 错误码索引 |
isCameraAutoFocusFaceModeSupported | — | boolean | 错误码索引 |
isCameraCenterStageSupported | — | boolean | 错误码索引 |
isCameraExposurePositionSupported | — | boolean | 错误码索引 |
isCameraExposureSupported | — | boolean | 错误码索引 |
isCameraFaceDetectSupported | — | boolean | 错误码索引 |
isCameraFocusSupported | — | boolean | 错误码索引 |
isCameraTorchSupported | — | boolean | 错误码索引 |
isCameraZoomSupported | — | boolean | 错误码索引 |
isFeatureAvailableOnDevice | type: FeatureType | boolean | 错误码索引 |
isSpeakerphoneEnabled | — | boolean | 错误码索引 |
joinChannel | token: string, channelId: string, uid: number, options: ChannelMediaOptions | number | 错误码索引 |
joinChannelWithUserAccount | token: string, channelId: string, userAccount: string, options?: ChannelMediaOptions | number | 错误码索引 |
joinChannelWithUserAccountEx | token: string, channelId: string, userAccount: string, options: ChannelMediaOptions | number | 错误码索引 |
leaveChannel | options?: LeaveChannelOptions | number | 错误码索引 |
loadExtensionProvider | path: string, unloadAfterUse?: boolean | number | 错误码索引 |
muteAllRemoteAudioStreams | mute: boolean | number | 错误码索引 |
muteAllRemoteVideoStreams | mute: boolean | number | 错误码索引 |
muteLocalAudioStream | mute: boolean | number | 错误码索引 |
muteLocalVideoStream | mute: boolean | number | 错误码索引 |
muteRecordingSignal | mute: boolean | number | 错误码索引 |
muteRemoteAudioStream | uid: number, mute: boolean | number | 错误码索引 |
muteRemoteVideoStream | uid: number, mute: boolean | number | 错误码索引 |
pauseAllChannelMediaRelay | — | number | 错误码索引 |
pauseAllEffects | — | number | 错误码索引 |
pauseAudioMixing | — | number | 错误码索引 |
pauseEffect | soundId: number | number | 错误码索引 |
playAllEffects | loopCount: number, pitch: number, pan: number, gain: number, publish?: boolean | number | 错误码索引 |
playEffect | soundId: number, filePath: string, loopCount: number, pitch: number, pan: number, gain: number, publish?: boolean, startPos?: number | number | 错误码索引 |
preloadChannel | token: string, channelId: string, uid: number | number | 错误码索引 |
preloadChannelWithUserAccount | token: string, channelId: string, userAccount: string | number | 错误码索引 |
preloadEffect | soundId: number, filePath: string, startPos?: number | number | 错误码索引 |
queryCameraFocalLengthCapability | — | { focalLengthInfos: FocalLengthInfo[]; size: number; } | 错误码索引 |
queryCodecCapability | — | { codecInfo: CodecCapInfo[]; size: number } | 错误码索引 |
queryDeviceScore | — | number | 错误码索引 |
queryScreenCaptureCapability | — | number | 错误码索引 |
rate | callId: string, rating: number, description: string | number | 错误码索引 |
registerAudioEncodedFrameObserver | config: AudioEncodedFrameObserverConfig, observer: IAudioEncodedFrameObserver | number | 错误码索引 |
registerAudioSpectrumObserver | observer: IAudioSpectrumObserver | number | 错误码索引 |
registerEventHandler | eventHandler: IRtcEngineEventHandler | boolean | 错误码索引 |
registerExtension | provider: string, extension: string, type?: MediaSourceType | number | 错误码索引 |
registerLocalUserAccount | appId: string, userAccount: string | number | 错误码索引 |
registerMediaMetadataObserver | observer: IMetadataObserver, type: MetadataType | number | 错误码索引 |
release | sync?: boolean | void | 错误码索引 |
removeAllListeners | eventType?: EventType | void | 错误码索引 |
removeListener | eventType: EventType, listener: IRtcEngineEvent[EventType] | void | 错误码索引 |
removeVideoWatermark | id: string | number | 错误码索引 |
renewToken | token: string | number | 错误码索引 |
resumeAllChannelMediaRelay | — | number | 错误码索引 |
resumeAllEffects | — | number | 错误码索引 |
resumeAudioMixing | — | number | 错误码索引 |
resumeEffect | soundId: number | number | 错误码索引 |
selectAudioTrack | index: number | number | 错误码索引 |
sendCustomReportMessage | id: string, category: string, event: string, label: string, value: number | number | 错误码索引 |
sendMetaData | metadata: Metadata, sourceType: VideoSourceType | number | 错误码索引 |
sendStreamMessage | streamId: number, data: Uint8Array, length: number | number | 错误码索引 |
setAINSMode | enabled: boolean, mode: AudioAinsMode | number | 错误码索引 |
setAVSyncSource | channelId: string, uid: number | number | 错误码索引 |
setAdvancedAudioOptions | options: AdvancedAudioOptions | number | 错误码索引 |
setAudioEffectParameters | preset: AudioEffectPreset, param1: number, param2: number | number | 错误码索引 |
setAudioEffectPreset | preset: AudioEffectPreset | number | 错误码索引 |
setAudioMixingDualMonoMode | mode: AudioMixingDualMonoMode | number | 错误码索引 |
setAudioMixingPitch | pitch: number | number | 错误码索引 |
setAudioMixingPlaybackSpeed | speed: number | number | 错误码索引 |
setAudioMixingPosition | pos: number | number | 错误码索引 |
setAudioProfile | profile: AudioProfileType, scenario?: AudioScenarioType | number | 错误码索引 |
setAudioScenario | scenario: AudioScenarioType | number | 错误码索引 |
setAudioSessionOperationRestriction | restriction: AudioSessionOperationRestriction | number | 错误码索引 |
setBeautyEffectOptions | enabled: boolean, options: BeautyOptions, type?: MediaSourceType | number | 错误码索引 |
setCameraAutoExposureFaceModeEnabled | enabled: boolean | number | 错误码索引 |
setCameraAutoFocusFaceModeEnabled | enabled: boolean | number | 错误码索引 |
setCameraCapturerConfiguration | config: CameraCapturerConfiguration | number | 错误码索引 |
setCameraDeviceOrientation | type: VideoSourceType, orientation: VideoOrientation | number | 错误码索引 |
setCameraExposureFactor | factor: number | number | 错误码索引 |
setCameraExposurePosition | positionXinView: number, positionYinView: number | number | 错误码索引 |
setCameraFocusPositionInPreview | positionX: number, positionY: number | number | 错误码索引 |
setCameraStabilizationMode | mode: CameraStabilizationMode | number | 错误码索引 |
setCameraTorchOn | isOn: boolean | number | 错误码索引 |
setCameraZoomFactor | factor: number | number | 错误码索引 |
setChannelProfile | profile: ChannelProfileType | number | 错误码索引 |
setClientRole | role: ClientRoleType, options?: ClientRoleOptions | number | 错误码索引 |
setCloudProxy | proxyType: CloudProxyType | number | 错误码索引 |
setColorEnhanceOptions | enabled: boolean, options: ColorEnhanceOptions, type?: MediaSourceType | number | 错误码索引 |
setDefaultAudioRouteToSpeakerphone | defaultToSpeaker: boolean | number | 错误码索引 |
setDualStreamMode | mode: SimulcastStreamMode, streamConfig?: SimulcastStreamConfig | number | 错误码索引 |
setEarMonitoringAudioFrameParameters | sampleRate: number, channel: number, mode: RawAudioFrameOpModeType, samplesPerCall: number | number | 错误码索引 |
setEffectPosition | soundId: number, pos: number | number | 错误码索引 |
setEffectsVolume | volume: number | number | 错误码索引 |
setEnableSpeakerphone | speakerOn: boolean | number | 错误码索引 |
setExtensionProperty | provider: string, extension: string, key: string, value: string, type?: MediaSourceType | number | 错误码索引 |
setExtensionProviderProperty | provider: string, key: string, value: string | number | 错误码索引 |
setExternalMediaProjection | mediaProjection: any | number | 错误码索引 |
setExternalRemoteEglContext | eglContext: any | number | 错误码索引 |
setFaceShapeAreaOptions | options: FaceShapeAreaOptions, type?: MediaSourceType | number | 错误码索引 |
setFaceShapeBeautyOptions | enabled: boolean, options: FaceShapeBeautyOptions, type?: MediaSourceType | number | 错误码索引 |
setFilterEffectOptions | enabled: boolean, options: FilterEffectOptions, type?: MediaSourceType | number | 错误码索引 |
setHeadphoneEQParameters | lowGain: number, highGain: number | number | 错误码索引 |
setHeadphoneEQPreset | preset: HeadphoneEqualizerPreset | number | 错误码索引 |
setInEarMonitoringVolume | volume: number | number | 错误码索引 |
setLocalAccessPoint | config: LocalAccessPointConfiguration | number | 错误码索引 |
setLocalRenderMode | renderMode: RenderModeType, mirrorMode?: VideoMirrorModeType | number | 错误码索引 |
setLocalRenderTargetFps | sourceType: VideoSourceType, targetFps: number | number | 错误码索引 |
setLocalVideoMirrorMode | mirrorMode: VideoMirrorModeType | number | 错误码索引 |
setLocalVoiceEqualization | bandFrequency: AudioEqualizationBandFrequency, bandGain: number | number | 错误码索引 |
setLocalVoiceFormant | formantRatio: number | number | 错误码索引 |
setLocalVoicePitch | pitch: number | number | 错误码索引 |
setLocalVoiceReverb | reverbKey: AudioReverbType, value: number | number | 错误码索引 |
setLogFile | filePath: string | number | 错误码索引 |
setLogFileSize | fileSizeInKBytes: number | number | 错误码索引 |
setLogFilter | filter: LogFilterType | number | 错误码索引 |
setLogLevel | level: LogLevel | number | 错误码索引 |
setLowlightEnhanceOptions | enabled: boolean, options: LowlightEnhanceOptions, type?: MediaSourceType | number | 错误码索引 |
setMaxMetadataSize | size: number | number | 错误码索引 |
setMixedAudioFrameParameters | sampleRate: number, channel: number, samplesPerCall: number | number | 错误码索引 |
setParameters | parameters: string | number | 错误码索引 |
setPlaybackAudioFrameBeforeMixingParameters | sampleRate: number, channel: number samplesPerCall: number | number | 错误码索引 |
setPlaybackAudioFrameParameters | sampleRate: number, channel: number, mode: RawAudioFrameOpModeType, samplesPerCall: number | number | 错误码索引 |
setRecordingAudioFrameParameters | sampleRate: number, channel: number, mode: RawAudioFrameOpModeType, samplesPerCall: number | number | 错误码索引 |
setRemoteDefaultVideoStreamType | streamType: VideoStreamType | number | 错误码索引 |
setRemoteRenderMode | uid: number, renderMode: RenderModeType, mirrorMode: VideoMirrorModeType | number | 错误码索引 |
setRemoteRenderTargetFps | targetFps: number | number | 错误码索引 |
setRemoteSubscribeFallbackOption | option: StreamFallbackOptions | number | 错误码索引 |
setRemoteUserSpatialAudioParams | uid: number, params: SpatialAudioParams | number | 错误码索引 |
setRemoteVideoStreamType | uid: number, streamType: VideoStreamType | number | 错误码索引 |
setRemoteVideoSubscriptionOptions | uid: number, options: VideoSubscriptionOptions | number | 错误码索引 |
setRemoteVoicePosition | uid: number, pan: number, gain: number | number | 错误码索引 |
setRouteInCommunicationMode | route: number | number | 错误码索引 |
setScreenCaptureContentHint | contentHint: VideoContentHint | number | 错误码索引 |
setScreenCaptureScenario | screenScenario: ScreenScenarioType | number | 错误码索引 |
setSubscribeAudioAllowlist | uidList: number[], uidNumber: number | number | 错误码索引 |
setSubscribeAudioBlocklist | uidList: number[], uidNumber: number | number | 错误码索引 |
setSubscribeVideoAllowlist | uidList: number[], uidNumber: number | number | 错误码索引 |
setSubscribeVideoBlocklist | uidList: number[], uidNumber: number | number | 错误码索引 |
setVideoDenoiserOptions | enabled: boolean, options: VideoDenoiserOptions, type?: MediaSourceType | number | 错误码索引 |
setVideoEncoderConfiguration | config: VideoEncoderConfiguration | number | 错误码索引 |
setVideoScenario | scenarioType: VideoApplicationScenarioType | number | 错误码索引 |
setVoiceBeautifierParameters | preset: VoiceBeautifierPreset, param1: number, param2: number | number | 错误码索引 |
setVoiceBeautifierPreset | preset: VoiceBeautifierPreset | number | 错误码索引 |
setVoiceConversionPreset | preset: VoiceConversionPreset | number | 错误码索引 |
setVolumeOfEffect | soundId: number, volume: number | number | 错误码索引 |
startAudioMixing | filePath: string, loopback: boolean, cycle: number, startPos?: number | number | 错误码索引 |
startAudioRecording | config: AudioRecordingConfiguration | number | 错误码索引 |
startCameraCapture | sourceType: VideoSourceType, config: CameraCapturerConfiguration | number | 错误码索引 |
startEchoTest | config: EchoTestConfiguration | number | 错误码索引 |
startLastmileProbeTest | config: LastmileProbeConfig | number | 错误码索引 |
startLocalAudioMixer | config: LocalAudioMixerConfiguration | number | 错误码索引 |
startLocalVideoTranscoder | config: LocalTranscoderConfiguration | number | 错误码索引 |
startMediaRenderingTracing | — | number | 错误码索引 |
startOrUpdateChannelMediaRelay | configuration: ChannelMediaRelayConfiguration | number | 错误码索引 |
startPreview | sourceType?: VideoSourceType | number | 错误码索引 |
startPreviewWithoutSourceType | — | number | 错误码索引 |
startRhythmPlayer | sound1: string, sound2: string, config: AgoraRhythmPlayerConfig | number | 错误码索引 |
startRtmpStreamWithTranscoding | url: string, transcoding: LiveTranscoding | number | 错误码索引 |
startRtmpStreamWithoutTranscoding | url: string | number | 错误码索引 |
startScreenCapture | captureParams: ScreenCaptureParameters2 | number | 错误码索引 |
stopAllEffects | — | number | 错误码索引 |
stopAudioMixing | — | number | 错误码索引 |
stopAudioRecording | — | number | 错误码索引 |
stopCameraCapture | sourceType: VideoSourceType | number | 错误码索引 |
stopChannelMediaRelay | — | number | 错误码索引 |
stopEchoTest | — | number | 错误码索引 |
stopEffect | soundId: number | number | 错误码索引 |
stopLastmileProbeTest | — | number | 错误码索引 |
stopLocalAudioMixer | — | number | 错误码索引 |
stopLocalVideoTranscoder | — | number | 错误码索引 |
stopPreview | sourceType?: VideoSourceType | number | 错误码索引 |
stopRhythmPlayer | — | number | 错误码索引 |
stopRtmpStream | url: string | number | 错误码索引 |
stopScreenCapture | — | number | 错误码索引 |
switchCamera | — | number | 错误码索引 |
takeSnapshot | uid: number, filePath: string | number | 错误码索引 |
takeSnapshotWithConfig | uid: number, config: SnapshotConfig | number | 错误码索引 |
unloadAllEffects | — | number | 错误码索引 |
unloadEffect | soundId: number | number | 错误码索引 |
unregisterAudioEncodedFrameObserver | observer: IAudioEncodedFrameObserver | number | 错误码索引 |
unregisterAudioSpectrumObserver | observer: IAudioSpectrumObserver | number | 错误码索引 |
unregisterEventHandler | eventHandler: IRtcEngineEventHandler | boolean | 错误码索引 |
unregisterMediaMetadataObserver | observer: IMetadataObserver, type: MetadataType | number | 错误码索引 |
updateChannelMediaOptions | options: ChannelMediaOptions | number | 错误码索引 |
updateLocalAudioMixerConfiguration | config: LocalAudioMixerConfiguration | number | 错误码索引 |
updateLocalTranscoderConfiguration | config: LocalTranscoderConfiguration | number | 错误码索引 |
updatePreloadChannelToken | token: string | number | 错误码索引 |
updateRtmpTranscoding | transcoding: LiveTranscoding | number | 错误码索引 |
updateScreenCapture | captureParams: ScreenCaptureParameters2 | number | 错误码索引 |
updateScreenCaptureParameters | captureParams: ScreenCaptureParameters | number | 错误码索引 |
updateScreenCaptureRegion | regionRect: Rectangle | number | 错误码索引 |
IRtcEngineEventHandler 84 方法 / 0 属性
onActiveSpeaker(connection: RtcConnection, uid: number): void
onAudioEffectFinished(soundId: number): void
onAudioMixingFinished(): void
onAudioMixingPositionChanged(position: number): void
onAudioMixingStateChanged(state: AudioMixingStateType, reason: AudioMixingReasonType): void
onAudioPublishStateChanged(channel: string, oldState: StreamPublishState, newState: StreamPublishState, elapseSinceLastState: number): void
onAudioQuality(connection: RtcConnection, remoteUid: number, quality: QualityType, delay: number, lost: number): void
onAudioRoutingChanged(routing: number): void
onAudioSubscribeStateChanged(channel: string, uid: number, oldState: StreamSubscribeState, newState: StreamSubscribeState, elapseSinceLastState: number): void
onAudioVolumeIndication(connection: RtcConnection, speakers: AudioVolumeInfo[], speakerNumber: number, totalVolume: number): void
onCameraExposureAreaChanged(x: number, y: number, width: number, height: number): void
onCameraFocusAreaChanged(x: number, y: number, width: number, height: number): 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: number, message: string): void
onExtensionEventWithContext(context: ExtensionContext, key: string, value: string): void
onExtensionStartedWithContext(context: ExtensionContext): void
onExtensionStoppedWithContext(context: ExtensionContext): void
onFacePositionChanged(imageWidth: number, imageHeight: number, vecRectangle: Rectangle, vecDistance: number, numFaces: number): void
onFirstLocalAudioFramePublished(connection: RtcConnection, elapsed: number): void
onFirstLocalVideoFrame(source: VideoSourceType, width: number, height: number, elapsed: number): void
onFirstLocalVideoFramePublished(connection: RtcConnection, elapsed: number): void
onFirstRemoteAudioDecoded(connection: RtcConnection, uid: number, elapsed: number): void
onFirstRemoteAudioFrame(connection: RtcConnection, userId: number, elapsed: number): void
onFirstRemoteVideoDecoded(connection: RtcConnection, remoteUid: number, width: number, height: number, elapsed: number): void
onFirstRemoteVideoFrame(connection: RtcConnection, remoteUid: number, width: number, height: number, elapsed: number): void
onJoinChannelSuccess(connection: RtcConnection, elapsed: number): 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: number, userAccount: string): void
onLocalVideoEvent(source: VideoSourceType, event: LocalVideoEventType): void
onLocalVideoStateChanged(source: VideoSourceType, state: LocalVideoStreamState, reason: LocalVideoStreamReason): void
onLocalVideoStats(connection: RtcConnection, stats: LocalVideoStats): void
onLocalVideoTranscoderError(stream: TranscodingVideoStream, error: VideoTranscoderError): void
onMultipathStats(connection: RtcConnection, stats: MultipathStats): void
onNetworkQuality(connection: RtcConnection, remoteUid: number, txQuality: QualityType, rxQuality: QualityType): void
onNetworkTypeChanged(connection: RtcConnection, type: NetworkType): void
onPermissionError(permissionType: PermissionType): void
onPermissionGranted(permissionType: PermissionType): void
onProxyConnected(channel: string, uid: number, proxyType: ProxyType, localProxyIp: string, elapsed: number): void
onRejoinChannelSuccess(connection: RtcConnection, elapsed: number): void
onRemoteAudioStateChanged(connection: RtcConnection, remoteUid: number, state: RemoteAudioState, reason: RemoteAudioStateReason, elapsed: number): void
onRemoteAudioStats(connection: RtcConnection, stats: RemoteAudioStats): void
onRemoteAudioTransportStats(connection: RtcConnection, remoteUid: number, delay: number, lost: number, rxKBitRate: number): void
onRemoteSubscribeFallbackToAudioOnly(uid: number, isFallbackOrRecover: boolean): void
onRemoteVideoStateChanged(connection: RtcConnection, remoteUid: number, state: RemoteVideoState, reason: RemoteVideoStateReason, elapsed: number): void
onRemoteVideoStats(connection: RtcConnection, stats: RemoteVideoStats): void
onRemoteVideoTransportStats(connection: RtcConnection, remoteUid: number, delay: number, lost: number, rxKBitRate: number): 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: number, filePath: string, width: number, height: number, errCode: number): void
onStreamMessage(connection: RtcConnection, remoteUid: number, streamId: number, data: Uint8Array, length: number, sentTs: number): void
onStreamMessageError(connection: RtcConnection, remoteUid: number, streamId: number, code: ErrorCodeType, missed: number, cached: number): void
onTokenPrivilegeWillExpire(connection: RtcConnection, token: string): void
onTranscodedStreamLayoutInfo(connection: RtcConnection, uid: number, width: number, height: number, layoutCount: number, layoutlist: VideoLayout[]): void
onTranscodingUpdated(): void
onUplinkNetworkInfoUpdated(info: UplinkNetworkInfo): void
onUserEnableLocalVideo(connection: RtcConnection, remoteUid: number, enabled: boolean): void
onUserEnableVideo(connection: RtcConnection, remoteUid: number, enabled: boolean): void
onUserInfoUpdated(uid: number, info: UserInfo): void
onUserJoined(connection: RtcConnection, remoteUid: number, elapsed: number): void
onUserMuteAudio(connection: RtcConnection, remoteUid: number, muted: boolean): void
onUserMuteVideo(connection: RtcConnection, remoteUid: number, muted: boolean): void
onUserOffline(connection: RtcConnection, remoteUid: number, reason: UserOfflineReasonType): void
onVideoPublishStateChanged(source: VideoSourceType, channel: string, oldState: StreamPublishState, newState: StreamPublishState, elapseSinceLastState: number): void
onVideoRenderingTracingResult(connection: RtcConnection, uid: number, currentEvent: MediaTraceEvent, tracingInfo: VideoRenderingTracingInfo): void
onVideoSizeChanged(connection: RtcConnection, sourceType: VideoSourceType, uid: number, width: number, height: number, rotation: number): void
onVideoStopped(): void
onVideoSubscribeStateChanged(channel: string, uid: number, oldState: StreamSubscribeState, newState: StreamSubscribeState, elapseSinceLastState: number): void方法明细:84 / 84(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
onActiveSpeaker | connection: RtcConnection, uid: number | void | 错误码索引 |
onAudioEffectFinished | soundId: number | void | 错误码索引 |
onAudioMixingFinished | — | void | 错误码索引 |
onAudioMixingPositionChanged | position: number | void | 错误码索引 |
onAudioMixingStateChanged | state: AudioMixingStateType, reason: AudioMixingReasonType | void | 错误码索引 |
onAudioPublishStateChanged | channel: string, oldState: StreamPublishState, newState: StreamPublishState, elapseSinceLastState: number | void | 错误码索引 |
onAudioQuality | connection: RtcConnection, remoteUid: number, quality: QualityType, delay: number, lost: number | void | 错误码索引 |
onAudioRoutingChanged | routing: number | void | 错误码索引 |
onAudioSubscribeStateChanged | channel: string, uid: number, oldState: StreamSubscribeState, newState: StreamSubscribeState, elapseSinceLastState: number | void | 错误码索引 |
onAudioVolumeIndication | connection: RtcConnection, speakers: AudioVolumeInfo[], speakerNumber: number, totalVolume: number | void | 错误码索引 |
onCameraExposureAreaChanged | x: number, y: number, width: number, height: number | void | 错误码索引 |
onCameraFocusAreaChanged | x: number, y: number, width: number, height: number | 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: number, message: string | void | 错误码索引 |
onExtensionEventWithContext | context: ExtensionContext, key: string, value: string | void | 错误码索引 |
onExtensionStartedWithContext | context: ExtensionContext | void | 错误码索引 |
onExtensionStoppedWithContext | context: ExtensionContext | void | 错误码索引 |
onFacePositionChanged | imageWidth: number, imageHeight: number, vecRectangle: Rectangle, vecDistance: number, numFaces: number | void | 错误码索引 |
onFirstLocalAudioFramePublished | connection: RtcConnection, elapsed: number | void | 错误码索引 |
onFirstLocalVideoFrame | source: VideoSourceType, width: number, height: number, elapsed: number | void | 错误码索引 |
onFirstLocalVideoFramePublished | connection: RtcConnection, elapsed: number | void | 错误码索引 |
onFirstRemoteAudioDecoded | connection: RtcConnection, uid: number, elapsed: number | void | 错误码索引 |
onFirstRemoteAudioFrame | connection: RtcConnection, userId: number, elapsed: number | void | 错误码索引 |
onFirstRemoteVideoDecoded | connection: RtcConnection, remoteUid: number, width: number, height: number, elapsed: number | void | 错误码索引 |
onFirstRemoteVideoFrame | connection: RtcConnection, remoteUid: number, width: number, height: number, elapsed: number | void | 错误码索引 |
onJoinChannelSuccess | connection: RtcConnection, elapsed: number | 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: number, userAccount: string | void | 错误码索引 |
onLocalVideoEvent | source: VideoSourceType, event: LocalVideoEventType | void | 错误码索引 |
onLocalVideoStateChanged | source: VideoSourceType, state: LocalVideoStreamState, reason: LocalVideoStreamReason | void | 错误码索引 |
onLocalVideoStats | connection: RtcConnection, stats: LocalVideoStats | void | 错误码索引 |
onLocalVideoTranscoderError | stream: TranscodingVideoStream, error: VideoTranscoderError | void | 错误码索引 |
onMultipathStats | connection: RtcConnection, stats: MultipathStats | void | 错误码索引 |
onNetworkQuality | connection: RtcConnection, remoteUid: number, txQuality: QualityType, rxQuality: QualityType | void | 错误码索引 |
onNetworkTypeChanged | connection: RtcConnection, type: NetworkType | void | 错误码索引 |
onPermissionError | permissionType: PermissionType | void | 错误码索引 |
onPermissionGranted | permissionType: PermissionType | void | 错误码索引 |
onProxyConnected | channel: string, uid: number, proxyType: ProxyType, localProxyIp: string, elapsed: number | void | 错误码索引 |
onRejoinChannelSuccess | connection: RtcConnection, elapsed: number | void | 错误码索引 |
onRemoteAudioStateChanged | connection: RtcConnection, remoteUid: number, state: RemoteAudioState, reason: RemoteAudioStateReason, elapsed: number | void | 错误码索引 |
onRemoteAudioStats | connection: RtcConnection, stats: RemoteAudioStats | void | 错误码索引 |
onRemoteAudioTransportStats | connection: RtcConnection, remoteUid: number, delay: number, lost: number, rxKBitRate: number | void | 错误码索引 |
onRemoteSubscribeFallbackToAudioOnly | uid: number, isFallbackOrRecover: boolean | void | 错误码索引 |
onRemoteVideoStateChanged | connection: RtcConnection, remoteUid: number, state: RemoteVideoState, reason: RemoteVideoStateReason, elapsed: number | void | 错误码索引 |
onRemoteVideoStats | connection: RtcConnection, stats: RemoteVideoStats | void | 错误码索引 |
onRemoteVideoTransportStats | connection: RtcConnection, remoteUid: number, delay: number, lost: number, rxKBitRate: number | 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: number, filePath: string, width: number, height: number, errCode: number | void | 错误码索引 |
onStreamMessage | connection: RtcConnection, remoteUid: number, streamId: number, data: Uint8Array, length: number, sentTs: number | void | 错误码索引 |
onStreamMessageError | connection: RtcConnection, remoteUid: number, streamId: number, code: ErrorCodeType, missed: number, cached: number | void | 错误码索引 |
onTokenPrivilegeWillExpire | connection: RtcConnection, token: string | void | 错误码索引 |
onTranscodedStreamLayoutInfo | connection: RtcConnection, uid: number, width: number, height: number, layoutCount: number, layoutlist: VideoLayout[] | void | 错误码索引 |
onTranscodingUpdated | — | void | 错误码索引 |
onUplinkNetworkInfoUpdated | info: UplinkNetworkInfo | void | 错误码索引 |
onUserEnableLocalVideo | connection: RtcConnection, remoteUid: number, enabled: boolean | void | 错误码索引 |
onUserEnableVideo | connection: RtcConnection, remoteUid: number, enabled: boolean | void | 错误码索引 |
onUserInfoUpdated | uid: number, info: UserInfo | void | 错误码索引 |
onUserJoined | connection: RtcConnection, remoteUid: number, elapsed: number | void | 错误码索引 |
onUserMuteAudio | connection: RtcConnection, remoteUid: number, muted: boolean | void | 错误码索引 |
onUserMuteVideo | connection: RtcConnection, remoteUid: number, muted: boolean | void | 错误码索引 |
onUserOffline | connection: RtcConnection, remoteUid: number, reason: UserOfflineReasonType | void | 错误码索引 |
onVideoPublishStateChanged | source: VideoSourceType, channel: string, oldState: StreamPublishState, newState: StreamPublishState, elapseSinceLastState: number | void | 错误码索引 |
onVideoRenderingTracingResult | connection: RtcConnection, uid: number, currentEvent: MediaTraceEvent, tracingInfo: VideoRenderingTracingInfo | void | 错误码索引 |
onVideoSizeChanged | connection: RtcConnection, sourceType: VideoSourceType, uid: number, width: number, height: number, rotation: number | void | 错误码索引 |
onVideoStopped | — | void | 错误码索引 |
onVideoSubscribeStateChanged | channel: string, uid: number, oldState: StreamSubscribeState, newState: StreamSubscribeState, elapseSinceLastState: number | void | 错误码索引 |
IRtcEngineEx 46 方法 / 0 属性
addVideoWatermarkEx(watermarkUrl: string, options: WatermarkOptions, connection: RtcConnection): number
addVideoWatermarkWithConfigEx(config: WatermarkConfig, connection: RtcConnection): number
adjustUserPlaybackSignalVolumeEx(uid: number, volume: number, connection: RtcConnection): number
clearVideoWatermarkEx(connection: RtcConnection): number
createDataStreamEx(config: DataStreamConfig, connection: RtcConnection): number
enableAudioVolumeIndicationEx(interval: number, smooth: number, reportVad: boolean, connection: RtcConnection): number
enableContentInspectEx(enabled: boolean, config: ContentInspectConfig, connection: RtcConnection): number
enableDualStreamModeEx(enabled: boolean, streamConfig: SimulcastStreamConfig, connection: RtcConnection): number
enableEncryptionEx(connection: RtcConnection, enabled: boolean, config: EncryptionConfig): number
getCallIdEx(connection: RtcConnection): string
getConnectionStateEx(connection: RtcConnection): ConnectionStateType
joinChannelEx(token: string, connection: RtcConnection, options: ChannelMediaOptions): number
leaveChannelEx(connection: RtcConnection, options?: LeaveChannelOptions): number
muteAllRemoteAudioStreamsEx(mute: boolean, connection: RtcConnection): number
muteAllRemoteVideoStreamsEx(mute: boolean, connection: RtcConnection): number
muteLocalAudioStreamEx(mute: boolean, connection: RtcConnection): number
muteLocalVideoStreamEx(mute: boolean, connection: RtcConnection): number
muteRemoteAudioStreamEx(uid: number, mute: boolean, connection: RtcConnection): number
muteRemoteVideoStreamEx(uid: number, mute: boolean, connection: RtcConnection): number
pauseAllChannelMediaRelayEx(connection: RtcConnection): number
playEffectEx(connection: RtcConnection, soundId: number, filePath: string, loopCount: number, pitch: number, pan: number, gain: number, publish?: boolean, startPos?: number): number
preloadEffectEx(connection: RtcConnection, soundId: number, filePath: string, startPos?: number): number
removeVideoWatermarkEx(id: string, connection: RtcConnection): number
resumeAllChannelMediaRelayEx(connection: RtcConnection): number
sendCustomReportMessageEx(id: string, category: string, event: string, label: string, value: number, connection: RtcConnection): number
sendStreamMessageEx(streamId: number, data: Uint8Array, length: number, connection: RtcConnection): number
setDualStreamModeEx(mode: SimulcastStreamMode, streamConfig: SimulcastStreamConfig, connection: RtcConnection): number
setRemoteRenderModeEx(uid: number, renderMode: RenderModeType, mirrorMode: VideoMirrorModeType, connection: RtcConnection): number
setRemoteVideoStreamTypeEx(uid: number, streamType: VideoStreamType, connection: RtcConnection): number
setRemoteVideoSubscriptionOptionsEx(uid: number, options: VideoSubscriptionOptions, connection: RtcConnection): number
setRemoteVoicePositionEx(uid: number, pan: number, gain: number, connection: RtcConnection): number
setSubscribeAudioAllowlistEx(uidList: number[], uidNumber: number, connection: RtcConnection): number
setSubscribeAudioBlocklistEx(uidList: number[], uidNumber: number, connection: RtcConnection): number
setSubscribeVideoAllowlistEx(uidList: number[], uidNumber: number, connection: RtcConnection): number
setSubscribeVideoBlocklistEx(uidList: number[], uidNumber: number, connection: RtcConnection): number
setVideoEncoderConfigurationEx(config: VideoEncoderConfiguration, connection: RtcConnection): number
startMediaRenderingTracingEx(connection: RtcConnection): number
startOrUpdateChannelMediaRelayEx(configuration: ChannelMediaRelayConfiguration, connection: RtcConnection): number
startRtmpStreamWithTranscodingEx(url: string, transcoding: LiveTranscoding, connection: RtcConnection): number
startRtmpStreamWithoutTranscodingEx(url: string, connection: RtcConnection): number
stopChannelMediaRelayEx(connection: RtcConnection): number
stopRtmpStreamEx(url: string, connection: RtcConnection): number
takeSnapshotEx(connection: RtcConnection, uid: number, filePath: string): number
takeSnapshotWithConfigEx(connection: RtcConnection, uid: number, config: SnapshotConfig): number
updateChannelMediaOptionsEx(options: ChannelMediaOptions, connection: RtcConnection): number
updateRtmpTranscodingEx(transcoding: LiveTranscoding, connection: RtcConnection): number方法明细:46 / 46(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
addVideoWatermarkEx | watermarkUrl: string, options: WatermarkOptions, connection: RtcConnection | number | 错误码索引 |
addVideoWatermarkWithConfigEx | config: WatermarkConfig, connection: RtcConnection | number | 错误码索引 |
adjustUserPlaybackSignalVolumeEx | uid: number, volume: number, connection: RtcConnection | number | 错误码索引 |
clearVideoWatermarkEx | connection: RtcConnection | number | 错误码索引 |
createDataStreamEx | config: DataStreamConfig, connection: RtcConnection | number | 错误码索引 |
enableAudioVolumeIndicationEx | interval: number, smooth: number, reportVad: boolean, connection: RtcConnection | number | 错误码索引 |
enableContentInspectEx | enabled: boolean, config: ContentInspectConfig, connection: RtcConnection | number | 错误码索引 |
enableDualStreamModeEx | enabled: boolean, streamConfig: SimulcastStreamConfig, connection: RtcConnection | number | 错误码索引 |
enableEncryptionEx | connection: RtcConnection, enabled: boolean, config: EncryptionConfig | number | 错误码索引 |
getCallIdEx | connection: RtcConnection | string | 错误码索引 |
getConnectionStateEx | connection: RtcConnection | ConnectionStateType | 错误码索引 |
joinChannelEx | token: string, connection: RtcConnection, options: ChannelMediaOptions | number | 错误码索引 |
leaveChannelEx | connection: RtcConnection, options?: LeaveChannelOptions | number | 错误码索引 |
muteAllRemoteAudioStreamsEx | mute: boolean, connection: RtcConnection | number | 错误码索引 |
muteAllRemoteVideoStreamsEx | mute: boolean, connection: RtcConnection | number | 错误码索引 |
muteLocalAudioStreamEx | mute: boolean, connection: RtcConnection | number | 错误码索引 |
muteLocalVideoStreamEx | mute: boolean, connection: RtcConnection | number | 错误码索引 |
muteRemoteAudioStreamEx | uid: number, mute: boolean, connection: RtcConnection | number | 错误码索引 |
muteRemoteVideoStreamEx | uid: number, mute: boolean, connection: RtcConnection | number | 错误码索引 |
pauseAllChannelMediaRelayEx | connection: RtcConnection | number | 错误码索引 |
playEffectEx | connection: RtcConnection, soundId: number, filePath: string, loopCount: number, pitch: number, pan: number, gain: number, publish?: boolean, startPos?: number | number | 错误码索引 |
preloadEffectEx | connection: RtcConnection, soundId: number, filePath: string, startPos?: number | number | 错误码索引 |
removeVideoWatermarkEx | id: string, connection: RtcConnection | number | 错误码索引 |
resumeAllChannelMediaRelayEx | connection: RtcConnection | number | 错误码索引 |
sendCustomReportMessageEx | id: string, category: string, event: string, label: string, value: number, connection: RtcConnection | number | 错误码索引 |
sendStreamMessageEx | streamId: number, data: Uint8Array, length: number, connection: RtcConnection | number | 错误码索引 |
setDualStreamModeEx | mode: SimulcastStreamMode, streamConfig: SimulcastStreamConfig, connection: RtcConnection | number | 错误码索引 |
setRemoteRenderModeEx | uid: number, renderMode: RenderModeType, mirrorMode: VideoMirrorModeType, connection: RtcConnection | number | 错误码索引 |
setRemoteVideoStreamTypeEx | uid: number, streamType: VideoStreamType, connection: RtcConnection | number | 错误码索引 |
setRemoteVideoSubscriptionOptionsEx | uid: number, options: VideoSubscriptionOptions, connection: RtcConnection | number | 错误码索引 |
setRemoteVoicePositionEx | uid: number, pan: number, gain: number, connection: RtcConnection | number | 错误码索引 |
setSubscribeAudioAllowlistEx | uidList: number[], uidNumber: number, connection: RtcConnection | number | 错误码索引 |
setSubscribeAudioBlocklistEx | uidList: number[], uidNumber: number, connection: RtcConnection | number | 错误码索引 |
setSubscribeVideoAllowlistEx | uidList: number[], uidNumber: number, connection: RtcConnection | number | 错误码索引 |
setSubscribeVideoBlocklistEx | uidList: number[], uidNumber: number, connection: RtcConnection | number | 错误码索引 |
setVideoEncoderConfigurationEx | config: VideoEncoderConfiguration, connection: RtcConnection | number | 错误码索引 |
startMediaRenderingTracingEx | connection: RtcConnection | number | 错误码索引 |
startOrUpdateChannelMediaRelayEx | configuration: ChannelMediaRelayConfiguration, connection: RtcConnection | number | 错误码索引 |
startRtmpStreamWithTranscodingEx | url: string, transcoding: LiveTranscoding, connection: RtcConnection | number | 错误码索引 |
startRtmpStreamWithoutTranscodingEx | url: string, connection: RtcConnection | number | 错误码索引 |
stopChannelMediaRelayEx | connection: RtcConnection | number | 错误码索引 |
stopRtmpStreamEx | url: string, connection: RtcConnection | number | 错误码索引 |
takeSnapshotEx | connection: RtcConnection, uid: number, filePath: string | number | 错误码索引 |
takeSnapshotWithConfigEx | connection: RtcConnection, uid: number, config: SnapshotConfig | number | 错误码索引 |
updateChannelMediaOptionsEx | options: ChannelMediaOptions, connection: RtcConnection | number | 错误码索引 |
updateRtmpTranscodingEx | transcoding: LiveTranscoding, connection: RtcConnection | number | 错误码索引 |
IVideoEffectObject 9 方法 / 0 属性
addOrUpdateVideoEffect(nodeId: number, templateName: string): number
getVideoEffectBoolParam(option: string, key: string): boolean
getVideoEffectFloatParam(option: string, key: string): number
getVideoEffectIntParam(option: string, key: string): number
performVideoEffectAction(nodeId: number, actionId: VideoEffectAction): number
removeVideoEffect(nodeId: number): number
setVideoEffectBoolParam(option: string, key: string, param: boolean): number
setVideoEffectFloatParam(option: string, key: string, param: number): number
setVideoEffectIntParam(option: string, key: string, param: number): number方法明细:9 / 9(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
addOrUpdateVideoEffect | nodeId: number, templateName: string | number | 错误码索引 |
getVideoEffectBoolParam | option: string, key: string | boolean | 错误码索引 |
getVideoEffectFloatParam | option: string, key: string | number | 错误码索引 |
getVideoEffectIntParam | option: string, key: string | number | 错误码索引 |
performVideoEffectAction | nodeId: number, actionId: VideoEffectAction | number | 错误码索引 |
removeVideoEffect | nodeId: number | number | 错误码索引 |
setVideoEffectBoolParam | option: string, key: string, param: boolean | number | 错误码索引 |
setVideoEffectFloatParam | option: string, key: string, param: number | number | 错误码索引 |
setVideoEffectIntParam | option: string, key: string, param: number | number | 错误码索引 |
IVideoEncodedFrameObserver 1 方法 / 0 属性
onEncodedVideoFrameReceived(channelId: string, uid: number, imageBuffer: Uint8Array, length: number, videoEncodedFrameInfo: EncodedVideoFrameInfo): void方法明细:1 / 1(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
onEncodedVideoFrameReceived | channelId: string, uid: number, imageBuffer: Uint8Array, length: number, videoEncodedFrameInfo: EncodedVideoFrameInfo | void | 错误码索引 |
IVideoFrameObserver 3 方法 / 0 属性
onCaptureVideoFrame(sourceType: VideoSourceType, videoFrame: VideoFrame): void
onPreEncodeVideoFrame(sourceType: VideoSourceType, videoFrame: VideoFrame): void
onRenderVideoFrame(channelId: string, remoteUid: number, videoFrame: VideoFrame): void方法明细:3 / 3(参数、返回值、错误码)
LastmileProbeConfig 0 方法 / 4 属性
| 属性 | 类型 | 只读 |
|---|---|---|
probeUplink | unknown | 否 |
probeDownlink | unknown | 否 |
expectedUplinkBitrate | unknown | 否 |
expectedDownlinkBitrate | unknown | 否 |
LastmileProbeOneWayResult 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
packetLossRate | unknown | 否 |
jitter | unknown | 否 |
availableBandwidth | unknown | 否 |
LastmileProbeResult 0 方法 / 4 属性
| 属性 | 类型 | 只读 |
|---|---|---|
state | unknown | 否 |
uplinkReport | unknown | 否 |
downlinkReport | unknown | 否 |
rtt | unknown | 否 |
LeaveChannelOptions 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
stopAudioMixing | unknown | 否 |
stopAllEffect | unknown | 否 |
stopMicrophoneRecording | unknown | 否 |
LiveStreamAdvancedFeature 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
featureName | unknown | 否 |
opened | unknown | 否 |
LiveTranscoding 0 方法 / 23 属性
| 属性 | 类型 | 只读 |
|---|---|---|
width | unknown | 否 |
height | unknown | 否 |
videoBitrate | unknown | 否 |
videoFramerate | unknown | 否 |
lowLatency | unknown | 否 |
videoGop | unknown | 否 |
videoCodecProfile | unknown | 否 |
videoCodecType | unknown | 否 |
transcodingUsers | unknown | 否 |
transcodingExtraInfo | unknown | 否 |
backgroundColor | unknown | 否 |
userCount | unknown | 否 |
metadata | unknown | 否 |
watermark | unknown | 否 |
backgroundImage | unknown | 否 |
audioSampleRate | unknown | 否 |
audioBitrate | unknown | 否 |
audioChannels | unknown | 否 |
audioCodecProfile | unknown | 否 |
watermarkCount | unknown | 否 |
backgroundImageCount | unknown | 否 |
advancedFeatures | unknown | 否 |
advancedFeatureCount | unknown | 否 |
LocalAccessPointConfiguration 0 方法 / 7 属性
| 属性 | 类型 | 只读 |
|---|---|---|
ipList | unknown | 否 |
ipListSize | unknown | 否 |
domainList | unknown | 否 |
domainListSize | unknown | 否 |
verifyDomainName | unknown | 否 |
mode | unknown | 否 |
advancedConfig | unknown | 否 |
LocalAudioMixerConfiguration 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
streamCount | unknown | 否 |
audioInputStreams | unknown | 否 |
syncWithLocalMic | unknown | 否 |
LocalAudioStats 0 方法 / 8 属性
| 属性 | 类型 | 只读 |
|---|---|---|
numChannels | unknown | 否 |
sentSampleRate | unknown | 否 |
sentBitrate | unknown | 否 |
txPacketLossRate | unknown | 否 |
internalCodec | unknown | 否 |
audioDeviceDelay | unknown | 否 |
earMonitorDelay | unknown | 否 |
aecEstimatedDelay | unknown | 否 |
LocalTranscoderConfiguration 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
streamCount | unknown | 否 |
videoInputStreams | unknown | 否 |
videoOutputConfiguration | unknown | 否 |
LocalVideoStats 0 方法 / 22 属性
| 属性 | 类型 | 只读 |
|---|---|---|
uid | unknown | 否 |
sentBitrate | unknown | 否 |
sentFrameRate | unknown | 否 |
captureFrameRate | unknown | 否 |
captureFrameWidth | unknown | 否 |
captureFrameHeight | unknown | 否 |
regulatedCaptureFrameRate | unknown | 否 |
regulatedCaptureFrameWidth | unknown | 否 |
regulatedCaptureFrameHeight | unknown | 否 |
encoderOutputFrameRate | unknown | 否 |
rendererOutputFrameRate | unknown | 否 |
targetBitrate | unknown | 否 |
targetFrameRate | unknown | 否 |
qualityAdaptIndication | unknown | 否 |
encodedBitrate | unknown | 否 |
encodedFrameHeight | unknown | 否 |
encodedFrameWidth | unknown | 否 |
encodedFrameCount | unknown | 否 |
codecType | unknown | 否 |
txPacketLossRate | unknown | 否 |
captureBrightnessLevel | unknown | 否 |
hwEncoderAccelerating | unknown | 否 |
LogConfig 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
filePath | unknown | 否 |
fileSizeInKB | unknown | 否 |
level | unknown | 否 |
LogUploadServerInfo 0 方法 / 4 属性
| 属性 | 类型 | 只读 |
|---|---|---|
serverDomain | unknown | 否 |
serverPath | unknown | 否 |
serverPort | unknown | 否 |
serverHttps | unknown | 否 |
LowlightEnhanceOptions 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
level | unknown | 否 |
mode | unknown | 否 |
MediaRecorderConfiguration 0 方法 / 11 属性
| 属性 | 类型 | 只读 |
|---|---|---|
storagePath | unknown | 否 |
containerFormat | unknown | 否 |
streamType | unknown | 否 |
maxDurationMs | unknown | 否 |
recorderInfoUpdateInterval | unknown | 否 |
width | unknown | 否 |
height | unknown | 否 |
fps | unknown | 否 |
sample_rate | unknown | 否 |
channel_num | unknown | 否 |
videoSourceType | unknown | 否 |
MediaSource 0 方法 / 8 属性
| 属性 | 类型 | 只读 |
|---|---|---|
url | unknown | 否 |
uri | unknown | 否 |
startPos | unknown | 否 |
autoPlay | unknown | 否 |
enableCache | unknown | 否 |
enableMultiAudioTrack | unknown | 否 |
isAgoraSource | unknown | 否 |
isLiveSource | unknown | 否 |
Metadata 0 方法 / 5 属性
| 属性 | 类型 | 只读 |
|---|---|---|
channelId | unknown | 否 |
uid | unknown | 否 |
size | unknown | 否 |
buffer | unknown | 否 |
timeStampMs | unknown | 否 |
MixedAudioStream 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
sourceType | unknown | 否 |
remoteUserUid | unknown | 否 |
trackId | unknown | 否 |
MultipathStats 0 方法 / 8 属性
| 属性 | 类型 | 只读 |
|---|---|---|
lanTxBytes | unknown | 否 |
lanRxBytes | unknown | 否 |
wifiTxBytes | unknown | 否 |
wifiRxBytes | unknown | 否 |
mobileTxBytes | unknown | 否 |
mobileRxBytes | unknown | 否 |
activePathNum | unknown | 否 |
pathStats | unknown | 否 |
Music 0 方法 / 12 属性
| 属性 | 类型 | 只读 |
|---|---|---|
songCode | unknown | 否 |
name | unknown | 否 |
singer | unknown | 否 |
poster | unknown | 否 |
releaseTime | unknown | 否 |
type | unknown | 否 |
pitchType | unknown | 否 |
durationS | unknown | 否 |
lyricList | unknown | 否 |
climaxSegmentList | unknown | 否 |
lyricCount | unknown | 否 |
climaxSegmentCount | unknown | 否 |
MusicCacheInfo 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
songCode | unknown | 否 |
status | unknown | 否 |
MusicChartCollection 2 方法 / 0 属性
get(index: number): MusicChartInfo
getCount(): number方法明细:2 / 2(参数、返回值、错误码)
MusicChartInfo 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
chartName | unknown | 否 |
id | unknown | 否 |
MusicCollection 5 方法 / 0 属性
getCount(): number
getMusic(index: number): Music
getPage(): number
getPageSize(): unknown
getTotal(): number方法明细:5 / 5(参数、返回值、错误码)
MusicContentCenterConfiguration 0 方法 / 4 属性
| 属性 | 类型 | 只读 |
|---|---|---|
appId | unknown | 否 |
token | unknown | 否 |
mccUid | unknown | 否 |
maxCacheSize | unknown | 否 |
PathStats 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
type | unknown | 否 |
txKBitRate | unknown | 否 |
rxKBitRate | unknown | 否 |
PlayerPlaybackStats 0 方法 / 4 属性
| 属性 | 类型 | 只读 |
|---|---|---|
videoFps | unknown | 否 |
videoBitrateInKbps | unknown | 否 |
audioBitrateInKbps | unknown | 否 |
totalBitrateInKbps | unknown | 否 |
PlayerStreamInfo 0 方法 / 13 属性
| 属性 | 类型 | 只读 |
|---|---|---|
streamIndex | unknown | 否 |
streamType | unknown | 否 |
codecName | unknown | 否 |
language | unknown | 否 |
videoFrameRate | unknown | 否 |
videoBitRate | unknown | 否 |
videoWidth | unknown | 否 |
videoHeight | unknown | 否 |
videoRotation | unknown | 否 |
audioSampleRate | unknown | 否 |
audioChannels | unknown | 否 |
audioBitsPerSample | unknown | 否 |
duration | unknown | 否 |
PlayerUpdatedInfo 0 方法 / 6 属性
| 属性 | 类型 | 只读 |
|---|---|---|
deviceId | unknown | 否 |
videoHeight | unknown | 否 |
videoWidth | unknown | 否 |
audioSampleRate | unknown | 否 |
audioChannels | unknown | 否 |
audioBitsPerSample | unknown | 否 |
RecorderInfo 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
fileName | unknown | 否 |
durationMs | unknown | 否 |
fileSize | unknown | 否 |
RecorderStreamInfo 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
channelId | unknown | 否 |
uid | unknown | 否 |
type | unknown | 否 |
Rectangle 0 方法 / 4 属性
| 属性 | 类型 | 只读 |
|---|---|---|
x | unknown | 否 |
y | unknown | 否 |
width | unknown | 否 |
height | unknown | 否 |
RemoteAudioStats 0 方法 / 16 属性
| 属性 | 类型 | 只读 |
|---|---|---|
uid | unknown | 否 |
quality | unknown | 否 |
networkTransportDelay | unknown | 否 |
jitterBufferDelay | unknown | 否 |
audioLossRate | unknown | 否 |
numChannels | unknown | 否 |
receivedSampleRate | unknown | 否 |
receivedBitrate | unknown | 否 |
totalFrozenTime | unknown | 否 |
frozenRate | unknown | 否 |
totalActiveTime | unknown | 否 |
publishDuration | unknown | 否 |
qoeQuality | unknown | 否 |
qualityChangedReason | unknown | 否 |
mosValue | unknown | 否 |
e2eDelay | unknown | 否 |
RemoteVideoStats 0 方法 / 17 属性
| 属性 | 类型 | 只读 |
|---|---|---|
uid | unknown | 否 |
delay | unknown | 否 |
e2eDelay | unknown | 否 |
width | unknown | 否 |
height | unknown | 否 |
receivedBitrate | unknown | 否 |
decoderOutputFrameRate | unknown | 否 |
rendererOutputFrameRate | unknown | 否 |
frameLossRate | unknown | 否 |
packetLossRate | unknown | 否 |
rxStreamType | unknown | 否 |
totalFrozenTime | unknown | 否 |
frozenRate | unknown | 否 |
totalActiveTime | unknown | 否 |
publishDuration | unknown | 否 |
avSyncTimeMs | unknown | 否 |
mosValue | unknown | 否 |
RemoteVoicePositionInfo 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
position | unknown | 否 |
forward | unknown | 否 |
RtcConnection 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
channelId | unknown | 否 |
localUid | unknown | 否 |
RtcEngineContext 0 方法 / 7 属性
| 属性 | 类型 | 只读 |
|---|---|---|
appId | unknown | 否 |
channelProfile | unknown | 否 |
audioScenario | unknown | 否 |
areaCode | unknown | 否 |
logConfig | unknown | 否 |
domainLimit | unknown | 否 |
autoRegisterAgoraExtensions | unknown | 否 |
RtcImage 0 方法 / 7 属性
| 属性 | 类型 | 只读 |
|---|---|---|
url | unknown | 否 |
x | unknown | 否 |
y | unknown | 否 |
width | unknown | 否 |
height | unknown | 否 |
zOrder | unknown | 否 |
alpha | unknown | 否 |
RtcRendererViewProps 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
canvas | unknown | 否 |
connection | unknown | 否 |
RtcStats 0 方法 / 24 属性
| 属性 | 类型 | 只读 |
|---|---|---|
duration | unknown | 否 |
txBytes | unknown | 否 |
rxBytes | unknown | 否 |
txAudioBytes | unknown | 否 |
txVideoBytes | unknown | 否 |
rxAudioBytes | unknown | 否 |
rxVideoBytes | unknown | 否 |
txKBitRate | unknown | 否 |
rxKBitRate | unknown | 否 |
rxAudioKBitRate | unknown | 否 |
txAudioKBitRate | unknown | 否 |
rxVideoKBitRate | unknown | 否 |
txVideoKBitRate | unknown | 否 |
lastmileDelay | unknown | 否 |
txPacketLossRate | unknown | 否 |
rxPacketLossRate | unknown | 否 |
userCount | unknown | 否 |
cpuAppUsage | unknown | 否 |
cpuTotalUsage | unknown | 否 |
connectTimeMs | unknown | 否 |
gatewayRtt | unknown | 否 |
memoryAppUsageRatio | unknown | 否 |
memoryTotalUsageRatio | unknown | 否 |
memoryAppUsageInKbytes | unknown | 否 |
RtcSurfaceViewProps 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
zOrderOnTop | unknown | 否 |
zOrderMediaOverlay | unknown | 否 |
ScreenAudioParameters 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
sampleRate | unknown | 否 |
channels | unknown | 否 |
captureSignalVolume | unknown | 否 |
ScreenCaptureParameters2 0 方法 / 4 属性
| 属性 | 类型 | 只读 |
|---|---|---|
captureAudio | unknown | 否 |
audioParams | unknown | 否 |
captureVideo | unknown | 否 |
videoParams | unknown | 否 |
ScreenVideoParameters 0 方法 / 4 属性
| 属性 | 类型 | 只读 |
|---|---|---|
dimensions | unknown | 否 |
frameRate | unknown | 否 |
bitrate | unknown | 否 |
contentHint | unknown | 否 |
SDKBuildInfo 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
build | unknown | 否 |
version | unknown | 否 |
SegmentationProperty 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
modelType | unknown | 否 |
greenCapacity | unknown | 否 |
screenColorType | unknown | 否 |
SimulcastStreamConfig 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
dimensions | unknown | 否 |
kBitrate | unknown | 否 |
framerate | unknown | 否 |
SnapshotConfig 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
filePath | unknown | 否 |
position | unknown | 否 |
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 | unknown | 否 |
position | unknown | 否 |
forward | unknown | 否 |
right | unknown | 否 |
up | unknown | 否 |
forwardLength | unknown | 否 |
rightLength | unknown | 否 |
upLength | unknown | 否 |
audioAttenuation | unknown | 否 |
SrcInfo 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
bitrateInKbps | unknown | 否 |
name | unknown | 否 |
TranscodingUser 0 方法 / 8 属性
| 属性 | 类型 | 只读 |
|---|---|---|
uid | unknown | 否 |
x | unknown | 否 |
y | unknown | 否 |
width | unknown | 否 |
height | unknown | 否 |
zOrder | unknown | 否 |
alpha | unknown | 否 |
audioChannel | unknown | 否 |
TranscodingVideoStream 0 方法 / 11 属性
| 属性 | 类型 | 只读 |
|---|---|---|
sourceType | unknown | 否 |
remoteUserUid | unknown | 否 |
imageUrl | unknown | 否 |
mediaPlayerId | unknown | 否 |
x | unknown | 否 |
y | unknown | 否 |
width | unknown | 否 |
height | unknown | 否 |
zOrder | unknown | 否 |
alpha | unknown | 否 |
mirror | unknown | 否 |
UplinkNetworkInfo 0 方法 / 1 属性
| 属性 | 类型 | 只读 |
|---|---|---|
video_encoder_target_bitrate_bps | unknown | 否 |
UserAudioSpectrumInfo 0 方法 / 1 属性
| 属性 | 类型 | 只读 |
|---|---|---|
uid | unknown | 否 |
UserInfo 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
uid | unknown | 否 |
userAccount | unknown | 否 |
VideoCanvas 0 方法 / 11 属性
| 属性 | 类型 | 只读 |
|---|---|---|
uid | any | 否 |
subviewUid | unknown | 否 |
view | unknown | 否 |
renderMode | unknown | 否 |
mirrorMode | RenderModeType | 否 |
sourceType | unknown | 否 |
setupMode | VideoMirrorModeType | 否 |
mediaPlayerId | VideoSourceType | 否 |
cropArea | unknown | 否 |
backgroundColor | unknown | 否 |
position | unknown | 否 |
VideoDenoiserOptions 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
level | unknown | 否 |
mode | unknown | 否 |
VideoDeviceInfo 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
deviceId | unknown | 否 |
deviceName | unknown | 否 |
VideoDimensions 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
width | unknown | 否 |
height | unknown | 否 |
VideoEncoderConfiguration 0 方法 / 9 属性
| 属性 | 类型 | 只读 |
|---|---|---|
dimensions | unknown | 否 |
codecType | unknown | 否 |
frameRate | unknown | 否 |
bitrate | unknown | 否 |
minBitrate | unknown | 否 |
orientationMode | unknown | 否 |
degradationPreference | unknown | 否 |
mirrorMode | unknown | 否 |
advanceOptions | unknown | 否 |
VideoFormat 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
width | unknown | 否 |
height | unknown | 否 |
fps | unknown | 否 |
VideoFrame 0 方法 / 20 属性
| 属性 | 类型 | 只读 |
|---|---|---|
type | avsync_ | 否 |
width | unknown | 否 |
height | unknown | 否 |
yStride | unknown | 否 |
uStride | unknown | 否 |
vStride | unknown | 否 |
yBuffer | unknown | 否 |
uBuffer | unknown | 否 |
vBuffer | unknown | 否 |
rotation | unknown | 否 |
renderTimeMs | unknown | 否 |
avsync_type | unknown | 否 |
metadata_buffer | unknown | 否 |
metadata_size | unknown | 否 |
textureId | unknown | 否 |
matrix | unknown | 否 |
colorSpace | unknown | 否 |
alphaBuffer | unknown | 否 |
alphaStitchMode | unknown | 否 |
metaInfo | unknown | 否 |
VideoLayout 0 方法 / 8 属性
| 属性 | 类型 | 只读 |
|---|---|---|
channelId | unknown | 否 |
uid | unknown | 否 |
strUid | unknown | 否 |
x | unknown | 否 |
y | unknown | 否 |
width | unknown | 否 |
height | unknown | 否 |
videoState | unknown | 否 |
VideoRenderingTracingInfo 0 方法 / 7 属性
| 属性 | 类型 | 只读 |
|---|---|---|
elapsedTime | unknown | 否 |
start2JoinChannel | unknown | 否 |
join2JoinSuccess | unknown | 否 |
joinSuccess2RemoteJoined | unknown | 否 |
remoteJoined2SetView | unknown | 否 |
remoteJoined2UnmuteVideo | unknown | 否 |
remoteJoined2PacketReceived | unknown | 否 |
VideoSubscriptionOptions 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
type | unknown | 否 |
encodedFrameOnly | unknown | 否 |
VirtualBackgroundSource 0 方法 / 4 属性
| 属性 | 类型 | 只读 |
|---|---|---|
background_source_type | unknown | 否 |
color | unknown | 否 |
source | unknown | 否 |
blur_degree | unknown | 否 |
WatermarkBuffer 0 方法 / 5 属性
| 属性 | 类型 | 只读 |
|---|---|---|
width | unknown | 否 |
height | unknown | 否 |
length | unknown | 否 |
format | unknown | 否 |
buffer | unknown | 否 |
WatermarkConfig 0 方法 / 7 属性
| 属性 | 类型 | 只读 |
|---|---|---|
id | unknown | 否 |
type | unknown | 否 |
buffer | unknown | 否 |
timestamp | unknown | 否 |
literal | unknown | 否 |
imageUrl | unknown | 否 |
options | unknown | 否 |
WatermarkLiteral 0 方法 / 4 属性
| 属性 | 类型 | 只读 |
|---|---|---|
fontSize | unknown | 否 |
strokeWidth | unknown | 否 |
wmLiteral | unknown | 否 |
fontFilePath | unknown | 否 |
WatermarkOptions 0 方法 / 6 属性
| 属性 | 类型 | 只读 |
|---|---|---|
visibleInPreview | unknown | 否 |
positionInLandscapeMode | unknown | 否 |
positionInPortraitMode | unknown | 否 |
watermarkRatio | unknown | 否 |
mode | unknown | 否 |
zOrder | unknown | 否 |
WatermarkRatio 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
xRatio | unknown | 否 |
yRatio | unknown | 否 |
widthRatio | unknown | 否 |
WatermarkTimestamp 0 方法 / 4 属性
| 属性 | 类型 | 只读 |
|---|---|---|
fontSize | unknown | 否 |
fontFilePath | unknown | 否 |
strokeWidth | unknown | 否 |
format | unknown | 否 |
枚举
| 枚举 | 成员数 | 示例值 |
|---|---|---|
AgoraPipState | 3 | pipStateStarted = 0 |
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 | AudioMixingDualMonoModeAuto = 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 | 8 | 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 | 4 | BackgroundColor = 1 |
CameraDirection | 2 | CameraRear = 0 |
CameraFocalLengthType | 4 | CameraFocalLengthDefault = 0 |
CameraStabilizationMode | 5 | CameraStabilizationModeOff = -1 |
CaptureBrightnessLevelType | 4 | CAPTURE_BRIGHTNESS_LEVEL_INVALID = -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 |
FrameRate | 6 | FrameRateFps1 = 1 |
HeadphoneEqualizerPreset | 3 | HeadphoneEqualizerOff = null |
InterfaceIdType | 7 | AgoraIidAudioDeviceManager = 1 |
LastmileProbeResultState | 3 | LastmileProbeResultComplete = 1 |
LighteningContrastLevel | 3 | LighteningContrastLow = 0 |
LocalAudioStreamReason | 7 | LocalAudioStreamReasonOk = 0 |
LocalAudioStreamState | 4 | LocalAudioStreamStateStopped = 0 |
LocalProxyMode | 2 | ConnectivityFirst = 0 |
LocalVideoEventType | 6 | LocalVideoEventTypeScreenCaptureWindowHidden = 1 |
LocalVideoStreamReason | 11 | 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 | 2 | 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 |
ScreenColorType | 3 | ScreenColorAuto = 0 |
ScreenScenarioType | 4 | ScreenScenarioDocument = 1 |
SegModelType | 2 | SegModelAi = 1 |
SimulcastStreamMode | 3 | AutoSimulcastStream = -1 |
STREAM_FALLBACK_OPTIONS | 3 | StreamFallbackOptionDisabled = 0 |
StreamPublishState | 4 | PubStateIdle = 0 |
StreamSubscribeState | 4 | SubStateIdle = 0 |
UserOfflineReasonType | 3 | UserOfflineQuit = 0 |
VIDEO_CODEC_CAPABILITY_LEVEL | 5 | CodecCapabilityLevelUnspecified = -1 |
VideoApplicationScenarioType | 4 | ApplicationScenarioGeneral = 0 |
VideoBufferType | 3 | VideoBufferRawData = 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 | 4 | VideoPixelDefault = 0 |
VideoSourceType | 17 | 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 | 0 |
pipStateStopped | 1 |
pipStateFailed | 2 |
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 个成员
| 成员 | 值 |
|---|---|
AudioMixingDualMonoModeAuto | 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 8 个成员
| 成员 | 值 |
|---|---|
RouteDefault | -1 |
RouteHeadset | 0 |
RouteEarpiece | 1 |
RouteHeadsetNoMic | 2 |
RouteSpeakerphone | 3 |
RouteLoudspeaker | 4 |
RouteBluetoothDeviceHFP | 5 |
RouteBluetoothDeviceA2DP | 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 4 个成员
| 成员 | 值 |
|---|---|
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 个成员
| 成员 | 值 |
|---|---|
CAPTURE_BRIGHTNESS_LEVEL_INVALID | -1 |
CAPTURE_BRIGHTNESS_LEVEL_NORMAL | 0 |
CAPTURE_BRIGHTNESS_LEVEL_BRIGHT | 1 |
CAPTURE_BRIGHTNESS_LEVEL_DARK | 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 |
IRtcEngine | 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 |
ErrCertRaw | 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 |
FrameRate 6 个成员
| 成员 | 值 |
|---|---|
FrameRateFps1 | 1 |
FrameRateFps7 | 7 |
FrameRateFps10 | 10 |
FrameRateFps15 | 15 |
FrameRateFps24 | 24 |
FrameRateFps30 | 30 |
HeadphoneEqualizerPreset 3 个成员
| 成员 | 值 |
|---|---|
HeadphoneEqualizerOff | null |
HeadphoneEqualizerOverear | null |
HeadphoneEqualizerInear | null |
InterfaceIdType 7 个成员
| 成员 | 值 |
|---|---|
AgoraIidAudioDeviceManager | 1 |
AgoraIidVideoDeviceManager | 2 |
AgoraIidRtcEngineParameter | 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 7 个成员
| 成员 | 值 |
|---|---|
LocalAudioStreamReasonOk | 0 |
LocalAudioStreamReasonFailure | 1 |
LocalAudioStreamReasonDeviceNoPermission | 2 |
LocalAudioStreamReasonDeviceBusy | 3 |
LocalAudioStreamReasonRecordFailure | 4 |
LocalAudioStreamReasonEncodeFailure | 5 |
LocalAudioStreamReasonInterrupted | 8 |
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 11 个成员
| 成员 | 值 |
|---|---|
LocalVideoStreamReasonOk | 0 |
LocalVideoStreamReasonFailure | 1 |
LocalVideoStreamReasonDeviceNoPermission | 2 |
LocalVideoStreamReasonDeviceBusy | 3 |
LocalVideoStreamReasonCaptureFailure | 4 |
LocalVideoStreamReasonCodecNotSupport | 5 |
LocalVideoStreamReasonCaptureInbackground | 6 |
LocalVideoStreamReasonCaptureMultipleForegroundApps | 7 |
LocalVideoStreamReasonDeviceNotFound | 8 |
LocalVideoStreamReasonDeviceInterrupt | 14 |
LocalVideoStreamReasonDeviceFatalError | 15 |
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 | 5 |
AudioVirtualRecordingDevice | 6 |
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 |
OrientationFixedLandscape | 1 |
OrientationFixedPortrait | 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 |
RecorderErrorWriteFailed | 1 |
RecorderErrorNoStream | 2 |
RecorderErrorOverMaxDuration | 3 |
RecorderErrorConfigChanged | 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 2 个成员
| 成员 | 值 |
|---|---|
RenderModeHidden | 1 |
RenderModeFit | 2 |
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 |
RtmpStreamUnpublishErrorOk | 100 |
RtmpStreamPublishState 6 个成员
| 成员 | 值 |
|---|---|
RtmpStreamPublishStateIdle | 0 |
RtmpStreamPublishStateConnecting | 1 |
RtmpStreamPublishStateRunning | 2 |
RtmpStreamPublishStateRecovering | 3 |
RtmpStreamPublishStateFailure | 4 |
RtmpStreamPublishStateDisconnecting | 5 |
ScreenCaptureFramerateCapability 3 个成员
| 成员 | 值 |
|---|---|
ScreenCaptureFramerateCapability15Fps | 0 |
ScreenCaptureFramerateCapability30Fps | 1 |
ScreenCaptureFramerateCapability60Fps | 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 |
STREAM_FALLBACK_OPTIONS 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 |
VIDEO_CODEC_CAPABILITY_LEVEL 5 个成员
| 成员 | 值 |
|---|---|
CodecCapabilityLevelUnspecified | -1 |
CodecCapabilityLevelBasicSupport | 5 |
CodecCapabilityLevel1080p30fps | 10 |
CodecCapabilityLevel1080p60fps | 20 |
CodecCapabilityLevel4k60fps | 30 |
VideoApplicationScenarioType 4 个成员
| 成员 | 值 |
|---|---|
ApplicationScenarioGeneral | 0 |
ApplicationScenarioMeeting | 1 |
ApplicationScenario1v1 | 2 |
ApplicationScenarioLiveshow | 3 |
VideoBufferType 3 个成员
| 成员 | 值 |
|---|---|
VideoBufferRawData | 1 |
VideoBufferArray | 2 |
VideoBufferTexture | 3 |
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 4 个成员
| 成员 | 值 |
|---|---|
VideoPixelDefault | 0 |
VideoPixelI420 | 1 |
VideoPixelRgba | 4 |
VideoPixelI422 | 16 |
VideoSourceType 17 个成员
| 成员 | 值 |
|---|---|
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 |
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 |
错误码常量
| 常量 | 值 |
|---|---|
ErrAborted | 20 |
ErrAdmGeneralError | 1005 |
ErrAdmInitPlayout | 1008 |
ErrAdmInitRecording | 1011 |
ErrAdmStartPlayout | 1009 |
ErrAdmStartRecording | 1012 |
ErrAdmStopPlayout | 1010 |
ErrAdmStopRecording | 1013 |
ErrAlreadyInUse | 19 |
ErrBitrateLimit | 115 |
ErrBufferTooSmall | 6 |
ErrCertRaw | 1001 |
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 |
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 |
IRtcEngine | null |
已知限制
以下成员在当前版本暂不可用,调用时返回 -4(ERR_NOT_SUPPORTED)。接口定义中保留这些成员,便于跨端代码保持一致。
| 接口 | 成员 |
|---|---|
AgoraPip | isPipActivated |
AgoraPip | pipDispose |
AgoraPip | pipIsAutoEnterSupported |
AgoraPip | pipIsSupported |
AgoraPip | pipSetup |
AgoraPip | pipStart |
AgoraPip | pipStop |
AgoraPip | registerPipStateChangedObserver |
AgoraPip | release |
AgoraPip | unregisterPipStateChangedObserver |
FilterEffectOptions | path |
IAudioDeviceManager | startPlaybackDeviceTest |
IAudioDeviceManager | stopPlaybackDeviceTest |
IAudioFrameObserverBase | onEarMonitoringAudioFrame |
IAudioFrameObserverBase | onMixedAudioFrame |
IAudioFrameObserverBase | onPlaybackAudioFrame |
IAudioFrameObserverBase | onRecordAudioFrame |
IBaseSpatialAudioEngine | muteAllRemoteAudioStreams |
IBaseSpatialAudioEngine | muteLocalAudioStream |
IBaseSpatialAudioEngine | muteRemoteAudioStream |
IBaseSpatialAudioEngine | release |
IBaseSpatialAudioEngine | setAudioRecvRange |
IBaseSpatialAudioEngine | setDistanceUnit |
IBaseSpatialAudioEngine | setMaxAudioRecvCount |
IBaseSpatialAudioEngine | setPlayerAttenuation |
IBaseSpatialAudioEngine | setZones |
IBaseSpatialAudioEngine | updatePlayerPositionInfo |
IBaseSpatialAudioEngine | updateSelfPosition |
ILocalSpatialAudioEngine | clearRemotePositions |
ILocalSpatialAudioEngine | initialize |
ILocalSpatialAudioEngine | removeRemotePosition |
ILocalSpatialAudioEngine | setRemoteAudioAttenuation |
ILocalSpatialAudioEngine | updateRemotePosition |
IMediaEngine | addListener |
IMediaEngine | createCustomAudioTrack |
IMediaEngine | destroyCustomAudioTrack |
IMediaEngine | pullAudioFrame |
IMediaEngine | pushAudioFrame |
IMediaEngine | pushVideoFrame |
IMediaEngine | registerAudioFrameObserver |
IMediaEngine | registerFaceInfoObserver |
IMediaEngine | registerVideoEncodedFrameObserver |
IMediaEngine | registerVideoFrameObserver |
IMediaEngine | removeAllListeners |
IMediaEngine | removeListener |
IMediaEngine | setExternalAudioSink |
IMediaEngine | setExternalAudioSource |
IMediaEngine | setExternalVideoSource |
IMediaEngine | unregisterAudioFrameObserver |
IMediaEngine | unregisterFaceInfoObserver |
IMediaEngine | unregisterVideoEncodedFrameObserver |
IMediaEngine | unregisterVideoFrameObserver |
IMediaPlayer | addListener |
IMediaPlayer | adjustPlayoutVolume |
IMediaPlayer | adjustPublishSignalVolume |
IMediaPlayer | getAudioBufferDelay |
IMediaPlayer | getDuration |
IMediaPlayer | getMediaPlayerId |
IMediaPlayer | getMute |
IMediaPlayer | getPlayPosition |
IMediaPlayer | getPlaySrc |
IMediaPlayer | getPlayoutVolume |
IMediaPlayer | getPublishSignalVolume |
IMediaPlayer | getState |
IMediaPlayer | getStreamCount |
IMediaPlayer | getStreamInfo |
IMediaPlayer | mute |
IMediaPlayer | open |
IMediaPlayer | openWithMediaSource |
IMediaPlayer | pause |
IMediaPlayer | play |
IMediaPlayer | playPreloadedSrc |
IMediaPlayer | preloadSrc |
IMediaPlayer | registerAudioFrameObserver |
IMediaPlayer | registerPlayerSourceObserver |
IMediaPlayer | registerVideoFrameObserver |
IMediaPlayer | removeAllListeners |
IMediaPlayer | removeListener |
IMediaPlayer | resume |
IMediaPlayer | seek |
IMediaPlayer | selectAudioTrack |
IMediaPlayer | selectMultiAudioTrack |
IMediaPlayer | setAudioDualMonoMode |
IMediaPlayer | setAudioPitch |
IMediaPlayer | setLoopCount |
IMediaPlayer | setPlaybackSpeed |
IMediaPlayer | setPlayerOptionInInt |
IMediaPlayer | setPlayerOptionInString |
IMediaPlayer | setRenderMode |
IMediaPlayer | setSpatialAudioParams |
IMediaPlayer | setView |
IMediaPlayer | stop |
IMediaPlayer | switchSrc |
IMediaPlayer | unloadSrc |
IMediaPlayer | unregisterAudioFrameObserver |
IMediaPlayer | unregisterPlayerSourceObserver |
IMediaPlayer | unregisterVideoFrameObserver |
IMediaPlayerCacheManager | enableAutoRemoveCache |
IMediaPlayerCacheManager | getCacheDir |
IMediaPlayerCacheManager | getCacheFileCount |
IMediaPlayerCacheManager | getMaxCacheFileCount |
IMediaPlayerCacheManager | getMaxCacheFileSize |
IMediaPlayerCacheManager | getMediaPlayerCacheManager |
IMediaPlayerCacheManager | removeAllCaches |
IMediaPlayerCacheManager | removeCacheByUri |
IMediaPlayerCacheManager | removeOldCache |
IMediaPlayerCacheManager | setCacheDir |
IMediaPlayerCacheManager | setMaxCacheFileCount |
IMediaPlayerCacheManager | setMaxCacheFileSize |
IMediaRecorder | addListener |
IMediaRecorder | removeAllListeners |
IMediaRecorder | removeListener |
IMediaRecorder | setMediaRecorderObserver |
IMediaRecorder | startRecording |
IMediaRecorder | stopRecording |
IMusicContentCenter | Preload |
IMusicContentCenter | createMusicPlayer |
IMusicContentCenter | destroyMusicPlayer |
IMusicContentCenter | getInternalSongCode |
IMusicContentCenter | getLyric |
IMusicContentCenter | getMusicCharts |
IMusicContentCenter | getMusicCollectionByMusicChartId |
IMusicContentCenter | getSongSimpleInfo |
IMusicContentCenter | initialize |
IMusicContentCenter | isPreloaded |
IMusicContentCenter | registerEventHandler |
IMusicContentCenter | release |
IMusicContentCenter | removeCache |
IMusicContentCenter | renewToken |
IMusicContentCenter | searchMusic |
IMusicContentCenter | unregisterEventHandler |
IMusicPlayer | openWithSongCode |
IMusicPlayer | setPlayMode |
IRtcEngine | addVideoWatermark |
IRtcEngine | addVideoWatermarkWithConfig |
IRtcEngine | adjustCustomAudioPlayoutVolume |
IRtcEngine | adjustCustomAudioPublishVolume |
IRtcEngine | adjustUserPlaybackSignalVolume |
IRtcEngine | clearVideoWatermarks |
IRtcEngine | configRhythmPlayer |
IRtcEngine | createAgoraRtcEngine |
IRtcEngine | createCustomVideoTrack |
IRtcEngine | createDataStream |
IRtcEngine | createMediaRecorder |
IRtcEngine | createVideoEffectObject |
IRtcEngine | destroyCustomVideoTrack |
IRtcEngine | destroyMediaRecorder |
IRtcEngine | destroyVideoEffectObject |
IRtcEngine | enableCameraCenterStage |
IRtcEngine | enableExtension |
IRtcEngine | enableFaceDetection |
IRtcEngine | enableSpatialAudio |
IRtcEngine | enableVideoImageSource |
IRtcEngine | enableVirtualBackground |
IRtcEngine | enableVoiceAITuner |
IRtcEngine | getExtensionProperty |
IRtcEngine | getFaceShapeAreaOptions |
IRtcEngine | getFaceShapeBeautyOptions |
IRtcEngine | getLocalSpatialAudioEngine |
IRtcEngine | getMediaEngine |
IRtcEngine | getMusicContentCenter |
IRtcEngine | getNativeHandle |
IRtcEngine | isCameraCenterStageSupported |
IRtcEngine | isCameraFaceDetectSupported |
IRtcEngine | joinChannelWithUserAccountEx |
IRtcEngine | loadExtensionProvider |
IRtcEngine | pauseAllChannelMediaRelay |
IRtcEngine | preloadChannelWithUserAccount |
IRtcEngine | registerAudioEncodedFrameObserver |
IRtcEngine | registerAudioSpectrumObserver |
IRtcEngine | registerExtension |
IRtcEngine | removeVideoWatermark |
IRtcEngine | resumeAllChannelMediaRelay |
IRtcEngine | setBeautyEffectOptions |
IRtcEngine | setColorEnhanceOptions |
IRtcEngine | setExtensionProperty |
IRtcEngine | setExtensionProviderProperty |
IRtcEngine | setExternalMediaProjection |
IRtcEngine | setExternalRemoteEglContext |
IRtcEngine | setFaceShapeAreaOptions |
IRtcEngine | setFaceShapeBeautyOptions |
IRtcEngine | setFilterEffectOptions |
IRtcEngine | setLowlightEnhanceOptions |
IRtcEngine | setRemoteUserSpatialAudioParams |
IRtcEngine | setVideoDenoiserOptions |
IRtcEngine | startAudioRecording |
IRtcEngine | startEchoTest |
IRtcEngine | startLastmileProbeTest |
IRtcEngine | startLocalAudioMixer |
IRtcEngine | startLocalVideoTranscoder |
IRtcEngine | startMediaRenderingTracing |
IRtcEngine | startOrUpdateChannelMediaRelay |
IRtcEngine | startRhythmPlayer |
IRtcEngine | startRtmpStreamWithTranscoding |
IRtcEngine | startRtmpStreamWithoutTranscoding |
IRtcEngine | stopAudioRecording |
IRtcEngine | stopChannelMediaRelay |
IRtcEngine | stopEchoTest |
IRtcEngine | stopLastmileProbeTest |
IRtcEngine | stopLocalAudioMixer |
IRtcEngine | stopLocalVideoTranscoder |
IRtcEngine | stopRhythmPlayer |
IRtcEngine | stopRtmpStream |
IRtcEngine | takeSnapshot |
IRtcEngine | takeSnapshotWithConfig |
IRtcEngine | unregisterAudioEncodedFrameObserver |
IRtcEngine | unregisterAudioSpectrumObserver |
IRtcEngine | updateLocalAudioMixerConfiguration |
IRtcEngine | updateLocalTranscoderConfiguration |
IRtcEngine | updateRtmpTranscoding |
IRtcEngineEx | addVideoWatermarkEx |
IRtcEngineEx | addVideoWatermarkWithConfigEx |
IRtcEngineEx | adjustUserPlaybackSignalVolumeEx |
IRtcEngineEx | clearVideoWatermarkEx |
IRtcEngineEx | createDataStreamEx |
IRtcEngineEx | enableAudioVolumeIndicationEx |
IRtcEngineEx | enableContentInspectEx |
IRtcEngineEx | enableDualStreamModeEx |
IRtcEngineEx | enableEncryptionEx |
IRtcEngineEx | getCallIdEx |
IRtcEngineEx | getConnectionStateEx |
IRtcEngineEx | joinChannelEx |
IRtcEngineEx | leaveChannelEx |
IRtcEngineEx | muteAllRemoteAudioStreamsEx |
IRtcEngineEx | muteAllRemoteVideoStreamsEx |
IRtcEngineEx | muteLocalAudioStreamEx |
IRtcEngineEx | muteLocalVideoStreamEx |
IRtcEngineEx | muteRemoteAudioStreamEx |
IRtcEngineEx | muteRemoteVideoStreamEx |
IRtcEngineEx | pauseAllChannelMediaRelayEx |
IRtcEngineEx | playEffectEx |
IRtcEngineEx | preloadEffectEx |
IRtcEngineEx | removeVideoWatermarkEx |
IRtcEngineEx | resumeAllChannelMediaRelayEx |
IRtcEngineEx | sendCustomReportMessageEx |
IRtcEngineEx | sendStreamMessageEx |
IRtcEngineEx | setDualStreamModeEx |
IRtcEngineEx | setRemoteRenderModeEx |
IRtcEngineEx | setRemoteVideoStreamTypeEx |
IRtcEngineEx | setRemoteVideoSubscriptionOptionsEx |
IRtcEngineEx | setRemoteVoicePositionEx |
IRtcEngineEx | setSubscribeAudioAllowlistEx |
IRtcEngineEx | setSubscribeAudioBlocklistEx |
IRtcEngineEx | setSubscribeVideoAllowlistEx |
IRtcEngineEx | setSubscribeVideoBlocklistEx |
IRtcEngineEx | setVideoEncoderConfigurationEx |
IRtcEngineEx | startMediaRenderingTracingEx |
IRtcEngineEx | startOrUpdateChannelMediaRelayEx |
IRtcEngineEx | startRtmpStreamWithTranscodingEx |
IRtcEngineEx | startRtmpStreamWithoutTranscodingEx |
IRtcEngineEx | stopChannelMediaRelayEx |
IRtcEngineEx | stopRtmpStreamEx |
IRtcEngineEx | takeSnapshotEx |
IRtcEngineEx | takeSnapshotWithConfigEx |
IRtcEngineEx | updateChannelMediaOptionsEx |
IRtcEngineEx | updateRtmpTranscodingEx |
IVideoEffectObject | addOrUpdateVideoEffect |
IVideoEffectObject | getVideoEffectBoolParam |
IVideoEffectObject | getVideoEffectFloatParam |
IVideoEffectObject | getVideoEffectIntParam |
IVideoEffectObject | performVideoEffectAction |
IVideoEffectObject | removeVideoEffect |
IVideoEffectObject | setVideoEffectBoolParam |
IVideoEffectObject | setVideoEffectFloatParam |
IVideoEffectObject | setVideoEffectIntParam |
MusicChartCollection | get |
MusicChartCollection | getCount |
MusicCollection | getCount |
MusicCollection | getMusic |
MusicCollection | getPage |
MusicCollection | getPageSize |
MusicCollection | getTotal |