alsatimer: add documentation for alsa-gobject v0.3.0

Signed-off-by: Takashi Sakamoto <[email protected]>
alsa-project · Jul 10, 2022 · 80fdbaf · 80fdbaf
1 parent 742778c
commit 80fdbaf
Show file tree

Hide file tree

Showing 96 changed files with 1,468 additions and 1,281 deletions.
diff --git a/alsatimer/alsatimer.devhelp2 b/alsatimer/alsatimer.devhelp2
diff --git a/alsatimer/class.DeviceInfo.html b/alsatimer/class.DeviceInfo.html
@@ -70,7 +70,7 @@
         <h3><a href="index.html">ALSATimer</a></h3>
         <p>API Version: 0.0</p>
 
-        <p>Library Version: 0.2.2</p>
+        <p>Library Version: 0.3.0</p>
 
       </div>
 
@@ -146,8 +146,8 @@ <h4 id="description" style="display:flex;">
 }</pre></code>
 
         <div class="docblock">
-          <p>A GObject-derived object to represent information of timer device.
-A <a href="class.DeviceInfo.html"><code>ALSATimerDeviceInfo</code></a> is a GObject-derived object to represent information of timer device.
+          <p>A GObject-derived object to express information of timer device.
+A <a href="class.DeviceInfo.html"><code>ALSATimerDeviceInfo</code></a> is a GObject-derived object to express information of timer device.
 The call of <code>alsatimer_get_device_info()</code> returns an instance of the object according to the
 identifier of timer&nbsp;device.</p>
 <p>The object wraps <code>struct snd_timer_ginfo</code> in <span class="caps">UAPI</span> of Linux sound&nbsp;subsystem.</p>
@@ -237,7 +237,7 @@ <h4 id="properties">
           <h6><a href="property.DeviceInfo.card-id.html">ALSATimer.DeviceInfo:card-id</a></h6>
 
           <div class="docblock">
-            No description available.
+            <p>The numeric <span class="caps">ID</span> of sound&nbsp;card.</p>
           </div>
 
 
@@ -247,7 +247,7 @@ <h6><a href="property.DeviceInfo.card-id.html">ALSATimer.DeviceInfo:card-id</a><
           <h6><a href="property.DeviceInfo.flags.html">ALSATimer.DeviceInfo:flags</a></h6>
 
           <div class="docblock">
-            No description available.
+            <p>The flags of timer, one of <code>ALSATimerDeviceInfoFlag</code>.</p>
           </div>
 
 
@@ -257,7 +257,7 @@ <h6><a href="property.DeviceInfo.flags.html">ALSATimer.DeviceInfo:flags</a></h6>
           <h6><a href="property.DeviceInfo.id.html">ALSATimer.DeviceInfo:id</a></h6>
 
           <div class="docblock">
-            No description available.
+            <p>The string <span class="caps">ID</span> of&nbsp;timer.</p>
           </div>
 
 
@@ -267,7 +267,7 @@ <h6><a href="property.DeviceInfo.id.html">ALSATimer.DeviceInfo:id</a></h6>
           <h6><a href="property.DeviceInfo.instance-count.html">ALSATimer.DeviceInfo:instance-count</a></h6>
 
           <div class="docblock">
-            No description available.
+            <p>The number of instances for the&nbsp;timer.</p>
           </div>
 
 
@@ -277,7 +277,7 @@ <h6><a href="property.DeviceInfo.instance-count.html">ALSATimer.DeviceInfo:insta
           <h6><a href="property.DeviceInfo.name.html">ALSATimer.DeviceInfo:name</a></h6>
 
           <div class="docblock">
-            No description available.
+            <p>The name of&nbsp;timer.</p>
           </div>
 
 
@@ -287,7 +287,7 @@ <h6><a href="property.DeviceInfo.name.html">ALSATimer.DeviceInfo:name</a></h6>
           <h6><a href="property.DeviceInfo.resolution.html">ALSATimer.DeviceInfo:resolution</a></h6>
 
           <div class="docblock">
