Discussion

开发者使用本 API 获取 SDK 版本号

Discussion

1、回调信息为加密信息(需要zego解密工具解密) 2、设置此日志回调之后sdk 将不会在写日志文件 3、调用时机,应该最早时机调用此接口 InitSDK之前

Discussion

建议在初始化 SDK 前调用。建议开发者在开发阶段设置为测试环境，使用由 Zego 提供的测试环境。上线前需切换为正式环境运营

Discussion

建议setLogDir后 initSDK前调用 , 启用后,控制台会输出用户调用信息，并且会在SDK日志目录生成 明文的用户可见的日志文件

Discussion

确保在创建接口对象前调用

Discussion

上传日志到后台便于分析问题

在初始化 SDK 成功后调用

Discussion

确保在 loginRoom 前设置成功。userID 和 userName 由业务方自己控制

Discussion

在初始化 SDK 之前调用有效

SDK 默认单个日志文件大小为 5M

Discussion

在初始化 SDK 之前调用有效

Discussion

在初始化 SDK 之前调用有效

Discussion

Discussion

Discussion

回调值信息 taskId：sdk任务id type: 任务类型 taskDispatchTime: 任务调度消耗时间 单位ms taskRunTime: 任务执行耗时 单位ms taskTotalTime: 任务总耗时 单位ms 一般情况只需关注此时间即可

建议每次 初始化SDK前调用, SDK 被反初始化会清除此回调值

Discussion

默认是单房间模式

必须在初始化SDK前调用。

如果需要开启多房间模式，请与即构技术支持联系配置服务端支持。

Discussion

Discussion

初始化 SDK 时调用。初始化 SDK 失败可能导致 SDK 功能异常

Discussion

初始化 SDK 时调用。初始化 SDK 失败可能导致 SDK 功能异常

Discussion

使用 room 功能，初始化相关视图控制器时需要设置代理对象。未设置代理对象，或对象设置错误，可能导致无法正常收到相关回调

Discussion

在 userStateUpdate 为 true 的情况下，用户进入、退出房间会触发 [ZegoLiveRoomApi (IM) -onUserUpdate:updateType:] 回调

在登录房间前调用有效，退出房间后失效

userStateUpdate为房间属性而非用户属性，设置的是该房间内是否会进行用户状态的广播。如果需要在房间内用户状态改变时，其他用户能收到通知，请为所有用户设置为true；反之，设置为false。设置为true后，方可从OnUserUpdate回调收到用户状态变更通知

不支持多房间模式（通过 [ZegoLiveRoomApi setRoomMode:] 开启），多房间模式下请使用 [ZegoLiveRoomApi setRoomConfig:userStateUpdate:room:]，指定房间 ID。

Discussion

在 userStateUpdate 为 true 的情况下，用户进入、退出房间会触发 [ZegoLiveRoomApi (IM) -onUserUpdate:updateType:] 回调

在登录房间前调用有效，退出房间后失效

userStateUpdate为房间属性而非用户属性，设置的是该房间内是否会进行用户状态的广播。如果需要在房间内用户状态改变时，其他用户能收到通知，请为所有用户设置为true；反之，设置为false。设置为true后，方可从OnUserUpdate回调收到用户状态变更通知

支持多房间模式（通过 [ZegoLiveRoomApi setRoomMode:] 开启）。

Discussion

使用此方法验证登录及推流时用户的合法性，登录房间前调用，token的生成规则请联系即构。若不需要验证用户合法性，不需要调用此函数。

在登录房间前调用有效，支持在登录房间后重新设置，退出房间后失效

Discussion

使用此方法验证登录及推流时用户的合法性，登录房间前调用，token的生成规则请联系即构。若不需要验证用户合法性，不需要调用此函数。

在登录房间前调用有效，支持在登录房间后重新设置，退出房间后失效

Discussion

在登录房间前调用有效，退出房间后失效

不支持多房间模式（通过 [ZegoLiveRoomApi setRoomMode:] 开启），多房间模式下请使用 [ZegoLiveRoomApi setRoomMaxUserCount:room:]，指定房间 ID。

Discussion

在登录房间前调用有效，退出房间后失效

支持多房间模式（通过 [ZegoLiveRoomApi setRoomMode:] 开启）。

Discussion

登录房间成功，才能开始直播。观众登录房间成功后，会在 blk 中返回当前房间的流信息

Discussion

登录房间成功，才能开始直播。观众登录房间成功后，会在 blk 中返回当前房间的流信息

Discussion

切换房间成功，才能开始直播。观众登录房间成功后，会在 blk 中返回当前房间的流信息

不支持多房间模式（通过 [ZegoLiveRoomApi setRoomMode:] 开启）。

调用成功，会停止所有推拉流。

Discussion

切换房间成功，才能开始直播。观众登录房间成功后，会在 blk 中返回当前房间的流信息

同时支持单房间和多房间模式。

调用成功，会停止房间 fromRoomID 的所有推拉流。

Discussion

连麦情况下，要 stop 所有的 stream 后，才能执行 logoutRoom。

不支持多房间模式（通过 [ZegoLiveRoomApi setRoomMode:] 开启）。多房间模式下请使用 [ZegoLiveRoomApi logoutRoom:] 指定房间 ID。

