@haxtheweb/a11y-media-player
Version:
A feature rich, highly accessible video player
1,787 lines • 77.8 kB
JSON
{
"schema_version": "1.0.0",
"classes": [
{
"description": "`a11y-media-button`\na button used in a11y-media-controls and a11y-media-transcript-controls.",
"summary": "",
"path": "lib/a11y-media-button.js",
"properties": [],
"methods": [
{
"name": "render",
"description": "",
"privacy": "public",
"sourceRange": {
"start": {
"line": 178,
"column": 2
},
"end": {
"line": 200,
"column": 3
}
},
"metadata": {},
"params": []
},
{
"name": "_buttonClick",
"description": "lets player know this button was clicked",
"privacy": "protected",
"sourceRange": {
"start": {
"line": 205,
"column": 2
},
"end": {
"line": 211,
"column": 3
}
},
"metadata": {},
"params": [
{
"name": "e"
}
],
"return": {
"type": "void"
}
}
],
"staticMethods": [],
"demos": [],
"metadata": {},
"sourceRange": {
"start": {
"line": 13,
"column": 0
},
"end": {
"line": 212,
"column": 1
}
},
"privacy": "public",
"superclass": "LitElement",
"name": "A11yMediaButton"
},
{
"description": "`a11y-media-play-button`\na giant play button that overlays the media in a11y-media-player.\n```\nCustom styles:\n--a11y-play-button-bg-color: overlay background color, default is #000000\n--a11y-play-button-focus-bg-color: overlay background color, default is --a11y-play-button-bg-color```",
"summary": "",
"path": "lib/a11y-media-play-button.js",
"properties": [],
"methods": [
{
"name": "render",
"description": "render function",
"privacy": "public",
"sourceRange": {
"start": {
"line": 91,
"column": 2
},
"end": {
"line": 171,
"column": 3
}
},
"metadata": {},
"params": []
}
],
"staticMethods": [],
"demos": [],
"metadata": {},
"sourceRange": {
"start": {
"line": 18,
"column": 0
},
"end": {
"line": 172,
"column": 1
}
},
"privacy": "public",
"superclass": "A11yMediaBehaviors",
"name": "A11yMediaPlayButton"
},
{
"description": "`a11y-media-state-manager`\nA utility that manages the state of multiple a11y-media-players on a single page.",
"summary": "",
"path": "lib/a11y-media-state-manager.js",
"properties": [
{
"name": "observer",
"type": "?",
"description": "active player observer",
"privacy": "public",
"sourceRange": {
"start": {
"line": 106,
"column": 2
},
"end": {
"line": 121,
"column": 3
}
},
"metadata": {}
}
],
"methods": [
{
"name": "checkConcurrentPlayers",
"description": "if a player disallows concurrent players, pauses other players",
"privacy": "public",
"sourceRange": {
"start": {
"line": 73,
"column": 2
},
"end": {
"line": 86,
"column": 3
}
},
"metadata": {},
"params": [],
"return": {
"type": "void"
}
},
{
"name": "setActivePlayer",
"description": "sets the active player",
"privacy": "public",
"sourceRange": {
"start": {
"line": 93,
"column": 2
},
"end": {
"line": 98,
"column": 3
}
},
"metadata": {},
"params": [
{
"name": "player"
}
],
"return": {
"type": "void"
}
},
{
"name": "_handleIntersect",
"description": "handles when active player is out of range and sets stickiness accordingly",
"privacy": "protected",
"sourceRange": {
"start": {
"line": 128,
"column": 2
},
"end": {
"line": 137,
"column": 3
}
},
"metadata": {},
"params": [
{
"name": "entries",
"type": "array"
},
{
"name": "observer",
"type": "object"
}
],
"return": {
"type": "void"
}
},
{
"name": "setStickyPlayer",
"description": "stops all other players on the page",
"privacy": "public",
"sourceRange": {
"start": {
"line": 144,
"column": 2
},
"end": {
"line": 153,
"column": 3
}
},
"metadata": {},
"params": [
{
"name": "player"
}
],
"return": {
"type": "void"
}
},
{
"name": "_handleFullscreen",
"description": "",
"privacy": "protected",
"sourceRange": {
"start": {
"line": 155,
"column": 2
},
"end": {
"line": 157,
"column": 3
}
},
"metadata": {},
"params": [
{
"name": "player"
}
],
"return": {
"type": "void"
}
},
{
"name": "connectedCallback",
"description": "",
"privacy": "public",
"sourceRange": {
"start": {
"line": 159,
"column": 2
},
"end": {
"line": 179,
"column": 3
}
},
"metadata": {},
"params": [],
"return": {
"type": "void"
}
},
{
"name": "disconnectedCallback",
"description": "life cycle, element is removed from the DOM",
"privacy": "public",
"sourceRange": {
"start": {
"line": 183,
"column": 2
},
"end": {
"line": 186,
"column": 3
}
},
"metadata": {},
"params": [],
"return": {
"type": "void"
}
}
],
"staticMethods": [],
"demos": [],
"metadata": {},
"sourceRange": {
"start": {
"line": 26,
"column": 0
},
"end": {
"line": 187,
"column": 1
}
},
"privacy": "public",
"superclass": "LitElement",
"name": "A11yMediaStateManager"
},
{
"description": "`a11y-media-transcript-cue`\na single cue in a11y-media-transcriptas static text or as an button that controls media.\n\nCustom styles:\n```--a11y-media-transcript-bg-color: background color of the transcript, default is #ffffff\n--a11y-media-transcript-text-color: color of the transcript text, default is #000000```\n\nCustom styles for focused cue:\n```--a11y-media-transcript-focused-cue-text: color of the focused cue text, default is --a11y-media-transcript-text-color\n--a11y-media-transcript-focused-cue-bg: background color of the focused cue, default is --a11y-media-transcript-bg-color\n--a11y-media-transcript-focused-cue-weight: font-weight of the focused cue, default is bold```\n\nCustom styles for active cue:\n```--a11y-media-transcript-active-cue-text: color of the active cue text, default is --a11y-media-transcript-text-color\n--a11y-media-transcript-active-cue-bg: background color of the active cue, default is #ccfffd\n--a11y-media-transcript-active-cue-weight: font-weight of the active cue, default is normal```",
"summary": "",
"path": "lib/a11y-media-transcript-cue.js",
"properties": [],
"methods": [
{
"name": "render",
"description": "",
"privacy": "public",
"sourceRange": {
"start": {
"line": 161,
"column": 2
},
"end": {
"line": 168,
"column": 3
}
},
"metadata": {},
"params": []
},
{
"name": "updated",
"description": "",
"privacy": "public",
"sourceRange": {
"start": {
"line": 169,
"column": 2
},
"end": {
"line": 182,
"column": 3
}
},
"metadata": {},
"params": [
{
"name": "changedProperties"
}
],
"return": {
"type": "void"
}
}
],
"staticMethods": [],
"demos": [],
"metadata": {},
"sourceRange": {
"start": {
"line": 27,
"column": 0
},
"end": {
"line": 183,
"column": 1
}
},
"privacy": "public",
"superclass": "LitElement",
"name": "A11yMediaTranscriptCue"
},
{
"description": "`a11y-media-youtube`\nuses YouTubeAPI to create and control an embedded YouTube video.",
"summary": "",
"path": "lib/a11y-media-youtube.js",
"properties": [
{
"name": "api",
"type": "object",
"description": "single instance of YouTube iframe script",
"privacy": "public",
"sourceRange": {
"start": {
"line": 203,
"column": 2
},
"end": {
"line": 216,
"column": 3
}
},
"metadata": {}
},
{
"name": "buffered",
"type": "number",
"description": "returns buffered media",
"privacy": "public",
"sourceRange": {
"start": {
"line": 223,
"column": 2
},
"end": {
"line": 227,
"column": 3
}
},
"metadata": {}
},
{
"name": "currentTime",
"type": "number",
"description": "elapsed time of video",
"privacy": "public",
"sourceRange": {
"start": {
"line": 234,
"column": 2
},
"end": {
"line": 238,
"column": 3
}
},
"metadata": {}
},
{
"name": "duration",
"type": "number",
"description": "duration of video",
"privacy": "public",
"sourceRange": {
"start": {
"line": 245,
"column": 2
},
"end": {
"line": 247,
"column": 3
}
},
"metadata": {}
},
{
"name": "paused",
"type": "boolean",
"description": "whether video playback is paused",
"privacy": "public",
"sourceRange": {
"start": {
"line": 254,
"column": 2
},
"end": {
"line": 258,
"column": 3
}
},
"metadata": {}
},
{
"name": "seekable",
"type": "object",
"description": "seekable range of video",
"privacy": "public",
"sourceRange": {
"start": {
"line": 265,
"column": 2
},
"end": {
"line": 273,
"column": 3
}
},
"metadata": {}
}
],
"methods": [
{
"name": "render",
"description": "render function",
"privacy": "public",
"sourceRange": {
"start": {
"line": 47,
"column": 2
},
"end": {
"line": 49,
"column": 3
}
},
"metadata": {},
"params": []
},
{
"name": "init",
"description": "",
"privacy": "public",
"sourceRange": {
"start": {
"line": 279,
"column": 2
},
"end": {
"line": 291,
"column": 3
}
},
"metadata": {},
"params": [],
"return": {
"type": "void"
}
},
{
"name": "updated",
"description": "",
"privacy": "public",
"sourceRange": {
"start": {
"line": 296,
"column": 2
},
"end": {
"line": 330,
"column": 3
}
},
"metadata": {},
"params": [
{
"name": "changedProperties",
"type": "map",
"description": "the properties that have changed"
}
],
"return": {
"type": "void"
}
},
{
"name": "play",
"description": "plays video",
"privacy": "public",
"sourceRange": {
"start": {
"line": 334,
"column": 2
},
"end": {
"line": 350,
"column": 3
}
},
"metadata": {},
"params": [],
"return": {
"type": "void"
}
},
{
"name": "pause",
"description": "pauses video",
"privacy": "public",
"sourceRange": {
"start": {
"line": 355,
"column": 2
},
"end": {
"line": 357,
"column": 3
}
},
"metadata": {},
"params": [],
"return": {
"type": "void"
}
},
{
"name": "seek",
"description": "seeks video",
"privacy": "public",
"sourceRange": {
"start": {
"line": 363,
"column": 2
},
"end": {
"line": 368,
"column": 3
}
},
"metadata": {},
"params": [
{
"name": "time",
"type": "number",
"defaultValue": "0",
"description": "in seconds"
}
],
"return": {
"type": "void"
}
},
{
"name": "setLoop",
"description": "sets video looping",
"privacy": "public",
"sourceRange": {
"start": {
"line": 374,
"column": 2
},
"end": {
"line": 376,
"column": 3
}
},
"metadata": {},
"params": [
{
"name": "loop"
}
],
"return": {
"type": "void"
}
},
{
"name": "setMute",
"description": "mutes or unmutes video",
"privacy": "public",
"sourceRange": {
"start": {
"line": 382,
"column": 2
},
"end": {
"line": 390,
"column": 3
}
},
"metadata": {},
"params": [
{
"name": "muted"
}
],
"return": {
"type": "void"
}
},
{
"name": "setPlaybackRate",
"description": "sets playbackRate function",
"privacy": "public",
"sourceRange": {
"start": {
"line": 396,
"column": 2
},
"end": {
"line": 400,
"column": 3
}
},
"metadata": {},
"params": [
{
"name": "value"
}
],
"return": {
"type": "void"
}
},
{
"name": "setVolume",
"description": "sets video volume",
"privacy": "public",
"sourceRange": {
"start": {
"line": 406,
"column": 2
},
"end": {
"line": 408,
"column": 3
}
},
"metadata": {},
"params": [
{
"name": "volume",
"type": "number",
"defaultValue": "0.7",
"description": "from 1 - 10"
}
],
"return": {
"type": "void"
}
},
{
"name": "_getSeconds",
"description": "returns time in seconds of a string, such as 00:00:00.0, 0h0m0.0s, or 0hh0mm0.0ss",
"privacy": "protected",
"sourceRange": {
"start": {
"line": 414,
"column": 2
},
"end": {
"line": 423,
"column": 3
}
},
"metadata": {},
"params": [
{
"name": "time",
"type": "string",
"defaultValue": "0"
}
],
"return": {
"type": "float",
"desc": "seconds"
}
},
{
"name": "_handleMediaStateChange",
"description": "Fires as YouTube after video src is loaded",
"privacy": "protected",
"sourceRange": {
"start": {
"line": 429,
"column": 2
},
"end": {
"line": 438,
"column": 3
}
},
"metadata": {},
"params": [
{
"name": "e"
}
],
"return": {
"type": "void"
}
},
{
"name": "_handleMediaLoaded",
"description": "Fires as YouTube video time changes",
"privacy": "protected",
"sourceRange": {
"start": {
"line": 443,
"column": 2
},
"end": {
"line": 452,
"column": 3
}
},
"metadata": {},
"params": [
{
"name": "e"
}
],
"return": {
"type": "void"
}
},
{
"name": "_handleTimeupdate",
"description": "Fires as YouTube video time changes",
"privacy": "protected",
"sourceRange": {
"start": {
"line": 458,
"column": 2
},
"end": {
"line": 467,
"column": 3
}
},
"metadata": {},
"params": [],
"return": {
"type": "void"
}
},
{
"name": "_autoMetadata",
"description": "loads metadata by playing a small clip on mute and stopping",
"privacy": "protected",
"sourceRange": {
"start": {
"line": 472,
"column": 2
},
"end": {
"line": 490,
"column": 3
}
},
"metadata": {},
"params": [],
"return": {
"type": "void"
}
},
{
"name": "_loadVideo",
"description": "loads video (and optionally preloads) from video data object {videoId, optional start timecode, }",
"privacy": "protected",
"sourceRange": {
"start": {
"line": 496,
"column": 2
},
"end": {
"line": 498,
"column": 3
}
},
"metadata": {},
"params": [
{
"name": "preload",
"type": "string",
"defaultValue": "this.preload",
"description": "mode for preloading: `auto`, `metadata`, `none`"
}
],
"return": {
"type": "void"
}
},
{
"name": "_preloadVideo",
"description": "initializes the youtube player for a given element\nSee https://developers.google.com/youtube/player_parameters for more information",
"privacy": "protected",
"sourceRange": {
"start": {
"line": 506,
"column": 2
},
"end": {
"line": 560,
"column": 3
}
},
"metadata": {},
"params": [
{
"name": "auto",
"defaultValue": "false"
}
],
"return": {
"type": "object",
"desc": "the YouTube player object"
}
},
{
"name": "_removeIframe",
"description": "removes iframe aand resets container",
"privacy": "protected",
"sourceRange": {
"start": {
"line": 565,
"column": 2
},
"end": {
"line": 575,
"column": 3
}
},
"metadata": {},
"params": [],
"return": {
"type": "void"
}
},
{
"name": "connectedCallback",
"description": "",
"privacy": "public",
"sourceRange": {
"start": {
"line": 576,
"column": 2
},
"end": {
"line": 579,
"column": 3
}
},
"metadata": {},
"params": [],
"return": {
"type": "void"
}
},
{
"name": "disconnectedCallback",
"description": "",
"privacy": "public",
"sourceRange": {
"start": {
"line": 580,
"column": 2
},
"end": {
"line": 583,
"column": 3
}
},
"metadata": {},
"params": [],
"return": {
"type": "void"
}
}
],
"staticMethods": [
{
"name": "warmConnections",
"description": "inspired by https://github.com/paulirish/lite-youtube-embed/blob/master/src/lite-yt-embed.js",
"privacy": "public",
"sourceRange": {
"start": {
"line": 163,
"column": 2
},
"end": {
"line": 185,
"column": 3
}
},
"metadata": {},
"params": [],
"return": {
"type": "void"
}
},
{
"name": "addPrefetch",
"description": "Add a <link rel={preload | preconnect} ...> to the head",
"privacy": "public",
"sourceRange": {
"start": {
"line": 189,
"column": 2
},
"end": {
"line": 197,
"column": 3
}
},
"metadata": {},
"params": [
{
"name": "kind"
},
{
"name": "url"
},
{
"name": "as"
}
],
"return": {
"type": "void"
}
}
],
"demos": [],
"metadata": {},
"sourceRange": {
"start": {
"line": 24,
"column": 0
},
"end": {
"line": 584,
"column": 1
}
},
"privacy": "public",
"superclass": "LitElement",
"name": "A11yMediaYoutube"
},
{
"description": "`a11y-media-player`\nan accessible video player\n\n ### Styling\n `<a11y-media-player>` provides the following basic custom properties\n for styling:\n \n #### Basic Styling\n \n Custom property | Description | Default\n ----------------|-------------|----------\n `--a11y-media-color` | default text color | `--simple-colors-default-theme-grey-11`\n `--a11y-media-bg-color` | default background color | `--simple-colors-default-theme-grey-2`\n `--a11y-media-border-color` | default border color | `--simple-colors-default-theme-grey-3`\n `--a11y-media-hover-color` | text color when hovering | `--simple-colors-default-theme-grey-12`\n `--a11y-media-hover-bg-color` | background color when hovering | `--simple-colors-default-theme-grey-2`\n `--a11y-media-accent-color` | accent color | `--simple-colors-default-theme-accent-9`\n `--a11y-media-faded-accent-color` | accent color when faded | `--simple-colors-default-theme-accent-8`\n `--a11y-media-disabled-color` | color for disabled items | `--simple-colors-default-theme-grey-5`\n `--a11y-media-transcript-color` | default text color of transcript | `--simple-colors-default-theme-grey-7`\n `--a11y-media-transcript-bg-color` | default background color of transcript | `--simple-colors-default-theme-grey-1`\n `--a11y-media-transcript-accent-color` | default accent color of transcript | `--simple-colors-default-theme-accent-8`\n `--a11y-media-transcript-faded-accent-color` | accent color of transcript, faded | `--simple-colors-default-theme-accent-10`\n `--a11y-media-transcript-cue-color` | text color of transcript cue | `--simple-colors-fixed-theme-grey-12`\n `--a11y-media-transcript-cue-bg-color` | background color of transcript cue | `--simple-colors-fixed-theme-grey-1`\n `--a11y-media-transcript-active-cue-color` | text color of active transcript cue | `--simple-colors-fixed-theme-grey-12`\n `--a11y-media-transcript-active-cue-bg-color` | background color of active transcript cue | `--simple-colors-fixed-theme-accent-1`\n `--a11y-media-transcript-focused-cue-color` | text color of focused transcript cue | `--simple-colors-fixed-theme-grey-12`\n `--a11y-media-transcript-focused-cue-bg-color` | background color of focused transcript cue | `--simple-colors-fixed-theme-grey-2`\n `--a11y-media-transcript-match-color` | text color of matched term in transcript search | `--simple-colors-fixed-theme-grey-1`\n `--a11y-media-transcript-match-bg-color` | background color of matched term in transcript search | `--simple-colors-fixed-theme-accent-10`\n `--a11y-media-transcript-match-border-color` | border color of matched term in transcript search | `--simple-colors-fixed-theme-accent-12`\n \n #### Controls\n Custom property | Description | Default \n ----------------|-------------|----------\n `--a11y-media-scrollbar-width` | default width of scrollbars | `5px`\n `--a11y-media-controls-font-family` | font-family of controls\n \n #### Buttons\n Custom property | Description | Default\n ----------------|-------------|----------\n `--a11y-media-button-color` | button text color | `--a11y-media-color`\n `--a11y-media-button-bg-color` | button background color | `--a11y-media-bg-color`\n `--a11y-media-button-hover-color` | button text color when hovering | `--a11y-media-accent-color`\n `--a11y-media-button-hover-bg-color` | button background color when hovering | `--a11y-media-hover-bg-color`\n `--a11y-media-button-disabled-color` | button text color when disabled | `--a11y-media-disabled-color`\n `--a11y-media-button-toggle-color` | button text color when toggled | `--a11y-media-faded-accent-color`\n \n #### Sliders\n Custom property | Description | Default\n ----------------|-------------|----------\n `--simple-range-input-active-color` | slider color when active | `--a11y-media-accent-color`\n `--simple-range-input-secondary-color` | slider color for buffering | `--a11y-media-faded-accent-color`\n `--simple-range-input-pin-color` | slider pin color | `--a11y-media-bg-color`\n `--simple-range-input-pin-start-color` | slider pin color in start position | `--a11y-media-bg-color`\n `--simple-range-input-pin-end-color` | slider pin color in end position | `--a11y-media-bg-color`\n `--simple-range-input-knob-color` | slider knob color | `--a11y-media-accent-color`\n `--simple-range-input-knob-start-color` | slider knob color in start position | `--a11y-media-accent-color`\n `--simple-range-input-knob-end-color` | slider knob color in end position | `--a11y-media-bg-accent-color`\n `--simple-range-input-knob-border-color` | slider knob border color | `--a11y-media-accent-color`\n `--simple-range-input-knob-start-border-color` | slider knob border color in start position | `--a11y-media-bg-color`\n `--simple-range-input-knob-end-border-color` | slider knob border color in end position | `--a11y-media-bg-color`\n \n #### Settings Menu\n Custom property | Description | Default\n ----------------|-------------|----------\n `--a11y-media-settings-menu-color` | settings menu text color | `--a11y-media-color`\n `--a11y-media-settings-menu-bg-color` | settings menu background color | `--a11y-media-bg-color`\n `--a11y-media-settings-menu-hover-color` | settings menu text color when hovering | `--a11y-media-hover-color`\n `--a11y-media-settings-menu-hover-bg-color` | settings menu background color when hovering | `--a11y-media-hover-bg-color`\n \n #### Link Sharing Toast\n Custom property | Description | Default\n ----------------|-------------|----------\n `--simple-toast-color` | toast text color | `--a11y-media-color`\n `--simple-toast-background-color` | toast background color | `--a11y-media-bg-color`",
"summary": "",
"path": "a11y-media-player.js",
"properties": [
{
"name": "anchor",
"type": "number",
"description": "gets anchors from page and uses their timecodes",
"privacy": "public",
"sourceRange": {
"start": {
"line": 1915,
"column": 2
},
"end": {
"line": 1921,
"column": 3
}
},
"metadata": {}
},
{
"name": "aspect",
"type": "number",
"description": "the aspect ratio of the media, or if unknown, `16/9`",
"privacy": "public",
"sourceRange": {
"start": {
"line": 1928,
"column": 2
},
"end": {
"line": 1934,
"column": 3
}
},
"metadata": {}
},
{
"name": "audioNoThumb",
"type": "boolean",
"description": "returns true if an attribute is set to a value",
"privacy": "public",
"sourceRange": {
"start": {
"line": 1941,
"column": 2
},
"end": {
"line": 1946,
"column": 3
}
},
"metadata": {}
},
{
"name": "buffered",
"type": "number",
"description": "returns buffered media",
"privacy": "public",
"sourceRange": {
"start": {
"line": 1953,
"column": 2
},
"end": {
"line": 1957,
"column": 3
}
},
"metadata": {}
},
{
"name": "captionCues",
"type": "array",
"description": "gets caption cues that should be visible for custom captions",
"privacy": "public",
"sourceRange": {
"start": {
"line": 1964,
"column": 2
},
"end": {
"line": 1980,
"column": 3
}
},
"metadata": {}
},
{
"name": "captionsPicker",
"type": "?",
"description": "gets options for captions picker",
"privacy": "public",
"sourceRange": {
"start": {
"line": 1988,
"column": 2
},
"end": {
"line": 2001,
"column": 3
}
},
"metadata": {}
},
{
"name": "captionsTrackKey",
"type": "?",
"description": "`key` of selected textTrack based on `captionsTrack` and `cc` values\n ",
"privacy": "public",
"sourceRange": {
"start": {
"line": 2006,
"column": 2
},
"end": {
"line": 2008,
"column": 3
}
},
"metadata": {}
},
{
"name": "cues",
"type": "?",
"description": "returns cues array\n ",
"privacy": "public",
"sourceRange": {
"start": {
"line": 2013,
"column": 2
},
"end": {
"line": 2015,
"column": 3
}
},
"metadata": {}
},
{
"name": "duration",
"type": "number",
"description": "returns media duration",
"privacy": "public",
"sourceRange": {
"start": {
"line": 2022,
"column": 2
},
"end": {
"line": 2030,
"column": 3
}
},
"metadata": {}
},
{
"name": "flexLayout",
"type": "boolean",
"description": "determines if player is in flex-layout mode",
"privacy": "public",
"sourceRange": {
"start": {
"line": 2036,
"column": 2
},
"end": {
"line": 2044,
"column": 3
}
},
"metadata": {}
},
{
"name": "fullFlex",
"type": "boolean",
"description": "determines if parent is wide enough for full flex-layout mode",
"privacy": "public",
"sourceRange": {
"start": {
"line": 2050,
"column": 2
},
"end": {
"line": 2056,
"column": 3
}
},
"metadata": {}
},
{
"name": "fullscreenButton",
"type": "boolean",
"description": "whether or not the fullscreen mode is be disabled",
"privacy": "public",
"sourceRange": {
"start": {
"line": 2062,
"column": 2
},
"end": {
"line": 2066,
"column": 3
}
},
"metadata": {}
},
{
"name": "hasCaptions",
"type": "boolean",
"description": "whether the media has any tracks",
"privacy": "public",
"sourceRange": {
"start": {
"line": 2074,
"column": 2
},
"end": {
"line": 2076,
"column": 3
}
},
"metadata": {}
},
{
"name": "isYoutube",
"type": "boolean",
"description": "whether media is YouTube",
"privacy": "public",
"sourceRange": {
"start": {
"line": 2083,
"column": 2
},
"end": {
"line": 2085,
"column": 3
}
},
"metadata": {}
},
{
"name": "loadedTracks",
"type": "object",
"description": "HTML `audio` or `video` tag where textTracks, if any, can be found",
"privacy": "public",
"sourceRange": {
"start": {
"line": 2092,
"column": 2
},
"end": {
"line": 2094,
"column": 3
}
},
"metadata": {}
},
{
"name": "localizationDefaults",
"type": "object",
"description": "object that contains default localization",
"privacy": "public",
"sourceRange": {
"start": {
"line": 2102,
"column": 2
},
"end": {
"line": 2215,
"column": 3
}
},
"metadata": {}
},
{
"name": "media",
"type": "?",
"description": "media used for playback",
"privacy": "public",
"sourceRange": {
"start": {
"line": 2221,
"column": 2
},
"end": {
"line": 2223,
"column": 3
}
},
"metadata": {}
},
{
"name": "mediaCaption",
"type": "string",
"description": "gets media caption",
"privacy": "public",
"sourceRange": {
"start": {
"line": 2230,
"column": 2
},
"end": {
"line": 2245,
"column": 3
}
},
"metadata": {}
},
{
"name": "mediaEnd",
"type": "number",
"description": "gets media media time if set",
"privacy": "public",
"sourceRange": {
"start": {
"line": 2252,
"column": 2
},
"end": {
"line": 2256,
"column": 3
}
},
"metadata": {}
},
{
"name": "mediaMaxWidth",
"type": "string",
"description": "`style` for `#player-and-controls`",
"privacy": "public",
"sourceRange": {
"start": {
"line": 2263,
"column": 2
},
"end": {
"line": 2269,
"column": 3
}
},
"metadata": {}
},
{
"name": "mediaSeekable",
"type": "boolean",
"description": "whether media has a seekable time range",
"privacy": "public",
"sourceRange": {
"start": {
"line": 2276,
"column": 2
},
"end": {
"line": 2280,
"column": 3
}
},
"metadata": {}
},
{
"name": "mediaStart",
"type": "number",
"description": "gets media start time",
"privacy": "public",
"sourceRange": {
"start": {
"line": 2287,
"column": 2
},
"end": {
"line": 2291,
"column": 3
}
},
"metadata": {}
},
{
"name": "playing",
"type": "boolean",
"description": "whether media is currently playing",
"privacy": "public",
"sourceRange": {
"start": {
"line": 2298,
"column": 2
},
"end": {
"line": 2300,
"column": 3
}
},
"metadata": {}
},
{
"name": "playerStyle",
"type": "string",
"description": "`style` for `#player`",
"privacy": "public",
"sourceRange": {
"start": {
"line": 2307,
"column": 2
},
"end": {
"line": 2318,
"column": 3
}
},
"metadata": {}
},
{
"name": "poster",
"type": "string",
"description": "`poster` image for video",
"privacy": "public",
"sourceRange": {
"start": {
"line": 2325,
"column": 2
},
"end": {
"line": 2337,
"column": 3
}
},
"metadata": {}
},
{
"name": "printCaption",
"type": "string",
"description": "gets print caption",
"privacy": "public",
"sourceRange": {
"start": {
"line": 2344,
"column": 2
},
"end": {
"line": 2360,
"column": 3
}
},
"metadata": {}
},
{
"name": "currentTime",
"type": "number",
"description": "returns the current playback progress or slider position",
"privacy": "public",
"sourceRange": {
"start": {
"line": 2367,
"column": 2
},
"end": {
"line": 2376,
"column": 3
}
},
"metadata": {}
},
{
"name": "shareLink",
"type": "string",
"description": "gets the link for sharing the video at a specific timecode",
"privacy": "public",
"sourceRange": {
"start": {
"line": 2383,
"column": 2
},
"end": {
"line": 2391,
"column": 3
}
},
"metadata": {}
},
{
"name": "showCustomCaptions",
"type": "boolean",
"description": "Show custom CC (for audio and YouTube)?",
"privacy": "public",
"sourceRange": {
"start": {
"line": 2397,
"column": 2
},
"end": {
"line": 2399,
"column": 3
}
},
"metadata": {}
},
{
"name": "status",
"type": "string",
"description": "gets playback status text",
"privacy": "public",
"sourceRange": {
"start": {
"line": 2407,
"column": 2
},
"end": {
"line": 2419,
"column": 3
}
},
"metadata": {}
},
{
"name": "stickyMode",
"type": "boolean",
"description": "Show custom CC (for audio and YouTube)?",
"privacy": "public",
"sourceRange": {
"start": {
"line": 2425,
"column": 2
},
"end": {
"line": 2427,
"column": 3
}
},
"metadata": {}
},
{
"name": "t",
"type": "array",
"description": "gets initial timecode parameter",
"privacy": "public",
"sourceRange": {
"start": {
"line": 2434,
"column": 2
},
"end": {
"line": 2440,
"column": 3
}
},
"metadata": {}
},
{
"name": "transcriptCues",
"type": "array",
"description": "gets transcript cues that should be visible",
"privacy": "public",
"sourceRange": {
"start": {
"line": 2447,
"column": 2
},
"end": {
"line": 2450,
"column": 3
}
},
"metadata": {}
},
{
"name": "transcriptPicker",
"type": "?",
"description": "gets options for transcript picker",
"privacy": "public",
"sourceRange": {
"start": {
"line": 2458,
"column": 2
},
"end": {
"line": 2471,
"column": 3
}
},
"metadata": {}
},
{
"name": "transcriptTrackKey",
"type": "?",
"description": "`key` of selected textTrack based on `transcriptTrack` and `hide-transcript` values\n ",
"privacy": "public",
"sourceRange": {
"start": {
"line": 2476,
"column": 2
},
"end": {
"line": 2478,
"column": 3
}
},
"metadata": {}
},
{
"name": "videoData",
"type": "?",
"description": "",
"privacy": "public",
"sourceRange": {
"start": {
"line": 2480,
"column": 2
},
"end": {
"line": 2493,
"column": 3
}
},
"metadata": {}
},
{
"name": "videoId",
"type": "?",
"description": "",
"privacy": "public",
"sourceRange": {
"start": {
"line": 2494,
"column": 2
},
"end": {
"line": 2496,
"column": 3
}
},
"metadata": {}
},
{
"name": "youtube",
"type": "object",
"description": "youtube embed element",
"privacy": "public",
"sourceRange": {
"start": {
"line": 2503,
"column": 2
},
"end": {
"line": 2507,
"column": 3
}
},
"metadata": {}
},
{
"name": "fullscreenTarget",
"type": "?",
"description": "element to make fullscreen, can be overidden",
"privacy": "public",
"sourceRange": {
"start": {
"line": 3136,
"column": 2
},
"end": {
"line": 3140,
"column": 3
}
},
"metadata": {}
}
],
"methods": [
{
"name": "render",
"description": "render function",
"privacy": "public",
"sourceRange": {
"start": {
"line": 925,
"column": 2
},
"end": {
"line": 1457,
"column": 3
}
},
"metadata": {},
"params": []
},
{
"name": "_setAttribute",
"description": "",
"privacy": "protected",
"sourceRange": {
"start": {
"line": 2509,
"column": 2
},
"end": {
"line": 2515,
"column": 3
}
},
"metadata": {},
"params": [
{
"name": "attr"
},
{
"name": "val"
}
],
"return": {
"type": "void"
}
},
{
"name": "updated",
"description": "",
"privacy": "public",
"sourceRange": {
"start": {
"line": 2520,
"column": 2
},
"end": {
"line": 2605,
"column": 3
}
},
"metadata": {},
"params": [
{
"name": "changedProperties",
"type": "map",
"description": "the properties that have changed"
}
],
"return": {
"type": "void"
}
},
{
"name": "_captionsChanged",
"description": "updates track mode & `__captionsOption` when `captionsTrack` or `cc` changes",
"privacy": "protected",
"sourceRange": {
"start": {
"line": 2610,
"column": 2
},
"end": {
"line": 2619,
"column": 3
}
},
"metadata": {},
"params": [],
"return": {
"type": "void"
}
},
{
"name": "_captionsOptionChanged",
"description": "updates track mode & `captionsTrack` when `__captionsOption` changes",
"privacy": "protected",
"sourceRange": {
"start": {
"line": 2624,
"column": 2
},
"end": {
"line": 2631,
"column": 3
}
},
"metadata":