media-codecs: Clarify that codec availability should be checked before use

This commit is contained in:
Evangelos Ribeiro Tzaras
2021-11-25 05:34:44 +01:00
parent 27463212d9
commit 0b8fb4a448

View File

@@ -66,7 +66,9 @@ media_codec_available_in_gst (MediaCodecInfo *codec) {
* *
* @name: The name of the codec * @name: The name of the codec
* *
* Returns: (transfer none): A #MediaCodecInfo, if found * Returns: (transfer none): A #MediaCodecInfo, if found.
* You should check if the codec is available on your system before
* trying to use it with media_codec_available_in_gst()
*/ */
MediaCodecInfo * MediaCodecInfo *
media_codec_by_name (const char *name) media_codec_by_name (const char *name)
@@ -85,7 +87,9 @@ media_codec_by_name (const char *name)
* *
* @payload_id: The payload id (see RFC 3551, 3555, 4733, 4855) * @payload_id: The payload id (see RFC 3551, 3555, 4733, 4855)
* *
* Returns: (transfer none): A #MediaCodecInfo, if found * Returns: (transfer none): A #MediaCodecInfo, if found.
* You should check if the codec is available on your system before
* trying to use it with media_codec_available_in_gst()
*/ */
MediaCodecInfo * MediaCodecInfo *
media_codec_by_payload_id (guint payload_id) media_codec_by_payload_id (guint payload_id)