ZegoLiveRoom
Classes | Enumerations | Functions
ZEGO::MEDIAPLAYER Namespace Reference

Classes

class  IZegoMediaPlayerAudioDataCallback
 
class  IZegoMediaPlayerEventWithIndexCallback
 
class  IZegoMediaPlayerMediaSideInfoCallback
 
class  IZegoMediaPlayerVideoDataWithIndexCallback
 
struct  ZegoMediaPlayerHttpHeader
 
struct  ZegoMediaPlayerVideoDataFormat
 

Enumerations

enum  ZegoMediaPlayerType { ZegoMediaPlayerTypePlayer = 0, ZegoMediaPlayerTypeAux = 1 }
 
enum  ZegoMediaPlayerVideoPixelFormat {
  ZegoMediaPlayerVideoPixelFormatUnknown = 0, ZegoMediaPlayerVideoPixelFormatI420 = 1, ZegoMediaPlayerVideoPixelFormatNV12 = 2, ZegoMediaPlayerVideoPixelFormatNV21 = 3,
  ZegoMediaPlayerVideoPixelFormatBGRA32 = 4, ZegoMediaPlayerVideoPixelFormatRGBA32 = 5, ZegoMediaPlayerVideoPixelFormatARGB32 = 6, ZegoMediaPlayerVideoPixelFormatABGR32 = 7
}
 
enum  ZegoMediaPlayerIndex { ZegoMediaPlayerIndexFirst = 0, ZegoMediaPlayerIndexSecond = 1, ZegoMediaPlayerIndexThird = 2, ZegoMediaPlayerIndexFourth = 3 }
 
enum  ZegoMediaPlayerAudioChannel { ZegoMediaPlayerAudioChannelLeft = 1, ZegoMediaPlayerAudioChannelRight = 2, ZegoMediaPlayerAudioChannelAll = 3 }
 
enum  ZegoMediaPlayerError {
  ZegoMediaPlayerErrorOK = 0, ZegoMediaPlayerErrorFile = -1, ZegoMediaPlayerErrorPath = -2, ZegoMediaPlayerErrorCodec = -3,
  ZegoMediaPlayerErrorNoSupportStream = -4, ZegoMediaPlayerErrorDemux = -5, ZegoMediaPlayerErrorFrameDrop = -6, ZegoMediaPlayerErrorLoadTimeout = -7
}
 

Functions

