IZoomVideoSDKReceiveFile Class Reference

Interface for managing a file that is being received in the Zoom Video SDK. Inherits from IZoomVideoSDKFileTransferBaseInfo. More...

#include <zoom_video_sdk_def.h>

Inherits IZoomVideoSDKFileTransferBaseInfo.

Public Member Functions
virtual	~IZoomVideoSDKReceiveFile ()
virtual IZoomVideoSDKUser *	getSender ()=0
	Get the sender of the file transfer.
virtual ZoomVideoSDKErrors	cancelReceive ()=0
	Cancel the ongoing file receive operation.
virtual ZoomVideoSDKErrors	startReceive (const zchar_t *path)=0
	Start receiving the file and specify the download path.
Public Member Functions inherited from IZoomVideoSDKFileTransferBaseInfo
virtual	~IZoomVideoSDKFileTransferBaseInfo ()
virtual time_t	getTimeStamp ()=0
	Get the timestamp when the file transfer started.
virtual bool	isSendToAll ()=0
	Check whether the file was sent to all participants.
virtual uint32_t	getFileSize ()=0
	Get the size of the file in bytes.
virtual const zchar_t *	getFileName ()=0
	Get the name of the file being transferred.
virtual ZoomVideoSDKFileStatus	getStatus ()=0
	Get the current transfer status of the file.

Detailed Description

Interface for managing a file that is being received in the Zoom Video SDK. Inherits from IZoomVideoSDKFileTransferBaseInfo.

Definition at line 700 of file zoom_video_sdk_def.h.

Constructor & Destructor Documentation

~IZoomVideoSDKReceiveFile()

virtual IZoomVideoSDKReceiveFile::~IZoomVideoSDKReceiveFile ( )

inlinevirtual

Definition at line 703 of file zoom_video_sdk_def.h.

{}

Member Function Documentation

cancelReceive()

virtual ZoomVideoSDKErrors IZoomVideoSDKReceiveFile::cancelReceive ( )

pure virtual

Cancel the ongoing file receive operation.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. For detailed error codes, see the ZoomVideoSDKErrors enum.

getSender()

virtual IZoomVideoSDKUser * IZoomVideoSDKReceiveFile::getSender ( )

pure virtual

Get the sender of the file transfer.

Returns

A pointer to the IZoomVideoSDKUser representing the sender.

startReceive()

virtual ZoomVideoSDKErrors IZoomVideoSDKReceiveFile::startReceive ( const zchar_t * path )

pure virtual

Start receiving the file and specify the download path.

Parameters

path	The local file system path where the file will be saved.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. For detailed error codes, see the ZoomVideoSDKErrors enum.