AliRtcEngine接口

创建AliRtcEngine实例（单例模式）。

+ (instancetype _Nonnull )sharedInstance:(id<AliRtcEngineDelegate>_Nullable)delegate extras:(NSString *_Nullable)extras;

调用时机

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

调用限制

• 该方法为同步调用，只能在主线程中调用。

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

相关回调

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

异常发生原因	回调及参数	解决方案	说明
鉴权失败	onJoinChannelResult回调中的result返回AliRtcErrJoinBadToken	发生错误时App需要检查Token是否正确。	在用户主动调用API时，若鉴权失败，系统将在调用API的回调中返回鉴权失败的错误信息。
网络连接异常	onConnectionStatusChange回调返回AliRtcConnectionStatusFailed。	发生该异常时APP需要重新入会。	SDK具备一定时间断网自动恢复能力，但若断线时间超出预设阈值，会触发超时并断开连接。此时，App应检查网络状态并指导用户重新加入会议。
本地设备异常	onLocalDeviceException	发生该异常时App需要检测权限、设备硬件是否正常。	RTC服务支持设备检测和异常诊断的能力；当本地设备发生异常时，RTC服务会通过回调的方式通知客户本地设备异常，此时，若SDK无法自行解决问题，则App需要介入以查看设备是否正常。
被踢下线	onBye	AliRtcOnByeUserReplaced：当发生该异常时排查用户userid是否相同。 AliRtcOnByeBeKickedOut：当发生该异常时，表示被业务踢下线，需要重新入会。 AliRtcOnByeChannelTerminated：当发生该异常时，表示房间被销毁，需要重新入会。	RTC服务提供了管理员可以主动移除参与者的功能。
鉴权将要过期	onWillAuthInfoExpire	发生该异常时App需要重新获取最新的鉴权信息后，再调用refreshAuthInfo刷新鉴权信息。	鉴权过期错误在两种情况下出现：用户调用API或程序执行期间。因此，错误反馈将通过API回调或通过独立的错误回调通知。
鉴权过期	onAuthInfoExpired	发生该异常时App需要重新入会。	鉴权过期错误在两种情况下出现：用户调用API或程序执行期间。因此，错误反馈将通过API回调或通过独立的错误回调通知。

参数说明

名称	类型	描述
delegate	id<AliRtcEngineDelegate>_Nullable	监听回调的代理。
extras	NSString *_Nullable	用于接收来自客户灰度下发的参数，通过JSON配置SDK的特别功能，可以是空字符串。

销毁AliRtcEngine 实例。

+ (void)destroy;

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

该方法和destroy[2/2]均能销毁引擎实例，区别在于 destroy[2/2] 允许传入销毁完成的监测器对象。

调用时机

当音视频通信结束后（即不再需要使用 AliRtcEngine 功能时），建议调用此方法释放实例，减少不必要的资源占用。

调用限制

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

销毁AliRtcEngine实例。

+ (void)destroy:(id<AliRtcEngineDestroyDelegate>_Nullable)delegate;

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

调用时机

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

调用限制

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

参数说明

名称	类型	描述
delegate	AliRtcEngineDestroyDelegate	释放后回调对象

设置是否兼容H5。

+ (void)setH5CompatibleMode:(BOOL)comp;

参数说明

名称	类型	描述
comp	BOOL	YES表示兼容H5，NO表示不兼容H5。默认不兼容H5。

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

+ (BOOL)getH5CompatibleMode;

返回说明

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

获取SDK版本号。

+ (NSString *_Nonnull)getSdkVersion;

返回值

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

说明

该函数为静态方法，可以任意时候获取版本号。

设置频道模式。

- (int)setChannelProfile:(AliRtcChannelProfile)profile;

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

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

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

调用时机

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

参数说明

名称	类型	描述
profile	AliRtcChannelProfile	频道类型，RTC场景都建议设置为AliRtcChannelProfileInteractiveLive，即互动直播模式。

返回说明

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

设置音频Profile。

- (int)setAudioProfile:(AliRtcAudioProfile)audio_profile audio_scene:(AliRtcAudioScenario)audio_scene;

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

调用时机

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

参数说明

名称	类型	描述
audio_profile	AliRtcAudioProfile	音频采集或编码模式参数，建议使用高音质模式（AliRtcEngineHighQualityMode）。 说明 如果需要与 Web 互通，需要设置采样率为 48k。 AliRtcEngineLowQualityMode：音频低音质模式，默认8000Hz采样率，单声道，最大编码码率12kbps。 AliRtcEngineBasicQualityMode：标准音质模式，默认16000Hz采样率，单声道，最大编码码率24kbps。 AliRtcEngineHighQualityMode：默认48000Hz采样率，单声道，最大编码码率64kbps。 AliRtcEngineStereoHighQualityMode：立体声高音质模式，默认48000Hz采样率，双声道，最大编码码率80kbps。 AliRtcEngineSuperHighQualityMode：超高音质模式，默认48000Hz采样率，单声道，最大编码码率96kbps。 AliRtcEngineStereoSuperHighQualityMode：立体声超高音质模式，默认48000Hz采样率，双声道，最大编码码率128kbps。
audio_scene	AliRtcAudioScenario	音频场景模式参数，主要包含： AliRtcSceneMusicMode（建议设置）：音乐场景，使用软件 3A，从手机采集（音质更高）。 AliRtcSceneDefaultMode：使用硬件 3A，可以从蓝牙设备采集。 说明 ARTC SDK v6.21及之后的版本请不要设置为聊天室场景（AliRtcSceneChatroomMode）。

返回说明

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

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

- (BOOL)isAudioOnly;

返回说明

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

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

- (int)setAudioOnlyMode:(BOOL)audioOnly;

参数说明

名称	类型	描述
audioOnly	BOOL	YES表示只有音频推流和拉流。 NO表示音视频都支持，默认值为NO。

返回说明

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

加入频道（单参入会）。

- (int)joinChannel:(NSString *_Nonnull)token channelId:(NSString *_Nullable)channelId userId:(NSString *_Nullable)userId name:(NSString *_Nullable)userName onResultWithUserId:(void(^_Nullable)(NSInteger errCode, NSString * _Nonnull channel, NSString * _Nonnull userId, NSInteger elapsed))onResult;

该接口用于加入频道。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 不能互通。

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

相关回调

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

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

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

参数说明

参数	类型	描述
token	String	单参数入会的鉴权信息。
channelId	String	入会频道，必须和产生Token的值一样。
userId	String	入会的userid，必须和产生token的值一样。
userName	String	用户的显示名称（不是用户ID）。
onResultWithUserId	void(^_Nullable)(NSInteger errCode, NSString * _Nonnull channel, NSString * _Nonnull userId, NSInteger elapsed)	当此接口执行结束后调用此回调。

