Cocos Creator API 参考

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

由公开 SDK 接口定义生成

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

接口概览

本页列出 Cocos Creator 端公开 API 的类、方法、重载、属性、事件与错误码，接口定义与 SDK 包版本一致。

核对项	数量
接口 / 类	2
方法	63
方法重载	63
属性	0
枚举	5
错误码常量	4

可用性

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

加入频道核心链路

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

步骤	接口	方法	重载数
开启视频与预览	`AgoraRtcClient`	`enableVideo`	1
创建 / 初始化	`AgoraRtcClient`	`initialize`	1
加入频道	`AgoraRtcClient`	`joinChannel`	1
离开频道	`AgoraRtcClient`	`leaveChannel`	1
订阅远端媒体	`AgoraRtcClient`	`muteRemoteAudioStream`	1
续期 Token	`AgoraRtcClient`	`renewToken`	1
频道场景	`AgoraRtcClient`	`setChannelProfile`	1
角色切换	`AgoraRtcClient`	`setClientRole`	1

最小可运行链路的参数

参数	类型	可选	可变参数
`enabled`	`boolean`	否	否
`config`	`string\|AgoraRtcEngineConfig`	否	否
`token`	`string`	否	否
`channelId`	`string`	否	否
`uid`	`number`	否	否
`options`	`AgoraChannelMediaOptions`	是	否
`options`	`AgoraLeaveChannelOptions`	是	否
`uid`	`number`	否	否
`muted`	`boolean`	否	否
`token`	`string`	否	否
`profile`	`'communication'\|'liveBroadcasting'`	否	否
`role`	`'broadcaster'\|'audience'`	否	否
`options`	`AgoraClientRoleOptions`	是	否

接口索引

接口	方法	属性	事件
`AgoraRtc`	1	0	0
`AgoraRtcClient`	62	0	23

全部接口

AgoraRtc 1 方法 / 0 属性

typescript

createAgoraRtcClient(options?: AgoraRtcClientOptions): AgoraRtcClient

方法明细：1 / 1（参数、返回值、错误码）

方法	参数	返回值	错误
`createAgoraRtcClient`	`options?: AgoraRtcClientOptions`	`AgoraRtcClient`	错误码索引

AgoraRtcClient 62 方法 / 0 属性

typescript

