MozillaWiki

WebAPI/WebMMS: Difference between revisions

Page Discussion

WebAPI/WebMMS (view source)

Revision as of 23:23, 1 October 2014

1,172 bytes added ,  1 October 2014
no edit summary
No edit summary
No edit summary
 
(19 intermediate revisions by one other user not shown)
Line 1: Line 1:
= Overview =
= Overview =


On the surface, MMS messages are very similar to multipart HTML emails. One part is responsible for the layout of the message, though MMS uses SMIL rather than HTML. The other parts are attachments, such as text, picture, video, and sound files. Much like in multipart  
On the surface, MMS messages are very similar to multipart HTML emails. One part is responsible for the layout of the message, though MMS uses SMIL rather than HTML. The other parts are attachments, such as text, picture, video, and sound files. Much like in multipart emails, the attachments have "file names" and are referred to by those from the presentation part.
 
The API proposal below tries to reuse as many existing Web technologies as applicable. The SMIL document is exposed as a [https://developer.mozilla.org/en/DOM:document DOM document] and the attachments as [https://developer.mozilla.org/en/DOM/Blob Blob] objects. On a User Agent capable of rendering SMIL, the web application may simply render the DOM right away. On other User Agents, it may use XSLT or some other method to convert SMIL to HTML.
 
To read the attachments, the web application may use the [https://developer.mozilla.org/en/DOM/FileReader FileReader] API. However, it's not that useful or efficient to have image/audio/video data in memory (e.g. as a typed array). For display purposes the web application just needs a URI that resolves to the data, so that it can point to it in a <video>, <audio>, <img> element. This is possible with the [https://developer.mozilla.org/en/DOM/window.URL.createObjectURL window.URL] API.


= API =
= API =
== MmsManager ==


   /**
   /**
Line 36: Line 42:
     DOMRequest  cancelMessage(MmsMessage message);
     DOMRequest  cancelMessage(MmsMessage message);
   }
   }
== MmsMessage ==
  /**
  * MmsMessage constructor.
  */
  MmsMessage MmsMessage(
    DOMString receiver,
    Document document
  );
    
    
   [Constructor]
   [Constructor]
Line 75: Line 91:
     readonly attribute MmsAttachmentStorage attachments;     
     readonly attribute MmsAttachmentStorage attachments;     
   }
   }
== MmsAttachmentStorage ==
    
    
   /**
   /**
   * This object implements a mapping to look up attachments by their name.
   * This object implements a mapping to look up attachments (blobs) by their name.
   *
   *
   *  var text = message.attachments["text.txt"];
   *  var text = message.attachments["text.txt"];
   *  message.attachments["movie.mov"] = new MmsAttachment([data], {type: "application/video"});
   *  message.attachments["movie.mov"] = new Blob([data], {type: "application/video"});
   *  delete message.attachments["picture.png"];
   *  delete message.attachments["picture.png"];
   */
   */
   interface MmsAttachmentStorage
   interface MmsAttachmentStorage
   {
   {
     getter MmsAttachment getAttachment(DOMString name);
     getter Blob getAttachment(DOMString name);
     setter creator void setAttachment(DOMString name, MmsAttachment attachment);
     setter creator void setAttachment(DOMString name, Blob attachment);
     deleter void deleteAttachment(DOMString name);
     deleter void deleteAttachment(DOMString name);
  }
 
  /**
  * MmsAttachment constructor (cf. Blob constructor)
  */
  MmsAttachment MmsAttachment(
    [optional] Array parts,
    [optional] BlobPropertyBag properties
  );
 
  /**
  * MMS attachments extend the DOM Blob type, akin to how File extends Blob.
  */
  [Constructor]
  interface MmsAttachment : Blob
  {
    /**
    * Name of the attachment as it is referenced within the SMIL document (cf. File::name)
    */
    readonly attribute DOMString name;
   
    /**
    * An absolute URI under which User Agent makes the attachment available for download.
    * This is provided so that the data does not have to be loaded into memory first, but
    * can directly be linked to from an <img>, <video>, or <audio> element.
    */
    readonly attribute DOMString uri;
   
    /**
    * Inherited from Blob. See https://developer.mozilla.org/en/DOM/Blob
    */
    readonly attribute unsigned long long size;
    readonly attribute DOMString type;
   }
   }


= Example =
= Examples =


== Receiving an MMS ==
== Receiving an MMS ==


  // Listen for incoming MMS. If the message contents hasn't been fetched yet, do so.
   navigator.mms.onreceived = function (event) {
   navigator.mms.onreceived = function (event) {
     var message = event.message;
     var message = event.message;
Line 138: Line 124:
   }
   }
    
    
  // Deconstruct and display an MMS. For simplicity's sake, this only supports one
  // slide and one multimedia element per slide.
   function handleNewMessage(message) {
   function handleNewMessage(message) {
     var pars = message.contentDocument.querySelectorAll("par");
     var firstPar = message.contentDocument.querySelectorAll("par")[0];
     for (var i = 0; i < pars.length; i++) {
     var mediaEl = firstPar.querySelectorAll("img|audio|video")[0];
      //TODO
    var importedEl = document.importNode(mediaEl);
     }
    var mediaUrl = window.URL.createObjectURL(message.attachments[importedEl.src]);
    importedEl.src = mediaUrl;
    messageDisplayContainer.appendChild(importedEl);
     window.URL.revokeObjectURL(mediaUrl);
   }
   }


== Sending an MMS ==
== Sending an MMS ==


   var smil = "&lt;smil>&lt;body>&lt;par>&lt;video src="lolcat.mov"/>&lt;/par>&lt;/body>&lt;/smil>";
   &lt;html>
  var parser = new DOMParser();
  &lt;body>
  var doc = parser.parseFromString(smil, "application/smil");
    &lt;input type="file" id="picture" accept="image/*">
 
    &lt;div>
  var message = new MmsMessage(recipient, doc);
      &lt;input type="text" id="number">
  message.attachments["lolcat.mov"] = new MmsAttchment("lolcat.mov", "application/video", videoData);
      &lt;button onclick="sendMMS();">Send</button>
 
    &lt;/div>
  navigator.mms.send(message);
    &lt;script>
      function sendMMS() {
        var smil = "&lt;smil>&lt;body>&lt;par>&lt;video src="lolcat.mov"/>&lt;/par>&lt;/body>&lt;/smil>";
        var doc = (new DOMParser()).parseFromString(smil, "application/smil");
        var number = document.getElementById("number").value;
        var message = new MmsMessage(number, doc);
       
        var pictureEl = document.getElementById("picture");
        var pictureBlob = pictureEl.files[0];
        message.attachments["picture.jpg"] = pictureBlob;
       
        navigator.mms.send(message);
      }
    &lt;/script>
  &lt;/body>
  &lt;/html>
 
[[Category:Web APIs]]
Chaasof
Confirmed users
1,340

edits

Retrieved from "https://wiki.allizom.org/Special:MobileDiff/419420...1021301"