← Back to branch summary

~ubuntu-branches/ubuntu/lucid/rhythmbox/lucid

« back to all changes in this revision

Viewing changes to doc/reference/xml/rb-streaming-source.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-03-29 10:12:48 UTC
  • mfrom: (1.1.45 upstream)
  • Revision ID: james.westby@ubuntu.com-20100329101248-fu29j0q1s2dx8k99
Tags: 0.12.8-0ubuntu1
* New upstream version
* debian/patches/90_autoreconf.patch:
  - new version update

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/xml/rb-streaming-source.xml
1
 
<?xml version="1.0"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
3
 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
 
<refentry id="RBStreamingSource">
5
 
<refmeta>
6
 
<refentrytitle role="top_of_page" id="RBStreamingSource.top_of_page">RBStreamingSource</refentrytitle>
7
 
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>RHYTHMBOX Library</refmiscinfo>
9
 
</refmeta>
10
 
 
11
 
<refnamediv>
12
 
<refname>RBStreamingSource</refname>
13
 
<refpurpose>Base class for streaming sources such as internet radio</refpurpose>
14
 
</refnamediv>
15
 
 
16
 
<refsynopsisdiv id="RBStreamingSource.synopsis" role="synopsis">
17
 
<title role="synopsis.title">Synopsis</title>
18
 
 
19
 
<synopsis>
20
 
                    <link linkend="RBStreamingSource-struct">RBStreamingSource</link>;
21
 
                    <link linkend="RBStreamingSourceClass">RBStreamingSourceClass</link>;
22
 
<link linkend="void">void</link>                <link linkend="rb-streaming-source-get-progress">rb_streaming_source_get_progress</link>    (<link linkend="RBStreamingSource">RBStreamingSource</link> *source,
23
 
                                                         <link linkend="char">char</link> **text,
24
 
                                                         <link linkend="float">float</link> *progress);
25
 
<link linkend="void">void</link>                <link linkend="rb-streaming-source-set-streaming-title">rb_streaming_source_set_streaming_title</link>
26
 
                                                        (<link linkend="RBStreamingSource">RBStreamingSource</link> *source,
27
 
                                                         const <link linkend="char">char</link> *title);
28
 
<link linkend="void">void</link>                <link linkend="rb-streaming-source-set-streaming-artist">rb_streaming_source_set_streaming_artist</link>
29
 
                                                        (<link linkend="RBStreamingSource">RBStreamingSource</link> *source,
30
 
                                                         const <link linkend="char">char</link> *artist);
31
 
<link linkend="void">void</link>                <link linkend="rb-streaming-source-set-streaming-album">rb_streaming_source_set_streaming_album</link>
32
 
                                                        (<link linkend="RBStreamingSource">RBStreamingSource</link> *source,
33
 
                                                         const <link linkend="char">char</link> *album);
34
 
</synopsis>
35
 
</refsynopsisdiv>
36
 
 
37
 
<refsect1 id="RBStreamingSource.object-hierarchy" role="object_hierarchy">
38
 
<title role="object_hierarchy.title">Object Hierarchy</title>
39
 
<synopsis>
40
 
  <link linkend="GObject">GObject</link>
41
 
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
42
 
         +----<link linkend="GtkObject">GtkObject</link>
43
 
               +----<link linkend="GtkWidget">GtkWidget</link>
44
 
                     +----<link linkend="GtkContainer">GtkContainer</link>
45
 
                           +----<link linkend="GtkBox">GtkBox</link>
46
 
                                 +----<link linkend="GtkHBox">GtkHBox</link>
47
 
                                       +----<link linkend="RBSource">RBSource</link>
48
 
                                             +----RBStreamingSource
49
 
</synopsis>
50
 
</refsect1>
51
 
 
52
 
 
53
 
 
54
 
<refsect1 id="RBStreamingSource.implemented-interfaces" role="impl_interfaces">
55
 
<title role="impl_interfaces.title">Implemented Interfaces</title>
56
 
<para>
57
 
RBStreamingSource implements
58
 
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>,  <link linkend="GtkBuildable">GtkBuildable</link> and  <link linkend="GtkOrientable">GtkOrientable</link>.</para>
59
 
</refsect1>
60
 
 
61
 
 
62
 
 
63
 
 
64
 
 
65
 
<refsect1 id="RBStreamingSource.description" role="desc">
66
 
<title role="desc.title">Description</title>
67
 
<para>
68
 
This class provides handling of buffering signals and streaming song metadata
69
 
common to different types of sources that play continuous streaming media.</para>
70
 
<para>
71
 
</para>
72
 
</refsect1>
73
 
 
74
 
<refsect1 id="RBStreamingSource.details" role="details">
75
 
<title role="details.title">Details</title>
76
 
<refsect2 id="RBStreamingSource-struct" role="struct">
77
 
<title>RBStreamingSource</title>
78
 
<indexterm zone="RBStreamingSource-struct"><primary sortas="RBStreamingSource">RBStreamingSource</primary></indexterm><programlisting>typedef struct _RBStreamingSource RBStreamingSource;</programlisting>
79
 
<para>
80
 
</para></refsect2>
81
 
<refsect2 id="RBStreamingSourceClass" role="struct">
82
 
<title>RBStreamingSourceClass</title>
83
 
<indexterm zone="RBStreamingSourceClass"><primary sortas="RBStreamingSourceClass">RBStreamingSourceClass</primary></indexterm><programlisting>typedef struct {
84
 
        RBSourceClass parent;
85
 
} RBStreamingSourceClass;
86
 