ZEGOAVKIT_API void InitWithType (ZegoMediaPlayerType type, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 
ZEGOAVKIT_API void CreatePlayer (ZegoMediaPlayerType type, ZegoMediaPlayerIndex index)
 
ZEGOAVKIT_API void DestroyPlayer (ZegoMediaPlayerIndex index)
 
ZEGOAVKIT_API void SetVolume (int volume, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 
ZEGOAVKIT_API void SetPublishVolume (int volume, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 
ZEGOAVKIT_API void SetPlayVolume (int volume, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 
ZEGOAVKIT_API int GetPublishVolume (ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 
ZEGOAVKIT_API int GetPlayVolume (ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 
ZEGOAVKIT_API void Start (const char *path, bool repeat, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 
ZEGOAVKIT_API void Start (const char *path, bool repeat, long startPosition, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 
ZEGOAVKIT_API void Start (const char *path, long startPosition, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 
ZEGOAVKIT_API void Stop (ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 
ZEGOAVKIT_API void Pause (ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 
ZEGOAVKIT_API void Resume (ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 
ZEGOAVKIT_API void SeekTo (long duration, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 
ZEGOAVKIT_API long GetDuration (ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 
ZEGOAVKIT_API long GetCurrentDuration (ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 
ZEGOAVKIT_API void MuteLocal (bool mute, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 
ZEGOAVKIT_API void Load (const char *path, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 
ZEGOAVKIT_API void Load (const char *path, long startPosition, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 
ZEGOAVKIT_API void SetView (void *view, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 
ZEGOAVKIT_API long SetAudioStream (long streamIndex, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 
ZEGOAVKIT_API void SetPlayerType (ZegoMediaPlayerType type, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 
ZEGOAVKIT_API long GetAudioStreamCount (ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 
ZEGOAVKIT_API void EnableRepeatMode (bool enable, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 
ZEGOAVKIT_API void SetLoopCount (int loopCount, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 
ZEGOAVKIT_API void TakeSnapshot (ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 
ZEGOAVKIT_API bool SetProcessInterval (long interval, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 
ZEGOAVKIT_API bool RequireHWDecoder (ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 
ZEGOAVKIT_API void SetViewMode (AV::ZegoVideoViewMode mode, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 
ZEGOAVKIT_API void SetBackgroundColor (int color, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 
ZEGOAVKIT_API void ClearView (ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 
ZEGOAVKIT_API void EnableAccurateSeek (bool enable, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 
ZEGOAVKIT_API void SetAccurateSeekTimeout (long timeoutInMS, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 
ZEGOAVKIT_API void SetActiveAudioChannel (ZegoMediaPlayerAudioChannel channel, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 
ZEGOAVKIT_API void SetAudioChannelKeyShift (ZegoMediaPlayerAudioChannel channel, float keyShiftValue, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 
ZEGOAVKIT_API void SetOnlineResourceCache (int timeInMS, int sizeInByte, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 
ZEGOAVKIT_API bool GetOnlineResourceCacheStat (int *timeInMS, int *sizeInByte, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 
ZEGOAVKIT_API void SetBufferThreshold (int thresholdInMS, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 
ZEGOAVKIT_API void SetLoadResourceTimeout (int timeoutInMS, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 
ZEGOAVKIT_API void SetHttpHeaders (ZegoMediaPlayerHttpHeader *headers, int headerSize, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 
ZEGOAVKIT_API void SetEventWithIndexCallback (IZegoMediaPlayerEventWithIndexCallback *callback, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 
ZEGOAVKIT_API void SetVideoDataWithIndexCallback (IZegoMediaPlayerVideoDataWithIndexCallback *callback, ZegoMediaPlayerVideoPixelFormat format, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 
ZEGOAVKIT_API void SetAudioDataCallback (IZegoMediaPlayerAudioDataCallback *callback, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 
ZEGOAVKIT_API void SetMediaSideInfoCallback (IZegoMediaPlayerMediaSideInfoCallback *callback, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
 

Enumeration Type Documentation

◆ ZegoMediaPlayerAudioChannel

Enumerator
ZegoMediaPlayerAudioChannelLeft 
ZegoMediaPlayerAudioChannelRight 
ZegoMediaPlayerAudioChannelAll 

◆ ZegoMediaPlayerError

媒体播放器错误码

Enumerator
ZegoMediaPlayerErrorOK 

ok

ZegoMediaPlayerErrorFile 

文件格式不支持

ZegoMediaPlayerErrorPath 

路径不存在

ZegoMediaPlayerErrorCodec 

文件无法解码

ZegoMediaPlayerErrorNoSupportStream 

文件中没有可播放的音视频流

ZegoMediaPlayerErrorDemux 

文件解析过程中出现错误

ZegoMediaPlayerErrorFrameDrop 

播放掉帧

ZegoMediaPlayerErrorLoadTimeout 

加载资源超时

◆ ZegoMediaPlayerIndex

Enumerator
ZegoMediaPlayerIndexFirst 
ZegoMediaPlayerIndexSecond 
ZegoMediaPlayerIndexThird 
ZegoMediaPlayerIndexFourth 

◆ ZegoMediaPlayerType

Enumerator
ZegoMediaPlayerTypePlayer 
ZegoMediaPlayerTypeAux 

◆ ZegoMediaPlayerVideoPixelFormat

Enumerator
ZegoMediaPlayerVideoPixelFormatUnknown 
ZegoMediaPlayerVideoPixelFormatI420 
ZegoMediaPlayerVideoPixelFormatNV12 
ZegoMediaPlayerVideoPixelFormatNV21 
ZegoMediaPlayerVideoPixelFormatBGRA32 
ZegoMediaPlayerVideoPixelFormatRGBA32 
ZegoMediaPlayerVideoPixelFormatARGB32 
ZegoMediaPlayerVideoPixelFormatABGR32 

Function Documentation

◆ ClearView()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::ClearView ( ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst)

清除播放控件播放结束后, 在控件上保留的最后一帧画面

Parameters
index播放器序号, 默认为 ZegoMediaPlayerIndexFirst

◆ CreatePlayer()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::CreatePlayer ( ZegoMediaPlayerType  type,
ZegoMediaPlayerIndex  index 
)

创建播放器

Parameters
type
See also
ZegoMediaPlayerType
Parameters
index播放器序号, 详见 ZegoMediaPlayerIndex
Note
初始化 SDK 前后都可以调用,但是播放器的功能必须在初始化 SDK 之后才可用。

◆ DestroyPlayer()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::DestroyPlayer ( ZegoMediaPlayerIndex  index)

释放播放器

Parameters
index播放器序号, 详见 ZegoMediaPlayerIndex
Note
反初始化 SDK 时,会把 CreatePlayer 创建的播放器对象一起销毁。

◆ EnableAccurateSeek()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::EnableAccurateSeek ( bool  enable,
ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst 
)

设置是否开启精准搜索

Parameters
enable是否开启
index播放器序号, 默认为 ZegoMediaPlayerIndexFirst
Note
: 播放文件之前调用,即Start或Load前,播放过程中调用不起作用,但可能对下个文件的播放起作用.

◆ EnableRepeatMode()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::EnableRepeatMode ( bool  enable,
ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst 
)

设置是否循环播放

Warning
Deprecated, 请使用 SetLoopCount 代替
Parameters
enabletrue: 循环播放,false: 不循环播放
index播放器序号, 默认为 ZegoMediaPlayerIndexFirst

◆ GetAudioStreamCount()

ZEGOAVKIT_API long ZEGO::MEDIAPLAYER::GetAudioStreamCount ( ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst)

获取音轨个数

Returns
音轨个数
Parameters
index播放器序号, 默认为 ZegoMediaPlayerIndexFirst

◆ GetCurrentDuration()

ZEGOAVKIT_API long ZEGO::MEDIAPLAYER::GetCurrentDuration ( ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst)

获取当前播放的进度

Parameters
index播放器序号, 默认为 ZegoMediaPlayerIndexFirst
Returns
当前播放进度,单位毫秒

◆ GetDuration()

ZEGOAVKIT_API long ZEGO::MEDIAPLAYER::GetDuration ( ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst)

获取整个文件的播放时长

Parameters
index播放器序号, 默认为 ZegoMediaPlayerIndexFirst
Returns
文件的播放时长,单位毫秒

◆ GetOnlineResourceCacheStat()

ZEGOAVKIT_API bool ZEGO::MEDIAPLAYER::GetOnlineResourceCacheStat ( int *  timeInMS,
int *  sizeInByte,
ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst 
)

获取网络素材缓存队列的缓存数据可播放的时长和缓存数据大小

Parameters
timeInMS缓存数据可播放的时长, 单位 ms
sizeInByte缓存数据大小, 单位 byte
index播放器序号, 默认为 ZegoMediaPlayerIndexFirst
Returns
true 调用成功, false 调用失败

◆ GetPlayVolume()

ZEGOAVKIT_API int ZEGO::MEDIAPLAYER::GetPlayVolume ( ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst)

获取本地播放音量

Parameters
index播放器序号, 默认为 ZegoMediaPlayerIndexFirst
Returns
返回本地播放音量

◆ GetPublishVolume()

ZEGOAVKIT_API int ZEGO::MEDIAPLAYER::GetPublishVolume ( ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst)

获取推流音量

Parameters
index播放器序号, 默认为 ZegoMediaPlayerIndexFirst
Returns
返回推流音量

◆ InitWithType()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::InitWithType ( ZegoMediaPlayerType  type,
ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst 
)

初始化播放器

Deprecated:
请使用 CreatePlayer 代替
Parameters
type
See also
ZegoMediaPlayerType
Parameters
index播放器序号, 默认为 ZegoMediaPlayerIndexFirst

◆ Load() [1/2]

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::Load ( const char *  path,
long  startPosition,
ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst 
)

预加载资源

Parameters
path媒体文件的路径
startPosition指定开始播放的进度,单位毫秒
index播放器序号, 默认为 ZegoMediaPlayerIndexFirst
Note
如果是视频, 会将首帧画面显示在显示控件上(通过 SetView 设置的). 之后需要播放资源时请调用 Resume 接口
当 startPosition 超过播放总时长,将从头开始播放

◆ Load() [2/2]

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::Load ( const char *  path,
ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst 
)

预加载资源

Parameters
path媒体文件的路径
index播放器序号, 默认为 ZegoMediaPlayerIndexFirst
Note
如果是视频, 会将首帧画面显示在显示控件上(通过 SetView 设置的). 之后需要播放资源时请调用 Resume 接口

◆ MuteLocal()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::MuteLocal ( bool  mute,
ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst 
)

设置本地静默播放

Parameters
mute是否静默播放
index播放器序号, 默认为 ZegoMediaPlayerIndexFirst
Note
如果设置了 ZegoMediaPlayerTypeAux 模式, 推出的流是有声音的

◆ Pause()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::Pause ( ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst)

暂停播放

Parameters
index播放器序号, 默认为 ZegoMediaPlayerIndexFirst

◆ RequireHWDecoder()

ZEGOAVKIT_API bool ZEGO::MEDIAPLAYER::RequireHWDecoder ( ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst)

设置使用硬件解码

Parameters
index播放器序号, 默认为 ZegoMediaPlayerIndexFirst。
Returns
设置是否成功
Note
当前只支持 iOS 系统
需要在加载媒体资源之前设置,即在 Start 或者 Load 之前
即使设置了使用硬件解码,引擎也会根据当前硬件情况决定是否使用
多次调用没有影响

◆ Resume()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::Resume ( ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst)

恢复播放

Parameters
index播放器序号, 默认为 ZegoMediaPlayerIndexFirst

◆ SeekTo()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::SeekTo ( long  duration,
ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst 
)

设置指定的进度进行播放

Parameters
duration指定的进度,单位毫秒
index播放器序号, 默认为 ZegoMediaPlayerIndexFirst

◆ SetAccurateSeekTimeout()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::SetAccurateSeekTimeout ( long  timeoutInMS,
ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst 
)

设置精确搜索的超时时间

Parameters
timeoutInMS超时时间, 单位毫秒. 有效值区间 [2000, 10000]
index播放器序号, 默认为 ZegoMediaPlayerIndexFirst
Note
如果不设置, SDK 内部默认是设置 5000 毫秒

◆ SetActiveAudioChannel()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::SetActiveAudioChannel ( ZegoMediaPlayerAudioChannel  channel,
ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst 
)

设置播放声道

Parameters
channel声道, 参见 ZegoMediaPlayerAudioChannel 定义. 播放器初始化时默认是 ZegoMediaPlayerAudioChannelAll
index播放器序号, 默认为 ZegoMediaPlayerIndexFirst

◆ SetAudioChannelKeyShift()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::SetAudioChannelKeyShift ( ZegoMediaPlayerAudioChannel  channel,
float  keyShiftValue,
ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst 
)

设置声道音调

Parameters
channel声道, 参见 ZegoMediaPlayerAudioChannel 定义
keyShiftValue音调偏移值, 有效值范围 [-12.0, 12.0], 播放器初始化时默认是 0
index播放器序号, 默认为 ZegoMediaPlayerIndexFirst
Note
可选择设置左声道、右声道、左右声道,当只设置一个声道时,另一个声道保持原值

◆ SetAudioDataCallback()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::SetAudioDataCallback ( IZegoMediaPlayerAudioDataCallback callback,
ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst 
)

设置音频数据回调

Parameters
callback回调
index播放器序号,默认为 ZegoMediaPlayerIndexFirst

◆ SetAudioStream()

ZEGOAVKIT_API long ZEGO::MEDIAPLAYER::SetAudioStream ( long  streamIndex,
ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst 
)

设置播放文件的音轨

Parameters
streamIndex音轨序号,可以通过 getAudioStreamCount 接口获取音轨个数
index播放器序号, 默认为 ZegoMediaPlayerIndexFirst

◆ SetBackgroundColor()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::SetBackgroundColor ( int  color,
ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst 
)

设置播放的背景颜色

Parameters
color颜色,取值为0x00RRGGBB
index播放器序号, 默认为 ZegoMediaPlayerIndexFirst

◆ SetBufferThreshold()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::SetBufferThreshold ( int  thresholdInMS,
ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst 
)

设置缓冲回调的阈值, 缓冲区可播放时长大于阈值时,开始播放, 并回调 OnBufferEnd

Parameters
thresholdInMS阈值, 单位 ms, 有效值为大于等于 1000
index播放器序号, 默认为 ZegoMediaPlayerIndexFirst
Note
在 Start 或者 Load 之前调用, 设置一次, 生命周期内一直有效
SDK 默认值是 5000ms

◆ SetEventWithIndexCallback()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::SetEventWithIndexCallback ( IZegoMediaPlayerEventWithIndexCallback callback,
ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst 
)

设置播放器事件回调

Parameters
callback回调 IZegoMediaPlayerEventWithIndexCallback
index播放器序号, 默认为 ZegoMediaPlayerIndexFirst
Note
使用多实例媒体播放器时,应该使用这个接口设置回调,便于在回调中区分是哪个播放器实例的回调

◆ SetHttpHeaders()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::SetHttpHeaders ( ZegoMediaPlayerHttpHeader headers,
int  headerSize,
ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst 
)

设置 http 网络资源的http headers

Parameters
headersheaders, 每一个 key 和 value 不大于 512 字节
sizeheaders size
index播放器序号, 默认为 ZegoMediaPlayerIndexFirst

◆ SetLoadResourceTimeout()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::SetLoadResourceTimeout ( int  timeoutInMS,
ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst 
)

设置加载资源的超时时间

Parameters
timeoutInMS超时时间, 单位 ms, 有效值为大于等于 1000
index播放器序号, 默认为 ZegoMediaPlayerIndexFirst
Note
在 Start 或者 Load 之前设置, 设置一次, 生命周期内一直有效,
当打开文件超过设定超时时间,会失败并回调 onPlayError
SDK 默认会一直等待

◆ SetLoopCount()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::SetLoopCount ( int  loopCount,
ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst 
)

设置循环播放次数

Parameters
loopCount循环次数,-1 表示无限循环,0 表示不循环,>0 表示循环次数,实际播放次数为 (loopCount+1)
index播放器序号, 默认为 ZegoMediaPlayerIndexFirst
Note
创建播放器之后可调用,播放器的生命周期内有效
默认为不循环播放

◆ SetMediaSideInfoCallback()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::SetMediaSideInfoCallback ( IZegoMediaPlayerMediaSideInfoCallback callback,
ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst 
)

设置播放文件的 SEI 信息回调

Parameters
callback回调
index播放器序号,默认为 ZegoMediaPlayerIndexFirst

◆ SetOnlineResourceCache()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::SetOnlineResourceCache ( int  timeInMS,
int  sizeInByte,
ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst 
)

设置网络素材最大的缓存时长和缓存数据大小, 以先达到者为准

Parameters
timeInMS缓存最大时长, 单位 ms, 有效值为大于等于 2000, 如果填 0, 表示不限制
sizeInByte缓存最大尺寸, 单位 byte, 有效值为大于等于 5000000, 如果填 0, 表示不限制
index播放器序号, 默认为 ZegoMediaPlayerIndexFirst
Note
不允许 timeInMS 和 sizeInByte 都为 0
SDK 内部默认 timeInMS 为 5000, sizeInByte 为 15*1024*1024
在 Start 或者 Load 之前调用, 设置一次, 生命周期内一直有效

◆ SetPlayerType()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::SetPlayerType ( ZegoMediaPlayerType  type,
ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst 
)

设置播放器类型

Parameters
type
See also
ZegoMediaPlayerType
Parameters
index播放器序号, 默认为 ZegoMediaPlayerIndexFirst

◆ SetPlayVolume()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::SetPlayVolume ( int  volume,
ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst 
)

设置本地播放音量

Parameters
volume音量,取值范围[0, 200],默认 60
index播放器序号, 默认为 ZegoMediaPlayerIndexFirst

◆ SetProcessInterval()

ZEGOAVKIT_API bool ZEGO::MEDIAPLAYER::SetProcessInterval ( long  interval,
ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst 
)

设置播放进度回调间隔。

Parameters
interval回调间隔,单位毫秒。有效值为大于等于 0。默认值为 0。
index播放器序号, 默认为 ZegoMediaPlayerIndexFirst。
Note
设置 interval 大于 0 时,就会收到 OnProcessInterval 回调。interval = 0 时,停止回调。
回调不会严格按照设定的回调间隔值返回,而是以处理音频帧或者视频帧的频率来判断是否需要回调。

◆ SetPublishVolume()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::SetPublishVolume ( int  volume,
ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst 
)

设置推流音量

Parameters
volume音量,取值范围[0, 200],默认 60
index播放器序号, 默认为 ZegoMediaPlayerIndexFirst

◆ SetVideoDataWithIndexCallback()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::SetVideoDataWithIndexCallback ( IZegoMediaPlayerVideoDataWithIndexCallback callback,
ZegoMediaPlayerVideoPixelFormat  format,
ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst 
)

设置视频帧数据回调

Parameters
callback回调
format需要返回的视频帧数据格式,
See also
ZegoMediaPlayerVideoPixelFormat
Parameters
index播放器序号, 默认为 ZegoMediaPlayerIndexFirst
Note
使用多实例媒体播放器时,应该使用这个接口设置回调,便于在回调中区分是哪个播放器实例的回调

◆ SetView()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::SetView ( void *  view,
ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst 
)

设置显示视频的view

Parameters
view播放的控件
index播放器序号, 默认为 ZegoMediaPlayerIndexFirst

◆ SetViewMode()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::SetViewMode ( AV::ZegoVideoViewMode  mode,
ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst 
)

设置播放控件显示模式

Parameters
mode显示模式。详见 AV::ZegoVideoViewMode,默认为 ZegoVideoViewModeScaleAspectFit 模式
index播放器序号, 默认为 ZegoMediaPlayerIndexFirst

◆ SetVolume()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::SetVolume ( int  volume,
ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst 
)

设置本地播放音量, 如果播放器设置了推流模式, 也会设置推流音量

Parameters
volume音量,取值范围[0, 200],默认 60
index播放器序号, 默认为 ZegoMediaPlayerIndexFirst

◆ Start() [1/3]

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::Start ( const char *  path,
bool  repeat,
long  startPosition,
ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst 
)

开始播放并指定开始播放的进度

Warning
Deprecated, 请使用 Start(const char *path, long startPosition, ZegoMediaPlayerIndex index) 替代,需要设置循环模式时,可调用 SetLoopCount 接口。
Parameters
path媒体文件的路径
repeat是否重复播放
startPosition指定开始播放的进度,单位毫秒
index播放器序号, 默认为 ZegoMediaPlayerIndexFirst
Note
当 startPosition 超过播放总时长,将从头开始播放
当 repeat=true 时, startposition只在第一次播放时生效

◆ Start() [2/3]

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::Start ( const char *  path,
bool  repeat,
ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst 
)

开始播放

Warning
Deprecated, 请使用 Start(const char *path, long startPosition, ZegoMediaPlayerIndex index) 替代,需要设置循环模式时,可调用 SetLoopCount 接口。
Parameters
path媒体文件的路径
repeat是否重复播放
index播放器序号, 默认为 ZegoMediaPlayerIndexFirst

◆ Start() [3/3]

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::Start ( const char *  path,
long  startPosition,
ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst 
)

开始播放并指定开始播放的进度

Parameters
path媒体文件的路径
startPosition指定开始播放的进度,单位毫秒
index播放器序号, 默认为 ZegoMediaPlayerIndexFirst
Note
在已经初始化 SDK 且调用 CreatePlayer 之后可以调用
当 startPosition 超过播放总时长,将从头开始播放
需要设置循环模式时,可调用 SetLoopCount 接口

◆ Stop()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::Stop ( ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst)

停止播放

Parameters
index播放器序号, 默认为 ZegoMediaPlayerIndexFirst

◆ TakeSnapshot()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::TakeSnapshot ( ZegoMediaPlayerIndex  index = ZegoMediaPlayerIndexFirst)

获取当前播放视频的截图

Parameters
index播放器序号, 默认为 ZegoMediaPlayerIndexFirst
Note
只有在调用 setView 设置了显示控件,以及播放状态的情况下,才能正常截图。