Cocos Creator SDK API Reference

createAgoraRtcClient(options?: AgoraRtcClientOptions): AgoraRtcClient

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>