Classes
class	IZegoMediaPlayerAudioDataCallback

class	IZegoMediaPlayerBlockDataCallback

class	IZegoMediaPlayerEventWithIndexCallback

class	IZegoMediaPlayerMediaSideInfoCallback

class	IZegoMediaPlayerSoundInfoCallback

class	IZegoMediaPlayerVideoDataWithIndexCallback

class	ZegoMediaPlayerFileReader

struct	ZegoMediaPlayerHttpHeader

struct	ZegoMediaPlayerMediaInfo

struct	ZegoMediaPlayerResource

struct	ZegoMediaPlayerStatisticsInfo

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	ZegoMediaPlayerAudioTrackMode { ZegoMediaPlayerAudioTrackModeNormal = 0 , ZegoMediaPlayerAudioTrackModeMultiple = 1 }

enum	ZegoMediaPlayerError { ZegoMediaPlayerErrorOK = 0 , ZegoMediaPlayerErrorFile = -1 , ZegoMediaPlayerErrorPath = -2 , ZegoMediaPlayerErrorCodec = -3 , ZegoMediaPlayerErrorNoSupportStream = -4 , ZegoMediaPlayerErrorDemux = -5 , ZegoMediaPlayerErrorFrameDrop = -6 , ZegoMediaPlayerErrorLoadTimeout = -7 , ZegoMediaPlayerErrorExpired = -8 , ZegoMediaPlayerErrorResourceIDExpired = -9 }

enum	ZegoMultimediaLoadType { ZEGO_MULTIMEDIA_LOAD_TYPE_FILE_PATH = 0 , ZEGO_MULTIMEDIA_LOAD_TYPE_MEMORY = 1 , ZEGO_MULTIMEDIA_LOAD_TYPE_RESOURCE_ID = 2 }

enum	ZegoLiveAudioEffectMode { ZEGO_LIVE_AUDIO_EFFECT_MODE_NONE = 0 , ZEGO_LIVE_AUDIO_EFFECT_MODE_LOCAL = 1 , ZEGO_LIVE_AUDIO_EFFECT_MODE_PUBLISH = 2 , ZEGO_LIVE_AUDIO_EFFECT_MODE_ALL = 3 }
	Live audio effect mode. More...

