Why Gemfury?
Push, build, and install
RubyGems
npm packages
Python packages
Maven artifacts
PHP packages
Go Modules
Debian packages
RPM packages
NuGet packages
showbox-public-14
showbox-public-14 / ffmpeg-doc deb
Repository URL to install this package:
|
Version:
8:3.0.2-1ubuntu3 ▾
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>FFmpeg: Option getting functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">FFmpeg
 <span id="projectnumber">3.0.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Option getting functions<div class="ingroups"><a class="el" href="group__avoptions.html">AVOptions</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Those functions get a value of the option with the given name from an object.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaf31144e60f9ce89dbe8cbea57a0b232c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__opt__get__funcs.html#gaf31144e60f9ce89dbe8cbea57a0b232c">av_opt_get</a> (void *obj, const char *name, int search_flags, uint8_t **out_val)</td></tr>
<tr class="separator:gaf31144e60f9ce89dbe8cbea57a0b232c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaab5b9c0969efe56420536a5d190e59bd"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__opt__get__funcs.html#gaab5b9c0969efe56420536a5d190e59bd">av_opt_get_int</a> (void *obj, const char *name, int search_flags, int64_t *out_val)</td></tr>
<tr class="separator:gaab5b9c0969efe56420536a5d190e59bd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4ee50245cd18a65ec1cd27bc8e0cab83"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__opt__get__funcs.html#ga4ee50245cd18a65ec1cd27bc8e0cab83">av_opt_get_double</a> (void *obj, const char *name, int search_flags, double *out_val)</td></tr>
<tr class="separator:ga4ee50245cd18a65ec1cd27bc8e0cab83"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabc553a1b95468f935eedfa9db86e2a15"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__opt__get__funcs.html#gabc553a1b95468f935eedfa9db86e2a15">av_opt_get_q</a> (void *obj, const char *name, int search_flags, <a class="el" href="structAVRational.html">AVRational</a> *out_val)</td></tr>
<tr class="separator:gabc553a1b95468f935eedfa9db86e2a15"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga96d9c726c3feff308e7fe447633c9720"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__opt__get__funcs.html#ga96d9c726c3feff308e7fe447633c9720">av_opt_get_image_size</a> (void *obj, const char *name, int search_flags, int *w_out, int *h_out)</td></tr>
<tr class="separator:ga96d9c726c3feff308e7fe447633c9720"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga41fdd93f0483e96548168f9cfaf5bf6b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__opt__get__funcs.html#ga41fdd93f0483e96548168f9cfaf5bf6b">av_opt_get_pixel_fmt</a> (void *obj, const char *name, int search_flags, enum <a class="el" href="pixfmt_8h.html#a9a8e335cf3be472042bc9f0cf80cd4c5">AVPixelFormat</a> *out_fmt)</td></tr>
<tr class="separator:ga41fdd93f0483e96548168f9cfaf5bf6b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gade39dd8ce34b193f7012022072e36642"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__opt__get__funcs.html#gade39dd8ce34b193f7012022072e36642">av_opt_get_sample_fmt</a> (void *obj, const char *name, int search_flags, enum <a class="el" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5">AVSampleFormat</a> *out_fmt)</td></tr>
<tr class="separator:gade39dd8ce34b193f7012022072e36642"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf565dc77c53e8e56d08ee1a3c642f95f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__opt__get__funcs.html#gaf565dc77c53e8e56d08ee1a3c642f95f">av_opt_get_video_rate</a> (void *obj, const char *name, int search_flags, <a class="el" href="structAVRational.html">AVRational</a> *out_val)</td></tr>
<tr class="separator:gaf565dc77c53e8e56d08ee1a3c642f95f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga35864ccde3246be3f56366fd5145fc12"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__opt__get__funcs.html#ga35864ccde3246be3f56366fd5145fc12">av_opt_get_channel_layout</a> (void *obj, const char *name, int search_flags, int64_t *ch_layout)</td></tr>
<tr class="separator:ga35864ccde3246be3f56366fd5145fc12"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6ed0b77def62321ff995843211405338"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__opt__get__funcs.html#ga6ed0b77def62321ff995843211405338">av_opt_get_dict_val</a> (void *obj, const char *name, int search_flags, <a class="el" href="group__lavu__dict.html#ga1d7cc0833bee918994a600556410315f">AVDictionary</a> **out_val)</td></tr>
<tr class="separator:ga6ed0b77def62321ff995843211405338"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Those functions get a value of the option with the given name from an object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">obj</td><td>a struct whose first element is a pointer to an <a class="el" href="structAVClass.html" title="Describe the class of an AVClass context structure. ">AVClass</a>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>name of the option to get. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">search_flags</td><td>flags passed to av_opt_find2. I.e. if AV_OPT_SEARCH_CHILDREN is passed here, then the option may be found in a child of obj. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">out_val</td><td>value of the option will be written here </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>>=0 on success, a negative error code otherwise </dd></dl>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gaf31144e60f9ce89dbe8cbea57a0b232c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int av_opt_get </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>search_flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t ** </td>
<td class="paramname"><em>out_val</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section note"><dt>Note</dt><dd>the returned string will be <a class="el" href="group__lavu__mem.html#ga9722446c5e310ffedfaac9489864796d" title="Allocate a block of size bytes with alignment suitable for all memory accesses (including vectors if ...">av_malloc()</a>ed and must be <a class="el" href="group__lavu__mem.html#ga0c9096f498624c525aa2315b8a20c411" title="Free a memory block which has been allocated with av_malloc(z)() or av_realloc(). ...">av_free()</a>ed by the caller</dd>
<dd>
if AV_OPT_ALLOW_NULL is set in search_flags in av_opt_get, and the option has AV_OPT_TYPE_STRING or AV_OPT_TYPE_BINARY and is set to NULL, *out_val will be set to NULL instead of an allocated empty string. </dd></dl>
</div>
</div>
<a class="anchor" id="gaab5b9c0969efe56420536a5d190e59bd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int av_opt_get_int </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>search_flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int64_t * </td>
<td class="paramname"><em>out_val</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ga4ee50245cd18a65ec1cd27bc8e0cab83"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int av_opt_get_double </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>search_flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double * </td>
<td class="paramname"><em>out_val</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="gabc553a1b95468f935eedfa9db86e2a15"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int av_opt_get_q </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>search_flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structAVRational.html">AVRational</a> * </td>
<td class="paramname"><em>out_val</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ga96d9c726c3feff308e7fe447633c9720"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int av_opt_get_image_size </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>search_flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>w_out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>h_out</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ga41fdd93f0483e96548168f9cfaf5bf6b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int av_opt_get_pixel_fmt </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>search_flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">enum <a class="el" href="pixfmt_8h.html#a9a8e335cf3be472042bc9f0cf80cd4c5">AVPixelFormat</a> * </td>
<td class="paramname"><em>out_fmt</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="gade39dd8ce34b193f7012022072e36642"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int av_opt_get_sample_fmt </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>search_flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">enum <a class="el" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5">AVSampleFormat</a> * </td>
<td class="paramname"><em>out_fmt</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="gaf565dc77c53e8e56d08ee1a3c642f95f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int av_opt_get_video_rate </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>search_flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structAVRational.html">AVRational</a> * </td>
<td class="paramname"><em>out_val</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ga35864ccde3246be3f56366fd5145fc12"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int av_opt_get_channel_layout </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>search_flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int64_t * </td>
<td class="paramname"><em>ch_layout</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ga6ed0b77def62321ff995843211405338"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int av_opt_get_dict_val </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>search_flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__lavu__dict.html#ga1d7cc0833bee918994a600556410315f">AVDictionary</a> ** </td>
<td class="paramname"><em>out_val</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">out_val</td><td>The returned dictionary is a copy of the actual value and must be freed with <a class="el" href="group__lavu__dict.html#ga1bafd682b1fbb90e48a4cc3814b820f7" title="Free all the memory allocated for an AVDictionary struct and all keys and values. ...">av_dict_free()</a> by the caller </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>