generateVideoStreamingUrl( )

Generates a URL for streaming a specific video file in the Media Manager.

The generateVideoStreamingUrl() function returns a Promise that resolves to a download URL and its asset key.

To stream different assets of the file, use the assetKeys parameter which generates a video streaming URL for each asset. If no asset key is specified, it defaults to src, which generates one video streaming URL in the original file's format and quality.

Authentication

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permissions
Manage Bookings Services and Settings
Read Media Manager
Manage Media Manager
Manage Portfolio
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
fileIdstringRequired

File ID.

You can also pass the files' Wix media URLs. For example, ["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]. Learn more in the File and Folder IDs article.

optionsGenerateVideoStreamingUrlOptions

Options to use when generating a video file's streaming URL.

Returns
Return Type:Promise<GenerateVideoStreamingUrlResponse>
Was this helpful?
Yes
No