Commit 6d69a91f authored by Pekka Pessi's avatar Pekka Pessi

soa_tag.c: documented SOATAG_HOLD() inactive mode

darcs-hash:20080111141518-65a35-446080226b9f96a62dd1ee651a712f0d85c7b22f.gz
parent f624c01c
......@@ -585,12 +585,22 @@ tag_typedef_t soatag_srtp_integrity = BOOLTAG_TYPEDEF(srtp_integrity);
/**@def SOATAG_HOLD(x)
*
* Hold media stream or streams. When putting a SIP session on hold, the
* application can include, e.g., SOATAG_HOLD("audio") or
* SOATAG_HOLD("video") or SOATAG_HOLD("audio, video") or SOATAG_HOLD("*")
* as @soa parameters. When resuming the session, it can include
* SOATAG_HOLD(NULL). Note that last SOATAG_HOLD() in the tag list will
* override the SOATAG_HOLD() tags before it.
* Hold media stream or streams.
*
* The hold media stream will have the attribute a=sendonly (meaning that
* some hold announcements or pause music is sent to the held party but that
* the held party should not generate any media) or a=inactive (meaning that
* no media is sent).
*
* When putting a SIP session on hold with sendonly, the application can
* include, e.g., SOATAG_HOLD("audio") or SOATAG_HOLD("video") or
* SOATAG_HOLD("audio, video") or SOATAG_HOLD("*") as @soa parameters. When
* using inactive instead, the application should use "#" or
* "audio=inactive" instead. When resuming the session, application should
* include the tag SOATAG_HOLD(NULL).
*
* Note that last SOATAG_HOLD() in the tag list will override the
* SOATAG_HOLD() tags before it.
*
* @par Used with
* soa_set_params(), soa_get_params(), soa_get_paramlist() \n
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment