Skip to content

Commit

Permalink
Update documents.
Browse files Browse the repository at this point in the history
  • Loading branch information
shogo4405 committed Feb 4, 2024
1 parent d3742a0 commit 1c7e32c
Show file tree
Hide file tree
Showing 19 changed files with 728 additions and 59 deletions.
3 changes: 2 additions & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ ktlint {
}

tasks.dokkaHtmlMultiModule.configure {
outputDirectory.set(file("docs"))
outputDirectory.set(file("docs"))
includes.from("README.md")
}

Original file line number Diff line number Diff line change
Expand Up @@ -58,12 +58,12 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageids="haishinkit::com.haishinkit.media/MediaProjectionSource/MediaProjectionSource/#android.content.Context#android.media.projection.MediaProjection#android.util.DisplayMetrics/PointingToDeclaration//524763335">
<div class="main-content" data-page-type="member" id="content" pageids="haishinkit::com.haishinkit.media/MediaProjectionSource/MediaProjectionSource/#android.content.Context#android.media.projection.MediaProjection/PointingToDeclaration//524763335">
<div class="breadcrumbs"><a href="../../index.html">haishinkit</a><span class="delimiter">/</span><a href="../index.html">com.haishinkit.media</a><span class="delimiter">/</span><a href="index.html">MediaProjectionSource</a><span class="delimiter">/</span><span class="current">MediaProjectionSource</span></div>
<div class="cover ">
<h1 class="cover"><span>Media</span><wbr><span>Projection</span><wbr><span><span>Source</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":haishinkit:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">context<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/android/content/Context.html">Context</a><span class="token punctuation">, </span></span><span class="parameter ">mediaProjection<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/android/media/projection/MediaProjection.html">MediaProjection</a><span class="token punctuation">, </span></span><span class="parameter ">metrics<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/android/util/DisplayMetrics.html">DisplayMetrics</a></span></span><span class="token punctuation">)</span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":haishinkit:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">context<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/android/content/Context.html">Context</a><span class="token punctuation">, </span></span><span class="parameter ">mediaProjection<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/android/media/projection/MediaProjection.html">MediaProjection</a></span></span><span class="token punctuation">)</span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,24 +62,24 @@
<div class="breadcrumbs"><a href="../../index.html">haishinkit</a><span class="delimiter">/</span><a href="../index.html">com.haishinkit.media</a><span class="delimiter">/</span><span class="current">MediaProjectionSource</span></div>
<div class="cover ">
<h1 class="cover"><span>Media</span><wbr><span>Projection</span><wbr><span><span>Source</span></span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":haishinkit:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword">class </span><a href="index.html">MediaProjectionSource</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">context<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/android/content/Context.html">Context</a><span class="token punctuation">, </span></span><span class="parameter ">mediaProjection<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/android/media/projection/MediaProjection.html">MediaProjection</a><span class="token punctuation">, </span></span><span class="parameter ">metrics<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/android/util/DisplayMetrics.html">DisplayMetrics</a></span></span><span class="token punctuation">)</span> : <a href="../-video-source/index.html">VideoSource</a>, <a href="../../com.haishinkit.screen/-video/-on-surface-changed-listener/index.html">Video.OnSurfaceChangedListener</a></div><p class="paragraph">A video source that captures a display by the MediaProjection API.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":haishinkit:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword">class </span><a href="index.html">MediaProjectionSource</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">context<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/android/content/Context.html">Context</a><span class="token punctuation">, </span></span><span class="parameter ">mediaProjection<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/android/media/projection/MediaProjection.html">MediaProjection</a></span></span><span class="token punctuation">)</span> : <a href="../-video-source/index.html">VideoSource</a>, <a href="../../com.haishinkit.screen/-video/-on-surface-changed-listener/index.html">Video.OnSurfaceChangedListener</a></div><p class="paragraph">A video source that captures a display by the MediaProjection API.</p></div></div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
<div class="tabs-section-body">
<div data-togglable="CONSTRUCTOR">
<h2 class="">Constructors</h2>
<div class="table"><a data-name="1164347328%2FConstructors%2F524763335" anchor-label="MediaProjectionSource" id="1164347328%2FConstructors%2F524763335" data-filterable-set=":haishinkit:dokkaHtmlPartial/release"></a>
<div class="table"><a data-name="914162763%2FConstructors%2F524763335" anchor-label="MediaProjectionSource" id="914162763%2FConstructors%2F524763335" data-filterable-set=":haishinkit:dokkaHtmlPartial/release"></a>
<div class="table-row" data-togglable="CONSTRUCTOR" data-filterable-current=":haishinkit:dokkaHtmlPartial/release" data-filterable-set=":haishinkit:dokkaHtmlPartial/release">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-media-projection-source.html"><span>Media</span><wbr><span>Projection</span><wbr><span><span>Source</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1164347328%2FConstructors%2F524763335"></span>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="914162763%2FConstructors%2F524763335"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":haishinkit:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">context<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/android/content/Context.html">Context</a><span class="token punctuation">, </span></span><span class="parameter ">mediaProjection<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/android/media/projection/MediaProjection.html">MediaProjection</a><span class="token punctuation">, </span></span><span class="parameter ">metrics<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/android/util/DisplayMetrics.html">DisplayMetrics</a></span></span><span class="token punctuation">)</span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":haishinkit:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">context<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/android/content/Context.html">Context</a><span class="token punctuation">, </span></span><span class="parameter ">mediaProjection<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/android/media/projection/MediaProjection.html">MediaProjection</a></span></span><span class="token punctuation">)</span></div></div></div>
</div>
</div>
</div>
Expand Down Expand Up @@ -152,21 +152,6 @@ <h2 class="">Properties</h2>
</div>
</div>
</div>
<a data-name="1135814836%2FProperties%2F524763335" anchor-label="scale" id="1135814836%2FProperties%2F524763335" data-filterable-set=":haishinkit:dokkaHtmlPartial/release"></a>
<div class="table-row" data-filterable-current=":haishinkit:dokkaHtmlPartial/release" data-filterable-set=":haishinkit:dokkaHtmlPartial/release">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="scale.html"><span><span>scale</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1135814836%2FProperties%2F524763335"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":haishinkit:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="scale.html">scale</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a></div><div class="brief "><p class="paragraph">Specifies scale that defines a transformation that resizes an image.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1352307216%2FProperties%2F524763335" anchor-label="screen" id="-1352307216%2FProperties%2F524763335" data-filterable-set=":haishinkit:dokkaHtmlPartial/release"></a>
<div class="table-row" data-filterable-current=":haishinkit:dokkaHtmlPartial/release" data-filterable-set=":haishinkit:dokkaHtmlPartial/release">
<div class="main-subrow keyValue ">
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
<!doctype html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>DEFAULT_SCREEN_HEIGHT</title>
<link href="../../../../images/logo-icon.svg" rel="icon" type="image/svg"> <script>var pathToRoot = "../../../../";</script>
<script>document.documentElement.classList.replace("no-js","js");</script>
<script>const storage = localStorage.getItem("dokka-dark-mode")
if (storage == null) {
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</script>
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async></script>
<script type="text/javascript" src="../../../../scripts/sourceset_dependencies.js" async></script>
<link href="../../../../styles/style.css" rel="Stylesheet">
<link href="../../../../styles/main.css" rel="Stylesheet">
<link href="../../../../styles/prism.css" rel="Stylesheet">
<link href="../../../../styles/logo-styles.css" rel="Stylesheet">
<link href="../../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
<script type="text/javascript" src="../../../../scripts/clipboard.js" async></script>
<script type="text/javascript" src="../../../../scripts/navigation-loader.js" async></script>
<script type="text/javascript" src="../../../../scripts/platform-content-handler.js" async></script>
<script type="text/javascript" src="../../../../scripts/main.js" defer></script>
<script type="text/javascript" src="../../../../scripts/prism.js" async></script>
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer></script></head>
<body>
<div class="root">
<nav class="navigation" id="navigation-wrapper">
<div class="navigation--inner">
<div class="navigation-title">
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../../index.html">
HaishinKit.kt
</a> </div>
<div class="library-version">
</div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":haishinkit:dokkaHtmlPartial/release">androidJvm</button>
</div>
</div>
<div class="navigation-controls">
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
</div>
</nav>
<div id="container">
<div class="sidebar" id="leftColumn">
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageids="haishinkit::com.haishinkit.media/Stream.Companion/DEFAULT_SCREEN_HEIGHT/#/PointingToDeclaration//524763335">
<div class="breadcrumbs"><a href="../../../index.html">haishinkit</a><span class="delimiter">/</span><a href="../../index.html">com.haishinkit.media</a><span class="delimiter">/</span><a href="../index.html">Stream</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">DEFAULT_SCREEN_HEIGHT</span></div>
<div class="cover ">
<h1 class="cover"><span><span>DEFAULT_SCREEN_HEIGHT</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":haishinkit:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-d-e-f-a-u-l-t_-s-c-r-e-e-n_-h-e-i-g-h-t.html">DEFAULT_SCREEN_HEIGHT</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token operator"> = </span><span class="token constant">720</span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
</div>
</div>
</div>
</body>
</html>

Loading

0 comments on commit 1c7e32c

Please sign in to comment.