floo::BMXVoiceAttachment#

音频消息附件

#include <bmx_voice_attachment.h>

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

Public Functions#

	Name
	BMXVoiceAttachment(const std::string & path, int duration, const std::string & displayName ="") 构造函数，构建发送音频消息附件
	BMXVoiceAttachment(const std::string & ratelUrl, int duration, const std::string & displayName, int64_t fileLength) 构造函数，构建接收音频消息附件
virtual	~BMXVoiceAttachment() 析构函数
virtual Type	type() const 返回文件类型
virtual BMXMessageAttachmentPtr	clone() const 克隆函数
int32_t	duration() const 语音时长

Friends#

	Name
class	Encoder< BMXVoiceAttachment >
class	Decoder< BMXVoiceAttachment >

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	downloadStatus() const 附件下载状态

Protected Attributes inherited from floo::BMXFileAttachment

	Name
std::string	mPath
std::string	mDisplayName
std::string	mRatelUrl
std::string	mUrl
int64_t	mFileLength
DownloadStatus	mDownloadStatus

Friends inherited from floo::BMXFileAttachment

	Name
class	Encoder< BMXFileAttachment >
class	Decoder< 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 BMXVoiceAttachment#

BMXVoiceAttachment(
    const std::string & path,
    int duration,
    const std::string & displayName =""
)

构造函数，构建发送音频消息附件

Parameters:

path 文件的本地路径
duration 音频时长
displayName 文件展示名

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXVoiceAttachment",function="BMXVoiceAttachment" %}{% endlanying_code_snippet %}

function BMXVoiceAttachment#

BMXVoiceAttachment(
    const std::string & ratelUrl,
    int duration,
    const std::string & displayName,
    int64_t fileLength
)

构造函数，构建接收音频消息附件

Parameters:

ratelUrl ratel文件服务器地址
duration 音频时长
displayName 文件展示名
fileLength 文件大小

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXVoiceAttachment",function="BMXVoiceAttachment" %}{% endlanying_code_snippet %}

function ~BMXVoiceAttachment#

inline virtual ~BMXVoiceAttachment()

析构函数

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXVoiceAttachment",function="~BMXVoiceAttachment" %}{% endlanying_code_snippet %}

function type#

inline virtual Type type() const

返回文件类型

Return: Type

Reimplements: floo::BMXFileAttachment::type

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXVoiceAttachment",function="type" %}{% endlanying_code_snippet %}

function clone#

virtual BMXMessageAttachmentPtr clone() const

克隆函数

Return: BMXMessageAttachmentPtr

Reimplements: floo::BMXFileAttachment::clone

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXVoiceAttachment",function="clone" %}{% endlanying_code_snippet %}

function duration#

int32_t duration() const

语音时长

Return: int32_t

Friends#

friend Encoder< BMXVoiceAttachment >#

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

friend Decoder< BMXVoiceAttachment >#

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

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXVoiceAttachment",function="duration" %}{% endlanying_code_snippet %}

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