Discussion

连麦情况下，要 stop 所有的 stream 后，才能执行 logoutRoom。

支持多房间模式（通过 [ZegoLiveRoomApi setRoomMode:] 开启）。

Discussion

• 该 API 可以向指定列表内的用户发送自定义信令，信令内容由用户自定义。发送结果通过 block 回调。
• 用户可通过代理 [ZegoRoomDelegate -onReceiveCustomCommand:userName:content:roomID:] 方法收到信令。
• 信令不能保证 100% 可达。
• 不支持多房间模式（通过 [ZegoLiveRoomApi setRoomMode:] 开启）。多房间模式下请使用 [ZegoLiveRoomApi sendCustomCommand:content:room:completion:] 指定房间 ID。

Discussion

• 该 API 可以向指定列表内的用户发送自定义信令，信令内容由用户自定义。发送结果通过 block 回调。
• 用户可通过代理 [ZegoRoomDelegate -onReceiveCustomCommand:userName:content:roomID:] 方法收到信令。
• 信令不能保证 100% 可达。
• 支持多房间模式（通过 [ZegoLiveRoomApi setRoomMode:] 开启）。必须指定房间 ID

Discussion

• 注意：该代理用于监听直播事件回调，设置代理对象后在 [ZegoLiveEventDelegate -zego_onLiveEvent:info:] 中获取直播事件。

Discussion

开发者获取音视频设备错误，需要先设置此代理对象。未设置代理对象，或对象设置错误，可能导致无法正常收到相关回调

Discussion

• 调用时机为引擎创建后的任意时刻。
• 接口由于涉及对设备的操作，极为耗时，不建议随便调用，只在真正需要让出麦克风给其他应用的时候才调用。

Discussion

• 用于需要暂停指定模块的场合，例如来电时暂停音频模块。

• 注意：

• 1.可以在初始化后任意时间调用。
• 2.暂停指定模块后，注意在合适时机下调用 [ZegoLiveRoomApi -resumeModule:] 恢复模块。

Discussion

• 用于暂停模块后需要恢复模块的场合，例如来电结束后恢复音频模块。

• 注意：可以在初始化后任意时间调用。

Discussion

本接口用于 Mac PC 端的业务开发

Discussion

本接口用于 Mac PC 端的业务开发

Discussion

Discussion

切换麦克风后需要重新获取麦克风音量

Discussion

设置后如果有音量变化（包括app音量）通过ZegoDeviceEventDelegate::zego_onDevice:error:回调

Discussion

具体配置信息请咨询技术支持

“prefer_play_ultra_source”, int value(1/0), default: 0. 可在 InitSDK 之后，拉流之前调用

“keep_audio_session_active”, bool value, default: false. if set true, app need to set the session inactive yourself

“enforce_audio_loopback_in_sync”, bool value, default: false. enforce audio loopback in synchronous method

“audio_session_mix_with_others”, bool value, default: true. set AVAudioSessionCategoryOptionMixWithOthers

“support_general_mode_below_ios9”, bool value, default: false. support general mode below ios 9.0

“room_retry_time”, uint32 value, default:300S，设置房间异常后自动恢复最大重试时间，SDK尽最大努力恢复，单位为S，SDK默认为300s，设置为0时不重试

“av_retry_time”, uint32 value, default:300S，设置推拉流异常后自动恢复最大重试时间，SDK尽最大努力恢复，单位为S，SDK默认为300s，设置为0时不重试

“play_clear_last_frame”, bool value, default false. 停止拉流时，是否清除最后一帧内容

“preview_clear_last_frame”, bool value, default false. 停止预览时，是否清除最后一帧内容。注意：必须停止预览且setPreviewView设置为空，此配置才能生效。否则，停止预览后，播放控件仍会保留最后一帧

“vcap_external_handle_rotation”, bool value, default true, 表示在推流端处理旋转；设置为 vcap_external_handle_rotation=false 时，会把旋转值传到拉流端（仅为 UDP 时有效）。这个配置目前只对外部采集的内存模式和 CVPixelBuffer 模式生效

“audio_jitter_break_threshold_ms”, uint32 value, default:200ms，定义音频卡顿时长，当音频卡顿时长超过该值时，认为存在卡顿，单位为ms，SDK默认为200ms，取值范围[10,2000]

“video_jitter_break_threshold_ms”, uint32 value, default:500ms，定义视频卡顿时长，当视频卡顿时长超过该值时，认为存在卡顿，单位为ms，SDK默认为500ms，取值范围[500,2000]

“transform_http_to_https_on_init”, bool value, default false，控制是否在initSDK时使用https替代http

Discussion

Discussion

Discussion

Discussion

• 注意：
• 1.在 init 之前设置。

Discussion

• 注意：
• 1.在 InitSDK 之后调用才有效。
• 2.不支持多房间 SDK。与 unInit 配对调用。

Discussion

• 注意：
• 1.在 init 之后调用。
• 2.与InitRangeAudio 配对调用。

Discussion