返回说明

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

加入频道（多参入会）。

- (int)joinChannel:(AliRtcAuthInfo *_Nonnull)authInfo name:(NSString *_Nullable)userName onResultWithUserId:(void(^_Nullable)(NSInteger errCode, NSString * _Nonnull channel, NSString * _Nonnull userId, NSInteger elapsed))onResult;

该接口用于加入频道。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回调。

参数说明

名称	类型	描述
authInfo	AliRtcAuthInfo	鉴权信息。
userName	String	用户的显示名称（不是用户ID）。
onResultWithUserId	void(^_Nullable)(NSInteger errCode, NSString * _Nonnull channel, NSString * _Nonnull userId, NSInteger elapsed)	当此接口执行结束后调用此回调。

加入频道。

- (int)joinChannel:(NSString *_Nonnull)token channelParam:(AliRtcChannelParam *_Nonnull)channelParam onResultWithUserId:(void(^_Nullable)(NSInteger errCode, NSString * _Nonnull channel, NSString * _Nonnull userId, NSInteger elapsed))onResult;

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

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

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

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

调用限制

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

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

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

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

相关回调

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

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

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

参数说明

名称	类型	描述
token	NSString*	认证信息，从App Server获取。
channelParam	AliRtcChannelParam	入会参数
onResultWithUserId	void(^_Nullable)(NSInteger errCode,NSString * _Nonnull channel,NSInteger elapsed)	当此接口执行结束后调用此回调。

离开频道。

- (int)leaveChannel;

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

调用时机

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

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

相关回调

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

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

返回说明

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

检查当前是否在频道中。

- (BOOL)isInCall;

返回说明

YES表示在频道中，NO表示不在频道中。

设置用户角色。

- (int)setClientRole:(AliRtcClientRole)role;

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

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

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

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

调用时机

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

调用限制

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

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

参数说明

名称	类型	描述
role	AliRtcClientRole	用户角色类型，默认值为AliRtcClientRolelive（观众角色），非通信模式下角色类型才有效。

返回说明

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

获取用户角色（仅iOS）。

- (AliRtcClientRole)getCurrentClientRole;

返回说明

返回当前用户角色。

刷新鉴权信息。

- (int)refreshAuthInfo:(AliRtcAuthInfo *_Nonnull)authInfo;

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

调用时机

在以下情况下：

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

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

参数说明

名称	类型	描述
authInfo	AliRtcAuthInfo *_Nonnull	鉴权信息。

返回说明

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

刷新鉴权信息。

- (int)refreshAuthInfoWithToken:(NSString *_Nonnull)token;

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

调用时机

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

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

参数说明

名称	类型	描述
token	NSString *_Nonnull	单参数入会的鉴权信息。

返回说明

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

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

- (int)publishLocalAudioStream:(BOOL)enable;

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

调用时机

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

相关回调

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

参数说明

名称	类型	描述
enable	boolean	YES表示发送本地音频流。 NO表示停止推流，默认YES。

返回说明

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

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

- (BOOL)isLocalAudioStreamPublished;

返回说明

YES表示允许推送，NO表示不允许推送。

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

- (int)setDefaultSubscribeAllRemoteAudioStreams:(BOOL)sub;

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

调用时机

加入频道前后均可调用。

• 加入频道前：

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

• 加入频道后：

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

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

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

参数说明

名称	类型	描述
sub	BOOL	YES表示接收用户的音频流。 NO表示停止接收用户的音频流，默认值为YES。

返回说明

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

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

- (int)subscribeRemoteAudioStream:(NSString *_Nonnull)uid sub:(BOOL)sub;

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

参数说明

名称	类型	描述
uid	NSString *_Nonnull	远端用户ID。
sub	BOOL	YES表示接收指定用户的音频流。 NO表示停止接收指定用户的音频流，默认值为YES。

返回说明

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

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

- (int)subscribeAllRemoteAudioStreams:(BOOL)sub;

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

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

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

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

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

参数说明

名称	类型	描述
sub	BOOL	YES表示接收所有用户的音频流。 NO表示停止接收所有用户的音频流，默认值为YES。

返回说明

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

设置是否允许发布相机流。

- (int)publishLocalVideoStream:(BOOL)enable;

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

调用时机

加入频道前后均可调用。

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

相关回调

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

参数说明

名称	类型	描述
enable	boolean	YES表示发送视频。 NO表示停止发送，默认YES。

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

- (BOOL)isLocalVideoStreamPublished;

返回说明

YES表示发布相机流，NO表示不发布相机流。

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

- (int)setDefaultSubscribeAllRemoteVideoStreams:(BOOL)sub;

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

调用时机

入会前后均可调用。

• 入会前：

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

• 入会后：

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

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

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

参数说明

名称	类型	描述
sub	boolean	YES表示接收用户的视频流。 NO表示不接收用户的视频流，默认值为YES。

返回说明

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

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

- (int)subscribeRemoteVideoStream:(NSString *_Nonnull)uid track:(AliRtcVideoTrack)track sub:(BOOL)sub;

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

调用时机

入会前后均可调用。

参数说明

名称	类型	描述
uid	NSString *	用户ID，从App server分配的唯一标示符。
track	AliRtcVideoTrack	视频流类型。
sub	BOOL	是否订阅。

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

- (int)subscribeAllRemoteVideoStreams:(BOOL)sub;

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

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

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

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

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

参数说明

名称	类型	描述
sub	BOOL	YES表示接收所有用户的视频流。 NO表示停止允许接收所有用户的视频流，默认值为YES。

返回说明

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

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

- (int)subscribeRemoteMediaStream:(NSString *_Nonnull)uid videoTrack:(AliRtcVideoTrack)videoTrack subVideo:(BOOL)subVideo subAudio:(BOOL)subAudio;

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

相关接口

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

注意：在该接口中 AliRtcVideoTrack 的AliRtcVideoTrackNo是无效的，设置不会有任何效果。

参数说明

参数	类型	描述
uid	String	远端用户ID。
videoTrack	AliRtcVideoTrack	视频流类型。
subVideo	boolean	停止或恢复特定远端用户的视频流拉取，取值： true（默认值）：恢复。 false：停止。
subAudio	boolean	停止或恢复特定远端用户的音频流拉取，取值： true（默认值）：恢复。 false：停止。

返回说明

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

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

- (int)subscribeRemoteMediaStream:(NSString *_Nonnull)uid videoTrack:(AliRtcVideoTrack)videoTrack audioTrack:(AliRtcAudioTrack)audioTrack;

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

