AliRtcEngine接口

创建AliRtcEngine实例。

static AliEngine *Create(const char *extras);

调用时机

请确保在调用 ARTC SDK 其他 APi 前调用该方法创建 AliRtcEngine 实例。

调用限制

对于每个 App，SDK 仅支持创建一个 AliRtcEngine 实例。

参数说明

返回说明

返回一个 AliEngine 类的单例实例。

销毁AliRtcEngine实例。

static void Destroy(AliEngineDestroyCompletionCallback *callback = nullptr);

销毁AliRtcEngine 单例对象，调用该方法后将会释放所有内部使用的资源，你将不能再使用AliRtcEngine的其他方法和任何回调，如需要再次使用需要重新调用Create 创建新的实例。

调用时机

当完成音视频通信之后都建议调用该方法释放实例。

调用限制

为避免死锁，不建议在任何SDK的回调中调用本方法。

参数说明

获取功能接口实例。

virtual int QueryInterface(AliEngineInterfaceIdType iid, void** pInterface) = 0;

本接口用于获取特定类型的功能接口实例。在开发音视频相关应用时，windows 平台下许多高级功能（如音频设备管理AliEngineInterfaceAudioDeviceManger、视频设备管理AliEngineInterfaceVideoDeviceManger和媒体引擎AliEngineInterfaceMediaEngine）是通过对应的接口类提供的。但在调用相关方法之前，必须通过 QueryInterface 方法获取这些接口的实例。

参数说明

返回说明

• 0：获取成功。

• <0：获取失败。

设置是否兼容H5。

static void SetH5CompatibleMode(bool comp);

参数说明

检查是否设置了H5兼容模式。

static bool GetH5CompatibleMode();

返回说明

YES表示兼容H5，NO表示不兼容H5。

设置相关监听事件回调。

virtual int SetEngineEventListener(AliEngineEventListener *listener) = 0;

该方法为 SDK 用于设置回调监听器的一个方法。通过设置该监听器，开发者可以接收引擎中的各种通知事件（如用户加入、离开频道、网络状态变化、音视频流状态等）。

开发者需要实现 AliEngineEventListener 类，来定制具体需要监听的事件方法。默认所有接口都有空实现，开发者不需要实现所有方法，可根据自身业务来实现对应的事件方法。

相关回调

在运行过程中如遇到异常情况，会优先尝试内部重试机制以自动恢复。对于无法自行解决的错误，SDK 会通过预定义的回调接口通知您的应用程序。以下是一些 SDK 无法处理、需由应用层监听和响应的关键回调：

参数说明

返回说明

• 0：成功。

• 非 0：失败，可能因为传入的 listener 参数不合法或 SDK 未正确初始化。

查询当前 SDK 版本。

static const char *GetSDKVersion();

返回说明

当前的SDK版本号，格式为字符串，例："2.5.0.x"。

设置频道模式。

virtual int SetChannelProfile(const AliEngineChannelProfile channelProfile) = 0;

该接口用于设置频道模式，目前主要提供视频通话场景和互动直播场景：

• 视频通话模式：所有用户都是主播角色，可以进行推流和拉流。

• 互动直播模式：需要调用SetClientRole（设置角色），在频道内推流的用户设置主播角色（AliRTCSdkInteractive）；如果用户只需要拉流，不需要推流，则设置观众角色（AliRTCSdkLive）。RTC 场景推荐设置为此模式。

调用时机

该接口只可以在加入频道之前调用，会议中不可以重新设置，离开频道后可以重新设置。

参数说明

返回说明

• 0：表示方法调用成功。

• 其他表示方法调用失败。

  • -1：SDK未初始化或已销毁。

设置音频Profile。

virtual int SetAudioProfile(int audioProfile, int audioScene) = 0;

该接口用于设置音频编码模式以及音频场景模式。详情请参考音频常用操作和配置。ARTC SDK 默认使用高音质模式（AliEngineHighQualityMode）和音乐场景模式（AliEngineSceneMusicMode）。如果默认设置无法满足您的需求，您需要调用此接口进行设置。

调用时机

该接口只可以在加入频道之前调用，加入频道后不可以重新设置，离开频道后可以重新设置。

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

检查当前是否纯音频模式。

virtual bool IsAudioOnlyMode() = 0;

返回说明

YES表示纯音频模式，NO表示音视频模式。

设置为纯音频模式还是音视频模式。

virtual int SetAudioOnlyMode(bool audioOnly) = 0;

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

加入频道。

virtual int JoinChannel(const char *token, const char *channelId, const char *userId, const char *userName) = 0;

该接口用于加入频道。ARTC 通过频道组织用户，用户需要加入频道才能“发布”或“订阅”音视频流。本接口与 JoinChannel[2/3]和接口JoinChannel[3/3]均可以加入频道，区别在于通过的认证方式和传递的用户信息，具体如下：

• 本接口为单参入会接口，传入Token鉴权生成单参入会的 Token 即可入会。RTC 场景推荐使用该接口加入频道。

• JoinChannel[2/3]为多参入会接口，需要传入Token鉴权生成的多参入会 Token，并传入生成 Token 使用的用户信息入会。

• JoinChannel[3/3]为 AI 实时互动场景使用，传入单参入会 Token，并根据场景设置用户属性capabilityProfile。

调用时机

需要在创建引擎后调用。

调用限制

• 加入频道成功后，如果中途需要加入其他频道，必须先调用LeaveChannel离开当前频道，并确保收到OnLeaveChannelResult回调，之后才能再次调用入会。

• 该方法仅支持用户一次加入一个频道。

• 使用不同 App ID 的 App 不能互通。

• 加入频道失败重试时无需调用。

相关回调

成功调用该接口后会触发以下回调：

• 本端加入频道的结果会通过AliRtcEngineEventListener中的OnJoinChannelResult 回调进行通知加入频道的结果

• 成功加入频道后，远端会触发OnRemoteUserOnLineNotify回调。

参数说明

返回说明

0表示方法调用成功，非0表示方法调用失败。

加入频道。

virtual int JoinChannel(const AliEngineAuthInfo &authInfo,
                                 const char *userName) = 0;

该接口用于加入频道。ARTC 通过频道组织用户，用户需要加入频道才能“发布”或“订阅”音视频流。本接口与 JoinChannel[1/3]和接口JoinChannel[3/3]均可以加入频道，区别在于通过的认证方式和传递的用户信息，具体如下：

