|
ZegoLiveRoom
|
Classes | |
| class | IAVEngineCallback |
| class | IIMCallback |
| class | ILivePlayerCallback |
| class | ILivePublisherCallback |
| class | IRoomCallback |
| class | IRoomExtraInfoCallback |
| struct | ZegoPlayQuality |
| struct | ZegoPlayStreamParams |
| struct | ZegoPublishQuality |
| struct | ZegoPublishStreamParams |
| struct | ZegoReceiveRangeParam |
| struct | ZegoVocalRangeParam |
Typedefs | |
| typedef void(* | ExperimentalAPICallback) (const char *params) |
Enumerations | |
| enum | ZegoVideoViewMode { ZegoVideoViewModeScaleAspectFit = 0 , ZegoVideoViewModeScaleAspectFill = 1 , ZegoVideoViewModeScaleToFill = 2 } |
| enum | ZegoMixSysPlayoutPropertyMask { MIX_PROP_NONE = 0 , MIX_PROP_ENABLE_AGC_FOR_SYS_PLAYOUT = 1 } |
| enum | ZegoRoomMode { ZegoRoomModeSingleRoom = 0 , ZegoRoomModeMultiRoom = 1 } |
| enum | ZegoRangeAudioMode { ZegoRangeAudioModeWorld = 1 , ZegoRangeAudioModeTeam = 2 , ZegoRangeAudioModeSecreteTeam = 3 } |
| enum | ZegoRangeAudioMicrophoneState { Opening = 1 , Success = 2 , TempBroken = 3 , Failed = 4 } |
| enum | ZegoRangeAudioSpeakMode { SpeakToAll = 0 , SpeakToWorld = 1 , SpeakToTeam = 2 } |
| enum | ZegoRangeAudioListenMode { ListenFromAll = 0 , ListenFromWorld = 1 , ListenFromTeam = 2 } |
Variables | |
| ZEGO_API const char * | kZegoVideoDataMainPublishingStream |
| ZEGO_API const char * | kZegoVideoDataAuxPublishingStream |
| const int | kInvalidSeq = -1 |
| typedef void(* ZEGO::LIVEROOM::ExperimentalAPICallback) (const char *params) |
试验性API回调函数定义
| params | 参数，json格式，详情请咨询ZEGO技术支持。 |
| ZEGO_API int ZEGO::LIVEROOM::ActivateAllAudioPlayStream | ( | bool | bActive | ) |
拉流是否接收音频数据
| bActive | true 接收，false 不接收 |
| ZEGO_API int ZEGO::LIVEROOM::ActivateAllVideoPlayStream | ( | bool | bActive | ) |
拉流是否接收视频数据
| bActive | true 接收，false 不接收 |
| ZEGO_API int ZEGO::LIVEROOM::ActivateAudioPlayStream | ( | const char * | pszStreamID, |
| bool | bActive | ||
| ) |
拉流是否接收音频数据
| pszStreamID | 播放流 ID |
| bActive | true 接收，false 不接收 |
| ZEGO_API int ZEGO::LIVEROOM::ActivateVideoPlayStream | ( | const char * | pszStreamID, |
| bool | bActive, | ||
| AV::VideoStreamLayer | videoLayer = AV::VideoStreamLayer_Auto |
||
| ) |
拉流是否接收视频数据
| pszStreamID | 播放流 ID |
| bActive | true 接收，false 不接收 |
| videoLayer | 视频分层类型，请参考 AV::VideoStreamLayer |
| ZEGO_API int ZEGO::LIVEROOM::AddPublishTarget | ( | const char * | strTarget, |
| const char * | pszStreamID, | ||
| int | timeout = 0 |
||
| ) |
添加转推地址
| strTarget | 转推地址（支持rtmp/avertp） |
| pszStreamID | 推流ID |
| timeout | 超时时间，如果在时间内没有开始转推要回调通知。默认为0，表示不超时，有效范围[5,600]，单位秒。小于0会被重置为0，1到4会被重置为5，大于600会被重置为600。 |
| ZEGO_API unsigned int ZEGO::LIVEROOM::CallExperimentalAPI | ( | const char * | params | ) |
试验性API
| params | 参数，json格式，详情请咨询ZEGO技术支持。 |
| ZEGO_API int ZEGO::LIVEROOM::DeletePublishTarget | ( | const char * | strTarget, |
| const char * | pszStreamID | ||
| ) |
删除转推地址
| strTarget | 转推地址（支持rtmp/avertp） |
| pszStreamID | 推流ID |
| ZEGO_API bool ZEGO::LIVEROOM::EnableAEC | ( | bool | bEnable | ) |
开关回声消除
未调用此函数前，SDK 内部会自动判断是否需要使用 AEC，一旦调用了此函数则不再自动判断 若需要恢复为 SDK 自动判断，请调用 [ResetAEC]
| bEnable | true 打开，false 关闭 |
| ZEGO_API bool ZEGO::LIVEROOM::EnableAGC | ( | bool | bEnable | ) |
音频采集自动增益开关。
未调用此函数前，SDK 内部会自动判断是否需要使用 AGC，一旦调用了此函数则不再自动判断 若需要恢复为 SDK 自动判断，请调用 [ResetAGC]
| bEnable | 是否开启 true 开启，false 关闭 |
| ZEGO_API void ZEGO::LIVEROOM::EnableAlignedAudioAuxData | ( | bool | enable, |
| int | sampleRate, | ||
| int | channels | ||
| ) |
开启/关闭抛出对齐后的混音数据特性
| enable | true: 开启抛出对齐后的混音数据特性；false: 关闭抛出对齐后的混音数据特性 |
| sampleRate | 采样率，仅支持 8000、16000、32000、44100、48000 |
| channels | 声道数，仅支持单声道(1)、双声道(2) |
| ZEGO_API void ZEGO::LIVEROOM::EnableAlphaChannelVideoEncoder | ( | bool | enable, |
| AV::ZegoAlphaLayoutType | layoutType, | ||
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
开启视频编码器透明通道支持。
| enable | 是否开启视频编码器透明通道支持，默认关闭。 |
| layoutType | 透明通道数据布局方式。 |
| idx | 推流通道，默认为 AV::PUBLISH_CHN_MAIN。 |
| ZEGO_API void ZEGO::LIVEROOM::EnableAudioPostp | ( | bool | enable, |
| const char * | streamID | ||
| ) |
开启/关闭音频后处理特性
| enable | true: 开启拉流音频后处理特性；false: 关闭拉流音频后处理特性 |
| streamID | 流 ID, 当 streamID 为空串时，表明需要混音后的音频数据 |
| ZEGO_API void ZEGO::LIVEROOM::EnableAudioPrepVADStableStateMonitor | ( | bool | enable, |
| int | period = 3000 |
||
| ) |
开启音频外部预处理后的音频数据的语音状态检测
| enable | 是否开启 |
| period | 检测周期，单位毫秒，默认值 3000，有效值 [200, 10000] |
| ZEGO_API bool ZEGO::LIVEROOM::EnableBeautifying | ( | int | nFeature, |
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
主播开启美颜功能
| nFeature | 美颜特性。默认无美颜 |
| idx | 推流 channel Index. 默认为主Channel |
| ZEGO_API void ZEGO::LIVEROOM::EnableBeforeAudioPrepCallback | ( | bool | enable, |
| int | sampleRate, | ||
| int | channel | ||
| ) |
开启或关闭音频前处理前的音频数据回调。
| enable | true-开启，false-关闭，默认 false。 |
| sampleRate | 音频采样率，取值范围：{0, 16000, 32000, 44100, 48000}，0-使用 SDK 数据当前采样率 |
| channel | 声道数，取值范围：{0, 1, 2}，0-使用 SDK 数据当前声道数 |
| ZEGO_API bool ZEGO::LIVEROOM::EnableCamera | ( | bool | bEnable, |
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
开启摄像头
| bEnable | true 开启，false 关闭。默认 true |
| idx | 推流 channel Index. 默认为主Channel |
| ZEGO_API void ZEGO::LIVEROOM::EnableCapturedAudioVADStableStateMonitor | ( | bool | enable, |
| int | period = 3000 |
||
| ) |
开启采集后的音频数据语音状态检测（包括麦克风采集和外部音频采集）
| enable | 是否开启 |
| period | 检测周期，单位毫秒，默认值 3000，有效值 [200, 10000] |
| ZEGO_API void ZEGO::LIVEROOM::EnableCheckPoc | ( | bool | bEnable | ) |
帧顺序检测开关
| bEnalbe | true 检测帧顺序，不支持B帧； false 不检测帧顺序，支持B帧，可能出现短暂花屏 |
| ZEGO_API void ZEGO::LIVEROOM::EnableColorEnhancement | ( | bool | enable, |
| AV::ZegoColorEnhancementParams | params, | ||
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
开启色彩增强
| enable | 是否开启；true 表示开启；false 表示关闭。 |
| params | 色彩增强参数。 |
| idx | 推流通道号，参见 PublishChannelIndex，默认值 PUBLISH_CHN_MAIN。 |
| ZEGO_API void ZEGO::LIVEROOM::EnableDTX | ( | bool | bEnable | ) |
是否开启离散音频包发送
| bEnable | true 开启，推流中检测为静音的数据包不发送；false 关闭，推流中的静音数据包照常发送。默认是 false。 |
| ZEGO_API bool ZEGO::LIVEROOM::EnableH265EncodeFallback | ( | bool | enable | ) |
开/关 H.265 编码自动降级到 H.264 编码
| enable | true - 在H.265编码失败时，自动降级到H.264编码，false - 不支持H.265编码自动降级，默认true |
| ZEGO_API bool ZEGO::LIVEROOM::EnableLoopback | ( | bool | bEnable | ) |
开启采集监听
| bEnable | true 打开，false 关闭。默认 false |
| ZEGO_API bool ZEGO::LIVEROOM::EnableMic | ( | bool | bEnable | ) |
开启麦克风
| bEnable | true 打开，false 关闭。默认 true |
| ZEGO_API bool ZEGO::LIVEROOM::EnableMicDevice | ( | bool | enable | ) |
设置是否允许SDK使用麦克风设备
| enable | true 表示允许使用麦克风，false 表示禁止使用麦克风，此时如果SDK在占用麦克风则会立即释放。 |
| ZEGO_API bool ZEGO::LIVEROOM::EnableNoiseSuppress | ( | bool | bEnable | ) |
音频采集降噪开关
未调用此函数前，SDK 内部会自动判断是否需要使用 ANS，一旦调用了此函数则不再自动判断 若需要恢复为 SDK 自动判断，请调用 [ResetNoiseSuppress]
| bEnable | 是否开启 |
| ZEGO_API bool ZEGO::LIVEROOM::EnablePlayVirtualStereo | ( | bool | enable, |
| int | angle, | ||
| const char * | streamID | ||
| ) |
设置拉的流的虚拟立体声源相对于本端的角度，可以实现空间音频效果
| enable | true 开启，false 关闭，默认关闭 |
| angle | 虚拟立体声中声源的角度，范围为0～360，90为正前方，0对应正右方 |
| streamID | 流 ID |
| ZEGO_API bool ZEGO::LIVEROOM::EnablePreviewMirror | ( | bool | bEnabasle, |
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
是否启用预览镜像
| bEnable | true 启用，false 不启用。默认 true |
| idx | 推流 channel Index. 默认为主Channel |
| ZEGO_API int ZEGO::LIVEROOM::EnablePublishStreamAlignment | ( | bool | enable | ) |
设置所有推流通道是否校准网络时间，用于混流时各路流的对齐
| enable | true开启，false关闭 |
| ZEGO_API void ZEGO::LIVEROOM::EnableScreenCaptureEncodeOptimization | ( | bool | enable, |
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
开启屏幕分享编码优化
| enable | 是否开启。true：开启，false：关闭。默认是关闭的。 |
| idx | 推流通道 |
| ZEGO_API bool ZEGO::LIVEROOM::EnableSelectedAudioRecord | ( | unsigned int | uMask, |
| int | nSampleRate = 44100, |
||
| int | nChannels = 1 |
||
| ) |
音频录制回调开关
| uMask | 启用音频源选择，参考 AV::ZegoAVAPIAudioRecordMask |
| nSampleRate | 采样率 8000, 16000, 22050, 24000, 32000, 44100, 48000 |
| nChannels | 声道数 1(单声道) 或 2(双声道) |
| ZEGO_API bool ZEGO::LIVEROOM::EnableSpeaker | ( | bool | bEnable | ) |
（声音输出）扬声器开关
| bEnable | true 开启，false 关闭。默认 true |
| ZEGO_API void ZEGO::LIVEROOM::EnableTrafficControl | ( | int | properties, |
| bool | bEnable, | ||
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
是否开启流量控制
| properites | 流量控制属性 (帧率，分辨率），参考 ZegoTrafficControlProperty 定义。默认 ZEGO_TRAFFIC_CONTROL_ADAPTIVE_FPS |
| bEnable | true 开启，false 关闭。默认开启。 |
| idx | 推流通道，参考 AV::PublishChannelIndex 定义。默认 AV::PUBLISH_CHN_MAIN。 |
| ZEGO_API bool ZEGO::LIVEROOM::EnableTransientNoiseSuppress | ( | bool | bEnable | ) |
音频采集智能降噪开关, 消除键盘、敲桌子的规律噪音
| bEnable | 是否开启 true 开启，false 关闭，默认关闭 |
| ZEGO_API void ZEGO::LIVEROOM::EnableVAD | ( | bool | bEnable | ) |
是否开启语音活动检测
| bEnable | true 开启；false 关闭，默认关闭 |
| ZEGO_API void ZEGO::LIVEROOM::EnableVideoObjectSegmentation | ( | bool | enable, |
| AV::ZegoObjectSegmentationType | type, | ||
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
开启视频主体分割
| enable | 是否开启主体分割，默认关闭。 |
| type | 主体分割类型。 |
| idx | 推流通道，默认为 AV::PUBLISH_CHN_MAIN。 |
| ZEGO_API void ZEGO::LIVEROOM::EnableVideoObjectSegmentation | ( | bool | enable, |
| const AV::ZegoObjectSegmentationConfig & | config, | ||
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
开启主体分割
| enable | 是否开启主体分割，默认关闭。 |
| config | 主体分割配置。 |
| idx | 推流通道，默认为 AV::PUBLISH_CHN_MAIN。 |
| ZEGO_API bool ZEGO::LIVEROOM::EnableViewMirror | ( | bool | bEnable, |
| const char * | pszStreamID | ||
| ) |
是否启用播放镜像
| bEnable | true 启用，false 不启用。默认 true |
| pszStreamID | 播放流 ID |
| ZEGO_API int ZEGO::LIVEROOM::EndJoinLive | ( | const char * | pszUserID, |
| const char * | pszRoomID = nullptr |
||
| ) |
结束连麦
| pszUserID | 指定结束连麦的用户 ID |
| pszRoomID | 房间 ID |
| ZEGO_API void ZEGO::LIVEROOM::FreeDeviceList | ( | AV::DeviceInfo * | parrDeviceList | ) |
释放设备列表
| parrDeviceList | 设备列表 |
| ZEGO_API void ZEGO::LIVEROOM::FreeRoomStreamList | ( | ROOM::ZegoRoomStreamList * | streamList | ) |
释放GetRoomStreamList 获取的列表内存
| streamList | GetRoomStreamList 获取的streamList 列表 |
| ZEGO_API void ZEGO::LIVEROOM::FreeVideoCodecCapabilityList | ( | AV::ZegoCodecCapabilityInfo * | parrCodecCapability | ) |
释放设备编码格式的能力列表
| parrCodecCapability | 设备编码格式的能力列表 |
| ZEGO_API void ZEGO::LIVEROOM::FreeVideoDevCapabilityList | ( | AV::DeviceVideoCapabilityInfo * | parrVideoCapability | ) |
释放视频设备的分辨率列表
| parrVideoCapability | 视频设备的分辨率列表 |
| ZEGO_API AV::DeviceInfo * ZEGO::LIVEROOM::GetAudioDeviceList | ( | AV::AudioDeviceType | deviceType, |
| int & | device_count | ||
| ) |
获取音频设备列表
| deviceType | 设备类型 |
| device_count | 设备数量 |
| ZEGO_API int ZEGO::LIVEROOM::GetAudioRouteType | ( | ) |
获取当前的 audio route type
| ZEGO_API float ZEGO::LIVEROOM::GetCaptureSoundLevel | ( | ) |
获取当前采集的音量
| ZEGO_API void * ZEGO::LIVEROOM::GetChannelExtraParam | ( | AV::ChannelExtraParamKey | key, |
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
获取推流通道扩展参数
| key | 需要获取的参数类型，目前仅支持 AVCaptureDevice |
| idx | 推流通道索引，默认主通道 |
| ZEGO_API int ZEGO::LIVEROOM::GetMaxPlayChannelCount | ( | ) |
获取 SDK 支持的最大同时播放流数
| ZEGO_API int ZEGO::LIVEROOM::GetMaxPublishChannelCount | ( | ) |
获取 SDK 支持的最大同时支持的推流路数
| ZEGO_API bool ZEGO::LIVEROOM::GetRoomMessage | ( | ROOM::ZegoMessagePriority | priority, |
| bool | ascendOrder, | ||
| unsigned long long | messageId, | ||
| int | messageCount, | ||
| const char * | roomID = nullptr |
||
| ) |
获取聊天室历史消息
| priority | 消息优先级 |
| ascendOrder | 历史消息新旧顺序 |
| messageId | 消息ID |
| messageCount | 历史消息条数 |
| roomID | 可选，房间 ID, 为 nullptr 时，表示往默认房间发送 |
| ZEGO_API bool ZEGO::LIVEROOM::GetRoomStreamList | ( | ROOM::ZegoRoomStreamList ** | streamList, |
| ROOM::ZegoRoomStreamListType | streamListType, | ||
| const char * | roomID = nullptr |
||
| ) |
获取房间内的流列表
| streamList | 流列表 |
| streamListType | 获取流列表类型 |
| roomID | 可选，房间 ID |
| ZEGO_API const char * ZEGO::LIVEROOM::GetSDKVersion | ( | ) |
获取SDK版本号
| ZEGO_API const char * ZEGO::LIVEROOM::GetSDKVersion2 | ( | ) |
获取SDK版本号2
| ZEGO_API float ZEGO::LIVEROOM::GetSoundLevel | ( | const char * | pszStreamID | ) |
获取当前播放视频的实时音量
| pszStreamID | 播放流 ID |
| ZEGO_API ROOM::ZegoUser ZEGO::LIVEROOM::GetUserByStreamID | ( | const char * | pszStreamID | ) |
| ZEGO_API const char * ZEGO::LIVEROOM::GetUserID | ( | ) |
获取用户信息
| ZEGO_API AV::ZegoCodecCapabilityInfo * ZEGO::LIVEROOM::GetVideoCodecCapabilityList | ( | int & | len | ) |
获取设备编码格式的能力，外部拿到信息 建议立即调用FreeVideoCodecCapabilityList 销毁SDK申请的内存。
| len | 设备支持编码格式个数 |
| ZEGO_API AV::DeviceVideoCapabilityInfo * ZEGO::LIVEROOM::GetVideoDevCapabilityList | ( | const char * | pszVideoDeviceID, |
| int & | nVideoCapabilityInfoCount | ||
| ) |
获取视频设备的分辨率列表,获取完成后，外部拿到信息 建议立即调用FreeVideoDevCapabilityList 销毁SDK申请的内存。 mac 平台需在initsdk 回调后调用
| pszVideoDeviceID | 视频设备 ID |
| nVideoCapabilityInfoCount | 支持分辨率列表个数 |
| ZEGO_API AV::DeviceInfo * ZEGO::LIVEROOM::GetVideoDeviceList | ( | int & | device_count | ) |
获取视频设备列表
| device_count | 设备数量 |
| ZEGO_API bool ZEGO::LIVEROOM::InitPlatform | ( | void * | jvm = 0, |
| void * | ctx = 0, |
||
| void * | clsLoader = 0 |
||
| ) |
初始化引擎
| jvm | jvm 仅用于 Android |
| ctx | ctx 仅用于 Android |
| clsLoader | 仅用于 Android |
| ZEGO_API bool ZEGO::LIVEROOM::InitSDK | ( | unsigned int | uiAppID, |
| unsigned char * | pBufAppSignature, | ||
| int | nSignatureSize | ||
| ) |
初始化 SDK
| uiAppID | Zego 派发的数字 ID, 各个开发者的唯一标识 |
| pBufAppSignature | Zego 派发的签名, 用来校验对应 appID 的合法性 |
| nSignatureSize | 签名长度（字节） |
| ZEGO_API int ZEGO::LIVEROOM::InviteJoinLive | ( | const char * | pszUserID, |
| const char * | pszRoomID = nullptr |
||
| ) |
邀请连麦
| pszUserID | 准备邀请的用户 ID |
| pszRoomID | 房间 ID |
| ZEGO_API bool ZEGO::LIVEROOM::IsVideoDecoderSupported | ( | AV::ZegoVideoCodecAvc | codecID | ) |
是否支持指定视频解码格式
| codecID | 解码ID |
| ZEGO_API int ZEGO::LIVEROOM::IsVideoDecoderSupported | ( | AV::ZegoVideoCodecAvc | codecID, |
| AV::ZegoVideoCodecBackend | codecBackend | ||
| ) |
是否支持指定视频解码格式
| codecID | 解码ID |
| codecBackend | 解码器的后端实现 |
| ZEGO_API bool ZEGO::LIVEROOM::IsVideoEncoderSupported | ( | AV::ZegoVideoCodecAvc | codecID | ) |
是否支持指定视频编码
| codecID | 编码ID |
| ZEGO_API int ZEGO::LIVEROOM::IsVideoEncoderSupported | ( | AV::ZegoVideoCodecAvc | codecID, |
| AV::ZegoVideoCodecBackend | codecBackend | ||
| ) |
是否支持指定视频编码
| codecID | 编码ID |
| codecBackend | 编码器后端实现 |
| ZEGO_API bool ZEGO::LIVEROOM::LoginRoom | ( | const char * | pszRoomID, |
| int | role, | ||
| const char * | pszRoomName = "" |
||
| ) |
登录房间
| pszRoomID | 房间 ID |
| role | 成员角色, 参见 ZegoRoomRole |
| pszRoomName | 房间名称 |
| ZEGO_API bool ZEGO::LIVEROOM::LogoutRoom | ( | const char * | pszRoomID = nullptr | ) |
退出房间
| pszRoomID | 可选，要退出的房间 ID |
| ZEGO_API int ZEGO::LIVEROOM::MuteAudioPublish | ( | bool | mute, |
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
推流时是否发送音频数据。
| mute | true 不发送，false 发送 |
| idx | 推流通道索引. 默认为主Channel |
| ZEGO_API int ZEGO::LIVEROOM::MuteVideoPublish | ( | bool | mute, |
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
推流时是否发送视频数据。
| mute | true 不发送（仅预览），false 发送 |
| idx | 推流通道索引. 默认为主Channel |
| ZEGO_API void ZEGO::LIVEROOM::RemoveDumpData | ( | ) |
删除转储数据
| ZEGO_API int ZEGO::LIVEROOM::RequestJoinLive | ( | const char * | pszRoomID = nullptr | ) |
向房间内的主播申请连麦
| pszRoomID | 房间 ID |
| ZEGO_API bool ZEGO::LIVEROOM::RequireHardwareDecoder | ( | bool | enable, |
| const char * | pszStreamID = nullptr |
||
| ) |
为指定拉流通道开启/关闭硬件解码，当 pszStreamID 为 nullptr 或者 "" 时为所有拉流道通开启/关闭硬件解码。
| enable | true 打开，false 关闭。默认 false |
| pszStreamID | 拉流 ID，当不指定时，默认作用于所有拉流通道 |
| ZEGO_API bool ZEGO::LIVEROOM::RequireHardwareEncoder | ( | bool | bRequired | ) |
开启/关闭推流硬件编码。
| bRequired | true 开启，false 关闭。默认 false |
| ZEGO_API bool ZEGO::LIVEROOM::RequireHardwareEncoderByChannel | ( | bool | enable, |
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
为某个推流道通单独开启/关闭硬件编码。
| enable | true 开启，false 关闭。如果有调用 RequireHardwareEncoder 设置，则默认为 RequireHardwareEncoder 设置的值，否则默认为 false |
| idx | 推流通道 |
| ZEGO_API void ZEGO::LIVEROOM::ResetAEC | ( | ) |
重置 AEC 到 SDK 初始状态
此函数会重置主通道 [EnableAEC] 和 [SetAECMode]
| ZEGO_API void ZEGO::LIVEROOM::ResetAGC | ( | ) |
重置 AGC 到 SDK 初始状态
此函数会重置 [EnableAGC]
| ZEGO_API void ZEGO::LIVEROOM::ResetNoiseSuppress | ( | ) |
重置 ANS 到 SDK 初始状态
此函数会重置 [EnableNoiseSuppress], [SetNoiseSuppressMode] 和 [EnableTransientNoiseSuppress]
| ZEGO_API bool ZEGO::LIVEROOM::RespondInviteJoinLiveReq | ( | int | seq, |
| int | rspResult, | ||
| const char * | pszRoomID = nullptr |
||
| ) |
回应房间内主播的连麦邀请
| seq | 回应的邀请 seq |
| rspResult | 回应，0 表示同意 |
| pszRoomID | 房间 ID |
| ZEGO_API bool ZEGO::LIVEROOM::RespondJoinLiveReq | ( | int | seq, |
| int | rspResult, | ||
| const char * | pszRoomID = nullptr |
||
| ) |
回应连麦申请
| seq | 收到的连麦申请 seq (通过 ILivePublisherCallback::OnJoinLiveRequest 收到申请) |
| rspResult | 回应，0 表示同意 |
| pszRoomID | 房间 ID |
| ZEGO_API int ZEGO::LIVEROOM::SendBigRoomMessage | ( | ROOM::ZegoMessageType | type, |
| ROOM::ZegoMessageCategory | category, | ||
| const char * | messageContent, | ||
| const char * | roomID = nullptr |
||
| ) |
发送不可靠信道消息，主要用于大并发的场景，发送一些非必须到达的消息
| type | 消息类型 |
| category | 消息分类 |
| messageContent | 消息内容, 小于 1024 字节 |
| roomID | 可选，房间 ID, 为 nullptr 时，表示往默认房间发送 |
| ZEGO_API int ZEGO::LIVEROOM::SendCustomCommand | ( | ROOM::ZegoUser * | memberList, |
| unsigned int | memberCount, | ||
| const char * | content, | ||
| const char * | roomID = nullptr |
||
| ) |
发送自定义信令
| memberList | 信令发送成员列表。如果不指定接受人，会给所有人发送消息 |
| memberCount | 成员个数 |
| content | 信令内容 |
| roomID | 可选，房间 ID |
| ZEGO_API int ZEGO::LIVEROOM::SendRealtimeSequentialData | ( | unsigned char * | userData, |
| int | dataLen, | ||
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
发送通过流传输的实时有序数据
| userData | 数据，不超过 4096 字节 |
| dataLen | 数据大小 |
| idx | 推流通道号，参见 AV::PublishChannelIndex，默认值 AV::PUBLISH_CHN_MAIN |
| ZEGO_API int ZEGO::LIVEROOM::SendRoomMessageEx | ( | ROOM::ZegoMessageType | type, |
| ROOM::ZegoMessageCategory | category, | ||
| const char * | messageContent, | ||
| const char * | roomID = nullptr |
||
| ) |
发送聊天室消息
| type | 消息类型 |
| category | 消息分类 |
| messageContent | 消息内容, 小于1024 字节 |
| roomID | 可选，房间 ID, 为 nullptr 时，表示往默认房间发送 |
| ZEGO_API int ZEGO::LIVEROOM::SendTransparentMessage | ( | ROOM::ZegoSendTransparentMessage * | message, |
| const char * | roomID = nullptr |
||
| ) |
发送透传消息
| ZegoSendTransparentMessage | 详情见消息类型 |
| roomID | 可选，房间 ID, 为 nullptr 时，表示往默认房间发送 |
| ZEGO_API void ZEGO::LIVEROOM::SetAECMode | ( | AV::ZegoAECMode | mode | ) |
回声消除模式
| mode | 回声消除模式；默认为 [AGGRESSIVE] |
| ZEGO_API void ZEGO::LIVEROOM::SetAlignedAudioAuxDataCallback | ( | AVE::OnAlignedAudioAuxCallback | callback, |
| void * | callbackContext | ||
| ) |
设置对齐后的混音数据回调
| callback | 对齐后的混音数据回调 |
| callbackContext | 上下文 |
| ZEGO_API bool ZEGO::LIVEROOM::SetAudioBitrate | ( | int | bitrate, |
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
设置音频码率
| bitrate | 码率 |
| idx | 推流 channel Index. 默认为主Channel |
| ZEGO_API void ZEGO::LIVEROOM::SetAudioCaptureShiftOnMix | ( | int | shiftMS | ) |
设置麦克风采集声音在混音过程中的偏移
| shiftMS | 偏移值，当 shiftMS 小于 0 时，混音时会延迟播放音；当 shiftMS 大于 0 时，混音时会延迟采集音。有效值范围[-500, 500]，单位毫秒，默认值 0 |
| ZEGO_API void ZEGO::LIVEROOM::SetAudioChannelCount | ( | int | count | ) |
设置所有推流通道的推流音频声道数
| count | 声道数，1 或 2，默认为 1（单声道） |
| ZEGO_API void ZEGO::LIVEROOM::SetAudioChannelCountByChannel | ( | int | count, |
| AV::PublishChannelIndex | idx | ||
| ) |
设置指定推流通道的推流音频声道数
| count | 声道数，1 或 2，默认为 1（单声道） |
| idx | 推流 channel Index. 详见 AV::PublishChannelIndex |
| ZEGO_API bool ZEGO::LIVEROOM::SetAudioDevice | ( | AV::AudioDeviceType | deviceType, |
| const char * | pszDeviceID | ||
| ) |
设置选用音频设备
| deviceType | 设备类型 |
| pszDeviceID | 设备 ID |
| ZEGO_API void ZEGO::LIVEROOM::SetAudioDeviceMode | ( | AV::ZegoAVAPIAudioDeviceMode | mode | ) |
设置音频设备模式
| mode | 模式, 默认 ZEGO_AUDIO_DEVICE_MODE_AUTO |
| ZEGO_API bool ZEGO::LIVEROOM::SetAudioEqualizerGain | ( | int | bandIndex, |
| float | bandGain | ||
| ) |
音效均衡器
| bandIndex | 取值范围[0, 9]。分别对应10个频带，其中心频率分别是[31, 62, 125, 250, 500, 1K, 2K, 4K, 8K, 16K]Hz |
| bandGain | 取值范围[-15, 15]。默认值是0，如果所有频带的增益值全部为0，则会关闭EQ功能 |
| ZEGO_API bool ZEGO::LIVEROOM::SetAudioMixMode | ( | AV::ZegoAudioMixMode | mixMode, |
| const char ** | pszStreamIDList, | ||
| int | num | ||
| ) |
设置多路混音时突出的拉流ID，当有多路流同时发声，将突出pszStreamIDList中的流
| mixMode | ZEGO_AUDIO_MIX_MODE_RAW时关闭该功能，ZEGO_AUDIO_MIX_MODE_FOCUSED时开启 |
| pszStreamIDList | 需要突出的拉流ID |
| num | 需要突出的拉流ID的数量[0, 4] |
| ZEGO_API void ZEGO::LIVEROOM::SetAudioPostpCallback | ( | AVE::OnPostpCallback | callback, |
| const AVE::ExtPostpSet & | config | ||
| ) |
设置音频后处理函数
| callback | 音频后处理函数指针 |
| config | 预处理的采样率等参数设置 |
| ZEGO_API void ZEGO::LIVEROOM::SetAudioPrepAfterLoopbackCallback | ( | AVE::OnAudioProcCallback | callback, |
| const AVE::ExtPrepSet & | config | ||
| ) |
设置音频处理函数(耳返后), 并开启/关闭音频处理特性
| callback | 音频处理函数指针 |
| config | 预处理的采样率等参数设置 |
| ZEGO_API void ZEGO::LIVEROOM::SetAudioPrepCallback | ( | AVE::OnPrepCallback | callback, |
| const AVE::ExtPrepSet & | config | ||
| ) |
设置音频前处理函数(耳返前), 并开启/关闭音频前处理特性
| callback | 音频前处理函数指针 |
| config | 预处理的采样率等参数设置 |
| ZEGO_API bool ZEGO::LIVEROOM::SetAudioRecordCallback | ( | AV::IZegoAudioRecordCallback * | pCB | ) |
设置音频录制回调，以获取录制的音频数据
| pCB | 实现了 AV::IZegoAudioRecordCallback 回调的对象指针，以获取录制的音频数据 |
| ZEGO_API bool ZEGO::LIVEROOM::SetAudioSource | ( | AV::ZegoAudioSourceType | srcType, |
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_AUX |
||
| ) |
设置采集音频源类型
| srcType | 源类型，参见 ZegoAudioSourceType 定义 |
| idx | 推流 channel Index. 默认为辅Channel |
| ZEGO_API void ZEGO::LIVEROOM::SetAudioVADStableStateCallback | ( | AV::IZegoCheckAudioVADCallback * | callback | ) |
设置检测语音状态的回调
| callback | 回调指针 |
| ZEGO_API bool ZEGO::LIVEROOM::SetAVEngineCallback | ( | IAVEngineCallback * | pCB | ) |
设置“音视频引擎状态通知”的回调
| pCB | 回调对象指针 |
| ZEGO_API void ZEGO::LIVEROOM::SetBeforeAudioPrepCallback | ( | AV::IZegoBeforeAudioPrepCallback * | callback | ) |
设置音频前处理前的音频数据回调。
| callback | 回调，详见 IZegoBeforeAudioPrepCallback。 |
| ZEGO_API bool ZEGO::LIVEROOM::SetBuiltInSpeakerOn | ( | bool | bOn | ) |
默认扬声器开关
| bOn | true 打开，false 关闭。默认 true |
| ZEGO_API bool ZEGO::LIVEROOM::SetBusinessType | ( | int | nType | ) |
设置业务类型
| nType | 业务类型，取值 0（直播类型）或 2（实时音视频类型）。默认为 0 |
| ZEGO_API bool ZEGO::LIVEROOM::SetCaptureFrameRotation | ( | int | nRotation, |
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
设置视频采集旋转角度
| nRotation | 逆时针旋转角度(0/90/180/270)。默认 0 |
| idx | 推流 channel Index. 默认为主Channel |
| ZEGO_API void ZEGO::LIVEROOM::SetCapturePipelineScaleMode | ( | AV::ZegoCapturePipelineScaleMode | mode | ) |
设置视频采集缩放时机
| mode | 视频采集缩放时机，请参考 AV::ZegoCapturePipelineScaleMode 定义。默认为 ZegoCapturePipelinePreScale @discussion 初始化 SDK 后，StartPreview, StartPublish 前调用。摄像头启动之后设置不会立即生效，而是在下次摄像头启动时生效。 |
| ZEGO_API void ZEGO::LIVEROOM::SetCaptureVolume | ( | int | volume | ) |
设置采集音量
| volume | 音量大小，取值范围 [0, 200], 默认 100 |
| ZEGO_API void ZEGO::LIVEROOM::SetCDNPublishTarget | ( | const char * | pszCDNPublishTarget, |
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
单主播模式下，自定义直推CDN的地址
| pszCDNPublishTarget | 目的 rtmp 推流地址 |
| idx | 推流 channel Index. 默认为主Channel |
| ZEGO_API void ZEGO::LIVEROOM::SetChannelExtraParam | ( | const char * | param_config, |
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
给推流通道设置扩展参数，一般不建议修改
| param_config | 参数配置信息 |
| idx | 推流通道索引，默认主通道 |
| ZEGO_API void ZEGO::LIVEROOM::SetCloudProxyConfig | ( | const AV::ZegoProxyInfo * | proxy, |
| int | proxyCount, | ||
| bool | enable, | ||
| const char * | token = nullptr |
||
| ) |
设置云代理信息
| ZEGO_API void ZEGO::LIVEROOM::SetConfig | ( | const char * | config | ) |
设置配置信息
| config | config 配置信息 |
| ZEGO_API bool ZEGO::LIVEROOM::SetCustomCDNPublishTarget | ( | const AV::ZegoCDNPublishTarget | target, |
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
单主播模式下，自定义直推CDN的地址
| target | 推流地址信息 |
| idx | 推流 channel Index. 默认为主Channel |
| ZEGO_API void ZEGO::LIVEROOM::SetCustomPublishTarget | ( | const char * | pszCustomPublishTarget, |
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
自定义转推目的地
| pszCustomPublishTarget | 目的 rmtp 推流地址 |
| idx | 推流 channel Index. 默认为主Channel |
| ZEGO_API bool ZEGO::LIVEROOM::SetCustomToken | ( | const char * | thirdPartyToken | ) |
设置房间的自定义token信息
| thirdPartyToken | 第三方传入的token |
| ZEGO_API bool ZEGO::LIVEROOM::SetDataCacheDir | ( | const char * | cache_dir | ) |
设置数据缓存目录，用于存储 SDK 需要缓存的数据文件
| cache_dir | 数据缓存目录 |
| ZEGO_API void ZEGO::LIVEROOM::SetDeviceStateCallback | ( | AV::IZegoDeviceStateCallback * | pCB | ) |
设置音频视频设备变化的回调
| pCB | 回调对象指针 |
| ZEGO_API void ZEGO::LIVEROOM::SetDummyCaptureImagePath | ( | const char * | filePath, |
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
设置关闭摄像头时所推静态图片的路径
| filePath | 图片路径 |
| idx | 推流 channel Index. 默认为主Channel |
| ZEGO_API void ZEGO::LIVEROOM::SetDumpDataCallback | ( | AV::IZegoDumpDataCallback * | callback | ) |
设置转储数据的回调
| callback | 回调指针 |
| ZEGO_API void ZEGO::LIVEROOM::SetExperimentalAPICallback | ( | ExperimentalAPICallback | callback | ) |
设置试验性API回调函数
| callback | 试验性API回调函数指针 |
| ZEGO_API bool ZEGO::LIVEROOM::SetFilter | ( | int | nIndex, |
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
设置滤镜
| nIndex | 滤镜索引。默认不使用滤镜 |
| idx | 推流 channel Index. 默认为主Channel |
| ZEGO_API bool ZEGO::LIVEROOM::SetGeoFence | ( | enum AV::ZegoGeoFenceType | type, |
| const int * | area_code_list, | ||
| int | area_code_list_count | ||
| ) |
设置地理围栏
| type | 设置指定区域是允许还是排除 |
| area_code_list | 区域列表，参考 ZegoGeoFenceAreaCode |
| area_code_list_count | 区域列表个数 |
| ZEGO_API bool ZEGO::LIVEROOM::SetIMCallback | ( | IIMCallback * | pCB | ) |
设置 IM 信息通知的回调对象
| pCB | 回调对象指针 |
| ZEGO_API void ZEGO::LIVEROOM::SetLatencyMode | ( | AV::ZegoAVAPILatencyMode | mode | ) |
设置所有推流通道的延迟模式
| mode | 延迟模式，默认 ZEGO_LATENCY_MODE_NORMAL |
| ZEGO_API void ZEGO::LIVEROOM::SetLatencyModeByChannel | ( | AV::ZegoAVAPILatencyMode | mode, |
| AV::PublishChannelIndex | idx | ||
| ) |
设置指定推流通道的延迟模式
| mode | 延迟模式，默认 ZEGO_LATENCY_MODE_NORMAL |
| idx | 推流 channel Index. 详见 AV::PublishChannelIndex |
| ZEGO_API void ZEGO::LIVEROOM::SetLicense | ( | const char * | license | ) |
设置 license 鉴权
| license | license 信息 |
| ZEGO_API void ZEGO::LIVEROOM::SetLiveEventCallback | ( | AV::IZegoLiveEventCallback * | pCB | ) |
设置直播事件回调
| pCB | 回调对象指针 |
| ZEGO_API bool ZEGO::LIVEROOM::SetLivePlayerCallback | ( | ILivePlayerCallback * | pCB | ) |
设置直播观众相关信息通知的回调，以接收拉流事件回调
| pCB | 实现了 ILivePlayerCallback 回调的对象指针，以接收拉流事件 |
| ZEGO_API bool ZEGO::LIVEROOM::SetLivePublisherCallback | ( | ILivePublisherCallback * | pCB | ) |
设置直播主播相关信息通知的回调
| pCB | 回调对象指针 |
| ZEGO_API void ZEGO::LIVEROOM::SetLocalProxyConfig | ( | const AV::ZegoProxyInfo * | proxy, |
| int | proxyCount, | ||
| bool | enable | ||
| ) |
设置本地代理信息
| ZEGO_API bool ZEGO::LIVEROOM::SetLogDirAndSize | ( | const char * | pszLogDir, |
| unsigned long long | lLogFileSize = ZEGO_DEFAULT_LOG_SIZE, |
||
| const char * | pszSubFolder = nullptr, |
||
| unsigned int | log_file_count = 3 |
||
| ) |
设置日志路径和大小
| pszLogDir | 日志路径 |
| lLogFileSize | 单个日志文件大小, 有效范围[1*1024 * 1024, 100*1024*1024], 默认 5*1024*1024 字节。当设置为 0 时，不写日志（不推荐，当 SDK 出问题时无法定位原因） |
| pszSubFolder | 日志子目录，如果指定了子目录，则日志文件会存放在此子目录下 |
| log_file_count | 日志文件个数，默认是 3 个 |
| ZEGO_API void ZEGO::LIVEROOM::SetLogHook | ( | void(*)(const char *message) | log_hook | ) |
日志hook 的回调函数
| logHook | 日志的回调函数 建议外部static 函数。 |
| ZEGO_API void ZEGO::LIVEROOM::SetLoopbackVolume | ( | int | volume | ) |
设置监听音量
| volume | 音量大小，取值范围 [0, 200], 默认 60 |
| ZEGO_API bool ZEGO::LIVEROOM::SetLowlightEnhancement | ( | AV::ZegoLowlightEnhanceMode | mode, |
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
设置低照度增强
| mode | 低照度增强模式。 |
| idx | 推流 channel Index。 |
| ZEGO_API void ZEGO::LIVEROOM::SetMinVideoBitrateForTrafficControl | ( | int | nBitrate, |
| AV::ZegoTrafficControlMinVideoBitrateMode | mode = AV::ZEGO_TRAFFIC_CONTROL_MIN_VIDEO_BITRATE_NO_VIDEO, |
||
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
设置推流视频码率达不到最小阈值时的控制策略
| nBitrate | 视频码率最小阈值，单位为bps。 |
| mode | 低于视频码率最小阈值时的视频发送模式。当网络情况较差，无法发送该最小码率的数据时，如果选择 ZEGO_TRAFFIC_CONTROL_MIN_VIDEO_BITRATE_NO_VIDEO 模式，视频会被暂停，而不是以低于该码率继续发送。如果选择 ZEGO_TRAFFIC_CONTROL_MIN_VIDEO_BITRATE_ULTRA_LOW_FPS 模式，视频会以超低帧率发送。 |
| idx | 推流通道，参考 AV::PublishChannelIndex 定义。默认 AV::PUBLISH_CHN_MAIN。 |
| ZEGOAVKIT_API void ZEGO::LIVEROOM::SetMinVideoFpsForTrafficControl | ( | int | nFps, |
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
设置推流视频帧率达不到最小阈值时的控制策略
| [in] | nFps | 视频帧率最小阈值，单位为fps。 |
| [in] | idx | 推流通道，参考 AV::PublishChannelIndex 定义。默认 AV::PUBLISH_CHN_MAIN。 |
| ZEGOAVKIT_API void ZEGO::LIVEROOM::SetMinVideoResolutionForTrafficControl | ( | int | nWidth, |
| int | nHeight, | ||
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
设置推流视频分辨率达不到最小阈值时的控制策略
| [in] | nWidth | 视频分辨率宽的最小阈值。 |
| [in] | nHeight | 视频分辨率高的最小阈值。 |
| [in] | idx | 推流通道，参考 AV::PublishChannelIndex 定义。默认 AV::PUBLISH_CHN_MAIN。 |
| ZEGO_API void ZEGO::LIVEROOM::SetNetTypeCallback | ( | AV::IZegoNetTypeCallback * | pCB | ) |
设置网络类型回调
| pCB | 回调对象指针 |
| ZEGO_API bool ZEGO::LIVEROOM::SetNoiseSuppressMode | ( | AV::ZegoANSMode | mode | ) |
设置音频采集降噪等级
| mode | 降噪等级，详见 ZegoANSMode 定义，默认为 [MEDIUM] |
| ZEGO_API bool ZEGO::LIVEROOM::SetPlayQualityMonitorCycle | ( | unsigned int | timeInMS | ) |
设置拉流质量监控周期
| timeInMS | 时间周期，单位为毫秒，取值范围为(500, 60000)。默认为 3000 |
| ZEGO_API bool ZEGO::LIVEROOM::SetPlayStreamFocus | ( | const char * | streamID | ) |
设置拉流优先级的权重，被置为 focus 的流，优先保证其质量。
| streamID | 流 ID，当为 null 时，恢复初始状态，所有流的权重相同。 |
| ZEGO_API int ZEGO::LIVEROOM::SetPlayStreamsAlignmentProperty | ( | int | alignment | ) |
设置拉流是否校准网络时间，用于有对齐属性的各路流进行时间对齐
| alignment | 1 开启，0 关闭 |
| ZEGO_API bool ZEGO::LIVEROOM::SetPlayVolume | ( | int | volume, |
| const char * | pszStreamID = 0 |
||
| ) |
设置拉流的播放音量
| volume | 音量大小, 取值范围[0, 200], 默认 100 |
| pszStreamID | 需要设置播放音量的流 ID , 传入 nullptr 表示统一设置所有拉流的播放音量 |
| ZEGO_API bool ZEGO::LIVEROOM::SetPolishFactor | ( | float | factor, |
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
设置美颜采样颜色阈值
| factor | 采样颜色阈值，取值范围[0,16]。默认 4.0 |
| idx | 推流 channel Index. 默认为主Channel |
| ZEGO_API bool ZEGO::LIVEROOM::SetPolishStep | ( | float | step, |
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
设置美颜磨皮的采样步长
| step | 采样步长，取值范围[1,16]。默认 4.0 |
| idx | 推流 channel Index. 默认为主Channel |
| ZEGO_API bool ZEGO::LIVEROOM::SetPreviewRotation | ( | int | nRotation, |
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
设置预览渲染朝向
| nRotation | 旋转角度(0/90/180/270)。默认 0 |
| idx | 推流 channel Index. 默认为主Channel |
| ZEGO_API bool ZEGO::LIVEROOM::SetPreviewView | ( | const AV::ZegoView & | view, |
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
设置本地预览视图
| view | 用于渲染本地预览视频的视图 |
| idx | 推流 channel Index. 默认为主Channel |
| ZEGO_API bool ZEGO::LIVEROOM::SetPreviewView | ( | void * | pView, |
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
设置本地预览视图
| pView | 用于渲染本地预览视频的视图 |
| idx | 推流 channel Index. 默认为主Channel |
| ZEGO_API bool ZEGO::LIVEROOM::SetPreviewViewBackgroundColor | ( | int | color, |
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
设置预览视频控件的背景颜色
| color | 颜色,取值为0x00RRGGBB |
| idx | 推流 channel Index. 默认为主Channel |
| ZEGO_API bool ZEGO::LIVEROOM::SetPreviewViewMode | ( | ZegoVideoViewMode | mode, |
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
设置本地预览视频视图的模式
| mode | 模式 |
| idx | 推流 channel Index. 默认为主Channel |
| ZEGO_API void ZEGO::LIVEROOM::SetPreviewWaterMarkRect | ( | int | left, |
| int | top, | ||
| int | right, | ||
| int | bottom, | ||
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
设置水印在预览视频中的位置
| left | 左上角坐标的第一个元素 |
| top | 左上角坐标的第二个元素，即左上角坐标为 (left, top) |
| right | 右下角坐标的第一个元素 |
| bottom | 右下角坐标的第二个元素，即右下角坐标为 (right, bottom) |
| idx | 推流 channel Index. 默认为主Channel |
| ZEGO_API void ZEGO::LIVEROOM::SetPublishDualStreamConfig | ( | const AV::ZegoPublishDualStreamConfig * | configList, |
| int | configListCount, | ||
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
设置大小流编码配置
| configList | 配置列表 |
| ZEGO_API void ZEGO::LIVEROOM::SetPublishEncryptKey | ( | const unsigned char * | pKey, |
| int | nkeyLen, | ||
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
设置推流加密密钥
| pszKey | 加密密钥 |
| nkeyLen | 密钥长度（支持16/24/32字节） |
| idx | 推流 channel Index. 默认为主Channel |
| ZEGO_API bool ZEGO::LIVEROOM::SetPublishQualityMonitorCycle | ( | unsigned int | timeInMS | ) |
设置推流质量监控周期
| timeInMS | 时间周期，单位为毫秒，取值范围为(500, 60000)。默认为 3000 |
| ZEGO_API bool ZEGO::LIVEROOM::SetPublishStreamExtraInfo | ( | const char * | pszStreamExtraInfo, |
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
设置或更新推流的附加信息
| pszStreamExtraInfo | 流附加信息, 最大为 1024 字节 |
| idx | 推流 channel Index. 默认为主Channel |
| ZEGO_API void ZEGO::LIVEROOM::SetPublishWaterMarkRect | ( | int | left, |
| int | top, | ||
| int | right, | ||
| int | bottom, | ||
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
设置水印在采集视频中的位置
| left | 左上角坐标的第一个元素 |
| top | 左上角坐标的第二个元素，即左上角坐标为 (left, top) |
| right | 右下角坐标的第一个元素 |
| bottom | 右下角坐标的第二个元素，即右下角坐标为 (right, bottom) |
| idx | 推流 channel Index. 默认为主Channel |
| ZEGO_API void ZEGO::LIVEROOM::SetRealtimeSequentialDataCallback | ( | AV::IZegoRealtimeSequentialDataCallback * | callback | ) |
设置实时有序数据回调
| callback | 回调接口，详见 AV::IZegoRealtimeSequentialDataCallback 类。 |
| ZEGO_API bool ZEGO::LIVEROOM::SetRecvBufferLevelLimit | ( | int | minBufferLevel, |
| int | maxBufferLevel, | ||
| const char * | streamID | ||
| ) |
设置拉流播放缓存自适应调整的区间范围（上下限）
| minBufferLevel | 缓存自适应区间下限, 单位毫秒. 当 minBufferLevel <= 0 表示未设置下限. |
| maxBufferLevel | 缓存自适应区间上限, 单位毫秒. 当 maxBufferLevel <= 0 表示未设置上限. 当设置的上限超过4000时，会取值4000. |
| streamID | 流 ID |
| ZEGO_API bool ZEGO::LIVEROOM::SetRoomCallback | ( | IRoomCallback * | pCB | ) |
设置直播房间相关信息通知的回调
| pCB | 回调对象指针 |
| ZEGO_API bool ZEGO::LIVEROOM::SetRoomConfig | ( | bool | audienceCreateRoom, |
| bool | userStateUpdate, | ||
| const char * | pszRoomID = nullptr |
||
| ) |
设置房间配置信息
| audienceCreateRoom | 观众是否可以创建房间。true 可以，false 不可以。默认 true |
| userStateUpdate | 用户状态（用户进入、退出房间）是否广播。true 广播，false 不广播。默认 false |
| pszRoomID | 房间 ID。 |
| ZEGO_API int ZEGO::LIVEROOM::SetRoomExtraInfo | ( | const char * | pszKey, |
| const char * | pszValue, | ||
| const char * | pszRoomID = nullptr |
||
| ) |
更新房间属性 登录房间成功后使用
| pszKey | 房间额外信息key值，不能超过 10字节, 不允许为空字符串, 一个房间内只允许1个消息类型 |
| pszValue | 房间属性内容，不能超过 128 字节, 允许为空字符串 |
| pszRoomID | 可选，房间 ID, 为 nullptr 时，表示往默认房间发送 |
| ZEGO_API bool ZEGO::LIVEROOM::SetRoomExtraInfoCallback | ( | IRoomExtraInfoCallback * | pCB | ) |
设置 RoomExtraInfo 通知的回调
| pCB | 回调对象指针 |
| ZEGO_API bool ZEGO::LIVEROOM::SetRoomMaxUserCount | ( | unsigned int | maxCount, |
| const char * | pszRoomID = nullptr |
||
| ) |
设置房间最大在线人数
| maxCount | 最大人数 |
| pszRoomID | 房间 ID。 |
| ZEGO_API bool ZEGO::LIVEROOM::SetRoomMode | ( | ZegoRoomMode | mode | ) |
设置房间模式
| mode | 房间模式, 详见 ZegoRoomMode 定义，默认是单房间模式 |
| ZEGO_API void ZEGO::LIVEROOM::SetRunLoopObserveCallback | ( | void(*)(unsigned int taskId, AV::ZegoTaskType type, int taskDispatchTime, int taskRunTime, int taskTotalTime) | OnRunLoopObserveCallback | ) |
设置SDK线程回调observe，将会回调SDK 主线程执行相关耗时 建议 外部static 函数
| OnRunLoopObserveCallback | observe回调的callback |
| taskId | sdk主线程taskid |
| type | 任务类型 参见ZegoTaskType |
| taskDispatchTime | 任务调度消耗时间 单位ms |
| taskRunTime | 任务执行消耗时间 单位ms |
| taskTotalTime | 任务总耗时，单位ms 一般情况只需关注此时间即可 |
| ZEGO_API bool ZEGO::LIVEROOM::SetSharpenFactor | ( | float | factor, |
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
设置锐化参数
| factor | 锐化参数，取值范围[0,2]，值越大锐化越强。默认 0.2 |
| idx | 推流 channel Index. 默认为主Channel |
| ZEGO_API int ZEGO::LIVEROOM::SetStreamAlignmentProperty | ( | int | alignment, |
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
为某个推流道通单独指定推流是否校准网络时间，用于混流时各路流的对齐
| alignment | 1设置，0 关闭 |
| idx | 推流通道索引，默认主通道 |
| ZEGO_API bool ZEGO::LIVEROOM::SetThirdPartyFrameworkInfo | ( | const char * | framework_info | ) |
设置第三方框架信息
| framework_info | 框架信息，不超过 256 字节 |
| ZEGO_API bool ZEGO::LIVEROOM::SetToken | ( | const char * | pszToken, |
| const char * | pszRoomID | ||
| ) |
设置房间的鉴权 token
| pszToken | 鉴权 token |
| pszRoomID | 房间 ID |
| ZEGO_API void ZEGO::LIVEROOM::SetTrafficControlFocusOn | ( | enum AV::ZegoTrafficControlFocusOn | focusOn, |
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
设置触发流量控制的关注因素
| focusOn | 触发流量控制的关注因素。选择 ZEGO_TRAFFIC_CONTROL_FOCUS_ON_LOCAL_ONLY 时，只关注本地网络状况。选择 ZEGO_TRAFFIC_CONTROL_FOCUS_ON_REMOTE 时，不仅关注本地网络，同时也兼顾远端网络，目前只在 1v1 场景下有效。 |
| idx | 推流通道，参考 AV::PublishChannelIndex 定义。默认 AV::PUBLISH_CHN_MAIN。 |
| ZEGO_API bool ZEGO::LIVEROOM::SetUser | ( | const char * | pszUserID, |
| const char * | pszUserName | ||
| ) |
设置用户信息
| pszUserID | 用户唯一 ID |
| pszUserName | 用户名字 |
| ZEGO_API void ZEGO::LIVEROOM::SetUseTestEnv | ( | bool | bTestEnv | ) |
设置是否使用测试环境
| bTestEnv | 测试环境 |
| ZEGO_API void ZEGO::LIVEROOM::SetVerbose | ( | bool | bVerbose | ) |
设置是否开启调试信息
| bVerbose | 控制开关 |
| ZEGO_API bool ZEGO::LIVEROOM::SetVideoBitrate | ( | int | nBitrate, |
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
设置视频码率
| nBitrate | 码率，单位为bps |
| idx | 推流 channel Index. 默认为主Channel |
| ZEGO_API bool ZEGO::LIVEROOM::SetVideoCaptureResolution | ( | int | nWidth, |
| int | nHeight, | ||
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
设置视频采集分辨率
| nWidth | 宽 |
| nHeight | 高 |
| idx | 推流 channel Index. 默认为主Channel |
| ZEGO_API bool ZEGO::LIVEROOM::SetVideoCodecId | ( | AV::ZegoVideoCodecAvc | codecId, |
| AV::PublishChannelIndex | nChannel = AV::PUBLISH_CHN_MAIN |
||
| ) |
设置选用编码格式
| codecId | 编码 ID |
| ZEGO_API bool ZEGO::LIVEROOM::SetVideoDevice | ( | const char * | pszDeviceID, |
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
设置选用视频设备
| pszDeviceID | 设备 ID |
| ZEGO_API void ZEGO::LIVEROOM::SetVideoEncodeMode | ( | AV::ZegoVideoEncodeMode | mode, |
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
设置视频编码模式
| mode | 视频编码模式，详见 AV::ZegoVideoEncodeMode。默认是 AV::ZEGO_VIDEO_ENCODE_MODE_LOW_DELAY。 |
| idx | 推流通道，默认为 AV::PUBLISH_CHN_MAIN |
| ZEGO_API bool ZEGO::LIVEROOM::SetVideoEncodeResolution | ( | int | nWidth, |
| int | nHeight, | ||
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
设置视频编码输出分辨率
| nWidth | 宽 |
| nHeight | 高 |
| idx | 推流 channel Index. 默认为主Channel |
| ZEGO_API void ZEGO::LIVEROOM::SetVideoEncoderRateControlConfig | ( | AV::ZegoVideoEncoderRateControlStrategy | strategy, |
| int | encoderCRF, | ||
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
设置编码器码率控制策略
| strategy | 策略配置，参考 ZegoVideoEncoderRateControlStrategy |
| encoderCRF | 当策略为恒定质量（ZEGO_RC_VBR/ZEGO_RC_CRF）有效，取值范围 [0~51]，越小质量越好，但是码率会相应变大。建议取值范围 [18, 28] |
| idx | 推流 channel Index. 默认为主Channel |
| ZEGO_API bool ZEGO::LIVEROOM::SetVideoFPS | ( | int | nFps, |
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
设置视频帧率
| nFps | 帧率 |
| idx | 推流 channel Index. 默认为主Channel |
| ZEGO_API bool ZEGO::LIVEROOM::SetVideoKeyFrameInterval | ( | int | nIntervalSecond, |
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
设置视频关键帧间隔
| nIntervalSecond | 关键帧间隔，单位为秒，默认2秒 |
| idx | 推流 channel Index. 默认为主Channel |
| ZEGO_API bool ZEGO::LIVEROOM::SetVideoMirrorMode | ( | AV::ZegoVideoMirrorMode | mode, |
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
是否启用预览和推流镜像
| mode | 镜像模式 |
| idx | 推流 channel Index. 默认为主Channel |
| ZEGO_API bool ZEGO::LIVEROOM::SetVideoSource | ( | AV::ZegoVideoSourceType | srcType, |
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_AUX |
||
| ) |
设置采集视频源类型
| srcType | 源类型，参见 ZegoVideoSourceType 定义 |
| idx | 推流 channel Index. 默认为辅Channel |
| ZEGO_API bool ZEGO::LIVEROOM::SetVideoSource | ( | AV::ZegoVideoSourceType | srcType, |
| unsigned int | instanceID, | ||
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_AUX |
||
| ) |
设置采集视频源类型
| srcType | 源类型，参见 ZegoVideoSourceType 定义 |
| instanceID | 使用媒体播放器或屏幕共享采集源时，所使用的媒体播放器或屏幕共享实例 ID |
| idx | 推流 channel Index. 默认为辅Channel |
| ZEGO_API bool ZEGO::LIVEROOM::SetViewBackgroundColor | ( | int | color, |
| const char * | pszStreamID | ||
| ) |
设置视频控件的背景颜色
| color | 颜色,取值为0x00RRGGBB |
| pszStreamID | 播放流 ID |
| ZEGO_API bool ZEGO::LIVEROOM::SetViewMode | ( | ZegoVideoViewMode | mode, |
| const char * | pszStreamID | ||
| ) |
设置观看直播的 View 的模式
| mode | 模式，默认 ZegoVideoViewModeScaleAspectFit |
| pszStreamID | 播放流 ID |
| ZEGO_API bool ZEGO::LIVEROOM::SetViewRotation | ( | int | nRotation, |
| const char * | pszStreamID | ||
| ) |
设置播放渲染朝向
| nRotation | 逆时针旋转角度(0/90/180/270)。默认 0 |
| pszStreamID | 播放流 ID |
| ZEGO_API void ZEGO::LIVEROOM::SetWaterMarkImagePath | ( | const char * | filePath, |
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
设置水印的图片路径
| filePath | 图片路径 |
| idx | 推流 channel Index. 默认为主Channel |
| ZEGO_API bool ZEGO::LIVEROOM::SetWhitenFactor | ( | float | factor, |
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
设置美颜美白的亮度修正参数
| factor | 亮度修正参数，取值范围[0,1]，值越大亮度越暗。默认 0.5 |
| idx | 推流 channel Index. 默认为主Channel |
| ZEGO_API void ZEGO::LIVEROOM::StartDumpData | ( | AV::ZegoDumpDataConfig | config | ) |
开始转储数据
| config | 转储数据配置 |
| ZEGO_API bool ZEGO::LIVEROOM::StartPlayingStream | ( | const char * | pszStreamID, |
| void * | pView, | ||
| const char * | pszParams = 0 |
||
| ) |
播放多媒体流
| pszStreamID | 需要播放的用户流 ID |
| pView | 用来渲染播放视频的视图，设置为空时不显示视频，只播放音频 |
| pszParams | 拉流参数 |
| ZEGO_API bool ZEGO::LIVEROOM::StartPlayingStream2 | ( | const char * | pszStreamID, |
| const AV::ZegoView & | pView, | ||
| ZegoStreamExtraPlayInfo * | info = nullptr |
||
| ) |
根据用户配置的多媒体流附加信息，播放多媒体流
| pszStreamID | 需要播放的用户流 ID |
| pView | 用来渲染播放视频的视图，设置为空时不显示视频，只播放音频 |
| info | 多媒体流附加信息，请参考 ZegoStreamExtraPlayInfo 定义 |
| ZEGO_API bool ZEGO::LIVEROOM::StartPlayingStream2 | ( | const char * | pszStreamID, |
| void * | pView, | ||
| ZegoStreamExtraPlayInfo * | info = nullptr |
||
| ) |
根据用户配置的多媒体流附加信息，播放多媒体流
| pszStreamID | 需要播放的用户流 ID |
| pView | 用来渲染播放视频的视图，设置为空时不显示视频，只播放音频 |
| info | 多媒体流附加信息，请参考 ZegoStreamExtraPlayInfo 定义 |
| ZEGO_API bool ZEGO::LIVEROOM::StartPlayingStreamWithParams | ( | const ZegoPlayStreamParams * | playParams | ) |
根据用户配置的多媒体流附加信息，播放多媒体流
| playParams | 拉流参数 |
| ZEGO_API bool ZEGO::LIVEROOM::StartPreview | ( | AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN | ) |
启动本地预览
| idx | 推流 channel Index. 默认为主Channel |
| ZEGO_API bool ZEGO::LIVEROOM::StartPublishing | ( | const char * | pszTitle, |
| const char * | pszStreamID, | ||
| int | flag, | ||
| const char * | pszParams = 0 |
||
| ) |
开始直播
| pszTitle | 直播名称 |
| pszStreamID | 流 ID |
| flag | 直播属性，参考 ZegoPublishFlag |
| pszParams | 推流参数 |
| ZEGO_API bool ZEGO::LIVEROOM::StartPublishing2 | ( | const char * | pszTitle, |
| const char * | pszStreamID, | ||
| int | flag, | ||
| const char * | pszParams = 0, |
||
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
开始直播
| pszTitle | 直播名称 |
| pszStreamID | 流 ID |
| flag | 直播属性，参考 ZegoPublishFlag |
| pszParams | 推流参数 |
| idx | 推流 channel Index. 默认为主Channel |
| ZEGO_API bool ZEGO::LIVEROOM::StartPublishingWithParams | ( | const ZegoPublishStreamParams * | streamParams | ) |
开始直播
| streamParams | 推流参数 |
| ZEGO_API void ZEGO::LIVEROOM::StopDumpData | ( | ) |
结束转储数据
| ZEGO_API bool ZEGO::LIVEROOM::StopPlayingStream | ( | const char * | pszStreamID | ) |
停止播放流
| pszStreamID | 需要停止播放的用户流 ID |
| ZEGO_API bool ZEGO::LIVEROOM::StopPreview | ( | AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN | ) |
结束本地预览
| idx | 推流 channel Index. 默认为主Channel |
| ZEGO_API bool ZEGO::LIVEROOM::StopPublishing | ( | int | flag = 0, |
| const char * | pszMsg = 0, |
||
| AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN |
||
| ) |
停止直播
| flag | 保留字段 |
| pszMsg | 自定义信息，server 对接流结束回调包含此字段内容 |
| idx | 推流 channel Index. 默认为主Channel |
| ZEGO_API bool ZEGO::LIVEROOM::SwitchRoom | ( | const char * | fromRoomID, |
| const char * | toRoomID, | ||
| int | role, | ||
| const char * | toRoomName = "" |
||
| ) |
切换房间
| fromRoomID | 要退出的房间 ID |
| toRoomID | 要登录的房间 ID |
| role | 要登录房间的成员角色, 参见 ZegoRoomRole |
| toRoomName | 要登录房间的房间名称 |
| ZEGO_API bool ZEGO::LIVEROOM::SwitchRoom | ( | const char * | pszRoomID, |
| int | role, | ||
| const char * | pszRoomName = "" |
||
| ) |
切换房间
| pszRoomID | 房间 ID |
| role | 成员角色, 参见 ZegoRoomRole |
| pszRoomName | 房间名称 |
| ZEGO_API bool ZEGO::LIVEROOM::TakeSnapshot | ( | const char * | pszStreamID | ) |
对观看直播视图进行截图
| pszStreamID | 需要截图的流 ID |
| ZEGO_API bool ZEGO::LIVEROOM::TakeSnapshotPreview | ( | AV::PublishChannelIndex | idx = AV::PUBLISH_CHN_MAIN | ) |
截预览图
| idx | 推流 channel Index. 默认为主Channel |
| ZEGO_API bool ZEGO::LIVEROOM::UnInitSDK | ( | ) |
反初始化 SDK
| ZEGO_API void ZEGO::LIVEROOM::UpdatePlayDecryptKey | ( | const char * | pszStreamID, |
| const unsigned char * | pKey, | ||
| int | nkeyLen | ||
| ) |
设置拉流解密密钥（只用于拉流之后更新密钥）
| pszStreamID | 需要设置密钥的用户流 ID |
| pszKey | 解密密钥 |
| nkeyLen | 密钥长度（支持16/24/32字节） |
| ZEGO_API bool ZEGO::LIVEROOM::UpdatePlayToken | ( | const char * | pszStreamID, |
| const unsigned char * | token, | ||
| int | tokenlen | ||
| ) |
StartPlayingStream2 或 StartPlayingStreamWithParams 设置的Token即将过期，调用该 API 变更。
| pszStreamID | 需要更新 Token 的流 ID |
| token | 设置的 Token |
| tokenlen | Token 的长度 |
| ZEGO_API bool ZEGO::LIVEROOM::UpdatePlayView | ( | const AV::ZegoView & | view, |
| const char * | streamID | ||
| ) |
更新播放视图
| view | 播放视图，设置为空时不显示视频，只播放音频 |
| streamID | 需要更新视图的用户流 ID |
| ZEGO_API bool ZEGO::LIVEROOM::UpdatePlayView | ( | void * | pView, |
| const char * | pszStreamID | ||
| ) |
更新播放视图
| pView | 播放视图，设置为空时不显示视频，只播放音频 |
| pszStreamID | 需要更新视图的用户流 ID |
| ZEGO_API void ZEGO::LIVEROOM::UploadLog | ( | ) |
上传日志
| const int ZEGO::LIVEROOM::kInvalidSeq = -1 |
|
extern |
|
extern |
1.9.2