Changeset 1710861

Timestamp:

08/09/2017 10:12:59 AM (9 years ago)

Author:

meisterplayer

Message:

Update docs

Location:

meister-player

Files:

• tags/1.0.5/readme.txt (modified) (1 diff)
• trunk/readme.txt (modified) (1 diff)

meister-player/tags/1.0.5/readme.txt

@@ -8 +8 @@
 
 == Description ==
-With this Woodstock release of Meisterplayer you can play mp4, mp3, icecast, DASH-streaming, HLS-streaming and Smooth-streaming on your Wordpress-website. We even support embedded Youtube-videos and you are able to display a small logo as watermark on top of your video.
-Meisterplayer has a lot more features to offer, we have plugins for DRM, Advertising, several analytics-libraries and a Custom UI.  Check out our website https://meisterplayer.com for more information.
-
+With this Woodstock release of Meisterplayer you can play mp4, mp3, icecast, DASH-streams, HLS-streams and Smooth-streams on your WordPress website; we even support embedded YouTube videos! Personalise your content further by overlaying the video with a small watermark/logo.
+This is just a small set of the features Meisterplayer has to offer; we have MeisterPlayer-plugins for DRM, advertising, various analytics providers, even a plugin to create your own UI. Check out our website on https://meisterplayer.com for more information.
 
 
 == Installation ==
 = Installing =
-Simply upload the zip-file onto your Wordpress-website from the admin-interface (in plugins->add new).
-You can also search for \"meisterplayer\"  from admin->plugins->add new and just click \"Install now\".
+Upload the zip file onto your website from the admin interface by pressing “plugins” and then “add new”. You can also search for ‘Meisterplayer’ from the “add new” interface and click the “Install now” button.
 
 = Usage =
