Video SDK for Windows API Reference
Loading...
Searching...
No Matches
IZoomVideoSDKSendFile Class Referenceabstract

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

#include <zoom_video_sdk_def.h>

Inherits IZoomVideoSDKFileTransferBaseInfo.

Public Member Functions

virtual ~IZoomVideoSDKSendFile ()
 
virtual IZoomVideoSDKUsergetReceiver ()=0
 Get the receiver of the file transfer.
 
virtual ZoomVideoSDKErrors cancelSend ()=0
 Cancel the ongoing file transfer.
 
- 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_tgetFileName ()=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 sent in the Zoom Video SDK. Inherits from IZoomVideoSDKFileTransferBaseInfo.

Definition at line 680 of file zoom_video_sdk_def.h.

Constructor & Destructor Documentation

◆ ~IZoomVideoSDKSendFile()

virtual IZoomVideoSDKSendFile::~IZoomVideoSDKSendFile ( )
inlinevirtual

Definition at line 683 of file zoom_video_sdk_def.h.

683{}

Member Function Documentation

◆ cancelSend()

virtual ZoomVideoSDKErrors IZoomVideoSDKSendFile::cancelSend ( )
pure virtual

Cancel the ongoing file transfer.

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

◆ getReceiver()

virtual IZoomVideoSDKUser * IZoomVideoSDKSendFile::getReceiver ( )
pure virtual

Get the receiver of the file transfer.

Returns
A pointer to the IZoomVideoSDKUser representing the recipient.