adjustAudioMixingPlayoutVolume(volume: number): Promise<void>
adjustAudioMixingPublishVolume(volume: number): Promise<void>
adjustAudioMixingVolume(volume: number): Promise<void>
adjustPlaybackSignalVolume(volume: number): Promise<void>
adjustUserPlaybackSignalVolume(uid: number, volume: number): Promise<void>
destroy(): Promise<void>
enableAudio(enabled: boolean): Promise<void>
enableAudioVolumeIndication(interval: number, smooth?: number, reportVad?: boolean): Promise<void>
enableContentInspect(enabled: boolean, config?: AgoraContentInspectConfig): Promise<void>
enableLocalAudio(enabled: boolean): Promise<void>
enableLocalVideo(enabled: boolean): Promise<void>
enableVideo(enabled: boolean): Promise<void>
getAudioMixingCurrentPosition(): Promise<number>
getErrorDescription(code: number): Promise<string>
getSdkVersion(): Promise<string>
initialize(config: string|AgoraRtcEngineConfig): Promise<void>
isSpeakerphoneEnabled(): Promise<boolean>
joinChannel(token: string, channelId: string, uid: number, options?: AgoraChannelMediaOptions): Promise<void>
leaveChannel(options?: AgoraLeaveChannelOptions): Promise<void>
muteAllRemoteAudioStreams(muted: boolean): Promise<void>
muteAllRemoteVideoStreams(muted: boolean): Promise<void>
muteLocalAudioStream(muted: boolean): Promise<void>
muteLocalVideoStream(muted: boolean): Promise<void>
muteRemoteAudioStream(uid: number, muted: boolean): Promise<void>
muteRemoteVideoStream(uid: number, muted: boolean): Promise<void>
off(eventName: K, listener: (payload:AgoraEventMap[K])=>void): void
on(eventName: K, listener: (payload:AgoraEventMap[K])=>void): ()=>void
pauseAudioMixing(): Promise<void>
pauseEffect(soundId: number): Promise<void>
playEffect(config: AgoraPlayEffectConfig): Promise<void>
preloadEffect(soundId: number, path: string, startPos?: number): Promise<void>
removeLocalVideoView(): Promise<void>
removeRemoteVideoView(uid: number): Promise<void>
renewToken(token: string): Promise<void>
resumeAudioMixing(): Promise<void>
resumeEffect(soundId: number): Promise<void>
setAudioMixingPosition(positionMs: number): Promise<void>
setAudioProfile(profile: AgoraAudioProfileValue, scenario?: AgoraAudioScenarioValue): Promise<void>
setAudioSessionOperationRestriction(restriction: number): Promise<void>
setBeautyEffectOptions(enabled: boolean, options: AgoraBeautyOptions, mediaSourceType?: AgoraMediaSourceTypeValue): Promise<void>
setChannelProfile(profile: 'communication'|'liveBroadcasting'): Promise<void>
setClientRole(role: 'broadcaster'|'audience', options?: AgoraClientRoleOptions): Promise<void>
setDefaultAudioRouteToSpeakerphone(enabled: boolean): Promise<void>
setEffectsVolume(volume: number): Promise<void>
setEnableSpeakerphone(enabled: boolean): Promise<void>
setLogFile(path: string): Promise<void>
setLogFilter(level: number): Promise<void>
setNativeVideoOverlaySuspended(suspended: boolean): Promise<void>
setParameters(parameters: string|Record<string,unknown>): Promise<void>
setRenderBackend(backend: AgoraRenderBackend): Promise<void>
setVideoEncoderConfiguration(config: AgoraVideoEncoderConfiguration): Promise<void>
setupLocalVideoView(canvas: AgoraRtcVideoCanvas): Promise<void>
setupRemoteVideoView(uid: number, canvas: AgoraRtcVideoCanvas): Promise<void>
startAudioMixing(config: AgoraAudioMixingConfig): Promise<void>
startPreview(videoSourceType?: AgoraVideoSourceTypeValue): Promise<void>
stopAudioMixing(): Promise<void>
stopEffect(soundId: number): Promise<void>
stopPreview(videoSourceType?: AgoraVideoSourceTypeValue): Promise<void>
switchCamera(): Promise<void>
updateLocalVideoView(canvas: AgoraRtcVideoCanvas): Promise<void>
updateRemoteVideoView(uid: number, canvas: AgoraRtcVideoCanvas): Promise<void>
uploadLogFile(): Promise<string>

方法明细：62 / 62（参数、返回值、错误码）

