1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2<html> 3<head> 4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 5<title>hlssink: GStreamer Bad Plugins 1.0 Plugins Reference Manual</title> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="index.html" title="GStreamer Bad Plugins 1.0 Plugins Reference Manual"> 8<link rel="up" href="ch01.html" title="gst-plugins-bad Elements"> 9<link rel="prev" href="gst-plugins-bad-plugins-hlssink2.html" title="hlssink2"> 10<link rel="next" href="gst-plugins-bad-plugins-id3mux.html" title="id3mux"> 11<meta name="generator" content="GTK-Doc V1.28 (XML mode)"> 12<link rel="stylesheet" href="style.css" type="text/css"> 13</head> 14<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 15<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> 16<td width="100%" align="left" class="shortcuts"> 17<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 18 <a href="#gst-plugins-bad-plugins-hlssink.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-bad-plugins-hlssink.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> 20 <a href="#gst-plugins-bad-plugins-hlssink.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> 21 <a href="#gst-plugins-bad-plugins-hlssink.properties" class="shortcut">Properties</a></span> 22</td> 23<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> 24<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> 25<td><a accesskey="p" href="gst-plugins-bad-plugins-hlssink2.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> 26<td><a accesskey="n" href="gst-plugins-bad-plugins-id3mux.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> 27</tr></table> 28<div class="refentry"> 29<a name="gst-plugins-bad-plugins-hlssink"></a><div class="titlepage"></div> 30<div class="refnamediv"><table width="100%"><tr> 31<td valign="top"> 32<h2><span class="refentrytitle"><a name="gst-plugins-bad-plugins-hlssink.top_of_page"></a>hlssink</span></h2> 33<p>hlssink</p> 34</td> 35<td class="gallery_image" valign="top" align="right"></td> 36</tr></table></div> 37<div class="refsect1"> 38<a name="gst-plugins-bad-plugins-hlssink.properties"></a><h2>Properties</h2> 39<div class="informaltable"><table class="informaltable" border="0"> 40<colgroup> 41<col width="150px" class="properties_type"> 42<col width="300px" class="properties_name"> 43<col width="200px" class="properties_flags"> 44</colgroup> 45<tbody> 46<tr> 47<td class="property_type"> 48<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> 49<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-hlssink.html#GstHlsSink--location" title="The “location” property">location</a></td> 50<td class="property_flags">Read / Write</td> 51</tr> 52<tr> 53<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> 54<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-hlssink.html#GstHlsSink--max-files" title="The “max-files” property">max-files</a></td> 55<td class="property_flags">Read / Write</td> 56</tr> 57<tr> 58<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> 59<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-hlssink.html#GstHlsSink--playlist-length" title="The “playlist-length” property">playlist-length</a></td> 60<td class="property_flags">Read / Write</td> 61</tr> 62<tr> 63<td class="property_type"> 64<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> 65<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-hlssink.html#GstHlsSink--playlist-location" title="The “playlist-location” property">playlist-location</a></td> 66<td class="property_flags">Read / Write</td> 67</tr> 68<tr> 69<td class="property_type"> 70<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> 71<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-hlssink.html#GstHlsSink--playlist-root" title="The “playlist-root” property">playlist-root</a></td> 72<td class="property_flags">Read / Write</td> 73</tr> 74<tr> 75<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> 76<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-hlssink.html#GstHlsSink--target-duration" title="The “target-duration” property">target-duration</a></td> 77<td class="property_flags">Read / Write</td> 78</tr> 79</tbody> 80</table></div> 81</div> 82<a name="GstHlsSink"></a><div class="refsect1"> 83<a name="gst-plugins-bad-plugins-hlssink.other"></a><h2>Types and Values</h2> 84<div class="informaltable"><table class="informaltable" width="100%" border="0"> 85<colgroup> 86<col width="150px" class="name"> 87<col class="description"> 88</colgroup> 89<tbody><tr> 90<td class="datatype_keyword">struct</td> 91<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-hlssink.html#GstHlsSink-struct" title="struct GstHlsSink">GstHlsSink</a></td> 92</tr></tbody> 93</table></div> 94</div> 95<div class="refsect1"> 96<a name="gst-plugins-bad-plugins-hlssink.object-hierarchy"></a><h2>Object Hierarchy</h2> 97<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 98 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 99 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 100 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 101 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstBin.html#GstBin-struct">GstBin</a> 102 <span class="lineart">╰──</span> GstHlsSink 103</pre> 104</div> 105<div class="refsect1"> 106<a name="gst-plugins-bad-plugins-hlssink.implemented-interfaces"></a><h2>Implemented Interfaces</h2> 107<p> 108GstHlsSink implements 109 <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstChildProxy.html#GstChildProxy-struct">GstChildProxy</a>.</p> 110</div> 111<div class="refsect1"> 112<a name="gst-plugins-bad-plugins-hlssink.description"></a><h2>Description</h2> 113<p>HTTP Live Streaming sink/server</p> 114<div class="refsect3"> 115<a name="id-1.2.108.8.3"></a><h4>Example launch line</h4> 116<div class="informalexample"> 117 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 118 <tbody> 119 <tr> 120 <td class="listing_lines" align="right"><pre>1</pre></td> 121 <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch<span class="gtkdoc opt">-</span><span class="number">1.0</span> videotestsrc is<span class="gtkdoc opt">-</span>live<span class="gtkdoc opt">=</span><span class="keyword">true</span> <span class="gtkdoc opt">!</span> x264enc <span class="gtkdoc opt">!</span> hlssink max<span class="gtkdoc opt">-</span>files<span class="gtkdoc opt">=</span><span class="number">5</span></pre></td> 122 </tr> 123 </tbody> 124 </table> 125</div> 126 127<p></p> 128</div> 129<div class="refsynopsisdiv"> 130<h2>Synopsis</h2> 131<div class="refsect2"> 132<a name="id-1.2.108.8.4.1"></a><h3>Element Information</h3> 133<div class="variablelist"><table border="0" class="variablelist"> 134<colgroup> 135<col align="left" valign="top"> 136<col> 137</colgroup> 138<tbody> 139<tr> 140<td><p><span class="term">plugin</span></p></td> 141<td> 142 <a class="link" href="gst-plugins-bad-plugins-plugin-hls.html#plugin-hls">hls</a> 143 </td> 144</tr> 145<tr> 146<td><p><span class="term">author</span></p></td> 147<td>Alessandro Decina <alessandro.d@gmail.com></td> 148</tr> 149<tr> 150<td><p><span class="term">class</span></p></td> 151<td>Sink</td> 152</tr> 153</tbody> 154</table></div> 155</div> 156<hr> 157<div class="refsect2"> 158<a name="id-1.2.108.8.4.2"></a><h3>Element Pads</h3> 159<div class="variablelist"><table border="0" class="variablelist"> 160<colgroup> 161<col align="left" valign="top"> 162<col> 163</colgroup> 164<tbody> 165<tr> 166<td><p><span class="term">name</span></p></td> 167<td>sink</td> 168</tr> 169<tr> 170<td><p><span class="term">direction</span></p></td> 171<td>sink</td> 172</tr> 173<tr> 174<td><p><span class="term">presence</span></p></td> 175<td>always</td> 176</tr> 177<tr> 178<td><p><span class="term">details</span></p></td> 179<td>ANY</td> 180</tr> 181</tbody> 182</table></div> 183</div> 184</div> 185</div> 186<div class="refsect1"> 187<a name="gst-plugins-bad-plugins-hlssink.functions_details"></a><h2>Functions</h2> 188<p></p> 189</div> 190<div class="refsect1"> 191<a name="gst-plugins-bad-plugins-hlssink.other_details"></a><h2>Types and Values</h2> 192<div class="refsect2"> 193<a name="GstHlsSink-struct"></a><h3>struct GstHlsSink</h3> 194<pre class="programlisting">struct GstHlsSink;</pre> 195</div> 196</div> 197<div class="refsect1"> 198<a name="gst-plugins-bad-plugins-hlssink.property-details"></a><h2>Property Details</h2> 199<div class="refsect2"> 200<a name="GstHlsSink--location"></a><h3>The <code class="literal">“location”</code> property</h3> 201<pre class="programlisting"> “location” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> 202<p>Location of the file to write.</p> 203<p>Flags: Read / Write</p> 204<p>Default value: "segment%05d.ts"</p> 205</div> 206<hr> 207<div class="refsect2"> 208<a name="GstHlsSink--max-files"></a><h3>The <code class="literal">“max-files”</code> property</h3> 209<pre class="programlisting"> “max-files” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> 210<p>Maximum number of files to keep on disk. Once the maximum is reached,old files start to be deleted to make room for new ones.</p> 211<p>Flags: Read / Write</p> 212<p>Default value: 10</p> 213</div> 214<hr> 215<div class="refsect2"> 216<a name="GstHlsSink--playlist-length"></a><h3>The <code class="literal">“playlist-length”</code> property</h3> 217<pre class="programlisting"> “playlist-length” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> 218<p>Length of HLS playlist. To allow players to conform to section 6.3.3 of the HLS specification, this should be at least 3. If set to 0, the playlist will be infinite.</p> 219<p>Flags: Read / Write</p> 220<p>Default value: 5</p> 221</div> 222<hr> 223<div class="refsect2"> 224<a name="GstHlsSink--playlist-location"></a><h3>The <code class="literal">“playlist-location”</code> property</h3> 225<pre class="programlisting"> “playlist-location” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> 226<p>Location of the playlist to write.</p> 227<p>Flags: Read / Write</p> 228<p>Default value: "playlist.m3u8"</p> 229</div> 230<hr> 231<div class="refsect2"> 232<a name="GstHlsSink--playlist-root"></a><h3>The <code class="literal">“playlist-root”</code> property</h3> 233<pre class="programlisting"> “playlist-root” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> 234<p>Location of the playlist to write.</p> 235<p>Flags: Read / Write</p> 236<p>Default value: NULL</p> 237</div> 238<hr> 239<div class="refsect2"> 240<a name="GstHlsSink--target-duration"></a><h3>The <code class="literal">“target-duration”</code> property</h3> 241<pre class="programlisting"> “target-duration” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> 242<p>The target duration in seconds of a segment/file. (0 - disabled, useful for management of segment duration by the streaming server).</p> 243<p>Flags: Read / Write</p> 244<p>Default value: 15</p> 245</div> 246</div> 247</div> 248<div class="footer"> 249<hr>Generated by GTK-Doc V1.28</div> 250</body> 251</html>