enum	ZegoMediaStreamType { ZEGO_MEDIA_STREAM_TYPE_AUDIO = 0 , ZEGO_MEDIA_STREAM_TYPE_VIDEO = 1 , ZEGO_MEDIA_STREAM_TYPE_AV = 2 }

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	SetPlaySpeed (float speed, 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	Start (unsigned char *mediaData, int mediaDataLen, long startPosition, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)

ZEGOAVKIT_API void	StartCopyrightedMusic (const char *resourceID, 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 long	GetCurrentRenderingDuration (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	Load (unsigned char *mediaData, int mediaDataLen, long startPosition, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)

ZEGOAVKIT_API void	LoadCopyrightedMusic (const char *resourceID, long startPosition, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)

ZEGOAVKIT_API void	Load (const ZegoMediaPlayerResource &resource, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)

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

ZEGOAVKIT_API void	SetView (const AV::ZegoView &view, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)

ZEGOAVKIT_API long	SetAudioStream (long streamIndex, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)

ZEGOAVKIT_API void	SetAudioPublishStream (long streamIndex, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)

ZEGOAVKIT_API void	SetAudioTrackMode (ZegoMediaPlayerAudioTrackMode mode, 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)

ZEGOAVKIT_API void	SetMediaPlayerFileReader (ZegoMediaPlayerFileReader *reader, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)

ZEGOAVKIT_API void	SetSoundInfoCallback (IZegoMediaPlayerSoundInfoCallback *callback, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
	设置声音信息回调，包括声浪、频谱。 More...

ZEGOAVKIT_API void	EnableSoundLevelMonitor (bool enable, unsigned int timeInMS=200, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
	是否开启声浪监听 More...

ZEGOAVKIT_API void	EnableFrequencySpectrumMonitor (bool enable, unsigned int timeInMS=200, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
	是否开启频谱监听 More...

ZEGOAVKIT_API void	SetBlockDataCallback (IZegoMediaPlayerBlockDataCallback *callback, int blockSize, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)

ZEGOAVKIT_API void	AttachToPublishChannel (AV::PublishChannelIndex channel=AV::PUBLISH_CHN_AUX, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
	指定某个播放器绑定到推流通道，注意不能为主路，当前复制播放器音频到辅路只支持channel 1，推荐设置到channel 1。 More...

ZEGOAVKIT_API const char *	GetMetaDataValue (const char *key, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
	通过键值获取保存在媒体文件中的元数据信息 More...

ZEGOAVKIT_API ZegoMediaPlayerMediaInfo	GetMediaInfo (ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)

ZEGOAVKIT_API void	UpdatePosition (const float position[3], ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
	更新媒体播放器(音频源)位置 More...

ZEGOAVKIT_API void	EnableLiveAudioEffect (bool enable, ZegoLiveAudioEffectMode mode, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
	开启现场音效 More...

ZEGOAVKIT_API void	SetPlayMediaStreamType (ZegoMediaStreamType type, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
	设置媒体播放器播放的媒体流类型，用于仅播放音频流或者视频流的场景 More...

ZEGOAVKIT_API void	EnableLocalCache (bool enable, const char *cache_dir, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
	开启本地缓存文件 More...

ZEGOAVKIT_API bool	GetPlaybackStatistics (ZegoMediaPlayerStatisticsInfo &stat, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
	获取播放器当前播放统计信息 More...

ZEGOAVKIT_API void	EnableViewMirror (bool enable, ZegoMediaPlayerIndex index=ZegoMediaPlayerIndexFirst)
	开启画面镜像 More...

Enumeration Type Documentation

◆ ZegoLiveAudioEffectMode

enum ZEGO::MEDIAPLAYER::ZegoLiveAudioEffectMode

Live audio effect mode.

Enumerator
ZEGO_LIVE_AUDIO_EFFECT_MODE_NONE	无音效
ZEGO_LIVE_AUDIO_EFFECT_MODE_LOCAL	仅本地播放
ZEGO_LIVE_AUDIO_EFFECT_MODE_PUBLISH	仅推流
ZEGO_LIVE_AUDIO_EFFECT_MODE_ALL	推流和本地播放

◆ ZegoMediaPlayerAudioChannel

enum ZEGO::MEDIAPLAYER::ZegoMediaPlayerAudioChannel

Enumerator
ZegoMediaPlayerAudioChannelLeft
ZegoMediaPlayerAudioChannelRight
ZegoMediaPlayerAudioChannelAll

◆ ZegoMediaPlayerAudioTrackMode

enum ZEGO::MEDIAPLAYER::ZegoMediaPlayerAudioTrackMode

Enumerator
ZegoMediaPlayerAudioTrackModeNormal
ZegoMediaPlayerAudioTrackModeMultiple

◆ ZegoMediaPlayerError

enum ZEGO::MEDIAPLAYER::ZegoMediaPlayerError

媒体播放器错误码

Enumerator
ZegoMediaPlayerErrorOK	ok
ZegoMediaPlayerErrorFile	文件格式不支持
ZegoMediaPlayerErrorPath	路径不存在
ZegoMediaPlayerErrorCodec	文件无法解码
ZegoMediaPlayerErrorNoSupportStream	文件中没有可播放的音视频流
ZegoMediaPlayerErrorDemux	文件解析过程中出现错误
ZegoMediaPlayerErrorFrameDrop	播放掉帧
ZegoMediaPlayerErrorLoadTimeout	加载资源超时
ZegoMediaPlayerErrorExpired	版权资源文件已过期
ZegoMediaPlayerErrorResourceIDExpired	版权资源已过期

◆ ZegoMediaPlayerIndex

enum ZEGO::MEDIAPLAYER::ZegoMediaPlayerIndex

Enumerator
ZegoMediaPlayerIndexFirst
ZegoMediaPlayerIndexSecond
ZegoMediaPlayerIndexThird
ZegoMediaPlayerIndexFourth

◆ ZegoMediaPlayerType

enum ZEGO::MEDIAPLAYER::ZegoMediaPlayerType

Enumerator
ZegoMediaPlayerTypePlayer
ZegoMediaPlayerTypeAux

◆ ZegoMediaPlayerVideoPixelFormat

enum ZEGO::MEDIAPLAYER::ZegoMediaPlayerVideoPixelFormat

Enumerator
ZegoMediaPlayerVideoPixelFormatUnknown
ZegoMediaPlayerVideoPixelFormatI420
ZegoMediaPlayerVideoPixelFormatNV12
ZegoMediaPlayerVideoPixelFormatNV21
ZegoMediaPlayerVideoPixelFormatBGRA32
ZegoMediaPlayerVideoPixelFormatRGBA32
ZegoMediaPlayerVideoPixelFormatARGB32
ZegoMediaPlayerVideoPixelFormatABGR32

◆ ZegoMediaStreamType

enum ZEGO::MEDIAPLAYER::ZegoMediaStreamType

媒体流类型

Enumerator
ZEGO_MEDIA_STREAM_TYPE_AUDIO	媒体音频流
ZEGO_MEDIA_STREAM_TYPE_VIDEO	媒体视频流
ZEGO_MEDIA_STREAM_TYPE_AV	媒体音视频流

◆ ZegoMultimediaLoadType

enum ZEGO::MEDIAPLAYER::ZegoMultimediaLoadType

媒体资源加载方式

Enumerator
ZEGO_MULTIMEDIA_LOAD_TYPE_FILE_PATH	通过文件路径加载资源
ZEGO_MULTIMEDIA_LOAD_TYPE_MEMORY	通过二进制内存数据加载资源
ZEGO_MULTIMEDIA_LOAD_TYPE_RESOURCE_ID	通过版权音乐资源 ID 加载资源

Function Documentation

◆ AttachToPublishChannel()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::AttachToPublishChannel	(	AV::PublishChannelIndex	channel = `AV::PUBLISH_CHN_AUX`,
		ZegoMediaPlayerIndex	index = `ZegoMediaPlayerIndexFirst`
	)

指定某个播放器绑定到推流通道，注意不能为主路，当前复制播放器音频到辅路只支持channel 1，推荐设置到channel 1。

Parameters

channel	推流 channel Index. 默认为辅Channel
index	播放器序号，默认为 ZegoMediaPlayerIndexFirst

◆ 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前，播放过程中调用不起作用，但可能对下个文件的播放起作用.

◆ EnableFrequencySpectrumMonitor()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::EnableFrequencySpectrumMonitor	(	bool	enable,
		unsigned int	timeInMS = `200`,
		ZegoMediaPlayerIndex	index = `ZegoMediaPlayerIndexFirst`
	)

是否开启频谱监听

Parameters

enable	是否开启，true 开启，false 关闭。
timeInMS	时间间隔，单位为毫秒，取值范围 [100, 3000]，默认 200 毫秒。

◆ EnableLiveAudioEffect()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::EnableLiveAudioEffect	(	bool	enable,
		ZegoLiveAudioEffectMode	mode,
		ZegoMediaPlayerIndex	index = `ZegoMediaPlayerIndexFirst`
	)

开启现场音效

Parameters

enable	是否开启现场音效
mode	开启时选择的现场音效模式
index	播放器序号，默认为 ZegoMediaPlayerIndexFirst

Note: 此接口需要在 CreatePlayer 后，DestroyPlayer 前调用

◆ EnableLocalCache()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::EnableLocalCache	(	bool	enable,
		const char *	cache_dir,
		ZegoMediaPlayerIndex	index = `ZegoMediaPlayerIndexFirst`
	)

开启本地缓存文件

Parameters

enable	是否开启
cache_dir	缓存目录，如果开启了本地缓存，而没有设置cache_dir，SDK 会内部指定缓存目录。
index	播放器序号，默认为 ZegoMediaPlayerIndexFirst

Attention: 只能缓存 http/https 类型的网络资源，如果播放过程中有 seek 行为，会导致缓存失败。

◆ EnableRepeatMode()

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

设置是否循环播放

Warning: Deprecated, 请使用 SetLoopCount 代替

Parameters

enable	true: 循环播放，false: 不循环播放
index	播放器序号, 默认为 ZegoMediaPlayerIndexFirst

◆ EnableSoundLevelMonitor()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::EnableSoundLevelMonitor	(	bool	enable,
		unsigned int	timeInMS = `200`,
		ZegoMediaPlayerIndex	index = `ZegoMediaPlayerIndexFirst`
	)

是否开启声浪监听

Parameters

enable	是否开启，true 开启，false 关闭。
timeInMS	时间间隔，单位为毫秒，取值范围 [100, 3000]，默认 200 毫秒。

◆ EnableViewMirror()

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

开启画面镜像

Parameters

enable 是否开启

◆ 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: 当前播放进度，单位毫秒

◆ GetCurrentRenderingDuration()

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

获取当前渲染的进度

Parameters

index 播放器序号, 默认为 ZegoMediaPlayerIndexFirst

Returns: 当前渲染进度，单位毫秒

◆ GetDuration()

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

获取整个文件的播放时长

Parameters

index 播放器序号, 默认为 ZegoMediaPlayerIndexFirst

Returns: 文件的播放时长，单位毫秒

◆ GetMediaInfo()

ZEGOAVKIT_API ZegoMediaPlayerMediaInfo ZEGO::MEDIAPLAYER::GetMediaInfo ( ZegoMediaPlayerIndex index = ZegoMediaPlayerIndexFirst )

获取媒体文件视频分辨率等媒体信息

Parameters

index 播放器序号, 默认为 ZegoMediaPlayerIndexFirst

Returns: 媒体文件视频分辨率等媒体信息

◆ GetMetaDataValue()

ZEGOAVKIT_API const char * ZEGO::MEDIAPLAYER::GetMetaDataValue	(	const char *	key,
		ZegoMediaPlayerIndex	index = `ZegoMediaPlayerIndexFirst`
	)

通过键值获取保存在媒体文件中的元数据信息

Parameters

key	要获取元数据的键值
index	播放器序号，默认为 ZegoMediaPlayerIndexFirst

Returns: 指定键值对应的元数据信息。媒体文件未加载或元数据中没有指定的键值时，将返回 NULL。

◆ GetOnlineResourceCacheStat()

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

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

Parameters

timeInMS	缓存数据可播放的时长, 单位 ms
sizeInByte	缓存数据大小, 单位 byte
index	播放器序号, 默认为 ZegoMediaPlayerIndexFirst

Returns: true 调用成功, false 调用失败

◆ GetPlaybackStatistics()

ZEGOAVKIT_API bool ZEGO::MEDIAPLAYER::GetPlaybackStatistics	(	ZegoMediaPlayerStatisticsInfo &	stat,
		ZegoMediaPlayerIndex	index = `ZegoMediaPlayerIndexFirst`
	)

获取播放器当前播放统计信息

Parameters

stat	播放器播放统计信息
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/4]

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/4]

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

预加载资源

Parameters

path	媒体文件的路径
index	播放器序号, 默认为 ZegoMediaPlayerIndexFirst

Note: 如果是视频, 会将首帧画面显示在显示控件上(通过 SetView 设置的). 之后需要播放资源时请调用 Resume 接口

◆ Load() [3/4]

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::Load	(	const ZegoMediaPlayerResource &	resource,
		ZegoMediaPlayerIndex	index = `ZegoMediaPlayerIndexFirst`
	)

预加载资源

Parameters

resource	媒体资源
index	播放器序号, 默认为 ZegoMediaPlayerIndexFirst

Note: 如果是视频, 会将首帧画面显示在显示控件上(通过 SetView 设置的). 之后需要播放资源时请调用 Resume 接口

◆ Load() [4/4]

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::Load	(	unsigned char *	mediaData,
		int	mediaDataLen,
		long	startPosition,
		ZegoMediaPlayerIndex	index = `ZegoMediaPlayerIndexFirst`
	)

预加载资源

Parameters

mediaData	媒体数据
mediaDataLen	媒体数据的大小
startPosition	指定开始播放的进度,单位毫秒
index	播放器序号, 默认为 ZegoMediaPlayerIndexFirst

Note: 如果是视频, 会将首帧画面显示在显示控件上(通过 SetView 设置的). 之后需要播放资源时请调用 Resume 接口; 当 startPosition 超过播放总时长，将从头开始播放

◆ LoadCopyrightedMusic()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::LoadCopyrightedMusic	(	const char *	resourceID,
		long	startPosition,
		ZegoMediaPlayerIndex	index = `ZegoMediaPlayerIndexFirst`
	)

预加载资源

Parameters

resourceID	资源 ID
startPosition	指定开始播放的进度,单位毫秒
index	播放器序号, 默认为 ZegoMediaPlayerIndexFirst

Note: 在已经初始化 SDK 且调用 CreatePlayer 之后可以调用; 如果是视频, 会将首帧画面显示在显示控件上(通过 SetView 设置的). 之后需要播放资源时请调用 Resume 接口; 当 startPosition 超过播放总时长，将从头开始播放; 需要设置循环模式时，可调用 SetLoopCount 接口; resource_id 从版权音乐模块 COPYRIGHTED_MUSIC 相关接口中获取

◆ 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: 需要在加载媒体资源之前设置，即在 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	音调偏移值, 有效值范围 [-8.0, 8.0], 播放器初始化时默认是 0
index	播放器序号, 默认为 ZegoMediaPlayerIndexFirst

Note: 可选择设置左声道、右声道、左右声道，当只设置一个声道时，另一个声道保持原值

◆ SetAudioDataCallback()

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

设置音频数据回调

Parameters

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

◆ SetAudioPublishStream()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::SetAudioPublishStream	(	long	streamIndex,
		ZegoMediaPlayerIndex	index = `ZegoMediaPlayerIndexFirst`
	)

设置媒体文件需要推流的音轨

Parameters

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

Note: 在已经初始化 SDK 且调用 CreatePlayer 之后可以调用; 该接口需要通过 SetAudioTrackMode 开启多音轨模式下才生效

◆ SetAudioStream()

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

设置播放文件的音轨

Parameters

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

◆ SetAudioTrackMode()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::SetAudioTrackMode	(	ZegoMediaPlayerAudioTrackMode	mode,
		ZegoMediaPlayerIndex	index = `ZegoMediaPlayerIndexFirst`
	)

设置播放器的音轨模式

Parameters

mode	音轨模式，当指定多音轨模式时需要搭配 SetAudioPublishStream 一起使用，用于支持本地播放和推流分别使用不同的音轨
index	播放器序号, 默认为 ZegoMediaPlayerIndexFirst

Note: 在 CreatePlayer 之后且在 start 之前调用生效; 开启该模式会增加对硬件设备的资源消耗

◆ SetBackgroundColor()

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

设置播放的背景颜色

Parameters

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

◆ SetBlockDataCallback()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::SetBlockDataCallback	(	IZegoMediaPlayerBlockDataCallback *	callback,
		int	blockSize,
		ZegoMediaPlayerIndex	index = `ZegoMediaPlayerIndexFirst`
	)

设置媒体播放器资源块数据回调

Parameters

callback	回调
blockSize	最小加密块数据的大小，OnBlockData 回调中的 size 为 blockSize 整数倍
index	播放器序号，默认为 ZegoMediaPlayerIndexFirst

Attention: 该接口适用于使用媒体播放器播放用户自己的加密文件，当 SDK 读到块数据后，通过回调抛出，由用户负责在原内存块解密

◆ 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

headers	headers, 每一个 key 和 value 不大于 512 字节
size	headers 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: 创建播放器之后可调用，播放器的生命周期内有效; 默认为不循环播放

◆ SetMediaPlayerFileReader()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::SetMediaPlayerFileReader	(	ZegoMediaPlayerFileReader *	reader,
		ZegoMediaPlayerIndex	index = `ZegoMediaPlayerIndexFirst`
	)

设置播放文件操作相关的回调

Parameters

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

Attention: 该接口适用于用户自己维护文件数据，当sdk 内部播放器读写时, 会触发回调中的文件操作，打开，读取，文件相关数据

◆ 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

◆ SetPlayMediaStreamType()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::SetPlayMediaStreamType	(	ZegoMediaStreamType	type,
		ZegoMediaPlayerIndex	index = `ZegoMediaPlayerIndexFirst`
	)

设置媒体播放器播放的媒体流类型，用于仅播放音频流或者视频流的场景

Parameters

type	媒体流类型
index	播放器序号，默认为 ZegoMediaPlayerIndexFirst

Note: 此接口需要在 CreatePlayer 后，DestroyPlayer 前调用

Attention: 播放时设置媒体流类型，将在下次播放时生效。

◆ SetPlaySpeed()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::SetPlaySpeed	(	float	speed,
		ZegoMediaPlayerIndex	index = `ZegoMediaPlayerIndexFirst`
	)

设置本地播放倍速

Parameters

speed	倍速，取值范围[0.5, 4.0]，默认 1.0
index	播放器序号, 默认为 ZegoMediaPlayerIndexFirst

Note: 回调对应IZegoMediaPlayerEventWithIndexCallback::OnPlayStart或IZegoMediaPlayerEventWithIndexCallback::OnLoadComplete 之后可以调用

◆ 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

◆ SetSoundInfoCallback()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::SetSoundInfoCallback	(	IZegoMediaPlayerSoundInfoCallback *	callback,
		ZegoMediaPlayerIndex	index = `ZegoMediaPlayerIndexFirst`
	)

设置声音信息回调，包括声浪、频谱。

Parameters

callback	回调
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() [1/2]

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::SetView	(	const AV::ZegoView &	view,
		ZegoMediaPlayerIndex	index = `ZegoMediaPlayerIndexFirst`
	)

设置显示视频的view

Parameters

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

◆ SetView() [2/2]

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/4]

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/4]

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/4]

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

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

Parameters

path	媒体文件的路径
startPosition	指定开始播放的进度,单位毫秒
index	播放器序号, 默认为 ZegoMediaPlayerIndexFirst

Note: 在已经初始化 SDK 且调用 CreatePlayer 之后可以调用; 当 startPosition 超过播放总时长，将从头开始播放; 需要设置循环模式时，可调用 SetLoopCount 接口

◆ Start() [4/4]

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::Start	(	unsigned char *	mediaData,
		int	mediaDataLen,
		long	startPosition,
		ZegoMediaPlayerIndex	index = `ZegoMediaPlayerIndexFirst`
	)

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

Parameters

mediaData	媒体数据
mediaDataLen	媒体数据的大小
startPosition	指定开始播放的进度,单位毫秒
index	播放器序号, 默认为 ZegoMediaPlayerIndexFirst

Note: 在已经初始化 SDK 且调用 CreatePlayer 之后可以调用; 当 startPosition 超过播放总时长，将从头开始播放; 需要设置循环模式时，可调用 SetLoopCount 接口

◆ StartCopyrightedMusic()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::StartCopyrightedMusic	(	const char *	resourceID,
		long	startPosition,
		ZegoMediaPlayerIndex	index = `ZegoMediaPlayerIndexFirst`
	)

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

Parameters

resourceID	资源 ID
startPosition	指定开始播放的进度,单位毫秒
index	播放器序号, 默认为 ZegoMediaPlayerIndexFirst

Note: 在已经初始化 SDK 且调用 CreatePlayer 之后可以调用; 当 startPosition 超过播放总时长，将从头开始播放; 需要设置循环模式时，可调用 SetLoopCount 接口; resource_id 从版权音乐模块 COPYRIGHTED_MUSIC 相关接口中获取

◆ 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 设置了显示控件，以及播放状态的情况下，才能正常截图。

◆ UpdatePosition()

ZEGOAVKIT_API void ZEGO::MEDIAPLAYER::UpdatePosition	(	const float	position[3],
		ZegoMediaPlayerIndex	index = `ZegoMediaPlayerIndexFirst`
	)

更新媒体播放器(音频源)位置

Parameters

position	用户的三维空间坐标
index	播放器序号，默认为 ZegoMediaPlayerIndexFirst

Note: 此接口需要与 RangeAudio/RangeScene 模块配合使用，RangeAudio/RangeScene 模块开启 3D 音效后，此接口才能调用成功; 此接口需要在 CreatePlayer 后，DestroyPlayer 前调用

Classes

Enumerations

Functions

Enumeration Type Documentation

◆ ZegoLiveAudioEffectMode

◆ ZegoMediaPlayerAudioChannel

◆ ZegoMediaPlayerAudioTrackMode

◆ ZegoMediaPlayerError

◆ ZegoMediaPlayerIndex

◆ ZegoMediaPlayerType

◆ ZegoMediaPlayerVideoPixelFormat

◆ ZegoMediaStreamType

◆ ZegoMultimediaLoadType

Function Documentation

◆ AttachToPublishChannel()

◆ ClearView()

◆ CreatePlayer()

◆ DestroyPlayer()

◆ EnableAccurateSeek()

◆ EnableFrequencySpectrumMonitor()

◆ EnableLiveAudioEffect()

◆ EnableLocalCache()

◆ EnableRepeatMode()

◆ EnableSoundLevelMonitor()

◆ EnableViewMirror()

◆ GetAudioStreamCount()

◆ GetCurrentDuration()

◆ GetCurrentRenderingDuration()

◆ GetDuration()

◆ GetMediaInfo()

◆ GetMetaDataValue()

◆ GetOnlineResourceCacheStat()

◆ GetPlaybackStatistics()

◆ GetPlayVolume()

◆ GetPublishVolume()

◆ InitWithType()

◆ Load() [1/4]

◆ Load() [2/4]

◆ Load() [3/4]

◆ Load() [4/4]

◆ LoadCopyrightedMusic()

◆ MuteLocal()

◆ Pause()

◆ RequireHWDecoder()

◆ Resume()

◆ SeekTo()

◆ SetAccurateSeekTimeout()

◆ SetActiveAudioChannel()

◆ SetAudioChannelKeyShift()

◆ SetAudioDataCallback()

◆ SetAudioPublishStream()

◆ SetAudioStream()

◆ SetAudioTrackMode()

◆ SetBackgroundColor()

◆ SetBlockDataCallback()

◆ SetBufferThreshold()

◆ SetEventWithIndexCallback()

◆ SetHttpHeaders()

◆ SetLoadResourceTimeout()

◆ SetLoopCount()

◆ SetMediaPlayerFileReader()

◆ SetMediaSideInfoCallback()

◆ SetOnlineResourceCache()

◆ SetPlayerType()

◆ SetPlayMediaStreamType()

◆ SetPlaySpeed()

◆ SetPlayVolume()

◆ SetProcessInterval()

◆ SetPublishVolume()

◆ SetSoundInfoCallback()

◆ SetVideoDataWithIndexCallback()

◆ SetView() [1/2]

◆ SetView() [2/2]

◆ SetViewMode()

◆ SetVolume()

◆ Start() [1/4]

◆ Start() [2/4]

◆ Start() [3/4]

◆ Start() [4/4]

◆ StartCopyrightedMusic()