cordova-plugin-mmedia
Version:
Cordova plugin for MillennialMedia Ads, support Banner, Interstitial and Video Ad
142 lines (105 loc) • 4.62 kB
Markdown
# mMedia (Millennial Media) Plugin Pro #
Present mMedia Ads in Mobile App/Games natively from JavaScript.
Highlights:
- [x] Easy-to-use APIs. Display Ad with single line of Js code.
- [x] Support Banner, Interstitial Ad, and Video Ad.
- [x] One plugin supports both Android and iOS platform.
- [x] Auto fit on orientation change.
- [x] Actively maintained, prompt support.
Compatible with:
* Cordova CLI, v3.5+
* Intel XDK and Crosswalk, r1095+
* IBM Worklight, v6.2+
## How to use? ##
If use with Cordova CLI:
```
cordova plugin add com.rjfun.cordova.mmedia
```
If use with Intel XDK:
Project -> CORDOVA 3.X HYBRID MOBILE APP SETTINGS -> PLUGINS AND PERMISSIONS -> Third-Party Plugins ->
Add a Third-Party Plugin -> Get Plugin from the Web, input:
```
Name: mMediaPluginPro
Plugin ID: com.rjfun.cordova.mmedia
[x] Plugin is located in the Apache Cordova Plugins Registry
```
## Quick Start Example Code ##
Step 1: Prepare your mMedia Apid for your app, create it in [mMedia website](http://www.mmedia.com/)
```javascript
var ad_units = {
ios : {
banner : "177365",
interstitial : "177364"
},
android : {
banner : "177367",
interstitial : "177369"
}
};
// select the right Ad Id according to platform
var adid = ( /(android)/i.test(navigator.userAgent) ) ? ad_units.android : ad_units.ios;
```
Step 2: Create a banner with single line of javascript
```javascript
// it will display smart banner at top center, using the default options
if(mMedia) mMedia.createBanner({adId:adid.banner, autoShow:true});
```
Or, show the banner Ad in some other way:
```javascript
// or, show a default banner at bottom
if(mMedia) mMedia.createBanner({
adId : adid.banner,
autoShow : true,
overlap : true,
position : mMedia.AD_POSITION.BOTTOM_CENTER
});
```
Step 3: Prepare an interstitial or video Ad, and show it when needed
```javascript
// preppare and load ad resource in background, e.g. at begining of game level
if(mMedia) mMedia.prepareInterstitial( {adId:adid.interstitial, autoShow:false} );
// show the interstitial later, e.g. at end of game level
if(mMedia) mMedia.showInterstitial();
```
## Javascript API Overview ##
Methods:
```javascript
// set default value for other methods
setOptions(options, success, fail);
// for banner
createBanner(adId/options, success, fail);
removeBanner();
showBanner(position);
showBannerAtXY(x, y);
hideBanner();
// for interstitial
prepareInterstitial(adId/options, success, fail);
showInterstitial();
```
## Detailed Documentation ##
The APIs, Events and Options are detailed documented.
Read the detailed API Reference Documentation [English](https://github.com/floatinghotpot/cordova-plugin-mmedia/wiki).
## FAQ ##
If encounter problem when using the plugin, please read the [FAQ](https://github.com/floatinghotpot/cordova-plugin-mmedia/wiki/FAQ) first.
## Full Example Code ##
This mMedia Plugin Pro offers the most flexibility and many options.
Check the [test/index.html] (https://github.com/floatinghotpot/cordova-plugin-mmedia/blob/master/test/index.html).
## Screenshots ##
iPhone Banner | iPhone Interstitial
-------|---------------
 | 
iPad Banner | iPad Video Ad
 | 
Android Banner | Android Video Ad
 | 
Ad PluginPro series for the world leading Mobile Ad services:
* [GoogleAds PluginPro](https://github.com/floatinghotpot/cordova-admob-pro), for Google AdMob/DoubleClick.
* [iAd PluginPro](https://github.com/floatinghotpot/cordova-iad-pro), for Apple iAd.
* [FacebookAds PluginPro](https://github.com/floatinghotpot/cordova-plugin-facebookads), for Facebook Audience Network.
* [FlurryAds PluginPro](https://github.com/floatinghotpot/cordova-plugin-flurry), for Flurry Ads.
* [mMedia PluginPro](https://github.com/floatinghotpot/cordova-plugin-mmedia), for Millennial Meida.
* [MobFox PluginPro](https://github.com/floatinghotpot/cordova-mobfox-pro), for MobFox.
* [MoPub PluginPro](https://github.com/floatinghotpot/cordova-plugin-mopub), for MoPub.
More Cordova/PhoneGap plugins by Raymond Xie, [find them in plugin registry](http://plugins.cordova.io/#/search?search=rjfun).
If use in commercial project or need prompt support, please [buy a license](http://rjfun.github.io/), you will be served with high priority.
Project outsourcing and consulting service is also available. Please [contact us](mailto:rjfun.mobile@gmail.com) if you have the business needs.