-To publish a video on your wordpress-website open up the visual-editor in a blog-post of page. Click the Meister-logo and select a video or audio file from the  media-selector.  You\'ll see the following code in the visual editor after you\'ve successfully selected a video;
-[meisterplayer video=\"[url to your video]\" autoplay=\"true\" fullscreen=\"true\"]
+To publish a video on your website open up the visual editor in a blogpost of a page. Click the Meisterplayer icon and select a video or audio file fro the Media selector. You’ll see the following code after successfully selecting your media:
+[meisterplayer video=“[url to your media]” autoplay=“false” ]
 
-You can finetune the behaviour of the player by adding/changing the following attributes;
-- video: url. The url of the video that will be played
-- autoplay: true/false. Will automatically start the video when the page loads. Disabled by default
-- muted: true/false. Will set the player to muted on start. If you\'d like the video to play automatically on mobile devices (autoplay:true) you should set muted to true. iOS and Android don\'t allow autoplay on video\'s that are not muted
-- type : (optional) m3u8 (hls), mpd (DASH), smooth, youtube. The type of video you are playing. If you do not provide a type the player will assume it\'s an mp4. For HLS/DASH/Smooth and Youtube, please refer to the section \"Playing external URL\'s\"
-- watermark : (optional) URL. Url of an image, preferable a PNG which is shown as watermark on the top-left side of the player.
+You can finetune the behaviour of the player by adding or changing the following attributes:
+- video: “url to your media”. The url of the media you want to play.
+- autoplay: “true” of “false”. Setting this to true will cause the media to start playing when your page loads. This is false by default.
+- muted: “true” or “false”. Setting this to true will mute the sound of the media. This is set to false by default. If you want to use the autoplay attribute on mobile devices you should also set the muted attribute to true, otherwise the media will not play automatically due to restrictions by the mobile platforms.
 
-= Playing external URL\'s =
-Most DASH/HLS/Smooth streams are hosted on a separate URL. You can set this up by entering a URL manually in the video-attribute.
-Please note that if you are trying to reference a DASH/HLS stream that\'s not your own you\'ll probably have issues with invalid CORS-headers.
+Optional attributes:
+- type: “m3u8”, “mpd”, “smooth”, “youtube”. This is the type of media that you want to play. For more common types such as MP3 or MP4 you do not need to use this attribute. The types correspond to streaming methods: for HLS use “m3u8”, for DASH use “mpd”, for Smooth use “smooth”, and for YouTube videos use “youtube”. Further down we will elaborate a bit more on these special types.
+- watermark: “url to your watermark”. A url of an image (we recommend PNG) which is displayed in the top-left corner of the player.
 
-= Using Youtube embed =
-It\'s very easy to play Youtube video\'s in Meisterplayer. Just insert the Youtube-ID from the Youtube video as 'video' value (eg. _FVgD5KJPyE from https://www.youtube.com/watch?v=_FVgD5KJPyE) and set type:youtube .
+Playing HLS, DASH, and Smooth streams
 
+Usually these kinds of streams will be hosted on a different domain so they won’t be available from the Media selector. You can play these by entering the url to the stream directly in the ‘video’ attribute. Please note that when you’re using streams from different domains you might run into CORS-header issues depending on the settings of the domain where the stream is located.
+
+Playing YouTube videos
+
+For YouTube videos you need to use the YouTube ID from the video instead of a url as the ‘video’ attribute. For example, to play the video from https://www.youtube.com/watch?v=_FVgD5KJPyE use the ID “_FVgD5KJPyE” as the ‘video’ attribute, and set the ‘type’ attribute to “youtube”
 
 == Frequently Asked Questions ==
 - Is Meisterplayer open source?
-Yes it is! You can freely checkout and download the (ES6) source code on GitHub; https://github.com/meisterplayer/meisterplayer. We have release a lot of plugin on GitHub as well.
+Yes it is! You can freely checkout and download the (ES6) source code on GitHub; https://github.com/meisterplayer/meisterplayer. A lot of our plugins can also be found on GitHub.
 
 - Can I contribute?
-Yes! Please do! We like a fresh new look on our codebase and like to be inspired by new ideas to make Meisterplayer even better.
+Yes, please do! We like a fresh new look on our codebase and like to be inspired by new ideas to make Meisterplayer even better.
 
 - Do you have technical support?
-We have several technical support options. Checkout our website for more information.
+We have several technical support options. Check out our website for more information.
 
-- Why are DRM, Advertising and Analytics plugins not open-source?
-We put considerable effort in creating stable and easy to use plugins for generally complex features. We want to keep them up to date and up to standards in the fast moving world of ever evolving DRM-techniques, advertising and analytics. In order to do that we need to invest time and effort, and you know what that means.
+- Why are the DRM, advertising and analytics Meister-plugins not open-source?
+We put considerable effort in creating stable and easy to use plugins for generally complex features. We strive to keep those plugins up to date in this world of rapidly evolving DRM, advertising, and analytics standards. In order to do so we need to invest time and effort, and we also like to eat ;)
 
 - Can I use Meisterplayer for audio?
-Sure you can. Several dutch radio-stations already do :-)
-This Meisterplayer-wordpress plugin supports Mp3, icecast and OGG (on browsers that support OGG). If you need more configuration-options you should build your own Meisterplayer-build.
+Sure you can; several Dutch radio station do so already.
+This Meisterplayer WordPress plugin supports MP3, Icecast, and Ogg (as long as the browser supports the format). Should you need more options you can look into building a custom build of Meisterplayer.
 
-- Can I create my own interface?
-Not (yet) with this plugin, but with Meisterplayer you  can. You do need to set up a Node-js project to build your own instance of Meisterplayer though. It\'s to detailed to get into that here, but check out our GitHub to get more information: https://github.com/meisterplayer/meisterplayer
+- Can I create my own user interface?
+This is not (yet) possible with this plugin, but you can with your own Meisterplayer build. You do need to set up a Node-js project to build your own instance of Meisterplayer though. It\'s to detailed to get into that here, but check out our GitHub to get more information: https://github.com/meisterplayer/meisterplayer
 
 == Screenshots ==
 1. Demo page Meisterplayer
