Files
HaishinKit.swift/docs/Classes.html
T
2022-09-17 16:04:54 +09:00

1174 lines
61 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html>
<html lang="en">
<head>
<title>Classes Reference</title>
<link rel="stylesheet" type="text/css" href="css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="css/highlight.css" />
<meta charset='utf-8'>
<script src="js/jquery.min.js" defer></script>
<script src="js/jazzy.js" defer></script>
<script src="js/lunr.min.js" defer></script>
<script src="js/typeahead.jquery.js" defer></script>
<script src="js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Section/Classes" class="dashAnchor"></a>
<a title="Classes Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">HaishinKit 1.3.0 Docs</a> (79% documented)</p>
<div class="header-right">
<form role="search" action="search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</div>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="index.html">HaishinKit Reference</a>
<img id="carat" src="img/carat.png" alt=""/>
Classes Reference
</p>
</div>
<div class="content-wrapper">
<nav class="sidebar">
<ul class="nav-groups">
<li class="nav-group-name">
<a href="Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Classes/AVMixer.html">AVMixer</a>
</li>
<li class="nav-group-task">
<a href="Classes/AVMixer/Option.html"> Option</a>
</li>
<li class="nav-group-task">
<a href="Classes/AVMixer/Option.html"> Option</a>
</li>
<li class="nav-group-task">
<a href="Classes/AVRecorder.html">AVRecorder</a>
</li>
<li class="nav-group-task">
<a href="Classes/AVRecorder/Error.html"> Error</a>
</li>
<li class="nav-group-task">
<a href="Classes/AudioCodec.html">AudioCodec</a>
</li>
<li class="nav-group-task">
<a href="Classes/AudioCodec/Option.html"> Option</a>
</li>
<li class="nav-group-task">
<a href="Classes/AudioCodec/Format.html"> Format</a>
</li>
<li class="nav-group-task">
<a href="Classes/AudioEffect.html">AudioEffect</a>
</li>
<li class="nav-group-task">
<a href="Classes/ByteArray.html">ByteArray</a>
</li>
<li class="nav-group-task">
<a href="Classes/ByteArray/Error.html"> Error</a>
</li>
<li class="nav-group-task">
<a href="Classes/Event.html">Event</a>
</li>
<li class="nav-group-task">
<a href="Classes/Event/Name.html"> Name</a>
</li>
<li class="nav-group-task">
<a href="Classes/EventDispatcher.html">EventDispatcher</a>
</li>
<li class="nav-group-task">
<a href="Classes/FLVReader.html">FLVReader</a>
</li>
<li class="nav-group-task">
<a href="Classes/HKView.html">HKView</a>
</li>
<li class="nav-group-task">
<a href="Classes/HLSService.html">HLSService</a>
</li>
<li class="nav-group-task">
<a href="Classes/HTTPService.html">HTTPService</a>
</li>
<li class="nav-group-task">
<a href="Classes/HTTPStream.html">HTTPStream</a>
</li>
<li class="nav-group-task">
<a href="Classes/MTHKView.html">MTHKView</a>
</li>
<li class="nav-group-task">
<a href="Classes/NetClient.html">NetClient</a>
</li>
<li class="nav-group-task">
<a href="Classes/NetService.html">NetService</a>
</li>
<li class="nav-group-task">
<a href="Classes/NetSocket.html">NetSocket</a>
</li>
<li class="nav-group-task">
<a href="Classes/NetStream.html">NetStream</a>
</li>
<li class="nav-group-task">
<a href="Classes/PiPHKView.html">PiPHKView</a>
</li>
<li class="nav-group-task">
<a href="Classes/PiPHKView.html">PiPHKView</a>
</li>
<li class="nav-group-task">
<a href="Classes/RTMPConnection.html">RTMPConnection</a>
</li>
<li class="nav-group-task">
<a href="Classes/RTMPConnection/Code.html"> Code</a>
</li>
<li class="nav-group-task">
<a href="Classes/RTMPSharedObject.html">RTMPSharedObject</a>
</li>
<li class="nav-group-task">
<a href="Classes/RTMPStream.html">RTMPStream</a>
</li>
<li class="nav-group-task">
<a href="Classes/RTMPStream/Code.html"> Code</a>
</li>
<li class="nav-group-task">
<a href="Classes/RTMPStream/PlayTransition.html"> PlayTransition</a>
</li>
<li class="nav-group-task">
<a href="Classes/RTMPStream/PlayOption.html"> PlayOption</a>
</li>
<li class="nav-group-task">
<a href="Classes/RTMPStream/HowToPublish.html"> HowToPublish</a>
</li>
<li class="nav-group-task">
<a href="Classes/Responder.html">Responder</a>
</li>
<li class="nav-group-task">
<a href="Classes/ScreenCaptureSession.html">ScreenCaptureSession</a>
</li>
<li class="nav-group-task">
<a href="Classes/Setting.html">Setting</a>
</li>
<li class="nav-group-task">
<a href="Classes/TSWriter.html">TSWriter</a>
</li>
<li class="nav-group-task">
<a href="Classes/VideoCodec.html">VideoCodec</a>
</li>
<li class="nav-group-task">
<a href="Classes/VideoCodec/Error.html"> Error</a>
</li>
<li class="nav-group-task">
<a href="Classes/VideoCodec/Option.html"> Option</a>
</li>
<li class="nav-group-task">
<a href="Classes/VideoEffect.html">VideoEffect</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Global%20Variables.html">Global Variables</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Global%20Variables.html#/s:10HaishinKit12kASUndefinedAA0C0Vvp">kASUndefined</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Enums/DeviceUtil.html">DeviceUtil</a>
</li>
<li class="nav-group-task">
<a href="Enums/FLVAACPacketType.html">FLVAACPacketType</a>
</li>
<li class="nav-group-task">
<a href="Enums/FLVAVCPacketType.html">FLVAVCPacketType</a>
</li>
<li class="nav-group-task">
<a href="Enums/FLVAudioCodec.html">FLVAudioCodec</a>
</li>
<li class="nav-group-task">
<a href="Enums/FLVFrameType.html">FLVFrameType</a>
</li>
<li class="nav-group-task">
<a href="Enums/FLVSoundRate.html">FLVSoundRate</a>
</li>
<li class="nav-group-task">
<a href="Enums/FLVSoundSize.html">FLVSoundSize</a>
</li>
<li class="nav-group-task">
<a href="Enums/FLVSoundType.html">FLVSoundType</a>
</li>
<li class="nav-group-task">
<a href="Enums/FLVTagType.html">FLVTagType</a>
</li>
<li class="nav-group-task">
<a href="Enums/FLVVideoCodec.html">FLVVideoCodec</a>
</li>
<li class="nav-group-task">
<a href="Enums/RTMPObjectEncoding.html">RTMPObjectEncoding</a>
</li>
<li class="nav-group-task">
<a href="Enums/ScalingMode.html">ScalingMode</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Extensions/AVMixer.html">AVMixer</a>
</li>
<li class="nav-group-task">
<a href="Extensions/AudioStreamBasicDescription.html">AudioStreamBasicDescription</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Protocols/AVRecorderDelegate.html">AVRecorderDelegate</a>
</li>
<li class="nav-group-task">
<a href="Protocols/AudioCodecDelegate.html">AudioCodecDelegate</a>
</li>
<li class="nav-group-task">
<a href="Protocols/CaptureSessionConvertible.html">CaptureSessionConvertible</a>
</li>
<li class="nav-group-task">
<a href="Protocols/CaptureSessionDelegate.html">CaptureSessionDelegate</a>
</li>
<li class="nav-group-task">
<a href="Protocols/EventDispatcherConvertible.html">EventDispatcherConvertible</a>
</li>
<li class="nav-group-task">
<a href="Protocols/FLVTag.html">FLVTag</a>
</li>
<li class="nav-group-task">
<a href="Protocols/KeyPathRepresentable.html">KeyPathRepresentable</a>
</li>
<li class="nav-group-task">
<a href="Protocols/NetStreamDrawable.html">NetStreamDrawable</a>
</li>
<li class="nav-group-task">
<a href="Protocols/RTMPStreamDelegate.html">RTMPStreamDelegate</a>
</li>
<li class="nav-group-task">
<a href="Protocols/Running.html">Running</a>
</li>
<li class="nav-group-task">
<a href="Protocols/TSWriterDelegate.html">TSWriterDelegate</a>
</li>
<li class="nav-group-task">
<a href="Protocols/VideoCodecDelegate.html">VideoCodecDelegate</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Structs/ASArray.html">ASArray</a>
</li>
<li class="nav-group-task">
<a href="Structs/ASTypedObject.html">ASTypedObject</a>
</li>
<li class="nav-group-task">
<a href="Structs/ASUndefined.html">ASUndefined</a>
</li>
<li class="nav-group-task">
<a href="Structs/ASXML.html">ASXML</a>
</li>
<li class="nav-group-task">
<a href="Structs/ASXMLDocument.html">ASXMLDocument</a>
</li>
<li class="nav-group-task">
<a href="Structs/Atomic.html">Atomic</a>
</li>
<li class="nav-group-task">
<a href="Structs/FLVAudioTag.html">FLVAudioTag</a>
</li>
<li class="nav-group-task">
<a href="Structs/FLVDataTag.html">FLVDataTag</a>
</li>
<li class="nav-group-task">
<a href="Structs/FLVVideoTag.html">FLVVideoTag</a>
</li>
<li class="nav-group-task">
<a href="Structs/HTTPRequest.html">HTTPRequest</a>
</li>
<li class="nav-group-task">
<a href="Structs/HTTPResponse.html">HTTPResponse</a>
</li>
<li class="nav-group-task">
<a href="Structs/RTMPStreamInfo.html">RTMPStreamInfo</a>
</li>
<li class="nav-group-task">
<a href="Structs/SoundTransform.html">SoundTransform</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Typealiases.html#/s:10HaishinKit8ASObjecta">ASObject</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1>Classes</h1>
<p>The following classes are available globally.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/c:@M@HaishinKit@objc(cs)HKView"></a>
<a name="//apple_ref/swift/Class/HKView" class="dashAnchor"></a>
<a class="token" href="#/c:@M@HaishinKit@objc(cs)HKView">HKView</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>A view that displays a video content of a NetStream object which uses AVCaptureVideoPreviewLayer.</p>
<a href="Classes/HKView.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">HKView</span> <span class="p">:</span> <span class="kt">UIView</span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">HKView</span><span class="p">:</span> <span class="kt"><a href="Protocols/NetStreamDrawable.html">NetStreamDrawable</a></span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:@M@HaishinKit@objc(cs)NetStream"></a>
<a name="//apple_ref/swift/Class/NetStream" class="dashAnchor"></a>
<a class="token" href="#/c:@M@HaishinKit@objc(cs)NetStream">NetStream</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The <code>NetStream</code> class is the foundation of a RTMPStream, HTTPStream.</p>
<a href="Classes/NetStream.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">NetStream</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:@M@HaishinKit@objc(cs)ScreenCaptureSession"></a>
<a name="//apple_ref/swift/Class/ScreenCaptureSession" class="dashAnchor"></a>
<a class="token" href="#/c:@M@HaishinKit@objc(cs)ScreenCaptureSession">ScreenCaptureSession</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<a href="Classes/ScreenCaptureSession.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">ScreenCaptureSession</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt"><a href="Protocols/CaptureSessionConvertible.html">CaptureSessionConvertible</a></span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">ScreenCaptureSession</span><span class="p">:</span> <span class="kt"><a href="Protocols/Running.html">Running</a></span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit10AudioCodecC"></a>
<a name="//apple_ref/swift/Class/AudioCodec" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit10AudioCodecC">AudioCodec</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The AudioCodec translate audio data to another format.</p>
<div class="aside aside-seealso">
<p class="aside-title">Seealso</p>
<a href="https://developer.apple.com/library/ios/technotes/tn2236/_index.html">https://developer.apple.com/library/ios/technotes/tn2236/_index.html</a>
</div>
<a href="Classes/AudioCodec.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">AudioCodec</span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">AudioCodec</span><span class="p">:</span> <span class="kt"><a href="Protocols/Running.html">Running</a></span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit10VideoCodecC"></a>
<a name="//apple_ref/swift/Class/VideoCodec" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit10VideoCodecC">VideoCodec</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The VideoCodec class provides methods for encode or decode for video.</p>
<a href="Classes/VideoCodec.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">VideoCodec</span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">VideoCodec</span><span class="p">:</span> <span class="kt"><a href="Protocols/Running.html">Running</a></span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit9FLVReaderC"></a>
<a name="//apple_ref/swift/Class/FLVReader" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit9FLVReaderC">FLVReader</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The FLVReader is used to read the contents of a FLV file.</p>
<a href="Classes/FLVReader.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">FLVReader</span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">FLVReader</span><span class="p">:</span> <span class="kt">IteratorProtocol</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:@M@HaishinKit@objc(cs)HLSService"></a>
<a name="//apple_ref/swift/Class/HLSService" class="dashAnchor"></a>
<a class="token" href="#/c:@M@HaishinKit@objc(cs)HLSService">HLSService</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The HLSService class provide a simple HTTP Live Streaming service.</p>
<a href="Classes/HLSService.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">HLSService</span> <span class="p">:</span> <span class="kt"><a href="Classes/HTTPService.html">HTTPService</a></span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:@M@HaishinKit@objc(cs)HTTPService"></a>
<a name="//apple_ref/swift/Class/HTTPService" class="dashAnchor"></a>
<a class="token" href="#/c:@M@HaishinKit@objc(cs)HTTPService">HTTPService</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The HTTPService class provide a lightweight HTTPServer.</p>
<a href="Classes/HTTPService.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">HTTPService</span> <span class="p">:</span> <span class="kt"><a href="Classes/NetService.html">NetService</a></span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:@M@HaishinKit@objc(cs)HTTPStream"></a>
<a name="//apple_ref/swift/Class/HTTPStream" class="dashAnchor"></a>
<a class="token" href="#/c:@M@HaishinKit@objc(cs)HTTPStream">HTTPStream</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The HTTPStream class represents an HLS playlist and .ts files.</p>
<a href="Classes/HTTPStream.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">HTTPStream</span> <span class="p">:</span> <span class="kt"><a href="Classes/NetStream.html">NetStream</a></span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit7AVMixerC"></a>
<a name="//apple_ref/swift/Class/AVMixer" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit7AVMixerC">AVMixer</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>An object that mixies audio and video for streaming.</p>
<a href="Classes/AVMixer.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">AVMixer</span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">AVMixer</span><span class="p">:</span> <span class="kt"><a href="Protocols/Running.html">Running</a></span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit10AVRecorderC"></a>
<a name="//apple_ref/swift/Class/AVRecorder" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit10AVRecorderC">AVRecorder</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The AVRecorder class represents video and audio recorder.</p>
<a href="Classes/AVRecorder.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">AVRecorder</span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">AVRecorder</span><span class="p">:</span> <span class="kt"><a href="Protocols/Running.html">Running</a></span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:@M@HaishinKit@objc(cs)AudioEffect"></a>
<a name="//apple_ref/swift/Class/AudioEffect" class="dashAnchor"></a>
<a class="token" href="#/c:@M@HaishinKit@objc(cs)AudioEffect">AudioEffect</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>An object that apply an audio effect.</p>
<a href="Classes/AudioEffect.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">AudioEffect</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:@M@HaishinKit@objc(cs)MTHKView"></a>
<a name="//apple_ref/swift/Class/MTHKView" class="dashAnchor"></a>
<a class="token" href="#/c:@M@HaishinKit@objc(cs)MTHKView">MTHKView</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>A view that displays a video content of a NetStream object which uses Metal api.</p>
<a href="Classes/MTHKView.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">MTHKView</span> <span class="p">:</span> <span class="kt">MTKView</span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">MTHKView</span><span class="p">:</span> <span class="kt"><a href="Protocols/NetStreamDrawable.html">NetStreamDrawable</a></span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">MTHKView</span><span class="p">:</span> <span class="kt">MTKViewDelegate</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:@M@HaishinKit@objc(cs)PiPHKView"></a>
<a name="//apple_ref/swift/Class/PiPHKView" class="dashAnchor"></a>
<a class="token" href="#/c:@M@HaishinKit@objc(cs)PiPHKView">PiPHKView</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>A view that displays a video content of a NetStream object which uses AVSampleBufferDisplayLayer api.</p>
<a href="Classes/PiPHKView.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">PiPHKView</span> <span class="p">:</span> <span class="kt">UIView</span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">PiPHKView</span><span class="p">:</span> <span class="kt"><a href="Protocols/NetStreamDrawable.html">NetStreamDrawable</a></span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/"></a>
<a name="//apple_ref/swift/Class/PiPHKView" class="dashAnchor"></a>
<a class="token" href="#/">PiPHKView</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>A view that displays a video content of a NetStream object which uses AVSampleBufferDisplayLayer api.</p>
<a href="Classes/PiPHKView.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:@M@HaishinKit@objc(cs)VideoEffect"></a>
<a name="//apple_ref/swift/Class/VideoEffect" class="dashAnchor"></a>
<a class="token" href="#/c:@M@HaishinKit@objc(cs)VideoEffect">VideoEffect</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>An object that apply a video effect.</p>
<div class="aside aside-seealso">
<p class="aside-title">Seealso</p>
<a href="https://developer.apple.com/documentation/coreimage/processing_an_image_using_built-in_filters">https://developer.apple.com/documentation/coreimage/processing_an_image_using_built-in_filters</a>
</div>
<h2 id='example-code' class='heading'>Example code:</h2>
<pre class="highlight swift"><code><span class="kd">final</span> <span class="kd">class</span> <span class="kt">MonochromeEffect</span><span class="p">:</span> <span class="kt">VideoEffect</span> <span class="p">{</span>
<span class="k">let</span> <span class="nv">filter</span><span class="p">:</span> <span class="kt">CIFilter</span><span class="p">?</span> <span class="o">=</span> <span class="kt">CIFilter</span><span class="p">(</span><span class="nv">name</span><span class="p">:</span> <span class="s">"CIColorMonochrome"</span><span class="p">)</span>
<span class="k">override</span> <span class="kd">func</span> <span class="nf">execute</span><span class="p">(</span><span class="n">_</span> <span class="nv">image</span><span class="p">:</span> <span class="kt">CIImage</span><span class="p">,</span> <span class="nv">info</span><span class="p">:</span> <span class="kt">CMSampleBuffer</span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="kt">CIImage</span> <span class="p">{</span>
<span class="k">guard</span> <span class="k">let</span> <span class="nv">filter</span><span class="p">:</span> <span class="kt">CIFilter</span> <span class="o">=</span> <span class="n">filter</span> <span class="k">else</span> <span class="p">{</span>
<span class="k">return</span> <span class="n">image</span>
<span class="p">}</span>
<span class="n">filter</span><span class="o">.</span><span class="nf">setValue</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="nv">forKey</span><span class="p">:</span> <span class="s">"inputImage"</span><span class="p">)</span>
<span class="n">filter</span><span class="o">.</span><span class="nf">setValue</span><span class="p">(</span><span class="kt">CIColor</span><span class="p">(</span><span class="nv">red</span><span class="p">:</span> <span class="mf">0.75</span><span class="p">,</span> <span class="nv">green</span><span class="p">:</span> <span class="mf">0.75</span><span class="p">,</span> <span class="nv">blue</span><span class="p">:</span> <span class="mf">0.75</span><span class="p">),</span> <span class="nv">forKey</span><span class="p">:</span> <span class="s">"inputColor"</span><span class="p">)</span>
<span class="n">filter</span><span class="o">.</span><span class="nf">setValue</span><span class="p">(</span><span class="mf">1.0</span><span class="p">,</span> <span class="nv">forKey</span><span class="p">:</span> <span class="s">"inputIntensity"</span><span class="p">)</span>
<span class="k">return</span> <span class="n">filter</span><span class="o">.</span><span class="n">outputImage</span> <span class="p">??</span> <span class="n">image</span>
<span class="p">}</span>
<span class="p">}</span>
</code></pre>
<a href="Classes/VideoEffect.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">VideoEffect</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:@M@HaishinKit@objc(cs)NetClient"></a>
<a name="//apple_ref/swift/Class/NetClient" class="dashAnchor"></a>
<a class="token" href="#/c:@M@HaishinKit@objc(cs)NetClient">NetClient</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The NetClient class creates a two-way connection between a NetService.</p>
<a href="Classes/NetClient.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">NetClient</span> <span class="p">:</span> <span class="kt"><a href="Classes/NetSocket.html">NetSocket</a></span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:@M@HaishinKit@objc(cs)NetService"></a>
<a name="//apple_ref/swift/Class/NetService" class="dashAnchor"></a>
<a class="token" href="#/c:@M@HaishinKit@objc(cs)NetService">NetService</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<a href="Classes/NetService.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">NetService</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">NetService</span><span class="p">:</span> <span class="kt">NetServiceDelegate</span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">NetService</span><span class="p">:</span> <span class="kt"><a href="Protocols/Running.html">Running</a></span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:@M@HaishinKit@objc(cs)NetSocket"></a>
<a name="//apple_ref/swift/Class/NetSocket" class="dashAnchor"></a>
<a class="token" href="#/c:@M@HaishinKit@objc(cs)NetSocket">NetSocket</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The NetSocket class creates a two-way connection between a client and a server. This class is wrapper for a InputStream and an OutputStream.</p>
<a href="Classes/NetSocket.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">NetSocket</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">NetSocket</span><span class="p">:</span> <span class="kt">StreamDelegate</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit9ResponderC"></a>
<a name="//apple_ref/swift/Class/Responder" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit9ResponderC">Responder</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>flash.net.Responder for Swift</p>
<a href="Classes/Responder.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">Responder</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit14RTMPConnectionC"></a>
<a name="//apple_ref/swift/Class/RTMPConnection" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit14RTMPConnectionC">RTMPConnection</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The RTMPConneciton class create a two-way RTMP connection.</p>
<a href="Classes/RTMPConnection.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">RTMPConnection</span> <span class="p">:</span> <span class="kt"><a href="Classes/EventDispatcher.html">EventDispatcher</a></span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit16RTMPSharedObjectC"></a>
<a name="//apple_ref/swift/Class/RTMPSharedObject" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit16RTMPSharedObjectC">RTMPSharedObject</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>flash.net.SharedObject for Swift</p>
<a href="Classes/RTMPSharedObject.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">RTMPSharedObject</span> <span class="p">:</span> <span class="kt"><a href="Classes/EventDispatcher.html">EventDispatcher</a></span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">RTMPSharedObject</span><span class="p">:</span> <span class="kt">CustomDebugStringConvertible</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:@M@HaishinKit@objc(cs)RTMPStream"></a>
<a name="//apple_ref/swift/Class/RTMPStream" class="dashAnchor"></a>
<a class="token" href="#/c:@M@HaishinKit@objc(cs)RTMPStream">RTMPStream</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>An object that provides the interface to control a one-way channel over a RtmpConnection.</p>
<a href="Classes/RTMPStream.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">RTMPStream</span> <span class="p">:</span> <span class="kt"><a href="Classes/NetStream.html">NetStream</a></span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">RTMPStream</span><span class="p">:</span> <span class="kt"><a href="Protocols/EventDispatcherConvertible.html">EventDispatcherConvertible</a></span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit8TSWriterC"></a>
<a name="//apple_ref/swift/Class/TSWriter" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit8TSWriterC">TSWriter</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>MPEG-2 TS (Transport Stream) Writer Foundation class</p>
<a href="Classes/TSWriter.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">TSWriter</span> <span class="p">:</span> <span class="kt"><a href="Protocols/Running.html">Running</a></span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">TSWriter</span><span class="p">:</span> <span class="kt"><a href="Protocols/AudioCodecDelegate.html">AudioCodecDelegate</a></span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">TSWriter</span><span class="p">:</span> <span class="kt"><a href="Protocols/VideoCodecDelegate.html">VideoCodecDelegate</a></span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit9ByteArrayC"></a>
<a name="//apple_ref/swift/Class/ByteArray" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit9ByteArrayC">ByteArray</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The ByteArray class provides methods and properties the reading or writing with binary data.</p>
<a href="Classes/ByteArray.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">ByteArray</span> <span class="p">:</span> <span class="kt">ByteArrayConvertible</span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">ByteArray</span><span class="p">:</span> <span class="kt">CustomDebugStringConvertible</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit5EventC"></a>
<a name="//apple_ref/swift/Class/Event" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit5EventC">Event</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The Event interface is used to provide information.</p>
<a href="Classes/Event.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">Event</span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">Event</span><span class="p">:</span> <span class="kt">CustomDebugStringConvertible</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit15EventDispatcherC"></a>
<a name="//apple_ref/swift/Class/EventDispatcher" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit15EventDispatcherC">EventDispatcher</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The EventDispatcher interface is in implementation which supports the DOM Event Model.</p>
<a href="Classes/EventDispatcher.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">EventDispatcher</span> <span class="p">:</span> <span class="kt"><a href="Protocols/EventDispatcherConvertible.html">EventDispatcherConvertible</a></span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit7SettingC"></a>
<a name="//apple_ref/swift/Class/Setting" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit7SettingC">Setting</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<a href="Classes/Setting.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">Setting</span><span class="o">&lt;</span><span class="kt">T</span><span class="p">,</span> <span class="kt">Key</span><span class="o">&gt;</span> <span class="p">:</span> <span class="kt">ExpressibleByDictionaryLiteral</span> <span class="k">where</span> <span class="kt">T</span> <span class="p">:</span> <span class="kt">AnyObject</span><span class="p">,</span> <span class="kt">Key</span> <span class="p">:</span> <span class="kt"><a href="Protocols/KeyPathRepresentable.html">KeyPathRepresentable</a></span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">Setting</span><span class="p">:</span> <span class="kt">CustomDebugStringConvertible</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2022 <a class="link" href="https://github.com/shogo4405/HaishinKit.swift" target="_blank" rel="external noopener">shogo4405</a>. All rights reserved. (Last updated: 2022-09-17)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</html>