• JoinChannel[1/3]为单参入会接口，传入Token鉴权生成单参入会的Token 即可入会。RTC 场景推荐使用该接口加入频道。

• 本接口为多参入会接口，需要传入Token鉴权生成多参入会Token，并传入生成 Token 使用的用户信息入会。

• JoinChannel[3/3]为 AI 实时互动场景使用，传入单参入会 Token，并根据场景设置用户属性capabilityProfile。

调用限制

• 加入频道成功后，如果中途需要加入其他频道，必须先调用LeaveChannel离开当前频道，并确保收到OnLeaveChannelResult回调，之后才能再次调用入会。

• 该方法仅支持用户一次加入一个频道。

• 使用不同 App ID 的 App 不能互通。

相关回调

成功调用该接口后会触发以下回调：

• 本端加入频道的结果会通过OnJoinChannelResult 回调进行通知加入频道的结果

• 成功加入频道后，远端会触发OnRemoteUserOnLineNotify回调。

参数说明

加入频道。

virtual int JoinChannel(const char *token, const char *channelId, const char *userId, const AliEngineChannelParam &userParam) = 0;

该接口用于加入频道。ARTC 通过频道组织用户，用户需要加入频道才能“发布”或“订阅”音视频流。本接口与 JoinChannel[1/3]和接口JoinChannel[2/3]均可以加入频道，区别在于通过的认证方式和传递的用户信息，具体如下：

• JoinChannel[1/3]为 RTC 场景单参入会接口，传入Token鉴权生成单参入会的 Token 即可入会。RTC 场景推荐使用该接口加入频道。

• JoinChannel[2/3]为多参入会接口，需要传入Token鉴权生成多参入会的 Token，并传入生成 Token 使用的用户信息入会。

• 本接口为 AI 实时互动场景使用，传入单参入会 Token，并根据场景设置用户属性capabilityProfile，如果要与 AI 智能体通话时设置为AliCapabilityProfileHuman。

调用限制

• 加入频道成功后，如果中途需要加入其他频道，必须先调用leaveChannel离开当前频道，并确保收到OnLeaveChannelResult回调，之后才能再次调用加入频道。

• 该方法仅支持用户一次加入一个频道。

• 使用不同 App ID 的 App 不能互通。

• 加入频道失败重试时无需调用。

相关回调

成功调用该接口后会触发以下回调：

• 本端加入频道的结果会通过OnJoinChannelResult 回调进行通知加入频道的结果

• 成功加入频道后，远端会触发OnRemoteUserOnLineNotify回调。

参数说明

返回说明

0表示方法调用成功，非0表示方法调用失败。

离开频道。

virtual int LeaveChannel() = 0;

调用该方法后，SDK 会终止音视频互动、离开当前频道。

调用时机

• 应该在加入频道后需要离开频道时调用该方法。

• 如果已经加入频道且需要加入其他频道需要调用此接口先退出频道。

相关回调

• 本端：调用本方法后会触发OnLeaveChannelResult 回调通知离会结果。

• 远端：调用该接口成功后远端用户会触发OnRemoteUserOffLineNotify 回调。

返回说明

0表示方法调用成功，其他表示方法调用失败。

检查当前是否在频道中。

virtual bool IsInCall() = 0;

返回说明

true表示在频道中，false表示不在频道中。

设置用户角色。

virtual int SetClientRole(const AliEngineClientRole clientRole) = 0;

该方法用于设置用户角色为主播/观众。

互动模式下，加入频道前：

• 设置用户角色为主播：SDK默认会自动推送本地音视频流，并接收其他主播的音视频流

• 设置用户角色为观众：SDK不会推送本地的音视频流，但会接收其他主播的音视频流。

调用时机

该方法在加入频道前后均可调用，可以在入会前调用设置用户角色，也可以在入会后调用进行用户角色切换。

调用限制

该方法在互动模式下才有效，即调用SetChannelProfile接口设置为AliEngineInteractiveLive时才有效。

互动模式下建议入会前显式调用设置用户角色。

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

获取当前用户角色类型（主播/观众）。

virtual AliEngineClientRole GetClientRole() = 0;

返回说明

方法调用成功后，返回AliEngineClientRole对象，该对象为枚举类型，表示角色类型为主播（0） 或者观众（1）。

刷新鉴权信息。

virtual int RefreshAuthInfo(const AliEngineAuthInfo &authInfo) = 0;

该方法用于更新鉴权信息。Token 会在一定时间后失效，此时 SDK 将无法和服务器建立连接。

调用时机

在以下情况下：

• 当收到OnAuthInfoWillExpire回调报告鉴权信息即将过期时，推荐你在你的服务端重新生成 Token，然后调用该方法传入新的 Token。

• 如果没有及时更新 Token，会触发OnAuthInfoExpired通告鉴权已经过期，此时需要重新生成 Token 然后调用JoinChannel重新加入频道。

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

刷新鉴权信息。

virtual int RefreshAuthInfo(const char *token) = 0;

该方法用于更新 Token。Token 会在一定时间后失效，此时 SDK 将无法和服务器建立连接。

调用时机

在以下情况下，推荐你在你的服务端重新生成 Token，然后调用该方法传入新的 Token：

• 当收到OnAuthInfoWillExpire回调报告鉴权信息即将过期时。

• 如果没有及时更新 Token，会触发OnAuthInfoExpired通告鉴权已经过期，此时需要调用JoinChannel重新加入频道。

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

设置是否允许发布音频流。

virtual int PublishLocalAudioStream(bool enabled) = 0;

该方法用于控制是否发布本地采集的音频流。SDK默认设置推送音频流，如果您不想默认推送音频流，可以在入会前调用PublishLocalAudioStream(false)关闭音频流的推送。

调用时机

加入频道前后均可调用。加入频道前调用可修改默认配置，在加入频道时生效。

相关回调

本地音频推流结果发生变化时，本端会触发OnAudioPublishStateChanged回调通知音频推流最新状态，远端会触发OnRemoteTrackAvailableNotify通知远端用户的音视频流发生变化。

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

查询当前是否允许推音频流。

virtual bool IsLocalAudioStreamPublished() = 0;

返回说明

true表示允许推送，false表示不允许推送。

设置是否默认接收音频流。

