/doc/modules/mod_video_embed/mod_video_embed.html

http://github.com/zotonic/zotonic · HTML · 54 lines · 45 code · 9 blank · 0 comment · 0 complexity · ce5ec1a57e7cfa31b1fddc723c25fbf3 MD5 · raw file 

    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
    2. 

  2. <html>
    3. 

  3. <head>
    4. 

  4. <title>Module mod_video_embed</title>
    5. 

  5. <link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
    6. 

  6. </head>
    7. 

  7. <body bgcolor="white">
    8. 

  8. <div class="navbar"><a name="#navbar_top"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
    9. 

  9. <hr>
    10. 

  10. 

  11. <h1>Module mod_video_embed</h1>
    12. 

  12. <ul class="index"><li><a href="#description">Description</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>Enables embedding video's as media pages.
    13. 

  13. <p>Copyright Š 2009 Marc Worrell
    14. 

  14.   Date: 2009-07-15</p>
    15. 

  15. 

  16. <p><b>Authors:</b> Marc Worrell (<a href="mailto:marc@worrell.nl"><tt>marc@worrell.nl</tt></a>).</p>
    17. 

  17. 

  18. <h2><a name="description">Description</a></h2>Enables embedding video's as media pages.  Handles the embed information for showing video's.
    19. 

  19.   The embed information is stored in the medium table associated with the page. You can not have embed
    20. 

  20.   information and a medium file. Either one or the other.
    21. 

  21. <h2><a name="index">Function Index</a></h2>
    22. 

  22. <table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#event-2">event/2</a></td><td>Handle the form submit from the "new media" dialog.</td></tr>
    23. 

  23. <tr><td valign="top"><a href="#observe_media_stillimage-2">observe_media_stillimage/2</a></td><td>Return the filename of a still image to be used for image tags.</td></tr>
    24. 

  24. <tr><td valign="top"><a href="#observe_media_viewer-2">observe_media_viewer/2</a></td><td>Return the media viewer for the embedded video (that is, when it is an embedded media).</td></tr>
    25. 

  25. <tr><td valign="top"><a href="#observe_rsc_update-3">observe_rsc_update/3</a></td><td>Check if the update contains video embed information.</td></tr>
    26. 

  26. </table>
    27. 

  27. 

  28. <h2><a name="functions">Function Details</a></h2>
    29. 

  29. 

  30. <h3 class="function"><a name="event-2">event/2</a></h3>
    31. 

  31. <div class="spec">
    32. 

  32. <p><tt>event(X1::Event, Context::Context1) -&gt; Context2</tt></p>
    33. 

  33. </div><p>Handle the form submit from the "new media" dialog.  The form is defined in templates/_media_upload_panel.tpl.</p>
    34. 

  34. 

  35. <h3 class="function"><a name="observe_media_stillimage-2">observe_media_stillimage/2</a></h3>
    36. 

  36. <div class="spec">
    37. 

  37. <p><tt>observe_media_stillimage(Media_stillimage::Notification, Context::_Context) -&gt; undefined | {ok, Filename}</tt></p>
    38. 

  38. </div><p>Return the filename of a still image to be used for image tags.</p>
    39. 

  39. 

  40. <h3 class="function"><a name="observe_media_viewer-2">observe_media_viewer/2</a></h3>
    41. 

  41. <div class="spec">
    42. 

  42. <p><tt>observe_media_viewer(Media_viewer::Notification, Context) -&gt; undefined | {ok, Html}</tt></p>
    43. 

  43. </div><p>Return the media viewer for the embedded video (that is, when it is an embedded media).</p>
    44. 

  44. 

  45. <h3 class="function"><a name="observe_rsc_update-3">observe_rsc_update/3</a></h3>
    46. 

  46. <div class="spec">
    47. 

  47. <p><tt>observe_rsc_update(Rsc_update::{rsc_update, ResourceId, OldResourceProps}, X2::{Changed, UpdateProps}, Context) -&gt; {NewChanged, NewUpdateProps}</tt></p>
    48. 

  48. </div><p>Check if the update contains video embed information.  If so then update the attached medium item.</p>
    49. 

  49. <hr>
    50. 

  50. 

  51. <div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
    52. 

  52. <p><i>Generated by EDoc, Oct 13 2011, 14:45:58.</i></p>
    53. 

  53. </body>
    54. 

  54. </html>
    55.