protection: Document original-media-type caps field

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/6142>
This commit is contained in:
Philippe Normand 2024-02-19 12:25:01 +00:00
parent d972acd3c5
commit 6059391e10
2 changed files with 19 additions and 1 deletions

View file

@ -51884,7 +51884,16 @@ which is then encapsulated in a GstProtectionMeta object and attached to
the corresponding output buffer using the gst_buffer_add_protection_meta()
function. The information in this attached GstProtectionMeta would be
used by a downstream decrypter element to recover the original unencrypted
frame.</doc>
frame.
In addition to the #GstProtectionMeta demuxers signal encrypted streams with
specific caps. The caps #GstStructure name will usually depend on the
encryption scheme, for instance Common Encryption will be signaled with
`application/x-cenc`. To prevent loss of information the media type of the
decrypted stream will be stored in a `original-media-type` string field.
Downstream elements can re-use that information, for instance decryptors can
set their source pad caps according to the `original-media-type` received on
their sink pad.</doc>
</docsection>
<docsection name="gststreams">
<doc xml:space="preserve" filename="../subprojects/gstreamer/gst/gststreams.c">A #GstStream is a high-level object defining a stream of data which is, or

View file

@ -35,6 +35,15 @@
* used by a downstream decrypter element to recover the original unencrypted
* frame.
*
* In addition to the #GstProtectionMeta demuxers signal encrypted streams with
* specific caps. The caps #GstStructure name will usually depend on the
* encryption scheme, for instance Common Encryption will be signaled with
* `application/x-cenc`. To prevent loss of information the media type of the
* decrypted stream will be stored in a `original-media-type` string field.
* Downstream elements can re-use that information, for instance decryptors can
* set their source pad caps according to the `original-media-type` received on
* their sink pad.
*
* Since: 1.6
*/