virtual int SetDefaultSubscribeAllRemoteAudioStreams(bool sub) = 0;

该接口用于配置系统是否默认订阅远端用户的音频流，该设置将影响新加入频道用户的音频流订阅行为。无特殊场景需求建议设置为 true。

调用时机

加入频道前后均可调用。

• 加入频道前：

  • SDK 加入频道时默认订阅远端用户的音频流，如果希望修改此行为，可在加入频道前调用该接口。

• 加入频道后：

  • 如果希望停止默认订阅，可调用SetDefaultSubscribeAllRemoteAudioStreams(false)，则不会订阅后续加入频道的用户的音频流。

  • 停止默认订阅后，如果希望恢复订阅指定用户的音频流，请调用 SubscribeRemoteAudioStream 接口，如果希望恢复多个用户请多次调用。

  • 停止默认订阅后，调用SetDefaultSubscribeAllRemoteAudioStreams(true)仅恢复后续加入频道的用户的音频流，对于停止期间加入的远端用户不会订阅。

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

停止或恢复特定远端用户的音频流拉取。

virtual int SubscribeRemoteAudioStream(const char* uid, bool sub) = 0;

该接口用于停止或恢复订阅特定远端用户的音频流，无特殊场景需求建议设置为 true。

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

停止或恢复接收所有远端音频流。

virtual int SubscribeAllRemoteAudioStreams(bool sub) = 0;

该接口为订阅远端音频流的总开关，建议设为 true。 如果设置为 false，则会导致：

• 当前会议中所有远端音频停止订阅；

• 后续入会的新用户也不再订阅；

• 无法通过SubscribeRemoteAudioStream单独操控指定用户的音频流。

如果需要重新订阅，请再次调用本接口并设置为 true 恢复订阅。

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

发布/停止发布相机流。

virtual int PublishLocalVideoStream(bool enabled) = 0;

该方法用于控制是否发布本地采集的视频流。

调用时机

加入频道前后均可调用。

加入频道前调用可修改默认配置，在加入频道时生效。

相关回调

本地音频推流结果发生变化时，本端会触发OnVideoPublishStateChanged回调通知音频推流最新状态，远端会触发OnRemoteTrackAvailableNotify通知远端用户的音视频流发生变化。

参数说明

返回说明

• 0：接口调用成功。

• <0：接口调用失败。

查询当前是否允许发布视频流。

virtual bool IsLocalVideoStreamPublished() = 0;

返回说明

true表示发布相机流，false表示不发布相机流。

设置是否默认接收视频流。

virtual int SetDefaultSubscribeAllRemoteVideoStreams(bool sub) = 0;

该接口用于设置是否默认订阅视频流，SDK 默认订阅。

调用时机

入会前后均可调用。

• 入会前：

  • 可通过此接口取消默认订阅设置。

• 入会后：

  • 如果希望停止默认订阅，可调用SetDefaultSubscribeAllRemoteVideoStreams(false)，则不会订阅后续加入频道的用户的音频流。

  • 停止默认订阅后，如果希望恢复订阅指定用户的音频流，请调用 SubscribeRemoteVideoStream 接口，如果希望恢复多个用户请多次调用。

  • 停止默认订阅后，调用SetDefaultSubscribeAllRemoteVideoStreams(false)仅恢复后续加入频道的用户的音频流。

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

停止/恢复订阅远端用户的视频流。

virtual int SubscribeRemoteVideoStream(const char* uid, AliEngineVideoTrack track, bool sub) = 0;

对指定用户的视频流进行订阅和取消订阅的操作。

调用时机

入会前后均可调用。

参数说明

返回说明

• true：设置成功。

• false：设置失败。

停止或恢复接收所有远端视频流。

virtual int SubscribeAllRemoteVideoStreams(bool sub) = 0;

该接口为订阅远端视频流的总开关，如果设置为 false，则会导致：

• 当前会议中所有远端视频流停止订阅；

• 后续入会的新用户也不再订阅（即使设置了SetDefaultSubscribeAllRemoteVideoStreams(true)默认订阅）；

• 无法通过SubscribeRemoteVideoStream单独操控指定用户的音频流。

如果需要重新订阅，请再次调用本接口并设置为 true 恢复订阅。

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

停止或恢复特定远端用户的媒体流。

virtual int SubscribeRemoteMediaStream(const char* uid, AliEngineVideoTrack videoTrack, bool subVideo,  bool subAudio) = 0;

该接口用于合并订阅远端音视频流。

相关接口

相比SubscribeRemoteMediaStream[2/2]，本接口通过两个布尔类型参数 subVideo、subAudio 决定是否订阅远端音视频流，videoTrack 用于控制拉取哪一路视频流。

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

停止或恢复特定远端用户的媒体流。

virtual int SubscribeRemoteMediaStream(const char* uid, AliEngineVideoTrack videoTrack, AliEngineAudioTrack audioTrack) = 0;

该接口用于合并订阅远端音视频流。

相关接口

相比于SubscribeRemoteMediaStream[1/2]，这个接口通过 videoTrack、audioTrack 两个参数在一个接口中把想要订阅的状态告知SDK，例如：

• 希望订阅相机流和麦克风流，则在调用时将 videoTrack 和 audioTrack 分别置为 AliRtcVideoTrackCamera和AliRtcAudioTrackMic。

• 希望取消订阅相机流但保留麦克风，则在再次调用时将 videoTrack 和 audioTrack 分别置为AliRtcVideoTrackNo和AliRtcAudioTrackMic。

• 如果希望都取消，则在再次调用时将 videoTrack 和 audioTrack 分别置为AliRtcVideoTrackNo和AliRtcAudioTrackNo。

• 如果希望同时订阅相机流和屏幕共享流两路视频流，将 videoTrack 设置为AliRtcVideoTrackBoth，音频同理。

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

跨频道订阅指定用户的流。

virtual int SubscribeRemoteDestChannelStream(const char* channelId, const char* uid, AliEngineVideoTrack track, bool sub_audio, bool sub) = 0;

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

调节本地播放的指定远端用户音量。

virtual int SetRemoteAudioVolume(const char *uid, int volume) = 0;

参数说明

返回说明

• 0：成功。

• 非 0：失败。

停止或恢复本地音频数据发送。

