ZegoExpressEngine

2026-03-13

ZegoExpressEngine

Declared in ZegoExpressEngine.h

Methods

createEngineWithProfile:eventHandler:

static

createEngineWithProfile:eventHandler:

+ (ZegoExpressEngine *)createEngineWithProfile:(ZegoEngineProfile *) profile eventHandler:(nullable id<ZegoEventHandler>) eventHandler;

Create ZegoExpressEngine singleton object and initialize SDK.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
profile	ZegoEngineProfile *	The basic configuration information is used to create the engine.
eventHandler	nullable id<ZegoEventHandler>	Event notification callback. [nil] means not receiving any callback notifications.It can also be managed later via [setEventHandler]. If [createEngine] is called repeatedly and the [destroyEngine] function is not called to destroy the engine before the second call, the eventHandler will not be updated.

Details

Create ZegoExpressEngine singleton object and initialize SDK.

When to call: The engine needs to be created before calling other functions.
Caution: The SDK only supports the creation of one instance of ZegoExpressEngine. If you need call [createEngine] multiple times, you need call [destroyEngine] before you call the next [createEngine]. Otherwise it will return the instance which created by [createEngine] you called last time.

Available since: 2.14.0
Restrictions: None.

Return

engine singleton instance.

destroyEngine:

static

destroyEngine:

+ (void)destroyEngine:(nullable ZegoDestroyCompletionCallback) callback;

Destroy the ZegoExpressEngine singleton object and deinitialize the SDK.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
callback	nullable ZegoDestroyCompletionCallback	Notification callback for destroy engine completion. Developers can listen to this callback to ensure that device hardware resources are released. If the developer only uses SDK to implement audio and video functions, this parameter can be passed [nil].

Details

Destroy the ZegoExpressEngine singleton object and deinitialize the SDK.

When to call: When the SDK is no longer used, the resources used by the SDK can be released through this interface
Caution: After using [createEngine] to create a singleton, if the singleton object has not been created or has been destroyed, you will not receive related callbacks when calling this function.

Available since: 1.1.0
Restrictions: None.

sharedEngine

static

sharedEngine

+ (ZegoExpressEngine *)sharedEngine;

Returns the singleton instance of ZegoExpressEngine.

Declared in ZegoExpressEngine.h

If the engine has not been created or has been destroyed, an unusable engine object will be returned.

When to call: After creating the engine, before destroying the engine.

Available since: 1.1.0
Restrictions: None.

Engine singleton instance

setEngineConfig:

static

setEngineConfig:

+ (void)setEngineConfig:(ZegoEngineConfig *) config;

Set advanced engine configuration.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
config	ZegoEngineConfig *	Advanced engine configuration

Details

Used to enable advanced functions.

When to call: Different configurations have different call timing requirements. For details, please consult ZEGO technical support.

Available since: 1.1.0
Restrictions: None.

setLogConfig:

static

setLogConfig:

+ (void)setLogConfig:(ZegoLogConfig *) config;

Set log configuration.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
config	ZegoLogConfig *	log configuration.

Details

If you need to customize the log file size and path, please call this function to complete the configuration.

When to call: It must be set before calling [createEngine] to take effect. If it is set after [createEngine], it will take effect at the next [createEngine] after [destroyEngine].
Caution: Once this interface is called, the method of setting log size and path via [setEngineConfig] will be invalid.Therefore, it is not recommended to use [setEngineConfig] to set the log size and path.

Available since: 2.3.0
Restrictions: None.

setLocalProxyConfig:enable:

static

setLocalProxyConfig:enable:

+ (void)setLocalProxyConfig:(NSArray<ZegoProxyInfo *> *) proxyList enable:(BOOL) enable;

Set local proxy config.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
proxyList	NSArray<ZegoProxyInfo >	proxy info.
enable	BOOL	enable proxy or not.

Details

If you need to use the local proxy feature, please call this function to complete the configuration.

When to call: Must be set before calling [createEngine] to take effect, otherwise it will fail.
Caution: None.

Available since: 3.1.0
Restrictions: After [createEngine], can not change the proxy.

setCloudProxyConfig:token:enable:

static

setCloudProxyConfig:token:enable:

+ (void)setCloudProxyConfig:(NSArray<ZegoProxyInfo *> *) proxyList token:(NSString *) token enable:(BOOL) enable;

Set cloud proxy config.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
proxyList	NSArray<ZegoProxyInfo >	proxy info.
token	NSString *	token. if use appsign auth, ignore.
enable	BOOL	enable proxy or not.

Details

If you need to use the cloud proxy feature, please call this function to complete the configuration.

When to call: Must be set before calling [createEngine] to take effect, otherwise it will fail.
Caution: None.

Available since: 3.1.0
Restrictions: After [createEngine], can not change the proxy.

setLicense:

static

setLicense:

+ (void)setLicense:(NSString *) license;

Set license auth.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
license	NSString *	license.

Details

This function needs to be called to complete the configuration when using License authentication charges.

When to call: Must be set before calling [createEngine] to take effect, otherwise it will fail.
Caution: None.

Available since: 3.5.0
Restrictions: Does not support midway changes.

setRoomMode:

static

setRoomMode:

+ (void)setRoomMode:(ZegoRoomMode) mode;

Set room mode.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
mode	ZegoRoomMode	Room mode. Description: Used to set the room mode. Use cases: If you need to enter multiple rooms at the same time for publish-play stream, please turn on the multi-room mode through this interface. Required: True. Default value: ZEGO_ROOM_MODE_SINGLE_ROOM.

Details

If you need to use the multi-room feature, please call this function to complete the configuration.

When to call: Must be set before calling [createEngine] to take effect, otherwise it will fail.
Caution: None.

Available since: 2.9.0
Restrictions: If you need to use the multi-room feature, please contact the instant technical support to configure the server support.

setGeoFence:area:

static

setGeoFence:area:

+ (void)setGeoFence:(ZegoGeoFenceType) type area:(NSArray<NSNumber *> *) area;

Set Geo Fence.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
type	ZegoGeoFenceType	Geo fence type. Description: Used to set the geo fence type.
area	NSArray<NSNumber >	Geo fence area. Description: Used to describe the range of geo fence.

Details

If you need to use the geo fence feature, please call this function to complete the configuration.

When to call: Must be set before calling [createEngine] to take effect, otherwise it will fail.
Caution: None.

Available since: 3.4.0
Restrictions: If you need to use the geo fence feature, please contact ZEGO Technical Support.

getVersion

static

getVersion

+ (NSString *)getVersion;

Gets the SDK's version number.

Declared in ZegoExpressEngine.h

If you encounter an abnormality during the running of the SDK, you can submit the problem, log and other information to the ZEGO technical staff to locate and troubleshoot. Developers can also collect current SDK version information through this API, which is convenient for App operation statistics and related issues.

When to call: Any time.
Caution: None.

Available since: 1.1.0
Restrictions: None.

SDK version.

setApiCalledCallback:

static

setApiCalledCallback:

+ (void)setApiCalledCallback:(nullable id<ZegoApiCalledEventHandler>) callback;

Set method execution result callback.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
callback	nullable id<ZegoApiCalledEventHandler>	Method execution result callback.

Details

Set the setting of the execution result of the calling method. After setting, you can get the detailed information of the result of each execution of the ZEGO SDK method.

When to call: Any time.
Caution: It is recommended that developers call this interface only when they need to obtain the call results of each interface. For example, when troubleshooting and tracing problems. Developers generally do not need to pay attention to this interface.

Available since: 2.3.0
Restrictions: None.

isFeatureSupported:

static

isFeatureSupported:

+ (BOOL)isFeatureSupported:(ZegoFeatureType) featureType;

Query whether the current SDK supports the specified feature.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
featureType	ZegoFeatureType	Type of feature to query.

Details

Since the SDK supports feature trimming, some features may be trimmed; you can use this function to quickly determine whether the current SDK supports the specified features, such as querying whether the media player feature is supported.

When to call: Any time.

Available since: 2.22.0

Return

Whether the specified feature is supported. true: supported; false: not supported.

submitLog

static

submitLog

+ (void)submitLog;

Uploads logs to the ZEGO server.

Declared in ZegoExpressEngine.h

By default, SDK creates and prints log files in the App's default directory. Each log file defaults to a maximum of 5MB. Three log files are written over and over in a circular fashion. When calling this function, SDK will auto package and upload the log files to the ZEGO server.

Use cases: Developers can provide a business “feedback” channel in the App. When users feedback problems, they can call this function to upload the local log information of SDK to help locate user problems.
When to call: None.
Caution: 1.After calling this interface to upload logs, if you call [destroyEngine] or exit the App too quickly, there may be a failure.It is recommended to wait a few seconds, and then call [destroyEngine] or exit the App after receiving the upload success callback. 2.It is supported to call before [createEngine]. If it had called [createEngine] before, the last appid will be used to upload the log, otherwise the log will not be uploaded until the next [createEngine].

Available since: 3.7.0
Restrictions: The frequency limit is once per minute.

createEngineWithAppID:appSign:isTestEnv:scenario:eventHandler:

static

createEngineWithAppID:appSign:isTestEnv:scenario:eventHandler:

deprecated

+ (ZegoExpressEngine *)createEngineWithAppID:(unsigned int) appID appSign:(NSString *) appSign isTestEnv:(BOOL) isTestEnv scenario:(ZegoScenario) scenario eventHandler:(nullable id<ZegoEventHandler>) eventHandler;