• 如设置 ZEGO_RANGE_AUDIO_MODE_WORLD 则会听到自己小队内和房间内其它用户模式为 ZEGO_RANGE_AUDIO_MODE_WORLD ，且在距离我音频接收范围内的语音。
• 如设置 ZEGO_RANGE_AUDIO_MODE_TEAM 则只能听到与自己同一小队的语音。

• 默认值 : ZEGO_RANGE_AUDIO_MODE_WORLD

• 注意：

• 1.在 init 之后，unInit 之前调用，可随时变更。

Discussion

• 设置小队ID 设置后，将能听到与房间内的其他用户属于同一小队下的声音, 且不会随距离方向产生变化。

• 注意：

• 1.在 init 之后，unInit 之前调用，可随时变更。

Discussion

• 设置范围后，在开启3D音效情况下，声音将会随距离衰减，直至超出设置范围，则不再有声音。

• 小队内的语音，将不会受到此值的限制。

• 注意：

• 1.在 init 之后，unInit 之前调用，可随时变更。

Discussion

• 设置范围后，在开启3D音效情况下，声音将会随距离衰减，直至超出设置范围，则不再有声音。

• 小队内的语音，将不会受到此值的限制。

• 注意：

• 1.在 init 之后，unInit 之前调用，可随时变更。

Discussion

• 开启麦克风后，SDK将会自动使用主通道推音频流。

• 注意：

• 1.在 init 之后，unInit 之前调用。
• 2.ZegoRangeAudioDelegate 中的 OnRangAudioMicrophone 回调查看开启麦克风结果。

Discussion

• 开启扬声器后，SDK将会自动使用主通道推音频流。
• 若当前是仅小队模式，将只会拉取同一小队的音频流，停止非小队的音频流。

• 若当前是世界模式, 将优先拉取同一小队的语音，非小队成员，则按距离我最近的的开始拉取。

• 注意：

• 1.在 init 之后，unInit 之前调用。

Discussion

• 开启后，在房间内非小队成员的音频，会随离我的距离，和方向产生空间变化。

• 注意：

• 1.在 init 之后，unInit 之前调用。

Discussion

• 注意：
• 1.在 init 之后，unInit 之前调用。

Discussion

• 注意：
• 1.在 init 之后，unInit 之前调用。

Discussion

• 注意：
• 1.在 init 之后，unInit 之前调用。

Discussion

• 注意：
• 1.在 init 之后，unInit 之前调用。

Discussion

• 注意：
• 1.在 init 之后，unInit 之前调用。

Discussion

• 注意：
• 1.在 init 之后，且StartPlayStream 之后 。

Discussion

• 注意：
• 1.在 init 之后，且StartPlayStream 之后 。

Discussion

• 注意：
• 1.在 init 之后，且StartPlayStream 之后 。

Discussion

• 注意：
• 1.建议在调用 startPreview: 开启预览前，调用该 API 设置本地预览视图，才能在视图上预览采集的视频。
• 2.建议本地预览结束后，调用该 API 设置预览视图为 nil。

Discussion

• 注意：
• 1.建议在调用 startPreview: 开启预览前，调用该 API 设置本地预览视图，才能在视图上预览采集的视频。
• 2.建议本地预览结束后，调用该 API 设置预览视图为 nil。

Discussion

• 注意：
• 1.建议在启动本地预览前，调用 setPreviewView:channelIndex: 设置本地预览视图。
• 2.在退出房间后，SDK 内部会停止预览，如果需要继续预览，需要重新调用本方法开启预览。

Discussion

注意： 1. 当 srcType 设置为 VIDEO_SRC_EXTERNAL_CAPTURE 但对应通道没有外部采集工厂时，将自动修正为 VIDEO_SRC_CAMERA; 2. 当 srcType 设置为 VIDEO_SRC_NONE 时，表示不启动视频采集，即没有视频数据，支持在主路和辅路使用; 3. 当 srcType 设置为 VIDEO_SRC_DEFAULT 时，如果有设置外部视频采集工厂，则使用外部采集，否则使用内部采集; 4. 当 srcType 设置为 VIDEO_SRC_CAMERA 时，即使设置了外部视频采集工厂，也会使用摄像头作为视频数据源; 5. 当 index 为 PUBLISH_CHN_MAIN 时，srcType 不能设置为 VIDEO_SRC_MAIN_PUBLISH_CHN 和 VIDEO_SRC_PLAYER; 6. 当 index 为 PUBLISH_CHN_AUX 且 srcType 设置为 VIDEO_SRC_MAIN_PUBLISH_CHN 时，需要 PUBLISH_CHN_MAIN 有设备工作，否则 PUBLISH_CHN_AUX 无法正常推出视频数据; 7. 当 index 为 PUBLISH_CHN_AUX 且 srcType 设置为 VIDEO_SRC_PLAYER 时，需要 PUBLISH_CHN_MAIN 有设备工作，否则媒体播放器无法正常循环播放; 8. 当 srcType 设置为有实例的视频源类型时，例如：VIDEO_SRC_PLAYER，默认使用实例 ID 为 0 的实例; 9. 一旦使用过此 API 设置采集视频源类型，在停止推流时，SDK 不会重置视频采集源类型;

Discussion

