HarmonyOS(ArkTS) API 参考
构建时从公开 SDK 接口定义生成:接口、方法重载、属性、事件、枚举与错误码。
接口概览
本页列出 HarmonyOS(ArkTS) 端公开 API 的类、方法、重载、属性、事件与错误码,接口定义与 SDK 包版本一致。
| 核对项 | 数量 |
|---|---|
| 接口 / 类 | 88 |
| 方法 | 317 |
| 方法重载 | 317 |
| 属性 | 413 |
| 枚举 | 86 |
| 错误码常量 | 40 |
可用性
该端 SDK:正式可用。接口定义与 SDK 包版本一致;运行时的能力边界以实际发布的 SDK 包为准。
加入频道核心链路
按 join / leave / publish / subscribe 的典型调用顺序整理;参数表在“最小可运行链路”一节展开。
| 步骤 | 接口 | 方法 | 重载数 |
|---|---|---|---|
| 创建 / 初始化 | __unattributed__ | create | 1 |
| 加入频道 | __unattributed__ | joinChannelWithUserAccount | 1 |
| 续期 Token | IAgoraMusicContentCenter | renewToken | 1 |
| 开启视频与预览 | RtcEngine | enableVideo | 1 |
| 离开频道 | RtcEngine | leaveChannel | 1 |
| 订阅远端媒体 | RtcEngine | muteRemoteAudioStream | 1 |
| 频道场景 | RtcEngine | setChannelProfile | 1 |
| 角色切换 | RtcEngine | setClientRole | 1 |
| 本地画面 | RtcEngine | setupLocalVideo | 1 |
最小可运行链路的参数
| 参数 | 类型 | 可选 | 可变参数 |
|---|---|---|---|
config | RtcEngineConfig | 否 | 否 |
token | string | 否 | 否 |
channelName | string | 否 | 否 |
userAccount | string | 否 | 否 |
options | ChannelMediaOptions | 是 | 否 |
token | string | 否 | 否 |
options | LeaveChannelOptions | 是 | 否 |
uid | number | 否 | 否 |
muted | boolean | 否 | 否 |
profile | number | 否 | 否 |
role | number | 否 | 否 |
options | ClientRoleOptions | 是 | 否 |
canvas | VideoCanvas | 否 | 否 |
接口索引
全部接口
__unattributed__ 78 方法 / 0 属性
addBackgroundImage(backgroundImage: unknown): unknown
create(config: RtcEngineConfig): RtcEngine
createCustomAudioTrack(trackType: Constants.AudioTrackType, config: AudioTrackConfig): number
createEngine(context: Context, appID: string, handler: IRtcEngineEventHandler): RtcEngine
destroy(): number
destroyCustomAudioTrack(trackId: number): number
destroyMediaRecorder(recorder: AgoraMediaRecorder): void
enableAutoRemoveCache(enable: unknown): unknown
enableEncryptionEx(enabled: boolean, config: EncryptionConfig, connection: RtcConnection): number
enableFaceDetection(enabled: boolean): number
enableVideoImageSource(enabled: boolean, options: ImageTrackOptions): number
getCacheDir(): unknown
getCacheFileCount(): unknown
getDestChannelMediaInfos(): Map
getEffectsVolume(): number
getMaxCacheFileCount(): unknown
getMaxCacheFileSize(): unknown
getNtpWallTimeInMs(): bigint
getSrcChannelMediaInfo(): ChannelMediaInfo
getUserInfoByUid(uid: number, userInfo: UserInfo): number
getUserInfoByUserAccount(userAccount: string, userInfo: UserInfo): number
getVolumeOfEffect(soundId: number): number
getWatermarkList(): unknown
joinChannelWithUserAccount(token: string, channelName: string, userAccount: string, options?: ChannelMediaOptions): number
joinChannelWithUserAccountEx(token: string, channelId: string, userAccount: string, options: ChannelMediaOptions, eventHandler: IRtcEngineEventHandler): number
muteRecordingSignal(muted: boolean): number
onAudioRouteChanged(route: Constants.AudioRouteTypes): void
onFacePositionChanged(imageWidth: number, imageHeight: number, faceRectArr: Array): void
onLyricResult(requestId: string, songCode: bigint, lyricUrl: string, reason: Constants.MusicContentCenterStateReason): void
onMusicChartsResult(requestId: string, list: MusicChartInfo[], reason: Constants.MusicContentCenterStateReason): void
onMusicCollectionResult(requestId: string, page: number, pageSize: number, total: number, list: Music[], reason: Constants.MusicContentCenterStateReason): void
onPreLoadEvent(requestId: string, songCode: bigint, percent: number, lyricUrl: string, state: number, reason: Constants.MusicContentCenterStateReason): void
onSongSimpleInfoResult(requestId: string, songCode: bigint, simpleInfo: string, reason: Constants.MusicContentCenterStateReason): void
onUserInfoUpdated(uid: unknown): unknown
pauseAllEffects(): 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): Promise
preloadChannelWithUserAccount(token: string, channelName: string, userAccount: string): number
preloadEffect(soundId: number, filePath: string, startPos?: number): Promise
registerLocalUserAccount(appId: string, userAccount: string): number
registerPlayerObserver(playerObserver: IMediaPlayerObserver): unknown
removeAllCaches(): unknown
removeBackgroundImage(backgroundImage: unknown): unknown
removeCacheByUri(uri: unknown): unknown
removeDestChannelInfo(channelName: string): unknown
removeOldCache(): unknown
resumeAllEffects(): number
resumeEffect(soundId: number): number
setAudioEffectPreset(preset: Constants.AudioEffectPreset): number
setBeautyEffectOptions(enabled: boolean, options: BeautyOptions, sourceType?: Constants.MediaSourceType): number
setCacheDir(): unknown
setCameraExposurePosition(positionXinView: number, positionYinView: number): number
setCameraFocusPositionInPreview(positionX: number, positionY: number): number
setCameraZoomFactor(factor: number): number
setDestChannelInfo(channelName: string, destInfo: ChannelMediaInfo): unknown
setDualStreamMode(mode: Constants.SimulcastStreamMode, streamConfig?: SimulcastStreamConfig): number
setEffectsVolume(volume: number): number
setLocalVoiceEqualization(bandFrequency: Constants.AudioEqualizationBandFrequency, bandGain: number): number
setLocalVoicePitch(pitch: number): number
setLocalVoiceReverb(reverbKey: Constants.AudioReverbType, value: number): number
setMaxCacheFileCount(count: unknown): unknown
setMaxCacheFileSize(cacheSize: unknown): unknown
setRemoteRenderModeEx(uid: number, renderMode: number, mirrorMode: number, connection: RtcConnection): number
setRemoteSubscribeFallbackOption(option: Constants.StreamFallbackOptions): number
setSrcChannelInfo(srcInfo: ChannelMediaInfo): unknown
setVolumeOfEffect(soundId: number, volume: number): number
startAudioRecording(filePath: string, quality: Constants.AudioRecordingQualityType): number
startRecordingDeviceTest(indicationInterval: number): number
stopAllEffects(): number
stopEffect(soundId: number): number
stopLocalVideoTranscoder(): number
stopRecordingDeviceTest(): number
takeSnapshotEx(connection: RtcConnection, uid: number, filePath: string): number
unRegisterPlayerObserver(): unknown
unloadAllEffects(): number
unloadEffect(soundId: number): number
updateScreenCaptureParameters(screenCaptureParameters: ScreenCaptureParameters): number方法明细:78 / 78(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
addBackgroundImage | backgroundImage: unknown | unknown | 错误码索引 |
create | config: RtcEngineConfig | RtcEngine | 错误码索引 |
createCustomAudioTrack | trackType: Constants.AudioTrackType, config: AudioTrackConfig | number | 错误码索引 |
createEngine | context: Context, appID: string, handler: IRtcEngineEventHandler | RtcEngine | 错误码索引 |
destroy | — | number | 错误码索引 |
destroyCustomAudioTrack | trackId: number | number | 错误码索引 |
destroyMediaRecorder | recorder: AgoraMediaRecorder | void | 错误码索引 |
enableAutoRemoveCache | enable: unknown | unknown | 错误码索引 |
enableEncryptionEx | enabled: boolean, config: EncryptionConfig, connection: RtcConnection | number | 错误码索引 |
enableFaceDetection | enabled: boolean | number | 错误码索引 |
enableVideoImageSource | enabled: boolean, options: ImageTrackOptions | number | 错误码索引 |
getCacheDir | — | unknown | 错误码索引 |
getCacheFileCount | — | unknown | 错误码索引 |
getDestChannelMediaInfos | — | Map | 错误码索引 |
getEffectsVolume | — | number | 错误码索引 |
getMaxCacheFileCount | — | unknown | 错误码索引 |
getMaxCacheFileSize | — | unknown | 错误码索引 |
getNtpWallTimeInMs | — | bigint | 错误码索引 |
getSrcChannelMediaInfo | — | ChannelMediaInfo | 错误码索引 |
getUserInfoByUid | uid: number, userInfo: UserInfo | number | 错误码索引 |
getUserInfoByUserAccount | userAccount: string, userInfo: UserInfo | number | 错误码索引 |
getVolumeOfEffect | soundId: number | number | 错误码索引 |
getWatermarkList | — | unknown | 错误码索引 |
joinChannelWithUserAccount | token: string, channelName: string, userAccount: string, options?: ChannelMediaOptions | number | 错误码索引 |
joinChannelWithUserAccountEx | token: string, channelId: string, userAccount: string, options: ChannelMediaOptions, eventHandler: IRtcEngineEventHandler | number | 错误码索引 |
muteRecordingSignal | muted: boolean | number | 错误码索引 |
onAudioRouteChanged | route: Constants.AudioRouteTypes | void | 错误码索引 |
onFacePositionChanged | imageWidth: number, imageHeight: number, faceRectArr: Array | void | 错误码索引 |
onLyricResult | requestId: string, songCode: bigint, lyricUrl: string, reason: Constants.MusicContentCenterStateReason | void | 错误码索引 |
onMusicChartsResult | requestId: string, list: MusicChartInfo[], reason: Constants.MusicContentCenterStateReason | void | 错误码索引 |
onMusicCollectionResult | requestId: string, page: number, pageSize: number, total: number, list: Music[], reason: Constants.MusicContentCenterStateReason | void | 错误码索引 |
onPreLoadEvent | requestId: string, songCode: bigint, percent: number, lyricUrl: string, state: number, reason: Constants.MusicContentCenterStateReason | void | 错误码索引 |
onSongSimpleInfoResult | requestId: string, songCode: bigint, simpleInfo: string, reason: Constants.MusicContentCenterStateReason | void | 错误码索引 |
onUserInfoUpdated | uid: unknown | unknown | 错误码索引 |
pauseAllEffects | — | 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 | Promise | 错误码索引 |
preloadChannelWithUserAccount | token: string, channelName: string, userAccount: string | number | 错误码索引 |
preloadEffect | soundId: number, filePath: string, startPos?: number | Promise | 错误码索引 |
registerLocalUserAccount | appId: string, userAccount: string | number | 错误码索引 |
registerPlayerObserver | playerObserver: IMediaPlayerObserver | unknown | 错误码索引 |
removeAllCaches | — | unknown | 错误码索引 |
removeBackgroundImage | backgroundImage: unknown | unknown | 错误码索引 |
removeCacheByUri | uri: unknown | unknown | 错误码索引 |
removeDestChannelInfo | channelName: string | unknown | 错误码索引 |
removeOldCache | — | unknown | 错误码索引 |
resumeAllEffects | — | number | 错误码索引 |
resumeEffect | soundId: number | number | 错误码索引 |
setAudioEffectPreset | preset: Constants.AudioEffectPreset | number | 错误码索引 |
setBeautyEffectOptions | enabled: boolean, options: BeautyOptions, sourceType?: Constants.MediaSourceType | number | 错误码索引 |
setCacheDir | — | unknown | 错误码索引 |
setCameraExposurePosition | positionXinView: number, positionYinView: number | number | 错误码索引 |
setCameraFocusPositionInPreview | positionX: number, positionY: number | number | 错误码索引 |
setCameraZoomFactor | factor: number | number | 错误码索引 |
setDestChannelInfo | channelName: string, destInfo: ChannelMediaInfo | unknown | 错误码索引 |
setDualStreamMode | mode: Constants.SimulcastStreamMode, streamConfig?: SimulcastStreamConfig | number | 错误码索引 |
setEffectsVolume | volume: number | number | 错误码索引 |
setLocalVoiceEqualization | bandFrequency: Constants.AudioEqualizationBandFrequency, bandGain: number | number | 错误码索引 |
setLocalVoicePitch | pitch: number | number | 错误码索引 |
setLocalVoiceReverb | reverbKey: Constants.AudioReverbType, value: number | number | 错误码索引 |
setMaxCacheFileCount | count: unknown | unknown | 错误码索引 |
setMaxCacheFileSize | cacheSize: unknown | unknown | 错误码索引 |
setRemoteRenderModeEx | uid: number, renderMode: number, mirrorMode: number, connection: RtcConnection | number | 错误码索引 |
setRemoteSubscribeFallbackOption | option: Constants.StreamFallbackOptions | number | 错误码索引 |
setSrcChannelInfo | srcInfo: ChannelMediaInfo | unknown | 错误码索引 |
setVolumeOfEffect | soundId: number, volume: number | number | 错误码索引 |
startAudioRecording | filePath: string, quality: Constants.AudioRecordingQualityType | number | 错误码索引 |
startRecordingDeviceTest | indicationInterval: number | number | 错误码索引 |
stopAllEffects | — | number | 错误码索引 |
stopEffect | soundId: number | number | 错误码索引 |
stopLocalVideoTranscoder | — | number | 错误码索引 |
stopRecordingDeviceTest | — | number | 错误码索引 |
takeSnapshotEx | connection: RtcConnection, uid: number, filePath: string | number | 错误码索引 |
unRegisterPlayerObserver | — | unknown | 错误码索引 |
unloadAllEffects | — | number | 错误码索引 |
unloadEffect | soundId: number | number | 错误码索引 |
updateScreenCaptureParameters | screenCaptureParameters: ScreenCaptureParameters | number | 错误码索引 |
AdvancedConfigInfo 0 方法 / 1 属性
| 属性 | 类型 | 只读 |
|---|---|---|
logUploadServer | unknown | 否 |
AdvanceOptions 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
encodingPreference | unknown | 否 |
compressionPreference | unknown | 否 |
encodeAlpha | unknown | 否 |
AgoraFacePositionInfo 0 方法 / 5 属性
| 属性 | 类型 | 只读 |
|---|---|---|
x | unknown | 否 |
y | unknown | 否 |
width | unknown | 否 |
height | unknown | 否 |
distance | unknown | 否 |
AgoraImage 0 方法 / 7 属性
| 属性 | 类型 | 只读 |
|---|---|---|
url | unknown | 否 |
x | unknown | 否 |
y | unknown | 否 |
width | unknown | 否 |
height | unknown | 否 |
zOrder | unknown | 否 |
alpha | unknown | 否 |
AgoraMediaRecorder 3 方法 / 0 属性
setMediaRecorderObserver(callback: IMediaRecorderCallback | null): number
startRecording(config: MediaRecorderConfiguration): number
stopRecording(): number方法明细:3 / 3(参数、返回值、错误码)
AgoraRhythmPlayerConfig 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
beatsPerMeasure | unknown | 否 |
beatsPerMinute | unknown | 否 |
AudioCaptureParameters 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
sampleRate | unknown | 否 |
channels | unknown | 否 |
captureSignalVolume | unknown | 否 |
AudioEncodedFrameObserverConfig 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
postionType | unknown | 否 |
encodingType | unknown | 否 |
AudioFrame 0 方法 / 5 属性
| 属性 | 类型 | 只读 |
|---|---|---|
samplesPerChannel | unknown | 否 |
bytesPerSample | unknown | 否 |
channelNums | unknown | 否 |
sampleRataHz | unknown | 否 |
timestamp | unknown | 否 |
AudioRecordingConfiguration 0 方法 / 5 属性
| 属性 | 类型 | 只读 |
|---|---|---|
filePath | unknown | 否 |
codec | unknown | 否 |
sampleRate | unknown | 否 |
quality | unknown | 否 |
recordingChannel | unknown | 否 |
AudioSpectrumInfo 0 方法 / 1 属性
| 属性 | 类型 | 只读 |
|---|---|---|
audioSpectrumData | unknown | 否 |
AudioTrackConfig 0 方法 / 1 属性
| 属性 | 类型 | 只读 |
|---|---|---|
enableLocalPlayback | 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 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
cameraDirection | unknown | 否 |
captureFormat | unknown | 否 |
followEncodeDimensionRatio | unknown | 否 |
CaptureFormat 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
width | unknown | 否 |
height | unknown | 否 |
fps | unknown | 否 |
ChannelMediaInfo 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
channelName | unknown | 否 |
token | unknown | 否 |
uid | unknown | 否 |
ChannelMediaOptions 0 方法 / 24 属性
| 属性 | 类型 | 只读 |
|---|---|---|
publishCameraTrack | unknown | 否 |
publishMicrophoneTrack | unknown | 否 |
publishScreenCaptureVideo | unknown | 否 |
publishScreenCaptureAudio | 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 | 否 |
ChannelMediaRelayConfiguration 0 方法 / 1 属性
| 属性 | 类型 | 只读 |
|---|---|---|
setSrcChannelInfo | unknown | 否 |
ClientRoleOptions 0 方法 / 1 属性
| 属性 | 类型 | 只读 |
|---|---|---|
audienceLatencyLevel | unknown | 否 |
ClimaxSegment 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
startTimeMs | unknown | 否 |
endTimeMs | unknown | 否 |
ContentInspectConfig 0 方法 / 4 属性
| 属性 | 类型 | 只读 |
|---|---|---|
extraInfo | unknown | 否 |
serverConfig | unknown | 否 |
modules | unknown | 否 |
moduleCount | unknown | 否 |
ContentInspectModule 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
type | unknown | 否 |
interval | unknown | 否 |
DataStreamConfig 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
syncWithAudio | unknown | 否 |
ordered | unknown | 否 |
DeviceInfo 0 方法 / 1 属性
| 属性 | 类型 | 只读 |
|---|---|---|
isLowLatencyAudioSupported | unknown | 否 |
DirectCdnStreamingMediaOptions 0 方法 / 5 属性
| 属性 | 类型 | 只读 |
|---|---|---|
publishCameraTrack | unknown | 否 |
publishMicrophoneTrack | unknown | 否 |
publishCustomAudioTrack | unknown | 否 |
publishCustomVideoTrack | unknown | 否 |
customVideoTrackId | unknown | 否 |
DirectCdnStreamingStats 0 方法 / 5 属性
| 属性 | 类型 | 只读 |
|---|---|---|
videoWidth | unknown | 否 |
videoHeight | unknown | 否 |
fps | unknown | 否 |
videoBitrate | unknown | 否 |
audioBitrate | unknown | 否 |
EchoTestConfiguration 0 方法 / 6 属性
| 属性 | 类型 | 只读 |
|---|---|---|
view | unknown | 否 |
enableAudio | unknown | 否 |
enableVideo | unknown | 否 |
token | unknown | 否 |
channelId | unknown | 否 |
intervalInSeconds | unknown | 否 |
EncodedVideoFrameInfo 0 方法 / 10 属性
| 属性 | 类型 | 只读 |
|---|---|---|
codecType | unknown | 否 |
width | unknown | 否 |
height | unknown | 否 |
framesPerSecond | unknown | 否 |
frameType | unknown | 否 |
rotation | unknown | 否 |
trackId | unknown | 否 |
captureTimeMs | unknown | 否 |
uid | unknown | 否 |
streamType | unknown | 否 |
EncryptionConfig 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
encryptionMode | unknown | 否 |
encryptionKey | unknown | 否 |
encryptionKdfSalt | unknown | 否 |
IAgoraMusicContentCenter 18 方法 / 0 属性
createMusicPlayer(): IAgoraMusicPlayer
destroy(): void
destroyMusicPlayer(): unknown
getCaches(): MusicCacheInfo[]
getInternalSongCode(songCode: bigint, jsonOption: string): bigint
getLyric(songCode: bigint, lyricType: number): string
getMusicCharts(): string
getMusicCollectionByMusicChartId(musicChartId: number, page: number, pageSize: number, jsonOption?: string): string
getSongSimpleInfo(songCode: bigint): string
initialize(configuration: MusicContentCenterConfiguration): number
isPreloaded(songCode: bigint): number
preload(songCode: bigint): string
registerEventHandler(eventHandler: IMusicContentCenterEventHandler): number
release(): void
removeCache(songCode: bigint): number
renewToken(token: string): number
searchMusic(keyword: string, page: number, pageSize: number, jsonOption?: string): string
unregisterEventHandler(): number方法明细:18 / 18(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
createMusicPlayer | — | IAgoraMusicPlayer | 错误码索引 |
destroy | — | void | 错误码索引 |
destroyMusicPlayer | — | unknown | 错误码索引 |
getCaches | — | MusicCacheInfo[] | 错误码索引 |
getInternalSongCode | songCode: bigint, jsonOption: string | bigint | 错误码索引 |
getLyric | songCode: bigint, lyricType: number | string | 错误码索引 |
getMusicCharts | — | string | 错误码索引 |
getMusicCollectionByMusicChartId | musicChartId: number, page: number, pageSize: number, jsonOption?: string | string | 错误码索引 |
getSongSimpleInfo | songCode: bigint | string | 错误码索引 |
initialize | configuration: MusicContentCenterConfiguration | number | 错误码索引 |
isPreloaded | songCode: bigint | number | 错误码索引 |
preload | songCode: bigint | string | 错误码索引 |
registerEventHandler | eventHandler: IMusicContentCenterEventHandler | number | 错误码索引 |
release | — | void | 错误码索引 |
removeCache | songCode: bigint | number | 错误码索引 |
renewToken | token: string | number | 错误码索引 |
searchMusic | keyword: string, page: number, pageSize: number, jsonOption?: string | string | 错误码索引 |
unregisterEventHandler | — | number | 错误码索引 |
IAgoraMusicPlayer 1 方法 / 0 属性
setPlayMode(mode: Constants.MusicPlayMode): number方法明细:1 / 1(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
setPlayMode | mode: Constants.MusicPlayMode | number | 错误码索引 |
ImageTrackOptions 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
imageUrl | unknown | 否 |
fps | unknown | 否 |
IMediaPlayer 34 方法 / 0 属性
adjustPlayoutVolume(vol: number): number
adjustPublishSignalVolume(volume: number): number
getDuration(): number
getMediaPlayerId(): number
getMute(): boolean
getPlayPosition(): number
getPlaySrc(): string
getPlayoutVolume(): number
getPublishSignalVolume(): number
getState(): Constants.MediaPlayerState
getStreamCount(): number
getStreamInfo(index: number): MediaStreamInfo|undefined
mute(muted: boolean): number
open(url: string, startPos: number): number
openWithMediaSource(source: MediaPlayerSource): number
pause(): number
play(): number
playPreloadedSrc(src: string): number
preloadSrc(src: string, startPos: number): number
resume(): number
seek(newPos: number): number
selectAudioTrack(index: number): number
selectMultiAudioTrack(playoutTrackIndex: number, publishTrackIndex: number): number
setAudioDualMonoMode(mode: Constants.AudioDualMonoMode): number
setAudioPitch(pitch: number): number
setLoopCount(loopCount: number): number
setPlaybackSpeed(speed: number): number
setPlayerOption(key: string, value: number): unknown
setPlayerOptionString(key: string, value: string): number
setRenderMode(mode: number): number
setView(view: string): number
stop(): number
switchSrc(src: string, syncPts: boolean): number
unloadSrc(src: string): number方法明细:34 / 34(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
adjustPlayoutVolume | vol: number | number | 错误码索引 |
adjustPublishSignalVolume | volume: number | number | 错误码索引 |
getDuration | — | number | 错误码索引 |
getMediaPlayerId | — | number | 错误码索引 |
getMute | — | boolean | 错误码索引 |
getPlayPosition | — | number | 错误码索引 |
getPlaySrc | — | string | 错误码索引 |
getPlayoutVolume | — | number | 错误码索引 |
getPublishSignalVolume | — | number | 错误码索引 |
getState | — | Constants.MediaPlayerState | 错误码索引 |
getStreamCount | — | number | 错误码索引 |
getStreamInfo | index: number | MediaStreamInfo|undefined | 错误码索引 |
mute | muted: boolean | number | 错误码索引 |
open | url: string, startPos: number | number | 错误码索引 |
openWithMediaSource | source: MediaPlayerSource | number | 错误码索引 |
pause | — | number | 错误码索引 |
play | — | number | 错误码索引 |
playPreloadedSrc | src: string | number | 错误码索引 |
preloadSrc | src: string, startPos: number | number | 错误码索引 |
resume | — | number | 错误码索引 |
seek | newPos: number | number | 错误码索引 |
selectAudioTrack | index: number | number | 错误码索引 |
selectMultiAudioTrack | playoutTrackIndex: number, publishTrackIndex: number | number | 错误码索引 |
setAudioDualMonoMode | mode: Constants.AudioDualMonoMode | number | 错误码索引 |
setAudioPitch | pitch: number | number | 错误码索引 |
setLoopCount | loopCount: number | number | 错误码索引 |
setPlaybackSpeed | speed: number | number | 错误码索引 |
setPlayerOption | key: string, value: number | unknown | 错误码索引 |
setPlayerOptionString | key: string, value: string | number | 错误码索引 |
setRenderMode | mode: number | number | 错误码索引 |
setView | view: string | number | 错误码索引 |
stop | — | number | 错误码索引 |
switchSrc | src: string, syncPts: boolean | number | 错误码索引 |
unloadSrc | src: string | number | 错误码索引 |
IMediaPlayerObserver 10 方法 / 0 属性
onAudioVolumeIndication(volume: number): void
onMetaData(type: Constants.MediaPlayerMetadataType, data: ArrayBuffer): void
onPlayBufferUpdated(playCachedBuffer: number): void
onPlayerEvent(eventCode: Constants.MediaPlayerEvent, elapsedTime: number, message: string): void
onPlayerInfoUpdated(info: PlayerUpdatedInfo): void
onPlayerPlaybackStats(stats: PlayerPlaybackStats): void
onPlayerSrcInfoChanged(from: SrcInfo, to: SrcInfo): void
onPlayerStateChanged(state: Constants.MediaPlayerState, reason: Constants.MediaPlayerReason): void
onPositionChanged(positionMs: number, timestampMs: number): void
onPreloadEvent(src: string, event: Constants.MediaPlayerPreloadEvent): void方法明细:10 / 10(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
onAudioVolumeIndication | volume: number | void | 错误码索引 |
onMetaData | type: Constants.MediaPlayerMetadataType, data: ArrayBuffer | void | 错误码索引 |
onPlayBufferUpdated | playCachedBuffer: number | void | 错误码索引 |
onPlayerEvent | eventCode: Constants.MediaPlayerEvent, elapsedTime: number, message: string | void | 错误码索引 |
onPlayerInfoUpdated | info: PlayerUpdatedInfo | void | 错误码索引 |
onPlayerPlaybackStats | stats: PlayerPlaybackStats | void | 错误码索引 |
onPlayerSrcInfoChanged | from: SrcInfo, to: SrcInfo | void | 错误码索引 |
onPlayerStateChanged | state: Constants.MediaPlayerState, reason: Constants.MediaPlayerReason | void | 错误码索引 |
onPositionChanged | positionMs: number, timestampMs: number | void | 错误码索引 |
onPreloadEvent | src: string, event: Constants.MediaPlayerPreloadEvent | void | 错误码索引 |
| 事件名 | 回调参数 |
|---|---|
onPlayerCacheStats | onPlayerCacheStats?:(stats:CacheStatistics |
onAudioVolumeIndication(volume: number): void
onMetaData(type: Constants.MediaPlayerMetadataType, data: ArrayBuffer): void
onPlayBufferUpdated(playCachedBuffer: number): void
onPlayerEvent(eventCode: Constants.MediaPlayerEvent, elapsedTime: number, message: string): void
onPlayerInfoUpdated(info: PlayerUpdatedInfo): void
onPlayerPlaybackStats(stats: PlayerPlaybackStats): void
onPlayerSrcInfoChanged(from: SrcInfo, to: SrcInfo): void
onPlayerStateChanged(state: Constants.MediaPlayerState, reason: Constants.MediaPlayerReason): void
onPositionChanged(positionMs: number, timestampMs: number): void
onPreloadEvent(src: string, event: Constants.MediaPlayerPreloadEvent): voidIMediaRecorderCallback 2 方法 / 0 属性
onRecorderInfoUpdated(channelId: string, uid: number, info: RecorderInfo): void
onRecorderStateChanged(channelId: string, uid: number, state: number, reason: number): void方法明细:2 / 2(参数、返回值、错误码)
IRtcEngineEventHandler 51 方法 / 0 属性
onAudioEffectFinished(soundId: number): void
onAudioMixingPositionChanged(position: bigint): void
onAudioMixingStateChanged(state: Constants.AudioMixingState, reason: Constants.AudioMixingReason): void
onAudioPublishStateChanged(channel: string, oldState: Constants.StreamPublishState, newState: Constants.StreamPublishState, elapseSinceLastState: number): void
onAudioSubscribeStateChanged(channel: string, uid: number, oldState: Constants.StreamSubscribeState, newState: Constants.StreamSubscribeState, elapseSinceLastState: number): void
onAudioVolumeIndication(speakers: Array, totalVolume: number): void
onCameraExposureAreaChanged(rect: camera.Rect): void
onCameraFocusPointChanged(point: camera.Point): void
onChannelMediaRelayStateChanged(state: Constants.ChannelMediaRelayState, code: Constants.ChannelMediaRelayError): void
onClientRoleChangeFailed(reason: number, currentRole: Constants.ClientRole): void
onClientRoleChanged(oldRole: Constants.ClientRole, newRole: Constants.ClientRole, newRoleOptions: ClientRoleOptions): void
onConnectionLost(): void
onConnectionStateChanged(state: Constants.ConnectionState, reason: Constants.ConnectionChangedReason): void
onEncryptionError(errorType: Constants.EncryptionError): void
onError(err: Constants.ErrorCode, message: string): void
onFirstLocalVideoFrame(source: Constants.VideoSourceType, width: number, height: number, elapsed: number): void
onFirstRemoteVideoFrame(uid: number, width: number, height: number, elapsed: number): void
onJoinChannelSuccess(channel: string, uid: number, elapsed: number): void
onLastmileProbeResult(result: LastmileProbeResult): void
onLastmileQuality(quality: Constants.QualityType): void
onLeaveChannel(stats: RtcStats): void
onLocalAudioStateChanged(state: Constants.LocalAudioStreamState, error: Constants.LocalAudioStreamReason): void
onLocalAudioStats(stats: LocalAudioStats): void
onLocalUserRegistered(uid: unknown, userAccount: unknown): unknown
onLocalVideoStateChanged(source: Constants.VideoSourceType, state: Constants.LocalVideoStreamState, reason: Constants.LocalVideoStreamReason): void
onLocalVideoStats(source: Constants.VideoSourceType, stats: LocalVideoStats): void
onLocalVideoTranscoderError(stream: TranscodingVideoStream, error: Constants.VideoTranscoderError): void
onNetworkQuality(uid: number, txQuality: Constants.NetworkQuality, rxQuality: Constants.NetworkQuality): void
onPermissionError(permission: Constants.PermissionType): void
onRejoinChannelSuccess(channel: string, uid: number, elapsed: number): void
onRemoteAudioStateChanged(uid: number, state: Constants.RemoteAudioStreamState, reason: Constants.RemoteAudioStreamReason, elapsed: number): void
onRemoteAudioStats(stats: RemoteAudioStats): void
onRemoteVideoStateChanged(uid: number, state: Constants.RemoteVideoStreamState, reason: Constants.RemoteVideoStreamReason, elapsed: number): void
onRemoteVideoStats(stats: RemoteVideoStats): void
onRequestToken(): void
onRtcStats(stats: RtcStats): void
onRtmpStreamingEvent(url: string, event: Constants.RtmpStreamingEvent): void
onRtmpStreamingStateChanged(url: string, state: Constants.RtmpStreamPublishState, reason: Constants.RtmpStreamPublishReason): void
onSnapshotTaken(uid: number, filePath: string, width: number, height: number, errCode: number): void
onStreamMessage(uid: number, streamId: number, data: Uint8Array): void
onStreamMessageError(uid: number, streamId: number, error: number, missed: number, cached: number): void
onTokenPrivilegeWillExpire(token: string): void
onTranscodingUpdated(): void
onUserEnableVideo(uid: number, enabled: boolean): void
onUserJoined(uid: number, elapse: number): void
onUserMuteAudio(uid: number, muted: boolean): void
onUserMuteVideo(uid: number, muted: boolean): void
onUserOffline(uid: number, reason: number): void
onVideoPublishStateChanged(source: Constants.VideoSourceType, channel: string, oldState: Constants.StreamPublishState, newState: Constants.StreamPublishState, elapseSinceLastState: number): void
onVideoSizeChanged(source: Constants.VideoSourceType, uid: number, width: number, height: number, rotation: number): void
onVideoSubscribeStateChanged(channel: string, uid: number, oldState: Constants.StreamSubscribeState, newState: Constants.StreamSubscribeState, elapseSinceLastState: number): void方法明细:51 / 51(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
onAudioEffectFinished | soundId: number | void | 错误码索引 |
onAudioMixingPositionChanged | position: bigint | void | 错误码索引 |
onAudioMixingStateChanged | state: Constants.AudioMixingState, reason: Constants.AudioMixingReason | void | 错误码索引 |
onAudioPublishStateChanged | channel: string, oldState: Constants.StreamPublishState, newState: Constants.StreamPublishState, elapseSinceLastState: number | void | 错误码索引 |
onAudioSubscribeStateChanged | channel: string, uid: number, oldState: Constants.StreamSubscribeState, newState: Constants.StreamSubscribeState, elapseSinceLastState: number | void | 错误码索引 |
onAudioVolumeIndication | speakers: Array, totalVolume: number | void | 错误码索引 |
onCameraExposureAreaChanged | rect: camera.Rect | void | 错误码索引 |
onCameraFocusPointChanged | point: camera.Point | void | 错误码索引 |
onChannelMediaRelayStateChanged | state: Constants.ChannelMediaRelayState, code: Constants.ChannelMediaRelayError | void | 错误码索引 |
onClientRoleChangeFailed | reason: number, currentRole: Constants.ClientRole | void | 错误码索引 |
onClientRoleChanged | oldRole: Constants.ClientRole, newRole: Constants.ClientRole, newRoleOptions: ClientRoleOptions | void | 错误码索引 |
onConnectionLost | — | void | 错误码索引 |
onConnectionStateChanged | state: Constants.ConnectionState, reason: Constants.ConnectionChangedReason | void | 错误码索引 |
onEncryptionError | errorType: Constants.EncryptionError | void | 错误码索引 |
onError | err: Constants.ErrorCode, message: string | void | 错误码索引 |
onFirstLocalVideoFrame | source: Constants.VideoSourceType, width: number, height: number, elapsed: number | void | 错误码索引 |
onFirstRemoteVideoFrame | uid: number, width: number, height: number, elapsed: number | void | 错误码索引 |
onJoinChannelSuccess | channel: string, uid: number, elapsed: number | void | 错误码索引 |
onLastmileProbeResult | result: LastmileProbeResult | void | 错误码索引 |
onLastmileQuality | quality: Constants.QualityType | void | 错误码索引 |
onLeaveChannel | stats: RtcStats | void | 错误码索引 |
onLocalAudioStateChanged | state: Constants.LocalAudioStreamState, error: Constants.LocalAudioStreamReason | void | 错误码索引 |
onLocalAudioStats | stats: LocalAudioStats | void | 错误码索引 |
onLocalUserRegistered | uid: unknown, userAccount: unknown | unknown | 错误码索引 |
onLocalVideoStateChanged | source: Constants.VideoSourceType, state: Constants.LocalVideoStreamState, reason: Constants.LocalVideoStreamReason | void | 错误码索引 |
onLocalVideoStats | source: Constants.VideoSourceType, stats: LocalVideoStats | void | 错误码索引 |
onLocalVideoTranscoderError | stream: TranscodingVideoStream, error: Constants.VideoTranscoderError | void | 错误码索引 |
onNetworkQuality | uid: number, txQuality: Constants.NetworkQuality, rxQuality: Constants.NetworkQuality | void | 错误码索引 |
onPermissionError | permission: Constants.PermissionType | void | 错误码索引 |
onRejoinChannelSuccess | channel: string, uid: number, elapsed: number | void | 错误码索引 |
onRemoteAudioStateChanged | uid: number, state: Constants.RemoteAudioStreamState, reason: Constants.RemoteAudioStreamReason, elapsed: number | void | 错误码索引 |
onRemoteAudioStats | stats: RemoteAudioStats | void | 错误码索引 |
onRemoteVideoStateChanged | uid: number, state: Constants.RemoteVideoStreamState, reason: Constants.RemoteVideoStreamReason, elapsed: number | void | 错误码索引 |
onRemoteVideoStats | stats: RemoteVideoStats | void | 错误码索引 |
onRequestToken | — | void | 错误码索引 |
onRtcStats | stats: RtcStats | void | 错误码索引 |
onRtmpStreamingEvent | url: string, event: Constants.RtmpStreamingEvent | void | 错误码索引 |
onRtmpStreamingStateChanged | url: string, state: Constants.RtmpStreamPublishState, reason: Constants.RtmpStreamPublishReason | void | 错误码索引 |
onSnapshotTaken | uid: number, filePath: string, width: number, height: number, errCode: number | void | 错误码索引 |
onStreamMessage | uid: number, streamId: number, data: Uint8Array | void | 错误码索引 |
onStreamMessageError | uid: number, streamId: number, error: number, missed: number, cached: number | void | 错误码索引 |
onTokenPrivilegeWillExpire | token: string | void | 错误码索引 |
onTranscodingUpdated | — | void | 错误码索引 |
onUserEnableVideo | uid: number, enabled: boolean | void | 错误码索引 |
onUserJoined | uid: number, elapse: number | void | 错误码索引 |
onUserMuteAudio | uid: number, muted: boolean | void | 错误码索引 |
onUserMuteVideo | uid: number, muted: boolean | void | 错误码索引 |
onUserOffline | uid: number, reason: number | void | 错误码索引 |
onVideoPublishStateChanged | source: Constants.VideoSourceType, channel: string, oldState: Constants.StreamPublishState, newState: Constants.StreamPublishState, elapseSinceLastState: number | void | 错误码索引 |
onVideoSizeChanged | source: Constants.VideoSourceType, uid: number, width: number, height: number, rotation: number | void | 错误码索引 |
onVideoSubscribeStateChanged | channel: string, uid: number, oldState: Constants.StreamSubscribeState, newState: Constants.StreamSubscribeState, elapseSinceLastState: number | void | 错误码索引 |
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 | 否 |
LiveTranscoding 0 方法 / 13 属性
| 属性 | 类型 | 只读 |
|---|---|---|
width | unknown | 否 |
height | unknown | 否 |
videoBitrate | unknown | 否 |
videoFrameRate | unknown | 否 |
videoGop | unknown | 否 |
videoCodecProfile | unknown | 否 |
videoCodecType | unknown | 否 |
transcodingUsers | unknown | 否 |
userConfigExtraInfo | unknown | 否 |
audioSampleRate | unknown | 否 |
audioBitrate | unknown | 否 |
audioChannels | unknown | 否 |
audioCodecProfile | unknown | 否 |
LocalAccessPointConfiguration 0 方法 / 5 属性
| 属性 | 类型 | 只读 |
|---|---|---|
ipList | unknown | 否 |
domainList | unknown | 否 |
verifyDomainName | unknown | 否 |
mode | unknown | 否 |
advancedConfig | unknown | 否 |
LocalAudioStats 0 方法 / 8 属性
| 属性 | 类型 | 只读 |
|---|---|---|
numChannels | unknown | 否 |
sentSampleRate | unknown | 否 |
sentBitrate | unknown | 否 |
txPacketLossRate | unknown | 否 |
internalCodec | unknown | 否 |
audioDeviceDelay | unknown | 否 |
earMonitorDelay | unknown | 否 |
aecEstimatedDelay | unknown | 否 |
LocalTranscoderConfiguration 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
transcodingVideoStreams | 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 | 否 |
MediaPlayerSource 0 方法 / 8 属性
| 属性 | 类型 | 只读 |
|---|---|---|
url | unknown | 否 |
uri | unknown | 否 |
startPos | unknown | 否 |
autoPlay | unknown | 否 |
enableCache | unknown | 否 |
enableMultiAudioTrack | unknown | 否 |
isAgoraSource | unknown | 否 |
isLiveSource | Boolean | 否 |
MediaRecorderConfiguration 0 方法 / 5 属性
| 属性 | 类型 | 只读 |
|---|---|---|
storagePath | unknown | 否 |
containerFormat | unknown | 否 |
streamType | unknown | 否 |
maxDurationMs | unknown | 否 |
recorderInfoUpdateInterval | unknown | 否 |
MediaStreamInfo 0 方法 / 12 属性
| 属性 | 类型 | 只读 |
|---|---|---|
streamIndex | unknown | 否 |
mediaStreamType | unknown | 否 |
codecName | unknown | 否 |
language | unknown | 否 |
videoFrameRate | unknown | 否 |
videoBitRate | unknown | 否 |
videoWidth | unknown | 否 |
videoHeight | unknown | 否 |
audioSampleRate | unknown | 否 |
audioChannels | unknown | 否 |
audioBytesPerSample | unknown | 否 |
duration | unknown | 否 |
Music 0 方法 / 10 属性
| 属性 | 类型 | 只读 |
|---|---|---|
songCode | unknown | 否 |
name | unknown | 否 |
singer | unknown | 否 |
poster | unknown | 否 |
releaseTime | unknown | 否 |
type | unknown | 否 |
pitchType | unknown | 否 |
durationS | unknown | 否 |
lyricTypes | unknown | 否 |
climaxSegments | MvProperty[] | 否 |
MusicCacheInfo 0 方法 / 1 属性
| 属性 | 类型 | 只读 |
|---|---|---|
songCode | unknown | 否 |
MusicChartInfo 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
name | unknown | 否 |
type | unknown | 否 |
MusicContentCenterConfiguration 0 方法 / 4 属性
| 属性 | 类型 | 只读 |
|---|---|---|
appId | unknown | 否 |
token | unknown | 否 |
mccUid | unknown | 否 |
maxCacheSize | unknown | 否 |
PlayerPlaybackStats 0 方法 / 4 属性
| 属性 | 类型 | 只读 |
|---|---|---|
videoFps | unknown | 否 |
videoBitrateInKbps | unknown | 否 |
audioBitrateInKbps | unknown | 否 |
totalBitrateInKbps | 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 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
channelId | unknown | 否 |
uid | 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 方法 / 16 属性
| 属性 | 类型 | 只读 |
|---|---|---|
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 | 否 |
RtcConnection 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
channelId | unknown | 否 |
localUid | unknown | 否 |
RtcEngine 101 方法 / 0 属性
adjustAudioMixingPlayoutVolume(volume: number): number
adjustAudioMixingPublishVolume(volume: number): number
adjustAudioMixingVolume(volume: number): number
adjustPlaybackSignalVolume(volume: number): number
adjustRecordingSignalVolume(volume: number): number
adjustUserPlaybackSignalVolume(uid: number, volume: number): number
createCustomVideoTrack(): number
createDataStream(config: DataStreamConfig): number
createMediaPlayer(): IMediaPlayer|undefined
createMediaRecorder(info: RecorderStreamInfo): AgoraMediaRecorder
destroy(): Promise
destroyCustomVideoTrack(videoTrackId: number): number
disableAudio(): number
disableVideo(): number
enableAudio(): number
enableAudioVolumeIndication(interval: number, smooth: number, reportVad: boolean): number
enableContentInspect(enabled: boolean, config: ContentInspectConfig): number
enableEncryption(enabled: boolean, config: EncryptionConfig): number
enableInEarMonitoring(enabled: boolean, includeAudioFilters?: Constants.EarMontoringFilterType): number
enableLocalAudio(enabled: boolean): number
enableLocalVideo(enabled: boolean): number
enableVideo(): number
enableVirtualBackground(enabled: boolean, backgroundSource: VirtualBackgroundSource, segproperty: SegmentationProperty, sourceType?: Constants.MediaSourceType): number
getAudioMixingCurrentPosition(): number
getAudioMixingDuration(): number
getAudioMixingPlayoutVolume(): number
getAudioMixingPublishVolume(): number
getCallId(): string
getCameraMaxZoomFactor(): number
getCurrentMonotonicTimeInMs(): number
getErrorDescription(error: number): string
getNativeHandle(): bigint
getSdkVersion(): string
isCameraAutoFocusFaceModeSupported(): boolean
isCameraExposurePositionSupported(): boolean
isCameraExposureSupported(): boolean
isCameraFaceDetectSupported(): boolean
isCameraFocusSupported(): boolean
isCameraZoomSupported(): boolean
isSpeakerphoneEnabled(): boolean
joinChannel(key: string, channel: string, optionalInfo: string, uid: number): number
joinChannelWithOptions(token: string, channelId: string, uid: number, options: ChannelMediaOptions): number
leaveChannel(options?: LeaveChannelOptions): number
muteAllRemoteAudioStreams(muted: boolean): number
muteAllRemoteVideoStreams(muted: boolean): number
muteLocalAudioStream(muted: boolean): number
muteLocalVideoStream(muted: boolean): number
muteRemoteAudioStream(uid: number, muted: boolean): number
muteRemoteVideoStream(uid: number, muted: boolean): number
pauseAllChannelMediaRelay(): number
pauseAudioMixing(): number
pushExternalVideoFrame(frame: VideoFrame): boolean
pushExternalVideoFrameById(frame: VideoFrame, videoTrackId: number): number
renewToken(token: string): number
resumeAllChannelMediaRelay(): number
resumeAudioMixing(): number
sendStreamMessage(streamId: number, message: ArrayBuffer): number
setAudioMixingPlaybackSpeed(speed: number): number
setAudioMixingPosition(pos: number): number
setAudioProfile(profile: Constants.AudioProfileType): number
setAudioScenario(scenario: Constants.AudioScenarioType): number
setCameraAutoFocusFaceModeEnabled(enabled: boolean): number
setCameraCapturerConfiguration(config: CameraCapturerConfiguration): number
setChannelProfile(profile: number): number
setClientRole(role: number, options?: ClientRoleOptions): number
setDefaultAudioRouteToSpeakerphone(defaultToSpeaker: boolean): number
setEnableSpeakerphone(enabled: unknown): unknown
setExternalVideoSource(enable: boolean, useTexture: boolean, sourceType: Constants.ExternalVideoSourceType): number
setInEarMonitoringVolume(volume: number): number
setLocalRenderMode(renderMode: number, mirrorMode: number): number
setParameters(parameters: string): number
setRemoteDefaultVideoStreamType(streamType: Constants.VideoStreamType): number
setRemoteRenderMode(uid: number, renderMode: number, mirrorMode: number): number
setRemoteVideoStreamType(uid: number, streamType: Constants.VideoStreamType): number
setVideoEncoderConfiguration(configuration: VideoEncoderConfiguration): number
setVoiceBeautifierPreset(preset: Constants.VoiceBeautifierPreset): number
setupLocalVideo(canvas: VideoCanvas): number
setupRemoteVideo(canvas: VideoCanvas): number
startAudioMixing(filepath: string, loopback: boolean, cycle: number, startpos?: number): number
startAudioRecordingWithConfiguration(config: AudioRecordingConfiguration): number
startCameraCapture(sourceType: Constants.VideoSourceType, config: CameraCapturerConfiguration): number
startLastmileProbeTest(config: LastmileProbeConfig): number
startLocalVideoTranscoder(config: LocalTranscoderConfiguration): number
startOrUpdateChannelMediaRelay(channelMediaRelayConfiguration: ChannelMediaRelayConfiguration): number
startPreview(sourceType?: Constants.VideoSourceType): number
startRtmpStreamWithTranscoding(url: string, transcoding: LiveTranscoding): number
startRtmpStreamWithoutTranscoding(url: string): number
startScreenCapture(screenCaptureParameters: ScreenCaptureParameters): number
stopAudioMixing(): number
stopAudioRecording(): number
stopCameraCapture(sourceType: Constants.VideoSourceType): number
stopChannelMediaRelay(): number
stopLastmileProbeTest(): number
stopPreview(sourceType?: Constants.VideoSourceType): number
stopRtmpStream(url: string): number
stopScreenCapture(): number
switchCamera(): number
takeSnapshot(uid: number, filePath: string): number
updateChannelMediaOptions(options: ChannelMediaOptions): number
updateLocalTranscoderConfiguration(config: LocalTranscoderConfiguration): number
updateRtmpTranscoding(transcoding: LiveTranscoding): number方法明细:101 / 101(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
adjustAudioMixingPlayoutVolume | volume: number | number | 错误码索引 |
adjustAudioMixingPublishVolume | volume: number | number | 错误码索引 |
adjustAudioMixingVolume | volume: number | number | 错误码索引 |
adjustPlaybackSignalVolume | volume: number | number | 错误码索引 |
adjustRecordingSignalVolume | volume: number | number | 错误码索引 |
adjustUserPlaybackSignalVolume | uid: number, volume: number | number | 错误码索引 |
createCustomVideoTrack | — | number | 错误码索引 |
createDataStream | config: DataStreamConfig | number | 错误码索引 |
createMediaPlayer | — | IMediaPlayer|undefined | 错误码索引 |
createMediaRecorder | info: RecorderStreamInfo | AgoraMediaRecorder | 错误码索引 |
destroy | — | Promise | 错误码索引 |
destroyCustomVideoTrack | videoTrackId: number | number | 错误码索引 |
disableAudio | — | number | 错误码索引 |
disableVideo | — | number | 错误码索引 |
enableAudio | — | number | 错误码索引 |
enableAudioVolumeIndication | interval: number, smooth: number, reportVad: boolean | number | 错误码索引 |
enableContentInspect | enabled: boolean, config: ContentInspectConfig | number | 错误码索引 |
enableEncryption | enabled: boolean, config: EncryptionConfig | number | 错误码索引 |
enableInEarMonitoring | enabled: boolean, includeAudioFilters?: Constants.EarMontoringFilterType | number | 错误码索引 |
enableLocalAudio | enabled: boolean | number | 错误码索引 |
enableLocalVideo | enabled: boolean | number | 错误码索引 |
enableVideo | — | number | 错误码索引 |
enableVirtualBackground | enabled: boolean, backgroundSource: VirtualBackgroundSource, segproperty: SegmentationProperty, sourceType?: Constants.MediaSourceType | number | 错误码索引 |
getAudioMixingCurrentPosition | — | number | 错误码索引 |
getAudioMixingDuration | — | number | 错误码索引 |
getAudioMixingPlayoutVolume | — | number | 错误码索引 |
getAudioMixingPublishVolume | — | number | 错误码索引 |
getCallId | — | string | 错误码索引 |
getCameraMaxZoomFactor | — | number | 错误码索引 |
getCurrentMonotonicTimeInMs | — | number | 错误码索引 |
getErrorDescription | error: number | string | 错误码索引 |
getNativeHandle | — | bigint | 错误码索引 |
getSdkVersion | — | string | 错误码索引 |
isCameraAutoFocusFaceModeSupported | — | boolean | 错误码索引 |
isCameraExposurePositionSupported | — | boolean | 错误码索引 |
isCameraExposureSupported | — | boolean | 错误码索引 |
isCameraFaceDetectSupported | — | boolean | 错误码索引 |
isCameraFocusSupported | — | boolean | 错误码索引 |
isCameraZoomSupported | — | boolean | 错误码索引 |
isSpeakerphoneEnabled | — | boolean | 错误码索引 |
joinChannel | key: string, channel: string, optionalInfo: string, uid: number | number | 错误码索引 |
joinChannelWithOptions | token: string, channelId: string, uid: number, options: ChannelMediaOptions | number | 错误码索引 |
leaveChannel | options?: LeaveChannelOptions | number | 错误码索引 |
muteAllRemoteAudioStreams | muted: boolean | number | 错误码索引 |
muteAllRemoteVideoStreams | muted: boolean | number | 错误码索引 |
muteLocalAudioStream | muted: boolean | number | 错误码索引 |
muteLocalVideoStream | muted: boolean | number | 错误码索引 |
muteRemoteAudioStream | uid: number, muted: boolean | number | 错误码索引 |
muteRemoteVideoStream | uid: number, muted: boolean | number | 错误码索引 |
pauseAllChannelMediaRelay | — | number | 错误码索引 |
pauseAudioMixing | — | number | 错误码索引 |
pushExternalVideoFrame | frame: VideoFrame | boolean | 错误码索引 |
pushExternalVideoFrameById | frame: VideoFrame, videoTrackId: number | number | 错误码索引 |
renewToken | token: string | number | 错误码索引 |
resumeAllChannelMediaRelay | — | number | 错误码索引 |
resumeAudioMixing | — | number | 错误码索引 |
sendStreamMessage | streamId: number, message: ArrayBuffer | number | 错误码索引 |
setAudioMixingPlaybackSpeed | speed: number | number | 错误码索引 |
setAudioMixingPosition | pos: number | number | 错误码索引 |
setAudioProfile | profile: Constants.AudioProfileType | number | 错误码索引 |
setAudioScenario | scenario: Constants.AudioScenarioType | number | 错误码索引 |
setCameraAutoFocusFaceModeEnabled | enabled: boolean | number | 错误码索引 |
setCameraCapturerConfiguration | config: CameraCapturerConfiguration | number | 错误码索引 |
setChannelProfile | profile: number | number | 错误码索引 |
setClientRole | role: number, options?: ClientRoleOptions | number | 错误码索引 |
setDefaultAudioRouteToSpeakerphone | defaultToSpeaker: boolean | number | 错误码索引 |
setEnableSpeakerphone | enabled: unknown | unknown | 错误码索引 |
setExternalVideoSource | enable: boolean, useTexture: boolean, sourceType: Constants.ExternalVideoSourceType | number | 错误码索引 |
setInEarMonitoringVolume | volume: number | number | 错误码索引 |
setLocalRenderMode | renderMode: number, mirrorMode: number | number | 错误码索引 |
setParameters | parameters: string | number | 错误码索引 |
setRemoteDefaultVideoStreamType | streamType: Constants.VideoStreamType | number | 错误码索引 |
setRemoteRenderMode | uid: number, renderMode: number, mirrorMode: number | number | 错误码索引 |
setRemoteVideoStreamType | uid: number, streamType: Constants.VideoStreamType | number | 错误码索引 |
setVideoEncoderConfiguration | configuration: VideoEncoderConfiguration | number | 错误码索引 |
setVoiceBeautifierPreset | preset: Constants.VoiceBeautifierPreset | number | 错误码索引 |
setupLocalVideo | canvas: VideoCanvas | number | 错误码索引 |
setupRemoteVideo | canvas: VideoCanvas | number | 错误码索引 |
startAudioMixing | filepath: string, loopback: boolean, cycle: number, startpos?: number | number | 错误码索引 |
startAudioRecordingWithConfiguration | config: AudioRecordingConfiguration | number | 错误码索引 |
startCameraCapture | sourceType: Constants.VideoSourceType, config: CameraCapturerConfiguration | number | 错误码索引 |
startLastmileProbeTest | config: LastmileProbeConfig | number | 错误码索引 |
startLocalVideoTranscoder | config: LocalTranscoderConfiguration | number | 错误码索引 |
startOrUpdateChannelMediaRelay | channelMediaRelayConfiguration: ChannelMediaRelayConfiguration | number | 错误码索引 |
startPreview | sourceType?: Constants.VideoSourceType | number | 错误码索引 |
startRtmpStreamWithTranscoding | url: string, transcoding: LiveTranscoding | number | 错误码索引 |
startRtmpStreamWithoutTranscoding | url: string | number | 错误码索引 |
startScreenCapture | screenCaptureParameters: ScreenCaptureParameters | number | 错误码索引 |
stopAudioMixing | — | number | 错误码索引 |
stopAudioRecording | — | number | 错误码索引 |
stopCameraCapture | sourceType: Constants.VideoSourceType | number | 错误码索引 |
stopChannelMediaRelay | — | number | 错误码索引 |
stopLastmileProbeTest | — | number | 错误码索引 |
stopPreview | sourceType?: Constants.VideoSourceType | number | 错误码索引 |
stopRtmpStream | url: string | number | 错误码索引 |
stopScreenCapture | — | number | 错误码索引 |
switchCamera | — | number | 错误码索引 |
takeSnapshot | uid: number, filePath: string | number | 错误码索引 |
updateChannelMediaOptions | options: ChannelMediaOptions | number | 错误码索引 |
updateLocalTranscoderConfiguration | config: LocalTranscoderConfiguration | number | 错误码索引 |
updateRtmpTranscoding | transcoding: LiveTranscoding | number | 错误码索引 |
RtcEngineConfig 0 方法 / 5 属性
| 属性 | 类型 | 只读 |
|---|---|---|
mEventHandler | unknown | 否 |
mAppId | unknown | 否 |
mContext | unknown | 否 |
mLogConfig | unknown | 否 |
mParameters | unknown | 否 |
RtcEngineEx 19 方法 / 0 属性
adjustUserPlaybackSignalVolumeEx(uid: number, volume: number, connection: RtcConnection): number
createDataStreamEx(config: DataStreamConfig, connection: RtcConnection): number
enableAudioVolumeIndicationEx(interval: number, smooth: number, reportVad: boolean, connection: RtcConnection): number
getCallIdEx(connection: RtcConnection): string
joinChannelEx(token: string, connection: RtcConnection, options: ChannelMediaOptions, eventHandler: IRtcEngineEventHandler): number
leaveChannelEx(connection: RtcConnection, options?: LeaveChannelOptions): number
muteAllRemoteAudioStreamsEx(muted: boolean, connection: RtcConnection): number
muteAllRemoteVideoStreamsEx(muted: boolean, connection: RtcConnection): number
muteLocalAudioStreamEx(muted: boolean, connection: RtcConnection): number
muteLocalVideoStreamEx(muted: boolean, connection: RtcConnection): number
muteRemoteAudioStreamEx(uid: number, muted: boolean, connection: RtcConnection): number
muteRemoteVideoStreamEx(uid: number, muted: boolean, connection: RtcConnection): number
setDualStreamModeEx(mode: Constants.SimulcastStreamMode, streamConfig: SimulcastStreamConfig, connection: RtcConnection): number
setRemoteVideoStreamTypeEx(uid: number, streamType: number, connection: RtcConnection): number
setRemoteVoicePositionEx(uid: unknown, pan: unknown, gain: unknown, connection: unknown): unknown
setVideoEncoderConfigurationEx(configuration: VideoEncoderConfiguration, connection: RtcConnection): number
setupRemoteVideoEx(remote: VideoCanvas, connection: RtcConnection): number
startOrUpdateChannelMediaRelayEx(channelMediaRelayConfiguration: ChannelMediaRelayConfiguration, connection: RtcConnection): number
updateChannelMediaOptionsEx(options: ChannelMediaOptions, connection: RtcConnection): number方法明细:19 / 19(参数、返回值、错误码)
| 方法 | 参数 | 返回值 | 错误 |
|---|---|---|---|
adjustUserPlaybackSignalVolumeEx | uid: number, volume: number, connection: RtcConnection | number | 错误码索引 |
createDataStreamEx | config: DataStreamConfig, connection: RtcConnection | number | 错误码索引 |
enableAudioVolumeIndicationEx | interval: number, smooth: number, reportVad: boolean, connection: RtcConnection | number | 错误码索引 |
getCallIdEx | connection: RtcConnection | string | 错误码索引 |
joinChannelEx | token: string, connection: RtcConnection, options: ChannelMediaOptions, eventHandler: IRtcEngineEventHandler | number | 错误码索引 |
leaveChannelEx | connection: RtcConnection, options?: LeaveChannelOptions | number | 错误码索引 |
muteAllRemoteAudioStreamsEx | muted: boolean, connection: RtcConnection | number | 错误码索引 |
muteAllRemoteVideoStreamsEx | muted: boolean, connection: RtcConnection | number | 错误码索引 |
muteLocalAudioStreamEx | muted: boolean, connection: RtcConnection | number | 错误码索引 |
muteLocalVideoStreamEx | muted: boolean, connection: RtcConnection | number | 错误码索引 |
muteRemoteAudioStreamEx | uid: number, muted: boolean, connection: RtcConnection | number | 错误码索引 |
muteRemoteVideoStreamEx | uid: number, muted: boolean, connection: RtcConnection | number | 错误码索引 |
setDualStreamModeEx | mode: Constants.SimulcastStreamMode, streamConfig: SimulcastStreamConfig, connection: RtcConnection | number | 错误码索引 |
setRemoteVideoStreamTypeEx | uid: number, streamType: number, connection: RtcConnection | number | 错误码索引 |
setRemoteVoicePositionEx | uid: unknown, pan: unknown, gain: unknown, connection: unknown | unknown | 错误码索引 |
setVideoEncoderConfigurationEx | configuration: VideoEncoderConfiguration, connection: RtcConnection | number | 错误码索引 |
setupRemoteVideoEx | remote: VideoCanvas, connection: RtcConnection | number | 错误码索引 |
startOrUpdateChannelMediaRelayEx | channelMediaRelayConfiguration: ChannelMediaRelayConfiguration, connection: RtcConnection | number | 错误码索引 |
updateChannelMediaOptionsEx | options: ChannelMediaOptions, connection: RtcConnection | number | 错误码索引 |
RtcStats 0 方法 / 24 属性
| 属性 | 类型 | 只读 |
|---|---|---|
totalDuration | 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 | 否 |
users | unknown | 否 |
cpuAppUsage | unknown | 否 |
cpuTotalUsage | unknown | 否 |
connectTimeMs | unknown | 否 |
gatewayRtt | unknown | 否 |
memoryAppUsageRatio | unknown | 否 |
memoryTotalUsageRatio | unknown | 否 |
memoryAppUsageInKbytes | unknown | 否 |
ScreenCaptureParameters 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
dimensions | unknown | 否 |
frameRate | unknown | 否 |
bitrate | unknown | 否 |
SegmentationProperty 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
modelType | unknown | 否 |
greenCapacity | unknown | 否 |
SimulcastStreamConfig 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
dimensions | unknown | 否 |
bitrate | unknown | 否 |
framerate | 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 方法 / 7 属性
| 属性 | 类型 | 只读 |
|---|---|---|
sourceType | unknown | 否 |
remoteUserUid | unknown | 否 |
imageUrl | unknown | 否 |
mediaPlayerId | unknown | 否 |
zOrder | unknown | 否 |
alpha | unknown | 否 |
mirror | unknown | 否 |
UserInfo 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
uid | unknown | 否 |
userAccount | unknown | 否 |
VideoCanvas 0 方法 / 5 属性
| 属性 | 类型 | 只读 |
|---|---|---|
uid | unknown | 否 |
xcomponentId | unknown | 否 |
renderMode | unknown | 否 |
mirrorMode | unknown | 否 |
sourceType | unknown | 否 |
VideoCaptureParameters 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
dimensions | unknown | 否 |
frameRate | unknown | 否 |
bitrate | unknown | 否 |
VideoDenoiserOptions 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
level | unknown | 否 |
mode | unknown | 否 |
VideoDimensions 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
width | this. | 否 |
height | this. | 否 |
VideoEncoderConfiguration 0 方法 / 9 属性
| 属性 | 类型 | 只读 |
|---|---|---|
dimensions | unknown | 否 |
codecType | unknown | 否 |
frameRate | unknown | 否 |
bitrate | unknown | 否 |
minBitrate | unknown | 否 |
orientationMode | unknown | 否 |
degradationPreference | unknown | 否 |
mirrorMode | unknown | 否 |
advanceOptions | unknown | 否 |
VideoFrame 0 方法 / 18 属性
| 属性 | 类型 | 只读 |
|---|---|---|
type | unknown | 否 |
format | unknown | 否 |
width | unknown | 否 |
height | unknown | 否 |
stride | unknown | 否 |
uStride | unknown | 否 |
vStride | unknown | 否 |
yBuffer | unknown | 否 |
uBuffer | unknown | 否 |
vBuffer | unknown | 否 |
buffer | unknown | 否 |
rotation | unknown | 否 |
timestampNs | unknown | 否 |
colorSpace | unknown | 否 |
sourceType | unknown | 否 |
sampleAspectRatio | unknown | 否 |
alphaStitchMode | unknown | 否 |
metaInfo | unknown | 否 |
VideoLayout 0 方法 / 8 属性
| 属性 | 类型 | 只读 |
|---|---|---|
channelId | unknown | 否 |
uid | unknown | 否 |
strUid | unknown | 否 |
x | unknown | 否 |
y | unknown | 否 |
width | unknown | 否 |
height | unknown | 否 |
videoState | unknown | 否 |
VideoSubscriptionOptions 0 方法 / 2 属性
| 属性 | 类型 | 只读 |
|---|---|---|
streamType | unknown | 否 |
encodedFrameOnly | unknown | 否 |
VirtualBackgroundSource 0 方法 / 4 属性
| 属性 | 类型 | 只读 |
|---|---|---|
backgroundSourceType | unknown | 否 |
color | unknown | 否 |
source | unknown | 否 |
blurDegree | unknown | 否 |
WatermarkOptions 0 方法 / 3 属性
| 属性 | 类型 | 只读 |
|---|---|---|
visibleInPreview | unknown | 否 |
positionInLandscapeMode | unknown | 否 |
positionInPortraitMode | unknown | 否 |
枚举
| 枚举 | 成员数 | 示例值 |
|---|---|---|
AreaCode | 7 | AREA_CODE_CN = null |
AudienceLatencyLevel | 2 | LOW_LATENCY = 1 |
AudioCodecProfileType | 3 | LC_AAC = 0 |
AudioDualMonoMode | 4 | STEREO = 0 |
AudioEffectPreset | 21 | AUDIO_EFFECT_OFF = null |
AudioEqualizationBandFrequency | 10 | BAND_31 = 0 |
AudioMixingDualMonoMode | 4 | AUTO = 0 |
AudioMixingReason | 7 | OK = 0 |
AudioMixingState | 4 | PLAYING = 710 |
AudioProfileType | 4 | SPEECH_STANDARD = 1 |
AudioRecordingQuality | 4 | LOW = 0 |
AudioRecordingType | 3 | MIC = 1 |
AudioReverbType | 5 | DRY_LEVEL = 0 |
AudioSampleRateType | 3 | TYPE_32000 = 32000 |
AudioScenarioType | 4 | GAME_STREAMING = 3 |
AudioTrackType | 2 | MIXABLE = 0 |
CameraDirection | 3 | REAR = 0 |
ChannelMediaRelayError | 12 | OK = 0 |
ChannelMediaRelayState | 4 | IDLE = 0 |
ChannelProfile | 2 | COMMUNICATION = 0 |
ClientRole | 2 | BROADCASTER = 1 |
CompressionPrefence | 2 | PREFER_LOW_LATENCY = 0 |
ConnectionChangedReason | 21 | CONNECTING = 0 |
ConnectionState | 5 | DISCONNECTED = 1 |
ContentInspectType | 3 | INVALID = 0 |
DegradationPreference | 4 | MAINTAIN_QUALITY = 0 |
EarMontoringFilterType | 3 | BUILT_IN_AUDIO_FILTERS = null |
EncryptionError | 5 | INTERNAL_FAILURE = 0 |
EncryptionMode | 9 | AES_128_XTS = 1 |
ErrorCode | 40 | ERR_OK = 0 |
ExternalVideoSourceType | 2 | VIDEO_FRAME = 0 |
FeatureType | 2 | VIDEO_VIRTUAL_BACKGROUND = 1 |
FRAME_RATE | 6 | FRAME_RATE_FPS_1 = 1 |
HEADPHONE_EQUALIZER_PRESET | 3 | HEADPHONE_EQUALIZER_OFF = null |
LastmileProbeResult | 3 | COMPLETE = 1 |
LocalAudioStreamReason | 5 | OK = 0 |
LocalAudioStreamState | 4 | STOPPED = 0 |
LocalVideoStreamReason | 10 | OK = 0 |
LocalVideoStreamState | 4 | STOPPED = 0 |
LogFilter | 6 | OFF = 0 |
LogLevel | 5 | LOG_LEVEL_NONE = 0 |
MEDIA_TRACE_EVENT | 2 | MEDIA_TRACE_EVENT_VIDEO_RENDERED = 0 |
MediaPlayerEvent | 15 | UNKNOWN = -1 |
MediaPlayerMetadataType | 2 | PLAYER_METADATA_TYPE_UNKNOWN = 0 |
MediaPlayerPreloadEvent | 3 | PLAYER_PRELOAD_EVENT_BEGIN = 0 |
MediaPlayerReason | 16 | PLAYER_REASON_NONE = 0 |
MediaPlayerState | 10 | UNKNOWN = -1 |
MediaSourceType | 6 | AUDIO_PLAYOUT_SOURCE = 0 |
MediaStreamType | 4 | STREAM_TYPE_UNKNOWN = 0 |
MusicCacheStatusType | 2 | MUSIC_CACHE_STATUS_TYPE_CACHED = 0 |
MusicContentCenterStateReason | 8 | OK = 0 |
MusicPlayMode | 3 | ORIGINAL = 0 |
NetworkQuality | 7 | UNKNOWN = 0 |
ORIENTATION_MODE | 3 | ORIENTATION_MODE_ADAPTIVE = 0 |
PermissionType | 2 | RECORD_AUDIO = 0 |
PreloadState | 4 | PRELOAD_STATE_COMPLETED = 0 |
PRESET | 9 | OFF = null |
RawAudioFrameOpMode | 2 | RAW_AUDIO_FRAME_OP_MODE_READ_ONLY = 0 |
RemoteAudioState | 5 | STOPPED = 0 |
RemoteAudioStateReason | 8 | INTERNAL = 0 |
RemoteVideoStreamReason | 11 | INTERNAL = 0 |
RemoteVideoStreamState | 5 | STOPPED = 0 |
RtmpStreamingEvent | 4 | FAILED_LOAD_IMAGE = 1 |
RtmpStreamPublishReason | 15 | OK = 0 |
RtmpStreamPublishState | 6 | IDLE = 0 |
ScreenCaptureContentHint | 2 | MOTION = null |
ScreenScenarioType | 3 | SCREEN_SCENARIO_DOCUMENT = 1 |
SegModelType | 2 | AI = 1 |
SimulcastStreamMode | 3 | AUTO = -1 |
StreamFallbackOptions | 3 | STREAM_FALLBACK_OPTION_DISABLED = 0 |
StreamPublishState | 4 | IDLE = 0 |
StreamSubscribeState | 4 | IDLE = 0 |
VIDEO_CODEC_CAPABILITY_LEVEL | 5 | CODEC_CAPABILITY_LEVEL_UNSPECIFIED = -1 |
VideoBufferType | 3 | RAW_DATA = 1 |
VideoCodecProfileType | 3 | BASELINE = 66 |
VideoCodecType | 2 | H264 = 2 |
VideoFrameProcessMode | 2 | READ_ONLY = null |
VideoModulePosition | 4 | POST_CAPTURER = 1 |
VideoPixelFormat | 3 | I420 = 1 |
VideoScenario | 1 | GENERAL = 0 |
VideoSourceType | 10 | CAMERA_SECONDARY = 1 |
VideoStreamType | 2 | HIGH = 0 |
VideoTranscoderError | 6 | VIDEO_SOURCE_NOT_READY = 1 |
VirtualBackgroundBlurDegree | 3 | LOW = 1 |
VirtualBackgroundType | 4 | COLOR = 1 |
VoiceBeautifierPreset | 14 | VOICE_BEAUTIFIER_OFF = null |
AreaCode 7 个成员
| 成员 | 值 |
|---|---|
AREA_CODE_CN | null |
AREA_CODE_NA | null |
AREA_CODE_EU | null |
AREA_CODE_AS | null |
AREA_CODE_JP | null |
AREA_CODE_IN | null |
AREA_CODE_GLOB | null |
AudienceLatencyLevel 2 个成员
| 成员 | 值 |
|---|---|
LOW_LATENCY | 1 |
ULTRA_LOW_LATENCY | 2 |
AudioCodecProfileType 3 个成员
| 成员 | 值 |
|---|---|
LC_AAC | 0 |
HE_AAC | 1 |
HE_AAC_V2 | 2 |
AudioDualMonoMode 4 个成员
| 成员 | 值 |
|---|---|
STEREO | 0 |
L | 1 |
R | 2 |
MIX | 3 |
AudioEffectPreset 21 个成员
| 成员 | 值 |
|---|---|
AUDIO_EFFECT_OFF | null |
ROOM_ACOUSTICS_KTV | null |
ROOM_ACOUSTICS_VOCAL_CONCERT | null |
ROOM_ACOUSTICS_STUDIO | null |
ROOM_ACOUSTICS_PHONOGRAPH | null |
ROOM_ACOUSTICS_VIRTUAL_STEREO | null |
ROOM_ACOUSTICS_SPACIAL | null |
ROOM_ACOUSTICS_ETHEREAL | null |
ROOM_ACOUSTICS_VIRTUAL_SURROUND_SOUND | null |
ROOM_ACOUSTICS_CHORUS | null |
ROOM_ACOUSTICS_3D_VOICE | null |
VOICE_CHANGER_EFFECT_UNCLE | null |
VOICE_CHANGER_EFFECT_OLDMAN | null |
VOICE_CHANGER_EFFECT_BOY | null |
VOICE_CHANGER_EFFECT_SISTER | null |
VOICE_CHANGER_EFFECT_GIRL | null |
VOICE_CHANGER_EFFECT_PIGKING | null |
VOICE_CHANGER_EFFECT_HULK | null |
STYLE_TRANSFORMATION_RNB | null |
STYLE_TRANSFORMATION_POPULAR | null |
PITCH_CORRECTION | null |
AudioEqualizationBandFrequency 10 个成员
| 成员 | 值 |
|---|---|
BAND_31 | 0 |
BAND_62 | 1 |
BAND_125 | 2 |
BAND_250 | 3 |
BAND_500 | 4 |
BAND_1K | 5 |
BAND_2K | 6 |
BAND_4K | 7 |
BAND_8K | 8 |
BAND_16K | 9 |
AudioMixingDualMonoMode 4 个成员
| 成员 | 值 |
|---|---|
AUTO | 0 |
L | 1 |
R | 2 |
MIX | 3 |
AudioMixingReason 7 个成员
| 成员 | 值 |
|---|---|
OK | 0 |
CAN_NOT_OPEN | 701 |
TOO_FREQUENT_CALL | 702 |
INTERRUPTED_EOF | 703 |
ONE_LOOP_COMPLETED | 721 |
ALL_LOOPS_COMPLETED | 723 |
STOPPED_BY_USER | 724 |
AudioMixingState 4 个成员
| 成员 | 值 |
|---|---|
PLAYING | 710 |
PAUSED | 711 |
STOPPED | 713 |
FAILED | 714 |
AudioProfileType 4 个成员
| 成员 | 值 |
|---|---|
SPEECH_STANDARD | 1 |
MUSIC_STANDARD | 2 |
MUSIC_STANDARD_STEREO | 3 |
MUSIC_HIGH_QUALITY_STEREO | 5 |
AudioRecordingQuality 4 个成员
| 成员 | 值 |
|---|---|
LOW | 0 |
MEDIUM | 1 |
HIGH | 2 |
ULTRA_HIGH | 3 |
AudioRecordingType 3 个成员
| 成员 | 值 |
|---|---|
MIC | 1 |
PLAYBACK | 2 |
MIXED | 3 |
AudioReverbType 5 个成员
| 成员 | 值 |
|---|---|
DRY_LEVEL | 0 |
WET_LEVEL | 1 |
ROOM_SIZE | 2 |
WET_DELAY | 3 |
STRENGTH | 4 |
AudioSampleRateType 3 个成员
| 成员 | 值 |
|---|---|
TYPE_32000 | 32000 |
TYPE_44100 | 44100 |
TYPE_48000 | 48000 |
AudioScenarioType 4 个成员
| 成员 | 值 |
|---|---|
GAME_STREAMING | 3 |
CHATROOM | 5 |
CHORUS | 7 |
MEETING | 8 |
AudioTrackType 2 个成员
| 成员 | 值 |
|---|---|
MIXABLE | 0 |
DIRECT | 1 |
CameraDirection 3 个成员
| 成员 | 值 |
|---|---|
REAR | 0 |
FRONT | 1 |
EXTRA | 2 |
ChannelMediaRelayError 12 个成员
| 成员 | 值 |
|---|---|
OK | 0 |
SERVER_ERROR_RESPONSE | 1 |
SERVER_NO_RESPONSE | 2 |
NO_RESOURCE_AVAILABLE | 3 |
FAILED_JOIN_SRC | 4 |
FAILED_JOIN_DEST | 5 |
FAILED_PACKET_RECEIVED_FROM_SRC | 6 |
FAILED_PACKET_SENT_TO_DEST | 7 |
SERVER_CONNECTION_LOST | 8 |
INTERNAL_ERROR | 9 |
SRC_TOKEN_EXPIRED | 10 |
DEST_TOKEN_EXPIRED | 11 |
ChannelMediaRelayState 4 个成员
| 成员 | 值 |
|---|---|
IDLE | 0 |
CONNECTING | 1 |
RUNNING | 2 |
FAILURE | 3 |
ChannelProfile 2 个成员
| 成员 | 值 |
|---|---|
COMMUNICATION | 0 |
LIVE_BROADCASTING | 1 |
ClientRole 2 个成员
| 成员 | 值 |
|---|---|
BROADCASTER | 1 |
AUDIENCE | 2 |
CompressionPrefence 2 个成员
| 成员 | 值 |
|---|---|
PREFER_LOW_LATENCY | 0 |
PREFER_QUALITY | 1 |
ConnectionChangedReason 21 个成员
| 成员 | 值 |
|---|---|
CONNECTING | 0 |
JOIN_SUCCESS | 1 |
INTERRUPTED | 2 |
BANNED_BY_SERVER | 3 |
JOIN_FAILED | 4 |
LEAVE_CHANNEL | 5 |
INVALID_APP_ID | 6 |
INVALID_CHANNEL_NAME | 7 |
INVALID_TOKEN | 8 |
TOKEN_EXPIRED | 9 |
REJECTED_BY_SERVER | 10 |
SETTING_PROXY_SERVER | 11 |
RENEW_TOKEN | 12 |
CLIENT_IP_ADDRESS_CHANGED | 13 |
KEEP_ALIVE_TIMEOUT | 14 |
REJOIN_SUCCESS | 15 |
LOST | 16 |
ECHO_TEST | 17 |
CLIENT_IP_ADDRESS_CHANGED_BY_USER | 18 |
SAME_UID_LOGIN | 19 |
TOO_MANY_BROADCASTERS | 20 |
ConnectionState 5 个成员
| 成员 | 值 |
|---|---|
DISCONNECTED | 1 |
CONNECTING | 2 |
CONNECTED | 3 |
RECONNECTING | 4 |
FAILED | 5 |
ContentInspectType 3 个成员
| 成员 | 值 |
|---|---|
INVALID | 0 |
SUPERVISE | 2 |
IMAGE_MODERATION | 3 |
DegradationPreference 4 个成员
| 成员 | 值 |
|---|---|
MAINTAIN_QUALITY | 0 |
MAINTAIN_FRAMERATE | 1 |
MAINTAIN_BALANCED | 2 |
MAINTAIN_RESOLUTION | 3 |
EarMontoringFilterType 3 个成员
| 成员 | 值 |
|---|---|
BUILT_IN_AUDIO_FILTERS | null |
NOISE_SUPPRESSION | null |
REUSE_POST_PROCESSING_FILTER | null |
EncryptionError 5 个成员
| 成员 | 值 |
|---|---|
INTERNAL_FAILURE | 0 |
DECRYPTION_FAILURE | 1 |
ENCRYPTION_FAILURE | 2 |
DATASTREAM_DECRYPTION_FAILURE | 3 |
DATASTREAM_ENCRYPTION_FAILURE | 4 |
EncryptionMode 9 个成员
| 成员 | 值 |
|---|---|
AES_128_XTS | 1 |
AES_128_ECB | 2 |
AES_256_XTS | 3 |
SM4_128_ECB | 4 |
AES_128_GCM | 5 |
AES_256_GCM | 6 |
AES_128_GCM2 | 7 |
AES_256_GCM2 | 8 |
MODE_END | null |
ErrorCode 40 个成员
| 成员 | 值 |
|---|---|
ERR_OK | 0 |
ERR_FAILED | 1 |
ERR_INVALID_ARGUMENT | 2 |
ERR_NOT_READY | 3 |
RtcEngine | null |
ERR_NOT_SUPPORTED | 4 |
ERR_REFUSED | 5 |
ERR_BUFFER_TOO_SMALL | 6 |
ERR_NOT_INITIALIZED | 7 |
ERR_NO_PERMISSION | 9 |
ERR_TIMEDOUT | 10 |
ERR_JOIN_CHANNEL_REJECTED | 17 |
ERR_LEAVE_CHANNEL_REJECTED | 18 |
ERR_ALREADY_IN_USE | 19 |
ERR_ABORTED | 20 |
ERR_INIT_NET_ENGINE | 21 |
ERR_RESOURCE_LIMITED | 22 |
ERR_INVALID_APP_ID | 101 |
ERR_INVALID_CHANNEL_NAME | 102 |
ERR_TOKEN_EXPIRED | 109 |
ERR_INVALID_TOKEN | 110 |
ERR_CONNECTION_INTERRUPTED | 111 |
ERR_CONNECTION_LOST | 112 |
ERR_NOT_IN_CHANNEL | 113 |
ERR_SIZE_TOO_LARGE | 114 |
ERR_BITRATE_LIMIT | 115 |
ERR_TOO_MANY_DATA_STREAMS | 116 |
ERR_DECRYPTION_FAILED | 120 |
ERR_DATASTREAM_DECRYPTION_FAILED | 122 |
ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISH | 130 |
ERR_INVALID_USER_ACCOUNT | 134 |
ERR_LOAD_MEDIA_ENGINE | 1001 |
ERR_ADM_GENERAL_ERROR | 1005 |
ERR_ADM_INIT_PLAYOUT | 1008 |
ERR_ADM_START_PLAYOUT | 1009 |
ERR_ADM_STOP_PLAYOUT | 1010 |
ERR_ADM_INIT_RECORDING | 1011 |
ERR_ADM_START_RECORDING | 1012 |
ERR_ADM_STOP_RECORDING | 1013 |
ERR_VDM_CAMERA_NOT_AUTHORIZED | 1501 |
ExternalVideoSourceType 2 个成员
| 成员 | 值 |
|---|---|
VIDEO_FRAME | 0 |
ENCODED_VIDEO_FRAME | 1 |
FeatureType 2 个成员
| 成员 | 值 |
|---|---|
VIDEO_VIRTUAL_BACKGROUND | 1 |
VIDEO_BEAUTY_EFFECT | 2 |
FRAME_RATE 6 个成员
| 成员 | 值 |
|---|---|
FRAME_RATE_FPS_1 | 1 |
FRAME_RATE_FPS_7 | 7 |
FRAME_RATE_FPS_10 | 10 |
FRAME_RATE_FPS_15 | 15 |
FRAME_RATE_FPS_24 | 24 |
FRAME_RATE_FPS_30 | 30 |
HEADPHONE_EQUALIZER_PRESET 3 个成员
| 成员 | 值 |
|---|---|
HEADPHONE_EQUALIZER_OFF | null |
HEADPHONE_EQUALIZER_OVEREAR | null |
HEADPHONE_EQUALIZER_INEAR | null |
LastmileProbeResult 3 个成员
| 成员 | 值 |
|---|---|
COMPLETE | 1 |
INCOMPLETE_NO_BWE | 2 |
UNAVAILABLE | 3 |
LocalAudioStreamReason 5 个成员
| 成员 | 值 |
|---|---|
OK | 0 |
FAILURE | 1 |
DEVICE_NO_PERMISSION | 2 |
CAPTURE_FAILURE | 4 |
ENCODE_FAILURE | 5 |
LocalAudioStreamState 4 个成员
| 成员 | 值 |
|---|---|
STOPPED | 0 |
RECORDING | 1 |
ENCODING | 2 |
FAILED | 3 |
LocalVideoStreamReason 10 个成员
| 成员 | 值 |
|---|---|
OK | 0 |
FAILURE | 1 |
DEVICE_NO_PERMISSION | 2 |
DEVICE_BUSY | 3 |
CAPTURE_FAILURE | 4 |
CODEC_NOT_SUPPORT | 5 |
DEVICE_NOT_FOUND | 8 |
SCREEN_CAPTURE_STOPPED_BY_USER | 31 |
SCREEN_CAPTURE_INTERRUPTED_BY_OTHER | 32 |
SCREEN_CAPTURE_STOPPED_BY_CALL | 33 |
LocalVideoStreamState 4 个成员
| 成员 | 值 |
|---|---|
STOPPED | 0 |
CAPTURING | 1 |
ENCODING | 2 |
FAILED | 3 |
LogFilter 6 个成员
| 成员 | 值 |
|---|---|
OFF | 0 |
DEBUG | 2063 |
INFO | 15 |
WARN | 14 |
ERROR | 12 |
CRITICAL | 8 |
LogLevel 5 个成员
| 成员 | 值 |
|---|---|
LOG_LEVEL_NONE | 0 |
LOG_LEVEL_INFO | 1 |
LOG_LEVEL_WARN | 2 |
LOG_LEVEL_ERROR | 4 |
LOG_LEVEL_FATAL | 8 |
MEDIA_TRACE_EVENT 2 个成员
| 成员 | 值 |
|---|---|
MEDIA_TRACE_EVENT_VIDEO_RENDERED | 0 |
MEDIA_TRACE_EVENT_VIDEO_DECODED | 1 |
MediaPlayerEvent 15 个成员
| 成员 | 值 |
|---|---|
UNKNOWN | -1 |
SEEK_BEGIN | 0 |
SEEK_COMPLETE | 1 |
SEEK_ERROR | 2 |
AUDIO_TRACK_CHANGED | 5 |
BUFFER_LOW | 6 |
BUFFER_RECOVER | 7 |
FREEZE_START | 8 |
FREEZE_STOP | 9 |
SWITCH_BEGIN | 10 |
SWITCH_COMPLETE | 11 |
SWITCH_ERROR | 12 |
FIRST_DISPLAYED | 13 |
REACH_CACHE_FILE_MAX_COUNT | 14 |
REACH_CACHE_FILE_MAX_SIZE | 15 |
MediaPlayerMetadataType 2 个成员
| 成员 | 值 |
|---|---|
PLAYER_METADATA_TYPE_UNKNOWN | 0 |
PLAYER_METADATA_TYPE_SEI | 1 |
MediaPlayerPreloadEvent 3 个成员
| 成员 | 值 |
|---|---|
PLAYER_PRELOAD_EVENT_BEGIN | 0 |
PLAYER_PRELOAD_EVENT_COMPLETE | 1 |
PLAYER_PRELOAD_EVENT_ERROR | 2 |
MediaPlayerReason 16 个成员
| 成员 | 值 |
|---|---|
PLAYER_REASON_NONE | 0 |
PLAYER_REASON_INVALID_ARGUMENTS | -1 |
PLAYER_REASON_INTERNAL | -2 |
PLAYER_REASON_NO_RESOURCE | -3 |
PLAYER_REASON_INVALID_MEDIA_SOURCE | -4 |
PLAYER_REASON_UNKNOWN_STREAM_TYPE | -5 |
PLAYER_REASON_OBJ_NOT_INITIALIZED | -6 |
PLAYER_REASON_CODEC_NOT_SUPPORTED | -7 |
PLAYER_REASON_VIDEO_RENDER_FAILED | -8 |
PLAYER_REASON_INVALID_STATE | -9 |
PLAYER_REASON_URL_NOT_FOUND | -10 |
PLAYER_REASON_INVALID_CONNECTION_STATE | -11 |
PLAYER_REASON_SRC_BUFFER_UNDERFLOW | -12 |
PLAYER_REASON_INTERRUPTED | -13 |
PLAYER_REASON_NOT_SUPPORTED | -14 |
PLAYER_REASON_UNKNOWN | -17 |
MediaPlayerState 10 个成员
| 成员 | 值 |
|---|---|
UNKNOWN | -1 |
IDLE | 0 |
OPENING | 1 |
OPEN_COMPLETED | 2 |
PLAYING | 3 |
PAUSED | 4 |
PLAYBACK_COMPLETED | 5 |
PLAYBACK_ALL_LOOPS_COMPLETED | 6 |
STOPPED | 7 |
FAILED | 100 |
MediaSourceType 6 个成员
| 成员 | 值 |
|---|---|
AUDIO_PLAYOUT_SOURCE | 0 |
AUDIO_RECORDING_SOURCE | 1 |
PRIMARY_CAMERA_SOURCE | 2 |
SECONDARY_CAMERA_SOURCE | 3 |
CUSTOM_VIDEO_SOURCE | 6 |
UNKNOWN_MEDIA_SOURCE | 100 |
MediaStreamType 4 个成员
| 成员 | 值 |
|---|---|
STREAM_TYPE_UNKNOWN | 0 |
STREAM_TYPE_VIDEO | 1 |
STREAM_TYPE_AUDIO | 2 |
STREAM_TYPE_SUBTITLE | 3 |
MusicCacheStatusType 2 个成员
| 成员 | 值 |
|---|---|
MUSIC_CACHE_STATUS_TYPE_CACHED | 0 |
MUSIC_CACHE_STATUS_TYPE_CACHING | 1 |
MusicContentCenterStateReason 8 个成员
| 成员 | 值 |
|---|---|
OK | 0 |
ERROR | 1 |
GATEWAY | 2 |
PERMISSION_AND_RESOURCE | 3 |
INTERNAL_DATA_PARSE | 4 |
MUSIC_LOADING | 5 |
MUSIC_DECRYPTION | 6 |
HTTP_INTERNAL | 7 |
MusicPlayMode 3 个成员
| 成员 | 值 |
|---|---|
ORIGINAL | 0 |
ACCOMPANY | 1 |
LEAD_SING | 2 |
NetworkQuality 7 个成员
| 成员 | 值 |
|---|---|
UNKNOWN | 0 |
EXCELLENT | 1 |
GOOD | 2 |
POOR | 3 |
BAD | 4 |
VBAD | 5 |
DOWN | 6 |
ORIENTATION_MODE 3 个成员
| 成员 | 值 |
|---|---|
ORIENTATION_MODE_ADAPTIVE | 0 |
ORIENTATION_FIXED_LANDSCAPE | 1 |
ORIENTATION_FIXED_PORTRAIT | 2 |
PermissionType 2 个成员
| 成员 | 值 |
|---|---|
RECORD_AUDIO | 0 |
CAMERA | 1 |
PreloadState 4 个成员
| 成员 | 值 |
|---|---|
PRELOAD_STATE_COMPLETED | 0 |
PRELOAD_STATE_FAILED | 1 |
PRELOAD_STATE_PRELOADING | 2 |
PRELOAD_STATE_REMOVED | 3 |
PRESET 9 个成员
| 成员 | 值 |
|---|---|
OFF | null |
FX_KTV | null |
FX_VOCAL_CONCERT | null |
FX_UNCLE | null |
FX_SISTER | null |
FX_STUDIO | null |
FX_POPULAR | null |
FX_RNB | null |
FX_PHONOGRAPH | null |
RawAudioFrameOpMode 2 个成员
| 成员 | 值 |
|---|---|
RAW_AUDIO_FRAME_OP_MODE_READ_ONLY | 0 |
RAW_AUDIO_FRAME_OP_MODE_READ_WRITE | 2 |
RemoteAudioState 5 个成员
| 成员 | 值 |
|---|---|
STOPPED | 0 |
STARTING | 1 |
DECODING | 2 |
FROZEN | 3 |
FAILED | 4 |
RemoteAudioStateReason 8 个成员
| 成员 | 值 |
|---|---|
INTERNAL | 0 |
NETWORK_CONGESTION | 1 |
NETWORK_RECOVERY | 2 |
LOCAL_MUTED | 3 |
LOCAL_UNMUTED | 4 |
REMOTE_MUTED | 5 |
REMOTE_UNMUTED | 6 |
REMOTE_OFFLINE | 7 |
RemoteVideoStreamReason 11 个成员
| 成员 | 值 |
|---|---|
INTERNAL | 0 |
NETWORK_CONGESTION | 1 |
NETWORK_RECOVERY | 2 |
LOCAL_MUTED | 3 |
LOCAL_UNMUTED | 4 |
REMOTE_MUTED | 5 |
REMOTE_UNMUTED | 6 |
REMOTE_OFFLINE | 7 |
AUDIO_FALLBACK | 8 |
AUDIO_FALLBACK_RECOVERY | 9 |
CODEC_NOT_SUPPORT | 13 |
RemoteVideoStreamState 5 个成员
| 成员 | 值 |
|---|---|
STOPPED | 0 |
STARTING | 1 |
DECODING | 2 |
FROZEN | 3 |
FAILED | 4 |
RtmpStreamingEvent 4 个成员
| 成员 | 值 |
|---|---|
FAILED_LOAD_IMAGE | 1 |
URL_ALREADY_IN_USE | 2 |
ADVANCED_FEATURE_NOT_SUPPORT | 3 |
REQUEST_TOO_OFTEN | 4 |
RtmpStreamPublishReason 15 个成员
| 成员 | 值 |
|---|---|
OK | 0 |
INVALID_ARGUMENT | 1 |
ENCRYPTED_STREAM_NOT_ALLOWED | 2 |
CONNECTION_TIMEOUT | 3 |
INTERNAL_SERVER_ERROR | 4 |
RTMP_SERVER_ERROR | 5 |
TOO_OFTEN | 6 |
REACH_LIMIT | 7 |
NOT_AUTHORIZED | 8 |
STREAM_NOT_FOUND | 9 |
FORMAT_NOT_SUPPORTED | 10 |
NOT_BROADCASTER | 11 |
TRANSCODING_NO_MIX_STREAM | 13 |
NET_DOWN | 14 |
INVALID_PRIVILEGE | 16 |
RtmpStreamPublishState 6 个成员
| 成员 | 值 |
|---|---|
IDLE | 0 |
CONNECTING | 1 |
RUNNING | 2 |
RECOVERING | 3 |
FAILURE | 4 |
DISCONNECTING | 5 |
ScreenCaptureContentHint 2 个成员
| 成员 | 值 |
|---|---|
MOTION | null |
DETAILS | null |
ScreenScenarioType 3 个成员
| 成员 | 值 |
|---|---|
SCREEN_SCENARIO_DOCUMENT | 1 |
SCREEN_SCENARIO_GAMING | 2 |
SCREEN_SCENARIO_VIDEO | 3 |
SegModelType 2 个成员
| 成员 | 值 |
|---|---|
AI | 1 |
GREEN | 2 |
SimulcastStreamMode 3 个成员
| 成员 | 值 |
|---|---|
AUTO | -1 |
DISABLE | 0 |
ENABLE | 1 |
StreamFallbackOptions 3 个成员
| 成员 | 值 |
|---|---|
STREAM_FALLBACK_OPTION_DISABLED | 0 |
STREAM_FALLBACK_OPTION_VIDEO_STREAM_LOW | 1 |
STREAM_FALLBACK_OPTION_AUDIO_ONLY | 2 |
StreamPublishState 4 个成员
| 成员 | 值 |
|---|---|
IDLE | 0 |
NO_PUBLISHED | 1 |
PUBLISHING | 2 |
PUBLISHED | 3 |
StreamSubscribeState 4 个成员
| 成员 | 值 |
|---|---|
IDLE | 0 |
NO_SUBSCRIBED | 1 |
SUBSCRIBING | 2 |
SUBSCRIBED | 3 |
VIDEO_CODEC_CAPABILITY_LEVEL 5 个成员
| 成员 | 值 |
|---|---|
CODEC_CAPABILITY_LEVEL_UNSPECIFIED | -1 |
CODEC_CAPABILITY_LEVEL_BASIC_SUPPORT | 5 |
CODEC_CAPABILITY_LEVEL_1080P30FPS | 10 |
CODEC_CAPABILITY_LEVEL_1080P60FPS | 20 |
CODEC_CAPABILITY_LEVEL_4K60FPS | 30 |
VideoBufferType 3 个成员
| 成员 | 值 |
|---|---|
RAW_DATA | 1 |
ARRAY | 2 |
TEXTURE | 3 |
VideoCodecProfileType 3 个成员
| 成员 | 值 |
|---|---|
BASELINE | 66 |
MAIN | 77 |
HIGH | 100 |
VideoCodecType 2 个成员
| 成员 | 值 |
|---|---|
H264 | 2 |
H265 | 3 |
VideoFrameProcessMode 2 个成员
| 成员 | 值 |
|---|---|
READ_ONLY | null |
READ_WRITE | null |
VideoModulePosition 4 个成员
| 成员 | 值 |
|---|---|
POST_CAPTURER | 1 |
PRE_RENDERER | 2 |
PRE_ENCODER | 4 |
POST_CAPTURER_ORIGIN | 8 |
VideoPixelFormat 3 个成员
| 成员 | 值 |
|---|---|
I420 | 1 |
RGBA | 4 |
I422 | 16 |
VideoScenario 1 个成员
| 成员 | 值 |
|---|---|
GENERAL | 0 |
VideoSourceType 10 个成员
| 成员 | 值 |
|---|---|
CAMERA_SECONDARY | 1 |
SCREEN_SECONDARY | 3 |
CUSTOM | 4 |
MEDIA_PLAYER | 5 |
RTC_IMAGE_PNG | 6 |
RTC_IMAGE_JPEG | 7 |
RTC_IMAGE_GIF | 8 |
REMOTE | 9 |
TRANSCODED | 10 |
UNKNOWN | 100 |
VideoStreamType 2 个成员
| 成员 | 值 |
|---|---|
HIGH | 0 |
LOW | 1 |
VideoTranscoderError 6 个成员
| 成员 | 值 |
|---|---|
VIDEO_SOURCE_NOT_READY | 1 |
INVALID_VIDEO_SOURCE_TYPE | 2 |
INVALID_IMAGE_PATH | 3 |
UNSUPPORT_IMAGE_FORMAT | 4 |
INVALID_LAYOUT | 5 |
INTERNAL | 20 |
VirtualBackgroundBlurDegree 3 个成员
| 成员 | 值 |
|---|---|
LOW | 1 |
MEDIUM | 2 |
HIGH | 3 |
VirtualBackgroundType 4 个成员
| 成员 | 值 |
|---|---|
COLOR | 1 |
IMG | 2 |
BLUR | 3 |
VIDEO | 4 |
VoiceBeautifierPreset 14 个成员
| 成员 | 值 |
|---|---|
VOICE_BEAUTIFIER_OFF | null |
CHAT_BEAUTIFIER_MAGNETIC | null |
CHAT_BEAUTIFIER_FRESH | null |
CHAT_BEAUTIFIER_VITALITY | null |
SINGING_BEAUTIFIER | null |
TIMBRE_TRANSFORMATION_VIGOROUS | null |
TIMBRE_TRANSFORMATION_DEEP | null |
TIMBRE_TRANSFORMATION_MELLOW | null |
TIMBRE_TRANSFORMATION_FALSETTO | null |
TIMBRE_TRANSFORMATION_FULL | null |
TIMBRE_TRANSFORMATION_CLEAR | null |
TIMBRE_TRANSFORMATION_RESOUNDING | null |
TIMBRE_TRANSFORMATION_RINGING | null |
ULTRA_HIGH_QUALITY_VOICE | null |
错误码常量
| 常量 | 值 |
|---|---|
ERR_ABORTED | 20 |
ERR_ADM_GENERAL_ERROR | 1005 |
ERR_ADM_INIT_PLAYOUT | 1008 |
ERR_ADM_INIT_RECORDING | 1011 |
ERR_ADM_START_PLAYOUT | 1009 |
ERR_ADM_START_RECORDING | 1012 |
ERR_ADM_STOP_PLAYOUT | 1010 |
ERR_ADM_STOP_RECORDING | 1013 |
ERR_ALREADY_IN_USE | 19 |
ERR_BITRATE_LIMIT | 115 |
ERR_BUFFER_TOO_SMALL | 6 |
ERR_CONNECTION_INTERRUPTED | 111 |
ERR_CONNECTION_LOST | 112 |
ERR_DATASTREAM_DECRYPTION_FAILED | 122 |
ERR_DECRYPTION_FAILED | 120 |
ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISH | 130 |
ERR_FAILED | 1 |
ERR_INIT_NET_ENGINE | 21 |
ERR_INVALID_APP_ID | 101 |
ERR_INVALID_ARGUMENT | 2 |
ERR_INVALID_CHANNEL_NAME | 102 |
ERR_INVALID_TOKEN | 110 |
ERR_INVALID_USER_ACCOUNT | 134 |
ERR_JOIN_CHANNEL_REJECTED | 17 |
ERR_LEAVE_CHANNEL_REJECTED | 18 |
ERR_LOAD_MEDIA_ENGINE | 1001 |
ERR_NOT_INITIALIZED | 7 |
ERR_NOT_IN_CHANNEL | 113 |
ERR_NOT_READY | 3 |
ERR_NOT_SUPPORTED | 4 |
ERR_NO_PERMISSION | 9 |
ERR_OK | 0 |
ERR_REFUSED | 5 |
ERR_RESOURCE_LIMITED | 22 |
ERR_SIZE_TOO_LARGE | 114 |
ERR_TIMEDOUT | 10 |
ERR_TOKEN_EXPIRED | 109 |
ERR_TOO_MANY_DATA_STREAMS | 116 |
ERR_VDM_CAMERA_NOT_AUTHORIZED | 1501 |
RtcEngine | null |
已知限制
以下成员在当前版本暂不可用,调用时返回 -4(ERR_NOT_SUPPORTED)。接口定义中保留这些成员,便于跨端代码保持一致。
| 接口 | 成员 |
|---|---|
AgoraMediaRecorder | setMediaRecorderObserver |
AgoraMediaRecorder | startRecording |
AgoraMediaRecorder | stopRecording |
IAgoraMusicContentCenter | createMusicPlayer |
IAgoraMusicContentCenter | destroy |
IAgoraMusicContentCenter | destroyMusicPlayer |
IAgoraMusicContentCenter | getCaches |
IAgoraMusicContentCenter | getInternalSongCode |
IAgoraMusicContentCenter | getLyric |
IAgoraMusicContentCenter | getMusicCharts |
IAgoraMusicContentCenter | getMusicCollectionByMusicChartId |
IAgoraMusicContentCenter | getSongSimpleInfo |
IAgoraMusicContentCenter | initialize |
IAgoraMusicContentCenter | isPreloaded |
IAgoraMusicContentCenter | preload |
IAgoraMusicContentCenter | registerEventHandler |
IAgoraMusicContentCenter | release |
IAgoraMusicContentCenter | removeCache |
IAgoraMusicContentCenter | renewToken |
IAgoraMusicContentCenter | searchMusic |
IAgoraMusicContentCenter | unregisterEventHandler |
IAgoraMusicPlayer | setPlayMode |
IMediaPlayer | adjustPlayoutVolume |
IMediaPlayer | adjustPublishSignalVolume |
IMediaPlayer | getDuration |
IMediaPlayer | getMediaPlayerId |
IMediaPlayer | getMute |
IMediaPlayer | getPlayPosition |
IMediaPlayer | getPlaySrc |
IMediaPlayer | getPlayoutVolume |
IMediaPlayer | getPublishSignalVolume |
IMediaPlayer | getState |
IMediaPlayer | getStreamCount |
IMediaPlayer | getStreamInfo |
IMediaPlayer | mute |
IMediaPlayer | open |
IMediaPlayer | openWithMediaSource |
IMediaPlayer | pause |
IMediaPlayer | play |
IMediaPlayer | playPreloadedSrc |
IMediaPlayer | preloadSrc |
IMediaPlayer | resume |
IMediaPlayer | seek |
IMediaPlayer | selectAudioTrack |
IMediaPlayer | selectMultiAudioTrack |
IMediaPlayer | setAudioDualMonoMode |
IMediaPlayer | setAudioPitch |
IMediaPlayer | setLoopCount |
IMediaPlayer | setPlaybackSpeed |
IMediaPlayer | setPlayerOption |
IMediaPlayer | setPlayerOptionString |
IMediaPlayer | setRenderMode |
IMediaPlayer | setView |
IMediaPlayer | stop |
IMediaPlayer | switchSrc |
IMediaPlayer | unloadSrc |
RtcEngine | createCustomVideoTrack |
RtcEngine | createDataStream |
RtcEngine | createMediaPlayer |
RtcEngine | createMediaRecorder |
RtcEngine | destroyCustomVideoTrack |
RtcEngine | enableContentInspect |
RtcEngine | enableEncryption |
RtcEngine | enableVirtualBackground |
RtcEngine | getNativeHandle |
RtcEngine | pauseAllChannelMediaRelay |
RtcEngine | pushExternalVideoFrame |
RtcEngine | pushExternalVideoFrameById |
RtcEngine | resumeAllChannelMediaRelay |
RtcEngine | sendStreamMessage |
RtcEngine | setExternalVideoSource |
RtcEngine | setParameters |
RtcEngine | setupLocalVideo |
RtcEngine | setupRemoteVideo |
RtcEngine | startAudioRecordingWithConfiguration |
RtcEngine | startLastmileProbeTest |
RtcEngine | startLocalVideoTranscoder |
RtcEngine | startOrUpdateChannelMediaRelay |
RtcEngine | startRtmpStreamWithTranscoding |
RtcEngine | startRtmpStreamWithoutTranscoding |
RtcEngine | stopAudioRecording |
RtcEngine | stopChannelMediaRelay |
RtcEngine | stopLastmileProbeTest |
RtcEngine | stopRtmpStream |
RtcEngine | updateChannelMediaOptions |
RtcEngine | updateLocalTranscoderConfiguration |
RtcEngine | updateRtmpTranscoding |
RtcEngineEx | adjustUserPlaybackSignalVolumeEx |
RtcEngineEx | createDataStreamEx |
RtcEngineEx | enableAudioVolumeIndicationEx |
RtcEngineEx | getCallIdEx |
RtcEngineEx | joinChannelEx |
RtcEngineEx | leaveChannelEx |
RtcEngineEx | muteAllRemoteAudioStreamsEx |
RtcEngineEx | muteAllRemoteVideoStreamsEx |
RtcEngineEx | muteLocalAudioStreamEx |
RtcEngineEx | muteLocalVideoStreamEx |
RtcEngineEx | muteRemoteAudioStreamEx |
RtcEngineEx | muteRemoteVideoStreamEx |
RtcEngineEx | setDualStreamModeEx |
RtcEngineEx | setRemoteVideoStreamTypeEx |
RtcEngineEx | setRemoteVoicePositionEx |
RtcEngineEx | setVideoEncoderConfigurationEx |
RtcEngineEx | setupRemoteVideoEx |
RtcEngineEx | startOrUpdateChannelMediaRelayEx |
RtcEngineEx | updateChannelMediaOptionsEx |
__unattributed__ | addBackgroundImage |
__unattributed__ | createCustomAudioTrack |
__unattributed__ | destroy |
__unattributed__ | destroyCustomAudioTrack |
__unattributed__ | destroyMediaRecorder |
__unattributed__ | enableAutoRemoveCache |
__unattributed__ | enableEncryptionEx |
__unattributed__ | enableVideoImageSource |
__unattributed__ | getCacheDir |
__unattributed__ | getCacheFileCount |
__unattributed__ | getDestChannelMediaInfos |
__unattributed__ | getMaxCacheFileCount |
__unattributed__ | getMaxCacheFileSize |
__unattributed__ | getSrcChannelMediaInfo |
__unattributed__ | getWatermarkList |
__unattributed__ | joinChannelWithUserAccountEx |
__unattributed__ | muteRecordingSignal |
__unattributed__ | onAudioRouteChanged |
__unattributed__ | onFacePositionChanged |
__unattributed__ | onLyricResult |
__unattributed__ | onMusicChartsResult |
__unattributed__ | onMusicCollectionResult |
__unattributed__ | onPreLoadEvent |
__unattributed__ | onSongSimpleInfoResult |
__unattributed__ | onUserInfoUpdated |
__unattributed__ | registerPlayerObserver |
__unattributed__ | removeAllCaches |
__unattributed__ | removeBackgroundImage |
__unattributed__ | removeCacheByUri |
__unattributed__ | removeDestChannelInfo |
__unattributed__ | removeOldCache |
__unattributed__ | setCacheDir |
__unattributed__ | setDestChannelInfo |
__unattributed__ | setMaxCacheFileCount |
__unattributed__ | setMaxCacheFileSize |
__unattributed__ | setRemoteRenderModeEx |
__unattributed__ | setRemoteSubscribeFallbackOption |
__unattributed__ | setSrcChannelInfo |
__unattributed__ | startAudioRecording |
__unattributed__ | startRecordingDeviceTest |
__unattributed__ | stopLocalVideoTranscoder |
__unattributed__ | stopRecordingDeviceTest |
__unattributed__ | takeSnapshotEx |
__unattributed__ | unRegisterPlayerObserver |