← Back to branch summary

~ubuntu-branches/ubuntu/quantal/gnash/quantal-proposed

« back to all changes in this revision

Viewing changes to doc/C/BackLash/netconnection.xml

  • Committer: Bazaar Package Importer
  • Author(s): Alexander Sack
  • Date: 2008-10-14 16:06:54 UTC
  • mfrom: (1.1.10 upstream)
  • Revision ID: james.westby@ubuntu.com-20081014160654-0anbl2mi098aee2h
Tags: 0.8.4-0ubuntu1
https://launchpad.net/bugs/84526
* LP: #84526 - Gnash menu launcher (/usr/share/applications/gnash.desktop
  file) doesn't start any application, also gnash isn't asociated with SWF
  mimetype; we dont show gnash in the .desktop launcher; we add
  NoDisplay=true, add a GenericName and Comment for the sake of
  completeness. Also we add the proper MimeType value, remove Encoding,
  don't use absolute paths for icon and exec and dont use specific icon
  file format suffix.
  - update debian/gnash.desktop

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/C/BackLash/netconnection.xml
1
 
<sect4 id="asnetconnection">
2
 
  <title>NetConnection ActionScript Class</title>
3
 
 
4
 
  <para>
5
 
    This class implements an NetConnection object. The NetConnection
6
 
    object opens a client connection to load an FLV video file from a
7
 
    local system, or a remote one using the RTMP or RTMPT protocols.
8
 
    RTMP connections use port 1935, and RTMPT connections use port 80.
9
 
  </para>
10
 
 
11
 
  <para>
12
 
    This class was first introduced for swf v7 and the behavior has
13
 
    recently changed slightly to allow the loading of files from
14
 
    external systems. Prior to this, you were required to pass NULL to
15
 
    this class. Gnash handles both cases. The older behavior is default
16
 
    when connecting to the local filesystem for the file.
17
 
  </para>
18
 
 
19
 
  <para>
20
 
    The URL that can be passed to <emphasis>connect()</emphasis> in newer
21
 
    versions of the swf format is as follows:
22
 
    <programlisting>
23
 
      protocol:[//host][:port]/appname/[instanceName]
24
 
    </programlisting>
25
 
    For protocol, specify either <emphasis>RTMP</emphasis> or
26
 
    <emphasis>RTMPT</emphasis>. If rtmp is specified, SWF Player will create
27
 
    a client connection. If <emphasis>RTMPT</emphasis> is specified, SWF
28
 
    Player will create an HTTP "tunneling" connection to the server.
29
 
  </para>
30
 
 
31
 
  <para>
32
 
    You can omit the host parameter if the SWF movie is served from
33
 
    localhost. If the instanceName parameter is omitted, SWF Player
34
 
    connects to the application's default instance (_definst_).
35
 
  </para>
36
 
 
37
 
    <sect5 id="netconnectionmethods">
38
 
        <title>The Methods of the  Class</title>
39
 
 
40
 
        <variablelist>
41
 
          <varlistentry>the same host where Flash Communication Server is installed
42
 
          <term>NetConnection.connect(const char *)</term>
43
 
          <listitem>
44
 
            <para>
45
 
              Connect to a local or remote system to load a
46
 
              FLV file. Arg can be NULL, or a URL.
47
 
            </para>
48
 
          </listitem>
49
 
          </varlistentry>
50
 
        </variablelist>
51
 
    </sect5>
52
 
 
53
 
<!--    
54
 
    <sect5 id="netconnectionprops">
55
 
      <title>The Properties of the NetConnection Class</title>
56
 
      
57
 
      <para>
58
 
        <variablelist>
59
 
          
60
 
        </variablelist>
61
 
      </para>
62
 
    </sect5>
63
 
-->
64
 
    
65
 
    <sect5 id="netconnectionconf">
66
 
      <title>NetConnection Class Conformance</title>
67
 
      
68
 
      <informaltable frame="all">
69
 
        <?dbhtml table-width="75%" ?>
70
 
        <tgroup cols="2">
71
 
          <thead>
72
 
            <row>
73
 
              <entry valign="top">
74
 
                <para>Class Name</para>
75
 
              </entry>
76
 
              <entry valign="top">
77
 
                <para>Conformance</para>
78
 
              </entry>
79
 
            </row>
80
 
          </thead>
81
 
          <tbody>
82
 
            <row>
83
 
              <entry valign="top" align="left">
84
 
                <para>NetConnection.connect()</para>
85
 
              </entry>
86
 
              <entry valign="top" align="center">
87
 
                <para>
88
 
                  This method is partially implemented. It can only be
89
 
                  used in conjunction with the <link
90
 
                  linkend="asnetstream">NetStream</link> and <link
91
 
                  linkend="asvideo">Video</link> classes; it cannot
92
 
                  load a FLV file by itself.
93
 
                </para>
94
 
              </entry>
95
 
            </row>
96
 
          </tbody>
97
 
        </tgroup>
98
 
      </informaltable>
99
 
  </sect5>  
100
 
</sect4>