ZegoExpressEngine(Publisher)

Declared in ZegoExpressEngine+Publisher.h

startPublishingStream: - 开始推流
startPublishingStream:channel: - 开始推流，可选择推第二路流
stopPublishingStream - 停止推流
stopPublishingStream: - 停止推流，可停止指定通道的音视频流
setStreamExtraInfo:callback: - 设置流附加信息
setStreamExtraInfo:channel:callback: - 设置流附加信息，支持设置其他通道的推流
startPreview: - 启动/更新本地预览
startPreview:channel: - 启动/更新本地预览，支持设置其他通道的推流
startPreview - 启动本地音频预览，即在创建 Engine 之后，未推拉流之前，可以调用此接口，Enging 会开始采集音频
stopPreview - 停止本地预览
stopPreview: - 停止本地预览
setVideoConfig: - 设置视频配置
setVideoConfig:channel: - 设置视频配置，支持设置其他推流
getVideoConfig - 获取当前视频配置
getVideoConfig: - 获取当前视频配置
setVideoMirrorMode: - 设置镜像模式
setVideoMirrorMode:channel: - 设置镜像模式，支持设置其他通道的推流
setAppOrientation: - 设置视频的朝向
setAppOrientation:channel: - 设置采集视频的朝向，支持设置其他路推流。
setAudioConfig: - 设置音频质量配置
getAudioConfig - 获取当前音频质量配置
mutePublishStreamAudio: - 停止或恢复发送音频流
mutePublishStreamAudio:channel: - 停止或恢复发送音频流，支持设置其他路推流
mutePublishStreamVideo: - 停止或恢复发送视频流
mutePublishStreamVideo:channel: - 停止或恢复发送视频流，支持设置其他路推流
enableTrafficControl:property: - 开始或停止流量控制
setMinVideoBitrateForTrafficControl:mode: - 设置流量控制视频码率最低值
setCaptureVolume: - 设置推流端采集音量
addPublishCdnUrl:streamID:callback: - 增加转推至 CDN 的 URL
removePublishCdnUrl:streamID:callback: - 删除转推至 CDN 的 URL
enablePublishDirectToCDN:config: - 是否不经过 Zego 实时视频云服务器直接推流到 CDN
enablePublishDirectToCDN:config:channel: - 是否不经过 Zego 实时视频云服务器直接推流到 CDN，支持设置其他路推流
setPublishWatermark:isPreviewVisible: - 设置推流水印
setPublishWatermark:isPreviewVisible:channel: - 设置推流水印，支持设置其他路推流
sendSEI: - 发送媒体增强补充信息
sendSEI:channel: - 发送媒体增强补充信息，支持设置其他路推流
enableHardwareEncoder: - 开/关硬件编码
setCapturePipelineScaleMode: - 设置采集缩放时机，视频数据是采集的时候立即缩放还是编码时才进行缩放

Public Func Docs

startPublishingStream:

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

开始推流

Parameters
streamID	流 ID，长度不超过256的字符串，需要在整个 AppID 内全局唯一，若出现在同一个 AppID 内，不同的用户各推了一条流且流名相同，将会导致后推流的用户推流失败。不可以包含 URL 关键字，否则推拉流失败。仅支持数字，英文字符和 '~', '!', '@', '#', '$', '', '^', '&', '*', '(', ')', '_', '+', '=', '-', ', ';', '’', ',', '.', '<', '>', '/', ''。

Parameters

streamID

流 ID，长度不超过256的字符串，需要在整个 AppID 内全局唯一，若出现在同一个 AppID 内，不同的用户各推了一条流且流名相同，将会导致后推流的用户推流失败。不可以包含 URL 关键字，否则推拉流失败。仅支持数字，英文字符和 '~', '!', '@', '#', '$', '', '^', '&', '*', '(', ')', '_', '+', '=', '-', ', ';', '’', ',', '.', '<', '>', '/', ''。

startPublishingStream:channel:

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

