Skip to main content

SDK Quick start

The Media Protocol SDK exists to help developers build on top of Media Protocol. It's designed to run in any environment that can execute JavaScript (think websites, node scripts, etc.). While simple enough to use in a hackathon project, it's also robust enough to power production applications.

Installation​

The easiest way to consume the SDK is via npm. To install it in your project, simply run yarn add media-sdk (or npm install media-sdk).

Usage​

To run code from the SDK in your application, use an import or require statement, depending on which your environment supports. Note that the guides following this page will use ES6 syntax.

ES6 (import)​

import { initSdk, MarketplaceViewer, Marketplace, Resources, Helper } from 'media-sdk';

CommonJS (require)​

const { initSdk, MarketplaceViewer, Marketplace, Resources, Helper } = require('media-sdk');

Reference​

Comprehensive reference material for the SDK can be found here

note

Please note that this documentation is currently a work in progress, and we apologize for any errors or blank pages you may come across. We welcome any contributions or feedback to improve the documentation via the official repository at https://github.com/mediafoundation/media-protocol-docs.