方法	参数	返回值	错误
`adjustAudioMixingPlayoutVolume`	`volume: number`	`Promise<void>`	错误码索引
`adjustAudioMixingPublishVolume`	`volume: number`	`Promise<void>`	错误码索引
`adjustAudioMixingVolume`	`volume: number`	`Promise<void>`	错误码索引
`adjustPlaybackSignalVolume`	`volume: number`	`Promise<void>`	错误码索引
`adjustUserPlaybackSignalVolume`	`uid: number, volume: number`	`Promise<void>`	错误码索引
`destroy`	—	`Promise<void>`	错误码索引
`enableAudio`	`enabled: boolean`	`Promise<void>`	错误码索引
`enableAudioVolumeIndication`	`interval: number, smooth?: number, reportVad?: boolean`	`Promise<void>`	错误码索引
`enableContentInspect`	`enabled: boolean, config?: AgoraContentInspectConfig`	`Promise<void>`	错误码索引
`enableLocalAudio`	`enabled: boolean`	`Promise<void>`	错误码索引
`enableLocalVideo`	`enabled: boolean`	`Promise<void>`	错误码索引
`enableVideo`	`enabled: boolean`	`Promise<void>`	错误码索引
`getAudioMixingCurrentPosition`	—	`Promise<number>`	错误码索引
`getErrorDescription`	`code: number`	`Promise<string>`	错误码索引
`getSdkVersion`	—	`Promise<string>`	错误码索引
`initialize`	`config: string\|AgoraRtcEngineConfig`	`Promise<void>`	错误码索引
`isSpeakerphoneEnabled`	—	`Promise<boolean>`	错误码索引
`joinChannel`	`token: string, channelId: string, uid: number, options?: AgoraChannelMediaOptions`	`Promise<void>`	错误码索引
`leaveChannel`	`options?: AgoraLeaveChannelOptions`	`Promise<void>`	错误码索引
`muteAllRemoteAudioStreams`	`muted: boolean`	`Promise<void>`	错误码索引
`muteAllRemoteVideoStreams`	`muted: boolean`	`Promise<void>`	错误码索引
`muteLocalAudioStream`	`muted: boolean`	`Promise<void>`	错误码索引
`muteLocalVideoStream`	`muted: boolean`	`Promise<void>`	错误码索引
`muteRemoteAudioStream`	`uid: number, muted: boolean`	`Promise<void>`	错误码索引
`muteRemoteVideoStream`	`uid: number, muted: boolean`	`Promise<void>`	错误码索引
`off`	`eventName: K, listener: (payload:AgoraEventMap[K])=>void`	`void`	错误码索引
`on`	`eventName: K, listener: (payload:AgoraEventMap[K])=>void`	`()=>void`	错误码索引
`pauseAudioMixing`	—	`Promise<void>`	错误码索引
`pauseEffect`	`soundId: number`	`Promise<void>`	错误码索引
`playEffect`	`config: AgoraPlayEffectConfig`	`Promise<void>`	错误码索引
`preloadEffect`	`soundId: number, path: string, startPos?: number`	`Promise<void>`	错误码索引
`removeLocalVideoView`	—	`Promise<void>`	错误码索引
`removeRemoteVideoView`	`uid: number`	`Promise<void>`	错误码索引
`renewToken`	`token: string`	`Promise<void>`	错误码索引
`resumeAudioMixing`	—	`Promise<void>`	错误码索引
`resumeEffect`	`soundId: number`	`Promise<void>`	错误码索引
`setAudioMixingPosition`	`positionMs: number`	`Promise<void>`	错误码索引
`setAudioProfile`	`profile: AgoraAudioProfileValue, scenario?: AgoraAudioScenarioValue`	`Promise<void>`	错误码索引
`setAudioSessionOperationRestriction`	`restriction: number`	`Promise<void>`	错误码索引
`setBeautyEffectOptions`	`enabled: boolean, options: AgoraBeautyOptions, mediaSourceType?: AgoraMediaSourceTypeValue`	`Promise<void>`	错误码索引
`setChannelProfile`	`profile: 'communication'\|'liveBroadcasting'`	`Promise<void>`	错误码索引
`setClientRole`	`role: 'broadcaster'\|'audience', options?: AgoraClientRoleOptions`	`Promise<void>`	错误码索引
`setDefaultAudioRouteToSpeakerphone`	`enabled: boolean`	`Promise<void>`	错误码索引
`setEffectsVolume`	`volume: number`	`Promise<void>`	错误码索引
`setEnableSpeakerphone`	`enabled: boolean`	`Promise<void>`	错误码索引
`setLogFile`	`path: string`	`Promise<void>`	错误码索引
`setLogFilter`	`level: number`	`Promise<void>`	错误码索引
`setNativeVideoOverlaySuspended`	`suspended: boolean`	`Promise<void>`	错误码索引
`setParameters`	`parameters: string\|Record<string,unknown>`	`Promise<void>`	错误码索引
`setRenderBackend`	`backend: AgoraRenderBackend`	`Promise<void>`	错误码索引
`setVideoEncoderConfiguration`	`config: AgoraVideoEncoderConfiguration`	`Promise<void>`	错误码索引
`setupLocalVideoView`	`canvas: AgoraRtcVideoCanvas`	`Promise<void>`	错误码索引
`setupRemoteVideoView`	`uid: number, canvas: AgoraRtcVideoCanvas`	`Promise<void>`	错误码索引
`startAudioMixing`	`config: AgoraAudioMixingConfig`	`Promise<void>`	错误码索引
`startPreview`	`videoSourceType?: AgoraVideoSourceTypeValue`	`Promise<void>`	错误码索引
`stopAudioMixing`	—	`Promise<void>`	错误码索引
`stopEffect`	`soundId: number`	`Promise<void>`	错误码索引
`stopPreview`	`videoSourceType?: AgoraVideoSourceTypeValue`	`Promise<void>`	错误码索引
`switchCamera`	—	`Promise<void>`	错误码索引
`updateLocalVideoView`	`canvas: AgoraRtcVideoCanvas`	`Promise<void>`	错误码索引
`updateRemoteVideoView`	`uid: number, canvas: AgoraRtcVideoCanvas`	`Promise<void>`	错误码索引
`uploadLogFile`	—	`Promise<string>`	错误码索引