注意： 1. 当 srcType 设置为 VIDEO_SRC_EXTERNAL_CAPTURE 但对应通道没有外部采集工厂时，将自动修正为 VIDEO_SRC_CAMERA; 2. 当 srcType 设置为 VIDEO_SRC_NONE 时，表示不启动视频采集，即没有视频数据; 3. 当 srcType 设置为 VIDEO_SRC_DEFAULT 时，如果有设置外部视频采集工厂，则使用外部采集，否则使用内部采集; 4. 当 srcType 设置为 VIDEO_SRC_CAMERA 时，即使设置了外部视频采集工厂，也会使用摄像头作为视频数据源; 5. 当 index 为 PUBLISH_CHN_MAIN 时，srcType 不能设置为 VIDEO_SRC_MAIN_PUBLISH_CHN 和 VIDEO_SRC_PLAYER; 6. 当 index 为 PUBLISH_CHN_AUX 且 srcType 设置为 VIDEO_SRC_MAIN_PUBLISH_CHN 时，需要 PUBLISH_CHN_MAIN 有设备工作，否则 PUBLISH_CHN_AUX 无法正常推出视频数据; 7. 当 index 为 PUBLISH_CHN_AUX 且 srcType 设置为 VIDEO_SRC_PLAYER 时，需要 PUBLISH_CHN_MAIN 有设备工作，否则媒体播放器无法正常循环播放; 8. 一旦使用过此 API 设置采集视频源类型，在停止推流时，SDK 不会重置视频采集源类型;

Discussion

注意： 1. 当 srcType 设置为 AUDIO_SRC_NONE 时，表示不启动音频采集，即没有音频数据; 2. 当 index 为 PUBLISH_CHN_MAIN 时，srcType 不能设置为 AUDIO_SRC_MAIN_PUBLISH_CHN 和 AUDIO_SRC_PLAYER; 3. 一旦使用过此 API 设置采集音频源类型，在停止推流时，SDK 不会重置音频采集源类型;

Discussion

• 注意：
• 1.可以登录房间成功后调用，发布直播后可以使用 [ZegoLiveRoomApi(Publisher2) -stopPublishing:] 停止发布直播。
• 2.发布直播 API 调用成功后，SDK 会在 [ZegoLivePublisherDelegate -onPublishStateUpdate:streamID:streamInfo:] 回调中通知发布结果，同一房间的其他人会在 [ZegoLiveRoomDelegate -onStreamUpdated:streams:roomID:] 回调中收到流新增通知。
• 3.如果有收到 [ZegoRoomDelegate -onDisconnect:roomID:] 回调，则不会再收到 [ZegoLivePublisherDelegate -onPublishStateUpdate:streamID:streamInfo:] 回调。
• 4.为了满足客户的秒开播需求，该接口可以在调用登录房间接口后同步调用，如果登录房间失败，则直播发布也失败。
• 5.[ZegoLiveRoonApi(Publisher) -startPublishing] 既是主通道推流。

Discussion

• 注意：
• 1.可以登录房间成功后调用，发布直播后可以使用 [ZegoLiveRoomApi(Publisher2) -stopPublishing:] 停止发布直播。
• 2.发布直播 API 调用成功后，SDK 会在 [ZegoLivePublisherDelegate -onPublishStateUpdate:streamID:streamInfo:] 回调中通知发布结果，同一房间的其他人会在 [ZegoLiveRoomDelegate -onStreamUpdated:streams:roomID:] 回调中收到流新增通知。
• 3.如果有收到 [ZegoRoomDelegate -onDisconnect:roomID:] 回调，则不会再收到 [ZegoLivePublisherDelegate -onPublishStateUpdate:streamID:streamInfo:] 回调。
• 4.为了满足客户的秒开播需求，该接口可以在调用登录房间接口后同步调用，如果登录房间失败，则直播发布也失败。
• 5.[ZegoLiveRoonApi(Publisher) -startPublishing] 既是主通道推流。

Discussion

发布直播成功后，等待 [ZegoLivePublisherDelegate -onPublishStateUpdate:streamID:streamInfo:] 通知

Discussion

发布直播成功后，等待 [ZegoLivePublisherDelegate -onPublishStateUpdate:streamID:streamInfo:] 通知

Discussion

通常在主播方的 [ZegoLivePublisherDelegate -onPublishStateUpdate:streamID:streamInfo:] 通知中，或其他需更新流附加信息的场合下调用。更新流附加信息成功后，除调用方外，同一房间内的其他人会收到 [ZegoLiveRoomDelegate -onStreamExtraInfoUpdated:roomID] 通知

Discussion

• 注意：
• 1.用于停止已发布的直播，可以在发布直播后调用。
• 2.停止发布直播不会触发 [ZegoLivePublisherDelegate -onPublishStateUpdate:streamID:streamInfo:] 回调。

Discussion

开发者如果使用自定义转推功能，推流开始前，必须调用此接口设置转推 RTMP 地址（SDK 推流方式必须为 UDP，转推地址必须为 RTMP），否则可能导致转推失败。

Discussion

推流开始前调用本 API 进行视频采集参数配置

Discussion

• 注意：推流前调用有效。

Discussion