virtual int MuteLocalMic(bool mute, AliEngineMuteLocalAudioMode mode = AliEngineMuteLocalAudioModeDefault) = 0;

调用时机

加入房间前后均可调用。

相关回调

调用成功后，远端用户触发OnUserAudioMuted通知该用户是否静音。

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

停止或恢复远端的音频播放。

virtual int MuteRemoteAudio(const char *uid,
                                    bool mute) = 0;

该接口仅用于停止或者恢复远端指定用户的音频的播放，但是不影响对远端音频的拉流和解码，如果希望取消订阅某个用户的音频流，请调用SubscribeRemoteAudioStream 完成。

调用时机

加入频道前后均可调用。

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

停止或恢复远端所有的音频播放。

virtual int MuteAllRemoteAudio(bool mute) = 0;

该接口用于停止或恢复远端所有音频播放。

调用时机

加入频道前后均可设置。

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

开启音频采集。

virtual int StartAudioCapture() = 0;

此接口用于控制开启音频采集。此外在入会前调用可以控制提前打开音频采集，如果不设置，则SDK会自动控制音频采集设备。调用stopAudioCapture关闭音频采集后如果想要打开，请调用此接口。

调用时机

入会前后均可调用。

相关接口

• StartAudioCapture[2/2]接口通过参数可以控制离会后音频采集设备是否保持开启状态。

相关回调

调用此接口修改本地音频采集状态后，可通过 OnLocalAudioStateChange 回调来获取状态变化。

返回说明

0表示方法调用成功，其他表示方法调用失败。

开启音频采集。

virtual int StartAudioCapture(bool keepAlive) = 0;

静音后关闭麦克风采集。

此接口用于控制开启音频采集。此外在入会前调用可以控制提前打开音频采集，如果不设置，则SDK会自动控制音频采集设备。

调用时机

入会前后均可调用。

相关接口

相比StartAudioCapture[1/2]，本接口允许通过 keepAlive 参数控制离会后采集设备是否保持开启。

相关回调

调用此接口修改本地音频采集状态后，可通过 OnLocalAudioStateChange 回调来获取状态变化。

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

关闭音频采集。

virtual int StopAudioCapture() = 0;

调用StartAudioCapture开启音频设备采集后，可以调用此方法停止采集。

相关回调

调用此接口修改本地音频采集状态后，可通过 OnLocalAudioStateChange 回调来获取状态变化。

返回说明

0表示方法调用成功，其他表示方法调用失败。

设置音量回调频率和平滑系数。

virtual int EnableAudioVolumeIndication(int interval, int smooth, int reportVad) = 0;

该接口允许 SDK 定期向 App 报告本地发流用户和瞬时音量最高的远端用户的音量相关信息。

调用时机

加入频道前后均可调用。

相关回调

成功调用该方法后，如果频道内存在发流用户时，SDK 会按照设置的时间间隔触发下面两个回调：

• 说话人的音频音量会通过OnAudioVolumeCallback 回调通知，回调频率会根据 interval 决定。

• 语音激励，当监测到活跃用户时，说话人uid会通过OnActiveSpeaker回调。

调用时机

入会前后均可调用。

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

开启音频播放设备。

virtual int StartAudioPlayer() = 0;

此接口可以控制提前打开音频播放，如果不设置，则SDK会在订阅到音频流后自动打开音频播放。

返回说明

• 0：成功。

• 非 0：失败，返回错误码。

关闭音频播放。

virtual int StopAudioPlayer() = 0;

此接口可以控制关闭音频播放，与AliEngine::StartAudioPlayer对应。

参数说明

无。

返回说明

• 0：成功。

• 非 0：失败，返回错误码。

设置播放音量。

virtual int SetPlayoutVolume(int volume) = 0;

参数说明

返回说明

• 0：成功。

• 非 0：失败，返回错误码。

virtual int SetRecordingVolume(int volume) = 0;

参数说明

返回说明

• 0：成功。

• 非 0：失败，返回错误码。

播放音频文件。

virtual int PlayAudioFileTest(const char* filePath) = 0;

参数说明

返回说明

• 0：成功。

• <0：失败。

停止播放音频文件。

virtual int StopAudioFileTest() = 0;

返回说明

• 0：成功。

• <0：失败。

通话前开启音频采集测试。

virtual int StartAudioCaptureTest() = 0;

此接口可以控制打开音频采集测试,通过 AliEngineEventListener::OnTestAudioVolumeCallback 回调结果来判断音频采集是否正常。

返回说明

• 0：成功。

• <0：失败。

关闭音频采集测试。

virtual int StopAudioCaptureTest() = 0;

返回说明

• 0：成功。

• <0：失败。

开启/关闭系统声音采集推送。

virtual int EnableSystemAudioRecording(bool enable, const char *path = nullptr, const char *device_id = nullptr) = 0;

此接口用于开启或关闭系统声音采集，如浏览器、应用播放的声音等。

参数说明

返回说明

• 0：接口调用成功。

• <0：接口调用失败。

当前是否开启系统声音采集推送。

virtual bool IsSystemAudioRecording() = 0;

返回说明

• true：开启状态。

• false：关闭状态。

设置系统声音采集推送音量。

virtual int SetSystemAudioRecordingVolume(int volume) = 0;

此接口仅在 Windows 和 macOS 平台上有效。

此接口需要开启系统声音采集推送后才能设置，否则设置无效。

参数说明

返回说明

• 0：成功。

• <0：失败。

获取当前设置系统声音采集推送音量。

virtual int GetSystemAudioRecordingVolume() = 0;

此接口仅在 Windows 和 macOS 平台上有效。

返回说明

系统采集推流音量。

设置系统声音播放音量。

virtual int SetSystemAudioPlayoutVolume(int volume) = 0;

此接口仅在 Windows 和 macOS 平台上有效。

此接口需要开启系统声音采集推送后才能设置，否则设置无效。

参数说明

返回说明

• 0：成功。

• <0：失败。

获取当前设置系统声音播放音量。

virtual int GetSystemAudioPlayoutVolume() = 0;

此接口仅在 Windows 和 macOS 平台上有效。

返回说明

系统采集播放音量。

获取系统中的录音设备列表。

virtual AliEngineDeviceInfoList* GetAudioCaptureList() = 0;

返回值

AliEngineDeviceInfoList * 录音设备列表指针。

获取使用的录音设备名称。