事件名	回调参数
`audioMixingFinished`	`Record<string,never>`
`audioMixingStateChanged`	`{state:number;reason:number;}`
`connectionInterrupted`	`Record<string,never>`
`connectionStateChanged`	`{state:number;reason:number;}`
`contentInspectResult`	`{result:number;}`
`error`	`{code?:number\|string;message:string;}`
`firstLocalAudioFramePublished`	`{elapsed:number;}`
`joinChannelSuccess`	`{channelId:string;uid:number;elapsed:number;}`
`leaveChannel`	`AgoraRtcStatsPayload`
`localVideoStateChanged`	`{sourceType:number;state:number;error:number;}`
`localVideoTextureReady`	`{slotId:number;width:number;height:number;}`
`localVideoTextureReleased`	`{slotId:number;}`
`rejoinChannelSuccess`	`{channelId:string;uid:number;elapsed:number;}`
`remoteAudioStateChanged`	`{uid:number;state:number;reason:number;elapsed:number;}`
`remoteVideoStateChanged`	`{uid:number;state:number;reason:number;elapsed:number;}`
`remoteVideoTextureReady`	`{uid:number;slotId:number;width:number;height:number;}`
`remoteVideoTextureReleased`	`{uid:number;slotId:number;}`
`renderBackendState`	`{backend:string;phase:string;result:number;uid:number;fallbackBackend?:string;platform?:string;}`
`rtcStats`	`AgoraRtcStatsPayload`
`uploadLogResult`	`{requestId:string;success:boolean;reason:number;}`
`userJoined`	`{uid:number;elapsed:number;}`
`userOffline`	`{uid:number;reason?:number;}`
`volumeIndication`	`{speakers:Array<{uid:number;volume:number;vad:number;voicePitch:number;}>;totalVolume:number;}`

枚举

枚举	成员数	示例值
`AgoraAudioProfile`	7	`Default = 0`
`AgoraAudioScenario`	7	`Default = 0`
`AgoraErrorCode`	4	`BridgeUnavailable = null`
`AgoraMediaSourceType`	2	`PrimaryCamera = 2`
`AgoraVideoSourceType`	5	`Camera = 0`

AgoraAudioProfile 7 个成员

成员	值
`Default`	`0`
`SpeechStandard`	`1`
`MusicStandard`	`2`
`MusicStandardStereo`	`3`
`MusicHighQuality`	`4`
`MusicHighQualityStereo`	`5`
`Iot`	`6`

AgoraAudioScenario 7 个成员

成员	值
`Default`	`0`
`GameStreaming`	`3`
`Chatroom`	`5`
`Chorus`	`7`
`Meeting`	`8`
`AiServer`	`9`
`AiClient`	`10`

AgoraErrorCode 4 个成员

成员	值
`BridgeUnavailable`	`null`
`Timeout`	`null`
`NativeFailure`	`null`
`ProtocolError`	`null`

AgoraMediaSourceType 2 个成员

成员	值
`PrimaryCamera`	`2`
`SecondaryCamera`	`3`

AgoraVideoSourceType 5 个成员

成员	值
`Camera`	`0`
`CameraSecondary`	`1`
`ScreenPrimary`	`2`
`ScreenSecondary`	`3`
`Transcoded`	`10`

错误码常量

常量	值
`BridgeUnavailable`	`null`
`NativeFailure`	`null`
`ProtocolError`	`null`
`Timeout`	`null`