开始推流，可选择推第二路流

Parameters
streamID	流 ID，长度不超过256的字符串，需要在整个 AppID 内全局唯一，若出现在同一个 AppID 内，不同的用户各推了一条流且流名相同，将会导致后推流的用户推流失败。不可以包含 URL 关键字，否则推拉流失败。仅支持数字，英文字符和 '~', '!', '@', '#', '$', '', '^', '&', '*', '(', ')', '_', '+', '=', '-', ', ';', '’', ',', '.', '<', '>', '/', ''。
channel	推流通道

Parameters

streamID

channel

推流通道

stopPublishingStream

- (void)stopPublishingStream:;

停止推流

stopPublishingStream:

- (void)stopPublishingStream:(ZegoPublishChannel) channel;

停止推流，可停止指定通道的音视频流

Parameters
channel	推流通道

setStreamExtraInfo:callback:

- (void)setStreamExtraInfo:(NSString *) extraInfo callback:(ZegoPublisherSetStreamExtraInfoCallbacknullable ) callback;

设置流附加信息

Parameters
extraInfo	流附加信息，长度不超过1024的字符串
callback	更新流附加信息执行结果通知

setStreamExtraInfo:channel:callback:

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

设置流附加信息，支持设置其他通道的推流

Parameters
extraInfo	流附加信息，长度不超过1024的字符串
channel	推流通道
callback	更新流附加信息执行结果通知

startPreview:

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

启动/更新本地预览

Parameters
canvas	启动预览时用于显示画面的视图，视图设置为 nil 则不进行预览

startPreview:channel:

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

启动/更新本地预览，支持设置其他通道的推流

Parameters
canvas	启动预览时用于显示画面的视图，视图设置为 nil 则不进行预览
channel	推流通道

startPreview

- (void)startPreview:;

启动本地音频预览，即在创建 Engine 之后，未推拉流之前，可以调用此接口，Enging 会开始采集音频

stopPreview

- (void)stopPreview:;

停止本地预览

stopPreview:

- (void)stopPreview:(ZegoPublishChannel) channel;

停止本地预览

Parameters
channel	推流通道

setVideoConfig:

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

设置视频配置

Parameters
config	视频配置，SDK 提供常用的分辨率、帧率和码率的组合值，也可自定义分辨率、帧率和码率

setVideoConfig:channel:

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

设置视频配置，支持设置其他推流

Parameters
config	视频配置，SDK 提供常用的分辨率、帧率和码率的组合值，也可自定义分辨率、帧率和码率
channel	推流通道

getVideoConfig

- (ZegoVideoConfig *)getVideoConfig:;

获取当前视频配置

getVideoConfig:

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

获取当前视频配置

Parameters
channel	推流通道

setVideoMirrorMode:

- (void)setVideoMirrorMode:(ZegoVideoMirrorMode) mirrorMode;

设置镜像模式

Parameters
mirrorMode	预览或推流的镜像模式

setVideoMirrorMode:channel:

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

设置镜像模式，支持设置其他通道的推流

Parameters
mirrorMode	预览或推流的镜像模式
channel	推流通道

setAppOrientation:

- (void)setAppOrientation:(UIInterfaceOrientation) orientation;

设置视频的朝向

Parameters
orientation	视频的朝向

setAppOrientation:channel:

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

设置采集视频的朝向，支持设置其他路推流。

Parameters
orientation	视频的朝向
channel	推流通道

setAudioConfig:

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

设置音频质量配置

Parameters
config	音频质量配置

getAudioConfig

- (ZegoAudioConfig *)getAudioConfig:;

获取当前音频质量配置

mutePublishStreamAudio:

- (void)mutePublishStreamAudio:(BOOL) mute;

停止或恢复发送音频流

Parameters
mute	是否停止发送音频流；YES 表示只发送视频流不发送音频流；NO 表示同时发送音频和视频流；默认为 NO

mutePublishStreamAudio:channel:

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

