VideoContent (android API)

java.lang.Object
- cn.jpush.im.android.api.content.MessageContent
- - cn.jpush.im.android.api.content.CompoundContent
  - - cn.jpush.im.android.api.content.VideoContent

所有已实现的接口:

java.lang.Cloneable
```
public class VideoContent
extends CompoundContent
```
视频类型消息体

从以下版本开始:

2.6.0

构造器概要

构造器
构造器和说明
`VideoContent(android.graphics.Bitmap thumbImg, java.lang.String thumbFormat, java.io.File videoFile, java.lang.String videoFileName, int duration)` 创建一个视频消息内容类型。

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`autoDownloadWhenMsgReceived(Message message, DownloadCompletionCallback callback)` SDK内部使用，上层无需关心
`void`	`cancelDownload(Message message)` 取消下载,手动下载后可调用此接口取消下载, 注意可以自动下载的文件不可取消是否取消成功需要根据下载的回调来判断,如果取消成功，下载回调中错误码为`ErrorCode.LOCAL_ERROR#LOCAL_OPERATION_CANCELLED`
`void`	`clearLocalInfosWhenSend()` SDK内部使用，上层无需关心
`java.lang.Object`	`clone()`
`void`	`downloadThumbImage(Message message, DownloadCompletionCallback callback)` 下载视频消息的缩略图（如果视频消息发送者有指定的话）对于用户在线期间收到的视频消息：sdk会在接收到视频消息时自动下载缩略图文件。
`void`	`downloadVideoFile(Message message, DownloadCompletionCallback callback)` 下载视频消息中的视频文件,下载过程中如果想取消调用`cancelDownload(Message)` 注意：sdk收到文件消息后，不会自动下载视频文件附件，需要用户主动调用此接口完成下载。
`int`	`getDuration()` 获取视频文件时长
`java.lang.String`	`getFileName()` 获取视频的自定义文件名
`java.lang.String`	`getFormat()` 获取视频文件后缀名
`long`	`getMediaFileSize()` 获取视频文件对应文件大小
`java.lang.Number`	`getThumbCrc32()`
`java.lang.String`	`getThumbFormat()` 获取视频缩略图格式
`long`	`getThumbFsize()` 获取视频缩略图文件大小
`java.lang.String`	`getThumbHash()`
`int`	`getThumbHeight()` 获取视频缩略图宽度
`java.lang.String`	`getThumbLocalPath()` 获取视频缩略图文件本地路径。
`java.lang.String`	`getThumbMediaId()` 获取视频缩略图唯一资源标识
`java.lang.String`	`getThumbResourceId()`
`int`	`getThumbWidth()` 获取视频缩略图高度
`java.lang.String`	`getVideoLocalPath()` 获取视频文件本地路径。
`java.lang.String`	`getVideoMediaID()` 获取视频文件在sdk内部对应的唯一资源id
`boolean`	`isUploadFinished()` SDK内部使用，上层无需关心
`boolean`	`needAutoDownloadWhenRecv()`
`java.util.List<UploadObject>`	`ObjectsNeedUpload()` SDK内部使用，上层无需关心
`void`	`setUploadFinish(boolean isUploadFinish)` SDK内部使用，上层无需关心

从类继承的方法 cn.jpush.im.android.api.content.MessageContent
fromJson, getBooleanExtra, getBooleanExtras, getContentType, getNumberExtra, getNumberExtras, getStringExtra, getStringExtras, setBooleanExtra, setExtras, setNumberExtra, setStringExtra, toJson, toJsonElement

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - VideoContent
```
public VideoContent(android.graphics.Bitmap thumbImg,
                    java.lang.String thumbFormat,
                    java.io.File videoFile,
                    java.lang.String videoFileName,
                    int duration)
             throws java.io.IOException
```
    创建一个视频消息内容类型。
    
    参数:
    
    thumbImg - 视频缩略图，可以为空
    
    thumbFormat - 视频缩略图格式，可以不填
    
    videoFile - 视频文件对象
    
    videoFileName - 视频文件自定义文件名
    
    duration - 视频时长
    
    抛出:
    
    java.io.IOException - 如果视频文件不存在或者读取失败则抛此异常
- 方法详细资料
  - getDuration
```
public int getDuration()
```
    获取视频文件时长
    
    返回:
    
    视频文件的时长
  - getThumbResourceId
```
public java.lang.String getThumbResourceId()
```
  - getThumbMediaId
```
public java.lang.String getThumbMediaId()
```
    获取视频缩略图唯一资源标识
    
    返回:
    
    返回null如果视频缩略图不存在
  - getThumbCrc32
```
public java.lang.Number getThumbCrc32()
```
  - getThumbHash
```
public java.lang.String getThumbHash()
```
  - getThumbFormat
```
public java.lang.String getThumbFormat()
```
    获取视频缩略图格式
    
    返回:
    
    返回null如果视频缩略图不存在
  - getThumbWidth
```
public int getThumbWidth()
```
    获取视频缩略图高度
    
    返回:
    
    返回0如果视频缩略图不存在
  - getThumbHeight
```
public int getThumbHeight()
```
    获取视频缩略图宽度
    
    返回:
    
    返回0如果视频缩略图不存在
  - getThumbFsize
```
public long getThumbFsize()
```
    获取视频缩略图文件大小
    
    返回:
    
    返回0如果视频缩略图不存在
  - getThumbLocalPath