相关接口

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

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

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

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

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

参数说明

参数	类型	描述
uid	NSString *	远端用户ID。
videoTrack	AliRtcVideoTrack	视频流类型。
audioTrack	AliRtcAudioTrack	音频流类型。

返回说明

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

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

- (int)subscribeRemoteDestChannelStream:(NSString *_Nonnull)channelId uid:(NSString *_Nonnull)uid track:(AliRtcVideoTrack)track subAudio:(BOOL)subAudio sub:(BOOL)sub;

参数说明

参数	类型	描述
channelId	String	远端频道ID。
uid	String	远端用户ID。
track	AliRtcVideoTrack	需要订阅的视频流。
sub_audio	boolean	停止或恢复特定远端用户的音频流拉取，取值： true（默认值）：恢复。 false：停止。
sub	boolean	停止或恢复跨频道订阅指定用户的流。

返回说明

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

订阅目标频道，所有用户的流

- (int)subscribeRemoteDestChannelAllStream:(NSString *_Nonnull)channelId track:(AliRtcVideoTrack)track subAudio:(BOOL)subAudio sub:(BOOL)sub;

参数说明

名称	类型	描述
channelId	NSString *	目标频道。
videotrack	AliRtcVideoTrack	视频流类型。
audioTrack	AliRtcAudioTrack	音频流类型。
subAudio	BOOL	是否订阅音频流。
sub	BOOL	是否订阅远端频道用户的视频流。

返回值

0 成功，其他失败。

设置远端音频的音量。

- (int)setRemoteAudioVolume:(NSString *_Nonnull)uid volume:(NSInteger)volume;

参数说明

名称	类型	描述
uid	NSString *	用户ID，从App server分配的唯一标示符。
volume	NSInteger	播放音量，取值范围[0,100] 0：静音；100：原始音量。

返回值

0成功，非0失败。

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

- (int)muteLocalMic:(BOOL)mute mode:(AliRtcMuteLocalAudioMode)mode;

调用时机

加入房间前后均可调用。

相关回调

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

参数说明

名称	类型	描述
mute	BOOL	YES表示本地音频发送空帧。 NO表示恢复正常，默认值为NO。
mode	AliRtcMuteLocalAudioMode	静音模式，默认静音全部。 AliRtcMuteAudioModeDefault：静音全部，包括麦克风和外部输入音频。 AliRtcMuteAllAudioMode：静音全部，包括麦克风和外部输入音频。 AliRtcMuteOnlyMicAudioMode：只静音麦克风。

返回说明

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

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

- (int)muteRemoteAudioPlaying:(NSString *_Nonnull)uid mute:(BOOL)mute;- (int)muteRemoteAudioPlaying:(NSString *_Nonnull)uid mute:(BOOL)mute;- (int)muteRemoteAudioPlaying:(NSString *_Nonnull)uid mute:(BOOL)mute;

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

调用时机

加入频道前后均可调用。

参数说明

名称	类型	描述
uid	NSString *_Nonnull	用户ID。
mute	BOOL	YES表示停止播放。 NO表示恢复播放，默认值为NO。

返回说明

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

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

- (int)muteAllRemoteAudioPlaying:(BOOL)mute;

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

调用时机

加入频道前后均可设置。

参数说明

名称	类型	描述
mute	BOOL	YES表示停止播放。 NO表示恢复播放，默认值为NO。

返回说明

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

开启音频采集。

- (void)startAudioCapture;

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

调用时机

入会前后均可调用。

相关接口

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

相关回调

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

返回说明

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

开启音频采集。

- (void)startAudioCapture:(BOOL)keepAlive;

静音后关闭麦克风采集。

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

调用时机

入会前后均可调用。

相关接口

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

相关回调

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

参数说明

参数	类型	描述
keepAlive	boolean	离会后采集设备的状态，取值： true：离会后采集设备保持开启状态。 false（默认值）：离会后采集设备关闭。

返回说明

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

关闭音频采集。

- (void)stopAudioCapture;

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

相关回调

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

返回说明

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

设置音频输出为听筒或扬声器（仅iOS）。

- (int)enableSpeakerphone:(BOOL)enable;

该接口用于在入会后设置当前播放的音频设备，在听筒和扬声器之间选择。如果没有设置该功能，将使用默认音频路由所设置的设备进行播放。

音频路由的优先级在 SDK 内部已经定义好，并会根据当前外设连接状态自动切换，优先级如下：有线耳机>蓝牙耳机>用户设置>默认设置，因此当连接外设时，该接口调用不生效。更多有关音频路由设置相关细节请参考音频路由设置。

调用时机

加入频道前后均可调用。

相关接口

setDefaultAudioRoutetoSpeakerphone用于修改默认音频路由设置，本接口用于设置当前路由设备。

参数说明

名称	类型	描述
enable	BOOL	YES表示扬声器模式。 NO表示听筒模式，默认为YES。

返回说明

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

获取当前音频输出为听筒或扬声器（仅iOS）。

- (BOOL)isEnableSpeakerphone;

返回说明

YES表示扬声器模式，NO表示听筒模式。

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

- (int)enableAudioVolumeIndication:(NSInteger)interval smooth:(NSInteger)smooth reportVad:(NSInteger)reportVad;

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

调用时机

加入频道前后均可调用。

相关回调

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

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

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

参数说明

名称	类型	描述
interval	NSInteger	时间间隔，单位为毫秒，最小值不得小于10ms，建议设置300~500ms，小于等于0表示不启用音量提示和说话人提示功能。
smooth	NSInteger	平滑系数，取值范围：[0,9]，数值越大平滑程度越高，反之越低，实时性越好，建议设置3。
reportVad	NSInteger	说话人检测开关，取值： 1：开启，通过onAudioVolumeCallback接口回调每一个说话人的状态。 0：关闭。

返回说明

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

启用耳返。

- (int)enableEarBack:(BOOL)enable;

该方法用于启用或关闭耳返功能。建议在戴耳机（有线或蓝牙均可）的情况下开启耳返，效果更好。

调用时机

加入频道前后均可调用。

参数说明

名称	类型	描述
enable	BOOL	YES表示启用耳返。 NO表示关闭耳返，默认值为NO。

返回说明

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

设置耳返音量。

- (int)setEarBackVolume:(NSInteger)volume;

该接口用于设置耳返的音量， 通过enableEarBack开启耳返功能后才生效。

调用时机

加入频道前后均可调用。

参数说明

名称	类型	描述
volume	NSInteger	取值范围：[0,100]，默认100。

返回说明

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

开启音频播放。

- (void)startAudioPlayer;

停止音频播放。

- (void)stopAudioPlayer;

设置播放音量。