• 本设置用于校正输出视频朝向，默认竖屏。建议在预览和推流之前设置好方向。
• 不建议在推流过程中旋转画面，原因：
• 1. 如果刚开始为竖屏开播，此时旋转为横屏，但是分辨率仍然是竖屏的，会导致横屏后，画面放大的效果(按照等比填充的模式) 或者 上下黑边的效果(按照等比缩放的模式)，除非旋转为横屏后，画面的分辨率也做修改。
• 1. 直播过程中修改分辨率的话，会导致录制文件(回放)有异常，因此不建议中途旋转画面。

Discussion

@attention 推流前或者推流过程中设置都有效，当次推流有效。

Discussion

推流时可调用本 API 进行参数配置

Discussion

推流时可调用本 API 进行参数配置。设置时需确保对应美颜特性开启

Discussion

推流时可调用本 API 进行参数配置。设置时需确保对应美颜特性开启

Discussion

推流时可调用本 API 进行参数配置。设置时需确保对应美颜特性开启

Discussion

推流时可调用本 API 进行参数配置。设置时需确保对应美颜特性开启

Discussion

推流时可调用本 API 进行参数配置

Discussion

Discussion

• 视图模式默认为 ZegoVideoViewModeScaleAspectFill。

Discussion

• 注意：
• 1.只能设置(0/90/180/270)，默认为0。
• 2.该设置只是设置预览渲染图像的朝向，不会改变推流时的图像朝向。

Discussion

• 注意：
• 1.只能设置(0/90/180/270)，默认为0。
• 2.该设置会改变推流时的图像朝向。
• 3.在InitSDK之后调用有效，UninitSDK前有效。支持推流时调用。

Discussion

推流时可调用本 API 进行参数配置

Discussion

推流时可调用本 API 进行参数配置

Discussion

• 预览镜像只对前置摄像头有效，后置无效。
• 默认预览启用镜像，推流不启用镜像（即 ZegoVideoMirrorModePreviewMirrorPublishNoMirror）

Discussion

• 注意：1. 在推流之前设置有效；
• 只适用于 RTMP 推流。

开启后，在带宽不足的情况下码率自动适应当前带宽

Discussion

• 如果使用前置摄像头，本地预览和推流都将使用前置摄像头拍摄的数据。SDK 默认使用前置摄像头。

Discussion

• 开启视频采集后，预览视图才能显示预览画面，推流时才包含采集的视频数据。SDK 默认开启视频采集。

Discussion

• 推流时可调用本 API 进行参数配置。SDK 默认关闭手电筒。

Discussion

Discussion

推流开始前调用本 API 进行参数配置

Discussion

左上角为坐标系原点，区域不能超过编码分辨率设置的大小

Discussion

左上角为坐标系原点，区域不能超过预览视图的大小

Discussion

Discussion

• 设置 SDK 推流时音频使用的延迟模式，可以根据自己的业务场景选择最合适的延迟模式，详情可咨询 ZEGO 技术支持。

• 注意：在InitSDK之后，推流前调用有效。

Discussion

• 注意：
• 1.在InitSDK之后，推流前调用有效。
• 2.[ZegoLiveRoomApi(Publisher) -setLatencyMode:] 中将延迟模式设置为 ZEGO_LATENCY_MODE_NORMAL、ZEGO_LATENCY_MODE_NORMAL2、ZEGO_LATENCY_MODE_LOW3 才能设置双声道。
• 3.在移动端双声道通常需要配合音频前处理才能体现效果。

Discussion

• 开启流量控制开关可以使 SDK 通过动态调整音视频的码率、帧率、分辨率来适应当前网络环境，从而保证直播的流畅发布。

• 注意：

• 1.在推流前调用，连麦/混流方式调用此接口有效。
• 2.当关闭流量控制时，流量控制属性将被忽略。
• 3.只适用于 UDP 推流。

Discussion

• 开启流量控制后，设置视频码率最小值可以让 SDK 当网络不足以达到发送视频最小码率时采取用户设置的策略。

• 注意：可以在初始化之后的任意时间调用，需要开启流量控制该参数才会生效。

Discussion

• 开启流量控制后，设置视频帧率最小值可以让 SDK 采取用户设置的策略。

• 注意：可以在初始化之后的任意时间调用，需要开启流量控制该参数才会生效。

Discussion

• 开启流量控制后，设置视频分辨率最小值可以让 SDK 采取用户设置的策略。

• 注意：可以在初始化之后的任意时间调用，需要开启流量控制该参数才会生效。

Discussion

• 在初始化 SDK 之后，推流之前调用有效。如果每次推流前不重新设置，将继续使用上次的配置。在反初始化 SDK 之后失效。

• 当 focusOn 设置为 ZEGOAPI_TRAFFIC_CONTROL_FOCUS_ON_REMOTE 时，当对方的网络拥塞时，推流端可能限定推流的码率。

• 当通过 enableTrafficControl:properties: 接口开启了指定推流通道的流量控制后，可通过该接口控制是否因为远端网络状况差而启动流量控制。在 1v1 场景下默认是开启的。

Discussion

Discussion

Discussion

Discussion

Discussion

Discussion

• 注意：使用 Publisher 功能前需要设置代理对象，用于接收 ZegoLivePublisherDelegate 回调方法。