[Deprecated] Create ZegoExpressEngine singleton object and initialize SDK. Deprecated since 2.14.0, please use the method with the same name without [isTestEnv] parameter instead. Please refer to [Testing environment deprecation](https://docs.zegocloud.com/article/13315) for more details.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
appID	unsigned int	Application ID issued by ZEGO for developers, please apply from the ZEGO Admin Console https://console.zegocloud.com The value ranges from 0 to 4294967295.
appSign	NSString *	Application signature for each AppID, please apply from the ZEGO Admin Console. Application signature is a 64 character string. Each character has a range of '0' ~ '9', 'a' ~ 'z'. AppSign 2.17.0 and later allows null or no transmission. If the token is passed empty or not passed, the token must be entered in the [ZegoRoomConfig] parameter for authentication when the [loginRoom] interface is called to login to the room.
isTestEnv	BOOL	[Deprecated] For providing better and more standardized services, starting from 2021-11-16, ZEGO no longer classifies environments into production environments and testing environments. f you create your project in ZEGO Admin Console on/before 2021-11-16, refer to Testing environment deprecation to upgrade the SDK and adjust related codes.
scenario	ZegoScenario	The room scenario. the SDK will optimize the audio and video configuration for the specified scenario to achieve the best effect in this scenario. After specifying the scenario, you can call other APIs to adjusting the audio and video configuration. Differences between scenarios and how to choose a suitable scenario, please refer to https://docs.zegocloud.com/article/14940
eventHandler	nullable id<ZegoEventHandler>	Event notification callback. [nil] means not receiving any callback notifications.It can also be managed later via [setEventHandler]. If [createEngine] is called repeatedly and the [destroyEngine] function is not called to destroy the engine before the second call, the eventHandler will not be updated.

Details

Create ZegoExpressEngine singleton object and initialize SDK.

When to call: The engine needs to be created before calling other functions.
Caution: The SDK only supports the creation of one instance of ZegoExpressEngine. If you need call [createEngine] multiple times, you need call [destroyEngine] before you call the next [createEngine]. Otherwise it will return the instance which created by [createEngine] you called last time.

Restrictions: None.

Deprecated

Deprecated since 2.14.0, please use the method with the same name without [isTestEnv] parameter instead.

Return

Engine singleton instance.

setEventHandler:

- (void)setEventHandler:(nullable id<ZegoEventHandler>) eventHandler;

Sets up the event notification callbacks that need to be handled. If the eventHandler is set to [null], all the callbacks set previously will be cleared.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
eventHandler	nullable id<ZegoEventHandler>	Event notification callback. If the eventHandler is set to [nil], all the callbacks set previously will be cleared. Developers should monitor the corresponding callbacks according to their own business scenarios. The main callback functions of the SDK are here.

Details

Set up event notification callbacks, used to monitor callbacks such as engine status changes, room status changes, etc.

When to call: After [createEngine].
Caution: After calling this function or [createEngine] setting a callback, unless this function is called to clear the callback, setting a callback again will not take effect. After calling [destroyEngine], the event handler that has been set will be invalid and need to be reset after next calling of [createEngine].

Available since: 1.1.0
Restrictions: None.

setRoomScenario:

- (void)setRoomScenario:(ZegoScenario) scenario;

Set room scenario.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
scenario	ZegoScenario	Room scenario.

Details

You can set the scenario of the room, and the SDK will adopt different optimization strategies for different scenarios in order to obtain better effects; this function does exactly the same thing as the [scenario] parameter in the [profile] configuration of [createEngine].

Use cases: This function is suitable for apps in various audio and video business scenarios, such as 1v1 video call (or voice call) scenario and live show scenario; this function can be used to switch scenarios without destroying the engine through [destroyEngine].
When to call: Must be set before calling [loginRoom] AND after calling [createEngine].
Caution: 1. Users in the same room are recommended to use the same room scenario for best results. 2. Setting the scenario will affect the audio and video bit rate, frame rate, resolution, codec id, audio device mode, audio route type, traffic control, 3A, ear return and other audio and video configurations. If you have special needs, you can call various other APIs to set the above configuration after calling this API. 3. Calling this function will override the scenario specified on [createEngine] or the scenario set by the last call to this function. 4. Calling this function will overwrite the audio and video related configuration you set through APIs such as [setVideoConfig], [setAudioConfig], so it is recommended to set the scenario first and then adjust the audio and video configuration through other APIs.

Available since: 3.0.0
Restrictions: Once you log in to the room, you are no longer allowed to modify the room scenario. If you need to modify the scenario, you need to log out of the room first. If you log in to multiple rooms, you need to log out of all rooms before you can modify it.

uploadLog

- (void)uploadLog;

Uploads logs to the ZEGO server.

Declared in ZegoExpressEngine.h

Use cases: Developers can provide a business “feedback” channel in the App. When users feedback problems, they can call this function to upload the local log information of SDK to help locate user problems.
When to call: After [createEngine].
Caution: 1.After calling this interface to upload logs, if you call [destroyEngine] or exit the App too quickly, there may be a failure.It is recommended to wait a few seconds, and then call [destroyEngine] or exit the App after receiving the upload success callback. 2.If you want to call before [createEngine], use the [submitLog] interface.

Available since: 1.1.0
Restrictions: The frequency limit is once per minute.

uploadLog:

- (void)uploadLog:(nullable ZegoUploadLogResultCallback) callback;

Uploads logs to the ZEGO server, with callback.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
callback	nullable ZegoUploadLogResultCallback	Log upload result callback.

Details

Use cases: Developers can provide a business “feedback” channel in the App. When users feedback problems, they can call this function to upload the local log information of SDK to help locate user problems.
When to call: After [createEngine].
Caution: 1.After calling this interface to upload logs, if you call [destroyEngine] or exit the App too quickly, there may be a failure.It is recommended to wait a few seconds, and then call [destroyEngine] or exit the App after receiving the upload success callback. 2.If you want to call before [createEngine], use the [submitLog] interface.

Available since: 2.4.0
Restrictions: The frequency limit is once per minute.

enableDebugAssistant:

- (void)enableDebugAssistant:(BOOL) enable;

Enable the debug assistant. Note, do not enable this feature in the online version! Use only during development phase!

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	Whether to enable the debug assistant.

Details

After enabled, the SDK will print logs to the console, and will pop-up an alert (toast) UI message when there is a problem with calling other SDK functions.

Default value: This function is disabled by default.
When to call: This function can be called right after [createEngine].
Platform differences: The pop-up alert function only supports Android / iOS / macOS / Windows, and the console log function supports all platforms.
Caution: Be sure to confirm that this feature is turned off before the app is released to avoid pop-up UI alert when an error occurs in your release version's app. It is recommended to associate the [enable] parameter of this function with the DEBUG variable of the app, that is, only enable the debug assistant in the DEBUG environment.

Available since: 2.17.0
Restrictions: None.

callExperimentalAPI:

- (NSString *)callExperimentalAPI:(NSString *) params;

Call the experimental API.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
params	NSString *	Parameters in the format of a JSON string, please consult ZEGO technical support for details.

Details

ZEGO provides some technical previews or special customization functions in RTC business through this API. If you need to get the use of the function or the details, please consult ZEGO technical support.

When to call: After [createEngine].

Available since: 2.7.0

Return

Returns an argument in the format of a JSON string, please consult ZEGO technical support for details.

loginRoom:user:

- (void)loginRoom:(NSString *) roomID user:(ZegoUser *) user;

Logs in to a room. You must log in to a room before publishing or playing streams.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
roomID	NSString *	Room ID, a string of less 128 bytes in length. Caution: 1. room ID is defined by yourself. 2. Only support numbers, English characters and '~', '!', '@', '#', '$', '%', '^', '&', '*', '(', ')', '_', '+', '=', '-', '`', ';', '’', ',', '.', '<', '>', ''. 3. If you need to communicate with the Web SDK, please do not use '%'.
user	ZegoUser *	User object instance, configure userID, userName. Note that the userID needs to be globally unique with the same appID, otherwise the user who logs in later will kick out the user who logged in first.

Details

Use cases: In the same room, users can conduct live broadcast, audio and video calls, etc.
When to call /Trigger: This interface is called after [createEngine] initializes the SDK.
Caution: 1. Apps that use different appIDs cannot intercommunication with each other. 2. SDK supports startPlayingStream audio and video streams from different rooms under the same appID, that is, startPlayingStream audio and video streams across rooms. Since ZegoExpressEngine's room related callback notifications are based on the same room, when developers want to startPlayingStream streams across rooms, developers need to maintain related messages and signaling notifications by themselves. 3. It is strongly recommended that userID corresponds to the user ID of the business APP, that is, a userID and a real user are fixed and unique, and should not be passed to the SDK in a random userID. Because the unique and fixed userID allows ZEGO technicians to quickly locate online problems. 4. After the first login failure due to network reasons or the room is disconnected, the default time of SDK reconnection is 20min.
Privacy reminder: Please do not fill in sensitive user information in this interface, including but not limited to mobile phone number, ID number, passport number, real name, etc.
Related callbacks: 1. When the user starts to log in to the room, the room is successfully logged in, or the room fails to log in, the [onRoomStateChanged] (Not supported before 2.18.0, please use [onRoomStateUpdate]) callback will be triggered to notify the developer of the status of the current user connected to the room. 2. Different users who log in to the same room can get room related notifications in the same room (eg [onRoomUserUpdate], [onRoomStreamUpdate], etc.), and users in one room cannot receive room signaling notifications in another room. 3. If the network is temporarily interrupted due to network quality reasons, the SDK will automatically reconnect internally. You can get the current connection status of the local room by listening to the [onRoomStateChanged] (Not supported before 2.18.0, please use [onRoomStateUpdate]) callback method, and other users in the same room will receive [onRoomUserUpdate] callback notification. 4. Messages sent in one room (e.g. [setStreamExtraInfo], [sendBroadcastMessage], [sendBarrageMessage], [sendCustomCommand], etc.) cannot be received callback ((eg [onRoomStreamExtraInfoUpdate], [onIMRecvBroadcastMessage], [onIMRecvBarrageMessage], [onIMRecvCustomCommand], etc) in other rooms. Currently, SDK does not provide the ability to send messages across rooms. Developers can integrate the SDK of third-party IM to achieve.
Related APIs: 1. Users can call [logoutRoom] to log out. In the case that a user has successfully logged in and has not logged out, if the login interface is called again, the console will report an error and print the error code 1002001. 2. SDK supports multi-room login, please call [setRoomMode] function to select multi-room mode before engine initialization, and then call [loginRoom] to log in to multi-room. 3. Calling [destroyEngine] will also automatically log out.

Available since: 1.1.0
Restrictions: For restrictions on the use of this function, please refer to https://docs.zegocloud.com/article/7611 or contact ZEGO technical support.

loginRoom:user:config:

- (void)loginRoom:(NSString *) roomID user:(ZegoUser *) user config:(ZegoRoomConfig *) config;

Logs in to a room with advanced room configurations. You must log in to a room before publishing or playing streams.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
roomID	NSString *	Room ID, a string of less 128 bytes in length. Caution: 1. room ID is defined by yourself. 2. Only support numbers, English characters and '~', '!', '@', '#', '$', '%', '^', '&', '*', '(', ')', '_', '+', '=', '-', '`', ';', '’', ',', '.', '<', '>', ''. 3. If you need to communicate with the Web SDK, please do not use '%'.
user	ZegoUser *	User object instance, configure userID, userName. Note that the userID needs to be globally unique with the same appID, otherwise the user who logs in later will kick out the user who logged in first.
config	ZegoRoomConfig *	Advanced room configuration.

Details

If the room does not exist, [loginRoom] creates and logs in the room. SDK uses the 'room' to organize users. After users log in to a room, they can use interface such as push stream [startPublishingStream], pull stream [startPlayingStream], send and receive broadcast messages [sendBroadcastMessage], etc. To prevent the app from being impersonated by a malicious user, you can add authentication before logging in to the room, that is, the [token] parameter in the ZegoRoomConfig object passed in by the [config] parameter.

Use cases: In the same room, users can conduct live broadcast, audio and video calls, etc.
When to call /Trigger: This interface is called after [createEngine] initializes the SDK.
Caution: 1. Apps that use different appIDs cannot intercommunication with each other. 2. SDK supports startPlayingStream audio and video streams from different rooms under the same appID, that is, startPlayingStream audio and video streams across rooms. Since ZegoExpressEngine's room related callback notifications are based on the same room, when developers want to startPlayingStream streams across rooms, developers need to maintain related messages and signaling notifications by themselves. 3. It is strongly recommended that userID corresponds to the user ID of the business APP, that is, a userID and a real user are fixed and unique, and should not be passed to the SDK in a random userID. Because the unique and fixed userID allows ZEGO technicians to quickly locate online problems. 4. After the first login failure due to network reasons or the room is disconnected, the default time of SDK reconnection is 20min.
Privacy reminder: Please do not fill in sensitive user information in this interface, including but not limited to mobile phone number, ID number, passport number, real name, etc.
Related callbacks: 1. When the user starts to log in to the room, the room is successfully logged in, or the room fails to log in, the [onRoomStateChanged] (Not supported before 2.18.0, please use [onRoomStateUpdate]) callback will be triggered to notify the developer of the status of the current user connected to the room. 2. Different users who log in to the same room can get room related notifications in the same room (eg [onRoomUserUpdate], [onRoomStreamUpdate], etc.), and users in one room cannot receive room signaling notifications in another room. 3. If the network is temporarily interrupted due to network quality reasons, the SDK will automatically reconnect internally. You can get the current connection status of the local room by listening to the [onRoomStateChanged] (Not supported before 2.18.0, please use [onRoomStateUpdate]) callback method, and other users in the same room will receive [onRoomUserUpdate] callback notification. 4. Messages sent in one room (e.g. [setStreamExtraInfo], [sendBroadcastMessage], [sendBarrageMessage], [sendCustomCommand], etc.) cannot be received callback ((eg [onRoomStreamExtraInfoUpdate], [onIMRecvBroadcastMessage], [onIMRecvBarrageMessage], [onIMRecvCustomCommand], etc) in other rooms. Currently, SDK does not provide the ability to send messages across rooms. Developers can integrate the SDK of third-party IM to achieve.
Related APIs: 1. Users can call [logoutRoom] to log out. In the case that a user has successfully logged in and has not logged out, if the login interface is called again, the console will report an error and print the error code 1002001. 2. SDK supports multi-room login, please call [setRoomMode] function to select multi-room mode before engine initialization, and then call [loginRoom] to log in to multi-room. 3. Calling [destroyEngine] will also automatically log out.

Available since: 1.1.0
Restrictions: For restrictions on the use of this function, please refer to https://docs.zegocloud.com/article/7611 or contact ZEGO technical support.

loginRoom:user:config:callback:

- (void)loginRoom:(NSString *) roomID user:(ZegoUser *) user config:(ZegoRoomConfig *) config callback:(ZegoRoomLoginCallback) callback;

Log in to the room by configuring advanced properties, and return the login result through the callback parameter. You must log in to the room before pushing or pulling the stream.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
roomID	NSString *	Room ID, a string of less 128 bytes in length. Caution: 1. room ID is defined by yourself. 2. Only support numbers, English characters and '~', '!', '@', '#', '$', '%', '^', '&', '*', '(', ')', '_', '+', '=', '-', '`', ';', '’', ',', '.', '<', '>', ''. 3. If you need to communicate with the Web SDK, please do not use '%'.
user	ZegoUser *	User object instance, configure userID, userName. Note that the userID needs to be globally unique with the same appID, otherwise the user who logs in later will kick out the user who logged in first.
config	ZegoRoomConfig *	Advanced room configuration.
callback	ZegoRoomLoginCallback	The callback of this login result, if you need detailed room status, please pay attention to the [onRoomStateChanged] callback. Required: No. Default value: nil.Caution: If the connection is retried multiple times due to network problems, the retry status will not be thrown by this callback.

Details

Use cases: In the same room, users can conduct live broadcast, audio and video calls, etc.
When to call /Trigger: This interface is called after [createEngine] initializes the SDK.
Caution: 1. Apps that use different appIDs cannot intercommunication with each other. 2. SDK supports startPlayingStream audio and video streams from different rooms under the same appID, that is, startPlayingStream audio and video streams across rooms. Since ZegoExpressEngine's room related callback notifications are based on the same room, when developers want to startPlayingStream streams across rooms, developers need to maintain related messages and signaling notifications by themselves. 3. It is strongly recommended that userID corresponds to the user ID of the business APP, that is, a userID and a real user are fixed and unique, and should not be passed to the SDK in a random userID. Because the unique and fixed userID allows ZEGO technicians to quickly locate online problems. 4. After the first login failure due to network reasons or the room is disconnected, the default time of SDK reconnection is 20min.
Privacy reminder: Please do not fill in sensitive user information in this interface, including but not limited to mobile phone number, ID number, passport number, real name, etc.
Related callbacks: 1. When the user starts to log in to the room, the room is successfully logged in, or the room fails to log in, the [onRoomStateChanged] (Not supported before 2.18.0, please use [onRoomStateUpdate]) callback will be triggered to notify the developer of the status of the current user connected to the room. 2. Different users who log in to the same room can get room related notifications in the same room (eg [onRoomUserUpdate], [onRoomStreamUpdate], etc.), and users in one room cannot receive room signaling notifications in another room. 3. If the network is temporarily interrupted due to network quality reasons, the SDK will automatically reconnect internally. You can get the current connection status of the local room by listening to the [onRoomStateChanged] (Not supported before 2.18.0, please use [onRoomStateUpdate]) callback method, and other users in the same room will receive [onRoomUserUpdate] callback notification. 4. Messages sent in one room (e.g. [setStreamExtraInfo], [sendBroadcastMessage], [sendBarrageMessage], [sendCustomCommand], etc.) cannot be received callback ((eg [onRoomStreamExtraInfoUpdate], [onIMRecvBroadcastMessage], [onIMRecvBarrageMessage], [onIMRecvCustomCommand], etc) in other rooms. Currently, SDK does not provide the ability to send messages across rooms. Developers can integrate the SDK of third-party IM to achieve.
Related APIs: 1. Users can call [logoutRoom] to log out. In the case that a user has successfully logged in and has not logged out, if the login interface is called again, the console will report an error and print the error code 1002001. 2. SDK supports multi-room login, please call [setRoomMode] function to select multi-room mode before engine initialization, and then call [loginRoom] to log in to multi-room. 3. Calling [destroyEngine] will also automatically log out.

Available since: 2.18.0
Restrictions: For restrictions on the use of this function, please refer to https://docs.zegocloud.com/article/7611 or contact ZEGO technical support.

logoutRoom

- (void)logoutRoom;

Exit the room.

Declared in ZegoExpressEngine.h

This API will log out the current user has logged in the room, if user logs in more than one room, all the rooms will be logged out.

Use cases: In the same room, users can conduct live broadcast, audio and video calls, etc.
When to call /Trigger: After successfully logging in to the room, if the room is no longer used, the user can call the function [logoutRoom].
Caution: 1. Exiting the room will stop all publishing and playing streams for user, and inner audio and video engine will stop, and then SDK will auto stop local preview UI. If you want to keep the preview ability when switching rooms, please use the [switchRoom] method. 2. If the user is not logged in to the room, calling this function will also return success.
Related callbacks: After calling this function, you will receive [onRoomStateChanged] (Not supported before 2.18.0, please use [onRoomStateUpdate]) callback notification successfully exits the room, while other users in the same room will receive the [onRoomUserUpdate] callback notification(On the premise of enabling isUserStatusNotify configuration).
Related APIs: Users can use [loginRoom], [switchRoom] functions to log in or switch rooms.

Available since: 2.9.0
Restrictions: None.

logoutRoomWithCallback:

- (void)logoutRoomWithCallback:(ZegoRoomLogoutCallback) callback;

Exit the room with callback.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
callback	ZegoRoomLogoutCallback	The callback of this logout room result, if you need detailed room status, please pay attention to the [onRoomStateChanged] callback. Required: No. Default value: nil.

Details

This API will log out the current user has logged in the room, if user logs in more than one room, all the rooms will be logged out.

Use cases: In the same room, users can conduct live broadcast, audio and video calls, etc.
When to call /Trigger: After successfully logging in to the room, if the room is no longer used, the user can call the function [logoutRoom].
Caution: 1. Exiting the room will stop all publishing and playing streams for user, and inner audio and video engine will stop, and then SDK will auto stop local preview UI. If you want to keep the preview ability when switching rooms, please use the [switchRoom] method. 2. If the user is not logged in to the room, calling this function will also return success.
Related callbacks: After calling this function, you will receive [onRoomStateChanged] (Not supported before 2.18.0, please use [onRoomStateUpdate]) callback notification successfully exits the room, while other users in the same room will receive the [onRoomUserUpdate] callback notification(On the premise of enabling isUserStatusNotify configuration).
Related APIs: Users can use [loginRoom], [switchRoom] functions to log in or switch rooms.

Available since: 2.9.0
Restrictions: None.

logoutRoom:

- (void)logoutRoom:(NSString *) roomID;

Exit the room of the specified room ID.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
roomID	NSString *	Room ID, a string of up to 128 bytes in length. Caution: 1. Only support numbers, English characters and '~', '!', '@', '#', '$', '%', '^', '&', '*', '(', ')', '_', '+', '=', '-', '`', ';', '’', ',', '.', '<', '>', ''. 2. If you need to communicate with the Web SDK, please do not use '%'.

Details

This API will log out the room named roomID.

Use cases: In the same room, users can conduct live broadcast, audio and video calls, etc.
When to call /Trigger: After successfully logging in to the room, if the room is no longer used, the user can call the function [logoutRoom].
Caution: 1. Exiting the room will stop all publishing and playing streams for user, and inner audio and video engine will stop, and then SDK will auto stop local preview UI. If you want to keep the preview ability when switching rooms, please use the [switchRoom] method. 2. If the user logs out to the room, but the incoming 'roomID' is different from the logged-in room name, SDK will return failure.
Related callbacks: After calling this function, you will receive [onRoomStateChanged] (Not supported before 2.18.0, please use [onRoomStateUpdate]) callback notification successfully exits the room, while other users in the same room will receive the [onRoomUserUpdate] callback notification(On the premise of enabling isUserStatusNotify configuration).
Related APIs: Users can use [loginRoom], [switchRoom] functions to log in or switch rooms.

Available since: 1.1.0
Restrictions: None.

logoutRoomWithCallback:callback:

- (void)logoutRoomWithCallback:(NSString *) roomID callback:(ZegoRoomLogoutCallback) callback;

Exit the room of the specified room ID with callback.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
roomID	NSString *	Room ID, a string of up to 128 bytes in length. Caution: 1. Only support numbers, English characters and '~', '!', '@', '#', '$', '%', '^', '&', '*', '(', ')', '_', '+', '=', '-', '`', ';', '’', ',', '.', '<', '>', ''. 2. If you need to communicate with the Web SDK, please do not use '%'.
callback	ZegoRoomLogoutCallback	The callback of this logout room result, if you need detailed room status, please pay attention to the [onRoomStateChanged] callback. Required: No. Default value: nil.

Details

This API will log out the room named roomID.

Use cases: In the same room, users can conduct live broadcast, audio and video calls, etc.
When to call /Trigger: After successfully logging in to the room, if the room is no longer used, the user can call the function [logoutRoom].
Caution: 1. Exiting the room will stop all publishing and playing streams for user, and inner audio and video engine will stop, and then SDK will auto stop local preview UI. If you want to keep the preview ability when switching rooms, please use the [switchRoom] method. 2. If the user logs out to the room, but the incoming 'roomID' is different from the logged-in room name, SDK will return failure.
Related callbacks: After calling this function, you will receive [onRoomStateChanged] (Not supported before 2.18.0, please use [onRoomStateUpdate]) callback notification successfully exits the room, while other users in the same room will receive the [onRoomUserUpdate] callback notification(On the premise of enabling isUserStatusNotify configuration).
Related APIs: Users can use [loginRoom], [switchRoom] functions to log in or switch rooms.

Available since: 1.1.0
Restrictions: None.

switchRoom:toRoomID:

- (void)switchRoom:(NSString *) fromRoomID toRoomID:(NSString *) toRoomID;

Switch the room.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
fromRoomID	NSString *	Current roomID.
toRoomID	NSString *	The next roomID.

Details

Using this interface allows users to quickly switch from one room to another room.

Use cases: If you need to quickly switch to the next room, you can call this function.
When to call /Trigger: After successfully login room.
Caution: 1. When this function is called, all streams currently publishing or playing will stop (but the local preview will not stop). 2. Multi-room mode is supported in version 3.5.0 (use the function [setRoomMode] to set ZegoRoomMode to ZEGO_ROOM_MODE_MULTI_ROOM). 3. If a Token is passed in for login when logging into the room [loginRoom], the [switchroom] interface must be used with the config parameter and the corresponding Token value passed in when switching rooms.
Privacy reminder: Please do not fill in sensitive user information in this interface, including but not limited to mobile phone number, ID number, passport number, real name, etc.
Related callbacks: When the user call the [switchRoom] function, the [onRoomStateChanged] (Not supported before 2.18.0, please use [onRoomStateUpdate]) callback will be triggered to notify the developer of the status of the current user connected to the room.
Related APIs: Users can use the [logoutRoom] function to log out of the room.

Available since: 1.14.0
Restrictions: None.

switchRoom:toRoomID:config:

- (void)switchRoom:(NSString *) fromRoomID toRoomID:(NSString *) toRoomID config:(ZegoRoomConfig *) config;

Switch the room with advanced room configurations.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
fromRoomID	NSString *	Current roomID.
toRoomID	NSString *	The next roomID.
config	ZegoRoomConfig *	Advanced room configuration.

Details

Using this interface allows users to quickly switch from one room to another room.

Use cases: if you need to quickly switch to the next room, you can call this function.
When to call /Trigger: After successfully login room.
Caution: 1. When this function is called, all streams currently publishing or playing will stop (but the local preview will not stop). 2. To prevent the app from being impersonated by a malicious user, you can add authentication before logging in to the room, that is, the [token] parameter in the ZegoRoomConfig object passed in by the [config] parameter. This parameter configuration affects the room to be switched over. 3. Multi-room mode is supported in version 3.5.0 (use the function [setRoomMode] to set ZegoRoomMode to ZEGO_ROOM_MODE_MULTI_ROOM). 4. If a Token is passed in for login when logging into the room [loginRoom], the [switchroom] interface must be used with the config parameter and the corresponding Token value passed in when switching rooms.
Privacy reminder: Please do not fill in sensitive user information in this interface, including but not limited to mobile phone number, ID number, passport number, real name, etc.
Related callbacks: When the user call the [switchRoom] function, the [onRoomStateChanged] (Not supported before 2.18.0, please use [onRoomStateUpdate]) callback will be triggered to notify the developer of the status of the current user connected to the room.
Related APIs: Users can use the [logoutRoom] function to log out of the room.

Available since: 1.15.0
Restrictions: None.

renewToken:roomID:

- (void)renewToken:(NSString *) token roomID:(NSString *) roomID;

Renew token.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
token	NSString *	The token that needs to be renew.
roomID	NSString *	Room ID.

Details

After the developer receives [onRoomTokenWillExpire], they can use this API to update the token to ensure that the subsequent RTC functions are normal.

Use cases: Used when the token is about to expire.
When to call /Trigger: After the developer receives [onRoomTokenWillExpire].
Caution: The token contains important information such as the user's room permissions, publish stream permissions, and effective time, please refer to https://docs.zegocloud.com/article/11649.
Related callbacks: None.
Related APIs: None.

Available since: 2.8.0
Restrictions: None.

setRoomExtraInfo:forKey:roomID:callback:

- (void)setRoomExtraInfo:(NSString *) value key:(NSString *) forKey roomID:(NSString *) roomID callback:(nullable ZegoRoomSetRoomExtraInfoCallback) callback;

Set room extra information.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
value	NSString *	value if the extra info.
key	NSString *	key of the extra info.
roomID	NSString *	Room ID.
callback	nullable ZegoRoomSetRoomExtraInfoCallback	Callback for setting room extra information.

Details

The user can call this function to set the extra info of the room.

Use cases: You can set some room-related business attributes, such as whether someone is Co-hosting.
When to call /Trigger: After logging in the room successful.
Caution: For key and value restrictions, please refer to Restrictions. Newly set values will overwrite old ones.
Related callbacks: Other users in the same room will be notified through the [onRoomExtraInfoUpdate] callback function.
Related APIs: None.

Available since: 1.13.0
Restrictions: For restrictions on the use of this function, please refer to https://docs.zegocloud.com/article/7611 or contact ZEGO technical support.

getRoomStreamList:streamListType:

- (ZegoRoomStreamList *)getRoomStreamList:(NSString *) roomID streamListType:(ZegoRoomStreamListType) streamListType;

Get room stream list.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
roomID	NSString *	Room ID.
streamListType	ZegoRoomStreamListType	Get type

Details

Get room stream list.

Use cases: Get room stream list.
When to call /Trigger: After logging in the room successful.
Caution: This interface is to get a real-time internal stream list, which may be inaccurate when the room is disconnected from the service. Do not call this interface with high frequency.
Related APIs: None.

Available since: 3.12.0

Return

return stream list

startPublishingStream:

- (void)startPublishingStream:(NSString *) streamID;

Start publishing a stream.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
streamID	NSString *	Stream ID, a string of up to 256 characters. Caution: 1. Stream ID is defined by you. 2. needs to be globally unique within the entire AppID. If in the same AppID, different users publish each stream and the stream ID is the same, which will cause the user to publish the stream failure. You cannot include URL keywords, otherwise publishing stream and playing stream will fails. 3. Only support numbers, English characters and '-', '_'.

Details

Users push their local audio and video streams to the ZEGO RTC server or CDN, and other users in the same room can pull the audio and video streams to watch through the streamID or CDN pull stream address.

Use cases: It can be used to publish streams in real-time connecting wheat, live broadcast and other scenarios.
When to call: After [loginRoom].
Caution: 1. Before start to publish the stream, the user can choose to call [setVideoConfig] to set the relevant video parameters, and call [startPreview] to preview the video. 2. Other users in the same room can get the streamID by monitoring the [onRoomStreamUpdate] event callback after the local user publishing stream successfully. 3. In the case of poor network quality, user publish may be interrupted, and the SDK will attempt to reconnect. You can learn about the current state and error information of the stream published by monitoring the [onPublisherStateUpdate] event.

Available since: 1.1.0
Restrictions: None.

startPublishingStream:channel:

- (void)startPublishingStream:(NSString *) streamID channel:(ZegoPublishChannel) channel;

Starts publishing a stream (for the specified channel). You can call this function to publish a second stream.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
streamID	NSString *	Stream ID, a string of up to 256 characters. Caution: 1. Stream ID is defined by you. 2. needs to be globally unique within the entire AppID. If in the same AppID, different users publish each stream and the stream ID is the same, which will cause the user to publish the stream failure. You cannot include URL keywords, otherwise publishing stream and playing stream will fails. 3. Only support numbers, English characters and '-', '_'.
channel	ZegoPublishChannel	Publish stream channel.

Details

Use cases: It can be used to publish streams in real-time connecting wheat, live broadcast and other scenarios.
When to call: After [loginRoom].
Caution: 1. Before start to publish the stream, the user can choose to call [setVideoConfig] to set the relevant video parameters, and call [startPreview] to preview the video. 2. Other users in the same room can get the streamID by monitoring the [onRoomStreamUpdate] event callback after the local user publishing stream successfully. 3. In the case of poor network quality, user publish may be interrupted, and the SDK will attempt to reconnect. You can learn about the current state and error information of the stream published by monitoring the [onPublisherStateUpdate] event.

Available since: 1.1.0
Restrictions: None.

startPublishingStream:config:channel:

- (void)startPublishingStream:(NSString *) streamID config:(ZegoPublisherConfig *) config channel:(ZegoPublishChannel) channel;

Starts publishing a stream. Support multi-room mode.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
streamID	NSString *	Stream ID, a string of up to 256 characters. Caution: 1. Stream ID is defined by you. 2. needs to be globally unique within the entire AppID. If in the same AppID, different users publish each stream and the stream ID is the same, which will cause the user to publish the stream failure. You cannot include URL keywords, otherwise publishing stream and playing stream will fails. 3. Only support numbers, English characters and '-', '_'.
config	ZegoPublisherConfig *	Advanced publish configuration.
channel	ZegoPublishChannel	Publish stream channel.

Details

Use cases: It can be used to publish streams in real-time connecting wheat, live broadcast and other scenarios.
When to call: After [loginRoom].
Caution: 1. Before start to publish the stream, the user can choose to call [setVideoConfig] to set the relevant video parameters, and call [startPreview] to preview the video. 2. Other users in the same room can get the streamID by monitoring the [onRoomStreamUpdate] event callback after the local user publishing stream successfully. 3. In the case of poor network quality, user publish may be interrupted, and the SDK will attempt to reconnect. You can learn about the current state and error information of the stream published by monitoring the [onPublisherStateUpdate] event. 4. To call [SetRoomMode] function to select multiple rooms, the room ID must be specified explicitly.

Available since: 1.1.0
Restrictions: None.

startPublishingStreamInScene:channel:config:

- (void)startPublishingStreamInScene:(NSString *) streamID channel:(ZegoPublishChannel) channel config:(ZegoScenePublisherConfig *) config;

Starts publishing a stream in RangeScene scene.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
streamID	NSString *	Stream ID, a string of up to 256 characters. Caution: 1. Stream ID is defined by you. 2. needs to be globally unique within the entire AppID. If in the same AppID, different users publish each stream and the stream ID is the same, which will cause the user to publish the stream failure. You cannot include URL keywords, otherwise publishing stream and playing stream will fails. 3. Only support numbers, English characters and '-', '_'.
channel	ZegoPublishChannel	Publish stream channel.
config	ZegoScenePublisherConfig *	Advanced scene publish configuration.

Details

Users push their local audio and video streams to the ZEGO RTC server.

Use cases: Starts publishing a stream in RangeScene scene.
When to call: After [loginScene].
Caution: None.

Available since: 3.0.0
Restrictions: None.

stopPublishingStream

- (void)stopPublishingStream;

Stops publishing a stream.

Declared in ZegoExpressEngine.h

The user stops sending local audio and video streams, and other users in the room will receive a stream deletion notification.

Use cases: It can be used to stop publish streams in real-time connecting wheat, live broadcast and other scenarios.
When to call: After [startPublishingStream].
Caution: 1. After stopping the streaming, other users in the same room can receive the delete notification of the stream by listening to the [onRoomStreamUpdate] callback. 2. If the user has initiated publish flow, this function must be called to stop the publish of the current stream before publishing the new stream (new streamID), otherwise the new stream publish will return a failure. 3. After stopping streaming, the developer should stop the local preview based on whether the business situation requires it.

Available since: 1.1.0
Restrictions: None.

stopPublishingStream:

- (void)stopPublishingStream:(ZegoPublishChannel) channel;

Stops publishing a stream (for the specified channel).

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
channel	ZegoPublishChannel	Publish stream channel.

Details

The user stops sending local audio and video streams, and other users in the room will receive a stream deletion notification.

Use cases: It can be used to stop publish streams in real-time connecting wheat, live broadcast and other scenarios.
When to call: After [startPublishingStream].
Caution: 1. After stopping the streaming, other users in the same room can receive the delete notification of the stream by listening to the [onRoomStreamUpdate] callback. 2. If the user has initiated publish flow, this function must be called to stop the publish of the current stream before publishing the new stream (new streamID), otherwise the new stream publish will return a failure. 3. After stopping streaming, the developer should stop the local preview based on whether the business situation requires it.

Available since: 1.1.0
Restrictions: None.

setStreamExtraInfo:callback:

- (void)setStreamExtraInfo:(NSString *) extraInfo callback:(nullable ZegoPublisherSetStreamExtraInfoCallback) callback;

Sets the extra information of the stream being published.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
extraInfo	NSString *	Stream extra information, a string of up to 1024 characters.
callback	nullable ZegoPublisherSetStreamExtraInfoCallback	Set stream extra information execution result notification.

Details

Use this function to set the extra info of the stream. The stream extra information is an extra information identifier of the stream ID. Unlike the stream ID, which cannot be modified during the publishing process, the stream extra information can be modified midway through the stream corresponding to the stream ID. Developers can synchronize variable content related to stream IDs based on stream additional information.

When to call: After the engine is created [createEngine], Called before and after [startPublishingStream] can both take effect.
Caution: Act on the main publish channel ZegoPublishChannel.Main.
Related callbacks: Other users in the same room will be notified through the [onRoomStreamExtraInfoUpdate] callback function.

Available since: 1.1.0
Restrictions: None.

setStreamExtraInfo:channel:callback:

- (void)setStreamExtraInfo:(NSString *) extraInfo channel:(ZegoPublishChannel) channel callback:(nullable ZegoPublisherSetStreamExtraInfoCallback) callback;

Sets the extra information of the stream being published for the specified publish channel.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
extraInfo	NSString *	Stream extra information, a string of up to 1024 characters.
channel	ZegoPublishChannel	Publish stream channel.
callback	nullable ZegoPublisherSetStreamExtraInfoCallback	Set stream extra information execution result notification.

Details

When to call: After the engine is created [createEngine], Called before and after [startPublishingStream] can both take effect.
Related callbacks: Users can obtain the execution result of the function through [ZegoPublisherSetStreamExtraInfoCallback] callback.

Available since: 1.1.0
Restrictions: None.

startPreview:

- (void)startPreview:(ZegoCanvas *) canvas;

Starts/Updates the local video preview.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
canvas	ZegoCanvas *	The view used to display the preview image. If the view is set to nil, no preview will be made.

Details

The user can see his own local image by calling this function.

Use cases: It can be used for local preview in real-time connecting wheat, live broadcast and other scenarios.
When to call: After [createEngine].
Caution: 1. The preview function does not require you to log in to the room or publish the stream first. But after exiting the room, SDK internally actively stops previewing by default. 2. Local view and preview modes can be updated by calling this function again. The user can only preview on one view. If you call [startPreview] again to pass in a new view, the preview screen will only be displayed in the new view. 3. You can set the mirror mode of the preview by calling the [setVideoMirrorMode] function. The default preview setting is image mirrored. 4. When this function is called, the audio and video engine module inside SDK will start really, and it will start to try to collect audio and video.

Available since: 1.1.0
Restrictions: None.

startPreview:channel:

- (void)startPreview:(ZegoCanvas *) canvas channel:(ZegoPublishChannel) channel;

Starts/Updates the local video preview (for the specified channel).

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
canvas	ZegoCanvas *	The view used to display the preview image. If the view is set to nil, no preview will be made.
channel	ZegoPublishChannel	Publish stream channel

Details

The user can see his own local image by calling this function.

Use cases: It can be used for local preview in real-time connecting wheat, live broadcast and other scenarios.
When to call: After [createEngine].
Caution: 1. The preview function does not require you to log in to the room or publish the stream first. But after exiting the room, SDK internally actively stops previewing by default. 2. Local view and preview modes can be updated by calling this function again. The user can only preview on one view. If you call [startPreview] again to pass in a new view, the preview screen will only be displayed in the new view. 3. You can set the mirror mode of the preview by calling the [setVideoMirrorMode] function. The default preview setting is image mirrored. 4. When this function is called, the audio and video engine module inside SDK will start really, and it will start to try to collect audio and video.

Available since: 1.1.0
Restrictions: None.

startPreview

- (void)startPreview;

Starts the local audio preview.

Declared in ZegoExpressEngine.h

Call this function after creating the engine and before publishing/playing a stream, and then the engine will start to capture audio.

Use cases: Can check whether the audio equipment works ok by calling this function and by the soundlevel function of Engine.
When to call: After [createEngine].
Caution: 1. The preview function does not require you to log in to the room or publish the stream first. But after exiting the room, SDK internally actively stops previewing by default. 2. When this function is called, the audio engine module inside SDK will start, and it will start to try to collect audio.

Available since: 1.1.0
Restrictions: None.

stopPreview

- (void)stopPreview;

Stops the local preview.

Declared in ZegoExpressEngine.h

This function can be called to stop the preview when the preview is not needed locally.

Caution: Stopping the preview will not affect the publish stream and playing stream functions.

Available since: 1.1.0

stopPreview:

- (void)stopPreview:(ZegoPublishChannel) channel;

Stops the local preview (for the specified channel).

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
channel	ZegoPublishChannel	Publish stream channel

Details

This function can be called to stop the preview when the preview is not needed locally.

Caution: Stopping the preview will not affect the publish stream and playing stream functions.

Available since: 1.1.0

setVideoConfig:

- (void)setVideoConfig:(ZegoVideoConfig *) config;

Sets up the video configurations.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
config	ZegoVideoConfig *	Video configuration, the SDK provides a common setting combination of resolution, frame rate and bit rate, they also can be customized.

Details

Set the video frame rate, bit rate, video capture resolution, and video encoding output resolution.

Use cases: Recommended configuration in different business scenarios https://docs.zegocloud.com/article/12122.
Default value: The default video capture resolution is 360p, the video encoding output resolution is 360p, the bit rate is 600 kbps, and the frame rate is 15 fps.
When to call: After [createEngine].
Caution: Developers should note that the wide and high resolution of the mobile end is opposite to the wide and high resolution of the PC. For example, in the case of 360p, the resolution of the mobile end is 360x640, and the resolution of the PC end is 640x360.

Available since: 1.1.0
Restrictions: It is necessary to set the relevant video configuration before [startPreview], and only support the modification of the encoding resolution, the bit rate and the frame rate after [startPreview].

setVideoConfig:channel:

- (void)setVideoConfig:(ZegoVideoConfig *) config channel:(ZegoPublishChannel) channel;

Sets up the video configurations (for the specified channel).

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
config	ZegoVideoConfig *	Video configuration, the SDK provides a common setting combination of resolution, frame rate and bit rate, they also can be customized.
channel	ZegoPublishChannel	Publish stream channel.

Details

Set the video frame rate, bit rate, video capture resolution, and video encoding output resolution.

Default value: The default video capture resolution is 360p, the video encoding output resolution is 360p, the bit rate is 600 kbps, and the frame rate is 15 fps.
When to call: After [createEngine].
Caution: Developers should note that the wide and high resolution of the mobile end is opposite to the wide and high resolution of the PC. For example, in the case of 360p, the resolution of the mobile end is 360x640, and the resolution of the PC end is 640x360.

Available since: 1.1.0
Restrictions: It is necessary to set the relevant video configuration before [startPreview], and only support the modification of the encoding resolution, the bit rate and the frame rate after [startPreview].

getVideoConfig

- (ZegoVideoConfig *)getVideoConfig;

Gets the current video configurations.

Declared in ZegoExpressEngine.h

This function can be used to get the main publish channel's current video frame rate, bit rate, video capture resolution, and video encoding output resolution.

Video configuration object

getVideoConfig:

- (ZegoVideoConfig *)getVideoConfig:(ZegoPublishChannel) channel;

Gets the current video configurations (for the specified channel).

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
channel	ZegoPublishChannel	Publish stream channel

Details

This function can be used to get the specified publish channel's current video frame rate, bit rate, video capture resolution, and video encoding output resolution.

Return

Video configuration object

setPublishDualStreamConfig:channel:

- (void)setPublishDualStreamConfig:(NSArray<ZegoPublishDualStreamConfig *> *) configList channel:(ZegoPublishChannel) channel;

Set dual stream config.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
configList	NSArray<ZegoPublishDualStreamConfig >	config info.
channel	ZegoPublishChannel	ZegoPublishChannel.

Details

Set the stream config.

When to call: This must take effect when the codecID specified in the call to [ZegoExpressEngine > setVideoConfig] is ZegoVideoCodecIDH264DualStream after [createEngine] is called.
Caution: Width, height, resolution and bitrate are all greater than zero to take effect.

Available since: 3.7.0
Restrictions: To take effect, the parameters of flow and small flow must be specified at the same time. The resolution ratio of flow and small flow must be the same. For example, both are 4:3 .

setVideoMirrorMode:

- (void)setVideoMirrorMode:(ZegoVideoMirrorMode) mirrorMode;

Sets the video mirroring mode.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
mirrorMode	ZegoVideoMirrorMode	Mirror mode for previewing or publishing the stream.

Details

Set whether the local preview video and the published video have mirror mode enabled. For specific mirroring mode, please refer to https://docs.zegocloud.com/article/12122.

When to call: After [createEngine].

Available since: 1.1.0
Restrictions: This setting only works if the SDK is responsible for rendering.

setVideoMirrorMode:channel:

- (void)setVideoMirrorMode:(ZegoVideoMirrorMode) mirrorMode channel:(ZegoPublishChannel) channel;

Sets the video mirroring mode (for the specified channel).

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
mirrorMode	ZegoVideoMirrorMode	Mirror mode for previewing or publishing the stream.
channel	ZegoPublishChannel	Publish stream channel.

Details

Set whether the local preview video and the published video have mirror mode enabled. For specific mirroring mode.

When to call: After [createEngine].

Available since: 1.1.0
Restrictions: This setting only works if the SDK is responsible for rendering.

setAppOrientation:

- (void)setAppOrientation:(UIInterfaceOrientation) orientation;

Set the video orientation.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
orientation	UIInterfaceOrientation	Video orientation.

Details

Set the video orientation.

Use cases: When users use mobile devices to conduct live broadcasts or video calls, they can set different video directions according to the scene.
When to call: After [createEngine].

Available since: 1.1.0
Restrictions: None.

setAppOrientation:channel:

- (void)setAppOrientation:(UIInterfaceOrientation) orientation channel:(ZegoPublishChannel) channel;

Sets the video orientation (for the specified channel).

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
orientation	UIInterfaceOrientation	Video orientation.
channel	ZegoPublishChannel	Publish stream channel.

Details

Set the video orientation.

Use cases: When users use mobile devices to conduct live broadcasts or video calls, they can set different video directions according to the scene.
When to call: After [createEngine].

Available since: 1.1.0
Restrictions: Currently only supports iOS and Android platforms.

setAudioConfig:

- (void)setAudioConfig:(ZegoAudioConfig *) config;

Sets up the audio configurations.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
config	ZegoAudioConfig *	Audio config.

Details

You can set the combined value of the audio codec, bit rate, and audio channel through this function. If the preset value cannot meet the developer's scenario, the developer can set the parameters according to the business requirements.

Default value: The default audio config refers to the default value of [ZegoAudioConfig].
When to call: After the engine is created [createEngine], and before publishing [startPublishingStream].
Caution: Act on the main publish channel ZegoPublishChannel.Main.
Related APIs: [getAudioConfig].

Available since: 1.3.4
Restrictions: None.

setAudioConfig:channel:

- (void)setAudioConfig:(ZegoAudioConfig *) config channel:(ZegoPublishChannel) channel;

Sets up the audio configurations for the specified publish channel.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
config	ZegoAudioConfig *	Audio config.
channel	ZegoPublishChannel	Publish stream channel.

Details

Default value: The default audio config refers to the default value of [ZegoAudioConfig].
When to call: After the engine is created [createEngine], and before publishing [startPublishingStream].
Related APIs: [getAudioConfig].

Available since: 1.3.4
Restrictions: None.

getAudioConfig

- (ZegoAudioConfig *)getAudioConfig;

Gets the current audio configurations.

Declared in ZegoExpressEngine.h

You can get the current audio codec, bit rate, and audio channel through this function.

When to call: After the engine is created [createEngine].
Caution: Act on the main publish channel ZegoPublishChannel.Main.
Related APIs: [setAudioConfig].

Available since: 1.8.0
Restrictions: None.

Audio config.

getAudioConfig:

- (ZegoAudioConfig *)getAudioConfig:(ZegoPublishChannel) channel;

Gets the current audio configurations from the specified publish channel.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
channel	ZegoPublishChannel	Publish stream channel.

Details

You can get the current audio codec, bit rate, and audio channel through this function.

When to call: After the engine is created [createEngine].
Related APIs: [setAudioConfig].

Available since: 1.8.0
Restrictions: None.

Return

Audio config.

setPublishStreamEncryptionKey:

- (void)setPublishStreamEncryptionKey:(NSString *) key;

Set encryption key for the publishing stream.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
key	NSString *	The encryption key, note that the key length only supports 16/24/32 bytes.

Details

Support calling this function to update the encryption key while publishing stream.

When to call: After the engine is created [createEngine], Called before and after [startPublishingStream] can both take effect.
Caution: that developers need to update the player's decryption key before updating the publisher's encryption key. Act on the main publish channel ZegoPublishChannel.Main.
Related APIs: Calling [stopPublishingStream] or [logoutRoom] will clear the encryption key.

Available since: 1.19.0
Restrictions: This function is only valid when publishing stream to the Zego RTC server.

setPublishStreamEncryptionKey:channel:

- (void)setPublishStreamEncryptionKey:(NSString *) key channel:(ZegoPublishChannel) channel;

Set encryption key for the publishing stream for the specified publish channel.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
key	NSString *	The encryption key, note that the key length only supports 16/24/32 bytes.
channel	ZegoPublishChannel	Publish stream channel.

Details

Support calling this function to update the encryption key while publishing stream.

When to call: After the engine is created [createEngine], Called before and after [startPublishingStream] can both take effect.
Caution: that developers need to update the player's decryption key before updating the publisher's encryption key.
Related APIs: Calling [stopPublishingStream] or [logoutRoom] will clear the encryption key.

Available since: 1.19.0
Restrictions: This function is only valid when publishing stream to the Zego RTC server.

takePublishStreamSnapshot:

- (void)takePublishStreamSnapshot:(ZegoPublisherTakeSnapshotCallback) callback;

Take a snapshot of the publishing stream.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
callback	ZegoPublisherTakeSnapshotCallback	Results of take publish stream snapshot.

Details

Take a snapshot of the publishing stream.

When to call: Called this function after calling [startPublishingStream] or [startPreview].
Caution: The resolution of the snapshot is the encoding resolution set in [setVideoConfig]. If you need to change it to capture resolution, please call [setCapturePipelineScaleMode] to change the capture pipeline scale mode to [Post]. Act on the main publish channel ZegoPublishChannel.Main.
Related callbacks: The screenshot result will be called back through [ZegoPublisherTakeSnapshotCallback] (Windows HBITMAP; macOS/iOS CGImageRef; Linux QImage; Android Bitmap).
Related APIs: [takePlayStreamSnapshot].

Available since: 1.17.0
Restrictions: None.

takePublishStreamSnapshot:channel:

- (void)takePublishStreamSnapshot:(ZegoPublisherTakeSnapshotCallback) callback channel:(ZegoPublishChannel) channel;

Take a snapshot of the publishing stream for the specified publish channel.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
callback	ZegoPublisherTakeSnapshotCallback	Results of take publish stream snapshot.
channel	ZegoPublishChannel	Publish stream channel.

Details

Take a snapshot of the publishing stream.

When to call: Called this function after calling [startPublishingStream] or [startPreview].
Caution: The resolution of the snapshot is the encoding resolution set in [setVideoConfig]. If you need to change it to capture resolution, please call [setCapturePipelineScaleMode] to change the capture pipeline scale mode to [Post].
Related callbacks: The screenshot result will be called back through [ZegoPublisherTakeSnapshotCallback].
Related APIs: [takePlayStreamSnapshot].

Available since: 1.17.0
Restrictions: None.

takePublishStreamSnapshotByConfig:callback:channel:

- (void)takePublishStreamSnapshotByConfig:(ZegoPublisherTakeSnapshotConfig *) config callback:(ZegoPublisherTakeSnapshotCallback) callback channel:(ZegoPublishChannel) channel;

Take a snapshot of the publishing stream for the specified publish channel.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
config	ZegoPublisherTakeSnapshotConfig *	The config of snapshot
callback	ZegoPublisherTakeSnapshotCallback	Results of take publish stream snapshot.
channel	ZegoPublishChannel	Publish stream channel.

Details

Take a snapshot of the publishing stream.

When to call: Called this function after calling [startPublishingStream] or [startPreview].
Caution: The resolution of the snapshot is the encoding resolution set in [setVideoConfig]. If you need to change it to capture resolution, please call [setCapturePipelineScaleMode] to change the capture pipeline scale mode to [Post].
Related callbacks: The screenshot result will be called back through [ZegoPublisherTakeSnapshotCallback].
Related APIs: [takePlayStreamSnapshot].

Available since: 3.22.0
Restrictions: None.

mutePublishStreamAudio:

- (void)mutePublishStreamAudio:(BOOL) mute;

Stops or resumes sending the audio part of a stream.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
mute	BOOL	Whether to stop sending audio streams, true means not to send audio stream, and false means sending audio stream. The default is false.

Details

This function can be called when publishing the stream to realize not publishing the audio data stream. The SDK still collects and processes the audio, but send muted audio frame packets to the network. Use case: Users can call this interface when they do not want to publish any audio data. This interface does not affect [onBeforeAudioPrepAudioData].

When to call: Called after the engine is created [createEngine] can take effect.
Caution: Act on the main publish channel ZegoPublishChannel.Main.
Related callbacks: If you stop sending audio streams, the remote user that play stream of local user publishing stream can receive Mute status change notification by monitoring [onRemoteMicStateUpdate] callbacks.
Related APIs: [mutePublishStreamVideo].

Available since: 1.1.0
Restrictions: None.

mutePublishStreamAudio:channel:

- (void)mutePublishStreamAudio:(BOOL) mute channel:(ZegoPublishChannel) channel;

Stops or resumes sending the audio part of a stream for the specified channel.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
mute	BOOL	Whether to stop sending audio streams, true means not to send audio stream, and false means sending audio stream. The default is false.
channel	ZegoPublishChannel	Publish stream channel.

Details

When to call: Called after the engine is created [createEngine] can take effect.
Related callbacks: If you stop sending audio streams, the remote user that play stream of local user publishing stream can receive Mute status change notification by monitoring [onRemoteMicStateUpdate] callbacks.
Related APIs: [mutePublishStreamVideo].

Available since: 1.1.0
Restrictions: None.

mutePublishStreamVideo:

- (void)mutePublishStreamVideo:(BOOL) mute;

Stops or resumes sending the video part of a stream.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
mute	BOOL	Whether to stop sending video streams, true means not to send video stream, and false means sending video stream. The default is false.

Details

This function can be called when publishing the stream to realize not publishing the video stream. The local camera can still work normally, can capture, preview and process video images normally, but does not send the video data to the network.

When to call: Called after the engine is created [createEngine] can take effect.
Caution: Act on the main publish channel ZegoPublishChannel.Main.
Related callbacks: If you stop sending video streams locally, the remote user that play stream of local user publishing stream can receive Mute status change notification by monitoring [onRemoteCameraStateUpdate] callbacks.
Related APIs: [mutePublishStreamAudio].

Available since: 1.1.0
Restrictions: None.

mutePublishStreamVideo:channel:

- (void)mutePublishStreamVideo:(BOOL) mute channel:(ZegoPublishChannel) channel;

Stops or resumes sending the video part of a stream for the specified channel.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
mute	BOOL	Whether to stop sending video streams, true means not to send video stream, and false means sending video stream. The default is false.
channel	ZegoPublishChannel	Publish stream channel.

Details

When to call: Called after the engine is created [createEngine] can take effect.
Related callbacks: If you stop sending video streams locally, the remote user that play stream of local user publishing stream can receive Mute status change notification by monitoring [onRemoteCameraStateUpdate] callbacks.
Related APIs: [mutePublishStreamAudio].

Available since: 1.1.0
Restrictions: None.

setStreamAlignmentProperty:channel:

- (void)setStreamAlignmentProperty:(int) alignment channel:(ZegoPublishChannel) channel;

Enable or disable the stream precision alignment function.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
alignment	int	Whether to enable the stream mixing precision alignment function.
channel	ZegoPublishChannel	Publish stream channel

Details

Use this interface to enable stream alignment, the SDK will attach network time information to the stream when publishing it for accurate stream alignment. Use case: Generally used in scenarios such as KTV where stream mixing alignment is required.

When to call: After the engine is created [createEngine].
Caution: If you need to align each stream through network time when playing multiple streams or mixed streams, you need to call [startPublishingStream] to publish the stream and [forceSynchronousNetworkTime] in [ZegoPublisherConfig] is 1 to enable network time synchronization.
Related APIs: [startMixerTask], [startAutoMixerTask]

Available since: 2.11.0.

enableTrafficControl:property:

- (void)enableTrafficControl:(BOOL) enable property:(ZegoTrafficControlProperty) property;

Enables or disables traffic control.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	Whether to enable traffic control. The default is ture.
property	ZegoTrafficControlProperty	Adjustable property of traffic control, bitmask OR format. Should be one or the combinations of [ZegoTrafficControlProperty] enumeration. [AdaptiveFPS] as default.

Details

Enabling traffic control allows the SDK to adjust the audio and video streaming bitrate according to the current upstream network environment conditions, or according to the counterpart's downstream network environment conditions in a one-to-one interactive scenario, to ensure smooth results. At the same time, you can further specify the attributes of traffic control to adjust the corresponding control strategy.

Default value: Enable.
When to call: After the engine is created [createEngine], Called before [startPublishingStream] can take effect.
Caution: Act on the main publish channel ZegoPublishChannel.Main.

Available since: 1.5.0
Restrictions: Only support RTC publish.

enableTrafficControl:property:channel:

- (void)enableTrafficControl:(BOOL) enable property:(ZegoTrafficControlProperty) property channel:(ZegoPublishChannel) channel;

Enables or disables the traffic control for the specified publish channel.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	Whether to enable traffic control. The default is ture.
property	ZegoTrafficControlProperty	Adjustable property of traffic control, bitmask format. Should be one or the combinations of [ZegoTrafficControlProperty] enumeration. [AdaptiveFPS] as default.
channel	ZegoPublishChannel	Publish stream channel.

Details

Default value: Enable.
When to call: After the engine is created [createEngine], Called before [startPublishingStream] can take effect.

Available since: 1.5.0
Restrictions: Only support RTC publish.

setMinVideoBitrateForTrafficControl:mode:

- (void)setMinVideoBitrateForTrafficControl:(int) bitrate mode:(ZegoTrafficControlMinVideoBitrateMode) mode;

Set the minimum video bitrate threshold for traffic control.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
bitrate	int	Minimum video bitrate threshold for traffic control(kbps).
mode	ZegoTrafficControlMinVideoBitrateMode	Video sending mode below the minimum bitrate.

Details

Set the control strategy when the video bitrate reaches the lowest threshold during flow control. When the bitrate is lower than the minimum threshold, you can choose not to send video data or send it at a very low frame bitrate.

Default value: There is no control effect of the lowest threshold of video bitrate.
When to call: After the engine is created [createEngine], Called before [startPublishingStream] can take effect.
Caution: Act on the main publish channel ZegoPublishChannel.Main.
Related APIs: [enableTrafficControl].

Available since: 1.1.0
Restrictions: The traffic control must be turned on [enableTrafficControl].

setMinVideoBitrateForTrafficControl:mode:channel:

- (void)setMinVideoBitrateForTrafficControl:(int) bitrate mode:(ZegoTrafficControlMinVideoBitrateMode) mode channel:(ZegoPublishChannel) channel;

Sets the minimum video bitrate for traffic control for the specified publish channel.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
bitrate	int	Minimum video bitrate (kbps).
mode	ZegoTrafficControlMinVideoBitrateMode	Video sending mode below the minimum bitrate.
channel	ZegoPublishChannel	Publish stream channel.

Details

Default value: There is no control effect of the lowest threshold of video bitrate.
When to call: After the engine is created [createEngine], Called before [startPublishingStream] can take effect.
Related APIs: [enableTrafficControl].

Available since: 1.1.0
Restrictions: The traffic control must be turned on [enableTrafficControl].

setMinVideoFpsForTrafficControl:channel:

- (void)setMinVideoFpsForTrafficControl:(int) fps channel:(ZegoPublishChannel) channel;

Sets the minimum video frame rate threshold for traffic control.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
fps	int	The minimum video frame rate threshold for traffic control(fps).
channel	ZegoPublishChannel	Publish stream channel.

Details

When enabling traffic control [enableTrafficControl], and its parameter [property] includes the attribute AdaptiveFPS, the minimum frame rate of the video will not be lower than the value set by the [setMinVideoFpsForTrafficControl] interface. A value of 0 indicates no limit.

Default value: There is no control effect of the lowest threshold of video frame rate.
When to call: The call takes effect after the engine [createEngine] is created.
Related APIs: [enableTrafficControl].
Caution: If you need to cancel the limit of the setting value, you can set it to 0.

Available since: 2.17.0
Restrictions: The traffic control must be turned on [enableTrafficControl]. And its parameter [property] must contain AdaptiveFPS, Please refer to [ZegoTrafficControlProperty] for details.

setMinVideoResolutionForTrafficControl:height:channel:

- (void)setMinVideoResolutionForTrafficControl:(int) width height:(int) height channel:(ZegoPublishChannel) channel;

Sets the minimum video resolution threshold for traffic control.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
width	int	The flow controls the width of the lowest video resolution.
height	int	The flow controls the height of the lowest video resolution.
channel	ZegoPublishChannel	Publish stream channel.

Details

When enabling traffic control [enableTrafficControl], and its parameter [property] includes the attribute AdaptiveResolution, the minimum resolution of the video will not be lower than the value set by the [setMinVideoResolutionForTrafficControl] interface. A value of 0 indicates no limit.

Default value: There is no control effect of the lowest threshold of video resolution.
When to call: The call takes effect after the engine [createEngine] is created.
Related APIs: [enableTrafficControl].
Caution: If you need to cancel the limit of the setting value, you can set width and height to 0.

Available since: 2.17.0
Restrictions: The traffic control must be turned on [enableTrafficControl]. And its parameter [property] must contain AdaptiveResolution, Please refer to [ZegoTrafficControlProperty] for details.

setTrafficControlFocusOn:

- (void)setTrafficControlFocusOn:(ZegoTrafficControlFocusOnMode) mode;

Set the factors of concern that trigger traffic control.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
mode	ZegoTrafficControlFocusOnMode	When LOCAL_ONLY is selected, only the local network status is concerned. When choosing REMOTE, also take into account the remote network.

Details

Use this interface to control whether to start traffic control due to poor remote network conditions.

Default value: Default is ZegoTrafficControlFounsOnRemote.
When to call: After the engine is created [createEngine], Called before [startPublishingStream] can take effect.
Related APIs: [enableTrafficControl.

Available since: 2.4.0
Restrictions: The traffic control must be turned on [enableTrafficControl].

setTrafficControlFocusOn:channel:

- (void)setTrafficControlFocusOn:(ZegoTrafficControlFocusOnMode) mode channel:(ZegoPublishChannel) channel;

Set the factors of concern that trigger traffic control for the specified publish channel.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
mode	ZegoTrafficControlFocusOnMode	When LOCAL_ONLY is selected, only the local network status is concerned. When choosing REMOTE, also take into account the remote network.
channel	ZegoPublishChannel	Publish stream channel.

Details

Use this interface to control whether to start traffic control due to poor remote network conditions.

Default value: Default is disable.
When to call: After the engine is created [createEngine], Called before [startPublishingStream] can take effect.
Related APIs: [enableTrafficControl.

Available since: 2.4.0
Restrictions: The traffic control must be turned on [enableTrafficControl].

setCaptureVolume:

- (void)setCaptureVolume:(int) volume;

Sets the audio recording volume for stream publishing.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
volume	int	The volume gain percentage, the range is 0 ~ 200, and the default value is 100, which means 100% of the original collection volume of the device.

Details

This function is used to perform gain processing based on the device's collected volume. The local user can control the sound level of the audio stream sent to the remote end.

Default value: Default is 100.
When to call: After creating the engine [createEngine].
Related APIs: Set the playing stream volume [setPlayVolume].

Available since: 1.13.0
Restrictions: The capture volume can be dynamically set during publishing.

setAudioCaptureStereoMode:

- (void)setAudioCaptureStereoMode:(ZegoAudioCaptureStereoMode) mode;

Set audio capture stereo mode.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
mode	ZegoAudioCaptureStereoMode	Audio stereo capture mode.

Details

This function is used to set the audio capture channel mode. When the developer turns on the stereo capture, using a special stereo capture device, the stereo audio data can be captured and streamed.

Use cases: In some professional scenes, users are particularly sensitive to sound effects, such as voice radio and musical instrument performance. At this time, support for stereo and high-quality sound is required.
Default value: The default is None, which means mono capture.
When to call: It needs to be called after [createEngine]， before [startPublishingStream], [startPlayingStream], [startPreview], [createMediaPlayer], [createAudioEffectPlayer] and [createRealTimeSequentialDataManager].
Related APIs: When streaming, you need to enable the stereo audio encoding function through the [setAudioConfig] interface at the same time.

Available since: 1.15.0 (iOS/Android/Windows/OHOS); support macOS since 2.16.0
Restrictions: If you need to enable stereo capture, you also need to meet the following conditions: For iOS/Android, you need to connect an external audio device that supports stereo capture and be at the media volume. For macOS, it needs to be at the media volume. For Windows, an external audio device that supports stereo capture is required.

addPublishCdnUrl:streamID:callback:

- (void)addPublishCdnUrl:(NSString *) targetURL streamID:(NSString *) streamID callback:(nullable ZegoPublisherUpdateCdnUrlCallback) callback;

Adds a target CDN URL to which the stream will be relayed from ZEGO RTC server.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
targetURL	NSString *	CDN relay address, supported address format is rtmp, rtmps.
streamID	NSString *	Stream ID.
callback	nullable ZegoPublisherUpdateCdnUrlCallback	The execution result of update the relay CDN operation.

Details

Forward audio and video streams from ZEGO RTC servers to custom CDN content distribution networks with high latency but support for high concurrent pull streams.

Use cases: 1. It is often used in large-scale live broadcast scenes that do not have particularly high requirements for delay. 2. Since ZEGO RTC server itself can be configured to support CDN(content distribution networks), this function is mainly used by developers who have CDN content distribution services themselves. 3. This function supports dynamic relay to the CDN content distribution network, so developers can use this function as a disaster recovery solution for CDN content distribution services.
When to call: After calling the [createEngine] function to create the engine.
Caution: Removing URLs retweeted to CDN requires calling [removePublishCdnUrl], calling [stopPublishingStream] will not remove URLs publish to CDN.
Related APIs: Remove URLs that are re-pushed to the CDN [removePublishCdnUrl].

Available since: 1.1.0
Restrictions: When the [enablePublishDirectToCDN] function is set to true to publish the stream straight to the CDN, then calling this function will have no effect.

addPublishCdnUrl:streamID:timeout:callback:

- (void)addPublishCdnUrl:(NSString *) targetURL streamID:(NSString *) streamID timeout:(int) timeout callback:(nullable ZegoPublisherUpdateCdnUrlCallback) callback;

Adds a target CDN URL to which the stream will be relayed from ZEGO RTC server.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
targetURL	NSString *	CDN relay address, supported address format is rtmp, rtmps.
streamID	NSString *	Stream ID.
timeout	int	Timeout. Callback if it does not start in the time. Default is 0, which means no timeout. Valid range is [5, 600], in seconds. Less than 0 will be reset to 0, 1 to 4 will be reset to 5, and a greater than 600 will be reset to 600.
callback	nullable ZegoPublisherUpdateCdnUrlCallback	The execution result of update the relay CDN operation.

Details

Forward audio and video streams from ZEGO RTC servers to custom CDN content distribution networks with high latency but support for high concurrent pull streams.

Use cases: 1. It is often used in large-scale live broadcast scenes that do not have particularly high requirements for delay. 2. Since ZEGO RTC server itself can be configured to support CDN(content distribution networks), this function is mainly used by developers who have CDN content distribution services themselves. 3. This function supports dynamic relay to the CDN content distribution network, so developers can use this function as a disaster recovery solution for CDN content distribution services.
When to call: After calling the [createEngine] function to create the engine.
Caution: Removing URLs retweeted to CDN requires calling [removePublishCdnUrl], calling [stopPublishingStream] will not remove URLs publish to CDN.
Related APIs: Remove URLs that are re-pushed to the CDN [removePublishCdnUrl].

Available since: 1.1.0
Restrictions: When the [enablePublishDirectToCDN] function is set to true to publish the stream straight to the CDN, then calling this function will have no effect.

removePublishCdnUrl:streamID:callback:

- (void)removePublishCdnUrl:(NSString *) targetURL streamID:(NSString *) streamID callback:(nullable ZegoPublisherUpdateCdnUrlCallback) callback;

Deletes the specified CDN URL, which is used for relaying streams from ZEGO RTC server to CDN.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
targetURL	NSString *	CDN relay address, supported address format rtmp.
streamID	NSString *	Stream ID.
callback	nullable ZegoPublisherUpdateCdnUrlCallback	The execution result of update the relay CDN operation.

Details

When a CDN forwarding address has been added via [addPublishCdnUrl], this function is called when the stream needs to be stopped.

When to call: After calling the [createEngine] function to create the engine, When you don't need to continue publish to the CDN.
Caution: This function does not stop publishing audio and video stream to the ZEGO ZEGO RTC server.
Related APIs: Add URLs that are re-pushed to the CDN [addPublishCdnUrl].

Available since: 1.1.0
Restrictions: When the [enablePublishDirectToCDN] function is set to true to publish the stream straight to the CDN, then calling this function will have no effect.

enablePublishDirectToCDN:config:

- (void)enablePublishDirectToCDN:(BOOL) enable config:(ZegoCDNConfig *) config;

Whether to directly push to CDN (without going through the ZEGO RTC server).

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	Whether to enable direct publish CDN, true: enable direct publish CDN, false: disable direct publish CDN.
config	ZegoCDNConfig *	CDN configuration, if nil, use Zego's background default configuration.

Details

Whether to publish streams directly from the client to CDN without passing through Zego RTC server.

Use cases: It is often used in large-scale live broadcast scenes that do not have particularly high requirements for delay.
Default value: The default is false, and direct push is not enabled.
When to call: After creating the engine [createEngine], before starting to push the stream [startPublishingStream].
Caution: The Direct Push CDN feature does not pass through the ZEGO Real-Time Audio and Video Cloud during network transmission, so you cannot use ZEGO's ultra-low latency audio and video services.
Related APIs: Dynamic re-push to CDN function [addPublishCdnUrl], [removePublishCdnUrl].

Available since: 1.5.0

enablePublishDirectToCDN:config:channel:

- (void)enablePublishDirectToCDN:(BOOL) enable config:(ZegoCDNConfig *) config channel:(ZegoPublishChannel) channel;

Whether to directly push to CDN (without going through the ZEGO RTC server), for the specified channel.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	Whether to enable direct publish CDN, true: enable direct publish CDN, false: disable direct publish CDN.
config	ZegoCDNConfig *	CDN configuration, if nil, use Zego's background default configuration.
channel	ZegoPublishChannel	Publish stream channel.

Details

Whether to publish streams directly from the client to CDN without passing through Zego RTC server.

Use cases: It is often used in large-scale live broadcast scenes that do not have particularly high requirements for delay.
Default value: The default is false, and direct push is not enabled.
When to call: After creating the engine [createEngine], before starting to push the stream [startPublishingStream].
Caution: The Direct Push CDN feature does not pass through the ZEGO Real-Time Audio and Video Cloud during network transmission, so you cannot use ZEGO's ultra-low latency audio and video services.
Related APIs: Dynamic re-push to CDN function [addPublishCdnUrl], [removePublishCdnUrl].

Available since: 1.5.0

setPublishWatermark:isPreviewVisible:

- (void)setPublishWatermark:(ZegoWatermark *) watermark isPreviewVisible:(BOOL) isPreviewVisible;

Sets up the stream watermark before stream publishing.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
watermark	ZegoWatermark *	The upper left corner of the watermark layout is the origin of the coordinate system, and the area cannot exceed the size set by the encoding resolution. If it is nil, the watermark is cancelled.
isPreviewVisible	BOOL	Whether the watermark can be seen in the local preview.

Details

Set watermark for publish stream screen.

Use cases: It is often used to identify the source of the publish.
When to call: After creating the engine through [createEngine] function.
Caution: The layout of the watermark cannot exceed the video encoding resolution of the stream. It can be set at any time before or during the publishing stream.

Available since: 1.1.0

setPublishWatermark:isPreviewVisible:channel:

- (void)setPublishWatermark:(ZegoWatermark *) watermark isPreviewVisible:(BOOL) isPreviewVisible channel:(ZegoPublishChannel) channel;

Sets up the stream watermark before stream publishing (for the specified channel).

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
watermark	ZegoWatermark *	The upper left corner of the watermark layout is the origin of the coordinate system, and the area cannot exceed the size set by the encoding resolution. If it is nil, the watermark is cancelled.
isPreviewVisible	BOOL	the watermark is visible on local preview
channel	ZegoPublishChannel	Publish stream channel.

Details

Set watermark for publish stream screen.

Use cases: It is often used to identify the source of the publish.
When to call: After creating the engine through [createEngine] function.
Caution: The layout of the watermark cannot exceed the video encoding resolution of the stream. It can be set at any time before or during the publishing stream.

Available since: 1.1.0

setSEIConfig:

- (void)setSEIConfig:(ZegoSEIConfig *) config;

Set the Supplemental Enhancement Information type.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
config	ZegoSEIConfig *	SEI configuration. The SEI defined by ZEGO is used by default.

Details

By default, the SDK wraps the data with ZEGO's self-defined SEI type, which is not specified by the SEI standard. When the developer needs to use a third-party decoder to decode the SEI, the correct SEI will not be decoded and the [setSEIConfig] interface needs to be called to change the type of the SEI sent by the SDK to UserUnregister type.

Use cases: This function needs to be executed when the developer uses a third-party decoder to decode the SEI.
When to call: After creating the engine [createEngine], before starting to push the stream [startPublishingStream].

Available since: 1.18.0
Restrictions: None.

sendSEI:

- (void)sendSEI:(NSData *) data;

Sends Supplemental Enhancement Information.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
data	NSData *	SEI data.

Details

While pushing the stream to transmit the audio and video stream data, the stream media enhancement supplementary information is sent to synchronize some other additional information.

Use cases: Generally used in scenes such as synchronizing music lyrics or precise video layout, you can choose to send SEI.
When to call: After starting to push the stream [startPublishingStream].
Caution: 1. Due to network issues, frame loss may occur, which means SEI information may also be lost. To address this situation, it is advisable to send it multiple times within a limited frequency. 2. Even if the [enableCamera] interface is called to turn off the camera or [mutePublishStreamVideo] is used to stop sending video data, SEI can still be successfully sent; as long as the playback side does not call the [mutePlayStreamVideo] interface to stop pulling audio data, SEI can still be received normally. 3. If the SDK does not support the video module but does support the SEI functional module, SEI information can still be sent normally.
Related APIs: After the pusher sends the SEI, the puller can obtain the SEI content by monitoring the callback of [onPlayerRecvSEI].

Available since: 1.1.0
Restrictions: Do not exceed 30 times per second, and the SEI data length is limited to 4096 bytes.

sendSEI:channel:

- (void)sendSEI:(NSData *) data channel:(ZegoPublishChannel) channel;

Sends Supplemental Enhancement Information to the specified publish channel.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
data	NSData *	SEI data.
channel	ZegoPublishChannel	Publish stream channel.

Details

While pushing the stream to transmit the audio and video stream data, the stream media enhancement supplementary information is sent to synchronize some other additional information.

Use cases: Generally used in scenes such as synchronizing music lyrics or precise video layout, you can choose to send SEI.
When to call: After starting to push the stream [startPublishingStream].
Caution: 1. Due to network issues, frame loss may occur, which means SEI information may also be lost. To address this situation, it is advisable to send it multiple times within a limited frequency. 2. Even if the [enableCamera] interface is called to turn off the camera or [mutePublishStreamVideo] is used to stop sending video data, SEI can still be successfully sent; as long as the playback side does not call the [mutePlayStreamVideo] interface to stop pulling audio data, SEI can still be received normally. 3. If the SDK does not support the video module but does support the SEI functional module, SEI information can still be sent normally.
Related APIs: After the pusher sends the SEI, the puller can obtain the SEI content by monitoring the callback of [onPlayerRecvSEI].

Available since: 1.1.0
Restrictions: Do not exceed 30 times per second, and the SEI data length is limited to 4096 bytes.

sendSEISyncWithCustomVideo:timeStampNs:channel:

- (void)sendSEISyncWithCustomVideo:(NSData *) data timeStampNs:(unsigned long long) timeStampNs channel:(ZegoPublishChannel) channel;

Send the media supplementary enhancement information synchronized with the current video frame during custom video capture.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
data	NSData *	SEI data.
timeStampNs	unsigned long long	video frame reference time, UNIX timestamp, in nanosecond.
channel	ZegoPublishChannel	Publish stream channel.

Details

When using custom video capture, push the stream to transmit the video stream data, and send the stream media enhancement supplementary information to synchronize some other additional information, which is synchronized with the current video frame.

Use cases: Generally used in scenes that need to be played back in strong synchronization with the video frame, such as video karaoke, video and lyrics are strongly synchronized; or scenes that need to be accurate to the frame level for strategic processing.
When to call: To ensure that the SEI is synchronized with the current video frame, it must be called before sending the video frame data.
Caution: The sent SEI information follows the video frame. Due to network problems, there may be frame loss. At this time, the SEI will follow the next frame of video data. Therefore, in order to keep the SEI synchronized with the video frame, you should avoid sending SEI continuously; only when using SurfaceTexture on the Android platform , Need to pass the time stamp parameter timeStampNs, otherwise the parameter is invalid.
Related APIs: After the pusher sends the SEI, the puller can obtain the SEI content by monitoring the callback of [onPlayerRecvSEI].

Available since: 2.15.0
Restrictions: Only used for custom video capture; only supports video-driven SEI sending; you should try to avoid calling this interface to send SEI continuously; to ensure that SEI is synchronized with the current video frame, it must be kept in the same thread as the interface for sending custom video frame data; SEI data length is limited to 4096 bytes.

sendAudioSideInfo:timeStampMs:channel:

- (void)sendAudioSideInfo:(NSData *) data timeStampMs:(double) timeStampMs channel:(ZegoPublishChannel) channel;

Send audio side information.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
data	NSData *	Audio side info data.
timeStampMs	double	timeStampMs, derived from custom audio processing, in milliseconds. If you fill in 0, it is sent along with the frame that is currently ready to be sent.
channel	ZegoPublishChannel	Publish stream channel.

Details

While streaming audio data, send audio side information to synchronize some additional information.

Use cases: In the carousel scene, the audio data channel is required to carry accompanying information, such as timestamps to help align the accompaniment, and the need to know who the user is currently singing, whether to amplify the volume, and so on.
When to call: After starting to push the stream [startPublishingStream].
Caution: 1. Audio side information is driven by audio data, so audio data must be pushed (audio side information may be lost when the DTX function is enabled via the interface [setEngineConfig]). 2. Due to network issues, audio side information may be lost, and the SDK is responsible for transmission but does not guarantee reliability.
Related APIs: After the pusher sends the side information, the puller can obtain the side information content by monitoring the callback of [onPlayerRecvAudioSideInfo].

Available since: 2.19.0
Restrictions: 1. This function is only valid when publishing stream to the Zego RTC server and it also doesn't work when retweeting the stream from the RTC server to the CDN. 2. The audio side information data length is limited to 1024 bytes.

enableHardwareEncoder:

- (void)enableHardwareEncoder:(BOOL) enable;

Enables or disables hardware encoding.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	Whether to enable hardware encoding, true: enable hardware encoding, false: disable hardware encoding.

Details

Whether to use the hardware encoding function when publishing the stream, the GPU is used to encode the stream and to reduce the CPU usage.

When to call: The setting can take effect before the stream published. If it is set after the stream published, the stream should be stopped first before it takes effect.
Caution: Because hard-coded support is not particularly good for a few models, SDK uses software encoding by default. If the developer finds that the device is hot when publishing a high-resolution audio and video stream during testing of some models, you can consider calling this function to enable hard coding.

Available since: 1.1.0

setCapturePipelineScaleMode:

- (void)setCapturePipelineScaleMode:(ZegoCapturePipelineScaleMode) mode;

Sets the timing of video scaling in the video capture workflow. You can choose to do video scaling right after video capture (the default value) or before encoding.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
mode	ZegoCapturePipelineScaleMode	The capture scale timing mode.

When to call: This function needs to be set before call [startPreview] or [startPublishingStream].
Caution: The main effect is Whether the local preview is affected when the acquisition resolution is different from the encoding resolution.

Available since: 1.1.0

setDummyCaptureImagePath:channel:

- (void)setDummyCaptureImagePath:(NSString *) filePath channel:(ZegoPublishChannel) channel;

Set the path of the static picture would be published when the camera is closed.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
filePath	NSString *	Picture file path
channel	ZegoPublishChannel	Publish channel.

Details

Set the path of the static picture would be published when enableCamera(false) is called, it would start to publish static pictures, and when enableCamera(true) is called, it would end publishing static pictures. Use case: The developer wants to display a static picture when the camera is closed. For example, when the anchor exits the background, the camera would be actively closed. At this time, the audience side needs to display the image of the anchor temporarily leaving.

When to call: After the engine is initialized, call this API to configure the parameters before closing the camera.
Caution: 1. The static picture cannot be seen in the local preview. 2. External filters, mirroring, watermarks, and snapshots are all invalid. 3. If the picture aspect ratio is inconsistent with the set code aspect ratio, it will be cropped according to the code aspect ratio. 4. To publish the audio stream, you must call this interface again and set the image path to empty to avoid video billing.
Platform differences: 1. Windows: Fill in the location of the picture directly, such as "D://dir//image.jpg". 2. iOS: If it is a full path, add the prefix "file:", such as @"file:/var/image.png"; If it is a assets picture path, add the prefix "asset:", such as @"asset
". 3. Android: If it is a full path, add the prefix "file:", such as "file:/sdcard/image.png"; If it is a assets directory path, add the prefix "asset:", such as "asset
.png". 4. Flutter: If it is a absolute path, add the prefix "file:", such as "file:/sdcard/image.png"; If it is a assets resources directory path, add the prefix "flutter-asset://", such as "flutter-asset://assets/watermark.png". 5. UniApp: Only absolute paths are supported. You need to add a "file:" prefix, such as: "file:/sdcard/image.png".

Restrictions: 1. Supported picture types are JPEG/JPG, PNG, BMP, HEIF. 2. The function is only for SDK video capture and does not take effect for custom video capture. 3. Not supported that the filePath is a network link.

setDummyCaptureImageParams:channel:

- (void)setDummyCaptureImageParams:(ZegoDummyCaptureImageParams *) params channel:(ZegoPublishChannel) channel;

Set the params of the static picture would be published when the camera is closed.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
params	ZegoDummyCaptureImageParams *	Dummy capture image params.
channel	ZegoPublishChannel	Publish channel.

Details

Set the params of the static picture would be published when enableCamera(false) is called, it would start to publish static pictures, and when enableCamera(true) is called, it would end publishing static pictures. Use case: The developer wants to display a static picture when the camera is closed. For example, when the anchor exits the background, the camera would be actively closed. At this time, the audience side needs to display the image of the anchor temporarily leaving.

When to call: After the engine is initialized, call this API to configure the parameters before closing the camera.
Caution: 1. The static picture cannot be seen in the local preview. 2. External filters, mirroring, watermarks, and snapshots are all invalid. 3. If the picture aspect ratio is inconsistent with the set code aspect ratio, it will be cropped according to the code aspect ratio. 4. To publish the audio stream, you must call this interface again and set the image path to empty to avoid video billing.
Platform differences: 1. Windows: Fill in the location of the picture directly, such as "D://dir//image.jpg". 2. iOS: If it is a full path, add the prefix "file:", such as @"file:/var/image.png"; If it is a assets picture path, add the prefix "asset:", such as @"asset
". 3. Android: If it is a full path, add the prefix "file:", such as "file:/sdcard/image.png"; If it is a assets directory path, add the prefix "asset:", such as "asset
.png". 4. Flutter: If it is a absolute path, add the prefix "file:", such as "file:/sdcard/image.png"; If it is a assets resources directory path, add the prefix "flutter-asset://", such as "flutter-asset://assets/watermark.png". 5. UniApp: Only absolute paths are supported. You need to add a "file:" prefix, such as: "file:/sdcard/image.png".

Restrictions: 1. Supported picture types are JPEG/JPG, PNG, BMP, HEIF. 2. The function is only for SDK video capture and does not take effect for custom video capture. 3. Not supported that the filePath is a network link.

enableH265EncodeFallback:

- (void)enableH265EncodeFallback:(BOOL) enable;

Whether to enable H.265 encoding to automatically downgrade to H.264 encoding.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	Whether to enable H.265 coding automatically fallback to H.264 coding, true: enable, false: disable, and the default value is true

Details

When using H.265 encoding to push the stream, whether to enable the strategy of automatically degrading H.265 encoding to H.264 encoding under abnormal circumstances.After enabling automatic downgrade, when H.265 encoding is not supported or H.265 encoding fails, the SDK will try to downgrade and use H.264 encoding to push the stream.After turning off automatic downgrade, when H.265 encoding is not supported or H.265 encoding fails, the direct streaming fails.

Use cases: In the Co-hosting and Showroom Live Streaming scenarios, use H265 encoding to push the stream to save CDN traffic without degrading the picture quality. Default Value: When this interface is not called, the default is yes, which means that H.265 encoding is turned on and automatically downgraded to H.264 encoding.
When to call: After creating the engine, call the [startPublishingStream] function before pushing the stream.
Related callbacks: When the H.265 encoding is automatically downgraded to the H.264 encoding strategy, the [onPublisherVideoEncoderChanged] callback will be triggered when the encoding method changes.
Caution: When downgrading from H.265 to H.264 encoding occurs during the streaming process, if you are recording local video or cloud recording, multiple recording files will be generated, which needs to be dealt with.

Available since: 2.12.0

isVideoEncoderSupported:

- (BOOL)isVideoEncoderSupported:(ZegoVideoCodecID) codecID;

Whether the specified video encoding type is supported.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
codecID	ZegoVideoCodecID	Video codec id. Required: Yes.

Details

Whether the specified video encoding is supported depends on the following aspects, whether the hardware model supports hard encoding, whether the performance of the hardware model supports soft encoding, and whether the SDK has the encoding module.

When to call: After creating the engine.
Caution: It is recommended that users call this interface to obtain H.265 encoding support capability before publish stream with H.265 encoding, if not supported, you can use other encodings for publish, such as H.264.On the mobile platform, the SDK only supports H.265 hardware encoding, and it is affected by the model and hardware capabilities.

Available since: 2.12.0 and above

Return

Whether the specified video encoding is supported.Value range: true means support, you can use this encoding format for publish; false means the is not supported, and the encoding format cannot be used for publish.

isVideoEncoderSupported:codecBackend:

- (int)isVideoEncoderSupported:(ZegoVideoCodecID) codecID codecBackend:(ZegoVideoCodecBackend) codecBackend;

Whether the specified video encoding type and implementation are supported.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
codecID	ZegoVideoCodecID	Video codec id. Required: Yes.
codecBackend	ZegoVideoCodecBackend	Backend implementation of encoder. Required: Yes.

Details

When to call: After creating the engine.
Caution: It is recommended that users call this interface to obtain H.265 encoding support capability before publish stream with H.265 encoding, if not supported, you can use other encodings for publish, such as H.264.On the mobile platform, the SDK only supports H.265 hardware encoding, and it is affected by the model and hardware capabilities.

Available since: 3.0.0 and above

Return

Whether the specified video encoding format is supported; 0 means not supported, and the encoding format cannot be used for publish stream; 1 means support, you can use this encoding format for publish stream; 2 means not confirmed, it is recommended to call this interface later.

getVideoEncoderSupported:codecBackend:callback:

- (void)getVideoEncoderSupported:(ZegoVideoCodecID) codecID codecBackend:(ZegoVideoCodecBackend) codecBackend callback:(nullable ZegoPublisherGetVideoEncoderSupportedCallback) callback;

Whether the specified video encoding type and implementation are supported.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
codecID	ZegoVideoCodecID	Video codec id. Required: Yes.
codecBackend	ZegoVideoCodecBackend	Backend implementation of encoder. Required: Yes.
callback	nullable ZegoPublisherGetVideoEncoderSupportedCallback	Results of get video encoder supported.

Details

When to call: After creating the engine.
Caution: It is recommended that users call this interface to obtain H.265 encoding support capability before publish stream with H.265 encoding, if not supported, you can use other encodings for publish, such as H.264.On the mobile platform, the SDK only supports H.265 hardware encoding, and it is affected by the model and hardware capabilities.

Available since: 3.23.0 and above

setAppOrientationMode:

- (void)setAppOrientationMode:(ZegoOrientationMode) mode;

Set the orientation mode of the video.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
mode	ZegoOrientationMode	Orientation mode of the video.

Details

In order to simplify the complexity of processing video screen rotation for mobile developers, the SDK supports setting multiple video orientation modes, and developers can choose different modes according to the needs of the scene.

Use cases: Scenarios for live streaming or video calls using mobile devices.
Default value: Custom mode.
When to call: This function needs to be valid after calling [createEngine] and before calling preview [startPreview] or push stream [startPublishingStream].
Caution:
1. It is valid for all channels.
2. The adaptive mode takes effect in preview, streaming, and mixed streaming scenarios. It does not support external video capture, media player, cloud recording, local recording, or publishing/playing stream through CDN.
Related APIs: You can call the [setAppOrientation] function to set the orientation of the App in custom mode.

Available since: 2.23.0

setLowlightEnhancement:channel:

- (void)setLowlightEnhancement:(ZegoLowlightEnhancementMode) mode channel:(ZegoPublishChannel) channel;

Set low light enhancement.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
mode	ZegoLowlightEnhancementMode	Low light enhancement mode.
channel	ZegoPublishChannel	Publish stream channel.

Details

According to the set low-light enhancement mode, the brightness of the image captured by the camera is enhanced, which is compatible with the beauty function. Users can watch the effect while previewing and toggle the low-light enhancement mode in real time.

Use cases: The environment on the streaming end is dark, or the frame rate set by the camera is high, which causes the picture to be dark, and the subject cannot be displayed or recognized normally.
Default value: Off.
When to call: After creating the engine [createEngine].

Available since: 2.21.0

setLowlightEnhancementParams:channel:

- (void)setLowlightEnhancementParams:(ZegoExpLowlightEnhancementParams *) params channel:(ZegoPublishChannel) channel;

Set low light enhancement params.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
params	ZegoExpLowlightEnhancementParams *	Low light enhancement params.
channel	ZegoPublishChannel	Publish stream channel.

Details

Use cases: The environment on the streaming end is dark, or the frame rate set by the camera is high, which causes the picture to be dark, and the subject cannot be displayed or recognized normally.
When to call: After creating the engine [createEngine].

Available since: 3.19.0

setVideoDenoiseParams:channel:

- (void)setVideoDenoiseParams:(ZegoVideoDenoiseParams *) params channel:(ZegoPublishChannel) channel;

Set video denoise params.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
params	ZegoVideoDenoiseParams *	Video denoise params.
channel	ZegoPublishChannel	Publish stream channel.

Details

Set video denoise parameters, including mode and strength.

Default value: Off.
When to call: After creating the engine [createEngine].
Platform differences: Only supports iOS and Android.

Available since: 3.18.0

setVideoSource:

- (int)setVideoSource:(ZegoVideoSourceType) source;

Set video capture source.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
source	ZegoVideoSourceType	Video capture source.

Details

Set video capture source for switching between different video capture sources.

Use cases: Typically used in educational scenarios that require switching between different video capture sources.
When to call: After the engine is created [createEngine].
Caution: 1. Act on the main publish channel ZegoPublishChannel.Main.

Main push channel ZegoPublishChannel.Main does not support using ZegoVideoSourceType.Player and ZegoVideoSourceType.MainPublishChannel video source type.

Available since: 3.1.0
Restrictions: None.

setVideoSource:instanceID:

- (int)setVideoSource:(ZegoVideoSourceType) source instanceID:(unsigned int) instanceID;

Set a video capture instance as the video capture source.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
source	ZegoVideoSourceType	Video capture source.
instanceID	unsigned int	Video capture source instance id.

Details

Set video capture source for switching between different video capture sources.

Use cases: Typically used in educational scenarios that require switching between different video capture sources.
When to call: After the engine is created [createEngine].
Caution: 1. Act on the main publish channel ZegoPublishChannel.Main.

Main push channel ZegoPublishChannel.Main does not support using ZegoVideoSourceType.Player and ZegoVideoSourceType.MainPublishChannel video source type.

Available since: 3.1.0
Restrictions: None.

setVideoSource:channel:

- (int)setVideoSource:(ZegoVideoSourceType) source channel:(ZegoPublishChannel) channel;

Set video capture source for the specified channel.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
source	ZegoVideoSourceType	Video capture source.
channel	ZegoPublishChannel	Publish stream channel.

Details

Set video capture source for switching between different video capture sources.

Use cases: Typically used in educational scenarios that require switching between different video capture sources.
When to call: After the engine is created [createEngine].
Caution: 1. Main push channel ZegoPublishChannel.Main does not support using ZegoVideoSourceType.Player and ZegoVideoSourceType.MainPublishChannel video source type.

When using ZegoVideoSourceType.Player and ZegoVideoSourceType.MainPublishChannel video source type in aux publish channel ZegoPublishChannel.Aux, must ensure that physical device works on main publish channel ZegoPublishChannel.Main.
Preemptive video sources are not allowed to be used on multiple channels at the same time, such as ZegoVideoSourceType.Camera and ZegoVideoSourceType.ScreenCapture.
The other publish channel can copy the main publish channel only when the main publish channel uses internal video capture. A maximum of one copy is supported.
When using ZegoVideoSourceType.Player video source type, please ensure that the ZegoMediaPlayer instance is created successfully.

Available since: 3.1.0
Restrictions: None.

setVideoSource:instanceID:channel:

- (int)setVideoSource:(ZegoVideoSourceType) source instanceID:(unsigned int) instanceID channel:(ZegoPublishChannel) channel;

Set a video capture instance as video capture source for the specified channel.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
source	ZegoVideoSourceType	Video capture source.
instanceID	unsigned int	Video capture source instance id.
channel	ZegoPublishChannel	Publish stream channel.

Details

Set video capture source for switching between different video capture sources.

Use cases: Typically used in educational scenarios that require switching between different video capture sources.
When to call: After the engine is created [createEngine].
Caution: 1. Main push channel ZegoPublishChannel.Main does not support using ZegoVideoSourceType.Player and ZegoVideoSourceType.MainPublishChannel video source type.

When using ZegoVideoSourceType.Player and ZegoVideoSourceType.MainPublishChannel video source type in aux publish channel ZegoPublishChannel.Aux, must ensure that physical device works on main publish channel ZegoPublishChannel.Main.
Preemptive video sources are not allowed to be used on multiple channels at the same time, such as ZegoVideoSourceType.Camera and ZegoVideoSourceType.ScreenCapture.
The other publish channel can copy the main publish channel only when the main publish channel uses internal video capture. A maximum of one copy is supported.
When using ZegoVideoSourceType.Player video source type, please ensure that the ZegoMediaPlayer instance is created successfully.

Available since: 3.1.0
Restrictions: None.

setAudioSource:

- (int)setAudioSource:(ZegoAudioSourceType) source;

Set audio capture source.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
source	ZegoAudioSourceType	Audio capture source.

Details

Set audio capture source for switching between different audio capture sources.

Use cases: Typically used in educational scenarios that require switching between different audio capture sources.
When to call: After the engine is created [createEngine].
Caution: 1. Act on the main publish channel ZegoPublishChannel.Main.

Main push channel ZegoPublishChannel.Main does not support using ZegoAudioSourceType.MediaPlayer and ZegoAudioSourceType.MainPublishChannel audio source type.

Available since: 3.1.0
Restrictions: None.

setAudioSource:channel:

- (int)setAudioSource:(ZegoAudioSourceType) source channel:(ZegoPublishChannel) channel;

Set audio capture source for the specified channel.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
source	ZegoAudioSourceType	Audio capture source.
channel	ZegoPublishChannel	Publish stream channel.

Details

Set audio capture source for switching between different audio capture sources.

Use cases: Typically used in educational scenarios that require switching between different audio capture sources.
When to call: After the engine is created [createEngine].
Caution: 1. Main push channel ZegoPublishChannel.Main does not support using ZegoAudioSourceType.MediaPlayer and ZegoAudioSourceType.MainPublishChannel audio source type.

When using ZegoAudioSourceType.MediaPlayer and ZegoAudioSourceType.MainPublishChannel audio source type in aux publish channel ZegoPublishChannel.Aux, must ensure that physical device works on main publish channel ZegoPublishChannel.Main.
Preemptive audio sources are not allowed to be used on multiple channels at the same time, such as ZegoAudioSourceType.Microphone.
When using ZegoAudioSourceType.MediaPlayer audio source type, please ensure that the ZegoMediaPlayer instance is created successfully.

Available since: 3.1.0

setAudioSource:config:

- (int)setAudioSource:(ZegoAudioSourceType) source config:(ZegoAudioSourceMixConfig *) config;

Set audio capture source with audio mix config.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
source	ZegoAudioSourceType	Audio capture source.
config	ZegoAudioSourceMixConfig *	Audio capture source mix config.

Details

Set audio capture source for switching between different audio capture sources.

Use cases: Typically used in educational scenarios that require switching between different audio capture sources.
When to call: After the engine is created [createEngine].
Caution: 1. Act on the main publish channel ZegoPublishChannel.Main.

Main push channel ZegoPublishChannel.Main does not support using ZegoAudioSourceType.MediaPlayer and ZegoAudioSourceType.MainPublishChannel audio source type.

Available since: 3.1.0
Restrictions: None.

enableVideoObjectSegmentation:type:channel:

- (void)enableVideoObjectSegmentation:(BOOL) enable type:(ZegoObjectSegmentationType) type channel:(ZegoPublishChannel) channel;

Enable video object segmentation.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	Whether to enable video object segmentation, off by default.
type	ZegoObjectSegmentationType	The type of object segmentation.
channel	ZegoPublishChannel	Publish stream channel.

Details

Video object segmentation and transmission is a technology that separates the video object (in most cases, a person) in a rectangular video through an AI algorithm at the push end, transmits it in the RTC network, and renders it at the stream playing end.

Use cases: Scenes where the object in the video needs to be separated from the background, such as mixed reality, multi-person interaction scenes, and so on.
When to call:

After the engine is created [createEngine].
If you want to listen to the [onVideoObjectSegmentationStateChanged] callback, you need to call [startPublishingStream] or [startPreview].

Caution: This feature requires special braiding, please contact ZEGO Technical Support
Related callbacks: Listen for changes of the object segmentation state through [onVideoObjectSegmentationStateChanged].
Related APIs: Use [enableAlphaChannelVideoEncoder] to support the transparent background encoding of the divided object, and then publish the stream, you can render the object with a transparent background effect on the stream playing side.

Available since: 3.4.0
Restrictions: Enabling object segmentation is a time-consuming operation, and it is not necessary to turn it on and off frequently.

enableVideoObjectSegmentation:config:channel:

- (void)enableVideoObjectSegmentation:(BOOL) enable config:(ZegoObjectSegmentationConfig *) config channel:(ZegoPublishChannel) channel;

Enable video object segmentation.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	Whether to enable video object segmentation, off by default.
config	ZegoObjectSegmentationConfig *	The type of object segmentation.
channel	ZegoPublishChannel	Publish stream channel.

Details

Use cases: Scenes where the object in the video needs to be separated from the background, such as mixed reality, multi-person interaction scenes, and so on.
When to call: After the engine is created [createEngine].
Caution: This feature requires special braiding, please contact ZEGO Technical Support
Related callbacks: When the object segmentation is turned on or off, the notification of the object segmentation state can be received through [onVideoObjectSegmentationStateChanged].
Related APIs: Use [enableAlphaChannelVideoEncoder] to support the transparent background encoding of the divided object, and then publish the stream, you can render the object with a transparent background effect on the stream playing side.

Available since: 3.6.0
Restrictions: Enabling object segmentation is a time-consuming operation, and it is not necessary to turn it on and off frequently.

enableAlphaChannelVideoEncoder:alphaLayout:channel:

- (void)enableAlphaChannelVideoEncoder:(BOOL) enable alphaLayout:(ZegoAlphaLayoutType) alphaLayout channel:(ZegoPublishChannel) channel;

Enable video encoder alpha channel support.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	Enable video encoder alpha channel support, off by default.
alphaLayout	ZegoAlphaLayoutType	Specify the layout position of the alpha channel data.
channel	ZegoPublishChannel	Publish stream channel.

Details

Enable the alpha channel support of the video encoder on the stream publishing end, and encode the split video body for streaming.

Use cases: Scenes where the object in the video needs to be separated from the background, such as mixed reality, multi-person interaction scenes, and so on.
When to call: After creating the engine.

Available since: 3.4.0

enableVideoEncoderEnhancement:enhanceLevel:channel:

- (void)enableVideoEncoderEnhancement:(BOOL) enable enhanceLevel:(float) enhanceLevel channel:(ZegoPublishChannel) channel;

Enable video encoder enhancement.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	Whether to enable, true: enable, false: disable
enhanceLevel	float	enhance_level [0.0,1.5], advise 0.9
channel	ZegoPublishChannel	Publish stream channel.

Details

Call this function to enable or disable video encoder enhancement.

Use cases: Commonly used in video calling, live streaming, and similar scenarios.
Default value: When this function is not called, video encoder enhancement is not enabled by default.
When to call: It needs to be called after [createEngine].

Available since: 3.23.0

setCameraStabilizationMode:channel:

- (void)setCameraStabilizationMode:(int) mode channel:(ZegoPublishChannel) channel;

Set the camera stabilization mode.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
mode	int	The camera stabilization mode. iOS Apple AVCaptureVideoStabilizationMode definition for details. The default value is 0. Android:AUTO:-1, OFF:0. The default value is 0.
channel	ZegoPublishChannel	Publish stream channel.

Details

Set the camera stabilization mode. Use case: Users can use this function to set the camera stabilization mode to reduce the impact of camera shake on video collection.

When to call: Called after the engine is created [createEngine].
Platform differences: Only supports iPhone and Android.

Available since: 3.13.0
Restrictions: Only supports internal video capture.

enableAuxBgmBalance:

- (void)enableAuxBgmBalance:(BOOL) enable;

Turn on or off the adaptive mode to adjust the volume of the human voice according to the volume of the BGM.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	Turn on or off the adaptive mode to adjust the volume of the human voice according to the volume of the BGM.

Details

Turn on or off the adaptive mode to adjust the volume of the human voice according to the volume of the BGM to balance the volume of the human voice and the BGM. Default is off.

When to call: Called after the engine is created [createEngine].

Available since: 3.18.0
Restrictions: This interface will take effect only when the [EnableAux] interface of the media player is called to enable aux.

enableFaceDetection:channel:

- (void)enableFaceDetection:(BOOL) enable channel:(ZegoPublishChannel) channel;

Turn on or off the face detection.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	Turn on or off the face detection.
channel	ZegoPublishChannel	Publish stream channel.

Details

Turn on or off the face detection. Default is on.

When to call: Called after the engine is created [createEngine].
Related callbacks: Detect results will be called back through [onPublisherFaceDetectInfo].

Available since: 3.20.0
Restrictions: This interface is disabled when using custom video capture.

startPlayingStream:canvas:

- (void)startPlayingStream:(NSString *) streamID canvas:(ZegoCanvas *) canvas;

Starts playing a stream from ZEGO RTC server.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
streamID	NSString *	Stream ID, a string of up to 256 characters. Caution: Only support numbers, English characters and '-', '_'.
canvas	ZegoCanvas *	The view used to display the play audio and video stream's image. When the view is set to [nil], no video is displayed, only audio is played.

Details

Play audio and video streams from the ZEGO RTC server.

Use cases: In the real-time scenario, developers can listen to the [onRoomStreamUpdate] event callback to obtain the new stream information in the room where they are located, and call this interface to pass in streamID for play streams.
When to call: After [loginRoom].
Caution: 1. The developer can update the player canvas by calling this function again (the streamID must be the same). 2. After the first play stream failure due to network reasons or the play stream is interrupted, the default time for SDK reconnection is 20min. 3. In the case of poor network quality, user play may be interrupted, the SDK will try to reconnect, and the current play status and error information can be obtained by listening to the [onPlayerStateUpdate] event. please refer to https://docs.zegocloud.com/faq/reconnect. 4. Playing the stream ID that does not exist, the SDK continues to try to play after calling this function. After the stream ID is successfully published, the audio and video stream can be actually played.

Available since: 1.1.0
Restrictions: None.

startPlayingStream:canvas:config:

- (void)startPlayingStream:(NSString *) streamID canvas:(ZegoCanvas *) canvas config:(ZegoPlayerConfig *) config;

Starts playing a stream from ZEGO RTC server or from third-party CDN. Support multi-room mode.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
streamID	NSString *	Stream ID, a string of up to 256 characters. Caution: Only support numbers, English characters and '-', '_'.
canvas	ZegoCanvas *	The view used to display the play audio and video stream's image. When the view is set to [nil], no video is displayed, only audio is played.
config	ZegoPlayerConfig *	Advanced player configuration Room [roomID] in [ZegoPlayerConfig] is the login roomID.

Details

Play audio and video streams from the ZEGO RTC server or CDN.

Use cases: In real-time or live broadcast scenarios, developers can listen to the [onRoomStreamUpdate] event callback to obtain the new stream information in the room where they are located, and call this interface to pass in streamID for play streams.
When to call: After [loginRoom].
Caution: 1. The developer can update the player canvas by calling this function again (the streamID must be the same). 2. After the first play stream failure due to network reasons or the play stream is interrupted, the default time for SDK reconnection is 20min. 3. In the case of poor network quality, user play may be interrupted, the SDK will try to reconnect, and the current play status and error information can be obtained by listening to the [onPlayerStateUpdate] event. please refer to https://docs.zegocloud.com/faq/reconnect. 4. Playing the stream ID that does not exist, the SDK continues to try to play after calling this function. After the stream ID is successfully published, the audio and video stream can be actually played.

Available since: 1.1.0
Restrictions: None.

startPlayingStream:

- (void)startPlayingStream:(NSString *) streamID;

Starts playing a stream from ZEGO RTC server, without Canvas, it is more suitable for pure audio stream.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
streamID	NSString *	Stream ID, a string of up to 256 characters. Caution: Only support numbers, English characters and '-', '_'.

Details

Play audio streams from the ZEGO RTC server or CDN.

Use cases: In the real-time scenario, developers can listen to the [onRoomStreamUpdate] event callback to obtain the new stream information in the room where they are located, and call this interface to pass in streamID for play streams.
When to call: After [loginRoom].
Caution: 1. After the first play stream failure due to network reasons or the play stream is interrupted, the default time for SDK reconnection is 20min. 2. In the case of poor network quality, user play may be interrupted, the SDK will try to reconnect, and the current play status and error information can be obtained by listening to the [onPlayerStateUpdate] event. please refer to https://docs.zegocloud.com/faq/reconnect. 3. Playing the stream ID that does not exist, the SDK continues to try to play after calling this function. After the stream ID is successfully published, the audio stream can be actually played.

Available since: 1.1.0
Restrictions: None.

startPlayingStream:config:

- (void)startPlayingStream:(NSString *) streamID config:(ZegoPlayerConfig *) config;

Starts playing a stream from ZEGO RTC server or from third-party CDN, without Canvas, it is more suitable for pure audio stream.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
streamID	NSString *	Stream ID, a string of up to 256 characters. Caution: Only support numbers, English characters and '-', '_'.
config	ZegoPlayerConfig *	Advanced player configuration.

Details

Play audio streams from the ZEGO RTC server or CDN.

Use cases: In real-time or live broadcast scenarios, developers can listen to the [onRoomStreamUpdate] event callback to obtain the new stream information in the room where they are located, and call this interface to pass in streamID for play streams.
When to call: After [loginRoom].
Caution: 1. After the first play stream failure due to network reasons or the play stream is interrupted, the default time for SDK reconnection is 20min. 2. In the case of poor network quality, user play may be interrupted, the SDK will try to reconnect, and the current play status and error information can be obtained by listening to the [onPlayerStateUpdate] event. please refer to https://docs.zegocloud.com/faq/reconnect. 3. Playing the stream ID that does not exist, the SDK continues to try to play after calling this function. After the stream ID is successfully published, the audio stream can be actually played.

Available since: 1.1.0
Restrictions: None.

startPlayingStreamInScene:canvas:config:

- (void)startPlayingStreamInScene:(NSString *) streamID canvas:(ZegoCanvas *) canvas config:(ZegoScenePlayerConfig *) config;

Starts playing a stream from ZEGO RTC server or from third-party CDN when using RangeScene.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
streamID	NSString *	Stream ID, a string of up to 256 characters. Caution: Only support numbers, English characters and '-', '_'.
canvas	ZegoCanvas *	The view used to display the play audio and video stream's image. When the view is set to [nil], no video is displayed, only audio is played.
config	ZegoScenePlayerConfig *	Advanced scene player configuration.

Details

Play audio and video streams from the ZEGO RTC server or CDN.

Use cases: When using RangeScene, users can use this function to customize play the streaming.
When to call: After [loginScene].
Caution: 1. The developer can update the player canvas by calling this function again (the streamID must be the same). 2. After the first play stream failure due to network reasons or the play stream is interrupted, the default time for SDK reconnection is 20min. 3. In the case of poor network quality, user play may be interrupted, the SDK will try to reconnect, and the current play status and error information can be obtained by listening to the [onPlayerStateUpdate] event. please refer to https://docs.zegocloud.com/faq/reconnect. 4. Playing the stream ID that does not exist, the SDK continues to try to play after calling this function. After the stream ID is successfully published, the audio and video stream can be actually played.

Available since: 3.4.0
Restrictions: None.

startPlayingStreamInScene:config:

- (void)startPlayingStreamInScene:(NSString *) streamID config:(ZegoScenePlayerConfig *) config;

Starts playing a stream from ZEGO RTC server or from third-party CDN when using RangeScene, without Canvas, it is more suitable for pure audio stream.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
streamID	NSString *	Stream ID, a string of up to 256 characters. Caution: Only support numbers, English characters and '-', '_'.
config	ZegoScenePlayerConfig *	Advanced scene player configuration.

Details

Play audio and video streams from the ZEGO RTC server or CDN.

Use cases: When using RangeScene, users can use this function to customize play the streaming.
When to call: After [loginScene].
Caution: 1. The developer can update the player canvas by calling this function again (the streamID must be the same). 2. After the first play stream failure due to network reasons or the play stream is interrupted, the default time for SDK reconnection is 20min. 3. In the case of poor network quality, user play may be interrupted, the SDK will try to reconnect, and the current play status and error information can be obtained by listening to the [onPlayerStateUpdate] event. please refer to https://docs.zegocloud.com/faq/reconnect. 4. Playing the stream ID that does not exist, the SDK continues to try to play after calling this function. After the stream ID is successfully published, the audio and video stream can be actually played.

Available since: 3.3.0
Restrictions: None.

switchPlayingStream:toStreamID:config:

- (void)switchPlayingStream:(NSString *) fromStreamID toStreamID:(NSString *) toStreamID config:(ZegoPlayerConfig *) config;

Switch from playing a certain stream to playing another stream.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
fromStreamID	NSString *	Stream ID, a string of up to 256 characters. Caution: Only support numbers, English characters and '-', '_'.
toStreamID	NSString *	Stream ID, a string of up to 256 characters. Caution: Only support numbers, English characters and '-', '_'.
config	ZegoPlayerConfig *	Advanced player configuration.

Details

Smoothly switch from one flv stream to another flv stream.

Use cases: For the same stream, there may be multiple streams with different resolutions. When the network quality deteriorates, in order to ensure the streaming quality, the streaming end can choose to switch from a high-resolution stream to a low-resolution stream..
When to call: After [startPlayingStream].
Related callbacks:

The result of the switching request can be obtained through the [onPlayerSwitched] event.
When the stream is switched successfully, the current streaming status can be known through the [onPlayerStateUpdate] event.
When switching streams fails, there may not necessarily be an [onPlayerStateUpdate] event notification.

Available since: 3.16.0
Restrictions: Only supports flv protocol stream.

stopPlayingStream:

- (void)stopPlayingStream:(NSString *) streamID;

Stops playing a stream.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
streamID	NSString *	Stream ID.

Details

Play audio and video streams from the ZEGO RTC server.

Use cases: In the real-time scenario, developers can listen to the [onRoomStreamUpdate] event callback to obtain the delete stream information in the room where they are located, and call this interface to pass in streamID for stop play streams.
When to call: After [loginRoom].
Caution: 1. When stopped, the attributes set for this stream previously, such as [setPlayVolume], [mutePlayStreamAudio], [mutePlayStreamVideo], etc., will be invalid and need to be reset when playing the the stream next time.

After stopping pulling, the iOS platform view will clear the last frame by default and keep the background color of the view. The Android platform view remains at the last frame by default. If you need to clear the last frame, please contact ZEGO technical support.

Available since: 1.1.0
Restrictions: None.

setPlayStreamDecryptionKey:streamID:

- (void)setPlayStreamDecryptionKey:(NSString *) key streamID:(NSString *) streamID;

Set decryption key for the playing stream.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
key	NSString *	The decryption key, note that the key length only supports 16/24/32 bytes.
streamID	NSString *	Stream ID.

Details

When streaming, the audio and video data will be decrypted according to the set key.

Use cases: Usually used in scenarios that require high security for audio and video calls.
When to call: after [createEngine], after the play stream can be changed at any time.
Related APIs: [setPublishStreamEncryptionKey]Set the publish stream encryption key.
Caution: This interface can only be called if encryption is set on the publish. Calling [stopPlayingStream] or [logoutRoom] will clear the decryption key.

Available since: 1.19.0
Restrictions: This function is only valid when calling from Zego RTC or L3 server.

setPlayStreamCrossAppInfo:streamID:

- (void)setPlayStreamCrossAppInfo:(ZegoCrossAppInfo *) info streamID:(NSString *) streamID;

Set up cross App playing stream information.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
info	ZegoCrossAppInfo *	Information for cross App playing stream.
streamID	NSString *	Stream ID.

Details

This information is used for authentication before playing a stream or when retrying playing a stream.

Use cases: Used in scenarios that playing streams across apps.
When to call: after [createEngine], after the play stream can be changed at any time.
Caution: Calling [stopPlayingStream] or [logoutRoom] will clear this information.

Available since: 2.19.0
Restrictions: This function is only valid when playing stream from Zego RTC server.

takePlayStreamSnapshot:callback:

- (void)takePlayStreamSnapshot:(NSString *) streamID callback:(ZegoPlayerTakeSnapshotCallback) callback;

Take a snapshot of the playing stream.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
streamID	NSString *	Stream ID to be snapshot.
callback	ZegoPlayerTakeSnapshotCallback	Results of take play stream snapshot.

Details

Take a screenshot of the specified stream ID.

When to call: after called [startPlayingStream].
Related callbacks: [onPlayerTakeSnapshotResult] Screenshot data callback.

Available since: 1.17.0
Restrictions: None.

setPlayVolume:streamID:

- (void)setPlayVolume:(int) volume streamID:(NSString *) streamID;

Sets the stream playback volume.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
volume	int	Volume percentage. The value ranges from 0 to 200, and the default value is 100.
streamID	NSString *	Stream ID.

Details

Set the sound size of the stream, the local user can control the playback volume of the audio stream.

When to call: after called [startPlayingStream].
Related APIs: [setAllPlayStreamVolume] Set all stream volume.
Caution: You need to reset after [stopPlayingStream] and [startPlayingStream]. This function and the [setAllPlayStreamVolume] function overwrite each other, and the last call takes effect.

Available since: 1.16.0
Restrictions: None.

setAllPlayStreamVolume:

- (void)setAllPlayStreamVolume:(int) volume;

Sets the all stream playback volume.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
volume	int	Volume percentage. The value ranges from 0 to 200, and the default value is 100.

Details

Set the sound size of the stream, the local user can control the playback volume of the audio stream.

When to call: after called [startPlayingStream].
Related APIs: [setPlayVolume] Set the specified streaming volume.
Caution: Set the specified streaming volume and [setAllPlayStreamVolume] interface to override each other, and the last call takes effect.

Available since: 2.3.0
Restrictions: None.

setPlayStreamVideoType:streamID:

- (void)setPlayStreamVideoType:(ZegoVideoStreamType) streamType streamID:(NSString *) streamID;

Set play video stream type.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
streamType	ZegoVideoStreamType	Video stream type.
streamID	NSString *	Stream ID.

Details

When the publish stream sets the codecID to SVC through [setVideoConfig], the puller can dynamically set and select different stream types (small resolution is one-half of the standard layer).

Use cases: In general, when the network is weak or the rendered UI window is small, you can choose to pull videos with small resolutions to save bandwidth.
When to call: before or after called [startPlayingStream].

Available since: 2.3.0
Restrictions: None.

setPlayStreamBufferIntervalRange:min:max:

- (void)setPlayStreamBufferIntervalRange:(NSString *) streamID min:(unsigned int) min max:(unsigned int) max;

Set the adaptive adjustment interval range of the buffer for playing stream.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
streamID	NSString *	Stream ID.
min	unsigned int	The lower limit of the buffer adaptation interval, in milliseconds. The default value is 0ms.
max	unsigned int	The upper limit of the buffer adaptation interval, in milliseconds. The default value is 4000ms.

Details

Set the range of adaptive adjustment of the internal buffer of the sdk when streaming is 0-4000ms.

Use cases: Generally, in the case of a poor network environment, adjusting and increasing the playback buffer of the pull stream will significantly reduce the audio and video freezes, but will increase the delay.
When to call: after called [createEngine], if it has been set, you need to reset it every time you play the stream again.
Caution: When the upper limit of the cache interval set by the developer exceeds 4000ms, the value will be 4000ms. When the upper limit of the cache interval set by the developer is less than the lower limit of the cache interval, the upper limit will be automatically set as the lower limit.

Available since: 2.1.0
Restrictions: None.

setPlayStreamFocusOn:

- (void)setPlayStreamFocusOn:(NSString *) streamID;

Set the weight of the pull stream priority.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
streamID	NSString *	Stream ID.

Details

Set the weight of the streaming priority.

Use cases: This interface can be used when developers need to prioritize the quality of a audio and video stream in business（do not use in pure audio case）. For example: in class scene, if students pull multiple streams, you can set high priority for teacher stream.
When to call: after called [startPlayingStream].
Caution: By default, all streams have the same weight. Only one stream can be set with high priority, whichever is set last. After the flow is stopped, the initial state is automatically restored, and all flows have the same weight.When the local network is not good, while ensuring the focus flow, other stalls may be caused more.

Available since: 1.1.0
Restrictions: None.

mutePlayStreamAudio:streamID:

- (void)mutePlayStreamAudio:(BOOL) mute streamID:(NSString *) streamID;

Whether the pull stream can receive the specified audio data.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
mute	BOOL	Whether it can receive the audio data of the specified remote user when streaming, "true" means prohibition, "false" means receiving, the default value is "false".
streamID	NSString *	Stream ID.

Details

In the process of real-time audio and video interaction, local users can use this function to control whether to receive audio data from designated remote users when pulling streams as needed. When the developer does not receive the audio receipt, the hardware and network overhead can be reduced.

Use cases: Call this function when developers need to quickly close and restore remote audio. Compared to re-flow, it can greatly reduce the time and improve the interactive experience.
When to call: This function can be called after calling [createEngine].
Caution:

When used together with [muteAllPlayAudioStreams], they can override each other's configurations.
When used together with [muteAllPlayStreamAudio], this function only works when the [muteAllPlayStreamAudio] function is set to false.
After stopping streaming, any properties previously set for this stream such as [setPlayVolume], [mutePlayStreamAudio], [mutePlayStreamVideo] and other streaming-related configurations will become invalid and need to be reset before the next stream is pulled.

Related APIs: You can call the [muteAllPlayStreamAudio] function to control whether to receive all audio data. When the two functions [muteAllPlayStreamAudio] and [mutePlayStreamAudio] are set to false at the same time, the local user can receive the audio data of the remote user when the stream is pulled: 1. When the [muteAllPlayStreamAudio(true)] function is called, it is globally effective, that is, local users will be prohibited from receiving all remote users' audio data. At this time, the [mutePlayStreamAudio] function will not take effect whether it is called before or after [muteAllPlayStreamAudio].2. When the [muteAllPlayStreamAudio(false)] function is called, the local user can receive the audio data of all remote users. At this time, the [mutePlayStreamAudio] function can be used to control whether to receive a single audio data. Calling the [mutePlayStreamAudio(true, streamID)] function allows the local user to receive audio data other than the streamID; calling the [mutePlayStreamAudio(false, streamID)] function allows the local user to receive all audio data.

Available since: 1.1.0

mutePlayStreamVideo:streamID:

- (void)mutePlayStreamVideo:(BOOL) mute streamID:(NSString *) streamID;

Whether the pull stream can receive the specified video data.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
mute	BOOL	Whether it is possible to receive the video data of the specified remote user when streaming, "true" means prohibition, "false" means receiving, the default value is "false". The default value for automatically played streams within the SDK is false.
streamID	NSString *	Stream ID.

Details

In the process of real-time video and video interaction, local users can use this function to control whether to receive video data from designated remote users when pulling streams as needed. When the developer does not receive the video data, the hardware and network overhead can be reduced.

Use cases: This function can be called when developers need to quickly close and resume watching remote video. Compared to re-flow, it can greatly reduce the time and improve the interactive experience.
When to call: This function can be called after calling [createEngine].
Caution:

When used together with [muteAllPlayVideoStreams], they can override each other's configurations.
When used together with [muteAllPlayStreamAudio], this function only works when the [muteAllPlayStreamVideo] function is set to false.
When you mute the video stream, the view remains at the last frame by default, if you need to clear the last frame, please contact ZEGO technical support.
After stopping streaming, any properties previously set for this stream such as [setPlayVolume], [mutePlayStreamAudio], [mutePlayStreamVideo] and other streaming-related configurations will become invalid and need to be reset before the next stream is pulled.

Related APIs: You can call the [muteAllPlayStreamVideo] function to control whether to receive all video data. When the two functions [muteAllPlayStreamVideo] and [mutePlayStreamVideo] are set to false at the same time, the local user can receive the video data of the remote user when the stream is pulled: 1. When the [muteAllPlayStreamVideo(true)] function is called, it will take effect globally, that is, local users will be prohibited from receiving all remote users' video data. At this time, the [mutePlayStreamVideo] function will not take effect whether it is called before or after [muteAllPlayStreamVideo]. 2. When the [muteAllPlayStreamVideo(false)] function is called, the local user can receive the video data of all remote users. At this time, the [mutePlayStreamVideo] function can be used to control whether to receive a single video data. Call the [mutePlayStreamVideo(true, streamID)] function, the local user can receive other video data other than the streamID; call the [mutePlayStreamVideo(false, streamID)] function, the local user can receive all the video data.

Available since: 1.1.0

muteAllPlayStreamAudio:

- (void)muteAllPlayStreamAudio:(BOOL) mute;

Can the pull stream receive all audio data. (When set to true, calling [mutePlayStreamAudio] will not take effect)

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
mute	BOOL	Whether it is possible to receive audio data from all remote users when streaming, "true" means prohibition, "false" means receiving, and the default value is "false".

Details

In the process of real-time audio and video interaction, local users can use this function to control whether to receive audio data from all remote users when pulling streams (including the audio streams pushed by users who have newly joined the room after calling this function). By default, users can receive audio data pushed by all remote users after joining the room. When the developer does not receive the audio receipt, the hardware and network overhead can be reduced.

Use cases: Call this function when developers need to quickly close and restore remote audio. Compared to re-flow, it can greatly reduce the time and improve the interactive experience.
When to call: This function can be called after calling [createEngine].
Caution: This function cannot be used together with [muteAllPlayAudioStreams] throughout the SDK lifecycle.
Related APIs: You can call the [mutePlayStreamAudio] function to control whether to receive a single piece of audio data. When the two functions [muteAllPlayStreamAudio] and [mutePlayStreamAudio] are set to false at the same time, the local user can receive the audio data of the remote user when the stream is pulled: 1. When the [muteAllPlayStreamAudio(true)] function is called, it takes effect globally, that is, local users will be prohibited from receiving audio data from all remote users. At this time, the [mutePlayStreamAudio] function will not take effect no matter if the [mutePlayStreamAudio] function is called before or after [muteAllPlayStreamAudio]. 2. When the [muteAllPlayStreamAudio(false)] function is called, the local user can receive the audio data of all remote users. At this time, the [mutePlayStreamAudio] function can be used to control whether to receive a single audio data. Calling the [mutePlayStreamAudio(true, streamID)] function allows the local user to receive audio data other than the streamID; calling the [mutePlayStreamAudio(false, streamID)] function allows the local user to receive all audio data.

Available since: 2.4.0

muteAllPlayAudioStreams:

- (void)muteAllPlayAudioStreams:(BOOL) mute;

Can the pull stream receive all audio data.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
mute	BOOL	Whether it is possible to receive audio data from all remote users when streaming, "true" means prohibition, "false" means receiving, and the default value is "false".

Details

Use cases: Call this function when developers need to quickly close and restore remote audio. Compared to re-flow, it can greatly reduce the time and improve the interactive experience.
When to call: This function can be called after calling [createEngine].
Caution: This function cannot be used together with [muteAllPlayStreamAudio] throughout the SDK lifecycle.
Related APIs: You can call the [mutePlayStreamAudio] function to control whether to receive a single piece of audio data. When the two functions [muteAllPlayStreamAudio] and [mutePlayStreamAudio] are set to false at the same time, the local user can receive the audio data of the remote user when the stream is pulled: 1. When the [muteAllPlayStreamAudio(true)] function is called, it takes effect globally, that is, local users will be prohibited from receiving audio data from all remote users. At this time, the [mutePlayStreamAudio] function will not take effect no matter if the [mutePlayStreamAudio] function is called before or after [muteAllPlayStreamAudio]. 2. When the [muteAllPlayStreamAudio(false)] function is called, the local user can receive the audio data of all remote users. At this time, the [mutePlayStreamAudio] function can be used to control whether to receive a single audio data. Calling the [mutePlayStreamAudio(true, streamID)] function allows the local user to receive audio data other than the streamID; calling the [mutePlayStreamAudio(false, streamID)] function allows the local user to receive all audio data.

Available since: 3.10.0

muteAllPlayStreamVideo:

- (void)muteAllPlayStreamVideo:(BOOL) mute;

Can the pull stream receive all video data. (When set to true, calling [mutePlayStreamVideo] will not take effect)

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
mute	BOOL	Whether it is possible to receive all remote users' video data when streaming, "true" means prohibition, "false" means receiving, and the default value is "false".

Details

In the process of real-time video and video interaction, local users can use this function to control whether to receive all remote users' video data when pulling the stream (including the video stream pushed by the new user who joins the room after calling this function). By default, users can receive video data pushed by all remote users after joining the room. When the developer does not receive the video data, the hardware and network overhead can be reduced.

Use cases: This function can be called when developers need to quickly close and resume watching remote video. Compared to re-flow, it can greatly reduce the time and improve the interactive experience.
When to call: This function can be called after calling [createEngine].
Caution:

This function cannot be used together with [muteAllPlayVideoStreams] throughout the SDK lifecycle.
When you mute the video stream, the view remains at the last frame by default, if you need to clear the last frame, please contact ZEGO technical support.

Related APIs: You can call the [mutePlayStreamVideo] function to control whether to receive a single piece of video data. When the two functions [muteAllPlayStreamVideo] and [mutePlayStreamVideo] are set to false at the same time, the local user can receive the video data of the remote user when the stream is pulled: 1. When the [muteAllPlayStreamVideo(true)] function is called, it will take effect globally, that is, the local user will be prohibited from receiving all remote users' video data. At this time, the [mutePlayStreamVideo] function will not take effect whether it is called before or after [muteAllPlayStreamVideo]. 2. When the [muteAllPlayStreamVideo(false)] function is called, the local user can receive the video data of all remote users. At this time, the [mutePlayStreamVideo] function can be used to control whether to receive a single video data. Call the [mutePlayStreamVideo(true, streamID)] function, the local user can receive other video data other than the streamID; call the [mutePlayStreamVideo(false, streamID)] function, the local user can receive all the video data.

Available since: 2.4.0

muteAllPlayVideoStreams:

- (void)muteAllPlayVideoStreams:(BOOL) mute;

Can the pull stream receive all video data.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
mute	BOOL	Whether it is possible to receive all remote users' video data when streaming, "true" means prohibition, "false" means receiving, and the default value is "false".

Details

Use cases: This function can be called when developers need to quickly close and resume watching remote video. Compared to re-flow, it can greatly reduce the time and improve the interactive experience.
When to call: This function can be called after calling [createEngine].
Caution:

This function cannot be used together with [muteAllPlayStreamVideo] throughout the SDK lifecycle.
When you mute the video stream, the view remains at the last frame by default, if you need to clear the last frame, please contact ZEGO technical support.

Related APIs: You can call the [mutePlayStreamVideo] function to control whether to receive a single piece of video data.

Available since: 3.10.0

enableHardwareDecoder:

- (void)enableHardwareDecoder:(BOOL) enable;

Enables or disables hardware decoding.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	Whether to turn on hardware decoding switch, true: enable hardware decoding, false: disable hardware decoding.

Details

Control whether hardware decoding is used when playing streams, with hardware decoding enabled the SDK will use the GPU for decoding, reducing CPU usage.

Use cases: If developers find that the device heats up badly when playing large resolution audio and video streams during testing on some models, consider calling this function to enable hardware decoding.
Default value: Hardware decoding is disabled by default when this interface is not called.
When to call: This function needs to be called after [createEngine] creates an instance.
Caution: Need to be called before calling [startPlayingStream], if called after playing the stream, it will only take effect after stopping the stream and re-playing it. Once this configuration has taken effect, it will remain in force until the next call takes effect.

Available since: 1.1.0
Restrictions: None.

enableCheckPoc:

- (void)enableCheckPoc:(BOOL) enable;

Enables or disables frame order detection.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	Whether to turn on frame order detection, true: enable check poc, false: disable check poc.

Details

Control whether to turn on frame order detection.

Use cases: Turning on frame order detection when pulling cdn's stream will prevent splash screens.
Default value: Turn on frame order detection by default when this interface is not called.
When to call: This function needs to be called after [createEngine] creates an instance.
Caution: Turn off frame order detection during playing stream may result in a brief splash screen.

Available since: 1.1.0
Restrictions: None.

isVideoDecoderSupported:

- (BOOL)isVideoDecoderSupported:(ZegoVideoCodecID) codecID;

Whether the specified video decoding format is supported.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
codecID	ZegoVideoCodecID	Video codec id.Required: Yes.

Details

Whether the specified video decoding is supported depends on the following aspects: whether the hardware model supports hard decoding, whether the performance of the hardware model supports soft decoding, and whether the SDK includes the decoding module.

When to call: After creating the engine.
Caution: It is recommended that users call this interface to obtain the H.265 decoding support capability before pulling the H.265 stream. If it is not supported, the user can pull the stream of other encoding formats, such as H.264.

Available since: 2.12.0

Return

Whether the specified video decoding format is supported; true means supported, you can use this decoding format for playing stream; false means not supported, the SDK does not recommend users to play streams of this encoding format. If users force the play, low frame rates may occur.

isVideoDecoderSupported:codecBackend:

- (int)isVideoDecoderSupported:(ZegoVideoCodecID) codecID codecBackend:(ZegoVideoCodecBackend) codecBackend;

Whether the specified video decoding format is supported.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
codecID	ZegoVideoCodecID	Video codec id. Required: Yes.
codecBackend	ZegoVideoCodecBackend	Backend implementation of decoder. Required: Yes.

Details

When to call: After creating the engine.
Caution: It is recommended that users call this interface to obtain the H.265 decoding support capability before pulling the H.265 stream. If it is not supported, the user can pull the stream of other encoding formats, such as H.264.

Available since: 3.0.0

Return

Whether the specified video decoding format is supported; 0 means not supported, and the decoding format cannot be used for play stream; 1 means support, you can use this decoding format for playing stream; 2 means not confirmed, it is recommended to call this interface later.

getVideoDecoderSupported:codecBackend:callback:

- (void)getVideoDecoderSupported:(ZegoVideoCodecID) codecID codecBackend:(ZegoVideoCodecBackend) codecBackend callback:(nullable ZegoPlayerGetVideoDecoderSupportedCallback) callback;

Whether the specified video decoding type and implementation are supported.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
codecID	ZegoVideoCodecID	Video codec id. Required: Yes.
codecBackend	ZegoVideoCodecBackend	Backend implementation of decoder. Required: Yes.
callback	nullable ZegoPlayerGetVideoDecoderSupportedCallback	Results of get video decoder supported.

Details

When to call: After creating the engine.
Caution: It is recommended that users call this interface to obtain the H.265 decoding support capability before pulling the H.265 stream. If it is not supported, the user can pull the stream of other encoding formats, such as H.264.

Available since: 3.23.0

setPlayStreamsAlignmentProperty:

- (void)setPlayStreamsAlignmentProperty:(ZegoStreamAlignmentMode) mode;

Set the play stream alignment properties.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
mode	ZegoStreamAlignmentMode	Setting the stream alignment mode.

Details

When playing at the streaming end, control whether the playing RTC stream needs to be accurately aligned. If necessary, all the streams that contain precise alignment parameters will be aligned; if not, all streams are not aligned. Use case: It is often used in scenes that require to play multiple streams alignment such as KTV to ensure that users can switch between singing anchors, ordinary Maishangyu chat anchors, and Maixia audiences at any time during use.

Default value: If this interface is not called, the default is not aligned.
When to call: Called after [createEngine]. Call the interface repeatedly, and the latest setting is valid.
Related APIs: Set the precise alignment parameter of the stream channel [setStreamAlignmentProperty].

Available since: 2.14.0

enableVideoSuperResolution:enable:

- (void)enableVideoSuperResolution:(NSString *) streamID enable:(BOOL) enable;

Enable video super resolution.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
streamID	NSString *	The ID of the stream that currently needs to turn on or off overscore.
enable	BOOL	Whether to enable super resolution, it is not enabled by default.

Details

Whether to enable video super resolution when playing stream, the resolution of the played video can be doubled at the stream playing end through video super resolution. For example, the original resolution is 640x360, and the super-resolution is 1280x720.

Use cases: Live streaming scenario.
When to call: Video super resolution is only valid for playing stream video. Needs to be called after [initVideoSuperResolution].
Caution:

This function requires a special package, please contact ZEGO technical support;
This function will consume extra system resources. In order to ensure user experience, ZEGO can only enable video super resolution for one stream, and the original video resolution is not recommended to exceed 640 × 360.

Related callbacks: Developer can use the [onPlayerVideoSuperResolutionUpdate] callback to monitor the video super resolution status change.

Available since: 3.0.0

initVideoSuperResolution

- (void)initVideoSuperResolution;

Init video super resolution.

Declared in ZegoExpressEngine.h

After the super resolution is initialized, the super resolution function can be used normally

Use cases: Live streaming scenario.
When to call: Video super resolution is only valid for playing stream video. Needs to be called after [createEngine].
Caution:

Initializing the video screen is divided into time-consuming operations, and frequent initialization and de-initialization are not recommended;
This function requires a special package, please contact ZEGO technical support.

Available since: 3.3.0

uninitVideoSuperResolution

- (void)uninitVideoSuperResolution;

Uninit video super resolution.

Declared in ZegoExpressEngine.h

After deinitializing the super resolution, the SDK will release the resources occupied by the super resolution and make the super resolution function unavailable.

Use cases: Live streaming scenario.
When to call: Needs to be called after [initVideoSuperResolution].
Caution: Initializing the video screen is divided into time-consuming operations, and frequent initialization and de-initialization are not recommended.

Available since: 3.3.0

updatePlayingCanvas:canvas:

- (int)updatePlayingCanvas:(NSString *) streamID canvas:(ZegoCanvas *) canvas;

Update playing canvas.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
streamID	NSString *	Stream ID, a string of up to 256 characters. Caution: Only support numbers, English characters and '-', '_'.
canvas	ZegoCanvas *	The view used to display the play audio and video stream's image. When the view is set to [nil], no video is displayed, only audio is played.

Details

This interface will update playing view. Use case: The user can call this function to update canvas display video.

When to call: After calling the [startPlayingStream] interface.
Caution: None.

Restrictions: None.

Return

Error code, please refer to the error codes document https://doc-en.zego.im/en/5548.html for details.

setPlayingCanvas:updateType:canvas:

- (int)setPlayingCanvas:(NSString *) streamID updateType:(ZegoViewUpdateType) updateType canvas:(ZegoCanvas *) canvas;

Setting up playing canvas.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
streamID	NSString *	Stream ID, a string of up to 256 characters. Caution: Only support numbers, English characters and '-', '_'.
updateType	ZegoViewUpdateType	Update type.
canvas	ZegoCanvas *	The view used to display the play audio and video stream's image.

Details

This interface can add, delete and update playing view. Use case: The user can call this function to add, delete and update canvas display video.

When to call: After calling the [startPlayingStream] interface.
Caution: None.

Restrictions: None.

Return

Error code, please refer to the error codes document https://doc-en.zego.im/en/5548.html for details.

startMixerTask:callback:

- (void)startMixerTask:(ZegoMixerTask *) task callback:(nullable ZegoMixerStartCallback) callback;

Starts a stream mixing task.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
task	ZegoMixerTask *	Mixing task object. Required: Yes.
callback	nullable ZegoMixerStartCallback	Start notification of mixing task results.Required: No. Caution: Passing [nil] means not receiving callback notifications.

Details

Initiate a mixing stream request to the ZEGO RTC server, the server will look for the stream currently being pushed, and mix the layers according to the parameters of the mixing stream task requested by the SDK. When you need to update a mixing task, that is, when the input stream increases or decreases, you need to update the input stream list. At this time, you can update the field of the [ZegoMixerTask] object inputList and call this function again to pass in the same [ZegoMixerTask] object to update the mixing task.

Use cases: It is often used when multiple video images are required to synthesize a video using mixed streaming, such as education, live broadcast of teacher and student images.
When to call: After calling [loginRoom] to log in to the room.
Caution: Due to the performance considerations of the client device, the SDK muxing is to start the mixing task on the ZEGO RTC server for mixing. If an exception occurs when the mixing task is requested to start, for example, the most common mixing input stream does not exist, the error code will be given from the callback callback. If a certain input stream does not exist in the middle, the muxing task will automatically retry to pull this input stream for 90 seconds, and will not retry after 90 seconds. If all input streams no longer exist, the server will automatically stop the mixing task after 90 seconds.
Related callbacks: [OnMixerRelayCDNStateUpdate] can be used to obtain the CDN status update notification of the mixed stream repost, and the sound update notification of each single stream in the mixed stream can be obtained through [onMixerSoundLevelUpdate].
Related APIs: the mixing task can be stopped by the [stopMixerTask] function.

Available since: 1.2.1
Restrictions: None.

stopMixerTask:callback:

- (void)stopMixerTask:(ZegoMixerTask *) task callback:(nullable ZegoMixerStopCallback) callback;

Stops a stream mixing task.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
task	ZegoMixerTask *	Mixing task object. Required: Yes.
callback	nullable ZegoMixerStopCallback	Stop stream mixing task result callback notification.Required: No. Caution: Passing [nil] means not receiving callback notifications.

Details

Initiate a request to end the mixing task to the ZEGO RTC server.

Use cases: It is often used when multiple video images are required to synthesize a video using mixed streaming, such as education, live broadcast of teacher and student images.
When to call: After calling [startMixerTask] to start mixing.
Caution: If the developer starts the next mixing task without stopping the previous mixing task, the previous mixing task will not automatically stop until the input stream of the previous mixing task does not exist for 90 seconds. Before starting the next mixing task, you should stop the previous mixing task, so that when an anchor has already started the next mixing task to mix with other anchors, the audience is still pulling the output stream of the previous mixing task.
Related APIs: You can start mixing by using the [startMixerTask] function.

Available since: 1.2.1
Restrictions: None.

startAutoMixerTask:callback:

- (void)startAutoMixerTask:(ZegoAutoMixerTask *) task callback:(nullable ZegoMixerStartCallback) callback;

Starts an auto stream mixing task.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
task	ZegoAutoMixerTask *	Auto mix stream task object
callback	nullable ZegoMixerStartCallback	Start auto mix stream task result callback notification

Details

Local users can use this function to start an auto stream mixing task, all streams in a room wil be mixed. Currently, only audio streams can be mixed. When auto stream mixing is enabled, the audio of all streams in the room is automatically mixed, and any further pushed streams in the room are automatically mixed into the final output stream.

Use cases: Often used in voice chat room scenarios.
When to call: After the engine is created, user can call this function to enable auto stream mixing in the target room if the target room has already been created
Caution: Before starting the next auto stream mixing task in the same room, call [stopAutoMixerTask] function to end the last auto stream mixing task. Otherwise, when one anchor has started the next auto stream mixing task and other anchors have started the next auto stream mixing task, the audience still pulls the output stream of the first auto stream mixing task. If the user does not end the current auto stream mixing task, the task will automatically end after the room does not exist or the input streams do not exist for 90 seconds.
Related callbacks: Users can obtain the execution result of the function through [ZegoMixerStartCallback] callback.Users can get automatic mixed flow information through [onAutoMixerSoundLevelUpdate] callback.
Related APIs: Users can call [stopAutoMixerTask] function to stop an auto stream mixing task.

Available since: 2.10.0
Restrictions: Please refer to https://docs.zegocloud.com/article/7611 or contact ZEGO technical support.

stopAutoMixerTask:callback:

- (void)stopAutoMixerTask:(ZegoAutoMixerTask *) task callback:(nullable ZegoMixerStopCallback) callback;

Stops an auto stream mixing task.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
task	ZegoAutoMixerTask *	Auto mix stream task object
callback	nullable ZegoMixerStopCallback	Stop auto mix stream task result callback notification

Details

Local users can use this function to stop an auto stream mixing task.

Use cases: Often used in voice chat room scenarios.
When to call: Call this function after [startAutoMixerTask] function is called to start an auto stream mixing task.
Caution: Before calling [startAutoMixerTask] function to start the next auto stream mixing task in the same room, call this function to end the last auto stream mixing task. Otherwise, when one anchor has started the next auto stream mixing task and other anchors have started the next auto stream mixing task, the audience still pulls the output stream of the first auto stream mixing task. If the user does not end the current auto stream mixing task, the task will automatically end after the room does not exist or the input streams do not exist for 90 seconds.
Related callbacks: Users can obtain the execution result of the function through [ZegoMixerStopCallback] callback.
Related APIs: Users can call [startAutoMixerTask] function to start an auto stream mixing task.

Available since: 2.10.0

muteMicrophone:

- (void)muteMicrophone:(BOOL) mute;

Mutes or unmutes the microphone.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
mute	BOOL	Whether to mute (disable) the microphone, `true`: mute (disable) microphone, `false`: enable microphone.

Details

This function is used to control whether to use the collected audio data. Mute (turn off the microphone) will use the muted data to replace the audio data collected by the device for streaming. At this time, the microphone device will still be occupied. Use case: Users can call this interface by only turning off the human voice collected by the microphone and not turning off the music sound of the media player. This interface affects [onBeforeAudioPrepAudioData].

Default value: The default is false, which means no muting.
When to call: After creating the engine [createEngine].
Related APIs: Developers who want to control whether to use microphone on the UI should use this function to avoid unnecessary performance overhead by using the [enableAudioCaptureDevice]. You can use [isMicrophoneMuted] to check if the microphone is muted.

Available since: 1.1.0
Restrictions: None.

isMicrophoneMuted

- (BOOL)isMicrophoneMuted;

Checks whether the microphone is muted.

Declared in ZegoExpressEngine.h

Used to determine whether the microphone is set to mute.

When to call: After creating the engine [createEngine].
Related APIs: [muteMicrophone].

Available since: 1.1.0
Restrictions: None.

Whether the microphone is muted; true: the microphone is muted; false: the microphone is enable (not muted).

muteSpeaker:

- (void)muteSpeaker:(BOOL) mute;

Mutes or unmutes the audio output speaker.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
mute	BOOL	Whether to mute (disable) speaker audio output, `true`: mute (disable) speaker audio output, `false`: enable speaker audio output.

Details

After mute speaker, all the SDK sounds will not play, including playing stream, mediaplayer, etc.

Default value: The default is false, which means no muting.
When to call: After creating the engine [createEngine].

Available since: 1.1.0
Restrictions: None.

isSpeakerMuted

- (BOOL)isSpeakerMuted;

Checks whether the audio output speaker is muted.

Declared in ZegoExpressEngine.h

Used to determine whether the audio output is muted.

When to call: After creating the engine [createEngine].
Related APIs: [muteSpeaker].

Available since: 1.1.0
Restrictions: None.

Whether the speaker is muted; true: the speaker is muted; false: the speaker is enable (not muted).

getAudioDeviceList:

- (NSArray<ZegoDeviceInfo *> *)getAudioDeviceList:(ZegoAudioDeviceType) deviceType;

Gets a list of audio devices.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
deviceType	ZegoAudioDeviceType	Audio device type

Details

Only for Windows / macOS / Linux

Return

Audo device List

getDefaultAudioDeviceID:

- (NSString *)getDefaultAudioDeviceID:(ZegoAudioDeviceType) deviceType;

Get the device ID of the default audio device.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
deviceType	ZegoAudioDeviceType	Audio device type

Details

Only for Windows / macOS / Linux

Return

Default Audio device ID

useAudioDevice:deviceType:

- (void)useAudioDevice:(NSString *) deviceID deviceType:(ZegoAudioDeviceType) deviceType;

Chooses to use the specified audio device.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
deviceID	NSString *	ID of a device obtained by [getAudioDeviceList]
deviceType	ZegoAudioDeviceType	Audio device type

Details

Chooses to use the specified audio device.

When to call: After creating the engine [createEngine].

Available since: 1.1.0
Restrictions: Only supports Windows / macOS / Linux

getAudioDeviceVolume:deviceType:

- (int)getAudioDeviceVolume:(NSString *) deviceID deviceType:(ZegoAudioDeviceType) deviceType;

Get volume for the specified audio device.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
deviceID	NSString *	ID of a device obtained by [getAudioDeviceList]
deviceType	ZegoAudioDeviceType	Audio device type

Details

Get volume for the specified audio device. Only for Windows / macOS / Linux

Return

Device volume

setAudioDeviceVolume:deviceType:volume:

- (void)setAudioDeviceVolume:(NSString *) deviceID deviceType:(ZegoAudioDeviceType) deviceType volume:(int) volume;

Set volume for the specified audio device.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
deviceID	NSString *	ID of a device obtained by [getAudioDeviceList]
deviceType	ZegoAudioDeviceType	Audio device type
volume	int	Device volume

Details

The direct operating system device may fail due to system restrictions. Please use [setCaptureVolume] and [setPlayVolume] first to adjust the volume of publish and play streams. Only for Windows / macOS / Linux

startAudioDeviceVolumeMonitor:deviceType:

- (void)startAudioDeviceVolumeMonitor:(NSString *) deviceID deviceType:(ZegoAudioDeviceType) deviceType;

Turn on audio device volume monitoring.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
deviceID	NSString *	ID of a device obtained by [getAudioDeviceList]
deviceType	ZegoAudioDeviceType	Audio device type

Details

Starts the audio device volume monitor. When the volume of the device changes, the changed volume will be called back via [onAudioDeviceVolumeChanged].

Caution: Currently, only one audio output device and one audio input device are supported to be monitored at the same time. When this API is called multiple times and the same device type is set, the device ID set to this API during the last call will be overwritten.
When to call: After creating the engine via [createEngine].
Platform differences: Only supports Windows and macOS.
Related APIs: When you no longer need to monitor the device volume, please call [stopAudioDeviceVolumeMonitor] to stop monitoring.

Available since: 1.1.0

stopAudioDeviceVolumeMonitor:deviceType:

- (void)stopAudioDeviceVolumeMonitor:(NSString *) deviceID deviceType:(ZegoAudioDeviceType) deviceType;

Turn off audio device volume monitoring. Only for Windows/macOS.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
deviceID	NSString *	ID of a device obtained by [getAudioDeviceList]
deviceType	ZegoAudioDeviceType	Audio device type

Details

Stops the audio device volume monitor.

When to call: After creating the engine via [createEngine], and when you no longer need to monitor the device volume.
Platform differences: Only supports Windows and macOS.

Available since: 1.1.0

muteAudioDevice:deviceType:mute:

- (void)muteAudioDevice:(NSString *) deviceID deviceType:(ZegoAudioDeviceType) deviceType mute:(BOOL) mute;

Mutes or unmutes the audio device.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
deviceID	NSString *	ID of a device obtained by [getAudioDeviceList]
deviceType	ZegoAudioDeviceType	Audio device type
mute	BOOL	Whether to mute the audio device; `true` means to mute the audio device; `false` means to unmute the audio device.

Details

Only for Windows / macOS / Linux

setAudioDeviceMode:

- (void)setAudioDeviceMode:(ZegoAudioDeviceMode) deviceMode;

Set the audio device mode.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
deviceMode	ZegoAudioDeviceMode	Audio device mode

Details

Select audio equipment mode according to the need of the scene (only supported by Android and iOS).

Use cases: In the case of KTV, the General mode must be used, but in the language room, the Communication2 or Communication3 mode is required in order to avoid the sound of third-party music being collected. For details on how to set the audio device mode, see https://doc-zh.zego.im/faq/AudioDeviceMod?product=ExpressVideo&platform=macos
When to call: After creating the engine [createEngine].
Caution: This interface triggers startup switchover of the device. You are advised not to invoke this interface frequently to avoid unnecessary overhead and hardware problems. This interface may cause the volume mode to switch between call and media. If the media volume is inconsistent with the call volume, the volume may change.

Available since: 2.22.0

isAudioDeviceMuted:deviceType:

- (BOOL)isAudioDeviceMuted:(NSString *) deviceID deviceType:(ZegoAudioDeviceType) deviceType;

Check if the audio device is muted.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
deviceID	NSString *	ID of a device obtained by [getAudioDeviceList]
deviceType	ZegoAudioDeviceType	Audio device type

Details

Only for Windows / macOS / Linux

Return

Whether the audio device is muted; true means the audio device is muted; false means the audio device is not muted.

enableAudioCaptureDevice:

- (void)enableAudioCaptureDevice:(BOOL) enable;

Enables or disables the audio capture device.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	Whether to enable the audio capture device, `true`: enable audio capture device, `false`: disable audio capture device.

Details

This function is used to control whether to use the audio collection device. When the audio collection device is turned off, the SDK will no longer occupy the audio device. Of course, if the stream is being published at this time, by default, mute data will be used as audio data for streaming. not support Linux.

Use cases: When the user never needs to use the audio, you can call this function to close the audio collection.
Default value: The default is true.
When to call: After creating the engine [createEngine].
Related APIs: Turning off or turning on the microphone on the hardware is a time-consuming operation, and there is a certain performance overhead when the user performs frequent operations. [muteMicrophone] is generally recommended.

Available since: 1.1.0
Restrictions: None.

enableAudioCaptureDeviceAsync:callback:

- (void)enableAudioCaptureDeviceAsync:(BOOL) enable callback:(ZegoAudioCaptureDeviceEnableCallback) callback;

Asynchronous enables or disables the audio capture device.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	Whether to enable the audio capture device, `true`: enable audio capture device, `false`: disable audio capture device.
callback	ZegoAudioCaptureDeviceEnableCallback	The callback of this enable or disable result.

Details

Use cases: When the user never needs to use the audio, you can call this function to close the audio collection.
Default value: The default is true.
When to call: After creating the engine [createEngine].
Related APIs: Turning off or turning on the microphone on the hardware is a time-consuming operation, and there is a certain performance overhead when the user performs frequent operations. [muteMicrophone] is generally recommended.

Available since: 3.23.0
Restrictions: None.

getAudioRouteType

- (ZegoAudioRoute) getAudioRouteType;

get current audio route type.

Declared in ZegoExpressEngine.h

Audio routing refers to the audio output device that an app uses to play audio, and common audio routes are: speakers, handsets, headphones, Bluetooth devices, and so on.

When to call: After creating the engine [createEngine].
Related APIs: Set audio route to speaker [setAudioRouteToSpeaker].

Available since: 1.1.0
Restrictions: Not supported under win or mac platforms.

setAudioRouteToSpeaker:

- (void)setAudioRouteToSpeaker:(BOOL) defaultToSpeaker;

Whether to use the built-in speaker to play audio.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
defaultToSpeaker	BOOL	Whether to use the built-in speaker to play sound, `true`: use the built-in speaker to play sound, `false`: use the highest priority audio output device scheduled by the current system to play sound

Details

Whether to use the speaker to play audio, when you choose not to use the built-in speaker to play the sound, the SDK will select the audio output device with the highest current priority to play the sound according to the system schedule, and common audio routes are: handsets, headphones, Bluetooth devices, and so on.

When to call: After creating the engine [createEngine].
Related APIs: Get the current audio route [getAudioRouteType].

Available since: 1.1.0
Restrictions: Only switching between the earpiece and the speaker is supported. If it is a Bluetooth headset or a wired headset, it does not support routing to the speaker through this interface.

enableCamera:

- (void)enableCamera:(BOOL) enable;

Turns on/off the camera.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	Whether to turn on the camera, `true`: turn on camera, `false`: turn off camera

Details

This function is used to control whether to start the capture of the camera. After the camera is turned off, the video capture will not be performed. At this time, there will be no video data for local preview and push streaming.

Default value: The default is true which means the camera is turned on.
When to call: After creating the engine [createEngine].
Caution: In the case of using the custom video capture function [enableCustomVideoCapture], since the developer has taken over the video data capture, the SDK is no longer responsible for the video data capture, but this function still affects whether to encode or not. Therefore, when developers use custom video capture, please ensure that the value of this function is true.

Available since: 1.1.0
Restrictions: None.

enableCamera:channel:

- (void)enableCamera:(BOOL) enable channel:(ZegoPublishChannel) channel;

Turns on/off the camera (for the specified channel).

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	Whether to turn on the camera, `true`: turn on camera, `false`: turn off camera
channel	ZegoPublishChannel	Publishing stream channel

Details

Default value: The default is true which means the camera is turned on.
When to call: After creating the engine [createEngine].
Caution: In the case of using the custom video capture function [enableCustomVideoCapture], since the developer has taken over the video data capture, the SDK is no longer responsible for the video data capture, but this function still affects whether to encode or not. Therefore, when developers use custom video capture, please ensure that the value of this function is true.

Available since: 1.1.0
Restrictions: None.

enableCamera:notifyMode:channel:

- (void)enableCamera:(BOOL) enable notifyMode:(ZegoExpNotifyDeviceStateMode) notifyMode channel:(ZegoPublishChannel) channel;

Turns on/off the camera (for the specified channel).

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	Whether to turn on the camera, `true`: turn on camera, `false`: turn off camera
notifyMode	ZegoExpNotifyDeviceStateMode	Mode for notifying the local device status.
channel	ZegoPublishChannel	Publishing stream channel

Details

Default value: The default is true which means the camera is turned on.
When to call: After creating the engine [createEngine].
Caution: In the case of using the custom video capture function [enableCustomVideoCapture], since the developer has taken over the video data capture, the SDK is no longer responsible for the video data capture, but this function still affects whether to encode or not. Therefore, when developers use custom video capture, please ensure that the value of this function is true.

Available since: 3.20.0
Restrictions: None.

useFrontCamera:

- (void)useFrontCamera:(BOOL) enable;

Switches to the front or the rear camera.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	[ZegoVideoSourceTypeCamera] if or not use front camera, `true`: use the front camera, `false`: use the the rear camera.

Details

This function controls whether [ZegoVideoSourceTypeCamera] uses the front camera or the rear camera (only supported by Android and iOS).

Default value: The default is true which means the front camera is used.
When to call: After creating the engine [createEngine].
Caution: When the custom video capture function [enableCustomVideoCapture] is turned on, since the developer has taken over the video data capture, the SDK is no longer responsible for the video data capture, and this function is no longer valid.

Available since: 1.1.0
Restrictions: None.

useFrontCamera:channel:

- (void)useFrontCamera:(BOOL) enable channel:(ZegoPublishChannel) channel;

Switches to the front or the rear camera (for the specified channel).

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	[ZegoVideoSourceTypeCamera] if or not use front camera, `true`: use the front camera, `false`: use the the rear camera.
channel	ZegoPublishChannel	Publishing stream channel.

Details

This function controls whether [ZegoVideoSourceTypeCamera] uses the front camera or the rear camera (only supported by Android and iOS).

Default value: The default is true which means the front camera is used.
When to call: After creating the engine [createEngine].
Caution: When the custom video capture function [enableCustomVideoCapture] is turned on, since the developer has taken over the video data capture, the SDK is no longer responsible for the video data capture, and this function is no longer valid.

Available since: 1.1.0
Restrictions: None.

isCameraFocusSupported:

- (BOOL)isCameraFocusSupported:(ZegoPublishChannel) channel;

Whether the camera supports focusing.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
channel	ZegoPublishChannel	Publishing stream channel

Details

Whether the camera supports focusing.

Trigger: Called after turn on preview [startPreview].
Caution: Need to start the camera successfully.

Available since: 2.14.0

Return

Whether to support focus, support is true, not support is false.

setCameraFocusMode:channel:

- (void)setCameraFocusMode:(ZegoCameraFocusMode) mode channel:(ZegoPublishChannel) channel;

Set the camera focus mode.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
mode	ZegoCameraFocusMode	focus mode.
channel	ZegoPublishChannel	Publishing stream channel

Details

Set the camera focus mode.

Trigger: Called after turn on preview [startPreview].

Available since: 2.14.0
Restrictions: Currently only supports iOS and Android platforms.

setCameraFocusPointInPreviewX:y:channel:

- (void)setCameraFocusPointInPreviewX:(float) x y:(float) y channel:(ZegoPublishChannel) channel;

Set the focus point in the preview view.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
x	float	Normalized X axis coordinate value, effective value [0,1].
y	float	Normalized Y axis coordinate value, effective value [0,1].
channel	ZegoPublishChannel	Publishing stream channel

Details

Set the focus point in the preview view. (x, y) are the normalized coordinates in the preview view, that is, the ratio of the position of the focus point relative to the preview view and the width and height of the preview view. The upper left corner is (0, 0).

Trigger: Called after turn on preview [startPreview].
Caution: Every time the camera restarts the acquisition, the settings will become invalid and need to be reset.

Available since: 2.14.0
Restrictions: Currently only supports iOS and Android platforms.

setCameraExposureMode:channel:

- (void)setCameraExposureMode:(ZegoCameraExposureMode) mode channel:(ZegoPublishChannel) channel;

Set the camera exposure mode.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
mode	ZegoCameraExposureMode	Exposure mode.
channel	ZegoPublishChannel	Publishing stream channel

Details

Set the camera exposure mode.

Trigger: Called after turn on preview [startPreview].

Available since: 2.14.0
Restrictions: Currently only supports iOS and Android platforms.

setCameraExposurePointInPreviewX:y:channel:

- (void)setCameraExposurePointInPreviewX:(float) x y:(float) y channel:(ZegoPublishChannel) channel;

Set the exposure point in the preview view.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
x	float	Normalized X axis coordinate value, effective value [0,1].
y	float	Normalized Y axis coordinate value, effective value [0,1].
channel	ZegoPublishChannel	Publishing stream channel

Details

Set the exposure point in the preview view. (x, y) are the normalized coordinates in the preview view, that is, the ratio of the position of the exposure point relative to the preview view and the width and height of the preview view. The upper left corner is (0, 0).

Trigger: Called after turn on preview [startPreview].
Caution: Every time the camera restarts the acquisition, the settings will become invalid and need to be reset.

Available since: 2.14.0
Restrictions: Currently only supports iOS and Android platforms.

setCameraExposureCompensation:

- (void)setCameraExposureCompensation:(float) value;

Set the camera exposure compensation value.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
value	float	Camera exposure, the value range is [-1,1], the default 0, -1 tends to darken, 1 tends to brighten.

Details

Set the camera exposure compensation value.

Use cases: User can call this function to set the camera exposure compensation value.
When to call /Trigger: Called this function after calling [startPublishingStream] or [startPreview].
Caution: The setting will be invalid when the camera is restarted.
Platform differences: Only supports iOS and Android.

Available since: 2.10.0
Restrictions: None.

setCameraExposureCompensation:channel:

- (void)setCameraExposureCompensation:(float) value channel:(ZegoPublishChannel) channel;

Set the camera exposure compensation value and support spedifying the publish channel.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
value	float	Camera exposure, the value range is [-1,1], the default 0, -1 tends to darken, 1 tends to brighten.
channel	ZegoPublishChannel	Publishing stream channel

Details

Set the camera exposure compensation value.

Use cases: User can call this function to set the camera exposure compensation value.
When to call /Trigger: Called this function after calling [startPublishingStream] or [startPreview].
Caution: The setting will be invalid when the camera is restarted.
Platform differences: Only supports iOS and Android.

Available since: 2.10.0
Restrictions: None.

setCameraZoomFactor:

- (void)setCameraZoomFactor:(float) factor;

Set the zoom factor of the camera. Every time the camera is restarted, the camera zoom factor will return to the initial value (1.0).

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
factor	float	The zoom factor of the camera, the minimum value is 1.0, and the maximum value is the return value of [getCameraMaxZoomFactor].

Details

Set the camera zoom factor. Every time the camera is restarted, the camera zoom factor will be restored to its initial value.

When to call: After creating the engine [createEngine].

Available since: 1.20.0
Restrictions: The settings will not take effect until the camera is started.

setCameraZoomFactor:channel:

- (void)setCameraZoomFactor:(float) factor channel:(ZegoPublishChannel) channel;

Set the zoom factor of the camera and support specifying the publish channel. Every time the camera is restarted, the camera zoom factor will return to the initial value (1.0).

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
factor	float	The zoom factor of the camera, the minimum value is 1.0, and the maximum value is the return value of [getCameraMaxZoomFactor].
channel	ZegoPublishChannel	Publishing stream channel

Details

Set the camera zoom factor. Every time the camera is restarted, the camera zoom factor will be restored to its initial value.

When to call: After creating the engine [createEngine].

Available since: 1.20.0
Restrictions: The settings will not take effect until the camera is started.

getCameraMaxZoomFactor

- (float)getCameraMaxZoomFactor;

Get the maximum zoom factor of the camera.

Declared in ZegoExpressEngine.h

Set the camera zoom factor. Every time the camera is restarted, the camera zoom factor will be restored to its initial value.

When to call: This is only available after the camera has been successfully started, and can generally be called when the captured first frame is received [onPublisherCapturedVideoFirstFrame] callback.

Available since: 1.20.0
Restrictions: None.

The maximum zoom factor of the camera.

getCameraMaxZoomFactor:

- (float)getCameraMaxZoomFactor:(ZegoPublishChannel) channel;

Get the maximum zoom factor of the camera and support specifying the publish channel.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
channel	ZegoPublishChannel	Publishing stream channel

Details

Set the camera zoom factor. Every time the camera is restarted, the camera zoom factor will be restored to its initial value.

When to call: This is only available after the camera has been successfully started, and can generally be called when the captured first frame is received [onPublisherCapturedVideoFirstFrame] callback.

Available since: 1.20.0
Restrictions: None.

Return

The maximum zoom factor of the camera.

enableCameraAdaptiveFPS:minFPS:maxFPS:channel:

- (void)enableCameraAdaptiveFPS:(BOOL) enable minFPS:(int) minFPS maxFPS:(int) maxFPS channel:(ZegoPublishChannel) channel;

Enable camera adaptive frame rate.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	Whether to enable camera adaptive frame rate. true means on, false means off.Off by default.
minFPS	int	Desired minimum frame rate, 15 recommended. Unit: fps.
maxFPS	int	Desired minimum frame rate, 25 recommended. Unit: fps.
channel	ZegoPublishChannel	Publishing stream channel.

Details

After enabling, the SDK matches the capture frame rate range supported by the camera according to the set frame rate range, and dynamically adjusts the capture frame rate of the camera according to the ambient brightness within this range to improve the screen brightness when the set frame rate is too high.

Use cases: The frame rate set by the user on the streaming end is too high, and the ambient lighting is low, so the subject cannot be displayed or recognized normally. For example, live broadcast scenes with high exposure requirements.
When to call: After creating the engine [createEngine], before the camera starts.
Caution: Takes When calling [setVideoConfig] to set the frame rate lower than the expected minimum frame rate, the frame rate value set by [setVideoConfig] will be used. Due to the different hardware and algorithm strategies of different mobile phone manufacturers, the effect of this interface is different on different models or on the front and rear cameras of the same model.
Related APIs: Through [setVideoConfig], you can set the camera capture frame rate and the encoder encoding frame rate.

Available since: 2.20.0

useVideoDevice:

- (void)useVideoDevice:(NSString *) deviceID;

Chooses to use the specified video device.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
deviceID	NSString *	ID of a device obtained by [getVideoDeviceList]

Details

Only for Windows / macOS / Linux

useVideoDevice:channel:

- (void)useVideoDevice:(NSString *) deviceID channel:(ZegoPublishChannel) channel;

Chooses to use the specified video device (for the specified channel).

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
deviceID	NSString *	ID of a device obtained by [getVideoDeviceList]
channel	ZegoPublishChannel	Publishing stream channel

Details

Only for Windows / macOS / Linux

getVideoDeviceList

- (NSArray<ZegoDeviceInfo *> *)getVideoDeviceList;

Gets a list of video devices.

Declared in ZegoExpressEngine.h

Only for Windows / macOS / Linux

Video device List

getDefaultVideoDeviceID

- (NSString *)getDefaultVideoDeviceID;

Get the device ID of the default video device.

Declared in ZegoExpressEngine.h

Only for Windows / macOS / Linux

Default video device ID

startSoundLevelMonitor

- (void)startSoundLevelMonitor;

Starts sound level monitoring.

Declared in ZegoExpressEngine.h

After starting monitoring, you can receive local audio sound level via [onCapturedSoundLevelUpdate] callback, and receive remote audio sound level via [onRemoteSoundLevelUpdate] callback. Before entering the room, you can call [startPreview] with this function and combine it with [onCapturedSoundLevelUpdate] callback to determine whether the audio device is working properly.

Use cases: During the publishing and playing process, determine who is talking on the wheat and do a UI presentation, in the host K song scene, has been published or played under the premise that the host or audience to see the tone and volume change animation.
When to call: After the engine is created [createEngine].
Caution: 1. [onCapturedSoundLevelUpdate] and [onRemoteSoundLevelUpdate] callback notification period is 100 ms. 2. After the sound monitoring is started, even if the local audio capture is not started, [onCapturedSoundLevelUpdate] will have a callback, and the sound level is 0.

Available since: 1.1.0

startSoundLevelMonitor:

- (void)startSoundLevelMonitor:(unsigned int) millisecond;

Starts sound level monitoring. Support setting the listening interval.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
millisecond	unsigned int	Monitoring time period of the sound level, in milliseconds, has a value range of [100, 3000]. Default is 100 ms.

Details

Use cases: During the publishing and playing process, determine who is talking on the wheat and do a UI presentation.
When to call: After the engine is created [createEngine].
Caution: 1. [onCapturedSoundLevelUpdate] and [onRemoteSoundLevelUpdate] callback notification period is the value set by the parameter. If you want to use advanced feature of sound level, please use the function of the same name (the parameter type is ZegoSoundLevelConfig) instead. 2. After the sound monitoring is started, even if the local audio capture is not started, [onCapturedSoundLevelUpdate] will have a callback, and the sound level is 0.

Available since: 1.15.0

startSoundLevelMonitorWithConfig::

- (void)startSoundLevelMonitorWithConfig:(ZegoSoundLevelConfig *) config;

Starts sound level monitoring. Support enable some advanced feature.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
config	ZegoSoundLevelConfig *	Configuration for starts the sound level monitor.

Details

Use cases: During the publishing and playing process, determine who is talking on the wheat and do a UI presentation.
When to call: After the engine is created [createEngine].
Caution: 1. [onCapturedSoundLevelUpdate] and [onRemoteSoundLevelUpdate] callback notification period is the value set by the parameter. 2. After the sound monitoring is started, even if the local audio capture is not started, [onCapturedSoundLevelUpdate] will have a callback, and the sound level is 0.

Available since: 2.10.0

stopSoundLevelMonitor

- (void)stopSoundLevelMonitor;

Stops sound level monitoring.

Declared in ZegoExpressEngine.h

After the monitoring is stopped, the callback of the local/remote audio sound level will be stopped.

When to call: After the engine is created [createEngine].
Related APIs: Soundwave monitoring can be initiated via [startSoundLevelMonitor].

Available since: 1.1.0

startAudioSpectrumMonitor

- (void)startAudioSpectrumMonitor;

Starts audio spectrum monitoring.

Declared in ZegoExpressEngine.h

After starting monitoring, you can receive local audio spectrum via [onCapturedAudioSpectrumUpdate] callback, and receive remote audio spectrum via [onRemoteAudioSpectrumUpdate] callback.

Use cases: In the host K song scene, has been published or played under the premise that the host or audience to see the tone and volume change animation.
When to call: After the engine is created [createEngine].
Caution: [onCapturedAudioSpectrumUpdate] and [onRemoteAudioSpectrumUpdate] callback notification period is 100 ms.

Available since: 1.1.0

startAudioSpectrumMonitor:

- (void)startAudioSpectrumMonitor:(unsigned int) millisecond;

Starts audio spectrum monitoring. Support setting the listening interval.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
millisecond	unsigned int	Monitoring time period of the audio spectrum, in milliseconds, the minimum value is 10. Default is 500 ms.

Details

After starting monitoring, you can receive local audio spectrum via [onCapturedAudioSpectrumUpdate] callback, and receive remote audio spectrum via [onRemoteAudioSpectrumUpdate] callback.

Use cases: In the host K song scene, has been published or played under the premise that the host or audience to see the tone and volume change animation.
When to call: After the engine is created [createEngine].
Caution: [onCapturedAudioSpectrumUpdate] and [onRemoteAudioSpectrumUpdate] callback notification period is the value set by the parameter.

Available since: 1.15.0

stopAudioSpectrumMonitor

- (void)stopAudioSpectrumMonitor;

Stops audio spectrum monitoring.

Declared in ZegoExpressEngine.h

After the monitoring is stopped, the callback of the local/remote audio spectrum will be stopped.

When to call: After the engine is created [createEngine].
Related APIs: Audio spectrum monitoring can be initiated via [startAudioSpectrumMonitor].

Available since: 1.1.0

enableHeadphoneMonitor:

- (void)enableHeadphoneMonitor:(BOOL) enable;

Enables or disables headphone monitoring.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	Whether to use headphone monitor, true: enable, false: disable

Details

Enable/Disable headphone monitor, and users hear their own voices as they use the microphone to capture sounds.

When to call: After the engine is created [createEngine].
Default value: Disable.
Caution: 1. This setting does not actually take effect until both the headset and microphone are connected. 2. The default is to return after acquisition and before pre-processing. If you need to return after pre-processing, please contact ZEGO technical support.

Available since: 1.9.0

setHeadphoneMonitorVolume:

- (void)setHeadphoneMonitorVolume:(int) volume;

Sets the headphone monitor volume.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
volume	int	headphone monitor volume, range from 0 to 200, 60 as default.

Details

set headphone monitor volume.

When to call: After the engine is created [createEngine].
Caution: This setting does not actually take effect until both the headset and microphone are connected.
Related APIs: Enables or disables headphone monitoring via [enableHeadphoneMonitor].

Available since: 1.9.0

enableMixSystemPlayout:

- (void)enableMixSystemPlayout:(BOOL) enable;

Enable or disable system audio capture.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	Whether to mix system playout.

Details

Enable sound card capture to mix sounds played by the system into the publishing stream, such as sounds played by the browser, sounds played by the third-party player, etc.

Default value: Default is disable.
When to call: Called this function after calling [startPublishingStream] or [startPreview].
Caution: The system sound card sound does not include streaming sound, media player sound and sound effect player sound.
Related APIs: [setMixSystemPlayoutVolume] function can set system audio capture volume.
Platform differences: Only supports Windows and macOS.

Available since: 1.9.0
Restrictions: None.

setMixSystemPlayoutVolume:

- (void)setMixSystemPlayoutVolume:(int) volume;

set system audio capture volume.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
volume	int	the volume. Valid range [0, 200], default is 100.

Details

only for macOS

enableMixEnginePlayout:

- (void)enableMixEnginePlayout:(BOOL) enable;

Enable or disable mix SDK playout to stream publishing.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	Whether to mix engine playout

Details

Enable mix SDK playout sounds into the stream publishing.

Use cases: Users need to mix the sound of SDK playout into stream publishing. For example, when the class scene, the teacher and student Co-hosting, and the teacher can mix the play streaming sound into the publish streaming.
Default value: Default is disable.
When to call /Trigger: Called this function after calling [startPublishingStream] or [startPreview].

Available since: 1.1.0
Restrictions: None.

startAudioVADStableStateMonitor:

- (void)startAudioVADStableStateMonitor:(ZegoAudioVADStableStateMonitorType) type;

Start audio VAD stable state monitoring.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
type	ZegoAudioVADStableStateMonitorType	audio VAD monitor type.

Details

After monitoring is started, you can use the [onAudioVADStateUpdate] callback to receive the specified type of audio VAD callback.

Use cases: For example, when you specify the type of collection and use the microphone to collect, you can check whether the host has continuous and stable voice input through this interface.
When to call: Before publish stream, you can call [startPreview] with this function and combine it with [onAudioVADStateUpdate] callback to determine whether the audio device is working properly.
Related APIs: [stopAudioVADStableStateMonitor].

Restrictions: [onAudioVADStateUpdate] callback notification period is 3 seconds.

startAudioVADStableStateMonitor:millisecond:

- (void)startAudioVADStableStateMonitor:(ZegoAudioVADStableStateMonitorType) type millisecond:(int) millisecond;

Start audio VAD stable state monitoring, and the monitoring period can be set.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
type	ZegoAudioVADStableStateMonitorType	audio VAD monitor type.
millisecond	int	monitoring period default 3000. value of [200, 10000]

Details

After monitoring is started, you can use the [onAudioVADStateUpdate] callback to receive the specified type of audio VAD callback.

Use cases: For example, when you specify the type of collection and use the microphone to collect, you can check whether the host has continuous and stable voice input through this interface.
When to call: Before publish stream, you can call [startPreview] with this function and combine it with [onAudioVADStateUpdate] callback to determine whether the audio device is working properly.
Related APIs: [stopAudioVADStableStateMonitor].

Restrictions: None.

stopAudioVADStableStateMonitor:

- (void)stopAudioVADStableStateMonitor:(ZegoAudioVADStableStateMonitorType) type;

Stop audio VAD stable state monitoring.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
type	ZegoAudioVADStableStateMonitorType	audio VAD monitor type.

Details

After calling this interface, the specified type of [onAudioVADStateUpdate] callback can no longer be received.

When to call: None.
Related APIs: [startAudioVADStableStateMonitor].

Available since: 2.14.0
Restrictions: None.

getCurrentAudioDevice:

- (ZegoDeviceInfo *)getCurrentAudioDevice:(ZegoAudioDeviceType) deviceType;

Get the audio device information currently in use.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
deviceType	ZegoAudioDeviceType	Audio device type.Required .

Details

Get the audio device information currently in use.

Use cases: Used for scenes that need to manually switch between multiple audio devices.
When to call: Called this function after calling [startPublishingStream] or [startPreview].
Related APIs: The default audio device ID can be obtained through [getDefaultAudioDeviceID].

Available since: 2.12.0
Restrictions: Only supports Windows and macOS.

Return

Audio device information.

enableAEC:

- (void)enableAEC:(BOOL) enable;

Whether to enable acoustic echo cancellation (AEC).

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	Whether to enable echo cancellation, true: enable, false: disable

Details

Turning on echo cancellation, the SDK filters the collected audio data to reduce the echo component in the audio. Use case: When you need to reduce the echo to improve the call quality and user experience, you can turn on this feature.

When to call: It needs to be called after [createEngine].
Caution: The AEC function only supports the processing of sounds playbacked through the SDK, such as sounds played by the playing stream, media player, audio effect player, etc. Before this function is called, the SDK automatically determines whether to use AEC. Once this function is called, the SDK does not automatically determine whether to use AEC.
Related APIs: Developers can use [enableHeadphoneAEC] to set whether to enable AEC when using headphones, and use [setAECMode] to set the echo cancellation mode.

Available since: 1.1.0
Restrictions: None.

enableHeadphoneAEC:

- (void)enableHeadphoneAEC:(BOOL) enable;

Whether to turn on acoustic echo cancellation (AEC) when using the headphone.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	Whether to enable, true: enable, false: disable

Details

When [enableAEC] is used to turn on echo cancellation, it is only turned on when the speaker is used for mobile terminal equipment. Call this function if you need to turn echo cancellation on or off when using the headset. Use case: It is common when the mobile device is connected to a external sound card as the audio output source. In order to eliminate the echo in this case, you need to call this function to turn on the echo cancellation.

Default value: Android is off by default and iOS is on by default.
When to call: It needs to be called after [createEngine], before [startPublishingStream], [startPlayingStream], [startPreview], [createMediaPlayer], [createAudioEffectPlayer] and [createRealTimeSequentialDataManager].
Caution: Turning on echo cancellation will increase the ear return delay. On the iOS platform, the SDK cannot distinguish between the headset and the external sound card. If you use this function to turn off the system echo cancellation when using the headset, the sound played by the external sound card will be collected when the user accesses the external sound card.
Related APIs: When the headset is not used, you can set whether the SDK turns on echo cancellation through [enableAEC].
Platform differences: Only supports iOS and Android.

Available since: 1.1.0
Restrictions: None.

setAECMode:

- (void)setAECMode:(ZegoAECMode) mode;

Sets the acoustic echo cancellation (AEC) mode.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
mode	ZegoAECMode	Echo cancellation mode

Details

When [enableAEC] is used to enable echo cancellation, this function can be used to switch between different echo cancellation modes to control the degree of echo cancellation. Use case: When the default echo cancellation effect does not meet expectations, this function can be used to adjust the echo cancellation mode.

Default value: When this function is not called, the default echo cancellation mode is [Aggressive].
When to call: It needs to be called after [createEngine].

Available since: 1.1.0
Restrictions: The value set by this function is valid only after the echo cancellation function is turned on.

enableAGC:

- (void)enableAGC:(BOOL) enable;

Enables or disables automatic gain control (AGC).

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	Whether to enable automatic gain control, true: enable, false: disable

Details

After turning on this function, the SDK can automatically adjust the microphone volume to adapt to near and far sound pickups and keep the volume stable. Use case: When you need to ensure volume stability to improve call quality and user experience, you can turn on this feature.

When to call: It needs to be called after [createEngine].
Caution: Before this function is called, the SDK automatically determines whether to use AGC. Once this function is called, the SDK does not automatically determine whether to use AGC.

Available since: 1.1.0
Restrictions: None.

enableANS:

- (void)enableANS:(BOOL) enable;

Enables or disables active noise suppression (ANS, aka ANC).

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	Whether to enable noise suppression, true: enable, false: disable

Details

Enable the noise suppression can reduce the noise in the audio data and make the human voice clearer. Use case: When you need to suppress noise to improve call quality and user experience, you can turn on this feature.

When to call: It needs to be called after [createEngine].
Related APIs: This function has a better suppression effect on continuous noise (such as the sound of rain, white noise). If you need to turn on transient noise suppression, please use [enableTransientANS]. And the noise suppression mode can be set by [setANSMode].
Caution: Before this function is called, the SDK automatically determines whether to use ANS. Once this function is called, the SDK does not automatically determine whether to use ANS.

Available since: 1.1.0
Restrictions: None.

enableTransientANS:

- (void)enableTransientANS:(BOOL) enable;

Enables or disables transient noise suppression.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	Whether to enable transient noise suppression, true: enable, false: disable

Details

Enable the transient noise suppression can suppress the noises such as keyboard and desk knocks. Use case: When you need to suppress transient noise to improve call quality and user experience, you can turn on this feature.

Default value: When this function is not called, this is disabled by default.
When to call: It needs to be called after [createEngine].
Related APIs: This function will not suppress normal noise after it is turned on. If you need to turn on normal noise suppression, please use [enableANS].

Available since: 1.17.0
Restrictions: None.

setANSMode:

- (void)setANSMode:(ZegoANSMode) mode;

Sets the automatic noise suppression (ANS) mode.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
mode	ZegoANSMode	Audio Noise Suppression mode

Details

When [enableANS] is used to enable noise suppression, this function can be used to switch between different noise suppression modes to control the degree of noise suppression. Use case: When the default noise suppression effect does not meet expectations, this function can be used to adjust the noise suppression mode.

Default value: When this function is not called, the default automatic noise suppression (ANS) mode is [Medium].
When to call: It needs to be called after [createEngine].

Available since: 1.1.0
Restrictions: The value set by this function is valid only after the noise suppression function is turned on.

enableSpeechEnhance:level:

- (void)enableSpeechEnhance:(BOOL) enable level:(int) level;

Enables or disables speech enhancement.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	Whether to enable speech enhancement, true: enable, false: disable
level	int	Enhancement level; The value range is [0, 10]

Details

Enable the speech enhancement function. Use case: In the KTV external playback scene, due to 3A damage and distance, the voice is weak or empty or unclear, so it is necessary to enhance the external playback experience through the voice enhancement technology.

Default value: When this function is not called, this is disabled by default.
When to call: It needs to be called after [createEngine] and it Supports dynamic change.
Caution: 1. If this interface is called repeatedly, the settings of the last call are used;

After call [DestroyEngine], the Settings fail.

Available since: 3.3.0.
Restrictions: None.

enableAudioMixing:

- (void)enableAudioMixing:(BOOL) enable;

Enables or disables audio mixing function.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	Whether to enable audio mixting, true: enable, false: disable

Details

After the audio mixing function is turned on, the SDK will mix the audio data prepared by the developer with the audio data collected by the SDK before publishing. Use case: Developers can use this function when they need to mix their own songs, sound effects or other audio data into the publishing stream.

Default value: When this function is not called, this is disabled by default.
When to call: It needs to be called after [createEngine].
Related APIs: After enabling audio mixing, the developer also needs to call [setAudioMixingHandler] to set the audio mixing callback, so as to provide the SDK with the audio data that needs to be mixed in the [onAudioMixingCopyData] callback.
Caution: After you start audio mixing, the SDK will play the mixed audio on the local (publisher side) by default. If you do not want to play it locally but only on the remote (player side), please call [muteLocalAudioMixing] to set the local audio mixing mute. Recommend to use audio effect player or media player for audio mixing.

Available since: 1.9.0, will be deprecated soon. It is recommended to use the media player [createMediaPlayer] or the audio effect player [createAudioEffectPlayer] to implement the audio mixing function.
Restrictions: None.

setAudioMixingHandler:

- (void)setAudioMixingHandler:(nullable id<ZegoAudioMixingHandler>) handler;

Sets up the audio mixing event handler.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
handler	nullable id<ZegoAudioMixingHandler>	Audio mixing callback handler

Details

When to call: It needs to be called after [createEngine].
Caution: When this function is called again to set the callback, the previously set mixing callback will be overwritten.

Available since: 1.9.0
Restrictions: None.

muteLocalAudioMixing:

- (void)muteLocalAudioMixing:(BOOL) mute;

Mute or resume local playback of the mixing audio.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
mute	BOOL	Whether to mute local audio mixting, true: mute, false: unmute

Details

When calling this function to mute the local playback audio mixing, the local (publisher side) will not play the audio provided to the SDK through [onAudioMixingCopyData], but the remote (player side) can still playback it Mix. Use case: When developers need to mix their own songs, sound effects or other audio data into the publishing stream, but the mixed audio only wants to be heard by the remote player, and does not want to be playback locally, you can use this function.

Default value: When this function is not called, the default is not mute, which is false.
When to call: It needs to be called after [createEngine].

Available since: 1.9.0
Restrictions: None.

setAudioMixingVolume:

- (void)setAudioMixingVolume:(int) volume;

Sets the audio mixing output volume for both local playback and the stream to be published.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
volume	int	The audio mixing volume, range from 0 to 200, 100 as default.

Details

After enabling the audio mixing function through [enableAudioMixing], the developer can use this function to set the volume of the mixing audio to be mixed to SDK. Use case: When developers need to mix their own songs, sound effects or other audio data into the publishing stream, and want to adjust the volume of the mixing audio, you can use this function.

When to call: It needs to be called after [createEngine].
Caution: This function will set both the mixing audio volume of the local playback and the remote playback at the same time.
Related APIs: If you need to set the mixing audio volume for local playback or remote playback separately, please use the function of the same name with the [type] parameter.

Available since: 1.9.0
Restrictions: None.

setAudioMixingVolume:type:

- (void)setAudioMixingVolume:(int) volume type:(ZegoVolumeType) type;

Sets the audio mixing output volume for either local playback or the stream to published.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
volume	int	The audio mixing volume, range from 0 to 200, 100 as default.
type	ZegoVolumeType	Local playback volume / Remote playback volume

Details

When to call: It needs to be called after [createEngine].
Caution: This function can individually set the mixing audio volume of the local playback or the remote playback.

Available since: 1.9.0
Restrictions: None.

startEffectsEnv

- (void)startEffectsEnv;

Enable the Effects beauty environment.

Declared in ZegoExpressEngine.h

Enable the Effects beauty environment. The SDK uses the specified video frame data type for transmission. The Windows platform only supports video frame raw data, the Apple platform only supports CVPixelBuffer, and the Android platform only supports texture2d.

Use cases: It is often used in scenes such as video calls and live broadcasts.
Default value: When this function is not called, the beauty environment is not activated by default.
When to call: Must be called before calling [startPreview], [startPublishingStream]. If you need to modify the configuration, please call [logoutRoom] to log out of the room first, otherwise it will not take effect.
Related APIs: [enableEffectsBeauty] switch beauty, [setEffectsBeautyParam] set beauty parameters.
Caution: This beauty function is the basic function. If it does not meet the expectations of the developer, you can use the custom video pre-processing function [enableCustomVideoProcessing] or the custom video capture function [enableCustomVideoCapture] docking and constructing the AI Effects SDK [ZegoEffects] /ai-effects-android-java/overview/overview for best results.

Available since: 2.16.0
Restrictions: This function only supports Android system 5.0 and above, Android SDK version 21 and above.

stopEffectsEnv

- (void)stopEffectsEnv;

Disable the Effects beauty environment.

Declared in ZegoExpressEngine.h

Disable the Effects beauty environment.

Use cases: It is often used in scenes such as video calls and live broadcasts.
When to call: Must be called before calling [startPreview], [startPublishingStream]. If you need to modify the configuration, please call [logoutRoom] to log out of the room first, otherwise it will not take effect.
Related APIs: [enableEffectsBeauty] switch beauty, [setEffectsBeautyParam] set beauty parameters.
Caution: This beauty function is the basic function. If it does not meet the expectations of the developer, you can use the custom video pre-processing function [enableCustomVideoProcessing] or the custom video capture function [enableCustomVideoCapture] docking and constructing the AI Effects SDK [ZegoEffects] for best results.

Available since: 2.16.0
Restrictions: This function only supports Android system 5.0 and above, Android SDK version 21 and above.

enableEffectsBeauty:

- (void)enableEffectsBeauty:(BOOL) enable;

Enables or disables the beauty effect.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	Whether to enable the beauty effect, true is enabled; false is disabled, and the default is false.

Details

Support basic beauty functions, including whiten, rosy, smooth, and sharpen.

Use cases: It is often used in scenes such as video calls and live broadcasts.
When to call: You must call [startEffectsEnv] to enable the beauty environment before calling this function.
Default value: When this function is not called, the beauty effect is not enabled by default.
Related APIs: You can call the [setBeautifyOption] function to adjust the beauty parameters.
Caution: This beauty function is the basic function. If it does not meet the expectations of the developer, you can use the custom video pre-processing function [enableCustomVideoProcessing] or the custom video capture function [enableCustomVideoCapture] docking and constructing the AI Effects SDK [ZegoEffects] for best results.

Available since: 2.16.0
Restrictions: If this function is used on the Android platform, it only supports 5.0 and above, SDK version 21 and above.

setEffectsBeautyParam:

- (void)setEffectsBeautyParam:(ZegoEffectsBeautyParam *) param;

Set beautify param.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
param	ZegoEffectsBeautyParam *	Beauty option param.

Details

Set the beauty parameters, including whiten, rosy, smooth, and sharpen.

Use cases: It is often used in scenes such as video calls and live broadcasts.
When to call: You must call [startEffectsEnv] to enable the beauty environment before calling this function.
Related APIs: You can call [enableEffectsBeauty] to turn on or off the beauty function.

Available since: 2.16.0
Restrictions: This function only supports Android system 5.0 and above, Android SDK version 21 and above.

setAudioEqualizerGain:bandGain:

- (void)setAudioEqualizerGain:(int) bandIndex bandGain:(float) bandGain;

Set the sound equalizer (EQ).

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
bandIndex	int	Band frequency index, the value range is [0, 9], corresponding to 10 frequency bands, and the center frequencies are [31, 62, 125, 250, 500, 1K, 2K, 4K, 8K, 16K] Hz.
bandGain	float	Band gain for the index, the value range is [-15, 15]. Default value is 0, if all gain values in all frequency bands are 0, EQ function will be disabled.

Details

Call this function to set the sound equalizer adjust the tone.

Use cases: Often used in voice chatroom, KTV.
When to call: It should be called after the engine has started.

Available since: 1.12.0
Restrictions: None.

setVoiceChangerPreset:

- (void)setVoiceChangerPreset:(ZegoVoiceChangerPreset) preset;

Setting up the voice changer via preset enumeration.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
preset	ZegoVoiceChangerPreset	The voice changer preset enumeration.

Details

Call this function to use preset voice changer effect.

Use cases: Often used in live broadcasting, voice chatroom and KTV.
When to call: It needs to be called after [createEngine].
Related APIs: If you need advanced voice changer effect, please use [setVoiceChangerParam]. The effect of using this function together with [setReverbPreset] may be different from what is expected. If you need to use it at the same time, it is recommended to enable the voice changer first, and then enable the reverb. Using ANDROID/ETHEREAL preset voice changer effect will modify reverberation or reverberation echo parameters. Calling [setVoiceChangerParam], [setReverbAdvancedParam], [setReverbEchoParam] may affect the voice changer effect after use these preset voice changer effect. If you need advanced reverb/echo/electronic effects/voice changer effect, please use [setReverbAdvancedParam], [setReverbEchoParam], [setElectronicEffects], [setVoiceChangerParam] together.

Available since: 1.17.0

setVoiceChangerParam:

- (void)setVoiceChangerParam:(ZegoVoiceChangerParam *) param;

Setting up the specific voice changer parameters.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
param	ZegoVoiceChangerParam *	Voice changer parameters.

Details

Call this function to set custom voice changer effect.

Use cases: Often used in live broadcasting, voice chatroom and KTV.
When to call: It needs to be called after [createEngine].
Related APIs: [setVoiceChangerPreset] provide a set of preset voice changer effects. If you need advanced reverb/echo/voice changer effect, please use [setReverbAdvancedParam], [setReverbEchoParam], [setVoiceChangerParam] together.

Available since: 1.10.0

setReverbPreset:

- (void)setReverbPreset:(ZegoReverbPreset) preset;

Setting up the reverberation via preset enumeration.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
preset	ZegoReverbPreset	The reverberation preset enumeration.

Details

Call this function to set preset reverb effect.

Use cases: Often used in live broadcasting, voice chatroom and KTV.
When to call: It needs to be called after [createEngine]. Support call this function to change preset reverb effect during publishing stream.
Related APIs: If you need advanced reverb effect, please use [setReverbAdvancedParam]. The effect of using this function together with [setVoiceChangerPreset] may be different from what is expected. If you need to use it at the same time, it is recommended to enable the voice changer first, and then enable the reverb. If you need advanced reverb/echo/voice changer effect, please use [setReverbAdvancedParam], [setReverbEchoParam], [setVoiceChangerParam] together.

Available since: 1.17.0

setReverbAdvancedParam:

- (void)setReverbAdvancedParam:(ZegoReverbAdvancedParam *) param;

Setting up the specific reverberation parameters.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
param	ZegoReverbAdvancedParam *	Reverb advanced parameter.

Details

Call this function to set preset reverb effect.

Use cases: Often used in live broadcasting, voice chatroom and KTV.
When to call: It needs to be called after [createEngine].
Caution: Different values dynamically set during publishing stream will take effect. When all parameters are set to 0, the reverberation is turned off.
Related APIs: [setReverbPreset] provide a set of preset reverb effects. If you need advanced reverb/echo/voice changer effect, please use [setReverbAdvancedParam], [setReverbEchoParam], [setVoiceChangerParam] together.

Available since: 1.10.0

setReverbEchoParam:

- (void)setReverbEchoParam:(ZegoReverbEchoParam *) param;

Setting up the specific reverberation echo parameters.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
param	ZegoReverbEchoParam *	The reverberation echo parameter.

Details

Call this function to set reverb echo effect. This function can be used with voice changer and reverb to achieve a variety of custom sound effects.

Use cases: Often used in live broadcasting, voice chatroom and KTV.
When to call: It needs to be called after [createEngine].
Related APIs: If you need advanced reverb/echo/voice changer effect, please use [setReverbAdvancedParam], [setReverbEchoParam], [setVoiceChangerParam] together.

Available since: 1.17.0

enableVirtualStereo:angle:

- (void)enableVirtualStereo:(BOOL) enable angle:(int) angle;

Enable or disable the virtual stereo effect when publishing stream.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	true to turn on the virtual stereo, false to turn off the virtual stereo.
angle	int	The angle of the sound source in virtual stereo in the range of -1 ~ 360, with 90 being directly in front, 0 / 180 / 270 corresponding to the rightmost and leftmost respectively. In particular, when set to -1, it is all round virtual stereo effects.

Details

Call this function to enable / disable the virtual stereo effect when publishing stream.

Use cases: Often used in live broadcasting, voice chatroom and KTV.
When to call: It needs to be called after [createEngine].
Caution: You need to set up a dual channel with [setAudioConfig] for the virtual stereo to take effect.

Available since: 1.10.0; Starting from 2.15.0, the angle parameter supports setting -1 to present a all round virtual stereo effect.

enablePlayStreamVirtualStereo:angle:streamID:

- (void)enablePlayStreamVirtualStereo:(BOOL) enable angle:(int) angle streamID:(NSString *) streamID;

Enable or disable the virtual stereo effect when playing stream.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	true to turn on the virtual stereo, false to turn off the virtual stereo.
angle	int	The angle of the sound source in virtual stereo in the range of 0 ~ 360, with 90 being directly in front, 0 / 180 / 270 corresponding to the rightmost and leftmost respectively.
streamID	NSString *	Stream ID.

Details

Call this function to enable/disable the virtual stereo effect when playing stream.

Use cases: Often used in live broadcasting, voice chatroom and KTV.
When to call: It needs to be called after [createEngine].
Caution: It can dynamically switch and set angle parameters before and after playing stream. After stopping playing stream, it will automatically reset and disable.

Available since: 2.8.0

setElectronicEffects:mode:tonal:

- (void)setElectronicEffects:(BOOL) enable mode:(ZegoElectronicEffectsMode) mode tonal:(int) tonal;

Turn on or off the electronic sound effect.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	true to turn on the electronic sound effect, false to turn off the electronic sound effect.
mode	ZegoElectronicEffectsMode	Mode of Electronic Effects reference.
tonal	int	The starting pitch of an electric tone in a given mode, representing 12 semitones in one octave of the sound, in the range [0, 11].

Details

Call this function to turn on or off the electronic sound effect.

Use cases: Often used in live broadcasting, voice chatroom and sung unaccompanied scenes.
Default value: When this function is not called, the electronic sound effect is not enabled by default.
When to call: It needs to be called after [createEngine].
Caution: When the mode parameter is Harmonic Minor, the tonal parameter does not take effect.
Related APIs: Common electronic sound effect configurations can be set via [setVoiceChangerPreset].

Available since: 2.13.0
Restrictions: None.

enableColorEnhancement:params:channel:

- (void)enableColorEnhancement:(BOOL) enable params:(ZegoColorEnhancementParams *) params channel:(ZegoPublishChannel) channel;

Enable color enhancement.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	Whether to enable, true: enable, false: disable
params	ZegoColorEnhancementParams *	Color enhancement parameters.
channel	ZegoPublishChannel	Publish stream channel.

Details

Call this function to enable or disable color enhancement.

Use cases: Commonly used in video calling, live streaming, and similar scenarios.
Default value: When this function is not called, color enhancement is not enabled by default.
When to call: It needs to be called after [createEngine].

Available since: 3.11.0

createRealTimeSequentialDataManager:

- (nullable ZegoRealTimeSequentialDataManager *)createRealTimeSequentialDataManager:(NSString *) roomID;

Create the real time sequential data manager instance

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
roomID	NSString *	Fill in the room ID that has been logged in, and all related stuff will be do in this room.

Details

Create a manager object for sending/receiving real-time signaling.

Use cases: You can use this function when you need to use real-time signaling to implement services such as cloud games and remote desktops.
When to call: After logging in to a room.
Caution: None.

Restrictions: Only one corresponding manager object can be created for each room ID of [loginRoom], that is, only one object can be created in single room mode, and multiple objects can be created in multi-room mode.

Return

The real-time sequential data manager instance, nil will be returned when the maximum number is exceeded.

destroyRealTimeSequentialDataManager:

- (void)destroyRealTimeSequentialDataManager:(ZegoRealTimeSequentialDataManager *) manager;

Destroy the real time sequential data manager instance

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
manager	ZegoRealTimeSequentialDataManager *	The real time sequential data manager instance to be destroyed.

Details

Destroy the [ZegoRealTimeSequentialDataManager] instance object.

Use cases: When you no longer need to use the real-time signaling function, you can use this function to destroy the instance object created by the [createRealTimeSequentialDataManager] function
When to call: When you need to the real-time signaling manager object needs to be destroyed
Caution: None.

Restrictions: After destroy the instance, you need to release the [ZegoRealTimeSequentialDataManager] instance object you hold by yourself, and don’t call the function of this instance object after the destruction.

sendBroadcastMessage:roomID:callback:

- (void)sendBroadcastMessage:(NSString *) message roomID:(NSString *) roomID callback:(nullable ZegoIMSendBroadcastMessageCallback) callback;

Sends a Broadcast Message.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
message	NSString *	The content of the message. Required: Yes. Value range: The length does not exceed 1024 bytes.
roomID	NSString *	Room ID, a string of less 128 bytes in length. Caution: 1. room ID is defined by yourself. 2. Only support numbers, English characters and '~', '!', '@', '#', '$', '%', '^', '&', '*', '(', ')', '_', '+', '=', '-', '`', ';', '’', ',', '.', '<', '>', ''. 3. If you need to communicate with the Web SDK, please do not use '%'.
callback	nullable ZegoIMSendBroadcastMessageCallback	Send a notification of the result of a broadcast message. Required: No. Caution: Passing [nil] means not receiving callback notifications.

Details

Send a broadcast message to the room, users who have entered the same room can receive the message, and the message is reliable.

Use cases: Generally used in the live room.
When to call: After calling [loginRoom] to log in to the room.
Related callbacks: The room broadcast message can be received through [onIMRecvBroadcastMessage].
Related APIs: Barrage messages can be sent through the [sendBarrageMessage] function, and custom command can be sent through the [sendCustomCommand] function.

Available since: 1.2.1
Restrictions: The frequency of sending broadcast messages in the same room cannot be higher than 10 messages/s. The maximum QPS for a single user to call this interface within a single room is 2. For restrictions on the use of this function, please contact ZEGO technical support.

sendBarrageMessage:roomID:callback:

- (void)sendBarrageMessage:(NSString *) message roomID:(NSString *) roomID callback:(nullable ZegoIMSendBarrageMessageCallback) callback;

Sends a Barrage Message (bullet screen) to all users in the same room, without guaranteeing the delivery.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
message	NSString *	The content of the message. Required: Yes. Value range: The length does not exceed 1024 bytes.
roomID	NSString *	Room ID, a string of less 128 bytes in length. Caution: 1. room ID is defined by yourself. 2. Only support numbers, English characters and '~', '!', '@', '#', '$', '%', '^', '&', '*', '(', ')', '_', '+', '=', '-', '`', ';', '’', ',', '.', '<', '>', ''. 3. If you need to communicate with the Web SDK, please do not use '%'.
callback	nullable ZegoIMSendBarrageMessageCallback	Send barrage message result callback.Required: No. Caution: Passing [nil] means not receiving callback notifications.

Details

Send a barrage message to the room, users who have logged in to the same room can receive the message, the message is unreliable.

Use cases: Generally used in scenarios where there is a large number of messages sent and received in the room and the reliability of the messages is not required, such as live barrage.
When to call: After calling [loginRoom] to log in to the room.
Related callbacks: The room barrage message can be received through [onIMRecvBarrageMessage].
Related APIs: Broadcast messages can be sent through the [sendBroadcastMessage] function, and custom command can be sent through the [sendCustomCommand] function.

Available since: 1.5.0
Restrictions: The frequency of sending barrage messages in the same room cannot be higher than 20 messages/s. For restrictions on the use of this function, please contact ZEGO technical support.

sendCustomCommand:toUserList:roomID:callback:

- (void)sendCustomCommand:(NSString *) command toUserList:(nullable NSArray<ZegoUser *> *) toUserList roomID:(NSString *) roomID callback:(nullable ZegoIMSendCustomCommandCallback) callback;

Sends a Custom Command to the specified users in the same room.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
command	NSString *	Custom command content. Required: Yes. Value range: The maximum length is 1024 bytes. Caution: To protect privacy, please do not fill in sensitive user information in this interface, including but not limited to mobile phone number, ID number, passport number, real name, etc.
toUserList	nullable NSArray<ZegoUser >	List of recipients of signaling. Required: Yes. Value range: user list or [nil]. Caution: When it is [nil], the SDK will send custom signaling back to all users in the room
roomID	NSString *	Room ID, a string of less 128 bytes in length. Caution: 1. room ID is defined by yourself. 2. Only support numbers, English characters and '~', '!', '@', '#', '$', '%', '^', '&', '*', '(', ')', '_', '+', '=', '-', '`', ';', '’', ',', '.', '<', '>', ''. 3. If you need to communicate with the Web SDK, please do not use '%'.
callback	nullable ZegoIMSendCustomCommandCallback	Send a notification of the signaling result. Required: No. Caution: Passing [nil] means not receiving callback notifications.

Details

Send point-to-point signaling to other users who have logged into the same room, and the message is reliable.

Use cases: Generally used for remote control signaling or message sending between users.
When to call: After calling [loginRoom] to log in to the room.
Related callbacks: The room custom command can be received through [onIMRecvCustomCommand].
Related APIs: Broadcast messages can be sent through the [sendBroadcastMessage] function, and barrage messages can be sent through the [sendBarrageMessage] function.
Privacy reminder: Please do not fill in sensitive user information in this interface, including but not limited to mobile phone number, ID number, passport number, real name, etc.

Available since: 1.2.1
Restrictions: The frequency of sending barrage messages in the same room cannot be higher than 20 messages/s. For restrictions on the use of this function, please contact ZEGO technical support.

sendTransparentMessage:roomID:callback:

- (void)sendTransparentMessage:(ZegoRoomSendTransparentMessage*) message roomID:(NSString *) roomID callback:(nullable ZegoRoomSendTransparentMessageCallback) callback;

Sends a transparent message in room.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
message	ZegoRoomSendTransparentMessage*	ZegoRoomSendTransparentMessage
roomID	NSString *	Room ID, a string of less 128 bytes in length. Caution: 1. room ID is defined by yourself. 2. Only support numbers, English characters and '~', '!', '@', '#', '$', '%', '^', '&', '*', '(', ')', '_', '+', '=', '-', '`', ';', '’', ',', '.', '<', '>', ''. 3. If you need to communicate with the Web SDK, please do not use '%'.
callback	nullable ZegoRoomSendTransparentMessageCallback	Send a notification of the signaling result. Required: No. Caution: Passing [nil] means not receiving callback notifications.

Details

Send point-to-point signaling to other users who have logged into the same room.

Use cases: Generally used for remote control signaling or message sending between users.
When to call: After calling [loginRoom] to log in to the room.
Related callbacks: When sending a message, Mode is specified for ZegoRoomTransparentMessageModeOnlyClient or ZegoRoomTransparentMessageModeClientAndServer can pass [onRecvRoomTransparentMessage] received sends the message content.
Privacy reminder: Please do not fill in sensitive user information in this interface, including but not limited to mobile phone number, ID number, passport number, real name, etc.

Available since: 1.2.1
Restrictions: The frequency of sending barrage messages in the same room cannot be higher than 20 messages/s. For restrictions on the use of this function, please contact ZEGO technical support.

createMediaPlayer

- (nullable ZegoMediaPlayer *)createMediaPlayer;

Creates a media player instance.

Declared in ZegoExpressEngine.h

Creates a media player instance. Use case: It is often used to play media resource scenes, For example, play video files, push the video of media resources in combination with custom video acquisition, and the remote end can pull the stream for viewing.

When to call: It can be called after the SDK by [createEngine] has been initialized.
Caution: The more instances of a media player, the greater the performance overhead on the device.
Related APIs: User can call [destroyMediaPlayer] function to destroy a media player instance.

Available since: 2.1.0
Restrictions: Currently, a maximum of 10 instances can be created, after which it will return nil.

Media player instance, nil will be returned when the maximum number is exceeded.

destroyMediaPlayer:

- (void)destroyMediaPlayer:(ZegoMediaPlayer *) mediaPlayer;

Destroys a media player instance.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
mediaPlayer	ZegoMediaPlayer *	The media player instance object to be destroyed.

Details

Destroys a media player instance.

Related APIs: User can call [createMediaPlayer] function to create a media player instance.

Available since: 2.1.0

createAudioEffectPlayer

- (nullable ZegoAudioEffectPlayer *)createAudioEffectPlayer;

Creates a audio effect player instance.

Declared in ZegoExpressEngine.h

Creates a audio effect player instance.

Use cases: When you need to play short sound effects, such as applause, cheers, etc., you can use audioEffectPlayer to achieve.
When to call: It can be called after [createEngine].
Related APIs: [destroyAudioEffectPlayer].

Available since: 1.16.0
Restrictions: Currently, a maximum of 1 instances can be created, after which it will return nil.

audio effect player instance, nil will be returned when the maximum number is exceeded.

destroyAudioEffectPlayer:

- (void)destroyAudioEffectPlayer:(ZegoAudioEffectPlayer *) audioEffectPlayer;

Destroys a audio effect player instance.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
audioEffectPlayer	ZegoAudioEffectPlayer *	The audio effect player instance object to be destroyed.

Details

Destroys the specified audio effect player instance.

When to call: It can be called after [createAudioEffectPlayer].
Related APIs: [createAudioEffectPlayer].

Available since: 1.16.0
Restrictions: None.

createMediaDataPublisher:

- (nullable ZegoMediaDataPublisher *)createMediaDataPublisher:(ZegoMediaDataPublisherConfig *) config;

Creates a media data publisher instance.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
config	ZegoMediaDataPublisherConfig *	Config the media data publisher.

Details

Developers can use this interface to create ZegoMediaDataPublisher objects to push local media resource files to implement server-side streaming scenarios, such as AI classrooms.

Use cases: Often used in server-side publishing stream scenarios, such as AI classrooms.
When to call: After calling the [createEngine] function to create an engine.
Caution: It returns the instance object of the specified publish channel. It will return the instance object if it already exists.

Available since: 3.4.0

Return

Media data publisher instance.

destroyMediaDataPublisher:

- (void)destroyMediaDataPublisher:(ZegoMediaDataPublisher *) mediaDataPublisher;

Destroys a media data publisher instance.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
mediaDataPublisher	ZegoMediaDataPublisher *	The media data publisher instance object to be destroyed

Details

Destroys a media data publisher instance.

Use cases: Often used in server-side publishing stream scenarios, such as AI classrooms.
When to call: After calling the [createEngine] function to create an engine.

Available since: 2.17.0

startRecordingCapturedData:channel:

- (void)startRecordingCapturedData:(ZegoDataRecordConfig *) config channel:(ZegoPublishChannel) channel;

Starts to record and directly save the data to a file.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
config	ZegoDataRecordConfig *	Record config.
channel	ZegoPublishChannel	Publishing stream channel.

Details

Starts to record locally captured audio or video and directly save the data to a file, The recorded data will be the same as the data publishing through the specified channel.

Caution: Developers should not [stopPreview] or [stopPublishingStream] during recording, otherwise the SDK will end the current recording task. The data of the media player needs to be mixed into the publishing stream to be recorded.
Related callbacks: Developers will receive the [onCapturedDataRecordStateUpdate] and the [onCapturedDataRecordProgressUpdate] callback after start recording.

Available since: 1.10.0
Restrictions: None.

stopRecordingCapturedData:

- (void)stopRecordingCapturedData:(ZegoPublishChannel) channel;

Stops recording locally captured audio or video.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
channel	ZegoPublishChannel	Publishing stream channel.

Details

Stops recording locally captured audio or video.

When to call: After [startRecordingCapturedData].

Available since: 1.10.0
Restrictions: None.

setDataRecordEventHandler:

- (void)setDataRecordEventHandler:(nullable id<ZegoDataRecordEventHandler>) eventHandler;

Sets up the event callback handler for data recording.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
eventHandler	nullable id<ZegoDataRecordEventHandler>	Data record event handler.

Details

Implemente the functions of ZegoDataRecordEventHandler to get notified when recode state and process changed.

When to call: After [createEngine].

Available since: 1.10.0
Restrictions: None.

startPerformanceMonitor:

- (void)startPerformanceMonitor:(unsigned int) millisecond;

Start system performance monitoring.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
millisecond	unsigned int	Monitoring time period(in milliseconds), the value range is [1000, 10000]. Default value is 2000 ms.

Details

Start system performance monitoring, monitor system or App's CPU usage and memory usage. Support set the monitoring interval.

Use cases: Monitor system performance can help user quickly locate and solve performance problems and improve user experience.
When to call: It needs to be called after [createEngine].
Related callbacks: After starting monitoring, you can receive system performance status via [onPerformanceStatusUpdate] callback. [onPerformanceStatusUpdate] callback notification period is the value set by millisecond parameter.
Related APIs: Call [stopPerformanceMonitor] to stop system performance monitoring.

Available since: 1.19.0
Restrictions: None.

stopPerformanceMonitor

- (void)stopPerformanceMonitor;

Stop system performance monitoring.

Declared in ZegoExpressEngine.h

Stop system performance monitoring. After the monitoring is stopped, the [onPerformanceStatusUpdate] callback will not triggered.

Use cases: Monitor system performance can help user quickly locate and solve performance problems and improve user experience.
When to call: It needs to be called after [createEngine].
Related APIs: Call [startPerformanceMonitor] to start system performance monitoring.

Available since: 1.19.0
Restrictions: None.

startNetworkProbe:callback:

- (void)startNetworkProbe:(ZegoNetworkProbeConfig *) config callback:(nullable ZegoNetworkProbeResultCallback) callback;

Start network probe.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
config	ZegoNetworkProbeConfig *	network probe config.
callback	nullable ZegoNetworkProbeResultCallback	Network probe result callback.

Details

Some local network problems may cause audio and video calls to fail. Using this function to probe the network protocols, assist in locating and solving related network problems.

Use cases: Before pushing and pulling the stream, detect and locate some possible network problems.
When to call: It needs to be called after [createEngine].
Caution: The SDK detects http, tcp, and udp in sequence internally. If the probe fails in the middle, the subsequent detection will not continue. Therefore, when reading the values in the probe result, please pay attention to check if the value is nil. Network probe may take a long time. Developers can call [stopNetworkProbe] to stop network probe if needed. It is not recommended to start network probe during publishing/playing stream.
Related APIs: Call [stopNetworkProbe] to stop network probe.

Available since: 2.3.0
Restrictions: The SDK will not perform multiple network probe at the same time, that is, if the network probe is in progress, the SDK will ignore subsequent calls of this function.

stopNetworkProbe

- (void)stopNetworkProbe;

Stop network probe.

Declared in ZegoExpressEngine.h

Stop network probe.

Use cases: Before pushing and pulling the stream, detect and locate some possible network problems.
When to call: It needs to be called after [createEngine].
Related APIs: Call [startNetworkProbe] to start network probe.

Available since: 2.3.0
Restrictions: None.

testNetworkConnectivity:

- (void)testNetworkConnectivity:(ZegoTestNetworkConnectivityCallback) callback;

Test network connectivity.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
callback	ZegoTestNetworkConnectivityCallback	Network connectivity test result callback notification.

Details

Test network connectivity.

startNetworkSpeedTest:

- (void)startNetworkSpeedTest:(ZegoNetworkSpeedTestConfig *) config;

Start network speed test.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
config	ZegoNetworkSpeedTestConfig *	Network speed test configuration.

Details

This function supports uplink/downlink network speed test when the network can be connected.

Use cases: This function can be used to detect whether the network environment is suitable for pushing/pulling streams with specified bitrates.
When to call: It needs to be called after [loginRoom]. If you call [startPublishingStream]/[startPlayingStream] while speed testing, the speed test will automatically stop.
Caution: Developers can register [onNetworkSpeedTestQualityUpdate] callback to get the speed test result, which will be triggered every 3 seconds. If an error occurs during the speed test process, [onNetworkSpeedTestError] callback will be triggered. If this function is repeatedly called multiple times, the last functioh call's configuration will be used.
Related APIs: Call [stopNetworkSpeedTest] to stop network speed test.

Available since: 1.20.0
Restrictions: The default maximum allowable test time for a single network speed test is 30 seconds.

startNetworkSpeedTest:interval:

- (void)startNetworkSpeedTest:(ZegoNetworkSpeedTestConfig *) config interval:(unsigned int) interval;

Start network speed test. Support set speed test interval。

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
config	ZegoNetworkSpeedTestConfig *	Network speed test configuration.
interval	unsigned int	Interval of network speed test. In milliseconds, default is 3000 ms.

Details

This function supports uplink/downlink network speed test when the network can be connected.

Use cases: This function can be used to detect whether the network environment is suitable for pushing/pulling streams with specified bitrates.
When to call: It needs to be called after [loginRoom]. If you call [startPublishingStream]/[startPlayingStream] while speed testing, the speed test will automatically stop.
Caution: Developers can register [onNetworkSpeedTestQualityUpdate] callback to get the speed test result, which will be triggered every 3 seconds. If an error occurs during the speed test process, [onNetworkSpeedTestError] callback will be triggered. If this function is repeatedly called multiple times, the last functioh call's configuration will be used.
Related APIs: Call [stopNetworkSpeedTest] to stop network speed test.

Available since: 1.20.0
Restrictions: The default maximum allowable test time for a single network speed test is 30 seconds.

stopNetworkSpeedTest

- (void)stopNetworkSpeedTest;

Stop network speed test.

Declared in ZegoExpressEngine.h

Stop network speed test.

Use cases: This function can be used to detect whether the network environment is suitable for pushing/pulling streams with specified bitrates.
When to call: It needs to be called after [createEngine].
Caution: After the network speed test stopped, [onNetworkSpeedTestQualityUpdate] callback will not be triggered.
Related APIs: Call [startNetworkSpeedTest] to start network speed test.

Available since: 1.20.0
Restrictions: None.

getNetworkTimeInfo

- (ZegoNetworkTimeInfo *)getNetworkTimeInfo;

Obtain synchronization network time information.

Declared in ZegoExpressEngine.h

Obtain synchronization network time(NTP), including timestamp and maximum deviation.

Use cases: When performing multi-terminal synchronization behaviors, network time synchronization is required.
When to call: It needs to be called after [createEngine].

Available since: 2.9.0
Restrictions: None.

startDumpData:

- (void)startDumpData:(ZegoDumpDataConfig *) config;

Dump audio, video data.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
config	ZegoDumpDataConfig *	Dump data config.

Details

Dump audio, video data.

Use cases: This is a debugging tool. When there is a problem with audio/video capturing, 3A processing, or other environment processing during publish, you can dump the audio data and upload it to the ZEGO server for further analysis.
When to call: It needs to be called after [createEngine].
Caution: It will trigger the [onStartDumpData] callback when data dumping starts. The video dump auto-stops after 30 seconds to prevent excessive storage usage, triggering the [onStopDumpData] callback.
Related APIs: Call [stopDumpData] to stop dumping data.

Available since: 3.10.0
Restrictions: Only support Android and iOS to dump video.

stopDumpData

- (void)stopDumpData;

Stop dumping data.

Declared in ZegoExpressEngine.h

Stop dumping data.

Use cases: This is a debugging tool. When there is a problem with audio capturing, 3A processing, or other environment processing during publish, you can dump the audio data and upload it to the ZEGO server for further analysis.
When to call: It needs to be called after [startDumpData].
Caution: It will trigger the [onUploadDumpData] callback.

Available since: 3.10.0
Restrictions: None.

uploadDumpData

- (void)uploadDumpData;

Upload dumped data to the ZEGO server.

Declared in ZegoExpressEngine.h

Upload dumped data to the ZEGO server.

Use cases: This is a debugging tool. When there is a problem with audio capturing, 3A processing, or other environment processing during publish, you can dump the audio data and upload it to the ZEGO server for further analysis.
When to call: It needs to be called after [stopDumpData].
Caution: It will trigger the [onUploadDumpData] callback when dump data uploaded.

Available since: 3.10.0
Restrictions: None.

removeDumpData

- (void)removeDumpData;

Remove dumped data.

Declared in ZegoExpressEngine.h

Remove dumped data.

Use cases: This is a debugging tool. When there is a problem with audio capturing, 3A processing, or other environment processing during publish, you can dump the audio data and upload it to the ZEGO server for further analysis.
When to call: It needs to be called after [stopDumpData]. If the dump data is to be uploaded to the ZEGO server, it should be deleted after the upload is successful.

Available since: 3.10.0
Restrictions: None.

enableCustomVideoRender:config:

- (void)enableCustomVideoRender:(BOOL) enable config:(nullable ZegoCustomVideoRenderConfig *) config;

Enables or disables custom video rendering.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	enable or disable
config	nullable ZegoCustomVideoRenderConfig *	custom video render config

Details

When enable is true,video custom rendering is enabled; if the value of false, video custom rendering is disabled. Use case: Use beauty features or apps that use a cross-platform UI framework (for example, Qt requires a complex hierarchical UI to achieve high-experience interaction) or game engine (e.g. Unity, Unreal Engine, Cocos)

Default value: Custom video rendering is turned off by default when this function is not called.
When to call: After [createEngine], and before calling [startPreview], [startPublishingStream], [startPlayingStream], [createRealTimeSequentialDataManager]. The configuration can only be modified after the engine is stopped, that is, after [logoutRoom] is called.
Caution: Custom video rendering can be used in conjunction with custom video capture, but when both are enabled, the local capture frame callback for custom video rendering will no longer be called back, you should directly use the captured video frame from the custom video capture source.
Related callbacks: Call [setCustomVideoRenderHandler] to set the callback to get video frame data. [onCapturedVideoFrameRawData] local preview video frame data callback, [onRemoteVideoFrameRawData] remote playing stream video frame data callback.

Available since: 1.9.0

setCustomVideoRenderHandler:

- (void)setCustomVideoRenderHandler:(nullable id<ZegoCustomVideoRenderHandler>) handler;

Sets up the event callback handler for custom video rendering.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
handler	nullable id<ZegoCustomVideoRenderHandler>	Custom video render handler

Details

Custom video rendering, where the developer is responsible for rendering the video data onto the UI components. With the change callback set, a callback that throws video data to the developer will be triggered when the developer calls startPreview, startPublishingStream, and startPlayingStream. Use case: Use beauty features or apps that use a cross-platform UI framework (for example, Qt requires a complex hierarchical UI to achieve high-experience interaction) or game engine (e.g. Unity, Unreal Engine, Cocos)

When to call: After [createEngine].
Related callbacks: [onCapturedVideoFrameRawData] local preview video frame data callback, [onRemoteVideoFrameRawData] remote playing stream video frame data callback.

Available since: 1.9.0

enableCapturedVideoCustomVideoRender:channel:

- (void)enableCapturedVideoCustomVideoRender:(BOOL) enable channel:(ZegoPublishChannel) channel;

Enables or disables captured video to custom video rendering.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	enable or disable
channel	ZegoPublishChannel	publish channel

Details

enable or disable custom video rendering of captured video during publish. Use case: Use beauty features or apps that use a cross-platform UI framework (for example, Qt requires a complex hierarchical UI to achieve high-experience interaction) or game engine (e.g. Unity, Unreal Engine, Cocos)

Default value: After [enableCustomVideoRender] enables custom video rendering, all captured videos will be used as custom video data.
When to call: After [enableCustomVideoRender] enables custom video rendering, call [enableCapturedVideoCustomVideoRender] to config whether the specified channel used custom video render or not.
Caution: You can call this API only after [enableCustomVideoRender] enables custom video rendering.Custom video rendering can be used in conjunction with custom video capture, but when both are enabled, the local capture frame callback for custom video rendering will no longer be called back, you should directly use the captured video frame from the custom video capture source.
Related callbacks: Call [setCustomVideoRenderHandler] to set the callback to get video frame data. [onCapturedVideoFrameRawData] local preview video frame data callback, [onRemoteVideoFrameRawData] remote playing stream video frame data callback.

Available since: 3.13.0

enableRemoteVideoCustomVideoRender:streamID:

- (void)enableRemoteVideoCustomVideoRender:(BOOL) enable streamID:(NSString *) streamID;

Enables or disables remote playback video to custom video rendering.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	enable or disable
streamID	NSString *	Stream ID.

Details

enable or disable custom video rendering during playback. Use case: Use beauty features or apps that use a cross-platform UI framework (for example, Qt requires a complex hierarchical UI to achieve high-experience interaction) or game engine (e.g. Unity, Unreal Engine, Cocos)

Default value: After [enableCustomVideoRender] enables custom video rendering, all remote playback videos will be used as custom video data.
When to call: After [enableCustomVideoRender] enables custom video rendering, call [enableRemoteVideoCustomVideoRender] to config whether the specified stream used custom video render or not.
Caution: You can call this API only after [enableCustomVideoRender] enables custom video rendering.
Related callbacks: Call [setCustomVideoRenderHandler] to set the callback to get video frame data. [onCapturedVideoFrameRawData] local preview video frame data callback, [onRemoteVideoFrameRawData] remote playing stream video frame data callback.

Available since: 3.13.0

enableCustomVideoCapture:config:

- (void)enableCustomVideoCapture:(BOOL) enable config:(nullable ZegoCustomVideoCaptureConfig *) config;

Enables or disables custom video capture.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	enable or disable
config	nullable ZegoCustomVideoCaptureConfig *	custom video capture config

Details

If the value of enable is true, the video collection function is enabled. If the value of enable is false, the video collection function is disabled. Use case: The App developed by the developer uses the beauty SDK of a third-party beauty manufacturer to broadcast non-camera collected data.

Default value: When this function is not called, custom video collection is disabled by default.
When to call: After [createEngine], call [startPreview], [startPublishingStream], [createRealTimeSequentialDataManager], and call [logoutRoom] to modify the configuration.
Caution: Custom video rendering can be used in conjunction with custom video capture, but when both are enabled, the local capture frame callback for custom video rendering will no longer be triggered, and the developer should directly capture the captured video frame from the custom video capture source.
Related callbacks: When developers to open a custom collection, by calling [setCustomVideoCaptureHandler] can be set up to receive a custom collection start-stop event notification.

Available since: 1.9.0

enableCustomVideoCapture:config:channel:

- (void)enableCustomVideoCapture:(BOOL) enable config:(nullable ZegoCustomVideoCaptureConfig *) config channel:(ZegoPublishChannel) channel;

Enables or disables custom video capture (for the specified channel).

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	enable or disable
config	nullable ZegoCustomVideoCaptureConfig *	custom video capture config
channel	ZegoPublishChannel	publish channel

Details

Default value: When this function is not called, custom video collection is disabled by default.
When to call: After [createEngine], call [startPreview], [startPublishingStream], [createRealTimeSequentialDataManager], and call [logoutRoom] to modify the configuration.
Caution: Custom video rendering can be used in conjunction with custom video capture, but when both are enabled, the local capture frame callback for custom video rendering will no longer be triggered, and the developer should directly capture the captured video frame from the custom video capture source.
Related callbacks: When developers to open a custom collection, by calling [setCustomVideoCaptureHandler] can be set up to receive a custom collection start-stop event notification.

Available since: 1.9.0

setCustomVideoCaptureHandler:

- (void)setCustomVideoCaptureHandler:(nullable id<ZegoCustomVideoCaptureHandler>) handler;

Sets the event callback handler for custom video capture.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
handler	nullable id<ZegoCustomVideoCaptureHandler>	Custom video capture handler

Details

Example Set the callback for custom video capture. That is, the developer is responsible for collecting video data, and sends the collected video data to the SDK for coding and pushing the video data to the ZEGO RTC server. Use case: This feature is typically used by developers using third-party beauty features or livestreaming of games.

When to call: After [createEngine] .
Caution: In the case of customized video collection, the SDK will not start the camera to collect video data, and developers need to collect video data from the video collection source. A callback notifying the developer that it can start sending video data is triggered when the developer calls [startPreview] to start pushing the stream to [startPublishingStream]. A callback notifying the developer that it can stop sending video data is triggered when [stopPreview] and [stopPublishingStream].
Related callbacks: [onStart] Starts collection, and [onStop] stops collection.

Available since: 1.9.0

sendCustomVideoCaptureTextureData:size:timestamp:

- (void)sendCustomVideoCaptureTextureData:(GLuint) textureID size:(CGSize) size timestamp:(CMTime) timestamp;

Sends the video frames (Texture Data) produced by custom video capture to the SDK.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
textureID	GLuint	texture ID
size	CGSize	Video frame width and height
timestamp	CMTime	Timestamp of this video frame

Details

Send custom captured video frame type GL_TEXTURE_2D data to the SDK.

When to call: After receiving the [onStart] notification, the developer starts the call after the collection logic starts and ends the call after the [onStop] notification.
Caution: Calling this interface must be [enableCustomVideoCapture] with an argument of type GL_TEXTURE_2D or GL_TEXTURE_EXTERNAL_OES.
Related APIs: [enableCustomVideoCapture], [setCustomVideoCaptureHandler].

Available since: 1.9.0

sendCustomVideoCaptureTextureData:size:timestamp:channel:

- (void)sendCustomVideoCaptureTextureData:(GLuint) textureID size:(CGSize) size timestamp:(CMTime) timestamp channel:(ZegoPublishChannel) channel;

Sends the video frames (Texture Data) produced by custom video capture to the SDK (for the specified channel).

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
textureID	GLuint	texture ID
size	CGSize	Video frame width and height
timestamp	CMTime	Timestamp of this video frame
channel	ZegoPublishChannel	Publishing stream channel

Details

Send custom captured video frame type GL_TEXTURE_2D data to the SDK.

When to call: After receiving the [onStart] notification, the developer starts the call after the collection logic starts and ends the call after the [onStop] notification.
Caution: Calling this interface must be [enableCustomVideoCapture] with an argument of type GL_TEXTURE_2D or GL_TEXTURE_EXTERNAL_OES.
Related APIs: [enableCustomVideoCapture], [setCustomVideoCaptureHandler].

Available since: 1.9.0

sendCustomVideoCapturePixelBuffer:timestamp:

- (void)sendCustomVideoCapturePixelBuffer:(CVPixelBufferRef) buffer timestamp:(CMTime) timestamp;

Sends the video frames (CVPixelBuffer) produced by custom video capture to the SDK.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
buffer	CVPixelBufferRef	Video frame data to send to the SDK
timestamp	CMTime	Timestamp of this video frame

Details

Send custom captured video frame type CVPixelBuffer data to the SDK.

When to call: After receiving the [onStart] notification, the developer starts the call after the collection logic starts and ends the call after the [onStop] notification.
Caution: Calling this interface must be [enableCustomVideoCapture] with an argument of type ZegoVideoBufferTypeCVPixelBuffer.
Related APIs: [enableCustomVideoCapture], [setCustomVideoCaptureHandler].

Available since: 1.9.0

sendCustomVideoCapturePixelBuffer:timestamp:channel:

- (void)sendCustomVideoCapturePixelBuffer:(CVPixelBufferRef) buffer timestamp:(CMTime) timestamp channel:(ZegoPublishChannel) channel;

Sends the video frames (CVPixelBuffer) produced by custom video capture to the SDK (for the specified channel).

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
buffer	CVPixelBufferRef	Video frame data to send to the SDK
timestamp	CMTime	Timestamp of this video frame
channel	ZegoPublishChannel	Publishing stream channel

Details

Send custom captured video frame type CVPixelBuffer data to the SDK.

When to call: After receiving the [onStart] notification, the developer starts the call after the collection logic starts and ends the call after the [onStop] notification.
Caution: Calling this interface must be [enableCustomVideoCapture] with an argument of type ZegoVideoBufferTypeCVPixelBuffer.
Related APIs: [enableCustomVideoCapture], [setCustomVideoCaptureHandler].

Available since: 1.9.0

sendCustomVideoCaptureEncodedData:params:timestamp:

- (void)sendCustomVideoCaptureEncodedData:(NSData *) data params:(ZegoVideoEncodedFrameParam *) params timestamp:(CMTime) timestamp;

Sends the video frames (Encoded Data) produced by custom video capture to the SDK.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
data	NSData *	video encoded frame data
params	ZegoVideoEncodedFrameParam *	video encoded frame param
timestamp	CMTime	video frame reference time, UNIX timestamp.

Details

Send custom captured video frame type CVPixelBuffer data to the SDK.

When to call: After receiving the [onStart] notification, the developer starts the call after the collection logic starts and ends the call after the [onStop] notification.
Caution: It is recommended to make a GOP every 2s; each I frame must carry SPS and PPS which should be placed at the front of the data; the SPS, PPS and I frame need to be combined into one frame for transmission. Before calling this API, you need to ensure that the parameter type specified when calling [enableCustomVideoCapture] is [EncodedData]
Related APIs: [enableCustomVideoCapture], [setCustomVideoCaptureHandler].

Available since: 1.9.0

sendCustomVideoCaptureEncodedData:params:timestamp:channel:

- (void)sendCustomVideoCaptureEncodedData:(NSData *) data params:(ZegoVideoEncodedFrameParam *) params timestamp:(CMTime) timestamp channel:(ZegoPublishChannel) channel;

Sends the video frames (Encoded Data) produced by custom video capture to the SDK (for the specified channel).

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
data	NSData *	video frame encoded data
params	ZegoVideoEncodedFrameParam *	video frame param
timestamp	CMTime	video frame reference time, UNIX timestamp.
channel	ZegoPublishChannel	Publishing stream channel

Details

Send custom captured video frame type CVPixelBuffer data to the SDK.

When to call: After receiving the [onStart] notification, the developer starts the call after the collection logic starts and ends the call after the [onStop] notification.
Caution: It is recommended to make a GOP every 2s; each I frame must carry SPS and PPS which should be placed at the front of the data; the SPS, PPS and I frame need to be combined into one frame for transmission. Before calling this API, you need to ensure that the parameter type specified when calling [enableCustomVideoCapture] is [EncodedData]
Related APIs: [enableCustomVideoCapture], [setCustomVideoCaptureHandler].

Available since: 1.9.0

setCustomVideoCaptureFillMode:

- (void)setCustomVideoCaptureFillMode:(ZegoViewMode) mode;

Sets the video fill mode of custom video capture.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
mode	ZegoViewMode	View mode

Details

When the custom video collection function is enabled, you can use this interface to set the video zooming and filling mode.

Use cases: If the customized collection resolution and SDK coding resolution are inconsistent, THE SDK will process the video frame according to the fill mode and adjust it to the coding resolution.
When to call: Before [sendCustomVideoCaptureRawData], [sendCustomVideoCaptureTextureData], [sendCustomVideoCapturePixelBuffer], [sendCustomVideoCaptureEncodedData].

Available since: 1.10.0

setCustomVideoCaptureFillMode:channel:

- (void)setCustomVideoCaptureFillMode:(ZegoViewMode) mode channel:(ZegoPublishChannel) channel;

Sets the video fill mode of custom video capture (for the specified channel).

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
mode	ZegoViewMode	View mode
channel	ZegoPublishChannel	Publishing stream channel

Details

When the custom video collection function is enabled, you can use this interface to set the video zooming and filling mode.

Use cases: If the customized collection resolution and SDK coding resolution are inconsistent, THE SDK will process the video frame according to the fill mode and adjust it to the coding resolution.
When to call: Before [sendCustomVideoCaptureRawData], [sendCustomVideoCaptureTextureData], [sendCustomVideoCapturePixelBuffer], [sendCustomVideoCaptureEncodedData].

Available since: 1.10.0

setCustomVideoCaptureFlipMode:

- (void)setCustomVideoCaptureFlipMode:(ZegoVideoFlipMode) mode;

Sets the video flip mode of custom video capture (for the specified channel). This function takes effect only if the custom video buffer type is Texture2D.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
mode	ZegoVideoFlipMode	Flip mode

Details

When the custom video collection function is enabled, you can use this interface to set the video flipping mode.

When to call: Before [sendCustomVideoCaptureRawData], [sendCustomVideoCaptureTextureData], [sendCustomVideoCapturePixelBuffer], [sendCustomVideoCaptureEncodedData].
Caution: This function takes effect only if the custom collection type is Texture2D.

Available since: 1.10.0

setCustomVideoCaptureFlipMode:channel:

- (void)setCustomVideoCaptureFlipMode:(ZegoVideoFlipMode) mode channel:(ZegoPublishChannel) channel;

Sets the video flip mode of custom video capture (for the specified channel). This function takes effect only if the custom video buffer type is Texture2D.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
mode	ZegoVideoFlipMode	Flip mode
channel	ZegoPublishChannel	Publishing stream channel

Details

When the custom video collection function is enabled, you can use this interface to set the video flipping mode.

When to call: Before [sendCustomVideoCaptureRawData], [sendCustomVideoCaptureTextureData], [sendCustomVideoCapturePixelBuffer], [sendCustomVideoCaptureEncodedData].
Caution: This function takes effect only if the custom collection type is Texture2D.

Available since: 1.10.0

setCustomVideoCaptureRotation:channel:

- (void)setCustomVideoCaptureRotation:(int) rotation channel:(ZegoPublishChannel) channel;

Sets the video rotation of custom video capture (for the specified channel).

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
rotation	int	Clockwise angle.
channel	ZegoPublishChannel	Publishing stream channel

Details

You can set the video rotation of custom video capture (for the specified channel) through this function.

When to call: After the callback [onStart] is received.

Available since: 2.14.0.
Restrictions: This function takes effect when the custom acquisition type is CVPixelBuffer or Texture2D.

setCustomVideoCaptureDeviceState:state:channel:

- (void)setCustomVideoCaptureDeviceState:(BOOL) isEnable state:(ZegoRemoteDeviceState) state channel:(ZegoPublishChannel) channel;

Sets device state of custom video capture (for the specified channel).

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
isEnable	BOOL	Whether the device is enable.
state	ZegoRemoteDeviceState	The device state.
channel	ZegoPublishChannel	Publishing stream channel

Details

User can set the video device state of custom video capture (for the specified channel) through this function.

When to call: After the callback [onStart] is received.

Available since: 2.15.0.
Restrictions: None. Related Callbacks: The remote user that play stream of local user publishing stream can receive state update notification by monitoring [onRemoteCameraStateUpdate] callbacks.

setCustomVideoCaptureRegionOfInterest:channel:

- (void)setCustomVideoCaptureRegionOfInterest:(NSArray<ZegoRoiRect *> *) rectList channel:(ZegoPublishChannel) channel;

Set the region of interest (ROI) for encoder of custom video capture (for the specified channel).

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
rectList	NSArray<ZegoRoiRect >	ROI rectangle area list, currently supports up to 6 areas.
channel	ZegoPublishChannel	Publish channel

Details

You can set the video encoder's region of interest rectangle areas of custom video capture (for the specified channel) through this function.

When to call: After the callback [onStart] is received.
Caution: This function is currently an experimental feature, please contact ZEGO technical support before using it.

Available since: 2.16.0.
Restrictions: Currently, only certain video encoders support this function, please contact ZEGO technical support before using it.

prepareForReplayKit

- (void)prepareForReplayKit;

Initialize the Express ReplayKit module.

Declared in ZegoExpressEngine.h

Only use in the ReplayKit sub-process, don't use it in the main App process

setReplayKitMicrophoneVolume:

- (void)setReplayKitMicrophoneVolume:(int) volume;

Set ReplayKit Microphone volume

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
volume	int	The range is 0 ~ 200. The default is 100.

Details

Set Microphone audio volume for ReplayKit.

Use cases: Set Microphone audio volume in the game live scenarios.
When to call /Trigger: This function needs to be called after the success of [startPreview] or [startPublishingStream] to be effective.
Caution: This function affects the audio volume of type RPSampleBufferTypeAudioMic.
Related APIs: [setReplayKitApplicationVolume] function can set the Application audio volume for ReplayKit.

Available since: 2.13.0
Restrictions: None.

setReplayKitApplicationVolume:

- (void)setReplayKitApplicationVolume:(int) volume;

Set ReplayKit Application volume

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
volume	int	The range is 0 ~ 200. The default is 100.

Details

Set Application audio volume for ReplayKit.

Use cases: Set Application audio volume in the game live scenarios.
When to call /Trigger: This function needs to be called after the success of [startPreview] or [startPublishingStream] to be effective.
Caution: This function affects the audio volume of type RPSampleBufferTypeAudioApp.
Related APIs: [setReplayKitMicrophoneVolume] function can set the Microphone audio volume for ReplayKit.

Available since: 2.13.0
Restrictions: None.

handleReplayKitSampleBuffer:bufferType

- (void)handleReplayKitSampleBuffer:(CMSampleBufferRef)sampleBuffer bufferType:(RPSampleBufferType)bufferType API_AVAILABLE(ios(10.0));

Handles ReplayKit's SampleBuffer, supports receiving video and audio buffer.

Declared in ZegoExpressEngine.h

Name	Type	Description
sampleBuffer	CMSampleBufferRef	Video or audio buffer returned by ReplayKit
bufferType	RPSampleBufferType	Buffer type returned by ReplayKit

enableCustomVideoProcessing:config:

- (void)enableCustomVideoProcessing:(BOOL) enable config:(nullable ZegoCustomVideoProcessConfig *) config;

Enables or disables custom video processing.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	enable or disable. Required: Yes.
config	nullable ZegoCustomVideoProcessConfig *	custom video processing configuration. Required: Yes.Caution: If nil is passed, the platform default value is used.

Details

When the developer opens custom pre-processing, by calling [setCustomVideoProcessHandler] you can set the custom video pre-processing callback.

Use cases: After the developer collects the video data by himself or obtains the video data collected by the SDK, if the basic beauty and watermark functions of the SDK cannot meet the needs of the developer (for example, the beauty effect cannot meet the expectations), the ZegoEffects SDK can be used to perform the video Some special processing, such as beautifying, adding pendants, etc., this process is the pre-processing of custom video.
Default value: Off by default
When to call: Must be set before calling [startPreview], [startPublishingStream], [createRealTimeSequentialDataManager]. If you need to modify the configuration, please call [logoutRoom] to log out of the room first, otherwise it will not take effect.
Related APIs: Call the [setCustomVideoProcessHandler] function to set the callback before custom video processing.

Available since: 2.2.0 (Android/iOS/macOS native), 2.4.0 (Windows/macOS C++).
Restrictions: None.

enableCustomVideoProcessing:config:channel:

- (void)enableCustomVideoProcessing:(BOOL) enable config:(nullable ZegoCustomVideoProcessConfig *) config channel:(ZegoPublishChannel) channel;

Enables or disables custom video processing, and support specifying the publish channel.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	enable or disable. Required: Yes.
config	nullable ZegoCustomVideoProcessConfig *	custom video processing configuration. Required: Yes.Caution: If nil is passed, the platform default value is used.
channel	ZegoPublishChannel	Publishing stream channel.Required: No.Default value: Main publish channel.

Details

When the developer opens custom pre-processing, by calling [setCustomVideoProcessHandler] you can set the custom video pre-processing callback.

Use cases: After the developer collects the video data by himself or obtains the video data collected by the SDK, if the basic beauty and watermark functions of the SDK cannot meet the needs of the developer (for example, the beauty effect cannot meet the expectations), the ZegoEffects SDK can be used to perform the video Some special processing, such as beautifying, adding pendants, etc., this process is the pre-processing of custom video.
Default value: Off by default
When to call: Must be set before calling [startPreview], [startPublishingStream], [createRealTimeSequentialDataManager]. If you need to modify the configuration, please call [logoutRoom] to log out of the room first, otherwise it will not take effect.
Related APIs: Call the [setCustomVideoProcessHandler] function to set the callback before custom video processing.

Available since: 2.2.0 (Android/iOS/macOS native), 2.4.0 (Windows/macOS C++).
Restrictions: None.

setCustomVideoProcessHandler:

- (void)setCustomVideoProcessHandler:(nullable id<ZegoCustomVideoProcessHandler>) handler;

Sets up the event callback handler for custom video processing.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
handler	nullable id<ZegoCustomVideoProcessHandler>	Custom video process handler.Required: Yes.

Details

When the developer opens the custom pre-processing, by calling [setCustomVideoProcessHandler], you can set the custom video pre-processing callback to obtain the original video data.

Use cases: After the developer collects the video data by himself or obtains the video data collected by the SDK, if the basic beauty and watermark functions of the SDK cannot meet the needs of the developer (for example, the beauty effect cannot meet the expectations), the ZegoEffects SDK can be used to perform the video Some special processing, such as beautifying, adding pendants, etc., this process is the pre-processing of custom video.
When to call: Called before [startPreview], [startPublishingStream] and [createRealTimeSequentialDataManager], otherwise it may cause the timing of obtaining video data to be too slow.
Related APIs: Call [enableCustomVideoProcessing] function to enable custom video pre-processing callback.

Available since: 2.2.0 (Android/iOS/macOS native), 2.4.0 (Windows/macOS C++).
Restrictions: None.

sendCustomVideoProcessedCVPixelBuffer:timestamp:

- (void)sendCustomVideoProcessedCVPixelBuffer:(CVPixelBufferRef) buffer timestamp:(CMTime) timestamp;

Send the [CVPixelBuffer] type video data after the custom video processing to the SDK (for the specified channel).

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
buffer	CVPixelBufferRef	CVPixelBuffer type video frame data to be sent to the SDK.Required: Yes.
timestamp	CMTime	Timestamp of this video frame.Required: Yes.

Details

When the custom video pre-processing is turned on, the [CVPixelBuffer] format video data after the custom video pre-processing is sent to the SDK, and other channels are supported.

Use cases: After the developer collects the video data by himself or obtains the video data collected by the SDK, if the basic beauty and watermark functions of the SDK cannot meet the needs of the developer (for example, the beauty effect cannot meet the expectations), the ZegoEffects SDK can be used to perform the video Some special processing, such as beautifying, adding pendants, etc., this process is the pre-processing of custom video.
When to call: Must be called in the [onCapturedUnprocessedCVPixelbuffer] callback.
Platform differences: Only valid on Windows platform.

Available since: 2.2.0 (iOS native), 2.4.0 (macOS C++).
Restrictions: This interface takes effect when [enableCustomVideoProcessing] is called to enable custom video pre-processing and the bufferType of config is passed in [ZegoVideoBufferTypeCVPixelBuffer] or [ZegoVideoBufferTypeNV12CVPixelBuffer].

sendCustomVideoProcessedCVPixelBuffer:timestamp:channel:

- (void)sendCustomVideoProcessedCVPixelBuffer:(CVPixelBufferRef) buffer timestamp:(CMTime) timestamp channel:(ZegoPublishChannel) channel;

Send the [CVPixelBuffer] type video data after the custom video processing to the SDK (for the specified channel).

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
buffer	CVPixelBufferRef	CVPixelBuffer type video frame data to be sent to the SDK.
timestamp	CMTime	Timestamp of this video frame.
channel	ZegoPublishChannel	Publishing stream channel.

Details

When the custom video pre-processing is turned on, the [CVPixelBuffer] format video data after the custom video pre-processing is sent to the SDK, and other channels are supported.

Use cases: After the developer collects the video data by himself or obtains the video data collected by the SDK, if the basic beauty and watermark functions of the SDK cannot meet the needs of the developer (for example, the beauty effect cannot meet the expectations), the ZegoEffects SDK can be used to perform the video Some special processing, such as beautifying, adding pendants, etc., this process is the pre-processing of custom video.
When to call: Must be called in the [onCapturedUnprocessedCVPixelbuffer] callback.
Platform differences: Only valid on Windows platform.

Available since: 2.2.0 (iOS native), 2.4.0 (macOS C++).
Restrictions: This interface takes effect when [enableCustomVideoProcessing] is called to enable custom video pre-processing and the bufferType of config is passed in [ZegoVideoBufferTypeCVPixelBuffer] or [ZegoVideoBufferTypeNV12CVPixelBuffer].

sendCustomVideoProcessedCVPixelBuffer:timestamp:usage:channel:

- (void)sendCustomVideoProcessedCVPixelBuffer:(CVPixelBufferRef) buffer timestamp:(CMTime) timestamp usage:(ZegoProcessedDataUsageType) usage channel:(ZegoPublishChannel) channel;

Send the [CVPixelBuffer] type video data after the custom video processing to the SDK (for the specified channel), and support specified data usage.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
buffer	CVPixelBufferRef	CVPixelBuffer type video frame data to be sent to the SDK.
timestamp	CMTime	Timestamp of this video frame.
usage	ZegoProcessedDataUsageType	Data usage
channel	ZegoPublishChannel	Publishing stream channel.

Details

When the custom video pre-processing is turned on, the [CVPixelBuffer] format video data after the custom video pre-processing is sent to the SDK, and other channels are supported.

Use cases: After the developer collects the video data by himself or obtains the video data collected by the SDK, if the basic beauty and watermark functions of the SDK cannot meet the needs of the developer (for example, the beauty effect cannot meet the expectations), the ZegoEffects SDK can be used to perform the video Some special processing, such as beautifying, adding pendants, etc., this process is the pre-processing of custom video.
When to call: Must be called in the [onCapturedUnprocessedCVPixelbuffer] callback.
Platform differences: Only valid on Windows platform.

Available since: 3.14.0 (iOS native, macOS C++).
Restrictions: This interface takes effect when [enableCustomVideoProcessing] is called to enable custom video pre-processing and the bufferType of config is passed in [ZegoVideoBufferTypeCVPixelBuffer] or [ZegoVideoBufferTypeNV12CVPixelBuffer].

enableCustomAudioCaptureProcessing:config:

- (void)enableCustomAudioCaptureProcessing:(BOOL) enable config:(ZegoCustomAudioProcessConfig *) config;

Enable local collection and custom audio processing(before ear return).

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	Whether to enable local capture custom audio processing.
config	ZegoCustomAudioProcessConfig *	Custom audio processing configuration.

Details

Enable custom audio processing(before ear return), developers can receive locally collected audio frames through [onProcessCapturedAudioData], and can modify the audio data.

Use cases: If the developer wants to implement special functions (such as voice change, bel canto, etc.) through custom processing after the audio data is collected or before the remote audio data is drawn for rendering.
When to call: It needs to be called before [startPublishingStream], [startPlayingStream], [startPreview], [createMediaPlayer], [createAudioEffectPlayer] and [createRealTimeSequentialDataManager] to be effective.

Available since: 1.13.0
Restrictions: None.

enableCustomAudioCaptureProcessingAfterHeadphoneMonitor:config:

- (void)enableCustomAudioCaptureProcessingAfterHeadphoneMonitor:(BOOL) enable config:(ZegoCustomAudioProcessConfig *) config;

Turn on local collection and custom audio processing (after ear return).

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	Whether to enable local capture custom audio processing.
config	ZegoCustomAudioProcessConfig *	Custom audio processing configuration.

Details

Enable custom audio processing(after ear return), developers can receive locally collected audio frames through [onProcessCapturedAudioData], and can modify the audio data.

Use cases: If the developer wants to implement special functions (such as voice change, bel canto, etc.) through custom processing after the audio data is collected or before the remote audio data is drawn for rendering.
When to call: It needs to be called before [startPublishingStream], [startPlayingStream], [startPreview], [createMediaPlayer], [createAudioEffectPlayer] and [createRealTimeSequentialDataManager] to be effective.

Available since: 1.13.0
Restrictions: None.

enableAlignedAudioAuxData:param:

- (void)enableAlignedAudioAuxData:(BOOL) enable param:(ZegoAudioFrameParam *) param;

Enable feature of throwing audio aux frames which aligned with accompany.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	Whether to enable the feature of throwing alignmented audio aux frames.
param	ZegoAudioFrameParam *	param of audio frame. Currently supports 8k, 16k, 32k, 44.1k, 48k sampling rate, mono or stereo.

Details

Enable feature of throwing audio aux frames which aligned with accompany, and developers can receive the aligned audio aux frame through [onAlignedAudioAuxData].

Use cases: In KTV scene, this function can be used if the user wants to record voice and accompaniment for free processing.
When to call: It needs to be called after [createEngine] to be effective.
Caution: When throwing onAlignedAudioAuxData audio aux frames is enabled, the streaming data of [startPublishingStream] does not contain audio aux frames.

Available since: 2.22.0
Restrictions: None.

enableBeforeAudioPrepAudioData:param:

- (void)enableBeforeAudioPrepAudioData:(BOOL) enable param:(ZegoAudioFrameParam *) param;

Enable the feature of throwing audio data before SDK internal audio preprocessing.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	Whether to enable feature of throwing audio data before SDK internal audio preprocessing.
param	ZegoAudioFrameParam *	param of audio frame. Currently, it supports sampling rates of 0, 16k, 32k, 44.1k, and 48k. The 0 means using SDK internal value. It supports channels Unknown, Mono, and Stereo. The Unknown means using SDK internal value.

Details

Enables the feature of throwing audio data before SDK internal audio preprocessing, and developers can receive audio data before SDK internal audio preprocessing through [onBeforeAudioPrepAudioData].

When to call: It needs to be called after [createEngine] to be effective.

Available since: 3.11.0
Restrictions: None.

enableCustomAudioRemoteProcessing:config:

- (void)enableCustomAudioRemoteProcessing:(BOOL) enable config:(ZegoCustomAudioProcessConfig *) config;

Enable custom audio processing for remote playing stream.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	Whether to enable custom audio processing for remote playing stream.
config	ZegoCustomAudioProcessConfig *	Custom audio processing configuration.

Details

Enable remote streaming custom audio processing, developers can receive remote streaming audio frames through [onProcessRemoteAudioData], and can modify the audio data.

Use cases: If the developer wants to implement special functions (such as voice change, bel canto, etc.) through custom processing before pulling the remote audio data for rendering.
When to call: It needs to be called before [startPublishingStream], [startPlayingStream], [startPreview], [createMediaPlayer], [createAudioEffectPlayer] and [createRealTimeSequentialDataManager] to be effective.

Available since: 1.13.0
Restrictions: None.

enableCustomAudioPlaybackProcessing:config:

- (void)enableCustomAudioPlaybackProcessing:(BOOL) enable config:(ZegoCustomAudioProcessConfig *) config;

Enable custom audio processing for SDK playback audio data.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	Whether to enable custom audio processing for SDK playback audio data.
config	ZegoCustomAudioProcessConfig *	Custom audio processing configuration.

Details

Enable remote streaming custom audio processing, developers can receive remote streaming audio frames through [onProcessPlaybackAudioData], and can modify the audio data.

Use cases: If the developer wants to implement special functions (such as voice change, bel canto, etc.) through custom processing after collecting audio data.
When to call: It needs to be called before [startPublishingStream], [startPlayingStream], [startPreview], [createMediaPlayer], [createAudioEffectPlayer] and [createRealTimeSequentialDataManager] to be effective.

Available since: 1.13.0
Restrictions: None.

setCustomAudioProcessHandler:

- (void)setCustomAudioProcessHandler:(nullable id<ZegoCustomAudioProcessHandler>) handler;

Set up callback handler for custom audio processing.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
handler	nullable id<ZegoCustomAudioProcessHandler>	Callback handler for custom audio processing.

Details

When the custom audio processing is enabled, the custom audio processing callback is set through this function, and the developer can modify the processed audio frame data in the callback.

Use cases: If the developer wants to implement special functions (such as voice change, bel canto, etc.) through custom processing after the audio data is collected or before the remote audio data is drawn for rendering.
When to call: After creating the engine.

Available since: 1.13.0
Restrictions: None.

startAudioDataObserver:param:

- (void)startAudioDataObserver:(ZegoAudioDataCallbackBitMask) observerBitMask param:(ZegoAudioFrameParam *) param;

Enable audio data observering.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
observerBitMask	ZegoAudioDataCallbackBitMask	The callback function bitmask marker for receive audio data, refer to enum [ZegoAudioDataCallbackBitMask], when this param converted to binary, 0b01 that means 1 << 0 for triggering [onCapturedAudioData], 0x10 that means 1 << 1 for triggering [onPlaybackAudioData], 0x100 that means 1 << 2 for triggering [onMixedAudioData], 0x1000 that means 1 << 3 for triggering [onPlayerAudioData]. The masks can be combined to allow different callbacks to be triggered simultaneously.
param	ZegoAudioFrameParam *	param of audio frame.

Details

When custom audio processing is turned on, use this function to turn on audio data callback monitoring.

Use cases: When develop need to monitor the original audio.
When to call: After creating the engine.
Caution: This api will start the media engine and occupy the microphone device.

Available since: 1.1.0
Restrictions: Audio monitoring is triggered only after this function has been called and the callback has been set by calling [setAudioDataHandler]. If you want to enable the [onPlayerAudioData] callback, you must also be in the pull stream, and the incoming sampling rate of the [startAudioDataObserver] function is not supported at 8000Hz, 22050Hz, and 24000Hz.

stopAudioDataObserver

- (void)stopAudioDataObserver;

Disable audio data observering.

Declared in ZegoExpressEngine.h

Disable audio data observering.

Use cases: When develop need to monitor the original audio.
When to call: After calling [startAudioDataObserver] to start audio data monitoring.

Available since: 1.1.0

setAudioDataHandler:

- (void)setAudioDataHandler:(nullable id<ZegoAudioDataHandler>) handler;

Sets up the event callback handler for receiving audio data.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
handler	nullable id<ZegoAudioDataHandler>	Audio data handler for receive audio data.

Details

This function can be called to receive audio data thrown by SDK bypass.

Use cases: When the developer needs to obtain the audio data of the remote user or the data collected by the local microphone for other purposes (such as pure audio recording, pure audio third-party monitoring, pure audio real-time analysis).
When to call: After creating the engine.
Related APIs: Turn on the audio data monitoring call [startAudioDataObserver], turn off the audio data monitoring call [stopAudioDataObserver].
Caution: The format of the thrown audio data is pcm. The SDK still controls the collection and playback of the sound device. This function is to copy a copy of the data collected or played inside the SDK for use by the developer.

Available since: 1.1.0
Restrictions: The set callback needs to be effective after calling [startAudioDataObserver] and is in the push or pull state.

enableCustomAudioIO:config:

- (void)enableCustomAudioIO:(BOOL) enable config:(ZegoCustomAudioConfig *) config;

Enables the custom audio I/O function.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	Whether to enable custom audio IO, default is false.
config	ZegoCustomAudioConfig *	Custom audio IO config.

Details

Enable custom audio IO function, support PCM, AAC format data.

Use cases: If the developer wants to implement special functions (such as voice change, bel canto, etc.) through custom processing after the audio data is collected or before the remote audio data is drawn for rendering.
When to call: It needs to be called before [startPublishingStream], [startPlayingStream], [startPreview], [createMediaPlayer], [createAudioEffectPlayer] and [createRealTimeSequentialDataManager] to be effective.

Available since: 1.10.0
Restrictions: None.

enableCustomAudioIO:config:channel:

- (void)enableCustomAudioIO:(BOOL) enable config:(ZegoCustomAudioConfig *) config channel:(ZegoPublishChannel) channel;

Enables the custom audio I/O function (for the specified channel), support PCM, AAC format data.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
enable	BOOL	Whether to enable custom audio IO, default is false.
config	ZegoCustomAudioConfig *	Custom audio IO config.
channel	ZegoPublishChannel	Specify the publish channel to enable custom audio IO.

Details

Enable custom audio IO function, support PCM, AAC format data.

Use cases: If the developer wants to implement special functions (such as voice change, bel canto, etc.) through custom processing after the audio data is collected or before the remote audio data is drawn for rendering.
When to call: It needs to be called before [startPublishingStream], [startPlayingStream], [startPreview], [createMediaPlayer], [createAudioEffectPlayer] and [createRealTimeSequentialDataManager] to be effective.

Available since: 1.10.0
Restrictions: None.

sendCustomAudioCaptureAACData:dataLength:configLength:timestamp:samples:param:channel:

- (void)sendCustomAudioCaptureAACData:(unsigned char *) data dataLength:(unsigned int) dataLength configLength:(unsigned int) configLength timestamp:(CMTime) timestamp samples:(unsigned int) samples param:(ZegoAudioFrameParam *) param channel:(ZegoPublishChannel) channel;

Sends AAC audio data produced by custom audio capture to the SDK (for the specified channel).

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
data	unsigned char *	AAC buffer data.
dataLength	unsigned int	The total length of the buffer data.
configLength	unsigned int	The length of AAC specific config (Note: The AAC encoded data length is 'encodedLength = dataLength - configLength').Value range: [0,64]
timestamp	CMTime	The UNIX timestamp of this AAC audio frame.
samples	unsigned int	The number of samples for this AAC audio frame.Value range: [480,512,1024,1960,2048].
param	ZegoAudioFrameParam *	The param of this AAC audio frame.
channel	ZegoPublishChannel	Publish channel for capturing audio frames.

Details

Sends the captured audio AAC data to the SDK.

Use cases: The customer needs to obtain input after acquisition from the existing audio stream, audio file, or customized acquisition system, and hand it over to the SDK for transmission.
When to call: After [enableCustomAudioIO] and publishing stream successfully.
Related APIs: Enable the custom audio IO function [enableCustomAudioIO], and start the push stream [startPublishingStream].

Available since: 2.20.0
Restrictions: None.

sendCustomAudioCapturePCMData:dataLength:param:

- (void)sendCustomAudioCapturePCMData:(unsigned char *) data dataLength:(unsigned int) dataLength param:(ZegoAudioFrameParam *) param;

Sends PCM audio data produced by custom audio capture to the SDK.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
data	unsigned char *	PCM buffer data.
dataLength	unsigned int	The total length of the buffer data.
param	ZegoAudioFrameParam *	The param of this PCM audio frame.

Details

Sends the captured audio PCM data to the SDK.

Use cases: 1.The customer needs to obtain input after acquisition from the existing audio stream, audio file, or customized acquisition system, and hand it over to the SDK for transmission. 2.Customers have their own requirements for special sound processing for PCM input sources. After the sound processing, the input will be sent to the SDK for transmission.
When to call: After [enableCustomAudioIO] and publishing stream successfully.
Related APIs: Enable the custom audio IO function [enableCustomAudioIO], and start the push stream [startPublishingStream].

Available since: 1.10.0
Restrictions: None.

sendCustomAudioCapturePCMData:dataLength:param:channel:

- (void)sendCustomAudioCapturePCMData:(unsigned char *) data dataLength:(unsigned int) dataLength param:(ZegoAudioFrameParam *) param channel:(ZegoPublishChannel) channel;

Sends PCM audio data produced by custom audio capture to the SDK (for the specified channel).

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
data	unsigned char *	PCM buffer data.
dataLength	unsigned int	The total length of the buffer data.
param	ZegoAudioFrameParam *	The param of this PCM audio frame.
channel	ZegoPublishChannel	Publish channel for capturing audio frames.

Details

Sends the captured audio PCM data to the SDK.

Use cases: 1.The customer needs to obtain input after acquisition from the existing audio stream, audio file, or customized acquisition system, and hand it over to the SDK for transmission. 2.Customers have their own requirements for special sound processing for PCM input sources. After the sound processing, the input will be sent to the SDK for transmission.
When to call: After [enableCustomAudioIO] and publishing stream successfully.
Related APIs: Enable the custom audio IO function [enableCustomAudioIO], and start the push stream [startPublishingStream].

Available since: 1.10.0
Restrictions: None.

fetchCustomAudioRenderPCMData:dataLength:param:

- (void)fetchCustomAudioRenderPCMData:(unsigned char *) data dataLength:(unsigned int) dataLength param:(ZegoAudioFrameParam *) param;

Fetches PCM audio data of the remote stream from the SDK for custom audio rendering.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
data	unsigned char *	A block of memory for storing audio PCM data that requires user to manage the memory block's lifecycle, the SDK will copy the audio frame rendering data to this memory block.
dataLength	unsigned int	The length of the audio data to be fetch this time (dataLength = duration * sampleRate * channels * 2(16 bit depth i.e. 2 Btye)).
param	ZegoAudioFrameParam *	Specify the parameters of the fetched audio frame. sampleRate in ZegoAudioFrameParam must assignment

Details

Fetches PCM audio data of the remote stream from the SDK for custom audio rendering, it is recommended to use the system framework to periodically invoke this function to drive audio data rendering.

Use cases: When developers have their own rendering requirements, such as special applications or processing and rendering of the original PCM data that are pulled, it is recommended to use the custom audio rendering function of the SDK.
When to call: After [enableCustomAudioIO] and playing stream successfully.
Related APIs: Enable the custom audio IO function [enableCustomAudioIO], and start the play stream [startPlayingStream].

Available since: 1.10.0
Restrictions: None.

sendReferenceAudioPCMData:dataLength:param:

- (void)sendReferenceAudioPCMData:(unsigned char *) data dataLength:(unsigned int) dataLength param:(ZegoAudioFrameParam *) param;

Send the PCM audio data customized by the developer to the SDK, which is used as a reference for custom rendering audio to eliminate echo.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
data	unsigned char *	PCM buffer data
dataLength	unsigned int	The total length of the buffer data
param	ZegoAudioFrameParam *	The param of this PCM audio frame

Details

Developers use the audio device clock as the driver to capture PCM audio data, and use it for custom audio rendering after processing. When submitting for rendering, call this function to send the processed audio data back to the SDK so that the SDK can use it as an echo cancellation reference.

Use cases: In entertainment scenarios, it may be necessary to customize the processing of PCM audio data from the remote end, such as synthesizing a background sound and KTV accompaniment before rendering and playing. At the same time, developers are required to send the audio data processed by themselves to the SDK for reference, so that the processed sound effects can be echo canceled after collection.
When to call: After calling [fetchCustomAudioRenderPCMData] to fetch and process the PCM audio data, this function is called while submitting to the system for rendering and playback.

Available since: 2.13.0.
Restrictions: You must call [setEngineConfig] to enable the external audio data as a reference for this function to take effect. If you need to get the use of the function or the details, please consult ZEGO technical support.

setCustomAudioIOAudioRoute:

- (void)setCustomAudioIOAudioRoute:(ZegoAudioRoute) audioRoute;

Set the audio route after enabling the custom audio IO function.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
audioRoute	ZegoAudioRoute	Audio route.

Details

Set the audio route after enabling the custom audio IO function.

Use cases: The current audio route is specified by the APP to optimize the AEC effect.
When to call: After [enableCustomAudioIO] and [startPublishingStream].

Available since: 3.21.0
Restrictions: Only support iOS and Android.

createRangeAudio

- (nullable ZegoRangeAudio *)createRangeAudio;

Creates a range audio instance.

Declared in ZegoExpressEngine.h

Creates a range audio instance. Use case: Often used in game voice scenarios, users can use related functions by creating range audio instance objects.

When to call: It can be called after the engine by [createEngine] has been initialized.
Impacts on other APIs: If you use the range audio module, you cannot use the basic push-pull stream [startPublishingStream], [startPlayingStream] interfaces and related callbacks.

Available since: 2.11.0
Restrictions: Currently, a maximum of 1 instances can be created, after which it will return nil.

range audio instance, nil will be returned when the maximum number is exceeded.

destroyRangeAudio:

- (void)destroyRangeAudio:(ZegoRangeAudio *) rangeAudio;

Destroys a range audio instance.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
rangeAudio	ZegoRangeAudio *	The range audio instance object to be destroyed.

Details

Destroys a range audio instance.

Available since: 2.11.0

createCopyrightedMusic

- (nullable ZegoCopyrightedMusic *)createCopyrightedMusic;

Creates a copyrighted music instance.

Declared in ZegoExpressEngine.h

Creates a copyrighted music instance. Use case: Often used in online KTV chorus scenarios, users can use related functions by creating copyrighted music instance objects.

When to call: It can be called after the engine by [createEngine] has been initialized.

Available since: 2.13.0
Restrictions: The SDK only supports the creation of one instance of CopyrightedMusic. Multiple calls to this function return the same object.

copyrighted music instance, multiple calls to this function return the same object.

destroyCopyrightedMusic:

- (void)destroyCopyrightedMusic:(ZegoCopyrightedMusic *) copyrightedMusic;

Destroys a copyrighted music instance.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
copyrightedMusic	ZegoCopyrightedMusic *	The copyrighted music instance object to be destroyed.

Details

Destroys a copyrighted music instance.

When to call: It can be called before the engine by [destroyEngine]

Available since: 2.13.0

createAudioVADClient

- (nullable ZegoAudioVADClient *)createAudioVADClient;

Create a audio vad client instance.

Declared in ZegoExpressEngine.h

Create a audio vad client instance. Use case: Can be used to detect if an audio packet contains speech.

When to call: It can be called after [createEngine].

Available since: 2.21.0
Restrictions: Each stream should correspond to a detected audio packet class object, or reset the existing object and apply it to a different stream.

audio vad client instance.

destroyAudioVADClient:

- (void)destroyAudioVADClient:(ZegoAudioVADClient *) client;

Destroys a audio vad client instance.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
client	ZegoAudioVADClient *	The audio vad client instance object to be destroyed.

Details

Destroys a audio vad client instance.

When to call: It can be called after [createEngine].

Available since: 2.21.0

createRangeScene

- (nullable ZegoRangeScene *)createRangeScene;

Create a range scene instance object.

Declared in ZegoExpressEngine.h

Create a range scene instance object. Use case: Often used in meta world scenarios, users can use related functions by range scene instance objects.

When to call: After initializing the engine by [createEngine].

Available since: 3.0.0
Restrictions: None.

range scene instance object.

destroyRangeScene:

- (void)destroyRangeScene:(ZegoRangeScene *) rangeScene;

Destroy a range scene instance object.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
rangeScene	ZegoRangeScene *	The range scene instance object to be destroyed.

Details

Destroy a range scene instance.

When to call: After create the range scene by [createRangeScene].

Available since: 3.0.0
Restrictions: None.

getScreenCaptureSourcesWithThumbnailSize:iconSize:

- (NSArray<ZegoScreenCaptureSourceInfo *> *)getScreenCaptureSourcesWithThumbnailSize:(CGSize) thumbnailSize iconSize:(CGSize) iconSize;

Get a list of screens or windows in a screen.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
thumbnailSize	CGSize	Get the thumbnail size corresponding to the window, the thumbnail can be used to draw on the window selection interface. (unit is pixel)
iconSize	CGSize	Get the size of the icon corresponding to the program. (unit is pixel)

Details

Get a list of screens or windows in a screen.

Available since: 3.1.0
Restrictions: Only support in Windows/macOS.

Return

List of capture source info objects.

createScreenCaptureSource:sourceType:

- (nullable ZegoScreenCaptureSource*)createScreenCaptureSource:(unsigned int) sourceId sourceType:(ZegoScreenCaptureSourceType) sourceType;

Create the screen capture source

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
sourceId	unsigned int	The specified screen ID or window ID.
sourceType	ZegoScreenCaptureSourceType	The specified screen source type.

Details

Creates a screen capture source object based on the provided source ID and source type.

Use cases: It is used when you need to record and share the screen or window.
When to call: It needs to be called after [createEngine].
Platform differences: Only supports Windows and macOS.

Return

The screen capture instance, nil will be returned when the maximum number is exceeded.

destroyScreenCaptureSource:

- (void)destroyScreenCaptureSource:(ZegoScreenCaptureSource *) source;

Destroy the screen capture source instance

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
source	ZegoScreenCaptureSource *	The screen capture source instance to be destroyed.

Details

Destroy the [ZegoScreenCaptureSource] instance object.

Use cases: When you no longer need to use the screen capture function, you can use this function to destroy the instance object created by the [createScreenCaptureSource] function
When to call: When you need to the screen capture source object needs to be destroyed
Platform differences: Only supports Windows and macOS.

Restrictions: After destroy the instance, you need to release the [ZegoScreenCaptureSource] instance object you hold by yourself, and don’t call the function of this instance object after the destruction.

setAppGroupID:

- (void)setAppGroupID:(NSString *)groupID API_AVAILABLE(ios (12.0));

Set the App Group configuration item.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
groupID	NSString *	The host app and the extension app should belong to the same App Group, and the AppGroupID needs to be passed in here.

Use cases: You need to use the iOS cross-process screen sharing function, and you need to start the App Group, which can provide better performance and stability. Must be used with [setupWithAppGroupID:] in the ZegoReplayKit extension class.
When to call: Called after [createEngine], before calling [startScreenCapture].

Available since: 3.3.0
Restrictions: Only available on iOS platform.

startScreenCaptureInApp:

- (void)startScreenCaptureInApp:(ZegoScreenCaptureConfig *)config API_AVAILABLE(ios (12.0));

Start screen capture, in-app capture only.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
config	ZegoScreenCaptureConfig *	Screen capture parameter configuration.

Details

Start screen capture.

When to call: After calling the [setVideoSource]、[setAudioSource] function to set the capture source to ScreenCapture.

Available since: 3.1.0
Restrictions: Only valid for iOS system

startScreenCapture:

- (void)startScreenCapture:(ZegoScreenCaptureConfig *)config API_AVAILABLE(ios (12.0));

Start screen capture.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
config	ZegoScreenCaptureConfig *	Screen capture parameter configuration.

Details

Start screen capture.

When to call: After calling the [setVideoSource]、[setAudioSource] function to set the capture source to ScreenCapture.

Available since: 3.1.0

stopScreenCapture

- (void)stopScreenCapture API_AVAILABLE(ios (12.0));

Stop screen capture.

Declared in ZegoExpressEngine.h

Stop screen capture.

Available since: 3.1.0

updateScreenCaptureConfig:

- (void)updateScreenCaptureConfig:(ZegoScreenCaptureConfig *)config API_AVAILABLE(ios (12.0));

Update screen capture parameter configuration.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
config	ZegoScreenCaptureConfig *	Screen capture parameter configuration.

Details

Update screen capture parameter configuration.

When to call: After calling [startScreenCapture] to start capturing.

Available since: 3.1.0
Restrictions: Only valid for iOS system. Only available on iOS 12.0 or newer

createAIVoiceChanger

- (nullable ZegoAIVoiceChanger *)createAIVoiceChanger;

Creates an AI voice changer instance.

Declared in ZegoExpressEngine.h

Creates an AI voice changer instance. Use case: Often used in live broadcasting, voice chatroom and KTV.

When to call: It can be called after the SDK by [createEngine] has been initialized.
Related APIs: User can call [destroyAIVoiceChanger] function to destroy an AI voice changer instance.

Available since: 3.10.0
Restrictions: Currently, a maximum of 1 instance can be created, after which it will return nil.

AI voice changer instance.

destroyAIVoiceChanger:

- (void)destroyAIVoiceChanger:(ZegoAIVoiceChanger *) aiVoiceChanger;

Destroys an AI voice changer instance.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
aiVoiceChanger	ZegoAIVoiceChanger *	The AI voice changer instance object to be destroyed.

Details

Destroys the AI voice changer instance.

Related APIs: User can call [createAIVoiceChanger] function to create an AI voice changer instance.

Available since: 3.10.0

isAIVoiceChangerSupported

- (BOOL)isAIVoiceChangerSupported;

Check the device can run AI voice changer or not.

Declared in ZegoExpressEngine.h

Check the device can run AI voice changer or not. Use case: Often used in live broadcasting, voice chatroom and KTV.

When to call: It can be called after the SDK by [createEngine] has been initialized.

Available since: 3.14.0

Return true if the device can run AI voice changer, otherwise return false.

createPictureCapturer

- (nullable ZegoPictureCapturer *)createPictureCapturer;

Create picture capturer instance.

Declared in ZegoExpressEngine.h

Creates a picture capturer instance. Use case: Often used in pushing static images.

When to call: It can be called after the SDK by [createEngine] has been initialized.
Related APIs: User can call [destroyPictureCapturer] function to destroy a picture capturer instance. Use [setVideoSource] to set the picture capturer as the push stream video source.

Available since: 3.22.0
Restrictions: None.

Picture capturer instance.

destroyPictureCapturer:

- (void)destroyPictureCapturer:(ZegoPictureCapturer *) pictureCapturer;

Destroys a picture capturer instance.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
pictureCapturer	ZegoPictureCapturer *	The picture capturer instance to be destroyed.

Details

Destroys the picture capturer instance.

Related APIs: User can call [createPictureCapturer] function to create a picture capturer instance.

Available since: 3.22.0

setPlayStreamBufferIntervalRange:streamID:

deprecated

- (void)setPlayStreamBufferIntervalRange:(NSRange) range streamID:(NSString *) streamID;

[Deprecated] Set the adaptive adjustment interval range of the buffer for playing stream.

Declared in ZegoExpressEngine.h

Name	Type	Description
range	NSRange	The buffer adaptive interval range.
streamID	NSString *	Stream ID.

Deprecated

Deprecated since 3.4.0, please use [setPlayStreamBufferIntervalRange:min:max:] instead.

enableBeautify:

deprecated

- (void)enableBeautify:(ZegoBeautifyFeature) featureBitmask;

[Deprecated] Enables or disables the beauty features for the main publish channel. Deprecated since 2.16.0, please use the [enableEffectsBeauty] function instead.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
featureBitmask	ZegoBeautifyFeature	Beauty features, bitmask format, you can choose to enable several features in [ZegoBeautifyFeature] at the same time

Details

When developers do not have much need for beauty features, they can use this function to set some very simple beauty effects.

When to call: It needs to be called after [createEngine].
Default value: When this function is not called, the beauty feature is not enabled by default.
Related APIs: After turning on the beauty features, you can call the [setBeautifyOption] function to adjust the beauty parameters.
Caution: This beauty feature is very simple and may not meet the developer’s expectations. It is recommended to use the custom video processing function [enableCustomVideoProcessing] or the custom video capture function [enableCustomVideoCapture] to connect the AI Effects SDK [ZegoEffects] https://docs.zegocloud.com/article/9896 for best results.

Available since: 1.1.0
Restrictions: In the case of using the custom video capture function, since the developer has handle the video data capturing, the SDK is no longer responsible for the video data capturing, so this function is no longer valid. It is also invalid when using the custom video processing function.

Deprecated

Deprecated since 2.16.0, please use the [enableEffectsBeauty] function instead.

enableBeautify:channel:

deprecated

- (void)enableBeautify:(ZegoBeautifyFeature) featureBitmask channel:(ZegoPublishChannel) channel;

[Deprecated] Enables or disables the beauty features for the specified publish channel. Deprecated since 2.16.0, please use the [enableEffectsBeauty] function instead.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
featureBitmask	ZegoBeautifyFeature	Beauty features, bitmask format, you can choose to enable several features in [ZegoBeautifyFeature] at the same time
channel	ZegoPublishChannel	Publishing stream channel

Details

When developers do not have much need for beauty features, they can use this function to set some very simple beauty effects.

When to call: It needs to be called after [createEngine].
Default value: When this function is not called, the beauty feature is not enabled by default.
Related APIs: After turning on the beauty features, you can call the [setBeautifyOption] function to adjust the beauty parameters.
Caution: This beauty feature is very simple and may not meet the developer’s expectations. It is recommended to use the custom video processing function [enableCustomVideoProcessing] or the custom video capture function [enableCustomVideoCapture] to connect the AI Effects SDK [ZegoEffects] https://docs.zegocloud.com/article/9896 for best results.

Available since: 1.1.0
Restrictions: In the case of using the custom video capture function, since the developer has handle the video data capturing, the SDK is no longer responsible for the video data capturing, so this function is no longer valid. It is also invalid when using the custom video processing function.

Deprecated

Deprecated since 2.16.0, please use the [enableEffectsBeauty] function instead.

setBeautifyOption:

deprecated

- (void)setBeautifyOption:(ZegoBeautifyOption *) option;

[Deprecated] Set beautify option. Deprecated since 2.16.0, please use the [setEffectsBeautyParam] function instead.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
option	ZegoBeautifyOption *	Beautify option.

Details

set beautify option for main publish channel.

Use cases: Often used in video call, live broadcasting.
When to call: It needs to be called after [createEngine].
Caution: In the case of using a custom video capture function, because the developer has taken over the video data capturing, the SDK is no longer responsible for the video data capturing, call this function will not take effect. When using custom video processing, the video data collected by the SDK will be handed over to the business for further processing, call this function will not take effect either.

Available since: 1.1.0
Restrictions: None.

Deprecated

Deprecated since 2.16.0, please use the [setEffectsBeautyParam] function instead.

setBeautifyOption:channel:

deprecated

- (void)setBeautifyOption:(ZegoBeautifyOption *) option channel:(ZegoPublishChannel) channel;

[Deprecated] Set beautify option. Deprecated since 2.16.0, please use the [setEffectsBeautyParam] function instead.

Declared in ZegoExpressEngine.h

Parameters

Name	Type	Description
option	ZegoBeautifyOption *	Beautify option.
channel	ZegoPublishChannel	stream publish channel.

Details

set beautify option for main publish channel.

Use cases: Often used in video call, live broadcasting.
When to call: It needs to be called after [createEngine].
Caution: In the case of using a custom video capture function, because the developer has taken over the video data capturing, the SDK is no longer responsible for the video data capturing, call this function will not take effect. When using custom video processing, the video data collected by the SDK will be handed over to the business for further processing, call this function will not take effect either.

Available since: 1.1.0
Restrictions: None.

Deprecated

Deprecated since 2.16.0, please use the [setEffectsBeautyParam] function instead.