停止或恢复发送音频流，支持设置其他路推流

Parameters
mute	是否停止发送音频流；YES 表示只发送视频流不发送音频流；NO 表示同时发送音频和视频流；默认为 NO
channel	推流通道

mutePublishStreamVideo:

- (void)mutePublishStreamVideo:(BOOL) mute;

停止或恢复发送视频流

Parameters
mute	是否停止发送视频流；YES 表示只发送音频流不发送视频流；NO 表示同时发送音频和视频流；默认为 NO

mutePublishStreamVideo:channel:

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

停止或恢复发送视频流，支持设置其他路推流

Parameters
mute	是否停止发送视频流；YES 表示只发送音频流不发送视频流；NO 表示同时发送音频和视频流；默认为 NO
channel	推流通道

enableTrafficControl:property:

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

开始或停止流量控制

Parameters
enable	是否使用流量控制；YES 表示开启流控；NO 表示关闭流控；默认为 YES
property	流量控制的可调节的属性，位掩码格式。具体可设置为 [ZegoTrafficControlProperty] 的属性的一个或多个枚举组合。默认为 AdaptiveFPS

setMinVideoBitrateForTrafficControl:mode:

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

设置流量控制视频码率最低值

Parameters
bitrate	最低视频码率，单位为 kbps
mode	低于最低码率时的视频发送模式

setCaptureVolume:

- (void)setCaptureVolume:(int) volume;

设置推流端采集音量

Parameters
volume	音量百分比，范围为 0 ~ 100，默认值为 100。

addPublishCdnUrl:streamID:callback:

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

增加转推至 CDN 的 URL

Parameters
targetURL	CDN 转推地址，支持的转推地址格式为 rtmp。
streamID	流 ID
callback	添加 CDN 转推结果通知

removePublishCdnUrl:streamID:callback:

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

删除转推至 CDN 的 URL

Parameters
targetURL	CDN 转推地址，支持的转推地址格式有 rtmp，flv，hls
streamID	流 ID
callback	移除 CDN 转推结果通知

enablePublishDirectToCDN:config:

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

是否不经过 Zego 实时视频云服务器直接推流到 CDN

Parameters
enable	是否开启直推 CDN；YES 表示开启直推 CDN；NO 表示不开启直推 CDN；默认为 NO
config	CDN 配置，若为 nil 则使用 Zego 的后台配置

enablePublishDirectToCDN:config:channel:

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

是否不经过 Zego 实时视频云服务器直接推流到 CDN，支持设置其他路推流

Parameters
enable	是否开启直推 CDN；YES 表示开启直推 CDN；NO 表示不开启直推 CDN；默认为 NO
config	CDN 配置，若为 nil 则使用 Zego 的后台配置
channel	推流通道

setPublishWatermark:isPreviewVisible:

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

设置推流水印

Parameters
watermark	水印布局左上角为坐标系原点，区域不能超过编码分辨率设置的大小。若为空表示取消水印。
isPreviewVisible	是否本地预览能看见水印

setPublishWatermark:isPreviewVisible:channel:

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

设置推流水印，支持设置其他路推流

Parameters
watermark	水印布局左上角为坐标系原点，区域不能超过编码分辨率设置的大小。若为空表示取消水印。
isPreviewVisible	是否本地预览能看见水印
channel	推流通道

sendSEI:

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

发送媒体增强补充信息

Parameters
data	SEI 内容

sendSEI:channel:

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

发送媒体增强补充信息，支持设置其他路推流

Parameters
data	SEI 内容
channel	推流通道

enableHardwareEncoder:

- (void)enableHardwareEncoder:(BOOL) enable;

开/关硬件编码

Parameters
enable	是否开启硬件编码；YES 表示开启硬编；NO 表示关闭硬编；默认为 NO

setCapturePipelineScaleMode:

- (void)setCapturePipelineScaleMode:(ZegoCapturePipelineScaleMode) mode;

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

Parameters
mode	采集缩放时机