-2. Wordpress-plugin in action
+2. WordPress-plugin in action
 3. Meisterplayer as header video player
 

meister-player/trunk/readme.txt

@@ -8 +8 @@
 
 == Description ==
-With this Woodstock release of Meisterplayer you can play mp4, mp3, icecast, DASH-streaming, HLS-streaming and Smooth-streaming on your Wordpress-website. We even support embedded Youtube-videos and you are able to display a small logo as watermark on top of your video.
-Meisterplayer has a lot more features to offer, we have plugins for DRM, Advertising, several analytics-libraries and a Custom UI.  Check out our website https://meisterplayer.com for more information.
-
+With this Woodstock release of Meisterplayer you can play mp4, mp3, icecast, DASH-streams, HLS-streams and Smooth-streams on your WordPress website; we even support embedded YouTube videos! Personalise your content further by overlaying the video with a small watermark/logo.
+This is just a small set of the features Meisterplayer has to offer; we have MeisterPlayer-plugins for DRM, advertising, various analytics providers, even a plugin to create your own UI. Check out our website on https://meisterplayer.com for more information.
 
 
 == Installation ==
 = Installing =
-Simply upload the zip-file onto your Wordpress-website from the admin-interface (in plugins->add new).
-You can also search for \"meisterplayer\"  from admin->plugins->add new and just click \"Install now\".
+Upload the zip file onto your website from the admin interface by pressing “plugins” and then “add new”. You can also search for ‘Meisterplayer’ from the “add new” interface and click the “Install now” button.
 
 = Usage =