- (int)setPlayoutVolume:(NSInteger)volume;

参数说明

名称	类型	描述
volume	音量	值域：[0..400] 其中 [0..100]是原始音量范围[100..400]是音量放大

返回值

0成功，其他失败。

设置录音音量

- (int)setRecordingVolume:(NSInteger)volume;

参数说明

名称	类型	描述
volume	NSInteger	值域：[0..400] [0..100]是原始音量[100..400]是音量放大

返回值

0成功，其他失败。

播放音频文件。

- (int)playAudioFileTest:(NSString *_Nonnull)filePath;

参数说明

参数	类型	描述
filePath	NSString *_Nonnull	播放文件路径

返回值

0成功，其他失败。

停止播放音频文件。

- (int)stopAudioFileTest;

返回值

0成功，其他失败。

通话前，开启音频采集设备检测。

- (void)startAudioCaptureTest;

停止通话前音频采集设备检测。

- (void)stopAudioCaptureTest;

设置默认音频输出是否从扬声器出声，默认从扬声器出声。

- (int)setDefaultAudioRouteToSpeakerphone:(BOOL)defaultToSpeakerphone;

该接口用于在入会前设置默认的音频路由设备，可选择默认输出到听筒或扬声器，SDK 内部默认为扬声器，如果您希望修改该默认配置可在入会前调用本接口。

音频路由的优先级在 SDK 内部已经定义好，并会根据当前外设连接状态自动切换，优先级如下：有线耳机>蓝牙耳机>用户设置>默认设置，因此如果没有连接外设且没有通过enableSpeakerphone进行设置，则会使用默认设置。

更多有关音频路由设置相关细节请参考音频路由设置。

手机设备一般有两个音频路由设备，分别是听筒和扬声器：

• 当音频路由为听筒时，声音比较小，只有将耳朵凑近才能听清楚，隐私性较好，适合用于接听电话。

• 当音频路由为扬声器时，声音比较大，不用将手机贴脸也能听清，因此可以实现“免提”的功能。

相关接口

该接口用于修改默认音频路由设置，enableSpeakerphone接口用于设置当前路由设备。

调用时机

入会前后均可调用。

参数说明

名称	类型	描述
defaultToSpeakerphone	BOOL	是否音频路由到扬声器，YES扬声器，NO听筒。

返回值

0 成功，其他失败。

设置变声音效模式。

- (int)setAudioEffectVoiceChangerMode:(AliRtcAudioEffectVoiceChangerMode)mode;

参数说明

名称	类型	描述
mode	AliRtcAudioEffectVoiceChangerMode	模式值，默认值为AliRtcSdk_AudioEffect_Voice_Changer_OFF。

返回说明

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

设置变调参数。

- (int)setAudioEffectPitchValue:(double)value;

参数说明

名称	类型	描述
value	double	取值范围：[0.5,2.0]，默认为1.0，表示音调不变。

返回说明

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

设置混响音效模式。

- (int)setAudioEffectReverbMode:(AliRtcAudioEffectReverbMode)mode;

参数说明

名称	类型	描述
mode	AliRtcAudioEffectReverbMode	音效模式，默认值为AliRtcAudioEffectReverb_Off。

返回说明

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

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

- (int)setAudioEffectReverbParamType:(AliRtcAudioEffectReverbParamType)type value:(float)value;

参数说明

名称	类型	描述
type	AliRtcAudioEffectReverbParamType	音效混响模式。
value	float	具体参数值。

返回说明

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

设置预设的美声音效模式。

- (int)setAudioEffectBeautifyMode:(AliRtcAudioEffectBeautifyMode)mode;

该接口用于设置 SDK 内部预设的一些美声模式，适用于语音直播、K歌、语音社交等对人声音质有美化需求的场景。通过选择不同的美声模式，可以改变人声的听感效果，如增强磁性、提升清晰度等，从而改善远端用户的收听体验。

调用时机

加入频道前后均可调用。

参数说明

参数	类型	描述
mode	AliRtcAudioEffectBeatifyMode	美声音效模式，详见枚举定义。

返回说明

• 0：设置成功

• 非 0：设置失败。

设置音频均衡器参数（EQ），调节指定频段的增益。

- (int)setAudioEffectEqualizationParam:(AliRtcAudioEffectEqualizationBandFrequency)bandIndex gain:(float)gain;

该接口用于对本地采集的人声或音频信号进行图形均衡器（Graphic Equalizer）调节，通过调整 10 个固定频段中某一频段的增益（单位：dB），实现音色定制化处理。适用于语音清晰度优化、人声突出、降噪辅助等场景。

均衡器支持从 31 Hz 到 16 kHz 的完整音频频谱调节，共 10 个标准频段，每个频段可独立设置增益值，范围为 [-15, 15] dB，默认为 0 dB（即无增强或衰减）。

调用限制

• 不支持在未开启美声模式前单独使用均衡器，必须在调用 setAudioEffectBeautifyMode 之后调用此接口。

参数说明

参数	类型	描述
bandIndex	AliRtcAudioEffectEqualizationBandFrequency	要调节的频段索引，对应中心频率（31Hz ~ 16kHz）中的某一段.
gain	float	增益值，单位为 dB，取值 [-15, 15] 。

返回说明

0：设置成功

非 0：设置失败。

增加外部音频流。

- (int)addExternalAudioStream:(AliRtcExternalAudioStreamConfig *_Nonnull)config;

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

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

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

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

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

参数说明

名称	类型	描述
config	AliRtcExternalAudioStreamConfig	外部音频流配置。

返回说明

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

输入外部音频流数据。

- (int)pushExternalAudioStream:(int)streamId rawData:(AliRtcAudioFrame * _Nonnull)audioFrame;

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

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

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

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

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

参数说明

名称	类型	描述
streamId	int	外部音频流Id。
audioFrame	AliRtcAudioFrame	音频数据。

返回说明

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

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

- (int)setExternalAudioStream:(int)streamId
                publishVolume:(int)publishVolume;

参数说明

名称	类型	描述
streamId	int	外部音频流Id。
publishVolume	int	推流音量。

返回说明

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

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

- (int)getExternalAudioStreamPublishVolume:(int)streamId;

参数说明

名称	类型	描述
streamId	int	外部音频流Id。

返回说明

[0, 100]: 推流音量,< 0: 失败。

设置外部音频流播放音量。

- (int)setExternalAudioStream:(int)streamId
                playoutVolume:(int)playoutVolume;

参数说明

名称	类型	描述
streamId	int	外部音频流Id。
playoutVolume	int	播放音量。

返回说明

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

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

- (int)getExternalAudioStreamPlayoutVolume:(int)streamId;

