TXVodPlayer

java.lang.Object
- com.tencent.rtmp.TXVodPlayer

All Implemented Interfaces:: com.tencent.liteav.network.TXCVodPlayerNetListener

public class TXVodPlayer
extends java.lang.Object
implements com.tencent.liteav.network.TXCVodPlayerNetListener

Created by annidy on 2017/9/21.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface TXVodPlayer.ITXSnapshotListener
截图回调用于接收当前视频图片

Nested Classes
Modifier and Type	Class and Description
`static interface`	`TXVodPlayer.ITXSnapshotListener` 截图回调用于接收当前视频图片

Field Summary

Fields
Modifier and Type Field and Description

static int PLAYER_TYPE_EXO

static int PLAYER_TYPE_FFPLAY
播放器类型

static java.lang.String TAG

Fields
Modifier and Type	Field and Description
`static int`	`PLAYER_TYPE_EXO`
`static int`	`PLAYER_TYPE_FFPLAY` 播放器类型
`static java.lang.String`	`TAG`

Constructor Summary

Constructors
Constructor and Description

TXVodPlayer(Context context)
构造一个TXLivePlayer对象.

Constructors
Constructor and Description
`TXVodPlayer(Context context)` 构造一个TXLivePlayer对象.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`enableHardwareDecode(boolean enable)` 启用或禁用视频硬解码.
`int`	`getBitrateIndex()` 返回当前播放的码率索引
`float`	`getBufferDuration()`
`float`	`getCurrentPlaybackTime()` 获取当前播放位置
`float`	`getDuration()` 获取总时长
`int`	`getHeight()` 获取视频高度
`float`	`getPlayableDuration()` 获取可播放时长
`java.util.ArrayList<TXBitrateItem>`	`getSupportedBitrates()` 当播放地址为master playlist，返回支持的码率（清晰度）
`int`	`getWidth()` 获取视频宽度
`boolean`	`isLoop()`
`boolean`	`isPlaying()` 是否正在播放.
`void`	`onNetFailed(com.tencent.liteav.network.TXCVodPlayerNetApi netApi, java.lang.String reason, int code)` 播放信息查询失败
`void`	`onNetSuccess(com.tencent.liteav.network.TXCVodPlayerNetApi netApi)` 播放信息查询成功
`void`	`onNotifyEvent(int event, Bundle param)`
`void`	`pause()` 暂停播放,停止获取流数据,保留最后一帧画面.
`void`	`resume()` 恢复播放,重新获取流数据.
`void`	`seek(float time)` 跳转到视频流指定时间点.
`void`	`seek(int time)` 跳转到视频流指定时间点.
`void`	`setAutoPlay(boolean autoPlay)` 设置点播是否startPlay后自动开始播放。默认自动播放
`void`	`setBitrateIndex(int index)` 设置当前正在播放的码率索引，无缝切换清晰度清晰度切换可能需要等待一小段时间。腾讯云支持多码率HLS分片对齐，保证最佳体验。
`void`	`setConfig(TXVodPlayConfig config)` 设置播放器配置信息.
`void`	`setLoop(boolean loop)` 设置是否循环播放
`void`	`setMirror(boolean mirror)` 设置镜像
`void`	`setMute(boolean mute)` 设置是否静音播放.
`void`	`setPlayerView(TextureRenderView glRootView)` 设置播放器视频渲染TextureRenderView, 推荐使用TXCloudVideoView
`void`	`setPlayerView(com.tencent.rtmp.ui.TXCloudVideoView glRootView)` 设置播放器的视频渲染View.
`void`	`setRate(float rate)` 设置点播的播放速率。默认1.0
`void`	`setRenderMode(int mode)` 设置图像平铺模式.
`void`	`setRenderRotation(int rotation)` 设置图像渲染角度.
`void`	`setSurface(Surface surface)` 设置Surface，目前只支持硬解播放器只能在Surface有效的情况下才能正常工作，使用此接口播放时，需要由用户手动调用 resume() 或 pause()
`void`	`setToken(java.lang.String token)` 加密HLS的token。设置此值后，播放器自动在URL中的文件名之前增加voddrm.token.
`void`	`setVodListener(ITXVodPlayListener listener)` 设置播放器的回调.
`void`	`snapshot(TXLivePlayer.ITXSnapshotListener listener)` 获取当前视频帧图像注意：由于获取当前帧图像是比较耗时的操作，所以截图会通过异步回调出来
`int`	`startPlay(java.lang.String playUrl)` 启动播放.
`int`	`startPlay(TXPlayerAuthBuilder authBuilder)` 以fileid形式播放
`int`	`stopPlay(boolean isNeedClearLastImg)` 停止播放.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PLAYER_TYPE_EXO
```
public static final int PLAYER_TYPE_EXO
```
  - PLAYER_TYPE_FFPLAY