virtual String GetCurrentAudioCaptureName() = 0;

返回值

String 当前音频采集设备名。

获取使用的录音设备ID。

virtual String GetCurrentAudioCaptureID() = 0;

返回值

当前使用的录音设备ID。

选择录音设备名称。

virtual int SetCurrentAudioCaptureName(const char* captureName) = 0;

参数说明

返回值

0成功，其他失败。

选择录音设备ID。

virtual int SetCurrentAudioCaptureID(const char* captureID) = 0;

参数说明

返回值

0成功，其他失败。

获取系统中的扬声器列表。

virtual AliEngineDeviceInfoList* GetAudioPlayerList() = 0;

返回值

系统中的扬声器列表对象指针 AliEngineDeviceInfoList *

获取系统中的可录制的扬声器列表（系统内录使用）。

virtual AliEngineDeviceInfoList* GetSystemRecordAudioPlayerList() = 0;

返回值

音频播放设备列表主要提供给EnableSystemAudioRecording作为最后一个参数使用，采集系统播放音频使用。

获取当前使用的扬声器名称。

virtual String GetCurrentAudioPlayerName() = 0;

返回值

当前音频播放设备名

获取当前使用的扬声器ID。

virtual String GetCurrentAudioPlayerID() = 0;

返回值

当前音频播放设备ID。

选择扬声器名称。

virtual int SetCurrentAudioPlayerName(const char* playerName) = 0;

返回值

音频播放设备名称。

选择扬声器ID

virtual int SetCurrentAudioPlayerID(const char* playerID) = 0;

参数说明

返回值

0成功，其他失败。

设置音频采集设备音量，音量范围[0, 100]。

virtual int SetRecordingDeviceVolume(int volume) = 0;

参数列表

返回值

0成功，其他失败。

获取音频采集设备音量。

virtual int GetRecordingDeviceVolume() = 0;

返回值

>=0返回音量，其他失败。

设置音频播放设备音量，音量范围[0, 100]。

virtual int SetPlaybackDeviceVolume(int volume) = 0;

参数说明

返回值

0成功，其他失败。

获取音频播放设备音量。

virtual int GetPlaybackDeviceVolume() = 0;

返回值

>=0 系统音量，其他失败。

静音音频采集设备。

virtual int SetRecordingDeviceMute(bool mute) = 0;

参数说明

返回值

0成功，其他失败。

获取音频采集设备静音状态

virtual bool GetRecordingDeviceMute() = 0;

返回值

录音是否静音。

静音音频播放设备

virtual int SetPlaybackDeviceMute(bool mute) = 0;

参数说明

返回值

0成功，其他失败。

获取音频播放设备静音状态。

virtual bool GetPlaybackDeviceMute() = 0;

返回说明

播放设备是否被静音。

设置变声音效模式。

virtual int SetAudioEffectVoiceChangerMode(const AliEngineAudioEffectVoiceChangerMode &mode) = 0;

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

设置变调参数。

virtual int SetAudioEffectPitchValue(double value) = 0;

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

设置混响音效模式。

virtual int SetAudioEffectReverbMode(const AliEngineAudioEffectReverbMode& mode) = 0;

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

设置混响音效类型和具体参数。

virtual int SetAudioEffectReverbParamType(const AliEngineAudioEffectReverbParamType& type,
                                                  float value) = 0;

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

增加外部音频流。

virtual int AddExternalAudioStream(const AliEngineExternalAudioStreamConfig& config) = 0;

该接口用于新增一个外部音频流。以下为相关步骤：

1. 调用AddExternalAudioStream接口添加一个外部音频流并获取外部音频流 ID。

2. 调用PushExternalAudioStreamRawData向创建的音频流中传入音频数据。

3. 结束通话时，需要调用RemoveExternalAudioStream移除外部音频流。

如需在频道中发布自定义采集音频，可参考文档自定义音频采集。

参数说明

返回说明

大于0表示方法调用成功，返回值为外部音频流ID，其他表示方法调用失败。

输入外部音频流数据。

virtual int PushExternalAudioStreamRawData(int streamId, AliEngineAudioRawData& data) = 0;

该接口用于向指定的音频流传入数据。以下为相关步骤：

1. 调用AddExternalAudioStream接口添加一个外部音频流并获取外部音频流 ID。

2. 调用PushExternalAudioStreamRawData向创建的音频流中传入音频数据。

3. 结束通话时，需要调用RemoveExternalAudioStream移除外部音频流。

如需在频道中发布自定义采集音频，可参考文档自定义音频采集。

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

设置外部音频流推流音量。

virtual int SetExternalAudioStreamPublishVolume(int streamId, int vol) = 0;

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

设置外部音频流推流音量。

virtual int SetExternalAudioStreamPlayoutVolume(int streamId, int vol) = 0;

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

获取外部音频流推流音量。

virtual int GetExternalAudioStreamPublishVolume(int streamId) = 0;

参数说明

返回说明

[0, 100]: 推流音量，小于0表示失败。

获取外部音频流播放音量。

virtual int GetExternalAudioStreamPlayoutVolume(int streamId) = 0;

参数说明

返回说明

[0, 100]: 播放音量，小于0表示失败。

移除外部音频流。

virtual int RemoveExternalAudioStream(int streamId) = 0;

该方法负责根据传入的 streamId 移除对应的外部音频流，与 AddExternalAudioStream方法相对应。

调用时机

如果您想要使用自定义音频输入功能，需要调用 AddExternalAudioStream方法添加一个音频流并获取外部音频流 Id，之后调用PushExternalAudioStreamRawData接口向 sdk 输入您的音频数据。在您想要停止自定义音频输入时，调用当前接口移除对应的外部音频流并清理资源。

参数说明

返回值

0成功，其他失败。

获取音频文件信息。

virtual int GetAudioFileInfo(const char *filePath) = 0;

异步接口，可通过AliEngineEventListener::OnAudioFileInfo获取音频文件信息。

参数说明

返回说明

• 0：成功。

• 非 0：失败，返回错误码。

开始伴奏混音。

virtual int StartAudioAccompany(const char *filePath, const AliEngineAudioAccompanyConfig& config) = 0;

异步接口，可通过AliEngineEventListener::OnAudioAccompanyStateChanged监听音频伴奏播放器状态。

参数说明

返回说明

• 0：成功。

• 非 0：失败，返回错误码。