-            No description available.
+            <p>The resolution in nano&nbsp;seconds.</p>
           </div>
 
 
@@ -297,7 +297,7 @@ <h6><a href="property.DeviceInfo.resolution.html">ALSATimer.DeviceInfo:resolutio
           <h6><a href="property.DeviceInfo.resolution-max.html">ALSATimer.DeviceInfo:resolution-max</a></h6>
 
           <div class="docblock">
-            No description available.
+            <p>The maximum resolution in nano&nbsp;seconds.</p>
           </div>
 
 
@@ -307,7 +307,7 @@ <h6><a href="property.DeviceInfo.resolution-max.html">ALSATimer.DeviceInfo:resol
           <h6><a href="property.DeviceInfo.resolution-min.html">ALSATimer.DeviceInfo:resolution-min</a></h6>
 
           <div class="docblock">
-            No description available.
+            <p>The minimum resolution in nano&nbsp;seconds.</p>
           </div>
 
 

diff --git a/alsatimer/class.DeviceParams.html b/alsatimer/class.DeviceParams.html
@@ -70,7 +70,7 @@
         <h3><a href="index.html">ALSATimer</a></h3>
         <p>API Version: 0.0</p>
 
-        <p>Library Version: 0.2.2</p>
+        <p>Library Version: 0.3.0</p>
 
       </div>
 
@@ -143,8 +143,8 @@ <h4 id="description" style="display:flex;">
 }</pre></code>
 
         <div class="docblock">
-          <p>A GObject-derived object to represent parameter of timer device.
-A <a href="class.DeviceParams.html"><code>ALSATimerDeviceParams</code></a> is a GObject-derived object to represent parameter of timer device. The
+          <p>A GObject-derived object to express parameter of timer device.
+A <a href="class.DeviceParams.html"><code>ALSATimerDeviceParams</code></a> is a GObject-derived object to express parameter of timer device. The
 call of <code>alsatimer_set_device_params()</code> requires the instance of&nbsp;object.</p>
 <p>The object wraps <code>struct snd_timer_gparams</code> in <span class="caps">UAPI</span> of Linux sound&nbsp;subsystem.</p>
         </div>
@@ -254,7 +254,7 @@ <h4 id="properties">
           <h6><a href="property.DeviceParams.period-denominator.html">ALSATimer.DeviceParams:period-denominator</a></h6>
 
           <div class="docblock">
-            No description available.
+            <p>The denominator of period for&nbsp;timer.</p>
           </div>
 
 
@@ -264,7 +264,7 @@ <h6><a href="property.DeviceParams.period-denominator.html">ALSATimer.DevicePara
           <h6><a href="property.DeviceParams.period-numerator.html">ALSATimer.DeviceParams:period-numerator</a></h6>
 
           <div class="docblock">
-            No description available.
+            <p>The numerator of period for&nbsp;timer.</p>
           </div>
 
 

diff --git a/alsatimer/class.DeviceStatus.html b/alsatimer/class.DeviceStatus.html
@@ -70,7 +70,7 @@
         <h3><a href="index.html">ALSATimer</a></h3>
         <p>API Version: 0.0</p>
 
-        <p>Library Version: 0.2.2</p>
+        <p>Library Version: 0.3.0</p>
 
       </div>
 
@@ -145,8 +145,8 @@ <h4 id="description" style="display:flex;">
 }</pre></code>
 
         <div class="docblock">
-          <p>A GObject-derived object to represent status of timer device.
-A <a href="class.DeviceStatus.html"><code>ALSATimerDeviceStatus</code></a> is a GObject-derived object to represent status of timer device. The
+          <p>A GObject-derived object to express status of timer device.
+A <a href="class.DeviceStatus.html"><code>ALSATimerDeviceStatus</code></a> is a GObject-derived object to express status of timer device. The
 call of <a href="func.get_device_status.html"><code>alsatimer_get_device_status()</code></a> returns the instance of&nbsp;object.</p>
 <p>The object wraps &#8216;struct snd_timer_gstatus&#8217; in <span class="caps">UAPI</span> of Linux sound&nbsp;subsystem.</p>
         </div>
