Android
本文是Android播放器SDK的 api文档
| 播放器类 | 说明 |
|---|---|
| MgtvVideoView | 点播播放器 |
| MgtvVideoView | 点播播放器 |
| MgtvSuperVideoView | 超级播放器 |
| MgtvAudioView | 音频播放器 |
接口方法¶
setReadDataSourceType¶
本方法用于设置数据源类型。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| type | 数据源类型 | DATASOURCE_NORMAL 以path参数作为数据源；READ_DATASOURCE_TYPE_PROXY 以proxypath作为数据源 ；READ_DATASOURCE_TYPE_P2P_DIRECT 自研数据模块直连方，直接从自研数据模块读取数据，不通过代理层。 |
提示
请在setVideoPath或者resetVideoPath之前设置。READ_DATASOURCE_TYPE_PROXY和DATASOURCE_NORMAL仅表示从不同的参数作为数据url，不表示实际使用的是代理还是原始地址。
示例
setReadDataSourceType(DATASOURCE_NORMAL)
getReadDataSourceType¶
本方法用于获取当前数据源类型。
setVideoPath()¶
本方法用于设置播放地址。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| path | String | 数据源地址 |
示例
setVideoPath("http://test.mgtv.com/1.mp4")
resetVideoPath()¶
本方法用于重新设置设置播放地址。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| path | String | 数据源地址 |
示例
resetVideoPath("http://test.mgtv.com/1.mp4")
setAudioPath()¶
本方法用于在音频模式下，设置音频地址。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| path | String | 数据源地址 |
示例
setAudioPath("http://test.mgtv.com/1.mp3")
setVideoDataSource()¶
本方法用于设置播放数据结构体，用于m3u8快速起播场景。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| dataSource | MgtvPlayerDataSource | 数据源结构体 |
reset()¶
本方法用于重置播放器
提示
不退出播放页切换片源调用reset()进行重置，继续调用resetVideoPath()重新设置播放源
release()¶
本方法用于释放播放器,退出播放页面时调用。
start()¶
本方法用于设置播放地址后，开始播放。
pause()¶
本方法用于暂停播放，恢复播放调用start()。
stop()¶
本方法用于停止当前播放。
seekTo()¶
本方法用于seek到指定时间点开始播放。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| pos | int | 时间点，单位ms |
| enableACC | boolean | 精准seek开关，可选参数 |
getDuration()¶
本方法用于获取视频/音频媒资时长，单位ms，类型int。
getCurrentPosition()¶
本方法用于获取当前播放的时间点，单位ms，类型int。
getCurrentPositionUnsafe()¶
本方法用于线程非安全状态下，获取当前播放的时间点，单位ms，类型int。
isPlaying()¶
本方法用于获取播放状态是否是playing，返回值类型为boolean。
isPrepared()¶
本方法用于获取播放状态是否是prepared，返回值类型为boolean。
isRendered()¶
本方法用于获取播放首帧是否已渲染，返回值类型为boolean。
isCompletion()¶
本方法用于获取播放状态是否是complated，返回值类型为boolean。
getBufferingPercentage()¶
本方法用于获取当前缓冲进度，单位int。
getTotalBuffering()¶
本方法用于获取当前缓冲播放时长，单位ms，类型int。
getBufferedPositionMs()¶
本方法用于获取当前缓冲到的播放位置，单位ms，类型int。
resetRender()¶
本方法用于reset播放器且重置渲染view。
isOnlyAudioMode()¶
本方法用于获取播放源是否是音频（是否通过setAudioPath()设置播放数据源），返回值类型为boolean。
setTimeout()¶
本方法用于设置媒资请求的网络连接超时时间、以及读取媒资数据超时时间。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| networkConnectMillis | int | 媒资网络连接超时时间，单位ms |
| dataReceiveMillis | boolean | 媒资读取数据连接超时时间，单位ms |
setConnectTimeOut()¶
本方法用于设置媒资请求的网络连接超时时间。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| networkConnectMillis | int | 媒资网络连接超时时间，单位ms |
setReciveDataTimeOut()¶
本方法用于设置媒资读取数据连接超时时间。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| dataReceiveMillis | int | 媒资读取数据连接超时时间，单位ms |
setBufferTimeout()¶
本方法用于缓冲超时时间。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| buffertimeout | int | 媒资缓冲超时时间，单位ms |
setNETIsBroken()¶
本方法用于设置网络连接中断。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| broken | boolean | 网络状态是否中断 |
setPlayerDebug()¶
本方法用于设置播放器的debug状态。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| enable | boolean | 是否处于debug状态，输出debug info log |
setPlayerHardwareMode()¶
本方法用于设置解码模式为硬解码。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| enable | boolean | 解码模式是否为硬解码 |
setForceDecodeMode()¶
本方法用于设置强制硬解码，即硬解码失败不会走兜底策略转为软解码。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| enable | boolean | 解码模式是否为强制硬解码 |
isHardware()¶
本方法用于获取当前解码模式是否为硬解码，返回值类型boolean。
getPlayerVersion()¶
本方法用于获取当前播放器版本号，返回值类型String。
getVideoWidth()/getVideoHeight()¶
本方法用于获取视频媒资宽/高，返回值类型int。
getBitRate()¶
本方法用于获取媒资码率，返回值类型int。
getFPS()¶
本方法用于获取媒资帧率，返回值类型int。
setZOrderMediaOverlay()¶
本方法用于设置播放器Surfaceview渲染view在Z轴的优先级。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| isMediaOverlay | boolean | 当前播放器是否在Z轴最上层，两个播放器重叠时，调用该方法来进行显示遮挡 |
cleanUri()¶
本方法用于重置播放uri。
setRenderViewVisible()¶
本方法用于设置播放器渲染view的可见性。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| visible | boolean | 当前播放器渲染view的可见性 |
setVideoIntroduction()¶
本方法用于设置一层接口的videoIntroduction字段信息。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| videoIntroduction | String | 一层接口下发的videoIntroduction |
openImgoDSModule()¶
本方法用于设置IMGO数据模块开关。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| enable | boolean | IMGO数据模块开关 |
isImgoSourceModuleOpen()¶
本方法用于获取IMGO数据模块开关，返回值类型boolean。
resumeLoadData()/pauseLoadData()¶
本方法用于恢复/暂停播放器下载播放数据。
setPlaybackSpeed()¶
本方法用于设置播放倍速值。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| speed | float | 播放倍速值 |
getPlaybackSpeed()¶
本方法用于获取当前播放倍速值，返回值类型float。
isSupportedSnapshot()¶
本方法用于获取当前播放是否支持截图，返回值类型boolean。
isSnapshotSupportAsync()¶
本方法用于获取当前播放是否支持异步方式，返回值类型boolean。
getSnapshot()¶
本方法用于同步获取截图，返回值Bitmap。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| w | int | 目标截图宽度，如获取源视频宽度可传-1 |
| h | int | 目标截图高度，如获取源视频高度可传-1 |
getSnapshotAsync()¶
本方法用于异步获取截图。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| w | int | 目标截图宽度，如获取源视频宽度可传-1 |
| h | int | 目标截图高度，如获取源视频高度可传-1 |
| listener | MgtvPlayerListener.OnSnapshotListener | 异步监听器 |
isAccurateSeekEnable()¶
本方法用于获取是否打开精准seek，返回值类型boolean。
setVolume()¶
本方法用于设置音量。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| leftVolume | float | 左声道音量值，0-1范围float |
| rightVolume | float | 右声道音量值，0-1范围float |
getCurrentStatus()¶
本方法用于获取播放器当前状态，返回值类型int。
setScreenOnWhilePlaying()¶
本方法用于设置屏幕常亮。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| enable | boolean | 是否屏幕常亮 |
startRecord()¶
本方法用于开始录制视频。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| filePath | String | 录制的视频媒资存储路径 |
stopRecord()¶
本方法用于结束录制视频。
isRecording()¶
本方法用于获取是否正在录制视频，返回值类型boolean。
getRenderView()¶
本方法用于获取当前渲染view，返回值类型View。
setAspectRatio()¶
本方法用于设置当前画幅比例。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| aspectRatio | int | 画幅比例枚举 |
setRenderFilter()¶
本方法用于设置渲染滤镜。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| renderFilter | RenderFilter | 滤镜结构体 |
getRenderFilter()¶
本方法用于获取当前渲染滤镜，返回值类型RenderFilter。
setStartPosMs()¶
本方法用于设置起播时间点。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| startPosMs | int | 起播时间点，单位ms |
getVideoPath()¶
本方法用于获取当前播放链接，返回值类型String。
getCurrentUri()¶
本方法用于获取当前播放Uri，返回值类型Uri。
getVideoProxyPath()¶
本方法用于获取代理播放链接，返回值类型String。
getLastIP()¶
本方法用于获取最后一次播放器网络请求解析的IP值，返回值类型String。
getMediaPlayer()¶
本方法用于获取播放器对象，返回值类型MgtvMediaPlayer。
setBackPlayEnable()¶
本方法用于设置后台播放开关。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| enable | boolean | 后台播放开关 |
isBackPlayEnable()¶
本方法用于获取后台播放开关，返回值类型boolean。
enableMediaCodecSW()¶
本方法用于设置软渲染开关。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| enable | boolean | 软渲染开关 |
isMediaCodecSWEnable()¶
本方法用于获取软渲染开关，返回值类型boolean。
setBackground()¶
本方法用于设置播放页面是否进入后台。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| background | boolean | 是否进入后台 |
isBackground()¶
本方法用于获取当前播放是否在后台，返回值类型boolean。
supportMaxSpeed()¶
本方法用于获取当前播放支持的最高播放倍速，返回值类型float。
setOnPreparedListener()¶
本方法用于设置播放状态prepared监听。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| l | IVideoView.OnPreparedListener | prepared监听器 |
setOnCompletionListener()¶
本方法用于设置播放状态complete监听。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| l | IVideoView.OnCompletionListener | complete监听器 |
setOnSeekCompleteListener()¶
本方法用于设置seek完成监听。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| l | IVideoView.OnSeekCompleteListener | seek完成监听器 |
setOnErrorListener()¶
本方法用于设置error事件监听。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| l | IVideoView.OnErrorListener | error事件监听器 |
setOnInfoListener()¶
本方法用于设置Info事件监听。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| l | IVideoView.OnInfoListener | info事件监听器 |
setOnStartListener()¶
本方法用于设置开始播放事件监听。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| l | IVideoView.OnStartListener | 开始播放事件监听器 |
setOnPauseListener()¶
本方法用于设置暂停播放事件监听。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| l | IVideoView.OnPauseListener | 暂停播放事件监听器 |
setSurfaceHolderListener()¶
本方法用于设置渲染句柄SurfaceHolder事件监听。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| l | IVideoView.SurfaceHolderListener | 渲染句柄SurfaceHolder事件监听器 |
setOnBufferingUpdateListener()¶
本方法用于设置缓冲进度更新事件监听。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| l | IVideoView.OnBufferingUpdateListener | 缓冲进度更新事件监听器 |
setOnWarningListener()¶
本方法用于设置警告事件监听。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| l | MgtvPlayerListener.OnWarningListener | 告警事件监听器 |
setOnChangeSourceListener()¶
本方法用于设置播放切源事件监听。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| l | IVideoView.OnChangeSourceListener | 播放切源事件监听器 |
setOnRecordListener()¶
本方法用于设置录屏事件监听。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| l | IVideoView.OnRecordListener | 录屏事件监听器 |
setOnVideoSizeChangedListener()¶
本方法用于设置视频size change事件监听。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| l | IVideoView.OnVideoSizeChangedListener | 视频size change事件监听器 |
setOnFrameListener()¶
本方法用于设置视频帧渲染事件监听。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| l | IVideoView.OnFrameListener | 视频帧渲染事件监听器 |
setOnSwitchSmoothSourceListener()¶
本方法用于设置无缝切换视频源事件监听。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| l | IVideoView.OnSwitchSmoothSourceListener | 无缝切换视频源事件监听器 |
setOnInfoStringListener()¶
本方法用于设置String类info消息监听。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| l | IVideoView.OnInfoStringListener | String类info消息监听器 |
setOnEventInfoListener()¶
本方法用于设置播放内核消息监听。
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| l | IVideoView.OnEventInfoListener | 播放内核消息监听器 |