停止伴奏混音。

virtual int StopAudioAccompany() = 0;

返回说明

• 0：成功。

• 非 0：失败，返回错误码。

设置伴奏音量。

 virtual int SetAudioAccompanyVolume(int volume) = 0;

参数说明

返回说明

• 0：成功。

• 非 0：失败，返回错误码。

设置伴奏推流音量。

virtual int SetAudioAccompanyPublishVolume(int volume) = 0;

参数说明

返回说明

• 0：成功。

• 非 0：失败，返回错误码。

获取伴奏推流音量。

virtual int GetAudioAccompanyPublishVolume() = 0;

返回说明

伴奏推流的音量，范围为 [0-100]。

设置伴奏本地播放音量。

virtual int SetAudioAccompanyPlayoutVolume(int volume) = 0;

参数说明

返回说明

• 0：成功。

• 非 0：失败，返回错误码。

获取伴奏本地播放音量。

virtual int GetAudioAccompanyPlayoutVolume() = 0;

返回说明

伴奏本地播放的音量，范围为 [0-100]。

暂停伴奏混音。

virtual int PauseAudioAccompany() = 0;

返回说明

• 0：成功。

• 非 0：失败，返回错误码。

重新开始伴奏混音。

virtual int ResumeAudioAccompany() = 0;

返回说明

• 0：成功。

• 非 0：失败，返回错误码。

获取伴奏文件时长, 单位为毫秒。

virtual int GetAudioAccompanyDuration() = 0;

返回说明

音频伴奏文件的时长，单位为毫秒。

获取伴奏文件播放进度，单位为毫秒。

virtual int GetAudioAccompanyCurrentPosition() = 0;

返回说明

音频伴奏文件当前播放位置，单位为毫秒。

设置伴奏文件的播放位置。

virtual int SetAudioAccompanyPosition(int pos) = 0;

返回说明

• 0：成功。

• 非 0：失败，返回错误码。

预加载音效文件。

virtual int PreloadAudioEffect(unsigned int soundId,
                                       const char *filePath) = 0;

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

删除预加载的音效文件。

virtual int UnloadAudioEffect(unsigned int soundId) = 0;

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

开始播放音效。

virtual int PlayAudioEffect(unsigned int soundId, const char *filePath, const AliEngineAudioEffectConfig& config) = 0;

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

停止播放音效。

virtual int StopAudioEffect(unsigned int soundId) = 0;

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

停止播放所有音效。

- (int)StopAllAudioEffects;

返回说明

0表示方法调用成功，其他表示方法调用失败。

暂停音效。

virtual int PauseAudioEffect(unsigned int soundId) = 0;

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

暂停所有音效。

virtual int PauseAllAudioEffects() = 0;

返回说明

0表示方法调用成功，其他表示方法调用失败。

重新开始播放音效。

virtual int ResumeAudioEffect(unsigned int soundId) = 0;

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

重新开始播放所有音效。

virtual int ResumeAllAudioEffects() = 0;

返回说明

0表示方法调用成功，其他表示方法调用失败。

设置音效推流音量。

virtual int SetAudioEffectPublishVolume(unsigned int soundId, int volume) = 0;

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

获取推流音效音量。

virtual int GetAudioEffectPublishVolume(unsigned int soundId) = 0;

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

设置所有音效本地播放音量。

virtual int SetAllAudioEffectsPublishVolume(int volume) = 0;

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

设置音效本地播放音量。

virtual int SetAudioEffectPlayoutVolume(unsigned int soundId, int volume) = 0;

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

获取音效本地播放音量。

virtual int GetAudioEffectPlayoutVolume(unsigned int soundId) = 0;

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

设置所有音效播放音量。

virtual int SetAllAudioEffectsPlayoutVolume(int volume) = 0;

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

设置所有音效推流音量。

virtual int SetAllAudioEffectsPublishVolume(int volume) = 0;

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

为本地预览设置渲染窗口以及绘制参数。

virtual int SetLocalViewConfig(AliEngineVideoCanvas renderConfig,
                                         AliEngineVideoTrack track) = 0;

该方法用于设置本地预览视图，调用该方法会绑定本地视频流的显示视窗 (view)，并设置本地用户视图的渲染模式、镜像模式和旋转角度等，只影响本地用户预览画面，不影响推流视频。如果需要设置远端用户界面视图请调用SetRemoteViewConfig。

调用时机

该方法在加入频道前后均可调用。

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

设置摄像头采集偏好。

virtual int SetCameraCapturerConfiguration(const AliEngineCameraCapturerConfiguration& config) = 0;

该接口用于配置摄像头采集时的偏好，例如摄像头方向、采集帧率等。

调用时机

必须在打开摄像头之前设置，例如在以下操作前调用：

• StartPreview（开始预览）

• JoinChannel（加入频道）

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

禁用或重新启用本地视频采集。

virtual int EnableLocalVideo(bool enabled) = 0;

该方法用于控制本地视频采集的开启和关闭，当关闭本地视频采集时，本地预览和推流均没有视频数据，但是并不影响接收远端视频。如果调用此接口关闭了本地摄像头采集，那么本端预览和远端推流都会停留在最后一帧。

调用时机

该方法在加入频道前后均可调用。

相关回调

成功调用本接口后会通过 OnUserVideoEnabled 回调通知远端用户。

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

停止或恢复本地视频数据发送。

virtual int MuteLocalCamera(bool mute, AliEngineVideoTrack track) = 0;

推流时可调用此接口实现推送全黑色的视频帧，本地预览正常，采集，编码，发送模块仍然工作，只是视频内容是黑色帧。

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

为远端的视频设置渲染窗口以及绘制参数。

virtual int SetRemoteViewConfig(AliEngineVideoCanvas renderConfig,
                                          const char *uid,
                                          AliEngineVideoTrack track) = 0;

该方法会绑定远端用户指定视频流的显示视图，并设置远端用户视图在本地显示时的渲染模式、镜像模式和旋转角度等，只影响本地用户看到的视频画面。如果需要设置本地预览视图，请调用SetLocalViewConfig。

• 如果AliEngineVideoCanvas中的view参数为空，则停止渲染。

• 如果在播放过程中需要重新设置AliEngineVideoCanvas的参数renderMode，请保持其他参数不变，仅修改renderMode。

