gecko-dev/dom/interfaces/html/nsIDOMHTMLByteRanges.idl

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim:set ts=2 sw=2 sts=2 et cindent: */
/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is Mozilla code.
 *
 * The Initial Developer of the Original Code is the Mozilla Corporation.
 * Portions created by the Initial Developer are Copyright (C) 2007
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *  Chris Double <chris.double@double.co.nz>
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */
#include "domstubs.idl"

[scriptable, uuid(992c540c-4d81-42df-80a6-f71ede2b59d8)]
interface nsIDOMHTMLByteRanges : nsISupports
{
  /* The number of ranges represented by the object */
  readonly attribute unsigned long length;

  /* The start(index) method must return the position of the first
     byte of the indexth range represented by the object. */
  unsigned long start(in unsigned long index);

  /* The end(index) method must return the position of the byte
     immediately after the last byte of the indexth range represented
     by the object. (The byte position returned by this method is not
     in the range itself. If the first byte of the range is the byte
     at position 0, and the entire stream of bytes is in the range,
     then the value of the position of the byte returned by this
     method for that range will be the same as the number of bytes in
     the stream.) */
  unsigned long end(in unsigned long index);
};