```
public java.lang.String getThumbLocalPath()
```
    获取视频缩略图文件本地路径。
    收到视频消息之后，如果消息中有带缩略图。sdk会主动触发缩略图的下载。
    但是当sdk主动下载失败，消息状态为MessageStatus.receive_fail时，此接口将返回null。此时需要上层主动调用downloadThumbImage(Message, DownloadCompletionCallback)接口去再次尝试下载视频缩略图
    
    返回:
    
    视频缩略图在本地的路径
  - getVideoLocalPath
```
public java.lang.String getVideoLocalPath()
```
    获取视频文件本地路径。
    收到视频消息后，sdk不会主动触发视频文件的下载。此时接口返回null 需要上层主动调用downloadVideoFile(Message, DownloadCompletionCallback)接口触发下载。
    下载成功之后通过此接口可以获取到视频文件本地的地址
    
    返回:
    
    视频文件在本地的路径
  - getVideoMediaID
```
public java.lang.String getVideoMediaID()
```
    获取视频文件在sdk内部对应的唯一资源id
    
    返回:
  - getMediaFileSize
```
public long getMediaFileSize()
```
    获取视频文件对应文件大小
    
    返回:
  - getFormat
```
public java.lang.String getFormat()
```
    获取视频文件后缀名
    
    返回:
  - getFileName
```
public java.lang.String getFileName()
```
    获取视频的自定义文件名
    
    返回:
  - downloadThumbImage
```
public void downloadThumbImage(Message message,
                               DownloadCompletionCallback callback)
```
    下载视频消息的缩略图（如果视频消息发送者有指定的话）
    对于用户在线期间收到的视频消息：sdk会在接收到视频消息时自动下载缩略图文件。
    对于离线期间批量收到的视频消息：sdk会主动下载最新20条消息中视频消息的缩略图文件。
    仅当自动下载失败，消息状态为receive_fail时，需要用户调用此接口手动下载缩略图。
    
    参数:
    
    message - 视频消息对象
    
    callback - 下载完成后的回调接口
  - downloadVideoFile
```
public void downloadVideoFile(Message message,
                              DownloadCompletionCallback callback)
```
    下载视频消息中的视频文件,下载过程中如果想取消调用cancelDownload(Message)
    注意：sdk收到文件消息后，不会自动下载视频文件附件，需要用户主动调用此接口完成下载。
    
    参数:
    
    message - 视频消息对象
    
    callback - 下载完成时的回调接口
  - ObjectsNeedUpload
```
public java.util.List<UploadObject> ObjectsNeedUpload()
```
    从类复制的说明: CompoundContent
    
    SDK内部使用，上层无需关心
    
    指定者:
    
    ObjectsNeedUpload 在类中 CompoundContent
    
    返回:
  - isUploadFinished
```
public boolean isUploadFinished()
```
    从类复制的说明: CompoundContent
    
    SDK内部使用，上层无需关心
    
    指定者:
    
    isUploadFinished 在类中 CompoundContent
    
    返回:
  - setUploadFinish
```
public void setUploadFinish(boolean isUploadFinish)
```
    从类复制的说明: CompoundContent
    
    SDK内部使用，上层无需关心
    
    指定者:
    
    setUploadFinish 在类中 CompoundContent
  - needAutoDownloadWhenRecv
```
public boolean needAutoDownloadWhenRecv()
```
    指定者:
    
    needAutoDownloadWhenRecv 在类中 MessageContent
  - autoDownloadWhenMsgReceived
```
public void autoDownloadWhenMsgReceived(Message message,
                                        DownloadCompletionCallback callback)
```
    从类复制的说明: CompoundContent
    
    SDK内部使用，上层无需关心
    
    指定者:
    
    autoDownloadWhenMsgReceived 在类中 CompoundContent
  - clearLocalInfosWhenSend
```
public void clearLocalInfosWhenSend()
```
    从类复制的说明: CompoundContent
    
    SDK内部使用，上层无需关心
    
    指定者:
    
    clearLocalInfosWhenSend 在类中 CompoundContent
  - cancelDownload
```
public void cancelDownload(Message message)
```
    从类复制的说明: MessageContent
    
    取消下载,手动下载后可调用此接口取消下载, 注意可以自动下载的文件不可取消
    是否取消成功需要根据下载的回调来判断,如果取消成功，下载回调中错误码为ErrorCode.LOCAL_ERROR#LOCAL_OPERATION_CANCELLED
    
    指定者:
    
    cancelDownload 在类中 MessageContent
    
    参数:
    
    message - 该Content所对应的消息对象
  - clone
```
public java.lang.Object clone()
```
    覆盖:
    
    clone 在类中 MessageContent

类 VideoContent

构造器概要

方法概要

从类继承的方法 cn.jpush.im.android.api.content.MessageContent

从类继承的方法 java.lang.Object

构造器详细资料

VideoContent

方法详细资料

getDuration

getThumbResourceId

getThumbMediaId

getThumbCrc32

getThumbHash

getThumbFormat

getThumbWidth

getThumbHeight

getThumbFsize

getThumbLocalPath

getVideoLocalPath

getVideoMediaID

getMediaFileSize

getFormat

getFileName

downloadThumbImage

downloadVideoFile

ObjectsNeedUpload

isUploadFinished

setUploadFinish

needAutoDownloadWhenRecv

autoDownloadWhenMsgReceived

clearLocalInfosWhenSend

cancelDownload

clone