Important parameters

更新时间:
复制 MD 格式

This topic describes the key parameters for integrating the audio and video call API for iOS.

Variable

Description

delegate

Sets the delegate object.

dynamicConfigProxy

You can dynamically configure the agent.

uid

Sets the user ID.

Note

The uid can contain only letters, digits, and underscores. The length cannot exceed 128 characters.

roomServerCustomUrl

Sets the server address.

videoProfileType

Sets the encoding resolution.

autoPublish

Sets auto-publishing.

autoPublishConfig

Sets the auto-publishing configuration parameters.

currentPublishConfig

You can obtain the configuration parameters for automatic subscriptions.

autoSubscribe

Sets auto-subscription.

autoSubscribeOptions

Sets the auto-subscription configuration parameters.

delegate

  • Feature: Sets the delegate object.

  • Description: Specifies the delegate object, which is weakly referenced. You must set this parameter to receive event callbacks.

dynamicConfigProxy

  • Feature: Sets the dynamic configuration proxy.

  • Description: Used to configure dynamic policies. You do not need to set this parameter if dynamic configuration is not required.

uid

  • Feature: Sets the user ID.

  • Description: The user ID. You must set this parameter before you call the API.

roomServerCustomUrl

  • Feature: Sets the server address.

  • Description: The server address. You must set this parameter before you call the API.

videoProfileType

  • Feature: Sets the encoding resolution.

  • Description: The encoding resolution. You must set this parameter before you call the API.

autoPublish

  • Feature: Enables or disables auto-publishing.

  • Description: Specifies whether to enable auto-publishing. This parameter is optional. Auto-publishing is enabled by default.

autoPublishConfig

  • Feature: Sets the auto-publishing configuration parameters.

  • Description: The configuration parameters for auto-publishing. You can configure settings such as publishing audio, publishing video, encoding resolution, and timeout. This parameter is optional. If you do not set this parameter, the default configurations are used.

currentPublishConfig

  • Feature: Retrieves the configuration parameters for automatic subscriptions.

autoSubscribe

  • Feature: Enables or disables auto-subscription.

  • Description: Specifies whether to enable auto-subscription. This parameter is optional. Auto-subscription is enabled by default.

autoSubscribeOptions

  • Feature: Sets the auto-subscription configuration parameters.

  • Description: The configuration parameters for auto-subscription. You can configure settings such as accepting audio, accepting video, and timeout. This parameter is optional. If you do not set this parameter, the default configurations are used.