{"_id":"ayamel.js","_rev":"26-0507318828fb7b5c1e24dc14f9b8a6c1","name":"ayamel.js","description":"Client-side services and display elements for the Flagship Media Library interface","dist-tags":{"latest":"0.1.5"},"versions":{"0.1.1":{"name":"ayamel.js","version":"0.1.1","author":{"name":"BYU-ARCLITE"},"description":"Client-side services and display elements for the Flagship Media Library interface","repository":{"type":"git","url":"https://github.com/BYU-ARCLITE/TimedText.git"},"dependencies":{"timed-text":"0.1.x"},"bugs":{"url":"https://github.com/BYU-ARCLITE/TimedText/issues"},"_id":"ayamel.js@0.1.1","dist":{"shasum":"c3cfed5250df0ad2f70cff978c15e0ea38392f59","tarball":"https://registry.npmjs.org/ayamel.js/-/ayamel.js-0.1.1.tgz","integrity":"sha512-9svcWotHjbTooqp61qIW80BVrojc7xSov++9ywR0nUGbFK92jRAcEt9Nt5w/FMDOZyT/z6bnlMq3e7aFuuqSmQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIAw5GlAcQ/0LBltQV2yc+z75ztE8LPiDaKrpHUCLoFZyAiEA9qsMs8E0YUQqPL/L3f+ifvXvkXGgnsy9OQRa9nyNIq8="}]},"_from":".","_npmVersion":"1.3.11","_npmUser":{"name":"davidmikesimon","email":"dsimon@americancouncils.org"},"maintainers":[{"name":"davidmikesimon","email":"dsimon@americancouncils.org"}]},"0.1.2":{"name":"ayamel.js","version":"0.1.2","author":{"name":"BYU-ARCLITE"},"description":"Client-side services and display elements for the Flagship Media Library interface","repository":{"type":"git","url":"https://github.com/BYU-ARCLITE/Ayamel.js.git"},"dependencies":{"timed-text":"0.1.x"},"bugs":{"url":"https://github.com/BYU-ARCLITE/Ayamel.js/issues"},"_id":"ayamel.js@0.1.2","dist":{"shasum":"7ba8592689eb3c7f3d98c874e59967ae096ded0d","tarball":"https://registry.npmjs.org/ayamel.js/-/ayamel.js-0.1.2.tgz","integrity":"sha512-ysxr60wqvDIEKie/jn/xzM/P2n/viqBG7+tw4yYdN4BUMMeoqu2cH6IFSBwZYgvvUwcrDIYnWwYelhp/mKnMaQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDWGXotAWcYFz+lWc1UWCwWsKVQUh/aL/JNdJLyNLBxugIhAO5iW3E0ol9m5iaFABpSSo0+OYzlMThRA/Qs1neadxpo"}]},"_from":".","_npmVersion":"1.3.11","_npmUser":{"name":"davidmikesimon","email":"dsimon@americancouncils.org"},"maintainers":[{"name":"davidmikesimon","email":"dsimon@americancouncils.org"}]},"0.1.3":{"name":"ayamel.js","version":"0.1.3","author":{"name":"BYU-ARCLITE"},"description":"Client-side services and display elements for the Flagship Media Library interface","repository":{"type":"git","url":"https://github.com/BYU-ARCLITE/Ayamel.js.git"},"dependencies":{"timed-text":"0.1.x"},"bugs":{"url":"https://github.com/BYU-ARCLITE/Ayamel.js/issues"},"_id":"ayamel.js@0.1.3","dist":{"shasum":"0f27ad8f312dbe6c9b415a477bc1747e9fb49eb3","tarball":"https://registry.npmjs.org/ayamel.js/-/ayamel.js-0.1.3.tgz","integrity":"sha512-cpR/JDbonM3cM3lUFNEWtUe9AKmluSB0BmpKAu9RyB6Jyi6R96/e0u1btS48e3JyLqtIpC9s/7z9j6446vvjXA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQD7V5WnAubUrN+3haeKMIxid1pZIUnzTCrCca8rUlQZNQIhAMAdHvav1fqKZDGt1lN8x6Yd6hw1Yu4sXptMyoHBePAg"}]},"_from":".","_npmVersion":"1.3.11","_npmUser":{"name":"davidmikesimon","email":"dsimon@americancouncils.org"},"maintainers":[{"name":"davidmikesimon","email":"dsimon@americancouncils.org"}]},"0.1.5":{"name":"ayamel.js","version":"0.1.5","author":{"name":"BYU-ARCLITE"},"description":"Client-side services and display elements for the Flagship Media Library interface","repository":{"type":"git","url":"https://github.com/BYU-ARCLITE/Ayamel.js.git"},"dependencies":{"timed-text":"0.1.x"},"bugs":{"url":"https://github.com/BYU-ARCLITE/Ayamel.js/issues"},"homepage":"https://github.com/BYU-ARCLITE/Ayamel.js","_id":"ayamel.js@0.1.5","_shasum":"8576fc4c53b6084d6544325907955105656bd579","_from":".","_npmVersion":"1.4.10","_npmUser":{"name":"davidmikesimon","email":"dsimon@americancouncils.org"},"maintainers":[{"name":"davidmikesimon","email":"dsimon@americancouncils.org"}],"dist":{"shasum":"8576fc4c53b6084d6544325907955105656bd579","tarball":"https://registry.npmjs.org/ayamel.js/-/ayamel.js-0.1.5.tgz","integrity":"sha512-YDNxEHzntbPo5VaWnd2NFMkP5hRXBUjmgMSJJwwX17B3Oj9pmE6/0XD1/KmVxVzZzzmGemNP3ZqSg/ibeivxpQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQChxmT5ckQW+T/gaGgygB0izDGU4IfZnMSnotdKx84dAwIhALi6IZbN1nWvl306IbV+BYKaZ+7fAhxtM4dMX/wCGPKr"}]}}},"readme":"# Ayamel.js\n\nClient-side services and display elements for the Flagship Media Library interface.\n\nScripts, purposes, and usage.\n\nTable of Contents:\n + [actor.js](#actor)\n + [annotator.js](#annotator)\n + [async.js](#async)\n + [Ayamel.js](#ayamel)\n + [ControlBar.js](#controlBar)\n + [ControlBarComponents.js](#controlBarComponents)\n + [h5Clip.js](#h5Clip)\n + [language_modules.js](#languageModules)\n + [h5Clip.js](#h5Clip)\n + [MediaController.js](#mediaController)\n + [MediaControls.js](#mediaControls)\n + [ProgressBar.js](#progressBar)\n + [swfobject.js](#swfobject)\n + [Text.js](#text)\n + [textmenu.js](#textmenu)\n + [TimedMedia.js](#timedMedia)\n + [UniformAspectRatio.js](#uniformAspectRatio)\n + [video.js](#video)\n + [VideoPlayer.js](#videoPlayer)\n + [ytClip.js](#ytClip)\n\n## <a name=\"actor\"></a>actor.js\nUm... I'm not sure how this fits in.\n\n**Dependencies:**\n + `Ayamel.js`\n\n## <a name=\"annotator\"></a>annotator.js\nUsed for annotating stuff. You can call it with one of the following:\n\n```javascript\nAnnotator.HTML(config, content);\n```\n    \nAnnotates HTML.\n\nParameter | Type | Description\n--- | ---| ---\nconfig | Object | Configuration. Not sure exactly what it needs/can contain.\ncontent | DOM Element? | The content to annotate\n\n***\n\n```javascript\nAnnotator.Text(config, content);\n```\n    \nAnnotates text.\n\nParameter | Type | Description\n--- | ---| ---\nconfig | Object | Configuration. Not sure exactly what it needs/can contain.\ncontent | String? | The content to annotate\n\n**Dependencies:**\n + *None*\n\n## <a name=\"async\"></a>async.js\nDon't know.\n\n**Dependencies:**\n + *None*\n\n## <a name=\"ayamel\"></a>Ayamel.js\nThis is the starting point of the Ayamel scripts. This defines a namespace contained within the `Ayamel` object. It also defines an AyamelElement which is used as the prototype for other elements. You'll never call just the Ayamel object, but one of the sub objects which each require a separate script to work properly. These include:\n + TimedMedia\n + VideoPlayer\n + Video\n + Text\n\n**Dependencies:**\n + *None*\n\n**Used by:**\n + `actor.js`\n + `MediaController.js`\n + `Text.js`\n + `TimedMedia.js`\n + `UniformAspectRatio.js`\n + `video.js`\n + `VideoPlayer.js`\n\n## <a name=\"controlBar\"></a>ControlBar.js\nThis is the control bar for media controller. This creates a graphical interface that can be used to control media playback. This is a customizable alternative to `MediaControls.js`.\n\n**Dependencies:**\n + `ProgressBar.js`\n + `ControlBarComponents.js`\n + jQuery\n\n**Used by:**\n + `MediaController.js`\n\nYou shouldn't ever need to call it, as it's called from `MediaController.js`\n\n## <a name=\"controlBarComponents\"></a>ControlBarComponents.js\n\nThis defines a bunch of components that can be added to the control bar. You shouldn't ever need to call this, as you can define the components through the video player.\n\n**Dependencies:**\n + jQuery\n\n**Used by:**\n + `ControlBar.js`\n \n## <a name=\"h5Clip\"></a>h5Clip.js\nThis script defines the video player installer which can be used to support HTML5 video.\n\n**Dependencies:**\n + `Ayamel.js`\n + `video.js`\n\nTo use the installer, do one of the following:\n\n```javascript\nAyamel.AddVideoPlayer(h5PlayerInstall, priority, callback);\nAyamel.InstallVideoPlayers([h5PlayerInstall, ...], callback)\n```\n    \nFor a description of these functions, see `video.js`\n\n## <a name=\"languageModules\"></a>language_modules.js\nSomething to do with languages.\n\n**Dependencies:**\n + *None*\n\n## <a name=\"mediaController\"></a>MediaController.js\n\nAs the name suggests, this is a controller for media. This connects the media player with the controls.\n\n**Dependencies:**\n + `Ayamel.js`\n + `ControlBar.js` or `MediaControls.js`\n\n**Used by:**\n + `VideoPlayer.js`\n\n## <a name=\"mediaControls\"></a>MediaControls.js\nProvides a graphical interface for controlling media. Can use `ControlBar.js` instead.\n\n**Dependencies:**\n + *None*\n\n**Used by:**\n + `MediaController.js`\n\n## <a name=\"progressBar\"></a>ProgressBar.js\n\nThe progress bar used by the control bar.\n\n**Dependencies:**\n + jQuery\n\n**Used by:**\n + `ControlBar.js`\n\n## <a name=\"swfobject\"></a>swfobject.js\nUsed to load flash objects onto the page.\n\n**Dependencies:**\n + *None*\n\n**Used by:**\n + `ytClip.js`\n\n## <a name=\"text\"></a>Text.js\nHas to do with text somehow.\n\n**Dependencies:**\n + `Ayamel.js`\n + `TextMenu.js`\n\n## <a name=\"textmenu\"></a>textmenu.js\nA menu for text?\n\n**Used by:**\n + `TextMenu.js`\n\n## <a name=\"timedMedia\"></a>TimedMedia.js\nAn abstract layer for working with timed media (video, audio).\n\n**Dependencies:**\n + `Ayamel.js`\n\n**Used by:**\n + `video.js`\n\n## <a name=\"uniformAspectRatio\"></a>UniformAspectRatio.js\nThis helps maniuplate DOM Elements such that a certain aspect ratio can be maintained.\n\n**Dependencies:**\n + `Ayamel.js`\n\n**Used by:**\n + `VideoPlayer.js`\n\n## <a name=\"video\"></a>video.js\nThis adds video support. Provides video player installers.\n\n**Dependencies:**\n + `TimedMedia.js`\n\nIt provides the following video player installers within the Ayamel namespace:\n\n```javascript\nAyamel.AddVideoPlayer(installer, priority, callback)\n```\n\nInstalls a video player.\n\nParameter | Type | Description\n--- | ---| ---\ninstaller | Player installer | The video player installer.\npriority | integer | The priority of the player. The lower the number the more preferred the player\ncallback | function | A callback function\n\n***\n\n```javascript\nAyamel.InstallVideoPlayers(installers, callback)\n```\n    \nInstalls multiple video players.\n    \nParameter | Type | Description\n--- | ---| ---\ninstallers | Array of player installers | The list of video players to install. The order is the priority.\ncallback | function | A callback function\n\n## <a name=\"videoPlayer\"></a>VideoPlayer.js\n\nAn interface for creating video players on the page.\n\n**Dependencies:**\n + `Ayamel.js`\n + `MediaController.js`\n + `UniformAspectRatio.js`\n\nTo create a video player, do the following:\n\n```javascript\nvar player = Ayamel.VideoPlayer(parameters);\n```\n    \nCreates a video player on the page.\n\n`parameters` is an object. The following are valid within it:\n\nParameter | Type | Description | Required\n--- | --- | --- | ---\naspectRatio | Number | The ratio of height to width on a scale of 100. 50 is a square. | Yes\ncomponents | Array of strings | The components to add to the player. | No\nelement | DOM Element | The element where the video player will be added. | Yes\nresource | Resource | The video resource that will be played. | Yes\n\nValid components include:\n + `play` The play/pause button\n + `volume` The volume control\n + `captions` Caption track selection. For more information, see `ControlBar.js`\n + More coming soon!\n\n## <a name=\"ytClip\"></a>ytClip.js\n\nThis script defines the video player installer which can be used to support YouTube videos.\n\n**Dependencies:**\n + `Ayamel.js`\n + `swfobject.js`\n + `video.js`\n\nTo use the installer, do one of the following:\n\n```javascript\nAyamel.AddVideoPlayer(ytPlayerInstall, priority, callback);\nAyamel.InstallVideoPlayers([ytPlayerInstall, ...], callback)\n```\n    \nFor a description of these functions, see `video.js`\n\nSetup\n=====\n\n1.  Create a target element on the page  \n\t`<div id=\"timeline\"></div>`  \n\t`var target = document.getElementById(\"timeline\");`\n\n2.  Create a timeline  \n\t`var timeline = new Timeline(target, {});`  \n    The arguments are\n    *   A DOM node into which to insert the timeline.\n    *   A map of optional parameters, including:\n        *   width: the width of the timeline display in pixels (defaults\n            to the offsetWidth of the target).\n        *   length: the length of the timeline in seconds.\n        *   start: the initial starting time of the viewing window.\n        *   end: the initial ending time of the viewing window.\n\n    \n3.  Create the cues and add them to the timeline  \n\t`timeline.addTextTrack(TimedText.WebVTT.parse(vttdata), \"track-id\", \"en\");`  \n    The arguments are\n    *   An array of Cue objects or a TextTrack object\n    *   A track name\n    *   Language\n    \n4.  Add event handlers\n\t\n\t\t// addtrack is fired whenever a text track is added to the timeline\n\t\t// and passes the added track object to the listener\n\t\ttimeline.on('addtrack',function(track) {});\n\n\t\t// removetrack is fired whenever a text track is removed from the\n\t\t// timeline and passes the removed track object to the listener\n\t\ttimeline.on('removetrack',function(track) {});\n\n\t\t// select is fired whenever a segment is selected and passes the\n\t\t// segment object (which includes the backing cue object) to the listener\n\t\ttimeline.on('select',function(seg) {\n\t\t\tvar cue = seg.cue;\n\t\t\t....\n\t\t});\n\n\t\t// unselect is fired when the selection is terminated\n\t\ttimeline.on('unselect',function(seg) {});\n\n\t\t// jump is fired whenever the timeline alters its current time internally;  \n\t\t// e.g., when a repeat point is hit or when the time marker is moved manually.\n\t\ttimeline.on('jump', function(time) {\n\t\t\tcontrols.currentTime = time/1000;\n\t\t});\n\n\t\t// timeupdate is fired whenever the timeline's time marker is moved;  \n\t\t// e.g., when timeline.currentTime is set by external code\n\t\ttimeline.on('timeupdate', function(time) {});\n\n\t\t// abRepeatEnabled is fired whenever the AB repeat functionality is turned on\n\t\ttimeline.on('abRepeatEnabled',function() {});\n\n\t\t// update is fired whenever the contents of a segment change\n\t\ttimeline.on('update', function(seg) {});\n","maintainers":[{"name":"davidmikesimon","email":"dsimon@americancouncils.org"}],"time":{"modified":"2022-06-13T03:57:38.061Z","created":"2014-03-28T19:55:02.684Z","0.1.1":"2014-03-28T19:55:07.382Z","0.1.2":"2014-03-28T19:58:46.889Z","0.1.3":"2014-05-12T14:56:16.825Z","0.1.5":"2014-05-13T21:13:30.679Z"},"readmeFilename":"README.md","repository":{"type":"git","url":"https://github.com/BYU-ARCLITE/Ayamel.js.git"},"author":{"name":"BYU-ARCLITE"},"bugs":{"url":"https://github.com/BYU-ARCLITE/Ayamel.js/issues"},"homepage":"https://github.com/BYU-ARCLITE/Ayamel.js"}