Discussion

• 使用分层视频编码可以实现开发者(连麦/混流)业务中不同终端显示不同质量的视频流、根据网络状态自适应拉取视频流的质量的场景，分层视频编码更详细的描述见官网相关文档。

• 注意：

• 1.在推流前调用有效。
• 2.分层视频编码使用的是 ZEGO 的私有协议，仅限于连麦/混流方使用。
• 3.推流方设置使用分层视频编码后，拉流方可以使用 [ZegoLiveRoomApi(Player) -activateVideoPlayStream:active:videoLayer:] 接口指定拉取的视频分层。

Discussion

• 注意：
• 1.可以在初始化 SDK 之后的任意时间调用，建议在调用 startPreview 开启预览前，调用该 API 设置本地预览视图，才能在视图上预览采集的视频。
• 2.建议本地预览结束后调用该 API 将本地预览视图置空。

Discussion

• 注意：
• 1.可以在初始化 SDK 之后的任意时间调用。
• 2.调用 API 前，需要调用 [ZegoLiveRoomApi(Publisher) -setPreviewView:] 设置本地预览视图才可以看到采集的画面。
• 3.在退出房间后，SDK 内部会停止预览，如果需要继续预览，需要重新调用本方法开启预览。
• 4.本地预览默认开启预览镜像功能。

Discussion

• 注意：
• 1.可以在初始化 SDK 之后的任意时间调用。
• 2.建议本地预览结束后调用 [ZegoLiveRoomApi(Publisher) -setPreviewView:] 将本地预览视图置空。

Discussion

• 注意：
• 1.可以在登录房间成功后调用，发布直播后可以使用 [ZegoLiveRoomApi(Publisher) -stopPublishing] 停止发布直播。
• 2.发布直播 API 调用成功后，SDK 会在 [ZegoLivePublisherDelegate -onPublishStateUpdate:streamID:streamInfo:] 回调中通知发布结果，同一房间的其他人会在 [ZegoLiveRoomDelegate -onStreamUpdated:streams:roomID:] 回调中收到流新增通知。
• 1. 如果有收到 [ZegoRoomDelegate -onDisconnect:roomID:] 回调，则不会再收到 [ZegoLivePublisherDelegate -onPublishStateUpdate:streamID:streamInfo:] 回调。
• 4.为了满足客户的秒开播需求，该接口可以在调用登录房间接口后同步调用，如果登录房间失败，则直播发布也失败。

Discussion

• 注意：
• 1.可以在登录房间成功后调用，发布直播后可以使用 [ZegoLiveRoomApi(Publisher) -stopPublishing] 停止发布直播。
• 2.发布直播 API 调用成功后，SDK 会在 [ZegoLivePublisherDelegate -onPublishStateUpdate:streamID:streamInfo:] 回调中通知发布结果，同一房间的其他人会在 [ZegoLiveRoomDelegate -onStreamUpdated:streams:roomID:] 回调中收到流新增通知。
• 1. 如果有收到 [ZegoRoomDelegate -onDisconnect:roomID:] 回调，则不会再收到 [ZegoLivePublisherDelegate -onPublishStateUpdate:streamID:streamInfo:] 回调。
• 4.为了满足客户的秒开播需求，该接口可以在调用登录房间接口后同步调用，如果登录房间失败，则直播发布也失败。

Discussion

• 接收端只要开始拉流就会收到流附加信息及其后续更新，适用于想要在流信息中附带附加信息的情况（非变动频繁的信息）。

• 注意：

• 1.可以在初始化 SDK 之后的任意时间调用，会在直播流中附带该信息。
• 2.更新流附加信息后，同一房间播放该直播流的人会收到 [ZegoLiveRoomDelegate -onStreamExtraInfoUpdated:roomID:] 回调。

Discussion

• 注意：
• 1.用于停止已发布的直播，可以在发布直播后调用。
• 2.停止发布直播不会触发 [ZegoLivePublisherDelegate -onPublishStateUpdate:streamID:streamInfo:] 回调。

Discussion

• 使用连麦/混流推流模式时，可以通过该接口指定即构服务器转推 CDN 的地址。

• 注意：推流开始前调用有效。

Discussion

不支持多房间模式（通过 [ZegoLiveRoomApi setRoomMode:] 开启）。

多房间模式下请使用 [ZegoLiveRoomApi respondJoinLiveReq:result:room:]，指定房间 ID。

主播端通过 [ZegoLivePublisherDelegate -onJoinLiveRequest:fromUserID:fromUserName:seq:] 收到观众连麦申请，再调用本 API 响应

Discussion

多房间模式下，必须指定房间 ID。

主播端通过 [ZegoLivePublisherDelegate -onJoinLiveRequest:fromUserID:fromUserName:seq:] 收到观众连麦申请，再调用本 API 响应

Discussion

不支持多房间模式（通过 [ZegoLiveRoomApi setRoomMode:] 开启）。

多房间模式下请使用 [ZegoLiveRoomApi inviteJoinLive:room:responseBlock:]，指定房间 ID。

