~ubuntu-branches/ubuntu/quantal/linphone/quantal

« back to all changes in this revision

Viewing changes to oRTP/docs/tmpl/payloads.sgml

  • Committer: Bazaar Package Importer
  • Author(s): Samuel Mimram
  • Date: 2006-11-15 10:34:50 UTC
  • mfrom: (1.2.1 upstream) (2.1.8 feisty)
  • Revision ID: james.westby@ubuntu.com-20061115103450-qgafwcks2lkhctlj
* New upstream release.
* Enable video support.
* Fix mismatched #endif in mscommon.h, closes: #398307.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<!-- ##### SECTION Title ##### -->
2
 
RTP payloads and profiles
3
 
 
4
 
<!-- ##### SECTION Short_Description ##### -->
5
 
This section describes the way that the oRTP stack manages RTP profiles and payload types.
6
 
 
7
 
<!-- ##### SECTION Long_Description ##### -->
8
 
<para>
9
 
A rtp payload type is a number between 0 and 127 that identifies a particular payload 
10
 
(GSM, PCMU, MPEG,...) within a given rtp profile. The #PayloadType object in oRTP describes
11
 
a payload.
12
 
 
13
 
An RTP profile is a table that assigns particular payloads (GSM, MPEG...) to a payload type
14
 
number within the range 0..127. In oRTP, profiles are represented by the #RtpProfile object.
15
 
 
16
 
For example in the AV profile (Audio Video profile, defined in RFC1890), often used 
17
 
by telephony applications, the payload type number 8 is assigned to PCMA 
18
 
(A-law compressed audio) at sampling frequency 8000 Hz, mono.
19
 
 
20
 
By default, all RTP sessions created by oRTP use the AV profile, but you can change the profile
21
 
of an RTP session using rtp_session_set_profile().
22
 
</para>
23
 
 
24
 
<!-- ##### SECTION See_Also ##### -->
25
 
<para>
26
 
rtp_session_set_profile()
27
 
</para>
28
 
 
29
 
<!-- ##### STRUCT PayloadType ##### -->
30
 
<para>
31
 
 
32
 
</para>
33
 
 
34
 
@type: 
35
 
@bytes_per_sample: 
36
 
@zero_pattern: 
37
 
@pattern_length: 
38
 
@normal_bitrate: 
39
 
@mime_type: 
40
 
@flags: 
41
 
@user_data: 
42
 
 
43
 
<!-- ##### STRUCT RtpProfile ##### -->
44
 
<para>
45
 
 
46
 
</para>
47
 
 
48
 
@name: 
49
 
@payload: 
50
 
 
51
 
<!-- ##### VARIABLE av_profile ##### -->
52
 
<para>
53
 
This is the Audio Video profile defined in RFC1890.
54
 
</para>
55
 
 
56
 
 
57
 
<!-- ##### MACRO rtp_profile_clear_all ##### -->
58
 
<para>
59
 
 
60
 
</para>
61
 
 
62
 
@profile: 
63
 
 
64
 
 
65
 
<!-- ##### MACRO rtp_profile_get_name ##### -->
66
 
<para>
67
 
 
68
 
</para>
69
 
 
70
 
@profile: 
71
 
 
72
 
 
73
 
<!-- ##### MACRO rtp_profile_set_name ##### -->
74
 
<para>
75
 
 
76
 
</para>
77
 
 
78
 
@profile: 
79
 
@nm: 
80
 
 
81
 
 
82
 
<!-- ##### MACRO rtp_profile_set_payload ##### -->
83
 
<para>
84
 
 
85
 
</para>
86
 
 
87
 
@profile: 
88
 
@index: 
89
 
@pt: 
90
 
 
91
 
 
92
 
<!-- ##### MACRO rtp_profile_get_payload ##### -->
93
 
<para>
94
 
 
95
 
</para>
96
 
 
97
 
@profile: 
98
 
@index: 
99
 
 
100
 
 
101
 
<!-- ##### MACRO rtp_profile_clear_payload ##### -->
102
 
<para>
103
 
 
104
 
</para>
105
 
 
106
 
@profile: 
107
 
@index: 
108
 
 
109
 
 
110
 
<!-- ##### MACRO rtp_profile_clear_all ##### -->
111
 
<para>
112
 
 
113
 
</para>
114
 
 
115
 
@profile: 
116
 
 
117