```
public static final int PLAYER_TYPE_FFPLAY
```
    播放器类型
  - TAG
```
public static final java.lang.String TAG
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TXVodPlayer
```
public TXVodPlayer(Context context)
```
    构造一个TXLivePlayer对象.
    
    Parameters:
    
    context - 用于系统函数调用，内部会转成ApplicationContext保存.
- Method Detail
  - enableHardwareDecode
```
public boolean enableHardwareDecode(boolean enable)
```
    启用或禁用视频硬解码.
    
    Parameters:
    
    enable - 启用或禁用视频硬解码. true:启用视频硬解码. false:禁用视频硬解码.启用默认的视频软解码.
    
    Returns:
    
    是否成功启用或禁用视频硬解码. true:启用或禁用视频硬解码成功. false:启用或禁用视频硬解码失败.
  - getBitrateIndex
```
public int getBitrateIndex()
```
    返回当前播放的码率索引
    
    Returns:
  - getBufferDuration
```
public float getBufferDuration()
```
  - getCurrentPlaybackTime
```
public float getCurrentPlaybackTime()
```
    获取当前播放位置
    
    Returns:
    
    单位秒
  - getDuration
```
public float getDuration()
```
    获取总时长
    
    Returns:
    
    单位秒
  - getHeight
```
public int getHeight()
```
    获取视频高度
    
    Returns:
  - getPlayableDuration
```
public float getPlayableDuration()
```
    获取可播放时长
    
    Returns:
    
    单位秒
  - getSupportedBitrates
```
public java.util.ArrayList<TXBitrateItem> getSupportedBitrates()
```
    当播放地址为master playlist，返回支持的码率（清晰度）
    
    在收到PLAY_EVT_PLAY_BEGIN事件后才能正确返回结果
    
    Returns:
    
    码率列表；无多码率支持返回空数组
  - getWidth
```
public int getWidth()
```
    获取视频宽度
    
    Returns:
  - isLoop
```
public boolean isLoop()
```
  - isPlaying
```
public boolean isPlaying()
```
    是否正在播放.
    
    Returns:
    
    是否正在播放. true:正在播放. false:未播放.
  - onNetFailed
```
public void onNetFailed(com.tencent.liteav.network.TXCVodPlayerNetApi netApi,
                        java.lang.String reason,
                        int code)
```
    Description copied from interface: com.tencent.liteav.network.TXCVodPlayerNetListener
    
    播放信息查询失败
    
    Specified by:
    
    onNetFailed in interface com.tencent.liteav.network.TXCVodPlayerNetListener
    
    reason - 失败原因
    
    code - 错误码
  - onNetSuccess
```
public void onNetSuccess(com.tencent.liteav.network.TXCVodPlayerNetApi netApi)
```
    Description copied from interface: com.tencent.liteav.network.TXCVodPlayerNetListener
    
    播放信息查询成功
    
    Specified by:
    
    onNetSuccess in interface com.tencent.liteav.network.TXCVodPlayerNetListener
  - onNotifyEvent
```
public void onNotifyEvent(int event,
                          Bundle param)
