Class useFile

useFile provides methods to upload files to and retrieve files from VideoSDK’s temporary file storage.

Index

Constructors

Methods

fetchBase64File uploadBase64File

Constructors

constructor

new useFile(): useFile

Returns useFile

Methods

fetchBase64File

fetchBase64File(options: { token: string; url: string }): Promise<string>
- This method can be used to retrieve a previously uploaded file from VideoSDK's temporary storage.
- The returned value is a Base64-encoded string.
Parameters
- options: { token: string; url: string }
  - token: string
    
    VideoSDK authentication token.
  - url: string
    
    The file URL returned by uploadBase64File().
Returns Promise<string>
A Base64-encoded string of the requested file.
Throws
- Errors.ERROR_INVALID_PARAMETER — missing or invalid options (url / token)
- Errors.ERROR_FILE_FETCH_FAILED — server rejected the fetch request
Example
```
const { fetchBase64File } = useFile();

async function fetchFile() {
  const url = "<FILE_URL>";
  const token = "<VIDEOSDK_TOKEN>";

  try {
    const base64 = await fetchBase64File({ url, token });
    console.log("base64:", base64);
  } catch (err) {
    console.log("fetchBase64File failed", err);
  }
}
```
- Defined in useFile.d.ts:89

uploadBase64File

uploadBase64File(
options: { base64Data: string; fileName: string; token: string },
): Promise<string>
- This method can be used to upload a file to VideoSDK's temporary storage.
- This method returns a fileUrl, which can later be used to retrieve the uploaded file.
Parameters
- options: { base64Data: string; fileName: string; token: string }
  - base64Data: string
    
    Base64-encoded representation of the file.
  - fileName: string
    
    Name of the file including its extension.
  - token: string
    
    VideoSDK authentication token. Learn more about tokens here.
Returns Promise<string>
Throws
- Errors.ERROR_INVALID_PARAMETER — missing or invalid options (base64Data / token / fileName)
- Errors.ERROR_FILE_UPLOAD_FAILED — server rejected the upload request
Example
```
const { uploadBase64File } = useFile();

async function uploadFile() {
  const base64Data = "<YOUR_FILE_BASE64_DATA>";
  const token = "<VIDEOSDK_TOKEN>";
  const fileName = "myImage.jpeg";

  try {
    const url = await uploadBase64File({
      base64Data,
      token,
      fileName,
    });

    console.log("fileUrl:", url);
  } catch (err) {
    console.log("uploadBase64File failed", err);
  }
}
```
- Defined in useFile.d.ts:48