</programlisting>
87
 
<para>
88
 
</para></refsect2>
89
 
<refsect2 id="rb-streaming-source-get-progress" role="function">
90
 
<title>rb_streaming_source_get_progress ()</title>
91
 
<indexterm zone="rb-streaming-source-get-progress"><primary sortas="rb_streaming_source_get_progress">rb_streaming_source_get_progress</primary></indexterm><programlisting><link linkend="void">void</link>                rb_streaming_source_get_progress    (<link linkend="RBStreamingSource">RBStreamingSource</link> *source,
92
 
                                                         <link linkend="char">char</link> **text,
93
 
                                                         <link linkend="float">float</link> *progress);</programlisting>
94
 
<para>
95
 
Provides status text and progress fraction suitable for use in
96
 
a streaming source's <parameter>rb_source_get_status</parameter> method.</para>
97
 
<para>
98
 
</para><variablelist role="params">
99
 
<varlistentry><term><parameter>source</parameter>&#160;:</term>
100
 
<listitem><simpara> a <link linkend="RBStreamingSource"><type>RBStreamingSource</type></link>
101
 
</simpara></listitem></varlistentry>
102
 
<varlistentry><term><parameter>text</parameter>&#160;:</term>
103
 
<listitem><simpara> returns buffering status text
104
 
</simpara></listitem></varlistentry>
105
 
<varlistentry><term><parameter>progress</parameter>&#160;:</term>
106
 
<listitem><simpara> returns buffering progress fraction
107
 
</simpara></listitem></varlistentry>
108
 
</variablelist></refsect2>
109
 
<refsect2 id="rb-streaming-source-set-streaming-title" role="function">
110
 
<title>rb_streaming_source_set_streaming_title ()</title>
111
 
<indexterm zone="rb-streaming-source-set-streaming-title"><primary sortas="rb_streaming_source_set_streaming_title">rb_streaming_source_set_streaming_title</primary></indexterm><programlisting><link linkend="void">void</link>                rb_streaming_source_set_streaming_title
112
 
                                                        (<link linkend="RBStreamingSource">RBStreamingSource</link> *source,
113
 
                                                         const <link linkend="char">char</link> *title);</programlisting>
114
 
<para>
115
 
Updates the streaming song title.  Call this when an updated
116
 
streaming song title is received from the stream.</para>
117
 
<para>
118
 
</para><variablelist role="params">
119
 
<varlistentry><term><parameter>source</parameter>&#160;:</term>
120
 
<listitem><simpara> a <link linkend="RBStreamingSource"><type>RBStreamingSource</type></link>
121
 
</simpara></listitem></varlistentry>
122
 
<varlistentry><term><parameter>title</parameter>&#160;:</term>
123
 
<listitem><simpara> the new streaming song title
124
 
</simpara></listitem></varlistentry>
125
 
</variablelist></refsect2>
126
 
<refsect2 id="rb-streaming-source-set-streaming-artist" role="function">
127
 
<title>rb_streaming_source_set_streaming_artist ()</title>
128
 
<indexterm zone="rb-streaming-source-set-streaming-artist"><primary sortas="rb_streaming_source_set_streaming_artist">rb_streaming_source_set_streaming_artist</primary></indexterm><programlisting><link linkend="void">void</link>                rb_streaming_source_set_streaming_artist
129
 
                                                        (<link linkend="RBStreamingSource">RBStreamingSource</link> *source,
130
 
                                                         const <link linkend="char">char</link> *artist);</programlisting>
131
 
<para>
132
 
Updates the streaming song artist name.  Call this when an updated
133
 
streaming song artist name is received from the stream.</para>
134
 
<para>
135
 
</para><variablelist role="params">
136
 
<varlistentry><term><parameter>source</parameter>&#160;:</term>
137
 
<listitem><simpara> a <link linkend="RBStreamingSource"><type>RBStreamingSource</type></link>
138
 
</simpara></listitem></varlistentry>
139
 
<varlistentry><term><parameter>artist</parameter>&#160;:</term>
140
 
<listitem><simpara> the new streaming song artist name
141
 
</simpara></listitem></varlistentry>
142
 
</variablelist></refsect2>
143
 
<refsect2 id="rb-streaming-source-set-streaming-album" role="function">
144
 
<title>rb_streaming_source_set_streaming_album ()</title>
145
 
<indexterm zone="rb-streaming-source-set-streaming-album"><primary sortas="rb_streaming_source_set_streaming_album">rb_streaming_source_set_streaming_album</primary></indexterm><programlisting><link linkend="void">void</link>                rb_streaming_source_set_streaming_album
146
 
                                                        (<link linkend="RBStreamingSource">RBStreamingSource</link> *source,
147
 
                                                         const <link linkend="char">char</link> *album);</programlisting>
148
 
<para>
149
 
Updates the streaming song album name.  Call this when an updated
150
 
streaming song album name is received from the stream.</para>
151
 
<para>
152
 
</para><variablelist role="params">
153
 
<varlistentry><term><parameter>source</parameter>&#160;:</term>
154
 
<listitem><simpara> a <link linkend="RBStreamingSource"><type>RBStreamingSource</type></link>
155
 
</simpara></listitem></varlistentry>
156
 
<varlistentry><term><parameter>album</parameter>&#160;:</term>
157
 
<listitem><simpara> the new streaming song album name
158
 
</simpara></listitem></varlistentry>
159
 
</variablelist></refsect2>
160
 
 
161
 
</refsect1>
162
 
 
163
 
 
164
 
 
165
 
 
166
 
</refentry>