mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-04-10 10:04:23 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: add MIKEY docs

Browse source
This commit is contained in:
Wim Taymans 2014-03-20 12:29:33 +01:00
parent 83888d6b13
commit 51ca0bdf7b
4 changed files with 109 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/libs/gst-plugins-base-libs-docs.sgml
View file

@ -140,6 +140,16 @@
<xi:include href="xml/gstsdpmessage.xml" />
</chapter>
<chapter id="gstreamer-mikey">
<title>MIKEY Library</title>
<para>
This library should be linked to by getting cflags and libs from
<filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
<filename>-lgstsdp-&GST_API_VERSION;</filename> to the library flags.
</para>
<xi:include href="xml/gstmikey.xml" />
</chapter>
<chapter id="gstreamer-tag">
<title>Tag Support Library</title>
<para>

84
docs/libs/gst-plugins-base-libs-sections.txt
View file

@ -1730,6 +1730,90 @@ gst_sdp_media_remove_attribute
gst_sdp_media_add_attribute
</SECTION>
<SECTION>
<FILE>gstmikey</FILE>
<INCLUDE>gst/sdp/gstmikey.h</INCLUDE>
<SUBSECTION Messages>
GST_MIKEY_VERSION
GstMIKEYType
GstMIKEYMessage
gst_mikey_message_new
gst_mikey_message_new_from_bytes
gst_mikey_message_new_from_data
gst_mikey_message_free
gst_mikey_message_to_bytes
<SUBSECTION MessageInfo>
GstMIKEYPRFFunc
GstMIKEYMapType
gst_mikey_message_set_info
gst_mikey_message_get_n_cs
<SUBSECTION MessageCSSRTP>
GstMIKEYMapSRTP
gst_mikey_message_get_cs_srtp
gst_mikey_message_insert_cs_srtp
gst_mikey_message_remove_cs_srtp
gst_mikey_message_replace_cs_srtp
gst_mikey_message_add_cs_srtp
<SUBSECTION Payloads>
gst_mikey_message_get_n_payloads
gst_mikey_message_get_payload
gst_mikey_message_find_payload
gst_mikey_message_insert_payload
gst_mikey_message_remove_payload
gst_mikey_message_replace_payload
gst_mikey_message_add_payload
GstMIKEYPayloadType
GstMIKEYPayloadClearFunc
GstMIKEYPayloadCopyFunc
GstMIKEYPayload
gst_mikey_payload_new
gst_mikey_payload_copy
gst_mikey_payload_free
<SUBSECTION PayloadKEMAC>
GstMIKEYEncAlg
GstMIKEYMacAlg
GstMIKEYPayloadKEMAC
gst_mikey_payload_kemac_set
gst_mikey_message_add_kemac
<SUBSECTION PayloadPKE>
GstMIKEYCacheType
GstMIKEYPayloadPKE
gst_mikey_payload_pke_set
gst_mikey_message_add_pke
<SUBSECTION PayloadT>
GstMIKEYTSType
GstMIKEYPayloadT
gst_mikey_payload_t_set
gst_mikey_message_add_t
gst_mikey_message_add_t_now_ntp_utc
<SUBSECTION PayloadRAND>
GstMIKEYPayloadRAND
gst_mikey_payload_rand_set
gst_mikey_message_add_rand
gst_mikey_message_add_rand_len
<SUBSECTION PayloadSP>
GstMIKEYSecProto
GstMIKEYSecSRTP
GstMIKEYPayloadSP
GstMIKEYPayloadSPParam
gst_mikey_payload_sp_set
gst_mikey_payload_sp_get_n_params
gst_mikey_payload_sp_get_param
gst_mikey_payload_sp_add_param
gst_mikey_payload_sp_remove_param
<SUBSECTION Standard>
</SECTION>
# tag
<SECTION>

14
gst-libs/gst/sdp/gstmikey.c
View file

@ -19,6 +19,20 @@
* Boston, MA 02110-1301, USA.
*/
/**
* SECTION:gstmikey
* @short_description: Helper methods for dealing with MIKEY messages
*
* <refsect2>
* <para>
* The GstMIKEY helper functions makes it easy to parse and create MIKEY
* messages.
* </para>
* </refsect2>
*
* Last reviewed on 2014-03-20 (1.3.0)
*/
#include <string.h>
#include "gstmikey.h"

4
gst-libs/gst/sdp/gstmikey.h
View file

@ -366,9 +366,7 @@ typedef enum
* GstMIKEYPayloadSP:
* @pt: the payload header
* @policy: the policy number
* @prot: the security protocol
* @param_len: the total length of the policy parameters for the
* specific security protocol
* @proto: the security protocol
* @params: array of #GstMIKEYPayloadPSParam
*
* The Security Policy payload defines a set of policies that apply to a