floo::BMXVideoAttachment

视频消息附件

#include <bmx_video_attachment.h>

Inherits from floo::BMXFileAttachment, floo::BMXMessageAttachment, BMXBaseObject

Public Functions

Name

BMXVideoAttachment(const std::string & path, int duration, const [Size] & size, const std::string & displayName ="") 构造函数,构建发送视频消息附件

BMXVideoAttachment(const std::string & path, const std::string & thumbnailPath, int duration, const [Size] & size, const std::string & displayName ="") 构造函数,构建发送视频消息附件

BMXVideoAttachment(const std::string & ratelUrl, int duration, const [Size] & size, const std::string & displayName, int64_t fileLength) 构造函数,构建接收视频消息附件

BMXVideoAttachment(const std::string & ratelUrl, const std::string & thumbnailRatelUrl, int duration, const [Size] & size, const std::string & displayName, int64_t fileLength) 构造函数,构建接收视频消息附件

virtual

~BMXVideoAttachment() 析构函数

virtual Type

type() const 返回文件类型

virtual BMXMessageAttachmentPtr

clone() const 克隆函数

const [Size] &

size() const 视频大小,宽度和高度

int32_t

duration() const 视频片段时长

void

setThumbnail(const std::string & path) 设置发送视频片段消息缩略图

const std::string &

thumbnailPath() const 缩略图本地路径

const std::string &

thumbnailUrl() const 远程缩略图使用URL

void

setThumbnailRatelUrl(const std::string & thumbnailRatelUrl) 设置发送视频片段消息缩略图ratel服务器路径

const std::string &

thumbnailRatelUrl() const 缩略图ratel服务器路径

thumbnailDownloadStatus() const 缩略图下载状态

Friends

Additional inherited members

Public Functions inherited from floo::BMXFileAttachment

Name

BMXFileAttachment(const std::string & path, const std::string & displayName ="") 构造函数,构建发送文件消息附件

BMXFileAttachment(const std::string & ratelUrl, const std::string & displayName, int64_t fileLength) 构造函数,构建接收文件消息附件

virtual

~BMXFileAttachment() 析构函数

const std::string &

path() const 本地路径

const std::string &

displayName() const 显示名

const std::string &

ratelUrl() const 远程ratel使用URL

const std::string &

url() const 远程使用URL

int64_t

fileLength() const 文件长度

downloadStatus() const 附件下载状态

Protected Attributes inherited from floo::BMXFileAttachment

Name

std::string

std::string

std::string

std::string

Friends inherited from floo::BMXFileAttachment

Public Types inherited from floo::BMXMessageAttachment

Name

enum class

Type { Image, Voice, Video, File, Location, Command, Forward} 附件类型

enum class

DownloadStatus { Downloaing, Successed, Failed, NotStart, Canceled} 附件下载状态

Public Functions inherited from floo::BMXMessageAttachment

Name

BMXMessageAttachment() 构造函数

virtual

~BMXMessageAttachment() 析构函数

Public Functions Documentation

function BMXVideoAttachment

BMXVideoAttachment(
    const std::string & path,
    int duration,
    const Size & size,
    const std::string & displayName =""
)

构造函数,构建发送视频消息附件

Parameters:

  • path 文件的本地路径

  • duration 视频片段时长

  • size 视频大小,宽度和高度

  • displayName 文件展示名

function BMXVideoAttachment

BMXVideoAttachment(
    const std::string & path,
    const std::string & thumbnailPath,
    int duration,
    const Size & size,
    const std::string & displayName =""
)

构造函数,构建发送视频消息附件

Parameters:

  • path 文件的本地路径

  • thumbnailPath 缩略图文件的本地路径

  • duration 视频片段时长

  • size 视频大小,宽度和高度

  • displayName 文件展示名

function BMXVideoAttachment

BMXVideoAttachment(
    const std::string & ratelUrl,
    int duration,
    const Size & size,
    const std::string & displayName,
    int64_t fileLength
)

构造函数,构建接收视频消息附件

Parameters:

  • ratelUrl ratel文件服务器地址

  • duration 视频片段时长

  • size 视频大小,宽度和高度

  • displayName 文件展示名

  • fileLength 文件大小

function BMXVideoAttachment

BMXVideoAttachment(
    const std::string & ratelUrl,
    const std::string & thumbnailRatelUrl,
    int duration,
    const Size & size,
    const std::string & displayName,
    int64_t fileLength
)

构造函数,构建接收视频消息附件

Parameters:

  • ratelUrl ratel文件服务器地址

  • thumbnailRatelUrl 缩略图ratel文件服务器地址

  • duration 视频片段时长

  • size 视频大小,宽度和高度

  • displayName 文件展示名

  • fileLength 文件大小

function ~BMXVideoAttachment

inline virtual ~BMXVideoAttachment()

析构函数

function type

inline virtual Type type() const

返回文件类型

Return: Type

Reimplements: floo::BMXFileAttachment::type

function clone

virtual BMXMessageAttachmentPtr clone() const

克隆函数

Return: BMXMessageAttachmentPtr

Reimplements: floo::BMXFileAttachment::clone

function size

const Size & size() const

视频大小,宽度和高度

Return: Size

function duration

int32_t duration() const

视频片段时长

Return: int32_t

function setThumbnail

void setThumbnail(
    const std::string & path
)

设置发送视频片段消息缩略图

Parameters:

  • path 视频片段消息缩略图

function thumbnailPath

const std::string & thumbnailPath() const

缩略图本地路径

Return: std::string

function thumbnailUrl

const std::string & thumbnailUrl() const

远程缩略图使用URL

Return: std::string

function setThumbnailRatelUrl

void setThumbnailRatelUrl(
    const std::string & thumbnailRatelUrl
)

设置发送视频片段消息缩略图ratel服务器路径

Parameters:

  • thumbnailRatelUrl 视频片段消息缩略图服务器路径

function thumbnailRatelUrl

const std::string & thumbnailRatelUrl() const

缩略图ratel服务器路径

Return: std::string

function thumbnailDownloadStatus

DownloadStatus thumbnailDownloadStatus() const

缩略图下载状态

Return: DownloadStatus

Friends

friend Encoder< BMXVideoAttachment >

friend class Encoder< BMXVideoAttachment >(
    Encoder< BMXVideoAttachment > 
);

friend Decoder< BMXVideoAttachment >

friend class Decoder< BMXVideoAttachment >(
    Decoder< BMXVideoAttachment > 
);

Updated on 2022-01-26 at 17:20:40 +0800

Last updated

Was this helpful?