参数说明

名称	类型	描述
streamId	int	外部音频流Id。

返回说明

[0, 100]: 播放音量,< 0: 失败。

删除外部音频流。

- (int)removeExternalAudioStream:(int)streamId;

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

调用时机

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

参数说明

名称	类型	描述
streamId	int	外部音频流Id。

返回值

0成功，其他失败。

获取音频文件信息

- (int)getAudioFileInfo:(NSString *_Nonnull)filePath;

参数说明

名称	类型	描述
filePath	NSString *	文件路径。

开始伴奏混音。

- (int)startAudioAccompanyWithFile:(NSString *_Nonnull)filePath config:(AliRtcAudioAccompanyConfig *_Nonnull)config;

参数说明

名称	类型	描述
filePath	NSString *	文件路径。
config	AliRtcAudioAccompanyConfig *	伴奏的配置。

返回值

0成功，其他失败

停止伴奏混音。

- (int)stopAudioAccompany;

返回值

0成功，其他失败。

设置伴奏音量

- (int)setAudioAccompanyVolume:(NSInteger)volume;

参数说明

名称	类型	描述
volume	NSInteger	volume 伴奏音量，取值范围[0,100]。

返回值

0成功，其他失败；

设置伴奏推流音量。

- (int)setAudioAccompanyPublishVolume:(NSInteger)volume;

参数说明

名称	类型	描述
volume	NSInteger	volume 伴奏音量，取值范围[0,100]。

返回值

0成功，其他失败。

获取伴奏推流音量。

- (int)getAudioAccompanyPublishVolume;

返回值

[0, 100]成功，其他失败。

设置伴奏本地播放音量。

- (int)setAudioAccompanyPlayoutVolume:(NSInteger)volume;

参数说明

名称	类型	描述
volume	NSInteger	volume 伴奏音量，取值范围[0,100]。

返回值

0成功，其他失败。

获取伴奏本地播放音量

- (int)getAudioAccompanyPlayoutVolume;

返回值

[0, 100]: 成功，其他失败。

暂停伴奏混音。

- (int)pauseAudioAccompany;

返回值

0成功，其他失败。

继续伴奏混音。

- (int)resumeAudioAccompany;

返回值

0成功，其他失败。

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

- (int)getAudioAccompanyDuration;

返回值

>=0获取伴奏文件时长, 单位为毫秒；<0失败。

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

- (int)getAudioAccompanyCurrentPosition;

返回值

>=0: 伴奏文件播放进度；<0失败。

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

- (int)setAudioAccompanyPosition:(int)pos;

参数说明

名称	类型	描述
pos	int	pos 进度条位置，单位为毫秒。

返回值

0成功，其他失败。

预加载音效文件。

- (int)preloadAudioEffectWithSoundId:(NSInteger)soundId filePath:(NSString *_Nonnull)filePath;

参数说明

名称	类型	描述
soundId	NSInteger	用户给该音效文件分配的ID。
filePath	NSString *_Nonnull	音效文件路径。

返回说明

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

删除预加载的音效文件。

- (int)unloadAudioEffectWithSoundId:(NSInteger)soundId;

参数说明

名称	类型	描述
soundId	NSInteger	用户给该音效文件分配的ID。

返回说明

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

开始播放音效。

- (int)playAudioEffectWithSoundId:(NSInteger)soundId filePath:(NSString *_Nonnull)filePath cycles:(NSInteger)cycles publish:(BOOL)publish;

参数说明

名称	类型	描述
soundId	NSInteger	用户给该音效文件分配的ID。
filePath	NSString *_Nonnull	音效文件路径。
cycles	NSInteger	循环次数（可以设置-1或者正整数）。
publish	BOOL	是否发布。

返回说明

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

停止播放音效。

- (int)stopAudioEffectWithSoundId:(NSInteger)soundId;

参数说明

名称	类型	描述
soundId	NSInteger	用户给该音效文件分配的ID。

返回说明

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

停止播放所有音效。

- (int)stopAllAudioEffects;

返回说明

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

暂停音效。

- (int)pauseAudioEffectWithSoundId:(NSInteger)soundId;

参数说明

名称	类型	描述
soundId	NSInteger	用户给该音效文件分配的ID。

返回说明

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

暂停所有音效。

- (int)pauseAllAudioEffects;

返回说明

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

重新开始播放音效。

- (int)resumeAudioEffectWithSoundId:(NSInteger)soundId;

参数说明

名称	类型	描述
soundId	NSInteger	用户给该音效文件分配的ID。

返回说明

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

重新开始播放所有音效。

- (int)resumeAllAudioEffects;

返回说明

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

设置音效推流音量。

- (int)setAudioEffectPublishVolumeWithSoundId:(NSInteger)soundId volume:(NSInteger)volume;

参数说明

名称	类型	描述
soundId	NSInteger	用户给该音效文件分配的ID。
volume	NSInteger	混音音量，取值范围：[0,100]，默认值为50。

返回说明

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

获取推流音效音量。

- (int)getAudioEffectPublishVolumeWithSoundId:(NSInteger)soundId;

参数说明

名称	类型	描述
soundId	NSInteger	用户给该音效文件分配的ID。

返回说明

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

设置所有音效推流混音音量。

- (int)setAllAudioEffectsPublishVolume:(NSInteger)volume;

参数说明

名称	类型	描述
volume	NSInteger	混音音量，取值范围：[0,100]，默认值为50。

返回说明

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

设置音效本地播放音量。

- (int)setAaudioEffectPlayoutVolumeWithSoundId:(NSInteger)soundId volume:(NSInteger)volume;

参数说明

名称	类型	描述
soundId	NSInteger	用户给该音效文件分配的ID。
volume	NSInteger	混音音量，取值范围：[0,100]，默认值为50。

返回说明

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

获取音效本地播放音量。

- (int)getAudioEffectPlayoutVolumeWithSoundId:(NSInteger)soundId;

参数说明

名称	类型	描述
soundId	NSInteger	用户给该音效文件分配的ID。

返回说明

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

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

- (int)setAllAudioEffectsPlayoutVolume:(NSInteger)volume;

参数说明

名称	类型	描述
volume	NSInteger	混音音量，取值范围：[0,100]，默认值为50。

返回说明

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

开启媒体文件录制。

- (BOOL)startRecord:(AliRtcRecordType)recordType recordFormat:(AliRtcRecordFormat)recordFormat filePath:(NSString*)filePath audioConfig:(AliRtcRecordAudioConfig*)audioConfig videoConfig:(AliRtcRecordVideoConfig*)videoConfig;

参数说明

