mirror of https://github.com/OpenVidu/openvidu.git
Merge remote-tracking branch 'origin/councilbox' into councilbox
miguelrcDEV
commit
a1e4c253f3
|
|
@ -25,4 +25,5 @@ nbactions.xml
|
|||
log/
|
||||
\.vscode/
|
||||
*.iml
|
||||
*/.tscache/*
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,59 @@
|
|||
/node_modules/
|
||||
/yarn.lock
|
||||
/npm-debug.log
|
||||
/lib/
|
||||
# Logs
|
||||
logs
|
||||
*.log
|
||||
npm-debug.log*
|
||||
yarn-debug.log*
|
||||
yarn-error.log*
|
||||
|
||||
# Runtime data
|
||||
pids
|
||||
*.pid
|
||||
*.seed
|
||||
*.pid.lock
|
||||
|
||||
# Directory for instrumented libs generated by jscoverage/JSCover
|
||||
lib-cov
|
||||
|
||||
# Coverage directory used by tools like istanbul
|
||||
coverage
|
||||
|
||||
# nyc test coverage
|
||||
.nyc_output
|
||||
|
||||
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
|
||||
.grunt
|
||||
|
||||
# Bower dependency directory (https://bower.io/)
|
||||
bower_components
|
||||
|
||||
# node-waf configuration
|
||||
.lock-wscript
|
||||
|
||||
# Compiled binary addons (http://nodejs.org/api/addons.html)
|
||||
build/Release
|
||||
|
||||
# Dependency directories
|
||||
node_modules/
|
||||
jspm_packages/
|
||||
|
||||
# Typescript v1 declaration files
|
||||
typings/
|
||||
|
||||
# Optional npm cache directory
|
||||
.npm
|
||||
|
||||
# Optional eslint cache
|
||||
.eslintcache
|
||||
|
||||
# Optional REPL history
|
||||
.node_repl_history
|
||||
|
||||
# Output of 'npm pack'
|
||||
*.tgz
|
||||
|
||||
# Yarn Integrity file
|
||||
.yarn-integrity
|
||||
|
||||
# dotenv environment variables file
|
||||
.env
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,201 @@
|
|||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
|
|
@ -0,0 +1,154 @@
|
|||
{
|
||||
"extends": "tslint:recommended",
|
||||
"rules": {
|
||||
"array-type": [
|
||||
true,
|
||||
"array"
|
||||
],
|
||||
"ban-types": {
|
||||
"options": [
|
||||
[
|
||||
"Object",
|
||||
"Avoid using the `Object` type. Did you mean `object`?"
|
||||
],
|
||||
[
|
||||
"Function",
|
||||
"Avoid using the `Function` type. Prefer a specific function type, like `() => void`, or use `ts.AnyFunction`."
|
||||
],
|
||||
[
|
||||
"Boolean",
|
||||
"Avoid using the `Boolean` type. Did you mean `boolean`?"
|
||||
],
|
||||
[
|
||||
"Number",
|
||||
"Avoid using the `Number` type. Did you mean `number`?"
|
||||
],
|
||||
[
|
||||
"String",
|
||||
"Avoid using the `String` type. Did you mean `string`?"
|
||||
]
|
||||
]
|
||||
},
|
||||
"class-name": true,
|
||||
"comment-format": [
|
||||
true,
|
||||
"check-space"
|
||||
],
|
||||
"curly": [
|
||||
true,
|
||||
"ignore-same-line"
|
||||
],
|
||||
"indent": [
|
||||
true,
|
||||
"spaces",
|
||||
4
|
||||
],
|
||||
"interface-name": [
|
||||
true,
|
||||
"never-prefix"
|
||||
],
|
||||
"interface-over-type-literal": true,
|
||||
"jsdoc-format": true,
|
||||
"no-inferrable-types": true,
|
||||
"no-internal-module": true,
|
||||
"no-null-keyword": false,
|
||||
"no-switch-case-fall-through": true,
|
||||
"no-trailing-whitespace": [
|
||||
true,
|
||||
"ignore-template-strings"
|
||||
],
|
||||
"no-var-keyword": true,
|
||||
"object-literal-shorthand": true,
|
||||
"one-line": [
|
||||
true,
|
||||
"check-open-brace",
|
||||
"check-whitespace"
|
||||
],
|
||||
"prefer-const": true,
|
||||
"quotemark": [
|
||||
true,
|
||||
"single",
|
||||
"avoid-escape",
|
||||
"avoid-template"
|
||||
],
|
||||
"semicolon": [
|
||||
true,
|
||||
"always",
|
||||
"ignore-bound-class-methods"
|
||||
],
|
||||
"space-within-parens": true,
|
||||
"triple-equals": true,
|
||||
"typedef-whitespace": [
|
||||
true,
|
||||
{
|
||||
"call-signature": "nospace",
|
||||
"index-signature": "nospace",
|
||||
"parameter": "nospace",
|
||||
"property-declaration": "nospace",
|
||||
"variable-declaration": "nospace"
|
||||
},
|
||||
{
|
||||
"call-signature": "onespace",
|
||||
"index-signature": "onespace",
|
||||
"parameter": "onespace",
|
||||
"property-declaration": "onespace",
|
||||
"variable-declaration": "onespace"
|
||||
}
|
||||
],
|
||||
"whitespace": [
|
||||
true,
|
||||
"check-branch",
|
||||
"check-decl",
|
||||
"check-operator",
|
||||
"check-module",
|
||||
"check-separator",
|
||||
"check-type"
|
||||
],
|
||||
"no-implicit-dependencies": [
|
||||
true,
|
||||
"dev"
|
||||
],
|
||||
"object-literal-key-quotes": [
|
||||
true,
|
||||
"consistent-as-needed"
|
||||
],
|
||||
"variable-name": [
|
||||
true,
|
||||
"ban-keywords",
|
||||
"check-format",
|
||||
"allow-leading-underscore"
|
||||
],
|
||||
"arrow-parens": false,
|
||||
"arrow-return-shorthand": false,
|
||||
"forin": false,
|
||||
"member-access": false,
|
||||
"no-conditional-assignment": false,
|
||||
"no-console": false,
|
||||
"no-debugger": false,
|
||||
"no-empty-interface": false,
|
||||
"no-eval": false,
|
||||
"no-object-literal-type-assertion": false,
|
||||
"no-shadowed-variable": false,
|
||||
"no-submodule-imports": false,
|
||||
"no-var-requires": false,
|
||||
"ordered-imports": false,
|
||||
"prefer-conditional-expression": false,
|
||||
"radix": false,
|
||||
"trailing-comma": false,
|
||||
"align": false,
|
||||
"eofline": false,
|
||||
"max-line-length": false,
|
||||
"no-consecutive-blank-lines": false,
|
||||
"space-before-function-paren": false,
|
||||
"ban-comma-operator": false,
|
||||
"max-classes-per-file": false,
|
||||
"member-ordering": false,
|
||||
"no-angle-bracket-type-assertion": false,
|
||||
"no-bitwise": false,
|
||||
"no-namespace": false,
|
||||
"no-reference": false,
|
||||
"object-literal-sort-keys": false,
|
||||
"one-variable-per-declaration": false,
|
||||
"unified-signatures": false
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
// Fonts
|
||||
//
|
||||
$FONT_FAMILY: 'Segoe UI', sans-serif
|
||||
$FONT_FAMILY_MONO: Menlo, Monaco, Consolas, 'Courier New', monospace
|
||||
|
||||
$FONT_SIZE: 16px
|
||||
$FONT_SIZE_MONO: 14px
|
||||
|
||||
$LINE_HEIGHT: 1.333em
|
||||
|
||||
|
||||
// Colors
|
||||
//
|
||||
$COLOR_BACKGROUND: #fdfdfd
|
||||
$COLOR_TEXT: #222
|
||||
$COLOR_TEXT_ASIDE: #808080
|
||||
$COLOR_LINK: #4da6ff
|
||||
|
||||
$COLOR_MENU_DIVIDER: #eee
|
||||
$COLOR_MENU_DIVIDER_FOCUS: #000
|
||||
$COLOR_MENU_LABEL: #808080
|
||||
|
||||
$COLOR_PANEL: #fff
|
||||
$COLOR_PANEL_DIVIDER: #eee
|
||||
|
||||
$COLOR_COMMENT_TAG: #808080
|
||||
$COLOR_COMMENT_TAG_TEXT: #fff
|
||||
|
||||
$COLOR_CODE_BACKGROUND: rgba(#000, 0.04)
|
||||
|
||||
$COLOR_TS: #9600ff
|
||||
$COLOR_TS_INTERFACE: #7da01f
|
||||
$COLOR_TS_ENUM: #cc9900
|
||||
$COLOR_TS_CLASS: #4da6ff
|
||||
$COLOR_TS_PRIVATE: #808080
|
||||
|
||||
$TOOLBAR_COLOR: #fff
|
||||
$TOOLBAR_TEXT_COLOR: #333
|
||||
$TOOLBAR_HEIGHT: 40px
|
||||
|
|
@ -0,0 +1,53 @@
|
|||
// Displays all regular comment tags
|
||||
//
|
||||
// <dl class="tsd-comment-tags">
|
||||
// <dt>see</dt>
|
||||
// <dd><p><a href="#">Dispatcher.EVENT_BEGIN</a></p></dd>
|
||||
// <dt>see</dt>
|
||||
// <dd><p><a href="#">Dispatcher.EVENT_BEGIN_RESOLVE</a></p></dd>
|
||||
// <dt>see</dt>
|
||||
// <dd><p><a href="#">Dispatcher.EVENT_END_RESOLVE</a></p></dd>
|
||||
// </dl>
|
||||
//
|
||||
dl.tsd-comment-tags
|
||||
overflow: hidden
|
||||
|
||||
dt
|
||||
float: left
|
||||
padding: 1px 5px
|
||||
margin: 0 10px 0 0
|
||||
border-radius: 4px
|
||||
border: 1px solid $COLOR_COMMENT_TAG
|
||||
color: $COLOR_COMMENT_TAG
|
||||
font-size: 0.8em
|
||||
font-weight: normal
|
||||
|
||||
dd
|
||||
margin: 0 0 10px 0
|
||||
|
||||
&:before, &:after
|
||||
display: table
|
||||
content: " "
|
||||
pre, &:after
|
||||
clear: both
|
||||
|
||||
p
|
||||
margin: 0
|
||||
|
||||
|
||||
// Special formatting for the main reflection on each page.
|
||||
//
|
||||
// <section class="tsd-panel tsd-comment">
|
||||
// <div class="tsd-comment tsd-typography">
|
||||
// <div class="lead"><p>The default TypeDoc main application class.</p></div>
|
||||
// <p>This class holds the two main components of TypeDoc, the Dispatcher and the Renderer.</p>
|
||||
// </div>
|
||||
// </section>
|
||||
//
|
||||
.tsd-panel.tsd-comment .lead
|
||||
font-size: 1.1em
|
||||
line-height: $LINE_HEIGHT
|
||||
margin-bottom: 2em
|
||||
|
||||
&:last-child
|
||||
margin-bottom: 0
|
||||
|
|
@ -0,0 +1,65 @@
|
|||
// Classes set on the body to control the visible state of the filtered elements
|
||||
//
|
||||
.toggle-protected .tsd-is-private
|
||||
display: none
|
||||
|
||||
.toggle-public .tsd-is-private,
|
||||
.toggle-public .tsd-is-protected,
|
||||
.toggle-public .tsd-is-private-protected
|
||||
display: none
|
||||
|
||||
.toggle-inherited .tsd-is-inherited
|
||||
display: none
|
||||
|
||||
.toggle-only-exported .tsd-is-not-exported
|
||||
display: none
|
||||
|
||||
.toggle-externals .tsd-is-external
|
||||
display: none
|
||||
|
||||
|
||||
// Filter Buttons in the toolbar
|
||||
//
|
||||
#tsd-filter
|
||||
position: relative
|
||||
display: inline-block
|
||||
height: $TOOLBAR_HEIGHT
|
||||
vertical-align: bottom
|
||||
|
||||
.no-filter &
|
||||
display: none
|
||||
|
||||
.tsd-filter-group
|
||||
display: inline-block
|
||||
height: $TOOLBAR_HEIGHT
|
||||
vertical-align: bottom
|
||||
white-space: nowrap
|
||||
|
||||
input
|
||||
display: none
|
||||
|
||||
+size-xs-sm
|
||||
.tsd-filter-group
|
||||
display: block
|
||||
position: absolute
|
||||
top: $TOOLBAR_HEIGHT
|
||||
right: 20px
|
||||
height: auto
|
||||
background-color: $COLOR_PANEL
|
||||
visibility: hidden
|
||||
transform: translate(50%,0)
|
||||
box-shadow: 0 0 4px rgba(#000, 0.25)
|
||||
|
||||
.has-options &
|
||||
visibility: visible
|
||||
|
||||
.to-has-options &
|
||||
animation: fade-in 0.2s
|
||||
|
||||
.from-has-options &
|
||||
animation: fade-out 0.2s
|
||||
|
||||
label,
|
||||
.tsd-select
|
||||
display: block
|
||||
padding-right: 20px
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
footer
|
||||
border-top: 1px solid $COLOR_PANEL_DIVIDER
|
||||
background-color: $COLOR_PANEL
|
||||
|
||||
&.with-border-bottom
|
||||
border-bottom: 1px solid $COLOR_PANEL_DIVIDER
|
||||
|
||||
.tsd-legend-group
|
||||
font-size: 0
|
||||
|
||||
.tsd-legend
|
||||
display: inline-block
|
||||
width: 25%
|
||||
padding: 0
|
||||
font-size: $FONT_SIZE
|
||||
list-style: none
|
||||
line-height: $LINE_HEIGHT
|
||||
vertical-align: top
|
||||
|
||||
+size-xs-sm
|
||||
width: 50%
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
// Displays the type hierarchy
|
||||
//
|
||||
// <ul class="tsd-hierarchy">
|
||||
// <li>
|
||||
// <a href="#" class="tsd-signature-type">Event</a>
|
||||
// <ul class="tsd-hierarchy">
|
||||
// <li>
|
||||
// <span class="target">DispatcherEvent</span>
|
||||
// <ul class="tsd-hierarchy">
|
||||
// <li><a href="#" class="tsd-signature-type">BaseState</a></li>
|
||||
// <li><a href="#" class="tsd-signature-type">ReflectionEvent</a></li>
|
||||
// </ul>
|
||||
// </li>
|
||||
// </ul>
|
||||
// </li>
|
||||
// </ul>
|
||||
//
|
||||
.tsd-hierarchy
|
||||
list-style: square
|
||||
padding: 0 0 0 20px
|
||||
margin: 0
|
||||
|
||||
.target
|
||||
font-weight: bold
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
// fixes issue with images in readme
|
||||
img
|
||||
max-width: 100%
|
||||
|
|
@ -0,0 +1,80 @@
|
|||
// Displays an index of grouped links.
|
||||
//
|
||||
// <section class="tsd-panel tsd-index-panel">
|
||||
// <div class="tsd-index-content">
|
||||
// <div class="tsd-index-section">
|
||||
// <h3>Constructor methods</h3>
|
||||
// <ul class="tsd-member-index">
|
||||
// <li class="tsd-kind-constructor-method tsd-parent-kind-class"><a href="#" class="tsd-kind-icon">constructor</a></li>
|
||||
// </ul>
|
||||
// </div>
|
||||
// <div class="tsd-index-section">
|
||||
// <h3>Properties</h3>
|
||||
// <ul class="tsd-member-index">
|
||||
// <li class="tsd-kind-property tsd-parent-kind-class"><a href="#" class="tsd-kind-icon">EVENT_<wbr>BEGIN</a></li>
|
||||
// <li class="tsd-kind-property tsd-parent-kind-class"><a href="#" class="tsd-kind-icon">EVENT_<wbr>BEGIN_<wbr>DECLARATION</a></li>
|
||||
// <li class="tsd-kind-property tsd-parent-kind-class"><a href="#" class="tsd-kind-icon">EVENT_<wbr>BEGIN_<wbr>DOCUMENT</a></li>
|
||||
// <li class="tsd-kind-property tsd-parent-kind-class"><a href="#" class="tsd-kind-icon">EVENT_<wbr>BEGIN_<wbr>RESOLVE</a></li>
|
||||
// </ul>
|
||||
// </div>
|
||||
// </div>
|
||||
// </section>
|
||||
//
|
||||
.tsd-index-panel
|
||||
.tsd-index-content
|
||||
margin-bottom: -30px !important
|
||||
|
||||
.tsd-index-section
|
||||
margin-bottom: 30px !important
|
||||
|
||||
h3
|
||||
@extend h4
|
||||
margin: 0 -20px 10px -20px
|
||||
padding: 0 20px 10px 20px
|
||||
border-bottom: 1px solid $COLOR_PANEL_DIVIDER
|
||||
|
||||
ul.tsd-index-list
|
||||
+vendors(column-count, 3)
|
||||
+vendors(column-gap, 20px)
|
||||
padding: 0
|
||||
list-style: none
|
||||
line-height: $LINE_HEIGHT
|
||||
|
||||
+size-xs-sm
|
||||
+vendors(column-count, 1)
|
||||
|
||||
+size-md
|
||||
+vendors(column-count, 2)
|
||||
|
||||
li
|
||||
+vendors(column-break-inside, avoid)
|
||||
+vendors(page-break-inside, avoid)
|
||||
|
||||
a,
|
||||
.tsd-parent-kind-module a
|
||||
color: $COLOR_TS
|
||||
|
||||
.tsd-parent-kind-interface a
|
||||
color: $COLOR_TS_INTERFACE
|
||||
|
||||
.tsd-parent-kind-enum a
|
||||
color: $COLOR_TS_ENUM
|
||||
|
||||
.tsd-parent-kind-class a
|
||||
color: $COLOR_TS_CLASS
|
||||
|
||||
|
||||
.tsd-kind-module a
|
||||
color: $COLOR_TS
|
||||
|
||||
.tsd-kind-interface a
|
||||
color: $COLOR_TS_INTERFACE
|
||||
|
||||
.tsd-kind-enum a
|
||||
color: $COLOR_TS_ENUM
|
||||
|
||||
.tsd-kind-class a
|
||||
color: $COLOR_TS_CLASS
|
||||
|
||||
.tsd-is-private a
|
||||
color: $COLOR_TS_PRIVATE
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
.tsd-flag
|
||||
display: inline-block
|
||||
padding: 1px 5px
|
||||
border-radius: 4px
|
||||
color: $COLOR_COMMENT_TAG_TEXT
|
||||
background-color: $COLOR_COMMENT_TAG
|
||||
text-indent: 0
|
||||
font-size: $FONT_SIZE_MONO
|
||||
font-weight: normal
|
||||
|
||||
.tsd-anchor
|
||||
position: absolute
|
||||
top: -100px
|
||||
|
||||
.tsd-member
|
||||
position: relative
|
||||
|
||||
.tsd-anchor + h3
|
||||
margin-top: 0
|
||||
margin-bottom: 0
|
||||
border-bottom: none
|
||||
|
|
@ -0,0 +1,162 @@
|
|||
// Base format for the navigation parts.
|
||||
//
|
||||
=INDENT($DEPTH, $BASE, $STEP, $PROGRESS:$DEPTH)
|
||||
@if $PROGRESS > 0
|
||||
& li
|
||||
+INDENT($DEPTH, $BASE, $STEP, $PROGRESS - 1)
|
||||
@else
|
||||
& a
|
||||
padding-left: #{($BASE + $STEP * ($DEPTH - 1))}px
|
||||
|
||||
=INDENTS($COUNT, $BASE, $STEP)
|
||||
@for $DEPTH from 1 through $COUNT
|
||||
+INDENT($DEPTH, $BASE, $STEP)
|
||||
|
||||
.tsd-navigation
|
||||
padding: 0 0 0 40px
|
||||
|
||||
a
|
||||
display: block
|
||||
padding-top: 2px
|
||||
padding-bottom: 2px
|
||||
border-left: 2px solid transparent
|
||||
color: $COLOR_TEXT
|
||||
text-decoration: none
|
||||
transition: border-left-color 0.1s
|
||||
|
||||
&:hover
|
||||
text-decoration: underline
|
||||
|
||||
ul
|
||||
margin: 0
|
||||
padding: 0
|
||||
list-style: none
|
||||
|
||||
li
|
||||
padding: 0
|
||||
|
||||
|
||||
// Primary part of the navigation containing the available modules.
|
||||
//
|
||||
// <nav class="tsd-navigation primary">
|
||||
// <ul>
|
||||
// <li class="globals"><a href="#"><em>Globals</em></a></li>
|
||||
// <li class="current tsd-kind-container">
|
||||
// <a href="#">TypeDoc</a>
|
||||
// <ul>
|
||||
// <li class="tsd-kind-container tsd-parent-kind-container"><a href="#">Factories</a></li>
|
||||
// <li class="tsd-kind-container tsd-parent-kind-container"><a href="#">Models</a></li>
|
||||
// <li class="current tsd-kind-container tsd-parent-kind-container"><a href="#">Output</a></li>
|
||||
// </ul>
|
||||
// </li>
|
||||
// </ul>
|
||||
// </nav>
|
||||
//
|
||||
.tsd-navigation.primary
|
||||
padding-bottom: 40px
|
||||
|
||||
a
|
||||
display: block
|
||||
padding-top: 6px
|
||||
padding-bottom: 6px
|
||||
|
||||
ul
|
||||
+INDENTS(6, 5, 20)
|
||||
|
||||
> ul
|
||||
border-bottom: 1px solid $COLOR_PANEL_DIVIDER
|
||||
|
||||
li
|
||||
border-top: 1px solid $COLOR_PANEL_DIVIDER
|
||||
|
||||
&.current > a
|
||||
font-weight: bold
|
||||
|
||||
&.label span
|
||||
display: block
|
||||
padding: 20px 0 6px 5px
|
||||
color: $COLOR_MENU_LABEL
|
||||
|
||||
&.globals + li > span,
|
||||
&.globals + li > a
|
||||
padding-top: 20px
|
||||
|
||||
|
||||
// Secondary part of the navigation containing the table of contents
|
||||
// of the current module.
|
||||
// Can be made sticky by `typedoc.MenuSticky` and will highlight current sticky with `typedoc.MenuHighlight`.
|
||||
//
|
||||
// <nav class="tsd-navigation secondary">
|
||||
// <ul class="before-current">
|
||||
// <li class="tsd-kind-class tsd-parent-kind-container"><a href="#" class="tsd-kind-icon">AssetsPlugin</a></li>
|
||||
// <li class="tsd-kind-class tsd-parent-kind-container"><a href="#" class="tsd-kind-icon">BasePlugin</a></li>
|
||||
// <li class="tsd-kind-class tsd-parent-kind-container"><a href="#" class="tsd-kind-icon">BaseTheme</a></li>
|
||||
// </ul>
|
||||
// <ul class="current">
|
||||
// <li class="current tsd-kind-class tsd-parent-kind-container">
|
||||
// <a href="#" class="tsd-kind-icon">OutputEvent</a>
|
||||
// <ul>
|
||||
// <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="#" class="tsd-kind-icon">isDefaultPrevented</a></li>
|
||||
// <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="#" class="tsd-kind-icon">isPropagationStopped</a></li>
|
||||
// <li class="tsd-kind-property tsd-parent-kind-class"><a href="#" class="tsd-kind-icon">outputDirectory</a></li>
|
||||
// <li class="tsd-kind-property tsd-parent-kind-class"><a href="#" class="tsd-kind-icon">project</a></li>
|
||||
// </ul>
|
||||
// </li>
|
||||
// </ul>
|
||||
// <ul class="after-current">
|
||||
// <li class="tsd-kind-class tsd-parent-kind-container"><a href="#" class="tsd-kind-icon">OutputPageEvent</a></li>
|
||||
// <li class="tsd-kind-class tsd-parent-kind-container"><a href="#" class="tsd-kind-icon">PartialsPlugin</a></li>
|
||||
// </ul>
|
||||
// </nav>
|
||||
//
|
||||
.tsd-navigation.secondary
|
||||
ul
|
||||
+INDENTS(6, 25, 20)
|
||||
transition: opacity 0.2s
|
||||
|
||||
&.current a
|
||||
border-left-color: $COLOR_PANEL_DIVIDER
|
||||
|
||||
li.focus > a,
|
||||
ul.current li.focus > a
|
||||
border-left-color: $COLOR_MENU_DIVIDER_FOCUS
|
||||
|
||||
li.current
|
||||
margin-top: 20px
|
||||
margin-bottom: 20px
|
||||
border-left-color: $COLOR_PANEL_DIVIDER
|
||||
|
||||
> a
|
||||
font-weight: bold
|
||||
|
||||
|
||||
// Sticky menu setup
|
||||
//
|
||||
.menu-sticky-wrap
|
||||
+size-md-lg
|
||||
position: static
|
||||
|
||||
.no-csspositionsticky &
|
||||
&.sticky
|
||||
position: fixed
|
||||
|
||||
&.sticky-current
|
||||
position: fixed
|
||||
|
||||
ul.before-current,
|
||||
ul.after-current
|
||||
opacity: 0
|
||||
|
||||
&.sticky-bottom
|
||||
position: absolute
|
||||
top: auto !important
|
||||
left: auto !important
|
||||
bottom: 0
|
||||
right: 0
|
||||
|
||||
.csspositionsticky &
|
||||
&.sticky
|
||||
position: sticky
|
||||
|
||||
&.sticky-current
|
||||
position: sticky
|
||||
|
|
@ -0,0 +1,70 @@
|
|||
// Displays a panel, an organisation unit in TypeDoc used to group single entities
|
||||
// like a method or a variable.
|
||||
//
|
||||
// <div class="tsd-panel">
|
||||
// <h3>Eirmod tempor invidunt</h3>
|
||||
// <p>Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat.</p>
|
||||
// </div>
|
||||
//
|
||||
.tsd-panel
|
||||
@extend %prevent-children-margin
|
||||
margin: 20px 0
|
||||
padding: 20px
|
||||
background-color: $COLOR_PANEL
|
||||
box-shadow: 0 0 4px rgba(#000, 0.25)
|
||||
|
||||
&:empty
|
||||
display: none
|
||||
|
||||
> h1, > h2, > h3
|
||||
margin: 1.5em -20px 10px -20px
|
||||
padding: 0 20px 10px 20px
|
||||
border-bottom: 1px solid $COLOR_PANEL_DIVIDER
|
||||
|
||||
&.tsd-before-signature
|
||||
margin-bottom: 0
|
||||
border-bottom: 0
|
||||
|
||||
table
|
||||
display: block
|
||||
width: 100%
|
||||
overflow: auto
|
||||
margin-top: 10px
|
||||
word-break: normal
|
||||
word-break: keep-all
|
||||
|
||||
th
|
||||
font-weight: bold
|
||||
|
||||
th, td
|
||||
padding: 6px 13px
|
||||
border: 1px solid #ddd
|
||||
|
||||
tr
|
||||
background-color: #fff
|
||||
border-top: 1px solid #ccc
|
||||
|
||||
&:nth-child(2n)
|
||||
background-color: #f8f8f8
|
||||
|
||||
|
||||
// Holds a series of panels with an optional heading.
|
||||
//
|
||||
// <div class="tsd-panel-group">
|
||||
// <h2>Consetetur sadipscing elitr</h2>
|
||||
// <div class="tsd-panel">
|
||||
// <h3>Eirmod tempor invidunt</h3>
|
||||
// <p>Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat.</p>
|
||||
// </div>
|
||||
// <div class="tsd-panel">
|
||||
// <h3>Eirmod tempor invidunt</h3>
|
||||
// <p>Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat.</p>
|
||||
// </div>
|
||||
// </div>
|
||||
//
|
||||
.tsd-panel-group
|
||||
margin: 60px 0
|
||||
|
||||
> h1, > h2, > h3
|
||||
padding-left: 20px
|
||||
padding-right: 20px
|
||||
|
|
@ -0,0 +1,89 @@
|
|||
#tsd-search
|
||||
transition: background-color 0.2s
|
||||
|
||||
.title
|
||||
position: relative
|
||||
z-index: 2
|
||||
|
||||
.field
|
||||
position: absolute
|
||||
left: 0
|
||||
top: 0
|
||||
right: 40px
|
||||
height: 40px
|
||||
|
||||
input
|
||||
box-sizing: border-box
|
||||
position: relative
|
||||
top: -50px
|
||||
z-index: 1
|
||||
width: 100%
|
||||
padding: 0 10px
|
||||
opacity: 0
|
||||
outline: 0
|
||||
border: 0
|
||||
background: transparent
|
||||
color: $COLOR_TEXT
|
||||
|
||||
label
|
||||
position: absolute
|
||||
overflow: hidden
|
||||
right: -40px
|
||||
|
||||
.field input,
|
||||
.title
|
||||
transition: opacity 0.2s
|
||||
|
||||
.results
|
||||
position: absolute
|
||||
visibility: hidden
|
||||
top: 40px
|
||||
width: 100%
|
||||
margin: 0
|
||||
padding: 0
|
||||
list-style: none
|
||||
box-shadow: 0 0 4px rgba(#000, 0.25)
|
||||
|
||||
li
|
||||
padding: 0 10px
|
||||
background-color: $COLOR_BACKGROUND
|
||||
|
||||
li:nth-child(even)
|
||||
background-color: $COLOR_PANEL
|
||||
|
||||
li.state
|
||||
display: none
|
||||
|
||||
li.current,
|
||||
li:hover
|
||||
background-color: $COLOR_PANEL_DIVIDER
|
||||
|
||||
a
|
||||
display: block
|
||||
|
||||
&:before
|
||||
top: 10px
|
||||
|
||||
span.parent
|
||||
color: $COLOR_TEXT_ASIDE
|
||||
font-weight: normal
|
||||
|
||||
&.has-focus
|
||||
background-color: $COLOR_PANEL_DIVIDER
|
||||
|
||||
.field input
|
||||
top: 0
|
||||
opacity: 1
|
||||
|
||||
.title
|
||||
z-index: 0
|
||||
opacity: 0
|
||||
|
||||
.results
|
||||
visibility: visible
|
||||
|
||||
&.loading .results li.state.loading
|
||||
display: block
|
||||
|
||||
&.failure .results li.state.failure
|
||||
display: block
|
||||
|
|
@ -0,0 +1,152 @@
|
|||
// Wraps a function signature.
|
||||
// Changes its appearance when directly placed inside a `tsd-panel`.
|
||||
// Can be combined with class `tsd-kind-icon` to display an icon in front of the signature.
|
||||
//
|
||||
// <div class="tsd-kind-method">
|
||||
// <div class="tsd-signature tsd-kind-icon">
|
||||
// get<wbr>Child<wbr>ByName<span class="tsd-signature-symbol">(</span>
|
||||
// name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>
|
||||
// <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span>
|
||||
// <a href="# class="tsd-signature-type">DeclarationReflection</a>
|
||||
// </div>
|
||||
// </div>
|
||||
//
|
||||
.tsd-signature
|
||||
margin: 0 0 1em 0
|
||||
padding: 10px
|
||||
border: 1px solid $COLOR_PANEL_DIVIDER
|
||||
font-family: $FONT_FAMILY_MONO
|
||||
font-size: $FONT_SIZE_MONO
|
||||
|
||||
&.tsd-kind-icon
|
||||
padding-left: 30px
|
||||
|
||||
&:before
|
||||
top: 10px
|
||||
left: 10px
|
||||
|
||||
.tsd-panel > &
|
||||
margin-left: -20px
|
||||
margin-right: -20px
|
||||
border-width: 1px 0
|
||||
|
||||
&.tsd-kind-icon
|
||||
padding-left: 40px
|
||||
|
||||
&:before
|
||||
left: 20px
|
||||
|
||||
.tsd-signature-symbol
|
||||
color: $COLOR_TEXT_ASIDE
|
||||
font-weight: normal
|
||||
|
||||
.tsd-signature-type
|
||||
font-style: italic
|
||||
font-weight: normal
|
||||
|
||||
|
||||
// Displays a list of signatures.
|
||||
// Changes its appearance when directly placed inside a `tsd-panel`.
|
||||
// Made interactive by JavaScript at `typedoc.Signature`.
|
||||
//
|
||||
// <ul class="tsd-signatures tsd-kind-method">
|
||||
// <li class="tsd-signature tsd-kind-icon current">getChildByName(name: string): DeclarationReflection</li>
|
||||
// <li class="tsd-signature tsd-kind-icon">getChildByName(names: Array<string>): DeclarationReflection</li>
|
||||
// </ul>
|
||||
//
|
||||
.tsd-signatures
|
||||
padding: 0
|
||||
margin: 0 0 1em 0
|
||||
border: 1px solid $COLOR_PANEL_DIVIDER
|
||||
|
||||
.tsd-signature
|
||||
margin: 0
|
||||
border-width: 1px 0 0 0
|
||||
transition: background-color 0.1s
|
||||
|
||||
&:first-child
|
||||
border-top-width: 0
|
||||
|
||||
&.current
|
||||
background-color: $COLOR_PANEL_DIVIDER
|
||||
|
||||
&.active > .tsd-signature
|
||||
cursor: pointer
|
||||
|
||||
.tsd-panel > &
|
||||
margin-left: -20px
|
||||
margin-right: -20px
|
||||
border-width: 1px 0
|
||||
|
||||
.tsd-signature.tsd-kind-icon
|
||||
padding-left: 40px
|
||||
|
||||
&:before
|
||||
left: 20px
|
||||
|
||||
.tsd-panel > a.anchor + &
|
||||
border-top-width: 0
|
||||
margin-top: -20px
|
||||
|
||||
|
||||
// Holds the descriptions related to a list of signatures.
|
||||
// Made interactive by JavaScript at `typedoc.Signature`.
|
||||
//
|
||||
// <ul class="tsd-descriptions active">
|
||||
// <li class="tsd-description current">
|
||||
// <p>Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat.</p>
|
||||
// </li>
|
||||
// <li class="tsd-description">
|
||||
// <p>Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat.</p>
|
||||
// </li>
|
||||
// </ul>
|
||||
//
|
||||
ul.tsd-descriptions
|
||||
position: relative
|
||||
overflow: hidden
|
||||
transition: height 0.3s
|
||||
padding: 0
|
||||
list-style: none
|
||||
|
||||
> li
|
||||
@extend %prevent-children-margin
|
||||
|
||||
&.active > .tsd-description
|
||||
display: none
|
||||
|
||||
&.current
|
||||
display: block
|
||||
|
||||
&.fade-in
|
||||
animation: fade-in-delayed 0.3s
|
||||
|
||||
&.fade-out
|
||||
animation: fade-out-delayed 0.3s
|
||||
position: absolute
|
||||
display: block
|
||||
top: 0
|
||||
left: 0
|
||||
right: 0
|
||||
opacity: 0
|
||||
visibility: hidden
|
||||
|
||||
h4
|
||||
font-size: $FONT_SIZE
|
||||
margin: 1em 0 0.5em 0
|
||||
|
||||
ul.tsd-parameters,
|
||||
ul.tsd-type-parameters
|
||||
list-style: square
|
||||
margin: 0
|
||||
padding-left: 20px
|
||||
|
||||
> li.tsd-parameter-siganture
|
||||
list-style: none
|
||||
margin-left: -20px
|
||||
|
||||
h5
|
||||
font-size: $FONT_SIZE
|
||||
margin: 1em 0 0.5em 0
|
||||
|
||||
.tsd-comment
|
||||
margin-top: -0.5em
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
// Displays the source and inheritance information
|
||||
//
|
||||
// <aside class="tsd-sources">
|
||||
// <p>Overrides <a href="#">BaseHandler</a>.<a href="#">constructor</a></p>
|
||||
// <ul>
|
||||
// <li>Defined in src/typedoc/factories/handlers/DynamicModuleHandler.ts:37</li>
|
||||
// </ul>
|
||||
// </aside>
|
||||
//
|
||||
.tsd-sources
|
||||
font-size: $FONT_SIZE_MONO
|
||||
color: $COLOR_TEXT_ASIDE
|
||||
margin: 0 0 1em 0
|
||||
|
||||
a
|
||||
color: $COLOR_TEXT_ASIDE
|
||||
text-decoration: underline
|
||||
|
||||
ul, p
|
||||
margin: 0 !important
|
||||
|
||||
ul
|
||||
list-style: none
|
||||
padding: 0
|
||||
|
|
@ -0,0 +1,171 @@
|
|||
// Displays the toolbar at the top of the page.
|
||||
//
|
||||
// <div class="tsd-page-toolbar">
|
||||
// <div class="container">
|
||||
// <div class="table-wrap">
|
||||
// <div class="table-cell">
|
||||
// <a href="../index.html" class="title">TypeDoc Documentation</a>
|
||||
// </div>
|
||||
// </div>
|
||||
// </div>
|
||||
// </div>
|
||||
//
|
||||
.tsd-page-toolbar
|
||||
position: absolute
|
||||
z-index: 1
|
||||
top: 0
|
||||
left: 0
|
||||
width: 100%
|
||||
height: $TOOLBAR_HEIGHT
|
||||
color: $TOOLBAR_TEXT_COLOR
|
||||
background: $TOOLBAR_COLOR
|
||||
border-bottom: 1px solid $COLOR_PANEL_DIVIDER
|
||||
|
||||
a
|
||||
color: $TOOLBAR_TEXT_COLOR
|
||||
text-decoration: none
|
||||
|
||||
&.title
|
||||
font-weight: bold
|
||||
|
||||
&.title:hover
|
||||
text-decoration: underline
|
||||
|
||||
.table-wrap
|
||||
display: table
|
||||
width: 100%
|
||||
height: $TOOLBAR_HEIGHT
|
||||
|
||||
.table-cell
|
||||
display: table-cell
|
||||
position: relative
|
||||
white-space: nowrap
|
||||
line-height: $TOOLBAR_HEIGHT
|
||||
|
||||
&:first-child
|
||||
width: 100%
|
||||
|
||||
%TSD_WIDGET_ICON
|
||||
&:before
|
||||
content: ''
|
||||
display: inline-block
|
||||
width: 40px
|
||||
height: 40px
|
||||
margin: 0 -8px 0 0
|
||||
background-image: url(../images/widgets.png)
|
||||
background-repeat: no-repeat
|
||||
text-indent: -1024px
|
||||
vertical-align: bottom
|
||||
|
||||
+retina
|
||||
background-image: url(../images/widgets@2x.png)
|
||||
background-size: 320px 40px
|
||||
|
||||
.tsd-widget
|
||||
@extend %TSD_WIDGET_ICON
|
||||
display: inline-block
|
||||
overflow: hidden
|
||||
opacity: 0.6
|
||||
height: $TOOLBAR_HEIGHT
|
||||
transition: opacity 0.1s, background-color 0.2s
|
||||
vertical-align: bottom
|
||||
cursor: pointer
|
||||
|
||||
&:hover
|
||||
opacity: 0.8
|
||||
|
||||
&.active
|
||||
opacity: 1
|
||||
background-color: $COLOR_PANEL_DIVIDER
|
||||
|
||||
&.no-caption
|
||||
width: 40px
|
||||
|
||||
&:before
|
||||
margin: 0
|
||||
|
||||
&.search:before
|
||||
background-position: 0 0
|
||||
|
||||
&.menu:before
|
||||
background-position: -40px 0
|
||||
|
||||
&.options:before
|
||||
background-position: -80px 0
|
||||
|
||||
&.options,
|
||||
&.menu
|
||||
display: none
|
||||
|
||||
+size-xs-sm
|
||||
display: inline-block
|
||||
|
||||
input[type=checkbox] + &:before
|
||||
background-position: -120px 0
|
||||
|
||||
input[type=checkbox]:checked + &:before
|
||||
background-position: -160px 0
|
||||
|
||||
.tsd-select
|
||||
position: relative
|
||||
display: inline-block
|
||||
height: $TOOLBAR_HEIGHT
|
||||
transition: opacity 0.1s, background-color 0.2s
|
||||
vertical-align: bottom
|
||||
cursor: pointer
|
||||
|
||||
.tsd-select-label
|
||||
@extend %TSD_WIDGET_ICON
|
||||
opacity: 0.6
|
||||
transition: opacity 0.2s
|
||||
|
||||
&:before
|
||||
background-position: -240px 0
|
||||
|
||||
&.active
|
||||
.tsd-select-label
|
||||
opacity: 0.8
|
||||
|
||||
.tsd-select-list
|
||||
visibility: visible
|
||||
opacity: 1
|
||||
transition-delay: 0s
|
||||
|
||||
.tsd-select-list
|
||||
position: absolute
|
||||
visibility: hidden
|
||||
top: $TOOLBAR_HEIGHT
|
||||
left: 0
|
||||
margin: 0
|
||||
padding: 0
|
||||
opacity: 0
|
||||
list-style: none
|
||||
box-shadow: 0 0 4px rgba(#000, 0.25)
|
||||
transition: visibility 0s 0.2s, opacity 0.2s
|
||||
|
||||
li
|
||||
@extend %TSD_WIDGET_ICON
|
||||
padding: 0 20px 0 0
|
||||
background-color: $COLOR_BACKGROUND
|
||||
|
||||
&:before
|
||||
background-position: 40px 0
|
||||
|
||||
&:nth-child(even)
|
||||
background-color: $COLOR_PANEL
|
||||
|
||||
&:hover
|
||||
background-color: $COLOR_PANEL_DIVIDER
|
||||
|
||||
&.selected:before
|
||||
background-position: -200px 0
|
||||
|
||||
+size-xs-sm
|
||||
.tsd-select-list
|
||||
top: 0
|
||||
left: auto
|
||||
right: 100%
|
||||
margin-right: -5px
|
||||
|
||||
.tsd-select-label:before
|
||||
background-position: -280px 0
|
||||
|
|
@ -0,0 +1,114 @@
|
|||
html.default
|
||||
+size-md
|
||||
.col-content
|
||||
width: 72%
|
||||
|
||||
.col-menu
|
||||
width: 28%
|
||||
|
||||
.tsd-navigation
|
||||
padding-left: 10px
|
||||
|
||||
+size-xs-sm
|
||||
.col-content
|
||||
float: none
|
||||
width: 100%
|
||||
|
||||
.col-menu
|
||||
position: fixed !important
|
||||
overflow: auto
|
||||
-webkit-overflow-scrolling: touch
|
||||
overflow-scrolling: touch
|
||||
z-index: 1024
|
||||
top: 0 !important
|
||||
bottom: 0 !important
|
||||
left: auto !important
|
||||
right: 0 !important
|
||||
width: 100%
|
||||
padding: 20px 20px 0 0
|
||||
max-width: 450px
|
||||
visibility: hidden
|
||||
background-color: $COLOR_PANEL
|
||||
transform: translate(100%,0)
|
||||
|
||||
> *:last-child
|
||||
padding-bottom: 20px
|
||||
|
||||
.overlay
|
||||
content: ''
|
||||
display: block
|
||||
position: fixed
|
||||
z-index: 1023
|
||||
top: 0
|
||||
left: 0
|
||||
right: 0
|
||||
bottom: 0
|
||||
background-color: rgba(#000, 0.75)
|
||||
visibility: hidden
|
||||
|
||||
&.to-has-menu
|
||||
.overlay
|
||||
animation: fade-in 0.4s
|
||||
|
||||
header,
|
||||
footer,
|
||||
.col-content
|
||||
animation: shift-to-left 0.4s
|
||||
|
||||
.col-menu
|
||||
animation: pop-in-from-right 0.4s
|
||||
|
||||
&.from-has-menu
|
||||
.overlay
|
||||
animation: fade-out 0.4s
|
||||
|
||||
header,
|
||||
footer,
|
||||
.col-content
|
||||
animation: unshift-to-left 0.4s
|
||||
|
||||
.col-menu
|
||||
animation: pop-out-to-right 0.4s
|
||||
|
||||
&.has-menu
|
||||
body
|
||||
overflow: hidden
|
||||
|
||||
.overlay
|
||||
visibility: visible
|
||||
|
||||
header,
|
||||
footer,
|
||||
.col-content
|
||||
transform: translate(-25%, 0)
|
||||
|
||||
.col-menu
|
||||
visibility: visible
|
||||
transform: translate(0,0)
|
||||
|
||||
.tsd-page-title
|
||||
padding: 70px 0 20px 0
|
||||
margin: 0 0 40px 0
|
||||
background: $COLOR_PANEL
|
||||
box-shadow: 0 1px 4px rgba(0, 0, 0, 0.15)
|
||||
|
||||
h1
|
||||
margin: 0
|
||||
|
||||
.tsd-breadcrumb
|
||||
margin: 0
|
||||
padding: 0
|
||||
color: $COLOR_TEXT_ASIDE
|
||||
|
||||
a
|
||||
color: $COLOR_TEXT_ASIDE
|
||||
text-decoration: none
|
||||
|
||||
&:hover
|
||||
text-decoration: underline
|
||||
|
||||
li
|
||||
display: inline
|
||||
|
||||
&:after
|
||||
content: ' / '
|
||||
|
|
@ -0,0 +1,50 @@
|
|||
html.minimal
|
||||
.container
|
||||
margin: 0
|
||||
|
||||
.container-main
|
||||
padding-top: 50px
|
||||
padding-bottom: 0
|
||||
|
||||
.content-wrap
|
||||
padding-left: 300px
|
||||
|
||||
.tsd-navigation
|
||||
position: fixed !important
|
||||
overflow: auto
|
||||
-webkit-overflow-scrolling: touch
|
||||
overflow-scrolling: touch
|
||||
box-sizing: border-box
|
||||
z-index: 1
|
||||
left: 0
|
||||
top: 40px
|
||||
bottom: 0
|
||||
width: 300px
|
||||
padding: 20px
|
||||
margin: 0
|
||||
|
||||
.tsd-member .tsd-member
|
||||
margin-left: 0
|
||||
|
||||
.tsd-page-toolbar
|
||||
position: fixed
|
||||
z-index: 2
|
||||
|
||||
#tsd-filter .tsd-filter-group
|
||||
right: 0
|
||||
transform: none
|
||||
|
||||
footer
|
||||
background-color: transparent
|
||||
|
||||
.container
|
||||
padding: 0
|
||||
|
||||
.tsd-generator
|
||||
padding: 0
|
||||
|
||||
+size-xs-sm
|
||||
.tsd-navigation
|
||||
display: none
|
||||
.content-wrap
|
||||
padding-left: 0
|
||||
|
|
@ -0,0 +1,27 @@
|
|||
@import constants
|
||||
|
||||
@import vendors/normalize
|
||||
@import vendors/highlight.js
|
||||
|
||||
@import setup/mixins
|
||||
@import setup/grid
|
||||
@import setup/icons
|
||||
@import setup/animations
|
||||
@import setup/typography
|
||||
|
||||
@import layouts/default
|
||||
@import layouts/minimal
|
||||
|
||||
@import elements/comment
|
||||
@import elements/filter
|
||||
@import elements/footer
|
||||
@import elements/hierarchy
|
||||
@import elements/index
|
||||
@import elements/member
|
||||
@import elements/navigation
|
||||
@import elements/panel
|
||||
@import elements/search
|
||||
@import elements/signatures
|
||||
@import elements/sources
|
||||
@import elements/toolbar
|
||||
@import elements/images
|
||||
|
|
@ -0,0 +1,57 @@
|
|||
.no-transition
|
||||
transition: none !important
|
||||
|
||||
@keyframes fade-in
|
||||
from
|
||||
opacity: 0
|
||||
to
|
||||
opacity: 1
|
||||
|
||||
@keyframes fade-out
|
||||
from
|
||||
opacity: 1
|
||||
visibility: visible
|
||||
to
|
||||
opacity: 0
|
||||
|
||||
@keyframes fade-in-delayed
|
||||
0%
|
||||
opacity: 0
|
||||
33%
|
||||
opacity: 0
|
||||
100%
|
||||
opacity: 1
|
||||
|
||||
@keyframes fade-out-delayed
|
||||
0%
|
||||
opacity: 1
|
||||
visibility: visible
|
||||
66%
|
||||
opacity: 0
|
||||
100%
|
||||
opacity: 0
|
||||
|
||||
@keyframes shift-to-left
|
||||
from
|
||||
transform: translate(0,0)
|
||||
to
|
||||
transform: translate(-25%,0)
|
||||
|
||||
@keyframes unshift-to-left
|
||||
from
|
||||
transform: translate(-25%,0)
|
||||
to
|
||||
transform: translate(0,0)
|
||||
|
||||
@keyframes pop-in-from-right
|
||||
from
|
||||
transform: translate(100%,0)
|
||||
to
|
||||
transform: translate(0,0)
|
||||
|
||||
@keyframes pop-out-to-right
|
||||
from
|
||||
transform: translate(0,0)
|
||||
visibility: visible
|
||||
to
|
||||
transform: translate(100%,0)
|
||||
|
|
@ -0,0 +1,59 @@
|
|||
=size-xs
|
||||
@media (max-width: 640px)
|
||||
&
|
||||
@content
|
||||
|
||||
=size-sm
|
||||
@media (min-width: 641px) and (max-width: 900px)
|
||||
&
|
||||
@content
|
||||
|
||||
=size-md
|
||||
@media (min-width: 901px) and (max-width: 1024px)
|
||||
&
|
||||
@content
|
||||
|
||||
=size-lg
|
||||
@media (min-width: 1025px)
|
||||
&
|
||||
@content
|
||||
|
||||
=size-xs-sm
|
||||
@media (max-width: 900px)
|
||||
&
|
||||
@content
|
||||
|
||||
=size-md-lg
|
||||
@media (min-width: 901px)
|
||||
&
|
||||
@content
|
||||
|
||||
.container
|
||||
max-width: 1200px
|
||||
margin: 0 auto
|
||||
padding: 0 40px
|
||||
|
||||
+size-xs
|
||||
padding: 0 20px
|
||||
|
||||
.container-main
|
||||
padding-bottom: 200px
|
||||
|
||||
.row
|
||||
+clearfix
|
||||
position: relative
|
||||
margin: 0 -10px
|
||||
|
||||
.col
|
||||
@extend %prevent-children-margin
|
||||
box-sizing: border-box
|
||||
float: left
|
||||
padding: 0 10px
|
||||
|
||||
@for $width from 1 to 12
|
||||
.col-#{$width}
|
||||
@extend .col
|
||||
width: $width / 12 * 100%
|
||||
|
||||
.offset-#{$width}
|
||||
margin-left: $width / 12 * 100%
|
||||
|
|
@ -0,0 +1,166 @@
|
|||
$type-icons:
|
||||
(object-literal),
|
||||
(class),
|
||||
('class.tsd-has-type-parameter'),
|
||||
(interface),
|
||||
('interface.tsd-has-type-parameter'),
|
||||
(module, external-module),
|
||||
(enum),
|
||||
(enum-member),
|
||||
(signature),
|
||||
(type-alias),
|
||||
('type-alias.tsd-has-type-parameter');
|
||||
|
||||
$member-icons:
|
||||
(variable, property),
|
||||
(get-signature),
|
||||
(set-signature),
|
||||
(accessor),
|
||||
(function, method, call-signature),
|
||||
('function.tsd-has-type-parameter', 'method.tsd-has-type-parameter'),
|
||||
(constructor, constructor-signature),
|
||||
(index-signature),
|
||||
(event),
|
||||
(property),
|
||||
(function, method, call-signature),
|
||||
(event);
|
||||
|
||||
// parameter
|
||||
// type-literal
|
||||
// type-parameter
|
||||
|
||||
.tsd-kind-icon {
|
||||
display: block;
|
||||
position: relative;
|
||||
padding-left: 20px;
|
||||
text-indent: -20px;
|
||||
|
||||
&:before {
|
||||
content: '';
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
width: 17px;
|
||||
height: 17px;
|
||||
margin: 0 3px 2px 0;
|
||||
background-image: url(../images/icons.png);
|
||||
|
||||
@include retina {
|
||||
background-image: url(../images/icons@2x.png);
|
||||
background-size: 238px 204px;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
.tsd-signature.tsd-kind-icon:before {
|
||||
background-position: 0 -153px;
|
||||
}
|
||||
|
||||
$icon-size: 17px;
|
||||
$type: -0 * $icon-size;
|
||||
$type-protected: -1 * $icon-size;
|
||||
$type-private: -2 * $icon-size;
|
||||
$member-class-public: -3 * $icon-size;
|
||||
$member-class-public-inherited: -4 * $icon-size;
|
||||
$member-class-protected: -5 * $icon-size;
|
||||
$member-class-protected-inherited: -6 * $icon-size;
|
||||
$member-private: -7 * $icon-size;
|
||||
$member: -8 * $icon-size;
|
||||
$member-protected: -9 * $icon-size;
|
||||
$member-enum: -10 * $icon-size;
|
||||
$member-enum-protected: -11 * $icon-size;
|
||||
$member-interface: -12 * $icon-size;
|
||||
$member-interface-inherited: -13 * $icon-size;
|
||||
|
||||
|
||||
@for $index from 1 through length($type-icons) {
|
||||
@each $kind in nth($type-icons, $index) {
|
||||
$selector: '.tsd-kind-' + $kind;
|
||||
$offset: -#{17 * ($index)}px;
|
||||
|
||||
#{$selector} {
|
||||
> .tsd-kind-icon:before {
|
||||
background-position: $type $offset;
|
||||
}
|
||||
|
||||
&.tsd-is-protected > .tsd-kind-icon:before {
|
||||
background-position: $type-protected $offset;
|
||||
}
|
||||
|
||||
&.tsd-is-private > .tsd-kind-icon:before {
|
||||
background-position: $type-private $offset;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@for $index from 1 through length($member-icons) {
|
||||
@each $kind in nth($member-icons, $index) {
|
||||
$offset: -#{17 * ($index - 1)}px;
|
||||
$selector: '.tsd-kind-' + $kind;
|
||||
@if $index == 10 {
|
||||
$selector: '.tsd-is-static';
|
||||
} @else if $index > 10 {
|
||||
$selector: '.tsd-is-static.tsd-kind-' + $kind;
|
||||
}
|
||||
|
||||
#{$selector} {
|
||||
> .tsd-kind-icon:before {
|
||||
background-position: $member $offset;
|
||||
}
|
||||
|
||||
&.tsd-is-protected > .tsd-kind-icon:before {
|
||||
background-position: $member-protected $offset;
|
||||
}
|
||||
|
||||
&.tsd-is-private > .tsd-kind-icon:before {
|
||||
background-position: $member-private $offset;
|
||||
}
|
||||
|
||||
&.tsd-parent-kind-class {
|
||||
> .tsd-kind-icon:before {
|
||||
background-position: $member-class-public $offset;
|
||||
}
|
||||
|
||||
&.tsd-is-inherited > .tsd-kind-icon:before {
|
||||
background-position: $member-class-public-inherited $offset;
|
||||
}
|
||||
|
||||
&.tsd-is-protected > .tsd-kind-icon:before {
|
||||
background-position: $member-class-protected $offset;
|
||||
}
|
||||
|
||||
&.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before {
|
||||
background-position: $member-class-protected-inherited $offset;
|
||||
}
|
||||
|
||||
&.tsd-is-private > .tsd-kind-icon:before {
|
||||
background-position: $member-private $offset;
|
||||
}
|
||||
}
|
||||
|
||||
&.tsd-parent-kind-enum {
|
||||
> .tsd-kind-icon:before {
|
||||
background-position: $member-enum $offset;
|
||||
}
|
||||
|
||||
&.tsd-is-protected > .tsd-kind-icon:before {
|
||||
background-position: $member-enum-protected $offset;
|
||||
}
|
||||
|
||||
&.tsd-is-private > .tsd-kind-icon:before {
|
||||
background-position: $member-private $offset;
|
||||
}
|
||||
}
|
||||
|
||||
&.tsd-parent-kind-interface {
|
||||
> .tsd-kind-icon:before {
|
||||
background-position: $member-interface $offset;
|
||||
}
|
||||
|
||||
&.tsd-is-inherited > .tsd-kind-icon:before {
|
||||
background-position: $member-interface-inherited $offset;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,30 @@
|
|||
@mixin vendors($property, $value...)
|
||||
-webkit-#{$property}: $value
|
||||
-moz-#{$property}: $value
|
||||
-ms-#{$property}: $value
|
||||
-o-#{$property}: $value
|
||||
#{$property}: $value
|
||||
|
||||
@mixin clearfix
|
||||
&:after
|
||||
visibility: hidden
|
||||
display: block
|
||||
content: ""
|
||||
clear: both
|
||||
height: 0
|
||||
|
||||
@mixin retina
|
||||
@media (-webkit-min-device-pixel-ratio: 1.5), (min-device-pixel-ratio: 1.5), (min-resolution: 144dpi)
|
||||
&
|
||||
@content
|
||||
|
||||
%prevent-children-margin
|
||||
> :first-child,
|
||||
> :first-child > :first-child,
|
||||
> :first-child > :first-child > :first-child
|
||||
margin-top: 0
|
||||
|
||||
> :last-child,
|
||||
> :last-child > :last-child,
|
||||
> :last-child > :last-child > :last-child
|
||||
margin-bottom: 0
|
||||
|
|
@ -0,0 +1,45 @@
|
|||
body
|
||||
background: $COLOR_BACKGROUND
|
||||
font-family: $FONT_FAMILY
|
||||
font-size: $FONT_SIZE
|
||||
color: $COLOR_TEXT
|
||||
|
||||
a
|
||||
color: $COLOR_LINK
|
||||
text-decoration: none
|
||||
|
||||
&:hover
|
||||
text-decoration: underline
|
||||
|
||||
code, pre
|
||||
font-family: $FONT_FAMILY_MONO
|
||||
padding: 0.2em
|
||||
margin: 0
|
||||
font-size: $FONT_SIZE_MONO
|
||||
background-color: $COLOR_CODE_BACKGROUND
|
||||
|
||||
pre
|
||||
padding: 10px
|
||||
|
||||
code
|
||||
padding: 0
|
||||
font-size: 100%
|
||||
background-color: transparent
|
||||
|
||||
.tsd-typography
|
||||
line-height: $LINE_HEIGHT
|
||||
|
||||
ul
|
||||
list-style: square
|
||||
padding: 0 0 0 20px
|
||||
margin: 0
|
||||
|
||||
h4, h5, h6
|
||||
font-size: 1em
|
||||
margin: 0
|
||||
|
||||
h5, h6
|
||||
font-weight: normal
|
||||
|
||||
p, ul, ol
|
||||
margin: 1em 0
|
||||
50
openvidu-browser/config/typedoc/custom-theme/assets/css/vendors/_highlight.js.sass
vendored
Normal file
50
openvidu-browser/config/typedoc/custom-theme/assets/css/vendors/_highlight.js.sass
vendored
Normal file
|
|
@ -0,0 +1,50 @@
|
|||
/*
|
||||
*
|
||||
*Visual Studio-like style based on original C# coloring by Jason Diamond <jason@diamond.name>
|
||||
|
||||
.hljs
|
||||
display: inline-block
|
||||
padding: 0.5em
|
||||
background: white
|
||||
color: black
|
||||
|
||||
.hljs-comment, .hljs-annotation, .hljs-template_comment, .diff .hljs-header, .hljs-chunk, .apache .hljs-cbracket
|
||||
color: #008000
|
||||
|
||||
.hljs-keyword, .hljs-id, .hljs-built_in, .css .smalltalk .hljs-class, .hljs-winutils, .bash .hljs-variable, .tex .hljs-command, .hljs-request, .hljs-status, .nginx .hljs-title
|
||||
color: #00f
|
||||
|
||||
.xml .hljs-tag
|
||||
color: #00f
|
||||
.hljs-value
|
||||
color: #00f
|
||||
|
||||
.hljs-string, .hljs-title, .hljs-parent, .hljs-tag .hljs-value, .hljs-rules .hljs-value
|
||||
color: #a31515
|
||||
|
||||
.ruby .hljs-symbol
|
||||
color: #a31515
|
||||
.hljs-string
|
||||
color: #a31515
|
||||
|
||||
.hljs-template_tag, .django .hljs-variable, .hljs-addition, .hljs-flow, .hljs-stream, .apache .hljs-tag, .hljs-date, .tex .hljs-formula, .coffeescript .hljs-attribute
|
||||
color: #a31515
|
||||
|
||||
.ruby .hljs-string, .hljs-decorator, .hljs-filter .hljs-argument, .hljs-localvars, .hljs-array, .hljs-attr_selector, .hljs-pseudo, .hljs-pi, .hljs-doctype, .hljs-deletion, .hljs-envvar, .hljs-shebang, .hljs-preprocessor, .hljs-pragma, .userType, .apache .hljs-sqbracket, .nginx .hljs-built_in, .tex .hljs-special, .hljs-prompt
|
||||
color: #2b91af
|
||||
|
||||
.hljs-phpdoc, .hljs-javadoc, .hljs-xmlDocTag
|
||||
color: #808080
|
||||
|
||||
.vhdl
|
||||
.hljs-typename
|
||||
font-weight: bold
|
||||
.hljs-string
|
||||
color: #666666
|
||||
.hljs-literal
|
||||
color: #a31515
|
||||
.hljs-attribute
|
||||
color: #00b0e8
|
||||
|
||||
.xml .hljs-attribute
|
||||
color: #f00
|
||||
424
openvidu-browser/config/typedoc/custom-theme/assets/css/vendors/_normalize.sass
vendored
Normal file
424
openvidu-browser/config/typedoc/custom-theme/assets/css/vendors/_normalize.sass
vendored
Normal file
|
|
@ -0,0 +1,424 @@
|
|||
/*! normalize.css v1.1.3 | MIT License | git.io/normalize
|
||||
|
||||
/* ==========================================================================
|
||||
* HTML5 display definitions
|
||||
* ==========================================================================
|
||||
|
||||
/**
|
||||
* Correct `block` display not defined in IE 6/7/8/9 and Firefox 3.
|
||||
|
||||
article, aside, details, figcaption, figure, footer, header, hgroup, main, nav, section, summary
|
||||
display: block
|
||||
|
||||
/**
|
||||
* Correct `inline-block` display not defined in IE 6/7/8/9 and Firefox 3.
|
||||
|
||||
audio, canvas, video
|
||||
display: inline-block
|
||||
*display: inline
|
||||
*zoom: 1
|
||||
|
||||
/**
|
||||
* Prevent modern browsers from displaying `audio` without controls.
|
||||
* Remove excess height in iOS 5 devices.
|
||||
|
||||
audio:not([controls])
|
||||
display: none
|
||||
height: 0
|
||||
|
||||
/**
|
||||
* Address styling not present in IE 7/8/9, Firefox 3, and Safari 4.
|
||||
* Known issue: no IE 6 support.
|
||||
|
||||
[hidden]
|
||||
display: none
|
||||
|
||||
/* ==========================================================================
|
||||
* Base
|
||||
* ==========================================================================
|
||||
|
||||
/**
|
||||
* 1. Correct text resizing oddly in IE 6/7 when body `font-size` is set using
|
||||
* `em` units.
|
||||
* 2. Prevent iOS text size adjust after orientation change, without disabling
|
||||
* user zoom.
|
||||
|
||||
html
|
||||
font-size: 100%
|
||||
/* 1
|
||||
-ms-text-size-adjust: 100%
|
||||
/* 2
|
||||
-webkit-text-size-adjust: 100%
|
||||
/* 2
|
||||
font-family: sans-serif
|
||||
|
||||
/**
|
||||
* Address `font-family` inconsistency between `textarea` and other form
|
||||
* elements.
|
||||
|
||||
button, input, select, textarea
|
||||
font-family: sans-serif
|
||||
|
||||
/**
|
||||
* Address margins handled incorrectly in IE 6/7.
|
||||
|
||||
body
|
||||
margin: 0
|
||||
|
||||
/* ==========================================================================
|
||||
* Links
|
||||
* ==========================================================================
|
||||
|
||||
/**
|
||||
* Address `outline` inconsistency between Chrome and other browsers.
|
||||
|
||||
a
|
||||
&:focus
|
||||
outline: thin dotted
|
||||
&:active, &:hover
|
||||
outline: 0
|
||||
|
||||
/**
|
||||
* Improve readability when focused and also mouse hovered in all browsers.
|
||||
|
||||
/* ==========================================================================
|
||||
* Typography
|
||||
* ==========================================================================
|
||||
|
||||
/**
|
||||
* Address font sizes and margins set differently in IE 6/7.
|
||||
* Address font sizes within `section` and `article` in Firefox 4+, Safari 5,
|
||||
* and Chrome.
|
||||
|
||||
h1
|
||||
font-size: 2em
|
||||
margin: 0.67em 0
|
||||
|
||||
h2
|
||||
font-size: 1.5em
|
||||
margin: 0.83em 0
|
||||
|
||||
h3
|
||||
font-size: 1.17em
|
||||
margin: 1em 0
|
||||
|
||||
h4
|
||||
font-size: 1em
|
||||
margin: 1.33em 0
|
||||
|
||||
h5
|
||||
font-size: 0.83em
|
||||
margin: 1.67em 0
|
||||
|
||||
h6
|
||||
font-size: 0.67em
|
||||
margin: 2.33em 0
|
||||
|
||||
/**
|
||||
* Address styling not present in IE 7/8/9, Safari 5, and Chrome.
|
||||
|
||||
abbr[title]
|
||||
border-bottom: 1px dotted
|
||||
|
||||
/**
|
||||
* Address style set to `bolder` in Firefox 3+, Safari 4/5, and Chrome.
|
||||
|
||||
b, strong
|
||||
font-weight: bold
|
||||
|
||||
blockquote
|
||||
margin: 1em 40px
|
||||
|
||||
/**
|
||||
* Address styling not present in Safari 5 and Chrome.
|
||||
|
||||
dfn
|
||||
font-style: italic
|
||||
|
||||
/**
|
||||
* Address differences between Firefox and other browsers.
|
||||
* Known issue: no IE 6/7 normalization.
|
||||
|
||||
hr
|
||||
-moz-box-sizing: content-box
|
||||
box-sizing: content-box
|
||||
height: 0
|
||||
|
||||
/**
|
||||
* Address styling not present in IE 6/7/8/9.
|
||||
|
||||
mark
|
||||
background: #ff0
|
||||
color: #000
|
||||
|
||||
/**
|
||||
* Address margins set differently in IE 6/7.
|
||||
|
||||
p, pre
|
||||
margin: 1em 0
|
||||
|
||||
/**
|
||||
* Correct font family set oddly in IE 6, Safari 4/5, and Chrome.
|
||||
|
||||
code, kbd, pre, samp
|
||||
font-family: monospace, serif
|
||||
_font-family: 'courier new', monospace
|
||||
font-size: 1em
|
||||
|
||||
/**
|
||||
* Improve readability of pre-formatted text in all browsers.
|
||||
|
||||
pre
|
||||
white-space: pre
|
||||
white-space: pre-wrap
|
||||
word-wrap: break-word
|
||||
|
||||
/**
|
||||
* Address CSS quotes not supported in IE 6/7.
|
||||
|
||||
q
|
||||
quotes: none
|
||||
&:before, &:after
|
||||
content: ''
|
||||
content: none
|
||||
|
||||
/**
|
||||
* Address `quotes` property not supported in Safari 4.
|
||||
|
||||
/**
|
||||
* Address inconsistent and variable font size in all browsers.
|
||||
|
||||
small
|
||||
font-size: 80%
|
||||
|
||||
/**
|
||||
* Prevent `sub` and `sup` affecting `line-height` in all browsers.
|
||||
|
||||
sub
|
||||
font-size: 75%
|
||||
line-height: 0
|
||||
position: relative
|
||||
vertical-align: baseline
|
||||
|
||||
sup
|
||||
font-size: 75%
|
||||
line-height: 0
|
||||
position: relative
|
||||
vertical-align: baseline
|
||||
top: -0.5em
|
||||
|
||||
sub
|
||||
bottom: -0.25em
|
||||
|
||||
/* ==========================================================================
|
||||
* Lists
|
||||
* ==========================================================================
|
||||
|
||||
/**
|
||||
* Address margins set differently in IE 6/7.
|
||||
|
||||
dl, menu, ol, ul
|
||||
margin: 1em 0
|
||||
|
||||
dd
|
||||
margin: 0 0 0 40px
|
||||
|
||||
/**
|
||||
* Address paddings set differently in IE 6/7.
|
||||
|
||||
menu, ol, ul
|
||||
padding: 0 0 0 40px
|
||||
|
||||
/**
|
||||
* Correct list images handled incorrectly in IE 7.
|
||||
|
||||
nav
|
||||
ul, ol
|
||||
list-style: none
|
||||
list-style-image: none
|
||||
|
||||
/* ==========================================================================
|
||||
* Embedded content
|
||||
* ==========================================================================
|
||||
|
||||
/**
|
||||
* 1. Remove border when inside `a` element in IE 6/7/8/9 and Firefox 3.
|
||||
* 2. Improve image quality when scaled in IE 7.
|
||||
|
||||
img
|
||||
border: 0
|
||||
/* 1
|
||||
-ms-interpolation-mode: bicubic
|
||||
/* 2
|
||||
|
||||
/**
|
||||
* Correct overflow displayed oddly in IE 9.
|
||||
|
||||
svg:not(:root)
|
||||
overflow: hidden
|
||||
|
||||
/* ==========================================================================
|
||||
* Figures
|
||||
* ==========================================================================
|
||||
|
||||
/**
|
||||
* Address margin not present in IE 6/7/8/9, Safari 5, and Opera 11.
|
||||
|
||||
figure, form
|
||||
margin: 0
|
||||
|
||||
/* ==========================================================================
|
||||
* Forms
|
||||
* ==========================================================================
|
||||
|
||||
/**
|
||||
* Correct margin displayed oddly in IE 6/7.
|
||||
|
||||
/**
|
||||
* Define consistent border, margin, and padding.
|
||||
|
||||
fieldset
|
||||
border: 1px solid #c0c0c0
|
||||
margin: 0 2px
|
||||
padding: 0.35em 0.625em 0.75em
|
||||
|
||||
/**
|
||||
* 1. Correct color not being inherited in IE 6/7/8/9.
|
||||
* 2. Correct text not wrapping in Firefox 3.
|
||||
* 3. Correct alignment displayed oddly in IE 6/7.
|
||||
|
||||
legend
|
||||
border: 0
|
||||
/* 1
|
||||
padding: 0
|
||||
white-space: normal
|
||||
/* 2
|
||||
*margin-left: -7px
|
||||
/* 3
|
||||
|
||||
/**
|
||||
* 1. Correct font size not being inherited in all browsers.
|
||||
* 2. Address margins set differently in IE 6/7, Firefox 3+, Safari 5,
|
||||
* and Chrome.
|
||||
* 3. Improve appearance and consistency in all browsers.
|
||||
|
||||
button, input, select, textarea
|
||||
font-size: 100%
|
||||
/* 1
|
||||
margin: 0
|
||||
/* 2
|
||||
vertical-align: baseline
|
||||
/* 3
|
||||
*vertical-align: middle
|
||||
/* 3
|
||||
|
||||
/**
|
||||
* Address Firefox 3+ setting `line-height` on `input` using `!important` in
|
||||
* the UA stylesheet.
|
||||
|
||||
button, input
|
||||
line-height: normal
|
||||
|
||||
/**
|
||||
* Address inconsistent `text-transform` inheritance for `button` and `select`.
|
||||
* All other form control elements do not inherit `text-transform` values.
|
||||
* Correct `button` style inheritance in Chrome, Safari 5+, and IE 6+.
|
||||
* Correct `select` style inheritance in Firefox 4+ and Opera.
|
||||
|
||||
button, select
|
||||
text-transform: none
|
||||
|
||||
/**
|
||||
* 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio`
|
||||
* and `video` controls.
|
||||
* 2. Correct inability to style clickable `input` types in iOS.
|
||||
* 3. Improve usability and consistency of cursor style between image-type
|
||||
* `input` and others.
|
||||
* 4. Remove inner spacing in IE 7 without affecting normal text inputs.
|
||||
* Known issue: inner spacing remains in IE 6.
|
||||
|
||||
button, html input[type="button"]
|
||||
-webkit-appearance: button
|
||||
/* 2
|
||||
cursor: pointer
|
||||
/* 3
|
||||
*overflow: visible
|
||||
/* 4
|
||||
|
||||
input
|
||||
&[type="reset"], &[type="submit"]
|
||||
-webkit-appearance: button
|
||||
/* 2
|
||||
cursor: pointer
|
||||
/* 3
|
||||
*overflow: visible
|
||||
/* 4
|
||||
|
||||
/**
|
||||
* Re-set default cursor for disabled elements.
|
||||
|
||||
button[disabled], html input[disabled]
|
||||
cursor: default
|
||||
|
||||
/**
|
||||
* 1. Address box sizing set to content-box in IE 8/9.
|
||||
* 2. Remove excess padding in IE 8/9.
|
||||
* 3. Remove excess padding in IE 7.
|
||||
* Known issue: excess padding remains in IE 6.
|
||||
|
||||
input
|
||||
&[type="checkbox"], &[type="radio"]
|
||||
box-sizing: border-box
|
||||
/* 1
|
||||
padding: 0
|
||||
/* 2
|
||||
*height: 13px
|
||||
/* 3
|
||||
*width: 13px
|
||||
/* 3
|
||||
&[type="search"]
|
||||
-webkit-appearance: textfield
|
||||
/* 1
|
||||
-moz-box-sizing: content-box
|
||||
-webkit-box-sizing: content-box
|
||||
/* 2
|
||||
box-sizing: content-box
|
||||
&::-webkit-search-cancel-button, &::-webkit-search-decoration
|
||||
-webkit-appearance: none
|
||||
|
||||
/**
|
||||
* 1. Address `appearance` set to `searchfield` in Safari 5 and Chrome.
|
||||
* 2. Address `box-sizing` set to `border-box` in Safari 5 and Chrome
|
||||
* (include `-moz` to future-proof).
|
||||
|
||||
/**
|
||||
* Remove inner padding and search cancel button in Safari 5 and Chrome
|
||||
* on OS X.
|
||||
|
||||
/**
|
||||
* Remove inner padding and border in Firefox 3+.
|
||||
|
||||
button::-moz-focus-inner, input::-moz-focus-inner
|
||||
border: 0
|
||||
padding: 0
|
||||
|
||||
/**
|
||||
* 1. Remove default vertical scrollbar in IE 6/7/8/9.
|
||||
* 2. Improve readability and alignment in all browsers.
|
||||
|
||||
textarea
|
||||
overflow: auto
|
||||
/* 1
|
||||
vertical-align: top
|
||||
/* 2
|
||||
|
||||
/* ==========================================================================
|
||||
* Tables
|
||||
* ==========================================================================
|
||||
|
||||
/**
|
||||
* Remove most spacing between table cells.
|
||||
|
||||
table
|
||||
border-collapse: collapse
|
||||
border-spacing: 0
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 9.4 KiB |
Binary file not shown.
Binary file not shown.
|
After Width: | Height: | Size: 28 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 480 B |
Binary file not shown.
Binary file not shown.
|
After Width: | Height: | Size: 855 B |
2
openvidu-browser/config/typedoc/custom-theme/assets/js/lib/backbone-1.1.2.min.js
vendored
Normal file
2
openvidu-browser/config/typedoc/custom-theme/assets/js/lib/backbone-1.1.2.min.js
vendored
Normal file
File diff suppressed because one or more lines are too long
4
openvidu-browser/config/typedoc/custom-theme/assets/js/lib/jquery-2.1.1.min.js
vendored
Normal file
4
openvidu-browser/config/typedoc/custom-theme/assets/js/lib/jquery-2.1.1.min.js
vendored
Normal file
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
6
openvidu-browser/config/typedoc/custom-theme/assets/js/lib/underscore-1.6.0.min.js
vendored
Normal file
6
openvidu-browser/config/typedoc/custom-theme/assets/js/lib/underscore-1.6.0.min.js
vendored
Normal file
File diff suppressed because one or more lines are too long
|
|
@ -0,0 +1,822 @@
|
|||
var __extends = (this && this.__extends) || (function () {
|
||||
var extendStatics = Object.setPrototypeOf ||
|
||||
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
|
||||
function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
|
||||
return function (d, b) {
|
||||
extendStatics(d, b);
|
||||
function __() { this.constructor = d; }
|
||||
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
|
||||
};
|
||||
})();
|
||||
var typedoc;
|
||||
(function (typedoc) {
|
||||
typedoc.$html = $('html');
|
||||
var services = [];
|
||||
var components = [];
|
||||
typedoc.$document = $(document);
|
||||
typedoc.$window = $(window);
|
||||
typedoc.$body = $('body');
|
||||
function registerService(constructor, name, priority) {
|
||||
if (priority === void 0) { priority = 0; }
|
||||
services.push({
|
||||
constructor: constructor,
|
||||
name: name,
|
||||
priority: priority,
|
||||
instance: null
|
||||
});
|
||||
services.sort(function (a, b) { return a.priority - b.priority; });
|
||||
}
|
||||
typedoc.registerService = registerService;
|
||||
function registerComponent(constructor, selector, priority, namespace) {
|
||||
if (priority === void 0) { priority = 0; }
|
||||
if (namespace === void 0) { namespace = '*'; }
|
||||
components.push({
|
||||
selector: selector,
|
||||
constructor: constructor,
|
||||
priority: priority,
|
||||
namespace: namespace
|
||||
});
|
||||
components.sort(function (a, b) { return a.priority - b.priority; });
|
||||
}
|
||||
typedoc.registerComponent = registerComponent;
|
||||
if (typeof Backbone != 'undefined') {
|
||||
typedoc['Events'] = (function () {
|
||||
var res = function () { };
|
||||
_.extend(res.prototype, Backbone.Events);
|
||||
return res;
|
||||
})();
|
||||
}
|
||||
var Application = (function (_super) {
|
||||
__extends(Application, _super);
|
||||
function Application() {
|
||||
var _this = _super.call(this) || this;
|
||||
_this.createServices();
|
||||
_this.createComponents(typedoc.$body);
|
||||
return _this;
|
||||
}
|
||||
Application.prototype.createServices = function () {
|
||||
_(services).forEach(function (c) {
|
||||
c.instance = new c.constructor();
|
||||
typedoc[c.name] = c.instance;
|
||||
});
|
||||
};
|
||||
Application.prototype.createComponents = function ($context, namespace) {
|
||||
if (namespace === void 0) { namespace = 'default'; }
|
||||
var result = [];
|
||||
_(components).forEach(function (c) {
|
||||
if (c.namespace != namespace && c.namespace != '*') {
|
||||
return;
|
||||
}
|
||||
$context.find(c.selector).each(function (m, el) {
|
||||
var $el = $(el), instance;
|
||||
if (instance = $el.data('component')) {
|
||||
if (_(result).indexOf(instance) == -1) {
|
||||
result.push(instance);
|
||||
}
|
||||
}
|
||||
else {
|
||||
instance = new c.constructor({ el: el });
|
||||
$el.data('component', instance);
|
||||
result.push(instance);
|
||||
}
|
||||
});
|
||||
});
|
||||
return result;
|
||||
};
|
||||
return Application;
|
||||
}(typedoc.Events));
|
||||
typedoc.Application = Application;
|
||||
})(typedoc || (typedoc = {}));
|
||||
var typedoc;
|
||||
(function (typedoc) {
|
||||
var FilterItem = (function () {
|
||||
function FilterItem(key, value) {
|
||||
this.key = key;
|
||||
this.value = value;
|
||||
this.defaultValue = value;
|
||||
this.initialize();
|
||||
if (window.localStorage[this.key]) {
|
||||
this.setValue(this.fromLocalStorage(window.localStorage[this.key]));
|
||||
}
|
||||
}
|
||||
FilterItem.prototype.initialize = function () { };
|
||||
FilterItem.prototype.handleValueChange = function (oldValue, newValue) { };
|
||||
FilterItem.prototype.fromLocalStorage = function (value) {
|
||||
return value;
|
||||
};
|
||||
FilterItem.prototype.toLocalStorage = function (value) {
|
||||
return value;
|
||||
};
|
||||
FilterItem.prototype.setValue = function (value) {
|
||||
if (this.value == value)
|
||||
return;
|
||||
var oldValue = this.value;
|
||||
this.value = value;
|
||||
window.localStorage[this.key] = this.toLocalStorage(value);
|
||||
this.handleValueChange(oldValue, value);
|
||||
};
|
||||
return FilterItem;
|
||||
}());
|
||||
var FilterItemCheckbox = (function (_super) {
|
||||
__extends(FilterItemCheckbox, _super);
|
||||
function FilterItemCheckbox() {
|
||||
return _super !== null && _super.apply(this, arguments) || this;
|
||||
}
|
||||
FilterItemCheckbox.prototype.initialize = function () {
|
||||
var _this = this;
|
||||
this.$checkbox = $('#tsd-filter-' + this.key);
|
||||
this.$checkbox.on('change', function () {
|
||||
_this.setValue(_this.$checkbox.prop('checked'));
|
||||
});
|
||||
};
|
||||
FilterItemCheckbox.prototype.handleValueChange = function (oldValue, newValue) {
|
||||
this.$checkbox.prop('checked', this.value);
|
||||
typedoc.$html.toggleClass('toggle-' + this.key, this.value != this.defaultValue);
|
||||
};
|
||||
FilterItemCheckbox.prototype.fromLocalStorage = function (value) {
|
||||
return value == 'true';
|
||||
};
|
||||
FilterItemCheckbox.prototype.toLocalStorage = function (value) {
|
||||
return value ? 'true' : 'false';
|
||||
};
|
||||
return FilterItemCheckbox;
|
||||
}(FilterItem));
|
||||
var FilterItemSelect = (function (_super) {
|
||||
__extends(FilterItemSelect, _super);
|
||||
function FilterItemSelect() {
|
||||
return _super !== null && _super.apply(this, arguments) || this;
|
||||
}
|
||||
FilterItemSelect.prototype.initialize = function () {
|
||||
var _this = this;
|
||||
typedoc.$html.addClass('toggle-' + this.key + this.value);
|
||||
this.$select = $('#tsd-filter-' + this.key);
|
||||
this.$select.on(typedoc.pointerDown + ' mouseover', function () {
|
||||
_this.$select.addClass('active');
|
||||
}).on('mouseleave', function () {
|
||||
_this.$select.removeClass('active');
|
||||
}).on(typedoc.pointerUp, 'li', function (e) {
|
||||
_this.$select.removeClass('active');
|
||||
_this.setValue($(e.target).attr('data-value'));
|
||||
});
|
||||
typedoc.$document.on(typedoc.pointerDown, function (e) {
|
||||
var $path = $(e.target).parents().addBack();
|
||||
if ($path.is(_this.$select))
|
||||
return;
|
||||
_this.$select.removeClass('active');
|
||||
});
|
||||
};
|
||||
FilterItemSelect.prototype.handleValueChange = function (oldValue, newValue) {
|
||||
this.$select.find('li.selected').removeClass('selected');
|
||||
this.$select.find('.tsd-select-label').text(this.$select.find('li[data-value="' + newValue + '"]').addClass('selected').text());
|
||||
typedoc.$html.removeClass('toggle-' + oldValue);
|
||||
typedoc.$html.addClass('toggle-' + newValue);
|
||||
};
|
||||
return FilterItemSelect;
|
||||
}(FilterItem));
|
||||
var Filter = (function (_super) {
|
||||
__extends(Filter, _super);
|
||||
function Filter(options) {
|
||||
var _this = _super.call(this, options) || this;
|
||||
_this.optionVisibility = new FilterItemSelect('visibility', 'private');
|
||||
_this.optionInherited = new FilterItemCheckbox('inherited', true);
|
||||
_this.optionExternals = new FilterItemCheckbox('externals', true);
|
||||
_this.optionOnlyExported = new FilterItemCheckbox('only-exported', false);
|
||||
return _this;
|
||||
}
|
||||
Filter.isSupported = function () {
|
||||
try {
|
||||
return typeof window.localStorage != 'undefined';
|
||||
}
|
||||
catch (e) {
|
||||
return false;
|
||||
}
|
||||
};
|
||||
return Filter;
|
||||
}(Backbone.View));
|
||||
if (Filter.isSupported()) {
|
||||
typedoc.registerComponent(Filter, '#tsd-filter');
|
||||
}
|
||||
else {
|
||||
typedoc.$html.addClass('no-filter');
|
||||
}
|
||||
})(typedoc || (typedoc = {}));
|
||||
var typedoc;
|
||||
(function (typedoc) {
|
||||
var MenuHighlight = (function (_super) {
|
||||
__extends(MenuHighlight, _super);
|
||||
function MenuHighlight(options) {
|
||||
var _this = _super.call(this, options) || this;
|
||||
_this.index = 0;
|
||||
_this.listenTo(typedoc.viewport, 'resize', _this.onResize);
|
||||
_this.listenTo(typedoc.viewport, 'scroll', _this.onScroll);
|
||||
_this.createAnchors();
|
||||
return _this;
|
||||
}
|
||||
MenuHighlight.prototype.createAnchors = function () {
|
||||
var _this = this;
|
||||
this.index = 0;
|
||||
this.anchors = [{
|
||||
position: 0
|
||||
}];
|
||||
var base = window.location.href;
|
||||
if (base.indexOf('#') != -1) {
|
||||
base = base.substr(0, base.indexOf('#'));
|
||||
}
|
||||
this.$el.find('a').each(function (index, el) {
|
||||
var href = el.href;
|
||||
if (href.indexOf('#') == -1)
|
||||
return;
|
||||
if (href.substr(0, base.length) != base)
|
||||
return;
|
||||
var hash = href.substr(href.indexOf('#') + 1);
|
||||
var $anchor = $('a.tsd-anchor[name=' + hash + ']');
|
||||
if ($anchor.length == 0)
|
||||
return;
|
||||
_this.anchors.push({
|
||||
$link: $(el.parentNode),
|
||||
$anchor: $anchor,
|
||||
position: 0
|
||||
});
|
||||
});
|
||||
this.onResize();
|
||||
};
|
||||
MenuHighlight.prototype.onResize = function () {
|
||||
var anchor;
|
||||
for (var index = 1, count = this.anchors.length; index < count; index++) {
|
||||
anchor = this.anchors[index];
|
||||
anchor.position = anchor.$anchor.offset().top;
|
||||
}
|
||||
this.anchors.sort(function (a, b) {
|
||||
return a.position - b.position;
|
||||
});
|
||||
this.onScroll(typedoc.viewport.scrollTop);
|
||||
};
|
||||
MenuHighlight.prototype.onScroll = function (scrollTop) {
|
||||
var anchors = this.anchors;
|
||||
var index = this.index;
|
||||
var count = anchors.length - 1;
|
||||
scrollTop += 5;
|
||||
while (index > 0 && anchors[index].position > scrollTop) {
|
||||
index -= 1;
|
||||
}
|
||||
while (index < count && anchors[index + 1].position < scrollTop) {
|
||||
index += 1;
|
||||
}
|
||||
if (this.index != index) {
|
||||
if (this.index > 0)
|
||||
this.anchors[this.index].$link.removeClass('focus');
|
||||
this.index = index;
|
||||
if (this.index > 0)
|
||||
this.anchors[this.index].$link.addClass('focus');
|
||||
}
|
||||
};
|
||||
return MenuHighlight;
|
||||
}(Backbone.View));
|
||||
typedoc.MenuHighlight = MenuHighlight;
|
||||
typedoc.registerComponent(MenuHighlight, '.menu-highlight');
|
||||
})(typedoc || (typedoc = {}));
|
||||
var typedoc;
|
||||
(function (typedoc) {
|
||||
var hasPositionSticky = typedoc.$html.hasClass('csspositionsticky');
|
||||
var StickyMode;
|
||||
(function (StickyMode) {
|
||||
StickyMode[StickyMode["None"] = 0] = "None";
|
||||
StickyMode[StickyMode["Secondary"] = 1] = "Secondary";
|
||||
StickyMode[StickyMode["Current"] = 2] = "Current";
|
||||
})(StickyMode || (StickyMode = {}));
|
||||
var MenuSticky = (function (_super) {
|
||||
__extends(MenuSticky, _super);
|
||||
function MenuSticky(options) {
|
||||
var _this = _super.call(this, options) || this;
|
||||
_this.state = '';
|
||||
_this.stickyMode = StickyMode.None;
|
||||
_this.$current = _this.$el.find('> ul.current');
|
||||
_this.$navigation = _this.$el.parents('.menu-sticky-wrap');
|
||||
_this.$container = _this.$el.parents('.row');
|
||||
_this.listenTo(typedoc.viewport, 'resize', _this.onResize);
|
||||
if (!hasPositionSticky) {
|
||||
_this.listenTo(typedoc.viewport, 'scroll', _this.onScroll);
|
||||
}
|
||||
_this.onResize(typedoc.viewport.width, typedoc.viewport.height);
|
||||
return _this;
|
||||
}
|
||||
MenuSticky.prototype.setState = function (state) {
|
||||
if (this.state == state)
|
||||
return;
|
||||
if (this.state != '')
|
||||
this.$navigation.removeClass(this.state);
|
||||
this.state = state;
|
||||
if (this.state != '')
|
||||
this.$navigation.addClass(this.state);
|
||||
};
|
||||
MenuSticky.prototype.onResize = function (width, height) {
|
||||
this.stickyMode = StickyMode.None;
|
||||
this.setState('');
|
||||
var containerTop = this.$container.offset().top;
|
||||
var containerHeight = this.$container.height();
|
||||
var bottom = containerTop + containerHeight;
|
||||
if (this.$navigation.height() < containerHeight) {
|
||||
var elHeight = this.$el.height();
|
||||
var elTop = this.$el.offset().top;
|
||||
if (this.$current.length) {
|
||||
var currentHeight = this.$current.height();
|
||||
var currentTop = this.$current.offset().top;
|
||||
this.$navigation.css('top', containerTop - currentTop + 20);
|
||||
if (currentHeight < height) {
|
||||
this.stickyMode = StickyMode.Current;
|
||||
this.stickyTop = currentTop;
|
||||
this.stickyBottom = bottom - elHeight + (currentTop - elTop) - 20;
|
||||
}
|
||||
}
|
||||
if (elHeight < height) {
|
||||
this.$navigation.css('top', containerTop - elTop + 20);
|
||||
this.stickyMode = StickyMode.Secondary;
|
||||
this.stickyTop = elTop;
|
||||
this.stickyBottom = bottom - elHeight - 20;
|
||||
}
|
||||
}
|
||||
if (!hasPositionSticky) {
|
||||
this.$navigation.css('left', this.$navigation.offset().left);
|
||||
this.onScroll(typedoc.viewport.scrollTop);
|
||||
}
|
||||
else {
|
||||
if (this.stickyMode == StickyMode.Current) {
|
||||
this.setState('sticky-current');
|
||||
}
|
||||
else if (this.stickyMode == StickyMode.Secondary) {
|
||||
this.setState('sticky');
|
||||
}
|
||||
else {
|
||||
this.setState('');
|
||||
}
|
||||
}
|
||||
};
|
||||
MenuSticky.prototype.onScroll = function (scrollTop) {
|
||||
if (this.stickyMode == StickyMode.Current) {
|
||||
if (scrollTop > this.stickyBottom) {
|
||||
this.setState('sticky-bottom');
|
||||
}
|
||||
else {
|
||||
this.setState(scrollTop + 20 > this.stickyTop ? 'sticky-current' : '');
|
||||
}
|
||||
}
|
||||
else if (this.stickyMode == StickyMode.Secondary) {
|
||||
if (scrollTop > this.stickyBottom) {
|
||||
this.setState('sticky-bottom');
|
||||
}
|
||||
else {
|
||||
this.setState(scrollTop + 20 > this.stickyTop ? 'sticky' : '');
|
||||
}
|
||||
}
|
||||
};
|
||||
return MenuSticky;
|
||||
}(Backbone.View));
|
||||
typedoc.MenuSticky = MenuSticky;
|
||||
typedoc.registerComponent(MenuSticky, '.menu-sticky');
|
||||
})(typedoc || (typedoc = {}));
|
||||
var typedoc;
|
||||
(function (typedoc) {
|
||||
var search;
|
||||
(function (search) {
|
||||
var SearchLoadingState;
|
||||
(function (SearchLoadingState) {
|
||||
SearchLoadingState[SearchLoadingState["Idle"] = 0] = "Idle";
|
||||
SearchLoadingState[SearchLoadingState["Loading"] = 1] = "Loading";
|
||||
SearchLoadingState[SearchLoadingState["Ready"] = 2] = "Ready";
|
||||
SearchLoadingState[SearchLoadingState["Failure"] = 3] = "Failure";
|
||||
})(SearchLoadingState || (SearchLoadingState = {}));
|
||||
var $el = $('#tsd-search');
|
||||
var $field = $('#tsd-search-field');
|
||||
var $results = $('.results');
|
||||
var base = $el.attr('data-base') + '/';
|
||||
var query = '';
|
||||
var loadingState = SearchLoadingState.Idle;
|
||||
var hasFocus = false;
|
||||
var preventPress = false;
|
||||
var index;
|
||||
function createIndex() {
|
||||
index = new lunr.Index();
|
||||
index.pipeline.add(lunr.trimmer);
|
||||
index.field('name', { boost: 10 });
|
||||
index.field('parent');
|
||||
index.ref('id');
|
||||
var rows = search.data.rows;
|
||||
var pos = 0;
|
||||
var length = rows.length;
|
||||
function batch() {
|
||||
var cycles = 0;
|
||||
while (cycles++ < 100) {
|
||||
index.add(rows[pos]);
|
||||
if (++pos == length) {
|
||||
return setLoadingState(SearchLoadingState.Ready);
|
||||
}
|
||||
}
|
||||
setTimeout(batch, 10);
|
||||
}
|
||||
batch();
|
||||
}
|
||||
function loadIndex() {
|
||||
if (loadingState != SearchLoadingState.Idle)
|
||||
return;
|
||||
setTimeout(function () {
|
||||
if (loadingState == SearchLoadingState.Idle) {
|
||||
setLoadingState(SearchLoadingState.Loading);
|
||||
}
|
||||
}, 500);
|
||||
if (typeof search.data != 'undefined') {
|
||||
createIndex();
|
||||
}
|
||||
else {
|
||||
$.get($el.attr('data-index'))
|
||||
.done(function (source) {
|
||||
eval(source);
|
||||
createIndex();
|
||||
}).fail(function () {
|
||||
setLoadingState(SearchLoadingState.Failure);
|
||||
});
|
||||
}
|
||||
}
|
||||
function updateResults() {
|
||||
if (loadingState != SearchLoadingState.Ready)
|
||||
return;
|
||||
$results.empty();
|
||||
var res = index.search(query);
|
||||
for (var i = 0, c = Math.min(10, res.length); i < c; i++) {
|
||||
var row = search.data.rows[res[i].ref];
|
||||
var name = row.name;
|
||||
if (row.parent)
|
||||
name = '<span class="parent">' + row.parent + '.</span>' + name;
|
||||
$results.append('<li class="' + row.classes + '"><a href="' + base + row.url + '" class="tsd-kind-icon">' + name + '</li>');
|
||||
}
|
||||
}
|
||||
function setLoadingState(value) {
|
||||
if (loadingState == value)
|
||||
return;
|
||||
$el.removeClass(SearchLoadingState[loadingState].toLowerCase());
|
||||
loadingState = value;
|
||||
$el.addClass(SearchLoadingState[loadingState].toLowerCase());
|
||||
if (value == SearchLoadingState.Ready) {
|
||||
updateResults();
|
||||
}
|
||||
}
|
||||
function setHasFocus(value) {
|
||||
if (hasFocus == value)
|
||||
return;
|
||||
hasFocus = value;
|
||||
$el.toggleClass('has-focus');
|
||||
if (!value) {
|
||||
$field.val(query);
|
||||
}
|
||||
else {
|
||||
setQuery('');
|
||||
$field.val('');
|
||||
}
|
||||
}
|
||||
function setQuery(value) {
|
||||
query = $.trim(value);
|
||||
updateResults();
|
||||
}
|
||||
function setCurrentResult(dir) {
|
||||
var $current = $results.find('.current');
|
||||
if ($current.length == 0) {
|
||||
$results.find(dir == 1 ? 'li:first-child' : 'li:last-child').addClass('current');
|
||||
}
|
||||
else {
|
||||
var $rel = dir == 1 ? $current.next('li') : $current.prev('li');
|
||||
if ($rel.length > 0) {
|
||||
$current.removeClass('current');
|
||||
$rel.addClass('current');
|
||||
}
|
||||
}
|
||||
}
|
||||
function gotoCurrentResult() {
|
||||
var $current = $results.find('.current');
|
||||
if ($current.length == 0) {
|
||||
$current = $results.find('li:first-child');
|
||||
}
|
||||
if ($current.length > 0) {
|
||||
window.location.href = $current.find('a').prop('href');
|
||||
$field.blur();
|
||||
}
|
||||
}
|
||||
$field.on('focusin', function () {
|
||||
setHasFocus(true);
|
||||
loadIndex();
|
||||
}).on('focusout', function () {
|
||||
setTimeout(function () { return setHasFocus(false); }, 100);
|
||||
}).on('input', function () {
|
||||
setQuery($.trim($field.val()));
|
||||
}).on('keydown', function (e) {
|
||||
if (e.keyCode == 13 || e.keyCode == 27 || e.keyCode == 38 || e.keyCode == 40) {
|
||||
preventPress = true;
|
||||
e.preventDefault();
|
||||
if (e.keyCode == 13) {
|
||||
gotoCurrentResult();
|
||||
}
|
||||
else if (e.keyCode == 27) {
|
||||
$field.blur();
|
||||
}
|
||||
else if (e.keyCode == 38) {
|
||||
setCurrentResult(-1);
|
||||
}
|
||||
else if (e.keyCode == 40) {
|
||||
setCurrentResult(1);
|
||||
}
|
||||
}
|
||||
else {
|
||||
preventPress = false;
|
||||
}
|
||||
}).on('keypress', function (e) {
|
||||
if (preventPress)
|
||||
e.preventDefault();
|
||||
});
|
||||
$('body').on('keydown', function (e) {
|
||||
if (e.altKey || e.ctrlKey || e.metaKey)
|
||||
return;
|
||||
if (!hasFocus && e.keyCode > 47 && e.keyCode < 112) {
|
||||
$field.focus();
|
||||
}
|
||||
});
|
||||
})(search = typedoc.search || (typedoc.search = {}));
|
||||
})(typedoc || (typedoc = {}));
|
||||
var typedoc;
|
||||
(function (typedoc) {
|
||||
var SignatureGroup = (function () {
|
||||
function SignatureGroup($signature, $description) {
|
||||
this.$signature = $signature;
|
||||
this.$description = $description;
|
||||
}
|
||||
SignatureGroup.prototype.addClass = function (className) {
|
||||
this.$signature.addClass(className);
|
||||
this.$description.addClass(className);
|
||||
return this;
|
||||
};
|
||||
SignatureGroup.prototype.removeClass = function (className) {
|
||||
this.$signature.removeClass(className);
|
||||
this.$description.removeClass(className);
|
||||
return this;
|
||||
};
|
||||
return SignatureGroup;
|
||||
}());
|
||||
var Signature = (function (_super) {
|
||||
__extends(Signature, _super);
|
||||
function Signature(options) {
|
||||
var _this = _super.call(this, options) || this;
|
||||
_this.index = -1;
|
||||
_this.createGroups();
|
||||
if (_this.groups) {
|
||||
_this.$el.addClass('active')
|
||||
.on('touchstart', '.tsd-signature', function (event) { return _this.onClick(event); })
|
||||
.on('click', '.tsd-signature', function (event) { return _this.onClick(event); });
|
||||
_this.$container.addClass('active');
|
||||
_this.setIndex(0);
|
||||
}
|
||||
return _this;
|
||||
}
|
||||
Signature.prototype.setIndex = function (index) {
|
||||
if (index < 0)
|
||||
index = 0;
|
||||
if (index > this.groups.length - 1)
|
||||
index = this.groups.length - 1;
|
||||
if (this.index == index)
|
||||
return;
|
||||
var to = this.groups[index];
|
||||
if (this.index > -1) {
|
||||
var from = this.groups[this.index];
|
||||
typedoc.animateHeight(this.$container, function () {
|
||||
from.removeClass('current').addClass('fade-out');
|
||||
to.addClass('current fade-in');
|
||||
typedoc.viewport.triggerResize();
|
||||
});
|
||||
setTimeout(function () {
|
||||
from.removeClass('fade-out');
|
||||
to.removeClass('fade-in');
|
||||
}, 300);
|
||||
}
|
||||
else {
|
||||
to.addClass('current');
|
||||
typedoc.viewport.triggerResize();
|
||||
}
|
||||
this.index = index;
|
||||
};
|
||||
Signature.prototype.createGroups = function () {
|
||||
var _this = this;
|
||||
var $signatures = this.$el.find('> .tsd-signature');
|
||||
if ($signatures.length < 2)
|
||||
return;
|
||||
this.$container = this.$el.siblings('.tsd-descriptions');
|
||||
var $descriptions = this.$container.find('> .tsd-description');
|
||||
this.groups = [];
|
||||
$signatures.each(function (index, el) {
|
||||
_this.groups.push(new SignatureGroup($(el), $descriptions.eq(index)));
|
||||
});
|
||||
};
|
||||
Signature.prototype.onClick = function (e) {
|
||||
var _this = this;
|
||||
e.preventDefault();
|
||||
_(this.groups).forEach(function (group, index) {
|
||||
if (group.$signature.is(e.currentTarget)) {
|
||||
_this.setIndex(index);
|
||||
}
|
||||
});
|
||||
};
|
||||
return Signature;
|
||||
}(Backbone.View));
|
||||
typedoc.registerComponent(Signature, '.tsd-signatures');
|
||||
})(typedoc || (typedoc = {}));
|
||||
var typedoc;
|
||||
(function (typedoc) {
|
||||
var Toggle = (function (_super) {
|
||||
__extends(Toggle, _super);
|
||||
function Toggle(options) {
|
||||
var _this = _super.call(this, options) || this;
|
||||
_this.className = _this.$el.attr('data-toggle');
|
||||
_this.$el.on(typedoc.pointerUp, function (e) { return _this.onPointerUp(e); });
|
||||
_this.$el.on('click', function (e) { return e.preventDefault(); });
|
||||
typedoc.$document.on(typedoc.pointerDown, function (e) { return _this.onDocumentPointerDown(e); });
|
||||
typedoc.$document.on(typedoc.pointerUp, function (e) { return _this.onDocumentPointerUp(e); });
|
||||
return _this;
|
||||
}
|
||||
Toggle.prototype.setActive = function (value) {
|
||||
if (this.active == value)
|
||||
return;
|
||||
this.active = value;
|
||||
typedoc.$html.toggleClass('has-' + this.className, value);
|
||||
this.$el.toggleClass('active', value);
|
||||
var transition = (this.active ? 'to-has-' : 'from-has-') + this.className;
|
||||
typedoc.$html.addClass(transition);
|
||||
setTimeout(function () { return typedoc.$html.removeClass(transition); }, 500);
|
||||
};
|
||||
Toggle.prototype.onPointerUp = function (event) {
|
||||
if (typedoc.hasPointerMoved)
|
||||
return;
|
||||
this.setActive(true);
|
||||
event.preventDefault();
|
||||
};
|
||||
Toggle.prototype.onDocumentPointerDown = function (e) {
|
||||
if (this.active) {
|
||||
var $path = $(e.target).parents().addBack();
|
||||
if ($path.hasClass('col-menu')) {
|
||||
return;
|
||||
}
|
||||
if ($path.hasClass('tsd-filter-group')) {
|
||||
return;
|
||||
}
|
||||
this.setActive(false);
|
||||
}
|
||||
};
|
||||
Toggle.prototype.onDocumentPointerUp = function (e) {
|
||||
var _this = this;
|
||||
if (typedoc.hasPointerMoved)
|
||||
return;
|
||||
if (this.active) {
|
||||
var $path = $(e.target).parents().addBack();
|
||||
if ($path.hasClass('col-menu')) {
|
||||
var $link = $path.filter('a');
|
||||
if ($link.length) {
|
||||
var href = window.location.href;
|
||||
if (href.indexOf('#') != -1) {
|
||||
href = href.substr(0, href.indexOf('#'));
|
||||
}
|
||||
if ($link.prop('href').substr(0, href.length) == href) {
|
||||
setTimeout(function () { return _this.setActive(false); }, 250);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
};
|
||||
return Toggle;
|
||||
}(Backbone.View));
|
||||
typedoc.registerComponent(Toggle, 'a[data-toggle]');
|
||||
})(typedoc || (typedoc = {}));
|
||||
var typedoc;
|
||||
(function (typedoc) {
|
||||
var Viewport = (function (_super) {
|
||||
__extends(Viewport, _super);
|
||||
function Viewport() {
|
||||
var _this = _super.call(this) || this;
|
||||
_this.scrollTop = 0;
|
||||
_this.width = 0;
|
||||
_this.height = 0;
|
||||
typedoc.$window.on('scroll', _(function () { return _this.onScroll(); }).throttle(10));
|
||||
typedoc.$window.on('resize', _(function () { return _this.onResize(); }).throttle(10));
|
||||
_this.onResize();
|
||||
_this.onScroll();
|
||||
return _this;
|
||||
}
|
||||
Viewport.prototype.triggerResize = function () {
|
||||
this.trigger('resize', this.width, this.height);
|
||||
};
|
||||
Viewport.prototype.onResize = function () {
|
||||
this.width = typedoc.$window.width();
|
||||
this.height = typedoc.$window.height();
|
||||
this.trigger('resize', this.width, this.height);
|
||||
};
|
||||
Viewport.prototype.onScroll = function () {
|
||||
this.scrollTop = typedoc.$window.scrollTop();
|
||||
this.trigger('scroll', this.scrollTop);
|
||||
};
|
||||
return Viewport;
|
||||
}(typedoc.Events));
|
||||
typedoc.Viewport = Viewport;
|
||||
typedoc.registerService(Viewport, 'viewport');
|
||||
})(typedoc || (typedoc = {}));
|
||||
var typedoc;
|
||||
(function (typedoc) {
|
||||
typedoc.pointerDown = 'mousedown';
|
||||
typedoc.pointerMove = 'mousemove';
|
||||
typedoc.pointerUp = 'mouseup';
|
||||
typedoc.pointerDownPosition = { x: 0, y: 0 };
|
||||
typedoc.preventNextClick = false;
|
||||
typedoc.isPointerDown = false;
|
||||
typedoc.isPointerTouch = false;
|
||||
typedoc.hasPointerMoved = false;
|
||||
typedoc.isMobile = /Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);
|
||||
typedoc.$html.addClass(typedoc.isMobile ? 'is-mobile' : 'not-mobile');
|
||||
if (typedoc.isMobile && 'ontouchstart' in document.documentElement) {
|
||||
typedoc.isPointerTouch = true;
|
||||
typedoc.pointerDown = 'touchstart';
|
||||
typedoc.pointerMove = 'touchmove';
|
||||
typedoc.pointerUp = 'touchend';
|
||||
}
|
||||
typedoc.$document.on(typedoc.pointerDown, function (e) {
|
||||
typedoc.isPointerDown = true;
|
||||
typedoc.hasPointerMoved = false;
|
||||
var t = (typedoc.pointerDown == 'touchstart' ? e.originalEvent['targetTouches'][0] : e);
|
||||
typedoc.pointerDownPosition.x = t.pageX;
|
||||
typedoc.pointerDownPosition.y = t.pageY;
|
||||
}).on(typedoc.pointerMove, function (e) {
|
||||
if (!typedoc.isPointerDown)
|
||||
return;
|
||||
if (!typedoc.hasPointerMoved) {
|
||||
var t = (typedoc.pointerDown == 'touchstart' ? e.originalEvent['targetTouches'][0] : e);
|
||||
var x = typedoc.pointerDownPosition.x - t.pageX;
|
||||
var y = typedoc.pointerDownPosition.y - t.pageY;
|
||||
typedoc.hasPointerMoved = (Math.sqrt(x * x + y * y) > 10);
|
||||
}
|
||||
}).on(typedoc.pointerUp, function (e) {
|
||||
typedoc.isPointerDown = false;
|
||||
}).on('click', function (e) {
|
||||
if (typedoc.preventNextClick) {
|
||||
e.preventDefault();
|
||||
e.stopImmediatePropagation();
|
||||
typedoc.preventNextClick = false;
|
||||
}
|
||||
});
|
||||
})(typedoc || (typedoc = {}));
|
||||
var typedoc;
|
||||
(function (typedoc) {
|
||||
function getVendorInfo(tuples) {
|
||||
for (var name in tuples) {
|
||||
if (!tuples.hasOwnProperty(name))
|
||||
continue;
|
||||
if (typeof (document.body.style[name]) !== 'undefined') {
|
||||
return { name: name, endEvent: tuples[name] };
|
||||
}
|
||||
}
|
||||
return null;
|
||||
}
|
||||
typedoc.transition = getVendorInfo({
|
||||
'transition': 'transitionend',
|
||||
'OTransition': 'oTransitionEnd',
|
||||
'msTransition': 'msTransitionEnd',
|
||||
'MozTransition': 'transitionend',
|
||||
'WebkitTransition': 'webkitTransitionEnd'
|
||||
});
|
||||
function noTransition($el, callback) {
|
||||
$el.addClass('no-transition');
|
||||
callback();
|
||||
$el.offset();
|
||||
$el.removeClass('no-transition');
|
||||
}
|
||||
typedoc.noTransition = noTransition;
|
||||
function animateHeight($el, callback, success) {
|
||||
var from = $el.height(), to;
|
||||
noTransition($el, function () {
|
||||
callback();
|
||||
$el.css('height', '');
|
||||
to = $el.height();
|
||||
if (from != to && typedoc.transition)
|
||||
$el.css('height', from);
|
||||
});
|
||||
if (from != to && typedoc.transition) {
|
||||
$el.css('height', to);
|
||||
$el.on(typedoc.transition.endEvent, function () {
|
||||
noTransition($el, function () {
|
||||
$el.off(typedoc.transition.endEvent).css('height', '');
|
||||
if (success)
|
||||
success();
|
||||
});
|
||||
});
|
||||
}
|
||||
else {
|
||||
if (success)
|
||||
success();
|
||||
}
|
||||
}
|
||||
typedoc.animateHeight = animateHeight;
|
||||
})(typedoc || (typedoc = {}));
|
||||
var typedoc;
|
||||
(function (typedoc) {
|
||||
typedoc.app = new typedoc.Application();
|
||||
})(typedoc || (typedoc = {}));
|
||||
387
openvidu-browser/config/typedoc/custom-theme/assets/js/src/lib/backbone/backbone.d.ts
vendored
Normal file
387
openvidu-browser/config/typedoc/custom-theme/assets/js/src/lib/backbone/backbone.d.ts
vendored
Normal file
|
|
@ -0,0 +1,387 @@
|
|||
// Type definitions for Backbone 1.0.0
|
||||
// Project: http://backbonejs.org/
|
||||
// Definitions by: Boris Yankov <https://github.com/borisyankov/>, Natan Vivo <https://github.com/nvivo/>
|
||||
// Definitions: https://github.com/borisyankov/DefinitelyTyped
|
||||
|
||||
/// <reference path="../jquery/jquery.d.ts" />
|
||||
/// <reference path="../underscore/underscore.d.ts" />
|
||||
|
||||
declare module Backbone {
|
||||
|
||||
interface AddOptions extends Silenceable {
|
||||
at?: number;
|
||||
}
|
||||
|
||||
interface HistoryOptions extends Silenceable {
|
||||
pushState?: boolean;
|
||||
root?: string;
|
||||
}
|
||||
|
||||
interface NavigateOptions {
|
||||
trigger?: boolean;
|
||||
}
|
||||
|
||||
interface RouterOptions {
|
||||
routes: any;
|
||||
}
|
||||
|
||||
interface Silenceable {
|
||||
silent?: boolean;
|
||||
}
|
||||
|
||||
interface Validable {
|
||||
validate?: boolean;
|
||||
}
|
||||
|
||||
interface Waitable {
|
||||
wait?: boolean;
|
||||
}
|
||||
|
||||
interface Parseable {
|
||||
parse?: any;
|
||||
}
|
||||
|
||||
interface PersistenceOptions {
|
||||
url?: string;
|
||||
beforeSend?: (jqxhr: JQueryXHR) => void;
|
||||
success?: (modelOrCollection?: any, response?: any, options?: any) => void;
|
||||
error?: (modelOrCollection?: any, jqxhr?: JQueryXHR, options?: any) => void;
|
||||
}
|
||||
|
||||
interface ModelSetOptions extends Silenceable, Validable {
|
||||
}
|
||||
|
||||
interface ModelFetchOptions extends PersistenceOptions, ModelSetOptions, Parseable {
|
||||
}
|
||||
|
||||
interface ModelSaveOptions extends Silenceable, Waitable, Validable, Parseable, PersistenceOptions {
|
||||
patch?: boolean;
|
||||
}
|
||||
|
||||
interface ModelDestroyOptions extends Waitable, PersistenceOptions {
|
||||
}
|
||||
|
||||
interface CollectionFetchOptions extends PersistenceOptions, Parseable {
|
||||
reset?: boolean;
|
||||
}
|
||||
|
||||
class Events {
|
||||
on(eventName: string, callback?: Function, context?: any): any;
|
||||
off(eventName?: string, callback?: Function, context?: any): any;
|
||||
trigger(eventName: string, ...args: any[]): any;
|
||||
bind(eventName: string, callback: Function, context?: any): any;
|
||||
unbind(eventName?: string, callback?: Function, context?: any): any;
|
||||
|
||||
once(events: string, callback: Function, context?: any): any;
|
||||
listenTo(object: any, events: string, callback: Function): any;
|
||||
listenToOnce(object: any, events: string, callback: Function): any;
|
||||
stopListening(object?: any, events?: string, callback?: Function): any;
|
||||
}
|
||||
|
||||
class ModelBase extends Events {
|
||||
url: any;
|
||||
parse(response: any, options?: any): any;
|
||||
toJSON(options?: any): any;
|
||||
sync(...arg: any[]): JQueryXHR;
|
||||
}
|
||||
|
||||
class Model extends ModelBase {
|
||||
|
||||
/**
|
||||
* Do not use, prefer TypeScript's extend functionality.
|
||||
**/
|
||||
private static extend(properties: any, classProperties?: any): any;
|
||||
|
||||
attributes: any;
|
||||
changed: any[];
|
||||
cid: string;
|
||||
collection: Collection<any>;
|
||||
|
||||
/**
|
||||
* Default attributes for the model. It can be an object hash or a method returning an object hash.
|
||||
* For assigning an object hash, do it like this: this.defaults = <any>{ attribute: value, ... };
|
||||
* That works only if you set it in the constructor or the initialize method.
|
||||
**/
|
||||
defaults(): any;
|
||||
id: any;
|
||||
idAttribute: string;
|
||||
validationError: any;
|
||||
urlRoot: any;
|
||||
|
||||
constructor(attributes?: any, options?: any);
|
||||
initialize(attributes?: any): void;
|
||||
|
||||
fetch(options?: ModelFetchOptions): JQueryXHR;
|
||||
|
||||
/**
|
||||
* For strongly-typed access to attributes, use the `get` method only privately in public getter properties.
|
||||
* @example
|
||||
* get name(): string {
|
||||
* return super.get("name");
|
||||
* }
|
||||
**/
|
||||
/*private*/ get(attributeName: string): any;
|
||||
|
||||
/**
|
||||
* For strongly-typed assignment of attributes, use the `set` method only privately in public setter properties.
|
||||
* @example
|
||||
* set name(value: string) {
|
||||
* super.set("name", value);
|
||||
* }
|
||||
**/
|
||||
/*private*/ set(attributeName: string, value: any, options?: ModelSetOptions): Model;
|
||||
set(obj: any, options?: ModelSetOptions): Model;
|
||||
|
||||
change(): any;
|
||||
changedAttributes(attributes?: any): any[];
|
||||
clear(options?: Silenceable): any;
|
||||
clone(): Model;
|
||||
destroy(options?: ModelDestroyOptions): any;
|
||||
escape(attribute: string): string;
|
||||
has(attribute: string): boolean;
|
||||
hasChanged(attribute?: string): boolean;
|
||||
isNew(): boolean;
|
||||
isValid(options?:any): boolean;
|
||||
previous(attribute: string): any;
|
||||
previousAttributes(): any[];
|
||||
save(attributes?: any, options?: ModelSaveOptions): any;
|
||||
unset(attribute: string, options?: Silenceable): Model;
|
||||
validate(attributes: any, options?: any): any;
|
||||
|
||||
private _validate(attrs: any, options: any): boolean;
|
||||
|
||||
// mixins from underscore
|
||||
|
||||
keys(): string[];
|
||||
values(): any[];
|
||||
pairs(): any[];
|
||||
invert(): any;
|
||||
pick(keys: string[]): any;
|
||||
pick(...keys: string[]): any;
|
||||
omit(keys: string[]): any;
|
||||
omit(...keys: string[]): any;
|
||||
}
|
||||
|
||||
class Collection<TModel extends Model> extends ModelBase {
|
||||
|
||||
/**
|
||||
* Do not use, prefer TypeScript's extend functionality.
|
||||
**/
|
||||
private static extend(properties: any, classProperties?: any): any;
|
||||
|
||||
// TODO: this really has to be typeof TModel
|
||||
//model: typeof TModel;
|
||||
model: { new(): TModel; }; // workaround
|
||||
models: TModel[];
|
||||
length: number;
|
||||
|
||||
constructor(models?: TModel[], options?: any);
|
||||
|
||||
fetch(options?: CollectionFetchOptions): JQueryXHR;
|
||||
|
||||
comparator(element: TModel): number;
|
||||
comparator(compare: TModel, to?: TModel): number;
|
||||
|
||||
add(model: TModel, options?: AddOptions): Collection<TModel>;
|
||||
add(models: TModel[], options?: AddOptions): Collection<TModel>;
|
||||
at(index: number): TModel;
|
||||
/**
|
||||
* Get a model from a collection, specified by an id, a cid, or by passing in a model.
|
||||
**/
|
||||
get(id: number): TModel;
|
||||
get(id: string): TModel;
|
||||
get(id: Model): TModel;
|
||||
create(attributes: any, options?: ModelSaveOptions): TModel;
|
||||
pluck(attribute: string): any[];
|
||||
push(model: TModel, options?: AddOptions): TModel;
|
||||
pop(options?: Silenceable): TModel;
|
||||
remove(model: TModel, options?: Silenceable): TModel;
|
||||
remove(models: TModel[], options?: Silenceable): TModel[];
|
||||
reset(models?: TModel[], options?: Silenceable): TModel[];
|
||||
set(models?: TModel[], options?: Silenceable): TModel[];
|
||||
shift(options?: Silenceable): TModel;
|
||||
sort(options?: Silenceable): Collection<TModel>;
|
||||
unshift(model: TModel, options?: AddOptions): TModel;
|
||||
where(properies: any): TModel[];
|
||||
findWhere(properties: any): TModel;
|
||||
|
||||
private _prepareModel(attrs?: any, options?: any): any;
|
||||
private _removeReference(model: TModel): void;
|
||||
private _onModelEvent(event: string, model: TModel, collection: Collection<TModel>, options: any): void;
|
||||
|
||||
// mixins from underscore
|
||||
|
||||
all(iterator: (element: TModel, index: number) => boolean, context?: any): boolean;
|
||||
any(iterator: (element: TModel, index: number) => boolean, context?: any): boolean;
|
||||
collect(iterator: (element: TModel, index: number, context?: any) => any[], context?: any): any[];
|
||||
chain(): any;
|
||||
compact(): TModel[];
|
||||
contains(value: any): boolean;
|
||||
countBy(iterator: (element: TModel, index: number) => any): _.Dictionary<number>;
|
||||
countBy(attribute: string): _.Dictionary<number>;
|
||||
detect(iterator: (item: any) => boolean, context?: any): any; // ???
|
||||
difference(...model: TModel[]): TModel[];
|
||||
drop(): TModel;
|
||||
drop(n: number): TModel[];
|
||||
each(iterator: (element: TModel, index: number, list?: any) => void, context?: any): any;
|
||||
every(iterator: (element: TModel, index: number) => boolean, context?: any): boolean;
|
||||
filter(iterator: (element: TModel, index: number) => boolean, context?: any): TModel[];
|
||||
find(iterator: (element: TModel, index: number) => boolean, context?: any): TModel;
|
||||
first(): TModel;
|
||||
first(n: number): TModel[];
|
||||
flatten(shallow?: boolean): TModel[];
|
||||
foldl(iterator: (memo: any, element: TModel, index: number) => any, initialMemo: any, context?: any): any;
|
||||
forEach(iterator: (element: TModel, index: number, list?: any) => void, context?: any): any;
|
||||
groupBy(iterator: (element: TModel, index: number) => string, context?: any): _.Dictionary<TModel[]>;
|
||||
groupBy(attribute: string, context?: any): _.Dictionary<TModel[]>;
|
||||
include(value: any): boolean;
|
||||
indexOf(element: TModel, isSorted?: boolean): number;
|
||||
initial(): TModel;
|
||||
initial(n: number): TModel[];
|
||||
inject(iterator: (memo: any, element: TModel, index: number) => any, initialMemo: any, context?: any): any;
|
||||
intersection(...model: TModel[]): TModel[];
|
||||
isEmpty(object: any): boolean;
|
||||
invoke(methodName: string, args?: any[]): any;
|
||||
last(): TModel;
|
||||
last(n: number): TModel[];
|
||||
lastIndexOf(element: TModel, fromIndex?: number): number;
|
||||
map(iterator: (element: TModel, index: number, context?: any) => any[], context?: any): any[];
|
||||
max(iterator?: (element: TModel, index: number) => any, context?: any): TModel;
|
||||
min(iterator?: (element: TModel, index: number) => any, context?: any): TModel;
|
||||
object(...values: any[]): any[];
|
||||
reduce(iterator: (memo: any, element: TModel, index: number) => any, initialMemo: any, context?: any): any;
|
||||
select(iterator: any, context?: any): any[];
|
||||
size(): number;
|
||||
shuffle(): any[];
|
||||
some(iterator: (element: TModel, index: number) => boolean, context?: any): boolean;
|
||||
sortBy(iterator: (element: TModel, index: number) => number, context?: any): TModel[];
|
||||
sortBy(attribute: string, context?: any): TModel[];
|
||||
sortedIndex(element: TModel, iterator?: (element: TModel, index: number) => number): number;
|
||||
range(stop: number, step?: number): any;
|
||||
range(start: number, stop: number, step?: number): any;
|
||||
reduceRight(iterator: (memo: any, element: TModel, index: number) => any, initialMemo: any, context?: any): any[];
|
||||
reject(iterator: (element: TModel, index: number) => boolean, context?: any): TModel[];
|
||||
rest(): TModel;
|
||||
rest(n: number): TModel[];
|
||||
tail(): TModel;
|
||||
tail(n: number): TModel[];
|
||||
toArray(): any[];
|
||||
union(...model: TModel[]): TModel[];
|
||||
uniq(isSorted?: boolean, iterator?: (element: TModel, index: number) => boolean): TModel[];
|
||||
without(...values: any[]): TModel[];
|
||||
zip(...model: TModel[]): TModel[];
|
||||
}
|
||||
|
||||
class Router extends Events {
|
||||
|
||||
/**
|
||||
* Do not use, prefer TypeScript's extend functionality.
|
||||
**/
|
||||
private static extend(properties: any, classProperties?: any): any;
|
||||
|
||||
/**
|
||||
* Routes hash or a method returning the routes hash that maps URLs with parameters to methods on your Router.
|
||||
* For assigning routes as object hash, do it like this: this.routes = <any>{ "route": callback, ... };
|
||||
* That works only if you set it in the constructor or the initialize method.
|
||||
**/
|
||||
routes(): any;
|
||||
|
||||
constructor(options?: RouterOptions);
|
||||
initialize(options?: RouterOptions): void;
|
||||
route(route: string, name: string, callback?: Function): Router;
|
||||
navigate(fragment: string, options?: NavigateOptions): Router;
|
||||
navigate(fragment: string, trigger?: boolean): Router;
|
||||
|
||||
private _bindRoutes(): void;
|
||||
private _routeToRegExp(route: string): RegExp;
|
||||
private _extractParameters(route: RegExp, fragment: string): string[];
|
||||
}
|
||||
|
||||
var history: History;
|
||||
|
||||
class History extends Events {
|
||||
|
||||
handlers: any[];
|
||||
interval: number;
|
||||
|
||||
start(options?: HistoryOptions): boolean;
|
||||
|
||||
getHash(window?: Window): string;
|
||||
getFragment(fragment?: string, forcePushState?: boolean): string;
|
||||
stop(): void;
|
||||
route(route: string, callback: Function): number;
|
||||
checkUrl(e?: any): void;
|
||||
loadUrl(fragmentOverride: string): boolean;
|
||||
navigate(fragment: string, options?: any): boolean;
|
||||
started: boolean;
|
||||
options: any;
|
||||
|
||||
private _updateHash(location: Location, fragment: string, replace: boolean): void;
|
||||
}
|
||||
|
||||
interface ViewOptions<TModel extends Model> {
|
||||
model?: TModel;
|
||||
collection?: Backbone.Collection<TModel>;
|
||||
el?: any;
|
||||
id?: string;
|
||||
className?: string;
|
||||
tagName?: string;
|
||||
attributes?: any[];
|
||||
}
|
||||
|
||||
class View<TModel extends Model> extends Events {
|
||||
|
||||
/**
|
||||
* Do not use, prefer TypeScript's extend functionality.
|
||||
**/
|
||||
private static extend(properties: any, classProperties?: any): any;
|
||||
|
||||
constructor(options?: ViewOptions<TModel>);
|
||||
|
||||
/**
|
||||
* Events hash or a method returning the events hash that maps events/selectors to methods on your View.
|
||||
* For assigning events as object hash, do it like this: this.events = <any>{ "event:selector": callback, ... };
|
||||
* That works only if you set it in the constructor or the initialize method.
|
||||
**/
|
||||
events(): any;
|
||||
|
||||
$(selector: string): JQuery;
|
||||
model: TModel;
|
||||
collection: Collection<TModel>;
|
||||
//template: (json, options?) => string;
|
||||
make(tagName: string, attrs?: any, opts?: any): View<TModel>;
|
||||
setElement(element: HTMLElement, delegate?: boolean): View<TModel>;
|
||||
setElement(element: JQuery, delegate?: boolean): View<TModel>;
|
||||
id: string;
|
||||
cid: string;
|
||||
className: string;
|
||||
tagName: string;
|
||||
|
||||
el: any;
|
||||
$el: JQuery;
|
||||
setElement(element: any): View<TModel>;
|
||||
attributes: any;
|
||||
$(selector: any): JQuery;
|
||||
render(): View<TModel>;
|
||||
remove(): View<TModel>;
|
||||
make(tagName: any, attributes?: any, content?: any): any;
|
||||
delegateEvents(events?: any): any;
|
||||
undelegateEvents(): any;
|
||||
|
||||
_ensureElement(): void;
|
||||
}
|
||||
|
||||
// SYNC
|
||||
function sync(method: string, model: Model, options?: JQueryAjaxSettings): any;
|
||||
function ajax(options?: JQueryAjaxSettings): JQueryXHR;
|
||||
var emulateHTTP: boolean;
|
||||
var emulateJSON: boolean;
|
||||
|
||||
// Utility
|
||||
function noConflict(): typeof Backbone;
|
||||
var $: JQueryStatic;
|
||||
}
|
||||
|
||||
declare module "backbone" {
|
||||
export = Backbone;
|
||||
}
|
||||
3929
openvidu-browser/config/typedoc/custom-theme/assets/js/src/lib/jquery/jquery.d.ts
vendored
Normal file
3929
openvidu-browser/config/typedoc/custom-theme/assets/js/src/lib/jquery/jquery.d.ts
vendored
Normal file
File diff suppressed because it is too large
Load Diff
839
openvidu-browser/config/typedoc/custom-theme/assets/js/src/lib/lunr/lunr.d.ts
vendored
Normal file
839
openvidu-browser/config/typedoc/custom-theme/assets/js/src/lib/lunr/lunr.d.ts
vendored
Normal file
|
|
@ -0,0 +1,839 @@
|
|||
// Type definitions for lunr.js 0.5.4
|
||||
// Project: https://github.com/olivernn/lunr.js
|
||||
// Definitions by: Sebastian Lenz <https://github.com/sebastian-lenz>
|
||||
// Definitions: https://github.com/borisyankov/DefinitelyTyped
|
||||
|
||||
/**
|
||||
* lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 0.5.4
|
||||
* Copyright (C) 2014 Oliver Nightingale
|
||||
* MIT Licensed
|
||||
* @license
|
||||
*/
|
||||
declare module lunr
|
||||
{
|
||||
var version:string;
|
||||
|
||||
|
||||
/**
|
||||
* A function for splitting a string into tokens ready to be inserted into the search index.
|
||||
*
|
||||
* @param token The token to pass through the filter
|
||||
*/
|
||||
function tokenizer(token:string):string;
|
||||
|
||||
|
||||
/**
|
||||
* lunr.stemmer is an english language stemmer, this is a JavaScript implementation of
|
||||
* the PorterStemmer taken from http://tartaurs.org/~martin
|
||||
*
|
||||
* @param token The string to stem
|
||||
*/
|
||||
function stemmer(token:string):string;
|
||||
|
||||
|
||||
/**
|
||||
* lunr.stopWordFilter is an English language stop word list filter, any words contained
|
||||
* in the list will not be passed through the filter.
|
||||
*
|
||||
* This is intended to be used in the Pipeline. If the token does not pass the filter then
|
||||
* undefined will be returned.
|
||||
*
|
||||
* @param token The token to pass through the filter
|
||||
*/
|
||||
function stopWordFilter(token:string):string;
|
||||
|
||||
module stopWordFilter {
|
||||
var stopWords:SortedSet<string>;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* lunr.trimmer is a pipeline function for trimming non word characters from the beginning
|
||||
* and end of tokens before they enter the index.
|
||||
*
|
||||
* This implementation may not work correctly for non latin characters and should either
|
||||
* be removed or adapted for use with languages with non-latin characters.
|
||||
* @param token The token to pass through the filter
|
||||
*/
|
||||
function trimmer(token:string):string;
|
||||
|
||||
|
||||
/**
|
||||
* lunr.EventEmitter is an event emitter for lunr. It manages adding and removing event handlers
|
||||
* and triggering events and their handlers.
|
||||
*/
|
||||
class EventEmitter
|
||||
{
|
||||
/**
|
||||
* Can bind a single function to many different events in one call.
|
||||
*
|
||||
* @param eventName The name(s) of events to bind this function to.
|
||||
* @param handler The function to call when an event is fired. Binds a handler
|
||||
* function to a specific event(s).
|
||||
*/
|
||||
addListener(eventName:string, handler:Function):void;
|
||||
addListener(eventName:string, eventName2:string, handler:Function):void;
|
||||
addListener(eventName:string, eventName2:string, eventName3:string, handler:Function):void;
|
||||
addListener(eventName:string, eventName2:string, eventName3:string, eventName4:string, handler:Function):void;
|
||||
addListener(eventName:string, eventName2:string, eventName3:string, eventName4:string, eventName5:string, handler:Function):void;
|
||||
|
||||
|
||||
/**
|
||||
* Removes a handler function from a specific event.
|
||||
*
|
||||
* @param eventName The name of the event to remove this function from.
|
||||
* @param handler The function to remove from an event.
|
||||
*/
|
||||
removeListener(eventName:string, handler:Function):void;
|
||||
|
||||
|
||||
/**
|
||||
* Calls all functions bound to the given event.
|
||||
*
|
||||
* Additional data can be passed to the event handler as arguments to emit after the event name.
|
||||
*
|
||||
* @param eventName The name of the event to emit.
|
||||
* @param args
|
||||
*/
|
||||
emit(eventName:string, ...args:any[]):void;
|
||||
|
||||
|
||||
/**
|
||||
* Checks whether a handler has ever been stored against an event.
|
||||
*
|
||||
* @param eventName The name of the event to check.
|
||||
*/
|
||||
hasHandler(eventName:string):boolean;
|
||||
}
|
||||
|
||||
|
||||
interface IPipelineFunction {
|
||||
(token:string):string;
|
||||
(token:string, tokenIndex:number):string;
|
||||
(token:string, tokenIndex:number, tokens:string[]):string;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* lunr.Pipelines maintain an ordered list of functions to be applied to all tokens in documents
|
||||
* entering the search index and queries being ran against the index.
|
||||
*
|
||||
* An instance of lunr.Index created with the lunr shortcut will contain a pipeline with a stop
|
||||
* word filter and an English language stemmer. Extra functions can be added before or after either
|
||||
* of these functions or these default functions can be removed.
|
||||
*
|
||||
* When run the pipeline will call each function in turn, passing a token, the index of that token
|
||||
* in the original list of all tokens and finally a list of all the original tokens.
|
||||
*
|
||||
* The output of functions in the pipeline will be passed to the next function in the pipeline.
|
||||
* To exclude a token from entering the index the function should return undefined, the rest of
|
||||
* the pipeline will not be called with this token.
|
||||
*
|
||||
* For serialisation of pipelines to work, all functions used in an instance of a pipeline should
|
||||
* be registered with lunr.Pipeline. Registered functions can then be loaded. If trying to load a
|
||||
* serialised pipeline that uses functions that are not registered an error will be thrown.
|
||||
*
|
||||
* If not planning on serialising the pipeline then registering pipeline functions is not necessary.
|
||||
*/
|
||||
class Pipeline
|
||||
{
|
||||
registeredFunctions:{[label:string]:Function};
|
||||
|
||||
|
||||
/**
|
||||
* Register a function with the pipeline.
|
||||
*
|
||||
* Functions that are used in the pipeline should be registered if the pipeline needs to be
|
||||
* serialised, or a serialised pipeline needs to be loaded.
|
||||
*
|
||||
* Registering a function does not add it to a pipeline, functions must still be added to instances
|
||||
* of the pipeline for them to be used when running a pipeline.
|
||||
*
|
||||
* @param fn The function to check for.
|
||||
* @param label The label to register this function with
|
||||
*/
|
||||
registerFunction(fn:IPipelineFunction, label:string):void;
|
||||
|
||||
|
||||
/**
|
||||
* Warns if the function is not registered as a Pipeline function.
|
||||
*
|
||||
* @param fn The function to check for.
|
||||
*/
|
||||
warnIfFunctionNotRegistered(fn:IPipelineFunction):void;
|
||||
|
||||
|
||||
/**
|
||||
* Adds new functions to the end of the pipeline.
|
||||
*
|
||||
* Logs a warning if the function has not been registered.
|
||||
*
|
||||
* @param functions Any number of functions to add to the pipeline.
|
||||
*/
|
||||
add(...functions:IPipelineFunction[]):void;
|
||||
|
||||
|
||||
/**
|
||||
* Adds a single function after a function that already exists in the pipeline.
|
||||
*
|
||||
* Logs a warning if the function has not been registered.
|
||||
*
|
||||
* @param existingFn A function that already exists in the pipeline.
|
||||
* @param newFn The new function to add to the pipeline.
|
||||
*/
|
||||
after(existingFn:IPipelineFunction, newFn:IPipelineFunction):void;
|
||||
|
||||
|
||||
/**
|
||||
* Adds a single function before a function that already exists in the pipeline.
|
||||
*
|
||||
* Logs a warning if the function has not been registered.
|
||||
*
|
||||
* @param existingFn A function that already exists in the pipeline.
|
||||
* @param newFn The new function to add to the pipeline.
|
||||
*/
|
||||
before(existingFn:IPipelineFunction, newFn:IPipelineFunction):void;
|
||||
|
||||
|
||||
/**
|
||||
* Removes a function from the pipeline.
|
||||
*
|
||||
* @param fn The function to remove from the pipeline.
|
||||
*/
|
||||
remove(fn:IPipelineFunction):void;
|
||||
|
||||
|
||||
/**
|
||||
* Runs the current list of functions that make up the pipeline against
|
||||
* the passed tokens.
|
||||
*
|
||||
* @param tokens The tokens to run through the pipeline.
|
||||
*/
|
||||
run(tokens:string[]):string[];
|
||||
|
||||
|
||||
/**
|
||||
* Resets the pipeline by removing any existing processors.
|
||||
*/
|
||||
reset():void;
|
||||
|
||||
|
||||
/**
|
||||
* Returns a representation of the pipeline ready for serialisation.
|
||||
*/
|
||||
toJSON():any;
|
||||
|
||||
|
||||
/**
|
||||
* Loads a previously serialised pipeline.
|
||||
*
|
||||
* All functions to be loaded must already be registered with lunr.Pipeline. If any function from
|
||||
* the serialised data has not been registered then an error will be thrown.
|
||||
*
|
||||
* @param serialised The serialised pipeline to load.
|
||||
*/
|
||||
static load(serialised:any):Pipeline;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* lunr.Vectors implement vector related operations for a series of elements.
|
||||
*/
|
||||
class Vector
|
||||
{
|
||||
list:Node;
|
||||
|
||||
|
||||
/**
|
||||
* Calculates the magnitude of this vector.
|
||||
*/
|
||||
magnitude():number;
|
||||
|
||||
|
||||
/**
|
||||
* Calculates the dot product of this vector and another vector.
|
||||
* @param otherVector The vector to compute the dot product with.
|
||||
*/
|
||||
dot(otherVector:Vector):number;
|
||||
|
||||
|
||||
/**
|
||||
* Calculates the cosine similarity between this vector and another vector.
|
||||
*
|
||||
* @param otherVector The other vector to calculate the
|
||||
*/
|
||||
similarity(otherVector:Vector):number;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* lunr.Vector.Node is a simple struct for each node in a lunr.Vector.
|
||||
*/
|
||||
class Node
|
||||
{
|
||||
/**
|
||||
* The index of the node in the vector.
|
||||
*/
|
||||
idx:number;
|
||||
|
||||
/**
|
||||
* The data at this node in the vector.
|
||||
*/
|
||||
val:number;
|
||||
|
||||
/**
|
||||
* The node directly after this node in the vector.
|
||||
*/
|
||||
next:Node;
|
||||
|
||||
|
||||
/**
|
||||
* @param idx The index of the node in the vector.
|
||||
* @param val The data at this node in the vector.
|
||||
* @param next The node directly after this node in the vector.
|
||||
*/
|
||||
constructor(idx:number, val:number, next:Node);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* lunr.SortedSets are used to maintain an array of unique values in a sorted order.
|
||||
*/
|
||||
class SortedSet<T>
|
||||
{
|
||||
elements:T[];
|
||||
|
||||
length:number;
|
||||
|
||||
|
||||
/**
|
||||
* Inserts new items into the set in the correct position to maintain the order.
|
||||
*
|
||||
* @param values The objects to add to this set.
|
||||
*/
|
||||
add(...values:T[]):void;
|
||||
|
||||
|
||||
/**
|
||||
* Converts this sorted set into an array.
|
||||
*/
|
||||
toArray():T[];
|
||||
|
||||
|
||||
/**
|
||||
* Creates a new array with the results of calling a provided function on
|
||||
* every element in this sorted set.
|
||||
*
|
||||
* Delegates to Array.prototype.map and has the same signature.
|
||||
*
|
||||
* @param fn The function that is called on each element of the
|
||||
* @param ctx An optional object that can be used as the context
|
||||
*/
|
||||
map(fn:Function, ctx:any):T[];
|
||||
|
||||
|
||||
/**
|
||||
* Executes a provided function once per sorted set element.
|
||||
*
|
||||
* Delegates to Array.prototype.forEach and has the same signature.
|
||||
*
|
||||
* @param fn The function that is called on each element of the
|
||||
* @param ctx An optional object that can be used as the context
|
||||
*/
|
||||
forEach(fn:Function, ctx:any):any;
|
||||
|
||||
|
||||
/**
|
||||
* Returns the index at which a given element can be found in the sorted
|
||||
* set, or -1 if it is not present.
|
||||
*
|
||||
* @param elem The object to locate in the sorted set.
|
||||
* @param start An optional index at which to start searching from
|
||||
* @param end An optional index at which to stop search from within
|
||||
*/
|
||||
indexOf(elem:T, start?:number, end?:number):number;
|
||||
|
||||
|
||||
/**
|
||||
* Returns the position within the sorted set that an element should be
|
||||
* inserted at to maintain the current order of the set.
|
||||
*
|
||||
* This function assumes that the element to search for does not already exist
|
||||
* in the sorted set.
|
||||
*
|
||||
* @param elem - The elem to find the position for in the set
|
||||
* @param start - An optional index at which to start searching from
|
||||
* @param end - An optional index at which to stop search from within
|
||||
*/
|
||||
locationFor(elem:T, start?:number, end?:number):number;
|
||||
|
||||
|
||||
/**
|
||||
* Creates a new lunr.SortedSet that contains the elements in the
|
||||
* intersection of this set and the passed set.
|
||||
*
|
||||
* @param otherSet The set to intersect with this set.
|
||||
*/
|
||||
intersect(otherSet:SortedSet<T>):SortedSet<T>;
|
||||
|
||||
|
||||
/**
|
||||
* Creates a new lunr.SortedSet that contains the elements in the union of this
|
||||
* set and the passed set.
|
||||
*
|
||||
* @param otherSet The set to union with this set.
|
||||
*/
|
||||
union(otherSet:SortedSet<T>):SortedSet<T>;
|
||||
|
||||
|
||||
/**
|
||||
* Makes a copy of this set
|
||||
*/
|
||||
clone():SortedSet<T>;
|
||||
|
||||
|
||||
/**
|
||||
* Returns a representation of the sorted set ready for serialisation.
|
||||
*/
|
||||
toJSON():any;
|
||||
|
||||
|
||||
/**
|
||||
* Loads a previously serialised sorted set.
|
||||
*
|
||||
* @param serialisedData The serialised set to load.
|
||||
*/
|
||||
static load<T>(serialisedData:T[]):SortedSet<T>;
|
||||
}
|
||||
|
||||
|
||||
interface IIndexField
|
||||
{
|
||||
/**
|
||||
* The name of the field within the document that
|
||||
*/
|
||||
name:string;
|
||||
|
||||
/**
|
||||
* An optional boost that can be applied to terms in this field.
|
||||
*/
|
||||
boost:number;
|
||||
}
|
||||
|
||||
|
||||
interface IIndexSearchResult
|
||||
{
|
||||
ref:any;
|
||||
|
||||
score:number;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* lunr.Index is object that manages a search index. It contains the indexes and stores
|
||||
* all the tokens and document lookups. It also provides the main user facing API for
|
||||
* the library.
|
||||
*/
|
||||
class Index
|
||||
{
|
||||
eventEmitter:EventEmitter;
|
||||
|
||||
documentStore:Store<string>;
|
||||
|
||||
tokenStore:TokenStore;
|
||||
|
||||
corpusTokens:SortedSet<string>;
|
||||
|
||||
pipeline:Pipeline;
|
||||
|
||||
_fields:IIndexField[];
|
||||
|
||||
_ref:string;
|
||||
|
||||
_idfCache:{[key:string]:string};
|
||||
|
||||
|
||||
/**
|
||||
* Bind a handler to events being emitted by the index.
|
||||
*
|
||||
* The handler can be bound to many events at the same time.
|
||||
*
|
||||
* @param eventName The name(s) of events to bind the function to.
|
||||
* @param handler The function to call when an event is fired. Binds a handler
|
||||
* function to a specific event(s).
|
||||
*/
|
||||
on(eventName:string, handler:Function):void;
|
||||
on(eventName:string, eventName2:string, handler:Function):void;
|
||||
on(eventName:string, eventName2:string, eventName3:string, handler:Function):void;
|
||||
on(eventName:string, eventName2:string, eventName3:string, eventName4:string, handler:Function):void;
|
||||
on(eventName:string, eventName2:string, eventName3:string, eventName4:string, eventName5:string, handler:Function):void;
|
||||
|
||||
|
||||
/**
|
||||
* Removes a handler from an event being emitted by the index.
|
||||
*
|
||||
* @param eventName The name of events to remove the function from.
|
||||
* @param handler The serialised set to load.
|
||||
*/
|
||||
off(eventName:string, handler:Function):void;
|
||||
|
||||
|
||||
/**
|
||||
* Adds a field to the list of fields that will be searchable within documents in the index.
|
||||
*
|
||||
* An optional boost param can be passed to affect how much tokens in this field rank in
|
||||
* search results, by default the boost value is 1.
|
||||
*
|
||||
* Fields should be added before any documents are added to the index, fields that are added
|
||||
* after documents are added to the index will only apply to new documents added to the index.
|
||||
*
|
||||
* @param fieldName The name of the field within the document that
|
||||
* @param options An optional boost that can be applied to terms in this field.
|
||||
*/
|
||||
field(fieldName:string, options?:{boost?:number}):Index;
|
||||
|
||||
|
||||
/**
|
||||
* Sets the property used to uniquely identify documents added to the index, by default this
|
||||
* property is 'id'.
|
||||
*
|
||||
* This should only be changed before adding documents to the index, changing the ref property
|
||||
* without resetting the index can lead to unexpected results.
|
||||
*
|
||||
* @refName The property to use to uniquely identify the
|
||||
*/
|
||||
ref(refName:string):Index;
|
||||
|
||||
|
||||
/**
|
||||
* Add a document to the index.
|
||||
*
|
||||
* This is the way new documents enter the index, this function will run the fields from the
|
||||
* document through the index's pipeline and then add it to the index, it will then show up
|
||||
* in search results.
|
||||
*
|
||||
* An 'add' event is emitted with the document that has been added and the index the document
|
||||
* has been added to. This event can be silenced by passing false as the second argument to add.
|
||||
*
|
||||
* @param doc The document to add to the index.
|
||||
* @param emitEvent Whether or not to emit events, default true.
|
||||
*/
|
||||
add(doc:any, emitEvent?:boolean):void;
|
||||
|
||||
|
||||
/**
|
||||
* Removes a document from the index.
|
||||
*
|
||||
* To make sure documents no longer show up in search results they can be removed from the
|
||||
* index using this method.
|
||||
*
|
||||
* The document passed only needs to have the same ref property value as the document that was
|
||||
* added to the index, they could be completely different objects.
|
||||
*
|
||||
* A 'remove' event is emitted with the document that has been removed and the index the
|
||||
* document has been removed from. This event can be silenced by passing false as the second
|
||||
* argument to remove.
|
||||
*
|
||||
* @param doc The document to remove from the index.
|
||||
* @param emitEvent Whether to emit remove events, defaults to true
|
||||
*/
|
||||
remove(doc:any, emitEvent?:boolean):void;
|
||||
|
||||
|
||||
/**
|
||||
* Updates a document in the index.
|
||||
*
|
||||
* When a document contained within the index gets updated, fields changed, added or removed,
|
||||
* to make sure it correctly matched against search queries, it should be updated in the index.
|
||||
*
|
||||
* This method is just a wrapper around [[remove]] and [[add]].
|
||||
*
|
||||
* An 'update' event is emitted with the document that has been updated and the index.
|
||||
* This event can be silenced by passing false as the second argument to update. Only an
|
||||
* update event will be fired, the 'add' and 'remove' events of the underlying calls are
|
||||
* silenced.
|
||||
*
|
||||
* @param doc The document to update in the index.
|
||||
* @param emitEvent Whether to emit update events, defaults to true
|
||||
*/
|
||||
update(doc:any, emitEvent?:boolean):void;
|
||||
|
||||
|
||||
/**
|
||||
* Calculates the inverse document frequency for a token within the index.
|
||||
*
|
||||
* @param token The token to calculate the idf of.
|
||||
*/
|
||||
idf(token:string):string;
|
||||
|
||||
|
||||
/**
|
||||
* Searches the index using the passed query.
|
||||
*
|
||||
* Queries should be a string, multiple words are allowed and will lead to an AND based
|
||||
* query, e.g. idx.search('foo bar') will run a search for documents containing both
|
||||
* 'foo' and 'bar'.
|
||||
*
|
||||
* All query tokens are passed through the same pipeline that document tokens are passed
|
||||
* through, so any language processing involved will be run on every query term.
|
||||
*
|
||||
* Each query term is expanded, so that the term 'he' might be expanded to 'hello'
|
||||
* and 'help' if those terms were already included in the index.
|
||||
*
|
||||
* Matching documents are returned as an array of objects, each object contains the
|
||||
* matching document ref, as set for this index, and the similarity score for this
|
||||
* document against the query.
|
||||
*
|
||||
* @param query The query to search the index with.
|
||||
*/
|
||||
search(query:string):IIndexSearchResult[];
|
||||
|
||||
|
||||
/**
|
||||
* Generates a vector containing all the tokens in the document matching the
|
||||
* passed documentRef.
|
||||
*
|
||||
* The vector contains the tf-idf score for each token contained in the document with
|
||||
* the passed documentRef. The vector will contain an element for every token in the
|
||||
* indexes corpus, if the document does not contain that token the element will be 0.
|
||||
*
|
||||
* @param documentRef The ref to find the document with.
|
||||
*/
|
||||
documentVector(documentRef:string):Vector;
|
||||
|
||||
|
||||
/**
|
||||
* Returns a representation of the index ready for serialisation.
|
||||
*/
|
||||
toJSON():any;
|
||||
|
||||
|
||||
/**
|
||||
* Applies a plugin to the current index.
|
||||
*
|
||||
* A plugin is a function that is called with the index as its context. Plugins can be
|
||||
* used to customise or extend the behaviour the index in some way. A plugin is just a
|
||||
* function, that encapsulated the custom behaviour that should be applied to the index.
|
||||
*
|
||||
* The plugin function will be called with the index as its argument, additional arguments
|
||||
* can also be passed when calling use. The function will be called with the index as
|
||||
* its context.
|
||||
*
|
||||
* Example:
|
||||
*
|
||||
* ```javascript
|
||||
* var myPlugin = function(idx, arg1, arg2) {
|
||||
* // `this` is the index to be extended
|
||||
* // apply any extensions etc here.
|
||||
* };
|
||||
*
|
||||
* var idx = lunr(function() {
|
||||
* this.use(myPlugin, 'arg1', 'arg2');
|
||||
* });
|
||||
* ```
|
||||
*
|
||||
* @param plugin The plugin to apply.
|
||||
* @param args
|
||||
*/
|
||||
use(plugin:Function, ...args:any[]):void;
|
||||
|
||||
|
||||
/**
|
||||
* Loads a previously serialised index.
|
||||
*
|
||||
* Issues a warning if the index being imported was serialised by a different version
|
||||
* of lunr.
|
||||
*
|
||||
* @param serialisedData The serialised set to load.
|
||||
*/
|
||||
static load(serialisedData:any):Index;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* lunr.Store is a simple key-value store used for storing sets of tokens for documents
|
||||
* stored in index.
|
||||
*/
|
||||
class Store<T>
|
||||
{
|
||||
store:{[id:string]:SortedSet<T>};
|
||||
|
||||
length:number;
|
||||
|
||||
|
||||
/**
|
||||
* Stores the given tokens in the store against the given id.
|
||||
*
|
||||
* @param id The key used to store the tokens against.
|
||||
* @param tokens The tokens to store against the key.
|
||||
*/
|
||||
set(id:string, tokens:SortedSet<T>):void;
|
||||
|
||||
|
||||
/**
|
||||
* Retrieves the tokens from the store for a given key.
|
||||
*
|
||||
* @param id The key to lookup and retrieve from the store.
|
||||
*/
|
||||
get(id:string):SortedSet<T>;
|
||||
|
||||
|
||||
/**
|
||||
* Checks whether the store contains a key.
|
||||
*
|
||||
* @param id The id to look up in the store.
|
||||
*/
|
||||
has(id:string):boolean;
|
||||
|
||||
|
||||
/**
|
||||
* Removes the value for a key in the store.
|
||||
*
|
||||
* @param id The id to remove from the store.
|
||||
*/
|
||||
remove(id:string):void;
|
||||
|
||||
|
||||
/**
|
||||
* Returns a representation of the store ready for serialisation.
|
||||
*/
|
||||
toJSON():any;
|
||||
|
||||
|
||||
/**
|
||||
* Loads a previously serialised store.
|
||||
*
|
||||
* @param serialisedData The serialised store to load.
|
||||
*/
|
||||
static load<T>(serialisedData:any):Store<T>;
|
||||
}
|
||||
|
||||
|
||||
interface ITokenDocument
|
||||
{
|
||||
ref:number;
|
||||
|
||||
tf:number;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* lunr.TokenStore is used for efficient storing and lookup of the reverse index of token
|
||||
* to document ref.
|
||||
*/
|
||||
class TokenStore
|
||||
{
|
||||
root:{[token:string]:TokenStore};
|
||||
|
||||
docs:{[ref:string]:ITokenDocument};
|
||||
|
||||
length:number;
|
||||
|
||||
|
||||
/**
|
||||
* Adds a new token doc pair to the store.
|
||||
*
|
||||
* By default this function starts at the root of the current store, however it can
|
||||
* start at any node of any token store if required.
|
||||
*
|
||||
* @param token The token to store the doc under
|
||||
* @param doc The doc to store against the token
|
||||
* @param root An optional node at which to start looking for the
|
||||
*/
|
||||
add(token:string, doc:ITokenDocument, root?:TokenStore):void;
|
||||
|
||||
|
||||
/**
|
||||
* Checks whether this key is contained within this lunr.TokenStore.
|
||||
*
|
||||
* @param token The token to check for
|
||||
*/
|
||||
has(token:string):boolean;
|
||||
|
||||
|
||||
/**
|
||||
* Retrieve a node from the token store for a given token.
|
||||
*
|
||||
* @param token The token to get the node for.
|
||||
*/
|
||||
getNode(token:string):TokenStore;
|
||||
|
||||
|
||||
/**
|
||||
* Retrieve the documents for a node for the given token.
|
||||
*
|
||||
* By default this function starts at the root of the current store, however it can
|
||||
* start at any node of any token store if required.
|
||||
*
|
||||
* @param token The token to get the documents for.
|
||||
* @param root An optional node at which to start.
|
||||
*/
|
||||
get(token:string, root:TokenStore):{[ref:string]:ITokenDocument};
|
||||
|
||||
|
||||
count(token:string, root:TokenStore):number;
|
||||
|
||||
|
||||
/**
|
||||
* Remove the document identified by ref from the token in the store.
|
||||
*
|
||||
* @param token The token to get the documents for.
|
||||
* @param ref The ref of the document to remove from this token.
|
||||
*/
|
||||
remove(token:string, ref:string):void;
|
||||
|
||||
|
||||
/**
|
||||
* Find all the possible suffixes of the passed token using tokens currently in
|
||||
* the store.
|
||||
*
|
||||
* @param token The token to expand.
|
||||
* @param memo
|
||||
*/
|
||||
expand(token:string, memo?:string[]):string[];
|
||||
|
||||
|
||||
/**
|
||||
* Returns a representation of the token store ready for serialisation.
|
||||
*/
|
||||
toJSON():any;
|
||||
|
||||
|
||||
/**
|
||||
* Loads a previously serialised token store.
|
||||
*
|
||||
* @param serialisedData The serialised token store to load.
|
||||
*/
|
||||
static load(serialisedData:any):TokenStore;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Convenience function for instantiating a new lunr index and configuring it with the default
|
||||
* pipeline functions and the passed config function.
|
||||
*
|
||||
* When using this convenience function a new index will be created with the following functions
|
||||
* already in the pipeline:
|
||||
*
|
||||
* * lunr.StopWordFilter - filters out any stop words before they enter the index
|
||||
*
|
||||
* * lunr.stemmer - stems the tokens before entering the index.
|
||||
*
|
||||
* Example:
|
||||
*
|
||||
* ```javascript
|
||||
* var idx = lunr(function () {
|
||||
* this.field('title', 10);
|
||||
* this.field('tags', 100);
|
||||
* this.field('body');
|
||||
*
|
||||
* this.ref('cid');
|
||||
*
|
||||
* this.pipeline.add(function () {
|
||||
* // some custom pipeline function
|
||||
* });
|
||||
* });
|
||||
* ```
|
||||
*/
|
||||
declare function lunr(config:Function):lunr.Index;
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
/// <reference path="jquery/jquery.d.ts" />
|
||||
/// <reference path="underscore/underscore.d.ts" />
|
||||
/// <reference path="backbone/backbone.d.ts" />
|
||||
/// <reference path="lunr/lunr.d.ts" />
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
{
|
||||
"version": "v4",
|
||||
"repo": "borisyankov/DefinitelyTyped",
|
||||
"ref": "master",
|
||||
"path": "./",
|
||||
"bundle": "./tsd.d.ts",
|
||||
"installed": {
|
||||
"jquery/jquery.d.ts": {
|
||||
"commit": "d4b55bafc0c9c4a2338cb427a4eeaf6023f12a24"
|
||||
},
|
||||
"lunr/lunr.d.ts": {
|
||||
"commit": "f64ae50d573dae7500236a3deaee402f3376a871"
|
||||
},
|
||||
"backbone/backbone.d.ts": {
|
||||
"commit": "d4b55bafc0c9c4a2338cb427a4eeaf6023f12a24"
|
||||
},
|
||||
"underscore/underscore.d.ts": {
|
||||
"commit": "d4b55bafc0c9c4a2338cb427a4eeaf6023f12a24"
|
||||
}
|
||||
}
|
||||
}
|
||||
3168
openvidu-browser/config/typedoc/custom-theme/assets/js/src/lib/underscore/underscore.d.ts
vendored
Normal file
3168
openvidu-browser/config/typedoc/custom-theme/assets/js/src/lib/underscore/underscore.d.ts
vendored
Normal file
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,158 @@
|
|||
declare module typedoc
|
||||
{
|
||||
class Events extends Backbone.Events { }
|
||||
}
|
||||
|
||||
module typedoc
|
||||
{
|
||||
export var $html = $('html');
|
||||
|
||||
|
||||
/**
|
||||
* Service definition.
|
||||
*/
|
||||
export interface IService
|
||||
{
|
||||
constructor:any;
|
||||
name:string;
|
||||
instance:any;
|
||||
priority:number;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Component definition.
|
||||
*/
|
||||
export interface IComponent
|
||||
{
|
||||
constructor:any;
|
||||
selector:string;
|
||||
priority:number;
|
||||
namespace:string;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* List of all known services.
|
||||
*/
|
||||
var services:IService[] = [];
|
||||
|
||||
/**
|
||||
* List of all known components.
|
||||
*/
|
||||
var components:IComponent[] = [];
|
||||
|
||||
/**
|
||||
* jQuery instance of the document.
|
||||
*/
|
||||
export var $document = $(document);
|
||||
|
||||
/**
|
||||
* jQuery instance of the window.
|
||||
*/
|
||||
export var $window = $(window);
|
||||
|
||||
/**
|
||||
* jQuery instance of the window.
|
||||
*/
|
||||
export var $body = $('body');
|
||||
|
||||
|
||||
/**
|
||||
* Register a new component.
|
||||
*/
|
||||
export function registerService(constructor:any, name:string, priority:number = 0) {
|
||||
services.push({
|
||||
constructor: constructor,
|
||||
name: name,
|
||||
priority: priority,
|
||||
instance: null
|
||||
});
|
||||
|
||||
services.sort((a:IService, b:IService) => a.priority - b.priority);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Register a new component.
|
||||
*/
|
||||
export function registerComponent(constructor:any, selector:string, priority:number = 0, namespace:string = '*')
|
||||
{
|
||||
components.push({
|
||||
selector: selector,
|
||||
constructor: constructor,
|
||||
priority: priority,
|
||||
namespace: namespace
|
||||
});
|
||||
|
||||
components.sort((a:IComponent, b:IComponent) => a.priority - b.priority);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Copy Backbone.Events to TypeScript class.
|
||||
*/
|
||||
if (typeof Backbone != 'undefined') {
|
||||
typedoc['Events'] = <any>(function() {
|
||||
var res = function() {};
|
||||
_.extend(res.prototype, Backbone.Events);
|
||||
return res;
|
||||
})();
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* TypeDoc application class.
|
||||
*/
|
||||
export class Application extends Events
|
||||
{
|
||||
/**
|
||||
* Create a new Application instance.
|
||||
*/
|
||||
constructor() {
|
||||
super();
|
||||
|
||||
this.createServices();
|
||||
this.createComponents($body);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Create all services.
|
||||
*/
|
||||
private createServices() {
|
||||
_(services).forEach((c) => {
|
||||
c.instance = new c.constructor();
|
||||
typedoc[c.name] = c.instance;
|
||||
});
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Create all components beneath the given jQuery element.
|
||||
*/
|
||||
public createComponents($context:JQuery, namespace:string = 'default'):Backbone.View<any>[] {
|
||||
var result = [];
|
||||
_(components).forEach((c) => {
|
||||
if (c.namespace != namespace && c.namespace != '*') {
|
||||
return;
|
||||
}
|
||||
|
||||
$context.find(c.selector).each((m:number, el:HTMLElement) => {
|
||||
var $el = $(el), instance;
|
||||
if (instance = $el.data('component')) {
|
||||
if (_(result).indexOf(instance) == -1) {
|
||||
result.push(instance);
|
||||
}
|
||||
} else {
|
||||
instance = new c.constructor({el:el});
|
||||
$el.data('component', instance);
|
||||
result.push(instance);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
return result;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,157 @@
|
|||
module typedoc
|
||||
{
|
||||
class FilterItem<T>
|
||||
{
|
||||
protected key:string;
|
||||
|
||||
protected value:T;
|
||||
|
||||
protected defaultValue:T;
|
||||
|
||||
|
||||
constructor(key:string, value:T) {
|
||||
this.key = key;
|
||||
this.value = value;
|
||||
this.defaultValue = value;
|
||||
|
||||
this.initialize();
|
||||
|
||||
if (window.localStorage[this.key]) {
|
||||
this.setValue(this.fromLocalStorage(window.localStorage[this.key]));
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
protected initialize() {}
|
||||
|
||||
|
||||
protected handleValueChange(oldValue:T, newValue:T) {}
|
||||
|
||||
|
||||
protected fromLocalStorage(value:string):T {
|
||||
return <any>value;
|
||||
}
|
||||
|
||||
|
||||
protected toLocalStorage(value:T):string {
|
||||
return <any>value;
|
||||
}
|
||||
|
||||
|
||||
protected setValue(value:T) {
|
||||
if (this.value == value) return;
|
||||
|
||||
var oldValue = this.value;
|
||||
this.value = value;
|
||||
window.localStorage[this.key] = this.toLocalStorage(value);
|
||||
|
||||
this.handleValueChange(oldValue, value);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
class FilterItemCheckbox extends FilterItem<boolean>
|
||||
{
|
||||
private $checkbox:JQuery;
|
||||
|
||||
|
||||
protected initialize() {
|
||||
this.$checkbox = $('#tsd-filter-' + this.key);
|
||||
this.$checkbox.on('change', () => {
|
||||
this.setValue(this.$checkbox.prop('checked'));
|
||||
});
|
||||
}
|
||||
|
||||
|
||||
protected handleValueChange(oldValue:boolean, newValue:boolean) {
|
||||
this.$checkbox.prop('checked', this.value);
|
||||
$html.toggleClass('toggle-' + this.key, this.value != this.defaultValue);
|
||||
}
|
||||
|
||||
|
||||
protected fromLocalStorage(value:string):boolean {
|
||||
return value == 'true';
|
||||
}
|
||||
|
||||
|
||||
protected toLocalStorage(value:boolean):string {
|
||||
return value ? 'true' : 'false';
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
class FilterItemSelect extends FilterItem<string>
|
||||
{
|
||||
private $select:JQuery;
|
||||
|
||||
|
||||
protected initialize() {
|
||||
$html.addClass('toggle-' + this.key + this.value);
|
||||
|
||||
this.$select = $('#tsd-filter-' + this.key);
|
||||
this.$select.on(pointerDown + ' mouseover', () => {
|
||||
this.$select.addClass('active');
|
||||
}).on('mouseleave', () => {
|
||||
this.$select.removeClass('active');
|
||||
}).on(pointerUp, 'li', (e:JQueryMouseEventObject) => {
|
||||
this.$select.removeClass('active');
|
||||
this.setValue($(e.target).attr('data-value'));
|
||||
});
|
||||
|
||||
$document.on(pointerDown, (e:JQueryMouseEventObject) => {
|
||||
var $path = $(e.target).parents().addBack();
|
||||
if ($path.is(this.$select)) return;
|
||||
|
||||
this.$select.removeClass('active');
|
||||
});
|
||||
}
|
||||
|
||||
|
||||
protected handleValueChange(oldValue:string, newValue:string) {
|
||||
this.$select.find('li.selected').removeClass('selected');
|
||||
this.$select.find('.tsd-select-label').text(
|
||||
this.$select.find('li[data-value="' + newValue + '"]').addClass('selected').text());
|
||||
|
||||
$html.removeClass('toggle-' + oldValue);
|
||||
$html.addClass('toggle-' + newValue);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
class Filter extends Backbone.View<any>
|
||||
{
|
||||
private optionVisibility:FilterItemSelect;
|
||||
|
||||
private optionInherited:FilterItemCheckbox;
|
||||
|
||||
private optionOnlyExported:FilterItemCheckbox;
|
||||
|
||||
private optionExternals:FilterItemCheckbox;
|
||||
|
||||
|
||||
constructor(options?:Backbone.ViewOptions<any>) {
|
||||
super(options);
|
||||
|
||||
this.optionVisibility = new FilterItemSelect('visibility', 'private');
|
||||
this.optionInherited = new FilterItemCheckbox('inherited', true);
|
||||
this.optionExternals = new FilterItemCheckbox('externals', true);
|
||||
this.optionOnlyExported = new FilterItemCheckbox('only-exported', false);
|
||||
}
|
||||
|
||||
|
||||
static isSupported():boolean {
|
||||
try {
|
||||
return typeof window.localStorage != 'undefined';
|
||||
} catch (e) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
if (Filter.isSupported()) {
|
||||
registerComponent(Filter, '#tsd-filter');
|
||||
} else {
|
||||
$html.addClass('no-filter');
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,141 @@
|
|||
module typedoc
|
||||
{
|
||||
/**
|
||||
* Stored element and position data of a single anchor.
|
||||
*/
|
||||
interface IAnchorInfo
|
||||
{
|
||||
/**
|
||||
* jQuery instance of the anchor tag.
|
||||
*/
|
||||
$anchor?:JQuery;
|
||||
|
||||
/**
|
||||
* jQuery instance of the link in the navigation representing this anchor.
|
||||
*/
|
||||
$link?:JQuery;
|
||||
|
||||
/**
|
||||
* The vertical offset of the anchor on the page.
|
||||
*/
|
||||
position:number;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Manages the sticky state of the navigation and moves the highlight
|
||||
* to the current navigation item.
|
||||
*/
|
||||
export class MenuHighlight extends Backbone.View<any>
|
||||
{
|
||||
/**
|
||||
* List of all discovered anchors.
|
||||
*/
|
||||
private anchors:IAnchorInfo[];
|
||||
|
||||
/**
|
||||
* Index of the currently highlighted anchor.
|
||||
*/
|
||||
private index:number = 0;
|
||||
|
||||
|
||||
/**
|
||||
* Create a new MenuHighlight instance.
|
||||
*
|
||||
* @param options Backbone view constructor options.
|
||||
*/
|
||||
constructor(options:Backbone.ViewOptions<any>) {
|
||||
super(options);
|
||||
|
||||
this.listenTo(viewport, 'resize', this.onResize);
|
||||
this.listenTo(viewport, 'scroll', this.onScroll);
|
||||
|
||||
this.createAnchors();
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Find all anchors on the current page.
|
||||
*/
|
||||
private createAnchors() {
|
||||
this.index = 0;
|
||||
this.anchors = [{
|
||||
position: 0
|
||||
}];
|
||||
|
||||
var base = window.location.href;
|
||||
if (base.indexOf('#') != -1) {
|
||||
base = base.substr(0, base.indexOf('#'));
|
||||
}
|
||||
|
||||
this.$el.find('a').each((index, el:HTMLAnchorElement) => {
|
||||
var href = el.href;
|
||||
if (href.indexOf('#') == -1) return;
|
||||
if (href.substr(0, base.length) != base) return;
|
||||
|
||||
var hash = href.substr(href.indexOf('#') + 1);
|
||||
var $anchor = $('a.tsd-anchor[name=' + hash + ']');
|
||||
if ($anchor.length == 0) return;
|
||||
|
||||
this.anchors.push({
|
||||
$link: $(el.parentNode),
|
||||
$anchor: $anchor,
|
||||
position: 0
|
||||
});
|
||||
});
|
||||
|
||||
this.onResize();
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Triggered after the viewport was resized.
|
||||
*/
|
||||
private onResize() {
|
||||
var anchor;
|
||||
for (var index = 1, count = this.anchors.length; index < count; index++) {
|
||||
anchor = this.anchors[index];
|
||||
anchor.position = anchor.$anchor.offset().top;
|
||||
}
|
||||
|
||||
this.anchors.sort((a, b) => {
|
||||
return a.position - b.position;
|
||||
});
|
||||
|
||||
this.onScroll(viewport.scrollTop);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Triggered after the viewport was scrolled.
|
||||
*
|
||||
* @param scrollTop The current vertical scroll position.
|
||||
*/
|
||||
private onScroll(scrollTop:number) {
|
||||
var anchors = this.anchors;
|
||||
var index = this.index;
|
||||
var count = anchors.length - 1;
|
||||
|
||||
scrollTop += 5;
|
||||
while (index > 0 && anchors[index].position > scrollTop) {
|
||||
index -= 1;
|
||||
}
|
||||
|
||||
while (index < count && anchors[index + 1].position < scrollTop) {
|
||||
index += 1;
|
||||
}
|
||||
|
||||
if (this.index != index) {
|
||||
if (this.index > 0) this.anchors[this.index].$link.removeClass('focus');
|
||||
this.index = index;
|
||||
if (this.index > 0) this.anchors[this.index].$link.addClass('focus');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Register this component.
|
||||
*/
|
||||
registerComponent(MenuHighlight, '.menu-highlight');
|
||||
}
|
||||
|
|
@ -0,0 +1,182 @@
|
|||
module typedoc
|
||||
{
|
||||
var hasPositionSticky = $html.hasClass('csspositionsticky');
|
||||
|
||||
/**
|
||||
* Defines the known ways to make the navigation sticky.
|
||||
*/
|
||||
enum StickyMode
|
||||
{
|
||||
/**
|
||||
* The navigation is not sticky at all.
|
||||
*/
|
||||
None,
|
||||
|
||||
/**
|
||||
* The entire secondary navigation will stick to the top.
|
||||
*/
|
||||
Secondary,
|
||||
|
||||
/**
|
||||
* Only the current root navigation item will stick to the top.
|
||||
*/
|
||||
Current
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Controls the sticky behaviour of the secondary menu.
|
||||
*/
|
||||
export class MenuSticky extends Backbone.View<any>
|
||||
{
|
||||
/**
|
||||
* jQuery instance of the current navigation item.
|
||||
*/
|
||||
private $current:JQuery;
|
||||
|
||||
/**
|
||||
* jQuery instance of the parent representing the entire navigation.
|
||||
*/
|
||||
private $navigation:JQuery;
|
||||
|
||||
/**
|
||||
* jQuery instance of the parent representing entire sticky container.
|
||||
*/
|
||||
private $container:JQuery;
|
||||
|
||||
/**
|
||||
* The current state of the menu.
|
||||
*/
|
||||
private state:string = '';
|
||||
|
||||
/**
|
||||
* The current mode for determining the sticky position.
|
||||
*/
|
||||
private stickyMode:StickyMode = StickyMode.None;
|
||||
|
||||
/**
|
||||
* The threshold at which the menu is attached to the top.
|
||||
*/
|
||||
private stickyTop:number;
|
||||
|
||||
/**
|
||||
* The threshold at which the menu is attached to the bottom.
|
||||
*/
|
||||
private stickyBottom:number;
|
||||
|
||||
|
||||
/**
|
||||
* Create a new MenuSticky instance.
|
||||
*
|
||||
* @param options Backbone view constructor options.
|
||||
*/
|
||||
constructor(options:Backbone.ViewOptions<any>) {
|
||||
super(options);
|
||||
|
||||
this.$current = this.$el.find('> ul.current');
|
||||
this.$navigation = this.$el.parents('.menu-sticky-wrap');
|
||||
this.$container = this.$el.parents('.row');
|
||||
|
||||
this.listenTo(viewport, 'resize', this.onResize);
|
||||
if (!hasPositionSticky) {
|
||||
this.listenTo(viewport, 'scroll', this.onScroll);
|
||||
}
|
||||
|
||||
this.onResize(viewport.width, viewport.height);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Set the current sticky state.
|
||||
*
|
||||
* @param state The new sticky state.
|
||||
*/
|
||||
private setState(state:string) {
|
||||
if (this.state == state) return;
|
||||
|
||||
if (this.state != '') this.$navigation.removeClass(this.state);
|
||||
this.state = state;
|
||||
if (this.state != '') this.$navigation.addClass(this.state);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Triggered after the viewport was resized.
|
||||
*
|
||||
* @param width The width of the viewport.
|
||||
* @param height The height of the viewport.
|
||||
*/
|
||||
private onResize(width:number, height:number) {
|
||||
this.stickyMode = StickyMode.None;
|
||||
this.setState('');
|
||||
|
||||
var containerTop = this.$container.offset().top;
|
||||
var containerHeight = this.$container.height();
|
||||
var bottom = containerTop + containerHeight;
|
||||
if (this.$navigation.height() < containerHeight) {
|
||||
var elHeight = this.$el.height();
|
||||
var elTop = this.$el.offset().top;
|
||||
|
||||
if (this.$current.length) {
|
||||
var currentHeight = this.$current.height();
|
||||
var currentTop = this.$current.offset().top;
|
||||
|
||||
this.$navigation.css('top', containerTop - currentTop + 20);
|
||||
if (currentHeight < height) {
|
||||
this.stickyMode = StickyMode.Current;
|
||||
this.stickyTop = currentTop;
|
||||
this.stickyBottom = bottom - elHeight + (currentTop - elTop) - 20;
|
||||
}
|
||||
}
|
||||
|
||||
if (elHeight < height) {
|
||||
this.$navigation.css('top', containerTop - elTop + 20);
|
||||
this.stickyMode = StickyMode.Secondary;
|
||||
this.stickyTop = elTop;
|
||||
this.stickyBottom = bottom - elHeight - 20;
|
||||
}
|
||||
}
|
||||
|
||||
if (!hasPositionSticky) {
|
||||
this.$navigation.css('left', this.$navigation.offset().left);
|
||||
this.onScroll(viewport.scrollTop);
|
||||
} else {
|
||||
if (this.stickyMode == StickyMode.Current) {
|
||||
this.setState('sticky-current');
|
||||
} else if (this.stickyMode == StickyMode.Secondary) {
|
||||
this.setState('sticky');
|
||||
} else {
|
||||
this.setState('');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Triggered after the viewport was scrolled.
|
||||
*
|
||||
* @param scrollTop The current vertical scroll position.
|
||||
*/
|
||||
private onScroll(scrollTop:number) {
|
||||
if (this.stickyMode == StickyMode.Current) {
|
||||
if (scrollTop > this.stickyBottom) {
|
||||
this.setState('sticky-bottom');
|
||||
} else {
|
||||
this.setState(scrollTop + 20 > this.stickyTop ? 'sticky-current' : '');
|
||||
}
|
||||
} else if (this.stickyMode == StickyMode.Secondary) {
|
||||
if (scrollTop > this.stickyBottom) {
|
||||
this.setState('sticky-bottom');
|
||||
} else {
|
||||
this.setState(scrollTop + 20 > this.stickyTop ? 'sticky' : '');
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Register this component.
|
||||
*/
|
||||
registerComponent(MenuSticky, '.menu-sticky');
|
||||
}
|
||||
|
|
@ -0,0 +1,268 @@
|
|||
declare module typedoc.search
|
||||
{
|
||||
interface IDocument {
|
||||
id:number;
|
||||
kind:number;
|
||||
name:string;
|
||||
url:string;
|
||||
classes:string;
|
||||
parent?:string;
|
||||
}
|
||||
|
||||
interface IData {
|
||||
kinds:{[kind:number]:string};
|
||||
rows:IDocument[];
|
||||
}
|
||||
|
||||
var data:IData;
|
||||
}
|
||||
|
||||
|
||||
module typedoc.search
|
||||
{
|
||||
/**
|
||||
* Loading state definitions.
|
||||
*/
|
||||
enum SearchLoadingState
|
||||
{
|
||||
Idle, Loading, Ready, Failure
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* The element holding the search widget and results.
|
||||
*/
|
||||
var $el:JQuery = $('#tsd-search');
|
||||
|
||||
/**
|
||||
* The input field of the search widget.
|
||||
*/
|
||||
var $field:JQuery = $('#tsd-search-field');
|
||||
|
||||
/**
|
||||
* The result list wrapper.
|
||||
*/
|
||||
var $results:JQuery = $('.results');
|
||||
|
||||
/**
|
||||
* The base url that must be prepended to the indexed urls.
|
||||
*/
|
||||
var base:string = $el.attr('data-base') + '/';
|
||||
|
||||
/**
|
||||
* The current query string.
|
||||
*/
|
||||
var query:string = '';
|
||||
|
||||
/**
|
||||
* The state the search is currently in.
|
||||
*/
|
||||
var loadingState:SearchLoadingState = SearchLoadingState.Idle;
|
||||
|
||||
/**
|
||||
* Is the input field focused?
|
||||
*/
|
||||
var hasFocus:boolean = false;
|
||||
|
||||
/**
|
||||
* Should the next key press be prevents?
|
||||
*/
|
||||
var preventPress:boolean = false;
|
||||
|
||||
/**
|
||||
* The lunr index used to search the documentation.
|
||||
*/
|
||||
var index:lunr.Index;
|
||||
|
||||
|
||||
/**
|
||||
* Instantiate the lunr index.
|
||||
*/
|
||||
function createIndex() {
|
||||
index = new lunr.Index();
|
||||
index.pipeline.add(
|
||||
lunr.trimmer
|
||||
);
|
||||
|
||||
index.field('name', {boost:10});
|
||||
index.field('parent');
|
||||
index.ref('id');
|
||||
|
||||
var rows = data.rows;
|
||||
var pos = 0;
|
||||
var length = rows.length;
|
||||
function batch() {
|
||||
var cycles = 0;
|
||||
while (cycles++ < 100) {
|
||||
index.add(rows[pos]);
|
||||
if (++pos == length) {
|
||||
return setLoadingState(SearchLoadingState.Ready);
|
||||
}
|
||||
}
|
||||
setTimeout(batch, 10);
|
||||
}
|
||||
|
||||
batch();
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Lazy load the search index and parse it.
|
||||
*/
|
||||
function loadIndex() {
|
||||
if (loadingState != SearchLoadingState.Idle) return;
|
||||
setTimeout(() => {
|
||||
if (loadingState == SearchLoadingState.Idle) {
|
||||
setLoadingState(SearchLoadingState.Loading);
|
||||
}
|
||||
}, 500);
|
||||
|
||||
if (typeof data != 'undefined') {
|
||||
createIndex();
|
||||
} else {
|
||||
$.get($el.attr('data-index'))
|
||||
.done((source:string) => {
|
||||
eval(source);
|
||||
createIndex();
|
||||
}).fail(() => {
|
||||
setLoadingState(SearchLoadingState.Failure);
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Update the visible state of the search control.
|
||||
*/
|
||||
function updateResults() {
|
||||
if (loadingState != SearchLoadingState.Ready) return;
|
||||
$results.empty();
|
||||
|
||||
var res = index.search(query);
|
||||
for (var i = 0, c = Math.min(10, res.length); i < c; i++) {
|
||||
var row = data.rows[res[i].ref];
|
||||
var name = row.name;
|
||||
if (row.parent) name = '<span class="parent">' + row.parent + '.</span>' + name;
|
||||
$results.append('<li class="' + row.classes + '"><a href="' + base + row.url + '" class="tsd-kind-icon">' + name + '</li>');
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Set the loading state and update the visual state accordingly.
|
||||
*/
|
||||
function setLoadingState(value:SearchLoadingState) {
|
||||
if (loadingState == value) return;
|
||||
|
||||
$el.removeClass(SearchLoadingState[loadingState].toLowerCase());
|
||||
loadingState = value;
|
||||
$el.addClass(SearchLoadingState[loadingState].toLowerCase());
|
||||
|
||||
if (value == SearchLoadingState.Ready) {
|
||||
updateResults();
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Set the focus state and update the visual state accordingly.
|
||||
*/
|
||||
function setHasFocus(value:boolean) {
|
||||
if (hasFocus == value) return;
|
||||
hasFocus = value;
|
||||
$el.toggleClass('has-focus');
|
||||
|
||||
if (!value) {
|
||||
$field.val(query);
|
||||
} else {
|
||||
setQuery('');
|
||||
$field.val('');
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Set the query string and update the results.
|
||||
*/
|
||||
function setQuery(value:string) {
|
||||
query = $.trim(value);
|
||||
updateResults();
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Move the highlight within the result set.
|
||||
*/
|
||||
function setCurrentResult(dir:number) {
|
||||
var $current = $results.find('.current');
|
||||
if ($current.length == 0) {
|
||||
$results.find(dir == 1 ? 'li:first-child' : 'li:last-child').addClass('current');
|
||||
} else {
|
||||
var $rel = dir == 1 ? $current.next('li') : $current.prev('li');
|
||||
if ($rel.length > 0) {
|
||||
$current.removeClass('current');
|
||||
$rel.addClass('current');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Navigate to the highlighted result.
|
||||
*/
|
||||
function gotoCurrentResult() {
|
||||
var $current = $results.find('.current');
|
||||
|
||||
if ($current.length == 0) {
|
||||
$current = $results.find('li:first-child');
|
||||
}
|
||||
|
||||
if ($current.length > 0) {
|
||||
window.location.href = $current.find('a').prop('href');
|
||||
$field.blur();
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Bind all required events on the input field.
|
||||
*/
|
||||
$field.on('focusin', () => {
|
||||
setHasFocus(true);
|
||||
loadIndex();
|
||||
}).on('focusout', () => {
|
||||
setTimeout(() => setHasFocus(false), 100);
|
||||
}).on('input', () => {
|
||||
setQuery($.trim($field.val()));
|
||||
}).on('keydown', (e:JQueryKeyEventObject) => {
|
||||
if (e.keyCode == 13 || e.keyCode == 27 || e.keyCode == 38 || e.keyCode == 40) {
|
||||
preventPress = true;
|
||||
e.preventDefault();
|
||||
|
||||
if (e.keyCode == 13) {
|
||||
gotoCurrentResult();
|
||||
} else if (e.keyCode == 27) {
|
||||
$field.blur();
|
||||
} else if (e.keyCode == 38) {
|
||||
setCurrentResult(-1);
|
||||
} else if (e.keyCode == 40) {
|
||||
setCurrentResult(1);
|
||||
}
|
||||
} else {
|
||||
preventPress = false;
|
||||
}
|
||||
}).on('keypress', (e) => {
|
||||
if (preventPress) e.preventDefault();
|
||||
});
|
||||
|
||||
|
||||
/**
|
||||
* Start searching by pressing a key on the body.
|
||||
*/
|
||||
$('body').on('keydown', (e:JQueryKeyEventObject) => {
|
||||
if (e.altKey || e.ctrlKey || e.metaKey) return;
|
||||
if (!hasFocus && e.keyCode > 47 && e.keyCode < 112) {
|
||||
$field.focus();
|
||||
}
|
||||
});
|
||||
}
|
||||
|
|
@ -0,0 +1,167 @@
|
|||
module typedoc
|
||||
{
|
||||
/**
|
||||
* Holds a signature and its description.
|
||||
*/
|
||||
class SignatureGroup
|
||||
{
|
||||
/**
|
||||
* The target signature.
|
||||
*/
|
||||
$signature:JQuery;
|
||||
|
||||
/**
|
||||
* The description for the signature.
|
||||
*/
|
||||
$description:JQuery;
|
||||
|
||||
|
||||
/**
|
||||
* Create a new SignatureGroup instance.
|
||||
*
|
||||
* @param $signature The target signature.
|
||||
* @param $description The description for the signature.
|
||||
*/
|
||||
constructor($signature, $description) {
|
||||
this.$signature = $signature;
|
||||
this.$description = $description;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Add the given class to all elements of the group.
|
||||
*
|
||||
* @param className The class name to add.
|
||||
*/
|
||||
addClass(className:string):SignatureGroup {
|
||||
this.$signature.addClass(className);
|
||||
this.$description.addClass(className);
|
||||
return this;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Remove the given class from all elements of the group.
|
||||
*
|
||||
* @param className The class name to remove.
|
||||
*/
|
||||
removeClass(className:string):SignatureGroup {
|
||||
this.$signature.removeClass(className);
|
||||
this.$description.removeClass(className);
|
||||
return this;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Controls the tab like behaviour of methods and functions with multiple signatures.
|
||||
*/
|
||||
class Signature extends Backbone.View<any>
|
||||
{
|
||||
/**
|
||||
* List of found signature groups.
|
||||
*/
|
||||
private groups:SignatureGroup[];
|
||||
|
||||
/**
|
||||
* The container holding all the descriptions.
|
||||
*/
|
||||
private $container:JQuery;
|
||||
|
||||
/**
|
||||
* The index of the currently displayed signature.
|
||||
*/
|
||||
private index:number = -1;
|
||||
|
||||
|
||||
/**
|
||||
* Create a new Signature instance.
|
||||
*
|
||||
* @param options Backbone view constructor options.
|
||||
*/
|
||||
constructor(options:Backbone.ViewOptions<any>) {
|
||||
super(options);
|
||||
|
||||
this.createGroups();
|
||||
|
||||
if (this.groups) {
|
||||
this.$el.addClass('active')
|
||||
.on('touchstart', '.tsd-signature', (event) => this.onClick(event))
|
||||
.on('click', '.tsd-signature', (event) => this.onClick(event));
|
||||
this.$container.addClass('active');
|
||||
this.setIndex(0);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Set the index of the active signature.
|
||||
*
|
||||
* @param index The index of the signature to activate.
|
||||
*/
|
||||
private setIndex(index:number) {
|
||||
if (index < 0) index = 0;
|
||||
if (index > this.groups.length - 1) index = this.groups.length - 1;
|
||||
if (this.index == index) return;
|
||||
|
||||
var to = this.groups[index];
|
||||
if (this.index > -1) {
|
||||
var from = this.groups[this.index];
|
||||
|
||||
animateHeight(this.$container, () => {
|
||||
from.removeClass('current').addClass('fade-out');
|
||||
to.addClass('current fade-in');
|
||||
viewport.triggerResize();
|
||||
});
|
||||
|
||||
setTimeout(() => {
|
||||
from.removeClass('fade-out');
|
||||
to.removeClass('fade-in');
|
||||
}, 300);
|
||||
} else {
|
||||
to.addClass('current');
|
||||
viewport.triggerResize();
|
||||
}
|
||||
|
||||
this.index = index;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Find all signature/description groups.
|
||||
*/
|
||||
private createGroups() {
|
||||
var $signatures = this.$el.find('> .tsd-signature');
|
||||
if ($signatures.length < 2) return;
|
||||
|
||||
this.$container = this.$el.siblings('.tsd-descriptions');
|
||||
var $descriptions = this.$container.find('> .tsd-description');
|
||||
|
||||
this.groups = [];
|
||||
$signatures.each((index, el) => {
|
||||
this.groups.push(new SignatureGroup($(el), $descriptions.eq(index)));
|
||||
});
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Triggered when the user clicks onto a signature header.
|
||||
*
|
||||
* @param e The related jQuery event object.
|
||||
*/
|
||||
private onClick(e:JQueryMouseEventObject) {
|
||||
e.preventDefault();
|
||||
_(this.groups).forEach((group, index) => {
|
||||
if (group.$signature.is(e.currentTarget)) {
|
||||
this.setIndex(index);
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Register this component.
|
||||
*/
|
||||
registerComponent(Signature, '.tsd-signatures');
|
||||
}
|
||||
|
|
@ -0,0 +1,84 @@
|
|||
module typedoc
|
||||
{
|
||||
/**
|
||||
* Enabled simple toggle buttons.
|
||||
*/
|
||||
class Toggle extends Backbone.View<any>
|
||||
{
|
||||
active:boolean;
|
||||
|
||||
className:string;
|
||||
|
||||
|
||||
constructor(options:Backbone.ViewOptions<any>) {
|
||||
super(options);
|
||||
|
||||
this.className = this.$el.attr('data-toggle');
|
||||
this.$el.on(pointerUp, (e) => this.onPointerUp(e));
|
||||
this.$el.on('click', (e) => e.preventDefault());
|
||||
$document.on(pointerDown, (e) => this.onDocumentPointerDown(e));
|
||||
$document.on(pointerUp, (e) => this.onDocumentPointerUp(e));
|
||||
}
|
||||
|
||||
|
||||
setActive(value:boolean) {
|
||||
if (this.active == value) return;
|
||||
this.active = value;
|
||||
|
||||
$html.toggleClass('has-' + this.className, value);
|
||||
this.$el.toggleClass('active', value);
|
||||
|
||||
var transition = (this.active ? 'to-has-' : 'from-has-') + this.className;
|
||||
$html.addClass(transition);
|
||||
setTimeout(() => $html.removeClass(transition), 500);
|
||||
}
|
||||
|
||||
|
||||
onPointerUp(event:JQueryMouseEventObject) {
|
||||
if (hasPointerMoved) return;
|
||||
this.setActive(true);
|
||||
event.preventDefault();
|
||||
}
|
||||
|
||||
|
||||
onDocumentPointerDown(e:JQueryMouseEventObject) {
|
||||
if (this.active) {
|
||||
var $path = $(e.target).parents().addBack();
|
||||
if ($path.hasClass('col-menu')) {
|
||||
return;
|
||||
}
|
||||
|
||||
if ($path.hasClass('tsd-filter-group')) {
|
||||
return;
|
||||
}
|
||||
|
||||
this.setActive(false);
|
||||
}
|
||||
}
|
||||
|
||||
onDocumentPointerUp(e:JQueryMouseEventObject) {
|
||||
if (hasPointerMoved) return;
|
||||
if (this.active) {
|
||||
var $path = $(e.target).parents().addBack();
|
||||
if ($path.hasClass('col-menu')) {
|
||||
var $link = $path.filter('a');
|
||||
if ($link.length) {
|
||||
var href = window.location.href;
|
||||
if (href.indexOf('#') != -1) {
|
||||
href = href.substr(0, href.indexOf('#'));
|
||||
}
|
||||
if ($link.prop('href').substr(0, href.length) == href) {
|
||||
setTimeout(() => this.setActive(false), 250);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Register this component.
|
||||
*/
|
||||
registerComponent(Toggle, 'a[data-toggle]');
|
||||
}
|
||||
|
|
@ -0,0 +1,70 @@
|
|||
module typedoc
|
||||
{
|
||||
/**
|
||||
* A global service that monitors the window size and scroll position.
|
||||
*/
|
||||
export class Viewport extends Events
|
||||
{
|
||||
/**
|
||||
* The current scroll position.
|
||||
*/
|
||||
scrollTop:number = 0;
|
||||
|
||||
/**
|
||||
* The width of the window.
|
||||
*/
|
||||
width:number = 0;
|
||||
|
||||
/**
|
||||
* The height of the window.
|
||||
*/
|
||||
height:number = 0;
|
||||
|
||||
|
||||
/**
|
||||
* Create new Viewport instance.
|
||||
*/
|
||||
constructor() {
|
||||
super();
|
||||
$window.on('scroll', <any>_(() => this.onScroll()).throttle(10));
|
||||
$window.on('resize', <any>_(() => this.onResize()).throttle(10));
|
||||
|
||||
this.onResize();
|
||||
this.onScroll();
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Trigger a resize event.
|
||||
*/
|
||||
triggerResize() {
|
||||
this.trigger('resize', this.width, this.height);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Triggered when the size of the window has changed.
|
||||
*/
|
||||
onResize() {
|
||||
this.width = $window.width();
|
||||
this.height = $window.height();
|
||||
this.trigger('resize', this.width, this.height);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Triggered when the user scrolled the viewport.
|
||||
*/
|
||||
onScroll() {
|
||||
this.scrollTop = $window.scrollTop();
|
||||
this.trigger('scroll', this.scrollTop);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Register service.
|
||||
*/
|
||||
export var viewport:Viewport;
|
||||
registerService(Viewport, 'viewport');
|
||||
}
|
||||
|
|
@ -0,0 +1,88 @@
|
|||
module typedoc
|
||||
{
|
||||
/**
|
||||
* Simple point interface.
|
||||
*/
|
||||
export interface Point {
|
||||
x:number;
|
||||
y:number;
|
||||
}
|
||||
|
||||
/**
|
||||
* Event name of the pointer down event.
|
||||
*/
|
||||
export var pointerDown:string = 'mousedown';
|
||||
|
||||
/**
|
||||
* Event name of the pointer move event.
|
||||
*/
|
||||
export var pointerMove:string = 'mousemove';
|
||||
|
||||
/**
|
||||
* Event name of the pointer up event.
|
||||
*/
|
||||
export var pointerUp:string = 'mouseup';
|
||||
|
||||
/**
|
||||
* Position the pointer was pressed at.
|
||||
*/
|
||||
export var pointerDownPosition:Point = {x:0, y:0};
|
||||
|
||||
/**
|
||||
* Should the next click on the document be supressed?
|
||||
*/
|
||||
export var preventNextClick:boolean = false;
|
||||
|
||||
/**
|
||||
* Is the pointer down?
|
||||
*/
|
||||
export var isPointerDown:boolean = false;
|
||||
|
||||
/**
|
||||
* Is the pointer a touch point?
|
||||
*/
|
||||
export var isPointerTouch:boolean = false;
|
||||
|
||||
/**
|
||||
* Did the pointer move since the last down event?
|
||||
*/
|
||||
export var hasPointerMoved:boolean = false;
|
||||
|
||||
/**
|
||||
* Is the user agent a mobile agent?
|
||||
*/
|
||||
export var isMobile:boolean = /Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);
|
||||
$html.addClass(isMobile ? 'is-mobile' : 'not-mobile');
|
||||
|
||||
|
||||
if (isMobile && 'ontouchstart' in document.documentElement) {
|
||||
isPointerTouch = true;
|
||||
pointerDown = 'touchstart';
|
||||
pointerMove = 'touchmove';
|
||||
pointerUp = 'touchend';
|
||||
}
|
||||
|
||||
$document.on(pointerDown, (e:JQueryMouseEventObject) => {
|
||||
isPointerDown = true;
|
||||
hasPointerMoved = false;
|
||||
var t = (pointerDown == 'touchstart' ? e.originalEvent['targetTouches'][0] : e);
|
||||
pointerDownPosition.x = t.pageX;
|
||||
pointerDownPosition.y = t.pageY;
|
||||
}).on(pointerMove, (e:JQueryMouseEventObject) => {
|
||||
if (!isPointerDown) return;
|
||||
if (!hasPointerMoved) {
|
||||
var t = (pointerDown == 'touchstart' ? e.originalEvent['targetTouches'][0] : e);
|
||||
var x = pointerDownPosition.x - t.pageX;
|
||||
var y = pointerDownPosition.y - t.pageY;
|
||||
hasPointerMoved = (Math.sqrt(x*x + y*y) > 10);
|
||||
}
|
||||
}).on(pointerUp, (e:JQueryMouseEventObject) => {
|
||||
isPointerDown = false;
|
||||
}).on('click', (e:JQueryMouseEventObject) => {
|
||||
if (preventNextClick) {
|
||||
e.preventDefault();
|
||||
e.stopImmediatePropagation();
|
||||
preventNextClick = false;
|
||||
}
|
||||
});
|
||||
}
|
||||
|
|
@ -0,0 +1,53 @@
|
|||
module typedoc {
|
||||
function getVendorInfo(tuples) {
|
||||
for (var name in tuples) {
|
||||
if (!tuples.hasOwnProperty(name))
|
||||
continue;
|
||||
if (typeof (document.body.style[name]) !== 'undefined') {
|
||||
return { name: name, endEvent: tuples[name] };
|
||||
}
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
|
||||
export var transition = getVendorInfo({
|
||||
'transition': 'transitionend',
|
||||
'OTransition': 'oTransitionEnd',
|
||||
'msTransition': 'msTransitionEnd',
|
||||
'MozTransition': 'transitionend',
|
||||
'WebkitTransition': 'webkitTransitionEnd'
|
||||
});
|
||||
|
||||
|
||||
export function noTransition($el, callback) {
|
||||
$el.addClass('no-transition');
|
||||
callback();
|
||||
$el.offset();
|
||||
$el.removeClass('no-transition');
|
||||
}
|
||||
|
||||
|
||||
export function animateHeight($el:JQuery, callback:Function, success?:Function) {
|
||||
var from = $el.height(), to;
|
||||
noTransition($el, function () {
|
||||
callback();
|
||||
|
||||
$el.css('height', '');
|
||||
to = $el.height();
|
||||
if (from != to && transition) $el.css('height', from);
|
||||
});
|
||||
|
||||
if (from != to && transition) {
|
||||
$el.css('height', to);
|
||||
$el.on(transition.endEvent, function () {
|
||||
noTransition($el, function () {
|
||||
$el.off(transition.endEvent).css('height', '');
|
||||
if (success) success();
|
||||
});
|
||||
});
|
||||
} else {
|
||||
if (success) success();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
/// <reference path="./typedoc/Application.ts" />
|
||||
|
||||
module typedoc
|
||||
{
|
||||
export var app:Application = new Application();
|
||||
}
|
||||
|
|
@ -0,0 +1,139 @@
|
|||
module.exports = function(grunt)
|
||||
{
|
||||
grunt.file.setBase('../../../');
|
||||
grunt.initConfig({
|
||||
pkg: grunt.file.readJSON('package.json'),
|
||||
ts: {
|
||||
themeCustom: {
|
||||
options: {
|
||||
sourceMap: false,
|
||||
module: 'amd',
|
||||
basePath: 'themes',
|
||||
declaration: false
|
||||
},
|
||||
src: [
|
||||
'config/typedoc/custom-theme/assets/js/src/lib/**/*.ts',
|
||||
'config/typedoc/custom-theme/assets/js/src/typedoc/Application.ts',
|
||||
'config/typedoc/custom-theme/assets/js/src/typedoc/components/**/*.ts',
|
||||
'config/typedoc/custom-theme/assets/js/src/typedoc/services/**/*.ts',
|
||||
'config/typedoc/custom-theme/assets/js/src/typedoc/utils/**/*.ts',
|
||||
'config/typedoc/custom-theme/assets/js/src/~bootstrap.ts'
|
||||
],
|
||||
out: 'config/typedoc/custom-theme/assets/js/main.js'
|
||||
}
|
||||
},
|
||||
uglify: {
|
||||
themeCustom: {
|
||||
options: {
|
||||
mangle: false
|
||||
},
|
||||
files: {
|
||||
'config/typedoc/custom-theme/bin/default/assets/js/main.js': [
|
||||
'config/typedoc/custom-theme/assets/js/lib/jquery-2.1.1.min.js',
|
||||
'config/typedoc/custom-theme/assets/js/lib/underscore-1.6.0.min.js',
|
||||
'config/typedoc/custom-theme/assets/js/lib/backbone-1.1.2.min.js',
|
||||
'config/typedoc/custom-theme/assets/js/lib/lunr.min.js',
|
||||
'config/typedoc/custom-theme/assets/js/main.js'
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
'string-replace': {
|
||||
themeMinimal: {
|
||||
files: {
|
||||
'config/typedoc/custom-theme/bin/minimal/layouts/default.hbs': ['src/minimal/layouts/default.hbs']
|
||||
},
|
||||
options: {
|
||||
replacements: [{
|
||||
pattern: /{{ CSS }}/g,
|
||||
replacement: function() {
|
||||
var css = grunt.file.read('bin/default/assets/css/main.css');
|
||||
return css.replace(/url\(([^\)]*)\)/g, function(match, file) {
|
||||
if (match.indexOf(':') != -1) return match;
|
||||
var path = require('path'), fs = require('fs');
|
||||
var file = path.resolve('bin/default/assets/css', file);
|
||||
var data = fs.readFileSync(file, 'base64');
|
||||
return 'url(data:image/png;base64,' + data + ')';
|
||||
});
|
||||
}
|
||||
}, {
|
||||
pattern: /{{ JS }}/g,
|
||||
replacement: function() {
|
||||
return grunt.file.read('bin/default/assets/js/main.js').replace('{{', '{/**/{');
|
||||
}
|
||||
}]
|
||||
}
|
||||
}
|
||||
},
|
||||
sass: {
|
||||
options: {
|
||||
style: 'compact',
|
||||
unixNewlines: true
|
||||
},
|
||||
themeCustom: {
|
||||
files: [{
|
||||
expand: true,
|
||||
cwd: 'config/typedoc/custom-theme/assets/css',
|
||||
src: 'config/typedoc/custom-theme/**/*.sass',
|
||||
dest: 'config/typedoc/custom-theme/bin/assets/css',
|
||||
ext: '.css'
|
||||
}]
|
||||
}
|
||||
},
|
||||
autoprefixer: {
|
||||
options: {
|
||||
cascade: false
|
||||
},
|
||||
themeCustom: {
|
||||
expand: true,
|
||||
src: 'config/typedoc/custom-theme/bin/**/*.css',
|
||||
dest: './'
|
||||
}
|
||||
},
|
||||
copy: {
|
||||
plugin: {
|
||||
files: [{
|
||||
expand: true,
|
||||
cwd: 'src',
|
||||
src: ['*.js'],
|
||||
dest: 'config/typedoc/custom-theme/bin'
|
||||
}]
|
||||
},
|
||||
themeCustom: {
|
||||
files: [{
|
||||
expand: true,
|
||||
cwd: 'config/typedoc/custom-theme',
|
||||
src: ['**/*.hbs', '**/*.png'],
|
||||
dest: 'config/typedoc/custom-theme/bin'
|
||||
}]
|
||||
}
|
||||
},
|
||||
watch: {
|
||||
js: {
|
||||
files: ['config/typedoc/custom-theme/assets/js/src/**/*.ts'],
|
||||
tasks: ['js']
|
||||
},
|
||||
css: {
|
||||
files: ['config/typedoc/custom-theme/assets/css/**/*'],
|
||||
tasks: ['css']
|
||||
},
|
||||
custom: {
|
||||
files: ['config/typedoc/custom-theme/**/*.hbs'],
|
||||
tasks: ['copy', 'string-replace']
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
|
||||
grunt.loadNpmTasks('grunt-contrib-watch');
|
||||
grunt.loadNpmTasks('grunt-contrib-sass');
|
||||
grunt.loadNpmTasks('grunt-contrib-uglify');
|
||||
grunt.loadNpmTasks('grunt-contrib-copy');
|
||||
grunt.loadNpmTasks('grunt-string-replace');
|
||||
grunt.loadNpmTasks('grunt-autoprefixer');
|
||||
grunt.loadNpmTasks('grunt-ts');
|
||||
|
||||
grunt.registerTask('css', ['sass', 'autoprefixer']);
|
||||
grunt.registerTask('js', ['ts:themeCustom', 'uglify']);
|
||||
grunt.registerTask('default', ['copy', 'css', 'js', 'string-replace']);
|
||||
};
|
||||
|
|
@ -0,0 +1,51 @@
|
|||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>{{#ifCond model.name '==' project.name}}{{project.name}}{{else}}{{model.name}} | {{project.name}}{{/ifCond}}</title>
|
||||
<meta name="description" content="">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
|
||||
<link rel="stylesheet" href="{{relativeURL "assets/css/main.css"}}">
|
||||
<link rel="shortcut icon" href="/img/favicon.ico" type="image/x-icon">
|
||||
</head>
|
||||
<body>
|
||||
|
||||
{{> header}}
|
||||
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
{{{contents}}}
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
{{#each navigation.children}}
|
||||
{{> navigation}}
|
||||
{{/each}}
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
{{#each toc.children}}
|
||||
{{> toc.root}}
|
||||
{{/each}}
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{{> footer}}
|
||||
|
||||
<div class="overlay"></div>
|
||||
<script src="{{relativeURL "assets/js/main.js"}}"></script>
|
||||
<script>if (location.protocol == 'file:') document.write('<script src="{{relativeURL "assets/js/search.js"}}"><' + '/script>');</script>
|
||||
|
||||
{{> analytics}}
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
{{#if settings.gaID}}
|
||||
<script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', '{{settings.gaID}}', '{{settings.gaSite}}');
|
||||
ga('send', 'pageview');
|
||||
</script>
|
||||
{{/if}}
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
{{#if parent}}
|
||||
{{#with parent}}{{> breadcrumb}}{{/with}}
|
||||
<li>
|
||||
{{#if url}}
|
||||
<a href="{{relativeURL url}}">{{name}}</a>
|
||||
{{else}}
|
||||
<span>{{name}}</span>
|
||||
{{/if}}
|
||||
</li>
|
||||
{{else}}
|
||||
{{#if url}}
|
||||
<li>
|
||||
<a href="{{relativeURL url}}">Globals</a>
|
||||
</li>
|
||||
{{/if}}
|
||||
{{/if}}
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
{{#with comment}}
|
||||
{{#if hasVisibleComponent}}
|
||||
<div class="tsd-comment tsd-typography">
|
||||
{{#if shortText}}
|
||||
<div class="lead">
|
||||
{{#markdown}}{{{shortText}}}{{/markdown}}
|
||||
</div>
|
||||
{{/if}}
|
||||
{{#if text}}
|
||||
{{#markdown}}{{{text}}}{{/markdown}}
|
||||
{{/if}}
|
||||
{{#if tags}}
|
||||
<dl class="tsd-comment-tags">
|
||||
{{#each tags}}
|
||||
<dt>{{tagName}}</dt>
|
||||
<dd>{{#markdown}}{{{text}}}{{/markdown}}</dd>
|
||||
{{/each}}
|
||||
</dl>
|
||||
{{/if}}
|
||||
</div>
|
||||
{{/if}}
|
||||
{{/with}}
|
||||
|
|
@ -0,0 +1,68 @@
|
|||
|
||||
<footer{{#unless settings.hideGenerator}} class="with-border-bottom"{{/unless}}>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
|
||||
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
|
||||
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
|
||||
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
||||
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
|
||||
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||||
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
|
||||
{{#unless settings.hideGenerator}}
|
||||
<div class="container tsd-generator">
|
||||
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
|
||||
</div>
|
||||
{{/unless}}
|
||||
|
|
@ -0,0 +1,73 @@
|
|||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="{{relativeURL "assets/js/search.js"}}" data-base="{{relativeURL "./"}}">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
|
||||
<a style="position: absolute" href="/docs/reference-docs/openvidu-browser/" class="title">
|
||||
<img class="logo-small" style="height: 26px; margin-top: 7px" src="/img/logos/openvidu_vert_grey_bg_transp_cropped.png">
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
||||
<div class="tsd-filter-group">
|
||||
<div class="tsd-select" id="tsd-filter-visibility">
|
||||
<span class="tsd-select-label">All</span>
|
||||
<ul class="tsd-select-list">
|
||||
<li data-value="public">Public</li>
|
||||
<li data-value="protected">Public/Protected</li>
|
||||
<li data-value="private" class="selected">All</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<input type="checkbox" id="tsd-filter-inherited" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
||||
|
||||
{{#unless settings.excludeExternals}}
|
||||
<input type="checkbox" id="tsd-filter-externals" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
||||
{{/unless}}
|
||||
|
||||
{{#unless settings.excludeNotExported}}
|
||||
<input type="checkbox" id="tsd-filter-only-exported" />
|
||||
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
||||
{{/unless}}
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
{{#with model}}{{> breadcrumb}}{{/with}}
|
||||
</ul>
|
||||
<h1>{{#compact}}
|
||||
{{model.kindString}}
|
||||
{{model.name}}
|
||||
{{#if model.typeParameters}}
|
||||
<
|
||||
{{#each model.typeParameters}}
|
||||
{{#if @index}}, {{/if}}
|
||||
{{name}}
|
||||
{{/each}}
|
||||
>
|
||||
{{/if}}
|
||||
{{/compact}}</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
<ul class="tsd-hierarchy">
|
||||
{{#each types}}
|
||||
<li>
|
||||
{{#if ../isTarget}}
|
||||
<span class="target">{{this}}</span>
|
||||
{{else}}
|
||||
{{> type}}
|
||||
{{/if}}
|
||||
|
||||
{{#if @last}}
|
||||
{{#with ../next}}
|
||||
{{> hierarchy}}
|
||||
{{/with}}
|
||||
{{/if}}
|
||||
</li>
|
||||
{{/each}}
|
||||
</ul>
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
{{#if groups}}
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
{{#each groups}}
|
||||
<section class="tsd-index-section {{cssClasses}}">
|
||||
<h3>{{title}}</h3>
|
||||
<ul class="tsd-index-list">
|
||||
{{#each children}}
|
||||
<li class="{{cssClasses}}"><a href="{{relativeURL url}}" class="tsd-kind-icon">{{#if name}}{{{wbr name}}}{{else}}<em>{{{wbr kindString}}}</em>{{/if}}</a></li>
|
||||
{{/each}}
|
||||
</ul>
|
||||
</section>
|
||||
{{/each}}
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
{{/if}}
|
||||
|
|
@ -0,0 +1,36 @@
|
|||
<div class="tsd-signature tsd-kind-icon">{{#compact}}
|
||||
{{{wbr name}}}
|
||||
{{#if typeParameters}}
|
||||
<
|
||||
{{#each typeParameters}}
|
||||
{{#if @index}}, {{/if}}
|
||||
{{name}}
|
||||
{{/each}}
|
||||
>
|
||||
{{/if}}
|
||||
<span class="tsd-signature-symbol">{{#if isOptional}}?{{/if}}:</span> {{#with type}}{{>type}}{{/with}}
|
||||
{{#if defaultValue}}
|
||||
<span class="tsd-signature-symbol">
|
||||
=
|
||||
{{defaultValue}}
|
||||
</span>
|
||||
{{/if}}
|
||||
{{/compact}}</div>
|
||||
|
||||
{{> member.sources}}
|
||||
|
||||
{{> comment}}
|
||||
|
||||
{{#if typeParameters}}
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
{{> typeParameters}}
|
||||
{{/if}}
|
||||
|
||||
{{#if type.declaration}}
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
{{#with type.declaration}}
|
||||
{{> parameter}}
|
||||
{{/with}}
|
||||
</div>
|
||||
{{/if}}
|
||||
|
|
@ -0,0 +1,37 @@
|
|||
<ul class="tsd-signatures {{cssClasses}}">
|
||||
{{#if getSignature}}
|
||||
{{#with getSignature}}
|
||||
<li class="tsd-signature tsd-kind-icon">{{#compact}}
|
||||
<span class="tsd-signature-symbol">get</span>
|
||||
{{../name}}
|
||||
{{> member.signature.title hideName=true }}
|
||||
{{/compact}}</li>
|
||||
{{/with}}
|
||||
{{/if}}
|
||||
{{#if setSignature}}
|
||||
{{#with setSignature}}
|
||||
<li class="tsd-signature tsd-kind-icon">{{#compact}}
|
||||
<span class="tsd-signature-symbol">set</span>
|
||||
{{../name}}
|
||||
{{> member.signature.title hideName=true }}
|
||||
{{/compact}}</li>
|
||||
{{/with}}
|
||||
{{/if}}
|
||||
</ul>
|
||||
|
||||
<ul class="tsd-descriptions">
|
||||
{{#if getSignature}}
|
||||
{{#with getSignature}}
|
||||
<li class="tsd-description">
|
||||
{{> member.signature.body }}
|
||||
</li>
|
||||
{{/with}}
|
||||
{{/if}}
|
||||
{{#if setSignature}}
|
||||
{{#with setSignature}}
|
||||
<li class="tsd-description">
|
||||
{{> member.signature.body }}
|
||||
</li>
|
||||
{{/with}}
|
||||
{{/if}}
|
||||
</ul>
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
<section class="tsd-panel tsd-member {{cssClasses}}">
|
||||
<a name="{{anchor}}" class="tsd-anchor"></a>
|
||||
{{#if name}}
|
||||
<h3>{{#each flags}}<span class="tsd-flag ts-flag{{this}}">{{this}}</span> {{/each}}{{{wbr name}}}</h3>
|
||||
{{/if}}
|
||||
|
||||
{{#if signatures}}
|
||||
{{> member.signatures}}
|
||||
{{else}}{{#if hasGetterOrSetter}}
|
||||
{{> member.getterSetter}}
|
||||
{{else}}
|
||||
{{> member.declaration}}
|
||||
{{/if}}{{/if}}
|
||||
|
||||
{{#each groups}}
|
||||
{{#each children}}
|
||||
{{#unless hasOwnDocument}}
|
||||
{{> member}}
|
||||
{{/unless}}
|
||||
{{/each}}
|
||||
{{/each}}
|
||||
</section>
|
||||
|
|
@ -0,0 +1,56 @@
|
|||
{{#unless hideSources}}
|
||||
{{> member.sources}}
|
||||
{{/unless}}
|
||||
|
||||
{{> comment}}
|
||||
|
||||
{{#if typeParameters}}
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
{{> typeParameters}}
|
||||
{{/if}}
|
||||
|
||||
{{#if parameters}}
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
{{#each parameters}}
|
||||
<li>
|
||||
<h5>{{#compact}}
|
||||
{{#each flags}}
|
||||
<span class="tsd-flag ts-flag{{this}}">{{this}}</span>
|
||||
{{/each}}
|
||||
{{#if flags.isRest}}<span class="tsd-signature-symbol">...</span>{{/if}}
|
||||
{{name}}:
|
||||
{{#with type}}{{>type}}{{/with}}
|
||||
{{#if defaultValue}}
|
||||
<span class="tsd-signature-symbol">
|
||||
=
|
||||
{{defaultValue}}
|
||||
</span>
|
||||
{{/if}}
|
||||
{{/compact}}</h5>
|
||||
|
||||
{{> comment}}
|
||||
|
||||
{{#if type.declaration}}
|
||||
{{#with type.declaration}}
|
||||
{{> parameter}}
|
||||
{{/with}}
|
||||
{{/if}}
|
||||
</li>
|
||||
{{/each}}
|
||||
</ul>
|
||||
{{/if}}
|
||||
|
||||
{{#if type}}
|
||||
<h4 class="tsd-returns-title">Returns {{#with type}}{{>type}}{{/with}}</h4>
|
||||
|
||||
{{#if comment.returns}}
|
||||
{{#markdown}}{{{comment.returns}}}{{/markdown}}
|
||||
{{/if}}
|
||||
|
||||
{{#if type.declaration}}
|
||||
{{#with type.declaration}}
|
||||
{{> parameter}}
|
||||
{{/with}}
|
||||
{{/if}}
|
||||
{{/if}}
|
||||
|
|
@ -0,0 +1,28 @@
|
|||
{{#compact}}
|
||||
{{#unless hideName}}{{{wbr name}}}{{/unless}}
|
||||
{{#if typeParameters}}
|
||||
<
|
||||
{{#each typeParameters}}
|
||||
{{#if @index}}, {{/if}}
|
||||
{{name}}
|
||||
{{/each}}
|
||||
>
|
||||
{{/if}}
|
||||
<span class="tsd-signature-symbol">(</span>
|
||||
{{#each parameters}}
|
||||
{{#if @index}}, {{/if}}
|
||||
{{#if flags.isRest}}<span class="tsd-signature-symbol">...</span>{{/if}}
|
||||
{{name}}
|
||||
<span class="tsd-signature-symbol">
|
||||
{{#if flags.isOptional}}?{{/if}}
|
||||
{{#if defaultValue}}?{{/if}}
|
||||
:
|
||||
</span>
|
||||
{{#with type}}{{>type}}{{/with}}
|
||||
{{/each}}
|
||||
<span class="tsd-signature-symbol">)</span>
|
||||
{{#if type}}
|
||||
<span class="tsd-signature-symbol">: </span>
|
||||
{{#with type}}{{>type}}{{/with}}
|
||||
{{/if}}
|
||||
{{/compact}}
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<ul class="tsd-signatures {{cssClasses}}">
|
||||
{{#each signatures}}
|
||||
<li class="tsd-signature tsd-kind-icon">{{> member.signature.title }}</li>
|
||||
{{/each}}
|
||||
</ul>
|
||||
|
||||
<ul class="tsd-descriptions">
|
||||
{{#each signatures}}
|
||||
<li class="tsd-description">
|
||||
{{> member.signature.body }}
|
||||
</li>
|
||||
{{/each}}
|
||||
</ul>
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
<aside class="tsd-sources">
|
||||
{{#if implementationOf}}
|
||||
<p>Implementation of {{#with implementationOf}}{{> typeAndParent}}{{/with}}</p>
|
||||
{{/if}}
|
||||
{{#if inheritedFrom}}
|
||||
<p>Inherited from {{#with inheritedFrom}}{{> typeAndParent}}{{/with}}</p>
|
||||
{{/if}}
|
||||
{{#if overwrites}}
|
||||
<p>Overrides {{#with overwrites}}{{> typeAndParent}}{{/with}}</p>
|
||||
{{/if}}
|
||||
{{#if sources}}
|
||||
<ul>
|
||||
{{#each sources}}
|
||||
{{#if url}}
|
||||
<li>Defined in <a href="{{url}}">{{fileName}}:{{line}}</a></li>
|
||||
{{else}}
|
||||
<li>Defined in {{fileName}}:{{line}}</li>
|
||||
{{/if}}
|
||||
{{/each}}
|
||||
</ul>
|
||||
{{/if}}
|
||||
</aside>
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
<section class="tsd-panel-group tsd-member-group {{cssClasses}}">
|
||||
<h2>{{title}}</h2>
|
||||
{{#each children}}
|
||||
{{#unless hasOwnDocument}}
|
||||
{{> member}}
|
||||
{{/unless}}
|
||||
{{/each}}
|
||||
</section>
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
{{#each groups}}
|
||||
{{#unless allChildrenHaveOwnDocument}}
|
||||
{{> members.group}}
|
||||
{{/unless}}
|
||||
{{/each}}
|
||||
|
|
@ -0,0 +1,26 @@
|
|||
{{#if isVisible}}
|
||||
{{#if isLabel}}
|
||||
<li class="label {{cssClasses}}">
|
||||
<span>{{{wbr title}}}</span>
|
||||
</li>
|
||||
{{else}}
|
||||
{{#if isGlobals}}
|
||||
<li class="globals {{#if isInPath}}current{{/if}} {{cssClasses}}">
|
||||
<a href="{{relativeURL url}}"><em>{{{wbr title}}}</em></a>
|
||||
</li>
|
||||
{{else}}
|
||||
<li class="{{#if isInPath}}current{{/if}} {{cssClasses}}">
|
||||
<a href="{{relativeURL url}}">{{{wbr title}}}</a>
|
||||
{{#if isInPath}}
|
||||
{{#if children}}
|
||||
<ul>
|
||||
{{#each children}}
|
||||
{{> navigation}}
|
||||
{{/each}}
|
||||
</ul>
|
||||
{{/if}}
|
||||
{{/if}}
|
||||
</li>
|
||||
{{/if}}
|
||||
{{/if}}
|
||||
{{/if}}
|
||||
|
|
@ -0,0 +1,81 @@
|
|||
<ul class="tsd-parameters">
|
||||
{{#if signatures}}
|
||||
<li class="tsd-parameter-siganture">
|
||||
<ul class="tsd-signatures {{cssClasses}}">
|
||||
{{#each signatures}}
|
||||
<li class="tsd-signature tsd-kind-icon">{{> member.signature.title hideName=true }}</li>
|
||||
{{/each}}
|
||||
</ul>
|
||||
|
||||
<ul class="tsd-descriptions">
|
||||
{{#each signatures}}
|
||||
<li class="tsd-description">{{> member.signature.body hideSources=true }}</li>
|
||||
{{/each}}
|
||||
</ul>
|
||||
</li>
|
||||
{{/if}}
|
||||
{{#if indexSignature}}
|
||||
<li class="tsd-parameter-index-signature">
|
||||
<h5>{{#compact}}
|
||||
<span class="tsd-signature-symbol">[</span>
|
||||
{{#each indexSignature.parameters}}
|
||||
{{#if flags.isRest}}<span class="tsd-signature-symbol">...</span>{{/if}}{{name}}: {{#with type}}{{>type}}{{/with}}
|
||||
{{/each}}
|
||||
<span class="tsd-signature-symbol">]: </span>
|
||||
{{#with indexSignature.type}}{{>type}}{{/with}}
|
||||
{{/compact}}</h5>
|
||||
|
||||
{{#with indexSignature}}
|
||||
{{> comment}}
|
||||
{{/with}}
|
||||
|
||||
{{#if indexSignature.type.declaration}}
|
||||
{{#with indexSignature.type.declaration}}
|
||||
{{> parameter}}
|
||||
{{/with}}
|
||||
{{/if}}
|
||||
</li>
|
||||
{{/if}}
|
||||
{{#each children}}
|
||||
<li class="tsd-parameter">
|
||||
{{#if signatures}}
|
||||
<h5>{{#compact}}
|
||||
{{#if flags.isRest}}<span class="tsd-signature-symbol">...</span>{{/if}}
|
||||
{{{wbr name}}}
|
||||
<span class="tsd-signature-symbol">
|
||||
{{#if isOptional}}?{{/if}}
|
||||
:
|
||||
</span>
|
||||
function
|
||||
{{/compact}}</h5>
|
||||
|
||||
{{> member.signatures}}
|
||||
{{else}}
|
||||
<h5>{{#compact}}
|
||||
{{#each flags}}
|
||||
<span class="tsd-flag ts-flag{{this}}">{{this}}</span>
|
||||
{{/each}}
|
||||
{{#if flags.isRest}}<span class="tsd-signature-symbol">...</span>{{/if}}
|
||||
{{{wbr name}}}
|
||||
<span class="tsd-signature-symbol">
|
||||
{{#if flags.isOptional}}?{{/if}}
|
||||
:
|
||||
</span>
|
||||
{{#with type}}{{>type}}{{/with}}
|
||||
{{/compact}}</h5>
|
||||
|
||||
{{> comment}}
|
||||
|
||||
{{#if children}}
|
||||
{{> parameter}}
|
||||
{{/if}}
|
||||
|
||||
{{#if type.declaration}}
|
||||
{{#with type.declaration}}
|
||||
{{> parameter}}
|
||||
{{/with}}
|
||||
{{/if}}
|
||||
{{/if}}
|
||||
</li>
|
||||
{{/each}}
|
||||
</ul>
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
<li class="{{#if isInPath}}current{{/if}} {{cssClasses}}">
|
||||
<a href="{{relativeURL url}}" class="tsd-kind-icon">{{{wbr title}}}</a>
|
||||
{{#if children}}
|
||||
<ul>
|
||||
{{#each children}}
|
||||
{{> toc}}
|
||||
{{/each}}
|
||||
</ul>
|
||||
{{/if}}
|
||||
</li>
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
{{#if isInPath}}
|
||||
</ul>
|
||||
<ul class="current">
|
||||
{{/if}}
|
||||
<li class="{{#if isInPath}}current{{/if}} {{cssClasses}}">
|
||||
<a href="{{relativeURL url}}" class="tsd-kind-icon">{{{wbr title}}}</a>
|
||||
{{#if children}}
|
||||
<ul>
|
||||
{{#each children}}
|
||||
{{> toc}}
|
||||
{{/each}}
|
||||
</ul>
|
||||
{{/if}}
|
||||
</li>
|
||||
{{#if isInPath}}
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
{{/if}}
|
||||
|
|
@ -0,0 +1,83 @@
|
|||
{{#if this}}
|
||||
{{#if reflection}}
|
||||
{{#compact}}
|
||||
<a href="{{relativeURL reflection.url}}" class="tsd-signature-type">
|
||||
{{reflection.name}}
|
||||
</a>
|
||||
{{#if typeArguments}}
|
||||
<span class="tsd-signature-symbol"><</span>
|
||||
|
||||
{{#each typeArguments}}
|
||||
{{#if @index}}
|
||||
<span class="tsd-signature-symbol">, </span>
|
||||
{{/if}}{{> type}}
|
||||
{{/each}}
|
||||
|
||||
<span class="tsd-signature-symbol">></span>
|
||||
{{/if}}
|
||||
{{/compact}}
|
||||
{{else}}
|
||||
{{#if elementType}}
|
||||
{{#with elementType}}
|
||||
{{#compact}}
|
||||
{{#if types}}
|
||||
<span class="tsd-signature-symbol">(</span>
|
||||
{{/if}}
|
||||
{{> type}}
|
||||
{{#if types}}
|
||||
<span class="tsd-signature-symbol">)</span>
|
||||
{{/if}}<span class="tsd-signature-symbol">[]</span>
|
||||
{{/compact}}
|
||||
{{/with}}
|
||||
{{else}}
|
||||
{{#if types}}
|
||||
{{#each types}}
|
||||
{{#if @index}}
|
||||
<span class="tsd-signature-symbol"> {{#ifCond ../type '==' 'intersection'}}&{{else}}|{{/ifCond}} </span>
|
||||
{{/if}}{{> type}}
|
||||
{{/each}}
|
||||
{{else}}
|
||||
{{#if elements}}
|
||||
{{#compact}}
|
||||
<span class="tsd-signature-symbol">[</span>
|
||||
|
||||
{{#each elements}}
|
||||
{{#if @index}}
|
||||
<span class="tsd-signature-symbol">, </span>
|
||||
{{/if}}{{> type}}
|
||||
{{/each}}
|
||||
|
||||
<span class="tsd-signature-symbol">]</span>
|
||||
{{/compact}}
|
||||
{{else}}
|
||||
{{#compact}}
|
||||
<span class="tsd-signature-type">
|
||||
{{#if name}}
|
||||
{{name}}
|
||||
{{else}}
|
||||
{{#if value}}
|
||||
"{{value}}"
|
||||
{{else}}
|
||||
{{this}}
|
||||
{{/if}}
|
||||
{{/if}}
|
||||
</span>
|
||||
{{#if typeArguments}}
|
||||
<span class="tsd-signature-symbol"><</span>
|
||||
|
||||
{{#each typeArguments}}
|
||||
{{#if @index}}
|
||||
<span class="tsd-signature-symbol">, </span>
|
||||
{{/if}}{{> type}}
|
||||
{{/each}}
|
||||
|
||||
<span class="tsd-signature-symbol">></span>
|
||||
{{/if}}
|
||||
{{/compact}}
|
||||
{{/if}}
|
||||
{{/if}}
|
||||
{{/if}}
|
||||
{{/if}}
|
||||
{{else}}
|
||||
<span class="tsd-signature-type">void</span>
|
||||
{{/if}}
|
||||
|
|
@ -0,0 +1,42 @@
|
|||
{{#compact}}
|
||||
{{#if this}}
|
||||
{{#if elementType}}
|
||||
{{#with elementType}}
|
||||
{{> typeAndParent}}
|
||||
{{/with}}
|
||||
[]
|
||||
{{else}}
|
||||
{{#if reflection}}
|
||||
{{#ifSignature reflection}}
|
||||
{{#if reflection.parent.parent.url}}
|
||||
<a href="{{relativeURL reflection.parent.parent.url}}">{{reflection.parent.parent.name}}</a>
|
||||
{{else}}
|
||||
{{reflection.parent.parent.name}}
|
||||
{{/if}}
|
||||
.
|
||||
{{#if reflection.parent.url}}
|
||||
<a href="{{relativeURL reflection.parent.url}}">{{reflection.parent.name}}</a>
|
||||
{{else}}
|
||||
{{reflection.parent.name}}
|
||||
{{/if}}
|
||||
{{else}}
|
||||
{{#if reflection.parent.url}}
|
||||
<a href="{{relativeURL reflection.parent.url}}">{{reflection.parent.name}}</a>
|
||||
{{else}}
|
||||
{{reflection.parent.name}}
|
||||
{{/if}}
|
||||
.
|
||||
{{#if reflection.url}}
|
||||
<a href="{{relativeURL reflection.url}}">{{reflection.name}}</a>
|
||||
{{else}}
|
||||
{{reflection.name}}
|
||||
{{/if}}
|
||||
{{/ifSignature}}
|
||||
{{else}}
|
||||
{{this}}
|
||||
{{/if}}
|
||||
{{/if}}
|
||||
{{else}}
|
||||
void
|
||||
{{/if}}
|
||||
{{/compact}}
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
<ul class="tsd-type-parameters">
|
||||
{{#each typeParameters}}
|
||||
<li>
|
||||
<h4>{{#compact}}
|
||||
{{name}}
|
||||
{{#if type}}
|
||||
<span class="tsd-signature-symbol">: </span>
|
||||
{{#with type}}{{> type}}{{/with}}
|
||||
{{/if}}
|
||||
{{/compact}}</h4>
|
||||
{{> comment}}
|
||||
</li>
|
||||
{{/each}}
|
||||
</ul>
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
<div class="tsd-panel tsd-typography">
|
||||
{{#markdown}}{{{model.readme}}}{{/markdown}}
|
||||
</div>
|
||||
|
|
@ -0,0 +1,79 @@
|
|||
{{#with model}}
|
||||
{{#if hasComment}}
|
||||
<section class="tsd-panel tsd-comment">
|
||||
{{> comment}}
|
||||
</section>
|
||||
{{/if}}
|
||||
{{/with}}
|
||||
|
||||
{{#if model.typeParameters}}
|
||||
<section class="tsd-panel tsd-type-parameters">
|
||||
<h3>Type parameters</h3>
|
||||
{{#with model}}{{> typeParameters}}{{/with}}
|
||||
</section>
|
||||
{{/if}}
|
||||
|
||||
{{#if model.typeHierarchy}}
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
{{#with model.typeHierarchy}}{{> hierarchy}}{{/with}}
|
||||
</section>
|
||||
{{/if}}
|
||||
|
||||
{{#if model.implementedTypes}}
|
||||
<section class="tsd-panel">
|
||||
<h3>Implements</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
{{#each model.implementedTypes}}
|
||||
<li>{{> type}}</li>
|
||||
{{/each}}
|
||||
</ul>
|
||||
</section>
|
||||
{{/if}}
|
||||
|
||||
{{#if model.implementedBy}}
|
||||
<section class="tsd-panel">
|
||||
<h3>Implemented by</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
{{#each model.implementedBy}}
|
||||
<li>{{> type}}</li>
|
||||
{{/each}}
|
||||
</ul>
|
||||
</section>
|
||||
{{/if}}
|
||||
|
||||
{{#if model.signatures}}
|
||||
<section class="tsd-panel">
|
||||
<h3 class="tsd-before-signature">Callable</h3>
|
||||
{{#with model}}{{> member.signatures}}{{/with}}
|
||||
</section>
|
||||
{{/if}}
|
||||
|
||||
{{#if model.indexSignature}}
|
||||
<section class="tsd-panel {{model.cssClasses}}">
|
||||
<h3 class="tsd-before-signature">Indexable</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">{{#compact}}
|
||||
<span class="tsd-signature-symbol">[</span>
|
||||
{{#each model.indexSignature.parameters}}
|
||||
{{name}}: {{#with type}}{{>type}}{{/with}}
|
||||
{{/each}}
|
||||
<span class="tsd-signature-symbol">]: </span>
|
||||
{{#with model.indexSignature.type}}{{>type}}{{/with}}
|
||||
{{/compact}}</div>
|
||||
|
||||
{{#with model.indexSignature}}
|
||||
{{> comment}}
|
||||
{{/with}}
|
||||
|
||||
{{#if model.indexSignature.type.declaration}}
|
||||
{{#with model.indexSignature.type.declaration}}
|
||||
{{> parameter}}
|
||||
{{/with}}
|
||||
{{/if}}
|
||||
</section>
|
||||
{{/if}}
|
||||
|
||||
{{#with model}}
|
||||
{{> index}}
|
||||
{{> members}}
|
||||
{{/with}}
|
||||
|
|
@ -0,0 +1,26 @@
|
|||
module.exports = {
|
||||
lib: [
|
||||
"lib.dom.d.ts",
|
||||
"lib.es5.d.ts",
|
||||
"lib.es2015.promise.d.ts",
|
||||
"lib.scripthost.d.ts"
|
||||
],
|
||||
mode: "file",
|
||||
module: "commonjs",
|
||||
name: "OpenVidu Browser",
|
||||
target: "es5",
|
||||
externalPattern: "node_modules",
|
||||
exclude: [
|
||||
"**/OpenViduInternal/Interfaces/Private/**",
|
||||
"**/OpenViduInternal/WebRtcStats/WebRtcStats.ts",
|
||||
"**/OpenViduInternal/VersionAdapter.ts"
|
||||
],
|
||||
excludeExternals: true,
|
||||
excludePrivate: true,
|
||||
theme: "./config/typedoc/custom-theme/bin",
|
||||
plugin: [
|
||||
"typedoc-plugin-sourcefile-url",
|
||||
],
|
||||
'sourcefile-url-prefix': "https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/",
|
||||
readme: "none"
|
||||
}
|
||||
|
|
@ -0,0 +1,865 @@
|
|||
/*! normalize.css v1.1.3 | MIT License | git.io/normalize */
|
||||
/* ========================================================================== HTML5 display definitions ========================================================================== */
|
||||
/** Correct `block` display not defined in IE 6/7/8/9 and Firefox 3. */
|
||||
article, aside, details, figcaption, figure, footer, header, hgroup, main, nav, section, summary { display: block; }
|
||||
|
||||
/** Correct `inline-block` display not defined in IE 6/7/8/9 and Firefox 3. */
|
||||
audio, canvas, video { display: inline-block; *display: inline; *zoom: 1; }
|
||||
|
||||
/** Prevent modern browsers from displaying `audio` without controls. Remove excess height in iOS 5 devices. */
|
||||
audio:not([controls]) { display: none; height: 0; }
|
||||
|
||||
/** Address styling not present in IE 7/8/9, Firefox 3, and Safari 4. Known issue: no IE 6 support. */
|
||||
[hidden] { display: none; }
|
||||
|
||||
/* ========================================================================== Base ========================================================================== */
|
||||
/** 1. Correct text resizing oddly in IE 6/7 when body `font-size` is set using `em` units. 2. Prevent iOS text size adjust after orientation change, without disabling user zoom. */
|
||||
html { font-size: 100%; /* 1 */ -ms-text-size-adjust: 100%; /* 2 */ -webkit-text-size-adjust: 100%; /* 2 */ font-family: sans-serif; }
|
||||
|
||||
/** Address `font-family` inconsistency between `textarea` and other form elements. */
|
||||
button, input, select, textarea { font-family: sans-serif; }
|
||||
|
||||
/** Address margins handled incorrectly in IE 6/7. */
|
||||
body { margin: 0; }
|
||||
|
||||
/* ========================================================================== Links ========================================================================== */
|
||||
/** Address `outline` inconsistency between Chrome and other browsers. */
|
||||
a:focus { outline: thin dotted; }
|
||||
a:active, a:hover { outline: 0; }
|
||||
|
||||
/** Improve readability when focused and also mouse hovered in all browsers. */
|
||||
/* ========================================================================== Typography ========================================================================== */
|
||||
/** Address font sizes and margins set differently in IE 6/7. Address font sizes within `section` and `article` in Firefox 4+, Safari 5, and Chrome. */
|
||||
h1 { font-size: 2em; margin: 0.67em 0; }
|
||||
|
||||
h2 { font-size: 1.5em; margin: 0.83em 0; }
|
||||
|
||||
h3 { font-size: 1.17em; margin: 1em 0; }
|
||||
|
||||
h4, .tsd-index-panel h3 { font-size: 1em; margin: 1.33em 0; }
|
||||
|
||||
h5 { font-size: 0.83em; margin: 1.67em 0; }
|
||||
|
||||
h6 { font-size: 0.67em; margin: 2.33em 0; }
|
||||
|
||||
/** Address styling not present in IE 7/8/9, Safari 5, and Chrome. */
|
||||
abbr[title] { border-bottom: 1px dotted; }
|
||||
|
||||
/** Address style set to `bolder` in Firefox 3+, Safari 4/5, and Chrome. */
|
||||
b, strong { font-weight: bold; }
|
||||
|
||||
blockquote { margin: 1em 40px; }
|
||||
|
||||
/** Address styling not present in Safari 5 and Chrome. */
|
||||
dfn { font-style: italic; }
|
||||
|
||||
/** Address differences between Firefox and other browsers. Known issue: no IE 6/7 normalization. */
|
||||
hr { box-sizing: content-box; height: 0; }
|
||||
|
||||
/** Address styling not present in IE 6/7/8/9. */
|
||||
mark { background: #ff0; color: #000; }
|
||||
|
||||
/** Address margins set differently in IE 6/7. */
|
||||
p, pre { margin: 1em 0; }
|
||||
|
||||
/** Correct font family set oddly in IE 6, Safari 4/5, and Chrome. */
|
||||
code, kbd, pre, samp { font-family: monospace, serif; _font-family: "courier new", monospace; font-size: 1em; }
|
||||
|
||||
/** Improve readability of pre-formatted text in all browsers. */
|
||||
pre { white-space: pre; white-space: pre-wrap; word-wrap: break-word; }
|
||||
|
||||
/** Address CSS quotes not supported in IE 6/7. */
|
||||
q { quotes: none; }
|
||||
q:before, q:after { content: ""; content: none; }
|
||||
|
||||
/** Address `quotes` property not supported in Safari 4. */
|
||||
/** Address inconsistent and variable font size in all browsers. */
|
||||
small { font-size: 80%; }
|
||||
|
||||
/** Prevent `sub` and `sup` affecting `line-height` in all browsers. */
|
||||
sub { font-size: 75%; line-height: 0; position: relative; vertical-align: baseline; }
|
||||
|
||||
sup { font-size: 75%; line-height: 0; position: relative; vertical-align: baseline; top: -0.5em; }
|
||||
|
||||
sub { bottom: -0.25em; }
|
||||
|
||||
/* ========================================================================== Lists ========================================================================== */
|
||||
/** Address margins set differently in IE 6/7. */
|
||||
dl, menu, ol, ul { margin: 1em 0; }
|
||||
|
||||
dd { margin: 0 0 0 40px; }
|
||||
|
||||
/** Address paddings set differently in IE 6/7. */
|
||||
menu, ol, ul { padding: 0 0 0 40px; }
|
||||
|
||||
/** Correct list images handled incorrectly in IE 7. */
|
||||
nav ul, nav ol { list-style: none; list-style-image: none; }
|
||||
|
||||
/* ========================================================================== Embedded content ========================================================================== */
|
||||
/** 1. Remove border when inside `a` element in IE 6/7/8/9 and Firefox 3. 2. Improve image quality when scaled in IE 7. */
|
||||
img { border: 0; /* 1 */ -ms-interpolation-mode: bicubic; }
|
||||
|
||||
/* 2 */
|
||||
/** Correct overflow displayed oddly in IE 9. */
|
||||
svg:not(:root) { overflow: hidden; }
|
||||
|
||||
/* ========================================================================== Figures ========================================================================== */
|
||||
/** Address margin not present in IE 6/7/8/9, Safari 5, and Opera 11. */
|
||||
figure, form { margin: 0; }
|
||||
|
||||
/* ========================================================================== Forms ========================================================================== */
|
||||
/** Correct margin displayed oddly in IE 6/7. */
|
||||
/** Define consistent border, margin, and padding. */
|
||||
fieldset { border: 1px solid #c0c0c0; margin: 0 2px; padding: 0.35em 0.625em 0.75em; }
|
||||
|
||||
/** 1. Correct color not being inherited in IE 6/7/8/9. 2. Correct text not wrapping in Firefox 3. 3. Correct alignment displayed oddly in IE 6/7. */
|
||||
legend { border: 0; /* 1 */ padding: 0; white-space: normal; /* 2 */ *margin-left: -7px; }
|
||||
|
||||
/* 3 */
|
||||
/** 1. Correct font size not being inherited in all browsers. 2. Address margins set differently in IE 6/7, Firefox 3+, Safari 5, and Chrome. 3. Improve appearance and consistency in all browsers. */
|
||||
button, input, select, textarea { font-size: 100%; /* 1 */ margin: 0; /* 2 */ vertical-align: baseline; /* 3 */ *vertical-align: middle; }
|
||||
|
||||
/* 3 */
|
||||
/** Address Firefox 3+ setting `line-height` on `input` using `!important` in the UA stylesheet. */
|
||||
button, input { line-height: normal; }
|
||||
|
||||
/** Address inconsistent `text-transform` inheritance for `button` and `select`. All other form control elements do not inherit `text-transform` values. Correct `button` style inheritance in Chrome, Safari 5+, and IE 6+. Correct `select` style inheritance in Firefox 4+ and Opera. */
|
||||
button, select { text-transform: none; }
|
||||
|
||||
/** 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio` and `video` controls. 2. Correct inability to style clickable `input` types in iOS. 3. Improve usability and consistency of cursor style between image-type `input` and others. 4. Remove inner spacing in IE 7 without affecting normal text inputs. Known issue: inner spacing remains in IE 6. */
|
||||
button, html input[type="button"] { -webkit-appearance: button; /* 2 */ cursor: pointer; /* 3 */ *overflow: visible; }
|
||||
|
||||
/* 4 */
|
||||
input[type="reset"], input[type="submit"] { -webkit-appearance: button; /* 2 */ cursor: pointer; /* 3 */ *overflow: visible; }
|
||||
|
||||
/* 4 */
|
||||
/** Re-set default cursor for disabled elements. */
|
||||
button[disabled], html input[disabled] { cursor: default; }
|
||||
|
||||
/** 1. Address box sizing set to content-box in IE 8/9. 2. Remove excess padding in IE 8/9. 3. Remove excess padding in IE 7. Known issue: excess padding remains in IE 6. */
|
||||
input { /* 3 */ }
|
||||
input[type="checkbox"], input[type="radio"] { box-sizing: border-box; /* 1 */ padding: 0; /* 2 */ *height: 13px; /* 3 */ *width: 13px; }
|
||||
input[type="search"] { -webkit-appearance: textfield; /* 1 */ /* 2 */ box-sizing: content-box; }
|
||||
input[type="search"]::-webkit-search-cancel-button, input[type="search"]::-webkit-search-decoration { -webkit-appearance: none; }
|
||||
|
||||
/** 1. Address `appearance` set to `searchfield` in Safari 5 and Chrome. 2. Address `box-sizing` set to `border-box` in Safari 5 and Chrome (include `-moz` to future-proof). */
|
||||
/** Remove inner padding and search cancel button in Safari 5 and Chrome on OS X. */
|
||||
/** Remove inner padding and border in Firefox 3+. */
|
||||
button::-moz-focus-inner, input::-moz-focus-inner { border: 0; padding: 0; }
|
||||
|
||||
/** 1. Remove default vertical scrollbar in IE 6/7/8/9. 2. Improve readability and alignment in all browsers. */
|
||||
textarea { overflow: auto; /* 1 */ vertical-align: top; }
|
||||
|
||||
/* 2 */
|
||||
/* ========================================================================== Tables ========================================================================== */
|
||||
/** Remove most spacing between table cells. */
|
||||
table { border-collapse: collapse; border-spacing: 0; }
|
||||
|
||||
/* Visual Studio-like style based on original C# coloring by Jason Diamond <jason@diamond.name> */
|
||||
.hljs { display: inline-block; padding: 0.5em; background: white; color: black; }
|
||||
|
||||
.hljs-comment, .hljs-annotation, .hljs-template_comment, .diff .hljs-header, .hljs-chunk, .apache .hljs-cbracket { color: #008000; }
|
||||
|
||||
.hljs-keyword, .hljs-id, .hljs-built_in, .css .smalltalk .hljs-class, .hljs-winutils, .bash .hljs-variable, .tex .hljs-command, .hljs-request, .hljs-status, .nginx .hljs-title { color: #00f; }
|
||||
|
||||
.xml .hljs-tag { color: #00f; }
|
||||
.xml .hljs-tag .hljs-value { color: #00f; }
|
||||
|
||||
.hljs-string, .hljs-title, .hljs-parent, .hljs-tag .hljs-value, .hljs-rules .hljs-value { color: #a31515; }
|
||||
|
||||
.ruby .hljs-symbol { color: #a31515; }
|
||||
.ruby .hljs-symbol .hljs-string { color: #a31515; }
|
||||
|
||||
.hljs-template_tag, .django .hljs-variable, .hljs-addition, .hljs-flow, .hljs-stream, .apache .hljs-tag, .hljs-date, .tex .hljs-formula, .coffeescript .hljs-attribute { color: #a31515; }
|
||||
|
||||
.ruby .hljs-string, .hljs-decorator, .hljs-filter .hljs-argument, .hljs-localvars, .hljs-array, .hljs-attr_selector, .hljs-pseudo, .hljs-pi, .hljs-doctype, .hljs-deletion, .hljs-envvar, .hljs-shebang, .hljs-preprocessor, .hljs-pragma, .userType, .apache .hljs-sqbracket, .nginx .hljs-built_in, .tex .hljs-special, .hljs-prompt { color: #2b91af; }
|
||||
|
||||
.hljs-phpdoc, .hljs-javadoc, .hljs-xmlDocTag { color: #808080; }
|
||||
|
||||
.vhdl .hljs-typename { font-weight: bold; }
|
||||
.vhdl .hljs-string { color: #666666; }
|
||||
.vhdl .hljs-literal { color: #a31515; }
|
||||
.vhdl .hljs-attribute { color: #00b0e8; }
|
||||
|
||||
.xml .hljs-attribute { color: #f00; }
|
||||
|
||||
.col > :first-child, .col-1 > :first-child, .col-2 > :first-child, .col-3 > :first-child, .col-4 > :first-child, .col-5 > :first-child, .col-6 > :first-child, .col-7 > :first-child, .col-8 > :first-child, .col-9 > :first-child, .col-10 > :first-child, .col-11 > :first-child, .tsd-panel > :first-child, ul.tsd-descriptions > li > :first-child, .col > :first-child > :first-child, .col-1 > :first-child > :first-child, .col-2 > :first-child > :first-child, .col-3 > :first-child > :first-child, .col-4 > :first-child > :first-child, .col-5 > :first-child > :first-child, .col-6 > :first-child > :first-child, .col-7 > :first-child > :first-child, .col-8 > :first-child > :first-child, .col-9 > :first-child > :first-child, .col-10 > :first-child > :first-child, .col-11 > :first-child > :first-child, .tsd-panel > :first-child > :first-child, ul.tsd-descriptions > li > :first-child > :first-child, .col > :first-child > :first-child > :first-child, .col-1 > :first-child > :first-child > :first-child, .col-2 > :first-child > :first-child > :first-child, .col-3 > :first-child > :first-child > :first-child, .col-4 > :first-child > :first-child > :first-child, .col-5 > :first-child > :first-child > :first-child, .col-6 > :first-child > :first-child > :first-child, .col-7 > :first-child > :first-child > :first-child, .col-8 > :first-child > :first-child > :first-child, .col-9 > :first-child > :first-child > :first-child, .col-10 > :first-child > :first-child > :first-child, .col-11 > :first-child > :first-child > :first-child, .tsd-panel > :first-child > :first-child > :first-child, ul.tsd-descriptions > li > :first-child > :first-child > :first-child { margin-top: 0; }
|
||||
.col > :last-child, .col-1 > :last-child, .col-2 > :last-child, .col-3 > :last-child, .col-4 > :last-child, .col-5 > :last-child, .col-6 > :last-child, .col-7 > :last-child, .col-8 > :last-child, .col-9 > :last-child, .col-10 > :last-child, .col-11 > :last-child, .tsd-panel > :last-child, ul.tsd-descriptions > li > :last-child, .col > :last-child > :last-child, .col-1 > :last-child > :last-child, .col-2 > :last-child > :last-child, .col-3 > :last-child > :last-child, .col-4 > :last-child > :last-child, .col-5 > :last-child > :last-child, .col-6 > :last-child > :last-child, .col-7 > :last-child > :last-child, .col-8 > :last-child > :last-child, .col-9 > :last-child > :last-child, .col-10 > :last-child > :last-child, .col-11 > :last-child > :last-child, .tsd-panel > :last-child > :last-child, ul.tsd-descriptions > li > :last-child > :last-child, .col > :last-child > :last-child > :last-child, .col-1 > :last-child > :last-child > :last-child, .col-2 > :last-child > :last-child > :last-child, .col-3 > :last-child > :last-child > :last-child, .col-4 > :last-child > :last-child > :last-child, .col-5 > :last-child > :last-child > :last-child, .col-6 > :last-child > :last-child > :last-child, .col-7 > :last-child > :last-child > :last-child, .col-8 > :last-child > :last-child > :last-child, .col-9 > :last-child > :last-child > :last-child, .col-10 > :last-child > :last-child > :last-child, .col-11 > :last-child > :last-child > :last-child, .tsd-panel > :last-child > :last-child > :last-child, ul.tsd-descriptions > li > :last-child > :last-child > :last-child { margin-bottom: 0; }
|
||||
|
||||
.container { max-width: 1200px; margin: 0 auto; padding: 0 40px; }
|
||||
@media (max-width: 640px) { .container { padding: 0 20px; } }
|
||||
|
||||
.container-main { padding-bottom: 200px; }
|
||||
|
||||
.row { position: relative; margin: 0 -10px; }
|
||||
.row:after { visibility: hidden; display: block; content: ""; clear: both; height: 0; }
|
||||
|
||||
.col, .col-1, .col-2, .col-3, .col-4, .col-5, .col-6, .col-7, .col-8, .col-9, .col-10, .col-11 { box-sizing: border-box; float: left; padding: 0 10px; }
|
||||
|
||||
.col-1 { width: 8.33333%; }
|
||||
|
||||
.offset-1 { margin-left: 8.33333%; }
|
||||
|
||||
.col-2 { width: 16.66667%; }
|
||||
|
||||
.offset-2 { margin-left: 16.66667%; }
|
||||
|
||||
.col-3 { width: 25%; }
|
||||
|
||||
.offset-3 { margin-left: 25%; }
|
||||
|
||||
.col-4 { width: 33.33333%; }
|
||||
|
||||
.offset-4 { margin-left: 33.33333%; }
|
||||
|
||||
.col-5 { width: 41.66667%; }
|
||||
|
||||
.offset-5 { margin-left: 41.66667%; }
|
||||
|
||||
.col-6 { width: 50%; }
|
||||
|
||||
.offset-6 { margin-left: 50%; }
|
||||
|
||||
.col-7 { width: 58.33333%; }
|
||||
|
||||
.offset-7 { margin-left: 58.33333%; }
|
||||
|
||||
.col-8 { width: 66.66667%; }
|
||||
|
||||
.offset-8 { margin-left: 66.66667%; }
|
||||
|
||||
.col-9 { width: 75%; }
|
||||
|
||||
.offset-9 { margin-left: 75%; }
|
||||
|
||||
.col-10 { width: 83.33333%; }
|
||||
|
||||
.offset-10 { margin-left: 83.33333%; }
|
||||
|
||||
.col-11 { width: 91.66667%; }
|
||||
|
||||
.offset-11 { margin-left: 91.66667%; }
|
||||
|
||||
.tsd-kind-icon { display: block; position: relative; padding-left: 20px; text-indent: -20px; }
|
||||
.tsd-kind-icon:before { content: ''; display: inline-block; vertical-align: middle; width: 17px; height: 17px; margin: 0 3px 2px 0; background-image: url(../images/icons.png); }
|
||||
@media (-webkit-min-device-pixel-ratio: 1.5), (min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { .tsd-kind-icon:before { background-image: url(../images/icons@2x.png); background-size: 238px 204px; } }
|
||||
|
||||
.tsd-signature.tsd-kind-icon:before { background-position: 0 -153px; }
|
||||
|
||||
.tsd-kind-object-literal > .tsd-kind-icon:before { background-position: 0px -17px; }
|
||||
.tsd-kind-object-literal.tsd-is-protected > .tsd-kind-icon:before { background-position: -17px -17px; }
|
||||
.tsd-kind-object-literal.tsd-is-private > .tsd-kind-icon:before { background-position: -34px -17px; }
|
||||
|
||||
.tsd-kind-class > .tsd-kind-icon:before { background-position: 0px -34px; }
|
||||
.tsd-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -17px -34px; }
|
||||
.tsd-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -34px -34px; }
|
||||
|
||||
.tsd-kind-class.tsd-has-type-parameter > .tsd-kind-icon:before { background-position: 0px -51px; }
|
||||
.tsd-kind-class.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { background-position: -17px -51px; }
|
||||
.tsd-kind-class.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { background-position: -34px -51px; }
|
||||
|
||||
.tsd-kind-interface > .tsd-kind-icon:before { background-position: 0px -68px; }
|
||||
.tsd-kind-interface.tsd-is-protected > .tsd-kind-icon:before { background-position: -17px -68px; }
|
||||
.tsd-kind-interface.tsd-is-private > .tsd-kind-icon:before { background-position: -34px -68px; }
|
||||
|
||||
.tsd-kind-interface.tsd-has-type-parameter > .tsd-kind-icon:before { background-position: 0px -85px; }
|
||||
.tsd-kind-interface.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { background-position: -17px -85px; }
|
||||
.tsd-kind-interface.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { background-position: -34px -85px; }
|
||||
|
||||
.tsd-kind-module > .tsd-kind-icon:before { background-position: 0px -102px; }
|
||||
.tsd-kind-module.tsd-is-protected > .tsd-kind-icon:before { background-position: -17px -102px; }
|
||||
.tsd-kind-module.tsd-is-private > .tsd-kind-icon:before { background-position: -34px -102px; }
|
||||
|
||||
.tsd-kind-external-module > .tsd-kind-icon:before { background-position: 0px -102px; }
|
||||
.tsd-kind-external-module.tsd-is-protected > .tsd-kind-icon:before { background-position: -17px -102px; }
|
||||
.tsd-kind-external-module.tsd-is-private > .tsd-kind-icon:before { background-position: -34px -102px; }
|
||||
|
||||
.tsd-kind-enum > .tsd-kind-icon:before { background-position: 0px -119px; }
|
||||
.tsd-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -17px -119px; }
|
||||
.tsd-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -34px -119px; }
|
||||
|
||||
.tsd-kind-enum-member > .tsd-kind-icon:before { background-position: 0px -136px; }
|
||||
.tsd-kind-enum-member.tsd-is-protected > .tsd-kind-icon:before { background-position: -17px -136px; }
|
||||
.tsd-kind-enum-member.tsd-is-private > .tsd-kind-icon:before { background-position: -34px -136px; }
|
||||
|
||||
.tsd-kind-signature > .tsd-kind-icon:before { background-position: 0px -153px; }
|
||||
.tsd-kind-signature.tsd-is-protected > .tsd-kind-icon:before { background-position: -17px -153px; }
|
||||
.tsd-kind-signature.tsd-is-private > .tsd-kind-icon:before { background-position: -34px -153px; }
|
||||
|
||||
.tsd-kind-type-alias > .tsd-kind-icon:before { background-position: 0px -170px; }
|
||||
.tsd-kind-type-alias.tsd-is-protected > .tsd-kind-icon:before { background-position: -17px -170px; }
|
||||
.tsd-kind-type-alias.tsd-is-private > .tsd-kind-icon:before { background-position: -34px -170px; }
|
||||
|
||||
.tsd-kind-variable > .tsd-kind-icon:before { background-position: -136px -0px; }
|
||||
.tsd-kind-variable.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -0px; }
|
||||
.tsd-kind-variable.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -0px; }
|
||||
.tsd-kind-variable.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -0px; }
|
||||
.tsd-kind-variable.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -0px; }
|
||||
.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -0px; }
|
||||
.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -0px; }
|
||||
.tsd-kind-variable.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -0px; }
|
||||
.tsd-kind-variable.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -0px; }
|
||||
.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -0px; }
|
||||
.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -0px; }
|
||||
.tsd-kind-variable.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -0px; }
|
||||
.tsd-kind-variable.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -0px; }
|
||||
|
||||
.tsd-kind-property > .tsd-kind-icon:before { background-position: -136px -0px; }
|
||||
.tsd-kind-property.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -0px; }
|
||||
.tsd-kind-property.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -0px; }
|
||||
.tsd-kind-property.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -0px; }
|
||||
.tsd-kind-property.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -0px; }
|
||||
.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -0px; }
|
||||
.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -0px; }
|
||||
.tsd-kind-property.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -0px; }
|
||||
.tsd-kind-property.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -0px; }
|
||||
.tsd-kind-property.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -0px; }
|
||||
.tsd-kind-property.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -0px; }
|
||||
.tsd-kind-property.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -0px; }
|
||||
.tsd-kind-property.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -0px; }
|
||||
|
||||
.tsd-kind-get-signature > .tsd-kind-icon:before { background-position: -136px -17px; }
|
||||
.tsd-kind-get-signature.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -17px; }
|
||||
.tsd-kind-get-signature.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -17px; }
|
||||
.tsd-kind-get-signature.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -17px; }
|
||||
.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -17px; }
|
||||
.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -17px; }
|
||||
.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -17px; }
|
||||
.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -17px; }
|
||||
.tsd-kind-get-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -17px; }
|
||||
.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -17px; }
|
||||
.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -17px; }
|
||||
.tsd-kind-get-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -17px; }
|
||||
.tsd-kind-get-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -17px; }
|
||||
|
||||
.tsd-kind-set-signature > .tsd-kind-icon:before { background-position: -136px -34px; }
|
||||
.tsd-kind-set-signature.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -34px; }
|
||||
.tsd-kind-set-signature.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -34px; }
|
||||
.tsd-kind-set-signature.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -34px; }
|
||||
.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -34px; }
|
||||
.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -34px; }
|
||||
.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -34px; }
|
||||
.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -34px; }
|
||||
.tsd-kind-set-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -34px; }
|
||||
.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -34px; }
|
||||
.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -34px; }
|
||||
.tsd-kind-set-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -34px; }
|
||||
.tsd-kind-set-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -34px; }
|
||||
|
||||
.tsd-kind-accessor > .tsd-kind-icon:before { background-position: -136px -51px; }
|
||||
.tsd-kind-accessor.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -51px; }
|
||||
.tsd-kind-accessor.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -51px; }
|
||||
.tsd-kind-accessor.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -51px; }
|
||||
.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -51px; }
|
||||
.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -51px; }
|
||||
.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -51px; }
|
||||
.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -51px; }
|
||||
.tsd-kind-accessor.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -51px; }
|
||||
.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -51px; }
|
||||
.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -51px; }
|
||||
.tsd-kind-accessor.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -51px; }
|
||||
.tsd-kind-accessor.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -51px; }
|
||||
|
||||
.tsd-kind-function > .tsd-kind-icon:before { background-position: -136px -68px; }
|
||||
.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -68px; }
|
||||
.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -68px; }
|
||||
.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -68px; }
|
||||
.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -68px; }
|
||||
.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -68px; }
|
||||
.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -68px; }
|
||||
.tsd-kind-function.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -68px; }
|
||||
.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -68px; }
|
||||
.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -68px; }
|
||||
.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -68px; }
|
||||
.tsd-kind-function.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -68px; }
|
||||
.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -68px; }
|
||||
|
||||
.tsd-kind-method > .tsd-kind-icon:before { background-position: -136px -68px; }
|
||||
.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -68px; }
|
||||
.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -68px; }
|
||||
.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -68px; }
|
||||
.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -68px; }
|
||||
.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -68px; }
|
||||
.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -68px; }
|
||||
.tsd-kind-method.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -68px; }
|
||||
.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -68px; }
|
||||
.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -68px; }
|
||||
.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -68px; }
|
||||
.tsd-kind-method.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -68px; }
|
||||
.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -68px; }
|
||||
|
||||
.tsd-kind-call-signature > .tsd-kind-icon:before { background-position: -136px -68px; }
|
||||
.tsd-kind-call-signature.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -68px; }
|
||||
.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -68px; }
|
||||
.tsd-kind-call-signature.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -68px; }
|
||||
.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -68px; }
|
||||
.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -68px; }
|
||||
.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -68px; }
|
||||
.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -68px; }
|
||||
.tsd-kind-call-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -68px; }
|
||||
.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -68px; }
|
||||
.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -68px; }
|
||||
.tsd-kind-call-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -68px; }
|
||||
.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -68px; }
|
||||
|
||||
.tsd-kind-function.tsd-has-type-parameter > .tsd-kind-icon:before { background-position: -136px -85px; }
|
||||
.tsd-kind-function.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -85px; }
|
||||
.tsd-kind-function.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -85px; }
|
||||
.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -85px; }
|
||||
.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -85px; }
|
||||
.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -85px; }
|
||||
.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -85px; }
|
||||
.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -85px; }
|
||||
.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -85px; }
|
||||
.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -85px; }
|
||||
.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -85px; }
|
||||
.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -85px; }
|
||||
.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -85px; }
|
||||
|
||||
.tsd-kind-method.tsd-has-type-parameter > .tsd-kind-icon:before { background-position: -136px -85px; }
|
||||
.tsd-kind-method.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -85px; }
|
||||
.tsd-kind-method.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -85px; }
|
||||
.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -85px; }
|
||||
.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -85px; }
|
||||
.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -85px; }
|
||||
.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -85px; }
|
||||
.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -85px; }
|
||||
.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -85px; }
|
||||
.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -85px; }
|
||||
.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -85px; }
|
||||
.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -85px; }
|
||||
.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -85px; }
|
||||
|
||||
.tsd-kind-constructor > .tsd-kind-icon:before { background-position: -136px -102px; }
|
||||
.tsd-kind-constructor.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -102px; }
|
||||
.tsd-kind-constructor.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -102px; }
|
||||
.tsd-kind-constructor.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -102px; }
|
||||
.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -102px; }
|
||||
.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -102px; }
|
||||
.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -102px; }
|
||||
.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -102px; }
|
||||
.tsd-kind-constructor.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -102px; }
|
||||
.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -102px; }
|
||||
.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -102px; }
|
||||
.tsd-kind-constructor.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -102px; }
|
||||
.tsd-kind-constructor.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -102px; }
|
||||
|
||||
.tsd-kind-constructor-signature > .tsd-kind-icon:before { background-position: -136px -102px; }
|
||||
.tsd-kind-constructor-signature.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -102px; }
|
||||
.tsd-kind-constructor-signature.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -102px; }
|
||||
.tsd-kind-constructor-signature.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -102px; }
|
||||
.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -102px; }
|
||||
.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -102px; }
|
||||
.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -102px; }
|
||||
.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -102px; }
|
||||
.tsd-kind-constructor-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -102px; }
|
||||
.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -102px; }
|
||||
.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -102px; }
|
||||
.tsd-kind-constructor-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -102px; }
|
||||
.tsd-kind-constructor-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -102px; }
|
||||
|
||||
.tsd-kind-index-signature > .tsd-kind-icon:before { background-position: -136px -119px; }
|
||||
.tsd-kind-index-signature.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -119px; }
|
||||
.tsd-kind-index-signature.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -119px; }
|
||||
.tsd-kind-index-signature.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -119px; }
|
||||
.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -119px; }
|
||||
.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -119px; }
|
||||
.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -119px; }
|
||||
.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -119px; }
|
||||
.tsd-kind-index-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -119px; }
|
||||
.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -119px; }
|
||||
.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -119px; }
|
||||
.tsd-kind-index-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -119px; }
|
||||
.tsd-kind-index-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -119px; }
|
||||
|
||||
.tsd-kind-event > .tsd-kind-icon:before { background-position: -136px -136px; }
|
||||
.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -136px; }
|
||||
.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -136px; }
|
||||
.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -136px; }
|
||||
.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -136px; }
|
||||
.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -136px; }
|
||||
.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -136px; }
|
||||
.tsd-kind-event.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -136px; }
|
||||
.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -136px; }
|
||||
.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -136px; }
|
||||
.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -136px; }
|
||||
.tsd-kind-event.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -136px; }
|
||||
.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -136px; }
|
||||
|
||||
.tsd-is-static > .tsd-kind-icon:before { background-position: -136px -153px; }
|
||||
.tsd-is-static.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -153px; }
|
||||
.tsd-is-static.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -153px; }
|
||||
.tsd-is-static.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -153px; }
|
||||
.tsd-is-static.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -153px; }
|
||||
.tsd-is-static.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -153px; }
|
||||
.tsd-is-static.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -153px; }
|
||||
.tsd-is-static.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -153px; }
|
||||
.tsd-is-static.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -153px; }
|
||||
.tsd-is-static.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -153px; }
|
||||
.tsd-is-static.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -153px; }
|
||||
.tsd-is-static.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -153px; }
|
||||
.tsd-is-static.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -153px; }
|
||||
|
||||
.tsd-is-static.tsd-kind-function > .tsd-kind-icon:before { background-position: -136px -170px; }
|
||||
.tsd-is-static.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -170px; }
|
||||
.tsd-is-static.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -170px; }
|
||||
.tsd-is-static.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -170px; }
|
||||
.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -170px; }
|
||||
.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -170px; }
|
||||
.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -170px; }
|
||||
.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -170px; }
|
||||
.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -170px; }
|
||||
.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -170px; }
|
||||
.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -170px; }
|
||||
.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -170px; }
|
||||
.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -170px; }
|
||||
|
||||
.tsd-is-static.tsd-kind-method > .tsd-kind-icon:before { background-position: -136px -170px; }
|
||||
.tsd-is-static.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -170px; }
|
||||
.tsd-is-static.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -170px; }
|
||||
.tsd-is-static.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -170px; }
|
||||
.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -170px; }
|
||||
.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -170px; }
|
||||
.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -170px; }
|
||||
.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -170px; }
|
||||
.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -170px; }
|
||||
.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -170px; }
|
||||
.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -170px; }
|
||||
.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -170px; }
|
||||
.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -170px; }
|
||||
|
||||
.tsd-is-static.tsd-kind-call-signature > .tsd-kind-icon:before { background-position: -136px -170px; }
|
||||
.tsd-is-static.tsd-kind-call-signature.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -170px; }
|
||||
.tsd-is-static.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -170px; }
|
||||
.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -170px; }
|
||||
.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -170px; }
|
||||
.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -170px; }
|
||||
.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -170px; }
|
||||
.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -170px; }
|
||||
.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -170px; }
|
||||
.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -170px; }
|
||||
.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -170px; }
|
||||
.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -170px; }
|
||||
.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -170px; }
|
||||
|
||||
.tsd-is-static.tsd-kind-event > .tsd-kind-icon:before { background-position: -136px -187px; }
|
||||
.tsd-is-static.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -187px; }
|
||||
.tsd-is-static.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -187px; }
|
||||
.tsd-is-static.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -187px; }
|
||||
.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -187px; }
|
||||
.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -187px; }
|
||||
.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -187px; }
|
||||
.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -187px; }
|
||||
.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -187px; }
|
||||
.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -187px; }
|
||||
.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -187px; }
|
||||
.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -187px; }
|
||||
.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -187px; }
|
||||
|
||||
.no-transition { transition: none !important; }
|
||||
|
||||
@-webkit-keyframes fade-in { from { opacity: 0; }
|
||||
to { opacity: 1; } }
|
||||
|
||||
@keyframes fade-in { from { opacity: 0; }
|
||||
to { opacity: 1; } }
|
||||
@-webkit-keyframes fade-out { from { opacity: 1; visibility: visible; }
|
||||
to { opacity: 0; } }
|
||||
@keyframes fade-out { from { opacity: 1; visibility: visible; }
|
||||
to { opacity: 0; } }
|
||||
@-webkit-keyframes fade-in-delayed { 0% { opacity: 0; }
|
||||
33% { opacity: 0; }
|
||||
100% { opacity: 1; } }
|
||||
@keyframes fade-in-delayed { 0% { opacity: 0; }
|
||||
33% { opacity: 0; }
|
||||
100% { opacity: 1; } }
|
||||
@-webkit-keyframes fade-out-delayed { 0% { opacity: 1; visibility: visible; }
|
||||
66% { opacity: 0; }
|
||||
100% { opacity: 0; } }
|
||||
@keyframes fade-out-delayed { 0% { opacity: 1; visibility: visible; }
|
||||
66% { opacity: 0; }
|
||||
100% { opacity: 0; } }
|
||||
@-webkit-keyframes shift-to-left { from { -webkit-transform: translate(0, 0); transform: translate(0, 0); }
|
||||
to { -webkit-transform: translate(-25%, 0); transform: translate(-25%, 0); } }
|
||||
@keyframes shift-to-left { from { -webkit-transform: translate(0, 0); transform: translate(0, 0); }
|
||||
to { -webkit-transform: translate(-25%, 0); transform: translate(-25%, 0); } }
|
||||
@-webkit-keyframes unshift-to-left { from { -webkit-transform: translate(-25%, 0); transform: translate(-25%, 0); }
|
||||
to { -webkit-transform: translate(0, 0); transform: translate(0, 0); } }
|
||||
@keyframes unshift-to-left { from { -webkit-transform: translate(-25%, 0); transform: translate(-25%, 0); }
|
||||
to { -webkit-transform: translate(0, 0); transform: translate(0, 0); } }
|
||||
@-webkit-keyframes pop-in-from-right { from { -webkit-transform: translate(100%, 0); transform: translate(100%, 0); }
|
||||
to { -webkit-transform: translate(0, 0); transform: translate(0, 0); } }
|
||||
@keyframes pop-in-from-right { from { -webkit-transform: translate(100%, 0); transform: translate(100%, 0); }
|
||||
to { -webkit-transform: translate(0, 0); transform: translate(0, 0); } }
|
||||
@-webkit-keyframes pop-out-to-right { from { -webkit-transform: translate(0, 0); transform: translate(0, 0); visibility: visible; }
|
||||
to { -webkit-transform: translate(100%, 0); transform: translate(100%, 0); } }
|
||||
@keyframes pop-out-to-right { from { -webkit-transform: translate(0, 0); transform: translate(0, 0); visibility: visible; }
|
||||
to { -webkit-transform: translate(100%, 0); transform: translate(100%, 0); } }
|
||||
body { background: #fdfdfd; font-family: "Segoe UI", sans-serif; font-size: 16px; color: #222; }
|
||||
|
||||
a { color: #4da6ff; text-decoration: none; }
|
||||
a:hover { text-decoration: underline; }
|
||||
|
||||
code, pre { font-family: Menlo, Monaco, Consolas, "Courier New", monospace; padding: 0.2em; margin: 0; font-size: 14px; background-color: rgba(0, 0, 0, 0.04); }
|
||||
|
||||
pre { padding: 10px; }
|
||||
pre code { padding: 0; font-size: 100%; background-color: transparent; }
|
||||
|
||||
.tsd-typography { line-height: 1.333em; }
|
||||
.tsd-typography ul { list-style: square; padding: 0 0 0 20px; margin: 0; }
|
||||
.tsd-typography h4, .tsd-typography .tsd-index-panel h3, .tsd-index-panel .tsd-typography h3, .tsd-typography h5, .tsd-typography h6 { font-size: 1em; margin: 0; }
|
||||
.tsd-typography h5, .tsd-typography h6 { font-weight: normal; }
|
||||
.tsd-typography p, .tsd-typography ul, .tsd-typography ol { margin: 1em 0; }
|
||||
|
||||
@media (min-width: 901px) and (max-width: 1024px) { html.default .col-content { width: 72%; }
|
||||
html.default .col-menu { width: 28%; }
|
||||
html.default .tsd-navigation { padding-left: 10px; } }
|
||||
@media (max-width: 900px) { html.default .col-content { float: none; width: 100%; }
|
||||
html.default .col-menu { position: fixed !important; overflow: auto; -webkit-overflow-scrolling: touch; overflow-scrolling: touch; z-index: 1024; top: 0 !important; bottom: 0 !important; left: auto !important; right: 0 !important; width: 100%; padding: 20px 20px 0 0; max-width: 450px; visibility: hidden; background-color: #fff; -webkit-transform: translate(100%, 0); transform: translate(100%, 0); }
|
||||
html.default .col-menu > *:last-child { padding-bottom: 20px; }
|
||||
html.default .overlay { content: ""; display: block; position: fixed; z-index: 1023; top: 0; left: 0; right: 0; bottom: 0; background-color: rgba(0, 0, 0, 0.75); visibility: hidden; }
|
||||
html.default.to-has-menu .overlay { -webkit-animation: fade-in 0.4s; animation: fade-in 0.4s; }
|
||||
html.default.to-has-menu header, html.default.to-has-menu footer, html.default.to-has-menu .col-content { -webkit-animation: shift-to-left 0.4s; animation: shift-to-left 0.4s; }
|
||||
html.default.to-has-menu .col-menu { -webkit-animation: pop-in-from-right 0.4s; animation: pop-in-from-right 0.4s; }
|
||||
html.default.from-has-menu .overlay { -webkit-animation: fade-out 0.4s; animation: fade-out 0.4s; }
|
||||
html.default.from-has-menu header, html.default.from-has-menu footer, html.default.from-has-menu .col-content { -webkit-animation: unshift-to-left 0.4s; animation: unshift-to-left 0.4s; }
|
||||
html.default.from-has-menu .col-menu { -webkit-animation: pop-out-to-right 0.4s; animation: pop-out-to-right 0.4s; }
|
||||
html.default.has-menu body { overflow: hidden; }
|
||||
html.default.has-menu .overlay { visibility: visible; }
|
||||
html.default.has-menu header, html.default.has-menu footer, html.default.has-menu .col-content { -webkit-transform: translate(-25%, 0); transform: translate(-25%, 0); }
|
||||
html.default.has-menu .col-menu { visibility: visible; -webkit-transform: translate(0, 0); transform: translate(0, 0); } }
|
||||
|
||||
.tsd-page-title { padding: 70px 0 20px 0; margin: 0 0 40px 0; background: #fff; box-shadow: 0 0 5px rgba(0, 0, 0, 0.35); }
|
||||
.tsd-page-title h1 { margin: 0; }
|
||||
|
||||
.tsd-breadcrumb { margin: 0; padding: 0; color: #808080; }
|
||||
.tsd-breadcrumb a { color: #808080; text-decoration: none; }
|
||||
.tsd-breadcrumb a:hover { text-decoration: underline; }
|
||||
.tsd-breadcrumb li { display: inline; }
|
||||
.tsd-breadcrumb li:after { content: " / "; }
|
||||
|
||||
html.minimal .container { margin: 0; }
|
||||
html.minimal .container-main { padding-top: 50px; padding-bottom: 0; }
|
||||
html.minimal .content-wrap { padding-left: 300px; }
|
||||
html.minimal .tsd-navigation { position: fixed !important; overflow: auto; -webkit-overflow-scrolling: touch; overflow-scrolling: touch; box-sizing: border-box; z-index: 1; left: 0; top: 40px; bottom: 0; width: 300px; padding: 20px; margin: 0; }
|
||||
html.minimal .tsd-member .tsd-member { margin-left: 0; }
|
||||
html.minimal .tsd-page-toolbar { position: fixed; z-index: 2; }
|
||||
html.minimal #tsd-filter .tsd-filter-group { right: 0; -webkit-transform: none; transform: none; }
|
||||
html.minimal footer { background-color: transparent; }
|
||||
html.minimal footer .container { padding: 0; }
|
||||
html.minimal .tsd-generator { padding: 0; }
|
||||
@media (max-width: 900px) { html.minimal .tsd-navigation { display: none; }
|
||||
html.minimal .content-wrap { padding-left: 0; } }
|
||||
|
||||
dl.tsd-comment-tags { overflow: hidden; }
|
||||
dl.tsd-comment-tags dt { clear: both; float: left; padding: 1px 5px; margin: 0 10px 0 0; border-radius: 4px; border: 1px solid #808080; color: #808080; font-size: 0.8em; font-weight: normal; }
|
||||
dl.tsd-comment-tags dd { margin: 0 0 10px 0; }
|
||||
dl.tsd-comment-tags p { margin: 0; }
|
||||
|
||||
.tsd-panel.tsd-comment .lead { font-size: 1.1em; line-height: 1.333em; margin-bottom: 2em; }
|
||||
.tsd-panel.tsd-comment .lead:last-child { margin-bottom: 0; }
|
||||
|
||||
.toggle-protected .tsd-is-private { display: none; }
|
||||
|
||||
.toggle-public .tsd-is-private, .toggle-public .tsd-is-protected, .toggle-public .tsd-is-private-protected { display: none; }
|
||||
|
||||
.toggle-inherited .tsd-is-inherited { display: none; }
|
||||
|
||||
.toggle-only-exported .tsd-is-not-exported { display: none; }
|
||||
|
||||
.toggle-externals .tsd-is-external { display: none; }
|
||||
|
||||
#tsd-filter { position: relative; display: inline-block; height: 40px; vertical-align: bottom; }
|
||||
.no-filter #tsd-filter { display: none; }
|
||||
#tsd-filter .tsd-filter-group { display: inline-block; height: 40px; vertical-align: bottom; white-space: nowrap; }
|
||||
#tsd-filter input { display: none; }
|
||||
@media (max-width: 900px) { #tsd-filter .tsd-filter-group { display: block; position: absolute; top: 40px; right: 20px; height: auto; background-color: #fff; visibility: hidden; -webkit-transform: translate(50%, 0); transform: translate(50%, 0); box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); }
|
||||
.has-options #tsd-filter .tsd-filter-group { visibility: visible; }
|
||||
.to-has-options #tsd-filter .tsd-filter-group { -webkit-animation: fade-in 0.2s; animation: fade-in 0.2s; }
|
||||
.from-has-options #tsd-filter .tsd-filter-group { -webkit-animation: fade-out 0.2s; animation: fade-out 0.2s; }
|
||||
#tsd-filter label, #tsd-filter .tsd-select { display: block; padding-right: 20px; } }
|
||||
|
||||
footer { border-top: 1px solid #eee; background-color: #fff; }
|
||||
footer.with-border-bottom { border-bottom: 1px solid #eee; }
|
||||
footer .tsd-legend-group { font-size: 0; }
|
||||
footer .tsd-legend { display: inline-block; width: 25%; padding: 0; font-size: 16px; list-style: none; line-height: 1.333em; vertical-align: top; }
|
||||
@media (max-width: 900px) { footer .tsd-legend { width: 50%; } }
|
||||
|
||||
.tsd-hierarchy { list-style: square; padding: 0 0 0 20px; margin: 0; }
|
||||
.tsd-hierarchy .target { font-weight: bold; }
|
||||
|
||||
.tsd-index-panel .tsd-index-content { margin-bottom: -30px !important; }
|
||||
.tsd-index-panel .tsd-index-section { margin-bottom: 30px !important; }
|
||||
.tsd-index-panel h3 { margin: 0 -20px 10px -20px; padding: 0 20px 10px 20px; border-bottom: 1px solid #eee; }
|
||||
.tsd-index-panel ul.tsd-index-list { -webkit-column-count: 3; -moz-column-count: 3; -ms-column-count: 3; -o-column-count: 3; column-count: 3; -webkit-column-gap: 20px; -moz-column-gap: 20px; -ms-column-gap: 20px; -o-column-gap: 20px; column-gap: 20px; padding: 0; list-style: none; line-height: 1.333em; }
|
||||
@media (max-width: 900px) { .tsd-index-panel ul.tsd-index-list { -webkit-column-count: 1; -moz-column-count: 1; -ms-column-count: 1; -o-column-count: 1; column-count: 1; } }
|
||||
@media (min-width: 901px) and (max-width: 1024px) { .tsd-index-panel ul.tsd-index-list { -webkit-column-count: 2; -moz-column-count: 2; -ms-column-count: 2; -o-column-count: 2; column-count: 2; } }
|
||||
.tsd-index-panel ul.tsd-index-list li { -webkit-column-break-inside: avoid; -moz-column-break-inside: avoid; -ms-column-break-inside: avoid; -o-column-break-inside: avoid; column-break-inside: avoid; -webkit-page-break-inside: avoid; -moz-page-break-inside: avoid; -ms-page-break-inside: avoid; -o-page-break-inside: avoid; page-break-inside: avoid; }
|
||||
.tsd-index-panel a, .tsd-index-panel .tsd-parent-kind-module a { color: #9600ff; }
|
||||
.tsd-index-panel .tsd-parent-kind-interface a { color: #7da01f; }
|
||||
.tsd-index-panel .tsd-parent-kind-enum a { color: #cc9900; }
|
||||
.tsd-index-panel .tsd-parent-kind-class a { color: #4da6ff; }
|
||||
.tsd-index-panel .tsd-kind-module a { color: #9600ff; }
|
||||
.tsd-index-panel .tsd-kind-interface a { color: #7da01f; }
|
||||
.tsd-index-panel .tsd-kind-enum a { color: #cc9900; }
|
||||
.tsd-index-panel .tsd-kind-class a { color: #4da6ff; }
|
||||
.tsd-index-panel .tsd-is-private a { color: #808080; }
|
||||
|
||||
.tsd-flag { display: inline-block; padding: 1px 5px; border-radius: 4px; color: #fff; background-color: #808080; text-indent: 0; font-size: 14px; font-weight: normal; }
|
||||
|
||||
.tsd-anchor { position: absolute; top: -100px; }
|
||||
|
||||
.tsd-member { position: relative; }
|
||||
.tsd-member .tsd-anchor + h3 { margin-top: 0; margin-bottom: 0; border-bottom: none; }
|
||||
|
||||
.tsd-navigation { padding: 0 0 0 40px; }
|
||||
.tsd-navigation a { display: block; padding-top: 2px; padding-bottom: 2px; border-left: 2px solid transparent; color: #222; text-decoration: none; transition: border-left-color 0.1s; }
|
||||
.tsd-navigation a:hover { text-decoration: underline; }
|
||||
.tsd-navigation ul { margin: 0; padding: 0; list-style: none; }
|
||||
.tsd-navigation li { padding: 0; }
|
||||
|
||||
.tsd-navigation.primary { padding-bottom: 40px; }
|
||||
.tsd-navigation.primary a { display: block; padding-top: 6px; padding-bottom: 6px; }
|
||||
.tsd-navigation.primary ul li a { padding-left: 5px; }
|
||||
.tsd-navigation.primary ul li li a { padding-left: 25px; }
|
||||
.tsd-navigation.primary ul li li li a { padding-left: 45px; }
|
||||
.tsd-navigation.primary ul li li li li a { padding-left: 65px; }
|
||||
.tsd-navigation.primary ul li li li li li a { padding-left: 85px; }
|
||||
.tsd-navigation.primary ul li li li li li li a { padding-left: 105px; }
|
||||
.tsd-navigation.primary > ul { border-bottom: 1px solid #eee; }
|
||||
.tsd-navigation.primary li { border-top: 1px solid #eee; }
|
||||
.tsd-navigation.primary li.current > a { font-weight: bold; }
|
||||
.tsd-navigation.primary li.label span { display: block; padding: 20px 0 6px 5px; color: #808080; }
|
||||
.tsd-navigation.primary li.globals + li > span, .tsd-navigation.primary li.globals + li > a { padding-top: 20px; }
|
||||
|
||||
.tsd-navigation.secondary ul { transition: opacity 0.2s; }
|
||||
.tsd-navigation.secondary ul li a { padding-left: 25px; }
|
||||
.tsd-navigation.secondary ul li li a { padding-left: 45px; }
|
||||
.tsd-navigation.secondary ul li li li a { padding-left: 65px; }
|
||||
.tsd-navigation.secondary ul li li li li a { padding-left: 85px; }
|
||||
.tsd-navigation.secondary ul li li li li li a { padding-left: 105px; }
|
||||
.tsd-navigation.secondary ul li li li li li li a { padding-left: 125px; }
|
||||
.tsd-navigation.secondary ul.current a { border-left-color: #eee; }
|
||||
.tsd-navigation.secondary li.focus > a, .tsd-navigation.secondary ul.current li.focus > a { border-left-color: #000; }
|
||||
.tsd-navigation.secondary li.current { margin-top: 20px; margin-bottom: 20px; border-left-color: #eee; }
|
||||
.tsd-navigation.secondary li.current > a { font-weight: bold; }
|
||||
|
||||
@media (min-width: 901px) { .menu-sticky-wrap { position: static; }
|
||||
.no-csspositionsticky .menu-sticky-wrap.sticky { position: fixed; }
|
||||
.no-csspositionsticky .menu-sticky-wrap.sticky-current { position: fixed; }
|
||||
.no-csspositionsticky .menu-sticky-wrap.sticky-current ul.before-current, .no-csspositionsticky .menu-sticky-wrap.sticky-current ul.after-current { opacity: 0; }
|
||||
.no-csspositionsticky .menu-sticky-wrap.sticky-bottom { position: absolute; top: auto !important; left: auto !important; bottom: 0; right: 0; }
|
||||
.csspositionsticky .menu-sticky-wrap.sticky { position: -webkit-sticky; position: sticky; }
|
||||
.csspositionsticky .menu-sticky-wrap.sticky-current { position: -webkit-sticky; position: sticky; } }
|
||||
|
||||
.tsd-panel { margin: 20px 0; padding: 20px; background-color: #fff; box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); }
|
||||
.tsd-panel:empty { display: none; }
|
||||
.tsd-panel > h1, .tsd-panel > h2, .tsd-panel > h3 { margin: 1.5em -20px 10px -20px; padding: 0 20px 10px 20px; border-bottom: 1px solid #eee; }
|
||||
.tsd-panel > h1.tsd-before-signature, .tsd-panel > h2.tsd-before-signature, .tsd-panel > h3.tsd-before-signature { margin-bottom: 0; border-bottom: 0; }
|
||||
.tsd-panel table { display: block; width: 100%; overflow: auto; margin-top: 10px; word-break: normal; word-break: keep-all; }
|
||||
.tsd-panel table th { font-weight: bold; }
|
||||
.tsd-panel table th, .tsd-panel table td { padding: 6px 13px; border: 1px solid #ddd; }
|
||||
.tsd-panel table tr { background-color: #fff; border-top: 1px solid #ccc; }
|
||||
.tsd-panel table tr:nth-child(2n) { background-color: #f8f8f8; }
|
||||
|
||||
.tsd-panel-group { margin: 60px 0; }
|
||||
.tsd-panel-group > h1, .tsd-panel-group > h2, .tsd-panel-group > h3 { padding-left: 20px; padding-right: 20px; }
|
||||
|
||||
#tsd-search { transition: background-color 0.2s; }
|
||||
#tsd-search .title { position: relative; z-index: 2; }
|
||||
#tsd-search .field { position: absolute; left: 0; top: 0; right: 40px; height: 40px; }
|
||||
#tsd-search .field input { box-sizing: border-box; position: relative; top: -50px; z-index: 1; width: 100%; padding: 0 10px; opacity: 0; outline: 0; border: 0; background: transparent; color: #222; }
|
||||
#tsd-search .field label { position: absolute; overflow: hidden; right: -40px; }
|
||||
#tsd-search .field input, #tsd-search .title { transition: opacity 0.2s; }
|
||||
#tsd-search .results { position: absolute; visibility: hidden; top: 40px; width: 100%; margin: 0; padding: 0; list-style: none; box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); }
|
||||
#tsd-search .results li { padding: 0 10px; background-color: #fdfdfd; }
|
||||
#tsd-search .results li:nth-child(even) { background-color: #fff; }
|
||||
#tsd-search .results li.state { display: none; }
|
||||
#tsd-search .results li.current, #tsd-search .results li:hover { background-color: #eee; }
|
||||
#tsd-search .results a { display: block; }
|
||||
#tsd-search .results a:before { top: 10px; }
|
||||
#tsd-search .results span.parent { color: #808080; font-weight: normal; }
|
||||
#tsd-search.has-focus { background-color: #eee; }
|
||||
#tsd-search.has-focus .field input { top: 0; opacity: 1; }
|
||||
#tsd-search.has-focus .title { z-index: 0; opacity: 0; }
|
||||
#tsd-search.has-focus .results { visibility: visible; }
|
||||
#tsd-search.loading .results li.state.loading { display: block; }
|
||||
#tsd-search.failure .results li.state.failure { display: block; }
|
||||
|
||||
.tsd-signature { margin: 0 0 1em 0; padding: 10px; border: 1px solid #eee; font-family: Menlo, Monaco, Consolas, "Courier New", monospace; font-size: 14px; }
|
||||
.tsd-signature.tsd-kind-icon { padding-left: 30px; }
|
||||
.tsd-signature.tsd-kind-icon:before { top: 10px; left: 10px; }
|
||||
.tsd-panel > .tsd-signature { margin-left: -20px; margin-right: -20px; border-width: 1px 0; }
|
||||
.tsd-panel > .tsd-signature.tsd-kind-icon { padding-left: 40px; }
|
||||
.tsd-panel > .tsd-signature.tsd-kind-icon:before { left: 20px; }
|
||||
|
||||
.tsd-signature-symbol { color: #808080; font-weight: normal; }
|
||||
|
||||
.tsd-signature-type { font-style: italic; font-weight: normal; }
|
||||
|
||||
.tsd-signatures { padding: 0; margin: 0 0 1em 0; border: 1px solid #eee; }
|
||||
.tsd-signatures .tsd-signature { margin: 0; border-width: 1px 0 0 0; transition: background-color 0.1s; }
|
||||
.tsd-signatures .tsd-signature:first-child { border-top-width: 0; }
|
||||
.tsd-signatures .tsd-signature.current { background-color: #eee; }
|
||||
.tsd-signatures.active > .tsd-signature { cursor: pointer; }
|
||||
.tsd-panel > .tsd-signatures { margin-left: -20px; margin-right: -20px; border-width: 1px 0; }
|
||||
.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon { padding-left: 40px; }
|
||||
.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon:before { left: 20px; }
|
||||
.tsd-panel > a.anchor + .tsd-signatures { border-top-width: 0; margin-top: -20px; }
|
||||
|
||||
ul.tsd-descriptions { position: relative; overflow: hidden; transition: height 0.3s; padding: 0; list-style: none; }
|
||||
ul.tsd-descriptions.active > .tsd-description { display: none; }
|
||||
ul.tsd-descriptions.active > .tsd-description.current { display: block; }
|
||||
ul.tsd-descriptions.active > .tsd-description.fade-in { -webkit-animation: fade-in-delayed 0.3s; animation: fade-in-delayed 0.3s; }
|
||||
ul.tsd-descriptions.active > .tsd-description.fade-out { -webkit-animation: fade-out-delayed 0.3s; animation: fade-out-delayed 0.3s; position: absolute; display: block; top: 0; left: 0; right: 0; opacity: 0; visibility: hidden; }
|
||||
ul.tsd-descriptions h4, ul.tsd-descriptions .tsd-index-panel h3, .tsd-index-panel ul.tsd-descriptions h3 { font-size: 16px; margin: 1em 0 0.5em 0; }
|
||||
|
||||
ul.tsd-parameters, ul.tsd-type-parameters { list-style: square; margin: 0; padding-left: 20px; }
|
||||
ul.tsd-parameters > li.tsd-parameter-siganture, ul.tsd-type-parameters > li.tsd-parameter-siganture { list-style: none; margin-left: -20px; }
|
||||
ul.tsd-parameters h5, ul.tsd-type-parameters h5 { font-size: 16px; margin: 1em 0 0.5em 0; }
|
||||
ul.tsd-parameters .tsd-comment, ul.tsd-type-parameters .tsd-comment { margin-top: -0.5em; }
|
||||
|
||||
.tsd-sources { font-size: 14px; color: #808080; margin: 0 0 1em 0; }
|
||||
.tsd-sources a { color: #808080; text-decoration: underline; }
|
||||
.tsd-sources ul, .tsd-sources p { margin: 0 !important; }
|
||||
.tsd-sources ul { list-style: none; padding: 0; }
|
||||
|
||||
.tsd-page-toolbar { position: absolute; z-index: 1; top: 0; left: 0; width: 100%; height: 40px; color: #333; background: #fff; border-bottom: 1px solid #eee; }
|
||||
.tsd-page-toolbar a { color: #333; text-decoration: none; }
|
||||
.tsd-page-toolbar a.title { font-weight: bold; }
|
||||
.tsd-page-toolbar a.title:hover { text-decoration: underline; }
|
||||
.tsd-page-toolbar .table-wrap { display: table; width: 100%; height: 40px; }
|
||||
.tsd-page-toolbar .table-cell { display: table-cell; position: relative; white-space: nowrap; line-height: 40px; }
|
||||
.tsd-page-toolbar .table-cell:first-child { width: 100%; }
|
||||
|
||||
.tsd-widget:before, .tsd-select .tsd-select-label:before, .tsd-select .tsd-select-list li:before { content: ""; display: inline-block; width: 40px; height: 40px; margin: 0 -8px 0 0; background-image: url(../images/widgets.png); background-repeat: no-repeat; text-indent: -1024px; vertical-align: bottom; }
|
||||
@media (-webkit-min-device-pixel-ratio: 1.5), (min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { .tsd-widget:before, .tsd-select .tsd-select-label:before, .tsd-select .tsd-select-list li:before { background-image: url(../images/widgets@2x.png); background-size: 320px 40px; } }
|
||||
|
||||
.tsd-widget { display: inline-block; overflow: hidden; opacity: 0.6; height: 40px; transition: opacity 0.1s, background-color 0.2s; vertical-align: bottom; cursor: pointer; }
|
||||
.tsd-widget:hover { opacity: 0.8; }
|
||||
.tsd-widget.active { opacity: 1; background-color: #eee; }
|
||||
.tsd-widget.no-caption { width: 40px; }
|
||||
.tsd-widget.no-caption:before { margin: 0; }
|
||||
.tsd-widget.search:before { background-position: 0 0; }
|
||||
.tsd-widget.menu:before { background-position: -40px 0; }
|
||||
.tsd-widget.options:before { background-position: -80px 0; }
|
||||
.tsd-widget.options, .tsd-widget.menu { display: none; }
|
||||
@media (max-width: 900px) { .tsd-widget.options, .tsd-widget.menu { display: inline-block; } }
|
||||
input[type=checkbox] + .tsd-widget:before { background-position: -120px 0; }
|
||||
input[type=checkbox]:checked + .tsd-widget:before { background-position: -160px 0; }
|
||||
|
||||
.tsd-select { position: relative; display: inline-block; height: 40px; transition: opacity 0.1s, background-color 0.2s; vertical-align: bottom; cursor: pointer; }
|
||||
.tsd-select .tsd-select-label { opacity: 0.6; transition: opacity 0.2s; }
|
||||
.tsd-select .tsd-select-label:before { background-position: -240px 0; }
|
||||
.tsd-select.active .tsd-select-label { opacity: 0.8; }
|
||||
.tsd-select.active .tsd-select-list { visibility: visible; opacity: 1; transition-delay: 0s; }
|
||||
.tsd-select .tsd-select-list { position: absolute; visibility: hidden; top: 40px; left: 0; margin: 0; padding: 0; opacity: 0; list-style: none; box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); transition: visibility 0s 0.2s, opacity 0.2s; }
|
||||
.tsd-select .tsd-select-list li { padding: 0 20px 0 0; background-color: #fdfdfd; }
|
||||
.tsd-select .tsd-select-list li:before { background-position: 40px 0; }
|
||||
.tsd-select .tsd-select-list li:nth-child(even) { background-color: #fff; }
|
||||
.tsd-select .tsd-select-list li:hover { background-color: #eee; }
|
||||
.tsd-select .tsd-select-list li.selected:before { background-position: -200px 0; }
|
||||
@media (max-width: 900px) { .tsd-select .tsd-select-list { top: 0; left: auto; right: 100%; margin-right: -5px; }
|
||||
.tsd-select .tsd-select-label:before { background-position: -280px 0; } }
|
||||
|
||||
img { max-width: 100%; }
|
||||
File diff suppressed because one or more lines are too long
Binary file not shown.
|
After Width: | Height: | Size: 9.4 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 28 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 480 B |
Binary file not shown.
|
After Width: | Height: | Size: 855 B |
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -0,0 +1,323 @@
|
|||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>Connection | OpenVidu Browser</title>
|
||||
<meta name="description" content="">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link rel="shortcut icon" href="/img/favicon.ico" type="image/x-icon">
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a style="position: absolute" href="/docs/reference-docs/openvidu-browser/" class="title">
|
||||
<img class="logo-small" style="height: 26px; margin-top: 7px" src="/img/logos/openvidu_vert_grey_bg_transp_cropped.png">
|
||||
</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
||||
<div class="tsd-filter-group">
|
||||
<div class="tsd-select" id="tsd-filter-visibility">
|
||||
<span class="tsd-select-label">All</span>
|
||||
<ul class="tsd-select-list">
|
||||
<li data-value="public">Public</li>
|
||||
<li data-value="protected">Public/Protected</li>
|
||||
<li data-value="private" class="selected">All</li>
|
||||
</ul>
|
||||
</div>
|
||||
<input type="checkbox" id="tsd-filter-inherited" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
||||
<input type="checkbox" id="tsd-filter-only-exported" />
|
||||
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
||||
</div>
|
||||
</div>
|
||||
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../index.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="connection.html">Connection</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class Connection</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-comment">
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Represents each one of the user's connection to the session (the local one and other user's connections).
|
||||
Therefore each <a href="session.html">Session</a> and <a href="stream.html">Stream</a> object has an attribute of type Connection</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">Connection</span>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="connection.html#connectionid" class="tsd-kind-icon">connection<wbr>Id</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="connection.html#creationtime" class="tsd-kind-icon">creation<wbr>Time</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="connection.html#data" class="tsd-kind-icon">data</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="connectionid" class="tsd-anchor"></a>
|
||||
<h3>connection<wbr>Id</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">connection<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Connection.ts#L34">OpenVidu/Connection.ts:34</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Unique identifier of the connection</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="creationtime" class="tsd-anchor"></a>
|
||||
<h3>creation<wbr>Time</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">creation<wbr>Time<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Connection.ts#L39">OpenVidu/Connection.ts:39</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Time when this connection was created (UTC milliseconds)</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="data" class="tsd-anchor"></a>
|
||||
<h3>data</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Connection.ts#L45">OpenVidu/Connection.ts:45</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Data associated to this connection (and therefore to certain user). This is an important field:
|
||||
it allows you to broadcast all the information you want for each user (a username, for example)</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../index.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-enum">
|
||||
<a href="../enums/localrecorderstate.html" class="tsd-kind-icon">Local<wbr>Recorder<wbr>State</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-enum">
|
||||
<a href="../enums/openviduerrorname.html" class="tsd-kind-icon">Open<wbr>Vidu<wbr>Error<wbr>Name</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-enum">
|
||||
<a href="../enums/videoinsertmode.html" class="tsd-kind-icon">Video<wbr>Insert<wbr>Mode</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-class">
|
||||
<a href="connection.html" class="tsd-kind-icon">Connection</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="connection.html#connectionid" class="tsd-kind-icon">connection<wbr>Id</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="connection.html#creationtime" class="tsd-kind-icon">creation<wbr>Time</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="connection.html#data" class="tsd-kind-icon">data</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="connectionevent.html" class="tsd-kind-icon">Connection<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="event.html" class="tsd-kind-icon">Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="localrecorder.html" class="tsd-kind-icon">Local<wbr>Recorder</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="openvidu.html" class="tsd-kind-icon">Open<wbr>Vidu</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="openviduerror.html" class="tsd-kind-icon">Open<wbr>Vidu<wbr>Error</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="publisher.html" class="tsd-kind-icon">Publisher</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="publisherspeakingevent.html" class="tsd-kind-icon">Publisher<wbr>Speaking<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="recordingevent.html" class="tsd-kind-icon">Recording<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="session.html" class="tsd-kind-icon">Session</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="sessiondisconnectedevent.html" class="tsd-kind-icon">Session<wbr>Disconnected<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="signalevent.html" class="tsd-kind-icon">Signal<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="stream.html" class="tsd-kind-icon">Stream</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="streamevent.html" class="tsd-kind-icon">Stream<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="subscriber.html" class="tsd-kind-icon">Subscriber</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="videoelementevent.html" class="tsd-kind-icon">Video<wbr>Element<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/device.html" class="tsd-kind-icon">Device</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/eventdispatcher.html" class="tsd-kind-icon">Event<wbr>Dispatcher</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/openviduadvancedconfiguration.html" class="tsd-kind-icon">Open<wbr>Vidu<wbr>Advanced<wbr>Configuration</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/publisherproperties.html" class="tsd-kind-icon">Publisher<wbr>Properties</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/signaloptions.html" class="tsd-kind-icon">Signal<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/subscriberproperties.html" class="tsd-kind-icon">Subscriber<wbr>Properties</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer class="with-border-bottom">
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
|
||||
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
|
||||
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
||||
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
|
||||
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||||
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="container tsd-generator">
|
||||
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,444 @@
|
|||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>ConnectionEvent | OpenVidu Browser</title>
|
||||
<meta name="description" content="">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link rel="shortcut icon" href="/img/favicon.ico" type="image/x-icon">
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a style="position: absolute" href="/docs/reference-docs/openvidu-browser/" class="title">
|
||||
<img class="logo-small" style="height: 26px; margin-top: 7px" src="/img/logos/openvidu_vert_grey_bg_transp_cropped.png">
|
||||
</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
||||
<div class="tsd-filter-group">
|
||||
<div class="tsd-select" id="tsd-filter-visibility">
|
||||
<span class="tsd-select-label">All</span>
|
||||
<ul class="tsd-select-list">
|
||||
<li data-value="public">Public</li>
|
||||
<li data-value="protected">Public/Protected</li>
|
||||
<li data-value="private" class="selected">All</li>
|
||||
</ul>
|
||||
</div>
|
||||
<input type="checkbox" id="tsd-filter-inherited" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
||||
<input type="checkbox" id="tsd-filter-only-exported" />
|
||||
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
||||
</div>
|
||||
</div>
|
||||
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../index.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="connectionevent.html">ConnectionEvent</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class ConnectionEvent</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-comment">
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Defines the following events:</p>
|
||||
<ul>
|
||||
<li><code>connectionCreated</code>: dispatched by <a href="session.html">Session</a></li>
|
||||
<li><code>connectionDestroyed</code>: dispatched by <a href="session.html">Session</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<a href="event.html" class="tsd-signature-type">Event</a>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">ConnectionEvent</span>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="connectionevent.html#cancelable" class="tsd-kind-icon">cancelable</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="connectionevent.html#connection" class="tsd-kind-icon">connection</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="connectionevent.html#reason" class="tsd-kind-icon">reason</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="connectionevent.html#target" class="tsd-kind-icon">target</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="connectionevent.html#type" class="tsd-kind-icon">type</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section tsd-is-inherited">
|
||||
<h3>Methods</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="connectionevent.html#isdefaultprevented" class="tsd-kind-icon">is<wbr>Default<wbr>Prevented</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="connectionevent.html#preventdefault" class="tsd-kind-icon">prevent<wbr>Default</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="cancelable" class="tsd-anchor"></a>
|
||||
<h3>cancelable</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">cancelable<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="event.html">Event</a>.<a href="event.html#cancelable">cancelable</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Events/Event.ts#L25">OpenViduInternal/Events/Event.ts:25</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Whether the event has a default behaviour that may be prevented by calling <a href="event.html#preventdefault">Event.preventDefault</a></p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="connection" class="tsd-anchor"></a>
|
||||
<h3>connection</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">connection<span class="tsd-signature-symbol">:</span> <a href="connection.html" class="tsd-signature-type">Connection</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Events/ConnectionEvent.ts#L32">OpenViduInternal/Events/ConnectionEvent.ts:32</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Connection object that was created or destroyed</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="reason" class="tsd-anchor"></a>
|
||||
<h3>reason</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">reason<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Events/ConnectionEvent.ts#L41">OpenViduInternal/Events/ConnectionEvent.ts:41</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>For 'connectionDestroyed' event:</p>
|
||||
<ul>
|
||||
<li>"disconnect"</li>
|
||||
<li>"networkDisconnect"</li>
|
||||
</ul>
|
||||
</div>
|
||||
<p>For 'connectionCreated' empty string</p>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="target" class="tsd-anchor"></a>
|
||||
<h3>target</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">target<span class="tsd-signature-symbol">:</span> <a href="session.html" class="tsd-signature-type">Session</a><span class="tsd-signature-symbol"> | </span><a href="subscriber.html" class="tsd-signature-type">Subscriber</a><span class="tsd-signature-symbol"> | </span><a href="publisher.html" class="tsd-signature-type">Publisher</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="event.html">Event</a>.<a href="event.html#target">target</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Events/Event.ts#L30">OpenViduInternal/Events/Event.ts:30</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>The object that dispatched the event</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="type" class="tsd-anchor"></a>
|
||||
<h3>type</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="event.html">Event</a>.<a href="event.html#type">type</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Events/Event.ts#L35">OpenViduInternal/Events/Event.ts:35</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>The type of event. This is the same string you pass as first parameter when calling method <code>on()</code> of any object implementing <a href="../interfaces/eventdispatcher.html">EventDispatcher</a> interface</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
|
||||
<h2>Methods</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="isdefaultprevented" class="tsd-anchor"></a>
|
||||
<h3>is<wbr>Default<wbr>Prevented</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">is<wbr>Default<wbr>Prevented<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="event.html">Event</a>.<a href="event.html#isdefaultprevented">isDefaultPrevented</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Events/Event.ts#L51">OpenViduInternal/Events/Event.ts:51</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Whether the default beahivour of the event has been prevented or not. Call <a href="event.html#preventdefault">Event.preventDefault</a> to prevent it</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="preventdefault" class="tsd-anchor"></a>
|
||||
<h3>prevent<wbr>Default</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">prevent<wbr>Default<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="event.html">Event</a>.<a href="event.html#preventdefault">preventDefault</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Events/Event.ts#L62">OpenViduInternal/Events/Event.ts:62</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Prevents the default behaviour of the event. The following events have a default behaviour:</p>
|
||||
<ul>
|
||||
<li><code>sessionDisconnected</code>: automatically unsubscribes the leaving participant from every Subscriber object of the session (this includes closing the WebRTCPeer connection and disposing all MediaStreamTracks)
|
||||
and also deletes the HTML video element associated to it.</li>
|
||||
<li><code>streamDestroyed</code>: if dispatched by a <a href="publisher.html">Publisher</a> (<em>you</em> have unpublished), automatically stops all media tracks and deletes the HTML video element associated to the stream. If dispatched by <a href="session.html">Session</a>,
|
||||
(<em>other user</em> has unpublished), automatically unsubscribes the proper Subscriber object from the session (this includes closing the WebRTCPeer connection and disposing all MediaStreamTracks) and deletes the HTML video element associated to it.</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../index.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-enum">
|
||||
<a href="../enums/localrecorderstate.html" class="tsd-kind-icon">Local<wbr>Recorder<wbr>State</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-enum">
|
||||
<a href="../enums/openviduerrorname.html" class="tsd-kind-icon">Open<wbr>Vidu<wbr>Error<wbr>Name</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-enum">
|
||||
<a href="../enums/videoinsertmode.html" class="tsd-kind-icon">Video<wbr>Insert<wbr>Mode</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="connection.html" class="tsd-kind-icon">Connection</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-class">
|
||||
<a href="connectionevent.html" class="tsd-kind-icon">Connection<wbr>Event</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="connectionevent.html#cancelable" class="tsd-kind-icon">cancelable</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="connectionevent.html#connection" class="tsd-kind-icon">connection</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="connectionevent.html#reason" class="tsd-kind-icon">reason</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="connectionevent.html#target" class="tsd-kind-icon">target</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="connectionevent.html#type" class="tsd-kind-icon">type</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="connectionevent.html#isdefaultprevented" class="tsd-kind-icon">is<wbr>Default<wbr>Prevented</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="connectionevent.html#preventdefault" class="tsd-kind-icon">prevent<wbr>Default</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="event.html" class="tsd-kind-icon">Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="localrecorder.html" class="tsd-kind-icon">Local<wbr>Recorder</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="openvidu.html" class="tsd-kind-icon">Open<wbr>Vidu</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="openviduerror.html" class="tsd-kind-icon">Open<wbr>Vidu<wbr>Error</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="publisher.html" class="tsd-kind-icon">Publisher</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="publisherspeakingevent.html" class="tsd-kind-icon">Publisher<wbr>Speaking<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="recordingevent.html" class="tsd-kind-icon">Recording<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="session.html" class="tsd-kind-icon">Session</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="sessiondisconnectedevent.html" class="tsd-kind-icon">Session<wbr>Disconnected<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="signalevent.html" class="tsd-kind-icon">Signal<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="stream.html" class="tsd-kind-icon">Stream</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="streamevent.html" class="tsd-kind-icon">Stream<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="subscriber.html" class="tsd-kind-icon">Subscriber</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="videoelementevent.html" class="tsd-kind-icon">Video<wbr>Element<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/device.html" class="tsd-kind-icon">Device</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/eventdispatcher.html" class="tsd-kind-icon">Event<wbr>Dispatcher</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/openviduadvancedconfiguration.html" class="tsd-kind-icon">Open<wbr>Vidu<wbr>Advanced<wbr>Configuration</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/publisherproperties.html" class="tsd-kind-icon">Publisher<wbr>Properties</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/signaloptions.html" class="tsd-kind-icon">Signal<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/subscriberproperties.html" class="tsd-kind-icon">Subscriber<wbr>Properties</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer class="with-border-bottom">
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
|
||||
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
|
||||
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
||||
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
|
||||
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||||
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="container tsd-generator">
|
||||
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,424 @@
|
|||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>Event | OpenVidu Browser</title>
|
||||
<meta name="description" content="">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link rel="shortcut icon" href="/img/favicon.ico" type="image/x-icon">
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a style="position: absolute" href="/docs/reference-docs/openvidu-browser/" class="title">
|
||||
<img class="logo-small" style="height: 26px; margin-top: 7px" src="/img/logos/openvidu_vert_grey_bg_transp_cropped.png">
|
||||
</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
||||
<div class="tsd-filter-group">
|
||||
<div class="tsd-select" id="tsd-filter-visibility">
|
||||
<span class="tsd-select-label">All</span>
|
||||
<ul class="tsd-select-list">
|
||||
<li data-value="public">Public</li>
|
||||
<li data-value="protected">Public/Protected</li>
|
||||
<li data-value="private" class="selected">All</li>
|
||||
</ul>
|
||||
</div>
|
||||
<input type="checkbox" id="tsd-filter-inherited" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
||||
<input type="checkbox" id="tsd-filter-only-exported" />
|
||||
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
||||
</div>
|
||||
</div>
|
||||
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../index.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="event.html">Event</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class Event</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">Event</span>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<a href="connectionevent.html" class="tsd-signature-type">ConnectionEvent</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="publisherspeakingevent.html" class="tsd-signature-type">PublisherSpeakingEvent</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="recordingevent.html" class="tsd-signature-type">RecordingEvent</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="sessiondisconnectedevent.html" class="tsd-signature-type">SessionDisconnectedEvent</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="signalevent.html" class="tsd-signature-type">SignalEvent</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="streamevent.html" class="tsd-signature-type">StreamEvent</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="videoelementevent.html" class="tsd-signature-type">VideoElementEvent</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="event.html#cancelable" class="tsd-kind-icon">cancelable</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="event.html#target" class="tsd-kind-icon">target</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="event.html#type" class="tsd-kind-icon">type</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Methods</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="event.html#calldefaultbehaviour" class="tsd-kind-icon">call<wbr>Default<wbr>Behaviour</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="event.html#isdefaultprevented" class="tsd-kind-icon">is<wbr>Default<wbr>Prevented</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="event.html#preventdefault" class="tsd-kind-icon">prevent<wbr>Default</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="cancelable" class="tsd-anchor"></a>
|
||||
<h3>cancelable</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">cancelable<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Events/Event.ts#L25">OpenViduInternal/Events/Event.ts:25</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Whether the event has a default behaviour that may be prevented by calling <a href="event.html#preventdefault">Event.preventDefault</a></p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="target" class="tsd-anchor"></a>
|
||||
<h3>target</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">target<span class="tsd-signature-symbol">:</span> <a href="session.html" class="tsd-signature-type">Session</a><span class="tsd-signature-symbol"> | </span><a href="subscriber.html" class="tsd-signature-type">Subscriber</a><span class="tsd-signature-symbol"> | </span><a href="publisher.html" class="tsd-signature-type">Publisher</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Events/Event.ts#L30">OpenViduInternal/Events/Event.ts:30</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>The object that dispatched the event</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="type" class="tsd-anchor"></a>
|
||||
<h3>type</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Events/Event.ts#L35">OpenViduInternal/Events/Event.ts:35</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>The type of event. This is the same string you pass as first parameter when calling method <code>on()</code> of any object implementing <a href="../interfaces/eventdispatcher.html">EventDispatcher</a> interface</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Methods</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
||||
<a name="calldefaultbehaviour" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagAbstract">Abstract</span> call<wbr>Default<wbr>Behaviour</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
||||
<li class="tsd-signature tsd-kind-icon">call<wbr>Default<wbr>Behaviour<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Events/Event.ts#L68">OpenViduInternal/Events/Event.ts:68</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="isdefaultprevented" class="tsd-anchor"></a>
|
||||
<h3>is<wbr>Default<wbr>Prevented</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">is<wbr>Default<wbr>Prevented<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Events/Event.ts#L51">OpenViduInternal/Events/Event.ts:51</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Whether the default beahivour of the event has been prevented or not. Call <a href="event.html#preventdefault">Event.preventDefault</a> to prevent it</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="preventdefault" class="tsd-anchor"></a>
|
||||
<h3>prevent<wbr>Default</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">prevent<wbr>Default<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Events/Event.ts#L62">OpenViduInternal/Events/Event.ts:62</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Prevents the default behaviour of the event. The following events have a default behaviour:</p>
|
||||
<ul>
|
||||
<li><code>sessionDisconnected</code>: automatically unsubscribes the leaving participant from every Subscriber object of the session (this includes closing the WebRTCPeer connection and disposing all MediaStreamTracks)
|
||||
and also deletes the HTML video element associated to it.</li>
|
||||
<li><code>streamDestroyed</code>: if dispatched by a <a href="publisher.html">Publisher</a> (<em>you</em> have unpublished), automatically stops all media tracks and deletes the HTML video element associated to the stream. If dispatched by <a href="session.html">Session</a>,
|
||||
(<em>other user</em> has unpublished), automatically unsubscribes the proper Subscriber object from the session (this includes closing the WebRTCPeer connection and disposing all MediaStreamTracks) and deletes the HTML video element associated to it.</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../index.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-enum">
|
||||
<a href="../enums/localrecorderstate.html" class="tsd-kind-icon">Local<wbr>Recorder<wbr>State</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-enum">
|
||||
<a href="../enums/openviduerrorname.html" class="tsd-kind-icon">Open<wbr>Vidu<wbr>Error<wbr>Name</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-enum">
|
||||
<a href="../enums/videoinsertmode.html" class="tsd-kind-icon">Video<wbr>Insert<wbr>Mode</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="connection.html" class="tsd-kind-icon">Connection</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="connectionevent.html" class="tsd-kind-icon">Connection<wbr>Event</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-class">
|
||||
<a href="event.html" class="tsd-kind-icon">Event</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="event.html#cancelable" class="tsd-kind-icon">cancelable</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="event.html#target" class="tsd-kind-icon">target</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="event.html#type" class="tsd-kind-icon">type</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
||||
<a href="event.html#calldefaultbehaviour" class="tsd-kind-icon">call<wbr>Default<wbr>Behaviour</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="event.html#isdefaultprevented" class="tsd-kind-icon">is<wbr>Default<wbr>Prevented</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="event.html#preventdefault" class="tsd-kind-icon">prevent<wbr>Default</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="localrecorder.html" class="tsd-kind-icon">Local<wbr>Recorder</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="openvidu.html" class="tsd-kind-icon">Open<wbr>Vidu</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="openviduerror.html" class="tsd-kind-icon">Open<wbr>Vidu<wbr>Error</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="publisher.html" class="tsd-kind-icon">Publisher</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="publisherspeakingevent.html" class="tsd-kind-icon">Publisher<wbr>Speaking<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="recordingevent.html" class="tsd-kind-icon">Recording<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="session.html" class="tsd-kind-icon">Session</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="sessiondisconnectedevent.html" class="tsd-kind-icon">Session<wbr>Disconnected<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="signalevent.html" class="tsd-kind-icon">Signal<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="stream.html" class="tsd-kind-icon">Stream</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="streamevent.html" class="tsd-kind-icon">Stream<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="subscriber.html" class="tsd-kind-icon">Subscriber</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="videoelementevent.html" class="tsd-kind-icon">Video<wbr>Element<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/device.html" class="tsd-kind-icon">Device</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/eventdispatcher.html" class="tsd-kind-icon">Event<wbr>Dispatcher</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/openviduadvancedconfiguration.html" class="tsd-kind-icon">Open<wbr>Vidu<wbr>Advanced<wbr>Configuration</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/publisherproperties.html" class="tsd-kind-icon">Publisher<wbr>Properties</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/signaloptions.html" class="tsd-kind-icon">Signal<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/subscriberproperties.html" class="tsd-kind-icon">Subscriber<wbr>Properties</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer class="with-border-bottom">
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
|
||||
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
|
||||
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
||||
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
|
||||
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||||
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="container tsd-generator">
|
||||
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,589 @@
|
|||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>LocalRecorder | OpenVidu Browser</title>
|
||||
<meta name="description" content="">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link rel="shortcut icon" href="/img/favicon.ico" type="image/x-icon">
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a style="position: absolute" href="/docs/reference-docs/openvidu-browser/" class="title">
|
||||
<img class="logo-small" style="height: 26px; margin-top: 7px" src="/img/logos/openvidu_vert_grey_bg_transp_cropped.png">
|
||||
</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
||||
<div class="tsd-filter-group">
|
||||
<div class="tsd-select" id="tsd-filter-visibility">
|
||||
<span class="tsd-select-label">All</span>
|
||||
<ul class="tsd-select-list">
|
||||
<li data-value="public">Public</li>
|
||||
<li data-value="protected">Public/Protected</li>
|
||||
<li data-value="private" class="selected">All</li>
|
||||
</ul>
|
||||
</div>
|
||||
<input type="checkbox" id="tsd-filter-inherited" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
||||
<input type="checkbox" id="tsd-filter-only-exported" />
|
||||
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
||||
</div>
|
||||
</div>
|
||||
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../index.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="localrecorder.html">LocalRecorder</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class LocalRecorder</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-comment">
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Easy recording of <a href="stream.html">Stream</a> objects straightaway from the browser.</p>
|
||||
</div>
|
||||
<blockquote>
|
||||
<p>WARNING: Performing browser local recording of <strong>remote streams</strong> may cause some troubles. A long waiting time may be required after calling <em>LocalRecorder.stop()</em> in this case</p>
|
||||
</blockquote>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">LocalRecorder</span>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="localrecorder.html#state" class="tsd-kind-icon">state</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Methods</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="localrecorder.html#clean" class="tsd-kind-icon">clean</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="localrecorder.html#download" class="tsd-kind-icon">download</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="localrecorder.html#getblob" class="tsd-kind-icon">get<wbr>Blob</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="localrecorder.html#pause" class="tsd-kind-icon">pause</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="localrecorder.html#preview" class="tsd-kind-icon">preview</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="localrecorder.html#record" class="tsd-kind-icon">record</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="localrecorder.html#resume" class="tsd-kind-icon">resume</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="localrecorder.html#stop" class="tsd-kind-icon">stop</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="localrecorder.html#uploadasbinary" class="tsd-kind-icon">upload<wbr>AsBinary</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="localrecorder.html#uploadasmultipartfile" class="tsd-kind-icon">upload<wbr>AsMultipartfile</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="state" class="tsd-anchor"></a>
|
||||
<h3>state</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">state<span class="tsd-signature-symbol">:</span> <a href="../enums/localrecorderstate.html" class="tsd-signature-type">LocalRecorderState</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/LocalRecorder.ts#L34">OpenVidu/LocalRecorder.ts:34</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Methods</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="clean" class="tsd-anchor"></a>
|
||||
<h3>clean</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">clean<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/LocalRecorder.ts#L225">OpenVidu/LocalRecorder.ts:225</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Gracefully stops and cleans the current recording (WARNING: it is completely dismissed). Sets <a href="localrecorder.html#state">state</a> to <code>READY</code> so the recording can start again</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="download" class="tsd-anchor"></a>
|
||||
<h3>download</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">download<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/LocalRecorder.ts#L244">OpenVidu/LocalRecorder.ts:244</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Downloads the recorded video through the browser. <a href="localrecorder.html#state">state</a> property must be <code>FINISHED</code></p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getblob" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Blob</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Blob<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Blob</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/LocalRecorder.ts#L265">OpenVidu/LocalRecorder.ts:265</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Gets the raw Blob file. Methods preview, download, uploadAsBinary and uploadAsMultipartfile use this same file to perform their specific actions. <a href="localrecorder.html#state">state</a> property must be <code>FINISHED</code></p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Blob</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="pause" class="tsd-anchor"></a>
|
||||
<h3>pause</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">pause<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/LocalRecorder.ts#L157">OpenVidu/LocalRecorder.ts:157</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Pauses the recording of the Stream. <a href="localrecorder.html#state">state</a> property must be <code>RECORDING</code>. After method succeeds is set to <code>PAUSED</code></p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
|
||||
<p>A Promise (to which you can optionally subscribe to) that is resolved if the recording was successfully paused and rejected with an Error object if not</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="preview" class="tsd-anchor"></a>
|
||||
<h3>preview</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">preview<span class="tsd-signature-symbol">(</span>parentElement<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLVideoElement</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/LocalRecorder.ts#L193">OpenVidu/LocalRecorder.ts:193</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Previews the recording, appending a new HTMLVideoElement to element with id <code>parentId</code>. <a href="localrecorder.html#state">state</a> property must be <code>FINISHED</code></p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>parentElement: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">HTMLVideoElement</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="record" class="tsd-anchor"></a>
|
||||
<h3>record</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">record<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/LocalRecorder.ts#L59">OpenVidu/LocalRecorder.ts:59</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Starts the recording of the Stream. <a href="localrecorder.html#state">state</a> property must be <code>READY</code>. After method succeeds is set to <code>RECORDING</code></p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
|
||||
<p>A Promise (to which you can optionally subscribe to) that is resolved if the recording successfully started and rejected with an Error object if not</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="resume" class="tsd-anchor"></a>
|
||||
<h3>resume</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">resume<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/LocalRecorder.ts#L175">OpenVidu/LocalRecorder.ts:175</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Resumes the recording of the Stream. <a href="localrecorder.html#state">state</a> property must be <code>PAUSED</code>. After method succeeds is set to <code>RECORDING</code></p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
|
||||
<p>A Promise (to which you can optionally subscribe to) that is resolved if the recording was successfully resumed and rejected with an Error object if not</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="stop" class="tsd-anchor"></a>
|
||||
<h3>stop</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">stop<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/LocalRecorder.ts#L135">OpenVidu/LocalRecorder.ts:135</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Ends the recording of the Stream. <a href="localrecorder.html#state">state</a> property must be <code>RECORDING</code> or <code>PAUSED</code>. After method succeeds is set to <code>FINISHED</code></p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
|
||||
<p>A Promise (to which you can optionally subscribe to) that is resolved if the recording successfully stopped and rejected with an Error object if not</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="uploadasbinary" class="tsd-anchor"></a>
|
||||
<h3>upload<wbr>AsBinary</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">upload<wbr>AsBinary<span class="tsd-signature-symbol">(</span>endpoint<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, headers<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/LocalRecorder.ts#L284">OpenVidu/LocalRecorder.ts:284</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Uploads the recorded video as a binary file performing an HTTP/POST operation to URL <code>endpoint</code>. <a href="localrecorder.html#state">state</a> property must be <code>FINISHED</code>. Optional HTTP headers can be passed as second parameter. For example:</p>
|
||||
<pre><code><span class="hljs-keyword">var</span> headers = {
|
||||
<span class="hljs-string">"Cookie"</span>: <span class="hljs-string">"<span class="hljs-variable">$Version</span>=1; Skin=new;"</span>,
|
||||
<span class="hljs-string">"Authorization"</span>:<span class="hljs-string">"Basic QWxhZGpbjpuIHNlctZQ=="</span>
|
||||
}
|
||||
</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>endpoint: <span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> headers: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
|
||||
<p>A Promise (to which you can optionally subscribe to) that is resolved with the <code>http.responseText</code> from server if the operation was successful and rejected with the failed <code>http.status</code> if not</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="uploadasmultipartfile" class="tsd-anchor"></a>
|
||||
<h3>upload<wbr>AsMultipartfile</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">upload<wbr>AsMultipartfile<span class="tsd-signature-symbol">(</span>endpoint<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, headers<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/LocalRecorder.ts#L324">OpenVidu/LocalRecorder.ts:324</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Uploads the recorded video as a multipart file performing an HTTP/POST operation to URL <code>endpoint</code>. <a href="localrecorder.html#state">state</a> property must be <code>FINISHED</code>. Optional HTTP headers can be passed as second parameter. For example:</p>
|
||||
<pre><code><span class="hljs-keyword">var</span> headers = {
|
||||
<span class="hljs-string">"Cookie"</span>: <span class="hljs-string">"<span class="hljs-variable">$Version</span>=1; Skin=new;"</span>,
|
||||
<span class="hljs-string">"Authorization"</span>:<span class="hljs-string">"Basic QWxhZGpbjpuIHNlctZQ=="</span>
|
||||
}
|
||||
</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>endpoint: <span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> headers: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
|
||||
<p>A Promise (to which you can optionally subscribe to) that is resolved with the <code>http.responseText</code> from server if the operation was successful and rejected with the failed <code>http.status</code> if not:</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../index.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-enum">
|
||||
<a href="../enums/localrecorderstate.html" class="tsd-kind-icon">Local<wbr>Recorder<wbr>State</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-enum">
|
||||
<a href="../enums/openviduerrorname.html" class="tsd-kind-icon">Open<wbr>Vidu<wbr>Error<wbr>Name</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-enum">
|
||||
<a href="../enums/videoinsertmode.html" class="tsd-kind-icon">Video<wbr>Insert<wbr>Mode</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="connection.html" class="tsd-kind-icon">Connection</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="connectionevent.html" class="tsd-kind-icon">Connection<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="event.html" class="tsd-kind-icon">Event</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-class">
|
||||
<a href="localrecorder.html" class="tsd-kind-icon">Local<wbr>Recorder</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="localrecorder.html#state" class="tsd-kind-icon">state</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="localrecorder.html#clean" class="tsd-kind-icon">clean</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="localrecorder.html#download" class="tsd-kind-icon">download</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="localrecorder.html#getblob" class="tsd-kind-icon">get<wbr>Blob</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="localrecorder.html#pause" class="tsd-kind-icon">pause</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="localrecorder.html#preview" class="tsd-kind-icon">preview</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="localrecorder.html#record" class="tsd-kind-icon">record</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="localrecorder.html#resume" class="tsd-kind-icon">resume</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="localrecorder.html#stop" class="tsd-kind-icon">stop</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="localrecorder.html#uploadasbinary" class="tsd-kind-icon">upload<wbr>AsBinary</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="localrecorder.html#uploadasmultipartfile" class="tsd-kind-icon">upload<wbr>AsMultipartfile</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="openvidu.html" class="tsd-kind-icon">Open<wbr>Vidu</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="openviduerror.html" class="tsd-kind-icon">Open<wbr>Vidu<wbr>Error</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="publisher.html" class="tsd-kind-icon">Publisher</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="publisherspeakingevent.html" class="tsd-kind-icon">Publisher<wbr>Speaking<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="recordingevent.html" class="tsd-kind-icon">Recording<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="session.html" class="tsd-kind-icon">Session</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="sessiondisconnectedevent.html" class="tsd-kind-icon">Session<wbr>Disconnected<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="signalevent.html" class="tsd-kind-icon">Signal<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="stream.html" class="tsd-kind-icon">Stream</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="streamevent.html" class="tsd-kind-icon">Stream<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="subscriber.html" class="tsd-kind-icon">Subscriber</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="videoelementevent.html" class="tsd-kind-icon">Video<wbr>Element<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/device.html" class="tsd-kind-icon">Device</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/eventdispatcher.html" class="tsd-kind-icon">Event<wbr>Dispatcher</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/openviduadvancedconfiguration.html" class="tsd-kind-icon">Open<wbr>Vidu<wbr>Advanced<wbr>Configuration</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/publisherproperties.html" class="tsd-kind-icon">Publisher<wbr>Properties</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/signaloptions.html" class="tsd-kind-icon">Signal<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/subscriberproperties.html" class="tsd-kind-icon">Subscriber<wbr>Properties</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer class="with-border-bottom">
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
|
||||
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
|
||||
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
||||
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
|
||||
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||||
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="container tsd-generator">
|
||||
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,825 @@
|
|||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>OpenVidu | OpenVidu Browser</title>
|
||||
<meta name="description" content="">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link rel="shortcut icon" href="/img/favicon.ico" type="image/x-icon">
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a style="position: absolute" href="/docs/reference-docs/openvidu-browser/" class="title">
|
||||
<img class="logo-small" style="height: 26px; margin-top: 7px" src="/img/logos/openvidu_vert_grey_bg_transp_cropped.png">
|
||||
</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
||||
<div class="tsd-filter-group">
|
||||
<div class="tsd-select" id="tsd-filter-visibility">
|
||||
<span class="tsd-select-label">All</span>
|
||||
<ul class="tsd-select-list">
|
||||
<li data-value="public">Public</li>
|
||||
<li data-value="protected">Public/Protected</li>
|
||||
<li data-value="private" class="selected">All</li>
|
||||
</ul>
|
||||
</div>
|
||||
<input type="checkbox" id="tsd-filter-inherited" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
||||
<input type="checkbox" id="tsd-filter-only-exported" />
|
||||
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
||||
</div>
|
||||
</div>
|
||||
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../index.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="openvidu.html">OpenVidu</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class OpenVidu</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-comment">
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Entrypoint of OpenVidu Browser library.
|
||||
Use it to initialize objects of type <a href="session.html">Session</a>, <a href="publisher.html">Publisher</a> and <a href="localrecorder.html">LocalRecorder</a></p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">OpenVidu</span>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Constructors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="openvidu.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Methods</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="openvidu.html#checksystemrequirements" class="tsd-kind-icon">check<wbr>System<wbr>Requirements</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="openvidu.html#enableprodmode" class="tsd-kind-icon">enable<wbr>Prod<wbr>Mode</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="openvidu.html#getdevices" class="tsd-kind-icon">get<wbr>Devices</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="openvidu.html#getusermedia" class="tsd-kind-icon">get<wbr>User<wbr>Media</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="openvidu.html#initlocalrecorder" class="tsd-kind-icon">init<wbr>Local<wbr>Recorder</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="openvidu.html#initpublisher" class="tsd-kind-icon">init<wbr>Publisher</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="openvidu.html#initpublisherasync" class="tsd-kind-icon">init<wbr>Publisher<wbr>Async</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="openvidu.html#initsession" class="tsd-kind-icon">init<wbr>Session</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="openvidu.html#setadvancedconfiguration" class="tsd-kind-icon">set<wbr>Advanced<wbr>Configuration</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Constructors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
||||
<a name="constructor" class="tsd-anchor"></a>
|
||||
<h3>constructor</h3>
|
||||
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">new <wbr>Open<wbr>Vidu<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="openvidu.html" class="tsd-signature-type">OpenVidu</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L57">OpenVidu/OpenVidu.ts:57</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <a href="openvidu.html" class="tsd-signature-type">OpenVidu</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Methods</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="checksystemrequirements" class="tsd-anchor"></a>
|
||||
<h3>check<wbr>System<wbr>Requirements</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">check<wbr>System<wbr>Requirements<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L217">OpenVidu/OpenVidu.ts:217</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Checks if the browser supports OpenVidu</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
||||
<p>1 if the browser supports OpenVidu, 0 otherwise</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="enableprodmode" class="tsd-anchor"></a>
|
||||
<h3>enable<wbr>Prod<wbr>Mode</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">enable<wbr>Prod<wbr>Mode<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L334">OpenVidu/OpenVidu.ts:334</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Disable all logging except error level</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getdevices" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Devices</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Devices<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/device.html" class="tsd-signature-type">Device</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L235">OpenVidu/OpenVidu.ts:235</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Collects information about the media input devices available on the system. You can pass property <code>deviceId</code> of a <a href="../interfaces/device.html">Device</a> object as value of <code>audioSource</code> or <code>videoSource</code> properties in <a href="openvidu.html#initpublisher">initPublisher</a> method</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/device.html" class="tsd-signature-type">Device</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getusermedia" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>User<wbr>Media</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>User<wbr>Media<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../interfaces/publisherproperties.html" class="tsd-signature-type">PublisherProperties</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MediaStream</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L304">OpenVidu/OpenVidu.ts:304</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get a MediaStream object that you can customize before calling <a href="openvidu.html#initpublisher">initPublisher</a> (pass <em>MediaStreamTrack</em> property of the <em>MediaStream</em> value resolved by the Promise as <code>audioSource</code> or <code>videoSource</code> properties in <a href="openvidu.html#initpublisher">initPublisher</a>)</p>
|
||||
</div>
|
||||
<p>Parameter <code>options</code> is the same as in <a href="openvidu.html#initpublisher">initPublisher</a> second parameter (of type <a href="../interfaces/publisherproperties.html">PublisherProperties</a>), but only the following properties will be applied: <code>audioSource</code>, <code>videoSource</code>, <code>frameRate</code>, <code>resolution</code></p>
|
||||
<p>To customize the Publisher's video, the API for HTMLCanvasElement is very useful. For example, to get a black-and-white video at 10 fps and HD resolution with no sound:</p>
|
||||
<pre><code><span class="hljs-keyword">var</span> OV = <span class="hljs-keyword">new</span> OpenVidu();
|
||||
<span class="hljs-keyword">var</span> FRAME_RATE = <span class="hljs-number">10</span>;
|
||||
|
||||
OV.getUserMedia({
|
||||
audioSource: <span class="hljs-literal">false</span>;
|
||||
videoSource: <span class="hljs-literal">undefined</span>,
|
||||
resolution: <span class="hljs-string">'1280x720'</span>,
|
||||
frameRate: FRAME_RATE
|
||||
})
|
||||
.then(<span class="hljs-function"><span class="hljs-params">mediaStream</span> =></span> {
|
||||
|
||||
<span class="hljs-keyword">var</span> videoTrack = mediaStream.getVideoTracks()[<span class="hljs-number">0</span>];
|
||||
<span class="hljs-keyword">var</span> video = <span class="hljs-built_in">document</span>.createElement(<span class="hljs-string">'video'</span>);
|
||||
video.srcObject = <span class="hljs-keyword">new</span> MediaStream([videoTrack]);
|
||||
|
||||
<span class="hljs-keyword">var</span> canvas = <span class="hljs-built_in">document</span>.createElement(<span class="hljs-string">'canvas'</span>);
|
||||
<span class="hljs-keyword">var</span> ctx = canvas.getContext(<span class="hljs-string">'2d'</span>);
|
||||
ctx.filter = <span class="hljs-string">'grayscale(100%)'</span>;
|
||||
|
||||
video.addEventListener(<span class="hljs-string">'play'</span>, <span class="hljs-function"><span class="hljs-params">()</span> =></span> {
|
||||
<span class="hljs-keyword">var</span> loop = <span class="hljs-function"><span class="hljs-params">()</span> =></span> {
|
||||
<span class="hljs-keyword">if</span> (!video.paused && !video.ended) {
|
||||
ctx.drawImage(video, <span class="hljs-number">0</span>, <span class="hljs-number">0</span>, <span class="hljs-number">300</span>, <span class="hljs-number">170</span>);
|
||||
setTimeout(loop, <span class="hljs-number">1000</span>/ FRAME_RATE); <span class="hljs-comment">// Drawing at 10 fps</span>
|
||||
}
|
||||
};
|
||||
loop();
|
||||
});
|
||||
video.play();
|
||||
|
||||
<span class="hljs-keyword">var</span> grayVideoTrack = canvas.captureStream(FRAME_RATE).getVideoTracks()[<span class="hljs-number">0</span>];
|
||||
<span class="hljs-keyword">var</span> publisher = <span class="hljs-keyword">this</span>.OV.initPublisher(
|
||||
myHtmlTarget,
|
||||
{
|
||||
audioSource: <span class="hljs-literal">false</span>,
|
||||
videoSource: grayVideoTrack
|
||||
});
|
||||
});
|
||||
</code></pre>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>options: <a href="../interfaces/publisherproperties.html" class="tsd-signature-type">PublisherProperties</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MediaStream</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="initlocalrecorder" class="tsd-anchor"></a>
|
||||
<h3>init<wbr>Local<wbr>Recorder</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">init<wbr>Local<wbr>Recorder<span class="tsd-signature-symbol">(</span>stream<span class="tsd-signature-symbol">: </span><a href="stream.html" class="tsd-signature-type">Stream</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="localrecorder.html" class="tsd-signature-type">LocalRecorder</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L208">OpenVidu/OpenVidu.ts:208</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Returns a new local recorder for recording streams straight away from the browser</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>stream: <a href="stream.html" class="tsd-signature-type">Stream</a></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Stream to record</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="localrecorder.html" class="tsd-signature-type">LocalRecorder</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="initpublisher" class="tsd-anchor"></a>
|
||||
<h3>init<wbr>Publisher</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">init<wbr>Publisher<span class="tsd-signature-symbol">(</span>targetElement<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLElement</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="publisher.html" class="tsd-signature-type">Publisher</a></li>
|
||||
<li class="tsd-signature tsd-kind-icon">init<wbr>Publisher<span class="tsd-signature-symbol">(</span>targetElement<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLElement</span>, properties<span class="tsd-signature-symbol">: </span><a href="../interfaces/publisherproperties.html" class="tsd-signature-type">PublisherProperties</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="publisher.html" class="tsd-signature-type">Publisher</a></li>
|
||||
<li class="tsd-signature tsd-kind-icon">init<wbr>Publisher<span class="tsd-signature-symbol">(</span>targetElement<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLElement</span>, completionHandler<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="publisher.html" class="tsd-signature-type">Publisher</a></li>
|
||||
<li class="tsd-signature tsd-kind-icon">init<wbr>Publisher<span class="tsd-signature-symbol">(</span>targetElement<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLElement</span>, properties<span class="tsd-signature-symbol">: </span><a href="../interfaces/publisherproperties.html" class="tsd-signature-type">PublisherProperties</a>, completionHandler<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="publisher.html" class="tsd-signature-type">Publisher</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L88">OpenVidu/OpenVidu.ts:88</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Returns a new publisher</p>
|
||||
</div>
|
||||
<h4 id="events-dispatched">Events dispatched</h4>
|
||||
<p>The <a href="publisher.html">Publisher</a> object will dispatch an <code>accessDialogOpened</code> event, only if the pop-up shown by the browser to request permissions for the camera is opened. You can use this event to alert the user about granting permissions
|
||||
for your website. An <code>accessDialogClosed</code> event will also be dispatched after user clicks on "Allow" or "Block" in the pop-up.</p>
|
||||
<p>The <a href="publisher.html">Publisher</a> object will dispatch an <code>accessAllowed</code> or <code>accessDenied</code> event once it has been granted access to the requested input devices or not.</p>
|
||||
<p>The <a href="publisher.html">Publisher</a> object will dispatch a <code>videoElementCreated</code> event once the HTML video element has been added to DOM (if <em>targetElement</em> not null or undefined)</p>
|
||||
<p>The <a href="publisher.html">Publisher</a> object will dispatch a <code>videoPlaying</code> event once the local video starts playing (only if <code>videoElementCreated</code> event has been previously dispatched)</p>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>targetElement: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLElement</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>HTML DOM element (or its <code>id</code> attribute) in which the video element of the Publisher will be inserted (see <a href="../interfaces/publisherproperties.html#insertmode">PublisherProperties.insertMode</a>). If null or undefined no default video will be created for this Publisher
|
||||
(you can always access the native MediaStream object by calling <em>Publisher.stream.getMediaStream()</em> and use it as <em>srcObject</em> of any HTML video element)</p>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="publisher.html" class="tsd-signature-type">Publisher</a></h4>
|
||||
</li>
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L89">OpenVidu/OpenVidu.ts:89</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Returns a new publisher</p>
|
||||
</div>
|
||||
<h4 id="events-dispatched">Events dispatched</h4>
|
||||
<p>The <a href="publisher.html">Publisher</a> object will dispatch an <code>accessDialogOpened</code> event, only if the pop-up shown by the browser to request permissions for the camera is opened. You can use this event to alert the user about granting permissions
|
||||
for your website. An <code>accessDialogClosed</code> event will also be dispatched after user clicks on "Allow" or "Block" in the pop-up.</p>
|
||||
<p>The <a href="publisher.html">Publisher</a> object will dispatch an <code>accessAllowed</code> or <code>accessDenied</code> event once it has been granted access to the requested input devices or not.</p>
|
||||
<p>The <a href="publisher.html">Publisher</a> object will dispatch a <code>videoElementCreated</code> event once the HTML video element has been added to DOM (if <em>targetElement</em> not null or undefined)</p>
|
||||
<p>The <a href="publisher.html">Publisher</a> object will dispatch a <code>videoPlaying</code> event once the local video starts playing (only if <code>videoElementCreated</code> event has been previously dispatched)</p>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>targetElement: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLElement</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>HTML DOM element (or its <code>id</code> attribute) in which the video element of the Publisher will be inserted (see <a href="../interfaces/publisherproperties.html#insertmode">PublisherProperties.insertMode</a>). If null or undefined no default video will be created for this Publisher
|
||||
(you can always access the native MediaStream object by calling <em>Publisher.stream.getMediaStream()</em> and use it as <em>srcObject</em> of any HTML video element)</p>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5>properties: <a href="../interfaces/publisherproperties.html" class="tsd-signature-type">PublisherProperties</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="publisher.html" class="tsd-signature-type">Publisher</a></h4>
|
||||
</li>
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L90">OpenVidu/OpenVidu.ts:90</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Returns a new publisher</p>
|
||||
</div>
|
||||
<h4 id="events-dispatched">Events dispatched</h4>
|
||||
<p>The <a href="publisher.html">Publisher</a> object will dispatch an <code>accessDialogOpened</code> event, only if the pop-up shown by the browser to request permissions for the camera is opened. You can use this event to alert the user about granting permissions
|
||||
for your website. An <code>accessDialogClosed</code> event will also be dispatched after user clicks on "Allow" or "Block" in the pop-up.</p>
|
||||
<p>The <a href="publisher.html">Publisher</a> object will dispatch an <code>accessAllowed</code> or <code>accessDenied</code> event once it has been granted access to the requested input devices or not.</p>
|
||||
<p>The <a href="publisher.html">Publisher</a> object will dispatch a <code>videoElementCreated</code> event once the HTML video element has been added to DOM (if <em>targetElement</em> not null or undefined)</p>
|
||||
<p>The <a href="publisher.html">Publisher</a> object will dispatch a <code>videoPlaying</code> event once the local video starts playing (only if <code>videoElementCreated</code> event has been previously dispatched)</p>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>targetElement: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLElement</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>HTML DOM element (or its <code>id</code> attribute) in which the video element of the Publisher will be inserted (see <a href="../interfaces/publisherproperties.html#insertmode">PublisherProperties.insertMode</a>). If null or undefined no default video will be created for this Publisher
|
||||
(you can always access the native MediaStream object by calling <em>Publisher.stream.getMediaStream()</em> and use it as <em>srcObject</em> of any HTML video element)</p>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5>completionHandler: <span class="tsd-signature-type">function</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p><code>error</code> parameter is null if <code>initPublisher</code> succeeds, and is defined if it fails.
|
||||
<code>completionHandler</code> function is called before the Publisher dispatches an <code>accessAllowed</code> or an <code>accessDenied</code> event</p>
|
||||
</div>
|
||||
</div>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-siganture">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>error: <span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="publisher.html" class="tsd-signature-type">Publisher</a></h4>
|
||||
</li>
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L91">OpenVidu/OpenVidu.ts:91</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Returns a new publisher</p>
|
||||
</div>
|
||||
<h4 id="events-dispatched">Events dispatched</h4>
|
||||
<p>The <a href="publisher.html">Publisher</a> object will dispatch an <code>accessDialogOpened</code> event, only if the pop-up shown by the browser to request permissions for the camera is opened. You can use this event to alert the user about granting permissions
|
||||
for your website. An <code>accessDialogClosed</code> event will also be dispatched after user clicks on "Allow" or "Block" in the pop-up.</p>
|
||||
<p>The <a href="publisher.html">Publisher</a> object will dispatch an <code>accessAllowed</code> or <code>accessDenied</code> event once it has been granted access to the requested input devices or not.</p>
|
||||
<p>The <a href="publisher.html">Publisher</a> object will dispatch a <code>videoElementCreated</code> event once the HTML video element has been added to DOM (if <em>targetElement</em> not null or undefined)</p>
|
||||
<p>The <a href="publisher.html">Publisher</a> object will dispatch a <code>videoPlaying</code> event once the local video starts playing (only if <code>videoElementCreated</code> event has been previously dispatched)</p>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>targetElement: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLElement</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>HTML DOM element (or its <code>id</code> attribute) in which the video element of the Publisher will be inserted (see <a href="../interfaces/publisherproperties.html#insertmode">PublisherProperties.insertMode</a>). If null or undefined no default video will be created for this Publisher
|
||||
(you can always access the native MediaStream object by calling <em>Publisher.stream.getMediaStream()</em> and use it as <em>srcObject</em> of any HTML video element)</p>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5>properties: <a href="../interfaces/publisherproperties.html" class="tsd-signature-type">PublisherProperties</a></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>completionHandler: <span class="tsd-signature-type">function</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p><code>error</code> parameter is null if <code>initPublisher</code> succeeds, and is defined if it fails.
|
||||
<code>completionHandler</code> function is called before the Publisher dispatches an <code>accessAllowed</code> or an <code>accessDenied</code> event</p>
|
||||
</div>
|
||||
</div>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-siganture">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>error: <span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="publisher.html" class="tsd-signature-type">Publisher</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="initpublisherasync" class="tsd-anchor"></a>
|
||||
<h3>init<wbr>Publisher<wbr>Async</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">init<wbr>Publisher<wbr>Async<span class="tsd-signature-symbol">(</span>targetElement<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLElement</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="publisher.html" class="tsd-signature-type">Publisher</a><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">init<wbr>Publisher<wbr>Async<span class="tsd-signature-symbol">(</span>targetElement<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLElement</span>, properties<span class="tsd-signature-symbol">: </span><a href="../interfaces/publisherproperties.html" class="tsd-signature-type">PublisherProperties</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="publisher.html" class="tsd-signature-type">Publisher</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L179">OpenVidu/OpenVidu.ts:179</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Promisified version of <a href="openvidu.html#initpublisher">OpenVidu.initPublisher</a></p>
|
||||
</div>
|
||||
<blockquote>
|
||||
<p>WARNING: events <code>accessDialogOpened</code> and <code>accessDialogClosed</code> will not be dispatched if using this method instead of <a href="openvidu.html#initpublisher">OpenVidu.initPublisher</a></p>
|
||||
</blockquote>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>targetElement: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLElement</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="publisher.html" class="tsd-signature-type">Publisher</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L180">OpenVidu/OpenVidu.ts:180</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>targetElement: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLElement</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>properties: <a href="../interfaces/publisherproperties.html" class="tsd-signature-type">PublisherProperties</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="publisher.html" class="tsd-signature-type">Publisher</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="initsession" class="tsd-anchor"></a>
|
||||
<h3>init<wbr>Session</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">init<wbr>Session<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="session.html" class="tsd-signature-type">Session</a></li>
|
||||
<li class="tsd-signature tsd-kind-icon">init<wbr>Session<span class="tsd-signature-symbol">(</span>sessionId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="session.html" class="tsd-signature-type">Session</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L64">OpenVidu/OpenVidu.ts:64</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Returns a session with id <code>sessionId</code></p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <a href="session.html" class="tsd-signature-type">Session</a></h4>
|
||||
</li>
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L73">OpenVidu/OpenVidu.ts:73</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<hr>
|
||||
<h2 id="deprecated">DEPRECATED</h2>
|
||||
</div>
|
||||
<p><em>No <code>sessionId</code> is required. Now every necessary information is received in <a href="session.html#connect">Session.connect</a></em></p>
|
||||
<hr>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>sessionId: <span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Session unique ID generated in openvidu-server</p>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="session.html" class="tsd-signature-type">Session</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="setadvancedconfiguration" class="tsd-anchor"></a>
|
||||
<h3>set<wbr>Advanced<wbr>Configuration</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">set<wbr>Advanced<wbr>Configuration<span class="tsd-signature-symbol">(</span>configuration<span class="tsd-signature-symbol">: </span><a href="../interfaces/openviduadvancedconfiguration.html" class="tsd-signature-type">OpenViduAdvancedConfiguration</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L349">OpenVidu/OpenVidu.ts:349</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Set OpenVidu advanced configuration options. Currently <code>configuration</code> is an object with the following optional properties (see <a href="../interfaces/openviduadvancedconfiguration.html">OpenViduAdvancedConfiguration</a> for more details):</p>
|
||||
<ul>
|
||||
<li><code>iceServers</code>: set custom STUN/TURN servers to be used by OpenVidu Browser</li>
|
||||
<li><code>screenShareChromeExtension</code>: url to a custom screen share extension for Chrome to be used instead of the default one, based on ours <a href="https://github.com/OpenVidu/openvidu-screen-sharing-chrome-extension">https://github.com/OpenVidu/openvidu-screen-sharing-chrome-extension</a></li>
|
||||
<li><code>publisherSpeakingEventsOptions</code>: custom configuration for the <a href="publisherspeakingevent.html">PublisherSpeakingEvent</a> feature</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>configuration: <a href="../interfaces/openviduadvancedconfiguration.html" class="tsd-signature-type">OpenViduAdvancedConfiguration</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../index.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-enum">
|
||||
<a href="../enums/localrecorderstate.html" class="tsd-kind-icon">Local<wbr>Recorder<wbr>State</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-enum">
|
||||
<a href="../enums/openviduerrorname.html" class="tsd-kind-icon">Open<wbr>Vidu<wbr>Error<wbr>Name</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-enum">
|
||||
<a href="../enums/videoinsertmode.html" class="tsd-kind-icon">Video<wbr>Insert<wbr>Mode</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="connection.html" class="tsd-kind-icon">Connection</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="connectionevent.html" class="tsd-kind-icon">Connection<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="event.html" class="tsd-kind-icon">Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="localrecorder.html" class="tsd-kind-icon">Local<wbr>Recorder</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-class">
|
||||
<a href="openvidu.html" class="tsd-kind-icon">Open<wbr>Vidu</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
||||
<a href="openvidu.html#constructor" class="tsd-kind-icon">constructor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="openvidu.html#checksystemrequirements" class="tsd-kind-icon">check<wbr>System<wbr>Requirements</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="openvidu.html#enableprodmode" class="tsd-kind-icon">enable<wbr>Prod<wbr>Mode</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="openvidu.html#getdevices" class="tsd-kind-icon">get<wbr>Devices</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="openvidu.html#getusermedia" class="tsd-kind-icon">get<wbr>User<wbr>Media</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="openvidu.html#initlocalrecorder" class="tsd-kind-icon">init<wbr>Local<wbr>Recorder</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="openvidu.html#initpublisher" class="tsd-kind-icon">init<wbr>Publisher</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="openvidu.html#initpublisherasync" class="tsd-kind-icon">init<wbr>Publisher<wbr>Async</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="openvidu.html#initsession" class="tsd-kind-icon">init<wbr>Session</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="openvidu.html#setadvancedconfiguration" class="tsd-kind-icon">set<wbr>Advanced<wbr>Configuration</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="openviduerror.html" class="tsd-kind-icon">Open<wbr>Vidu<wbr>Error</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="publisher.html" class="tsd-kind-icon">Publisher</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="publisherspeakingevent.html" class="tsd-kind-icon">Publisher<wbr>Speaking<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="recordingevent.html" class="tsd-kind-icon">Recording<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="session.html" class="tsd-kind-icon">Session</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="sessiondisconnectedevent.html" class="tsd-kind-icon">Session<wbr>Disconnected<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="signalevent.html" class="tsd-kind-icon">Signal<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="stream.html" class="tsd-kind-icon">Stream</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="streamevent.html" class="tsd-kind-icon">Stream<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="subscriber.html" class="tsd-kind-icon">Subscriber</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="videoelementevent.html" class="tsd-kind-icon">Video<wbr>Element<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/device.html" class="tsd-kind-icon">Device</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/eventdispatcher.html" class="tsd-kind-icon">Event<wbr>Dispatcher</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/openviduadvancedconfiguration.html" class="tsd-kind-icon">Open<wbr>Vidu<wbr>Advanced<wbr>Configuration</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/publisherproperties.html" class="tsd-kind-icon">Publisher<wbr>Properties</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/signaloptions.html" class="tsd-kind-icon">Signal<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/subscriberproperties.html" class="tsd-kind-icon">Subscriber<wbr>Properties</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer class="with-border-bottom">
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
|
||||
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
|
||||
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
||||
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
|
||||
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||||
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="container tsd-generator">
|
||||
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,292 @@
|
|||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>OpenViduError | OpenVidu Browser</title>
|
||||
<meta name="description" content="">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link rel="shortcut icon" href="/img/favicon.ico" type="image/x-icon">
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a style="position: absolute" href="/docs/reference-docs/openvidu-browser/" class="title">
|
||||
<img class="logo-small" style="height: 26px; margin-top: 7px" src="/img/logos/openvidu_vert_grey_bg_transp_cropped.png">
|
||||
</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
||||
<div class="tsd-filter-group">
|
||||
<div class="tsd-select" id="tsd-filter-visibility">
|
||||
<span class="tsd-select-label">All</span>
|
||||
<ul class="tsd-select-list">
|
||||
<li data-value="public">Public</li>
|
||||
<li data-value="protected">Public/Protected</li>
|
||||
<li data-value="private" class="selected">All</li>
|
||||
</ul>
|
||||
</div>
|
||||
<input type="checkbox" id="tsd-filter-inherited" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
||||
<input type="checkbox" id="tsd-filter-only-exported" />
|
||||
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
||||
</div>
|
||||
</div>
|
||||
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../index.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="openviduerror.html">OpenViduError</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class OpenViduError</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-comment">
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Simple object to identify runtime errors on the client side</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">OpenViduError</span>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="openviduerror.html#message" class="tsd-kind-icon">message</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="openviduerror.html#name" class="tsd-kind-icon">name</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="message" class="tsd-anchor"></a>
|
||||
<h3>message</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L41">OpenViduInternal/Enums/OpenViduError.ts:41</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="name" class="tsd-anchor"></a>
|
||||
<h3>name</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <a href="../enums/openviduerrorname.html" class="tsd-signature-type">OpenViduErrorName</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L40">OpenViduInternal/Enums/OpenViduError.ts:40</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../index.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-enum">
|
||||
<a href="../enums/localrecorderstate.html" class="tsd-kind-icon">Local<wbr>Recorder<wbr>State</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-enum">
|
||||
<a href="../enums/openviduerrorname.html" class="tsd-kind-icon">Open<wbr>Vidu<wbr>Error<wbr>Name</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-enum">
|
||||
<a href="../enums/videoinsertmode.html" class="tsd-kind-icon">Video<wbr>Insert<wbr>Mode</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="connection.html" class="tsd-kind-icon">Connection</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="connectionevent.html" class="tsd-kind-icon">Connection<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="event.html" class="tsd-kind-icon">Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="localrecorder.html" class="tsd-kind-icon">Local<wbr>Recorder</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="openvidu.html" class="tsd-kind-icon">Open<wbr>Vidu</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-class">
|
||||
<a href="openviduerror.html" class="tsd-kind-icon">Open<wbr>Vidu<wbr>Error</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="openviduerror.html#message" class="tsd-kind-icon">message</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="openviduerror.html#name" class="tsd-kind-icon">name</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="publisher.html" class="tsd-kind-icon">Publisher</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="publisherspeakingevent.html" class="tsd-kind-icon">Publisher<wbr>Speaking<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="recordingevent.html" class="tsd-kind-icon">Recording<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="session.html" class="tsd-kind-icon">Session</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="sessiondisconnectedevent.html" class="tsd-kind-icon">Session<wbr>Disconnected<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="signalevent.html" class="tsd-kind-icon">Signal<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="stream.html" class="tsd-kind-icon">Stream</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="streamevent.html" class="tsd-kind-icon">Stream<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="subscriber.html" class="tsd-kind-icon">Subscriber</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="videoelementevent.html" class="tsd-kind-icon">Video<wbr>Element<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/device.html" class="tsd-kind-icon">Device</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/eventdispatcher.html" class="tsd-kind-icon">Event<wbr>Dispatcher</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/openviduadvancedconfiguration.html" class="tsd-kind-icon">Open<wbr>Vidu<wbr>Advanced<wbr>Configuration</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/publisherproperties.html" class="tsd-kind-icon">Publisher<wbr>Properties</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/signaloptions.html" class="tsd-kind-icon">Signal<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/subscriberproperties.html" class="tsd-kind-icon">Subscriber<wbr>Properties</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer class="with-border-bottom">
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
|
||||
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
|
||||
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
||||
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
|
||||
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||||
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="container tsd-generator">
|
||||
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,628 @@
|
|||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>Publisher | OpenVidu Browser</title>
|
||||
<meta name="description" content="">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link rel="shortcut icon" href="/img/favicon.ico" type="image/x-icon">
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a style="position: absolute" href="/docs/reference-docs/openvidu-browser/" class="title">
|
||||
<img class="logo-small" style="height: 26px; margin-top: 7px" src="/img/logos/openvidu_vert_grey_bg_transp_cropped.png">
|
||||
</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
||||
<div class="tsd-filter-group">
|
||||
<div class="tsd-select" id="tsd-filter-visibility">
|
||||
<span class="tsd-select-label">All</span>
|
||||
<ul class="tsd-select-list">
|
||||
<li data-value="public">Public</li>
|
||||
<li data-value="protected">Public/Protected</li>
|
||||
<li data-value="private" class="selected">All</li>
|
||||
</ul>
|
||||
</div>
|
||||
<input type="checkbox" id="tsd-filter-inherited" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
||||
<input type="checkbox" id="tsd-filter-only-exported" />
|
||||
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
||||
</div>
|
||||
</div>
|
||||
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../index.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="publisher.html">Publisher</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class Publisher</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-comment">
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Packs local media streams. Participants can publish it to a session. Initialized with <a href="openvidu.html#initpublisher">OpenVidu.initPublisher</a> method</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">Publisher</span>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel">
|
||||
<h3>Implements</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li><a href="../interfaces/eventdispatcher.html" class="tsd-signature-type">EventDispatcher</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="publisher.html#accessallowed" class="tsd-kind-icon">access<wbr>Allowed</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="publisher.html#element" class="tsd-kind-icon">element</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="publisher.html#id" class="tsd-kind-icon">id</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="publisher.html#session" class="tsd-kind-icon">session</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="publisher.html#stream" class="tsd-kind-icon">stream</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Methods</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="publisher.html#off" class="tsd-kind-icon">off</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="publisher.html#on" class="tsd-kind-icon">on</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="publisher.html#once" class="tsd-kind-icon">once</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="publisher.html#publishaudio" class="tsd-kind-icon">publish<wbr>Audio</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="publisher.html#publishvideo" class="tsd-kind-icon">publish<wbr>Video</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="publisher.html#subscribetoremote" class="tsd-kind-icon">subscribe<wbr>ToRemote</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="accessallowed" class="tsd-anchor"></a>
|
||||
<h3>access<wbr>Allowed</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">access<wbr>Allowed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Publisher.ts#L38">OpenVidu/Publisher.ts:38</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Whether the Publisher has been granted access to the requested input devices or not</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="element" class="tsd-anchor"></a>
|
||||
<h3>element</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">element<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">HTMLElement</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Publisher.ts#L43">OpenVidu/Publisher.ts:43</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>HTML DOM element in which the Publisher's video has been inserted</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="id" class="tsd-anchor"></a>
|
||||
<h3>id</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Publisher.ts#L48">OpenVidu/Publisher.ts:48</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>DOM id of the Publisher's video element</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="session" class="tsd-anchor"></a>
|
||||
<h3>session</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">session<span class="tsd-signature-symbol">:</span> <a href="session.html" class="tsd-signature-type">Session</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Publisher.ts#L53">OpenVidu/Publisher.ts:53</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>The <a href="session.html">Session</a> to which the Publisher belongs</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="stream" class="tsd-anchor"></a>
|
||||
<h3>stream</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">stream<span class="tsd-signature-symbol">:</span> <a href="stream.html" class="tsd-signature-type">Stream</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Publisher.ts#L58">OpenVidu/Publisher.ts:58</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>The <a href="stream.html">Stream</a> that you are publishing</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Methods</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="off" class="tsd-anchor"></a>
|
||||
<h3>off</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">off<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, handler<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="publisher.html" class="tsd-signature-type">Publisher</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Publisher.ts#L275">OpenVidu/Publisher.ts:275</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>See <a href="../interfaces/eventdispatcher.html#off">EventDispatcher.off</a></p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>type: <span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> handler: <span class="tsd-signature-type">function</span></h5>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-siganture">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="streamevent.html" class="tsd-signature-type">StreamEvent</a><span class="tsd-signature-symbol"> | </span><a href="videoelementevent.html" class="tsd-signature-type">VideoElementEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>event: <a href="streamevent.html" class="tsd-signature-type">StreamEvent</a><span class="tsd-signature-symbol"> | </span><a href="videoelementevent.html" class="tsd-signature-type">VideoElementEvent</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="publisher.html" class="tsd-signature-type">Publisher</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="on" class="tsd-anchor"></a>
|
||||
<h3>on</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, handler<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/eventdispatcher.html" class="tsd-signature-type">EventDispatcher</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Publisher.ts#L125">OpenVidu/Publisher.ts:125</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>See <a href="../interfaces/eventdispatcher.html#on">EventDispatcher.on</a></p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>type: <span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>handler: <span class="tsd-signature-type">function</span></h5>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-siganture">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="streamevent.html" class="tsd-signature-type">StreamEvent</a><span class="tsd-signature-symbol"> | </span><a href="videoelementevent.html" class="tsd-signature-type">VideoElementEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>event: <a href="streamevent.html" class="tsd-signature-type">StreamEvent</a><span class="tsd-signature-symbol"> | </span><a href="videoelementevent.html" class="tsd-signature-type">VideoElementEvent</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="../interfaces/eventdispatcher.html" class="tsd-signature-type">EventDispatcher</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="once" class="tsd-anchor"></a>
|
||||
<h3>once</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">once<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, handler<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="publisher.html" class="tsd-signature-type">Publisher</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Publisher.ts#L200">OpenVidu/Publisher.ts:200</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>See <a href="../interfaces/eventdispatcher.html#once">EventDispatcher.once</a></p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>type: <span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>handler: <span class="tsd-signature-type">function</span></h5>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-siganture">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="streamevent.html" class="tsd-signature-type">StreamEvent</a><span class="tsd-signature-symbol"> | </span><a href="videoelementevent.html" class="tsd-signature-type">VideoElementEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>event: <a href="streamevent.html" class="tsd-signature-type">StreamEvent</a><span class="tsd-signature-symbol"> | </span><a href="videoelementevent.html" class="tsd-signature-type">VideoElementEvent</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="publisher.html" class="tsd-signature-type">Publisher</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="publishaudio" class="tsd-anchor"></a>
|
||||
<h3>publish<wbr>Audio</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">publish<wbr>Audio<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Publisher.ts#L100">OpenVidu/Publisher.ts:100</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Publish or unpublish the audio stream (if available). Calling this method twice in a row passing same value will have no effect</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>value: <span class="tsd-signature-type">boolean</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p><code>true</code> to publish the audio stream, <code>false</code> to unpublish it</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="publishvideo" class="tsd-anchor"></a>
|
||||
<h3>publish<wbr>Video</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">publish<wbr>Video<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Publisher.ts#L109">OpenVidu/Publisher.ts:109</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Publish or unpublish the video stream (if available). Calling this method twice in a row passing same value will have no effect</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>value: <span class="tsd-signature-type">boolean</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p><code>true</code> to publish the video stream, <code>false</code> to unpublish it</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="subscribetoremote" class="tsd-anchor"></a>
|
||||
<h3>subscribe<wbr>ToRemote</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">subscribe<wbr>ToRemote<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Publisher.ts#L117">OpenVidu/Publisher.ts:117</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Call this method before <a href="session.html#publish">Session.publish</a> to subscribe to your Publisher's stream as any other user would do. The local video will be automatically replaced by the remote video</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../index.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-enum">
|
||||
<a href="../enums/localrecorderstate.html" class="tsd-kind-icon">Local<wbr>Recorder<wbr>State</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-enum">
|
||||
<a href="../enums/openviduerrorname.html" class="tsd-kind-icon">Open<wbr>Vidu<wbr>Error<wbr>Name</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-enum">
|
||||
<a href="../enums/videoinsertmode.html" class="tsd-kind-icon">Video<wbr>Insert<wbr>Mode</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="connection.html" class="tsd-kind-icon">Connection</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="connectionevent.html" class="tsd-kind-icon">Connection<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="event.html" class="tsd-kind-icon">Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="localrecorder.html" class="tsd-kind-icon">Local<wbr>Recorder</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="openvidu.html" class="tsd-kind-icon">Open<wbr>Vidu</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="openviduerror.html" class="tsd-kind-icon">Open<wbr>Vidu<wbr>Error</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-class">
|
||||
<a href="publisher.html" class="tsd-kind-icon">Publisher</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="publisher.html#accessallowed" class="tsd-kind-icon">access<wbr>Allowed</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="publisher.html#element" class="tsd-kind-icon">element</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="publisher.html#id" class="tsd-kind-icon">id</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="publisher.html#session" class="tsd-kind-icon">session</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="publisher.html#stream" class="tsd-kind-icon">stream</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="publisher.html#off" class="tsd-kind-icon">off</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="publisher.html#on" class="tsd-kind-icon">on</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="publisher.html#once" class="tsd-kind-icon">once</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="publisher.html#publishaudio" class="tsd-kind-icon">publish<wbr>Audio</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="publisher.html#publishvideo" class="tsd-kind-icon">publish<wbr>Video</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="publisher.html#subscribetoremote" class="tsd-kind-icon">subscribe<wbr>ToRemote</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="publisherspeakingevent.html" class="tsd-kind-icon">Publisher<wbr>Speaking<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="recordingevent.html" class="tsd-kind-icon">Recording<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="session.html" class="tsd-kind-icon">Session</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="sessiondisconnectedevent.html" class="tsd-kind-icon">Session<wbr>Disconnected<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="signalevent.html" class="tsd-kind-icon">Signal<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="stream.html" class="tsd-kind-icon">Stream</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="streamevent.html" class="tsd-kind-icon">Stream<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="subscriber.html" class="tsd-kind-icon">Subscriber</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="videoelementevent.html" class="tsd-kind-icon">Video<wbr>Element<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/device.html" class="tsd-kind-icon">Device</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/eventdispatcher.html" class="tsd-kind-icon">Event<wbr>Dispatcher</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/openviduadvancedconfiguration.html" class="tsd-kind-icon">Open<wbr>Vidu<wbr>Advanced<wbr>Configuration</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/publisherproperties.html" class="tsd-kind-icon">Publisher<wbr>Properties</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/signaloptions.html" class="tsd-kind-icon">Signal<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/subscriberproperties.html" class="tsd-kind-icon">Subscriber<wbr>Properties</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer class="with-border-bottom">
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
|
||||
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
|
||||
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
||||
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
|
||||
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||||
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="container tsd-generator">
|
||||
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,446 @@
|
|||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>PublisherSpeakingEvent | OpenVidu Browser</title>
|
||||
<meta name="description" content="">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link rel="shortcut icon" href="/img/favicon.ico" type="image/x-icon">
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a style="position: absolute" href="/docs/reference-docs/openvidu-browser/" class="title">
|
||||
<img class="logo-small" style="height: 26px; margin-top: 7px" src="/img/logos/openvidu_vert_grey_bg_transp_cropped.png">
|
||||
</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
||||
<div class="tsd-filter-group">
|
||||
<div class="tsd-select" id="tsd-filter-visibility">
|
||||
<span class="tsd-select-label">All</span>
|
||||
<ul class="tsd-select-list">
|
||||
<li data-value="public">Public</li>
|
||||
<li data-value="protected">Public/Protected</li>
|
||||
<li data-value="private" class="selected">All</li>
|
||||
</ul>
|
||||
</div>
|
||||
<input type="checkbox" id="tsd-filter-inherited" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
||||
<input type="checkbox" id="tsd-filter-only-exported" />
|
||||
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
||||
</div>
|
||||
</div>
|
||||
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../index.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="publisherspeakingevent.html">PublisherSpeakingEvent</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class PublisherSpeakingEvent</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-comment">
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Defines the following events:</p>
|
||||
<ul>
|
||||
<li><code>publisherStartSpeaking</code>: dispatched by <a href="session.html">Session</a></li>
|
||||
<li><code>publisherStopSpeaking</code>: dispatched by <a href="session.html">Session</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<p>More information:</p>
|
||||
<ul>
|
||||
<li>This events will only be triggered for <strong>remote streams that have audio tracks</strong></li>
|
||||
<li>Both events share the same lifecycle. That means that you can subscribe to only one of them if you want, but if you call <code>Session.off('publisherStopSpeaking')</code>,
|
||||
keep in mind that this will also internally remove any 'publisherStartSpeaking' event</li>
|
||||
<li>You can further configure how the events are dispatched by setting property <code>publisherSpeakingEventsOptions</code> in the call of <a href="openvidu.html#setadvancedconfiguration">OpenVidu.setAdvancedConfiguration</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<a href="event.html" class="tsd-signature-type">Event</a>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">PublisherSpeakingEvent</span>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="publisherspeakingevent.html#cancelable" class="tsd-kind-icon">cancelable</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="publisherspeakingevent.html#connection" class="tsd-kind-icon">connection</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="publisherspeakingevent.html#streamid" class="tsd-kind-icon">stream<wbr>Id</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="publisherspeakingevent.html#target" class="tsd-kind-icon">target</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="publisherspeakingevent.html#type" class="tsd-kind-icon">type</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section tsd-is-inherited">
|
||||
<h3>Methods</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="publisherspeakingevent.html#isdefaultprevented" class="tsd-kind-icon">is<wbr>Default<wbr>Prevented</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="publisherspeakingevent.html#preventdefault" class="tsd-kind-icon">prevent<wbr>Default</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="cancelable" class="tsd-anchor"></a>
|
||||
<h3>cancelable</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">cancelable<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="event.html">Event</a>.<a href="event.html#cancelable">cancelable</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Events/Event.ts#L25">OpenViduInternal/Events/Event.ts:25</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Whether the event has a default behaviour that may be prevented by calling <a href="event.html#preventdefault">Event.preventDefault</a></p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="connection" class="tsd-anchor"></a>
|
||||
<h3>connection</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">connection<span class="tsd-signature-symbol">:</span> <a href="connection.html" class="tsd-signature-type">Connection</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Events/PublisherSpeakingEvent.ts#L38">OpenViduInternal/Events/PublisherSpeakingEvent.ts:38</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>The client that started or stopped speaking</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="streamid" class="tsd-anchor"></a>
|
||||
<h3>stream<wbr>Id</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">stream<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Events/PublisherSpeakingEvent.ts#L43">OpenViduInternal/Events/PublisherSpeakingEvent.ts:43</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>The streamId of the Stream affected by the speaking event</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="target" class="tsd-anchor"></a>
|
||||
<h3>target</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">target<span class="tsd-signature-symbol">:</span> <a href="session.html" class="tsd-signature-type">Session</a><span class="tsd-signature-symbol"> | </span><a href="subscriber.html" class="tsd-signature-type">Subscriber</a><span class="tsd-signature-symbol"> | </span><a href="publisher.html" class="tsd-signature-type">Publisher</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="event.html">Event</a>.<a href="event.html#target">target</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Events/Event.ts#L30">OpenViduInternal/Events/Event.ts:30</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>The object that dispatched the event</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="type" class="tsd-anchor"></a>
|
||||
<h3>type</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="event.html">Event</a>.<a href="event.html#type">type</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Events/Event.ts#L35">OpenViduInternal/Events/Event.ts:35</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>The type of event. This is the same string you pass as first parameter when calling method <code>on()</code> of any object implementing <a href="../interfaces/eventdispatcher.html">EventDispatcher</a> interface</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
|
||||
<h2>Methods</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="isdefaultprevented" class="tsd-anchor"></a>
|
||||
<h3>is<wbr>Default<wbr>Prevented</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">is<wbr>Default<wbr>Prevented<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="event.html">Event</a>.<a href="event.html#isdefaultprevented">isDefaultPrevented</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Events/Event.ts#L51">OpenViduInternal/Events/Event.ts:51</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Whether the default beahivour of the event has been prevented or not. Call <a href="event.html#preventdefault">Event.preventDefault</a> to prevent it</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="preventdefault" class="tsd-anchor"></a>
|
||||
<h3>prevent<wbr>Default</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">prevent<wbr>Default<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="event.html">Event</a>.<a href="event.html#preventdefault">preventDefault</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Events/Event.ts#L62">OpenViduInternal/Events/Event.ts:62</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Prevents the default behaviour of the event. The following events have a default behaviour:</p>
|
||||
<ul>
|
||||
<li><code>sessionDisconnected</code>: automatically unsubscribes the leaving participant from every Subscriber object of the session (this includes closing the WebRTCPeer connection and disposing all MediaStreamTracks)
|
||||
and also deletes the HTML video element associated to it.</li>
|
||||
<li><code>streamDestroyed</code>: if dispatched by a <a href="publisher.html">Publisher</a> (<em>you</em> have unpublished), automatically stops all media tracks and deletes the HTML video element associated to the stream. If dispatched by <a href="session.html">Session</a>,
|
||||
(<em>other user</em> has unpublished), automatically unsubscribes the proper Subscriber object from the session (this includes closing the WebRTCPeer connection and disposing all MediaStreamTracks) and deletes the HTML video element associated to it.</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../index.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-enum">
|
||||
<a href="../enums/localrecorderstate.html" class="tsd-kind-icon">Local<wbr>Recorder<wbr>State</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-enum">
|
||||
<a href="../enums/openviduerrorname.html" class="tsd-kind-icon">Open<wbr>Vidu<wbr>Error<wbr>Name</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-enum">
|
||||
<a href="../enums/videoinsertmode.html" class="tsd-kind-icon">Video<wbr>Insert<wbr>Mode</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="connection.html" class="tsd-kind-icon">Connection</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="connectionevent.html" class="tsd-kind-icon">Connection<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="event.html" class="tsd-kind-icon">Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="localrecorder.html" class="tsd-kind-icon">Local<wbr>Recorder</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="openvidu.html" class="tsd-kind-icon">Open<wbr>Vidu</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="openviduerror.html" class="tsd-kind-icon">Open<wbr>Vidu<wbr>Error</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="publisher.html" class="tsd-kind-icon">Publisher</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-class">
|
||||
<a href="publisherspeakingevent.html" class="tsd-kind-icon">Publisher<wbr>Speaking<wbr>Event</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="publisherspeakingevent.html#cancelable" class="tsd-kind-icon">cancelable</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="publisherspeakingevent.html#connection" class="tsd-kind-icon">connection</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="publisherspeakingevent.html#streamid" class="tsd-kind-icon">stream<wbr>Id</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="publisherspeakingevent.html#target" class="tsd-kind-icon">target</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="publisherspeakingevent.html#type" class="tsd-kind-icon">type</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="publisherspeakingevent.html#isdefaultprevented" class="tsd-kind-icon">is<wbr>Default<wbr>Prevented</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="publisherspeakingevent.html#preventdefault" class="tsd-kind-icon">prevent<wbr>Default</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="recordingevent.html" class="tsd-kind-icon">Recording<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="session.html" class="tsd-kind-icon">Session</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="sessiondisconnectedevent.html" class="tsd-kind-icon">Session<wbr>Disconnected<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="signalevent.html" class="tsd-kind-icon">Signal<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="stream.html" class="tsd-kind-icon">Stream</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="streamevent.html" class="tsd-kind-icon">Stream<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="subscriber.html" class="tsd-kind-icon">Subscriber</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="videoelementevent.html" class="tsd-kind-icon">Video<wbr>Element<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/device.html" class="tsd-kind-icon">Device</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/eventdispatcher.html" class="tsd-kind-icon">Event<wbr>Dispatcher</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/openviduadvancedconfiguration.html" class="tsd-kind-icon">Open<wbr>Vidu<wbr>Advanced<wbr>Configuration</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/publisherproperties.html" class="tsd-kind-icon">Publisher<wbr>Properties</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/signaloptions.html" class="tsd-kind-icon">Signal<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/subscriberproperties.html" class="tsd-kind-icon">Subscriber<wbr>Properties</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer class="with-border-bottom">
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
|
||||
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
|
||||
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
||||
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
|
||||
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||||
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="container tsd-generator">
|
||||
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
|
||||
</body>
|
||||
</html>
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue