被 agora::rtc::IRtcEngine2 继承.
Public 类型 | |
typedef unsigned int | WindowIDType |
typedef HWND | WindowIDType |
Public 成员函数 | |
virtual int | initialize (const RtcEngineContext &context)=0 |
virtual int | setChannelProfile (CHANNEL_PROFILE_TYPE profile)=0 |
virtual int | setClientRole (CLIENT_ROLE_TYPE role)=0 |
virtual int | setClientRole (CLIENT_ROLE_TYPE role, const ClientRoleOptions &options)=0 |
virtual int | joinChannel (const char *token, const char *channelId, const char *info, uid_t uid)=0 |
virtual int | joinChannel (const char *token, const char *channelId, const char *info, uid_t uid, const ChannelMediaOptions &options)=0 |
virtual int | switchChannel (const char *token, const char *channelId)=0 |
virtual int | switchChannel (const char *token, const char *channelId, const ChannelMediaOptions &options)=0 |
virtual int | leaveChannel ()=0 |
virtual int | renewToken (const char *token)=0 |
virtual int | queryInterface (INTERFACE_ID_TYPE iid, void **inter)=0 |
virtual int | registerLocalUserAccount (const char *appId, const char *userAccount)=0 |
virtual int | joinChannelWithUserAccount (const char *token, const char *channelId, const char *userAccount)=0 |
virtual int | joinChannelWithUserAccount (const char *token, const char *channelId, const char *userAccount, const ChannelMediaOptions &options)=0 |
virtual int | getUserInfoByUserAccount (const char *userAccount, UserInfo *userInfo)=0 |
virtual int | getUserInfoByUid (uid_t uid, UserInfo *userInfo)=0 |
virtual int | startEchoTest ()=0 |
virtual int | startEchoTest (int intervalInSeconds)=0 |
virtual int | stopEchoTest ()=0 |
virtual int | setCloudProxy (CLOUD_PROXY_TYPE proxyType)=0 |
virtual int | enableVideo ()=0 |
virtual int | disableVideo ()=0 |
virtual int | setVideoProfile (VIDEO_PROFILE_TYPE profile, bool swapWidthAndHeight)=0 |
virtual int | setVideoEncoderConfiguration (const VideoEncoderConfiguration &config)=0 |
virtual int | setCameraCapturerConfiguration (const CameraCapturerConfiguration &config)=0 |
virtual int | setupLocalVideo (const VideoCanvas &canvas)=0 |
virtual int | setupRemoteVideo (const VideoCanvas &canvas)=0 |
virtual int | startPreview ()=0 |
virtual int | setRemoteUserPriority (uid_t uid, PRIORITY_TYPE userPriority)=0 |
virtual int | stopPreview ()=0 |
virtual int | enableAudio ()=0 |
virtual int | enableLocalAudio (bool enabled)=0 |
virtual int | disableAudio ()=0 |
virtual int | setAudioProfile (AUDIO_PROFILE_TYPE profile, AUDIO_SCENARIO_TYPE scenario)=0 |
virtual int | muteLocalAudioStream (bool mute)=0 |
virtual int | muteAllRemoteAudioStreams (bool mute)=0 |
virtual int | setDefaultMuteAllRemoteAudioStreams (bool mute)=0 |
virtual int | adjustUserPlaybackSignalVolume (unsigned int uid, int volume)=0 |
virtual int | muteRemoteAudioStream (uid_t userId, bool mute)=0 |
virtual int | muteLocalVideoStream (bool mute)=0 |
virtual int | enableLocalVideo (bool enabled)=0 |
virtual int | muteAllRemoteVideoStreams (bool mute)=0 |
virtual int | setDefaultMuteAllRemoteVideoStreams (bool mute)=0 |
virtual int | muteRemoteVideoStream (uid_t userId, bool mute)=0 |
virtual int | setRemoteVideoStreamType (uid_t userId, REMOTE_VIDEO_STREAM_TYPE streamType)=0 |
virtual int | setRemoteDefaultVideoStreamType (REMOTE_VIDEO_STREAM_TYPE streamType)=0 |
virtual int | enableAudioVolumeIndication (int interval, int smooth, bool report_vad)=0 |
virtual int | startAudioRecording (const char *filePath, AUDIO_RECORDING_QUALITY_TYPE quality)=0 |
virtual int | startAudioRecording (const char *filePath, int sampleRate, AUDIO_RECORDING_QUALITY_TYPE quality)=0 |
virtual int | startAudioRecording (const AudioRecordingConfiguration &config)=0 |
virtual int | stopAudioRecording ()=0 |
virtual int | startAudioMixing (const char *filePath, bool loopback, bool replace, int cycle)=0 |
virtual int | startAudioMixing (const char *filePath, bool loopback, bool replace, int cycle, int startPos)=0 |
virtual int | stopAudioMixing ()=0 |
virtual int | pauseAudioMixing ()=0 |
virtual int | resumeAudioMixing ()=0 |
virtual int | setHighQualityAudioParameters (bool fullband, bool stereo, bool fullBitrate)=0 |
virtual int | adjustAudioMixingVolume (int volume)=0 |
virtual int | adjustAudioMixingPlayoutVolume (int volume)=0 |
virtual int | getAudioMixingPlayoutVolume ()=0 |
virtual int | adjustAudioMixingPublishVolume (int volume)=0 |
virtual int | getAudioMixingPublishVolume ()=0 |
virtual int | getAudioMixingDuration ()=0 |
virtual int | getAudioMixingDuration (const char *filePath)=0 |
virtual int | getAudioMixingCurrentPosition ()=0 |
virtual int | setAudioMixingPosition (int pos)=0 |
virtual int | setAudioMixingPitch (int pitch)=0 |
virtual int | getEffectsVolume ()=0 |
virtual int | setEffectsVolume (int volume)=0 |
virtual int | setVolumeOfEffect (int soundId, int volume)=0 |
virtual int | enableFaceDetection (bool enable)=0 |
virtual int | playEffect (int soundId, const char *filePath, int loopCount, double pitch, double pan, int gain, bool publish=false)=0 |
virtual int | playEffect (int soundId, const char *filePath, int loopCount, double pitch, double pan, int gain, bool publish, int startPos)=0 |
virtual int | stopEffect (int soundId)=0 |
virtual int | stopAllEffects ()=0 |
virtual int | preloadEffect (int soundId, const char *filePath)=0 |
virtual int | unloadEffect (int soundId)=0 |
virtual int | pauseEffect (int soundId)=0 |
virtual int | pauseAllEffects ()=0 |
virtual int | resumeEffect (int soundId)=0 |
virtual int | resumeAllEffects ()=0 |
virtual int | getEffectDuration (const char *filePath)=0 |
virtual int | setEffectPosition (int soundId, int pos)=0 |
virtual int | getEffectCurrentPosition (int soundId)=0 |
virtual int | enableDeepLearningDenoise (bool enable)=0 |
virtual int | enableSoundPositionIndication (bool enabled)=0 |
virtual int | setRemoteVoicePosition (uid_t uid, double pan, double gain)=0 |
virtual int | setLocalVoicePitch (double pitch)=0 |
virtual int | setLocalVoiceEqualization (AUDIO_EQUALIZATION_BAND_FREQUENCY bandFrequency, int bandGain)=0 |
virtual int | setLocalVoiceReverb (AUDIO_REVERB_TYPE reverbKey, int value)=0 |
virtual int | setLocalVoiceChanger (VOICE_CHANGER_PRESET voiceChanger)=0 |
virtual int | setLocalVoiceReverbPreset (AUDIO_REVERB_PRESET reverbPreset)=0 |
virtual int | setVoiceBeautifierPreset (VOICE_BEAUTIFIER_PRESET preset)=0 |
virtual int | setAudioEffectPreset (AUDIO_EFFECT_PRESET preset)=0 |
virtual int | setVoiceConversionPreset (VOICE_CONVERSION_PRESET preset)=0 |
virtual int | setAudioEffectParameters (AUDIO_EFFECT_PRESET preset, int param1, int param2)=0 |
virtual int | setVoiceBeautifierParameters (VOICE_BEAUTIFIER_PRESET preset, int param1, int param2)=0 |
virtual int | setLogFile (const char *filePath)=0 |
virtual int | setLogFilter (unsigned int filter)=0 |
virtual int | setLogFileSize (unsigned int fileSizeInKBytes)=0 |
virtual int | setLocalRenderMode (RENDER_MODE_TYPE renderMode)=0 |
virtual int | setLocalRenderMode (RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode)=0 |
virtual int | setRemoteRenderMode (uid_t userId, RENDER_MODE_TYPE renderMode)=0 |
virtual int | setRemoteRenderMode (uid_t userId, RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode)=0 |
virtual int | setLocalVideoMirrorMode (VIDEO_MIRROR_MODE_TYPE mirrorMode)=0 |
virtual int | enableDualStreamMode (bool enabled)=0 |
virtual int | setExternalAudioSource (bool enabled, int sampleRate, int channels)=0 |
virtual int | setExternalAudioSink (bool enabled, int sampleRate, int channels)=0 |
virtual int | setRecordingAudioFrameParameters (int sampleRate, int channel, RAW_AUDIO_FRAME_OP_MODE_TYPE mode, int samplesPerCall)=0 |
virtual int | setPlaybackAudioFrameParameters (int sampleRate, int channel, RAW_AUDIO_FRAME_OP_MODE_TYPE mode, int samplesPerCall)=0 |
virtual int | setMixedAudioFrameParameters (int sampleRate, int samplesPerCall)=0 |
virtual int | adjustRecordingSignalVolume (int volume)=0 |
virtual int | adjustPlaybackSignalVolume (int volume)=0 |
virtual int | adjustLoopbackRecordingSignalVolume (int volume)=0 |
virtual int | enableWebSdkInteroperability (bool enabled)=0 |
virtual int | setVideoQualityParameters (bool preferFrameRateOverImageQuality)=0 |
virtual int | setLocalPublishFallbackOption (STREAM_FALLBACK_OPTIONS option)=0 |
virtual int | setRemoteSubscribeFallbackOption (STREAM_FALLBACK_OPTIONS option)=0 |
virtual int | switchCamera ()=0 |
virtual int | setDefaultAudioRouteToSpeakerphone (bool defaultToSpeaker)=0 |
virtual int | setEnableSpeakerphone (bool speakerOn)=0 |
virtual int | enableInEarMonitoring (bool enabled)=0 |
virtual int | setInEarMonitoringVolume (int volume)=0 |
virtual bool | isSpeakerphoneEnabled ()=0 |
virtual int | setAudioSessionOperationRestriction (AUDIO_SESSION_OPERATION_RESTRICTION restriction)=0 |
virtual int | enableLoopbackRecording (bool enabled, const char *deviceName=NULL)=0 |
virtual int | startScreenCaptureByDisplayId (unsigned int displayId, const Rectangle ®ionRect, const ScreenCaptureParameters &captureParams)=0 |
virtual int | startScreenCaptureByScreenRect (const Rectangle &screenRect, const Rectangle ®ionRect, const ScreenCaptureParameters &captureParams)=0 |
virtual int | startScreenCaptureByWindowId (view_t windowId, const Rectangle ®ionRect, const ScreenCaptureParameters &captureParams)=0 |
virtual int | setScreenCaptureContentHint (VideoContentHint contentHint)=0 |
virtual int | updateScreenCaptureParameters (const ScreenCaptureParameters &captureParams)=0 |
virtual int | updateScreenCaptureRegion (const Rectangle ®ionRect)=0 |
virtual int | stopScreenCapture ()=0 |
virtual int | startScreenCapture (WindowIDType windowId, int captureFreq, const Rect *rect, int bitrate)=0 |
virtual int | updateScreenCaptureRegion (const Rect *rect)=0 |
virtual bool | setVideoSource (IVideoSource *source)=0 |
virtual int | getCallId (agora::util::AString &callId)=0 |
virtual int | rate (const char *callId, int rating, const char *description)=0 |
virtual int | complain (const char *callId, const char *description)=0 |
virtual const char * | getVersion (int *build)=0 |
virtual int | enableLastmileTest ()=0 |
virtual int | disableLastmileTest ()=0 |
virtual int | startLastmileProbeTest (const LastmileProbeConfig &config)=0 |
virtual int | stopLastmileProbeTest ()=0 |
virtual const char * | getErrorDescription (int code)=0 |
virtual int | setEncryptionSecret (const char *secret)=0 |
virtual int | setEncryptionMode (const char *encryptionMode)=0 |
virtual int | enableEncryption (bool enabled, const EncryptionConfig &config)=0 |
virtual int | registerPacketObserver (IPacketObserver *observer)=0 |
virtual int | createDataStream (int *streamId, bool reliable, bool ordered)=0 |
virtual int | createDataStream (int *streamId, DataStreamConfig &config)=0 |
virtual int | sendStreamMessage (int streamId, const char *data, size_t length)=0 |
virtual int | addPublishStreamUrl (const char *url, bool transcodingEnabled)=0 |
virtual int | removePublishStreamUrl (const char *url)=0 |
virtual int | setLiveTranscoding (const LiveTranscoding &transcoding)=0 |
virtual int | addVideoWatermark (const RtcImage &watermark)=0 |
virtual int | addVideoWatermark (const char *watermarkUrl, const WatermarkOptions &options)=0 |
virtual int | clearVideoWatermarks ()=0 |
virtual int | setBeautyEffectOptions (bool enabled, BeautyOptions options)=0 |
virtual int | addInjectStreamUrl (const char *url, const InjectStreamConfig &config)=0 |
virtual int | startChannelMediaRelay (const ChannelMediaRelayConfiguration &configuration)=0 |
virtual int | updateChannelMediaRelay (const ChannelMediaRelayConfiguration &configuration)=0 |
virtual int | stopChannelMediaRelay ()=0 |
virtual int | removeInjectStreamUrl (const char *url)=0 |
virtual bool | registerEventHandler (IRtcEngineEventHandler *eventHandler)=0 |
virtual bool | unregisterEventHandler (IRtcEngineEventHandler *eventHandler)=0 |
virtual int | sendCustomReportMessage (const char *id, const char *category, const char *event, const char *label, int value)=0 |
virtual CONNECTION_STATE_TYPE | getConnectionState ()=0 |
virtual int | registerMediaMetadataObserver (IMetadataObserver *observer, IMetadataObserver::METADATA_TYPE type)=0 |
virtual int | setParameters (const char *parameters)=0 |
静态 Public 成员函数 | |
static AGORA_CPP_API void | release (bool sync=false) |
Protected 成员函数 | |
virtual | ~IRtcEngine () |
IRtcEngine 类提供了供 App 调用的主要接口方法。
IRtcEngine 是 Agora Native SDK 的基础接口类。创建一个 IRtcEngine 对象并调用这个对象的方法可以激活 Agora Native SDK 的通信功能。
typedef unsigned int agora::rtc::IRtcEngine::WindowIDType |
typedef HWND agora::rtc::IRtcEngine::WindowIDType |
|
inlineprotectedvirtual |
|
pure virtual |
初始化 Agora SDK 服务。
请确保在调用其他 API 前先调用 createAgoraRtcEngine 和 initialize 创建并初始化 IRtcEngine。
context | 详见 RtcEngineContext 。 |
|
static |
销毁 IRtcEngine 对象。
该方法释放 Agora SDK 使用的所有资源。有些 app 只在用户需要时才进行实时音视频通信,不需要时则将资源释放出来用于其他操作, 该方法适用于此类情况。调用 release
方法后,你将无法再使用 SDK 的其它方法和回调。如需再次使用实时音视频通信功能, 你必须重新依次调用 createAgoraRtcEngine 和 initialize 方法创建一个新的 IRtcEngine
对象。
IRtcEngine
对象,需要等待 release
方法执行结束后再创建实例。sync |
|
|
pure virtual |
设置频道场景。
该方法用于设置 Agora 频道场景。Agora 会针对不同的使用场景采用不同的优化策略,如通信场景偏好流畅,直播场景偏好画质。
profile | 频道使用场景: CHANNEL_PROFILE_TYPE |
|
pure virtual |
设置用户角色。
在加入频道前,用户需要通过本方法设置观众(默认)或主播。在加入频道后,用户可以通过本方法切换用户角色。
直播场景下,如果你在加入频道后调用该方法切换用户角色,调用成功后,本地会触发 onClientRoleChanged 回调; 远端会触发 onUserJoined 回调或 onUserOffline (BECOME_AUDIENCE) 回调。
role | 直播场景里的用户角色: CLIENT_ROLE_TYPE |
|
pure virtual |
设置直播场景下的用户角色。
在加入频道前和加入频道后均可调用该方法设置用户角色。
如果你在加入频道后调用该方法成功切换用户角色,SDK 会触发以下回调:
profile
设为 CHANNEL_PROFILE_LIVE_BROADCASTING
)时生效。role
)确定用户在 SDK 层的权限,包含是否可以发送流、是否可以接收流、是否可以推流到 CDN 等。level
)需要与角色结合使用,确定用户在其权限范围内,可以操作和享受到的服务级别。例如对于观众,选择接收低延时还是超低延时的视频流。不同的级别会影响计费。role | 直播场景中的用户角色,详见 CLIENT_ROLE_TYPE |
options | 用户具体设置,包含用户级别,详见 ClientRoleOptions |
|
pure virtual |
加入频道。
该方法让用户加入通话频道,在同一个频道内的用户可以互相通话,多个用户加入同一个频道,可以群聊。 使用不同 App ID 的 App 是不能互通的。如果已在通话中,用户必须调用 leaveChannel 退出当前通话,才能进入下一个频道。 成功调用该方加入频道后,本地会触发 onJoinChannelSuccess 回调;通信场景下的用户和直播场景下的主播加入频道后,远端会触发 onUserJoined 回调。 在网络状况不理想的情况下,客户端可能会与 Agora 的服务器失去连接;SDK 会自动尝试重连,重连成功后,本地会触发 onRejoinChannelSuccess 回调。
用户成功加入(切换)频道后,默认订阅频道内所有其他用户的音频流和视频流,因此产生用量并影响计费。如果想取消订阅,可以通过调用相应的 mute
方法实现。
token | 动态秘钥。
|
channelId | 标识通话的频道名称,长度在 64 字节以内的字符串。以下为支持的字符集范围(共 89 个字符):
|
info | (非必选项) 开发者需加入的任何附加信息。一般可设置为空字符串,或频道相关信息。该信息不会传递给频道内的其他用户。 |
uid | (非必选项) 用户 ID,32位无符号整数。建议设置范围:1到 232-1,并保证唯一性。如果不指定(即设为0),SDK 会自动分配一个,并在 onJoinChannelSuccess 回调方法中返回,App 层必须记住该返回值并维护,SDK 不对该返回值进行维护。 |
|
pure virtual |
加入频道并设置是否自动订阅音频或视频流。
该方法让用户加入通话频道,在同一个频道内的用户可以互相通话,多个用户加入同一个频道,可以群聊。使用不同 App ID 的 App 是不能互通的。 如果已在通话中,用户必须调用 leaveChannel 退出当前通话,才能进入下一个频道。
成功调用该方法加入频道后,本地会触发 onJoinChannelSuccess 回调; 通信场景下的用户和直播场景下的主播加入频道后,远端会触发 onUserJoined 回调。
在网络状况不理想的情况下,客户端可能会与 Agora 的服务器失去连接;SDK 会自动尝试重连,重连成功后,本地会触发 onRejoinChannelSuccess 回调。
options
参数,用于配置用户加入频道时是否自动订阅频道内所有远端音视频流。默认情况下,用户订阅频道内所有其他用户的音频流和视频流,因此会产生用量并影响计费。 如果想取消订阅,可以通过设置 options
参数或相应的 mute
方法实现。token | 在服务端生成的用于鉴权的 Token。详见从服务端生成 Token。 |
channelId | 标识通话的频道名称,长度在 64 字节以内的字符串。以下为支持的字符集范围(共 89 个字符):
|
info | (非必选项) 预留参数。 |
uid | (非必选项) 用户 ID,32位无符号整数。建议设置范围:1到 232-1,并保证唯一性。如果不指定(即设为0),SDK 会自动分配一个, 并在 onJoinChannelSuccess 回调方法中返回,App 层必须记住该返回值并维护,SDK 不对该返回值进行维护。 请注意:频道内每个用户的 UID 必须是唯一的。如果想要从不同的设备同时接入同一个频道,请确保每个设备上使用的 UID 是不同的。 |
options | 频道媒体设置选项: ChannelMediaOptions |
|
pure virtual |
快速切换直播频道。
当直播频道中的观众想从一个频道切换到另一个频道时,可以调用该方法,实现快速切换。
成功调用该方切换频道后,本地会先收到离开原频道的回调 onLeaveChannel,再收到成功加入新频道的回调 onJoinChannelSuccess。
用户成功加入(切换)频道后,默认订阅频道内所有其他用户的音频流和视频流,因此产生用量并影响计费。如果想取消订阅,可以通过调用相应的 mute
方法实现。
token | 在服务器端生成的用于鉴权的 Token:
|
channelId | 标识频道的频道名,最大不超过 64 字节。以下为支持的字符集范围 (共 89 个字符):
|
|
pure virtual |
快速切换直播频道,并设置是否自动订阅音频流或视频流。
当直播频道中的观众想从一个频道切换到另一个频道时,可以调用该方法,实现快速切换。
成功调用该方切换频道后,本地会先收到离开原频道的回调 onLeaveChannel,再收到成功加入新频道的回调 onJoinChannelSuccess。
用户成功切换频道后,默认订阅频道内所有其他用户的音频流和视频流,因此产生用量并影响计费。如果想取消订阅,可以通过调用相应的 mute
方法实现。
options
参数,用于配置终端用户在切换到新的频道时是否自动订阅频道内所有远端音视频流。token | 在服务端生成的用于鉴权的 Token。详见从服务端生成 Token。 |
channelId | 标识频道的频道名,最大不超过 64 字节。以下为支持的字符集范围 (共 89 个字符):
|
options | 频道媒体设置选项: ChannelMediaOptions |
|
pure virtual |
离开频道。
离开频道,即挂断或退出通话。
当调用 joinChannel 方法后,必须调用 leaveChannel 结束通话,否则无法开始下一次通话。 不管当前是否在通话中,都可以调用 leaveChannel,没有副作用。该方法会把会话相关的所有资源释放掉。 该方法是异步操作,调用返回时并没有真正退出频道。在真正退出频道后,SDK 会触发 onLeaveChannel 回调。 成功调用该方法离开频道后,本地会触发 onLeaveChannel 回调;通信场景下的用户和直播场景下的主播离开频道后,远端会触发 onUserOffline 回调。
|
pure virtual |
更新 Token。
该方法用于更新 Token。如果启用了 Token 机制,过一段时间后使用的 Token 会失效。当:
App 应重新获取 Token,然后调用该方法更新 Token,否则 SDK 无法和服务器建立连接。
token | 新的 Token。 |
|
pure virtual |
获取设备管理员对象的指针。
iid | 想要获取的接口的接口。 |
inter | 指向 DeviceManager 对象的指针。 |
|
pure virtual |
注册本地用户 User Account。
该方法为本地用户注册一个 User Account。注册成功后,该 User Account 即可标识该本地用户的身份,用户可以使用它加入频道。成功注册 User Account 后,本地会触发 onLocalUserRegistered 回调,告知本地用户的 UID 和 User Account。
该方法为可选。如果你希望用户使用 User Account 加入频道,可以选用以下两种方式:
两种方式的区别在于,提前调用 registerLocalUserAccount,可以缩短使用 joinChannelWithUserAccount 进入频道的时间。
userAccount
不能为空,否则该方法不生效。userAccount
在频道中的唯一性。appId | 你的项目在 Agora 控制台注册的 App ID |
userAccount | 用户 User Account。该参数为必填,最大不超过 255 字节,不可填 null 。请确保注册的 User Account 的唯一性。以下为支持的字符集范围(共 89 个字符):
|
|
pure virtual |
使用 User Account 加入频道。
该方法允许本地用户使用 User Account 加入频道。成功加入频道后,会触发以下回调:
用户成功加入频道后,默认订阅频道内所有其他用户的音频流和视频流,因此产生用量并影响计费。如果想取消订阅,可以通过调用相应的 mute
方法实现。
token | 在服务端生成的用于鉴权的 Token。详见从服务端生成 Token。 |
channelId | 标识频道的频道名,最大不超过 64 字节。以下为支持的字符集范围(共 89 个字符):
|
userAccount | 用户 User Account。该参数为必需,最大不超过 255 字节,不可为 null 。请确保注册的 User Account 的唯一性。以下为支持的字符集范围(共 89 个字符):
|
|
pure virtual |
使用 User Account 加入频道,并设置是否自动订阅音频或视频流。
该方法允许本地用户使用 User Account 加入频道。成功加入频道后,会触发以下回调:
用户成功加入频道后,默认订阅频道内所有其他用户的音频流和视频流,因此产生用量并影响计费。如果想取消订阅,可以通过调用相应的 mute
方法实现。
options
参数,用于配置用户加入频道时是否自动订阅频道内所有远端音视频流。默认情况下,用户订阅频道内所有其他用户的音频流和视频流,因此会产生用量并影响计费。如果想取消订阅, 可以通过设置 options
参数或相应的 mute
方法实现。token | 在服务端生成的用于鉴权的 Token。详见从服务端生成 Token。 |
channelId | 标识频道的频道名,最大不超过 64 字节。以下为支持的字符集范围(共 89 个字符):
|
userAccount | 用户 User Account。该参数为必需,最大不超过 255 字节,不可为 null 。请确保注册的 User Account 的唯一性。以下为支持的字符集范围(共 89 个字符):
|
options | 频道媒体设置选项: ChannelMediaOptions |
|
pure virtual |
通过 User Account 获取用户信息。
远端用户加入频道后,SDK 会获取到该远端用户的 UID 和 User Account,然后缓存一个包含了远端用户 UID 和 User Account 的 Mapping 表, 并在本地触发 onUserInfoUpdated 回调。收到这个回调后,你可以调用该方法, 通过传入 User Account 获取包含了指定用户 UID 的 UserInfo
对象。
userAccount | 用户 User Account。该参数为必填 | |
[in,out] | userInfo | 标识用户信息的 UserInfo 对象:
|
|
pure virtual |
通过 UID 获取用户信息。
远端用户加入频道后, SDK 会获取到该远端用户的 UID 和 User Account,然后缓存一个包含了远端用户 UID 和 User Account 的 Mapping 表, 并在本地触发 onUserInfoUpdated 回调。收到这个回调后,你可以调用该方法, 通过传入 UID 获取包含了指定用户 User Account 的 UserInfo
对象。
uid | 用户 UID。该参数为必填 | |
[in,out] | userInfo | 标识用户信息的 UserInfo 对象:
|
|
pure virtual |
该方法自 v2.4.0 起废弃。
该方法启动语音通话测试,目的是测试系统的音频设备(耳麦、扬声器等)和网络连接是否正常。在测试过程中,用户先说一段话,声音会在设置的时间间隔(单位为秒)后回放出来。如果用户能正常听到自己刚才说的话,就表示系统音频设备和网络连接都是正常的。
|
pure virtual |
开始语音通话回路测试。
该方法启动语音通话测试,目的是测试系统的音频设备(耳麦、扬声器等)和网络连接是否正常。 在测试过程中,用户先说一段话,声音会在设置的时间间隔(单位为秒)后回放出来。 如果用户能正常听到自己刚才说的话,就表示系统音频设备和网络连接都是正常的。
intervalInSeconds | 设置返回语音通话回路测试结果的时间间隔,取值范围为 [2, 10],单位为秒,默认为 10 秒。 |
|
pure virtual |
停止语音通话回路测试。
|
pure virtual |
设置 Agora 云代理服务。
当用户防火墙限制 IP 和端口号时,你需要参考《使用云代理》开放相应 IP 和端口号,然后调用该方法开启云代理,并通过 proxyType
参数设置为 UDP_PROXY(1)
,即 UDP 协议的云代理。
成功连接云代理后,SDK 会触发 onConnectionStateChanged (CONNECTION_STATE_CONNECTING, CONNECTION_CHANGED_SETTING_PROXY_SERVER) 回调。
如果你想关闭已设置的云代理,请调用 setCloudProxy(NONE_PROXY)
。如果你想更改已设置的云代理类型, 请先调用 setCloudProxy(NONE_PROXY)
,再调用 setCloudProxy
并传入你期望的 proxyType
值。
proxyType | 云代理类型,详见 CLOUD_PROXY_TYPE 。该参数为必填参数,如果你不赋值,SDK 会报错。 |
-2(ERR_INVALID_ARGUMENT)
: 传入的参数无效-7(ERR_NOT_INITIALIZED)
: SDK 尚未初始化
|
pure virtual |
启用视频模块。
该方法可以在加入频道前或者通话中调用,在加入频道前调用则自动开启视频模块;在通话中调用则由音频模式切换为视频模式。 调用 disableVideo 方法可关闭视频模式。 成功调用该方法后,远端会触发 onUserEnableVideo (true) 回调。
|
pure virtual |
关闭视频模块。
该方法可以在加入频道前或者通话中调用,在加入频道前调用,则自动开启纯音频模式,在通话中调用则由视频模式切换为纯音频模式。 调用 enableVideo 方法可开启视频模式。 成功调用该方法后,远端会触发 onUserEnableVideo (false) 回调。
|
pure virtual |
设置视频编码配置。
该方法自 v2.3 起废弃。请改用 setVideoEncoderConfiguration 方法。
该方法设置视频编码属性(Profile)。每个属性对应一套视频参数,如分辨率、帧率、码率等。 当设备的摄像头不支持指定的分辨率时,Agora SDK 会自动选择一个合适的摄像头分辨率,但是编码分辨率仍然用 setVideoProfile 指定的。
profile | 视频属性。详见: VIDEO_PROFILE_TYPE 。 |
swapWidthAndHeight | SDK 会按照你选择的视频属性 (profile) 输出固定宽高的视频。该参数设置是否交换宽和高:
|
你可以直接通过视频属性 (profile) 来定义输出的视频是 Landscape(横屏)还是 Portrait(竖屏)模式,因此 声网建议你将参数设置为默认值。
|
pure virtual |
设置视频编码属性。
设置本地视频的编码属性。
config | 视频编码参数配置。详见: VideoEncoderConfiguration 。 |
|
pure virtual |
设置摄像头采集配置。
一般的视频通话或直播中,默认由 SDK 自动控制摄像头的输出参数。在如下特殊场景中,默认的参数通常无法满足需求,或可能引起设备性能问题,我们推荐调用该方法设置摄像头的采集偏好:
config | 摄像头采集配置,详见 CameraCapturerConfiguration 。 |
|
pure virtual |
初始化本地视图。
该方法初始化本地视图并设置本地用户视频显示信息,只影响本地用户看到的视频画面,不影响本地发布视频。调用该方法绑定本地视频流的显示视窗(view),并设置本地用户视图的渲染模式和镜像模式。
在 App 开发中,通常在初始化后调用该方法进行本地视频设置,然后再加入频道。退出频道后,绑定仍然有效,如果需要解除绑定,可以指定空(NULL)View 调用 setupLocalVideo。
canvas | 视频画布信息: VideoCanvas 。 |
|
pure virtual |
初始化远端用户视图。
该方法绑定远端用户和显示视图,并设置远端用户视图在本地显示时的渲染模式和镜像模式,只影响本地用户看到的视频画面。
调用该接口时需要指定远端视频的 uid,一般可以在进频道前提前设置好。
如果 App 不能事先知道对方的 uid,可以在 APP 收到 onUserJoined 事件时设置。 如果启用了视频录制功能,视频录制服务会做为一个哑客户端加入频道,因此其他客户端也会收到它的 onUserJoined 事件,App 不应给它绑定视图(因为它不会发送视频流),如果 App 不能识别哑客户端,可以在 onFirstRemoteVideoDecoded 事件时再绑定视图。 解除某个用户的绑定视图可以把 view 设置为空。退出频道后,SDK 会把远端用户的绑定关系清除掉。
canvas | 视频画布信息: VideoCanvas 。 |
|
pure virtual |
开启视频预览。
该方法用于在进入频道前启动本地视频预览。调用该 API 前,必须:
启用了本地视频预览后,如果调用 leaveChannel 退出频道,本地预览依然处于启动状态,如需要关闭本地预览,需要调用 stopPreview。
|
pure virtual |
设置远端用户流的优先级。
设置远端用户的优先级。如果将某个用户的优先级设为高,那么发给这个用户的音视频流的优先级就会高于其他用户。 弱网下 SDK 会优先保证高优先级用户收到的流的质量。
uid | 远端用户的 ID。 |
userPriority | 远端用户的需求优先级。详见: PRIORITY_TYPE 。 |
|
pure virtual |
停止视频预览。
|
pure virtual |
启用音频模块。
启用音频模块(默认为开启状态)。
|
pure virtual |
开关本地音频采集。
当用户加入频道时,语音功能默认是开启的。该方法可以关闭或重新开启本地语音功能,即停止或重新开始本地音频采集。
该方法不影响接收或播放远端音频流,enableLocalAudio(false) 适用于只听不发的用户场景。
语音功能关闭或重新开启后,会收到回调 onLocalAudioStateChanged, 并报告 LOCAL_AUDIO_STREAM_STATE_STOPPED(0)
或 LOCAL_AUDIO_STREAM_STATE_RECORDING(1)
。
enableLocalAudio
关闭或开启本地采集后,本地听远端播放会有短暂中断。enabled |
|
|
pure virtual |
关闭音频模块。
|
pure virtual |
设置音频编码属性。
profile | 设置采样率,码率,编码模式和声道数: AUDIO_PROFILE_TYPE 。 |
scenario | 设置音频应用场景: AUDIO_SCENARIO_TYPE 。不同的音频场景下,设备的音量类型是不同的。详见如何区分媒体音量和通话音量。 |
|
pure virtual |
取消或恢复发布本地音频流。
成功调用该方法后,远端会触发 onUserMuteAudio 回调。
setChannelProfile
后调用该方法。mute | 是否取消发布本地音频流。
|
|
pure virtual |
取消或恢复订阅所有远端用户的音频流。
自 v3.3.0 起,成功调用该方法后,本地用户会取消或恢复订阅所有远端用户的音频流,包括在调用该方法后加入频道的用户的音频流。
mute | 是否取消订阅所有远端用户的音频流。
|
|
pure virtual |
默认取消或恢复订阅远端用户的音频流。
该方法需要在加入频道后调用。调用成功后,本地用户取消或恢复订阅调用时刻之后加入频道的远端用户。
mute | 是否默认取消订阅远端用户的音频流:
|
|
pure virtual |
调节本地播放的指定远端用户信号音量。
你可以在通话中调用该方法调节指定远端用户在本地播放的音量。如需调节多个用户在本地播放的音量,则需多次调用该方法。
uid | 远端用户 ID。 |
volume | 播放音量,取值范围为 [0,100]:
|
|
pure virtual |
取消或恢复订阅指定远端用户的音频流。
userId | 指定用户的用户 ID。 |
mute | 是否取消订阅指定远端用户的音频流。
|
|
pure virtual |
取消或恢复发布本地视频流。
成功调用该方法后,远端会触发 onUserMuteVideo 回调。
setChannelProfile
后调用该方法。mute | 是否取消发布本地视频流。
|
|
pure virtual |
开关本地视频采集。
该方法禁用或重新启用本地视频采集,不影响接收远端视频。
调用 enableVideo 后,本地视频即默认开启。你可以调用 enableLocalVideo(false) 关闭本地视频采集。关闭后如果想要重新开启,则可调用 enableLocalVideo(true)。
成功禁用或启用本地视频采集后,远端会触发 onUserEnableLocalVideo 回调。
enabled |
|
|
pure virtual |
取消或恢复订阅所有远端用户的视频流。
自 v3.3.0 起,成功调用该方法后,本地用户会取消或恢复订阅所有远端用户的视频流,包括在调用该方法后加入频道的用户的视频流。
mute | 是否取消订阅所有远端用户的视频流。
|
|
pure virtual |
默认取消或恢复订阅远端用户的视频流。
该方法需要在加入频道后调用。调用成功后,本地用户取消或恢复订阅调用时刻之后加入频道的远端用户。
mute | 是否默认取消订阅远端用户的视频流:
|
|
pure virtual |
取消或恢复订阅指定远端用户的视频流。
userId | 指定用户的用户 ID。 |
mute | 是否取消订阅指定远端用户的视频流。
|
|
pure virtual |
设置订阅的视频流类型。
在网络条件受限的情况下,如果发送端没有调用 enableDualStreamMode (false) 关闭双流模式,接收端可以选择接收大流还是小流。其中,大流可以接为高分辨率高码率的视频流, 小流则是低分辨率低码率的视频流。
正常情况下,用户默认接收大流。如需接收小流,可以调用本方法进行切换。SDK 会根据视频窗口的大小动态调整对应视频流的大小,以节约带宽和计算资源。
视频小流默认的宽高比和视频大流的宽高比一致。根据当前大流的宽高比,系统会自动分配小流的分辨率、帧率及码率。
调用本方法的执行结果将在 onApiCallExecuted 中返回。
setRemoteVideoStreamType
,也调用了 setRemoteDefaultVideoStreamType,则 SDK 以 setRemoteVideoStreamType
中的设置为准。userId | 用户 ID。 |
streamType | 视频流类型: REMOTE_VIDEO_STREAM_TYPE 。 |
|
pure virtual |
设置默认订阅的视频流类型。
在网络条件受限的情况下,如果发送端没有调用 enableDualStreamMode (false) 关闭双流模式, 接收端可以选择接收大流还是小流。其中,大流可以接为高分辨率高码率的视频流, 小流则是低分辨率低码率的视频流。
正常情况下,用户默认接收大流。如需默认接收所有用户的视频小流,可以调用本方法进行切换。SDK 会根据视频窗口的大小动态调整对应视频流的大小,以节约带宽和计算资源。视频小流默认 的宽高比和视频大流的宽高比一致。根据当前大流的宽高比,系统会自动分配小流的分辨率、帧率及码率。
调用本方法的执行结果将在 onApiCallExecuted 中返回。
setRemoteVideoStreamType
,也调用了 setRemoteDefaultVideoStreamType,则 SDK 以 setRemoteVideoStreamType
中的设置为准。streamType | 视频流类型: REMOTE_VIDEO_STREAM_TYPE 。 |
|
pure virtual |
启用用户音量提示。
该方法允许 SDK 定期向 app 报告本地发流用户和瞬时音量最高的远端用户(最多 3 位)的音量相关信息。启用该方法后,只要频道内有发流用户, SDK 会在加入频道后按设置的时间间隔触发 onAudioVolumeIndication 回调。
interval | 指定音量提示的时间间隔:
|
smooth | 平滑系数,指定音量提示的灵敏度。取值范围为 [0,10],建议值为 3。数字越大,波动越灵敏;数字越小,波动越平滑。 |
report_vad |
|
|
pure virtual |
开始客户端录音。
Agora SDK 支持通话过程中在客户端进行录音。该方法录制频道内所有用户的音频,并生成一个包含所有用户声音的录音文件,录音文件格式可以为:
请确保 App 里指定的目录存在且可写。该接口需在 joinChannel 之后调用。如果调用 leaveChannel 时还在录音,录音会自动停止。
filePath | 录音文件的本地保存路径,由用户自行指定,需精确到文件名及格式,例如:/dir1/dir2/dir3/audio.aac。 |
quality | AUDIO_RECORDING_QUALITY_TYPE 。 |
|
pure virtual |
开始客户端录音。
Agora SDK 支持通话过程中在客户端进行录音。调用该方法后,你可以录制频道内所有用户的音频,并得到一个包含所有用户声音的录音文件。录音文件格式可以为:
sampleRate
设为 44.1 kHz 或 48 kHz 时,建议将 quality
设为 AUDIO_RECORDING_QUALITY_MEDIUM 或 AUDIO_RECORDING_QUALITY_HIGH 。filePath | 录音文件在本地保存的绝对路径,由用户自行指定,需精确到文件名及格式,例如:c:/music/audio.aac。 |
sampleRate | 录音采样率(Hz),可以设为以下值:
|
quality | 录音音质。详见 AUDIO_RECORDING_QUALITY_TYPE 。 |
|
pure virtual |
开始客户端录音。
Agora SDK 支持通话过程中在客户端进行录音。调用该方法后,你可以录制频道内用户的音频,并得到一个录音文件。录音文件格式可以为:
一旦用户离开频道,录音会自动停止。
config | 录音配置。详见 AudioRecordingConfiguration。 |
-160(ERR_ALREADY_IN_RECORDING)
: 客户端正在录音。如需开始新的录音, 请先调用 stopAudioRecording 停止当前录音, 再调用 startAudioRecording
|
pure virtual |
|
pure virtual |
开始播放音乐文件。
指定本地或在线音频文件来和麦克风采集的音频流进行混音和替换。替换是指用音频文件替换音频采集设备采集的音频流。该方法可以选择是否让对方听到本地播 放的音频并指定循环播放的次数。成功调用该方法后,本地会触发 onAudioMixingStateChanged (PLAY) 回调。播放结束后, 会收到 onAudioMixingStateChanged (STOPPED) 回调。
filePath | 指定需要混音的本地或在线音频文件的绝对路径,例如:C:/music/audio.mp4 。建议填写文件后缀名。若无法确定文件后缀名,可不填。 支持的音频格式包括:3GP、ASF、ADTS、AVI、MP3、MP4、MPEG-4、SAMI 和 WAVE。 详见 Supported Media Formats in Media Foundation 。 |
loopback |
|
replace |
|
cycle | 循环播放次数:
|
|
pure virtual |
开始播放音乐文件。
该方法支持将本地或在线音乐文件和麦克风采集的音频进行混音或替换。成功播放音乐文件后,本地 会触发 onAudioMixingStateChanged(AUDIO_MIXING_STATE_PLAYING,AUDIO_MIXING_REASON_STARTED_BY_USER) 回调。 播放结束后,本地会触发 onAudioMixingStateChanged(AUDIO_MIXING_STATE_STOPPED,AUDIO_MIXING_REASON_ALL_LOOPS_COMPLETED) 回调。
startAudioMixing
,请确保调用间隔大于 500 ms。/sdcard/
目录下,且格式为 MP3。filePath | 音乐文件的绝对路径或 URL 地址,需精确到文件名及后缀。 例如:C:\music\audio.mp4 。支持的音频格式包括 MP3、AAC、M4A、MP4、WAV、3GP。 详见 Supported Media Formats in Media Foundation。 |
loopback | 是否只在本地播放音乐文件:
|
replace | 是否用音乐文件替换麦克风采集的音频:
|
cycle | 音乐文件的播放次数。
|
startPos | 音乐文件的播放位置,单位为毫秒。 |
|
pure virtual |
停止播放音乐文件。
该方法停止播放音乐文件。请在频道内调用该方法。
|
pure virtual |
暂停播放音乐文件。
该方法暂停播放音乐文件。请在频道内调用该方法。
|
pure virtual |
恢复播放音乐文件。
该方法恢复混音,继续播放音乐文件。请在频道内调用该方法。
|
pure virtual |
设置音频高音质选项。
fullband | 全频带编解码器(48 kHz 采样率), 不兼容 v1.7.4 以前版本
|
stereo | 立体声编解码器,不兼容 v1.7.4 以前版本
|
fullBitrate | 高码率模式,建议仅在纯音频模式下使用
|
|
pure virtual |
调节音乐文件的播放音量。
该方法调节混音音乐文件在本端和远端的播放音量大小。
volume | 音乐文件音量范围为 0~100。100 (默认值)为原始文件音量。 |
|
pure virtual |
调节音乐文件本端播放音量。
该方法调节混音音乐文件在本端的播放音量大小。
volume | 音乐文件音量范围为 0~100。100 (默认值) 为原始文件音量。 |
|
pure virtual |
获取音乐文件的本地播放音量。
该方法获取混音的音乐文件本地播放音量,方便排查音量相关问题。
|
pure virtual |
调节音乐文件远端播放音量。
该方法调节混音音乐文件在远端的播放音量大小。
volume | 音乐文件音量范围为 0~100。100 (默认值) 为原始文件音量。 |
|
pure virtual |
获取音乐文件的远端播放音量
该接口可以方便开发者排查音量相关问题。
|
pure virtual |
获取音乐文件总时长。
该方法获取音乐文件总时长,单位为毫秒。请在频道内调用该方法。
|
pure virtual |
获取指定音乐文件总时长。
filePath | 本地音乐文件的绝对路径,需精确到文件名及后缀。 例如:C:\music\audio.mp4 。支持的音频格式包括 MP3、AAC、M4A、MP4、WAV、3GP。 详见 Supported Media Formats in Media Foundation。 |
|
pure virtual |
获取音乐文件的播放进度。
该方法获取当前音乐文件播放进度,单位为毫秒。请在频道内调用该方法。
|
pure virtual |
设置音乐文件的播放位置。
该方法可以设置音频文件的播放位置,这样你可以根据实际情况播放文件,而非从头到尾播放整个文件。
pos | 整数。进度条位置,单位为毫秒。 |
|
pure virtual |
调整本地播放的音乐文件的音调。
本地人声和播放的音乐文件混音时,调用该方法可以仅调节音乐文件的音调。
pitch | 按半音音阶调整本地播放的音乐文件的音调,默认值为 0,即不调整音调。取值范围为 [-12,12], 每相邻两个值的音高距离相差半音。取值的绝对值越大,音调升高或降低得越多。 |
|
pure virtual |
|
pure virtual |
设置音效文件的播放音量。
音量范围为 0~100。100 (默认值)为原始文件音量。
volume | 该方法设置音效的音量。 |
|
pure virtual |
实时调整音效文件的播放音量。
soundId | 指定音效的 ID。每个音效均有唯一的 ID。 |
volume | 播放音量。音量范围为 0~100。100 (默认值)为原始文件音量。 |
|
pure virtual |
开启/关闭本地人脸检测。仅适用于 Android 和 iOS。
开启本地人脸检测后,SDK 会触发 onFacePositionChanged 回调向你报告人脸检测的信息:
enable | 是否开启人脸检测:
|
|
pure virtual |
播放指定音效文件。
你可以多次调用该方法,通过传入不同的音效文件的 soundID
和 filePath
,同时播放多个音效文件,实现音效叠加。为获得最佳用户体验,我们建议同时播放的音效文件不要超过 3 个。在 macOS 和 Windows 上,该方法不支持同时播放多个在线音效文件。
soundId | 指定音效的 ID。每个音效均有唯一的 ID。如果你已通过 preloadEffect 将音效加载至内存,确保这里设置的 soundId 与 preloadEffect 设置的 soundId 相同。 |
filePath | 音效文件的绝对路径或 URL 地址,例如:c:/music/audio.mp4。建议填写文件后缀名。若无法确定文件后缀名,可不填。 支持的音频格式包括:mp3、mp4、m4a、aac、3gp、mkv 及 wav。 详见 Supported Media Formats in Media Foundation 。 |
loopCount | 设置音效循环播放的次数:
|
pitch | 设置音效的音调 取值范围为 [0.5, 2]。默认值为 1.0,表示不需要修改音调。取值越小,则音调越低。 |
pan | 设置是否改变音效的空间位置。取值范围为 [-1.0, 1.0]:
|
gain | 设置是否改变单个音效的音量。取值范围为 [0.0, 100.0]。默认值为 100.0。取值越小,则音效的音量越低。 |
publish | 设置是否将音效传到远端:
|
|
pure virtual |
播放指定的本地或在线音效文件。
你可以多次调用该方法,传入不同的 soundId
和 filePath
,同时播放多个音效文件。 为获得最佳用户体验,Agora 推荐同时播放的音效文件不超过 3 个。
音效文件播放结束后,SDK 会触发 onAudioEffectFinished 回调。
soundId | 音效的 ID。每个音效的 ID 具有唯一性。 如果你已通过 preloadEffect 将音效加载至内存, 请确保该参数与 preloadEffect 中设置的 soundId 相同。 |
filePath | 音效文件的绝对路径或 URL 地址,需精确到文件名及后缀。例如:C:\music\audio.mp4 。 支持的音频格式包括 MP3、AAC、M4A、MP4、WAV、3GP。 详见 Supported Media Formats in Media Foundation。 如果你已通过 preloadEffect 将音效加载至内存, 请确保该参数与 preloadEffect 中设置的 filePath 相同。 |
loopCount | 音效循环播放的次数。
|
pitch | 音效的音调,取值范围为 [0.5,2.0]。默认值为 1.0,表示原始音调。取值越小,则音调越低。 |
pan | 音效的空间位置。取值范围为 [-1.0,1.0],例如:
|
gain | 音效的音量。取值范围为 [0.0,100.0]。默认值为 100.0,表示原始音量。取值越小,则音量越低。 |
publish | 是否将音效发布至远端:
|
startPos | 音效文件的播放位置,单位为毫秒。 |
|
pure virtual |
停止播放指定音效文件。
soundId | 指定音效文件的 ID。每个音效文件均有唯一的 ID。 |
|
pure virtual |
停止播放所有音效文件。
|
pure virtual |
将音效文件加载至内存。
该方法将指定音效文件预加载至内存。
为保证通信畅通,请注意控制预加载音效文件的大小,并在 joinChannel 前就使用该方法完成音效预加载。音频文件支持以下音频格式: mp3、aac、m4a、3gp,和 wav。
soundId | 指定音效文件的 ID。每个音效文件均有唯一的 ID。 |
filePath | 音效文件的绝对路径。 |
|
pure virtual |
从内存释放某个预加载的音效文件。
soundId | 指定音效文件的 ID。每个音效文件均有唯一的 ID |
|
pure virtual |
暂停音效文件播放。
soundId | 指定音效文件的 ID。每个音效文件均有唯一的 ID。 |
|
pure virtual |
暂停所有音效文件播放。
|
pure virtual |
恢复播放指定音效文件。
soundId | 指定音效文件的 ID。每个音效文件均有唯一的 ID。 |
|
pure virtual |
恢复播放所有音效文件。
|
pure virtual |
获取指定音效文件总时长。
filePath | 本地音效文件的绝对路径,需精确到文件名及格式。例如:C:\music\audio.mp4 。 支持的音频格式包括 MP3、AAC、M4A、MP4、WAV、3GP。 详见 Supported Media Formats in Media Foundation。 |
-22(ERR_RESOURCE_LIMITED)
: 无法找到音效文件。请填写正确的 filePath
|
pure virtual |
设置指定音效文件的播放位置。
成功设置后,本地音效文件会在指定位置开始播放。
soundId | 音效 ID。请确保与 playEffect 中设置的 soundId 一致。 |
pos | 音效文件的播放位置,单位为毫秒。 |
-22(ERR_RESOURCE_LIMITED)
: 无法找到音效文件。请填写正确的 soundId
|
pure virtual |
获取指定音效文件的播放进度
soundId | 音效 ID。请确保与 playEffect 中设置的 soundId 一致。 |
-22(ERR_RESOURCE_LIMITED)
: 无法找到音效文件。请填写正确的 soundId
|
pure virtual |
开启或关闭 AI 降噪模式。
SDK 默认开启传统降噪模式,以消除大部分平稳噪声。如果你还需要消除非平稳噪声,Agora 推荐你按如下步骤开启 AI 降噪模式:
libagora_ai_denoise_extension.so
AgoraAIDenoiseExtension.xcframework
AgoraAIDenoiseExtension.framework
libagora_ai_denoise_extension.dll
enableDeepLearningDenoise(true)
。AI 降噪模式对设备性能有要求。只有在设备性能良好的情况下,SDK 才会成功开启 AI 降噪模式。例如, 支持在如下设备及其之后的型号中开启 AI 降噪模式:
成功开启 AI 降噪模式后,如果 SDK 检测到当前设备的性能不足,SDK 会自动关闭 AI 降噪模式,并开启传统降噪模式。
在频道内,如果你调用了 enableDeepLearningDenoise(false)
或 SDK 自动关闭了 AI 降噪模式,当你需要重新开启 AI 降噪模式时, 你需要先调用 leaveChannel,再调用 enableDeepLearningDenoise(true)
。
enable | 是否开启 AI 降噪模式:
|
|
pure virtual |
开启/关闭远端用户的语音立体声。
如果想调用 setRemoteVoicePosition 实现听声辨位的功能,请确保在加入频道前调用该方法开启远端用户的语音立体声。
enabled | 是否开启远端用户语音立体声:
|
|
pure virtual |
设置远端用户的语音位置。
设置远端用户声音的空间位置和音量,方便本地用户听声辨位。
通过调用该接口设置远端用户声音出现的位置,左右声道的声音差异会产生声音的方位感,从而判断出远端用户的实时位置。在多人在线游戏场景,如吃鸡游戏中,该方法能有效增加游戏角色的方位感,模拟真实场景。
uid | 远端用户的 ID |
pan | 设置远端用户声音的空间位置,取值范围为 [-1.0,1.0]:
|
gain | 设置远端用户声音的音量,取值范围为 [0.0,100.0],默认值为 100.0,表示该用户的原始音量。取值越小,则音量越低。 |
|
pure virtual |
设置本地语音音调。
pitch | 语音频率可以 [0.5,2.0] 范围内设置。取值越小,则音调越低。默认值为 1.0,表示不需要修改音调。 |
|
pure virtual |
设置本地语音音效均衡。
bandFrequency | 频谱子带索引。取值范围是 [0,9],分别代表音效的 10 个频带。对应的中心频率为 [31,62,125,250,500,1k,2k,4k,8k,16k] Hz。详见 AUDIO_EQUALIZATION_BAND_FREQUENCY 。 |
bandGain | 每个 band 的增益,单位是 dB,每一个值的范围是 [-15,15]。 |
|
pure virtual |
设置本地音效混响。
reverbKey | 混响音效 Key。该方法共有 5 个混响音效 Key: AUDIO_REVERB_TYPE 。 |
value | 各混响音效 Key 所对应的值: |
|
pure virtual |
设置本地语音变声、美音或语聊美声效果。
通信场景下的用户或直播场景下的主播均可调用该方法为本地语音设置以下效果。成功设置以后,频道内的所有用户均可听到声音效果。
VOICE_CHANGER
为前缀。效果包括老男人、小男孩、小女孩、猪八戒、空灵和绿巨人,通常用于语聊场景。VOICE_BEAUTY
为前缀。效果包括浑厚、低沉、圆润、假音、饱满、清澈、高亢、嘹亮和空旷,通常用于语聊和唱歌场景。GENERAL_BEAUTY_VOICE
为前缀。效果包括磁性(男)、清新(女)和活力(女),通常用于语聊场景。该功能主要细化了男声和女声各自的特点。profile
参数设置为 AUDIO_PROFILE_MUSIC_HIGH_QUALITY (4) 或 AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO (5)voiceChanger | 预设本地语音变声、美音或语聊美声效果选项,默认值为 VOICE_CHANGER_OFF ,即原声。详见 VOICE_CHANGER_PRESET 。 设置语聊美声效果时,Agora 推荐使用 GENERAL_BEAUTY_VOICE_MALE_MAGNETIC 处理男声,使用 GENERAL_BEAUTY_VOICE_FEMALE_FRESH 或 GENERAL_BEAUTY_VOICE_FEMALE_VITALITY 处理女声,否则音频可能会产生失真。 |
|
pure virtual |
设置本地语音混响(含虚拟立体声效果)。
通信场景下的用户或直播场景下的主播均可调用该方法设置本地语音混响。成功设置以后,频道内的所有用户均可听到声音效果。
AUDIO_REVERB_FX
为前缀的枚举值时,请确保在调用该方法前将 setAudioProfile 的 profile
参数设置为 AUDIO_PROFILE_MUSIC_HIGH_QUALITY (4) 或 AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO (5) ,否则该方法设置无效。setAudioProfile
的 profile
参数设置为 AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO (5)reverbPreset | 本地语音混响选项,默认值为 AUDIO_REVERB_OFF ,即原声。详见 AUDIO_REVERB_PRESET 。 为达到更好的混响效果,Agora 推荐使用以 AUDIO_REVERB_FX 为前缀的枚举值。 |
|
pure virtual |
设置 SDK 预设的美声效果。
调用该方法可以为本地发流用户设置 SDK 预设的人声美化效果。设置美声效果后,频道内所有用户都能听到该效果。根据不同的场景,你可以为用户设置 不同的美声效果,各美声效果的适用场景可参考《设置人声效果》。
为获取更好的人声效果,Agora 推荐你在调用该方法前将 setAudioProfile 的 scenario
设为 AUDIO_SCENARIO_GAME_STREAMING(3)
,并将 profile
设为 AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)
或 AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)
。
profile
参数设置为 AUDIO_PROFILE_SPEECH_STANDARD(1)
或 AUDIO_PROFILE_IOT(6)
,否则该方法不生效。preset | 预设的美声效果选项,详见 VOICE_BEAUTIFIER_PRESET |
|
pure virtual |
设置 SDK 预设的人声音效。
调用该方法可以为本地发流用户设置 SDK 预设的人声音效,且不会改变原声的性别特征。设置音效后,频道内所有用户都能听到该效果。
根据不同的场景,你可以为用户设置不同的音效,各音效的适用场景可参考《设置人声效果》。
为获取更好的人声效果,Agora 推荐你在调用该方法前将 setAudioProfile 的 scenario
设为 AUDIO_SCENARIO_GAME_STREAMING(3)
。
profile
参数设置为 AUDIO_PROFILE_SPEECH_STANDARD(1)
或 AUDIO_PROFILE_IOT(6)
,否则该方法不生效。或
PITCH_CORRECTION` 外的枚举,请勿再 调用 setAudioEffectParameters,否则该方法设置的效果会被覆盖。preset | 预设的音效选项,详见 AUDIO_EFFECT_PRESET |
|
pure virtual |
设置 SDK 预设的变声效果。
调用该方法可以为本地发流用户设置 SDK 预设的变声效果。设置变声效果后,频道内所有用户都能听到该效果。根据不同的场景, 你可以为用户设置不同的变声效果,各变声效果的适用场景可参考《设置人声效果》。
为获取更好的人声效果,Agora 推荐你在调用该方法前将 setAudioProfile 的 profile
设为 AUDIO_PROFILE_MUSIC_HIGH_QUALITY (4) 或 AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO (5),并将 scenario
设为 AUDIO_SCENARIO_GAME_STREAMING (3)。
setAudioProfile
的 profile
参数设置为 AUDIO_PROFILE_SPEECH_STANDARD (1) 或 AUDIO_PROFILE_IOT (6),否则该方法不生效。preset | 预设的变声效果选项: VOICE_CONVERSION_PRESET |
|
pure virtual |
设置 SDK 预设人声音效的参数。
调用该方法可以对本地发流用户进行如下设置:
设置后,频道内所有用户都能听到该效果。
scenario
设为 AUDIO_SCENARIO_GAME_STREAMING(3)
。profile
参数设置为 AUDIO_PROFILE_SPEECH_STANDARD(1)
或 AUDIO_PROFILE_IOT(6)
,否则该方法不生效。preset | SDK 预设的音效:
|
param1 |
|
param2 |
|
|
pure virtual |
设置 SDK 预设美声效果的参数。
调用该方法可以设置歌唱美声效果的性别特征和混响效果。该方法对本地发流用户进行设置。设置后,频道内所有用户都能听到该效果。
为获取更好的人声效果,Agora 推荐你在调用该方法前将 setAudioProfile 的 scenario
设为 AUDIO_SCENARIO_GAME_STREAMING(3)
,并将 profile
设为 AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)
或 AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)
。
profile
参数设置为 AUDIO_PROFILE_SPEECH_STANDARD(1)
或 AUDIO_PROFILE_IOT(6)
,否则该方法不生效。preset | SDK 预设的音效:
|
param1 | 歌声的性别特征:
|
param2 | 歌声的混响效果:
|
|
pure virtual |
设置 Agora SDK 输出的日志文件。
logConfig
。默认情况下,SDK 会生成 agorasdk.log
、agorasdk_1.log
、agorasdk_2.log
、agorasdk_3.log
、agorasdk_4.log
这 5 个日志文件。 每个文件的默认大小为 1024 KB。日志文件为 UTF-8 编码。最新的日志永远写在 agorasdk.log
中。agorasdk.log
写满后,SDK 会从 1-4 中删除修改时间最早的一个文件, 然后将 agorasdk.log
重命名为该文件,并建立新的 agorasdk.log
写入最新的日志。
filePath | 日志文件的完整路径。默认路径为 C:\Users\<user_name>\AppData\Local\Agora\<process_name>\agorasdk.log 。请确保指定的目录存在而且可写。你可通过该参数修改日志文件名。 |
|
pure virtual |
设置日志输出等级。
logConfig
。设置 Agora SDK 的输出日志输出等级。不同的输出等级可以单独或组合使用。日志级别顺序依次为 OFF、CRITICAL、ERROR、WARNING、INFO 和 DEBUG。选择一个级别,你就可以看到在该级别之前所有级别的日志信息。
例如,你选择 WARNING 级别,就可以看到在 CRITICAL、ERROR 和 WARNING 级别上的所有日志信息。
filter | 设置过滤等级: LOG_FILTER_TYPE 。 |
|
pure virtual |
设置 Agora SDK 输出的单个日志文件大小。
logConfig
。默认情况下,SDK 会生成 agorasdk.log
、agorasdk_1.log
、agorasdk_2.log
、agorasdk_3.log
、agorasdk_4.log
这 5 个日志文件。 每个文件的默认大小为 1024 KB。日志文件为 UTF-8 编码。最新的日志永远写在 agorasdk.log
中。agorasdk.log
写满后,SDK 会从 1-4 中删除修改时间最早的一个文件, 然后将 agorasdk.log
重命名为该文件,并建立新的 agorasdk.log
写入最新的日志。
fileSizeInKBytes | 单个日志文件的大小,单位为 KB。默认值为 1024 KB。如果你将 fileSizeInKByte 设为 1024 KB,SDK 会最多输出 5 MB 的日志文件。如果你将 fileSizeInKByte 设为小于 1024 KB,单个日志文件最大仍为 1024 KB。 |
|
pure virtual |
设置本地视图显示模式。
该方法设置本地视图显示模式。 App 可以多次调用此方法更改显示模式。
renderMode | RENDER_MODE_TYPE 。 |
|
pure virtual |
更新本地视图显示模式。
初始化本地用户视图后,你可以调用该方法更新本地用户视图的渲染和镜像模式。该方法只影响本地用户看到的视频画面,不影响本地发布视频。
renderMode | 本地视图的渲染模式,详见 RENDER_MODE_TYPE |
mirrorMode |
|
|
pure virtual |
设置远端视图显示模式。
该方法设置远端视图显示模式。App 可以多次调用此方法更改显示模式。
userId | 远端用户 ID。 |
renderMode | RENDER_MODE_TYPE 。 |
|
pure virtual |
更新远端视图显示模式。
初始化远端用户视图后,你可以调用该方法更新远端用户视图在本地显示时的渲染和镜像模式。该方法只影响本地用户看到的视频画面。
userId | 远端用户 ID。 |
renderMode | 远端用户视图的渲染模式,详见 RENDER_MODE_TYPE |
mirrorMode |
|
|
pure virtual |
设置本地视频镜像模式。
mirrorMode | 详见 VIDEO_MIRROR_MODE_TYPE |
|
pure virtual |
开关双流模式。
该方法设置单流(默认)或者双流模式。发送端开启双流模式后,接收端可以选择接收大流还是小流。其中,大流指高分辨率、高码率的视频流,小流指低分辨率、低码率的视频流。
enabled |
|
|
pure virtual |
设置外部音频采集参数。
enabled |
|
sampleRate | 外部音频源的采样率 (Hz),可设置为 8000,16000,32000,44100 或 48000。 |
channels | 外部音频源的通道数,可设置为 1 或 2:
|
|
pure virtual |
设置外部音频渲染。
该方法适用于需要自行渲染音频的场景。开启外部音频渲染后,你可以通过调用 pullAudioFrame 方法拉取远端音频数据。 App 可以对拉取到的原始音频数据进行处理后再渲染,获取想要的音频效果。
enabled |
|
sampleRate | 外部音频渲染的采样率 (Hz),可设置为 16000,32000,44100 或 48000。 |
channels | 外部音频渲染的声道数,可设置为 1 或 2:
|
|
pure virtual |
设置采集的音频格式。
该方法设置 onRecordAudioFrame 回调的采集音频格式。
sampleRate | 指定 onRecordAudioFrame 中返回数据的采样率,可设置为 8000、 16000、 32000、 44100 或 48000。 |
channel | 指定 onRecordAudioFrame 中返回数据的通道数,可设置为 1 或 2:
|
mode | onRecordAudioFrame 回调的使用模式: RAW_AUDIO_FRAME_OP_MODE_TYPE 。 |
samplesPerCall | 指定 onRecordAudioFrame 中返回数据的采样点数,如 RTMP/RTMPS 推流应用中通常为 1024。 |
onRecordAudioFrame
回调。请确保采样间隔不得小于 0.01 (s)。其中,采样间隔 = samplesPerCall/(sampleRate × channel)。
|
pure virtual |
设置播放的声音格式。
sampleRate | 指定 onPlaybackAudioFrame 中返回数据的采样率,可设置为 8000,16000,32000,44100 或 48000。 |
channel | 指定 onPlaybackAudioFrame 中返回数据的通道数,可设置为 1 或 2:
|
mode | 指定 onPlaybackAudioFrame 的使用模式: RAW_AUDIO_FRAME_OP_MODE_TYPE 。 |
samplesPerCall | 指定 onPlaybackAudioFrame 中返回数据的采样点数,如RTMP推流应用中通常为 1024。 |
onPlaybackAudioFrame
回调。请确保采样间隔不得小于 0.01 (s)。其中,采样间隔 = samplesPerCall/(sampleRate × channel)。
|
pure virtual |
设置采集与播放声音混音后的数据格式
sampleRate | 指定 onMixedAudioFrame 中返回数据的采样率,可设置为 8000,16000,32000,44100 或 48000。 |
samplesPerCall | 指定 onMixedAudioFrame 中返回数据的采样点数,如 RTMP/RTMPS 推流应用中通常为 1024。 |
onMixedAudioFrame
回调。请确保采样间隔不得小于 0.01 (s)。其中,采样间隔 = samplesPerCall/(sampleRate × channels)。
|
pure virtual |
调节麦克风采集信号音量。
volume | 麦克风采集信号音量。取值范围为 [0,100]。默认值为 100,表示原始音量。 |
|
pure virtual |
调节本地播放的所有远端用户信号音量。
adjustPlaybackSignalVolume
和 adjustAudioMixingPlayoutVolume 方法,并将 volume
设置为 0
。volume | 播放音量。取值范围为 [0,100]。默认值为 100,表示原始音量。 |
|
pure virtual |
调节声卡采集信号音量。
调用 enableLoopbackRecording 开启声卡采集后,你可以调用该方法调节声卡采集的信号音量。
volume | 声卡采集信号音量。取值范围为 [0,100]。默认值为 100,表示原始音量。 |
|
pure virtual |
打开直播场景下与 Agora Web SDK 的互通。
enabled |
|
|
pure virtual |
degradationPrefer
参数设置视频质量偏好。该方法允许用户设置视频的优化选项。设置视频优化选项(仅适用于直播)。
preferFrameRateOverImageQuality | 支持两种优化选项:
|
|
pure virtual |
设置弱网条件下发布的音视频流回退选项。
网络不理想的环境下,实时通信音视频的质量都会下降。使用该接口并将 option
设置为 STREAM_FALLBACK_OPTION_AUDIO_ONLY (2) 后,SDK 会在上行弱网且音视频质量严重受影响时,自动关断视频流,从而保证或提高音频质量。同时 SDK 会持续监控网络质量,并在网络质量改善时恢复音视频流。当本地推流回退为音频流时,或由音频流恢复为音视频流时,SDK 会触发本地发布的媒体流已回退为音频流 onLocalPublishFallbackToAudioOnly 回调。
STREAM_FALLBACK_OPTION_AUDIO_ONLY (2)
可能导致 CDN 观众听到的声音有所延迟。Agora 不建议主播使用视频流回退机制。option | 本地发流回退处理选项:
|
|
pure virtual |
设置弱网条件下订阅的音视频流的回退选项。
默认 option
为 STREAM_FALLBACK_OPTION_VIDEO_STREAM_LOW (1) 。 如果你使用本方法并将 option
设置为 STREAM_FALLBACK_OPTION_AUDIO_ONLY (2), SDK 会在下行弱网且音视频质量严重受影响时,将视频流切换为小流,或关断视频流,从而保证或提高音频质量。 同时 SDK 会持续监控网络质量,并在网络质量改善时恢复音视频流。 当远端订阅流回退为音频流时,或由音频流恢复为音视频流时,SDK 会触发 onRemoteSubscribeFallbackToAudioOnly 回调。
option | 详见 STREAM_FALLBACK_OPTIONS 。 |
|
pure virtual |
切换前置/后置摄像头
|
pure virtual |
设置默认的音频路由
该方法设置接收到的语音从听筒或扬声器出声。如果用户不调用本方法,语音默认从听筒出声。
各频道场景下默认的音频路由:
defaultToSpeaker | 设置默认的音频路由
|