Skip to content

Latest commit

 

History

History
29 lines (17 loc) · 1.89 KB

POSTINSTALL.md

File metadata and controls

29 lines (17 loc) · 1.89 KB
Raw

See it in action

You can test out this extension right away!

  1. Go to your Storage dashboard in the Firebase console.

  2. Upload an image file to the bucket: ${param:YOUR_BUCKET} in the path ${param:VIDEO_PATH}

  3. After the video is fully uploaded, wait a few seconds and the generated image will appear in the thumbnail path ${param:THUMBNAIL_PATH}.

    Note that you might need to refresh the page to see changes.

Using the extension

You can upload images using the Cloud Storage for Firebase SDK for your platform (iOS, Android, or Web). Alternatively, you can upload images directly in the Firebase console's Storage dashboard.

Whenever you upload an image file to ${param:YOUR_BUCKET} in the path ${param:VIDEO_PATH}, this extension does the following:

  • Detects if the file is a video
  • Checks to see if the video is in the ${param:VIDEO_PATH} directory
  • Takes a screenshot ${param:TIMESTAMP} second(s) into the video
  • Sets the name of the file based on the video filename and a prefix and/or suffix if provided, and the file type of the image ${param:IMAGE_TYPE}
  • Stores the generated image in the ${param:THUMBNAIL_PATH} directory in your Storage bucket

Please note: Video and image processing requires more memory usage than typical cloud functions. For this reason generating thumbnails for large videos (over 200 MB) may fail if not enough memory is allocated for this function. I recommend at least 1 GB (1024 MB) memory allocation for videos under or around 200 MB. The memory allocation setting is in the advanced settings of this extension.

Monitoring

As a best practice, you can monitor the activity of your installed extension, including checks on its health, usage, and logs.