参数	类型	描述
recordType	AliRtcRecordType	录制类型。
recordFormat	AliRtcRecordFormat	录制格式。
filePath	NSString *	录制文件名和路径。
audioConfig	AliRtcRecordAudioConfig *	音频配置。
videoConfig	AliRtcRecordVideoConfig *	视频配置。

返回说明

TRUE成功，其他失败。

停止录制媒体文件。

- (void)stopRecord 

参数说明

无。

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

- (int)setLocalViewConfig:(AliVideoCanvas *_Nullable)viewConfig forTrack:(AliRtcVideoTrack)track;

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

调用时机

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

参数说明

名称	类型	描述
viewConfig	AliVideoCanvas *_Nullable	渲染参数，包含渲染窗口以及渲染方式。
track	AliRtcVideoTrack	视频Track的类型。

返回说明

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

设置摄像头采集偏好。

- (int)setCameraCapturerConfiguration:(AliRtcCameraCapturerConfiguration* _Nonnull)config;

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

调用时机

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

• startPreview（开始预览）

• joinChannel（加入频道）

参数说明

名称	类型	描述
config	AliRtcCameraCapturerConfiguration * _Nonnull	摄像头采集偏好，默认值： preference：0 cameraDirection：0 fps: 0 cameraCaptureProfile: 0 disableVideoCaptureReverse: -1 enableCameraMacroFocus: -1 captureObserverOriginal: -1 nativeBufferObserver: -1 captureCallbackCvpixelbufferToRaw: -1 以上-1表示使用SDK内部默认设置；

返回说明

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

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

- (int)enableLocalVideo:(BOOL)enable;

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

调用时机

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

相关回调

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

参数说明

名称	类型	描述
enable	BOOL	YES表示恢复正常，NO表示停止视频采集，默认YES。

返回说明

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

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

- (int)muteLocalCamera:(BOOL)mute forTrack:(AliRtcVideoTrack)track;

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

参数说明

名称	类型	描述
mute	BOOL	YES表示视频数据发送黑帧，NO表示恢复正常，默认值为NO。
track	AliRtcVideoTrack	需要改变发布状态的视频Track类型。

返回说明

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

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

- (int)setRemoteViewConfig:(AliVideoCanvas *_Nullable)canvas uid:(NSString *_Nonnull)uid forTrack:(AliRtcVideoTrack)track;

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

• 如果AliVideoCanvas：渲染画布。中的view参数为空，则停止渲染。

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

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

调用时机

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

参数说明

名称	类型	描述
canvas	AliVideoCanvas *_Nullable	渲染参数，包含渲染窗口以及渲染方式。
uid	NSString *_Nonnull	用户ID。
track	AliRtcVideoTrack	需要设置的视频Track类型。

返回说明

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

检查摄像头是否打开。

- (BOOL)isCameraOn;

返回说明

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

设置视频编码属性。

- (void)setVideoEncoderConfiguration:(AliRtcVideoEncoderConfiguration* _Nonnull)config;

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

调用时机

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

调用限制

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

参数说明

名称	类型	描述
config	AliRtcVideoEncoderConfiguration * _Nonnull	预定义的编码属性，默认值： dimensions：[640,480] frameRate：15 bitrate：0 mirrorMode：0 keyFrameInterval：关键帧间隔，单位为毫秒，默认为 0，表示由 SDK 内部控制。 forceStrictKeyFrameInterval：是否强制编码器严格按照设置的关键帧间隔产生关键帧。默认值false。 orientationMode：0 rotation：0 codecType：AliRtcVideoCodecTypeDefault encoderType:AliRtcVideoEncodeCodecTypeDefault seiForceFrontIFrame: -1 enableDynamicEncode: -1 disableDipenseResolutionChange: -1 enableDowngrade: -1 enableH264BFrame: -1 enableHevcBFrame: -1 backgroundHardwareToSoftware: -1 以上-1表示使用SDK内部默认设置；

设置视频解码属性。

- (void)setVideoDecoderConfiguration:(AliRtcVideoDecoderConfiguration* _Nonnull)config;

该方法用于设置相机流视频解码属性对应的视频参数。

调用时机

该方法建议在入会前调用。

参数说明

名称	类型	描述
config	AliRtcVideoDecoderConfiguration * _Nonnull	预定义的解码属性，默认值： codecType：AliRtcVideoCodecTypeDefault enableDecoderBframe：-1 backgroundHardwareToSoftware：-1 以上-1表示使用SDK内部默认设置；

切换前后摄像头，默认为前置摄像头（仅iOS）。

- (int)switchCamera;

此接口用于控制使用前置/后置摄像头，默认采用前置摄像头，可以在 App 运行期间根据可用摄像头实际情况来动态切换摄像头，而无需重启视频流或重新配置视频源。

调用时机

该方法必须在摄像头成功开启后调用。

调用限制

仅 Android 和 iOS 平台可用。

返回说明

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

获取当前摄像头方向，默认前置摄像头（仅iOS）。

- (AliRtcCameraDirection)getCurrentCameraDirection;

返回说明

返回camera方向枚举值。

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

- (int)startPreview;

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

调用时机

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

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

返回说明

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

停止本地预览。

- (int)stopPreview;

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

调用时机

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

返回说明

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

设置摄像头缩放。

 - (int)setCameraZoom:(float)zoom;

参数说明

名称	类型	描述
zoom	float	缩放级别，范围从 1 到 camera支持的最大 zoom值。

返回值

0 成功，其他失败。

获取摄像头最大缩放比例。

 - (float)GetCameraMaxZoomFactor;

返回值

摄像头最大缩放比例。

获取摄像头当前缩放比例。

- (float)GetCurrentZoom;

返回值

获取摄像头当前缩放比例。

设置摄像头曝光度。

- (int)SetExposure:(float)exposure;

参数说明

名称	类型	描述
exposure	float	曝光度

返回值

0 成功，其他失败。

获取摄像头曝光度。

- (float)GetCurrentExposure;

返回值

摄像头曝光度。

获取摄像头最小曝光度

- (float)GetMinExposure;

返回值

摄像头曝光最小曝光度。

获取摄像头最大曝光度。

- (float)GetMaxExposure;

返回值

摄像头曝光最大曝光度。

设置摄像头闪光灯开关。

- (int)setCameraFlash:(BOOL)flash;

参数说明

名称	类型	描述
flash	BOOL	是否允许开闪光灯。

返回值

0成功，其他失败。

摄像头是否支持手动聚焦。

- (BOOL)isCameraFocusPointSupported;

返回值

TRUE支持手动聚焦 FALSE不支持手动聚焦。

摄像头是否支持设置曝光点

- (BOOL)isCameraExposurePointSupported;

返回值

