diff --git a/docs/pages/component/_meta.json b/docs/pages/component/_meta.json index f7c7561f..53c34087 100644 --- a/docs/pages/component/_meta.json +++ b/docs/pages/component/_meta.json @@ -1,6 +1,7 @@ { "props": "Properties", "drm": "DRM", + "ads": "Ads", "events": "Events", "methods": "Methods" } \ No newline at end of file diff --git a/docs/pages/component/ads.md b/docs/pages/component/ads.md new file mode 100644 index 00000000..cd82e409 --- /dev/null +++ b/docs/pages/component/ads.md @@ -0,0 +1,25 @@ +# Ads + +## IMA SDK +`react-native-video` has built-in support for Google IMA SDK for Android and iOS. To enable it please refer to [installation section](/installation) + +### Usage +To use AVOD, you need to pass `adTagUrl` prop to `Video` component. `adTagUrl` is a VAST uri. + +Example: +``` +adTagUrl="https://pubads.g.doubleclick.net/gampad/ads?iu=/21775744923/external/vmap_ad_samples&sz=640x480&cust_params=sample_ar%3Dpremidpostoptimizedpodbumper&ciu_szs=300x250&gdfp_req=1&ad_rule=1&output=vmap&unviewed_position_start=1&env=vp&impl=s&cmsid=496&vid=short_onecue&correlator=" +``` + +> NOTE: Video ads cannot start when you are using the PIP on iOS (more info available at [Google IMA SDK Docs](https://developers.google.com/interactive-media-ads/docs/sdks/ios/client-side/picture_in_picture?hl=en#starting_ads)). If you are using custom controls, you must hide your PIP button when you receive the ```STARTED``` event from ```onReceiveAdEvent``` and show it again when you receive the ```ALL_ADS_COMPLETED``` event. + +### Events +To receive events from IMA SDK, you need to pass `onReceiveAdEvent` prop to `Video` component. List of events, you can find [here](https://github.com/react-native-video/react-native-video/blob/master/src/types/Ads.ts) + +Example: + +```jsx +... +onReceiveAdEvent={event => console.log(event)} +... +``` diff --git a/docs/pages/component/props.md b/docs/pages/component/props.md index dad2272c..e4ecb974 100644 --- a/docs/pages/component/props.md +++ b/docs/pages/component/props.md @@ -66,7 +66,7 @@ Example: adTagUrl="https://pubads.g.doubleclick.net/gampad/ads?iu=/21775744923/external/vmap_ad_samples&sz=640x480&cust_params=sample_ar%3Dpremidpostoptimizedpodbumper&ciu_szs=300x250&gdfp_req=1&ad_rule=1&output=vmap&unviewed_position_start=1&env=vp&impl=s&cmsid=496&vid=short_onecue&correlator=" ``` -Note: On android, you need enable IMA SDK in gradle file, see: [enable client side ads insertion](#enable-client-side-ads-insertion) +Note: You need enable IMA SDK in gradle or pod file - [enable client side ads insertion](/installation) Platforms: Android, iOS