• 如果在播放过程中需要重新设置AliEngineVideoCanvas的参数mirrorMode，请保持其他参数不变，仅修改mirrorMode。

调用时机

建议在收到OnRemoteTrackAvailableNotify 回调时调用，即远端用户视频可用时设置。

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

检查摄像头是否打开。

virtual bool IsCameraOn() = 0;

返回说明

YES表示摄像头已打开，NO表示摄像头没有打开。

设置视频编码属性。

virtual void SetVideoEncoderConfiguration(const AliEngineVideoEncoderConfiguration& config) = 0;

该方法用于设置视频流编码属性对应的视频参数，如分辨率、帧率、码率、视频方向等。有视频场景都建议调用此接口。

调用时机

该方法在入会前和入会后都可以调用。如果每次入会只需要设置一次相机流视频编码属性，建议在入会前调用。

调用限制

该方法的 mirrorMode 和 setVideoMirrorMode 均可设置视频推流镜像，建议只使用一种，同时使用多种会导致镜像效果叠加从而造成设置镜像失败或错乱。

参数说明

设置视频解码属性。该方法用于设置相机流视频解码属性，包含软硬解设置、是否启用 B 帧等。

virtual void SetVideoDecoderConfiguration(const AliEngineVideoDecoderConfiguration& config) = 0;

调用时机

推荐在入会拉流前调用。

参数说明

开始本地预览（会自动打开摄像头）。

virtual int StartPreview(int width = 0, int height = 0) = 0;

该接口用于开启本地视频预览并自动打开摄像头，如果需要停止本地预览，可以调用 StopPreview 接口。

调用时机

• 调用前需要通过 SetLocalViewConfig 为本地预览设置视图，否则无法预览，但不影响推流。

• 如有需要可以在 JoinChannel 加入频道前调用此接口开启预览，会自动开启摄像头。

返回说明

0表示方法调用成功，其他表示方法调用失败。

停止本地预览。

virtual int StopPreview() = 0;

该接口用于关闭本地视频预览并关闭摄像头，停止预览后本端将保持在最后一帧，不影响推流。

调用时机

开启预览后如果需要关闭预览则可以调用此方法。

返回说明

0表示方法调用成功，其他表示方法调用失败。

设置预览和推流镜像能力。

virtual int setVideoMirrorMode(AliEngineVideoPipelineMirrorMode mirrorMode) = 0;

设置本地预览视频和推送的视频流是否开启镜像模式。

调用时机

此接口在入会前和入会后均可以动态设置，SDK内部会记录状态，并在可以操作预览及编码（推流）的时候对视频进行操作。

调用限制

此接口与 SetLocalViewConfig&SetVideoEncoderConfiguration里面的mirrorMode 参数重合，建议仅使用本方法。

参数说明

返回说明

• 0：设置成功。

• <0：设置失败。

  • AliRtcErrInner: SDK内部状态错误，需检查是否创建SDK实例成功。

设置采集缩放时机，视频数据是采集的时候立即缩放还是编码时才进行缩放。

virtual void SetCapturePipelineScaleMode(const AliEngineCapturePipelineScaleMode mode) = 0;

设置视频数据采集缩放时机是采集的时候立即缩放还是编码时才进行缩放。例如当采集的分辨率与编码分辨率不一致时可以通过设置缩放的时机来决定预览数据与推流数据是否一致。

调用时机

此方法需要在打开摄像头之前进行设置，例如在 StartPreview 开始预览、JoinChannel 加入频道之前进行设置。

参数说明

获取摄像头列表。

virtual AliEngineDeviceInfoList* GetCameraList() = 0;

返回值

摄像头列表对象指针 AliEngineDeviceInfoList*。

获取当前使用的摄像头名称。

virtual String GetCurrentCameraName() = 0;

返回值

当前使用的摄像头设备名称。

获取当前使用的摄像头ID

virtual String GetCurrentCameraID() = 0;

返回值

当前使用的摄像头ID。

选择摄像头名称。

virtual int SetCurrentCameraName(const char* cameraName) = 0;

参数说明

返回值

0成功，其他失败。

选择摄像头ID。

virtual int SetCurrentCameraID(const char* cameraID) = 0;

参数说明

返回值

0成功，其他失败。

获取支持的分辨率。

virtual AliEngineVideoResolutionList * GetCurrentCameraSupportedResolutionList(int source) = 0 ;

参数说明

返回值

!=NULL 获取支持的分辨率列表，NULL失败。

启用外部视频输入源。

virtual int SetExternalVideoSource(bool enable,
        AliEngineVideoTrack type,
        AliEngineRenderMode renderMode) = 0;

参数说明

输入视频数据。

virtual int PushExternalVideoFrame(const AliEngineVideoRawData &frame,
        AliEngineVideoTrack type) = 0;

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

开启旁路直播。

virtual int StartPublishLiveStream(const String& streamURL, const AliEngineLiveTranscodingParam &transcoding) = 0;

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

更新旁路直播相关参数。

virtual int UpdatePublishLiveStream(const String& streamURL, const AliEngineLiveTranscodingParam &transcoding) = 0;

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

停止旁路直播。

virtual int StopPublishLiveStream(const String& streamURL) = 0;

参数说明

返回说明

0表示方法调用成功，其他表示方法调用失败。

获取旁路直播状态。

virtual AliEngineLiveTranscodingState GetPublishLiveStreamState(const String& streamURL) = 0;

参数说明

返回说明

返回旁路直播状态。

开始网络质量探测。本地网络的一些问题可能会导致音视频通话失败，通过调用此接口可以获取上下行网络的带宽、丢包率、抖动、链路 RTT 等信息，协助定位和解决相关网络问题。

 virtual int StartLastmileDetect(bool uplink, bool downlink, int uplinkBandWidth, int downlinkBandWidth) = 0;

调用时机

该接口需要在JoinChannel前调用，探测结果会通过回调给出。一次网络探测可能耗时较长，可按需调用StopLastmileDetect终止网络探测。

调用限制

SDK 在同一时刻只能执行一个网络探测，在上一次探测结束前重复调用会失效。

相关回调

成功调用该方法后，会触发两个回调：

• OnLastmileDetectResultWithQuality：约3s后会触发该回调，粗略的判断网络等级。

• OnLastmileDetectResultWithBandWidth： 约30s后会触发该回调，给出详细的探测结果。