@@ -256,7 +256,7 @@ <h4 id="properties">
           <h6><a href="property.DeviceStatus.resolution.html">ALSATimer.DeviceStatus:resolution</a></h6>
 
           <div class="docblock">
-            No description available.
+            <p>The current resolution in nano&nbsp;seconds.</p>
           </div>
 
 
@@ -266,7 +266,7 @@ <h6><a href="property.DeviceStatus.resolution.html">ALSATimer.DeviceStatus:resol
           <h6><a href="property.DeviceStatus.resolution-denominator.html">ALSATimer.DeviceStatus:resolution-denominator</a></h6>
 
           <div class="docblock">
-            No description available.
+            <p>The denominator of current resolution in&nbsp;seconds.</p>
           </div>
 
 
@@ -276,7 +276,7 @@ <h6><a href="property.DeviceStatus.resolution-denominator.html">ALSATimer.Device
           <h6><a href="property.DeviceStatus.resolution-numerator.html">ALSATimer.DeviceStatus:resolution-numerator</a></h6>
 
           <div class="docblock">
-            No description available.
+            <p>The numerator of current resolution in&nbsp;seconds.</p>
           </div>
 
 

diff --git a/alsatimer/class.InstanceInfo.html b/alsatimer/class.InstanceInfo.html
@@ -70,7 +70,7 @@
         <h3><a href="index.html">ALSATimer</a></h3>
         <p>API Version: 0.0</p>
 
-        <p>Library Version: 0.2.2</p>
+        <p>Library Version: 0.3.0</p>
 
       </div>
 
@@ -140,8 +140,8 @@ <h4 id="description" style="display:flex;">
 }</pre></code>
 
         <div class="docblock">
-          <p>A GObject-derived object to represent information of user instance.
-A <a href="class.InstanceInfo.html"><code>ALSATimerInstanceInfo</code></a> is a GObject-derived object to represent information of user instance
+          <p>A GObject-derived object to express information of user instance.
+A <a href="class.InstanceInfo.html"><code>ALSATimerInstanceInfo</code></a> is a GObject-derived object to express information of user instance
 attached to any timer device or the other instance as slave. The call of
 <a href="method.UserInstance.get_info.html"><code>alsatimer_user_instance_get_info()</code></a> returns the instance of&nbsp;object.</p>
 <p>The object wraps <code>struct snd_timer_info</code> in <span class="caps">UAPI</span> of Linux sound&nbsp;subsystem.</p>
@@ -231,7 +231,7 @@ <h4 id="properties">
           <h6><a href="property.InstanceInfo.card-id.html">ALSATimer.InstanceInfo:card-id</a></h6>
 
           <div class="docblock">
-            No description available.
+            <p>The numeric <span class="caps">ID</span> of sound card for attached&nbsp;timer.</p>
           </div>
 
 
@@ -241,7 +241,7 @@ <h6><a href="property.InstanceInfo.card-id.html">ALSATimer.InstanceInfo:card-id<
           <h6><a href="property.InstanceInfo.flags.html">ALSATimer.InstanceInfo:flags</a></h6>
 
           <div class="docblock">
-            No description available.
+            <p>The flags for attached&nbsp;timer.</p>
           </div>
 
 
@@ -251,7 +251,7 @@ <h6><a href="property.InstanceInfo.flags.html">ALSATimer.InstanceInfo:flags</a><
           <h6><a href="property.InstanceInfo.id.html">ALSATimer.InstanceInfo:id</a></h6>
 
           <div class="docblock">
-            No description available.
+            <p>The string <span class="caps">ID</span> of attached&nbsp;timer.</p>
           </div>
 
 
@@ -261,7 +261,7 @@ <h6><a href="property.InstanceInfo.id.html">ALSATimer.InstanceInfo:id</a></h6>
           <h6><a href="property.InstanceInfo.name.html">ALSATimer.InstanceInfo:name</a></h6>
 
           <div class="docblock">
