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

1048 lines
54 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>RTMPStream 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/RTMPStream" class="dashAnchor"></a>
<a title="RTMPStream Class 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=""/>
RTMPStream 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/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>RTMPStream</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">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>
<p>An object that provides the interface to control a one-way channel over a RtmpConnection.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit10RTMPStreamC4CodeO"></a>
<a name="//apple_ref/swift/Enum/Code" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit10RTMPStreamC4CodeO">Code</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>NetStatusEvent#info.code for NetStream</p>
<div class="aside aside-seealso">
<p class="aside-title">Seealso</p>
<a href="https://help.adobe.com/en_US/air/reference/html/flash/events/NetStatusEvent.html#NET_STATUS">https://help.adobe.com/en_US/air/reference/html/flash/events/NetStatusEvent.html#NET_STATUS</a>
</div>
<a href="../Classes/RTMPStream/Code.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">enum</span> <span class="kt">Code</span> <span class="p">:</span> <span class="kt">String</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit10RTMPStreamC14PlayTransitionO"></a>
<a name="//apple_ref/swift/Enum/PlayTransition" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit10RTMPStreamC14PlayTransitionO">PlayTransition</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.NetStreamPlayTransitions for Swift</p>
<a href="../Classes/RTMPStream/PlayTransition.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">enum</span> <span class="kt">PlayTransition</span> <span class="p">:</span> <span class="kt">String</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit10RTMPStreamC10PlayOptionV"></a>
<a name="//apple_ref/swift/Struct/PlayOption" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit10RTMPStreamC10PlayOptionV">PlayOption</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/RTMPStream/PlayOption.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">PlayOption</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:10HaishinKit10RTMPStreamC12HowToPublishO"></a>
<a name="//apple_ref/swift/Enum/HowToPublish" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit10RTMPStreamC12HowToPublishO">HowToPublish</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The type of publish options.</p>
<a href="../Classes/RTMPStream/HowToPublish.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">enum</span> <span class="kt">HowToPublish</span> <span class="p">:</span> <span class="kt">String</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit10RTMPStreamC19defaultAudioBitrates6UInt32VvpZ"></a>
<a name="//apple_ref/swift/Variable/defaultAudioBitrate" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit10RTMPStreamC19defaultAudioBitrates6UInt32VvpZ">defaultAudioBitrate</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The default audio bitrate for RTMPStream.</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="k">let</span> <span class="nv">defaultAudioBitrate</span><span class="p">:</span> <span class="kt">UInt32</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit10RTMPStreamC19defaultVideoBitrates6UInt32VvpZ"></a>
<a name="//apple_ref/swift/Variable/defaultVideoBitrate" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit10RTMPStreamC19defaultVideoBitrates6UInt32VvpZ">defaultVideoBitrate</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The default video bitrate for RTMPStream.</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="k">let</span> <span class="nv">defaultVideoBitrate</span><span class="p">:</span> <span class="kt">UInt32</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit10RTMPStreamC8delegateAA0C8Delegate_pSgvp"></a>
<a name="//apple_ref/swift/Property/delegate" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit10RTMPStreamC8delegateAA0C8Delegate_pSgvp">delegate</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Specifies the delegate of the RTMPStream.</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="k">weak</span> <span class="k">var</span> <span class="nv">delegate</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RTMPStreamDelegate.html">RTMPStreamDelegate</a></span><span class="p">?</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit10RTMPStreamC4infoAA0C4InfoVvp"></a>
<a name="//apple_ref/swift/Property/info" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit10RTMPStreamC4infoAA0C4InfoVvp">info</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The NetStreamInfo object whose properties contain data.</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">internal(set)</span> <span class="k">var</span> <span class="nv">info</span><span class="p">:</span> <span class="kt"><a href="../Structs/RTMPStreamInfo.html">RTMPStreamInfo</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:10HaishinKit10RTMPStreamC14objectEncodingAA010RTMPObjectE0Ovp"></a>
<a name="//apple_ref/swift/Property/objectEncoding" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit10RTMPStreamC14objectEncodingAA010RTMPObjectE0Ovp">objectEncoding</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The object encoding (AMF). Framework supports AMF0 only.</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">private(set)</span> <span class="k">var</span> <span class="nv">objectEncoding</span><span class="p">:</span> <span class="kt"><a href="../Enums/RTMPObjectEncoding.html">RTMPObjectEncoding</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="/c:@M@HaishinKit@objc(cs)RTMPStream(py)currentFPS"></a>
<a name="//apple_ref/swift/Property/currentFPS" class="dashAnchor"></a>
<a class="token" href="#/c:@M@HaishinKit@objc(cs)RTMPStream(py)currentFPS">currentFPS</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The number of frames per second being displayed.</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">@objc</span>
<span class="kd">public</span> <span class="kd">private(set)</span> <span class="kd">dynamic</span> <span class="k">var</span> <span class="nv">currentFPS</span><span class="p">:</span> <span class="kt">UInt16</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:10HaishinKit10RTMPStreamC14soundTransformAA05SoundE0Vvp"></a>
<a name="//apple_ref/swift/Property/soundTransform" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit10RTMPStreamC14soundTransformAA05SoundE0Vvp">soundTransform</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Specifies the controls sound.</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="k">var</span> <span class="nv">soundTransform</span><span class="p">:</span> <span class="kt"><a href="../Structs/SoundTransform.html">SoundTransform</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit10RTMPStreamC12receiveAudioSbvp"></a>
<a name="//apple_ref/swift/Property/receiveAudio" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit10RTMPStreamC12receiveAudioSbvp">receiveAudio</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Incoming audio plays on the stream or not.</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="k">var</span> <span class="nv">receiveAudio</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit10RTMPStreamC12receiveVideoSbvp"></a>
<a name="//apple_ref/swift/Property/receiveVideo" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit10RTMPStreamC12receiveVideoSbvp">receiveVideo</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Incoming video plays on the stream or not.</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="k">var</span> <span class="nv">receiveVideo</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit10RTMPStreamC6pausedSbvp"></a>
<a name="//apple_ref/swift/Property/paused" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit10RTMPStreamC6pausedSbvp">paused</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Pauses playback or publish of a video stream or not.</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="k">var</span> <span class="nv">paused</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit10RTMPStreamC10connectionAcA14RTMPConnectionC_tcfc"></a>
<a name="//apple_ref/swift/Method/init(connection:)" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit10RTMPStreamC10connectionAcA14RTMPConnectionC_tcfc">init(connection:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Creates a new stream.</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">connection</span><span class="p">:</span> <span class="kt"><a href="../Classes/RTMPConnection.html">RTMPConnection</a></span><span class="p">)</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit10RTMPStreamC4playyyypSgd_tF"></a>
<a name="//apple_ref/swift/Method/play(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit10RTMPStreamC4playyyypSgd_tF">play(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Plays a live stream from RTMPServer.</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="kd">func</span> <span class="nf">play</span><span class="p">(</span><span class="n">_</span> <span class="nv">arguments</span><span class="p">:</span> <span class="kt">Any</span><span class="p">?</span><span class="o">...</span><span class="p">)</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit10RTMPStreamC4seekyySdF"></a>
<a name="//apple_ref/swift/Method/seek(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit10RTMPStreamC4seekyySdF">seek(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Seeks the keyframe.</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="kd">func</span> <span class="nf">seek</span><span class="p">(</span><span class="n">_</span> <span class="nv">offset</span><span class="p">:</span> <span class="kt">Double</span><span class="p">)</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit10RTMPStreamC7publish_4typeySSSg_AC12HowToPublishOtF"></a>
<a name="//apple_ref/swift/Method/publish(_:type:)" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit10RTMPStreamC7publish_4typeySSSg_AC12HowToPublishOtF">publish(_:<wbr>type:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Sends streaming audio, vidoe and data message from client.</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="kd">func</span> <span class="nf">publish</span><span class="p">(</span><span class="n">_</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">type</span><span class="p">:</span> <span class="kt">RTMPStream</span><span class="o">.</span><span class="kt"><a href="../Classes/RTMPStream/HowToPublish.html">HowToPublish</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">live</span><span class="p">)</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit10RTMPStreamC5closeyyF"></a>
<a name="//apple_ref/swift/Method/close()" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit10RTMPStreamC5closeyyF">close()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Stops playing or publishing and makes available other uses.</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="kd">func</span> <span class="nf">close</span><span class="p">()</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit10RTMPStreamC4send11handlerName9argumentsySS_ypSgdtF"></a>
<a name="//apple_ref/swift/Method/send(handlerName:arguments:)" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit10RTMPStreamC4send11handlerName9argumentsySS_ypSgdtF">send(handlerName:<wbr>arguments:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Sends a message on a published stream to all subscribing clients.</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="kd">func</span> <span class="nf">send</span><span class="p">(</span><span class="nv">handlerName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">arguments</span><span class="p">:</span> <span class="kt">Any</span><span class="p">?</span><span class="o">...</span><span class="p">)</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit10RTMPStreamC14createMetaDataSDySSypSgGyF"></a>
<a name="//apple_ref/swift/Method/createMetaData()" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit10RTMPStreamC14createMetaDataSDySSypSgGyF">createMetaData()</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="kd">func</span> <span class="nf">createMetaData</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Typealiases.html#/s:10HaishinKit8ASObjecta">ASObject</a></span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<div class="task-name-container">
<a name="/IEventDispatcher"></a>
<a name="//apple_ref/swift/Section/IEventDispatcher" class="dashAnchor"></a>
<div class="section-name-container">
<a class="section-name-link" href="#/IEventDispatcher"></a>
<h3 class="section-name"><span>IEventDispatcher</span>
</h3>
</div>
</div>
<ul>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit26EventDispatcherConvertibleP03addC8Listener_8selector8observer10useCaptureyAA0C0C4NameV_10ObjectiveC8SelectorVyXlSgSbtF"></a>
<a name="//apple_ref/swift/Method/addEventListener(_:selector:observer:useCapture:)" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit26EventDispatcherConvertibleP03addC8Listener_8selector8observer10useCaptureyAA0C0C4NameV_10ObjectiveC8SelectorVyXlSgSbtF">addEventListener(_:<wbr>selector:<wbr>observer:<wbr>useCapture:<wbr>)</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="kd">func</span> <span class="nf">addEventListener</span><span class="p">(</span><span class="n">_</span> <span class="nv">type</span><span class="p">:</span> <span class="kt"><a href="../Classes/Event.html">Event</a></span><span class="o">.</span><span class="kt">Name</span><span class="p">,</span> <span class="nv">selector</span><span class="p">:</span> <span class="kt">Selector</span><span class="p">,</span> <span class="nv">observer</span><span class="p">:</span> <span class="kt">AnyObject</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> <span class="nv">useCapture</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">false</span><span class="p">)</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit26EventDispatcherConvertibleP06removeC8Listener_8selector8observer10useCaptureyAA0C0C4NameV_10ObjectiveC8SelectorVyXlSgSbtF"></a>
<a name="//apple_ref/swift/Method/removeEventListener(_:selector:observer:useCapture:)" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit26EventDispatcherConvertibleP06removeC8Listener_8selector8observer10useCaptureyAA0C0C4NameV_10ObjectiveC8SelectorVyXlSgSbtF">removeEventListener(_:<wbr>selector:<wbr>observer:<wbr>useCapture:<wbr>)</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="kd">func</span> <span class="nf">removeEventListener</span><span class="p">(</span><span class="n">_</span> <span class="nv">type</span><span class="p">:</span> <span class="kt"><a href="../Classes/Event.html">Event</a></span><span class="o">.</span><span class="kt">Name</span><span class="p">,</span> <span class="nv">selector</span><span class="p">:</span> <span class="kt">Selector</span><span class="p">,</span> <span class="nv">observer</span><span class="p">:</span> <span class="kt">AnyObject</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> <span class="nv">useCapture</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">false</span><span class="p">)</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit26EventDispatcherConvertibleP8dispatch5eventyAA0C0C_tF"></a>
<a name="//apple_ref/swift/Method/dispatch(event:)" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit26EventDispatcherConvertibleP8dispatch5eventyAA0C0C_tF">dispatch(event:<wbr>)</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="kd">func</span> <span class="nf">dispatch</span><span class="p">(</span><span class="nv">event</span><span class="p">:</span> <span class="kt"><a href="../Classes/Event.html">Event</a></span><span class="p">)</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10HaishinKit26EventDispatcherConvertibleP8dispatch_7bubbles4datayAA0C0C4NameV_SbypSgtF"></a>
<a name="//apple_ref/swift/Method/dispatch(_:bubbles:data:)" class="dashAnchor"></a>
<a class="token" href="#/s:10HaishinKit26EventDispatcherConvertibleP8dispatch_7bubbles4datayAA0C0C4NameV_SbypSgtF">dispatch(_:<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">
</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">func</span> <span class="nf">dispatch</span><span class="p">(</span><span class="n">_</span> <span class="nv">type</span><span class="p">:</span> <span class="kt"><a href="../Classes/Event.html">Event</a></span><span class="o">.</span><span class="kt">Name</span><span class="p">,</span> <span class="nv">bubbles</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Any</span><span class="p">?)</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>