参数说明

返回说明

• 0: 调用本方法成功。

• <0: 调用本方法失败，例如已经入会等。

停止网络质量探测。调用此接口可以停止网络质量探测。

virtual int StopLastmileDetect() = 0;

调用时机

需要在创建引擎后、入会前调用。

返回说明

• 0: 调用此接口成功。

• <0：调用此接口失败。

发送媒体扩展信息，内部使用SEI实现。

virtual int SendMediaExtensionMsg(const int8_t * message, uint32_t length, int32_t repeatCount, uint32_t delay, bool isKeyFrame) = 0;

SDK提供了发送和接收媒体扩展信息的功能，接收端参考 AliEngineEventListener::OnMediaExtensionMsgReceived。使用媒体扩展信息时需要复用音视频数据通道，因此必须控制自定义消息的发送频率和消息数据长度，使用限制如下：

• 每秒最多发送profile设置的fps条消息。

• 为了不影响媒体数据的传输质量，自定义消息体长度限制为4K Bytes，可以用来传输少量数据。

• sendMediaExtensionMsg函数中repeatCount参数为自定义消息冗余度，若大于1，则会发送多次，防止网络丢包导致的消息丢失，此时房间里的其他人也会收到多次相同的消息，需要去重。

• 发送的自定义消息，在旁路直播时，房间里的订阅者也一样会收到，设置为-1为永久发送data数据，除非重新设置sendMediaExtensionMsg。

• 同一时刻只有一个 sendMediaExtensionMsg 会被发送，意味着调用sendMediaExtensionMsg会覆盖上一次调用的sendMediaExtensionMsg，如果上次的调用没有发送或者没有发送完成。

参数说明

返回说明

• 0：成功。

• <0：失败，返回错误码。

  • ERR_INNER(-1): SDK内部错误，可能的情况为SDK未初始化或者SDK销毁后调用。

发送媒体扩展信息，内部使用SEI实现。

virtual int SendMediaExtensionMsgEx(const int8_t * message, uint32_t length, int32_t repeatCount, uint32_t delay, bool isKeyFrame, int32_t payloadType) = 0;

SDK提供了发送和接收媒体扩展信息的功能，接收端参考 AliEngineEventListener::OnMediaExtensionMsgReceived。使用媒体扩展信息时需要复用音视频数据通道，因此必须控制自定义消息的发送频率和消息数据长度，使用限制如下：

• 每秒最多发送profile设置的fps条消息；

• 为了不影响媒体数据的传输质量，自定义消息体长度限制为4K Bytes，可以用来传输少量数据；

• sendMediaExtensionMsg函数中repeatCount参数为自定义消息冗余度，若大于1，则会发送多次，防止网络丢包导致的消息丢失，此时房间里的其他人也会收到多次相同的消息，需要去重；

• 发送的自定义消息，在旁路直播时，房间里的订阅者也一样会收到，设置为-1为永久发送data数据，除非重新设置sendMediaExtensionMsg；

• 同一时刻只有一个 sendMediaExtensionMsg 会被发送，意味着调用sendMediaExtensionMsg会覆盖上一次调用的sendMediaExtensionMsg，如果上次的调用没有发送或者没有发送完成；

参数说明

返回说明

• 0：成功。

• <0：失败，返回错误码。

  • ERR_INNER(-1): SDK内部错误，可能的情况为SDK未初始化或者SDK销毁后调用。

网络连接状态改变的回调。

virtual void OnConnectionStatusChange(int status, int reason) {};

参数说明

本地设备异常回调；客户需要关心此回调。

virtual void OnLocalDeviceException(AliEngineLocalDeviceType deviceType, AliEngineLocalDeviceExceptionType exceptionType, const char* msg){};

参数说明

用户鉴权信息即将过期通知，收到后30秒鉴权过期;客户需要关心此回调。

virtual void OnAuthInfoWillExpire() {};

该回调表示用户的鉴权信息即将失效，收到此回调后 30 秒鉴权过期，你需要重新获取新的 Token，然后通过下列任意一种方式更新鉴权信息：

• 调用RefreshAuthInfo接口更新鉴权信息。

• 调用LeaveChannel离开当前频道，然后再调用JoinChannel重新加入频道。

触发时机

SDK 会在用户鉴权信息过期前 30s 触发此回调，收到该回调后应该及时更新鉴权信息。

用户调用需要鉴权的接口，服务端返回信息过期。

virtual void OnAuthInfoExpired() {};

该回调表示用户鉴权信息已过期，如果想继续在会中，需要在服务端生成新的 Token，然后通过下列方法更新鉴权信息：

• 调用LeaveChannel离开当前频道，然后再调用JoinChannel重新加入频道。

触发时机

当用户鉴权信息过期时会触发此回调。

加入频道结果回调（该回调等同于调用JoinChannel接口的block操作，即处理加入频道之后的事件，选择其一即可）。

virtual void OnJoinChannelResult(int result, const char *channel, const char *userId, int elapsed) {}

触发条件

当应用调用 JoinChannel方法时，该回调表示成功/失败加入频道，并且返回频道加入的相关信息以及加入频道耗时。

参数说明

离开频道结果回调。调用LeaveChannel接口后返回，如果调用后直接调用Destroy，将不会收到此回调。

virtual void OnLeaveChannelResult(int result, AliEngineStats stats) {}

触发条件

当应用成功调用LeaveChannel离会时会触发此回调返回离会的结果和本次频道会话的统计信息。

参数说明

远端用户下线时的回调。

virtual void OnRemoteUserOffLineNotify(const char *uid, AliEngineUserOfflineReason reason) {}

该回调用于通知本地用户，远端用户因各种原因离开频道。当远端用户离线，该接口将被触发。

触发条件

• 当远端用户角色主动离开频道时，触发回调。

• 当远端主播调用SetClientRole切换为观众角色（设置为 AliEngineClientRoleLive）时，触发回调。

• 当长时间未收到远端主播数据并认为其掉线时，触发回调。

参数说明

远端用户上线时的回调。

virtual void OnRemoteUserOnLineNotify(const char *uid, int elapsed) {}

该接口用于通知本地客户端远端用户加入频道。

触发条件

• 远端用户成功加入频道。

• 当前用户加入频道后，会收到频道中已有用户的加入回调，用于显示之前已加入的用户。

参数说明