ZegoLiveRoom
Classes | Functions
ZEGO::MIXSTREAM Namespace Reference

Classes

class  IZegoMixStreamCallback
 
class  IZegoMixStreamExCallback
 
class  IZegoSoundLevelInMixedStreamCallback
 
struct  ZegoMixStreamConfig
 
struct  ZegoMixStreamInput
 
struct  ZegoMixStreamOutput
 
struct  ZegoMixStreamWatermark
 

Functions

ZEGOAVKIT_API bool SetMixStreamCallback (IZegoMixStreamCallback *pCB)
 
ZEGOAVKIT_API bool MixStream (const AV::ZegoCompleteMixStreamConfig &config, int seq)
 
ZEGOAVKIT_API bool SetMixStreamExCallback (IZegoMixStreamExCallback *pCB)
 
ZEGOAVKIT_API int MixStreamEx (const char *mixStreamID, const ZegoMixStreamConfig &config)
 
ZEGOAVKIT_API bool SetSoundLevelInMixedStreamCallback (IZegoSoundLevelInMixedStreamCallback *pCB)
 

Function Documentation

◆ MixStream()

ZEGOAVKIT_API bool ZEGO::MIXSTREAM::MixStream ( const AV::ZegoCompleteMixStreamConfig config,
int  seq 
)

混流接口,支持混流单路输出

Warning
Deprecated, 请使用 MixStreamEx 代替
Parameters
seq请求序号,回调会带回次 seq
Returns
true 成功,等待回调,false 失败
Note
每次需要更新混流配置时,都可以调用此接口;如果需要多次调用,可以通过传入不同的 seq 区分回调

◆ MixStreamEx()

ZEGOAVKIT_API int ZEGO::MIXSTREAM::MixStreamEx ( const char *  mixStreamID,
const ZegoMixStreamConfig config 
)

混流接口,支持输出单路或者多路混流。

Parameters
mixStreamID混流任务ID
config混流配置信息,详细配置信息请查看 ZegoMixStreamConfig。
Returns
大于 0 表示调用成功,且返回值为调用序号(seq),用以区分 OnMixStreamEx 回调;小于等于 0 表示调用失败。
Note
1. 混流任务ID,表示混流任务的唯一ID,调用方应该保证 mixStreamID 的唯一性。如果 mixStreamID 相同,服务端就认为是更新同一个混流。
  1. 此 API 既是开始混流、更新混流接口,也是停止混流接口。

3.需要停止混流时,将 ZegoMixStreamConfig 参数中的 pInputStreamList 置为空列表(即清空输入流列表),将 mixStreamID 参数设置为和开始或更新混流的一致。

  1. 当混流信息变更(例如:混流的输入流列表发生增减、调整混流视频的输出码率等)时,需要调用此接口更新 ZEGO 混流服务器上的混流配置信息,且注意每次调用时此 API 的 mixStreamID 参数需保证一致。
  2. 如果需要启动多个不同的混流,可以传入不同的 mixStreamID,通过返回的 seq 来区分接收的 -OnMixStreamEx 回调。

◆ SetMixStreamCallback()

ZEGOAVKIT_API bool ZEGO::MIXSTREAM::SetMixStreamCallback ( IZegoMixStreamCallback pCB)

设置对应 MixStream 的回调

Warning
Deprecated, 请使用 SetMixStreamExCallback 代替

◆ SetMixStreamExCallback()

ZEGOAVKIT_API bool ZEGO::MIXSTREAM::SetMixStreamExCallback ( IZegoMixStreamExCallback pCB)

设置接收混流配置更新结果的回调监听,对应于 MixStreamEx 接口的回调监听。

Parameters
pCB实现了 IZegoMixStreamExCallback 回调的方法,用于混流时接收混流请求结果及配置更新信息。
Note
若不再需要接收混流配置更新信息,调用 SetMixStreamExCallback(null) 去除回调监听。
See also
相关接口请查看 MixStreamEx

◆ SetSoundLevelInMixedStreamCallback()

ZEGOAVKIT_API bool ZEGO::MIXSTREAM::SetSoundLevelInMixedStreamCallback ( IZegoSoundLevelInMixedStreamCallback pCB)

设置拉取混流时对混流中音量的回调监听

Parameters
pCB实现了 IZegoSoundLevelInMixedStreamCallback 回调的方法,用于拉取混流时接收混流中各单流的音量信息,可以根据此回调实现音浪。
Returns
true 调用成功,false 调用失败,将收不到音量回调。
Note
1. 此方法由拉取混流方调用。

2.若不再需要接收混流中各单流的音量信息,调用 SetSoundLevelInMixedStreamCallback(null) 去除回调监听。