Wix Media Platform is an end-to-end solution for all modern web media management, handling images, video and audio in the most efficient way on the market. From upload, storage, metadata management and all the way to delivery, Wix Media Platform takes care of all possible media workflows.
This artifact is a PHP library, compatible with PHP 5.6+ and PHP 7.
The respective JavaScript (for the Browser and Node.js) package can be found here.
The respective Java package can be found here.
PHP 5.6 and later.
Firebase PHP JWT (JSON Web Tokens)
To install the bindings via Composer run the following command
composer require wix/media-platform-php-sdkOr add the following to composer.json:
{
"require": {
"wix/media-platform-php-sdk": "*@dev"
}
}
Then run composer install
Download the files and include autoload.php:
require_once('/path/to/sdk/media-platform-php-sdk/autoload.php');First, if you haven't done so yet, register at Wix Media Platform, create your organization, project and application.
$mediaPlatform = new \Wix\Mediaplatform\MediaPlatform(
"<project host as appears in the application page>",
"<application id as appears in the application page>",
"<shared secret as appears in the application page>"
);$file = fopen("...path to file...", "r");
$files = $mediaPlatform->fileManager()->uploadFile("/destination_path/file_name.ext", "mime_type", "file_name.ext", file, "private||public");Generates a signed URL and token, required for uploading from the browser
$getUploadUrlResponse = $mediaPlatform->fileManager()->getUploadUrl();$importFileRequest = new \Wix\Mediaplatform\Model\Request\ImportFileRequest();
$destination = new \Wix\Mediaplatform\Model\Job\Destination();
$destination->setPath("/to/file.ext")
->setAcl("private||public")
$importFileRequest->setSourceUrl("from URL")
->setDestination($destination);
$job = $mediaPlatform->fileManager()->importFile($importFileRequest);File Download API documentation
File access can be restricted by setting the acl to 'private'. In order to access these files, a secure URL must be generated:
$signedUrl = $mediaPlatform->fileDownloader()->getDownloadUrl("path/to/file.ext");The Jobs API forms the basis for all long running asynchronous operations in the platform.
A job is created by a service that performs a long running operation, such as video transcode or file import.
- When a job is created, it is queued for execution, and its status is initially set to 'pending'.
- Once the job execution commences, the job status is updated to 'working'.
- On job completion, the job status is updated to either 'success' or 'error', and the 'result' property is populated (prior to the job's completion, the 'result' field is null).
$job = $mediaPlatform->jobManager()->getJob("job id");$jobGroup = $mediaPlatform->jobManager()->getJobGroup("job group id");The SDK provides a programmatic facility to generate image URLs
$image = new \Wix\Mediaplatform\Image\Image($fileDescriptor);
$image->setHost("images service host");
$image->crop($width, $height, $x, $y, $scale);
$url = $image->toUrl(); It's possible to create a watermark manifest, and later apply it in any image manipulation url. Adding a watermark manifest to secured (private) files will make these files available publicly via the image API, only after the watermark manifest is created for the specific image, and only if the wm_{manifestId} parameter is present.
// define the source image
$source = new Source();
$source->setPath("/image/path/file.jpg");
// define the source for the watermark image
$watermarkSource = new Source();
$watermarkSource->setPath("/image/watermark/file.png");
// define the watermark specification options
$specification = new ImageWatermarkSpecification();
$specification->setWatermark($watermarkSource);
$specification->setPosition(ImageWatermarkPosition::CENTER);
$specification->setOpacity(90);
$specification->setScale(0);
// issue the request
$watermarkRequest = new ImageWatermarkRequest();
$watermarkRequest->setSource($source);
$watermarkRequest->setSpecification($specification);
$watermarkManifest = self::$imageManager->createWatermarkManifest($watermarkRequest);
// example: get a watermarked image url using the watermark manifest
$image = new Image();
$imageUrl = $image->setPath('/image/path/file.jpg')
->setFilename('watermarked.jpg')
->fill(100, 100)
->watermark( $watermarkManifest->getId() )
->toUrl();
// $imageUrl will be: '/image/path/file.jpg/v1/fill/w_100,h_100,wm_abcdefghijklmnop/watermarked.jpg'The SDK enables extracting an image's features, which includes face detection, labeling, explicit content detection and color-hinting:
$extractFeaturesRequest = new Wix\Mediaplatform\Model\Request\ExtractImageFeaturesRequest()
->setPath('/test.jpg')
->setFeatures({FACIAL_DETECTION, LABEL_DETECTION, COLOR_DETECTION, EXPLICIT_CONTENT_DETECTION});
$imageFeatures = $mediaPlatform->imageManager()->extractFeatures($extractFeaturesRequest); // define the source
$source = new Source();
$source->setPath("/test.jpg");
// define the destination
$destination = new Destination();
$destination->setPath('/image/file/outputs/first.jpg');
$destination->setAcl('public');
// create an empty image object
$image = new Image();
// perform an image operation
$image->fit(100, 100);
// create specification object
$specification = new ImageOperationSpecification();
$specification->setCommand($image);
$specification->setDestination($destination);
// prepare the image operation request
$imageOperationRequest = new ImageOperationRequest();
$imageOperationRequest->setSource($source);
$imageOperationRequest->setSpecification($specification);
// execute the request and fetch the file descriptor
$fileDescriptor = self::$imageManager->imageOperation($imageOperationRequest);File Management API Documentation
File Metadata API Documentation
Wix Media Platform provides a comprehensive set of APIs tailored for management of previously uploaded files.
$response = $mediaPlatform->fileManager()->listFiles("directory path");$fileMetadata = $mediaPlatform->fileManager()->getFileMetadataById("file id");$mediaPlatform->fileManager()->deleteFileById("file id");// mandatory: one of $path or $file
// mandatory: $acl ('private' or 'public'
$fileDescriptor = $mediaPlatform->fileManager()->updateFileAcl($path, $fileId, $acl);In order to get the basic uploaded file metadata synchronously, it's possible to call the digest API
$filePath = "/path/to/some/file.jpg";
$fileMetadataResponse = $mediaPlatform->fileManager()->getFileDigest($filePath);Create an archive from several files:
$createArchiveRequest = new \Wix\Mediaplatform\Model\Request\CreateArchiveRequest();
$source = new \Wix\Mediaplatform\Model\Job\Source();
$source->setFileId("file id");
$destination = new \Wix\Mediaplatform\Model\Job\Destination();
$destination->setAcl("public")
->setPath("/demo/file.zip");
$createArchiveRequest
->addSource($source)
->setDestination($destination)
->setArchiveType('zip');
$job = $mediaPlatform->archiveManager()->createArchive($createArchiveRequest);Instead of uploading numerous files one by one, you can upload a single zip file and instruct the Media Platform to extract its content to a destination directory.
$extractArchiveRequest = new \Wix\Mediaplatform\Model\Request\ExtractArchiveRequest();
$source = new \Wix\Mediaplatform\Model\Job\Source();
$source->setFileId("file id");
$destination = new \Wix\Mediaplatform\Model\Job\Destination();
$destination->setAcl("public")
->setDirectory("/demo/extracted");
$extractArchiveRequest
->setSource($source)
->setDestination($destination);
$job = $mediaPlatform->archiveManager()->extractArchive($extractArchiveRequest);To initiate a transcode request:
$transcodeRequest = new TranscodeRequest();
$specifications = array(
TranscodeSpecification::factory()
->setDestination(
Destination::factory()
->setDirectory("/test/output1.mp4")
->setAcl("public")
)->setQualityRange(
QualityRange::factory()
->setMinimum("240p")
->setMaximum("1440p")
)
);
$source = Source::factory()->setPath("/test/file.mp4");
$transcodeRequest->addSource($source)
->setSpecifications($specifications);
$transcodeResponse = $mediaPlatform->transcodeManager()->transcodeVideo($transcodeRequest);Please use the issue tracker to report issues related to this library, or to the Wix Media Platform API in general.
We use a custom license, see LICENSE.md.
Wix.com is a leading cloud-based web development platform with more than 100 million registered users worldwide. Our powerful technology makes it simple for everyone to create a beautiful website and grow their business online.
Google Cloud Platform enables developers to build, test and deploy applications on Google’s reliable infrastructure. It offers computing, storage and application services for web, mobile and backend solutions.