-            No description available.
+            <p>The name of attached&nbsp;timer.</p>
           </div>
 
 
@@ -271,7 +271,7 @@ <h6><a href="property.InstanceInfo.name.html">ALSATimer.InstanceInfo:name</a></h
           <h6><a href="property.InstanceInfo.resolution.html">ALSATimer.InstanceInfo:resolution</a></h6>
 
           <div class="docblock">
-            No description available.
+            <p>The resolution of attached timer in nano&nbsp;seconds.</p>
           </div>
 
 

diff --git a/alsatimer/class.InstanceParams.html b/alsatimer/class.InstanceParams.html
@@ -70,7 +70,7 @@
         <h3><a href="index.html">ALSATimer</a></h3>
         <p>API Version: 0.0</p>
 
-        <p>Library Version: 0.2.2</p>
+        <p>Library Version: 0.3.0</p>
 
       </div>
 
@@ -156,8 +156,8 @@ <h4 id="description" style="display:flex;">
 }</pre></code>
 
         <div class="docblock">
-          <p>A GObject-derived object to represent parameters of user instance.
-A <a href="class.InstanceParams.html"><code>ALSATimerInstanceParams</code></a> is a GObject-derived object to represent parameters of user instance
+          <p>A GObject-derived object to express parameters of user instance.
+A <a href="class.InstanceParams.html"><code>ALSATimerInstanceParams</code></a> is a GObject-derived object to express parameters of user instance
 attached to any timer device or the other instance as slave. The call of
 <a href="method.UserInstance.set_params.html"><code>alsatimer_user_instance_set_params()</code></a> requires the instance of&nbsp;object.</p>
 <p>The object wraps <code>struct snd_timer_params</code> in <span class="caps">UAPI</span> of Linux sound&nbsp;subsystem.</p>
@@ -237,17 +237,17 @@ <h4 id="methods">
         <div class="">
           <h6><a href="method.InstanceParams.get_event_filter.html">alsatimer_instance_params_get_event_filter</a></h6>
           <div class="docblock">
-            <p>Get the list of ALSATimerEventType to filter events. This parameter is effective only for target
-instance with <code>ALSATimerEventDataType</code>.</p>
+            <p>Get the list of <code>ALSATimerRealTimeEventType</code> to filter events. This parameter is effective only for
+target instance with <code>ALSATimerEventType</code>.REAL_TIME.</p>
           </div>
 
         </div>
 
         <div class="">
           <h6><a href="method.InstanceParams.set_event_filter.html">alsatimer_instance_params_set_event_filter</a></h6>
           <div class="docblock">
-            <p>Set the list of <code>ALSATimerEventType</code> to filter events. This parameter is effective only for target
-instance with <code>ALSATimerEventDataType</code>.</p>
+            <p>Set the list of <code>ALSATimerRealTimeEventType</code> to filter events. This parameter is effective only for
+target instance with <code>ALSATimerEventType</code>.<span class="caps">TIMESTAMP</span>.</p>
           </div>
 
         </div>
@@ -286,7 +286,7 @@ <h4 id="properties">
           <h6><a href="property.InstanceParams.flags.html">ALSATimer.InstanceParams:flags</a></h6>
 
           <div class="docblock">
-            No description available.
+            <p>The flags for user instance, as a set of <code>ALSATimerInstanceParamFlag</code>.</p>
           </div>
 
 
@@ -296,7 +296,7 @@ <h6><a href="property.InstanceParams.flags.html">ALSATimer.InstanceParams:flags<
           <h6><a href="property.InstanceParams.interval.html">ALSATimer.InstanceParams:interval</a></h6>
 
           <div class="docblock">
-            No description available.
+            <p>The interval to generate event in tick&nbsp;count.</p>
           </div>
 
 
@@ -306,7 +306,7 @@ <h6><a href="property.InstanceParams.interval.html">ALSATimer.InstanceParams:int
           <h6><a href="property.InstanceParams.queue-size.html">ALSATimer.InstanceParams:queue-size</a></h6>
 
           <div class="docblock">
