MediaKeySession.hx 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899
  1. /*
  2. * Copyright (C)2005-2019 Haxe Foundation
  3. *
  4. * Permission is hereby granted, free of charge, to any person obtaining a
  5. * copy of this software and associated documentation files (the "Software"),
  6. * to deal in the Software without restriction, including without limitation
  7. * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  8. * and/or sell copies of the Software, and to permit persons to whom the
  9. * Software is furnished to do so, subject to the following conditions:
  10. *
  11. * The above copyright notice and this permission notice shall be included in
  12. * all copies or substantial portions of the Software.
  13. *
  14. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17. * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  19. * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  20. * DEALINGS IN THE SOFTWARE.
  21. */
  22. // This file is generated from mozilla\MediaKeySession.webidl. Do not edit!
  23. package js.html.eme;
  24. import js.lib.Promise;
  25. /**
  26. The `MediaKeySession` interface of the EncryptedMediaExtensions API represents a context for message exchange with a content decryption module (CDM).
  27. Documentation [MediaKeySession](https://developer.mozilla.org/en-US/docs/Web/API/MediaKeySession) by [Mozilla Contributors](https://developer.mozilla.org/en-US/docs/Web/API/MediaKeySession$history), licensed under [CC-BY-SA 2.5](https://creativecommons.org/licenses/by-sa/2.5/).
  28. @see <https://developer.mozilla.org/en-US/docs/Web/API/MediaKeySession>
  29. **/
  30. @:native("MediaKeySession")
  31. extern class MediaKeySession extends js.html.EventTarget {
  32. var error(default,null) : MediaKeyError;
  33. /**
  34. Contains a unique string generated by the CDM for the current media object and its associated keys or licenses.
  35. **/
  36. var sessionId(default,null) : String;
  37. /**
  38. The time after which the keys in the current session can no longer be used to decrypt media data, or `NaN` if no such time exists. This value is determined by the CDM and measured in milliseconds since January 1, 1970, UTC. This value may change during a session lifetime, such as when an action triggers the start of a window.
  39. **/
  40. var expiration(default,null) : Float;
  41. /**
  42. Returns a `Promise` signaling when a `MediaKeySession` closes. This promise can only be fulfilled and is never rejected. Closing a session means that licenses and keys associated with it are no longer valid for decrypting media data. 
  43. **/
  44. var closed(default,null) : Promise<Void>;
  45. /**
  46. Contains a reference to a read-only `MediaKeyStatusMap` of the current session's keys and their statuses.
  47. **/
  48. var keyStatuses(default,null) : MediaKeyStatusMap;
  49. /**
  50. Sets the `EventHandler` called when there has been a change in the keys in a session or their statuses.
  51. **/
  52. var onkeystatuseschange : haxe.Constraints.Function;
  53. /**
  54. Sets the `EventHandler` called when the content decryption module has generated a message for the session.
  55. **/
  56. var onmessage : haxe.Constraints.Function;
  57. /**
  58. Returns a `Promise` after generating a media request based on initialization data.
  59. **/
  60. @:overload( function( initDataType : String, initData : js.lib.ArrayBuffer) : Promise<Void> {} )
  61. function generateRequest( initDataType : String, initData : js.lib.ArrayBufferView ) : Promise<Void>;
  62. /**
  63. Returns a `Promise` that resolves to a boolean value after loading data for a specified session object. 
  64. **/
  65. function load( sessionId : String ) : Promise<Bool>;
  66. /**
  67. Returns a `Promise` after loading messages and licenses to the CDM.
  68. **/
  69. @:overload( function( response : js.lib.ArrayBuffer) : Promise<Void> {} )
  70. function update( response : js.lib.ArrayBufferView ) : Promise<Void>;
  71. /**
  72. Returns a `Promise` after notifying the current media session is no longer needed and that the CDM should release any resources associated with this object and close it.
  73. **/
  74. function close() : Promise<Void>;
  75. /**
  76. Returns a `Promise` after removing any session data associated with the current object.
  77. **/
  78. function remove() : Promise<Void>;
  79. }