主播邀请连麦成功后，被邀请的观众收到 [ZegoLivePlayerDelegate -onInviteJoinLiveRequest:fromUserID:fromUserName:roomID:] 通知

Discussion

多房间模式下，必须指定房间 ID。

主播邀请连麦成功后，被邀请的观众收到 [ZegoLivePlayerDelegate -onInviteJoinLiveRequest:fromUserID:fromUserName:roomID:] 通知

Discussion

不支持多房间模式（通过 [ZegoLiveRoomApi setRoomMode:] 开启）。

多房间模式下请使用 [ZegoLiveRoomApi endJoinLive:room:completionBlock:]，指定房间 ID。

Discussion

多房间模式下，必须指定房间 ID。

Discussion

• 注意：
• 1. 必须在推流前设置；
• 1. 在反初始化 SDK 前，设置的值一直有效；
• 1. 打开硬编硬解开关需后台可控，避免碰到版本升级或者硬件升级时出现硬编硬解失败的问题；
• 1. 如果要单独控制某个推流通道，请参考：-requireHardwareEncoder:channelIndex:；
• 1. ！！！打开硬编硬解开关需后台可控，避免碰到版本升级或者硬件升级时出现硬编硬解失败的问题

Discussion

• 注意：
• 1. 必须在推流前设置；
• 1. 在反初始化 SDK 前，设置的值一直有效；
• 1. 打开硬编硬解开关需后台可控，避免碰到版本升级或者硬件升级时出现硬编硬解失败的问题；
• 1. 如果想统一控制所有通道的硬编码开关，请参考：+requireHardwareEncoder:；
• 1. 通过此 API 设置的值可与 requireHardwareEncoder: 设置的值相互覆盖，具体取决于其调用顺序。

Discussion

• 调用本 API 可以配置发布直播时视频采集、编码的参数。

• 注意：

• 1.在推流之前设置有效，在推流后设置的视频采集分辨率将无效并且不推荐在推流之后修改设置。
• 2.推荐使用 [ZegoLiveRoomApi(Publisher) -enableTrafficControl:properties:] 流量控制，让 SDK 进行动态码率、帧率、分辨率控制。
• 3.只适用于 UDP 推流。

Discussion

• 本设置用于校正输出视频朝向，默认竖屏。建议在预览和推流之前设置好方向。
• 不建议在推流过程中旋转画面，原因：
• 1. 如果刚开始为竖屏开播，此时旋转为横屏，但是分辨率仍然是竖屏的，会导致横屏后，画面放大的效果(按照等比填充的模式) 或者 上下黑边的效果(按照等比缩放的模式)，除非旋转为横屏后，画面的分辨率也做修改。
• 1. 直播过程中修改分辨率的话，会导致录制文件(回放)有异常，因此不建议中途旋转画面。

Discussion

推流时可调用本 API 进行参数配置

Discussion

推流时可调用本 API 进行参数配置。设置时需确保对应美颜特性开启

Discussion

推流时可调用本 API 进行参数配置。设置时需确保对应美颜特性开启

Discussion

推流时可调用本 API 进行参数配置。设置时需确保对应美颜特性开启

Discussion

推流时可调用本 API 进行参数配置。设置时需确保对应美颜特性开启

Discussion

推流时可调用本 API 进行参数配置

Discussion

• 视图模式默认为 ZegoVideoViewModeScaleAspectFill。

Discussion

• 注意：
• 1.只能设置(0/90/180/270)，默认为0。
• 2.该设置只是设置预览渲染图像的朝向，不会改变推流时的图像朝向。

Discussion

推流时可调用本 API 进行参数配置

Discussion

推流时可调用本 API 进行参数配置

Discussion

• 预览镜像只对前置摄像头有效，后置无效。
• 默认预览启用镜像，推流不启用镜像（即 ZegoVideoMirrorModePreviewMirrorPublishNoMirror）

Discussion

• 注意：1. 在推流之前设置有效；
• 只适用于 RTMP 推流。

开启后，在带宽不足的情况下码率自动适应当前带宽

Discussion

• 注意：在推流之前设置有效。

Discussion

• 如果使用前置摄像头，本地预览和推流都将使用前置摄像头拍摄的数据。SDK 默认使用前置摄像头。

Discussion

• 开启麦克风后，推流数据才包含麦克风采集的音频数据。SDK 默认开启麦克风。

Discussion

• 开启视频采集后，预览视图才能显示预览画面，推流时才包含采集的视频数据。SDK 默认开启视频采集。

Discussion

• 推流时可调用本 API 进行参数配置。SDK 默认关闭手电筒。

Discussion

• 截图结果通过 blk 回调。

Discussion

• 开启耳返后，主播方讲话会听到自己的声音。
• 在连接上耳麦时耳返功能才实际生效。
• 耳返默认是在采集之后、前处理之前返回，如果需要在前处理之后返回请咨询技术支持。

Discussion

• SDK 采集音频时会根据该 API 设置的音量值进行音量大小的控制。开发者可在推流时调用该 API 调节音频数据的音量大小。

Discussion

推流开始前调用本 API 进行参数配置

Discussion

左上角为坐标系原点，区域不能超过编码分辨率设置的大小

Discussion

左上角为坐标系原点，区域不能超过预览视图的大小

