跳到主要内容

download

功能描述

  • SDK 提供多媒体文件的下载、取消、暂停功能。
  • 多媒体消息的发送,请参见消息发送 中的「发送媒体消息」部分。

下载多媒体消息

下载多媒体文件。

方法

downloadMediaMessage(message: RCIMIWMediaMessage): Promise<number>;

参数说明

参数类型说明
messageRCIMIWMediaMessage媒体消息(FileMessage,SightMessage,GIFMessage, HQVoiceMessage 等)

代码示例

engine.downloadMediaMessage(message)
.then((code: number) => {})

回调方法

  • setOnMediaMessageDownloadingListener

    接口调用结果的监听

setOnMediaMessageDownloadingListener(listener?: (message: RCIMIWMediaMessage, progress: number) => void): void;

参数说明

参数名参数类型描述
messageRCIMIWMediaMessage媒体消息(FileMessage,SightMessage,GIFMessage, HQVoiceMessage 等)
progressnumber媒体下载进度

代码示例

engine.setOnMediaMessageDownloadingListener(
(
message: RCIMIWMediaMessage,
progress: number
) => {}
);
  • setOnMediaMessageDownloadedListener

    接口调用结果的监听

setOnMediaMessageDownloadedListener(listener?: (code: number, message: RCIMIWMediaMessage) => void): void;

参数说明

参数名参数类型描述
codenumber接口回调的状态码,0 代表成功,非 0 代表出现异常
messageRCIMIWMediaMessage媒体消息(FileMessage,SightMessage,GIFMessage, HQVoiceMessage 等)

代码示例

engine.setOnMediaMessageDownloadedListener(
(
code: number,
message: RCIMIWMediaMessage
) => {}
);

取消多媒体消息

取消多媒体消息下载。

方法

cancelDownloadingMediaMessage(message: RCIMIWMediaMessage): Promise<number>;

参数说明

参数类型说明
messageRCIMIWMediaMessage媒体消息(FileMessage,SightMessage,GIFMessage, HQVoiceMessage 等)

代码示例

main.engine.cancelDownloadingMediaMessage(
message
)
.then((code: number) => {});

回调方法

  • setOnDownloadingMediaMessageCanceledListener

    接口调用结果的监听

setOnDownloadingMediaMessageCanceledListener(listener?: (code: number, message: RCIMIWMediaMessage) => void): void;

参数说明

参数名参数类型描述
codenumber接口回调的状态码,0 代表成功,非 0 代表出现异常
messageRCIMIWMediaMessage媒体消息(FileMessage,SightMessage,GIFMessage, HQVoiceMessage 等)

代码示例

engine.setOnDownloadingMediaMessageCanceledListener(
(
code: number,
message: RCIMIWMediaMessage
) => {}
);