-            No description available.
+            <p>The size of&nbsp;queue.</p>
           </div>
 
 

diff --git a/alsatimer/class.InstanceStatus.html b/alsatimer/class.InstanceStatus.html
@@ -70,7 +70,7 @@
         <h3><a href="index.html">ALSATimer</a></h3>
         <p>API Version: 0.0</p>
 
-        <p>Library Version: 0.2.2</p>
+        <p>Library Version: 0.3.0</p>
 
       </div>
 
@@ -99,7 +99,7 @@ <h5>Constructors</h5>
   <h5>Instance methods</h5>
   <div class="links">
 
-    <a class="method" href="method.InstanceStatus.get_tstamp.html">get_tstamp</a>
+    <a class="method" href="method.InstanceStatus.get_time.html">get_time</a>
 
   </div>
 </div>
@@ -156,10 +156,10 @@ <h4 id="description" style="display:flex;">
 }</pre></code>
 
         <div class="docblock">
-          <p>A GObject-derived object to represent status of user instance.
-A <a href="class.InstanceStatus.html"><code>ALSATimerInstanceStatus</code></a> is a GObject-derived object to represent status of user instance
-attached to any timer device or the other instance as slave. The call of
-<a href="method.UserInstance.get_status.html"><code>alsatimer_user_instance_get_status()</code></a> returns the instance of&nbsp;object.</p>
+          <p>A GObject-derived object to express status of user instance.
+A <a href="class.InstanceStatus.html"><code>ALSATimerInstanceStatus</code></a> is a GObject-derived object to express status of user instance attached
+to any timer device or the other instance as slave. The call of <a href="method.UserInstance.get_status.html"><code>alsatimer_user_instance_get_status()</code></a>
+returns the instance of&nbsp;object.</p>
 <p>The object wraps <code>struct snd_timer_status</code> in <span class="caps">UAPI</span> of Linux sound&nbsp;subsystem.</p>
         </div>
 
@@ -235,9 +235,9 @@ <h4 id="methods">
       <div class="docblock">
 
         <div class="">
-          <h6><a href="method.InstanceStatus.get_tstamp.html">alsatimer_instance_status_get_tstamp</a></h6>
+          <h6><a href="method.InstanceStatus.get_time.html">alsatimer_instance_status_get_time</a></h6>
           <div class="docblock">
-            <p>Get timestamp for the latest&nbsp;event.</p>
+            <p>Get real time at which the timer starts, stops, pauses, and&nbsp;continues.</p>
           </div>
 
         </div>
@@ -276,7 +276,7 @@ <h4 id="properties">
           <h6><a href="property.InstanceStatus.interval.html">ALSATimer.InstanceStatus:interval</a></h6>
 
           <div class="docblock">
-            No description available.
+            <p>The current interval in nano&nbsp;second.</p>
           </div>
 
 
@@ -286,7 +286,7 @@ <h6><a href="property.InstanceStatus.interval.html">ALSATimer.InstanceStatus:int
           <h6><a href="property.InstanceStatus.lost.html">ALSATimer.InstanceStatus:lost</a></h6>
 
           <div class="docblock">
-            No description available.
+            <p>The count of losts master&nbsp;ticks.</p>
           </div>
 
 
@@ -296,7 +296,7 @@ <h6><a href="property.InstanceStatus.lost.html">ALSATimer.InstanceStatus:lost</a
           <h6><a href="property.InstanceStatus.overrun.html">ALSATimer.InstanceStatus:overrun</a></h6>
 
           <div class="docblock">
-            No description available.
+            <p>The count of overrun in read&nbsp;queue.</p>
           </div>
 
 
@@ -306,7 +306,7 @@ <h6><a href="property.InstanceStatus.overrun.html">ALSATimer.InstanceStatus:over
           <h6><a href="property.InstanceStatus.queue-size.html">ALSATimer.InstanceStatus:queue-size</a></h6>
 
           <div class="docblock">
-            No description available.
+            <p>The current size of&nbsp;queue.</p>
           </div>