gergely/matrix-glib-sdk
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
3dfe286f52
matrix-glib-sdk/Matrix-0.0-MatrixEventCallInvite.html

360 lines
18 KiB
HTML
Raw Normal View History

Update GTK Doc with current develop
2016-03-17 16:47:46 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>MatrixEventCallInvite: Matrix-0.0 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Matrix-0.0 Reference Manual">
<link rel="up" href="ch01.html" title="Matrix-0.0 API Reference">
<link rel="prev" href="Matrix-0.0-MatrixHTTPAPI.html" title="MatrixHTTPAPI">
<link rel="next" href="Matrix-0.0-MatrixEventRoomName.html" title="MatrixEventRoomName">
<meta name="generator" content="GTK-Doc V1.24 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
<a href="#Matrix-0.0-MatrixEventCallInvite.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="Matrix-0.0-MatrixHTTPAPI.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="Matrix-0.0-MatrixEventRoomName.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="Matrix-0.0-MatrixEventCallInvite"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="Matrix-0.0-MatrixEventCallInvite.top_of_page"></a>MatrixEventCallInvite</span></h2>
<p>MatrixEventCallInvite — This event is sent by the caller when they wish to establish a call.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventCallInvite.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="Matrix-0.0-MatrixEventCallInvite.html#MATRIX-EVENT-TYPE-CALL-INVITE:CAPS" title="MATRIX_EVENT_TYPE_CALL_INVITE">MATRIX_EVENT_TYPE_CALL_INVITE</a></td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="Matrix-0.0-MatrixEventCallInvite.html#MatrixEventCallInvite" title="struct MatrixEventCallInvite"><span class="returnvalue">MatrixEventCallInvite</span></a> *
</td>
<td class="function_name">
<a class="link" href="Matrix-0.0-MatrixEventCallInvite.html#matrix-event-call-invite-new" title="matrix_event_call_invite_new ()">matrix_event_call_invite_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="Matrix-0.0-matrix-types.html#MatrixCallOfferType" title="enum MatrixCallOfferType"><span class="returnvalue">MatrixCallOfferType</span></a>
</td>
<td class="function_name">
<a class="link" href="Matrix-0.0-MatrixEventCallInvite.html#matrix-event-call-invite-get-offer-type" title="matrix_event_call_invite_get_offer_type ()">matrix_event_call_invite_get_offer_type</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="Matrix-0.0-MatrixEventCallInvite.html#matrix-event-call-invite-set-offer-type" title="matrix_event_call_invite_set_offer_type ()">matrix_event_call_invite_set_offer_type</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="Matrix-0.0-MatrixEventCallInvite.html#matrix-event-call-invite-get-sdp" title="matrix_event_call_invite_get_sdp ()">matrix_event_call_invite_get_sdp</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="Matrix-0.0-MatrixEventCallInvite.html#matrix-event-call-invite-set-sdp" title="matrix_event_call_invite_set_sdp ()">matrix_event_call_invite_set_sdp</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
</td>
<td class="function_name">
<a class="link" href="Matrix-0.0-MatrixEventCallInvite.html#matrix-event-call-invite-get-lifetime" title="matrix_event_call_invite_get_lifetime ()">matrix_event_call_invite_get_lifetime</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="Matrix-0.0-MatrixEventCallInvite.html#matrix-event-call-invite-set-lifetime" title="matrix_event_call_invite_set_lifetime ()">matrix_event_call_invite_set_lifetime</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventCallInvite.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="Matrix-0.0-MatrixEventCallInvite.html#MatrixEventCallInvite" title="struct MatrixEventCallInvite">MatrixEventCallInvite</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="Matrix-0.0-MatrixEventCallInvite.html#MatrixEventCallInviteClass" title="struct MatrixEventCallInviteClass">MatrixEventCallInviteClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventCallInvite.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventCallInvite.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="MATRIX-EVENT-TYPE-CALL-INVITE:CAPS"></a><h3>MATRIX_EVENT_TYPE_CALL_INVITE</h3>
<pre class="programlisting">#define MATRIX_EVENT_TYPE_CALL_INVITE (matrix_event_call_invite_get_type ())
</pre>
<p>The type for <a class="link" href="Matrix-0.0-MatrixEventCallInvite.html#MatrixEventCallInvite" title="struct MatrixEventCallInvite"><span class="type">MatrixEventCallInvite</span></a>.</p>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-call-invite-new"></a><h3>matrix_event_call_invite_new ()</h3>
<pre class="programlisting"><a class="link" href="Matrix-0.0-MatrixEventCallInvite.html#MatrixEventCallInvite" title="struct MatrixEventCallInvite"><span class="returnvalue">MatrixEventCallInvite</span></a> *
matrix_event_call_invite_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-call-invite-get-offer-type"></a><h3>matrix_event_call_invite_get_offer_type ()</h3>
<pre class="programlisting"><a class="link" href="Matrix-0.0-matrix-types.html#MatrixCallOfferType" title="enum MatrixCallOfferType"><span class="returnvalue">MatrixCallOfferType</span></a>
matrix_event_call_invite_get_offer_type
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventCallInvite.html#MatrixEventCallInvite" title="struct MatrixEventCallInvite"><span class="type">MatrixEventCallInvite</span></a> *self</code></em>);</pre>
<p>Get and return the current value of the <span class="type">"offer-type"</span> property.</p>
<p>The type of session description.</p>
<div class="refsect3">
<a name="id-1.2.5.6.4.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="Matrix-0.0-MatrixEventCallInvite.html#MatrixEventCallInvite" title="struct MatrixEventCallInvite"><span class="type">MatrixEventCallInvite</span></a> instance to query</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.5.6.4.7"></a><h4>Returns</h4>
<p> the value of the <span class="type">"offer-type"</span> property</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-call-invite-set-offer-type"></a><h3>matrix_event_call_invite_set_offer_type ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
matrix_event_call_invite_set_offer_type
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventCallInvite.html#MatrixEventCallInvite" title="struct MatrixEventCallInvite"><span class="type">MatrixEventCallInvite</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="Matrix-0.0-matrix-types.html#MatrixCallOfferType" title="enum MatrixCallOfferType"><span class="type">MatrixCallOfferType</span></a> value</code></em>);</pre>
<p>Set the value of the <span class="type">"offer-type"</span> property to <em class="parameter"><code>value</code></em>
.</p>
<p>The type of session description.</p>
<div class="refsect3">
<a name="id-1.2.5.6.5.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="Matrix-0.0-MatrixEventCallInvite.html#MatrixEventCallInvite" title="struct MatrixEventCallInvite"><span class="type">MatrixEventCallInvite</span></a> instance to modify</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>the new value of the <span class="type">"offer-type"</span> property</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-call-invite-get-sdp"></a><h3>matrix_event_call_invite_get_sdp ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
matrix_event_call_invite_get_sdp (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventCallInvite.html#MatrixEventCallInvite" title="struct MatrixEventCallInvite"><span class="type">MatrixEventCallInvite</span></a> *self</code></em>);</pre>
<p>Get and return the current value of the <span class="type">"sdp"</span> property.</p>
<p>The SDP text of the session description.</p>
<div class="refsect3">
<a name="id-1.2.5.6.6.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="Matrix-0.0-MatrixEventCallInvite.html#MatrixEventCallInvite" title="struct MatrixEventCallInvite"><span class="type">MatrixEventCallInvite</span></a> instance to query</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.5.6.6.7"></a><h4>Returns</h4>
<p> the value of the <span class="type">"sdp"</span> property</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-call-invite-set-sdp"></a><h3>matrix_event_call_invite_set_sdp ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
matrix_event_call_invite_set_sdp (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventCallInvite.html#MatrixEventCallInvite" title="struct MatrixEventCallInvite"><span class="type">MatrixEventCallInvite</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *value</code></em>);</pre>
<p>Set the value of the <span class="type">"sdp"</span> property to <em class="parameter"><code>value</code></em>
.</p>
<p>The SDP text of the session description.</p>
<div class="refsect3">
<a name="id-1.2.5.6.7.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="Matrix-0.0-MatrixEventCallInvite.html#MatrixEventCallInvite" title="struct MatrixEventCallInvite"><span class="type">MatrixEventCallInvite</span></a> instance to modify</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>the new value of the <span class="type">"sdp"</span> property</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-call-invite-get-lifetime"></a><h3>matrix_event_call_invite_get_lifetime ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
matrix_event_call_invite_get_lifetime (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventCallInvite.html#MatrixEventCallInvite" title="struct MatrixEventCallInvite"><span class="type">MatrixEventCallInvite</span></a> *self</code></em>);</pre>
<p>Get and return the current value of the <span class="type">"lifetime"</span> property.</p>
<p>The time in milliseconds that the invite is valid for. Once the invite age exceeds this value, clients should discard it. They should also no longer show the call as awaiting an answer in the UI.</p>
<div class="refsect3">
<a name="id-1.2.5.6.8.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="Matrix-0.0-MatrixEventCallInvite.html#MatrixEventCallInvite" title="struct MatrixEventCallInvite"><span class="type">MatrixEventCallInvite</span></a> instance to query</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.5.6.8.7"></a><h4>Returns</h4>
<p> the value of the <span class="type">"lifetime"</span> property</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-event-call-invite-set-lifetime"></a><h3>matrix_event_call_invite_set_lifetime ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
matrix_event_call_invite_set_lifetime (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixEventCallInvite.html#MatrixEventCallInvite" title="struct MatrixEventCallInvite"><span class="type">MatrixEventCallInvite</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">gint</span> value</code></em>);</pre>
<p>Set the value of the <span class="type">"lifetime"</span> property to <em class="parameter"><code>value</code></em>
.</p>
<p>The time in milliseconds that the invite is valid for. Once the invite age exceeds this value, clients should discard it. They should also no longer show the call as awaiting an answer in the UI.</p>
<div class="refsect3">
<a name="id-1.2.5.6.9.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="Matrix-0.0-MatrixEventCallInvite.html#MatrixEventCallInvite" title="struct MatrixEventCallInvite"><span class="type">MatrixEventCallInvite</span></a> instance to modify</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>the new value of the <span class="type">"lifetime"</span> property</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixEventCallInvite.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="MatrixEventCallInvite"></a><h3>struct MatrixEventCallInvite</h3>
<pre class="programlisting">struct MatrixEventCallInvite {
MatrixEventCall parent_instance;
MatrixEventCallInvitePrivate * priv;
};
</pre>
<p>This event is sent by the caller when they wish to establish a call.</p>
</div>
<hr>
<div class="refsect2">
<a name="MatrixEventCallInviteClass"></a><h3>struct MatrixEventCallInviteClass</h3>
<pre class="programlisting">struct MatrixEventCallInviteClass {
MatrixEventCallClass parent_class;
};
</pre>
<p>The class structure for <a class="link" href="Matrix-0.0-MatrixEventCallInvite.html#MATRIX-EVENT-TYPE-CALL-INVITE:CAPS" title="MATRIX_EVENT_TYPE_CALL_INVITE"><code class="literal">MATRIX_EVENT_TYPE_CALL_INVITE</code></a>. All the fields in this structure are private and should never be accessed directly.</p>
<div class="refsect3">
<a name="id-1.2.5.7.3.5"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody><tr>
<td class="struct_member_name"><p><a class="link" href="Matrix-0.0-MatrixEventCall.html#MatrixEventCallClass" title="struct MatrixEventCallClass"><span class="type">MatrixEventCallClass</span></a> <em class="structfield"><code><a name="MatrixEventCallInviteClass.parent-class"></a>parent_class</code></em>;</p></td>
<td class="struct_member_description"><p>the parent class structure</p></td>
<td class="struct_member_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
Reference in New Issue Copy Permalink