HaishinKit.swift/docs/Classes/Event.html

602 lines
28 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>Event Class 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/Class/Event" class="dashAnchor"></a>
<a title="Event Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">HaishinKit 1.1.2 Docs</a> (16% documented)</p>
<p class="header-right">
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../index.html">HaishinKit Reference</a>
<img id="carat" src="../img/carat.png" />
Event Class 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/ASUndefined.html">ASUndefined</a>
</li>
<li class="nav-group-task">
<a href="../Classes/ASXML.html">ASXML</a>
</li>
<li class="nav-group-task">
<a href="../Classes/ASXMLDocument.html">ASXMLDocument</a>
</li>
<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/AudioConverter.html">AudioConverter</a>
</li>
<li class="nav-group-task">
<a href="../Classes/AudioConverter/Option.html"> Option</a>
</li>
<li class="nav-group-task">
<a href="../Classes/AudioConverter/Destination.html"> Destination</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/DefaultAVRecorderDelegate.html">DefaultAVRecorderDelegate</a>
</li>
<li class="nav-group-task">
<a href="../Classes/DefaultAVRecorderDelegate/FileType.html"> FileType</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/GLHKView.html">GLHKView</a>
</li>
<li class="nav-group-task">
<a href="../Classes/H264Encoder.html">H264Encoder</a>
</li>
<li class="nav-group-task">
<a href="../Classes/H264Encoder/Option.html"> Option</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/MP4Sampler.html">MP4Sampler</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/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/TimerDriver.html">TimerDriver</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:10HaishinKit12kASUndefinedAA0C0Cvp">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/EventPhase.html">EventPhase</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/HKPictureInPicureControllerPosition.html">HKPictureInPicureControllerPosition</a>
</li>
<li class="nav-group-task">
<a href="../Enums/RTMPObjectEncoding.html">RTMPObjectEncoding</a>
</li>
<li class="nav-group-task">
<a href="../Enums/SamplingFrequency.html">SamplingFrequency</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/AudioConverterDelegate.html">AudioConverterDelegate</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/CustomCaptureSession.html">CustomCaptureSession</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/FLVTag.html">FLVTag</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/HKPictureInPicureController.html">HKPictureInPicureController</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/IEventDispatcher.html">IEventDispatcher</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/KeyPathRepresentable.html">KeyPathRepresentable</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/ScreenCaptureOutputPixelBufferDelegate.html">ScreenCaptureOutputPixelBufferDelegate</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/TSWriterDelegate.html">TSWriterDelegate</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/TimerDriverDelegate.html">TimerDriverDelegate</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/VideoEncoderDelegate.html">VideoEncoderDelegate</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/Atomic.html">Atomic</a>
</li>
<li class="nav-group-task">
<a href="../Structs/DeviceUtil.html">DeviceUtil</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/MachUtil.html">MachUtil</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>Event</h1>
<div class="declaration">
<div class="language">
<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>
<p>flash.events.Event for Swift</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit5EventC4NameV"></a>
<a name="//apple_ref/swift/Struct/Name" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit5EventC4NameV">Name</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/Event/Name.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">struct</span> <span class="kt">Name</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="kt">ExpressibleByStringLiteral</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit5EventC4fromyAC10Foundation12NotificationVFZ"></a>
<a name="//apple_ref/swift/Method/from(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit5EventC4fromyAC10Foundation12NotificationVFZ">from(_:<wbr>)</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>
</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">static</span> <span class="kd">func</span> <span class="nf">from</span><span class="p">(</span><span class="n">_</span> <span class="nv">notification</span><span class="p">:</span> <span class="kt">Notification</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Event</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit5EventC4typeAC4NameVvp"></a>
<a name="//apple_ref/swift/Property/type" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit5EventC4typeAC4NameVvp">type</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>
</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="nf">fileprivate</span><span class="p">(</span><span class="k">set</span><span class="p">)</span> <span class="k">var</span> <span class="nv">type</span><span class="p">:</span> <span class="kt"><a href="../Classes/Event/Name.html">Name</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit5EventC7bubblesSbvp"></a>
<a name="//apple_ref/swift/Property/bubbles" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit5EventC7bubblesSbvp">bubbles</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>
</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="nf">fileprivate</span><span class="p">(</span><span class="k">set</span><span class="p">)</span> <span class="k">var</span> <span class="nv">bubbles</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit5EventC4dataypSgvp"></a>
<a name="//apple_ref/swift/Property/data" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit5EventC4dataypSgvp">data</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>
</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="nf">fileprivate</span><span class="p">(</span><span class="k">set</span><span class="p">)</span> <span class="k">var</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Any</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit5EventC6targetyXlSgvp"></a>
<a name="//apple_ref/swift/Property/target" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit5EventC6targetyXlSgvp">target</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>
</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="nf">fileprivate</span><span class="p">(</span><span class="k">set</span><span class="p">)</span> <span class="k">var</span> <span class="nv">target</span><span class="p">:</span> <span class="kt">AnyObject</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit5EventC4type7bubbles4dataA2C4NameV_SbypSgtcfc"></a>
<a name="//apple_ref/swift/Method/init(type:bubbles:data:)" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit5EventC4type7bubbles4dataA2C4NameV_SbypSgtcfc">init(type:<wbr>bubbles:<wbr>data:<wbr>)</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>
</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="nf">init</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span> <span class="kt"><a href="../Classes/Event/Name.html">Name</a></span><span class="p">,</span> <span class="nv">bubbles</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">false</span><span class="p">,</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Any</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<div class="task-name-container">
<a name="/CustomDebugStringConvertible"></a>
<a name="//apple_ref/swift/Section/CustomDebugStringConvertible" class="dashAnchor"></a>
<div class="section-name-container">
<a class="section-name-link" href="#/CustomDebugStringConvertible"></a>
<h3 class="section-name"><p>CustomDebugStringConvertible</p>
</h3>
</div>
</div>
<ul>
<li class="item">
<div>
<code>
<a name="/s:s28CustomDebugStringConvertibleP16debugDescriptionSSvp"></a>
<a name="//apple_ref/swift/Property/debugDescription" class="dashAnchor"></a>
<a class="token" href="#/s:s28CustomDebugStringConvertibleP16debugDescriptionSSvp">debugDescription</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
</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="k">var</span> <span class="nv">debugDescription</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="https://github.com/shogo4405/HaishinKit.swift" target="_blank" rel="external">shogo4405</a>. All rights reserved. (Last updated: 2021-01-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>