-To publish a video on your wordpress-website open up the visual-editor in a blog-post of page. Click the Meister-logo and select a video or audio file from the  media-selector.  You\'ll see the following code in the visual editor after you\'ve successfully selected a video;
-[meisterplayer video=\"[url to your video]\" autoplay=\"true\" fullscreen=\"true\"]
+To publish a video on your website open up the visual editor in a blogpost of a page. Click the Meisterplayer icon and select a video or audio file fro the Media selector. You’ll see the following code after successfully selecting your media:
+[meisterplayer video=“[url to your media]” autoplay=“false” ]
 
-You can finetune the behaviour of the player by adding/changing the following attributes;
-- video: url. The url of the video that will be played
-- autoplay: true/false. Will automatically start the video when the page loads. Disabled by default
-- muted: true/false. Will set the player to muted on start. If you\'d like the video to play automatically on mobile devices (autoplay:true) you should set muted to true. iOS and Android don\'t allow autoplay on video\'s that are not muted
-- type : (optional) m3u8 (hls), mpd (DASH), smooth, youtube. The type of video you are playing. If you do not provide a type the player will assume it\'s an mp4. For HLS/DASH/Smooth and Youtube, please refer to the section \"Playing external URL\'s\"
-- watermark : (optional) URL. Url of an image, preferable a PNG which is shown as watermark on the top-left side of the player.
+You can finetune the behaviour of the player by adding or changing the following attributes:
+- video: “url to your media”. The url of the media you want to play.
+- autoplay: “true” of “false”. Setting this to true will cause the media to start playing when your page loads. This is false by default.
+- muted: “true” or “false”. Setting this to true will mute the sound of the media. This is set to false by default. If you want to use the autoplay attribute on mobile devices you should also set the muted attribute to true, otherwise the media will not play automatically due to restrictions by the mobile platforms.
 
-= Playing external URL\'s =
-Most DASH/HLS/Smooth streams are hosted on a separate URL. You can set this up by entering a URL manually in the video-attribute.
-Please note that if you are trying to reference a DASH/HLS stream that\'s not your own you\'ll probably have issues with invalid CORS-headers.
+Optional attributes:
+- type: “m3u8”, “mpd”, “smooth”, “youtube”. This is the type of media that you want to play. For more common types such as MP3 or MP4 you do not need to use this attribute. The types correspond to streaming methods: for HLS use “m3u8”, for DASH use “mpd”, for Smooth use “smooth”, and for YouTube videos use “youtube”. Further down we will elaborate a bit more on these special types.
+- watermark: “url to your watermark”. A url of an image (we recommend PNG) which is displayed in the top-left corner of the player.
 
-= Using Youtube embed =
-It\'s very easy to play Youtube video\'s in Meisterplayer. Just insert the Youtube-ID from the Youtube video as 'video' value (eg. _FVgD5KJPyE from https://www.youtube.com/watch?v=_FVgD5KJPyE) and set type:youtube .
+Playing HLS, DASH, and Smooth streams
 
+Usually these kinds of streams will be hosted on a different domain so they won’t be available from the Media selector. You can play these by entering the url to the stream directly in the ‘video’ attribute. Please note that when you’re using streams from different domains you might run into CORS-header issues depending on the settings of the domain where the stream is located.
+
+Playing YouTube videos
+
+For YouTube videos you need to use the YouTube ID from the video instead of a url as the ‘video’ attribute. For example, to play the video from https://www.youtube.com/watch?v=_FVgD5KJPyE use the ID “_FVgD5KJPyE” as the ‘video’ attribute, and set the ‘type’ attribute to “youtube”
 
 == Frequently Asked Questions ==
 - Is Meisterplayer open source?
-Yes it is! You can freely checkout and download the (ES6) source code on GitHub; https://github.com/meisterplayer/meisterplayer. We have release a lot of plugin on GitHub as well.
+Yes it is! You can freely checkout and download the (ES6) source code on GitHub; https://github.com/meisterplayer/meisterplayer. A lot of our plugins can also be found on GitHub.
 
 - Can I contribute?
-Yes! Please do! We like a fresh new look on our codebase and like to be inspired by new ideas to make Meisterplayer even better.
+Yes, please do! We like a fresh new look on our codebase and like to be inspired by new ideas to make Meisterplayer even better.
 
 - Do you have technical support?
-We have several technical support options. Checkout our website for more information.
+We have several technical support options. Check out our website for more information.
 
-- Why are DRM, Advertising and Analytics plugins not open-source?
-We put considerable effort in creating stable and easy to use plugins for generally complex features. We want to keep them up to date and up to standards in the fast moving world of ever evolving DRM-techniques, advertising and analytics. In order to do that we need to invest time and effort, and you know what that means.
+- Why are the DRM, advertising and analytics Meister-plugins not open-source?
+We put considerable effort in creating stable and easy to use plugins for generally complex features. We strive to keep those plugins up to date in this world of rapidly evolving DRM, advertising, and analytics standards. In order to do so we need to invest time and effort, and we also like to eat ;)
 
 - Can I use Meisterplayer for audio?
-Sure you can. Several dutch radio-stations already do :-)
-This Meisterplayer-wordpress plugin supports Mp3, icecast and OGG (on browsers that support OGG). If you need more configuration-options you should build your own Meisterplayer-build.
+Sure you can; several Dutch radio station do so already.
+This Meisterplayer WordPress plugin supports MP3, Icecast, and Ogg (as long as the browser supports the format). Should you need more options you can look into building a custom build of Meisterplayer.
 
-- Can I create my own interface?
-Not (yet) with this plugin, but with Meisterplayer you  can. You do need to set up a Node-js project to build your own instance of Meisterplayer though. It\'s to detailed to get into that here, but check out our GitHub to get more information: https://github.com/meisterplayer/meisterplayer
+- Can I create my own user interface?
+This is not (yet) possible with this plugin, but you can with your own Meisterplayer build. You do need to set up a Node-js project to build your own instance of Meisterplayer though. It\'s to detailed to get into that here, but check out our GitHub to get more information: https://github.com/meisterplayer/meisterplayer
 
 == Screenshots ==
 1. Demo page Meisterplayer
-2. Wordpress-plugin in action
+2. WordPress-plugin in action
 3. Meisterplayer as header video player