TRUE支持设置曝光点FALSE不支持设置曝光点。

设置摄像头手动聚焦点。

- (int)setCameraFocusPoint:(CGPoint)point;

参数说明

名称	类型	描述
point	CGPoint	设置的对焦点坐标，一直保持

返回值

0成功，其他失败。

设置曝光点曝光值。

- (int)setCameraExposurePoint:(CGPoint)point;

参数说明

名称	类型	描述
point	CGPoint	设置的对焦点坐标，一直保持。

返回值

0成功，其他失败。

摄像头是否支持人脸聚焦。

- (BOOL)isCameraAutoFocusFaceModeSupported;

返回值

TRUE 支持人脸聚焦 FALSE 不支持人脸聚焦。

设置摄像头人脸对焦。

- (BOOL)setCameraAutoFocusFaceModeEnabled:(BOOL)enable;

参数说明

名称	类型	描述
point	CGPoint	设置的对焦点坐标，一直保持。

返回值

TRUE 成功 FALSE 失败。

设置视频镜像模式。

- (int)setVideoMirrorMode:(AliRtcVideoPipelineMirrorMode)mirrorMode;

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

调用时机

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

调用限制

此接口与setLocalViewConfig&setVideoEncoderConfiguration里面的mirrorMode重合，建议仅使用本方法。

参数说明

名称	类型	描述
mirrorMode	AliRtcVideoPipelineMirrorMode	镜像类型。

设置视频链路缩放模式。

-(void)setCapturePipelineScaleMode:(AliRtcCapturePipelineScaleMode)mode;

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

调用时机

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

参数说明

名称	类型	描述
mode	AliRtcCapturePipelineScaleMode	缩放类型。

返回值

0成功，其他失败；

注册视频数据输出对象。

- (void)registerVideoFrameWithObserver:(id<AliRtcVideoFrameDelegate> _Nullable)observer;

该接口用于注册视频数据的输出对象。如果要取消注册，请调用unregisterVideoSampleWithObserver接口。

调用时机

如果你需要获取原始音频数据（如 YUV 或 RGBA 格式），可以调用此接口注册一个视频数据监测器来获取各阶段的视频数据。

相关回调

成功注册视频数据输出监测器后，SDK 会在捕捉到每个视频帧时，触发你实现的回调，请根据业务需要实现对应回调：

• onCaptureVideoSample：本地采集视频数据回调。

• onRemoteVideoSample：远端视频数据回调。

• onPreEncodeVideoSample：本地编码前视频数据回调。

参数说明

名称	类型	描述
observer	AliRtcVideoFrameDelegate	视频数据输出对象。

取消视频数据输出对象。

- (void)unregisterVideoSampleWithObserver:(id<AliRtcVideoFrameDelegate> _Nullable)observer;

此接口与registerVideoSampleObserver接口相对应，负责取消注册视频数据输出对象。

参数说明

名称	类型	描述
observer	AliRtcVideoFrameDelegate	视频数据输出对象。

注册本地相机流视频OpenGL纹理数据观测器。

- (void)registerLocalVideoTextureObserver:(id<AliRtcTextureDelegate> _Nullable)observer;

如果您想获取原始视频数据，请调用registerVideoSampleObserver接口注册相关回调；如果你希望获取内部纹理数据，请调用本接口。如果希望取消注册，请调用unRegisterLocalVideoTextureObserver接口。

相关回调

成功注册本地相机流视频OpenGL纹理数据观测器后，SDK 会在捕捉到每个视频帧时，触发你在 AliRtcTextureObserver 接口中实现的回调，请根据业务需要实现对应回调：

• onTextureCreate：该回调是在SDK内部OpenGL上下文创建的时候触发。

• onTextureUpdate：该回调会在每一帧视频数据上传到OpenGL纹理之后触发，当外部注册了OpenGL纹理数据观测器，在该回调中可以对纹理进行处理，并返回处理后的纹理ID。该回调返回值必须为有效的纹理ID，如果不做任何处理必须返回参数textureId

• onTextureDestroy：该回调是在SDK内部OpenGL上下文销毁的时候触发。

参数说明

名称	类型	描述
observer	AliRtcTextureDelegate	OpenGL纹理数据观测器。

取消注册本地相机流视频OpenGL纹理数据观测器。

- (void)unregisterLocalVideoTextureObserver:(id<AliRtcTextureDelegate> _Nullable)observer;

该接口与registerLocalVideoTextureObserver相对应，负责取消注册。

参数说明

名称	类型	描述
observer	AliRtcTextureDelegate	OpenGL纹理数据观测器。

视频截图功能。

- (int)snapshotVideo:(NSString*_Nullable)userId type:(AliRtcVideoTrack)type;

参数说明

名称	类型	描述
userId	NSString *	用户ID，userId 为nil或者为""代表本地用户。
type	AliRtcVideoTrack	视频流类型，只支持 {@link AliRtcVideoTrack::AliRtcVideoTrackCamera} 和 {@link AliRtcVideoTrack::AliRtcVideoTrackScreen}。

返回值

0成功，其他失败。

启用外部视频输入源。

- (int)setExternalVideoSource:(BOOL)enable sourceType:(AliRtcVideoSource)type renderMode:(AliRtcRenderMode)renderMode;

参数说明

名称	类型	描述
enable	BOOL	YES表示开启，NO表示关闭。
type	AliRtcVideoSource	流类型。
renderMode	AliRtcRenderMode	渲染模式。

输入视频数据。

- (int)pushExternalVideoFrame:(AliRtcVideoDataSample *_Nonnull)frame sourceType:(AliRtcVideoSource)type;

参数说明

名称	类型	描述
frame	AliRtcVideoDataSample *_Nonnull	帧数据。
type	AliRtcVideoSource	流类型。

返回说明

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

开启旁路直播。

- (int)startPublishLiveStreamWithURL:(NSString *_Nonnull)streamURL liveTranscoding:(AliRtcLiveTranscodingParam *_Nonnull)trancoding;

参数说明

名称	类型	描述
streamUrl	NSString *	推流地址。
transcoding	AliRtcLiveTranscodingParam *	推流所需参数。

返回说明

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

更新旁路直播相关参数。

- (int)updatePublishLiveStreamWithURL:(NSString *_Nonnull)streamURL liveTranscoding:(AliRtcLiveTranscodingParam *_Nonnull)trancoding;

参数说明

名称	类型	描述
streamUrl	NSString *	推流地址。
transcoding	AliRtcLiveTranscodingParam *	推流所需参数。

返回说明

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

停止旁路直播。

- (int)stopPublishLiveStreamWithURL:(NSString *_Nonnull)streamURL;

参数说明