```
  - pause
```
public void pause()
```
    暂停播放,停止获取流数据,保留最后一帧画面.
  - resume
```
public void resume()
```
    恢复播放,重新获取流数据.
    
    点播从pause位置开始播放,直播从当前开始播放实时画面.
  - seek
```
public void seek(float time)
```
    跳转到视频流指定时间点.
    
    可实现视频快进,快退,进度条跳转等功能.
    
    Parameters:
    
    time - 视频流时间点,小数点后为毫秒
  - seek
```
public void seek(int time)
```
    跳转到视频流指定时间点.
    
    可实现视频快进,快退,进度条跳转等功能.
    
    Parameters:
    
    time - 视频流时间点,单位为秒
  - setAutoPlay
```
public void setAutoPlay(boolean autoPlay)
```
    设置点播是否startPlay后自动开始播放。默认自动播放
    
    Parameters:
    
    autoPlay -
  - setBitrateIndex
```
public void setBitrateIndex(int index)
```
    设置当前正在播放的码率索引，无缝切换清晰度清晰度切换可能需要等待一小段时间。腾讯云支持多码率HLS分片对齐，保证最佳体验。
    
    Parameters:
    
    index -
    
    See Also:
    
    TXBitrateItem.index
  - setConfig
```
public void setConfig(TXVodPlayConfig config)
```
    设置播放器配置信息.
    
    推荐在启动播放前设置配置信息.
    
    Parameters:
    
    config - 播放器配置信息.配置信息请参考 TXVodPlayConfig.
  - setLoop
```
public void setLoop(boolean loop)
```
    设置是否循环播放
    
    Parameters:
    
    loop -
  - setMirror
```
public void setMirror(boolean mirror)
```
    设置镜像
    
    Parameters:
    
    mirror -
  - setMute
```
public void setMute(boolean mute)
```
    设置是否静音播放.
    
    Parameters:
    
    mute - 是否静音播放. true:静音播放. false:不静音播放.
  - setPlayerView
```
public void setPlayerView(TextureRenderView glRootView)
```
    设置播放器视频渲染TextureRenderView, 推荐使用TXCloudVideoView
    仅当使用TXCloudVideoView不开用时（比如RN下使用），才可考虑直接使用TextureRenderView。使用TextureRenderView会导致log显示不可用。
    
    Parameters:
    
    glRootView - 视频渲染TextureRenderView
  - setPlayerView
```
public void setPlayerView(com.tencent.rtmp.ui.TXCloudVideoView glRootView)
```
    设置播放器的视频渲染View.
    
    仅仅在启动播放之前设置有效.
    
    Parameters:
    
    glRootView - 视频渲染view.
  - setRate
```
public void setRate(float rate)
```
    设置点播的播放速率。默认1.0
    
    Parameters:
    
    rate -
  - setRenderMode
```
public void setRenderMode(int mode)
```
    设置图像平铺模式.
    
    Parameters:
    
    mode - 图像平铺模式.请参考图像平铺模式.
  - setRenderRotation
```
public void setRenderRotation(int rotation)
```
    设置图像渲染角度.
    
    Parameters:
    
    rotation - 图像渲染角度.请参考图像渲染角度.
  - setSurface
```
public void setSurface(Surface surface)
```
    设置Surface，目前只支持硬解播放器只能在Surface有效的情况下才能正常工作，使用此接口播放时，需要由用户手动调用 resume() 或 pause()
    
    Parameters:
    
    surface - 视频渲染surface
  - setToken
```
public void setToken(java.lang.String token)
```
    加密HLS的token。设置此值后，播放器自动在URL中的文件名之前增加voddrm.token.
    
    Parameters:
    
    token -
  - setVodListener
```
public void setVodListener(ITXVodPlayListener listener)
```
    设置播放器的回调.
    
    Parameters:
    
    listener - 播放器回调,请参考类ITXVodPlayListener
  - snapshot
```
public void snapshot(TXLivePlayer.ITXSnapshotListener listener)
```
    获取当前视频帧图像注意：由于获取当前帧图像是比较耗时的操作，所以截图会通过异步回调出来
    
    Parameters:
    
    listener - 截图回调
  - startPlay
```
public int startPlay(java.lang.String playUrl)
```
    启动播放.
    
    Parameters:
    
    playUrl - 播放的流地址.
    
    Returns:
    
    是否成功启动播放. 0: 成功. -1: 失败,rtmpUrl为空.
  - startPlay
```
public int startPlay(TXPlayerAuthBuilder authBuilder)
```
    以fileid形式播放
    
    Parameters:
    
    authBuilder -
    
    Returns:
  - stopPlay
```
public int stopPlay(boolean isNeedClearLastImg)
```
    停止播放.
    
    Parameters:
    
    isNeedClearLastImg - 是否需要清除最后一帧画面. true:清除最后一帧画面.正常停止播放时,推荐清除. false:保留最后一帧画面.异常停止播放(如网络异常,导致播放被迫停止),而SDK使用者希望重连服务器,继续播放时,推荐保留.
    
    Returns:
    
    是否成功停止播放. 0:成功. 非0:失败.

Class TXVodPlayer

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PLAYER_TYPE_EXO

PLAYER_TYPE_FFPLAY

TAG

Constructor Detail

TXVodPlayer

Method Detail

enableHardwareDecode

getBitrateIndex

getBufferDuration

getCurrentPlaybackTime

getDuration

getHeight

getPlayableDuration

getSupportedBitrates

getWidth

isLoop

isPlaying

onNetFailed

onNetSuccess

onNotifyEvent

pause

resume

seek

seek

setAutoPlay

setBitrateIndex

setConfig

setLoop

setMirror

setMute

setPlayerView

setPlayerView

setRate

setRenderMode

setRenderRotation

setSurface

setToken

setVodListener

snapshot

startPlay

startPlay

stopPlay