Discussion

• 注意：
• 1.可以在初始化 SDK 后任意时间设置，但不推荐在推流时动态修改码率。
• 2.推荐使用 [ZegoLiveRoomApi(Publisher) -enableTrafficControl:properties:] 让 SDK 进行动态码率控制。
• 3.只适用于 UDP 推流。

Discussion

• 注意：
• 1.可以在初始化 SDK 后任意时间设置，但不推荐在推流时动态修改码率。
• 2.推荐使用 [ZegoLiveRoomApi(Publisher) -enableTrafficControl:properties:] 让 SDK 进行动态码率控制。
• 3.只适用于 UDP 推流。

Discussion

• 建议开发者根据情景选择合适的模式，以达到前处理的最优效果。
• 直播场景下，推荐使用 ZEGOAPI_AUDIO_DEVICE_MODE_AUTO；
• 实时音、视频场景下（比如教育、游戏等），推荐使用 COMMUNICATION 类 mode，可避免 SDK 内部因切换 Mode 而启动、停止音频设备等耗时操作。
• 当业务方的用户主要在带耳机的情况下推流时，如果需要保证较好的音质效果，可使用 ZEGOAPI_AUDIO_DEVICE_MODE_GENERAL，除此情景之外，不推荐使用 GENERAL 模式，因为无法保证采集的音质效果。

• 默认使用 ZEGOAPI_AUDIO_DEVICE_MODE_AUTO。

• 注意：

• 1.在推流预览前后调用均有效，调用该接口会触发设备的启动切换，建议不要频繁调用，避免不必要的开销与硬件问题。
• 2.如果需要在使用耳机时进行音频前处理，需要调用 [ZegoLiveRoomApi(AudioIO) -enableAECWhenHeadsetDetected:] 设置 YES。
• 3.用本接口可能导致音量模式在 通话/媒体 间切换，若媒体音量和通话音量不一致，可能导致音量变化

Discussion

• 推荐结合硬件音频前处理一起使用，当硬件音频前处理效果不好、被关闭或不被支持时，可开启软件音频前处理。

• 建议在推流前调用设置。

• 注意：

• 1.软件回音消除只能处理 zego SDK 播放的音频，不能处理第三方播放器播放的视频。
• 2.如果使用音频外部采集，需要开发者自己去回声消除，该开关无效。
• 3.iOS 默认不开启该开关，Android 是默认开启该开关。

Discussion

• 建议在推流前调用设置。默认为 ZEGOAPI_AEC_MODE_ARRGRESSIVE。

Discussion

• 开启该开关后，SDK 可将太小或太大的音量处理成一定范围的音量，让整段音频的音量控制在一定范围内。在教育、视频会议等对音量稳定性有要求的场景可启用该开关。
• 建议在推流前调用设置。默认开启。

Discussion

• 注意：
• 1.建议在启动本地预览和开始推流前调用，摄像头启动之后调用不会立即生效，而是在下次摄像头启动时生效。
• 2.如果设置为先缩放（ZEGOAPI_CAPTURE_PIPELINE_SCALE_MODE_PRE），预览的分辨率就是编码分辨率；设置为后缩放（ZEGOAPI_CAPTURE_PIPELINE_SCALE_MODE_POST），预览的分辨率就是采集分辨率。
• 默认为 ZEGOAPI_CAPTURE_PIPELINE_SCALE_MODE_PRE。

Discussion

• 设置 SDK 推流时音频使用的延迟模式，可以根据自己的业务场景选择最合适的延迟模式，详情可咨询 ZEGO 技术支持。

• 注意：在InitSDK之后，推流前调用有效。

Discussion

• 注意：
• 1.在InitSDK之后，推流前调用有效。
• 2.[ZegoLiveRoomApi(Publisher) -setLatencyMode:] 中将延迟模式设置为 ZEGO_LATENCY_MODE_NORMAL、ZEGO_LATENCY_MODE_NORMAL2、ZEGO_LATENCY_MODE_LOW3 才能设置双声道。
• 3.在移动端双声道通常需要配合音频前处理才能体现效果。

Discussion

• 注意：
• 1.推流前调用有效，连麦/混流方式调用此接口有效。
• 2.开启离散音频包发送可以在关闭麦克风或者静音的状态下，停止音频包的发送，节省用户流量。
• 3.如果为音频单流(非混流)转推 CDN，开启此选项将导致 CDN 在设定时间内未收到数据包认为流关闭而断开连接，所以此种情况不建议开启。
• 4.SDK 默认关闭该特性。

Discussion

• 开启语音活动检测可以在检测到没有语音只有底噪声的情况下，直接发送静音包，节省用户流量。

• 注意：

• 1.推流前调用有效，连麦/混流方式调用此接口有效。
• 2.可以和 [ZegoLiveRoomApi(Publisher) -enableDTX:] 配合使用。

Discussion

• 开启流量控制开关可以使 SDK 通过动态调整音视频的码率、帧率、分辨率来适应当前网络环境，从而保证直播的流畅发布。

• 注意：

• 1.在推流前调用，连麦/混流方式调用此接口有效。
• 2.当关闭流量控制时，流量控制属性将被忽略。