@galacean/effects-plugin-multimedia 2.1.0-alpha.9 → 2.1.0-beta.0

package/dist/audio/audio-loader.d.ts

@@ -1,6 +1,10 @@
-import type { SceneLoadOptions } from '@galacean/effects';
+import type { PrecompileOptions, Renderer, SceneLoadOptions } from '@galacean/effects';
 import { spec, AbstractPlugin } from '@galacean/effects';
+/**
+ * 音频加载插件
+ */
 export declare class AudioLoader extends AbstractPlugin {
+    static precompile(compositions: spec.Composition[], renderer: Renderer, options?: PrecompileOptions): Promise<any>;
     static processAssets(json: spec.JSONScene, options?: SceneLoadOptions): Promise<{
         assets: spec.AssetBase[];
         loadedAssets: (HTMLAudioElement | AudioBuffer)[];

package/dist/index.d.ts

@@ -3,3 +3,7 @@ export * from './audio/audio-component';
 export * from './audio/audio-player';
 export * from './constants';
 export * from './utils';
+/**
+ * 插件版本号
+ */
+export declare const version: string;

package/dist/index.js

@@ -3,14 +3,34 @@
  * Description: Galacean Effects player multimedia plugin
  * Author: Ant Group CO., Ltd.
  * Contributors: 云垣
- * Version: v2.1.0-alpha.9
+ * Version: v2.1.0-beta.0
  */
 
 'use strict';
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var effects = require('@galacean/effects');
+var EFFECTS = require('@galacean/effects');
+
+function _interopNamespace(e) {
+    if (e && e.__esModule) return e;
+    var n = Object.create(null);
+    if (e) {
+        Object.keys(e).forEach(function (k) {
+            if (k !== 'default') {
+                var d = Object.getOwnPropertyDescriptor(e, k);
+                Object.defineProperty(n, k, d.get ? d : {
+                    enumerable: true,
+                    get: function () { return e[k]; }
+                });
+            }
+        });
+    }
+    n["default"] = e;
+    return Object.freeze(n);
+}
+
+var EFFECTS__namespace = /*#__PURE__*/_interopNamespace(EFFECTS);
 
 function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {
     try {
@@ -259,11 +279,11 @@ function _processMultimedia() {
         return __generator(this, function(_state) {
             renderLevel = options.renderLevel;
             jobs = media.map(function(medium) {
-                if (effects.passRenderLevel(medium.renderLevel, renderLevel)) {
+                if (EFFECTS.passRenderLevel(medium.renderLevel, renderLevel)) {
                     var url = new URL(medium.url, location.href).href;
-                    if (type === effects.spec.MultimediaType.video) {
-                        return effects.loadVideo(url);
-                    } else if (type === effects.spec.MultimediaType.audio) {
+                    if (type === EFFECTS.spec.MultimediaType.video) {
+                        return EFFECTS.loadVideo(url);
+                    } else if (type === EFFECTS.spec.MultimediaType.audio) {
                         return loadAudio(url);
                     }
                 }
@@ -351,7 +371,7 @@ function _loadAudio() {
                     audioContext = new AudioContext();
                     return [
                         4,
-                        effects.loadBinary(url)
+                        EFFECTS.loadBinary(url)
                     ];
                 case 2:
                     buffer = _state.sent();
@@ -404,7 +424,7 @@ var MultimediaError = /*#__PURE__*/ function(Error1) {
         _this = Error1.call(this, message) || this;
         _this.code = code;
         _this.name = _this.constructor.name;
-        if ("captureStackTrace" in Error && effects.isFunction(Error.captureStackTrace)) {
+        if ("captureStackTrace" in Error && EFFECTS.isFunction(Error.captureStackTrace)) {
             Error.captureStackTrace(_assert_this_initialized(_this), MultimediaError);
         }
         return _this;
@@ -412,11 +432,25 @@ var MultimediaError = /*#__PURE__*/ function(Error1) {
     return MultimediaError;
 }(_wrap_native_super(Error));
 
-var VideoLoader = /*#__PURE__*/ function(AbstractPlugin) {
+/**
+ * 视频加载插件
+ */ var VideoLoader = /*#__PURE__*/ function(AbstractPlugin) {
     _inherits(VideoLoader, AbstractPlugin);
     function VideoLoader() {
         return AbstractPlugin.apply(this, arguments);
     }
+    VideoLoader.precompile = function precompile(compositions, renderer, options) {
+        var engine = renderer.engine;
+        var env = (options != null ? options : {
+            env: ""
+        }).env;
+        if (env === EFFECTS.PLAYER_OPTIONS_ENV_EDITOR) {
+            return checkAutoplayPermission().catch(function(error) {
+                engine.renderErrors.add(error);
+            });
+        }
+        return Promise.resolve();
+    };
     VideoLoader.processAssets = function processAssets(json, options) {
         if (options === void 0) options = {};
         return _async_to_generator(function() {
@@ -427,7 +461,7 @@ var VideoLoader = /*#__PURE__*/ function(AbstractPlugin) {
                         _json_videos = json.videos, videos = _json_videos === void 0 ? [] : _json_videos;
                         return [
                             4,
-                            processMultimedia(videos, effects.spec.MultimediaType.video, options)
+                            processMultimedia(videos, EFFECTS.spec.MultimediaType.video, options)
                         ];
                     case 1:
                         loadedAssets = _state.sent();
@@ -443,13 +477,27 @@ var VideoLoader = /*#__PURE__*/ function(AbstractPlugin) {
         })();
     };
     return VideoLoader;
-}(effects.AbstractPlugin);
+}(EFFECTS.AbstractPlugin);
 
-var AudioLoader = /*#__PURE__*/ function(AbstractPlugin) {
+/**
+ * 音频加载插件
+ */ var AudioLoader = /*#__PURE__*/ function(AbstractPlugin) {
     _inherits(AudioLoader, AbstractPlugin);
     function AudioLoader() {
         return AbstractPlugin.apply(this, arguments);
     }
+    AudioLoader.precompile = function precompile(compositions, renderer, options) {
+        var engine = renderer.engine;
+        var env = (options != null ? options : {
+            env: ""
+        }).env;
+        if (env === EFFECTS.PLAYER_OPTIONS_ENV_EDITOR) {
+            return checkAutoplayPermission().catch(function(error) {
+                engine.renderErrors.add(error);
+            });
+        }
+        return Promise.resolve();
+    };
     AudioLoader.processAssets = function processAssets(json, options) {
         if (options === void 0) options = {};
         return _async_to_generator(function() {
@@ -460,7 +508,7 @@ var AudioLoader = /*#__PURE__*/ function(AbstractPlugin) {
                         _json_audios = json.audios, audios = _json_audios === void 0 ? [] : _json_audios;
                         return [
                             4,
-                            processMultimedia(audios, effects.spec.MultimediaType.audio, options)
+                            processMultimedia(audios, EFFECTS.spec.MultimediaType.audio, options)
                         ];
                     case 1:
                         loadedAssets = _state.sent();
@@ -476,7 +524,7 @@ var AudioLoader = /*#__PURE__*/ function(AbstractPlugin) {
         })();
     };
     return AudioLoader;
-}(effects.AbstractPlugin);
+}(EFFECTS.AbstractPlugin);
 
 var seed = 0;
 exports.VideoComponent = /*#__PURE__*/ function(BaseRenderComponent) {
@@ -486,7 +534,7 @@ exports.VideoComponent = /*#__PURE__*/ function(BaseRenderComponent) {
         _this = BaseRenderComponent.call(this, engine) || this;
         _this.threshold = 0.03;
         _this.name = "MVideo" + seed++;
-        _this.geometry = _this.createGeometry(effects.glContext.TRIANGLES);
+        _this.geometry = _this.createGeometry(EFFECTS.glContext.TRIANGLES);
         return _this;
     }
     var _proto = VideoComponent.prototype;
@@ -503,7 +551,7 @@ exports.VideoComponent = /*#__PURE__*/ function(BaseRenderComponent) {
         });
         this.engine.removeTexture(oldTexture);
         this.renderer.texture = texture;
-        this.material.setTexture("uSampler0", texture);
+        this.material.setTexture("_MainTex", texture);
         this.video = texture.source.video;
     };
     _proto.fromData = function fromData(data) {
@@ -526,26 +574,27 @@ exports.VideoComponent = /*#__PURE__*/ function(BaseRenderComponent) {
             this.setMuted(muted);
             var endBehavior = this.item.endBehavior;
             // 如果元素设置为 destroy
-            if (endBehavior === effects.spec.EndBehavior.destroy) {
+            if (endBehavior === EFFECTS.spec.EndBehavior.destroy) {
                 this.setLoop(false);
             }
         }
         var _renderer_renderMode, _renderer_blending, _renderer_texture, _renderer_side, _renderer_mask, _renderer_maskMode;
         this.renderer = {
-            renderMode: (_renderer_renderMode = renderer.renderMode) != null ? _renderer_renderMode : effects.spec.RenderMode.BILLBOARD,
-            blending: (_renderer_blending = renderer.blending) != null ? _renderer_blending : effects.spec.BlendingMode.ALPHA,
+            renderMode: (_renderer_renderMode = renderer.renderMode) != null ? _renderer_renderMode : EFFECTS.spec.RenderMode.BILLBOARD,
+            blending: (_renderer_blending = renderer.blending) != null ? _renderer_blending : EFFECTS.spec.BlendingMode.ALPHA,
             texture: (_renderer_texture = renderer.texture) != null ? _renderer_texture : this.engine.emptyTexture,
             occlusion: !!renderer.occlusion,
-            transparentOcclusion: !!renderer.transparentOcclusion || renderer.maskMode === effects.spec.MaskMode.MASK,
-            side: (_renderer_side = renderer.side) != null ? _renderer_side : effects.spec.SideMode.DOUBLE,
+            transparentOcclusion: !!renderer.transparentOcclusion || renderer.maskMode === EFFECTS.spec.MaskMode.MASK,
+            side: (_renderer_side = renderer.side) != null ? _renderer_side : EFFECTS.spec.SideMode.DOUBLE,
             mask: (_renderer_mask = renderer.mask) != null ? _renderer_mask : 0,
-            maskMode: (_renderer_maskMode = renderer.maskMode) != null ? _renderer_maskMode : effects.spec.MaskMode.NONE,
-            order: listIndex
+            maskMode: (_renderer_maskMode = renderer.maskMode) != null ? _renderer_maskMode : EFFECTS.spec.MaskMode.NONE,
+            order: listIndex,
+            shape: renderer.shape
         };
         this.interaction = interaction;
         this.pauseVideo();
         this.setItem();
-        this.material.setVector4("_Color", new effects.math.Vector4().setFromArray(startColor));
+        this.material.setVector4("_Color", new EFFECTS.math.Vector4().setFromArray(startColor));
     };
     _proto.onUpdate = function onUpdate(dt) {
         var _this_item_composition;
@@ -555,14 +604,14 @@ exports.VideoComponent = /*#__PURE__*/ function(BaseRenderComponent) {
             this.setVisible(true);
             this.playVideo();
         }
-        if (time === 0 && ((_this_item_composition = this.item.composition) == null ? void 0 : _this_item_composition.rootItem.endBehavior) === effects.spec.EndBehavior.freeze) {
+        if (time === 0 && ((_this_item_composition = this.item.composition) == null ? void 0 : _this_item_composition.rootItem.endBehavior) === EFFECTS.spec.EndBehavior.freeze) {
             this.pauseVideo();
             this.setCurrentTime(0);
         }
         if (Math.abs(time - duration) < this.threshold) {
-            if (endBehavior === effects.spec.EndBehavior.freeze) {
+            if (endBehavior === EFFECTS.spec.EndBehavior.freeze) {
                 this.pauseVideo();
-            } else if (endBehavior === effects.spec.EndBehavior.restart) {
+            } else if (endBehavior === EFFECTS.spec.EndBehavior.restart) {
                 this.setVisible(false);
                 // 重播
                 this.pauseVideo();
@@ -653,9 +702,9 @@ exports.VideoComponent = /*#__PURE__*/ function(BaseRenderComponent) {
         this.playVideo();
     };
     return VideoComponent;
-}(effects.BaseRenderComponent);
+}(EFFECTS.BaseRenderComponent);
 exports.VideoComponent = __decorate([
-    effects.effectsClass(effects.spec.DataType.VideoComponent)
+    EFFECTS.effectsClass(EFFECTS.spec.DataType.VideoComponent)
 ], exports.VideoComponent);
 
 var AudioPlayer = /*#__PURE__*/ function() {
@@ -664,7 +713,7 @@ var AudioPlayer = /*#__PURE__*/ function() {
         this.audioSourceInfo = {};
         this.isSupportAudioContext = !!window["AudioContext"];
         this.options = {
-            endBehavior: effects.spec.EndBehavior.destroy,
+            endBehavior: EFFECTS.spec.EndBehavior.destroy,
             duration: 0
         };
         this.destroyed = false;
@@ -715,11 +764,11 @@ var AudioPlayer = /*#__PURE__*/ function() {
             var _this_audioSourceInfo = this.audioSourceInfo, audioContext = _this_audioSourceInfo.audioContext, source = _this_audioSourceInfo.source;
             if (source && audioContext) {
                 switch(this.options.endBehavior){
-                    case effects.spec.EndBehavior.destroy:
-                    case effects.spec.EndBehavior.freeze:
+                    case EFFECTS.spec.EndBehavior.destroy:
+                    case EFFECTS.spec.EndBehavior.freeze:
                         source.start(0);
                         break;
-                    case effects.spec.EndBehavior.restart:
+                    case EFFECTS.spec.EndBehavior.restart:
                         source.loop = true;
                         source.loopStart = 0;
                         source.loopEnd = this.options.duration;
@@ -853,7 +902,7 @@ exports.AudioComponent = /*#__PURE__*/ function(RendererComponent) {
             this.isVideoPlay = true;
         }
         if (Math.abs(time - duration) < this.threshold) {
-            if (endBehavior === effects.spec.EndBehavior.destroy) {
+            if (endBehavior === EFFECTS.spec.EndBehavior.destroy) {
                 this.audioPlayer.pause();
             }
         }
@@ -912,13 +961,20 @@ exports.AudioComponent = /*#__PURE__*/ function(RendererComponent) {
         this.audioPlayer.dispose();
     };
     return AudioComponent;
-}(effects.RendererComponent);
+}(EFFECTS.RendererComponent);
 exports.AudioComponent = __decorate([
-    effects.effectsClass(effects.spec.DataType.AudioComponent)
+    EFFECTS.effectsClass(EFFECTS.spec.DataType.AudioComponent)
 ], exports.AudioComponent);
 
-effects.registerPlugin("video", VideoLoader, effects.VFXItem, true);
-effects.registerPlugin("audio", AudioLoader, effects.VFXItem, true);
+/**
+ * 插件版本号
+ */ var version = "2.1.0-beta.0";
+EFFECTS.registerPlugin("video", VideoLoader, EFFECTS.VFXItem, true);
+EFFECTS.registerPlugin("audio", AudioLoader, EFFECTS.VFXItem, true);
+EFFECTS.logger.info("Plugin multimedia version: " + version + ".");
+if (version !== EFFECTS__namespace.version) {
+    console.error("注意：请统一 Multimedia 插件与 Player 版本，不统一的版本混用会有不可预知的后果！", "\nAttention: Please ensure the Multimedia plugin is synchronized with the Player version. Mixing and matching incompatible versions may result in unpredictable consequences!");
+}
 
 exports.AudioPlayer = AudioPlayer;
 exports.MultimediaError = MultimediaError;
@@ -927,4 +983,5 @@ exports.loadAudio = loadAudio;
 exports.multimediaErrorDisplayMessageMap = multimediaErrorDisplayMessageMap;
 exports.multimediaErrorMessageMap = multimediaErrorMessageMap;
 exports.processMultimedia = processMultimedia;
+exports.version = version;
 //# sourceMappingURL=index.js.map