名称	类型	描述
streamUrl	NSString *_Nonnull	推流地址。

返回说明

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

获取旁路直播状态。

- (AliRtcLiveTranscodingState)GetPublishLiveStreamStateWithURL:(NSString *_Nonnull)streamURL;

参数说明

参数	类型	说明
streamURL	NSString *	推流地址。

返回说明

返回旁路直播状态。

开启网络质量探测。

- (int)startLastmileDetect:(AliRtcNetworkQualityProbeConfig *_Nonnull)config;

参数说明

参数	类型	说明
config	AliRtcNetworkQualityProbeConfig	探测配置的参数。

返回说明

0表示成功，其他表示失败。

停止网络质量探测。

- (int)stopLastmileDetect;

返回说明

0表示成功，其他表示失败。

发送SEI信息。

- (int)sendMediaExtensionMsg:(NSData *_Nonnull)data repeatCount:(int)repeatCount delay:(int)delay isKeyFrame:(bool)isKeyFrame;

SDK提供了发送和接收媒体扩展信息的功能，当前方法实现了发送媒体扩展信息的功能，内部使用SEI扩展协议来实现。接收方可通过监听onMediaExtensionMsgReceived 获取信息。

常见使用场景包括：

• 使用媒体扩展信息传递时间戳，计算端到端的网络延迟，或者跟自身其他业务做数据同步

• 使用媒体扩展信息传递描述信息。目前可以传递最多 4k Byte数据，可以用来传输少量数据，建议使用JSON或者纯字符串

调用时机

在开始推流后调用。

调用限制

使用媒体扩展信息时需要复用音视频数据通道，因此必须控制自定义消息的发送频率和消息数据长度，使用限制如下：

• 每秒最多发送profile 中设置的 fps 条消息，因为sei信息是放到h264/h265流中传输，有视频帧编码才能附加扩展信息；

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

• sendMediaExtensionMsg函数中repeatCount参数为自定义消息冗余度，若大于1，则会发送多次，

• 防止网络丢包导致的消息丢失，此时房间里的其他人也会收到多次相同的消息，需要去重;

• 发送的自定义消息，在旁路直播时，房间里的订阅者也一样会收到

• 同一时间只有一条MediaExtensionMsg在传输，多次调用sendMediaExtensionMsg，新调用的数据会覆盖前一次的数据。

相关回调

当推流方发送了媒体扩展信息后，拉流方可通过监听onMediaExtensionMsgReceived 回调获取信息。

参数说明

名称	类型	描述
data	NSData *	扩展信息内容, 长度限制为最大4K 字节
repeatCount	int	重复次数，代表消息冗余度，用于防止网络丢包导致的消息丢失-1表示无限重发，除非再一次调用sendMediaExtensionMs
delay	int	延迟多少毫秒发送。用来延迟多少毫秒之后再发送SEI，因SEI是附在编码之后的h264/h265流，所以实际的延迟会比设置的延迟略大
isKeyFrame	bool	是否只给关键帧加SEI 设置为true，则只给关键帧加SEI信息

返回值

0成功，其他失败；

发送媒体扩展信息，底层使用SEI实现。

- (int)sendMediaExtensionMsgEx:(NSData *_Nonnull)data repeatCount:(int)repeatCount delay:(int)delay isKeyFrame:(bool)isKeyFrame payloadType:(int)payloadType;

SDK提供了发送和接收媒体扩展信息的功能，当前方法实现了发送媒体扩展信息的功能，内部使用SEI扩展协议来实现。接收方可通过监听onMediaExtensionMsgReceived 获取信息。当payloadType 为 5 时等于使用sendMediaExtensionMsg 接口。

常见使用场景包括：

• 使用媒体扩展信息传递时间戳，计算端到端的网络延迟，或者跟自身其他业务做数据同步

• 使用媒体扩展信息传递描述信息。目前可以传递最多 4k Byte数据，可以用来传输少量数据，建议使用JSON或者纯字符串

调用时机

在开始推流后调用。

调用限制

使用媒体扩展信息时需要复用音视频数据通道，因此必须控制自定义消息的发送频率和消息数据长度，使用限制如下：

• 每秒最多发送profile 中设置的 fps 条消息，因为sei信息是放到h264/h265流中传输，有视频帧编码才能附加扩展信息；

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

• sendMediaExtensionMsg函数中repeatCount参数为自定义消息冗余度，若大于1，则会发送多次，

• 防止网络丢包导致的消息丢失，此时房间里的其他人也会收到多次相同的消息，需要去重;

• 发送的自定义消息，在旁路直播时，房间里的订阅者也一样会收到

• 同一时间只有一条MediaExtensionMsg在传输，多次调用sendMediaExtensionMsg，新调用的数据会覆盖前一次的数据。

参数说明

名称	类型	描述
data	NSData *	扩展信息内容, 长度限制为最大4K 字节
repeatCount	int	重复次数，代表消息冗余度，用于防止网络丢包导致的消息丢失-1表示无限重发，除非再一次调用sendMediaExtensionMs
delay	int	延迟多少毫秒发送。用来延迟多少毫秒之后再发送SEI，因SEI是附在编码之后的h264/h265流，所以实际的延迟会比设置的延迟略大
isKeyFrame	bool	是否只给关键帧加SEI 设置为true，则只给关键帧加SEI信息
payloadType	int	类型，带UUID的请用5，范围是[5,100..254]

返回说明

• 0：调用成功。

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

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

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

- (void)onConnectionStatusChange:(AliRtcConnectionStatus)status reason:(AliRtcConnectionStatusChangeReason)reason;

参数说明

参数	类型	描述
status	AliRtcConnectionStatus	当前状态值。
reason	AliRtcConnectionStatusChangeReason	引起状态变化的具体原因。

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

- (void)onLocalDeviceException:(AliRtcLocalDeviceType)deviceType exceptionType:(AliRtcLocalDeviceExceptionType)exceptionType message:(NSString *_Nullable)msg;

参数说明

参数	类型	描述
deviceType	AliRtcLocalDeviceType	设备类型
exceptionType	AliRtcLocalDeviceExceptionType	设备异常类型
msg	NSString	异常时携带的信息

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

- (void)onAuthInfoWillExpire;

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

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

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

触发时机

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

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

- (void)onAuthInfoExpired;

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

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

触发时机

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

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

- (void)onJoinChannelResult:(int)result channel:(NSString *_Nonnull)channel elapsed:(int) elapsed;

触发条件

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

参数说明

参数	类型	描述
result	int	加入频道结果，成功返回0，失败返回错误码。
channel	NSString *_Nonnull	加入的频道ID。
elapsed	int	加入频道耗时。