HaishinKit.swift/docs/Extensions/VTCompressionSession.html

539 lines
25 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>VTCompressionSession Extension 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>
</head>
<body>
<a name="//apple_ref/swift/Extension/VTCompressionSession" class="dashAnchor"></a>
<a title="VTCompressionSession Extension Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">HaishinKit Docs</a> (17% documented)</p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../index.html">HaishinKit Reference</a>
<img id="carat" src="../img/carat.png" />
VTCompressionSession Extension 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/AudioBuffer.html"> AudioBuffer</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/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/AVCaptureDevice.html">AVCaptureDevice</a>
</li>
<li class="nav-group-task">
<a href="../Extensions/AVCaptureSession.html">AVCaptureSession</a>
</li>
<li class="nav-group-task">
<a href="../Extensions/AVCaptureSession/Preset.html"> Preset</a>
</li>
<li class="nav-group-task">
<a href="../Extensions/AVFrameRateRange.html">AVFrameRateRange</a>
</li>
<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>
<li class="nav-group-task">
<a href="../Extensions/CGRect.html">CGRect</a>
</li>
<li class="nav-group-task">
<a href="../Extensions/CMAudioFormatDescription.html">CMAudioFormatDescription</a>
</li>
<li class="nav-group-task">
<a href="../Extensions/CMBlockBuffer.html">CMBlockBuffer</a>
</li>
<li class="nav-group-task">
<a href="../Extensions/CMFormatDescription.html">CMFormatDescription</a>
</li>
<li class="nav-group-task">
<a href="../Extensions/CMSampleBuffer.html">CMSampleBuffer</a>
</li>
<li class="nav-group-task">
<a href="../Extensions/CMVideoFormatDescription.html">CMVideoFormatDescription</a>
</li>
<li class="nav-group-task">
<a href="../Extensions/CVPixelBuffer.html">CVPixelBuffer</a>
</li>
<li class="nav-group-task">
<a href="../Extensions/Data.html">Data</a>
</li>
<li class="nav-group-task">
<a href="../Extensions/ExpressibleByIntegerLiteral.html">ExpressibleByIntegerLiteral</a>
</li>
<li class="nav-group-task">
<a href="../Extensions/Mirror.html">Mirror</a>
</li>
<li class="nav-group-task">
<a href="../Extensions/URL.html">URL</a>
</li>
<li class="nav-group-task">
<a href="../Extensions/VTCompressionSession.html">VTCompressionSession</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/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>
</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>VTCompressionSession</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">VTCompressionSession</span></code></pre>
</div>
</div>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:So23VTCompressionSessionRefa10HaishinKitE11setProperty_5values5Int32VAC0abG3KeyO_yXlSgtF"></a>
<a name="//apple_ref/swift/Method/setProperty(_:value:)" class="dashAnchor"></a>
<a class="token" href="#/s:So23VTCompressionSessionRefa10HaishinKitE11setProperty_5values5Int32VAC0abG3KeyO_yXlSgtF">setProperty(_:value:)</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">func</span> <span class="nf">setProperty</span><span class="p">(</span><span class="n">_</span> <span class="nv">key</span><span class="p">:</span> <span class="kt">VTCompressionSessionPropertyKey</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">CFTypeRef</span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="kt">OSStatus</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:So23VTCompressionSessionRefa10HaishinKitE13setPropertiesys5Int32VSDySo8NSStringCSo8NSObjectCGF"></a>
<a name="//apple_ref/swift/Method/setProperties(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:So23VTCompressionSessionRefa10HaishinKitE13setPropertiesys5Int32VSDySo8NSStringCSo8NSObjectCGF">setProperties(_:)</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">func</span> <span class="nf">setProperties</span><span class="p">(</span><span class="n">_</span> <span class="nv">propertyDictionary</span><span class="p">:</span> <span class="p">[</span><span class="kt">NSString</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="kt">OSStatus</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:So23VTCompressionSessionRefa10HaishinKitE20prepareToEncodeFrames5Int32VyF"></a>
<a name="//apple_ref/swift/Method/prepareToEncodeFrame()" class="dashAnchor"></a>
<a class="token" href="#/s:So23VTCompressionSessionRefa10HaishinKitE20prepareToEncodeFrames5Int32VyF">prepareToEncodeFrame()</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">func</span> <span class="nf">prepareToEncodeFrame</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">OSStatus</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:So23VTCompressionSessionRefa10HaishinKitE10invalidateyyF"></a>
<a name="//apple_ref/swift/Method/invalidate()" class="dashAnchor"></a>
<a class="token" href="#/s:So23VTCompressionSessionRefa10HaishinKitE10invalidateyyF">invalidate()</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">func</span> <span class="nf">invalidate</span><span class="p">()</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:So23VTCompressionSessionRefa10HaishinKitE31copySupportedPropertyDictionarySDys11AnyHashableVypGyF"></a>
<a name="//apple_ref/swift/Method/copySupportedPropertyDictionary()" class="dashAnchor"></a>
<a class="token" href="#/s:So23VTCompressionSessionRefa10HaishinKitE31copySupportedPropertyDictionarySDys11AnyHashableVypGyF">copySupportedPropertyDictionary()</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">func</span> <span class="nf">copySupportedPropertyDictionary</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="p">[</span><span class="kt">AnyHashable</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; 2020 <a class="link" href="https://github.com/shogo4405/HaishinKit.swift" target="_blank" rel="external">shogo4405</a>. All rights reserved. (Last updated: 2020-04-18)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>