README 1.06 KB
Newer Older
1 2

Nice: GLib ICE library
3
======================
4

Dafydd Harries's avatar
Dafydd Harries committed
5 6
Copyright
---------
7

Youness Alaoui's avatar
Youness Alaoui committed
8 9
 (C) 2006-2011 Collabora Ltd.
 (C) 2006-2011 Nokia Corporation
10

Dafydd Harries's avatar
Dafydd Harries committed
11 12
License
-------
13

Dafydd Harries's avatar
Dafydd Harries committed
14
See the file COPYING.
15

16 17
Requirements
------------
18 19

 glib >= 2.10
20
 pkg-config
Youness Alaoui's avatar
Youness Alaoui committed
21 22
 gupnp-igd >= 0.1.2 (optional)
 gstreamer-0.10 >= 0.10.0 (optional)
23

24 25 26
Structure
---------

Youness Alaoui's avatar
Youness Alaoui committed
27 28 29 30
 agent/   - ICE agent
 docs/    - Design and API documentation
 gst/     - Gstreamer elements
 nice/    - libnice library
31
 random/  - random number generation
Youness Alaoui's avatar
Youness Alaoui committed
32
 socket/  - Socket abstraction layer
33
 stun/    - STUN implementation
Youness Alaoui's avatar
Youness Alaoui committed
34
 tests/   - Unit tests
35

36 37 38 39 40
Relevant standards
------------------

These standards are relevant to nice's current implementation.

41
ICE draft 15
Youness Alaoui's avatar
Youness Alaoui committed
42
  http://tools.ietf.org/html/rfc5245
43 44
STUN
  http://tools.ietf.org/html/rfc3489
45
  http://tools.ietf.org/html/rfc5389
46
TURN 
Marcus Lundblad's avatar
Marcus Lundblad committed
47
  http://tools.ietf.org/html/rfc5766
48 49 50 51 52 53 54 55 56
RTP
  http://tools.ietf.org/html/rfc3550
XMPP Jingle ICE transport
  http://www.xmpp.org/extensions/xep-0176.html

In future, nice may additionally support the following standards.

NAT-PMP
  http://files.dns-sd.org/draft-cheshire-nat-pmp.txt
Marcus Lundblad's avatar
Marcus Lundblad committed
57

58