Chan.rtp
From Yate Documentation
(Difference between revisions)
(Created page with "This documentation has been extracted from the source of ''Yate-0.9-CVS'' and as such it might not be accurate -- technically or semantically. The '''chan.rtp''' message seem...") |
(Added lots of message parameters, understood by yrtpchan) |
||
| (One intermediate revision by one user not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
| − | The '''chan.rtp''' message | + | The '''chan.rtp''' message is sent from a channel-creating module (such as h323chan and ysipchan) to an RTP transport-providing module (like yrtpchan). |
| − | The message | + | The message is designed for synchronous processing. |
=== Message parameters === | === Message parameters === | ||
| Line 9: | Line 8: | ||
'''localip''' | '''localip''' | ||
:::the local IP address of the RTP channel to be created | :::the local IP address of the RTP channel to be created | ||
| + | '''transport''' | ||
| + | :::transport ''optional'' protocol name as specified in SDP, can start with "RTP/" to create RTP stream or be "udptl" to start UDPTL (fax) stream | ||
| + | '''terminate''' | ||
| + | :::set to true to stop RTP stream | ||
'''direction''' | '''direction''' | ||
| − | :::the direction of the channel | + | :::the direction of the channel (string "send" or "receive" or "bidir") |
| + | '''media''' | ||
| + | :::''optional'' string, overrides guessed media type (audio/image/...) | ||
| + | '''rtpid''' | ||
| + | :::RTP channel id, used to find existing RTP channel if DataEndpoint object is not set in message's UserData. | ||
| + | '''remoteip''' | ||
| + | :::Remote IP address | ||
| + | '''ipv6_support''' | ||
| + | :::IPv6 support, overrides yrtpchan.conf ipv6_support perameter | ||
| + | '''secure''' | ||
| + | :::Set to true to create SRTP (encrypted) session | ||
| + | '''crypto_suite''' | ||
| + | '''crypto_key''' | ||
| + | :::Encryption parameters (used by SRTP channels) | ||
| + | '''tos''' | ||
| + | :::''optional'' TOS (type of service) value, overrides config file paramter | ||
| + | '''thread''' | ||
| + | :::Set RTP group thread priority, overrides config file parameter | ||
| + | '''msleep''' | ||
| + | :::Minimum time to sleep in loop in milliseconds for [http://yate.null.ro/docs/api/TelEngine__RTPGroup.html#ref2 RTP group] | ||
| + | '''format''' | ||
| + | '''payload''' | ||
| + | '''evpayload''' | ||
| + | :::Media format and RTP payload code | ||
| + | '''buffer''' | ||
| + | :::XXX ??? | ||
| + | '''drillhole''' | ||
| + | :::Attempt or not to drill a hole in NAT, overrides config file parameter | ||
| + | '''autoaddr''' | ||
| + | :::XXX ??? | ||
| + | '''timeout''' | ||
| + | :::Set channel's [http://yate.null.ro/docs/api/TelEngine__UDPSession.html#ref10 inactivity timeout] | ||
| + | '''anyssrc''' | ||
| + | :::XXX ??? | ||
| + | '''padding''' | ||
| + | :::XXX ???, overrides config file parameter | ||
| + | '''rtcp_interval''' | ||
| + | :::Set RTCP reports interval, overrides config file parameter | ||
| + | '''minjitter''' | ||
| + | '''maxjitter''' | ||
| + | :::Set dejitter buffer parameters, override config file parameters | ||
| + | '''getsession''' | ||
| + | :::If set to true, message's UserDate pointer will be replaced with a pointer to an YRTPWrapper object, allowing orher modules to access RTP channel's internal objects (Socket, DataSource, DataConsumer, RTPSession) | ||
When the message returns processed, the following parameters are added: | When the message returns processed, the following parameters are added: | ||
| Line 16: | Line 61: | ||
'''rtpid''' | '''rtpid''' | ||
:::module-specific RTP channel ID | :::module-specific RTP channel ID | ||
| + | '''localip''' | ||
| + | :::the local ip address on which the newly created RTP channel is run. | ||
'''localport''' | '''localport''' | ||
:::the local port number on which the newly created RTP channel is run. | :::the local port number on which the newly created RTP channel is run. | ||
| + | '''status''' | ||
| + | :::Current status of RTP channel (created/updated/terminated) | ||
| + | '''t38maxdatagram''' | ||
| + | '''osdp_T38FaxMaxDatagram''' | ||
| + | :::Maximum UDPTL datagram length (set by UDPTL channels) | ||
| + | '''t38redundancy''' | ||
| + | '''osdp_T38FaxUdpEC''' | ||
| + | :::UDPTL redudancy flag (set by UDPTL channels) | ||
| + | |||
| + | '''See also''' | ||
| + | |||
| + | *[[chan.startup]] | ||
Latest revision as of 10:03, 8 June 2016
The chan.rtp message is sent from a channel-creating module (such as h323chan and ysipchan) to an RTP transport-providing module (like yrtpchan).
The message is designed for synchronous processing.
[edit] Message parameters
localip
- the local IP address of the RTP channel to be created
transport
- transport optional protocol name as specified in SDP, can start with "RTP/" to create RTP stream or be "udptl" to start UDPTL (fax) stream
terminate
- set to true to stop RTP stream
direction
- the direction of the channel (string "send" or "receive" or "bidir")
media
- optional string, overrides guessed media type (audio/image/...)
rtpid
- RTP channel id, used to find existing RTP channel if DataEndpoint object is not set in message's UserData.
remoteip
- Remote IP address
ipv6_support
- IPv6 support, overrides yrtpchan.conf ipv6_support perameter
secure
- Set to true to create SRTP (encrypted) session
crypto_suite crypto_key
- Encryption parameters (used by SRTP channels)
tos
- optional TOS (type of service) value, overrides config file paramter
thread
- Set RTP group thread priority, overrides config file parameter
msleep
- Minimum time to sleep in loop in milliseconds for RTP group
format payload evpayload
- Media format and RTP payload code
buffer
- XXX ???
drillhole
- Attempt or not to drill a hole in NAT, overrides config file parameter
autoaddr
- XXX ???
timeout
- Set channel's inactivity timeout
anyssrc
- XXX ???
padding
- XXX ???, overrides config file parameter
rtcp_interval
- Set RTCP reports interval, overrides config file parameter
minjitter maxjitter
- Set dejitter buffer parameters, override config file parameters
getsession
- If set to true, message's UserDate pointer will be replaced with a pointer to an YRTPWrapper object, allowing orher modules to access RTP channel's internal objects (Socket, DataSource, DataConsumer, RTPSession)
When the message returns processed, the following parameters are added:
rtpid
- module-specific RTP channel ID
localip
- the local ip address on which the newly created RTP channel is run.
localport
- the local port number on which the newly created RTP channel is run.
status
- Current status of RTP channel (created/updated/terminated)
t38maxdatagram osdp_T38FaxMaxDatagram
- Maximum UDPTL datagram length (set by UDPTL channels)
t38redundancy osdp_T38FaxUdpEC
- UDPTL redudancy flag (set by UDPTL channels)
See also
