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

682 lines
31 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>Protocols 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/Protocols" class="dashAnchor"></a>
<a title="Protocols 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=""/>
Protocols 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>Protocols</h1>
<p>The following protocols are available globally.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit22CaptureSessionDelegateP"></a>
<a name="//apple_ref/swift/Protocol/CaptureSessionDelegate" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit22CaptureSessionDelegateP">CaptureSessionDelegate</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The interface a capture session uses to inform its delegate.</p>
<a href="Protocols/CaptureSessionDelegate.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">protocol</span> <span class="kt">CaptureSessionDelegate</span> <span class="p">:</span> <span class="kt">AnyObject</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit25CaptureSessionConvertibleP"></a>
<a name="//apple_ref/swift/Protocol/CaptureSessionConvertible" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit25CaptureSessionConvertibleP">CaptureSessionConvertible</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="Protocols/CaptureSessionConvertible.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">protocol</span> <span class="kt">CaptureSessionConvertible</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:10HaishinKit18AudioCodecDelegateP"></a>
<a name="//apple_ref/swift/Protocol/AudioCodecDelegate" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit18AudioCodecDelegateP">AudioCodecDelegate</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The interface a AudioCodec uses to inform its delegate.</p>
<a href="Protocols/AudioCodecDelegate.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">protocol</span> <span class="kt">AudioCodecDelegate</span> <span class="p">:</span> <span class="kt">AnyObject</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit18VideoCodecDelegateP"></a>
<a name="//apple_ref/swift/Protocol/VideoCodecDelegate" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit18VideoCodecDelegateP">VideoCodecDelegate</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The interface a VideoCodec uses to inform its delegate.</p>
<a href="Protocols/VideoCodecDelegate.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">protocol</span> <span class="kt">VideoCodecDelegate</span> <span class="p">:</span> <span class="kt">AnyObject</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit6FLVTagP"></a>
<a name="//apple_ref/swift/Protocol/FLVTag" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit6FLVTagP">FLVTag</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The interface of FLV tag.</p>
<a href="Protocols/FLVTag.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">protocol</span> <span class="kt">FLVTag</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:10HaishinKit18AVRecorderDelegateP"></a>
<a name="//apple_ref/swift/Protocol/AVRecorderDelegate" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit18AVRecorderDelegateP">AVRecorderDelegate</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The interface an AVRecorder uses to inform its delegate.</p>
<a href="Protocols/AVRecorderDelegate.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">protocol</span> <span class="kt">AVRecorderDelegate</span> <span class="p">:</span> <span class="kt">AnyObject</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit17NetStreamDrawableP"></a>
<a name="//apple_ref/swift/Protocol/NetStreamDrawable" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit17NetStreamDrawableP">NetStreamDrawable</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>An interface that manages the NetStream content on the screen.</p>
<a href="Protocols/NetStreamDrawable.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">protocol</span> <span class="kt">NetStreamDrawable</span> <span class="p">:</span> <span class="kt">AnyObject</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit18RTMPStreamDelegateP"></a>
<a name="//apple_ref/swift/Protocol/RTMPStreamDelegate" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit18RTMPStreamDelegateP">RTMPStreamDelegate</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The interface a RTMPStream uses to inform its delegate.</p>
<a href="Protocols/RTMPStreamDelegate.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">protocol</span> <span class="kt">RTMPStreamDelegate</span> <span class="p">:</span> <span class="kt">AnyObject</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit16TSWriterDelegateP"></a>
<a name="//apple_ref/swift/Protocol/TSWriterDelegate" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit16TSWriterDelegateP">TSWriterDelegate</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 delegate</p>
<a href="Protocols/TSWriterDelegate.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">protocol</span> <span class="kt">TSWriterDelegate</span> <span class="p">:</span> <span class="kt">AnyObject</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit26EventDispatcherConvertibleP"></a>
<a name="//apple_ref/swift/Protocol/EventDispatcherConvertible" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit26EventDispatcherConvertibleP">EventDispatcherConvertible</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The EventDispatcherConvertible interface is in implementation which supports the DOM Event Model.</p>
<a href="Protocols/EventDispatcherConvertible.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">protocol</span> <span class="kt">EventDispatcherConvertible</span> <span class="p">:</span> <span class="kt">AnyObject</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit7RunningP"></a>
<a name="//apple_ref/swift/Protocol/Running" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit7RunningP">Running</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>A type that methods for running.</p>
<a href="Protocols/Running.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">protocol</span> <span class="kt">Running</span> <span class="p">:</span> <span class="kt">AnyObject</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit20KeyPathRepresentableP"></a>
<a name="//apple_ref/swift/Protocol/KeyPathRepresentable" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit20KeyPathRepresentableP">KeyPathRepresentable</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="Protocols/KeyPathRepresentable.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">protocol</span> <span class="kt">KeyPathRepresentable</span> <span class="p">:</span> <span class="kt">CaseIterable</span><span class="p">,</span> <span class="kt">Hashable</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>